adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

usb: device_next: rename the rate properties to use the correct unit

Browse source 
The polling properties are a period in us but are named as "-rate" right
now, which would imply that that's a frequency. Rename them to
"period-us" to make that unambiguous.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
This commit is contained in:
Fabio Baltieri 2024-06-06 17:19:40 +01:00 committed by Anas Nashif
parent 5098bf3539
commit 2c5b09cbda
7 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
dts/bindings/usb/zephyr,hid-device.yaml
View file

@ -36,11 +36,11 @@ properties:
The size of the longest input report that the HID device can generate.
This property is used to determine the buffer length used for transfers.
in-polling-rate:
in-polling-period-us:
type: int
required: true
description: |
Input or output type reports polling rate in microseconds. For USB full
Input or output type reports polling period in microseconds. For USB full
speed this could be clamped to 1ms or 255ms depending on the value.
out-report-size:
@ -50,9 +50,9 @@ properties:
When this property is present, a USB device will use out pipe for output
reports, otherwise control pipe will be used for output reports.
out-polling-rate:
out-polling-period-us:
type: int
description: |
Output type reports polling rate in microseconds. For USB full
Output type reports polling period in microseconds. For USB full
speed this could be clamped to 1ms or 255ms depending on the value.
This option is only effective if the out-report-size property is defined.

2
samples/subsys/usb/hid-keyboard/app.overlay
View file

@ -10,6 +10,6 @@
interface-name = "HID0";
protocol-code = "keyboard";
in-report-size = <64>;
in-polling-rate = <1000>;
in-polling-period-us = <1000>;
};
};

2
samples/subsys/usb/hid-keyboard/large_in_report.overlay
View file

@ -9,6 +9,6 @@
compatible = "zephyr,hid-device";
interface-name = "HID0";
in-report-size = <256>;
in-polling-rate = <1000>;
in-polling-period-us = <1000>;
};
};

2
samples/subsys/usb/hid-keyboard/large_out_report.overlay
View file

@ -10,6 +10,6 @@
hid_dev_0: hid_dev_0 {
compatible = "zephyr,hid-device";
out-report-size = <128>;
out-polling-rate = <16000>;
out-polling-period-us = <16000>;
};
};

2
samples/subsys/usb/hid-keyboard/out_report.overlay
View file

@ -10,6 +10,6 @@
hid_dev_0: hid_dev_0 {
compatible = "zephyr,hid-device";
out-report-size = <64>;
out-polling-rate = <16000>;
out-polling-period-us = <16000>;
};
};

2
samples/subsys/usb/hid-mouse/usbd_next.overlay
View file

@ -9,7 +9,7 @@
compatible = "zephyr,hid-device";
interface-name = "HID0";
protocol-code = "none";
in-polling-rate = <1000>;
in-polling-period-us = <1000>;
in-report-size = <64>;
};
};

16
subsys/usb/device_next/class/usbd_hid_macros.h
View file

@ -1056,16 +1056,16 @@
HID_MPS_LESS_65(DT_INST_PROP(n, in_report_size)))
/* Get IN endpoint polling rate based on the desired speed. */
#define HID_IN_EP_INTERVAL(n, hs) \
COND_CODE_1(hs, \
(USB_HS_INT_EP_INTERVAL(DT_INST_PROP(n, in_polling_rate))), \
(USB_FS_INT_EP_INTERVAL(DT_INST_PROP(n, in_polling_rate))))
#define HID_IN_EP_INTERVAL(n, hs) \
COND_CODE_1(hs, \
(USB_HS_INT_EP_INTERVAL(DT_INST_PROP(n, in_polling_period_us))), \
(USB_FS_INT_EP_INTERVAL(DT_INST_PROP(n, in_polling_period_us))))
/* Get OUT endpoint polling rate based on the desired speed. */
#define HID_OUT_EP_INTERVAL(n, hs) \
COND_CODE_1(hs, \
(USB_HS_INT_EP_INTERVAL(DT_INST_PROP(n, out_polling_rate))),\
(USB_FS_INT_EP_INTERVAL(DT_INST_PROP(n, out_polling_rate))))
#define HID_OUT_EP_INTERVAL(n, hs) \
COND_CODE_1(hs, \
(USB_HS_INT_EP_INTERVAL(DT_INST_PROP(n, out_polling_period_us))), \
(USB_FS_INT_EP_INTERVAL(DT_INST_PROP(n, out_polling_period_us))))
/* Get the number of endpoints, which can be either 1 or 2 */
#define HID_NUM_ENDPOINTS(n) \