udb 0.1.13 → 0.1.15

data/.data/spec/std/isa/param/HPM_EVENTS.yaml

@@ -28,9 +28,6 @@ definedBy:
           - name: HPM_COUNTER_EN
             index: 4
             equal: true
-          - name: HPM_COUNTER_EN
-            index: 4
-            equal: true
           - name: HPM_COUNTER_EN
             index: 5
             equal: true

data/.data/spec/std/isa/param/HSTATEEN_CONTEXT_TYPE.yaml

@@ -19,6 +19,7 @@ schema:
     - rw
     - read-only-0
     - read-only-1
+  default: rw
 requirements:
   idl(): |
     MSTATEEN_CONTEXT_TYPE == "read-only-0" -> HSTATEEN_CONTEXT_TYPE == "read-only-0";

data/.data/spec/std/isa/param/MCOUNTENABLE_EN.yaml

@@ -27,6 +27,14 @@ definedBy:
     name: Sm
 requirements:
   idl(): |
+    for (U32 i = 0; i < 3; i++) {
+      !implemented?(ExtensionName::Zicntr) -> !MCOUNTENABLE_EN[i];
+    }
     for (U32 i=3; i < 32; i++) {
+      !implemented?(ExtensionName::Zihpm) -> !MCOUNTENABLE_EN[i];
       MCOUNTENABLE_EN[i] -> HPM_COUNTER_EN[i];
     }
+  reason: |
+    Counters 0-2 are defined by Zicntr
+    Counters 3..31 are defined by Zihpm
+    When mhpmcounter[i] is not implemented, it cannot be enabled.

data/.data/spec/std/isa/param/MSTATEEN_CONTEXT_TYPE.yaml

@@ -19,6 +19,7 @@ schema:
     - rw
     - read-only-0
     - read-only-1
+  default: rw
 definedBy:
   extension:
     allOf:

data/.data/spec/std/isa/param/MTVEC_BASE_ALIGNMENT_DIRECT.yaml

@@ -25,72 +25,79 @@ description: |
   the base, the minimum alignment cannot be less than 4.
 schema:
   description: An unsigned power of 2 greater than or equal to 4 that fits in 64 bits
+  default: 0x4
   enum:
     [
-      4,
-      8,
-      16,
-      32,
-      64,
-      128,
-      256,
-      512,
-      1024,
-      2048,
-      4095,
-      8192,
-      16384,
-      32768,
-      65536,
-      131072,
-      262144,
-      524288,
-      1048576,
-      2097152,
-      4194304,
-      8388608,
-      16777216,
-      33554432,
-      67108864,
-      134217728,
-      268435456,
-      536870912,
-      1073741824,
-      2147483648,
-      4294967296,
-      8589934592,
-      17179869184,
-      34359738368,
-      68719476736,
-      137438953472,
-      274877906944,
-      549755813888,
-      1099511627776,
-      2199023255552,
-      4398046511104,
-      8796093022208,
-      17592186044416,
-      35184372088832,
-      70368744177664,
-      140737488355328,
-      281474976710656,
-      562949953421312,
-      1125899906842624,
-      2251799813685248,
-      4503599627370496,
-      9007199254740992,
-      18014398509481984,
-      36028797018963968,
-      72057594037927936,
-      144115188075855872,
-      288230376151711744,
-      576460752303423488,
-      1152921504606846976,
-      2305843009213693952,
-      4611686018427387904,
-      9223372036854775808,
+      0x4,
+      0x8,
+      0x10,
+      0x20,
+      0x40,
+      0x80,
+      0x100,
+      0x200,
+      0x400,
+      0x800,
+      0x1000,
+      0x2000,
+      0x4000,
+      0x8000,
+      0x10000,
+      0x20000,
+      0x40000,
+      0x80000,
+      0x100000,
+      0x200000,
+      0x400000,
+      0x800000,
+      0x1000000,
+      0x2000000,
+      0x4000000,
+      0x8000000,
+      0x10000000,
+      0x20000000,
+      0x40000000,
+      0x80000000,
+      0x100000000,
+      0x200000000,
+      0x400000000,
+      0x800000000,
+      0x1000000000,
+      0x2000000000,
+      0x4000000000,
+      0x8000000000,
+      0x10000000000,
+      0x20000000000,
+      0x40000000000,
+      0x80000000000,
+      0x100000000000,
+      0x200000000000,
+      0x400000000000,
+      0x800000000000,
+      0x1000000000000,
+      0x2000000000000,
+      0x4000000000000,
+      0x8000000000000,
+      0x10000000000000,
+      0x20000000000000,
+      0x40000000000000,
+      0x80000000000000,
+      0x100000000000000,
+      0x200000000000000,
+      0x400000000000000,
+      0x800000000000000,
+      0x1000000000000000,
+      0x2000000000000000,
+      0x4000000000000000,
+      0x8000000000000000,
     ]
 
 requirements:
