aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNeel Gala <neelgala@incoresemi.com>2023-01-14 13:48:36 +0530
committerNeel Gala <neelgala@incoresemi.com>2023-01-14 13:48:36 +0530
commit01c36086d51a3fbec7fa04d2f92a79a32faa8ad2 (patch)
tree79ca89972751d49ba214c9ca9b16c203e1c852e4 /README.md
parent946f4dd3e77c2492ef06cf141822eb92fcf4fb65 (diff)
downloadriscv-opcodes-01c36086d51a3fbec7fa04d2f92a79a32faa8ad2.zip
riscv-opcodes-01c36086d51a3fbec7fa04d2f92a79a32faa8ad2.tar.gz
riscv-opcodes-01c36086d51a3fbec7fa04d2f92a79a32faa8ad2.tar.bz2
updated readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index d41015a..dec6003 100644
--- a/README.md
+++ b/README.md
@@ -81,6 +81,15 @@ Instruction syntaxes used in this project are broadly categorized into three:
```
$import rv32_zkne::aes32esmi
```
+
+### RESTRICTIONS
+
+Following are the restrictions one should keep in mind while defining $pseudo\_ops and $imported\_ops
+
+- Pseudo-op or already imported instructions cannot be imported again in another file. One should
+ always import base-instructions only.
+- While defining a $pseudo\_op, the base-instruction itself cannot be a $pseudo\_op
+
## Flow for parse.py
The `parse.py` python file is used to perform checks on the current set of instruction encodings and also generates multiple artifacts : latex tables, encoding.h header file, etc. This section will provide a brief overview of the flow within the python file.