1# InputController 2 3 4## 概述 5 6提供Input设备业务控制相关的接口。 7 8此类接口包含电源状态的设置、特性的使能、器件信息的获取，以及产线相关的测试功能接口。 9 10**起始版本：** 1.0 11 12**相关模块：**[Input](_input.md) 13 14 15## 汇总 16 17 18### Public 属性 19 20| 名称 | 描述 | 21| -------- | -------- | 22| int32_t(\* [SetPowerStatus](#setpowerstatus) )(uint32_t devIndex, uint32_t status) | 设置电源状态。 | 23| int32_t(\* [GetPowerStatus](#getpowerstatus) )(uint32_t devIndex, uint32_t \*status) | 获取电源状态。 | 24| int32_t(\* [GetDeviceType](#getdevicetype) )(uint32_t devIndex, uint32_t \*deviceType) | 获取devIndex对应的Input设备的类型。 | 25| int32_t(\* [GetChipInfo](#getchipinfo) )(uint32_t devIndex, char \*chipInfo, uint32_t length) | 获取器件对应的编码信息。 | 26| int32_t(\* [GetVendorName](#getvendorname) )(uint32_t devIndex, char \*vendorName, uint32_t length) | 获取devIndex对应的模组厂商名。 | 27| int32_t(\* [GetChipName](#getchipname) )(uint32_t devIndex, char \*chipName, uint32_t length) | 获取devIndex对应的驱动芯片名。 | 28| int32_t(\* [SetGestureMode](#setgesturemode) )(uint32_t devIndex, uint32_t gestureMode) | 设置手势模式。 | 29| int32_t(\* [RunCapacitanceTest](#runcapacitancetest) )(uint32_t devIndex, uint32_t testType, char \*result, uint32_t length) | 执行容值自检测试。 | 30| int32_t(\* [RunExtraCommand](#runextracommand) )(uint32_t devIndex, [InputExtraCmd](_input_extra_cmd.md) \*cmd) | 执行拓展指令。 | 31 32 33## 类成员变量说明 34 35 36### GetChipInfo 37 38``` 39int32_t(* InputController::GetChipInfo) (uint32_t devIndex, char *chipInfo, uint32_t length) 40``` 41 42**描述** 43 44 45获取器件对应的编码信息。 46 47一款产品通常会有多家模组和Driver IC，上层应用如果关注具体器件型号，则通过此接口来获取。 48 49**起始版本：** 1.0 50 51**参数:** 52 53| 名称 | 描述 | 54| -------- | -------- | 55| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 56| chipInfo | 输出参数，获取的对应设备索引的器件编码信息。 | 57| length | 输入参数，保存器件芯片信息的内存长度。 | 58 59**返回：** 60 61INPUT_SUCCESS 表示执行成功。 62 63其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 64 65 66### GetChipName 67 68``` 69int32_t(* InputController::GetChipName) (uint32_t devIndex, char *chipName, uint32_t length) 70``` 71 72**描述** 73 74 75获取devIndex对应的驱动芯片名。 76 77**起始版本：** 1.0 78 79**参数:** 80 81| 名称 | 描述 | 82| -------- | -------- | 83| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 84| chipName | 输出参数，获取的对应设备索引的驱动芯片名。 | 85| length | 输入参数，保存驱动芯片名的内存长度。 | 86 87**返回：** 88 89INPUT_SUCCESS 表示执行成功。 90 91其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 92 93 94### GetDeviceType 95 96``` 97int32_t(* InputController::GetDeviceType) (uint32_t devIndex, uint32_t *deviceType) 98``` 99 100**描述** 101 102 103获取devIndex对应的Input设备的类型。 104 105**起始版本：** 1.0 106 107**参数:** 108 109| 名称 | 描述 | 110| -------- | -------- | 111| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 112| deviceType | 输出参数，获取的对应设备索引的设备类型，具体参考[InputDevType](_input.md#inputdevtype)。 | 113 114**返回：** 115 116INPUT_SUCCESS 表示执行成功。 117 118其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 119 120 121### GetPowerStatus 122 123``` 124int32_t(* InputController::GetPowerStatus) (uint32_t devIndex, uint32_t *status) 125``` 126 127**描述** 128 129 130获取电源状态。 131 132在系统休眠或者唤醒时，Input服务或电源管理模块获取电源状态，以便驱动IC能正常进入对应的休眠模式。 133 134**起始版本：** 1.0 135 136**参数:** 137 138| 名称 | 描述 | 139| -------- | -------- | 140| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 141| status | 输出参数，获取的对应设备索引的电源状态，具体参考[PowerStatus](_input.md#powerstatus)。 | 142 143**返回：** 144 145INPUT_SUCCESS 表示执行成功。 146 147其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 148 149 150### GetVendorName 151 152``` 153int32_t(* InputController::GetVendorName) (uint32_t devIndex, char *vendorName, uint32_t length) 154``` 155 156**描述** 157 158 159获取devIndex对应的模组厂商名。 160 161**起始版本：** 1.0 162 163**参数:** 164 165| 名称 | 描述 | 166| -------- | -------- | 167| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 168| vendorName | 输出参数，获取的对应设备索引的模组厂商名。 | 169| length | 输入参数，保存模组厂商名的内存长度。 | 170 171**返回：** 172 173INPUT_SUCCESS 表示执行成功。 174 175其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 176 177 178### RunCapacitanceTest 179 180``` 181int32_t(* InputController::RunCapacitanceTest) (uint32_t devIndex, uint32_t testType, char *result, uint32_t length) 182``` 183 184**描述** 185 186 187执行容值自检测试。 188 189启动不同检测场景下的容值自检测试，并获取测试结果，容值自检项由器件厂商自定义， 一般包括RawData测试、短路检测、开路检测、干扰检测、行列差检测等测试项。 190 191**起始版本：** 1.0 192 193**参数:** 194 195| 名称 | 描述 | 196| -------- | -------- | 197| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 198| testType | 输入参数，容值测试的测试类型，具体参考[CapacitanceTest](_input.md#capacitancetest)。 | 199| result | 输出参数，容值测试的结果，成功则输出“SUCC”，失败则返回对应的错误提示。 | 200| length | 输入参数，保存容值测试结果的内存长度。 | 201 202**返回：** 203 204INPUT_SUCCESS 表示执行成功。 205 206其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 207 208 209### RunExtraCommand 210 211``` 212int32_t(* InputController::RunExtraCommand) (uint32_t devIndex, InputExtraCmd *cmd) 213``` 214 215**描述** 216 217 218执行拓展指令。 219 220**起始版本：** 1.0 221 222**参数:** 223 224| 名称 | 描述 | 225| -------- | -------- | 226| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 227| cmd | 输入参数，拓展指令数据包，包括指令编码及参数，具体参考[InputExtraCmd](_input_extra_cmd.md)。 | 228 229**返回：** 230 231INPUT_SUCCESS 表示执行成功。 232 233其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 234 235 236### SetGestureMode 237 238``` 239int32_t(* InputController::SetGestureMode) (uint32_t devIndex, uint32_t gestureMode) 240``` 241 242**描述** 243 244 245设置手势模式。 246 247上层应用开关手势模式，即设置手势模式的对应使能bit。 248 249**起始版本：** 1.0 250 251**参数:** 252 253| 名称 | 描述 | 254| -------- | -------- | 255| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 256| gestureMode | 输入参数，手势模式的开关状态。 | 257 258**返回：** 259 260INPUT_SUCCESS 表示执行成功。 261 262其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 263 264 265### SetPowerStatus 266 267``` 268int32_t(* InputController::SetPowerStatus) (uint32_t devIndex, uint32_t status) 269``` 270 271**描述** 272 273 274设置电源状态。 275 276在系统休眠或者唤醒时，Input服务或电源管理模块设置电源状态，以使驱动IC能正常进入对应的休眠模式。 277 278**起始版本：** 1.0 279 280**参数:** 281 282| 名称 | 描述 | 283| -------- | -------- | 284| devIndex | 输入参数，Input设备索引，用于标志多个Input设备，取值从0开始，最多支持32个设备。 | 285| status | 输入参数，设置的电源状态，Input服务控制Input设备进入resume或者suspend等状态[PowerStatus](_input.md#powerstatus)。 | 286 287**返回：** 288 289INPUT_SUCCESS 表示执行成功。 290 291其他值表示执行失败，具体错误码查看[RetStatus](_input.md#retstatus)。 292