Add quirk for reading BD_ADDR from fwnode property
Subsystems (6)
v2 cover Add quirk for reading BD_ADDR from fwnode property
On some systems the Bluetooth Device Address (BD_ADDR) isn't stored on the Bluetooth chip itself. One way to configure the address is through the device tree (patched in by the bootloader). The btqcomsmd driver is an example, it can read the address from the DT property 'local-bd-address'.
To avoid redundant open-coded reading of 'local-bd-address' and error handling this series adds the quirk HCI_QUIRK_USE_BDADDR_PROPERTY to retrieve the BD address of a device from the DT and adapts the btqcomsmd and hci_qca drivers to use this quirk.
First post: https://lore.kernel.org/patchwork/project/lkml/list/?series=370982
Matthias Kaehlcke (3):
Bluetooth: Add quirk for reading BD_ADDR from fwnode property
Bluetooth: btqcomsmd: use HCI_QUIRK_USE_BDADDR_PROPERTY
Bluetooth: hci_qca: Set HCI_QUIRK_USE_BDADDR_PROPERTY for wcn3990
drivers/bluetooth/btqcomsmd.c | 29 +++------------------- drivers/bluetooth/hci_qca.c | 1 + include/net/bluetooth/hci.h | 12 ++++++++++ net/bluetooth/hci_core.c | 45 +++++++++++++++++++++++++++++++++++ net/bluetooth/mgmt.c | 6 +++-- 5 files changed, 65 insertions(+), 28 deletions(-)
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH RESEND v2 1/3 Bluetooth: Add quirk for reading BD_ADDR from fwnode property
Add HCI_QUIRK_USE_BDADDR_PROPERTY to allow controllers to retrieve the public Bluetooth address from the firmware node property 'local-bd-address'. If quirk is set and the property does not exist or is invalid the controller is marked as unconfigured.
---
Changes in v2:
- added check for return value of ->setup()
- only read BD_ADDR from the property if it isn't assigned yet. This is needed to support configuration from user space
- refactored the branch of the new quirk to get rid of 'bd_addr_set'
- added 'Reviewed-by: Balakrishna Godavarthi <[email protected]>' tag
--- include/net/bluetooth/hci.h | 12 ++++++++++ net/bluetooth/hci_core.c | 45 +++++++++++++++++++++++++++++++++++++ net/bluetooth/mgmt.c | 6 +++-- 3 files changed, 61 insertions(+), 2 deletions(-)
include/net/bluetooth/hci.h +12 -0
@@ -158,6 +158,18 @@ enum {*/ HCI_QUIRK_INVALID_BDADDR , +/* When this quirk is set, the public Bluetooth address +* initially reported by HCI Read BD Address command +* is considered invalid. The public BD Address can be +* specified in the fwnode property 'local-bd-address'. +* If this property does not exist or is invalid controller +* configuration is required before this device can be used. +* +* This quirk can be set before hci_register_dev is called or +* during the hdev->setup vendor callback. +*/ + HCI_QUIRK_USE_BDADDR_PROPERTY, +/* When this quirk is set, the duplicate filtering during * scanning is based on Bluetooth devices addresses. To allow * RSSI based updates, restart scanning if needed.
net/bluetooth/hci_core.c +45 -0
63 lines not on this page · raw message
net/bluetooth/mgmt.c +4 -2
@@ -551,7 +551,8 @@ static bool is_configured(struct hci_dev *hdev) !hci_dev_test_flag(hdev, HCI_EXT_CONFIGURED))return false; -if (test_bit (HCI_QUIRK_INVALID_BDADDR , &hdev->quirks) && +if ((test_bit (HCI_QUIRK_INVALID_BDADDR , &hdev->quirks) || +test_bit (HCI_QUIRK_USE_BDADDR_PROPERTY , &hdev->quirks)) && !bacmp (&hdev->public_addr,BDADDR_ANY ))return false;
@@ -566,7 +567,8 @@ static __le32 get_missing_options(struct hci_dev *hdev) !hci_dev_test_flag(hdev, HCI_EXT_CONFIGURED)) options |=MGMT_OPTION_EXTERNAL_CONFIG ; -if (test_bit (HCI_QUIRK_INVALID_BDADDR , &hdev->quirks) && +if ((test_bit (HCI_QUIRK_INVALID_BDADDR , &hdev->quirks) || +test_bit (HCI_QUIRK_USE_BDADDR_PROPERTY , &hdev->quirks)) && !bacmp (&hdev->public_addr,BDADDR_ANY )) options |=MGMT_OPTION_PUBLIC_ADDRESS ;
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
A message that is not in the archive (sent off-list or not yet received): [email protected]
Re: [PATCH RESEND v2 1/3] Bluetooth: Add quirk for reading BD_ADDR from fwnode property
Hi Marcel,
thanks for the review!
Quoted 80 lines · Marcel Holtmann
Quoted 80 lines
Add
HCI_QUIRK_USE_BDADDR_PROPERTYto allow controllers to retrieve the public Bluetooth address from the firmware node property 'local-bd-address'. If quirk is set and the property does not exist or is invalid the controller is marked as unconfigured.Signed-off-by Matthias Kaehlcke <[email protected]>Reviewed-by Balakrishna Godavarthi <[email protected]>---
Changes in v2:
- added check for return value of ->setup()
- only readBD_ADDRfrom the property if it isn't assigned yet. This is needed to support configuration from user space
- refactored the branch of the new quirk to get rid of 'bd_addr_set'
- added 'Reviewed-by: Balakrishna Godavarthi <[email protected]>' tag
---include/net/bluetooth/hci.h | 12 ++++++++++ net/bluetooth/hci_core.c | 45 +++++++++++++++++++++++++++++++++++++ net/bluetooth/mgmt.c | 6 +++-- 3 files changed, 61 insertions(+), 2 deletions(-)include/net/bluetooth/hci.h +12
-0@@ -158,6 +158,18 @@ enum {*/ HCI_QUIRK_INVALID_BDADDR , +/* When this quirk is set, the public Bluetooth address +* initially reported by HCI Read BD Address command +* is considered invalid. The public BD Address can be +* specified in the fwnode property 'local-bd-address'. +* If this property does not exist or is invalid controller +* configuration is required before this device can be used. +* +* This quirk can be set before hci_register_dev is called or +* during the hdev->setup vendor callback. +*/ + HCI_QUIRK_USE_BDADDR_PROPERTY, +/* When this quirk is set, the duplicate filtering during * scanning is based on Bluetooth devices addresses. To allow * RSSI based updates, restart scanning if needed. net/bluetooth/hci_core.c +21
-0@@ -30,6 +30,7 @@#include <linux/rfkill.h> #include <linux/debugfs.h> #include <linux/crypto.h> +#include <linux/property.h> #include <asm/unaligned.h> #include <net/bluetooth/bluetooth.h> @@ -1355,6 +1356,36 @@ int hci_inquiry(void __user *arg)return err; } +/** +* hci_dev_get_bd_addr_from_property - Get the Bluetooth Device Address +* (BD_ADDR) for a HCI device from +* a firmware node property. +* @hdev: The HCI device +* +* Search the firmware node for 'local-bd-address'. +* +* All-zero BD addresses are rejected, because those could be properties +* that exist in the firmware tables, but were not updated by the firmware. For +* example, the DTS could define 'local-bd-address', with zero BD addresses. +*/ +static int hci_dev_get_bd_addr_from_property (struct hci_dev *hdev) +{ +struct fwnode_handle *fwnode =dev_fwnode (hdev->dev.parent); +bdaddr_t ba; +int ret; + + ret =fwnode_property_read_u8_array (fwnode,"local-bd-address" , + (u8 *)&ba,sizeof (ba));
Quoted 8 lines
net/bluetooth/hci_core.c int hci_inquiry(void __user *arg) · line 1384
Quoted 6 lines
net/bluetooth/hci_core.c +6
-0+if (ret <0 ) +return ret; +if (!bacmp (&ba,BDADDR_ANY )) +return -ENODATA ; + + hdev->public_addr = ba;this needs to use bacpy btw.
will change
Quoted 5 lines
net/bluetooth/hci_core.c int hci_inquiry(void __user *arg) · line 1387
Quoted 3 lines
net/bluetooth/hci_core.c +3
-0+ +return 0 ; +}Make this void since the return value is actually not used right now.
ok
Quoted 8 lines
Quoted 8 lines
net/bluetooth/hci_core.c +1
-0+static int hci_dev_do_open (struct hci_dev *hdev) {int ret =0 ;@@ -1422,6 +1453,20 @@ static int hci_dev_do_open(struct hci_dev *hdev)if (hdev->setup) ret = hdev->setup (hdev);
Quoted 10 lines
net/bluetooth/hci_core.c static int hci_dev_do_open(struct hci_dev *hdev) · line 1461
Quoted 6 lines
net/bluetooth/hci_core.c +6
-0+if (ret) + goto setup_failed; + +if (test_bit (HCI_QUIRK_USE_BDADDR_PROPERTY , &hdev->quirks)) { +if (!bacmp (&hdev->public_addr,BDADDR_ANY )) +hci_dev_get_bd_addr_from_property (hdev);So I would move the
bacmp()intohci_dev_get_bd_addr_from_property. Mainly since you also write the field there.
Personally I'm not a fan of functions that pretend to do something and then do it conditionally, IMO it obscures the actual code flow.
I'm open to change it though if you have a strong preference for not having the check in hci_dev_do_open().
Quoted 7 lines
net/bluetooth/hci_core.c static int hci_dev_do_open(struct hci_dev *hdev) · line 1467
Quoted 5 lines
net/bluetooth/hci_core.c +5
-0+if (!bacmp (&hdev->public_addr,BDADDR_ANY ) || + !hdev->set_bdaddr || + hdev->set_bdaddr (hdev, &hdev->public_addr)) +hci_dev_set_flag (hdev,HCI_UNCONFIGURED ); + }So this one I don’t like since it makes my brain hurt when I have to read it and understand it.
I agree, it's an ugly construct.
Quoted 9 lines
I think this needs to be like this:
if (bacmp(&hdev->public_addr, BDADDR_ANY) && hdev->set_bdaddr) ret = hdev->set_bdaddr(hdev, &hdev->public_addr); else err = -EADDRNOTAVAIL;That will fail the power on procedure which is the right thing to do if the local-bd-address is not present. The driver decided that it should be in DT and so enforce that.
Ok, will change as suggested.
Thanks
Matthias
PATCH RESEND v2 2/3 Bluetooth: btqcomsmd: use HCI_QUIRK_USE_BDADDR_PROPERTY
In reply to Matthias KaehlckeUse the HCI_QUIRK_USE_BDADDR_PROPERTY quirk to let the HCI core handle the reading of 'local-bd-address'. With this there is no need to set HCI_QUIRK_INVALID_BDADDR, the case of a non-existing or invalid fwnode property is handled by the core code.
---
I couldn't actually test the changes in this driver since I don't have a device with this controller. Could someone from Qualcomm help with this?
Changes in v2:
- removed now unused field 'bdaddr' from struct btqcomsmd
- added 'Reviewed-by: Balakrishna Godavarthi <[email protected]>' tag
--- drivers/bluetooth/btqcomsmd.c | 29 +++-------------------------- 1 file changed, 3 insertions(+), 26 deletions(-)
drivers/bluetooth/btqcomsmd.c +3 -26
@@ -28,7 +28,6 @@struct btqcomsmd {struct hci_dev *hdev; -bdaddr_t bdaddr;struct rpmsg_endpoint *acl_channel;struct rpmsg_endpoint *cmd_channel; };
@@ -125,23 +124,10 @@ static int btqcomsmd_setup(struct hci_dev *hdev)return PTR_ERR (skb);kfree_skb (skb); -/* Devices do not have persistent storage for BD address. If no -* BD address has been retrieved during probe, mark the device -* as having an invalid BD address. +/* Devices do not have persistent storage for BD address. Retrieve +* it from the firmware node property. */ -if (!bacmp (&btq->bdaddr,BDADDR_ANY )) { -set_bit (HCI_QUIRK_INVALID_BDADDR , &hdev->quirks); -return 0 ; - } - -/* When setting a configured BD address fails, mark the device -* as having an invalid BD address. -*/ - err =qca_set_bdaddr_rome (hdev, &btq->bdaddr); -if (err) { -set_bit (HCI_QUIRK_INVALID_BDADDR , &hdev->quirks); -return 0 ; - } +set_bit (HCI_QUIRK_USE_BDADDR_PROPERTY , &hdev->quirks);return 0 ; }
@@ -169,15 +155,6 @@ static int btqcomsmd_probe(struct platform_device *pdev)if (IS_ERR (btq->cmd_channel))return PTR_ERR (btq->cmd_channel); -/* The local-bd-address property is usually injected by the -* bootloader which has access to the allocated BD address. -*/ -if (!of_property_read_u8_array (pdev->dev.of_node,"local-bd-address" , - (u8 *)&btq->bdaddr,sizeof (bdaddr_t))) { -dev_info (&pdev->dev,"BD address %pMR retrieved from device-tree" , - &btq->bdaddr); - } - hdev =hci_alloc_dev ();if (!hdev)return -ENOMEM ;
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog
PATCH RESEND v2 3/3 Bluetooth: hci_qca: Set HCI_QUIRK_USE_BDADDR_PROPERTY for wcn3990
In reply to Matthias KaehlckeSet quirk for wcn3990 to read BD_ADDR from a firmware node property.
---
Changes in v2:
- patch added to the series
tested with https://lore.kernel.org/patchwork/patch/1003830
("Bluetooth: hci_qca: Add helper to set device address.")
--- drivers/bluetooth/hci_qca.c | 1 + 1 file changed, 1 insertion(+)
drivers/bluetooth/hci_qca.c +1 -0
@@ -1193,6 +1193,7 @@ static int qca_setup(struct hci_uart *hu)* setup for every hci up. */ set_bit (HCI_QUIRK_NON_PERSISTENT_SETUP , &hdev->quirks); +set_bit (HCI_QUIRK_USE_BDADDR_PROPERTY , &hdev->quirks); hu->hdev->shutdown = qca_power_off; ret =qca_wcn3990_init (hu);if (ret)
Signature · 1 line
2.20.0.rc1.387.gf8505762e3-goog