esp32-s2_dfu/README.md

90 lines
4.3 KiB
Markdown
Raw Permalink Normal View History

2018-12-13 09:20:28 +01:00
# TinyUSB
2012-11-26 07:24:01 +01:00
2019-08-07 20:09:04 +02:00
![tinyUSB_240x100](https://user-images.githubusercontent.com/249515/62646655-f9393200-b978-11e9-9c53-484862f15503.png)
2019-03-20 10:12:38 +01:00
[![Build Status](https://travis-ci.org/hathach/tinyusb.svg?branch=master)](https://travis-ci.org/hathach/tinyusb) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
2018-12-29 08:29:59 +01:00
2019-04-08 08:22:08 +02:00
TinyUSB is an open-source cross-platform USB Host/Device stack for embedded system. It is designed to be memory-safe with no dynamic allocation and thread-safe with all interrupt events are deferred then handled in the stack's task function.
2014-03-28 11:50:30 +01:00
2018-12-12 10:35:53 +01:00
![tinyusb](https://user-images.githubusercontent.com/249515/49858616-f60c9700-fe27-11e8-8627-e76936352ff7.png)
2014-03-28 11:50:30 +01:00
2018-12-29 08:29:59 +01:00
```
.
2018-12-29 08:39:28 +01:00
├── docs # Documentation
├── examples # Sample with Makefile and Segger Embedded build support
2018-12-29 08:29:59 +01:00
├── hw
2018-12-29 08:39:28 +01:00
│   ├── bsp # Supported boards source files
│   └── mcu # Low level mcu core & peripheral drivers
├── lib # Sources from 3rd party such as freeRTOS, fatfs ...
├── src # All sources files for TinyUSB stack itself.
2019-06-10 12:50:16 +02:00
├── test # Unit tests for the stack
2018-12-29 08:39:28 +01:00
└── tools # Files used internally
2018-12-29 08:29:59 +01:00
```
2019-09-20 11:14:35 +02:00
## Supported MCUs
The stack supports the following MCUs
- **Nordic:** nRF52840
- **NXP:** LPC Series: 11Uxx, 13xx, 175x_6x, 177x_8x, 18xx, 40xx, 43xx, 51Uxx
2019-09-20 11:14:35 +02:00
- **MicroChip:** SAMD21, SAMD51 (device only)
2019-10-08 10:49:37 +02:00
- **Sony:** CXD56
- **ST:** STM32 series: L0, F0, F1, F2, F3, F4, F7, H7 (device only)
2019-09-20 11:14:35 +02:00
[Here is the list of supported Boards](docs/boards.md) that can be used with provided examples.
2018-12-12 10:35:53 +01:00
## Device Stack
2013-05-07 08:36:34 +02:00
2019-04-08 08:22:08 +02:00
Support multiple device configurations by dynamically changing usb descriptors. Low power functions such as suspend, resume and remote wakeup. Following device classes are supported:
2019-04-02 11:18:36 +02:00
- Communication Class (CDC)
- Human Interface Device (HID): Generic (In & Out), Keyboard, Mouse, Gamepad etc ...
- Mass Storage Class (MSC): with multiple LUNs
2019-03-19 13:09:08 +01:00
- Musical Instrument Digital Interface (MIDI)
2019-08-01 08:31:59 +02:00
- 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
2013-05-07 08:36:34 +02:00
2018-12-12 10:35:53 +01:00
## Host Stack
2018-12-12 10:57:10 +01:00
**Most active development is on the Device stack. The Host stack is under rework and largely untested.**
2013-05-07 08:36:34 +02:00
2018-12-12 10:35:53 +01:00
- Human Interface Device (HID): Keyboard, Mouse, Generic
2014-03-25 10:42:34 +01:00
- Mass Storage Class (MSC)
- Hub currently only support 1 level of hub (due to my laziness)
2013-05-07 08:36:34 +02:00
2018-12-12 10:35:53 +01:00
## OS Abtraction layer
2013-05-07 08:36:34 +02:00
2019-09-20 18:05:08 +02:00
TinyUSB is completely thread-safe by pushing all ISR events into a central queue, then process it later in the non-ISR context. 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.
2013-05-07 08:36:34 +02:00
2019-09-20 11:14:35 +02:00
- **No OS** : Disabling USB IRQ is used as way to provide mutex
2013-05-08 07:23:25 +02:00
- **FreeRTOS**
2019-08-01 11:22:19 +02:00
- **Mynewt** Due to the newt package build system, Mynewt examples are better to be on its [own repo](https://github.com/hathach/mynewt-tinyusb-example)
2018-12-12 10:35:53 +01:00
## Compiler & IDE
2014-03-25 18:00:53 +01:00
2019-09-06 11:50:00 +02:00
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).
2014-03-26 09:42:34 +01:00
2018-12-12 10:35:53 +01:00
## Getting Started
2014-03-26 09:42:34 +01:00
2018-12-12 10:35:53 +01:00
[Here is the details for getting started](docs/getting_started.md) with the stack.
2013-05-07 08:36:34 +02:00
2019-04-08 08:22:08 +02:00
## Porting
Want to help add TinyUSB support for a new MCU? Read [here](docs/porting.md) for an explanation on the low-level API needed by TinyUSB.
## 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.
2018-12-12 10:35:53 +01:00
## Uses
TinyUSB is currently used by these other projects:
2018-12-12 10:35:53 +01:00
* [Adafruit nRF52 Arduino](https://github.com/adafruit/Adafruit_nRF52_Arduino)
* [Adafruit nRF52 Bootloader](https://github.com/adafruit/Adafruit_nRF52_Bootloader)
2019-06-10 12:50:16 +02:00
* [Adafruit SAMD Arduino](https://github.com/adafruit/ArduinoCore-samd)
* [CircuitPython](https://github.com/adafruit/circuitpython)
2019-04-27 19:43:36 +02:00
* [TinyUSB Arduino Library](https://github.com/adafruit/Adafruit_TinyUSB_Arduino)
2019-08-01 11:23:27 +02:00
Let's me know if your project also uses TinyUSB and want to share.