graphics.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <title>Graphics &amp; UI | NebOS Architecture</title>
  7. <meta name="description" content="NebOS graphics architecture: VBE framebuffer, shadow buffer, damage rectangles, blit vtable, window manager, canvas ABI, ngui toolkit and image library.">
  8. <link rel="icon" href="favicon.svg" type="image/svg+xml">
  9. <link rel="stylesheet" href="style.css">
  10. </head>
  11. <body>
  12. <a class="skip" href="#main">Skip to content</a>
  13. <header class="site-header">
  14. <a class="brand" href="index.html">
  15. <span class="brand-mark" aria-hidden="true"></span>
  16. <span>NebOS <span class="brand-sub">Architecture</span></span>
  17. </a>
  18. <nav class="site-nav" aria-label="Architecture sections">
  19. <a href="index.html">Overview</a>
  20. <a href="boot.html">Boot</a>
  21. <a href="memory.html">Memory</a>
  22. <a href="cpu.html">CPU</a>
  23. <a href="drivers.html">Drivers</a>
  24. <a href="filesystems.html">Filesystems</a>
  25. <a href="graphics.html" aria-current="page">Graphics</a>
  26. <a href="network.html">Network</a>
  27. <a href="userland.html">Userland</a>
  28. <a href="development.html">Development</a>
  29. </nav>
  30. </header>
  31. <main id="main" class="page">
  32. <div class="page-head">
  33. <p class="kicker">Graphics &amp; UI</p>
  34. <h1>Draw into a shadow, publish by damage.</h1>
  35. <p class="lede">
  36. The display path is intentionally simple: drawing lands in a RAM
  37. shadow buffer, damage rectangles describe what changed, and a
  38. budgeted flush copies those rectangles to VRAM. Windows add a
  39. compositor and a mapped-canvas ABI on top; a small immediate-mode
  40. toolkit supplies the widgets.
  41. </p>
  42. <div class="meta">
  43. <span class="pill">VBE LFB</span>
  44. <span class="pill">1 MiB flush budget</span>
  45. <span class="pill">8 windows</span>
  46. <span class="pill">RGB565 canvases</span>
  47. </div>
  48. </div>
  49. <nav class="toc" aria-label="On this page">
  50. <h2>On this page</h2>
  51. <ul>
  52. <li><a href="#framebuffer">Framebuffer</a></li>
  53. <li><a href="#shadow">Shadow &amp; damage</a></li>
  54. <li><a href="#blit">Blit backends</a></li>
  55. <li><a href="#wm">Window manager</a></li>
  56. <li><a href="#canvas">Canvas ABI</a></li>
  57. <li><a href="#ngui">ngui toolkit</a></li>
  58. <li><a href="#apps">Applications</a></li>
  59. <li><a href="#images">Image library</a></li>
  60. <li><a href="#gpu">GPU quirks</a></li>
  61. <li><a href="#backlight">Panel backlight</a></li>
  62. <li><a href="#sources">Source map</a></li>
  63. </ul>
  64. </nav>
  65. <section id="framebuffer">
  66. <h2>Framebuffer</h2>
  67. <p>
  68. The boot path writes a <code>struct vga_boot_fb_info</code> to
  69. <code>0x600</code>: LFB base, pitch, width, height, bits per pixel
  70. and an RGBX flag for GOP's byte order. The legacy VESA stage chooses
  71. a mode with at least 16 bpp, a linear framebuffer, it must fit the
  72. card's VRAM, and width at most 1280 pixels. The UEFI loader imposes
  73. its own GOP constraints.
  74. </p>
  75. <p>
  76. <span class="file">vga.c</span> owns the visible surface. On a
  77. normal boot the render target is a RAM shadow buffer at
  78. <code>0x100000</code>, not the LFB; the 8 MB reserve leaves room for
  79. future modes. A surface carries width, height, pitch, format and a
  80. pixel-pointer, so the same drawing code can target a window layer or
  81. a canvas.
  82. </p>
  83. </section>
  84. <section id="shadow">
  85. <h2>Shadow buffer &amp; damage</h2>
  86. <p>
  87. Drawing never writes VRAM directly. Each operation records a damage
  88. rectangle; overlapping or touching rectangles merge, so a keystroke's
  89. cells collapse into one small rect while unrelated damage stays
  90. apart. The main loop calls <code>vga_present_shadow()</code> on every
  91. iteration with a byte budget of <code>VGA_FLUSH_BUDGET_BYTES</code>
  92. (1 MiB by default).
  93. </p>
  94. <ul>
  95. <li><strong>Small rects copy whole.</strong> A window repaint within the budget never tears.</li>
  96. <li><strong>Large rects are chunked.</strong> A full-screen redraw continues across loop iterations; newer damage is queued behind it.</li>
  97. <li><strong>No fixed frame rate.</strong> The loop flushes whenever there is pending damage, so a cursor move reaches the screen within one loop.</li>
  98. <li><strong>Re-entry guard.</strong> <code>vga_present_shadow()</code> refuses to run while another process is mid-flush; a full-screen copy is long enough to be preempted.</li>
  99. <li><strong>Window drags flush immediately.</strong> <code>wm_drag_shadow</code> copies each drag step as one consistent frame.</li>
  100. </ul>
  101. <p>
  102. When the target is not the screen — a window layer or an app canvas —
  103. <code>vga_target_damage()</code> is a no-op. The render target
  104. override is stored in the PCB, so a preempted draw cannot leak into
  105. another process's window.
  106. </p>
  107. </section>
  108. <section id="blit">
  109. <h2>Blit backends</h2>
  110. <p>
  111. <span class="file">blit.c</span> is the pixel-operation vtable:
  112. fill, copy, blend, canvas, present and flip. Software is the only
  113. backend today, but the WM calls the vtable rather than a fixed
  114. function, so an accelerator can replace individual operations
  115. without touching window logic.
  116. </p>
  117. <p>
  118. The software fill uses an SSE2 row store when the CPU supports it.
  119. Rows that do not fit the cache use streaming stores
  120. (<code>movntdq</code>, one <code>sfence</code> per fill), which
  121. avoids read-for-ownership traffic that makes large fills DRAM-bound
  122. on the Atom. SSE/SSE2 are never assumed: the kernel is built with
  123. <code>-mno-sse</code>, and <code>cpu_has_sse2()</code> probes CPUID,
  124. sets <code>CR4.OSFXSR/OSXMMEXCPT</code> and is re-run on every AP.
  125. </p>
  126. <p>
  127. <code>gfxbench</code> times fill, copy, cell, canvas and flush paths
  128. and reports the bytes actually copied by the presenter.
  129. </p>
  130. </section>
  131. <section id="wm">
  132. <h2>Window manager</h2>
  133. <p>
  134. The WM is a process that owns the desktop and a fixed array of eight
  135. windows. It draws a system bar with the banner, launcher buttons,
  136. clock, the temperature, and, on ThinkPads and Chromebooks, an
  137. AC/battery status icon at the far right (a plug on AC, a
  138. level-filled battery on battery, with a percentage tooltip below
  139. the bar on hover, painted above the windows), plus draggable
  140. terminal and canvas windows with a title bar and close button.
  141. Click-to-focus, drag-by-title-bar and close are routed through the
  142. same pointer path. To the left of the rightmost AC/battery status
  143. icon, a network status icon shows a
  144. cable for wired Ethernet, signal bars for a connected WiFi link, a
  145. USB mark for RNDIS tethering, or a red X when no link is up;
  146. clicking it opens the anchored <code>bin/netmenu</code> popover.
  147. Present NICs can be selected (then DHCP runs), and scanned WiFi
  148. networks can be joined, asking for the WPA2 passphrase first when
  149. the AP requires one. The right-aligned date/time text sits to the
  150. icon's left and is also a target: it highlights on hover and opens
  151. the Date &amp; Time editor (<code>bin/settime</code>) on a click.
  152. </p>
  153. <p>
  154. A popover is a chromeless canvas window created with
  155. <code>u_win_create_popover()</code> (<code>WIN_F_POPOVER</code>).
  156. The WM anchors it under the status icon, treats it as always
  157. topmost in painting and hit-testing, and draws no chrome at all:
  158. the canvas fills the whole window rectangle, with no title bar,
  159. shadow, rim or rounded outer corners, so it reads as a flat menu
  160. panel. The kernel uses the window origin for content-relative
  161. pointer and scroll coordinates. An outside press dismisses the
  162. popover and the click then continues normally; a second click on
  163. the network icon toggles it. The panel itself is drawn with the
  164. ngui popover components: a flat body with section captions and
  165. two-line list rows, and a footer status line.
  166. </p>
  167. <p>
  168. The WM is the ring-3 process loaded from
  169. <code>/ramfs/bin/wm</code>; there is no kernel WM fallback. The
  170. kernel window server in <span class="file">wm.c</span> owns the
  171. shadow mapping, the per-window canvases, input routing, the cursor,
  172. kexec detection and the boot-console handoff. It starts the first
  173. terminal after the storage mount
  174. (<code>wm_server_boot_ready</code>) and leaves the boot console
  175. visible until the WM attaches.
  176. </p>
  177. <figure class="figure">
  178. <svg viewBox="0 0 920 260" role="img" aria-labelledby="wm-title wm-desc">
  179. <title id="wm-title">Window anatomy</title>
  180. <desc id="wm-desc">A window consists of a title bar, a content area backed by an RGB565 canvas, and a close control. The WM composites the canvas into the screen shadow buffer.</desc>
  181. <rect class="svg-box" x="70" y="22" width="780" height="200" rx="10"/>
  182. <rect class="svg-box accent" x="70" y="22" width="780" height="34" rx="10"/>
  183. <text class="svg-text" x="88" y="45">Terminal · /ramfs/bin/ls</text>
  184. <text class="svg-text" x="800" y="45">×</text>
  185. <rect class="svg-box green" x="86" y="72" width="748" height="132" rx="6"/>
  186. <text class="svg-text" x="104" y="98">content canvas · RGB565 · mapped at 0x50000000</text>
  187. <text class="svg-sub" x="104" y="120">text cells, images, widgets, or arbitrary drawing</text>
  188. </svg>
  189. <figcaption>
  190. <strong>One window, one canvas.</strong> The title bar belongs to
  191. the WM; the content is whatever the owning process draws into its
  192. mapped back buffer. The WM never reads the process's memory — it
  193. composites the front canvas on <code>PRESENT</code>.
  194. </figcaption>
  195. </figure>
  196. <ul>
  197. <li><strong>Terminal windows</strong> are canvas clients: <span class="file">ucmd_term.c</span> renders its rows into the RGB565 window canvas; keys arrive through the generic <code>SYS_KEY_POLL</code> or <code>SYS_WIN_KEY_WAIT</code>. The WM no longer has a text-cell path.</li>
  198. <li><strong>Canvas windows</strong> are generic: the app gets a back buffer, pointer position/buttons/focus and queued press/release edges with capture.</li>
  199. <li><strong>Focus and z-order</strong> are explicit; closing a window kills its session and frees its canvas.</li>
  200. </ul>
  201. <h3>Compositing cost</h3>
  202. <p>
  203. The WM keeps a front-to-back order: the focused window first, then
  204. the remaining windows in descending slot order. For each damage
  205. rectangle it fills the desktop once and walks that order, subtracting
  206. every window in front from the region still uncovered. A window is
  207. drawn only in its exposed pieces, so a fully occluded window costs
  208. nothing and the stack is never repainted back-to-front. The kernel
  209. pointer hit-test uses the same order. A focused-window drag copies
  210. its shadow block to the new position and repaints only the old
  211. strips the new rectangle does not cover, instead of compositing the
  212. window at both positions. If either rectangle is partly off-screen
  213. the shadow has no valid pixels for the hidden part, so that step
  214. repaints the window rect instead of copying desktop background into
  215. it.
  216. </p>
  217. <p>
  218. <code>SYS_WIN_PRESENT</code> carries a content-relative damage
  219. rectangle. The terminal tracks its dirty rows, so a keystroke copies
  220. and composites one 8×16 row block instead of the whole 512×512
  221. canvas. The kernel unions the rectangles between WM polls and
  222. <code>SYS_WM_INFO</code> returns that union; a present with
  223. <code>w == 0</code> or <code>h == 0</code> still means the whole
  224. canvas. The WM overwrites <code>/share/wmstats</code> every two
  225. seconds with the interval's frame count, compositing time, worst
  226. frame and pixels drawn (<code>usurf_pixels</code>), which is the
  227. on-target compositor measurement.
  228. </p>
  229. </section>
  230. <section id="canvas">
  231. <h2>Canvas ABI</h2>
  232. <p>
  233. <code>SYS_WIN_CREATE</code> maps the calling command's window canvas
  234. read/write at <code>0x50000000</code>. The process draws RGB565
  235. pixels and publishes a finished frame with
  236. <code>SYS_WIN_PRESENT</code>, optionally passing a content-relative
  237. rectangle (<code>struct wm_win_present</code>) for the changed
  238. region. Present copies that region from the back buffer into the
  239. composited front canvas with interrupts off, so a half-drawn frame
  240. can never reach the screen. Frames carry monotonic sequence
  241. counters, so the WM cannot lose one.
  242. </p>
  243. <p>
  244. <code>SYS_WIN_CREATE</code> creates a generic canvas window.
  245. <code>struct win_create.flags</code> can request
  246. <code>WIN_F_POPOVER</code>, a chromeless overlay: the canvas fills
  247. the window and the WM supplies only the topmost placement.
  248. Input is exposed through <code>SYS_WIN_POINTER</code>
  249. (content-relative position, button mask, focus),
  250. <code>SYS_WIN_EVENT</code>, which
  251. queues press/release edges and a capture window, and
  252. <code>SYS_WIN_SCROLL</code>, which returns wheel/touchpad scroll
  253. accumulated for the window under the pointer in pixels
  254. (<code>+dy</code> is later content). A click that starts
  255. in a window still receives its release after the pointer leaves.
  256. The ngui helper <code>ngui_scroll_wheel()</code> applies the delta
  257. to a pane when the pointer is over it.
  258. The WM process itself is special: it maps the screen shadow at
  259. <code>0x58000000</code> and each front canvas at
  260. <code>0x59000000 + index × 4 MB</code>, which is how it composites
  261. without reading another process's memory. The 4 MB slot covers a
  262. full-screen 1280×1024 canvas minus the chrome; the old 2 MB slot
  263. capped a full-height window at roughly 1050 px wide.
  264. <code>SYS_WM_RESIZE</code> (WM side) and
  265. <code>SYS_WIN_ACK_RESIZE</code> (client side) swap in a resized
  266. canvas; the content size is bounded by the framebuffer, so a
  267. window can grow to the edge of the screen.
  268. </p>
  269. <p>
  270. Double-clicking a title bar maximizes the window to the work area
  271. below the system bar (<code>0, WM_BAR_H, fbw, fbh - WM_BAR_H</code>);
  272. the next double-click restores the saved geometry. Dragging a
  273. maximized window restores it first, and a manual resize clears the
  274. maximized state. Windows can be dragged past the left, right and
  275. bottom edges; <code>WM_DRAG_VISIBLE</code> (48 px) of the title bar
  276. always stays on-screen for recovery, and the top bar is never
  277. overlapped. The resize grip is clamped to the full work area and
  278. snaps to it when dragged into the screen corner.
  279. </p>
  280. <div class="note">
  281. <p><strong>Buttons fire on the release edge.</strong> The toolkit keeps
  282. a button <code>active</code> until <code>ui-&gt;released</code>;
  283. inferring release from the sampled button mask races the WM event
  284. queue and drops clicks.</p>
  285. </div>
  286. <p>
  287. When a process exits or crashes, the reaper releases its window
  288. mappings and the window server frees the canvas. Closing a window
  289. kills its owner. Keys go through the window key queue
  290. (<code>SYS_WIN_KEY_WAIT</code>) or the generic
  291. <code>SYS_KEY_POLL</code>; Ctrl+C still reaches the terminal.
  292. </p>
  293. </section>
  294. <section id="ngui">
  295. <h2>ngui toolkit</h2>
  296. <p>
  297. <span class="file">ngui.c</span>/<span class="file">ngui.h</span> is an
  298. immediate-mode GUI toolkit shared by the ring-3 apps. It provides
  299. clipped RGB565 primitives, buttons, menu items, text fields, nine
  300. procedural icons, a theme palette, layout cut helpers and scrolling
  301. panes. It is linked into <code>files</code>, <code>mines</code>,
  302. <code>solitaire</code>, <code>chat</code> and the real
  303. <code>gallery.elf</code>.
  304. </p>
  305. <ul>
  306. <li><strong>Text fields</strong> 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 <code>disabled</code> ignores pointer and keyboard input, drops the focus and paints its value dimmed in the same proportional face. A field marked <code>secret</code> is measured and painted from a <code>*</code> mask (caret, selection and click positions follow the mask, Ctrl+Left/Right jump to the ends), and Tab returns <code>NGUI_INPUT_NEXT</code> together with <code>NGUI_INPUT_CANCEL</code> so forms can move the focus. Fields hold up to 511 characters (<code>NGUI_INPUT_MAX</code> 512). The terminal and editor keep the 8×16 cell grid.</li>
  307. <li><strong>Popover components</strong> give a menu panel its surface: <code>ngui_popover_begin()</code> fills the canvas and returns the body and footer rectangles (no title bar or close button); <code>ngui_section()</code> draws a captioned section header with an optional right-aligned action button; <code>ngui_list_row()</code> is a two-line hover/selected row with optional signal bars and trailing text. The WM draws no outer chrome, so the app paints the whole window.</li>
  308. <li><strong>Clip stack</strong> keeps nested panes and popups inside their parents.</li>
  309. <li><strong>Layout cuts</strong> split a rectangle into rows, columns and fixed margins without a constraint solver.</li>
  310. <li><strong>No retained widget tree.</strong> Apps redraw from state every frame, which keeps the toolkit small and predictable.</li>
  311. </ul>
  312. <p>
  313. Proportional text comes from <span class="file">ufont.c</span>: a
  314. fixed-point, integer-only TrueType parser and antialiased rasterizer.
  315. The pack carries Latin-1 Arimo regular/bold/italic/bold-italic,
  316. Liberation Mono and a curated monochrome Noto Emoji subset under
  317. <code>/ramfs/fonts</code>. The browser, ngui apps and the WM chrome
  318. use real pixel sizes from 8 to 48 px; the browser maps CSS
  319. <code>font-size</code>, <code>font-weight</code>,
  320. <code>font-style</code> and <code>font-family: monospace</code> to
  321. the faces. Missing fonts fall back to the 8×16 bitmap. The browser
  322. detaches the font arena before <code>heap_reset()</code> and
  323. reattaches after <code>heap_start()</code>; terminal content and
  324. the editor keep the bitmap cells.
  325. </p>
  326. <p>
  327. UTF-8 text is available through <code>ngui_text_utf8*</code> and
  328. <code>ngui_menu_item_utf8()</code>. Per codepoint, the selected
  329. primary face is tried first, then the lazily loaded emoji face;
  330. cmap format 12 covers codepoints above the BMP. The emoji set is
  331. deliberately limited to common single-codepoint glyphs that fit the
  332. rasterizer's 256-point/16-contour limits. ZWJ sequences, flags,
  333. skin tones and color glyphs fall back to a tofu or
  334. <code>?</code>; the browser keeps its Latin-1 byte path.
  335. </p>
  336. </section>
  337. <section id="apps">
  338. <h2>Applications</h2>
  339. <div class="grid">
  340. <div class="card">
  341. <h3>files</h3>
  342. <p>File browser on the VFS: opens text in <code>edit</code>, images in <code>view</code> and HTML in <code>browser</code>. The first ngui user.</p>
  343. </div>
  344. <div class="card">
  345. <h3>gallery</h3>
  346. <p>Live showcase of every ngui control and primitive. Ships in the pack as <code>bin/gallery.app</code>; a launcher prefers <code>/share/GALLERY</code> for development.</p>
  347. </div>
  348. <div class="card">
  349. <h3>chat</h3>
  350. <p>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 <em>Chat</em> button launches it.</p>
  351. </div>
  352. <div class="card">
  353. <h3>solitaire</h3>
  354. <p>Klondike with drag-and-drop, draw-one/three, scoring, animation and pixel-art cards on the canvas service.</p>
  355. </div>
  356. <div class="card">
  357. <h3>view</h3>
  358. <p>Image viewer with fit, 1:1, zoom, pan, EXIF orientation and animated GIF playback.</p>
  359. </div>
  360. <div class="card">
  361. <h3>clock / colors / settime</h3>
  362. <p>Small canvas demos: an analog clock, a colour test window, and the Date &amp; Time editor. Clicking the top-bar date/time opens <code>settime</code>, which reads and writes the CMOS RTC and can fetch UTC from an SNTP server.</p>
  363. </div>
  364. <div class="card">
  365. <h3>browser</h3>
  366. <p>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.</p>
  367. </div>
  368. </div>
  369. </section>
  370. <section id="images">
  371. <h2>Image library</h2>
  372. <p>
  373. The codecs are independent of the OS and the toolkit: each takes an
  374. input buffer plus a caller-provided <code>struct img_mem</code> arena
  375. and returns an RGB565 image with an optional 8-bit alpha plane. The
  376. browser and the chat client link the same objects and decode HTTP
  377. bodies in memory.
  378. </p>
  379. <ul>
  380. <li><strong>Formats.</strong> PNG, baseline and progressive JPEG, animated GIF, BMP, TGA, PNM, ICO/CUR and PAM.</li>
  381. <li><strong>Drawing.</strong> <code>img_draw()</code> is a clipped, scaled RGB565 blit: box-filter downscale, bilinear upscale, alpha over a checkerboard or over the destination.</li>
  382. <li><strong>Orientation.</strong> EXIF orientation is applied; arithmetic JPEG and CMYK are rejected.</li>
  383. <li><strong>Cost.</strong> 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.</li>
  384. </ul>
  385. </section>
  386. <section id="gpu">
  387. <h2>GPU quirks</h2>
  388. <ul>
  389. <li><strong>ATI Mach64.</strong> A CRTC fixup is applied after mode set. The legacy CRTC is skipped under UEFI.</li>
  390. <li><strong>NVIDIA.</strong> VBE-only. The legacy VGA CRTC is never touched. On the ION, the framebuffer is stolen DRAM behind a BAR3 aperture; <span class="file">nvidia.c</span> finds the stolen range and writes through a cached alias once a WC MTRR covers it.</li>
  391. <li><strong>Intel.</strong> 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).</li>
  392. <li><strong>UEFI.</strong> <code>vga.c</code> honours the RGBX flag and skips the VBE-only ATI CRTC reset and NVIDIA stolen-VRAM alias. <span class="file">mouse.c</span> forces the software cursor.</li>
  393. </ul>
  394. </section>
  395. <section id="backlight">
  396. <h2>Panel backlight</h2>
  397. <p>
  398. The HP Chromebook 11 G5 (<code>google/setzer</code>, Braswell)
  399. drives its internal panel PWM from the display engine, not from
  400. the Chrome EC. The board VBT (<code>data.vbt</code>, block 43)
  401. declares PWM controller 0 at 200 Hz, active high. Linux uses the
  402. same Valleyview/Cherryview registers through
  403. <code>intel_backlight</code>.
  404. </p>
  405. <ul>
  406. <li><strong>Registers.</strong> <code>BLC_PWM_CTL2</code> at GPU BAR0 + <code>0x1E1250</code> (pipe A; pipe B is <code>+0x100</code>): bit 31 enables, bit 28 is polarity. <code>BLC_PWM_CTL</code> at <code>0x1E1254</code>: 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.</li>
  407. <li><strong>Probe.</strong> <span class="file">backlight.c</span> matches Intel <code>8086:22b0</code>/<code>22b1</code>, 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.</li>
  408. <li><strong>Use.</strong> The <code>backlight</code> command prints the percentage and PWM state; <code>backlight up|down</code> steps by 10%, <code>backlight 0-100</code> sets a level (clamped to 5..100), and <code>backlight probe</code> dumps both pipes' registers. F6/F7 (the ChromeOS EC action-row brightness keys) and the standard <code>E0 14</code>/<code>E0 15</code> brightness scancodes adjust it; the keys are consumed in <span class="file">io.c</span> and never reach a window.</li>
  409. <li><strong>Overlay.</strong> <code>SYS_WM_POLL</code> also reports the backlight percentage and a change counter. After each change the ring-3 WM (<span class="file">ucmd_wm.c</span>) draws a centered <em>Brightness</em> 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.</li>
  410. <li><strong>Limits.</strong> Only the Cherryview/Braswell native PWM (<code>8086:22b0</code>/<code>22b1</code>) is driven. The level is not persisted; a cold boot returns to the firmware's duty.</li>
  411. </ul>
  412. </section>
  413. <section id="sources">
  414. <h2>Source map</h2>
  415. <ul class="filelist">
  416. <li><code>vga.c</code>, <code>vga.h</code> — framebuffer and damage</li>
  417. <li><code>vga_copy.S</code> — copy primitives</li>
  418. <li><code>blit.c</code>, <code>blit.h</code> — pixel vtable</li>
  419. <li><code>cpu.c</code> — SSE2 probing</li>
  420. <li><code>wm.c</code>, <code>wm.h</code>, <code>wm_abi.h</code> — kernel window server and shared ABI</li>
  421. <li><code>ucmd_wm.c</code>, <code>uwm_lib.c</code> — ring-3 WM</li>
  422. <li><code>ucmd_netmenu.c</code> — top-bar network popover (NIC selection, DHCP, WiFi scan/passphrase)</li>
  423. <li><code>ucmd_settime.c</code>, <code>rtc.c</code>, <code>ntp.c</code> — Date &amp; Time editor, RTC access and SNTP sync</li>
  424. <li><code>gfx.c</code>, <code>gfx.h</code> — RGB565 window canvases</li>
  425. <li><code>sys_wm.c</code>, <code>sys_wm.h</code> — WM/window ABI</li>
  426. <li><code>browser.c</code>, <code>browser_html.c</code> — HTML/CSS renderer and inline SVG</li>
  427. <li><code>ngui.c</code>, <code>ngui.h</code> — toolkit</li>
  428. <li><code>ufont.c</code>, <code>ufont_ttf.c</code>, <code>ufont_draw.c</code> — fixed-point TrueType text</li>
  429. <li><code>fonts/*.ttf</code> — Arimo / Liberation Mono / Noto Emoji subsets in the pack</li>
  430. <li><code>ucmd_files.c</code>, <code>gallery.c</code>, <code>ucmd_solitaire.c</code>, <code>ucmd_chat.c</code></li>
  431. <li><code>img*.c</code> — image codecs</li>
  432. <li><code>ati.c</code>, <code>nvidia.c</code>, <code>intel.c</code>, <code>nv50.c</code></li>
  433. <li><code>backlight.c</code>, <code>backlight.h</code> — Cherryview/VLV panel PWM</li>
  434. </ul>
  435. </section>
  436. </main>
  437. <footer class="site-footer">
  438. <div class="inner">
  439. <p><strong>NebOS 0.2.0</strong> · Architecture documentation · <a href="index.html">overview</a></p>
  440. <p>Maintain alongside <code>AGENTS.md</code> and the source files listed on each page.</p>
  441. </div>
  442. </footer>
  443. </body>
  444. </html>