1# USB DDK开发指导 2 3## 场景介绍 4 5USB DDK（USB Driver Develop Kit）是为开发者提供的USB驱动程序开发套件，支持开发者基于用户态，在应用层开发USB设备驱动。提供了一系列主机侧访问设备的接口，包括主机侧打开和关闭接口、管道同步异步读写通信、控制传输、中断传输等。 6 7## 接口说明 8 9| 名称 | 描述 | 10| -------- | -------- | 11| OH_Usb_Init(void) | 初始化DDK。 | 12| OH_Usb_Release(void) | 释放DDK。 | 13| OH_Usb_GetDeviceDescriptor(uint64_t deviceId, struct UsbDeviceDescriptor *desc) | 获取设备描述符。 | 14| OH_Usb_GetConfigDescriptor(uint64_t deviceId, uint8_t configIndex, struct UsbDdkConfigDescriptor **const config) | 获取配置描述符。请在描述符使用完后使用OH_Usb_FreeConfigDescriptor()释放描述符，否则会造成内存泄露。 | 15| OH_Usb_FreeConfigDescriptor(const struct UsbDdkConfigDescriptor *const config) | 释放配置描述符，请在描述符使用完后释放描述符，否则会造成内存泄露。 | 16| OH_Usb_ClaimInterface(uint64_t deviceId, uint8_t interfaceIndex, uint64_t *interfaceHandle) | 声明接口。 | 17| OH_Usb_SelectInterfaceSetting(uint64_t interfaceHandle, uint8_t settingIndex) | 激活接口的备用设置。 | 18| OH_Usb_GetCurrentInterfaceSetting(uint64_t interfaceHandle, uint8_t \*settingIndex) | 获取接口当前激活的备用设置。 | 19| OH_Usb_SendControlReadRequest(uint64_t interfaceHandle, const struct UsbControlRequestSetup \*setup, uint32_t timeout, uint8_t \*data, uint32_t \*dataLen) | 发送控制读请求，该接口为同步接口。 | 20| OH_Usb_SendControlWriteRequest(uint64_t interfaceHandle, const struct UsbControlRequestSetup \*setup, uint32_t, const uint8_t \*data, uint32_t dataLen) | 发送控制写请求，该接口为同步接口。 | 21| OH_Usb_ReleaseInterface(uint64_t interfaceHandle) | 释放接口。 | 22| OH_Usb_SendPipeRequest(const struct UsbRequestPipe *pipe, UsbDeviceMemMap *devMmap) | 发送管道请求，该接口为同步接口。中断传输和批量传输都使用该接口发送请求。 | 23| OH_Usb_CreateDeviceMemMap(uint64_t deviceId, size_t size, UsbDeviceMemMap **devMmap) | 创建缓冲区。请在缓冲区使用完后，调用OH_Usb_DestroyDeviceMemMap()销毁缓冲区，否则会造成资源泄露。 | 24| OH_Usb_DestroyDeviceMemMap(UsbDeviceMemMap *devMmap) | 销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区，否则会造成资源泄露。 | 25 26详细的接口说明请参考[USB DDK](../reference/native-apis/_usb_ddk.md)。 27 28## USB DDK开发步骤 29 30以下步骤描述了如何使用 **USB DDK**开发USB驱动： 31 32**添加动态链接库** 33 34CMakeLists.txt中添加以下lib。 35```txt 36libusb_ndk.z.so 37``` 38 39**头文件** 40```c++ 41#include <usb/usb_ddk_api.h> 42#include <usb/usb_ddk_types.h> 43``` 44 451. **获取设备描述符**。使用 **usb_ddk_api.h** 的 **OH_Usb_Init** 接口初始化DDK，并使用 **OH_Usb_GetDeviceDescriptor**获取到设备描述符。 46 47 ```c++ 48 // 初始化USB DDK 49 OH_Usb_Init(); 50 struct UsbDeviceDescriptor devDesc; 51 uint64_t deviceId = 0; 52 // 获取设备描述符 53 OH_Usb_GetDeviceDescriptor(deviceId, &devDesc); 54 ``` 55 562. **获取配置描述符及声明接口**。使用 **usb_ddk_api.h** 的 **OH_Usb_GetConfigDescriptor** 接口获取配置描述符 **config**，并使用 **OH_Usb_ClaimInterface** 声明接口。 57 58 ```c++ 59 struct UsbDdkConfigDescriptor *config = nullptr; 60 // 获取配置描述符 61 OH_Usb_GetConfigDescriptor(deviceId, 1, &config); 62 // 根据配置描述符,找到所需要通信的interfaceIndex 63 uint8_t interfaceIndex = 0; 64 // 声明接口 65 uint64_t interfaceHandle = 0; 66 OH_Usb_ClaimInterface(deviceId, interfaceIndex, &interfaceHandle); 67 // 释放配置描述符 68 OH_Usb_FreeConfigDescriptor(config); 69 ``` 703. **获取当前激活接口的备用设置及激活备用设置**。使用 **usb_ddk_api.h** 的 **OH_Usb_GetCurrentInterfaceSetting** 获取备用设置，并使用 **OH_Usb_SelectInterfaceSetting** 激活备用设置 71 72 ```c++ 73 uint8_t settingIndex = 0; 74 // 接口获取备用设置 75 OH_Usb_GetCurrentInterfaceSetting(interfaceHandle, &settingIndex); 76 77 // 激活备用设置 78 OH_Usb_SelectInterfaceSetting(interfaceHandle, &settingIndex); 79 ``` 804. **发送控制读请求、发送控制写请求**。使用 **usb_ddk_api.h** 的**OH_Usb_SendControlReadRequest**发送控制读请求，或者使用**OH_Usb_SendControlWriteRequest**发送控制写请求。 81 82 ```c++ 83 // 超时时间，设置为1s; 84 uint32_t timeout = 1000; 85 86 struct UsbControlRequestSetup setupRead; 87 setupRead.bmRequestType = 0x80; 88 setupRead.bRequest = 0x08; 89 setupRead.wValue = 0; 90 setupRead.wIndex = 0; 91 setupRead.wLength = 0x01; 92 uint8_t dataRead[256] = {0}; 93 uint32_t dataReadLen = 256; 94 // 发送控制读请求 95 OH_Usb_SendControlReadRequest(interfaceHandle, &setupRead, timeout, dataRead, &dataReadLen); 96 97 struct UsbControlRequestSetup setupWrite; 98 setupWrite.bmRequestType = 0; 99 setupWrite.bRequest = 0x09; 100 setupWrite.wValue = 1; 101 setupWrite.wIndex = 0; 102 setupWrite.wLength = 0; 103 uint8_t dataWrite[256] = {0}; 104 uint32_t dataWriteLen = 256; 105 // 发送控制写请求 106 OH_Usb_SendControlWriteRequest(interfaceHandle, &setupWrite, timeout, dataWrite, &dataWriteLen); 107 ``` 108 1095. **创建内存映射缓冲区及发送请求**。使用 **usb_ddk_api.h** 的**OH_Usb_CreateDeviceMemMap**接口创建内存映射缓冲区**devMmap**，并使用**OH_Usb_SendPipeRequest**发送请求。 110 111 ```c++ 112 struct UsbDeviceMemMap *devMmap = nullptr; 113 // 创建用于存放数据的缓冲区 114 size_t bufferLen = 10; 115 OH_Usb_CreateDeviceMemMap(deviceId, bufferLen, &devMmap); 116 struct UsbRequestPipe pipe; 117 pipe.interfaceHandle = interfaceHandle; 118 // 根据配置描述符找到所要通信的端点 119 pipe.endpoint = 128; 120 pipe.timeout = UINT32_MAX; 121 // 发送请求 122 OH_Usb_SendPipeRequest(&pipe, devMmap); 123 ``` 124 1256. **释放资源**。在所有请求处理完毕，程序退出前，使用 **usb_ddk_api.h** 的 **OH_Usb_DestroyDeviceMemMap** 接口销毁缓冲区。使用**OH_Usb_ReleaseInterface**释放接口。使用**OH_Usb_Release**释放USB DDK。 126 127 ```c++ 128 // 销毁缓冲区 129 OH_Usb_DestroyDeviceMemMap(devMmap); 130 // 释放接口 131 OH_Usb_ReleaseInterface(interfaceHandle); 132 // 释放USB DDK 133 OH_Usb_Release(); 134 ```