winUSB设备的开发方法 5.00

发布于 2022-05-11 12:13:37 浏览：2896 订阅该版

1、winUSB功能介绍
winUSB设备在win10系统下自带驱动程序的，winUSB设备连接到USB后，可以直接被系统识别，无需安装驱动，实现了免驱的功能。就像键盘、鼠标插入到电脑上直接使用一下。

winUSB设备使用BULK传输，具有传输数据量的优点，设备使用BULK IN, BULK OUT，CONTROL3个端点来进行通信。因此winUSB设备在开发USB产品时是一个很好的选择。

2、winUSB软件选型
    winUSB软件采用RT thread操作系统自带的USB device协议中 Winusb类驱动，此协议栈已经实现了USB的基本功能，具体代码可以参考分享仓库地址：GitHub - longtengmcu/USB-HOST-driver-4G-rndis-device: STM32F429 USB HOST driver 4G rndis device, Realization of high speed Ethernet data communication。

程序在STM32中运行USB连接到WIN10电脑后是可以直接枚举到的，但是具体进行数据通信时要做软件上的修改。

其中对于winUSB部分代码做了改进：

对于winUSB的read部分函数：修改成读取剩余部分的数据，这样在USB主机发送一包数据后就会立即触发接收回调函数来处理数据，原来的写法是接收到输入缓冲区长度的数据后才什么触发接收回调函数。

