document with markdown
This commit is contained in:
hathach
parent
22c2c1fd64
commit
9eff09ef7f
|
|
@ -1,15 +1,13 @@
|
|||
# tinyusb #
|
||||
|
||||
## What Is 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.
|
||||
|
||||
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.
|
||||
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
|
||||
|
||||
|
||||
|
||||
## Features ##
|
||||
|
||||
designed to run out-of-the-box and easy to configure.
|
||||
|
||||
### Host ###
|
||||
|
||||
- HID Mouse
|
||||
|
|
@ -30,17 +28,15 @@ designed to run out-of-the-box and easy to configure.
|
|||
|
||||
### 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).
|
||||
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 Platforms ##
|
||||
### Supported MCUs ###
|
||||
|
||||
The stack supports the following MCUs
|
||||
|
||||
### NXP ###
|
||||
The stack supports the following MCUs
|
||||
|
||||
- LPC11uxx
|
||||
- LPC13uxx (12 bit ADC)
|
||||
|
|
@ -59,16 +55,26 @@ You can compile with any of following toolchains
|
|||
|
||||
## 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)
|
||||
|
||||
## 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.
|
||||
[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)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -15,4 +15,4 @@ Continuous Integration (CI) is used to automatically run all the tests whenever
|
|||
|
||||
As many other open source project, tinyusb uses Travis-CI server (free for OOS). You can find my project on Travis here https://travis-ci.org/hathach/tinyusb
|
||||
|
||||
[](https://travis-ci.org/hathach/tinyusb)
|
||||
|
||||
|
|
|
|||
|
|
@ -1106,7 +1106,7 @@ HTML_FILE_EXTENSION = .html
|
|||
# of the possible markers and block names see the documentation.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_HEADER =
|
||||
HTML_HEADER = header.html
|
||||
|
||||
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
|
||||
# generated HTML page. If the tag is left blank doxygen will generate a standard
|
||||
|
|
|
|||
Loading…
Reference in New Issue