| Filename | Latest commit message | Latest commit date |
|---|---|---|
4a723cfc0e
The laptop's NIC is an RTL8111H, and the request was to add it to LDLS.
Measuring it is what changed the answer, so the measurement is the commit
message: r8169.ko (6.18.52) has **183 undefined symbols, 130 of them not
implemented by ldls/kpi/, and 35 of those 130 are phylib** --
phy_connect_direct, phy_start, mdiobus_read, genphy_soft_reset and the rest.
phylib is a subsystem with a link state machine, not a set of leaf calls, and
LDLS's usual answer for an unimplemented symbol -- a stub that reports itself
and returns zero -- is exactly wrong for it. phy_start returning zero means the
link never comes up and there is nothing to look at. The 8139too that ldls.md
uses as its model has no phylib dependency, which is why that one was
tractable and this one is not.
So: a native driver. It reaches the PHY through the chip's own MII window --
PHYAR is one register that is a whole MII bus -- and skips the subsystem. Less
work than the port, no GPL entanglement, no firmware blob, no coupling to one
Linux version, and it covers the whole RTL8111/8168 family because all of it
answers to 10EC:8168. The register layout is a fact about the hardware, taken
the way ldls.md section 3 says facts may be taken; the expression is this
tree's, in the same shape as the e1000 beside it.
**It has not run on hardware, and that is not a hedge.** QEMU emulates rtl8139
and nothing else from Realtek, and the 8139 is a different programming model --
a circular receive buffer rather than descriptors -- so it is deliberately not
in the match table. What is verified: it builds, its presence changes nothing
on a machine without the device, and with an rtl8139 on the bus it correctly
leaves it unclaimed. What is not: every register write, on a real part.
The probe therefore says everything a first bug report needs, with cprintf
rather than kinfo so it reaches the screen of a machine with no serial port:
r8169: xid 5c0, 1c:1b:b5:xx:xx:xx, irq 11, link up (bmsr 796d)
xid is the hardware version from the top of TxConfig -- the PCI device id has
been 8168 for twenty years and says nothing. bmsr is MII register 1: bit 2 is
link, bit 5 is autonegotiation complete. Those four facts separate "the chip is
not there" from "the PHY sees nothing" from "the rings are wrong".
Two constants were wrong in the first draft and are recorded because both would
have worked quietly. RxConfig had 0x7700 for "unlimited": MXDMA is bits 8-10
and RXFTH is bits 13-15, so that was one bit short of a full burst and a
half-full FIFO threshold. And CPCR bit 3 was being set under a comment calling
it "PCI multiple read/write" -- bit 3 is PCIDAC, 64-bit addressing, and bit 4
is what the comment described; neither is wanted, so the write is gone.
Both supported configurations: one boot each, no traps, no panics, socktest and
memfdtest green.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
||
| .. | ||
| architecture | ||
| branding | ||
| guides | ||
| history | ||
| niveus | ||
| plan | ||
| Website | ||
| licensing.md | ||
| README.md | ||
SchOS documentation
Four kinds of document, kept in four directories, because they answer four different questions and go stale at four different rates.
| architecture/ | What SchOS is | Present tense. Describes what is built and working. |
| plan/ | What SchOS will be | Future tense. Everything here is unbuilt. |
| guides/ | How to work on it | Imperative. Build it, test it, add to it. |
| history/ | Why it is the way it is | Past tense. Bugs whose cause is not visible from the fix. |
Plus two that belong to no category and apply to everything: licensing.md — read it before copying anyone else's code in — and branding/, which holds the marks and the rules for using them.
The rule that keeps this from rotting
When something is finished, it moves from
plan/toarchitecture/and is rewritten as a description of the thing rather than a record of building it.
A completed item is not a ticked checkbox. A ticked checkbox says the work happened; it does not say what the work produced, and six months later the checkbox is the only thing left and it explains nothing.
So finishing a piece of work has three steps, and the third is not optional:
- The code works and is tested.
- The plan entry is deleted.
- A description exists in
architecture/written for somebody who was not there — what it does, what shape it has, what it costs, and what it still does not do.
This is not bookkeeping. The tree has already proved it necessary: the network stack was finished, verified end to end, and for a month afterwards the only description of it anywhere was a checkbox in a roadmap, four levels of indentation deep, written in the past tense of somebody arguing for the work rather than explaining the result.
The "what it does not do" section is the one that pays. Every description in
architecture/ ends with one. A document that only lists a subsystem's
strengths is marketing, and the reader who most needs the document is the one
about to trip over a limitation nobody wrote down.
Start here
New to the tree → architecture/README.md, the system layer by layer, then guides/layout.md for where the files are.
Trying to build it → guides/building.md.
Wondering what happens next → plan/1.0.md, which is the finish line and the register of everything half-built. Then plan/README.md for the order.
About to start something new → the register, first. Nothing new starts while it has rows in it, and a row leaves only by being finished or deleted.
Something is broken and it feels familiar → history/. There is a good chance it is in there.
architecture/ — what SchOS is
| README | The system, layer by layer. Read first. |
| boot.md | Firmware to the first userspace process. |
| kernel.md | SchIFT: memory, processes, scheduling, traps, signals, SMP. |
| syscalls.md | The call table, and the Linux personality that lets real software run. |
| filesystem.md | The VFS, the buffer cache, procfs, mounts. |
| schfs.md | SchFS: the copy-on-write root filesystem. |
| devices.md | The device model, driver binding, the class vtables. |
| usb.md | xHCI, the USB core, and the class drivers. |
| graphics.md | Framebuffer, text rendering, console, and the crash screen. |
| terminals.md | The six virtual terminals, and how one is switched to. |
| networking.md | Drivers, lwIP, sockets — Unix and INET. |
| init.md | schinit, PID 1 as a role, and the job manifests. |
plan/ — what SchOS will be
| README | The three current decisions and the order they happen in. |
| 1.0.md | The finish line, and the freeze. What 1.0 contains, what is deferred, and the register of every half-built thing in the tree. |
| foundations.md | The kernel work everything else is blocked on. |
| wayland.md | The GUI stack, and what gets deleted to make room. |
| hybrid.md | Moving drivers out of the kernel. |
| schapi.md | The long-term API layering, and the compatibility promise. |
| roadmap.md | Everything else still open. |
guides/ — how to work on it
| building.md | Prerequisites and the build, per host. |
| testing.md | The harnesses, and what each one actually proves. |
| layout.md | Repository map, and how to add a program or a port. |
| adding-a-driver.md | Writing one, binding it, publishing its class vtable. |
branding/ — the marks
| README | Shift, the one mark: what it is for, the colour rule, why an icon and a mascot were removed, and why a raster is committed next to its SVG. |
history/ — why it is the way it is
| README | What belongs in here and what does not. |
| kernel.md | Bugs whose cause was nowhere near their symptom. |
| schfs.md | The filesystem's own, from the same period as its design. |
| moving-to-linux.md | The Windows-to-Fedora move, kept for the parts that recur. |
Writing one of these
Four conventions, all of them observable in the existing files:
State the cost. Every design choice gave something up. A document that does not say what is a document that will be argued with later by somebody who only sees the downside.
Prefer the measured number to the remembered one. "500 of 3565 files carry the advertising clause" is worth more than "some do", and it was worth the minute it took to count.
Write down the bug that shaped it. Half the non-obvious code in this tree is non-obvious because something failed once. If a design is strange, the strangeness is load-bearing and the reader deserves to know why before changing it.
No dates in headings. A date in a heading turns a description into a
changelog, and the description is the thing with a long life. Dates belong in
history/, where they mean something.