Skip to content

Commit e6d62f7

Browse files
Improve doc
Signed-off-by: James Ball <jameball@qti.qualcomm.com>
1 parent 78567fd commit e6d62f7

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

tools/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,8 +163,8 @@ CSR Definition Encoding:
163163
- Use `csr_definitions` entries for CSRs, with `reg-name` (single CSR) or `reg-names` (multiple CSRs).
164164
- Every CSR/field entry must include `type` with one of:
165165
- `LegalEnum` - Standard defines legal values and implementation supports a subset that doesn't use all possible bit encodings (e.g., 10 values in a 4-bit field). Implementation's config file provides:
166-
- A list of supported legal write values
167-
- An indication of whether illegal write values are ignored or map to one specified legal value
166+
- A list of supported legal write values. An empty list indicates the CSR/field is treated as read-only zero.
167+
- An indication of whether illegal write values are ignored or how they map to legal values
168168
- `VarWidth` - CSR/field is variable width and the `width-parameter` property provides the name of the parameter that provides its value.
169169
- `ConstMask` - CSR/field allows implementation to treat some bits as constant values. Writes are ignored and reads return the constant value. Implementation's config file provides:
170170
- mask: A bit mask (1 = constant, 0 = variable) of constant bits

0 commit comments

Comments
 (0)