adafruit-mirror/arduino-pico
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Allow changing USB HID poll rate (#1771)

Browse source 
Fixes #1769

Add a weak variable that can be overridden by the user to speed up or
slow down the USB HID polling speed.
This commit is contained in:
Earle F. Philhower, III 2023-10-17 04:38:48 -07:00 committed by GitHub
parent d42f0ab4b0
commit ae6847cf78
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
cores/rp2040/RP2040USB.cpp
View file

@ -83,6 +83,8 @@ static int __usb_task_irq;
9, TUSB_DESC_INTERFACE, _itfnum, 0, 0, TUSB_CLASS_VENDOR_SPECIFIC, RESET_INTERFACE_SUBCLASS, RESET_INTERFACE_PROTOCOL, _stridx, 9, TUSB_DESC_INTERFACE, _itfnum, 0, 0, TUSB_CLASS_VENDOR_SPECIFIC, RESET_INTERFACE_SUBCLASS, RESET_INTERFACE_PROTOCOL, _stridx,
int usb_hid_poll_interval __attribute__((weak)) = 10;
const uint8_t *tud_descriptor_device_cb(void) { const uint8_t *tud_descriptor_device_cb(void) {
static tusb_desc_device_t usbd_desc_device = { static tusb_desc_device_t usbd_desc_device = {
.bLength = sizeof(tusb_desc_device_t), .bLength = sizeof(tusb_desc_device_t),
@ -263,7 +265,7 @@ void __SetupUSBDescriptor() {
uint8_t hid_itf = __USBInstallSerial ? 2 : 0; uint8_t hid_itf = __USBInstallSerial ? 2 : 0;
uint8_t hid_desc[TUD_HID_DESC_LEN] = { uint8_t hid_desc[TUD_HID_DESC_LEN] = {
// Interface number, string index, protocol, report descriptor len, EP In & Out address, size & polling interval // Interface number, string index, protocol, report descriptor len, EP In & Out address, size & polling interval
TUD_HID_DESCRIPTOR(hid_itf, 0, HID_ITF_PROTOCOL_NONE, hid_report_len, EPNUM_HID, CFG_TUD_HID_EP_BUFSIZE, 10) TUD_HID_DESCRIPTOR(hid_itf, 0, HID_ITF_PROTOCOL_NONE, hid_report_len, EPNUM_HID, CFG_TUD_HID_EP_BUFSIZE, (uint8_t)usb_hid_poll_interval)
}; };
uint8_t msd_itf = interface_count - 1; uint8_t msd_itf = interface_count - 1;
@ -400,7 +402,7 @@ bool __USBHIDReady() {
while (((millis() - start) < timeout) && tud_ready() && !tud_hid_ready()) { while (((millis() - start) < timeout) && tud_ready() && !tud_hid_ready()) {
tud_task(); tud_task();
delay(1); delayMicroseconds(1);
} }
return tud_hid_ready(); return tud_hid_ready();
} }

17
docs/usb.rst
View file

@ -14,13 +14,28 @@ from the IDE.
The Arduino-Pico core includes ported versions of the basic Arduino The Arduino-Pico core includes ported versions of the basic Arduino
``Keyboard``, ``Mouse`` and ``Joystick`` libraries. These libraries ``Keyboard``, ``Mouse`` and ``Joystick`` libraries. These libraries
allow you to emulate a keyboard, a gamepad or mouse (or all together) allow you to emulate a keyboard, a gamepad or mouse (or all together)
with the Pico in your sketches. with the Pico in your sketches. These libraries only are available
when using the built-in USB, not the Adafruit library.
See the examples and Arduino Reference at See the examples and Arduino Reference at
https://www.arduino.cc/reference/en/language/functions/usb/keyboard/ https://www.arduino.cc/reference/en/language/functions/usb/keyboard/
and and
https://www.arduino.cc/reference/en/language/functions/usb/mouse https://www.arduino.cc/reference/en/language/functions/usb/mouse
HID Polling Interval
--------------------
By default, HID devices will request to be polled every 10ms (i.e. 100x
per second). If you have a higher performance need, you can override
this value by creating a global variable in your main application, set
to the polling period:
.. code:: cpp
int usb_hid_poll_interval = 1; // Set HID poll interval to 1ms (1kHz)
void setup() {
....
}
Adafruit TinyUSB Arduino Support Adafruit TinyUSB Arduino Support
-------------------------------- --------------------------------
Examples are provided in the Adafruit_TinyUSB_Arduino for the more Examples are provided in the Adafruit_TinyUSB_Arduino for the more