-  idl(): |
-    (MXLEN == 32) -> MTVEC_BASE_ALIGNMENT_DIRECT <= 2147483648;
+  if:
+    param:
+      name: MXLEN
+      equal: 32
+  then:
+    param:
+      name: MTVEC_BASE_ALIGNMENT_DIRECT
+      lessThanOrEqual: 0x80000000

data/.data/spec/std/isa/param/MTVEC_BASE_ALIGNMENT_VECTORED.yaml

@@ -25,72 +25,79 @@ description: |
   the base, the minimum alignment cannot be less than 4.
 schema:
   description: An unsigned power of 2 greater than or equal to 4 that fits in 64 bits
+  default: 0x4
   enum:
     [
-      4,
-      8,
-      16,
-      32,
-      64,
-      128,
-      256,
-      512,
-      1024,
-      2048,
-      4095,
-      8192,
-      16384,
-      32768,
-      65536,
-      131072,
-      262144,
-      524288,
-      1048576,
-      2097152,
-      4194304,
-      8388608,
-      16777216,
-      33554432,
-      67108864,
-      134217728,
-      268435456,
-      536870912,
-      1073741824,
-      2147483648,
-      4294967296,
-      8589934592,
-      17179869184,
-      34359738368,
-      68719476736,
-      137438953472,
-      274877906944,
-      549755813888,
-      1099511627776,
-      2199023255552,
-      4398046511104,
-      8796093022208,
-      17592186044416,
-      35184372088832,
-      70368744177664,
-      140737488355328,
-      281474976710656,
-      562949953421312,
-      1125899906842624,
-      2251799813685248,
-      4503599627370496,
-      9007199254740992,
-      18014398509481984,
-      36028797018963968,
-      72057594037927936,
-      144115188075855872,
-      288230376151711744,
-      576460752303423488,
-      1152921504606846976,
-      2305843009213693952,
-      4611686018427387904,
-      9223372036854775808,
+      0x4,
+      0x8,
+      0x10,
+      0x20,
+      0x40,
+      0x80,
+      0x100,
+      0x200,
+      0x400,
+      0x800,
+      0x1000,
+      0x2000,
+      0x4000,
+      0x8000,
+      0x10000,
+      0x20000,
+      0x40000,
+      0x80000,
+      0x100000,
+      0x200000,
+      0x400000,
+      0x800000,
+      0x1000000,
+      0x2000000,
+      0x4000000,
+      0x8000000,
+      0x10000000,
+      0x20000000,
+      0x40000000,
+      0x80000000,
+      0x100000000,
+      0x200000000,
+      0x400000000,
+      0x800000000,
+      0x1000000000,
+      0x2000000000,
+      0x4000000000,
+      0x8000000000,
+      0x10000000000,
+      0x20000000000,
+      0x40000000000,
+      0x80000000000,
+      0x100000000000,
+      0x200000000000,
+      0x400000000000,
+      0x800000000000,
+      0x1000000000000,
+      0x2000000000000,
+      0x4000000000000,
+      0x8000000000000,
+      0x10000000000000,
+      0x20000000000000,
+      0x40000000000000,
+      0x80000000000000,
+      0x100000000000000,
+      0x200000000000000,
+      0x400000000000000,
+      0x800000000000000,
+      0x1000000000000000,
+      0x2000000000000000,
+      0x4000000000000000,
+      0x8000000000000000,
     ]
 
 requirements:
