Skip to content

Commit

Permalink
modify format of debug insn doc for github display
Browse files Browse the repository at this point in the history
  • Loading branch information
Mingkai-Li committed Sep 1, 2023
1 parent 301fd5a commit e3e3166
Showing 1 changed file with 15 additions and 101 deletions.
116 changes: 15 additions & 101 deletions docs/spike-debug.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,129 +58,43 @@ S:: Secure world

=== Revocation Tree

.*RCUPDATE*
[%collapsible]
====
****
RCUPDATE::
Update the revocation tree node with node id `x[rs1]` by `x[rs2]`.
****
====

.*ALLOC*
[%collapsible]
====
****
ALLOC::
Allocate a new revocation tree node whose parent node has a node id `x[rs1]`, and write the node id of the new node to `x[rd]`.
****
====

.*REV*
[%collapsible]
====
****
REV::
Revoke the revocation tree node (and the nodes of its subtree) with node id `x[rs1]`.
****
====

=== Capability Manipulation

.*CAPCREATE*
[%collapsible]
====
****
CAPCREATE::
Make the tag of the register `x[rd]` to refer to a capability.
****
====

.*CAPTYPE*
[%collapsible]
====
****
CAPTYPE::
Set `x[rd].type` to `x[rs1]`.
****
====

.*CAPNODE*
[%collapsible]
====
****
CAPNODE::
Set `x[rd].node` to `x[rs1]`.
****
====

.*CAPPERM*
[%collapsible]
====
****
CAPPERM::
Set `x[rd].perm` to `x[rs1]`.
****
====

.*CAPBOUND*
[%collapsible]
====
****
CAPBOUND::
. Set `x[rd].base` to `x[rs1]`.
. If `x[rs2]` is not `zero`, set `x[rd].end` to `x[rs2]`.
****
====

.*CAPASYNC*
[%collapsible]
====
****
CAPASYNC::
Set `x[rd].async` to `x[rs1]`.
****
====

.*CAPREG*
[%collapsible]
====
****
CAPREG::
Set `x[rd].reg` to `x[rs1]`.
****
====

=== Memory

.*TAGSET*
[%collapsible]
====
****
TAGSET::
Set the tag of the CLEN-bit aligned memory region containing the memory address `x[rs1]` to refer to a capability if `x[rs2]` is not `zero`, or to refer to an integer register otherwise.
****
====

.*TAGGET*
[%collapsible]
====
****
TAGGET::
If the tag of the CLEN-bit aligned memory region containing the memory address `x[rs1]` refers to a capability, set `x[rd]` to `1`; otherwise, set `x[rd]` to `0`.
****
====

=== Others

.*CAPPRINT*
[%collapsible]
====
****
CAPPRINT::
Print the content in `x[rs1]` to the console.
****
====

.*SETWORLD*
[%collapsible]
====
****
SETWORLD::
Set `cwrld` to `0` if `x[rs1]` is `zero`, or to `1` otherwise.
****
====

.*SETEH*
[%collapsible]
====
****
SETEH::
Set `ceh` to `x[rs1]`.
****
====

0 comments on commit e3e3166

Please sign in to comment.