Pico-PIO-USB 项目使用教程

1. 项目目录结构及介绍

Pico-PIO-USB 项目的目录结构如下：

Pico-PIO-USB/
├── examples/
│   ├── capture_hid_report/
│   ├── usb_device/
│   └── host_hid_to_device_cdc/
├── src/
│   ├── pio_usb.c
│   ├── pio_usb.h
│   └── ...
├── CMakeLists.txt
├── LICENSE
└── README.md

目录结构介绍

• examples/: 包含多个示例程序，展示了如何使用 Pico-PIO-USB 实现不同的 USB 功能。

  • capture_hid_report/: 一个 USB 主机示例程序，用于接收并打印 USB 设备发送的 HID 报告。
  • usb_device/: 一个 HID USB 设备示例程序，模拟鼠标并每 0.5 秒移动一次鼠标光标。
  • host_hid_to_device_cdc/: 类似于 capture_hid_report，但将主机端口的鼠标/键盘报告打印到设备端口的 CDC。

• src/: 包含 Pico-PIO-USB 的核心驱动代码。

  • pio_usb.c: PIO-USB 的主要实现文件。
  • pio_usb.h: PIO-USB 的头文件，定义了相关接口和数据结构。

• CMakeLists.txt: 项目的 CMake 构建配置文件。

• LICENSE: 项目的开源许可证文件，采用 MIT 许可证。

• README.md: 项目的说明文档，包含项目的基本介绍、使用方法和示例。

2. 项目的启动文件介绍

项目的启动文件主要是 examples/ 目录下的示例程序。每个示例程序都是一个独立的应用程序，展示了如何使用 Pico-PIO-USB 实现特定的 USB 功能。

示例程序介绍

• capture_hid_report:

  • 功能: 作为 USB 主机，接收并打印 USB 设备发送的 HID 报告。
  • 启动方式: 通过 CMake 构建后，将生成的 UF2 文件上传到 Raspberry Pi Pico 上运行。

• usb_device:

  • 功能: 模拟一个 HID USB 设备，每 0.5 秒移动一次鼠标光标。
  • 启动方式: 通过 CMake 构建后，将生成的 UF2 文件上传到 Raspberry Pi Pico 上运行。

• host_hid_to_device_cdc:

  • 功能: 从主机端口打印鼠标/键盘报告到设备端口的 CDC。
  • 启动方式: 通过 CMake 构建后，将生成的 UF2 文件上传到 Raspberry Pi Pico 上运行。

3. 项目的配置文件介绍

项目的配置文件主要是 CMakeLists.txt，它定义了项目的构建配置。

CMakeLists.txt 介绍

CMakeLists.txt 文件的主要内容如下：

cmake_minimum_required(VERSION 3.13)

project(Pico-PIO-USB)

# 设置编译器选项
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Werror")

# 添加源文件
add_executable(capture_hid_report examples/capture_hid_report/main.c src/pio_usb.c)
add_executable(usb_device examples/usb_device/main.c src/pio_usb.c)
add_executable(host_hid_to_device_cdc examples/host_hid_to_device_cdc/main.c src/pio_usb.c)

# 设置目标属性
target_include_directories(capture_hid_report PRIVATE src)
target_include_directories(usb_device PRIVATE src)
target_include_directories(host_hid_to_device_cdc PRIVATE src)

# 添加 Pico SDK
include($ENV{PICO_SDK_PATH}/external/pico_sdk_import.cmake)
pico_sdk_init()

# 设置 Pico 目标
pico_add_extra_outputs(capture_hid_report)
pico_add_extra_outputs(usb_device)
pico_add_extra_outputs(host_hid_to_device_cdc)

配置文件功能

• 编译器选项: 设置了编译器的警告和错误选项。
• 源文件: 定义了每个示例程序的源文件和依赖。
• 目标属性: 设置了每个目标的包含目录。
• Pico SDK: 引入了 Pico SDK，并初始化。
• Pico 目标: 为每个示例程序生成了额外的输出文件（如 UF2 文件）。

通过这些配置，用户可以方便地构建和运行 Pico-PIO-USB 项目中的示例程序。