[edn/doc] references to register bits and fields updated
Matching the documenation section to match any bit to field conversions.
Signed-off-by: Mark Branstad <mark.branstad@wdc.com>
diff --git a/hw/ip/edn/doc/_index.md b/hw/ip/edn/doc/_index.md
index ae9631b..0f78cca 100644
--- a/hw/ip/edn/doc/_index.md
+++ b/hw/ip/edn/doc/_index.md
@@ -52,17 +52,17 @@
Once this is done, the EDN block can request data from the CSRNG once firmware has instantiated the associated instance through the EDN command forwarding interface.
When in this mode, the EDN emits `generate` commands from the first FIFO to get more data.
Once the {{< regref "MAX_NUM_REQS_BETWEEN_RESEEDS" >}} timer expires, the EDN block emits a `reseed` command from the second FIFO.
-The process of sending these two commands will repeat forever until the `EDN_ENABLE` bit is cleared, the `AUTO_REQ_MODE` bit is cleared, or the EDN is reset.
+The process of sending these two commands will repeat forever until the `EDN_ENABLE` field is cleared, the `AUTO_REQ_MODE` field is cleared, or the EDN is reset.
-Any of the command FIFOs can be reset by asserting the `CMD_FIFO_RST` bit in the {{< regref "CTRL" >}} register.
+Any of the command FIFOs can be reset by asserting the `CMD_FIFO_RST` field in the {{< regref "CTRL" >}} register.
The other mode is "boot-time request mode", where only the hardware generates CSRNG application interface commands.
In this mode a single `instantiate` command is sent, followed by a stream of `generate` commands.
This sequence fetches the initial random values needed for the system to boot.
Use of boot-time request mode, though simpler in operation, is only for applications which do not require FIPS-approved random values.
Please see the [entropy_src IP documentation]({{< relref "hw/ip/entropy_src/doc" >}}) for more information on trade-offs when creating CSRNG seeds before the completion of the FIPS-required health checks.
-In boot-time request mode the generate commands continue until `EDN_ENABLE` bit is cleared, the `BOOT_REQ_DIS` bit is set, or the EDN is reset.
-Note that when the `EDN_ENABLE` bit is cleared or the `BOOT_REQ_DIS` bit is set, an `uninstantiate` command needs to be sent by firmware to destroy the instance.
+In boot-time request mode the generate commands continue until `EDN_ENABLE` field is cleared (set to false), the `BOOT_REQ_MODE` field is cleared, or the EDN is reset.
+Note that when the `EDN_ENABLE` field is cleared or the `BOOT_REQ_MODE` field is cleared, an `uninstantiate` command needs to be sent by firmware to destroy the instance in csrng.
Note that the EDNs and CSRNG should always be reset together to ensure proper instantiation or uninstantiation of state variables.
## Example Topology
@@ -77,7 +77,7 @@
The EDN is for distributing random number streams to hardware blocks, via peripheral ports on on the EDN.
Each block connected to a peripheral port is referred to as an endpoint.
-To enable the EDN block, set the `EDN_ENABLE` bit in the {{< regref "CTRL" >}} register..
+To enable the EDN block, set the `EDN_ENABLE` field in the {{< regref "CTRL" >}} register..
## Interaction with CSRNG Application Interface Ports
@@ -97,10 +97,9 @@
In this mode, the EDN automatically issues a special reduced-latency `instantiate` command followed by the default `generate` commands.
This means, for instance, that no personalization strings or additional data may be passed to the CSRNG application interface port in this mode.
On exiting, the EDN issues an `uninstantiate` command to destroy the associated CSRNG instance.
-Since boot-time request mode is enabled as the default mode on reset, a single write to the `EDN_ENABLE` bit will start the flow of entropy in this mode.
Once firmware initialization is complete, it is important to exit this mode if the endpoints ever need FIPS-approved random values.
-This is done by either *clearing* the `EDN_ENABLE` bit or *setting* the `BOOT_REQ_DIS` bit in {{< regref "CTRL" >}} to halt the boot-time request state machine.
+This is done by either *clearing* the `EDN_ENABLE` field or *clearing* the `BOOT_REQ_MODE` field in {{< regref "CTRL" >}} to halt the boot-time request state machine.
Firmware must then wait for successful the shutdown of the state machine by polling the `REQ_MODE_SM_STS` field of the {{< regref "SUM_STS" >}} register.
#### Note on Security Considerations when Using Boot-time Request Mode
@@ -133,8 +132,8 @@
These `generate` commands will be issued as necessary to meet the bandwidth requirements of the endpoints.
The `reseed` commands will be issued once every `MAX_NUM_REQS_BETWEEN_RESEEDS` generate requests.
For details on the options for application interface commands please see the [CSRNG IP Documentation]({{< relref "hw/ip/csrng/doc/_index.md" >}}).
-Once the CSRNG instance has been instantiated, and the `generate` and `reseed` commands have been loaded, auto request mode can be entered by programming the {{< regref "CTRL" >}} register with `EDN_ENABLE`, `AUTO_REQ_MODE` and `BOOT_REQ_DIS` all asserted.
-Note that if BOOT_REQ_DIS is deasserted the state machine will enter boot-time request mode, even if AUTO_REQ_MODE is asserted.
+Once the CSRNG instance has been instantiated, and the `generate` and `reseed` commands have been loaded, auto request mode can be entered by programming the {{< regref "CTRL" >}} register with `EDN_ENABLE`, `AUTO_REQ_MODE` and `BOOT_REQ_MODE` all asserted.
+Note that if BOOT_REQ_MODE is asserted the state machine will enter boot-time request mode, even if AUTO_REQ_MODE is asserted.
To issue any new commands other than those stored in the generate or reseed FIFOs, it is important to disable auto request mode, by deasserting the `AUTO_REQ_MODE` field in the {{< regref "CTRL" >}} register.
Firmware must then wait until the current command is completed by polling the `REQ_MODE_SM_STS` bit in the {{< regref "SUM_STS" >}} register
