1# USB DDK 2 3 4## 概述 5 6提供USB DDK接口，包括主机侧打开和关闭接口、管道同步异步读写通信、控制传输、中断传输等。 7 8**系统能力：** SystemCapability.Driver.USB.Extension 9 10**起始版本：** 11 1210 13 14## 汇总 15 16 17### 文件 18 19| 名称 | 描述 | 20| -------- | -------- | 21| [usb_ddk_api.h](usb__ddk__api_8h.md) | 声明用于主机侧访问设备的USB DDK接口。<br/>引用文件：<usb/usb_ddk_api.h> <br/>库： libusb_ndk.z.so| 22| [usb_ddk_types.h](usb__ddk__types_8h.md) | 提供USB DDK中的枚举变量、结构体定义与宏定义。<br/>引用文件：<usb/usb_ddk_types.h> <br/>库： libusb_ndk.z.so| 23 24 25### 结构体 26 27| 名称 | 描述 | 28| -------- | -------- | 29| [UsbControlRequestSetup](_usb_control_request_setup.md) | 控制传输setup包，对应USB协议中的Setup Data。 | 30| [UsbDeviceDescriptor](_usb_device_descriptor.md) | 标准设备描述符，对应USB协议中Standard Device Descriptor。 | 31| [UsbConfigDescriptor](_usb_config_descriptor.md) | 标准配置描述符，对应USB协议中Standard Configuration Descriptor。 | 32| [UsbInterfaceDescriptor](_usb_interface_descriptor.md) | 标准接口描述符，对应USB协议中Standard Interface Descriptor。 | 33| [UsbEndpointDescriptor](_usb_endpoint_descriptor.md) | 标准端点描述符，对应USB协议中Standard Endpoint Descriptor。 | 34| [UsbDdkEndpointDescriptor](_usb_ddk_endpoint_descriptor.md) | 端点描述符。 | 35| [UsbDdkInterfaceDescriptor](_usb_ddk_interface_descriptor.md) | 接口描述符。 | 36| [UsbDdkInterface](_usb_ddk_interface.md) | USB接口，是特定接口下备用设置的集合。 | 37| [UsbDdkConfigDescriptor](_usb_ddk_config_descriptor.md) | 配置描述符。 | 38| [UsbRequestPipe](_usb_request_pipe.md) | 请求管道。 | 39| [UsbDeviceMemMap](_usb_device_mem_map.md) | 设备内存映射，通过[OH_Usb_CreateDeviceMemMap()](#oh_usb_createdevicememmap)创建设备内存映射，使用内存映射后的缓冲区，获得更好的性能。 | 40| [Usb_DeviceArray](_usb_device_array.md) | 设备ID清单，用于存放[OH_Usb_GetDevices()](#oh_usb_getdevices16)接口获取到的设备ID列表和设备数量。 | 41 42### 枚举 43 44| 名称 | 描述 | 45| -------- | -------- | 46| [UsbDdkErrCode](#usbddkerrcode) {<br/>USB_DDK_SUCCESS = 0, USB_DDK_NO_PERM = 201, USB_DDK_INVALID_PARAMETER = 401, USB_DDK_MEMORY_ERROR = 27400001,<br/>USB_DDK_INVALID_OPERATION = 27400002, USB_DDK_IO_FAILED = 27400003, USB_DDK_TIMEOUT = 27400004<br/>} | USB DDK 错误码定义。 | 47 48 49### 函数 50 51| 名称 | 描述 | 52| -------- | -------- | 53| [OH_Usb_Init](#oh_usb_init) (void) | 初始化DDK。 | 54| [OH_Usb_Release](#oh_usb_release) (void) | 释放DDK。 | 55| [OH_Usb_ReleaseResource](#oh_usb_releaseresource14) (void) | 释放DDK。 | 56| [OH_Usb_GetDeviceDescriptor](#oh_usb_getdevicedescriptor) (uint64_t deviceId, struct [UsbDeviceDescriptor](_usb_device_descriptor.md) \*desc) | 获取设备描述符。 | 57| [OH_Usb_GetConfigDescriptor](#oh_usb_getconfigdescriptor) (uint64_t deviceId, uint8_t configIndex, struct [UsbDdkConfigDescriptor](_usb_ddk_config_descriptor.md) \*\*const config) | 获取配置描述符。请在描述符使用完后使用[OH_Usb_FreeConfigDescriptor()](#oh_usb_freeconfigdescriptor)释放描述符，否则会造成内存泄露。 | 58| [OH_Usb_FreeConfigDescriptor](#oh_usb_freeconfigdescriptor) (const struct [UsbDdkConfigDescriptor](_usb_ddk_config_descriptor.md) \*const config) | 释放配置描述符，请在描述符使用完后释放描述符，否则会造成内存泄露。 | 59| [OH_Usb_ClaimInterface](#oh_usb_claiminterface) (uint64_t deviceId, uint8_t interfaceIndex, uint64_t \*[interfaceHandle](usb__ddk__types_8h.md#interfacehandle)) | 声明接口。 | 60| [OH_Usb_ReleaseInterface](#oh_usb_releaseinterface) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle)) | 释放接口。 | 61| [OH_Usb_SelectInterfaceSetting](#oh_usb_selectinterfacesetting) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle), uint8_t settingIndex) | 激活接口的备用设置。 | 62| [OH_Usb_GetCurrentInterfaceSetting](#oh_usb_getcurrentinterfacesetting) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle), uint8_t \*settingIndex) | 获取接口当前激活的备用设置。 | 63| [OH_Usb_SendControlReadRequest](#oh_usb_sendcontrolreadrequest) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle), const struct [UsbControlRequestSetup](_usb_control_request_setup.md) \*setup, uint32_t [timeout](usb__ddk__types_8h.md#timeout), uint8_t \*data, uint32_t \*dataLen) | 发送控制读请求，该接口为同步接口。 | 64| [OH_Usb_SendControlWriteRequest](#oh_usb_sendcontrolwriterequest) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle), const struct [UsbControlRequestSetup](_usb_control_request_setup.md) \*setup, uint32_t [timeout](usb__ddk__types_8h.md#timeout), const uint8_t \*data, uint32_t dataLen) | 发送控制写请求，该接口为同步接口。 | 65| [OH_Usb_SendPipeRequest](#oh_usb_sendpiperequest) (const struct [UsbRequestPipe](_usb_request_pipe.md) \*pipe, [UsbDeviceMemMap](_usb_device_mem_map.md) \*devMmap) | 发送管道请求，该接口为同步接口。中断传输和批量传输都使用该接口发送请求。 | 66| [OH_Usb_SendPipeRequestWithAshmem](#oh_usb_sendpiperequestwithashmem12) (const struct [UsbRequestPipe](_usb_request_pipe.md) \*pipe, [DDK_Ashmem](_ddk_ashmem.md) \*ashmem) | 发送共享内存管道请求，该接口为同步接口。中断传输和批量传输都使用该接口发送请求。 | 67| [OH_Usb_CreateDeviceMemMap](#oh_usb_createdevicememmap) (uint64_t deviceId, size_t size, [UsbDeviceMemMap](_usb_device_mem_map.md) \*\*devMmap) | 创建缓冲区。请在缓冲区使用完后，调用[OH_Usb_DestroyDeviceMemMap()](#oh_usb_destroydevicememmap)销毁缓冲区，否则会造成资源泄露。 | 68| [OH_Usb_DestroyDeviceMemMap](#oh_usb_destroydevicememmap) ([UsbDeviceMemMap](_usb_device_mem_map.md) \*devMmap) | 销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区，否则会造成资源泄露。 | 69| [OH_Usb_GetDevices](#oh_usb_getdevices16) ([Usb_DeviceArray](_usb_device_array.md) \*devices) | 获取USB设备ID列表。请保证传入的指针参数是有效的，申请设备的数量不要超过128个，在使用完结构之后，释放成员内存，否则造成资源泄露。获取到的USB设备ID，已通过驱动配置信息中的vid进行筛选过滤。 | 70 71#### 函数参数deviceId说明 72 73设备ID（deviceId）的获取可通过外设查询接口queryDevices()查询。 74具体请查阅[扩展外设管理开发指导](../../device/driver/externaldevice-guidelines.md)。 75 76#### 函数参数deviceId转换指导 77 78通过外设查询接口queryDevices()获取到的deviceId，还需要通过数据转换，才能得到[OH_Usb_GetDeviceDescriptor](#oh_usb_getdevicedescriptor) 等函数的入参deviceId。 79<p>转换原理：提取queryDevices()获取到的deviceId的前32位作为C_API的deviceId。</p> 80<p>以下代码仅供参考：</p> 81 82 ~~~ 83uint64_t JsDeviceIdToNative(uint64_t deviceId) 84{ 85 uint32_t busNum = (uint32_t)(deviceId >> 48); 86 uint32_t devNum = (uint32_t)((deviceId & 0x0000FFFF00000000) >> 32); 87 return (((static_cast<uint64_t>(busNum)) << 32) | devNum); 88} 89~~~ 90 91## 类型定义说明 92 93### UsbDdkEndpointDescriptor 94 95``` 96typedef struct UsbDdkEndpointDescriptor UsbDdkEndpointDescriptor 97``` 98 99**描述** 100 101端点描述符。 102 103**起始版本：** 10 104 105### UsbDdkInterfaceDescriptor 106 107``` 108typedef struct UsbDdkInterfaceDescriptor UsbDdkInterfaceDescriptor 109``` 110 111**描述** 112 113接口描述符。 114 115**起始版本：** 10 116 117### UsbDdkInterface 118 119``` 120typedef struct UsbDdkInterface UsbDdkInterface 121``` 122 123**描述** 124 125USB接口。 126 127**起始版本：** 10 128 129### UsbDdkConfigDescriptor 130 131``` 132typedef struct UsbDdkConfigDescriptor UsbDdkConfigDescriptor 133``` 134 135**描述** 136 137配置描述符。 138 139**起始版本：** 10 140 141### UsbDeviceMemMap 142 143``` 144typedef struct UsbDeviceMemMap UsbDeviceMemMap 145``` 146 147**描述** 148 149 设备内存映射，通过[OH_Usb_CreateDeviceMemMap()](_usb_ddk.md#oh_usb_createdevicememmap)创建设备内存映射，使用内存映射后的缓冲区，获得更好的性能。 150 151**起始版本：** 10 152 153### Usb_DeviceArray 154 155``` 156typedef struct Usb_DeviceArray usb_DeviceArray 157``` 158 159**描述** 160 161设备ID清单，用于存放[OH_Usb_GetDevices()](_usb_ddk.md#oh_usb_getdevices16)接口获取到的设备ID列表和设备数量。 162 163**起始版本：** 10 164 165## 枚举类型说明 166 167### UsbDdkErrCode 168 169 170``` 171enum UsbDdkErrCode 172``` 173 174**描述:** 175 176USB DDK 错误码定义。 177 178| 枚举定义 | 值 | 描述 | 179| -------- | -------- |-------- | 180| USB_DDK_SUCCESS | 0 | 操作成功。 | 181| USB_DDK_NO_PERM | 201 | 操作失败。 | 182| USB_DDK_INVALID_PARAMETER | 401 | 非法参数。 | 183| USB_DDK_MEMORY_ERROR | 27400001 | 内存相关的错误，包括：内存不足、内存数据拷贝失败、内存申请失败等。 | 184| USB_DDK_INVALID_OPERATION | 27400002 | 非法操作。 | 185| USB_DDK_IO_FAILED | 27400003 | 设备I/O操作失败。 | 186| USB_DDK_TIMEOUT | 27400004 | 传输超时。 | 187 188 189## 函数说明 190 191 192### OH_Usb_ClaimInterface() 193 194 195``` 196int32_t OH_Usb_ClaimInterface (uint64_t deviceId, uint8_t interfaceIndex, uint64_t * interfaceHandle) 197``` 198 199**描述:** 200 201声明接口。 202 203**需要权限**：ohos.permission.ACCESS_DDK_USB 204 205**参数:** 206 207| 名称 | 描述 | 208| -------- | -------- | 209| deviceId | 设备ID，代表要操作的设备。 | 210| interfaceIndex | 接口索引，对应USB协议中的[bInterfaceNumber](_usb_interface_descriptor.md#binterfacenumber)。 | 211| interfaceHandle | 接口操作句柄，接口声明成功后，该参数将会被赋值。 | 212 213**返回:** 214 215- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 216- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 217- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 218- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode)：表示入参interfaceHandle为空指针。 219 220 221### OH_Usb_CreateDeviceMemMap() 222 223 224``` 225int32_t OH_Usb_CreateDeviceMemMap (uint64_t deviceId, size_t size, UsbDeviceMemMap ** devMmap) 226``` 227 228**描述:** 229 230创建缓冲区。请在缓冲区使用完后，调用[OH_Usb_DestroyDeviceMemMap()](#oh_usb_destroydevicememmap)销毁缓冲区，否则会造成资源泄露。 231 232**需要权限**：ohos.permission.ACCESS_DDK_USB 233 234**参数:** 235 236| 名称 | 描述 | 237| -------- | -------- | 238| deviceId | 设备ID，代表要创建缓冲区的设备。 | 239| size | 缓冲区的大小。 | 240| devMmap | 创建的缓冲区通过该参数返回给调用者。 | 241 242**返回:** 243 244- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 245- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 246- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode)：表示入参devMmap为空指针。 247- [USB_DDK_MEMORY_ERROR](#usbddkerrcode)：表示mmap失败或者申请devMmap的内存空间失败。 248 249 250### OH_Usb_DestroyDeviceMemMap() 251 252 253``` 254void OH_Usb_DestroyDeviceMemMap (UsbDeviceMemMap * devMmap) 255``` 256 257**描述:** 258 259销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区，否则会造成资源泄露。 260 261**需要权限**：ohos.permission.ACCESS_DDK_USB 262 263**参数:** 264 265| 名称 | 描述 | 266| -------- | -------- | 267| devMmap | 销毁由[OH_Usb_CreateDeviceMemMap()](#oh_usb_createdevicememmap)创建的缓冲区。 | 268 269 270### OH_Usb_FreeConfigDescriptor() 271 272 273``` 274void OH_Usb_FreeConfigDescriptor (struct UsbDdkConfigDescriptor *const config) 275``` 276 277**描述:** 278 279释放配置描述符，请在描述符使用完后释放描述符，否则会造成内存泄露。 280 281**需要权限**：ohos.permission.ACCESS_DDK_USB 282 283**参数:** 284 285| 名称 | 描述 | 286| -------- | -------- | 287| config | 配置描述符，通过[OH_Usb_GetConfigDescriptor()](#oh_usb_getconfigdescriptor)获得的配置描述符。 | 288 289 290### OH_Usb_GetConfigDescriptor() 291 292 293``` 294int32_t OH_Usb_GetConfigDescriptor (uint64_t deviceId, uint8_t configIndex, struct UsbDdkConfigDescriptor **const config) 295``` 296 297**描述:** 298 299获取配置描述符。请在描述符使用完后使用[OH_Usb_FreeConfigDescriptor()](#oh_usb_freeconfigdescriptor)释放描述符，否则会造成内存泄露。 300 301**需要权限**：ohos.permission.ACCESS_DDK_USB 302 303**参数:** 304 305| 名称 | 描述 | 306| -------- | -------- | 307| deviceId | 设备ID，代表要获取配置描述符的设备。 | 308| configIndex | 配置id，对应USB协议中的[bConfigurationValue](_usb_config_descriptor.md#bconfigurationvalue)。 | 309| config | 配置描述符，包含USB协议中定义的标准配置描述符，以及与其关联的接口描述符和端点描述符。 | 310 311**返回:** 312 313- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 314- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 315- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 316- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode)：表示入参config为空指针。 317- [USB_DDK_IO_FAILED](#usbddkerrcode)：表示设备I/O操作失败。 318 319 320### OH_Usb_GetCurrentInterfaceSetting() 321 322 323``` 324int32_t OH_Usb_GetCurrentInterfaceSetting (uint64_t interfaceHandle, uint8_t * settingIndex) 325``` 326 327**描述:** 328 329获取接口当前激活的备用设置。 330 331**需要权限**：ohos.permission.ACCESS_DDK_USB 332 333**参数:** 334 335| 名称 | 描述 | 336| -------- | -------- | 337| interfaceHandle | 接口操作句柄，代表要操作的接口。 | 338| settingIndex | 备用设置索引，对应USB协议中的[bAlternateSetting](_usb_interface_descriptor.md#balternatesetting)。 | 339 340**返回:** 341 342- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 343- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 344- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 345- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode)：表示入参settingIndex为空指针。 346 347 348### OH_Usb_GetDeviceDescriptor() 349 350 351``` 352int32_t OH_Usb_GetDeviceDescriptor (uint64_t deviceId, struct UsbDeviceDescriptor * desc) 353``` 354 355**描述:** 356 357获取设备描述符。 358 359**需要权限**：ohos.permission.ACCESS_DDK_USB 360 361**参数:** 362 363| 名称 | 描述 | 364| -------- | -------- | 365| deviceId | 设备ID，代表要获取描述符的设备。 | 366| desc | 设备描述符，详细定义请参考[UsbDeviceDescriptor](_usb_device_descriptor.md)。 | 367 368**返回:** 369 370- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 371- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 372- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 373- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode)：表示入参desc为空指针。 374 375### OH_Usb_Init() 376 377 378``` 379int32_t OH_Usb_Init (void ) 380``` 381 382**描述:** 383 384初始化DDK。 385 386**需要权限**：ohos.permission.ACCESS_DDK_USB 387 388**返回:** 389 390- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 391- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 392- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 393 394### OH_Usb_Release() 395 396 397``` 398void OH_Usb_Release (void) 399``` 400 401**描述:** 402 403释放DDK。 404 405**需要权限**：ohos.permission.ACCESS_DDK_USB 406 407### OH_Usb_ReleaseResource()<sup>14+</sup> 408 409``` 410int32_t OH_Usb_ReleaseResource (void) 411``` 412 413**描述:** 414 415释放DDK。 416 417**需要权限**：ohos.permission.ACCESS_DDK_USB 418 419**返回:** 420 421- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 422- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 423- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 424 425### OH_Usb_ReleaseInterface() 426 427``` 428int32_t OH_Usb_ReleaseInterface (uint64_t interfaceHandle) 429``` 430 431**描述:** 432 433释放接口。 434 435**需要权限**：ohos.permission.ACCESS_DDK_USB 436 437**参数:** 438 439| 名称 | 描述 | 440| -------- | -------- | 441| interfaceHandle | 接口操作句柄，代表要释放的接口。 | 442 443**返回:** 444 445- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 446- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 447- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 448 449 450### OH_Usb_SelectInterfaceSetting() 451 452 453``` 454int32_t OH_Usb_SelectInterfaceSetting (uint64_t interfaceHandle, uint8_t settingIndex) 455``` 456 457**描述:** 458 459激活接口的备用设置。 460 461**需要权限**：ohos.permission.ACCESS_DDK_USB 462 463**参数:** 464 465| 名称 | 描述 | 466| -------- | -------- | 467| interfaceHandle | 接口操作句柄，代表要操作的接口。 | 468| settingIndex | 备用设置索引，对应USB协议中的[bAlternateSetting](_usb_interface_descriptor.md#balternatesetting)。 | 469 470**返回:** 471 472- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 473- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 474- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 475 476 477### OH_Usb_SendControlReadRequest() 478 479 480``` 481int32_t OH_Usb_SendControlReadRequest (uint64_t interfaceHandle, const struct UsbControlRequestSetup * setup, uint32_t timeout, uint8_t * data, uint32_t * dataLen) 482``` 483 484**描述:** 485 486发送控制读请求，该接口为同步接口。 487 488**需要权限**：ohos.permission.ACCESS_DDK_USB 489 490**参数:** 491 492| 名称 | 描述 | 493| -------- | -------- | 494| interfaceHandle | 接口操作句柄，代表要操作的接口。 | 495| setup | 请求相关的参数，详细定义请参考 [UsbControlRequestSetup](_usb_control_request_setup.md)。 | 496| timeout | 超时时间，单位为毫秒。 | 497| data | 要传输的数据。 | 498| dataLen | 表示data的数据长度，在函数返回后，表示实际读取到的数据的长度。 | 499 500**返回:** 501 502- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 503- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 504- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 505- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode)：表示入参setup、data或者dataLen为空指针，亦或datalen小于读取到的数据长度。 506- [USB_DDK_MEMORY_ERROR](#usbddkerrcode)：表示拷贝读取数据的内存失败。 507- [USB_DDK_IO_FAILED](#usbddkerrcode)：表示设备I/O操作失败。 508- [USB_DDK_TIMEOUT](#usbddkerrcode)：表示请求超时。 509 510 511### OH_Usb_SendControlWriteRequest() 512 513 514``` 515int32_t OH_Usb_SendControlWriteRequest (uint64_t interfaceHandle, const struct UsbControlRequestSetup * setup, uint32_t timeout, const uint8_t * data, uint32_t dataLen) 516``` 517 518**描述:** 519 520发送控制写请求，该接口为同步接口。 521 522**需要权限**：ohos.permission.ACCESS_DDK_USB 523 524**参数:** 525 526| 名称 | 描述 | 527| -------- | -------- | 528| interfaceHandle | 接口操作句柄，代表要操作的接口。 | 529| setup | 请求相关的参数，详细定义请参考 [UsbControlRequestSetup](_usb_control_request_setup.md)。 | 530| timeout | 超时时间，单位为毫秒。 | 531| data | 要传输的数据。 | 532| dataLen | 表示data的数据长度。 | 533 534**返回:** 535 536- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 537- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 538- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 539- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode)：表示入参setup或者data为空指针。 540- [USB_DDK_IO_FAILED](#usbddkerrcode)：表示设备I/O操作失败。 541- [USB_DDK_TIMEOUT](#usbddkerrcode)：表示请求超时。 542 543 544### OH_Usb_SendPipeRequest() 545 546 547``` 548int32_t OH_Usb_SendPipeRequest (const struct UsbRequestPipe * pipe, UsbDeviceMemMap * devMmap) 549``` 550 551**描述:** 552 553发送管道请求，该接口为同步接口。中断传输和批量传输都使用该接口发送请求。 554 555**需要权限**：ohos.permission.ACCESS_DDK_USB 556 557**参数:** 558 559| 名称 | 描述 | 560| -------- | -------- | 561| pipe | 要传输数据的管道信息。 | 562| devMmap | 数据缓冲区，可以通过[OH_Usb_CreateDeviceMemMap()](#oh_usb_createdevicememmap)获得。 | 563 564**返回:** 565 566- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 567- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 568- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 569- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode)：表示入参pipe、devMmap或者devMmap的地址为空指针。 570- [USB_DDK_IO_FAILED](#usbddkerrcode)：表示设备I/O操作失败。 571- [USB_DDK_TIMEOUT](#usbddkerrcode)：表示请求超时。 572 573### OH_Usb_SendPipeRequestWithAshmem()<sup>12+</sup> 574 575 576``` 577int32_t OH_Usb_SendPipeRequestWithAshmem(const struct UsbRequestPipe *pipe, DDK_Ashmem *ashmem) 578``` 579 580**描述:** 581 582发送共享内存的管道请求，该接口为同步接口。中断传输和批量传输都使用该接口发送请求。 583 584**需要权限**：ohos.permission.ACCESS_DDK_USB 585 586**参数:** 587 588| 名称 | 描述 | 589| -------- | -------- | 590| pipe | 要传输数据的管道信息。 | 591| ashmem | 共享内存，可以通过[OH_DDK_CreateAshmem()](_base_ddk.md#oh_ddk_createashmem)获得。 | 592 593**返回:** 594 595- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 596- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 597- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 598- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode)：表示入参pipe、ashmem或者ashmem的地址为空指针。 599- [USB_DDK_IO_FAILED](#usbddkerrcode)：表示设备I/O操作失败。 600- [USB_DDK_TIMEOUT](#usbddkerrcode)：表示请求超时。 601 602### OH_Usb_GetDevices()<sup>16+</sup> 603 604 605``` 606int32_t OH_Usb_GetDevices(struct Usb_DeviceArray *devices) 607``` 608 609**描述:** 610 611获取USB设备ID列表。请保证传入的指针参数是有效的，申请设备的数量不要超过128个，在使用完结构之后，释放成员内存，否则造成资源泄露。获取到的USB设备ID，已通过驱动配置信息中的vid进行筛选过滤。 612 613**需要权限**：ohos.permission.ACCESS_DDK_USB 614 615**参数:** 616 617| 名称 | 描述 | 618| -------- | -------- | 619| devices | 已申请好的设备内存地址，用于存放获取到的设备ID列表及数量。 | 620 621**返回:** 622 623- [USB_DDK_SUCCESS](#usbddkerrcode)：表示调用接口成功。 624- [USB_DDK_NO_PERM](#usbddkerrcode)：表示权限校验失败。 625- [USB_DDK_INVALID_OPERATION](#usbddkerrcode)：表示连接usb_ddk服务失败。 626- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode)：表示参数devices的地址为空指针。