Documentation map

September 17, 2026 ยท View on GitHub

Documentation is organized by authority rather than investigation date.

When documents overlap, use this precedence:

  1. reviewed evidence/*.json and named runtime manifests state accepted or falsified conclusions;
  2. concise subsystem contracts state current ownership, behavior, and remaining uncertainty;
  3. generated/static censuses state mechanically recovered coverage and facts;
  4. deep reverse-engineering maps retain address-level detail but do not override a newer subsystem contract or evidence entry; and
  5. 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

DocumentPurpose
hardware_atlas.mdHigh-level firmware-to-hardware boundary.
mad2_fidelity.mdAuthoritative MAD2 implementation and uncertainty ledger.
mad2_static_access.mdGenerated paired-ROM census of direct MAD2 MMIO accesses.
mad2_residual_census.mdGenerated five-ROM closure of unresolved CTSI surfaces.
board_io_static_census.mdGenerated five-ROM PUP, KBGPIO, UIF and SELECT direct-access census.
driver_structure.mdCode ownership and quarantine rules.
driver_vision.mdCurrent modularization path and configuration taxonomy.
upstream_architecture.mdTarget MAME device graph, DSP substitution seam, ROM policy, and upstream staging.
product_configuration_audit.mdPost-refactor product-contract dependency audit and next bounded refactor.
external_call_bridge.mdVersioned host telephony API for network state, calls, GSM-FR media, SMS and USSD.
subscriber_profile.mdShared immutable SIM/network identity and authentication contract.
ccont_subsystem.mdCurrent CCONT contract, conclusions and fidelity backlog.
gensio_controller.mdExtracted GENSIO endpoint, serial and SELECT-latch contract.
mbus_controller.mdExtracted MBUS controller, firmware data path, and attachment boundary.
cross_rom_confidence.mdCross-product and cross-ROM boot, idle, and input evidence.
model_coverage.mdEvidence-gated per-product compatibility and fidelity matrix.
6110_bringup.mdAuthoritative NSE-3 hardware/firmware map and blocked resumption boundary.
5210_bringup.mdValidated NSM-5 v5.40 product contracts and remaining scope.
2100_bringup.mdBounded NAM-2 v5.84 portability frontier and display resumption contract.
3610_bringup.mdNAM-1 v5.11 executable profile, GENSIO/CCONT evidence and current bring-up boundary.
6110_bootstrap_capture.mdPhysical NSE-3 DSP-bootstrap capture format and acceptance contract.
structural_regression.mdAcceptance profiles, semantic predicates, and frame oracles.
evidence_regime.mdNormalized topology, hardware, predicate and falsification evidence rules.
research_cleanup.mdRepeatable cleanup protocol for hypotheses, naming residue, diagnostics, and evidence retention.
rtos_tasks.mdAuthoritative ROM-specific task identities, neutral aliases, and naming cautions.
normalization_status.mdCoverage boundary and remaining model, topology and instrumentation debt.
tooling.mdAnalysis, census and acceptance tooling reference.

Validated startup and UI boundaries

DocumentPurpose
sim_subsystem.mdConcise SIM ownership and interface summary.
mmi_layer.mdKeypad, security editor, interactive idle/menu, and power/shutdown lifecycle.
resource_providers.mdResource-provider ownership and excluded conditional startup paths.
external_service_topology.mdClass-0x40 service-command producers, acknowledgements, and external-service boundary.
service_bootstrap.mdService-session startup prerequisites and acceptance contract.
service_firmware_map.mdConcise lower-service and service-session firmware address map.
scheduler_delivery.mdReusable scheduler message/event encoding contract.
eeprom_analysis.mdEEPROM usage map, checksum contracts and the generated provisioning fixture.
storage_static_census.mdFive-ROM direct EEPROMSelX and PUP access absence/ownership census.
dct3_type_1f.mdCross-model status-2 type-0x1f envelope shared by 3210, 3310 and 6110 images.
gate_migration.mdHow acceptance gates are authored in gates.json and generated into gates.mk.
gate_parity_audit.mdGenerated audit of where sibling product gates differ.

Active protocol and HLE boundaries

DocumentPurpose
network_scouting.mdValidated camp, Location Updating, channel-release and operator-presentation contract.
cell_broadcast_and_ems.mdNSE-8 EMS application boundary and Cell Broadcast page/CBCH contract.
supplementary_call_control.mdValidated NSE-8 DTMF and hold/retrieve call-control lifecycle.
gsm_supplementary_services.mdCall-independent GSM 04.80, call-divert and host USSD contracts.
grey_salamander_integration.mdCurrent LAPDm/GSM capability catalogue and retained external-reference boundaries.
dsp_interface.mdDetailed MCU/DSP transport and later lower-radio maps.
dsp_shared_memory_inventory.mdGenerated two-ROM inventory of reachable firmware reads from DSP shared RAM.
dsp_shared_memory_transitions.mdGenerated two-ROM transaction census for DSP-owned shared-RAM scalar state.
dsp_packet_semantics.mdGenerated two-ROM inventory of DSP packet vocabulary and current HLE disposition.
dsp_service_transport_contract.mdDSP/generic-service ownership and acceptance contract.
cobba_control_boundary.mdOpaque DSP-to-COBBA control ownership, capture seam, and promotion requirements.
rom4_dsp_loader.mdRecovered ROM4 DSP block descriptor, reset and demand-load contract.
djr_dsp_integration.mdDSP architectural knowledge reviewed from the parallel djr-747 emulator without importing its code.
gsm_a5_ciphering.mdStandards-owned A5 keystream boundary, COUNT derivation and ciphering lifecycle.
gsm_tch_f_l1_completion.mdAudit of the generic GSM full-rate traffic-channel Layer 1 milestone against evidence.
ordinary_sms.mdAuthoritative 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.md
  • sim_emulator_scope.md
  • firmware_code_maps.md
  • message_topology_census.md
  • battery_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.