Documentation map
September 17, 2026 ยท View on GitHub
Documentation is organized by authority rather than investigation date.
When documents overlap, use this precedence:
- reviewed
evidence/*.jsonand named runtime manifests state accepted or falsified conclusions; - concise subsystem contracts state current ownership, behavior, and remaining uncertainty;
- generated/static censuses state mechanically recovered coverage and facts;
- deep reverse-engineering maps retain address-level detail but do not override a newer subsystem contract or evidence entry; and
- Git history retains chronology and discarded implementations.
The source implements the current model, but a calibrated implementation is not automatically a hardware fact. The relevant subsystem contract must label that distinction.
Start here
| Document | Purpose |
|---|---|
hardware_atlas.md | High-level firmware-to-hardware boundary. |
mad2_fidelity.md | Authoritative MAD2 implementation and uncertainty ledger. |
mad2_static_access.md | Generated paired-ROM census of direct MAD2 MMIO accesses. |
mad2_residual_census.md | Generated five-ROM closure of unresolved CTSI surfaces. |
board_io_static_census.md | Generated five-ROM PUP, KBGPIO, UIF and SELECT direct-access census. |
driver_structure.md | Code ownership and quarantine rules. |
driver_vision.md | Current modularization path and configuration taxonomy. |
upstream_architecture.md | Target MAME device graph, DSP substitution seam, ROM policy, and upstream staging. |
product_configuration_audit.md | Post-refactor product-contract dependency audit and next bounded refactor. |
external_call_bridge.md | Versioned host telephony API for network state, calls, GSM-FR media, SMS and USSD. |
subscriber_profile.md | Shared immutable SIM/network identity and authentication contract. |
ccont_subsystem.md | Current CCONT contract, conclusions and fidelity backlog. |
gensio_controller.md | Extracted GENSIO endpoint, serial and SELECT-latch contract. |
mbus_controller.md | Extracted MBUS controller, firmware data path, and attachment boundary. |
cross_rom_confidence.md | Cross-product and cross-ROM boot, idle, and input evidence. |
model_coverage.md | Evidence-gated per-product compatibility and fidelity matrix. |
6110_bringup.md | Authoritative NSE-3 hardware/firmware map and blocked resumption boundary. |
5210_bringup.md | Validated NSM-5 v5.40 product contracts and remaining scope. |
2100_bringup.md | Bounded NAM-2 v5.84 portability frontier and display resumption contract. |
3610_bringup.md | NAM-1 v5.11 executable profile, GENSIO/CCONT evidence and current bring-up boundary. |
6110_bootstrap_capture.md | Physical NSE-3 DSP-bootstrap capture format and acceptance contract. |
structural_regression.md | Acceptance profiles, semantic predicates, and frame oracles. |
evidence_regime.md | Normalized topology, hardware, predicate and falsification evidence rules. |
research_cleanup.md | Repeatable cleanup protocol for hypotheses, naming residue, diagnostics, and evidence retention. |
rtos_tasks.md | Authoritative ROM-specific task identities, neutral aliases, and naming cautions. |
normalization_status.md | Coverage boundary and remaining model, topology and instrumentation debt. |
tooling.md | Analysis, census and acceptance tooling reference. |
Validated startup and UI boundaries
| Document | Purpose |
|---|---|
sim_subsystem.md | Concise SIM ownership and interface summary. |
mmi_layer.md | Keypad, security editor, interactive idle/menu, and power/shutdown lifecycle. |
resource_providers.md | Resource-provider ownership and excluded conditional startup paths. |
external_service_topology.md | Class-0x40 service-command producers, acknowledgements, and external-service boundary. |
service_bootstrap.md | Service-session startup prerequisites and acceptance contract. |
service_firmware_map.md | Concise lower-service and service-session firmware address map. |
scheduler_delivery.md | Reusable scheduler message/event encoding contract. |
eeprom_analysis.md | EEPROM usage map, checksum contracts and the generated provisioning fixture. |
storage_static_census.md | Five-ROM direct EEPROMSelX and PUP access absence/ownership census. |
dct3_type_1f.md | Cross-model status-2 type-0x1f envelope shared by 3210, 3310 and 6110 images. |
gate_migration.md | How acceptance gates are authored in gates.json and generated into gates.mk. |
gate_parity_audit.md | Generated audit of where sibling product gates differ. |
Active protocol and HLE boundaries
| Document | Purpose |
|---|---|
network_scouting.md | Validated camp, Location Updating, channel-release and operator-presentation contract. |
cell_broadcast_and_ems.md | NSE-8 EMS application boundary and Cell Broadcast page/CBCH contract. |
supplementary_call_control.md | Validated NSE-8 DTMF and hold/retrieve call-control lifecycle. |
gsm_supplementary_services.md | Call-independent GSM 04.80, call-divert and host USSD contracts. |
grey_salamander_integration.md | Current LAPDm/GSM capability catalogue and retained external-reference boundaries. |
dsp_interface.md | Detailed MCU/DSP transport and later lower-radio maps. |
dsp_shared_memory_inventory.md | Generated two-ROM inventory of reachable firmware reads from DSP shared RAM. |
dsp_shared_memory_transitions.md | Generated two-ROM transaction census for DSP-owned shared-RAM scalar state. |
dsp_packet_semantics.md | Generated two-ROM inventory of DSP packet vocabulary and current HLE disposition. |
dsp_service_transport_contract.md | DSP/generic-service ownership and acceptance contract. |
cobba_control_boundary.md | Opaque DSP-to-COBBA control ownership, capture seam, and promotion requirements. |
rom4_dsp_loader.md | Recovered ROM4 DSP block descriptor, reset and demand-load contract. |
djr_dsp_integration.md | DSP architectural knowledge reviewed from the parallel djr-747 emulator without importing its code. |
gsm_a5_ciphering.md | Standards-owned A5 keystream boundary, COUNT derivation and ciphering lifecycle. |
gsm_tch_f_l1_completion.md | Audit of the generic GSM full-rate traffic-channel Layer 1 milestone against evidence. |
ordinary_sms.md | Authoritative boundary for ordinary SMS-DELIVER and SMS-SUBMIT. |
Address-level reverse-engineering references
The following are detailed firmware maps that remain useful when working in the corresponding subsystem:
sim_registration.mdsim_emulator_scope.mdfirmware_code_maps.mdmessage_topology_census.mdbattery_classifier_analysis.md(mapped battery ADC/classifier contract)
Absolute addresses apply to the 3210 v6.00 firmware unless explicitly stated otherwise. These maps are retained because their coverage and exact addresses make future work cheaper; their older interpretations are not authoritative.
Normalized reviewed evidence lives in evidence/*.json; named runtime inputs
live in tools/run_manifests/*.json. Run make evidence-check before banking a
new conclusion.
Evidence policy
Keep:
- register maps and interface contracts;
- exact addresses needed to reproduce a conclusion;
- current acceptance conditions and hashes;
- unresolved questions with a concrete observation needed; and
- negative conclusions that prevent a plausible failed approach being repeated.
Remove or condense:
- chronological session narratives;
- repeated progress summaries;
- superseded plans and speculative component sketches;
- raw trace dumps already represented by a table or conclusion; and
- descriptions of probes or knobs that no longer exist.
Failed forcing implementations live in Git history. Only reusable negative
conclusions belong in evidence/falsifications.json; the current force policy
lives in evidence_regime.md.