TinyUSB RNDIS网络设备:嵌入式系统以太网-over-USB实现

TinyUSB RNDIS网络设备:嵌入式系统以太网-over-USB实现

【免费下载链接】tinyusb An open source cross-platform USB stack for embedded system 【免费下载链接】tinyusb 项目地址: https://gitcode.com/gh_mirrors/ti/tinyusb

引言:嵌入式网络连接的痛点与解决方案

你是否曾面临嵌入式系统需要网络功能但缺乏物理以太网接口的困境?是否在寻找一种无需额外硬件即可实现网络通信的方法?本文将详细介绍如何使用TinyUSB库的RNDIS(Remote Network Driver Interface Specification,远程网络驱动接口规范)类实现嵌入式设备的以太网-over-USB功能,通过USB接口模拟以太网连接,为资源受限的嵌入式系统提供高效、可靠的网络解决方案。

读完本文后,你将能够:

  • 理解RNDIS协议的工作原理及其在嵌入式系统中的应用价值
  • 使用TinyUSB库快速实现RNDIS网络设备
  • 配置和优化嵌入式网络参数,如IP地址、DHCP服务和DNS服务
  • 构建完整的嵌入式Web服务器应用
  • 解决常见的RNDIS设备兼容性问题

RNDIS协议概述

RNDIS协议简介

RNDIS是微软提出的一种网络设备规范,允许USB设备模拟以太网接口,使主机操作系统能够通过USB连接识别并与网络设备通信。与传统的USB CDC-ECM(Ethernet Control Model)相比,RNDIS在Windows系统中具有更好的原生支持,无需额外安装驱动程序。

RNDIS协议基于NDIS(Network Driver Interface Specification)架构,定义了USB设备与主机之间的通信协议和数据格式。通过RNDIS,嵌入式设备可以像标准以太网设备一样被主机识别,支持TCP/IP协议栈,实现网络通信功能。

RNDIS通信流程

RNDIS设备与主机之间的通信主要包括以下几个阶段:

mermaid

RNDIS消息类型

TinyUSB定义了多种RNDIS消息类型,用于设备与主机之间的控制和数据传输:

typedef enum
{
  RNDIS_MSG_PACKET           = 0x00000001UL, ///< 用于发送网络数据
  RNDIS_MSG_INITIALIZE       = 0x00000002UL, ///< 主机发送初始化设备
  RNDIS_MSG_INITIALIZE_CMPLT = 0x80000002UL, ///< 设备响应初始化
  RNDIS_MSG_HALT             = 0x00000003UL, ///< 主机发送停止设备
  RNDIS_MSG_QUERY            = 0x00000004UL, ///< 主机查询OID
  RNDIS_MSG_QUERY_CMPLT      = 0x80000004UL, ///< 设备响应查询
  RNDIS_MSG_SET              = 0x00000005UL, ///< 主机设置OID
  RNDIS_MSG_SET_CMPLT        = 0x80000005UL, ///< 设备响应设置
  RNDIS_MSG_RESET            = 0x00000006UL, ///< 主机发送重置
  RNDIS_MSG_RESET_CMPLT      = 0x80000006UL, ///< 设备响应重置
  RNDIS_MSG_INDICATE_STATUS  = 0x00000007UL, ///< 设备指示状态
  RNDIS_MSG_KEEP_ALIVE       = 0x00000008UL, ///< 主机发送保活
  RNDIS_MSG_KEEP_ALIVE_CMPLT = 0x80000008UL  ///< 设备响应保活
} rndis_msg_type_t;

NDIS对象标识符(OID)

RNDIS使用NDIS对象标识符(OID)来查询和设置设备参数。常见的OID包括:

typedef enum
{
  // 通用OIDs
  RNDIS_OID_GEN_SUPPORTED_LIST      = 0x00010101, ///< 支持的OID列表
  RNDIS_OID_GEN_HARDWARE_STATUS     = 0x00010102, ///< 硬件状态
  RNDIS_OID_GEN_MEDIA_SUPPORTED     = 0x00010103, ///< 支持的媒体类型
  RNDIS_OID_GEN_MEDIA_IN_USE        = 0x00010104, ///< 当前使用的媒体类型
  RNDIS_OID_GEN_MAXIMUM_FRAME_SIZE  = 0x00010106, ///< 最大帧大小
  RNDIS_OID_GEN_LINK_SPEED          = 0x00010107, ///< 链路速度
  RNDIS_OID_GEN_CURRENT_PACKET_FILTER=0x0001010E, ///< 当前数据包过滤器
  
  // 802.3 (以太网) OIDs
  RNDIS_OID_802_3_PERMANENT_ADDRESS = 0x01010101, ///< 永久MAC地址
  RNDIS_OID_802_3_CURRENT_ADDRESS   = 0x01010102, ///< 当前MAC地址
  RNDIS_OID_802_3_MULTICAST_LIST    = 0x01010103  ///< 多播地址列表
} rndis_oid_type_t;

