From 146680d625bb2238a84c01dee118351efb5ede4e Mon Sep 17 00:00:00 2001 From: "graham.sanderson@raspberrypi.com" Date: Fri, 4 Jun 2021 08:41:47 -0500 Subject: [PATCH] update usb example info in README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++------ 1 file changed, 35 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2409848..3a5f4a6 100644 --- a/README.md +++ b/README.md @@ -176,18 +176,47 @@ App|Description ### USB Device +#### TinyUSB Examples + +All but one of the USB device examples come directly from the TinyUSB device examples directory [here](https://github.com/hathach/tinyusb/tree/master/examples/device). +Those that are supported on RP2040 devices are automatically included as part of the pico-examples +build as targets named `tinyusb_dev_`, e.g. https://github.com/hathach/tinyusb/tree/master/examples/device/hid_composite +is built as `tinyusb_dev_hid_composite`. + +At the time of writing, these examples are available: + +- tinyusb_dev_audio_4_channel_mic +- tinyusb_dev_audio_test +- tinyusb_dev_board_test +- tinyusb_dev_cdc_dual_ports +- tinyusb_dev_cdc_msc +- tinyusb_dev_dfu +- tinyusb_dev_dfu_runtime +- tinyusb_dev_dynamic_configuration +- tinyusb_dev_hid_composite +- tinyusb_dev_hid_generic_inout +- tinyusb_dev_hid_multiple_interface +- tinyusb_dev_midi_test +- tinyusb_dev_msc_dual_lun +- tinyusb_dev_uac2_headset +- tinyusb_dev_usbtmc +- tinyusb_dev_webusb_serial + +#### Low Level examples App|Description ---|--- -[dev_audio_headset](usb/device/dev_audio_headset) | Audio headset example from TinyUSB -[dev_hid_composite](usb/device/dev_hid_composite) | Composite HID (mouse + keyboard) example from TinyUSB -[dev_hid_generic_inout](usb/device/dev_hid_generic_inout) | Generic HID device example from TinyUSB [dev_lowlevel](usb/device/dev_lowlevel) | A USB Bulk loopback implemented with direct access to the USB hardware (no TinyUSB) ### USB Host -App|Description ----|--- -[host_hid](usb/host/host_hid) | Use USB in host mode to poll an attached HID keyboard (TinyUSB example) +All the USB host examples come directly from the TinyUSB host examples directory [here](https://github.com/hathach/tinyusb/tree/master/examples/host). +Those that are supported on RP2040 devices are automatically included as part of the pico-examples +build as targets named `tinyusb_host_`, e.g. https://github.com/hathach/tinyusb/tree/master/examples/host/cdc_msc_hid +is built as `tinyusb_host_cdc_msc_hid`. + +At the time of writing, there is only one host example available: + +- tinyusb_host_cdc_msc_hid ### Watchdog