From patchwork Thu Jun 30 22:14:52 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luiz Augusto von Dentz X-Patchwork-Id: 586643 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 11549CCA473 for ; Thu, 30 Jun 2022 22:15:09 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230268AbiF3WPH (ORCPT ); Thu, 30 Jun 2022 18:15:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39998 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230305AbiF3WPG (ORCPT ); Thu, 30 Jun 2022 18:15:06 -0400 Received: from mail-pj1-x1033.google.com (mail-pj1-x1033.google.com [IPv6:2607:f8b0:4864:20::1033]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 02CF948821 for ; Thu, 30 Jun 2022 15:15:05 -0700 (PDT) Received: by mail-pj1-x1033.google.com with SMTP id b12-20020a17090a6acc00b001ec2b181c98so4521884pjm.4 for ; Thu, 30 Jun 2022 15:15:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=pf1spZWRVVmzlCkdIoNQHP94yvKyL48SphUGzWr78oI=; b=OOb/HwCB9rPlqRxA2AZtPvldPiz/E1l0YkXYif4aCB90ZpWBfZpkLR4yc+gylXMnAc X5TtIIA+aN3sATuwVR5abOtrv+49SyquRvnN00A9Oz0nrV1APeLJUvGdfjjTks+RvMEL yZQvzEgB9lYTOk2Q1ErRQ67e8v8UKRVUKeSHSYgru5XsVDCfGkRmyONRyOyOUl5ToRX+ RJ2tmOhoklxLjLSk2KVKlwr5hiJvfuWaczAm9ABxxzNPOTWLDaZ2iUEia5eNkn9gcj+V kTO6WH0IiDDezrjcvl1ID5iwsgv6nJWRqBAA3Z7BGfvvJPQ1jMIcjFrxeuXzH0LiKADr rxiQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=pf1spZWRVVmzlCkdIoNQHP94yvKyL48SphUGzWr78oI=; b=d+PPiORuWfKLiQpXY4yBouyx6eTEpdcICdYpc3MfWVLAilH60N7tk1/8jNOKf2BBY4 lU+/v5/DE5QVu5zw0JqnBR6X6hxZv1NZmJaz+bwvuQ+/j3eO/WXKB+NI9MzkumShk907 6dYMMZ/rKPaLLWyD3zPpJ6typjRYUI1RasNatDytZ/Es2+bU2aQo+7BmLORMKvAIC7FW nigVFS4S8xtJ0ToWGCVWItGD3JdBNCWsrXpjcduGiPv8upflHQbuZy5V7Xz5F7unJaqP 9YwlBhxVxIvrGNxPCQM5S1MKeZ8CJUzgHDx29TghxW4i7wRWt1lDoKofLpA+zVBFDNF+ IV0Q== X-Gm-Message-State: AJIora+7hVNHElNrrQ7z40GbZAGTHPlyeTOkQESUzwP8SXb1TuGe3JWz M0HfM6xsQYis7tNXR/NnVzyqR2zFwX1hpQ== X-Google-Smtp-Source: AGRyM1srPdslVCYlz8ybPPG+m+RrioU1EN4spyXS0G3ZyAqKgXwXeeQLw2xDJ4wInLtK49S3sAZe1w== X-Received: by 2002:a17:902:7604:b0:16a:f36d:73f3 with SMTP id k4-20020a170902760400b0016af36d73f3mr16879996pll.170.1656627303941; Thu, 30 Jun 2022 15:15:03 -0700 (PDT) Received: from lvondent-mobl4.. (c-71-56-157-77.hsd1.or.comcast.net. [71.56.157.77]) by smtp.gmail.com with ESMTPSA id me3-20020a17090b17c300b001ec84b0f199sm3460333pjb.1.2022.06.30.15.15.02 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 30 Jun 2022 15:15:03 -0700 (PDT) From: Luiz Augusto von Dentz To: linux-bluetooth@vger.kernel.org Subject: [BlueZ PATCH v8 8/8] isotest: Add documentation Date: Thu, 30 Jun 2022 15:14:52 -0700 Message-Id: <20220630221452.638591-8-luiz.dentz@gmail.com> X-Mailer: git-send-email 2.35.3 In-Reply-To: <20220630221452.638591-1-luiz.dentz@gmail.com> References: <20220630221452.638591-1-luiz.dentz@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-bluetooth@vger.kernel.org From: Luiz Augusto von Dentz 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 4e5ff73b0..9412aed36 100644 --- a/Makefile.tools +++ b/Makefile.tools @@ -325,7 +325,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 @@ -443,7 +443,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 +: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= Send or Receive packet size + +-i, --index= Select the specified HCI device index. *hciNUM* is + also acceptable. + +-j, --jitter= Socket jitter buffer. + +-h, --help + +-q, --quiet Disables packet logging. + +-t, --timeout= Socket send timeout. + +-C, --continue Continuously send packets starting over in case of a + file. + +-W, --defer= Enable deferred setup. + +-M, --mtu= Socket QoS SDU. + +-S, --sca/adv-interval= + Socket QoS CIS SCA/BIS advertising interval. + +-P, --packing= Socket QoS Packing. + +.. list-table:: + :header-rows: 1 + :widths: auto + :stub-columns: 1 + :align: left + + * - *PACKING* + - Description + + * - **0x00** + - Sequential + + * - **0x01** + - Interleaved + +-F, --framing= Socket QoS Framing. + +.. list-table:: + :header-rows: 1 + :widths: auto + :stub-columns: 1 + :align: left + + * - *FRAMING* + - Description + + * - **0x00** + - Unframed + + * - **0x01** + - Framed + +-I, --interval= Socket QoS Interval. + +-L, --latency= Socket QoS Latency. + +-Y, --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= Socket QoS retransmissions. + +-B, --preset= Socket QoS preset. + +-G, --CIG/BIG= Socket QoS CIG/BIG ID. + +-T, --CIS/BIS= Socket QoS CIS/BIS ID. + +-V, --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