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