Add HAL/abstractions to TODOs

Move serial driver to arch::x86_64::dev::serial
Update some docs and add a little more code to main
2025-02-28 23:07:16 +00:00 · 2025-02-28 23:03:12 +00:00 · 2025-02-28 22:45:31 +00:00 · 2025-02-28 22:21:51 +00:00 · 2025-02-28 21:12:41 +00:00 · 2025-02-28 17:21:44 +00:00
60 changed files with 2169 additions and 530 deletions
@@ -1,5 +1,5 @@
 [build]
-target = "x86_64-kernel"
+target = "x86_64-kernel.json"
 target-dir = "build/target"

 [unstable]
@@ -9,5 +9,16 @@ build-std-features = ["compiler-builtins-mem"]
 [env]
 RUST_TARGET_PATH = { value = "kernel", relative = true }

-[target.x86_64-kernel]
-runner = "scripts/run.sh"
+# Run in debug mode.
+[target.'cfg(all(target_arch = "x86_64", target_os = "none", debug_assertions))']
+runner = "scripts/run_debug.sh"
+
+# Otherwise we run in release mode.
+[target.'cfg(all(target_arch = "x86_64", target_os = "none", not(debug_assertions)))']
+runner = "scripts/run_release.sh"
+
+# [registry]
+# default = "gitea"
+
+[registries.gitea]
+index = "sparse+https://git.zxq5.dev/api/packages/OsDev/cargo/" # Sparse index
@@ -1,15 +0,0 @@
-[submodule "lib/lib_application"]
-	path = lib/lib_application
-	url = https://git.zxq5.dev/OsDev/FoundryOS-lib_application.git
-[submodule "lib/lib_ascii"]
-	path = lib/lib_ascii
-	url = https://git.zxq5.dev/OsDev/FoundryOS-lib_ascii.git
-[submodule "lib/lib_framebuffer"]
-	path = lib/lib_framebuffer
-	url = https://git.zxq5.dev/OsDev/FoundryOS-lib_framebuffer.git
-[submodule "lib/lib_serial"]
-	path = lib/lib_serial
-	url = https://git.zxq5.dev/OsDev/FoundryOS-lib_serial.git
-[submodule "lib/lib_alloc"]
-	path = lib/lib_alloc
-	url = https://git.zxq5.dev/OsDev/FoundryOS-lib_alloc.git
@@ -4,6 +4,8 @@
    <content url="file://$MODULE_DIR$">
      <sourceFolder url="file://$MODULE_DIR$/kernel/src" isTestSource="false" />
      <sourceFolder url="file://$MODULE_DIR$/lib_example/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/libk/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/libm/src" isTestSource="false" />
      <excludeFolder url="file://$MODULE_DIR$/target" />
    </content>
    <orderEntry type="inheritedJdk" />
@@ -1,9 +1,11 @@
 {
    "rust-analyzer.cargo.allTargets": false,
-    "rust-analyzer.cargo.target": "x86_64-kernel",
+    "rust-analyzer.cargo.target": "x86_64-kernel.json",
    "[rust]": {
        "editor.defaultFormatter": "rust-lang.rust-analyzer",
        "editor.formatOnSave": true
-    }
+    },
+    "rust-analyzer.check.command": "clippy",
+    "rust-analyzer.procMacro.attributes.enable": true,
+    "rust-analyzer.cargo.buildScripts.enable": true
 }
-
@@ -22,22 +22,87 @@ checksum = "8f68f53c83ab957f72c32642f3868eec03eb974d1fb82e453128456482613d36"

 [[package]]
 name = "cc"
-version = "1.2.14"
+version = "1.2.16"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0c3d1b2e905a3a7b00a6141adb0e4c0bb941d11caf55349d863942a1cc44e3c9"
+checksum = "be714c154be609ec7f5dad223a33bf1482fff90472de28f7362806e6d4832b8c"
 dependencies = [
 "shlex",
 ]

