aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Hepworth <tomhepworth@hotmail.co.uk>2023-10-26 10:42:34 +0100
committerGitHub <noreply@github.com>2023-10-26 10:42:34 +0100
commit38a31d663cc044731d740520f0091822bafeee4c (patch)
treef2496f62be08ecd33394452c1345b7a8fd1eb6fa
parentf9ed144c5c61bbe44e59cc47384024905ed37786 (diff)
downloadriscv-opcodes-38a31d663cc044731d740520f0091822bafeee4c.zip
riscv-opcodes-38a31d663cc044731d740520f0091822bafeee4c.tar.gz
riscv-opcodes-38a31d663cc044731d740520f0091822bafeee4c.tar.bz2
Clarified syntax of regular instructions
See https://github.com/riscv/riscv-opcodes/issues/204 Before this change the text implied that bit encodings and variable arguments could not be mixed in the list of instruction arguments. Signed-off-by: Thomas Hepworth <tomhepworth@hotmail.co.uk>
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index dec6003..9657484 100644
--- a/README.md
+++ b/README.md
@@ -46,8 +46,10 @@ Instruction syntaxes used in this project are broadly categorized into three:
- **regular instructions** :- these are instructions which hold a unique opcode in the encoding space. A very generic syntax guideline
for these instructions is as follows:
```
- <instruction name> <instruction args> <bit-encodings>
+ <instruction name> <arguments>
```
+ where `<argument>` is either `<bit encoding>` or `<variable argument>`.
+
Examples:
```
lui rd imm20 6..2=0x0D 1..0=3