-  idl(): |
-    (MXLEN == 32) -> MTVEC_BASE_ALIGNMENT_VECTORED <= 2147483648;
+  if:
+    param:
+      name: MXLEN
+      equal: 32
+  then:
+    param:
+      name: MTVEC_BASE_ALIGNMENT_VECTORED
+      lessThanOrEqual: 0x80000000

data/.data/spec/std/isa/param/NUM_PMP_ENTRIES.yaml

@@ -7,36 +7,25 @@ $schema: param_schema.json#
 kind: parameter
 name: NUM_PMP_ENTRIES
 description: |
-  Number of implemented PMP entries. Can be any value between 0-64, inclusive.
+  Number of implemented PMP entries.
 
   The architecture mandates that the number of implemented PMP registers
-  must appear to be 0, 16, or 64.
-
-  Therefore, pmp registers will behave as follows according to NUN_PMP_ENTRIES:
-
-  [separator="!"]
-  !===
-  ! NUM_PMP_ENTRIES ! pmpaddr<0-15> / pmpcfg<0-3> ! pmpaddr<16-63> / pmpcfg<4-15>
-  ! 0               ! N                           ! N
-  ! 1-16            ! Y                           ! N
-  ! 17-64           ! Y                           ! Y
-  !===
-
-  ** N = Not implemented; access will cause `IllegalInstruction`
-     if TRAP_ON_UNIMPLEMENTED_CSR is true
-  ** Y = Implemented; access will not cause an exception (from M-mode), but register
-     may be read-only-zero if NUM_PMP_ENTRIES is less than the corresponding register
+  must appear to be 0, 16, or 64, so NUM_PMP_ENTRIES must be one of those values.
+  It directly determines which PMP registers exist: `pmpaddr0`-`pmpaddr<N-1>`
+  and their corresponding `pmpNcfg` fields are implemented, and the rest are
+  not. Accessing an unimplemented PMP register causes an `IllegalInstruction`
+  when TRAP_ON_UNIMPLEMENTED_CSR is true.
 
   [NOTE]
-  `pmpcfgN` for an odd N never exists when XLEN == 64
+  `pmpcfgN` for an odd N never exists when XLEN == 64.
 
-  When NUM_PMP_ENTRIES is not exactly 0, 16, or 64, some extant pmp registers,
-  and associated pmpNcfg, will be read-only zero (but will never cause an exception).
+  An implemented entry may still be read-only zero (but will never cause an exception).
+  The number of entries that are actually usable is given by
+  NUM_USABLE_PMP_ENTRIES.
 long_name: TODO
 schema:
   type: integer
-  minimum: 0
-  maximum: 64
+  enum: [0, 16, 64]
 definedBy:
   extension:
     name: Sm

data/.data/spec/std/isa/param/NUM_USABLE_PMP_ENTRIES.yaml

@@ -0,0 +1,35 @@
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# yaml-language-server: $schema=../../../schemas/param_schema.json
+
+$schema: param_schema.json#
+kind: parameter
+name: NUM_USABLE_PMP_ENTRIES
+description: |
+  Number of implemented PMP entries that are actually usable.
+
+  An implementation may implement PMP entries (NUM_PMP_ENTRIES) but hardwire
+  some of them to zero (read-only zero). Such entries exist -- their
+  `pmpaddrN`/`pmpNcfg` registers are accessible and will not cause an exception
+  from M-mode -- but they cannot be configured to guard a region.
+
+  NUM_USABLE_PMP_ENTRIES gives the number of low-numbered entries that are
+  writable/usable. Entries `0` through `NUM_USABLE_PMP_ENTRIES-1` are usable;
+  entries `NUM_USABLE_PMP_ENTRIES` through `NUM_PMP_ENTRIES-1` are read-only
+  zero.
+
+  Must be between 0 and NUM_PMP_ENTRIES, inclusive.
+long_name: TODO
+schema:
+  type: integer
+  minimum: 0
+  maximum: 64
+definedBy:
+  param:
+    name: NUM_PMP_ENTRIES
+    greaterThan: 0
+requirements:
+  idl(): |
+    NUM_PMP_ENTRIES == 16 -> NUM_USABLE_PMP_ENTRIES <= 16;
+  reason: Usable PMP entries cannot exceed the number of implemented PMP entries

data/.data/spec/std/isa/param/PMP_NA4_SUPPORTED.yaml

@@ -0,0 +1,23 @@
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# yaml-language-server: $schema=../../../schemas/param_schema.json
+
+$schema: param_schema.json#
+kind: parameter
+name: PMP_NA4_SUPPORTED
+description: |
+  Whether or not the Naturally Aligned four-byte (NA4) PMP address matching
+  mode is supported.
+
+long_name: PMP NA4 mode supported
+schema:
+  type: boolean
+definedBy:
+  param:
+    name: NUM_PMP_ENTRIES
+    greaterThan: 0
+requirements:
+  idl(): |
+    PMP_NA4_SUPPORTED -> (PMP_GRANULARITY == 2);
+  reason: NA4 is not valid when the PMP granularity is larger than 4 bytes

data/.data/spec/std/isa/param/{STVEC_MODE_VECTORED.yaml → PMP_NAPOT_SUPPORTED.yaml}

@@ -5,15 +5,15 @@
 
 $schema: param_schema.json#
 kind: parameter
-name: STVEC_MODE_VECTORED
-description: Whether or not `stvec.MODE` supports Vectored (1).
-long_name: TODO
+name: PMP_NAPOT_SUPPORTED
+description: |
+  Whether or not the Naturally Aligned Power-Of-Two (NAPOT) PMP address
+  matching mode is supported.
+
+long_name: PMP NAPOT mode supported
 schema:
   type: boolean
-requirements:
-  idl(): |
-    !STVEC_MODE_DIRECT -> STVEC_MODE_VECTORED;
-  reason: stvec must support at least one mode
 definedBy:
-  extension:
-    name: S
+  param:
+    name: NUM_PMP_ENTRIES
+    greaterThan: 0

data/.data/spec/std/isa/param/{MSTATUS_TVM_IMPLEMENTED.yaml → PMP_TOR_SUPPORTED.yaml}

@@ -5,14 +5,14 @@
 
 $schema: param_schema.json#
 kind: parameter
-name: MSTATUS_TVM_IMPLEMENTED
+name: PMP_TOR_SUPPORTED
 description: |
-  Whether or not mstatus.TVM is implemented.
+  Whether or not the Top-of-Range (TOR) PMP address matching mode is supported.
 
-  When not implemented mstatus.TVM will be read-only-zero.
-long_name: TODO
+long_name: PMP TOR mode supported
 schema:
   type: boolean
 definedBy:
-  extension:
-    name: S
+  param:
+    name: NUM_PMP_ENTRIES
+    greaterThan: 0

data/.data/spec/std/isa/param/PRECISE_SYNCHRONOUS_EXCEPTIONS.yaml

@@ -15,3 +15,4 @@ description: |
   will cause execution to enter an unpredictable state.
 schema:
   type: boolean
+  default: true

data/.data/spec/std/isa/param/STVAL_WIDTH.yaml

@@ -10,10 +10,11 @@ description: |
   The number of implemented bits in `stval`.
 
   Must be greater than or equal to _max_(`PHYS_ADDR_WIDTH`, `VA_SIZE`)
-long_name: TODO
+long_name: "`stval` implemented bits"
 schema:
   type: integer
-  maximum: 18446744073709551615
+  minimum: 0
+  maximum: 64
 definedBy:
   extension:
     name: S

data/.data/spec/std/isa/param/STVEC_BASE_ALIGNMENT_VECTORED.yaml

