Files
ZephCore/zephcore/boards/common/debug.conf
T
liquidraver 38f815a0a1 server roles, event loops, companion transports, storage and prefs.json
Server roles (slice 7)
- CommonCLI split into upstream's shape; region CLI moved into CommonCLI;
  ClientACL, RegionMap, TransportKeyStore and both server meshes in
  upstream shape over an Arduino compat shim (helpers/compat: Arduino.h,
  Stream/Print, Serial, SHA256, FILESYSTEM/File over Zephyr fs)
- room server processAck port; `get acl` prints as upstream
- room: default name Room-XXXX, display/input rotation, live radio UI refresh

Event loops (slice 7b)
- repeater and room server share server_main_common with a ServerRole
  descriptor; shared event bits in src/mesh_events.h
- room server deadline-driven (idle wakes 2.2/s -> 0.08/s); companion
  loop() runs on housekeeping (closes the lazy contact-flush gap)
- `get loop.wakes` in debug builds (CONFIG_ZEPHCORE_LOOP_WAKE_STATS)

Companion transports and WiFi (slice 8)
- upstream MultiSerialInterface: BLE, USB/UART and TCP are each a
  BaseSerialInterface, every connected transport gets every frame;
  CompanionSerial holds a lossless reply; shared frame_txq for BLE/TCP
- SerialCompanionTransport and LinuxTCPTransport replaced by
  TcpCompanionTransport; ZephyrBLE split (gatt layout, DFU)
- WiFi companion (upstream wifi.ssid/pwd/enabled CLI, TCP port 5000) on
  boards declaring `capabilities: wifi` in zephcore.yml: the PSRAM
  ESP32-S3 boards, plus Heltec V3 (140 contacts), Wireless Tracker (130)
  and both C6 boards (280); ESP32-S3 without PSRAM gets bounded WiFi
  buffers and a measured 72 KB heap; PSRAM boards' internal heap 72 KB
- TCP queues: own depth (ZEPHCORE_TCP_QUEUE_SIZE=8), RX waits instead
  of dropping
- RAM: companion ClientACL dropped; main/BT-TX/TCP stacks sized from
  measured peaks (-7 KB nRF companions, -9 KB ESP32 companions)
- ESP32 WiFi stopped working under ~200 frames/s unicast. Fixed by:
  patches/zephyr/0017 never block the WiFi task in the RX callback;
  patches/zephyr/0018 lock shared_multi_heap (heap corruption with the
  WiFi heap in PSRAM); patches/modules/hal_espressif/0001 backport of
  hal_espressif af97fb02df (PSRAM realloc)

Storage and prefs (slice 9)
- prefs are now prefs.json through upstream's ConfigSerializer (ported
  verbatim), with upstream's key names for shared fields and ZephCore's
  own under "zc"; on first boot the binary new_prefs / repeater prefs is
  migrated and kept, so a downgrade still boots with the old settings
- helpers/PrefsCodec: both legacy binary layouts (companion 272 B,
  server 311 B) as Zephyr-free codecs; sanitizeNodePrefs is the only
  validator
- fix: server prefs could be replaced by a truncated file when a write
  failed; identity, prefs and channel writes go through one checked
  atomic replace (ZephyrFsUtil)
- fix: a corrupt cad_auto byte turned adaptive CAD off instead of the
  default on
- fix: a deliberate 300 s GPS duty on a repeater was rewritten to 48 h
  on every boot (that migration now runs on legacy files only)
- one identity loader for all roles (IdentityFile); an unusable key
  file is always parked as .bad before regenerating
- server store no longer stamps repeater defaults on room server and
  observer; companion first-boot volume policy moved into the store
  (adoptVolume)
- ZephyrDataStore 1435 -> ~850 lines
2026-09-25 08:34:21 +02:00

67 lines
2.9 KiB
Plaintext

# Debug Config — opt-in logging and diagnostics.
#
# Production is the default. Pass this conf to get the full debug experience:
#
# west build -b rak4631 zephcore --pristine -- \
# -DEXTRA_CONF_FILE="boards/common/debug.conf"
#
# # With repeater role:
# west build -b rak4631 zephcore --pristine -- \
# -DEXTRA_CONF_FILE="boards/common/repeater.conf;boards/common/debug.conf"
# ========== Core debug features ==========
CONFIG_LOG=y
CONFIG_ASSERT=y
CONFIG_THREAD_NAME=y
# SEGGER RTT is OFF by default: it costs 4,280 bytes of RAM (a 4 KB up-buffer
# plus control block) and is unusable without a debug probe, which most people
# do not have. Logs reach a plain serial terminal over USB CDC regardless —
# see the backend note below. Measured on meshtracker_x1: 1.8 % of total RAM
# on a build that sits near 92 %.
#
# With a J-Link attached, turn it back on for that build only:
# -DCONFIG_USE_SEGGER_RTT=y -DCONFIG_LOG_BACKEND_RTT=y \
# -DCONFIG_SEGGER_RTT_BUFFER_SIZE_UP=4096
# Halt-and-inspect on fatal faults instead of the production reboot-on-fatal
# (prj.conf sets CONFIG_ZEPHCORE_RESET_ON_FATAL_ERROR=y). A debugger needs the
# core stopped at the fault with a stack dump, not rebooted out from under it.
CONFIG_ZEPHCORE_RESET_ON_FATAL_ERROR=n
# ========== Log tuning ==========
# ZephCore BLE modules at INF level (connection lifecycle, pairing, TX/RX).
CONFIG_ZEPHCORE_BLE_LOG_LEVEL_INF=y
# Deferred logging — non-blocking so BLE/LoRa timing is not disturbed.
CONFIG_LOG_BUFFER_SIZE=8192
CONFIG_LOG_PROCESS_TRIGGER_THRESHOLD=1
CONFIG_LOG_PROCESS_THREAD_STACK_SIZE=2048
# No backend is selected here, deliberately. Zephyr's Kconfig.uart is
# "default y if !SHELL_BACKEND_SERIAL" and ZephCore never enables the serial
# shell backend, so CONFIG_LOG_BACKEND_UART is already on in every build — and
# on the boards whose chosen console is a cdc_acm_uart (nRF52 with native USB,
# e.g. meshtracker_x1, promicro_lr2021, t1000_e) that means logs come out of the
# USB CDC port with no J-Link and no extra flags.
#
# The comment that used to sit here claimed "RTT backend only — no UART backend
# on nRF52", which was never true: this file has never set
# CONFIG_LOG_BACKEND_UART=n, so it described an intent it did not implement.
# The stated worry — uart_poll_out() stalling when the USB host disconnects —
# does not apply in deferred mode, where the log thread does the blocking, not
# the mesh or radio threads.
# ========== Radio diagnostics ==========
# Verify the SX126x warm-start retention list survives duty-cycle sleeps.
# Prints "retention[install]" once at boot, then warns if a duty-cycled packet
# was received at the wrong Rx gain — the silent -3 dB failure that a broken
# retention list produces. Two SPI reads per received packet, so debug only.
CONFIG_ZEPHCORE_LORA_RETENTION_DEBUG=y
# Event-loop wake counter: `get loop.wakes`.
CONFIG_ZEPHCORE_LOOP_WAKE_STATS=y
# Silence noisy subsystems
CONFIG_CFB_LOG_LEVEL_ERR=y