aboutsummaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorjohannst <johannes.stoelp@gmail.com>2021-02-28 20:40:11 +0100
committerjohannst <johannes.stoelp@gmail.com>2021-02-28 20:40:11 +0100
commite699ff88fd42dd144f6a0b4e9c3311c852b0fb71 (patch)
treec104eee2ffd96a747f4bf85ad1affbce9b891be5 /lib
parente58a957f32e0becfe49f313a819087789211a6c2 (diff)
downloadmatcha-threads-e699ff88fd42dd144f6a0b4e9c3311c852b0fb71.tar.gz
matcha-threads-e699ff88fd42dd144f6a0b4e9c3311c852b0fb71.zip
updated READMEs
Diffstat (limited to 'lib')
-rw-r--r--lib/arch/arm/README.md11
-rw-r--r--lib/arch/arm64/README.md9
-rw-r--r--lib/arch/x86_64/README.md9
3 files changed, 19 insertions, 10 deletions
diff --git a/lib/arch/arm/README.md b/lib/arch/arm/README.md
index 8631c93..83675a9 100644
--- a/lib/arch/arm/README.md
+++ b/lib/arch/arm/README.md
@@ -1,9 +1,12 @@
-# Procedure Call Standard ARM64
+# ARM (aapcs32)
+Provide an implementation of the platform specific API as required in
+[`api.h`](../api.h) according to the `ARM Procedure Call Standard (aapcs32)`.
+## Notes: Procedure Call Standard ARM (aapcs32)
- Integer/pointer arguments via `r0`-`r3`
- Integer/pointer return values via `r0`
-- Callee saved registers `r4`-`r11`, `sp`, `lr`, `fp`
+- Callee saved registers `r4`-`r11`, `sp`
-## Reference
+## References
- [johannst armv7 notes](https://johannst.github.io/notes/arch/armv7.html)
-
+- [Procedure Call Standard aapcs32](https://github.com/ARM-software/abi-aa/blob/master/aapcs32/aapcs32.rst)
diff --git a/lib/arch/arm64/README.md b/lib/arch/arm64/README.md
index 9bf85bf..b726186 100644
--- a/lib/arch/arm64/README.md
+++ b/lib/arch/arm64/README.md
@@ -1,9 +1,12 @@
-# Procedure Call Standard ARM64
+# ARM64 (aapcs64)
+Provide an implementation of the platform specific API as required in
+[`api.h`](../api.h) according to the `ARM64 Procedure Call Standard (aapcs64)`.
+## Notes: Procedure Call Standard ARM64 (aapcs64)
- Integer/pointer arguments via `x0`-`x7`
- Integer/pointer return values via `x0`
- Callee saved registers `x19`-`x28`, `sp`
-## Reference
+## References
- [johannst arm64 notes](https://johannst.github.io/notes/arch/arm64.html)
-
+- [Procedure Call Standard aapcs64](https://github.com/ARM-software/abi-aa/blob/master/aapcs64/aapcs64.rst)
diff --git a/lib/arch/x86_64/README.md b/lib/arch/x86_64/README.md
index f81fc98..7420bf3 100644
--- a/lib/arch/x86_64/README.md
+++ b/lib/arch/x86_64/README.md
@@ -1,9 +1,12 @@
-# SystemV AMD64 ABI
+# x86_64 (SystemV)
+Provide an implementation of the platform specific API as required in
+[`api.h`](../api.h) according to the `x86_64 SystemV ABI`.
+## Notes: SystemV ABI
- Integer/pointer arguments via `rdi`, `rsi`, `rdx`, `rcx`, `r8`, `r9`
- Integer/pointer return values via `rax`
- Callee saved registers `rbx`, `rbp`, `r12` – `r15`
-## Reference
+## References
- [johannst x86_64 notes](https://johannst.github.io/notes/arch/x86_64.html)
-
+- [x86_64 SystemV ABI](https://www.uclibc.org/docs/psABI-x86_64.pdf)