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:
parent
21356bc7f6
commit
0b8e56120c
5 changed files with 41 additions and 12 deletions
4
doc/build/dts/api/api.rst
vendored
4
doc/build/dts/api/api.rst
vendored
|
|
@ -386,8 +386,8 @@ device.
|
||||||
:ref:`bluetooth-hci-uart-sample`
|
:ref:`bluetooth-hci-uart-sample`
|
||||||
* - zephyr,bt-mon-uart
|
* - zephyr,bt-mon-uart
|
||||||
- Sets UART device used for the Bluetooth monitor logging
|
- Sets UART device used for the Bluetooth monitor logging
|
||||||
* - zephyr,bt-uart
|
* - zephyr,bt-hci
|
||||||
- Sets UART device used by Bluetooth
|
- Selects the HCI device used by the Bluetooth host stack
|
||||||
* - zephyr,canbus
|
* - zephyr,canbus
|
||||||
- Sets the default CAN controller
|
- Sets the default CAN controller
|
||||||
* - zephyr,ccm
|
* - zephyr,ccm
|
||||||
|
|
|
||||||
|
|
@ -177,9 +177,9 @@ driver instead of the built-in controller:
|
||||||
|
|
||||||
CONFIG_BT_HCI=y
|
CONFIG_BT_HCI=y
|
||||||
CONFIG_BT_CTLR=n
|
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
|
.. code-block:: dts
|
||||||
|
|
||||||
|
|
@ -187,6 +187,14 @@ Similarly, the `zephyr,bt-uart` DTS property selects which uart to use:
|
||||||
chosen {
|
chosen {
|
||||||
zephyr,console = &uart0;
|
zephyr,console = &uart0;
|
||||||
zephyr,shell-uart = &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";
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
|
||||||
|
|
@ -177,9 +177,9 @@ driver instead of the built-in controller:
|
||||||
|
|
||||||
CONFIG_BT_HCI=y
|
CONFIG_BT_HCI=y
|
||||||
CONFIG_BT_CTLR=n
|
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
|
.. code-block:: dts
|
||||||
|
|
||||||
|
|
@ -187,6 +187,14 @@ Similarly, the `zephyr,bt-uart` DTS property selects which uart to use:
|
||||||
chosen {
|
chosen {
|
||||||
zephyr,console = &uart0;
|
zephyr,console = &uart0;
|
||||||
zephyr,shell-uart = &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";
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
|
||||||
|
|
@ -143,9 +143,9 @@ driver instead of the built-in controller:
|
||||||
|
|
||||||
CONFIG_BT_HCI=y
|
CONFIG_BT_HCI=y
|
||||||
CONFIG_BT_CTLR=n
|
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
|
.. code-block:: dts
|
||||||
|
|
||||||
|
|
@ -153,6 +153,14 @@ Similarly, the `zephyr,bt-uart` DTS property selects which uart to use:
|
||||||
chosen {
|
chosen {
|
||||||
zephyr,console = &uart0;
|
zephyr,console = &uart0;
|
||||||
zephyr,shell-uart = &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,7 +6,7 @@
|
||||||
|
|
||||||
/ {
|
/ {
|
||||||
chosen {
|
chosen {
|
||||||
zephyr,bt-uart = &lpuart3;
|
zephyr,bt-hci = &bt_hci_uart;
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
@ -14,4 +14,9 @@
|
||||||
status = "okay";
|
status = "okay";
|
||||||
current-speed = <3000000>;
|
current-speed = <3000000>;
|
||||||
hw-flow-control;
|
hw-flow-control;
|
||||||
|
|
||||||
|
bt_hci_uart: bt_hci_uart {
|
||||||
|
compatible = "zephyr,bt-hci-uart";
|
||||||
|
status = "okay";
|
||||||
|
};
|
||||||
};
|
};
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue