Software APIs
keymgr_dpe_regs.h
Go to the documentation of this file.
1/**
2 * @file
3 * @brief Generated register defines for keymgr_dpe
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 _KEYMGR_DPE_REG_DEFS_
14#define _KEYMGR_DPE_REG_DEFS_
15
16#ifdef __cplusplus
17extern "C" {
18#endif
19// Number of Registers for SW inputs (Salt)
20#define KEYMGR_DPE_PARAM_NUM_SALT_REG 8
21
22// Number of Registers for SW inputs (SW binding)
23#define KEYMGR_DPE_PARAM_NUM_SW_BINDING_REG 8
24
25// Number of Registers for SW outputs
26#define KEYMGR_DPE_PARAM_NUM_OUT_REG 12
27
28// Number of maximum supported HW slots. If this value is changed then the
29#define KEYMGR_DPE_PARAM_NUM_MAX_HW_SLOT 8
30
31// Number of alerts
32#define KEYMGR_DPE_PARAM_NUM_ALERTS 2
33
34// Register width
35#define KEYMGR_DPE_PARAM_REG_WIDTH 32
36
37// Common Interrupt Offsets
38#define KEYMGR_DPE_INTR_COMMON_OP_DONE_BIT 0
39
40// Interrupt State Register
41#define KEYMGR_DPE_INTR_STATE_REG_OFFSET 0x0
42#define KEYMGR_DPE_INTR_STATE_REG_RESVAL 0x0u
43#define KEYMGR_DPE_INTR_STATE_OP_DONE_BIT 0
44
45// Interrupt Enable Register
46#define KEYMGR_DPE_INTR_ENABLE_REG_OFFSET 0x4
47#define KEYMGR_DPE_INTR_ENABLE_REG_RESVAL 0x0u
48#define KEYMGR_DPE_INTR_ENABLE_OP_DONE_BIT 0
49
50// Interrupt Test Register
51#define KEYMGR_DPE_INTR_TEST_REG_OFFSET 0x8
52#define KEYMGR_DPE_INTR_TEST_REG_RESVAL 0x0u
53#define KEYMGR_DPE_INTR_TEST_OP_DONE_BIT 0
54
55// Alert Test Register
56#define KEYMGR_DPE_ALERT_TEST_REG_OFFSET 0xc
57#define KEYMGR_DPE_ALERT_TEST_REG_RESVAL 0x80000000u
58#define KEYMGR_DPE_ALERT_TEST_RECOV_OPERATION_ERR_BIT 0
59#define KEYMGR_DPE_ALERT_TEST_FATAL_FAULT_ERR_BIT 1
60#define KEYMGR_DPE_ALERT_TEST_REGWEN_BIT 31
61
62// Key manager configuration enable
63#define KEYMGR_DPE_CFG_REGWEN_REG_OFFSET 0x10
64#define KEYMGR_DPE_CFG_REGWEN_REG_RESVAL 0x1u
65#define KEYMGR_DPE_CFG_REGWEN_EN_BIT 0
66
67// Key manager operation start
68#define KEYMGR_DPE_START_REG_OFFSET 0x14
69#define KEYMGR_DPE_START_REG_RESVAL 0x0u
70#define KEYMGR_DPE_START_EN_BIT 0
71#define KEYMGR_DPE_START_EN_VALUE_VALID_STATE 0x1
72
73// Key manager operation controls
74#define KEYMGR_DPE_CONTROL_SHADOWED_REG_OFFSET 0x18
75#define KEYMGR_DPE_CONTROL_SHADOWED_REG_RESVAL 0x10u
76#define KEYMGR_DPE_CONTROL_SHADOWED_OPERATION_MASK 0x7u
77#define KEYMGR_DPE_CONTROL_SHADOWED_OPERATION_OFFSET 4
78#define KEYMGR_DPE_CONTROL_SHADOWED_OPERATION_FIELD \
79 ((bitfield_field32_t) { .mask = KEYMGR_DPE_CONTROL_SHADOWED_OPERATION_MASK, .index = KEYMGR_DPE_CONTROL_SHADOWED_OPERATION_OFFSET })
80#define KEYMGR_DPE_CONTROL_SHADOWED_OPERATION_VALUE_ADVANCE 0x0
81#define KEYMGR_DPE_CONTROL_SHADOWED_OPERATION_VALUE_ERASE_SLOT 0x1
82#define KEYMGR_DPE_CONTROL_SHADOWED_OPERATION_VALUE_GENERATE_SW_OUTPUT 0x2
83#define KEYMGR_DPE_CONTROL_SHADOWED_OPERATION_VALUE_GENERATE_HW_OUTPUT 0x3
84#define KEYMGR_DPE_CONTROL_SHADOWED_OPERATION_VALUE_DISABLE 0x4
85#define KEYMGR_DPE_CONTROL_SHADOWED_OPERATION_VALUE_LOAD_ROOT_KEY 0x5
86#define KEYMGR_DPE_CONTROL_SHADOWED_OPERATION_VALUE_LOAD_SECONDARY_ROOT_KEY 0x6
87#define KEYMGR_DPE_CONTROL_SHADOWED_DEST_SEL_MASK 0x7u
88#define KEYMGR_DPE_CONTROL_SHADOWED_DEST_SEL_OFFSET 11
89#define KEYMGR_DPE_CONTROL_SHADOWED_DEST_SEL_FIELD \
90 ((bitfield_field32_t) { .mask = KEYMGR_DPE_CONTROL_SHADOWED_DEST_SEL_MASK, .index = KEYMGR_DPE_CONTROL_SHADOWED_DEST_SEL_OFFSET })
91#define KEYMGR_DPE_CONTROL_SHADOWED_DEST_SEL_VALUE_NONE 0x0
92#define KEYMGR_DPE_CONTROL_SHADOWED_DEST_SEL_VALUE_AES 0x1
93#define KEYMGR_DPE_CONTROL_SHADOWED_DEST_SEL_VALUE_KMAC 0x2
94#define KEYMGR_DPE_CONTROL_SHADOWED_DEST_SEL_VALUE_OTBN 0x3
95#define KEYMGR_DPE_CONTROL_SHADOWED_DEST_SEL_VALUE_HMAC 0x4
96#define KEYMGR_DPE_CONTROL_SHADOWED_SLOT_SRC_SEL_MASK 0x7u
97#define KEYMGR_DPE_CONTROL_SHADOWED_SLOT_SRC_SEL_OFFSET 14
98#define KEYMGR_DPE_CONTROL_SHADOWED_SLOT_SRC_SEL_FIELD \
99 ((bitfield_field32_t) { .mask = KEYMGR_DPE_CONTROL_SHADOWED_SLOT_SRC_SEL_MASK, .index = KEYMGR_DPE_CONTROL_SHADOWED_SLOT_SRC_SEL_OFFSET })
100#define KEYMGR_DPE_CONTROL_SHADOWED_SLOT_DST_SEL_MASK 0x7u
101#define KEYMGR_DPE_CONTROL_SHADOWED_SLOT_DST_SEL_OFFSET 18
102#define KEYMGR_DPE_CONTROL_SHADOWED_SLOT_DST_SEL_FIELD \
103 ((bitfield_field32_t) { .mask = KEYMGR_DPE_CONTROL_SHADOWED_SLOT_DST_SEL_MASK, .index = KEYMGR_DPE_CONTROL_SHADOWED_SLOT_DST_SEL_OFFSET })
104#define KEYMGR_DPE_CONTROL_SHADOWED_SW_BINDING_ONLY_BIT 22
105
106// sideload key slots clear
107#define KEYMGR_DPE_SIDELOAD_CLEAR_REG_OFFSET 0x1c
108#define KEYMGR_DPE_SIDELOAD_CLEAR_REG_RESVAL 0x0u
109#define KEYMGR_DPE_SIDELOAD_CLEAR_VAL_MASK 0x7u
110#define KEYMGR_DPE_SIDELOAD_CLEAR_VAL_OFFSET 0
111#define KEYMGR_DPE_SIDELOAD_CLEAR_VAL_FIELD \
112 ((bitfield_field32_t) { .mask = KEYMGR_DPE_SIDELOAD_CLEAR_VAL_MASK, .index = KEYMGR_DPE_SIDELOAD_CLEAR_VAL_OFFSET })
113#define KEYMGR_DPE_SIDELOAD_CLEAR_VAL_VALUE_NONE 0x0
114#define KEYMGR_DPE_SIDELOAD_CLEAR_VAL_VALUE_AES 0x1
115#define KEYMGR_DPE_SIDELOAD_CLEAR_VAL_VALUE_KMAC 0x2
116#define KEYMGR_DPE_SIDELOAD_CLEAR_VAL_VALUE_OTBN 0x3
117#define KEYMGR_DPE_SIDELOAD_CLEAR_VAL_VALUE_HMAC 0x4
118
119// regwen for reseed interval
120#define KEYMGR_DPE_RESEED_INTERVAL_REGWEN_REG_OFFSET 0x20
121#define KEYMGR_DPE_RESEED_INTERVAL_REGWEN_REG_RESVAL 0x1u
122#define KEYMGR_DPE_RESEED_INTERVAL_REGWEN_EN_BIT 0
123
124// Reseed interval for key manager entropy reseed
125#define KEYMGR_DPE_RESEED_INTERVAL_SHADOWED_REG_OFFSET 0x24
126#define KEYMGR_DPE_RESEED_INTERVAL_SHADOWED_REG_RESVAL 0x100u
127#define KEYMGR_DPE_RESEED_INTERVAL_SHADOWED_VAL_MASK 0xffffu
128#define KEYMGR_DPE_RESEED_INTERVAL_SHADOWED_VAL_OFFSET 0
129#define KEYMGR_DPE_RESEED_INTERVAL_SHADOWED_VAL_FIELD \
130 ((bitfield_field32_t) { .mask = KEYMGR_DPE_RESEED_INTERVAL_SHADOWED_VAL_MASK, .index = KEYMGR_DPE_RESEED_INTERVAL_SHADOWED_VAL_OFFSET })
131
132// Register write enable for KDF_ENGINE
133#define KEYMGR_DPE_KDF_ENGINE_REGWEN_REG_OFFSET 0x28
134#define KEYMGR_DPE_KDF_ENGINE_REGWEN_REG_RESVAL 0x1u
135#define KEYMGR_DPE_KDF_ENGINE_REGWEN_EN_BIT 0
136
137// Selects the engine used to perform key derivation if KdfEngineSel equals
138// `KdfEngineBoth`, otherwise ignored.
139#define KEYMGR_DPE_KDF_ENGINE_SHADOWED_REG_OFFSET 0x2c
140#define KEYMGR_DPE_KDF_ENGINE_SHADOWED_REG_RESVAL 0x9u
141#define KEYMGR_DPE_KDF_ENGINE_SHADOWED_SEL_MASK 0xfu
142#define KEYMGR_DPE_KDF_ENGINE_SHADOWED_SEL_OFFSET 0
143#define KEYMGR_DPE_KDF_ENGINE_SHADOWED_SEL_FIELD \
144 ((bitfield_field32_t) { .mask = KEYMGR_DPE_KDF_ENGINE_SHADOWED_SEL_MASK, .index = KEYMGR_DPE_KDF_ENGINE_SHADOWED_SEL_OFFSET })
145
146// Register write enable for SLOT_POLICY
147#define KEYMGR_DPE_SLOT_POLICY_REGWEN_REG_OFFSET 0x30
148#define KEYMGR_DPE_SLOT_POLICY_REGWEN_REG_RESVAL 0x1u
149#define KEYMGR_DPE_SLOT_POLICY_REGWEN_EN_BIT 0
150
151// Policy bits for the child DPE context
152#define KEYMGR_DPE_SLOT_POLICY_REG_OFFSET 0x34
153#define KEYMGR_DPE_SLOT_POLICY_REG_RESVAL 0x0u
154#define KEYMGR_DPE_SLOT_POLICY_ALLOW_CHILD_BIT 0
155#define KEYMGR_DPE_SLOT_POLICY_EXPORTABLE_BIT 1
156#define KEYMGR_DPE_SLOT_POLICY_RETAIN_PARENT_BIT 2
157#define KEYMGR_DPE_SLOT_POLICY_ALLOW_KEYGEN_BIT 3
158
159// Register write enable for SOFTWARE_BINDING
160#define KEYMGR_DPE_SW_BINDING_REGWEN_REG_OFFSET 0x38
161#define KEYMGR_DPE_SW_BINDING_REGWEN_REG_RESVAL 0x1u
162#define KEYMGR_DPE_SW_BINDING_REGWEN_EN_BIT 0
163
164// Software binding input of the key manager.
165#define KEYMGR_DPE_SW_BINDING_VAL_FIELD_WIDTH 32
166#define KEYMGR_DPE_SW_BINDING_MULTIREG_COUNT 8
167
168// Software binding input of the key manager.
169#define KEYMGR_DPE_SW_BINDING_0_REG_OFFSET 0x3c
170#define KEYMGR_DPE_SW_BINDING_0_REG_RESVAL 0x0u
171
172// Software binding input of the key manager.
173#define KEYMGR_DPE_SW_BINDING_1_REG_OFFSET 0x40
174#define KEYMGR_DPE_SW_BINDING_1_REG_RESVAL 0x0u
175
176// Software binding input of the key manager.
177#define KEYMGR_DPE_SW_BINDING_2_REG_OFFSET 0x44
178#define KEYMGR_DPE_SW_BINDING_2_REG_RESVAL 0x0u
179
180// Software binding input of the key manager.
181#define KEYMGR_DPE_SW_BINDING_3_REG_OFFSET 0x48
182#define KEYMGR_DPE_SW_BINDING_3_REG_RESVAL 0x0u
183
184// Software binding input of the key manager.
185#define KEYMGR_DPE_SW_BINDING_4_REG_OFFSET 0x4c
186#define KEYMGR_DPE_SW_BINDING_4_REG_RESVAL 0x0u
187
188// Software binding input of the key manager.
189#define KEYMGR_DPE_SW_BINDING_5_REG_OFFSET 0x50
190#define KEYMGR_DPE_SW_BINDING_5_REG_RESVAL 0x0u
191
192// Software binding input of the key manager.
193#define KEYMGR_DPE_SW_BINDING_6_REG_OFFSET 0x54
194#define KEYMGR_DPE_SW_BINDING_6_REG_RESVAL 0x0u
195
196// Software binding input of the key manager.
197#define KEYMGR_DPE_SW_BINDING_7_REG_OFFSET 0x58
198#define KEYMGR_DPE_SW_BINDING_7_REG_RESVAL 0x0u
199
200// Salt value used as part of output generation. (common parameters)
201#define KEYMGR_DPE_SALT_VAL_FIELD_WIDTH 32
202#define KEYMGR_DPE_SALT_MULTIREG_COUNT 8
203
204// Salt value used as part of output generation.
205#define KEYMGR_DPE_SALT_0_REG_OFFSET 0x5c
206#define KEYMGR_DPE_SALT_0_REG_RESVAL 0x0u
207
208// Salt value used as part of output generation.
209#define KEYMGR_DPE_SALT_1_REG_OFFSET 0x60
210#define KEYMGR_DPE_SALT_1_REG_RESVAL 0x0u
211
212// Salt value used as part of output generation.
213#define KEYMGR_DPE_SALT_2_REG_OFFSET 0x64
214#define KEYMGR_DPE_SALT_2_REG_RESVAL 0x0u
215
216// Salt value used as part of output generation.
217#define KEYMGR_DPE_SALT_3_REG_OFFSET 0x68
218#define KEYMGR_DPE_SALT_3_REG_RESVAL 0x0u
219
220// Salt value used as part of output generation.
221#define KEYMGR_DPE_SALT_4_REG_OFFSET 0x6c
222#define KEYMGR_DPE_SALT_4_REG_RESVAL 0x0u
223
224// Salt value used as part of output generation.
225#define KEYMGR_DPE_SALT_5_REG_OFFSET 0x70
226#define KEYMGR_DPE_SALT_5_REG_RESVAL 0x0u
227
228// Salt value used as part of output generation.
229#define KEYMGR_DPE_SALT_6_REG_OFFSET 0x74
230#define KEYMGR_DPE_SALT_6_REG_RESVAL 0x0u
231
232// Salt value used as part of output generation.
233#define KEYMGR_DPE_SALT_7_REG_OFFSET 0x78
234#define KEYMGR_DPE_SALT_7_REG_RESVAL 0x0u
235
236// Version used as part of output generation.
237#define KEYMGR_DPE_KEY_VERSION_REG_OFFSET 0x7c
238#define KEYMGR_DPE_KEY_VERSION_REG_RESVAL 0x0u
239
240// Register write enable for MAX_KEY_VERSION
241#define KEYMGR_DPE_MAX_KEY_VER_REGWEN_REG_OFFSET 0x80
242#define KEYMGR_DPE_MAX_KEY_VER_REGWEN_REG_RESVAL 0x1u
243#define KEYMGR_DPE_MAX_KEY_VER_REGWEN_EN_BIT 0
244
245// Max key version
246#define KEYMGR_DPE_MAX_KEY_VER_SHADOWED_REG_OFFSET 0x84
247#define KEYMGR_DPE_MAX_KEY_VER_SHADOWED_REG_RESVAL 0x0u
248
249// Key manager software output.
250#define KEYMGR_DPE_SW_SHARE0_OUTPUT_VAL_FIELD_WIDTH 32
251#define KEYMGR_DPE_SW_SHARE0_OUTPUT_MULTIREG_COUNT 12
252
253// Key manager software output.
254#define KEYMGR_DPE_SW_SHARE0_OUTPUT_0_REG_OFFSET 0x88
255#define KEYMGR_DPE_SW_SHARE0_OUTPUT_0_REG_RESVAL 0x0u
256
257// Key manager software output.
258#define KEYMGR_DPE_SW_SHARE0_OUTPUT_1_REG_OFFSET 0x8c
259#define KEYMGR_DPE_SW_SHARE0_OUTPUT_1_REG_RESVAL 0x0u
260
261// Key manager software output.
262#define KEYMGR_DPE_SW_SHARE0_OUTPUT_2_REG_OFFSET 0x90
263#define KEYMGR_DPE_SW_SHARE0_OUTPUT_2_REG_RESVAL 0x0u
264
265// Key manager software output.
266#define KEYMGR_DPE_SW_SHARE0_OUTPUT_3_REG_OFFSET 0x94
267#define KEYMGR_DPE_SW_SHARE0_OUTPUT_3_REG_RESVAL 0x0u
268
269// Key manager software output.
270#define KEYMGR_DPE_SW_SHARE0_OUTPUT_4_REG_OFFSET 0x98
271#define KEYMGR_DPE_SW_SHARE0_OUTPUT_4_REG_RESVAL 0x0u
272
273// Key manager software output.
274#define KEYMGR_DPE_SW_SHARE0_OUTPUT_5_REG_OFFSET 0x9c
275#define KEYMGR_DPE_SW_SHARE0_OUTPUT_5_REG_RESVAL 0x0u
276
277// Key manager software output.
278#define KEYMGR_DPE_SW_SHARE0_OUTPUT_6_REG_OFFSET 0xa0
279#define KEYMGR_DPE_SW_SHARE0_OUTPUT_6_REG_RESVAL 0x0u
280
281// Key manager software output.
282#define KEYMGR_DPE_SW_SHARE0_OUTPUT_7_REG_OFFSET 0xa4
283#define KEYMGR_DPE_SW_SHARE0_OUTPUT_7_REG_RESVAL 0x0u
284
285// Key manager software output.
286#define KEYMGR_DPE_SW_SHARE0_OUTPUT_8_REG_OFFSET 0xa8
287#define KEYMGR_DPE_SW_SHARE0_OUTPUT_8_REG_RESVAL 0x0u
288
289// Key manager software output.
290#define KEYMGR_DPE_SW_SHARE0_OUTPUT_9_REG_OFFSET 0xac
291#define KEYMGR_DPE_SW_SHARE0_OUTPUT_9_REG_RESVAL 0x0u
292
293// Key manager software output.
294#define KEYMGR_DPE_SW_SHARE0_OUTPUT_10_REG_OFFSET 0xb0
295#define KEYMGR_DPE_SW_SHARE0_OUTPUT_10_REG_RESVAL 0x0u
296
297// Key manager software output.
298#define KEYMGR_DPE_SW_SHARE0_OUTPUT_11_REG_OFFSET 0xb4
299#define KEYMGR_DPE_SW_SHARE0_OUTPUT_11_REG_RESVAL 0x0u
300
301// Key manager software output.
302#define KEYMGR_DPE_SW_SHARE1_OUTPUT_VAL_FIELD_WIDTH 32
303#define KEYMGR_DPE_SW_SHARE1_OUTPUT_MULTIREG_COUNT 12
304
305// Key manager software output.
306#define KEYMGR_DPE_SW_SHARE1_OUTPUT_0_REG_OFFSET 0xb8
307#define KEYMGR_DPE_SW_SHARE1_OUTPUT_0_REG_RESVAL 0x0u
308
309// Key manager software output.
310#define KEYMGR_DPE_SW_SHARE1_OUTPUT_1_REG_OFFSET 0xbc
311#define KEYMGR_DPE_SW_SHARE1_OUTPUT_1_REG_RESVAL 0x0u
312
313// Key manager software output.
314#define KEYMGR_DPE_SW_SHARE1_OUTPUT_2_REG_OFFSET 0xc0
315#define KEYMGR_DPE_SW_SHARE1_OUTPUT_2_REG_RESVAL 0x0u
316
317// Key manager software output.
318#define KEYMGR_DPE_SW_SHARE1_OUTPUT_3_REG_OFFSET 0xc4
319#define KEYMGR_DPE_SW_SHARE1_OUTPUT_3_REG_RESVAL 0x0u
320
321// Key manager software output.
322#define KEYMGR_DPE_SW_SHARE1_OUTPUT_4_REG_OFFSET 0xc8
323#define KEYMGR_DPE_SW_SHARE1_OUTPUT_4_REG_RESVAL 0x0u
324
325// Key manager software output.
326#define KEYMGR_DPE_SW_SHARE1_OUTPUT_5_REG_OFFSET 0xcc
327#define KEYMGR_DPE_SW_SHARE1_OUTPUT_5_REG_RESVAL 0x0u
328
329// Key manager software output.
330#define KEYMGR_DPE_SW_SHARE1_OUTPUT_6_REG_OFFSET 0xd0
331#define KEYMGR_DPE_SW_SHARE1_OUTPUT_6_REG_RESVAL 0x0u
332
333// Key manager software output.
334#define KEYMGR_DPE_SW_SHARE1_OUTPUT_7_REG_OFFSET 0xd4
335#define KEYMGR_DPE_SW_SHARE1_OUTPUT_7_REG_RESVAL 0x0u
336
337// Key manager software output.
338#define KEYMGR_DPE_SW_SHARE1_OUTPUT_8_REG_OFFSET 0xd8
339#define KEYMGR_DPE_SW_SHARE1_OUTPUT_8_REG_RESVAL 0x0u
340
341// Key manager software output.
342#define KEYMGR_DPE_SW_SHARE1_OUTPUT_9_REG_OFFSET 0xdc
343#define KEYMGR_DPE_SW_SHARE1_OUTPUT_9_REG_RESVAL 0x0u
344
345// Key manager software output.
346#define KEYMGR_DPE_SW_SHARE1_OUTPUT_10_REG_OFFSET 0xe0
347#define KEYMGR_DPE_SW_SHARE1_OUTPUT_10_REG_RESVAL 0x0u
348
349// Key manager software output.
350#define KEYMGR_DPE_SW_SHARE1_OUTPUT_11_REG_OFFSET 0xe4
351#define KEYMGR_DPE_SW_SHARE1_OUTPUT_11_REG_RESVAL 0x0u
352
353// Key manager working state.
354#define KEYMGR_DPE_WORKING_STATE_REG_OFFSET 0xe8
355#define KEYMGR_DPE_WORKING_STATE_REG_RESVAL 0x0u
356#define KEYMGR_DPE_WORKING_STATE_STATE_MASK 0x3u
357#define KEYMGR_DPE_WORKING_STATE_STATE_OFFSET 0
358#define KEYMGR_DPE_WORKING_STATE_STATE_FIELD \
359 ((bitfield_field32_t) { .mask = KEYMGR_DPE_WORKING_STATE_STATE_MASK, .index = KEYMGR_DPE_WORKING_STATE_STATE_OFFSET })
360#define KEYMGR_DPE_WORKING_STATE_STATE_VALUE_RESET 0x0
361#define KEYMGR_DPE_WORKING_STATE_STATE_VALUE_AVAILABLE 0x1
362#define KEYMGR_DPE_WORKING_STATE_STATE_VALUE_DISABLED 0x2
363#define KEYMGR_DPE_WORKING_STATE_STATE_VALUE_INVALID 0x3
364
365// Key manager status.
366#define KEYMGR_DPE_OP_STATUS_REG_OFFSET 0xec
367#define KEYMGR_DPE_OP_STATUS_REG_RESVAL 0x0u
368#define KEYMGR_DPE_OP_STATUS_STATUS_MASK 0x3u
369#define KEYMGR_DPE_OP_STATUS_STATUS_OFFSET 0
370#define KEYMGR_DPE_OP_STATUS_STATUS_FIELD \
371 ((bitfield_field32_t) { .mask = KEYMGR_DPE_OP_STATUS_STATUS_MASK, .index = KEYMGR_DPE_OP_STATUS_STATUS_OFFSET })
372#define KEYMGR_DPE_OP_STATUS_STATUS_VALUE_IDLE 0x0
373#define KEYMGR_DPE_OP_STATUS_STATUS_VALUE_WIP 0x1
374#define KEYMGR_DPE_OP_STATUS_STATUS_VALUE_DONE_SUCCESS 0x2
375#define KEYMGR_DPE_OP_STATUS_STATUS_VALUE_DONE_ERROR 0x3
376
377// Read metadata (low word) for each HW slot.
378#define KEYMGR_DPE_METADATA_LOW_MAX_KEY_VERSION_FIELD_WIDTH 32
379#define KEYMGR_DPE_METADATA_LOW_MULTIREG_COUNT 8
380
381// Read metadata (low word) for each HW slot.
382#define KEYMGR_DPE_METADATA_LOW_0_REG_OFFSET 0xf0
383#define KEYMGR_DPE_METADATA_LOW_0_REG_RESVAL 0x0u
384
385// Read metadata (low word) for each HW slot.
386#define KEYMGR_DPE_METADATA_LOW_1_REG_OFFSET 0xf4
387#define KEYMGR_DPE_METADATA_LOW_1_REG_RESVAL 0x0u
388
389// Read metadata (low word) for each HW slot.
390#define KEYMGR_DPE_METADATA_LOW_2_REG_OFFSET 0xf8
391#define KEYMGR_DPE_METADATA_LOW_2_REG_RESVAL 0x0u
392
393// Read metadata (low word) for each HW slot.
394#define KEYMGR_DPE_METADATA_LOW_3_REG_OFFSET 0xfc
395#define KEYMGR_DPE_METADATA_LOW_3_REG_RESVAL 0x0u
396
397// Read metadata (low word) for each HW slot.
398#define KEYMGR_DPE_METADATA_LOW_4_REG_OFFSET 0x100
399#define KEYMGR_DPE_METADATA_LOW_4_REG_RESVAL 0x0u
400
401// Read metadata (low word) for each HW slot.
402#define KEYMGR_DPE_METADATA_LOW_5_REG_OFFSET 0x104
403#define KEYMGR_DPE_METADATA_LOW_5_REG_RESVAL 0x0u
404
405// Read metadata (low word) for each HW slot.
406#define KEYMGR_DPE_METADATA_LOW_6_REG_OFFSET 0x108
407#define KEYMGR_DPE_METADATA_LOW_6_REG_RESVAL 0x0u
408
409// Read metadata (low word) for each HW slot.
410#define KEYMGR_DPE_METADATA_LOW_7_REG_OFFSET 0x10c
411#define KEYMGR_DPE_METADATA_LOW_7_REG_RESVAL 0x0u
412
413// Read metadata (high word) for each HW slot.
414#define KEYMGR_DPE_METADATA_HIGH_VALID_FIELD_WIDTH 1
415#define KEYMGR_DPE_METADATA_HIGH_BOOT_STAGE_FIELD_WIDTH 3
416#define KEYMGR_DPE_METADATA_HIGH_ALLOW_CHILD_POLICY_FIELD_WIDTH 1
417#define KEYMGR_DPE_METADATA_HIGH_EXPORTABLE_POLICY_FIELD_WIDTH 1
418#define KEYMGR_DPE_METADATA_HIGH_RETAIN_PARENT_POLICY_FIELD_WIDTH 1
419#define KEYMGR_DPE_METADATA_HIGH_ALLOW_KEYGEN_POLICY_FIELD_WIDTH 1
420#define KEYMGR_DPE_METADATA_HIGH_MULTIREG_COUNT 8
421
422// Read metadata (high word) for each HW slot.
423#define KEYMGR_DPE_METADATA_HIGH_0_REG_OFFSET 0x110
424#define KEYMGR_DPE_METADATA_HIGH_0_REG_RESVAL 0x0u
425#define KEYMGR_DPE_METADATA_HIGH_0_VALID_0_BIT 0
426#define KEYMGR_DPE_METADATA_HIGH_0_BOOT_STAGE_0_MASK 0x7u
427#define KEYMGR_DPE_METADATA_HIGH_0_BOOT_STAGE_0_OFFSET 1
428#define KEYMGR_DPE_METADATA_HIGH_0_BOOT_STAGE_0_FIELD \
429 ((bitfield_field32_t) { .mask = KEYMGR_DPE_METADATA_HIGH_0_BOOT_STAGE_0_MASK, .index = KEYMGR_DPE_METADATA_HIGH_0_BOOT_STAGE_0_OFFSET })
430#define KEYMGR_DPE_METADATA_HIGH_0_ALLOW_CHILD_POLICY_0_BIT 4
431#define KEYMGR_DPE_METADATA_HIGH_0_EXPORTABLE_POLICY_0_BIT 5
432#define KEYMGR_DPE_METADATA_HIGH_0_RETAIN_PARENT_POLICY_0_BIT 6
433#define KEYMGR_DPE_METADATA_HIGH_0_ALLOW_KEYGEN_POLICY_0_BIT 7
434
435// Read metadata (high word) for each HW slot.
436#define KEYMGR_DPE_METADATA_HIGH_1_REG_OFFSET 0x114
437#define KEYMGR_DPE_METADATA_HIGH_1_REG_RESVAL 0x0u
438#define KEYMGR_DPE_METADATA_HIGH_1_VALID_1_BIT 0
439#define KEYMGR_DPE_METADATA_HIGH_1_BOOT_STAGE_1_MASK 0x7u
440#define KEYMGR_DPE_METADATA_HIGH_1_BOOT_STAGE_1_OFFSET 1
441#define KEYMGR_DPE_METADATA_HIGH_1_BOOT_STAGE_1_FIELD \
442 ((bitfield_field32_t) { .mask = KEYMGR_DPE_METADATA_HIGH_1_BOOT_STAGE_1_MASK, .index = KEYMGR_DPE_METADATA_HIGH_1_BOOT_STAGE_1_OFFSET })
443#define KEYMGR_DPE_METADATA_HIGH_1_ALLOW_CHILD_POLICY_1_BIT 4
444#define KEYMGR_DPE_METADATA_HIGH_1_EXPORTABLE_POLICY_1_BIT 5
445#define KEYMGR_DPE_METADATA_HIGH_1_RETAIN_PARENT_POLICY_1_BIT 6
446#define KEYMGR_DPE_METADATA_HIGH_1_ALLOW_KEYGEN_POLICY_1_BIT 7
447
448// Read metadata (high word) for each HW slot.
449#define KEYMGR_DPE_METADATA_HIGH_2_REG_OFFSET 0x118
450#define KEYMGR_DPE_METADATA_HIGH_2_REG_RESVAL 0x0u
451#define KEYMGR_DPE_METADATA_HIGH_2_VALID_2_BIT 0
452#define KEYMGR_DPE_METADATA_HIGH_2_BOOT_STAGE_2_MASK 0x7u
453#define KEYMGR_DPE_METADATA_HIGH_2_BOOT_STAGE_2_OFFSET 1
454#define KEYMGR_DPE_METADATA_HIGH_2_BOOT_STAGE_2_FIELD \
455 ((bitfield_field32_t) { .mask = KEYMGR_DPE_METADATA_HIGH_2_BOOT_STAGE_2_MASK, .index = KEYMGR_DPE_METADATA_HIGH_2_BOOT_STAGE_2_OFFSET })
456#define KEYMGR_DPE_METADATA_HIGH_2_ALLOW_CHILD_POLICY_2_BIT 4
457#define KEYMGR_DPE_METADATA_HIGH_2_EXPORTABLE_POLICY_2_BIT 5
458#define KEYMGR_DPE_METADATA_HIGH_2_RETAIN_PARENT_POLICY_2_BIT 6
459#define KEYMGR_DPE_METADATA_HIGH_2_ALLOW_KEYGEN_POLICY_2_BIT 7
460
461// Read metadata (high word) for each HW slot.
462#define KEYMGR_DPE_METADATA_HIGH_3_REG_OFFSET 0x11c
463#define KEYMGR_DPE_METADATA_HIGH_3_REG_RESVAL 0x0u
464#define KEYMGR_DPE_METADATA_HIGH_3_VALID_3_BIT 0
465#define KEYMGR_DPE_METADATA_HIGH_3_BOOT_STAGE_3_MASK 0x7u
466#define KEYMGR_DPE_METADATA_HIGH_3_BOOT_STAGE_3_OFFSET 1
467#define KEYMGR_DPE_METADATA_HIGH_3_BOOT_STAGE_3_FIELD \
468 ((bitfield_field32_t) { .mask = KEYMGR_DPE_METADATA_HIGH_3_BOOT_STAGE_3_MASK, .index = KEYMGR_DPE_METADATA_HIGH_3_BOOT_STAGE_3_OFFSET })
469#define KEYMGR_DPE_METADATA_HIGH_3_ALLOW_CHILD_POLICY_3_BIT 4
470#define KEYMGR_DPE_METADATA_HIGH_3_EXPORTABLE_POLICY_3_BIT 5
471#define KEYMGR_DPE_METADATA_HIGH_3_RETAIN_PARENT_POLICY_3_BIT 6
472#define KEYMGR_DPE_METADATA_HIGH_3_ALLOW_KEYGEN_POLICY_3_BIT 7
473
474// Read metadata (high word) for each HW slot.
475#define KEYMGR_DPE_METADATA_HIGH_4_REG_OFFSET 0x120
476#define KEYMGR_DPE_METADATA_HIGH_4_REG_RESVAL 0x0u
477#define KEYMGR_DPE_METADATA_HIGH_4_VALID_4_BIT 0
478#define KEYMGR_DPE_METADATA_HIGH_4_BOOT_STAGE_4_MASK 0x7u
479#define KEYMGR_DPE_METADATA_HIGH_4_BOOT_STAGE_4_OFFSET 1
480#define KEYMGR_DPE_METADATA_HIGH_4_BOOT_STAGE_4_FIELD \
481 ((bitfield_field32_t) { .mask = KEYMGR_DPE_METADATA_HIGH_4_BOOT_STAGE_4_MASK, .index = KEYMGR_DPE_METADATA_HIGH_4_BOOT_STAGE_4_OFFSET })
482#define KEYMGR_DPE_METADATA_HIGH_4_ALLOW_CHILD_POLICY_4_BIT 4
483#define KEYMGR_DPE_METADATA_HIGH_4_EXPORTABLE_POLICY_4_BIT 5
484#define KEYMGR_DPE_METADATA_HIGH_4_RETAIN_PARENT_POLICY_4_BIT 6
485#define KEYMGR_DPE_METADATA_HIGH_4_ALLOW_KEYGEN_POLICY_4_BIT 7
486
487// Read metadata (high word) for each HW slot.
488#define KEYMGR_DPE_METADATA_HIGH_5_REG_OFFSET 0x124
489#define KEYMGR_DPE_METADATA_HIGH_5_REG_RESVAL 0x0u
490#define KEYMGR_DPE_METADATA_HIGH_5_VALID_5_BIT 0
491#define KEYMGR_DPE_METADATA_HIGH_5_BOOT_STAGE_5_MASK 0x7u
492#define KEYMGR_DPE_METADATA_HIGH_5_BOOT_STAGE_5_OFFSET 1
493#define KEYMGR_DPE_METADATA_HIGH_5_BOOT_STAGE_5_FIELD \
494 ((bitfield_field32_t) { .mask = KEYMGR_DPE_METADATA_HIGH_5_BOOT_STAGE_5_MASK, .index = KEYMGR_DPE_METADATA_HIGH_5_BOOT_STAGE_5_OFFSET })
495#define KEYMGR_DPE_METADATA_HIGH_5_ALLOW_CHILD_POLICY_5_BIT 4
496#define KEYMGR_DPE_METADATA_HIGH_5_EXPORTABLE_POLICY_5_BIT 5
497#define KEYMGR_DPE_METADATA_HIGH_5_RETAIN_PARENT_POLICY_5_BIT 6
498#define KEYMGR_DPE_METADATA_HIGH_5_ALLOW_KEYGEN_POLICY_5_BIT 7
499
500// Read metadata (high word) for each HW slot.
501#define KEYMGR_DPE_METADATA_HIGH_6_REG_OFFSET 0x128
502#define KEYMGR_DPE_METADATA_HIGH_6_REG_RESVAL 0x0u
503#define KEYMGR_DPE_METADATA_HIGH_6_VALID_6_BIT 0
504#define KEYMGR_DPE_METADATA_HIGH_6_BOOT_STAGE_6_MASK 0x7u
505#define KEYMGR_DPE_METADATA_HIGH_6_BOOT_STAGE_6_OFFSET 1
506#define KEYMGR_DPE_METADATA_HIGH_6_BOOT_STAGE_6_FIELD \
507 ((bitfield_field32_t) { .mask = KEYMGR_DPE_METADATA_HIGH_6_BOOT_STAGE_6_MASK, .index = KEYMGR_DPE_METADATA_HIGH_6_BOOT_STAGE_6_OFFSET })
508#define KEYMGR_DPE_METADATA_HIGH_6_ALLOW_CHILD_POLICY_6_BIT 4
509#define KEYMGR_DPE_METADATA_HIGH_6_EXPORTABLE_POLICY_6_BIT 5
510#define KEYMGR_DPE_METADATA_HIGH_6_RETAIN_PARENT_POLICY_6_BIT 6
511#define KEYMGR_DPE_METADATA_HIGH_6_ALLOW_KEYGEN_POLICY_6_BIT 7
512
513// Read metadata (high word) for each HW slot.
514#define KEYMGR_DPE_METADATA_HIGH_7_REG_OFFSET 0x12c
515#define KEYMGR_DPE_METADATA_HIGH_7_REG_RESVAL 0x0u
516#define KEYMGR_DPE_METADATA_HIGH_7_VALID_7_BIT 0
517#define KEYMGR_DPE_METADATA_HIGH_7_BOOT_STAGE_7_MASK 0x7u
518#define KEYMGR_DPE_METADATA_HIGH_7_BOOT_STAGE_7_OFFSET 1
519#define KEYMGR_DPE_METADATA_HIGH_7_BOOT_STAGE_7_FIELD \
520 ((bitfield_field32_t) { .mask = KEYMGR_DPE_METADATA_HIGH_7_BOOT_STAGE_7_MASK, .index = KEYMGR_DPE_METADATA_HIGH_7_BOOT_STAGE_7_OFFSET })
521#define KEYMGR_DPE_METADATA_HIGH_7_ALLOW_CHILD_POLICY_7_BIT 4
522#define KEYMGR_DPE_METADATA_HIGH_7_EXPORTABLE_POLICY_7_BIT 5
523#define KEYMGR_DPE_METADATA_HIGH_7_RETAIN_PARENT_POLICY_7_BIT 6
524#define KEYMGR_DPE_METADATA_HIGH_7_ALLOW_KEYGEN_POLICY_7_BIT 7
525
526// Key manager error code.
527#define KEYMGR_DPE_ERR_CODE_REG_OFFSET 0x130
528#define KEYMGR_DPE_ERR_CODE_REG_RESVAL 0x0u
529#define KEYMGR_DPE_ERR_CODE_INVALID_OP_BIT 0
530#define KEYMGR_DPE_ERR_CODE_INVALID_KMAC_INPUT_BIT 1
531#define KEYMGR_DPE_ERR_CODE_INVALID_SHADOW_UPDATE_BIT 2
532
533// This register represents both synchronous and asynchronous fatal faults.
534#define KEYMGR_DPE_FAULT_STATUS_REG_OFFSET 0x134
535#define KEYMGR_DPE_FAULT_STATUS_REG_RESVAL 0x0u
536#define KEYMGR_DPE_FAULT_STATUS_CMD_BIT 0
537#define KEYMGR_DPE_FAULT_STATUS_KMAC_FSM_BIT 1
538#define KEYMGR_DPE_FAULT_STATUS_KMAC_DONE_BIT 2
539#define KEYMGR_DPE_FAULT_STATUS_KMAC_OP_BIT 3
540#define KEYMGR_DPE_FAULT_STATUS_KMAC_OUT_BIT 4
541#define KEYMGR_DPE_FAULT_STATUS_REGFILE_INTG_BIT 5
542#define KEYMGR_DPE_FAULT_STATUS_SHADOW_BIT 6
543#define KEYMGR_DPE_FAULT_STATUS_CTRL_FSM_INTG_BIT 7
544#define KEYMGR_DPE_FAULT_STATUS_CTRL_FSM_CHK_BIT 8
545#define KEYMGR_DPE_FAULT_STATUS_CTRL_FSM_CNT_BIT 9
546#define KEYMGR_DPE_FAULT_STATUS_RESEED_CNT_BIT 10
547#define KEYMGR_DPE_FAULT_STATUS_SIDE_CTRL_FSM_BIT 11
548#define KEYMGR_DPE_FAULT_STATUS_SIDE_CTRL_SEL_BIT 12
549#define KEYMGR_DPE_FAULT_STATUS_KEY_ECC_BIT 13
550
551// The register holds some debug information that may be convenient if keymgr
552#define KEYMGR_DPE_DEBUG_REG_OFFSET 0x138
553#define KEYMGR_DPE_DEBUG_REG_RESVAL 0x0u
554#define KEYMGR_DPE_DEBUG_INVALID_CREATOR_SEED_BIT 0
555#define KEYMGR_DPE_DEBUG_INVALID_OWNER_SEED_BIT 1
556#define KEYMGR_DPE_DEBUG_INVALID_DEV_ID_BIT 2
557#define KEYMGR_DPE_DEBUG_INVALID_HEALTH_STATE_BIT 3
558#define KEYMGR_DPE_DEBUG_INVALID_KEY_VERSION_BIT 4
559#define KEYMGR_DPE_DEBUG_INVALID_KEY_BIT 5
560#define KEYMGR_DPE_DEBUG_INVALID_DIGEST_BIT 6
561#define KEYMGR_DPE_DEBUG_INVALID_ROOT_KEY_BIT 7
562#define KEYMGR_DPE_DEBUG_INACTIVE_LC_EN_BIT 8
563#define KEYMGR_DPE_DEBUG_INVALID_SECONDARY_ROOT_KEY_BIT 9
564#define KEYMGR_DPE_DEBUG_INVALID_FIELD_ENTROPY_BIT 10
565
566// Register lock for the `load root key` operation, see
567// !!CONTROL_SHADOWED.OPERATION.
568#define KEYMGR_DPE_LOAD_ROOT_KEY_LOCK_REG_OFFSET 0x13c
569#define KEYMGR_DPE_LOAD_ROOT_KEY_LOCK_REG_RESVAL 0x9u
570#define KEYMGR_DPE_LOAD_ROOT_KEY_LOCK_LOCK_MASK 0xfu
571#define KEYMGR_DPE_LOAD_ROOT_KEY_LOCK_LOCK_OFFSET 0
572#define KEYMGR_DPE_LOAD_ROOT_KEY_LOCK_LOCK_FIELD \
573 ((bitfield_field32_t) { .mask = KEYMGR_DPE_LOAD_ROOT_KEY_LOCK_LOCK_MASK, .index = KEYMGR_DPE_LOAD_ROOT_KEY_LOCK_LOCK_OFFSET })
574
575// Register lock for the `load secondary root key` operation, see
576// !!CONTROL_SHADOWED.OPERATION.
577#define KEYMGR_DPE_LOAD_SECONDARY_ROOT_KEY_LOCK_REG_OFFSET 0x140
578#define KEYMGR_DPE_LOAD_SECONDARY_ROOT_KEY_LOCK_REG_RESVAL 0x9u
579#define KEYMGR_DPE_LOAD_SECONDARY_ROOT_KEY_LOCK_LOCK_MASK 0xfu
580#define KEYMGR_DPE_LOAD_SECONDARY_ROOT_KEY_LOCK_LOCK_OFFSET 0
581#define KEYMGR_DPE_LOAD_SECONDARY_ROOT_KEY_LOCK_LOCK_FIELD \
582 ((bitfield_field32_t) { .mask = KEYMGR_DPE_LOAD_SECONDARY_ROOT_KEY_LOCK_LOCK_MASK, .index = KEYMGR_DPE_LOAD_SECONDARY_ROOT_KEY_LOCK_LOCK_OFFSET })
583
584// Enforce the software binding value as the only advance input message until
585// the next reset
586#define KEYMGR_DPE_ENFORCE_SW_BINDING_REG_OFFSET 0x144
587#define KEYMGR_DPE_ENFORCE_SW_BINDING_REG_RESVAL 0x9u
588#define KEYMGR_DPE_ENFORCE_SW_BINDING_ENFORCE_MASK 0xfu
589#define KEYMGR_DPE_ENFORCE_SW_BINDING_ENFORCE_OFFSET 0
590#define KEYMGR_DPE_ENFORCE_SW_BINDING_ENFORCE_FIELD \
591 ((bitfield_field32_t) { .mask = KEYMGR_DPE_ENFORCE_SW_BINDING_ENFORCE_MASK, .index = KEYMGR_DPE_ENFORCE_SW_BINDING_ENFORCE_OFFSET })
592
593// Disable software read access to the slot metadata until the next reset
594#define KEYMGR_DPE_METADATA_READ_LOCK_REG_OFFSET 0x148
595#define KEYMGR_DPE_METADATA_READ_LOCK_REG_RESVAL 0x9u
596#define KEYMGR_DPE_METADATA_READ_LOCK_LOCK_MASK 0xfu
597#define KEYMGR_DPE_METADATA_READ_LOCK_LOCK_OFFSET 0
598#define KEYMGR_DPE_METADATA_READ_LOCK_LOCK_FIELD \
599 ((bitfield_field32_t) { .mask = KEYMGR_DPE_METADATA_READ_LOCK_LOCK_MASK, .index = KEYMGR_DPE_METADATA_READ_LOCK_LOCK_OFFSET })
600
601#ifdef __cplusplus
602} // extern "C"
603#endif
604#endif // _KEYMGR_DPE_REG_DEFS_
605// End generated register defines for keymgr_dpe