Skip to content

Commit 464ccb5

Browse files
authored
Merge pull request #9836 from dhalbert/hid-boot-device-doc-update
update usb_hid boot device documentation
2 parents 0dc6e0f + 0cc0da0 commit 464ccb5

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

shared-bindings/usb_hid/__init__.c

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,16 @@ MP_DEFINE_CONST_FUN_OBJ_0(usb_hid_disable_obj, usb_hid_disable);
6565
//|
6666
//| **Boot Devices**
6767
//|
68-
//| Boot devices implement a fixed, predefined report descriptor, defined in
69-
//| https://www.usb.org/sites/default/files/hid1_12.pdf, Appendix B. A USB host
70-
//| can request to use the boot device if the USB device says it is available.
71-
//| Usually only a BIOS or other kind of limited-functionality
72-
//| host needs boot keyboard support.
68+
//| A USB HID boot device implements a fixed, predefined report descriptor,
69+
//| as defined in https://www.usb.org/sites/default/files/hid1_12.pdf, Appendix B.
70+
//| Currently the only HID boot devices defined in the USB specification are a keyboard and a mouse.
71+
//| A USB host can ask a USB device to use a boot device if the USB device says it is available.
72+
//| Usually only a limited-functionality host like a BIOS or other boot-time software
73+
//| needs boot device support.
7374
//|
7475
//| For example, to make a boot keyboard available, you can use this code::
7576
//|
76-
//| usb_hid.enable((Device.KEYBOARD), boot_device=1) # 1 for a keyboard
77+
//| usb_hid.enable((Device.KEYBOARD,), boot_device=1) # 1 for a keyboard, 2 for a mouse
7778
//|
7879
//| If the host requests the boot keyboard, the report descriptor provided by `Device.KEYBOARD`
7980
//| will be ignored, and the predefined report descriptor will be used.

0 commit comments

Comments
 (0)