andy/tinyUSB
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

change REDUCE_SPEED=0/1 to explicitly SPEED=high/full

Browse Source 
update readme, boards.md to add link to new stm boards
This commit is contained in:
hathach
2020-07-08 16:29:48 +07:00
parent f82655a212
commit 0fd074afd8
7 changed files with 58 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
examples/readme.md
View File

@@ -32,28 +32,39 @@ Then compile with `make BOARD=[your_board] all`, for example
$ make BOARD=feather_nrf52840_express all
```
**Port Selection**
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:
If a board has several ports, one port is chosen by default in the individual board.mk file. Use option `PORT=x` To choose another port. For example to select the HS port of a STM32F746Disco board, use:
```
$ make BOARD=stm32f746disco PORT=1 all
```
### Debug Log
**Port Speed**
### Log Level
A MCU can support multiple operational speed. By default, the example build system will use the fastest supported on the board. Use option `SPEED=full/high` e.g To force F723 operate at full instead of default high speed
```
$ make BOARD=stm32f746disco SPEED=full all
```
### Debug
To compile for debugging with debug symbols add `DEBUG=1`, for example
```
$ make BOARD=feather_nrf52840_express DEBUG=1 all
```
#### Log
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
$ make BOARD=feather_nrf52840_express LOG=2 all
```
### Logger
#### 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:
@@ -67,8 +78,8 @@ By default log message is printed via on-board UART which is slow and take lots
- 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
$ make BOARD=feather_nrf52840_express LOG=2 LOGGER=rtt all
$ make BOARD=feather_nrf52840_express LOG=2 LOGGER=swo all
```
## Flash