TinyUSB RNDIS实现架构

TinyUSB网络类驱动架构

TinyUSB提供了完整的RNDIS协议实现,其网络类驱动架构如下:

mermaid

TinyUSB的RNDIS实现主要包含以下组件:

  • 网络设备抽象层:提供统一的网络设备接口
  • ECM/RNDIS设备驱动:实现USB网络设备功能
  • RNDIS协议处理:处理RNDIS消息和OID查询
  • lwIP协议栈集成:提供TCP/IP协议支持

RNDIS数据结构

TinyUSB定义了多种RNDIS消息结构,用于设备与主机之间的通信:

初始化消息结构

typedef struct {
  uint32_t type;          ///< 消息类型,必须为RNDIS_MSG_INITIALIZE
  uint32_t length;        ///< 消息长度,必须为0x18
  uint32_t request_id;    ///< 请求ID,用于匹配请求和响应
  uint32_t major_version; ///< 主机实现的RNDIS主版本号
  uint32_t minor_version; ///< 主机实现的RNDIS次版本号
  uint32_t max_xfer_size; ///< 主机期望接收的最大传输大小
} rndis_msg_initialize_t;

数据包消息结构

typedef struct {
  uint32_t type;                          ///< 消息类型,必须为RNDIS_MSG_PACKET
  uint32_t length;                        ///< 消息总长度
  uint32_t data_offset;                   ///< 数据偏移量
  uint32_t data_length;                   ///< 数据长度
  uint32_t out_of_band_data_offet;        ///< 带外数据偏移量
  uint32_t out_of_band_data_length;       ///< 带外数据长度
  uint32_t num_out_of_band_data_elements; ///< 带外数据元素数量
  uint32_t per_packet_info_offset;        ///< 每包信息偏移量
  uint32_t per_packet_info_length;        ///< 每包信息长度
  uint32_t reserved[2];                   ///< 保留字段
  uint32_t payload[0];                    ///< 网络数据负载
} rndis_msg_packet_t;

快速上手:实现RNDIS网络设备

环境准备

