include: bluetooth: Deprecate bt_hci_bus enumeration #95062
Conversation
zephyrbot
added
Release Notes
zephyrbot
requested review from
alwa-nordic,
cfriedt,
cvinayak,
HaavardRei,
hermabe,
HoZHel,
jhedberg,
kartben,
PavelVPV,
sjanc and
Thalley
include/zephyr/drivers/bluetooth.h
Outdated
| @@ -87,7 +87,7 @@ enum bt_hci_bus { | |||
| #define BT_DT_HCI_NAME_GET(node_id) DT_PROP_OR(node_id, bt_hci_name, "HCI") | |||
| #define BT_DT_HCI_NAME_INST_GET(inst) BT_DT_HCI_NAME_GET(DT_DRV_INST(inst)) | |||
|
|
|||
| #define BT_DT_HCI_BUS_GET(node_id) DT_ENUM_IDX_OR(node_id, bt_hci_bus, BT_HCI_BUS_VIRTUAL) | |||
| #define BT_DT_HCI_BUS_GET(node_id) DT_ENUM_IDX_OR(node_id, bt_hci_bus, 0) | |||
There was a problem hiding this comment.
Instead of 0 here, I expect that DT has generated defines for the enum? Something like DT_PROP__BT_HCI_BUS__ENUM__VIRTUAL. But I can't find anything like this. @jhedberg Do you know?
There was a problem hiding this comment.
Wouldn't the easiest thing be to just add default: "virtual" to the binding?
There was a problem hiding this comment.
I did try this initially, but it raise a device tree error. Every yaml file, that includes bt-hci.yaml, has already a default.
devicetree error: renesas,bt-hci-da1469x.yaml (in 'bt-hci-bus'): 'default' from included file overwritten ('virtual' replaced with 'ipc')
I could remove every default from the bindings and make sure that it is included in the dts files but it will introduce a lot of changes which are not related to PR's goal.
There was a problem hiding this comment.
Good point. I didn't realize that since I just tried to build combo where both were "virtual". How about required: true?
There was a problem hiding this comment.
Yes, that will work. Let me update the PR.
There was a problem hiding this comment.
Needs to go to migration guide though, in case someone has an out of tree binding that didn't specify a bus.
There was a problem hiding this comment.
I spoke too soon. It seems that required: doesn't take into account default: from the bindings.
Also this one will introduce a lot of changes.
There was a problem hiding this comment.
Ugh.. ok. Then I'd just leave a single define for the virtual value in the header rather than a hard-coded 0.
ydamigos
force-pushed
the
bluetooth-deprecate-bt-hci-bus-enum
branch
from
6877804 to
9b604a7
Compare
include/zephyr/drivers/bluetooth.h
Outdated
| @@ -87,6 +87,7 @@ enum bt_hci_bus { | |||
| #define BT_DT_HCI_NAME_GET(node_id) DT_PROP_OR(node_id, bt_hci_name, "HCI") | |||
| #define BT_DT_HCI_NAME_INST_GET(inst) BT_DT_HCI_NAME_GET(DT_DRV_INST(inst)) | |||
|
|
|||
| #define BT_HCI_BUS_VIRTUAL (0) | |||
There was a problem hiding this comment.
Hmm, isn't there a risk of some static analyzer warning about this since the enum has the same name? Another option would have been:
/* Fallback default when there's no property, same as "virtual" */
#define BT_HCI_BUS_DEFAULT 0There was a problem hiding this comment.
You could also use the _PRIV_ infix, which will eventually become a guideline for private APIs (see #89765), so #define BT_PRIV_HCI_BUS_DEFAULT (not sure if that's overkill, but the idea is that this define is really only supposed to be for the DT macro in this header file and for nothing else.
There was a problem hiding this comment.
You are right. I forgot that I only deprecated it and I did not remove it.
ydamigos
force-pushed
the
bluetooth-deprecate-bt-hci-bus-enum
branch
from
9b604a7 to
29caf1e
Compare
bt_hci_bus enumeration is not used anymore. This commit deprecates it. Signed-off-by: Ioannis Damigos <[email protected]>
Document deprecation of bt_hci_bus enumeration in v4.3 release notes. Signed-off-by: Ioannis Damigos <[email protected]>
ydamigos
force-pushed
the
bluetooth-deprecate-bt-hci-bus-enum
branch
from
29caf1e to
649ff9a
Compare
|
Deprecate
bt_hci_busenumeration as discussed in #94810 (comment).