From 6295c626bbba0831966b6162e10c16dfb1a97c07 Mon Sep 17 00:00:00 2001 From: duangavin123 Date: Thu, 28 Jul 2022 14:30:42 +0800 Subject: [PATCH] =?UTF-8?q?=E8=A1=A5=E5=85=85HDI?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: duangavin123 --- .../reference/hdi-apis/_input_dev_ability.md | 196 ++++++++++++++++++ .../reference/hdi-apis/_input_dev_attr.md | 58 ++++++ .../reference/hdi-apis/_input_dev_desc.md | 51 +++++ .../reference/hdi-apis/_input_dev_identify.md | 69 ++++++ .../hdi-apis/_input_dimension_info.md | 91 ++++++++ .../reference/hdi-apis/_input_host_cb.md | 44 ++++ .../hdi-apis/_input_hotplug_event.md | 66 ++++++ 7 files changed, 575 insertions(+) create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_dev_ability.md create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_dev_attr.md create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_dev_desc.md create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_dev_identify.md create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_dimension_info.md create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_host_cb.md create mode 100644 zh-cn/device-dev/reference/hdi-apis/_input_hotplug_event.md diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_dev_ability.md b/zh-cn/device-dev/reference/hdi-apis/_input_dev_ability.md new file mode 100644 index 0000000000..d7ec4c6686 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dev_ability.md @@ -0,0 +1,196 @@ +# 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)] +``` + +**描述：** + +开关状态的位图。 + diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_dev_attr.md b/zh-cn/device-dev/reference/hdi-apis/_input_dev_attr.md new file mode 100644 index 0000000000..d6dcb2b379 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dev_attr.md @@ -0,0 +1,58 @@ +# 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 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_dev_desc.md b/zh-cn/device-dev/reference/hdi-apis/_input_dev_desc.md new file mode 100644 index 0000000000..5950fca754 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dev_desc.md @@ -0,0 +1,51 @@ +# InputDevDesc + + +## **概述** + +**所属模块:** + +[Input](_input.md) + + +## **汇总** + + +### Public 属性 + + | Public 属性 | 描述 | +| -------- | -------- | +| [devIndex](#devindex) | 设备索引 | +| [devType](#devtype) | 设备类型 | + + +## **详细描述** + +Input设备描述信息。 + + +## **类成员变量说明** + + +### devIndex + + +``` +uint32_t InputHotPlugEvent::devIndex +``` + +**描述：** + +设备索引。 + + +### devType + + +``` +uint32_t InputHotPlugEvent::devType +``` + +**描述：** + +设备类型。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_dev_identify.md b/zh-cn/device-dev/reference/hdi-apis/_input_dev_identify.md new file mode 100644 index 0000000000..8520f5f62c --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dev_identify.md @@ -0,0 +1,69 @@ +# 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 +``` + +**描述：** + +版本号。 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_dimension_info.md b/zh-cn/device-dev/reference/hdi-apis/_input_dimension_info.md new file mode 100644 index 0000000000..bdbbdbd5d3 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_dimension_info.md @@ -0,0 +1,91 @@ +# 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 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_host_cb.md b/zh-cn/device-dev/reference/hdi-apis/_input_host_cb.md new file mode 100644 index 0000000000..372d6d7847 --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_host_cb.md @@ -0,0 +1,44 @@ +# 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 diff --git a/zh-cn/device-dev/reference/hdi-apis/_input_hotplug_event.md b/zh-cn/device-dev/reference/hdi-apis/_input_hotplug_event.md new file mode 100644 index 0000000000..1bfe63ea8d --- /dev/null +++ b/zh-cn/device-dev/reference/hdi-apis/_input_hotplug_event.md @@ -0,0 +1,66 @@ +# 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：在线。 -- GitLab