• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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### UsbDdkEndpointDescriptor
92
93```
94typedef struct UsbDdkEndpointDescriptor UsbDdkEndpointDescriptor
95```
96
97**描述**
98
99端点描述符。
100
101**起始版本:** 10
102
103### UsbDdkInterfaceDescriptor
104
105```
106typedef struct UsbDdkInterfaceDescriptor UsbDdkInterfaceDescriptor
107```
108
109**描述**
110
111接口描述符。
112
113**起始版本:** 10
114
115### UsbDdkInterface
116
117```
118typedef struct UsbDdkInterface UsbDdkInterface
119```
120
121**描述**
122
123USB接口。
124
125**起始版本:** 10
126
127### UsbDdkConfigDescriptor
128
129```
130typedef struct UsbDdkConfigDescriptor UsbDdkConfigDescriptor
131```
132
133**描述**
134
135配置描述符。
136
137**起始版本:** 10
138
139### UsbDeviceMemMap
140
141```
142typedef struct UsbDeviceMemMap UsbDeviceMemMap
143```
144
145**描述**
146
147 设备内存映射,通过[OH_Usb_CreateDeviceMemMap()](_usb_ddk.md#oh_usb_createdevicememmap)创建设备内存映射,使用内存映射后的缓冲区,获得更好的性能。
148
149**起始版本:** 10
150
151## 枚举类型说明
152
153
154### UsbDdkErrCode
155
156
157```
158enum UsbDdkErrCode
159```
160
161**描述:**
162
163USB DDK 错误码定义。
164
165| 枚举定义 | 值 | 描述 |
166| -------- | -------- |-------- |
167| USB_DDK_SUCCESS | 0 | 操作成功。 |
168| USB_DDK_NO_PERM | 201 | 操作失败。 |
169| USB_DDK_INVALID_PARAMETER | 401 | 非法参数。 |
170| USB_DDK_MEMORY_ERROR | 27400001 | 内存相关的错误,包括:内存不足、内存数据拷贝失败、内存申请失败等。 |
171| USB_DDK_INVALID_OPERATION | 27400002 | 非法操作。 |
172| USB_DDK_IO_FAILED | 27400003 | 设备I/O操作失败。 |
173| USB_DDK_TIMEOUT | 27400004 | 传输超时。 |
174
175
176## 函数说明
177
178
179### OH_Usb_ClaimInterface()
180
181
182```
183int32_t OH_Usb_ClaimInterface (uint64_t deviceId, uint8_t interfaceIndex, uint64_t * interfaceHandle)
184```
185
186**描述:**
187
188声明接口。
189
190**需要权限**:ohos.permission.ACCESS_DDK_USB
191
192**参数:**
193
194| 名称 | 描述 |
195| -------- | -------- |
196| deviceId | 设备ID,代表要操作的设备。 |
197| interfaceIndex | 接口索引,对应USB协议中的[bInterfaceNumber](_usb_interface_descriptor.md#binterfacenumber)。 |
198| interfaceHandle | 接口操作句柄,接口声明成功后,该参数将会被赋值。 |
199
200**返回:**
201
202- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
203- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
204- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
205- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参interfaceHandle为空指针。
206
207
208### OH_Usb_CreateDeviceMemMap()
209
210
211```
212int32_t OH_Usb_CreateDeviceMemMap (uint64_t deviceId, size_t size, UsbDeviceMemMap ** devMmap)
213```
214
215**描述:**
216
217创建缓冲区。请在缓冲区使用完后,调用[OH_Usb_DestroyDeviceMemMap()](#oh_usb_destroydevicememmap)销毁缓冲区,否则会造成资源泄露。
218
219**需要权限**:ohos.permission.ACCESS_DDK_USB
220
221**参数:**
222
223| 名称 | 描述 |
224| -------- | -------- |
225| deviceId | 设备ID,代表要创建缓冲区的设备。 |
226| size | 缓冲区的大小。 |
227| devMmap | 创建的缓冲区通过该参数返回给调用者。 |
228
229**返回:**
230
231- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
232- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
233- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参devMmap为空指针。
234- [USB_DDK_MEMORY_ERROR](#usbddkerrcode):表示mmap失败或者申请devMmap的内存空间失败。
235
236
237### OH_Usb_DestroyDeviceMemMap()
238
239
240```
241void OH_Usb_DestroyDeviceMemMap (UsbDeviceMemMap * devMmap)
242```
243
244**描述:**
245
246销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区,否则会造成资源泄露。
247
248**需要权限**:ohos.permission.ACCESS_DDK_USB
249
250**参数:**
251
252| 名称 | 描述 |
253| -------- | -------- |
254| devMmap | 销毁由[OH_Usb_CreateDeviceMemMap()](#oh_usb_createdevicememmap)创建的缓冲区。 |
255
256
257### OH_Usb_FreeConfigDescriptor()
258
259
260```
261void OH_Usb_FreeConfigDescriptor (struct UsbDdkConfigDescriptor *const config)
262```
263
264**描述:**
265
266释放配置描述符,请在描述符使用完后释放描述符,否则会造成内存泄露。
267
268**需要权限**:ohos.permission.ACCESS_DDK_USB
269
270**参数:**
271
272| 名称 | 描述 |
273| -------- | -------- |
274| config | 配置描述符,通过[OH_Usb_GetConfigDescriptor()](#oh_usb_getconfigdescriptor)获得的配置描述符。 |
275
276
277### OH_Usb_GetConfigDescriptor()
278
279
280```
281int32_t OH_Usb_GetConfigDescriptor (uint64_t deviceId, uint8_t configIndex, struct UsbDdkConfigDescriptor **const config)
282```
283
284**描述:**
285
286获取配置描述符。请在描述符使用完后使用[OH_Usb_FreeConfigDescriptor()](#oh_usb_freeconfigdescriptor)释放描述符,否则会造成内存泄露。
287
288**需要权限**:ohos.permission.ACCESS_DDK_USB
289
290**参数:**
291
292| 名称 | 描述 |
293| -------- | -------- |
294| deviceId | 设备ID,代表要获取配置描述符的设备。 |
295| configIndex | 配置id,对应USB协议中的[bConfigurationValue](_usb_config_descriptor.md#bconfigurationvalue)。 |
296| config | 配置描述符,包含USB协议中定义的标准配置描述符,以及与其关联的接口描述符和端点描述符。 |
297
298**返回:**
299
300- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
301- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
302- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
303- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参config为空指针。
304- [USB_DDK_IO_FAILED](#usbddkerrcode):表示设备I/O操作失败。
305
306
307### OH_Usb_GetCurrentInterfaceSetting()
308
309
310```
311int32_t OH_Usb_GetCurrentInterfaceSetting (uint64_t interfaceHandle, uint8_t * settingIndex)
312```
313
314**描述:**
315
316获取接口当前激活的备用设置。
317
318**需要权限**:ohos.permission.ACCESS_DDK_USB
319
320**参数:**
321
322| 名称 | 描述 |
323| -------- | -------- |
324| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
325| settingIndex | 备用设置索引,对应USB协议中的[bAlternateSetting](_usb_interface_descriptor.md#balternatesetting)。 |
326
327**返回:**
328
329- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
330- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
331- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
332- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参settingIndex为空指针。
333
334
335### OH_Usb_GetDeviceDescriptor()
336
337
338```
339int32_t OH_Usb_GetDeviceDescriptor (uint64_t deviceId, struct UsbDeviceDescriptor * desc)
340```
341
342**描述:**
343
344获取设备描述符。
345
346**需要权限**:ohos.permission.ACCESS_DDK_USB
347
348**参数:**
349
350| 名称 | 描述 |
351| -------- | -------- |
352| deviceId | 设备ID,代表要获取描述符的设备。 |
353| desc | 设备描述符,详细定义请参考[UsbDeviceDescriptor](_usb_device_descriptor.md)。 |
354
355**返回:**
356
357- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
358- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
359- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
360- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参desc为空指针。
361
362### OH_Usb_Init()
363
364
365```
366int32_t OH_Usb_Init (void )
367```
368
369**描述:**
370
371初始化DDK。
372
373**需要权限**:ohos.permission.ACCESS_DDK_USB
374
375**返回:**
376
377- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
378- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
379- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
380
381### OH_Usb_Release()
382
383
384```
385void OH_Usb_Release (void)
386```
387
388**描述:**
389
390释放DDK。
391
392**需要权限**:ohos.permission.ACCESS_DDK_USB
393
394### OH_Usb_ReleaseResource()<sup>14+</sup>
395
396```
397int32_t OH_Usb_ReleaseResource (void)
398```
399
400**描述:**
401
402释放DDK。
403
404**需要权限**:ohos.permission.ACCESS_DDK_USB
405
406**返回:**
407
408- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
409- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
410- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
411
412### OH_Usb_ReleaseInterface()
413
414```
415int32_t OH_Usb_ReleaseInterface (uint64_t interfaceHandle)
416```
417
418**描述:**
419
420释放接口。
421
422**需要权限**:ohos.permission.ACCESS_DDK_USB
423
424**参数:**
425
426| 名称 | 描述 |
427| -------- | -------- |
428| interfaceHandle | 接口操作句柄,代表要释放的接口。 |
429
430**返回:**
431
432- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
433- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
434- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
435
436
437### OH_Usb_SelectInterfaceSetting()
438
439
440```
441int32_t OH_Usb_SelectInterfaceSetting (uint64_t interfaceHandle, uint8_t settingIndex)
442```
443
444**描述:**
445
446激活接口的备用设置。
447
448**需要权限**:ohos.permission.ACCESS_DDK_USB
449
450**参数:**
451
452| 名称 | 描述 |
453| -------- | -------- |
454| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
455| settingIndex | 备用设置索引,对应USB协议中的[bAlternateSetting](_usb_interface_descriptor.md#balternatesetting)。 |
456
457**返回:**
458
459- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
460- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
461- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
462
463
464### OH_Usb_SendControlReadRequest()
465
466
467```
468int32_t OH_Usb_SendControlReadRequest (uint64_t interfaceHandle, const struct UsbControlRequestSetup * setup, uint32_t timeout, uint8_t * data, uint32_t * dataLen )
469```
470
471**描述:**
472
473发送控制读请求,该接口为同步接口。
474
475**需要权限**:ohos.permission.ACCESS_DDK_USB
476
477**参数:**
478
479| 名称 | 描述 |
480| -------- | -------- |
481| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
482| setup | 请求相关的参数,详细定义请参考 [UsbControlRequestSetup](_usb_control_request_setup.md)。 |
483| timeout | 超时时间,单位为毫秒。 |
484| data | 要传输的数据。 |
485| dataLen | 表示data的数据长度,在函数返回后,表示实际读取到的数据的长度。 |
486
487**返回:**
488
489- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
490- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
491- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
492- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参setup、data或者dataLen为空指针,亦或datalen小于读取到的数据长度。
493- [USB_DDK_MEMORY_ERROR](#usbddkerrcode):表示拷贝读取数据的内存失败。
494- [USB_DDK_IO_FAILED](#usbddkerrcode):表示设备I/O操作失败。
495- [USB_DDK_TIMEOUT](#usbddkerrcode):表示请求超时。
496
497
498### OH_Usb_SendControlWriteRequest()
499
500
501```
502int32_t OH_Usb_SendControlWriteRequest (uint64_t interfaceHandle, const struct UsbControlRequestSetup * setup, uint32_t timeout, const uint8_t * data, uint32_t dataLen)
503```
504
505**描述:**
506
507发送控制写请求,该接口为同步接口。
508
509**需要权限**:ohos.permission.ACCESS_DDK_USB
510
511**参数:**
512
513| 名称 | 描述 |
514| -------- | -------- |
515| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
516| setup | 请求相关的参数,详细定义请参考 [UsbControlRequestSetup](_usb_control_request_setup.md)。 |
517| timeout | 超时时间,单位为毫秒。 |
518| data | 要传输的数据。 |
519| dataLen | 表示data的数据长度。 |
520
521**返回:**
522
523- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
524- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
525- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
526- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参setup或者data为空指针。
527- [USB_DDK_IO_FAILED](#usbddkerrcode):表示设备I/O操作失败。
528- [USB_DDK_TIMEOUT](#usbddkerrcode):表示请求超时。
529
530
531### OH_Usb_SendPipeRequest()
532
533
534```
535int32_t OH_Usb_SendPipeRequest (const struct UsbRequestPipe * pipe, UsbDeviceMemMap * devMmap)
536```
537
538**描述:**
539
540发送管道请求,该接口为同步接口。中断传输和批量传输都使用该接口发送请求。
541
542**需要权限**:ohos.permission.ACCESS_DDK_USB
543
544**参数:**
545
546| 名称 | 描述 |
547| -------- | -------- |
548| pipe | 要传输数据的管道信息。 |
549| devMmap | 数据缓冲区,可以通过[OH_Usb_CreateDeviceMemMap()](#oh_usb_createdevicememmap)获得。 |
550
551**返回:**
552
553- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
554- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
555- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
556- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参pipe、devMmap或者devMmap的地址为空指针。
557- [USB_DDK_IO_FAILED](#usbddkerrcode):表示设备I/O操作失败。
558- [USB_DDK_TIMEOUT](#usbddkerrcode):表示请求超时。
559
560### OH_Usb_SendPipeRequestWithAshmem()<sup>12+</sup>
561
562
563```
564int32_t OH_Usb_SendPipeRequestWithAshmem(const struct UsbRequestPipe *pipe, DDK_Ashmem *ashmem)
565```
566
567**描述:**
568
569发送共享内存的管道请求,该接口为同步接口。中断传输和批量传输都使用该接口发送请求。
570
571**需要权限**:ohos.permission.ACCESS_DDK_USB
572
573**参数:**
574
575| 名称 | 描述 |
576| -------- | -------- |
577| pipe | 要传输数据的管道信息。 |
578| ashmem | 共享内存,可以通过[OH_DDK_CreateAshmem()](_base_ddk.md#oh_ddk_createashmem)获得。 |
579
580**返回:**
581
582- [USB_DDK_SUCCESS](#usbddkerrcode):表示调用接口成功。
583- [USB_DDK_NO_PERM](#usbddkerrcode):表示权限校验失败。
584- [USB_DDK_INVALID_OPERATION](#usbddkerrcode):表示连接usb_ddk服务失败。
585- [USB_DDK_INVALID_PARAMETER](#usbddkerrcode):表示入参pipe、ashmem或者ashmem的地址为空指针。
586- [USB_DDK_IO_FAILED](#usbddkerrcode):表示设备I/O操作失败。
587- [USB_DDK_TIMEOUT](#usbddkerrcode):表示请求超时。
588