[bluez/bluez] 107305: doc/btmon: Add Channel Sounding protocol flow docu...

[bluez/bluez] 107305: doc/btmon: Add Channel Sounding protocol flow docu...

[Luiz Augusto von Dentz]

  Branch: refs/heads/master
  Home:   https://github.com/bluez/bluez
  Commit: 10730536e5b55f93e9234fac493c7db581f7a4bf
      https://github.com/bluez/bluez/commit/10730536e5b55f93e9234fac493c7db581f7a4bf
  Author: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
  Date:   2026-04-03 (Fri, 03 Apr 2026)

  Changed paths:
    A doc/btmon-cs.rst

  Log Message:
  -----------
  doc/btmon: Add Channel Sounding protocol flow documentation

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.


  Commit: b499a284d08a03945834c602c47d7175e1e91819
      https://github.com/bluez/bluez/commit/b499a284d08a03945834c602c47d7175e1e91819
  Author: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
  Date:   2026-04-03 (Fri, 03 Apr 2026)

  Changed paths:
    M doc/btmon-cs.rst

  Log Message:
  -----------
  doc/btmon: Add RAS/RAP protocol flow to Channel Sounding documentation

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.


  Commit: 00dfd32af38ac950db32af0acfa4193511f718d9
      https://github.com/bluez/bluez/commit/00dfd32af38ac950db32af0acfa4193511f718d9
  Author: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
  Date:   2026-04-03 (Fri, 03 Apr 2026)

  Changed paths:
    M doc/btmon-cs.rst

  Log Message:
  -----------
  doc/btmon: Add CS and RAS state machines and combined flow charts

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


Compare: https://github.com/bluez/bluez/compare/000dc08822ff...00dfd32af38a

To unsubscribe from these emails, change your notification settings at https://github.com/bluez/bluez/settings/notifications