Skip to content

Add Smstateen/Ssstateen Extension and CSRs #592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
6a3c81c
add smstateen/ssstateen CSRs
neverlandiz Apr 4, 2025
be264c6
Merge branch 'main' into add-smstateen-sstateen
neverlandiz Apr 21, 2025
f981030
lots of minor fixes
neverlandiz Apr 24, 2025
4348f66
merging
neverlandiz Apr 24, 2025
f147046
merge
neverlandiz Apr 26, 2025
601efbe
lots of backticks
neverlandiz Apr 26, 2025
a5108d2
minor fixes
neverlandiz Apr 28, 2025
8bb0d30
modified descriptions
neverlandiz Apr 29, 2025
0807a91
Merge branch 'main' into add-smstateen-sstateen
neverlandiz Apr 29, 2025
e5fa958
remove pre-commit-config.yaml from pr
neverlandiz May 1, 2025
fffabda
remove pre-commit file changes
neverlandiz May 1, 2025
daa12b4
Merge branch 'main' into add-smstateen-sstateen
neverlandiz May 1, 2025
354ed45
add definedBy for fields
neverlandiz May 1, 2025
9484789
add sw_write and sw_read for alias
neverlandiz May 1, 2025
493e97c
add long names
neverlandiz May 5, 2025
843c1c6
structured format descriptions
neverlandiz May 5, 2025
a3f75bb
finish adding structured format
neverlandiz May 5, 2025
f4c73f3
change mstateen* reset values to 0
neverlandiz May 5, 2025
de434ae
docs(stateen): comment out Zfinx & Zdinx code + add sw_read
neverlandiz May 6, 2025
d074a3e
docs(stateen): change C field description
neverlandiz May 6, 2025
4321a85
Merge branch 'main' into add-smstateen-sstateen
neverlandiz May 6, 2025
efc3bff
docs(stateen): fix syntax errors
neverlandiz May 6, 2025
659aa3a
docs(stateen): syntax
neverlandiz May 6, 2025
405103b
docs(stateen): add sw_write for sstateen CSRs
neverlandiz May 8, 2025
240b895
docs(stateen): add sw_write for hstateen* CSRs
neverlandiz May 8, 2025
59a027a
Merge branch 'main' into add-smstateen-sstateen
neverlandiz May 8, 2025
838355d
docs(stateen): syntax fixes
neverlandiz May 8, 2025
eb9b003
docs(stateen): syntax fixes
neverlandiz May 8, 2025
5d4e1be
docs(stateen): more fixes
neverlandiz May 8, 2025
3bc9359
docs(stateen): syntax fix
neverlandiz May 8, 2025
a439395
fix
neverlandiz May 8, 2025
7dae65a
docs(stateen): add params to zcmt
neverlandiz May 12, 2025
a0d910c
docs(stateen): update fields based on newest specs
neverlandiz May 15, 2025
a73ea8e
docs(stateen): fix sw_write
neverlandiz May 20, 2025
c14d794
docs(stateen): add params for ext files
neverlandiz May 20, 2025
7c06ae7
docs(stateen): sw_write fixes
neverlandiz May 22, 2025
c7bba1d
docs(stateen): add definedBy for some fields
neverlandiz May 22, 2025
d565997
docs(stateen): syntax fixes
neverlandiz May 22, 2025
5e290b6
Merge branch 'main' into add-smstateen-sstateen
neverlandiz May 23, 2025
db8de99
Merge branch 'main' into add-smstateen-sstateen
neverlandiz May 28, 2025
0cb9aa9
docs(stateen): fix CI failures
neverlandiz Jun 3, 2025
cdc8c2e
Merge branch 'main' into add-smstateen-sstateen
neverlandiz Jun 3, 2025
6fb0fe9
docs(mstateen0): typo fix
neverlandiz Jun 4, 2025
cc5c669
docs(mstateen0): typo fix
neverlandiz Jun 4, 2025
780876d
docs(stateen): change MXLEN to 64
neverlandiz Jun 4, 2025
aef6da9
docs(stateen): fix base
neverlandiz Jun 4, 2025
b7e7f70
docs(zcmt): fix Zcmt typo
neverlandiz Jun 4, 2025
3d63bb4
Merge branch 'main' into add-smstateen-sstateen
neverlandiz Jun 4, 2025
3d57b11
fix(stateen): fix ruby code bug
neverlandiz Jun 4, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 100 additions & 0 deletions arch/csr/hstateen0.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# yaml-language-server: $schema=../../schemas/csr_schema.json

