[PATCH v2 BlueZ 7/7] isotest: Add documentation

Luiz Augusto von Dentz
2022-05-06T22:18:36Z

This adds isotest.rst which documents the modes and options of
isotest(1) and is then converted isotest.1 manpage.
---
Makefile.tools | 4 +-
tools/isotest.rst | 202 ++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 204 insertions(+), 2 deletions(-)
create mode 100644 tools/isotest.rst

diff --git a/Makefile.tools b/Makefile.tools
index 3e949c00c..3c5766728 100644
--- a/Makefile.tools
+++ b/Makefile.tools
@@ -320,7 +320,7 @@ profiles_iap_iapd_SOURCES = profiles/iap/main.c
profiles_iap_iapd_LDADD = gdbus/libgdbus-internal.la $(GLIB_LIBS) $(DBUS_LIBS)

if MANPAGES
-man_MANS += tools/rctest.1 tools/l2ping.1 tools/btattach.1
+man_MANS += tools/rctest.1 tools/l2ping.1 tools/btattach.1 tools/isotest.1
endif

if MESH
@@ -438,7 +438,7 @@ manual_pages += tools/hciattach.1 tools/hciconfig.1 \
tools/hcitool.1 tools/hcidump.1 \
tools/rfcomm.1 tools/sdptool.1 tools/ciptool.1 \
tools/rctest.1 tools/l2ping.1 tools/btattach.1 \
- tools/bdaddr.1
+ tools/bdaddr.1 tools/isotest.1

if HID2HCI
udevdir = $(UDEV_DIR)
diff --git a/tools/isotest.rst b/tools/isotest.rst
new file mode 100644
index 000000000..b2f4e4b38
--- /dev/null
+++ b/tools/isotest.rst
@@ -0,0 +1,202 @@
+=======
+isotest
+=======
+
+-----------
+ISO testing
+-----------
+
+:Authors: - Luiz Augusto Von Dentz <luiz.von.dentz@intel.com>
+:Version: BlueZ
+:Copyright: Free use of this software is granted under ther terms of the GNU
+ Lesser General Public Licenses (LGPL).
+:Date: May 4, 2022
+:Manual section: 1
+:Manual group: Linux System Administration
+
+SYNOPSIS
+========
+
+**isotest** <*MODE*> [*OPTIONS*] [*bdaddr*] [*bdaddr1*]...
+
+DESCRIPTION
+===========
+
+**isotest(1)** is used to test Isochronous (CIS/BIS) communications on the
+BlueZ stack
+
+MODES
+=====
+
+-d, --dump=[FILE] Listen and dump incoming data
+ (CIS server/BIS broadcaster) and optionally save the
+ contents to *FILE*.
+
+-c, --reconnect Reconnect (CIS client).
+
+-m, --multiple Multiple connects (CIS client).
+
+-r, --receive=[FILE] Receive (CIS server/BIS broadcast receiver) and
+ optionally save the contents to *FILE*.
+
+-s, --send=[FILE] Connect and send (CIS client/BIS broadcaster), can
+ optionally use contents from *FILE*.
+
+-n, --silent Connect and be silent (CIS client/BIS broadcaster).
+
+OPTIONS
+=======
+
+-b, --bytes=<SIZE> Send or Receive packet size
+
+-i, --index=<NUM> Select the specified HCI device index. *hciNUM* is
+ also acceptable.
+
+-j, --jitter=<JITTER> Socket jitter buffer.
+
+-h, --help
+
+-q, --quiet Disables packet logging.
+
+-t, --timeout=<USEC> Socket send timeout.
+
+-C, --continue Continuously send packets starting over in case of a
+ file.
+
+-W, --defer= Enable deferred setup.
+
+-M, --mtu=<SDU> Socket QoS SDU.
+
+-S, --sca/adv-interval=<SCA/INTERVAL>
+ Socket QoS CIS SCA/BIS advertising interval.
+
+-P, --packing=<PACKING> Socket QoS Packing.
+
+.. list-table::
+ :header-rows: 1
+ :widths: auto
+ :stub-columns: 1
+ :align: left
+
+ * - *PACKING*
+ - Description
+
+ * - **0x00**
+ - Sequential
+
+ * - **0x01**
+ - Interleaved
+
+-F, --framing=<FRAMING> Socket QoS Framing.
+
+.. list-table::
+ :header-rows: 1
+ :widths: auto
+ :stub-columns: 1
+ :align: left
+
+ * - *FRAMING*
+ - Description
+
+ * - **0x00**
+ - Unframed
+
+ * - **0x01**
+ - Framed
+
+-I, --interval=<USEC> Socket QoS Interval.
+
+-L, --latency=<MSEC> Socket QoS Latency.
+
+-Y, --phy=<PHY> Socket QoS PHY.
+
+.. list-table::
+ :header-rows: 1
+ :widths: auto
+ :stub-columns: 1
+ :align: left
+
+ * - *PHY*
+ - Description
+
+ * - **0x01**
+ - LE 1M
+
+ * - **0x02**
+ - LE 2M
+
+ * - **0x03**
+ - LE Coded
+
+-R, --rtn=<NUM> Socket QoS retransmissions.
+
+-B, --preset=<PRESET> Socket QoS preset.
+
+-G, --CIG/BIG=<ID> Socket QoS CIG/BIG ID.
+
+-T, --CIS/BIS=<ID> Socket QoS CIS/BIS ID.
+
+-V, --type=<TYPE> Socket destination address type:
+
+.. list-table::
+ :header-rows: 1
+ :widths: auto
+ :stub-columns: 1
+ :align: left
+
+ * - *TYPE*
+ - Description
+
+ * - **le_public**
+ - LE Public Address
+
+ * - **le_random**
+ - LE Random Address
+
+EXAMPLES
+========
+
+Unicast Central
+---------------
+
+.. code-block::
+
+ $ tools/isotest -s XX:XX:XX:XX:XX:XX
+
+Unicast Central connecting to 2 peers using CIG 0x01
+----------------------------------------------------
+
+.. code-block::
+
+ $ tools/isotest -G 0x01 -s XX:XX:XX:XX:XX:XX YY:YY:YY:YY:YY:YY
+
+Unicast Peripheral
+------------------
+
+.. code-block::
+
+ $ tools/isotest -d
+
+Broadcaster
+-----------
+
+.. code-block::
+
+ $ tools/isotest -s 00:00:00:00:00:00
+
+Broadcast Receiver using hci1
+-----------------------------
+
+.. code-block::
+
+ $ tools/isotest -i hci1 -d XX:XX:XX:XX:XX:XX
+
+RESOURCES
+=========
+
+http://www.bluez.org
+
+REPORTING BUGS
+==============
+
+linux-bluetooth@vger.kernel.org
--
2.35.1