summaryrefslogtreecommitdiffhomepage
path: root/docs/md
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal.elmahrouss@icloud.com>2025-03-23 20:57:26 +0100
committerAmlal El Mahrouss <amlal.elmahrouss@icloud.com>2025-03-23 20:57:26 +0100
commit56ce5020c702b538ce26ec69515b790b11f91de3 (patch)
tree4a416fcd7fe90c65b3677b515b360196ac3622ec /docs/md
parent229441231a4d89575b8a1c82cf060f34dd52ec8f (diff)
feat(meta): move documentation to either drawio/ or /md/ according to
file type. Signed-off-by: Amlal El Mahrouss <amlal.elmahrouss@icloud.com>
Diffstat (limited to 'docs/md')
-rw-r--r--docs/md/SPECIFICATION_KERNEL.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/md/SPECIFICATION_KERNEL.md b/docs/md/SPECIFICATION_KERNEL.md
new file mode 100644
index 00000000..2cdee1f0
--- /dev/null
+++ b/docs/md/SPECIFICATION_KERNEL.md
@@ -0,0 +1,63 @@
+===================================
+
+# 0: General Information
+
+===================================
+
+- ABI and Format: PEF/PE32+.
+- Kernel architecture: Portable hybrid Kernel.
+- Language: C++/(Assembly (AMD64, X64000, X86S, ARM64, POWER, RISCV))
+
+===================================
+
+# 1: The Kernel
+
+===================================
+
+- Drive/Device Abstraction.
+- SMP, Preemptive Multi Threading.
+- Separation of Files/Devices.
+- Networking.
+- Hardware Abstraction Layer.
+- Native Filesystem support (NeFS, FAT32 and ffs2).
+- Program Loaders interfaces.
+- TLS (Thread Local Storage) support.
+- BinaryMutex, Locks, Timers.
+- Canary mechanisms.
+- Dynamic Sys.
+- Cross Platform.
+- Permission Selectors.
+
+===================================
+
+# 2: The Filesystem
+
+===================================
+
+- Catalog object with associated forks.
+- Large storage support.
+- Long file names.
+- UNIX path style.
+
+==================================
+
+# 3: Common naming conventions:
+
+==================================
+
+- Kernel -> ke_init_x
+- RunTime -> rt_copy_mem
+- Hal -> hal_foo_bar
+- Class methods -> Class::FooBar
+
+===================================
+
+# 4: The BootZ
+
+===================================
+
+- Capable of booting from a network drive.
+- Loads a PE file which is the Kernel.
+- Sanity checks, based on the number of sections.
+- Handover compliant.
+- Does check for a valid partition (useful in the case of recovering)