Skip to contentSkip to conversation

doc/btmon: Split Advertising and Scanning into btmon-advertising.rst

PATCH Applied Luiz Augusto von Dentz 3 participants 11 messages Mar 25

Subsystems (2)
lore
Share & tools
lore

Luiz Augusto von Dentz

author maintainer
#0 lore raw

PATCH v3 1/9 doc/btmon: Split Advertising and Scanning into btmon-advertising.rst

From: Luiz Augusto von Dentz <[email protected]>

Move the ADVERTISING AND SCANNING section into a standalone file and replace it with an RST include directive. This allows the btsnoop-analyzer to load only the relevant documentation for advertising/scanning focus-area analysis instead of the full btmon.rst.

---
 Makefile.am               |   2 +
 doc/btmon-advertising.rst | 155 ++++++++++++++++++++++++++++++++++++++
 doc/btmon.rst             | 155 +-------------------------------------
 3 files changed, 160 insertions(+), 152 deletions(-)
 create mode 100644 doc/btmon-advertising.rst
Makefile.am +2 -0
index dee6aa6d0d9b..9ab2a8231307 100644
@@ -538,6 +538,8 @@ EXTRA_DIST += doc/pics-opp.txt doc/pixit-opp.txt \
 
 EXTRA_DIST += doc/btsnoop-protocol.rst
 
+EXTRA_DIST += doc/btmon-advertising.rst
+
 EXTRA_DIST += tools/magic.btsnoop
 
 AM_CPPFLAGS += $(DBUS_CFLAGS) $(GLIB_CFLAGS) -I$(srcdir)/lib
doc/btmon-advertising.rst new file +155 -0

155 lines not on this page · raw message

doc/btmon.rst +3 -152

162 lines not on this page · raw message

Signature · 1 line
2.53.0
author maintainer
#1 lore raw

PATCH v3 2/9 doc/btmon: Split LE Audio Protocol Flow into btmon-le-audio.rst

From: Luiz Augusto von Dentz <[email protected]>

Move the LE AUDIO PROTOCOL FLOW section (including CIS unicast, BIS broadcast, and BIG sync flows) into a standalone file and replace it with an RST include directive. This is the largest split section (660 lines) and was being truncated away in context-limited analysis.

---
 Makefile.am            |   2 +
 doc/btmon-le-audio.rst | 655 ++++++++++++++++++++++++++++++++++++++++
 doc/btmon.rst          | 656 +----------------------------------------
 3 files changed, 659 insertions(+), 654 deletions(-)
 create mode 100644 doc/btmon-le-audio.rst
Makefile.am +2 -0
index 9ab2a8231307..b561b708cab5 100644
@@ -540,6 +540,8 @@ EXTRA_DIST += doc/btsnoop-protocol.rst
 
 EXTRA_DIST += doc/btmon-advertising.rst
 
+EXTRA_DIST += doc/btmon-le-audio.rst
+
 EXTRA_DIST += tools/magic.btsnoop
 
 AM_CPPFLAGS += $(DBUS_CFLAGS) $(GLIB_CFLAGS) -I$(srcdir)/lib
doc/btmon-le-audio.rst new file +655 -0

655 lines not on this page · raw message

doc/btmon.rst +2 -654

668 lines not on this page · raw message

Signature · 1 line
2.53.0
author maintainer
#2 lore raw

PATCH v3 3/9 doc/btmon: Split L2CAP Channel Tracking into btmon-l2cap.rst

In reply to Luiz Augusto von Dentz

From: Luiz Augusto von Dentz <[email protected]>

Move the L2CAP CHANNEL TRACKING section into a standalone file and replace it with an RST include directive.

---
 Makefile.am         |   2 +
 doc/btmon-l2cap.rst | 192 +++++++++++++++++++++++++++++++++++++++++++
 doc/btmon.rst       | 193 +-------------------------------------------
 3 files changed, 196 insertions(+), 191 deletions(-)
 create mode 100644 doc/btmon-l2cap.rst
Makefile.am +2 -0
index b561b708cab5..292ef64a98d3 100644
@@ -542,6 +542,8 @@ EXTRA_DIST += doc/btmon-advertising.rst
 
 EXTRA_DIST += doc/btmon-le-audio.rst
 
+EXTRA_DIST += doc/btmon-l2cap.rst
+
 EXTRA_DIST += tools/magic.btsnoop
 
 AM_CPPFLAGS += $(DBUS_CFLAGS) $(GLIB_CFLAGS) -I$(srcdir)/lib
doc/btmon-l2cap.rst new file +192 -0

192 lines not on this page · raw message

doc/btmon.rst +2 -191

205 lines not on this page · raw message

Signature · 1 line
2.53.0
author maintainer
#3 lore raw

PATCH v3 4/9 doc/btmon: Split SMP Pairing Flow into btmon-smp.rst

