espressif_tinyusb/README.md

# tinyusb

tinyusb is an cross-platform open-source USB Host/Device stack for embedded system.

![tinyusb](https://user-images.githubusercontent.com/249515/49858616-f60c9700-fe27-11e8-8627-e76936352ff7.png)

Folder  | Description
-----   | -------------
docs    | Documentation
examples| Sample applications are kept with Makefile and Segger Embedded build support
hw/bsp  | Source files of supported boards
hw/mcu  | Low level mcu core & peripheral drivers (e.g CMSIS )
lib     | Source files from 3rd party such as freeRTOS, fatfs etc ...
src     | All sources files for tinyusb stack itself.
tests   | Unit tests for the stack
tools   | Files used internally

## Device Stack

- Human Interface Device (HID): Keyboard, Mouse, Generic
- Communication Class (CDC)
- Mass Storage Class (MSC)

## Host Stack

** Most active development is on the Device stack. The Host stack is under rework and largely untested.**

- Human Interface Device (HID): Keyboard, Mouse, Generic
- Mass Storage Class (MSC)
- Hub currently only support 1 level of hub (due to my laziness)

## OS Abtraction layer

Currently the following OS are supported with tinyusb out of the box with a simple change of **CFG_TUSB_OS** macro.

- **No OS**
- **FreeRTOS**
- **MyNewt** (work in progress)

## Supported MCUs

The stack supports the following MCUs

  - **NXP:** LPC11Uxx, LPC13xx, LPC175x_6x, LPC177x_8x, LPC40xx, LPC43xx
  - **MicroChip:** SAMD21, SAMD51 (device only)
  - **Nordic:** nRF52840

[Here is the list of supported Boards](hw/bsp/readme.md)

## Compiler & IDE

The stack is developed with GCC compiler, and should be compilable with others. However, it requires C99 to build with. Folder `examples` provide Makefile and Segger Embedded Studio build support.

## Getting Started

[Here is the details for getting started](docs/getting_started.md) with the stack.

## Uses

TinyUSB is currently used by these other projects:

* [Adafruit nRF52 Arduino](https://github.com/adafruit/Adafruit_nRF52_Arduino)
* [CircuitPython](https://github.com/adafruit/circuitpython)
* [nRF52840 UF2 Bootloader](https://github.com/adafruit/Adafruit_nRF52_Bootloader)

## Porting

Want to help add TinyUSB support for a new MCU? Read [here](docs/porting.md) for an explanation on the low-level API needed by TinyUSB.

## License

BSD license for all tinyusb sources [Full license is here](tinyusb/license.md) and most of the code base. However each file/folder is individually licensed especially those in `lib` and `hw/mcu` folder. Please make sure you understand all the license term for files you use in your project.
docs update 2018-12-12 10:35:53 +01:00			`# tinyusb`
Initial commit 2012-11-26 07:24:01 +01:00
docs update 2018-12-12 10:35:53 +01:00			`tinyusb is an cross-platform open-source USB Host/Device stack for embedded system.`
update md 2014-03-28 11:50:30 +01:00
docs update 2018-12-12 10:35:53 +01:00			`![tinyusb](https://user-images.githubusercontent.com/249515/49858616-f60c9700-fe27-11e8-8627-e76936352ff7.png)`
update md 2014-03-28 11:50:30 +01:00
docs update 2018-12-12 10:35:53 +01:00			`Folder \| Description`
			`----- \| -------------`
			`docs \| Documentation`
			`examples\| Sample applications are kept with Makefile and Segger Embedded build support`
			`hw/bsp \| Source files of supported boards`
			`hw/mcu \| Low level mcu core & peripheral drivers (e.g CMSIS )`
			`lib \| Source files from 3rd party such as freeRTOS, fatfs etc ...`
			`src \| All sources files for tinyusb stack itself.`
			`tests \| Unit tests for the stack`
			`tools \| Files used internally`
update md 2014-03-28 11:50:30 +01:00
docs update 2018-12-12 10:35:53 +01:00			`## Device Stack`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
docs update 2018-12-12 10:35:53 +01:00			`- Human Interface Device (HID): Keyboard, Mouse, Generic`
Add a porting doc and make a pass over the others. Fixes #5 2018-11-28 03:07:22 +01:00			`- Communication Class (CDC)`
update project file 2014-03-25 10:42:34 +01:00			`- Mass Storage Class (MSC)`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
docs update 2018-12-12 10:35:53 +01:00			`## Host Stack`
Add a porting doc and make a pass over the others. Fixes #5 2018-11-28 03:07:22 +01:00
docs update 2018-12-12 10:35:53 +01:00			` Most active development is on the Device stack. The Host stack is under rework and largely untested.`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
docs update 2018-12-12 10:35:53 +01:00			`- Human Interface Device (HID): Keyboard, Mouse, Generic`
update project file 2014-03-25 10:42:34 +01:00			`- Mass Storage Class (MSC)`
Add a porting doc and make a pass over the others. Fixes #5 2018-11-28 03:07:22 +01:00			`- Hub currently only support 1 level of hub (due to my laziness)`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
docs update 2018-12-12 10:35:53 +01:00			`## OS Abtraction layer`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
docs update 2018-12-12 10:35:53 +01:00			`Currently the following OS are supported with tinyusb out of the box with a simple change of CFG_TUSB_OS macro.`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
docs update 2018-12-12 10:35:53 +01:00			`- No OS`
documenting on the way 2013-05-08 07:23:25 +02:00			`- FreeRTOS`
docs update 2018-12-12 10:35:53 +01:00			`- MyNewt (work in progress)`
doc work, comment out \subpage command in markdown result 2014-04-17 07:02:03 +02:00
docs update 2018-12-12 10:35:53 +01:00			`## Supported MCUs`
doc work, comment out \subpage command in markdown result 2014-04-17 07:02:03 +02:00
docs update 2018-12-12 10:35:53 +01:00			`The stack supports the following MCUs`
doc work, comment out \subpage command in markdown result 2014-04-17 07:02:03 +02:00
docs update 2018-12-12 10:35:53 +01:00			`- NXP: LPC11Uxx, LPC13xx, LPC175x_6x, LPC177x_8x, LPC40xx, LPC43xx`
			`- MicroChip: SAMD21, SAMD51 (device only)`
			`- Nordic: nRF52840`
markdown documenting 2014-03-25 18:00:53 +01:00
docs update 2018-12-12 10:35:53 +01:00			`[Here is the list of supported Boards](hw/bsp/readme.md)`
clean up 2018-06-19 10:08:31 +02:00
docs update 2018-12-12 10:35:53 +01:00			`## Compiler & IDE`
markdown documenting 2014-03-25 18:00:53 +01:00
docs update 2018-12-12 10:35:53 +01:00			The stack is developed with GCC compiler, and should be compilable with others. However, it requires C99 to build with. Folder `examples` provide Makefile and Segger Embedded Studio build support.
documenting with markdown 2014-03-26 09:42:34 +01:00
docs update 2018-12-12 10:35:53 +01:00			`## Getting Started`
documenting with markdown 2014-03-26 09:42:34 +01:00
docs update 2018-12-12 10:35:53 +01:00			`[Here is the details for getting started](docs/getting_started.md) with the stack.`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
docs update 2018-12-12 10:35:53 +01:00			`## Uses`
Add a porting doc and make a pass over the others. Fixes #5 2018-11-28 03:07:22 +01:00
			`TinyUSB is currently used by these other projects:`

docs update 2018-12-12 10:35:53 +01:00			`* [Adafruit nRF52 Arduino](https://github.com/adafruit/Adafruit_nRF52_Arduino)`
Add a porting doc and make a pass over the others. Fixes #5 2018-11-28 03:07:22 +01:00			`* [CircuitPython](https://github.com/adafruit/circuitpython)`
docs update 2018-12-12 10:35:53 +01:00			`* [nRF52840 UF2 Bootloader](https://github.com/adafruit/Adafruit_nRF52_Bootloader)`
Add a porting doc and make a pass over the others. Fixes #5 2018-11-28 03:07:22 +01:00
docs update 2018-12-12 10:35:53 +01:00			`## Porting`
Add a porting doc and make a pass over the others. Fixes #5 2018-11-28 03:07:22 +01:00
docs update 2018-12-12 10:35:53 +01:00			`Want to help add TinyUSB support for a new MCU? Read [here](docs/porting.md) for an explanation on the low-level API needed by TinyUSB.`
Add a porting doc and make a pass over the others. Fixes #5 2018-11-28 03:07:22 +01:00
docs update 2018-12-12 10:35:53 +01:00			`## License`
complete double buffering for queueing xfer for lpc11u/13u requried by msc device 2013-11-14 08:12:07 +01:00
docs update 2018-12-12 10:35:53 +01:00			BSD license for all tinyusb sources [Full license is here](tinyusb/license.md) and most of the code base. However each file/folder is individually licensed especially those in `lib` and `hw/mcu` folder. Please make sure you understand all the license term for files you use in your project.