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 <johan.hedberg@silabs.com>
This commit is contained in:
Johan Hedberg 2024-06-07 10:32:19 +03:00 committed by Anas Nashif
parent 21356bc7f6
commit 0b8e56120c
5 changed files with 41 additions and 12 deletions

View file

@ -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

View file

@ -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";
};
};

View file

@ -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";
};
};

View file

@ -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";
};
};

View file

@ -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";
};
};