docs: ASCII typography and style normalization across all repo text
Replace every em dash with real punctuation (rewrites, not hyphen swaps) in docs, code comments, scripts, configs, and the port records; convert en dashes, curly quotes, ellipsis glyphs, arrows, and section signs to ASCII; drop machine-writing tell phrases from living docs. ADR titles now use a colon. The M2 bring-up DTS model string carried an em dash into the patch series and its record echoes; fixed at both, and the full series re-verified to apply cleanly onto pristine 6.18.46. One comment in freshness.h deliberately names the em dash glyph the UI renders as the unknown mark; that is data, kept as prose naming it. Verified: cargo tests (sim, config-lint, rs485-bridge), shellcheck, both driver MC/DC harnesses, patches-apply.
This commit is contained in:
BFE Engineering
@@ -1,6 +1,6 @@
|
||||
# RV1106 → 6.18 forward-port — live status
|
||||
# RV1106 -> 6.18 forward-port: live status
|
||||
|
||||
> **CANONICAL SOURCE.** This directory is a point-in-time **port-provenance layer** —
|
||||
> **CANONICAL SOURCE.** This directory is a point-in-time **port-provenance layer**:
|
||||
> what was ported, the milestones, verification evidence, and standalone test programs
|
||||
> (e.g. `npu/rknpu_version_test.c`). It is **not** the source of truth for the kernel
|
||||
> delta. The canonical, current delta is **`../../patches/*.patch`** (applied by
|
||||
@@ -8,125 +8,125 @@
|
||||
> `flare-edge/research/linux-6.18.46/`. The `.c`/`.dts`/`.frag` snapshots here are
|
||||
> historical port evidence and may **lag** the final series (e.g. `clk/clk-rv1106.c`
|
||||
> predates the last HPMCU-clock `CLK_IGNORE_UNUSED` fix that is in `patches/10-clk-rv1106.patch`).
|
||||
> Do not hand-edit them or treat them as current — change kernel behaviour in `patches/`.
|
||||
> Do not hand-edit them or treat them as current: change kernel behaviour in `patches/`.
|
||||
|
||||
Target: **Linux 6.18.46** (vanilla, `flare-edge/research/linux-6.18.46/`), forward-ported
|
||||
from the **vendor 5.10.160** tree, no plan44 code, built with our
|
||||
`arm-rockchip830-...-gcc 8.3` (confirmed: **gcc 8.3 builds 6.18 fine**).
|
||||
|
||||
## Confirmed feasibility facts
|
||||
- gcc 8.3 (our SDK toolchain) compiles the 6.18 kernel — no toolchain bump needed to start.
|
||||
- gcc 8.3 (our SDK toolchain) compiles the 6.18 kernel: no toolchain bump needed to start.
|
||||
- `multi_v7_defconfig` (ARM + rockchip) configures; `CLK_RV1106=y` wires in cleanly.
|
||||
- rv1106's siblings **rv1126/rv1108 exist in both trees**, so their 5.10→6.18 delta is a
|
||||
- rv1106's siblings **rv1126/rv1108 exist in both trees**, so their 5.10->6.18 delta is a
|
||||
working template for the framework API changes.
|
||||
|
||||
## M1 — clock driver (`clk-rv1106.c`, 1294 lines): [x] COMPILES CLEAN on 6.18
|
||||
Build-fix loop against 6.18 — `clk-rv1106.o` (85732 bytes) builds with no errors.
|
||||
## M1, clock driver (`clk-rv1106.c`, 1294 lines): [x] COMPILES CLEAN on 6.18
|
||||
Build-fix loop against 6.18: `clk-rv1106.o` (85732 bytes) builds with no errors.
|
||||
Fixed (captured in `clk/`):
|
||||
1. **Kconfig + Makefile hooks** — added `CONFIG_CLK_RV1106` (mirrors CLK_RV1126).
|
||||
2. **CRU register macros** — ported all 55 `RV1106_*` register-accessor `#define`s from the
|
||||
1. **Kconfig + Makefile hooks**: added `CONFIG_CLK_RV1106` (mirrors CLK_RV1126).
|
||||
2. **CRU register macros**: ported all 55 `RV1106_*` register-accessor `#define`s from the
|
||||
vendor `clk.h` into 6.18's `clk.h` (mainline has none).
|
||||
3. **Header split** — `panic_notifier_list` moved to `<linux/panic_notifier.h>` (kernel
|
||||
3. **Header split**: `panic_notifier_list` moved to `<linux/panic_notifier.h>` (kernel
|
||||
5.18); added the include.
|
||||
4. **`rockchip_clk_register_armclk` signature change** — 5.10 took
|
||||
4. **`rockchip_clk_register_armclk` signature change**: 5.10 took
|
||||
`(num_parents, parent_clk, alt_parent_clk)`; 6.18 takes `(parent_names[], num_parents)`
|
||||
and drives the mux from `reg_data.mux_core_main/alt`. Adapted the call to the 6.18 form
|
||||
using a parent-names array (sibling-delta from rv1126). **PORT-VERIFY**: the mux input
|
||||
list `{ "gpll","cpll","apll" }` and the `mux_core_main/alt=2` mapping are a best-effort
|
||||
from the 5.10 intent (main=apll) — they set the **CPU clock source**, so they must be
|
||||
from the 5.10 intent (main=apll); they set the **CPU clock source**, so they must be
|
||||
checked against the RV1106 `CORECLKSEL_CON` register map (TRM) and validated on hardware
|
||||
before trusting a boot. A wrong mux silently breaks boot.
|
||||
|
||||
5. **`CLK_FRAC_DIVIDER_NO_LIMIT`** — Rockchip downstream-only frac-divider flag (6 uses on
|
||||
5. **`CLK_FRAC_DIVIDER_NO_LIMIT`**: Rockchip downstream-only frac-divider flag (6 uses on
|
||||
the UART frac clocks); mainline has no min/max opt-out, mapped to 0 (default limit).
|
||||
**PORT-VERIFY**: UART fractional baud accuracy.
|
||||
|
||||
## M1 — pinctrl (`pinctrl-rockchip.c/.h`): [x] COMPILES CLEAN on 6.18
|
||||
## M1, pinctrl (`pinctrl-rockchip.c/.h`): [x] COMPILES CLEAN on 6.18
|
||||
`pinctrl-rockchip.o` (173688 bytes) builds no-errors. Transplanted from vendor 5.10 (effort S,
|
||||
zero API drift — the survey's assessment held): added `RV1106` to the type enum; a 159-line
|
||||
zero API drift, the survey's assessment held): added `RV1106` to the type enum; a 159-line
|
||||
block of `RV1106_DRV/PULL/SMT_*` macros + 3 `rv1106_calc_*_reg_and_bit()` functions; `case
|
||||
RV1106:` in the 3 pull functions + the RK3568 drive-strength group; `rv1106_pin_banks[]` +
|
||||
`rv1106_pin_ctrl`; and the `rockchip,rv1106-pinctrl` of_device_id (dropping the vendor's
|
||||
`#ifdef CONFIG_CPU_RV1106` guard — mainline compiles all SoCs unconditionally). Captured as
|
||||
`#ifdef CONFIG_CPU_RV1106` guard: mainline compiles all SoCs unconditionally). Captured as
|
||||
`pinctrl/0001-rv1106-pinctrl.patch`.
|
||||
- **PORT-VERIFY RESOLVED (iomux offsets):** the DRV/PULL/SMT per-bank offsets are confirmed by
|
||||
a THIRD independent source — the upstream Simon Glass v3 pinctrl patch. Its
|
||||
a THIRD independent source: the upstream Simon Glass v3 pinctrl patch. Its
|
||||
`rv1106_{drv,pull,smt}_offsets[]` match ours exactly once the 0x10000-strided per-bank IOC
|
||||
base is applied (e.g. vendor GPIO2 DRV `0x100C0` = `0x10000 + 0xc0`). Retires the "do not
|
||||
guess" iomux risk without hardware. (Note upstream uses per-bank IOC regmaps + low offsets;
|
||||
we use the vendor's full-offset form — same absolute register, both compile.)
|
||||
- **Still PORT-VERIFY:** GPIO4 bank pin-count (`pin_banks` says 24, DT `gpio-ranges` says 32) —
|
||||
we use the vendor's full-offset form: same absolute register, both compile.)
|
||||
- **Still PORT-VERIFY:** GPIO4 bank pin-count (`pin_banks` says 24, DT `gpio-ranges` says 32),
|
||||
carried from vendor unchanged; needs TRM/hardware.
|
||||
|
||||
## M1 — mach: DONE
|
||||
## M1, mach: DONE
|
||||
`mach-rockchip` RV1106/RV1103 SoC recognition added as a DT-compat entry (no
|
||||
`CPU_RV1106` symbol recreated). Captured as `mach/0001-rv1106-soc-recognition.patch`.
|
||||
**M1 is complete: clk + pinctrl + mach all compile clean on 6.18.**
|
||||
|
||||
## M2 — earlycon build: DONE (boot pending hardware)
|
||||
## M2, earlycon build: DONE (boot pending hardware)
|
||||
The first full kernel build with our SoC drivers, 2026-08-24:
|
||||
- **`multi_v7_defconfig` + `configs/m2-earlycon.fragment` builds an 11.8 MB zImage**
|
||||
with `clk-rv1106.o` (85732 B) and `pinctrl-rockchip.o` (173688 B, our rv1106 data)
|
||||
compiled *into the full tree* — no rv1106 warnings/errors. Reproducible via
|
||||
compiled *into the full tree*: no rv1106 warnings/errors. Reproducible via
|
||||
`build-m2.sh`.
|
||||
- **`dts/rv1106-warden-m2.dts` → `rv1106-warden-m2.dtb` compiles clean** (W=1, no dtc
|
||||
warnings). A deliberately minimal DT — CPU (cortex-a7), GIC-400, arch timer, 256 MiB
|
||||
RAM, GRF, the CRU (our clk-rv1106), and uart2 (`snps,dw-apb-uart`, the console) —
|
||||
- **`dts/rv1106-warden-m2.dts` -> `rv1106-warden-m2.dtb` compiles clean** (W=1, no dtc
|
||||
warnings). A deliberately minimal DT: CPU (cortex-a7), GIC-400, arch timer, 256 MiB
|
||||
RAM, GRF, the CRU (our clk-rv1106), and uart2 (`snps,dw-apb-uart`, the console),
|
||||
with `earlycon=uart8250,mmio32,0xff4c0000` so the first print reuses the loader's
|
||||
divisor before any clock/pinctrl probe.
|
||||
|
||||
**Still PORT-VERIFY before a boot is trusted:** memory size/base (256 MiB @ 0x0 assumed
|
||||
— the loader usually patches this); the CPU clock mux in clk-rv1106 (§M1 item 4); the
|
||||
**Still PORT-VERIFY before a boot is trusted:** memory size/base (256 MiB @ 0x0 assumed,
|
||||
the loader usually patches this); the CPU clock mux in clk-rv1106 (section M1 item 4); the
|
||||
console baud (1.5M assumed). A wrong DDR/clock value silently hangs before or just after
|
||||
earlycon.
|
||||
|
||||
## M2 — boot: DONE — "it's alive" on warden-c8a3 (2026-08-24)
|
||||
## M2, boot: DONE: "it's alive" on warden-c8a3 (2026-08-24)
|
||||
The self-built **Linux 6.18.46 boots on real RV1106 hardware**, through our ported
|
||||
drivers, verified over the serial console. It reaches earlycon, the arch timer
|
||||
(BogoMIPS calibrated), **our `clk-rv1106` CRU driver**, pinctrl, and the mainline
|
||||
8250 bound to uart2 **clocked by our CRU** (`ttyS2 … 16550A`), then hands off to the
|
||||
8250 bound to uart2 **clocked by our CRU** (`ttyS2 ... 16550A`), then hands off to the
|
||||
real console and mounts a rootfs. See `../docs/m2-boot-on-c8a3.md` for the method
|
||||
(the A/B `_b`-slot safe-test framework worked first try) and the boot-image format
|
||||
(external-data FIT + resource, `mkimage -E -p 0x800`).
|
||||
|
||||
Three bring-up bugs were found and fixed on hardware, all captured in the DT:
|
||||
1. **boot.img format** — rockchip U-Boot needs the external-data FIT + a `resource`
|
||||
1. **boot.img format**: rockchip U-Boot needs the external-data FIT + a `resource`
|
||||
(multi) sub-image with `rk-kernel.dtb`, else `No fit blob` / `Failed to load DTB`.
|
||||
2. **DTB overrun** — the bloated multi_v7 zImage decompresses to ~20 MiB and overran
|
||||
2. **DTB overrun**: the bloated multi_v7 zImage decompresses to ~20 MiB and overran
|
||||
the DTB at 0xc00000, so the kernel got `r2=0` (`invalid dtb`). Fix: place the fdt
|
||||
high (`load=0x08000000`). A lean RV1106 defconfig would also fix this and is the
|
||||
right long-term move.
|
||||
3. **grf-cru NULL deref** — `clk-rv1106` registers a second branch set against a GRF
|
||||
3. **grf-cru NULL deref**: `clk-rv1106` registers a second branch set against a GRF
|
||||
clock-controller (`grf_ctx`), set only by a `rockchip,rv1106-grf-cru` node. The
|
||||
minimal DT omitted it → `grf_ctx` NULL → panic in `rockchip_clk_register_branches`.
|
||||
minimal DT omitted it -> `grf_ctx` NULL -> panic in `rockchip_clk_register_branches`.
|
||||
Fix: add the `grf-clock-controller` child to the grf syscon.
|
||||
|
||||
**clk-rv1106 PORT-VERIFY (armclk mux, PLL rates) is now partially retired**: the CRU
|
||||
comes up far enough to clock the UART and the arch timer on hardware. A wrong CPU
|
||||
mux/PLL would show later (cpufreq / peripheral rates), still to be checked.
|
||||
|
||||
## M3 — rootfs boot: DONE — the full WardenOS runs on the 6.18 kernel (2026-08-24)
|
||||
Adding the eMMC (`dw_mmc`) node to the DT was all M3 needed — the drivers are already
|
||||
## M3, rootfs boot: DONE: the full WardenOS runs on the 6.18 kernel (2026-08-24)
|
||||
Adding the eMMC (`dw_mmc`) node to the DT was all M3 needed: the drivers are already
|
||||
in the config. On hardware:
|
||||
```
|
||||
dwmmc_rockchip ffa90000.mmc: Version ID is 270a ← our dw_mmc bound
|
||||
mmc0: new HS200 MMC card ... mmcblk0: 8GTF4R 7.28 GiB ← eMMC at HS200 (198 MHz)
|
||||
mmcblk0: p1(env)...p10(rootfs_b)...p12(userdata) ← partitions enumerated
|
||||
EXT4-fs (mmcblk0p10): mounted ... VFS: Mounted root ← ext4 rootfs mounted
|
||||
dwmmc_rockchip ffa90000.mmc: Version ID is 270a <- our dw_mmc bound
|
||||
mmc0: new HS200 MMC card ... mmcblk0: 8GTF4R 7.28 GiB <- eMMC at HS200 (198 MHz)
|
||||
mmcblk0: p1(env)...p10(rootfs_b)...p12(userdata) <- partitions enumerated
|
||||
EXT4-fs (mmcblk0p10): mounted ... VFS: Mounted root <- ext4 rootfs mounted
|
||||
Run /sbin/init as init process
|
||||
Starting warden-modbus / -mikrotik / -asic / -flared / Warden UI
|
||||
```
|
||||
A root shell over the serial console confirms it: `uname -a` → **`Linux warden-c8a3
|
||||
A root shell over the serial console confirms it: `uname -a` -> **`Linux warden-c8a3
|
||||
6.18.46 armv7l`**, with `warden-flared`, `warden-modbus`, `warden-mikrotik`,
|
||||
`warden-asic`, `warden-ui`, `warden-flight` all in `ps`. The eMMC node's ciu-drive/
|
||||
ciu-sample clocks come from `grf_cru`, so the M2 grf-cru fix was a prerequisite.
|
||||
|
||||
The expected M4/M5 gaps show as clean failures: the out-of-tree 5.10 `aic8800`
|
||||
wifi/BT `.ko` won't load on 6.18 (vermagic — needs the driver ported, **M5**), and
|
||||
`warden-ui: no backlight device` (no display/VOP node yet — **M4**).
|
||||
wifi/BT `.ko` won't load on 6.18 (vermagic, needs the driver ported, **M5**), and
|
||||
`warden-ui: no backlight device` (no display/VOP node yet, **M4**).
|
||||
|
||||
## M4/M5/M6 — NEXT
|
||||
- **M4 display**: VOP2 + the RGB666 720×720 panel + GT911 touch + PWM backlight →
|
||||
## M4/M5/M6: NEXT
|
||||
- **M4 display**: VOP2 + the RGB666 720x720 panel + GT911 touch + PWM backlight ->
|
||||
the LVGL UI renders (the UI process already runs, it just has no framebuffer).
|
||||
- **M5 wifi**: port the AIC8800 SDIO driver to 6.18 (+ the Tier-1 fix) so wlan0/usb0
|
||||
come back; re-apply our 4 kernel patches.
|
||||
@@ -137,16 +137,16 @@ wifi/BT `.ko` won't load on 6.18 (vermagic — needs the driver ported, **M5**),
|
||||
|
||||
## Upstream tracking (decision 2026-08-23)
|
||||
Base stays the vendor forward-port (applies to 6.18; we control it). The unmerged upstream
|
||||
RV1106 series (~35 patches, "New" state, does NOT apply cleanly to 6.18 — pinctrl v3 failed at
|
||||
RV1106 series (~35 patches, "New" state, does NOT apply cleanly to 6.18, pinctrl v3 failed at
|
||||
`pinctrl-rockchip.c:3390`) is used as a **correctness oracle** for boot-critical PORT-VERIFY
|
||||
values (already retired the iomux offsets) and tracked for eventual convergence when it merges.
|
||||
|
||||
## Honest scope
|
||||
This is the first driver of ~120 in the RV1106 BSP. The clk port alone is a multi-cycle
|
||||
effort of the four delta classes above; the whole bring-up (M1–M6 in `../docs/bringup.md`)
|
||||
effort of the four delta classes above; the whole bring-up (M1-M6 in `../docs/bringup.md`)
|
||||
is a multi-month kernel effort. Progress is real and the method is proven; correctness of
|
||||
boot-critical pieces (clock mux, PLL rates, DDR, pinctrl iomux) requires the TRM and
|
||||
on-hardware validation — which waits on c8a3's recovery and, ultimately, careful bring-up.
|
||||
on-hardware validation: which waits on c8a3's recovery and, ultimately, careful bring-up.
|
||||
|
||||
## Layout
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user