tinyusb/README.md

# tinyusb #

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Features](#features)
	- [Host](#host)
	- [Device](#device)
	- [RTOS](#rtos)
	- [Supported MCUs](#supported-mcus)
	- [Toolchains](#toolchains)
- [Getting Started](#getting-started)
- [License](#license)
- [How Can I Help](#how-can-i-help)
	- [Donate Time](#donate-time)
	- [Donate Money](#donate-money)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

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. More documents and API reference can be found at http://docs.tinyusb.org

![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 currnetly 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 CFG_TUSB_OS macro.

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

### Toolchains ###

You can compile with any of following toolchains, however, the stack requires C99 to build with

- lpcxpresso
- Keil MDK
- IAR Workbench

### Supported MCUs ###

The stack supports the following MCUs

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

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

## Getting Started ##

[Here is the details for getting started](doxygen/getting_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 is here](tinyusb/license.md)
documenting with markdown 2014-03-26 15:42:34 +07:00			`# tinyusb #`
Initial commit 2012-11-25 22:24:01 -08:00
update md 2014-03-28 17:50:30 +07:00			`<!-- START doctoc generated TOC please keep comment here to allow auto update -->`
			`<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->`
			`Table of Contents`

			`- [Features](#features)`
			`- [Host](#host)`
			`- [Device](#device)`
			`- [RTOS](#rtos)`
			`- [Supported MCUs](#supported-mcus)`
			`- [Toolchains](#toolchains)`
			`- [Getting Started](#getting-started)`
			`- [License](#license)`
			`- [How Can I Help](#how-can-i-help)`
			`- [Donate Time](#donate-time)`
			`- [Donate Money](#donate-money)`

			`<!-- END doctoc generated TOC please keep comment here to allow auto update -->`

document with markdown 2014-03-28 15:23:32 +07: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 13:36:34 +07:00
doc work, comment out \subpage command in markdown result 2014-04-17 12:02:03 +07: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. More documents and API reference can be found at http://docs.tinyusb.org`
adding some document to /readme.md 2013-05-07 13:36:34 +07:00
fix image path 2014-03-27 17:59:45 +07:00			`![tinyusb diagram](http://docs.tinyusb.org/images/tinyusb_overview.png)`
adding some document to /readme.md 2013-05-07 13:36:34 +07:00
documenting with markdown 2014-03-26 15:42:34 +07:00			`## Features ##`
adding some document to /readme.md 2013-05-07 13:36:34 +07:00
documenting with markdown 2014-03-26 15:42:34 +07:00			`### Host ###`
adding some document to /readme.md 2013-05-07 13:36:34 +07:00
			`- HID Mouse`
clean up 2018-06-19 15:08:31 +07:00			`- HID Keyboard`
update project file 2014-03-25 16:42:34 +07:00			`- HID Generic (comming soon)`
			`- Communication Device Class (CDC)`
			`- Mass Storage Class (MSC)`
doc work, comment out \subpage command in markdown result 2014-04-17 12:02:03 +07:00			`- Hub currnetly only support 1 level of hub (due to my laziness)`
adding some document to /readme.md 2013-05-07 13:36:34 +07:00
documenting with markdown 2014-03-26 15:42:34 +07:00			`### Device ###`
adding some document to /readme.md 2013-05-07 13:36:34 +07:00
added hid device hidd_isr callback refractor keyboard dev demo app 2013-11-06 19:55:48 +07:00			`- HID Mouse`
clean up 2018-06-19 15:08:31 +07:00			`- HID Keyboard`
			`- HID Generic (comming soon)`
update project file 2014-03-25 16:42:34 +07:00			`- Communication Class (CDC)`
			`- Mass Storage Class (MSC)`
adding some document to /readme.md 2013-05-07 13:36:34 +07:00
documenting with markdown 2014-03-26 15:42:34 +07:00			`### RTOS ###`
adding some document to /readme.md 2013-05-07 13:36:34 +07:00
mass rename TUSB_CFG to CFG_TUSB 2018-04-10 14:31:11 +07: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 13:36:34 +07:00
documenting on the way 2013-05-08 12:23:25 +07:00			`- None OS`
			`- FreeRTOS`
all project can run ok 2013-09-13 22:30:11 +07:00			`- CMSIS RTX`
adding some document to /readme.md 2013-05-07 13:36:34 +07:00
doc work, comment out \subpage command in markdown result 2014-04-17 12:02:03 +07:00			`### Toolchains ###`

add C99 requirement 2014-04-18 22:53:42 +07:00			`You can compile with any of following toolchains, however, the stack requires C99 to build with`
doc work, comment out \subpage command in markdown result 2014-04-17 12:02:03 +07:00
			`- lpcxpresso`
			`- Keil MDK`
clean up 2018-06-19 15:08:31 +07:00			`- IAR Workbench`
doc work, comment out \subpage command in markdown result 2014-04-17 12:02:03 +07:00
document with markdown 2014-03-28 15:23:32 +07:00			`### Supported MCUs ###`
markdown documenting 2014-03-26 00:00:53 +07:00
clean up 2018-06-19 15:08:31 +07:00			`The stack supports the following MCUs`

			`- LPC11uxx`
			`- LPC13uxx (12 bit ADC)`
			`- LPC175x_6x`
			`- LPC43xx`
markdown documenting 2014-03-26 00:00:53 +07:00
doc work, comment out \subpage command in markdown result 2014-04-17 12:02:03 +07:00			`[Here is the list of supported Boards](boards/readme.md) in the code base`
documenting with markdown 2014-03-26 15:42:34 +07:00
			`## Getting Started ##`

clean up 2018-06-19 15:08:31 +07:00			`[Here is the details for getting started](doxygen/getting_started.md) with the stack.`
adding some document to /readme.md 2013-05-07 13:36:34 +07:00
document with markdown 2014-03-28 15:23:32 +07:00			`## License ##`
complete double buffering for queueing xfer for lpc11u/13u requried by msc device 2013-11-14 14:12:07 +07:00
doc work, comment out \subpage command in markdown result 2014-04-17 12:02:03 +07: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 is here](tinyusb/license.md)`