瀏覽代碼

doc: font italic for reserved fields

luojia65 3 年之前
父節點
當前提交
ca2ccb3eb2
共有 2 個文件被更改,包括 6 次插入6 次删除
  1. 3 3
      src/hsm.rs
  2. 3 3
      src/pmu.rs

+ 3 - 3
src/hsm.rs

@@ -158,12 +158,12 @@ pub trait Hsm: Send {
     /// | Value                   | Description
     /// |:------------------------|:--------------
     /// | 0x00000000              | Default retentive suspend
-    /// | 0x00000001 - 0x0FFFFFFF | Reserved for future use
+    /// | 0x00000001 - 0x0FFFFFFF | _Reserved for future use_
     /// | 0x10000000 - 0x7FFFFFFF | Platform specific retentive suspend
     /// | 0x80000000              | Default non-retentive suspend
-    /// | 0x80000001 - 0x8FFFFFFF | Reserved for future use
+    /// | 0x80000001 - 0x8FFFFFFF | _Reserved for future use_
     /// | 0x90000000 - 0xFFFFFFFF | Platform specific non-retentive suspend
-    /// | > 0xFFFFFFFF            | Reserved (and non-existent on RV32)
+    /// | > 0xFFFFFFFF            | _Reserved (and non-existent on RV32)_
     ///
     /// The `resume_addr` parameter points to a runtime-specified physical address,
     /// where the hart can resume execution in supervisor-mode after a non-retentive

+ 3 - 3
src/pmu.rs

@@ -88,7 +88,7 @@ pub trait Pmu: Send {
     /// | SBI_PMU_CFG_FLAG_SET_UINH    | 5:5        | Event counting inhibited in U-mode
     /// | SBI_PMU_CFG_FLAG_SET_SINH    | 6:6        | Event counting inhibited in S-mode
     /// | SBI_PMU_CFG_FLAG_SET_MINH    | 7:7        | Event counting inhibited in M-mode
-    /// | *RESERVED*                   | 8:(XLEN-1) | All non-zero values are reserved for future use.
+    /// | _RESERVED_                   | 8:(XLEN-1) | _All non-zero values are reserved for future use._
     ///
     /// *NOTE:* When *SBI_PMU_CFG_FLAG_SKIP_MATCH* is set in `config_flags`, the
     /// SBI implementation will unconditionally select the first counter from the
@@ -132,7 +132,7 @@ pub trait Pmu: Send {
     /// | Flag Name                    | Bits       | Description
     /// |:-----------------------------|:-----------|:------------
     /// | SBI_PMU_START_SET_INIT_VALUE | 0:0        | Set the value of counters based on the `initial_value` parameter.
-    /// | *RESERVED*                   | 1:(XLEN-1) | All non-zero values are reserved for future use.
+    /// | _RESERVED_                   | 1:(XLEN-1) | _All non-zero values are reserved for future use._
     ///
     /// *NOTE*: When `SBI_PMU_START_SET_INIT_VALUE` is not set in `start_flags`, the counter value will
     /// not be modified and event counting will start from current counter value.
@@ -163,7 +163,7 @@ pub trait Pmu: Send {
     /// | Flag Name               | Bits       | Description
     /// |:------------------------|:-----------|:------------
     /// | SBI_PMU_STOP_FLAG_RESET | 0:0        | Reset the counter to event mapping.
-    /// | *RESERVED*              | 1:(XLEN-1) | All non-zero values are reserved for future use.
+    /// | _RESERVED_              | 1:(XLEN-1) | *All non-zero values are reserved for future use.*
     ///
     /// # Return value
     ///