summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal.elmahrouss@icloud.com>2025-03-23 19:13:48 +0100
committerAmlal El Mahrouss <amlal.elmahrouss@icloud.com>2025-03-23 19:15:17 +0100
commita13e1c0911c0627184bc38f18c7fdda64447b3ad (patch)
tree073a62c09bf216e85a3f310376640fa1805147f9 /docs
parent149fa096eb306d03686b3b67e813cf1a78e08cd0 (diff)
meta(kernel): Reworked repository's filesystem structure.
Removing useless parts of the project too. Signed-off-by: Amlal El Mahrouss <amlal.elmahrouss@icloud.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/GUI_DESIGN.drawio2
-rw-r--r--docs/MBCI_DESIGN.drawio (renamed from docs/MBCI.drawio)0
-rw-r--r--docs/OS_DESIGN.drawio2
-rw-r--r--docs/SOFT_SCHED_DESIGN.drawio (renamed from docs/ROUND_ROBIN.drawio)2
-rw-r--r--docs/SPECIFICATION_KERNEL.md63
-rw-r--r--docs/ZXD_DESIGN.drawio (renamed from docs/ZXD.drawio)0
-rw-r--r--docs/apic.pngbin203155 -> 0 bytes
-rw-r--r--docs/filesystem.pngbin174261 -> 0 bytes
8 files changed, 66 insertions, 3 deletions
diff --git a/docs/GUI_DESIGN.drawio b/docs/GUI_DESIGN.drawio
index 3ada69be..09bd3400 100644
--- a/docs/GUI_DESIGN.drawio
+++ b/docs/GUI_DESIGN.drawio
@@ -4,7 +4,7 @@
<root>
<mxCell id="0"/>
<mxCell id="1" parent="0"/>
- <mxCell id="mspNsT0Gx7HsNPX6GqQO-2" value="LibSCI" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
+ <mxCell id="mspNsT0Gx7HsNPX6GqQO-2" value="libsci" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="50" y="500" width="450" height="140" as="geometry"/>
</mxCell>
<mxCell id="2" style="edgeStyle=none;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" parent="1" source="mspNsT0Gx7HsNPX6GqQO-3" target="mspNsT0Gx7HsNPX6GqQO-13" edge="1">
diff --git a/docs/MBCI.drawio b/docs/MBCI_DESIGN.drawio
index 9a8f4283..9a8f4283 100644
--- a/docs/MBCI.drawio
+++ b/docs/MBCI_DESIGN.drawio
diff --git a/docs/OS_DESIGN.drawio b/docs/OS_DESIGN.drawio
index d704b481..0091f5c1 100644
--- a/docs/OS_DESIGN.drawio
+++ b/docs/OS_DESIGN.drawio
@@ -4,7 +4,7 @@
<root>
<mxCell id="0"/>
<mxCell id="1" parent="0"/>
- <mxCell id="ifhO3zQZNW-sXvZMTmu8-2" value="&lt;p class=&quot;p1&quot;&gt;&lt;b&gt;System API (LibSCI.dylib) – User-Space Interface (Ring 3, EL0)&lt;/b&gt;&lt;/p&gt;" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
+ <mxCell id="ifhO3zQZNW-sXvZMTmu8-2" value="&lt;p class=&quot;p1&quot;&gt;&lt;b&gt;System API (libsci.dylib) – User-Space Interface (Ring 3, EL0)&lt;/b&gt;&lt;/p&gt;" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="235.5" y="340" width="360" height="30" as="geometry"/>
</mxCell>
<mxCell id="ifhO3zQZNW-sXvZMTmu8-3" value="&lt;p class=&quot;p1&quot;&gt;&lt;b&gt;Applications &amp;amp; Dynamically Linked Libraries (Ring 3, EL0)&lt;/b&gt;&lt;/p&gt;" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
diff --git a/docs/ROUND_ROBIN.drawio b/docs/SOFT_SCHED_DESIGN.drawio
index 46c6304b..32a7800d 100644
--- a/docs/ROUND_ROBIN.drawio
+++ b/docs/SOFT_SCHED_DESIGN.drawio
@@ -4,7 +4,7 @@
<root>
<mxCell id="0"/>
<mxCell id="1" parent="0"/>
- <mxCell id="ifhO3zQZNW-sXvZMTmu8-2" value="LibSCI DLL inside code (RING 3)" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
+ <mxCell id="ifhO3zQZNW-sXvZMTmu8-2" value="libsci DLL inside code (RING 3)" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="235.5" y="340" width="360" height="30" as="geometry"/>
</mxCell>
<mxCell id="ifhO3zQZNW-sXvZMTmu8-3" value="Running code (RING 3)" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
diff --git a/docs/SPECIFICATION_KERNEL.md b/docs/SPECIFICATION_KERNEL.md
new file mode 100644
index 00000000..2cdee1f0
--- /dev/null
+++ b/docs/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)
diff --git a/docs/ZXD.drawio b/docs/ZXD_DESIGN.drawio
index 7452d3f9..7452d3f9 100644
--- a/docs/ZXD.drawio
+++ b/docs/ZXD_DESIGN.drawio
diff --git a/docs/apic.png b/docs/apic.png
deleted file mode 100644
index 33954dce..00000000
--- a/docs/apic.png
+++ /dev/null
Binary files differ
diff --git a/docs/filesystem.png b/docs/filesystem.png
deleted file mode 100644
index 9e3599a9..00000000
--- a/docs/filesystem.png
+++ /dev/null
Binary files differ