diff options
Diffstat (limited to 'Private')
| -rw-r--r-- | Private/Documentation/.gitkeep | 0 | ||||
| -rw-r--r-- | Private/Documentation/Spec.md | 52 | ||||
| -rw-r--r-- | Private/Documentation/Todo.md | 21 | ||||
| -rw-r--r-- | Private/Documentation/kernel-design.drawio | 70 |
4 files changed, 143 insertions, 0 deletions
diff --git a/Private/Documentation/.gitkeep b/Private/Documentation/.gitkeep new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/Private/Documentation/.gitkeep diff --git a/Private/Documentation/Spec.md b/Private/Documentation/Spec.md new file mode 100644 index 00000000..458d17a9 --- /dev/null +++ b/Private/Documentation/Spec.md @@ -0,0 +1,52 @@ +=================================== +# 0: General Information +=================================== + +- ABI and Format: PEF/PE32+. +- Kernel architecture: Microkernel. +- Language: C++/(Assembly (AMD64, X64000, X86S, ARM64, PowerPC, RISCV)) + +=================================== +# 1: The NewKernel +=================================== + +- Drive/Device Abstraction. +- SMP, Preemptive Multi Threading. +- Separation of Files/Devices. +- Networking. +- Hardware Abstraction Layer. +- Native Filesystem support (NewFS, FAT32 and ffs2). +- Program Loaders. +- Thread Local Storage. +- Semaphore, Locks, Timers. +- Canary mechanisms. +- Dynamic Libraries. +- 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 + +=================================== +# 4: The NewBoot +=================================== + +- 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/Private/Documentation/Todo.md b/Private/Documentation/Todo.md new file mode 100644 index 00000000..2c4af6e5 --- /dev/null +++ b/Private/Documentation/Todo.md @@ -0,0 +1,21 @@ +- 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 ] +- AHCI support [ ] +- Make installer [ ] + +Status: + +NewBoot: Need to boot from EPM partition. +NewKernel: New Filesystem in progress. + diff --git a/Private/Documentation/kernel-design.drawio b/Private/Documentation/kernel-design.drawio new file mode 100644 index 00000000..d78ac170 --- /dev/null +++ b/Private/Documentation/kernel-design.drawio @@ -0,0 +1,70 @@ +<mxfile host="app.diagrams.net" modified="2024-03-20T02:51:52.841Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36 Edg/122.0.0.0" etag="oPkzCtvrIkHoFdXP1Jzt" version="24.0.7" type="gitlab"> + <diagram name="Page-1" id="mxOE_IV8GVOi3fDmlM2_"> + <mxGraphModel dx="1002" dy="569" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0"> + <root> + <mxCell id="0" /> + <mxCell id="1" parent="0" /> + <mxCell id="dpAw-ApGermXuwIBdtFA-1" value="<h1 style="margin-top: 0px;">NewKernel.exe</h1><p>The kernel is a C++ app, designed to be scalable, reliable and object oriented.</p><p>We're actually working on the AHCI support for it is scheduled to be done by the end of april.</p>" style="text;html=1;whiteSpace=wrap;overflow=hidden;rounded=0;" parent="1" vertex="1"> + <mxGeometry x="40" y="40" width="400" height="120" as="geometry" /> + </mxCell> + <mxCell id="dpAw-ApGermXuwIBdtFA-2" value="MicroKernel" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1"> + <mxGeometry x="286" y="450" width="256" height="60" as="geometry" /> + </mxCell> + <mxCell id="dpAw-ApGermXuwIBdtFA-3" value="System Call Interface" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1"> + <mxGeometry x="286" y="420" width="256" height="30" as="geometry" /> + </mxCell> + <mxCell id="dpAw-ApGermXuwIBdtFA-4" value="System Object" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1"> + <mxGeometry x="286" y="330" width="254" height="70" as="geometry" /> + </mxCell> + <mxCell id="dpAw-ApGermXuwIBdtFA-5" value="User Defined Object #1" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1"> + <mxGeometry x="288" y="280" width="92" height="40" as="geometry" /> + </mxCell> + <mxCell id="dpAw-ApGermXuwIBdtFA-6" value="User Defined Object #2" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1"> + <mxGeometry x="390" y="280" width="70" height="40" as="geometry" /> + </mxCell> + <mxCell id="dpAw-ApGermXuwIBdtFA-7" value="User Defined Object #3" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1"> + <mxGeometry x="470" y="280" width="70" height="40" as="geometry" /> + </mxCell> + <mxCell id="NTNQYUPq4CuizRvDkpOI-1" value="<h1 style="margin-top: 0px;"><span style="background-color: initial;">SystemLib.lib</span></h1><h1 style="margin-top: 0px;"><span style="background-color: initial; font-size: 12px; font-weight: normal;">The System API is written in C/C++ and assembly, meant to interface with the SCI, it provides everything you need to make a NewOS application, properties, objects, threading, heap allocation.</span><br></h1><div><span style="background-color: initial; font-size: 12px; font-weight: normal;">You can also register you own user objects.</span></div>" style="text;html=1;whiteSpace=wrap;overflow=hidden;rounded=0;" parent="1" vertex="1"> + <mxGeometry x="40" y="560" width="360" height="190" as="geometry" /> + </mxCell> + <mxCell id="NTNQYUPq4CuizRvDkpOI-2" value="System Object" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1"> + <mxGeometry x="281" y="820" width="254" height="70" as="geometry" /> + </mxCell> + <mxCell id="NTNQYUPq4CuizRvDkpOI-3" value="User Defined Object #1" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1"> + <mxGeometry x="286" y="730" width="92" height="40" as="geometry" /> + </mxCell> + <mxCell id="NTNQYUPq4CuizRvDkpOI-4" value="User Defined Object #2" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1"> + <mxGeometry x="388" y="730" width="70" height="40" as="geometry" /> + </mxCell> + <mxCell id="NTNQYUPq4CuizRvDkpOI-5" value="User Defined Object #3" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1"> + <mxGeometry x="468" y="730" width="70" height="40" as="geometry" /> + </mxCell> + <mxCell id="NTNQYUPq4CuizRvDkpOI-6" value="" style="endArrow=classic;html=1;rounded=0;exitX=1;exitY=0;exitDx=0;exitDy=0;" parent="1" source="NTNQYUPq4CuizRvDkpOI-5" edge="1"> + <mxGeometry width="50" height="50" relative="1" as="geometry"> + <mxPoint x="390" y="770" as="sourcePoint" /> + <mxPoint x="560" y="690" as="targetPoint" /> + </mxGeometry> + </mxCell> + <mxCell id="NTNQYUPq4CuizRvDkpOI-7" value="/Manifest.xml<div>/NewOS/</div><div><span style="white-space: pre;">	</span>- Library.lib/Dll.dll (Subsystem 17)</div><div>/Resources/</div><div><br></div><div><br></div>" style="rounded=0;whiteSpace=wrap;html=1;align=left;" parent="1" vertex="1"> + <mxGeometry x="570" y="650" width="210" height="110" as="geometry" /> + </mxCell> + <mxCell id="vm68-OaV5PJmx3jSNiIi-1" value="<h1 style="margin-top: 0px;">GraphicsLib.lib (merged with SystemLib)</h1><p>Handles input, graphics and sound.</p><p>Uses the ODF format to display graphics and sound is handled by XIFF.</p>" style="text;html=1;whiteSpace=wrap;overflow=hidden;rounded=0;" vertex="1" parent="1"> + <mxGeometry x="31" y="980" width="250" height="120" as="geometry" /> + </mxCell> + <mxCell id="vm68-OaV5PJmx3jSNiIi-3" value="GraphicsLib.lib" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1"> + <mxGeometry x="286" y="780" width="114" height="30" as="geometry" /> + </mxCell> + <mxCell id="vm68-OaV5PJmx3jSNiIi-4" value="System Object" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1"> + <mxGeometry x="298" y="1150" width="254" height="70" as="geometry" /> + </mxCell> + <mxCell id="vm68-OaV5PJmx3jSNiIi-5" value="GraphicsLib.lib" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1"> + <mxGeometry x="300" y="1110" width="114" height="30" as="geometry" /> + </mxCell> + <mxCell id="vm68-OaV5PJmx3jSNiIi-6" value="SystemLib.lib" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1"> + <mxGeometry x="406" y="780" width="124" height="30" as="geometry" /> + </mxCell> + </root> + </mxGraphModel> + </diagram> +</mxfile> |