mirror of
https://github.com/aprochazka/ProfilometerProbe.git
synced 2025-06-30 09:37:22 +02:00
Error in makefile
This commit is contained in:
Adam Procházka
18
Firmware/Core/tinyusb/docs/assets/logo.svg
Normal file
18
Firmware/Core/tinyusb/docs/assets/logo.svg
Normal file
@ -0,0 +1,18 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg width="280" height="140" version="1.1" viewBox="0 0 74.083 37.042" xmlns="http://www.w3.org/2000/svg">
|
||||
<g transform="translate(-60.931 -79.245)">
|
||||
<g transform="matrix(1.0442 0 0 1.1531 -27.105 33.588)" fill="#fff">
|
||||
<path d="m86.972 39.594c-1.4683 3.2e-5 -2.6588 1.181-2.66 2.6384v26.844c3.3e-5 1.4583 1.1909 2.6404 2.66 2.6404h65.63c1.469-3.2e-5 2.66-1.1822 2.66-2.6404v-26.844c-1e-3 -1.4575-1.1917-2.6384-2.66-2.6384z" color="#000000" fill="#fff" style="-inkscape-stroke:none"/>
|
||||
</g>
|
||||
<g transform="matrix(.35278 0 0 -.35278 -160.36 421.93)" fill="#231f20">
|
||||
<path transform="translate(672.09 955.48)" d="m0 0h-21.484v-12.601h-5.349v-6.436h5.349v-25.383c0-11.331 7.252-13.87 17.223-13.87 4.352 0 8.613 0.272 12.873 0.907v6.073c-0.816-0.09-2.266-0.362-3.535-0.362-3.807 0-5.077 0.816-5.077 4.896v27.739h8.612v6.436h-8.612z"/>
|
||||
<path transform="translate(693.61 925.33)" d="m0 0h-0.049c-1.518 0-2.165-0.896-2.165-2.24v-0.05h4.504v0.05c0 1.344-0.771 2.24-2.29 2.24"/>
|
||||
<path transform="translate(700.92 925.5)" d="m0 0h-0.124c-1.443 0-2.265-0.995-2.265-2.389v-0.074h4.654v0.074c0 1.394-0.822 2.389-2.265 2.389"/>
|
||||
<path transform="translate(750.09 943.78)" d="m0 0c-6.165 0-11.876-2.267-14.505-5.893v4.986h-20.578v-45.326h21.484v36.533c1.27 0.272 2.449 0.453 3.717 0.453 4.715 0 5.44-2.538 5.44-6.436v-30.55h21.484v30.278c0 11.694-7.523 15.955-17.042 15.955"/>
|
||||
<path transform="translate(811.83 942.88)" d="m0 0-10.516-23.57-11.784 23.57h-23.388l24.204-48.046-6.799-15.411h8.249l28.193 63.457z"/>
|
||||
<path transform="translate(706 920)" d="m0 0h-17.421v2.637c0 2.938 1.194 5.675 4.43 5.675h0.124c2.24 0 3.335-1.269 3.932-2.514 0.647 1.469 1.667 2.738 3.883 2.738h0.224c3.086 0 4.828-2.39 4.828-5.774zm-0.598-9.412h-3.16c0.622 1.07 0.971 1.917 0.971 2.737 0 0.871-0.424 1.618-1.493 1.618h-0.05c-0.797 0-1.394-0.249-3.037-1.692-2.339-2.065-3.459-2.912-5.574-2.912h-0.05c-2.787 0-4.555 1.816-4.555 4.231 0 1.219 0.175 1.941 0.548 2.687h3.161c-0.548-0.945-0.797-1.518-0.797-2.314 0-0.845 0.548-1.568 1.493-1.568h0.05c0.821 0 1.12 0.25 2.788 1.692 2.762 2.39 3.832 2.912 5.824 2.912h0.048c2.739 0 4.555-1.917 4.555-4.305 0-1.195-0.298-2.215-0.722-3.086m-4.479-10.93h-12.344v3.011h12.643c1.567 0 2.189 0.548 2.189 1.319 0 0.772-0.622 1.32-2.189 1.32h-12.643v3.01h12.344c3.658 0 5.301-1.841 5.301-4.33 0-2.488-1.643-4.33-5.301-4.33m-9.641 53.817h12.114v-10.601h-12.114zm14.114 2h-16.114v-12.601h-2.685v-45.326h21.484v45.326h-2.685z"/>
|
||||
<path d="m692.79 947.02h2.827v2.319h-2.827z"/>
|
||||
<path d="m699.06 947.02h2.826v2.319h-2.826z"/>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 2.6 KiB |
1
Firmware/Core/tinyusb/docs/assets/stack.svg
Normal file
1
Firmware/Core/tinyusb/docs/assets/stack.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 84 KiB |
41
Firmware/Core/tinyusb/docs/conf.py
Normal file
41
Firmware/Core/tinyusb/docs/conf.py
Normal file
@ -0,0 +1,41 @@
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'TinyUSB'
|
||||
copyright = '2021, Ha Thach'
|
||||
author = 'Ha Thach'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.intersphinx',
|
||||
'sphinx.ext.todo',
|
||||
'sphinx_autodoc_typehints',
|
||||
]
|
||||
|
||||
templates_path = ['_templates']
|
||||
|
||||
exclude_patterns = ['_build']
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
html_theme = 'furo'
|
||||
html_title = 'TinyUSB'
|
||||
html_logo = 'assets/logo.svg'
|
||||
html_favicon = 'assets/logo.svg'
|
||||
html_theme_options = {
|
||||
'sidebar_hide_name': True,
|
||||
}
|
||||
|
||||
todo_include_todos = True
|
||||
1
Firmware/Core/tinyusb/docs/contributing/code_of_conduct.rst
Symbolic link
1
Firmware/Core/tinyusb/docs/contributing/code_of_conduct.rst
Symbolic link
@ -0,0 +1 @@
|
||||
../../CODE_OF_CONDUCT.rst
|
||||
23
Firmware/Core/tinyusb/docs/contributing/index.rst
Normal file
23
Firmware/Core/tinyusb/docs/contributing/index.rst
Normal file
@ -0,0 +1,23 @@
|
||||
************
|
||||
Contributing
|
||||
************
|
||||
|
||||
Contributing can be highly rewarding, but it can also be frustrating at times.
|
||||
It takes time to review patches, and as this is an open source project, that
|
||||
sometimes can take a while. The reviewing process depends on the availability
|
||||
of the maintainers, who may not be always available. Please try to be
|
||||
understanding through the process.
|
||||
|
||||
There a few guidelines you need to keep in mind when contributing. Please have
|
||||
a look at them as that will make the contribution process easier for all
|
||||
parties.
|
||||
|
||||
Index
|
||||
=====
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
code_of_conduct
|
||||
structure
|
||||
porting
|
||||
241
Firmware/Core/tinyusb/docs/contributing/porting.rst
Normal file
241
Firmware/Core/tinyusb/docs/contributing/porting.rst
Normal file
@ -0,0 +1,241 @@
|
||||
|
||||
*******
|
||||
Porting
|
||||
*******
|
||||
|
||||
TinyUSB is designed to be a universal USB protocol stack for microcontrollers. It
|
||||
handles most of the high level USB protocol and relies on the microcontroller's USB peripheral for
|
||||
data transactions on different endpoints. Porting is the process of adding low-level support for
|
||||
the rest of the common stack. Once the low-level is implemented, it is very easy to add USB support
|
||||
for the microcontroller to other projects, especially those already using TinyUSB such as CircuitPython.
|
||||
|
||||
Below are instructions on how to get the cdc_msc device example running on a new microcontroller. Doing so includes adding the common code necessary for other uses while minimizing other extra code. Whenever you see a phrase or word in <> it should be replaced.
|
||||
|
||||
Register defs
|
||||
-------------
|
||||
|
||||
The first step to adding support is including the register definitions and startup code for the
|
||||
microcontroller in TinyUSB. We write the TinyUSB implementation against these structs instead of higher level functions to keep the code small and to prevent function name collisions in linking of larger projects. For ARM microcontrollers this is the CMSIS definitions. They should be
|
||||
placed in the ``hw/mcu/<vendor>/<chip_family>`` directory.
|
||||
|
||||
Once this is done, create a directory in ``hw/bsp/<your board name>`` for the specific board you are using to test the code. (Duplicating an existing board's directory is the best way to get started.) The board should be a readily available development board so that others can also test.
|
||||
|
||||
Build
|
||||
-----
|
||||
|
||||
Now that those directories are in place, we can start our iteration process to get the example building successfully. To build, run from the root of TinyUSB:
|
||||
|
||||
``make -C examples/device/cdc_msc BOARD=<board>``
|
||||
|
||||
Unless, you've read ahead, this will fail miserably. Now, lets get it to fail less by updating the files in the board directory. The code in the board's directory is responsible for setting up the microcontroller's clocks and pins so that USB works. TinyUSB itself only operates on the USB peripheral. The board directory also includes information what files are needed to build the example.
|
||||
|
||||
One of the first things to change is the ``-DCFG_TUSB_MCU`` cflag in the ``board.mk`` file. This is used to tell TinyUSB what platform is being built. So, add an entry to ``src/tusb_option.h`` and update the CFLAG to match.
|
||||
|
||||
Update ``board.mk``\ 's VENDOR and CHIP_FAMILY values when creating the directory for the struct files. Duplicate one of the other sources from ``src/portable`` into ``src/portable/<vendor>/<chip_family>`` and delete all of the implementation internals. We'll cover what everything there does later. For now, get it compiling.
|
||||
|
||||
Implementation
|
||||
--------------
|
||||
|
||||
At this point you should get an error due to an implementation issue and hopefully the build is setup for the new MCU. You will still need to modify the ``board.mk`` to include specific CFLAGS, the linker script, linker flags, source files, include directories. All file paths are relative to the top of the TinyUSB repo.
|
||||
|
||||
Board Support (BSP)
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The board support code is only used for self-contained examples and testing. It is not used when TinyUSB is part of a larger project. Its responsible for getting the MCU started and the USB peripheral clocked. It also optionally provides LED definitions that are used to blink an LED to show that the code is running.
|
||||
|
||||
It is located in ``hw/bsp/<board name>/board_<board name>.c``.
|
||||
|
||||
board_init
|
||||
~~~~~~~~~~
|
||||
|
||||
``board_init`` is responsible for starting the MCU, setting up the USB clock and USB pins. It is also responsible for initializing LED pins.
|
||||
|
||||
One useful clock debugging technique is to set up a PWM output at a known value such as 500hz based on the USB clock so that you can verify it is correct with a logic probe or oscilloscope.
|
||||
|
||||
Setup your USB in a crystal-less mode when available. That makes the code easier to port across boards.
|
||||
|
||||
board_led_write
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
Feel free to skip this until you want to verify your demo code is running. To implement, set the pin corresponding to the led to output a value that lights the LED when ``state`` is true.
|
||||
|
||||
OS Abstraction Layer (OSAL)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The OS Abstraction Layer is responsible for providing basic data structures for TinyUSB that may allow for concurrency when used with an RTOS. Without an RTOS it simply handles concurrency issues between the main code and interrupts.
|
||||
|
||||
The code is almost entirely agnostic of MCU and lives in ``src/osal``.
|
||||
|
||||
Device API
|
||||
^^^^^^^^^^
|
||||
|
||||
After the USB device is setup, the USB device code works by processing events on the main thread (by calling ``tud_task``\ ). These events are queued by the USB interrupt handler. So, there are three parts to the device low-level API: device setup, endpoint setup and interrupt processing.
|
||||
|
||||
All of the code for the low-level device API is in ``src/portable/<vendor>/<chip family>/dcd_<chip family>.c``.
|
||||
|
||||
Device Setup
|
||||
~~~~~~~~~~~~
|
||||
|
||||
dcd_init
|
||||
""""""""
|
||||
|
||||
Initializes the USB peripheral for device mode and enables it.
|
||||
This function should enable internal D+/D- pull-up for enumeration.
|
||||
|
||||
dcd_int_enable / dcd_int_disable
|
||||
""""""""""""""""""""""""""""""""
|
||||
|
||||
Enables or disables the USB device interrupt(s). May be used to prevent concurrency issues when mutating data structures shared between main code and the interrupt handler.
|
||||
|
||||
dcd_int_handler
|
||||
"""""""""""""""
|
||||
|
||||
Processes all the hardware generated events e.g Bus reset, new data packet from host etc ... It will be called by application in the MCU USB interrupt handler.
|
||||
|
||||
dcd_set_address
|
||||
"""""""""""""""
|
||||
|
||||
Called when the device is given a new bus address.
|
||||
|
||||
If your peripheral automatically changes address during enumeration (like the nrf52) you may leave this empty and also no queue an event for the corresponding SETUP packet.
|
||||
|
||||
dcd_remote_wakeup
|
||||
"""""""""""""""""
|
||||
|
||||
Called to remote wake up host when suspended (e.g hid keyboard)
|
||||
|
||||
dcd_connect / dcd_disconnect
|
||||
""""""""""""""""""""""""""""
|
||||
|
||||
Connect or disconnect the data-line pull-up resistor. Define only if MCU has an internal pull-up. (BSP may define for MCU without internal pull-up.)
|
||||
|
||||
Special events
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
You must let TinyUSB know when certain events occur so that it can continue its work. There are a few methods you can call to queue events for TinyUSB to process.
|
||||
|
||||
dcd_event_bus_signal
|
||||
""""""""""""""""""""
|
||||
|
||||
There are a number of events that your peripheral may communicate about the state of the bus. Here is an overview of what they are. Events in **BOLD** must be provided for TinyUSB to work.
|
||||
|
||||
|
||||
* **DCD_EVENT_RESET** - Triggered when the host resets the bus causing the peripheral to reset. Do any other internal reset you need from the interrupt handler such as resetting the control endpoint.
|
||||
* DCD_EVENT_SOF - Signals the start of a new USB frame.
|
||||
|
||||
Calls to this look like:
|
||||
|
||||
.. code-block::
|
||||
|
||||
dcd_event_bus_signal(0, DCD_EVENT_BUS_RESET, true);
|
||||
|
||||
|
||||
The first ``0`` is the USB peripheral number. Statically saying 0 is common for single USB device MCUs.
|
||||
|
||||
The ``true`` indicates the call is from an interrupt handler and will always be the case when porting in this way.
|
||||
|
||||
dcd_setup_received
|
||||
""""""""""""""""""
|
||||
|
||||
SETUP packets are a special type of transaction that can occur at any time on the control endpoint, numbered ``0``. Since they are unique, most peripherals have special handling for them. Their data is always 8 bytes in length as well.
|
||||
|
||||
Calls to this look like:
|
||||
|
||||
.. code-block::
|
||||
|
||||
dcd_event_setup_received(0, setup, true);
|
||||
|
||||
|
||||
As before with ``dcd_event_bus_signal`` the first argument is the USB peripheral number and the third is true to signal its being called from an interrupt handler. The middle argument is byte array of length 8 with the contents of the SETUP packet. It can be stack allocated because it is copied into the queue.
|
||||
|
||||
Endpoints
|
||||
~~~~~~~~~
|
||||
|
||||
Endpoints are the core of the USB data transfer process. They come in a few forms such as control, isochronous, bulk, and interrupt. We won't cover the details here except with some caveats in open below. In general, data is transferred by setting up a buffer of a given length to be transferred on a given endpoint address and then waiting for an interrupt to signal that the transfer is finished. Further details below.
|
||||
|
||||
Endpoints within USB have an address which encodes both the number and direction of an endpoint. TinyUSB provides ``tu_edpt_number`` and ``tu_edpt_dir`` to unpack this data from the address. Here is a snippet that does it.
|
||||
|
||||
.. code-block::
|
||||
|
||||
uint8_t epnum = tu_edpt_number(ep_addr);
|
||||
uint8_t dir = tu_edpt_dir(ep_addr);
|
||||
|
||||
|
||||
dcd_edpt_open
|
||||
"""""""""""""
|
||||
|
||||
Opening an endpoint is done for all non-control endpoints once the host picks a configuration that the device should use. At this point, the endpoint should be enabled in the peripheral and configured to match the endpoint descriptor. Pay special attention to the direction of the endpoint you can get from the helper methods above. It will likely change what registers you are setting.
|
||||
|
||||
Also make sure to enable endpoint specific interrupts.
|
||||
|
||||
dcd_edpt_close
|
||||
""""""""""""""
|
||||
|
||||
Close an endpoint. his function is used for implementing alternate settings.
|
||||
|
||||
After calling this, the device should not respond to any packets directed towards this endpoint. When called, this function must abort any transfers in progress through this endpoint, before returning.
|
||||
|
||||
Implementation is optional. Must be called from the USB task. Interrupts could be disabled or enabled during the call.
|
||||
|
||||
dcd_edpt_xfer
|
||||
"""""""""""""
|
||||
|
||||
``dcd_edpt_xfer`` is responsible for configuring the peripheral to send or receive data from the host. "xfer" is short for "transfer". **This is one of the core methods you must implement for TinyUSB to work (one other is the interrupt handler).** Data from the host is the OUT direction and data to the host is IN. It is used for all endpoints including the control endpoint 0. Make sure to handle the zero-length packet STATUS packet on endpoint 0 correctly. It may be a special transaction to the peripheral.
|
||||
|
||||
Besides that, all other transactions are relatively straight-forward. The endpoint address provides the endpoint
|
||||
number and direction which usually determines where to write the buffer info. The buffer and its length are usually
|
||||
written to a specific location in memory and the peripheral is told the data is valid. (Maybe by writing a 1 to a
|
||||
register or setting a counter register to 0 for OUT or length for IN.)
|
||||
|
||||
The transmit buffer alignment is determined by ``CFG_TUSB_MEM_ALIGN``.
|
||||
|
||||
One potential pitfall is that the buffer may be longer than the maximum endpoint size of one USB
|
||||
packet. Some peripherals can handle transmitting multiple USB packets for a provided buffer (like the SAMD21).
|
||||
Others (like the nRF52) may need each USB packet queued individually. To make this work you'll need to track
|
||||
some state for yourself and queue up an intermediate USB packet from the interrupt handler.
|
||||
|
||||
Once the transaction is going, the interrupt handler will notify TinyUSB of transfer completion.
|
||||
During transmission, the IN data buffer is guaranteed to remain unchanged in memory until the ``dcd_xfer_complete`` function is called.
|
||||
|
||||
The dcd_edpt_xfer function must never add zero-length-packets (ZLP) on its own to a transfer. If a ZLP is required,
|
||||
then it must be explicitly sent by the stack calling dcd_edpt_xfer(), by calling dcd_edpt_xfer() a second time with len=0.
|
||||
For control transfers, this is automatically done in ``usbd_control.c``.
|
||||
|
||||
At the moment, only a single buffer can be transmitted at once. There is no provision for double-buffering. new dcd_edpt_xfer() will not
|
||||
be called again on the same endpoint address until the driver calls dcd_xfer_complete() (except in cases of USB resets).
|
||||
|
||||
dcd_xfer_complete
|
||||
"""""""""""""""""
|
||||
|
||||
Once a transfer completes you must call dcd_xfer_complete from the USB interrupt handler to let TinyUSB know that a transaction has completed. Here is a sample call:
|
||||
|
||||
.. code-block::
|
||||
|
||||
dcd_event_xfer_complete(0, ep_addr, xfer->actual_len, XFER_RESULT_SUCCESS, true);
|
||||
|
||||
|
||||
The arguments are:
|
||||
|
||||
|
||||
* the USB peripheral number
|
||||
* the endpoint address
|
||||
* the actual length of the transfer. (OUT transfers may be smaller than the buffer given in ``dcd_edpt_xfer``\ )
|
||||
* the result of the transfer. Failure isn't handled yet.
|
||||
* ``true`` to note the call is from an interrupt handler.
|
||||
|
||||
dcd_edpt_stall / dcd_edpt_clear_stall
|
||||
"""""""""""""""""""""""""""""""""""""
|
||||
|
||||
Stalling is one way an endpoint can indicate failure such as when an unsupported command is transmitted. The pair of ``dcd_edpt_stall``\ , ``dcd_edpt_clear_stall`` help manage the stall state of all endpoints.
|
||||
|
||||
Woohoo!
|
||||
-------
|
||||
|
||||
At this point you should have everything working! ;-) Of course, you may not write perfect code. Here are some tips and tricks for debugging.
|
||||
|
||||
Use `WireShark <https://www.wireshark.org/>`_ or `a Beagle <https://www.totalphase.com/protocols/usb/>`_ to sniff the USB traffic. When things aren't working its likely very early in the USB enumeration process. Figuring out where can help clue in where the issue is. For example:
|
||||
|
||||
|
||||
* If the host sends a SETUP packet and its not ACKed then your USB peripheral probably isn't started correctly.
|
||||
* If the peripheral is started correctly but it still didn't work, then verify your usb clock is correct. (You did output a PWM based on it right? ;-) )
|
||||
* If the SETUP packet is ACKed but nothing is sent back then you interrupt handler isn't queueing the setup packet correctly. (Also, if you are using your own code instead of an example ``tud_task`` may not be called.) If that's OK, the ``dcd_xfer_complete`` may not be setting up the next transaction correctly.
|
||||
59
Firmware/Core/tinyusb/docs/contributing/structure.rst
Normal file
59
Firmware/Core/tinyusb/docs/contributing/structure.rst
Normal file
@ -0,0 +1,59 @@
|
||||
*********
|
||||
Structure
|
||||
*********
|
||||
|
||||
Tree
|
||||
====
|
||||
|
||||
::
|
||||
|
||||
.
|
||||
├── docs
|
||||
├── examples
|
||||
├── hw
|
||||
│ ├── bsp
|
||||
│ └── mcu
|
||||
├── lib
|
||||
├── src
|
||||
├── test
|
||||
└── tools
|
||||
|
||||
docs
|
||||
----
|
||||
|
||||
Documentation
|
||||
|
||||
examples
|
||||
--------
|
||||
|
||||
Sample with Makefile build support
|
||||
|
||||
hw/bsp
|
||||
------
|
||||
|
||||
Supported boards source files
|
||||
|
||||
hw/mcu
|
||||
------
|
||||
|
||||
Low level mcu core & peripheral drivers
|
||||
|
||||
lib
|
||||
---
|
||||
|
||||
Sources from 3rd party such as freeRTOS, fatfs ...
|
||||
|
||||
src
|
||||
---
|
||||
|
||||
All sources files for TinyUSB stack itself.
|
||||
|
||||
test
|
||||
----
|
||||
|
||||
Unit tests for the stack
|
||||
|
||||
tools
|
||||
-----
|
||||
|
||||
Files used internally
|
||||
25
Firmware/Core/tinyusb/docs/index.rst
Normal file
25
Firmware/Core/tinyusb/docs/index.rst
Normal file
@ -0,0 +1,25 @@
|
||||
:hide-toc:
|
||||
|
||||
*********
|
||||
TinyUSB
|
||||
*********
|
||||
|
||||
TinyUSB is an open-source cross-platform USB Host/Device stack for embedded systems,
|
||||
designed to be memory-safe with no dynamic allocation and thread-safe with all interrupt events being deferred and then handled in the non-ISR task function.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:caption: Index
|
||||
:hidden:
|
||||
|
||||
Info <info/index>
|
||||
Reference <reference/index>
|
||||
Contributing <contributing/index>
|
||||
|
||||
.. toctree::
|
||||
:caption: External Links
|
||||
:hidden:
|
||||
|
||||
Source Code <https://github.com/hathach/tinyusb>
|
||||
Issue Tracker <https://github.com/hathach/tinyusb/issues>
|
||||
Discussions <https://github.com/hathach/tinyusb/discussions>
|
||||
798
Firmware/Core/tinyusb/docs/info/changelog.rst
Normal file
798
Firmware/Core/tinyusb/docs/info/changelog.rst
Normal file
@ -0,0 +1,798 @@
|
||||
*********
|
||||
Changelog
|
||||
*********
|
||||
|
||||
0.15.0
|
||||
======
|
||||
|
||||
- Add codespell to detect typo
|
||||
- Add support for fuzzing and bagde for oss-fuzz
|
||||
- [osal]
|
||||
|
||||
- Allow the use of non-static allocation for FreeRTOS
|
||||
- Fix FreeRTOS wrong task switch in some cases
|
||||
|
||||
- Fix tu_fifo memory overflown when repeatedly write to overwritable fifo (accumulated more than 2 depths)
|
||||
- Better support for IAR (ARM) with ci build check for stm32 mcus.
|
||||
- Fix Windows build for some mingw gnu make situations
|
||||
|
||||
Controller Driver (DCD & HCD)
|
||||
-----------------------------
|
||||
|
||||
- Add new port support (WIP) for WCH CH32V307 USB Highspeed
|
||||
- Add new port support (WIP) for PIC32MM/MX & PIC24
|
||||
|
||||
- [nRF]
|
||||
|
||||
- Fix endpoint internal state when closed
|
||||
- Fix reception of large ISO packets
|
||||
|
||||
- [rp2040]
|
||||
|
||||
- [dcd] Implement workaround for Errata 15. This enable SOF when bulk-in endpoint is in use and reduce its bandwidth to only 80%
|
||||
- [hcd] Fix shared irq slots filling up when hcd_init() is called multiple times
|
||||
- [hcd] Support host bulk endpoint using hw "interrupt" endpoint. Note speed limit is 64KB/s
|
||||
|
||||
- [samd][dcd] Add support for ISO endpoint
|
||||
- [dwc2][dcd] Add support for stm32u5xx
|
||||
- [esp32sx] Fix Isochronous transfers only transmitted on even frame
|
||||
- [lpc_ip3511][dcd] Add isochronous support and fix endpoint accidental write
|
||||
- [ft90x] Improve and enhance support for FT9xx MCU, tested with more examples
|
||||
|
||||
Device Stack
|
||||
------------
|
||||
|
||||
- [Video]
|
||||
|
||||
- Add support for MJPEG
|
||||
- Fix probe on macOS
|
||||
|
||||
- [MIDI]
|
||||
|
||||
- Support port name strings
|
||||
- fix MS Header wTotalLength computation
|
||||
|
||||
- [HID]
|
||||
|
||||
- Add FIDO descriptor template
|
||||
- change length in tud_hid_report_complete_cb() from uint8 to uint16
|
||||
|
||||
- [CDC]
|
||||
|
||||
- Fix autoflush for FIFO < MPS
|
||||
- Fix tx fifo memory overflown when DTR is not set and tud_cdc_write() is called repeatedly with large enough data
|
||||
|
||||
- [USBTMC] Fix packet size with highspeed
|
||||
|
||||
Host Stack
|
||||
----------
|
||||
|
||||
- Retry a few times with transfers in enumeration since device can be unstable when starting up
|
||||
- [MSC] Rework host masstorage API. Add new **host/msc_file_explorer** example
|
||||
- [CDC]
|
||||
|
||||
- Add support for host cdc
|
||||
- Fix host cdc with device without IAD e.g Arduino Due
|
||||
|
||||
0.14.0
|
||||
======
|
||||
|
||||
- Improve compiler support for CCRX and IAR
|
||||
- Add timeout to osal_queue_receive()
|
||||
- Add tud_task_ext(timeout, in_isr) as generic version of tud_task(). Same as tuh_task_ext(), tuh_task()
|
||||
- Enable more warnings -Wnull-dereference -Wuninitialized -Wunused -Wredundant-decls -Wconversion
|
||||
- Add new examples
|
||||
|
||||
- host/bare_api to demonstrate generic (app-level) enumeration and endpoint transfer
|
||||
- dual/host_hid_to_device_cdc to run both device and host stack concurrently, get HID report from host and print out to device CDC. This example only work with multiple-controller MCUs and rp2040 with the help of pio-usb as added controller.
|
||||
|
||||
Controller Driver (DCD & HCD)
|
||||
-----------------------------
|
||||
|
||||
- Enhance rhports management to better support dual roles
|
||||
|
||||
- CFG_TUD_ENABLED/CFG_TUH_ENABLED, CFG_TUD_MAX_SPEED/CFG_TUH_MAX_SPEED can be used to replace CFG_TUSB_RHPORT0_MODE/CFG_TUSB_RHPORT1_MODE
|
||||
- tud_init(rphort), tuh_init(rhport) can be used to init stack on specified roothub port (controller) instead of tusb_init(void)
|
||||
- Add dcd/hcd port specific defines TUP_ (stand for tinyusb port-specific)
|
||||
- [dwc2]
|
||||
|
||||
- Update to support stm32 h72x, h73x with only 1 otg controller
|
||||
- Fix overwrite with grstctl when disable endpoint
|
||||
- [EHCI] Fix an issue with EHCI driver
|
||||
- [msp430] Fix for possible bug in msp430-elf-gcc 9.3.0
|
||||
- [nrf5x] Fix DMA access race condition using atomic function
|
||||
- [pic32] Fix PIC32 santiy
|
||||
- [rp2040]
|
||||
|
||||
- Add PICO-PIO-USB as controller (device/host) support for rp2040
|
||||
- Use shared IRQ handlers, so user can also hook the USB IRQ
|
||||
- Fix resumed signal not reported to device stack
|
||||
- [stm32fsdev] Add support for stm32wb55
|
||||
|
||||
Device Stack
|
||||
------------
|
||||
|
||||
- [Audio] Add support for feedback endpoint computation
|
||||
|
||||
- New API tud_audio_feedback_params_cb(), tud_audio_feedback_interval_isr().
|
||||
- Supported computation method are: frequency with fixed/float or power of 2. Feedback with fifo count is not yet supported.
|
||||
- Fix nitfs (should be 3) in TUD_AUDIO_HEADSET_STEREO_DESCRIPTOR
|
||||
- Fix typo in audiod_rx_done_cb()
|
||||
|
||||
- [DFU] Fix coexistence with other interfaces BTH, RNDIS
|
||||
- [MSC] Fix inquiry response additional length field
|
||||
- [Venndor] Improve write performance
|
||||
|
||||
Host Stack
|
||||
----------
|
||||
|
||||
- Add new API tuh_configure(rhport, cfg_id, cfg_param) for dynamnic port specific behavior configuration
|
||||
- [HID] Open OUT endpoint if available
|
||||
- [Hub] hub clear port and device interrupts
|
||||
- [USBH] Major improvement
|
||||
|
||||
- Rework usbh control transfer with complete callback. New API tuh_control_xfer() though still only carry 1 usbh (no queueing) at a time.
|
||||
- Add generic endpoint transfer with tuh_edpt_open(), tuh_edpt_xfer(). Require `CFG_TUH_API_EDPT_XFER=1`
|
||||
- Support app-level enumeration with new APIs
|
||||
|
||||
- tuh_descriptor_get(), tuh_descriptor_get_device(), tuh_descriptor_get_configuration(), tuh_descriptor_get_hid_report()
|
||||
- tuh_descriptor_get_string(), tuh_descriptor_get_manufacturer_string(), tuh_descriptor_get_product_string(), tuh_descriptor_get_serial_string()
|
||||
- Also add _sync() as sync/blocking version for above APIs
|
||||
|
||||
0.13.0
|
||||
======
|
||||
|
||||
- [tu_fifo] Fix locked mutex when full, and return type in peek_n()
|
||||
|
||||
Controller Driver (DCD & HCD)
|
||||
-----------------------------
|
||||
|
||||
- [DWC2] Generalize synopsys dwc2 with synopsys/dwc2 which support both FS and HS phy (UTMI and ULPI) for various MCUs.
|
||||
- Broadcom 28/27xx on raspberrypi SBC
|
||||
- Silicon Labs EFM32
|
||||
- Espressif ESP32 Sx
|
||||
- GigaDevice GD32
|
||||
- ST STM32
|
||||
- Infineon XMC
|
||||
- [KL25] Add new HCD for NXP KL25
|
||||
- [MUSB] Add new DCD and HCD for Mentor musb with TI MSP432E4
|
||||
- [F1C100s] Add new DCD for Allwinner F1C100s family
|
||||
- [PIC32MZ] Add new DCD for PIC32MZ
|
||||
- [nRF] Fix/Enhance various race condition with: EASY DMA, request HFXO, EPOUT
|
||||
- [ChipIdea] rename Transdimension to more popular ChipIdea Highspeed,
|
||||
- [RP2040] various update/fix for hcd/dcd
|
||||
- [FT9XX] new DCD port for Bridgetek FT90x and FT93x devices
|
||||
- [DA1469X] Fix resume
|
||||
- [OHCI] Fix device array out of bound
|
||||
|
||||
Note: legacy drivers such as st/synopsys, nxp/transdimension are still present in this release but won't receive more update and could be removed in the future.
|
||||
|
||||
Device Stack
|
||||
------------
|
||||
|
||||
- [Audio] Support disabling feedback format correction (16.16 <-> 10.14 format)
|
||||
- [MSC] Add tud_msc_request_sense_cb() callback, change most default sense error to medium not present (0x02, 0x3A, 0x00)
|
||||
- [Video] Fix video_capture example fails enumeration when 8FPS
|
||||
|
||||
Host Stack
|
||||
----------
|
||||
|
||||
No notable changes
|
||||
|
||||
0.12.0
|
||||
======
|
||||
|
||||
- add CFG_TUSB_OS_INC_PATH for os include path
|
||||
|
||||
Device Controller Driver (DCD)
|
||||
------------------------------
|
||||
|
||||
- Getting device stack to pass USB Compliance Verification test (chapter9, HID, MSC). Ports are tested:
|
||||
nRF, SAMD 21/51, rp2040, stm32f4, Renesas RX, iMXRT, ESP32-S2/3, Kinetic KL25/32, DA146xx
|
||||
- Added dcd_edpt_close_all() for switching configuration
|
||||
- [Transdimension] Support dcd_edpt_xfer_fifo() with auto wrap over if fifo buffer is 4K aligned and size is multiple of 4K.
|
||||
- [DA146xx] Improve vbus, reset, suspend, resume detection, and remote wakeup.
|
||||
|
||||
Device Stack
|
||||
------------
|
||||
|
||||
- Add new network driver Network Control Model (CDC-NCM), update net_lwip_webserver to work with NCM (need re-configure example)
|
||||
- Add new USB Video Class UVC 1.5 driver and video_capture example ((work in progress)
|
||||
- Fix potential buffer overflow for HID, bluetooth drivers
|
||||
|
||||
Host Controller Driver (HCD)
|
||||
----------------------------
|
||||
|
||||
No notable changes
|
||||
|
||||
Host Stack
|
||||
----------
|
||||
|
||||
No notable changes
|
||||
|
||||
0.11.0 (2021-08-29)
|
||||
===================
|
||||
|
||||
- Add host/hid_controller example: only worked/tested with Sony PS4 DualShock controller
|
||||
- Add device/hid_boot_interface example
|
||||
- Add support for Renesas CCRX toolchain for RX mcu
|
||||
|
||||
Device Controller Driver (DCD)
|
||||
------------------------------
|
||||
|
||||
- Add new DCD port for SAMx7x (E70, S70, V70, V71)
|
||||
- Add new mcu K32L2Bxx
|
||||
- Add new mcu GD32VF103
|
||||
- Add new mcu STM32l151
|
||||
- Add new mcu SAML21
|
||||
- Add new mcu RX65n RX72n
|
||||
- Fix NUC120/121/126 USBRAM can only be accessed in byte manner. Also improve set_address & disable sof
|
||||
- Add Suspend/Resume handling for Renesas RX family.
|
||||
- Fix DA1469x no VBUS startup
|
||||
|
||||
Synopsys
|
||||
^^^^^^^^
|
||||
|
||||
- Fix Synopsys set address bug which could cause re-enumeration failed
|
||||
- Fix dcd_synopsys driver integer overflow in HS mode (issue #968)
|
||||
|
||||
nRF5x
|
||||
^^^^^
|
||||
|
||||
- Add nRF5x suspend, resume and remote wakeup
|
||||
- Fix nRF5x race condition with TASKS_EP0RCVOUT
|
||||
|
||||
RP2040
|
||||
^^^^^^
|
||||
|
||||
- Add RP2040 suspend & resume support
|
||||
- Implement double buffer for both host and device (#891). However device EPOUT is still single buffered due to techinical issue with short packet
|
||||
|
||||
Device Stack
|
||||
------------
|
||||
|
||||
USBD
|
||||
^^^^
|
||||
|
||||
- Better support big endian mcu
|
||||
- Add tuh_inited() and tud_inited(), will separate tusb_init/inited() to tud/tuh init/inited
|
||||
- Add dcd_attr.h for defining common controller attribute such as max endpoints
|
||||
|
||||
Bluetooth
|
||||
^^^^^^^^^
|
||||
|
||||
- Fix stridx error in descriptor template
|
||||
|
||||
DFU
|
||||
^^^
|
||||
|
||||
- Enhance DFU implementation to support multiple alternate interface and better support bwPollTimeout
|
||||
- Rename CFG_TUD_DFU_MODE to simply CFG_TUD_DFU
|
||||
|
||||
HID
|
||||
^^^
|
||||
|
||||
- Fix newline usage keyboard (ENTER 0x28)
|
||||
- Better support Hid Get/Set report
|
||||
- Change max gamepad support from 16 to 32 buttons
|
||||
|
||||
MIDI
|
||||
^^^^
|
||||
|
||||
- Fix midi available
|
||||
- Fix midi data
|
||||
- Fix an issue when calling midi API when not enumerated yet
|
||||
|
||||
UAC2
|
||||
^^^^
|
||||
|
||||
- Fix bug and enhance of UAC2
|
||||
|
||||
Vendor
|
||||
^^^^^^
|
||||
|
||||
- Fix vendor fifo deadlock in certain case
|
||||
- Add tud_vendor_n_read_flush
|
||||
|
||||
Host Controller Driver (HCD)
|
||||
----------------------------
|
||||
|
||||
RP2040
|
||||
^^^^^^
|
||||
|
||||
- Implement double buffered to fix E4 errata and boost performance
|
||||
- Lots of rp2040 update and enhancement
|
||||
|
||||
Host Stack
|
||||
----------
|
||||
|
||||
- Major update and rework most of host stack, still needs more improvement
|
||||
- Lots of improvement and update in parsing configuration and control
|
||||
- Rework and major update to HID driver. Will default to enable boot interface if available
|
||||
- Separate CFG_TUH_DEVICE_MAX and CFG_TUH_HUB for better management and reduce SRAM usage
|
||||
|
||||
0.10.1 (2021-06-03)
|
||||
===================
|
||||
|
||||
- rework rp2040 examples and CMake build, allow better integration with pico-sdk
|
||||
|
||||
Host Controller Driver (HCD)
|
||||
----------------------------
|
||||
|
||||
- Fix rp2040 host driver: incorrect PID with low speed device with max packet size of 8 bytes
|
||||
- Improve hub driver
|
||||
- Remove obsolete hcd_pipe_queue_xfer()/hcd_pipe_xfer()
|
||||
- Use hcd_frame_number() instead of micro frame
|
||||
- Fix OHCI endpoint address and xferred_bytes in xfer complete event
|
||||
|
||||
0.10.0 (2021-05-28)
|
||||
===================
|
||||
|
||||
- Rework tu_fifo_t with separated mutex for read and write, better support DMA with read/write buffer info. And constant address mode
|
||||
- Improve audio_test example and add audio_4_channel_mic example
|
||||
- Add new dfu example
|
||||
- Remove pico-sdk from submodule
|
||||
|
||||
Device Controller Driver (DCD)
|
||||
------------------------------
|
||||
|
||||
- Add new DCD port for Silabs EFM32GG12 with board Thunderboard Kit (SLTB009A)
|
||||
- Add new DCD port Renesas RX63N, board GR-CITRUS
|
||||
- Add new (optional) endpoint API dcd_edpt_xfer_fifo
|
||||
- Fix build with nRF5340
|
||||
- Fix build with lpc15 and lpc54
|
||||
- Fix build with lpc177x_8x
|
||||
- STM32 Synopsys: greatly improve Isochronous transfer with edpt_xfer_fifo API
|
||||
- Support LPC55 port1 highspeed
|
||||
- Add support for Espressif esp32s3
|
||||
- nRF: fix race condition that could cause drop packet of Bulk OUT transfer
|
||||
|
||||
USB Device Driver (USBD)
|
||||
------------------------
|
||||
|
||||
- Add new (optional) endpoint ADPI usbd_edpt_xfer_fifo
|
||||
|
||||
Device Class Driver
|
||||
-------------------
|
||||
|
||||
CDC
|
||||
|
||||
- [Breaking] tud_cdc_peek(), tud_vendor_peek() no longer support random offset and dropped position parameter.
|
||||
|
||||
DFU
|
||||
|
||||
- Add new DFU 1.1 class driver (WIP)
|
||||
|
||||
HID
|
||||
|
||||
- Fix keyboard report descriptor template
|
||||
- Add more hid keys constant from 0x6B to 0xA4
|
||||
|
||||
- [Breaking] rename API
|
||||
- HID_PROTOCOL_NONE/KEYBOARD/MOUST to HID_ITF_PROTOCOL_NONE/KEYBOARD/MOUSE
|
||||
- tud_hid_boot_mode() to tud_hid_get_protocol()
|
||||
- tud_hid_boot_mode_cb() to tud_hid_set_protocol_cb()
|
||||
|
||||
MIDI
|
||||
|
||||
- Fix MIDI buffer overflow issue
|
||||
|
||||
- [Breaking] rename API
|
||||
- Rename tud_midi_read() to tud_midi_stream_read()
|
||||
- Rename tud_midi_write() to tud_midi_stream_write()
|
||||
- Rename tud_midi_receive() to tud_midi_packet_read()
|
||||
- Rename tud_midi_send() to tud_midi_packet_write()
|
||||
|
||||
Host Controller Driver (HCD)
|
||||
----------------------------
|
||||
|
||||
- No noticeable changes
|
||||
|
||||
USB Host Driver (USBH)
|
||||
----------------------
|
||||
|
||||
- No noticeable changes
|
||||
|
||||
Host Class Driver
|
||||
-----------------
|
||||
|
||||
- HID: Rework host hid driver, basically everything changes
|
||||
|
||||
|
||||
0.9.0 (2021-03-12)
|
||||
==================
|
||||
|
||||
Device Stack
|
||||
------------
|
||||
|
||||
Device Controller Driver (DCD)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
RP2040
|
||||
|
||||
- Fix endpoint buffer reallocation overrun problem
|
||||
- Fix osal_pico queue overflow in initialization
|
||||
- Fix Isochronous endpoint buffer size in transfer
|
||||
- Optimize hardware endpoint struct to reduce RAM usage
|
||||
- Fix enum walkaround forever check for SE0 when pull up is disabled
|
||||
|
||||
Sony CXD56
|
||||
|
||||
- Pass the correct speed on Spresense
|
||||
- Fix setup processed flag
|
||||
|
||||
NXP Transdimention
|
||||
|
||||
- Update dcd_init() to reset controller to device mode
|
||||
|
||||
USB Device Driver (USBD)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- Fix issue with status zlp (tud_control_status) is returned by class driver with SET/CLEAR_FEATURE for endpoint.
|
||||
- Correct endpoint size check for fullspeed bulk, can be 8, 16, 32, 64
|
||||
- Ack SET_INTERFACE even if it is not implemented by class driver.
|
||||
|
||||
Device Class Driver
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
DFU Runtime
|
||||
|
||||
- rename dfu_rt to dfu_runtime for easy reading
|
||||
|
||||
CDC
|
||||
|
||||
- Add tud_cdc_send_break_cb() to support break request
|
||||
- Improve CDC receive, minor behavior changes: when tud_cdc_rx_wanted_cb() is invoked wanted_char may not be the last byte in the fifo
|
||||
|
||||
HID
|
||||
|
||||
- [Breaking] Add itf argument to hid API to support multiple instances, follow API has signature changes
|
||||
|
||||
- tud_hid_descriptor_report_cb()
|
||||
- tud_hid_get_report_cb()
|
||||
- tud_hid_set_report_cb()
|
||||
- tud_hid_boot_mode_cb()
|
||||
- tud_hid_set_idle_cb()
|
||||
|
||||
- Add report complete callback tud_hid_report_complete_cb() API
|
||||
- Add DPad/Hat support for HID Gamepad
|
||||
|
||||
- `TUD_HID_REPORT_DESC_GAMEPAD()` now support 16 buttons, 2 joysticks, 1 hat/dpad
|
||||
- Add hid_gamepad_report_t along with `GAMEPAD_BUTTON_` and `GAMEPAD_HAT_` enum
|
||||
- Add Gamepad to hid_composite / hid_composite_freertos example
|
||||
|
||||
MIDI
|
||||
|
||||
- Fix dropping MIDI sysex message when fifo is full
|
||||
- Fix typo in tud_midi_write24(), make example less ambiguous for cable and channel
|
||||
- Fix incorrect endpoint descriptor length, MIDI v1 use Audio v1 which has 9-byte endpoint descriptor (instead of 7)
|
||||
|
||||
Host Stack
|
||||
----------
|
||||
|
||||
Host Controller Driver (HCD)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- Add rhport to hcd_init()
|
||||
- Improve EHCI/OHCI driver abstraction
|
||||
|
||||
- Move echi/ohci files to portable/
|
||||
- Rename hcd_lpc18_43 to hcd_transdimension
|
||||
- Sub hcd API with hcd_ehci_init(), hcd_ehci_register_addr()
|
||||
|
||||
- Update NXP transdimention hcd_init() to reset controller to host mode
|
||||
|
||||
- Ported hcd to rt10xx
|
||||
|
||||
USB Host Driver (USBH)
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- No noticeable changes to usbh
|
||||
|
||||
Host Class Driver
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
MSC
|
||||
|
||||
- Rename tuh_msc_scsi_inquiry() to tuh_msc_inquiry()
|
||||
- Rename tuh_msc_mounted_cb/tuh_msc_unmounted_cb to tuh_msc_mount_cb/tuh_msc_unmount_cb to match device stack naming
|
||||
- Change tuh_msc_is_busy() to tuh_msc_ready()
|
||||
- Add read10 and write10 function: tuh_msc_read10(), tuh_msc_write10()
|
||||
- Read_Capacity is invoked as part of enumeration process
|
||||
- Add tuh_msc_get_block_count(), tuh_msc_get_block_size()
|
||||
- Add CFG_TUH_MSC_MAXLUN (default to 4) to hold lun capacities
|
||||
|
||||
Others
|
||||
------
|
||||
|
||||
- Add basic support for rt-thread OS
|
||||
- Change zero bitfield length to more explicit padding
|
||||
- Build example now fetch required submodules on the fly while running `make` without prio submodule init for mcu drivers
|
||||
- Update pico-sdk to v1.1.0
|
||||
|
||||
**New Boards**
|
||||
|
||||
- Microchip SAM E54 Xplained Pro
|
||||
- LPCXpresso 55s28
|
||||
- LPCXpresso 18s37
|
||||
|
||||
|
||||
0.8.0 (2021-02-05)
|
||||
==================
|
||||
|
||||
Device Controller Driver
|
||||
------------------------
|
||||
|
||||
- Added new device support for Raspberry Pi RP2040
|
||||
- Added new device support for NXP Kinetis KL25ZXX
|
||||
- Use dcd_event_bus_reset() with link speed to replace bus_signal
|
||||
|
||||
- ESP32-S2:
|
||||
- Add bus suspend and wakeup support
|
||||
|
||||
- SAMD21:
|
||||
- Fix (walkaround) samd21 setup_packet overflow by USB DMA
|
||||
|
||||
- STM32 Synopsys:
|
||||
- Rework USB FIFO allocation scheme and allow RX FIFO size reduction
|
||||
|
||||
- Sony CXD56
|
||||
- Update Update Spresense SDK to 2.0.2
|
||||
- Fix dcd issues with setup packets
|
||||
- Correct EP number for cdc_msc example
|
||||
|
||||
USB Device
|
||||
----------
|
||||
|
||||
**USBD**
|
||||
|
||||
- Rework usbd control transfer to have additional stage parameter for setup, data, status
|
||||
- Fix tusb_init() return true instead of TUSB_ERROR_NONE
|
||||
- Added new API tud_connected() that return true after device got out of bus reset and received the very first setup packet
|
||||
|
||||
**Class Driver**
|
||||
|
||||
- CDC
|
||||
- Allow to transmit data, even if the host does not support control line states i.e set DTR
|
||||
|
||||
- HID
|
||||
- change default CFG_TUD_HID_EP_BUFSIZE from 16 to 64
|
||||
|
||||
- MIDI
|
||||
- Fix midi sysex sending bug
|
||||
|
||||
- MSC
|
||||
- Invoke only scsi complete callback after status transaction is complete.
|
||||
- Fix scsi_mode_sense6_t padding, which cause IAR compiler internal error.
|
||||
|
||||
- USBTMC
|
||||
- Change interrupt endpoint example size to 8 instead of 2 for better compatibility with mcu
|
||||
|
||||
**Example**
|
||||
|
||||
- Support make from windows cmd.exe
|
||||
- Add HID Consumer Control (media keys) to hid_composite & hid_composite_freertos examples
|
||||
|
||||
|
||||
USB Host
|
||||
--------
|
||||
|
||||
No noticeable changes to host stack
|
||||
|
||||
New Boards
|
||||
----------
|
||||
|
||||
- NXP/Freescale Freedom FRDM-KL25Z
|
||||
- Feather Double M33 express
|
||||
- Raspberry Pi Pico
|
||||
- Adafruit Feather RP2040
|
||||
- Adafruit Itsy Bitsy RP2040
|
||||
- Adafruit QT RP2040
|
||||
- Adfruit Feather ESP32-S2
|
||||
- Adafruit Magtag 29" Eink
|
||||
- Adafruit Metro ESP32-S2
|
||||
- Adafruit PyBadge
|
||||
- Adafruit PyPortal
|
||||
- Great Scott Gadgets' LUNA D11 & D21
|
||||
|
||||
|
||||
0.7.0 (2020-11-08)
|
||||
==================
|
||||
|
||||
Device Controller Driver
|
||||
------------------------
|
||||
|
||||
- Added new support for Espressif ESP32-S2
|
||||
- Added new support for Dialog DA1469x
|
||||
- Enhance STM32 Synopsys
|
||||
|
||||
- Support bus events disconnection/suspend/resume/wakeup
|
||||
- Improve transfer performance with optimizing xfer and fifo size
|
||||
- Support Highspeed port (OTG_HS) with both internal and external PHY
|
||||
- Support multiple usb ports with rhport=1 is highspeed on selected MCUs e.g H743, F23. It is possible to have OTG_HS to run on Fullspeed PHY (e.g lacking external PHY)
|
||||
- Add ISO transfer, fix odd/even frame
|
||||
- Fix FIFO flush during stall
|
||||
- Implement dcd_edpt_close() API
|
||||
- Support F105, F107
|
||||
|
||||
- Enhance STM32 fsdev
|
||||
- Improve dcd fifo allocation
|
||||
- Fix ISTR race condition
|
||||
- Support remap USB IRQ on supported MCUs
|
||||
- Implement dcd_edpt_close() API
|
||||
|
||||
- Enhance NUC 505: enhance set configure behavior
|
||||
|
||||
- Enhance SAMD
|
||||
- Fix race condition with setup packet
|
||||
- Add SAMD11 option `OPT_MCU_SAMD11`
|
||||
- Add SAME5x option `OPT_MCU_SAME5X`
|
||||
|
||||
- Fix SAMG control data toggle and stall race condition
|
||||
|
||||
- Enhance nRF
|
||||
- Fix hanged when tud_task() is called within critical section (disabled interrupt)
|
||||
- Fix disconnect bus event not submitted
|
||||
- Implement ISO transfer and dcd_edpt_close()
|
||||
|
||||
|
||||
USB Device
|
||||
----------
|
||||
|
||||
**USBD**
|
||||
|
||||
- Add new class driver for **Bluetooth HCI** class driver with example can be found in [mynewt-tinyusb-example](https://github.com/hathach/mynewt-tinyusb-example) since it needs mynewt OS to run with.
|
||||
- Fix USBD endpoint usage racing condition with `usbd_edpt_claim()/usbd_edpt_release()`
|
||||
- Added `tud_task_event_ready()` and `osal_queue_empty()`. This API is needed to check before enter low power mode with WFI/WFE
|
||||
- Rename USB IRQ Handler to `dcd_int_handler()`. Application must define IRQ handler in which it calls this API.
|
||||
- Add `dcd_connect()` and `dcd_disconnect()` to enable/disable internal pullup on D+/D- on supported MCUs.
|
||||
- Add `usbd_edpt_open()`
|
||||
- Remove `dcd_set_config()`
|
||||
- Add *OPT_OS_CUMSTOM* as hook for application to overwrite and/or add their own OS implementation
|
||||
- Support SET_INTERFACE, GET_INTERFACE request
|
||||
- Add Logging for debug with optional uart/rtt/swo printf retarget or `CFG_TUSB_DEBUG_PRINTF` hook
|
||||
- Add IAR compiler support
|
||||
- Support multiple configuration descriptors. `TUD_CONFIG_DESCRIPTOR()` template has extra config_num as 1st argument
|
||||
- Improve USB Highspeed support with actual link speed detection with `dcd_event_bus_reset()`
|
||||
|
||||
- Enhance class driver management
|
||||
- `usbd_driver_open()` add max length argument, and return length of interface (0 for not supported). Return value is used for finding appropriate driver
|
||||
- Add application implemented class driver via `usbd_app_driver_get_cb()`
|
||||
- IAD is handled to assign driver id
|
||||
|
||||
- Added `tud_descriptor_device_qualifier_cb()` callback
|
||||
- Optimize `tu_fifo` bulk write/read transfer
|
||||
- Forward non-std control request to class driver
|
||||
- Let application handle Microsoft OS 1.0 Descriptors (the 0xEE index string)
|
||||
- Fix OSAL FreeRTOS yield from ISR
|
||||
|
||||
**Class Drivers**
|
||||
|
||||
- USBNET: remove ACM-EEM due to lack of support from host
|
||||
- USBTMC: fix descriptors when INT EP is disabled
|
||||
|
||||
- CDC:
|
||||
- Send zero length packet for end of data when needed
|
||||
- Add `tud_cdc_tx_complete_cb()` callback
|
||||
- Change tud_cdc_n_write_flush() return number of bytes forced to transfer, and flush when writing enough data to fifo
|
||||
|
||||
- MIDI:
|
||||
- Add packet interface
|
||||
- Add multiple jack descriptors
|
||||
- Fix MIDI driver for sysex
|
||||
|
||||
- DFU Runtime: fix response to SET_INTERFACE and DFU_GETSTATUS request
|
||||
|
||||
- Rename some configure macro to make it clear that those are used directly for endpoint transfer
|
||||
- CFG_TUD_HID_BUFSIZE to CFG_TUD_HID_EP_BUFSIZE
|
||||
- CFG_TUD_CDC_EPSIZE to CFG_TUD_CDC_EP_BUFSIZE
|
||||
- CFG_TUD_MSC_BUFSIZE to CFG_TUD_MSC_EP_BUFSIZE
|
||||
- CFG_TUD_MIDI_EPSIZE to CFG_TUD_MIDI_EP_BUFSIZE
|
||||
|
||||
- HID:
|
||||
- Fix gamepad template descriptor
|
||||
- Add multiple HID interface API
|
||||
- Add extra comma to HID_REPORT_ID
|
||||
|
||||
USB Host
|
||||
--------
|
||||
|
||||
- Rework USB host stack (still work in progress)
|
||||
- Fix compile error with pipehandle
|
||||
- Rework usbh control and enumeration as non-blocking
|
||||
|
||||
- Improve Hub, MSC, HID host driver
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
- Add new hid_composite_freertos
|
||||
- Add new dynamic_configuration to demonstrate how to switch configuration descriptors
|
||||
- Add new hid_multiple_interface
|
||||
|
||||
- Enhance `net_lwip_webserver` example
|
||||
- Add multiple configuration: RNDIS for Windows, CDC-ECM for macOS (Linux will work with both)
|
||||
- Update lwip to STABLE-2_1_2_RELEASE for net_lwip_webserver
|
||||
|
||||
- Added new Audio example: audio_test uac2_headsest
|
||||
|
||||
New Boards
|
||||
----------
|
||||
|
||||
- Espressif ESP32-S2: saola_1, kaluga_1
|
||||
- STM32: F746 Nucleo, H743 Eval, H743 Nucleo, F723 discovery, stlink v3 mini, STM32L4r5 Nucleo
|
||||
- Dialog DA1469x dk pro and dk usb
|
||||
- Microchip: Great Scoot Gadgets' LUNA, samd11_xplained, D5035-01, atsamd21 xplained pro
|
||||
- nRF: ItsyBitsy nRF52840
|
||||
|
||||
|
||||
0.6.0 (2020-03-30)
|
||||
==================
|
||||
|
||||
Added **CONTRIBUTORS.md** to give proper credit for contributors to the stack. Special thanks to `Nathan Conrad <https://github.com/pigrew>`__ , `Peter Lawrence <https://github.com/majbthrd>`__ , `William D. Jones <https://github.com/cr1901>`__ and `Sean Cross <https://github.com/xobs>`__ and others for spending their precious time to add lots of features and ports for this release.
|
||||
|
||||
Added
|
||||
-----
|
||||
|
||||
**MCU**
|
||||
|
||||
- Added support for Microchip SAMG55
|
||||
- Added support for Nordic nRF52833
|
||||
- Added support for Nuvoton: NUC120, NUC121/NUC125, NUC126, NUC505
|
||||
- Added support for NXP LPC: 51Uxx, 54xxx, 55xx
|
||||
- Added support for NXP iMXRT: RT1011, RT1015, RT1021, RT1052, RT1062, RT1064
|
||||
- Added support for Sony CXD56 (Spresense)
|
||||
- Added support for STM32: L0, F0, F1, F2, F3, F4, F7, H7
|
||||
- Added support for TI MSP430
|
||||
- Added support for ValentyUSB's eptri
|
||||
|
||||
**Class Driver**
|
||||
|
||||
- Added DFU Runtime class driver
|
||||
- Added Network class driver with RNDIS, CDC-ECM, CDC-EEM (work in progress)
|
||||
- Added USBTMC class driver
|
||||
- Added WebUSB class driver using vendor-specific class
|
||||
- Added multiple instances support for CDC and MIDI
|
||||
- Added a handful of unit test with Ceedling.
|
||||
- Added LOG support for debugging with CFG_TUSB_DEBUG
|
||||
- Added `tud_descriptor_bos_cb()` for BOS descriptor (required for USB 2.1)
|
||||
- Added `dcd_edpt0_status_complete()` as optional API for DCD
|
||||
|
||||
**Examples**
|
||||
|
||||
Following examples are added:
|
||||
|
||||
- board_test
|
||||
- cdc_dual_ports
|
||||
- dfu_rt
|
||||
- hid_composite
|
||||
- net_lwip_webserver
|
||||
- usbtmc
|
||||
- webusb_serial
|
||||
|
||||
Changed
|
||||
-------
|
||||
|
||||
- Changed `tud_descriptor_string_cb()` to have additional Language ID argument
|
||||
- Merged hal_nrf5x.c into dcd_nrf5x.c
|
||||
- Merged dcd_samd21.c and dcd_samd51.c into dcd_samd.c
|
||||
- Generalized dcd_stm32f4.c to dcd_synopsys.c
|
||||
- Changed cdc_msc_hid to cdc_msc (drop hid) due to limited endpoints number of some MCUs
|
||||
- Improved DCD SAMD stability, fix missing setup packet occasionally
|
||||
- Improved usbd/usbd_control with proper handling of zero-length packet (ZLP)
|
||||
- Improved STM32 DCD FSDev
|
||||
- Improved STM32 DCD Synopsys
|
||||
- Migrated CI from Travis to Github Action
|
||||
- Updated nrfx submodule to 2.1.0
|
||||
- Fixed mynewt osal queue definition
|
||||
- Fixed cdc_msc_freertos example build for all MCUs
|
||||
|
||||
|
||||
0.5.0 (2019-06)
|
||||
===============
|
||||
|
||||
First release, device stack works great, host stack works but still need improvement.
|
||||
|
||||
- Special thanks to @adafruit team, especially @tannewt to help out immensely to rework device stack: simplify osal & control transfer, adding SAMD21/SAMD51 ports, writing porting docs, adding MIDI class support etc...
|
||||
- Thanks to @cr1901 for adding STM32F4 port.
|
||||
- Thanks to @PTS93 and @todbot for HID raw API
|
||||
1
Firmware/Core/tinyusb/docs/info/contributors.rst
Symbolic link
1
Firmware/Core/tinyusb/docs/info/contributors.rst
Symbolic link
@ -0,0 +1 @@
|
||||
../../CONTRIBUTORS.rst
|
||||
13
Firmware/Core/tinyusb/docs/info/index.rst
Normal file
13
Firmware/Core/tinyusb/docs/info/index.rst
Normal file
@ -0,0 +1,13 @@
|
||||
****
|
||||
Info
|
||||
****
|
||||
|
||||
Index
|
||||
=====
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
uses
|
||||
changelog
|
||||
contributors
|
||||
17
Firmware/Core/tinyusb/docs/info/uses.rst
Normal file
17
Firmware/Core/tinyusb/docs/info/uses.rst
Normal file
@ -0,0 +1,17 @@
|
||||
****
|
||||
Uses
|
||||
****
|
||||
|
||||
TinyUSB is currently used by these other projects:
|
||||
|
||||
- `Adafruit nRF52 Arduino <https://github.com/adafruit/Adafruit_nRF52_Arduino>`__
|
||||
- `Adafruit nRF52 Bootloader <https://github.com/adafruit/Adafruit_nRF52_Bootloader>`__
|
||||
- `Adafruit SAMD Arduino <https://github.com/adafruit/ArduinoCore-samd>`__
|
||||
- `CircuitPython <https://github.com/adafruit/circuitpython>`__
|
||||
- `Espressif IDF <https://github.com/espressif/esp-idf>`__
|
||||
- `MicroPython <https://github.com/micropython/micropython>`__
|
||||
- `mynewt <https://mynewt.apache.org>`__
|
||||
- `openinput <https://github.com/openinput-fw/openinput>`__
|
||||
- `Raspberry Pi Pico SDK <https://github.com/raspberrypi/pico-sdk>`__
|
||||
- `TinyUF2 Bootloader <https://github.com/adafruit/tinyuf2>`__
|
||||
- `TinyUSB Arduino Library <https://github.com/adafruit/Adafruit_TinyUSB_Arduino>`__
|
||||
42
Firmware/Core/tinyusb/docs/reference/concurrency.rst
Normal file
42
Firmware/Core/tinyusb/docs/reference/concurrency.rst
Normal file
@ -0,0 +1,42 @@
|
||||
***********
|
||||
Concurrency
|
||||
***********
|
||||
|
||||
The TinyUSB library is designed to operate on single-core MCUs with multi-threaded applications in mind. Interaction with interrupts is especially important to pay attention to.
|
||||
It is compatible with optionally using a RTOS.
|
||||
|
||||
General
|
||||
-------
|
||||
|
||||
When writing code, keep in mind that the OS (if using a RTOS) may swap out your code at any time. Also, your code can be preempted by an interrupt at any time.
|
||||
|
||||
Application Code
|
||||
----------------
|
||||
|
||||
The USB core does not execute application callbacks while in an interrupt context. Calls to application code are from within the USB core task context. Note that the application core will call class drivers from within their own task.
|
||||
|
||||
Class Drivers
|
||||
-------------
|
||||
|
||||
Class driver code should never be called from an interrupt context by the USB core, though the application is allowed to call class driver functions from interrupts. USB core functions may be called simultaneously by multiple tasks. Use care that proper locking is used to guard the USBD core functions from this case.
|
||||
|
||||
Class drivers are allowed to call ``usbd_*`` functions, but not ``dcd_*`` functions.
|
||||
|
||||
USB Core
|
||||
--------
|
||||
|
||||
All functions that may be called from an (USB core) interrupt context have a ``bool in_isr`` parameter to remind the implementer that special care must be taken.
|
||||
|
||||
Interrupt handlers must not directly call class driver code, they must pass a message to the USB core's task.
|
||||
|
||||
``usbd_*`` functions may be called from interrupts without any notice. They may also be called simultaneously by multiple tasks.
|
||||
|
||||
Device Drivers
|
||||
--------------
|
||||
|
||||
Much of the processing of the USB stack is done in an interrupt context, and care must be taken in order to ensure variables are handled in the appropriate ways by the compiler and optimizer.
|
||||
|
||||
In particular:
|
||||
|
||||
* Ensure that all memory-mapped registers (including packet memory) are marked as volatile. GCC's optimizer will even combine memory access (like two 16-bit to be a 32-bit) if you don't mark the pointers as volatile. On some architectures, this can use macros like _I , _O , or _IO.
|
||||
* All defined global variables are marked as ``static``.
|
||||
206
Firmware/Core/tinyusb/docs/reference/getting_started.rst
Normal file
206
Firmware/Core/tinyusb/docs/reference/getting_started.rst
Normal file
@ -0,0 +1,206 @@
|
||||
***************
|
||||
Getting Started
|
||||
***************
|
||||
|
||||
Add TinyUSB to your project
|
||||
---------------------------
|
||||
|
||||
It is relatively simple to incorporate tinyusb to your (existing) project
|
||||
|
||||
|
||||
* Copy or ``git submodule`` this repo into your project in a subfolder. Let's say it is *your_project/tinyusb*
|
||||
* Add all the .c in the ``tinyusb/src`` folder to your project
|
||||
* Add *your_project/tinyusb/src* to your include path. Also make sure your current include path also contains the configuration file tusb_config.h.
|
||||
* Make sure all required macros are all defined properly in tusb_config.h (configure file in demo application is sufficient, but you need to add a few more such as CFG_TUSB_MCU, CFG_TUSB_OS since they are passed by IDE/compiler to maintain a unique configure for all boards).
|
||||
* If you use the device stack, make sure you have created/modified usb descriptors for your own need. Ultimately you need to implement all **tud descriptor** callbacks for the stack to work.
|
||||
* Add tusb_init() call to your reset initialization code.
|
||||
* Call ``tud_int_handler()`` (device) and/or ``tuh_int_handler()`` (host) in your USB IRQ Handler
|
||||
* Implement all enabled classes's callbacks.
|
||||
* If you don't use any RTOSes at all, you need to continuously and/or periodically call tud_task()/tuh_task() function. All of the callbacks and functionality are handled and invoked within the call of that task runner.
|
||||
|
||||
.. code-block::
|
||||
|
||||
int main(void)
|
||||
{
|
||||
your_init_code();
|
||||
tusb_init(); // initialize tinyusb stack
|
||||
|
||||
while(1) // the mainloop
|
||||
{
|
||||
your_application_code();
|
||||
|
||||
tud_task(); // device task
|
||||
tuh_task(); // host task
|
||||
}
|
||||
}
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
For your convenience, TinyUSB contains a handful of examples for both host and device with/without RTOS to quickly test the functionality as well as demonstrate how API() should be used. Most examples will work on most of `the supported boards <supported.rst>`_. Firstly we need to ``git clone`` if not already
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ git clone https://github.com/hathach/tinyusb tinyusb
|
||||
$ cd tinyusb
|
||||
|
||||
Some TinyUSB examples also requires external submodule libraries in ``/lib`` such as FreeRTOS, Lightweight IP to build. Run following command to fetch them
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ git submodule update --init lib
|
||||
|
||||
Some ports will also require a port-specific SDK (e.g. RP2040) or binary (e.g. Sony Spresense) to build examples. They are out of scope for tinyusb, you should download/install it first according to its manufacturer guide.
|
||||
|
||||
Build
|
||||
^^^^^
|
||||
|
||||
To build example, first change directory to an example folder.
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ cd examples/device/cdc_msc
|
||||
|
||||
Before building, we need to download MCU driver submodule to provide low-level MCU peripheral's driver first. Run the ``get-deps`` target in one of the example folder as follow. You only need to do this once per mcu
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ make BOARD=feather_nrf52840_express get-deps
|
||||
|
||||
|
||||
Some modules (e.g. RP2040 and ESP32s2) require the project makefiles to be customized using CMake. If necessary apply any setup steps for the platform's SDK.
|
||||
|
||||
Then compile with ``make BOARD=[board_name] all``\ , for example
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ make BOARD=feather_nrf52840_express all
|
||||
|
||||
Note: ``BOARD`` can be found as directory name in ``hw/bsp``\ , either in its family/boards or directly under bsp (no family).
|
||||
Note: some examples especially those that uses Vendor class (e.g webUSB) may requires udev permission on Linux (and/or macOS) to access usb device. It depends on your OS distro, typically copy ``/examples/device/99-tinyusb.rules`` file to /etc/udev/rules.d/ then run ``sudo udevadm control --reload-rules && sudo udevadm trigger`` is good enough.
|
||||
|
||||
Port Selection
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
If a board has several ports, one port is chosen by default in the individual board.mk file. Use option ``PORT=x`` To choose another port. For example to select the HS port of a STM32F746Disco board, use:
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ make BOARD=stm32f746disco PORT=1 all
|
||||
|
||||
Port Speed
|
||||
~~~~~~~~~~
|
||||
|
||||
A MCU can support multiple operational speed. By default, the example build system will use the fastest supported on the board. Use option ``SPEED=full/high`` e.g To force F723 operate at full instead of default high speed
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ make BOARD=stm32f746disco SPEED=full all
|
||||
|
||||
Size Analysis
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
First install `linkermap tool <https://github.com/hathach/linkermap>`_ then ``linkermap`` target can be used to analyze code size. You may want to compile with ``NO_LTO=1`` since -flto merges code across .o files and make it difficult to analyze.
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ make BOARD=feather_nrf52840_express NO_LTO=1 all linkermap
|
||||
|
||||
Debug
|
||||
^^^^^
|
||||
|
||||
To compile for debugging add ``DEBUG=1``\ , for example
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ make BOARD=feather_nrf52840_express DEBUG=1 all
|
||||
|
||||
Log
|
||||
~~~
|
||||
|
||||
Should you have an issue running example and/or submitting an bug report. You could enable TinyUSB built-in debug logging with optional ``LOG=``. LOG=1 will only print out error message, LOG=2 print more information with on-going events. LOG=3 or higher is not used yet.
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ make BOARD=feather_nrf52840_express LOG=2 all
|
||||
|
||||
Logger
|
||||
~~~~~~
|
||||
|
||||
By default log message is printed via on-board UART which is slow and take lots of CPU time comparing to USB speed. If your board support on-board/external debugger, it would be more efficient to use it for logging. There are 2 protocols:
|
||||
|
||||
|
||||
* `LOGGER=rtt`: use `Segger RTT protocol <https://www.segger.com/products/debug-probes/j-link/technology/about-real-time-transfer/>`_
|
||||
|
||||
* Cons: requires jlink as the debugger.
|
||||
* Pros: work with most if not all MCUs
|
||||
* Software viewer is JLink RTT Viewer/Client/Logger which is bundled with JLink driver package.
|
||||
|
||||
* ``LOGGER=swo``\ : Use dedicated SWO pin of ARM Cortex SWD debug header.
|
||||
|
||||
* Cons: only work with ARM Cortex MCUs minus M0
|
||||
* Pros: should be compatible with more debugger that support SWO.
|
||||
* Software viewer should be provided along with your debugger driver.
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ make BOARD=feather_nrf52840_express LOG=2 LOGGER=rtt all
|
||||
$ make BOARD=feather_nrf52840_express LOG=2 LOGGER=swo all
|
||||
|
||||
Flash
|
||||
^^^^^
|
||||
|
||||
``flash`` target will use the default on-board debugger (jlink/cmsisdap/stlink/dfu) to flash the binary, please install those support software in advance. Some board use bootloader/DFU via serial which is required to pass to make command
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ make BOARD=feather_nrf52840_express flash
|
||||
$ make SERIAL=/dev/ttyACM0 BOARD=feather_nrf52840_express flash
|
||||
|
||||
Since jlink can be used with most of the boards, there is also ``flash-jlink`` target for your convenience.
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ make BOARD=feather_nrf52840_express flash-jlink
|
||||
|
||||
Some board use uf2 bootloader for drag & drop in to mass storage device, uf2 can be generated with ``uf2`` target
|
||||
|
||||
.. code-block::
|
||||
|
||||
$ make BOARD=feather_nrf52840_express all uf2
|
||||
|
||||
IAR Support
|
||||
^^^^^^^^^^^
|
||||
|
||||
IAR Project Connection files are provided to import TinyUSB stack into your project.
|
||||
|
||||
* A buldable project of your MCU need to be created in advance.
|
||||
|
||||
|
||||
* Take example of STM32F0:
|
||||
|
||||
- You need `stm32l0xx.h`, `startup_stm32f0xx.s`, `system_stm32f0xx.c`.
|
||||
|
||||
- `STM32L0xx_HAL_Driver` is only needed to run examples, TinyUSB stack itself doesn't rely on MCU's SDKs.
|
||||
|
||||
* Open `Tools -> Configure Custom Argument Variables` (Switch to `Global` tab if you want to do it for all your projects)
|
||||
Click `New Group ...`, name it to `TUSB`, Click `Add Variable ...`, name it to `TUSB_DIR`, change it's value to the path of your TinyUSB stack,
|
||||
for example `C:\\tinyusb`
|
||||
|
||||
Import stack only
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
1. Open `Project -> Add project Connection ...`, click `OK`, choose `tinyusb\\tools\\iar_template.ipcf`.
|
||||
|
||||
Run examples
|
||||
~~~~~~~~~~~~
|
||||
|
||||
1. (Python3 is needed) Run `iar_gen.py` to generate .ipcf files of examples:
|
||||
|
||||
.. code-block::
|
||||
|
||||
cd C:\tinyusb\tools
|
||||
python iar_gen.py
|
||||
|
||||
2. Open `Project -> Add project Connection ...`, click `OK`, choose `tinyusb\\examples\\(.ipcf of example)`.
|
||||
For example `C:\\tinyusb\\examples\\device\\cdc_msc\\iar_cdc_msc.ipcf`
|
||||
59
Firmware/Core/tinyusb/docs/reference/index.rst
Normal file
59
Firmware/Core/tinyusb/docs/reference/index.rst
Normal file
@ -0,0 +1,59 @@
|
||||
*********
|
||||
Reference
|
||||
*********
|
||||
|
||||
.. figure:: ../assets/stack.svg
|
||||
:width: 1600px
|
||||
:alt: stackup
|
||||
|
||||
representation of the TinyUSB stack.
|
||||
|
||||
Device Stack
|
||||
============
|
||||
|
||||
Supports multiple device configurations by dynamically changing usb descriptors. Low power functions such like suspend, resume, and remote wakeup. Following device classes are supported:
|
||||
|
||||
- Audio Class 2.0 (UAC2)
|
||||
- Bluetooth Host Controller Interface (BTH HCI)
|
||||
- Communication Class (CDC)
|
||||
- Device Firmware Update (DFU): DFU mode (WIP) and Runtinme
|
||||
- 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 (work in progress)
|
||||
- USB Test and Measurement Class (USBTMC)
|
||||
- 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
|
||||
|
||||
If you have special need, `usbd_app_driver_get_cb()` can be used to write your own class driver without modifying the stack. Here is how RPi team add their reset interface `raspberrypi/pico-sdk#197 <https://github.com/raspberrypi/pico-sdk/pull/197>`__
|
||||
|
||||
Host Stack
|
||||
==========
|
||||
|
||||
- Human Interface Device (HID): Keyboard, Mouse, Generic
|
||||
- Mass Storage Class (MSC)
|
||||
- Hub currently only supports 1 level of hub (due to my laziness)
|
||||
|
||||
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 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**
|
||||
- **FreeRTOS**
|
||||
- **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>`__
|
||||
|
||||
License
|
||||
=======
|
||||
|
||||
All TinyUSB sources in the `src` folder are licensed under MIT license. However, each file can be 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.
|
||||
|
||||
Index
|
||||
=====
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
supported
|
||||
getting_started
|
||||
concurrency
|
||||
406
Firmware/Core/tinyusb/docs/reference/supported.rst
Normal file
406
Firmware/Core/tinyusb/docs/reference/supported.rst
Normal file
@ -0,0 +1,406 @@
|
||||
*****************
|
||||
Supported Devices
|
||||
*****************
|
||||
|
||||
Supported MCUs
|
||||
==============
|
||||
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| Manufacturer | Family | Device | Host | Highspeed | Driver | Note |
|
||||
+==============+=======================+========+======+===========+===================+==============+
|
||||
| Broadcom | BCM2711, BCM2837 | ✔ | | ✔ | dwc2 | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| Dialog | DA1469x | ✔ | ✖ | ✖ | da146xx | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| Espressif | ESP32 S2, S3 | ✔ | | ✖ | dwc2 or esp32sx | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| GigaDevice | GD32VF103 | ✔ | | ✖ | dwc2 | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| Infineon | XMC4500 | ✔ | | ✖ | dwc2 | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| MicroChip | SAM D11, D21 | ✔ | | ✖ | samd | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | SAM D51, E5x | ✔ | | ✖ | samd | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | SAM G55 | ✔ | | ✖ | samg | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | SAM L21, L22 | ✔ | | ✖ | samd | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | SAM E70,S70,V70,V71 | ✔ | | ✔ | samx7x | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| NordicSemi | nRF52833, nRF52840 | ✔ | ✖ | ✖ | nrf5x | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | nRF5340 | ✔ | ✖ | ✖ | nrf5x | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| Nuvoton | NUC120 | ✔ | ✖ | ✖ | | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | NUC121/NUC125 | ✔ | ✖ | ✖ | | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | NUC126 | ✔ | ✖ | ✖ | | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | NUC505 | ✔ | | ✔ | | |
|
||||
+--------------+---------+-------------+--------+------+-----------+-------------------+--------------+
|
||||
| NXP | iMXRT | RT10xx | ✔ | ✔ | ✔ | ci_hs | |
|
||||
| | +-------------+--------+------+-----------+-------------------+--------------+
|
||||
| | | RT11xx | ✔ | ✔ | ✔ | ci_hs | |
|
||||
| +---------+-------------+--------+------+-----------+-------------------+--------------+
|
||||
| | Kinetis | KL25 | ✔ | ⚠ | ✖ | | |
|
||||
| | +-------------+--------+------+-----------+-------------------+--------------+
|
||||
| | | K32L2 | ✔ | | ✖ | | |
|
||||
| +---------+-------------+--------+------+-----------+-------------------+--------------+
|
||||
| | LPC | 11u, 13, 15 | ✔ | ✖ | ✖ | lpc_ip3511 | |
|
||||
| | +-------------+--------+------+-----------+-------------------+--------------+
|
||||
| | | 17, 40 | ✔ | ⚠ | ✖ | lpc17_40 | |
|
||||
| | +-------------+--------+------+-----------+-------------------+--------------+
|
||||
| | | 18, 43 | ✔ | ✔ | ✔ | ci_hs | |
|
||||
| | +-------------+--------+------+-----------+-------------------+--------------+
|
||||
| | | 51u | ✔ | ✖ | ✖ | lpc_ip3511 | |
|
||||
| | +-------------+--------+------+-----------+-------------------+--------------+
|
||||
| | | 54 | ✔ | | ✔ | lpc_ip3511 | |
|
||||
| | +-------------+--------+------+-----------+-------------------+--------------+
|
||||
| | | 55 | ✔ | | ✔ | lpc_ip3511 | |
|
||||
+--------------+---------+-------------+--------+------+-----------+-------------------+--------------+
|
||||
| Raspberry Pi | RP2040 | ✔ | ✔ | ✖ | rp2040, pio_usb | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| Renesas | RX 63N, 65N, 72N | ✔ | ✔ | ✖ | usba | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| Silabs | EFM32GG12 | ✔ | | ✖ | dwc2 | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| Sony | CXD56 | ✔ | ✖ | ✔ | cxd56 | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| ST STM32 | F0 | ✔ | ✖ | ✖ | stm32_fsdev | |
|
||||
| +----+------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | F1 | 102, 103 | ✔ | ✖ | ✖ | stm32_fsdev | |
|
||||
| | +------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | | 105, 107 | ✔ | | ✖ | dwc2 | |
|
||||
| +----+------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | F2 | ✔ | | ✔ | dwc2 | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | F3 | ✔ | ✖ | ✖ | stm32_fsdev | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | F4 | ✔ | | ✔ | dwc2 | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | F7 | ✔ | | ✔ | dwc2 | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | H7 | ✔ | | ✔ | dwc2 | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | G4 | ✔ | ✖ | ✖ | stm32_fsdev | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | L0, L1 | ✔ | ✖ | ✖ | stm32_fsdev | |
|
||||
| +----+------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | L4 | 4x2, 4x3 | ✔ | ✖ | ✖ | stm32_fsdev | |
|
||||
| | +------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | | 4x5, 4x6 | ✔ | | | dwc2 | |
|
||||
| +----+------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | L4+ | ✔ | | | dwc2 | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | U5 | ⚠ | | | dwc2 | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | WBx5 | ✔ | | | stm32_fsdev | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| TI | MSP430 | ✔ | ✖ | ✖ | msp430x5xx | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | MSP432E4 | ✔ | | ✖ | musb | |
|
||||
| +-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| | TM4C123 | ✔ | | ✖ | musb | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| ValentyUSB | eptri | ✔ | ✖ | ✖ | eptri | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
| WCH | CH32V307 | ✔ | | ✔ | ch32v307 | |
|
||||
+--------------+-----------------------+--------+------+-----------+-------------------+--------------+
|
||||
|
||||
|
||||
Table Legend
|
||||
------------
|
||||
|
||||
= ===================
|
||||
✔ Supported
|
||||
⚠ WIP/partial support
|
||||
✖ Not supported
|
||||
= ===================
|
||||
|
||||
Supported Boards
|
||||
================
|
||||
|
||||
The board support code is only used for self-contained examples and testing. It is not used when TinyUSB is part of a larger project. It is responsible for getting the MCU started and the USB peripheral clocked with minimal of on-board devices
|
||||
|
||||
- One LED : for status
|
||||
- One Button : to get input from user
|
||||
- One UART : optional for device, but required for host examples
|
||||
|
||||
The following boards are supported (sorted alphabetically):
|
||||
|
||||
Broadcom
|
||||
--------
|
||||
|
||||
- `Raspberry Pi CM4 <https://www.raspberrypi.com/products/compute-module-4>`__
|
||||
|
||||
Dialog DA146xx
|
||||
--------------
|
||||
|
||||
- `DA14695 Development Kit – USB <https://www.dialog-semiconductor.com/products/da14695-development-kit-usb>`__
|
||||
- `DA1469x Development Kit – Pro <https://www.dialog-semiconductor.com/products/da14695-development-kit-pro>`__
|
||||
|
||||
Espressif ESP32-S2
|
||||
------------------
|
||||
|
||||
- `Adafruit Feather ESP32-S2 <https://www.adafruit.com/product/5000>`__
|
||||
- `Adafruit Magtag 2.9" E-Ink WiFi Display <https://www.adafruit.com/product/4800>`__
|
||||
- `Adafruit Metro ESP32-S2 <https://www.adafruit.com/product/4775>`__
|
||||
- `ESP32-S2-Kaluga-1 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.html>`__
|
||||
- `ESP32-S2-Saola-1 <https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/hw-reference/esp32s2/user-guide-saola-1-v1.2.html>`__
|
||||
|
||||
GigaDevice
|
||||
----------
|
||||
|
||||
- `Sipeed Longan Nano <https://longan.sipeed.com/en/>`__
|
||||
|
||||
Infineon
|
||||
---------
|
||||
|
||||
XMC4000
|
||||
^^^^^^^
|
||||
|
||||
- `XMC4500 Relax (Lite) Kit <https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc45_relax_lite_v1/>`__
|
||||
|
||||
MicroChip
|
||||
---------
|
||||
|
||||
SAMD11 & SAMD21
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
- `Adafruit Circuit Playground Express <https://www.adafruit.com/product/3333>`__
|
||||
- `Adafruit Feather M0 Express <https://www.adafruit.com/product/3403>`__
|
||||
- `Adafruit ItsyBitsy M0 Express <https://www.adafruit.com/product/3727>`__
|
||||
- `Adafruit Metro M0 Express <https://www.adafruit.com/product/3505>`__
|
||||
- `Great Scott Gadgets LUNA <https://greatscottgadgets.com/luna/>`__
|
||||
- `Microchip SAMD11 Xplained Pro <https://www.microchip.com/developmenttools/ProductDetails/atsamd11-xpro>`__
|
||||
- `Microchip SAMD21 Xplained Pro <https://www.microchip.com/DevelopmentTools/ProductDetails/ATSAMD21-XPRO>`__
|
||||
- `Seeeduino Xiao <https://www.seeedstudio.com/Seeeduino-XIAO-Arduino-Microcontroller-SAMD21-Cortex-M0+-p-4426.html>`__
|
||||
|
||||
SAMD51 & SAME54
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
- `Adafruit Feather M4 Express <https://www.adafruit.com/product/3857>`__
|
||||
- `Adafruit ItsyBitsy M4 Express <https://www.adafruit.com/product/3800>`__
|
||||
- `Adafruit PyBadge <https://www.adafruit.com/product/4200>`__
|
||||
- `Adafruit PyPortal <https://www.adafruit.com/product/4116>`__
|
||||
- `Adafruit Metro M4 Express <https://www.adafruit.com/product/3382>`__
|
||||
- `D5035-01 <https://github.com/RudolphRiedel/USB_CAN-FD>`__
|
||||
- `Microchip SAME54 Xplained Pro <https://www.microchip.com/developmenttools/productdetails/atsame54-xpro>`__
|
||||
|
||||
SAME7x
|
||||
^^^^^^
|
||||
|
||||
- `Microchip SAME70 Xplained <https://www.microchip.com/en-us/development-tool/ATSAME70-XPLD>`_
|
||||
- `QMTECH ATSAME70N19 <https://www.aliexpress.com/item/1005003173783268.html>`_
|
||||
|
||||
SAMG
|
||||
^^^^
|
||||
|
||||
- `Microchip SAMG55 Xplained Pro <https://www.microchip.com/DevelopmentTools/ProductDetails/PartNO/ATSAMG55-XPRO>`__
|
||||
|
||||
SAML2x
|
||||
^^^^^^
|
||||
|
||||
- `SAML21 Xplaind Pro <https://www.microchip.com/DevelopmentTools/ProductDetails/ATSAML21-XPRO-B>`__
|
||||
- `SAML22 Feather <https://github.com/joeycastillo/Feather-Projects/tree/main/SAML22%20Feather>`__
|
||||
- `Sensor Watch <https://github.com/joeycastillo/Sensor-Watch>`__
|
||||
|
||||
Nordic nRF5x
|
||||
------------
|
||||
|
||||
- `Adafruit Circuit Playground Bluefruit <https://www.adafruit.com/product/4333>`__
|
||||
- `Adafruit CLUE <https://www.adafruit.com/product/4500>`__
|
||||
- `Adafruit Feather nRF52840 Express <https://www.adafruit.com/product/4062>`__
|
||||
- `Adafruit Feather nRF52840 Sense <https://www.adafruit.com/product/4516>`__
|
||||
- `Adafruit ItsyBitsy nRF52840 Express <https://www.adafruit.com/product/4481>`__
|
||||
- `Arduino Nano 33 BLE <https://store.arduino.cc/usa/nano-33-ble>`__
|
||||
- `Arduino Nano 33 BLE Sense <https://store.arduino.cc/usa/nano-33-ble-sense>`__
|
||||
- `Maker Diary nRF52840 MDK Dongle <https://wiki.makerdiary.com/nrf52840-mdk-usb-dongle>`__
|
||||
- `Nordic nRF52840 Development Kit (aka pca10056) <https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK>`__
|
||||
- `Nordic nRF52840 Dongle (aka pca10059) <https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-Dongle>`__
|
||||
- `Nordic nRF52833 Development Kit (aka pca10100) <https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52833-DK>`__
|
||||
- `Raytac MDBT50Q-RX Dongle <https://www.raytac.com/product/ins.php?index_id=89>`__
|
||||
|
||||
Nuvoton
|
||||
-------
|
||||
|
||||
- NuTiny SDK NUC120
|
||||
- `NuTiny NUC121S <https://direct.nuvoton.com/en/nutiny-nuc121s>`__
|
||||
- `NuTiny NUC125S <https://direct.nuvoton.com/en/nutiny-nuc125s>`__
|
||||
- `NuTiny NUC126V <https://direct.nuvoton.com/en/nutiny-nuc126v>`__
|
||||
- `NuTiny SDK NUC505Y <https://direct.nuvoton.com/en/nutiny-nuc505y>`__
|
||||
|
||||
NXP
|
||||
---
|
||||
|
||||
iMX RT
|
||||
^^^^^^
|
||||
|
||||
- `MIMX RT1010 Evaluation Kit <https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/i.mx-rt1010-evaluation-kit:MIMXRT1010-EVK>`__
|
||||
- `MIMX RT1015 Evaluation Kit <https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/i.mx-rt1015-evaluation-kit:MIMXRT1015-EVK>`__
|
||||
- `MIMX RT1020 Evaluation Kit <https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/i.mx-rt1020-evaluation-kit:MIMXRT1020-EVK>`__
|
||||
- `MIMX RT1050 Evaluation Kit <https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/i.mx-rt1050-evaluation-kit:MIMXRT1050-EVK>`__
|
||||
- `MIMX RT1060 Evaluation Kit <https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/mimxrt1060-evk-i.mx-rt1060-evaluation-kit:MIMXRT1060-EVK>`__
|
||||
- `MIMX RT1064 Evaluation Kit <https://www.nxp.com/design/development-boards/i.mx-evaluation-and-development-boards/mimxrt1064-evk-i.mx-rt1064-evaluation-kit:MIMXRT1064-EVK>`__
|
||||
- `Teensy 4.0 Development Board <https://www.pjrc.com/store/teensy40.html>`__
|
||||
- `Teensy 4.1 Development Board <https://www.pjrc.com/store/teensy41.html>`__
|
||||
|
||||
Kinetis
|
||||
^^^^^^^
|
||||
|
||||
- `Freedom FRDM-KL25Z <https://www.nxp.com/design/development-boards/freedom-development-boards/mcu-boards/freedom-development-platform-for-kinetis-kl14-kl15-kl24-kl25-mcus:FRDM-KL25Z>`__
|
||||
- `Freedom FRDM-K32L2B3 <https://www.nxp.com/design/development-boards/freedom-development-boards/mcu-boards/nxp-freedom-development-platform-for-k32-l2b-mcus:FRDM-K32L2B3>`__
|
||||
- `KUIIC <https://github.com/nxf58843/kuiic>`__
|
||||
|
||||
LPC 11-13-15
|
||||
^^^^^^^^^^^^
|
||||
|
||||
- `LPCXpresso 11u37 <https://www.nxp.com/design/microcontrollers-developer-resources/lpcxpresso-boards/lpcxpresso-board-for-lpc11u37h:OM13074>`__
|
||||
- `LPCXpresso 11u68 <https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc11u68:OM13058>`__
|
||||
- `LPCXpresso 1347 <https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc1347:OM13045>`__
|
||||
- `LPCXpresso 1549 <https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc1500-cortex-m3/lpcxpresso-board-for-lpc1549:OM13056>`__
|
||||
|
||||
LPC 17-40
|
||||
^^^^^^^^^
|
||||
|
||||
- `ARM mbed LPC1768 <https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc1700-cortex-m3/arm-mbed-lpc1768-board:OM11043>`__
|
||||
- `Embedded Artists LPC4088 Quick Start board <https://www.embeddedartists.com/products/lpc4088-quickstart-board>`__
|
||||
- `LPCXpresso 1769 <https://www.nxp.com/support/developer-resources/evaluation-and-development-boards/lpcxpresso-boards/lpcxpresso-board-for-lpc1769:OM13000>`__
|
||||
|
||||
LPC 18-43
|
||||
^^^^^^^^^
|
||||
|
||||
- `Embedded Artists LPC4357 Developer Kit <http://www.embeddedartists.com/products/kits/lpc4357_kit.php>`__
|
||||
- `Keil MCB1800 Evaluation Board <http://www.keil.com/mcb1800>`__
|
||||
- `LPCXpresso18S37 Development Board <https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc4000-cortex-m4/lpcxpresso18s37-development-board:OM13076>`__
|
||||
- `NGX LPC4330-Xplorer <https://www.nxp.com/design/designs/lpc4330-xplorer-board:OM13027>`__
|
||||
|
||||
LPC 51
|
||||
^^^^^^
|
||||
|
||||
- `LPCXpresso 51U68 <https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpcxpresso51u68-for-the-lpc51u68-mcus:OM40005>`__
|
||||
|
||||
LPC 54
|
||||
^^^^^^
|
||||
|
||||
- `LPCXpresso 54114 <https://www.nxp.com/design/microcontrollers-developer-resources/lpcxpresso-boards/lpcxpresso54114-board:OM13089>`__
|
||||
|
||||
LPC55
|
||||
^^^^^
|
||||
|
||||
- `Double M33 Express <https://www.crowdsupply.com/steiert-solutions/double-m33-express>`__
|
||||
- `LPCXpresso 55s28 EVK <https://www.nxp.com/design/software/development-software/lpcxpresso55s28-development-board:LPC55S28-EVK>`__
|
||||
- `LPCXpresso 55s69 EVK <https://www.nxp.com/design/development-boards/lpcxpresso-boards/lpcxpresso55s69-development-board:LPC55S69-EVK>`__
|
||||
- `MCU-Link <https://www.nxp.com/design/development-boards/lpcxpresso-boards/mcu-link-debug-probe:MCU-LINK>`__
|
||||
|
||||
Renesas RX
|
||||
----------
|
||||
|
||||
- `GR-CITRUS <https://www.renesas.com/us/en/products/gadget-renesas/boards/gr-citrus>`__
|
||||
- `Renesas RX65N Target Board <https://www.renesas.com/us/en/products/microcontrollers-microprocessors/rx-32-bit-performance-efficiency-mcus/rtk5rx65n0c00000br-target-board-rx65n>`__
|
||||
|
||||
Raspberry Pi RP2040
|
||||
-------------------
|
||||
|
||||
- `Adafruit Feather RP2040 <https://www.adafruit.com/product/4884>`__
|
||||
- `Adafruit ItsyBitsy RP2040 <https://www.adafruit.com/product/4888>`__
|
||||
- `Adafruit QT Py RP2040 <https://www.adafruit.com/product/4900>`__
|
||||
- `Raspberry Pi Pico <https://www.raspberrypi.org/products/raspberry-pi-pico/>`__
|
||||
|
||||
Silabs
|
||||
------
|
||||
|
||||
- `EFM32GG12 Thunderboard Kit (SLTB009A) <https://www.silabs.com/development-tools/thunderboard/thunderboard-gg12-kit>`__
|
||||
|
||||
Sony
|
||||
----
|
||||
|
||||
- `Sony Spresense CXD5602 <https://developer.sony.com/develop/spresense>`__
|
||||
|
||||
ST STM32
|
||||
--------
|
||||
|
||||
F0
|
||||
^^
|
||||
- `STM32 F070rb Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f070rb.html>`__
|
||||
- `STM32 F072 Evaluation <https://www.st.com/en/evaluation-tools/stm32072b-eval.html>`__
|
||||
- `STM32 F072rb Discovery <https://www.st.com/en/evaluation-tools/32f072bdiscovery.html>`__
|
||||
|
||||
F1
|
||||
^^
|
||||
- `STM32 F103c8 Blue Pill <https://stm32-base.org/boards/STM32F103C8T6-Blue-Pill>`__
|
||||
- `STM32 F103rc Mini v2.0 <https://stm32-base.org/boards/STM32F103RCT6-STM32-Mini-V2.0>`__
|
||||
|
||||
F2
|
||||
^^
|
||||
- `STM32 F207zg Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f207zg.html>`__
|
||||
|
||||
F3
|
||||
^^
|
||||
- `STM32 F303vc Discovery <https://www.st.com/en/evaluation-tools/stm32f3discovery.html>`__
|
||||
|
||||
F4
|
||||
^^
|
||||
- `Adafruit Feather STM32F405 <https://www.adafruit.com/product/4382>`__
|
||||
- `Micro Python PyBoard v1.1 <https://store.micropython.org/product/PYBv1.1>`__
|
||||
- `STM32 F401cc Black Pill <https://stm32-base.org/boards/STM32F401CCU6-WeAct-Black-Pill-V1.2>`__
|
||||
- `STM32 F407vg Discovery <https://www.st.com/en/evaluation-tools/stm32f4discovery.html>`__
|
||||
- `STM32 F411ce Black Pill <https://www.adafruit.com/product/4877>`__
|
||||
- `STM32 F411ve Discovery <https://www.st.com/en/evaluation-tools/32f411ediscovery.html>`__
|
||||
- `STM32 F412zg Discovery <https://www.st.com/en/evaluation-tools/32f412gdiscovery.html>`__
|
||||
- `STM32 F412zg Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f412zg.html>`__
|
||||
- `STM32 F439zi Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f439zi.html>`__
|
||||
|
||||
F7
|
||||
^^
|
||||
|
||||
- `STLink-V3 Mini <https://www.st.com/en/development-tools/stlink-v3mini.html>`__
|
||||
- `STM32 F723e Discovery <https://www.st.com/en/evaluation-tools/32f723ediscovery.html>`__
|
||||
- `STM32 F746zg Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f746zg.html>`__
|
||||
- `STM32 F746g Discovery <https://www.st.com/en/evaluation-tools/32f746gdiscovery.html>`__
|
||||
- `STM32 F767zi Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f767zi.html>`__
|
||||
- `STM32 F769i Discovery <https://www.st.com/en/evaluation-tools/32f769idiscovery.html>`__
|
||||
|
||||
H7
|
||||
^^
|
||||
- `STM32 H743zi Nucleo <https://www.st.com/en/evaluation-tools/nucleo-h743zi.html>`__
|
||||
- `STM32 H743i Evaluation <https://www.st.com/en/evaluation-tools/stm32h743i-eval.html>`__
|
||||
- `STM32 H745i Discovery <https://www.st.com/en/evaluation-tools/stm32h745i-disco.html>`__
|
||||
- `Waveshare OpenH743I-C <https://www.waveshare.com/openh743i-c-standard.htm>`__
|
||||
|
||||
G4
|
||||
^^
|
||||
- `STM32 G474RE Nucleo <https://www.st.com/en/evaluation-tools/nucleo-g474re.html>`__
|
||||
|
||||
L0
|
||||
^^
|
||||
- `STM32 L035c8 Discovery <https://www.st.com/en/evaluation-tools/32l0538discovery.html>`__
|
||||
|
||||
L4
|
||||
^^
|
||||
- `STM32 L476vg Discovery <https://www.st.com/en/evaluation-tools/32l476gdiscovery.html>`__
|
||||
- `STM32 L4P5zg Nucleo <https://www.st.com/en/evaluation-tools/nucleo-l4p5zg.html>`__
|
||||
- `STM32 L4R5zi Nucleo <https://www.st.com/en/evaluation-tools/nucleo-l4r5zi.html>`__
|
||||
|
||||
WB
|
||||
^^
|
||||
- `STM32 WB55 Nucleo <https://www.st.com/en/evaluation-tools/p-nucleo-wb55.html>`__
|
||||
|
||||
TI
|
||||
--
|
||||
|
||||
- `MSP430F5529 USB LaunchPad Evaluation Kit <http://www.ti.com/tool/MSP-EXP430F5529LP>`__
|
||||
- `MSP-EXP432E401Y LaunchPad Evaluation Kit <https://www.ti.com/tool/MSP-EXP432E401Y>`__
|
||||
- `TM4C123GXL LaunchPad Evaluation Kit <https://www.ti.com/tool/EK-TM4C123GXL>`__
|
||||
|
||||
Tomu
|
||||
----
|
||||
|
||||
- `Fomu <https://www.crowdsupply.com/sutajio-kosagi/fomu>`__
|
||||
|
||||
WCH
|
||||
---
|
||||
|
||||
- `CH32V307V-R1-1v0 <https://lcsc.com/product-detail/Development-Boards-Kits_WCH-Jiangsu-Qin-Heng-CH32V307V-EVT-R1_C2943980.html>`
|
||||
4
Firmware/Core/tinyusb/docs/requirements.txt
Normal file
4
Firmware/Core/tinyusb/docs/requirements.txt
Normal file
@ -0,0 +1,4 @@
|
||||
sphinx~=3.0
|
||||
furo>=2020.12.30.b24
|
||||
sphinx-autodoc-typehints>=1.10
|
||||
jinja2==3.0.3
|
||||
Reference in New Issue
Block a user