aboutsummaryrefslogtreecommitdiff
path: root/lib/arch/riscv64/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/arch/riscv64/README.md')
-rw-r--r--lib/arch/riscv64/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/arch/riscv64/README.md b/lib/arch/riscv64/README.md
new file mode 100644
index 0000000..517ddb2
--- /dev/null
+++ b/lib/arch/riscv64/README.md
@@ -0,0 +1,12 @@
+# riscv64 (RISC-V ELF)
+Provide an implementation of the platform specific API as required in
+[`api.h`](../api.h) according to the `RISC-V ELF ABI`.
+
+## Notes: RISC-V ABI
+- Integer/pointer arguments via `x10 - x17`
+- Integer/pointer return values via `x10` - `x11`
+- Callee saved registers `x2`, `x8` - `x9`, `x18` - `x27`, `f8` - `f9`, `f18` - `f27`
+
+## References
+- [RISC-V ABI](https://github.com/riscv/riscv-elf-psabi-doc/blob/master/riscv-elf.md)
+- [RISC-V asm manual](https://github.com/riscv/riscv-asm-manual/blob/master/riscv-asm.md)