aboutsummaryrefslogtreecommitdiff
path: root/riscv/debug_defines.h
diff options
context:
space:
mode:
Diffstat (limited to 'riscv/debug_defines.h')
-rw-r--r--riscv/debug_defines.h2554
1 files changed, 1338 insertions, 1216 deletions
diff --git a/riscv/debug_defines.h b/riscv/debug_defines.h
index 06ba082..bf2dda0 100644
--- a/riscv/debug_defines.h
+++ b/riscv/debug_defines.h
@@ -1,21 +1,21 @@
-/*
- * This file is auto-generated by running 'make debug_defines.h' in
- * https://github.com/riscv/riscv-debug-spec/ (0e4d91e)
- */
+/* SPDX-License-Identifier: BSD-2-Clause OR CC-BY-4.0 */
+/* This file was auto-generated by running 'make debug_defines' in https://github.com/riscv/riscv-debug-spec/ (bc20adc) */
+#ifndef DEBUG_DEFINES_H
+#define DEBUG_DEFINES_H
#define DTM_IDCODE 0x01
/*
* Identifies the release version of this part.
*/
-#define DTM_IDCODE_VERSION_OFFSET 0x1c
-#define DTM_IDCODE_VERSION_LENGTH 4
-#define DTM_IDCODE_VERSION 0xf0000000U
+#define DTM_IDCODE_VERSION_OFFSET 0x1cULL
+#define DTM_IDCODE_VERSION_LENGTH 4ULL
+#define DTM_IDCODE_VERSION 0xf0000000ULL
/*
* Identifies the designer's part number of this part.
*/
-#define DTM_IDCODE_PARTNUMBER_OFFSET 0xc
-#define DTM_IDCODE_PARTNUMBER_LENGTH 0x10
-#define DTM_IDCODE_PARTNUMBER 0xffff000
+#define DTM_IDCODE_PARTNUMBER_OFFSET 0xcULL
+#define DTM_IDCODE_PARTNUMBER_LENGTH 0x10ULL
+#define DTM_IDCODE_PARTNUMBER 0xffff000ULL
/*
* Identifies the designer/manufacturer of this part. Bits 6:0 must be
* bits 6:0 of the designer/manufacturer's Identification Code as
@@ -23,14 +23,47 @@
* count of the number of continuation characters (0x7f) in that same
* Identification Code.
*/
-#define DTM_IDCODE_MANUFID_OFFSET 1
-#define DTM_IDCODE_MANUFID_LENGTH 0xb
-#define DTM_IDCODE_MANUFID 0xffe
-#define DTM_IDCODE_1_OFFSET 0
-#define DTM_IDCODE_1_LENGTH 1
-#define DTM_IDCODE_1 1
+#define DTM_IDCODE_MANUFID_OFFSET 1ULL
+#define DTM_IDCODE_MANUFID_LENGTH 0xbULL
+#define DTM_IDCODE_MANUFID 0xffeULL
+#define DTM_IDCODE_1_OFFSET 0ULL
+#define DTM_IDCODE_1_LENGTH 1ULL
+#define DTM_IDCODE_1 1ULL
#define DTM_DTMCS 0x10
/*
+ * This optional field may provide additional detail about an error
+ * that occurred when communicating with a DM. It is updated whenever
+ * {dmi-op} is updated by the hardware or when 1 is written to
+ * {dtmcs-dmireset}.
+ */
+#define DTM_DTMCS_ERRINFO_OFFSET 0x12ULL
+#define DTM_DTMCS_ERRINFO_LENGTH 3ULL
+#define DTM_DTMCS_ERRINFO 0x1c0000ULL
+/*
+ * not implemented: This field is not implemented.
+ */
+#define DTM_DTMCS_ERRINFO_NOT_IMPLEMENTED 0
+/*
+ * dmi error: There was an error between the DTM and DMI.
+ */
+#define DTM_DTMCS_ERRINFO_DMI_ERROR 1
+/*
+ * communication error: There was an error between the DMI and a DMI subordinate.
+ */
+#define DTM_DTMCS_ERRINFO_COMMUNICATION_ERROR 2
+/*
+ * device error: The DMI subordinate reported an error.
+ */
+#define DTM_DTMCS_ERRINFO_DEVICE_ERROR 3
+/*
+ * unknown: There is no error to report, or no further information available
+ * about the error. This is the reset value if the field is implemented.
+ */
+#define DTM_DTMCS_ERRINFO_UNKNOWN 4
+/*
+ * Other values are reserved for future use by this specification.
+ */
+/*
* Writing 1 to this bit does a hard reset of the DTM,
* causing the DTM to forget about any outstanding DMI transactions, and
* returning all registers and internal state to their reset value.
@@ -39,22 +72,22 @@
* complete (e.g. a reset condition caused an inflight DMI transaction to
* be cancelled).
*/
-#define DTM_DTMCS_DMIHARDRESET_OFFSET 0x11
-#define DTM_DTMCS_DMIHARDRESET_LENGTH 1
-#define DTM_DTMCS_DMIHARDRESET 0x20000
+#define DTM_DTMCS_DTMHARDRESET_OFFSET 0x11ULL
+#define DTM_DTMCS_DTMHARDRESET_LENGTH 1ULL
+#define DTM_DTMCS_DTMHARDRESET 0x20000ULL
/*
- * Writing 1 to this bit clears the sticky error state, but does
- * not affect outstanding DMI transactions.
+ * Writing 1 to this bit clears the sticky error state and resets
+ * {dtmcs-errinfo}, but does not affect outstanding DMI transactions.
*/
-#define DTM_DTMCS_DMIRESET_OFFSET 0x10
-#define DTM_DTMCS_DMIRESET_LENGTH 1
-#define DTM_DTMCS_DMIRESET 0x10000
+#define DTM_DTMCS_DMIRESET_OFFSET 0x10ULL
+#define DTM_DTMCS_DMIRESET_LENGTH 1ULL
+#define DTM_DTMCS_DMIRESET 0x10000ULL
/*
* This is a hint to the debugger of the minimum number of
* cycles a debugger should spend in
* Run-Test/Idle after every DMI scan to avoid a `busy'
- * return code (\FdtmDtmcsDmistat of 3). A debugger must still
- * check \FdtmDtmcsDmistat when necessary.
+ * return code ({dtmcs-dmistat} of 3). A debugger must still
+ * check {dtmcs-dmistat} when necessary.
*
* 0: It is not necessary to enter Run-Test/Idle at all.
*
@@ -64,24 +97,24 @@
*
* And so on.
*/
-#define DTM_DTMCS_IDLE_OFFSET 0xc
-#define DTM_DTMCS_IDLE_LENGTH 3
-#define DTM_DTMCS_IDLE 0x7000
+#define DTM_DTMCS_IDLE_OFFSET 0xcULL
+#define DTM_DTMCS_IDLE_LENGTH 3ULL
+#define DTM_DTMCS_IDLE 0x7000ULL
/*
- * Read-only alias of \FdtmDmiOp.
+ * Read-only alias of {dmi-op}.
*/
-#define DTM_DTMCS_DMISTAT_OFFSET 0xa
-#define DTM_DTMCS_DMISTAT_LENGTH 2
-#define DTM_DTMCS_DMISTAT 0xc00
+#define DTM_DTMCS_DMISTAT_OFFSET 0xaULL
+#define DTM_DTMCS_DMISTAT_LENGTH 2ULL
+#define DTM_DTMCS_DMISTAT 0xc00ULL
/*
- * The size of \FdmSbaddressZeroAddress in \RdtmDmi.
+ * The size of {sbaddress0-address} in {dtm-dmi}.
*/
-#define DTM_DTMCS_ABITS_OFFSET 4
-#define DTM_DTMCS_ABITS_LENGTH 6
-#define DTM_DTMCS_ABITS 0x3f0
-#define DTM_DTMCS_VERSION_OFFSET 0
-#define DTM_DTMCS_VERSION_LENGTH 4
-#define DTM_DTMCS_VERSION 0xf
+#define DTM_DTMCS_ABITS_OFFSET 4ULL
+#define DTM_DTMCS_ABITS_LENGTH 6ULL
+#define DTM_DTMCS_ABITS 0x3f0ULL
+#define DTM_DTMCS_VERSION_OFFSET 0ULL
+#define DTM_DTMCS_VERSION_LENGTH 4ULL
+#define DTM_DTMCS_VERSION 0xfULL
/*
* 0.11: Version described in spec version 0.11.
*/
@@ -98,48 +131,50 @@
/*
* Address used for DMI access. In Update-DR this value is used
* to access the DM over the DMI.
+ * {dmi-op} defines what this register contains after every possible
+ * operation.
*/
-#define DTM_DMI_ADDRESS_OFFSET 0x22
-#define DTM_DMI_ADDRESS_LENGTH(abits) abits
-#define DTM_DMI_ADDRESS(abits) ((0x400000000ULL * (1ULL<<abits)) + -0x400000000ULL)
+#define DTM_DMI_ADDRESS_OFFSET 0x22ULL
+#define DTM_DMI_ADDRESS_LENGTH(abits) (abits)
+#define DTM_DMI_ADDRESS(abits) ((0x400000000ULL * (1ULL << (abits))) + -0x400000000ULL)
/*
* The data to send to the DM over the DMI during Update-DR, and
* the data returned from the DM as a result of the previous operation.
*/
-#define DTM_DMI_DATA_OFFSET 2
-#define DTM_DMI_DATA_LENGTH 0x20
+#define DTM_DMI_DATA_OFFSET 2ULL
+#define DTM_DMI_DATA_LENGTH 0x20ULL
#define DTM_DMI_DATA 0x3fffffffcULL
/*
* When the debugger writes this field, it has the following meaning:
*/
-#define DTM_DMI_OP_OFFSET 0
-#define DTM_DMI_OP_LENGTH 2
-#define DTM_DMI_OP 3
+#define DTM_DMI_OP_OFFSET 0ULL
+#define DTM_DMI_OP_LENGTH 2ULL
+#define DTM_DMI_OP 3ULL
/*
- * nop: Ignore \FdmSbdataZeroData and \FdmSbaddressZeroAddress.
+ * nop: Ignore {sbdata0-data} and {sbaddress0-address}.
*
* Don't send anything over the DMI during Update-DR.
* This operation should never result in a busy or error response.
* The address and data reported in the following Capture-DR
* are undefined.
*
- * This operation leaves the values in \FdtmDmiAddress and \FdtmDmiData
- * \unspecified.
+ * This operation leaves the values in {dmi-address} and {dmi-data}
+ * UNSPECIFIED.
*/
#define DTM_DMI_OP_NOP 0
/*
- * read: Read from \FdtmDmiAddress.
+ * read: Read from {dmi-address}.
*
- * When this operation succeeds, \FdtmDmiAddress contains the address
- * that was read from, and \FdtmDmiData contains the value that was
+ * When this operation succeeds, {dmi-address} contains the address
+ * that was read from, and {dmi-data} contains the value that was
* read.
*/
#define DTM_DMI_OP_READ 1
/*
- * write: Write \FdtmDmiData to \FdtmDmiAddress.
+ * write: Write {dmi-data} to {dmi-address}.
*
- * This operation leaves the values in \FdtmDmiAddress and \FdtmDmiData
- * \unspecified.
+ * This operation leaves the values in {dmi-address} and {dmi-data}
+ * UNSPECIFIED.
*/
#define DTM_DMI_OP_WRITE 2
/*
@@ -156,30 +191,33 @@
* reserved: Reserved.
*/
/*
- * failed: A previous operation failed. The data scanned into \RdtmDmi in
+ * failed: A previous operation failed. The data scanned into {dtm-dmi} in
* this access will be ignored. This status is sticky and can be
- * cleared by writing \FdtmDtmcsDmireset in \RdtmDtmcs.
+ * cleared by writing {dtmcs-dmireset} in {dtm-dtmcs}.
*
- * This indicates that the DM itself responded with an error.
+ * This indicates that the DM itself or the DMI responded with an error.
* There are no specified cases in which the DM would
* respond with an error, and DMI is not required to support
* returning errors.
+ *
+ * If a debugger sees this status, there might be additional
+ * information in {dtmcs-errinfo}.
*/
#define DTM_DMI_OP_FAILED 2
/*
* busy: An operation was attempted while a DMI request is still in
- * progress. The data scanned into \RdtmDmi in this access will be
+ * progress. The data scanned into {dtm-dmi} in this access will be
* ignored. This status is sticky and can be cleared by writing
- * \FdtmDtmcsDmireset in \RdtmDtmcs. If a debugger sees this status, it
+ * {dtmcs-dmireset} in {dtm-dtmcs}. If a debugger sees this status, it
* needs to give the target more TCK edges between Update-DR and
* Capture-DR. The simplest way to do that is to add extra transitions
* in Run-Test/Idle.
*/
#define DTM_DMI_OP_BUSY 3
#define CSR_DCSR 0x7b0
-#define CSR_DCSR_DEBUGVER_OFFSET 0x1c
-#define CSR_DCSR_DEBUGVER_LENGTH 4
-#define CSR_DCSR_DEBUGVER 0xf0000000U
+#define CSR_DCSR_DEBUGVER_OFFSET 0x1cULL
+#define CSR_DCSR_DEBUGVER_LENGTH 4ULL
+#define CSR_DCSR_DEBUGVER 0xf0000000ULL
/*
* none: There is no debug support.
*/
@@ -193,87 +231,141 @@
* available version of this spec.
*/
#define CSR_DCSR_DEBUGVER_CUSTOM 15
-#define CSR_DCSR_EBREAKVS_OFFSET 0x11
-#define CSR_DCSR_EBREAKVS_LENGTH 1
-#define CSR_DCSR_EBREAKVS 0x20000
/*
- * exception: {\tt ebreak} instructions in VS-mode behave as described in the
+ * When {dcsr-cause} is 7, this optional field contains the value of a
+ * more specific halt reason than "other." Otherwise it contains 0.
+ */
+#define CSR_DCSR_EXTCAUSE_OFFSET 0x18ULL
+#define CSR_DCSR_EXTCAUSE_LENGTH 3ULL
+#define CSR_DCSR_EXTCAUSE 0x7000000ULL
+/*
+ * critical error: The hart entered a critical error state, as defined in the
+ * ((Smdbltrp)) extension.
+ */
+#define CSR_DCSR_EXTCAUSE_CRITICAL_ERROR 0
+/*
+ * All other values are reserved for future versions of this spec, or
+ * for use by other RISC-V extensions.
+ */
+/*
+ * This bit is part of ((Smdbltrp)) and only exists when that extension
+ * is implemented.
+ */
+#define CSR_DCSR_CETRIG_OFFSET 0x13ULL
+#define CSR_DCSR_CETRIG_LENGTH 1ULL
+#define CSR_DCSR_CETRIG 0x80000ULL
+/*
+ * disabled: A hart in a critical error state does not enter Debug Mode but
+ * instead asserts the critical-error signal to the platform.
+ */
+#define CSR_DCSR_CETRIG_DISABLED 0
+/*
+ * enabled: A hart in a critical error state enters Debug Mode instead of
+ * asserting the critical-error signal to the platform. Upon such
+ * entry into Debug Mode, the cause field is set to 7, and the
+ * extcause field is set to 0, indicating a critical error
+ * triggered the Debug Mode entry. This cause has the highest
+ * priority among all reasons for entering Debug Mode. Resuming
+ * from Debug Mode following an entry from the critical error state
+ * returns the hart to the critical error state.
+ */
+#define CSR_DCSR_CETRIG_ENABLED 1
+/*
+ * [NOTE]
+ * ====
+ * When {dcsr-cetrig} is 1, resuming from Debug Mode
+ * following an entry due to a critical error will result in an
+ * immediate re-entry into Debug Mode due to the critical error.
+ * The debugger may resume with {dcsr-cetrig} set to 0 to allow the
+ * platform defined actions on critical-error signal to occur.
+ * Other possible actions include initiating a hart or platform
+ * reset using the Debug Module reset control.
+ * ====
+ */
+#define CSR_DCSR_EBREAKVS_OFFSET 0x11ULL
+#define CSR_DCSR_EBREAKVS_LENGTH 1ULL
+#define CSR_DCSR_EBREAKVS 0x20000ULL
+/*
+ * exception: `ebreak` instructions in VS-mode behave as described in the
* Privileged Spec.
*/
#define CSR_DCSR_EBREAKVS_EXCEPTION 0
/*
- * debug mode: {\tt ebreak} instructions in VS-mode enter Debug Mode.
+ * debug mode: `ebreak` instructions in VS-mode enter Debug Mode.
*/
#define CSR_DCSR_EBREAKVS_DEBUG_MODE 1
/*
* This bit is hardwired to 0 if the hart does not support virtualization mode.
*/
-#define CSR_DCSR_EBREAKVU_OFFSET 0x10
-#define CSR_DCSR_EBREAKVU_LENGTH 1
-#define CSR_DCSR_EBREAKVU 0x10000
+#define CSR_DCSR_EBREAKVU_OFFSET 0x10ULL
+#define CSR_DCSR_EBREAKVU_LENGTH 1ULL
+#define CSR_DCSR_EBREAKVU 0x10000ULL
/*
- * exception: {\tt ebreak} instructions in VU-mode behave as described in the
+ * exception: `ebreak` instructions in VU-mode behave as described in the
* Privileged Spec.
*/
#define CSR_DCSR_EBREAKVU_EXCEPTION 0
/*
- * debug mode: {\tt ebreak} instructions in VU-mode enter Debug Mode.
+ * debug mode: `ebreak` instructions in VU-mode enter Debug Mode.
*/
#define CSR_DCSR_EBREAKVU_DEBUG_MODE 1
/*
* This bit is hardwired to 0 if the hart does not support virtualization mode.
*/
-#define CSR_DCSR_EBREAKM_OFFSET 0xf
-#define CSR_DCSR_EBREAKM_LENGTH 1
-#define CSR_DCSR_EBREAKM 0x8000
+#define CSR_DCSR_EBREAKM_OFFSET 0xfULL
+#define CSR_DCSR_EBREAKM_LENGTH 1ULL
+#define CSR_DCSR_EBREAKM 0x8000ULL
/*
- * exception: {\tt ebreak} instructions in M-mode behave as described in the
+ * exception: `ebreak` instructions in M-mode behave as described in the
* Privileged Spec.
*/
#define CSR_DCSR_EBREAKM_EXCEPTION 0
/*
- * debug mode: {\tt ebreak} instructions in M-mode enter Debug Mode.
+ * debug mode: `ebreak` instructions in M-mode enter Debug Mode.
*/
#define CSR_DCSR_EBREAKM_DEBUG_MODE 1
-#define CSR_DCSR_EBREAKS_OFFSET 0xd
-#define CSR_DCSR_EBREAKS_LENGTH 1
-#define CSR_DCSR_EBREAKS 0x2000
+#define CSR_DCSR_EBREAKS_OFFSET 0xdULL
+#define CSR_DCSR_EBREAKS_LENGTH 1ULL
+#define CSR_DCSR_EBREAKS 0x2000ULL
/*
- * exception: {\tt ebreak} instructions in S-mode behave as described in the
+ * exception: `ebreak` instructions in S-mode behave as described in the
* Privileged Spec.
*/
#define CSR_DCSR_EBREAKS_EXCEPTION 0
/*
- * debug mode: {\tt ebreak} instructions in S-mode enter Debug Mode.
+ * debug mode: `ebreak` instructions in S-mode enter Debug Mode.
*/
#define CSR_DCSR_EBREAKS_DEBUG_MODE 1
/*
* This bit is hardwired to 0 if the hart does not support S-mode.
*/
-#define CSR_DCSR_EBREAKU_OFFSET 0xc
-#define CSR_DCSR_EBREAKU_LENGTH 1
-#define CSR_DCSR_EBREAKU 0x1000
+#define CSR_DCSR_EBREAKU_OFFSET 0xcULL
+#define CSR_DCSR_EBREAKU_LENGTH 1ULL
+#define CSR_DCSR_EBREAKU 0x1000ULL
/*
- * exception: {\tt ebreak} instructions in U-mode behave as described in the
+ * exception: `ebreak` instructions in U-mode behave as described in the
* Privileged Spec.
*/
#define CSR_DCSR_EBREAKU_EXCEPTION 0
/*
- * debug mode: {\tt ebreak} instructions in U-mode enter Debug Mode.
+ * debug mode: `ebreak` instructions in U-mode enter Debug Mode.
*/
#define CSR_DCSR_EBREAKU_DEBUG_MODE 1
/*
* This bit is hardwired to 0 if the hart does not support U-mode.
*/
-#define CSR_DCSR_STEPIE_OFFSET 0xb
-#define CSR_DCSR_STEPIE_LENGTH 1
-#define CSR_DCSR_STEPIE 0x800
+#define CSR_DCSR_STEPIE_OFFSET 0xbULL
+#define CSR_DCSR_STEPIE_LENGTH 1ULL
+#define CSR_DCSR_STEPIE 0x800ULL
/*
- * interrupts disabled: Interrupts (including NMI) are disabled during single stepping.
+ * interrupts disabled: Interrupts (including NMI) are disabled during single stepping
+ * with {dcsr-step} set.
+ * This value should be supported.
*/
#define CSR_DCSR_STEPIE_INTERRUPTS_DISABLED 0
/*
- * interrupts enabled: Interrupts (including NMI) are enabled during single stepping.
+ * interrupts enabled: Interrupts (including NMI) are enabled during single stepping
+ * with {dcsr-step} set.
*/
#define CSR_DCSR_STEPIE_INTERRUPTS_ENABLED 1
/*
@@ -283,35 +375,38 @@
* The debugger must not change the value of this bit while the hart
* is running.
*/
-#define CSR_DCSR_STOPCOUNT_OFFSET 0xa
-#define CSR_DCSR_STOPCOUNT_LENGTH 1
-#define CSR_DCSR_STOPCOUNT 0x400
+#define CSR_DCSR_STOPCOUNT_OFFSET 0xaULL
+#define CSR_DCSR_STOPCOUNT_LENGTH 1ULL
+#define CSR_DCSR_STOPCOUNT 0x400ULL
/*
* normal: Increment counters as usual.
*/
#define CSR_DCSR_STOPCOUNT_NORMAL 0
/*
* freeze: Don't increment any hart-local counters while in Debug Mode or
- * on {\tt ebreak} instructions that cause entry into Debug Mode.
- * These counters include the {\tt instret} CSR. On single-hart cores
- * {\tt cycle} should be stopped, but on multi-hart cores it must keep
+ * on `ebreak` instructions that cause entry into Debug Mode.
+ * These counters include the `instret` CSR. On single-hart cores
+ * `cycle` should be stopped, but on multi-hart cores it must keep
* incrementing.
*/
#define CSR_DCSR_STOPCOUNT_FREEZE 1
/*
* An implementation may hardwire this bit to 0 or 1.
*/
-#define CSR_DCSR_STOPTIME_OFFSET 9
-#define CSR_DCSR_STOPTIME_LENGTH 1
-#define CSR_DCSR_STOPTIME 0x200
+#define CSR_DCSR_STOPTIME_OFFSET 9ULL
+#define CSR_DCSR_STOPTIME_LENGTH 1ULL
+#define CSR_DCSR_STOPTIME 0x200ULL
/*
- * normal: Increment \Rtime as usual.
+ * normal: `time` continues to reflect `mtime`.
*/
#define CSR_DCSR_STOPTIME_NORMAL 0
/*
- * freeze: Don't increment \Rtime while in Debug Mode. If all harts
- * have \FcsrDcsrStoptime=1 and are in Debug Mode then \Rmtime
- * is also allowed to stop incrementing.
+ * freeze: `time` is frozen at the time that Debug Mode was entered. When
+ * leaving Debug Mode, `time` will reflect the latest
+ * value of `mtime` again.
+ *
+ * While all harts have {dcsr-stoptime}=1 and are in Debug Mode,
+ * `mtime` is allowed to stop incrementing.
*/
#define CSR_DCSR_STOPTIME_FREEZE 1
/*
@@ -321,14 +416,14 @@
* Explains why Debug Mode was entered.
*
* When there are multiple reasons to enter Debug Mode in a single
- * cycle, hardware should set \FcsrDcsrCause to the cause with the highest
- * priority. See table~\ref{tab:dcsrcausepriority} for priorities.
+ * cycle, hardware should set {dcsr-cause} to the cause with the highest
+ * priority. See <<tab:dcsrcausepriority>> for priorities.
*/
-#define CSR_DCSR_CAUSE_OFFSET 6
-#define CSR_DCSR_CAUSE_LENGTH 3
-#define CSR_DCSR_CAUSE 0x1c0
+#define CSR_DCSR_CAUSE_OFFSET 6ULL
+#define CSR_DCSR_CAUSE_LENGTH 3ULL
+#define CSR_DCSR_CAUSE 0x1c0ULL
/*
- * ebreak: An {\tt ebreak} instruction was executed.
+ * ebreak: An `ebreak` instruction was executed.
*/
#define CSR_DCSR_CAUSE_EBREAK 1
/*
@@ -336,15 +431,15 @@
*/
#define CSR_DCSR_CAUSE_TRIGGER 2
/*
- * haltreq: The debugger requested entry to Debug Mode using \FdmDmcontrolHaltreq.
+ * haltreq: The debugger requested entry to Debug Mode using {dmcontrol-haltreq}.
*/
#define CSR_DCSR_CAUSE_HALTREQ 3
/*
- * step: The hart single stepped because \FcsrDcsrStep was set.
+ * step: The hart single stepped because {dcsr-step} was set.
*/
#define CSR_DCSR_CAUSE_STEP 4
/*
- * resethaltreq: The hart halted directly out of reset due to \Fresethaltreq. It
+ * resethaltreq: The hart halted directly out of reset due to {resethaltreq} It
* is also acceptable to report 3 when this happens.
*/
#define CSR_DCSR_CAUSE_RESETHALTREQ 5
@@ -354,28 +449,29 @@
*/
#define CSR_DCSR_CAUSE_GROUP 6
/*
- * Other values are reserved for future use.
+ * other: The hart halted for a reason other than the ones mentioned above.
+ * {dcsr-extcause} may contain a more specific reason.
*/
+#define CSR_DCSR_CAUSE_OTHER 7
/*
* Extends the prv field with the virtualization mode the hart was operating
- * in when Debug Mode was entered. The encoding is described in Table
- * \ref{tab:privmode}.
+ * in when Debug Mode was entered. The encoding is described in <<tab:privmode>>.
* A debugger can change this value to change the hart's virtualization mode
* when exiting Debug Mode.
* This bit is hardwired to 0 on harts that do not support virtualization mode.
*/
-#define CSR_DCSR_V_OFFSET 5
-#define CSR_DCSR_V_LENGTH 1
-#define CSR_DCSR_V 0x20
-#define CSR_DCSR_MPRVEN_OFFSET 4
-#define CSR_DCSR_MPRVEN_LENGTH 1
-#define CSR_DCSR_MPRVEN 0x10
+#define CSR_DCSR_V_OFFSET 5ULL
+#define CSR_DCSR_V_LENGTH 1ULL
+#define CSR_DCSR_V 0x20ULL
+#define CSR_DCSR_MPRVEN_OFFSET 4ULL
+#define CSR_DCSR_MPRVEN_LENGTH 1ULL
+#define CSR_DCSR_MPRVEN 0x10ULL
/*
- * disabled: \FcsrMstatusMprv in \Rmstatus is ignored in Debug Mode.
+ * disabled: `mprv` in `mstatus` is ignored in Debug Mode.
*/
#define CSR_DCSR_MPRVEN_DISABLED 0
/*
- * enabled: \FcsrMstatusMprv in \Rmstatus takes effect in Debug Mode.
+ * enabled: `mprv` in `mstatus` takes effect in Debug Mode.
*/
#define CSR_DCSR_MPRVEN_ENABLED 1
/*
@@ -388,49 +484,54 @@
* reliable debugging may no longer be possible once this bit becomes set.
* This is implementation-dependent.
*/
-#define CSR_DCSR_NMIP_OFFSET 3
-#define CSR_DCSR_NMIP_LENGTH 1
-#define CSR_DCSR_NMIP 8
+#define CSR_DCSR_NMIP_OFFSET 3ULL
+#define CSR_DCSR_NMIP_LENGTH 1ULL
+#define CSR_DCSR_NMIP 8ULL
/*
* When set and not in Debug Mode, the hart will only execute a single
- * instruction and then enter Debug Mode. See Section~\ref{stepBit}
+ * instruction and then enter Debug Mode. See xref:stepbit[]
* for details.
*
* The debugger must not change the value of this bit while the hart
* is running.
*/
-#define CSR_DCSR_STEP_OFFSET 2
-#define CSR_DCSR_STEP_LENGTH 1
-#define CSR_DCSR_STEP 4
+#define CSR_DCSR_STEP_OFFSET 2ULL
+#define CSR_DCSR_STEP_LENGTH 1ULL
+#define CSR_DCSR_STEP 4ULL
/*
* Contains the privilege mode the hart was operating in when Debug
- * Mode was entered. The encoding is described in Table
- * \ref{tab:privmode}. A debugger can change this value to change
+ * Mode was entered. The encoding is described in <<tab:privmode>>. A debugger can change this value to change
* the hart's privilege mode when exiting Debug Mode.
*
* Not all privilege modes are supported on all harts. If the
* encoding written is not supported or the debugger is not allowed to
* change to it, the hart may change to any supported privilege mode.
*/
-#define CSR_DCSR_PRV_OFFSET 0
-#define CSR_DCSR_PRV_LENGTH 2
-#define CSR_DCSR_PRV 3
+#define CSR_DCSR_PRV_OFFSET 0ULL
+#define CSR_DCSR_PRV_LENGTH 2ULL
+#define CSR_DCSR_PRV 3ULL
#define CSR_DPC 0x7b1
-#define CSR_DPC_DPC_OFFSET 0
-#define CSR_DPC_DPC_LENGTH(DXLEN) DXLEN
-#define CSR_DPC_DPC(DXLEN) ((1ULL<<DXLEN) + -1)
+#define CSR_DPC_DPC_OFFSET 0ULL
+#define CSR_DPC_DPC_LENGTH(DXLEN) (DXLEN)
+#define CSR_DPC_DPC(DXLEN) ((1ULL << (DXLEN)) + -1ULL)
#define CSR_DSCRATCH0 0x7b2
+#define CSR_DSCRATCH0_DSCRATCH0_OFFSET 0ULL
+#define CSR_DSCRATCH0_DSCRATCH0_LENGTH(DXLEN) (DXLEN)
+#define CSR_DSCRATCH0_DSCRATCH0(DXLEN) ((1ULL << (DXLEN)) + -1ULL)
#define CSR_DSCRATCH1 0x7b3
+#define CSR_DSCRATCH1_DSCRATCH1_OFFSET 0ULL
+#define CSR_DSCRATCH1_DSCRATCH1_LENGTH(DXLEN) (DXLEN)
+#define CSR_DSCRATCH1_DSCRATCH1(DXLEN) ((1ULL << (DXLEN)) + -1ULL)
#define CSR_TSELECT 0x7a0
-#define CSR_TSELECT_INDEX_OFFSET 0
-#define CSR_TSELECT_INDEX_LENGTH(XLEN) XLEN
-#define CSR_TSELECT_INDEX(XLEN) ((1ULL<<XLEN) + -1)
+#define CSR_TSELECT_INDEX_OFFSET 0ULL
+#define CSR_TSELECT_INDEX_LENGTH(XLEN) (XLEN)
+#define CSR_TSELECT_INDEX(XLEN) ((1ULL << (XLEN)) + -1ULL)
#define CSR_TDATA1 0x7a1
-#define CSR_TDATA1_TYPE_OFFSET(XLEN) (XLEN + -4)
-#define CSR_TDATA1_TYPE_LENGTH 4
-#define CSR_TDATA1_TYPE(XLEN) (0xf * (1ULL<<(XLEN + -4)))
+#define CSR_TDATA1_TYPE_OFFSET(XLEN) ((XLEN) + -4ULL)
+#define CSR_TDATA1_TYPE_LENGTH 4ULL
+#define CSR_TDATA1_TYPE(XLEN) (0xfULL * (1ULL << ((XLEN) + -4ULL)))
/*
- * none: There is no trigger at this \RcsrTselect.
+ * none: There is no trigger at this {csr-tselect}.
*/
#define CSR_TDATA1_TYPE_NONE 0
/*
@@ -440,34 +541,34 @@
#define CSR_TDATA1_TYPE_LEGACY 1
/*
* mcontrol: The trigger is an address/data match trigger. The remaining bits
- * in this register act as described in \RcsrMcontrol.
+ * in this register act as described in {csr-mcontrol}.
*/
#define CSR_TDATA1_TYPE_MCONTROL 2
/*
* icount: The trigger is an instruction count trigger. The remaining bits
- * in this register act as described in \RcsrIcount.
+ * in this register act as described in {csr-icount}.
*/
#define CSR_TDATA1_TYPE_ICOUNT 3
/*
* itrigger: The trigger is an interrupt trigger. The remaining bits
- * in this register act as described in \RcsrItrigger.
+ * in this register act as described in {csr-itrigger}.
*/
#define CSR_TDATA1_TYPE_ITRIGGER 4
/*
* etrigger: The trigger is an exception trigger. The remaining bits
- * in this register act as described in \RcsrEtrigger.
+ * in this register act as described in {csr-etrigger}.
*/
#define CSR_TDATA1_TYPE_ETRIGGER 5
/*
* mcontrol6: The trigger is an address/data match trigger. The remaining bits
- * in this register act as described in \RcsrMcontrolSix. This is similar
+ * in this register act as described in {csr-mcontrol6}. This is similar
* to a type 2 trigger, but provides additional functionality and
* should be used instead of type 2 in newer implementations.
*/
#define CSR_TDATA1_TYPE_MCONTROL6 6
/*
* tmexttrigger: The trigger is a trigger source external to the TM. The
- * remaining bits in this register act as described in \RcsrTmexttrigger.
+ * remaining bits in this register act as described in {csr-tmexttrigger}.
*/
#define CSR_TDATA1_TYPE_TMEXTTRIGGER 7
/*
@@ -476,29 +577,30 @@
#define CSR_TDATA1_TYPE_CUSTOM_LOW 12
#define CSR_TDATA1_TYPE_CUSTOM_HIGH 14
/*
- * disabled: This trigger is disabled. In this state, \RcsrTdataTwo and
- * \RcsrTdataThree can be written with any value that is supported for
- * any of the types this trigger implements. The remaining bits in this
- * register are ignored.
+ * disabled: This trigger is disabled. In this state, {csr-tdata2} and
+ * {csr-tdata3} can be written with any value that is supported for
+ * any of the types this trigger implements.
+ * The remaining bits in this register, except for {tdata1-dmode},
+ * are ignored.
*/
#define CSR_TDATA1_TYPE_DISABLED 15
/*
* Other values are reserved for future use.
*/
/*
- * If \FcsrTdataOneType is 0, then this bit is hard-wired to 0.
+ * If {tdata1-type} is 0, then this bit is hard-wired to 0.
*/
-#define CSR_TDATA1_DMODE_OFFSET(XLEN) (XLEN + -5)
-#define CSR_TDATA1_DMODE_LENGTH 1
-#define CSR_TDATA1_DMODE(XLEN) (1ULL<<(XLEN + -5))
+#define CSR_TDATA1_DMODE_OFFSET(XLEN) ((XLEN) + -5ULL)
+#define CSR_TDATA1_DMODE_LENGTH 1ULL
+#define CSR_TDATA1_DMODE(XLEN) (1ULL << ((XLEN) + -5ULL))
/*
- * both: Both Debug and M-mode can write the {\tt tdata} registers at the
- * selected \RcsrTselect.
+ * both: Both Debug and M-mode can write the `tdata` registers at the
+ * selected {csr-tselect}.
*/
#define CSR_TDATA1_DMODE_BOTH 0
/*
- * dmode: Only Debug Mode can write the {\tt tdata} registers at the
- * selected \RcsrTselect. Writes from other modes are ignored.
+ * dmode: Only Debug Mode can write the `tdata` registers at the
+ * selected {csr-tselect}. Writes from other modes are ignored.
*/
#define CSR_TDATA1_DMODE_DMODE 1
/*
@@ -506,57 +608,80 @@
* In ordinary use, external debuggers will always set this bit when
* configuring a trigger.
* When clearing this bit, debuggers should also set the action field
- * (whose location depends on \FcsrTdataOneType) to something other
+ * (whose location depends on {tdata1-type}) to something other
* than 1.
*/
/*
- * If \FcsrTdataOneType is 0, then this field is hard-wired to 0.
+ * If {tdata1-type} is 0, then this field is hard-wired to 0.
*
* Trigger-specific data.
*/
-#define CSR_TDATA1_DATA_OFFSET 0
-#define CSR_TDATA1_DATA_LENGTH(XLEN) (XLEN + -5)
-#define CSR_TDATA1_DATA(XLEN) ((1ULL<<(XLEN + -5)) + -1)
+#define CSR_TDATA1_DATA_OFFSET 0ULL
+#define CSR_TDATA1_DATA_LENGTH(XLEN) ((XLEN) + -5ULL)
+#define CSR_TDATA1_DATA(XLEN) ((1ULL << ((XLEN) + -5ULL)) + -1ULL)
#define CSR_TDATA2 0x7a2
-#define CSR_TDATA2_DATA_OFFSET 0
-#define CSR_TDATA2_DATA_LENGTH(XLEN) XLEN
-#define CSR_TDATA2_DATA(XLEN) ((1ULL<<XLEN) + -1)
+#define CSR_TDATA2_DATA_OFFSET 0ULL
+#define CSR_TDATA2_DATA_LENGTH(XLEN) (XLEN)
+#define CSR_TDATA2_DATA(XLEN) ((1ULL << (XLEN)) + -1ULL)
#define CSR_TDATA3 0x7a3
-#define CSR_TDATA3_DATA_OFFSET 0
-#define CSR_TDATA3_DATA_LENGTH(XLEN) XLEN
-#define CSR_TDATA3_DATA(XLEN) ((1ULL<<XLEN) + -1)
+#define CSR_TDATA3_DATA_OFFSET 0ULL
+#define CSR_TDATA3_DATA_LENGTH(XLEN) (XLEN)
+#define CSR_TDATA3_DATA(XLEN) ((1ULL << (XLEN)) + -1ULL)
#define CSR_TINFO 0x7a4
/*
- * One bit for each possible \FcsrTdataOneType enumerated in \RcsrTdataOne. Bit N
+ * Contains the version of the Sdtrig extension implemented.
+ */
+#define CSR_TINFO_VERSION_OFFSET 0x18ULL
+#define CSR_TINFO_VERSION_LENGTH 8ULL
+#define CSR_TINFO_VERSION 0xff000000ULL
+/*
+ * 0: Supports triggers as described in this spec at commit 5a5c078,
+ * made on February 2, 2023.
+ *
+ * In these older versions:
+ *
+ * . {csr-mcontrol6} has a timing bit identical to {mcontrol-timing}
+ * . {mcontrol6-hit0} behaves just as {mcontrol-hit}.
+ * . {mcontrol6-hit1} is read-only 0.
+ * . Encodings for {mcontrol6-size} for access sizes larger than 64 bits are different.
+ */
+#define CSR_TINFO_VERSION_0 0
+/*
+ * 1: Supports triggers as described in the ratified version 1.0 of
+ * this document.
+ */
+#define CSR_TINFO_VERSION_1 1
+/*
+ * One bit for each possible {tdata1-type} enumerated in {csr-tdata1}. Bit N
* corresponds to type N. If the bit is set, then that type is
* supported by the currently selected trigger.
*
* If the currently selected trigger doesn't exist, this field
* contains 1.
*/
-#define CSR_TINFO_INFO_OFFSET 0
-#define CSR_TINFO_INFO_LENGTH 0x10
-#define CSR_TINFO_INFO 0xffff
+#define CSR_TINFO_INFO_OFFSET 0ULL
+#define CSR_TINFO_INFO_LENGTH 0x10ULL
+#define CSR_TINFO_INFO 0xffffULL
#define CSR_TCONTROL 0x7a5
/*
* M-mode previous trigger enable field.
*
- * \FcsrTcontrolMpte and \FcsrTcontrolMte provide one solution to a problem
+ * {tcontrol-mpte} and {tcontrol-mte} provide one solution to a problem
* regarding triggers with action=0 firing in M-mode trap handlers. See
- * Section~\ref{sec:nativetrigger} for more details.
+ * xref:nativetrigger[] for more details.
*
- * When a breakpoint trap into M-mode is taken, \FcsrTcontrolMpte is set to the value of
- * \FcsrTcontrolMte.
+ * When any trap into M-mode is taken, {tcontrol-mpte} is set to the value of
+ * {tcontrol-mte}.
*/
-#define CSR_TCONTROL_MPTE_OFFSET 7
-#define CSR_TCONTROL_MPTE_LENGTH 1
-#define CSR_TCONTROL_MPTE 0x80
+#define CSR_TCONTROL_MPTE_OFFSET 7ULL
+#define CSR_TCONTROL_MPTE_LENGTH 1ULL
+#define CSR_TCONTROL_MPTE 0x80ULL
/*
* M-mode trigger enable field.
*/
-#define CSR_TCONTROL_MTE_OFFSET 3
-#define CSR_TCONTROL_MTE_LENGTH 1
-#define CSR_TCONTROL_MTE 8
+#define CSR_TCONTROL_MTE_OFFSET 3ULL
+#define CSR_TCONTROL_MTE_LENGTH 1ULL
+#define CSR_TCONTROL_MTE 8ULL
/*
* disabled: Triggers with action=0 do not match/fire while the hart is in M-mode.
*/
@@ -566,25 +691,9 @@
*/
#define CSR_TCONTROL_MTE_ENABLED 1
/*
- * When a breakpoint trap into M-mode is taken, \FcsrTcontrolMte is set to 0. When {\tt
- * mret} is executed, \FcsrTcontrolMte is set to the value of \FcsrTcontrolMpte.
+ * When any trap into M-mode is taken, {tcontrol-mte} is set to 0. When `mret` is executed, {tcontrol-mte} is set to the value of {tcontrol-mpte}.
*/
#define CSR_HCONTEXT 0x6a8
-/*
- * Hypervisor mode software can write a context number to this register,
- * which can be used to set triggers that only fire in that specific
- * context.
- *
- * An implementation may tie any number of upper bits in this field to
- * 0. If the H extension is not implemented, it's recommended to implement
- * no more than 6 bits on RV32 and 13 on RV64 (as visible through the
- * \RcsrMcontext register). If the H extension is implemented,
- * it's recommended to implement no more than 7 bits on RV32
- * and 14 on RV64.
- */
-#define CSR_HCONTEXT_HCONTEXT_OFFSET 0
-#define CSR_HCONTEXT_HCONTEXT_LENGTH(XLEN) XLEN
-#define CSR_HCONTEXT_HCONTEXT(XLEN) ((1ULL<<XLEN) + -1)
#define CSR_SCONTEXT 0x5a8
/*
* Supervisor mode software can write a context number to this
@@ -592,41 +701,56 @@
* specific context.
*
* An implementation may tie any number of high bits in this field to
- * 0. It's recommended to implement no more than 16 bits on RV32, and
- * 34 on RV64.
+ * 0. It's recommended to implement 16 bits on RV32 and 32 bits on
+ * RV64.
*/
-#define CSR_SCONTEXT_DATA_OFFSET 0
-#define CSR_SCONTEXT_DATA_LENGTH(XLEN) XLEN
-#define CSR_SCONTEXT_DATA(XLEN) ((1ULL<<XLEN) + -1)
+#define CSR_SCONTEXT_DATA_OFFSET 0ULL
+#define CSR_SCONTEXT_DATA_LENGTH 0x20ULL
+#define CSR_SCONTEXT_DATA 0xffffffffULL
#define CSR_MCONTEXT 0x7a8
+/*
+ * M-Mode or HS-Mode (using {csr-hcontext}) software can write a context
+ * number to this register, which can be used to set triggers that only
+ * fire in that specific context.
+ *
+ * An implementation may tie any number of upper bits in this field to
+ * 0. If the H extension is not implemented, it's recommended to implement
+ * 6 bits on RV32 and 13 bits on RV64 (as visible through the
+ * {csr-mcontext} register). If the H extension is implemented,
+ * it's recommended to implement 7 bits on RV32
+ * and 14 bits on RV64.
+ */
+#define CSR_MCONTEXT_HCONTEXT_OFFSET 0ULL
+#define CSR_MCONTEXT_HCONTEXT_LENGTH 0xeULL
+#define CSR_MCONTEXT_HCONTEXT 0x3fffULL
#define CSR_MSCONTEXT 0x7aa
#define CSR_MCONTROL 0x7a1
-#define CSR_MCONTROL_TYPE_OFFSET(XLEN) (XLEN + -4)
-#define CSR_MCONTROL_TYPE_LENGTH 4
-#define CSR_MCONTROL_TYPE(XLEN) (0xf * (1ULL<<(XLEN + -4)))
-#define CSR_MCONTROL_DMODE_OFFSET(XLEN) (XLEN + -5)
-#define CSR_MCONTROL_DMODE_LENGTH 1
-#define CSR_MCONTROL_DMODE(XLEN) (1ULL<<(XLEN + -5))
+#define CSR_MCONTROL_TYPE_OFFSET(XLEN) ((XLEN) + -4ULL)
+#define CSR_MCONTROL_TYPE_LENGTH 4ULL
+#define CSR_MCONTROL_TYPE(XLEN) (0xfULL * (1ULL << ((XLEN) + -4ULL)))
+#define CSR_MCONTROL_DMODE_OFFSET(XLEN) ((XLEN) + -5ULL)
+#define CSR_MCONTROL_DMODE_LENGTH 1ULL
+#define CSR_MCONTROL_DMODE(XLEN) (1ULL << ((XLEN) + -5ULL))
/*
* Specifies the largest naturally aligned powers-of-two (NAPOT) range
- * supported by the hardware when \FcsrMcontrolMatch is 1. The value is the
+ * supported by the hardware when {mcontrol-match} is 1. The value is the
* logarithm base 2 of the number of bytes in that range.
- * A value of 0 indicates \FcsrMcontrolMatch 1 is not supported.
+ * A value of 0 indicates {mcontrol-match} 1 is not supported.
* A value of 63 corresponds to the maximum NAPOT range, which is
- * $2^{63}$ bytes in size.
+ * 2^63^ bytes in size.
*/
-#define CSR_MCONTROL_MASKMAX_OFFSET(XLEN) (XLEN + -0xb)
-#define CSR_MCONTROL_MASKMAX_LENGTH 6
-#define CSR_MCONTROL_MASKMAX(XLEN) (0x3f * (1ULL<<(XLEN + -0xb)))
+#define CSR_MCONTROL_MASKMAX_OFFSET(XLEN) ((XLEN) + -0xbULL)
+#define CSR_MCONTROL_MASKMAX_LENGTH 6ULL
+#define CSR_MCONTROL_MASKMAX(XLEN) (0x3fULL * (1ULL << ((XLEN) + -0xbULL)))
/*
* This field only exists when XLEN is at least 64.
* It contains the 2 high bits of the access size. The low bits
- * come from \FcsrMcontrolSizelo. See \FcsrMcontrolSizelo for how this
+ * come from {mcontrol-sizelo}. See {mcontrol-sizelo} for how this
* is used.
*/
-#define CSR_MCONTROL_SIZEHI_OFFSET 0x15
-#define CSR_MCONTROL_SIZEHI_LENGTH 2
-#define CSR_MCONTROL_SIZEHI 0x600000
+#define CSR_MCONTROL_SIZEHI_OFFSET 0x15ULL
+#define CSR_MCONTROL_SIZEHI_LENGTH 2ULL
+#define CSR_MCONTROL_SIZEHI 0x600000ULL
/*
* If this bit is implemented then it must become set when this
* trigger fires and may become set when this trigger matches.
@@ -635,15 +759,15 @@
* trigger(s) matched. If the bit is not implemented, it is always 0
* and writing it has no effect.
*/
-#define CSR_MCONTROL_HIT_OFFSET 0x14
-#define CSR_MCONTROL_HIT_LENGTH 1
-#define CSR_MCONTROL_HIT 0x100000
+#define CSR_MCONTROL_HIT_OFFSET 0x14ULL
+#define CSR_MCONTROL_HIT_LENGTH 1ULL
+#define CSR_MCONTROL_HIT 0x100000ULL
/*
* This bit determines the contents of the XLEN-bit compare values.
*/
-#define CSR_MCONTROL_SELECT_OFFSET 0x13
-#define CSR_MCONTROL_SELECT_LENGTH 1
-#define CSR_MCONTROL_SELECT 0x80000
+#define CSR_MCONTROL_SELECT_OFFSET 0x13ULL
+#define CSR_MCONTROL_SELECT_LENGTH 1ULL
+#define CSR_MCONTROL_SELECT 0x80000ULL
/*
* address: There is at least one compare value and it contains the lowest
* virtual address of the access.
@@ -659,61 +783,65 @@
* Any bits beyond the size of the data access will contain 0.
*/
#define CSR_MCONTROL_SELECT_DATA 1
-#define CSR_MCONTROL_TIMING_OFFSET 0x12
-#define CSR_MCONTROL_TIMING_LENGTH 1
-#define CSR_MCONTROL_TIMING 0x40000
+#define CSR_MCONTROL_TIMING_OFFSET 0x12ULL
+#define CSR_MCONTROL_TIMING_LENGTH 1ULL
+#define CSR_MCONTROL_TIMING 0x40000ULL
/*
* before: The action for this trigger will be taken just before the
- * instruction that triggered it is committed, but after all preceding
- * instructions are committed. \Rxepc or \RcsrDpc (depending
- * on \FcsrMcontrolAction) must be set to the virtual address of the
+ * instruction that triggered it is retired, but after all preceding
+ * instructions are retired. `xepc` or {csr-dpc} (depending
+ * on {mcontrol-action}) must be set to the virtual address of the
* instruction that matched.
*
- * If this is combined with \FcsrMcontrolLoad and
- * \FcsrMcontrolSelect=1 then a memory access will be
+ * If this is combined with {mcontrol-load} and
+ * {mcontrol-select}=1 then a memory access will be
* performed (including any side effects of performing such an access) even
* though the load will not update its destination register. Debuggers
* should consider this when setting such breakpoints on, for example,
* memory-mapped I/O addresses.
+ *
+ * If an instruction matches this trigger and the instruction performs
+ * multiple memory accesses, it is UNSPECIFIED which memory accesses
+ * have completed before the trigger fires.
*/
#define CSR_MCONTROL_TIMING_BEFORE 0
/*
* after: The action for this trigger will be taken after the instruction
- * that triggered it is committed. It should be taken before the next
- * instruction is committed, but it is better to implement triggers imprecisely
- * than to not implement them at all. \Rxepc or
- * \RcsrDpc (depending on \FcsrMcontrolAction) must be set to
+ * that triggered it is retired. It should be taken before the next
+ * instruction is retired, but it is better to implement triggers imprecisely
+ * than to not implement them at all. `xepc` or
+ * {csr-dpc} (depending on {mcontrol-action}) must be set to
* the virtual address of the next instruction that must be executed to
* preserve the program flow.
*/
#define CSR_MCONTROL_TIMING_AFTER 1
/*
* Most hardware will only implement one timing or the other, possibly
- * dependent on \FcsrMcontrolSelect, \FcsrMcontrolExecute,
- * \FcsrMcontrolLoad, and \FcsrMcontrolStore. This bit
+ * dependent on {mcontrol-select}, {mcontrol-execute},
+ * {mcontrol-load}, and {mcontrol-store}. This bit
* primarily exists for the hardware to communicate to the debugger
* what will happen. Hardware may implement the bit fully writable, in
* which case the debugger has a little more control.
*
- * Data load triggers with \FcsrMcontrolTiming of 0 will result in the same load
+ * Data load triggers with {mcontrol-timing} of 0 will result in the same load
* happening again when the debugger lets the hart run. For data load
* triggers, debuggers must first attempt to set the breakpoint with
- * \FcsrMcontrolTiming of 1.
+ * {mcontrol-timing} of 1.
*
- * If a trigger with \FcsrMcontrolTiming of 0 matches, it is
+ * If a trigger with {mcontrol-timing} of 0 matches, it is
* implementation-dependent whether that prevents a trigger with
- * \FcsrMcontrolTiming of 1 matching as well.
+ * {mcontrol-timing} of 1 matching as well.
*/
/*
* This field contains the 2 low bits of the access size. The high bits come
- * from \FcsrMcontrolSizehi. The combined value is interpreted as follows:
+ * from {mcontrol-sizehi}. The combined value is interpreted as follows:
*/
-#define CSR_MCONTROL_SIZELO_OFFSET 0x10
-#define CSR_MCONTROL_SIZELO_LENGTH 2
-#define CSR_MCONTROL_SIZELO 0x30000
+#define CSR_MCONTROL_SIZELO_OFFSET 0x10ULL
+#define CSR_MCONTROL_SIZELO_LENGTH 2ULL
+#define CSR_MCONTROL_SIZELO 0x30000ULL
/*
* any: The trigger will attempt to match against an access of any size.
- * The behavior is only well-defined if $|select|=0$, or if the access
+ * The behavior is only well-defined if {mcontrol-select}=0, or if the access
* size is XLEN.
*/
#define CSR_MCONTROL_SIZELO_ANY 0
@@ -760,28 +888,28 @@
/*
* An implementation must support the value of 0, but all other values
* are optional. When an implementation supports address triggers
- * (\FcsrMcontrolSelect=0), it is recommended that those triggers
+ * ({mcontrol-select}=0), it is recommended that those triggers
* support every access size that the hart supports, as well as for
* every instruction size that the hart supports.
*
* Implementations such as RV32D or RV64V are able to perform loads
* and stores that are wider than XLEN. Custom extensions may also
* support instructions that are wider than XLEN. Because
- * \RcsrTdataTwo is of size XLEN, there is a known limitation that
- * data value triggers (\FcsrMcontrolSelect=1) can only be supported
+ * {csr-tdata2} is of size XLEN, there is a known limitation that
+ * data value triggers ({mcontrol-select}=1) can only be supported
* for access sizes up to XLEN bits. When an implementation supports
- * data value triggers (\FcsrMcontrolSelect=1), it is recommended
+ * data value triggers ({mcontrol-select}=1), it is recommended
* that those triggers support every access size up to XLEN that the
* hart supports, as well as for every instruction length up to XLEN
* that the hart supports.
*/
/*
* The action to take when the trigger fires. The values are explained
- * in Table~\ref{tab:action}.
+ * in xref:tab:action[].
*/
-#define CSR_MCONTROL_ACTION_OFFSET 0xc
-#define CSR_MCONTROL_ACTION_LENGTH 4
-#define CSR_MCONTROL_ACTION 0xf000
+#define CSR_MCONTROL_ACTION_OFFSET 0xcULL
+#define CSR_MCONTROL_ACTION_LENGTH 4ULL
+#define CSR_MCONTROL_ACTION 0xf000ULL
/*
* breakpoint:
*/
@@ -810,9 +938,9 @@
* external1:
*/
#define CSR_MCONTROL_ACTION_EXTERNAL1 9
-#define CSR_MCONTROL_CHAIN_OFFSET 0xb
-#define CSR_MCONTROL_CHAIN_LENGTH 1
-#define CSR_MCONTROL_CHAIN 0x800
+#define CSR_MCONTROL_CHAIN_OFFSET 0xbULL
+#define CSR_MCONTROL_CHAIN_LENGTH 1ULL
+#define CSR_MCONTROL_CHAIN 0x800ULL
/*
* disabled: When this trigger matches, the configured action is taken.
*/
@@ -823,10 +951,10 @@
*/
#define CSR_MCONTROL_CHAIN_ENABLED 1
/*
- * A trigger chain starts on the first trigger with $|chain|=1$ after
- * a trigger with $|chain|=0$, or simply on the first trigger if that
- * has $|chain|=1$. It ends on the first trigger after that which has
- * $|chain|=0$. This final trigger is part of the chain. The action
+ * A trigger chain starts on the first trigger with `chain`=1 after
+ * a trigger with `chain`=0, or simply on the first trigger if that
+ * has `chain`=1. It ends on the first trigger after that which has
+ * `chain`=0. This final trigger is part of the chain. The action
* on all but the final trigger is ignored. The action on that final
* trigger will be taken if and only if all the triggers in the chain
* match at the same time.
@@ -834,167 +962,223 @@
* Debuggers should not terminate a chain with a trigger with a
* different type. It is undefined when exactly such a chain fires.
*
- * Because \FcsrMcontrolChain affects the next trigger, hardware must zero it in
- * writes to \RcsrMcontrol that set \FcsrTdataOneDmode to 0 if the next trigger has
- * \FcsrTdataOneDmode of 1.
- * In addition hardware should ignore writes to \RcsrMcontrol that set
- * \FcsrTdataOneDmode to 1 if the previous trigger has both \FcsrTdataOneDmode of 0 and
- * \FcsrMcontrolChain of 1. Debuggers must avoid the latter case by checking
- * \FcsrMcontrolChain on the previous trigger if they're writing \RcsrMcontrol.
+ * Because {mcontrol-chain} affects the next trigger, hardware must zero it in
+ * writes to {csr-mcontrol} that set {tdata1-dmode} to 0 if the next trigger has
+ * {tdata1-dmode} of 1.
+ * In addition hardware should ignore writes to {csr-mcontrol} that set
+ * {tdata1-dmode} to 1 if the previous trigger has both {tdata1-dmode} of 0 and
+ * {mcontrol-chain} of 1. Debuggers must avoid the latter case by checking
+ * {mcontrol-chain} on the previous trigger if they're writing {csr-mcontrol}.
*
* Implementations that wish to limit the maximum length of a trigger
* chain (eg. to meet timing requirements) may do so by zeroing
- * \FcsrMcontrolChain in writes to \RcsrMcontrol that would make the chain too long.
+ * {mcontrol-chain} in writes to {csr-mcontrol} that would make the chain too long.
*/
-#define CSR_MCONTROL_MATCH_OFFSET 7
-#define CSR_MCONTROL_MATCH_LENGTH 4
-#define CSR_MCONTROL_MATCH 0x780
+#define CSR_MCONTROL_MATCH_OFFSET 7ULL
+#define CSR_MCONTROL_MATCH_LENGTH 4ULL
+#define CSR_MCONTROL_MATCH 0x780ULL
/*
- * equal: Matches when any compare value equals \RcsrTdataTwo.
+ * equal: Matches when any compare value equals {csr-tdata2}.
*/
#define CSR_MCONTROL_MATCH_EQUAL 0
/*
- * napot: Matches when the top $M$ bits of any compare value match the top
- * $M$ bits of \RcsrTdataTwo.
- * $M$ is $|XLEN|-1$ minus the index of the least-significant
- * bit containing 0 in \RcsrTdataTwo. Debuggers should only write values
- * to \RcsrTdataTwo such that $M + $\FcsrMcontrolMaskmax$ \geq |XLEN|$
- * and $M\gt0$ , otherwise it's undefined on what conditions the
+ * napot: Matches when the top `M` bits of any compare value match the top
+ * `M` bits of {csr-tdata2}.
+ * `M` is `XLEN-1` minus the index of the least-significant
+ * bit containing 0 in {csr-tdata2}. Debuggers should only write values
+ * to {csr-tdata2} such that `M` + {mcontrol-maskmax} ≥ `XLEN`
+ * and `M` > 0, otherwise it's undefined on what conditions the
* trigger will match.
*/
#define CSR_MCONTROL_MATCH_NAPOT 1
/*
* ge: Matches when any compare value is greater than (unsigned) or
- * equal to \RcsrTdataTwo.
+ * equal to {csr-tdata2}.
*/
#define CSR_MCONTROL_MATCH_GE 2
/*
* lt: Matches when any compare value is less than (unsigned)
- * \RcsrTdataTwo.
+ * {csr-tdata2}.
*/
#define CSR_MCONTROL_MATCH_LT 3
/*
- * mask low: Matches when $\frac{|XLEN|}{2}-1$:$0$ of any compare value
- * equals $\frac{|XLEN|}{2}-1$:$0$ of \RcsrTdataTwo after
- * $\frac{|XLEN|}{2}-1$:$0$ of the compare value is ANDed with
- * $|XLEN|-1$:$\frac{|XLEN|}{2}$ of \RcsrTdataTwo.
+ * mask low: Matches when latexmath:[$\frac{XLEN}{2}-{1:0}] of any compare value
+ * equals latexmath:[$\frac{XLEN}{2}-{1:0}] of {csr-tdata2} after
+ * latexmath:[$\frac{XLEN}{2}-{1:0}] of the compare value is ANDed with
+ * `XLEN-1`:latexmath:[$\frac{XLEN}{2}$] of {csr-tdata2}.
*/
#define CSR_MCONTROL_MATCH_MASK_LOW 4
/*
- * mask high: Matches when $|XLEN|-1$:$\frac{|XLEN|}{2}$ of any compare
- * value equals $\frac{|XLEN|}{2}-1$:$0$ of \RcsrTdataTwo after
- * $|XLEN|-1$:$\frac{|XLEN|}{2}$ of the compare value is ANDed with
- * $|XLEN|-1$:$\frac{|XLEN|}{2}$ of \RcsrTdataTwo.
+ * mask high: Matches when `XLEN-1`:latexmath:[$\frac{XLEN}{2}$] of any compare
+ * value equals latexmath:[$\frac{XLEN}{2}-{1:0}] of {csr-tdata2} after
+ * `XLEN-1`:latexmath:[$\frac{XLEN}{2}$] of the compare value is ANDed with
+ * `XLEN-1`:latexmath:[$\frac{XLEN}{2}$] of {csr-tdata2}.
*/
#define CSR_MCONTROL_MATCH_MASK_HIGH 5
/*
- * not equal: Matches when \FcsrMcontrolMatch$=0$ would not match.
+ * not equal: Matches when {mcontrol-match}=0 would not match.
*/
#define CSR_MCONTROL_MATCH_NOT_EQUAL 8
/*
- * not napot: Matches when \FcsrMcontrolMatch$=1$ would not match.
+ * not napot: Matches when {mcontrol-match}=1 would not match.
*/
#define CSR_MCONTROL_MATCH_NOT_NAPOT 9
/*
- * not mask low: Matches when \FcsrMcontrolMatch$=4$ would not match.
+ * not mask low: Matches when {mcontrol-match}=4 would not match.
*/
#define CSR_MCONTROL_MATCH_NOT_MASK_LOW 12
/*
- * not mask high: Matches when \FcsrMcontrolMatch$=5$ would not match.
+ * not mask high: Matches when {mcontrol-match}=5 would not match.
*/
#define CSR_MCONTROL_MATCH_NOT_MASK_HIGH 13
/*
* Other values are reserved for future use.
*
* All comparisons only look at the lower XLEN (in the current mode)
- * bits of the compare values and of \RcsrTdataTwo.
- * When \FcsrMcontrolSelect=1 and access size is N, this is further
+ * bits of the compare values and of {csr-tdata2}.
+ * When {mcontrol-select}=1 and access size is N, this is further
* reduced, and comparisons only look at the lower N bits of the
- * compare values and of \RcsrTdataTwo.
+ * compare values and of {csr-tdata2}.
*/
/*
* When set, enable this trigger in M-mode.
*/
-#define CSR_MCONTROL_M_OFFSET 6
-#define CSR_MCONTROL_M_LENGTH 1
-#define CSR_MCONTROL_M 0x40
+#define CSR_MCONTROL_M_OFFSET 6ULL
+#define CSR_MCONTROL_M_LENGTH 1ULL
+#define CSR_MCONTROL_M 0x40ULL
/*
* When set, enable this trigger in S/HS-mode.
* This bit is hard-wired to 0 if the hart does not support
* S-mode.
*/
-#define CSR_MCONTROL_S_OFFSET 4
-#define CSR_MCONTROL_S_LENGTH 1
-#define CSR_MCONTROL_S 0x10
+#define CSR_MCONTROL_S_OFFSET 4ULL
+#define CSR_MCONTROL_S_LENGTH 1ULL
+#define CSR_MCONTROL_S 0x10ULL
/*
* When set, enable this trigger in U-mode.
* This bit is hard-wired to 0 if the hart does not support
* U-mode.
*/
-#define CSR_MCONTROL_U_OFFSET 3
-#define CSR_MCONTROL_U_LENGTH 1
-#define CSR_MCONTROL_U 8
+#define CSR_MCONTROL_U_OFFSET 3ULL
+#define CSR_MCONTROL_U_LENGTH 1ULL
+#define CSR_MCONTROL_U 8ULL
/*
* When set, the trigger fires on the virtual address or opcode of an
* instruction that is executed.
*/
-#define CSR_MCONTROL_EXECUTE_OFFSET 2
-#define CSR_MCONTROL_EXECUTE_LENGTH 1
-#define CSR_MCONTROL_EXECUTE 4
+#define CSR_MCONTROL_EXECUTE_OFFSET 2ULL
+#define CSR_MCONTROL_EXECUTE_LENGTH 1ULL
+#define CSR_MCONTROL_EXECUTE 4ULL
/*
* When set, the trigger fires on the virtual address or data of any
* store.
*/
-#define CSR_MCONTROL_STORE_OFFSET 1
-#define CSR_MCONTROL_STORE_LENGTH 1
-#define CSR_MCONTROL_STORE 2
+#define CSR_MCONTROL_STORE_OFFSET 1ULL
+#define CSR_MCONTROL_STORE_LENGTH 1ULL
+#define CSR_MCONTROL_STORE 2ULL
/*
* When set, the trigger fires on the virtual address or data of any
* load.
*/
-#define CSR_MCONTROL_LOAD_OFFSET 0
-#define CSR_MCONTROL_LOAD_LENGTH 1
-#define CSR_MCONTROL_LOAD 1
+#define CSR_MCONTROL_LOAD_OFFSET 0ULL
+#define CSR_MCONTROL_LOAD_LENGTH 1ULL
+#define CSR_MCONTROL_LOAD 1ULL
#define CSR_MCONTROL6 0x7a1
-#define CSR_MCONTROL6_TYPE_OFFSET(XLEN) (XLEN + -4)
-#define CSR_MCONTROL6_TYPE_LENGTH 4
-#define CSR_MCONTROL6_TYPE(XLEN) (0xf * (1ULL<<(XLEN + -4)))
-#define CSR_MCONTROL6_DMODE_OFFSET(XLEN) (XLEN + -5)
-#define CSR_MCONTROL6_DMODE_LENGTH 1
-#define CSR_MCONTROL6_DMODE(XLEN) (1ULL<<(XLEN + -5))
+#define CSR_MCONTROL6_TYPE_OFFSET(XLEN) ((XLEN) + -4ULL)
+#define CSR_MCONTROL6_TYPE_LENGTH 4ULL
+#define CSR_MCONTROL6_TYPE(XLEN) (0xfULL * (1ULL << ((XLEN) + -4ULL)))
+#define CSR_MCONTROL6_DMODE_OFFSET(XLEN) ((XLEN) + -5ULL)
+#define CSR_MCONTROL6_DMODE_LENGTH 1ULL
+#define CSR_MCONTROL6_DMODE(XLEN) (1ULL << ((XLEN) + -5ULL))
+/*
+ * If implemented, the TM updates this field every time the trigger
+ * fires.
+ */
+#define CSR_MCONTROL6_UNCERTAIN_OFFSET 0x1aULL
+#define CSR_MCONTROL6_UNCERTAIN_LENGTH 1ULL
+#define CSR_MCONTROL6_UNCERTAIN 0x4000000ULL
+/*
+ * certain: The trigger that fired satisfied the configured conditions, or
+ * this bit is not implemented.
+ */
+#define CSR_MCONTROL6_UNCERTAIN_CERTAIN 0
+/*
+ * uncertain: The trigger that fired might not have perfectly satisfied the
+ * configured conditions. Due to the implementation the hardware
+ * cannot be certain.
+ */
+#define CSR_MCONTROL6_UNCERTAIN_UNCERTAIN 1
+#define CSR_MCONTROL6_HIT1_OFFSET 0x19ULL
+#define CSR_MCONTROL6_HIT1_LENGTH 1ULL
+#define CSR_MCONTROL6_HIT1 0x2000000ULL
/*
* When set, enable this trigger in VS-mode.
* This bit is hard-wired to 0 if the hart does not support
* virtualization mode.
*/
-#define CSR_MCONTROL6_VS_OFFSET 0x18
-#define CSR_MCONTROL6_VS_LENGTH 1
-#define CSR_MCONTROL6_VS 0x1000000
+#define CSR_MCONTROL6_VS_OFFSET 0x18ULL
+#define CSR_MCONTROL6_VS_LENGTH 1ULL
+#define CSR_MCONTROL6_VS 0x1000000ULL
/*
* When set, enable this trigger in VU-mode.
* This bit is hard-wired to 0 if the hart does not support
* virtualization mode.
*/
-#define CSR_MCONTROL6_VU_OFFSET 0x17
-#define CSR_MCONTROL6_VU_LENGTH 1
-#define CSR_MCONTROL6_VU 0x800000
+#define CSR_MCONTROL6_VU_OFFSET 0x17ULL
+#define CSR_MCONTROL6_VU_LENGTH 1ULL
+#define CSR_MCONTROL6_VU 0x800000ULL
/*
- * If this bit is implemented then it must become set when this
- * trigger fires and may become set when this trigger matches.
- * The trigger's user can set or clear it at any
- * time. It is used to determine which
- * trigger(s) matched. If the bit is not implemented, it is always 0
- * and writing it has no effect.
+ * If they are implemented, {mcontrol6-hit1} (MSB) and
+ * {mcontrol6-hit0} (LSB) combine into a single 2-bit field.
+ * The TM updates this field when the trigger fires. After the debugger
+ * has seen the update, it will normally write 0 to this field to so it
+ * can see future changes.
+ *
+ * If either of the bits is not implemented, the unimplemented bits
+ * will be read-only 0.
+ */
+#define CSR_MCONTROL6_HIT0_OFFSET 0x16ULL
+#define CSR_MCONTROL6_HIT0_LENGTH 1ULL
+#define CSR_MCONTROL6_HIT0 0x400000ULL
+/*
+ * false: The trigger did not fire.
+ */
+#define CSR_MCONTROL6_HIT0_FALSE 0
+/*
+ * before: The trigger fired before the instruction that matched it was
+ * retired, but after all preceding instructions are retired. This
+ * explicitly allows for instructions to be partially executed, as
+ * described in xref:multistate[].
+ *
+ * `xepc` or {csr-dpc} (depending on {mcontrol6-action}) must be set
+ * to the virtual address of the instruction that matched.
+ */
+#define CSR_MCONTROL6_HIT0_BEFORE 1
+/*
+ * after: The trigger fired after the instruction that triggered and at least
+ * one additional instruction were retired.
+ * `xepc` or {csr-dpc} (depending on {mcontrol6-action}) must be set
+ * to the virtual address of the next instruction that must be executed
+ * to preserve the program flow.
+ */
+#define CSR_MCONTROL6_HIT0_AFTER 2
+/*
+ * immediately after: The trigger fired just after the instruction that triggered it was
+ * retired, but before any subsequent instructions were executed.
+ * `xepc` or {csr-dpc} (depending on {mcontrol6-action}) must be set
+ * to the virtual address of the next instruction that must be executed
+ * to preserve the program flow.
+ *
+ * If the instruction performed multiple memory accesses, all of them
+ * have been completed.
*/
-#define CSR_MCONTROL6_HIT_OFFSET 0x16
-#define CSR_MCONTROL6_HIT_LENGTH 1
-#define CSR_MCONTROL6_HIT 0x400000
+#define CSR_MCONTROL6_HIT0_IMMEDIATELY_AFTER 3
/*
* This bit determines the contents of the XLEN-bit compare values.
*/
-#define CSR_MCONTROL6_SELECT_OFFSET 0x15
-#define CSR_MCONTROL6_SELECT_LENGTH 1
-#define CSR_MCONTROL6_SELECT 0x200000
+#define CSR_MCONTROL6_SELECT_OFFSET 0x15ULL
+#define CSR_MCONTROL6_SELECT_LENGTH 1ULL
+#define CSR_MCONTROL6_SELECT 0x200000ULL
/*
* address: There is at least one compare value and it contains the lowest
* virtual address of the access.
@@ -1010,58 +1194,13 @@
* Any bits beyond the size of the data access will contain 0.
*/
#define CSR_MCONTROL6_SELECT_DATA 1
-#define CSR_MCONTROL6_TIMING_OFFSET 0x14
-#define CSR_MCONTROL6_TIMING_LENGTH 1
-#define CSR_MCONTROL6_TIMING 0x100000
-/*
- * before: The action for this trigger will be taken just before the
- * instruction that triggered it is committed, but after all preceding
- * instructions are committed. \Rxepc or \RcsrDpc (depending
- * on \FcsrMcontrolSixAction) must be set to the virtual address of the
- * instruction that matched.
- *
- * If this is combined with \FcsrMcontrolSixLoad and
- * \FcsrMcontrolSixSelect=1 then a memory access will be
- * performed (including any side effects of performing such an access) even
- * though the load will not update its destination register. Debuggers
- * should consider this when setting such breakpoints on, for example,
- * memory-mapped I/O addresses.
- */
-#define CSR_MCONTROL6_TIMING_BEFORE 0
-/*
- * after: The action for this trigger will be taken after the instruction
- * that triggered it is committed. It should be taken before the next
- * instruction is committed, but it is better to implement triggers imprecisely
- * than to not implement them at all. \Rxepc or
- * \RcsrDpc (depending on \FcsrMcontrolSixAction) must be set to
- * the virtual address of the next instruction that must be executed to
- * preserve the program flow.
- */
-#define CSR_MCONTROL6_TIMING_AFTER 1
-/*
- * Most hardware will only implement one timing or the other, possibly
- * dependent on \FcsrMcontrolSixSelect, \FcsrMcontrolSixExecute,
- * \FcsrMcontrolSixLoad, and \FcsrMcontrolSixStore. This bit
- * primarily exists for the hardware to communicate to the debugger
- * what will happen. Hardware may implement the bit fully writable, in
- * which case the debugger has a little more control.
- *
- * Data load triggers with \FcsrMcontrolSixTiming of 0 will result in the same load
- * happening again when the debugger lets the hart run. For data load
- * triggers, debuggers must first attempt to set the breakpoint with
- * \FcsrMcontrolSixTiming of 1.
- *
- * If a trigger with \FcsrMcontrolSixTiming of 0 matches, it is
- * implementation-dependent whether that prevents a trigger with
- * \FcsrMcontrolSixTiming of 1 matching as well.
- */
-#define CSR_MCONTROL6_SIZE_OFFSET 0x10
-#define CSR_MCONTROL6_SIZE_LENGTH 4
-#define CSR_MCONTROL6_SIZE 0xf0000
+#define CSR_MCONTROL6_SIZE_OFFSET 0x10ULL
+#define CSR_MCONTROL6_SIZE_LENGTH 3ULL
+#define CSR_MCONTROL6_SIZE 0x70000ULL
/*
* any: The trigger will attempt to match against an access of any size.
- * The behavior is only well-defined if $|select|=0$, or if the access
- * size is XLEN.
+ * The behavior is only well-defined if {mcontrol6-select}=0, or if the
+ * access size is XLEN.
*/
#define CSR_MCONTROL6_SIZE_ANY 0
/*
@@ -1088,47 +1227,35 @@
*/
#define CSR_MCONTROL6_SIZE_64BIT 5
/*
- * 80bit: The trigger will only match against execution of 80-bit instructions.
- */
-#define CSR_MCONTROL6_SIZE_80BIT 6
-/*
- * 96bit: The trigger will only match against execution of 96-bit instructions.
- */
-#define CSR_MCONTROL6_SIZE_96BIT 7
-/*
- * 112bit: The trigger will only match against execution of 112-bit instructions.
- */
-#define CSR_MCONTROL6_SIZE_112BIT 8
-/*
* 128bit: The trigger will only match against 128-bit memory accesses or
* execution of 128-bit instructions.
*/
-#define CSR_MCONTROL6_SIZE_128BIT 9
+#define CSR_MCONTROL6_SIZE_128BIT 6
/*
* An implementation must support the value of 0, but all other values
* are optional. When an implementation supports address triggers
- * (\FcsrMcontrolSixSelect=0), it is recommended that those triggers
+ * ({mcontrol6-select}=0), it is recommended that those triggers
* support every access size that the hart supports, as well as for
* every instruction size that the hart supports.
*
* Implementations such as RV32D or RV64V are able to perform loads
* and stores that are wider than XLEN. Custom extensions may also
* support instructions that are wider than XLEN. Because
- * \RcsrTdataTwo is of size XLEN, there is a known limitation that
- * data value triggers (\FcsrMcontrolSixSelect=1) can only be supported
+ * {csr-tdata2} is of size XLEN, there is a known limitation that
+ * data value triggers ({mcontrol6-select}=1) can only be supported
* for access sizes up to XLEN bits. When an implementation supports
- * data value triggers (\FcsrMcontrolSixSelect=1), it is recommended
+ * data value triggers ({mcontrol6-select}=1), it is recommended
* that those triggers support every access size up to XLEN that the
* hart supports, as well as for every instruction length up to XLEN
* that the hart supports.
*/
/*
* The action to take when the trigger fires. The values are explained
- * in Table~\ref{tab:action}.
+ * in xref:tab:action[].
*/
-#define CSR_MCONTROL6_ACTION_OFFSET 0xc
-#define CSR_MCONTROL6_ACTION_LENGTH 4
-#define CSR_MCONTROL6_ACTION 0xf000
+#define CSR_MCONTROL6_ACTION_OFFSET 0xcULL
+#define CSR_MCONTROL6_ACTION_LENGTH 4ULL
+#define CSR_MCONTROL6_ACTION 0xf000ULL
/*
* breakpoint:
*/
@@ -1157,9 +1284,9 @@
* external1:
*/
#define CSR_MCONTROL6_ACTION_EXTERNAL1 9
-#define CSR_MCONTROL6_CHAIN_OFFSET 0xb
-#define CSR_MCONTROL6_CHAIN_LENGTH 1
-#define CSR_MCONTROL6_CHAIN 0x800
+#define CSR_MCONTROL6_CHAIN_OFFSET 0xbULL
+#define CSR_MCONTROL6_CHAIN_LENGTH 1ULL
+#define CSR_MCONTROL6_CHAIN 0x800ULL
/*
* disabled: When this trigger matches, the configured action is taken.
*/
@@ -1170,10 +1297,10 @@
*/
#define CSR_MCONTROL6_CHAIN_ENABLED 1
/*
- * A trigger chain starts on the first trigger with $|chain|=1$ after
- * a trigger with $|chain|=0$, or simply on the first trigger if that
- * has $|chain|=1$. It ends on the first trigger after that which has
- * $|chain|=0$. This final trigger is part of the chain. The action
+ * A trigger chain starts on the first trigger with `chain`=1 after
+ * a trigger with `chain`=0, or simply on the first trigger if that
+ * has `chain`=1. It ends on the first trigger after that which has
+ * `chain`=0. This final trigger is part of the chain. The action
* on all but the final trigger is ignored. The action on that final
* trigger will be taken if and only if all the triggers in the chain
* match at the same time.
@@ -1181,152 +1308,166 @@
* Debuggers should not terminate a chain with a trigger with a
* different type. It is undefined when exactly such a chain fires.
*
- * Because \FcsrMcontrolSixChain affects the next trigger, hardware must zero it in
- * writes to \RcsrMcontrolSix that set \FcsrTdataOneDmode to 0 if the next trigger has
- * \FcsrTdataOneDmode of 1.
- * In addition hardware should ignore writes to \RcsrMcontrolSix that set
- * \FcsrTdataOneDmode to 1 if the previous trigger has both \FcsrTdataOneDmode of 0 and
- * \FcsrMcontrolSixChain of 1. Debuggers must avoid the latter case by checking
- * \FcsrMcontrolSixChain on the previous trigger if they're writing \RcsrMcontrolSix.
+ * Because {mcontrol6-chain} affects the next trigger, hardware must zero it in
+ * writes to {csr-mcontrol6} that set {tdata1-dmode} to 0 if the next trigger has
+ * {tdata1-dmode} of 1.
+ * In addition hardware should ignore writes to {csr-mcontrol6} that set
+ * {tdata1-dmode} to 1 if the previous trigger has both {tdata1-dmode} of 0 and
+ * {mcontrol6-chain} of 1. Debuggers must avoid the latter case by checking
+ * {mcontrol6-chain} on the previous trigger if they're writing {csr-mcontrol6}.
*
* Implementations that wish to limit the maximum length of a trigger
* chain (eg. to meet timing requirements) may do so by zeroing
- * \FcsrMcontrolSixChain in writes to \RcsrMcontrolSix that would make the chain too long.
+ * {mcontrol6-chain} in writes to {csr-mcontrol6} that would make the chain too long.
*/
-#define CSR_MCONTROL6_MATCH_OFFSET 7
-#define CSR_MCONTROL6_MATCH_LENGTH 4
-#define CSR_MCONTROL6_MATCH 0x780
+#define CSR_MCONTROL6_MATCH_OFFSET 7ULL
+#define CSR_MCONTROL6_MATCH_LENGTH 4ULL
+#define CSR_MCONTROL6_MATCH 0x780ULL
/*
- * equal: Matches when any compare value equals \RcsrTdataTwo.
+ * equal: Matches when any compare value equals {csr-tdata2}.
*/
#define CSR_MCONTROL6_MATCH_EQUAL 0
/*
- * napot: Matches when the top $M$ bits of any compare value match the top
- * $M$ bits of \RcsrTdataTwo.
- * $M$ is $|XLEN|-1$ minus the index of the least-significant bit
- * containing 0 in \RcsrTdataTwo.
- * \RcsrTdataTwo is WARL and if bits $|maskmax6|-1$:0 are written with all
- * ones then bit $|maskmax6|-1$ will be set to 0 while the values of bits $|maskmax6|-2$:0
- * are \unspecified.
- * Legal values for \RcsrTdataTwo require $M + |maskmax6| \geq |XLEN|$ and $M\gt0$.
+ * napot: Matches when the top `M` bits of any compare value match the top
+ * `M` bits of {csr-tdata2}.
+ * `M` is `XLEN-1` minus the index of the least-significant bit
+ * containing 0 in {csr-tdata2}.
+ * {csr-tdata2} is *WARL* and if bits `maskmax6-1:0` are written with all
+ * ones then bit `maskmax6-1` will be set to 0 while the values of bits `maskmax6-2:0`
+ * are UNSPECIFIED.
+ * Legal values for {csr-tdata2} require M + `maskmax6` ≥ `XLEN` and `M` > 0.
* See above for how to determine maskmax6.
*/
#define CSR_MCONTROL6_MATCH_NAPOT 1
/*
* ge: Matches when any compare value is greater than (unsigned) or
- * equal to \RcsrTdataTwo.
+ * equal to {csr-tdata2}.
*/
#define CSR_MCONTROL6_MATCH_GE 2
/*
* lt: Matches when any compare value is less than (unsigned)
- * \RcsrTdataTwo.
+ * {csr-tdata2}.
*/
#define CSR_MCONTROL6_MATCH_LT 3
/*
- * mask low: Matches when $\frac{|XLEN|}{2}-1$:$0$ of any compare value
- * equals $\frac{|XLEN|}{2}-1$:$0$ of \RcsrTdataTwo after
- * $\frac{|XLEN|}{2}-1$:$0$ of the compare value is ANDed with
- * $|XLEN|-1$:$\frac{|XLEN|}{2}$ of \RcsrTdataTwo.
+ * mask low: Matches when latexmath:[$\frac{XLEN}{2}-{1:0}] of any compare value
+ * equals latexmath:[$\frac{XLEN}{2}-{1:0}] of {csr-tdata2} after
+ * latexmath:[$\frac{XLEN}{2}-{1:0}] of the compare value is ANDed with
+ * `XLEN-1`:latexmath:[$\frac{XLEN}{2}$] of {csr-tdata2}.
*/
#define CSR_MCONTROL6_MATCH_MASK_LOW 4
/*
- * mask high: Matches when $|XLEN|-1$:$\frac{|XLEN|}{2}$ of any compare
- * value equals $\frac{|XLEN|}{2}-1$:$0$ of \RcsrTdataTwo after
- * $|XLEN|-1$:$\frac{|XLEN|}{2}$ of the compare value is ANDed with
- * $|XLEN|-1$:$\frac{|XLEN|}{2}$ of \RcsrTdataTwo.
+ * mask high: Matches when `XLEN-1`:latexmath:[$\frac{XLEN}{2}$] of any compare
+ * value equals latexmath:[$\frac{XLEN}{2}-{1:0}] of {csr-tdata2} after
+ * `XLEN-1`:latexmath:[$\frac{XLEN}{2}$] of the compare value is ANDed with
+ * `XLEN-1`:latexmath:[$\frac{XLEN}{2}$] of {csr-tdata2}.
*/
#define CSR_MCONTROL6_MATCH_MASK_HIGH 5
/*
- * not equal: Matches when \FcsrMcontrolSixMatch$=0$ would not match.
+ * not equal: Matches when {mcontrol6-match} `=0` would not match.
*/
#define CSR_MCONTROL6_MATCH_NOT_EQUAL 8
/*
- * not napot: Matches when \FcsrMcontrolSixMatch$=1$ would not match.
+ * not napot: Matches when {mcontrol6-match} `=1` would not match.
*/
#define CSR_MCONTROL6_MATCH_NOT_NAPOT 9
/*
- * not mask low: Matches when \FcsrMcontrolSixMatch$=4$ would not match.
+ * not mask low: Matches when {mcontrol6-match} `=4` would not match.
*/
#define CSR_MCONTROL6_MATCH_NOT_MASK_LOW 12
/*
- * not mask high: Matches when \FcsrMcontrolSixMatch$=5$ would not match.
+ * not mask high: Matches when {mcontrol6-match} `=5` would not match.
*/
#define CSR_MCONTROL6_MATCH_NOT_MASK_HIGH 13
/*
* Other values are reserved for future use.
*
* All comparisons only look at the lower XLEN (in the current mode)
- * bits of the compare values and of \RcsrTdataTwo.
- * When \FcsrMcontrolSelect=1 and access size is N, this is further
+ * bits of the compare values and of {csr-tdata2}.
+ * When {mcontrol-select}=1 and access size is N, this is further
* reduced, and comparisons only look at the lower N bits of the
- * compare values and of \RcsrTdataTwo.
+ * compare values and of {csr-tdata2}.
*/
/*
* When set, enable this trigger in M-mode.
*/
-#define CSR_MCONTROL6_M_OFFSET 6
-#define CSR_MCONTROL6_M_LENGTH 1
-#define CSR_MCONTROL6_M 0x40
+#define CSR_MCONTROL6_M_OFFSET 6ULL
+#define CSR_MCONTROL6_M_LENGTH 1ULL
+#define CSR_MCONTROL6_M 0x40ULL
+#define CSR_MCONTROL6_UNCERTAINEN_OFFSET 5ULL
+#define CSR_MCONTROL6_UNCERTAINEN_LENGTH 1ULL
+#define CSR_MCONTROL6_UNCERTAINEN 0x20ULL
+/*
+ * disabled: This trigger will only match if the hardware can perfectly
+ * evaluate it.
+ */
+#define CSR_MCONTROL6_UNCERTAINEN_DISABLED 0
+/*
+ * enabled: This trigger will match if it's possible that it would match if
+ * the Trigger Module had perfect information about the operations
+ * being performed.
+ */
+#define CSR_MCONTROL6_UNCERTAINEN_ENABLED 1
/*
* When set, enable this trigger in S/HS-mode.
* This bit is hard-wired to 0 if the hart does not support
* S-mode.
*/
-#define CSR_MCONTROL6_S_OFFSET 4
-#define CSR_MCONTROL6_S_LENGTH 1
-#define CSR_MCONTROL6_S 0x10
+#define CSR_MCONTROL6_S_OFFSET 4ULL
+#define CSR_MCONTROL6_S_LENGTH 1ULL
+#define CSR_MCONTROL6_S 0x10ULL
/*
* When set, enable this trigger in U-mode.
* This bit is hard-wired to 0 if the hart does not support
* U-mode.
*/
-#define CSR_MCONTROL6_U_OFFSET 3
-#define CSR_MCONTROL6_U_LENGTH 1
-#define CSR_MCONTROL6_U 8
+#define CSR_MCONTROL6_U_OFFSET 3ULL
+#define CSR_MCONTROL6_U_LENGTH 1ULL
+#define CSR_MCONTROL6_U 8ULL
/*
* When set, the trigger fires on the virtual address or opcode of an
* instruction that is executed.
*/
-#define CSR_MCONTROL6_EXECUTE_OFFSET 2
-#define CSR_MCONTROL6_EXECUTE_LENGTH 1
-#define CSR_MCONTROL6_EXECUTE 4
+#define CSR_MCONTROL6_EXECUTE_OFFSET 2ULL
+#define CSR_MCONTROL6_EXECUTE_LENGTH 1ULL
+#define CSR_MCONTROL6_EXECUTE 4ULL
/*
* When set, the trigger fires on the virtual address or data of any
* store.
*/
-#define CSR_MCONTROL6_STORE_OFFSET 1
-#define CSR_MCONTROL6_STORE_LENGTH 1
-#define CSR_MCONTROL6_STORE 2
+#define CSR_MCONTROL6_STORE_OFFSET 1ULL
+#define CSR_MCONTROL6_STORE_LENGTH 1ULL
+#define CSR_MCONTROL6_STORE 2ULL
/*
* When set, the trigger fires on the virtual address or data of any
* load.
*/
-#define CSR_MCONTROL6_LOAD_OFFSET 0
-#define CSR_MCONTROL6_LOAD_LENGTH 1
-#define CSR_MCONTROL6_LOAD 1
+#define CSR_MCONTROL6_LOAD_OFFSET 0ULL
+#define CSR_MCONTROL6_LOAD_LENGTH 1ULL
+#define CSR_MCONTROL6_LOAD 1ULL
#define CSR_ICOUNT 0x7a1
-#define CSR_ICOUNT_TYPE_OFFSET(XLEN) (XLEN + -4)
-#define CSR_ICOUNT_TYPE_LENGTH 4
-#define CSR_ICOUNT_TYPE(XLEN) (0xf * (1ULL<<(XLEN + -4)))
-#define CSR_ICOUNT_DMODE_OFFSET(XLEN) (XLEN + -5)
-#define CSR_ICOUNT_DMODE_LENGTH 1
-#define CSR_ICOUNT_DMODE(XLEN) (1ULL<<(XLEN + -5))
+#define CSR_ICOUNT_TYPE_OFFSET(XLEN) ((XLEN) + -4ULL)
+#define CSR_ICOUNT_TYPE_LENGTH 4ULL
+#define CSR_ICOUNT_TYPE(XLEN) (0xfULL * (1ULL << ((XLEN) + -4ULL)))
+#define CSR_ICOUNT_DMODE_OFFSET(XLEN) ((XLEN) + -5ULL)
+#define CSR_ICOUNT_DMODE_LENGTH 1ULL
+#define CSR_ICOUNT_DMODE(XLEN) (1ULL << ((XLEN) + -5ULL))
/*
* When set, enable this trigger in VS-mode.
* This bit is hard-wired to 0 if the hart does not support
* virtualization mode.
*/
-#define CSR_ICOUNT_VS_OFFSET 0x1a
-#define CSR_ICOUNT_VS_LENGTH 1
-#define CSR_ICOUNT_VS 0x4000000
+#define CSR_ICOUNT_VS_OFFSET 0x1aULL
+#define CSR_ICOUNT_VS_LENGTH 1ULL
+#define CSR_ICOUNT_VS 0x4000000ULL
/*
* When set, enable this trigger in VU-mode.
* This bit is hard-wired to 0 if the hart does not support
* virtualization mode.
*/
-#define CSR_ICOUNT_VU_OFFSET 0x19
-#define CSR_ICOUNT_VU_LENGTH 1
-#define CSR_ICOUNT_VU 0x2000000
+#define CSR_ICOUNT_VU_OFFSET 0x19ULL
+#define CSR_ICOUNT_VU_LENGTH 1ULL
+#define CSR_ICOUNT_VU 0x2000000ULL
/*
* If this bit is implemented, the hardware sets it when this
* trigger fires. The trigger's user can set or clear it at any
@@ -1334,53 +1475,53 @@
* trigger(s) fires. If the bit is not implemented, it is always 0
* and writing it has no effect.
*/
-#define CSR_ICOUNT_HIT_OFFSET 0x18
-#define CSR_ICOUNT_HIT_LENGTH 1
-#define CSR_ICOUNT_HIT 0x1000000
+#define CSR_ICOUNT_HIT_OFFSET 0x18ULL
+#define CSR_ICOUNT_HIT_LENGTH 1ULL
+#define CSR_ICOUNT_HIT 0x1000000ULL
/*
- * The trigger will generally fire after \FcsrIcountCount instructions
+ * The trigger will generally fire after {icount-count} instructions
* in enabled modes have been executed. See above for the precise behavior.
*/
-#define CSR_ICOUNT_COUNT_OFFSET 0xa
-#define CSR_ICOUNT_COUNT_LENGTH 0xe
-#define CSR_ICOUNT_COUNT 0xfffc00
+#define CSR_ICOUNT_COUNT_OFFSET 0xaULL
+#define CSR_ICOUNT_COUNT_LENGTH 0xeULL
+#define CSR_ICOUNT_COUNT 0xfffc00ULL
/*
* When set, enable this trigger in M-mode.
*/
-#define CSR_ICOUNT_M_OFFSET 9
-#define CSR_ICOUNT_M_LENGTH 1
-#define CSR_ICOUNT_M 0x200
+#define CSR_ICOUNT_M_OFFSET 9ULL
+#define CSR_ICOUNT_M_LENGTH 1ULL
+#define CSR_ICOUNT_M 0x200ULL
/*
- * This bit becomes set when \FcsrIcountCount is decremented from 1
+ * This bit becomes set when {icount-count} is decremented from 1
* to 0. It is cleared when the trigger fires, which will happen just
* before executing the next instruction in one of the enabled modes.
*/
-#define CSR_ICOUNT_PENDING_OFFSET 8
-#define CSR_ICOUNT_PENDING_LENGTH 1
-#define CSR_ICOUNT_PENDING 0x100
+#define CSR_ICOUNT_PENDING_OFFSET 8ULL
+#define CSR_ICOUNT_PENDING_LENGTH 1ULL
+#define CSR_ICOUNT_PENDING 0x100ULL
/*
* When set, enable this trigger in S/HS-mode.
* This bit is hard-wired to 0 if the hart does not support
* S-mode.
*/
-#define CSR_ICOUNT_S_OFFSET 7
-#define CSR_ICOUNT_S_LENGTH 1
-#define CSR_ICOUNT_S 0x80
+#define CSR_ICOUNT_S_OFFSET 7ULL
+#define CSR_ICOUNT_S_LENGTH 1ULL
+#define CSR_ICOUNT_S 0x80ULL
/*
* When set, enable this trigger in U-mode.
* This bit is hard-wired to 0 if the hart does not support
* U-mode.
*/
-#define CSR_ICOUNT_U_OFFSET 6
-#define CSR_ICOUNT_U_LENGTH 1
-#define CSR_ICOUNT_U 0x40
+#define CSR_ICOUNT_U_OFFSET 6ULL
+#define CSR_ICOUNT_U_LENGTH 1ULL
+#define CSR_ICOUNT_U 0x40ULL
/*
* The action to take when the trigger fires. The values are explained
- * in Table~\ref{tab:action}.
+ * in xref:tab:action[].
*/
-#define CSR_ICOUNT_ACTION_OFFSET 0
-#define CSR_ICOUNT_ACTION_LENGTH 6
-#define CSR_ICOUNT_ACTION 0x3f
+#define CSR_ICOUNT_ACTION_OFFSET 0ULL
+#define CSR_ICOUNT_ACTION_LENGTH 6ULL
+#define CSR_ICOUNT_ACTION 0x3fULL
/*
* breakpoint:
*/
@@ -1410,12 +1551,12 @@
*/
#define CSR_ICOUNT_ACTION_EXTERNAL1 9
#define CSR_ITRIGGER 0x7a1
-#define CSR_ITRIGGER_TYPE_OFFSET(XLEN) (XLEN + -4)
-#define CSR_ITRIGGER_TYPE_LENGTH 4
-#define CSR_ITRIGGER_TYPE(XLEN) (0xf * (1ULL<<(XLEN + -4)))
-#define CSR_ITRIGGER_DMODE_OFFSET(XLEN) (XLEN + -5)
-#define CSR_ITRIGGER_DMODE_LENGTH 1
-#define CSR_ITRIGGER_DMODE(XLEN) (1ULL<<(XLEN + -5))
+#define CSR_ITRIGGER_TYPE_OFFSET(XLEN) ((XLEN) + -4ULL)
+#define CSR_ITRIGGER_TYPE_LENGTH 4ULL
+#define CSR_ITRIGGER_TYPE(XLEN) (0xfULL * (1ULL << ((XLEN) + -4ULL)))
+#define CSR_ITRIGGER_DMODE_OFFSET(XLEN) ((XLEN) + -5ULL)
+#define CSR_ITRIGGER_DMODE_LENGTH 1ULL
+#define CSR_ITRIGGER_DMODE(XLEN) (1ULL << ((XLEN) + -5ULL))
/*
* If this bit is implemented, the hardware sets it when this
* trigger matches. The trigger's user can set or clear it at any
@@ -1423,66 +1564,66 @@
* trigger(s) matched. If the bit is not implemented, it is always 0
* and writing it has no effect.
*/
-#define CSR_ITRIGGER_HIT_OFFSET(XLEN) (XLEN + -6)
-#define CSR_ITRIGGER_HIT_LENGTH 1
-#define CSR_ITRIGGER_HIT(XLEN) (1ULL<<(XLEN + -6))
+#define CSR_ITRIGGER_HIT_OFFSET(XLEN) ((XLEN) + -6ULL)
+#define CSR_ITRIGGER_HIT_LENGTH 1ULL
+#define CSR_ITRIGGER_HIT(XLEN) (1ULL << ((XLEN) + -6ULL))
/*
* When set, enable this trigger for interrupts that are taken from VS
* mode.
* This bit is hard-wired to 0 if the hart does not support
* virtualization mode.
*/
-#define CSR_ITRIGGER_VS_OFFSET 0xc
-#define CSR_ITRIGGER_VS_LENGTH 1
-#define CSR_ITRIGGER_VS 0x1000
+#define CSR_ITRIGGER_VS_OFFSET 0xcULL
+#define CSR_ITRIGGER_VS_LENGTH 1ULL
+#define CSR_ITRIGGER_VS 0x1000ULL
/*
* When set, enable this trigger for interrupts that are taken from VU
* mode.
* This bit is hard-wired to 0 if the hart does not support
* virtualization mode.
*/
-#define CSR_ITRIGGER_VU_OFFSET 0xb
-#define CSR_ITRIGGER_VU_LENGTH 1
-#define CSR_ITRIGGER_VU 0x800
+#define CSR_ITRIGGER_VU_OFFSET 0xbULL
+#define CSR_ITRIGGER_VU_LENGTH 1ULL
+#define CSR_ITRIGGER_VU 0x800ULL
/*
* When set, non-maskable interrupts cause this
* trigger to fire if the trigger is enabled for the current mode.
*/
-#define CSR_ITRIGGER_NMI_OFFSET 0xa
-#define CSR_ITRIGGER_NMI_LENGTH 1
-#define CSR_ITRIGGER_NMI 0x400
+#define CSR_ITRIGGER_NMI_OFFSET 0xaULL
+#define CSR_ITRIGGER_NMI_LENGTH 1ULL
+#define CSR_ITRIGGER_NMI 0x400ULL
/*
* When set, enable this trigger for interrupts that are taken from M
* mode.
*/
-#define CSR_ITRIGGER_M_OFFSET 9
-#define CSR_ITRIGGER_M_LENGTH 1
-#define CSR_ITRIGGER_M 0x200
+#define CSR_ITRIGGER_M_OFFSET 9ULL
+#define CSR_ITRIGGER_M_LENGTH 1ULL
+#define CSR_ITRIGGER_M 0x200ULL
/*
* When set, enable this trigger for interrupts that are taken from S/HS
* mode.
* This bit is hard-wired to 0 if the hart does not support
* S-mode.
*/
-#define CSR_ITRIGGER_S_OFFSET 7
-#define CSR_ITRIGGER_S_LENGTH 1
-#define CSR_ITRIGGER_S 0x80
+#define CSR_ITRIGGER_S_OFFSET 7ULL
+#define CSR_ITRIGGER_S_LENGTH 1ULL
+#define CSR_ITRIGGER_S 0x80ULL
/*
* When set, enable this trigger for interrupts that are taken from U
* mode.
* This bit is hard-wired to 0 if the hart does not support
* U-mode.
*/
-#define CSR_ITRIGGER_U_OFFSET 6
-#define CSR_ITRIGGER_U_LENGTH 1
-#define CSR_ITRIGGER_U 0x40
+#define CSR_ITRIGGER_U_OFFSET 6ULL
+#define CSR_ITRIGGER_U_LENGTH 1ULL
+#define CSR_ITRIGGER_U 0x40ULL
/*
* The action to take when the trigger fires. The values are explained
- * in Table~\ref{tab:action}.
+ * in xref:tab:action[].
*/
-#define CSR_ITRIGGER_ACTION_OFFSET 0
-#define CSR_ITRIGGER_ACTION_LENGTH 6
-#define CSR_ITRIGGER_ACTION 0x3f
+#define CSR_ITRIGGER_ACTION_OFFSET 0ULL
+#define CSR_ITRIGGER_ACTION_LENGTH 6ULL
+#define CSR_ITRIGGER_ACTION 0x3fULL
/*
* breakpoint:
*/
@@ -1512,12 +1653,12 @@
*/
#define CSR_ITRIGGER_ACTION_EXTERNAL1 9
#define CSR_ETRIGGER 0x7a1
-#define CSR_ETRIGGER_TYPE_OFFSET(XLEN) (XLEN + -4)
-#define CSR_ETRIGGER_TYPE_LENGTH 4
-#define CSR_ETRIGGER_TYPE(XLEN) (0xf * (1ULL<<(XLEN + -4)))
-#define CSR_ETRIGGER_DMODE_OFFSET(XLEN) (XLEN + -5)
-#define CSR_ETRIGGER_DMODE_LENGTH 1
-#define CSR_ETRIGGER_DMODE(XLEN) (1ULL<<(XLEN + -5))
+#define CSR_ETRIGGER_TYPE_OFFSET(XLEN) ((XLEN) + -4ULL)
+#define CSR_ETRIGGER_TYPE_LENGTH 4ULL
+#define CSR_ETRIGGER_TYPE(XLEN) (0xfULL * (1ULL << ((XLEN) + -4ULL)))
+#define CSR_ETRIGGER_DMODE_OFFSET(XLEN) ((XLEN) + -5ULL)
+#define CSR_ETRIGGER_DMODE_LENGTH 1ULL
+#define CSR_ETRIGGER_DMODE(XLEN) (1ULL << ((XLEN) + -5ULL))
/*
* If this bit is implemented, the hardware sets it when this
* trigger matches. The trigger's user can set or clear it at any
@@ -1525,59 +1666,59 @@
* trigger(s) matched. If the bit is not implemented, it is always 0
* and writing it has no effect.
*/
-#define CSR_ETRIGGER_HIT_OFFSET(XLEN) (XLEN + -6)
-#define CSR_ETRIGGER_HIT_LENGTH 1
-#define CSR_ETRIGGER_HIT(XLEN) (1ULL<<(XLEN + -6))
+#define CSR_ETRIGGER_HIT_OFFSET(XLEN) ((XLEN) + -6ULL)
+#define CSR_ETRIGGER_HIT_LENGTH 1ULL
+#define CSR_ETRIGGER_HIT(XLEN) (1ULL << ((XLEN) + -6ULL))
/*
* When set, enable this trigger for exceptions that are taken from VS
* mode.
* This bit is hard-wired to 0 if the hart does not support
* virtualization mode.
*/
-#define CSR_ETRIGGER_VS_OFFSET 0xc
-#define CSR_ETRIGGER_VS_LENGTH 1
-#define CSR_ETRIGGER_VS 0x1000
+#define CSR_ETRIGGER_VS_OFFSET 0xcULL
+#define CSR_ETRIGGER_VS_LENGTH 1ULL
+#define CSR_ETRIGGER_VS 0x1000ULL
/*
* When set, enable this trigger for exceptions that are taken from VU
* mode.
* This bit is hard-wired to 0 if the hart does not support
* virtualization mode.
*/
-#define CSR_ETRIGGER_VU_OFFSET 0xb
-#define CSR_ETRIGGER_VU_LENGTH 1
-#define CSR_ETRIGGER_VU 0x800
+#define CSR_ETRIGGER_VU_OFFSET 0xbULL
+#define CSR_ETRIGGER_VU_LENGTH 1ULL
+#define CSR_ETRIGGER_VU 0x800ULL
/*
* When set, enable this trigger for exceptions that are taken from M
* mode.
*/
-#define CSR_ETRIGGER_M_OFFSET 9
-#define CSR_ETRIGGER_M_LENGTH 1
-#define CSR_ETRIGGER_M 0x200
+#define CSR_ETRIGGER_M_OFFSET 9ULL
+#define CSR_ETRIGGER_M_LENGTH 1ULL
+#define CSR_ETRIGGER_M 0x200ULL
/*
* When set, enable this trigger for exceptions that are taken from S/HS
* mode.
* This bit is hard-wired to 0 if the hart does not support
* S-mode.
*/
-#define CSR_ETRIGGER_S_OFFSET 7
-#define CSR_ETRIGGER_S_LENGTH 1
-#define CSR_ETRIGGER_S 0x80
+#define CSR_ETRIGGER_S_OFFSET 7ULL
+#define CSR_ETRIGGER_S_LENGTH 1ULL
+#define CSR_ETRIGGER_S 0x80ULL
/*
* When set, enable this trigger for exceptions that are taken from U
* mode.
* This bit is hard-wired to 0 if the hart does not support
* U-mode.
*/
-#define CSR_ETRIGGER_U_OFFSET 6
-#define CSR_ETRIGGER_U_LENGTH 1
-#define CSR_ETRIGGER_U 0x40
+#define CSR_ETRIGGER_U_OFFSET 6ULL
+#define CSR_ETRIGGER_U_LENGTH 1ULL
+#define CSR_ETRIGGER_U 0x40ULL
/*
* The action to take when the trigger fires. The values are explained
- * in Table~\ref{tab:action}.
+ * in xref:tab:action[].
*/
-#define CSR_ETRIGGER_ACTION_OFFSET 0
-#define CSR_ETRIGGER_ACTION_LENGTH 6
-#define CSR_ETRIGGER_ACTION 0x3f
+#define CSR_ETRIGGER_ACTION_OFFSET 0ULL
+#define CSR_ETRIGGER_ACTION_LENGTH 6ULL
+#define CSR_ETRIGGER_ACTION 0x3fULL
/*
* breakpoint:
*/
@@ -1607,12 +1748,12 @@
*/
#define CSR_ETRIGGER_ACTION_EXTERNAL1 9
#define CSR_TMEXTTRIGGER 0x7a1
-#define CSR_TMEXTTRIGGER_TYPE_OFFSET(XLEN) (XLEN + -4)
-#define CSR_TMEXTTRIGGER_TYPE_LENGTH 4
-#define CSR_TMEXTTRIGGER_TYPE(XLEN) (0xf * (1ULL<<(XLEN + -4)))
-#define CSR_TMEXTTRIGGER_DMODE_OFFSET(XLEN) (XLEN + -5)
-#define CSR_TMEXTTRIGGER_DMODE_LENGTH 1
-#define CSR_TMEXTTRIGGER_DMODE(XLEN) (1ULL<<(XLEN + -5))
+#define CSR_TMEXTTRIGGER_TYPE_OFFSET(XLEN) ((XLEN) + -4ULL)
+#define CSR_TMEXTTRIGGER_TYPE_LENGTH 4ULL
+#define CSR_TMEXTTRIGGER_TYPE(XLEN) (0xfULL * (1ULL << ((XLEN) + -4ULL)))
+#define CSR_TMEXTTRIGGER_DMODE_OFFSET(XLEN) ((XLEN) + -5ULL)
+#define CSR_TMEXTTRIGGER_DMODE_LENGTH 1ULL
+#define CSR_TMEXTTRIGGER_DMODE(XLEN) (1ULL << ((XLEN) + -5ULL))
/*
* If this bit is implemented, the hardware sets it when this
* trigger matches. The trigger's user can set or clear it at any
@@ -1620,30 +1761,30 @@
* trigger(s) matched. If the bit is not implemented, it is always 0
* and writing it has no effect.
*/
-#define CSR_TMEXTTRIGGER_HIT_OFFSET(XLEN) (XLEN + -6)
-#define CSR_TMEXTTRIGGER_HIT_LENGTH 1
-#define CSR_TMEXTTRIGGER_HIT(XLEN) (1ULL<<(XLEN + -6))
+#define CSR_TMEXTTRIGGER_HIT_OFFSET(XLEN) ((XLEN) + -6ULL)
+#define CSR_TMEXTTRIGGER_HIT_LENGTH 1ULL
+#define CSR_TMEXTTRIGGER_HIT(XLEN) (1ULL << ((XLEN) + -6ULL))
/*
* This optional bit, when set, causes this trigger to fire whenever an attached
* interrupt controller signals a trigger.
*/
-#define CSR_TMEXTTRIGGER_INTCTL_OFFSET 0x16
-#define CSR_TMEXTTRIGGER_INTCTL_LENGTH 1
-#define CSR_TMEXTTRIGGER_INTCTL 0x400000
+#define CSR_TMEXTTRIGGER_INTCTL_OFFSET 0x16ULL
+#define CSR_TMEXTTRIGGER_INTCTL_LENGTH 1ULL
+#define CSR_TMEXTTRIGGER_INTCTL 0x400000ULL
/*
- * Selects any combination of up to 16 external debug trigger inputs
+ * Selects any combination of up to 16 TM external trigger inputs
* that cause this trigger to fire.
*/
-#define CSR_TMEXTTRIGGER_SELECT_OFFSET 6
-#define CSR_TMEXTTRIGGER_SELECT_LENGTH 0x10
-#define CSR_TMEXTTRIGGER_SELECT 0x3fffc0
+#define CSR_TMEXTTRIGGER_SELECT_OFFSET 6ULL
+#define CSR_TMEXTTRIGGER_SELECT_LENGTH 0x10ULL
+#define CSR_TMEXTTRIGGER_SELECT 0x3fffc0ULL
/*
* The action to take when the trigger fires. The values are explained
- * in Table~\ref{tab:action}.
+ * in xref:tab:action[].
*/
-#define CSR_TMEXTTRIGGER_ACTION_OFFSET 0
-#define CSR_TMEXTTRIGGER_ACTION_LENGTH 6
-#define CSR_TMEXTTRIGGER_ACTION 0x3f
+#define CSR_TMEXTTRIGGER_ACTION_OFFSET 0ULL
+#define CSR_TMEXTTRIGGER_ACTION_LENGTH 6ULL
+#define CSR_TMEXTTRIGGER_ACTION 0x3fULL
/*
* breakpoint:
*/
@@ -1674,29 +1815,31 @@
#define CSR_TMEXTTRIGGER_ACTION_EXTERNAL1 9
#define CSR_TEXTRA32 0x7a3
/*
- * Data used together with \FcsrTextraThirtytwoMhselect.
+ * Data used together with {textra32-mhselect}.
*/
-#define CSR_TEXTRA32_MHVALUE_OFFSET 0x1a
-#define CSR_TEXTRA32_MHVALUE_LENGTH 6
-#define CSR_TEXTRA32_MHVALUE 0xfc000000U
-#define CSR_TEXTRA32_MHSELECT_OFFSET 0x17
-#define CSR_TEXTRA32_MHSELECT_LENGTH 3
-#define CSR_TEXTRA32_MHSELECT 0x3800000
+#define CSR_TEXTRA32_MHVALUE_OFFSET 0x1aULL
+#define CSR_TEXTRA32_MHVALUE_LENGTH 6ULL
+#define CSR_TEXTRA32_MHVALUE 0xfc000000ULL
+#define CSR_TEXTRA32_MHSELECT_OFFSET 0x17ULL
+#define CSR_TEXTRA32_MHSELECT_LENGTH 3ULL
+#define CSR_TEXTRA32_MHSELECT 0x3800000ULL
/*
- * ignore: Ignore \FcsrTextraThirtytwoMhvalue.
+ * ignore: Ignore {textra32-mhvalue}.
*/
#define CSR_TEXTRA32_MHSELECT_IGNORE 0
/*
- * mcontext: This trigger will only match if the low bits of
- * \RcsrMcontext/\RcsrHcontext equal \FcsrTextraThirtytwoMhvalue.
+ * mcontext: This trigger will only match or fire if the low bits of
+ * {csr-mcontext}/{csr-hcontext} equal {textra32-mhvalue}.
*/
#define CSR_TEXTRA32_MHSELECT_MCONTEXT 4
/*
- * 1, 5 (mcontext\_select): This trigger will only match if the low bits of
- * \RcsrMcontext/\RcsrHcontext equal \{\FcsrTextraThirtytwoMhvalue, mhselect[2]\}.
+ * 1, 5 (mcontext_select): This trigger will only match or fire if the
+ * low bits of
+ * {csr-mcontext}/{csr-hcontext} equal {{textra32-mhvalue}, mhselect[2]}.
*
- * 2, 6 (vmid\_select): This trigger will only match if VMID in hgatp equals the lower VMIDMAX
- * (defined in the Privileged Spec) bits of \{\FcsrTextraThirtytwoMhvalue, mhselect[2]\}.
+ * 2, 6 (vmid_select): This trigger will only match or fire if VMID in
+ * hgatp equals the lower VMIDMAX
+ * (defined in the Privileged Spec) bits of {{textra32-mhvalue}, mhselect[2]}.
*
* 3, 7 (reserved): Reserved.
*
@@ -1704,193 +1847,192 @@
*/
/*
* When the least significant bit of this field is 1, it causes bits 7:0
- * in the comparison to be ignored, when \FcsrTextraThirtytwoSselect=1.
+ * in the comparison to be ignored, when {textra32-sselect}=1.
* When the next most significant bit of this field is 1, it causes bits 15:8
- * to be ignored in the comparison, when \FcsrTextraThirtytwoSselect=1.
+ * to be ignored in the comparison, when {textra32-sselect}=1.
*/
-#define CSR_TEXTRA32_SBYTEMASK_OFFSET 0x12
-#define CSR_TEXTRA32_SBYTEMASK_LENGTH 2
-#define CSR_TEXTRA32_SBYTEMASK 0xc0000
+#define CSR_TEXTRA32_SBYTEMASK_OFFSET 0x12ULL
+#define CSR_TEXTRA32_SBYTEMASK_LENGTH 2ULL
+#define CSR_TEXTRA32_SBYTEMASK 0xc0000ULL
/*
- * Data used together with \FcsrTextraThirtytwoSselect.
+ * Data used together with {textra32-sselect}.
*
* This field should be tied to 0 when S-mode is not supported.
*/
-#define CSR_TEXTRA32_SVALUE_OFFSET 2
-#define CSR_TEXTRA32_SVALUE_LENGTH 0x10
-#define CSR_TEXTRA32_SVALUE 0x3fffc
-#define CSR_TEXTRA32_SSELECT_OFFSET 0
-#define CSR_TEXTRA32_SSELECT_LENGTH 2
-#define CSR_TEXTRA32_SSELECT 3
+#define CSR_TEXTRA32_SVALUE_OFFSET 2ULL
+#define CSR_TEXTRA32_SVALUE_LENGTH 0x10ULL
+#define CSR_TEXTRA32_SVALUE 0x3fffcULL
+#define CSR_TEXTRA32_SSELECT_OFFSET 0ULL
+#define CSR_TEXTRA32_SSELECT_LENGTH 2ULL
+#define CSR_TEXTRA32_SSELECT 3ULL
/*
- * ignore: Ignore \FcsrTextraThirtytwoSvalue.
+ * ignore: Ignore {textra32-svalue}.
*/
#define CSR_TEXTRA32_SSELECT_IGNORE 0
/*
- * scontext: This trigger will only match if the low bits of
- * \RcsrScontext equal \FcsrTextraThirtytwoSvalue.
+ * scontext: This trigger will only match or fire if the low bits of
+ * {csr-scontext} equal {textra32-svalue}.
*/
#define CSR_TEXTRA32_SSELECT_SCONTEXT 1
/*
- * asid: This trigger will only match if:
- * \begin{itemize}[noitemsep,nolistsep]
- * \item the mode is VS-mode or VU-mode and ASID in \Rvsatp
+ * asid: This trigger will only match or fire if:
+ *
+ * * the mode is VS-mode or VU-mode and ASID in `vsatp`
* equals the lower ASIDMAX (defined in the Privileged Spec) bits
- * of \FcsrTextraThirtytwoSvalue.
- * \item in all other modes, ASID in \Rsatp equals the lower
+ * of {textra32-svalue}.
+ *
+ * * in all other modes, ASID in `satp` equals the lower
* ASIDMAX (defined in the Privileged Spec) bits of
- * \FcsrTextraThirtytwoSvalue.
- * \end{itemize}
+ * {textra32-svalue}.
*/
#define CSR_TEXTRA32_SSELECT_ASID 2
/*
* This field should be tied to 0 when S-mode is not supported.
*/
#define CSR_TEXTRA64 0x7a3
-#define CSR_TEXTRA64_MHVALUE_OFFSET 0x33
-#define CSR_TEXTRA64_MHVALUE_LENGTH 0xd
+#define CSR_TEXTRA64_MHVALUE_OFFSET 0x33ULL
+#define CSR_TEXTRA64_MHVALUE_LENGTH 0xdULL
#define CSR_TEXTRA64_MHVALUE 0xfff8000000000000ULL
-#define CSR_TEXTRA64_MHSELECT_OFFSET 0x30
-#define CSR_TEXTRA64_MHSELECT_LENGTH 3
+#define CSR_TEXTRA64_MHSELECT_OFFSET 0x30ULL
+#define CSR_TEXTRA64_MHSELECT_LENGTH 3ULL
#define CSR_TEXTRA64_MHSELECT 0x7000000000000ULL
/*
* When the least significant bit of this field is 1, it causes bits 7:0
- * in the comparison to be ignored, when \FcsrTextraSixtyfourSselect=1.
+ * in the comparison to be ignored, when {textra64-sselect}=1.
* Likewise, the second bit controls the comparison of bits 15:8,
* third bit controls the comparison of bits 23:16,
- * fourth bit controls the comparison of bits 31:24, and
- * fifth bit controls the comparison of bits 33:32.
- */
-#define CSR_TEXTRA64_SBYTEMASK_OFFSET 0x24
-#define CSR_TEXTRA64_SBYTEMASK_LENGTH 5
-#define CSR_TEXTRA64_SBYTEMASK 0x1f000000000ULL
-#define CSR_TEXTRA64_SVALUE_OFFSET 2
-#define CSR_TEXTRA64_SVALUE_LENGTH 0x22
-#define CSR_TEXTRA64_SVALUE 0xffffffffcULL
-#define CSR_TEXTRA64_SSELECT_OFFSET 0
-#define CSR_TEXTRA64_SSELECT_LENGTH 2
-#define CSR_TEXTRA64_SSELECT 3
+ * and fourth bit controls the comparison of bits 31:24.
+ */
+#define CSR_TEXTRA64_SBYTEMASK_OFFSET 0x24ULL
+#define CSR_TEXTRA64_SBYTEMASK_LENGTH 4ULL
+#define CSR_TEXTRA64_SBYTEMASK 0xf000000000ULL
+#define CSR_TEXTRA64_SVALUE_OFFSET 2ULL
+#define CSR_TEXTRA64_SVALUE_LENGTH 0x20ULL
+#define CSR_TEXTRA64_SVALUE 0x3fffffffcULL
+#define CSR_TEXTRA64_SSELECT_OFFSET 0ULL
+#define CSR_TEXTRA64_SSELECT_LENGTH 2ULL
+#define CSR_TEXTRA64_SSELECT 3ULL
#define DM_DMSTATUS 0x11
-#define DM_DMSTATUS_NDMRESETPENDING_OFFSET 0x18
-#define DM_DMSTATUS_NDMRESETPENDING_LENGTH 1
-#define DM_DMSTATUS_NDMRESETPENDING 0x1000000
+#define DM_DMSTATUS_NDMRESETPENDING_OFFSET 0x18ULL
+#define DM_DMSTATUS_NDMRESETPENDING_LENGTH 1ULL
+#define DM_DMSTATUS_NDMRESETPENDING 0x1000000ULL
/*
- * false: Unimplemented, or \FdmDmcontrolNdmreset is zero and no ndmreset is currently
+ * false: Unimplemented, or {dmcontrol-ndmreset} is zero and no ndmreset is currently
* in progress.
*/
#define DM_DMSTATUS_NDMRESETPENDING_FALSE 0
/*
- * true: \FdmDmcontrolNdmreset is currently nonzero, or there is an ndmreset in progress.
+ * true: {dmcontrol-ndmreset} is currently nonzero, or there is an ndmreset in progress.
*/
#define DM_DMSTATUS_NDMRESETPENDING_TRUE 1
-#define DM_DMSTATUS_STICKYUNAVAIL_OFFSET 0x17
-#define DM_DMSTATUS_STICKYUNAVAIL_LENGTH 1
-#define DM_DMSTATUS_STICKYUNAVAIL 0x800000
+#define DM_DMSTATUS_STICKYUNAVAIL_OFFSET 0x17ULL
+#define DM_DMSTATUS_STICKYUNAVAIL_LENGTH 1ULL
+#define DM_DMSTATUS_STICKYUNAVAIL 0x800000ULL
/*
- * current: The per-hart {\tt unavail} bits reflect the current state of the hart.
+ * current: The per-hart `unavail` bits reflect the current state of the hart.
*/
#define DM_DMSTATUS_STICKYUNAVAIL_CURRENT 0
/*
- * sticky: The per-hart {\tt unavail} bits are sticky. Once they are set, they will
- * not clear until the debugger acknowledges them using \FdmDmcontrolAckunavail.
+ * sticky: The per-hart `unavail` bits are sticky. Once they are set, they will
+ * not clear until the debugger acknowledges them using {dmcontrol-ackunavail}.
*/
#define DM_DMSTATUS_STICKYUNAVAIL_STICKY 1
/*
- * If 1, then there is an implicit {\tt ebreak} instruction at the
+ * If 1, then there is an implicit `ebreak` instruction at the
* non-existent word immediately after the Program Buffer. This saves
- * the debugger from having to write the {\tt ebreak} itself, and
+ * the debugger from having to write the `ebreak` itself, and
* allows the Program Buffer to be one word smaller.
*
- * This must be 1 when \FdmAbstractcsProgbufsize is 1.
+ * This must be 1 when {abstractcs-progbufsize} is 1.
*/
-#define DM_DMSTATUS_IMPEBREAK_OFFSET 0x16
-#define DM_DMSTATUS_IMPEBREAK_LENGTH 1
-#define DM_DMSTATUS_IMPEBREAK 0x400000
+#define DM_DMSTATUS_IMPEBREAK_OFFSET 0x16ULL
+#define DM_DMSTATUS_IMPEBREAK_LENGTH 1ULL
+#define DM_DMSTATUS_IMPEBREAK 0x400000ULL
/*
* This field is 1 when all currently selected harts have been reset
* and reset has not been acknowledged for any of them.
*/
-#define DM_DMSTATUS_ALLHAVERESET_OFFSET 0x13
-#define DM_DMSTATUS_ALLHAVERESET_LENGTH 1
-#define DM_DMSTATUS_ALLHAVERESET 0x80000
+#define DM_DMSTATUS_ALLHAVERESET_OFFSET 0x13ULL
+#define DM_DMSTATUS_ALLHAVERESET_LENGTH 1ULL
+#define DM_DMSTATUS_ALLHAVERESET 0x80000ULL
/*
* This field is 1 when at least one currently selected hart has been
* reset and reset has not been acknowledged for that hart.
*/
-#define DM_DMSTATUS_ANYHAVERESET_OFFSET 0x12
-#define DM_DMSTATUS_ANYHAVERESET_LENGTH 1
-#define DM_DMSTATUS_ANYHAVERESET 0x40000
+#define DM_DMSTATUS_ANYHAVERESET_OFFSET 0x12ULL
+#define DM_DMSTATUS_ANYHAVERESET_LENGTH 1ULL
+#define DM_DMSTATUS_ANYHAVERESET 0x40000ULL
/*
* This field is 1 when all currently selected harts have their
- * resume ack bit\index{resume ack bit} set.
+ * ((resume ack bit)) set.
*/
-#define DM_DMSTATUS_ALLRESUMEACK_OFFSET 0x11
-#define DM_DMSTATUS_ALLRESUMEACK_LENGTH 1
-#define DM_DMSTATUS_ALLRESUMEACK 0x20000
+#define DM_DMSTATUS_ALLRESUMEACK_OFFSET 0x11ULL
+#define DM_DMSTATUS_ALLRESUMEACK_LENGTH 1ULL
+#define DM_DMSTATUS_ALLRESUMEACK 0x20000ULL
/*
* This field is 1 when any currently selected hart has its
- * resume ack bit\index{resume ack bit} set.
+ * ((resume ack bit)) set.
*/
-#define DM_DMSTATUS_ANYRESUMEACK_OFFSET 0x10
-#define DM_DMSTATUS_ANYRESUMEACK_LENGTH 1
-#define DM_DMSTATUS_ANYRESUMEACK 0x10000
+#define DM_DMSTATUS_ANYRESUMEACK_OFFSET 0x10ULL
+#define DM_DMSTATUS_ANYRESUMEACK_LENGTH 1ULL
+#define DM_DMSTATUS_ANYRESUMEACK 0x10000ULL
/*
* This field is 1 when all currently selected harts do not exist in
* this hardware platform.
*/
-#define DM_DMSTATUS_ALLNONEXISTENT_OFFSET 0xf
-#define DM_DMSTATUS_ALLNONEXISTENT_LENGTH 1
-#define DM_DMSTATUS_ALLNONEXISTENT 0x8000
+#define DM_DMSTATUS_ALLNONEXISTENT_OFFSET 0xfULL
+#define DM_DMSTATUS_ALLNONEXISTENT_LENGTH 1ULL
+#define DM_DMSTATUS_ALLNONEXISTENT 0x8000ULL
/*
* This field is 1 when any currently selected hart does not exist in
* this hardware platform.
*/
-#define DM_DMSTATUS_ANYNONEXISTENT_OFFSET 0xe
-#define DM_DMSTATUS_ANYNONEXISTENT_LENGTH 1
-#define DM_DMSTATUS_ANYNONEXISTENT 0x4000
+#define DM_DMSTATUS_ANYNONEXISTENT_OFFSET 0xeULL
+#define DM_DMSTATUS_ANYNONEXISTENT_LENGTH 1ULL
+#define DM_DMSTATUS_ANYNONEXISTENT 0x4000ULL
/*
* This field is 1 when all currently selected harts are
- * unavailable, or (if \FdmDmstatusStickyunavail is 1) were
+ * unavailable, or (if {dmstatus-stickyunavail} is 1) were
* unavailable without that being acknowledged.
*/
-#define DM_DMSTATUS_ALLUNAVAIL_OFFSET 0xd
-#define DM_DMSTATUS_ALLUNAVAIL_LENGTH 1
-#define DM_DMSTATUS_ALLUNAVAIL 0x2000
+#define DM_DMSTATUS_ALLUNAVAIL_OFFSET 0xdULL
+#define DM_DMSTATUS_ALLUNAVAIL_LENGTH 1ULL
+#define DM_DMSTATUS_ALLUNAVAIL 0x2000ULL
/*
* This field is 1 when any currently selected hart is unavailable,
- * or (if \FdmDmstatusStickyunavail is 1) was unavailable without
+ * or (if {dmstatus-stickyunavail} is 1) was unavailable without
* that being acknowledged.
*/
-#define DM_DMSTATUS_ANYUNAVAIL_OFFSET 0xc
-#define DM_DMSTATUS_ANYUNAVAIL_LENGTH 1
-#define DM_DMSTATUS_ANYUNAVAIL 0x1000
+#define DM_DMSTATUS_ANYUNAVAIL_OFFSET 0xcULL
+#define DM_DMSTATUS_ANYUNAVAIL_LENGTH 1ULL
+#define DM_DMSTATUS_ANYUNAVAIL 0x1000ULL
/*
* This field is 1 when all currently selected harts are running.
*/
-#define DM_DMSTATUS_ALLRUNNING_OFFSET 0xb
-#define DM_DMSTATUS_ALLRUNNING_LENGTH 1
-#define DM_DMSTATUS_ALLRUNNING 0x800
+#define DM_DMSTATUS_ALLRUNNING_OFFSET 0xbULL
+#define DM_DMSTATUS_ALLRUNNING_LENGTH 1ULL
+#define DM_DMSTATUS_ALLRUNNING 0x800ULL
/*
* This field is 1 when any currently selected hart is running.
*/
-#define DM_DMSTATUS_ANYRUNNING_OFFSET 0xa
-#define DM_DMSTATUS_ANYRUNNING_LENGTH 1
-#define DM_DMSTATUS_ANYRUNNING 0x400
+#define DM_DMSTATUS_ANYRUNNING_OFFSET 0xaULL
+#define DM_DMSTATUS_ANYRUNNING_LENGTH 1ULL
+#define DM_DMSTATUS_ANYRUNNING 0x400ULL
/*
* This field is 1 when all currently selected harts are halted.
*/
-#define DM_DMSTATUS_ALLHALTED_OFFSET 9
-#define DM_DMSTATUS_ALLHALTED_LENGTH 1
-#define DM_DMSTATUS_ALLHALTED 0x200
+#define DM_DMSTATUS_ALLHALTED_OFFSET 9ULL
+#define DM_DMSTATUS_ALLHALTED_LENGTH 1ULL
+#define DM_DMSTATUS_ALLHALTED 0x200ULL
/*
* This field is 1 when any currently selected hart is halted.
*/
-#define DM_DMSTATUS_ANYHALTED_OFFSET 8
-#define DM_DMSTATUS_ANYHALTED_LENGTH 1
-#define DM_DMSTATUS_ANYHALTED 0x100
-#define DM_DMSTATUS_AUTHENTICATED_OFFSET 7
-#define DM_DMSTATUS_AUTHENTICATED_LENGTH 1
-#define DM_DMSTATUS_AUTHENTICATED 0x80
+#define DM_DMSTATUS_ANYHALTED_OFFSET 8ULL
+#define DM_DMSTATUS_ANYHALTED_LENGTH 1ULL
+#define DM_DMSTATUS_ANYHALTED 0x100ULL
+#define DM_DMSTATUS_AUTHENTICATED_OFFSET 7ULL
+#define DM_DMSTATUS_AUTHENTICATED_LENGTH 1ULL
+#define DM_DMSTATUS_AUTHENTICATED 0x80ULL
/*
* false: Authentication is required before using the DM.
*/
@@ -1903,47 +2045,47 @@
* On components that don't implement authentication, this bit must be
* preset as 1.
*/
-#define DM_DMSTATUS_AUTHBUSY_OFFSET 6
-#define DM_DMSTATUS_AUTHBUSY_LENGTH 1
-#define DM_DMSTATUS_AUTHBUSY 0x40
+#define DM_DMSTATUS_AUTHBUSY_OFFSET 6ULL
+#define DM_DMSTATUS_AUTHBUSY_LENGTH 1ULL
+#define DM_DMSTATUS_AUTHBUSY 0x40ULL
/*
* ready: The authentication module is ready to process the next
- * read/write to \RdmAuthdata.
+ * read/write to {dm-authdata}.
*/
#define DM_DMSTATUS_AUTHBUSY_READY 0
/*
- * busy: The authentication module is busy. Accessing \RdmAuthdata results
+ * busy: The authentication module is busy. Accessing {dm-authdata} results
* in unspecified behavior.
*/
#define DM_DMSTATUS_AUTHBUSY_BUSY 1
/*
- * \FdmDmstatusAuthbusy only becomes set in immediate response to an access to
- * \RdmAuthdata.
+ * {dmstatus-authbusy} only becomes set in immediate response to an access to
+ * {dm-authdata}.
*/
/*
* 1 if this Debug Module supports halt-on-reset functionality
- * controllable by the \FdmDmcontrolSetresethaltreq and \FdmDmcontrolClrresethaltreq bits.
+ * controllable by the {dmcontrol-setresethaltreq} and {dmcontrol-clrresethaltreq} bits.
* 0 otherwise.
*/
-#define DM_DMSTATUS_HASRESETHALTREQ_OFFSET 5
-#define DM_DMSTATUS_HASRESETHALTREQ_LENGTH 1
-#define DM_DMSTATUS_HASRESETHALTREQ 0x20
-#define DM_DMSTATUS_CONFSTRPTRVALID_OFFSET 4
-#define DM_DMSTATUS_CONFSTRPTRVALID_LENGTH 1
-#define DM_DMSTATUS_CONFSTRPTRVALID 0x10
+#define DM_DMSTATUS_HASRESETHALTREQ_OFFSET 5ULL
+#define DM_DMSTATUS_HASRESETHALTREQ_LENGTH 1ULL
+#define DM_DMSTATUS_HASRESETHALTREQ 0x20ULL
+#define DM_DMSTATUS_CONFSTRPTRVALID_OFFSET 4ULL
+#define DM_DMSTATUS_CONFSTRPTRVALID_LENGTH 1ULL
+#define DM_DMSTATUS_CONFSTRPTRVALID 0x10ULL
/*
- * invalid: \RdmConfstrptrZero--\RdmConfstrptrThree hold information which
+ * invalid: {dm-confstrptr0}--{dm-confstrptr3} hold information which
* is not relevant to the configuration structure.
*/
#define DM_DMSTATUS_CONFSTRPTRVALID_INVALID 0
/*
- * valid: \RdmConfstrptrZero--\RdmConfstrptrThree hold the address of the
+ * valid: {dm-confstrptr0}--{dm-confstrptr3} hold the address of the
* configuration structure.
*/
#define DM_DMSTATUS_CONFSTRPTRVALID_VALID 1
-#define DM_DMSTATUS_VERSION_OFFSET 0
-#define DM_DMSTATUS_VERSION_LENGTH 4
-#define DM_DMSTATUS_VERSION 0xf
+#define DM_DMSTATUS_VERSION_OFFSET 0ULL
+#define DM_DMSTATUS_VERSION_LENGTH 4ULL
+#define DM_DMSTATUS_VERSION 0xfULL
/*
* none: There is no Debug Module present.
*/
@@ -1977,23 +2119,23 @@
* harts. Running harts will halt whenever their halt request bit is
* set.
*
- * Writes apply to the new value of \Fhartsel and \FdmDmcontrolHasel.
+ * Writes apply to the new value of {hartsel} and {dmcontrol-hasel}.
*/
-#define DM_DMCONTROL_HALTREQ_OFFSET 0x1f
-#define DM_DMCONTROL_HALTREQ_LENGTH 1
-#define DM_DMCONTROL_HALTREQ 0x80000000U
+#define DM_DMCONTROL_HALTREQ_OFFSET 0x1fULL
+#define DM_DMCONTROL_HALTREQ_LENGTH 1ULL
+#define DM_DMCONTROL_HALTREQ 0x80000000ULL
/*
* Writing 1 causes the currently selected harts to resume once, if
* they are halted when the write occurs. It also clears the resume
* ack bit for those harts.
*
- * \FdmDmcontrolResumereq is ignored if \FdmDmcontrolHaltreq is set.
+ * {dmcontrol-resumereq} is ignored if {dmcontrol-haltreq} is set.
*
- * Writes apply to the new value of \Fhartsel and \FdmDmcontrolHasel.
+ * Writes apply to the new value of {hartsel} and {dmcontrol-hasel}.
*/
-#define DM_DMCONTROL_RESUMEREQ_OFFSET 0x1e
-#define DM_DMCONTROL_RESUMEREQ_LENGTH 1
-#define DM_DMCONTROL_RESUMEREQ 0x40000000
+#define DM_DMCONTROL_RESUMEREQ_OFFSET 0x1eULL
+#define DM_DMCONTROL_RESUMEREQ_LENGTH 1ULL
+#define DM_DMCONTROL_RESUMEREQ 0x40000000ULL
/*
* This optional field writes the reset bit for all the currently
* selected harts. To perform a reset the debugger writes 1, and then
@@ -2006,52 +2148,52 @@
* after writing 1 the debugger can read the register back to see if
* the feature is supported.
*
- * Writes apply to the new value of \Fhartsel and \FdmDmcontrolHasel.
+ * Writes apply to the new value of {hartsel} and {dmcontrol-hasel}.
*/
-#define DM_DMCONTROL_HARTRESET_OFFSET 0x1d
-#define DM_DMCONTROL_HARTRESET_LENGTH 1
-#define DM_DMCONTROL_HARTRESET 0x20000000
-#define DM_DMCONTROL_ACKHAVERESET_OFFSET 0x1c
-#define DM_DMCONTROL_ACKHAVERESET_LENGTH 1
-#define DM_DMCONTROL_ACKHAVERESET 0x10000000
+#define DM_DMCONTROL_HARTRESET_OFFSET 0x1dULL
+#define DM_DMCONTROL_HARTRESET_LENGTH 1ULL
+#define DM_DMCONTROL_HARTRESET 0x20000000ULL
+#define DM_DMCONTROL_ACKHAVERESET_OFFSET 0x1cULL
+#define DM_DMCONTROL_ACKHAVERESET_LENGTH 1ULL
+#define DM_DMCONTROL_ACKHAVERESET 0x10000000ULL
/*
* nop: No effect.
*/
#define DM_DMCONTROL_ACKHAVERESET_NOP 0
/*
- * ack: Clears {\tt havereset} for any selected harts.
+ * ack: Clears `havereset` for any selected harts.
*/
#define DM_DMCONTROL_ACKHAVERESET_ACK 1
/*
- * Writes apply to the new value of \Fhartsel and \FdmDmcontrolHasel.
+ * Writes apply to the new value of {hartsel} and {dmcontrol-hasel}.
*/
-#define DM_DMCONTROL_ACKUNAVAIL_OFFSET 0x1b
-#define DM_DMCONTROL_ACKUNAVAIL_LENGTH 1
-#define DM_DMCONTROL_ACKUNAVAIL 0x8000000
+#define DM_DMCONTROL_ACKUNAVAIL_OFFSET 0x1bULL
+#define DM_DMCONTROL_ACKUNAVAIL_LENGTH 1ULL
+#define DM_DMCONTROL_ACKUNAVAIL 0x8000000ULL
/*
* nop: No effect.
*/
#define DM_DMCONTROL_ACKUNAVAIL_NOP 0
/*
- * ack: Clears {\tt unavail} for any selected harts that are currently available.
+ * ack: Clears `unavail` for any selected harts that are currently available.
*/
#define DM_DMCONTROL_ACKUNAVAIL_ACK 1
/*
- * Writes apply to the new value of \Fhartsel and \FdmDmcontrolHasel.
+ * Writes apply to the new value of {hartsel} and {dmcontrol-hasel}.
*/
/*
* Selects the definition of currently selected harts.
*/
-#define DM_DMCONTROL_HASEL_OFFSET 0x1a
-#define DM_DMCONTROL_HASEL_LENGTH 1
-#define DM_DMCONTROL_HASEL 0x4000000
+#define DM_DMCONTROL_HASEL_OFFSET 0x1aULL
+#define DM_DMCONTROL_HASEL_LENGTH 1ULL
+#define DM_DMCONTROL_HASEL 0x4000000ULL
/*
- * single: There is a single currently selected hart, that is selected by \Fhartsel.
+ * single: There is a single currently selected hart, that is selected by {hartsel}.
*/
#define DM_DMCONTROL_HASEL_SINGLE 0
/*
* multiple: There may be multiple currently selected harts -- the hart
- * selected by \Fhartsel, plus those selected by the hart array mask
+ * selected by {hartsel}, plus those selected by the hart array mask
* register.
*/
#define DM_DMCONTROL_HASEL_MULTIPLE 1
@@ -2062,62 +2204,62 @@
* is supported.
*/
/*
- * The low 10 bits of \Fhartsel: the DM-specific index of the hart to
+ * The low 10 bits of {hartsel}: the DM-specific index of the hart to
* select. This hart is always part of the currently selected harts.
*/
-#define DM_DMCONTROL_HARTSELLO_OFFSET 0x10
-#define DM_DMCONTROL_HARTSELLO_LENGTH 0xa
-#define DM_DMCONTROL_HARTSELLO 0x3ff0000
+#define DM_DMCONTROL_HARTSELLO_OFFSET 0x10ULL
+#define DM_DMCONTROL_HARTSELLO_LENGTH 0xaULL
+#define DM_DMCONTROL_HARTSELLO 0x3ff0000ULL
/*
- * The high 10 bits of \Fhartsel: the DM-specific index of the hart to
+ * The high 10 bits of {hartsel}: the DM-specific index of the hart to
* select. This hart is always part of the currently selected harts.
*/
-#define DM_DMCONTROL_HARTSELHI_OFFSET 6
-#define DM_DMCONTROL_HARTSELHI_LENGTH 0xa
-#define DM_DMCONTROL_HARTSELHI 0xffc0
+#define DM_DMCONTROL_HARTSELHI_OFFSET 6ULL
+#define DM_DMCONTROL_HARTSELHI_LENGTH 0xaULL
+#define DM_DMCONTROL_HARTSELHI 0xffc0ULL
/*
- * This optional field sets \Fkeepalive for all currently selected
- * harts, unless \FdmDmcontrolClrkeepalive is simultaneously set to
+ * This optional field sets {keepalive} for all currently selected
+ * harts, unless {dmcontrol-clrkeepalive} is simultaneously set to
* 1.
*
- * Writes apply to the new value of \Fhartsel and \FdmDmcontrolHasel.
+ * Writes apply to the new value of {hartsel} and {dmcontrol-hasel}.
*/
-#define DM_DMCONTROL_SETKEEPALIVE_OFFSET 5
-#define DM_DMCONTROL_SETKEEPALIVE_LENGTH 1
-#define DM_DMCONTROL_SETKEEPALIVE 0x20
+#define DM_DMCONTROL_SETKEEPALIVE_OFFSET 5ULL
+#define DM_DMCONTROL_SETKEEPALIVE_LENGTH 1ULL
+#define DM_DMCONTROL_SETKEEPALIVE 0x20ULL
/*
- * This optional field clears \Fkeepalive for all currently selected
+ * This optional field clears {keepalive} for all currently selected
* harts.
*
- * Writes apply to the new value of \Fhartsel and \FdmDmcontrolHasel.
+ * Writes apply to the new value of {hartsel} and {dmcontrol-hasel}.
*/
-#define DM_DMCONTROL_CLRKEEPALIVE_OFFSET 4
-#define DM_DMCONTROL_CLRKEEPALIVE_LENGTH 1
-#define DM_DMCONTROL_CLRKEEPALIVE 0x10
+#define DM_DMCONTROL_CLRKEEPALIVE_OFFSET 4ULL
+#define DM_DMCONTROL_CLRKEEPALIVE_LENGTH 1ULL
+#define DM_DMCONTROL_CLRKEEPALIVE 0x10ULL
/*
* This optional field writes the halt-on-reset request bit for all
- * currently selected harts, unless \FdmDmcontrolClrresethaltreq is
+ * currently selected harts, unless {dmcontrol-clrresethaltreq} is
* simultaneously set to 1.
* When set to 1, each selected hart will halt upon the next deassertion
* of its reset. The halt-on-reset request bit is not automatically
- * cleared. The debugger must write to \FdmDmcontrolClrresethaltreq to clear it.
+ * cleared. The debugger must write to {dmcontrol-clrresethaltreq} to clear it.
*
- * Writes apply to the new value of \Fhartsel and \FdmDmcontrolHasel.
+ * Writes apply to the new value of {hartsel} and {dmcontrol-hasel}.
*
- * If \FdmDmstatusHasresethaltreq is 0, this field is not implemented.
+ * If {dmstatus-hasresethaltreq} is 0, this field is not implemented.
*/
-#define DM_DMCONTROL_SETRESETHALTREQ_OFFSET 3
-#define DM_DMCONTROL_SETRESETHALTREQ_LENGTH 1
-#define DM_DMCONTROL_SETRESETHALTREQ 8
+#define DM_DMCONTROL_SETRESETHALTREQ_OFFSET 3ULL
+#define DM_DMCONTROL_SETRESETHALTREQ_LENGTH 1ULL
+#define DM_DMCONTROL_SETRESETHALTREQ 8ULL
/*
* This optional field clears the halt-on-reset request bit for all
* currently selected harts.
*
- * Writes apply to the new value of \Fhartsel and \FdmDmcontrolHasel.
+ * Writes apply to the new value of {hartsel} and {dmcontrol-hasel}.
*/
-#define DM_DMCONTROL_CLRRESETHALTREQ_OFFSET 2
-#define DM_DMCONTROL_CLRRESETHALTREQ_LENGTH 1
-#define DM_DMCONTROL_CLRRESETHALTREQ 4
+#define DM_DMCONTROL_CLRRESETHALTREQ_OFFSET 2ULL
+#define DM_DMCONTROL_CLRRESETHALTREQ_LENGTH 1ULL
+#define DM_DMCONTROL_CLRRESETHALTREQ 4ULL
/*
* This bit controls the reset signal from the DM to the rest of the
* hardware platform. The signal should reset every part of the hardware platform, including
@@ -2127,26 +2269,26 @@
* and then writes 0
* to deassert the reset.
*/
-#define DM_DMCONTROL_NDMRESET_OFFSET 1
-#define DM_DMCONTROL_NDMRESET_LENGTH 1
-#define DM_DMCONTROL_NDMRESET 2
+#define DM_DMCONTROL_NDMRESET_OFFSET 1ULL
+#define DM_DMCONTROL_NDMRESET_LENGTH 1ULL
+#define DM_DMCONTROL_NDMRESET 2ULL
/*
* This bit serves as a reset signal for the Debug Module itself.
* After changing the value of this bit, the debugger must poll
- * \RdmDmcontrol until \FdmDmcontrolDmactive has taken the requested value
- * before performing any action that assumes the requested \FdmDmcontrolDmactive
+ * {dm-dmcontrol} until {dmcontrol-dmactive} has taken the requested value
+ * before performing any action that assumes the requested {dmcontrol-dmactive}
* state change has completed. Hardware may
* take an arbitrarily long time to complete activation or deactivation and will
- * indicate completion by setting \FdmDmcontrolDmactive to the requested value.
+ * indicate completion by setting {dmcontrol-dmactive} to the requested value.
*/
-#define DM_DMCONTROL_DMACTIVE_OFFSET 0
-#define DM_DMCONTROL_DMACTIVE_LENGTH 1
-#define DM_DMCONTROL_DMACTIVE 1
+#define DM_DMCONTROL_DMACTIVE_OFFSET 0ULL
+#define DM_DMCONTROL_DMACTIVE_LENGTH 1ULL
+#define DM_DMCONTROL_DMACTIVE 1ULL
/*
* inactive: The module's state, including authentication mechanism,
- * takes its reset values (the \FdmDmcontrolDmactive bit is the only bit which can
+ * takes its reset values (the {dmcontrol-dmactive} bit is the only bit which can
* be written to something other than its reset value). Any accesses
- * to the module may fail. Specifically, \FdmDmstatusVersion might not return
+ * to the module may fail. Specifically, {dmstatus-version} might not return
* correct data.
*/
#define DM_DMCONTROL_DMACTIVE_INACTIVE 0
@@ -2158,9 +2300,9 @@
* No other mechanism should exist that may result in resetting the
* Debug Module after power up.
*
- * To place the Debug Module into a known state, a debugger may write 0 to \FdmDmcontrolDmactive,
- * poll until \FdmDmcontrolDmactive is observed 0, write 1 to \FdmDmcontrolDmactive, and
- * poll until \FdmDmcontrolDmactive is observed 1.
+ * To place the Debug Module into a known state, a debugger may write 0 to {dmcontrol-dmactive},
+ * poll until {dmcontrol-dmactive} is observed 0, write 1 to {dmcontrol-dmactive}, and
+ * poll until {dmcontrol-dmactive} is observed 1.
*
* Implementations may pay attention to this bit to further aid
* debugging, for example by preventing the Debug Module from being
@@ -2168,80 +2310,76 @@
*/
#define DM_HARTINFO 0x12
/*
- * Number of {\tt dscratch} registers available for the debugger
- * to use during program buffer execution, starting from \RcsrDscratchZero.
+ * Number of `dscratch` registers available for the debugger
+ * to use during program buffer execution, starting from {csr-dscratch0}.
* The debugger can make no assumptions about the contents of these
* registers between commands.
*/
-#define DM_HARTINFO_NSCRATCH_OFFSET 0x14
-#define DM_HARTINFO_NSCRATCH_LENGTH 4
-#define DM_HARTINFO_NSCRATCH 0xf00000
-#define DM_HARTINFO_DATAACCESS_OFFSET 0x10
-#define DM_HARTINFO_DATAACCESS_LENGTH 1
-#define DM_HARTINFO_DATAACCESS 0x10000
+#define DM_HARTINFO_NSCRATCH_OFFSET 0x14ULL
+#define DM_HARTINFO_NSCRATCH_LENGTH 4ULL
+#define DM_HARTINFO_NSCRATCH 0xf00000ULL
+#define DM_HARTINFO_DATAACCESS_OFFSET 0x10ULL
+#define DM_HARTINFO_DATAACCESS_LENGTH 1ULL
+#define DM_HARTINFO_DATAACCESS 0x10000ULL
/*
- * csr: The {\tt data} registers are shadowed in the hart by CSRs.
+ * csr: The `data` registers are shadowed in the hart by CSRs.
* Each CSR is DXLEN bits in size, and corresponds
- * to a single argument, per Table~\ref{tab:datareg}.
+ * to a single argument, per <<tab:datareg>>.
*/
#define DM_HARTINFO_DATAACCESS_CSR 0
/*
- * memory: The {\tt data} registers are shadowed in the hart's memory map.
+ * memory: The `data` registers are shadowed in the hart's memory map.
* Each register takes up 4 bytes in the memory map.
*/
#define DM_HARTINFO_DATAACCESS_MEMORY 1
/*
- * If \FdmHartinfoDataaccess is 0: Number of CSRs dedicated to
- * shadowing the {\tt data} registers.
- *
- * If \FdmHartinfoDataaccess is 1: Number of 32-bit words in the memory map
- * dedicated to shadowing the {\tt data} registers.
+ * If {hartinfo-dataaccess} is 0: Number of CSRs dedicated to
+ * shadowing the `data` registers.
*
- * If this value is non-zero, then the {tt data} registers must go
- * beyond being MRs and guarantee they each store a single value, that is
- * readable/writable by either side.
+ * If {hartinfo-dataaccess} is 1: Number of 32-bit words in the memory map
+ * dedicated to shadowing the `data` registers.
*
- * Since there are at most 12 {\tt data} registers, the value in this
+ * Since there are at most 12 `data` registers, the value in this
* register must be 12 or smaller.
*/
-#define DM_HARTINFO_DATASIZE_OFFSET 0xc
-#define DM_HARTINFO_DATASIZE_LENGTH 4
-#define DM_HARTINFO_DATASIZE 0xf000
+#define DM_HARTINFO_DATASIZE_OFFSET 0xcULL
+#define DM_HARTINFO_DATASIZE_LENGTH 4ULL
+#define DM_HARTINFO_DATASIZE 0xf000ULL
/*
- * If \FdmHartinfoDataaccess is 0: The number of the first CSR dedicated to
- * shadowing the {\tt data} registers.
+ * If {hartinfo-dataaccess} is 0: The number of the first CSR dedicated to
+ * shadowing the `data` registers.
*
- * If \FdmHartinfoDataaccess is 1: Address of RAM where the data
+ * If {hartinfo-dataaccess} is 1: Address of RAM where the data
* registers are shadowed. This address is sign extended giving a
* range of -2048 to 2047, easily addressed with a load or store using
- * \Xzero as the address register.
+ * `x0` as the address register.
*/
-#define DM_HARTINFO_DATAADDR_OFFSET 0
-#define DM_HARTINFO_DATAADDR_LENGTH 0xc
-#define DM_HARTINFO_DATAADDR 0xfff
+#define DM_HARTINFO_DATAADDR_OFFSET 0ULL
+#define DM_HARTINFO_DATAADDR_LENGTH 0xcULL
+#define DM_HARTINFO_DATAADDR 0xfffULL
#define DM_HAWINDOWSEL 0x14
/*
* The high bits of this field may be tied to 0, depending on how large
- * the array mask register is. E.g.\ on a hardware platform with 48 harts only bit 0
+ * the array mask register is. E.g. on a hardware platform with 48 harts only bit 0
* of this field may actually be writable.
*/
-#define DM_HAWINDOWSEL_HAWINDOWSEL_OFFSET 0
-#define DM_HAWINDOWSEL_HAWINDOWSEL_LENGTH 0xf
-#define DM_HAWINDOWSEL_HAWINDOWSEL 0x7fff
+#define DM_HAWINDOWSEL_HAWINDOWSEL_OFFSET 0ULL
+#define DM_HAWINDOWSEL_HAWINDOWSEL_LENGTH 0xfULL
+#define DM_HAWINDOWSEL_HAWINDOWSEL 0x7fffULL
#define DM_HAWINDOW 0x15
-#define DM_HAWINDOW_MASKDATA_OFFSET 0
-#define DM_HAWINDOW_MASKDATA_LENGTH 0x20
-#define DM_HAWINDOW_MASKDATA 0xffffffffU
+#define DM_HAWINDOW_MASKDATA_OFFSET 0ULL
+#define DM_HAWINDOW_MASKDATA_LENGTH 0x20ULL
+#define DM_HAWINDOW_MASKDATA 0xffffffffULL
#define DM_ABSTRACTCS 0x16
/*
* Size of the Program Buffer, in 32-bit words. Valid sizes are 0 - 16.
*/
-#define DM_ABSTRACTCS_PROGBUFSIZE_OFFSET 0x18
-#define DM_ABSTRACTCS_PROGBUFSIZE_LENGTH 5
-#define DM_ABSTRACTCS_PROGBUFSIZE 0x1f000000
-#define DM_ABSTRACTCS_BUSY_OFFSET 0xc
-#define DM_ABSTRACTCS_BUSY_LENGTH 1
-#define DM_ABSTRACTCS_BUSY 0x1000
+#define DM_ABSTRACTCS_PROGBUFSIZE_OFFSET 0x18ULL
+#define DM_ABSTRACTCS_PROGBUFSIZE_LENGTH 5ULL
+#define DM_ABSTRACTCS_PROGBUFSIZE 0x1f000000ULL
+#define DM_ABSTRACTCS_BUSY_OFFSET 0xcULL
+#define DM_ABSTRACTCS_BUSY_LENGTH 1ULL
+#define DM_ABSTRACTCS_BUSY 0x1000ULL
/*
* ready: There is no abstract command currently being executed.
*/
@@ -2251,7 +2389,7 @@
*/
#define DM_ABSTRACTCS_BUSY_BUSY 1
/*
- * This bit is set as soon as \RdmCommand is written, and is
+ * This bit is set as soon as {dm-command} is written, and is
* not cleared until that command has completed.
*/
/*
@@ -2262,9 +2400,9 @@
* permission checks (e.g. PMP restrictions are ignored). The
* details of the latter are implementation-specific.
*/
-#define DM_ABSTRACTCS_RELAXEDPRIV_OFFSET 0xb
-#define DM_ABSTRACTCS_RELAXEDPRIV_LENGTH 1
-#define DM_ABSTRACTCS_RELAXEDPRIV 0x800
+#define DM_ABSTRACTCS_RELAXEDPRIV_OFFSET 0xbULL
+#define DM_ABSTRACTCS_RELAXEDPRIV_LENGTH 1ULL
+#define DM_ABSTRACTCS_RELAXEDPRIV 0x800ULL
/*
* full checks: Full permission checks apply.
*/
@@ -2278,24 +2416,24 @@
* they are cleared by writing 1 to them. No abstract command is
* started until the value is reset to 0.
*
- * This field only contains a valid value if \FdmAbstractcsBusy is 0.
+ * This field only contains a valid value if {abstractcs-busy} is 0.
*/
-#define DM_ABSTRACTCS_CMDERR_OFFSET 8
-#define DM_ABSTRACTCS_CMDERR_LENGTH 3
-#define DM_ABSTRACTCS_CMDERR 0x700
+#define DM_ABSTRACTCS_CMDERR_OFFSET 8ULL
+#define DM_ABSTRACTCS_CMDERR_LENGTH 3ULL
+#define DM_ABSTRACTCS_CMDERR 0x700ULL
/*
* none: No error.
*/
#define DM_ABSTRACTCS_CMDERR_NONE 0
/*
- * busy: An abstract command was executing while \RdmCommand,
- * \RdmAbstractcs, or \RdmAbstractauto was written, or when one
- * of the {\tt data} or {\tt progbuf} registers was read or written.
- * This status is only written if \FdmAbstractcsCmderr contains 0.
+ * busy: An abstract command was executing while {dm-command},
+ * {dm-abstractcs}, or {dm-abstractauto} was written, or when one
+ * of the `data` or `progbuf` registers was read or written.
+ * This status is only written if {abstractcs-cmderr} contains 0.
*/
#define DM_ABSTRACTCS_CMDERR_BUSY 1
/*
- * not supported: The command in \RdmCommand is not supported. It
+ * not supported: The command in {dm-command} is not supported. It
* may be supported with different options set, but it will not be
* supported at a later time when the hart or system state are
* different.
@@ -2303,7 +2441,7 @@
#define DM_ABSTRACTCS_CMDERR_NOT_SUPPORTED 2
/*
* exception: An exception occurred while executing the command
- * (e.g.\ while executing the Program Buffer).
+ * (e.g. while executing the Program Buffer).
*/
#define DM_ABSTRACTCS_CMDERR_EXCEPTION 3
/*
@@ -2312,7 +2450,7 @@
*/
#define DM_ABSTRACTCS_CMDERR_HALT_RESUME 4
/*
- * bus: The abstract command failed due to a bus error (e.g.\
+ * bus: The abstract command failed due to a bus error (e.g.
* alignment, access size, or timeout).
*/
#define DM_ABSTRACTCS_CMDERR_BUS 5
@@ -2325,70 +2463,70 @@
*/
#define DM_ABSTRACTCS_CMDERR_OTHER 7
/*
- * Number of {\tt data} registers that are implemented as part of the
+ * Number of `data` registers that are implemented as part of the
* abstract command interface. Valid sizes are 1 -- 12.
*/
-#define DM_ABSTRACTCS_DATACOUNT_OFFSET 0
-#define DM_ABSTRACTCS_DATACOUNT_LENGTH 4
-#define DM_ABSTRACTCS_DATACOUNT 0xf
+#define DM_ABSTRACTCS_DATACOUNT_OFFSET 0ULL
+#define DM_ABSTRACTCS_DATACOUNT_LENGTH 4ULL
+#define DM_ABSTRACTCS_DATACOUNT 0xfULL
#define DM_COMMAND 0x17
/*
* The type determines the overall functionality of this
* abstract command.
*/
-#define DM_COMMAND_CMDTYPE_OFFSET 0x18
-#define DM_COMMAND_CMDTYPE_LENGTH 8
-#define DM_COMMAND_CMDTYPE 0xff000000U
+#define DM_COMMAND_CMDTYPE_OFFSET 0x18ULL
+#define DM_COMMAND_CMDTYPE_LENGTH 8ULL
+#define DM_COMMAND_CMDTYPE 0xff000000ULL
/*
* This field is interpreted in a command-specific manner,
* described for each abstract command.
*/
-#define DM_COMMAND_CONTROL_OFFSET 0
-#define DM_COMMAND_CONTROL_LENGTH 0x18
-#define DM_COMMAND_CONTROL 0xffffff
+#define DM_COMMAND_CONTROL_OFFSET 0ULL
+#define DM_COMMAND_CONTROL_LENGTH 0x18ULL
+#define DM_COMMAND_CONTROL 0xffffffULL
#define DM_ABSTRACTAUTO 0x18
/*
* When a bit in this field is 1, read or write accesses to the
- * corresponding {\tt progbuf} word cause the DM to act as if the
- * current value in \RdmCommand was written there again after the
- * access to {\tt progbuf} completes.
+ * corresponding `progbuf` word cause the DM to act as if the
+ * current value in {dm-command} was written there again after the
+ * access to `progbuf` completes.
*/
-#define DM_ABSTRACTAUTO_AUTOEXECPROGBUF_OFFSET 0x10
-#define DM_ABSTRACTAUTO_AUTOEXECPROGBUF_LENGTH 0x10
-#define DM_ABSTRACTAUTO_AUTOEXECPROGBUF 0xffff0000U
+#define DM_ABSTRACTAUTO_AUTOEXECPROGBUF_OFFSET 0x10ULL
+#define DM_ABSTRACTAUTO_AUTOEXECPROGBUF_LENGTH 0x10ULL
+#define DM_ABSTRACTAUTO_AUTOEXECPROGBUF 0xffff0000ULL
/*
* When a bit in this field is 1, read or write accesses to the
- * corresponding {\tt data} word cause the DM to act as if the current
- * value in \RdmCommand was written there again after the
- * access to {\tt data} completes.
+ * corresponding `data` word cause the DM to act as if the current
+ * value in {dm-command} was written there again after the
+ * access to `data` completes.
*/
-#define DM_ABSTRACTAUTO_AUTOEXECDATA_OFFSET 0
-#define DM_ABSTRACTAUTO_AUTOEXECDATA_LENGTH 0xc
-#define DM_ABSTRACTAUTO_AUTOEXECDATA 0xfff
+#define DM_ABSTRACTAUTO_AUTOEXECDATA_OFFSET 0ULL
+#define DM_ABSTRACTAUTO_AUTOEXECDATA_LENGTH 0xcULL
+#define DM_ABSTRACTAUTO_AUTOEXECDATA 0xfffULL
#define DM_CONFSTRPTR0 0x19
-#define DM_CONFSTRPTR0_ADDR_OFFSET 0
-#define DM_CONFSTRPTR0_ADDR_LENGTH 0x20
-#define DM_CONFSTRPTR0_ADDR 0xffffffffU
+#define DM_CONFSTRPTR0_ADDR_OFFSET 0ULL
+#define DM_CONFSTRPTR0_ADDR_LENGTH 0x20ULL
+#define DM_CONFSTRPTR0_ADDR 0xffffffffULL
#define DM_CONFSTRPTR1 0x1a
-#define DM_CONFSTRPTR1_ADDR_OFFSET 0
-#define DM_CONFSTRPTR1_ADDR_LENGTH 0x20
-#define DM_CONFSTRPTR1_ADDR 0xffffffffU
+#define DM_CONFSTRPTR1_ADDR_OFFSET 0ULL
+#define DM_CONFSTRPTR1_ADDR_LENGTH 0x20ULL
+#define DM_CONFSTRPTR1_ADDR 0xffffffffULL
#define DM_CONFSTRPTR2 0x1b
-#define DM_CONFSTRPTR2_ADDR_OFFSET 0
-#define DM_CONFSTRPTR2_ADDR_LENGTH 0x20
-#define DM_CONFSTRPTR2_ADDR 0xffffffffU
+#define DM_CONFSTRPTR2_ADDR_OFFSET 0ULL
+#define DM_CONFSTRPTR2_ADDR_LENGTH 0x20ULL
+#define DM_CONFSTRPTR2_ADDR 0xffffffffULL
#define DM_CONFSTRPTR3 0x1c
-#define DM_CONFSTRPTR3_ADDR_OFFSET 0
-#define DM_CONFSTRPTR3_ADDR_LENGTH 0x20
-#define DM_CONFSTRPTR3_ADDR 0xffffffffU
+#define DM_CONFSTRPTR3_ADDR_OFFSET 0ULL
+#define DM_CONFSTRPTR3_ADDR_LENGTH 0x20ULL
+#define DM_CONFSTRPTR3_ADDR 0xffffffffULL
#define DM_NEXTDM 0x1d
-#define DM_NEXTDM_ADDR_OFFSET 0
-#define DM_NEXTDM_ADDR_LENGTH 0x20
-#define DM_NEXTDM_ADDR 0xffffffffU
+#define DM_NEXTDM_ADDR_OFFSET 0ULL
+#define DM_NEXTDM_ADDR_LENGTH 0x20ULL
+#define DM_NEXTDM_ADDR 0xffffffffULL
#define DM_DATA0 0x04
-#define DM_DATA0_DATA_OFFSET 0
-#define DM_DATA0_DATA_LENGTH 0x20
-#define DM_DATA0_DATA 0xffffffffU
+#define DM_DATA0_DATA_OFFSET 0ULL
+#define DM_DATA0_DATA_LENGTH 0x20ULL
+#define DM_DATA0_DATA 0xffffffffULL
#define DM_DATA1 0x05
#define DM_DATA2 0x06
#define DM_DATA3 0x07
@@ -2401,9 +2539,9 @@
#define DM_DATA10 0x0e
#define DM_DATA11 0x0f
#define DM_PROGBUF0 0x20
-#define DM_PROGBUF0_DATA_OFFSET 0
-#define DM_PROGBUF0_DATA_LENGTH 0x20
-#define DM_PROGBUF0_DATA 0xffffffffU
+#define DM_PROGBUF0_DATA_OFFSET 0ULL
+#define DM_PROGBUF0_DATA_LENGTH 0x20ULL
+#define DM_PROGBUF0_DATA 0xffffffffULL
#define DM_PROGBUF1 0x21
#define DM_PROGBUF2 0x22
#define DM_PROGBUF3 0x23
@@ -2420,13 +2558,13 @@
#define DM_PROGBUF14 0x2e
#define DM_PROGBUF15 0x2f
#define DM_AUTHDATA 0x30
-#define DM_AUTHDATA_DATA_OFFSET 0
-#define DM_AUTHDATA_DATA_LENGTH 0x20
-#define DM_AUTHDATA_DATA 0xffffffffU
+#define DM_AUTHDATA_DATA_OFFSET 0ULL
+#define DM_AUTHDATA_DATA_LENGTH 0x20ULL
+#define DM_AUTHDATA_DATA 0xffffffffULL
#define DM_DMCS2 0x32
-#define DM_DMCS2_GROUPTYPE_OFFSET 0xb
-#define DM_DMCS2_GROUPTYPE_LENGTH 1
-#define DM_DMCS2_GROUPTYPE 0x800
+#define DM_DMCS2_GROUPTYPE_OFFSET 0xbULL
+#define DM_DMCS2_GROUPTYPE_LENGTH 1ULL
+#define DM_DMCS2_GROUPTYPE 0x800ULL
/*
* halt: The remaining fields in this register configure halt groups.
*/
@@ -2441,17 +2579,17 @@
* If a non-existent trigger value is written here, the hardware will
* change it to a valid one or 0 if no DM external triggers exist.
*/
-#define DM_DMCS2_DMEXTTRIGGER_OFFSET 7
-#define DM_DMCS2_DMEXTTRIGGER_LENGTH 4
-#define DM_DMCS2_DMEXTTRIGGER 0x780
+#define DM_DMCS2_DMEXTTRIGGER_OFFSET 7ULL
+#define DM_DMCS2_DMEXTTRIGGER_LENGTH 4ULL
+#define DM_DMCS2_DMEXTTRIGGER 0x780ULL
/*
- * When \FdmDmcsTwoHgselect is 0, contains the group of the hart
- * specified by \Fhartsel.
+ * When {dmcs2-hgselect} is 0, contains the group of the hart
+ * specified by {hartsel}.
*
- * When \FdmDmcsTwoHgselect is 1, contains the group of the DM external
- * trigger selected by \FdmDmcsTwoDmexttrigger.
+ * When {dmcs2-hgselect} is 1, contains the group of the DM external
+ * trigger selected by {dmcs2-dmexttrigger}.
*
- * The value written to this field is ignored unless \FdmDmcsTwoHgwrite
+ * The value written to this field is ignored unless {dmcs2-hgwrite}
* is also written 1.
*
* Group numbers are contiguous starting at 0, with the highest number
@@ -2461,30 +2599,30 @@
*
* If groups aren't implemented, then this entire field is 0.
*/
-#define DM_DMCS2_GROUP_OFFSET 2
-#define DM_DMCS2_GROUP_LENGTH 5
-#define DM_DMCS2_GROUP 0x7c
+#define DM_DMCS2_GROUP_OFFSET 2ULL
+#define DM_DMCS2_GROUP_LENGTH 5ULL
+#define DM_DMCS2_GROUP 0x7cULL
/*
- * When 1 is written and \FdmDmcsTwoHgselect is 0, for every selected
- * hart the DM will change its group to the value written to \FdmDmcsTwoGroup,
+ * When 1 is written and {dmcs2-hgselect} is 0, for every selected
+ * hart the DM will change its group to the value written to {dmcs2-group},
* if the hardware supports that group for that hart.
* Implementations may also change the group of a minimal set of
* unselected harts in the same way, if that is necessary due to
* a hardware limitation.
*
- * When 1 is written and \FdmDmcsTwoHgselect is 1, the DM will change
- * the group of the DM external trigger selected by \FdmDmcsTwoDmexttrigger
- * to the value written to \FdmDmcsTwoGroup, if the hardware supports
+ * When 1 is written and {dmcs2-hgselect} is 1, the DM will change
+ * the group of the DM external trigger selected by {dmcs2-dmexttrigger}
+ * to the value written to {dmcs2-group}, if the hardware supports
* that group for that trigger.
*
* Writing 0 has no effect.
*/
-#define DM_DMCS2_HGWRITE_OFFSET 1
-#define DM_DMCS2_HGWRITE_LENGTH 1
-#define DM_DMCS2_HGWRITE 2
-#define DM_DMCS2_HGSELECT_OFFSET 0
-#define DM_DMCS2_HGSELECT_LENGTH 1
-#define DM_DMCS2_HGSELECT 1
+#define DM_DMCS2_HGWRITE_OFFSET 1ULL
+#define DM_DMCS2_HGWRITE_LENGTH 1ULL
+#define DM_DMCS2_HGWRITE 2ULL
+#define DM_DMCS2_HGSELECT_OFFSET 0ULL
+#define DM_DMCS2_HGSELECT_LENGTH 1ULL
+#define DM_DMCS2_HGSELECT 1ULL
/*
* harts: Operate on harts.
*/
@@ -2497,25 +2635,25 @@
* If there are no DM external triggers, this field must be tied to 0.
*/
#define DM_HALTSUM0 0x40
-#define DM_HALTSUM0_HALTSUM0_OFFSET 0
-#define DM_HALTSUM0_HALTSUM0_LENGTH 0x20
-#define DM_HALTSUM0_HALTSUM0 0xffffffffU
+#define DM_HALTSUM0_HALTSUM0_OFFSET 0ULL
+#define DM_HALTSUM0_HALTSUM0_LENGTH 0x20ULL
+#define DM_HALTSUM0_HALTSUM0 0xffffffffULL
#define DM_HALTSUM1 0x13
-#define DM_HALTSUM1_HALTSUM1_OFFSET 0
-#define DM_HALTSUM1_HALTSUM1_LENGTH 0x20
-#define DM_HALTSUM1_HALTSUM1 0xffffffffU
+#define DM_HALTSUM1_HALTSUM1_OFFSET 0ULL
+#define DM_HALTSUM1_HALTSUM1_LENGTH 0x20ULL
+#define DM_HALTSUM1_HALTSUM1 0xffffffffULL
#define DM_HALTSUM2 0x34
-#define DM_HALTSUM2_HALTSUM2_OFFSET 0
-#define DM_HALTSUM2_HALTSUM2_LENGTH 0x20
-#define DM_HALTSUM2_HALTSUM2 0xffffffffU
+#define DM_HALTSUM2_HALTSUM2_OFFSET 0ULL
+#define DM_HALTSUM2_HALTSUM2_LENGTH 0x20ULL
+#define DM_HALTSUM2_HALTSUM2 0xffffffffULL
#define DM_HALTSUM3 0x35
-#define DM_HALTSUM3_HALTSUM3_OFFSET 0
-#define DM_HALTSUM3_HALTSUM3_LENGTH 0x20
-#define DM_HALTSUM3_HALTSUM3 0xffffffffU
+#define DM_HALTSUM3_HALTSUM3_OFFSET 0ULL
+#define DM_HALTSUM3_HALTSUM3_LENGTH 0x20ULL
+#define DM_HALTSUM3_HALTSUM3 0xffffffffULL
#define DM_SBCS 0x38
-#define DM_SBCS_SBVERSION_OFFSET 0x1d
-#define DM_SBCS_SBVERSION_LENGTH 3
-#define DM_SBCS_SBVERSION 0xe0000000U
+#define DM_SBCS_SBVERSION_OFFSET 0x1dULL
+#define DM_SBCS_SBVERSION_LENGTH 3ULL
+#define DM_SBCS_SBVERSION 0xe0000000ULL
/*
* legacy: The System Bus interface conforms to mainline drafts of this
* spec older than 1 January, 2018.
@@ -2531,41 +2669,41 @@
/*
* Set when the debugger attempts to read data while a read is in
* progress, or when the debugger initiates a new access while one is
- * already in progress (while \FdmSbcsSbbusy is set). It remains set until
+ * already in progress (while {sbcs-sbbusy} is set). It remains set until
* it's explicitly cleared by the debugger.
*
* While this field is set, no more system bus accesses can be
* initiated by the Debug Module.
*/
-#define DM_SBCS_SBBUSYERROR_OFFSET 0x16
-#define DM_SBCS_SBBUSYERROR_LENGTH 1
-#define DM_SBCS_SBBUSYERROR 0x400000
+#define DM_SBCS_SBBUSYERROR_OFFSET 0x16ULL
+#define DM_SBCS_SBBUSYERROR_LENGTH 1ULL
+#define DM_SBCS_SBBUSYERROR 0x400000ULL
/*
- * When 1, indicates the system bus master is busy. (Whether the
+ * When 1, indicates the system bus manager is busy. (Whether the
* system bus itself is busy is related, but not the same thing.) This
* bit goes high immediately when a read or write is requested for any
* reason, and does not go low until the access is fully completed.
*
- * Writes to \RdmSbcs while \FdmSbcsSbbusy is high result in undefined
- * behavior. A debugger must not write to \RdmSbcs until it reads
- * \FdmSbcsSbbusy as 0.
+ * Writes to {dm-sbcs} while {sbcs-sbbusy} is high result in undefined
+ * behavior. A debugger must not write to {dm-sbcs} until it reads
+ * {sbcs-sbbusy} as 0.
*/
-#define DM_SBCS_SBBUSY_OFFSET 0x15
-#define DM_SBCS_SBBUSY_LENGTH 1
-#define DM_SBCS_SBBUSY 0x200000
+#define DM_SBCS_SBBUSY_OFFSET 0x15ULL
+#define DM_SBCS_SBBUSY_LENGTH 1ULL
+#define DM_SBCS_SBBUSY 0x200000ULL
/*
- * When 1, every write to \RdmSbaddressZero automatically triggers a
+ * When 1, every write to {dm-sbaddress0} automatically triggers a
* system bus read at the new address.
*/
-#define DM_SBCS_SBREADONADDR_OFFSET 0x14
-#define DM_SBCS_SBREADONADDR_LENGTH 1
-#define DM_SBCS_SBREADONADDR 0x100000
+#define DM_SBCS_SBREADONADDR_OFFSET 0x14ULL
+#define DM_SBCS_SBREADONADDR_LENGTH 1ULL
+#define DM_SBCS_SBREADONADDR 0x100000ULL
/*
* Select the access size to use for system bus accesses.
*/
-#define DM_SBCS_SBACCESS_OFFSET 0x11
-#define DM_SBCS_SBACCESS_LENGTH 3
-#define DM_SBCS_SBACCESS 0xe0000
+#define DM_SBCS_SBACCESS_OFFSET 0x11ULL
+#define DM_SBCS_SBACCESS_LENGTH 3ULL
+#define DM_SBCS_SBACCESS 0xe0000ULL
/*
* 8bit: 8-bit
*/
@@ -2587,35 +2725,35 @@
*/
#define DM_SBCS_SBACCESS_128BIT 4
/*
- * If \FdmSbcsSbaccess has an unsupported value when the DM starts a bus
- * access, the access is not performed and \FdmSbcsSberror is set to 4.
+ * If {sbcs-sbaccess} has an unsupported value when the DM starts a bus
+ * access, the access is not performed and {sbcs-sberror} is set to 4.
*/
/*
- * When 1, {\tt sbaddress} is incremented by the access size (in
- * bytes) selected in \FdmSbcsSbaccess after every system bus access.
+ * When 1, `sbaddress` is incremented by the access size (in
+ * bytes) selected in {sbcs-sbaccess} after every system bus access.
*/
-#define DM_SBCS_SBAUTOINCREMENT_OFFSET 0x10
-#define DM_SBCS_SBAUTOINCREMENT_LENGTH 1
-#define DM_SBCS_SBAUTOINCREMENT 0x10000
+#define DM_SBCS_SBAUTOINCREMENT_OFFSET 0x10ULL
+#define DM_SBCS_SBAUTOINCREMENT_LENGTH 1ULL
+#define DM_SBCS_SBAUTOINCREMENT 0x10000ULL
/*
- * When 1, every read from \RdmSbdataZero automatically triggers a
+ * When 1, every read from {dm-sbdata0} automatically triggers a
* system bus read at the (possibly auto-incremented) address.
*/
-#define DM_SBCS_SBREADONDATA_OFFSET 0xf
-#define DM_SBCS_SBREADONDATA_LENGTH 1
-#define DM_SBCS_SBREADONDATA 0x8000
+#define DM_SBCS_SBREADONDATA_OFFSET 0xfULL
+#define DM_SBCS_SBREADONDATA_LENGTH 1ULL
+#define DM_SBCS_SBREADONDATA 0x8000ULL
/*
* When the Debug Module's system bus
- * master encounters an error, this field gets set. The bits in this
+ * manager encounters an error, this field gets set. The bits in this
* field remain set until they are cleared by writing 1 to them.
* While this field is non-zero, no more system bus accesses can be
* initiated by the Debug Module.
*
* An implementation may report ``Other'' (7) for any error condition.
*/
-#define DM_SBCS_SBERROR_OFFSET 0xc
-#define DM_SBCS_SBERROR_LENGTH 3
-#define DM_SBCS_SBERROR 0x7000
+#define DM_SBCS_SBERROR_OFFSET 0xcULL
+#define DM_SBCS_SBERROR_LENGTH 3ULL
+#define DM_SBCS_SBERROR 0x7000ULL
/*
* none: There was no bus error.
*/
@@ -2644,101 +2782,101 @@
* Width of system bus addresses in bits. (0 indicates there is no bus
* access support.)
*/
-#define DM_SBCS_SBASIZE_OFFSET 5
-#define DM_SBCS_SBASIZE_LENGTH 7
-#define DM_SBCS_SBASIZE 0xfe0
+#define DM_SBCS_SBASIZE_OFFSET 5ULL
+#define DM_SBCS_SBASIZE_LENGTH 7ULL
+#define DM_SBCS_SBASIZE 0xfe0ULL
/*
* 1 when 128-bit system bus accesses are supported.
*/
-#define DM_SBCS_SBACCESS128_OFFSET 4
-#define DM_SBCS_SBACCESS128_LENGTH 1
-#define DM_SBCS_SBACCESS128 0x10
+#define DM_SBCS_SBACCESS128_OFFSET 4ULL
+#define DM_SBCS_SBACCESS128_LENGTH 1ULL
+#define DM_SBCS_SBACCESS128 0x10ULL
/*
* 1 when 64-bit system bus accesses are supported.
*/
-#define DM_SBCS_SBACCESS64_OFFSET 3
-#define DM_SBCS_SBACCESS64_LENGTH 1
-#define DM_SBCS_SBACCESS64 8
+#define DM_SBCS_SBACCESS64_OFFSET 3ULL
+#define DM_SBCS_SBACCESS64_LENGTH 1ULL
+#define DM_SBCS_SBACCESS64 8ULL
/*
* 1 when 32-bit system bus accesses are supported.
*/
-#define DM_SBCS_SBACCESS32_OFFSET 2
-#define DM_SBCS_SBACCESS32_LENGTH 1
-#define DM_SBCS_SBACCESS32 4
+#define DM_SBCS_SBACCESS32_OFFSET 2ULL
+#define DM_SBCS_SBACCESS32_LENGTH 1ULL
+#define DM_SBCS_SBACCESS32 4ULL
/*
* 1 when 16-bit system bus accesses are supported.
*/
-#define DM_SBCS_SBACCESS16_OFFSET 1
-#define DM_SBCS_SBACCESS16_LENGTH 1
-#define DM_SBCS_SBACCESS16 2
+#define DM_SBCS_SBACCESS16_OFFSET 1ULL
+#define DM_SBCS_SBACCESS16_LENGTH 1ULL
+#define DM_SBCS_SBACCESS16 2ULL
/*
* 1 when 8-bit system bus accesses are supported.
*/
-#define DM_SBCS_SBACCESS8_OFFSET 0
-#define DM_SBCS_SBACCESS8_LENGTH 1
-#define DM_SBCS_SBACCESS8 1
+#define DM_SBCS_SBACCESS8_OFFSET 0ULL
+#define DM_SBCS_SBACCESS8_LENGTH 1ULL
+#define DM_SBCS_SBACCESS8 1ULL
#define DM_SBADDRESS0 0x39
/*
- * Accesses bits 31:0 of the physical address in {\tt sbaddress}.
+ * Accesses bits 31:0 of the physical address in `sbaddress`.
*/
-#define DM_SBADDRESS0_ADDRESS_OFFSET 0
-#define DM_SBADDRESS0_ADDRESS_LENGTH 0x20
-#define DM_SBADDRESS0_ADDRESS 0xffffffffU
+#define DM_SBADDRESS0_ADDRESS_OFFSET 0ULL
+#define DM_SBADDRESS0_ADDRESS_LENGTH 0x20ULL
+#define DM_SBADDRESS0_ADDRESS 0xffffffffULL
#define DM_SBADDRESS1 0x3a
/*
- * Accesses bits 63:32 of the physical address in {\tt sbaddress} (if
+ * Accesses bits 63:32 of the physical address in `sbaddress` (if
* the system address bus is that wide).
*/
-#define DM_SBADDRESS1_ADDRESS_OFFSET 0
-#define DM_SBADDRESS1_ADDRESS_LENGTH 0x20
-#define DM_SBADDRESS1_ADDRESS 0xffffffffU
+#define DM_SBADDRESS1_ADDRESS_OFFSET 0ULL
+#define DM_SBADDRESS1_ADDRESS_LENGTH 0x20ULL
+#define DM_SBADDRESS1_ADDRESS 0xffffffffULL
#define DM_SBADDRESS2 0x3b
/*
- * Accesses bits 95:64 of the physical address in {\tt sbaddress} (if
+ * Accesses bits 95:64 of the physical address in `sbaddress` (if
* the system address bus is that wide).
*/
-#define DM_SBADDRESS2_ADDRESS_OFFSET 0
-#define DM_SBADDRESS2_ADDRESS_LENGTH 0x20
-#define DM_SBADDRESS2_ADDRESS 0xffffffffU
+#define DM_SBADDRESS2_ADDRESS_OFFSET 0ULL
+#define DM_SBADDRESS2_ADDRESS_LENGTH 0x20ULL
+#define DM_SBADDRESS2_ADDRESS 0xffffffffULL
#define DM_SBADDRESS3 0x37
/*
- * Accesses bits 127:96 of the physical address in {\tt sbaddress} (if
+ * Accesses bits 127:96 of the physical address in `sbaddress` (if
* the system address bus is that wide).
*/
-#define DM_SBADDRESS3_ADDRESS_OFFSET 0
-#define DM_SBADDRESS3_ADDRESS_LENGTH 0x20
-#define DM_SBADDRESS3_ADDRESS 0xffffffffU
+#define DM_SBADDRESS3_ADDRESS_OFFSET 0ULL
+#define DM_SBADDRESS3_ADDRESS_LENGTH 0x20ULL
+#define DM_SBADDRESS3_ADDRESS 0xffffffffULL
#define DM_SBDATA0 0x3c
/*
- * Accesses bits 31:0 of {\tt sbdata}.
+ * Accesses bits 31:0 of `sbdata`.
*/
-#define DM_SBDATA0_DATA_OFFSET 0
-#define DM_SBDATA0_DATA_LENGTH 0x20
-#define DM_SBDATA0_DATA 0xffffffffU
+#define DM_SBDATA0_DATA_OFFSET 0ULL
+#define DM_SBDATA0_DATA_LENGTH 0x20ULL
+#define DM_SBDATA0_DATA 0xffffffffULL
#define DM_SBDATA1 0x3d
/*
- * Accesses bits 63:32 of {\tt sbdata} (if the system bus is that
+ * Accesses bits 63:32 of `sbdata` (if the system bus is that
* wide).
*/
-#define DM_SBDATA1_DATA_OFFSET 0
-#define DM_SBDATA1_DATA_LENGTH 0x20
-#define DM_SBDATA1_DATA 0xffffffffU
+#define DM_SBDATA1_DATA_OFFSET 0ULL
+#define DM_SBDATA1_DATA_LENGTH 0x20ULL
+#define DM_SBDATA1_DATA 0xffffffffULL
#define DM_SBDATA2 0x3e
/*
- * Accesses bits 95:64 of {\tt sbdata} (if the system bus is that
+ * Accesses bits 95:64 of `sbdata` (if the system bus is that
* wide).
*/
-#define DM_SBDATA2_DATA_OFFSET 0
-#define DM_SBDATA2_DATA_LENGTH 0x20
-#define DM_SBDATA2_DATA 0xffffffffU
+#define DM_SBDATA2_DATA_OFFSET 0ULL
+#define DM_SBDATA2_DATA_LENGTH 0x20ULL
+#define DM_SBDATA2_DATA 0xffffffffULL
#define DM_SBDATA3 0x3f
/*
- * Accesses bits 127:96 of {\tt sbdata} (if the system bus is that
+ * Accesses bits 127:96 of `sbdata` (if the system bus is that
* wide).
*/
-#define DM_SBDATA3_DATA_OFFSET 0
-#define DM_SBDATA3_DATA_LENGTH 0x20
-#define DM_SBDATA3_DATA 0xffffffffU
+#define DM_SBDATA3_DATA_OFFSET 0ULL
+#define DM_SBDATA3_DATA_LENGTH 0x20ULL
+#define DM_SBDATA3_DATA 0xffffffffULL
#define DM_CUSTOM 0x1f
#define DM_CUSTOM0 0x70
#define DM_CUSTOM1 0x71
@@ -2760,18 +2898,18 @@
/*
* Description of what this field is used for.
*/
-#define SHORTNAME_FIELD_OFFSET 0
-#define SHORTNAME_FIELD_LENGTH 8
-#define SHORTNAME_FIELD 0xff
+#define SHORTNAME_FIELD_OFFSET 0ULL
+#define SHORTNAME_FIELD_LENGTH 8ULL
+#define SHORTNAME_FIELD 0xffULL
/*
* This is 0 to indicate Access Register Command.
*/
-#define AC_ACCESS_REGISTER_CMDTYPE_OFFSET 0x18
-#define AC_ACCESS_REGISTER_CMDTYPE_LENGTH 8
-#define AC_ACCESS_REGISTER_CMDTYPE 0xff000000U
-#define AC_ACCESS_REGISTER_AARSIZE_OFFSET 0x14
-#define AC_ACCESS_REGISTER_AARSIZE_LENGTH 3
-#define AC_ACCESS_REGISTER_AARSIZE 0x700000
+#define AC_ACCESS_REGISTER_CMDTYPE_OFFSET 0x18ULL
+#define AC_ACCESS_REGISTER_CMDTYPE_LENGTH 8ULL
+#define AC_ACCESS_REGISTER_CMDTYPE 0xff000000ULL
+#define AC_ACCESS_REGISTER_AARSIZE_OFFSET 0x14ULL
+#define AC_ACCESS_REGISTER_AARSIZE_LENGTH 3ULL
+#define AC_ACCESS_REGISTER_AARSIZE 0x700000ULL
/*
* 32bit: Access the lowest 32 bits of the register.
*/
@@ -2785,36 +2923,36 @@
*/
#define AC_ACCESS_REGISTER_AARSIZE_128BIT 4
/*
- * If \FacAccessregisterAarsize specifies a size larger than the register's actual size,
- * then the access must fail. If a register is accessible, then reads of \FacAccessregisterAarsize
+ * If {accessregister-aarsize} specifies a size larger than the register's actual size,
+ * then the access must fail. If a register is accessible, then reads of {accessregister-aarsize}
* less than or equal to the register's actual size must be supported.
* Writing less than the full register may be supported, but what
- * happens to the high bits in that case is \unspecified.
+ * happens to the high bits in that case is UNSPECIFIED.
*
* This field controls the Argument Width as referenced in
- * Table~\ref{tab:datareg}.
+ * xref:tab:datareg[].
*/
-#define AC_ACCESS_REGISTER_AARPOSTINCREMENT_OFFSET 0x13
-#define AC_ACCESS_REGISTER_AARPOSTINCREMENT_LENGTH 1
-#define AC_ACCESS_REGISTER_AARPOSTINCREMENT 0x80000
+#define AC_ACCESS_REGISTER_AARPOSTINCREMENT_OFFSET 0x13ULL
+#define AC_ACCESS_REGISTER_AARPOSTINCREMENT_LENGTH 1ULL
+#define AC_ACCESS_REGISTER_AARPOSTINCREMENT 0x80000ULL
/*
* disabled: No effect. This variant must be supported.
*/
#define AC_ACCESS_REGISTER_AARPOSTINCREMENT_DISABLED 0
/*
- * enabled: After a successful register access, \FacAccessregisterRegno is
+ * enabled: After a successful register access, {accessregister-regno} is
* incremented. Incrementing past the highest supported value
- * causes \FacAccessregisterRegno to become \unspecified. Supporting
+ * causes {accessregister-regno} to become UNSPECIFIED. Supporting
* this variant is optional. It is undefined whether the increment
- * happens when \FacAccessregisterTransfer is 0.
+ * happens when {accessregister-transfer} is 0.
*/
#define AC_ACCESS_REGISTER_AARPOSTINCREMENT_ENABLED 1
-#define AC_ACCESS_REGISTER_POSTEXEC_OFFSET 0x12
-#define AC_ACCESS_REGISTER_POSTEXEC_LENGTH 1
-#define AC_ACCESS_REGISTER_POSTEXEC 0x40000
+#define AC_ACCESS_REGISTER_POSTEXEC_OFFSET 0x12ULL
+#define AC_ACCESS_REGISTER_POSTEXEC_LENGTH 1ULL
+#define AC_ACCESS_REGISTER_POSTEXEC 0x40000ULL
/*
* disabled: No effect. This variant must be supported, and is the only
- * supported one if \FdmAbstractcsProgbufsize is 0.
+ * supported one if {abstractcs-progbufsize} is 0.
*/
#define AC_ACCESS_REGISTER_POSTEXEC_DISABLED 0
/*
@@ -2823,83 +2961,83 @@
* optional.
*/
#define AC_ACCESS_REGISTER_POSTEXEC_ENABLED 1
-#define AC_ACCESS_REGISTER_TRANSFER_OFFSET 0x11
-#define AC_ACCESS_REGISTER_TRANSFER_LENGTH 1
-#define AC_ACCESS_REGISTER_TRANSFER 0x20000
+#define AC_ACCESS_REGISTER_TRANSFER_OFFSET 0x11ULL
+#define AC_ACCESS_REGISTER_TRANSFER_LENGTH 1ULL
+#define AC_ACCESS_REGISTER_TRANSFER 0x20000ULL
/*
- * disabled: Don't do the operation specified by \FacAccessregisterWrite.
+ * disabled: Don't do the operation specified by {accessregister-write}.
*/
#define AC_ACCESS_REGISTER_TRANSFER_DISABLED 0
/*
- * enabled: Do the operation specified by \FacAccessregisterWrite.
+ * enabled: Do the operation specified by {accessregister-write}.
*/
#define AC_ACCESS_REGISTER_TRANSFER_ENABLED 1
/*
* This bit can be used to just execute the Program Buffer without
- * having to worry about placing valid values into \FacAccessregisterAarsize or \FacAccessregisterRegno.
+ * having to worry about placing valid values into {accessregister-aarsize} or {accessregister-regno}.
*/
/*
- * When \FacAccessregisterTransfer is set:
+ * When {accessregister-transfer} is set:
*/
-#define AC_ACCESS_REGISTER_WRITE_OFFSET 0x10
-#define AC_ACCESS_REGISTER_WRITE_LENGTH 1
-#define AC_ACCESS_REGISTER_WRITE 0x10000
+#define AC_ACCESS_REGISTER_WRITE_OFFSET 0x10ULL
+#define AC_ACCESS_REGISTER_WRITE_LENGTH 1ULL
+#define AC_ACCESS_REGISTER_WRITE 0x10000ULL
/*
- * arg0: Copy data from the specified register into {\tt arg0} portion
- * of {\tt data}.
+ * arg0: Copy data from the specified register into `arg0` portion
+ * of `data`.
*/
#define AC_ACCESS_REGISTER_WRITE_ARG0 0
/*
- * register: Copy data from {\tt arg0} portion of {\tt data} into the
+ * register: Copy data from `arg0` portion of `data` into the
* specified register.
*/
#define AC_ACCESS_REGISTER_WRITE_REGISTER 1
/*
* Number of the register to access, as described in
- * Table~\ref{tab:regno}.
- * \RcsrDpc may be used as an alias for PC if this command is
+ * xref:tab:regno[].
+ * {csr-dpc} may be used as an alias for PC if this command is
* supported on a non-halted hart.
*/
-#define AC_ACCESS_REGISTER_REGNO_OFFSET 0
-#define AC_ACCESS_REGISTER_REGNO_LENGTH 0x10
-#define AC_ACCESS_REGISTER_REGNO 0xffff
+#define AC_ACCESS_REGISTER_REGNO_OFFSET 0ULL
+#define AC_ACCESS_REGISTER_REGNO_LENGTH 0x10ULL
+#define AC_ACCESS_REGISTER_REGNO 0xffffULL
/*
* This is 1 to indicate Quick Access command.
*/
-#define AC_QUICK_ACCESS_CMDTYPE_OFFSET 0x18
-#define AC_QUICK_ACCESS_CMDTYPE_LENGTH 8
-#define AC_QUICK_ACCESS_CMDTYPE 0xff000000U
+#define AC_QUICK_ACCESS_CMDTYPE_OFFSET 0x18ULL
+#define AC_QUICK_ACCESS_CMDTYPE_LENGTH 8ULL
+#define AC_QUICK_ACCESS_CMDTYPE 0xff000000ULL
/*
* This is 2 to indicate Access Memory Command.
*/
-#define AC_ACCESS_MEMORY_CMDTYPE_OFFSET 0x18
-#define AC_ACCESS_MEMORY_CMDTYPE_LENGTH 8
-#define AC_ACCESS_MEMORY_CMDTYPE 0xff000000U
+#define AC_ACCESS_MEMORY_CMDTYPE_OFFSET 0x18ULL
+#define AC_ACCESS_MEMORY_CMDTYPE_LENGTH 8ULL
+#define AC_ACCESS_MEMORY_CMDTYPE 0xff000000ULL
/*
* An implementation does not have to implement both virtual and
* physical accesses, but it must fail accesses that it doesn't
* support.
*/
-#define AC_ACCESS_MEMORY_AAMVIRTUAL_OFFSET 0x17
-#define AC_ACCESS_MEMORY_AAMVIRTUAL_LENGTH 1
-#define AC_ACCESS_MEMORY_AAMVIRTUAL 0x800000
+#define AC_ACCESS_MEMORY_AAMVIRTUAL_OFFSET 0x17ULL
+#define AC_ACCESS_MEMORY_AAMVIRTUAL_LENGTH 1ULL
+#define AC_ACCESS_MEMORY_AAMVIRTUAL 0x800000ULL
/*
* physical: Addresses are physical (to the hart they are performed on).
*/
#define AC_ACCESS_MEMORY_AAMVIRTUAL_PHYSICAL 0
/*
* virtual: Addresses are virtual, and translated the way they would be from
- * M-mode, with \FcsrMstatusMprv set.
+ * M-mode, with `MPRV` set.
*/
#define AC_ACCESS_MEMORY_AAMVIRTUAL_VIRTUAL 1
/*
* Debug Modules on systems without address translation (i.e. virtual addresses equal physical)
- * may optionally allow \FacAccessmemoryAamvirtual set to 1, which would produce the same result as
- * that same abstract command with \FacAccessmemoryAamvirtual cleared.
+ * may optionally allow {accessmemory-aamvirtual} set to 1, which would produce the same result as
+ * that same abstract command with {accessmemory-aamvirtual} cleared.
*/
-#define AC_ACCESS_MEMORY_AAMSIZE_OFFSET 0x14
-#define AC_ACCESS_MEMORY_AAMSIZE_LENGTH 3
-#define AC_ACCESS_MEMORY_AAMSIZE 0x700000
+#define AC_ACCESS_MEMORY_AAMSIZE_OFFSET 0x14ULL
+#define AC_ACCESS_MEMORY_AAMSIZE_LENGTH 3ULL
+#define AC_ACCESS_MEMORY_AAMSIZE 0x700000ULL
/*
* 8bit: Access the lowest 8 bits of the memory location.
*/
@@ -2922,157 +3060,141 @@
#define AC_ACCESS_MEMORY_AAMSIZE_128BIT 4
/*
* After a memory access has completed, if this bit is 1, increment
- * {\tt arg1} (which contains the address used) by the number of bytes
- * encoded in \FacAccessmemoryAamsize.
+ * `arg1` (which contains the address used) by the number of bytes
+ * encoded in {accessmemory-aamsize}.
*
* Supporting this variant is optional, but highly recommended for
* performance reasons.
*/
-#define AC_ACCESS_MEMORY_AAMPOSTINCREMENT_OFFSET 0x13
-#define AC_ACCESS_MEMORY_AAMPOSTINCREMENT_LENGTH 1
-#define AC_ACCESS_MEMORY_AAMPOSTINCREMENT 0x80000
-#define AC_ACCESS_MEMORY_WRITE_OFFSET 0x10
-#define AC_ACCESS_MEMORY_WRITE_LENGTH 1
-#define AC_ACCESS_MEMORY_WRITE 0x10000
+#define AC_ACCESS_MEMORY_AAMPOSTINCREMENT_OFFSET 0x13ULL
+#define AC_ACCESS_MEMORY_AAMPOSTINCREMENT_LENGTH 1ULL
+#define AC_ACCESS_MEMORY_AAMPOSTINCREMENT 0x80000ULL
+#define AC_ACCESS_MEMORY_WRITE_OFFSET 0x10ULL
+#define AC_ACCESS_MEMORY_WRITE_LENGTH 1ULL
+#define AC_ACCESS_MEMORY_WRITE 0x10000ULL
/*
- * arg0: Copy data from the memory location specified in {\tt arg1} into
- * the low bits of {\tt arg0}. The value of the remaining bits of
- * {\tt arg0} are \unspecified.
+ * arg0: Copy data from the memory location specified in `arg1` into
+ * the low bits of `arg0`. The value of the remaining bits of
+ * `arg0` are UNSPECIFIED.
*/
#define AC_ACCESS_MEMORY_WRITE_ARG0 0
/*
- * memory: Copy data from the low bits of {\tt arg0} into the memory
- * location specified in {\tt arg1}.
+ * memory: Copy data from the low bits of `arg0` into the memory
+ * location specified in `arg1`.
*/
#define AC_ACCESS_MEMORY_WRITE_MEMORY 1
/*
* These bits are reserved for target-specific uses.
*/
-#define AC_ACCESS_MEMORY_TARGET_SPECIFIC_OFFSET 0xe
-#define AC_ACCESS_MEMORY_TARGET_SPECIFIC_LENGTH 2
-#define AC_ACCESS_MEMORY_TARGET_SPECIFIC 0xc000
+#define AC_ACCESS_MEMORY_TARGET_SPECIFIC_OFFSET 0xeULL
+#define AC_ACCESS_MEMORY_TARGET_SPECIFIC_LENGTH 2ULL
+#define AC_ACCESS_MEMORY_TARGET_SPECIFIC 0xc000ULL
#define VIRT_PRIV virtual
/*
* Contains the virtualization mode the hart was operating in when Debug
- * Mode was entered. The encoding is described in Table \ref{tab:privmode},
+ * Mode was entered. The encoding is described in <<tab:privmode>>,
* and matches the virtualization mode encoding from the Privileged Spec.
* A user can write this value to change the hart's virtualization mode
* when exiting Debug Mode.
*/
-#define VIRT_PRIV_V_OFFSET 2
-#define VIRT_PRIV_V_LENGTH 1
-#define VIRT_PRIV_V 4
+#define VIRT_PRIV_V_OFFSET 2ULL
+#define VIRT_PRIV_V_LENGTH 1ULL
+#define VIRT_PRIV_V 4ULL
/*
* Contains the privilege mode the hart was operating in when Debug
- * Mode was entered. The encoding is described in Table
- * \ref{tab:privmode}, and matches the privilege mode encoding from
+ * Mode was entered. The encoding is described in <<tab:privmode>>, and matches the privilege mode encoding from
* the Privileged Spec. A user can write this
* value to change the hart's privilege mode when exiting Debug Mode.
*/
-#define VIRT_PRIV_PRV_OFFSET 0
-#define VIRT_PRIV_PRV_LENGTH 2
-#define VIRT_PRIV_PRV 3
-#define DMI_SERCS 0x34
-/*
- * Number of supported serial ports.
- */
-#define DMI_SERCS_SERIALCOUNT_OFFSET 0x1c
-#define DMI_SERCS_SERIALCOUNT_LENGTH 4
-#define DMI_SERCS_SERIALCOUNT 0xf0000000U
-/*
- * Select which serial port is accessed by \RdmiSerrx and \RdmiSertx.
- */
-#define DMI_SERCS_SERIAL_OFFSET 0x18
-#define DMI_SERCS_SERIAL_LENGTH 3
-#define DMI_SERCS_SERIAL 0x7000000
-#define DMI_SERCS_ERROR7_OFFSET 0x17
-#define DMI_SERCS_ERROR7_LENGTH 1
-#define DMI_SERCS_ERROR7 0x800000
-#define DMI_SERCS_VALID7_OFFSET 0x16
-#define DMI_SERCS_VALID7_LENGTH 1
-#define DMI_SERCS_VALID7 0x400000
-#define DMI_SERCS_FULL7_OFFSET 0x15
-#define DMI_SERCS_FULL7_LENGTH 1
-#define DMI_SERCS_FULL7 0x200000
-#define DMI_SERCS_ERROR6_OFFSET 0x14
-#define DMI_SERCS_ERROR6_LENGTH 1
-#define DMI_SERCS_ERROR6 0x100000
-#define DMI_SERCS_VALID6_OFFSET 0x13
-#define DMI_SERCS_VALID6_LENGTH 1
-#define DMI_SERCS_VALID6 0x80000
-#define DMI_SERCS_FULL6_OFFSET 0x12
-#define DMI_SERCS_FULL6_LENGTH 1
-#define DMI_SERCS_FULL6 0x40000
-#define DMI_SERCS_ERROR5_OFFSET 0x11
-#define DMI_SERCS_ERROR5_LENGTH 1
-#define DMI_SERCS_ERROR5 0x20000
-#define DMI_SERCS_VALID5_OFFSET 0x10
-#define DMI_SERCS_VALID5_LENGTH 1
-#define DMI_SERCS_VALID5 0x10000
-#define DMI_SERCS_FULL5_OFFSET 0xf
-#define DMI_SERCS_FULL5_LENGTH 1
-#define DMI_SERCS_FULL5 0x8000
-#define DMI_SERCS_ERROR4_OFFSET 0xe
-#define DMI_SERCS_ERROR4_LENGTH 1
-#define DMI_SERCS_ERROR4 0x4000
-#define DMI_SERCS_VALID4_OFFSET 0xd
-#define DMI_SERCS_VALID4_LENGTH 1
-#define DMI_SERCS_VALID4 0x2000
-#define DMI_SERCS_FULL4_OFFSET 0xc
-#define DMI_SERCS_FULL4_LENGTH 1
-#define DMI_SERCS_FULL4 0x1000
-#define DMI_SERCS_ERROR3_OFFSET 0xb
-#define DMI_SERCS_ERROR3_LENGTH 1
-#define DMI_SERCS_ERROR3 0x800
-#define DMI_SERCS_VALID3_OFFSET 0xa
-#define DMI_SERCS_VALID3_LENGTH 1
-#define DMI_SERCS_VALID3 0x400
-#define DMI_SERCS_FULL3_OFFSET 9
-#define DMI_SERCS_FULL3_LENGTH 1
-#define DMI_SERCS_FULL3 0x200
-#define DMI_SERCS_ERROR2_OFFSET 8
-#define DMI_SERCS_ERROR2_LENGTH 1
-#define DMI_SERCS_ERROR2 0x100
-#define DMI_SERCS_VALID2_OFFSET 7
-#define DMI_SERCS_VALID2_LENGTH 1
-#define DMI_SERCS_VALID2 0x80
-#define DMI_SERCS_FULL2_OFFSET 6
-#define DMI_SERCS_FULL2_LENGTH 1
-#define DMI_SERCS_FULL2 0x40
-#define DMI_SERCS_ERROR1_OFFSET 5
-#define DMI_SERCS_ERROR1_LENGTH 1
-#define DMI_SERCS_ERROR1 0x20
-#define DMI_SERCS_VALID1_OFFSET 4
-#define DMI_SERCS_VALID1_LENGTH 1
-#define DMI_SERCS_VALID1 0x10
-#define DMI_SERCS_FULL1_OFFSET 3
-#define DMI_SERCS_FULL1_LENGTH 1
-#define DMI_SERCS_FULL1 8
-/*
- * 1 when the debugger-to-core queue for serial port 0 has
- * over or underflowed. This bit will remain set until it is reset by
- * writing 1 to this bit.
- */
-#define DMI_SERCS_ERROR0_OFFSET 2
-#define DMI_SERCS_ERROR0_LENGTH 1
-#define DMI_SERCS_ERROR0 4
-/*
- * 1 when the core-to-debugger queue for serial port 0 is not empty.
- */
-#define DMI_SERCS_VALID0_OFFSET 1
-#define DMI_SERCS_VALID0_LENGTH 1
-#define DMI_SERCS_VALID0 2
-/*
- * 1 when the debugger-to-core queue for serial port 0 is full.
- */
-#define DMI_SERCS_FULL0_OFFSET 0
-#define DMI_SERCS_FULL0_LENGTH 1
-#define DMI_SERCS_FULL0 1
-#define DMI_SERTX 0x35
-#define DMI_SERTX_DATA_OFFSET 0
-#define DMI_SERTX_DATA_LENGTH 0x20
-#define DMI_SERTX_DATA 0xffffffffU
-#define DMI_SERRX 0x36
-#define DMI_SERRX_DATA_OFFSET 0
-#define DMI_SERRX_DATA_LENGTH 0x20
-#define DMI_SERRX_DATA 0xffffffffU
+#define VIRT_PRIV_PRV_OFFSET 0ULL
+#define VIRT_PRIV_PRV_LENGTH 2ULL
+#define VIRT_PRIV_PRV 3ULL
+enum riscv_debug_reg_ordinal {
+ DTM_IDCODE_ORDINAL,
+ DTM_DTMCS_ORDINAL,
+ DTM_DMI_ORDINAL,
+ DTM_BYPASS_ORDINAL,
+ CSR_DCSR_ORDINAL,
+ CSR_DPC_ORDINAL,
+ CSR_DSCRATCH0_ORDINAL,
+ CSR_DSCRATCH1_ORDINAL,
+ CSR_TSELECT_ORDINAL,
+ CSR_TDATA1_ORDINAL,
+ CSR_TDATA2_ORDINAL,
+ CSR_TDATA3_ORDINAL,
+ CSR_TINFO_ORDINAL,
+ CSR_TCONTROL_ORDINAL,
+ CSR_SCONTEXT_ORDINAL,
+ CSR_MCONTEXT_ORDINAL,
+ CSR_MCONTROL_ORDINAL,
+ CSR_MCONTROL6_ORDINAL,
+ CSR_ICOUNT_ORDINAL,
+ CSR_ITRIGGER_ORDINAL,
+ CSR_ETRIGGER_ORDINAL,
+ CSR_TMEXTTRIGGER_ORDINAL,
+ CSR_TEXTRA32_ORDINAL,
+ CSR_TEXTRA64_ORDINAL,
+ DM_DMSTATUS_ORDINAL,
+ DM_DMCONTROL_ORDINAL,
+ DM_HARTINFO_ORDINAL,
+ DM_HAWINDOWSEL_ORDINAL,
+ DM_HAWINDOW_ORDINAL,
+ DM_ABSTRACTCS_ORDINAL,
+ DM_COMMAND_ORDINAL,
+ DM_ABSTRACTAUTO_ORDINAL,
+ DM_CONFSTRPTR0_ORDINAL,
+ DM_CONFSTRPTR1_ORDINAL,
+ DM_CONFSTRPTR2_ORDINAL,
+ DM_CONFSTRPTR3_ORDINAL,
+ DM_NEXTDM_ORDINAL,
+ DM_DATA0_ORDINAL,
+ DM_PROGBUF0_ORDINAL,
+ DM_AUTHDATA_ORDINAL,
+ DM_DMCS2_ORDINAL,
+ DM_HALTSUM0_ORDINAL,
+ DM_HALTSUM1_ORDINAL,
+ DM_HALTSUM2_ORDINAL,
+ DM_HALTSUM3_ORDINAL,
+ DM_SBCS_ORDINAL,
+ DM_SBADDRESS0_ORDINAL,
+ DM_SBADDRESS1_ORDINAL,
+ DM_SBADDRESS2_ORDINAL,
+ DM_SBADDRESS3_ORDINAL,
+ DM_SBDATA0_ORDINAL,
+ DM_SBDATA1_ORDINAL,
+ DM_SBDATA2_ORDINAL,
+ DM_SBDATA3_ORDINAL,
+ SHORTNAME_ORDINAL,
+ AC_ACCESS_REGISTER_ORDINAL,
+ AC_QUICK_ACCESS_ORDINAL,
+ AC_ACCESS_MEMORY_ORDINAL,
+ VIRT_PRIV_ORDINAL
+};
+typedef struct {
+ struct {
+ unsigned int value; int is_set;
+ } DXLEN;
+ struct {
+ unsigned int value; int is_set;
+ } XLEN;
+ struct {
+ unsigned int value; int is_set;
+ } abits;
+} riscv_debug_reg_ctx_t;
+
+typedef struct {
+ const char *name;
+ unsigned int lsb; // inclusive
+ unsigned int msb; // inclusive
+ const char **values; // If non-NULL, array of human-readable string for each possible value
+} riscv_debug_reg_field_info_t;
+typedef struct riscv_debug_reg_field_list_t {
+ riscv_debug_reg_field_info_t field;
+ struct riscv_debug_reg_field_list_t (*get_next)(riscv_debug_reg_ctx_t context);
+} riscv_debug_reg_field_list_t;
+typedef struct {
+ const char *name;
+ struct riscv_debug_reg_field_list_t (* const get_fields_head)(riscv_debug_reg_ctx_t context);
+} riscv_debug_reg_info_t;
+riscv_debug_reg_info_t get_riscv_debug_reg_info(enum riscv_debug_reg_ordinal reg_ordinal);
+#endif