diff options
Diffstat (limited to 'examples/host/msc_file_explorer')
| -rw-r--r-- | examples/host/msc_file_explorer/README.md | 30 |
1 files changed, 26 insertions, 4 deletions
diff --git a/examples/host/msc_file_explorer/README.md b/examples/host/msc_file_explorer/README.md index e220bedea..b80ca8f6c 100644 --- a/examples/host/msc_file_explorer/README.md +++ b/examples/host/msc_file_explorer/README.md @@ -27,16 +27,38 @@ CLI is presented over the board's serial console. | mv | `mv <src> <dest>` | Rename/move a file or directory | | rm | `rm <file>` | Remove a file | +## Configuration + +Notable `tusb_config.h` settings: + +```c +#define CFG_TUH_ENABLED 1 +#define CFG_TUH_HUB 1 +#define CFG_TUH_MSC 1 +#define CFG_TUH_DEVICE_MAX (3*CFG_TUH_HUB + 1) +#define CFG_TUH_MSC_MAXLUN 4 +``` + ## Build -Build for a specific board using CMake (see [Getting Started](https://docs.tinyusb.org/en/latest/getting_started.html)): +CMake: + +```bash +mkdir build && cd build +cmake -DBOARD=raspberry_pi_pico .. +cmake --build . +``` + +Make: ```bash -# Example: build for Raspberry Pi Pico -cmake -B build -DBOARD=raspberry_pi_pico -DFAMILY=rp2040 examples/host/msc_file_explorer -cmake --build build +make BOARD=raspberry_pi_pico all ``` +## FreeRTOS variant + +A FreeRTOS build is in `examples/host/msc_file_explorer_freertos` — identical MSC FatFS file-explorer CLI, running the host stack and CLI as FreeRTOS tasks. + ## Usage 1. Flash the firmware to your board. |