[PW_SID:1076592] [RFC,BlueZ,1/3] doc/btmon: Add Channel Sounding protocol flow documentation - #2005
[PW_SID:1076592] [RFC,BlueZ,1/3] doc/btmon: Add Channel Sounding protocol flow documentation#2005BluezTestBot wants to merge 3 commits into
Conversation
Add btmon-cs.rst documenting the complete CS protocol flow as seen in btmon traces. Covers capability exchange, security enable, configuration, procedure parameters, enable/disable, subevent results with all four step modes (Mode 0-3), result status fields, FAE table exchange, channel classification, CS test mode, the typical setup sequence, and common issues. This provides LLM context so automated trace analysis can correctly interpret CS distance measurement sessions.
Add the Ranging Service (RAS) and Ranging Profile (RAP) GATT-level protocol flow to btmon-cs.rst. Covers all six RAS characteristics (Features, Real-time Ranging Data, On-demand Ranging Data, Control Point, Data Ready, Data Overwritten), the five Control Point opcodes (Get Ranging Data, ACK, Retrieve Lost Segments, Abort, Set Filter), the segmented ranging data format with Ranging Header and Subevent Header decoding, the typical on-demand and real-time data flows, and common issues.
Add three state machine diagrams and four flow charts to btmon-cs.rst: - CS State Machine: IDLE → CAPABILITIES EXCHANGED → CONFIGURED → PARAMETERS SET → PROCEDURE RUNNING → CONFIGURED → IDLE - RAS Data Transfer State Machine: IDLE → DATA READY → TRANSFERRING → COMPLETE → IDLE (with ABORTED and recovery paths) - Typical CS Setup Sequence: HCI command/event timeline with state annotations showing the full capability exchange through procedure enable/disable cycle - Combined HCI + GATT Flow: interleaved three-column chart showing HCI CS operations alongside GATT RAS service discovery, CCC setup, data ready notification, on-demand retrieval with segmented transfers, and ACK - Real-time Streaming Flow: shows how HCI Subevent Results trigger immediate GATT notifications on Real-time Ranging Data - Lost Segment Recovery Flow: demonstrates the Retrieve Lost Segments mechanism with gap detection and retransmission
|
CheckPatch |
|
GitLint |
|
BuildEll |
Up to standards ✅🟢 Issues
|
|
BluezMake |
|
MakeCheck |
|
MakeDistcheck |
|
CheckValgrind |
|
CheckSmatch |
|
bluezmakeextell |
|
IncrementalBuild |
|
ScanBuild |
From: Luiz Augusto von Dentz luiz.von.dentz@intel.com
Add btmon-cs.rst documenting the complete CS protocol flow as seen
in btmon traces. Covers capability exchange, security enable,
configuration, procedure parameters, enable/disable, subevent
results with all four step modes (Mode 0-3), result status fields,
FAE table exchange, channel classification, CS test mode, the
typical setup sequence, and common issues.
This provides LLM context so automated trace analysis can correctly
interpret CS distance measurement sessions.
doc/btmon-cs.rst | 656 +++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 656 insertions(+)
create mode 100644 doc/btmon-cs.rst