diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 22 insertions, 12 deletions
@@ -2,7 +2,7 @@  -[](https://travis-ci.org/hathach/tinyusb) [](https://opensource.org/licenses/MIT) +[](https://github.com/hathach/tinyusb/actions) [](https://opensource.org/licenses/MIT) [](https://scan.coverity.com/projects/tinyusb) TinyUSB is an open-source cross-platform USB Host/Device stack for embedded system, designed to be memory-safe with no dynamic allocation and thread-safe with all interrupt events are deferred then handled in the non-ISR task function. @@ -21,26 +21,36 @@ TinyUSB is an open-source cross-platform USB Host/Device stack for embedded syst └── tools # Files used internally ``` +## Contributors + +Special thanks to all the people who spent their precious time and effort to help this project so far. Check out the +[CONTRIBUTORS.md](CONTRIBUTORS.md) file for the list of all contributors and their awesome work for the stack. + ## Supported MCUs -The stack supports the following MCUs +The stack supports the following MCUs: -- **Nordic:** nRF52840 -- **NXP:** LPC Series: 11Uxx, 13xx, 175x_6x, 177x_8x, 18xx, 40xx, 43xx, 51Uxx, 54xxx, 55xx - **MicroChip:** SAMD21, SAMD51 (device only) +- **Nordic:** nRF52840, nRF52833 +- **NXP:** + - LPC Series: 11Uxx, 13xx, 175x_6x, 177x_8x, 18xx, 40xx, 43xx, 51Uxx, 54xxx, 55xx + - iMX RT Series: RT1011, RT1015, RT1021, RT1052, RT1062, RT1064 - **Sony:** CXD56 - **ST:** STM32 series: L0, F0, F1, F2, F3, F4, F7, H7 (device only) +- **[ValentyUSB](https://github.com/im-tomu/valentyusb)** eptri +- **Nuvoton:** NUC120, NUC121/NUC125, NUC126, NUC505 [Here is the list of supported Boards](docs/boards.md) that can be used with provided examples. ## Device Stack -Support multiple device configurations by dynamically changing usb descriptors. Low power functions such as suspend, resume and remote wakeup. Following device classes are supported: +Supports multiple device configurations by dynamically changing usb descriptors. Low power functions such like suspend, resume, and remote wakeup. Following device classes are supported: - Communication Class (CDC) - Human Interface Device (HID): Generic (In & Out), Keyboard, Mouse, Gamepad etc ... - Mass Storage Class (MSC): with multiple LUNs - Musical Instrument Digital Interface (MIDI) +- Network with RNDIS, CDC-ECM, CDC-EEM (work in progress) - Vendor-specific class support with generic In & Out endpoints. Can be used with MS OS 2.0 compatible descriptor to load winUSB driver without INF file. - [WebUSB](https://github.com/WICG/webusb) with vendor-specific class @@ -50,11 +60,11 @@ Support multiple device configurations by dynamically changing usb descriptors. - Human Interface Device (HID): Keyboard, Mouse, Generic - Mass Storage Class (MSC) -- Hub currently only support 1 level of hub (due to my laziness) +- Hub currently only supports 1 level of hub (due to my laziness) -## OS Abtraction layer +## OS Abstraction layer -TinyUSB is completely thread-safe by pushing all ISR events into a central queue, then process it later in the non-ISR context task function. It also uses semphore/mutex to access shared resource such as CDC FIFO. Therefore the stack needs to use some of OS's basic APIs. Following OSes are already supported out of the box. +TinyUSB is completely thread-safe by pushing all ISR events into a central queue, then process it later in the non-ISR context task function. It also uses semaphore/mutex to access shared resources such as CDC FIFO. Therefore the stack needs to use some of OS's basic APIs. Following OSes are already supported out of the box. - **No OS** : Disabling USB IRQ is used as way to provide mutex - **FreeRTOS** @@ -62,11 +72,11 @@ TinyUSB is completely thread-safe by pushing all ISR events into a central queue ## Compiler & IDE -The stack is developed with GCC compiler, and should be compilable with others. Folder `examples` provide Makefile and Segger Embedded Studio build support. [Here is instruction to build example](examples/readme.md). +The stack is developed with GCC compiler and should be compilable with others. The `examples` folder provides Makefile and Segger Embedded Studio build support. [Here are example build instructions](examples/readme.md). ## Getting Started -[Here is the details for getting started](docs/getting_started.md) with the stack. +[Here are the details for getting started](docs/getting_started.md) with the stack. ## Porting @@ -74,7 +84,7 @@ Want to help add TinyUSB support for a new MCU? Read [here](docs/porting.md) for ## License -MIT license for all TinyUSB sources `src` folder, [Full license is here](LICENSE). However each file is individually licensed especially those in `lib` and `hw/mcu` folder. Please make sure you understand all the license term for files you use in your project. +MIT license for all TinyUSB sources `src` folder, [Full license is here](LICENSE). However, each file is individually licensed especially those in `lib` and `hw/mcu` folder. Please make sure you understand all the license term for files you use in your project. ## Uses @@ -87,4 +97,4 @@ TinyUSB is currently used by these other projects: * [MicroPython](https://github.com/micropython/micropython) * [TinyUSB Arduino Library](https://github.com/adafruit/Adafruit_TinyUSB_Arduino) -Let's me know if your project also uses TinyUSB and want to share. +Let me know if your project also uses TinyUSB and want to share. |