在开始之前,请确保你已准备好以下环境:

  • 支持USB Device功能的嵌入式开发板(如STM32、ESP32等)
  • TinyUSB库源码(从https://gitcode.com/gh_mirrors/ti/tinyusb获取)
  • 交叉编译工具链
  • 终端仿真器(如PuTTY、minicom等)
  • Web浏览器(用于测试Web服务器)

配置TinyUSB

首先,需要在TinyUSB配置文件中启用RNDIS功能。创建或修改tusb_config.h文件:

// 启用设备栈
#define CFG_TUD_ENABLED 1

// 启用ECM/RNDIS网络类
#define CFG_TUD_ECM_RNDIS 1

// 设置网络MTU(最大传输单元)
#define CFG_TUD_NET_MTU 1500

// 设置网络数据包缓冲区大小
#define CFG_TUD_NET_PACKET_SIZE (CFG_TUD_NET_MTU + 128)

// 设置USB端点大小
#define CFG_TUD_NET_ENDPOINT_SIZE 64

实现RNDIS设备核心功能

以下是实现RNDIS网络设备的核心代码:

#include "tusb.h"
#include "bsp/board_api.h"
#include "lwip/init.h"
#include "lwip/netif.h"
#include "dhserver.h"
#include "dnserver.h"
#include "httpd.h"

// 网络接口结构
static struct netif netif_data;

// MAC地址(建议第一个字节为0x02,表示链路本地地址)
uint8_t tud_network_mac_address[6] = {0x02, 0x02, 0x84, 0x6A, 0x96, 0x00};

// 网络参数配置
static const ip4_addr_t ipaddr  = INIT_IP4(192, 168, 7, 1);  // 设备IP地址
static const ip4_addr_t netmask = INIT_IP4(255, 255, 255, 0); // 子网掩码
static const ip4_addr_t gateway = INIT_IP4(0, 0, 0, 0);       // 网关地址

// DHCP服务器配置
static dhcp_entry_t dhcp_entries[] = {
  {{0}, INIT_IP4(192, 168, 7, 2), 24 * 60 * 60}, // IP地址租约24小时
  {{0}, INIT_IP4(192, 168, 7, 3), 24 * 60 * 60},
  {{0}, INIT_IP4(192, 168, 7, 4), 24 * 60 * 60}
};

static const dhcp_config_t dhcp_config = {
  .router = INIT_IP4(0, 0, 0, 0),
  .port = 67,
  .dns = INIT_IP4(192, 168, 7, 1),  // DNS服务器地址
  "usb",                           // DNS后缀
  TU_ARRAY_SIZE(dhcp_entries),
  dhcp_entries
};

// 初始化lwIP协议栈
static void init_lwip(void) {
  struct netif *netif = &netif_data;
  
  lwip_init();
  
  // 设置网络接口参数
  netif->hwaddr_len = sizeof(tud_network_mac_address);
  memcpy(netif->hwaddr, tud_network_mac_address, sizeof(tud_network_mac_address));
  netif->hwaddr[5] ^= 0x01;  // 确保与主机MAC地址不同
  
  // 添加网络接口
  netif = netif_add(netif, &ipaddr, &netmask, &gateway, NULL, netif_init_cb, ethernet_input);
  netif_set_default(netif);
  netif_set_up(netif);
}

// 网络接收回调函数
bool tud_network_recv_cb(const uint8_t *src, uint16_t size) {
  struct pbuf *p;
  
  if (size == 0) return true;
  
  // 分配pbuf缓冲区
  p = pbuf_alloc(PBUF_RAW, size, PBUF_POOL);
  if (p == NULL) {
    printf("Failed to allocate pbuf\n");
    return false;
  }
  
  // 复制数据到pbuf
  pbuf_take(p, src, size);
  
  // 将数据包传递给lwIP协议栈
  if (netif_input(p, &netif_data) != ERR_OK) {
    pbuf_free(p);
  }
  
  // 通知TinyUSB可以接收新的数据包
  tud_network_recv_renew();
  
  return true;
}

// 网络发送回调函数
uint16_t tud_network_xmit_cb(uint8_t *dst, void *ref, uint16_t arg) {
  struct pbuf *p = (struct pbuf *)ref;
  
  // 复制pbuf数据到目标缓冲区
  return pbuf_copy_partial(p, dst, p->tot_len, 0);
}

int main(void) {
  // 初始化硬件
  board_init();
  
  // 初始化TinyUSB
  tusb_init(BOARD_TUD_RHPORT, TUSB_ROLE_DEVICE);
  
  // 初始化lwIP协议栈
  init_lwip();
  
  // 启动DHCP服务器
  dhserv_init(&dhcp_config);
  
  // 启动DNS服务器
  dnserv_init(IP_ADDR_ANY, 53, dns_query_proc);
  
  // 启动HTTP服务器
  httpd_init();
  
  printf("RNDIS network device initialized\n");
  printf("IP address: 192.168.7.1\n");
  
  // 主循环
  while (1) {
    // 处理USB事件
    tud_task();
    
    // 处理lwIP定时器
    sys_check_timeouts();
    
    // 延时
    board_delay(1);
  }
  
  return 0;
}

USB描述符配置

RNDIS设备需要正确的USB描述符才能被主机识别。以下是USB配置描述符的示例:

// USB配置描述符
const uint8_t configuration_descriptor[] = {
  // 配置描述符
  TUD_CONFIG_DESCRIPTOR(1, ITF_NUM_TOTAL, 0, CONFIG_TOTAL_LEN, TUSB_DESC_CONFIG_ATT_REMOTE_WAKEUP, 100),
  
  // RNDIS控制接口
  TUD_RNDIS_DESCRIPTOR(ITF_NUM_RNDIS, 0, EP_RNDIS_NOTIF, EP_SIZE_NOTIF, EP_RNDIS_IN, EP_RNDIS_OUT, EP_SIZE_RNDIS),
  
  // 数据接口
  TUD_CDC_DATA_DESCRIPTOR(ITF_NUM_RNDIS_DATA, 0, EP_RNDIS_IN, EP_RNDIS_OUT, EP_SIZE_RNDIS)
};

编译和烧录

完成代码编写后,使用适当的编译工具链编译项目,并将生成的固件烧录到嵌入式开发板中:

# 编译项目
make -j

# 烧录固件(以STM32为例)
make flash

构建Web服务器应用

初始化Web服务器

TinyUSB的RNDIS示例中集成了简单的Web服务器。以下是初始化Web服务器的代码:

// HTTP请求处理函数
static const char *http_index_html = 
  "<html><head><title>TinyUSB RNDIS Demo</title></head>"
  "<body><h1>TinyUSB RNDIS Demo</h1>"
  "<p>Hello from TinyUSB RNDIS Web Server!</p>"
  "<p>MAC Address: %02X:%02X:%02X:%02X:%02X:%02X</p>"
  "<p>IP Address: %s</p>"
  "</body></html>";

// HTTP请求处理函数
static void http_process_request(struct httpd_state *pvar, char *req) {
  char ipstr[16];
  char macstr[20];
  
  // 格式化IP地址和MAC地址
  ip4addr_ntoa_r(&netif_data.ip_addr, ipstr, sizeof(ipstr));
  sprintf(macstr, "%02X:%02X:%02X:%02X:%02X:%02X",
          tud_network_mac_address[0], tud_network_mac_address[1],
          tud_network_mac_address[2], tud_network_mac_address[3],
          tud_network_mac_address[4], tud_network_mac_address[5]);
  
  // 发送HTTP响应
  httpd_resp_ok(pvar, "text/html", strlen(http_index_html) + 100);
  httpd_send(pvar, http_index_html, strlen(http_index_html));
  
  // 替换占位符
  httpd_send(pvar, macstr, strlen(macstr));
  httpd_send(pvar, ipstr, strlen(ipstr));
}

// 初始化HTTP服务器
void httpd_init(void) {
  httpd_register_handler("/", http_process_request);
  httpd_start();
}

测试Web服务器

  1. 将开发板通过USB连接到主机
  2. 等待主机识别RNDIS设备(可能需要几秒钟)
  3. 主机将获得192.168.7.x网段的IP地址
  4. 在浏览器中访问http://192.168.7.1
  5. 你应该能看到Web服务器的欢迎页面

高级配置与优化

网络参数优化

根据实际应用需求,可以调整以下网络参数以获得更好的性能:

// 设置DHCP租约时间(秒)
#define DHCP_LEASE_TIME 86400  // 24小时

// 设置DNS缓存时间(秒)
#define DNS_TTL 3600  // 1小时

// 设置TCP接收窗口大小
#define TCP_WND 4096

// 设置TCP发送缓冲区大小
#define TCP_SND_BUF 2048

// 设置ARP缓存超时时间(秒)
#define ARP_TMR_INTERVAL 30

电源管理优化

对于电池供电的嵌入式设备,可以通过以下方式优化电源消耗:

// 启用USB远程唤醒
#define CFG_TUD_REMOTE_WAKEUP 1

// 实现空闲状态检测
static void power_manage(void) {
  if (tud_suspended()) {
    // 进入深度睡眠模式
    board_power_down();
  } else {
    // 进入普通睡眠模式
    board_sleep();
  }
}

// 在主循环中调用电源管理函数
while (1) {
  tud_task();
  sys_check_timeouts();
  
  // 每100ms检查一次电源状态
  static uint32_t last_power_check = 0;
  if (board_millis() - last_power_check > 100) {
    power_manage();
    last_power_check = board_millis();
  }
}

链路状态控制

TinyUSB提供了链路状态控制功能,可以模拟以太网电缆的插拔状态:

// 切换网络链路状态(UP/DOWN)
void toggle_link_state(void) {
  static bool link_up = true;
  
  link_up = !link_up;
  if (link_up) {
    printf("Link state: UP\n");
    netif_set_link_up(&netif_data);
  } else {
    printf("Link state: DOWN\n");
    netif_set_link_down(&netif_data);
  }
  
  // 通知USB主机链路状态变化
  tud_network_link_state(BOARD_TUD_RHPORT, link_up);
}

// 按键中断处理函数,用于切换链路状态
void button_isr(void) {
  toggle_link_state();
}

常见问题与解决方案

设备无法被Windows识别

问题:将RNDIS设备连接到Windows主机后,设备无法被正确识别。

解决方案

  1. 确保USB描述符正确配置,特别是RNDIS接口类、子类和协议字段:

    #define TUD_RNDIS_ITF_CLASS    0x02  // 通信类
    #define TUD_RNDIS_ITF_SUBCLASS 0x06  // 以太网控制模型
    #define TUD_RNDIS_ITF_PROTOCOL 0x00  // RNDIS协议
    
  2. 尝试修改MAC地址的第一个字节,将其设置为0x00(清除第1位):

    uint8_t tud_network_mac_address[6] = {0x00, 0x02, 0x84, 0x6A, 0x96, 0x00};
    
  3. 手动安装RNDIS驱动程序:

    • 打开设备管理器,找到未知设备
    • 右键选择"更新驱动程序"
    • 选择"浏览我的计算机以查找驱动程序软件"
    • 选择"让我从计算机上的可用驱动程序列表中选取"
    • 选择"网络适配器"
    • 选择"Microsoft" -> "Remote NDIS Compatible Device"

网络速度慢或不稳定

问题:RNDIS网络连接速度慢或不稳定,经常断开连接。

解决方案

  1. 调整USB端点大小和缓冲区大小:

    // 增加端点大小(最大64字节)
    #define CFG_TUD_NET_ENDPOINT_SIZE 64
    
    // 增加发送和接收缓冲区大小
    #define CFG_TUD_NET_TX_BUFFERS 4
    #define CFG_TUD_NET_RX_BUFFERS 4
    
  2. 优化lwIP协议栈配置:

    // 增加TCP窗口大小
    #define TCP_WND (4 * TCP_MSS)
    
    // 启用TCP拥塞控制
    #define TCP_CONGestionCONTROL 1
    
    // 增加ARP缓存大小
    #define ARP_TABLE_SIZE 10
    
  3. 减少USB中断处理时间:

    • 避免在中断处理函数中执行耗时操作
    • 使用DMA传输大数据块
    • 优化数据复制操作

兼容性问题

问题:RNDIS设备在某些操作系统上工作正常,但在其他操作系统上无法使用。

解决方案

  1. 实现ECM/RNDIS双模式支持:

    // 在配置描述符中同时包含ECM和RNDIS接口
    #define CFG_TUD_ECM_RNDIS 1
    
    // 在USB描述符中设置接口优先级
    #define PREFER_ECM 0  // 0: 优先RNDIS, 1: 优先ECM
    
  2. 针对不同操作系统调整设备行为:

    // 检测主机操作系统类型
    static uint8_t detect_host_os(void) {
      // 通过分析RNDIS初始化消息判断操作系统
      if (rndis_init_msg.major_version == 1 && rndis_init_msg.minor_version == 0) {
        return OS_WINDOWS;  // Windows
      } else if (rndis_init_msg.major_version == 1 && rndis_init_msg.minor_version == 5) {
        return OS_LINUX;    // Linux
      } else if (rndis_init_msg.major_version == 2 && rndis_init_msg.minor_version == 0) {
        return OS_MACOS;    // macOS
      }
      return OS_UNKNOWN;
    }
    
    // 根据操作系统类型调整行为
    if (detect_host_os() == OS_MACOS) {
      // macOS特定配置
      #define MACOS_COMPAT 1
    }
    

结论与展望

本文详细介绍了如何使用TinyUSB库实现RNDIS网络设备,包括协议原理、实现步骤、应用开发和优化方法。通过RNDIS技术,嵌入式设备可以通过USB接口模拟以太网连接,为资源受限的系统提供网络功能。

TinyUSB的RNDIS实现具有以下优势:

  • 跨平台兼容性好,支持Windows、Linux、macOS等主流操作系统
  • 代码体积小,适合资源受限的嵌入式系统
  • 易于集成,提供与lwIP等协议栈的无缝对接
  • 高度可配置,可根据应用需求调整参数

未来,RNDIS技术在嵌入式系统中的应用将更加广泛,特别是在物联网、工业控制和消费电子领域。随着USB4和USB-C的普及,RNDIS设备将获得更高的传输速度和更好的兼容性,为嵌入式系统提供更强大的网络连接能力。

参考资料

  1. TinyUSB官方文档
  2. Remote Network Driver Interface Specification (RNDIS) Version 1.0
  3. lwIP协议栈官方文档
  4. USB Device Class Definition for Communication Devices
  5. USB in a NutShell - An Introduction to USB 1.1 and 2.0

通过本文的介绍,相信你已经掌握了使用TinyUSB实现RNDIS网络设备的方法。现在,你可以将这一技术应用到自己的嵌入式项目中,为设备添加强大的网络功能。祝你开发顺利!

【免费下载链接】tinyusb An open source cross-platform USB stack for embedded system 【免费下载链接】tinyusb 项目地址: https://gitcode.com/gh_mirrors/ti/tinyusb

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值