Skip to content

[PW_SID:1076592] [RFC,BlueZ,1/3] doc/btmon: Add Channel Sounding protocol flow documentation - #2005

Closed
BluezTestBot wants to merge 3 commits into
masterfrom
1076592
Closed

[PW_SID:1076592] [RFC,BlueZ,1/3] doc/btmon: Add Channel Sounding protocol flow documentation#2005
BluezTestBot wants to merge 3 commits into
masterfrom
1076592

Conversation

@BluezTestBot

Copy link
Copy Markdown

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

Vudentz added 3 commits April 2, 2026 18:06
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
@BluezTestBot

Copy link
Copy Markdown
Author

CheckPatch
Desc: Run checkpatch.pl script
Duration: 0.30 seconds
Result: PENDING

@BluezTestBot

Copy link
Copy Markdown
Author

GitLint
Desc: Run gitlint
Duration: 0.31 seconds
Result: PENDING

@BluezTestBot

Copy link
Copy Markdown
Author

BuildEll
Desc: Build and Install ELL
Duration: 20.15 seconds
Result: PASS

@codacy-production

codacy-production Bot commented Apr 2, 2026

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

@BluezTestBot

Copy link
Copy Markdown
Author

BluezMake
Desc: Build BlueZ
Duration: 660.36 seconds
Result: PASS

@BluezTestBot

Copy link
Copy Markdown
Author

MakeCheck
Desc: Run Bluez Make Check
Duration: 18.26 seconds
Result: PASS

@BluezTestBot

Copy link
Copy Markdown
Author

MakeDistcheck
Desc: Run Bluez Make Distcheck
Duration: 244.89 seconds
Result: PASS

@BluezTestBot

Copy link
Copy Markdown
Author

CheckValgrind
Desc: Run Bluez Make Check with Valgrind
Duration: 291.88 seconds
Result: PASS

@BluezTestBot

Copy link
Copy Markdown
Author

CheckSmatch
Desc: Run smatch tool with source
Duration: 349.42 seconds
Result: PASS

@BluezTestBot

Copy link
Copy Markdown
Author

bluezmakeextell
Desc: Build Bluez with External ELL
Duration: 181.27 seconds
Result: PASS

@BluezTestBot

Copy link
Copy Markdown
Author

IncrementalBuild
Desc: Incremental build with the patches in the series
Duration: 0.32 seconds
Result: PENDING

@BluezTestBot

Copy link
Copy Markdown
Author

ScanBuild
Desc: Run Scan Build
Duration: 1021.29 seconds
Result: PASS

@BluezTestBot
BluezTestBot deleted the 1076592 branch April 3, 2026 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants