Add support for Zephyr HCI VSC set TX power command #258

mogenson · 2023-08-25T16:56:53Z

Add HCI Zephyr vendor commands to read and write TX power

Create platforms/zephyr/hci.py with definitions of vendor HCI commands
to read and write TX power.

Add documentation for how to prepare an nRF52840 dongle with a Zephyr
HCI USB firmware application that includes dynamic TX power support and
how to send a write TX power vendor HCI command from Bumble

barbibulle · 2023-08-30T00:09:36Z

README.md

@@ -63,3 +63,23 @@ This is not an official Google product.
 This library is in alpha and will be going through a lot of breaking changes. While releases will be stable enough for prototyping, experimentation and research, we do not recommend using it in any production environment yet.
 Expect bugs and sharp edges.
 Please help by trying it out, reporting bugs, and letting us know what you think!
+
+# TX Power Control for nrf52840 dongles


Maybe this doc should live in a section under docs/mkdocs/src (maybe platforms/zephyr.md?) rather than the top-level README, which should remain very generic.

barbibulle · 2023-08-30T00:10:30Z

bumble/hci.py

@@ -557,6 +557,13 @@ def phy_list_to_bits(phys):
 HCI_LE_SET_DEFAULT_SUBRATE_COMMAND                                       = hci_command_op_code(0x08, 0x007D)
 HCI_LE_SUBRATE_REQUEST_COMMAND                                           = hci_command_op_code(0x08, 0x007E)

+# Vendor specific HCI commands
+HCI_VSC_TX_POWER_HANDLE_TYPE_ADV = 0x00


Those 3 constants should be class members of the HCI_VSC_Write_Tx_Power_Level_Command class I think.

barbibulle · 2023-08-30T00:14:53Z

bumble/hci.py

+        ('selected_tx_power_level', -1),
+    ],
+)
+class HCI_VSC_Write_Tx_Power_Level_Command(HCI_Command):


Is there a doc/spec we can point to for this vendor command?

barbibulle · 2023-08-30T00:18:58Z

hci_usb.zip

We should find a way to host this type of pre-built firmware images on the static pages rather than in the Git repo.

mogenson · 2023-08-30T00:45:05Z

Hi @barbibulle thanks for the comments. The vendor HCI command for TX power is here: https://github.com/zephyrproject-rtos/zephyr/blob/a15e7d2326d9e8896401be479fae56f30dde71bb/include/zephyr/bluetooth/hci_vs.h#L163

However, I'm going to close this PR because I don't think it makes sense to have vendor commands for specific hardware that require custom built firmware as part of Bumble. I will add the definition for these commands at the application level for our Python project. I just wanted to use this PR to demonstrate the feasibility of setting TX power.

barbibulle · 2023-08-30T02:29:44Z

Actually, I think it would be great to make these HCI commands and tool extension part of the main project. I’m sure others will find it useful, even if Nordic/Zephyr specific.

mogenson · 2023-08-30T12:39:15Z

Ok then! Is a vendor command section of hci.py a good location to place these command definitions?

Is any sort of Device level API needed, or is host.send_command() good enough?

Should we gate the presence of these commands with some sort of parameter in a device.json config file?

barbibulle · 2023-08-30T14:13:59Z

It might be good to put the vendor HCI packet definitions in their own file. Maybe hci_vendor.py or hci_vsc.py. I’d leave it as low level commands for now. For normal HCI commands, there’s a way to query the controller if the command is supported, but I don’t know of a way to do that for vendor commands (the answer comes in the form of a long bit mask, so not extensible to custom extensions). It’s probably safe to let users decide if they want/need to send those commands, and let them catch errors if they send the command to a controller without knowing if their controller supports it. Since the high level APIs would not send those commands directly, we wouldn’t need a config entry to enable/disable them.

barbibulle · 2023-08-31T00:24:14Z

It might be good to put the vendor HCI packet definitions in their own file. Maybe hci_vendor.py or hci_vsc.py.

I will push a PR for review with a structure and supporting functions for separating vendor HCI commands in discrete modules.

mogenson · 2023-08-31T01:02:52Z

I will push a PR for review with a structure and supporting functions for separating vendor HCI commands in discrete modules.

Great thanks!!

uael · 2023-09-01T06:09:11Z

It might be good to put the vendor HCI packet definitions in their own file. Maybe hci_vendor.py or hci_vsc.py. I’d leave it as low level commands for now. For normal HCI commands, there’s a way to query the controller if the command is supported, but I don’t know of a way to do that for vendor commands (the answer comes in the form of a long bit mask, so not extensible to custom extensions). It’s probably safe to let users decide if they want/need to send those commands, and let them catch errors if they send the command to a controller without knowing if their controller supports it. Since the high level APIs would not send those commands directly, we wouldn’t need a config entry to enable/disable them.

I suggest to put them in their own files like in bumble/vendor/{zephyr,rtk}.py and for ex. with realtek use the commands in bumble/drivers/rtk.py

barbibulle · 2023-09-07T03:08:54Z

It might be good to put the vendor HCI packet definitions in their own file. Maybe hci_vendor.py or hci_vsc.py. I’d leave it as low level commands for now. For normal HCI commands, there’s a way to query the controller if the command is supported, but I don’t know of a way to do that for vendor commands (the answer comes in the form of a long bit mask, so not extensible to custom extensions). It’s probably safe to let users decide if they want/need to send those commands, and let them catch errors if they send the command to a controller without knowing if their controller supports it. Since the high level APIs would not send those commands directly, we wouldn’t need a config entry to enable/disable them.

I suggest to put them in their own files like in bumble/vendor/{zephyr,rtk}.py and for ex. with realtek use the commands in bumble/drivers/rtk.py

PR up for review: #269

mogenson · 2023-09-08T17:42:22Z

@barbibulle @uael This PR is now ready to be reviewed and can be merged.

I was searching for a good way to host the prebuilt hci_usb.zip file as part of the online docs. I ended up creating a discussion thread here and uploading the file. It appears that there is a static Github URL that can be include in the mkdocs.

Create platforms/zephyr/hci.py with definitions of vendor HCI commands to read and write TX power. Add documentation for how to prepare an nRF52840 dongle with a Zephyr HCI USB firmware application that includes dynamic TX power support and how to send a write TX power vendor HCI command from Bumble.

mogenson · 2023-09-11T14:08:44Z

@barbibulle Changed the Zephyr firmware link to point to downloads/zephyr/hci_usb.zip from PR #276.

barbibulle reviewed Aug 30, 2023

View reviewed changes

mogenson closed this Aug 30, 2023

barbibulle reopened this Aug 30, 2023

mogenson force-pushed the vsc_tx_power branch from fefd911 to ffb9d55 Compare September 8, 2023 17:36

mogenson changed the title ~~DO NOT MERGE. Add support for Zephyr HCI VSC set TX power command~~ Add support for Zephyr HCI VSC set TX power command Sep 8, 2023

mogenson force-pushed the vsc_tx_power branch from ffb9d55 to da02f6a Compare September 11, 2023 14:06

barbibulle approved these changes Sep 12, 2023

View reviewed changes

barbibulle merged commit 56139c6 into google:main Sep 12, 2023
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Zephyr HCI VSC set TX power command #258

Add support for Zephyr HCI VSC set TX power command #258

mogenson commented Aug 25, 2023 •

edited

barbibulle Aug 30, 2023

barbibulle Aug 30, 2023

barbibulle Aug 30, 2023

barbibulle Aug 30, 2023

mogenson commented Aug 30, 2023

barbibulle commented Aug 30, 2023

mogenson commented Aug 30, 2023

barbibulle commented Aug 30, 2023 •

edited

barbibulle commented Aug 31, 2023

mogenson commented Aug 31, 2023 •

edited

uael commented Sep 1, 2023

barbibulle commented Sep 7, 2023

mogenson commented Sep 8, 2023

mogenson commented Sep 11, 2023

Add support for Zephyr HCI VSC set TX power command #258

Add support for Zephyr HCI VSC set TX power command #258

Conversation

mogenson commented Aug 25, 2023 • edited

barbibulle Aug 30, 2023

Choose a reason for hiding this comment

barbibulle Aug 30, 2023

Choose a reason for hiding this comment

barbibulle Aug 30, 2023

Choose a reason for hiding this comment

barbibulle Aug 30, 2023

Choose a reason for hiding this comment

mogenson commented Aug 30, 2023

barbibulle commented Aug 30, 2023

mogenson commented Aug 30, 2023

barbibulle commented Aug 30, 2023 • edited

barbibulle commented Aug 31, 2023

mogenson commented Aug 31, 2023 • edited

uael commented Sep 1, 2023

barbibulle commented Sep 7, 2023

mogenson commented Sep 8, 2023

mogenson commented Sep 11, 2023

mogenson commented Aug 25, 2023 •

edited

barbibulle commented Aug 30, 2023 •

edited

mogenson commented Aug 31, 2023 •

edited