$schema: "csr_schema.json#"
kind: csr
name: hstateen0
long_name: Hypervisor State Enable 0 Register
address: 0x60C
priv_mode: S
length: 64
description: |
For each hstateen CSR, bit 63 is defined to control access to the matching sstateen CSR.
Bit 63 of hstateen0 controls access to sstateen0.

With the hypervisor extension, the hstateen CSRs have identical encodings to the mstateen
CSRs, except controlling accesses for a virtual machine (from VS and VU modes).

For every bit in an hstateen CSR that is zero (whether read-only zero or set to zero),
the same bit appears as read-only zero in sstateen when accessed in VS-mode.

A bit in an hstateen CSR cannot be read-only one unless the same bit is read-only one
in the matching mstateen CSR.

definedBy:
allOf:
- H
- Smstateen
- Ssstateen
fields:
SEO:
location: 63
description: |
The SE0 bit in hstateen0 controls access to the sstateen0 CSR.
type: RW
reset_value: UNDEFINED_LEGAL
ENVCFG:
location: 62
description: |
The ENVCFG bit in hstateen0 controls access to the senvcfg CSRs.
type: RW
reset_value: UNDEFINED_LEGAL
CSRIND:
location: 60
description: |
The CSRIND bit in hstateen0 controls access to the siselect and the
sireg*, (really vsiselect and vsireg*) CSRs provided by the Sscsrind
extensions.
type: RW
reset_value: UNDEFINED_LEGAL
AIA:
location: 59
description: |
The AIA bit in hstateen0 controls access to all state introduced by
the Ssaia extension and is not controlled by either the CSRIND or the
IMSIC bits of hstateen0.
type: RW
reset_value: UNDEFINED_LEGAL
IMSIC:
location: 58
description: |
The IMSIC bit in hstateen0 controls access to the guest IMSIC state,
including CSRs stopei (really vstopei), provided by the Ssaia extension.

Setting the IMSIC bit in hstateen0 to zero prevents a virtual machine
from accessing the hart’s IMSIC the same as setting `hstatus.`VGEIN = 0.
type: RW
reset_value: UNDEFINED_LEGAL
CONTEXT:
location: 57
description: |
The CONTEXT bit in hstateen0 controls access to the scontext CSR provided
by the Sdtrig extension.
type: RW
reset_value: UNDEFINED_LEGAL
JVT:
location: 2
description: |
The JVT bit controls access to the jvt CSR provided by the Zcmt extension.
type: RW
reset_value: UNDEFINED_LEGAL
FCSR:
location: 1
description: |
The FCSR bit controls access to fcsr for the case when floating-point instructions
operate on x registers instead of f registers as specified by the Zfinx and related
extensions (Zdinx, etc.). Whenever misa.F = 1, FCSR bit of mstateen0 is read-only
zero (and hence read-only zero in hstateen0 and sstateen0 too). For convenience,
when the stateen CSRs are implemented and misa.F = 0, then if the FCSR bit of a
controlling stateen0 CSR is zero, all floating-point instructions cause an illegal
instruction trap (or virtual instruction trap, if relevant), as though they all access
fcsr, regardless of whether they really do.
type: RW
reset_value: UNDEFINED_LEGAL
C:
location: 0
description: |
The C bit controls access to any and all custom state. This bit is not custom state itself.
The C bit of these registers is not custom state itself; it is a standard field of a
standard CSR, either mstateen0, hstateen0, or sstateen0.
type: RW
reset_value: UNDEFINED_LEGAL
70 changes: 70 additions & 0 deletions arch/csr/hstateen0h.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# yaml-language-server: $schema=../../schemas/csr_schema.json

$schema: "csr_schema.json#"
kind: csr
name: hstateen0h
long_name: Upper 32 bits of Hypervisor State Enable 0 Register
address: 0x61C
priv_mode: S
length: 32
description: |
For RV64 harts, the Smstateen/Ssstateen extension adds four new 64-bit CSRs at machine level: mstateen0 (Machine State Enable 0),
mstateen1, mstateen2, and mstateen3. If supervisor mode is implemented, another four CSRs are defined at
supervisor level: sstateen0, sstateen1, sstateen2, and sstateen3. And if the hypervisor extension is implemented,
another set of CSRs is added: hstateen0, hstateen1, hstateen2, and hstateen3.

For RV32, the registers listed above are 32-bit, and for the machine-level and hypervisor CSRs there is a corresponding
set of high-half CSRs for the upper 32 bits of each register: mstateen0h, mstateen1h, mstateen2h, mstateen3h, hstateen0h,
hstateen1h, hstateen2h, and hstateen3h.

