Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
65afc80b
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
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,发现更多精彩内容 >>
未验证
提交
65afc80b
编写于
7月 11, 2023
作者:
O
openharmony_ci
提交者:
Gitee
7月 11, 2023
浏览文件
操作
浏览文件
下载
差异文件
!20735 【轻量级 PR】:update zh-cn/application-dev/reference/native-apis/_usb_ddk.md.
Merge pull request !20735 from 葛亚芳/N/A
上级
394a12ad
bd887fdb
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
24 addition
and
24 deletion
+24
-24
zh-cn/application-dev/reference/native-apis/_usb_ddk.md
zh-cn/application-dev/reference/native-apis/_usb_ddk.md
+24
-24
未找到文件。
zh-cn/application-dev/reference/native-apis/_usb_ddk.md
浏览文件 @
65afc80b
...
@@ -19,19 +19,19 @@
...
@@ -19,19 +19,19 @@
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| -------- | -------- |
|
[
usb_ddk_api.h
](
usb__ddk__api_8h.md
)
| 声明用于主机侧访问设备的USB
DDK接口。
<br/>
引用文件:
<
usb/usb_ddk_api.h
>
|
|
[
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
>
|
|
[
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。 |
|
[
UsbControlRequestSetup
](
_usb_control_request_setup.md
)
| 控制传输setup包,对应USB协议中的Setup
Data。 |
|
[
UsbDeviceDescriptor
](
_usb_device_descriptor.md
)
| 标准设备描述符,对应USB协议中Standard
Device
Descriptor。 |
|
[
UsbDeviceDescriptor
](
_usb_device_descriptor.md
)
| 标准设备描述符,对应USB协议中Standard
Device
Descriptor。 |
|
[
UsbConfigDescriptor
](
_usb_config_descriptor.md
)
| 标准配置描述符,对应USB协议中Standard
Configuration
Descriptor。 |
|
[
UsbConfigDescriptor
](
_usb_config_descriptor.md
)
| 标准配置描述符,对应USB协议中Standard
Configuration
Descriptor。 |
|
[
UsbInterfaceDescriptor
](
_usb_interface_descriptor.md
)
| 标准接口描述符,对应USB协议中Standard
Interface
Descriptor。 |
|
[
UsbInterfaceDescriptor
](
_usb_interface_descriptor.md
)
| 标准接口描述符,对应USB协议中Standard
Interface
Descriptor。 |
|
[
UsbEndpointDescriptor
](
_usb_endpoint_descriptor.md
)
| 标准端点描述符,对应USB协议中Standard
Endpoint
Descriptor。 |
|
[
UsbEndpointDescriptor
](
_usb_endpoint_descriptor.md
)
| 标准端点描述符,对应USB协议中Standard
Endpoint
Descriptor。 |
|
[
UsbDdkEndpointDescriptor
](
_usb_ddk_endpoint_descriptor.md
)
| 端点描述符。 |
|
[
UsbDdkEndpointDescriptor
](
_usb_ddk_endpoint_descriptor.md
)
| 端点描述符。 |
|
[
UsbDdkInterfaceDescriptor
](
_usb_ddk_interface_descriptor.md
)
| 接口描述符。 |
|
[
UsbDdkInterfaceDescriptor
](
_usb_ddk_interface_descriptor.md
)
| 接口描述符。 |
|
[
UsbDdkInterface
](
_usb_ddk_interface.md
)
| USB接口,是特定接口下备用设置的集合。 |
|
[
UsbDdkInterface
](
_usb_ddk_interface.md
)
| USB接口,是特定接口下备用设置的集合。 |
...
@@ -55,27 +55,27 @@
...
@@ -55,27 +55,27 @@
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| -------- | -------- |
|
[
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
错误码定义。 |
|
[
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_Init
](
#oh_usb_init
)
(
void
)
| 初始化DDK。 |
|
[
OH_Usb_Release
](
#oh_usb_release
)
(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_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_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_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_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_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_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_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_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_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_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_create
devicememmap
)
销毁缓冲区,否则会造成资源泄露。 |
|
[
OH_Usb_CreateDeviceMemMap
](
#oh_usb_createdevicememmap
)
(
uint64_t
deviceId, size_t size,
[
UsbDeviceMemMap
](
_usb_device_mem_map.md
)
\*\*
devMmap) | 创建缓冲区。请在缓冲区使用完后,调用
[
OH_Usb_DestroyDeviceMemMap()
](
#oh_usb_destroy
devicememmap
)
销毁缓冲区,否则会造成资源泄露。 |
|
[
OH_Usb_DestroyDeviceMemMap
](
#oh_usb_destroydevicememmap
)
([UsbDeviceMemMap](_usb_device_mem_map.md)
\*
devMmap) | 销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区,否则会造成资源泄露。 |
|
[
OH_Usb_DestroyDeviceMemMap
](
#oh_usb_destroydevicememmap
)
(
[UsbDeviceMemMap](_usb_device_mem_map.md
)
\*
devMmap) | 销毁缓冲区。请在缓冲区使用完后及时销毁缓冲区,否则会造成资源泄露。 |
## 类型定义说明
## 类型定义说明
...
@@ -413,7 +413,7 @@ int32_t OH_Usb_SendControlReadRequest (uint64_t interfaceHandle, const struct Us
...
@@ -413,7 +413,7 @@ int32_t OH_Usb_SendControlReadRequest (uint64_t interfaceHandle, const struct Us
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| -------- | -------- |
| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
| setup | 请求相关的参数,详细定义请参考
[
UsbControlRequestSetup
](
_usb_control_request_setup.md
)
。 |
| setup | 请求相关的参数,详细定义请参考
[
UsbControlRequestSetup
](
_usb_control_request_setup.md
)
。 |
| timeout | 超时时间,单位为毫秒。 |
| timeout | 超时时间,单位为毫秒。 |
| data | 要传输的数据。 |
| data | 要传输的数据。 |
| dataLen | 表示data的数据长度,在函数返回后,表示实际读取到的数据的长度。 |
| dataLen | 表示data的数据长度,在函数返回后,表示实际读取到的数据的长度。 |
...
@@ -439,7 +439,7 @@ int32_t OH_Usb_SendControlWriteRequest (uint64_t interfaceHandle, const struct U
...
@@ -439,7 +439,7 @@ int32_t OH_Usb_SendControlWriteRequest (uint64_t interfaceHandle, const struct U
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| -------- | -------- |
| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
| interfaceHandle | 接口操作句柄,代表要操作的接口。 |
| setup | 请求相关的参数,详细定义请参考
[
UsbControlRequestSetup
](
_usb_control_request_setup.md
)
。 |
| setup | 请求相关的参数,详细定义请参考
[
UsbControlRequestSetup
](
_usb_control_request_setup.md
)
。 |
| timeout | 超时时间,单位为毫秒。 |
| timeout | 超时时间,单位为毫秒。 |
| data | 要传输的数据。 |
| data | 要传输的数据。 |
| dataLen | 表示data的数据长度。 |
| dataLen | 表示data的数据长度。 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录