esp32-s2_dfu/readme.markdown

# tinyusb #

tinyusb is an open-source (BSD-licensed) USB Host/Device/OTG stack for embedded micro-controllers, especially ARM MCUs. It is designed to be user-friendly in term of configuration and out-of-the-box running experience.

In addition to running without an RTOS, tinyusb is an OS-awared stack that can run across RTOS vendors. For the purpose of eliminating bugs as soon as possible, the stack is developed using [Test-Driven Development (TDD)](tests/readme.md) approach 

![tinyusb diagram](http://docs.tinyusb.org/images/tinyusb_overview.png)

## Features ##

### 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 ###

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

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

### Supported MCUs ###

The stack supports the following MCUs
 
  - 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*

## Getting Started ##

[Here is the details for getting started](tinyusb/doxygen/get_started.md) with the stack  

## 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)

## How Can I Help ##

If you find my little USB stack is useful and want to give something back

### Donate Time ###

You can contribute your time by helping with programming, testing and filing bug reports, improving documentation. Or simply by using tinyusb, giving me some feedback on how to improve it and telling others about it. 

### Donate Money ###

If you don't have time but still want to help, then please consider making a financial donation. This will help to pay the (coffee) bills and motivate me to continue working on tinyusb. You can do so using the donation button at the top right of the page, or contact me for other payment methods.

[//]: # (\htmlonly)
<a href="https://pledgie.com/campaigns/24694"><img alt="Click here to lend your support to tinyusb donation and make a donation at pledgie.com" src="https://pledgie.com/campaigns/24694.png?skin_name=chrome" border="0"></a>
[//]: # (\endhtmlonly)
documenting with markdown 2014-03-26 09:42:34 +01:00			`# tinyusb #`
Initial commit 2012-11-26 07:24:01 +01:00
document with markdown 2014-03-28 09:23:32 +01:00			`tinyusb is an open-source (BSD-licensed) USB Host/Device/OTG stack for embedded micro-controllers, especially ARM MCUs. It is designed to be user-friendly in term of configuration and out-of-the-box running experience.`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
document with markdown 2014-03-28 09:23:32 +01:00			`In addition to running without an RTOS, tinyusb is an OS-awared stack that can run across RTOS vendors. For the purpose of eliminating bugs as soon as possible, the stack is developed using [Test-Driven Development (TDD)](tests/readme.md) approach`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
fix image path 2014-03-27 11:59:45 +01:00			`![tinyusb diagram](http://docs.tinyusb.org/images/tinyusb_overview.png)`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
documenting with markdown 2014-03-26 09:42:34 +01:00			`## Features ##`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
documenting with markdown 2014-03-26 09:42:34 +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
documenting with markdown 2014-03-26 09:42:34 +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
documenting with markdown 2014-03-26 09:42:34 +01:00			`### RTOS ###`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
document with markdown 2014-03-28 09:23:32 +01:00			`Currently the following OS are supported with tinyusb out of the box with a simple change of TUSB_CFG_OS macro.`
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
document with markdown 2014-03-28 09:23:32 +01:00			`### Supported MCUs ###`
markdown documenting 2014-03-25 18:00:53 +01:00
document with markdown 2014-03-28 09:23:32 +01:00			`The stack supports the following MCUs`
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
documenting with markdown 2014-03-26 09:42:34 +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`
documenting with markdown 2014-03-26 09:42:34 +01:00			`- IAR Workbench`

			`## Getting Started ##`

document with markdown 2014-03-28 09:23:32 +01:00			`[Here is the details for getting started](tinyusb/doxygen/get_started.md) with the stack`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
document with markdown 2014-03-28 09:23:32 +01:00			`## License ##`
complete double buffering for queueing xfer for lpc11u/13u requried by msc device 2013-11-14 08:12:07 +01:00
document with markdown 2014-03-28 09:23:32 +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)`
complete double buffering for queueing xfer for lpc11u/13u requried by msc device 2013-11-14 08:12:07 +01:00
documenting with markdown 2014-03-26 09:42:34 +01:00			`## How Can I Help ##`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00
document with markdown 2014-03-28 09:23:32 +01:00			`If you find my little USB stack is useful and want to give something back`

			`### Donate Time ###`

			`You can contribute your time by helping with programming, testing and filing bug reports, improving documentation. Or simply by using tinyusb, giving me some feedback on how to improve it and telling others about it.`

			`### Donate Money ###`

			`If you don't have time but still want to help, then please consider making a financial donation. This will help to pay the (coffee) bills and motivate me to continue working on tinyusb. You can do so using the donation button at the top right of the page, or contact me for other payment methods.`

			`[//]: # (\htmlonly)`
			`<a href="https://pledgie.com/campaigns/24694"><img alt="Click here to lend your support to tinyusb donation and make a donation at pledgie.com" src="https://pledgie.com/campaigns/24694.png?skin_name=chrome" border="0"></a>`
			`[//]: # (\endhtmlonly)`
adding some document to /readme.md 2013-05-07 08:36:34 +02:00