definedBy:
allOf:
- H
- Smstateen
- Ssstateen
fields:
SEO:
location: 31
description: |
The SE0 bit in hstateen0h controls access to the sstateen0 CSR.
type: RW
reset_value: UNDEFINED_LEGAL
ENVCFG:
location: 30
description: |
The ENVCFG bit in hstateen0h controls access to the senvcfg CSRs.
type: RW
reset_value: UNDEFINED_LEGAL
CSRIND:
location: 28
description: |
The CSRIND bit in hstateen0h controls access to the siselect and the
sireg*, (really vsiselect and vsireg*) CSRs provided by the Sscsrind
extensions.
type: RW
reset_value: UNDEFINED_LEGAL
AIA:
location: 27
description: |
The AIA bit in hstateen0h controls access to all state introduced by
the Ssaia extension and is not controlled by either the CSRIND or the
IMSIC bits of hstateen0.
type: RW
reset_value: UNDEFINED_LEGAL
IMSIC:
location: 26
description: |
The IMSIC bit in hstateen0h controls access to the guest IMSIC state,
including CSRs stopei (really vstopei), provided by the Ssaia extension.

Setting the IMSIC bit in hstateen0h to zero prevents a virtual machine
from accessing the hart’s IMSIC the same as setting `hstatus.`VGEIN = 0.
type: RW
reset_value: UNDEFINED_LEGAL
CONTEXT:
location: 25
description: |
The CONTEXT bit in hstateen0h controls access to the scontext CSR provided
by the Sdtrig extension.
type: RW
reset_value: UNDEFINED_LEGAL
34 changes: 34 additions & 0 deletions arch/csr/hstateen1.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# yaml-language-server: $schema=../../schemas/csr_schema.json

$schema: "csr_schema.json#"
kind: csr
name: hstateen1
long_name: Hypervisor State Enable 1 Register
address: 0x60D
priv_mode: S
length: 64
description: |
For each hstateen CSR, bit 63 is defined to control access to the matching sstateen CSR.
Bit 63 of hstateen1 controls access to sstateen1.

With the hypervisor extension, the hstateen CSRs have identical encodings to the mstateen
CSRs, except controlling accesses for a virtual machine (from VS and VU modes).

For every bit in an hstateen CSR that is zero (whether read-only zero or set to zero),
the same bit appears as read-only zero in sstateen when accessed in VS-mode.

A bit in an hstateen CSR cannot be read-only one unless the same bit is read-only one
in the matching mstateen CSR.

definedBy:
allOf:
- H
- Smstateen
- Ssstateen
fields:
SEO:
location: 63
description: |
The SE0 bit in hstateen1 controls access to the sstateen1 CSR.
type: RW
reset_value: UNDEFINED_LEGAL
31 changes: 31 additions & 0 deletions arch/csr/hstateen1h.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# yaml-language-server: $schema=../../schemas/csr_schema.json

$schema: "csr_schema.json#"
kind: csr
name: hstateen1h
long_name: Upper 32 bits of Hypervisor State Enable 1 Register
address: 0x61D
priv_mode: S
length: 32
description: |
For RV64 harts, the Smstateen/Ssstateen extension adds four new 64-bit CSRs at machine level: mstateen0 (Machine State Enable 0),
mstateen1, mstateen2, and mstateen3. If supervisor mode is implemented, another four CSRs are defined at
supervisor level: sstateen0, sstateen1, sstateen2, and sstateen3. And if the hypervisor extension is implemented,
another set of CSRs is added: hstateen0, hstateen1, hstateen2, and hstateen3.

For RV32, the registers listed above are 32-bit, and for the machine-level and hypervisor CSRs there is a corresponding
set of high-half CSRs for the upper 32 bits of each register: mstateen0h, mstateen1h, mstateen2h, mstateen3h, hstateen0h,
hstateen1h, hstateen2h, and hstateen3h.

definedBy:
allOf:
- H
- Smstateen
- Ssstateen
fields:
SEO:
location: 31
description: |
The SE0 bit in hstateen1h controls access to the sstateen1 CSR.
type: RW
reset_value: UNDEFINED_LEGAL
34 changes: 34 additions & 0 deletions arch/csr/hstateen2.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# yaml-language-server: $schema=../../schemas/csr_schema.json

$schema: "csr_schema.json#"
kind: csr
name: hstateen2
long_name: Hypervisor State Enable 2 Register
address: 0x60E
priv_mode: S
length: 64
description: |
For each hstateen CSR, bit 63 is defined to control access to the matching sstateen CSR.
Bit 63 of hstateen2 controls access to sstateen2.

