djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix sHID report doc and API

This commit is contained in:
Dan Halbert 2021-05-03 20:53:31 -04:00
parent be7b2b00a8
commit 5b5de4b92e
2 changed files with 18 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
shared-bindings/usb_hid/Device.c
View File

@ -39,7 +39,7 @@
//| mouse.send_report()""" //| mouse.send_report()"""
//| //|
//| def __init__(self, *, descriptor: ReadableBuffer, usage_page: int, usage: int, in_report_length: int, out_report_length: Optional[int], report_id_index: Optional[int]) -> None: //| def __init__(self, *, descriptor: ReadableBuffer, usage_page: int, usage: int, in_report_length: int, out_report_length: int = 0, report_id_index: Optional[int]) -> None:
//| """Create a description of a USB HID device. To create an actual device, //| """Create a description of a USB HID device. To create an actual device,
//| pass a `Device` to `usb_hid.configure_usb()`. //| pass a `Device` to `usb_hid.configure_usb()`.
//| //|
@ -50,7 +50,7 @@
//| :param int in_report_length: Size in bytes of the HID report sent to the host. //| :param int in_report_length: Size in bytes of the HID report sent to the host.
//| "In" is with respect to the host. //| "In" is with respect to the host.
//| :param int out_report_length: Size in bytes of the HID report received from the host. //| :param int out_report_length: Size in bytes of the HID report received from the host.
//| "Out" is with respect to the host. If no reports are expected, use ``None``. //| "Out" is with respect to the host. If no reports are expected, use 0.
//| :param int report_id_index: position of byte in descriptor that contains the Report ID. //| :param int report_id_index: position of byte in descriptor that contains the Report ID.
//| A Report ID will be assigned when the device is created. If there is no //| A Report ID will be assigned when the device is created. If there is no
//| Report ID, use ``None``. //| Report ID, use ``None``.
@ -66,8 +66,8 @@ STATIC mp_obj_t usb_hid_device_make_new(const mp_obj_type_t *type, size_t n_args
{ MP_QSTR_usage_page, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT }, { MP_QSTR_usage_page, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT },
{ MP_QSTR_usage, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT }, { MP_QSTR_usage, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT },
{ MP_QSTR_in_report_length, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT }, { MP_QSTR_in_report_length, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_INT },
{ MP_QSTR_out_report_length, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none } }, { MP_QSTR_out_report_length, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_int = 0 } },
{ MP_QSTR_report_id_index, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none } }, { MP_QSTR_report_id_index, MP_ARG_KW_ONLY | MP_ARG_REQUIRED | MP_ARG_OBJ, {.u_obj = mp_const_none } },
}; };
mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)]; mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
@ -95,27 +95,24 @@ STATIC mp_obj_t usb_hid_device_make_new(const mp_obj_type_t *type, size_t n_args
} }
const uint8_t in_report_length = in_report_length_arg; const uint8_t in_report_length = in_report_length_arg;
const mp_obj_t out_report_length_arg = args[ARG_out_report_length].u_obj; const mp_int_t out_report_length_arg = args[ARG_out_report_length].u_int;
if (out_report_length_arg == mp_const_none) { if (out_report_length_arg <= 0 || out_report_length_arg > 255) {
self->out_report_length = 0; mp_raise_ValueError_varg(translate("%q must be 1-255"), MP_QSTR_out_report_length);
} else if (!mp_obj_is_small_int(out_report_length_arg) ||
MP_OBJ_SMALL_INT_VALUE(out_report_length_arg) <= 0 ||
MP_OBJ_SMALL_INT_VALUE(out_report_length_arg) > 255) {
mp_raise_ValueError_varg(translate("%q must be None or 1-255"), MP_QSTR_out_report_length);
} }
uint8_t out_report_length = MP_OBJ_SMALL_INT_VALUE(out_report_length_arg); const uint8_t out_report_length = out_report_length_arg;
const mp_obj_t report_id_index_arg = args[ARG_report_id_index].u_obj; const mp_obj_t report_id_index_arg = args[ARG_report_id_index].u_obj;
if (report_id_index_arg == mp_const_none) { uint8_t report_id_index = 0;
self->report_id_index = 0; if (report_id_index_arg != mp_const_none) {
} else if (!mp_obj_is_small_int(report_id_index_arg) || const mp_int_t report_id_index_int = mp_obj_int_get_checked(report_id_index_arg);
MP_OBJ_SMALL_INT_VALUE(report_id_index_arg) <= 0 || if (report_id_index_int <= 0 || report_id_index_int > 255) {
MP_OBJ_SMALL_INT_VALUE(report_id_index_arg) > 255) { mp_raise_ValueError_varg(translate("%q must be None or 1-255"), MP_QSTR_report_id_index);
mp_raise_ValueError_varg(translate("%q must be None or 1-255"), MP_QSTR_report_id_index); }
report_id_index = report_id_index_int;
} }
uint8_t report_id_index = MP_OBJ_SMALL_INT_VALUE(report_id_index_arg);
common_hal_usb_hid_device_construct(self, descriptor, usage_page, usage, in_report_length, out_report_length, report_id_index); common_hal_usb_hid_device_construct(
self, descriptor, usage_page, usage, in_report_length, out_report_length, report_id_index);
return (mp_obj_t)self; return (mp_obj_t)self;
} }

2
shared-module/usb_hid/__init__.c
View File

@ -204,7 +204,7 @@ void usb_hid_build_report_descriptor(uint8_t *report_descriptor_space, size_t re
usb_hid_device_obj_t *device = &hid_devices[i]; usb_hid_device_obj_t *device = &hid_devices[i];
// Copy the report descriptor for this device. // Copy the report descriptor for this device.
if (hid_devices_num == 1) { if (hid_devices_num == 1) {
// Theres only one device, so it shouldn't have a report ID. // There's only one device, so it shouldn't have a report ID.
// Copy the descriptor, but splice out the report id indicator and value (2 bytes). // Copy the descriptor, but splice out the report id indicator and value (2 bytes).
memcpy(report_descriptor_start, device->report_descriptor, device->report_id_index - 1); memcpy(report_descriptor_start, device->report_descriptor, device->report_id_index - 1);
report_descriptor_start += device->report_id_index - 1; report_descriptor_start += device->report_id_index - 1;