Registers

Summary

NameOffsetLengthDescription
csrng.INTR_STATE0x04Interrupt State Register
csrng.INTR_ENABLE0x44Interrupt Enable Register
csrng.INTR_TEST0x84Interrupt Test Register
csrng.ALERT_TEST0xc4Alert Test Register
csrng.REGWEN0x104Register write enable for all control registers
csrng.CTRL0x144Control register
csrng.CMD_REQ0x184Command request register
csrng.RESEED_INTERVAL0x1c4CSRNG maximum number of generate requests allowed between reseeds register
csrng.RESEED_COUNTER_00x204Reseed counter.
csrng.RESEED_COUNTER_10x244Reseed counter.
csrng.RESEED_COUNTER_20x284Reseed counter.
csrng.SW_CMD_STS0x2c4Application interface command status register
csrng.GENBITS_VLD0x304Generate bits returned valid register
csrng.GENBITS0x344Generate bits returned register
csrng.INT_STATE_READ_ENABLE_REGWEN0x384Internal state read enable REGWEN register
csrng.INT_STATE_READ_ENABLE0x3c4Internal state read enable register
csrng.INT_STATE_NUM_REGWEN0x404Internal state instance index REGWEN register
csrng.INT_STATE_NUM0x444Internal state instance index register
csrng.INT_STATE_VAL0x484Internal state read/write access register
csrng.FIPS_FORCE0x4c4FIPS/CC compliance flag forcing register
csrng.GEN_ABORT_REGWEN0x504Register write enable for GEN_ABORT
csrng.GEN_ABORT_00x544Generate command abort request register
csrng.GEN_ABORT_10x584Generate command abort request register
csrng.GEN_ABORT_20x5c4Generate command abort request register
csrng.GEN_ABORT_STATUS_00x604Generate command abort completion status register
csrng.GEN_ABORT_STATUS_10x644Generate command abort completion status register
csrng.GEN_ABORT_STATUS_20x684Generate command abort completion status register
csrng.HW_EXC_STS0x6c4Hardware instance exception status register
csrng.RECOV_ALERT_STS0x704Recoverable alert status register
csrng.ERR_CODE0x744Hardware detection of error conditions status register
csrng.ERR_CODE_TEST0x784Test error conditions register
csrng.MAIN_SM_STATE0x7c4Main state machine state debug register
csrng.INT_STATE_WRITE_ENABLE_REGWEN0x804Internal state write enable REGWEN register
csrng.INT_STATE_WRITE_ENABLE0x844Internal state write enable register
csrng.INT_STATE_HALT_ENABLE_REGWEN0x884Internal state halt enable REGWEN register
csrng.INT_STATE_HALT_ENABLE0x8c4Internal state halt enable register
csrng.INT_STATE_HALT0x904Internal state halt register
csrng.INT_STATE_STS0x944Internal state halt status register

INTR_STATE

Interrupt State Register

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

Fields

{"reg": [{"name": "cs_cmd_req_done", "bits": 1, "attr": ["rw1c"], "rotate": -90}, {"name": "cs_entropy_req", "bits": 1, "attr": ["rw1c"], "rotate": -90}, {"name": "cs_hw_inst_exc", "bits": 1, "attr": ["rw1c"], "rotate": -90}, {"name": "cs_fatal_err", "bits": 1, "attr": ["rw1c"], "rotate": -90}, {"bits": 28}], "config": {"lanes": 1, "fontsize": 10, "vspace": 170}}
BitsTypeResetNameDescription
31:4Reserved
3rw1c0x0cs_fatal_errAsserted when a FIFO error or a fatal alert occurs. Check the ERR_CODE register to get more information.
2rw1c0x0cs_hw_inst_excAsserted when a hardware-attached CSRNG instance encounters a command exception
1rw1c0x0cs_entropy_reqAsserted when a request for entropy has been made.
0rw1c0x0cs_cmd_req_doneAsserted when a command request is completed, or when a CSRNG instance halted via INT_STATE_HALT has quiesced.

INTR_ENABLE

Interrupt Enable Register

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

Fields

{"reg": [{"name": "cs_cmd_req_done", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "cs_entropy_req", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "cs_hw_inst_exc", "bits": 1, "attr": ["rw"], "rotate": -90}, {"name": "cs_fatal_err", "bits": 1, "attr": ["rw"], "rotate": -90}, {"bits": 28}], "config": {"lanes": 1, "fontsize": 10, "vspace": 170}}
BitsTypeResetNameDescription
31:4Reserved
3rw0x0cs_fatal_errEnable interrupt when INTR_STATE.cs_fatal_err is set.
2rw0x0cs_hw_inst_excEnable interrupt when INTR_STATE.cs_hw_inst_exc is set.
1rw0x0cs_entropy_reqEnable interrupt when INTR_STATE.cs_entropy_req is set.
0rw0x0cs_cmd_req_doneEnable interrupt when INTR_STATE.cs_cmd_req_done is set.