With the hypervisor extension, the hstateen CSRs have identical encodings to the mstateen
CSRs, except controlling accesses for a virtual machine (from VS and VU modes).

For every bit in an hstateen CSR that is zero (whether read-only zero or set to zero),
the same bit appears as read-only zero in sstateen when accessed in VS-mode.

A bit in an hstateen CSR cannot be read-only one unless the same bit is read-only one
in the matching mstateen CSR.

definedBy:
allOf:
- H
- Smstateen
- Ssstateen
fields:
SEO:
location: 63
description: |
The SE0 bit in hstateen2 controls access to the sstateen2 CSR.
type: RW
reset_value: UNDEFINED_LEGAL
31 changes: 31 additions & 0 deletions arch/csr/hstateen2h.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# yaml-language-server: $schema=../../schemas/csr_schema.json

$schema: "csr_schema.json#"
kind: csr
name: hstateen2h
long_name: Upper 32 bits of Hypervisor State Enable 2 Register
address: 0x61E
priv_mode: S
length: 32
description: |
For RV64 harts, the Smstateen/Ssstateen extension adds four new 64-bit CSRs at machine level: mstateen0 (Machine State Enable 0),
mstateen1, mstateen2, and mstateen3. If supervisor mode is implemented, another four CSRs are defined at
supervisor level: sstateen0, sstateen1, sstateen2, and sstateen3. And if the hypervisor extension is implemented,
another set of CSRs is added: hstateen0, hstateen1, hstateen2, and hstateen3.

For RV32, the registers listed above are 32-bit, and for the machine-level and hypervisor CSRs there is a corresponding
set of high-half CSRs for the upper 32 bits of each register: mstateen0h, mstateen1h, mstateen2h, mstateen3h, hstateen0h,
hstateen1h, hstateen2h, and hstateen3h.

definedBy:
allOf:
- H
- Smstateen
- Ssstateen
fields:
SEO:
location: 31
description: |
The SE0 bit in hstateen2h controls access to the sstateen2 CSR.
type: RW
reset_value: UNDEFINED_LEGAL
34 changes: 34 additions & 0 deletions arch/csr/hstateen3.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# yaml-language-server: $schema=../../schemas/csr_schema.json

$schema: "csr_schema.json#"
kind: csr
name: hstateen3
long_name: Hypervisor State Enable 3 Register
address: 0x60F
priv_mode: S
length: 64
description: |
For each hstateen CSR, bit 63 is defined to control access to the matching sstateen CSR.
Bit 63 of hstateen3 controls access to sstateen3.

With the hypervisor extension, the hstateen CSRs have identical encodings to the mstateen
CSRs, except controlling accesses for a virtual machine (from VS and VU modes).

For every bit in an hstateen CSR that is zero (whether read-only zero or set to zero),
the same bit appears as read-only zero in sstateen when accessed in VS-mode.

A bit in an hstateen CSR cannot be read-only one unless the same bit is read-only one
in the matching mstateen CSR.

definedBy:
allOf:
- H
- Smstateen
- Ssstateen
fields:
SEO:
location: 63
description: |
The SE0 bit in hstateen3 controls access to the sstateen3 CSR.
type: RW
reset_value: UNDEFINED_LEGAL
31 changes: 31 additions & 0 deletions arch/csr/hstateen3h.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# yaml-language-server: $schema=../../schemas/csr_schema.json

$schema: "csr_schema.json#"
kind: csr
name: hstateen3h
long_name: Upper 32 bits of Hypervisor State Enable 3 Register
address: 0x61F
priv_mode: S
length: 32
description: |
For RV64 harts, the Smstateen/Ssstateen extension adds four new 64-bit CSRs at machine level: mstateen0 (Machine State Enable 0),
mstateen1, mstateen2, and mstateen3. If supervisor mode is implemented, another four CSRs are defined at
supervisor level: sstateen0, sstateen1, sstateen2, and sstateen3. And if the hypervisor extension is implemented,
another set of CSRs is added: hstateen0, hstateen1, hstateen2, and hstateen3.

For RV32, the registers listed above are 32-bit, and for the machine-level and hypervisor CSRs there is a corresponding
set of high-half CSRs for the upper 32 bits of each register: mstateen0h, mstateen1h, mstateen2h, mstateen3h, hstateen0h,
hstateen1h, hstateen2h, and hstateen3h.

definedBy:
allOf:
- H
- Smstateen
- Ssstateen
fields:
SEO:
location: 31
description: |
The SE0 bit in hstateen3h controls access to the sstateen3 CSR.
type: RW
reset_value: UNDEFINED_LEGAL
Loading
Loading