HarmonyOS驱动开发：USB驱动程序开发套件

场景介绍

USB DDK（USB Driver Develop Kit）是为开发者提供的USB驱动程序开发套件，支持开发者基于用户态，在应用层开发USB设备驱动。提供了一系列主机侧访问设备的接口，包括主机侧打开和关闭接口、管道同步异步读写通信、控制传输、中断传输等。

接口说明

名称	描述
OH_Usb_Init(void)	初始化DDK。
OH_Usb_Release(void)	释放DDK。
OH_Usb_GetDeviceDescriptor(uint64_t deviceId, struct UsbDeviceDescriptor *desc)	获取设备描述符。
OH_Usb_GetConfigDescriptor(uint64_t deviceId, uint8_t configIndex, struct UsbDdkConfigDescriptor **const config)	获取配置描述符。请在描述符使用完后使用OH_Usb_FreeConfigDescriptor()释放描述符，否则会造成内存泄露。
OH_Usb_FreeConfigDescriptor(const struct UsbDdkConfigDescriptor *const config)	释放配置描述符，请在描述符使用完后释放描述符，否则会造成内存泄露。
OH_Usb_ClaimInterface(uint64_t deviceId, uint8_t interfaceIndex, uint64_t *interfaceHandle)	声明接口。
OH_Usb_SelectInterfaceSetting(uint64_t interfaceHandle, uint8_t settingIndex)	激活接口的备用设置。
OH_Usb_GetCurrentInterfaceSetting(uint64_t interfaceHandle, uint8_t *settingIndex)	获取接口当前激活的备用设置。
OH_Usb_SendControlReadRequest(uint64_t interfaceHandle, const struct UsbControlRequestSetup *setup, uint32_t timeout, uint8_t *data, uint32_t *dataLen)	发送控制读请求，该接口为同步接口。
OH_Usb_SendControlWriteRequest(uint64_t interfaceHandle, const struct UsbControlRequestSetup *setup, uint32_t, const uint8_t *data, uint32_t dataLen)	发送控制写请求，该接口为同步接口。
OH_Usb_ReleaseInterface(uint64_t interfaceHandle)	释放接口。
OH_Usb_SendPipeRequest(const struct UsbRequestPipe *pipe, UsbDeviceMemMap *devMmap)	发送管道请求，该接口为同步接口。中断传输和批量传输都使用该接口发送请求。
OH_Usb_CreateDeviceMemMap(uint64_t deviceId, size_t size, UsbDeviceMemMap **devMmap)	创建缓冲区。请在缓冲区使用完后，调用OH_Usb_DestroyDeviceMemMap()销毁缓冲区，否则会造成资源泄露。
OH_Usb_DestroyDeviceMemMap(UsbDeviceMemMap *devMmap)	销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区，否则会造成资源泄露。

详细的接口说明请参考USB DDK。

USB DDK开发步骤

以下步骤描述了如何使用 USB DDK开发USB驱动：

添加动态链接库

CMakeLists.txt中添加以下lib。

libusb_ndk.z.so

头文件

#include 
#include 

1. 获取设备描述符。使用 usb_ddk_api.h 的 OH_Usb_Init 接口初始化DDK，并使用 OH_Usb_GetDeviceDescriptor获取到设备描述符。

   // 初始化USB DDK
   OH_Usb_Init();
   struct UsbDeviceDescriptor devDesc;
   uint64_t deviceId = 0;
   // 获取设备描述符
   OH_Usb_GetDeviceDescriptor(deviceId, &devDesc);

2. 获取配置描述符及声明接口。使用 usb_ddk_api.h 的 OH_Usb_GetConfigDescriptor 接口获取配置描述符 config，并使用 OH_Usb_ClaimInterface 声明接口。

   struct UsbDdkConfigDescriptor *config = nullptr;
   // 获取配置描述符
   OH_Usb_GetConfigDescriptor(deviceId, 1, &config);
   // 根据配置描述符,找到所需要通信的interfaceIndex
   uint8_t interfaceIndex = 0;
   // 声明接口
   uint64_t interfaceHandle = 0;
   OH_Usb_ClaimInterface(deviceId, interfaceIndex, &interfaceHandle);
   // 释放配置描述符
   OH_Usb_FreeConfigDescriptor(config);

3. 获取当前激活接口的备用设置及激活备用设置。使用 usb_ddk_api.h 的 OH_Usb_GetCurrentInterfaceSetting 获取备用设置，并使用 OH_Usb_SelectInterfaceSetting 激活备用设置

   uint8_t settingIndex = 0;
   // 接口获取备用设置
   OH_Usb_GetCurrentInterfaceSetting(interfaceHandle, &settingIndex);
   
   // 激活备用设置
   OH_Usb_SelectInterfaceSetting(interfaceHandle, &settingIndex);

4. 发送控制读请求、发送控制写请求。使用 usb_ddk_api.h 的OH_Usb_SendControlReadRequest发送控制读请求，或者使用OH_Usb_SendControlWriteRequest发送控制写请求。

       // 超时时间，设置为1s;
   uint32_t timeout = 1000;
   
   struct UsbControlRequestSetup setupRead;
   setupRead.bmRequestType    = 0x80;
   setupRead.bRequest = 0x08;
   setupRead.wValue = 0;
   setupRead.wIndex = 0;
   setupRead.wLength = 0x01;
   uint8_t dataRead[256] = {0};
   uint32_t dataReadLen = 256;
   // 发送控制读请求
   OH_Usb_SendControlReadRequest(interfaceHandle, &setupRead, timeout, dataRead, &dataReadLen);
   
   struct UsbControlRequestSetup setupWrite;
   setupWrite.bmRequestType = 0;
   setupWrite.bRequest = 0x09;
   setupWrite.wValue = 1;
   setupWrite.wIndex = 0;
   setupWrite.wLength = 0;
   uint8_t dataWrite[256] = {0};
   uint32_t dataWriteLen = 256;
   // 发送控制写请求
   OH_Usb_SendControlWriteRequest(interfaceHandle, &setupWrite, timeout, dataWrite, &dataWriteLen);

