README.rst
1.. _bluetooth_classic_l2cap_client_tests:
2
3Bluetooth Classic L2cap Client Tests
4##################################
5
6Overview
7********
8
9This test suite uses ``bumble`` for testing Bluetooth Classic communication between a host
10PC (running :ref:`Twister <twister_script>`) and a device under test (DUT) running Zephyr.
11
12Prerequisites
13*************
14
15The test suite has the following prerequisites:
16
17* The ``bumble`` library installed on the host PC.
18The Bluetooth Classic controller on PC side is required. Refer to getting started of `bumble`_
19for details.
20
21The HCI transport for ``bumble`` can be configured as follows:
22
23* A specific configuration context can be provided along with the ``usb_hci`` fixture separated by
24 a ``:`` (i.e. specify fixture ``usb_hci:usb:0`` to use the ``usb:0`` as hci transport for
25 ``bumble``).
26* The configuration context can be overridden using the `hci transport`_ can be provided using the
27 ``--hci-transport`` test suite argument (i.e. run ``twister`` with the
28 ``--pytest-args=--hci-transport=usb:0`` argument to use the ``usb:0`` as hci transport for
29 ``bumble``).
30
31Building and Running
32********************
33
34Running on mimxrt1170_evk@B/mimxrt1176/cm7
35==========================================
36
37Running the test suite on :ref:`mimxrt1170_evk` relies on configuration of ``bumble``.
38
39On the host PC, a HCI transport needs to be required. Refer to `bumble platforms`_ page of
40``bumble`` for details.
41c
42For example, on windows, a PTS dongle is used. After `WinUSB driver`_ has been installed,
43the HCI transport would be USB transport interface ``usb:<index>``.
44
45If the HCI transport is ``usb:0`` and debug console port is ``COM4``, the test suite can be
46launched using Twister:
47
48.. code-block:: shell
49
50 west twister -v -p mimxrt1170_evk@B/mimxrt1176/cm7 --device-testing --device-serial COM4 -T tests/bluetooth/classic/l2cap_c -O l2cap_c --force-platform --west-flash --west-runner=jlink -X usb_hci:usb:0
51
52Running on Hardware
53===================c
54
55Running the test suite on hardware requires a HCI transport connected to the host PC.
56
57The test suite can be launched using Twister. Below is an example for running on the
58:zephyr:board:`mimxrt1170_evk@B/mimxrt1176/cm7`:
59
60.. code-block:: shell
61
62 west twister -v -p mimxrt1170_evk@B/mimxrt1176/cm7 --device-testing --device-serial COM4 -T tests/bluetooth/classic/l2cap_c -O l2cap_c --force-platform --west-flash --west-runner=jlink -X usb_hci:usb:0
63
64.. _bumble:
65 https://google.github.io/bumble/getting_started.html
66
67.. _hci transport:
68 https://google.github.io/bumble/transports/index.html
69
70.. _bumble platforms:
71 https://google.github.io/bumble/platforms/index.html
72
73.. _WinUSB driver:
74 https://google.github.io/bumble/platforms/windows.html
75