# sussyback99/bitos architecture

> Architecture diagram of the GitHub repository sussyback99/bitos, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sussyback99/bitos
- Repository: https://github.com/sussyback99/bitos

## Overview

BitOS is a small freestanding 32-bit graphical OS. Its user workflow is keyboard input, command parsing, and text output on a VGA console; internally, the kernel waits for keyboard interrupts and dispatches scancodes to input handling. The README documents the boot and protected-mode transition, while the excerpt shows the kernel input, parser, and drawing calls. Some implementation details are unsampled, so documented relationships are cited to the README and unverified links are omitted.

Main entry points: [`kernel.cpp`](https://github.com/sussyback99/bitos/blob/main/kernel.cpp) (Kernel Main), [`boot.asm`](https://github.com/sussyback99/bitos/blob/main/boot.asm) (Boot Loader)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_boot["Boot"]
  node_loader["Boot Loader<br/>[boot.asm]"]
end

subgraph group_kernel["Kernel Input"]
  node_kernel_entry["Kernel Main<br/>[kernel.cpp]"]
  node_idt["IDT / IRQ1<br/>[kernel.cpp]"]
  node_key_handler["Key Handler<br/>[kernel.cpp]"]
end

subgraph group_console["Console"]
  node_command_parser["Command Parser<br/>[kernel.cpp]"]
  node_console_output["Console Output<br/>[kernel.cpp]"]
  node_interface["Console Interface<br/>[kernel.cpp]"]
  node_text_renderer["Text Renderer<br/>[kernel.cpp]"]
  node_font["Glyph Drawing<br/>[kernel.cpp]"]
  node_pixel_renderer["Pixel Primitives<br/>[kernel.cpp]"]
end

node_user(("User"))
node_keyboard["Keyboard"]
node_vga["VGA Memory"]

node_loader -->|"loads kernel"| node_kernel_entry
node_keyboard -->|"raises IRQ1"| node_idt
node_idt -->|"dispatches"| node_key_handler
node_kernel_entry -->|"waits for IRQ"| node_idt
node_kernel_entry -->|"processes scancode"| node_key_handler
node_user -->|"enters keys"| node_keyboard
node_key_handler -->|"executes command"| node_command_parser
node_key_handler -->|"prints input"| node_console_output
node_command_parser -->|"prints text"| node_console_output
node_kernel_entry -->|"draws interface"| node_interface
node_console_output -->|"renders text"| node_text_renderer
node_interface -->|"draws labels"| node_text_renderer
node_text_renderer -->|"draws glyphs"| node_font
node_font -->|"uses primitives"| node_pixel_renderer
node_pixel_renderer -->|"writes pixels"| node_vga

click node_loader "https://github.com/sussyback99/bitos/blob/main/boot.asm"
click node_kernel_entry "https://github.com/sussyback99/bitos/blob/main/kernel.cpp"
click node_idt "https://github.com/sussyback99/bitos/blob/main/kernel.cpp"
click node_key_handler "https://github.com/sussyback99/bitos/blob/main/kernel.cpp"
click node_command_parser "https://github.com/sussyback99/bitos/blob/main/kernel.cpp"
click node_console_output "https://github.com/sussyback99/bitos/blob/main/kernel.cpp"
click node_interface "https://github.com/sussyback99/bitos/blob/main/kernel.cpp"
click node_text_renderer "https://github.com/sussyback99/bitos/blob/main/kernel.cpp"
click node_font "https://github.com/sussyback99/bitos/blob/main/kernel.cpp"
click node_pixel_renderer "https://github.com/sussyback99/bitos/blob/main/kernel.cpp"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_loader,node_user toneBlue
class node_kernel_entry,node_idt,node_key_handler toneAmber
class node_command_parser,node_console_output,node_interface,node_text_renderer,node_font,node_pixel_renderer toneMint
class node_keyboard,node_vga toneIndigo
```

## Components

### Boot

- [Boot Loader](https://github.com/sussyback99/bitos/blob/main/boot.asm): `boot.asm`

### Kernel Input

- [Kernel Main](https://github.com/sussyback99/bitos/blob/main/kernel.cpp): `kernel.cpp`
- [IDT / IRQ1](https://github.com/sussyback99/bitos/blob/main/kernel.cpp): `kernel.cpp`
- [Key Handler](https://github.com/sussyback99/bitos/blob/main/kernel.cpp): `kernel.cpp`

### Console

- [Command Parser](https://github.com/sussyback99/bitos/blob/main/kernel.cpp): `kernel.cpp`
- [Console Output](https://github.com/sussyback99/bitos/blob/main/kernel.cpp): `kernel.cpp`
- [Console Interface](https://github.com/sussyback99/bitos/blob/main/kernel.cpp): `kernel.cpp`
- [Text Renderer](https://github.com/sussyback99/bitos/blob/main/kernel.cpp): `kernel.cpp`
- [Glyph Drawing](https://github.com/sussyback99/bitos/blob/main/kernel.cpp): `kernel.cpp`
- [Pixel Primitives](https://github.com/sussyback99/bitos/blob/main/kernel.cpp): `kernel.cpp`

### Other components

- **User**
- **Keyboard**
- **VGA Memory**

## Connections

- Boot Loader → Kernel Main: loads kernel (evidence: `README.md`)
- Keyboard → IDT / IRQ1: raises IRQ1 (evidence: `README.md`)
- IDT / IRQ1 → Key Handler: dispatches (evidence: `README.md`)
- Kernel Main → IDT / IRQ1: waits for IRQ (evidence: `README.md`)
- Kernel Main → Key Handler: processes scancode (evidence: `kernel.cpp`)
- User → Keyboard: enters keys (evidence: `README.md`)
- Key Handler → Command Parser: executes command (evidence: `kernel.cpp`)
- Key Handler → Console Output: prints input (evidence: `kernel.cpp`)
- Command Parser → Console Output: prints text (evidence: `kernel.cpp`)
- Kernel Main → Console Interface: draws interface (evidence: `README.md`)
- Console Output → Text Renderer: renders text (evidence: `kernel.cpp`)
- Console Interface → Text Renderer: draws labels (evidence: `kernel.cpp`)
- Text Renderer → Glyph Drawing: draws glyphs (evidence: `kernel.cpp`)
- Glyph Drawing → Pixel Primitives: uses primitives (evidence: `kernel.cpp`)
- Pixel Primitives → VGA Memory: writes pixels (evidence: `README.md`)