INTR_TEST

Interrupt Test Register

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

Fields

{"reg": [{"name": "cs_cmd_req_done", "bits": 1, "attr": ["wo"], "rotate": -90}, {"name": "cs_entropy_req", "bits": 1, "attr": ["wo"], "rotate": -90}, {"name": "cs_hw_inst_exc", "bits": 1, "attr": ["wo"], "rotate": -90}, {"name": "cs_fatal_err", "bits": 1, "attr": ["wo"], "rotate": -90}, {"bits": 28}], "config": {"lanes": 1, "fontsize": 10, "vspace": 170}}
BitsTypeResetNameDescription
31:4Reserved
3wo0x0cs_fatal_errWrite 1 to force INTR_STATE.cs_fatal_err to 1.
2wo0x0cs_hw_inst_excWrite 1 to force INTR_STATE.cs_hw_inst_exc to 1.
1wo0x0cs_entropy_reqWrite 1 to force INTR_STATE.cs_entropy_req to 1.
0wo0x0cs_cmd_req_doneWrite 1 to force INTR_STATE.cs_cmd_req_done to 1.

ALERT_TEST

Alert Test Register

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

Fields

{"reg": [{"name": "recov_alert", "bits": 1, "attr": ["wo"], "rotate": -90}, {"name": "fatal_alert", "bits": 1, "attr": ["wo"], "rotate": -90}, {"bits": 29}, {"name": "regwen", "bits": 1, "attr": ["rw0c"], "rotate": -90}], "config": {"lanes": 1, "fontsize": 10, "vspace": 130}}
BitsTypeResetNameDescription
31rw0c0x1regwenWrite 0 to disable alert testing until the next reset.
30:2Reserved
1wo0x0fatal_alertWrite 1 to trigger one alert event of this kind.
0wo0x0recov_alertWrite 1 to trigger one alert event of this kind.

REGWEN

Register write enable for all control registers

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

Fields

