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_ReleaseInterface(uint64_t interfaceHandle) | 释放接口。 | 18| OH_Usb_SendPipeRequest(const struct UsbRequestPipe *pipe, UsbDeviceMemMap *devMmap) | 发送管道请求，该接口为同步接口。中断传输和批量传输都使用该接口发送请求。 | 19| OH_Usb_CreateDeviceMemMap(uint64_t deviceId, size_t size, UsbDeviceMemMap **devMmap) | 创建缓冲区。请在缓冲区使用完后，调用OH_Usb_DestroyDeviceMemMap()销毁缓冲区，否则会造成资源泄露。 | 20| OH_Usb_DestroyDeviceMemMap(UsbDeviceMemMap *devMmap) | 销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区，否则会造成资源泄露。 | 21 22详细的接口说明请参考[USB DDK](../reference/native-apis/_usb_ddk.md)。 23 24## USB DDK开发步骤 25 26以下步骤描述了如何使用 **USB DDK**开发USB驱动： 27 28**添加动态链接库** 29 30CMakeLists.txt中添加以下lib。 31```txt 32libusb_ndk.z.so 33``` 34 35**头文件** 36```c++ 37#include <usb/usb_ddk_api.h> 38#include <usb/usb_ddk_types.h> 39``` 40 411. **获取设备描述符**。使用 **usb_ddk_api.h** 的 **OH_Usb_Init** 接口初始化DDK，并使用 **OH_Usb_GetDeviceDescriptor**获取到设备描述符。 42 43 ```c++ 44 // 初始化USB DDK 45 OH_Usb_Init(); 46 struct UsbDeviceDescriptor devDesc; 47 uint64_t deviceId = 0; 48 // 获取设备描述符 49 OH_Usb_GetDeviceDescriptor(deviceId, &devDesc); 50 ``` 51 522. **获取配置描述符及声明接口**。使用 **usb_ddk_api.h** 的 **OH_Usb_GetConfigDescriptor** 接口获取配置描述符 **config**，并使用 **OH_Usb_ClaimInterface** 声明接口。 53 54 ```c++ 55 struct UsbDdkConfigDescriptor *config = nullptr; 56 // 获取配置描述符 57 OH_Usb_GetConfigDescriptor(deviceId, 1, &config); 58 // 根据配置描述符,找到所需要通信的interfaceIndex 59 uint8_t interfaceIndex = 0; 60 // 声明接口 61 uint64_t interfaceHandle = 0; 62 OH_Usb_ClaimInterface(deviceId, interfaceIndex, &interfaceHandle); 63 // 释放配置描述符 64 OH_Usb_FreeConfigDescriptor(config); 65 ``` 66 673. **创建内存映射缓冲区及发送请求**。使用 **usb_ddk_api.h** 的**OH_Usb_CreateDeviceMemMap**接口创建内存映射缓冲区**devMmap**，并使用**OH_Usb_SendPipeRequest**发送请求。 68 69 ```c++ 70 struct UsbDeviceMemMap *devMmap = nullptr; 71 // 创建用于存放数据的缓冲区 72 size_t bufferLen = 10; 73 OH_Usb_CreateDeviceMemMap(deviceId, bufferLen, &devMmap); 74 struct UsbRequestPipe pipe; 75 pipe.interfaceHandle = interfaceHandle; 76 // 根据配置描述符找到所要通信的端点 77 pipe.endpoint = 128; 78 pipe.timeout = UINT32_MAX; 79 // 发送请求 80 OH_Usb_SendPipeRequest(&pipe, devMmap); 81 ``` 82 834. **释放资源**。在所有请求处理完毕，程序退出前，使用 **usb_ddk_api.h** 的 **OH_Usb_DestroyDeviceMemMap** 接口销毁缓冲区。使用**OH_Usb_ReleaseInterface**释放接口。使用**OH_Usb_Release**释放USB DDK。 84 85 ```c++ 86 // 销毁缓冲区 87 OH_Usb_DestroyDeviceMemMap(devMmap); 88 // 释放接口 89 OH_Usb_ReleaseInterface(interfaceHandle); 90 // 释放USB DDK 91 OH_Usb_Release(); 92 ```