In reply to Luiz Augusto von Dentz

From: Luiz Augusto von Dentz <[email protected]>

Move the SMP PAIRING FLOW section into a standalone file and replace it with an RST include directive.

---
 Makefile.am       |   2 +
 doc/btmon-smp.rst | 248 +++++++++++++++++++++++++++++++++++++++++++++
 doc/btmon.rst     | 249 +---------------------------------------------
 3 files changed, 252 insertions(+), 247 deletions(-)
 create mode 100644 doc/btmon-smp.rst
Makefile.am +2 -0
index 292ef64a98d3..5f2ce6a2d0f8 100644
@@ -544,6 +544,8 @@ EXTRA_DIST += doc/btmon-le-audio.rst
 
 EXTRA_DIST += doc/btmon-l2cap.rst
 
+EXTRA_DIST += doc/btmon-smp.rst
+
 EXTRA_DIST += tools/magic.btsnoop
 
 AM_CPPFLAGS += $(DBUS_CFLAGS) $(GLIB_CFLAGS) -I$(srcdir)/lib
doc/btmon-smp.rst new file +248 -0

248 lines not on this page · raw message

doc/btmon.rst +2 -247

261 lines not on this page · raw message

Signature · 1 line
2.53.0
author maintainer
#4 lore raw

PATCH v3 5/9 doc/btmon: Split GATT Database Reconstruction into btmon-gatt.rst

In reply to Luiz Augusto von Dentz

From: Luiz Augusto von Dentz <[email protected]>

Move the RECONSTRUCTING A GATT DATABASE FROM SNOOP TRACES section into a standalone file and replace it with an RST include directive.

---
 Makefile.am        |   2 +
 doc/btmon-gatt.rst | 419 ++++++++++++++++++++++++++++++++++++++++++++
 doc/btmon.rst      | 421 +--------------------------------------------
 3 files changed, 424 insertions(+), 418 deletions(-)
 create mode 100644 doc/btmon-gatt.rst
Makefile.am +2 -0
index 5f2ce6a2d0f8..b36da8a803e6 100644
@@ -546,6 +546,8 @@ EXTRA_DIST += doc/btmon-l2cap.rst
 
 EXTRA_DIST += doc/btmon-smp.rst
 
+EXTRA_DIST += doc/btmon-gatt.rst
+
 EXTRA_DIST += tools/magic.btsnoop
 
 AM_CPPFLAGS += $(DBUS_CFLAGS) $(GLIB_CFLAGS) -I$(srcdir)/lib
doc/btmon-gatt.rst new file +419 -0

419 lines not on this page · raw message

doc/btmon.rst +3 -418

433 lines not on this page · raw message

Signature · 1 line
2.53.0
author maintainer
#5 lore raw

PATCH v3 6/9 doc/btmon: Split Connection Tracking into btmon-connections.rst

In reply to Luiz Augusto von Dentz

From: Luiz Augusto von Dentz <[email protected]>

Move the CONNECTION TRACKING and HCI ERROR AND DISCONNECT REASON CODES sections into a standalone file and replace them with an RST include directive.

---
 Makefile.am               |   2 +
 doc/btmon-connections.rst | 142 +++++++++++++++++++++++++++++++++++++
 doc/btmon.rst             | 143 +-------------------------------------
 3 files changed, 146 insertions(+), 141 deletions(-)
 create mode 100644 doc/btmon-connections.rst
Makefile.am +2 -0
index b36da8a803e6..a8473127cf66 100644
@@ -548,6 +548,8 @@ EXTRA_DIST += doc/btmon-smp.rst
 
 EXTRA_DIST += doc/btmon-gatt.rst
 
+EXTRA_DIST += doc/btmon-connections.rst
+
 EXTRA_DIST += tools/magic.btsnoop
 
 AM_CPPFLAGS += $(DBUS_CFLAGS) $(GLIB_CFLAGS) -I$(srcdir)/lib
doc/btmon-connections.rst new file +142 -0

142 lines not on this page · raw message

doc/btmon.rst +2 -141

155 lines not on this page · raw message

Signature · 1 line
2.53.0
author maintainer
#6 lore raw

PATCH v3 7/9 doc/btmon: Add HCI initialization sequence documentation

In reply to Luiz Augusto von Dentz

From: Luiz Augusto von Dentz <[email protected]>

Document the multi-stage HCI controller initialization performed by the kernel (net/bluetooth/hci_sync.c). The four stages cover reset and identity, capability discovery, event mask configuration, and final setup. This helps trace readers distinguish normal init traffic from application-level issues.

---
 Makefile.am            |   2 +
 doc/btmon-hci-init.rst | 363 +++++++++++++++++++++++++++++++++++++++++
 doc/btmon.rst          |   2 +
 3 files changed, 367 insertions(+)
 create mode 100644 doc/btmon-hci-init.rst
