Graphics & UI
Draw into a shadow, publish by damage.
The display path is intentionally simple: drawing lands in a RAM shadow buffer, damage rectangles describe what changed, and a budgeted flush copies those rectangles to VRAM. Windows add a compositor and a mapped-canvas ABI on top; a small immediate-mode toolkit supplies the widgets.
Framebuffer
The boot path writes a struct vga_boot_fb_info to
0x600: LFB base, pitch, width, height, bits per pixel
and an RGBX flag for GOP's byte order. The legacy VESA stage chooses
a mode with at least 16 bpp, a linear framebuffer, it must fit the
card's VRAM, and width at most 1280 pixels. The UEFI loader imposes
its own GOP constraints.
vga.c owns the visible surface. On a
normal boot the render target is a RAM shadow buffer at
0x100000, not the LFB; the 8 MB reserve leaves room for
future modes. A surface carries width, height, pitch, format and a
pixel-pointer, so the same drawing code can target a window layer or
a canvas.
Shadow buffer & damage
Drawing never writes VRAM directly. Each operation records a damage
rectangle; overlapping or touching rectangles merge, so a keystroke's
cells collapse into one small rect while unrelated damage stays
apart. The main loop calls vga_present_shadow() on every
iteration with a byte budget of VGA_FLUSH_BUDGET_BYTES
(1 MiB by default).
- Small rects copy whole. A window repaint within the budget never tears.
- Large rects are chunked. A full-screen redraw continues across loop iterations; newer damage is queued behind it.
- No fixed frame rate. The loop flushes whenever there is pending damage, so a cursor move reaches the screen within one loop.
- Re-entry guard.
vga_present_shadow()refuses to run while another process is mid-flush; a full-screen copy is long enough to be preempted. - Window drags flush immediately.
wm_drag_shadowcopies each drag step as one consistent frame.
When the target is not the screen — a window layer or an app canvas —
vga_target_damage() is a no-op. The render target
override is stored in the PCB, so a preempted draw cannot leak into
another process's window.
Blit backends
blit.c is the pixel-operation vtable: fill, copy, blend, canvas, present and flip. Software is the only backend today, but the WM calls the vtable rather than a fixed function, so an accelerator can replace individual operations without touching window logic.
The software fill uses an SSE2 row store when the CPU supports it.
Rows that do not fit the cache use streaming stores
(movntdq, one sfence per fill), which
avoids read-for-ownership traffic that makes large fills DRAM-bound
on the Atom. SSE/SSE2 are never assumed: the kernel is built with
-mno-sse, and cpu_has_sse2() probes CPUID,
sets CR4.OSFXSR/OSXMMEXCPT and is re-run on every AP.
gfxbench times fill, copy, cell, canvas and flush paths
and reports the bytes actually copied by the presenter.
Window manager
The WM is a process that owns the desktop and a fixed array of eight
windows. It draws a system bar with the banner, launcher buttons,
clock, the temperature, and, on ThinkPads and Chromebooks, an
AC/battery status icon at the far right (a plug on AC, a
level-filled battery on battery, with a percentage tooltip below
the bar on hover, painted above the windows), plus draggable
terminal and canvas windows with a title bar and close button.
Click-to-focus, drag-by-title-bar and close are routed through the
same pointer path. To the left of the rightmost AC/battery status
icon, a network status icon shows a
cable for wired Ethernet, signal bars for a connected WiFi link, a
USB mark for RNDIS tethering, or a red X when no link is up.
The whole right status area — temperature, date/time, network
and AC/battery items plus the gaps between them — is one button:
it opens the anchored bin/netmenu control panel (a
second click closes it).
It opens collapsed: the battery/clock summary and Quick settings
pills are visible, while the network, power-mode and date/time
settings stay hidden until their pill is clicked. Present NICs
can then be selected (DHCP runs), and scanned WiFi networks can be
joined, asking for the WPA2 passphrase first when the AP requires
one.
A popover is a chromeless canvas window created with
u_win_create_popover() (WIN_F_POPOVER).
The WM anchors it flush under the top bar at the right screen
edge, treats it as always topmost in painting and hit-testing,
and draws no chrome at all:
the canvas fills the whole window rectangle, with no title bar,
shadow, rim or rounded outer corners, so it reads as a flat menu
panel. The kernel uses the window origin for content-relative
pointer and scroll coordinates. An outside press dismisses the
popover and the click then continues normally; a second click on
any status target toggles it. The panel itself is drawn with the
ngui components: a battery/AC and clock summary, a brightness
slider when the panel PWM is present, and Quick settings tiles for
Network, the CPU power mode (SYS_CPUFREQ) and Date
& Time. Clicking a tile expands that section in place — the
network devices/Wi-Fi/connection lists, the three power modes, or
an inline date/time editor with Set, Now and Sync NTP (no separate
window). SYS_WIN_RESIZE_SELF grows or shrinks the
popover to the section, clamped to SYS_SCREEN_INFO's
framebuffer; the section scrolls when it is taller than the screen.
The WM is the ring-3 process loaded from
/ramfs/bin/wm; there is no kernel WM fallback. The
kernel window server in wm.c owns the
shadow mapping, the per-window canvases, input routing, the cursor,
kexec detection and the boot-console handoff. It starts the first
terminal after the storage mount
(wm_server_boot_ready) and leaves the boot console
visible until the WM attaches.
PRESENT.
- Terminal windows are canvas clients: ucmd_term.c renders its rows into the RGB565 window canvas; keys arrive through the generic
SYS_KEY_POLLorSYS_WIN_KEY_WAIT. The WM no longer has a text-cell path. - Canvas windows are generic: the app gets a back buffer, pointer position/buttons/focus and queued press/release edges with capture.
- Focus and z-order are explicit; closing a window kills its session and frees its canvas.
Compositing cost
The WM keeps a front-to-back order: the focused window first, then the remaining windows in descending slot order. For each damage rectangle it fills the desktop once and walks that order, subtracting every window in front from the region still uncovered. A window is drawn only in its exposed pieces, so a fully occluded window costs nothing and the stack is never repainted back-to-front. The kernel pointer hit-test uses the same order. A focused-window drag copies its shadow block to the new position and repaints only the old strips the new rectangle does not cover, instead of compositing the window at both positions. If either rectangle is partly off-screen the shadow has no valid pixels for the hidden part, so that step repaints the window rect instead of copying desktop background into it.
SYS_WIN_PRESENT carries a content-relative damage
rectangle. The terminal tracks its dirty rows, so a keystroke copies
and composites one 8×16 row block instead of the whole 512×512
canvas. The kernel unions the rectangles between WM polls and
SYS_WM_INFO returns that union; a present with
w == 0 or h == 0 still means the whole
canvas. The WM overwrites /share/wmstats every two
seconds with the interval's frame count, compositing time, worst
frame and pixels drawn (usurf_pixels), which is the
on-target compositor measurement.
Canvas ABI
SYS_WIN_CREATE maps the calling command's window canvas
read/write at 0x50000000. The process draws RGB565
pixels and publishes a finished frame with
SYS_WIN_PRESENT, optionally passing a content-relative
rectangle (struct wm_win_present) for the changed
region. Present copies that region from the back buffer into the
composited front canvas with interrupts off, so a half-drawn frame
can never reach the screen. Frames carry monotonic sequence
counters, so the WM cannot lose one. content_gen comes
from a global counter and is unique per window creation, so a new
window that reuses a just-closed slot forces the WM to remap its
front canvas instead of reusing a stale mapping.
SYS_WIN_CREATE creates a generic canvas window.
struct win_create.flags can request
WIN_F_POPOVER, a chromeless overlay: the canvas fills
the window and the WM supplies only the topmost placement.
SYS_WIN_RESIZE_SELF (115) resizes the caller's canvas
and SYS_SCREEN_INFO (116) reports the framebuffer
size, so a popover can collapse or grow. Input is exposed through
SYS_WIN_POINTER
(content-relative position, button mask, focus),
SYS_WIN_EVENT, which
queues press/release edges and a capture window, and
SYS_WIN_SCROLL, which returns wheel/touchpad scroll
accumulated for the window under the pointer in pixels
(+dy is later content). A click that starts
in a window still receives its release after the pointer leaves.
The ngui helper ngui_scroll_wheel() applies the delta
to a pane when the pointer is over it.
The WM process itself is special: it maps the screen shadow at
0x58000000 and each front canvas at
0x59000000 + index × 4 MB, which is how it composites
without reading another process's memory. The 4 MB slot covers a
full-screen 1280×1024 canvas minus the chrome; the old 2 MB slot
capped a full-height window at roughly 1050 px wide.
SYS_WM_RESIZE (WM side) and
SYS_WIN_ACK_RESIZE (client side) swap in a resized
canvas; the content size is bounded by the framebuffer, so a
window can grow to the edge of the screen.
Double-clicking a title bar maximizes the window to the work area
below the system bar (0, WM_BAR_H, fbw, fbh - WM_BAR_H);
the next double-click restores the saved geometry. Dropping a
title-bar drag with the pointer on the left or right screen edge
(WM_SNAP_EDGE, 2 px) snaps the window to that half of
the work area at full height, and the top edge maximizes it. The
restore geometry is saved only when a window leaves the normal state,
so snapping and then maximizing still restores the original size.
Dragging a maximized or snapped window restores it first, with the
grab point kept at the same fraction of the title bar, and a manual
resize clears the state. While a window is dragged, the screen edges
and the facing edges of other windows resist it: the window stays
flush until the pointer overshoots by WM_RESIST (24 px),
which makes side-by-side placement exact. Windows can be dragged past the left, right and
bottom edges; WM_DRAG_VISIBLE (48 px) of the title bar
always stays on-screen for recovery, and the top bar is never
overlapped. The resize grip is clamped to the full work area and
snaps to it when dragged into the screen corner.
Buttons fire on the release edge. The toolkit keeps
a button active until ui->released;
inferring release from the sampled button mask races the WM event
queue and drops clicks.
When a process exits or crashes, the reaper releases its window
mappings and the window server frees the canvas. Closing a window
kills its owner. Keys go through the window key queue
(SYS_WIN_KEY_WAIT) or the generic
SYS_KEY_POLL; Ctrl+C still reaches the terminal.
ngui toolkit
ngui.c/ngui.h is an
immediate-mode GUI toolkit shared by the ring-3 apps. It provides
clipped RGB565 primitives, buttons, menu items, text fields, nine
procedural icons, a theme palette, layout cut helpers and scrolling
panes. It is linked into files, mines,
solitaire, chat, the control panel and
the real gallery.elf.
- Text fields support drag-selection, double-click select-all, Ctrl+Left/Right word jumps, Ctrl+Delete/Backspace word deletion and Ctrl+A. They use the proportional face with measured caret, selection and horizontal scrolling; a field marked
disabledignores pointer and keyboard input, drops the focus and paints its value dimmed in the same proportional face. A field markedsecretis measured and painted from a*mask (caret, selection and click positions follow the mask, Ctrl+Left/Right jump to the ends), and Tab returnsNGUI_INPUT_NEXTtogether withNGUI_INPUT_CANCELso forms can move the focus. Fields hold up to 511 characters (NGUI_INPUT_MAX512). The terminal and editor keep the 8×16 cell grid. - Popover components give a menu panel its surface:
ngui_popover_begin()fills the canvas and returns the body and footer rectangles (no title bar or close button);ngui_section()draws a captioned section header with an optional right-aligned action button;ngui_list_row()is a two-line hover/selected row with optional signal bars and trailing text;ngui_tile()is a rounded quick-settings tile andngui_slider()a draggable horizontal slider. The WM draws no outer chrome, so the app paints the whole window. - Clip stack keeps nested panes and popups inside their parents.
- Layout cuts split a rectangle into rows, columns and fixed margins without a constraint solver.
- No retained widget tree. Apps redraw from state every frame, which keeps the toolkit small and predictable.
Proportional text comes from ufont.c: a
fixed-point, integer-only TrueType parser and antialiased rasterizer.
The pack carries Latin-1 Arimo regular/bold/italic/bold-italic,
Liberation Mono and a curated monochrome Noto Emoji subset under
/ramfs/fonts. The browser, ngui apps and the WM chrome
use real pixel sizes from 8 to 48 px; the browser maps CSS
font-size, font-weight,
font-style and font-family: monospace to
the faces. Missing fonts fall back to the 8×16 bitmap. The browser
detaches the font arena before heap_reset() and
reattaches after heap_start(); terminal content and
the editor keep the bitmap cells.
UTF-8 text is available through ngui_text_utf8* and
ngui_menu_item_utf8(). Per codepoint, the selected
primary face is tried first, then the lazily loaded emoji face;
cmap format 12 covers codepoints above the BMP. The emoji set is
deliberately limited to common single-codepoint glyphs that fit the
rasterizer's 256-point/16-contour limits. ZWJ sequences, flags,
skin tones and color glyphs fall back to a tofu or
?; the browser keeps its Latin-1 byte path.
Applications
files
File browser on the VFS: opens text in edit, images in view and HTML in browser. The first ngui user.
gallery
Live showcase of every ngui control and primitive. Ships in the pack as bin/gallery.app; a launcher prefers /share/GALLERY for development.
chat
Cloudron Chat client: native OIDC login, channel/DM sidebar with unread badges and presence dots, a wrapped timeline with avatars, day headers and reply snippets, a composer and browse/new-DM pickers. The top-bar Chat button launches it.
solitaire
Klondike with drag-and-drop, draw-one/three, scoring, animation and pixel-art cards on the canvas service.
view
Image viewer with fit, 1:1, zoom, pan, EXIF orientation and animated GIF playback.
clock / colors / settime
Small canvas demos: an analog clock, a colour test window, and the standalone Date & Time editor (settime). The control panel's Date & Time tile reveals its own inline editor, which reads and writes the CMOS RTC and can fetch UTC from an SNTP server.
browser
HTML/CSS renderer with flex rows, auto-fit card grids, inline-block runs, basic tables and inline SVG diagrams. It decodes inline images and fetches through a headless helper; inline and external scripts run on the vendored QuickJS engine (ES2025), and forms render and submit natively. The largest ring-3 application in the tree.
Image library
The codecs are independent of the OS and the toolkit: each takes an
input buffer plus a caller-provided struct img_mem arena
and returns an RGB565 image with an optional 8-bit alpha plane. The
browser and the chat client link the same objects and decode HTTP
bodies in memory.
- Formats. PNG, baseline and progressive JPEG, animated GIF, BMP, TGA, PNM, ICO/CUR and PAM.
- Drawing.
img_draw()is a clipped, scaled RGB565 blit: box-filter downscale, bilinear upscale, alpha over a checkerboard or over the destination. - Orientation. EXIF orientation is applied; arithmetic JPEG and CMYK are rejected.
- Cost. Downscaling runs on the CPU. The viewer caches one image; the browser keeps a display bitmap but still rescales on repaint; the chat client caches up to 480x320 message images and 32x32 circular avatars.
GPU quirks
- ATI Mach64. A CRTC fixup is applied after mode set. The legacy CRTC is skipped under UEFI.
- NVIDIA. VBE-only. The legacy VGA CRTC is never touched. On the ION, the framebuffer is stolen DRAM behind a BAR3 aperture; nvidia.c finds the stolen range and writes through a cached alias once a WC MTRR covers it.
- Intel. The Ironlake-era path supports a hardware cursor where available; the software cursor is the common fallback. Cherryview/Braswell also exposes the panel backlight (below).
- UEFI.
vga.chonours the RGBX flag and skips the VBE-only ATI CRTC reset and NVIDIA stolen-VRAM alias. mouse.c forces the software cursor.
Panel backlight
The HP Chromebook 11 G5 (google/setzer, Braswell)
drives its internal panel PWM from the display engine, not from
the Chrome EC. The board VBT (data.vbt, block 43)
declares PWM controller 0 at 200 Hz, active high. Linux uses the
same Valleyview/Cherryview registers through
intel_backlight.
- Registers.
BLC_PWM_CTL2at GPU BAR0 +0x1E1250(pipe A; pipe B is+0x100): bit 31 enables, bit 28 is polarity.BLC_PWM_CTLat0x1E1254: period in bits 31:16, duty in bits 15:0. The Cherryview PWM clock is 19.2 MHz with a fixed /16 increment, so 200 Hz is a period of 6000. - Probe. backlight.c matches Intel
8086:22b0/22b1, maps the graphics MMIO BAR, reads both pipes, follows the one the firmware enabled and falls back to controller 0. It logs the chosen pipe, period, duty and raw registers to COM1. - Use. The
backlightcommand prints the percentage and PWM state;backlight up|downsteps by 10%,backlight 0-100sets a level (clamped to 5..100), andbacklight probedumps both pipes' registers.SYS_BACKLIGHTgives ring 3 the same get/set/step, which drives the control panel's brightness slider. F6/F7 (the ChromeOS EC action-row brightness keys) and the standardE0 14/E0 15brightness scancodes adjust it; the keys are consumed in io.c and never reach a window. - Overlay.
SYS_WM_POLLalso reports the backlight percentage and a change counter. After each change the ring-3 WM (ucmd_wm.c) draws a centered Brightness bubble with a sun icon, the percentage and a level bar, keeps it up for 3 s, and composits it above the windows on every pass while it is visible. - Limits. Only the Cherryview/Braswell native PWM (
8086:22b0/22b1) is driven. The level is not persisted; a cold boot returns to the firmware's duty.
Source map
vga.c,vga.h— framebuffer and damagevga_copy.S— copy primitivesblit.c,blit.h— pixel vtablecpu.c— SSE2 probingwm.c,wm.h,wm_abi.h— kernel window server and shared ABIucmd_wm.c,uwm_lib.c— ring-3 WMucmd_netmenu.c— top-bar control panel (network/WiFi, brightness, power mode, Date & Time)ucmd_settime.c,rtc.c,ntp.c— Date & Time editor, RTC access and SNTP syncgfx.c,gfx.h— RGB565 window canvasessys_wm.c,sys_wm.h— WM/window ABIbrowser.c,browser_html.c— HTML/CSS renderer and inline SVGngui.c,ngui.h— toolkitufont.c,ufont_ttf.c,ufont_draw.c— fixed-point TrueType textfonts/*.ttf— Arimo / Liberation Mono / Noto Emoji subsets in the packucmd_files.c,gallery.c,ucmd_solitaire.c,ucmd_chat.cimg*.c— image codecsati.c,nvidia.c,intel.c,nv50.cbacklight.c,backlight.h— Cherryview/VLV panel PWM