Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
4062ea51
D
Docs
项目概览
OpenHarmony
/
Docs
11 个月 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
4062ea51
编写于
6月 13, 2023
作者:
葛
葛亚芳
提交者:
Gitee
6月 13, 2023
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update
Signed-off-by:
N
葛亚芳
<
geyafang@huawei.com
>
上级
dcf804ae
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
472 addition
and
0 deletion
+472
-0
zh-cn/application-dev/reference/native-apis/_usb_ddk.md
zh-cn/application-dev/reference/native-apis/_usb_ddk.md
+472
-0
未找到文件。
zh-cn/application-dev/reference/native-apis/_usb_ddk.md
0 → 100644
浏览文件 @
4062ea51
# UsbDdk
## 概述
提供USB DDK接口,包括主机侧打开和关闭接口、管道同步异步读写通信、控制传输、中断传输等。
\@
syscap SystemCapability.Driver.USB.Extension
**起始版本:**
10
## 汇总
### 文件
| 名称 | 描述 |
| -------- | -------- |
|
[
usb_ddk_api.h
](
usb__ddk__api_8h.md
)
| 声明用于主机侧访问设备的USB
DDK接口。
<br/>
引用文件:
<
usb/usb_ddk_api.h
>
|
|
[
usb_ddk_types.h
](
usb__ddk__types_8h.md
)
| 提供USB
DDK中的枚举变量、结构体定义与宏定义。
<br/>
引用文件:
<
usb/usb_ddk_types.h
>
|
### 结构体
| 名称 | 描述 |
| -------- | -------- |
|
[
UsbControlRequestSetup
](
_usb_control_request_setup.md
)
| 控制传输setup包,对应USB协议中的Setup
Data。 |
|
[
UsbDeviceDescriptor
](
_usb_device_descriptor.md
)
| 标准设备描述符,对应USB协议中Standard
Device
Descriptor。 |
|
[
UsbConfigDescriptor
](
_usb_config_descriptor.md
)
| 标准配置描述符,对应USB协议中Standard
Configuration
Descriptor。 |
|
[
UsbInterfaceDescriptor
](
_usb_interface_descriptor.md
)
| 标准接口描述符,对应USB协议中Standard
Interface
Descriptor。 |
|
[
UsbEndpointDescriptor
](
_usb_endpoint_descriptor.md
)
| 标准端点描述符,对应USB协议中Standard
Endpoint
Descriptor。 |
|
[
UsbDdkEndpointDescriptor
](
_usb_ddk_endpoint_descriptor.md
)
| 端点描述符。 |
|
[
UsbDdkInterfaceDescriptor
](
_usb_ddk_interface_descriptor.md
)
| 接口描述符。 |
|
[
UsbDdkInterface
](
_usb_ddk_interface.md
)
| USB接口,是特定接口下备用设置的集合。 |
|
[
UsbDdkConfigDescriptor
](
_usb_ddk_config_descriptor.md
)
| 配置描述符。 |
|
[
UsbRequestPipe
](
_usb_request_pipe.md
)
| 请求管道。 |
|
[
UsbDeviceMemMap
](
_usb_device_mem_map.md
)
| 设备内存映射,通过
[
OH_Usb_CreateDeviceMemMap()
](
#oh_usb_createdevicememmap
)
创建设备内存映射,使用内存映射后的缓冲区,获得更好的性能。 |
### 类型定义
| 名称 | 描述 |
| -------- | -------- |
|
[
UsbDdkEndpointDescriptor
](
#usbddkendpointdescriptor
)
| 端点描述符。 |
|
[
UsbDdkInterfaceDescriptor
](
#usbddkinterfacedescriptor
)
| 接口描述符。 |
|
[
UsbDdkInterface
](
#usbddkinterface
)
| USB接口,是特定接口下备用设置的集合。 |
|
[
UsbDdkConfigDescriptor
](
#usbddkconfigdescriptor
)
| 配置描述符。 |
|
[
UsbDeviceMemMap
](
#usbdevicememmap
)
| 设备内存映射,通过
[
OH_Usb_CreateDeviceMemMap()
](
#oh_usb_createdevicememmap
)
创建设备内存映射,使用内存映射后的缓冲区,获得更好的性能。 |
### 枚举
| 名称 | 描述 |
| -------- | -------- |
|
[
UsbDdkErrCode
](
#usbddkerrcode
)
{
<br/>
USB_DDK_SUCCESS
=
0,
USB_DDK_FAILED
=
-1,
USB_DDK_INVALID_PARAMETER
=
-2,
USB_DDK_MEMORY_ERROR
=
-3,
<br/>
USB_DDK_INVALID_OPERATION
=
-4,
USB_DDK_NULL_PTR
=
-5,
USB_DDK_DEVICE_BUSY
=
-6,
USB_DDK_TIMEOUT
=
-7
<br/>
} | USB
DDK
错误码定义。 |
### 函数
| 名称 | 描述 |
| -------- | -------- |
|
[
OH_Usb_Init
](
#oh_usb_init
)
(void) | 初始化DDK。 |
|
[
OH_Usb_Release
](
#oh_usb_release
)
(void) | 释放DDK。 |
|
[
OH_Usb_GetDeviceDescriptor
](
#oh_usb_getdevicedescriptor
)
(uint64_t
deviceId,
struct
[UsbDeviceDescriptor](_usb_device_descriptor.md)
\*
desc) | 获取设备描述符。 |
|
[
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
)
释放描述符,否则会造成内存泄露。 |
|
[
OH_Usb_FreeConfigDescriptor
](
#oh_usb_freeconfigdescriptor
)
(const
struct
[UsbDdkConfigDescriptor](_usb_ddk_config_descriptor.md)
\*const
config) | 释放配置描述符,请在描述符使用完后释放描述符,否则会造成内存泄露。 |
|
[
OH_Usb_ClaimInterface
](
#oh_usb_claiminterface
)
(uint64_t
deviceId,
uint8_t
interfaceIndex,
uint64_t
\*
[
interfaceHandle
](
usb__ddk__types_8h.md#interfacehandle
)
) | 声明接口。 |
|
[
OH_Usb_ReleaseInterface
](
#oh_usb_releaseinterface
)
(uint64_t
[
interfaceHandle
](
usb__ddk__types_8h.md#interfacehandle
)
) | 释放接口。 |
|
[
OH_Usb_SelectInterfaceSetting
](
#oh_usb_selectinterfacesetting
)
(uint64_t
[interfaceHandle](usb__ddk__types_8h.md#interfacehandle),
uint8_t
settingIndex) | 激活接口的备用设置。 |
|
[
OH_Usb_GetCurrentInterfaceSetting
](
#oh_usb_getcurrentinterfacesetting
)
(uint64_t
[interfaceHandle](usb__ddk__types_8h.md#interfacehandle),
uint8_t
\*
settingIndex) | 获取接口当前激活的备用设置。 |
|
[
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) | 发送控制读请求,该接口为同步接口。 |
|
[
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) | 发送控制写请求,该接口为同步接口。 |
|
[
OH_Usb_SendPipeRequest
](
#oh_usb_sendpiperequest
)
(const
struct
[UsbRequestPipe](_usb_request_pipe.md)
\*pipe,
[UsbDeviceMemMap](_usb_device_mem_map.md)
\*
devMmap) | 发送管道请求,该接口为同步接口。中断传输和批量传输都使用该接口发送请求。 |
|
[
OH_Usb_CreateDeviceMemMap
](
#oh_usb_createdevicememmap
)
(uint64_t
deviceId,
size_t
size,
[UsbDeviceMemMap](_usb_device_mem_map.md)
\*\*
devMmap) | 创建缓冲区。请在缓冲区使用完后,调用
[
OH_Usb_CreateDeviceMemMap()
](
#oh_usb_createdevicememmap
)
销毁缓冲区,否则会造成资源泄露。 |
|
[
OH_Usb_DestroyDeviceMemMap
](
#oh_usb_destroydevicememmap
)
([UsbDeviceMemMap](_usb_device_mem_map.md)
\*
devMmap) | 销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区,否则会造成资源泄露。 |
## 类型定义说明
### UsbDdkConfigDescriptor
```
typedef struct UsbDdkConfigDescriptor UsbDdkConfigDescriptor
```
**描述:**
配置描述符。
### UsbDdkEndpointDescriptor
```
typedef struct UsbDdkEndpointDescriptor UsbDdkEndpointDescriptor
```
**描述:**
端点描述符。
### UsbDdkInterface
```
typedef struct UsbDdkInterface UsbDdkInterface
```
**描述:**
USB接口,是特定接口下备用设置的集合。
### UsbDdkInterfaceDescriptor
```
typedef struct UsbDdkInterfaceDescriptor UsbDdkInterfaceDescriptor
```
**描述:**
接口描述符。
### UsbDeviceMemMap
```
typedef struct UsbDeviceMemMap UsbDeviceMemMap
```
**描述:**
设备内存映射,通过
[
OH_Usb_CreateDeviceMemMap()
](
#oh_usb_createdevicememmap
)
创建设备内存映射,使用内存映射后的缓冲区,获得更好的性能。
## 枚举类型说明
### UsbDdkErrCode
```
enum UsbDdkErrCode
```
**描述:**
USB DDK 错误码定义。
| 枚举值 | 描述 |
| -------- | -------- |
| USB_DDK_SUCCESS | 操作成功。 |
| USB_DDK_FAILED | 操作失败。 |
| USB_DDK_INVALID_PARAMETER | 非法参数。 |
| USB_DDK_MEMORY_ERROR | 内存相关的错误,包括:内存不足、内存数据拷贝失败、内存申请失败等。 |
| USB_DDK_INVALID_OPERATION | 非法操作。 |
| USB_DDK_NULL_PTR | 空指针异常。 |
| USB_DDK_DEVICE_BUSY | 设备忙。 |
| USB_DDK_TIMEOUT | 传输超时。 |
## 函数说明
### OH_Usb_ClaimInterface()
```
int32_t OH_Usb_ClaimInterface (uint64_t deviceId, uint8_t interfaceIndex, uint64_t * interfaceHandle )
```
**描述:**
声明接口。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| deviceId | 设备ID,代表要操作的设备。 |
| interfaceIndex | 接口索引,对应USB协议中的
[
bInterfaceNumber
](
_usb_interface_descriptor.md#binterfacenumber
)
。 |
| interfaceHandle | 接口操作句柄,接口声明成功后,该参数将会被赋值。 |
**返回:**
成功返回0,否则返回负数。
### OH_Usb_CreateDeviceMemMap()
```
int32_t OH_Usb_CreateDeviceMemMap (uint64_t deviceId, size_t size, UsbDeviceMemMap ** devMmap )
```
**描述:**
创建缓冲区。请在缓冲区使用完后,调用
[
OH_Usb_DestroyDeviceMemMap()
](
#oh_usb_destroydevicememmap
)
销毁缓冲区,否则会造成资源泄露。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| deviceId | 设备ID,代表要创建缓冲区的设备。 |
| size | 缓冲区的大小。 |
| devMmap | 创建的缓冲区通过该参数返回给调用者。 |
**返回:**
成功返回0,否则返回负数。
### OH_Usb_DestroyDeviceMemMap()
```
void OH_Usb_DestroyDeviceMemMap (UsbDeviceMemMap * devMmap)
```
**描述:**
销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区,否则会造成资源泄露。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| devMmap | 销毁由
[
OH_Usb_CreateDeviceMemMap()
](
#oh_usb_createdevicememmap
)
创建的缓冲区。 |
### OH_Usb_FreeConfigDescriptor()
```
void OH_Usb_FreeConfigDescriptor (const struct UsbDdkConfigDescriptor *const config)
```
**描述:**
释放配置描述符,请在描述符使用完后释放描述符,否则会造成内存泄露。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| config | 配置描述符,通过
[
OH_Usb_GetConfigDescriptor()
](
#oh_usb_getconfigdescriptor
)
获得的配置描述符。 |
### OH_Usb_GetConfigDescriptor()
```
int32_t OH_Usb_GetConfigDescriptor (uint64_t deviceId, uint8_t configIndex, struct UsbDdkConfigDescriptor **const config )
```
**描述:**
获取配置描述符。请在描述符使用完后使用
[
OH_Usb_FreeConfigDescriptor()
](
#oh_usb_freeconfigdescriptor
)
释放描述符,否则会造成内存泄露。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| deviceId | 设备ID,代表要获取配置描述符的设备。 |
| configIndex | 配置id,对应USB协议中的
[
bConfigurationValue
](
_usb_config_descriptor.md#bconfigurationvalue
)
。 |
| config | 配置描述符,包含USB协议中定义的标准配置描述符,以及与其关联的接口描述符和端点描述符。 |
**返回:**
成功返回0,否则返回负数。
### OH_Usb_GetCurrentInterfaceSetting()
```
int32_t OH_Usb_GetCurrentInterfaceSetting (uint64_t interfaceHandle, uint8_t * settingIndex )
```
**描述:**
获取接口当前激活的备用设置。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
| settingIndex | 备用设置索引,对应USB协议中的
[
bAlternateSetting
](
_usb_interface_descriptor.md#balternatesetting
)
。 |
**返回:**
成功返回0,否则返回负数。
### OH_Usb_GetDeviceDescriptor()
```
int32_t OH_Usb_GetDeviceDescriptor (uint64_t deviceId, struct UsbDeviceDescriptor * desc )
```
**描述:**
获取设备描述符。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| deviceId | 设备ID,代表要获取描述符的设备。 |
| desc | 设备描述符,详细定义请参考
[
UsbDeviceDescriptor
](
_usb_device_descriptor.md
)
。 |
**返回:**
成功返回0,否则返回负数。
### OH_Usb_Init()
```
int32_t OH_Usb_Init (void )
```
**描述:**
初始化DDK。
**返回:**
成功返回0,否则返回负数。
### OH_Usb_Release()
```
void OH_Usb_Release (void )
```
**描述:**
释放DDK。
### OH_Usb_ReleaseInterface()
```
int32_t OH_Usb_ReleaseInterface (uint64_t interfaceHandle)
```
**描述:**
释放接口。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| interfaceHandle | 接口操作句柄,代表要释放的接口。 |
**返回:**
成功返回0,否则返回负数。
### OH_Usb_SelectInterfaceSetting()
```
int32_t OH_Usb_SelectInterfaceSetting (uint64_t interfaceHandle, uint8_t settingIndex )
```
**描述:**
激活接口的备用设置。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
| settingIndex | 备用设置索引,对应USB协议中的
[
bAlternateSetting
](
_usb_interface_descriptor.md#balternatesetting
)
。 |
**返回:**
成功返回0,否则返回负数。
### OH_Usb_SendControlReadRequest()
```
int32_t OH_Usb_SendControlReadRequest (uint64_t interfaceHandle, const struct UsbControlRequestSetup * setup, uint32_t timeout, uint8_t * data, uint32_t * dataLen )
```
**描述:**
发送控制读请求,该接口为同步接口。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
| setup | 请求相关的参数,详细定义请参考
[
UsbControlRequestSetup
](
_usb_control_request_setup.md
)
。 |
| timeout | 超时时间,单位为毫秒。 |
| data | 要传输的数据。 |
| dataLen | 表示data的数据长度,在函数返回后,表示实际读取到的数据的长度。 |
**返回:**
成功返回0,否则返回负数。
### OH_Usb_SendControlWriteRequest()
```
int32_t OH_Usb_SendControlWriteRequest (uint64_t interfaceHandle, const struct UsbControlRequestSetup * setup, uint32_t timeout, const uint8_t * data, uint32_t dataLen )
```
**描述:**
发送控制写请求,该接口为同步接口。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
| setup | 请求相关的参数,详细定义请参考
[
UsbControlRequestSetup
](
_usb_control_request_setup.md
)
。 |
| timeout | 超时时间,单位为毫秒。 |
| data | 要传输的数据。 |
| dataLen | 表示data的数据长度。 |
**返回:**
成功返回0,否则返回负数。
### OH_Usb_SendPipeRequest()
```
int32_t OH_Usb_SendPipeRequest (const struct UsbRequestPipe * pipe, UsbDeviceMemMap * devMmap )
```
**描述:**
发送管道请求,该接口为同步接口。中断传输和批量传输都使用该接口发送请求。
**参数:**
| 名称 | 描述 |
| -------- | -------- |
| pipe | 要传输数据的管道信息。 |
| devMmap | 数据缓冲区,可以通过
[
OH_Usb_CreateDeviceMemMap()
](
#oh_usb_createdevicememmap
)
获得。 |
**返回:**
成功返回0,否则返回负数。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录