Registers

Summary

INTR_STATE

Interrupt State Register

• Offset: 0x0
• Reset default: 0x0
• Reset mask: 0x1

Fields

{"reg": [{"name": "op_done", "bits": 1, "attr": ["rw1c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 90}}

INTR_ENABLE

Interrupt Enable Register

• Offset: 0x4
• Reset default: 0x0
• Reset mask: 0x1

Fields

{"reg": [{"name": "op_done", "bits": 1, "attr": ["rw"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 90}}

INTR_TEST

Interrupt Test Register

• Offset: 0x8
• Reset default: 0x0
• Reset mask: 0x1

Fields

{"reg": [{"name": "op_done", "bits": 1, "attr": ["wo"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 90}}

ALERT_TEST

Alert Test Register

• Offset: 0xc
• Reset default: 0x80000000
• Reset mask: 0x80000003

Fields

{"reg": [{"name": "recov_operation_err", "bits": 1, "attr": ["wo"], "rotate": -90}, {"name": "fatal_fault_err", "bits": 1, "attr": ["wo"], "rotate": -90}, {"bits": 29}, {"name": "regwen", "bits": 1, "attr": ["rw0c"], "rotate": -90}], "config": {"lanes": 1, "fontsize": 10, "vspace": 210}}

CFG_REGWEN

Key manager configuration enable

• Offset: 0x10
• Reset default: 0x1
• Reset mask: 0x1

Fields

{"reg": [{"name": "EN", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

START

Key manager operation start

• Offset: 0x14
• Reset default: 0x0
• Reset mask: 0x1
• Register enable: CFG_REGWEN

Fields

{"reg": [{"name": "EN", "bits": 1, "attr": ["rw"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

START . EN

Start key manager operations

Other values are reserved.

CONTROL_SHADOWED

Key manager operation controls

• Offset: 0x18
• Reset default: 0x10
• Reset mask: 0x5df870
• Register enable: CFG_REGWEN

Fields

{"reg": [{"bits": 4}, {"name": "OPERATION", "bits": 3, "attr": ["rw"], "rotate": -90}, {"bits": 4}, {"name": "DEST_SEL", "bits": 3, "attr": ["rw"], "rotate": -90}, {"name": "SLOT_SRC_SEL", "bits": 3, "attr": ["rw"], "rotate": -90}, {"bits": 1}, {"name": "SLOT_DST_SEL", "bits": 3, "attr": ["rw"], "rotate": -90}, {"bits": 1}, {"name": "SW_BINDING_ONLY", "bits": 1, "attr": ["rw"], "rotate": -90}, {"bits": 9}], "config": {"lanes": 1, "fontsize": 10, "vspace": 170}}

CONTROL_SHADOWED . SW_BINDING_ONLY

Only apply software binding as a message input to the advance operation.

See ENFORCE_SW_BINDING to make this mandatory for all advance calls until the next reset.

CONTROL_SHADOWED . SLOT_DST_SEL

The destination key slot to be used for the advance and erase operations.

CONTROL_SHADOWED . SLOT_SRC_SEL

The source key slot to be used for the invoked operation.

CONTROL_SHADOWED . DEST_SEL

When the OPERATION field is programmed to generate output, this field selects the target cryptograhic use of the key.

This field should be programmed for both HW / SW generation, as this helps diversify the output. The remaining values (5 to 7) are invalid and make a generate operation fail with invalid_op.

Other values are reserved.

CONTROL_SHADOWED . OPERATION

Key manager DPE operation selection

Other values are reserved.

SIDELOAD_CLEAR

sideload key slots clear

• Offset: 0x1c
• Reset default: 0x0
• Reset mask: 0x7
• Register enable: CFG_REGWEN

Fields

{"reg": [{"name": "VAL", "bits": 3, "attr": ["rw"], "rotate": 0}, {"bits": 29}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

SIDELOAD_CLEAR . VAL

Depending on the value programmed, a different sideload key slot is cleared. If the value programmed is not one of the enumerated values below, ALL sideload key slots are continuously cleared. In order to stop continuous clearing, SW should toggle the clear bit again (i.e. disable continuous clearing).

Other values are reserved.

RESEED_INTERVAL_REGWEN

regwen for reseed interval

• Offset: 0x20
• Reset default: 0x1
• Reset mask: 0x1

Fields

{"reg": [{"name": "EN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

RESEED_INTERVAL_SHADOWED

Reseed interval for key manager entropy reseed

• Offset: 0x24
• Reset default: 0x100
• Reset mask: 0xffff
• Register enable: RESEED_INTERVAL_REGWEN

Fields

{"reg": [{"name": "VAL", "bits": 16, "attr": ["rw"], "rotate": 0}, {"bits": 16}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

SLOT_POLICY_REGWEN

Register write enable for SLOT_POLICY

• Offset: 0x28
• Reset default: 0x1
• Reset mask: 0x1

Fields

{"reg": [{"name": "EN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

SLOT_POLICY

Policy bits for the child DPE context

• Offset: 0x2c
• Reset default: 0x0
• Reset mask: 0xf
• Register enable: SLOT_POLICY_REGWEN

Fields

{"reg": [{"name": "ALLOW_CHILD", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "EXPORTABLE", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "RETAIN_PARENT", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "ALLOW_KEYGEN", "bits": 1, "attr": ["rw"], "rotate": -90}, {"bits": 28}], "config": {"lanes": 1, "fontsize": 10, "vspace": 150}}

SW_BINDING_REGWEN

Register write enable for SOFTWARE_BINDING

• Offset: 0x30
• Reset default: 0x1
• Reset mask: 0x1

Fields

{"reg": [{"name": "EN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

SW_BINDING

Software binding input of the key manager. This register is lockable and shared between key manager stages. This binding value is not considered secret, however its integrity is very important.

The software binding is locked by software and unlocked by hardware upon a successful advance operation.

• Reset default: 0x0
• Reset mask: 0xffffffff
• Register enable: SW_BINDING_REGWEN

Instances

Fields

{"reg": [{"name": "VAL", "bits": 32, "attr": ["rw"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

SALT

Salt value used as part of output generation

• Reset default: 0x0
• Reset mask: 0xffffffff
• Register enable: CFG_REGWEN

Instances

Fields

{"reg": [{"name": "VAL", "bits": 32, "attr": ["rw"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

KEY_VERSION

Version used as part of output generation

• Reset default: 0x0
• Reset mask: 0xffffffff
• Register enable: CFG_REGWEN

Instances

Fields

{"reg": [{"name": "VAL", "bits": 32, "attr": ["rw"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

MAX_KEY_VER_REGWEN

Register write enable for MAX_KEY_VERSION

• Offset: 0x78
• Reset default: 0x1
• Reset mask: 0x1

Fields

{"reg": [{"name": "EN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

MAX_KEY_VER_SHADOWED

Max key version

• Offset: 0x7c
• Reset default: 0x0
• Reset mask: 0xffffffff
• Register enable: MAX_KEY_VER_REGWEN

Fields

{"reg": [{"name": "VAL", "bits": 32, "attr": ["rw"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

SW_SHARE0_OUTPUT

Key manager software output.

When a software output operation is selected, the results of the operation are placed here.

• Reset default: 0x0
• Reset mask: 0xffffffff

Instances

Fields

{"reg": [{"name": "VAL", "bits": 32, "attr": ["rc"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

SW_SHARE1_OUTPUT

Key manager software output.

When a software output operation is selected, the results of the operation are placed here.

• Reset default: 0x0
• Reset mask: 0xffffffff

Instances

Fields

{"reg": [{"name": "VAL", "bits": 32, "attr": ["rc"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

WORKING_STATE

Key manager working state.

This is a readout of the current key manager working state

• Offset: 0xc0
• Reset default: 0x0
• Reset mask: 0x3

Fields

{"reg": [{"name": "STATE", "bits": 2, "attr": ["ro"], "rotate": -90}, {"bits": 30}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

WORKING_STATE . STATE

Key manager control state

OP_STATUS

Key manager status.

Hardware sets the status based on software initiated operations. This register must be explicitly cleared by software. Software clears by writing back whatever it reads.

• Offset: 0xc4
• Reset default: 0x0
• Reset mask: 0x3

Fields

{"reg": [{"name": "STATUS", "bits": 2, "attr": ["rw1c"], "rotate": -90}, {"bits": 30}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

OP_STATUS . STATUS

Operation status.

METADATA_LOW

Read metadata (low word) for each HW slot.

Only the first NumInstHwSlot slots are instantiated. Entries at index NumInstHwSlot and above always read as 0. Together with METADATA_HIGH, this register lets software inspect the non-secret metadata of the DPE context.

• Reset default: 0x0
• Reset mask: 0xffffffff

Instances

Fields

{"reg": [{"name": "MAX_KEY_VERSION", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

METADATA_HIGH

Read metadata (high word) for each HW slot.

Only the first NumInstHwSlot slots are instantiated. Entries at index NumInstHwSlot and above always read as 0. Together with METADATA_LOW, this register lets software inspect the non-secret metadata of the DPE context.

• Reset default: 0x0
• Reset mask: 0x7f

Instances

Fields

{"reg": [{"name": "VALID", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "BOOT_STAGE", "bits": 2, "attr": ["ro"], "rotate": -90}, {"name": "ALLOW_CHILD_POLICY", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "EXPORTABLE_POLICY", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "RETAIN_PARENT_POLICY", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "ALLOW_KEYGEN_POLICY", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 25}], "config": {"lanes": 1, "fontsize": 10, "vspace": 220}}

METADATA_HIGH . ALLOW_KEYGEN_POLICY

Read the allow_keygen policy applied to the DPE context in this slot.

METADATA_HIGH . RETAIN_PARENT_POLICY

Read the retain_parent policy applied to the DPE context in this slot.

METADATA_HIGH . EXPORTABLE_POLICY

Read the exportable policy applied to the DPE context in this slot.

METADATA_HIGH . ALLOW_CHILD_POLICY

Read the allow_child policy applied to the DPE context in this slot.

METADATA_HIGH . BOOT_STAGE

Boot stage associated with the DPE context held in this slot.

The naming indicates the next bootstage after a successful key derivation e.g. boot stage 1 means the context is the CreatorRootKey and will be derived into the OwnerIntKey.

METADATA_HIGH . VALID

Set if the DPE context held in this slot is valid.

ERR_CODE

Key manager error code. This register must be explicitly cleared by software.

This register represents both synchronous and asynchronous recoverable errors.

Synchronous errors refer to those that only happen when a keymgr operation is invoked, while asynchronous refers to errors that can happen at any time.

• Offset: 0x108
• Reset default: 0x0
• Reset mask: 0x7

Fields

{"reg": [{"name": "INVALID_OP", "bits": 1, "attr": ["rw1c"], "rotate": -90}, {"name": "INVALID_KMAC_INPUT", "bits": 1, "attr": ["rw1c"], "rotate": -90}, {"name": "INVALID_SHADOW_UPDATE", "bits": 1, "attr": ["rw1c"], "rotate": -90}, {"bits": 29}], "config": {"lanes": 1, "fontsize": 10, "vspace": 230}}

FAULT_STATUS

This register represents both synchronous and asynchronous fatal faults.

Synchronous faults refer to those that only happen when a keymgr operation is invoked, while asynchronous refers to faults that can happen at any time.

• Offset: 0x10c
• Reset default: 0x0
• Reset mask: 0x3fff

Fields

{"reg": [{"name": "CMD", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "KMAC_FSM", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "KMAC_DONE", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "KMAC_OP", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "KMAC_OUT", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "REGFILE_INTG", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "SHADOW", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "CTRL_FSM_INTG", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "CTRL_FSM_CHK", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "CTRL_FSM_CNT", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "RESEED_CNT", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "SIDE_CTRL_FSM", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "SIDE_CTRL_SEL", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "KEY_ECC", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 18}], "config": {"lanes": 1, "fontsize": 10, "vspace": 150}}

DEBUG

The register holds some debug information that may be convenient if keymgr misbehaves.

• Offset: 0x110
• Reset default: 0x0
• Reset mask: 0x3ff

Fields

{"reg": [{"name": "INVALID_CREATOR_SEED", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "INVALID_OWNER_SEED", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "INVALID_DEV_ID", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "INVALID_HEALTH_STATE", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "INVALID_KEY_VERSION", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "INVALID_KEY", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "INVALID_DIGEST", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "INVALID_ROOT_KEY", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "INACTIVE_LC_EN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "INVALID_SECONDARY_ROOT_KEY", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 22}], "config": {"lanes": 1, "fontsize": 10, "vspace": 280}}

LOAD_ROOT_KEY_LOCK

Register lock for the load root key operation, see CONTROL_SHADOWED.OPERATION.

• Offset: 0x114
• Reset default: 0x0
• Reset mask: 0x1

Fields

{"reg": [{"name": "LOCK", "bits": 1, "attr": ["rw1s"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

LOAD_SECONDARY_ROOT_KEY_LOCK

Register lock for the load secondary root key operation, see CONTROL_SHADOWED.OPERATION.

• Offset: 0x118
• Reset default: 0x0
• Reset mask: 0x1

Fields

{"reg": [{"name": "LOCK", "bits": 1, "attr": ["rw1s"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}

ENFORCE_SW_BINDING

Enforce the software binding value as the only advance input message until the next reset

• Offset: 0x11c
• Reset default: 0x9
• Reset mask: 0xf

Fields

{"reg": [{"name": "ENFORCE", "bits": 4, "attr": ["rw1s"], "rotate": -90}, {"bits": 28}], "config": {"lanes": 1, "fontsize": 10, "vspace": 90}}

ENFORCE_SW_BINDING . ENFORCE

Enforce using only sw binding value for context derivation.

Once set no hw binding value can be consumed until the next reset. An advance operation from a parent whose boot stage consumes hw binding values (boot_stage 0 to 2, i.e. Creator, OwnerInt or Owner) without CONTROL_SHADOWED.SW_BINDING_ONLY set will fail with an invalid_op error without updating the destination slot. Advance operations from later boot stages are not affected.

Every encoding except kMultiBitBool4False will be treated as locked.