Skip to content

Commit

Permalink
pkg/tinyusb: update doc for common descriptors
Browse files Browse the repository at this point in the history
With PR RIOT-OS#18835, the automatic generation of descriptors for the most common device classes and their handling was introduced. The update of the documentation was forgotten.
  • Loading branch information
gschorcht authored and Einhornhool committed Jan 24, 2023
1 parent edfce3a commit 322f2c2
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions pkg/tinyusb/doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,45 @@
* INCLUDES += -I$(APPDIR)
* ```
*
* Implement required device descriptors and descriptor callbacks as well as
* the callbacks of the enabled classes.
* Implement the callbacks of the enabled classes.
*
* For most common device classes and their configuration, the tinyUSB
* package automatically generates the required descriptors and descriptor
* callbacks for any combination of
* - up to two interfaces of the class CDC ACM,
* - up to two interfaces of the Generic In/Out HID class,
* - up to one MSC device interface and,
* - up to one interface of the Vendor device class.
*
* Any other combination, either a different number of these device class
* interfaces or the use of a different device class interface, requires the
* implementation of custom descriptors and the callbacks.
*
* All symbols of the generated descriptors and their callback functions are
* defined as weak symbols so that the application can override parts of the
* descriptors or the callback functions that handle them. For example, the
* array `tusb_desc_hid_0_report`, which defines the HID report descriptor for
* HID device 0, making the device a generic in/out HID device
*
* ```c
* __attribute__((weak))
* uint8_t const tusb_desc_hid_0_report[] =
* {
* TUD_HID_REPORT_DESC_GENERIC_INOUT(CONFIG_TUSBD_HID_EP_SIZE),
* };
* ```
*
* could be overridden by the application with
*
* ```c
* uint8_t const tusb_desc_hid_0_report[] =
* {
* TUD_HID_REPORT_DESC_KEYBOARD(HID_REPORT_ID(REPORT_ID_KEYBOARD)),
* TUD_HID_REPORT_DESC_MOUSE(HID_REPORT_ID(REPORT_ID_MOUSE)),
* };
* ```
*
* to make the device to be a composite keyboard/mouse device.
*
* Please refer `$RIOTBASE/tests/pkg_tinyusb_cdc_msc` and the
* [tinyUSB documentation](https://docs.tinyusb.org/en/latest/reference/getting_started.html)
Expand Down

0 comments on commit 322f2c2

Please sign in to comment.