2.0 KiB
Getting Started
Table of Contents
Download
tinyusb uses github as online repository https://github.com/hathach/tinyusb since it is the best place for open source project.
If you are using Linux, you already know how to what to do. But If Windows is your OS, I would suggest to install git and front-end gui such as tortoisegit to begin with.
After downloading/cloning, the code base is composed of
| Folder | Description |
|---|---|
| boards | Source files of supported boards |
| demos | Source & project files for demonstration application |
| mcu | Low level mcu core & peripheral drivers (e.g CMSIS ) |
| tests | Unit tests for the stack |
| tinyusb | All sources files for tinyusb stack itself. |
| vendor | Source files from 3rd party such as freeRTOS, fatfs etc ... |
repo/demos is the folder where all the application & project files are located. There are demos for both device and hosts. For each, there are different projects for each of supported RTOS.
Add tinyusb to your project
It is relatively simple to incorporate tinyusb to your (existing) project
- Copy core folder repo/tinyusb to your project. Let's say it is your_project/tinyusb
- Add all the .c in the core folder to your project settings (uvproj, ewp, makefile)
- Add your_project/tinysb to your include path. Also make sure your current include path also contains the configuration file tusb_config.h. Or you could simply put the tusb_config.h into the tinyusb folder as well.
- Make sure all required macros such as TUSB_CFG_MCU are all defined properly in tusb_config.h.
\subpage md_boards_readme
\subpage md_doxygen_started_build_demo
\subpage md_doxygen_started_run_demo
\subpage md_doxygen_tools