@@ -0,0 +1,100 @@
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# yaml-language-server: $schema=../../../schemas/param_schema.json
+
+$schema: param_schema.json#
+kind: parameter
+name: STVEC_BASE_ALIGNMENT_VECTORED
+long_name: |
+  Minimum alignment of `stvec.BASE` when `stvec.MODE` is 1 (Vectored)
+definedBy:
+  allOf:
+    - extension:
+        name: S
+    - param:
+        name: STVEC_MODES
+        includes: 1
+        reason: Only relevant when vectored mode is supported
+description: |
+  Minimum alignment of the base pointer when `stvec.MODE` is Vectored. Because
+  `stvec` excludes the two least-significant bits of the base, the minimum
+  alignment cannot be less than 4 bytes.
+schema:
+  description: An unsigned power of 2 greater than or equal to 4 that fits in 64 bits
+  default: 0x4
+  enum:
+    [
+      0x4,
+      0x8,
+      0x10,
+      0x20,
+      0x40,
+      0x80,
+      0x100,
+      0x200,
+      0x400,
+      0x800,
+      0x1000,
+      0x2000,
+      0x4000,
+      0x8000,
+      0x10000,
+      0x20000,
+      0x40000,
+      0x80000,
+      0x100000,
+      0x200000,
+      0x400000,
+      0x800000,
+      0x1000000,
+      0x2000000,
+      0x4000000,
+      0x8000000,
+      0x10000000,
+      0x20000000,
+      0x40000000,
+      0x80000000,
+      0x100000000,
+      0x200000000,
+      0x400000000,
+      0x800000000,
+      0x1000000000,
+      0x2000000000,
+      0x4000000000,
+      0x8000000000,
+      0x10000000000,
+      0x20000000000,
+      0x40000000000,
+      0x80000000000,
+      0x100000000000,
+      0x200000000000,
+      0x400000000000,
+      0x800000000000,
+      0x1000000000000,
+      0x2000000000000,
+      0x4000000000000,
+      0x8000000000000,
+      0x10000000000000,
+      0x20000000000000,
+      0x40000000000000,
+      0x80000000000000,
+      0x100000000000000,
+      0x200000000000000,
+      0x400000000000000,
+      0x800000000000000,
+      0x1000000000000000,
+      0x2000000000000000,
+      0x4000000000000000,
+      0x8000000000000000,
+    ]
+
+requirements:
+  if:
+    param:
+      name: SXLEN
+      includes: 32
+  then:
+    param:
+      name: STVEC_BASE_ALIGNMENT_VECTORED
+      lessThanOrEqual: 0x80000000

data/.data/spec/std/isa/param/STVEC_MODES.yaml

@@ -0,0 +1,31 @@
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# yaml-language-server: $schema=../../../schemas/param_schema.json
+
+$schema: param_schema.json#
+kind: parameter
+name: STVEC_MODES
+long_name: |
+  Modes supported by `stvec.MODE`
+definedBy:
+  extension:
+    name: S
+description: |
+  Options:
+
+    0::
+      Direct; All traps set `pc` to `stvec.BASE`
+    1::
+      Vectored; Asynchronous interrupts set `pc` to `stvec.BASE` + 4 x cause.
+
+  If only one mode is given, `stvec.MODE` is assumed to be read-only with that value.
+  Otherwise, `stvec.MODE` is read-write.
+schema:
+  type: array
+  items:
+    type: integer
+    enum: [0, 1]
+  minItems: 1
+  maxItems: 2
+  uniqueItems: true

data/.data/spec/std/isa/param/SV32_VSMODE_TRANSLATION.yaml

@@ -16,7 +16,7 @@ requirements:
   idl(): |
     # at least one of Bare, Sv32 must be supported
     !VSSTAGE_MODE_BARE
-      -> SV39_VSMODE_TRANSLATION;
+      -> SV32_VSMODE_TRANSLATION;
   reason: at least one of Bare, Sv32 must be supported
 definedBy:
   allOf:

data/.data/spec/std/isa/param/SXLEN.yaml

@@ -9,8 +9,8 @@ name: SXLEN
 description: |
   Set of XLENs supported in S-mode. Can be one of:
 
-    * 32:   SXLEN is always 32
-    * 64:   SXLEN is always 64
+    * [32]:     SXLEN is always 32
+    * [64]:     SXLEN is always 64
     * [32, 64]: SXLEN can be changed (via mstatus.SXL) between 32 and 64
 long_name: TODO
 schema:

data/.data/spec/std/isa/param/TINST_VALUE_ON_FINAL_INSTRUCTION_GUEST_PAGE_FAULT.yaml

@@ -7,7 +7,7 @@ $schema: param_schema.json#
 kind: parameter
 name: TINST_VALUE_ON_FINAL_INSTRUCTION_GUEST_PAGE_FAULT
 description: |
-  Value to write into htval/mtval2 when there is a guest page fault on a final translation.
+  Value written into htinst/mtinst when there is an instruction guest-page fault on a final translation.
 
   Possible values:
     * "always zero": Always write the value zero