diff options
Diffstat (limited to 'docs/arch')
42 files changed, 250 insertions, 0 deletions
diff --git a/docs/arch/x86_64/boot.rst b/docs/arch/x86_64/boot.rst new file mode 100644 index 00000000..8be2a57c --- /dev/null +++ b/docs/arch/x86_64/boot.rst @@ -0,0 +1,9 @@ +Boot Information Subsystem +====================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + boot/*
\ No newline at end of file diff --git a/docs/arch/x86_64/boot/pointers.rst b/docs/arch/x86_64/boot/pointers.rst new file mode 100644 index 00000000..3ec626ab --- /dev/null +++ b/docs/arch/x86_64/boot/pointers.rst @@ -0,0 +1,5 @@ +Boot Information Structure +======================= + +.. doxygenfile:: arch/x86_64/include/arch/boot/pointers.hpp + diff --git a/docs/arch/x86_64/exception_handling.rst b/docs/arch/x86_64/exception_handling.rst new file mode 100644 index 00000000..3bf27709 --- /dev/null +++ b/docs/arch/x86_64/exception_handling.rst @@ -0,0 +1,9 @@ +Exception Handling Subsystem +====================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + exception_handling/*
\ No newline at end of file diff --git a/docs/arch/x86_64/exception_handling/assert.rst b/docs/arch/x86_64/exception_handling/assert.rst new file mode 100644 index 00000000..053cf666 --- /dev/null +++ b/docs/arch/x86_64/exception_handling/assert.rst @@ -0,0 +1,5 @@ +Exception Handling Assertion +======================= + +.. doxygenfile:: arch/x86_64/include/arch/exception_handling/assert.hpp + diff --git a/docs/arch/x86_64/exception_handling/panic.rst b/docs/arch/x86_64/exception_handling/panic.rst new file mode 100644 index 00000000..50b62848 --- /dev/null +++ b/docs/arch/x86_64/exception_handling/panic.rst @@ -0,0 +1,5 @@ +Exception Handling Panic +======================= + +.. doxygenfile:: arch/x86_64/include/arch/exception_handling/panic.hpp + diff --git a/docs/arch/x86_64/kernel.rst b/docs/arch/x86_64/kernel.rst new file mode 100644 index 00000000..650e3a6c --- /dev/null +++ b/docs/arch/x86_64/kernel.rst @@ -0,0 +1,9 @@ +Kernel Main Subsystem +====================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + kernel/*
\ No newline at end of file diff --git a/docs/arch/x86_64/kernel/halt.rst b/docs/arch/x86_64/kernel/halt.rst new file mode 100644 index 00000000..c425e817 --- /dev/null +++ b/docs/arch/x86_64/kernel/halt.rst @@ -0,0 +1,5 @@ +Kernel Halt +======================= + +.. doxygenfile:: arch/x86_64/include/arch/kernel/halt.hpp + diff --git a/docs/arch/x86_64/kernel/main.rst b/docs/arch/x86_64/kernel/main.rst new file mode 100644 index 00000000..194bd85f --- /dev/null +++ b/docs/arch/x86_64/kernel/main.rst @@ -0,0 +1,5 @@ +Kernel Main +======================= + +.. doxygenfile:: arch/x86_64/include/arch/kernel/main.hpp + diff --git a/docs/arch/x86_64/memory.rst b/docs/arch/x86_64/memory.rst new file mode 100644 index 00000000..58d12e9e --- /dev/null +++ b/docs/arch/x86_64/memory.rst @@ -0,0 +1,9 @@ +Kernel Memory Subsystem +====================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + memory/*
\ No newline at end of file diff --git a/docs/arch/x86_64/memory/allocator.rst b/docs/arch/x86_64/memory/allocator.rst new file mode 100644 index 00000000..6ce0a740 --- /dev/null +++ b/docs/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/arch/x86_64/memory/allocator/area_frame_allocator.rst b/docs/arch/x86_64/memory/allocator/area_frame_allocator.rst new file mode 100644 index 00000000..422f33c7 --- /dev/null +++ b/docs/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/arch/x86_64/memory/allocator/concept.rst b/docs/arch/x86_64/memory/allocator/concept.rst new file mode 100644 index 00000000..734a2cee --- /dev/null +++ b/docs/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/arch/x86_64/memory/allocator/physical_frame.rst b/docs/arch/x86_64/memory/allocator/physical_frame.rst new file mode 100644 index 00000000..c5d0fd2a --- /dev/null +++ b/docs/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/arch/x86_64/memory/allocator/tiny_frame_allocator.rst b/docs/arch/x86_64/memory/allocator/tiny_frame_allocator.rst new file mode 100644 index 00000000..27401b22 --- /dev/null +++ b/docs/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/arch/x86_64/memory/cpu.rst b/docs/arch/x86_64/memory/cpu.rst new file mode 100644 index 00000000..4cb5af08 --- /dev/null +++ b/docs/arch/x86_64/memory/cpu.rst @@ -0,0 +1,9 @@ +CPU Registers Subsystem +=========== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + cpu/* diff --git a/docs/arch/x86_64/memory/cpu/control_register.rst b/docs/arch/x86_64/memory/cpu/control_register.rst new file mode 100644 index 00000000..f087112e --- /dev/null +++ b/docs/arch/x86_64/memory/cpu/control_register.rst @@ -0,0 +1,5 @@ +CPU Control Registers +======================= + +.. doxygenfile:: arch/x86_64/include/arch/memory/cpu/control_register.hpp + diff --git a/docs/arch/x86_64/memory/cpu/msr.rst b/docs/arch/x86_64/memory/cpu/msr.rst new file mode 100644 index 00000000..c67d51c9 --- /dev/null +++ b/docs/arch/x86_64/memory/cpu/msr.rst @@ -0,0 +1,5 @@ +CPU Model-Specific Register +======================= + +.. doxygenfile:: arch/x86_64/include/arch/memory/cpu/msr.hpp + diff --git a/docs/arch/x86_64/memory/cpu/tlb.rst b/docs/arch/x86_64/memory/cpu/tlb.rst new file mode 100644 index 00000000..0d482dcb --- /dev/null +++ b/docs/arch/x86_64/memory/cpu/tlb.rst @@ -0,0 +1,5 @@ +CPU Translation Lookaside Buffer +======================= + +.. doxygenfile:: arch/x86_64/include/arch/memory/cpu/tlb.hpp + diff --git a/docs/arch/x86_64/memory/heap.rst b/docs/arch/x86_64/memory/heap.rst new file mode 100644 index 00000000..409d93a8 --- /dev/null +++ b/docs/arch/x86_64/memory/heap.rst @@ -0,0 +1,9 @@ +Heap Memory Subsystem +=========== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + heap/* diff --git a/docs/arch/x86_64/memory/heap/bump_allocator.rst b/docs/arch/x86_64/memory/heap/bump_allocator.rst new file mode 100644 index 00000000..185f00bc --- /dev/null +++ b/docs/arch/x86_64/memory/heap/bump_allocator.rst @@ -0,0 +1,5 @@ +Heap Bump Allocator +======================= + +.. doxygenfile:: arch/x86_64/include/arch/memory/heap/bump_allocator.hpp + diff --git a/docs/arch/x86_64/memory/heap/concept.rst b/docs/arch/x86_64/memory/heap/concept.rst new file mode 100644 index 00000000..c0c31236 --- /dev/null +++ b/docs/arch/x86_64/memory/heap/concept.rst @@ -0,0 +1,5 @@ +Heap Allocator Concept +======================= + +.. doxygenfile:: arch/x86_64/include/arch/memory/heap/concept.hpp + diff --git a/docs/arch/x86_64/memory/heap/linked_list_allocator.rst b/docs/arch/x86_64/memory/heap/linked_list_allocator.rst new file mode 100644 index 00000000..26b25ab4 --- /dev/null +++ b/docs/arch/x86_64/memory/heap/linked_list_allocator.rst @@ -0,0 +1,5 @@ +Heap Linked List Allocator +======================= + +.. doxygenfile:: arch/x86_64/include/arch/memory/heap/linked_list_allocator.hpp + diff --git a/docs/arch/x86_64/memory/heap/memory_block.rst b/docs/arch/x86_64/memory/heap/memory_block.rst new file mode 100644 index 00000000..8ed65660 --- /dev/null +++ b/docs/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/arch/x86_64/memory/main.rst b/docs/arch/x86_64/memory/main.rst new file mode 100644 index 00000000..d9a9f39d --- /dev/null +++ b/docs/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/arch/x86_64/memory/multiboot.rst b/docs/arch/x86_64/memory/multiboot.rst new file mode 100644 index 00000000..22ec3f2a --- /dev/null +++ b/docs/arch/x86_64/memory/multiboot.rst @@ -0,0 +1,9 @@ +Kernel Multiboot Subsystem +=========== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + multiboot/* diff --git a/docs/arch/x86_64/memory/multiboot/elf_symbols_section.rst b/docs/arch/x86_64/memory/multiboot/elf_symbols_section.rst new file mode 100644 index 00000000..bbd6dfb8 --- /dev/null +++ b/docs/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/arch/x86_64/memory/multiboot/info.rst b/docs/arch/x86_64/memory/multiboot/info.rst new file mode 100644 index 00000000..847870dc --- /dev/null +++ b/docs/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/arch/x86_64/memory/multiboot/memory_map.rst b/docs/arch/x86_64/memory/multiboot/memory_map.rst new file mode 100644 index 00000000..9c77331f --- /dev/null +++ b/docs/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/arch/x86_64/memory/multiboot/reader.rst b/docs/arch/x86_64/memory/multiboot/reader.rst new file mode 100644 index 00000000..fac98e26 --- /dev/null +++ b/docs/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/arch/x86_64/memory/paging.rst b/docs/arch/x86_64/memory/paging.rst new file mode 100644 index 00000000..10cd9769 --- /dev/null +++ b/docs/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/arch/x86_64/memory/paging/active_page_table.rst b/docs/arch/x86_64/memory/paging/active_page_table.rst new file mode 100644 index 00000000..5710131c --- /dev/null +++ b/docs/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/arch/x86_64/memory/paging/inactive_page_table.rst b/docs/arch/x86_64/memory/paging/inactive_page_table.rst new file mode 100644 index 00000000..5732e64c --- /dev/null +++ b/docs/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/arch/x86_64/memory/paging/kernel_mapper.rst b/docs/arch/x86_64/memory/paging/kernel_mapper.rst new file mode 100644 index 00000000..9948e4e8 --- /dev/null +++ b/docs/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/arch/x86_64/memory/paging/page_entry.rst b/docs/arch/x86_64/memory/paging/page_entry.rst new file mode 100644 index 00000000..8900b0ee --- /dev/null +++ b/docs/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/arch/x86_64/memory/paging/page_table.rst b/docs/arch/x86_64/memory/paging/page_table.rst new file mode 100644 index 00000000..c5ab8c78 --- /dev/null +++ b/docs/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/arch/x86_64/memory/paging/temporary_page.rst b/docs/arch/x86_64/memory/paging/temporary_page.rst new file mode 100644 index 00000000..0c638995 --- /dev/null +++ b/docs/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/arch/x86_64/memory/paging/virtual_page.rst b/docs/arch/x86_64/memory/paging/virtual_page.rst new file mode 100644 index 00000000..dd42f473 --- /dev/null +++ b/docs/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 + diff --git a/docs/arch/x86_64/shared.rst b/docs/arch/x86_64/shared.rst new file mode 100644 index 00000000..c9b754f6 --- /dev/null +++ b/docs/arch/x86_64/shared.rst @@ -0,0 +1,9 @@ +Shared Code Subsystem +====================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + shared/*
\ No newline at end of file diff --git a/docs/arch/x86_64/shared/container.rst b/docs/arch/x86_64/shared/container.rst new file mode 100644 index 00000000..c4b6aef5 --- /dev/null +++ b/docs/arch/x86_64/shared/container.rst @@ -0,0 +1,5 @@ +Shared Container Structure +======================= + +.. doxygenfile:: arch/x86_64/include/arch/shared/container.hpp + diff --git a/docs/arch/x86_64/shared/contiguous_pointer_iterator.rst b/docs/arch/x86_64/shared/contiguous_pointer_iterator.rst new file mode 100644 index 00000000..a5f921dd --- /dev/null +++ b/docs/arch/x86_64/shared/contiguous_pointer_iterator.rst @@ -0,0 +1,5 @@ +Shared Contiguous Pointer Iterator +======================= + +.. doxygenfile:: arch/x86_64/include/arch/shared/contiguous_pointer_iterator.hpp + diff --git a/docs/arch/x86_64/shared/forward_value_iterator.rst b/docs/arch/x86_64/shared/forward_value_iterator.rst new file mode 100644 index 00000000..cdff5afe --- /dev/null +++ b/docs/arch/x86_64/shared/forward_value_iterator.rst @@ -0,0 +1,5 @@ +Shared Forward Value Iterator +======================= + +.. doxygenfile:: arch/x86_64/include/arch/shared/forward_value_iterator.hpp + diff --git a/docs/arch/x86_64/shared/mutex.rst b/docs/arch/x86_64/shared/mutex.rst new file mode 100644 index 00000000..bc236368 --- /dev/null +++ b/docs/arch/x86_64/shared/mutex.rst @@ -0,0 +1,5 @@ +Shared Mutex +======================= + +.. doxygenfile:: arch/x86_64/include/arch/shared/mutex.hpp + |