parent
a04e4ca9ac
commit
12078447a2
1551 changed files with 370972 additions and 1 deletions
@ -1 +0,0 @@ |
||||
Subproject commit 2062372d203b372849d573f252cf7c6dc2800c0a |
||||
@ -0,0 +1,56 @@ |
||||
cmake_minimum_required(VERSION 3.13) |
||||
|
||||
# Note: this CMakeLists.txt can be used as a top-level CMakeLists.txt for the SDK itself. For all other uses |
||||
# it is included as a subdirectory via the pico_sdk_init() method provided by pico_sdk_init.cmake |
||||
if (NOT TARGET _pico_sdk_inclusion_marker) |
||||
add_library(_pico_sdk_inclusion_marker INTERFACE) |
||||
# This is a no-op unless we are the top-level CMakeLists.txt |
||||
include(pico_sdk_init.cmake) |
||||
|
||||
project(pico_sdk C CXX ASM) |
||||
|
||||
if ("${CMAKE_BUILD_TYPE}" STREQUAL "Debug") |
||||
if (PICO_DEOPTIMIZED_DEBUG) |
||||
message("Using fully de-optimized debug build (set PICO_DEOPTIMIZED_DEBUG=0 to optimize)") |
||||
else() |
||||
message("Using regular optimized debug build (set PICO_DEOPTIMIZED_DEBUG=1 to de-optimize)") |
||||
endif() |
||||
endif() |
||||
|
||||
pico_is_top_level_project(PICO_SDK_TOP_LEVEL_PROJECT) |
||||
|
||||
set(CMAKE_C_STANDARD 11) |
||||
set(CMAKE_CXX_STANDARD 11) |
||||
|
||||
if (NOT PICO_SDK_TOP_LEVEL_PROJECT) |
||||
set(PICO_SDK 1 PARENT_SCOPE) |
||||
endif() |
||||
|
||||
# allow customization |
||||
add_sub_list_dirs(PICO_SDK_PRE_LIST_DIRS) |
||||
add_sub_list_files(PICO_SDK_PRE_LIST_FILES) |
||||
|
||||
add_subdirectory(tools) |
||||
add_subdirectory(src) |
||||
|
||||
# allow customization |
||||
add_sub_list_dirs(PICO_SDK_POST_LIST_DIRS) |
||||
add_sub_list_files(PICO_SDK_POST_LIST_FILES) |
||||
|
||||
if (PICO_SDK_TOP_LEVEL_PROJECT AND NOT DEFINED PICO_SDK_TESTS_ENABLED) |
||||
set(PICO_SDK_TESTS_ENABLED 1) |
||||
endif() |
||||
if (PICO_SDK_TESTS_ENABLED) |
||||
add_subdirectory(test) |
||||
endif () |
||||
|
||||
set(PICO_SDK_TESTS_ENABLED "${PICO_SDK_TESTS_ENABLED}" CACHE INTERNAL "Enable build of SDK tests") |
||||
|
||||
# add docs at the end, as we gather documentation dirs as we go |
||||
add_subdirectory(docs) |
||||
|
||||
if (NOT PICO_SDK_TOP_LEVEL_PROJECT) |
||||
pico_promote_common_scope_vars() |
||||
endif() |
||||
endif() |
||||
|
||||
@ -0,0 +1,25 @@ |
||||
# Contributing to Raspberry Pi Pico C/C++ SDK |
||||
|
||||
## How to Report a Bug |
||||
|
||||
We use GitHub to host code, track [issues](https://github.com/raspberrypi/pico-sdk/issues) and feature requests, and to accept [pull requests](https://github.com/raspberrypi/pico-sdk/pulls). If you find think you have found a bug in the SDK please report it by [opening a new issue](https://github.com/raspberrypi/pico-sdk/issues/new). Please include as much detail as possible, and ideally some code to reproduce the problem. |
||||
|
||||
## How to Contribute Code |
||||
|
||||
In order to contribute new or updated code, you must first create a GitHub account and fork the original repository to your own account. You can make changes, save them in your repository, then [make a pull request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) against this repository. The pull request will appear [in the repository](https://github.com/raspberrypi/pico-sdk/pulls) where it can be assessed by the maintainers, and if appropriate, merged with the official repository. |
||||
|
||||
**NOTE:** Development takes place on the `develop` branch in this repository. Please open your https://github.com/raspberrypi/pico-sdk/pulls[pull request] (PR) against the [`develop`](https://github.com/raspberrypi/pico-sdk/tree/develop) branch, pull requests against the `master` branch will automatically CI fail checks and will not be accepted. You will be asked to rebase your PR against `develop` and if you do not do so, your PR will be closed. |
||||
|
||||
While we are happy to take contributions, big or small, changes in the SDK may have knock-on effects in other places so it is possible that apparently benign pull requests that make seemingly small changes could be refused. |
||||
|
||||
### Code Style |
||||
|
||||
If you are contributing new or updated code please match the existing code style, particularly: |
||||
|
||||
* Use 4 spaces for indentation rather than tabs. |
||||
* Braces are required for everything except single line `if` statements. |
||||
* Opening braces should not be placed on a new line. |
||||
|
||||
### Licensing |
||||
|
||||
Code in this repository is lisensed under the [BSD-3 License](LICENSE.TXT). By contributing content to this repository you are agreeing to place your contributions under this licence. |
||||
@ -0,0 +1,21 @@ |
||||
Copyright 2020 (c) 2020 Raspberry Pi (Trading) Ltd. |
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the |
||||
following conditions are met: |
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following |
||||
disclaimer. |
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following |
||||
disclaimer in the documentation and/or other materials provided with the distribution. |
||||
|
||||
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products |
||||
derived from this software without specific prior written permission. |
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
||||
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
||||
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
||||
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
@ -0,0 +1,158 @@ |
||||
# Raspberry Pi Pico SDK |
||||
|
||||
The Raspberry Pi Pico SDK (henceforth the SDK) provides the headers, libraries and build system |
||||
necessary to write programs for the RP2040-based devices such as the Raspberry Pi Pico |
||||
in C, C++ or assembly language. |
||||
|
||||
The SDK is designed to provide an API and programming environment that is familiar both to non-embedded C developers and embedded C developers alike. |
||||
A single program runs on the device at a time and starts with a conventional `main()` method. Standard C/C++ libraries are supported along with |
||||
C level libraries/APIs for accessing all of the RP2040's hardware include PIO (Programmable IO). |
||||
|
||||
Additionally the SDK provides higher level libraries for dealing with timers, synchronization, USB (TinyUSB) and multi-core programming |
||||
along with various utilities. |
||||
|
||||
The SDK can be used to build anything from simple applications, to fully fledged runtime environments such as MicroPython, to low level software |
||||
such as RP2040's on-chip bootrom itself. |
||||
|
||||
Additional libraries/APIs that are not yet ready for inclusion in the SDK can be found in [pico-extras](https://github.com/raspberrypi/pico-extras). |
||||
|
||||
# Documentation |
||||
|
||||
See [Getting Started with the Raspberry Pi Pico](https://rptl.io/pico-get-started) for information on how to setup your |
||||
hardware, IDE/environment and for how to build and debug software for the Raspberry Pi Pico |
||||
and other RP2040-based devices. |
||||
|
||||
See [Raspberry Pi Pico C/C++ SDK](https://rptl.io/pico-c-sdk) to learn more about programming using the |
||||
SDK, to explore more advanced features, and for complete PDF-based API documentation. |
||||
|
||||
See [Online Raspberry Pi Pico SDK API docs](https://rptl.io/pico-doxygen) for HTML-based API documentation. |
||||
|
||||
# Example code |
||||
|
||||
See [pico-examples](https://github.com/raspberrypi/pico-examples) for example code you can build. |
||||
|
||||
# Quick-start your own project |
||||
|
||||
These instructions are extremely terse, and Linux-based only. For detailed steps, |
||||
instructions for other platforms, and just in general, we recommend you see [Raspberry Pi Pico C/C++ SDK](https://rptl.io/pico-c-sdk) |
||||
|
||||
1. Install CMake (at least version 3.13), and GCC cross compiler |
||||
``` |
||||
sudo apt install cmake gcc-arm-none-eabi libnewlib-arm-none-eabi libstdc++-arm-none-eabi-newlib |
||||
``` |
||||
1. Set up your project to point to use the Raspberry Pi Pico SDK |
||||
|
||||
* Either by cloning the SDK locally (most common) : |
||||
1. `git clone` this Raspberry Pi Pico SDK repository |
||||
1. Copy [pico_sdk_import.cmake](https://github.com/raspberrypi/pico-sdk/blob/master/external/pico_sdk_import.cmake) |
||||
from the SDK into your project directory |
||||
2. Set `PICO_SDK_PATH` to the SDK location in your environment, or pass it (`-DPICO_SDK_PATH=`) to cmake later. |
||||
3. Setup a `CMakeLists.txt` like: |
||||
|
||||
```cmake |
||||
cmake_minimum_required(VERSION 3.13) |
||||
|
||||
# initialize the SDK based on PICO_SDK_PATH |
||||
# note: this must happen before project() |
||||
include(pico_sdk_import.cmake) |
||||
|
||||
project(my_project) |
||||
|
||||
# initialize the Raspberry Pi Pico SDK |
||||
pico_sdk_init() |
||||
|
||||
# rest of your project |
||||
|
||||
``` |
||||
|
||||
* Or with the Raspberry Pi Pico SDK as a submodule : |
||||
1. Clone the SDK as a submodule called `pico-sdk` |
||||
1. Setup a `CMakeLists.txt` like: |
||||
|
||||
```cmake |
||||
cmake_minimum_required(VERSION 3.13) |
||||
|
||||
# initialize pico-sdk from submodule |
||||
# note: this must happen before project() |
||||
include(pico-sdk/pico_sdk_init.cmake) |
||||
|
||||
project(my_project) |
||||
|
||||
# initialize the Raspberry Pi Pico SDK |
||||
pico_sdk_init() |
||||
|
||||
# rest of your project |
||||
|
||||
``` |
||||
|
||||
* Or with automatic download from GitHub : |
||||
1. Copy [pico_sdk_import.cmake](https://github.com/raspberrypi/pico-sdk/blob/master/external/pico_sdk_import.cmake) |
||||
from the SDK into your project directory |
||||
1. Setup a `CMakeLists.txt` like: |
||||
|
||||
```cmake |
||||
cmake_minimum_required(VERSION 3.13) |
||||
|
||||
# initialize pico-sdk from GIT |
||||
# (note this can come from environment, CMake cache etc) |
||||
set(PICO_SDK_FETCH_FROM_GIT on) |
||||
|
||||
# pico_sdk_import.cmake is a single file copied from this SDK |
||||
# note: this must happen before project() |
||||
include(pico_sdk_import.cmake) |
||||
|
||||
project(my_project) |
||||
|
||||
# initialize the Raspberry Pi Pico SDK |
||||
pico_sdk_init() |
||||
|
||||
# rest of your project |
||||
|
||||
``` |
||||
|
||||
1. Write your code (see [pico-examples](https://github.com/raspberrypi/pico-examples) or the [Raspberry Pi Pico C/C++ SDK](https://rptl.io/pico-c-sdk) documentation for more information) |
||||
|
||||
About the simplest you can do is a single source file (e.g. hello_world.c) |
||||
|
||||
```c |
||||
#include <stdio.h> |
||||
#include "pico/stdlib.h" |
||||
|
||||
int main() { |
||||
setup_default_uart(); |
||||
printf("Hello, world!\n"); |
||||
return 0; |
||||
} |
||||
``` |
||||
And add the following to your `CMakeLists.txt`: |
||||
|
||||
```cmake |
||||
add_executable(hello_world |
||||
hello_world.c |
||||
) |
||||
|
||||
# Add pico_stdlib library which aggregates commonly used features |
||||
target_link_libraries(hello_world pico_stdlib) |
||||
|
||||
# create map/bin/hex/uf2 file in addition to ELF. |
||||
pico_add_extra_outputs(hello_world) |
||||
``` |
||||
|
||||
Note this example uses the default UART for _stdout_; |
||||
if you want to use the default USB see the [hello-usb](https://github.com/raspberrypi/pico-examples/tree/master/hello_world/usb) example. |
||||
|
||||
|
||||
1. Setup a CMake build directory. |
||||
For example, if not using an IDE: |
||||
``` |
||||
$ mkdir build |
||||
$ cd build |
||||
$ cmake .. |
||||
``` |
||||
|
||||
1. Make your target from the build directory you created. |
||||
```sh |
||||
$ make hello_world |
||||
``` |
||||
|
||||
1. You now have `hello_world.elf` to load via a debugger, or `hello_world.uf2` that can be installed and run on your Raspberry Pi Pico via drag and drop. |
||||
@ -0,0 +1,4 @@ |
||||
# this is included because toolchain file sets SYSTEM_NAME=PICO |
||||
|
||||
set_property(GLOBAL PROPERTY TARGET_SUPPORTS_SHARED_LIBS FALSE) |
||||
set(CMAKE_EXECUTABLE_SUFFIX .elf) |
||||
@ -0,0 +1,29 @@ |
||||
# PICO_CMAKE_CONFIG: PICO_PLATFORM, platform to build for e.g. rp2040/host, default=rp2040 or environment value, group=build |
||||
if (DEFINED ENV{PICO_PLATFORM} AND (NOT PICO_PLATFORM)) |
||||
set(PICO_PLATFORM $ENV{PICO_PLATFORM}) |
||||
message("Using PICO_PLATFORM from environment ('${PICO_PLATFORM}')") |
||||
else() |
||||
if (NOT PICO_PLATFORM) |
||||
set(PICO_PLATFORM "rp2040") |
||||
pico_message("Defaulting PICO_PLATFORM to ${PICO_PLATFORM} since not specified.") |
||||
else() |
||||
message("PICO platform is ${PICO_PLATFORM}.") |
||||
endif() |
||||
endif () |
||||
|
||||
set(PICO_PLATFORM ${PICO_PLATFORM} CACHE STRING "PICO Build platform (e.g. rp2040, host)") |
||||
|
||||
# PICO_CMAKE_CONFIG: PICO_CMAKE_RELOAD_PLATFORM_FILE, custom CMake file to use to set up the platform environment, default=none, group=build |
||||
set(PICO_CMAKE_PRELOAD_PLATFORM_FILE "" CACHE INTERNAL "") |
||||
set(PICO_CMAKE_PRELOAD_PLATFORM_DIR "${CMAKE_CURRENT_LIST_DIR}/preload/platforms" CACHE INTERNAL "") |
||||
|
||||
if (NOT PICO_CMAKE_PRELOAD_PLATFORM_FILE) |
||||
set(PICO_CMAKE_PRELOAD_PLATFORM_FILE ${PICO_CMAKE_PRELOAD_PLATFORM_DIR}/${PICO_PLATFORM}.cmake CACHE INTERNAL "") |
||||
endif () |
||||
|
||||
if (NOT EXISTS "${PICO_CMAKE_PRELOAD_PLATFORM_FILE}") |
||||
message(FATAL_ERROR "${PICO_CMAKE_PRELOAD_PLATFORM_FILE} does not exist. \ |
||||
Either specify a valid PICO_PLATFORM (or PICO_CMAKE_PRELOAD_PLATFORM_FILE).") |
||||
endif () |
||||
|
||||
include(${PICO_CMAKE_PRELOAD_PLATFORM_FILE}) |
||||
@ -0,0 +1,43 @@ |
||||
# PICO_CMAKE_CONFIG: PICO_TOOLCHAIN_PATH, Path to search for compiler, default=none (i.e. search system paths), group=build |
||||
set(PICO_TOOLCHAIN_PATH "${PICO_TOOLCHAIN_PATH}" CACHE INTERNAL "") |
||||
|
||||
# Set a default build type if none was specified |
||||
set(default_build_type "Release") |
||||
|
||||
if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) |
||||
message(STATUS "Defaulting build type to '${default_build_type}' since not specified.") |
||||
set(CMAKE_BUILD_TYPE "${default_build_type}" CACHE STRING "Choose the type of build, options are: 'Debug', 'Release', 'MinSizeRel', 'RelWithDebInfo'." FORCE) |
||||
# Set the possible values of build type for cmake-gui |
||||
set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS |
||||
"Debug" "Release" "MinSizeRel" "RelWithDebInfo") |
||||
endif() |
||||
|
||||
if (CMAKE_BUILD_TYPE STREQUAL "Default") |
||||
error("Default build type is NOT supported") |
||||
endif() |
||||
|
||||
# PICO_CMAKE_CONFIG: PICO_COMPILER, Optionally specifies a different compiler (other than pico_arm_gcc.cmake) - this is not yet fully supported, default=none, group=build |
||||
# If PICO_COMPILER is specified, set toolchain file to ${PICO_COMPILER}.cmake. |
||||
if (DEFINED PICO_COMPILER) |
||||
if (DEFINED CMAKE_TOOLCHAIN_FILE) |
||||
get_filename_component(toolchain "${CMAKE_TOOLCHAIN_FILE}" NAME_WE) |
||||
if (NOT "${PICO_COMPILER}" STREQUAL "${toolchain}") |
||||
message(WARNING "CMAKE_TOOLCHAIN_FILE is already defined to ${toolchain}.cmake, you\ |
||||
need to delete cache and reconfigure if you want to switch compiler.") |
||||
endif () |
||||
else () |
||||
set(toolchain_dir "${CMAKE_CURRENT_LIST_DIR}/preload/toolchains") |
||||
set(toolchain_file "${toolchain_dir}/${PICO_COMPILER}.cmake") |
||||
if (EXISTS "${toolchain_file}") |
||||
set(CMAKE_TOOLCHAIN_FILE "${toolchain_file}" CACHE INTERNAL "") |
||||
else () |
||||
# todo improve message |
||||
message(FATAL_ERROR "Toolchain file \"${PICO_COMPILER}.cmake\" does not exist, please\ |
||||
select one from \"cmake/toolchains\" folder.") |
||||
endif () |
||||
endif () |
||||
message("PICO compiler is ${PICO_COMPILER}") |
||||
endif () |
||||
|
||||
unset(PICO_COMPILER CACHE) |
||||
|
||||
@ -0,0 +1,28 @@ |
||||
function(pico_message param) |
||||
if (${ARGC} EQUAL 1) |
||||
message("${param}") |
||||
return() |
||||
endif () |
||||
|
||||
if (NOT ${ARGC} EQUAL 2) |
||||
message(FATAL_ERROR "Expect at most 2 arguments") |
||||
endif () |
||||
message("${param}" "${ARGV1}") |
||||
endfunction() |
||||
|
||||
macro(assert VAR MSG) |
||||
if (NOT ${VAR}) |
||||
message(FATAL_ERROR "${MSG}") |
||||
endif () |
||||
endmacro() |
||||
|
||||
function(pico_find_in_paths OUT PATHS NAME) |
||||
foreach(PATH IN LISTS ${PATHS}) |
||||
if (EXISTS ${PATH}/${NAME}) |
||||
get_filename_component(FULLNAME ${PATH}/${NAME} ABSOLUTE) |
||||
set(${OUT} ${FULLNAME} PARENT_SCOPE) |
||||
return() |
||||
endif() |
||||
endforeach() |
||||
set(${OUT} "" PARENT_SCOPE) |
||||
endfunction() |
||||
@ -0,0 +1,7 @@ |
||||
if (NOT (DEFINED PICO_COMPILER OR DEFINED CMAKE_TOOLCHAIN_FILE)) |
||||
pico_message("Defaulting PICO platform compiler to pico_arm_gcc since not specified.") |
||||
set(PICO_COMPILER "pico_arm_gcc") |
||||
endif () |
||||
|
||||
|
||||
|
||||
@ -0,0 +1 @@ |
||||
include(${CMAKE_CURRENT_LIST_DIR}/pico/pico.cmake) |
||||
@ -0,0 +1,31 @@ |
||||
# Toolchain file is processed multiple times, however, it cannot access CMake cache on some runs. |
||||
# We store the search path in an environment variable so that we can always access it. |
||||
if (NOT "${PICO_TOOLCHAIN_PATH}" STREQUAL "") |
||||
set(ENV{PICO_TOOLCHAIN_PATH} "${PICO_TOOLCHAIN_PATH}") |
||||
endif () |
||||
|
||||
# Find the compiler executable and store its path in a cache entry ${compiler_path}. |
||||
# If not found, issue a fatal message and stop processing. PICO_TOOLCHAIN_PATH can be provided from |
||||
# commandline as additional search path. |
||||
function(pico_find_compiler compiler_path compiler_exe) |
||||
# Search user provided path first. |
||||
find_program( |
||||
${compiler_path} ${compiler_exe} |
||||
PATHS ENV PICO_TOOLCHAIN_PATH |
||||
PATH_SUFFIXES bin |
||||
NO_DEFAULT_PATH |
||||
) |
||||
|
||||
# If not then search system paths. |
||||
if ("${${compiler_path}}" STREQUAL "${compiler_path}-NOTFOUND") |
||||
if (DEFINED ENV{PICO_TOOLCHAIN_PATH}) |
||||
message(WARNING "PICO_TOOLCHAIN_PATH specified ($ENV{PICO_TOOLCHAIN_PATH}), but ${compiler_exe} not found there") |
||||
endif() |
||||
find_program(${compiler_path} ${compiler_exe}) |
||||
endif () |
||||
if ("${${compiler_path}}" STREQUAL "${compiler_path}-NOTFOUND") |
||||
set(PICO_TOOLCHAIN_PATH "" CACHE PATH "Path to search for compiler.") |
||||
message(FATAL_ERROR "Compiler '${compiler_exe}' not found, you can specify search path with\ |
||||
\"PICO_TOOLCHAIN_PATH\".") |
||||
endif () |
||||
endfunction() |
||||
@ -0,0 +1,53 @@ |
||||
# NOTE: THIS IS A WIP ONLY PICO_ARM_GCC IS CURRENTLY SUPPORTED |
||||
# todo there is probably a more "cmake" way of doing this going thru the standard path with our "PICO" platform |
||||
# i.e. CMake<Lang>Information and whatnot |
||||
include(${CMAKE_CURRENT_LIST_DIR}/find_compiler.cmake) |
||||
|
||||
# include our Platform/pico.cmake |
||||
set(CMAKE_SYSTEM_NAME PICO) |
||||
set(CMAKE_SYSTEM_PROCESSOR cortex-m0plus) |
||||
|
||||
# Find CLANG |
||||
pico_find_compiler(PICO_COMPILER_CC clang) |
||||
pico_find_compiler(PICO_COMPILER_CXX clang) |
||||
#pico_find_compiler(PICO_COMPILER_ASM armasm) |
||||
set(PICO_COMPILER_ASM "${PICO_COMPILER_CC}" CACHE INTERNAL "") |
||||
pico_find_compiler(PICO_OBJCOPY llvm-objcopy) |
||||
pico_find_compiler(PICO_OBJDUMP llvm-objdump) |
||||
|
||||
# Specify the cross compiler. |
||||
set(CMAKE_C_COMPILER ${PICO_COMPILER_CC} CACHE FILEPATH "C compiler") |
||||
set(CMAKE_CXX_COMPILER ${PICO_COMPILER_CXX} CACHE FILEPATH "C++ compiler") |
||||
set(CMAKE_C_OUTPUT_EXTENSION .o) |
||||
|
||||
# todo should we be including CMakeASMInformation anyway - i guess that is host side |
||||
set(CMAKE_ASM_COMPILER ${PICO_COMPILER_ASM} CACHE FILEPATH "ASM compiler") |
||||
set(CMAKE_ASM_COMPILE_OBJECT "<CMAKE_ASM_COMPILER> <DEFINES> <INCLUDES> <FLAGS> -o <OBJECT> -c <SOURCE>") |
||||
set(CMAKE_INCLUDE_FLAG_ASM "-I") |
||||
set(CMAKE_OBJCOPY ${PICO_OBJCOPY} CACHE FILEPATH "") |
||||
set(CMAKE_OBJDUMP ${PICO_OBJDUMP} CACHE FILEPATH "") |
||||
|
||||
# Disable compiler checks. |
||||
set(CMAKE_C_COMPILER_FORCED TRUE) |
||||
set(CMAKE_CXX_COMPILER_FORCED TRUE) |
||||
|
||||
# Add target system root to cmake find path. |
||||
get_filename_component(PICO_COMPILER_DIR "${PICO_COMPILER_CC}" DIRECTORY) |
||||
get_filename_component(CMAKE_FIND_ROOT_PATH "${PICO_COMPILER_DIR}" DIRECTORY) |
||||
|
||||
# Look for includes and libraries only in the target system prefix. |
||||
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) |
||||
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) |
||||
set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY) |
||||
set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) |
||||
|
||||
include_directories(/usr/include/newlib) |
||||
|
||||
# todo move to platform/Generix-xxx |
||||
set(ARM_CLANG_COMMON_FLAGS " --target=arm-none-eabi -mcpu=cortex-m0plus -mthumb") |
||||
set(CMAKE_C_FLAGS_INIT "${ARM_CLANG_COMMON_FLAGS}") |
||||
set(CMAKE_CXX_FLAGS_INIT "${ARM_CLANG_COMMON_FLAGS}") |
||||
set(CMAKE_ASM_FLAGS_INIT "${ARM_CLANG_COMMON_FLAGS}") |
||||
set(CMAKE_C_FLAGS_DEBUG_INIT "${ARM_CLANG_COMMON_FLAGS} -Og") |
||||
set(CMAKE_CXX_FLAGS_DEBUG_INIT "${ARM_CLANG_COMMON_FLAGS} -Og") |
||||
|
||||
@ -0,0 +1,52 @@ |
||||
# NOTE: THIS IS A WIP ONLY PICO_ARM_GCC IS CURRENTLY SUPPORTED |
||||
# todo there is probably a more "cmake" way of doing this going thru the standard path with our "PICO" platform |
||||
# i.e. CMake<Lang>Information and whatnot |
||||
include(${CMAKE_CURRENT_LIST_DIR}/find_compiler.cmake) |
||||
|
||||
# include our Platform/PICO.cmake |
||||
set(CMAKE_SYSTEM_NAME PICO) |
||||
set(CMAKE_SYSTEM_PROCESSOR cortex-m0plus) |
||||
|
||||
# Find ARMClang. |
||||
pico_find_compiler(PICO_COMPILER_CC armclang) |
||||
pico_find_compiler(PICO_COMPILER_CXX armclang) |
||||
pico_find_compiler(PICO_COMPILER_ASM armasm) |
||||
set(PICO_COMPILER_ASM "${PICO_COMPILER_ASM}" CACHE INTERNAL "") |
||||
pico_find_compiler(PICO_OBJCOPY llvm-objcopy) |
||||
pico_find_compiler(PICO_OBJDUMP llvm-objdump) |
||||
|
||||
# Specify the cross compiler. |
||||
set(CMAKE_C_COMPILER ${PICO_COMPILER_CC} CACHE FILEPATH "C compiler") |
||||
set(CMAKE_CXX_COMPILER ${PICO_COMPILER_CXX} CACHE FILEPATH "C++ compiler") |
||||
set(CMAKE_C_OUTPUT_EXTENSION .o) |
||||
|
||||
# todo should we be including CMakeASMInformation anyway - i guess that is host side |
||||
set(CMAKE_ASM_COMPILER ${PICO_COMPILER_ASM} CACHE FILEPATH "ASM compiler") |
||||
set(CMAKE_ASM_COMPILE_OBJECT "<CMAKE_ASM_COMPILER> <DEFINES> <INCLUDES> <FLAGS> -o <OBJECT> -c <SOURCE>") |
||||
set(CMAKE_INCLUDE_FLAG_ASM "-I") |
||||
set(CMAKE_OBJCOPY ${PICO_OBJCOPY} CACHE FILEPATH "") |
||||
set(CMAKE_OBJDUMP ${PICO_OBJDUMP} CACHE FILEPATH "") |
||||
|
||||
# Disable compiler checks. |
||||
set(CMAKE_C_COMPILER_FORCED TRUE) |
||||
set(CMAKE_CXX_COMPILER_FORCED TRUE) |
||||
|
||||
# Add target system root to cmake find path. |
||||
get_filename_component(PICO_COMPILER_DIR "${PICO_COMPILER_CC}" DIRECTORY) |
||||
get_filename_component(CMAKE_FIND_ROOT_PATH "${PICO_COMPILER_DIR}" DIRECTORY) |
||||
|
||||
# Look for includes and libraries only in the target system prefix. |
||||
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) |
||||
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) |
||||
set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY) |
||||
set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) |
||||
|
||||
# todo move to platform/Generix-xxx |
||||
set(ARM_CLANG_COMMON_FLAGS " --cpu=Cortex-M0plus") |
||||
string(APPEND CMAKE_C_FLAGS_INIT "${ARM_CLANG_COMMON_FLAGS}") |
||||
string(APPEND CMAKE_CXX_FLAGS_INIT "${ARM_CLANG_COMMON_FLAGS}") |
||||
string(APPEND CMAKE_ASM_FLAGS_INIT "${ARM_CLANG_COMMON_FLAGS}") |
||||
string(APPEND CMAKE_C_FLAGS_DEBUG_INIT "${ARM_CLANG_COMMON_FLAGS} -Og") |
||||
string(APPEND CMAKE_CXX_FLAGS_DEBUG_INIT "${ARM_CLANG_COMMON_FLAGS} -Og") |
||||
|
||||
|
||||
@ -0,0 +1,67 @@ |
||||
# todo there is probably a more "cmake" way of doing this going thru the standard path with our "PICO" platform |
||||
# i.e. CMake<Lang>Information and whatnot |
||||
include(${CMAKE_CURRENT_LIST_DIR}/find_compiler.cmake) |
||||
|
||||
# include our Platform/PICO.cmake |
||||
set(CMAKE_SYSTEM_NAME PICO) |
||||
set(CMAKE_SYSTEM_PROCESSOR cortex-m0plus) |
||||
|
||||
if (NOT PICO_GCC_TRIPLE) |
||||
if (DEFINED ENV{PICO_GCC_TRIPLE}) |
||||
set(PICO_GCC_TRIPLE $ENV{PICO_GCC_TRIPLE}) |
||||
message("PICO_GCC_TRIPLE set from environment: $ENV{PICO_GCC_TRIPLE}") |
||||
else() |
||||
set(PICO_GCC_TRIPLE arm-none-eabi) |
||||
#pico_message_debug("PICO_GCC_TRIPLE defaulted to arm-none-eabi") |
||||
endif() |
||||
endif() |
||||
|
||||
# Find GCC for ARM. |
||||
pico_find_compiler(PICO_COMPILER_CC ${PICO_GCC_TRIPLE}-gcc) |
||||
pico_find_compiler(PICO_COMPILER_CXX ${PICO_GCC_TRIPLE}-g++) |
||||
set(PICO_COMPILER_ASM "${PICO_COMPILER_CC}" CACHE INTERNAL "") |
||||
pico_find_compiler(PICO_OBJCOPY ${PICO_GCC_TRIPLE}-objcopy) |
||||
pico_find_compiler(PICO_OBJDUMP ${PICO_GCC_TRIPLE}-objdump) |
||||
|
||||
# Specify the cross compiler. |
||||
set(CMAKE_C_COMPILER ${PICO_COMPILER_CC} CACHE FILEPATH "C compiler") |
||||
set(CMAKE_CXX_COMPILER ${PICO_COMPILER_CXX} CACHE FILEPATH "C++ compiler") |
||||
set(CMAKE_C_OUTPUT_EXTENSION .o) |
||||
|
||||
# todo should we be including CMakeASMInformation anyway - i guess that is host side |
||||
set(CMAKE_ASM_COMPILER ${PICO_COMPILER_ASM} CACHE FILEPATH "ASM compiler") |
||||
set(CMAKE_ASM_COMPILE_OBJECT "<CMAKE_ASM_COMPILER> <DEFINES> <INCLUDES> <FLAGS> -o <OBJECT> -c <SOURCE>") |
||||
set(CMAKE_INCLUDE_FLAG_ASM "-I") |
||||
set(CMAKE_OBJCOPY ${PICO_OBJCOPY} CACHE FILEPATH "") |
||||
set(CMAKE_OBJDUMP ${PICO_OBJDUMP} CACHE FILEPATH "") |
||||
|
||||
# Disable compiler checks. |
||||
set(CMAKE_C_COMPILER_FORCED TRUE) |
||||
set(CMAKE_CXX_COMPILER_FORCED TRUE) |
||||
|
||||
# Add target system root to cmake find path. |
||||
get_filename_component(PICO_COMPILER_DIR "${PICO_COMPILER_CC}" DIRECTORY) |
||||
get_filename_component(CMAKE_FIND_ROOT_PATH "${PICO_COMPILER_DIR}" DIRECTORY) |
||||
|
||||
# Look for includes and libraries only in the target system prefix. |
||||
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) |
||||
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) |
||||
set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY) |
||||
set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) |
||||
|
||||
option(PICO_DEOPTIMIZED_DEBUG "Build debug builds with -O0" 0) |
||||
|
||||
# todo move to platform/Generix-xxx |
||||
|
||||
# on ARM -mcpu should not be mixed with -march |
||||
set(ARM_GCC_COMMON_FLAGS " -mcpu=cortex-m0plus -mthumb") |
||||
foreach(LANG IN ITEMS C CXX ASM) |
||||
set(CMAKE_${LANG}_FLAGS_INIT "${ARM_GCC_COMMON_FLAGS}") |
||||
if (PICO_DEOPTIMIZED_DEBUG) |
||||
set(CMAKE_${LANG}_FLAGS_DEBUG_INIT "-O0") |
||||
else() |
||||
set(CMAKE_${LANG}_FLAGS_DEBUG_INIT "-Og") |
||||
endif() |
||||
set(CMAKE_${LANG}_LINK_FLAGS "-Wl,--build-id=none") |
||||
endforeach() |
||||
|
||||
@ -0,0 +1,59 @@ |
||||
find_package(Doxygen QUIET) |
||||
if (PICO_SDK_TOP_LEVEL_PROJECT AND ${DOXYGEN_FOUND}) |
||||
set(PICO_BUILD_DOCS_DEFAULT 1) |
||||
endif() |
||||
option(PICO_BUILD_DOCS "Build HTML Doxygen docs" ${PICO_BUILD_DOCS_DEFAULT}) |
||||
|
||||
if (DEFINED ENV{PICO_EXAMPLES_PATH} AND NOT PICO_EXAMPLES_PATH) |
||||
set(PICO_EXAMPLES_PATH $ENV{PICO_EXAMPLES_PATH}) |
||||
message("Using PICO_EXAMPLES_PATH from environment ('${PICO_EXAMPLES_PATH}')") |
||||
endif() |
||||
|
||||
if(PICO_BUILD_DOCS) |
||||
if(NOT DOXYGEN_FOUND) |
||||
message(FATAL_ERROR "Doxygen is needed to build the documentation.") |
||||
endif() |
||||
|
||||
include(ExternalProject) |
||||
|
||||
if(PICO_EXAMPLES_PATH) |
||||
get_filename_component(PICO_EXAMPLES_PATH "${PICO_EXAMPLES_PATH}" REALPATH BASE_DIR "${CMAKE_BINARY_DIR}") |
||||
if (EXISTS ${PICO_EXAMPLES_PATH}) |
||||
message("Documentation example code will come from ${PICO_EXAMPLES_PATH}") |
||||
else() |
||||
message(WARNING "Documentation example code configured to come from ${PICO_EXAMPLES_PATH}, but that path does not exist") |
||||
endif() |
||||
add_custom_target(doc-pico-examples) |
||||
else() |
||||
ExternalProject_Add(doc-pico-examples |
||||
GIT_REPOSITORY https://github.com/raspberrypi/pico-examples |
||||
GIT_TAG master |
||||
CONFIGURE_COMMAND "" |
||||
BUILD_COMMAND "" |
||||
INSTALL_COMMAND "" |
||||
) |
||||
ExternalProject_Get_property(doc-pico-examples SOURCE_DIR) |
||||
ExternalProject_Get_property(doc-pico-examples GIT_REPOSITORY) |
||||
ExternalProject_Get_property(doc-pico-examples GIT_TAG) |
||||
set(PICO_EXAMPLES_PATH ${SOURCE_DIR}) |
||||
message("Documentation example code will come from git repo ${GIT_REPOSITORY}, branch ${GIT_TAG}") |
||||
endif() |
||||
|
||||
set(DOXY_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/doxygen") |
||||
set(DOXY_INPUT_DIRS "${PICO_DOXYGEN_PATHS}") |
||||
set(DOXY_EXCLUDE_DIRS "${PICO_DOXYGEN_EXCLUDE_PATHS}") |
||||
set(DOXY_EXAMPLE_DIR "${PICO_EXAMPLES_PATH}") |
||||
|
||||
set(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) |
||||
set(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) |
||||
|
||||
configure_file(${doxyfile_in} ${doxyfile} @ONLY) |
||||
|
||||
add_custom_target(docs |
||||
COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile} |
||||
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} |
||||
COMMENT "Generating API documentation with Doxygen" |
||||
VERBATIM) |
||||
|
||||
add_dependencies(docs doc-pico-examples) |
||||
endif() |
||||
@ -0,0 +1,63 @@ |
||||
PROJECT_NAME = "Raspberry Pi Pico SDK" |
||||
PROJECT_BRIEF = "Raspberry Pi Pico SDK documentation" |
||||
PROJECT_NUMBER = @PICO_SDK_VERSION_STRING@ |
||||
|
||||
#STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@ |
||||
STRIP_FROM_PATH = @DOXY_INPUT_DIRS@ |
||||
# @PROJECT_BINARY_DIR@ |
||||
#INPUT = @doxy_main_page@ \ |
||||
# @PROJECT_SOURCE_DIR@ \ |
||||
# @PROJECT_BINARY_DIR@ |
||||
|
||||
FILE_PATTERNS = *.h \ |
||||
*.cpp \ |
||||
*.c \ |
||||
*.S \ |
||||
*.s \ |
||||
*.md |
||||
|
||||
USE_MDFILE_AS_MAINPAGE = @PROJECT_SOURCE_DIR@/docs/mainpage.md |
||||
LAYOUT_FILE = @PROJECT_SOURCE_DIR@/docs/DoxygenLayout.xml |
||||
HTML_FOOTER = @PROJECT_SOURCE_DIR@/docs/footer.html |
||||
HTML_HEADER = @PROJECT_SOURCE_DIR@/docs/header.html |
||||
|
||||
OPTIMIZE_OUTPUT_FOR_C = YES |
||||
# HTML_EXTRA_STYLESHEET = @PROJECT_SOURCE_DIR@/docs/customdoxygen.css |
||||
HTML_EXTRA_STYLESHEET = @PROJECT_SOURCE_DIR@/docs/normalise.css @PROJECT_SOURCE_DIR@/docs/main.css @PROJECT_SOURCE_DIR@/docs/styles.css |
||||
HTML_EXTRA_FILES = @PROJECT_SOURCE_DIR@/docs/logo-mobile.svg @PROJECT_SOURCE_DIR@/docs/logo.svg @PROJECT_SOURCE_DIR@/docs/search.svg \ |
||||
@PROJECT_SOURCE_DIR@/docs/main.js @PROJECT_SOURCE_DIR@/docs/pico.jpg @PROJECT_SOURCE_DIR@/docs/rp2040.png |
||||
GENERATE_TREEVIEW = YES # This is needed as it wraps the content area in an HTML tag that we need to use |
||||
HTML_COLORSTYLE_HUE = 350 |
||||
HTML_COLORSTYLE_SAT = 200 |
||||
HTML_COLORSTYLE_GAMMA = 150 |
||||
GENERATE_LATEX = NO |
||||
GENERATE_XML = YES |
||||
GROUP_GRAPHS = NO |
||||
|
||||
ALIASES += tag=@internal |
||||
ALIASES += end=@internal |
||||
|
||||
OUTPUT_DIRECTORY = @DOXY_OUTPUT_DIR@ |
||||
INPUT = @PROJECT_SOURCE_DIR@/docs/index.h @DOXY_INPUT_DIRS@ @PROJECT_SOURCE_DIR@/docs/ |
||||
|
||||
#EXCLUDE = @DOXY_EXCLUDE_DIRS@ @PROJECT_SOURCE_DIR@/src/rp2040 |
||||
EXCLUDE = @DOXY_EXCLUDE_DIRS@ |
||||
RECURSIVE = YES |
||||
EXAMPLE_PATH = @PICO_EXAMPLES_PATH@ |
||||
|
||||
# This is needed as we have a number of static inline functions that need to be documented. |
||||
EXTRACT_STATIC = YES |
||||
|
||||
EXTRACT_ALL = NO |
||||
ALWAYS_DETAILED_SEC = NO |
||||
#REPEAT_BRIEF = NO |
||||
|
||||
# Need these next options to ensure that functions with modifiers do not confuse the Doxygen parser. |
||||
# And any further function modifiers here. |
||||
MACRO_EXPANSION = YES |
||||
|
||||
PREDEFINED = __not_in_flash_func(x) \ |
||||
__time_critical_func(x) \ |
||||
__not_in_flash(x)= \ |
||||
__no_inline_not_in_flash(x)= \ |
||||
__attribute__(x)= |
||||
@ -0,0 +1,246 @@ |
||||
<doxygenlayout version="1.0"> |
||||
<!-- Generated by doxygen 1.8.17 --> |
||||
<!-- Navigation index tabs for HTML output --> |
||||
<navindex> |
||||
<tab type="mainpage" visible="yes" title="Introduction"></tab> |
||||
<tab type="modules" visible="yes" title="API Documentation" intro="These are the libraries supplied in the Raspberry Pi Pico SDK"/> |
||||
<tab type="user" url="@ref examples_page" visible="yes" title="Examples" intro="Links to SDK examples"/> |
||||
<tab type="usergroup" url="@ref weblinks_page" visible="yes" title="Additional Documentation" intro="Links to datasheets and documentation"> |
||||
<tab type="user" url="https://rptl.io/pico-datasheet" visible="yes" title="Raspberry Pi Pico Datasheet" intro=""/> |
||||
<tab type="user" url="https://rptl.io/rp2040-datasheet" visible="yes" title="RP2040 Datasheet" intro=""/> |
||||
<tab type="user" url="https://rptl.io/rp2040-design" visible="yes" title="Hardware design with RP2040" intro=""/> |
||||
<tab type="user" url="https://rptl.io/pico-c-sdk" visible="yes" title="Raspberry Pi Pico C/C++ SDK" intro=""/> |
||||
<tab type="user" url="https://rptl.io/pico-micropython" visible="yes" title="Raspberry Pi Pico Python SDK" intro=""/> |
||||
<tab type="user" url="https://rptl.io/pico-get-started" visible="yes" title="Getting started with Raspberry Pi Pico" intro=""/> |
||||
<tab type="user" url="https://rptl.io/pico-faq" visible="yes" title="Raspberry Pi Pico FAQ" intro=""/> |
||||
</tab> |
||||
<tab type="usergroup" url="@ref weblinks_page" visible="yes" title="Web" intro="useful weblinks"> |
||||
<tab type="user" url="https://www.raspberrypi.com/" visible="yes" title="Raspberry Pi Site" intro=""/> |
||||
<tab type="user" url="https://rptl.io/rp2040-get-started" visible="yes" title="Raspberry Pi Pico Page" intro=""/> |
||||
<tab type="user" url="https://forums.raspberrypi.com/" visible="yes" title="Raspberry Pi Forums" intro=""/> |
||||
<tab type="user" url="https://github.com/raspberrypi/pico-sdk" visible="yes" title="Raspberry Pi Pico SDK on GitHub" intro=""/> |
||||
<tab type="user" url="https://github.com/raspberrypi/pico-examples" visible="yes" title="Pico Examples on GitHub" intro=""/> |
||||
<tab type="user" url="https://github.com/raspberrypi/pico-extras" visible="yes" title="Pico Extras on GitHub" intro=""/> |
||||
<tab type="user" url="https://github.com/raspberrypi/pico-playground" visible="yes" title="Pico Playground on GitHub" intro=""/> |
||||
<tab type="user" url="https://github.com/raspberrypi/pico-bootrom" visible="yes" title="Pico Bootrom on GitHub" intro=""/> |
||||
</tab> |
||||
<tab type="pages" visible="no" title="" intro=""/> |
||||
<tab type="namespaces" visible="yes" title=""> |
||||
<tab type="namespacelist" visible="yes" title="" intro=""/> |
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/> |
||||
</tab> |
||||
<tab type="interfaces" visible="yes" title=""> |
||||
<tab type="interfacelist" visible="yes" title="" intro=""/> |
||||
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/> |
||||
<tab type="interfacehierarchy" visible="yes" title="" intro=""/> |
||||
</tab> |
||||
<tab type="classes" visible="no" title=""> |
||||
<tab type="classlist" visible="yes" title="" intro=""/> |
||||
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> |
||||
<tab type="hierarchy" visible="yes" title="" intro=""/> |
||||
<tab type="classmembers" visible="yes" title="" intro=""/> |
||||
</tab> |
||||
<tab type="structs" visible="yes" title=""> |
||||
<tab type="structlist" visible="yes" title="" intro=""/> |
||||
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/> |
||||
</tab> |
||||
<tab type="exceptions" visible="yes" title=""> |
||||
<tab type="exceptionlist" visible="yes" title="" intro=""/> |
||||
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/> |
||||
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/> |
||||
</tab> |
||||
<tab type="files" visible="no" title=""> |
||||
<tab type="filelist" visible="yes" title="" intro=""/> |
||||
<tab type="globals" visible="yes" title="" intro=""/> |
||||
</tab> |
||||
<tab type="examples" visible="yes" title="" intro=""/> |
||||
</navindex> |
||||
|
||||
<!-- Layout definition for a class page --> |
||||
<class> |
||||
<briefdescription visible="yes"/> |
||||
<includes visible="$SHOW_INCLUDE_FILES"/> |
||||
<inheritancegraph visible="$CLASS_GRAPH"/> |
||||
<collaborationgraph visible="$COLLABORATION_GRAPH"/> |
||||
<memberdecl> |
||||
<nestedclasses visible="yes" title=""/> |
||||
<publictypes title=""/> |
||||
<services title=""/> |
||||
<interfaces title=""/> |
||||
<publicslots title=""/> |
||||
<signals title=""/> |
||||
<publicmethods title=""/> |
||||
<publicstaticmethods title=""/> |
||||
<publicattributes title=""/> |
||||
<publicstaticattributes title=""/> |
||||
<protectedtypes title=""/> |
||||
<protectedslots title=""/> |
||||
<protectedmethods title=""/> |
||||
<protectedstaticmethods title=""/> |
||||
<protectedattributes title=""/> |
||||
<protectedstaticattributes title=""/> |
||||
<packagetypes title=""/> |
||||
<packagemethods title=""/> |
||||
<packagestaticmethods title=""/> |
||||
<packageattributes title=""/> |
||||
<packagestaticattributes title=""/> |
||||
<properties title=""/> |
||||
<events title=""/> |
||||
<privatetypes title=""/> |
||||
<privateslots title=""/> |
||||
<privatemethods title=""/> |
||||
<privatestaticmethods title=""/> |
||||
<privateattributes title=""/> |
||||
<privatestaticattributes title=""/> |
||||
<friends title=""/> |
||||
<related title="" subtitle=""/> |
||||
<membergroups visible="yes"/> |
||||
</memberdecl> |
||||
<detaileddescription title=""/> |
||||
<memberdef> |
||||
<inlineclasses title=""/> |
||||
<typedefs title=""/> |
||||
<enums title=""/> |
||||
<services title=""/> |
||||
<interfaces title=""/> |
||||
<constructors title=""/> |
||||
<functions title=""/> |
||||
<related title=""/> |
||||
<variables title=""/> |
||||
<properties title=""/> |
||||
<events title=""/> |
||||
</memberdef> |
||||
<allmemberslink visible="yes"/> |
||||
<usedfiles visible="$SHOW_USED_FILES"/> |
||||
<authorsection visible="yes"/> |
||||
</class> |
||||
|
||||
<!-- Layout definition for a namespace page --> |
||||
<namespace> |
||||
<briefdescription visible="yes"/> |
||||
<memberdecl> |
||||
<nestednamespaces visible="yes" title=""/> |
||||
<constantgroups visible="yes" title=""/> |
||||
<interfaces visible="yes" title=""/> |
||||
<classes visible="yes" title=""/> |
||||
<structs visible="yes" title=""/> |
||||
<exceptions visible="yes" title=""/> |
||||
<typedefs title=""/> |
||||
<sequences title=""/> |
||||
<dictionaries title=""/> |
||||
<enums title=""/> |
||||
<functions title=""/> |
||||
<variables title=""/> |
||||
<membergroups visible="yes"/> |
||||
</memberdecl> |
||||
<detaileddescription title=""/> |
||||
<memberdef> |
||||
<inlineclasses title=""/> |
||||
<typedefs title=""/> |
||||
<sequences title=""/> |
||||
<dictionaries title=""/> |
||||
<enums title=""/> |
||||
<functions title=""/> |
||||
<variables title=""/> |
||||
</memberdef> |
||||
<authorsection visible="yes"/> |
||||
</namespace> |
||||
|
||||
<!-- Layout definition for a file page --> |
||||
<file> |
||||
<briefdescription visible="yes"/> |
||||
<includes visible="$SHOW_INCLUDE_FILES"/> |
||||
<includegraph visible="$INCLUDE_GRAPH"/> |
||||
<includedbygraph visible="$INCLUDED_BY_GRAPH"/> |
||||
<sourcelink visible="yes"/> |
||||
<memberdecl> |
||||
<interfaces visible="yes" title=""/> |
||||
<classes visible="yes" title=""/> |
||||
<structs visible="yes" title=""/> |
||||
<exceptions visible="yes" title=""/> |
||||
<namespaces visible="yes" title=""/> |
||||
<constantgroups visible="yes" title=""/> |
||||
<defines title=""/> |
||||
<typedefs title=""/> |
||||
<sequences title=""/> |
||||
<dictionaries title=""/> |
||||
<enums title=""/> |
||||
<functions title=""/> |
||||
<variables title=""/> |
||||
<membergroups visible="yes"/> |
||||
</memberdecl> |
||||
<detaileddescription title=""/> |
||||
<memberdef> |
||||
<inlineclasses title=""/> |
||||
<defines title=""/> |
||||
<typedefs title=""/> |
||||
<sequences title=""/> |
||||
<dictionaries title=""/> |
||||
<enums title=""/> |
||||
<functions title=""/> |
||||
<variables title=""/> |
||||
</memberdef> |
||||
<authorsection/> |
||||
</file> |
||||
|
||||
<!-- Layout definition for a group page --> |
||||
<group> |
||||
<briefdescription visible="yes"/> |
||||
<groupgraph visible="$GROUP_GRAPHS"/> |
||||
<memberdecl> |
||||
<nestedgroups visible="yes" title=""/> |
||||
<dirs visible="yes" title=""/> |
||||
<files visible="yes" title=""/> |
||||
<namespaces visible="yes" title=""/> |
||||
<classes visible="yes" title=""/> |
||||
<defines title=""/> |
||||
<typedefs title=""/> |
||||
<sequences title=""/> |
||||
<dictionaries title=""/> |
||||
<enums title=""/> |
||||
<enumvalues title=""/> |
||||
<functions title=""/> |
||||
<variables title=""/> |
||||
<signals title=""/> |
||||
<publicslots title=""/> |
||||
<protectedslots title=""/> |
||||
<privateslots title=""/> |
||||
<events title=""/> |
||||
<properties title=""/> |
||||
<friends title=""/> |
||||
<membergroups visible="yes"/> |
||||
</memberdecl> |
||||
<detaileddescription title=""/> |
||||
<memberdef> |
||||
<pagedocs/> |
||||
<inlineclasses title=""/> |
||||
<defines title=""/> |
||||
<typedefs title=""/> |
||||
<sequences title=""/> |
||||
<dictionaries title=""/> |
||||
<enums title=""/> |
||||
<enumvalues title=""/> |
||||
<functions title=""/> |
||||
<variables title=""/> |
||||
<signals title=""/> |
||||
<publicslots title=""/> |
||||
<protectedslots title=""/> |
||||
<privateslots title=""/> |
||||
<events title=""/> |
||||
<properties title=""/> |
||||
<friends title=""/> |
||||
</memberdef> |
||||
<authorsection visible="yes"/> |
||||
</group> |
||||
|
||||
<!-- Layout definition for a directory page --> |
||||
<directory> |
||||
<briefdescription visible="yes"/> |
||||
<directorygraph visible="yes"/> |
||||
<memberdecl> |
||||
<dirs visible="yes"/> |
||||
<files visible="yes"/> |
||||
</memberdecl> |
||||
<detaileddescription title=""/> |
||||
</directory> |
||||
</doxygenlayout> |
||||
@ -0,0 +1,21 @@ |
||||
## Examples Index {#examples_page} |
||||
|
||||
This page links to the various example code fragments in this documentation. For more complete examples, please see the [pico-examples](https://github.com/raspberrypi/pico-examples) repository, which contains complete buildable projects. |
||||
|
||||
- [RTC example](@ref rtc_example) |
||||
- [UART example](@ref uart_example) |
||||
- [ADC example](@ref adc_example) |
||||
- [I2C example](@ref i2c_example) |
||||
- [Clock example](@ref clock_example) |
||||
- [Timer example](@ref timer_example) |
||||
- [Flash programming example](@ref flash_example) |
||||
- [Watchdog example](@ref watchdog_example) |
||||
- [Divider example](@ref divider_example) |
||||
- [PWM example](@ref pwm_example) |
||||
- [Multicore example](@ref multicore_example) |
||||
- [Reset example](@ref reset_example) |
||||
|
||||
|
||||
All examples are "Copyright (c) 2020 Raspberry Pi (Trading) Ltd", and are released under a 3-Clause BSD licence. Briefly, this means you are free to use the example code |
||||
as long as you retain the copyright notice. Full details on the licence can be found [here](https://opensource.org/licenses/BSD-3-Clause). |
||||
|
||||
@ -0,0 +1,5 @@ |
||||
|
||||
<script src="main.js"></script> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -0,0 +1,64 @@ |
||||
<!-- HTML header for doxygen 1.8.20--> |
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
||||
<html xmlns="http://www.w3.org/1999/xhtml"> |
||||
<head> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/> |
||||
<meta name="generator" content="Doxygen $doxygenversion"/> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/> |
||||
|
||||
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME--> |
||||
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME--> |
||||
|
||||
<!-- <link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/> --> |
||||
<script type="text/javascript" src="$relpath^jquery.js"></script> |
||||
<script type="text/javascript" src="$relpath^dynsections.js"></script> |
||||
$treeview |
||||
$search |
||||
$mathjax |
||||
|
||||
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet"> |
||||
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" /> |
||||
$extrastylesheet |
||||
|
||||
</head> |
||||
|
||||
<body> |
||||
|
||||
|
||||
<div class="navigation-mobile"> |
||||
<div class="logo--mobile"> |
||||
<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a> |
||||
</div> |
||||
<div class="navigation-toggle"> |
||||
<span class="line-1"></span> |
||||
<span class="line-2"> |
||||
<p>Menu Toggle</p> |
||||
</span> |
||||
<span class="line-3"></span> |
||||
</div> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
||||
|
||||
<div class="logo"> |
||||
<a href="$relpath^index.html"> <img src="logo.svg" alt="Raspberry Pi"></a> |
||||
<span style="display: inline-block; margin-top: 10px;"> |
||||
v$projectnumber |
||||
</span> |
||||
</div> |
||||
|
||||
|
||||
<div class="navigation-footer"> |
||||
<img src="logo-mobile.svg" alt="Raspberry Pi"> |
||||
<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi (Trading) Ltd</a> |
||||
</div> |
||||
<!-- <div class="search"> |
||||
<form> |
||||
<input type="search" name="search" id="search" placeholder="Search"> |
||||
<input type="submit" value="Search"> |
||||
</form> |
||||
</div> --> |
||||
@ -0,0 +1,90 @@ |
||||
/*
|
||||
* Copyright (c) 2020 Raspberry Pi (Trading) Ltd. |
||||
* |
||||
* SPDX-License-Identifier: BSD-3-Clause |
||||
*/ |
||||
|
||||
// Here to organize documentation order
|
||||
|
||||
/**
|
||||
* \defgroup hardware Hardware APIs |
||||
* This group of libraries provides a thin and efficient C API / abstractions to access the RP2040 hardware without having to read and write |
||||
* hardware registers directly. |
||||
* @{ |
||||
* \defgroup hardware_adc hardware_adc |
||||
* \defgroup hardware_base hardware_base |
||||
* \defgroup hardware_claim hardware_claim |
||||
* \defgroup hardware_clocks hardware_clocks |
||||
* \defgroup hardware_divider hardware_divider |
||||
* \defgroup hardware_dma hardware_dma |
||||
* \defgroup hardware_exception hardware_exception |
||||
* \defgroup hardware_flash hardware_flash |
||||
* \defgroup hardware_gpio hardware_gpio |
||||
* \defgroup hardware_i2c hardware_i2c |
||||
* \defgroup hardware_interp hardware_interp |
||||
* \defgroup hardware_irq hardware_irq |
||||
* \defgroup hardware_pio hardware_pio |
||||
* \defgroup hardware_pll hardware_pll |
||||
* \defgroup hardware_pwm hardware_pwm |
||||
* \defgroup hardware_resets hardware_resets |
||||
* \defgroup hardware_rtc hardware_rtc |
||||
* \defgroup hardware_spi hardware_spi |
||||
* \defgroup hardware_sync hardware_sync |
||||
* \defgroup hardware_timer hardware_timer |
||||
* \defgroup hardware_uart hardware_uart |
||||
* \defgroup hardware_vreg hardware_vreg |
||||
* \defgroup hardware_watchdog hardware_watchdog |
||||
* \defgroup hardware_xosc hardware_xosc |
||||
* @} |
||||
* |
||||
* \defgroup high_level High Level APIs |
||||
* This group of libraries provide higher level functionality that isn't hardware related or provides a richer |
||||
* set of functionality above the basic hardware interfaces |
||||
* @{ |
||||
* \defgroup pico_multicore pico_multicore |
||||
* \defgroup pico_stdlib pico_stdlib |
||||
* \defgroup pico_sync pico_sync |
||||
* \defgroup pico_time pico_time |
||||
* \defgroup pico_unique_id pico_unique_id |
||||
* \defgroup pico_util pico_util |
||||
* @} |
||||
* |
||||
* \defgroup third_party Third-party Libraries |
||||
* Third party libraries for implementing high level functionality. |
||||
* @{ |
||||
* \defgroup tinyusb_device tinyusb_device |
||||
* \defgroup tinyusb_host tinyusb_host |
||||
* @} |
||||
* |
||||
* \defgroup runtime Runtime Infrastructure |
||||
* Libraries that are used to provide efficient implementation of certain |
||||
* language level and C library functions, as well as CMake INTERFACE libraries |
||||
* abstracting the compilation and link steps in the SDK |
||||
* @{ |
||||
* \defgroup boot_stage2 boot_stage2 |
||||
* \defgroup pico_base pico_base |
||||
* \defgroup pico_binary_info pico_binary_info |
||||
* \defgroup pico_bit_ops pico_bit_ops |
||||
* \defgroup pico_bootrom pico_bootrom |
||||
* \defgroup pico_bootsel_via_double_reset pico_bootsel_via_double_reset |
||||
* \defgroup pico_cxx_options pico_cxx_options |
||||
* \defgroup pico_divider pico_divider |
||||
* \defgroup pico_double pico_double |
||||
* \defgroup pico_float pico_float |
||||
* \defgroup pico_int64_ops pico_int64_ops |
||||
* \defgroup pico_malloc pico_malloc |
||||
* \defgroup pico_mem_ops pico_mem_ops |
||||
* \defgroup pico_platform pico_platform |
||||
* \defgroup pico_printf pico_printf |
||||
* \defgroup pico_runtime pico_runtime |
||||
* \defgroup pico_stdio pico_stdio |
||||
* \defgroup pico_standard_link pico_standard_link |
||||
* @} |
||||
* |
||||
* \defgroup misc External API Headers |
||||
* Headers for interfaces that are shared with code outside of the SDK |
||||
* @{ |
||||
* \defgroup boot_picoboot boot_picoboot |
||||
* \defgroup boot_uf2 boot_uf2 |
||||
* @} |
||||
*/ |
||||
|
After Width: | Height: | Size: 8.7 KiB |
|
After Width: | Height: | Size: 19 KiB |
@ -0,0 +1,105 @@ |
||||
/************************/ |
||||
/* GENERAL */ |
||||
/************************/ |
||||
|
||||
body { |
||||
color: #1e1e1e; |
||||
} |
||||
|
||||
h1, h2, h3, h4, h5, h6, p, a, li, span, blockquote, input, textarea, select, label { |
||||
font-family: 'Roboto', sans-serif; |
||||
} |
||||
|
||||
p { |
||||
/* font-size: 16px; |
||||
line-height: 25px; |
||||
margin-bottom: 20px;*/ |
||||
} |
||||
|
||||
a { |
||||
text-decoration: none; |
||||
color: inherit; |
||||
} |
||||
|
||||
|
||||
/* Sidebar */ |
||||
#top { |
||||
background-color: #F5F5F5; |
||||
width: 275px; |
||||
position: fixed; |
||||
top: 0; |
||||
bottom: 0; |
||||
left: 0; |
||||
height: auto !important; |
||||
overflow: auto; |
||||
padding: 25px; |
||||
box-sizing: border-box; |
||||
display: flex; |
||||
flex-direction: column; |
||||
} |
||||
@media (max-width: 1012px) { |
||||
#top { |
||||
box-shadow: 5px 0px 10px 0px rgba(0,0,0,0.25); |
||||
position: fixed; |
||||
z-index: 9999; |
||||
left: -100%; |
||||
width: 450px; |
||||
background-color: #F5F5F5; |
||||
transition: 0.2s left; |
||||
} |
||||
} |
||||
@media (max-width: 767px) { |
||||
#top { |
||||
width: calc(100% - 50px); |
||||
padding: 20px; |
||||
} |
||||
} |
||||
@media (max-width: 1012px) { |
||||
#top.open { |
||||
left: 0; |
||||
} |
||||
} |
||||
|
||||
|
||||
/* Content */ |
||||
#doc-content { |
||||
padding: 25px 50px 25px 290px; |
||||
margin: 0 !important; |
||||
height: auto !important; |
||||
} |
||||
@media (max-width: 1012px) { |
||||
#doc-content { |
||||
padding: 110px 40px 40px 40px; |
||||
} |
||||
} |
||||
@media (max-width: 767px) { |
||||
#doc-content { |
||||
padding: 90px 20px 50px 20px; |
||||
} |
||||
} |
||||
|
||||
|
||||
/* Hide the default doxygen stuff that we dont want */ |
||||
.ui-resizable-handle { |
||||
display: none !important; |
||||
} |
||||
#nav-sync { |
||||
display: none !important; |
||||
} |
||||
#nav-tree { |
||||
height: 100% !important; |
||||
background: none; |
||||
overflow: auto; |
||||
padding: 35px; |
||||
box-sizing: border-box; |
||||
} |
||||
#nav-path, #side-nav { |
||||
display: none !important; |
||||
} |
||||
|
||||
div.line, |
||||
div.line a, |
||||
div.line span { |
||||
font-family: monospace; |
||||
} |
||||
|
||||
@ -0,0 +1,17 @@ |
||||
$(document).ready(function() { |
||||
|
||||
// Trigger the mobile navigation
|
||||
$(document).on('click', '.navigation-toggle', function (event) { |
||||
event.preventDefault(); |
||||
$(this).toggleClass('clicked'); |
||||
$('#top').toggleClass('open'); |
||||
}); |
||||
|
||||
// Add a class to all <li>'s with children
|
||||
$('#main-nav ul li > ul').parent().addClass('hasChildren'); |
||||
$('#main-nav .has-submenu').removeClass('has-submenu'); |
||||
$('#main-nav .sm').removeClass('sm'); |
||||
$('#main-nav .sm-dox').removeClass('sm-dox'); |
||||
$('#main-nav #main-menu').removeAttr('data-smartmenus-id'); |
||||
$('#main-nav #main-menu').removeAttr('id'); |
||||
}); |
||||
@ -0,0 +1,30 @@ |
||||
# Raspberry Pi Pico SDK |
||||
|
||||
The Raspberry Pi Pico SDK (Software Development Kit), henceforth SDK, provides the headers, libraries and build system necessary to write programs for the RP2040 based devices such as the Raspberry Pi Pico in C, C++ or assembly language. The SDK is designed to provide an API and programming environment that is familiar both to non-embedded C developers and embedded C developers alike. |
||||
|
||||
A single program runs on the device at a time with a conventional main() method. Standard C/C++ libraries are supported along with APIs for accessing the RP2040’s hardware, including DMA, IRQs, and the wide variety fixed function peripherals and PIO (Programmable IO). |
||||
|
||||
Additionally the SDK provides higher level libraries for dealing with timers, USB, synchronization and multi-core programming, along with additional high level functionality built using PIO such as audio. The SDK can be used to build anything from simple applications, full fledged runtime environments such as MicroPython, to low level software such as the RP2040’s on chip bootrom itself. |
||||
|
||||
This documentation is generated from the SDK source tree using Doxygen. It provides basic information on the APIs used for each library, but does not provide usage information. Please refer to the Databooks for usage and more technical information. |
||||
|
||||
## SDK Design |
||||
|
||||
The RP2040 is a powerful chip, however it is an embedded environment, so both RAM, and program space are at premium. Additionally the trade offs between performance and other factors (e.g. edge case error handling, runtime vs compile time configuration) are necessarily much more visible to the developer than they might be on other higher level platforms. |
||||
|
||||
The intention within the SDK has been for features to just work out of the box, with sensible defaults, but also to give the developer as much control and power as possible (if they want it) to fine tune every aspect of the application they are building and the libraries used. |
||||
|
||||
## The Build System |
||||
|
||||
The SDK uses CMake to manage the build. CMake is widely supported by IDEs (Integrated Development Environments), and allows a simple specification of the build (via CMakeLists.txt files), from which CMake can generate a build system (for use by `make`, `ninja` or other build tools) customized for the platform and by any configuration variables the developer chooses for a list of configuration variables). |
||||
|
||||
Apart from being a widely used build system for C/C++ development, CMake is fundamental to the way the SDK is structured, and how applications are configured and built. |
||||
|
||||
The SDK builds an executable which is bare metal, i.e. it includes the entirety of the code needed to run on the device (other than floating point and other optimized code contained in the bootrom within the RP2040). |
||||
|
||||
## Examples |
||||
|
||||
|
||||
This SDK documentation contains a number of example code fragments. An index of these examples can be found [here](@ref examples_page). These examples, and any other source code included in this documentation, is Copyright © 2020 Raspberry Pi (Trading) Ltd. and licensed under the [3-Clause BSD](https://opensource.org/licenses/BSD-3-Clause) license. |
||||
|
||||
|
||||
@ -0,0 +1,447 @@ |
||||
/*! normalize.css v7.0.0 | MIT License | github.com/necolas/normalize.css */ |
||||
|
||||
/* Document |
||||
========================================================================== */ |
||||
|
||||
/** |
||||
* 1. Correct the line height in all browsers. |
||||
* 2. Prevent adjustments of font size after orientation changes in |
||||
* IE on Windows Phone and in iOS. |
||||
*/ |
||||
|
||||
html { |
||||
line-height: 1.15; /* 1 */ |
||||
-ms-text-size-adjust: 100%; /* 2 */ |
||||
-webkit-text-size-adjust: 100%; /* 2 */ |
||||
} |
||||
|
||||
/* Sections |
||||
========================================================================== */ |
||||
|
||||
/** |
||||
* Remove the margin in all browsers (opinionated). |
||||
*/ |
||||
|
||||
body { |
||||
margin: 0; |
||||
} |
||||
|
||||
/** |
||||
* Add the correct display in IE 9-. |
||||
*/ |
||||
|
||||
article, |
||||
aside, |
||||
footer, |
||||
header, |
||||
nav, |
||||
section { |
||||
display: block; |
||||
} |
||||
|
||||
/** |
||||
* Correct the font size and margin on `h1` elements within `section` and |
||||
* `article` contexts in Chrome, Firefox, and Safari. |
||||
*/ |
||||
|
||||
h1 { |
||||
font-size: 145%; |
||||
margin: 0.67em 0; |
||||
} |
||||
|
||||
/* Grouping content |
||||
========================================================================== */ |
||||
|
||||
/** |
||||
* Add the correct display in IE 9-. |
||||
* 1. Add the correct display in IE. |
||||
*/ |
||||
|
||||
figcaption, |
||||
figure, |
||||
main { /* 1 */ |
||||
display: block; |
||||
} |
||||
|
||||
/** |
||||
* Add the correct margin in IE 8. |
||||
*/ |
||||
|
||||
figure { |
||||
margin: 1em 40px; |
||||
} |
||||
|
||||
/** |
||||
* 1. Add the correct box sizing in Firefox. |
||||
* 2. Show the overflow in Edge and IE. |
||||
*/ |
||||
|
||||
hr { |
||||
box-sizing: content-box; /* 1 */ |
||||
height: 0; /* 1 */ |
||||
overflow: visible; /* 2 */ |
||||
} |
||||
|
||||
/** |
||||
* 1. Correct the inheritance and scaling of font size in all browsers. |
||||
* 2. Correct the odd `em` font sizing in all browsers. |
||||
*/ |
||||
|
||||
pre { |
||||
font-family: monospace, monospace; /* 1 */ |
||||
font-size: 1em; /* 2 */ |
||||
} |
||||
|
||||
/* Text-level semantics |
||||
========================================================================== */ |
||||
|
||||
/** |
||||
* 1. Remove the gray background on active links in IE 10. |
||||
* 2. Remove gaps in links underline in iOS 8+ and Safari 8+. |
||||
*/ |
||||
|
||||
a { |
||||
background-color: transparent; /* 1 */ |
||||
-webkit-text-decoration-skip: objects; /* 2 */ |
||||
} |
||||
|
||||
/** |
||||
* 1. Remove the bottom border in Chrome 57- and Firefox 39-. |
||||
* 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari. |
||||
*/ |
||||
|
||||
abbr[title] { |
||||
border-bottom: none; /* 1 */ |
||||
text-decoration: underline; /* 2 */ |
||||
text-decoration: underline dotted; /* 2 */ |
||||
} |
||||
|
||||
/** |
||||
* Prevent the duplicate application of `bolder` by the next rule in Safari 6. |
||||
*/ |
||||
|
||||
b, |
||||
strong { |
||||
font-weight: inherit; |
||||
} |
||||
|
||||
/** |
||||
* Add the correct font weight in Chrome, Edge, and Safari. |
||||
*/ |
||||
|
||||
b, |
||||
strong { |
||||
font-weight: bolder; |
||||
} |
||||
|
||||
/** |
||||
* 1. Correct the inheritance and scaling of font size in all browsers. |
||||
* 2. Correct the odd `em` font sizing in all browsers. |
||||
*/ |
||||
|
||||
code, |
||||
kbd, |
||||
samp { |
||||
font-family: monospace, monospace; /* 1 */ |
||||
font-size: 1em; /* 2 */ |
||||
} |
||||
|
||||
/** |
||||
* Add the correct font style in Android 4.3-. |
||||
*/ |
||||
|
||||
dfn { |
||||
font-style: italic; |
||||
} |
||||
|
||||
/** |
||||
* Add the correct background and color in IE 9-. |
||||
*/ |
||||
|
||||
mark { |
||||
background-color: #ff0; |
||||
color: #000; |
||||
} |
||||
|
||||
/** |
||||
* Add the correct font size in all browsers. |
||||
*/ |
||||
|
||||
small { |
||||
font-size: 80%; |
||||
} |
||||
|
||||
/** |
||||
* Prevent `sub` and `sup` elements from affecting the line height in |
||||
* all browsers. |
||||
*/ |
||||
|
||||
sub, |
||||
sup { |
||||
font-size: 75%; |
||||
line-height: 0; |
||||
position: relative; |
||||
vertical-align: baseline; |
||||
} |
||||
|
||||
sub { |
||||
bottom: -0.25em; |
||||
} |
||||
|
||||
sup { |
||||
top: -0.5em; |
||||
} |
||||
|
||||
/* Embedded content |
||||
========================================================================== */ |
||||
|
||||
/** |
||||
* Add the correct display in IE 9-. |
||||
*/ |
||||
|
||||
audio, |
||||
video { |
||||
display: inline-block; |
||||
} |
||||
|
||||
/** |
||||
* Add the correct display in iOS 4-7. |
||||
*/ |
||||
|
||||
audio:not([controls]) { |
||||
display: none; |
||||
height: 0; |
||||
} |
||||
|
||||
/** |
||||
* Remove the border on images inside links in IE 10-. |
||||
*/ |
||||
|
||||
img { |
||||
border-style: none; |
||||
} |
||||
|
||||
/** |
||||
* Hide the overflow in IE. |
||||
*/ |
||||
|
||||
svg:not(:root) { |
||||
overflow: hidden; |
||||
} |
||||
|
||||
/* Forms |
||||
========================================================================== */ |
||||
|
||||
/** |
||||
* 1. Change the font styles in all browsers (opinionated). |
||||
* 2. Remove the margin in Firefox and Safari. |
||||
*/ |
||||
|
||||
button, |
||||
input, |
||||
optgroup, |
||||
select, |
||||
textarea { |
||||
font-family: sans-serif; /* 1 */ |
||||
font-size: 100%; /* 1 */ |
||||
line-height: 1.15; /* 1 */ |
||||
margin: 0; /* 2 */ |
||||
} |
||||
|
||||
/** |
||||
* Show the overflow in IE. |
||||
* 1. Show the overflow in Edge. |
||||
*/ |
||||
|
||||
button, |
||||
input { /* 1 */ |
||||
overflow: visible; |
||||
} |
||||
|
||||
/** |
||||
* Remove the inheritance of text transform in Edge, Firefox, and IE. |
||||
* 1. Remove the inheritance of text transform in Firefox. |
||||
*/ |
||||
|
||||
button, |
||||
select { /* 1 */ |
||||
text-transform: none; |
||||
} |
||||
|
||||
/** |
||||
* 1. Prevent a WebKit bug where (2) destroys native `audio` and `video` |
||||
* controls in Android 4. |
||||
* 2. Correct the inability to style clickable types in iOS and Safari. |
||||
*/ |
||||
|
||||
button, |
||||
html [type="button"], /* 1 */ |
||||
[type="reset"], |
||||
[type="submit"] { |
||||
-webkit-appearance: button; /* 2 */ |
||||
} |
||||
|
||||
/** |
||||
* Remove the inner border and padding in Firefox. |
||||
*/ |
||||
|
||||
button::-moz-focus-inner, |
||||
[type="button"]::-moz-focus-inner, |
||||
[type="reset"]::-moz-focus-inner, |
||||
[type="submit"]::-moz-focus-inner { |
||||
border-style: none; |
||||
padding: 0; |
||||
} |
||||
|
||||
/** |
||||
* Restore the focus styles unset by the previous rule. |
||||
*/ |
||||
|
||||
button:-moz-focusring, |
||||
[type="button"]:-moz-focusring, |
||||
[type="reset"]:-moz-focusring, |
||||
[type="submit"]:-moz-focusring { |
||||
outline: 1px dotted ButtonText; |
||||
} |
||||
|
||||
/** |
||||
* Correct the padding in Firefox. |
||||
*/ |
||||
|
||||
fieldset { |
||||
padding: 0.35em 0.75em 0.625em; |
||||
} |
||||
|
||||
/** |
||||
* 1. Correct the text wrapping in Edge and IE. |
||||
* 2. Correct the color inheritance from `fieldset` elements in IE. |
||||
* 3. Remove the padding so developers are not caught out when they zero out |
||||
* `fieldset` elements in all browsers. |
||||
*/ |
||||
|
||||
legend { |
||||
box-sizing: border-box; /* 1 */ |
||||
color: inherit; /* 2 */ |
||||
display: table; /* 1 */ |
||||
max-width: 100%; /* 1 */ |
||||
padding: 0; /* 3 */ |
||||
white-space: normal; /* 1 */ |
||||
} |
||||
|
||||
/** |
||||
* 1. Add the correct display in IE 9-. |
||||
* 2. Add the correct vertical alignment in Chrome, Firefox, and Opera. |
||||
*/ |
||||
|
||||
progress { |
||||
display: inline-block; /* 1 */ |
||||
vertical-align: baseline; /* 2 */ |
||||
} |
||||
|
||||
/** |
||||
* Remove the default vertical scrollbar in IE. |
||||
*/ |
||||
|
||||
textarea { |
||||
overflow: auto; |
||||
} |
||||
|
||||
/** |
||||
* 1. Add the correct box sizing in IE 10-. |
||||
* 2. Remove the padding in IE 10-. |
||||
*/ |
||||
|
||||
[type="checkbox"], |
||||
[type="radio"] { |
||||
box-sizing: border-box; /* 1 */ |
||||
padding: 0; /* 2 */ |
||||
} |
||||
|
||||
/** |
||||
* Correct the cursor style of increment and decrement buttons in Chrome. |
||||
*/ |
||||
|
||||
[type="number"]::-webkit-inner-spin-button, |
||||
[type="number"]::-webkit-outer-spin-button { |
||||
height: auto; |
||||
} |
||||
|
||||
/** |
||||
* 1. Correct the odd appearance in Chrome and Safari. |
||||
* 2. Correct the outline style in Safari. |
||||
*/ |
||||
|
||||
[type="search"] { |
||||
-webkit-appearance: textfield; /* 1 */ |
||||
outline-offset: -2px; /* 2 */ |
||||
} |
||||
|
||||
/** |
||||
* Remove the inner padding and cancel buttons in Chrome and Safari on macOS. |
||||
*/ |
||||
|
||||
[type="search"]::-webkit-search-cancel-button, |
||||
[type="search"]::-webkit-search-decoration { |
||||
-webkit-appearance: none; |
||||
} |
||||
|
||||
/** |
||||
* 1. Correct the inability to style clickable types in iOS and Safari. |
||||
* 2. Change font properties to `inherit` in Safari. |
||||
*/ |
||||
|
||||
::-webkit-file-upload-button { |
||||
-webkit-appearance: button; /* 1 */ |
||||
font: inherit; /* 2 */ |
||||
} |
||||
|
||||
/* Interactive |
||||
========================================================================== */ |
||||
|
||||
/* |
||||
* Add the correct display in IE 9-. |
||||
* 1. Add the correct display in Edge, IE, and Firefox. |
||||
*/ |
||||
|
||||
details, /* 1 */ |
||||
menu { |
||||
display: block; |
||||
} |
||||
|
||||
/* |
||||
* Add the correct display in all browsers. |
||||
*/ |
||||
|
||||
summary { |
||||
display: list-item; |
||||
} |
||||
|
||||
/* Scripting |
||||
========================================================================== */ |
||||
|
||||
/** |
||||
* Add the correct display in IE 9-. |
||||
*/ |
||||
|
||||
canvas { |
||||
display: inline-block; |
||||
} |
||||
|
||||
/** |
||||
* Add the correct display in IE. |
||||
*/ |
||||
|
||||
template { |
||||
display: none; |
||||
} |
||||
|
||||
/* Hidden |
||||
========================================================================== */ |
||||
|
||||
/** |
||||
* Add the correct display in IE 10-. |
||||
*/ |
||||
|
||||
[hidden] { |
||||
display: none; |
||||
} |
||||
|
After Width: | Height: | Size: 26 KiB |
|
After Width: | Height: | Size: 80 KiB |
|
After Width: | Height: | Size: 1.5 KiB |
@ -0,0 +1,703 @@ |
||||
|
||||
.logo { |
||||
margin-bottom: 30px; |
||||
} |
||||
@media (max-width: 1012px) { |
||||
.logo { |
||||
display: none; |
||||
} |
||||
} |
||||
|
||||
.logo--mobile { |
||||
display: none; |
||||
} |
||||
@media (max-width: 1012px) { |
||||
.logo--mobile { |
||||
display: block; |
||||
box-sizing: border-box; |
||||
max-width: 35px; |
||||
position: absolute; |
||||
z-index: 10; |
||||
top: 50%; |
||||
left: 40px; |
||||
transform: translateY(-50%); |
||||
} |
||||
.logo--mobile img { |
||||
width: 100%; |
||||
} |
||||
} |
||||
@media (max-width: 767px) { |
||||
.logo--mobile { |
||||
left: 20px; |
||||
} |
||||
} |
||||
|
||||
|
||||
|
||||
.navigation-footer { |
||||
margin-top: auto; |
||||
order: 3; |
||||
color: #CA4F62; |
||||
display: flex; |
||||
align-items: center; |
||||
} |
||||
@media (max-width: 1012px) { |
||||
.navigation-footer { |
||||
margin-top: 50px; |
||||
} |
||||
} |
||||
.navigation-footer img { |
||||
height: 35px; |
||||
} |
||||
.navigation-footer a { |
||||
font-size: .9em; |
||||
margin-left: 10px; |
||||
} |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
/* Search Box */ |
||||
#MSearchBox { |
||||
border-radius: 5px; |
||||
margin-top: 0px; |
||||
margin-bottom: 15px; |
||||
background: none; |
||||
background-color: white; |
||||
position: relative; |
||||
border-radius: 0; |
||||
box-shadow: none; |
||||
width: 100%; |
||||
} |
||||
#MSearchBox .right { |
||||
display: none; |
||||
} |
||||
#MSearchBox .left { |
||||
width: 100%; |
||||
height: auto; |
||||
left: 0; |
||||
} |
||||
#MSearchBox img { |
||||
position: absolute; |
||||
z-index: 1; |
||||
top: 4px; |
||||
left: 0px; |
||||
} |
||||
#MSearchBox input[type=text] { |
||||
position: inherit; |
||||
padding: 16px 15px 14px 30px; |
||||
border: 0; |
||||
box-sizing: border-box; |
||||
background: none; |
||||
background-color: white; |
||||
width: 100%; |
||||
margin: 0; |
||||
box-sizing: border-box; |
||||
font-family: 'Roboto', sans-serif; |
||||
font-size: 0.9em; |
||||
} |
||||
#MSearchSelectWindow { |
||||
position: fixed; |
||||
top: 178px !important; |
||||
left: 49px !important; |
||||
border: solid 1px #d4d4d4; |
||||
border-radius: 0; |
||||
box-shadow: 0px 3px 5px 0px rgba(0,0,0,0.25); |
||||
background-color: white; |
||||
} |
||||
#MSearchSelectWindow .SelectItem { |
||||
font-family: 'Roboto', sans-serif; |
||||
padding: 1px 25px 1px 6px; |
||||
} |
||||
#MSearchSelectWindow .SelectionMark { |
||||
color: black; |
||||
} |
||||
#MSearchSelectWindow .SelectItem:hover { |
||||
background-color: #CA4F62; |
||||
} |
||||
#MSearchResultsWindow { |
||||
position: fixed; |
||||
top: 178px !important; |
||||
left: 49px !important; |
||||
border: solid 1px #d4d4d4; |
||||
border-radius: 0; |
||||
box-shadow: 0px 3px 5px 0px rgba(0,0,0,0.25); |
||||
background-color: white; |
||||
} |
||||
.SRSymbol { |
||||
color: #CA4F62; |
||||
} |
||||
|
||||
|
||||
|
||||
/* Main Navigation */ |
||||
#main-nav ul { |
||||
list-style-type: none; |
||||
margin: 0; |
||||
padding: 0; |
||||
} |
||||
#main-nav > ul { |
||||
display: flex; |
||||
flex-direction: column; |
||||
} |
||||
#main-nav > ul > li > a { |
||||
font-weight: normal; |
||||
font-size: 18px; |
||||
} |
||||
#main-nav > ul > li { |
||||
position: relative; |
||||
padding-bottom: 20px; |
||||
flex: 1; |
||||
order: 2; |
||||
} |
||||
#main-nav > ul > li:last-child { |
||||
order: 1; |
||||
float: none !important; |
||||
} |
||||
#main-nav ul li a { |
||||
display: block; |
||||
} |
||||
|
||||
#main-nav ul li.hasChildren > a:hover[aria-expanded="false"] { |
||||
text-decoration: none; |
||||
} |
||||
|
||||
#main-nav ul li a:hover { |
||||
text-decoration: underline; |
||||
color: #CA4F62; |
||||
} |
||||
|
||||
#main-nav ul ul li { |
||||
position: relative; |
||||
padding-bottom: 10px; |
||||
} |
||||
|
||||
#main-nav ul li.hasChildren > a[aria-expanded="false"]:after { |
||||
position: absolute; |
||||
content: "+"; |
||||
/*top: -1px;*/ |
||||
right: -2px; |
||||
line-height: 20px; |
||||
font-size: 20px; |
||||
} |
||||
|
||||
#main-nav li ul { |
||||
padding-left: 5px; |
||||
display: none; |
||||
padding-top: 15px; |
||||
/*padding-bottom: 15px;*/ |
||||
} |
||||
|
||||
@media (max-width: 1012px) { |
||||
#main-nav > ul > li.hasChildren:after { |
||||
top: 9px; |
||||
} |
||||
#main-nav > ul > li { |
||||
padding-bottom: 0px; |
||||
} |
||||
#main-nav > ul > li:first-child { |
||||
border-top: 1px solid rgba(0,0,0,0.2); |
||||
} |
||||
#main-nav > ul > li { |
||||
padding: 10px 0; |
||||
border-bottom: 1px solid rgba(0,0,0,0.2); |
||||
} |
||||
#main-nav > ul > li:last-child { |
||||
padding: 10px 0; |
||||
} |
||||
#main-nav > ul > li ul { |
||||
padding-bottom: 10px; |
||||
} |
||||
} |
||||
|
||||
|
||||
/* Page Header */ |
||||
div.header { |
||||
background: none; |
||||
padding: 0px; |
||||
margin-bottom: 20px; |
||||
border-bottom: none; |
||||
} |
||||
div.header .headertitle { |
||||
padding: 0; |
||||
} |
||||
div.header .title { |
||||
margin: 0; |
||||
} |
||||
div.header .summary { |
||||
font-size: 13px; |
||||
padding: 9px 0 0 0; |
||||
width: auto; |
||||
} |
||||
@media (max-width: 767px) { |
||||
div.header .summary { |
||||
text-align: left; |
||||
margin-bottom: 20px; |
||||
} |
||||
} |
||||
div.header .summary a:hover { |
||||
color: #CA4F62; |
||||
} |
||||
div.header .ingroups { |
||||
font-size: 13px; |
||||
width: auto; |
||||
font-weight: normal; |
||||
} |
||||
|
||||
|
||||
/* Floating labels */ |
||||
span.mlabels { |
||||
margin: 0; |
||||
margin-left: 10px; |
||||
} |
||||
span.mlabel { |
||||
margin: 0; |
||||
margin-left: 10px; |
||||
border: solid 1px #CA4F62; |
||||
background-color: #CA4F62; |
||||
padding: 3px 5px; |
||||
font-weight: normal; |
||||
} |
||||
|
||||
|
||||
/* Content area */ |
||||
div.contents { |
||||
padding: 0; |
||||
margin: 0px; |
||||
margin-bottom: 20px; |
||||
} |
||||
div.contents ul li { |
||||
margin-bottom: 10px; |
||||
} |
||||
div.contents ul li:last-child { |
||||
margin-bottom: 0px; |
||||
} |
||||
|
||||
div.toc { |
||||
padding: 0; |
||||
padding-bottom: 20px; |
||||
background-color: transparent; |
||||
border: none; |
||||
box-sizing: border-box; |
||||
float: none; |
||||
width: 100%; |
||||
margin: 0; |
||||
border-radius: 0; |
||||
} |
||||
|
||||
@media (max-width: 767px) { |
||||
div.toc { |
||||
// |
||||
} |
||||
} |
||||
div.toc h3 { |
||||
margin: 0; |
||||
margin-bottom: 5px; |
||||
color: black; |
||||
font: 400 14px/22px Roboto,sans-serif; |
||||
font-weight: bold; |
||||
} |
||||
div.toc ul { |
||||
margin: 0; |
||||
} |
||||
div.toc ul li { |
||||
margin-left: 0 !important; |
||||
padding-left: 15px !important; |
||||
font: 400 14px/22px Roboto,sans-serif; |
||||
} |
||||
div.toc li ul { |
||||
padding-left: 10px; |
||||
padding-top: 7px; |
||||
} |
||||
|
||||
/* Group Headers */ |
||||
h2.groupheader { |
||||
border-bottom: solid 1px #d4d4d4; |
||||
color: black; |
||||
margin: 0px; |
||||
margin-top: 30px; |
||||
padding: 10px 0; |
||||
} |
||||
tr.heading h2 { |
||||
margin: 0px; |
||||
} |
||||
|
||||
|
||||
/* Tables */ |
||||
table.memberdecls { |
||||
margin-top: 30px; |
||||
/*margin-bottom: 30px;*/ |
||||
} |
||||
table.memberdecls td.memSeparator { |
||||
line-height: 0; |
||||
font-size: 0; |
||||
border-bottom: 1px solid #d4d4d4; |
||||
} |
||||
table.memberdecls td.memItemLeft { |
||||
padding: 7px 15px 4px 15px; |
||||
background-color: #f5f5f5; |
||||
} |
||||
table.memberdecls td.memItemRight { |
||||
padding: 7px 15px 4px 15px; |
||||
background-color: #f5f5f5; |
||||
} |
||||
table.memberdecls td.mdescLeft { |
||||
padding: 7px 15px 4px 15px; |
||||
background-color: #f5f5f5; |
||||
} |
||||
table.memberdecls td.mdescRight { |
||||
padding: 7px 15px 4px 15px; |
||||
background-color: #f5f5f5; |
||||
} |
||||
|
||||
table.params .paramname { |
||||
color: black; |
||||
} |
||||
|
||||
|
||||
table.markdownTable td, table.markdownTable th { |
||||
border: 1px solid #d4d4d4; |
||||
padding: 3px 7px; |
||||
color: black; |
||||
} |
||||
|
||||
table.markdownTable th.markdownTableHeadLeft, table.markdownTable th.markdownTableHeadRight, table.markdownTable th.markdownTableHeadCenter, table.markdownTable th.markdownTableHeadNone { |
||||
background-color: #f5f5f5; |
||||
color: black; |
||||
padding: 3px 7px; |
||||
} |
||||
|
||||
div.contents .fragment { |
||||
border: solid 1px #CA4F62; |
||||
padding: 20px; |
||||
border-radius: 4px; |
||||
} |
||||
|
||||
div.contents .line { |
||||
line-height: 15px; |
||||
} |
||||
|
||||
|
||||
.memtitle { |
||||
margin-top: 10px; |
||||
border-top: solid 1px #d4d4d4; |
||||
border-left: solid 1px #d4d4d4; |
||||
border-right: solid 1px #d4d4d4; |
||||
background: none; |
||||
background-color: #f5f5f5; |
||||
padding: 8px 10px; |
||||
font-weight: bold; |
||||
font-size: 18px; |
||||
} |
||||
.memtitle .permalink a, .memtitle .permalink a:visited { |
||||
color: black; |
||||
} |
||||
.memtitle .permalink a:hover { |
||||
text-decoration: none; |
||||
} |
||||
.memitem { |
||||
margin: 0; |
||||
box-shadow: none; |
||||
} |
||||
.memitem.glow { |
||||
box-shadow: 0 0 15px #CA4F62; |
||||
} |
||||
.memitem .memproto { |
||||
box-shadow: none; |
||||
background: none; |
||||
background-color: #f5f5f5; |
||||
border-top: solid 1px #d4d4d4; |
||||
border-left: solid 1px #d4d4d4; |
||||
border-right: solid 1px #d4d4d4; |
||||
color: black; |
||||
padding: 8px 10px; |
||||
} |
||||
.memitem .memproto .memname { |
||||
margin-left: 0; |
||||
} |
||||
.memitem .memdoc { |
||||
box-shadow: none; |
||||
background: none; |
||||
border-bottom: solid 1px #d4d4d4; |
||||
border-left: solid 1px #d4d4d4; |
||||
border-right: solid 1px #d4d4d4; |
||||
padding: 10px 12px; |
||||
|
||||
} |
||||
|
||||
|
||||
/* General links? */ |
||||
a.el { |
||||
font-weight: normal; |
||||
} |
||||
a.el { |
||||
color: #CA4F62; |
||||
} |
||||
a.el:visited { |
||||
color: #CA4F62; |
||||
} |
||||
a.el:hover { |
||||
color: #CA4F62; |
||||
} |
||||
div.contents a { |
||||
color: #CA4F62; |
||||
} |
||||
div.contents a:visited { |
||||
color: #CA4F62; |
||||
} |
||||
div.contents a:hover { |
||||
color: #CA4F62; |
||||
} |
||||
|
||||
|
||||
/* Highlighted effect */ |
||||
h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { |
||||
text-shadow: 0 0 15px #CA4F62; |
||||
} |
||||
|
||||
|
||||
/* Directory */ |
||||
div.directory { |
||||
margin: 20px 0px; |
||||
border-top: 1px solid #d4d4d4; |
||||
border-bottom: 1px solid #d4d4d4; |
||||
} |
||||
div.directory .levels { |
||||
font-size: 13px; |
||||
padding: 8px 0; |
||||
} |
||||
div.directory .levels span:hover { |
||||
color: #CA4F62; |
||||
} |
||||
table.directory { |
||||
/*width: 100%;*/ |
||||
} |
||||
table.directory tr.even { |
||||
background-color: #f5f5f5; |
||||
} |
||||
table.directory td.entry { |
||||
padding: 8px 6px; |
||||
vertical-align: middle; |
||||
box-sizing: border-box; |
||||
} |
||||
table.directory td.desc { |
||||
padding: 8px 6px; |
||||
vertical-align: middle; |
||||
box-sizing: border-box; |
||||
} |
||||
|
||||
|
||||
/* Icons */ |
||||
.iconfopen, .icondoc { |
||||
margin: 0; |
||||
} |
||||
|
||||
|
||||
|
||||
dl.reflist dt { |
||||
box-shadow: none; |
||||
background-color: #F5F5F5; |
||||
border-top: solid 1px #d4d4d4; |
||||
border-left: solid 1px #d4d4d4; |
||||
border-right: solid 1px #d4d4d4; |
||||
padding: 10px; |
||||
} |
||||
dl.reflist dd { |
||||
box-shadow: none; |
||||
background: none; |
||||
border-bottom: solid 1px #d4d4d4; |
||||
border-left: solid 1px #d4d4d4; |
||||
border-right: solid 1px #d4d4d4; |
||||
padding: 10px; |
||||
} |
||||
|
||||
|
||||
/* Standard arrow icon? */ |
||||
.arrow { |
||||
color: #d4d4d4; |
||||
width: auto; |
||||
height: auto; |
||||
margin: 0 5px; |
||||
} |
||||
|
||||
.icona { |
||||
height: auto; |
||||
width: auto; |
||||
margin-right: 8px; |
||||
} |
||||
.icona .icon { |
||||
font-family: 'Roboto', sans-serif; |
||||
margin: 0; |
||||
background-color: #CA4F62; |
||||
padding: 1px; |
||||
font-weight: normal; |
||||
} |
||||
|
||||
/* horizontal ruler */ |
||||
hr { |
||||
border: none; |
||||
border-top: 1px solid #d4d4d4; |
||||
margin-top: 20px; |
||||
margin-bottom: 20px; |
||||
} |
||||
|
||||
|
||||
/* Notes */ |
||||
dl.warning { |
||||
margin: 0px; |
||||
padding: 0px; |
||||
padding-left: 10px; |
||||
} |
||||
dl.note { |
||||
margin: 0px; |
||||
padding: 0px; |
||||
padding-left: 10px; |
||||
} |
||||
dl.attention { |
||||
margin: 0px; |
||||
padding: 0px; |
||||
padding-left: 10px; |
||||
} |
||||
dl.todo { |
||||
margin: 0px; |
||||
padding: 0px; |
||||
padding-left: 10px; |
||||
} |
||||
dl dt, dl dt a.el { |
||||
font-weight: bold; |
||||
} |
||||
dl dd { |
||||
margin: 0px; |
||||
} |
||||
|
||||
|
||||
table.fieldtable { |
||||
box-shadow: none; |
||||
border: 1px solid #d4d4d4; |
||||
} |
||||
table.fieldtable th { |
||||
background: none; |
||||
background-color: #F5F5F5; |
||||
border-bottom: 1px solid #d4d4d4; |
||||
color: black; |
||||
font-size: 100%; |
||||
font-weight: bold; |
||||
} |
||||
table.fieldtable td.fieldname, table.fieldtable td.fielddoc { |
||||
border-bottom: 1px solid #d4d4d4; |
||||
border-right: 1px solid #d4d4d4; |
||||
vertical-align: middle; |
||||
} |
||||
|
||||
|
||||
div.qindex { |
||||
background-color: #F5F5F5; |
||||
border: none; |
||||
text-align: center; |
||||
padding: 8px 0; |
||||
} |
||||
table.classindex div.ah { |
||||
font-family: 'Roboto', sans-serif; |
||||
margin: 0; |
||||
background: none; |
||||
background-color: #CA4F62; |
||||
padding: 1px; |
||||
font-weight: normal; |
||||
border: none; |
||||
box-shadow: none; |
||||
border-radius: 0; |
||||
padding: 3px; |
||||
} |
||||
table.classindex td { |
||||
padding: 3px 6px; |
||||
vertical-align: middle; |
||||
font-size: 14px; |
||||
} |
||||
table.classindex table td { |
||||
padding: 0; |
||||
vertical-align: middle; |
||||
} |
||||
|
||||
|
||||
div.textblock h2 { |
||||
border-bottom: solid 1px #d4d4d4; |
||||
padding-bottom: 10px; |
||||
} |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
.navigation-mobile { |
||||
display: none; |
||||
background-color: #F5F5F5; |
||||
position: fixed; |
||||
top: 0; |
||||
left: 0; |
||||
width: 100%; |
||||
height: 70px; |
||||
} |
||||
@media (max-width: 1012px) { |
||||
.navigation-mobile { |
||||
display: block; |
||||
} |
||||
} |
||||
|
||||
|
||||
.navigation-toggle { |
||||
cursor: pointer; |
||||
width: 44px; |
||||
height: 44px; |
||||
margin-right: 20px; |
||||
position: absolute; |
||||
right: 0; |
||||
top: 50%; |
||||
transform: translateY(-50%); |
||||
bottom: 5%; |
||||
z-index: 50; |
||||
display: none; |
||||
} |
||||
@media (max-width: 1012px) { |
||||
.navigation-toggle { |
||||
display: block; |
||||
} |
||||
} |
||||
@media (max-width: 767px) { |
||||
.navigation-toggle { |
||||
margin-right: 0px; |
||||
} |
||||
} |
||||
.navigation-toggle span { |
||||
display: block; |
||||
text-indent: -9999px; |
||||
position: absolute; |
||||
height: 2px; |
||||
left: 10px; |
||||
right: 10px; |
||||
background-color: #CA4F62; |
||||
border-radius: 1px; |
||||
transition: 0.15s all; |
||||
} |
||||
.line-1 { |
||||
top: 14px; |
||||
} |
||||
.line-2 { |
||||
top: 50%; |
||||
margin-top: -1px; |
||||
} |
||||
.line-3 { |
||||
bottom: 14px; |
||||
} |
||||
.navigation-toggle.clicked .line-1 { |
||||
transform: rotate(45deg); |
||||
top: 21px; |
||||
} |
||||
.navigation-toggle.clicked .line-2 { |
||||
opacity: 0; |
||||
} |
||||
.navigation-toggle.clicked .line-3 { |
||||
transform: rotate(-45deg); |
||||
bottom: 21px; |
||||
} |
||||
|
||||
@ -0,0 +1,31 @@ |
||||
## Documentation and datasheets {#weblinks_page} |
||||
|
||||
The full documentation for the RP2040 and Raspberry Pi Pico board can be found at the following links |
||||
|
||||
- [RP2040 Datasheet](https://rptl.io/rp2040-datasheet) |
||||
- [Raspberry Pi Pico Datasheet](https://rptl.io/pico-datasheet) |
||||
- [Hardware design with the RP2040](https://rptl.io/rp2040-design) |
||||
- [Raspberry Pi Pico C/C++ SDK](https://rptl.io/pico-c-sdk) |
||||
- [Raspberry Pi Pico Python SDK](https://rptl.io/pico-micropython) |
||||
- [Getting started with Raspberry Pi Pico](https://rptl.io/pico-get-started) |
||||
- [Raspberry Pi Pico FAQ](https://rptl.io/pico-faq) |
||||
|
||||
### Weblinks |
||||
|
||||
At Raspberry Pi we have a very community-based attitude to help. We run a very popular and busy forum where you can ask questions about any aspect of the Raspberry Pi ecosystem, including the Raspberry Pi Pico. |
||||
|
||||
You can find our forums at the [following link](https://forums.raspberrypi.com/). |
||||
|
||||
For the main Raspberry Pi website, [see here](https://www.raspberrypi.com) |
||||
|
||||
For the Raspberry Pi Pico page, [see here](https://rptl.io/rp2040-get-started) |
||||
|
||||
### GitHub |
||||
|
||||
All the source code for the Raspberry Pi Pico SDK, examples and other libraries can be found on GitHub. |
||||
|
||||
- [Raspberry Pi Pico SDK](https://github.com/raspberrypi/pico-sdk) |
||||
- [Pico Examples](https://github.com/raspberrypi/pico-examples) |
||||
- [Pico Extras - Libraries under development](https://github.com/raspberrypi/pico-extras) |
||||
- [Pico Playground - Examples that use Pico Extras](https://github.com/raspberrypi/pico-playground) |
||||
- [Pico Bootrom source code](https://github.com/raspberrypi/pico-bootrom) |
||||
@ -0,0 +1,62 @@ |
||||
# This is a copy of <PICO_SDK_PATH>/external/pico_sdk_import.cmake |
||||
|
||||
# This can be dropped into an external project to help locate this SDK |
||||
# It should be include()ed prior to project() |
||||
|
||||
if (DEFINED ENV{PICO_SDK_PATH} AND (NOT PICO_SDK_PATH)) |
||||
set(PICO_SDK_PATH $ENV{PICO_SDK_PATH}) |
||||
message("Using PICO_SDK_PATH from environment ('${PICO_SDK_PATH}')") |
||||
endif () |
||||
|
||||
if (DEFINED ENV{PICO_SDK_FETCH_FROM_GIT} AND (NOT PICO_SDK_FETCH_FROM_GIT)) |
||||
set(PICO_SDK_FETCH_FROM_GIT $ENV{PICO_SDK_FETCH_FROM_GIT}) |
||||
message("Using PICO_SDK_FETCH_FROM_GIT from environment ('${PICO_SDK_FETCH_FROM_GIT}')") |
||||
endif () |
||||
|
||||
if (DEFINED ENV{PICO_SDK_FETCH_FROM_GIT_PATH} AND (NOT PICO_SDK_FETCH_FROM_GIT_PATH)) |
||||
set(PICO_SDK_FETCH_FROM_GIT_PATH $ENV{PICO_SDK_FETCH_FROM_GIT_PATH}) |
||||
message("Using PICO_SDK_FETCH_FROM_GIT_PATH from environment ('${PICO_SDK_FETCH_FROM_GIT_PATH}')") |
||||
endif () |
||||
|
||||
set(PICO_SDK_PATH "${PICO_SDK_PATH}" CACHE PATH "Path to the Raspberry Pi Pico SDK") |
||||
set(PICO_SDK_FETCH_FROM_GIT "${PICO_SDK_FETCH_FROM_GIT}" CACHE BOOL "Set to ON to fetch copy of SDK from git if not otherwise locatable") |
||||
set(PICO_SDK_FETCH_FROM_GIT_PATH "${PICO_SDK_FETCH_FROM_GIT_PATH}" CACHE FILEPATH "location to download SDK") |
||||
|
||||
if (NOT PICO_SDK_PATH) |
||||
if (PICO_SDK_FETCH_FROM_GIT) |
||||
include(FetchContent) |
||||
set(FETCHCONTENT_BASE_DIR_SAVE ${FETCHCONTENT_BASE_DIR}) |
||||
if (PICO_SDK_FETCH_FROM_GIT_PATH) |
||||
get_filename_component(FETCHCONTENT_BASE_DIR "${PICO_SDK_FETCH_FROM_GIT_PATH}" REALPATH BASE_DIR "${CMAKE_SOURCE_DIR}") |
||||
endif () |
||||
FetchContent_Declare( |
||||
pico_sdk |
||||
GIT_REPOSITORY https://github.com/raspberrypi/pico-sdk |
||||
GIT_TAG master |
||||
) |
||||
if (NOT pico_sdk) |
||||
message("Downloading Raspberry Pi Pico SDK") |
||||
FetchContent_Populate(pico_sdk) |
||||
set(PICO_SDK_PATH ${pico_sdk_SOURCE_DIR}) |
||||
endif () |
||||
set(FETCHCONTENT_BASE_DIR ${FETCHCONTENT_BASE_DIR_SAVE}) |
||||
else () |
||||
message(FATAL_ERROR |
||||
"SDK location was not specified. Please set PICO_SDK_PATH or set PICO_SDK_FETCH_FROM_GIT to on to fetch from git." |
||||
) |
||||
endif () |
||||
endif () |
||||
|
||||
get_filename_component(PICO_SDK_PATH "${PICO_SDK_PATH}" REALPATH BASE_DIR "${CMAKE_BINARY_DIR}") |
||||
if (NOT EXISTS ${PICO_SDK_PATH}) |
||||
message(FATAL_ERROR "Directory '${PICO_SDK_PATH}' not found") |
||||
endif () |
||||
|
||||
set(PICO_SDK_INIT_CMAKE_FILE ${PICO_SDK_PATH}/pico_sdk_init.cmake) |
||||
if (NOT EXISTS ${PICO_SDK_INIT_CMAKE_FILE}) |
||||
message(FATAL_ERROR "Directory '${PICO_SDK_PATH}' does not appear to contain the Raspberry Pi Pico SDK") |
||||
endif () |
||||
|
||||
set(PICO_SDK_PATH ${PICO_SDK_PATH} CACHE PATH "Path to the Raspberry Pi Pico SDK" FORCE) |
||||
|
||||
include(${PICO_SDK_INIT_CMAKE_FILE}) |
||||
@ -0,0 +1,25 @@ |
||||
# Set the default behavior, in case people don't have core.autocrlf set. |
||||
* text=auto |
||||
|
||||
*.c text |
||||
*.cpp text |
||||
*.h text |
||||
*.icf text |
||||
*.js text |
||||
*.json text |
||||
*.ld text |
||||
*.md text |
||||
*.mk text |
||||
*.py text |
||||
*.rst text |
||||
*.s text |
||||
*.txt text |
||||
*.xml text |
||||
*.yml text |
||||
|
||||
Makefile text |
||||
|
||||
# Windows-only Visual Studio things |
||||
|
||||
*.sln text eol=crlf |
||||
*.csproj text eol=crlf |
||||
@ -0,0 +1,74 @@ |
||||
name: Bug Report |
||||
description: Report a problem with TinyUSB |
||||
labels: 'Bug 🐞' |
||||
body: |
||||
- type: markdown |
||||
attributes: |
||||
value: | |
||||
Thanks for taking the time to fill out this bug report! |
||||
It's okay to leave some blank if it doesn't apply to your problem. |
||||
|
||||
- type: dropdown |
||||
attributes: |
||||
label: Operating System |
||||
options: |
||||
- Linux |
||||
- MacOS |
||||
- RaspberryPi OS |
||||
- Windows 7 |
||||
- Windows 10 |
||||
- Windows 11 |
||||
- Others |
||||
validations: |
||||
required: true |
||||
|
||||
- type: input |
||||
attributes: |
||||
label: Board |
||||
placeholder: e.g Feather nRF52840 Express |
||||
validations: |
||||
required: true |
||||
|
||||
- type: textarea |
||||
attributes: |
||||
label: Firmware |
||||
placeholder: | |
||||
e.g examples/device/cdc_msc. |
||||
If it is custom firmware, please provide links to your minimal sources or as attached files. |
||||
validations: |
||||
required: true |
||||
|
||||
- type: textarea |
||||
attributes: |
||||
label: What happened ? |
||||
placeholder: A clear and concise description of what the bug is. |
||||
validations: |
||||
required: true |
||||
|
||||
- type: textarea |
||||
attributes: |
||||
label: How to reproduce ? |
||||
placeholder: | |
||||
1. Go to '...' |
||||
2. Click on '....' |
||||
3. See error |
||||
validations: |
||||
required: true |
||||
|
||||
- type: textarea |
||||
attributes: |
||||
label: Debug Log |
||||
placeholder: | |
||||
TinyUSB debug log where the issue occurred as attached txt file, best with comments to explain the actual events. |
||||
|
||||
Note: To enable logging, add `LOG=3` to to the make command if building with stock examples or set `CFG_TUSB_DEBUG=3` in your tusb_config.h. |
||||
More information can be found at [example's readme](https://github.com/hathach/tinyusb/blob/master/docs/getting_started.md) |
||||
validations: |
||||
required: false |
||||
|
||||
- type: textarea |
||||
attributes: |
||||
label: Screenshots |
||||
description: If applicable, add screenshots to help explain your problem. |
||||
validations: |
||||
required: false |
||||
@ -0,0 +1,4 @@ |
||||
contact_links: |
||||
- name: TinyUSB Discussion |
||||
url: https://github.com/hathach/tinyusb/discussions |
||||
about: If you have other questions or need help, post it here. |
||||
@ -0,0 +1,14 @@ |
||||
--- |
||||
name: Feature Request |
||||
about: Suggest an idea for this project |
||||
title: '' |
||||
labels: Feature 💡 |
||||
assignees: '' |
||||
|
||||
--- |
||||
|
||||
**Is your feature request related to a problem? Please describe.** |
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] |
||||
|
||||
**Describe the solution you'd like** |
||||
A clear and concise description of what you want to happen. |
||||
@ -0,0 +1,5 @@ |
||||
**Describe the PR** |
||||
A clear and concise description of what this PR solve. |
||||
|
||||
**Additional context** |
||||
If applicable, add any other context about the PR and/or screenshots here. |
||||
@ -0,0 +1,159 @@ |
||||
name: Build ARM |
||||
|
||||
on: |
||||
pull_request: |
||||
push: |
||||
release: |
||||
types: |
||||
- created |
||||
|
||||
jobs: |
||||
# --------------------------------------- |
||||
# Unit testing with Ceedling |
||||
# --------------------------------------- |
||||
unit-test: |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- name: Setup Ruby |
||||
uses: actions/setup-ruby@v1 |
||||
with: |
||||
ruby-version: '2.7' |
||||
|
||||
- name: Checkout TinyUSB |
||||
uses: actions/checkout@v2 |
||||
|
||||
- name: Unit Tests |
||||
run: | |
||||
# Install Ceedling |
||||
gem install ceedling |
||||
cd test |
||||
ceedling test:all |
||||
|
||||
# --------------------------------------- |
||||
# Build ARM family |
||||
# --------------------------------------- |
||||
build-arm: |
||||
runs-on: ubuntu-latest |
||||
strategy: |
||||
fail-fast: false |
||||
matrix: |
||||
family: |
||||
# Alphabetical order |
||||
- 'imxrt' |
||||
- 'lpc15' |
||||
- 'lpc18' |
||||
- 'lpc54' |
||||
- 'lpc55' |
||||
- 'mm32' |
||||
- 'nrf' |
||||
- 'rp2040' |
||||
- 'samd11' |
||||
- 'samd21' |
||||
- 'samd51' |
||||
- 'saml2x' |
||||
- 'stm32f0' |
||||
- 'stm32f1' |
||||
- 'stm32f4' |
||||
- 'stm32f7' |
||||
- 'stm32h7' |
||||
steps: |
||||
- name: Setup Python |
||||
uses: actions/setup-python@v2 |
||||
|
||||
- name: Checkout TinyUSB |
||||
uses: actions/checkout@v2 |
||||
|
||||
- name: Checkout common submodules in lib |
||||
run: git submodule update --init lib/FreeRTOS-Kernel lib/lwip lib/sct_neopixel |
||||
|
||||
- name: Checkout hathach/linkermap |
||||
uses: actions/checkout@v2 |
||||
with: |
||||
repository: hathach/linkermap |
||||
path: linkermap |
||||
|
||||
- name: Checkout pico-sdk |
||||
if: matrix.family == 'rp2040' |
||||
run: | |
||||
git clone --depth 1 -b develop https://github.com/raspberrypi/pico-sdk ~/pico-sdk |
||||
echo >> $GITHUB_ENV PICO_SDK_PATH=~/pico-sdk |
||||
|
||||
- name: Set Toolchain URL |
||||
run: echo >> $GITHUB_ENV TOOLCHAIN_URL=https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/releases/download/v10.2.1-1.1/xpack-arm-none-eabi-gcc-10.2.1-1.1-linux-x64.tar.gz |
||||
|
||||
- name: Cache Toolchain |
||||
uses: actions/cache@v2 |
||||
id: cache-toolchain |
||||
with: |
||||
path: ~/cache/ |
||||
key: ${{ runner.os }}-21-03-04-${{ env.TOOLCHAIN_URL }} |
||||
|
||||
- name: Install Toolchain |
||||
if: steps.cache-toolchain.outputs.cache-hit != 'true' |
||||
run: | |
||||
mkdir -p ~/cache/toolchain |
||||
wget --progress=dot:mega $TOOLCHAIN_URL -O toolchain.tar.gz |
||||
tar -C ~/cache/toolchain -xaf toolchain.tar.gz |
||||
|
||||
- name: Set Toolchain Path |
||||
run: echo >> $GITHUB_PATH `echo ~/cache/toolchain/*/bin` |
||||
|
||||
- name: Build |
||||
run: python3 tools/build_family.py ${{ matrix.family }} |
||||
|
||||
- name: Linker Map |
||||
run: | |
||||
pip install linkermap/ |
||||
for ex in `ls -d examples/device/*/`; do \ |
||||
find ${ex} -name *.map -print -quit | \ |
||||
xargs -I % sh -c 'echo "::group::%"; linkermap -v %; echo "::endgroup::"'; \ |
||||
done |
||||
|
||||
# --------------------------------------- |
||||
# Build all no-family (opharned) boards |
||||
# --------------------------------------- |
||||
build-board: |
||||
runs-on: ubuntu-latest |
||||
strategy: |
||||
fail-fast: false |
||||
matrix: |
||||
example: |
||||
# Alphabetical order, a group of 4 |
||||
- 'device/audio_test device/board_test device/cdc_dual_ports device/cdc_msc' |
||||
- 'device/cdc_msc_freertos device/dfu_runtime device/hid_composite device/hid_composite_freertos' |
||||
- 'device/hid_generic_inout device/hid_multiple_interface device/midi_test device/msc_dual_lun' |
||||
- 'device/net_lwip_webserver' |
||||
- 'device/uac2_headset device/usbtmc device/webusb_serial host/cdc_msc_hid' |
||||
|
||||
steps: |
||||
- name: Setup Python |
||||
uses: actions/setup-python@v2 |
||||
|
||||
- name: Checkout TinyUSB |
||||
uses: actions/checkout@v2 |
||||
|
||||
- name: Checkout common submodules in lib |
||||
run: git submodule update --init lib/FreeRTOS-Kernel lib/lwip |
||||
|
||||
- name: Set Toolchain URL |
||||
run: echo >> $GITHUB_ENV TOOLCHAIN_URL=https://github.com/xpack-dev-tools/arm-none-eabi-gcc-xpack/releases/download/v10.2.1-1.1/xpack-arm-none-eabi-gcc-10.2.1-1.1-linux-x64.tar.gz |
||||
|
||||
- name: Cache Toolchain |
||||
uses: actions/cache@v2 |
||||
id: cache-toolchain |
||||
with: |
||||
path: ~/cache/ |
||||
key: ${{ runner.os }}-21-03-04-${{ env.TOOLCHAIN_URL }} |
||||
|
||||
- name: Install Toolchain |
||||
if: steps.cache-toolchain.outputs.cache-hit != 'true' |
||||
run: | |
||||
mkdir -p ~/cache/toolchain |
||||
wget --progress=dot:mega $TOOLCHAIN_URL -O toolchain.tar.gz |
||||
tar -C ~/cache/toolchain -xaf toolchain.tar.gz |
||||
|
||||
- name: Set Toolchain Path |
||||
run: echo >> $GITHUB_PATH `echo ~/cache/toolchain/*/bin` |
||||
|
||||
- name: Build |
||||
run: python3 tools/build_board.py ${{ matrix.example }} |
||||
@ -0,0 +1,48 @@ |
||||
name: Build ESP |
||||
|
||||
on: |
||||
pull_request: |
||||
push: |
||||
release: |
||||
types: |
||||
- created |
||||
|
||||
jobs: |
||||
build-esp: |
||||
runs-on: ubuntu-latest |
||||
strategy: |
||||
fail-fast: false |
||||
matrix: |
||||
board: |
||||
# Alphabetical order |
||||
# ESP32-S2 |
||||
- 'espressif_saola_1' |
||||
# ESP32-S3 |
||||
- 'espressif_addax_1' |
||||
|
||||
steps: |
||||
- name: Setup Python |
||||
uses: actions/setup-python@v2 |
||||
|
||||
- name: Pull ESP-IDF docker |
||||
run: docker pull espressif/idf:latest |
||||
|
||||
- name: Checkout TinyUSB |
||||
uses: actions/checkout@v2 |
||||
|
||||
- name: Checkout hathach/linkermap |
||||
uses: actions/checkout@v2 |
||||
with: |
||||
repository: hathach/linkermap |
||||
path: linkermap |
||||
|
||||
- name: Build |
||||
run: docker run --rm -v $PWD:/project -w /project espressif/idf:latest python3 tools/build_esp32sx.py ${{ matrix.board }} |
||||
|
||||
- name: Linker Map |
||||
run: | |
||||
pip install linkermap/ |
||||
for ex in `ls -d examples/device/*/`; do \ |
||||
find ${ex} -maxdepth 3 -name *.map -print -quit | \ |
||||
xargs -I % sh -c 'echo "::group::%"; linkermap -v %; echo "::endgroup::"'; \ |
||||
done |
||||
@ -0,0 +1,64 @@ |
||||
name: Build MSP430 |
||||
|
||||
on: |
||||
pull_request: |
||||
push: |
||||
release: |
||||
types: |
||||
- created |
||||
|
||||
jobs: |
||||
build-msp430: |
||||
runs-on: ubuntu-latest |
||||
strategy: |
||||
fail-fast: false |
||||
matrix: |
||||
family: |
||||
# Alphabetical order |
||||
- 'msp430' |
||||
steps: |
||||
- name: Setup Python |
||||
uses: actions/setup-python@v2 |
||||
|
||||
- name: Checkout TinyUSB |
||||
uses: actions/checkout@v2 |
||||
|
||||
- name: Checkout common submodules in lib |
||||
run: git submodule update --init lib/FreeRTOS-Kernel lib/lwip |
||||
|
||||
- name: Checkout hathach/linkermap |
||||
uses: actions/checkout@v2 |
||||
with: |
||||
repository: hathach/linkermap |
||||
path: linkermap |
||||
|
||||
- name: Set Toolchain URL |
||||
run: echo >> $GITHUB_ENV TOOLCHAIN_URL=http://software-dl.ti.com/msp430/msp430_public_sw/mcu/msp430/MSPGCC/9_2_0_0/export/msp430-gcc-9.2.0.50_linux64.tar.bz2 |
||||
|
||||
- name: Cache Toolchain |
||||
uses: actions/cache@v2 |
||||
id: cache-toolchain |
||||
with: |
||||
path: ~/cache/ |
||||
key: ${{ runner.os }}-21-03-04-${{ env.TOOLCHAIN_URL }} |
||||
|
||||
- name: Install Toolchain |
||||
if: steps.cache-toolchain.outputs.cache-hit != 'true' |
||||
run: | |
||||
mkdir -p ~/cache/toolchain |
||||
wget --progress=dot:mega $TOOLCHAIN_URL -O toolchain.tar.bz2 |
||||
tar -C ~/cache/toolchain -xaf toolchain.tar.bz2 |
||||
|
||||
- name: Set Toolchain Path |
||||
run: echo >> $GITHUB_PATH `echo ~/cache/toolchain/*/bin` |
||||
|
||||
- name: Build |
||||
run: python3 tools/build_family.py ${{ matrix.family }} |
||||
|
||||
- name: Linker Map |
||||
run: | |
||||
pip install linkermap/ |
||||
for ex in `ls -d examples/device/*/`; do \ |
||||
find ${ex} -name *.map -print -quit | \ |
||||
xargs -I % sh -c 'echo "::group::%"; linkermap -v %; echo "::endgroup::"'; \ |
||||
done |
||||
@ -0,0 +1,65 @@ |
||||
name: Build Renesas |
||||
|
||||
on: |
||||
pull_request: |
||||
push: |
||||
release: |
||||
types: |
||||
- created |
||||
|
||||
jobs: |
||||
build-rx: |
||||
runs-on: ubuntu-latest |
||||
strategy: |
||||
fail-fast: false |
||||
matrix: |
||||
family: |
||||
# Alphabetical order |
||||
- 'rx' |
||||
steps: |
||||
- name: Setup Python |
||||
uses: actions/setup-python@v2 |
||||
|
||||
- name: Checkout TinyUSB |
||||
uses: actions/checkout@v2 |
||||
|
||||
- name: Checkout common submodules in lib |
||||
run: git submodule update --init lib/FreeRTOS-Kernel lib/lwip |
||||
|
||||
- name: Checkout hathach/linkermap |
||||
uses: actions/checkout@v2 |
||||
with: |
||||
repository: hathach/linkermap |
||||
path: linkermap |
||||
|
||||
- name: Set Toolchain URL |
||||
run: echo >> $GITHUB_ENV TOOLCHAIN_URL=http://gcc-renesas.com/downloads/get.php?f=rx/8.3.0.202004-gnurx/gcc-8.3.0.202004-GNURX-ELF.run |
||||
|
||||
- name: Cache Toolchain |
||||
uses: actions/cache@v2 |
||||
id: cache-toolchain |
||||
with: |
||||
path: ~/cache/ |
||||
key: ${{ runner.os }}-21-03-30-${{ env.TOOLCHAIN_URL }} |
||||
|
||||
- name: Install Toolchain |
||||
if: steps.cache-toolchain.outputs.cache-hit != 'true' |
||||
run: | |
||||
mkdir -p ~/cache/toolchain/gnurx |
||||
wget --progress=dot:mega $TOOLCHAIN_URL -O toolchain.run |
||||
chmod +x toolchain.run |
||||
./toolchain.run -p ~/cache/toolchain/gnurx -y |
||||
|
||||
- name: Set Toolchain Path |
||||
run: echo >> $GITHUB_PATH `echo ~/cache/toolchain/*/bin` |
||||
|
||||
- name: Build |
||||
run: python3 tools/build_family.py ${{ matrix.family }} |
||||
|
||||
- name: Linker Map |
||||
run: | |
||||
pip install linkermap/ |
||||
for ex in `ls -d examples/device/*/`; do \ |
||||
find ${ex} -name *.map -print -quit | \ |
||||
xargs -I % sh -c 'echo "::group::%"; linkermap -v %; echo "::endgroup::"'; \ |
||||
done |
||||
@ -0,0 +1,65 @@ |
||||
name: Build RISC-V |
||||
|
||||
on: |
||||
pull_request: |
||||
push: |
||||
release: |
||||
types: |
||||
- created |
||||
|
||||
jobs: |
||||
build-riscv: |
||||
runs-on: ubuntu-latest |
||||
strategy: |
||||
fail-fast: false |
||||
matrix: |
||||
family: |
||||
# Alphabetical order |
||||
- 'fomu' |
||||
- 'gd32vf103' |
||||
steps: |
||||
- name: Setup Python |
||||
uses: actions/setup-python@v2 |
||||
|
||||
- name: Checkout TinyUSB |
||||
uses: actions/checkout@v2 |
||||
|
||||
- name: Checkout common submodules in lib |
||||
run: git submodule update --init lib/FreeRTOS-Kernel lib/lwip |
||||
|
||||
- name: Checkout hathach/linkermap |
||||
uses: actions/checkout@v2 |
||||
with: |
||||
repository: hathach/linkermap |
||||
path: linkermap |
||||
|
||||
- name: Set Toolchain URL |
||||
run: echo >> $GITHUB_ENV TOOLCHAIN_URL=https://github.com/xpack-dev-tools/riscv-none-embed-gcc-xpack/releases/download/v10.1.0-1.1/xpack-riscv-none-embed-gcc-10.1.0-1.1-linux-x64.tar.gz |
||||
|
||||
- name: Cache Toolchain |
||||
uses: actions/cache@v2 |
||||
id: cache-toolchain |
||||
with: |
||||
path: ~/cache/ |
||||
key: ${{ runner.os }}-21-03-04-${{ env.TOOLCHAIN_URL }} |
||||
|
||||
- name: Install Toolchain |
||||
if: steps.cache-toolchain.outputs.cache-hit != 'true' |
||||
run: | |
||||
mkdir -p ~/cache/toolchain |
||||
wget --progress=dot:mega $TOOLCHAIN_URL -O toolchain.tar.gz |
||||
tar -C ~/cache/toolchain -xaf toolchain.tar.gz |
||||
|
||||
- name: Set Toolchain Path |
||||
run: echo >> $GITHUB_PATH `echo ~/cache/toolchain/*/bin` |
||||
|
||||
- name: Build |
||||
run: python3 tools/build_family.py ${{ matrix.family }} |
||||
|
||||
- name: Linker Map |
||||
run: | |
||||
pip install linkermap/ |
||||
for ex in `ls -d examples/device/*/`; do \ |
||||
find ${ex} -name *.map -print -quit | \ |
||||
xargs -I % sh -c 'echo "::group::%"; linkermap -v %; echo "::endgroup::"'; \ |
||||
done |
||||
@ -0,0 +1,58 @@ |
||||
name: Trigger Repos |
||||
|
||||
on: |
||||
push: |
||||
branches: master |
||||
release: |
||||
types: |
||||
- created |
||||
|
||||
jobs: |
||||
trigger-mynewt: |
||||
if: github.repository == 'hathach/tinyusb' |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- name: Trigger mynewt-tinyusb-example |
||||
shell: bash |
||||
run: | |
||||
curl -X POST -H "Authorization: token ${{ secrets.API_TOKEN_GITHUB }}" -H "Accept: application/vnd.github.everest-preview+json" -H "Content-Type: application/json" --data '{"event_type": "rebuild"}' https://api.github.com/repos/hathach/mynewt-tinyusb-example/dispatches |
||||
|
||||
mirror-tinyusb-src: |
||||
if: github.repository == 'hathach/tinyusb' |
||||
runs-on: ubuntu-latest |
||||
steps: |
||||
- name: Checkout code |
||||
uses: actions/checkout@v2 |
||||
|
||||
- name: Push to tinyusb_src |
||||
run: | |
||||
# clone tinyusb_src with PAT |
||||
git config --global user.email "thach@tinyusb.org" |
||||
git config --global user.name "hathach" |
||||
git clone --depth 1 --single-branch --branch main "https://${{ secrets.API_TOKEN_GITHUB }}@github.com/hathach/tinyusb_src.git" tinyusb_src |
||||
|
||||
# Remove all files |
||||
rm -rf tinyusb_src/* |
||||
|
||||
# Copy src and other files |
||||
cp -r src tinyusb_src/ |
||||
cp LICENSE tinyusb_src/ |
||||
cd tinyusb_src |
||||
|
||||
# Commit if there is changes |
||||
if [ -n "$(git status --porcelain)" ]; then |
||||
git add . |
||||
git commit --message "Update from https://github.com/$GITHUB_REPOSITORY/commit/$GITHUB_SHA" |
||||
git push |
||||
fi |
||||
|
||||
- name: Create tinyusb_src Release |
||||
if: ${{ github.event_name == 'release' }} |
||||
run: | |
||||
# Push tag |
||||
cd tinyusb_src |
||||
git tag ${{ github.event.release.tag_name }} |
||||
git push origin ${{ github.event.release.tag_name }} |
||||
|
||||
# Send POST reqwuest to release https://docs.github.com/en/rest/reference/repos#create-a-release |
||||
curl -X POST -H "Authorization: token ${{ secrets.API_TOKEN_GITHUB }}" -H "Accept: application/vnd.github.v3+json" --data '{"tag_name": "${{ github.event.release.tag_name }}", "name": "${{ github.event.release.name }}", "body": "${{ github.event.release.body }}", "draft": ${{ github.event.release.draft }}, "prerelease": ${{ github.event.release.prerelease }}}' https://api.github.com/repos/hathach/tinyusb_src/releases |
||||
@ -0,0 +1,28 @@ |
||||
html |
||||
latex |
||||
*.d |
||||
*.o |
||||
*.P |
||||
*.map |
||||
*.axf |
||||
*.bin |
||||
*.jlink |
||||
*.emSession |
||||
*.elf |
||||
*.ind |
||||
.env |
||||
.settings/ |
||||
.idea/ |
||||
.gdb_history |
||||
/examples/*/*/build* |
||||
test_old/ |
||||
tests_obsolete/ |
||||
_build |
||||
/examples/*/*/ses |
||||
/examples/*/*/ozone |
||||
/examples/obsolete |
||||
# coverity intermediate files |
||||
cov-int |
||||
# cppcheck build directories |
||||
*-build-dir |
||||
/_bin/ |
||||
@ -0,0 +1,129 @@ |
||||
[submodule "hw/mcu/nordic/nrfx"] |
||||
path = hw/mcu/nordic/nrfx |
||||
url = https://github.com/NordicSemiconductor/nrfx.git |
||||
[submodule "tools/uf2"] |
||||
path = tools/uf2 |
||||
url = https://github.com/microsoft/uf2.git |
||||
[submodule "hw/mcu/sony/cxd56/spresense-exported-sdk"] |
||||
path = hw/mcu/sony/cxd56/spresense-exported-sdk |
||||
url = https://github.com/sonydevworld/spresense-exported-sdk.git |
||||
[submodule "hw/mcu/ti"] |
||||
path = hw/mcu/ti |
||||
url = https://github.com/hathach/ti_driver.git |
||||
[submodule "hw/mcu/microchip"] |
||||
path = hw/mcu/microchip |
||||
url = https://github.com/hathach/microchip_driver.git |
||||
[submodule "hw/mcu/nuvoton"] |
||||
path = hw/mcu/nuvoton |
||||
url = https://github.com/majbthrd/nuc_driver.git |
||||
[submodule "lib/lwip"] |
||||
path = lib/lwip |
||||
url = https://github.com/lwip-tcpip/lwip.git |
||||
[submodule "hw/mcu/st/cmsis_device_f4"] |
||||
path = hw/mcu/st/cmsis_device_f4 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_f4.git |
||||
[submodule "hw/mcu/st/stm32f4xx_hal_driver"] |
||||
path = hw/mcu/st/stm32f4xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32f4xx_hal_driver.git |
||||
[submodule "hw/mcu/st/cmsis_device_f0"] |
||||
path = hw/mcu/st/cmsis_device_f0 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_f0.git |
||||
[submodule "hw/mcu/st/stm32f0xx_hal_driver"] |
||||
path = hw/mcu/st/stm32f0xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32f0xx_hal_driver.git |
||||
[submodule "hw/mcu/st/cmsis_device_f1"] |
||||
path = hw/mcu/st/cmsis_device_f1 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_f1.git |
||||
[submodule "hw/mcu/st/stm32f1xx_hal_driver"] |
||||
path = hw/mcu/st/stm32f1xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32f1xx_hal_driver.git |
||||
[submodule "hw/mcu/st/cmsis_device_f2"] |
||||
path = hw/mcu/st/cmsis_device_f2 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_f2.git |
||||
[submodule "hw/mcu/st/stm32f2xx_hal_driver"] |
||||
path = hw/mcu/st/stm32f2xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32f2xx_hal_driver.git |
||||
[submodule "hw/mcu/st/cmsis_device_f3"] |
||||
path = hw/mcu/st/cmsis_device_f3 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_f3.git |
||||
[submodule "hw/mcu/st/stm32f3xx_hal_driver"] |
||||
path = hw/mcu/st/stm32f3xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32f3xx_hal_driver.git |
||||
[submodule "hw/mcu/st/cmsis_device_f7"] |
||||
path = hw/mcu/st/cmsis_device_f7 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_f7.git |
||||
[submodule "hw/mcu/st/stm32f7xx_hal_driver"] |
||||
path = hw/mcu/st/stm32f7xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32f7xx_hal_driver.git |
||||
[submodule "hw/mcu/st/cmsis_device_h7"] |
||||
path = hw/mcu/st/cmsis_device_h7 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_h7.git |
||||
[submodule "hw/mcu/st/stm32h7xx_hal_driver"] |
||||
path = hw/mcu/st/stm32h7xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32h7xx_hal_driver.git |
||||
[submodule "hw/mcu/st/cmsis_device_l0"] |
||||
path = hw/mcu/st/cmsis_device_l0 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_l0.git |
||||
[submodule "hw/mcu/st/stm32l0xx_hal_driver"] |
||||
path = hw/mcu/st/stm32l0xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32l0xx_hal_driver.git |
||||
[submodule "hw/mcu/st/cmsis_device_l1"] |
||||
path = hw/mcu/st/cmsis_device_l1 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_l1.git |
||||
[submodule "hw/mcu/st/stm32l1xx_hal_driver"] |
||||
path = hw/mcu/st/stm32l1xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32l1xx_hal_driver.git |
||||
[submodule "hw/mcu/st/cmsis_device_l4"] |
||||
path = hw/mcu/st/cmsis_device_l4 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_l4.git |
||||
[submodule "hw/mcu/st/stm32l4xx_hal_driver"] |
||||
path = hw/mcu/st/stm32l4xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32l4xx_hal_driver.git |
||||
[submodule "hw/mcu/st/cmsis_device_g0"] |
||||
path = hw/mcu/st/cmsis_device_g0 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_g0.git |
||||
[submodule "hw/mcu/st/stm32g0xx_hal_driver"] |
||||
path = hw/mcu/st/stm32g0xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32g0xx_hal_driver.git |
||||
[submodule "hw/mcu/st/cmsis_device_g4"] |
||||
path = hw/mcu/st/cmsis_device_g4 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_g4.git |
||||
[submodule "hw/mcu/st/stm32g4xx_hal_driver"] |
||||
path = hw/mcu/st/stm32g4xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32g4xx_hal_driver.git |
||||
[submodule "hw/mcu/st/cmsis_device_l5"] |
||||
path = hw/mcu/st/cmsis_device_l5 |
||||
url = https://github.com/STMicroelectronics/cmsis_device_l5.git |
||||
[submodule "hw/mcu/st/stm32l5xx_hal_driver"] |
||||
path = hw/mcu/st/stm32l5xx_hal_driver |
||||
url = https://github.com/STMicroelectronics/stm32l5xx_hal_driver.git |
||||
[submodule "lib/sct_neopixel"] |
||||
path = lib/sct_neopixel |
||||
url = https://github.com/gsteiert/sct_neopixel |
||||
[submodule "lib/FreeRTOS-Kernel"] |
||||
path = lib/FreeRTOS-Kernel |
||||
url = https://github.com/FreeRTOS/FreeRTOS-Kernel.git |
||||
[submodule "lib/CMSIS_5"] |
||||
path = lib/CMSIS_5 |
||||
url = https://github.com/ARM-software/CMSIS_5.git |
||||
[submodule "hw/mcu/silabs/cmsis-dfp-efm32gg12b"] |
||||
path = hw/mcu/silabs/cmsis-dfp-efm32gg12b |
||||
url = https://github.com/cmsis-packs/cmsis-dfp-efm32gg12b |
||||
[submodule "hw/mcu/renesas/rx"] |
||||
path = hw/mcu/renesas/rx |
||||
url = https://github.com/kkitayam/rx_device.git |
||||
[submodule "hw/mcu/nxp/lpcopen"] |
||||
path = hw/mcu/nxp/lpcopen |
||||
url = https://github.com/hathach/nxp_lpcopen.git |
||||
[submodule "hw/mcu/nxp/mcux-sdk"] |
||||
path = hw/mcu/nxp/mcux-sdk |
||||
url = https://github.com/NXPmicro/mcux-sdk.git |
||||
[submodule "hw/mcu/nxp/nxp_sdk"] |
||||
path = hw/mcu/nxp/nxp_sdk |
||||
url = https://github.com/hathach/nxp_sdk.git |
||||
[submodule "hw/mcu/gd/nuclei-sdk"] |
||||
path = hw/mcu/gd/nuclei-sdk |
||||
url = https://github.com/Nuclei-Software/nuclei-sdk.git |
||||
[submodule "hw/mcu/mindmotion/mm32sdk"] |
||||
path = hw/mcu/mindmotion/mm32sdk |
||||
url = https://github.com/hathach/mm32sdk.git |
||||
@ -0,0 +1,18 @@ |
||||
# .readthedocs.yaml |
||||
# Read the Docs configuration file |
||||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details |
||||
|
||||
version: 2 |
||||
|
||||
sphinx: |
||||
configuration: docs/conf.py |
||||
|
||||
python: |
||||
version: 3.8 |
||||
install: |
||||
- requirements: docs/requirements.txt |
||||
|
||||
submodules: |
||||
include: [] |
||||
recursive: false |
||||
|
||||
@ -0,0 +1,88 @@ |
||||
*************** |
||||
Code of Conduct |
||||
*************** |
||||
|
||||
Our Pledge |
||||
---------- |
||||
|
||||
In the interest of fostering an open and welcoming environment, we as |
||||
contributors and maintainers pledge to making participation in our |
||||
project and our community a harassment-free experience for everyone, |
||||
regardless of age, body size, disability, ethnicity, sex |
||||
characteristics, gender identity and expression, level of experience, |
||||
education, socio-economic status, nationality, personal appearance, |
||||
race, religion, or sexual identity and orientation. |
||||
|
||||
Our Standards |
||||
------------- |
||||
|
||||
Examples of behavior that contributes to creating a positive environment |
||||
include: |
||||
|
||||
- Using welcoming and inclusive language |
||||
- Being respectful of differing viewpoints and experiences |
||||
- Gracefully accepting constructive criticism |
||||
- Focusing on what is best for the community |
||||
- Showing empathy towards other community members |
||||
|
||||
Examples of unacceptable behavior by participants include: |
||||
|
||||
- The use of sexualized language or imagery and unwelcome sexual |
||||
attention or advances |
||||
- Trolling, insulting/derogatory comments, and personal or political |
||||
attacks |
||||
- Public or private harassment |
||||
- Publishing others' private information, such as a physical or |
||||
electronic address, without explicit permission |
||||
- Other conduct which could reasonably be considered inappropriate in a |
||||
professional setting |
||||
|
||||
Our Responsibilities |
||||
-------------------- |
||||
|
||||
Project maintainers are responsible for clarifying the standards of |
||||
acceptable behavior and are expected to take appropriate and fair |
||||
corrective action in response to any instances of unacceptable behavior. |
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, |
||||
or reject comments, commits, code, wiki edits, issues, and other |
||||
contributions that are not aligned to this Code of Conduct, or to ban |
||||
temporarily or permanently any contributor for other behaviors that they |
||||
deem inappropriate, threatening, offensive, or harmful. |
||||
|
||||
Scope |
||||
----- |
||||
|
||||
This Code of Conduct applies both within project spaces and in public |
||||
spaces when an individual is representing the project or its community. |
||||
Examples of representing a project or community include using an |
||||
official project e-mail address, posting via an official social media |
||||
account, or acting as an appointed representative at an online or |
||||
offline event. Representation of a project may be further defined and |
||||
clarified by project maintainers. |
||||
|
||||
Enforcement |
||||
----------- |
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may |
||||
be reported by contacting the project team at thach@tinyusb.org. All |
||||
complaints will be reviewed and investigated and will result in a |
||||
response that is deemed necessary and appropriate to the circumstances. |
||||
The project team is obligated to maintain confidentiality with regard to |
||||
the reporter of an incident. Further details of specific enforcement |
||||
policies may be posted separately. |
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in |
||||
good faith may face temporary or permanent repercussions as determined |
||||
by other members of the project's leadership. |
||||
|
||||
Attribution |
||||
----------- |
||||
|
||||
This Code of Conduct is adapted from the `Contributor |
||||
Covenant <https://www.contributor-covenant.org>`__, version 1.4, |
||||
available at |
||||
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html |
||||
|
||||
For answers to common questions about this code of conduct, see |
||||
https://www.contributor-covenant.org/faq |
||||
@ -0,0 +1,192 @@ |
||||
************ |
||||
Contributors |
||||
************ |
||||
|
||||
Special thanks to all the people who spent their precious time and effort to help this project so far. |
||||
list contributors and their awesome work for the stack: |
||||
|
||||
Notable contributors |
||||
==================== |
||||
|
||||
(sorted alphabetically) |
||||
|
||||
`Adafruit Team <https://github.com/adafruit>`__ |
||||
----------------------------------------------- |
||||
|
||||
- Main supporter and sponsor for hardware boards and kits |
||||
- Discussion and suggestion for feature and improvement |
||||
- Design the project logo |
||||
|
||||
|
||||
`Ha Thach <https://github.com/hathach>`__ |
||||
----------------------------------------- |
||||
|
||||
- *Author and maintainer* |
||||
- Most features development |
||||
|
||||
|
||||
`Hristo Gochkov <https://github.com/me-no-dev>`__ |
||||
------------------------------------------------- |
||||
|
||||
- Improve ESP32s2 DCD |
||||
|
||||
|
||||
`Jacob Berg Potter <https://github.com/j4cbo>`__ |
||||
------------------------------------------------ |
||||
|
||||
- Add new class driver for network CDC-NCM |
||||
|
||||
|
||||
`Jan Dümpelmann <https://github.com/duempel>`__ |
||||
----------------------------------------------- |
||||
|
||||
- Improve transfer performance for Synopsys DCD for STM32 MCUs |
||||
|
||||
|
||||
`Jeff Epler <https://github.com/jepler>`__ |
||||
------------------------------------------ |
||||
|
||||
- Improve MIDI class driver |
||||
|
||||
|
||||
`Jerzy Kasenberg <https://github.com/kasjer>`__ |
||||
----------------------------------------------- |
||||
|
||||
- Add new DCD port for Dialog DA1469x |
||||
- Add new class driver for Bluetooth HCI |
||||
- Add ISO transfer for STM32 Synopsys, Nordic nRF, Dialog DA1469x |
||||
- Improve Audio driver and add uac2\_headset example |
||||
- Improve STM32 Synopsys DCD with various PRs |
||||
|
||||
|
||||
`J McCarthy <https://github.com/xmos-jmccarthy>`__ |
||||
-------------------------------------------------- |
||||
|
||||
- Add new DFU 1.1 class driver |
||||
- Add new example for dfu |
||||
|
||||
|
||||
`Kamil Tomaszewski <https://github.com/kamtom480>`__ |
||||
---------------------------------------------------- |
||||
|
||||
- Add new DCD port for Sony CXD56 (spresnese board) |
||||
|
||||
|
||||
`Kay Sievers <https://github.com/kaysievers>`__ |
||||
----------------------------------------------- |
||||
|
||||
- Improve MIDI driver with packet API |
||||
|
||||
|
||||
`Koji KITAYAMA <https://github.com/kkitayam>`__ |
||||
----------------------------------------------- |
||||
|
||||
- Add new DCD port for NXP Kinetis KL25 |
||||
- Add new DCD port for Renesas RX family (RX600, RX700 ..) with GR-CITRUS, RX65n target board |
||||
- Add new class driver for USB Video Class (UVC 1.5) |
||||
|
||||
|
||||
`Nathan Conrad <https://github.com/pigrew>`__ |
||||
--------------------------------------------- |
||||
|
||||
- Add new DCD port for STM32 fsdev Fullspeed device for STM32 L0, |
||||
F0, F1, F3 etc ... |
||||
- Add new class driver for USB Test and Measurement Class (USBTMC) |
||||
- Various improvement e.g Zero-length packet, Lint setup |
||||
- Board support for STM32F070RB Nucleo, STM32F303 Discovery |
||||
|
||||
|
||||
`Peter Lawrence <https://github.com/majbthrd>`__ |
||||
------------------------------------------------ |
||||
|
||||
- Add new DCD port for Nuvoton NUC 120, 121, 125, 126, 505 |
||||
- Add new class driver for network RNDIS, CDC-ECM |
||||
- Enhance CDC-NCM network driver to compatible with RNDIS/ECM |
||||
- Add *net\_lwip\_webserver* example for demonstration of usbnet with lwip |
||||
- Board support for NuTiny NUC120, NUC121s, NUC125s, NUC126V, NUC505 |
||||
- Improve multiple cdc interfaces API & add cdc\_dual\_ports example |
||||
|
||||
|
||||
`Rafael Silva <https://github.com/perigoso>`__ |
||||
---------------------------------------------- |
||||
|
||||
- Add new DCD port for Silabs EFM32GG12 with SLTB009A board |
||||
- Rewrite documentation in rst and setup for readthedocs |
||||
|
||||
|
||||
`Raspberry Pi Team <https://github.com/raspberrypi>`__ |
||||
------------------------------------------------------ |
||||
|
||||
- Add new DCD port for Raspberry Pi RP2040 |
||||
- Add new HCD port for Raspberry Pi RP2040 |
||||
|
||||
|
||||
`Reinhard Panhuber <https://github.com/PanRe>`__ |
||||
------------------------------------------------ |
||||
|
||||
- Add new class driver for USB Audio Class 2.0 (UAC2) |
||||
- Rework tu\_fifo with unmasked pointer, add DMA support, and constant address support |
||||
- Add new DCD/USBD edpt\_xfer\_fifo() API for optimizing endpoint transfer |
||||
- Add and greatly improve Isochronous transfer |
||||
- Add new audio examples: audio\_test and audio\_4\_channel\_mic |
||||
|
||||
|
||||
`Scott Shawcroft <https://github.com/tannewt>`__ |
||||
------------------------------------------------ |
||||
|
||||
- Add new DCD port for SAMD21 and SAMD51 |
||||
- Add new class driver for Musical Instrument Digital Interface (MIDI) |
||||
- Improve USBD control transfer, MSC, CDC class driver |
||||
- Board support for Metro M0 & M4 express |
||||
- Write the excellent porting.md documentation |
||||
- Add initial Makefile |
||||
|
||||
`Sean Cross <https://github.com/xobs>`__ |
||||
---------------------------------------- |
||||
|
||||
- Add new DCD port for ValentyUSB eptri (fomu board) |
||||
|
||||
|
||||
`Sylvain "tnt" Munaut <https://github.com/smunaut>`__ |
||||
----------------------------------------------------- |
||||
|
||||
- Add new class driver for DFU Runtime |
||||
|
||||
|
||||
`Timon Skerutsch <https://github.com/PTS93>`__ |
||||
---------------------------------------------- |
||||
|
||||
- Add hid\_test.js script and extensive test for bi-directional raw HID |
||||
|
||||
|
||||
`Tod E. Kurt <https://github.com/todbot>`__ |
||||
------------------------------------------- |
||||
|
||||
- Add hid\_test.js script and extensive test for bi-directional raw HID |
||||
|
||||
|
||||
`Uwe Bonnes <https://github.com/UweBonnes>`__ |
||||
--------------------------------------------- |
||||
|
||||
- Improve STM32 Synopsys highspeed DCD |
||||
|
||||
|
||||
`William D. Jones <https://github.com/cr1901>`__ |
||||
------------------------------------------------ |
||||
|
||||
- Add new DCD port for Synopsys DesignWare for STM32 L4, F2, F4, |
||||
F7, H7 etc ... |
||||
- Add new DCD port for TI MSP430 |
||||
- Board support for STM32F407 Discovery, STM32H743 Nucleo, pyboard v1.1, msp\_exp430f5529lp etc ... |
||||
|
||||
|
||||
`Zixun Li <https://github.com/HiFiPhile>`__ |
||||
------------------------------------------- |
||||
|
||||
- Add new DCD port for Microchip SAMx7x |
||||
- Add IAR compiler support |
||||
- Improve UAC2, CDC, DFU class driver |
||||
|
||||
|
||||
`Full contributors list <https://github.com/hathach/tinyusb/contributors>`__ |
||||
============================================================================ |
||||
@ -0,0 +1,21 @@ |
||||
The MIT License (MIT) |
||||
|
||||
Copyright (c) 2018, hathach (tinyusb.org) |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to deal |
||||
in the Software without restriction, including without limitation the rights |
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in |
||||
all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
THE SOFTWARE. |
||||
|
After Width: | Height: | Size: 2.6 KiB |
|
After Width: | Height: | Size: 84 KiB |
@ -0,0 +1,42 @@ |
||||
# 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', |
||||
'sphinxemoji.sphinxemoji', |
||||
] |
||||
|
||||
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 |
||||
@ -0,0 +1,88 @@ |
||||
*************** |
||||
Code of Conduct |
||||
*************** |
||||
|
||||
Our Pledge |
||||
---------- |
||||
|
||||
In the interest of fostering an open and welcoming environment, we as |
||||
contributors and maintainers pledge to making participation in our |
||||
project and our community a harassment-free experience for everyone, |
||||
regardless of age, body size, disability, ethnicity, sex |
||||
characteristics, gender identity and expression, level of experience, |
||||
education, socio-economic status, nationality, personal appearance, |
||||
race, religion, or sexual identity and orientation. |
||||
|
||||
Our Standards |
||||
------------- |
||||
|
||||
Examples of behavior that contributes to creating a positive environment |
||||
include: |
||||
|
||||
- Using welcoming and inclusive language |
||||
- Being respectful of differing viewpoints and experiences |
||||
- Gracefully accepting constructive criticism |
||||
- Focusing on what is best for the community |
||||
- Showing empathy towards other community members |
||||
|
||||
Examples of unacceptable behavior by participants include: |
||||
|
||||
- The use of sexualized language or imagery and unwelcome sexual |
||||
attention or advances |
||||
- Trolling, insulting/derogatory comments, and personal or political |
||||
attacks |
||||
- Public or private harassment |
||||
- Publishing others' private information, such as a physical or |
||||
electronic address, without explicit permission |
||||
- Other conduct which could reasonably be considered inappropriate in a |
||||
professional setting |
||||
|
||||
Our Responsibilities |
||||
-------------------- |
||||
|
||||
Project maintainers are responsible for clarifying the standards of |
||||
acceptable behavior and are expected to take appropriate and fair |
||||
corrective action in response to any instances of unacceptable behavior. |
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, |
||||
or reject comments, commits, code, wiki edits, issues, and other |
||||
contributions that are not aligned to this Code of Conduct, or to ban |
||||
temporarily or permanently any contributor for other behaviors that they |
||||
deem inappropriate, threatening, offensive, or harmful. |
||||
|
||||
Scope |
||||
----- |
||||
|
||||
This Code of Conduct applies both within project spaces and in public |
||||
spaces when an individual is representing the project or its community. |
||||
Examples of representing a project or community include using an |
||||
official project e-mail address, posting via an official social media |
||||
account, or acting as an appointed representative at an online or |
||||
offline event. Representation of a project may be further defined and |
||||
clarified by project maintainers. |
||||
|
||||
Enforcement |
||||
----------- |
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may |
||||
be reported by contacting the project team at thach@tinyusb.org. All |
||||
complaints will be reviewed and investigated and will result in a |
||||
response that is deemed necessary and appropriate to the circumstances. |
||||
The project team is obligated to maintain confidentiality with regard to |
||||
the reporter of an incident. Further details of specific enforcement |
||||
policies may be posted separately. |
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in |
||||
good faith may face temporary or permanent repercussions as determined |
||||
by other members of the project's leadership. |
||||
|
||||
Attribution |
||||
----------- |
||||
|
||||
This Code of Conduct is adapted from the `Contributor |
||||
Covenant <https://www.contributor-covenant.org>`__, version 1.4, |
||||
available at |
||||
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html |
||||
|
||||
For answers to common questions about this code of conduct, see |
||||
https://www.contributor-covenant.org/faq |
||||
@ -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 throught 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 |
||||
@ -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 guarenteed 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 thats OK, the ``dcd_xfer_complete`` may not be setting up the next transaction correctly. |
||||
@ -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> |
||||
@ -0,0 +1,621 @@ |
||||
********* |
||||
Changelog |
||||
********* |
||||
|
||||
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). Howver device EPOUT is still single bufferred due to techinical issue with short packet |
||||
|
||||
Device Stack |
||||
------------ |
||||
|
||||
USBD |
||||
^^^^ |
||||
|
||||
- Better support big endian mcu |
||||
- Add tuh_inited() and tud_inited(), will separte 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 bufferred to fix E4 errata and boost performance |
||||
- Lots of rp2040 update and enhancment |
||||
|
||||
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 |
||||
- Sepearate 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 noticable changes |
||||
|
||||
USB Host Driver (USBH) |
||||
---------------------- |
||||
|
||||
- No noticable 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 ambigous 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 hanlding 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 |
||||
@ -0,0 +1,192 @@ |
||||
************ |
||||
Contributors |
||||
************ |
||||
|
||||
Special thanks to all the people who spent their precious time and effort to help this project so far. |
||||
list contributors and their awesome work for the stack: |
||||
|
||||
Notable contributors |
||||
==================== |
||||
|
||||
(sorted alphabetically) |
||||
|
||||
`Adafruit Team <https://github.com/adafruit>`__ |
||||
----------------------------------------------- |
||||
|
||||
- Main supporter and sponsor for hardware boards and kits |
||||
- Discussion and suggestion for feature and improvement |
||||
- Design the project logo |
||||
|
||||
|
||||
`Ha Thach <https://github.com/hathach>`__ |
||||
----------------------------------------- |
||||
|
||||
- *Author and maintainer* |
||||
- Most features development |
||||
|
||||
|
||||
`Hristo Gochkov <https://github.com/me-no-dev>`__ |
||||
------------------------------------------------- |
||||
|
||||
- Improve ESP32s2 DCD |
||||
|
||||
|
||||
`Jacob Berg Potter <https://github.com/j4cbo>`__ |
||||
------------------------------------------------ |
||||
|
||||
- Add new class driver for network CDC-NCM |
||||
|
||||
|
||||
`Jan Dümpelmann <https://github.com/duempel>`__ |
||||
----------------------------------------------- |
||||
|
||||
- Improve transfer performance for Synopsys DCD for STM32 MCUs |
||||
|
||||
|
||||
`Jeff Epler <https://github.com/jepler>`__ |
||||
------------------------------------------ |
||||
|
||||
- Improve MIDI class driver |
||||
|
||||
|
||||
`Jerzy Kasenberg <https://github.com/kasjer>`__ |
||||
----------------------------------------------- |
||||
|
||||
- Add new DCD port for Dialog DA1469x |
||||
- Add new class driver for Bluetooth HCI |
||||
- Add ISO transfer for STM32 Synopsys, Nordic nRF, Dialog DA1469x |
||||
- Improve Audio driver and add uac2\_headset example |
||||
- Improve STM32 Synopsys DCD with various PRs |
||||
|
||||
|
||||
`J McCarthy <https://github.com/xmos-jmccarthy>`__ |
||||
-------------------------------------------------- |
||||
|
||||
- Add new DFU 1.1 class driver |
||||
- Add new example for dfu |
||||
|
||||
|
||||
`Kamil Tomaszewski <https://github.com/kamtom480>`__ |
||||
---------------------------------------------------- |
||||
|
||||
- Add new DCD port for Sony CXD56 (spresnese board) |
||||
|
||||
|
||||
`Kay Sievers <https://github.com/kaysievers>`__ |
||||
----------------------------------------------- |
||||
|
||||
- Improve MIDI driver with packet API |
||||
|
||||
|
||||
`Koji KITAYAMA <https://github.com/kkitayam>`__ |
||||
----------------------------------------------- |
||||
|
||||
- Add new DCD port for NXP Kinetis KL25 |
||||
- Add new DCD port for Renesas RX family (RX600, RX700 ..) with GR-CITRUS, RX65n target board |
||||
- Add new class driver for USB Video Class (UVC 1.5) |
||||
|
||||
|
||||
`Nathan Conrad <https://github.com/pigrew>`__ |
||||
--------------------------------------------- |
||||
|
||||
- Add new DCD port for STM32 fsdev Fullspeed device for STM32 L0, |
||||
F0, F1, F3 etc ... |
||||
- Add new class driver for USB Test and Measurement Class (USBTMC) |
||||
- Various improvement e.g Zero-length packet, Lint setup |
||||
- Board support for STM32F070RB Nucleo, STM32F303 Discovery |
||||
|
||||
|
||||
`Peter Lawrence <https://github.com/majbthrd>`__ |
||||
------------------------------------------------ |
||||
|
||||
- Add new DCD port for Nuvoton NUC 120, 121, 125, 126, 505 |
||||
- Add new class driver for network RNDIS, CDC-ECM |
||||
- Enhance CDC-NCM network driver to compatible with RNDIS/ECM |
||||
- Add *net\_lwip\_webserver* example for demonstration of usbnet with lwip |
||||
- Board support for NuTiny NUC120, NUC121s, NUC125s, NUC126V, NUC505 |
||||
- Improve multiple cdc interfaces API & add cdc\_dual\_ports example |
||||
|
||||
|
||||
`Rafael Silva <https://github.com/perigoso>`__ |
||||
---------------------------------------------- |
||||
|
||||
- Add new DCD port for Silabs EFM32GG12 with SLTB009A board |
||||
- Rewrite documentation in rst and setup for readthedocs |
||||
|
||||
|
||||
`Raspberry Pi Team <https://github.com/raspberrypi>`__ |
||||
------------------------------------------------------ |
||||
|
||||
- Add new DCD port for Raspberry Pi RP2040 |
||||
- Add new HCD port for Raspberry Pi RP2040 |
||||
|
||||
|
||||
`Reinhard Panhuber <https://github.com/PanRe>`__ |
||||
------------------------------------------------ |
||||
|
||||
- Add new class driver for USB Audio Class 2.0 (UAC2) |
||||
- Rework tu\_fifo with unmasked pointer, add DMA support, and constant address support |
||||
- Add new DCD/USBD edpt\_xfer\_fifo() API for optimizing endpoint transfer |
||||
- Add and greatly improve Isochronous transfer |
||||
- Add new audio examples: audio\_test and audio\_4\_channel\_mic |
||||
|
||||
|
||||
`Scott Shawcroft <https://github.com/tannewt>`__ |
||||
------------------------------------------------ |
||||
|
||||
- Add new DCD port for SAMD21 and SAMD51 |
||||
- Add new class driver for Musical Instrument Digital Interface (MIDI) |
||||
- Improve USBD control transfer, MSC, CDC class driver |
||||
- Board support for Metro M0 & M4 express |
||||
- Write the excellent porting.md documentation |
||||
- Add initial Makefile |
||||
|
||||
`Sean Cross <https://github.com/xobs>`__ |
||||
---------------------------------------- |
||||
|
||||
- Add new DCD port for ValentyUSB eptri (fomu board) |
||||
|
||||
|
||||
`Sylvain "tnt" Munaut <https://github.com/smunaut>`__ |
||||
----------------------------------------------------- |
||||
|
||||
- Add new class driver for DFU Runtime |
||||
|
||||
|
||||
`Timon Skerutsch <https://github.com/PTS93>`__ |
||||
---------------------------------------------- |
||||
|
||||
- Add hid\_test.js script and extensive test for bi-directional raw HID |
||||
|
||||
|
||||
`Tod E. Kurt <https://github.com/todbot>`__ |
||||
------------------------------------------- |
||||
|
||||
- Add hid\_test.js script and extensive test for bi-directional raw HID |
||||
|
||||
|
||||
`Uwe Bonnes <https://github.com/UweBonnes>`__ |
||||
--------------------------------------------- |
||||
|
||||
- Improve STM32 Synopsys highspeed DCD |
||||
|
||||
|
||||
`William D. Jones <https://github.com/cr1901>`__ |
||||
------------------------------------------------ |
||||
|
||||
- Add new DCD port for Synopsys DesignWare for STM32 L4, F2, F4, |
||||
F7, H7 etc ... |
||||
- Add new DCD port for TI MSP430 |
||||
- Board support for STM32F407 Discovery, STM32H743 Nucleo, pyboard v1.1, msp\_exp430f5529lp etc ... |
||||
|
||||
|
||||
`Zixun Li <https://github.com/HiFiPhile>`__ |
||||
------------------------------------------- |
||||
|
||||
- Add new DCD port for Microchip SAMx7x |
||||
- Add IAR compiler support |
||||
- Improve UAC2, CDC, DFU class driver |
||||
|
||||
|
||||
`Full contributors list <https://github.com/hathach/tinyusb/contributors>`__ |
||||
============================================================================ |
||||
@ -0,0 +1,13 @@ |
||||
**** |
||||
Info |
||||
**** |
||||
|
||||
Index |
||||
===== |
||||
|
||||
.. toctree:: |
||||
:maxdepth: 2 |
||||
|
||||
uses |
||||
changelog |
||||
contributors |
||||
@ -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>`__ |
||||
@ -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``. |
||||
@ -0,0 +1,198 @@ |
||||
*************** |
||||
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 <boards.md>`_. 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 |
||||
|
||||
In addition, MCU driver submodule is also needed to provide low-level MCU peripheral's driver. Luckily, it will be fetched if needed when you run the ``make`` to build your board. |
||||
|
||||
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. |
||||
|
||||
Build |
||||
^^^^^ |
||||
|
||||
To build example, first change directory to an example folder. |
||||
|
||||
.. code-block:: |
||||
|
||||
$ cd examples/device/cdc_msc |
||||
|
||||
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). |
||||
|
||||
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` |
||||
@ -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 |
||||
@ -0,0 +1,344 @@ |
||||
***************** |
||||
Supported Devices |
||||
***************** |
||||
|
||||
|
||||
Supported MCUs |
||||
============== |
||||
|
||||
.. admonition:: Warning |
||||
:class: warning |
||||
|
||||
This table is a WIP! the data is not correct, tho if a device is listed, it likely works as a usb full speed device at the least. |
||||
|
||||
+--------------+--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| Manufacturer | Family | Device | Host | FS | HS | Known Issues | |
||||
+==============+====================+===================+====================+===================+===================+==============+ |
||||
| Dialog | DA1469x | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
+--------------+--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| Espressif | ESP32-S2 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | ESP32-S3 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
+--------------+--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| MicroChip | SAMD11 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | SAMD21 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | SAMD51 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | SAME5x | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | SAMG55 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | SAML21 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | SAML22 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | SAME70,S70,V70,V71 | |:green_square:| | |:red_square:| | |:green_square:| | |:green_square:| | | |
||||
+--------------+--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| NordicSemi | nRF52833 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | nRF52840 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
+--------------+--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| Nuvoton | NUC120 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | NUC121/NUC125 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | NUC126 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | NUC505 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
+--------------+-------+------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| NXP | iMX | RT1011 | |:green_square:| | |:yellow_square:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | RT1015 | |:green_square:| | |:yellow_square:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | RT1021 | |:green_square:| | |:yellow_square:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | RT1052 | |:green_square:| | |:yellow_square:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | RT1062 | |:green_square:| | |:yellow_square:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | RT1064 | |:green_square:| | |:yellow_square:| | |:green_square:| | |:x:| | | |
||||
| +-------+------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | Kinetis KL25 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| +-------+------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | LPC | 11u | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | 13 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | 15 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | 17 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | 18 | | |:yellow_square:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | 40 | | |:x:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | 43 | |:green_square:| | |:yellow_square:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | 51u | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | 54 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | 55 | |:green_square:| | |:x:| | |:green_square:| | | | |
||||
+--------------+-------+------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| Raspberry Pi | RP2040 | |:green_square:| | |:x:| | |:green_square:| | | | |
||||
+--------------+--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| Renesas | RX63N | |:green_square:| | | |:green_square:| | |:x:| | | |
||||
| +--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | RX65N | |:green_square:| | | |:green_square:| | |:x:| | | |
||||
+--------------+--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| Silabs | EFM32GG12 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | #750 | |
||||
+--------------+--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| Sony | CXD56 | |:green_square:| | |:x:| | |:green_square:| | |:x:| | | |
||||
+--------------+-------+------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| ST | STM32 | L0 | |:green_square:| | | |:green_square:| | | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | F0 | |:green_square:| | | |:green_square:| | | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | F1 | |:green_square:| | | |:green_square:| | | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | F2 | |:green_square:| | | |:green_square:| | | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | F3 | |:green_square:| | | |:green_square:| | | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | F4 | |:green_square:| | | |:green_square:| | | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | F7 | |:green_square:| | | |:green_square:| | | | |
||||
| | +------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| | | H7 | |:green_square:| | | |:green_square:| | |:green_square:| | | |
||||
+--------------+-------+------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| TI | MSP430 | |:green_square:| | | |:green_square:| | | | |
||||
+--------------+--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
| ValentyUSB | eptri | |:green_square:| | | |:green_square:| | | | |
||||
+--------------+--------------------+-------------------+--------------------+-------------------+-------------------+--------------+ |
||||
|
||||
Table Legend |
||||
------------ |
||||
|
||||
================= =================== |
||||
|:x:| Not available |
||||
|:red_square:| Not supported |
||||
|:yellow_square:| WIP/partial support |
||||
|:green_square:| 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): |
||||
|
||||
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 |
||||
- `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>`__ |
||||
|
||||
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>`__ |
||||
|
||||
Kinetis |
||||
^^^^^^^ |
||||
|
||||
- `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>`__ |
||||
|
||||
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 |
||||
-------- |
||||
|
||||
- `Adafruit Feather STM32F405 <https://www.adafruit.com/product/4382>`__ |
||||
- `Micro Python PyBoard v1.1 <https://store.micropython.org/product/PYBv1.1>`__ |
||||
- `STLink-V3 Mini <https://www.st.com/en/development-tools/stlink-v3mini.html>`__ |
||||
- `STM32 L035c8 Discovery <https://www.st.com/en/evaluation-tools/32l0538discovery.html>`__ |
||||
- `STM32 L4R5zi Nucleo <https://www.st.com/en/evaluation-tools/nucleo-l4r5zi.html>`__ |
||||
- `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>`__ |
||||
- `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>`__ |
||||
- `STM32 F207zg Nucleo <https://www.st.com/en/evaluation-tools/nucleo-f207zg.html>`__ |
||||
- `STM32 F303vc Discovery <https://www.st.com/en/evaluation-tools/stm32f3discovery.html>`__ |
||||
- `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 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>`__ |
||||
- `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>`__ |
||||
|
||||
TI |
||||
-- |
||||
|
||||
- `MSP430F5529 USB LaunchPad Evaluation Kit <http://www.ti.com/tool/MSP-EXP430F5529LP>`__ |
||||
|
||||
Tomu |
||||
---- |
||||
|
||||
- `Fomu <https://www.crowdsupply.com/sutajio-kosagi/fomu>`__ |
||||
@ -0,0 +1,4 @@ |
||||
sphinx~=3.0 |
||||
furo>=2020.12.30.b24 |
||||
sphinxemoji>=0.1.8 |
||||
sphinx-autodoc-typehints>=1.10 |
||||
@ -0,0 +1,14 @@ |
||||
# Copy this file to the location of your distribution's udev rules, for example on Ubuntu: |
||||
# sudo cp 99-tinyusb.rules /etc/udev/rules.d/ |
||||
# Then reload udev configuration by executing: |
||||
# sudo udevadm control --reload-rules |
||||
# sudo udevadm trigger |
||||
|
||||
# Check SUBSYSTEM |
||||
SUBSYSTEMS=="hidraw", KERNEL=="hidraw*", MODE="0666", GROUP="dialout" |
||||
|
||||
# Rule applies to all TinyUSB example |
||||
ATTRS{idVendor}=="cafe", MODE="0666", GROUP="dialout" |
||||
|
||||
# Rule to blacklist TinyUSB example from being manipulated by ModemManager. |
||||
SUBSYSTEMS=="usb", ATTRS{idVendor}=="cafe", ENV{ID_MM_DEVICE_IGNORE}="1" |
||||
@ -0,0 +1,28 @@ |
||||
cmake_minimum_required(VERSION 3.5) |
||||
|
||||
include(${CMAKE_CURRENT_SOURCE_DIR}/../../hw/bsp/family_support.cmake) |
||||
|
||||
project(tinyusb_device_examples) |
||||
family_initialize_project(tinyusb_device_examples ${CMAKE_CURRENT_LIST_DIR}) |
||||
|
||||
# family_add_subdirectory will filter what to actually add based on selected FAMILY |
||||
family_add_subdirectory(audio_4_channel_mic) |
||||
family_add_subdirectory(audio_test) |
||||
family_add_subdirectory(board_test) |
||||
family_add_subdirectory(cdc_dual_ports) |
||||
family_add_subdirectory(cdc_msc) |
||||
family_add_subdirectory(cdc_msc_freertos) |
||||
family_add_subdirectory(dfu) |
||||
family_add_subdirectory(dfu_runtime) |
||||
family_add_subdirectory(dynamic_configuration) |
||||
family_add_subdirectory(hid_composite) |
||||
family_add_subdirectory(hid_composite_freertos) |
||||
family_add_subdirectory(hid_generic_inout) |
||||
family_add_subdirectory(hid_multiple_interface) |
||||
family_add_subdirectory(midi_test) |
||||
family_add_subdirectory(msc_dual_lun) |
||||
family_add_subdirectory(net_lwip_webserver) |
||||
family_add_subdirectory(uac2_headset) |
||||
family_add_subdirectory(usbtmc) |
||||
family_add_subdirectory(video_capture) |
||||
family_add_subdirectory(webusb_serial) |
||||
@ -0,0 +1,28 @@ |
||||
cmake_minimum_required(VERSION 3.5) |
||||
|
||||
include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake) |
||||
|
||||
# gets PROJECT name for the example (e.g. <BOARD>-<DIR_NAME>) |
||||
family_get_project_name(PROJECT ${CMAKE_CURRENT_LIST_DIR}) |
||||
|
||||
project(${PROJECT}) |
||||
|
||||
# Checks this example is valid for the family and initializes the project |
||||
family_initialize_project(${PROJECT} ${CMAKE_CURRENT_LIST_DIR}) |
||||
|
||||
add_executable(${PROJECT}) |
||||
|
||||
# Example source |
||||
target_sources(${PROJECT} PUBLIC |
||||
${CMAKE_CURRENT_SOURCE_DIR}/src/main.c |
||||
${CMAKE_CURRENT_SOURCE_DIR}/src/usb_descriptors.c |
||||
) |
||||
|
||||
# Example include |
||||
target_include_directories(${PROJECT} PUBLIC |
||||
${CMAKE_CURRENT_SOURCE_DIR}/src |
||||
) |
||||
|
||||
# Configure compilation flags and libraries for the example... see the corresponding function |
||||
# in hw/bsp/FAMILY/family.cmake for details. |
||||
family_configure_device_example(${PROJECT}) |
||||
@ -0,0 +1,12 @@ |
||||
include ../../../tools/top.mk |
||||
include ../../make.mk |
||||
|
||||
INC += \
|
||||
src \
|
||||
$(TOP)/hw \
|
||||
|
||||
# Example source
|
||||
EXAMPLE_SOURCE += $(wildcard src/*.c)
|
||||
SRC_C += $(addprefix $(CURRENT_PATH)/, $(EXAMPLE_SOURCE))
|
||||
|
||||
include ../../rules.mk |
||||
@ -0,0 +1,458 @@ |
||||
/*
|
||||
* The MIT License (MIT) |
||||
* |
||||
* Copyright (c) 2020 Reinhard Panhuber |
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
* of this software and associated documentation files (the "Software"), to deal |
||||
* in the Software without restriction, including without limitation the rights |
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
* copies of the Software, and to permit persons to whom the Software is |
||||
* furnished to do so, subject to the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice shall be included in |
||||
* all copies or substantial portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
* THE SOFTWARE. |
||||
* |
||||
*/ |
||||
|
||||
/* plot_audio_samples.py requires following modules:
|
||||
* $ sudo apt install libportaudio |
||||
* $ pip3 install sounddevice matplotlib |
||||
* |
||||
* Then run |
||||
* $ python3 plot_audio_samples.py |
||||
*/ |
||||
|
||||
#include <stdlib.h> |
||||
#include <stdio.h> |
||||
#include <string.h> |
||||
|
||||
#include "bsp/board.h" |
||||
#include "tusb.h" |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// MACRO CONSTANT TYPEDEF PROTYPES
|
||||
//--------------------------------------------------------------------+
|
||||
|
||||
#ifndef AUDIO_SAMPLE_RATE |
||||
#define AUDIO_SAMPLE_RATE 48000 |
||||
#endif |
||||
|
||||
/* Blink pattern
|
||||
* - 250 ms : device not mounted |
||||
* - 1000 ms : device mounted |
||||
* - 2500 ms : device is suspended |
||||
*/ |
||||
enum { |
||||
BLINK_NOT_MOUNTED = 250, |
||||
BLINK_MOUNTED = 1000, |
||||
BLINK_SUSPENDED = 2500, |
||||
}; |
||||
|
||||
static uint32_t blink_interval_ms = BLINK_NOT_MOUNTED; |
||||
|
||||
// Audio controls
|
||||
// Current states
|
||||
bool mute[CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX + 1]; // +1 for master channel 0
|
||||
uint16_t volume[CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX + 1]; // +1 for master channel 0
|
||||
uint32_t sampFreq; |
||||
uint8_t clkValid; |
||||
|
||||
// Range states
|
||||
audio_control_range_2_n_t(1) volumeRng[CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX+1]; // Volume range state
|
||||
audio_control_range_4_n_t(1) sampleFreqRng; // Sample frequency range state
|
||||
|
||||
// Audio test data
|
||||
uint16_t i2s_dummy_buffer[CFG_TUD_AUDIO_FUNC_1_N_TX_SUPP_SW_FIFO][CFG_TUD_AUDIO_FUNC_1_TX_SUPP_SW_FIFO_SZ/2]; // Ensure half word aligned
|
||||
|
||||
void led_blinking_task(void); |
||||
void audio_task(void); |
||||
|
||||
/*------------- MAIN -------------*/ |
||||
int main(void) |
||||
{ |
||||
board_init(); |
||||
|
||||
tusb_init(); |
||||
|
||||
// Init values
|
||||
sampFreq = AUDIO_SAMPLE_RATE; |
||||
clkValid = 1; |
||||
|
||||
sampleFreqRng.wNumSubRanges = 1; |
||||
sampleFreqRng.subrange[0].bMin = AUDIO_SAMPLE_RATE; |
||||
sampleFreqRng.subrange[0].bMax = AUDIO_SAMPLE_RATE; |
||||
sampleFreqRng.subrange[0].bRes = 0; |
||||
|
||||
while (1) |
||||
{ |
||||
tud_task(); // tinyusb device task
|
||||
led_blinking_task(); |
||||
audio_task(); |
||||
} |
||||
|
||||
|
||||
return 0; |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// Device callbacks
|
||||
//--------------------------------------------------------------------+
|
||||
|
||||
// Invoked when device is mounted
|
||||
void tud_mount_cb(void) |
||||
{ |
||||
blink_interval_ms = BLINK_MOUNTED; |
||||
} |
||||
|
||||
// Invoked when device is unmounted
|
||||
void tud_umount_cb(void) |
||||
{ |
||||
blink_interval_ms = BLINK_NOT_MOUNTED; |
||||
} |
||||
|
||||
// Invoked when usb bus is suspended
|
||||
// remote_wakeup_en : if host allow us to perform remote wakeup
|
||||
// Within 7ms, device must draw an average of current less than 2.5 mA from bus
|
||||
void tud_suspend_cb(bool remote_wakeup_en) |
||||
{ |
||||
(void) remote_wakeup_en; |
||||
blink_interval_ms = BLINK_SUSPENDED; |
||||
} |
||||
|
||||
// Invoked when usb bus is resumed
|
||||
void tud_resume_cb(void) |
||||
{ |
||||
blink_interval_ms = BLINK_MOUNTED; |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// AUDIO Task
|
||||
//--------------------------------------------------------------------+
|
||||
|
||||
void audio_task(void) |
||||
{ |
||||
// Yet to be filled - e.g. put meas data into TX FIFOs etc.
|
||||
asm("nop"); |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// Application Callback API Implementations
|
||||
//--------------------------------------------------------------------+
|
||||
|
||||
// Invoked when audio class specific set request received for an EP
|
||||
bool tud_audio_set_req_ep_cb(uint8_t rhport, tusb_control_request_t const * p_request, uint8_t *pBuff) |
||||
{ |
||||
(void) rhport; |
||||
(void) pBuff; |
||||
|
||||
// We do not support any set range requests here, only current value requests
|
||||
TU_VERIFY(p_request->bRequest == AUDIO_CS_REQ_CUR); |
||||
|
||||
// Page 91 in UAC2 specification
|
||||
uint8_t channelNum = TU_U16_LOW(p_request->wValue); |
||||
uint8_t ctrlSel = TU_U16_HIGH(p_request->wValue); |
||||
uint8_t ep = TU_U16_LOW(p_request->wIndex); |
||||
|
||||
(void) channelNum; (void) ctrlSel; (void) ep; |
||||
|
||||
return false; // Yet not implemented
|
||||
} |
||||
|
||||
// Invoked when audio class specific set request received for an interface
|
||||
bool tud_audio_set_req_itf_cb(uint8_t rhport, tusb_control_request_t const * p_request, uint8_t *pBuff) |
||||
{ |
||||
(void) rhport; |
||||
(void) pBuff; |
||||
|
||||
// We do not support any set range requests here, only current value requests
|
||||
TU_VERIFY(p_request->bRequest == AUDIO_CS_REQ_CUR); |
||||
|
||||
// Page 91 in UAC2 specification
|
||||
uint8_t channelNum = TU_U16_LOW(p_request->wValue); |
||||
uint8_t ctrlSel = TU_U16_HIGH(p_request->wValue); |
||||
uint8_t itf = TU_U16_LOW(p_request->wIndex); |
||||
|
||||
(void) channelNum; (void) ctrlSel; (void) itf; |
||||
|
||||
return false; // Yet not implemented
|
||||
} |
||||
|
||||
// Invoked when audio class specific set request received for an entity
|
||||
bool tud_audio_set_req_entity_cb(uint8_t rhport, tusb_control_request_t const * p_request, uint8_t *pBuff) |
||||
{ |
||||
(void) rhport; |
||||
|
||||
// Page 91 in UAC2 specification
|
||||
uint8_t channelNum = TU_U16_LOW(p_request->wValue); |
||||
uint8_t ctrlSel = TU_U16_HIGH(p_request->wValue); |
||||
uint8_t itf = TU_U16_LOW(p_request->wIndex); |
||||
uint8_t entityID = TU_U16_HIGH(p_request->wIndex); |
||||
|
||||
(void) itf; |
||||
|
||||
// We do not support any set range requests here, only current value requests
|
||||
TU_VERIFY(p_request->bRequest == AUDIO_CS_REQ_CUR); |
||||
|
||||
// If request is for our feature unit
|
||||
if ( entityID == 2 ) |
||||
{ |
||||
switch ( ctrlSel ) |
||||
{ |
||||
case AUDIO_FU_CTRL_MUTE: |
||||
// Request uses format layout 1
|
||||
TU_VERIFY(p_request->wLength == sizeof(audio_control_cur_1_t)); |
||||
|
||||
mute[channelNum] = ((audio_control_cur_1_t*) pBuff)->bCur; |
||||
|
||||
TU_LOG2(" Set Mute: %d of channel: %u\r\n", mute[channelNum], channelNum); |
||||
return true; |
||||
|
||||
case AUDIO_FU_CTRL_VOLUME: |
||||
// Request uses format layout 2
|
||||
TU_VERIFY(p_request->wLength == sizeof(audio_control_cur_2_t)); |
||||
|
||||
volume[channelNum] = ((audio_control_cur_2_t*) pBuff)->bCur; |
||||
|
||||
TU_LOG2(" Set Volume: %d dB of channel: %u\r\n", volume[channelNum], channelNum); |
||||
return true; |
||||
|
||||
// Unknown/Unsupported control
|
||||
default: |
||||
TU_BREAKPOINT(); |
||||
return false; |
||||
} |
||||
} |
||||
return false; // Yet not implemented
|
||||
} |
||||
|
||||
// Invoked when audio class specific get request received for an EP
|
||||
bool tud_audio_get_req_ep_cb(uint8_t rhport, tusb_control_request_t const * p_request) |
||||
{ |
||||
(void) rhport; |
||||
|
||||
// Page 91 in UAC2 specification
|
||||
uint8_t channelNum = TU_U16_LOW(p_request->wValue); |
||||
uint8_t ctrlSel = TU_U16_HIGH(p_request->wValue); |
||||
uint8_t ep = TU_U16_LOW(p_request->wIndex); |
||||
|
||||
(void) channelNum; (void) ctrlSel; (void) ep; |
||||
|
||||
// return tud_control_xfer(rhport, p_request, &tmp, 1);
|
||||
|
||||
return false; // Yet not implemented
|
||||
} |
||||
|
||||
// Invoked when audio class specific get request received for an interface
|
||||
bool tud_audio_get_req_itf_cb(uint8_t rhport, tusb_control_request_t const * p_request) |
||||
{ |
||||
(void) rhport; |
||||
|
||||
// Page 91 in UAC2 specification
|
||||
uint8_t channelNum = TU_U16_LOW(p_request->wValue); |
||||
uint8_t ctrlSel = TU_U16_HIGH(p_request->wValue); |
||||
uint8_t itf = TU_U16_LOW(p_request->wIndex); |
||||
|
||||
(void) channelNum; (void) ctrlSel; (void) itf; |
||||
|
||||
return false; // Yet not implemented
|
||||
} |
||||
|
||||
// Invoked when audio class specific get request received for an entity
|
||||
bool tud_audio_get_req_entity_cb(uint8_t rhport, tusb_control_request_t const * p_request) |
||||
{ |
||||
(void) rhport; |
||||
|
||||
// Page 91 in UAC2 specification
|
||||
uint8_t channelNum = TU_U16_LOW(p_request->wValue); |
||||
uint8_t ctrlSel = TU_U16_HIGH(p_request->wValue); |
||||
// uint8_t itf = TU_U16_LOW(p_request->wIndex); // Since we have only one audio function implemented, we do not need the itf value
|
||||
uint8_t entityID = TU_U16_HIGH(p_request->wIndex); |
||||
|
||||
// Input terminal (Microphone input)
|
||||
if (entityID == 1) |
||||
{ |
||||
switch ( ctrlSel ) |
||||
{ |
||||
case AUDIO_TE_CTRL_CONNECTOR: |
||||
{ |
||||
// The terminal connector control only has a get request with only the CUR attribute.
|
||||
audio_desc_channel_cluster_t ret; |
||||
|
||||
// Those are dummy values for now
|
||||
ret.bNrChannels = 1; |
||||
ret.bmChannelConfig = 0; |
||||
ret.iChannelNames = 0; |
||||
|
||||
TU_LOG2(" Get terminal connector\r\n"); |
||||
|
||||
return tud_audio_buffer_and_schedule_control_xfer(rhport, p_request, (void*) &ret, sizeof(ret)); |
||||
} |
||||
break; |
||||
|
||||
// Unknown/Unsupported control selector
|
||||
default: |
||||
TU_BREAKPOINT(); |
||||
return false; |
||||
} |
||||
} |
||||
|
||||
// Feature unit
|
||||
if (entityID == 2) |
||||
{ |
||||
switch ( ctrlSel ) |
||||
{ |
||||
case AUDIO_FU_CTRL_MUTE: |
||||
// Audio control mute cur parameter block consists of only one byte - we thus can send it right away
|
||||
// There does not exist a range parameter block for mute
|
||||
TU_LOG2(" Get Mute of channel: %u\r\n", channelNum); |
||||
return tud_control_xfer(rhport, p_request, &mute[channelNum], 1); |
||||
|
||||
case AUDIO_FU_CTRL_VOLUME: |
||||
switch ( p_request->bRequest ) |
||||
{ |
||||
case AUDIO_CS_REQ_CUR: |
||||
TU_LOG2(" Get Volume of channel: %u\r\n", channelNum); |
||||
return tud_control_xfer(rhport, p_request, &volume[channelNum], sizeof(volume[channelNum])); |
||||
|
||||
case AUDIO_CS_REQ_RANGE: |
||||
TU_LOG2(" Get Volume range of channel: %u\r\n", channelNum); |
||||
|
||||
// Copy values - only for testing - better is version below
|
||||
audio_control_range_2_n_t(1) |
||||
ret; |
||||
|
||||
ret.wNumSubRanges = 1; |
||||
ret.subrange[0].bMin = -90; // -90 dB
|
||||
ret.subrange[0].bMax = 90; // +90 dB
|
||||
ret.subrange[0].bRes = 1; // 1 dB steps
|
||||
|
||||
return tud_audio_buffer_and_schedule_control_xfer(rhport, p_request, (void*) &ret, sizeof(ret)); |
||||
|
||||
// Unknown/Unsupported control
|
||||
default: |
||||
TU_BREAKPOINT(); |
||||
return false; |
||||
} |
||||
break; |
||||
|
||||
// Unknown/Unsupported control
|
||||
default: |
||||
TU_BREAKPOINT(); |
||||
return false; |
||||
} |
||||
} |
||||
|
||||
// Clock Source unit
|
||||
if ( entityID == 4 ) |
||||
{ |
||||
switch ( ctrlSel ) |
||||
{ |
||||
case AUDIO_CS_CTRL_SAM_FREQ: |
||||
// channelNum is always zero in this case
|
||||
switch ( p_request->bRequest ) |
||||
{ |
||||
case AUDIO_CS_REQ_CUR: |
||||
TU_LOG2(" Get Sample Freq.\r\n"); |
||||
return tud_control_xfer(rhport, p_request, &sampFreq, sizeof(sampFreq)); |
||||
|
||||
case AUDIO_CS_REQ_RANGE: |
||||
TU_LOG2(" Get Sample Freq. range\r\n"); |
||||
return tud_control_xfer(rhport, p_request, &sampleFreqRng, sizeof(sampleFreqRng)); |
||||
|
||||
// Unknown/Unsupported control
|
||||
default: |
||||
TU_BREAKPOINT(); |
||||
return false; |
||||
} |
||||
break; |
||||
|
||||
case AUDIO_CS_CTRL_CLK_VALID: |
||||
// Only cur attribute exists for this request
|
||||
TU_LOG2(" Get Sample Freq. valid\r\n"); |
||||
return tud_control_xfer(rhport, p_request, &clkValid, sizeof(clkValid)); |
||||
|
||||
// Unknown/Unsupported control
|
||||
default: |
||||
TU_BREAKPOINT(); |
||||
return false; |
||||
} |
||||
} |
||||
|
||||
TU_LOG2(" Unsupported entity: %d\r\n", entityID); |
||||
return false; // Yet not implemented
|
||||
} |
||||
|
||||
bool tud_audio_tx_done_pre_load_cb(uint8_t rhport, uint8_t itf, uint8_t ep_in, uint8_t cur_alt_setting) |
||||
{ |
||||
(void) rhport; |
||||
(void) itf; |
||||
(void) ep_in; |
||||
(void) cur_alt_setting; |
||||
|
||||
for (uint8_t cnt=0; cnt < CFG_TUD_AUDIO_FUNC_1_N_TX_SUPP_SW_FIFO; cnt++) |
||||
{ |
||||
tud_audio_write_support_ff(cnt, i2s_dummy_buffer[cnt], AUDIO_SAMPLE_RATE/1000 * CFG_TUD_AUDIO_FUNC_1_N_BYTES_PER_SAMPLE_TX * CFG_TUD_AUDIO_FUNC_1_CHANNEL_PER_FIFO_TX); |
||||
} |
||||
|
||||
return true; |
||||
} |
||||
|
||||
bool tud_audio_tx_done_post_load_cb(uint8_t rhport, uint16_t n_bytes_copied, uint8_t itf, uint8_t ep_in, uint8_t cur_alt_setting) |
||||
{ |
||||
(void) rhport; |
||||
(void) n_bytes_copied; |
||||
(void) itf; |
||||
(void) ep_in; |
||||
(void) cur_alt_setting; |
||||
|
||||
uint16_t dataVal; |
||||
|
||||
// Generate dummy data
|
||||
for (uint16_t cnt = 0; cnt < CFG_TUD_AUDIO_FUNC_1_N_TX_SUPP_SW_FIFO; cnt++) |
||||
{ |
||||
uint16_t * p_buff = i2s_dummy_buffer[cnt]; // 2 bytes per sample
|
||||
dataVal = 1; |
||||
for (uint16_t cnt2 = 0; cnt2 < AUDIO_SAMPLE_RATE/1000; cnt2++) |
||||
{ |
||||
for (uint8_t cnt3 = 0; cnt3 < CFG_TUD_AUDIO_FUNC_1_CHANNEL_PER_FIFO_TX; cnt3++) |
||||
{ |
||||
*p_buff++ = dataVal; |
||||
} |
||||
dataVal++; |
||||
} |
||||
} |
||||
return true; |
||||
} |
||||
|
||||
bool tud_audio_set_itf_close_EP_cb(uint8_t rhport, tusb_control_request_t const * p_request) |
||||
{ |
||||
(void) rhport; |
||||
(void) p_request; |
||||
|
||||
return true; |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// BLINKING TASK
|
||||
//--------------------------------------------------------------------+
|
||||
void led_blinking_task(void) |
||||
{ |
||||
static uint32_t start_ms = 0; |
||||
static bool led_state = false; |
||||
|
||||
// Blink every interval ms
|
||||
if ( board_millis() - start_ms < blink_interval_ms) return; // not enough time
|
||||
start_ms += blink_interval_ms; |
||||
|
||||
board_led_write(led_state); |
||||
led_state = 1 - led_state; // toggle
|
||||
} |
||||
@ -0,0 +1,34 @@ |
||||
import sounddevice as sd |
||||
import matplotlib.pyplot as plt |
||||
import numpy as np |
||||
import platform |
||||
|
||||
if __name__ == '__main__': |
||||
|
||||
# If you got "ValueError: No input device matching", that is because your PC name example device |
||||
# differently from tested list below. Uncomment the next line to see full list and try to pick correct one |
||||
# print(sd.query_devices()) |
||||
|
||||
fs = 48000 # Sample rate |
||||
duration = 100e-3 # Duration of recording |
||||
|
||||
if platform.system() == 'Windows': |
||||
# WDM-KS is needed since there are more than one MicNode device APIs (at least in Windows) |
||||
device = 'Microphone (MicNode_4_Ch), Windows WDM-KS' |
||||
elif platform.system() == 'Darwin': |
||||
device = 'MicNode_4_Ch' |
||||
else: |
||||
device ='default' |
||||
|
||||
myrecording = sd.rec(int(duration * fs), samplerate=fs, channels=4, dtype='int16', device=device) |
||||
print('Waiting...') |
||||
sd.wait() # Wait until recording is finished |
||||
print('Done!') |
||||
|
||||
time = np.arange(0, duration, 1 / fs) # time vector |
||||
plt.plot(time, myrecording) |
||||
plt.xlabel('Time [s]') |
||||
plt.ylabel('Amplitude') |
||||
plt.title('MicNode 4 Channel') |
||||
plt.show() |
||||
|
||||
@ -0,0 +1,118 @@ |
||||
/*
|
||||
* The MIT License (MIT) |
||||
* |
||||
* Copyright (c) 2019 Ha Thach (tinyusb.org) |
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
* of this software and associated documentation files (the "Software"), to deal |
||||
* in the Software without restriction, including without limitation the rights |
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
* copies of the Software, and to permit persons to whom the Software is |
||||
* furnished to do so, subject to the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice shall be included in |
||||
* all copies or substantial portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
* THE SOFTWARE. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef _TUSB_CONFIG_H_ |
||||
#define _TUSB_CONFIG_H_ |
||||
|
||||
#ifdef __cplusplus |
||||
extern "C" { |
||||
#endif |
||||
|
||||
//--------------------------------------------------------------------
|
||||
// COMMON CONFIGURATION
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
// defined by compiler flags for flexibility
|
||||
#ifndef CFG_TUSB_MCU |
||||
#error CFG_TUSB_MCU must be defined |
||||
#endif |
||||
|
||||
#if CFG_TUSB_MCU == OPT_MCU_LPC43XX || CFG_TUSB_MCU == OPT_MCU_LPC18XX || CFG_TUSB_MCU == OPT_MCU_MIMXRT10XX |
||||
#define CFG_TUSB_RHPORT0_MODE (OPT_MODE_DEVICE | OPT_MODE_HIGH_SPEED) |
||||
#else |
||||
#define CFG_TUSB_RHPORT0_MODE OPT_MODE_DEVICE |
||||
#endif |
||||
|
||||
#ifndef CFG_TUSB_OS |
||||
#define CFG_TUSB_OS OPT_OS_NONE |
||||
#endif |
||||
|
||||
#ifndef CFG_TUSB_DEBUG |
||||
#define CFG_TUSB_DEBUG 0 |
||||
#endif |
||||
|
||||
// CFG_TUSB_DEBUG is defined by compiler in DEBUG build
|
||||
// #define CFG_TUSB_DEBUG 0
|
||||
|
||||
/* USB DMA on some MCUs can only access a specific SRAM region with restriction on alignment.
|
||||
* Tinyusb use follows macros to declare transferring memory so that they can be put |
||||
* into those specific section. |
||||
* e.g |
||||
* - CFG_TUSB_MEM SECTION : __attribute__ (( section(".usb_ram") )) |
||||
* - CFG_TUSB_MEM_ALIGN : __attribute__ ((aligned(4))) |
||||
*/ |
||||
#ifndef CFG_TUSB_MEM_SECTION |
||||
#define CFG_TUSB_MEM_SECTION |
||||
#endif |
||||
|
||||
#ifndef CFG_TUSB_MEM_ALIGN |
||||
#define CFG_TUSB_MEM_ALIGN __attribute__ ((aligned(4))) |
||||
#endif |
||||
|
||||
//--------------------------------------------------------------------
|
||||
// DEVICE CONFIGURATION
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
#ifndef CFG_TUD_ENDPOINT0_SIZE |
||||
#define CFG_TUD_ENDPOINT0_SIZE 64 |
||||
#endif |
||||
|
||||
//------------- CLASS -------------//
|
||||
#define CFG_TUD_CDC 0 |
||||
#define CFG_TUD_MSC 0 |
||||
#define CFG_TUD_HID 0 |
||||
#define CFG_TUD_MIDI 0 |
||||
#define CFG_TUD_AUDIO 1 |
||||
#define CFG_TUD_VENDOR 0 |
||||
|
||||
//--------------------------------------------------------------------
|
||||
// AUDIO CLASS DRIVER CONFIGURATION
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
// Have a look into audio_device.h for all configurations
|
||||
|
||||
#define CFG_TUD_AUDIO_FUNC_1_DESC_LEN TUD_AUDIO_MIC_FOUR_CH_DESC_LEN |
||||
|
||||
#define CFG_TUD_AUDIO_FUNC_1_N_AS_INT 1 |
||||
#define CFG_TUD_AUDIO_FUNC_1_CTRL_BUF_SZ 64 |
||||
|
||||
#define CFG_TUD_AUDIO_ENABLE_EP_IN 1 |
||||
#define CFG_TUD_AUDIO_FUNC_1_N_BYTES_PER_SAMPLE_TX 2 // This value is not required by the driver, it parses this information from the descriptor once the alternate interface is set by the host - we use it for the setup
|
||||
#define CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX 4 // This value is not required by the driver, it parses this information from the descriptor once the alternate interface is set by the host - we use it for the setup
|
||||
#define CFG_TUD_AUDIO_EP_SZ_IN (48 + 1) * CFG_TUD_AUDIO_FUNC_1_N_BYTES_PER_SAMPLE_TX * CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX // 48 Samples (48 kHz) x 2 Bytes/Sample x CFG_TUD_AUDIO_N_CHANNELS_TX Channels - the Windows driver always needs an extra sample per channel of space more, otherwise it complains... found by trial and error
|
||||
#define CFG_TUD_AUDIO_FUNC_1_EP_IN_SZ_MAX CFG_TUD_AUDIO_EP_SZ_IN |
||||
#define CFG_TUD_AUDIO_FUNC_1_EP_IN_SW_BUF_SZ CFG_TUD_AUDIO_EP_SZ_IN |
||||
|
||||
#define CFG_TUD_AUDIO_ENABLE_ENCODING 1 |
||||
#define CFG_TUD_AUDIO_ENABLE_TYPE_I_ENCODING 1 |
||||
#define CFG_TUD_AUDIO_FUNC_1_CHANNEL_PER_FIFO_TX 2 // One I2S stream contains two channels, each stream is saved within one support FIFO - this value is currently fixed, the driver does not support a changing value
|
||||
#define CFG_TUD_AUDIO_FUNC_1_N_TX_SUPP_SW_FIFO (CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX / CFG_TUD_AUDIO_FUNC_1_CHANNEL_PER_FIFO_TX) |
||||
#define CFG_TUD_AUDIO_FUNC_1_TX_SUPP_SW_FIFO_SZ (CFG_TUD_AUDIO_EP_SZ_IN / CFG_TUD_AUDIO_FUNC_1_N_TX_SUPP_SW_FIFO) |
||||
|
||||
#ifdef __cplusplus |
||||
} |
||||
#endif |
||||
|
||||
#endif /* _TUSB_CONFIG_H_ */ |
||||
@ -0,0 +1,165 @@ |
||||
/*
|
||||
* The MIT License (MIT) |
||||
* |
||||
* Copyright (c) 2019 Ha Thach (tinyusb.org) |
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
* of this software and associated documentation files (the "Software"), to deal |
||||
* in the Software without restriction, including without limitation the rights |
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
* copies of the Software, and to permit persons to whom the Software is |
||||
* furnished to do so, subject to the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice shall be included in |
||||
* all copies or substantial portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
* THE SOFTWARE. |
||||
* |
||||
*/ |
||||
|
||||
#include "tusb.h" |
||||
|
||||
/* A combination of interfaces must have a unique product id, since PC will save device driver after the first plug.
|
||||
* Same VID/PID with different interface e.g MSC (first), then CDC (later) will possibly cause system error on PC. |
||||
* |
||||
* Auto ProductID layout's Bitmap: |
||||
* [MSB] AUDIO | MIDI | HID | MSC | CDC [LSB] |
||||
*/ |
||||
#define _PID_MAP(itf, n) ( (CFG_TUD_##itf) << (n) ) |
||||
#define USB_PID (0x4000 | _PID_MAP(CDC, 0) | _PID_MAP(MSC, 1) | _PID_MAP(HID, 2) | \ |
||||
_PID_MAP(MIDI, 3) | _PID_MAP(AUDIO, 4) | _PID_MAP(VENDOR, 5) ) |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// Device Descriptors
|
||||
//--------------------------------------------------------------------+
|
||||
tusb_desc_device_t const desc_device = |
||||
{ |
||||
.bLength = sizeof(tusb_desc_device_t), |
||||
.bDescriptorType = TUSB_DESC_DEVICE, |
||||
.bcdUSB = 0x0200, |
||||
|
||||
// Use Interface Association Descriptor (IAD) for CDC
|
||||
// As required by USB Specs IAD's subclass must be common class (2) and protocol must be IAD (1)
|
||||
.bDeviceClass = TUSB_CLASS_MISC, |
||||
.bDeviceSubClass = MISC_SUBCLASS_COMMON, |
||||
.bDeviceProtocol = MISC_PROTOCOL_IAD, |
||||
.bMaxPacketSize0 = CFG_TUD_ENDPOINT0_SIZE, |
||||
|
||||
.idVendor = 0xCafe, |
||||
.idProduct = USB_PID, |
||||
.bcdDevice = 0x0100, |
||||
|
||||
.iManufacturer = 0x01, |
||||
.iProduct = 0x02, |
||||
.iSerialNumber = 0x03, |
||||
|
||||
.bNumConfigurations = 0x01 |
||||
}; |
||||
|
||||
// Invoked when received GET DEVICE DESCRIPTOR
|
||||
// Application return pointer to descriptor
|
||||
uint8_t const * tud_descriptor_device_cb(void) |
||||
{ |
||||
return (uint8_t const *) &desc_device; |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// Configuration Descriptor
|
||||
//--------------------------------------------------------------------+
|
||||
enum |
||||
{ |
||||
ITF_NUM_AUDIO_CONTROL = 0, |
||||
ITF_NUM_AUDIO_STREAMING, |
||||
ITF_NUM_TOTAL |
||||
}; |
||||
|
||||
#define CONFIG_TOTAL_LEN (TUD_CONFIG_DESC_LEN + CFG_TUD_AUDIO * TUD_AUDIO_MIC_FOUR_CH_DESC_LEN) |
||||
|
||||
#if TU_CHECK_MCU(LPC175X_6X) || TU_CHECK_MCU(LPC177X_8X) || TU_CHECK_MCU(LPC40XX) |
||||
// LPC 17xx and 40xx endpoint type (bulk/interrupt/iso) are fixed by its number
|
||||
// 0 control, 1 In, 2 Bulk, 3 Iso, 4 In etc ...
|
||||
#define EPNUM_AUDIO 0x03 |
||||
|
||||
#elif TU_CHECK_MCU(NRF5X) |
||||
// nRF5x ISO can only be endpoint 8
|
||||
#define EPNUM_AUDIO 0x08 |
||||
|
||||
#else |
||||
#define EPNUM_AUDIO 0x01 |
||||
#endif |
||||
|
||||
uint8_t const desc_configuration[] = |
||||
{ |
||||
// Interface count, string index, total length, attribute, power in mA
|
||||
TUD_CONFIG_DESCRIPTOR(1, ITF_NUM_TOTAL, 0, CONFIG_TOTAL_LEN, 0x00, 100), |
||||
|
||||
// Interface number, string index, EP Out & EP In address, EP size
|
||||
TUD_AUDIO_MIC_FOUR_CH_DESCRIPTOR(/*_itfnum*/ ITF_NUM_AUDIO_CONTROL, /*_stridx*/ 0, /*_nBytesPerSample*/ CFG_TUD_AUDIO_FUNC_1_N_BYTES_PER_SAMPLE_TX, /*_nBitsUsedPerSample*/ CFG_TUD_AUDIO_FUNC_1_N_BYTES_PER_SAMPLE_TX*8, /*_epin*/ 0x80 | EPNUM_AUDIO, /*_epsize*/ CFG_TUD_AUDIO_EP_SZ_IN) |
||||
}; |
||||
|
||||
// Invoked when received GET CONFIGURATION DESCRIPTOR
|
||||
// Application return pointer to descriptor
|
||||
// Descriptor contents must exist long enough for transfer to complete
|
||||
uint8_t const * tud_descriptor_configuration_cb(uint8_t index) |
||||
{ |
||||
(void) index; // for multiple configurations
|
||||
return desc_configuration; |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// String Descriptors
|
||||
//--------------------------------------------------------------------+
|
||||
|
||||
// array of pointer to string descriptors
|
||||
char const* string_desc_arr [] = |
||||
{ |
||||
(const char[]) { 0x09, 0x04 }, // 0: is supported language is English (0x0409)
|
||||
"PaniRCorp", // 1: Manufacturer
|
||||
"MicNode_4_Ch", // 2: Product
|
||||
"123458", // 3: Serials, should use chip ID
|
||||
"UAC2", // 4: Audio Interface
|
||||
}; |
||||
|
||||
static uint16_t _desc_str[32]; |
||||
|
||||
// Invoked when received GET STRING DESCRIPTOR request
|
||||
// Application return pointer to descriptor, whose contents must exist long enough for transfer to complete
|
||||
uint16_t const* tud_descriptor_string_cb(uint8_t index, uint16_t langid) |
||||
{ |
||||
(void) langid; |
||||
|
||||
uint8_t chr_count; |
||||
|
||||
if ( index == 0) |
||||
{ |
||||
memcpy(&_desc_str[1], string_desc_arr[0], 2); |
||||
chr_count = 1; |
||||
}else |
||||
{ |
||||
// Convert ASCII string into UTF-16
|
||||
|
||||
if ( !(index < sizeof(string_desc_arr)/sizeof(string_desc_arr[0])) ) return NULL; |
||||
|
||||
const char* str = string_desc_arr[index]; |
||||
|
||||
// Cap at max char
|
||||
chr_count = strlen(str); |
||||
if ( chr_count > 31 ) chr_count = 31; |
||||
|
||||
for(uint8_t i=0; i<chr_count; i++) |
||||
{ |
||||
_desc_str[1+i] = str[i]; |
||||
} |
||||
} |
||||
|
||||
// first byte is length (including header), second byte is string type
|
||||
_desc_str[0] = (TUSB_DESC_STRING << 8 ) | (2*chr_count + 2); |
||||
|
||||
return _desc_str; |
||||
} |
||||
@ -0,0 +1,28 @@ |
||||
cmake_minimum_required(VERSION 3.5) |
||||
|
||||
include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake) |
||||
|
||||
# gets PROJECT name for the example (e.g. <BOARD>-<DIR_NAME>) |
||||
family_get_project_name(PROJECT ${CMAKE_CURRENT_LIST_DIR}) |
||||
|
||||
project(${PROJECT}) |
||||
|
||||
# Checks this example is valid for the family and initializes the project |
||||
family_initialize_project(${PROJECT} ${CMAKE_CURRENT_LIST_DIR}) |
||||
|
||||
add_executable(${PROJECT}) |
||||
|
||||
# Example source |
||||
target_sources(${PROJECT} PUBLIC |
||||
${CMAKE_CURRENT_SOURCE_DIR}/src/main.c |
||||
${CMAKE_CURRENT_SOURCE_DIR}/src/usb_descriptors.c |
||||
) |
||||
|
||||
# Example include |
||||
target_include_directories(${PROJECT} PUBLIC |
||||
${CMAKE_CURRENT_SOURCE_DIR}/src |
||||
) |
||||
|
||||
# Configure compilation flags and libraries for the example... see the corresponding function |
||||
# in hw/bsp/FAMILY/family.cmake for details. |
||||
family_configure_device_example(${PROJECT}) |
||||
@ -0,0 +1,12 @@ |
||||
include ../../../tools/top.mk |
||||
include ../../make.mk |
||||
|
||||
INC += \
|
||||
src \
|
||||
$(TOP)/hw \
|
||||
|
||||
# Example source
|
||||
EXAMPLE_SOURCE += $(wildcard src/*.c)
|
||||
SRC_C += $(addprefix $(CURRENT_PATH)/, $(EXAMPLE_SOURCE))
|
||||
|
||||
include ../../rules.mk |
||||
@ -0,0 +1,446 @@ |
||||
/*
|
||||
* The MIT License (MIT) |
||||
* |
||||
* Copyright (c) 2020 Reinhard Panhuber |
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
* of this software and associated documentation files (the "Software"), to deal |
||||
* in the Software without restriction, including without limitation the rights |
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
* copies of the Software, and to permit persons to whom the Software is |
||||
* furnished to do so, subject to the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice shall be included in |
||||
* all copies or substantial portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
* THE SOFTWARE. |
||||
* |
||||
*/ |
||||
|
||||
/* plot_audio_samples.py requires following modules:
|
||||
* $ sudo apt install libportaudio |
||||
* $ pip3 install sounddevice matplotlib |
||||
* |
||||
* Then run |
||||
* $ python3 plot_audio_samples.py |
||||
*/ |
||||
|
||||
#include <stdlib.h> |
||||
#include <stdio.h> |
||||
#include <string.h> |
||||
|
||||
#include "bsp/board.h" |
||||
#include "tusb.h" |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// MACRO CONSTANT TYPEDEF PROTYPES
|
||||
//--------------------------------------------------------------------+
|
||||
|
||||
#ifndef AUDIO_SAMPLE_RATE |
||||
#define AUDIO_SAMPLE_RATE 48000 |
||||
#endif |
||||
|
||||
/* Blink pattern
|
||||
* - 250 ms : device not mounted |
||||
* - 1000 ms : device mounted |
||||
* - 2500 ms : device is suspended |
||||
*/ |
||||
enum { |
||||
BLINK_NOT_MOUNTED = 250, |
||||
BLINK_MOUNTED = 1000, |
||||
BLINK_SUSPENDED = 2500, |
||||
}; |
||||
|
||||
static uint32_t blink_interval_ms = BLINK_NOT_MOUNTED; |
||||
|
||||
// Audio controls
|
||||
// Current states
|
||||
bool mute[CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX + 1]; // +1 for master channel 0
|
||||
uint16_t volume[CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX + 1]; // +1 for master channel 0
|
||||
uint32_t sampFreq; |
||||
uint8_t clkValid; |
||||
|
||||
// Range states
|
||||
audio_control_range_2_n_t(1) volumeRng[CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX+1]; // Volume range state
|
||||
audio_control_range_4_n_t(1) sampleFreqRng; // Sample frequency range state
|
||||
|
||||
// Audio test data
|
||||
uint16_t test_buffer_audio[CFG_TUD_AUDIO_EP_SZ_IN/2]; |
||||
uint16_t startVal = 0; |
||||
|
||||
void led_blinking_task(void); |
||||
void audio_task(void); |
||||
|
||||
/*------------- MAIN -------------*/ |
||||
int main(void) |
||||
{ |
||||
board_init(); |
||||
|
||||
tusb_init(); |
||||
|
||||
// Init values
|
||||
sampFreq = AUDIO_SAMPLE_RATE; |
||||
clkValid = 1; |
||||
|
||||
sampleFreqRng.wNumSubRanges = 1; |
||||
sampleFreqRng.subrange[0].bMin = AUDIO_SAMPLE_RATE; |
||||
sampleFreqRng.subrange[0].bMax = AUDIO_SAMPLE_RATE; |
||||
sampleFreqRng.subrange[0].bRes = 0; |
||||
|
||||
while (1) |
||||
{ |
||||
tud_task(); // tinyusb device task
|
||||
led_blinking_task(); |
||||
audio_task(); |
||||
} |
||||
|
||||
|
||||
return 0; |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// Device callbacks
|
||||
//--------------------------------------------------------------------+
|
||||
|
||||
// Invoked when device is mounted
|
||||
void tud_mount_cb(void) |
||||
{ |
||||
blink_interval_ms = BLINK_MOUNTED; |
||||
} |
||||
|
||||
// Invoked when device is unmounted
|
||||
void tud_umount_cb(void) |
||||
{ |
||||
blink_interval_ms = BLINK_NOT_MOUNTED; |
||||
} |
||||
|
||||
// Invoked when usb bus is suspended
|
||||
// remote_wakeup_en : if host allow us to perform remote wakeup
|
||||
// Within 7ms, device must draw an average of current less than 2.5 mA from bus
|
||||
void tud_suspend_cb(bool remote_wakeup_en) |
||||
{ |
||||
(void) remote_wakeup_en; |
||||
blink_interval_ms = BLINK_SUSPENDED; |
||||
} |
||||
|
||||
// Invoked when usb bus is resumed
|
||||
void tud_resume_cb(void) |
||||
{ |
||||
blink_interval_ms = BLINK_MOUNTED; |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// AUDIO Task
|
||||
//--------------------------------------------------------------------+
|
||||
|
||||
void audio_task(void) |
||||
{ |
||||
// Yet to be filled - e.g. put meas data into TX FIFOs etc.
|
||||
asm("nop"); |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// Application Callback API Implementations
|
||||
//--------------------------------------------------------------------+
|
||||
|
||||
// Invoked when audio class specific set request received for an EP
|
||||
bool tud_audio_set_req_ep_cb(uint8_t rhport, tusb_control_request_t const * p_request, uint8_t *pBuff) |
||||
{ |
||||
(void) rhport; |
||||
(void) pBuff; |
||||
|
||||
// We do not support any set range requests here, only current value requests
|
||||
TU_VERIFY(p_request->bRequest == AUDIO_CS_REQ_CUR); |
||||
|
||||
// Page 91 in UAC2 specification
|
||||
uint8_t channelNum = TU_U16_LOW(p_request->wValue); |
||||
uint8_t ctrlSel = TU_U16_HIGH(p_request->wValue); |
||||
uint8_t ep = TU_U16_LOW(p_request->wIndex); |
||||
|
||||
(void) channelNum; (void) ctrlSel; (void) ep; |
||||
|
||||
return false; // Yet not implemented
|
||||
} |
||||
|
||||
// Invoked when audio class specific set request received for an interface
|
||||
bool tud_audio_set_req_itf_cb(uint8_t rhport, tusb_control_request_t const * p_request, uint8_t *pBuff) |
||||
{ |
||||
(void) rhport; |
||||
(void) pBuff; |
||||
|
||||
// We do not support any set range requests here, only current value requests
|
||||
TU_VERIFY(p_request->bRequest == AUDIO_CS_REQ_CUR); |
||||
|
||||
// Page 91 in UAC2 specification
|
||||
uint8_t channelNum = TU_U16_LOW(p_request->wValue); |
||||
uint8_t ctrlSel = TU_U16_HIGH(p_request->wValue); |
||||
uint8_t itf = TU_U16_LOW(p_request->wIndex); |
||||
|
||||
(void) channelNum; (void) ctrlSel; (void) itf; |
||||
|
||||
return false; // Yet not implemented
|
||||
} |
||||
|
||||
// Invoked when audio class specific set request received for an entity
|
||||
bool tud_audio_set_req_entity_cb(uint8_t rhport, tusb_control_request_t const * p_request, uint8_t *pBuff) |
||||
{ |
||||
(void) rhport; |
||||
|
||||
// Page 91 in UAC2 specification
|
||||
uint8_t channelNum = TU_U16_LOW(p_request->wValue); |
||||
uint8_t ctrlSel = TU_U16_HIGH(p_request->wValue); |
||||
uint8_t itf = TU_U16_LOW(p_request->wIndex); |
||||
uint8_t entityID = TU_U16_HIGH(p_request->wIndex); |
||||
|
||||
(void) itf; |
||||
|
||||
// We do not support any set range requests here, only current value requests
|
||||
TU_VERIFY(p_request->bRequest == AUDIO_CS_REQ_CUR); |
||||
|
||||
// If request is for our feature unit
|
||||
if ( entityID == 2 ) |
||||
{ |
||||
switch ( ctrlSel ) |
||||
{ |
||||
case AUDIO_FU_CTRL_MUTE: |
||||
// Request uses format layout 1
|
||||
TU_VERIFY(p_request->wLength == sizeof(audio_control_cur_1_t)); |
||||
|
||||
mute[channelNum] = ((audio_control_cur_1_t*) pBuff)->bCur; |
||||
|
||||
TU_LOG2(" Set Mute: %d of channel: %u\r\n", mute[channelNum], channelNum); |
||||
return true; |
||||
|
||||
case AUDIO_FU_CTRL_VOLUME: |
||||
// Request uses format layout 2
|
||||
TU_VERIFY(p_request->wLength == sizeof(audio_control_cur_2_t)); |
||||
|
||||
volume[channelNum] = ((audio_control_cur_2_t*) pBuff)->bCur; |
||||
|
||||
TU_LOG2(" Set Volume: %d dB of channel: %u\r\n", volume[channelNum], channelNum); |
||||
return true; |
||||
|
||||
// Unknown/Unsupported control
|
||||
default: |
||||
TU_BREAKPOINT(); |
||||
return false; |
||||
} |
||||
} |
||||
return false; // Yet not implemented
|
||||
} |
||||
|
||||
// Invoked when audio class specific get request received for an EP
|
||||
bool tud_audio_get_req_ep_cb(uint8_t rhport, tusb_control_request_t const * p_request) |
||||
{ |
||||
(void) rhport; |
||||
|
||||
// Page 91 in UAC2 specification
|
||||
uint8_t channelNum = TU_U16_LOW(p_request->wValue); |
||||
uint8_t ctrlSel = TU_U16_HIGH(p_request->wValue); |
||||
uint8_t ep = TU_U16_LOW(p_request->wIndex); |
||||
|
||||
(void) channelNum; (void) ctrlSel; (void) ep; |
||||
|
||||
// return tud_control_xfer(rhport, p_request, &tmp, 1);
|
||||
|
||||
return false; // Yet not implemented
|
||||
} |
||||
|
||||
// Invoked when audio class specific get request received for an interface
|
||||
bool tud_audio_get_req_itf_cb(uint8_t rhport, tusb_control_request_t const * p_request) |
||||
{ |
||||
(void) rhport; |
||||
|
||||
// Page 91 in UAC2 specification
|
||||
uint8_t channelNum = TU_U16_LOW(p_request->wValue); |
||||
uint8_t ctrlSel = TU_U16_HIGH(p_request->wValue); |
||||
uint8_t itf = TU_U16_LOW(p_request->wIndex); |
||||
|
||||
(void) channelNum; (void) ctrlSel; (void) itf; |
||||
|
||||
return false; // Yet not implemented
|
||||
} |
||||
|
||||
// Invoked when audio class specific get request received for an entity
|
||||
bool tud_audio_get_req_entity_cb(uint8_t rhport, tusb_control_request_t const * p_request) |
||||
{ |
||||
(void) rhport; |
||||
|
||||
// Page 91 in UAC2 specification
|
||||
uint8_t channelNum = TU_U16_LOW(p_request->wValue); |
||||
uint8_t ctrlSel = TU_U16_HIGH(p_request->wValue); |
||||
// uint8_t itf = TU_U16_LOW(p_request->wIndex); // Since we have only one audio function implemented, we do not need the itf value
|
||||
uint8_t entityID = TU_U16_HIGH(p_request->wIndex); |
||||
|
||||
// Input terminal (Microphone input)
|
||||
if (entityID == 1) |
||||
{ |
||||
switch ( ctrlSel ) |
||||
{ |
||||
case AUDIO_TE_CTRL_CONNECTOR: |
||||
{ |
||||
// The terminal connector control only has a get request with only the CUR attribute.
|
||||
audio_desc_channel_cluster_t ret; |
||||
|
||||
// Those are dummy values for now
|
||||
ret.bNrChannels = 1; |
||||
ret.bmChannelConfig = 0; |
||||
ret.iChannelNames = 0; |
||||
|
||||
TU_LOG2(" Get terminal connector\r\n"); |
||||
|
||||
return tud_audio_buffer_and_schedule_control_xfer(rhport, p_request, (void*) &ret, sizeof(ret)); |
||||
} |
||||
break; |
||||
|
||||
// Unknown/Unsupported control selector
|
||||
default: |
||||
TU_BREAKPOINT(); |
||||
return false; |
||||
} |
||||
} |
||||
|
||||
// Feature unit
|
||||
if (entityID == 2) |
||||
{ |
||||
switch ( ctrlSel ) |
||||
{ |
||||
case AUDIO_FU_CTRL_MUTE: |
||||
// Audio control mute cur parameter block consists of only one byte - we thus can send it right away
|
||||
// There does not exist a range parameter block for mute
|
||||
TU_LOG2(" Get Mute of channel: %u\r\n", channelNum); |
||||
return tud_control_xfer(rhport, p_request, &mute[channelNum], 1); |
||||
|
||||
case AUDIO_FU_CTRL_VOLUME: |
||||
switch ( p_request->bRequest ) |
||||
{ |
||||
case AUDIO_CS_REQ_CUR: |
||||
TU_LOG2(" Get Volume of channel: %u\r\n", channelNum); |
||||
return tud_control_xfer(rhport, p_request, &volume[channelNum], sizeof(volume[channelNum])); |
||||
|
||||
case AUDIO_CS_REQ_RANGE: |
||||
TU_LOG2(" Get Volume range of channel: %u\r\n", channelNum); |
||||
|
||||
// Copy values - only for testing - better is version below
|
||||
audio_control_range_2_n_t(1) |
||||
ret; |
||||
|
||||
ret.wNumSubRanges = 1; |
||||
ret.subrange[0].bMin = -90; // -90 dB
|
||||
ret.subrange[0].bMax = 90; // +90 dB
|
||||
ret.subrange[0].bRes = 1; // 1 dB steps
|
||||
|
||||
return tud_audio_buffer_and_schedule_control_xfer(rhport, p_request, (void*) &ret, sizeof(ret)); |
||||
|
||||
// Unknown/Unsupported control
|
||||
default: |
||||
TU_BREAKPOINT(); |
||||
return false; |
||||
} |
||||
break; |
||||
|
||||
// Unknown/Unsupported control
|
||||
default: |
||||
TU_BREAKPOINT(); |
||||
return false; |
||||
} |
||||
} |
||||
|
||||
// Clock Source unit
|
||||
if ( entityID == 4 ) |
||||
{ |
||||
switch ( ctrlSel ) |
||||
{ |
||||
case AUDIO_CS_CTRL_SAM_FREQ: |
||||
// channelNum is always zero in this case
|
||||
switch ( p_request->bRequest ) |
||||
{ |
||||
case AUDIO_CS_REQ_CUR: |
||||
TU_LOG2(" Get Sample Freq.\r\n"); |
||||
return tud_control_xfer(rhport, p_request, &sampFreq, sizeof(sampFreq)); |
||||
|
||||
case AUDIO_CS_REQ_RANGE: |
||||
TU_LOG2(" Get Sample Freq. range\r\n"); |
||||
return tud_control_xfer(rhport, p_request, &sampleFreqRng, sizeof(sampleFreqRng)); |
||||
|
||||
// Unknown/Unsupported control
|
||||
default: |
||||
TU_BREAKPOINT(); |
||||
return false; |
||||
} |
||||
break; |
||||
|
||||
case AUDIO_CS_CTRL_CLK_VALID: |
||||
// Only cur attribute exists for this request
|
||||
TU_LOG2(" Get Sample Freq. valid\r\n"); |
||||
return tud_control_xfer(rhport, p_request, &clkValid, sizeof(clkValid)); |
||||
|
||||
// Unknown/Unsupported control
|
||||
default: |
||||
TU_BREAKPOINT(); |
||||
return false; |
||||
} |
||||
} |
||||
|
||||
TU_LOG2(" Unsupported entity: %d\r\n", entityID); |
||||
return false; // Yet not implemented
|
||||
} |
||||
|
||||
bool tud_audio_tx_done_pre_load_cb(uint8_t rhport, uint8_t itf, uint8_t ep_in, uint8_t cur_alt_setting) |
||||
{ |
||||
(void) rhport; |
||||
(void) itf; |
||||
(void) ep_in; |
||||
(void) cur_alt_setting; |
||||
|
||||
tud_audio_write ((uint8_t *)test_buffer_audio, CFG_TUD_AUDIO_EP_SZ_IN); |
||||
|
||||
return true; |
||||
} |
||||
|
||||
bool tud_audio_tx_done_post_load_cb(uint8_t rhport, uint16_t n_bytes_copied, uint8_t itf, uint8_t ep_in, uint8_t cur_alt_setting) |
||||
{ |
||||
(void) rhport; |
||||
(void) n_bytes_copied; |
||||
(void) itf; |
||||
(void) ep_in; |
||||
(void) cur_alt_setting; |
||||
|
||||
for (size_t cnt = 0; cnt < CFG_TUD_AUDIO_EP_SZ_IN/2; cnt++) |
||||
{ |
||||
test_buffer_audio[cnt] = startVal++; |
||||
} |
||||
|
||||
return true; |
||||
} |
||||
|
||||
bool tud_audio_set_itf_close_EP_cb(uint8_t rhport, tusb_control_request_t const * p_request) |
||||
{ |
||||
(void) rhport; |
||||
(void) p_request; |
||||
startVal = 0; |
||||
|
||||
return true; |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// BLINKING TASK
|
||||
//--------------------------------------------------------------------+
|
||||
void led_blinking_task(void) |
||||
{ |
||||
static uint32_t start_ms = 0; |
||||
static bool led_state = false; |
||||
|
||||
// Blink every interval ms
|
||||
if ( board_millis() - start_ms < blink_interval_ms) return; // not enough time
|
||||
start_ms += blink_interval_ms; |
||||
|
||||
board_led_write(led_state); |
||||
led_state = 1 - led_state; // toggle
|
||||
} |
||||
@ -0,0 +1,34 @@ |
||||
import sounddevice as sd |
||||
import matplotlib.pyplot as plt |
||||
import numpy as np |
||||
import platform |
||||
|
||||
if __name__ == '__main__': |
||||
|
||||
# If you got "ValueError: No input device matching", that is because your PC name example device |
||||
# differently from tested list below. Uncomment the next line to see full list and try to pick correct one |
||||
# print(sd.query_devices()) |
||||
|
||||
fs = 48000 # Sample rate |
||||
duration = 100e-3 # Duration of recording |
||||
|
||||
if platform.system() == 'Windows': |
||||
# MME is needed since there are more than one MicNode device APIs (at least in Windows) |
||||
device = 'Microphone (MicNode) MME' |
||||
elif platform.system() == 'Darwin': |
||||
device = 'MicNode' |
||||
else: |
||||
device ='default' |
||||
|
||||
myrecording = sd.rec(int(duration * fs), samplerate=fs, channels=1, dtype='int16', device=device) |
||||
print('Waiting...') |
||||
sd.wait() # Wait until recording is finished |
||||
print('Done!') |
||||
|
||||
time = np.arange(0, duration, 1 / fs) # time vector |
||||
plt.plot(time, myrecording) |
||||
plt.xlabel('Time [s]') |
||||
plt.ylabel('Amplitude') |
||||
plt.title('MicNode') |
||||
plt.show() |
||||
|
||||
@ -0,0 +1,111 @@ |
||||
/*
|
||||
* The MIT License (MIT) |
||||
* |
||||
* Copyright (c) 2019 Ha Thach (tinyusb.org) |
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
* of this software and associated documentation files (the "Software"), to deal |
||||
* in the Software without restriction, including without limitation the rights |
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
* copies of the Software, and to permit persons to whom the Software is |
||||
* furnished to do so, subject to the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice shall be included in |
||||
* all copies or substantial portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
* THE SOFTWARE. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef _TUSB_CONFIG_H_ |
||||
#define _TUSB_CONFIG_H_ |
||||
|
||||
#ifdef __cplusplus |
||||
extern "C" { |
||||
#endif |
||||
|
||||
//--------------------------------------------------------------------
|
||||
// COMMON CONFIGURATION
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
// defined by compiler flags for flexibility
|
||||
#ifndef CFG_TUSB_MCU |
||||
#error CFG_TUSB_MCU must be defined |
||||
#endif |
||||
|
||||
#if CFG_TUSB_MCU == OPT_MCU_LPC43XX || CFG_TUSB_MCU == OPT_MCU_LPC18XX || CFG_TUSB_MCU == OPT_MCU_MIMXRT10XX |
||||
#define CFG_TUSB_RHPORT0_MODE (OPT_MODE_DEVICE | OPT_MODE_HIGH_SPEED) |
||||
#else |
||||
#define CFG_TUSB_RHPORT0_MODE OPT_MODE_DEVICE |
||||
#endif |
||||
|
||||
#ifndef CFG_TUSB_OS |
||||
#define CFG_TUSB_OS OPT_OS_NONE |
||||
#endif |
||||
|
||||
#ifndef CFG_TUSB_DEBUG |
||||
#define CFG_TUSB_DEBUG 0 |
||||
#endif |
||||
|
||||
// CFG_TUSB_DEBUG is defined by compiler in DEBUG build
|
||||
// #define CFG_TUSB_DEBUG 0
|
||||
|
||||
/* USB DMA on some MCUs can only access a specific SRAM region with restriction on alignment.
|
||||
* Tinyusb use follows macros to declare transferring memory so that they can be put |
||||
* into those specific section. |
||||
* e.g |
||||
* - CFG_TUSB_MEM SECTION : __attribute__ (( section(".usb_ram") )) |
||||
* - CFG_TUSB_MEM_ALIGN : __attribute__ ((aligned(4))) |
||||
*/ |
||||
#ifndef CFG_TUSB_MEM_SECTION |
||||
#define CFG_TUSB_MEM_SECTION |
||||
#endif |
||||
|
||||
#ifndef CFG_TUSB_MEM_ALIGN |
||||
#define CFG_TUSB_MEM_ALIGN __attribute__ ((aligned(4))) |
||||
#endif |
||||
|
||||
//--------------------------------------------------------------------
|
||||
// DEVICE CONFIGURATION
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
#ifndef CFG_TUD_ENDPOINT0_SIZE |
||||
#define CFG_TUD_ENDPOINT0_SIZE 64 |
||||
#endif |
||||
|
||||
//------------- CLASS -------------//
|
||||
#define CFG_TUD_CDC 0 |
||||
#define CFG_TUD_MSC 0 |
||||
#define CFG_TUD_HID 0 |
||||
#define CFG_TUD_MIDI 0 |
||||
#define CFG_TUD_AUDIO 1 |
||||
#define CFG_TUD_VENDOR 0 |
||||
|
||||
//--------------------------------------------------------------------
|
||||
// AUDIO CLASS DRIVER CONFIGURATION
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
// Have a look into audio_device.h for all configurations
|
||||
|
||||
#define CFG_TUD_AUDIO_FUNC_1_DESC_LEN TUD_AUDIO_MIC_ONE_CH_DESC_LEN |
||||
#define CFG_TUD_AUDIO_FUNC_1_N_AS_INT 1 // Number of Standard AS Interface Descriptors (4.9.1) defined per audio function - this is required to be able to remember the current alternate settings of these interfaces - We restrict us here to have a constant number for all audio functions (which means this has to be the maximum number of AS interfaces an audio function has and a second audio function with less AS interfaces just wastes a few bytes)
|
||||
#define CFG_TUD_AUDIO_FUNC_1_CTRL_BUF_SZ 64 // Size of control request buffer
|
||||
|
||||
#define CFG_TUD_AUDIO_ENABLE_EP_IN 1 |
||||
#define CFG_TUD_AUDIO_FUNC_1_N_BYTES_PER_SAMPLE_TX 2 // Driver gets this info from the descriptors - we define it here to use it to setup the descriptors and to do calculations with it below
|
||||
#define CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX 1 // Driver gets this info from the descriptors - we define it here to use it to setup the descriptors and to do calculations with it below - be aware: for different number of channels you need another descriptor!
|
||||
#define CFG_TUD_AUDIO_EP_SZ_IN 48 * CFG_TUD_AUDIO_FUNC_1_N_BYTES_PER_SAMPLE_TX * CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX // 48 Samples (48 kHz) x 2 Bytes/Sample x 1 Channel
|
||||
#define CFG_TUD_AUDIO_FUNC_1_EP_IN_SZ_MAX CFG_TUD_AUDIO_EP_SZ_IN // Maximum EP IN size for all AS alternate settings used
|
||||
#define CFG_TUD_AUDIO_FUNC_1_EP_IN_SW_BUF_SZ CFG_TUD_AUDIO_EP_SZ_IN + 1 |
||||
|
||||
#ifdef __cplusplus |
||||
} |
||||
#endif |
||||
|
||||
#endif /* _TUSB_CONFIG_H_ */ |
||||
@ -0,0 +1,165 @@ |
||||
/*
|
||||
* The MIT License (MIT) |
||||
* |
||||
* Copyright (c) 2019 Ha Thach (tinyusb.org) |
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
* of this software and associated documentation files (the "Software"), to deal |
||||
* in the Software without restriction, including without limitation the rights |
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
* copies of the Software, and to permit persons to whom the Software is |
||||
* furnished to do so, subject to the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice shall be included in |
||||
* all copies or substantial portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
* THE SOFTWARE. |
||||
* |
||||
*/ |
||||
|
||||
#include "tusb.h" |
||||
|
||||
/* A combination of interfaces must have a unique product id, since PC will save device driver after the first plug.
|
||||
* Same VID/PID with different interface e.g MSC (first), then CDC (later) will possibly cause system error on PC. |
||||
* |
||||
* Auto ProductID layout's Bitmap: |
||||
* [MSB] AUDIO | MIDI | HID | MSC | CDC [LSB] |
||||
*/ |
||||
#define _PID_MAP(itf, n) ( (CFG_TUD_##itf) << (n) ) |
||||
#define USB_PID (0x4000 | _PID_MAP(CDC, 0) | _PID_MAP(MSC, 1) | _PID_MAP(HID, 2) | \ |
||||
_PID_MAP(MIDI, 3) | _PID_MAP(AUDIO, 4) | _PID_MAP(VENDOR, 5) ) |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// Device Descriptors
|
||||
//--------------------------------------------------------------------+
|
||||
tusb_desc_device_t const desc_device = |
||||
{ |
||||
.bLength = sizeof(tusb_desc_device_t), |
||||
.bDescriptorType = TUSB_DESC_DEVICE, |
||||
.bcdUSB = 0x0200, |
||||
|
||||
// Use Interface Association Descriptor (IAD) for CDC
|
||||
// As required by USB Specs IAD's subclass must be common class (2) and protocol must be IAD (1)
|
||||
.bDeviceClass = TUSB_CLASS_MISC, |
||||
.bDeviceSubClass = MISC_SUBCLASS_COMMON, |
||||
.bDeviceProtocol = MISC_PROTOCOL_IAD, |
||||
.bMaxPacketSize0 = CFG_TUD_ENDPOINT0_SIZE, |
||||
|
||||
.idVendor = 0xCafe, |
||||
.idProduct = USB_PID, |
||||
.bcdDevice = 0x0100, |
||||
|
||||
.iManufacturer = 0x01, |
||||
.iProduct = 0x02, |
||||
.iSerialNumber = 0x03, |
||||
|
||||
.bNumConfigurations = 0x01 |
||||
}; |
||||
|
||||
// Invoked when received GET DEVICE DESCRIPTOR
|
||||
// Application return pointer to descriptor
|
||||
uint8_t const * tud_descriptor_device_cb(void) |
||||
{ |
||||
return (uint8_t const *) &desc_device; |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// Configuration Descriptor
|
||||
//--------------------------------------------------------------------+
|
||||
enum |
||||
{ |
||||
ITF_NUM_AUDIO_CONTROL = 0, |
||||
ITF_NUM_AUDIO_STREAMING, |
||||
ITF_NUM_TOTAL |
||||
}; |
||||
|
||||
#define CONFIG_TOTAL_LEN (TUD_CONFIG_DESC_LEN + CFG_TUD_AUDIO * TUD_AUDIO_MIC_ONE_CH_DESC_LEN) |
||||
|
||||
#if CFG_TUSB_MCU == OPT_MCU_LPC175X_6X || CFG_TUSB_MCU == OPT_MCU_LPC177X_8X || CFG_TUSB_MCU == OPT_MCU_LPC40XX |
||||
// LPC 17xx and 40xx endpoint type (bulk/interrupt/iso) are fixed by its number
|
||||
// 0 control, 1 In, 2 Bulk, 3 Iso, 4 In etc ...
|
||||
#define EPNUM_AUDIO 0x03 |
||||
|
||||
#elif TU_CHECK_MCU(NRF5X) |
||||
// nRF5x ISO can only be endpoint 8
|
||||
#define EPNUM_AUDIO 0x08 |
||||
|
||||
#else |
||||
#define EPNUM_AUDIO 0x01 |
||||
#endif |
||||
|
||||
uint8_t const desc_configuration[] = |
||||
{ |
||||
// Interface count, string index, total length, attribute, power in mA
|
||||
TUD_CONFIG_DESCRIPTOR(1, ITF_NUM_TOTAL, 0, CONFIG_TOTAL_LEN, 0x00, 100), |
||||
|
||||
// Interface number, string index, EP Out & EP In address, EP size
|
||||
TUD_AUDIO_MIC_ONE_CH_DESCRIPTOR(/*_itfnum*/ ITF_NUM_AUDIO_CONTROL, /*_stridx*/ 0, /*_nBytesPerSample*/ CFG_TUD_AUDIO_FUNC_1_N_BYTES_PER_SAMPLE_TX, /*_nBitsUsedPerSample*/ CFG_TUD_AUDIO_FUNC_1_N_BYTES_PER_SAMPLE_TX*8, /*_epin*/ 0x80 | EPNUM_AUDIO, /*_epsize*/ CFG_TUD_AUDIO_EP_SZ_IN) |
||||
}; |
||||
|
||||
// Invoked when received GET CONFIGURATION DESCRIPTOR
|
||||
// Application return pointer to descriptor
|
||||
// Descriptor contents must exist long enough for transfer to complete
|
||||
uint8_t const * tud_descriptor_configuration_cb(uint8_t index) |
||||
{ |
||||
(void) index; // for multiple configurations
|
||||
return desc_configuration; |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// String Descriptors
|
||||
//--------------------------------------------------------------------+
|
||||
|
||||
// array of pointer to string descriptors
|
||||
char const* string_desc_arr [] = |
||||
{ |
||||
(const char[]) { 0x09, 0x04 }, // 0: is supported language is English (0x0409)
|
||||
"PaniRCorp", // 1: Manufacturer
|
||||
"MicNode", // 2: Product
|
||||
"123456", // 3: Serials, should use chip ID
|
||||
"UAC2", // 4: Audio Interface
|
||||
}; |
||||
|
||||
static uint16_t _desc_str[32]; |
||||
|
||||
// Invoked when received GET STRING DESCRIPTOR request
|
||||
// Application return pointer to descriptor, whose contents must exist long enough for transfer to complete
|
||||
uint16_t const* tud_descriptor_string_cb(uint8_t index, uint16_t langid) |
||||
{ |
||||
(void) langid; |
||||
|
||||
uint8_t chr_count; |
||||
|
||||
if ( index == 0) |
||||
{ |
||||
memcpy(&_desc_str[1], string_desc_arr[0], 2); |
||||
chr_count = 1; |
||||
}else |
||||
{ |
||||
// Convert ASCII string into UTF-16
|
||||
|
||||
if ( !(index < sizeof(string_desc_arr)/sizeof(string_desc_arr[0])) ) return NULL; |
||||
|
||||
const char* str = string_desc_arr[index]; |
||||
|
||||
// Cap at max char
|
||||
chr_count = strlen(str); |
||||
if ( chr_count > 31 ) chr_count = 31; |
||||
|
||||
for(uint8_t i=0; i<chr_count; i++) |
||||
{ |
||||
_desc_str[1+i] = str[i]; |
||||
} |
||||
} |
||||
|
||||
// first byte is length (including header), second byte is string type
|
||||
_desc_str[0] = (TUSB_DESC_STRING << 8 ) | (2*chr_count + 2); |
||||
|
||||
return _desc_str; |
||||
} |
||||
@ -0,0 +1,42 @@ |
||||
cmake_minimum_required(VERSION 3.5) |
||||
|
||||
include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake) |
||||
|
||||
# Check for -DFAMILY= |
||||
if(FAMILY MATCHES "^esp32s[2-3]") |
||||
# use BOARD-Directory name for project id |
||||
get_filename_component(PROJECT ${CMAKE_CURRENT_SOURCE_DIR} NAME) |
||||
set(PROJECT ${BOARD}-${PROJECT}) |
||||
|
||||
# TOP is absolute path to root directory of TinyUSB git repo |
||||
set(TOP "../../..") |
||||
get_filename_component(TOP "${TOP}" REALPATH) |
||||
|
||||
project(${PROJECT}) |
||||
|
||||
else() |
||||
|
||||
# gets PROJECT name for the example (e.g. <BOARD>-<DIR_NAME>) |
||||
family_get_project_name(PROJECT ${CMAKE_CURRENT_LIST_DIR}) |
||||
|
||||
project(${PROJECT}) |
||||
|
||||
# Checks this example is valid for the family and initializes the project |
||||
family_initialize_project(${PROJECT} ${CMAKE_CURRENT_LIST_DIR}) |
||||
|
||||
add_executable(${PROJECT}) |
||||
|
||||
# Example source |
||||
target_sources(${PROJECT} PUBLIC |
||||
${CMAKE_CURRENT_SOURCE_DIR}/src/main.c |
||||
) |
||||
|
||||
# Example include |
||||
target_include_directories(${PROJECT} PUBLIC |
||||
${CMAKE_CURRENT_SOURCE_DIR}/src |
||||
) |
||||
|
||||
# Configure compilation flags and libraries for the example... see the corresponding function |
||||
# in hw/bsp/FAMILY/family.cmake for details. |
||||
family_configure_device_example(${PROJECT}) |
||||
endif() |
||||
@ -0,0 +1,18 @@ |
||||
include ../../../tools/top.mk |
||||
include ../../make.mk |
||||
|
||||
INC += \
|
||||
src \
|
||||
$(TOP)/hw \
|
||||
|
||||
# Example source
|
||||
EXAMPLE_SOURCE += $(wildcard src/*.c)
|
||||
SRC_C += $(addprefix $(CURRENT_PATH)/, $(EXAMPLE_SOURCE))
|
||||
|
||||
# board_test example is special example that doesn't enable device or host stack
|
||||
# This can cause some TinyUSB API missing, this hack to allow us to fill those API
|
||||
# to pass the compilation process
|
||||
CFLAGS += \
|
||||
-D"tud_int_handler(x)= " \
|
||||
|
||||
include ../../rules.mk |
||||
@ -0,0 +1,3 @@ |
||||
CONFIG_IDF_CMAKE=y |
||||
CONFIG_FREERTOS_WATCHPOINT_END_OF_STACK=y |
||||
CONFIG_FREERTOS_SUPPORT_STATIC_ALLOCATION=y |
||||
@ -0,0 +1,17 @@ |
||||
# FAMILY = esp32sx |
||||
idf_component_register(SRCS "main.c" |
||||
INCLUDE_DIRS "." |
||||
REQUIRES freertos soc) |
||||
|
||||
file(TO_NATIVE_PATH "${TOP}/hw/bsp/${FAMILY}/boards/${BOARD}/board.cmake" board_cmake) |
||||
|
||||
if(EXISTS ${board_cmake}) |
||||
include(${board_cmake}) |
||||
endif() |
||||
|
||||
idf_component_get_property( FREERTOS_ORIG_INCLUDE_PATH freertos ORIG_INCLUDE_PATH) |
||||
target_include_directories(${COMPONENT_TARGET} PUBLIC |
||||
"${FREERTOS_ORIG_INCLUDE_PATH}" |
||||
"${TOP}/hw" |
||||
"${TOP}/src" |
||||
) |
||||
@ -0,0 +1,78 @@ |
||||
/*
|
||||
* The MIT License (MIT) |
||||
* |
||||
* Copyright (c) 2019 Ha Thach (tinyusb.org) |
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
* of this software and associated documentation files (the "Software"), to deal |
||||
* in the Software without restriction, including without limitation the rights |
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
* copies of the Software, and to permit persons to whom the Software is |
||||
* furnished to do so, subject to the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice shall be included in |
||||
* all copies or substantial portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
* THE SOFTWARE. |
||||
* |
||||
*/ |
||||
|
||||
#include <stdlib.h> |
||||
#include <stdio.h> |
||||
#include <string.h> |
||||
|
||||
#include "bsp/board.h" |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// MACRO CONSTANT TYPEDEF PROTYPES
|
||||
//--------------------------------------------------------------------+
|
||||
|
||||
/* Blink pattern
|
||||
* - 250 ms : button is not pressed |
||||
* - 1000 ms : button is pressed (and hold) |
||||
*/ |
||||
enum { |
||||
BLINK_PRESSED = 250, |
||||
BLINK_UNPRESSED = 1000 |
||||
}; |
||||
|
||||
#define HELLO_STR "Hello from TinyUSB\r\n" |
||||
|
||||
int main(void) |
||||
{ |
||||
board_init(); |
||||
|
||||
uint32_t start_ms = 0; |
||||
bool led_state = false; |
||||
|
||||
while (1) |
||||
{ |
||||
uint32_t interval_ms = board_button_read() ? BLINK_PRESSED : BLINK_UNPRESSED; |
||||
|
||||
// Blink every interval ms
|
||||
if ( !(board_millis() - start_ms < interval_ms) ) |
||||
{ |
||||
board_uart_write(HELLO_STR, strlen(HELLO_STR)); |
||||
|
||||
start_ms = board_millis(); |
||||
|
||||
board_led_write(led_state); |
||||
led_state = 1 - led_state; // toggle
|
||||
} |
||||
} |
||||
|
||||
return 0; |
||||
} |
||||
|
||||
#if CFG_TUSB_MCU == OPT_MCU_ESP32S2 || CFG_TUSB_MCU == OPT_MCU_ESP32S3 |
||||
void app_main(void) |
||||
{ |
||||
main(); |
||||
} |
||||
#endif |
||||
@ -0,0 +1,85 @@ |
||||
/*
|
||||
* The MIT License (MIT) |
||||
* |
||||
* Copyright (c) 2019 Ha Thach (tinyusb.org) |
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
* of this software and associated documentation files (the "Software"), to deal |
||||
* in the Software without restriction, including without limitation the rights |
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
* copies of the Software, and to permit persons to whom the Software is |
||||
* furnished to do so, subject to the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice shall be included in |
||||
* all copies or substantial portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
* THE SOFTWARE. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef _TUSB_CONFIG_H_ |
||||
#define _TUSB_CONFIG_H_ |
||||
|
||||
#ifdef __cplusplus |
||||
extern "C" { |
||||
#endif |
||||
|
||||
//--------------------------------------------------------------------
|
||||
// COMMON CONFIGURATION
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
// defined by compiler flags for flexibility
|
||||
#ifndef CFG_TUSB_MCU |
||||
#error CFG_TUSB_MCU must be defined |
||||
#endif |
||||
|
||||
#ifndef CFG_TUSB_OS |
||||
#define CFG_TUSB_OS OPT_OS_NONE |
||||
#endif |
||||
|
||||
#define CFG_TUSB_RHPORT0_MODE OPT_MODE_NONE |
||||
|
||||
// CFG_TUSB_DEBUG is defined by compiler in DEBUG build
|
||||
// #define CFG_TUSB_DEBUG 0
|
||||
|
||||
/* USB DMA on some MCUs can only access a specific SRAM region with restriction on alignment.
|
||||
* Tinyusb use follows macros to declare transferring memory so that they can be put |
||||
* into those specific section. |
||||
* e.g |
||||
* - CFG_TUSB_MEM SECTION : __attribute__ (( section(".usb_ram") )) |
||||
* - CFG_TUSB_MEM_ALIGN : __attribute__ ((aligned(4))) |
||||
*/ |
||||
#ifndef CFG_TUSB_MEM_SECTION |
||||
#define CFG_TUSB_MEM_SECTION |
||||
#endif |
||||
|
||||
#ifndef CFG_TUSB_MEM_ALIGN |
||||
#define CFG_TUSB_MEM_ALIGN __attribute__ ((aligned(4))) |
||||
#endif |
||||
|
||||
//--------------------------------------------------------------------
|
||||
// DEVICE CONFIGURATION
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
#ifndef CFG_TUD_ENDPOINT0_SIZE |
||||
#define CFG_TUD_ENDPOINT0_SIZE 64 |
||||
#endif |
||||
|
||||
//------------- CLASS -------------//
|
||||
#define CFG_TUD_CDC 0 |
||||
#define CFG_TUD_MSC 0 |
||||
#define CFG_TUD_HID 0 |
||||
#define CFG_TUD_MIDI 0 |
||||
#define CFG_TUD_VENDOR 0 |
||||
|
||||
#ifdef __cplusplus |
||||
} |
||||
#endif |
||||
|
||||
#endif /* _TUSB_CONFIG_H_ */ |
||||
@ -0,0 +1,28 @@ |
||||
cmake_minimum_required(VERSION 3.5) |
||||
|
||||
include(${CMAKE_CURRENT_SOURCE_DIR}/../../../hw/bsp/family_support.cmake) |
||||
|
||||
# gets PROJECT name for the example (e.g. <BOARD>-<DIR_NAME>) |
||||
family_get_project_name(PROJECT ${CMAKE_CURRENT_LIST_DIR}) |
||||
|
||||
project(${PROJECT}) |
||||
|
||||
# Checks this example is valid for the family and initializes the project |
||||
family_initialize_project(${PROJECT} ${CMAKE_CURRENT_LIST_DIR}) |
||||
|
||||
add_executable(${PROJECT}) |
||||
|
||||
# Example source |
||||
target_sources(${PROJECT} PUBLIC |
||||
${CMAKE_CURRENT_SOURCE_DIR}/src/main.c |
||||
${CMAKE_CURRENT_SOURCE_DIR}/src/usb_descriptors.c |
||||
) |
||||
|
||||
# Example include |
||||
target_include_directories(${PROJECT} PUBLIC |
||||
${CMAKE_CURRENT_SOURCE_DIR}/src |
||||
) |
||||
|
||||
# Configure compilation flags and libraries for the example... see the corresponding function |
||||
# in hw/bsp/FAMILY/family.cmake for details. |
||||
family_configure_device_example(${PROJECT}) |
||||
@ -0,0 +1,12 @@ |
||||
include ../../../tools/top.mk |
||||
include ../../make.mk |
||||
|
||||
INC += \
|
||||
src \
|
||||
$(TOP)/hw \
|
||||
|
||||
# Example source
|
||||
EXAMPLE_SOURCE += $(wildcard src/*.c)
|
||||
SRC_C += $(addprefix $(CURRENT_PATH)/, $(EXAMPLE_SOURCE))
|
||||
|
||||
include ../../rules.mk |
||||
@ -0,0 +1,100 @@ |
||||
/*
|
||||
* The MIT License (MIT) |
||||
* |
||||
* Copyright (c) 2019 Ha Thach (tinyusb.org) |
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
* of this software and associated documentation files (the "Software"), to deal |
||||
* in the Software without restriction, including without limitation the rights |
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
* copies of the Software, and to permit persons to whom the Software is |
||||
* furnished to do so, subject to the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice shall be included in |
||||
* all copies or substantial portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
* THE SOFTWARE. |
||||
* |
||||
*/ |
||||
|
||||
#include <stdlib.h> |
||||
#include <stdio.h> |
||||
#include <string.h> |
||||
#include <ctype.h> |
||||
|
||||
#include "bsp/board.h" |
||||
#include "tusb.h" |
||||
|
||||
//------------- prototypes -------------//
|
||||
static void cdc_task(void); |
||||
|
||||
/*------------- MAIN -------------*/ |
||||
int main(void) |
||||
{ |
||||
board_init(); |
||||
|
||||
tusb_init(); |
||||
|
||||
while (1) |
||||
{ |
||||
tud_task(); // tinyusb device task
|
||||
cdc_task(); |
||||
} |
||||
|
||||
return 0; |
||||
} |
||||
|
||||
// echo to either Serial0 or Serial1
|
||||
// with Serial0 as all lower case, Serial1 as all upper case
|
||||
static void echo_serial_port(uint8_t itf, uint8_t buf[], uint32_t count) |
||||
{ |
||||
for(uint32_t i=0; i<count; i++) |
||||
{ |
||||
if (itf == 0) |
||||
{ |
||||
// echo back 1st port as lower case
|
||||
if (isupper(buf[i])) buf[i] += 'a' - 'A'; |
||||
} |
||||
else |
||||
{ |
||||
// echo back 2nd port as upper case
|
||||
if (islower(buf[i])) buf[i] -= 'a' - 'A'; |
||||
} |
||||
|
||||
tud_cdc_n_write_char(itf, buf[i]); |
||||
} |
||||
tud_cdc_n_write_flush(itf); |
||||
} |
||||
|
||||
//--------------------------------------------------------------------+
|
||||
// USB CDC
|
||||
//--------------------------------------------------------------------+
|
||||
static void cdc_task(void) |
||||
{ |
||||
uint8_t itf; |
||||
|
||||
for (itf = 0; itf < CFG_TUD_CDC; itf++) |
||||
{ |
||||
// connected() check for DTR bit
|
||||
// Most but not all terminal client set this when making connection
|
||||
// if ( tud_cdc_n_connected(itf) )
|
||||
{ |
||||
if ( tud_cdc_n_available(itf) ) |
||||
{ |
||||
uint8_t buf[64]; |
||||
|
||||
uint32_t count = tud_cdc_n_read(itf, buf, sizeof(buf)); |
||||
|
||||
// echo back to both serial ports
|
||||
echo_serial_port(0, buf, count); |
||||
echo_serial_port(1, buf, count); |
||||
} |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,115 @@ |
||||
/*
|
||||
* The MIT License (MIT) |
||||
* |
||||
* Copyright (c) 2019 Ha Thach (tinyusb.org) |
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
* of this software and associated documentation files (the "Software"), to deal |
||||
* in the Software without restriction, including without limitation the rights |
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
||||
* copies of the Software, and to permit persons to whom the Software is |
||||
* furnished to do so, subject to the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice shall be included in |
||||
* all copies or substantial portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
||||
* THE SOFTWARE. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef _TUSB_CONFIG_H_ |
||||
#define _TUSB_CONFIG_H_ |
||||
|
||||
#ifdef __cplusplus |
||||
extern "C" { |
||||
#endif |
||||
|
||||
//--------------------------------------------------------------------
|
||||
// COMMON CONFIGURATION
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
// defined by board.mk
|
||||
#ifndef CFG_TUSB_MCU |
||||
#error CFG_TUSB_MCU must be defined |
||||
#endif |
||||
|
||||
// RHPort number used for device can be defined by board.mk, default to port 0
|
||||
#ifndef BOARD_DEVICE_RHPORT_NUM |
||||
#define BOARD_DEVICE_RHPORT_NUM 0 |
||||
#endif |
||||
|
||||
// RHPort max operational speed can defined by board.mk
|
||||
// Default to Highspeed for MCU with internal HighSpeed PHY (can be port specific), otherwise FullSpeed
|
||||
#ifndef BOARD_DEVICE_RHPORT_SPEED |
||||
#if (CFG_TUSB_MCU == OPT_MCU_LPC18XX || CFG_TUSB_MCU == OPT_MCU_LPC43XX || CFG_TUSB_MCU == OPT_MCU_MIMXRT10XX || \ |
||||
CFG_TUSB_MCU == OPT_MCU_NUC505 || CFG_TUSB_MCU == OPT_MCU_CXD56 || CFG_TUSB_MCU == OPT_MCU_SAMX7X) |
||||
#define BOARD_DEVICE_RHPORT_SPEED OPT_MODE_HIGH_SPEED |
||||
#else |
||||
#define BOARD_DEVICE_RHPORT_SPEED OPT_MODE_FULL_SPEED |
||||
#endif |
||||
#endif |
||||
|
||||
// Device mode with rhport and speed defined by board.mk
|
||||
#if BOARD_DEVICE_RHPORT_NUM == 0 |
||||
#define CFG_TUSB_RHPORT0_MODE (OPT_MODE_DEVICE | BOARD_DEVICE_RHPORT_SPEED) |
||||
#elif BOARD_DEVICE_RHPORT_NUM == 1 |
||||
#define CFG_TUSB_RHPORT1_MODE (OPT_MODE_DEVICE | BOARD_DEVICE_RHPORT_SPEED) |
||||
#else |
||||
#error "Incorrect RHPort configuration" |
||||
#endif |
||||
|
||||
#ifndef CFG_TUSB_OS |
||||
#define CFG_TUSB_OS OPT_OS_NONE |
||||
#endif |
||||
|
||||
// CFG_TUSB_DEBUG is defined by compiler in DEBUG build
|
||||
// #define CFG_TUSB_DEBUG 0
|
||||
|
||||
/* USB DMA on some MCUs can only access a specific SRAM region with restriction on alignment.
|
||||
* Tinyusb use follows macros to declare transferring memory so that they can be put |
||||
* into those specific section. |
||||
* e.g |
||||
* - CFG_TUSB_MEM SECTION : __attribute__ (( section(".usb_ram") )) |
||||
* - CFG_TUSB_MEM_ALIGN : __attribute__ ((aligned(4))) |
||||
*/ |
||||
#ifndef CFG_TUSB_MEM_SECTION |
||||
#define CFG_TUSB_MEM_SECTION |
||||
#endif |
||||
|
||||
#ifndef CFG_TUSB_MEM_ALIGN |
||||
#define CFG_TUSB_MEM_ALIGN __attribute__ ((aligned(4))) |
||||
#endif |
||||
|
||||
//--------------------------------------------------------------------
|
||||
// DEVICE CONFIGURATION
|
||||
//--------------------------------------------------------------------
|
||||
|
||||
#ifndef CFG_TUD_ENDPOINT0_SIZE |
||||
#define CFG_TUD_ENDPOINT0_SIZE 64 |
||||
#endif |
||||
|
||||
//------------- CLASS -------------//
|
||||
#define CFG_TUD_CDC 2 |
||||
#define CFG_TUD_MSC 0 |
||||
#define CFG_TUD_HID 0 |
||||
#define CFG_TUD_MIDI 0 |
||||
#define CFG_TUD_VENDOR 0 |
||||
|
||||
// CDC FIFO size of TX and RX
|
||||
#define CFG_TUD_CDC_RX_BUFSIZE (TUD_OPT_HIGH_SPEED ? 512 : 64) |
||||
#define CFG_TUD_CDC_TX_BUFSIZE (TUD_OPT_HIGH_SPEED ? 512 : 64) |
||||
|
||||
// CDC Endpoint transfer buffer size, more is faster
|
||||
#define CFG_TUD_CDC_EP_BUFSIZE (TUD_OPT_HIGH_SPEED ? 512 : 64) |
||||
|
||||
#ifdef __cplusplus |
||||
} |
||||
#endif |
||||
|
||||
#endif /* _TUSB_CONFIG_H_ */ |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue