This directory contains design notes, subsystem references, and status documents for the current Scarlet integration tree. The root README describes the repository at a high level; this page is the documentation map.
- Build system -
cargo-scarlet, project manifests, image layers, and generated artifacts. - Distribution model - repository role, projects, bundles, layers, and lock files.
- Limine boot - QEMU UEFI/Limine boot images for RISC-V and AArch64.
- Multi-architecture support - RISC-V and AArch64 build, test, linker, and target layout.
- Memory map - higher-half kernel and ioremap address layout.
- Scheduler placement and fairness - capacity-aware scheduling policy, hints, fairness, and preemption integration points.
- Scheduler benchmark scenarios - repeatable workloads for homogeneous and heterogeneous scheduler checks.
- Apple Silicon deployment - experimental m1n1/U-Boot/Limine deployment flow.
- Linux ABI demo - building and running the partial Linux userspace demo.
- Linux ABI status - syscall and feature compatibility matrix.
- Linux userspace artifacts - Buildroot and optional userspace artifact generation.
- Linux rootfs deployment - placing Linux artifacts into Scarlet images.
- Linux thread support - clone, futex, and per-thread state notes.
- Runtime delegation - delegating unsupported binary formats to userland runtimes.
- PCI/PCIe - ECAM discovery and PCI device model.
- Input event devices - Scarlet input event interface.
- VirtIO input and VirtIO RNG
- VirtIO device notes.
- Display presentation - CPU-composited display presentation paths.
- Video decode device -
/dev/videoNABI used byvideo_player. - USB subsystem - xHCI/USB host stack status and milestones.
- Audio system - kernel PCM transport, SAS, and playback model.
- Loadable Scarlet modules -
.lsmmodule loading and relocations.
- SWS IPC protocol - Scarlet Window Server wire protocol.
- sws-client - low-level SWS client library.
- ScarletUI design and ScarletUI API - UI framework architecture and reference.
- Wayland bridge - Wayland-to-SWS bridge design.
- stemd - service manager and desktop application registry.
- Scarlet SKK and Scarlet Mozc - input method service experiments.
- TTY and PTY - terminal and pseudoterminal support.
- Network architecture - network layers, sockets, and VirtIO-net.
- Socket/VFS integration - local socket path model.
- Namespace isolation and task namespaces - container isolation model.
- SCPM, package format, and package API - Scarlet package manager notes.
The documentation tracks implementation direction as well as completed behavior. When code and docs disagree, treat the code and project manifests as the source of truth, then update the relevant document in the same change.