![image.png](https://oss-club.rt-thread.org/uploads/20220511/a9cb733ada99ca062b68648d8bd87edf.png.webp)

对winusb设备端点IN处理流程中增加对发送整最大包数长度数据的处理，即这种情况下发送一个ZLP，0长度包，让主机知道这次传输完成。

![image.png](https://oss-club.rt-thread.org/uploads/20220511/455997a446b9fe3b4646b40903514e40.png.webp)

到这里，winUSB的驱动部分已经改好了。但是要做USB进行通信还有很多代码要写。

3、winUSB应用程序的编写
       winUSB设备在RT THREAD操作系统中注册成winUSB设备，所以对winUSB的读写要使用设备操作的几个函数rt_device_find, rt_device_open, rt_device_read, rt_device_write。感觉跟其他设备一样，但是在实际调试过程中由于底层是USB设备，用法还是有不少区别的，应用时要做很多特殊的处理。

3.1 winUSB设备的初始化

初始化时跟基他设备类型，find,open，注意除了注册接收回调函数外还要注册发送回调函数。最后必须先调用一下rt_device_read()给winUSB设备接收数据时传入接收数据使用的缓冲区，同时启动USB设备接收。

```
    /* find and open command device */
    dev_name = “winUSB”
    client->device = rt_device_find(dev_name);
    
    if (client->device)
    {
        /* using the tx interrupt when uart is RS485 */
        open_result = rt_device_open(client->device, RT_DEVICE_OFLAG_RDWR);
        
        RT_ASSERT(open_result == RT_EOK);

rt_device_set_tx_complete(client->device, utc_d_tx_ind);
        rt_device_set_rx_indicate(client->device, utc_d_rx_ind);
        client->putc_package = client->utcA_package;

/*wait read the winusb device success */
        while(rt_device_read(client->device, 0, client->putc_package, sizeof(client->utcA_package)) == 0)
        {
            rt_thread_mdelay(10);
        }
    }
    else
    {
        LOG_E("Not find the device(%s).", dev_name);
        result = -RT_ERROR;
    }
```

接收回调函数，USB设备接收到数据后，发送一个信号量给接收数据的线程通知数据处理。这个接收回调函数中使用双缓冲区，让接收数据与处理数据互不干扰。

```
static rt_err_t utc_d_rx_ind(rt_device_t dev, rt_size_t size)
{
    utc_d_client_t client = &utc_d_client;

if(client->package_len)
    {
        LOG_W("utc package overwrite!");
    }
    client->package_len = size;

if(client->putc_package == client->utcA_package)
    {
        client->putc_package = client->utcB_package;
    }
    else
    {
        client->putc_package = client->utcA_package;
    }
    /*read the usb data next */
    rt_device_read(dev, 0, client->putc_package, sizeof(client->utcA_package));

if(size)
    {
        
        /*release the sem */
        rt_sem_release(client->rx_notice);
    }

return RT_EOK;
}
```

发送回调函数，usb设备发送成功后会调用发送回调函数，发送一个信号量，通知发送函数已经成功完成发送，这个功能非常重要，否则，USB设备无法正常工作。

```
static rt_err_t utc_d_tx_ind(rt_device_t dev, void *buffer)
{
    utc_d_client_t client = &utc_d_client;

rt_sem_release(client->tx_notice);
    return RT_EOK;
}
```

usb设备发送函数通过rt_device_write函数把数据发送给usb设备驱动后，一定要等待发送完成才行。

```
static int utc_d_send(utc_d_client_t client, rt_uint8_t *send_data, rt_uint32_t send_len)
{

/*send the packet counter    */
    client->send_packet_counter++;

if(rt_device_write(client->device, 0, send_data, send_len) == send_len)
    {
        /*Must wait the usb send data finish */
        return rt_sem_take(client->tx_notice, RT_WAITING_FOREVER);
    }    
    else
    {
        return -RT_ERROR;
    }
    
}
```

至此，winUSB设备的应用程序基本功能就全部实现，你可以基于此来进行与上位机的数据通信了。

下期预告，winUSB的调试环境搭建与调试方法。
[winUSB的调试环境搭建](https://club.rt-thread.org/ask/article/691e79f4e05eb0fc.html)

aozima 打赏了 5.00 元 2022-05-11 12:21:40

7 条评论

crystal266 2022-05-11

嵌入式

大番茄 2022-06-02

Loves Apple

gerald 2023-07-10

这家伙很懒，什么也没写！

感谢！兜兜转转，还是回到这里仔细研读，终于调通。

但是还有个想请教一下：
在usb设备配置完成后，这段代码的作用是什么，wait的原理是什么，循环读取数据包不会影响app业务上的通讯吗？
```c
/*wait read the winusb device success */
LOG_D("wait usb...");
uint8_t tmp[64];
while(rt_device_read(dev_winusb, 0, tmp, sizeof(tmp)) == 0)
{
	rt_thread_mdelay(10);
}
LOG_D("wait usb done");
```

关于我调试winusb踩的坑在此分享一下：
- **NotImplementedError**:
	1. 驱动问题：搜索关键字 pyusb zadig libusb，使用zadig对RTT Win USB设备安装winusb驱动，之前尝试了libusb_1.0.dll，只能find并print设备信息，对usb设备的读写配置等全部提示NotImplement异常（MSVC下源码编译的dll也不行。。），最后用Zadig安装WinUSB驱动后再BusHound下终于抓到了数据包，然后用pyusb也当然可以成功收到mcu发送的数据包
	2. 端口问题：检查当前EP的地址是否被占用，是否填错，方向是否搞反，这个错误也会报 `NotImplement` 异常。。。 前面的驱动问题或许也有部分是端口填错引起的
- **mcu能发但不能收**
	需要将 `req_type` 修改为 `UIO_REQUEST_READ_BEST`，否则不是不能收，而是收到了没有触发回调打印出来，调试完后再根据业务需求修改为合适的`req_type`
- **pyusb 上位机timeout异常**
	1. 在winusb设备配置完成后，需要上述 `wait usb` 代码段持续读USB设备，否则每次上位机开始执行都会报写超时异常
	2. usb device端的`rt_device_write`虽然成功返回，但usb协议的完整通讯并不一定完成，对于device端每次发送数据包，需要做同步处理，不可在host端还未成功接收数据包时，device自顾自发（也许是发送至fifo中，还未研究，或许会引起数据包混乱），本例中延时较大，可不做同步验证通讯正常

```c
rt_err_t usb_interface_tx_complete(rt_device_t dev, void *buffer)
{
    return rt_sem_release(sem_tx_cplt);
}

void main(void)
{
	for(;;)
	{
		rt_thread_mdelay(2000);
		static uint32_t send = 0x0;
		int wrlen = rt_device_write(dev_winusb, 0, (uint8_t *)&send, sizeof(send));
		rt_sem_take(sem_tx_cplt, RT_WAITING_FOREVER);
		LOG_D("usb write len: %d", wrlen);
		++send;
	}
}
```