kingkevin
/
espressif_tinyusb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

documenting with markdown

This commit is contained in:
hathach 2014-03-26 15:42:34 +07:00
parent 3508eaa03a
commit a316099a90
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
readme.markdown
View File

@ -1,16 +1,16 @@
# tinyusb # tinyusb #
## What Is 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 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) ![tinyusb diagram](/docs/images/what_is_tinyusb.png)
## Features ## Features ##
designed to run out-of-the-box and easy to configure. designed to run out-of-the-box and easy to configure.
### Host ### Host ###
- HID Mouse - HID Mouse
- HID Keyboard - HID Keyboard
@ -20,7 +20,7 @@ designed to run out-of-the-box and easy to configure.
- Hub - Hub
- Only support 1 level of hub (due to my laziness) - Only support 1 level of hub (due to my laziness)
### Device ### Device ###
- HID Mouse - HID Mouse
- HID Keyboard - HID Keyboard
@ -28,7 +28,7 @@ designed to run out-of-the-box and easy to configure.
- Communication Class (CDC) - Communication Class (CDC)
- Mass Storage Class (MSC) - Mass Storage Class (MSC)
### RTOS ### 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). 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).
@ -36,15 +36,11 @@ tinyusb is designed to be OS-ware and run across RTOS vendors, thanks to its OS
- **FreeRTOS** - **FreeRTOS**
- **CMSIS RTX** - **CMSIS RTX**
## Getting Started ## Supported Platforms ##
coming soon ...
## Supported Platforms
The stack supports the following MCUs The stack supports the following MCUs
### NXP ### NXP ###
- LPC11uxx - LPC11uxx
- LPC13uxx (12 bit ADC) - LPC13uxx (12 bit ADC)
@ -53,22 +49,26 @@ The stack supports the following MCUs
[Here is the list of supported Boards](boards/) in the code base [Here is the list of supported Boards](boards/) in the code base
### Toolchains ### Toolchains ###
You can compile with any of following toolchains You can compile with any of following toolchains
- *lpcxpresso/redsuite* - *lpcxpresso/redsuite*
- *Keil MDK* - *Keil MDK*
- *IAR Workbench* - *IAR Workbench*
## Known Issues ## Getting Started ##
[Here is the details for getting started](tinyusb/doxygen/get_started.md) with the stack
## 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) - 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 ## 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. 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 ## 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) 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)