diff options
author | Benson Leung <bleung@chromium.org> | 2013-01-09 19:25:11 -0500 |
---|---|---|
committer | Dmitry Torokhov <dmitry.torokhov@gmail.com> | 2013-01-17 03:28:10 -0500 |
commit | d7e34d12ba877fa77080257d2621c29769333c40 (patch) | |
tree | cea039b57d11c5c124c530a2168b893949612304 /drivers/input/mouse/cyapa.c | |
parent | 236d6a77eeac702abb8e908a6ec11a37507c5071 (diff) |
Input: add driver for Cypress APA I2C Trackpad
This patch introduces a driver for Cypress All Points Addressable
I2C Trackpad, including the ones in 2012 Samsung Chromebooks.
This device is compatible with MT protocol type B, providing identifiable
contacts.
Signed-off-by: Dudley Du <dudl@cypress.com>
Signed-off-by: Daniel Kurtz <djkurtz@chromium.org>
Signed-off-by: Benson Leung <bleung@chromium.org>
Reviewed-by: Henrik Rydberg <rydberg@euromail.se>
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Diffstat (limited to 'drivers/input/mouse/cyapa.c')
-rw-r--r-- | drivers/input/mouse/cyapa.c | 804 |
1 files changed, 804 insertions, 0 deletions
diff --git a/drivers/input/mouse/cyapa.c b/drivers/input/mouse/cyapa.c new file mode 100644 index 000000000000..1a14688329be --- /dev/null +++ b/drivers/input/mouse/cyapa.c | |||
@@ -0,0 +1,804 @@ | |||
1 | /* | ||
2 | * Cypress APA trackpad with I2C interface | ||
3 | * | ||
4 | * Author: Dudley Du <dudl@cypress.com> | ||
5 | * Further cleanup and restructuring by: | ||
6 | * Daniel Kurtz <djkurtz@chromium.org> | ||
7 | * Benson Leung <bleung@chromium.org> | ||
8 | * | ||
9 | * Copyright (C) 2011-2012 Cypress Semiconductor, Inc. | ||
10 | * Copyright (C) 2011-2012 Google, Inc. | ||
11 | * | ||
12 | * This file is subject to the terms and conditions of the GNU General Public | ||
13 | * License. See the file COPYING in the main directory of this archive for | ||
14 | * more details. | ||
15 | */ | ||
16 | |||
17 | #include <linux/delay.h> | ||
18 | #include <linux/i2c.h> | ||
19 | #include <linux/input.h> | ||
20 | #include <linux/input/mt.h> | ||
21 | #include <linux/interrupt.h> | ||
22 | #include <linux/module.h> | ||
23 | #include <linux/slab.h> | ||
24 | |||
25 | /* APA trackpad firmware generation */ | ||
26 | #define CYAPA_GEN3 0x03 /* support MT-protocol B with tracking ID. */ | ||
27 | |||
28 | #define CYAPA_NAME "Cypress APA Trackpad (cyapa)" | ||
29 | |||
30 | /* commands for read/write registers of Cypress trackpad */ | ||
31 | #define CYAPA_CMD_SOFT_RESET 0x00 | ||
32 | #define CYAPA_CMD_POWER_MODE 0x01 | ||
33 | #define CYAPA_CMD_DEV_STATUS 0x02 | ||
34 | #define CYAPA_CMD_GROUP_DATA 0x03 | ||
35 | #define CYAPA_CMD_GROUP_CMD 0x04 | ||
36 | #define CYAPA_CMD_GROUP_QUERY 0x05 | ||
37 | #define CYAPA_CMD_BL_STATUS 0x06 | ||
38 | #define CYAPA_CMD_BL_HEAD 0x07 | ||
39 | #define CYAPA_CMD_BL_CMD 0x08 | ||
40 | #define CYAPA_CMD_BL_DATA 0x09 | ||
41 | #define CYAPA_CMD_BL_ALL 0x0a | ||
42 | #define CYAPA_CMD_BLK_PRODUCT_ID 0x0b | ||
43 | #define CYAPA_CMD_BLK_HEAD 0x0c | ||
44 | |||
45 | /* report data start reg offset address. */ | ||
46 | #define DATA_REG_START_OFFSET 0x0000 | ||
47 | |||
48 | #define BL_HEAD_OFFSET 0x00 | ||
49 | #define BL_DATA_OFFSET 0x10 | ||
50 | |||
51 | /* | ||
52 | * Operational Device Status Register | ||
53 | * | ||
54 | * bit 7: Valid interrupt source | ||
55 | * bit 6 - 4: Reserved | ||
56 | * bit 3 - 2: Power status | ||
57 | * bit 1 - 0: Device status | ||
58 | */ | ||
59 | #define REG_OP_STATUS 0x00 | ||
60 | #define OP_STATUS_SRC 0x80 | ||
61 | #define OP_STATUS_POWER 0x0c | ||
62 | #define OP_STATUS_DEV 0x03 | ||
63 | #define OP_STATUS_MASK (OP_STATUS_SRC | OP_STATUS_POWER | OP_STATUS_DEV) | ||
64 | |||
65 | /* | ||
66 | * Operational Finger Count/Button Flags Register | ||
67 | * | ||
68 | * bit 7 - 4: Number of touched finger | ||
69 | * bit 3: Valid data | ||
70 | * bit 2: Middle Physical Button | ||
71 | * bit 1: Right Physical Button | ||
72 | * bit 0: Left physical Button | ||
73 | */ | ||
74 | #define REG_OP_DATA1 0x01 | ||
75 | #define OP_DATA_VALID 0x08 | ||
76 | #define OP_DATA_MIDDLE_BTN 0x04 | ||
77 | #define OP_DATA_RIGHT_BTN 0x02 | ||
78 | #define OP_DATA_LEFT_BTN 0x01 | ||
79 | #define OP_DATA_BTN_MASK (OP_DATA_MIDDLE_BTN | OP_DATA_RIGHT_BTN | \ | ||
80 | OP_DATA_LEFT_BTN) | ||
81 | |||
82 | /* | ||
83 | * Bootloader Status Register | ||
84 | * | ||
85 | * bit 7: Busy | ||
86 | * bit 6 - 5: Reserved | ||
87 | * bit 4: Bootloader running | ||
88 | * bit 3 - 1: Reserved | ||
89 | * bit 0: Checksum valid | ||
90 | */ | ||
91 | #define REG_BL_STATUS 0x01 | ||
92 | #define BL_STATUS_BUSY 0x80 | ||
93 | #define BL_STATUS_RUNNING 0x10 | ||
94 | #define BL_STATUS_DATA_VALID 0x08 | ||
95 | #define BL_STATUS_CSUM_VALID 0x01 | ||
96 | |||
97 | /* | ||
98 | * Bootloader Error Register | ||
99 | * | ||
100 | * bit 7: Invalid | ||
101 | * bit 6: Invalid security key | ||
102 | * bit 5: Bootloading | ||
103 | * bit 4: Command checksum | ||
104 | * bit 3: Flash protection error | ||
105 | * bit 2: Flash checksum error | ||
106 | * bit 1 - 0: Reserved | ||
107 | */ | ||
108 | #define REG_BL_ERROR 0x02 | ||
109 | #define BL_ERROR_INVALID 0x80 | ||
110 | #define BL_ERROR_INVALID_KEY 0x40 | ||
111 | #define BL_ERROR_BOOTLOADING 0x20 | ||
112 | #define BL_ERROR_CMD_CSUM 0x10 | ||
113 | #define BL_ERROR_FLASH_PROT 0x08 | ||
114 | #define BL_ERROR_FLASH_CSUM 0x04 | ||
115 | |||
116 | #define BL_STATUS_SIZE 3 /* length of bootloader status registers */ | ||
117 | #define BLK_HEAD_BYTES 32 | ||
118 | |||
119 | #define PRODUCT_ID_SIZE 16 | ||
120 | #define QUERY_DATA_SIZE 27 | ||
121 | #define REG_PROTOCOL_GEN_QUERY_OFFSET 20 | ||
122 | |||
123 | #define REG_OFFSET_DATA_BASE 0x0000 | ||
124 | #define REG_OFFSET_COMMAND_BASE 0x0028 | ||
125 | #define REG_OFFSET_QUERY_BASE 0x002a | ||
126 | |||
127 | #define CAPABILITY_LEFT_BTN_MASK (0x01 << 3) | ||
128 | #define CAPABILITY_RIGHT_BTN_MASK (0x01 << 4) | ||
129 | #define CAPABILITY_MIDDLE_BTN_MASK (0x01 << 5) | ||
130 | #define CAPABILITY_BTN_MASK (CAPABILITY_LEFT_BTN_MASK | \ | ||
131 | CAPABILITY_RIGHT_BTN_MASK | \ | ||
132 | CAPABILITY_MIDDLE_BTN_MASK) | ||
133 | |||
134 | #define CYAPA_OFFSET_SOFT_RESET REG_OFFSET_COMMAND_BASE | ||
135 | |||
136 | #define REG_OFFSET_POWER_MODE (REG_OFFSET_COMMAND_BASE + 1) | ||
137 | |||
138 | #define PWR_MODE_MASK 0xfc | ||
139 | #define PWR_MODE_FULL_ACTIVE (0x3f << 2) | ||
140 | #define PWR_MODE_IDLE (0x05 << 2) /* default sleep time is 50 ms. */ | ||
141 | #define PWR_MODE_OFF (0x00 << 2) | ||
142 | |||
143 | #define PWR_STATUS_MASK 0x0c | ||
144 | #define PWR_STATUS_ACTIVE (0x03 << 2) | ||
145 | #define PWR_STATUS_IDLE (0x02 << 2) | ||
146 | #define PWR_STATUS_OFF (0x00 << 2) | ||
147 | |||
148 | /* | ||
149 | * CYAPA trackpad device states. | ||
150 | * Used in register 0x00, bit1-0, DeviceStatus field. | ||
151 | * Other values indicate device is in an abnormal state and must be reset. | ||
152 | */ | ||
153 | #define CYAPA_DEV_NORMAL 0x03 | ||
154 | #define CYAPA_DEV_BUSY 0x01 | ||
155 | |||
156 | enum cyapa_state { | ||
157 | CYAPA_STATE_OP, | ||
158 | CYAPA_STATE_BL_IDLE, | ||
159 | CYAPA_STATE_BL_ACTIVE, | ||
160 | CYAPA_STATE_BL_BUSY, | ||
161 | CYAPA_STATE_NO_DEVICE, | ||
162 | }; | ||
163 | |||
164 | |||
165 | struct cyapa_touch { | ||
166 | /* | ||
167 | * high bits or x/y position value | ||
168 | * bit 7 - 4: high 4 bits of x position value | ||
169 | * bit 3 - 0: high 4 bits of y position value | ||
170 | */ | ||
171 | u8 xy_hi; | ||
172 | u8 x_lo; /* low 8 bits of x position value. */ | ||
173 | u8 y_lo; /* low 8 bits of y position value. */ | ||
174 | u8 pressure; | ||
175 | /* id range is 1 - 15. It is incremented with every new touch. */ | ||
176 | u8 id; | ||
177 | } __packed; | ||
178 | |||
179 | /* The touch.id is used as the MT slot id, thus max MT slot is 15 */ | ||
180 | #define CYAPA_MAX_MT_SLOTS 15 | ||
181 | |||
182 | struct cyapa_reg_data { | ||
183 | /* | ||
184 | * bit 0 - 1: device status | ||
185 | * bit 3 - 2: power mode | ||
186 | * bit 6 - 4: reserved | ||
187 | * bit 7: interrupt valid bit | ||
188 | */ | ||
189 | u8 device_status; | ||
190 | /* | ||
191 | * bit 7 - 4: number of fingers currently touching pad | ||
192 | * bit 3: valid data check bit | ||
193 | * bit 2: middle mechanism button state if exists | ||
194 | * bit 1: right mechanism button state if exists | ||
195 | * bit 0: left mechanism button state if exists | ||
196 | */ | ||
197 | u8 finger_btn; | ||
198 | /* CYAPA reports up to 5 touches per packet. */ | ||
199 | struct cyapa_touch touches[5]; | ||
200 | } __packed; | ||
201 | |||
202 | /* The main device structure */ | ||
203 | struct cyapa { | ||
204 | enum cyapa_state state; | ||
205 | |||
206 | struct i2c_client *client; | ||
207 | struct input_dev *input; | ||
208 | char phys[32]; /* device physical location */ | ||
209 | int irq; | ||
210 | bool irq_wake; /* irq wake is enabled */ | ||
211 | |||
212 | /* read from query data region. */ | ||
213 | char product_id[16]; | ||
214 | u8 btn_capability; | ||
215 | u8 gen; | ||
216 | int max_abs_x; | ||
217 | int max_abs_y; | ||
218 | int physical_size_x; | ||
219 | int physical_size_y; | ||
220 | }; | ||
221 | |||
222 | static const u8 bl_deactivate[] = { 0x00, 0xff, 0x3b, 0x00, 0x01, 0x02, 0x03, | ||
223 | 0x04, 0x05, 0x06, 0x07 }; | ||
224 | static const u8 bl_exit[] = { 0x00, 0xff, 0xa5, 0x00, 0x01, 0x02, 0x03, 0x04, | ||
225 | 0x05, 0x06, 0x07 }; | ||
226 | |||
227 | struct cyapa_cmd_len { | ||
228 | u8 cmd; | ||
229 | u8 len; | ||
230 | }; | ||
231 | |||
232 | static const struct cyapa_cmd_len cyapa_i2c_cmds[] = { | ||
233 | { CYAPA_OFFSET_SOFT_RESET, 1 }, | ||
234 | { REG_OFFSET_COMMAND_BASE + 1, 1 }, | ||
235 | { REG_OFFSET_DATA_BASE, 1 }, | ||
236 | { REG_OFFSET_DATA_BASE, sizeof(struct cyapa_reg_data) }, | ||
237 | { REG_OFFSET_COMMAND_BASE, 0 }, | ||
238 | { REG_OFFSET_QUERY_BASE, QUERY_DATA_SIZE }, | ||
239 | { BL_HEAD_OFFSET, 3 }, | ||
240 | { BL_HEAD_OFFSET, 16 }, | ||
241 | { BL_HEAD_OFFSET, 16 }, | ||
242 | { BL_DATA_OFFSET, 16 }, | ||
243 | { BL_HEAD_OFFSET, 32 }, | ||
244 | { REG_OFFSET_QUERY_BASE, PRODUCT_ID_SIZE }, | ||
245 | { REG_OFFSET_DATA_BASE, 32 } | ||
246 | }; | ||
247 | |||
248 | static ssize_t cyapa_i2c_reg_read_block(struct cyapa *cyapa, u8 reg, size_t len, | ||
249 | u8 *values) | ||
250 | { | ||
251 | return i2c_smbus_read_i2c_block_data(cyapa->client, reg, len, values); | ||
252 | } | ||
253 | |||
254 | static ssize_t cyapa_i2c_reg_write_block(struct cyapa *cyapa, u8 reg, | ||
255 | size_t len, const u8 *values) | ||
256 | { | ||
257 | return i2c_smbus_write_i2c_block_data(cyapa->client, reg, len, values); | ||
258 | } | ||
259 | |||
260 | static s32 cyapa_read_byte(struct cyapa *cyapa, u8 cmd_idx) | ||
261 | { | ||
262 | u8 cmd = cyapa_i2c_cmds[cmd_idx].cmd; | ||
263 | |||
264 | return i2c_smbus_read_byte_data(cyapa->client, cmd); | ||
265 | } | ||
266 | |||
267 | static s32 cyapa_write_byte(struct cyapa *cyapa, u8 cmd_idx, u8 value) | ||
268 | { | ||
269 | u8 cmd = cyapa_i2c_cmds[cmd_idx].cmd; | ||
270 | |||
271 | return i2c_smbus_write_byte_data(cyapa->client, cmd, value); | ||
272 | } | ||
273 | |||
274 | static ssize_t cyapa_read_block(struct cyapa *cyapa, u8 cmd_idx, u8 *values) | ||
275 | { | ||
276 | u8 cmd = cyapa_i2c_cmds[cmd_idx].cmd; | ||
277 | size_t len = cyapa_i2c_cmds[cmd_idx].len; | ||
278 | |||
279 | return cyapa_i2c_reg_read_block(cyapa, cmd, len, values); | ||
280 | } | ||
281 | |||
282 | /* | ||
283 | * Query device for its current operating state. | ||
284 | * | ||
285 | */ | ||
286 | static int cyapa_get_state(struct cyapa *cyapa) | ||
287 | { | ||
288 | int ret; | ||
289 | u8 status[BL_STATUS_SIZE]; | ||
290 | |||
291 | cyapa->state = CYAPA_STATE_NO_DEVICE; | ||
292 | |||
293 | /* | ||
294 | * Get trackpad status by reading 3 registers starting from 0. | ||
295 | * If the device is in the bootloader, this will be BL_HEAD. | ||
296 | * If the device is in operation mode, this will be the DATA regs. | ||
297 | * | ||
298 | */ | ||
299 | ret = cyapa_i2c_reg_read_block(cyapa, BL_HEAD_OFFSET, BL_STATUS_SIZE, | ||
300 | status); | ||
301 | if (ret != BL_STATUS_SIZE) | ||
302 | goto error; | ||
303 | |||
304 | if ((status[REG_OP_STATUS] & OP_STATUS_SRC) == OP_STATUS_SRC) { | ||
305 | switch (status[REG_OP_STATUS] & OP_STATUS_DEV) { | ||
306 | case CYAPA_DEV_NORMAL: | ||
307 | case CYAPA_DEV_BUSY: | ||
308 | cyapa->state = CYAPA_STATE_OP; | ||
309 | break; | ||
310 | default: | ||
311 | ret = -EAGAIN; | ||
312 | goto error; | ||
313 | } | ||
314 | } else { | ||
315 | if (status[REG_BL_STATUS] & BL_STATUS_BUSY) | ||
316 | cyapa->state = CYAPA_STATE_BL_BUSY; | ||
317 | else if (status[REG_BL_ERROR] & BL_ERROR_BOOTLOADING) | ||
318 | cyapa->state = CYAPA_STATE_BL_ACTIVE; | ||
319 | else | ||
320 | cyapa->state = CYAPA_STATE_BL_IDLE; | ||
321 | } | ||
322 | |||
323 | return 0; | ||
324 | error: | ||
325 | return (ret < 0) ? ret : -EAGAIN; | ||
326 | } | ||
327 | |||
328 | /* | ||
329 | * Poll device for its status in a loop, waiting up to timeout for a response. | ||
330 | * | ||
331 | * When the device switches state, it usually takes ~300 ms. | ||
332 | * However, when running a new firmware image, the device must calibrate its | ||
333 | * sensors, which can take as long as 2 seconds. | ||
334 | * | ||
335 | * Note: The timeout has granularity of the polling rate, which is 100 ms. | ||
336 | * | ||
337 | * Returns: | ||
338 | * 0 when the device eventually responds with a valid non-busy state. | ||
339 | * -ETIMEDOUT if device never responds (too many -EAGAIN) | ||
340 | * < 0 other errors | ||
341 | */ | ||
342 | static int cyapa_poll_state(struct cyapa *cyapa, unsigned int timeout) | ||
343 | { | ||
344 | int ret; | ||
345 | int tries = timeout / 100; | ||
346 | |||
347 | ret = cyapa_get_state(cyapa); | ||
348 | while ((ret || cyapa->state >= CYAPA_STATE_BL_BUSY) && tries--) { | ||
349 | msleep(100); | ||
350 | ret = cyapa_get_state(cyapa); | ||
351 | } | ||
352 | return (ret == -EAGAIN || ret == -ETIMEDOUT) ? -ETIMEDOUT : ret; | ||
353 | } | ||
354 | |||
355 | static int cyapa_bl_deactivate(struct cyapa *cyapa) | ||
356 | { | ||
357 | int ret; | ||
358 | |||
359 | ret = cyapa_i2c_reg_write_block(cyapa, 0, sizeof(bl_deactivate), | ||
360 | bl_deactivate); | ||
361 | if (ret < 0) | ||
362 | return ret; | ||
363 | |||
364 | /* wait for bootloader to switch to idle state; should take < 100ms */ | ||
365 | msleep(100); | ||
366 | ret = cyapa_poll_state(cyapa, 500); | ||
367 | if (ret < 0) | ||
368 | return ret; | ||
369 | if (cyapa->state != CYAPA_STATE_BL_IDLE) | ||
370 | return -EAGAIN; | ||
371 | return 0; | ||
372 | } | ||
373 | |||
374 | /* | ||
375 | * Exit bootloader | ||
376 | * | ||
377 | * Send bl_exit command, then wait 50 - 100 ms to let device transition to | ||
378 | * operational mode. If this is the first time the device's firmware is | ||
379 | * running, it can take up to 2 seconds to calibrate its sensors. So, poll | ||
380 | * the device's new state for up to 2 seconds. | ||
381 | * | ||
382 | * Returns: | ||
383 | * -EIO failure while reading from device | ||
384 | * -EAGAIN device is stuck in bootloader, b/c it has invalid firmware | ||
385 | * 0 device is supported and in operational mode | ||
386 | */ | ||
387 | static int cyapa_bl_exit(struct cyapa *cyapa) | ||
388 | { | ||
389 | int ret; | ||
390 | |||
391 | ret = cyapa_i2c_reg_write_block(cyapa, 0, sizeof(bl_exit), bl_exit); | ||
392 | if (ret < 0) | ||
393 | return ret; | ||
394 | |||
395 | /* | ||
396 | * Wait for bootloader to exit, and operation mode to start. | ||
397 | * Normally, this takes at least 50 ms. | ||
398 | */ | ||
399 | usleep_range(50000, 100000); | ||
400 | /* | ||
401 | * In addition, when a device boots for the first time after being | ||
402 | * updated to new firmware, it must first calibrate its sensors, which | ||
403 | * can take up to an additional 2 seconds. | ||
404 | */ | ||
405 | ret = cyapa_poll_state(cyapa, 2000); | ||
406 | if (ret < 0) | ||
407 | return ret; | ||
408 | if (cyapa->state != CYAPA_STATE_OP) | ||
409 | return -EAGAIN; | ||
410 | |||
411 | return 0; | ||
412 | } | ||
413 | |||
414 | /* | ||
415 | * Set device power mode | ||
416 | * | ||
417 | */ | ||
418 | static int cyapa_set_power_mode(struct cyapa *cyapa, u8 power_mode) | ||
419 | { | ||
420 | struct device *dev = &cyapa->client->dev; | ||
421 | int ret; | ||
422 | u8 power; | ||
423 | |||
424 | if (cyapa->state != CYAPA_STATE_OP) | ||
425 | return 0; | ||
426 | |||
427 | ret = cyapa_read_byte(cyapa, CYAPA_CMD_POWER_MODE); | ||
428 | if (ret < 0) | ||
429 | return ret; | ||
430 | |||
431 | power = ret & ~PWR_MODE_MASK; | ||
432 | power |= power_mode & PWR_MODE_MASK; | ||
433 | ret = cyapa_write_byte(cyapa, CYAPA_CMD_POWER_MODE, power); | ||
434 | if (ret < 0) | ||
435 | dev_err(dev, "failed to set power_mode 0x%02x err = %d\n", | ||
436 | power_mode, ret); | ||
437 | return ret; | ||
438 | } | ||
439 | |||
440 | static int cyapa_get_query_data(struct cyapa *cyapa) | ||
441 | { | ||
442 | u8 query_data[QUERY_DATA_SIZE]; | ||
443 | int ret; | ||
444 | |||
445 | if (cyapa->state != CYAPA_STATE_OP) | ||
446 | return -EBUSY; | ||
447 | |||
448 | ret = cyapa_read_block(cyapa, CYAPA_CMD_GROUP_QUERY, query_data); | ||
449 | if (ret < 0) | ||
450 | return ret; | ||
451 | if (ret != QUERY_DATA_SIZE) | ||
452 | return -EIO; | ||
453 | |||
454 | memcpy(&cyapa->product_id[0], &query_data[0], 5); | ||
455 | cyapa->product_id[5] = '-'; | ||
456 | memcpy(&cyapa->product_id[6], &query_data[5], 6); | ||
457 | cyapa->product_id[12] = '-'; | ||
458 | memcpy(&cyapa->product_id[13], &query_data[11], 2); | ||
459 | cyapa->product_id[15] = '\0'; | ||
460 | |||
461 | cyapa->btn_capability = query_data[19] & CAPABILITY_BTN_MASK; | ||
462 | |||
463 | cyapa->gen = query_data[20] & 0x0f; | ||
464 | |||
465 | cyapa->max_abs_x = ((query_data[21] & 0xf0) << 4) | query_data[22]; | ||
466 | cyapa->max_abs_y = ((query_data[21] & 0x0f) << 8) | query_data[23]; | ||
467 | |||
468 | cyapa->physical_size_x = | ||
469 | ((query_data[24] & 0xf0) << 4) | query_data[25]; | ||
470 | cyapa->physical_size_y = | ||
471 | ((query_data[24] & 0x0f) << 8) | query_data[26]; | ||
472 | |||
473 | return 0; | ||
474 | } | ||
475 | |||
476 | /* | ||
477 | * Check if device is operational. | ||
478 | * | ||
479 | * An operational device is responding, has exited bootloader, and has | ||
480 | * firmware supported by this driver. | ||
481 | * | ||
482 | * Returns: | ||
483 | * -EBUSY no device or in bootloader | ||
484 | * -EIO failure while reading from device | ||
485 | * -EAGAIN device is still in bootloader | ||
486 | * if ->state = CYAPA_STATE_BL_IDLE, device has invalid firmware | ||
487 | * -EINVAL device is in operational mode, but not supported by this driver | ||
488 | * 0 device is supported | ||
489 | */ | ||
490 | static int cyapa_check_is_operational(struct cyapa *cyapa) | ||
491 | { | ||
492 | struct device *dev = &cyapa->client->dev; | ||
493 | static const char unique_str[] = "CYTRA"; | ||
494 | int ret; | ||
495 | |||
496 | ret = cyapa_poll_state(cyapa, 2000); | ||
497 | if (ret < 0) | ||
498 | return ret; | ||
499 | switch (cyapa->state) { | ||
500 | case CYAPA_STATE_BL_ACTIVE: | ||
501 | ret = cyapa_bl_deactivate(cyapa); | ||
502 | if (ret) | ||
503 | return ret; | ||
504 | |||
505 | /* Fallthrough state */ | ||
506 | case CYAPA_STATE_BL_IDLE: | ||
507 | ret = cyapa_bl_exit(cyapa); | ||
508 | if (ret) | ||
509 | return ret; | ||
510 | |||
511 | /* Fallthrough state */ | ||
512 | case CYAPA_STATE_OP: | ||
513 | ret = cyapa_get_query_data(cyapa); | ||
514 | if (ret < 0) | ||
515 | return ret; | ||
516 | |||
517 | /* only support firmware protocol gen3 */ | ||
518 | if (cyapa->gen != CYAPA_GEN3) { | ||
519 | dev_err(dev, "unsupported protocol version (%d)", | ||
520 | cyapa->gen); | ||
521 | return -EINVAL; | ||
522 | } | ||
523 | |||
524 | /* only support product ID starting with CYTRA */ | ||
525 | if (memcmp(cyapa->product_id, unique_str, | ||
526 | sizeof(unique_str) - 1) != 0) { | ||
527 | dev_err(dev, "unsupported product ID (%s)\n", | ||
528 | cyapa->product_id); | ||
529 | return -EINVAL; | ||
530 | } | ||
531 | return 0; | ||
532 | |||
533 | default: | ||
534 | return -EIO; | ||
535 | } | ||
536 | return 0; | ||
537 | } | ||
538 | |||
539 | static irqreturn_t cyapa_irq(int irq, void *dev_id) | ||
540 | { | ||
541 | struct cyapa *cyapa = dev_id; | ||
542 | struct device *dev = &cyapa->client->dev; | ||
543 | struct input_dev *input = cyapa->input; | ||
544 | struct cyapa_reg_data data; | ||
545 | int i; | ||
546 | int ret; | ||
547 | int num_fingers; | ||
548 | |||
549 | if (device_may_wakeup(dev)) | ||
550 | pm_wakeup_event(dev, 0); | ||
551 | |||
552 | ret = cyapa_read_block(cyapa, CYAPA_CMD_GROUP_DATA, (u8 *)&data); | ||
553 | if (ret != sizeof(data)) | ||
554 | goto out; | ||
555 | |||
556 | if ((data.device_status & OP_STATUS_SRC) != OP_STATUS_SRC || | ||
557 | (data.device_status & OP_STATUS_DEV) != CYAPA_DEV_NORMAL || | ||
558 | (data.finger_btn & OP_DATA_VALID) != OP_DATA_VALID) { | ||
559 | goto out; | ||
560 | } | ||
561 | |||
562 | num_fingers = (data.finger_btn >> 4) & 0x0f; | ||
563 | for (i = 0; i < num_fingers; i++) { | ||
564 | const struct cyapa_touch *touch = &data.touches[i]; | ||
565 | /* Note: touch->id range is 1 to 15; slots are 0 to 14. */ | ||
566 | int slot = touch->id - 1; | ||
567 | |||
568 | input_mt_slot(input, slot); | ||
569 | input_mt_report_slot_state(input, MT_TOOL_FINGER, true); | ||
570 | input_report_abs(input, ABS_MT_POSITION_X, | ||
571 | ((touch->xy_hi & 0xf0) << 4) | touch->x_lo); | ||
572 | input_report_abs(input, ABS_MT_POSITION_Y, | ||
573 | ((touch->xy_hi & 0x0f) << 8) | touch->y_lo); | ||
574 | input_report_abs(input, ABS_MT_PRESSURE, touch->pressure); | ||
575 | } | ||
576 | |||
577 | input_mt_sync_frame(input); | ||
578 | |||
579 | if (cyapa->btn_capability & CAPABILITY_LEFT_BTN_MASK) | ||
580 | input_report_key(input, BTN_LEFT, | ||
581 | data.finger_btn & OP_DATA_LEFT_BTN); | ||
582 | |||
583 | if (cyapa->btn_capability & CAPABILITY_MIDDLE_BTN_MASK) | ||
584 | input_report_key(input, BTN_MIDDLE, | ||
585 | data.finger_btn & OP_DATA_MIDDLE_BTN); | ||
586 | |||
587 | if (cyapa->btn_capability & CAPABILITY_RIGHT_BTN_MASK) | ||
588 | input_report_key(input, BTN_RIGHT, | ||
589 | data.finger_btn & OP_DATA_RIGHT_BTN); | ||
590 | |||
591 | input_sync(input); | ||
592 | |||
593 | out: | ||
594 | return IRQ_HANDLED; | ||
595 | } | ||
596 | |||
597 | static int cyapa_create_input_dev(struct cyapa *cyapa) | ||
598 | { | ||
599 | struct device *dev = &cyapa->client->dev; | ||
600 | int ret; | ||
601 | struct input_dev *input; | ||
602 | |||
603 | if (!cyapa->physical_size_x || !cyapa->physical_size_y) | ||
604 | return -EINVAL; | ||
605 | |||
606 | input = cyapa->input = input_allocate_device(); | ||
607 | if (!input) { | ||
608 | dev_err(dev, "allocate memory for input device failed\n"); | ||
609 | return -ENOMEM; | ||
610 | } | ||
611 | |||
612 | input->name = CYAPA_NAME; | ||
613 | input->phys = cyapa->phys; | ||
614 | input->id.bustype = BUS_I2C; | ||
615 | input->id.version = 1; | ||
616 | input->id.product = 0; /* means any product in eventcomm. */ | ||
617 | input->dev.parent = &cyapa->client->dev; | ||
618 | |||
619 | input_set_drvdata(input, cyapa); | ||
620 | |||
621 | __set_bit(EV_ABS, input->evbit); | ||
622 | |||
623 | /* finger position */ | ||
624 | input_set_abs_params(input, ABS_MT_POSITION_X, 0, cyapa->max_abs_x, 0, | ||
625 | 0); | ||
626 | input_set_abs_params(input, ABS_MT_POSITION_Y, 0, cyapa->max_abs_y, 0, | ||
627 | 0); | ||
628 | input_set_abs_params(input, ABS_MT_PRESSURE, 0, 255, 0, 0); | ||
629 | |||
630 | input_abs_set_res(input, ABS_MT_POSITION_X, | ||
631 | cyapa->max_abs_x / cyapa->physical_size_x); | ||
632 | input_abs_set_res(input, ABS_MT_POSITION_Y, | ||
633 | cyapa->max_abs_y / cyapa->physical_size_y); | ||
634 | |||
635 | if (cyapa->btn_capability & CAPABILITY_LEFT_BTN_MASK) | ||
636 | __set_bit(BTN_LEFT, input->keybit); | ||
637 | if (cyapa->btn_capability & CAPABILITY_MIDDLE_BTN_MASK) | ||
638 | __set_bit(BTN_MIDDLE, input->keybit); | ||
639 | if (cyapa->btn_capability & CAPABILITY_RIGHT_BTN_MASK) | ||
640 | __set_bit(BTN_RIGHT, input->keybit); | ||
641 | |||
642 | if (cyapa->btn_capability == CAPABILITY_LEFT_BTN_MASK) | ||
643 | __set_bit(INPUT_PROP_BUTTONPAD, input->propbit); | ||
644 | |||
645 | /* handle pointer emulation and unused slots in core */ | ||
646 | ret = input_mt_init_slots(input, CYAPA_MAX_MT_SLOTS, | ||
647 | INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED); | ||
648 | if (ret) { | ||
649 | dev_err(dev, "allocate memory for MT slots failed, %d\n", ret); | ||
650 | goto err_free_device; | ||
651 | } | ||
652 | |||
653 | /* Register the device in input subsystem */ | ||
654 | ret = input_register_device(input); | ||
655 | if (ret) { | ||
656 | dev_err(dev, "input device register failed, %d\n", ret); | ||
657 | goto err_free_device; | ||
658 | } | ||
659 | return 0; | ||
660 | |||
661 | err_free_device: | ||
662 | input_free_device(input); | ||
663 | cyapa->input = NULL; | ||
664 | return ret; | ||
665 | } | ||
666 | |||
667 | static int cyapa_probe(struct i2c_client *client, | ||
668 | const struct i2c_device_id *dev_id) | ||
669 | { | ||
670 | int ret; | ||
671 | struct cyapa *cyapa; | ||
672 | struct device *dev = &client->dev; | ||
673 | |||
674 | cyapa = kzalloc(sizeof(struct cyapa), GFP_KERNEL); | ||
675 | if (!cyapa) { | ||
676 | dev_err(dev, "allocate memory for cyapa failed\n"); | ||
677 | return -ENOMEM; | ||
678 | } | ||
679 | |||
680 | cyapa->gen = CYAPA_GEN3; | ||
681 | cyapa->client = client; | ||
682 | i2c_set_clientdata(client, cyapa); | ||
683 | sprintf(cyapa->phys, "i2c-%d-%04x/input0", client->adapter->nr, | ||
684 | client->addr); | ||
685 | |||
686 | cyapa->state = CYAPA_STATE_NO_DEVICE; | ||
687 | ret = cyapa_check_is_operational(cyapa); | ||
688 | if (ret) { | ||
689 | dev_err(dev, "device not operational, %d\n", ret); | ||
690 | goto err_mem_free; | ||
691 | } | ||
692 | |||
693 | ret = cyapa_create_input_dev(cyapa); | ||
694 | if (ret) { | ||
695 | dev_err(dev, "create input_dev instance failed, %d\n", ret); | ||
696 | goto err_mem_free; | ||
697 | } | ||
698 | |||
699 | ret = cyapa_set_power_mode(cyapa, PWR_MODE_FULL_ACTIVE); | ||
700 | if (ret) { | ||
701 | dev_err(dev, "set active power failed, %d\n", ret); | ||
702 | goto err_unregister_device; | ||
703 | } | ||
704 | |||
705 | cyapa->irq = client->irq; | ||
706 | ret = request_threaded_irq(cyapa->irq, | ||
707 | NULL, | ||
708 | cyapa_irq, | ||
709 | IRQF_TRIGGER_FALLING | IRQF_ONESHOT, | ||
710 | "cyapa", | ||
711 | cyapa); | ||
712 | if (ret) { | ||
713 | dev_err(dev, "IRQ request failed: %d\n, ", ret); | ||
714 | goto err_unregister_device; | ||
715 | } | ||
716 | |||
717 | return 0; | ||
718 | |||
719 | err_unregister_device: | ||
720 | input_unregister_device(cyapa->input); | ||
721 | err_mem_free: | ||
722 | kfree(cyapa); | ||
723 | |||
724 | return ret; | ||
725 | } | ||
726 | |||
727 | static int cyapa_remove(struct i2c_client *client) | ||
728 | { | ||
729 | struct cyapa *cyapa = i2c_get_clientdata(client); | ||
730 | |||
731 | free_irq(cyapa->irq, cyapa); | ||
732 | input_unregister_device(cyapa->input); | ||
733 | cyapa_set_power_mode(cyapa, PWR_MODE_OFF); | ||
734 | kfree(cyapa); | ||
735 | |||
736 | return 0; | ||
737 | } | ||
738 | |||
739 | #ifdef CONFIG_PM_SLEEP | ||
740 | static int cyapa_suspend(struct device *dev) | ||
741 | { | ||
742 | int ret; | ||
743 | u8 power_mode; | ||
744 | struct cyapa *cyapa = dev_get_drvdata(dev); | ||
745 | |||
746 | disable_irq(cyapa->irq); | ||
747 | |||
748 | /* | ||
749 | * Set trackpad device to idle mode if wakeup is allowed, | ||
750 | * otherwise turn off. | ||
751 | */ | ||
752 | power_mode = device_may_wakeup(dev) ? PWR_MODE_IDLE | ||
753 | : PWR_MODE_OFF; | ||
754 | ret = cyapa_set_power_mode(cyapa, power_mode); | ||
755 | if (ret < 0) | ||
756 | dev_err(dev, "set power mode failed, %d\n", ret); | ||
757 | |||
758 | if (device_may_wakeup(dev)) | ||
759 | cyapa->irq_wake = (enable_irq_wake(cyapa->irq) == 0); | ||
760 | return 0; | ||
761 | } | ||
762 | |||
763 | static int cyapa_resume(struct device *dev) | ||
764 | { | ||
765 | int ret; | ||
766 | struct cyapa *cyapa = dev_get_drvdata(dev); | ||
767 | |||
768 | if (device_may_wakeup(dev) && cyapa->irq_wake) | ||
769 | disable_irq_wake(cyapa->irq); | ||
770 | |||
771 | ret = cyapa_set_power_mode(cyapa, PWR_MODE_FULL_ACTIVE); | ||
772 | if (ret) | ||
773 | dev_warn(dev, "resume active power failed, %d\n", ret); | ||
774 | |||
775 | enable_irq(cyapa->irq); | ||
776 | return 0; | ||
777 | } | ||
778 | #endif /* CONFIG_PM_SLEEP */ | ||
779 | |||
780 | static SIMPLE_DEV_PM_OPS(cyapa_pm_ops, cyapa_suspend, cyapa_resume); | ||
781 | |||
782 | static const struct i2c_device_id cyapa_id_table[] = { | ||
783 | { "cyapa", 0 }, | ||
784 | { }, | ||
785 | }; | ||
786 | MODULE_DEVICE_TABLE(i2c, cyapa_id_table); | ||
787 | |||
788 | static struct i2c_driver cyapa_driver = { | ||
789 | .driver = { | ||
790 | .name = "cyapa", | ||
791 | .owner = THIS_MODULE, | ||
792 | .pm = &cyapa_pm_ops, | ||
793 | }, | ||
794 | |||
795 | .probe = cyapa_probe, | ||
796 | .remove = cyapa_remove, | ||
797 | .id_table = cyapa_id_table, | ||
798 | }; | ||
799 | |||
800 | module_i2c_driver(cyapa_driver); | ||
801 | |||
802 | MODULE_DESCRIPTION("Cypress APA I2C Trackpad Driver"); | ||
803 | MODULE_AUTHOR("Dudley Du <dudl@cypress.com>"); | ||
804 | MODULE_LICENSE("GPL"); | ||