| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527 |
- <!doctype html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <title>Drivers & Buses | NebOS Architecture</title>
- <meta name="description" content="NebOS drivers: PCI enumeration, floppy/ATA/AHCI storage, the USB core with UHCI, OHCI, EHCI and xHCI, HID input, USB mass storage, serial, board sensors and the panic path.">
- <link rel="icon" href="favicon.svg" type="image/svg+xml">
- <link rel="stylesheet" href="style.css">
- </head>
- <body>
- <a class="skip" href="#main">Skip to content</a>
- <header class="site-header">
- <a class="brand" href="index.html">
- <span class="brand-mark" aria-hidden="true"></span>
- <span>NebOS <span class="brand-sub">Architecture</span></span>
- </a>
- <nav class="site-nav" aria-label="Architecture sections">
- <a href="index.html">Overview</a>
- <a href="boot.html">Boot</a>
- <a href="memory.html">Memory</a>
- <a href="cpu.html">CPU</a>
- <a href="drivers.html" aria-current="page">Drivers</a>
- <a href="filesystems.html">Filesystems</a>
- <a href="graphics.html">Graphics</a>
- <a href="network.html">Network</a>
- <a href="userland.html">Userland</a>
- <a href="development.html">Development</a>
- </nav>
- </header>
- <main id="main" class="page">
- <div class="page-head">
- <p class="kicker">Drivers & buses</p>
- <h1>Polled hardware, one vtable per bus.</h1>
- <p class="lede">
- Most NebOS drivers are polled rather than interrupt-driven: storage,
- USB and every NIC are serviced from process context. That trades
- latency and CPU time for simple, single-owner state and a kernel that
- stays easy to reason about on old hardware.
- </p>
- <div class="meta">
- <span class="pill">PCI enumeration</span>
- <span class="pill">FDC · PATA · SATA</span>
- <span class="pill">UHCI · OHCI · EHCI · xHCI</span>
- <span class="pill">PS/2 · USB · I2C touchpad</span>
- </div>
- </div>
- <nav class="toc" aria-label="On this page">
- <h2>On this page</h2>
- <ul>
- <li><a href="#inventory">Driver inventory</a></li>
- <li><a href="#pci">PCI & discovery</a></li>
- <li><a href="#storage">Storage</a></li>
- <li><a href="#usb">USB stack</a></li>
- <li><a href="#hid">Input</a></li>
- <li><a href="#serial">Serial</a></li>
- <li><a href="#sensors">Sensors & power</a></li>
- <li><a href="#rtc">Wall clock (RTC)</a></li>
- <li><a href="#panic">Panic screen</a></li>
- <li><a href="#limits">Limits</a></li>
- <li><a href="#sources">Source map</a></li>
- </ul>
- </nav>
- <section id="inventory">
- <h2>Driver inventory</h2>
- <p>
- Every driver in the tree is small enough to read in one sitting. The
- table below is the quickest way to find the one responsible for a
- device.
- </p>
- <div class="table-wrap">
- <table>
- <thead>
- <tr><th>Subsystem</th><th>Driver</th><th>Bus / access</th><th>Service model</th></tr>
- </thead>
- <tbody>
- <tr><td>Floppy</td><td><span class="file">disk.c</span></td><td>ISA FDC + DMA channel 2</td><td>IRQ 6; FAT operations set <code>sys_fs_busy</code></td></tr>
- <tr><td>PATA</td><td><span class="file">ata.c</span></td><td>Legacy ports or PCI native BARs</td><td>Polled PIO, DRQ wait per sector</td></tr>
- <tr><td>SATA</td><td><span class="file">ahci.c</span></td><td>PCI AHCI MMIO</td><td>Polled, READ/WRITE DMA EXT</td></tr>
- <tr><td>eMMC</td><td><span class="file">sdhci.c</span></td><td>Intel Braswell SDHCI, PCI <code>00:10.0</code> (<code>8086:2294</code>)</td><td>Polled PIO, 1-bit/25 MHz; no DMA/IRQ</td></tr>
- <tr><td>USB</td><td><span class="file">usb.c</span> + <span class="file">uhci.c</span> <span class="file">ohci.c</span> <span class="file">ehci.c</span> <span class="file">xhci.c</span></td><td>PCI I/O ports or MMIO</td><td>Polled; hotplug watcher in the WM loop</td></tr>
- <tr><td>Network</td><td><span class="file">e1000e.c</span> <span class="file">r8168.c</span> <span class="file">ne2000.c</span> <span class="file">asix.c</span></td><td>PCI or USB</td><td>Polled, one active receiver</td></tr>
- <tr><td>PS/2</td><td><span class="file">mouse.c</span>, <span class="file">io.c</span></td><td>i8042</td><td>IRQ 1 keyboard, IRQ 12 mouse; polling fallback</td></tr>
- <tr><td>Touchpad</td><td><span class="file">i2c.c</span>, <span class="file">touchpad.c</span></td><td>LPSS DesignWare I2C, slave <code>0x15</code></td><td>Polled input register every 25 ms; software tap gestures; no GPIO interrupt driver</td></tr>
- <tr><td>Serial</td><td><span class="file">serial.c</span></td><td>16550 UART, COM1</td><td>IRQ 4 ring buffer + polled transmitter</td></tr>
- <tr><td>Thermal</td><td><span class="file">thermal.c</span></td><td>Intel DTS MSR</td><td>Sampled once a second from the scheduler tick</td></tr>
- <tr><td>Board sensors / EC</td><td><span class="file">it87.c</span>, <span class="file">tpec.c</span>, <span class="file">ec.c</span>, <span class="file">cros_ec.c</span></td><td>Super I/O, ThinkPad H8 EC, Chrome OS EC (temps, fans, battery, AC, switches)</td><td>Polled; EC battery-index/FIFO/page-selector writes only</td></tr>
- <tr><td>Wall clock</td><td><span class="file">rtc.c</span></td><td>CMOS RTC ports <code>0x70/0x71</code></td><td>Read/write under the BKL; update-cycle retries and a 1970–2069 two-digit year window</td></tr>
- </tbody>
- </table>
- </div>
- </section>
- <section id="pci">
- <h2>PCI & discovery</h2>
- <p>
- <span class="file">pci.c</span> walks bus/device/function and exposes
- BAR and capability access. The USB scan checks all functions: real
- PIIX3/PIIX4/VIA layouts put the USB function at 0:07.2 or 0:01.2, not
- 0:07.0. Controllers with unassigned BARs are ignored rather than
- driven at address zero.
- </p>
- <p>
- MMIO regions are mapped through <code>paging_map_mmio()</code>. PCI
- interrupts are disabled before touching MMIO, so every driver polls
- its own status registers. <code>lspci</code> lists every function;
- with a filter it prints BAR type, size and address details.
- </p>
- </section>
- <section id="storage">
- <h2>Storage</h2>
- <p>
- <span class="file">blkdev.c</span> is a small registry of block
- devices. Each device exposes sector read/write plus geometry; FAT,
- the format command and the installer sit above that interface and
- never talk to a controller directly. Devices are named
- <code>floppy0</code>, <code>ide0</code>, <code>sata0</code>,
- <code>mmc0</code>, <code>usb0</code> and so on; partitions append
- <code>p1</code>, <code>p2</code>.
- </p>
- <figure class="figure">
- <svg viewBox="0 0 920 246" role="img" aria-labelledby="storage-title storage-desc">
- <title id="storage-title">Storage software layers</title>
- <desc id="storage-desc">The VFS, format and install tools use a block-device registry, which dispatches to the floppy, ATA PIO, AHCI, SDHCI or USB mass-storage driver, then to the physical disk.</desc>
- <rect class="svg-box blue" x="40" y="30" width="230" height="62" rx="9"/>
- <text class="svg-text" x="60" y="57">VFS · FAT · format · install</text>
- <text class="svg-sub" x="60" y="77">files, or a whole-image clone</text>
- <rect class="svg-box accent" x="345" y="30" width="230" height="62" rx="9"/>
- <text class="svg-text" x="365" y="57">blkdev registry</text>
- <text class="svg-sub" x="365" y="77">sector read / write + geometry</text>
- <rect class="svg-box" x="650" y="30" width="230" height="62" rx="9"/>
- <text class="svg-text" x="670" y="57">driver</text>
- <text class="svg-sub" x="670" y="77">FDC · ATA · AHCI · SDHCI · USB</text>
- <path class="svg-line blue" d="M270 61h67"/>
- <path class="svg-line blue" d="M330 55l7 6-7 6"/>
- <path class="svg-line accent" d="M575 61h67"/>
- <path class="svg-line accent" d="M635 55l7 6-7 6"/>
- <rect class="svg-box green" x="40" y="142" width="230" height="62" rx="9"/>
- <text class="svg-text" x="60" y="169">floppy.img</text>
- <text class="svg-sub" x="60" y="189">CHS + ISA DMA</text>
- <rect class="svg-box green" x="345" y="142" width="230" height="62" rx="9"/>
- <text class="svg-text" x="365" y="169">ide0 / ide0pN</text>
- <text class="svg-sub" x="365" y="189">PIO, legacy or native BARs</text>
- <rect class="svg-box green" x="650" y="142" width="230" height="62" rx="9"/>
- <text class="svg-text" x="670" y="169">sata0 · mmc0 · usb0</text>
- <text class="svg-sub" x="670" y="189">AHCI · SDHCI · USB MSC</text>
- <path class="svg-line" d="M175 92v42"/>
- <path class="svg-line" d="M169 126l6 7 6-7"/>
- <path class="svg-line" d="M460 92v42"/>
- <path class="svg-line" d="M454 126l6 7 6-7"/>
- <path class="svg-line" d="M765 92v42"/>
- <path class="svg-line" d="M759 126l6 7 6-7"/>
- </svg>
- <figcaption>
- <strong>One narrow waist.</strong> Filesystems and tools only see
- <code>struct blk_dev</code>. The floppy still needs IRQ 6, but ATA,
- AHCI, SDHCI and USB MSC are polled; a FAT operation takes a
- non-preemptible section and <code>format_busy</code> keeps a
- destructive format/install exclusive. The installer clones the
- MBR and every used sector of the source image.
- </figcaption>
- </figure>
- <h3>Floppy</h3>
- <p>
- <span class="file">disk.c</span> drives the 8272-compatible FDC
- through ISA DMA channel 2, with the single-sector DMA buffer at
- <code>0x4000</code>. Retries handle the usual real-hardware flakiness.
- The second floppy slot can hold <code>root.img</code>.
- </p>
- <h3>PATA</h3>
- <p>
- <span class="file">ata.c</span> uses the legacy command block or the
- PCI IDE interface's native BARs. Multi-sector PIO waits for DRQ
- before every sector because drives drop it between sectors; it polls
- the command-block status rather than the alternate-status BAR, and
- falls back to single-sector commands when a bridge leaves DRQ pending.
- </p>
- <h3>SATA/AHCI</h3>
- <p>
- <span class="file">ahci.c</span> drives the first AHCI controller
- only, with no IRQs and no NCQ. It does COMRESET, IDENTIFY through the
- shared <code>ata_identify_parse()</code>, and READ/WRITE DMA EXT
- through a page-allocated bounce buffer. A disk added after boot needs
- a rescan; there is no COMRESET hotplug.
- </p>
- <h3>eMMC/SDHCI</h3>
- <p>
- <span class="file">sdhci.c</span> drives the Intel Braswell MMC
- function at PCI <code>00:10.0</code> (<code>8086:2294</code>, class
- <code>0805</code>), the HP Chromebook's eMMC. It resets the SDHCI
- host, selects the 1.8 V rail and Host Control 2's 1.8 V signalling,
- runs a 400 kHz initialization clock, then CMD0/1/2/3/7/16 and CMD8
- to read EXT_CSD (<code>SEC_COUNT</code> at 212,
- <code>CACHE_SIZE</code> at 249), and switches to a 25 MHz data clock.
- Sector I/O is CMD17/CMD24 through the polled PIO buffer port at
- 1-bit/25 MHz; there is no DMA, IRQ, bus-width/high-speed switch or
- hotplug. The read/write loops yield every 32 sectors so a long
- format does not starve the window manager. The eMMC appears as
- <code>mmc0</code>, and <code>format mmc0</code> writes an MBR + FAT
- partition exactly like an IDE/SATA disk. The write path flushes the
- card cache with CMD6 <code>FLUSH_CACHE</code> when EXT_CSD reports
- one.
- </p>
- </section>
- <section id="usb">
- <h2>USB stack</h2>
- <p>
- <span class="file">usb.c</span> is controller-agnostic. It handles
- enumeration, descriptor parsing, hub recursion, bus scans, per-controller
- addresses, the hotplug watcher and interrupt-IN consumers. Each host
- controller implements the <code>usb_hcd_ops</code> vtable in
- <span class="file">usb_hcd.h</span>.
- </p>
- <figure class="figure">
- <svg viewBox="0 0 920 300" role="img" aria-labelledby="usb-title usb-desc">
- <title id="usb-title">USB controller topology</title>
- <desc id="usb-desc">EHCI handles high-speed root ports, UHCI and OHCI handle low and full speed devices, xHCI handles USB2 and USB3 root ports. All feed the same USB core, which drives HID input and USB mass storage.</desc>
- <rect class="svg-box accent" x="30" y="24" width="200" height="64" rx="9"/>
- <text class="svg-text" x="50" y="50">EHCI</text>
- <text class="svg-sub" x="50" y="70">high-speed root ports</text>
- <rect class="svg-box blue" x="252" y="24" width="200" height="64" rx="9"/>
- <text class="svg-text" x="272" y="50">UHCI</text>
- <text class="svg-sub" x="272" y="70">full/low speed · 1 instance</text>
- <rect class="svg-box blue" x="474" y="24" width="200" height="64" rx="9"/>
- <text class="svg-text" x="494" y="50">OHCI</text>
- <text class="svg-sub" x="494" y="70">full/low speed · up to 4</text>
- <rect class="svg-box green" x="696" y="24" width="194" height="64" rx="9"/>
- <text class="svg-text" x="716" y="50">xHCI</text>
- <text class="svg-sub" x="716" y="70">USB2 + USB3 root ports</text>
- <path class="svg-line accent" d="M130 88v40h330v28"/>
- <path class="svg-line blue" d="M352 88v68"/>
- <path class="svg-line blue" d="M574 88v68"/>
- <path class="svg-line green" d="M793 88v40H460v28"/>
- <rect class="svg-box" x="300" y="156" width="320" height="58" rx="9"/>
- <text class="svg-text" x="320" y="181">usb core</text>
- <text class="svg-sub" x="320" y="201">enumeration · hubs · hotplug · interrupt-IN slots</text>
- <path class="svg-line" d="M460 214v34"/>
- <path class="svg-line" d="M454 240l6 7 6-7"/>
- <rect class="svg-box" x="300" y="248" width="320" height="50" rx="9"/>
- <text class="svg-text" x="320" y="266">usbhid · keyboard + mouse</text>
- <text class="svg-text" x="320" y="286">usbmsc · mass storage</text>
- </svg>
- <figcaption>
- <strong>Companions are not optional.</strong> EHCI is scanned first
- so its port resets can hand non-high-speed devices back to a
- companion. There is no transaction translator: a low/full-speed
- device behind a high-speed hub is invisible to EHCI.
- </figcaption>
- </figure>
- <div class="table-wrap">
- <table>
- <thead>
- <tr><th>Controller</th><th>Transport</th><th>Instances</th><th>Implementation notes</th></tr>
- </thead>
- <tbody>
- <tr><td>UHCI</td><td>PCI I/O ports</td><td>1</td><td>Frame list at <code>0x3000</code>; control QH plus one QH per interrupt slot.</td></tr>
- <tr><td>OHCI</td><td>PCI MMIO</td><td>up to 4</td><td>HCCA from the page allocator, static ED/TD sets, TDs start at <code>CC = NotAccessed</code>.</td></tr>
- <tr><td>EHCI</td><td>PCI MMIO</td><td>up to 4</td><td>Async QH/qTD schedule, page-allocated descriptors, polling only, no periodic list.</td></tr>
- <tr><td>xHCI</td><td>PCI MMIO</td><td>—</td><td>USB2 and USB3 root ports; direct SuperSpeed devices use a 512-byte EP0 and the port speed in the slot context (USB3 hubs are not decoded). Halts and waits for <code>HCH</code> around <code>HCRST</code>; EP0 max packet comes from the port speed; EP0 stages are encoded as one TD per stage (EDK2 style) because chained control TDs stall on Braswell.</td></tr>
- </tbody>
- </table>
- </div>
- <p>
- Hubs are class-9 devices: <code>usb.c</code> sets their configuration,
- powers every downstream port (honouring <code>bPwrOn2PwrGood</code>),
- resets and waits for <code>PORT_ENABLE</code>, then enumerates
- recursively. This is what makes the X201's internal PCH hubs work.
- Hotplug watches root ports; a device behind a hub is only found when a
- full scan runs (<code>lsusb</code> also bumps the USB generation so
- <code>usbhid</code> re-attaches).
- </p>
- <h3>Mass storage</h3>
- <p>
- <span class="file">usbmsc.c</span> is a device-level probe alongside
- the ASIX Ethernet driver. It claims an interface with class 8,
- subclass 6 and protocol 0x50, parses its bulk IN/OUT endpoints and
- identifies the disk with SCSI INQUIRY + READ CAPACITY. Commands use
- Bulk-Only Transport with LUN 0 and 512-byte blocks: READ(10),
- WRITE(10), SYNCHRONIZE CACHE and a BOT reset/endpoint-halt recovery.
- Short bulk-IN chunks are accumulated within a BOT data stage; a
- failed READ(10) gets REQUEST SENSE, retries and a 1-sector
- fallback. Present devices are registered as <code>usb0..</code>
- (<code>BLK_USB</code>) by <code>blk_scan()</code>, so
- <code>storage</code>, the VFS, <code>format</code> and
- <code>install</code> can use them.
- </p>
- <p>
- Bulk transfers exist on EHCI and xHCI only; a mass-storage device on
- a UHCI/OHCI companion is left unclaimed. The xHCI driver drives
- direct USB3 root-port devices (USB3 hubs are not decoded), so a
- SuperSpeed stick on the Chromebook works. This is what makes the
- installer's <code>usb0</code> source possible: it reads the whole
- live image into RAM first and then writes the target, so slow eMMC
- writes cannot leave the USB source idle between chunks.
- </p>
- </section>
- <section id="hid">
- <h2>Input</h2>
- <p>
- <span class="file">usbhid.c</span> gives every HID class-3 interface
- with an interrupt-IN endpoint one of the six USB interrupt slots. Boot
- interfaces (subclass 1, protocol 1/2) are used as-is; other class-3
- interfaces are classified by reading their HID report descriptor.
- Composite receivers and several devices can coexist; mouse reports
- from all slots are merged.
- </p>
- <ul>
- <li><strong>Mouse.</strong> Three-byte boot reports: buttons in <code>b0 & 7</code>, signed <code>dx/dy</code>. HID's +y is flipped to the PS/2 convention.</li>
- <li><strong>Keyboard.</strong> Eight-byte boot reports (modifier + six keycodes). Reports are diffed and decoded through a HID-usage → scancode-set-1 table, then injected with <code>io_inject_scancode()</code>.</li>
- <li><strong>Repeat.</strong> A boot keyboard only reports changes, so <code>io.c</code> adds software typematic repeat (500 ms delay, 33 ms rate).</li>
- <li><strong>PS/2.</strong> The i8042 path shares the cursor and keyboard code; the BIOS legacy USB emulation is disabled because the kernel owns the devices.</li>
- </ul>
- <p>
- <code>mouseinfo</code> shows the active backend and whether a USB
- keyboard is attached. Headless regression tests inject mouse motion
- and keys through QMP and verify the result with screen dumps.
- </p>
- <h3>I2C touchpad</h3>
- <p>
- The HP Chromebook 11 G5 EE has no PS/2 port: its Elan touchpad is a
- HID-over-I2C device on LPSS I2C6. The LPSS I2C functions are hidden
- from PCI in ACPI mode, so <span class="file">touchpad.c</span> scans
- the two firmware BAR windows for a DesignWare component and
- <span class="file">i2c.c</span> drives that controller in fast mode,
- polled and without interrupts.
- </p>
- <ul>
- <li><strong>Probe.</strong> Slave address <code>0x15</code>: reset
- (<code>0x0100</code>), consume the 2-byte acknowledgement, read the
- HID descriptor, select absolute mode (<code>0x0300 = 1</code>) and
- wake the device (<code>0x0800</code>). Resetting last leaves it
- silent until the next power cycle.</li>
- <li><strong>Reports.</strong> The Elan vendor report <code>0x5D</code>
- carries a finger bitmask and five bytes per active finger (X/Y high
- bits, X low, Y low, size, pressure). Finger 1 drives the pointer:
- successive absolute positions become PS/2 deltas, and the clickpad
- bit becomes the left button. The native max-X/Y commands
- (<code>0x0106</code>/<code>0x0107</code>) give the corner zone a
- physical coordinate frame.</li>
- <li><strong>Tap gestures.</strong> A short stationary contact is
- turned into a synthetic button press: two fingers is a right click,
- one finger starting in the bottom-right zone (right 25% x bottom
- 25% of the pad) is a right click, and one finger elsewhere is a
- left click. The press is held for 120 ms so applications polling
- <code>SYS_WIN_POINTER</code> sample it. Taps shorter than two 25 ms
- samples, longer than 300 ms, moved more than 60 coordinate units,
- or accompanied by a physical clickpad press are ignored.</li>
- <li><strong>Physical clickpad.</strong> The single clickpad button
- is latched at its leading edge: a press whose finger starts in the
- bottom-right zone reports the right button, anywhere else reports
- the left button, and the choice holds until the button is released
- (so a corner drag stays a right drag).</li>
- <li><strong>Polling.</strong> The report GPIO has no driver yet, so
- the input register is read every 25 ms. Back-to-back reads stall the
- device, which is why the poll is throttled rather than run flat
- out.</li>
- <li><strong>Discovery and tuning.</strong> <code>touchpad</code>
- prints the probe result, max coordinates, last report and synthesized
- click counters, and takes <code>rightclick off|tap|corner|both</code>
- or <code>tapclick on|off</code>; <code>mouseinfo</code> lists the
- Elan vendor/product ID next to the PS/2 and USB backends.</li>
- </ul>
- </section>
- <section id="serial">
- <h2>Serial</h2>
- <p>
- <span class="file">serial.c</span> drives the 16550 at COM1, 115200
- 8N1, with an IRQ-driven receive ring buffer. It is used for the boot
- trace, the netlog mirror source, the <code>dbg</code> monitor and the
- <code>KXE2</code> kexec receiver.
- </p>
- <p>
- The transmitter is polled, so a machine without a serial port still
- boots normally. <code>serial_puthex</code> and
- <code>serial_putdec</code> are the structured dump helpers used by
- drivers.
- </p>
- </section>
- <section id="sensors">
- <h2>Sensors, power & thermals</h2>
- <ul>
- <li><strong>DTS.</strong> <span class="file">thermal.c</span> reads <code>IA32_THERM_STATUS</code> on an allowlist of Core/Core 2, Nehalem/Westmere, Bonnell and Airmont/Braswell models. TjMax comes from <code>IA32_TEMPERATURE_TARGET</code> on Nehalem/Westmere; Airmont uses coretemp's 90 °C table (the kernel does not read the MSR before the IDT exists), and Bonnell uses the table.</li>
- <li><strong>IT87xx.</strong> <span class="file">it87.c</span> reads the Super I/O temperatures and fan tachometers on the ASUS AT3IONT-I. Nothing is written to fan control.</li>
- <li><strong>ThinkPad EC.</strong> <span class="file">tpec.c</span> is gated on an SMBIOS Lenovo/IBM match and reads temperatures and fan mode through the shared ACPI EC protocol in <span class="file">ec.c</span> (ports <code>0x62/0x66</code>, command <code>0x80</code> read / <code>0x81</code> write, OBF/IBF waits, stale-byte drain, bounded polls). Battery/AC state comes from <code>0x38/0x39</code> (present, charging, discharging), <code>0x46</code> bit 4 (AC online), and the page-selected 16-byte window at <code>0xA0..0xAF</code>; <code>0x81</code> selects the battery and page (0 dynamic, 1 mode, 2 design, 5 manufacturer, 6 model). That page selector is the only EC write, and it is restored when it changed.</li>
- <li><strong>Chrome EC.</strong> <span class="file">cros_ec.c</span> probes the Chrome OS EC, gated on the ACPI memory version, the <code>'E','C'</code> memmap id and the device feature bits; it skips the probe when the ThinkPad EC is present. Its ACPI window <code>0x20..0xFF</code> mirrors memmap <code>0x00..0xDF</code>: temperature sensors <code>0x00..0x0f</code>/<code>0x18..0x1f</code> (raw − 73 °C), fans <code>0x10..0x17</code> (<code>0xffff</code> absent), switches <code>0x30</code> (lid/power button), and the battery block <code>0x40..0x7f</code> (AC/present/charging flags at <code>0x4c</code>, voltage/rate/remaining/design/last-full/cycle count, and the 8-byte strings). <code>EC_ACPI_MEM_BATTERY_INDEX</code> <code>0x12</code> selects the battery and waits for <code>BATT_INDEX</code> <code>0x4e</code>; <code>EC_ACPI_MEM_STRINGS_FIFO</code> <code>0x16</code> returns longer strings when supported. The Cyan full-charge workaround is applied, and the units are mAh/mA. <span class="file">power_src.c</span> picks the ThinkPad backend first, then the Chrome EC; <code>SYS_CROS_EC_SENSORS</code> (107) exposes the EC temperature/fan/switch snapshot.</li>
- <li><strong>MTRRs.</strong> <span class="file">mtrr.c</span> manages write-combining ranges for the framebuffer and reports the effective mapping.</li>
- </ul>
- <p>
- <code>sensors</code> prints DTS values on the 90/100/125 °C scales,
- board sensors and both EC types; <code>powerinfo</code> prints the
- source (<code>thinkpad</code> or <code>chrome ec</code>), the AC
- adapter, battery model/manufacturer/serial, capacities, voltage,
- rate and cycle count through <code>SYS_POWER_INFO</code>;
- <code>power</code> prints ratios, effective MHz and C-state hints.
- The WM top bar shows the AC adapter state and the first present
- battery with a valid percentage next to the CPU temperature on
- both ThinkPads and Chromebooks; machines without an EC show neither.
- </p>
- </section>
- <section id="rtc">
- <h2>Wall clock (RTC)</h2>
- <p>
- <span class="file">rtc.c</span> talks to the MC146818-compatible
- CMOS clock through ports <code>0x70/0x71</code>. Reads honour the
- register-B BCD/binary and 12/24-hour modes, retry when the
- update-in-progress bit is set, and decode the hour's PM flag. The
- RTC only stores a two-digit year, so the kernel expands it over a
- 1970–2069 window (70–99 → 1900s, 00–69 → 2000s); a board whose
- dead battery left 1980 or 1990 therefore reads correctly instead of
- being pushed a century forward. Writes validate the calendar (leap
- years included), raise the register-B SET bit, preserve the mode
- bits and write the computed weekday. On ACPI machines the FADT
- century register (offset 108, normally CMOS <code>0x32</code>) is
- written as well, so the firmware and other operating systems see
- the intended century; boards without ACPI get no arbitrary NVRAM
- write.
- </p>
- <p>
- <code>SYS_RTC_GET</code>/<code>SYS_RTC_SET</code> (104/105) expose
- the full <code>struct sys_datetime</code>; the older
- <code>SYS_RTC_HMS</code>/<code>SYS_RTC_DATETIME</code> calls remain
- the small read-only views. The WM’s top-bar date/time is a click
- target that opens <code>bin/settime</code>; its <em>Sync NTP</em>
- button fetches UTC through <code>SYS_NTP_SYNC</code> (106), backed
- by the SNTP client in <span class="file">ntp.c</span>, and writes
- it with <code>SYS_RTC_SET</code>. The <code>date</code> command
- prints the same clock in the classic Linux format.
- </p>
- </section>
- <section id="panic">
- <h2>Panic screen</h2>
- <p>
- On a ring-0 fault, <span class="file">panic.c</span> draws straight
- into the framebuffer — bypassing the shadow buffer and the WM — and
- mirrors the same data to COM1 before halting. The banner includes the
- vector and error code, GPRs, control registers, current pid/name,
- uptime, instruction bytes and stack return-address candidates in the
- kernel image.
- </p>
- <p>
- Faults from ring 3 do not halt: the process is killed with a short
- message in its terminal and serial log. There is no interactive
- debugger on screen; the <code>dbg</code> kernel command drives a
- serial monitor instead.
- </p>
- </section>
- <section id="limits">
- <h2>Limits</h2>
- <ul>
- <li><strong>Polling.</strong> USB, storage and network drivers consume CPU time while waiting; there is no IRQ-driven data path outside PS/2, serial and the PIT.</li>
- <li><strong>EHCI.</strong> High-speed root ports only; no split transactions for low/full-speed devices behind a high-speed hub.</li>
- <li><strong>xHCI.</strong> USB2 and USB3 root ports; direct SuperSpeed devices work, but USB3 hub port-status decoding is not implemented.</li>
- <li><strong>HID.</strong> Report IDs are not handled, absolute pointers/tablets are ignored, and there is no wheel support.</li>
- <li><strong>AHCI.</strong> First controller only, no hotplug after boot, disks above 2 TB are clamped to 32-bit LBA.</li>
- <li><strong>eMMC.</strong> Polled 1-bit/25 MHz PIO; no DMA, IRQ, CMD6 bus-width/high-speed/DDR switch or hotplug. Only the eMMC function is driven; the SDIO/SD functions and SD card reader are not.</li>
- <li><strong>Storage serialization.</strong> A FAT/floppy operation sets <code>sys_fs_busy</code> and stalls process switching for its duration; the PIT keeps ticking.</li>
- <li><strong>EC.</strong> The Chrome EC path uses the ACPI v2 memmap only: no MEC host-command interface, EC SCI events, charger current/voltage, charging limit or EC firmware version. The ThinkPad H8 path is limited to its page-selected battery window and has no SCI handler. Battery/AC is polled by the WM once a second.</li>
- <li><strong>Suspend.</strong> There is no S0ix/suspend path; package C-states and the EC sleep handshake remain firmware-managed.</li>
- </ul>
- </section>
- <section id="sources">
- <h2>Source map</h2>
- <ul class="filelist">
- <li><code>pci.c</code>, <code>pci.h</code> — enumeration</li>
- <li><code>blkdev.c</code> — block registry</li>
- <li><code>sdhci.c</code>, <code>sdhci.h</code> — Intel Braswell eMMC</li>
- <li><code>disk.c</code> — floppy / DMA</li>
- <li><code>ata.c</code>, <code>ahci.c</code> — PATA/SATA</li>
- <li><code>usb.c</code>, <code>usb_hcd.h</code> — USB core</li>
- <li><code>uhci.c</code>, <code>ohci.c</code>, <code>ehci.c</code>, <code>xhci.c</code></li>
- <li><code>usbmsc.c</code>, <code>usbmsc.h</code> — USB BOT/SCSI mass storage</li>
- <li><code>install.c</code> — live-image clone installer</li>
- <li><code>usbhid.c</code>, <code>mouse.c</code>, <code>io.c</code> — input</li>
- <li><code>i2c.c</code>, <code>i2c.h</code> — DesignWare/LPSS I2C master</li>
- <li><code>touchpad.c</code>, <code>touchpad.h</code> — Elan HID-over-I2C touchpad</li>
- <li><code>serial.c</code>, <code>serial_ring_buf.c</code></li>
- <li><code>thermal.c</code>, <code>it87.c</code>, <code>tpec.c</code>, <code>ec.c</code>, <code>cros_ec.c</code>, <code>power_src.c</code>, <code>mtrr.c</code></li>
- <li><code>rtc.c</code> — CMOS wall clock read/write</li>
- <li><code>panic.c</code>, <code>timer.S</code> — fatal exceptions</li>
- </ul>
- </section>
- </main>
- <footer class="site-footer">
- <div class="inner">
- <p><strong>NebOS 0.2.0</strong> · Architecture documentation · <a href="index.html">overview</a></p>
- <p>Maintain alongside <code>AGENTS.md</code> and the source files listed on each page.</p>
- </div>
- </footer>
- </body>
- </html>
|