implemented boot_modules and boot_module_registry, init boot_modules in kernel main

3 files changed, 154 insertions, 0 deletions

diff --git a/kapi/include/kapi/boot_module/boot_module.hpp b/kapi/include/kapi/boot_module/boot_module.hpp
new file mode 100644
index 0000000..f2d97ae
--- /dev/null
+++ b/kapi/include/kapi/boot_module/boot_module.hpp
@@ -0,0 +1,21 @@
+#ifndef TEACHOS_KAPI_BOOT_MODULE_BOOT_MODULE_HPP
+#define TEACHOS_KAPI_BOOT_MODULE_BOOT_MODULE_HPP
+
+#include <cstddef>
+#include <string_view>
+
+namespace kapi::boot_modules
+{
+  // ! The boot module struct
+  // !
+  // ! The boot module struct represents a module loaded by the bootloader, and contains information about it, such as
+  // ! its name, virtual start address, and size.
+  struct boot_module
+  {
+    std::string_view name;
+    size_t start_address;
+    size_t size;
+  };
+}  // namespace kapi::boot_modules
+
+#endif
\ No newline at end of file
diff --git a/kapi/include/kapi/boot_module/boot_module_registry.hpp b/kapi/include/kapi/boot_module/boot_module_registry.hpp
new file mode 100644
index 0000000..3732a5f
--- /dev/null
+++ b/kapi/include/kapi/boot_module/boot_module_registry.hpp
@@ -0,0 +1,108 @@
+#ifndef TEACHOS_KAPI_BOOT_MODULE_BOOT_MODULE_REGISTRY_HPP
+#define TEACHOS_KAPI_BOOT_MODULE_BOOT_MODULE_REGISTRY_HPP
+
+#include "kapi/boot_module/boot_module.hpp"
+
+#include <array>
+#include <cstddef>
+
+namespace kapi::boot_modules
+{
+
+  // ! The interface of the boot module registry
+  // !
+  // ! The boot module registry is responsible for keeping track of the modules loaded by the bootloader, and
+  // ! providing access to them for the rest of the kernel.
+  struct boot_module_registry
+  {
+    using range_type = std::array<boot_module, 32>;  // TODO BA-FS26 use kstd::vector when available
+
+    using value_type = range_type::value_type;
+    using const_reference = range_type::const_reference;
+
+    using const_iterator = range_type::const_iterator;
+    using const_reverse_iterator = range_type::const_reverse_iterator;
+    using size_type = range_type::size_type;
+    using difference_type = range_type::difference_type;
+
+    [[nodiscard]] auto begin() const noexcept -> const_iterator
+    {
+      return m_modules.begin();
+    }
+
+    [[nodiscard]] auto end() const noexcept -> const_iterator
+    {
+      return m_modules.end();
+    }
+
+    [[nodiscard]] auto cbegin() const noexcept -> const_iterator
+    {
+      return begin();
+    }
+
+    [[nodiscard]] auto cend() const noexcept -> const_iterator
+    {
+      return end();
+    }
+
+    [[nodiscard]] auto rbegin() const noexcept -> const_reverse_iterator
+    {
+      return m_modules.rbegin();
+    }
+
+    [[nodiscard]] auto rend() const noexcept -> const_reverse_iterator
+    {
+      return m_modules.rend();
+    }
+
+    [[nodiscard]] auto crbegin() const noexcept -> const_reverse_iterator
+    {
+      return rbegin();
+    }
+
+    [[nodiscard]] auto crend() const noexcept -> const_reverse_iterator
+    {
+      return rend();
+    }
+
+    [[nodiscard]] auto front() const noexcept -> const_reference
+    {
+      return m_modules.front();
+    }
+
+    [[nodiscard]] auto back() const noexcept -> const_reference
+    {
+      return m_modules.back();
+    }
+
+    [[nodiscard]] auto size() const noexcept -> std::size_t
+    {
+      return m_modules.size();
+    }
+
+    [[nodiscard]] auto empty() const noexcept -> bool
+    {
+      return m_modules.empty();
+    }
+
+    [[nodiscard]] auto at(std::size_t index) const -> const_reference
+    {
+      return m_modules.at(index);
+    }
+
+    [[nodiscard]] auto operator[](std::size_t index) const noexcept -> const_reference
+    {
+      return m_modules[index];
+    }
+
+    auto add_boot_module(boot_module module) -> void
+    {
+      m_modules.at(0) = module;  // TODO BA-FS26 push back when kstd::vector is available
+    }
+
+  private:
+    range_type m_modules{};
+  };
+}  // namespace kapi::boot_modules
+
+#endif
\ No newline at end of file
diff --git a/kapi/include/kapi/boot_modules.hpp b/kapi/include/kapi/boot_modules.hpp
new file mode 100644
index 0000000..752b070
--- /dev/null
+++ b/kapi/include/kapi/boot_modules.hpp
@@ -0,0 +1,25 @@
+#ifndef TEACHOS_KAPI_BOOT_MODULES_HPP
+#define TEACHOS_KAPI_BOOT_MODULES_HPP
+
+#include "kapi/boot_module/boot_module_registry.hpp"  // IWYU pragma: export
+
+namespace kapi::boot_modules
+{
+
+  //! @qualifier platform-defined
+  //! Initialize the boot module registry.
+  //!
+  //! @note This function must be implemented by the target platform.
+  //!
+  //! This function initializes the boot module registry, which is responsible for keeping track of the modules loaded
+  //! by the bootloader, and providing access to them for the rest of the kernel.
+  auto init() -> void;
+
+  //! @qualifier kernel-defined
+  //! Set the boot module registry
+  //!
+  //! @param registry A new boot module registry.
+  auto set_boot_module_registry(boot_module_registry & registry) -> void;
+
+}  // namespace kapi::boot_modules
+#endif
\ No newline at end of file