diff options
Diffstat (limited to 'doc.src')
-rw-r--r-- | doc.src/arch.rst | 14 | ||||
-rw-r--r-- | doc.src/conf.py | 28 | ||||
-rw-r--r-- | doc.src/devices.rst | 35 | ||||
-rw-r--r-- | doc.src/index.rst | 23 | ||||
-rw-r--r-- | doc.src/libk.rst | 20 | ||||
-rw-r--r-- | doc.src/mem.rst | 32 | ||||
-rw-r--r-- | doc.src/mem/constinit.rst | 4 |
7 files changed, 0 insertions, 156 deletions
diff --git a/doc.src/arch.rst b/doc.src/arch.rst deleted file mode 100644 index 44bc9e7..0000000 --- a/doc.src/arch.rst +++ /dev/null @@ -1,14 +0,0 @@ -============= -Architectures -============= - -i686 -==== -Supported are CPUs with PSE (Page Size Extentions) - -Building for i686 ------------------ -Requirements: - -* i686-elf-gcc `gcc-PKGBUILD <https://neueland.iserlohn-fortress.net/cgit/glitch/i686-elf-gcc/>`_ -* i686-elf-binutils `binutils-PKGBUILD <https://neueland.iserlohn-fortress.net/cgit/glitch/i686-elf-binutils/>`_ diff --git a/doc.src/conf.py b/doc.src/conf.py deleted file mode 100644 index 02bd18c..0000000 --- a/doc.src/conf.py +++ /dev/null @@ -1,28 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# For the full list of built-in configuration values, see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Project information ----------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information - -project = 'glitch' -copyright = '2022, aqua@' -author = 'aqua@' -release = '0.0.0' - -# -- General configuration --------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration - -extensions = ['hawkmoth'] - -templates_path = ['_templates'] -exclude_patterns = [] - - - -# -- Options for HTML output ------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output - -html_theme = "sphinx_rtd_theme" -html_static_path = ['_static'] diff --git a/doc.src/devices.rst b/doc.src/devices.rst deleted file mode 100644 index 13bc2f0..0000000 --- a/doc.src/devices.rst +++ /dev/null @@ -1,35 +0,0 @@ -======= -Devices -======= - -VGA -=== - -Text mode ---------- -osdev wiki: `Text UI <https://wiki.osdev.org/Text_mode>`_ - -.. c:autodoc:: ../devices/vga.h - :clang: -isystem/usr/lib/gcc/i686-elf/12.2.0/include - -PS/2 Controller -=============== -.. c:autodoc:: ../devices/ps2_controller.h - -Keyboard --------- -.. c:autodoc:: ../devices/keyboard.h - -Mouse ------ -.. c:autodoc:: ../devices/mouse.h - -Programmable Interrupt Controller -================================= -.. c:autodoc:: ../devices/pic.h - -UART -==== -.. c:autodoc:: ../devices/uart_16550.h - :clang: -isystem/usr/lib/gcc/i686-elf/12.2.0/include - diff --git a/doc.src/index.rst b/doc.src/index.rst deleted file mode 100644 index b62b1ad..0000000 --- a/doc.src/index.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. glitch documentation master file, created by - sphinx-quickstart on Mon Nov 7 17:29:02 2022. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to the glitch documentation -=================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - arch - libk - devices - mem - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`search` diff --git a/doc.src/libk.rst b/doc.src/libk.rst deleted file mode 100644 index 078198c..0000000 --- a/doc.src/libk.rst +++ /dev/null @@ -1,20 +0,0 @@ -==== -libk -==== - -libk is the kernel's C standard library implementation. - -stdio.h -======= -.. c:autodoc:: ../lib/stdio.h - :clang: -isystem/usr/lib/gcc/i686-elf/12.2.0/include - -stdlib.h -======== -.. c:autodoc:: ../lib/stdlib.h - :clang: -isystem/usr/lib/gcc/i686-elf/12.2.0/include - -string.h -======== -.. c:autodoc:: ../lib/string.h - :clang: -isystem/usr/lib/gcc/i686-elf/12.2.0/include diff --git a/doc.src/mem.rst b/doc.src/mem.rst deleted file mode 100644 index 2dd86a9..0000000 --- a/doc.src/mem.rst +++ /dev/null @@ -1,32 +0,0 @@ -================= -Memory management -================= - -A frame is a fixed-sized block of physical memory. A page is a fixed-size block of virtual memory. Both are of the same size (4kB). - -Physical memory allocator -========================= -The FrameAllocator takes a bitmap describing available physical memory and allocates free frames. There is one global -instance. - -Virtual memory allocator -======================== -The PageAllocator takes allocated Frames and mounts them in virtual memory. - -.. table:: Virtual address space layout - :widths: auto - - ============== ==================== =========== - address symbol description - ============== ==================== =========== - ``ffff ffff`` virtual memory end - ``d000 0000`` MMIO - ``c040 0000`` kernel allocator - page-aligned ``__data_begin`` - page-aligned ``__bss_begin`` - page-aligned ``__rodata_begin`` - ``c000 0000`` ``__text_begin`` kernel text - ``0000 0000`` virtual memory start - ============== ==================== =========== - -.. include:: mem/constinit.rst diff --git a/doc.src/mem/constinit.rst b/doc.src/mem/constinit.rst deleted file mode 100644 index 7e069bf..0000000 --- a/doc.src/mem/constinit.rst +++ /dev/null @@ -1,4 +0,0 @@ -constinit section -================= - -``constinit`` is a part of ``.rodata`` |