From 56ce5020c702b538ce26ec69515b790b11f91de3 Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Sun, 23 Mar 2025 20:57:26 +0100 Subject: feat(meta): move documentation to either drawio/ or /md/ according to file type. Signed-off-by: Amlal El Mahrouss --- docs/AHCI_DESIGN.drawio | 40 --------------------- docs/GUI_DESIGN.drawio | 34 ------------------ docs/MBCI_DESIGN.drawio | 70 ------------------------------------ docs/OS_DESIGN.drawio | 22 ------------ docs/SCHED_DESIGN.drawio | 34 ------------------ docs/SOFT_SCHED_DESIGN.drawio | 25 ------------- docs/SPECIFICATION_KERNEL.md | 63 -------------------------------- docs/TIMER_DESIGN.drawio | 49 ------------------------- docs/ZXD_DESIGN.drawio | 31 ---------------- docs/drawio/AHCI_DESIGN.drawio | 40 +++++++++++++++++++++ docs/drawio/GUI_DESIGN.drawio | 34 ++++++++++++++++++ docs/drawio/MBCI_DESIGN.drawio | 70 ++++++++++++++++++++++++++++++++++++ docs/drawio/OS_DESIGN.drawio | 22 ++++++++++++ docs/drawio/SCHED_DESIGN.drawio | 34 ++++++++++++++++++ docs/drawio/SOFT_SCHED_DESIGN.drawio | 25 +++++++++++++ docs/drawio/TIMER_DESIGN.drawio | 49 +++++++++++++++++++++++++ docs/drawio/ZXD_DESIGN.drawio | 31 ++++++++++++++++ docs/md/SPECIFICATION_KERNEL.md | 63 ++++++++++++++++++++++++++++++++ 18 files changed, 368 insertions(+), 368 deletions(-) delete mode 100644 docs/AHCI_DESIGN.drawio delete mode 100644 docs/GUI_DESIGN.drawio delete mode 100644 docs/MBCI_DESIGN.drawio delete mode 100644 docs/OS_DESIGN.drawio delete mode 100644 docs/SCHED_DESIGN.drawio delete mode 100644 docs/SOFT_SCHED_DESIGN.drawio delete mode 100644 docs/SPECIFICATION_KERNEL.md delete mode 100644 docs/TIMER_DESIGN.drawio delete mode 100644 docs/ZXD_DESIGN.drawio create mode 100644 docs/drawio/AHCI_DESIGN.drawio create mode 100644 docs/drawio/GUI_DESIGN.drawio create mode 100644 docs/drawio/MBCI_DESIGN.drawio create mode 100644 docs/drawio/OS_DESIGN.drawio create mode 100644 docs/drawio/SCHED_DESIGN.drawio create mode 100644 docs/drawio/SOFT_SCHED_DESIGN.drawio create mode 100644 docs/drawio/TIMER_DESIGN.drawio create mode 100644 docs/drawio/ZXD_DESIGN.drawio create mode 100644 docs/md/SPECIFICATION_KERNEL.md (limited to 'docs') diff --git a/docs/AHCI_DESIGN.drawio b/docs/AHCI_DESIGN.drawio deleted file mode 100644 index 73029de7..00000000 --- a/docs/AHCI_DESIGN.drawio +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/GUI_DESIGN.drawio b/docs/GUI_DESIGN.drawio deleted file mode 100644 index 09bd3400..00000000 --- a/docs/GUI_DESIGN.drawio +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/MBCI_DESIGN.drawio b/docs/MBCI_DESIGN.drawio deleted file mode 100644 index 9a8f4283..00000000 --- a/docs/MBCI_DESIGN.drawio +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/OS_DESIGN.drawio b/docs/OS_DESIGN.drawio deleted file mode 100644 index 0091f5c1..00000000 --- a/docs/OS_DESIGN.drawio +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/SCHED_DESIGN.drawio b/docs/SCHED_DESIGN.drawio deleted file mode 100644 index ab75d000..00000000 --- a/docs/SCHED_DESIGN.drawio +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/SOFT_SCHED_DESIGN.drawio b/docs/SOFT_SCHED_DESIGN.drawio deleted file mode 100644 index 32a7800d..00000000 --- a/docs/SOFT_SCHED_DESIGN.drawio +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/SPECIFICATION_KERNEL.md b/docs/SPECIFICATION_KERNEL.md deleted file mode 100644 index 2cdee1f0..00000000 --- a/docs/SPECIFICATION_KERNEL.md +++ /dev/null @@ -1,63 +0,0 @@ -=================================== - -# 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) diff --git a/docs/TIMER_DESIGN.drawio b/docs/TIMER_DESIGN.drawio deleted file mode 100644 index ca081fd3..00000000 --- a/docs/TIMER_DESIGN.drawio +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/docs/ZXD_DESIGN.drawio b/docs/ZXD_DESIGN.drawio deleted file mode 100644 index 7452d3f9..00000000 --- a/docs/ZXD_DESIGN.drawio +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/drawio/AHCI_DESIGN.drawio b/docs/drawio/AHCI_DESIGN.drawio new file mode 100644 index 00000000..73029de7 --- /dev/null +++ b/docs/drawio/AHCI_DESIGN.drawio @@ -0,0 +1,40 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/drawio/GUI_DESIGN.drawio b/docs/drawio/GUI_DESIGN.drawio new file mode 100644 index 00000000..09bd3400 --- /dev/null +++ b/docs/drawio/GUI_DESIGN.drawio @@ -0,0 +1,34 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/drawio/MBCI_DESIGN.drawio b/docs/drawio/MBCI_DESIGN.drawio new file mode 100644 index 00000000..9a8f4283 --- /dev/null +++ b/docs/drawio/MBCI_DESIGN.drawio @@ -0,0 +1,70 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/drawio/OS_DESIGN.drawio b/docs/drawio/OS_DESIGN.drawio new file mode 100644 index 00000000..0091f5c1 --- /dev/null +++ b/docs/drawio/OS_DESIGN.drawio @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/drawio/SCHED_DESIGN.drawio b/docs/drawio/SCHED_DESIGN.drawio new file mode 100644 index 00000000..ab75d000 --- /dev/null +++ b/docs/drawio/SCHED_DESIGN.drawio @@ -0,0 +1,34 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/drawio/SOFT_SCHED_DESIGN.drawio b/docs/drawio/SOFT_SCHED_DESIGN.drawio new file mode 100644 index 00000000..32a7800d --- /dev/null +++ b/docs/drawio/SOFT_SCHED_DESIGN.drawio @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/drawio/TIMER_DESIGN.drawio b/docs/drawio/TIMER_DESIGN.drawio new file mode 100644 index 00000000..ca081fd3 --- /dev/null +++ b/docs/drawio/TIMER_DESIGN.drawio @@ -0,0 +1,49 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/drawio/ZXD_DESIGN.drawio b/docs/drawio/ZXD_DESIGN.drawio new file mode 100644 index 00000000..7452d3f9 --- /dev/null +++ b/docs/drawio/ZXD_DESIGN.drawio @@ -0,0 +1,31 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 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) -- cgit v1.2.3