Files
bfe-core1106-sdk/README.md
NoahandClaude Sonnet 5.5 0360b8dc46
ci / test (push) Successful in 18s
ci / mcdc (push) Successful in 19s
ci / bench (push) Successful in 9s
ci / qemu-tools (push) Successful in 53s
ci / kernel-symbols (push) Successful in 1m25s
ci / patches-apply (push) Successful in 21s
ci / prune-artifacts (push) Skipped
ci / kernel-build (push) Skipped
ci / quality (push) Successful in 46s
ci / badges (push) Skipped
kernel: single M0 batch (cgroups, namespaces, PSI, raw table, nftables) with a symbol list and clock keep-alive
One kernel flash for everything later work needs (rebuild M0, d09 M0-2):

- warden_defconfig: cgroup v2 controllers (MEMCG, CGROUP_PIDS, CGROUP_SCHED,
  FAIR_GROUP_SCHED, CFS_BANDWIDTH), the byte-metering match symbols
  (XT_MATCH_CGROUP, XT_CONNMARK, XT_MARK, IP6_NF_MANGLE), IKCONFIG and
  IKCONFIG_PROC, XT_MATCH_OWNER, the raw tables and the CT target (the
  NOTRACK for flare-edge#537), NAMESPACES with its five sub-options
  (USER_NS stays closed at boot by a sysctl), PSI, and the nftables set
  (NF_TABLES, ip and ip6 families, NFT_CT, NFT_MASQ, NFT_NAT, NFT_LIMIT,
  NFT_SOCKET, NFT_REJECT). TIME_NS and RT_GROUP_SCHED are explicitly unset.
  HW_RANDOM_ROCKCHIP is built in as a probe for the hardware RNG.
- build/required-symbols.txt and probe-symbols.txt are the source of record;
  build-kernel.sh asserts both against the final .config instead of a
  hand-written list (olddefconfig drops an unknown or unsatisfied symbol
  without a word).
- WARDEN_CONFIG_ONLY=1 stops after that assertion (a seconds-long CI gate) and,
  like a full build, writes the final .config and its sha256 (CONFIG_OUT),
  the digest firmware images record as KCONFIG_SHA256.
- clk_core_mcu_rtc gets CLK_IGNORE_UNUSED like clk_core_mcu, in the patch and in
  the enablement source it documents, so 6.18 keeps the HPMCU mtime clock up.
- CI: a kernel-symbols job expands the real configuration and asserts the lists
  on every push; offline tests prove the assertion fires for every failure shape.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Cxh2piVufTWbzKTmUafTkk
2026-10-09 10:12:15 -06:00

5.8 KiB

bfe-core1106-sdk

ci Lines of code Tests Coverage Code quality

A modern, open development environment for the Luckfox Pico 86 Panel (Rockchip RV1106), replacing the vendor SDK, and honest about what runs on real silicon versus what is simulated.

Vendor SDK This repo
Kernel 5.10.160, twice-forked, frozen 6.18.46: a reviewable, subsystem-split patch series onto pristine upstream; full peripheral set (display, touch, wifi, audio, NPU, ...) hardware-verified on a bench panel
Build ~2 GB tree, absolute paths baked in, Kconfig options silently dropped one hermetic script: sha256-pinned source fetch, fail-closed patch apply and config fragments
Off-device testing none; every change means flashing a panel register-level hardware models (sim/) plus a QEMU device VM booting the real kernel, real daemons, and the real UI with display + touch
Config safety memory-map mistakes reach hardware (one bricked a bench unit) static gates (tools/config-lint) catch them before any flash
CI none hosted pipeline: tests, coverage, benchmarks, patch-apply gate, kernel build with an in-CI QEMU boot smoke
Flashing tools closed (upgrade_tool) open (rkdeveloptool)
License mixed GPL-2.0-only, with a per-driver provenance ledger

Quick Start

Requirements: gcc-arm-linux-gnueabihf, qemu-system-arm, curl, cpio, mkfs.ext4, a bare python on PATH (Debian/Ubuntu: python-is-python3), gcc >= 14 (driver harnesses), and Rust (for the simulators' tests).

# 1. Build the kernel: fetch pinned pristine 6.18.46, apply patches/, emit
#    zImage + rv1106-warden.dtb. WORK must sit outside any git checkout.
WORK=$HOME/kbuild-out CROSS_COMPILE=arm-linux-gnueabihf- bash build/build-kernel.sh

# 2. Boot it in the QEMU device simulator (no hardware needed):
bash qemu/mkinitramfs.sh
bash qemu/mkimage.sh
bash qemu/run.sh --kernel $HOME/kbuild-out/linux-6.18.46/arch/arm/boot/zImage --shell

# 3. Run the test suites:
for d in sim tools/config-lint qemu/rs485-bridge; do
  (cd "$d" && cargo test)
done
for d in drivers/*/test; do make -C "$d" check; done  # driver harnesses (gcc >= 14)

Add WARDEN_KCONFIG_FRAGMENT=qemu/configs/virt.fragment to step 1 for the kernel variant with the simulator's extra devices; qemu/README.md has the scenario tests (portal, OTA apply, display + touch, watchdog).

Every kernel symbol the platform needs is listed in build/required-symbols.txt (and build/probe-symbols.txt for a symbol under test). build-kernel.sh asserts both against the final .config, because olddefconfig drops an unknown or unsatisfied symbol without a word. WARDEN_CONFIG_ONLY=1 CONFIG_OUT=<file> stops after that assertion, so the gate takes seconds; <file>.sha256 holds the digest of the final .config that firmware images record as KCONFIG_SHA256.

Layout

Directory Contents
patches/ the RV1106 forward-port onto pristine linux-6.18.46, subsystem-split
luckfox-sdk-patches/ the delta against the legacy vendor Luckfox SDK (U-Boot 2017.09, optionally the vendor 5.10.160 kernel, wifi driver, board build, buildroot) -- moved from blueflare/flare-edge's sdk-patches/ on 2026-09-15; unrelated to patches/ above
build/ hermetic kernel build: pinned fetch -> apply patches -> zImage + dtb; vendor.manifest pins the third-party trees this platform builds against (LVGL, the vendor RV1106 SDK) to exact commits, and fetch-vendor.sh obtains and verifies them
qemu/ device simulator: QEMU -M virt boots the real kernel and real userspace
sim/ register-level hardware models (Rust): membus, HPMCU, CRU, Modbus, RGA, NPU
drivers/ hardened hardware-facing drivers: HAL seams, test harnesses
kernel/ forward-port provenance and bring-up records (patches/ is canonical)
tools/ config-lint (static memory-map gates) and dev tooling
docs/ architecture, ADRs (decisions/), CI/CD

Architecture

One thin hardware abstraction seam per block (a trait in Rust, a function table in C): firmware logic talks to the seam; the seam binds a real backend on the device or a simulated backend on the host. The driver test harnesses measure against the same seam the simulator implements, so the two reinforce each other. Full detail: docs/architecture.md.

Simulator Runs Proves
sim/ register-level Rust models driver and supervisor logic, with fault injection
qemu/ the real kernel + userspace on -M virt boot, init, daemons, networking, OTA, watchdog, display + touch
lvglsim (downstream) the LVGL UI on SDL rendering and UI flows

With the production UI binary in qemu/payload/, run.sh --display on opens the panel's 720x720 screen in a window, mouse clicks landing as touch: device and UI in one VM. Emulation results are never on-silicon evidence; the simulators narrow which claims need a panel.

Principles

  • Open: open tools over closed ones; GPL-2.0-only.
  • Hard: every seam has a fault-injection path; recovery code is tested against failure, not just success.
  • Modern: the newest kernel the hardware can run, current toolchains, Rust for new host-testable code, reproducible builds.

License

GPL-2.0-only, repo-wide (LICENSE; a per-file SPDX identifier governs where present). patches/ and kernel/ are derivative of the Linux kernel and GPL-2.0 vendor code; per-driver origin is tracked in kernel/rv1106-enablement/PROVENANCE.md. Contributions are accepted under the same license (inbound = outbound).