5. 创建内存映射缓冲区及发送请求。使用 usb_ddk_api.h 的OH_Usb_CreateDeviceMemMap接口创建内存映射缓冲区devMmap，并使用OH_Usb_SendPipeRequest发送请求。

   struct UsbDeviceMemMap *devMmap = nullptr;
   // 创建用于存放数据的缓冲区
   size_t bufferLen = 10;
   OH_Usb_CreateDeviceMemMap(deviceId, bufferLen, &devMmap);
   struct UsbRequestPipe pipe;
   pipe.interfaceHandle = interfaceHandle;
   // 根据配置描述符找到所要通信的端点
   pipe.endpoint = 128;
   pipe.timeout = UINT32_MAX;
   // 发送请求
   OH_Usb_SendPipeRequest(&pipe, devMmap);

6. 释放资源。在所有请求处理完毕，程序退出前，使用 usb_ddk_api.h 的 OH_Usb_DestroyDeviceMemMap 接口销毁缓冲区。使用OH_Usb_ReleaseInterface释放接口。使用OH_Usb_Release释放USB DDK。

   // 销毁缓冲区
   OH_Usb_DestroyDeviceMemMap(devMmap);
   // 释放接口
   OH_Usb_ReleaseInterface(interfaceHandle);
   // 释放USB DDK
   OH_Usb_Release();

   场景介绍

   HID DDK（HID Driver Develop Kit）是为开发者提供的HID设备驱动程序开发套件，支持开发者基于用户态，在应用层开发HID设备驱动。提供了一系列主机侧访问设备的接口，包括创建设备、向设备发送事件、销毁设备。

   接口说明

   名称	描述
   OH_Hid_CreateDevice(Hid_Device *hidDevice, Hid_EventProperties *hidEventProperties)	创建HID设备。请在设备使用完后使用OH_Hid_DestroyDevice销毁设备
   OH_Hid_EmitEvent(int32_t deviceId, const Hid_EmitItem items[], uint16_t length)	向指定deviceId的HID设备发送事件。
   OH_Hid_DestroyDevice(int32_t deviceId)	销毁指定deviceId的HID设备。

   详细的接口说明请参考HID DDK。

   HID DDK开发步骤

   以下步骤描述了如何使用 HID DDK开发HID设备驱动：

   添加动态链接库

   CMakeLists.txt中添加以下lib。

   libhid.z.so

   头文件

#include 
#include 

创建设备。使用 hid_ddk_api.h 的 OH_Hid_CreateDevice 接口创建HID设备，成功返回设备deviceId（非负数），失败返回错误码（负数）。

// 构建HID设备属性
std::vector deviceProp = {HID_PROP_DIRECT};
std::string deviceName = "keyboard"
Hid_Device hidDevice = {
   .deviceName = deviceName.c_str(), 
   .vendorId = 0x6006, 
   .productId = 0x6006, 
   .version = 1, 
   .bustype = 3,
   .properties = deviceProp.data(),
   .propLength = (uint16_t)deviceProp.size()
};
// 构建HID设备关注的事件属性
std::vector eventType = {HID_EV_ABS, HID_EV_KEY, HID_EV_SYN, HID_EV_MSC};
Hid_EventTypeArray eventTypeArray = {.hidEventType = eventType.data(), .length = (uint16_t)eventType.size()};
std::vector keyCode = {HID_BTN_TOOL_PEN, HID_BTN_TOOL_RUBBER, HID_BTN_TOUCH, HID_BTN_STYLUS, HID_BTN_RIGHT};
Hid_KeyCodeArray keyCodeArray = {.hidKeyCode = keyCode.data(), .length = (uint16_t)keyCode.size()};
std::vector mscEvent = {HID_MSC_SCAN};
Hid_MscEventArray mscEventArray = {.hidMscEvent = mscEvent.data(), .length = (uint16_t)mscEvent.size()};
std::vector absAxes = {HID_ABS_X, HID_ABS_Y, HID_ABS_PRESSURE};
Hid_AbsAxesArray absAxesArray = {.hidAbsAxes = absAxes.data(), .length = (uint16_t)absAxes.size()};
Hid_EventProperties hidEventProp = {
   .hidEventTypes = eventTypeArray,
   .hidKeys = keyCodeArray,
   .hidAbs = absAxesArray,
   .hidMiscellaneous = mscEventArray
};
// 创建设备并获取到deviceId
int32_t deviceId = OH_Hid_CreateDevice(&hidDevice, &hidEventProp);

向指定deviceId的HID设备发送事件。使用 hid_ddk_api.h 的 OH_Hid_EmitEvent 向指定的deviceId的设备发送事件。

// 构建需要发送事件
Hid_EmitItem event = {.type = HID_EV_MSC, .code = HID_MSC_SCAN, .value = 0x000d0042};
std::vector itemVec;
itemVec.push_back(event);
// 向指定deviceId的HID设备发送事件
int32_t ret = OH_Hid_EmitEvent(deviceId, itemVec.data(), (uint16_t)itemVec.size());

释放资源。在所有请求处理完毕，程序退出前，使用 hid_ddk_api.h 的 OH_Hid_DestroyDevice 接口销毁HID设备。

// 销毁HID设备
int32_t ret = OH_Hid_DestroyDevice(deviceId);