esp32-s2_dfu/readme.markdown

# tinyusb

## What Is tinyusb

tinyusb is an open-source (BSD-licensed) USB Host/Device/OTG stack for embedded micro-controller. It is developed using [Test-Driven Development (TDD)](tests/readme.md) approach to eliminate bugs as soon as possible.

![tinyusb diagram](/docs/images/what_is_tinyusb.png)

## Features

designed to run out-of-the-box and easy to configure.

### Host

- HID Mouse
- HID Keyboard
- HID Generic (comming soon)
- Communication Device Class (CDC)
- Mass Storage Class (MSC)
- Hub
    - Only support 1 level of hub (due to my laziness)

### Device

- HID Mouse
- HID Keyboard
- HID Generic (comming soon)
- Communication Class (CDC)
- Mass Storage Class (MSC)

### RTOS

tinyusb is designed to be OS-ware and run across RTOS vendors, thanks to its OS Abstraction Layer (OSAL). However, it can also run without an RTOS (OSAL will be expanded to be a state machine in this case). Currently the following OS can be run with tinyusb (out of the box).

- **None OS**
- **FreeRTOS**
- **CMSIS RTX**

## Getting Started

coming soon ...

## Supported Platforms

The stack supports the following MCUs

### NXP
 
  - LPC11uxx
  - LPC13uxx (12 bit ADC)
  - LPC175x_6x
  - LPC43xx

[Here is the list of supported Boards](boards/) in the code base

### Toolchains

You can compile with any of following toolchains

- *lpcxpresso/redsuite*
- *Keil MDK*
- *IAR Workbench*

## Known Issues

- LPC11uxx & LPC13uxx cannot able to STALL Control OUT endpoint !!! --> unsupported with data out request may cause host stuck with control transfer forever. (reproduce: enable keyboard + mouse, return error in set report of hid_device)

## How Can I Help

If you find my little USB stack is useful, please take some time to file any issues that you encountered. It is not necessary to be a software bug, it can be a question, request, suggestion etc. We can consider each github's issue as a forum's topic. Alternatively, you can buy me a cup of coffee if you happen to be in Hochiminh city.

## License

BSD license for most of the code base, but each file is individually licensed especially those in /vendor folder. Please make sure you understand all the license term for files you use in your project. [Full license here](tinyusb/license.md)
markdown documenting 2014-03-25 18:00:53 +01:00			`# tinyusb`
Initial commit 2012-11-26 07:24:01 +01:00
markdown documenting 2014-03-25 18:00:53 +01:00			`## What Is tinyusb`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
documenting on the way 2013-05-08 07:23:25 +02:00			`tinyusb is an open-source (BSD-licensed) USB Host/Device/OTG stack for embedded micro-controller. It is developed using [Test-Driven Development (TDD)](tests/readme.md) approach to eliminate bugs as soon as possible.`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
documenting on the way 2013-05-08 07:23:25 +02:00			`![tinyusb diagram](/docs/images/what_is_tinyusb.png)`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
markdown documenting 2014-03-25 18:00:53 +01:00			`## Features`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
doxygen have problem with bolding the hyperlink. use <b> instead 2014-03-26 05:43:42 +01:00			`designed to run out-of-the-box and easy to configure.`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
markdown documenting 2014-03-25 18:00:53 +01:00			`### Host`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
			`- HID Mouse`
update project file 2014-03-25 10:42:34 +01:00			`- HID Keyboard`
			`- HID Generic (comming soon)`
			`- Communication Device Class (CDC)`
			`- Mass Storage Class (MSC)`
ignore multiple level of hub 2013-10-01 08:23:31 +02:00			`- Hub`
			`- Only support 1 level of hub (due to my laziness)`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
markdown documenting 2014-03-25 18:00:53 +01:00			`### Device`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
added hid device hidd_isr callback refractor keyboard dev demo app 2013-11-06 13:55:48 +01:00			`- HID Mouse`
update project file 2014-03-25 10:42:34 +01:00			`- HID Keyboard`
			`- HID Generic (comming soon)`
			`- Communication Class (CDC)`
			`- Mass Storage Class (MSC)`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
markdown documenting 2014-03-25 18:00:53 +01:00			`### RTOS`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
update project file 2014-03-25 10:42:34 +01:00			`tinyusb is designed to be OS-ware and run across RTOS vendors, thanks to its OS Abstraction Layer (OSAL). However, it can also run without an RTOS (OSAL will be expanded to be a state machine in this case). Currently the following OS can be run with tinyusb (out of the box).`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
documenting on the way 2013-05-08 07:23:25 +02:00			`- None OS`
			`- FreeRTOS`
all project can run ok 2013-09-13 17:30:11 +02:00			`- CMSIS RTX`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
markdown documenting 2014-03-25 18:00:53 +01:00			`## Getting Started`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
			`coming soon ...`

markdown documenting 2014-03-25 18:00:53 +01:00			`## Supported Platforms`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
markdown documenting 2014-03-25 18:00:53 +01:00			`The stack supports the following MCUs`

doxygen have problem with bolding the hyperlink. use <b> instead 2014-03-26 05:43:42 +01:00			`### NXP`
markdown documenting 2014-03-25 18:00:53 +01:00
fixed dcd lpc17xx queue transfer & IOC handling able to run MSC demo 2013-11-20 09:34:49 +01:00			`- LPC11uxx`
update project file 2014-03-25 10:42:34 +01:00			`- LPC13uxx (12 bit ADC)`
			`- LPC175x_6x`
markdown documenting 2014-03-25 18:00:53 +01:00			`- LPC43xx`

md 2014-03-26 09:34:16 +01:00			`[Here is the list of supported Boards](boards/) in the code base`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
markdown documenting 2014-03-25 18:00:53 +01:00			`### Toolchains`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
doxygen have problem with bolding the hyperlink. use <b> instead 2014-03-26 05:43:42 +01:00			`You can compile with any of following toolchains`
all project can run ok 2013-09-13 17:30:11 +02:00
IAR host none project working 2013-09-19 13:17:13 +02:00			`- lpcxpresso/redsuite`
			`- Keil MDK`
			`- IAR Workbench`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
markdown documenting 2014-03-25 18:00:53 +01:00			`## Known Issues`
complete double buffering for queueing xfer for lpc11u/13u requried by msc device 2013-11-14 08:12:07 +01:00
			`- LPC11uxx & LPC13uxx cannot able to STALL Control OUT endpoint !!! --> unsupported with data out request may cause host stuck with control transfer forever. (reproduce: enable keyboard + mouse, return error in set report of hid_device)`

markdown documenting 2014-03-25 18:00:53 +01:00			`## How Can I Help`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
update docs 2013-05-08 05:32:31 +02:00			`If you find my little USB stack is useful, please take some time to file any issues that you encountered. It is not necessary to be a software bug, it can be a question, request, suggestion etc. We can consider each github's issue as a forum's topic. Alternatively, you can buy me a cup of coffee if you happen to be in Hochiminh city.`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
markdown documenting 2014-03-25 18:00:53 +01:00			`## License`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
markdown document 2014-03-25 17:11:46 +01:00			`BSD license for most of the code base, but each file is individually licensed especially those in /vendor folder. Please make sure you understand all the license term for files you use in your project. [Full license here](tinyusb/license.md)`