summaryrefslogtreecommitdiff
path: root/docs/getting_started.rst
diff options
context:
space:
mode:
authorc1570 <[email protected]>2025-09-27 00:39:29 +0200
committerc1570 <[email protected]>2025-10-20 21:08:34 +0200
commit1f908d88ce4ba76d15d5b961a293327961deb7f9 (patch)
tree171a3eabacfdfb7b363413872612e8a389ec1d98 /docs/getting_started.rst
parent82aa46d8ea9370944440cc40b87738ebeabb9593 (diff)
getting_started structure
Diffstat (limited to 'docs/getting_started.rst')
-rw-r--r--docs/getting_started.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
index 5e8ebd040..85f1f8a04 100644
--- a/docs/getting_started.rst
+++ b/docs/getting_started.rst
@@ -63,13 +63,14 @@ For your convenience, TinyUSB contains a handful of examples for both host and d
$ git clone https://github.com/hathach/tinyusb tinyusb
$ cd tinyusb
-Some ports require additional port-specific SDKs (e.g., for RP2040) or binaries (e.g., for Sony Spresense) to build examples. These components are outside the scope of TinyUSB, so you should download and install them first according to the manufacturer's documentation.
+TinyUSB separates example applications from board-specific hardware configurations (Board Support Packages, BSP). The BSP provides hardware abstraction including pin mappings, clock settings, linker scripts, and hardware initialization routines.
+
+* Example applications live in ``examples/device``, ``examples/host``, and ``examples/dual`` directories.
+* BSP configurations are stored in ``hw/bsp/FAMILY/boards/BOARD_NAME``. For example, raspberry_pi_pico is located in ``hw/bsp/rp2040/boards/raspberry_pi_pico`` where ``FAMILY=rp2040`` and ``BOARD=raspberry_pi_pico``. When you build an example with ``BOARD=raspberry_pi_pico``, the build system automatically finds and uses the corresponding BSP.
Dependencies
^^^^^^^^^^^^
-TinyUSB separates example applications from board-specific hardware configurations (Board Support Packages, BSP). Example applications live in ``examples/device``, ``examples/host``, and ``examples/dual`` directories, while BSP configurations are stored in ``hw/bsp/FAMILY/boards/BOARD_NAME``. The BSP provides hardware abstraction including pin mappings, clock settings, linker scripts, and hardware initialization routines. For example, raspberry_pi_pico is located in ``hw/bsp/rp2040/boards/raspberry_pi_pico`` where ``FAMILY=rp2040`` and ``BOARD=raspberry_pi_pico``. When you build an example with ``BOARD=raspberry_pi_pico``, the build system automatically finds and uses the corresponding BSP.
-
Before building, you must first download dependencies including MCU low-level peripheral drivers and external libraries such as FreeRTOS (required by some examples). You can do this in either of two ways:
1. Run the ``tools/get_deps.py {FAMILY}`` script to download all dependencies for a specific MCU family. To download dependencies for all families, use ``FAMILY=all``.