Software APIs
kmac_regs.h
Go to the documentation of this file.
1/**
2 * @file
3 * @brief Generated register defines for kmac
4 */
5
6// Copyright information found in source file:
7// Copyright lowRISC contributors (OpenTitan project).
8
9// Licensing information found in source file:
10// Licensed under the Apache License, Version 2.0, see LICENSE for details.
11// SPDX-License-Identifier: Apache-2.0
12
13#ifndef _KMAC_REG_DEFS_
14#define _KMAC_REG_DEFS_
15
16#ifdef __cplusplus
17extern "C" {
18#endif
19// Number of words for the secret key
20#define KMAC_PARAM_NUM_WORDS_KEY 16
21
22// Number of words for Encoded NsPrefix.
23#define KMAC_PARAM_NUM_WORDS_PREFIX 11
24
25// Number of entries in the message FIFO. Must match kmac_pkg::MsgFifoDepth.
26#define KMAC_PARAM_NUM_ENTRIES_MSG_FIFO 10
27
28// Number of bytes in a single entry of the message FIFO. Must match
29// kmac_pkg::MsgWidth.
30#define KMAC_PARAM_NUM_BYTES_MSG_FIFO_ENTRY 8
31
32// Width of the hash counter in the entropy
33#define KMAC_PARAM_HASH_CNT_W 10
34
35// Number of words for the PRNG seed used for entropy generation
36#define KMAC_PARAM_NUM_SEEDS_ENTROPY 6
37
38// Number of alerts
39#define KMAC_PARAM_NUM_ALERTS 2
40
41// Register width
42#define KMAC_PARAM_REG_WIDTH 32
43
44// Common Interrupt Offsets
45#define KMAC_INTR_COMMON_KMAC_DONE_BIT 0
46#define KMAC_INTR_COMMON_FIFO_EMPTY_BIT 1
47#define KMAC_INTR_COMMON_KMAC_ERR_BIT 2
48
49// Interrupt State Register
50#define KMAC_INTR_STATE_REG_OFFSET 0x0
51#define KMAC_INTR_STATE_REG_RESVAL 0x0u
52#define KMAC_INTR_STATE_KMAC_DONE_BIT 0
53#define KMAC_INTR_STATE_FIFO_EMPTY_BIT 1
54#define KMAC_INTR_STATE_KMAC_ERR_BIT 2
55
56// Interrupt Enable Register
57#define KMAC_INTR_ENABLE_REG_OFFSET 0x4
58#define KMAC_INTR_ENABLE_REG_RESVAL 0x0u
59#define KMAC_INTR_ENABLE_KMAC_DONE_BIT 0
60#define KMAC_INTR_ENABLE_FIFO_EMPTY_BIT 1
61#define KMAC_INTR_ENABLE_KMAC_ERR_BIT 2
62
63// Interrupt Test Register
64#define KMAC_INTR_TEST_REG_OFFSET 0x8
65#define KMAC_INTR_TEST_REG_RESVAL 0x0u
66#define KMAC_INTR_TEST_KMAC_DONE_BIT 0
67#define KMAC_INTR_TEST_FIFO_EMPTY_BIT 1
68#define KMAC_INTR_TEST_KMAC_ERR_BIT 2
69
70// Alert Test Register
71#define KMAC_ALERT_TEST_REG_OFFSET 0xc
72#define KMAC_ALERT_TEST_REG_RESVAL 0x80000000u
73#define KMAC_ALERT_TEST_RECOV_OPERATION_ERR_BIT 0
74#define KMAC_ALERT_TEST_FATAL_FAULT_ERR_BIT 1
75#define KMAC_ALERT_TEST_REGWEN_BIT 31
76
77// Register write enable for !!CFG_SHADOWED register.
78#define KMAC_CFG_REGWEN_REG_OFFSET 0x10
79#define KMAC_CFG_REGWEN_REG_RESVAL 0x1u
80#define KMAC_CFG_REGWEN_CFG_REGWEN_BIT 0
81
82// KMAC Configuration register.
83#define KMAC_CFG_SHADOWED_REG_OFFSET 0x14
84#define KMAC_CFG_SHADOWED_REG_RESVAL 0x0u
85#define KMAC_CFG_SHADOWED_KMAC_EN_BIT 0
86#define KMAC_CFG_SHADOWED_KSTRENGTH_MASK 0x7u
87#define KMAC_CFG_SHADOWED_KSTRENGTH_OFFSET 1
88#define KMAC_CFG_SHADOWED_KSTRENGTH_FIELD \
89 ((bitfield_field32_t) { .mask = KMAC_CFG_SHADOWED_KSTRENGTH_MASK, .index = KMAC_CFG_SHADOWED_KSTRENGTH_OFFSET })
90#define KMAC_CFG_SHADOWED_KSTRENGTH_VALUE_L128 0x0
91#define KMAC_CFG_SHADOWED_KSTRENGTH_VALUE_L224 0x1
92#define KMAC_CFG_SHADOWED_KSTRENGTH_VALUE_L256 0x2
93#define KMAC_CFG_SHADOWED_KSTRENGTH_VALUE_L384 0x3
94#define KMAC_CFG_SHADOWED_KSTRENGTH_VALUE_L512 0x4
95#define KMAC_CFG_SHADOWED_MODE_MASK 0x3u
96#define KMAC_CFG_SHADOWED_MODE_OFFSET 4
97#define KMAC_CFG_SHADOWED_MODE_FIELD \
98 ((bitfield_field32_t) { .mask = KMAC_CFG_SHADOWED_MODE_MASK, .index = KMAC_CFG_SHADOWED_MODE_OFFSET })
99#define KMAC_CFG_SHADOWED_MODE_VALUE_SHA3 0x0
100#define KMAC_CFG_SHADOWED_MODE_VALUE_SHAKE 0x2
101#define KMAC_CFG_SHADOWED_MODE_VALUE_CSHAKE 0x3
102#define KMAC_CFG_SHADOWED_MSG_ENDIANNESS_BIT 8
103#define KMAC_CFG_SHADOWED_STATE_ENDIANNESS_BIT 9
104#define KMAC_CFG_SHADOWED_SIDELOAD_BIT 12
105#define KMAC_CFG_SHADOWED_ENTROPY_FAST_PROCESS_BIT 19
106#define KMAC_CFG_SHADOWED_MSG_MASK_BIT 20
107#define KMAC_CFG_SHADOWED_EN_UNSUPPORTED_MODESTRENGTH_BIT 26
108
109// KMAC/ SHA3 command register.
110#define KMAC_CMD_REG_OFFSET 0x18
111#define KMAC_CMD_REG_RESVAL 0x0u
112#define KMAC_CMD_CMD_MASK 0x3fu
113#define KMAC_CMD_CMD_OFFSET 0
114#define KMAC_CMD_CMD_FIELD \
115 ((bitfield_field32_t) { .mask = KMAC_CMD_CMD_MASK, .index = KMAC_CMD_CMD_OFFSET })
116#define KMAC_CMD_CMD_VALUE_START 0x7
117#define KMAC_CMD_CMD_VALUE_PROCESS 0x32
118#define KMAC_CMD_CMD_VALUE_RUN 0x2e
119#define KMAC_CMD_CMD_VALUE_DONE 0x35
120#define KMAC_CMD_CMD_VALUE_STOP 0x1c
121#define KMAC_CMD_CMD_VALUE_STATE_WRITE 0x1b
122#define KMAC_CMD_CMD_VALUE_CONTINUE 0x29
123#define KMAC_CMD_ENTROPY_REQ_BIT 8
124#define KMAC_CMD_HASH_CNT_CLR_BIT 9
125#define KMAC_CMD_ERR_PROCESSED_BIT 10
126
127// KMAC/SHA3 Status register.
128#define KMAC_STATUS_REG_OFFSET 0x1c
129#define KMAC_STATUS_REG_RESVAL 0x4001u
130#define KMAC_STATUS_SHA3_IDLE_BIT 0
131#define KMAC_STATUS_SHA3_ABSORB_BIT 1
132#define KMAC_STATUS_SHA3_SQUEEZE_BIT 2
133#define KMAC_STATUS_SHA3_STOPPED_BIT 3
134#define KMAC_STATUS_STATE_WRITE_BIT 4
135#define KMAC_STATUS_FIFO_DEPTH_MASK 0x1fu
136#define KMAC_STATUS_FIFO_DEPTH_OFFSET 8
137#define KMAC_STATUS_FIFO_DEPTH_FIELD \
138 ((bitfield_field32_t) { .mask = KMAC_STATUS_FIFO_DEPTH_MASK, .index = KMAC_STATUS_FIFO_DEPTH_OFFSET })
139#define KMAC_STATUS_FIFO_EMPTY_BIT 14
140#define KMAC_STATUS_FIFO_FULL_BIT 15
141#define KMAC_STATUS_ENTROPY_READY_BIT 20
142#define KMAC_STATUS_ENTROPY_RESEEDING_BIT 21
143#define KMAC_STATUS_ALERT_FATAL_FAULT_BIT 28
144#define KMAC_STATUS_ALERT_RECOV_CTRL_UPDATE_ERR_BIT 29
145
146// Software lock for the !!ENTROPY_CFG_SHADOWED register.
147#define KMAC_ENTROPY_CFG_LOCK_REG_OFFSET 0x20
148#define KMAC_ENTROPY_CFG_LOCK_REG_RESVAL 0x0u
149#define KMAC_ENTROPY_CFG_LOCK_ENTROPY_CFG_LOCK_BIT 0
150
151// Register write enable for !!ENTROPY_CFG_SHADOWED register.
152#define KMAC_ENTROPY_CFG_REGWEN_REG_OFFSET 0x24
153#define KMAC_ENTROPY_CFG_REGWEN_REG_RESVAL 0x1u
154#define KMAC_ENTROPY_CFG_REGWEN_ENTROPY_CFG_REGWEN_BIT 0
155
156// Entropy Configuration register.
157#define KMAC_ENTROPY_CFG_SHADOWED_REG_OFFSET 0x28
158#define KMAC_ENTROPY_CFG_SHADOWED_REG_RESVAL 0x1u
159#define KMAC_ENTROPY_CFG_SHADOWED_ENTROPY_BOOT_MODE_BIT 0
160#define KMAC_ENTROPY_CFG_SHADOWED_ENTROPY_MODE_BIT 1
161#define KMAC_ENTROPY_CFG_SHADOWED_ENTROPY_MODE_VALUE_EDN_MODE 0x0
162#define KMAC_ENTROPY_CFG_SHADOWED_ENTROPY_MODE_VALUE_SW_MODE 0x1
163#define KMAC_ENTROPY_CFG_SHADOWED_IGNORE_CMD_ENTROPY_REQ_BIT 2
164#define KMAC_ENTROPY_CFG_SHADOWED_EDN_MODE_REFRESH_THRESHOLD_MASK 0x3ffu
165#define KMAC_ENTROPY_CFG_SHADOWED_EDN_MODE_REFRESH_THRESHOLD_OFFSET 16
166#define KMAC_ENTROPY_CFG_SHADOWED_EDN_MODE_REFRESH_THRESHOLD_FIELD \
167 ((bitfield_field32_t) { .mask = KMAC_ENTROPY_CFG_SHADOWED_EDN_MODE_REFRESH_THRESHOLD_MASK, .index = KMAC_ENTROPY_CFG_SHADOWED_EDN_MODE_REFRESH_THRESHOLD_OFFSET })
168
169// Entropy Seed
170#define KMAC_ENTROPY_SEED_REG_OFFSET 0x2c
171#define KMAC_ENTROPY_SEED_REG_RESVAL 0x0u
172
173// Entropy Refresh Counter
174#define KMAC_ENTROPY_REFRESH_HASH_CNT_REG_OFFSET 0x30
175#define KMAC_ENTROPY_REFRESH_HASH_CNT_REG_RESVAL 0x0u
176#define KMAC_ENTROPY_REFRESH_HASH_CNT_HASH_CNT_MASK 0x3ffu
177#define KMAC_ENTROPY_REFRESH_HASH_CNT_HASH_CNT_OFFSET 0
178#define KMAC_ENTROPY_REFRESH_HASH_CNT_HASH_CNT_FIELD \
179 ((bitfield_field32_t) { .mask = KMAC_ENTROPY_REFRESH_HASH_CNT_HASH_CNT_MASK, .index = KMAC_ENTROPY_REFRESH_HASH_CNT_HASH_CNT_OFFSET })
180
181// KMAC Secret Key
182#define KMAC_KEY_SHARE0_KEY_FIELD_WIDTH 32
183#define KMAC_KEY_SHARE0_MULTIREG_COUNT 16
184
185// KMAC Secret Key
186#define KMAC_KEY_SHARE0_0_REG_OFFSET 0x34
187#define KMAC_KEY_SHARE0_0_REG_RESVAL 0x0u
188
189// KMAC Secret Key
190#define KMAC_KEY_SHARE0_1_REG_OFFSET 0x38
191#define KMAC_KEY_SHARE0_1_REG_RESVAL 0x0u
192
193// KMAC Secret Key
194#define KMAC_KEY_SHARE0_2_REG_OFFSET 0x3c
195#define KMAC_KEY_SHARE0_2_REG_RESVAL 0x0u
196
197// KMAC Secret Key
198#define KMAC_KEY_SHARE0_3_REG_OFFSET 0x40
199#define KMAC_KEY_SHARE0_3_REG_RESVAL 0x0u
200
201// KMAC Secret Key
202#define KMAC_KEY_SHARE0_4_REG_OFFSET 0x44
203#define KMAC_KEY_SHARE0_4_REG_RESVAL 0x0u
204
205// KMAC Secret Key
206#define KMAC_KEY_SHARE0_5_REG_OFFSET 0x48
207#define KMAC_KEY_SHARE0_5_REG_RESVAL 0x0u
208
209// KMAC Secret Key
210#define KMAC_KEY_SHARE0_6_REG_OFFSET 0x4c
211#define KMAC_KEY_SHARE0_6_REG_RESVAL 0x0u
212
213// KMAC Secret Key
214#define KMAC_KEY_SHARE0_7_REG_OFFSET 0x50
215#define KMAC_KEY_SHARE0_7_REG_RESVAL 0x0u
216
217// KMAC Secret Key
218#define KMAC_KEY_SHARE0_8_REG_OFFSET 0x54
219#define KMAC_KEY_SHARE0_8_REG_RESVAL 0x0u
220
221// KMAC Secret Key
222#define KMAC_KEY_SHARE0_9_REG_OFFSET 0x58
223#define KMAC_KEY_SHARE0_9_REG_RESVAL 0x0u
224
225// KMAC Secret Key
226#define KMAC_KEY_SHARE0_10_REG_OFFSET 0x5c
227#define KMAC_KEY_SHARE0_10_REG_RESVAL 0x0u
228
229// KMAC Secret Key
230#define KMAC_KEY_SHARE0_11_REG_OFFSET 0x60
231#define KMAC_KEY_SHARE0_11_REG_RESVAL 0x0u
232
233// KMAC Secret Key
234#define KMAC_KEY_SHARE0_12_REG_OFFSET 0x64
235#define KMAC_KEY_SHARE0_12_REG_RESVAL 0x0u
236
237// KMAC Secret Key
238#define KMAC_KEY_SHARE0_13_REG_OFFSET 0x68
239#define KMAC_KEY_SHARE0_13_REG_RESVAL 0x0u
240
241// KMAC Secret Key
242#define KMAC_KEY_SHARE0_14_REG_OFFSET 0x6c
243#define KMAC_KEY_SHARE0_14_REG_RESVAL 0x0u
244
245// KMAC Secret Key
246#define KMAC_KEY_SHARE0_15_REG_OFFSET 0x70
247#define KMAC_KEY_SHARE0_15_REG_RESVAL 0x0u
248
249// KMAC Secret Key, 2nd share.
250#define KMAC_KEY_SHARE1_KEY_FIELD_WIDTH 32
251#define KMAC_KEY_SHARE1_MULTIREG_COUNT 16
252
253// KMAC Secret Key, 2nd share.
254#define KMAC_KEY_SHARE1_0_REG_OFFSET 0x74
255#define KMAC_KEY_SHARE1_0_REG_RESVAL 0x0u
256
257// KMAC Secret Key, 2nd share.
258#define KMAC_KEY_SHARE1_1_REG_OFFSET 0x78
259#define KMAC_KEY_SHARE1_1_REG_RESVAL 0x0u
260
261// KMAC Secret Key, 2nd share.
262#define KMAC_KEY_SHARE1_2_REG_OFFSET 0x7c
263#define KMAC_KEY_SHARE1_2_REG_RESVAL 0x0u
264
265// KMAC Secret Key, 2nd share.
266#define KMAC_KEY_SHARE1_3_REG_OFFSET 0x80
267#define KMAC_KEY_SHARE1_3_REG_RESVAL 0x0u
268
269// KMAC Secret Key, 2nd share.
270#define KMAC_KEY_SHARE1_4_REG_OFFSET 0x84
271#define KMAC_KEY_SHARE1_4_REG_RESVAL 0x0u
272
273// KMAC Secret Key, 2nd share.
274#define KMAC_KEY_SHARE1_5_REG_OFFSET 0x88
275#define KMAC_KEY_SHARE1_5_REG_RESVAL 0x0u
276
277// KMAC Secret Key, 2nd share.
278#define KMAC_KEY_SHARE1_6_REG_OFFSET 0x8c
279#define KMAC_KEY_SHARE1_6_REG_RESVAL 0x0u
280
281// KMAC Secret Key, 2nd share.
282#define KMAC_KEY_SHARE1_7_REG_OFFSET 0x90
283#define KMAC_KEY_SHARE1_7_REG_RESVAL 0x0u
284
285// KMAC Secret Key, 2nd share.
286#define KMAC_KEY_SHARE1_8_REG_OFFSET 0x94
287#define KMAC_KEY_SHARE1_8_REG_RESVAL 0x0u
288
289// KMAC Secret Key, 2nd share.
290#define KMAC_KEY_SHARE1_9_REG_OFFSET 0x98
291#define KMAC_KEY_SHARE1_9_REG_RESVAL 0x0u
292
293// KMAC Secret Key, 2nd share.
294#define KMAC_KEY_SHARE1_10_REG_OFFSET 0x9c
295#define KMAC_KEY_SHARE1_10_REG_RESVAL 0x0u
296
297// KMAC Secret Key, 2nd share.
298#define KMAC_KEY_SHARE1_11_REG_OFFSET 0xa0
299#define KMAC_KEY_SHARE1_11_REG_RESVAL 0x0u
300
301// KMAC Secret Key, 2nd share.
302#define KMAC_KEY_SHARE1_12_REG_OFFSET 0xa4
303#define KMAC_KEY_SHARE1_12_REG_RESVAL 0x0u
304
305// KMAC Secret Key, 2nd share.
306#define KMAC_KEY_SHARE1_13_REG_OFFSET 0xa8
307#define KMAC_KEY_SHARE1_13_REG_RESVAL 0x0u
308
309// KMAC Secret Key, 2nd share.
310#define KMAC_KEY_SHARE1_14_REG_OFFSET 0xac
311#define KMAC_KEY_SHARE1_14_REG_RESVAL 0x0u
312
313// KMAC Secret Key, 2nd share.
314#define KMAC_KEY_SHARE1_15_REG_OFFSET 0xb0
315#define KMAC_KEY_SHARE1_15_REG_RESVAL 0x0u
316
317// Secret Key length in bit.
318#define KMAC_KEY_LEN_REG_OFFSET 0xb4
319#define KMAC_KEY_LEN_REG_RESVAL 0x0u
320#define KMAC_KEY_LEN_LEN_MASK 0x7u
321#define KMAC_KEY_LEN_LEN_OFFSET 0
322#define KMAC_KEY_LEN_LEN_FIELD \
323 ((bitfield_field32_t) { .mask = KMAC_KEY_LEN_LEN_MASK, .index = KMAC_KEY_LEN_LEN_OFFSET })
324#define KMAC_KEY_LEN_LEN_VALUE_KEY128 0x0
325#define KMAC_KEY_LEN_LEN_VALUE_KEY192 0x1
326#define KMAC_KEY_LEN_LEN_VALUE_KEY256 0x2
327#define KMAC_KEY_LEN_LEN_VALUE_KEY384 0x3
328#define KMAC_KEY_LEN_LEN_VALUE_KEY512 0x4
329
330// cSHAKE Prefix register.
331#define KMAC_PREFIX_PREFIX_FIELD_WIDTH 32
332#define KMAC_PREFIX_MULTIREG_COUNT 11
333
334// cSHAKE Prefix register.
335#define KMAC_PREFIX_0_REG_OFFSET 0xb8
336#define KMAC_PREFIX_0_REG_RESVAL 0x0u
337
338// cSHAKE Prefix register.
339#define KMAC_PREFIX_1_REG_OFFSET 0xbc
340#define KMAC_PREFIX_1_REG_RESVAL 0x0u
341
342// cSHAKE Prefix register.
343#define KMAC_PREFIX_2_REG_OFFSET 0xc0
344#define KMAC_PREFIX_2_REG_RESVAL 0x0u
345
346// cSHAKE Prefix register.
347#define KMAC_PREFIX_3_REG_OFFSET 0xc4
348#define KMAC_PREFIX_3_REG_RESVAL 0x0u
349
350// cSHAKE Prefix register.
351#define KMAC_PREFIX_4_REG_OFFSET 0xc8
352#define KMAC_PREFIX_4_REG_RESVAL 0x0u
353
354// cSHAKE Prefix register.
355#define KMAC_PREFIX_5_REG_OFFSET 0xcc
356#define KMAC_PREFIX_5_REG_RESVAL 0x0u
357
358// cSHAKE Prefix register.
359#define KMAC_PREFIX_6_REG_OFFSET 0xd0
360#define KMAC_PREFIX_6_REG_RESVAL 0x0u
361
362// cSHAKE Prefix register.
363#define KMAC_PREFIX_7_REG_OFFSET 0xd4
364#define KMAC_PREFIX_7_REG_RESVAL 0x0u
365
366// cSHAKE Prefix register.
367#define KMAC_PREFIX_8_REG_OFFSET 0xd8
368#define KMAC_PREFIX_8_REG_RESVAL 0x0u
369
370// cSHAKE Prefix register.
371#define KMAC_PREFIX_9_REG_OFFSET 0xdc
372#define KMAC_PREFIX_9_REG_RESVAL 0x0u
373
374// cSHAKE Prefix register.
375#define KMAC_PREFIX_10_REG_OFFSET 0xe0
376#define KMAC_PREFIX_10_REG_RESVAL 0x0u
377
378// KMAC/SHA3 Error Code
379#define KMAC_ERR_CODE_REG_OFFSET 0xe4
380#define KMAC_ERR_CODE_REG_RESVAL 0x0u
381
382// Memory area: Keccak State (1600 bit) memory.
383#define KMAC_STATE_REG_OFFSET 0x400
384#define KMAC_STATE_SIZE_WORDS 128
385#define KMAC_STATE_SIZE_BYTES 512
386// Memory area: Message FIFO.
387#define KMAC_MSG_FIFO_REG_OFFSET 0x800
388#define KMAC_MSG_FIFO_SIZE_WORDS 512
389#define KMAC_MSG_FIFO_SIZE_BYTES 2048
390#ifdef __cplusplus
391} // extern "C"
392#endif
393#endif // _KMAC_REG_DEFS_
394// End generated register defines for kmac