public inbox for linux-bluetooth@vger.kernel.org
 help / color / mirror / Atom feed
From: Luiz Augusto von Dentz <luiz.dentz@gmail.com>
To: linux-bluetooth@vger.kernel.org
Subject: [PATCH BlueZ v2 12/12] doc/btmon: Update documentation to reflect lastest changes
Date: Fri, 20 Feb 2026 12:31:16 -0500	[thread overview]
Message-ID: <20260220173120.3418666-12-luiz.dentz@gmail.com> (raw)
In-Reply-To: <20260220173120.3418666-1-luiz.dentz@gmail.com>

From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>

This update the diagram showing where each information is displayed to
include the connection type and peer address.
---
 doc/btmon.rst | 33 ++++++++++++++++++---------------
 1 file changed, 18 insertions(+), 15 deletions(-)

diff --git a/doc/btmon.rst b/doc/btmon.rst
index c1616318a004..e1e362b7c1b6 100644
--- a/doc/btmon.rst
+++ b/doc/btmon.rst
@@ -255,23 +255,26 @@ completes and the result status.
 
 **ACL Data** shows data plane traffic with handle and protocol decoding::
 
-    < ACL Data TX: Handle 2048 [1.. flags 0x00 dlen 16  #493 [hci0] 12:36:18.977915
-    │              │              │            │          │    │       │
-    │              │              │            │          │    │       └─ Timestamp
-    │              │              │            │          │    └─ Controller
-    │              │              │            │          └─ Frame number
-    │              │              │            └─ Data length
-    │              │              └─ Fragment info / flags
-    │              └─ Connection handle
-    └─ Direction: TX = outgoing, RX = incoming
+    < LE-ACL: Handle 2048 [66:B0:26:F1:D3:BC] [1/6] flags 0x00 dlen 16  #493 [hci0] 12:36:18.977915
+    │   │            │     │                   │          │         │    │    │     │
+    │   │            │     │                   │          │         │    │    │     └─ Timestamp
+    │   │            │     │                   │          │         │    │    └─ Controller
+    │   │            │     │                   │          │         │    └─ Frame number
+    │   │            │     │                   │          │         └─ Data length
+    │   │            │     │                   │          └─ flags
+    │   │            │     │                   └─ Buffer tracking (optional)
+    │   │            │     └─ Peer address (optional)
+    │   │            └─ Handle number
+    │   └─ Connection-type-aware label (e.g. BR-ACL, LE-ACL, BR-SCO, LE-ISO)
+    └─ Direction marker: '<' = host->controller (TX), '>' = controller->host (RX)
 
 ACL data is automatically decoded into higher-layer protocols::
 
-    < ACL Data TX: Handle 2048 [2/6] flags 0x00 dlen 7  #494 [hci0] 12:36:18.978488
+    < LE-ACL: Handle 2048 [2/6] flags 0x00 dlen 7  #494 [hci0] 12:36:18.978488
           ATT: Exchange MTU Request (0x02) len 2
             Client RX MTU: 517
 
-    > ACL Data RX: Handle 2048 flags 0x02 dlen 11       #497 [hci0] 12:36:19.000048
+    > LE-ACL: Handle 2048 flags 0x02 dlen 11       #497 [hci0] 12:36:19.000048
           SMP: Pairing Request (0x01) len 6
             IO capability: NoInputNoOutput (0x03)
             OOB data: Authentication data not present (0x00)
@@ -435,7 +438,7 @@ frame. The indentation level indicates the protocol layer:
 
 Example of protocol layering in ACL data::
 
-    > ACL Data RX: Handle 2048 flags 0x02 dlen 11       #497 [hci0] 12:36:19.000048
+    > ACL: Handle 2048 flags 0x02 dlen 11       #497 [hci0] 12:36:19.000048
           SMP: Pairing Request (0x01) len 6                          ← L2CAP/SMP layer
             IO capability: NoInputNoOutput (0x03)                    ← SMP fields
             OOB data: Authentication data not present (0x00)
@@ -520,9 +523,9 @@ MGMT Command Complete event back to bluetoothd.
             Peer address: AA:BB:CC:DD:EE:FF (OUI Company)
     @ MGMT Event: Device Connec.. (0x000b) plen 13  {0x0001} [hci0] 12:36:18.974319
     = bluetoothd: src/adapter.c:connected_callback() hci0 devic..   12:36:18.975307
-    < ACL Data TX: Handle 2048 [1.. flags 0x00 dlen 16  #493 [hci0] 12:36:18.977915
+    < ACL: Handle 2048 [1.. flags 0x00 dlen 16  #493 [hci0] 12:36:18.977915
           LE L2CAP: Connection Parameter Update Request (0x12) ident 1 len 8
-    < ACL Data TX: Handle 2048 [2/6] flags 0x00 dlen 7  #494 [hci0] 12:36:18.978488
+    < ACL: Handle 2048 [2/6] flags 0x00 dlen 7  #494 [hci0] 12:36:18.978488
           ATT: Exchange MTU Request (0x02) len 2
             Client RX MTU: 517
 
@@ -579,7 +582,7 @@ Controller Buffer Tracking
 
 Buffer tracking may show a indicator in square brackets::
 
-    < ACL Data TX: Handle 2048 [1/6] flags 0x00 dlen 16
+    < ACL: Handle 2048 [1/6] flags 0x00 dlen 16
 
 The ``[1/6]`` means this is buffer slot 1 of 6 available controller
 ACL buffers. This reflects the host-side HCI flow control: the host
-- 
2.52.0


  parent reply	other threads:[~2026-02-20 17:32 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-20 17:31 [PATCH BlueZ v2 01/12] doc/btmon: Add missing documentation Luiz Augusto von Dentz
2026-02-20 17:31 ` [PATCH BlueZ v2 02/12] doc/btmon: Add dedicate sections for timestamp and frame number Luiz Augusto von Dentz
2026-02-20 17:31 ` [PATCH BlueZ v2 03/12] doc/btmon: Add connection tracking section Luiz Augusto von Dentz
2026-02-20 17:31 ` [PATCH BlueZ v2 04/12] doc/btmon: Add a dedicated section for analyze mode Luiz Augusto von Dentz
2026-02-20 17:31 ` [PATCH BlueZ v2 05/12] doc/btmon: Add a section for automated trace analysis Luiz Augusto von Dentz
2026-02-20 17:31 ` [PATCH BlueZ v2 06/12] doc: add btsnoop protocol manpage Luiz Augusto von Dentz
2026-02-20 17:31 ` [PATCH BlueZ v2 07/12] doc/btmon: Add reference to btsnoop documention Luiz Augusto von Dentz
2026-02-20 17:31 ` [PATCH BlueZ v2 08/12] monitor: Annotate ACL/SCO/ISO data with device address Luiz Augusto von Dentz
2026-02-20 17:31 ` [PATCH BlueZ v2 09/12] monitor: Print connection type in Disconnect Complete Luiz Augusto von Dentz
2026-02-20 17:31 ` [PATCH BlueZ v2 10/12] monitor: Add connection lifecycle to analyze summary Luiz Augusto von Dentz
2026-02-20 17:31 ` [PATCH BlueZ v2 11/12] monitor: Prefix data packets with proper type Luiz Augusto von Dentz
2026-02-20 17:31 ` Luiz Augusto von Dentz [this message]
2026-02-20 18:25 ` [BlueZ,v2,01/12] doc/btmon: Add missing documentation bluez.test.bot
2026-02-20 20:20 ` [PATCH BlueZ v2 01/12] " patchwork-bot+bluetooth

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260220173120.3418666-12-luiz.dentz@gmail.com \
    --to=luiz.dentz@gmail.com \
    --cc=linux-bluetooth@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox