Commit 0b8e5612 authored by Johan Hedberg's avatar Johan Hedberg Committed by Anas Nashif
Browse files

Bluetooth: doc: Update documentation for the new HCI API

Update references to devicetree chosen properties and how devicetree nodes
should be defined in order to enable the new HCI drivers.

Signed-off-by: default avatarJohan Hedberg <johan.hedberg@silabs.com>
parent 21356bc7
Loading
Loading
Loading
Loading
+2 −2
Changes for doc/build/dts/api/api.rst: 2 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -386,8 +386,8 @@ device.
       :ref:`bluetooth-hci-uart-sample`
   * - zephyr,bt-mon-uart
     - Sets UART device used for the Bluetooth monitor logging
   * - zephyr,bt-uart
     - Sets UART device used by Bluetooth
   * - zephyr,bt-hci
     - Selects the HCI device used by the Bluetooth host stack
   * - zephyr,canbus
     - Sets the default CAN controller
   * - zephyr,ccm
+11 −3
Changes for samples/bluetooth/hci_uart/README.rst: 11 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -177,9 +177,9 @@ driver instead of the built-in controller:

   CONFIG_BT_HCI=y
   CONFIG_BT_CTLR=n
   CONFIG_BT_H4=y

Similarly, the `zephyr,bt-uart` DTS property selects which uart to use:
Similarly, the `zephyr,bt-hci` DTS property selects which HCI instance to use.
The UART needs to have as its child node a HCI UART node:

.. code-block:: dts

@@ -187,6 +187,14 @@ Similarly, the `zephyr,bt-uart` DTS property selects which uart to use:
      chosen {
         zephyr,console = &uart0;
         zephyr,shell-uart = &uart0;
         zephyr,bt-uart = &uart1;
         zephyr,bt-hci = &bt_hci_uart;
      };
   };

   &uart1 {
      status = "okay";
      bt_hci_uart: bt_hci_uart {
         compatible = "zephyr,bt-hci-uart";
         status = "okay";
      };
   };
+11 −3
Changes for samples/bluetooth/hci_uart_3wire/README.rst: 11 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -177,9 +177,9 @@ driver instead of the built-in controller:

   CONFIG_BT_HCI=y
   CONFIG_BT_CTLR=n
   CONFIG_BT_H5=y

Similarly, the `zephyr,bt-uart` DTS property selects which uart to use:
Similarly, the `zephyr,bt-hci` DTS property selects which HCI instance to use.
The UART needs to have as its child node a HCI UART node:

.. code-block:: dts

@@ -187,6 +187,14 @@ Similarly, the `zephyr,bt-uart` DTS property selects which uart to use:
      chosen {
         zephyr,console = &uart0;
         zephyr,shell-uart = &uart0;
         zephyr,bt-uart = &uart1;
         zephyr,bt-hci = &bt_hci_uart;
      };
   };

   &uart1 {
      status = "okay";
      bt_hci_uart: bt_hci_uart {
         compatible = "zephyr,bt-hci-3wire-uart";
         status = "okay";
      };
   };
+11 −3
Changes for samples/bluetooth/hci_uart_async/README.rst: 11 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -143,9 +143,9 @@ driver instead of the built-in controller:

   CONFIG_BT_HCI=y
   CONFIG_BT_CTLR=n
   CONFIG_BT_H4=y

Similarly, the `zephyr,bt-uart` DTS property selects which uart to use:
Similarly, the `zephyr,bt-hci` DTS property selects which HCI instance to use.
The UART needs to have as its child node a HCI UART node:

.. code-block:: dts

@@ -153,6 +153,14 @@ Similarly, the `zephyr,bt-uart` DTS property selects which uart to use:
      chosen {
         zephyr,console = &uart0;
         zephyr,shell-uart = &uart0;
         zephyr,bt-uart = &uart1;
         zephyr,bt-hci = &bt_hci_uart;
      };
   };

   &uart1 {
      status = "okay";
      bt_hci_uart: bt_hci_uart {
         compatible = "zephyr,bt-hci-uart";
         status = "okay";
      };
   };
+6 −1
Changes for tests/bluetooth/shell/boards/mimxrt1060_evk.overlay: 6 added lines, 1 removed line.
Original line number Diff line number Diff line
@@ -6,7 +6,7 @@

/ {
	chosen {
		zephyr,bt-uart = &lpuart3;
		zephyr,bt-hci = &bt_hci_uart;
	};
};

@@ -14,4 +14,9 @@
	status = "okay";
	current-speed = <3000000>;
	hw-flow-control;

	bt_hci_uart: bt_hci_uart {
		compatible = "zephyr,bt-hci-uart";
		status = "okay";
	};
};