Blob: isotest.rst

Blob id: 44c40f535c48f801aeba15e38424177a1ae1e9e6

Size: 4.2 KB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
=======
isotest
=======

-----------
ISO testing
-----------

:Authors: - Luiz Augusto Von Dentz <luiz.von.dentz@intel.com>
:Version: BlueZ
:Copyright: Free use of this software is granted under the 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=<SEC>        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

-e, --enc=<ENCRYPTION>  Socket QoS BIG Encryption

.. list-table::
   :header-rows: 1
   :widths: auto
   :stub-columns: 1
   :align: left

   * - *ENCRYPTION*
     - Description

   * - **0x00**
     - BIG unencrypted

   * - **0x01**
     - BIG encrypted

-k, --bcode=<BCODE>  Socket QoS Broadcast Code

-N, --nbis=<NBIS>  Number of BISes to create as part of a
                   BIG (BIS broadcaster) or to synchronize
                   to (BIS broadcast receiver)

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