Skip to content

Latest commit

 

History

History
1043 lines (816 loc) · 67.8 KB

registers.md

File metadata and controls

1043 lines (816 loc) · 67.8 KB
Raw

Registers

Summary of the core interface's registers

Name Offset Length Description
otp_ctrl.INTR_STATE 0x0 4 Interrupt State Register
otp_ctrl.INTR_ENABLE 0x4 4 Interrupt Enable Register
otp_ctrl.INTR_TEST 0x8 4 Interrupt Test Register
otp_ctrl.ALERT_TEST 0xc 4 Alert Test Register
otp_ctrl.STATUS 0x10 4 OTP status register.
otp_ctrl.ERR_CODE_0 0x14 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.ERR_CODE_1 0x18 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.ERR_CODE_2 0x1c 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.ERR_CODE_3 0x20 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.ERR_CODE_4 0x24 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.ERR_CODE_5 0x28 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.ERR_CODE_6 0x2c 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.ERR_CODE_7 0x30 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.ERR_CODE_8 0x34 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.ERR_CODE_9 0x38 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.ERR_CODE_10 0x3c 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.ERR_CODE_11 0x40 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.ERR_CODE_12 0x44 4 This register holds information about error conditions that occurred in the agents
otp_ctrl.DIRECT_ACCESS_REGWEN 0x48 4 Register write enable for all direct access interface registers.
otp_ctrl.DIRECT_ACCESS_CMD 0x4c 4 Command register for direct accesses.
otp_ctrl.DIRECT_ACCESS_ADDRESS 0x50 4 Address register for direct accesses.
otp_ctrl.DIRECT_ACCESS_WDATA_0 0x54 4 Write data for direct accesses.
otp_ctrl.DIRECT_ACCESS_WDATA_1 0x58 4 Write data for direct accesses.
otp_ctrl.DIRECT_ACCESS_RDATA_0 0x5c 4 Read data for direct accesses.
otp_ctrl.DIRECT_ACCESS_RDATA_1 0x60 4 Read data for direct accesses.
otp_ctrl.CHECK_TRIGGER_REGWEN 0x64 4 Register write enable for !!CHECK_TRIGGER.
otp_ctrl.CHECK_TRIGGER 0x68 4 Command register for direct accesses.
otp_ctrl.CHECK_REGWEN 0x6c 4 Register write enable for !!INTEGRITY_CHECK_PERIOD and !!CONSISTENCY_CHECK_PERIOD.
otp_ctrl.CHECK_TIMEOUT 0x70 4 Timeout value for the integrity and consistency checks.
otp_ctrl.INTEGRITY_CHECK_PERIOD 0x74 4 This value specifies the maximum period that can be generated pseudo-randomly.
otp_ctrl.CONSISTENCY_CHECK_PERIOD 0x78 4 This value specifies the maximum period that can be generated pseudo-randomly.
otp_ctrl.VENDOR_TEST_READ_LOCK 0x7c 4 Runtime read lock for the VENDOR_TEST partition.
otp_ctrl.CREATOR_SW_CFG_READ_LOCK 0x80 4 Runtime read lock for the CREATOR_SW_CFG partition.
otp_ctrl.OWNER_SW_CFG_READ_LOCK 0x84 4 Runtime read lock for the OWNER_SW_CFG partition.
otp_ctrl.ROT_CREATOR_AUTH_CODESIGN_READ_LOCK 0x88 4 Runtime read lock for the ROT_CREATOR_AUTH_CODESIGN partition.
otp_ctrl.ROT_CREATOR_AUTH_STATE_READ_LOCK 0x8c 4 Runtime read lock for the ROT_CREATOR_AUTH_STATE partition.
otp_ctrl.VENDOR_TEST_DIGEST_0 0x90 4 Integrity digest for the VENDOR_TEST partition.
otp_ctrl.VENDOR_TEST_DIGEST_1 0x94 4 Integrity digest for the VENDOR_TEST partition.
otp_ctrl.CREATOR_SW_CFG_DIGEST_0 0x98 4 Integrity digest for the CREATOR_SW_CFG partition.
otp_ctrl.CREATOR_SW_CFG_DIGEST_1 0x9c 4 Integrity digest for the CREATOR_SW_CFG partition.
otp_ctrl.OWNER_SW_CFG_DIGEST_0 0xa0 4 Integrity digest for the OWNER_SW_CFG partition.
otp_ctrl.OWNER_SW_CFG_DIGEST_1 0xa4 4 Integrity digest for the OWNER_SW_CFG partition.
otp_ctrl.ROT_CREATOR_AUTH_CODESIGN_DIGEST_0 0xa8 4 Integrity digest for the ROT_CREATOR_AUTH_CODESIGN partition.
otp_ctrl.ROT_CREATOR_AUTH_CODESIGN_DIGEST_1 0xac 4 Integrity digest for the ROT_CREATOR_AUTH_CODESIGN partition.
otp_ctrl.ROT_CREATOR_AUTH_STATE_DIGEST_0 0xb0 4 Integrity digest for the ROT_CREATOR_AUTH_STATE partition.
otp_ctrl.ROT_CREATOR_AUTH_STATE_DIGEST_1 0xb4 4 Integrity digest for the ROT_CREATOR_AUTH_STATE partition.
otp_ctrl.HW_CFG0_DIGEST_0 0xb8 4 Integrity digest for the HW_CFG0 partition.
otp_ctrl.HW_CFG0_DIGEST_1 0xbc 4 Integrity digest for the HW_CFG0 partition.
otp_ctrl.HW_CFG1_DIGEST_0 0xc0 4 Integrity digest for the HW_CFG1 partition.
otp_ctrl.HW_CFG1_DIGEST_1 0xc4 4 Integrity digest for the HW_CFG1 partition.
otp_ctrl.SECRET0_DIGEST_0 0xc8 4 Integrity digest for the SECRET0 partition.
otp_ctrl.SECRET0_DIGEST_1 0xcc 4 Integrity digest for the SECRET0 partition.
otp_ctrl.SECRET1_DIGEST_0 0xd0 4 Integrity digest for the SECRET1 partition.
otp_ctrl.SECRET1_DIGEST_1 0xd4 4 Integrity digest for the SECRET1 partition.
otp_ctrl.SECRET2_DIGEST_0 0xd8 4 Integrity digest for the SECRET2 partition.
otp_ctrl.SECRET2_DIGEST_1 0xdc 4 Integrity digest for the SECRET2 partition.
otp_ctrl.SW_CFG_WINDOW 0x800 2048 Any read to this window directly maps to the corresponding offset in the creator and owner software

INTR_STATE

Interrupt State Register

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

Fields

{"reg": [{"name": "otp_operation_done", "bits": 1, "attr": ["rw1c"], "rotate": -90}, {"name": "otp_error", "bits": 1, "attr": ["rw1c"], "rotate": -90}, {"bits": 30}], "config": {"lanes": 1, "fontsize": 10, "vspace": 200}}
Bits Type Reset Name Description
31:2 Reserved
1 rw1c 0x0 otp_error An error has occurred in the OTP controller. Check the ERR_CODE register to get more information.
0 rw1c 0x0 otp_operation_done A direct access command or digest calculation operation has completed.

INTR_ENABLE

Interrupt Enable Register

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

Fields

{"reg": [{"name": "otp_operation_done", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "otp_error", "bits": 1, "attr": ["rw"], "rotate": -90}, {"bits": 30}], "config": {"lanes": 1, "fontsize": 10, "vspace": 200}}
Bits Type Reset Name Description
31:2 Reserved
1 rw 0x0 otp_error Enable interrupt when INTR_STATE.otp_error is set.
0 rw 0x0 otp_operation_done Enable interrupt when INTR_STATE.otp_operation_done is set.

INTR_TEST

Interrupt Test Register

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

Fields

{"reg": [{"name": "otp_operation_done", "bits": 1, "attr": ["wo"], "rotate": -90}, {"name": "otp_error", "bits": 1, "attr": ["wo"], "rotate": -90}, {"bits": 30}], "config": {"lanes": 1, "fontsize": 10, "vspace": 200}}
Bits Type Reset Name Description
31:2 Reserved
1 wo 0x0 otp_error Write 1 to force INTR_STATE.otp_error to 1.
0 wo 0x0 otp_operation_done Write 1 to force INTR_STATE.otp_operation_done to 1.

ALERT_TEST

Alert Test Register

  • Offset: 0xc
  • Reset default: 0x0
  • Reset mask: 0x1f

Fields

{"reg": [{"name": "fatal_macro_error", "bits": 1, "attr": ["wo"], "rotate": -90}, {"name": "fatal_check_error", "bits": 1, "attr": ["wo"], "rotate": -90}, {"name": "fatal_bus_integ_error", "bits": 1, "attr": ["wo"], "rotate": -90}, {"name": "fatal_prim_otp_alert", "bits": 1, "attr": ["wo"], "rotate": -90}, {"name": "recov_prim_otp_alert", "bits": 1, "attr": ["wo"], "rotate": -90}, {"bits": 27}], "config": {"lanes": 1, "fontsize": 10, "vspace": 230}}
Bits Type Reset Name Description
31:5 Reserved
4 wo 0x0 recov_prim_otp_alert Write 1 to trigger one alert event of this kind.
3 wo 0x0 fatal_prim_otp_alert Write 1 to trigger one alert event of this kind.
2 wo 0x0 fatal_bus_integ_error Write 1 to trigger one alert event of this kind.
1 wo 0x0 fatal_check_error Write 1 to trigger one alert event of this kind.
0 wo 0x0 fatal_macro_error Write 1 to trigger one alert event of this kind.

STATUS

OTP status register.

  • Offset: 0x10
  • Reset default: 0x0
  • Reset mask: 0xfffff

Fields

{"reg": [{"name": "VENDOR_TEST_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "CREATOR_SW_CFG_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "OWNER_SW_CFG_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "ROT_CREATOR_AUTH_CODESIGN_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "ROT_CREATOR_AUTH_STATE_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "HW_CFG0_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "HW_CFG1_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "SECRET0_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "SECRET1_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "SECRET2_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "LIFE_CYCLE_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "DAI_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "LCI_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "TIMEOUT_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "LFSR_FSM_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "SCRAMBLING_FSM_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "KEY_DERIV_FSM_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "BUS_INTEG_ERROR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "DAI_IDLE", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "CHECK_PENDING", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 12}], "config": {"lanes": 1, "fontsize": 10, "vspace": 330}}
Bits Type Reset Name Description
31:20 Reserved
19 ro 0x0 CHECK_PENDING Set to 1 if an integrity or consistency check triggered by the LFSR timer or via CHECK_TRIGGER is pending.
18 ro 0x0 DAI_IDLE Set to 1 if the DAI is idle and ready to accept commands.
17 ro 0x0 BUS_INTEG_ERROR This bit is set to 1 if a fatal bus integrity fault is detected. This error triggers a fatal_bus_integ_error alert.
16 ro 0x0 KEY_DERIV_FSM_ERROR Set to 1 if the key derivation FSM has reached an invalid state. This raises an fatal_check_error alert and is an unrecoverable error condition.
15 ro 0x0 SCRAMBLING_FSM_ERROR Set to 1 if the scrambling datapath FSM has reached an invalid state. This raises an fatal_check_error alert and is an unrecoverable error condition.
14 ro 0x0 LFSR_FSM_ERROR Set to 1 if the LFSR timer FSM has reached an invalid state. This raises an fatal_check_error alert and is an unrecoverable error condition.
13 ro 0x0 TIMEOUT_ERROR Set to 1 if an integrity or consistency check times out. This raises an fatal_check_error alert and is an unrecoverable error condition.
12 ro 0x0 LCI_ERROR Set to 1 if an error occurred in the LCI. If set to 1, SW should check the ERR_CODE register at the corresponding index.
11 ro 0x0 DAI_ERROR Set to 1 if an error occurred in the DAI. If set to 1, SW should check the ERR_CODE register at the corresponding index.
10 ro 0x0 LIFE_CYCLE_ERROR Set to 1 if an error occurred in this partition. If set to 1, SW should check the ERR_CODE register at the corresponding index.
9 ro 0x0 SECRET2_ERROR Set to 1 if an error occurred in this partition. If set to 1, SW should check the ERR_CODE register at the corresponding index.
8 ro 0x0 SECRET1_ERROR Set to 1 if an error occurred in this partition. If set to 1, SW should check the ERR_CODE register at the corresponding index.
7 ro 0x0 SECRET0_ERROR Set to 1 if an error occurred in this partition. If set to 1, SW should check the ERR_CODE register at the corresponding index.
6 ro 0x0 HW_CFG1_ERROR Set to 1 if an error occurred in this partition. If set to 1, SW should check the ERR_CODE register at the corresponding index.
5 ro 0x0 HW_CFG0_ERROR Set to 1 if an error occurred in this partition. If set to 1, SW should check the ERR_CODE register at the corresponding index.
4 ro 0x0 ROT_CREATOR_AUTH_STATE_ERROR Set to 1 if an error occurred in this partition. If set to 1, SW should check the ERR_CODE register at the corresponding index.
3 ro 0x0 ROT_CREATOR_AUTH_CODESIGN_ERROR Set to 1 if an error occurred in this partition. If set to 1, SW should check the ERR_CODE register at the corresponding index.
2 ro 0x0 OWNER_SW_CFG_ERROR Set to 1 if an error occurred in this partition. If set to 1, SW should check the ERR_CODE register at the corresponding index.
1 ro 0x0 CREATOR_SW_CFG_ERROR Set to 1 if an error occurred in this partition. If set to 1, SW should check the ERR_CODE register at the corresponding index.
0 ro 0x0 VENDOR_TEST_ERROR Set to 1 if an error occurred in this partition. If set to 1, SW should check the ERR_CODE register at the corresponding index.

ERR_CODE

This register holds information about error conditions that occurred in the agents interacting with the OTP macro via the internal bus. The error codes should be checked if the partitions, DAI or LCI flag an error in the STATUS register, or when an INTR_STATE.otp_error has been triggered. Note that all errors trigger an otp_error interrupt, and in addition some errors may trigger either an fatal_macro_error or an fatal_check_error alert.

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

Instances

Name Offset
ERR_CODE_0 0x14
ERR_CODE_1 0x18
ERR_CODE_2 0x1c
ERR_CODE_3 0x20
ERR_CODE_4 0x24
ERR_CODE_5 0x28
ERR_CODE_6 0x2c
ERR_CODE_7 0x30
ERR_CODE_8 0x34
ERR_CODE_9 0x38
ERR_CODE_10 0x3c
ERR_CODE_11 0x40
ERR_CODE_12 0x44

Fields

{"reg": [{"name": "ERR_CODE", "bits": 3, "attr": ["ro"], "rotate": -90}, {"bits": 29}], "config": {"lanes": 1, "fontsize": 10, "vspace": 100}}
Bits Type Reset Name
31:3 Reserved
2:0 ro 0x0 ERR_CODE

ERR_CODE . ERR_CODE

Value Name Description
0x0 NO_ERROR No error condition has occurred.
0x1 MACRO_ERROR Returned if the OTP macro command was invalid or did not complete successfully due to a macro malfunction. This error should never occur during normal operation and is not recoverable. This error triggers an fatal_macro_error alert.
0x2 MACRO_ECC_CORR_ERROR A correctable ECC error has occured during an OTP read operation. The corresponding controller automatically recovers from this error when issuing a new command.
0x3 MACRO_ECC_UNCORR_ERROR An uncorrectable ECC error has occurred during an OTP read operation. This error should never occur during normal operation and is not recoverable. If this error is present this may be a sign that the device is malfunctioning. This error triggers an fatal_macro_error alert.
0x4 MACRO_WRITE_BLANK_ERROR This error is returned if a programming operation attempted to clear a bit that has previously been programmed to 1. The corresponding controller automatically recovers from this error when issuing a new command. Note however that the affected OTP word may be left in an inconsistent state if this error occurs. This can cause several issues when the word is accessed again (either as part of a regular read operation, as part of the readout at boot, or as part of a background check). It is important that SW ensures that each word is only written once, since this can render the device useless.
0x5 ACCESS_ERROR This error indicates that a locked memory region has been accessed. The corresponding controller automatically recovers from this error when issuing a new command.
0x6 CHECK_FAIL_ERROR An ECC, integrity or consistency mismatch has been detected in the buffer registers. This error should never occur during normal operation and is not recoverable. This error triggers an fatal_check_error alert.
0x7 FSM_STATE_ERROR The FSM of the corresponding controller has reached an invalid state, or the FSM has been moved into a terminal error state due to an escalation action via lc_escalate_en_i. This error should never occur during normal operation and is not recoverable. If this error is present, this is a sign that the device has fallen victim to an invasive attack. This error triggers an fatal_check_error alert.

DIRECT_ACCESS_REGWEN

Register write enable for all direct access interface registers.

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

Fields

{"reg": [{"name": "DIRECT_ACCESS_REGWEN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 220}}
Bits Type Reset Name
31:1 Reserved
0 rw0c 0x1 DIRECT_ACCESS_REGWEN

DIRECT_ACCESS_REGWEN . DIRECT_ACCESS_REGWEN

This bit controls whether the DAI registers can be written. Write 0 to it in order to clear the bit.

Note that the hardware also modulates this bit and sets it to 0 temporarily during an OTP operation such that the corresponding address and data registers cannot be modified while an operation is pending. The DAI_IDLE status bit will also be set to 0 in such a case.

DIRECT_ACCESS_CMD

Command register for direct accesses.

Fields

{"reg": [{"name": "RD", "bits": 1, "attr": ["r0w1c"], "rotate": -90}, {"name": "WR", "bits": 1, "attr": ["r0w1c"], "rotate": -90}, {"name": "DIGEST", "bits": 1, "attr": ["r0w1c"], "rotate": -90}, {"bits": 29}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:3 Reserved
2 r0w1c 0x0 DIGEST Initiates the digest calculation and locking sequence for the partition specified by DIRECT_ACCESS_ADDRESS.
1 r0w1c 0x0 WR Initiates a programming sequence that writes the data in DIRECT_ACCESS_WDATA_0 and DIRECT_ACCESS_WDATA_1 (for 64bit partitions) to the location specified by DIRECT_ACCESS_ADDRESS.
0 r0w1c 0x0 RD Initiates a readout sequence that reads the location specified by DIRECT_ACCESS_ADDRESS. The command places the data read into DIRECT_ACCESS_RDATA_0 and DIRECT_ACCESS_RDATA_1 (for 64bit partitions).

DIRECT_ACCESS_ADDRESS

Address register for direct accesses.

Fields

{"reg": [{"name": "DIRECT_ACCESS_ADDRESS", "bits": 11, "attr": ["rw"], "rotate": -90}, {"bits": 21}], "config": {"lanes": 1, "fontsize": 10, "vspace": 230}}
Bits Type Reset Name
31:11 Reserved
10:0 rw 0x0 DIRECT_ACCESS_ADDRESS

DIRECT_ACCESS_ADDRESS . DIRECT_ACCESS_ADDRESS

This is the address for the OTP word to be read or written through the direct access interface. Note that the address is aligned to the access size internally, hence bits 1:0 are ignored for 32bit accesses, and bits 2:0 are ignored for 64bit accesses.

For the digest calculation command, set this register to the partition base offset.

DIRECT_ACCESS_WDATA

Write data for direct accesses. Hardware automatically determines the access granule (32bit or 64bit) based on which partition is being written to.

Instances

Name Offset
DIRECT_ACCESS_WDATA_0 0x54
DIRECT_ACCESS_WDATA_1 0x58

Fields

{"reg": [{"name": "DIRECT_ACCESS_WDATA", "bits": 32, "attr": ["rw"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:0 rw 0x0 DIRECT_ACCESS_WDATA

DIRECT_ACCESS_RDATA

Read data for direct accesses. Hardware automatically determines the access granule (32bit or 64bit) based on which partition is read from.

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

Instances

Name Offset
DIRECT_ACCESS_RDATA_0 0x5c
DIRECT_ACCESS_RDATA_1 0x60

Fields

{"reg": [{"name": "DIRECT_ACCESS_RDATA", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:0 ro 0x0 DIRECT_ACCESS_RDATA

CHECK_TRIGGER_REGWEN

Register write enable for CHECK_TRIGGER.

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

Fields

{"reg": [{"name": "CHECK_TRIGGER_REGWEN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 220}}
Bits Type Reset Name Description
31:1 Reserved
0 rw0c 0x1 CHECK_TRIGGER_REGWEN When cleared to 0, the CHECK_TRIGGER register cannot be written anymore. Write 0 to clear this bit.

CHECK_TRIGGER

Command register for direct accesses.

Fields

{"reg": [{"name": "INTEGRITY", "bits": 1, "attr": ["r0w1c"], "rotate": -90}, {"name": "CONSISTENCY", "bits": 1, "attr": ["r0w1c"], "rotate": -90}, {"bits": 30}], "config": {"lanes": 1, "fontsize": 10, "vspace": 130}}
Bits Type Reset Name
31:2 Reserved
1 r0w1c 0x0 CONSISTENCY
0 r0w1c 0x0 INTEGRITY

CHECK_TRIGGER . CONSISTENCY

Writing 1 to this bit triggers a consistency check. SW should monitor STATUS.CHECK_PENDING and wait until the check has been completed. If there are any errors, those will be flagged in the STATUS and ERR_CODE registers, and via interrupts and alerts.

CHECK_TRIGGER . INTEGRITY

Writing 1 to this bit triggers an integrity check. SW should monitor STATUS.CHECK_PENDING and wait until the check has been completed. If there are any errors, those will be flagged in the STATUS and ERR_CODE registers, and via the interrupts and alerts.

CHECK_REGWEN

Register write enable for INTEGRITY_CHECK_PERIOD and CONSISTENCY_CHECK_PERIOD.

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

Fields

{"reg": [{"name": "CHECK_REGWEN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 140}}
Bits Type Reset Name Description
31:1 Reserved
0 rw0c 0x1 CHECK_REGWEN When cleared to 0, INTEGRITY_CHECK_PERIOD and CONSISTENCY_CHECK_PERIOD registers cannot be written anymore. Write 0 to clear this bit.

CHECK_TIMEOUT

Timeout value for the integrity and consistency checks.

  • Offset: 0x70
  • Reset default: 0x0
  • Reset mask: 0xffffffff
  • Register enable: CHECK_REGWEN

Fields

{"reg": [{"name": "CHECK_TIMEOUT", "bits": 32, "attr": ["rw"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name
31:0 rw 0x0 CHECK_TIMEOUT

CHECK_TIMEOUT . CHECK_TIMEOUT

Timeout value in cycles for the for the integrity and consistency checks. If an integrity or consistency check does not complete within the timeout window, an error will be flagged in the STATUS register, an otp_error interrupt will be raised, and an fatal_check_error alert will be sent out. The timeout should be set to a large value to stay on the safe side. The maximum check time can be upper bounded by the number of cycles it takes to readout, scramble and digest the entire OTP array. Since this amounts to roughly 25k cycles, it is recommended to set this value to at least 100'000 cycles in order to stay on the safe side. A value of zero disables the timeout mechanism (default).

INTEGRITY_CHECK_PERIOD

This value specifies the maximum period that can be generated pseudo-randomly. Only applies to the HW_CFG* and SECRET* partitions once they are locked.

  • Offset: 0x74
  • Reset default: 0x0
  • Reset mask: 0xffffffff
  • Register enable: CHECK_REGWEN

Fields

{"reg": [{"name": "INTEGRITY_CHECK_PERIOD", "bits": 32, "attr": ["rw"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name
31:0 rw 0x0 INTEGRITY_CHECK_PERIOD

INTEGRITY_CHECK_PERIOD . INTEGRITY_CHECK_PERIOD

The pseudo-random period is generated using a 40bit LFSR internally, and this register defines the bit mask to be applied to the LFSR output in order to limit its range. The value of this register is left shifted by 8bits and the lower bits are set to 8'hFF in order to form the 40bit mask. A recommended value is 0x3_FFFF, corresponding to a maximum period of ~2.8s at 24MHz. A value of zero disables the timer (default). Note that a one-off check can always be triggered via CHECK_TRIGGER.INTEGRITY.

CONSISTENCY_CHECK_PERIOD

This value specifies the maximum period that can be generated pseudo-randomly. This applies to the LIFE_CYCLE partition and the HW_CFG* and SECRET* partitions once they are locked.

  • Offset: 0x78
  • Reset default: 0x0
  • Reset mask: 0xffffffff
  • Register enable: CHECK_REGWEN

Fields

{"reg": [{"name": "CONSISTENCY_CHECK_PERIOD", "bits": 32, "attr": ["rw"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name
31:0 rw 0x0 CONSISTENCY_CHECK_PERIOD

CONSISTENCY_CHECK_PERIOD . CONSISTENCY_CHECK_PERIOD

The pseudo-random period is generated using a 40bit LFSR internally, and this register defines the bit mask to be applied to the LFSR output in order to limit its range. The value of this register is left shifted by 8bits and the lower bits are set to 8'hFF in order to form the 40bit mask. A recommended value is 0x3FF_FFFF, corresponding to a maximum period of ~716s at 24MHz. A value of zero disables the timer (default). Note that a one-off check can always be triggered via CHECK_TRIGGER.CONSISTENCY.

VENDOR_TEST_READ_LOCK

Runtime read lock for the VENDOR_TEST partition.

Fields

{"reg": [{"name": "VENDOR_TEST_READ_LOCK", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 230}}
Bits Type Reset Name Description
31:1 Reserved
0 rw0c 0x1 VENDOR_TEST_READ_LOCK When cleared to 0, read access to the VENDOR_TEST partition is locked. Write 0 to clear this bit.

CREATOR_SW_CFG_READ_LOCK

Runtime read lock for the CREATOR_SW_CFG partition.

Fields

{"reg": [{"name": "CREATOR_SW_CFG_READ_LOCK", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 260}}
Bits Type Reset Name Description
31:1 Reserved
0 rw0c 0x1 CREATOR_SW_CFG_READ_LOCK When cleared to 0, read access to the CREATOR_SW_CFG partition is locked. Write 0 to clear this bit.

OWNER_SW_CFG_READ_LOCK

Runtime read lock for the OWNER_SW_CFG partition.

Fields

{"reg": [{"name": "OWNER_SW_CFG_READ_LOCK", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 240}}
Bits Type Reset Name Description
31:1 Reserved
0 rw0c 0x1 OWNER_SW_CFG_READ_LOCK When cleared to 0, read access to the OWNER_SW_CFG partition is locked. Write 0 to clear this bit.

ROT_CREATOR_AUTH_CODESIGN_READ_LOCK

Runtime read lock for the ROT_CREATOR_AUTH_CODESIGN partition.

Fields

{"reg": [{"name": "ROT_CREATOR_AUTH_CODESIGN_READ_LOCK", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 370}}
Bits Type Reset Name Description
31:1 Reserved
0 rw0c 0x1 ROT_CREATOR_AUTH_CODESIGN_READ_LOCK When cleared to 0, read access to the ROT_CREATOR_AUTH_CODESIGN partition is locked. Write 0 to clear this bit.

ROT_CREATOR_AUTH_STATE_READ_LOCK

Runtime read lock for the ROT_CREATOR_AUTH_STATE partition.

Fields

{"reg": [{"name": "ROT_CREATOR_AUTH_STATE_READ_LOCK", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 340}}
Bits Type Reset Name Description
31:1 Reserved
0 rw0c 0x1 ROT_CREATOR_AUTH_STATE_READ_LOCK When cleared to 0, read access to the ROT_CREATOR_AUTH_STATE partition is locked. Write 0 to clear this bit.

VENDOR_TEST_DIGEST

Integrity digest for the VENDOR_TEST partition. The integrity digest is 0 by default. Software must write this digest value via the direct access interface in order to lock the partition. After a reset, write access to the VENDOR_TEST partition is locked and the digest becomes visible in this CSR.

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

Instances

Name Offset
VENDOR_TEST_DIGEST_0 0x90
VENDOR_TEST_DIGEST_1 0x94

Fields

{"reg": [{"name": "VENDOR_TEST_DIGEST", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:0 ro 0x0 VENDOR_TEST_DIGEST

CREATOR_SW_CFG_DIGEST

Integrity digest for the CREATOR_SW_CFG partition. The integrity digest is 0 by default. Software must write this digest value via the direct access interface in order to lock the partition. After a reset, write access to the CREATOR_SW_CFG partition is locked and the digest becomes visible in this CSR.

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

Instances

Name Offset
CREATOR_SW_CFG_DIGEST_0 0x98
CREATOR_SW_CFG_DIGEST_1 0x9c

Fields

{"reg": [{"name": "CREATOR_SW_CFG_DIGEST", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:0 ro 0x0 CREATOR_SW_CFG_DIGEST

OWNER_SW_CFG_DIGEST

Integrity digest for the OWNER_SW_CFG partition. The integrity digest is 0 by default. Software must write this digest value via the direct access interface in order to lock the partition. After a reset, write access to the OWNER_SW_CFG partition is locked and the digest becomes visible in this CSR.

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

Instances

Name Offset
OWNER_SW_CFG_DIGEST_0 0xa0
OWNER_SW_CFG_DIGEST_1 0xa4

Fields

{"reg": [{"name": "OWNER_SW_CFG_DIGEST", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:0 ro 0x0 OWNER_SW_CFG_DIGEST

ROT_CREATOR_AUTH_CODESIGN_DIGEST

Integrity digest for the ROT_CREATOR_AUTH_CODESIGN partition. The integrity digest is 0 by default. Software must write this digest value via the direct access interface in order to lock the partition. After a reset, write access to the ROT_CREATOR_AUTH_CODESIGN partition is locked and the digest becomes visible in this CSR.

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

Instances

Name Offset
ROT_CREATOR_AUTH_CODESIGN_DIGEST_0 0xa8
ROT_CREATOR_AUTH_CODESIGN_DIGEST_1 0xac

Fields

{"reg": [{"name": "ROT_CREATOR_AUTH_CODESIGN_DIGEST", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:0 ro 0x0 ROT_CREATOR_AUTH_CODESIGN_DIGEST

ROT_CREATOR_AUTH_STATE_DIGEST

Integrity digest for the ROT_CREATOR_AUTH_STATE partition. The integrity digest is 0 by default. Software must write this digest value via the direct access interface in order to lock the partition. After a reset, write access to the ROT_CREATOR_AUTH_STATE partition is locked and the digest becomes visible in this CSR.

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

Instances

Name Offset
ROT_CREATOR_AUTH_STATE_DIGEST_0 0xb0
ROT_CREATOR_AUTH_STATE_DIGEST_1 0xb4

Fields

{"reg": [{"name": "ROT_CREATOR_AUTH_STATE_DIGEST", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:0 ro 0x0 ROT_CREATOR_AUTH_STATE_DIGEST

HW_CFG0_DIGEST

Integrity digest for the HW_CFG0 partition. The integrity digest is 0 by default. The digest calculation can be triggered via the DIRECT_ACCESS_CMD. After a reset, the digest then becomes visible in this CSR, and the corresponding partition becomes write-locked.

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

Instances

Name Offset
HW_CFG0_DIGEST_0 0xb8
HW_CFG0_DIGEST_1 0xbc

Fields

{"reg": [{"name": "HW_CFG0_DIGEST", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:0 ro 0x0 HW_CFG0_DIGEST

HW_CFG1_DIGEST

Integrity digest for the HW_CFG1 partition. The integrity digest is 0 by default. The digest calculation can be triggered via the DIRECT_ACCESS_CMD. After a reset, the digest then becomes visible in this CSR, and the corresponding partition becomes write-locked.

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

Instances

Name Offset
HW_CFG1_DIGEST_0 0xc0
HW_CFG1_DIGEST_1 0xc4

Fields

{"reg": [{"name": "HW_CFG1_DIGEST", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:0 ro 0x0 HW_CFG1_DIGEST

SECRET0_DIGEST

Integrity digest for the SECRET0 partition. The integrity digest is 0 by default. The digest calculation can be triggered via the DIRECT_ACCESS_CMD. After a reset, the digest then becomes visible in this CSR, and the corresponding partition becomes write-locked.

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

Instances

Name Offset
SECRET0_DIGEST_0 0xc8
SECRET0_DIGEST_1 0xcc

Fields

{"reg": [{"name": "SECRET0_DIGEST", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:0 ro 0x0 SECRET0_DIGEST

SECRET1_DIGEST

Integrity digest for the SECRET1 partition. The integrity digest is 0 by default. The digest calculation can be triggered via the DIRECT_ACCESS_CMD. After a reset, the digest then becomes visible in this CSR, and the corresponding partition becomes write-locked.

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

Instances

Name Offset
SECRET1_DIGEST_0 0xd0
SECRET1_DIGEST_1 0xd4

Fields

{"reg": [{"name": "SECRET1_DIGEST", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:0 ro 0x0 SECRET1_DIGEST

SECRET2_DIGEST

Integrity digest for the SECRET2 partition. The integrity digest is 0 by default. The digest calculation can be triggered via the DIRECT_ACCESS_CMD. After a reset, the digest then becomes visible in this CSR, and the corresponding partition becomes write-locked.

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

Instances

Name Offset
SECRET2_DIGEST_0 0xd8
SECRET2_DIGEST_1 0xdc

Fields

{"reg": [{"name": "SECRET2_DIGEST", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:0 ro 0x0 SECRET2_DIGEST

SW_CFG_WINDOW

Any read to this window directly maps to the corresponding offset in the creator and owner software config partitions, and triggers an OTP readout of the bytes requested. Note that the transaction will block until OTP readout has completed.

  • Word Aligned Offset Range: 0x800to0xffc
  • Size (words): 512
  • Access: ro
  • Byte writes are not supported.

Summary of the prim interface's registers

Name Offset Length Description
otp_ctrl.CSR0 0x0 4
otp_ctrl.CSR1 0x4 4
otp_ctrl.CSR2 0x8 4
otp_ctrl.CSR3 0xc 4
otp_ctrl.CSR4 0x10 4
otp_ctrl.CSR5 0x14 4
otp_ctrl.CSR6 0x18 4
otp_ctrl.CSR7 0x1c 4

CSR0

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

Fields

{"reg": [{"name": "field0", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "field1", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "field2", "bits": 1, "attr": ["rw"], "rotate": -90}, {"bits": 1}, {"name": "field3", "bits": 10, "attr": ["rw"], "rotate": 0}, {"bits": 2}, {"name": "field4", "bits": 11, "attr": ["rw"], "rotate": 0}, {"bits": 5}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:27 Reserved
26:16 rw 0x0 field4
15:14 Reserved
13:4 rw 0x0 field3
3 Reserved
2 rw 0x0 field2
1 rw 0x0 field1
0 rw 0x0 field0

CSR1

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

Fields

{"reg": [{"name": "field0", "bits": 7, "attr": ["rw"], "rotate": 0}, {"name": "field1", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "field2", "bits": 7, "attr": ["rw"], "rotate": 0}, {"name": "field3", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "field4", "bits": 16, "attr": ["rw"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:16 rw 0x0 field4
15 rw 0x0 field3
14:8 rw 0x0 field2
7 rw 0x0 field1
6:0 rw 0x0 field0

CSR2

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

Fields

{"reg": [{"name": "field0", "bits": 1, "attr": ["rw"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:1 Reserved
0 rw 0x0 field0

CSR3

  • Offset: 0xc
  • Reset default: 0x0
  • Reset mask: 0x7f3ff7

Fields

{"reg": [{"name": "field0", "bits": 3, "attr": ["rw1c"], "rotate": -90}, {"bits": 1}, {"name": "field1", "bits": 10, "attr": ["rw1c"], "rotate": 0}, {"bits": 2}, {"name": "field2", "bits": 1, "attr": ["rw1c"], "rotate": -90}, {"name": "field3", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "field4", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "field5", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "field6", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "field7", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "field8", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 9}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:23 Reserved
22 ro 0x0 field8
21 ro 0x0 field7
20 ro 0x0 field6
19 ro 0x0 field5
18 ro 0x0 field4
17 ro 0x0 field3
16 rw1c 0x0 field2
15:14 Reserved
13:4 rw1c 0x0 field1
3 Reserved
2:0 rw1c 0x0 field0

CSR4

  • Offset: 0x10
  • Reset default: 0x0
  • Reset mask: 0x73ff

Fields

{"reg": [{"name": "field0", "bits": 10, "attr": ["rw"], "rotate": 0}, {"bits": 2}, {"name": "field1", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "field2", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "field3", "bits": 1, "attr": ["rw"], "rotate": -90}, {"bits": 17}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:15 Reserved
14 rw 0x0 field3
13 rw 0x0 field2
12 rw 0x0 field1
11:10 Reserved
9:0 rw 0x0 field0

CSR5

  • Offset: 0x14
  • Reset default: 0x0
  • Reset mask: 0xffff3fff

Fields

{"reg": [{"name": "field0", "bits": 6, "attr": ["rw"], "rotate": 0}, {"name": "field1", "bits": 2, "attr": ["rw"], "rotate": -90}, {"name": "field2", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "field3", "bits": 3, "attr": ["ro"], "rotate": -90}, {"name": "field4", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "field5", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 2}, {"name": "field6", "bits": 16, "attr": ["rw"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:16 rw 0x0 field6
15:14 Reserved
13 ro 0x0 field5
12 ro 0x0 field4
11:9 ro 0x0 field3
8 ro 0x0 field2
7:6 rw 0x0 field1
5:0 rw 0x0 field0

CSR6

  • Offset: 0x18
  • Reset default: 0x0
  • Reset mask: 0xffff1bff

Fields

{"reg": [{"name": "field0", "bits": 10, "attr": ["rw"], "rotate": 0}, {"bits": 1}, {"name": "field1", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "field2", "bits": 1, "attr": ["rw"], "rotate": -90}, {"bits": 3}, {"name": "field3", "bits": 16, "attr": ["rw"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:16 rw 0x0 field3
15:13 Reserved
12 rw 0x0 field2
11 rw 0x0 field1
10 Reserved
9:0 rw 0x0 field0

CSR7

  • Offset: 0x1c
  • Reset default: 0x0
  • Reset mask: 0xc73f

Fields

{"reg": [{"name": "field0", "bits": 6, "attr": ["ro"], "rotate": 0}, {"bits": 2}, {"name": "field1", "bits": 3, "attr": ["ro"], "rotate": -90}, {"bits": 3}, {"name": "field2", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "field3", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 16}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
Bits Type Reset Name Description
31:16 Reserved
15 ro 0x0 field3
14 ro 0x0 field2
13:11 Reserved
10:8 ro 0x0 field1
7:6 Reserved
5:0 ro 0x0 field0