{"reg": [{"name": "REGWEN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
BitsTypeResetNameDescription
31:1Reserved
0rw0c0x1REGWENWhen true, all writeable registers can be modified. When false, they become read-only.

CTRL

Control register

  • Offset: 0x14
  • Reset default: 0x99999
  • Reset mask: 0xfffff
  • Register enable: REGWEN

Fields

{"reg": [{"name": "ENABLE", "bits": 4, "attr": ["rw"], "rotate": 0}, {"name": "SW_APP_ENABLE", "bits": 4, "attr": ["rw"], "rotate": -90}, {"name": "READ_INT_STATE", "bits": 4, "attr": ["rw"], "rotate": -90}, {"name": "WRITE_INT_STATE", "bits": 4, "attr": ["rw"], "rotate": -90}, {"name": "FIPS_FORCE_ENABLE", "bits": 4, "attr": ["rw"], "rotate": -90}, {"bits": 12}], "config": {"lanes": 1, "fontsize": 10, "vspace": 190}}
BitsTypeResetNameDescription
31:20Reserved
19:16rw0x9FIPS_FORCE_ENABLESetting this field to kMultiBitBool4True enables forcing the FIPS/CC compliance flag to true via the FIPS_FORCE register.
15:12rw0x9WRITE_INT_STATESetting this field to kMultiBitBool4True will enable writing the internal state via INT_STATE_VAL. Also, the INT_STATE_WRITE_ENABLE bit of the selected instance needs to be set to true for this to work.
11:8rw0x9READ_INT_STATESetting this field to kMultiBitBool4True will enable reading the internal state via INT_STATE_VAL. Also, the INT_STATE_READ_ENABLE bit of the selected instance needs to be set to true for this to work.
7:4rw0x9SW_APP_ENABLESetting this field to kMultiBitBool4True will enable reading from the GENBITS register.
3:0rw0x9ENABLESetting this field to kMultiBitBool4True will enable the CSRNG module. The modules of the entropy complex may only be enabled and disabled in a specific order, see Programmers Guide for details.

CMD_REQ

Command request register

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

Fields

{"reg": [{"name": "CMD_REQ", "bits": 32, "attr": ["wo"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
BitsTypeResetName
31:0wo0x0CMD_REQ

CMD_REQ . CMD_REQ

Writing this request with defined CSRNG commands will initiate all possible CSRNG actions. The application interface must wait for the “ack” to return before issuing new commands. Before writing each word of a command, SW_CMD_STS.CMD_RDY needs to be polled.

RESEED_INTERVAL

CSRNG maximum number of generate requests allowed between reseeds register

  • Offset: 0x1c
  • Reset default: 0xffffffff
  • Reset mask: 0xffffffff

Fields

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

RESEED_INTERVAL . RESEED_INTERVAL

Setting this field will set the number of generate requests that can be made to CSRNG before a reseed request needs to be made. This register supports a maximum of 2^32 requests between reseeds. This register will be compared to a counter, which counts the number of generate commands between reseed or instantiate commands. If the counter reaches the value of this register, the violating command will be acknowledged with a status error. If the violating command was issued by a HW instance, an interrupt will be triggered.

RESEED_COUNTER

Reseed counter.

The per-instance reseed counter indicates the number of Generate requests that have been completed since new entropy input has been obtained with an Instantiate or a Reseed command.

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

Instances

NameOffset
RESEED_COUNTER_00x20
RESEED_COUNTER_10x24
RESEED_COUNTER_20x28

Fields

{"reg": [{"name": "RESEED_COUNTER", "bits": 32, "attr": ["ro"], "rotate": 0}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
BitsTypeResetNameDescription
31:0ro0x0RESEED_COUNTERReseed Counter indicating the number of completed Generate requests since the last Instantiate or Reseed command.

SW_CMD_STS

Application interface command status register

  • Offset: 0x2c
  • Reset default: 0x0
  • Reset mask: 0x3e

Fields

{"reg": [{"bits": 1}, {"name": "CMD_RDY", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "CMD_ACK", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "CMD_STS", "bits": 3, "attr": ["ro"], "rotate": -90}, {"bits": 26}], "config": {"lanes": 1, "fontsize": 10, "vspace": 90}}
BitsTypeResetName
31:6Reserved
5:3ro0x0CMD_STS
2ro0x0CMD_ACK
1ro0x0CMD_RDY

SW_CMD_STS . CMD_STS

This field represents the status code returned with the application command ack. It is updated each time a command ack is asserted on the internal application interface for software use. To check whether a command was successful, wait for INTR_STATE.CS_CMD_REQ_DONE or SW_CMD_STS.CMD_ACK to be high and then check the value of this field.

ValueNameDescription
0x0SUCCESSRequest completed successfully.
0x1INVALID_ACMDRequest completed with an invalid application command error. This error indicates that the issued application command doesn’t represent a valid operation.
0x2INVALID_GEN_CMDRequest completed with an invalid Generate command error. This error indicates that a Generate command was issued with a glen field of zero. The command is ignored and no entropy is generated.
0x3INVALID_CMD_SEQThis error indicates that the last command was issued out of sequence. This happens when a command other than Instantiate was issued without sending an Instantiate command first. This can also happen when an Uninstantiate command is sent without instantiating first.
0x4RESEED_CNT_EXCEEDEDThis error indicates that the number of generate requests between reseeds exceeded the maximum number allowed (see RESEED_INTERVAL). This happens only for Generate commands.
0x5GEN_ABORTEDThis bit indicates that a Generate command for this instance was aborted via GEN_ABORT before returning all requested genbits. The instance has been uninstantiated as a result and must be instantiated again before further commands will succeed. This happens only for Generate commands.

Other values are reserved.

SW_CMD_STS . CMD_ACK

This one bit field indicates when a SW command has been acknowledged by the CSRNG. It is set to low each time a new command is written to CMD_REQ. The field is set to high once a SW command request has been acknowledged by the CSRNG. 0b0: The last SW command has not been acknowledged yet. 0b1: The last SW command has been acknowledged. In case of a generate command the acknowledgement goes high after all of the requested entropy is consumed.

SW_CMD_STS . CMD_RDY

This bit indicates when the command interface is ready to accept the next command word. Before writing each word of a command to CMD_REQ, this field needs to be polled. Words written while this field is low are dropped, set ERR_CODE.SFIFO_CMD_ERR and ERR_CODE.FIFO_WRITE_ERR, and trigger a fatal alert. 0b0: CSRNG is not ready to accept the next command word or the last command hasn’t been acked yet. 0b1: CSRNG is ready to accept the next command word.

GENBITS_VLD

Generate bits returned valid register

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

Fields

{"reg": [{"name": "GENBITS_VLD", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "GENBITS_FIPS", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 30}], "config": {"lanes": 1, "fontsize": 10, "vspace": 140}}
BitsTypeResetNameDescription
31:2Reserved
1roxGENBITS_FIPSThis bit is set when genbits are FIPS/CC compliant.
0roxGENBITS_VLDThis bit is set when genbits are available on this application interface after a generate command has been issued.

GENBITS

Generate bits returned register

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

Fields

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

GENBITS . GENBITS

Reading this register will get the generated bits that were requested with the generate request. This register must be read four times for each request made. For example, an application command generate request with a clen value of 4 requires this register to be read 16 times to get all of the data out of the FIFO path. Note that for GENBITS to be able to deliver random numbers, also CTRL.SW_APP_ENABLE needs to be set to kMultiBitBool4True. Otherwise, the register reads as 0.

INT_STATE_READ_ENABLE_REGWEN

Internal state read enable REGWEN register

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

Fields

{"reg": [{"name": "INT_STATE_READ_ENABLE_REGWEN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 300}}
BitsTypeResetNameDescription
31:1Reserved
0rw0c0x1INT_STATE_READ_ENABLE_REGWENINT_STATE_READ_ENABLE register configuration enable bit. If this is cleared to 0, the INT_STATE_READ_ENABLE register cannot be written anymore.

INT_STATE_READ_ENABLE

Internal state read enable register

Fields

{"reg": [{"name": "INT_STATE_READ_ENABLE", "bits": 3, "attr": ["rw"], "rotate": -90}, {"bits": 29}], "config": {"lanes": 1, "fontsize": 10, "vspace": 230}}
BitsTypeResetName
31:3Reserved
2:0rw0x7INT_STATE_READ_ENABLE

INT_STATE_READ_ENABLE . INT_STATE_READ_ENABLE

Per-instance internal state read enable. Defines whether the internal state of the corresponding instance can be read via INT_STATE_VAL. Reads for an instance whose bit is cleared return 0. Note that reading additionally requires CTRL.READ_INT_STATE to be set to kMultiBitBool4True.

INT_STATE_NUM_REGWEN

Internal state instance index REGWEN register

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

Fields

{"reg": [{"name": "INT_STATE_NUM_REGWEN", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 220}}
BitsTypeResetNameDescription
31:1Reserved
0ro0x1INT_STATE_NUM_REGWENINT_STATE_NUM register configuration enable bit. This bit is cleared while INT_STATE_HALT is set to kMultiBitBool4True, so the selected instance cannot be changed while it is halted.

INT_STATE_NUM

Internal state instance index register

Fields

{"reg": [{"name": "INT_STATE_NUM", "bits": 4, "attr": ["rw"], "rotate": -90}, {"bits": 28}], "config": {"lanes": 1, "fontsize": 10, "vspace": 150}}
BitsTypeResetName
31:4Reserved
3:0rwxINT_STATE_NUM

INT_STATE_NUM . INT_STATE_NUM

Index of the CSRNG instance whose internal state is targeted via INT_STATE_VAL. Valid indices are 0 to NumApps-1 (number of HW interfaces plus one for the SW interface). Writes of a larger index are ignored and set RECOV_ALERT_STS.INT_STATE_NUM_INVALID_ALERT. This register cannot be written while INT_STATE_NUM_REGWEN is cleared. Writing this register also resets the read/write pointer of INT_STATE_VAL to the first word of the selected state. This field also selects the instance targeted by INT_STATE_HALT and INT_STATE_STS.

INT_STATE_VAL

Internal state read/write access register

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

Fields

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

INT_STATE_VAL . INT_STATE_VAL

Reading this register will dump out the contents of the selected instance’s internal state. Writing this register overwrites the state word by word as the writes arrive. Stopping before all 26 words have been written leaves the instance with a mix of restored and previous state words. The internal state comprises the CTR_DRBG state (key/V/reseed counter/fips/instantiated) as well as the state of a Generate command paused mid-sequence (remaining block count, Generate flag and additional data). Since this field is 816 bits wide, it will require 26 reads or writes of this register to access the entire field. Every read and every write advances the internal read/write pointer (selects 32 bits of the 816 bit field), which wraps around to zero after 26 accesses. Reads and writes share this pointer. Writing INT_STATE_NUM resets the pointer to zero, so every read or write sequence should be started by writing INT_STATE_NUM.

Reserved bits are ignored on writes and read as 0.

Reads are accepted regardless of whether the instance is halted. Restoring the state is only possible while the instance is halted. If the state is internally updated while an access sequence is in progress, RECOV_ALERT_STS.INT_STATE_OVERWRITE_ALERT is raised. To get a consistent snapshot, halt the instance via INT_STATE_HALT first.

Note that for INT_STATE_VAL to provide read access to the internal state, CTRL.READ_INT_STATE needs to be set to kMultiBitBool4True and the INT_STATE_READ_ENABLE bit of the selected instance needs to be set. For write access, CTRL.WRITE_INT_STATE needs to be set to kMultiBitBool4True, the INT_STATE_WRITE_ENABLE bit of the selected instance needs to be set and INT_STATE_STS.HALTED needs to be set. Otherwise, the register reads as 0, writes are dropped and the pointer does not advance.

FIPS_FORCE

FIPS/CC compliance flag forcing register

  • Offset: 0x4c
  • Reset default: 0x0
  • Reset mask: 0x7
  • Register enable: REGWEN

Fields

{"reg": [{"name": "FIPS_FORCE", "bits": 3, "attr": ["rw"], "rotate": -90}, {"bits": 29}], "config": {"lanes": 1, "fontsize": 10, "vspace": 120}}
BitsTypeResetName
31:3Reserved
2:0rw0x0FIPS_FORCE

FIPS_FORCE . FIPS_FORCE

Force the FIPS/CC compliance flag of individual instances to true. This allows CSRNG to set the output FIPS/CC compliance flag to true despite running in fully deterministic mode (flag0 being true). This can be useful e.g. for known-answer testing through entropy consumers accepting FIPS/CC compliant entropy only, or when firmware is used to derive FIPS/CC compliant entropy seeds. After setting a particular bit to 1, the FIPS/CC compliance flag of the corresponding instance will be forced to true upon the next Instantiate or Reseed command.

Note that for this to work, CTRL.FIPS_FORCE_ENABLE needs to be set to kMultiBitBool4True.

GEN_ABORT_REGWEN

Register write enable for GEN_ABORT

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

Fields

{"reg": [{"name": "GEN_ABORT_REGWEN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 180}}
BitsTypeResetNameDescription
31:1Reserved
0rw0c0x1GEN_ABORT_REGWENWhen true, the GEN_ABORT register can be written. When false, it becomes read-only until the next reset.

GEN_ABORT

Generate command abort request register

Instances

NameOffset
GEN_ABORT_00x54
GEN_ABORT_10x58
GEN_ABORT_20x5c

Fields

{"reg": [{"name": "GEN_ABORT", "bits": 4, "attr": ["rw1s"], "rotate": -90}, {"bits": 28}], "config": {"lanes": 1, "fontsize": 10, "vspace": 110}}
BitsTypeResetName
31:4Reserved
3:0rw1s0x9GEN_ABORT

GEN_ABORT . GEN_ABORT

Setting this field to kMultiBitBool4True requests aborting a Generate command that is currently in progress for this instance. The instance is zeroed as a result. It must be instantiated again before further Reseed, Update, or Generate commands can succeed.

This request is only accepted while a Generate command is actually in progress for this instance. If no Generate command is in progress, the write is ignored and RECOV_ALERT_STS.GEN_ABORT_INVALID_ALERT is set instead. If the instance is halted via INT_STATE_HALT, the abort only takes effect once the instance is resumed.

GEN_ABORT_STATUS

Generate command abort completion status register

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

Instances

NameOffset
GEN_ABORT_STATUS_00x60
GEN_ABORT_STATUS_10x64
GEN_ABORT_STATUS_20x68

Fields

{"reg": [{"name": "GEN_ABORT_STATUS", "bits": 1, "attr": ["rw1c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 180}}
BitsTypeResetNameDescription
31:1Reserved
0rw1c0x0GEN_ABORT_STATUSThis bit is set when a Generate command abort requested via GEN_ABORT for this instance has completed. Write 1 to clear.

HW_EXC_STS

Hardware instance exception status register

  • Offset: 0x6c
  • Reset default: 0x0
  • Reset mask: 0xffff

Fields

{"reg": [{"name": "HW_EXC_STS", "bits": 16, "attr": ["rw0c"], "rotate": 0}, {"bits": 16}], "config": {"lanes": 1, "fontsize": 10, "vspace": 80}}
BitsTypeResetName
31:16Reserved
15:0rw0c0x0HW_EXC_STS

HW_EXC_STS . HW_EXC_STS

Reading this register indicates whether one of the CSRNG HW instances has encountered an exception. Each bit corresponds to a particular hardware instance, with bit 0 corresponding to instance HW0, bit 1 corresponding to instance HW1, and so forth. (To monitor the status of requests made to the SW instance, check the SW_CMD_STS register). Writing a zero to this register resets the status bits.

RECOV_ALERT_STS

Recoverable alert status register

  • Offset: 0x70
  • Reset default: 0x0
  • Reset mask: 0x1f7ff

Fields

{"reg": [{"name": "ENABLE_FIELD_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "SW_APP_ENABLE_FIELD_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "READ_INT_STATE_FIELD_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "WRITE_INT_STATE_FIELD_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "FIPS_FORCE_ENABLE_FIELD_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "ACMD_FLAG0_FIELD_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "GEN_ABORT_INVALID_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "GEN_ABORT_FIELD_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "INT_STATE_HALT_FIELD_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "INT_STATE_OVERWRITE_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "INT_STATE_NUM_INVALID_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 1}, {"name": "CS_BUS_CMP_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "CMD_STAGE_INVALID_ACMD_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "CMD_STAGE_INVALID_GEN_CMD_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "CMD_STAGE_INVALID_CMD_SEQ_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"name": "CMD_STAGE_RESEED_CNT_ALERT", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 15}], "config": {"lanes": 1, "fontsize": 10, "vspace": 330}}

RECOV_ALERT_STS . CMD_STAGE_RESEED_CNT_ALERT

This bit is set when the maximum number of generate requests between reseeds is exceeded. The invalid generate command is ignored and CSRNG continues to operate. Writing a zero resets this status bit.

RECOV_ALERT_STS . CMD_STAGE_INVALID_CMD_SEQ_ALERT

This bit is set when an out of order command is received by the main state machine. This happens when an instantiate command is sent for a state that was already instantiated or when any command other than instantiate is sent for a state that wasn’t instantiated yet. The invalid command is ignored and CSRNG continues to operate. Writing a zero resets this status bit.

RECOV_ALERT_STS . CMD_STAGE_INVALID_GEN_CMD_ALERT

This bit is set when a Generate command is received with a glen field of zero. The invalid command is ignored and CSRNG continues to operate. Writing a zero resets this status bit.

RECOV_ALERT_STS . CMD_STAGE_INVALID_ACMD_ALERT

This bit is set when an unsupported/illegal CSRNG command is received by the main state machine. The invalid command is ignored and CSRNG continues to operate. Writing a zero resets this status bit.

RECOV_ALERT_STS . CS_BUS_CMP_ALERT

This bit is set when the software application port genbits bus value is equal to the prior valid value on the bus, indicating a possible attack. Writing a zero resets this status bit.

RECOV_ALERT_STS . INT_STATE_NUM_INVALID_ALERT

This bit is set when INT_STATE_NUM is written with the index of a reserved instance. The write is ignored and CSRNG continues to operate. This bit is also set if the selected instance is invalid, which can only be caused by a fault. Writing a zero resets this status bit.

RECOV_ALERT_STS . INT_STATE_OVERWRITE_ALERT

This bit is set when CSRNG internally updates the state of the instance selected by INT_STATE_NUM while an access sequence via INT_STATE_VAL is in progress. A sequence starts with the first access to INT_STATE_VAL and ends with the 26th access, or earlier when it is aborted, e.g., when INT_STATE_NUM is written. The words read or written in that sequence may therefore be inconsistent. Writing a zero resets this status bit.

RECOV_ALERT_STS . INT_STATE_HALT_FIELD_ALERT

This bit is set when the INT_STATE_HALT register is set to a value other than kMultiBitBool4True or kMultiBitBool4False. Writing a zero resets this status bit.

RECOV_ALERT_STS . GEN_ABORT_FIELD_ALERT

This bit is set when a field of the GEN_ABORT register is set to a value other than kMultiBitBool4True or kMultiBitBool4False. Writing a zero resets this status bit.

RECOV_ALERT_STS . GEN_ABORT_INVALID_ALERT

This bit is set when a field of the GEN_ABORT register is set to kMultiBitBool4True for an instance that does not currently have a Generate command in progress. The write is ignored and CSRNG continues to operate. Writing a zero resets this status bit.

RECOV_ALERT_STS . ACMD_FLAG0_FIELD_ALERT

This bit is set when the FLAG0 field in the Application Command is set to a value other than kMultiBitBool4True or kMultiBitBool4False. Writing a zero resets this status bit.

RECOV_ALERT_STS . FIPS_FORCE_ENABLE_FIELD_ALERT

This bit is set when the FIPS_FORCE_ENABLE field in the CTRL register is set to a value other than kMultiBitBool4True or kMultiBitBool4False. Writing a zero resets this status bit.

RECOV_ALERT_STS . WRITE_INT_STATE_FIELD_ALERT

This bit is set when the WRITE_INT_STATE field in the CTRL register is set to a value other than kMultiBitBool4True or kMultiBitBool4False. Writing a zero resets this status bit.

RECOV_ALERT_STS . READ_INT_STATE_FIELD_ALERT

This bit is set when the READ_INT_STATE field in the CTRL register is set to a value other than kMultiBitBool4True or kMultiBitBool4False. Writing a zero resets this status bit.

RECOV_ALERT_STS . SW_APP_ENABLE_FIELD_ALERT

This bit is set when the SW_APP_ENABLE field in the CTRL register is set to a value other than kMultiBitBool4True or kMultiBitBool4False. Writing a zero resets this status bit.

RECOV_ALERT_STS . ENABLE_FIELD_ALERT

This bit is set when the ENABLE field in the CTRL register is set to a value other than kMultiBitBool4True or kMultiBitBool4False. Writing a zero resets this status bit.

ERR_CODE

Hardware detection of error conditions status register

  • Offset: 0x74
  • Reset default: 0x0
  • Reset mask: 0x76700003

Fields

{"reg": [{"name": "SFIFO_CMD_ERR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "SFIFO_GENBITS_ERR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 18}, {"name": "CMD_STAGE_SM_ERR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "MAIN_SM_ERR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "CTR_DRBG_SM_ERR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 2}, {"name": "AES_CIPHER_SM_ERR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "CTR_ERR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 1}, {"name": "FIFO_WRITE_ERR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "FIFO_READ_ERR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "FIFO_STATE_ERR", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 1}], "config": {"lanes": 1, "fontsize": 10, "vspace": 190}}
BitsTypeResetName
31Reserved
30ro0x0FIFO_STATE_ERR
29ro0x0FIFO_READ_ERR
28ro0x0FIFO_WRITE_ERR
27Reserved
26ro0x0CTR_ERR
25ro0x0AES_CIPHER_SM_ERR
24:23Reserved
22ro0x0CTR_DRBG_SM_ERR
21ro0x0MAIN_SM_ERR
20ro0x0CMD_STAGE_SM_ERR
19:2Reserved
1ro0x0SFIFO_GENBITS_ERR
0ro0x0SFIFO_CMD_ERR

ERR_CODE . FIFO_STATE_ERR

This bit will be set to one when any of the source bits (bits 0 through 15 of this this register) are asserted as a result of an error pulse generated from any FIFO where both the empty and full status bits are set. This bit will stay set until the next reset.

ERR_CODE . FIFO_READ_ERR

This bit will be set to one when any of the source bits (bits 0 through 15 of this this register) are asserted as a result of an error pulse generated from any empty FIFO that has received a read pulse. This bit will stay set until the next reset.

ERR_CODE . FIFO_WRITE_ERR

This bit will be set to one when any of the source bits (bits 0 through 15 of this this register) are asserted as a result of an error pulse generated from any full FIFO that has received a write pulse, or from a word written to CMD_REQ while SW_CMD_STS.CMD_RDY is low. This bit will stay set until the next reset.

ERR_CODE . CTR_ERR

This bit will be set to one when a mismatch in any of the hardened counters has been detected. This error will signal a fatal alert, and also an interrupt if enabled. This bit will stay set until the next reset.

ERR_CODE . AES_CIPHER_SM_ERR

This bit will be set to one when an AES fatal error has been detected. This error will signal a fatal alert, and also an interrupt if enabled. This bit will stay set until the next reset.

ERR_CODE . CTR_DRBG_SM_ERR

This bit will be set to one when an illegal state has been detected for the ctr_drbg state machine. This error will signal a fatal alert, and also an interrupt if enabled. This bit will stay set until the next reset.

ERR_CODE . MAIN_SM_ERR

This bit will be set to one when an illegal state has been detected for the main state machine. This error will signal a fatal alert, and also an interrupt if enabled. This bit will stay set until the next reset.

ERR_CODE . CMD_STAGE_SM_ERR

This bit will be set to one when an illegal state has been detected for the command stage state machine. This error will signal a fatal alert, and also an interrupt if enabled. This bit will stay set until the next reset.

ERR_CODE . SFIFO_GENBITS_ERR

This bit will be set to one when an error has been detected for the command stage genbits FIFO. The type of error is reflected in the type status bits (bits 28 through 30 of this register). This bit will stay set until the next reset.

ERR_CODE . SFIFO_CMD_ERR

This bit will be set to one when an error has been detected for the command stage command FIFO. The type of error is reflected in the type status bits (bits 28 through 30 of this register). This includes words written to CMD_REQ while SW_CMD_STS.CMD_RDY is low. This bit will stay set until the next reset.

ERR_CODE_TEST

Test error conditions register

  • Offset: 0x78
  • Reset default: 0x0
  • Reset mask: 0x1f
  • Register enable: REGWEN

Fields

{"reg": [{"name": "ERR_CODE_TEST", "bits": 5, "attr": ["rw"], "rotate": -90}, {"bits": 27}], "config": {"lanes": 1, "fontsize": 10, "vspace": 150}}
BitsTypeResetName
31:5Reserved
4:0rw0x0ERR_CODE_TEST

ERR_CODE_TEST . ERR_CODE_TEST

Setting this field will set the bit number for which an error will be forced in the hardware. This bit number is that same one found in the ERR_CODE register. The action of writing this register will force an error pulse. The sole purpose of this register is to test that any error properly propagates to either an interrupt or an alert.

MAIN_SM_STATE

Main state machine state debug register

  • Offset: 0x7c
  • Reset default: 0x17
  • Reset mask: 0x3f

Fields

{"reg": [{"name": "MAIN_SM_STATE", "bits": 6, "attr": ["ro"], "rotate": -90}, {"bits": 26}], "config": {"lanes": 1, "fontsize": 10, "vspace": 150}}
BitsTypeResetNameDescription
31:6Reserved
5:0ro0x17MAIN_SM_STATEThis is the state of the CSRNG main state machine. See the RTL file csrng_main_sm for the meaning of the values.

INT_STATE_WRITE_ENABLE_REGWEN

Internal state write enable REGWEN register

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

Fields

{"reg": [{"name": "INT_STATE_WRITE_ENABLE_REGWEN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 310}}
BitsTypeResetNameDescription
31:1Reserved
0rw0c0x1INT_STATE_WRITE_ENABLE_REGWENINT_STATE_WRITE_ENABLE register configuration enable bit. If this is cleared to 0, the INT_STATE_WRITE_ENABLE register cannot be written anymore.

INT_STATE_WRITE_ENABLE

Internal state write enable register

Fields

{"reg": [{"name": "INT_STATE_WRITE_ENABLE", "bits": 3, "attr": ["rw"], "rotate": -90}, {"bits": 29}], "config": {"lanes": 1, "fontsize": 10, "vspace": 240}}
BitsTypeResetName
31:3Reserved
2:0rw0x7INT_STATE_WRITE_ENABLE

INT_STATE_WRITE_ENABLE . INT_STATE_WRITE_ENABLE

Per-instance internal state write enable. Defines whether the internal state of the corresponding instance can be written via INT_STATE_VAL. Writes for an instance whose bit is cleared are dropped. Note that writing additionally requires CTRL.WRITE_INT_STATE to be set to kMultiBitBool4True.

INT_STATE_HALT_ENABLE_REGWEN

Internal state halt enable REGWEN register

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

Fields

{"reg": [{"name": "INT_STATE_HALT_ENABLE_REGWEN", "bits": 1, "attr": ["rw0c"], "rotate": -90}, {"bits": 31}], "config": {"lanes": 1, "fontsize": 10, "vspace": 300}}
BitsTypeResetNameDescription
31:1Reserved
0rw0c0x1INT_STATE_HALT_ENABLE_REGWENINT_STATE_HALT_ENABLE register configuration enable bit. If this is cleared to 0, the INT_STATE_HALT_ENABLE register cannot be written anymore.

INT_STATE_HALT_ENABLE

Internal state halt enable register

Fields

{"reg": [{"name": "INT_STATE_HALT_ENABLE", "bits": 3, "attr": ["rw"], "rotate": -90}, {"bits": 29}], "config": {"lanes": 1, "fontsize": 10, "vspace": 230}}
BitsTypeResetNameDescription
31:3Reserved
2:0rw0x7INT_STATE_HALT_ENABLEPer-instance internal state halt enable. Defines whether the corresponding instance can be halted via INT_STATE_HALT. Setting INT_STATE_HALT has no effect on an instance whose bit is cleared.

INT_STATE_HALT

Internal state halt register

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

Fields

{"reg": [{"name": "INT_STATE_HALT", "bits": 4, "attr": ["rw"], "rotate": -90}, {"bits": 28}], "config": {"lanes": 1, "fontsize": 10, "vspace": 160}}
BitsTypeResetName
31:4Reserved
3:0rw0x9INT_STATE_HALT

INT_STATE_HALT . INT_STATE_HALT

While this field is set to kMultiBitBool4True, the instance selected by INT_STATE_NUM halts and INT_STATE_NUM cannot be written. The instance first completes the command in progress and any commands already queued for it. A Generate command is instead halted as soon as the block currently being generated is complete. If this is the final block, the command is acknowledged after resuming, once the block has been read out. While halted, the instance accepts no new commands: EDN requests are back-pressured and SW_CMD_STS.CMD_RDY is low for the software instance. This requires the bit of the selected instance in INT_STATE_HALT_ENABLE to be set, otherwise the instance is not halted. Poll INT_STATE_STS.HALTED, or wait for INTR_STATE.CS_CMD_REQ_DONE, to know when the instance has halted. Setting this field to kMultiBitBool4False resumes the command processing of the instance.

INT_STATE_STS

Internal state halt status register

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

Fields

{"reg": [{"name": "HALTED", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "GENBITS_VLD", "bits": 1, "attr": ["ro"], "rotate": -90}, {"name": "GEN_IN_PROGRESS", "bits": 1, "attr": ["ro"], "rotate": -90}, {"bits": 29}], "config": {"lanes": 1, "fontsize": 10, "vspace": 170}}
BitsTypeResetName
31:3Reserved
2ro0x0GEN_IN_PROGRESS
1ro0x0GENBITS_VLD
0ro0x0HALTED

INT_STATE_STS . GEN_IN_PROGRESS

Reflects whether a Generate command is in progress for the instance selected by INT_STATE_NUM. While the instance is halted, this bit stays constant and indicates whether a Generate command can be aborted via GEN_ABORT.

INT_STATE_STS . GENBITS_VLD

Reflects whether generated bits of the instance selected by INT_STATE_NUM are waiting to be read by the consumer. The consumer can still read these bits while the instance is halted. Restoring the internal state via INT_STATE_VAL discards any generated bits that have not been read yet.

INT_STATE_STS . HALTED

Reflects whether the instance selected by INT_STATE_NUM has quiesced following INT_STATE_HALT, such that its internal state stays constant while it is read/written via INT_STATE_VAL. Also see INTR_STATE.CS_CMD_REQ_DONE, which fires when an instance has halted.