TeenyUSB 开源项目使用教程

TeenyUSB 开源项目使用教程

TeenyUSB Lightweight USB device and host stack for STM32 and other MCUs. Ready for USB 3.0 device. 项目地址: https://gitcode.com/gh_mirrors/te/TeenyUSB

1. 项目的目录结构及介绍

TeenyUSB 项目的目录结构如下：

TeenyUSB/
├── TeenyDT/          # 基于 Lua 的 USB 描述符生成工具
├── sample/           # 示例代码
├── mcu_lib/          # MCU 文件子仓库
├── core/             # USB 核心文件
├── class/            # USB 设备类和主机类文件
├── driver_stm32/     # STM32 驱动文件
├── pc_test_tool/     # 基于 Lua Qt 的 Windows USB 测试程序
└── third_part/       # 第三方代码，如 FatFs、rt-thread

目录结构介绍

• TeenyDT: 该目录包含了基于 Lua 的 USB 描述符生成工具，用于生成 USB 设备的描述符。
• sample: 该目录包含了各种示例代码，展示了如何使用 TeenyUSB 实现不同的 USB 设备和主机功能。
• mcu_lib: 该目录包含了 MCU 相关的库文件，支持多种 MCU 平台。
• core: 该目录包含了 TeenyUSB 的核心文件，实现了 USB 协议栈的基本功能。
• class: 该目录包含了 USB 设备类和主机类的实现文件，支持多种 USB 设备类型。
• driver_stm32: 该目录包含了针对 STM32 平台的驱动文件，提供了与 STM32 硬件的接口。
• pc_test_tool: 该目录包含了基于 Lua Qt 的 Windows USB 测试程序，用于测试 USB 设备的功能。
• third_part: 该目录包含了第三方代码，如 FatFs 和 rt-thread，用于扩展 TeenyUSB 的功能。

2. 项目的启动文件介绍

TeenyUSB 项目的启动文件主要位于 sample 目录下，每个示例项目都有一个对应的启动文件。以下是一些常见的启动文件：

示例项目启动文件

• sample/f723dap/main.c: 该文件是 CMSIS DAP 示例项目的启动文件，展示了如何在 STM32F723 上实现 CMSIS DAP 功能。
• sample/f103bulk/main.c: 该文件是 WinUSB 设备示例项目的启动文件，展示了如何在 STM32F103 上实现 WinUSB 设备。
• sample/f107host/main.c: 该文件是 USB 主机示例项目的启动文件，展示了如何在 STM32F107 上实现 USB 主机功能。

启动文件功能介绍

每个启动文件通常包含以下内容：

• 初始化代码: 初始化 MCU 和 USB 外设。
• 主循环: 处理 USB 事件和设备功能。
• 中断处理: 处理 USB 中断事件。

3. 项目的配置文件介绍

TeenyUSB 项目的配置文件主要用于配置 USB 设备和主机的功能。以下是一些常见的配置文件：

配置文件示例

• sample/f723dap/config.h: 该文件用于配置 CMSIS DAP 示例项目的功能，如 USB 速度、设备类型等。
• sample/f103bulk/config.h: 该文件用于配置 WinUSB 设备示例项目的功能，如 Bulk 传输模式、设备描述符等。
• sample/f107host/config.h: 该文件用于配置 USB 主机示例项目的功能，如支持的设备类型、HUB 功能等。

配置文件功能介绍

配置文件通常包含以下内容：

• USB 设备描述符: 定义 USB 设备的描述符，如设备类型、接口数量等。
• USB 速度配置: 配置 USB 设备的工作速度，如全速（FS）或高速（HS）。
• 功能开关: 启用或禁用某些功能，如 HID、MSC、CDC 等。

通过配置文件，用户可以根据需求灵活配置 TeenyUSB 的功能，实现不同的 USB 设备和主机应用。

TeenyUSB Lightweight USB device and host stack for STM32 and other MCUs. Ready for USB 3.0 device. 项目地址: https://gitcode.com/gh_mirrors/te/TeenyUSB