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

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

[Luiz Augusto von Dentz]

  Branch: refs/heads/1076592
  Home:   https://github.com/bluez/bluez
  Commit: bb92984ff247b06450fc6e91b1f63d9134ae39a4
      https://github.com/bluez/bluez/commit/bb92984ff247b06450fc6e91b1f63d9134ae39a4
  Author: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
  Date:   2026-04-02 (Thu, 02 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: ac0383f3cd2d19860a8d4884a5a152de30bf2231
      https://github.com/bluez/bluez/commit/ac0383f3cd2d19860a8d4884a5a152de30bf2231
  Author: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
  Date:   2026-04-02 (Thu, 02 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: c8d25d070335e78579c0f95982b14e6829cea039
      https://github.com/bluez/bluez/commit/c8d25d070335e78579c0f95982b14e6829cea039
  Author: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
  Date:   2026-04-02 (Thu, 02 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/bb92984ff247%5E...c8d25d070335

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