Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 4ac779c5 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!7370 HDI接口更新【不需要翻译】 

Merge pull request !7370 from duangavin123/OpenHarmony-3.2-Beta2
上级 8c853462 a3ed18fa
展开全部 显示空白变更内容
内联 并排
Showing with 1807 addition and 1052 deletion
zh-cn/device-dev/reference/hdi-apis/Readme-CN.md
浏览文件 @ 4ac779c5
......@@ -122,7 +122,6 @@
- [CompVerInfo](_comp_ver_info.md)
- [CredentialInfo](_credential_info.md)
- [DeviceFuncs](_device_funcs.md)
- [DeviceInfo](_device_info.md)
- [DisplayCapability](_display_capability.md)
- [DisplayInfo](_display_info.md)
- [DisplayModeInfo](_display_mode_info.md)
......@@ -130,7 +129,6 @@
- [EnrollParam](_enroll_param.md)
- [EnrollResultInfo](_enroll_resultinfo.md)
- [EventInfo](_event_info.md)
- [EventPackage](_event_package.md)
- [ExecutorInfo](_executor_info.md)
- [ExecutorInfo](_user_executor_info.md)
- [ExecutorRegisterInfo](_executor_register_info.md)
......@@ -154,10 +152,19 @@
- [IInputInterface](_i_input_interface.md)
- [ILine](_i_line.md)
- [InputController](_input_controller.md)
- [InputDevAbility](_input_dev_ability.md)
- [InputDevAttr](_input_dev_attr.md)
- [InputDevDesc](_input_dev_desc.md)
- [InputDevIdentify](_input_dev_identify.md)
- [InputDeviceInfo](_device_info.md)
- [InputDimensionInfo](_input_dimension_info.md)
- [InputEventCb](_input_report_event_cb.md)
- [InputEventPackage](_event_package.md)
- [InputExtraCmd](_input_extra_cmd.md)
- [InputHostCb](_input_host_cb.md)
- [InputHotPlugEvent](_input_hotplug_event.md)
- [InputManager](_input_manager.md)
- [InputReporter](_input_reporter.md)
- [InputReportEventCb](_input_report_event_cb.md)
- [IPinAuthInterface](interface_i_pin_auth_interface.md)
- [IPowerHdiCallback](interface_i_power_hdi_callback.md)
- [IPowerInterface](interface_i_power_interface.md)
......
zh-cn/device-dev/reference/hdi-apis/_audio_port_capability.md
浏览文件 @ 4ac779c5
......@@ -26,7 +26,7 @@
| [subPortsNum](_audio.md#subportsnum) | 支持的子端口数目（仅用于输出设备）。 |
| [subPorts](_audio.md#subports) | 支持的子端口列表。 |
| [supportSampleFormatNum](_audio.md#supportsampleformatnum) | 支持的音频样本格式数量。 |
| [supportSampleFormats](_audio.md#supportsampleformats) | 支持的音频样本格式，详请参考[AudioSampleFormat](_codec.md#audiosampleformat)。 |
| [supportSampleFormats](_audio.md#supportsampleformats) | 支持的音频样本格式，详请参考[AudioSampleFormat](_audio.md#audiosampleformat)。 |
## **详细描述**
......
zh-cn/device-dev/reference/hdi-apis/_audio_scene_descriptor.md
浏览文件 @ 4ac779c5
......@@ -5,8 +5,7 @@
**所属模块:**
[Audio](_audio.md)[更多...](union_audio_scene_descriptor_1_1_scene_desc.md)
[Audio](_audio.md)
## **汇总**
......
zh-cn/device-dev/reference/hdi-apis/_codec_callback_type.md
浏览文件 @ 4ac779c5
......@@ -16,9 +16,9 @@
| Public 属性 | 描述 |
| -------- | -------- |
| [remote](_codec.md#remote) | 指向HdfRemoteService的指针。 [更多...](_codec.md#remote) |
| ( [EventHandler](_codec.md#eventhandler) )(struct [ERROR:Invalid link:zh-cn_topic_0000001304382300.xml#xref452479393083931,link:zh-cn_topic_0000001304382300.xml](zh-cn_topic_0000001304382300.xml) \*self, enum OMX_EVENTTYPE event, struct [EventInfo](_event_info.md) \*info) | 事件上报。 [更多...](_codec.md#eventhandler) |
| ( [EmptyBufferDone](_codec.md#emptybufferdone) )(struct [ERROR:Invalid link:zh-cn_topic_0000001304382300.xml#xref1077915705083931,link:zh-cn_topic_0000001304382300.xml](zh-cn_topic_0000001304382300.xml) \*self, int8_t \*appData, uint32_t appDataLen, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 上报输入buffer编码或者解码处理完毕。 [更多...](_codec.md#emptybufferdone) |
| ( [FillBufferDone](_codec.md#fillbufferdone) )(struct [ERROR:Invalid link:zh-cn_topic_0000001304382300.xml#xref1123615867083931,link:zh-cn_topic_0000001304382300.xml](zh-cn_topic_0000001304382300.xml) \*self, int8_t \*appData, uint32_t appDataLen, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 上报输出buffer填充完毕。 [更多...](_codec.md#fillbufferdone) |
| ( [EventHandler](_codec.md#eventhandler) )(struct CodecCallbackType \*self, enum OMX_EVENTTYPE event, struct [EventInfo](_event_info.md) \*info) | 事件上报。 [更多...](_codec.md#eventhandler) |
| ( [EmptyBufferDone](_codec.md#emptybufferdone) )(struct CodecCallbackType \*self, int8_t \*appData, uint32_t appDataLen, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 上报输入buffer编码或者解码处理完毕。 [更多...](_codec.md#emptybufferdone) |
| ( [FillBufferDone](_codec.md#fillbufferdone) )(struct CodecCallbackType \*self, int8_t \*appData, uint32_t appDataLen, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 上报输出buffer填充完毕。 [更多...](_codec.md#fillbufferdone) |
## **详细描述**
......
zh-cn/device-dev/reference/hdi-apis/_codec_component_type.md
浏览文件 @ 4ac779c5
......@@ -15,24 +15,24 @@
| Public 属性 | 描述 |
| -------- | -------- |
| ( [GetComponentVersion](_codec.md#getcomponentversion) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1521256091083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, struct [CompVerInfo](_comp_ver_info.md) \*verInfo) | 获取Codec组件版本号。 [更多...](_codec.md#getcomponentversion) |
| ( [SendCommand](_codec.md#sendcommand) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref2020788308083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t \*cmdData, uint32_t cmdDataLen) | 发送命令给组件。 [更多...](_codec.md#sendcommand) |
| ( [GetParameter](_codec.md#getparameter) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref2071182762083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t paramIndex, int8_t \*paramStruct, uint32_t paramStructLen) | 获取组件参数设置。 [更多...](_codec.md#getparameter) |
| ( [SetParameter](_codec.md#setparameter) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1874982936083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t index, int8_t \*paramStruct, uint32_t paramStructLen) | 设置组件需要的参数。 [更多...](_codec.md#setparameter) |
| ( [GetConfig](_codec.md#getconfig) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref921941812083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 获取组件的配置结构。 [更多...](_codec.md#getconfig) |
| ( [SetConfig](_codec.md#setconfig) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1073566491083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 设置组件的配置。 [更多...](_codec.md#setconfig) |
| ( [GetExtensionIndex](_codec.md#getextensionindex) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref68113596083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, const char \*paramName, uint32_t \*indexType) | 根据字符串获取组件的扩展索引。 [更多...](_codec.md#getextensionindex) |
| ( [GetState](_codec.md#getstate) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1226754841083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, enum OMX_STATETYPE \*state) | 获取组件的当前状态。 [更多...](_codec.md#getstate) |
| ( [ComponentTunnelRequest](_codec.md#componenttunnelrequest) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1739461855083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE \*tunnelSetup) | 设置组件采用Tunnel方式通信。 [更多...](_codec.md#componenttunnelrequest) |
| ( [UseBuffer](_codec.md#usebuffer) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref2135329427083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t portIndex, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 指定组件端口的buffer。 [更多...](_codec.md#usebuffer) |
| ( [AllocateBuffer](_codec.md#allocatebuffer) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref857621490083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t portIndex, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 向组件申请端口buffer。 [更多...](_codec.md#allocatebuffer) |
| ( [FreeBuffer](_codec.md#freebuffer) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1026220701083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint32_t portIndex, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 释放buffer。 [更多...](_codec.md#freebuffer) |
| ( [EmptyThisBuffer](_codec.md#emptythisbuffer) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1735359869083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 编解码输入待处理buffer。 [更多...](_codec.md#emptythisbuffer) |
| ( [FillThisBuffer](_codec.md#fillthisbuffer) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1574208746083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 编解码输出填充buffer。 [更多...](_codec.md#fillthisbuffer) |
| ( [SetCallbacks](_codec.md#setcallbacks) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1922857471083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, struct [CodecCallbackType](_codec_callback_type.md) \*callback, int8_t \*appData, uint32_t appDataLen) | 设置Codec组件的回调函数。 [更多...](_codec.md#setcallbacks) |
| ( [ComponentDeInit](_codec.md#componentdeinit) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1721252790083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self) | 组件去初始化。 [更多...](_codec.md#componentdeinit) |
| ( [UseEglImage](_codec.md#useeglimage) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref872648430083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer, uint32_t portIndex, int8_t \*eglImage, uint32_t eglImageLen) | 使用已在EGL中申请的空间。 [更多...](_codec.md#useeglimage) |
| ( [ComponentRoleEnum](_codec.md#componentroleenum) )(struct [ERROR:Invalid link:zh-cn_topic_0000001357501829.xml#xref1661834974083931,link:zh-cn_topic_0000001357501829.xml](zh-cn_topic_0000001357501829.xml) \*self, uint8_t \*role, uint32_t roleLen, uint32_t index) | 获取组件角色。 [更多...](_codec.md#componentroleenum) |
| ( [GetComponentVersion](_codec.md#getcomponentversion) )(struct CodecComponentType \*self, struct [CompVerInfo](_comp_ver_info.md) \*verInfo) | 获取Codec组件版本号。 [更多...](_codec.md#getcomponentversion) |
| ( [SendCommand](_codec.md#sendcommand) )(struct CodecComponentType \*self, enum OMX_COMMANDTYPE cmd, uint32_t param, int8_t \*cmdData, uint32_t cmdDataLen) | 发送命令给组件。 [更多...](_codec.md#sendcommand) |
| ( [GetParameter](_codec.md#getparameter) )(struct CodecComponentType \*self, uint32_t paramIndex, int8_t \*paramStruct, uint32_t paramStructLen) | 获取组件参数设置。 [更多...](_codec.md#getparameter) |
| ( [SetParameter](_codec.md#setparameter) )(struct CodecComponentType \*self, uint32_t index, int8_t \*paramStruct, uint32_t paramStructLen) | 设置组件需要的参数。 [更多...](_codec.md#setparameter) |
| ( [GetConfig](_codec.md#getconfig) )(struct CodecComponentType \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 获取组件的配置结构。 [更多...](_codec.md#getconfig) |
| ( [SetConfig](_codec.md#setconfig) )(struct CodecComponentType \*self, uint32_t index, int8_t \*cfgStruct, uint32_t cfgStructLen) | 设置组件的配置。 [更多...](_codec.md#setconfig) |
| ( [GetExtensionIndex](_codec.md#getextensionindex) )(struct CodecComponentType \*self, const char \*paramName, uint32_t \*indexType) | 根据字符串获取组件的扩展索引。 [更多...](_codec.md#getextensionindex) |
| ( [GetState](_codec.md#getstate) )(struct CodecComponentType \*self, enum OMX_STATETYPE \*state) | 获取组件的当前状态。 [更多...](_codec.md#getstate) |
| ( [ComponentTunnelRequest](_codec.md#componenttunnelrequest) )(struct CodecComponentType \*self, uint32_t port, int32_t tunneledComp, uint32_t tunneledPort, struct OMX_TUNNELSETUPTYPE \*tunnelSetup) | 设置组件采用Tunnel方式通信。 [更多...](_codec.md#componenttunnelrequest) |
| ( [UseBuffer](_codec.md#usebuffer) )(struct CodecComponentType \*self, uint32_t portIndex, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 指定组件端口的buffer。 [更多...](_codec.md#usebuffer) |
| ( [AllocateBuffer](_codec.md#allocatebuffer) )(struct CodecComponentType \*self, uint32_t portIndex, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 向组件申请端口buffer。 [更多...](_codec.md#allocatebuffer) |
| ( [FreeBuffer](_codec.md#freebuffer) )(struct CodecComponentType \*self, uint32_t portIndex, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 释放buffer。 [更多...](_codec.md#freebuffer) |
| ( [EmptyThisBuffer](_codec.md#emptythisbuffer) )(struct CodecComponentType \*self, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 编解码输入待处理buffer。 [更多...](_codec.md#emptythisbuffer) |
| ( [FillThisBuffer](_codec.md#fillthisbuffer) )(struct CodecComponentType \*self, const struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer) | 编解码输出填充buffer。 [更多...](_codec.md#fillthisbuffer) |
| ( [SetCallbacks](_codec.md#setcallbacks) )(struct CodecComponentType \*self, struct [CodecCallbackType](_codec_callback_type.md) \*callback, int8_t \*appData, uint32_t appDataLen) | 设置Codec组件的回调函数。 [更多...](_codec.md#setcallbacks) |
| ( [ComponentDeInit](_codec.md#componentdeinit) )(struct CodecComponentType \*self) | 组件去初始化。 [更多...](_codec.md#componentdeinit) |
| ( [UseEglImage](_codec.md#useeglimage) )(struct CodecComponentType \*self, struct [OmxCodecBuffer](_omx_codec_buffer.md) \*buffer, uint32_t portIndex, int8_t \*eglImage, uint32_t eglImageLen) | 使用已在EGL中申请的空间。 [更多...](_codec.md#useeglimage) |
| ( [ComponentRoleEnum](_codec.md#componentroleenum) )(struct [CodecComponentType \*self, uint8_t \*role, uint32_t roleLen, uint32_t index) | 获取组件角色。 [更多...](_codec.md#componentroleenum) |
## **详细描述**
......
zh-cn/device-dev/reference/hdi-apis/_device_info.md
浏览文件 @ 4ac779c5
# DeviceInfo
# InputDeviceInfo
## **概述**
......@@ -16,179 +16,103 @@
| Public 属性 | 描述 |
| -------- | -------- |
| [devIndex](#devindex) | 设备索引 |
| [fd](#fd) | 设备对应的文件描述符 |
| [service](#service) | 设备对应的服务 |
| [listener](#listener) | 设备对应的事件监听器 |
| [devType](#devtype) | 设备类型 |
| [powerStatus](#powerstatus) | 电源状态 |
| [chipInfo](#chipinfo) [CHIP_INFO_LEN] | 驱动芯片编码信息 |
| [vendorName](#vendorname) [VENDOR_NAME_LEN] | 模组厂商名 |
| [chipName](#chipname) [CHIP_NAME_LEN] | 驱动芯片型号 |
| [devNodePath](#devnodepath) [MAX_NODE_PATH_LEN] | 设备文件路径 |
| [solutionX](#solutionx) | x方向分辨率 |
| [solutionY](#solutiony) | y方向分辨率 |
| [callback](#callback) | 数据上报回调函数 [InputReportEventCb](_input_report_event_cb.md) |
| [attrSet](#attrset)| 设备属性。 |
| [abilitySet](#abilityset)| 设备能力属性。|
## **详细描述**
input设备基础设备信息
Input设备基础设备信息。
## **类成员变量说明**
### callback
```
InputReportEventCb* DeviceInfo::callback
```
**描述：**
数据上报回调函数 [InputReportEventCb](_input_report_event_cb.md)
### chipInfo
```
char DeviceInfo::chipInfo[CHIP_INFO_LEN]
char InputDeviceInfo::chipInfo[CHIP_INFO_LEN]
```
**描述：**
驱动芯片编码信息
驱动芯片编码信息。
### chipName
```
char DeviceInfo::chipName[CHIP_NAME_LEN]
char InputDeviceInfo::chipName[CHIP_NAME_LEN]
```
**描述：**
驱动芯片型号
驱动芯片型号。
### devIndex
```
uint32_t DeviceInfo::devIndex
uint32_t InputDeviceInfo::devIndex
```
**描述：**
设备索引
### devNodePath
```
char DeviceInfo::devNodePath[MAX_NODE_PATH_LEN]
```
**描述：**
设备索引。
设备文件路径
### devType
```
uint32_t DeviceInfo::devType
```
**描述：**
设备类型
### fd
```
int32_t DeviceInfo::fd
```
**描述：**
设备对应的文件描述符
### listener
```
void* DeviceInfo::listener
```
**描述：**
设备对应的事件监听器
### powerStatus
```
uint32_t DeviceInfo::powerStatus
```
**描述：**
电源状态
### service
```
void* DeviceInfo::service
uint32_t InputDeviceInfo::devType
```
**描述：**
设备对应的服务
设备类型。
### solutionX
### vendorName
```
uint32_t DeviceInfo::solutionX
char InputDeviceInfo::vendorName[VENDOR_NAME_LEN]
```
**描述：**
x方向分辨率
模组厂商名。
### solutionY
### attrSet
```
uint32_t DeviceInfo::solutionY
InputDevAttr InputDeviceInfo::attrSet
```
**描述：**
y方向分辨率
设备属性。
### vendorName
### abilitySet
```
char DeviceInfo::vendorName[VENDOR_NAME_LEN]
InputDevAbility InputDeviceInfo::abilitySet
```
**描述：**
模组厂商名
设备能力属性。
\ No newline at end of file
zh-cn/device-dev/reference/hdi-apis/_display.md
浏览文件 @ 4ac779c5
......@@ -1369,11 +1369,11 @@ int32_t(* DeviceFuncs::CreateVirtualDisplay) (uint32_t width, uint32_t height, i
**参数:**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| width | 输入参数，指定显示设备的像素宽度。 |
| height | 输入参数，指定显示设备的像素高度。 |
| format | 输出参数，指定显示设备的像素格式。 详情参考[ERROR:Invalid link:zh-cn_topic_0000001357381993.xml#xref738382043153217,link:zh-cn_topic_0000001347985105.xml#ga60883d4958a60b91661e97027a85072a](zh-cn_topic_0000001347985105.xml#ga60883d4958a60b91661e97027a85072a)，接口实现层可以根据硬件需求，修改format并返回给图形服务。 |
| format | 输出参数，指定显示设备的像素格式。详情参考[PixelFormat](#pixelformat)，接口实现层可以根据硬件需求，修改format并返回给图形服务。 |
| devId | 输出参数，用于接口层返回创建的设备ID。 |
**返回:**
......@@ -2267,7 +2267,7 @@ MirrorType GfxOpt::mirrorType
```
char PropertyObject::名称[PROPERTY_NAME_LEN]
char PropertyObject::name[PROPERTY_NAME_LEN]
```
**描述：**
......@@ -2279,7 +2279,7 @@ char PropertyObject::名称[PROPERTY_NAME_LEN]
```
char DisplayCapability::名称[PROPERTY_NAME_LEN]
char DisplayCapability::name[PROPERTY_NAME_LEN]
```
**描述：**
......
zh-cn/device-dev/reference/hdi-apis/_event_package.md
浏览文件 @ 4ac779c5
# EventPackage
# InputEventPackage
## **概述**
......@@ -23,7 +23,7 @@
## **详细描述**
input事件数据包结构。
Input事件数据包结构。
## **类成员变量说明**
......
zh-cn/device-dev/reference/hdi-apis/_hdf_pin_auth.md
浏览文件 @ 4ac779c5
......@@ -19,7 +19,7 @@
| 类 | 描述 |
| -------- | -------- |
| [IExecutor](interface_pin_i_executor.md) | 定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。[更多...](interface_pin_i_executor.md) |
| [IExecutorCallback](interface_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_i_executor.md)。 [更多...](interface_i_executor_callback.md) |
| [IExecutorCallback](interface_pin_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_pin_i_executor.md)。 [更多...](interface_pin_i_executor_callback.md) |
| [IPinAuthInterface](interface_i_pin_auth_interface.md) | 定义获取口令认证驱动的执行器列表接口。 [更多...](interface_i_pin_auth_interface.md) |
| [ExecutorInfo](_executor_info.md) | 执行器信息。 [更多...](_executor_info.md) |
| [TemplateInfo](_template_info.md) | 凭据模版信息。 [更多...](_template_info.md) |
......
zh-cn/device-dev/reference/hdi-apis/_hdf_user_auth.md
浏览文件 @ 4ac779c5
......@@ -36,6 +36,7 @@
| [AuthType](#authtype) : int {   PIN = 1, FACE = 2, FINGERPRINT = 4, ALL = 0 } | 枚举用户认证凭据类型。 [更多...](#authtype) |
| [ExecutorRole](#executorrole) : int {   COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 } | 枚举执行器角色。 [更多...](#executorrole) |
| [ExecutorSecureLevel](#executorsecurelevel) : int {   ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 } | 枚举执行器安全等级。 [更多...](#executorsecurelevel) |
| [PinSubType](#pinsubtype) : int {   PIN\_SIX = 10000, PIN\_NUMBER = 10001, PIN\_MIX = 10002 } | 口令认证子类型。 [更多...](#pinsubtype) |
### 变量
......@@ -113,3 +114,21 @@ enum ExecutorSecureLevel : int
| ESL1 | 执行器安全级别为1，关键操作在有访问控制的执行环境中完成。 |
| ESL2 | 执行器安全级别为2，关键操作在可信执行环境中完成。 |
| ESL3 | 执行器安全级别为3，关键操作在高安环境如独立安全芯片中完成。 |
### PinSubType
```
enum PinSubType : int
```
**描述：**
口令认证子类型。
| 枚举值 | 描述 |
| -------- | -------- |
| PIN_SIX | 六位口令密码。 |
| PIN_NUMBER| 数字口令密码。 |
| PIN_MIX | 混合密码。 |
zh-cn/device-dev/reference/hdi-apis/_i_input_interface.md
浏览文件 @ 4ac779c5
......@@ -15,14 +15,14 @@
| Public 属性 | 描述 |
| -------- | -------- |
| [iInputManager](#iinputmanager) | input设备的设备管理接口。 |
| [iInputController](#iinputcontroller) | input设备的业务控制接口。 |
| [iInputReporter](#iinputreporter) | input设备的数据上报接口。 |
| [iInputManager](#iinputmanager) | Input设备的设备管理接口。 |
| [iInputController](#iinputcontroller) | Input设备的业务控制接口。 |
| [iInputReporter](#iinputreporter) | Input设备的数据上报接口。 |
## **详细描述**
定义用于提供输入设备驱动能力的接口。
定义用于提供Input设备驱动程序功能的接口。
## **类成员变量说明**
......@@ -37,7 +37,7 @@ InputController* IInputInterface::iInputController
**描述：**
input设备的业务控制接口
Input设备的业务控制接口。
### iInputManager
......@@ -49,7 +49,7 @@ InputManager* IInputInterface::iInputManager
**描述：**
input设备的设备管理接口
Input设备的设备管理接口。
### iInputReporter
......@@ -61,4 +61,4 @@ InputReporter* IInputInterface::iInputReporter
**描述：**
input设备的数据上报接口
Input设备的数据上报接口。
zh-cn/device-dev/reference/hdi-apis/_input.md
浏览文件 @ 4ac779c5
......@@ -8,24 +8,31 @@
| 文件 | 描述 |
| -------- | -------- |
| [input_controller.h](input__controller_8h.md) | 描述input设备业务控制相关的接口声明。 |
| [input_manager.h](input__manager_8h.md) | 描述input设备管理相关的接口声明。 |
| [input_reporter.h](input__reporter_8h.md) | 描述input设备数据上报相关的接口声明。 |
| [input_type.h](input__type_8h.md) | input设备相关的类型定义，定义了input设备驱动接口所使用的结构体及枚举类型。 |
| [input_controller.h](input__controller_8h.md) | 描述Input设备业务控制相关的接口声明。 |
| [input_manager.h](input__manager_8h.md) | 描述Input设备管理相关的接口声明。 |
| [input_reporter.h](input__reporter_8h.md) | 描述Input设备数据上报相关的接口声明。 |
| [input_type.h](input__type_8h.md) | Input设备相关的类型定义，定义了Input设备驱动接口所使用的结构体及枚举类型。 |
### 类
| 类 | 描述 |
| -------- | -------- |
| [InputController](_input_controller.md) | 提供input设备业务控制相关的接口。 [更多...](_input_controller.md) |
| [InputManager](_input_manager.md) | 提供input设备管理相关的接口。 [更多...](_input_manager.md) |
| [InputController](_input_controller.md) | 提供Input设备业务控制相关的接口。 [更多...](_input_controller.md) |
| [InputManager](_input_manager.md) | 提供Input设备管理相关的接口。 [更多...](_input_manager.md) |
| [IInputInterface](_i_input_interface.md) | 定义用于提供输入设备驱动能力的接口。[更多...](_i_input_interface.md) |
| [InputReporter](_input_reporter.md) | 提供input设备数据上报相关的接口。 [更多...](_input_reporter.md) |
| [EventPackage](_event_package.md) | input事件数据包结构 [更多...](_event_package.md) |
| [InputReportEventCb](_input_report_event_cb.md) | 此结构体定义了输入事件回调函数并提供给input服务使用 [更多...](_input_report_event_cb.md) |
| [DeviceInfo](_device_info.md) | input设备基础设备信息 [更多...](_device_info.md) |
| [InputExtraCmd](_input_extra_cmd.md) | 扩展指令的数据结构 [更多...](_input_extra_cmd.md) |
| [InputReporter](_input_reporter.md) | 提供Input设备数据上报相关的接口。 [更多...](_input_reporter.md) |
| [InputEventPackage](_event_package.md) | Input事件数据包结构。 [更多...](_event_package.md) |
| [InputHotPlugEvent](_input_hotplug_event.md) | 热插拔事件数据包结构。 [更多...](_input_hotplug_event.md) |
| [InputDevDesc](_input_dev_desc.md) | Input设备描述信息。 [更多...](_input_dev_desc.md) |
| [InputEventCb](_input_report_event_cb.md) | 此结构体定义了输入事件回调函数并提供给Input服务使用。 [更多...](_input_report_event_cb.md) |
| [InputHostCb](_input_host_cb.md) | 此结构体定义了热插拔事件上报回调函数并提供给Input服务使用。 [更多...](_input_host_cb.md) |
| [InputDevAbility](_input_dev_ability.md) | Input设备的能力属性，存储支持事件的位图。 [更多...](_input_dev_ability.md) |
| [InputDimensionInfo](_input_dimension_info.md) | Input设备的维度信息。 [更多...](_input_dimension_info.md) |
| [InputDevIdentify](_input_dev_identify.md) | Input设备的识别信息。 [更多...](_input_dev_identify.md) |
| [InputDevAttr](_input_dev_attr.md) | Input设备属性。 [更多...](_input_dev_attr.md) |
| [InputDeviceInfo](_device_info.md) | Input设备基础设备信息。 [更多...](_device_info.md) |
| [InputExtraCmd](_input_extra_cmd.md) | 扩展指令的数据结构。 [更多...](_input_extra_cmd.md) |
### 宏定义
......@@ -33,35 +40,41 @@
| 宏定义 | 描述 |
| -------- | -------- |
| **MAX_INPUT_DEV_NUM**   32 | Input设备最大数量。 |
| **MAX_NODE_PATH_LEN**   64 | 节点路径最大长度。 |
| **DEV_NAME_LEN**   64 | Input设备名称长度。 |
| **CHIP_INFO_LEN**   10 | 芯片信息长度。 |
| **CHIP_NAME_LEN**   10 | 芯片名称长度。 |
| **VENDOR_NAME_LEN**   10 | 厂商名称长度。 |
| **SELF_TEST_RESULT_LEN**   20 | 自测结果长度。 |
| **DEV_MANAGER_SERVICE_NAME**   "hdf_input_host" | Input设备节点服务名称。 |
| **DIV_ROUND_UP(nr, d)**  (((nr) + (d) - 1) / (d)) | 向上取整计算公式。|
| **BYTE_HAS_BITS**  8 | 一个字节所包含的比特数。 |
| **BITS_TO_UINT64(count)**  DIV_ROUND_UP(count, BYTE_HAS_BITS * sizeof(uint64_t)) | 比特与64位无符号整数的转换公式。 |
| **HDF_FF_CNT**  (0x7f + 1) | Input设备发送力反馈命令的数量最大值。|
### 枚举
| 枚举 | 描述 |
| -------- | -------- |
| [RetStatus](#retstatus) { INPUT_SUCCESS = 0, INPUT_FAILURE = -1, INPUT_INVALID_PARAM = -2, INPUT_NOMEM = -3,   INPUT_NULL_PTR = -4, INPUT_TIMEOUT = -5, INPUT_UNSUPPORTED = -6 } | 定义返回值类型 [更多...](#retstatus) |
| [InputDevType](#inputdevtype) { INDEV_TYPE_TOUCH, INDEV_TYPE_KEY, INDEV_TYPE_KEYBOARD, INDEV_TYPE_MOUSE,   INDEV_TYPE_BUTTON, INDEV_TYPE_CROWN, INDEV_TYPE_ENCODER, INDEV_TYPE_UNKNOWN } | 定义input设备类型 [更多...](#inputdevtype) |
| [PowerStatus](#powerstatus) { INPUT_RESUME, INPUT_SUSPEND, INPUT_LOW_POWER, INPUT_POWER_STATUS_UNKNOWN } | 定义电源状态 [更多...](#powerstatus) |
| [CapacitanceTest](#capacitancetest) { BASE_TEST, FULL_TEST, MMI_TEST, RUNNING_TEST,   TEST_TYPE_UNKNOWN } | 定义容值测试类型 [更多...](#capacitancetest) |
| [RetStatus](#retstatus) { INPUT_SUCCESS = 0, INPUT_FAILURE = -1, INPUT_INVALID_PARAM = -2, INPUT_NOMEM = -3,   INPUT_NULL_PTR = -4, INPUT_TIMEOUT = -5, INPUT_UNSUPPORTED = -6 } | 定义返回值类型。 [更多...](#retstatus) |
| [InputDevType](#inputdevtype) { INDEV_TYPE_TOUCH, INDEV_TYPE_KEY, INDEV_TYPE_KEYBOARD, INDEV_TYPE_MOUSE,   INDEV_TYPE_BUTTON, INDEV_TYPE_CROWN, INDEV_TYPE_ENCODER, INDEV_TYPE_UNKNOWN } | 定义Input设备类型。 [更多...](#inputdevtype) |
| [PowerStatus](#powerstatus) { INPUT_RESUME, INPUT_SUSPEND, INPUT_LOW_POWER, INPUT_POWER_STATUS_UNKNOWN } | 定义电源状态。 [更多...](#powerstatus) |
| [CapacitanceTest](#capacitancetest) { BASE_TEST, FULL_TEST, MMI_TEST, RUNNING_TEST,   TEST_TYPE_UNKNOWN } | 定义容值测试类型。 [更多...](#capacitancetest) |
### 函数
| 函数 | 描述 |
| -------- | -------- |
| [GetInputInterface](#getinputinterface) ([IInputInterface](_i_input_interface.md) \*\*interface) | input服务通过调用此接口获取操作input设备的所有接口。 [更多...](#getinputinterface) |
| [GetInputInterface](#getinputinterface) ([IInputInterface](_i_input_interface.md) \*\*interface) | Input服务通过调用此接口获取操作Input设备的所有接口。 [更多...](#getinputinterface) |
| [ReleaseInputInterface](#releaseinputinterface) ([IInputInterface](_i_input_interface.md) \*\*inputInterface) | Input服务通过调用此接口释放操作Input设备的所有接口。 [更多...](#releaseinputinterface) |
## **详细描述**
Input模块驱动接口声明。
本模块为Input服务提供相关驱动接口，包括input设备的打开和关闭、input事件获取、设备信息查询、回调函数注册、特性状态控制等接口。
本模块为Input服务提供相关驱动接口，包括Input设备的打开和关闭、Input事件获取、设备信息查询、回调函数注册、特性状态控制等接口。
**Since：**
......@@ -171,13 +184,44 @@ int32_t GetInputInterface (IInputInterface **interface)
**描述：**
Input服务通过调用此接口获取操作input设备的所有接口。
Input服务通过调用此接口获取操作Input设备的所有接口。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| interface | 对input设备进行接口操作的指针，通常在input服务启动后，通过调用此函数获取input设备操作接口 |
| interface | 对Input设备进行接口操作的指针，通常在Input服务启动后，通过调用此函数获取Input设备操作接口。 |
**返回：**
INPUT_SUCCESS 表示执行成功。
其他值表示执行失败，具体错误码查看**RetSatus**。
**Since：**
1.0
**Version：**
1.0
### ReleaseInputInterface()
```
int32_t ReleaseInputInterface (IInputInterface *inputInterface)
```
**描述：**
Input服务通过调用此接口释放操作Input设备的所有接口。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| inputInterface| 对Input设备进行接口操作的指针。 |
**返回：**
......
zh-cn/device-dev/reference/hdi-apis/_input_controller.md
浏览文件 @ 4ac779c5
......@@ -17,7 +17,7 @@
| -------- | -------- |
| ( [SetPowerStatus](#setpowerstatus) )(uint32_t devIndex, uint32_t status) | 设置电源状态 [更多...](#setpowerstatus) |
| ( [GetPowerStatus](#getpowerstatus) )(uint32_t devIndex, uint32_t \*status) | 获取电源状态 [更多...](#getpowerstatus) |
| ( [GetDeviceType](#getdevicetype) )(uint32_t devIndex, uint32_t \*deviceType) | 获取devIndex对应的input设备的类型 [更多...](#getdevicetype) |
| ( [GetDeviceType](#getdevicetype) )(uint32_t devIndex, uint32_t \*deviceType) | 获取devIndex对应的Input设备的类型 [更多...](#getdevicetype) |
| ( [GetChipInfo](#getchipinfo) )(uint32_t devIndex, char \*chipInfo, uint32_t length) | 获取器件对应的编码信息 [更多...](#getchipinfo) |
| ( [GetVendorName](#getvendorname) )(uint32_t devIndex, char \*vendorName, uint32_t length) | 获取devIndex对应的模组厂商名 [更多...](#getvendorname) |
| ( [GetChipName](#getchipname) )(uint32_t devIndex, char \*chipName, uint32_t length) | 获取devIndex对应的驱动芯片名 [更多...](#getchipname) |
......@@ -28,7 +28,7 @@
## **详细描述**
提供input设备业务控制相关的接口。
提供Input设备业务控制相关的接口。
此类接口包含电源状态的设置、特性的使能、器件信息的获取，以及产线相关的测试功能接口。
......@@ -45,7 +45,7 @@ int32_t(* InputController::GetChipInfo) (uint32_t devIndex, char *chipInfo, uint
**描述：**
获取器件对应的编码信息
获取器件对应的编码信息。
一款产品通常会有多家模组和Driver IC，上层应用如果关注具体器件型号，则通过此接口来获取。
......@@ -53,15 +53,15 @@ int32_t(* InputController::GetChipInfo) (uint32_t devIndex, char *chipInfo, uint
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 |
| chipInfo | 获取的对应设备索引的器件编码信息。 |
| length | 保存器件芯片信息的内存长度。 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
| chipInfo | 输出参数，获取的对应设备索引的器件编码信息。 |
| length | 输入参数，保存器件芯片信息的内存长度。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### GetChipName
......@@ -73,21 +73,21 @@ int32_t(* InputController::GetChipName) (uint32_t devIndex, char *chipName, uint
**描述：**
获取devIndex对应的驱动芯片名
获取devIndex对应的驱动芯片名。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 |
| chipName | 获取的对应设备索引的驱动芯片名。 |
| length | 保存驱动芯片名的内存长度。 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
| chipName | 输出参数，获取的对应设备索引的驱动芯片名。 |
| length | 输入参数，保存驱动芯片名的内存长度。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### GetDeviceType
......@@ -99,20 +99,20 @@ int32_t(* InputController::GetDeviceType) (uint32_t devIndex, uint32_t *deviceTy
**描述：**
获取devIndex对应的input设备的类型
获取devIndex对应的Input设备的类型。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 |
| deviceType | 获取的对应设备索引的设备类型，具体参考**InputDevType**。 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
| deviceType | 输出参数，获取的对应设备索引的设备类型，具体参考**InputDevType**。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### GetPowerStatus
......@@ -124,22 +124,22 @@ int32_t(* InputController::GetPowerStatus) (uint32_t devIndex, uint32_t *status)
**描述：**
获取电源状态
获取电源状态。
在系统休眠或者唤醒时，input服务或电源管理模块获取电源状态，以便驱动IC能正常进入对应的休眠模式。
在系统休眠或者唤醒时，Input服务或电源管理模块获取电源状态，以便驱动IC能正常进入对应的休眠模式。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 |
| status | 获取的对应设备索引的电源状态，具体参考**PowerStatus**。 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
| status | 输出参数，获取的对应设备索引的电源状态，具体参考[PowerStatus](_input.md#powerstatus)。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus。**
其他值表示执行失败，具体错误码查看**RetSatus。**
### GetVendorName
......@@ -157,7 +157,7 @@ int32_t(* InputController::GetVendorName) (uint32_t devIndex, char *vendorName,
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 |
| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
| vendorName | 获取的对应设备索引的模组厂商名。 |
| length | 保存模组厂商名的内存长度。 |
......@@ -177,24 +177,24 @@ int32_t(* InputController::RunCapacitanceTest) (uint32_t devIndex, uint32_t test
**描述：**
执行容值自检测试
执行容值自检测试。
启动不同检测场景下的容值自检测试，并获取测试结果，容值自检项由器件厂商自定义， 一般包括RawData测试、 \* 短路检测、开路检测、干扰检测、行列差检测等测试项。
启动不同检测场景下的容值自检测试，并获取测试结果，容值自检项由器件厂商自定义， 一般包括RawData测试、短路检测、开路检测、干扰检测、行列差检测等测试项。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 |
| testType | 容值测试的测试类型，具体参考**CapacitanceTest**。 |
| result | 容值测试的结果，成功则输出“SUCCESS”，失败则返回对应的错误提示 。 |
| length | 保存容值测试结果的内存长度。 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
| testType | 输入参数，容值测试的测试类型，具体参考**CapacitanceTest**。 |
| result | 输出参数，容值测试的结果，成功则输出“SUCC”，失败则返回对应的错误提示。 |
| length | 输入参数，保存容值测试结果的内存长度。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### RunExtraCommand
......@@ -206,20 +206,20 @@ int32_t(* InputController::RunExtraCommand) (uint32_t devIndex, InputExtraCmd *c
**描述：**
执行拓展指令
执行拓展指令。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 |
| cmd | 拓展指令数据包，包括指令编码及参数，具体参考**InputExtraCmd**。 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
| cmd | 输入参数，拓展指令数据包，包括指令编码及参数，具体参考**InputExtraCmd**。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### SetGestureMode
......@@ -231,22 +231,22 @@ int32_t(* InputController::SetGestureMode) (uint32_t devIndex, uint32_t gestureM
**描述：**
设置手势模式
设置手势模式。
上层应用开关手势模式，即设置手势模式的对应使能bit
上层应用开关手势模式，即设置手势模式的对应使能bit。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 |
| gestureMode | 手势模式的开关状态 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
| gestureMode | 输入参数，手势模式的开关状态。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### SetPowerStatus
......@@ -258,19 +258,19 @@ int32_t(* InputController::SetPowerStatus) (uint32_t devIndex, uint32_t status)
**描述：**
设置电源状态
设置电源状态。
在系统休眠或者唤醒时，input服务或电源管理模块设置电源状态，以使驱动IC能正常进入对应的休眠模式。
在系统休眠或者唤醒时，Input服务或电源管理模块设置电源状态，以使驱动IC能正常进入对应的休眠模式。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 |
| status | 设置的电源状态，input服务控制input设备进入resume或者suspend等状态[PowerStatus](_input.md#powerstatus)。 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
| status | 输入参数，设置的电源状态，Input服务控制Input设备进入resume或者suspend等状态[PowerStatus](_input.md#powerstatus)。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
zh-cn/device-dev/reference/hdi-apis/_input_dev_ability.md 0 → 100644
浏览文件 @ 4ac779c5
# InputDevAbility
## **概述**
**所属模块:**
[Input](_input.md)
## **汇总**
### Public 属性
| Public 属性 | 描述 |
| -------- | -------- |
| [devProp](#devprop) | 设备属性 |
| [eventType](#eventtype) | 记录支持的事件类型的位图 |
| [absCode](#abscode) | 记录支持的绝对坐标的位图 |
| [relCode](#relcode) | 记录支持的相对坐标的位图 |
| [keyCode](#keycode) | 记录支持的按键值的位图 |
| [ledCode](#ledcode) | 记录设备支持的指示灯的位图 |
| [miscCode](misccode#) |记录设备支持的其他功能的位图 |
| [soundCode](#soundcode) | 记录设备支持的声音或警报的位图 |
| [forceCode](#forcecode) | 记录设备支持的作用力功能的位图 |
| [switchCode](#switchcode) | 记录设备支持的开关功能的位图 |
| [keyType](#keytype) | 按键状态的位图 |
| [ledType](#ledtype) | LED状态的位图 |
| [soundType](#soundtype) | 声音状态的位图 |
| [switchType](#switchtype) | 开关状态的位图 |
## **详细描述**
Input设备的能力属性，存储支持事件的位图。用位的方式来表示该Input设备能够上报的事件类型。
## **类成员变量说明**
### devProp
```
uint64_t InputDevAbility::devProp[BITS_TO_UINT64(INPUT_PROP_CNT)]
```
**描述：**
设备属性。
### eventType
```
uint64_t InputDevAbility::eventType[BITS_TO_UINT64(EV_CNT)]
```
**描述：**
用于记录支持的事件类型的位图。
### absCode
```
uint64_t InputDevAbility::absCode[BITS_TO_UINT64(ABS_CNT)]
```
**描述：**
记录支持的绝对坐标的位图。
### relCode
```
uint64_t InputDevAbility::relCode[BITS_TO_UINT64(REL_CNT)]
```
**描述：**
记录支持的相对坐标的位图。
### keyCode
```
uint64_t InputDevAbility::keyCode[BITS_TO_UINT64(KEY_CNT)]
```
**描述：**
记录支持的按键值的位图。
### ledCode
```
uint64_t InputDevAbility::ledCode[BITS_TO_UINT64(LED_CNT)]
```
**描述：**
记录设备支持的指示灯的位图。
### miscCode
```
uint64_t InputDevAbility::miscCode[BITS_TO_UINT64(MSC_CNT)]
```
**描述：**
记录设备支持的其他功能的位图。
### soundCode
```
uint64_t InputDevAbility::soundCode[BITS_TO_UINT64(SND_CNT)]
```
**描述：**
记录设备支持的声音或警报的位图。
### forceCode
```
uint64_t InputDevAbility::forceCode[BITS_TO_UINT64(HDF_FF_CNT)]
```
**描述：**
记录设备支持的作用力功能的位图。
### switchCode
```
uint64_t InputDevAbility::switchCode[BITS_TO_UINT64(SW_CNT)]
```
**描述：**
记录设备支持的开关功能的位图。
### keyType
```
uint64_t InputDevAbility::keyType[BITS_TO_UINT64(KEY_CNT)]
```
**描述：**
按键状态的位图。
### ledType
```
uint64_t InputDevAbility::ledType[BITS_TO_UINT64(LED_CNT)]
```
**描述：**
LED状态的位图。
### soundType
```
uint64_t InputDevAbility::soundType[BITS_TO_UINT64(SND_CNT)]
```
**描述：**
声音状态的位图。
### switchType
```
uint64_t InputDevAbility::switchType[BITS_TO_UINT64(SW_CNT)]
```
**描述：**
开关状态的位图。
zh-cn/device-dev/reference/hdi-apis/_input_dev_attr.md 0 → 100644
浏览文件 @ 4ac779c5
# InputDevAttr
## **概述**
**所属模块:**
[Input](_input.md)
## **汇总**
### Public 属性
| Public 属性 | 描述 |
| -------- | -------- |
| [devName](#devname) | 设备名 |
| [id](#id) | 设备识别信息 |
| [axisInfo](#axisinfo) | 设备维度信息 |
## **详细描述**
Input设备属性。
## **类成员变量说明**
### devName
```
char InputDevAttr::devName[DEV_NAME_LEN]
```
**描述：**
设备名。
### id
```
InputDevIdentify InputDevAttr::id
```
**描述：**
设备识别信息。
### axisInfo
```
InputDimensionInfo InputDevAttr::axisInfo[ABS_CNT];
```
**描述：**
设备维度信息。
\ No newline at end of file
zh-cn/device-dev/reference/hdi-apis/_input_dev_desc.md 0 → 100644
浏览文件 @ 4ac779c5
# InputDevDesc
## **概述**
**所属模块:**
[Input](_input.md)
## **汇总**
### Public 属性
| Public 属性 | 描述 |
| -------- | -------- |
| [devIndex](#devindex) | 设备索引 |
| [devType](#devtype) | 设备类型 |
## **详细描述**
Input设备描述信息。
## **类成员变量说明**
### devIndex
```
uint32_t InputHotPlugEvent::devIndex
```
**描述：**
设备索引。
### devType
```
uint32_t InputHotPlugEvent::devType
```
**描述：**
设备类型。
zh-cn/device-dev/reference/hdi-apis/_input_dev_identify.md 0 → 100644
浏览文件 @ 4ac779c5
# InputDevIdentify
## **概述**
**所属模块:**
[Input](_input.md)
## **汇总**
### Public 属性
| Public 属性 | 描述 |
| -------- | -------- |
| [busType](#bustype) | 总线类型 |
| [vendor](#vendor) | 生产商编号 |
| [product](#product) | 产品编号 |
| [fuzz](#version) | 版本号 |
## **详细描述**
Input设备的识别信息。
## **类成员变量说明**
### busType
```
uint16_t InputDevIdentify::busType
```
**描述：**
总线类型。
### vendor
```
uint16_t InputDevIdentify::vendor
```
**描述：**
生产商编号。
### product
```
uint16_t InputDevIdentify::product
```
**描述：**
产品编号。
### version
```
uint16_t InputDevIdentify::version
```
**描述：**
版本号。
zh-cn/device-dev/reference/hdi-apis/_input_dimension_info.md 0 → 100644
浏览文件 @ 4ac779c5
# InputDimensionInfo
## **概述**
**所属模块:**
[Input](_input.md)
## **汇总**
### Public 属性
| Public 属性 | 描述 |
| -------- | -------- |
| [axis](#axis) | 坐标轴 |
| [min](#min) | 记录各个坐标的最小值 |
| [max](#max) | 记录各个坐标的最大值 |
| [fuzz](#fuzz) | 记录各个坐标的分辨率 |
| [flat](#flat) | 记录各个坐标的基准值 |
| [range](#range) | 范围 |
## **详细描述**
Input设备的维度信息。
## **类成员变量说明**
### axis
```
int32_t InputDimensionInfo::axis
```
**描述：**
坐标轴。
### min
```
int32_t InputDimensionInfo::min
```
**描述：**
记录各个坐标的最小值。
### max
```
int32_t InputDimensionInfo::max
```
**描述：**
记录各个坐标的最大值。
### fuzz
```
int32_t InputDimensionInfo::fuzz
```
**描述：**
记录各个坐标的分辨率。
### flat
```
int32_t InputDimensionInfo::flat
```
**描述：**
记录各个坐标的基准值。
### range
```
int32_t InputDimensionInfo::range
```
**描述：**
范围。
\ No newline at end of file
zh-cn/device-dev/reference/hdi-apis/_input_host_cb.md 0 → 100644
浏览文件 @ 4ac779c5
# InputHostCb
## **概述**
**所属模块:**
[Input](_input.md)
## **汇总**
### Public 属性
| Public 属性 | 描述 |
| -------- | -------- |
| ( [HotPlugCallback](#hotplugcallback) ) (const [InputHotPlugEvent](_input_hotplug_event.md) \*event) | 热插拔事件上报的回调函数。 [更多...](#hotplugcallback) |
## **详细描述**
此结构体定义了热插拔事件上报回调函数并提供给Input服务使用。
## **类成员变量说明**
### HotPlugCallback
```
void (* InputHostCb::HotPlugCallback) (const InputHotPlugEvent* event);
```
**描述：**
热插拔事件上报的回调函数。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| event | 输入参数，上报的热插拔事件数据。 |
\ No newline at end of file
zh-cn/device-dev/reference/hdi-apis/_input_hotplug_event.md 0 → 100644
浏览文件 @ 4ac779c5
# InputHotPlugEvent
## **概述**
**所属模块:**
[Input](_input.md)
## **汇总**
### Public 属性
| Public 属性 | 描述 |
| -------- | -------- |
| [devIndex](#devindex) | 设备索引 |
| [devType](#devtype) | 设备类型 |
| [status](#status) | 设备状态|
## **详细描述**
热插拔事件数据包结构。
## **类成员变量说明**
### devIndex
```
uint32_t InputHotPlugEvent::devIndex
```
**描述：**
设备索引。
### devType
```
uint32_t InputHotPlugEvent::devType
```
**描述：**
设备类型。
### status
```
uint32_t InputHotPlugEvent::status
```
**描述：**
设备状态。
- 1：离线
- 0：在线。
zh-cn/device-dev/reference/hdi-apis/_input_manager.md
浏览文件 @ 4ac779c5
......@@ -15,18 +15,18 @@
| Public 属性 | 描述 |
| -------- | -------- |
| ( [ScanInputDevice](#scaninputdevice) )(DevDesc \*staArr, uint32_t arrLen) | input服务用于扫描所有在线设备。 [更多...](#scaninputdevice) |
| ( [OpenInputDevice](#openinputdevice) )(uint32_t devIndex) | input服务打开对应设备的设备文件 [更多...](#openinputdevice) |
| ( [CloseInputDevice](#closeinputdevice) )(uint32_t devIndex) | input服务关闭对应设备的设备文件 [更多...](#closeinputdevice) |
| ( [GetInputDevice](#getinputdevice) )(uint32_t devIndex, [DeviceInfo](_device_info.md) \*\*devInfo) | input服务获取对应ID的设备信息 [更多...](#getinputdevice) |
| ( [GetInputDeviceList](#getinputdevicelist) )(uint32_t \*devNum, [DeviceInfo](_device_info.md) \*\*devList, uint32_t size) | input服务获取所有input设备列表的设备信息 [更多...](#getinputdevicelist) |
| ( [ScanInputDevice](#scaninputdevice) )(DevDesc \*staArr, uint32_t arrLen) | Input服务用于扫描所有在线设备。 [更多...](#scaninputdevice) |
| ( [OpenInputDevice](#openinputdevice) )(uint32_t devIndex) | Input服务打开对应设备的设备文件 [更多...](#openinputdevice) |
| ( [CloseInputDevice](#closeinputdevice) )(uint32_t devIndex) | Input服务关闭对应设备的设备文件 [更多...](#closeinputdevice) |
| ( [GetInputDevice](#getinputdevice) )(uint32_t devIndex, [DeviceInfo](_device_info.md) \*\*devInfo) | Input服务获取对应ID的设备信息 [更多...](#getinputdevice) |
| ( [GetInputDeviceList](#getinputdevicelist) )(uint32_t \*devNum, [DeviceInfo](_device_info.md) \*\*devList, uint32_t size) | Input服务获取所有Input设备列表的设备信息 [更多...](#getinputdevicelist) |
## **详细描述**
提供input设备管理相关的接口。
提供Input设备管理相关的接口。
此类接口包含input设备的扫描、打开和关闭、特定设备信息查询，以及所有设备列表信息获取等接口。
此类接口包Input设备的扫描、打开和关闭、特定设备信息查询，以及所有设备列表信息获取等接口。
## **类成员变量说明**
......@@ -41,70 +41,70 @@ int32_t(* InputManager::CloseInputDevice) (uint32_t devIndex)
**描述：**
input服务关闭对应设备的设备文件
Input服务关闭对应设备的设备文件。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。|
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### GetInputDevice
```
int32_t(* InputManager::GetInputDevice) (uint32_t devIndex, DeviceInfo **devInfo)
int32_t(* InputManager::GetInputDevice) (uint32_t devIndex, InputDeviceInfo **devInfo)
```
**描述：**
input服务获取对应ID的设备信息。
Input服务获取对应ID的设备信息。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 |
| devInfo | 即devIndex对应设备的设备信息，具体参考**DeviceInfo**。 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
| devInfo | 输出参数，即devIndex对应的设备的设备信息，具体参考**DeviceInfo**。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### GetInputDeviceList
```
int32_t(* InputManager::GetInputDeviceList) (uint32_t *devNum, DeviceInfo **devList, uint32_t size)
int32_t(* InputManager::GetInputDeviceList) (uint32_t *devNum, InputDeviceInfo **devList, uint32_t size)
```
**描述：**
input服务获取所有input设备列表的设备信息。
Input服务获取所有Input设备列表的设备信息。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devNum | 当前已经注册过的所有input设备的总数。 |
| devInfo | input设备列表所对应的设备信息，具体参考**DeviceInfo**。 |
| size | 即指定deviceList数组对应的元素个数。 |
| devNum | 输出参数，当前已经注册过的所有Input设备的总数。 |
| devInfo | 输出参数，Input设备列表所对应的设备信息，具体参考**DeviceInfo**。 |
| size | 输入参数，即指定deviceList数组对应的元素个数。|
返回：
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### OpenInputDevice
......@@ -116,41 +116,41 @@ int32_t(* InputManager::OpenInputDevice) (uint32_t devIndex)
**描述：**
input服务打开对应设备的设备文件
Input服务打开对应设备的设备文件。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### ScanInputDevice
```
int32_t(* InputManager::ScanInputDevice) (DevDesc *staArr, uint32_t arrLen)
int32_t(* InputManager::ScanInputDevice) (InputDevDesc *staArr, uint32_t arrLen)
```
**描述：**
input服务用于扫描所有在线设备。
Input服务用于扫描所有在线设备。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| staArr | 存放Input设备扫描信息的数组，信息包含设备索引以及设备类型。 |
| arrLen | staArr数组的长度信息。 |
| staArr | 输出参数，存放Input设备扫描信息的数组，信息包含设备索引以及设备类型。 |
| arrLen | 输入参数，staArr数组的长度信息。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
zh-cn/device-dev/reference/hdi-apis/_input_report_event_cb.md
浏览文件 @ 4ac779c5
# InputReportEventCb
# InputEventCb
## **概述**
......@@ -15,51 +15,33 @@
| Public 属性 | 描述 |
| -------- | -------- |
| ( [ReportEventPkgCallback](#reporteventpkgcallback) )(const [EventPackage](_event_package.md) \*\*pkgs, uint32_t count, uint32_t devIndex) | 输入事件数据上报的回调函数 [更多...](#reporteventpkgcallback) |
| ( [ReportHotPlugEventCallback](#reporthotplugeventcallback) )(const HotPlugEvent \*event) | 热插拔事件上报的回调函数 [更多...](#reporthotplugeventcallback) |
| ( [EventPkgCallback](#eventpkgcallback) )(const [InputEventPackage](_event_package.md) \*\*pkgs, uint32_t count, uint32_t devIndex) | 输入事件数据上报的回调函数。 [更多...](#eventpkgcallback) |
## **详细描述**
此结构体定义了输入事件回调函数并提供给input服务使用。
此结构体定义了输入事件回调函数并提供给Input服务使用。
## **类成员变量说明**
### ReportEventPkgCallback
### EventPkgCallback
```
void(* InputReportEventCb::ReportEventPkgCallback) (const EventPackage **pkgs, uint32_t count, uint32_t devIndex)
void (* InputEventCb::EventPkgCallback)(const InputEventPackage **pkgs, uint32_t count, uint32_t devIndex);
```
**描述：**
输入事件数据上报的回调函数
输入事件数据上报的回调函数。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| eventData | 驱动上报的input事件数据。 |
| pkgs| 驱动上报的Input事件数据。 |
| count | Input事件数据包的个数。 |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备。 |
| devIndex | Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
### ReportHotPlugEventCallback
```
void(* InputReportEventCb::ReportHotPlugEventCallback) (const HotPlugEvent *event)
```
**描述：**
热插拔事件上报的回调函数
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| event | 上报的热插拔事件数据 |
zh-cn/device-dev/reference/hdi-apis/_input_reporter.md
浏览文件 @ 4ac779c5
......@@ -15,17 +15,17 @@
| Public 属性 | 描述 |
| -------- | -------- |
| ( [RegisterReportCallback](#registerreportcallback) )(uint32_t devIndex, [InputReportEventCb](_input_report_event_cb.md) \*callback) | 注册对应设备的回调函数 [更多...](#registerreportcallback) |
| ( [UnregisterReportCallback](#unregisterreportcallback) )(uint32_t devIndex) | 注销对应设备的回调函数 [更多...](#unregisterreportcallback) |
| ( [RegisterHotPlugCallback](#registerhotplugcallback) )([InputReportEventCb](_input_report_event_cb.md) \*callback) | 注册Input设备的热插拔回调函数 [更多...](#registerhotplugcallback) |
| ( [UnregisterHotPlugCallback](#unregisterhotplugcallback) )(void) | 注销Input设备的热插拔回调函数 [更多...](#unregisterhotplugcallback) |
| ( [RegisterReportCallback](#registerreportcallback) )(uint32_t devIndex, [InputHostCb](_input_report_event_cb.md) \*callback) | 注册对应设备的回调函数。 [更多...](#registerreportcallback) |
| ( [UnregisterReportCallback](#unregisterreportcallback) )(uint32_t devIndex) | 注销对应设备的回调函数。 [更多...](#unregisterreportcallback) |
| ( [RegisterHotPlugCallback](#registerhotplugcallback) )([InputHostCb](_input_report_event_cb.md) \*callback) | 注册Input设备的热插拔回调函数。 [更多...](#registerhotplugcallback) |
| ( [UnregisterHotPlugCallback](#unregisterhotplugcallback) )(void) | 注销Input设备的热插拔回调函数。 [更多...](#unregisterhotplugcallback) |
## **详细描述**
提供input设备数据上报相关的接口。
提供Input设备数据上报相关的接口。
此类接口包含input设备的数据上报回调函数的注册和注销。
此类接口包含Input设备的数据上报回调函数的注册和注销。
## **类成员变量说明**
......@@ -35,53 +35,53 @@
```
int32_t(* InputReporter::RegisterHotPlugCallback) (InputReportEventCb *callback)
int32_t(* InputReporter::RegisterHotPlugCallback) (InputHostCb *callback)
```
**描述：**
注册Input设备的热插拔回调函数
注册Input设备的热插拔回调函数。
input服务通过此接口注册回调函数到hdi中，所有Input设备由此函数进行热插拔事件上报
Input服务通过此接口注册回调函数到hdi中，所有Input设备由此函数进行热插拔事件上报。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| callback | 回调函数的函数指针 |
| callback | 输入参数，回调函数的函数指针。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### RegisterReportCallback
```
int32_t(* InputReporter::RegisterReportCallback) (uint32_t devIndex, InputReportEventCb *callback)
int32_t(* InputReporter::RegisterReportCallback) (uint32_t devIndex, InputEventCb *callback)
```
**描述：**
注册对应设备的回调函数
注册对应设备的回调函数。
input服务通过此接口注册数据回调函数到hdi中，hdi通过此回调函数上报input事件
Input服务通过此接口注册数据回调函数到hdi中，hdi通过此回调函数上报Input事件。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备 |
| callback | 回调函数的函数指针 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 |
| callback | 输入参数，回调函数的函数指针。 |
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### UnregisterHotPlugCallback
......@@ -93,19 +93,13 @@ int32_t(* InputReporter::UnregisterHotPlugCallback) (void)
**描述：**
注销Input设备的热插拔回调函数
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| 无 | - |
注销Input设备的热插拔回调函数。
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
### UnregisterReportCallback
......@@ -117,16 +111,16 @@ int32_t(* InputReporter::UnregisterReportCallback) (uint32_t devIndex)
**描述：**
注销对应设备的回调函数
注销对应设备的回调函数。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| devIndex | Input设备索引，用于标志多个input设备，取值从0开始，最多支持32个设备 |
| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。|
**返回：**
Returns INPUT_SUCCESS 表示执行成功。
INPUT_SUCCESS 表示执行成功。
Returns 其他值表示执行失败，具体错误码查看**RetSatus**。
其他值表示执行失败，具体错误码查看**RetSatus**。
zh-cn/device-dev/reference/hdi-apis/_light_effect.md
浏览文件 @ 4ac779c5
......@@ -13,7 +13,7 @@
### Public 属性
| Public 属性 | 描述 |
| Public 属性 | 描述 |
| -------- | -------- |
| [lightBrightness](#lightbrightness) | 亮度值。 |
| [flashEffect](#flasheffect) | 闪烁模式。 |
......@@ -54,4 +54,4 @@ int32_t LightEffect::lightBrightness
**描述：**
亮度值：Bits 24–31为扩展位，Bits 16–23为红色，bits 8–15为绿色，bits 0–7为蓝色。 如果字节段不等于0，指示打开相应颜色的灯。
亮度值：Bits 24–31为扩展位，Bits 16–23为红色，Bits 8–15为绿色，Bits 0–7为蓝色。 如果相对应的字节段不等于0，表示打开相应颜色的灯。
zh-cn/device-dev/reference/hdi-apis/_light_interface.md
浏览文件 @ 4ac779c5
......@@ -13,7 +13,7 @@
### Public 属性
| Public 属性 | 描述 |
| Public 属性 | 描述 |
| -------- | -------- |
| ( [GetLightInfo](#getlightinfo) )([out] struct [LightInfo](_light_info.md) \*\*lightInfo, [out] uint32_t \*count) | 获取当前系统中所有类型的灯信息。 [更多...](#getlightinfo) |
| ( [TurnOnLight](#turnonlight) )([in] uint32_t lightId, [in] struct [LightEffect](_light_effect.md) \*effect) | 根据指定的灯ID打开列表中的可用灯。 [更多...](#turnonlight) |
......@@ -24,7 +24,7 @@
定义可以在灯上执行的基本操作。
操作包括获取灯的信息、打开或关闭灯、设置灯的亮度或闪烁模式。
操作包括获取灯的信息、打开或关闭灯、设置灯的亮度和闪烁模式。
## **类成员变量说明**
......@@ -43,7 +43,7 @@ int32_t(* LightInterface::GetLightInfo) ([out] struct LightInfo **lightInfo,[out
**参数：**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| lightInfo | 表示指向灯信息的二级指针，详见[LightInfo](_light_info.md)。 |
| count | 表示指向灯数量的指针。 |
......@@ -68,7 +68,7 @@ int32_t(* LightInterface::TurnOffLight) ([in] uint32_t lightId)
**参数：**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| lightId | 表示灯ID，详见[LightId](_light.md#lightid)。 |
......@@ -92,7 +92,7 @@ int32_t(* LightInterface::TurnOnLight) ([in] uint32_t lightId,[in] struct LightE
**参数：**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| lightId | 表示灯ID，详见[LightId](_light.md#lightid)。 |
| effect | 表示指向灯效果的指针，如果lightbrightness字段为0时， 灯的亮度根据HCS配置的默认亮度进行设置，详见[LightEffect](_light_effect.md)。 |
......@@ -105,4 +105,5 @@ int32_t(* LightInterface::TurnOnLight) ([in] uint32_t lightId,[in] struct LightE
如果不支持闪烁设置，则返回-2。
如果不支持亮度设置，则返回3。
如果不支持亮度设置，则返回-3。
zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usb_info.md
浏览文件 @ 4ac779c5
......@@ -23,6 +23,13 @@
| [getDevInfoDevNum](_u_s_b.md#getdevinfodevnum) () const | 获取USB设备编号。 [更多...](_u_s_b.md#getdevinfodevnum) |
### Private 成员变量
| Private 成员变量 | 描述 |
| -------- | -------- |
| [USBDeviceInfo](_o_h_o_s_1_1_u_s_b_1_1_u_s_b_device_info.md) devInfo | USB设备信息。 |
## **详细描述**
USB设备信息类。
zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usbd_client.md
浏览文件 @ 4ac779c5
......@@ -54,4 +54,9 @@
| 静态 Public 成员函数 | 描述 |
| -------- | -------- |
| **GetInstance** () | 获取实例。 |
| [GetInstance](\_u\_s\_b.md#getinstance) () | 获取实例。 |
## 详细描述
USB驱动客户端类。
zh-cn/device-dev/reference/hdi-apis/_o_h_o_s_1_1_u_s_b_1_1_usbd_subscriber.md
浏览文件 @ 4ac779c5
......@@ -18,3 +18,24 @@
| [DeviceEvent](_u_s_b.md#deviceevent) (const [UsbInfo](_o_h_o_s_1_1_u_s_b_1_1_usb_info.md) &info)=0 | 设备事件。 [更多...](_u_s_b.md#deviceevent) |
| [PortChangedEvent](_u_s_b.md#portchangedevent) (int32_t portId, int32_t powerRole, int32_t dataRole, int32_t mode)=0 | 端口改变事件。 [更多...](_u_s_b.md#portchangedevent) |
| [OnRemoteRequest](_u_s_b.md#onremoterequest) (uint32_t code, MessageParcel &data, MessageParcel &reply, MessageOption &option) override | 远程请求。 [更多...](_u_s_b.md#onremoterequest) |
### Private 成员函数
| Private 成员函数 | 描述 |
| -------- | -------- |
| [OHOS::USB::UsbdSubscriber::ParserUsbInfo](_u_s_b.md#parserusbinfo) (MessageParcel &data, MessageParcel &reply, MessageOption &option, UsbInfo &info) | 解析USB设备信息。 [更多...](_u_s_b.md#parserusbinfo) |
| [OHOS::USB::UsbdSubscriber::ParserPortInfo](_u_s_b.md#parserportinfo) (MessageParcel &data, MessageParcel &reply, MessageOption &option, PortInfo &info) | 解析USB设备端口信息。 [更多...](_u_s_b.md#parserportinfo) |
## **详细描述**
USB驱动订阅类。
**Since：**
3.0
**Version：**
1.0
\ No newline at end of file
zh-cn/device-dev/reference/hdi-apis/_sensor.md
浏览文件 @ 4ac779c5
......@@ -6,15 +6,15 @@
### 文件
| 文件 | 描述 |
| 文件 | 描述 |
| -------- | -------- |
| [sensor_if.h](sensor__if_8h.md) | Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/去订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。 |
| [sensor_if.h](sensor__if_8h.md) | Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/取消订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。 |
| [sensor_type.h](sensor__type_8h.md) | 定义传感器模块所使用的传感器类型，传感器信息，传感器数据结构等数据类型。 |
### 类
| 类 | 描述 |
| 类 | 描述 |
| -------- | -------- |
| [SensorInterface](_sensor_interface.md) | 提供sensor设备基本控制操作接口。 [更多...](_sensor_interface.md) |
| [SensorInformation](_sensor_information.md) | 定义传感器基本信息。 [更多...](_sensor_information.md) |
......@@ -23,7 +23,7 @@
### 宏定义
| 宏定义 | 描述 |
| 宏定义 | 描述 |
| -------- | -------- |
| [SENSOR_NAME_MAX_LEN](#sensornamemaxlen)   32 | Sensor名称的最大长度。 |
| [SENSOR_VERSION_MAX_LEN](#sensorversionmaxlen)   16 | Sensor版本号的最大长度。 |
......@@ -31,14 +31,14 @@
### 类型定义
| 类型定义 | 描述 |
| 类型定义 | 描述 |
| -------- | -------- |
| ([RecordDataCallback](#recorddatacallback)) (const struct [SensorEvents](_sensor_events.md) \*) | 传感器上报数据回调函数的定义，传感器服务用户在订阅传感器时， 需要注册上报数据回调函数，传感器使能后，传感器服务用户可以接受到传感器数据，详见[SensorInterface](_sensor_interface.md)。 [更多...](#recorddatacallback) |
### 枚举
| 枚举 | 描述 |
| 枚举 | 描述 |
| -------- | -------- |
| [SensorStatus](#sensorstatus) { SENSOR_SUCCESS = 0, SENSOR_FAILURE = -1, SENSOR_NOT_SUPPORT = -2, SENSOR_INVALID_PARAM = -3,   SENSOR_INVALID_SERVICE = -4, SENSOR_NULL_PTR = -5 } | 定义传感器模块返回值类型。 [更多...](#sensorstatus) |
| [SensorTypeTag](#sensortypetag) { SENSOR_TYPE_NONE = 0, SENSOR_TYPE_ACCELEROMETER = 1, SENSOR_TYPE_GYROSCOPE = 2, SENSOR_TYPE_PHOTOPLETHYSMOGRAPH = 3,   SENSOR_TYPE_ELECTROCARDIOGRAPH = 4, SENSOR_TYPE_AMBIENT_LIGHT = 5, SENSOR_TYPE_MAGNETIC_FIELD = 6, SENSOR_TYPE_CAPACITIVE = 7,   SENSOR_TYPE_BAROMETER = 8, SENSOR_TYPE_TEMPERATURE = 9, SENSOR_TYPE_HALL = 10, SENSOR_TYPE_GESTURE = 11,   SENSOR_TYPE_PROXIMITY = 12, SENSOR_TYPE_HUMIDITY = 13, SENSOR_TYPE_MEDICAL_BEGIN = 128, SENSOR_TYPE_MEDICAL_END = 160,   SENSOR_TYPE_PHYSICAL_MAX = 255, SENSOR_TYPE_ORIENTATION = 256, SENSOR_TYPE_GRAVITY = 257, SENSOR_TYPE_LINEAR_ACCELERATION = 258,   SENSOR_TYPE_ROTATION_VECTOR = 259, SENSOR_TYPE_AMBIENT_TEMPERATURE = 260, SENSOR_TYPE_MAGNETIC_FIELD_UNCALIBRATED = 261, SENSOR_TYPE_GAME_ROTATION_VECTOR = 262,   SENSOR_TYPE_GYROSCOPE_UNCALIBRATED = 263, SENSOR_TYPE_SIGNIFICANT_MOTION = 264, SENSOR_TYPE_PEDOMETER_DETECTION = 265, SENSOR_TYPE_PEDOMETER = 266,   SENSOR_TYPE_GEOMAGNETIC_ROTATION_VECTOR = 277, SENSOR_TYPE_HEART_RATE = 278, SENSOR_TYPE_DEVICE_ORIENTATION = 279, SENSOR_TYPE_WEAR_DETECTION = 280,   SENSOR_TYPE_ACCELEROMETER_UNCALIBRATED = 281, SENSOR_TYPE_MAX } | 定义传感器类型标识。 [更多...](#sensortypetag) |
......@@ -50,7 +50,7 @@
### 函数
| 函数 | 描述 |
| 函数 | 描述 |
| -------- | -------- |
| [NewSensorInterfaceInstance](#newsensorinterfaceinstance) (void) | 创建传感器接口实例。 [更多...](#newsensorinterfaceinstance) |
| [FreeSensorInterfaceInstance](#freesensorinterfaceinstance) (void) | 释放传感器接口实例。 [更多...](#freesensorinterfaceinstance) |
......@@ -60,7 +60,7 @@
传感器设备驱动对传感器服务提供通用的接口能力。
模块提供传感器服务对传感器驱动访问统一接口，服务获取驱动对象或者代理后， 通过其提供的各类方法，以传感器id区分访问不同类型传感器设备，实现获取传感器设备信息、订阅/去订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置等。
模块提供传感器服务对传感器驱动访问统一接口，服务获取驱动对象或者代理后， 通过其提供的各类方法，以传感器id区分访问不同类型传感器设备，实现获取传感器设备信息、订阅/取消订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置等。
**Since：**
......@@ -127,7 +127,7 @@ enum SensorAccuracyType
传感器的精度类型。
| 枚举值 | 描述 |
| 枚举值 | 描述 |
| -------- | -------- |
| SENSOR_NO_ACCURACY | 无精度类型。 |
| SENSOR_LOW_ACCURACY | 低精度类型。 |
......@@ -147,7 +147,7 @@ enum SensorGroupType
枚举传感器的硬件服务组。
| 枚举值 | 描述 |
| 枚举值 | 描述 |
| -------- | -------- |
| TRADITIONAL_SENSOR_TYPE | 传统传感器类型，传感器ID枚举值范围为128-160。 |
| MEDICAL_SENSOR_TYPE | 医疗传感器类型，传感器ID枚举值范围不在128-160之间。 |
......@@ -165,7 +165,7 @@ enum SensorModeType
传感器的工作模式。
| 枚举值 | 描述 |
| 枚举值 | 描述 |
| -------- | -------- |
| SENSOR_MODE_DEFAULT | 传感器默认工作模式状态。 |
| SENSOR_MODE_REALTIME | 传感器实时工作模式状态，一组数据上报一次。 |
......@@ -186,7 +186,7 @@ enum SensorRangeType
传感器的量程级别。
| 枚举值 | 描述 |
| 枚举值 | 描述 |
| -------- | -------- |
| SENSOR_RANGE_LEVEL1 | 量程级别1。 |
| SENSOR_RANGE_LEVEL2 | 量程级别2。 |
......@@ -205,7 +205,7 @@ enum SensorStatus
定义传感器模块返回值类型。
| 枚举值 | 描述 |
| 枚举值 | 描述 |
| -------- | -------- |
| SENSOR_SUCCESS | 传感器执行成功。 |
| SENSOR_FAILURE | 传感器执行失败。 |
......@@ -226,7 +226,7 @@ enum SensorTypeTag
定义传感器类型标识。
| 枚举值 | 描述 |
| 枚举值 | 描述 |
| -------- | -------- |
| SENSOR_TYPE_NONE | 空传感器类型，用于测试。 |
| SENSOR_TYPE_ACCELEROMETER | 加速度传感器。 |
......@@ -306,7 +306,7 @@ const struct SensorInterface* NewSensorInterfaceInstance (void )
**参数：**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| sensorId | 表示传感器ID。有关详细信息，详见[SensorTypeTag](#sensortypetag)。 |
| cb | 表示要注册的回调函数。有关详细信息，详见[RecordDataCallback](#recorddatacallback)。 |
......
zh-cn/device-dev/reference/hdi-apis/_sensor_information.md
浏览文件 @ 4ac779c5
......@@ -13,14 +13,14 @@
### Public 属性
| Public 属性 | 描述 |
| Public 属性 | 描述 |
| -------- | -------- |
| [sensorName](#sensorname) [[SENSOR_NAME_MAX_LEN](_sensor.md#sensornamemaxlen)] | 传感器名称。 |
| [vendorName](#vendorname) [[SENSOR_NAME_MAX_LEN](_sensor.md#sensornamemaxlen)] | 传感器设备厂商。 |
| [firmwareVersion](#firmwareversion) [[SENSOR_VERSION_MAX_LEN](_sensor.md#sensorversionmaxlen)] | 传感器固件版本号。 |
| [hardwareVersion](#hardwareversion)<br/>[[SENSOR_VERSION_MAX_LEN](_sensor.md#sensorversionmaxlen)] | 传感器硬件版本号。 |
| [sensorTypeId](#sensortypeid) | 传感器类型编号， |
| [sensorId](#sensorid) | 传感器的标识号，有传感器驱动开发者定义。 |
| [sensorTypeId](#sensortypeid) | 传感器类型编号。 |
| [sensorId](#sensorid) | 传感器的标识号，由传感器驱动开发者定义。 |
| [maxRange](#maxrange) | 传感器的最大量程。 |
| [accuracy](#accuracy) | 传感器的精度。 |
| [power](#power) | 传感器的功耗。 |
......@@ -97,7 +97,7 @@ int32_t SensorInformation::sensorId
**描述：**
传感器的标识号，有传感器驱动开发者定义。
传感器的标识号，由传感器驱动开发者定义。
### sensorName
......
zh-cn/device-dev/reference/hdi-apis/_sensor_interface.md
浏览文件 @ 4ac779c5
......@@ -13,7 +13,7 @@
### Public 属性
| Public&nbsp;属性 | 描述 |
| Public&nbsp;属性 | 描述 |
| -------- | -------- |
| (&nbsp;[GetAllSensors](#getallsensors)&nbsp;)([out]&nbsp;struct&nbsp;[SensorInformation](_sensor_information.md)&nbsp;\*\*sensorInfo,&nbsp;[out]&nbsp;int32_t&nbsp;\*count) | 获取当前系统中所有类型的传感器信息。&nbsp;[更多...](#getallsensors) |
| (&nbsp;[Enable](#enable)&nbsp;)([in]&nbsp;int32_t&nbsp;sensorId) | 根据传感器设备类型标识使能传感器信息列表里存在的设备，只有数据订阅者使能传感器后，才能获取订阅的传感器数据。&nbsp;[更多...](#enable) |
......@@ -22,14 +22,14 @@
| (&nbsp;[SetMode](#setmode)&nbsp;)([in]&nbsp;int32_t&nbsp;sensorId,&nbsp;[in]&nbsp;int32_t&nbsp;mode) | 设置指定传感器的数据上报模式，不同的工作模式，上报数据的方式不同。&nbsp;[更多...](#setmode) |
| (&nbsp;[SetOption](#setoption)&nbsp;)([in]&nbsp;int32_t&nbsp;sensorId,&nbsp;[in]&nbsp;uint32_t&nbsp;option) | 设置指定传感器量程、精度等可选配置。&nbsp;[更多...](#setoption) |
| (&nbsp;[Register](#register)&nbsp;)([in]&nbsp;int32_t&nbsp;groupId,&nbsp;[in]&nbsp;[RecordDataCallback](_sensor.md#recorddatacallback)&nbsp;cb) | 订阅者注册传感器数据回调函数，系统会将获取到的传感器数据上报给订阅者。&nbsp;[更多...](#register) |
| (&nbsp;[Unregister](#unregister)&nbsp;)([in]&nbsp;int32_t&nbsp;groupId,&nbsp;[in]&nbsp;[RecordDataCallback](_sensor.md#recorddatacallback)&nbsp;cb) | 订阅者去注册传感器数据回调函数。&nbsp;[更多...](#unregister) |
| (&nbsp;[Unregister](#unregister)&nbsp;)([in]&nbsp;int32_t&nbsp;groupId,&nbsp;[in]&nbsp;[RecordDataCallback](_sensor.md#recorddatacallback)&nbsp;cb) | 订阅者取消注册传感器数据回调函数。&nbsp;[更多...](#unregister) |
## **详细描述**
提供sensor设备基本控制操作接口。
结构体提供获取传感器设备信息、订阅/去订阅传感器数据、使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置接口定义。
结构体提供获取传感器设备信息、订阅/取消订阅传感器数据、使能/去使能传感器、设置传感器模式、设置传感器精度、量程等可选配置接口定义。
## **类成员变量说明**
......@@ -48,7 +48,7 @@ int32_t(* SensorInterface::Disable) ([in] int32_t sensorId)
**参数：**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 |
......@@ -72,7 +72,7 @@ int32_t(* SensorInterface::Enable) ([in] int32_t sensorId)
**参数：**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 |
......@@ -96,7 +96,7 @@ int32_t(* SensorInterface::GetAllSensors) ([out] struct SensorInformation **sens
**参数：**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| sensorInfo | 输出系统中注册的所有传感器信息，一种类型传感器信息包括传感器名字、设备厂商、&nbsp;固件版本号、硬件版本号、传感器类型编号、传感器标识、最大量程、精度、功耗，详见[SensorInformation](_sensor_information.md)。 |
| count | 输出系统中注册的传感器数量。 |
......@@ -121,7 +121,7 @@ int32_t(* SensorInterface::Register) ([in] int32_t groupId,[in] RecordDataCallba
**参数：**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| groupId | 传感器组ID。&nbsp;sensorId枚举值范围为128-160，表示已订阅医疗传感器服务，只需成功订阅一次，无需重复订阅。&nbsp;sensorId枚举值范围不在128-160之间，这意味着传统传感器已订阅，只需成功订阅一次，无需重复订阅。 |
| cb | 要注册的回调函数，详见[RecordDataCallback](_sensor.md#recorddatacallback)。 |
......@@ -146,7 +146,7 @@ int32_t(* SensorInterface::SetBatch) ([in] int32_t sensorId,[in] int64_t samplin
**参数：**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 |
| samplingInterval | 设置指定传感器的数据采样间隔，单位纳秒。 |
......@@ -172,7 +172,7 @@ int32_t(* SensorInterface::SetMode) ([in] int32_t sensorId,[in] int32_t mode)
**参数：**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 |
| mode | 传感器的数据上报模式，详见[SensorModeType](_sensor.md#sensormodetype)。 |
......@@ -197,7 +197,7 @@ int32_t(* SensorInterface::SetOption) ([in] int32_t sensorId,[in] uint32_t optio
**参数：**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| sensorId | 唯一标识一个传感器设备类型，详见[SensorTypeTag](_sensor.md#sensortypetag)。 |
| option | 传感器的量程、精度等配置。 |
......@@ -218,14 +218,14 @@ int32_t(* SensorInterface::Unregister) ([in] int32_t groupId,[in] RecordDataCall
**描述：**
订阅者去注册传感器数据回调函数。
订阅者取消注册传感器数据回调函数。
**参数：**
| 名称 | 描述 |
| 名称 | 描述 |
| -------- | -------- |
| groupId | 传感器组ID。&nbsp;sensorId枚举值范围为128-160，表示已订阅医疗传感器服务。只需成功取消订阅一次，无需重复取消订阅。&nbsp;sensorId枚举值范围不在128-160之间，这意味着传统传感器已订阅。并且成功取消订阅。 |
| cb | 要注册的回调函数，详见[RecordDataCallback](_sensor.md#recorddatacallback)。 |
| cb | 要取消注册的回调函数，详见[RecordDataCallback](_sensor.md#recorddatacallback)。 |
**返回：**
......
zh-cn/device-dev/reference/hdi-apis/_u_s_b.md
浏览文件 @ 4ac779c5
......@@ -31,7 +31,16 @@
| 宏定义 | 描述 |
| -------- | -------- |
| [USB_MAX_INTERFACES](#usbmaxinterfaces)&nbsp;&nbsp;&nbsp;32 | USB设备最大接口数量。 |
| [USB_MAX_INTERFACES](#usb\_max\_interfaces)&nbsp;&nbsp;&nbsp;32 | USB设备最大接口数量。 |
### 静态常量
| 静态常量 | 描述 |
| -------- | -------- |
| [USB_ENDPOINT_DIR_MASK](#usb\_endpoint\_dir\_mask)&nbsp;&nbsp;&nbsp;0x80 | 从地址中提取USB Endpoint方向的位掩码。 |
| [USB_ENDPOINT_DIR_IN](#usb\_endpoint\_dir\_in)&nbsp;&nbsp;&nbsp;0x80 | USB Endpoint从设备到主机的数据方向。 |
| [USB_ENDPOINT_DIR_OUT](#usb\_endpoint\_dir\_out)&nbsp;&nbsp;&nbsp;0 | USB Endpoint从主机到设备的数据方向。 |
### 类型定义
......@@ -59,7 +68,7 @@
| [OHOS::USB::UsbInfo::getDevInfoStatus](#getdevinfostatus)&nbsp;()&nbsp;const | 获取USB设备状态。&nbsp;[更多...](#getdevinfostatus) |
| [OHOS::USB::UsbInfo::getDevInfoBusNum](#getdevinfobusnum)&nbsp;()&nbsp;const | 获取USB总线编号。&nbsp;[更多...](#getdevinfobusnum) |
| [OHOS::USB::UsbInfo::getDevInfoDevNum](#getdevinfodevnum)&nbsp;()&nbsp;const | 获取USB设备编号。&nbsp;[更多...](#getdevinfodevnum) |
| **OHOS::USB::UsbdClient::GetInstance**&nbsp;() | 获取实例。 |
| [OHOS::USB::UsbdClient::GetInstance](#getinstance)&nbsp;()&nbsp; | 获取实例。&nbsp;[更多...](#getinstance) |
| [OHOS::USB::UsbdClient::OpenDevice](#opendevice)&nbsp;(const&nbsp;[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)&nbsp;&amp;dev) | 打开设备，建立连接。&nbsp;[更多...](#opendevice) |
| [OHOS::USB::UsbdClient::CloseDevice](#closedevice)&nbsp;(const&nbsp;[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)&nbsp;&amp;dev) | 关闭设备，释放与设备相关的所有系统资源。&nbsp;[更多...](#closedevice) |
| [OHOS::USB::UsbdClient::GetDeviceDescriptor](#getdevicedescriptor)&nbsp;(const&nbsp;[UsbDev](_o_h_o_s_1_1_u_s_b_1_1_usb_dev.md)&nbsp;&amp;dev,&nbsp;std::vector&lt;&nbsp;uint8_t&nbsp;&gt;&nbsp;&amp;descriptor) | 获取设备描述符。&nbsp;[更多...](#getdevicedescriptor) |
......@@ -96,6 +105,8 @@
| [OHOS::USB::UsbdSubscriber::DeviceEvent](#deviceevent)&nbsp;(const&nbsp;[UsbInfo](_o_h_o_s_1_1_u_s_b_1_1_usb_info.md)&nbsp;&amp;info)=0 | 设备事件。&nbsp;[更多...](#deviceevent) |
| [OHOS::USB::UsbdSubscriber::PortChangedEvent](#portchangedevent)&nbsp;(int32_t&nbsp;portId,&nbsp;int32_t&nbsp;powerRole,&nbsp;int32_t&nbsp;dataRole,&nbsp;int32_t&nbsp;mode)=0 | 端口改变事件。&nbsp;[更多...](#portchangedevent) |
| [OHOS::USB::UsbdSubscriber::OnRemoteRequest](#onremoterequest)&nbsp;(uint32_t&nbsp;code,&nbsp;MessageParcel&nbsp;&amp;data,&nbsp;MessageParcel&nbsp;&amp;reply,&nbsp;MessageOption&nbsp;&amp;option)&nbsp;override | 远程请求。&nbsp;[更多...](#onremoterequest) |
| [OHOS::USB::UsbdSubscriber::ParserUsbInfo](#parserusbinfo)&nbsp;(MessageParcel&nbsp;&amp;data,&nbsp;MessageParcel&nbsp;&amp;reply,&nbsp;MessageOption&nbsp;&amp;option,&nbsp;UsbInfo&nbsp;&amp;info) | 解析USB设备信息。&nbsp;[更多...](#parserusbinfo) |
| [OHOS::USB::UsbdSubscriber::ParserPortInfo](#parserportinfo)&nbsp;(MessageParcel&nbsp;&amp;data,&nbsp;MessageParcel&nbsp;&amp;reply,&nbsp;MessageOption&nbsp;&amp;option,&nbsp;PortInfo&nbsp;&amp;info) | 解析USB设备端口信息。&nbsp;[更多...](#parserportinfo) |
### 变量
......@@ -114,6 +125,7 @@
| [OHOS::USB::UsbCtrlTransfer::value](#value) | 请求值 |
| [OHOS::USB::UsbCtrlTransfer::index](#index) | 索引 |
| [OHOS::USB::UsbCtrlTransfer::timeout](#timeout) | 超时时间 |
| [OHOS::USB::UsbInfo::devInfo](#devinfo ) | USB设备信息 |
## **详细描述**
......@@ -146,6 +158,40 @@
USB设备最大接口数量
## **静态常量说明**
### USB_ENDPOINT_DIR_MASK
```
static const int32_t USB_ENDPOINT_DIR_MASK = 0x80
```
**描述：**
从地址中提取USB Endpoint方向的位掩码
### USB_ENDPOINT_DIR_IN
```
static const int32_t USB_ENDPOINT_DIR_IN = 0x80
```
**描述：**
USB Endpoint从设备到主机的数据方向
### USB_ENDPOINT_DIR_OUT
```
static const int32_t USB_ENDPOINT_DIR_OUT = 0
```
**描述：**
USB Endpoint从主机到设备的数据方向
## **类型定义说明**
......@@ -1055,6 +1101,75 @@ int32_t OHOS::USB::UsbdClient::OpenDevice (const UsbDev & dev)
1.0
### ParserUsbInfo()
```
static int32_t OHOS::USB::UsbdSubscriber::ParserUsbInfo(MessageParcel &data, MessageParcel &reply, MessageOption &option, UsbInfo &info)
```
**描述：**
解析USB设备信息。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| data | 输入参数，命令字。|
| reply | 输出参数，返回的数据。 |
| option | 输入参数，选项数据。|
| info | 输出参数，USB设备信息。|
**返回：**
0 表示操作成功。
非零值 表示操作失败。
**Since：**
3.0
**Version：**
1.0
### ParserPortInfo()
```
static int32_t OHOS::USB::UsbdSubscriber::ParserPortInfo(MessageParcel &data, MessageParcel &reply, MessageOption &option, PortInfo &info)
```
**描述：**
解析USB设备端口信息。
**参数：**
| 名称 | 描述 |
| -------- | -------- |
| data | 输入参数，命令字。|
| reply | 输出参数，返回的数据。 |
| option | 输入参数，选项数据。|
| info | 输出参数，USB设备端口信息。|
**返回：**
0 表示操作成功。
非零值 表示操作失败。
**Since：**
3.0
**Version：**
1.0
### PortChangedEvent()
......@@ -1570,6 +1685,25 @@ int32_t OHOS::USB::UsbdClient::UnRegBulkCallback (const UsbDev & dev, const UsbP
1.0
### GetInstance()
```
OHOS::USB::UsbdClient::GetInstance()
```
**描述：**
获取实例。
**Since：**
3.0
**Version：**
1.0
## **变量说明**
......@@ -1609,6 +1743,17 @@ uint8_t OHOS::USB::UsbDev::devAddr
USB设备地址
### devInfo
```
OHOS::USB::UsbInfo devInfo
```
**描述：**
USB设备信息
### devNum
......
zh-cn/device-dev/reference/hdi-apis/_user_auth_types_8idl.md
浏览文件 @ 4ac779c5
......@@ -35,6 +35,7 @@
| [AuthType](_hdf_user_auth.md#authtype)&nbsp;:&nbsp;int&nbsp;{&nbsp;&nbsp;&nbsp;PIN&nbsp;=&nbsp;1,&nbsp;FACE&nbsp;=&nbsp;2,&nbsp;FINGERPRINT&nbsp;=&nbsp;4,&nbsp;ALL&nbsp;=&nbsp;0&nbsp;} | 枚举用户认证凭据类型。&nbsp;[更多...](_hdf_user_auth.md#authtype) |
| [ExecutorRole](_hdf_user_auth.md#executorrole)&nbsp;:&nbsp;int&nbsp;{&nbsp;&nbsp;&nbsp;COLLECTOR&nbsp;=&nbsp;1,&nbsp;VERIFIER&nbsp;=&nbsp;2,&nbsp;ALL_IN_ONE&nbsp;=&nbsp;3&nbsp;} | 枚举执行器角色。&nbsp;[更多...](_hdf_user_auth.md#executorrole) |
| [ExecutorSecureLevel](_hdf_user_auth.md#executorsecurelevel)&nbsp;:&nbsp;int&nbsp;{&nbsp;&nbsp;&nbsp;ESL0&nbsp;=&nbsp;0,&nbsp;ESL1&nbsp;=&nbsp;1,&nbsp;ESL2&nbsp;=&nbsp;2,&nbsp;ESL3&nbsp;=&nbsp;3&nbsp;} | 枚举执行器安全等级。&nbsp;[更多...](_hdf_user_auth.md#executorsecurelevel) |
| [PinSubType](_hdf_user_auth.md#pinsubtype)&nbsp;:&nbsp;int&nbsp;{&nbsp;&nbsp;&nbsp;PIN\_SIX&nbsp;=&nbsp;10000,&nbsp;PIN\_NUMBER&nbsp;=&nbsp;10001,&nbsp;PIN\_MIX&nbsp;=&nbsp;10002&nbsp;} | 口令认证子类型。&nbsp;[更多...](_hdf_user_auth.md#pinsubtype) |
### 变量
......
zh-cn/device-dev/reference/hdi-apis/input__controller_8h.md
浏览文件 @ 4ac779c5
......@@ -15,12 +15,12 @@
| 类 | 描述 |
| -------- | -------- |
| [InputController](_input_controller.md) | 提供input设备业务控制相关的接口。&nbsp;[更多...](_input_controller.md) |
| [InputController](_input_controller.md) | 提供Input设备业务控制相关的接口。&nbsp;[更多...](_input_controller.md) |
## **详细描述**
描述input设备业务控制相关的接口声明。
描述Input设备业务控制相关的接口声明。
**Since：**
......
zh-cn/device-dev/reference/hdi-apis/input__manager_8h.md
浏览文件 @ 4ac779c5
......@@ -15,7 +15,7 @@
| 类 | 描述 |
| -------- | -------- |
| [InputManager](_input_manager.md) | 提供input设备管理相关的接口。&nbsp;[更多...](_input_manager.md) |
| [InputManager](_input_manager.md) | 提供Input设备管理相关的接口。&nbsp;[更多...](_input_manager.md) |
| [IInputInterface](_i_input_interface.md) | 定义用于提供输入设备驱动能力的接口。[更多...](_i_input_interface.md) |
......@@ -23,12 +23,13 @@
| 函数 | 描述 |
| -------- | -------- |
| [GetInputInterface](_input.md#getinputinterface)&nbsp;([IInputInterface](_i_input_interface.md)&nbsp;\*\*interface) | input服务通过调用此接口获取操作input设备的所有接口。&nbsp;[更多...](_input.md#getinputinterface) |
| [GetInputInterface](_input.md#getinputinterface)&nbsp;([IInputInterface](_i_input_interface.md)&nbsp;\*\*interface) | Input服务通过调用此接口获取操作Input设备的所有接口。&nbsp;[更多...](_input.md#getinputinterface) |
| [ReleaseInputInterface](_input.md#releaseinputinterface)&nbsp;([IInputInterface](_i_input_interface.md)&nbsp;\*\*inputInterface) | Input服务通过调用此接口释放操作Input设备的所有接口。&nbsp;[更多...](_input.md#releaseinputinterface) |
## **详细描述**
描述input设备管理相关的接口声明。
描述Input设备管理相关的接口声明。
**Since：**
......
zh-cn/device-dev/reference/hdi-apis/input__reporter_8h.md
浏览文件 @ 4ac779c5
......@@ -15,12 +15,12 @@
| 类 | 描述 |
| -------- | -------- |
| [InputReporter](_input_reporter.md) | 提供input设备数据上报相关的接口。&nbsp;[更多...](_input_reporter.md) |
| [InputReporter](_input_reporter.md) | 提供Input设备数据上报相关的接口。&nbsp;[更多...](_input_reporter.md) |
## **详细描述**
描述input设备数据上报相关的接口声明。
描述Input设备数据上报相关的接口声明。
**Since：**
......
zh-cn/device-dev/reference/hdi-apis/input__type_8h.md
浏览文件 @ 4ac779c5
......@@ -15,10 +15,17 @@
| 类 | 描述 |
| -------- | -------- |
| [EventPackage](_event_package.md) | input事件数据包结构&nbsp;[更多...](_event_package.md) |
| [InputReportEventCb](_input_report_event_cb.md) | 此结构体定义了输入事件回调函数并提供给input服务使用&nbsp;[更多...](_input_report_event_cb.md) |
| [DeviceInfo](_device_info.md) | input设备基础设备信息&nbsp;[更多...](_device_info.md) |
| [InputExtraCmd](_input_extra_cmd.md) | 扩展指令的数据结构&nbsp;[更多...](_input_extra_cmd.md) |
| [InputEventPackage](_event_package.md) | Input事件数据包结构。&nbsp;[更多...](_event_package.md) |
| [InputHotPlugEvent](_input_hotplug_event.md) | 热插拔事件数据包结构。&nbsp;[更多...](_input_hotplug_event.md) |
| [InputDevDesc](_input_dev_desc.md) | Input设备描述信息。&nbsp;[更多...](_input_dev_desc.md) |
| [InputEventCb](_input_report_event_cb.md) | 此结构体定义了输入事件回调函数并提供给Input服务使用。&nbsp;[更多...](_input_report_event_cb.md) |
| [InputHostCb](_input_host_cb.md) | 此结构体定义了热插拔事件上报回调函数并提供给Input服务使用。&nbsp;[更多...](_input_host_cb.md) |
| [InputDevAbility](_input_dev_ability.md) | Input设备的能力属性，存储支持事件的位图。&nbsp;[更多...](_input_dev_ability.md) |
| [InputDimensionInfo](_input_dimension_info.md) | Input设备的维度信息。&nbsp;[更多...](_input_dimension_info.md) |
| [InputDevIdentify](_input_dev_identify.md) | Input设备的识别信息。&nbsp;[更多...](_input_dev_identify.md) |
| [InputDevAttr](_input_dev_attr.md) | Input设备属性。&nbsp;[更多...](_input_dev_attr.md) |
| [InputDeviceInfo](_device_info.md) | Input设备基础设备信息。&nbsp;[更多...](_device_info.md) |
| [InputExtraCmd](_input_extra_cmd.md) | 扩展指令的数据结构。&nbsp;[更多...](_input_extra_cmd.md) |
### 宏定义
......@@ -26,26 +33,31 @@
| 宏定义 | 描述 |
| -------- | -------- |
| **MAX_INPUT_DEV_NUM**&nbsp;&nbsp;&nbsp;32 | Input设备最大数量。 |
| **MAX_NODE_PATH_LEN**&nbsp;&nbsp;&nbsp;64 | 节点路径最大长度。 |
| **DEV_NAME_LEN**&nbsp;&nbsp;&nbsp;64 | Input设备名称长度。 |
| **CHIP_INFO_LEN**&nbsp;&nbsp;&nbsp;10 | 芯片信息长度。 |
| **CHIP_NAME_LEN**&nbsp;&nbsp;&nbsp;10 | 芯片名称长度。 |
| **VENDOR_NAME_LEN**&nbsp;&nbsp;&nbsp;10 | 厂商名称长度。 |
| **SELF_TEST_RESULT_LEN**&nbsp;&nbsp;&nbsp;20 | 自测结果长度。 |
| **DEV_MANAGER_SERVICE_NAME**&nbsp;&nbsp;&nbsp;"hdf_input_host" | Input设备节点服务名称。 |
| **DIV_ROUND_UP(nr, d)**&nbsp;&nbsp;(((nr) + (d) - 1) / (d)) | 向上取整计算公式。|
| **BYTE_HAS_BITS**&nbsp;&nbsp;8 | 一个字节所包含的比特数。 |
| **BITS_TO_UINT64(count)**&nbsp;&nbsp;DIV_ROUND_UP(count, BYTE_HAS_BITS * sizeof(uint64_t)) | 比特与64位无符号整数的转换公式。 |
| **HDF_FF_CNT**&nbsp;&nbsp;(0x7f + 1) | Input设备发送力反馈命令的数量最大值。|
### 枚举
| 枚举 | 描述 |
| -------- | -------- |
| [RetStatus](_input.md#retstatus)&nbsp;{&nbsp;INPUT_SUCCESS&nbsp;=&nbsp;0,&nbsp;INPUT_FAILURE&nbsp;=&nbsp;-1,&nbsp;INPUT_INVALID_PARAM&nbsp;=&nbsp;-2,&nbsp;INPUT_NOMEM&nbsp;=&nbsp;-3,&nbsp;&nbsp;&nbsp;INPUT_NULL_PTR&nbsp;=&nbsp;-4,&nbsp;INPUT_TIMEOUT&nbsp;=&nbsp;-5,&nbsp;INPUT_UNSUPPORTED&nbsp;=&nbsp;-6&nbsp;} | 定义返回值类型&nbsp;[更多...](_input.md#retstatus) |
| [InputDevType](_input.md#inputdevtype)&nbsp;{&nbsp;INDEV_TYPE_TOUCH,&nbsp;INDEV_TYPE_KEY,&nbsp;INDEV_TYPE_KEYBOARD,&nbsp;INDEV_TYPE_MOUSE,&nbsp;&nbsp;&nbsp;INDEV_TYPE_BUTTON,&nbsp;INDEV_TYPE_CROWN,&nbsp;INDEV_TYPE_ENCODER,&nbsp;INDEV_TYPE_UNKNOWN&nbsp;} | 定义input设备类型&nbsp;[更多...](_input.md#inputdevtype) |
| [PowerStatus](_input.md#powerstatus)&nbsp;{&nbsp;INPUT_RESUME,&nbsp;INPUT_SUSPEND,&nbsp;INPUT_LOW_POWER,&nbsp;INPUT_POWER_STATUS_UNKNOWN&nbsp;} | 定义电源状态&nbsp;[更多...](_input.md#powerstatus) |
| [CapacitanceTest](_input.md#capacitancetest)&nbsp;{&nbsp;BASE_TEST,&nbsp;FULL_TEST,&nbsp;MMI_TEST,&nbsp;RUNNING_TEST,&nbsp;&nbsp;&nbsp;TEST_TYPE_UNKNOWN&nbsp;} | 定义容值测试类型&nbsp;[更多...](_input.md#capacitancetest) |
| [RetStatus](_input.md#retstatus)&nbsp;{&nbsp;INPUT_SUCCESS&nbsp;=&nbsp;0,&nbsp;INPUT_FAILURE&nbsp;=&nbsp;-1,&nbsp;INPUT_INVALID_PARAM&nbsp;=&nbsp;-2,&nbsp;INPUT_NOMEM&nbsp;=&nbsp;-3,&nbsp;&nbsp;&nbsp;INPUT_NULL_PTR&nbsp;=&nbsp;-4,&nbsp;INPUT_TIMEOUT&nbsp;=&nbsp;-5,&nbsp;INPUT_UNSUPPORTED&nbsp;=&nbsp;-6&nbsp;} | 定义返回值类型。&nbsp;[更多...](_input.md#retstatus) |
| [InputDevType](_input.md#inputdevtype)&nbsp;{&nbsp;INDEV_TYPE_TOUCH,&nbsp;INDEV_TYPE_KEY,&nbsp;INDEV_TYPE_KEYBOARD,&nbsp;INDEV_TYPE_MOUSE,&nbsp;&nbsp;&nbsp;INDEV_TYPE_BUTTON,&nbsp;INDEV_TYPE_CROWN,&nbsp;INDEV_TYPE_ENCODER,&nbsp;INDEV_TYPE_UNKNOWN&nbsp;} | 定义Input设备类型。&nbsp;[更多...](_input.md#inputdevtype) |
| [PowerStatus](_input.md#powerstatus)&nbsp;{&nbsp;INPUT_RESUME,&nbsp;INPUT_SUSPEND,&nbsp;INPUT_LOW_POWER,&nbsp;INPUT_POWER_STATUS_UNKNOWN&nbsp;} | 定义电源状态。&nbsp;[更多...](_input.md#powerstatus) |
| [CapacitanceTest](_input.md#capacitancetest)&nbsp;{&nbsp;BASE_TEST,&nbsp;FULL_TEST,&nbsp;MMI_TEST,&nbsp;RUNNING_TEST,&nbsp;&nbsp;&nbsp;TEST_TYPE_UNKNOWN&nbsp;} | 定义容值测试类型。&nbsp;[更多...](_input.md#capacitancetest) |
## **详细描述**
input设备相关的类型定义，定义了input设备驱动接口所使用的结构体及枚举类型。
Input设备相关的类型定义，定义了Input设备驱动接口所使用的结构体及枚举类型。
**Since：**
......
zh-cn/device-dev/reference/hdi-apis/interface_i_pin_auth_interface.md
浏览文件 @ 4ac779c5
......@@ -15,7 +15,7 @@
| Public&nbsp;成员函数 | 描述 |
| -------- | -------- |
| [GetExecutorList](#getexecutorlist)&nbsp;([out]&nbsp;[IExecutor](interface_i_executor.md)[]&nbsp;executorList) | 获取执行器列表，口令认证服务进程启动进行初始化操作时通过该接口获取口令认证驱动支持的执行器列表。&nbsp;[更多...](#getexecutorlist) |
| [GetExecutorList](#getexecutorlist)&nbsp;([out]&nbsp;[IExecutor](interface_pin_i_executor.md)[]&nbsp;executorList) | 获取执行器列表，口令认证服务进程启动进行初始化操作时通过该接口获取口令认证驱动支持的执行器列表。&nbsp;[更多...](#getexecutorlist) |
## **详细描述**
......@@ -49,7 +49,7 @@ IPinAuthInterface::GetExecutorList ([out] IExecutor[] executorList)
| 名称 | 描述 |
| -------- | -------- |
| executorList | 执行器对象列表[IExecutor](interface_i_executor.md)。 |
| executorList | 执行器对象列表[IExecutor](interface_pin_i_executor.md)。 |
**返回：**
......
zh-cn/device-dev/reference/hdi-apis/interface_i_user_auth_interface.md
浏览文件 @ 4ac779c5
......@@ -429,7 +429,7 @@ IUserAuthInterface::GetUserInfo([in] int userId, [out] unsigned long secureUid,
| -------- | -------- |
| userId | 用户ID。 |
| secureUid | 安全用户ID。 |
| pinSubType | 口令认证子类型&nbsp;{\@link&nbsp;PinSubType}。 |
| pinSubType | 口令认证子类型，请参考[PinSubType](_hdf_user_auth.md#pinsubtype)。 |
| infos | 注册信息[EnrolledInfo](_enrolled_info.md)。 |
**返回：**
......
zh-cn/device-dev/reference/hdi-apis/interface_pin_i_executor.md
浏览文件 @ 4ac779c5
......@@ -17,13 +17,13 @@
| -------- | -------- |
| [GetTemplateInfo](interface_i_executor.md#gettemplateinfo)&nbsp;([in]&nbsp;unsigned&nbsp;long&nbsp;templateId,&nbsp;[out]&nbsp;struct&nbsp;[TemplateInfo](_template_info.md)&nbsp;templateInfo) | 获取凭据模版信息。&nbsp;[更多...](interface_i_executor.md#gettemplateinfo) |
| [Cancel](interface_i_executor.md#cancel)&nbsp;([in]&nbsp;unsigned&nbsp;long&nbsp;scheduleId) | 取消操作请求。&nbsp;[更多...](interface_i_executor.md#cancel) |
| [h2GetExecutorInfo](#getexecutorinfo)&nbsp;([out]&nbsp;struct&nbsp;[ExecutorInfo](_executor_info.md)&nbsp;executorInfo) | 获取执行器信息，口令认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。&nbsp;[更多...](#getexecutorinfo) |
| [GetExecutorInfo](#getexecutorinfo)&nbsp;([out]&nbsp;struct&nbsp;[ExecutorInfo](_executor_info.md)&nbsp;executorInfo) | 获取执行器信息，口令认证服务将执行器注册到用户认证框架时需要通过该接口获取对应信息。&nbsp;[更多...](#getexecutorinfo) |
| [OnRegisterFinish](#onregisterfinish)&nbsp;([in]&nbsp;unsigned&nbsp;long[]&nbsp;templateIdList,&nbsp;[in]&nbsp;unsigned&nbsp;char[]&nbsp;frameworkPublicKey,&nbsp;[in]&nbsp;unsigned&nbsp;char[]&nbsp;extraInfo) | 完成执行器注册，对口令模版信息进行对账，用于删除无效的口令模板及相关信息。&nbsp;[更多...](#onregisterfinish) |
| [OnSetData](interface_i_executor.md#onsetdata)&nbsp;([in]&nbsp;unsigned&nbsp;long&nbsp;scheduleId,&nbsp;[in]&nbsp;unsigned&nbsp;long&nbsp;authSubType,&nbsp;[in]&nbsp;unsigned&nbsp;char[]&nbsp;data) | 设置口令数据，口令认证驱动处理注册或认证口令请求时，如果口令数据由口令认证服务获取，需要通过该接口将口令数据传给口令认证驱动。&nbsp;[更多...](interface_i_executor.md#onsetdata) |
| [Enroll](#enroll)&nbsp;([in]&nbsp;unsigned&nbsp;long&nbsp;scheduleId,&nbsp;[in]&nbsp;unsigned&nbsp;char[]&nbsp;extraInfo,&nbsp;[in]&nbsp;[IExecutorCallback](interface_i_executor_callback.md)&nbsp;callbackObj) | 注册口令。&nbsp;[更多...](#enroll) |
| [Authenticate](#authenticate)&nbsp;([in]&nbsp;unsigned&nbsp;long&nbsp;scheduleId,&nbsp;[in]&nbsp;unsigned&nbsp;long&nbsp;templateId,&nbsp;[in]&nbsp;unsigned&nbsp;char[]&nbsp;extraInfo,&nbsp;[in]&nbsp;[IExecutorCallback](interface_i_executor_callback.md)&nbsp;callbackObj) | 认证口令。&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001304382272.xml#xref15713627408,link:zh-cn_topic_0000001304382272.xml](zh-cn_topic_0000001304382272.xml) |
| [Enroll](#enroll)&nbsp;([in]&nbsp;unsigned&nbsp;long&nbsp;scheduleId,&nbsp;[in]&nbsp;unsigned&nbsp;char[]&nbsp;extraInfo,&nbsp;[in]&nbsp;[IExecutorCallback](interface_pin_i_executor_callback.md)&nbsp;callbackObj) | 注册口令。&nbsp;[更多...](#enroll) |
| [Authenticate](#authenticate)&nbsp;([in]&nbsp;unsigned&nbsp;long&nbsp;scheduleId,&nbsp;[in]&nbsp;unsigned&nbsp;long&nbsp;templateId,&nbsp;[in]&nbsp;unsigned&nbsp;char[]&nbsp;extraInfo,&nbsp;[in]&nbsp;[IExecutorCallback](interface_pin_i_executor_callback.md)&nbsp;callbackObj) | 认证口令。&nbsp;[ERROR:Invalid&nbsp;link:zh-cn_topic_0000001304382272.xml#xref15713627408,link:zh-cn_topic_0000001304382272.xml](zh-cn_topic_0000001304382272.xml) |
| [Delete](#delete)&nbsp;([in]&nbsp;unsigned&nbsp;long&nbsp;templateId) | 删除口令。&nbsp;[更多...](#delete) |
| [SendCommand](#sendcommand)&nbsp;([in]&nbsp;int&nbsp;commandId,&nbsp;[in]&nbsp;unsigned&nbsp;char[]&nbsp;extraInfo,&nbsp;[in]&nbsp;[IExecutorCallback](interface_i_executor_callback.md)&nbsp;callbackObj) | 发送口令认证功能相关操作命令。&nbsp;[更多...](#sendcommand) |
| [SendCommand](#sendcommand)&nbsp;([in]&nbsp;int&nbsp;commandId,&nbsp;[in]&nbsp;unsigned&nbsp;char[]&nbsp;extraInfo,&nbsp;[in]&nbsp;[IExecutorCallback](interface_pin_i_executor_callback.md)&nbsp;callbackObj) | 发送口令认证功能相关操作命令。&nbsp;[更多...](#sendcommand) |
## **详细描述**
......@@ -60,7 +60,7 @@ IExecutor::Authenticate ([in] unsigned long scheduleId, [in] unsigned long templ
| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 |
| templateId | 指定要认证的模版ID。 |
| extraInfo | 其他相关信息，用于支持信息扩展。 |
| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback.md)。 |
| callbackObj | 回调对象[IExecutorCallback](interface_pin_i_executor_callback.md)。 |
**返回：**
......@@ -134,7 +134,7 @@ IExecutor::Enroll ([in] unsigned long scheduleId, [in] unsigned char[] extraInfo
| -------- | -------- |
| scheduleId | 调度ID，用于标识一次操作请求的调度过程。 |
| extraInfo | 其他相关信息，用于支持信息扩展。 |
| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback.md)。 |
| callbackObj | 回调对象[IExecutorCallback](interface_pin_i_executor_callback.md)。 |
**返回：**
......@@ -261,7 +261,7 @@ IExecutor::SendCommand ([in] int commandId, [in] unsigned char[] extraInfo, [in]
| -------- | -------- |
| commandId | 操作命令ID[CommandId](_hdf_pin_auth.md#commandid)。 |
| extraInfo | 其他相关信息，用于支持信息扩展。 |
| callbackObj | 回调对象[IExecutorCallback](interface_i_executor_callback.md)。 |
| callbackObj | 回调对象[IExecutorCallback](interface_pin_i_executor_callback.md)。 |
**返回：**
......
zh-cn/device-dev/reference/hdi-apis/light_8typeh.md
浏览文件 @ 4ac779c5
......@@ -13,7 +13,7 @@
### 类
| 类 | 描述 |
| 类 | 描述 |
| -------- | -------- |
| LightFlashEffect | 定义闪烁参数。&nbsp;[更多...](_light_flash_effect.md) |
| LightEffect | 定义灯的效果参数。&nbsp;[更多...](_light_effect.md) |
......@@ -27,3 +27,7 @@
**Since：**
3.1
**Version：**
1.0
\ No newline at end of file
zh-cn/device-dev/reference/hdi-apis/light__if_8h.md
浏览文件 @ 4ac779c5
......@@ -13,14 +13,14 @@
### 类
| 类 | 描述 |
| 类 | 描述 |
| -------- | -------- |
| [LightInterface](_light_interface.md) | 定义可以在灯上执行的基本操作。&nbsp;[更多...](_light_interface.md) |
### 函数
| 函数 | 描述 |
| 函数 | 描述 |
| -------- | -------- |
| [NewLightInterfaceInstance](_light.md#newlightinterfaceinstance)&nbsp;(void) | 创建LightInterface实例。&nbsp;[更多...](_light.md#newlightinterfaceinstance) |
| [FreeLightInterfaceInstance](_light.md#freelightinterfaceinstance)&nbsp;(void) | 释放LightInterface实例和相关资源。&nbsp;[更多...](_light.md#freelightinterfaceinstance) |
......@@ -30,6 +30,11 @@
声明light模块的通用API，可用于获取灯ID、打开或关闭灯、并设置灯光亮度和闪烁模式。
**Sinc[更多...](_light_flash_effect.md)e更多...[更多...](_light_info.md)：**
**Since：**
3.1
**Version：**
1.0
zh-cn/device-dev/reference/hdi-apis/pin__auth_2_i_executor_8idl.md
浏览文件 @ 4ac779c5
......@@ -15,7 +15,7 @@
| 类 | 描述 |
| -------- | -------- |
| [IExecutor](interface_i_executor.md) | 定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。&nbsp;[更多...](interface_i_executor.md) |
| [IExecutor](interface_pin_i_executor.md) | 定义执行器标准API接口。接口可用于获取执行器信息，获取凭据模版信息，注册口令，认证口令，删除口令等。&nbsp;[更多...](interface_pin_i_executor.md) |
### 变量
......
zh-cn/device-dev/reference/hdi-apis/pin__auth_2_i_executor_callback_8idl.md
浏览文件 @ 4ac779c5
......@@ -15,7 +15,7 @@
| 类 | 描述 |
| -------- | -------- |
| [IExecutorCallback](interface_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_i_executor.md)。&nbsp;[更多...](interface_i_executor_callback.md) |
| [IExecutorCallback](interface_pin_i_executor_callback.md) | 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见[IExecutor](interface_pin_i_executor.md)。&nbsp;[更多...](interface_pin_i_executor_callback.md) |
### 变量
......@@ -27,7 +27,7 @@
## **详细描述**
定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。使用细节见[IExecutor](interface_i_executor.md)。
定义异步API接口回调，用于返回异步接口的请求处理结果和获取信息。使用细节见[IExecutor](interface_pin_i_executor.md)。
**Since：**
......
zh-cn/device-dev/reference/hdi-apis/sensor__if_8h.md
浏览文件 @ 4ac779c5
......@@ -13,14 +13,14 @@
### 类
| 类 | 描述 |
| 类 | 描述 |
| -------- | -------- |
| [SensorInterface](_sensor_interface.md) | 提供sensor设备基本控制操作接口。&nbsp;[更多...](_sensor_interface.md) |
### 函数
| 函数 | 描述 |
| 函数 | 描述 |
| -------- | -------- |
| [NewSensorInterfaceInstance](_sensor.md#newsensorinterfaceinstance)&nbsp;(void) | 创建传感器接口实例。&nbsp;[更多...](_sensor.md#newsensorinterfaceinstance) |
| [FreeSensorInterfaceInstance](_sensor.md#freesensorinterfaceinstance)&nbsp;(void) | 释放传感器接口实例。&nbsp;[更多...](_sensor.md#freesensorinterfaceinstance) |
......@@ -28,7 +28,7 @@
## **详细描述**
Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/去订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。
Sensor模块对外通用的接口声明文件，提供获取传感器设备信息、订阅/取消订阅传感器数据、 使能/去使能传感器、设置传感器模式、设置传感器精度，量程等可选配置接口定义。
**Since：**
......
zh-cn/device-dev/reference/hdi-apis/usbd__type_8h.md
浏览文件 @ 4ac779c5
......@@ -27,6 +27,15 @@
| -------- | -------- |
| [USB_MAX_INTERFACES](_u_s_b.md#usbmaxinterfaces)&nbsp;&nbsp;&nbsp;32 | USB设备最大接口数量。 |
### 静态常量
| 静态常量 | 描述 |
| -------- | -------- |
| [USB_ENDPOINT_DIR_MASK](_u_s_b.md#usb\_endpoint\_dir\_mask)&nbsp;&nbsp;&nbsp;0x80 | 从地址中提取USB Endpoint方向的位掩码。 |
| [USB_ENDPOINT_DIR_IN](_u_s_b.md#usb\_endpoint\_dir\_in)&nbsp;&nbsp;&nbsp;0x80 | USB Endpoint从设备到主机的数据方向。 |
| [USB_ENDPOINT_DIR_OUT](_u_s_b.md#usb\_endpoint\_dir\_out)&nbsp;&nbsp;&nbsp;0 | USB Endpoint从主机到设备的数据方向。 |
### 类型定义
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或