History

Uwe Bonnes 62239bb576 cdc-acm: Use 512 bytes when in HS mode. Removes error: config 1 interface 2 altsetting 0 bulk endpoint 0x3 has invalid maxpacket 64 while enumerationg.		2020-06-30 11:02:41 +02:00
..
device	cdc-acm: Use 512 bytes when in HS mode.	2020-06-30 11:02:41 +02:00
host/cdc_msc_hid	clean up	2020-03-11 14:13:34 +07:00
obsolete/host	add TU_ prefix to compiler ATTR to prevent name conflict with application	2019-06-06 10:39:37 +07:00
make.mk	enable -Wcast-align	2020-05-17 14:24:15 +07:00
readme.md	Add Stm32F7xxdisco board support files	2020-06-30 11:02:38 +02:00
rules.mk	added esp32s2 kaluga bsp	2020-06-29 16:52:08 +07:00

readme.md

Examples

Clone this repo

$ git clone https://github.com/hathach/tinyusb tinyusb
$ cd tinyusb

Fetch submodule MCUs drivers

TinyUSB examples includes external repos aka submodules to provide low-level MCU peripheral's driver to compile with. Therefore we will firstly fetch those mcu driver repo by running this command in the top folder repo

$ git submodule update --init --recursive

It will takes a bit of time due to the number of supported MCUs, luckily we only need to do this once. Or if you only want to test with a specific mcu, you could only update its driver submodule

Build

Here is the list of supported Boards that should work out of the box with provided examples (hopefully). To build example, first change directory to example folder.

$ cd examples/device/cdc_msc

Then compile with make BOARD=[your_board] all, for example

$ make BOARD=feather_nrf52840_express all

To compile for debugging with debug symbols add DEBUG=1, for example

$ make BOARD=feather_nrf52840_express DEBUG=1 all
If a board has several ports, one port is choosen by default in the individual board.mk file. Choose another port with PORT=x. For example to select the HS port of a STM32F746Disco board, use:

$ make BOARD=stm32f746disco PORT=1 all


### Debug Log

### Log Level

Should you have an issue running example and/or submitting an bug report. You could enable TinyUSB built-in debug logging with optional `LOG=`. LOG=1 will only print out error message, LOG=2 print more information with on-going events. LOG=3 or higher is not used yet.

$ make LOG=2 BOARD=feather_nrf52840_express all


### Logger

By default log message is printed via on-board UART which is slow and take lots of CPU time comparing to USB speed. If your board support on-board/external debugger, it would be more efficient to use it for logging. There are 2 protocols: 

- `LOGGER=rtt`: use [Segger RTT protocol](https://www.segger.com/products/debug-probes/j-link/technology/about-real-time-transfer/)   
  - Cons: requires jlink as the debugger.
  - Pros: work with most if not all MCUs
  - Software viewer is JLink RTT Viewer/Client/Logger which is bundled with JLink driver package.
- `LOGGER=swo`: Use dedicated SWO pin of ARM Cortex SWD debug header.
  - Cons: only work with ARM Cortex MCUs minus M0
  - Pros: should be compatible with more debugger that support SWO.
  - Software viewer should be provided along with your debugger driver.

$ make LOG=2 LOGGER=rtt BOARD=feather_nrf52840_express all $ make LOG=2 LOGGER=swo BOARD=feather_nrf52840_express all


## Flash

`flash` target will use the default on-board debugger (jlink/cmsisdap/stlink/dfu) to flash the binary, please install those support software in advance. Some board use bootloader/DFU via serial which is required to pass to make command

$ make BOARD=feather_nrf52840_express flash $ make SERIAL=/dev/ttyACM0 BOARD=feather_nrf52840_express flash


Since jlink can be used with most of the boards, there is also `flash-jlink` target for your convenience.

$ make BOARD=feather_nrf52840_express flash-jlink


Some board use uf2 bootloader for drag & drop in to mass storage device, uf2 can be generated with `uf2` target

$ make BOARD=feather_nrf52840_express all uf2