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/>引用文件:&lt;usb/usb_ddk_api.h&gt; <br/>库: libusb_ndk.z.so|
22| [usb_ddk_types.h](usb__ddk__types_8h.md) | 提供USB DDK中的枚举变量、结构体定义与宏定义。<br/>引用文件:&lt;usb/usb_ddk_types.h&gt; <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
41### 枚举
42
43| 名称 | 描述 |
44| -------- | -------- |
45| [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 错误码定义。 |
46
47
48### 函数
49
50| 名称 | 描述 |
51| -------- | -------- |
52| [OH_Usb_Init](#oh_usb_init) (void) | 初始化DDK。 |
53| [OH_Usb_Release](#oh_usb_release) (void) | 释放DDK。 |
54| [OH_Usb_ReleaseResource](#oh_usb_releaseresource14) (void) | 释放DDK。 |
55| [OH_Usb_GetDeviceDescriptor](#oh_usb_getdevicedescriptor) (uint64_t deviceId, struct [UsbDeviceDescriptor](_usb_device_descriptor.md) \*desc) | 获取设备描述符。 |
56| [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)释放描述符,否则会造成内存泄露。 |
57| [OH_Usb_FreeConfigDescriptor](#oh_usb_freeconfigdescriptor) (const struct [UsbDdkConfigDescriptor](_usb_ddk_config_descriptor.md) \*const config) | 释放配置描述符,请在描述符使用完后释放描述符,否则会造成内存泄露。 |
58| [OH_Usb_ClaimInterface](#oh_usb_claiminterface) (uint64_t deviceId, uint8_t interfaceIndex, uint64_t \*[interfaceHandle](usb__ddk__types_8h.md#interfacehandle)) | 声明接口。 |
59| [OH_Usb_ReleaseInterface](#oh_usb_releaseinterface) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle)) | 释放接口。 |
60| [OH_Usb_SelectInterfaceSetting](#oh_usb_selectinterfacesetting) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle), uint8_t settingIndex) | 激活接口的备用设置。 |
61| [OH_Usb_GetCurrentInterfaceSetting](#oh_usb_getcurrentinterfacesetting) (uint64_t [interfaceHandle](usb__ddk__types_8h.md#interfacehandle), uint8_t \*settingIndex) | 获取接口当前激活的备用设置。 |
62| [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) | 发送控制读请求,该接口为同步接口。 |
63| [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) | 发送控制写请求,该接口为同步接口。 |
64| [OH_Usb_SendPipeRequest](#oh_usb_sendpiperequest) (const struct [UsbRequestPipe](_usb_request_pipe.md) \*pipe, [UsbDeviceMemMap](_usb_device_mem_map.md) \*devMmap) | 发送管道请求,该接口为同步接口。中断传输和批量传输都使用该接口发送请求。 |
65| [OH_Usb_SendPipeRequestWithAshmem](#oh_usb_sendpiperequestwithashmem12) (const struct [UsbRequestPipe](_usb_request_pipe.md) \*pipe, [DDK_Ashmem](_ddk_ashmem.md) \*ashmem) | 发送共享内存管道请求,该接口为同步接口。中断传输和批量传输都使用该接口发送请求。 |
66| [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)销毁缓冲区,否则会造成资源泄露。 |
67| [OH_Usb_DestroyDeviceMemMap](#oh_usb_destroydevicememmap) ([UsbDeviceMemMap](_usb_device_mem_map.md) \*devMmap) | 销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区,否则会造成资源泄露。 |
68
69#### 函数参数deviceId说明
70
71设备ID(deviceId)的获取可通过外设查询接口queryDevices()查询。
72具体请查阅[扩展外设管理开发指导](../../device/driver/externaldevice-guidelines.md)。
73
74#### 函数参数deviceId转换指导
75
76通过外设查询接口queryDevices()获取到的deviceId,还需要通过数据转换,才能得到[OH_Usb_GetDeviceDescriptor](#oh_usb_getdevicedescriptor) 等函数的入参deviceId。
77<p>转换原理:提取queryDevices()获取到的deviceId的前32位作为C_API的deviceId。</p>
78<p>以下代码仅供参考:</p>
79
80 ~~~
81uint64_t JsDeviceIdToNative(uint64_t deviceId)
82{
83    uint32_t busNum = (uint32_t)(deviceId >> 48);
84    uint32_t devNum = (uint32_t)((deviceId & 0x0000FFFF00000000) >> 32);
85    return (((static_cast<uint64_t>(busNum)) << 32) | devNum);
86}
87~~~
88
89## 枚举类型说明
90
91
92### UsbDdkErrCode
93
94
95```
96enum UsbDdkErrCode
97```
98
99**描述:**
100
101USB DDK 错误码定义。
102
103| 枚举定义 | 值 | 描述 |
104| -------- | -------- |-------- |
105| USB_DDK_SUCCESS | 0 | 操作成功。 |
106| USB_DDK_NO_PERM | 201 | 操作失败。 |
107| USB_DDK_INVALID_PARAMETER | 401 | 非法参数。 |
108| USB_DDK_MEMORY_ERROR | 27400001 | 内存相关的错误,包括:内存不足、内存数据拷贝失败、内存申请失败等。 |
109| USB_DDK_INVALID_OPERATION | 27400002 | 非法操作。 |
110| USB_DDK_IO_FAILED | 27400003 | 设备I/O操作失败。 |
111| USB_DDK_TIMEOUT | 27400004 | 传输超时。 |
112
113
114## 函数说明
115
116
117### OH_Usb_ClaimInterface()
118
119
120```
121int32_t OH_Usb_ClaimInterface (uint64_t deviceId, uint8_t interfaceIndex, uint64_t * interfaceHandle )
122```
123
124**描述:**
125
126声明接口。
127
128**需要权限**:ohos.permission.ACCESS_DDK_USB
129
130**参数:**
131
132| 名称 | 描述 |
133| -------- | -------- |
134| deviceId | 设备ID,代表要操作的设备。 |
135| interfaceIndex | 接口索引,对应USB协议中的[bInterfaceNumber](_usb_interface_descriptor.md#binterfacenumber)。 |
136| interfaceHandle | 接口操作句柄,接口声明成功后,该参数将会被赋值。 |
137
138**返回:**
139
140- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
141- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
142- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
143- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参interfaceHandle为空指针。
144
145
146### OH_Usb_CreateDeviceMemMap()
147
148
149```
150int32_t OH_Usb_CreateDeviceMemMap (uint64_t deviceId, size_t size, UsbDeviceMemMap ** devMmap )
151```
152
153**描述:**
154
155创建缓冲区。请在缓冲区使用完后,调用[OH_Usb_DestroyDeviceMemMap()](#oh_usb_destroydevicememmap)销毁缓冲区,否则会造成资源泄露。
156
157**需要权限**:ohos.permission.ACCESS_DDK_USB
158
159**参数:**
160
161| 名称 | 描述 |
162| -------- | -------- |
163| deviceId | 设备ID,代表要创建缓冲区的设备。 |
164| size | 缓冲区的大小。 |
165| devMmap | 创建的缓冲区通过该参数返回给调用者。 |
166
167**返回:**
168
169- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
170- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
171- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参devMmap为空指针。
172- [USB_DDK_MEMORY_ERROR](#usbddkerrcode):表示mmap失败或者申请devMmap的内存空间失败。
173
174
175### OH_Usb_DestroyDeviceMemMap()
176
177
178```
179void OH_Usb_DestroyDeviceMemMap (UsbDeviceMemMap * devMmap)
180```
181
182**描述:**
183
184销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区,否则会造成资源泄露。
185
186**需要权限**:ohos.permission.ACCESS_DDK_USB
187
188**参数:**
189
190| 名称 | 描述 |
191| -------- | -------- |
192| devMmap | 销毁由[OH_Usb_CreateDeviceMemMap()](#oh_usb_createdevicememmap)创建的缓冲区。 |
193
194
195### OH_Usb_FreeConfigDescriptor()
196
197
198```
199void OH_Usb_FreeConfigDescriptor (struct UsbDdkConfigDescriptor *const config)
200```
201
202**描述:**
203
204释放配置描述符,请在描述符使用完后释放描述符,否则会造成内存泄露。
205
206**需要权限**:ohos.permission.ACCESS_DDK_USB
207
208**参数:**
209
210| 名称 | 描述 |
211| -------- | -------- |
212| config | 配置描述符,通过[OH_Usb_GetConfigDescriptor()](#oh_usb_getconfigdescriptor)获得的配置描述符。 |
213
214
215### OH_Usb_GetConfigDescriptor()
216
217
218```
219int32_t OH_Usb_GetConfigDescriptor (uint64_t deviceId, uint8_t configIndex, struct UsbDdkConfigDescriptor **const config )
220```
221
222**描述:**
223
224获取配置描述符。请在描述符使用完后使用[OH_Usb_FreeConfigDescriptor()](#oh_usb_freeconfigdescriptor)释放描述符,否则会造成内存泄露。
225
226**需要权限**:ohos.permission.ACCESS_DDK_USB
227
228**参数:**
229
230| 名称 | 描述 |
231| -------- | -------- |
232| deviceId | 设备ID,代表要获取配置描述符的设备。 |
233| configIndex | 配置id,对应USB协议中的[bConfigurationValue](_usb_config_descriptor.md#bconfigurationvalue)。 |
234| config | 配置描述符,包含USB协议中定义的标准配置描述符,以及与其关联的接口描述符和端点描述符。 |
235
236**返回:**
237
238- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
239- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
240- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
241- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参config为空指针。
242- [USB_DDK_IO_FAILED](#usbddkerrcode):表示设备I/O操作失败。
243
244
245### OH_Usb_GetCurrentInterfaceSetting()
246
247
248```
249int32_t OH_Usb_GetCurrentInterfaceSetting (uint64_t interfaceHandle, uint8_t * settingIndex )
250```
251
252**描述:**
253
254获取接口当前激活的备用设置。
255
256**需要权限**:ohos.permission.ACCESS_DDK_USB
257
258**参数:**
259
260| 名称 | 描述 |
261| -------- | -------- |
262| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
263| settingIndex | 备用设置索引,对应USB协议中的[bAlternateSetting](_usb_interface_descriptor.md#balternatesetting)。 |
264
265**返回:**
266
267- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
268- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
269- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
270- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参settingIndex为空指针。
271
272
273### OH_Usb_GetDeviceDescriptor()
274
275
276```
277int32_t OH_Usb_GetDeviceDescriptor (uint64_t deviceId, struct UsbDeviceDescriptor * desc )
278```
279
280**描述:**
281
282获取设备描述符。
283
284**需要权限**:ohos.permission.ACCESS_DDK_USB
285
286**参数:**
287
288| 名称 | 描述 |
289| -------- | -------- |
290| deviceId | 设备ID,代表要获取描述符的设备。 |
291| desc | 设备描述符,详细定义请参考[UsbDeviceDescriptor](_usb_device_descriptor.md)。 |
292
293**返回:**
294
295- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
296- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
297- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
298- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参desc为空指针。
299
300### OH_Usb_Init()
301
302
303```
304int32_t OH_Usb_Init (void )
305```
306
307**描述:**
308
309初始化DDK。
310
311**需要权限**:ohos.permission.ACCESS_DDK_USB
312
313**返回:**
314
315- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
316- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
317- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
318
319### OH_Usb_Release()
320
321
322```
323void OH_Usb_Release (void)
324```
325
326**描述:**
327
328释放DDK。
329
330**需要权限**:ohos.permission.ACCESS_DDK_USB
331
332### OH_Usb_ReleaseResource()<sup>14+</sup>
333
334```
335int32_t OH_Usb_ReleaseResource (void)
336```
337
338**描述:**
339
340释放DDK。
341
342**需要权限**:ohos.permission.ACCESS_DDK_USB
343
344**返回:**
345
346- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
347- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
348- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
349
350### OH_Usb_ReleaseInterface()
351
352```
353int32_t OH_Usb_ReleaseInterface (uint64_t interfaceHandle)
354```
355
356**描述:**
357
358释放接口。
359
360**需要权限**:ohos.permission.ACCESS_DDK_USB
361
362**参数:**
363
364| 名称 | 描述 |
365| -------- | -------- |
366| interfaceHandle | 接口操作句柄,代表要释放的接口。 |
367
368**返回:**
369
370- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
371- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
372- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
373
374
375### OH_Usb_SelectInterfaceSetting()
376
377
378```
379int32_t OH_Usb_SelectInterfaceSetting (uint64_t interfaceHandle, uint8_t settingIndex )
380```
381
382**描述:**
383
384激活接口的备用设置。
385
386**需要权限**:ohos.permission.ACCESS_DDK_USB
387
388**参数:**
389
390| 名称 | 描述 |
391| -------- | -------- |
392| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
393| settingIndex | 备用设置索引,对应USB协议中的[bAlternateSetting](_usb_interface_descriptor.md#balternatesetting)。 |
394
395**返回:**
396
397- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
398- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
399- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
400
401
402### OH_Usb_SendControlReadRequest()
403
404
405```
406int32_t OH_Usb_SendControlReadRequest (uint64_t interfaceHandle, const struct UsbControlRequestSetup * setup, uint32_t timeout, uint8_t * data, uint32_t * dataLen )
407```
408
409**描述:**
410
411发送控制读请求,该接口为同步接口。
412
413**需要权限**:ohos.permission.ACCESS_DDK_USB
414
415**参数:**
416
417| 名称 | 描述 |
418| -------- | -------- |
419| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
420| setup | 请求相关的参数,详细定义请参考 [UsbControlRequestSetup](_usb_control_request_setup.md)。 |
421| timeout | 超时时间,单位为毫秒。 |
422| data | 要传输的数据。 |
423| dataLen | 表示data的数据长度,在函数返回后,表示实际读取到的数据的长度。 |
424
425**返回:**
426
427- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
428- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
429- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
430- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参setup、data或者dataLen为空指针,亦或datalen小于读取到的数据长度。
431- [USB_DDK_MEMORY_ERROR](#usbddkerrcode):表示拷贝读取数据的内存失败。
432- [USB_DDK_IO_FAILED](#usbddkerrcode):表示设备I/O操作失败。
433- [USB_DDK_TIMEOUT](#usbddkerrcode):表示请求超时。
434
435
436### OH_Usb_SendControlWriteRequest()
437
438
439```
440int32_t OH_Usb_SendControlWriteRequest (uint64_t interfaceHandle, const struct UsbControlRequestSetup * setup, uint32_t timeout, const uint8_t * data, uint32_t dataLen )
441```
442
443**描述:**
444
445发送控制写请求,该接口为同步接口。
446
447**需要权限**:ohos.permission.ACCESS_DDK_USB
448
449**参数:**
450
451| 名称 | 描述 |
452| -------- | -------- |
453| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
454| setup | 请求相关的参数,详细定义请参考 [UsbControlRequestSetup](_usb_control_request_setup.md)。 |
455| timeout | 超时时间,单位为毫秒。 |
456| data | 要传输的数据。 |
457| dataLen | 表示data的数据长度。 |
458
459**返回:**
460
461- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
462- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
463- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
464- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参setup或者data为空指针。
465- [USB_DDK_IO_FAILED](#usbddkerrcode):表示设备I/O操作失败。
466- [USB_DDK_TIMEOUT](#usbddkerrcode):表示请求超时。
467
468
469### OH_Usb_SendPipeRequest()
470
471
472```
473int32_t OH_Usb_SendPipeRequest (const struct UsbRequestPipe * pipe, UsbDeviceMemMap * devMmap )
474```
475
476**描述:**
477
478发送管道请求,该接口为同步接口。中断传输和批量传输都使用该接口发送请求。
479
480**需要权限**:ohos.permission.ACCESS_DDK_USB
481
482**参数:**
483
484| 名称 | 描述 |
485| -------- | -------- |
486| pipe | 要传输数据的管道信息。 |
487| devMmap | 数据缓冲区,可以通过[OH_Usb_CreateDeviceMemMap()](#oh_usb_createdevicememmap)获得。 |
488
489**返回:**
490
491- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
492- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
493- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
494- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参pipe、devMmap或者devMmap的地址为空指针。
495- [USB_DDK_IO_FAILED](#usbddkerrcode):表示设备I/O操作失败。
496- [USB_DDK_TIMEOUT](#usbddkerrcode):表示请求超时。
497
498### OH_Usb_SendPipeRequestWithAshmem()<sup>12+</sup>
499
500
501```
502int32_t OH_Usb_SendPipeRequestWithAshmem(const struct UsbRequestPipe *pipe, DDK_Ashmem *ashmem);
503```
504
505**描述:**
506
507发送共享内存的管道请求,该接口为同步接口。中断传输和批量传输都使用该接口发送请求。
508
509**需要权限**:ohos.permission.ACCESS_DDK_USB
510
511**参数:**
512
513| 名称 | 描述 |
514| -------- | -------- |
515| pipe | 要传输数据的管道信息。 |
516| ashmem | 共享内存,可以通过[OH_DDK_CreateAshmem()](_base_ddk.md#oh_ddk_createashmem)获得。 |
517
518**返回:**
519
520- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
521- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
522- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
523- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参pipe、ashmem或者ashmem的地址为空指针。
524- [USB_DDK_IO_FAILED](#usbddkerrcode):表示设备I/O操作失败。
525- [USB_DDK_TIMEOUT](#usbddkerrcode):表示请求超时。
526