From 1d07547776d6890c4b4115ddc265b35e68f87936 Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Thu, 20 Mar 2025 20:05:08 +0100 Subject: doc: Refactor names in directory. --- dev/Kernel/doc/EPM.pdf | Bin 0 -> 12364 bytes dev/Kernel/doc/Explicit Partition Map.pdf | Bin 12364 -> 0 bytes dev/Kernel/doc/SPECIFICATION.md | 63 ------------------------------ dev/Kernel/doc/Specs.md | 63 ++++++++++++++++++++++++++++++ dev/Kernel/doc/TODO-LIST.md | 25 ------------ dev/Kernel/doc/TodoList.md | 25 ++++++++++++ 6 files changed, 88 insertions(+), 88 deletions(-) create mode 100644 dev/Kernel/doc/EPM.pdf delete mode 100644 dev/Kernel/doc/Explicit Partition Map.pdf delete mode 100644 dev/Kernel/doc/SPECIFICATION.md create mode 100644 dev/Kernel/doc/Specs.md delete mode 100644 dev/Kernel/doc/TODO-LIST.md create mode 100644 dev/Kernel/doc/TodoList.md (limited to 'dev/Kernel') diff --git a/dev/Kernel/doc/EPM.pdf b/dev/Kernel/doc/EPM.pdf new file mode 100644 index 00000000..a73834cd Binary files /dev/null and b/dev/Kernel/doc/EPM.pdf differ diff --git a/dev/Kernel/doc/Explicit Partition Map.pdf b/dev/Kernel/doc/Explicit Partition Map.pdf deleted file mode 100644 index a73834cd..00000000 Binary files a/dev/Kernel/doc/Explicit Partition Map.pdf and /dev/null differ diff --git a/dev/Kernel/doc/SPECIFICATION.md b/dev/Kernel/doc/SPECIFICATION.md deleted file mode 100644 index 2cdee1f0..00000000 --- a/dev/Kernel/doc/SPECIFICATION.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/dev/Kernel/doc/Specs.md b/dev/Kernel/doc/Specs.md new file mode 100644 index 00000000..2cdee1f0 --- /dev/null +++ b/dev/Kernel/doc/Specs.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) diff --git a/dev/Kernel/doc/TODO-LIST.md b/dev/Kernel/doc/TODO-LIST.md deleted file mode 100644 index 0b17dc39..00000000 --- a/dev/Kernel/doc/TODO-LIST.md +++ /dev/null @@ -1,25 +0,0 @@ -# TODO list - -- We need preemptive multi-threading. [ X ] -- We then need sync primitives. [ X ] -- We also need a system library for the OS. [ X ] -- We need a bootloader for AMD64 [ X ] - - Implement Boot Services [ X ] - - Design Handover [ X ] - - Load Kernel into memory [ X ] - - Fix bug in Kernel loader, which causes a 06 #UD. [ X ] - - Load Kernel [ X ] - - Add IDT [ X ] - - AHCI driver [ WiP ] -- Context switch x87/SSE/AVX registers [ X ] -- Framebuffer [ X ] -- ATA support [ X ] -- Make installer [ X ] - -Status: - -BootZ: Need to boot from EPM partition. [ X ] -
-neoskrnl: New Filesystem is done. [ X ] - -**Refer to Jira please!** diff --git a/dev/Kernel/doc/TodoList.md b/dev/Kernel/doc/TodoList.md new file mode 100644 index 00000000..0b17dc39 --- /dev/null +++ b/dev/Kernel/doc/TodoList.md @@ -0,0 +1,25 @@ +# TODO list + +- We need preemptive multi-threading. [ X ] +- We then need sync primitives. [ X ] +- We also need a system library for the OS. [ X ] +- We need a bootloader for AMD64 [ X ] + - Implement Boot Services [ X ] + - Design Handover [ X ] + - Load Kernel into memory [ X ] + - Fix bug in Kernel loader, which causes a 06 #UD. [ X ] + - Load Kernel [ X ] + - Add IDT [ X ] + - AHCI driver [ WiP ] +- Context switch x87/SSE/AVX registers [ X ] +- Framebuffer [ X ] +- ATA support [ X ] +- Make installer [ X ] + +Status: + +BootZ: Need to boot from EPM partition. [ X ] +
+neoskrnl: New Filesystem is done. [ X ] + +**Refer to Jira please!** -- cgit v1.2.3