Refresh project documentation

Red Bear OS Team
2026-04-16 12:46:07 +01:00
parent aeac5a6d92
commit 90fa45c545
32 changed files with 1659 additions and 167 deletions
@@ -46,6 +46,76 @@ Red Bear ships a Redox-native `netctl` compatibility command in `redbear-netctl`
 - `Gateway='a.b.c.d'`
 - `DNS=('a.b.c.d')`

+### Current Wi-Fi-facing extension
+
+`redbear-netctl` now also has a bounded Wi-Fi profile layer intended for future native wireless
+bring-up.
+
+Current Wi-Fi-facing fields:
+
+- `Interface=wlan0` (or another future wireless interface name)
+- `Connection=wifi`
+- `SSID='...'`
+- `Security=open|wpa2-psk`
+- `Key='...'` / `Passphrase='...'`
+
+Current boundary:
+
+- `redbear-netctl` can parse and start these profiles
+- it writes Wi-Fi intent and credentials into the in-tree `/scheme/wifictl` control surface
+- it reuses the native `netcfg`/`dhcpd` handoff only after association
+- it is **not** the supplicant and does not currently implement scan/auth/association itself
+
+Current orchestration order for Intel Wi‑Fi profiles:
+
+- `prepare`
+- `init-transport`
+- `activate-nic`
+- `connect`
+
+Current orchestration order for `netctl scan` on Intel Wi‑Fi profiles:
+
+- `prepare`
+- `init-transport`
+- `activate-nic`
+- `scan`
+
+The current Intel backend will not attempt `scan` or `connect` until transport initialization has
+been attempted.
+
+The current user-facing Wi‑Fi subcommands are:
+
+- `netctl scan <profile|iface>`
+- `netctl status <profile>` with Wi‑Fi status, link state, firmware status, transport status, transport-init status, activation status, and last error
+
+The current `redbear-wifictl` daemon provides:
+
+- a bounded stub backend for end-to-end profile/control validation
+- an Intel-oriented backend boundary that detects Intel wireless-class PCI devices
+- firmware-family and firmware-presence reporting for the Intel target boundary
+- a bounded `prepare` step before connect
+- transport-readiness reporting for the detected Intel device
+- a bounded `scan` action and per-interface `scan-results`
+- a bounded PCI transport-prep action before connect
+- a bounded `init-transport` state after preparation and before connect
+- a bounded `activate-nic` state after transport initialization and before connect/scan
+- per-interface Wi-Fi state files under `/scheme/wifictl/ifaces/<iface>/...`
+
+Below that control plane, the current repo also contains the first bounded Intel driver-side package:
+
+- `local/recipes/drivers/redbear-iwlwifi/`
+
+Current bounded driver-side actions:
+
+- `redbear-iwlwifi --probe`
+- `redbear-iwlwifi --status <device>`
+- `redbear-iwlwifi --prepare <device>`
+- `redbear-iwlwifi --transport-probe <device>`
+- `redbear-iwlwifi --init-transport <device>`
+- `redbear-iwlwifi --activate-nic <device>`
+- `redbear-iwlwifi --scan <device>`
+- `redbear-iwlwifi --retry <device>`
+
 ### Supported commands

 - `netctl list`
@@ -56,6 +126,7 @@ Red Bear ships a Redox-native `netctl` compatibility command in `redbear-netctl`
 - `netctl disable [profile]`
 - `netctl is-enabled [profile]`
 - `netctl --boot`
+- `netctl scan <profile|iface>`

 Profiles live in `/etc/netctl`. Shipped examples live in `/etc/netctl/examples/`.

@@ -74,6 +145,10 @@ base networking services have started.

 - `redbear-netctl` was type-checked and smoke-tested with a fake runtime root by exercising:
  `list`, `enable`, `status`, and `start`.
+- the Wi-Fi profile flow was also exercised with a fake runtime root by starting a
+  `Connection=wifi` / `Interface=wlan0` profile and verifying that `SSID`, `Security`, `Key`, and
+  `connect` were written to the fake `/scheme/wifictl` tree while `status` reported the Wi-Fi
+  profile correctly
 - `rtl8168d` type-checks with the RTL8125 autoload configuration in place.
 - relibc type-checks with the interface and header updates in place.
 - `./local/scripts/validate-vm-network-baseline.sh` verifies the repo-level VM boot chain for