Added some docs and an example for how to use the APIC

.gitignore

@@ -1,2 +1,3 @@
 /target/
 **/*.rs.bk
+.idea

Cargo.toml

@@ -28,6 +28,7 @@ members = [
     "tests/test_kernels/min_stack",
     "tests/test_kernels/lower_memory_free",
     "tests/test_kernels/write_usable_memory",
+    "docs/apic_example",
 ]
 exclude = ["examples/basic", "examples/test_framework"]
 

docs/apic_example/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "apic_example"
+edition = "2021"
+version.workspace = true
+license.workspace = true
+repository.workspace = true
+
+[dependencies]
+bootloader_api = { workspace = true }
+x86_64 = "=0.15.1"
+lazy_static = "=1.5.0"
+spin = "=0.9.8"
+acpi = "=4.1.1"
+log = "=0.4.19"

docs/apic_example/apic.md

@@ -0,0 +1,30 @@
+# How to use the APIC
+
+## src/main.rs
+
+In the example provided we will be using a dynamic memory mapping. This is for exemplification only and can be changed
+with your own implementation of the memory mapper.
+
+## src/apic.rs
+
+Here we create an `AcpiHandlerImpl` that implements the `AcpiHandler` trait from the `apic` crate.
+We have also added an enum with all the APIC registers from
+the [OS Dev Wiki](https://wiki.osdev.org/APIC)
+The main functions of the file are:
+
+- Init the Local APIC
+- Init the IO APIC
+- Map the APIC
+
+## src/frame_allocator.rs
+
+This implements a basic frame allocator based on the [blog post](https://os.phil-opp.com/heap-allocation/)
+
+## src/gdt.rs
+
+Implements a basic Global Descriptor Table based on
+the [blog post](https://os.phil-opp.com/double-fault-exceptions/#the-global-descriptor-table/) as well as ensures that
+all segment registers are written, including `ss` and `ds`.
+
+## src/idt.rs
+Implements a basic Interrupt Descriptor Table based on the [blog post](https://os.phil-opp.com/hardware-interrupts/)