USB gadget functionfs

FunctionFS (Function Filesystem) 是 Linux USB Gadget 框架的一部分，专门用于从用户空间实现和控制自定义的 USB 功能。它提供了一种文件系统接口，使用户能够在用户空间中直接定义 USB 设备的接口、端点和描述符，并管理 USB 数据的传输。FunctionFS 常用于需要用户空间控制的复杂 USB 协议和自定义设备功能，比如 USB 音频 (UAC)、视频 (UVC) 或其他特殊用途的设备。

FunctionFS 的工作原理

FunctionFS 将 USB 设备功能暴露给用户空间，允许用户空间应用程序控制 USB 设备的行为。它通过文件系统的方式让用户程序与内核 USB 子系统交互，从而避免了复杂的内核开发，使得 USB 设备的开发和调试更加灵活。

使用 FunctionFS 的步骤

1. 加载内核模块：

   • 首先，确保系统已启用 FunctionFS 支持，并加载相关的 USB Gadget 模块。g_ffs 模块是 FunctionFS 的 Gadget driver，它允许从用户空间定义 USB 功能。

   modprobe g_ffs
   

2. 挂载 FunctionFS：

   • 挂载 FunctionFS 文件系统到一个目录，这个目录将用于配置 USB 功能的接口和端点。通常挂载到 /dev/ffs/<function_name>。

   mkdir -p /dev/ffs/my_function
   mount -t functionfs my_function /dev/ffs/my_function
   

3. 用户空间程序配置：

   • 用户空间程序可以在挂载的 FunctionFS 目录下创建描述符文件和端点文件。描述符文件定义了设备的 USB 描述符（设备描述符、接口描述符、端点描述符等），而端点文件用于读写数据。

   示例代码配置描述符：

   #include <fcntl.h>
   #include <unistd.h>
   #include <sys/types.h>
   #include <sys/stat.h>
   
   int main() {
       int fd = open("/dev/ffs/my_function/ep0", O_RDWR);
       if (fd < 0) {
           perror("Failed to open ep0");
           return 1;
       }
   
       // 在这里写入描述符数据，例如设备描述符、接口描述符等
       // 描述符的详细格式需要根据 USB 协议规范填写
       write(fd, "descriptor data", sizeof("descriptor data"));
   
       close(fd);
       return 0;
   }
   

4. 处理数据传输：

   • 用户空间应用程序可以通过文件读写的方式操作端点文件，处理 USB 数据的收发。例如，数据可以从 ep1 写入，或从 ep2 读取。

   int ep_in = open("/dev/ffs/my_function/ep1", O_WRONLY);
   int ep_out = open("/dev/ffs/my_function/ep2", O_RDONLY);
   
   // 写数据到 IN 端点
   write(ep_in, "data to send", 12);
   
   // 从 OUT 端点读数据
   char buffer[128];
   read(ep_out, buffer, sizeof(buffer));
   

5. 解除挂载：

   • 当不再需要使用该功能时，可以卸载 FunctionFS，并清理相关资源。

   umount /dev/ffs/my_function
   

适用场景

• 自定义 USB 功能：适合需要自定义 USB 功能的场景，例如实现用户定义的协议、特定控制传输的设备等。
• 高层协议支持：非常适合实现高层协议，如 USB 音频（UAC）、视频（UVC）和其他需要复杂控制的设备。
• 用户空间控制：FunctionFS 允许用户空间应用直接控制 USB 数据流，便于调试和开发。

FunctionFS 的优缺点

• 优点：

  • 灵活性：允许用户完全控制 USB 功能的行为，适合快速开发和调试。
  • 用户空间实现：无需频繁修改内核代码，可在用户空间编写逻辑代码，便于开发人员进行调试。
  • 实时性：适合需要快速响应和实时处理的 USB 功能实现。

• 缺点：

  • 实现复杂：由于需要用户空间应用参与控制，开发者需对 USB 协议有深入了解。
  • 性能限制：用户空间与内核空间的频繁交互可能带来一定的性能损耗，尤其在高吞吐量场景下。
  • 数据同步问题：用户空间和内核空间之间的数据同步和延迟控制需要仔细管理。

FunctionFS 和 CONFIGFS 的主要区别

特性	FunctionFS	CONFIGFS
控制层级	用户空间控制，适合自定义 USB 协议和功能	内核空间控制，通过文件系统动态配置 USB 功能
实现复杂度	需要用户空间程序参与数据处理和控制	无需用户空间干预，功能由内核模块直接实现
适用功能	高度自定义的 USB 功能，如音频、视频	标准 USB 功能，如 RNDIS、MTP、Mass Storage
配置方式	挂载到 /dev/ffs，用户程序读写文件配置	挂载到 /sys/kernel/config，内核空间操作
性能	用户空间参与可能增加延迟	内核直接实现，性能更高

总结

• FunctionFS 更灵活，适合自定义 USB 功能并允许用户空间控制，但实现复杂，需要用户程序处理数据流。
• CONFIGFS 更简单，适合标准 USB 功能配置，内核直接管理数据流，配置方便快捷。

选择哪种方式取决于 USB 功能的需求：需要标准功能组合时用 CONFIGFS，需要自定义和用户空间控制时用 FunctionFS。