aboutsummaryrefslogtreecommitdiff
path: root/docs/pre/arch/x86_64/memory
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@ost.ch>2025-07-24 16:39:43 +0000
committerFelix Morgner <felix.morgner@ost.ch>2025-07-24 16:42:39 +0000
commitfeac668578a35aac280b59d478a57b6937bb68da (patch)
treece9bc9854c75a5a663428fcd34b3a18035e1e53f /docs/pre/arch/x86_64/memory
parent2d3399ab6072acd85811a54fce8eff50628888b6 (diff)
downloadteachos-feac668578a35aac280b59d478a57b6937bb68da.tar.xz
teachos-feac668578a35aac280b59d478a57b6937bb68da.zip
docs: move files out of the way
Diffstat (limited to 'docs/pre/arch/x86_64/memory')
-rw-r--r--docs/pre/arch/x86_64/memory/allocator.rst9
-rw-r--r--docs/pre/arch/x86_64/memory/allocator/area_frame_allocator.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/allocator/concept.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/allocator/physical_frame.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/allocator/tiny_frame_allocator.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/cpu.rst9
-rw-r--r--docs/pre/arch/x86_64/memory/heap.rst9
-rw-r--r--docs/pre/arch/x86_64/memory/heap/bump_allocator.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/heap/global_heap_allocator.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/heap/heap_allocator.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/heap/linked_list_allocator.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/heap/memory_block.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/heap/user_heap_allocator.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/main.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/multiboot.rst9
-rw-r--r--docs/pre/arch/x86_64/memory/multiboot/elf_symbols_section.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/multiboot/info.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/multiboot/memory_map.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/multiboot/reader.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/paging.rst9
-rw-r--r--docs/pre/arch/x86_64/memory/paging/active_page_table.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/paging/inactive_page_table.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/paging/kernel_mapper.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/paging/page_entry.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/paging/page_table.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/paging/temporary_page.rst5
-rw-r--r--docs/pre/arch/x86_64/memory/paging/virtual_page.rst5
27 files changed, 155 insertions, 0 deletions
diff --git a/docs/pre/arch/x86_64/memory/allocator.rst b/docs/pre/arch/x86_64/memory/allocator.rst
new file mode 100644
index 0000000..6ce0a74
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/allocator.rst
@@ -0,0 +1,9 @@
+Physical Frame Allocator Subsystem
+===========
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+ :glob:
+
+ allocator/*
diff --git a/docs/pre/arch/x86_64/memory/allocator/area_frame_allocator.rst b/docs/pre/arch/x86_64/memory/allocator/area_frame_allocator.rst
new file mode 100644
index 0000000..422f33c
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/allocator/area_frame_allocator.rst
@@ -0,0 +1,5 @@
+Area Physical Frame Allocator
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/allocator/area_frame_allocator.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/allocator/concept.rst b/docs/pre/arch/x86_64/memory/allocator/concept.rst
new file mode 100644
index 0000000..734a2ce
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/allocator/concept.rst
@@ -0,0 +1,5 @@
+Physical Frame Allocator Concept
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/allocator/concept.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/allocator/physical_frame.rst b/docs/pre/arch/x86_64/memory/allocator/physical_frame.rst
new file mode 100644
index 0000000..c5d0fd2
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/allocator/physical_frame.rst
@@ -0,0 +1,5 @@
+Physical Frame
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/allocator/physical_frame.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/allocator/tiny_frame_allocator.rst b/docs/pre/arch/x86_64/memory/allocator/tiny_frame_allocator.rst
new file mode 100644
index 0000000..27401b2
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/allocator/tiny_frame_allocator.rst
@@ -0,0 +1,5 @@
+Tiny Physical Frame Allocator
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/allocator/tiny_frame_allocator.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/cpu.rst b/docs/pre/arch/x86_64/memory/cpu.rst
new file mode 100644
index 0000000..4cb5af0
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/cpu.rst
@@ -0,0 +1,9 @@
+CPU Registers Subsystem
+===========
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+ :glob:
+
+ cpu/*
diff --git a/docs/pre/arch/x86_64/memory/heap.rst b/docs/pre/arch/x86_64/memory/heap.rst
new file mode 100644
index 0000000..409d93a
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/heap.rst
@@ -0,0 +1,9 @@
+Heap Memory Subsystem
+===========
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+ :glob:
+
+ heap/*
diff --git a/docs/pre/arch/x86_64/memory/heap/bump_allocator.rst b/docs/pre/arch/x86_64/memory/heap/bump_allocator.rst
new file mode 100644
index 0000000..b20916e
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/heap/bump_allocator.rst
@@ -0,0 +1,5 @@
+Kernel Heap Bump Allocator
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/heap/bump_allocator.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/heap/global_heap_allocator.rst b/docs/pre/arch/x86_64/memory/heap/global_heap_allocator.rst
new file mode 100644
index 0000000..60ec0b5
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/heap/global_heap_allocator.rst
@@ -0,0 +1,5 @@
+Global Heap Allocator
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/heap/global_heap_allocator.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/heap/heap_allocator.rst b/docs/pre/arch/x86_64/memory/heap/heap_allocator.rst
new file mode 100644
index 0000000..b410e41
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/heap/heap_allocator.rst
@@ -0,0 +1,5 @@
+Kernel Heap Allocator
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/heap/heap_allocator.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/heap/linked_list_allocator.rst b/docs/pre/arch/x86_64/memory/heap/linked_list_allocator.rst
new file mode 100644
index 0000000..d156852
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/heap/linked_list_allocator.rst
@@ -0,0 +1,5 @@
+Kernel Heap Linked List Allocator
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/heap/linked_list_allocator.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/heap/memory_block.rst b/docs/pre/arch/x86_64/memory/heap/memory_block.rst
new file mode 100644
index 0000000..8ed6566
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/heap/memory_block.rst
@@ -0,0 +1,5 @@
+Heap Linked List Free Memory Block
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/heap/memory_block.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/heap/user_heap_allocator.rst b/docs/pre/arch/x86_64/memory/heap/user_heap_allocator.rst
new file mode 100644
index 0000000..d0febb6
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/heap/user_heap_allocator.rst
@@ -0,0 +1,5 @@
+User Heap Linked List Allocator
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/heap/user_heap_allocator.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/main.rst b/docs/pre/arch/x86_64/memory/main.rst
new file mode 100644
index 0000000..d9a9f39
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/main.rst
@@ -0,0 +1,5 @@
+Memory Main
+===========
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/main.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/multiboot.rst b/docs/pre/arch/x86_64/memory/multiboot.rst
new file mode 100644
index 0000000..22ec3f2
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/multiboot.rst
@@ -0,0 +1,9 @@
+Kernel Multiboot Subsystem
+===========
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+ :glob:
+
+ multiboot/*
diff --git a/docs/pre/arch/x86_64/memory/multiboot/elf_symbols_section.rst b/docs/pre/arch/x86_64/memory/multiboot/elf_symbols_section.rst
new file mode 100644
index 0000000..bbd6dfb
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/multiboot/elf_symbols_section.rst
@@ -0,0 +1,5 @@
+Multiboot ELF Header Symbols Section Structure
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/multiboot/elf_symbols_section.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/multiboot/info.rst b/docs/pre/arch/x86_64/memory/multiboot/info.rst
new file mode 100644
index 0000000..847870d
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/multiboot/info.rst
@@ -0,0 +1,5 @@
+Multiboot Header Information Structure
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/multiboot/info.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/multiboot/memory_map.rst b/docs/pre/arch/x86_64/memory/multiboot/memory_map.rst
new file mode 100644
index 0000000..9c77331
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/multiboot/memory_map.rst
@@ -0,0 +1,5 @@
+Multiboot Memory Map Header Structure
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/multiboot/memory_map.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/multiboot/reader.rst b/docs/pre/arch/x86_64/memory/multiboot/reader.rst
new file mode 100644
index 0000000..fac98e2
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/multiboot/reader.rst
@@ -0,0 +1,5 @@
+Multiboot Reader
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/multiboot/reader.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/paging.rst b/docs/pre/arch/x86_64/memory/paging.rst
new file mode 100644
index 0000000..10cd976
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/paging.rst
@@ -0,0 +1,9 @@
+Virtual Page Table Paging Subsystem
+===========
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+ :glob:
+
+ paging/*
diff --git a/docs/pre/arch/x86_64/memory/paging/active_page_table.rst b/docs/pre/arch/x86_64/memory/paging/active_page_table.rst
new file mode 100644
index 0000000..5710131
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/paging/active_page_table.rst
@@ -0,0 +1,5 @@
+Active Page Table
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/paging/active_page_table.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/paging/inactive_page_table.rst b/docs/pre/arch/x86_64/memory/paging/inactive_page_table.rst
new file mode 100644
index 0000000..5732e64
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/paging/inactive_page_table.rst
@@ -0,0 +1,5 @@
+Inactive Page Table
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/paging/inactive_page_table.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/paging/kernel_mapper.rst b/docs/pre/arch/x86_64/memory/paging/kernel_mapper.rst
new file mode 100644
index 0000000..9948e4e
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/paging/kernel_mapper.rst
@@ -0,0 +1,5 @@
+Kernel Mapper
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/paging/kernel_mapper.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/paging/page_entry.rst b/docs/pre/arch/x86_64/memory/paging/page_entry.rst
new file mode 100644
index 0000000..8900b0e
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/paging/page_entry.rst
@@ -0,0 +1,5 @@
+Virtual Page Table Entry
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/paging/page_entry.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/paging/page_table.rst b/docs/pre/arch/x86_64/memory/paging/page_table.rst
new file mode 100644
index 0000000..c5ab8c7
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/paging/page_table.rst
@@ -0,0 +1,5 @@
+Virtual Page Table
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/paging/page_table.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/paging/temporary_page.rst b/docs/pre/arch/x86_64/memory/paging/temporary_page.rst
new file mode 100644
index 0000000..0c63899
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/paging/temporary_page.rst
@@ -0,0 +1,5 @@
+Temporary Virtual Page Table
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/paging/temporary_page.hpp
+
diff --git a/docs/pre/arch/x86_64/memory/paging/virtual_page.rst b/docs/pre/arch/x86_64/memory/paging/virtual_page.rst
new file mode 100644
index 0000000..dd42f47
--- /dev/null
+++ b/docs/pre/arch/x86_64/memory/paging/virtual_page.rst
@@ -0,0 +1,5 @@
+Virtual Page
+=======================
+
+.. doxygenfile:: arch/x86_64/include/arch/memory/paging/virtual_page.hpp
+