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: Johan Hedberg <[email protected]>
andak · Jun 11, 2024 · 0b8e561 · 0b8e561
1 parent 21356bc
commit 0b8e561
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 12 deletions.
diff --git a/doc/build/dts/api/api.rst b/doc/build/dts/api/api.rst
@@ -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

diff --git a/samples/bluetooth/hci_uart/README.rst b/samples/bluetooth/hci_uart/README.rst
@@ -177,16 +177,24 @@ 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
 
    / {
       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";
       };
    };
diff --git a/samples/bluetooth/hci_uart_3wire/README.rst b/samples/bluetooth/hci_uart_3wire/README.rst
@@ -177,16 +177,24 @@ 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
 
    / {
       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";
       };
    };
diff --git a/samples/bluetooth/hci_uart_async/README.rst b/samples/bluetooth/hci_uart_async/README.rst
@@ -143,16 +143,24 @@ 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
 
    / {
       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";
       };
    };
diff --git a/tests/bluetooth/shell/boards/mimxrt1060_evk.overlay b/tests/bluetooth/shell/boards/mimxrt1060_evk.overlay
@@ -6,12 +6,17 @@
 
 / {
 	chosen {
-		zephyr,bt-uart = &lpuart3;
+		zephyr,bt-hci = &bt_hci_uart;
 	};
 };
 
 &lpuart3 {
 	status = "okay";
 	current-speed = <3000000>;
 	hw-flow-control;
+
+	bt_hci_uart: bt_hci_uart {
+		compatible = "zephyr,bt-hci-uart";
+		status = "okay";
+	};
 };