+[[package]]
+name = "crossbeam"
+version = "0.8.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1137cd7e7fc0fb5d3c5a8678be38ec56e819125d8d7907411fe24ccb943faca8"
+dependencies = [
+ "crossbeam-queue",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-queue"
+version = "0.3.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0f58bbc28f91df819d0aa2a2c00cd19754769c2fad90579b3592b1c9ba7a3115"
+dependencies = [
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-utils"
+version = "0.8.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28"
+
+[[package]]
+name = "darling"
+version = "0.20.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6f63b86c8a8826a49b8c21f08a2d07338eec8d900540f8630dc76284be802989"
+dependencies = [
+ "darling_core",
+ "darling_macro",
+]
+
+[[package]]
+name = "darling_core"
+version = "0.20.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "95133861a8032aaea082871032f5815eb9e98cef03fa916ab4500513994df9e5"
+dependencies = [
+ "fnv",
+ "ident_case",
+ "proc-macro2",
+ "quote",
+ "strsim",
+ "syn",
+]
+
+[[package]]
+name = "darling_macro"
+version = "0.20.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d336a2a514f6ccccaa3e09b02d41d35330c07ddf03a62165fcec10bb561c7806"
+dependencies = [
+ "darling_core",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "fnv"
+version = "1.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
+
 [[package]]
 name = "foundry_os"
 version = "0.1.0"
 dependencies = [
 "cc",
- "lib_alloc",
- "lib_ascii",
- "lib_framebuffer",
- "lib_serial",
+ "crossbeam",
+ "futures-util",
+ "libm",
 "limine",
 "pc-keyboard",
 "pic8259",
@@ -46,54 +111,43 @@ dependencies = [
 ]

 [[package]]
-name = "lazy_static"
-version = "1.5.0"
+name = "futures-core"
+version = "0.3.31"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
+checksum = "05f29059c0c2090612e8d742178b0580d2dc940c837851ad723096f87af6663e"
+
+[[package]]
+name = "futures-task"
+version = "0.3.31"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f90f7dce0722e95104fcb095585910c0977252f286e354b5e3bd38902cd99988"
+
+[[package]]
+name = "futures-util"
+version = "0.3.31"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9fa08315bb612088cc391249efdc3bc77536f16c91f6cf495e6fbe85b20a4a81"
 dependencies = [
- "spin",
+ "futures-core",
+ "futures-task",
+ "pin-project-lite",
+ "pin-utils",
 ]

 [[package]]
-name = "lib_alloc"
-version = "0.1.0"
-dependencies = [
- "linked_list_allocator",
- "x86_64",
-]
+name = "ident_case"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b9e0384b61958566e926dc50660321d12159025e767c18e043daf26b70104c39"

 [[package]]
-name = "lib_application"
+name = "libm"
 version = "0.1.0"
 dependencies = [
- "lib_ascii",
-]
-
-[[package]]
-name = "lib_ascii"
-version = "0.1.0"
-dependencies = [
- "lazy_static",
- "lib_framebuffer",
- "spin",
- "x86_64",
-]
-
-[[package]]
-name = "lib_framebuffer"
-version = "0.1.0"
-dependencies = [
- "limine",
- "spin",
-]
-
-[[package]]
-name = "lib_serial"
-version = "0.1.0"
-dependencies = [
- "lazy_static",
- "spin",
- "x86_64",
+ "darling",
+ "proc-macro2",
+ "quote",
+ "syn",
 ]

 [[package]]
@@ -105,15 +159,6 @@ dependencies = [
 "bitflags",
 ]

-[[package]]
-name = "linked_list_allocator"
-version = "0.10.5"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9afa463f5405ee81cdb9cc2baf37e08ec7e4c8209442b5d72c04cfb2cd6e6286"
-dependencies = [
- "spinning_top",
-]
-
 [[package]]
 name = "lock_api"
 version = "0.4.12"
@@ -139,6 +184,36 @@ dependencies = [
 "x86_64",
 ]

+[[package]]
+name = "pin-project-lite"
+version = "0.2.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3b3cff922bd51709b605d9ead9aa71031d81447142d828eb4a6eba76fe619f9b"
+
+[[package]]
+name = "pin-utils"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.93"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "60946a68e5f9d28b0dc1c21bb8a97ee7d018a8b322fa57838ba31cc878e22d99"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.38"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0e4dccaaaf89514f546c693ddc140f729f958c247918a13380cccc6078391acc"
+dependencies = [
+ "proc-macro2",
+]
+
 [[package]]
 name = "rustversion"
 version = "1.0.19"
@@ -167,14 +242,28 @@ dependencies = [
 ]

 [[package]]
-name = "spinning_top"
-version = "0.2.5"
+name = "strsim"
+version = "0.11.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5b9eb1a2f4c41445a3a0ff9abc5221c5fcd28e1f13cd7c0397706f9ac938ddb0"
+checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"
+
+[[package]]
+name = "syn"
+version = "2.0.98"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "36147f1a48ae0ec2b5b3bc5b537d267457555a10dc06f3dbc8cb11ba3006d3b1"
 dependencies = [
- "lock_api",
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
 ]

+[[package]]
+name = "unicode-ident"
+version = "1.0.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "00e2473a93778eb0bad35909dff6a10d28e63f792f16ed15e404fca9d5eeedbe"
+
 [[package]]
 name = "volatile"
 version = "0.4.6"
@@ -1,21 +1,18 @@
 [workspace]
-members = [
-    "lib/lib_framebuffer",
-    "lib/lib_serial",
-    "lib/lib_ascii",
-    "kernel",
-    "lib/lib_application", 
-    "lib/lib_alloc",
-]
+members = ["kernel", "libm"]
 resolver = "2"

 [workspace.package]
 version = "0.1.0"
-edition = "2021"
+edition = "2024"
+authors = ["The FoundryOS Contributors"]

 [profile.dev]
 opt-level = "z"
 debug = true
+# Leave this on to force Cargo to use the debug runner,
+# which adds the necessary flags for GDB debugging if you
+# set $USE_GDB (to any value) e.g. USE_GDB=1 cargo run 
 debug-assertions = true
 overflow-checks = true
 lto = false
@@ -1,22 +1,52 @@
 # FoundryOS

-## Cloning and building
+## Cloning
+```sh
+git clone https://git.zxq5.dev/OsDev/FoundryOS.git
+```

-Here are some simple steps to get started:
+## Build dependencies
+
+* latest rust nightly release
+* all necessary rust components installed
+* xorriso: creates ISO images to be booted from.
+* (Optional / Recommended) qemu: to run the kernel. (this may be packaged as qemu-desktop)
+* (Optional) GDB: for debugging the kernel.

 ```sh
-# If you have not yet cloned the repo:
-git clone --recurse-submodules https://git.zxq5.dev/OsDev/FoundryOS.git
-# If you already cloned the repo:
-git submodule update --init --recursive
+rustup update
+rustup override set nightly
+rustup component add rust-src
+rustup component add llvm-tools-preview
+```

-cargo build
-# This will build the binaries if required - no need to call cargo build.
+## Building & Running in qemu
+```sh
 cargo run
 ```

-### Build dependencies
+## Running in GDB
+```sh
+USE_GDB=1 cargo run
+```

-* jq: checks whether the app is to be run in debugging mode.
-* libisoburn: creates ISO images to be booted from.
-* qemu: to run the kernel.
+## Build errors
+
+If you see a qemu error like this:
+
+```
+qemu-system-x86_64: -drive if=pflash,format=raw,readonly=on,file=<...>/OVMF_CODE.fd: Could not open '<...>/OVMF_CODE.fd': No such file or directory
+```
+
+Simply delete the ./build directory and try to rebuild the program. Using the runner script or `cargo run` will download the required files for you, this is because the script only checks for the presence of one file and not the VARS file.
+
+Alternatively, you may disable using a UEFI firmware with qemu like so:
+```sh
+USE_LEGACY_BIOS=1 cargo run
+```
+
+## Debugging
+
+See [debugging](docs/Debugging/DEBUGGING.md) for some help with this, including commands to help with disassembly.
+
+If you have any other issues, feel free to create an issue or a PR.
@@ -1,5 +1,5 @@
 # Timeout in seconds that Limine will use before automatically booting.
-timeout: 1
+timeout: 0

 # The entry name that will be displayed in the boot menu.
 /foundry-os
@@ -0,0 +1,17 @@
+[0;32m[1m Running kernel in debug mode.
+[0;34m[1minfo[0m: Creating build directory structure
+[0;34m[1minfo[0m: Copying files to ISO root
+[0;32m[1m  Copying[0m: /home/fantasypvp/Projects/OSdev/FoundryOS/build/target/x86_64-kernel/debug/kernel to /home/fantasypvp/Projects/OSdev/FoundryOS/build/iso_root/boot/kernel
+[0;32m[1m  Copying[0m: /home/fantasypvp/Projects/OSdev/FoundryOS/config/limine.conf to /home/fantasypvp/Projects/OSdev/FoundryOS/build/iso_root/boot/limine/limine.conf
+[0;32m[1m  Copying[0m: /home/fantasypvp/Projects/OSdev/FoundryOS/build/limine/limine-bios-cd.bin to /home/fantasypvp/Projects/OSdev/FoundryOS/build/iso_root/boot/limine/
+[0;32m[1m  Copying[0m: /home/fantasypvp/Projects/OSdev/FoundryOS/build/limine/limine-uefi-cd.bin to /home/fantasypvp/Projects/OSdev/FoundryOS/build/iso_root/boot/limine/
+[0;32m[1m  Copying[0m: /home/fantasypvp/Projects/OSdev/FoundryOS/build/limine/limine-bios.sys to /home/fantasypvp/Projects/OSdev/FoundryOS/build/iso_root/boot/limine/
+[0;32m[1m  Copying[0m: /home/fantasypvp/Projects/OSdev/FoundryOS/build/limine/BOOTX64.EFI to /home/fantasypvp/Projects/OSdev/FoundryOS/build/iso_root/EFI/BOOT/
+[0;32m[1m  Copying[0m: /home/fantasypvp/Projects/OSdev/FoundryOS/build/limine/BOOTIA32.EFI to /home/fantasypvp/Projects/OSdev/FoundryOS/build/iso_root/EFI/BOOT/
+[0;32m[1mBuilding[0m: bootable ISO image
+[0;34m[1minfo[0m: Installing Limine bootloader
+[0;34m[1minfo[0m: KVM acceleration enabled
+[0;34m[1minfo[0m: Running OS in QEMU...
+[2J[01;01H[=3h[2J[01;01H[2J[01;01H[=3h[2J[01;01H[2J[01;01H[=3h[2J[01;01HBdsDxe: loading Boot0001 "UEFI QEMU DVD-ROM QM00005 " from PciRoot(0x0)/Pci(0x1F,0x2)/Sata(0x2,0xFFFF,0x0)
+BdsDxe: starting Boot0001 "UEFI QEMU DVD-ROM QM00005 " from PciRoot(0x0)/Pci(0x1F,0x2)/Sata(0x2,0xFFFF,0x0)
+[2J[01;01H[01;01H[2J[01;01H[01;01Hmap worked!got apic base
@@ -1 +1,3 @@
-{}
+{
+  "cssTheme": "Dark Moss"
+}
@@ -0,0 +1 @@
+[]
@@ -0,0 +1,12 @@
+{
+  "id": "obsidian-excalidraw-plugin",
+  "name": "Excalidraw",
+  "version": "2.8.3",
+  "minAppVersion": "1.1.6",
+  "description": "An Obsidian plugin to edit and view Excalidraw drawings",
+  "author": "Zsolt Viczian",
+  "authorUrl": "https://www.zsolt.blog",
+  "fundingUrl": "https://ko-fi.com/zsolt",
+  "helpUrl": "https://github.com/zsviczian/obsidian-excalidraw-plugin#readme",
+  "isDesktopOnly": false
+}
@@ -4,41 +4,21 @@
    "type": "split",
    "children": [
      {
-        "id": "a20540b7c1ddbfca",
+        "id": "c178a2dff57ae0aa",
        "type": "tabs",
        "children": [
          {
-            "id": "e1fb15cab546d0b6",
+            "id": "6d395e6a4c72e1c8",
            "type": "leaf",
            "state": {
              "type": "markdown",
              "state": {
-                "file": "Usage/Building The Kernel.md",
+                "file": "Planning & To-Dos.md",
                "mode": "source",
                "source": false
              },
              "icon": "lucide-file",
-              "title": "Building The Kernel"
-            }
-          }
-        ]
-      },
-      {
-        "id": "6bf1f87bf81a3031",
-        "type": "tabs",
-        "children": [
-          {
-            "id": "add883d295e04659",
-            "type": "leaf",
-            "state": {
-              "type": "markdown",
-              "state": {
-                "file": "Usage/Building The Kernel.md",
-                "mode": "preview",
-                "source": false
-              },
-              "icon": "lucide-file",
-              "title": "Building The Kernel"
+              "title": "Planning & To-Dos"
            }
          }
        ]
@@ -73,7 +53,7 @@
            "state": {
              "type": "search",
              "state": {
-                "query": "tag:#usage",
+                "query": "",
                "matchingCase": false,
                "explainSearch": false,
                "collapseAll": false,
@@ -98,8 +78,7 @@
      }
    ],
    "direction": "horizontal",
-    "width": 200,
-    "collapsed": true
+    "width": 307.5
  },
  "right": {
    "id": "baa2a8e61b737fa6",
@@ -177,7 +156,8 @@
      }
    ],
    "direction": "horizontal",
-    "width": 300
+    "width": 300,
+    "collapsed": true
  },
  "left-ribbon": {
    "hiddenItems": {
@@ -185,14 +165,21 @@
      "graph:Open graph view": false,
      "canvas:Create new canvas": false,
      "daily-notes:Open today's daily note": false,
-      "templates:Insert template": false,
-      "command-palette:Open command palette": false
+      "command-palette:Open command palette": false,
+      "templates:Insert template": false
    }
  },
-  "active": "e1fb15cab546d0b6",
+  "active": "6d395e6a4c72e1c8",
  "lastOpenFiles": [
+    "Usage/Building The Kernel.md",
+    "Planning & To-Dos.md",
+    "structure/idk.canvas",
+    "structure/kernel.md",
+    "structure/libk.md",
+    "structure/libm.md",
+    "structure/libk",
+    "structure",
    "Usage",
-    "Welcome.md",
-    "Usage/Building The Kernel.md"
+    "Welcome.md"
  ]
 }
@@ -0,0 +1,16 @@
+# Debugging the Kernel
+
+Here we will add some helpful tips on debugging the kernel.
+
+## Disassembling a public function
+
+To disassemble a public function, first we need a symbol in the public symbol table, so start by making the function fully public (including any parent modules). Do this as though you are trying to make a public function for a library crate (this includes the `kernel` crate). Simply mark the function and any parent modules as public, up until the point of [lib.rs (kernel link)](../../kernel/src/lib.rs).
+
+Then, we need to find the specific demangled symbol to disassemble, because the default objdump output can be very verbose.
+
+```sh
+# Change as required, I pipe to less and /SEARCH FOR FUNCTION HERE.
+nm --demangle ./build/target/x86_64-kernel/debug/kernel | less
+# Now just paste the symbol where it says YOUR_SYMBOL_HERE and profit. Use -Mintel for Intel assembly syntax.
+objdump -Matt --source --line-numbers --visualize-jumps ./build/target/x86_64-kernel/debug/kernel --demangle=rust --disassemble="YOUR_SYMBOL_HERE"
+```
@@ -0,0 +1,134 @@
+> [!todo] Testing
+> - [ ] setup custom test frameworks (Use CrystalOS-V2 as a reference)
+> 	- [ ] write a sub-crate for tests
+> 	- [ ] implement several unit tests on things that we are likely to break often
+> - [ ] setup Git CI/CD pipeline with testing
+> 	- [ ] figure out how to run QEMU in the test environment
+> 	- [ ] write a script to run tests
+> 	- [ ] a release should only be published if all tests pass
+>
+> [!todo] HAL (Hardware Abstraction Layer)
+> - [ ] use either traits or cfg attributes to support more than just x86_64
+>   - [ ] prefer writing cross platform code (I am aware I made the problem slightly worse by merging libk with the kernel sources)
+>
+> [!todo] Allocator
+> - [ ] learn about several allocator designs and decide on the optimal one
+> - [ ] implementation
+> 	- [ ] implement an allocate method
+> 	- [ ] implement a deallocate method
+> 	- [ ] set the global allocator
+> - [ ] testing
+> 	- [ ] write unit tests
+> 		- [ ] many allocations
+> 		- [ ] large allocations
+> 		- [ ] allocating more memory than is available
+> 	- [ ] pass unit tests
+
+> [!todo] Threading
+> - [ ] implement thread switching functionality
+> 	- [ ] switch stacks
+> - [ ] implement multi-threading
+> 	- [ ] figure out how to turn on another core
+> - [ ] Scheduler
+> 	- [ ] which task goes on which thread?
+> 		- [ ] round robin / time slicing algorithm
+> 	- [ ] switch tasks on a given core
+> 		- [ ] push registers
+> 		- [ ] switch stacks
+> 		- [ ] ensure the scheduler knows where to find the stack for each thread
+> 	- [ ] move a given task to a new core
+> 	- [ ] differentiate between kernel threads and user threads
+> - [ ] create syscall to create a new thread
+
+> [!todo] Filesystem 
+> - [ ] AHCI Implementation
+> 	- [ ] figure out what hard drives are attached
+> 	- [ ] read data
+> 	- [ ] write data
+> - [ ] FAT32 Implementation
+> 	- [ ] parse FAT header
+> 	- [ ] figure out where files are / what files are what
+> 	- [ ] parse file metadata / figure out type of file
+> 	- [ ] reading the entirety of a file into memory
+> - [ ] *(extension)* ext2 Implementation
+> - [ ] Syscall API
+> 	- [ ] provide a user program with file read / write access given a filename
+> 		- [ ] translate a filename into a disk location of data & the size of the data
+> 		- [ ] provide an interface to read from a file or write to a file
+
+> [!todo] APIC
+> - [ ] Enable APIC
+> 	- [x] Get apic location  from MSR
+> 	- [x] Enable APIC bit flag
+> 	- [x] Disable Legacy PIC
+> 	- [ ] Map physical APIC address to virtual memory
+> 
+>> [!error]
+>> Page fault exception occurs when APIC is activated
+>
+>- [ ] Setup Interrupt handlers to handle interrupts generated by the APIC
+>	- [ ] Timer Interrupts
+>	- [ ] Keyboard Interrupts
+
+> [!todo] Userspace (req: Threading, Filesystem)
+> - [ ] Load program into memory from disk
+> 	- [ ] requires:
+> 		- [ ] Program Loader
+> 			- [ ] Parse ELF File
+> 			- [ ] Load file into memory
+> 		- [ ] Filesystem
+> 		- [ ] Scheduler (to start and manage the process)
+> - [ ] Start a user process
+> 	- [ ] switch stacks
+> 	- [ ] jump to user code
+
+>[!todo] User Interface 
+>- This will be a library so that  programs in userspace can provide a user interface rather than relying on text commands from a basic terminal
+>- features required:
+>	- [ ] Rendering frames to a display buffer
+>		- [ ] requires: Frame rendering Syscall
+>	- [ ] I/O
+>		- [ ] syncio
+>			- [ ] keystrokes
+>		- [ ] asyncio
+>			- [ ] keystrokes
+>		- [ ] requires: I/O Syscalls
+>	- [ ] Window struct
+>		- [ ] stores it's size and location
+>		- [ ] handles rendering pixels to the screen
+>	- [ ] Widgets
+>		- [ ] textbox / label
+>		- [ ] single line text input
+>			- [ ] how do we capture keyboard inputs?
+>		- [ ] multiline text input
+>			- [ ] how do we capture keyboard inputs?
+>		- [ ] button
+>		- [ ] dialog
+>		- [ ] box widget
+>			- [ ] figure out how to nest other widgets inside it
+>```rust
+>pub struct Window {
+>	position;
+>	dimensions;
+>}
+>
+>impl Window {
+>	fn display(&self, frame: &Frame) -> Result<(), RenderError>;
+>}
+>
+>pub struct Frame<'a> {
+>	window: &'a Window,
+>	data: <"... a suitable type to store pixels">
+>}
+>
+>impl<'a> Frame<'a> {
+>	pub fn display(&self) -> Result<(), RenderError> {
+>		self.window.display(self)
+>	}
+>}
+>
+> pub trait Widget {
+> 	fn render(&self) -> Frame;
+> }
+>```
+
@@ -0,0 +1,41 @@
+{
+	"nodes":[
+		{"id":"8391ed519ab6cb3d","type":"group","x":-920,"y":600,"width":1595,"height":360,"label":"Hardware Layer"},
+		{"id":"967decfbdbf166e2","type":"group","x":-920,"y":120,"width":1595,"height":320,"label":"Kernel Layer (kernelspace)"},
+		{"id":"efd3cf75db396678","type":"group","x":-920,"y":-280,"width":1595,"height":240,"label":"System Layer (userspace)"},
+		{"id":"d577e6c4fa3d7479","type":"group","x":-920,"y":-600,"width":1595,"height":140,"label":"User Layer (userspace)"},
+		{"id":"549099b4188ff073","type":"text","text":"Interrupt handling & initialisation","x":-204,"y":320,"width":250,"height":60,"color":"2"},
+		{"id":"d0c73e9e86edba62","type":"text","text":"Kernel #kernel","x":-220,"y":260,"width":281,"height":140,"color":"2"},
+		{"id":"4fdc8ae730503ad0","type":"text","text":"libk #kernel","x":-880,"y":260,"width":280,"height":140,"color":"2"},
+		{"id":"4839a4f4f0980254","type":"text","text":"System Libraries #userspace","x":-220,"y":-240,"width":281,"height":160,"color":"3"},
+		{"id":"ba48ee2ccc891a62","type":"text","text":"Scheduler","x":-880,"y":160,"width":280,"height":60,"color":"2"},
+		{"id":"3d31fc276e0ba4a0","type":"text","text":"UI Shell #userspace","x":-880,"y":-560,"width":280,"height":60,"color":"4"},
+		{"id":"6b5e17c10589a7b6","type":"text","text":"Generic Application #userspace","x":-219,"y":-560,"width":281,"height":60,"color":"4"},
+		{"id":"0a47f47a2c7b3609","type":"text","text":"CPU #hardware","x":-880,"y":640,"width":280,"height":280,"color":"1"},
+		{"id":"a7002e4427f0540d","type":"text","text":"lib_io","x":-200,"y":-160,"width":122,"height":60,"color":"3"},
+		{"id":"e09d0bccffd19ed9","type":"text","text":"lib_ui","x":-78,"y":-160,"width":118,"height":60,"color":"3"},
+		{"id":"cbfeda8989b260d8","type":"text","text":"Userspace Drivers #userspace","x":360,"y":-240,"width":281,"height":160,"color":"3"},
+		{"id":"3acced35498279a0","type":"text","text":"Hardware #hardware\n- Display\n- Hard drives\n- Keyboard\n- Mouse","x":360,"y":640,"width":281,"height":280,"color":"1"},
+		{"id":"31548bb91b4977eb","type":"text","text":"Syscall API","x":-219,"y":160,"width":281,"height":60,"color":"2"},
+		{"id":"110b7bee2ba99819","type":"text","text":"Drivers & low level kernel libraries","x":-860,"y":320,"width":240,"height":60,"color":"2"}
+	],
+	"edges":[
+		{"id":"6a8d6b7540c2898d","fromNode":"3d31fc276e0ba4a0","fromSide":"right","toNode":"4839a4f4f0980254","toSide":"left","color":"3"},
+		{"id":"57aedf427a150ff1","fromNode":"6b5e17c10589a7b6","fromSide":"bottom","toNode":"4839a4f4f0980254","toSide":"top","color":"3","label":"Applications are statically \nlinked to system libraries"},
+		{"id":"d292a19f88032809","fromNode":"4839a4f4f0980254","fromSide":"bottom","toNode":"31548bb91b4977eb","toSide":"top","color":"2","label":"system libraries make syscalls"},
+		{"id":"8b437f1c08e1caf2","fromNode":"ba48ee2ccc891a62","fromSide":"top","toNode":"3d31fc276e0ba4a0","toSide":"bottom","color":"4","label":"Scheduler Starts\nUI in userspace"},
+		{"id":"3e2c6f6d5dcd7613","fromNode":"4839a4f4f0980254","fromSide":"right","toNode":"cbfeda8989b260d8","toSide":"left","color":"3"},
+		{"id":"88f6e95c288c933d","fromNode":"31548bb91b4977eb","fromSide":"top","toNode":"4839a4f4f0980254","toSide":"bottom","color":"2"},
+		{"id":"156c8a89b537e219","fromNode":"cbfeda8989b260d8","fromSide":"left","toNode":"4839a4f4f0980254","toSide":"right","color":"3","label":"some libs talk to\nhardware through\nuserspace drivers"},
+		{"id":"0d04c5b0f76a5d9b","fromNode":"cbfeda8989b260d8","fromSide":"bottom","toNode":"3acced35498279a0","toSide":"top","fromEnd":"arrow","color":"1","label":"Userspace drivers can talk\ndirectly to hardware so\nin the case of a driver crash\nthe kernel is unaffected"},
+		{"id":"e9f1afb45bf17b77","fromNode":"4fdc8ae730503ad0","fromSide":"bottom","toNode":"3acced35498279a0","toSide":"left","fromEnd":"arrow","color":"1","label":"Libk handles most hardware\ninteraction, keeping the core kernel codebase as minimal\nas possible"},
+		{"id":"99414d640e519c8c","fromNode":"4fdc8ae730503ad0","fromSide":"right","toNode":"d0c73e9e86edba62","toSide":"left","fromEnd":"arrow","color":"2","label":"kernel static linked to libk\nmost kernel functionality\nisfound in libk"},
+		{"id":"85cd865c914dd125","fromNode":"549099b4188ff073","fromSide":"top","toNode":"d0c73e9e86edba62","toSide":"top","color":"2"},
+		{"id":"e882694ec774c0d6","fromNode":"4fdc8ae730503ad0","fromSide":"top","toNode":"ba48ee2ccc891a62","toSide":"bottom","color":"2"},
+		{"id":"c689b667be8cdfab","fromNode":"d0c73e9e86edba62","fromSide":"top","toNode":"31548bb91b4977eb","toSide":"bottom","color":"2"},
+		{"id":"0c9da0cce11e4bd1","fromNode":"ba48ee2ccc891a62","fromSide":"bottom","toNode":"4fdc8ae730503ad0","toSide":"top","color":"2"},
+		{"id":"c45efb0ad498f8a8","fromNode":"ba48ee2ccc891a62","fromSide":"right","toNode":"6b5e17c10589a7b6","toSide":"left","color":"4","label":"Scheduler\nstarts applications"},
+		{"id":"aee2cd6ef9682f0f","fromNode":"31548bb91b4977eb","fromSide":"left","toNode":"ba48ee2ccc891a62","toSide":"right","color":"2","label":"system libs can talk to\nthe scheduler to manage\nprocesses"},
+		{"id":"b1b2b96d8ac2b490","fromNode":"4fdc8ae730503ad0","fromSide":"bottom","toNode":"0a47f47a2c7b3609","toSide":"top","fromEnd":"arrow","color":"1"}
+	]
+}
@@ -0,0 +1,16 @@
+- contains all proc macros for building the kernel
+
+## Current Features 
+### font importer:
+- a macro that takes a filename to a font file and turns it into a font.
+```rust 
+pub struct Font {
+	width: usize,
+	height: usize,
+	length: u16,
+	data: [[u8; 16]; 512],
+}
+
+pub static FONT_CP850_8X16: Font = 
+	Font::new(include_font!("./libk/resources/font/cp850-8x16.psf"));
+```
@@ -1,18 +1,24 @@
 [package]
 name = "foundry_os"
-version = "0.1.0"
-edition = "2021"
+edition.workspace = true
+version.workspace = true
+authors.workspace = true

 [dependencies]
 limine = "0.3.1"
-lib_framebuffer = { path = "../lib/lib_framebuffer" }
-lib_serial = { path = "../lib/lib_serial" }
-lib_ascii = { path = "../lib/lib_ascii" }
-lib_alloc = { path = "../lib/lib_alloc" }
+# libk = { path = "../libk" }
 x86_64 = "0.15.2"
 spin = "0.9.8"
 pic8259 = "0.11.0"
 pc-keyboard = "0.8.0"
+libm = { version = "0.1.0", path = "../libm" }
+crossbeam = { version = "0.8.4", default-features = false, features = [
+    # "alloc",
+    "crossbeam-queue",
+] }
+futures-util = { version = "0.3.31", default-features = false, features = [
+    # "alloc",
+] }

 [build-dependencies]
 cc = "1.2.14"
@@ -23,3 +29,4 @@ default = []
 [[bin]]
 name = "kernel"
 path = "src/main.rs"
+test = false
@@ -1,7 +1,3 @@
-use cc;
-use std::process::Command;
-use std::{env, path::Path};
-
 fn main() {
    // Tell cargo to rerun if these files change
    println!("cargo:rerun-if-changed=src");
@@ -0,0 +1,104 @@
+#![expect(unused)]
+use core::arch::x86_64::__cpuid;
+
+use spin::Lazy;
+// use libk::drivers::memory::{FRAME_ALLOCATOR, FoundryOSFrameAllocator,
+// OFFSET_PAGE_TABLE};
+use x86_64::{
+    PhysAddr, VirtAddr,
+    structures::paging::{Page, PageTableFlags, PhysFrame, Size4KiB},
+};
+
+// use crate::serial_print;
+
+use super::{cpu::msr::*, memmap::PHYSICAL_MEMORY_OFFSET};
+
+const IA32_APIC_BASE_MSR: u32 = 0x1b;
+const IA32_APIC_BASE_MSR_BSP: u64 = 0x100;
+const IA32_APIC_BASE_MSR_ENABLE: u64 = 0x800;
+const IA32_APIC_BASE_MSR_DISABLE: u64 = !IA32_APIC_BASE_MSR_ENABLE;
+
+const CPUID_FEAT_EDX_APIC: u64 = 1 << 9; // the cpuid instruction will return this flag if it supports APIC
+
+static APIC_VIRTUAL_ADDRESS: Lazy<VirtAddr> = Lazy::new(|| {
+    let apic_base = get_apic_base();
+
+    unsafe { phys_to_virt(apic_base) }
+});
+
+fn set_apic_base_enable(apic: PhysAddr) {
+    let rax = (apic.as_u64() & 0xfffff0000) | IA32_APIC_BASE_MSR_ENABLE;
+    cpu_set_msr(IA32_APIC_BASE_MSR, rax);
+}
+
+fn set_apic_base_disable(apic: PhysAddr) {
+    let rax = (apic.as_u64() & 0xfffff0000) & IA32_APIC_BASE_MSR_DISABLE;
+    cpu_set_msr(IA32_APIC_BASE_MSR, rax);
+}
+
+fn get_apic_base() -> PhysAddr {
+    let mut value: u64 = 0;
+    cpu_get_msr(IA32_APIC_BASE_MSR, &mut value);
+    PhysAddr::new(value & 0xfffff0000)
+}
+
+fn write_apic_register(apic_base: &VirtAddr, reg: u8, value: u32) {
+    let apic_base = apic_base.as_u64();
+    let reg_addr = (apic_base & 0xFFFFF0000) + reg as u64;
+    unsafe { *(reg_addr as *mut u32) = value };
+}
+
+const fn read_apic_register(apic_base: &VirtAddr, reg: u8) -> u32 {
+    let apic_base = apic_base.as_u64();
+
+    // serial_print!("got apic base");
+
+    let reg_addr = (apic_base & 0xFFFFF0000) + reg as u64;
+    unsafe { *(reg_addr as *const u32) }
+}
+
+pub fn check_apic() -> bool {
+    let res = unsafe { __cpuid(1) };
+    res.edx as u64 & CPUID_FEAT_EDX_APIC != 0
+}
+
+#[inline(always)]
+unsafe fn phys_to_virt(phys: PhysAddr) -> VirtAddr {
+    let phys = phys.as_u64();
+    phys.checked_add(*PHYSICAL_MEMORY_OFFSET)
+        .map_or_else(|| panic!(" overflow"), VirtAddr::new)
+}
+
+pub fn enable_apic() {
+    // let mut mapper = OFFSET_PAGE_TABLE.get().unwrap().lock();
+    // let mut frame_allocator = FRAME_ALLOCATOR.get().unwrap().lock();
+
+    let apic_phys_addr = get_apic_base();
+    set_apic_base_enable(apic_phys_addr);
+    // map virt address of apic
+
+    let apic_virt = unsafe { phys_to_virt(apic_phys_addr) };
+    let page: Page<Size4KiB> = Page::containing_address(apic_virt);
+    let frame: PhysFrame<Size4KiB> = PhysFrame::containing_address(apic_phys_addr);
+    let flags: PageTableFlags = PageTableFlags::PRESENT | PageTableFlags::WRITABLE;
+
+    /*     unsafe {
+           match mapper.map_to(page, frame, flags, &mut *frame_allocator) {
+               Ok(_) => {}
+               Err(why) => panic!("failed to map apic: {:?}", why),
+           }
+       }
+    */
+    // // FIXME: this causes a page fault
+    // // TODO: map to virtual memor
+
+    let reg = read_apic_register(&APIC_VIRTUAL_ADDRESS, 0xF0);
+
+    // serial_print!("ok2");
+
+    write_apic_register(&apic_virt, 0xF0, reg | 0x100);
+}
+
+pub struct Apic {}
+
+pub enum ApicVector {}
@@ -0,0 +1,2 @@
+pub mod msr;
+pub mod port;
@@ -0,0 +1,24 @@
+use core::arch::x86_64::__cpuid;
+use spin::Lazy;
+use x86_64::registers::model_specific::Msr;
+
+const CPUID_FLAG_MSR: u32 = 1 << 5;
+static EDX: Lazy<u32> = Lazy::new(|| unsafe { __cpuid(1).edx });
+
+pub fn cpu_has_msr() -> bool {
+    *EDX & CPUID_FLAG_MSR != 0
+}
+
+pub fn cpu_get_msr(msr: u32, value: &mut u64) {
+    let msr = Msr::new(msr);
+    unsafe {
+        *value = msr.read();
+    }
+}
+
+pub fn cpu_set_msr(msr: u32, value: u64) {
+    let mut msr = Msr::new(msr);
+    unsafe {
+        msr.write(value);
+    }
+}
@@ -0,0 +1,38 @@
+//! Functions for IO using ports.
+use core::arch::asm;
+
+/// Take a byte in from a port.
+///
+/// # Safety
+///
+/// This might have side effects so it is marked unsafe just in case.
+#[inline(always)]
+pub unsafe fn inb(port: u16) -> u8 {
+    let value: u8;
+    unsafe {
+        asm!(
+            "in al, dx",
+            out("al") value,
+            in("dx") port,
+            options(nomem, nostack, preserves_flags)
+        );
+    }
+    value
+}
+
+/// Take a byte in from a port.
+///
+/// # Safety
+///
+/// This might have side effects so it is marked unsafe just in case.
+#[inline(always)]
+pub unsafe fn outb(port: u16, value: u8) {
+    unsafe {
+        asm!(
+            "out dx, al",
+            in("dx") port,
+            in("al") value,
+            options(nomem, nostack, preserves_flags)
+        );
+    }
+}
@@ -0,0 +1,2 @@
+pub mod pic;
+pub mod serial;
@@ -0,0 +1,149 @@
+#![allow(clippy::missing_safety_doc)]
+use x86_64::instructions::port::Port;
+
+const CMD_INIT: u8 = 0x11;
+const CMD_END_OF_INT: u8 = 0x20;
+const MODE_8086: u8 = 0x01;
+
+struct Pic {
+    offset: u8,
+    data: Port<u8>,
+    command: Port<u8>,
+}
+
+impl Pic {
+    /// Are we in charge of handling the specified interrupt?
+    /// (Each PIC handles 8 interrupts.)
+    const fn handles_interrupt(&self, interrupt_id: u8) -> bool {
+        self.offset <= interrupt_id && interrupt_id < self.offset + 8
+    }
+
+    /// Notify us that an interrupt has been handled and that we're ready
+    /// for more.
+    unsafe fn end_of_interrupt(&mut self) {
+        unsafe { self.command.write(CMD_END_OF_INT) };
+    }
+
+    /// Reads the interrupt mask of this PIC.
+    unsafe fn read_mask(&mut self) -> u8 {
+        unsafe { self.data.read() }
+    }
+
+    /// Writes the interrupt mask of this PIC.
+    unsafe fn write_mask(&mut self, mask: u8) {
+        unsafe { self.data.write(mask) }
+    }
+}
+
+/// A pair of chained PICs.  This is the standard setup on x86.
+pub struct ChainedPics {
+    pics: [Pic; 2],
+}
+
+impl ChainedPics {
+    /// Creates a new [`ChainedPics`].
+    pub const fn new(offset1: u8, offset2: u8) -> Self {
+        Self {
+            pics: [
+                Pic {
+                    offset: offset1,
+                    command: Port::new(0x20),
+                    data: Port::new(0x21),
+                },
+                Pic {
+                    offset: offset2,
+                    command: Port::new(0xA0),
+                    data: Port::new(0xA1),
+                },
+            ],
+        }
+    }
+
+    pub const fn new_contiguous(primary_offset: u8) -> Self {
+        Self::new(primary_offset, primary_offset + 8)
+    }
+
+    /// Returns the initialize of this [`ChainedPics`].
+    ///
+    /// # Safety
+    ///
+    /// .
+    pub unsafe fn initialize(&mut self) {
+        unsafe {
+            let mut wait_port: Port<u8> = Port::new(0x80);
+            let mut wait = || wait_port.write(0);
+
+            // Save our original interrupt masks, because I'm too lazy to
+            // figure out reasonable values. We'll restore these when we're
+            // done.
+            let saved_masks = self.read_masks();
+
+            // Tell each PIC that we're going to send it a three-byte
+            // initialization sequence on its data port.
+            self.pics[0].command.write(CMD_INIT);
+            wait();
+            self.pics[1].command.write(CMD_INIT);
+            wait();
+
+            // Byte 1: Set up our base offsets.
+            self.pics[0].data.write(self.pics[0].offset);
+            wait();
+            self.pics[1].data.write(self.pics[1].offset);
+            wait();
+
+            // Byte 2: Configure chaining between PIC1 and PIC2.
+            self.pics[0].data.write(4);
+            wait();
+            self.pics[1].data.write(2);
+            wait();
+
+            // Byte 3: Set our mode.
+            self.pics[0].data.write(MODE_8086);
+            wait();
+            self.pics[1].data.write(MODE_8086);
+            wait();
+
+            // Restore our saved masks.
+            self.write_masks(saved_masks[0], saved_masks[1])
+        }
+    }
+
+    /// Reads the interrupt masks of both PICs.
+    pub unsafe fn read_masks(&mut self) -> [u8; 2] {
+        unsafe { [self.pics[0].read_mask(), self.pics[1].read_mask()] }
+    }
+
+    /// Writes the interrupt masks of both PICs.
+    pub unsafe fn write_masks(&mut self, mask1: u8, mask2: u8) {
+        unsafe {
+            self.pics[0].write_mask(mask1);
+            self.pics[1].write_mask(mask2);
+        }
+    }
+
+    /// Disables both PICs by masking all interrupts.
+    pub unsafe fn disable(&mut self) {
+        unsafe { self.write_masks(u8::MAX, u8::MAX) }
+    }
+
+    /// Do we handle this interrupt?
+    pub fn handles_interrupt(&self, interrupt_id: u8) -> bool {
+        self.pics.iter().any(|p| p.handles_interrupt(interrupt_id))
+    }
+
+    /// Figure out which (if any) PICs in our chain need to know about this
+    /// interrupt.  This is tricky, because all interrupts from `pics[1]`
+    /// get chained through `pics[0]`.
+    pub unsafe fn notify_end_of_interrupt(&mut self, interrupt_id: u8) {
+        if self.handles_interrupt(interrupt_id) {
+            if self.pics[1].handles_interrupt(interrupt_id) {
+                unsafe {
+                    self.pics[1].end_of_interrupt();
+                }
+            }
+            unsafe {
+                self.pics[0].end_of_interrupt();
+            }
+        }
+    }
+}
@@ -0,0 +1,153 @@
+use crate::arch::x86_64::cpu::port::{inb, outb};
+use core::{
+    fmt,
+    sync::atomic::{AtomicUsize, Ordering},
+};
+use spin::{Lazy, Mutex};
+use x86_64::instructions::interrupts;
+
+#[macro_export]
+macro_rules! serial_print {
+    ($($arg:tt)*) => ($crate::arch::x86_64::dev::serial::_serial_write(format_args!($($arg)*)));
+}
+
+#[macro_export]
+macro_rules! serial_println {
+    () => ($crate::serial_print!("\n"));
+    ($($arg:tt)*) => (serial_print!("{}\n", format_args!($($arg)*)));
+}
+
+pub fn _serial_write(args: fmt::Arguments) {
+    use core::fmt::Write;
+
+    interrupts::without_interrupts(|| {
+        if let Some(writer) = WRITER.lock().as_mut() {
+            writer.write_fmt(args).unwrap();
+        }
+    })
+}
+
+pub fn serial_read() -> &'static str {
+    serial_println!("getting value!");
+
+    interrupts::without_interrupts(|| {
+        if let Some(reader) = READER.lock().as_mut() {
+            serial_println!("stuff happnin.");
+            reader.read_str_to_buffer();
+        } else {
+            serial_println!("failed to get writer");
+        }
+    });
+
+    serial_println!("eee");
+
+    let i = BUFFER_LEN.load(Ordering::SeqCst);
+
+    unsafe {
+        if i != 0 {
+            core::str::from_utf8(&BUFFER[..i - 1]).unwrap()
+        } else {
+            serial_println!("empty string");
+            ""
+        }
+    }
+}
+
+static PORT: u16 = 0x3f8;
+static mut BUFFER: [u8; 256] = [0; 256];
+static BUFFER_LEN: AtomicUsize = AtomicUsize::new(0);
+
+static READER: Lazy<Mutex<Option<Reader>>> = Lazy::new(|| Mutex::new(None));
+static WRITER: Lazy<Mutex<Option<Writer>>> = Lazy::new(|| Mutex::new(None));
+
+struct Reader;
+
+struct Writer;
+
+impl fmt::Write for Writer {
+    fn write_str(&mut self, s: &str) -> fmt::Result {
+        for c in s.chars() {
+            self.write_byte(c as u8);
+        }
+        Ok(())
+    }
+}
+
+impl Writer {
+    unsafe fn write_success(&self) -> bool {
+        unsafe { inb(PORT + 5) & 0x20 != 0 }
+    }
+
+    pub fn write_byte(&self, data: u8) {
+        unsafe {
+            while !self.write_success() {}
+            outb(PORT, data);
+        }
+    }
+}
+
+pub fn init() -> Result<(), &'static str> {
+    test()?;
+
+    if READER.lock().is_none() {
+        *READER.lock() = Some(Reader);
+    }
+
+    if WRITER.lock().is_none() {
+        *WRITER.lock() = Some(Writer);
+    }
+
+    Ok(())
+}
+
+pub fn test() -> Result<(), &'static str> {
+    unsafe { outb(PORT + 1, 0x00) }; // Disable all interrupts
+    unsafe { outb(PORT + 3, 0x80) }; // Enable DLAB (set baud rate divisor)
+    unsafe { outb(PORT, 0x03) }; // Set divisor to 3 (lo byte) 38400 baud
+    unsafe { outb(PORT + 1, 0x00) }; //                  (hi byte)
+    unsafe { outb(PORT + 3, 0x03) }; // 8 bits, no parity, one stop bit
+    unsafe { outb(PORT + 2, 0xC7) }; // Enable FIFO, clear them, with 14-bytethreshold
+    unsafe { outb(PORT + 4, 0x0B) }; // IRQs enabled, RTS/DSR set
+    unsafe { outb(PORT + 4, 0x1E) }; // Set in loopback mode, test the serial chip
+    unsafe { outb(PORT, 0xAE) }; // Test serial chip (send byte 0xAE and check if serial returns same byte)
+
+    if unsafe { inb(PORT) } != 0xAE {
+        return Err("Serial test failed");
+    }
+
+    unsafe { outb(PORT + 4, 0x0F) };
+
+    Ok(())
+}
+
+impl Reader {
+    pub fn read_str_to_buffer(&mut self) {
+        unsafe {
+            while !self.read_ready() {}
+
+            BUFFER_LEN.store(0, Ordering::SeqCst);
+
+            while BUFFER_LEN.load(Ordering::SeqCst) < 256 {
+                let c = self.read();
+                BUFFER[BUFFER_LEN.load(Ordering::SeqCst)] = c;
+                if c as char == '\r' {
+                    break;
+                }
+                BUFFER_LEN.fetch_add(1, Ordering::SeqCst);
+            }
+
+            serial_println!("returning")
+        }
+    }
+
+    unsafe fn read_ready(&self) -> bool {
+        unsafe { inb(PORT + 5) & 1 != 0 }
+    }
+
+    pub fn read(&self) -> u8 {
+        unsafe {
+            while !self.read_ready() {}
+            inb(PORT)
+        }
+    }
+}
@@ -1,11 +1,11 @@
 use x86_64::{
+    VirtAddr,
    instructions::tables::load_tss,
-    registers::segmentation::{Segment, CS, DS, ES, SS},
+    registers::segmentation::{CS, DS, ES, SS, Segment},
    structures::{
        gdt::{Descriptor, GlobalDescriptorTable, SegmentSelector},
        tss::TaskStateSegment,
    },
-    VirtAddr,
 };

 use spin::Lazy;
@@ -19,8 +19,8 @@ static TSS: Lazy<TaskStateSegment> = Lazy::new(|| {
        static mut STACK: [u8; STACK_SIZE] = [0; STACK_SIZE];

        let stack_start = VirtAddr::from_ptr(&raw const STACK);
-        let stack_end = stack_start + STACK_SIZE.try_into().unwrap();
-        stack_end
+
+        stack_start + STACK_SIZE.try_into().unwrap()
    };
    tss
 });
@@ -40,8 +40,8 @@ static GDT: Lazy<(GlobalDescriptorTable, Selectors)> = Lazy::new(|| {
        Selectors {
            code_selector,
            data_selector,
-            user_code_selector,
-            user_data_selector,
+            _user_code_selector: user_code_selector,
+            _user_data_selector: user_data_selector,
            tss_selector,
        },
    )
@@ -50,8 +50,8 @@ static GDT: Lazy<(GlobalDescriptorTable, Selectors)> = Lazy::new(|| {
 struct Selectors {
    code_selector: SegmentSelector,
    data_selector: SegmentSelector,
-    user_code_selector: SegmentSelector,
-    user_data_selector: SegmentSelector,
+    _user_code_selector: SegmentSelector,
+    _user_data_selector: SegmentSelector,
    tss_selector: SegmentSelector,
 }

@@ -1,12 +1,12 @@
-use lib_ascii::{print, println_log};
-use lib_serial::serial_println;
-use x86_64::instructions::port::Port;
-use x86_64::registers::control::Cr2;
-use x86_64::structures::idt::{InterruptDescriptorTable, InterruptStackFrame, PageFaultErrorCode};
-
 use pic8259::ChainedPics;
+use x86_64::structures::idt::{
+    InterruptDescriptorTable, InterruptStackFrame, PageFaultErrorCode,
+};
+
 use spin::{Lazy, Mutex};

+use crate::print_log;
+
 use super::gdt;

 static IDT: Lazy<InterruptDescriptorTable> = Lazy::new(|| {
@@ -42,7 +42,7 @@ pub enum InterruptIndex {
 }

 impl InterruptIndex {
-    fn as_u8(self) -> u8 {
+    const fn as_u8(self) -> u8 {
        self as u8
    }

@@ -53,22 +53,33 @@ impl InterruptIndex {

 pub fn init_idt() {
    IDT.load();
+}
+
+pub fn enable_pic() {
    unsafe {
        PICS.lock().initialize();
        PICS.lock().write_masks(0xfc, 0xff);
    }
 }

-extern "x86-interrupt" fn breakpoint_handler(stack_frame: InterruptStackFrame) {
-    serial_println!("Exception: Breakpoint\n{:#?}", stack_frame);
-    println_log!("Exception: Breakpoint\n{:#?}", stack_frame);
+pub fn disable_pic() {
+    unsafe {
+        PICS.lock().disable();
+    }
+}
+
+const extern "x86-interrupt" fn breakpoint_handler(
+    _stack_frame: InterruptStackFrame,
+) {
+    // serial_println!("Exception: Breakpoint\n{:#?}", stack_frame);
+    // println_log!("Exception: Breakpoint\n{:#?}", stack_frame);
 }

 extern "x86-interrupt" fn general_protection_fault_handler(
    stack_frame: InterruptStackFrame,
    _error_code: u64,
 ) {
-    serial_println!("Exception: General Protection Fault\n{:#?}", stack_frame);
+    // serial_println!("Exception: General Protection Fault\n{:#?}", stack_frame);
    panic!("Exception: General Protection Fault\n{:#?}", stack_frame);
 }

@@ -76,35 +87,32 @@ extern "x86-interrupt" fn double_fault_handler(
    stack_frame: InterruptStackFrame,
    _error_code: u64,
 ) -> ! {
-    serial_println!("Exception: Double Fault\n{:#?}", stack_frame);
+    // serial_println!("Exception: Double Fault\n{:#?}", stack_frame);
    panic!("Exception: Double Fault\n{:#?}", stack_frame);
 }

-extern "x86-interrupt" fn keyboard_interrupt_handler(_stack_frame: InterruptStackFrame) {
-    use pc_keyboard::{layouts, DecodedKey, HandleControl, Keyboard, ScancodeSet1};
+extern "x86-interrupt" fn keyboard_interrupt_handler(
+    _stack_frame: InterruptStackFrame,
+) {
+    use pc_keyboard::{HandleControl, Keyboard, ScancodeSet1, layouts};
+    // use pc_keyboard::DecodedKey;
    use spin::Mutex;
-    use x86_64::instructions::port::Port;
+    // use x86_64::instructions::port::Port;

-    static KEYBOARD: Lazy<Mutex<Keyboard<layouts::Us104Key, ScancodeSet1>>> = Lazy::new(|| {
-        Mutex::new(Keyboard::new(
-            ScancodeSet1::new(),
-            layouts::Us104Key,
-            HandleControl::Ignore,
-        ))
-    });
+    static KEYBOARD: Lazy<Mutex<Keyboard<layouts::Uk105Key, ScancodeSet1>>> =
+        Lazy::new(|| {
+            Mutex::new(Keyboard::new(
+                ScancodeSet1::new(),
+                layouts::Uk105Key,
+                HandleControl::Ignore,
+            ))
+        });

-    let mut keyboard = KEYBOARD.lock();
-    let mut port = Port::new(0x60);
+    let _keyboard = KEYBOARD.lock();
+    // let mut port = Port::new(0x60);

-    let scancode: u8 = unsafe { port.read() };
-    if let Ok(Some(key_event)) = keyboard.add_byte(scancode) {
-        if let Some(key) = keyboard.process_keyevent(key_event) {
-            match key {
-                DecodedKey::Unicode(character) => print!("{}", character),
-                DecodedKey::RawKey(key) => print!("{:?}", key),
-            }
-        }
-    }
+    // let scancode: u8 = unsafe { port.read() };
+    // libk::drivers::io::keyboard::add_scancode(scancode);

    unsafe {
        PICS.lock()
@@ -112,21 +120,46 @@ extern "x86-interrupt" fn keyboard_interrupt_handler(_stack_frame: InterruptStac
    }
 }

-extern "x86-interrupt" fn timer_interrupt_handler(_stack_frame: InterruptStackFrame) {
+extern "x86-interrupt" fn timer_interrupt_handler(
+    _stack_frame: InterruptStackFrame,
+) {
+    x86_64::instructions::interrupts::without_interrupts(|| {
+        print_log!("{:?}", _stack_frame)
+    });
+
    unsafe {
        PICS.lock()
            .notify_end_of_interrupt(InterruptIndex::Timer.as_u8());
    }
 }

-extern "x86-interrupt" fn page_fault_handler(
-    stack_frame: InterruptStackFrame,
-    error_code: PageFaultErrorCode,
+const extern "x86-interrupt" fn page_fault_handler(
+    _stack_frame: InterruptStackFrame,
+    _error_code: PageFaultErrorCode,
 ) {
-    serial_println!("Exception: Page Fault");
-    serial_println!("Accessed Address: {:?}", Cr2::read());
-    serial_println!("Error Code: {:?}", error_code);
-    serial_println!("{:#?}", stack_frame);
+    // serial_println!("Exception: Page Fault");
+    // serial_println!("Accessed Address: {:?}", Cr2::read());
+    // serial_println!("Error Code: {:?}", _error_code);
+    // serial_println!("{:#?}", _stack_frame);

-    crate::hcf();
+    /*     if let Some(frame_allocator) = FRAME_ALLOCATOR.get() {
+           let mut f = frame_allocator.lock();
+
+           let frame = f.allocate_frame().unwrap();
+           let flags = PageTableFlags::PRESENT | PageTableFlags::WRITABLE;
+           let page: Page<Size4KiB> = Page::containing_address(Cr2::read().unwrap());
+
+           unsafe {
+               let mut mapper = OFFSET_PAGE_TABLE.get().unwrap().lock();
+
+               match mapper.map_to(page, frame, flags, &mut *f) {
+                   Ok(_) => {}
+                   Err(why) => panic!("failed to map page: {:?}", why),
+               }
+           }
+           MapperFlushAll::new().flush_all();
+       } else {
+           panic!("failed to get frame allocator");
+       }
+    */
 }
@@ -1,5 +1,4 @@
 //! Sets up a memory map using Limine.
-
 use limine::{
    request::{HhdmRequest, KernelAddressRequest, MemoryMapRequest},
    response::MemoryMapResponse,
@@ -7,13 +6,17 @@ use limine::{
 use spin::Lazy;

 #[used]
-#[link_section = ".requests"]
+#[unsafe(link_section = ".requests")]
 static MEMORY_MAP_REQUEST: MemoryMapRequest = MemoryMapRequest::new();

 #[used]
-#[link_section = ".requests"]
+#[unsafe(link_section = ".requests")]
 static HIGHER_HALF_DIRECT_MAP_REQUEST: HhdmRequest = HhdmRequest::new();

+#[used]
+#[unsafe(link_section = ".requests")]
+static KERNEL_ADDRESS_REQUEST: KernelAddressRequest = KernelAddressRequest::new();
+
 /// ```rs
 /// let virt_addr = phys_addr + offset;
 /// let phys_addr = virt_addr - offset; // (given VA is in the HHDM). Do not use for executable code.
@@ -25,17 +28,13 @@ pub static PHYSICAL_MEMORY_OFFSET: Lazy<u64> = Lazy::new(|| {
        .offset()
 });

-#[used]
-#[link_section = ".requests"]
-static KERNEL_ADDRESS_REQUEST: KernelAddressRequest = KernelAddressRequest::new();
-
 /// Converts virtual addresses in the kernel to a physical address like this:
 /// ```rs
 /// let phys_addr = virt_addr - virtual_base + physical_base;
 /// ```
 ///
 /// Returns (virtual_base, physical_base)
-pub static KERNEL_PHYSICAL_MEMORY_OFFSET: Lazy<(u64, u64)> = Lazy::new(|| {
+pub static _KERNEL_PHYSICAL_MEMORY_OFFSET: Lazy<(u64, u64)> = Lazy::new(|| {
    let resp = KERNEL_ADDRESS_REQUEST.get_response().unwrap();

    // These are base addresses, using Limine's built in page table.
@@ -48,9 +47,8 @@ pub static KERNEL_PHYSICAL_MEMORY_OFFSET: Lazy<(u64, u64)> = Lazy::new(|| {
 ///
 /// Panics if the memory map was not found in MEMORY_MAP_REQUEST.
 pub fn get_memory_map() -> &'static MemoryMapResponse {
-    if let Some(memory_map) = MEMORY_MAP_REQUEST.get_response() {
-        return memory_map;
-    } else {
-        unreachable!("Could not fetch memory map from Limine.")
-    }
+    MEMORY_MAP_REQUEST.get_response().map_or_else(
+        || unreachable!("Could not fetch memory map from Limine."),
+        |memory_map| memory_map,
+    )
 }
@@ -1,134 +0,0 @@
-use lib_alloc::allocator::FoundryAllocator;
-use limine::{memory_map::EntryType, response::MemoryMapResponse};
-use x86_64::{
-    addr,
-    registers::control::Cr3,
-    structures::paging::{
-        page_table::FrameError, FrameAllocator, OffsetPageTable, PageTable, PhysFrame, Size4KiB,
-    },
-    PhysAddr, VirtAddr,
-};
-
-/// Returns a mutable reference to the current level 4 page table.
-///
-/// # Safety
-///
-/// The caller must ensure that the level 4 page table is not modified
-/// simultaneously. The caller must also ensure that the physical memory offset
-/// is correct, to ensure that the correct virtual address is constructed.
-unsafe fn active_l4_table(physical_memory_offset: VirtAddr) -> &'static mut PageTable {
-    let (level_4_frame, _) = Cr3::read();
-
-    let phys_addr = level_4_frame.start_address();
-    let virt = phys_addr.as_u64() + physical_memory_offset.as_u64();
-    &mut *(virt as *mut PageTable)
-}
-
-/// Initializes the `OffsetPageTable` for the current CPU architecture.
-///
-/// # Safety
-///
-/// This function must be called only once and should be called before any
-/// memory operations are performed that rely on virtual memory management.
-/// The provided `physical_memory_offset` must be accurate to ensure correct
-/// translation of physical addresses.
-///
-/// # Parameters
-///
-/// - `physical_memory_offset`: The offset to convert physical addresses to
-///   virtual addresses in the higher-half direct map.
-///
-/// # Returns
-///
-/// Returns an `OffsetPageTable` that allows for manipulation of the page
-/// tables for the current CPU architecture.
-pub unsafe fn init(physical_memory_offset: VirtAddr) -> OffsetPageTable<'static> {
-    let l4_table = active_l4_table(physical_memory_offset);
-    OffsetPageTable::new(l4_table, physical_memory_offset)
-}
-
-pub(crate) struct FoundryOSFrameAllocator {
-    memory_map: &'static MemoryMapResponse,
-    next: usize,
-}
-
-impl FoundryOSFrameAllocator {
-    /// Creates a new `FoundryOSFrameAllocator` from a memory map.
-    ///
-    /// This function takes a reference to a `MemoryMapResponse` and initializes a
-    /// `FoundryOSFrameAllocator` with it. The `next` field is set to 0, indicating that
-    /// the first frame to be allocated is the first frame in the memory map.
-    pub unsafe fn init(memory_map: &'static MemoryMapResponse) -> FoundryOSFrameAllocator {
-        FoundryOSFrameAllocator {
-            memory_map,
-            next: 0,
-        }
-    }
-
-    /// An iterator over all usable frames in the memory map.
-    ///
-    /// Yields one `PhysFrame` for each available 4KiB frame in the memory map.
-    ///
-    /// This function is used to allocate frames for the pagemap.
-    fn usable_frames(&self) -> impl Iterator<Item = PhysFrame> {
-        let regions = self.memory_map.entries().iter();
-        let usable_regions = regions.filter(|region| region.entry_type == EntryType::USABLE);
-
-        let addr_ranges = usable_regions.map(|region| region.base..region.base + region.length);
-
-        let frame_addresses = addr_ranges.flat_map(|r| r.step_by(4096));
-
-        frame_addresses.map(|addr| PhysFrame::from_start_address(PhysAddr::new(addr)).unwrap())
-    }
-}
-
-unsafe impl FrameAllocator<Size4KiB> for FoundryOSFrameAllocator {
-    /// Allocates a frame from the list of usable frames.
-    ///
-    /// This function returns the next available `PhysFrame` from the memory map,
-    /// if one exists. Once a frame is allocated, the internal counter is incremented
-    /// to point to the next frame for future allocations.
-    ///
-    /// # Returns
-    ///
-    /// - `Some(PhysFrame)`: If a usable frame is available.
-    /// - `None`: If there are no more usable frames to allocate.
-
-    fn allocate_frame(&mut self) -> Option<PhysFrame> {
-        let frame = self.usable_frames().nth(self.next);
-        self.next += 1;
-        frame
-    }
-}
-
-// pub unsafe fn translate_addr(addr: VirtAddr, physical_memory_offset: VirtAddr) -> Option<PhysAddr> {
-//     translate_addr_inner(addr, physical_memory_offset)
-// }
-
-// fn translate_addr_inner(addr: VirtAddr, physical_memory_offset: VirtAddr) -> Option<PhysAddr> {
-//     let (l4_table_frame, _) = Cr3::read();
-
-//     let table_indexes = [
-//         addr.p4_index(),
-//         addr.p3_index(),
-//         addr.p2_index(),
-//         addr.p1_index(),
-//     ];
-//     let mut frame = l4_table_frame;
-
-//     for &i in &table_indexes {
-//         let virt = physical_memory_offset + frame.start_address().as_u64();
-//         let table_ptr: *const PageTable = virt.as_ptr();
-//         let table = unsafe { &*table_ptr };
-
-//         let entry = &table[i];
-
-//         frame = match entry.frame() {
-//             Ok(frame) => frame,
-//             Err(FrameError::FrameNotPresent) => return None,
-//             Err(FrameError::HugeFrame) => panic!("huge frames are not supported!"),
-//         };
-//     }
-
-//     Some(frame.start_address() + u64::from(addr.page_offset()))
-// }
@@ -1,7 +1,6 @@
+pub mod apic;
+pub mod cpu;
+pub mod dev;
 pub mod gdt;
-
 pub mod interrupts;
-
-pub mod memory;
-
-pub(crate) mod memmap;
+pub mod memmap;
@@ -0,0 +1,64 @@
+#[repr(u32)]
+#[derive(Copy, Clone, PartialEq, Eq, Debug)]
+// Some predefined colours as well as custom colours in the proper format. This
+// assumes that the framebuffer uses 32bpp, something which we will assert on
+// initialisation.
+pub enum Colour {
+    Argb(u8, u8, u8, u8),
+    Rgb(u8, u8, u8),
+    HexARGB(u32),
+    Black = 0x000000FF,
+    Blue = 0x0000FFFF,
+    Green = 0x00FF00FF,
+    Cyan = 0x00FFFFFF,
+    Red = 0xFF0000FF,
+    Magenta = 0xFF00FFFF,
+    Yellow = 0xFFFF00FF,
+    White = 0xFFFFFFFF,
+}
+
+#[expect(
+    clippy::use_self,
+    reason = "Self is uglier and more verbose than `u32`"
+)]
+impl From<Colour> for u32 {
+    fn from(val: Colour) -> Self {
+        match val {
+            Colour::Argb(a, r, g, b) => {
+                (a as u32) << 24 | (r as u32) << 16 | (g as u32) << 8 | (b as u32)
+            }
+            Colour::Rgb(r, g, b) => {
+                ((r as u32) << 16) | (g as u32) << 8 | (b as u32)
+            }
+            Colour::HexARGB(hex) => hex,
+            Colour::Black => 0xFF000000,
+            Colour::Blue => 0xFF0000FF,
+            Colour::Green => 0xFF00FF00,
+            Colour::Cyan => 0xFF00FFFF,
+            Colour::Red => 0xFFFF0000,
+            Colour::Magenta => 0xFFFF00FF,
+            Colour::Yellow => 0xFFFFFF00,
+            Colour::White => 0xFFFFFFFF,
+        }
+    }
+}
+
+impl core::fmt::Display for Colour {
+    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+        match self {
+            Self::Argb(r, g, b, a) => {
+                write!(f, "RGBA(#{:x}{:x}{:x}{:x})", r, g, b, a)
+            }
+            Self::Rgb(r, g, b) => write!(f, "RGB(#{:x}{:x}{:x})", r, g, b),
+            Self::HexARGB(hex) => write!(f, "Hex(#{:x})", hex),
+            Self::Black => write!(f, "Black"),
+            Self::Blue => write!(f, "Blue"),
+            Self::Green => write!(f, "Green"),
+            Self::Cyan => write!(f, "Cyan"),
+            Self::Red => write!(f, "Red"),
+            Self::Magenta => write!(f, "Magenta"),
+            Self::Yellow => write!(f, "Yellow"),
+            Self::White => write!(f, "White"),
+        }
+    }
+}
@@ -0,0 +1,46 @@
+#![allow(unused)]
+use libm::include_font;
+
+pub const FONT_SPLEEN_8X16: Font =
+    Font::new(include_font!("../../resources/font/spleen-8x16.psf"));
+
+pub const FONT_CP850_8X16: Font =
+    Font::new(include_font!("../../resources/font/cp850-8x16.psf"));
+
+pub struct Font {
+    width: usize,
+    height: usize,
+    length: u16,
+    data: [[u8; 16]; 512],
+}
+
+impl Font {
+    pub const fn new(data: [[u8; 16]; 512]) -> Self {
+        Self {
+            width: 8,
+            height: 16,
+            length: data.len() as u16,
+            data,
+        }
+    }
+
+    pub const fn glyph_for(&self, c: u16) -> &[u8] {
+        if c > self.length {
+            return &self.data[0];
+        }
+
+        &self.data[c as usize]
+    }
+
+    pub const fn width(&self) -> usize {
+        self.width
+    }
+
+    pub const fn height(&self) -> usize {
+        self.height
+    }
+
+    pub const fn default() -> &'static Self {
+        &FONT_SPLEEN_8X16
+    }
+}
@@ -0,0 +1,158 @@
+//! Handles setting up the framebuffer passed to us by Limine.
+#![expect(unused)]
+use crate::DEFAULT_FONT;
+
+use super::{colour::Colour, font::Font};
+
+use limine::framebuffer::Framebuffer;
+use limine::request::FramebufferRequest;
+use spin::{Lazy, Mutex};
+
+#[used]
+#[unsafe(link_section = ".requests")]
+/// The Limine framebuffer request.
+static FRAMEBUFFER_REQUEST: FramebufferRequest = FramebufferRequest::new();
+
+/// A mutex used for writing to the framebuffer, in most cases we can abstract
+/// this behind calls to println! etc.
+pub static FRAMEBUFFER_WRITER: Lazy<Mutex<Option<FramebufferWriter>>> = Lazy::new(
+    || {
+        Mutex::new(FRAMEBUFFER_REQUEST.get_response().map_or_else(
+            || {
+                unreachable!("Framebuffer request failed, got None.");
+            },
+            |framebuffer_response| {
+                let framebuffer =
+                    framebuffer_response.framebuffers().next()
+                    .expect("Expected to find at least one framebuffer in response, got zero.");
+                Some(FramebufferWriter::new(framebuffer, Colour::Black))
+            },
+        ))
+    },
+);
+
+/// The updated writer stores necessary fields from the [Framebuffer].
+/// This ensures that the contained types are Send, as Framebuffer was
+/// not marked as Send.
+///
+/// It also avoids the requirement for lifetimes.
+///
+/// Note this does not implement Writer as these functions only handle drawing
+/// pixels.
+pub struct FramebufferWriter {
+    pitch: u64,
+    /// Number of bits used per pixel, we expect 32 so this will be asserted
+    /// when we initialise the framebuffer.
+    bpp: u16,
+    /// A raw pointer to the framebuffer.
+    addr: *mut u8,
+    /// The width of the screen in pixels.
+    width: u64,
+    /// The height of the screen in pixels.
+    height: u64,
+    /// The default background colour of the Framebuffer.
+    background_colour: Colour,
+}
+
+/// Marker trait required for sending the writer across threads, which will
+/// probably come in handy later.
+unsafe impl Send for FramebufferWriter {}
+/// Marker trait required for sharing the writer across threads, which will
+/// probably come in handy later.
+///
+/// # Note
+///
+/// We wrap this in a Mutex later so this should handle synchronising accesses.
+unsafe impl Sync for FramebufferWriter {}
+
+impl FramebufferWriter {
+    /// Creates a new [`FramebufferWriter`] with the specified background
+    /// colour.
+    ///
+    /// # Panics
+    ///
+    /// Panics if the bits per pixel for the framebuffer is not 32 bits per
+    /// pixel, because we didn't exactly handle other cases.
+    pub fn new(framebuffer: Framebuffer, background_colour: Colour) -> Self {
+        // We don't handle other cases, this should not trigger on most newer
+        // hardware.
+        assert!(framebuffer.bpp() == 32);
+
+        Self {
+            pitch: framebuffer.pitch(),
+            bpp: framebuffer.bpp(),
+            addr: framebuffer.addr(),
+            width: framebuffer.width(),
+            height: framebuffer.height(),
+            background_colour,
+        }
+    }
+
+    /// Writes a pixel with `colour` to the screen at the given `(x, y)`
+    /// coordinates (in pixels).
+    pub fn write_pixel(&self, x: usize, y: usize, colour: Colour) {
+        let pitch = self.pitch as usize;
+        let bpp = (self.bpp / 8) as usize;
+        let pixel_offset = y * pitch + x * bpp;
+
+        // Safety: We assume the pointer to the framebuffer is valid, which it likely
+        // is because we copy it from the Limine request.
+        unsafe {
+            *(self.addr.add(pixel_offset) as *mut u32) = colour.into();
+        }
+    }
+
+    /// Writes a 2D slice `buffer` to the screen. This should be less than the
+    /// size of the screen in dimensions, but does not neccessarily fill the
+    /// whole screen.
+    pub fn render_frame(&self, buffer: &[&[Colour]]) {
+        // TODO: this should return errors.
+        for (y, &row) in buffer.iter().enumerate() {
+            if y >= self.height() as usize {
+                break;
+            }
+            for (x, pixel) in row.iter().enumerate() {
+                if x >= self.width() as usize {
+                    break;
+                }
+                self.write_pixel(x, y, *pixel);
+            }
+        }
+    }
+
+    /// Returns the width of the framebuffer in pixels.
+    pub const fn width(&self) -> u32 {
+        self.width as u32
+    }
+
+    /// Returns the height of the framebuffer in pixels.
+    pub const fn height(&self) -> u32 {
+        self.height as u32
+    }
+
+    /// Sets the new default background colour.
+    pub const fn set_default_background_colour(&mut self, bg: Colour) {
+        self.background_colour = bg;
+    }
+
+    /// Clears the screen and sets the background to the default colour.
+    pub fn clear(&self) {
+        let width = self.width as usize;
+        let height = self.height as usize;
+
+        for y in 0..height {
+            for x in 0..width {
+                // Write the background in the preferred background colour.
+                self.write_pixel(x, y, self.background_colour);
+            }
+        }
+    }
+}
+
+/// Returns the screen size in pixels or (0, 0) if something went wrong.
+pub fn screensize_px() -> (u32, u32) {
+    FRAMEBUFFER_WRITER
+        .lock()
+        .as_mut()
+        .map_or_else(|| (0, 0), |writer| (writer.width(), writer.height()))
+}
@@ -0,0 +1,4 @@
+pub mod colour;
+pub mod font;
+pub mod framebuffer;
+pub mod writer;
@@ -0,0 +1,248 @@
+//! Formerly called ascii.rs, this file defines helper functions for drawing
+//! characters to the screen.
+
+use core::fmt;
+use spin::{Lazy, Mutex};
+use x86_64::instructions::interrupts;
+
+use super::{colour::Colour, font::Font, framebuffer::FRAMEBUFFER_WRITER};
+
+static FONT_WIDTH: u32 = 8;
+static FONT_HEIGHT: u32 = 16;
+
+pub static WRITER: Lazy<Mutex<Writer>> = Lazy::new(|| Mutex::new(Writer::new()));
+
+pub fn screensize_chars() -> (u32, u32) {
+    let writer = WRITER.lock();
+    (writer.screen_width, writer.screen_height)
+}
+
+pub struct Writer {
+    font: &'static Font,
+    /// Measured in chars not pixels.
+    screen_width: u32,
+    /// Measured in chars not pixels.
+    screen_height: u32,
+    /// 16 pixels tall.
+    text_line: u32,
+    /// 8 pixels wide.
+    text_col: u32,
+
+    fg_color: Colour,
+    bg_color: Colour,
+}
+
+impl Default for Writer {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
+impl Writer {
+    pub fn new() -> Self {
+        FRAMEBUFFER_WRITER.lock().as_mut().map_or_else(
+            || {
+                panic!("Framebuffer writer not initialized.");
+            },
+            |writer| Self {
+                font: &crate::DEFAULT_FONT,
+                screen_width: writer.width() / 8,
+                screen_height: writer.height() / 16,
+                text_line: 0,
+                text_col: 0,
+                fg_color: Colour::White,
+                bg_color: Colour::Black,
+            },
+        )
+    }
+
+    pub const fn set_font(&mut self, font: &'static Font) {
+        self.font = font;
+    }
+
+    /// This is sent when the user types a backspace.
+    const BACKSPACE: u8 = 8;
+
+    pub fn write_glyph(&mut self, c: u8) {
+        if c == b'\n' {
+            self.newline();
+            return;
+        } else if c == Self::BACKSPACE {
+            self.backspace();
+            return;
+        }
+
+        // Get the character data from the font array. -- each byte is a row of
+        // pixels
+        let data: &[u8] = self.font.glyph_for(c as u16);
+
+        if let Some(writer) = FRAMEBUFFER_WRITER.lock().as_mut() {
+            for (row, line) in data.iter().enumerate().take(16) {
+                for col in 0..8 {
+                    let pixel_x: u32 = self.text_col * FONT_WIDTH + col;
+                    let pixel_y: u32 = self.text_line * FONT_HEIGHT + row as u32;
+
+                    if line & (0x80 >> col) != 0 {
+                        // Write the foreground color
+                        writer.write_pixel(
+                            pixel_x as usize,
+                            pixel_y as usize,
+                            self.fg_color,
+                        );
+                    } else {
+                        // Write the background color
+                        writer.write_pixel(
+                            pixel_x as usize,
+                            pixel_y as usize,
+                            self.bg_color,
+                        );
+                    }
+                }
+            }
+        }
+
+        // Go to next position
+        if self.text_col + 1 >= self.screen_width {
+            self.newline();
+        } else {
+            self.text_col += 1;
+        }
+    }
+
+    pub const fn dimensions(&self) -> (u32, u32) {
+        (self.screen_width, self.screen_height)
+    }
+
+    pub const fn next_char(&mut self) {
+        self.text_col += 1;
+    }
+
+    pub const fn newline(&mut self) {
+        self.text_col = 0;
+
+        if self.text_line + 1 >= self.screen_height {
+            self.text_line = 0;
+        } else {
+            self.text_line += 1;
+        }
+    }
+
+    /// Handles the backspace character. TODO: Implement VT-100 style terminal
+    /// control codes alongside a shell. Not simple.
+    pub fn backspace(&mut self) {
+        if self.text_col > 0 {
+            self.text_col -= 1;
+            // Blank out the previous char.
+            self.write_glyph(b' ');
+            self.text_col -= 1;
+        }
+    }
+
+    pub fn write_string(&mut self, s: &str) {
+        for c in s.chars() {
+            self.write_glyph(c as u8);
+        }
+    }
+
+    pub const fn set_colour(&mut self, fg: Colour, bg: Colour) {
+        self.fg_color = fg;
+        self.bg_color = bg;
+    }
+
+    pub const fn reset_colour(&mut self) {
+        self.fg_color = Colour::White;
+        self.bg_color = Colour::Black;
+    }
+}
+
+impl core::fmt::Write for Writer {
+    fn write_str(&mut self, s: &str) -> core::fmt::Result {
+        self.write_string(s);
+        Ok(())
+    }
+}
+
+fn write(args: fmt::Arguments, fg: Colour, bg: Colour) {
+    use core::fmt::Write;
+
+    interrupts::without_interrupts(|| {
+        let mut writer = WRITER.lock();
+        writer.set_colour(fg, bg);
+        writer.write_fmt(args).unwrap();
+        writer.reset_colour();
+    });
+}
+
+#[doc(hidden)]
+pub fn _print(args: fmt::Arguments) {
+    x86_64::instructions::interrupts::without_interrupts(|| {
+        write(args, Colour::White, Colour::Black);
+    })
+}
+
+#[doc(hidden)]
+pub fn _print_err(args: fmt::Arguments) {
+    x86_64::instructions::interrupts::without_interrupts(|| {
+        write(args, Colour::Red, Colour::Black);
+    })
+}
+
+#[doc(hidden)]
+pub fn _print_log(args: fmt::Arguments) {
+    x86_64::instructions::interrupts::without_interrupts(|| {
+        write(args, Colour::Yellow, Colour::Black);
+    })
+}
+
+pub fn clear_screen() {
+    interrupts::without_interrupts(|| {
+        let mut writer = WRITER.lock();
+        writer.text_line = 0;
+        writer.text_col = 0;
+
+        if let Some(writer) = FRAMEBUFFER_WRITER.lock().as_mut() {
+            writer.clear();
+        }
+    });
+}
+
+pub fn reset_cursor() {
+    interrupts::without_interrupts(|| {
+        let mut writer = WRITER.lock();
+        writer.text_line = 0;
+        writer.text_col = 0;
+    });
+}
+
+#[macro_export]
+macro_rules! println_log {
+    () => ($crate::print_log!("\n"));
+    ($($arg:tt)*) => ($crate::print_log!("{}\n", format_args!($($arg)*)));
+}
+
+#[macro_export]
+macro_rules! print_log {
+    ($($arg:tt)*) => ($crate::graphics::writer::_print_log(format_args!($($arg)*)));
+}
+
+#[macro_export]
+macro_rules! println {
+    () => ($crate::print!("\n"));
+    ($($arg:tt)*) => ($crate::print!("{}\n", format_args!($($arg)*)));
+}
+
+#[macro_export]
+macro_rules! print {
+    ($($arg:tt)*) => ($crate::graphics::writer::_print(format_args!($($arg)*)));
+}
+
+#[macro_export]
+macro_rules! printlnerr {
+    () => ($crate::printerr!("\n"));
+    ($($arg:tt)*) => ($crate::printerr!("{}\n", format_args!($($arg)*)));
+}
+
+#[macro_export]
+macro_rules! printerr {
+    ($($arg:tt)*) => ($crate::graphics::writer::_print_err(format_args!($($arg)*)));
+}
@@ -0,0 +1,209 @@
+use core::{
+    pin::Pin,
+    task::{Context, Poll},
+};
+
+use crossbeam::queue::ArrayQueue;
+use futures_util::{Stream, StreamExt, task::AtomicWaker};
+use pc_keyboard::{
+    DecodedKey, HandleControl, KeyCode, Keyboard, ScancodeSet1,
+    layouts::{self, Uk105Key},
+};
+use spin::{Lazy, Mutex, Once};
+
+static KBD_QUEUE: Once<ArrayQueue<u8>> = Once::new();
+static WAKER: AtomicWaker = AtomicWaker::new();
+
+pub static KEYBOARD: Lazy<Mutex<Keyboard<Uk105Key, ScancodeSet1>>> =
+    Lazy::new(|| {
+        Mutex::new(Keyboard::new(
+            ScancodeSet1::new(),
+            // TODO: Expose an API to change the default KB layout.
+            layouts::Uk105Key,
+            HandleControl::Ignore,
+        ))
+    });
+pub static SCANCODE_STREAM: Lazy<Mutex<ScancodeStream>> =
+    Lazy::new(|| Mutex::new(ScancodeStream::new()));
+
+pub fn add_scancode(scancode: u8) {
+    if let Some(queue) = KBD_QUEUE.get() {
+        if queue.push(scancode).is_err() {
+            // println!("WARNING: scancode queue full; dropping keyboard
+            // input");
+        } else {
+            WAKER.wake();
+        }
+    } else {
+        // println!("WARNING: scancode queue not initialized");
+    }
+}
+
+pub struct ScancodeStream {
+    _private: (),
+}
+
+impl ScancodeStream {
+    pub fn new() -> Self {
+        KBD_QUEUE.call_once(|| ArrayQueue::new(5));
+        Self { _private: () }
+    }
+
+    pub fn try_next(&mut self) -> Option<u8> {
+        KBD_QUEUE.get().and_then(|queue| queue.pop())
+    }
+}
+
+impl Default for ScancodeStream {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
+impl Stream for ScancodeStream {
+    type Item = u8;
+
+    fn poll_next(
+        self: Pin<&mut Self>,
+        cx: &mut Context<'_>,
+    ) -> Poll<Option<Self::Item>> {
+        let queue = KBD_QUEUE.get().unwrap();
+
+        if let Some(scancode) = queue.pop() {
+            return Poll::Ready(Some(scancode));
+        }
+
+        WAKER.register(cx.waker());
+        WAKER.register(cx.waker());
+
+        queue.pop().map_or(Poll::Pending, |scancode| {
+            WAKER.take();
+            Poll::Ready(Some(scancode))
+        })
+    }
+}
+
+pub async fn get_keystroke_async() -> KeyStroke {
+    loop {
+        if let Some(scancode) = SCANCODE_STREAM.lock().next().await {
+            if let Ok(keystroke) = KeyStroke::try_from(scancode) {
+                return keystroke;
+            }
+        }
+    }
+}
+
+pub fn get_keystroke_optional() -> Option<KeyStroke> {
+    if let Some(scancode) = SCANCODE_STREAM.lock().try_next() {
+        if let Ok(keystroke) = KeyStroke::try_from(scancode) {
+            return Some(keystroke);
+        }
+    }
+    None
+}
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum KeyStroke {
+    Char(char),
+    Ctrl,
+    RCtrl,
+    Alt,
+    RAlt,
+    Shift,
+    RShift,
+    Meta,
+    RMeta,
+    Backspace,
+    Left,
+    Right,
+    Up,
+    Down,
+    None,
+    Enter,
+    Escape,
+    Del,
+}
+
+impl KeyStroke {
+    pub const fn from_keycode(key: KeyCode) -> Self {
+        match key {
+            KeyCode::LControl => Self::Ctrl,
+            KeyCode::RControl => Self::RCtrl,
+            KeyCode::LAlt => Self::Alt,
+            KeyCode::RAlt2 => Self::RAlt,
+            KeyCode::LShift => Self::Shift,
+            KeyCode::RShift => Self::RShift,
+            KeyCode::LWin => Self::Meta,
+            KeyCode::RWin => Self::RMeta,
+            KeyCode::Backspace => Self::Backspace,
+            KeyCode::ArrowLeft => Self::Left,
+            KeyCode::ArrowRight => Self::Right,
+            KeyCode::ArrowUp => Self::Up,
+            KeyCode::ArrowDown => Self::Down,
+            KeyCode::Return => Self::Enter,
+            KeyCode::Escape => Self::Escape,
+            KeyCode::Delete => Self::Del,
+            _ => Self::None,
+        }
+    }
+}
+
+impl TryFrom<u8> for KeyStroke {
+    type Error = ();
+
+    fn try_from(code: u8) -> Result<Self, Self::Error> {
+        let mut keyboard = KEYBOARD.lock();
+
+        let key = match keyboard.add_byte(code) {
+            Ok(Some(event)) => match keyboard.process_keyevent(event) {
+                Some(key) => key,
+                _ => return Err(()),
+            },
+            _ => return Err(()),
+        };
+
+        match key {
+            DecodedKey::Unicode(ch) => Ok(Self::Char(ch)),
+            DecodedKey::RawKey(key) => match Self::from_keycode(key) {
+                Self::None => Err(()),
+                key => Ok(key),
+            },
+        }
+    }
+}
+
+impl TryInto<char> for KeyStroke {
+    type Error = ();
+
+    fn try_into(self) -> Result<char, Self::Error> {
+        match self {
+            Self::Char(c) => Ok(c),
+            _ => Err(()),
+        }
+    }
+}
+
+impl core::fmt::Display for KeyStroke {
+    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+        match self {
+            Self::Char(c) => write!(f, "{}", c),
+            Self::Ctrl => write!(f, "CTRL"),
+            Self::RCtrl => write!(f, "RCtrl"),
+            Self::Alt => write!(f, "ALT"),
+            Self::RAlt => write!(f, "RAlt"),
+            Self::Shift => write!(f, "SHIFT"),
+            Self::RShift => write!(f, "RShift"),
+            Self::Meta => write!(f, "META"),
+            Self::RMeta => write!(f, "RMeta"),
+            Self::Backspace => write!(f, "BACKSPACE"),
+            Self::Left => write!(f, "LEFT"),
+            Self::Right => write!(f, "RIGHT"),
+            Self::Up => write!(f, "UP"),
+            Self::Down => write!(f, "DOWN"),
+            Self::Enter => write!(f, "ENTER"),
+            Self::Escape => write!(f, "ESCAPE"),
+            Self::None => write!(f, "NONE"),
+            Self::Del => write!(f, "DEL"),
+        }
+    }
+}
@@ -0,0 +1 @@
+// pub mod keyboard;
@@ -1,95 +1,74 @@
 #![no_std]
 #![feature(abi_x86_interrupt)]
+#![warn(
+    clippy::correctness,
+    clippy::nursery,
+    clippy::unnecessary_cast,
+    clippy::all,
+    clippy::suspicious,
+    clippy::perf,
+    rustdoc::missing_errors_doc,
+    rustdoc::missing_panics_doc
+)]

-extern crate alloc;
-
+use arch::x86_64::dev::serial;
+use arch::x86_64::{gdt, interrupts};
 use core::arch::asm;
-use lib_alloc::allocator::init_heap;
-use limine::request::{RequestsEndMarker, RequestsStartMarker};
+use graphics::font::{FONT_SPLEEN_8X16, Font};
 use limine::BaseRevision;

-pub use lib_ascii::{print, print_log, println, println_log, WRITER};
-pub use lib_serial::{serial_print, serial_println, serial_read};
-use x86_64::structures::paging::Translate;
-use x86_64::{PhysAddr, VirtAddr};
-
-mod arch;
+pub mod arch;
+pub mod graphics;
+pub mod io;

 /// Sets the base revision to the latest revision supported by the crate.
 /// See specification for further info.
-/// Be sure to mark all limine requests with #[used], otherwise they may be removed by the compiler.
+/// Be sure to mark all limine requests with #[used], otherwise they may be
+/// removed by the compiler.
 #[used]
 // The .requests section allows limine to find the requests faster and more safely.
-#[link_section = ".requests"]
+#[unsafe(link_section = ".requests")]
 static BASE_REVISION: BaseRevision = BaseRevision::new();

-/// Define the stand and end markers for Limine requests.
-#[used]
-#[link_section = ".requests_start_marker"]
-static _START_MARKER: RequestsStartMarker = RequestsStartMarker::new();
-#[used]
-#[link_section = ".requests_end_marker"]
-static _END_MARKER: RequestsEndMarker = RequestsEndMarker::new();
+/// The default font used when setting up the framebuffer code.
+pub const DEFAULT_FONT: Font = FONT_SPLEEN_8X16;

 #[panic_handler]
 fn rust_panic(_info: &core::panic::PanicInfo) -> ! {
-    println!("Kernel panic: {}", _info);
-    serial_println!("Kernel panic: {}", _info);
    hcf();
 }

 pub fn hcf() -> ! {
    loop {
        unsafe {
-            #[cfg(target_arch = "x86_64")]
            asm!("hlt");
-            #[cfg(any(target_arch = "aarch64", target_arch = "riscv64"))]
-            asm!("wfi");
-            #[cfg(target_arch = "loongarch64")]
-            asm!("idle 0");
        }
    }
 }

 pub fn boot() -> Result<(), &'static str> {
    if !BASE_REVISION.is_supported() {
-        return Err("base revision not supported");
+        return Err("Base Revision was not supported.");
    }

-    use arch::x86_64::{gdt, interrupts, memmap, memory};
+    print_log!("    Setting up Serial Communication... ");

-    let memory_map = memmap::get_memory_map();
+    if serial::init().is_err() {
+        println_log!("[Not Detected]")
+    } else {
+        println_log!("[Success]")
+    }

-    print_log!("    Initialising Serial... ");
-    lib_serial::init()?;
-    println_log!("[Success]");
-
-    print_log!("    Setting Up Global Descriptor Table... ");
+    print_log!("    Setting up GDT... ");
    gdt::init();
    println_log!("[Success]");

-    print_log!("    Setting Up Interrupt Descriptor Table... ");
+    interrupts::enable_pic();
+    // interrupts::disable_pic();
+
+    print_log!("    Initialising interrupts... ");
    interrupts::init_idt();
    println_log!("[Success]");

-    print_log!("    Setting Up Page Table... ");
-    let mut frame_allocator = unsafe { memory::FoundryOSFrameAllocator::init(memory_map) };
-    println_log!("[Success]");
-
-    print_log!("    Initialising Memory Subsystem... ");
-    let physical_memory_offset = VirtAddr::new(*memmap::PHYSICAL_MEMORY_OFFSET);
-    let mut l4_table = unsafe { memory::init(physical_memory_offset) };
-    println_log!("[Success]");
-
-    print_log!("    Initialising Heap... ");
-    if let Err(e) = init_heap(&mut l4_table, &mut frame_allocator) {
-        return Err("Failed to initialise heap");
-    }
-    println_log!("[Success]");
-
-    print_log!("    Enabling Interrupts... ");
-    x86_64::instructions::interrupts::enable();
-    println_log!("[Success]");
-
    Ok(())
 }
@@ -1,50 +1,12 @@
 #![no_std]
 #![no_main]

-extern crate alloc;
+use foundry_os::boot;

-use alloc::vec::Vec;
-
-use foundry_os::{println, println_log};
-
-#[no_mangle]
-unsafe extern "C" fn kmain() -> ! {
-    // All limine requests must also be referenced in a called function, otherwise they may be
-    // removed by the linker.
-
-    println_log!(" [ Initialising Kernel Systems ] ");
-    if let Err(err) = foundry_os::boot() {
-        panic!("{}", err);
-    }
-
-    println_log!("[ Kernel Initialised Successfully ] ");
-
-    let dimensions = lib_ascii::screensize_chars();
-    let dimensions2 = lib_framebuffer::screensize_px();
-
-    println!("Dimensions: {}x{} (px)", dimensions2.0, dimensions2.1);
-    println!("Dimensions: {}x{} (chars)", dimensions.0, dimensions.1);
-
-    println!(
-        "
-        $$$$$$$$\\                                  $$\\                     
-        $$  _____|                                 $$ |                    
-        $$ |    $$$$$$\\  $$\\   $$\\ $$$$$$$\\   $$$$$$$ | $$$$$$\\  $$\\   $$\\ 
-        $$$$$\\ $$  __$$\\ $$ |  $$ |$$  __$$\\ $$  __$$ |$$  __$$\\ $$ |  $$ |
-        $$  __|$$ /  $$ |$$ |  $$ |$$ |  $$ |$$ /  $$ |$$ |  \\__|$$ |  $$ |
-        $$ |   $$ |  $$ |$$ |  $$ |$$ |  $$ |$$ |  $$ |$$ |      $$ |  $$ |
-        $$ |   \\$$$$$$  |\\$$$$$$  |$$ |  $$ |\\$$$$$$$ |$$ |      \\$$$$$$$ |
-        \\__|    \\______/  \\______/ \\__|  \\__| \\_______|\\__|       \\____$$ |
-             $$$$$$\\   $$$$$$\\        $$\\    $$\\   $$\\           $$\\   $$ |
-            $$  __$$\\ $$  __$$\\       $$ |   $$ |$$$$ |          \\$$$$$$  |
-            $$ /  $$ |$$ /  \\__|      $$ |   $$ |\\_$$ |           \\______/ 
-            $$ |  $$ |\\$$$$$$\\        \\$$\\  $$  |  $$ |                  
-            $$ |  $$ | \\____$$\\        \\$$\\$$  /   $$ |                  
-            $$ |  $$ |$$\\   $$ |        \\$$$  /    $$ |                  
-             $$$$$$  |\\$$$$$$  |         \\$  /   $$$$$$\\                 
-             \\______/  \\______/           \\_/    \\______|                              
-    "
-    );
+#[unsafe(no_mangle)]
+extern "C" fn kmain() -> ! {
+    _ = boot();

+    #[allow(clippy::empty_loop)]
    loop {}
 }
@@ -0,0 +1,15 @@
+[package]
+name = "libm"
+version.workspace = true
+edition.workspace = true
+authors.workspace = true
+
+[dependencies]
+darling = "0.20.10"
+proc-macro2 = "1.0.93"
+quote = "1.0.38"
+syn = "2.0.98"
+
+
+[lib]
+proc-macro = true
@@ -0,0 +1,3 @@
+[toolchain]
+channel = "nightly"
+targets = ["x86_64-linux-gnu"]
@@ -0,0 +1,114 @@
+#![feature(proc_macro_span)]
+#![warn(
+    clippy::correctness,
+    clippy::nursery,
+    clippy::unnecessary_cast,
+    clippy::all,
+    clippy::suspicious,
+    clippy::perf,
+    rustdoc::missing_errors_doc,
+    rustdoc::missing_panics_doc
+)]
+
+use std::fs::File;
+use std::io::{Read, Seek, SeekFrom};
+
+use proc_macro::{Span, TokenStream};
+use quote::quote;
+use std::path::PathBuf;
+use syn::{LitStr, parse_macro_input};
+extern crate proc_macro;
+
+#[proc_macro]
+/// Expects the file path to be relative to the current file so this works
+/// similarly to the standard Rust include! macros.
+pub fn include_font(item: TokenStream) -> TokenStream {
+    let span = Span::call_site();
+    let source_file = span.source_file();
+
+    if !source_file.is_real() {
+        panic!(
+            "We can't handle finding files if the source file does not exist. TODO: Can we?"
+        )
+    }
+
+    let filename = parse_macro_input!(item as LitStr);
+    let source_filepath: PathBuf = source_file.path();
+    let file_path = format!(
+        "{}/{}",
+        source_filepath.parent().unwrap_or_else(|| panic!("Expected to find the calling source file in a folder like src! Got: {}", source_filepath.display())).display(),
+        filename.value()
+    );
+
+    let font_bytes = match load_file(file_path) {
+        Ok(bytes) => bytes,
+        Err(why) => panic!("{}", why),
+    };
+
+    let font_data = match Font::new(font_bytes) {
+        Ok(font) => font.0,
+        Err(why) => panic!("{}", why),
+    };
+
+    quote!(
+        [
+            #(
+                [#(#font_data),*]
+            ),*
+        ]
+    )
+    .into()
+}
+
+struct Font([[u8; 16]; 512]);
+
+impl Font {
+    const MAGIC: u16 = 0x3604;
+
+    pub fn new(data: [u8; (32 + 2) * 512 + 4]) -> Result<Self, &'static str> {
+        let magic: u16 = (data[0] as u16) << 8 | data[1] as u16;
+        let mode = data[2];
+        let size = data[3];
+
+        if magic != Self::MAGIC {
+            return Err("Magic value is invalid!");
+        }
+
+        let has_512_glyphs = (mode & 0x01) != 0;
+        let mut glyphs = [[0; 16]; 512];
+        let glyph_count = if has_512_glyphs { 512 } else { 256 };
+
+        for i in 0..(glyph_count as usize) {
+            let mut buff: [u8; 16] = [0; 16];
+            for j in 0..(size as usize) {
+                buff[j] = data[4 + i * (size as usize) + j];
+            }
+            glyphs[i] = buff;
+        }
+
+        Ok(Self(glyphs))
+    }
+}
+
+type FileContents = [u8; (32 + 2) * 512 + 4];
+fn load_file(filename: String) -> Result<FileContents, std::io::Error> {
+    let mut buf = [0; (32 + 2) * 512 + 4];
+    let mut f = File::open(filename).unwrap();
+    f.seek(SeekFrom::Start(0)).unwrap();
+
+    loop {
+        match f.read(&mut buf) {
+            Ok(read) => {
+                if read == 0 {
+                    break;
+                }
+            }
+            Err(why) => {
+                eprintln!("Failed to read PS1 font file: {}", why);
+                return Err(why);
+            }
+        }
+    }
+
+    Ok(buf)
+}
@@ -0,0 +1,5 @@
+max_width = 85
+format_code_in_doc_comments = true
+comment_width = 80
+wrap_comments = true
+inline_attribute_width = 80
@@ -13,8 +13,9 @@ set -e
 trap 'echo -e "${RED}${BOLD}error${NC}: build failed" >&2' ERR

 # Get absolute path to project root
-script_dir=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
 project_root=$(cd "$script_dir/.." &>/dev/null && pwd)
+build_dir="$project_root/build"
+iso_root="$build_dir/iso_root"

 # Logging functions
 info() {
@@ -47,13 +48,8 @@ copy_file() {
    cp "$1" "$2" || error $3
 }

-build_dir="$project_root/build"
-iso_root="$build_dir/iso_root"
-
 # Check if we're running tests
-is_test=0
 if [[ $1 == *"deps"* ]]; then
-    is_test=1
    kernel_path="$1"
 else
    # Build the kernel normally
@@ -111,76 +107,3 @@ xorriso -as mkisofs -R -r -J -b boot/limine/limine-bios-cd.bin \
 # Install Limine
 info "Installing Limine bootloader"
 "$build_dir/limine/limine" bios-install "$build_dir/image.iso" || error "failed to install limine"
-
-# Check if KVM is available
-if [ "${KVM_FLAG:-enable}" = "disable" ]; then
-    warning "KVM acceleration disabled by user"
-    kvm_flag=""
-elif [ -c "/dev/kvm" ] && [ -w "/dev/kvm" ]; then
-    info "KVM acceleration enabled"
-    kvm_flag="-enable-kvm"
-else
-    warning "KVM acceleration not available (is kvm module loaded?)"
-    kvm_flag=""
-fi
-
-# Check if we're running in debug mode
-if [[ "$(cargo metadata --format-version=1 | jq -r '.workspace_members[0]' | cut -d' ' -f2)" == "(debug)" ]]; then
-    debug_flags="-s -S"
-else
-    debug_flags=""
-fi
-
-# Set up test-specific flags
-if [ $is_test -eq 1 ]; then
-    test_flags="-device isa-debug-exit,iobase=0xf4,iosize=0x04 -display none"
-    serial_flags="-serial stdio"
-else
-    test_flags=""
-    # serial_flags="-serial tcp:127.0.0.1:1234,server -monitor telnet:127.0.0.1:1235,server"
-    serial_flags="-serial stdio"
-fi
-
-# Run in QEMU
-if [[ ${QEMU_FLAGS} == *-S* ]]; then
-    info "Running OS in QEMU with GDB debugging enabled"
-    info "To connect GDB, run: gdb"
-    info "At the GDB prompt, type: target remote localhost:1234"
-else
-    info "Running OS in QEMU..."
-fi
-
-check_test_res() {
-    qemu_exit_code=$?
-    if [ $qemu_exit_code -eq 33 ]; then
-        # Success case (0x10 << 1) | 1 = 33
-        info "All tests passed"
-        exit 0
-    elif [ $qemu_exit_code -eq 35 ]; then
-        # Failure case (0x11 << 1) | 1 = 35
-        warning "Some tests failed"
-        exit 1
-    else
-        # Any other exit code is treated as a failure
-        warning "Some tests failed"
-        exit 1
-    fi
-}
-
-
-kvm_flag=""
-
-trap 'check_test_res "tests completed"' ERR
- 
-cd "$project_root"
-qemu-system-x86_64 -M q35 \
-    ${kvm_flag} \
-    -cdrom "$build_dir/image.iso" \
-    -boot d \
-    -m 2G \
-    ${serial_flags} \
-    -no-reboot \
-    ${test_flags} \
-    ${debug_flags} \
-    ${QEMU_FLAGS:-}
-
@@ -0,0 +1,20 @@
+#!/bin/bash
+
+script_dir=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
+
+source scripts/build.sh
+
+warning "This script will OVERWRITE whatever media you throw at it\nwith the built ISO."
+
+info "sudo ./hardware.sh /dev/yourdisk"
+
+if ! echo "$1" | grep -q "/dev"; then
+    error "invalid device"
+fi
+
+read -p "Confirm (y/n): " confirmation
+if [ "$confirmation" != "y" ]; then
+    exit 0
+fi
+
+dd if=./build/image.iso of="$1"
@@ -0,0 +1,109 @@
+#!/bin/bash
+
+# Script originally written by zxq5, I added separate scripts to remove `jq` dependency.
+
+script_dir=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
+
+source $script_dir/build.sh
+
+# Error handling
+set -e
+trap 'echo -e "${RED}${BOLD}error${NC}: build failed" >&2' ERR
+
+echo -e "${GREEN}${BOLD} Running kernel in debug mode."
+
+# Check if KVM is available
+if [ "${KVM_FLAG:-enable}" = "disable" ]; then
+    warning "KVM acceleration disabled by user"
+    kvm_flag=""
+elif [ -c "/dev/kvm" ] && [ -w "/dev/kvm" ]; then
+    info "KVM acceleration enabled"
+    kvm_flag="-enable-kvm"
+else
+    warning "KVM acceleration not available (is kvm module loaded?)"
+    kvm_flag=""
+fi
+
+# Enable using GDB with $USE_GDB.
+if [ $USE_GDB ]; then
+    debug_flags="-s -S"
+else
+    debug_flags=""
+fi
+
+# Set up test-specific flags
+if [ $is_test -eq 1 ]; then
+    test_flags="-device isa-debug-exit,iobase=0xf4,iosize=0x04 -display none"
+    serial_flags="-serial stdio"
+else
+    test_flags=""
+    # serial_flags="-serial tcp:127.0.0.1:1234,server -monitor telnet:127.0.0.1:1235,server"
+    serial_flags="-serial stdio"
+fi
+
+# Set up VM memory
+if [ $VM_MEMORY ]; then
+    vm_memory_flag="-m $VM_MEMORY"
+else
+    vm_memory_flag="-m 2G"
+fi
+
+# Set up boot flags
+if [ $USE_LEGACY_BIOS ]; then
+    boot_flags=""
+else
+#   Check for the presence of the OVMF firmware.
+    if [ ! -f $build_dir/RELEASEX64_OVMF_CODE.fd ]; then
+        info "Downloading OVMF UEFI firmware for QEMU"
+        info "To disable this, set USE_LEGACY_BIOS=1."
+        pushd $build_dir
+        curl https://retrage.github.io/edk2-nightly/bin/RELEASEX64_OVMF_CODE.fd -LO || error "failed to download OVMF firmware for UEFI"
+        curl https://retrage.github.io/edk2-nightly/bin/RELEASEX64_OVMF_VARS.fd -LO || error "failed to download OVMF firmware for UEFI"
+        popd
+    fi
+
+    boot_flags="-drive if=pflash,format=raw,readonly=on,file=$build_dir/RELEASEX64_OVMF_CODE.fd \
+                -drive if=pflash,format=raw,file=$build_dir/RELEASEX64_OVMF_VARS.fd"
+fi
+
+# Run in QEMU
+if [[ ${QEMU_FLAGS} == *-S* ]]; then
+    info "Running OS in QEMU with GDB debugging enabled"
+    info "To connect GDB, run: gdb"
+    info "At the GDB prompt, type: target remote localhost:1234"
+else
+    info "Running OS in QEMU..."
+fi
+
+check_test_res() {
+    qemu_exit_code=$?
+    if [ $qemu_exit_code -eq 33 ]; then
+        # Success case (0x10 << 1) | 1 = 33
+        info "All tests passed"
+        exit 0
+    elif [ $qemu_exit_code -eq 35 ]; then
+        # Failure case (0x11 << 1) | 1 = 35
+        warning "Some tests failed"
+        exit 1
+    else
+        # Any other exit code is treated as a failure
+        warning "Some tests failed"
+        exit 1
+    fi
+}
+
+trap 'check_test_res "tests completed"' ERR
+ 
+cd "$project_root"
+qemu-system-x86_64 -M q35 \
+    -cdrom "$build_dir/image.iso" \
+    ${kvm_flag} \
+    -boot d \
+    ${vm_memory_flag} \
+    ${serial_flags} \
+    -no-reboot \
+    ${test_flags} \
+    ${debug_flags} \
+    ${boot_flags} \
+    ${QEMU_FLAGS:-}
+
@@ -0,0 +1,60 @@
+#!/bin/bash
+
+# Script originally written by zxq5, I added separate scripts to remove `jq` dependency.
+
+script_dir=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
+
+source $script_dir/build.sh
+
+# Error handling
+set -e
+trap 'echo -e "${RED}${BOLD}error${NC}: build failed" >&2' ERR
+
+echo -e "${GREEN}${BOLD} Running kernel in release mode."
+
+
+if [ $VM_MEMORY ]; then
+    vm_memory_flag="-m $VM_MEMORY"
+else
+    vm_memory_flag="-m 2G"
+fi
+
+# Check if KVM is available
+if [ "${KVM_FLAG:-enable}" = "disable" ]; then
+    warning "KVM acceleration disabled by user"
+    kvm_flag=""
+elif [ -c "/dev/kvm" ] && [ -w "/dev/kvm" ]; then
+    info "KVM acceleration enabled"
+    kvm_flag="-enable-kvm"
+else
+    warning "KVM acceleration not available (is kvm module loaded?)"
+    kvm_flag=""
+fi
+
+if [ $USE_LEGACY_BIOS ]; then
+    boot_flags=""
+else
+#   Check for the presence of the OVMF firmware.
+    if [ ! -f $build_dir/RELEASEX64_OVMF_CODE.fd ]; then
+        info "Downloading OVMF UEFI firmware for QEMU"
+        info "To disable this, set USE_LEGACY_BIOS=1."
+        pushd $build_dir
+        curl https://retrage.github.io/edk2-nightly/bin/RELEASEX64_OVMF_CODE.fd -LO || error "failed to download OVMF firmware for UEFI"
+        curl https://retrage.github.io/edk2-nightly/bin/RELEASEX64_OVMF_VARS.fd -LO || error "failed to download OVMF firmware for UEFI"
+        popd
+    fi
+
+    boot_flags="-drive if=pflash,format=raw,readonly=on,file=$build_dir/RELEASEX64_OVMF_CODE.fd \
+                -drive if=pflash,format=raw,file=$build_dir/RELEASEX64_OVMF_VARS.fd"
+fi
+
+cd "$project_root"
+qemu-system-x86_64 -M q35 \
+    ${kvm_flag} \
+    -cdrom "$build_dir/image.iso" \
+    -boot d \
+    ${vm_memory_flag} \
+    ${serial_flags} \
+    -no-reboot \
+    ${boot_flags}
+
Author	SHA1	Message	Date
nullndvoid	9ed3b73df8	Add HAL/abstractions to TODOs	2025-02-28 23:07:16 +00:00
nullndvoid	ad5edb57db	Move serial driver to arch::x86_64::dev::serial	2025-02-28 23:03:12 +00:00
nullndvoid	394e932b9c	Update some docs and add a little more code to main	2025-02-28 22:45:31 +00:00
nullndvoid	fdd556f742	Fix more clippy errors, missing safety docs	2025-02-28 22:21:51 +00:00
nullndvoid	4bad44e475	Supressed clippy errors and add some rust docs	2025-02-28 21:12:41 +00:00
nullndvoid	096a66adbb	Start refactoring code. No rush to merge anything. I will try to focus on getting things working, as simply as possible	2025-02-28 17:21:44 +00:00
nullndvoid	53d325749d	Fix incorrect target name in config	2025-02-28 16:15:26 +00:00
zxq5	8a3e9e3afc	- implemented a custom allocator (fixed size block) with a fallback (linked list allocator) for larger block sizes - apic code still not working (commented out, check lib.rs)	2025-02-28 04:18:35 +00:00
zxq5	e38c20dbd3	Merge pull request 'editor' (#6 ) from editor into dev Reviewed-on: OsDev/FoundryOS#6	2025-02-28 03:05:38 +00:00
zxq5	c8bb85364c	- updated to-dos - removed unnecessary debugging code - moved x86_64-kernel.json to the project root	2025-02-28 03:05:10 +00:00
zxq5	fe18004f7d	Merge remote-tracking branch 'origin' into editor merging into dev	2025-02-27 23:58:01 +00:00
zxq5	192100be7a	changed page allocation to happen on page fault for performance reasons	2025-02-27 23:57:23 +00:00
nullndvoid	2915d0c879	Add tips on debugging/disassembling kernel sources	2025-02-27 23:32:05 +00:00
zxq5	9852cb14eb	updated build scripts	2025-02-27 22:58:10 +00:00
zxq5	db8dbff9f2	added memory allocation flag to run command ```VM_MEMORY=<amount>G cargo run```	2025-02-27 21:57:58 +00:00
zxq5	2178215a01	fixed triple fault	2025-02-27 16:52:31 +00:00
zxq5	821759ec63	apic broken pushing to debug	2025-02-27 16:19:43 +00:00
zxq5	0b3dbed4be	updated documentation	2025-02-27 02:30:48 +00:00
zxq5	3b6e272fd2	not working	2025-02-27 01:16:07 +00:00
zxq5	ac0b47a45c	merge	2025-02-26 04:00:00 +00:00
zxq5	15f59e68d5	initial apic implementaion (Commented out / NOT WORKING)	2025-02-26 03:48:11 +00:00
nullndvoid	b7397d8a1b	Remove unused clippy lints	2025-02-25 03:20:05 +00:00
nullndvoid	4fe6109e5b	Rename scheduling to 'async_io', general cleanup	2025-02-25 03:18:12 +00:00
nullndvoid	e294a13a91	Cleanup the README a little more	2025-02-25 02:59:55 +00:00
nullndvoid	752800a3ca	Merge UEFI support for qemu into our runner scripts/build system	2025-02-25 02:56:48 +00:00
nullndvoid	177fddcf7d	Add warnings to hardware script (dd implies 'doubly dangerous')	2025-02-25 02:55:52 +00:00
nullndvoid	375c5aa561	Update limine.conf to boot up faster	2025-02-25 02:54:19 +00:00
nullndvoid	b945416665	Add qemu UEFI firmware support.	2025-02-25 02:53:28 +00:00
zxq5	27ee8226d8	implemented stdin methods for reading a string (async) and reading keystrokes (sync + async). added a very basic shell on top of it for debugging	2025-02-25 02:16:01 +00:00
nullndvoid	00d3a1de72	fb: Added support for typing backspaces.	2025-02-24 23:24:03 +00:00
zxq5	f7723a3944	making the keyboard module more flexible, still needs work	2025-02-24 18:24:21 +00:00
zxq5	438ef7a748	stop banning mod.rs	2025-02-24 16:30:38 +00:00
zxq5	2f7ab8fe6b	Merge remote-tracking branch 'refs/remotes/origin/dev' into dev	2025-02-24 16:29:58 +00:00
zxq5	ca1c695e32	created stdio module, added hardware script	2025-02-24 16:28:56 +00:00
zxq5	1c22f89665	reverted dumb change	2025-02-24 15:34:46 +00:00
nullndvoid	1c147dd933	Ban module inception, this is annoying. @zxq5 thoughts?	2025-02-24 15:34:29 +00:00
zxq5	91044f5fad	merged dumb change	2025-02-24 15:33:59 +00:00
zxq5	d5b15826e2	adding std io idk	2025-02-24 15:33:42 +00:00
nullndvoid	39f1f4905d	Ban mod.rs.	2025-02-24 15:29:39 +00:00
nullndvoid	03a3469d20	Formatting changes to task.rs	2025-02-24 15:19:01 +00:00
nullndvoid	2cbe9641aa	Use prelude lol.	2025-02-24 15:14:12 +00:00
zxq5	e303ecf5a4	fixed merge commit tomfoolery.	2025-02-24 15:14:21 +00:00
zxq5	2f08835d69	merge commit. probably broken tbh	2025-02-24 15:10:58 +00:00
nullndvoid	8d57540566	Fix clippy errors	2025-02-24 15:02:44 +00:00
zxq5	03290e52a3	fixed a dumb error about me hardcoding paths	2025-02-24 13:07:11 +00:00
zxq5	8908a6a281	Update README.md	2025-02-24 03:45:02 +00:00
zxq5	aefc368d41	updated readme for more comprehensive build instructions	2025-02-24 03:44:22 +00:00
zxq5	76ec29b7ec	changed #usage back to being a tag (was not a markdown fail, it's an obsidian tag)	2025-02-24 03:36:28 +00:00
zxq5	d9bbdff08c	- added a new libary libm containing procedural macros for the kernel. these should be used to include external files and resources in the kernel binary at compile time. - libm currently supports loading psf-1 formatted fonts - added two fonts that are included in the binary at compile time - refactored libk to make the crate structure more organised and maintainable in future. new structure: - drivers (hardware interaction) - resources (consts and statics included either manually or via macros) - std (standard functions for higher level interaction with the os, for example creating windows) - added geometry.rs - provides the Vec2<T> struct for use with dimensions, coordinates etc. - added window.rs - provides the Window struct for rendering the state of an application to the screen - added application.rs - provides the Application trait for custom programs to implement in order to run	2025-02-24 03:26:49 +00:00
zxq5	7ff33659fe	async works!	2025-02-23 19:27:13 +00:00
zxq5	efe3034ad0	Merge pull request 'libk now replaces the plethora of lib crates' (#5 ) from nullndvoid/FoundryOS:dev into dev Reviewed-on: OsDev/FoundryOS#5	2025-02-23 17:07:25 +00:00
nullndvoid	d9b66f8008	Update README to remove refs to submodules.	2025-02-23 12:06:50 +00:00
nullndvoid	2be5b63af7	Fix some more clippy lints.	2025-02-23 11:58:52 +00:00
nullndvoid	7e62bdae35	Make rust-analyzer use clippy as the check command.	2025-02-23 11:53:42 +00:00
nullndvoid	b8aa203c05	Bump edition to now stable 2024 edition (shiny!).	2025-02-23 11:52:54 +00:00
nullndvoid	9f83c5f295	Merge GDB support (and updated runner scripts) into dev.	2025-02-23 11:47:51 +00:00
nullndvoid	914cb4e409	Enable support for $USE_GDB when running in debug mode.	2025-02-23 11:43:26 +00:00
nullndvoid	43b1db41ca	Introducing the hottest library crate in town (libk!)	2025-02-23 04:43:22 +00:00
nullndvoid	c763f512f1	Accidentally forgot to add lib alloc lol	2025-02-23 03:16:22 +00:00
nullndvoid	5dc73e7000	Update Cargo.toml to use new registry	2025-02-23 03:15:19 +00:00
nullndvoid	ca906767db	Update docs (markdown fail) and checkout libraries again	2025-02-23 02:19:38 +00:00
nullndvoid	ef8d028211	Update liballoc and libapplication.	2025-02-23 02:15:44 +00:00
nullndvoid	2886fe5ecf	Update	2025-02-23 02:07:01 +00:00
nullndvoid	c2c552ef25	Fixed most of the clippy warnings/suggestions.	2025-02-23 02:05:13 +00:00
nullndvoid	e722874cee	Formatting and fixing warnings	2025-02-23 01:38:21 +00:00
zxq5	27b0ed634c	setup but not working	2025-02-22 23:12:46 +00:00