diff options
| -rw-r--r-- | arch/x86_64/include/arch/boot/boot.hpp | 42 | ||||
| -rw-r--r-- | arch/x86_64/x86_64.dox | 22 |
2 files changed, 28 insertions, 36 deletions
diff --git a/arch/x86_64/include/arch/boot/boot.hpp b/arch/x86_64/include/arch/boot/boot.hpp index 71e8a70..3a598f5 100644 --- a/arch/x86_64/include/arch/boot/boot.hpp +++ b/arch/x86_64/include/arch/boot/boot.hpp @@ -1,48 +1,34 @@ -#ifndef TEACHOS_X86_64_BOOT_BOOT_H -#define TEACHOS_X86_64_BOOT_BOOT_H +#ifndef TEACHOS_X86_64_BOOT_BOOT_HPP +#define TEACHOS_X86_64_BOOT_BOOT_HPP #ifdef __ASSEMBLER__ -/* clang-format off */ -/** - * @brief The number of huge pages to map during bootstrap. - */ +// clang-format off + +//! The number of huge pages to map during bootstrap. #define HUGE_PAGES_TO_MAP (16) -/** - * @brief The magic value to be set in eax by the multiboot 2 loader. - */ +//! The magic value to be set in eax by the multiboot 2 loader. #define MULTIBOOT2_MAGIC (0x36d76289) -/** - * @brief The "A" bit in a GDT entry. - */ +//! The "A" bit in a GDT entry. #define GDT_ACCESSED (1 << 40) -/** - * @brief The "R/W" bit in a GDT entry - */ +//! The "R/W" bit in a GDT entry #define GDT_READ_WRITE (1 << 41) -/** - * @brief The "E" bit in a GDT entry. - */ +//! The "E" bit in a GDT entry. #define GDT_EXECUTABLE (1 << 43) -/** - * @brief The "S" bit in a GDT entry. - */ +//! The "S" bit in a GDT entry. #define GDT_DESCRIPTOR_TYPE (1 << 44) -/** - * @brief The "P" bit in a GDT entry. - */ +//! The "P" bit in a GDT entry. #define GDT_PRESENT (1 << 47) -/** - * @brief The "L" bit in a GDT entry. - */ +//! The "L" bit in a GDT entry. #define GDT_LONG_MODE (1 << 53) -/* clang-format on */ + +// clang-format on #else #include "kapi/boot.hpp" // IWYU pragma: export diff --git a/arch/x86_64/x86_64.dox b/arch/x86_64/x86_64.dox index a23d30a..e529863 100644 --- a/arch/x86_64/x86_64.dox +++ b/arch/x86_64/x86_64.dox @@ -1,14 +1,20 @@ //! @namespace arch::boot -//! The %x86_64 implementation of teachos::boot -//! -//! This namespace contains %x86_64 specific implementations of and extensions to the teachos::boot namespace. +//! Boot information and bootstrap configuration. //! @namespace arch::cpu -//! The %x86_64 implementation of teachos::cpu +//! x86-64 CPU interfaces. //! -//! This namespace contains %x86_64 specific implementations of and extensions to the teachos::cpu namespace. +//! This namespace contains, among others, the implementations of interfaces and types to interact with CPU intrinsic +//! features. + +//! @namespace arch::debug +//! x86-64 debugging infrastructure. + +//! @namespace arch::io +//! x86-64 I/O interfaces. //! @namespace arch::memory -//! The %x86_64 implementation of teachos::memory -//! -//! This namespace contains %x86_64 specific implementations of and extensions to the teachos::memory namespace.
\ No newline at end of file +//! x86-64 memory management infrastructure. + +//! @namespace arch::vga +//! VGA support.
\ No newline at end of file |