Makefile.am +2 -0
index a8473127cf66..e67a1f5c81e9 100644
@@ -550,6 +550,8 @@ EXTRA_DIST += doc/btmon-gatt.rst
 
 EXTRA_DIST += doc/btmon-connections.rst
 
+EXTRA_DIST += doc/btmon-hci-init.rst
+
 EXTRA_DIST += tools/magic.btsnoop
 
 AM_CPPFLAGS += $(DBUS_CFLAGS) $(GLIB_CFLAGS) -I$(srcdir)/lib
doc/btmon-hci-init.rst new file +363 -0

363 lines not on this page · raw message

doc/btmon.rst +2 -0
index 9cf1464eae63..6ecadf3f260d 100644
@@ -755,6 +755,8 @@ Errors often cascade across layers. Common patterns:
 PROTOCOL FLOWS
 ===============
 
+.. include:: btmon-hci-init.rst
+
 .. include:: btmon-connections.rst
 
 .. include:: btmon-gatt.rst
Signature · 1 line
2.53.0
author maintainer
#7 lore raw

PATCH v3 8/9 doc/btmon: Add A2DP/AVDTP protocol flow documentation

In reply to Luiz Augusto von Dentz

From: Luiz Augusto von Dentz <[email protected]>

Add btmon-a2dp.rst documenting the A2DP protocol flow as seen in btmon output, wrapped by btmon-classic-audio.rst parent file. Coverage includes:

- AVDTP signaling: Discover, Get Capabilities, Set Configuration, Open, Start, Suspend, Close
- Codec capability/configuration decoding for SBC, AAC, aptX, aptX HD, aptX Low Latency, FastStream, LDAC, and Opus
- AVDTP media transport channel setup
- AVRCP control and browsing channel overview
- Delay Reporting
- Automation-friendly grep patterns

---
 Makefile.am                 |   2 +
 doc/btmon-a2dp.rst          | 418 ++++++++++++++++++++++++++++++++++++
 doc/btmon-classic-audio.rst |  12 ++
 doc/btmon.rst               |   2 +
 4 files changed, 434 insertions(+)
 create mode 100644 doc/btmon-a2dp.rst
 create mode 100644 doc/btmon-classic-audio.rst
Makefile.am +2 -0
index e67a1f5c81e9..7bbb968f66f7 100644
@@ -552,6 +552,8 @@ EXTRA_DIST += doc/btmon-connections.rst
 
 EXTRA_DIST += doc/btmon-hci-init.rst
 
+EXTRA_DIST += doc/btmon-classic-audio.rst doc/btmon-a2dp.rst
+
 EXTRA_DIST += tools/magic.btsnoop
 
 AM_CPPFLAGS += $(DBUS_CFLAGS) $(GLIB_CFLAGS) -I$(srcdir)/lib
doc/btmon-a2dp.rst new file +418 -0

418 lines not on this page · raw message

doc/btmon-classic-audio.rst new file +12 -0
new file mode 100644
index 000000000000..11943c3a54bf
@@ -0,0 +1,12 @@
+.. This file is included by btmon.rst.
+
+CLASSIC AUDIO PROTOCOL FLOW
+=============================
+
+Classic Bluetooth audio uses two main profiles: A2DP for high-quality
+stereo streaming and HFP for voice calls. Both run over BR/EDR ACL
+connections and use different transport mechanisms for audio data --
+A2DP uses L2CAP-based AVDTP media channels while HFP uses SCO/eSCO
+synchronous connections.
+
+.. include:: btmon-a2dp.rst
doc/btmon.rst +2 -0
index 6ecadf3f260d..8a02edce8e6a 100644
@@ -767,6 +767,8 @@ PROTOCOL FLOWS
 
 .. include:: btmon-le-audio.rst
 
+.. include:: btmon-classic-audio.rst
+
 .. include:: btmon-advertising.rst
 
 EXAMPLES
Signature · 1 line
2.53.0
author maintainer
#8 lore raw

PATCH v3 9/9 doc/btmon: Add HFP protocol flow documentation

In reply to Luiz Augusto von Dentz

From: Luiz Augusto von Dentz <[email protected]>

Add btmon-hfp.rst documenting the HFP protocol flow as seen in btmon output. Coverage includes:

- SDP service discovery for Handsfree/AG UUIDs
- RFCOMM channel setup over L2CAP PSM 3 (SABM/UA, Parameter Negotiation, Modem Status Command)
- AT command exchange for SLC setup (noted as hex dump only -- btmon does not parse AT commands within RFCOMM UIH data frames)
- Codec negotiation via AT+BAC/AT+BCS
- SCO/eSCO synchronous connection setup (voice setting, coding format)
- Codec summary tables (AT-level vs HCI-level codec IDs)
- Automation-friendly grep patterns

---
 Makefile.am                 |   2 +
 doc/btmon-classic-audio.rst |   2 +
 doc/btmon-hfp.rst           | 476 ++++++++++++++++++++++++++++++++++++
 3 files changed, 480 insertions(+)
 create mode 100644 doc/btmon-hfp.rst
Makefile.am +2 -0
index 7bbb968f66f7..2cfb884f1851 100644
@@ -554,6 +554,8 @@ EXTRA_DIST += doc/btmon-hci-init.rst
 
 EXTRA_DIST += doc/btmon-classic-audio.rst doc/btmon-a2dp.rst
 
+EXTRA_DIST += doc/btmon-hfp.rst
+
 EXTRA_DIST += tools/magic.btsnoop
 
 AM_CPPFLAGS += $(DBUS_CFLAGS) $(GLIB_CFLAGS) -I$(srcdir)/lib
doc/btmon-classic-audio.rst +2 -0
index 11943c3a54bf..3e7c5384be87 100644
@@ -10,3 +10,5 @@ A2DP uses L2CAP-based AVDTP media channels while HFP uses SCO/eSCO
 synchronous connections.
 
 .. include:: btmon-a2dp.rst
+
+.. include:: btmon-hfp.rst
doc/btmon-hfp.rst new file +476 -0

476 lines not on this page · raw message

Signature · 1 line
2.53.0
#9 lore raw
In reply to Luiz Augusto von Dentz

This is automated email and please do not reply to this email!

Dear submitter,

Thank you for submitting the patches to the linux bluetooth mailing list. This is a CI test results with your patch series:
PW Link:https://patchwork.kernel.org/project/bluetooth/list/?series=1072496

---Test result---

Test Summary:

CheckPatch                    PENDING   0.32 seconds
GitLint                       PENDING   0.37 seconds
BuildEll                      PASS      18.66 seconds
BluezMake                     PASS      682.00 seconds
MakeCheck                     PASS      18.01 seconds
MakeDistcheck                 PASS      228.23 seconds
CheckValgrind                 PASS      280.54 seconds
CheckSmatch                   PASS      316.84 seconds
bluezmakeextell               PASS      170.57 seconds
IncrementalBuild              PENDING   0.41 seconds
ScanBuild                     PASS      948.66 seconds

Details
##############################
Test: CheckPatch - PENDING
Desc: Run checkpatch.pl script
Output:

##############################
Test: GitLint - PENDING
Desc: Run gitlint
Output:

##############################
Test: IncrementalBuild - PENDING
Desc: Incremental build with the patches in the series Output:

https://github.com/bluez/bluez/pull/1987/checks

---
Regards,
Linux Bluetooth

#10 lore raw
In reply to Luiz Augusto von Dentz
This series was applied to bluetooth/bluez.git (master) by Luiz Augusto von Dentz <[email protected]>:

Hello:

This series was applied to bluetooth/bluez.git (master) by Luiz Augusto von Dentz <[email protected]>:

Quoted 8 lines · On Wed, 25 Mar 2026 14:53:57 -0400 you wrote:

From: Luiz Augusto von Dentz <[email protected]>

Move the ADVERTISING AND SCANNING section into a standalone file and replace it with an RST include directive. This allows the btsnoop-analyzer to load only the relevant documentation for advertising/scanning focus-area analysis instead of the full btmon.rst.

[...]

Here is the summary with links:
- [BlueZ,v3,1/9] doc/btmon: Split Advertising and Scanning into btmon-advertising.rst

    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=6ca24f69351e
  - [BlueZ,v3,2/9] doc/btmon: Split LE Audio Protocol Flow into btmon-le-audio.rst
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=d6e2bf9a3a2b
  - [BlueZ,v3,3/9] doc/btmon: Split L2CAP Channel Tracking into btmon-l2cap.rst
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=042e211cd021
  - [BlueZ,v3,4/9] doc/btmon: Split SMP Pairing Flow into btmon-smp.rst
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=2bcd75cd75ea
  - [BlueZ,v3,5/9] doc/btmon: Split GATT Database Reconstruction into btmon-gatt.rst
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=d991284294f4
  - [BlueZ,v3,6/9] doc/btmon: Split Connection Tracking into btmon-connections.rst
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=838c717f9dfb
  - [BlueZ,v3,7/9] doc/btmon: Add HCI initialization sequence documentation
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=60a32f8c7517
  - [BlueZ,v3,8/9] doc/btmon: Add A2DP/AVDTP protocol flow documentation
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=173fad8fbe9f
  - [BlueZ,v3,9/9] doc/btmon: Add HFP protocol flow documentation
    https://git.kernel.org/pub/scm/bluetooth/bluez.git/?id=097196bf8a29

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html