Commit | Line | Data |
---|---|---|
d7e34d12 BL |
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 | * | |
94897619 | 9 | * Copyright (C) 2011-2015 Cypress Semiconductor, Inc. |
d7e34d12 BL |
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> | |
9f1cd857 | 23 | #include <linux/mutex.h> |
36e9615b | 24 | #include <linux/regulator/consumer.h> |
d7e34d12 | 25 | #include <linux/slab.h> |
9f1cd857 | 26 | #include <linux/uaccess.h> |
67286508 | 27 | #include <linux/pm_runtime.h> |
7b2171d7 | 28 | #include <linux/acpi.h> |
ddbb299d | 29 | #include <linux/of.h> |
9f1cd857 | 30 | #include "cyapa.h" |
d7e34d12 | 31 | |
d7e34d12 | 32 | |
6ddaf744 BL |
33 | #define CYAPA_ADAPTER_FUNC_NONE 0 |
34 | #define CYAPA_ADAPTER_FUNC_I2C 1 | |
35 | #define CYAPA_ADAPTER_FUNC_SMBUS 2 | |
36 | #define CYAPA_ADAPTER_FUNC_BOTH 3 | |
37 | ||
c806b0b8 DD |
38 | #define CYAPA_FW_NAME "cyapa.bin" |
39 | ||
9f1cd857 | 40 | const char product_id[] = "CYTRA"; |
d7e34d12 | 41 | |
9f1cd857 | 42 | static int cyapa_reinitialize(struct cyapa *cyapa); |
6ddaf744 | 43 | |
94897619 | 44 | bool cyapa_is_pip_bl_mode(struct cyapa *cyapa) |
d7e34d12 | 45 | { |
c2c06c41 DD |
46 | if (cyapa->gen == CYAPA_GEN6 && cyapa->state == CYAPA_STATE_GEN6_BL) |
47 | return true; | |
48 | ||
9f1cd857 DD |
49 | if (cyapa->gen == CYAPA_GEN5 && cyapa->state == CYAPA_STATE_GEN5_BL) |
50 | return true; | |
51 | ||
94897619 DD |
52 | return false; |
53 | } | |
54 | ||
55 | bool cyapa_is_pip_app_mode(struct cyapa *cyapa) | |
56 | { | |
c2c06c41 DD |
57 | if (cyapa->gen == CYAPA_GEN6 && cyapa->state == CYAPA_STATE_GEN6_APP) |
58 | return true; | |
59 | ||
94897619 DD |
60 | if (cyapa->gen == CYAPA_GEN5 && cyapa->state == CYAPA_STATE_GEN5_APP) |
61 | return true; | |
62 | ||
63 | return false; | |
64 | } | |
65 | ||
66 | static bool cyapa_is_bootloader_mode(struct cyapa *cyapa) | |
67 | { | |
68 | if (cyapa_is_pip_bl_mode(cyapa)) | |
69 | return true; | |
70 | ||
9f1cd857 DD |
71 | if (cyapa->gen == CYAPA_GEN3 && |
72 | cyapa->state >= CYAPA_STATE_BL_BUSY && | |
73 | cyapa->state <= CYAPA_STATE_BL_ACTIVE) | |
74 | return true; | |
75 | ||
76 | return false; | |
d7e34d12 BL |
77 | } |
78 | ||
9f1cd857 | 79 | static inline bool cyapa_is_operational_mode(struct cyapa *cyapa) |
d7e34d12 | 80 | { |
94897619 | 81 | if (cyapa_is_pip_app_mode(cyapa)) |
9f1cd857 DD |
82 | return true; |
83 | ||
84 | if (cyapa->gen == CYAPA_GEN3 && cyapa->state == CYAPA_STATE_OP) | |
85 | return true; | |
86 | ||
87 | return false; | |
d7e34d12 BL |
88 | } |
89 | ||
9f1cd857 DD |
90 | /* Returns 0 on success, else negative errno on failure. */ |
91 | static ssize_t cyapa_i2c_read(struct cyapa *cyapa, u8 reg, size_t len, | |
92 | u8 *values) | |
6ddaf744 | 93 | { |
6ddaf744 | 94 | struct i2c_client *client = cyapa->client; |
9f1cd857 DD |
95 | struct i2c_msg msgs[] = { |
96 | { | |
97 | .addr = client->addr, | |
98 | .flags = 0, | |
99 | .len = 1, | |
100 | .buf = ®, | |
101 | }, | |
102 | { | |
103 | .addr = client->addr, | |
104 | .flags = I2C_M_RD, | |
105 | .len = len, | |
106 | .buf = values, | |
107 | }, | |
108 | }; | |
109 | int ret; | |
6ddaf744 | 110 | |
9f1cd857 | 111 | ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs)); |
6ddaf744 | 112 | |
9f1cd857 DD |
113 | if (ret != ARRAY_SIZE(msgs)) |
114 | return ret < 0 ? ret : -EIO; | |
6ddaf744 | 115 | |
9f1cd857 | 116 | return 0; |
6ddaf744 BL |
117 | } |
118 | ||
9f1cd857 DD |
119 | /** |
120 | * cyapa_i2c_write - Execute i2c block data write operation | |
121 | * @cyapa: Handle to this driver | |
122 | * @ret: Offset of the data to written in the register map | |
123 | * @len: number of bytes to write | |
124 | * @values: Data to be written | |
125 | * | |
126 | * Return negative errno code on error; return zero when success. | |
127 | */ | |
128 | static int cyapa_i2c_write(struct cyapa *cyapa, u8 reg, | |
129 | size_t len, const void *values) | |
d7e34d12 | 130 | { |
9f1cd857 DD |
131 | struct i2c_client *client = cyapa->client; |
132 | char buf[32]; | |
133 | int ret; | |
d7e34d12 | 134 | |
9f1cd857 DD |
135 | if (len > sizeof(buf) - 1) |
136 | return -ENOMEM; | |
d7e34d12 | 137 | |
9f1cd857 DD |
138 | buf[0] = reg; |
139 | memcpy(&buf[1], values, len); | |
d7e34d12 | 140 | |
9f1cd857 DD |
141 | ret = i2c_master_send(client, buf, len + 1); |
142 | if (ret != len + 1) | |
143 | return ret < 0 ? ret : -EIO; | |
144 | ||
145 | return 0; | |
d7e34d12 BL |
146 | } |
147 | ||
9f1cd857 | 148 | static u8 cyapa_check_adapter_functionality(struct i2c_client *client) |
d7e34d12 | 149 | { |
9f1cd857 | 150 | u8 ret = CYAPA_ADAPTER_FUNC_NONE; |
d7e34d12 | 151 | |
9f1cd857 DD |
152 | if (i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) |
153 | ret |= CYAPA_ADAPTER_FUNC_I2C; | |
154 | if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA | | |
155 | I2C_FUNC_SMBUS_BLOCK_DATA | | |
156 | I2C_FUNC_SMBUS_I2C_BLOCK)) | |
157 | ret |= CYAPA_ADAPTER_FUNC_SMBUS; | |
158 | return ret; | |
d7e34d12 BL |
159 | } |
160 | ||
161 | /* | |
162 | * Query device for its current operating state. | |
d7e34d12 BL |
163 | */ |
164 | static int cyapa_get_state(struct cyapa *cyapa) | |
165 | { | |
d7e34d12 | 166 | u8 status[BL_STATUS_SIZE]; |
9f1cd857 DD |
167 | u8 cmd[32]; |
168 | /* The i2c address of gen4 and gen5 trackpad device must be even. */ | |
169 | bool even_addr = ((cyapa->client->addr & 0x0001) == 0); | |
170 | bool smbus = false; | |
171 | int retries = 2; | |
823a11fd | 172 | int error; |
d7e34d12 BL |
173 | |
174 | cyapa->state = CYAPA_STATE_NO_DEVICE; | |
175 | ||
176 | /* | |
177 | * Get trackpad status by reading 3 registers starting from 0. | |
178 | * If the device is in the bootloader, this will be BL_HEAD. | |
179 | * If the device is in operation mode, this will be the DATA regs. | |
180 | * | |
181 | */ | |
823a11fd | 182 | error = cyapa_i2c_reg_read_block(cyapa, BL_HEAD_OFFSET, BL_STATUS_SIZE, |
9f1cd857 | 183 | status); |
6ddaf744 BL |
184 | |
185 | /* | |
186 | * On smbus systems in OP mode, the i2c_reg_read will fail with | |
187 | * -ETIMEDOUT. In this case, try again using the smbus equivalent | |
188 | * command. This should return a BL_HEAD indicating CYAPA_STATE_OP. | |
189 | */ | |
9f1cd857 DD |
190 | if (cyapa->smbus && (error == -ETIMEDOUT || error == -ENXIO)) { |
191 | if (!even_addr) | |
192 | error = cyapa_read_block(cyapa, | |
193 | CYAPA_CMD_BL_STATUS, status); | |
194 | smbus = true; | |
195 | } | |
6ddaf744 | 196 | |
823a11fd | 197 | if (error != BL_STATUS_SIZE) |
d7e34d12 BL |
198 | goto error; |
199 | ||
9f1cd857 DD |
200 | /* |
201 | * Detect trackpad protocol based on characteristic registers and bits. | |
202 | */ | |
203 | do { | |
204 | cyapa->status[REG_OP_STATUS] = status[REG_OP_STATUS]; | |
205 | cyapa->status[REG_BL_STATUS] = status[REG_BL_STATUS]; | |
206 | cyapa->status[REG_BL_ERROR] = status[REG_BL_ERROR]; | |
207 | ||
208 | if (cyapa->gen == CYAPA_GEN_UNKNOWN || | |
209 | cyapa->gen == CYAPA_GEN3) { | |
210 | error = cyapa_gen3_ops.state_parse(cyapa, | |
211 | status, BL_STATUS_SIZE); | |
212 | if (!error) | |
213 | goto out_detected; | |
d7e34d12 | 214 | } |
c2c06c41 DD |
215 | if (cyapa->gen == CYAPA_GEN_UNKNOWN || |
216 | cyapa->gen == CYAPA_GEN6 || | |
217 | cyapa->gen == CYAPA_GEN5) { | |
218 | error = cyapa_pip_state_parse(cyapa, | |
219 | status, BL_STATUS_SIZE); | |
220 | if (!error) | |
221 | goto out_detected; | |
222 | } | |
223 | /* For old Gen5 trackpads detecting. */ | |
6972a859 DD |
224 | if ((cyapa->gen == CYAPA_GEN_UNKNOWN || |
225 | cyapa->gen == CYAPA_GEN5) && | |
226 | !smbus && even_addr) { | |
227 | error = cyapa_gen5_ops.state_parse(cyapa, | |
228 | status, BL_STATUS_SIZE); | |
229 | if (!error) | |
230 | goto out_detected; | |
231 | } | |
d7e34d12 | 232 | |
9f1cd857 DD |
233 | /* |
234 | * Write 0x00 0x00 to trackpad device to force update its | |
235 | * status, then redo the detection again. | |
236 | */ | |
237 | if (!smbus) { | |
238 | cmd[0] = 0x00; | |
239 | cmd[1] = 0x00; | |
240 | error = cyapa_i2c_write(cyapa, 0, 2, cmd); | |
241 | if (error) | |
242 | goto error; | |
243 | ||
244 | msleep(50); | |
245 | ||
246 | error = cyapa_i2c_read(cyapa, BL_HEAD_OFFSET, | |
247 | BL_STATUS_SIZE, status); | |
248 | if (error) | |
249 | goto error; | |
250 | } | |
251 | } while (--retries > 0 && !smbus); | |
252 | ||
253 | goto error; | |
254 | ||
255 | out_detected: | |
256 | if (cyapa->state <= CYAPA_STATE_BL_BUSY) | |
257 | return -EAGAIN; | |
d7e34d12 | 258 | return 0; |
9f1cd857 | 259 | |
d7e34d12 | 260 | error: |
823a11fd | 261 | return (error < 0) ? error : -EAGAIN; |
d7e34d12 BL |
262 | } |
263 | ||
264 | /* | |
265 | * Poll device for its status in a loop, waiting up to timeout for a response. | |
266 | * | |
267 | * When the device switches state, it usually takes ~300 ms. | |
268 | * However, when running a new firmware image, the device must calibrate its | |
269 | * sensors, which can take as long as 2 seconds. | |
270 | * | |
271 | * Note: The timeout has granularity of the polling rate, which is 100 ms. | |
272 | * | |
273 | * Returns: | |
274 | * 0 when the device eventually responds with a valid non-busy state. | |
275 | * -ETIMEDOUT if device never responds (too many -EAGAIN) | |
9f1cd857 DD |
276 | * -EAGAIN if bootload is busy, or unknown state. |
277 | * < 0 other errors | |
d7e34d12 | 278 | */ |
9f1cd857 | 279 | int cyapa_poll_state(struct cyapa *cyapa, unsigned int timeout) |
d7e34d12 | 280 | { |
823a11fd | 281 | int error; |
d7e34d12 BL |
282 | int tries = timeout / 100; |
283 | ||
9f1cd857 | 284 | do { |
823a11fd | 285 | error = cyapa_get_state(cyapa); |
9f1cd857 DD |
286 | if (!error && cyapa->state > CYAPA_STATE_BL_BUSY) |
287 | return 0; | |
d7e34d12 | 288 | |
9f1cd857 DD |
289 | msleep(100); |
290 | } while (tries--); | |
d7e34d12 | 291 | |
9f1cd857 | 292 | return (error == -EAGAIN || error == -ETIMEDOUT) ? -ETIMEDOUT : error; |
d7e34d12 BL |
293 | } |
294 | ||
295 | /* | |
296 | * Check if device is operational. | |
297 | * | |
298 | * An operational device is responding, has exited bootloader, and has | |
299 | * firmware supported by this driver. | |
300 | * | |
301 | * Returns: | |
9f1cd857 | 302 | * -ENODEV no device |
d7e34d12 BL |
303 | * -EBUSY no device or in bootloader |
304 | * -EIO failure while reading from device | |
9f1cd857 | 305 | * -ETIMEDOUT timeout failure for bus idle or bus no response |
d7e34d12 BL |
306 | * -EAGAIN device is still in bootloader |
307 | * if ->state = CYAPA_STATE_BL_IDLE, device has invalid firmware | |
308 | * -EINVAL device is in operational mode, but not supported by this driver | |
309 | * 0 device is supported | |
310 | */ | |
311 | static int cyapa_check_is_operational(struct cyapa *cyapa) | |
312 | { | |
823a11fd | 313 | int error; |
d7e34d12 | 314 | |
9f1cd857 | 315 | error = cyapa_poll_state(cyapa, 4000); |
823a11fd DD |
316 | if (error) |
317 | return error; | |
d7e34d12 | 318 | |
9f1cd857 | 319 | switch (cyapa->gen) { |
c2c06c41 DD |
320 | case CYAPA_GEN6: |
321 | cyapa->ops = &cyapa_gen6_ops; | |
322 | break; | |
6972a859 DD |
323 | case CYAPA_GEN5: |
324 | cyapa->ops = &cyapa_gen5_ops; | |
325 | break; | |
9f1cd857 DD |
326 | case CYAPA_GEN3: |
327 | cyapa->ops = &cyapa_gen3_ops; | |
328 | break; | |
d7e34d12 | 329 | default: |
9f1cd857 | 330 | return -ENODEV; |
d7e34d12 | 331 | } |
9f1cd857 DD |
332 | |
333 | error = cyapa->ops->operational_check(cyapa); | |
334 | if (!error && cyapa_is_operational_mode(cyapa)) | |
335 | cyapa->operational = true; | |
336 | else | |
337 | cyapa->operational = false; | |
338 | ||
339 | return error; | |
d7e34d12 BL |
340 | } |
341 | ||
9f1cd857 DD |
342 | |
343 | /* | |
344 | * Returns 0 on device detected, negative errno on no device detected. | |
94897619 | 345 | * And when the device is detected and operational, it will be reset to |
9f1cd857 DD |
346 | * full power active mode automatically. |
347 | */ | |
348 | static int cyapa_detect(struct cyapa *cyapa) | |
d7e34d12 | 349 | { |
d7e34d12 | 350 | struct device *dev = &cyapa->client->dev; |
9f1cd857 | 351 | int error; |
d7e34d12 | 352 | |
9f1cd857 DD |
353 | error = cyapa_check_is_operational(cyapa); |
354 | if (error) { | |
355 | if (error != -ETIMEDOUT && error != -ENODEV && | |
356 | cyapa_is_bootloader_mode(cyapa)) { | |
357 | dev_warn(dev, "device detected but not operational\n"); | |
358 | return 0; | |
359 | } | |
d7e34d12 | 360 | |
9f1cd857 DD |
361 | dev_err(dev, "no device detected: %d\n", error); |
362 | return error; | |
d7e34d12 BL |
363 | } |
364 | ||
9f1cd857 | 365 | return 0; |
6ddaf744 BL |
366 | } |
367 | ||
b1cfa7b4 DD |
368 | static int cyapa_open(struct input_dev *input) |
369 | { | |
370 | struct cyapa *cyapa = input_get_drvdata(input); | |
371 | struct i2c_client *client = cyapa->client; | |
757cae5a | 372 | struct device *dev = &client->dev; |
b1cfa7b4 DD |
373 | int error; |
374 | ||
9f1cd857 DD |
375 | error = mutex_lock_interruptible(&cyapa->state_sync_lock); |
376 | if (error) | |
b1cfa7b4 | 377 | return error; |
9f1cd857 DD |
378 | |
379 | if (cyapa->operational) { | |
380 | /* | |
381 | * though failed to set active power mode, | |
382 | * but still may be able to work in lower scan rate | |
383 | * when in operational mode. | |
384 | */ | |
385 | error = cyapa->ops->set_power_mode(cyapa, | |
3cd47869 | 386 | PWR_MODE_FULL_ACTIVE, 0, CYAPA_PM_ACTIVE); |
9f1cd857 | 387 | if (error) { |
757cae5a | 388 | dev_warn(dev, "set active power failed: %d\n", error); |
9f1cd857 DD |
389 | goto out; |
390 | } | |
391 | } else { | |
392 | error = cyapa_reinitialize(cyapa); | |
393 | if (error || !cyapa->operational) { | |
394 | error = error ? error : -EAGAIN; | |
395 | goto out; | |
396 | } | |
b1cfa7b4 DD |
397 | } |
398 | ||
399 | enable_irq(client->irq); | |
757cae5a DD |
400 | if (!pm_runtime_enabled(dev)) { |
401 | pm_runtime_set_active(dev); | |
402 | pm_runtime_enable(dev); | |
67286508 | 403 | } |
757cae5a DD |
404 | |
405 | pm_runtime_get_sync(dev); | |
406 | pm_runtime_mark_last_busy(dev); | |
407 | pm_runtime_put_sync_autosuspend(dev); | |
9f1cd857 DD |
408 | out: |
409 | mutex_unlock(&cyapa->state_sync_lock); | |
410 | return error; | |
b1cfa7b4 DD |
411 | } |
412 | ||
413 | static void cyapa_close(struct input_dev *input) | |
414 | { | |
415 | struct cyapa *cyapa = input_get_drvdata(input); | |
9f1cd857 | 416 | struct i2c_client *client = cyapa->client; |
757cae5a | 417 | struct device *dev = &cyapa->client->dev; |
9f1cd857 DD |
418 | |
419 | mutex_lock(&cyapa->state_sync_lock); | |
b1cfa7b4 | 420 | |
9f1cd857 | 421 | disable_irq(client->irq); |
757cae5a DD |
422 | if (pm_runtime_enabled(dev)) |
423 | pm_runtime_disable(dev); | |
424 | pm_runtime_set_suspended(dev); | |
67286508 | 425 | |
9f1cd857 | 426 | if (cyapa->operational) |
3cd47869 DD |
427 | cyapa->ops->set_power_mode(cyapa, |
428 | PWR_MODE_OFF, 0, CYAPA_PM_DEACTIVE); | |
9f1cd857 DD |
429 | |
430 | mutex_unlock(&cyapa->state_sync_lock); | |
b1cfa7b4 DD |
431 | } |
432 | ||
d7e34d12 BL |
433 | static int cyapa_create_input_dev(struct cyapa *cyapa) |
434 | { | |
435 | struct device *dev = &cyapa->client->dev; | |
d7e34d12 | 436 | struct input_dev *input; |
b1cfa7b4 | 437 | int error; |
d7e34d12 BL |
438 | |
439 | if (!cyapa->physical_size_x || !cyapa->physical_size_y) | |
440 | return -EINVAL; | |
441 | ||
b1cfa7b4 | 442 | input = devm_input_allocate_device(dev); |
d7e34d12 | 443 | if (!input) { |
823a11fd | 444 | dev_err(dev, "failed to allocate memory for input device.\n"); |
d7e34d12 BL |
445 | return -ENOMEM; |
446 | } | |
447 | ||
448 | input->name = CYAPA_NAME; | |
449 | input->phys = cyapa->phys; | |
450 | input->id.bustype = BUS_I2C; | |
451 | input->id.version = 1; | |
823a11fd | 452 | input->id.product = 0; /* Means any product in eventcomm. */ |
d7e34d12 BL |
453 | input->dev.parent = &cyapa->client->dev; |
454 | ||
b1cfa7b4 DD |
455 | input->open = cyapa_open; |
456 | input->close = cyapa_close; | |
457 | ||
d7e34d12 BL |
458 | input_set_drvdata(input, cyapa); |
459 | ||
460 | __set_bit(EV_ABS, input->evbit); | |
461 | ||
823a11fd | 462 | /* Finger position */ |
d7e34d12 BL |
463 | input_set_abs_params(input, ABS_MT_POSITION_X, 0, cyapa->max_abs_x, 0, |
464 | 0); | |
465 | input_set_abs_params(input, ABS_MT_POSITION_Y, 0, cyapa->max_abs_y, 0, | |
466 | 0); | |
9f1cd857 DD |
467 | input_set_abs_params(input, ABS_MT_PRESSURE, 0, cyapa->max_z, 0, 0); |
468 | if (cyapa->gen > CYAPA_GEN3) { | |
469 | input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0); | |
470 | input_set_abs_params(input, ABS_MT_TOUCH_MINOR, 0, 255, 0, 0); | |
471 | /* | |
472 | * Orientation is the angle between the vertical axis and | |
473 | * the major axis of the contact ellipse. | |
474 | * The range is -127 to 127. | |
475 | * the positive direction is clockwise form the vertical axis. | |
476 | * If the ellipse of contact degenerates into a circle, | |
477 | * orientation is reported as 0. | |
478 | * | |
479 | * Also, for Gen5 trackpad the accurate of this orientation | |
480 | * value is value + (-30 ~ 30). | |
481 | */ | |
482 | input_set_abs_params(input, ABS_MT_ORIENTATION, | |
483 | -127, 127, 0, 0); | |
484 | } | |
485 | if (cyapa->gen >= CYAPA_GEN5) { | |
486 | input_set_abs_params(input, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0); | |
487 | input_set_abs_params(input, ABS_MT_WIDTH_MINOR, 0, 255, 0, 0); | |
945525ee | 488 | input_set_abs_params(input, ABS_DISTANCE, 0, 1, 0, 0); |
9f1cd857 | 489 | } |
d7e34d12 BL |
490 | |
491 | input_abs_set_res(input, ABS_MT_POSITION_X, | |
492 | cyapa->max_abs_x / cyapa->physical_size_x); | |
493 | input_abs_set_res(input, ABS_MT_POSITION_Y, | |
494 | cyapa->max_abs_y / cyapa->physical_size_y); | |
495 | ||
496 | if (cyapa->btn_capability & CAPABILITY_LEFT_BTN_MASK) | |
497 | __set_bit(BTN_LEFT, input->keybit); | |
498 | if (cyapa->btn_capability & CAPABILITY_MIDDLE_BTN_MASK) | |
499 | __set_bit(BTN_MIDDLE, input->keybit); | |
500 | if (cyapa->btn_capability & CAPABILITY_RIGHT_BTN_MASK) | |
501 | __set_bit(BTN_RIGHT, input->keybit); | |
502 | ||
503 | if (cyapa->btn_capability == CAPABILITY_LEFT_BTN_MASK) | |
504 | __set_bit(INPUT_PROP_BUTTONPAD, input->propbit); | |
505 | ||
823a11fd | 506 | /* Handle pointer emulation and unused slots in core */ |
b1cfa7b4 DD |
507 | error = input_mt_init_slots(input, CYAPA_MAX_MT_SLOTS, |
508 | INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED); | |
509 | if (error) { | |
510 | dev_err(dev, "failed to initialize MT slots: %d\n", error); | |
511 | return error; | |
d7e34d12 BL |
512 | } |
513 | ||
9f1cd857 DD |
514 | /* Register the device in input subsystem */ |
515 | error = input_register_device(input); | |
516 | if (error) { | |
517 | dev_err(dev, "failed to register input device: %d\n", error); | |
518 | return error; | |
519 | } | |
520 | ||
b1cfa7b4 | 521 | cyapa->input = input; |
d7e34d12 | 522 | return 0; |
d7e34d12 BL |
523 | } |
524 | ||
c806b0b8 DD |
525 | static void cyapa_enable_irq_for_cmd(struct cyapa *cyapa) |
526 | { | |
527 | struct input_dev *input = cyapa->input; | |
528 | ||
529 | if (!input || !input->users) { | |
530 | /* | |
531 | * When input is NULL, TP must be in deep sleep mode. | |
532 | * In this mode, later non-power I2C command will always failed | |
533 | * if not bring it out of deep sleep mode firstly, | |
534 | * so must command TP to active mode here. | |
535 | */ | |
536 | if (!input || cyapa->operational) | |
537 | cyapa->ops->set_power_mode(cyapa, | |
3cd47869 | 538 | PWR_MODE_FULL_ACTIVE, 0, CYAPA_PM_ACTIVE); |
c806b0b8 DD |
539 | /* Gen3 always using polling mode for command. */ |
540 | if (cyapa->gen >= CYAPA_GEN5) | |
541 | enable_irq(cyapa->client->irq); | |
542 | } | |
543 | } | |
544 | ||
545 | static void cyapa_disable_irq_for_cmd(struct cyapa *cyapa) | |
546 | { | |
547 | struct input_dev *input = cyapa->input; | |
548 | ||
549 | if (!input || !input->users) { | |
550 | if (cyapa->gen >= CYAPA_GEN5) | |
551 | disable_irq(cyapa->client->irq); | |
552 | if (!input || cyapa->operational) | |
757cae5a | 553 | cyapa->ops->set_power_mode(cyapa, |
3cd47869 | 554 | PWR_MODE_OFF, 0, CYAPA_PM_ACTIVE); |
c806b0b8 DD |
555 | } |
556 | } | |
557 | ||
9f1cd857 DD |
558 | /* |
559 | * cyapa_sleep_time_to_pwr_cmd and cyapa_pwr_cmd_to_sleep_time | |
560 | * | |
561 | * These are helper functions that convert to and from integer idle | |
562 | * times and register settings to write to the PowerMode register. | |
563 | * The trackpad supports between 20ms to 1000ms scan intervals. | |
564 | * The time will be increased in increments of 10ms from 20ms to 100ms. | |
565 | * From 100ms to 1000ms, time will be increased in increments of 20ms. | |
566 | * | |
567 | * When Idle_Time < 100, the format to convert Idle_Time to Idle_Command is: | |
568 | * Idle_Command = Idle Time / 10; | |
569 | * When Idle_Time >= 100, the format to convert Idle_Time to Idle_Command is: | |
570 | * Idle_Command = Idle Time / 20 + 5; | |
571 | */ | |
572 | u8 cyapa_sleep_time_to_pwr_cmd(u16 sleep_time) | |
573 | { | |
574 | u16 encoded_time; | |
575 | ||
576 | sleep_time = clamp_val(sleep_time, 20, 1000); | |
577 | encoded_time = sleep_time < 100 ? sleep_time / 10 : sleep_time / 20 + 5; | |
578 | return (encoded_time << 2) & PWR_MODE_MASK; | |
579 | } | |
580 | ||
581 | u16 cyapa_pwr_cmd_to_sleep_time(u8 pwr_mode) | |
582 | { | |
583 | u8 encoded_time = pwr_mode >> 2; | |
584 | ||
585 | return (encoded_time < 10) ? encoded_time * 10 | |
586 | : (encoded_time - 5) * 20; | |
587 | } | |
588 | ||
589 | /* 0 on driver initialize and detected successfully, negative on failure. */ | |
590 | static int cyapa_initialize(struct cyapa *cyapa) | |
591 | { | |
592 | int error = 0; | |
593 | ||
594 | cyapa->state = CYAPA_STATE_NO_DEVICE; | |
595 | cyapa->gen = CYAPA_GEN_UNKNOWN; | |
596 | mutex_init(&cyapa->state_sync_lock); | |
597 | ||
598 | /* | |
599 | * Set to hard code default, they will be updated with trackpad set | |
600 | * default values after probe and initialized. | |
601 | */ | |
602 | cyapa->suspend_power_mode = PWR_MODE_SLEEP; | |
603 | cyapa->suspend_sleep_time = | |
604 | cyapa_pwr_cmd_to_sleep_time(cyapa->suspend_power_mode); | |
605 | ||
606 | /* ops.initialize() is aimed to prepare for module communications. */ | |
607 | error = cyapa_gen3_ops.initialize(cyapa); | |
6972a859 DD |
608 | if (!error) |
609 | error = cyapa_gen5_ops.initialize(cyapa); | |
c2c06c41 DD |
610 | if (!error) |
611 | error = cyapa_gen6_ops.initialize(cyapa); | |
9f1cd857 DD |
612 | if (error) |
613 | return error; | |
614 | ||
615 | error = cyapa_detect(cyapa); | |
616 | if (error) | |
617 | return error; | |
618 | ||
619 | /* Power down the device until we need it. */ | |
620 | if (cyapa->operational) | |
3cd47869 DD |
621 | cyapa->ops->set_power_mode(cyapa, |
622 | PWR_MODE_OFF, 0, CYAPA_PM_ACTIVE); | |
9f1cd857 DD |
623 | |
624 | return 0; | |
625 | } | |
626 | ||
627 | static int cyapa_reinitialize(struct cyapa *cyapa) | |
628 | { | |
629 | struct device *dev = &cyapa->client->dev; | |
630 | struct input_dev *input = cyapa->input; | |
631 | int error; | |
632 | ||
67286508 DD |
633 | if (pm_runtime_enabled(dev)) |
634 | pm_runtime_disable(dev); | |
635 | ||
9f1cd857 DD |
636 | /* Avoid command failures when TP was in OFF state. */ |
637 | if (cyapa->operational) | |
757cae5a | 638 | cyapa->ops->set_power_mode(cyapa, |
3cd47869 | 639 | PWR_MODE_FULL_ACTIVE, 0, CYAPA_PM_ACTIVE); |
9f1cd857 DD |
640 | |
641 | error = cyapa_detect(cyapa); | |
642 | if (error) | |
643 | goto out; | |
644 | ||
645 | if (!input && cyapa->operational) { | |
646 | error = cyapa_create_input_dev(cyapa); | |
647 | if (error) { | |
648 | dev_err(dev, "create input_dev instance failed: %d\n", | |
649 | error); | |
650 | goto out; | |
651 | } | |
652 | } | |
653 | ||
654 | out: | |
655 | if (!input || !input->users) { | |
656 | /* Reset to power OFF state to save power when no user open. */ | |
657 | if (cyapa->operational) | |
757cae5a | 658 | cyapa->ops->set_power_mode(cyapa, |
3cd47869 | 659 | PWR_MODE_OFF, 0, CYAPA_PM_DEACTIVE); |
67286508 DD |
660 | } else if (!error && cyapa->operational) { |
661 | /* | |
662 | * Make sure only enable runtime PM when device is | |
663 | * in operational mode and input->users > 0. | |
664 | */ | |
665 | pm_runtime_set_active(dev); | |
666 | pm_runtime_enable(dev); | |
757cae5a DD |
667 | |
668 | pm_runtime_get_sync(dev); | |
669 | pm_runtime_mark_last_busy(dev); | |
670 | pm_runtime_put_sync_autosuspend(dev); | |
9f1cd857 DD |
671 | } |
672 | ||
673 | return error; | |
674 | } | |
675 | ||
676 | static irqreturn_t cyapa_irq(int irq, void *dev_id) | |
677 | { | |
678 | struct cyapa *cyapa = dev_id; | |
679 | struct device *dev = &cyapa->client->dev; | |
757cae5a | 680 | int error; |
9f1cd857 DD |
681 | |
682 | if (device_may_wakeup(dev)) | |
683 | pm_wakeup_event(dev, 0); | |
684 | ||
94897619 | 685 | /* Interrupt event can be caused by host command to trackpad device. */ |
9f1cd857 DD |
686 | if (cyapa->ops->irq_cmd_handler(cyapa)) { |
687 | /* | |
688 | * Interrupt event maybe from trackpad device input reporting. | |
689 | */ | |
690 | if (!cyapa->input) { | |
691 | /* | |
94897619 DD |
692 | * Still in probing or in firmware image |
693 | * updating or reading. | |
9f1cd857 DD |
694 | */ |
695 | cyapa->ops->sort_empty_output_data(cyapa, | |
696 | NULL, NULL, NULL); | |
697 | goto out; | |
698 | } | |
699 | ||
757cae5a DD |
700 | if (cyapa->operational) { |
701 | error = cyapa->ops->irq_handler(cyapa); | |
702 | ||
703 | /* | |
704 | * Apply runtime power management to touch report event | |
705 | * except the events caused by the command responses. | |
706 | * Note: | |
707 | * It will introduce about 20~40 ms additional delay | |
708 | * time in receiving for first valid touch report data. | |
709 | * The time is used to execute device runtime resume | |
710 | * process. | |
711 | */ | |
712 | pm_runtime_get_sync(dev); | |
713 | pm_runtime_mark_last_busy(dev); | |
714 | pm_runtime_put_sync_autosuspend(dev); | |
715 | } | |
716 | ||
717 | if (!cyapa->operational || error) { | |
9f1cd857 DD |
718 | if (!mutex_trylock(&cyapa->state_sync_lock)) { |
719 | cyapa->ops->sort_empty_output_data(cyapa, | |
720 | NULL, NULL, NULL); | |
721 | goto out; | |
722 | } | |
723 | cyapa_reinitialize(cyapa); | |
724 | mutex_unlock(&cyapa->state_sync_lock); | |
725 | } | |
726 | } | |
727 | ||
728 | out: | |
729 | return IRQ_HANDLED; | |
730 | } | |
731 | ||
22e7db81 DD |
732 | /* |
733 | ************************************************************** | |
734 | * sysfs interface | |
735 | ************************************************************** | |
736 | */ | |
737 | #ifdef CONFIG_PM_SLEEP | |
738 | static ssize_t cyapa_show_suspend_scanrate(struct device *dev, | |
739 | struct device_attribute *attr, | |
740 | char *buf) | |
741 | { | |
742 | struct cyapa *cyapa = dev_get_drvdata(dev); | |
743 | u8 pwr_cmd = cyapa->suspend_power_mode; | |
744 | u16 sleep_time; | |
745 | int len; | |
746 | int error; | |
747 | ||
748 | error = mutex_lock_interruptible(&cyapa->state_sync_lock); | |
749 | if (error) | |
750 | return error; | |
751 | ||
752 | pwr_cmd = cyapa->suspend_power_mode; | |
753 | sleep_time = cyapa->suspend_sleep_time; | |
754 | ||
755 | mutex_unlock(&cyapa->state_sync_lock); | |
756 | ||
757 | switch (pwr_cmd) { | |
758 | case PWR_MODE_BTN_ONLY: | |
759 | len = scnprintf(buf, PAGE_SIZE, "%s\n", BTN_ONLY_MODE_NAME); | |
760 | break; | |
761 | ||
762 | case PWR_MODE_OFF: | |
763 | len = scnprintf(buf, PAGE_SIZE, "%s\n", OFF_MODE_NAME); | |
764 | break; | |
765 | ||
766 | default: | |
767 | len = scnprintf(buf, PAGE_SIZE, "%u\n", | |
768 | cyapa->gen == CYAPA_GEN3 ? | |
769 | cyapa_pwr_cmd_to_sleep_time(pwr_cmd) : | |
770 | sleep_time); | |
771 | break; | |
772 | } | |
773 | ||
774 | return len; | |
775 | } | |
776 | ||
777 | static ssize_t cyapa_update_suspend_scanrate(struct device *dev, | |
778 | struct device_attribute *attr, | |
779 | const char *buf, size_t count) | |
780 | { | |
781 | struct cyapa *cyapa = dev_get_drvdata(dev); | |
782 | u16 sleep_time; | |
783 | int error; | |
784 | ||
785 | error = mutex_lock_interruptible(&cyapa->state_sync_lock); | |
786 | if (error) | |
787 | return error; | |
788 | ||
789 | if (sysfs_streq(buf, BTN_ONLY_MODE_NAME)) { | |
790 | cyapa->suspend_power_mode = PWR_MODE_BTN_ONLY; | |
791 | } else if (sysfs_streq(buf, OFF_MODE_NAME)) { | |
792 | cyapa->suspend_power_mode = PWR_MODE_OFF; | |
793 | } else if (!kstrtou16(buf, 10, &sleep_time)) { | |
a333a03c | 794 | cyapa->suspend_sleep_time = min_t(u16, sleep_time, 1000); |
22e7db81 DD |
795 | cyapa->suspend_power_mode = |
796 | cyapa_sleep_time_to_pwr_cmd(cyapa->suspend_sleep_time); | |
797 | } else { | |
798 | count = -EINVAL; | |
799 | } | |
800 | ||
801 | mutex_unlock(&cyapa->state_sync_lock); | |
802 | ||
803 | return count; | |
804 | } | |
805 | ||
806 | static DEVICE_ATTR(suspend_scanrate_ms, S_IRUGO|S_IWUSR, | |
807 | cyapa_show_suspend_scanrate, | |
808 | cyapa_update_suspend_scanrate); | |
809 | ||
810 | static struct attribute *cyapa_power_wakeup_entries[] = { | |
811 | &dev_attr_suspend_scanrate_ms.attr, | |
812 | NULL, | |
813 | }; | |
814 | ||
815 | static const struct attribute_group cyapa_power_wakeup_group = { | |
816 | .name = power_group_name, | |
817 | .attrs = cyapa_power_wakeup_entries, | |
818 | }; | |
819 | ||
820 | static void cyapa_remove_power_wakeup_group(void *data) | |
821 | { | |
822 | struct cyapa *cyapa = data; | |
823 | ||
824 | sysfs_unmerge_group(&cyapa->client->dev.kobj, | |
825 | &cyapa_power_wakeup_group); | |
826 | } | |
827 | ||
828 | static int cyapa_prepare_wakeup_controls(struct cyapa *cyapa) | |
829 | { | |
830 | struct i2c_client *client = cyapa->client; | |
831 | struct device *dev = &client->dev; | |
832 | int error; | |
833 | ||
834 | if (device_can_wakeup(dev)) { | |
835 | error = sysfs_merge_group(&client->dev.kobj, | |
836 | &cyapa_power_wakeup_group); | |
837 | if (error) { | |
838 | dev_err(dev, "failed to add power wakeup group: %d\n", | |
839 | error); | |
840 | return error; | |
841 | } | |
842 | ||
843 | error = devm_add_action(dev, | |
844 | cyapa_remove_power_wakeup_group, cyapa); | |
845 | if (error) { | |
846 | cyapa_remove_power_wakeup_group(cyapa); | |
847 | dev_err(dev, "failed to add power cleanup action: %d\n", | |
848 | error); | |
849 | return error; | |
850 | } | |
851 | } | |
852 | ||
853 | return 0; | |
854 | } | |
855 | #else | |
856 | static inline int cyapa_prepare_wakeup_controls(struct cyapa *cyapa) | |
857 | { | |
858 | return 0; | |
859 | } | |
860 | #endif /* CONFIG_PM_SLEEP */ | |
861 | ||
67286508 DD |
862 | #ifdef CONFIG_PM |
863 | static ssize_t cyapa_show_rt_suspend_scanrate(struct device *dev, | |
864 | struct device_attribute *attr, | |
865 | char *buf) | |
866 | { | |
867 | struct cyapa *cyapa = dev_get_drvdata(dev); | |
868 | u8 pwr_cmd; | |
869 | u16 sleep_time; | |
870 | int error; | |
871 | ||
872 | error = mutex_lock_interruptible(&cyapa->state_sync_lock); | |
873 | if (error) | |
874 | return error; | |
875 | ||
876 | pwr_cmd = cyapa->runtime_suspend_power_mode; | |
877 | sleep_time = cyapa->runtime_suspend_sleep_time; | |
878 | ||
879 | mutex_unlock(&cyapa->state_sync_lock); | |
880 | ||
881 | return scnprintf(buf, PAGE_SIZE, "%u\n", | |
882 | cyapa->gen == CYAPA_GEN3 ? | |
883 | cyapa_pwr_cmd_to_sleep_time(pwr_cmd) : | |
884 | sleep_time); | |
885 | } | |
886 | ||
887 | static ssize_t cyapa_update_rt_suspend_scanrate(struct device *dev, | |
888 | struct device_attribute *attr, | |
889 | const char *buf, size_t count) | |
890 | { | |
891 | struct cyapa *cyapa = dev_get_drvdata(dev); | |
892 | u16 time; | |
893 | int error; | |
894 | ||
895 | if (buf == NULL || count == 0 || kstrtou16(buf, 10, &time)) { | |
896 | dev_err(dev, "invalid runtime suspend scanrate ms parameter\n"); | |
897 | return -EINVAL; | |
898 | } | |
899 | ||
900 | /* | |
901 | * When the suspend scanrate is changed, pm_runtime_get to resume | |
902 | * a potentially suspended device, update to the new pwr_cmd | |
903 | * and then pm_runtime_put to suspend into the new power mode. | |
904 | */ | |
905 | pm_runtime_get_sync(dev); | |
906 | ||
907 | error = mutex_lock_interruptible(&cyapa->state_sync_lock); | |
908 | if (error) | |
909 | return error; | |
910 | ||
a333a03c | 911 | cyapa->runtime_suspend_sleep_time = min_t(u16, time, 1000); |
67286508 DD |
912 | cyapa->runtime_suspend_power_mode = |
913 | cyapa_sleep_time_to_pwr_cmd(cyapa->runtime_suspend_sleep_time); | |
914 | ||
915 | mutex_unlock(&cyapa->state_sync_lock); | |
916 | ||
917 | pm_runtime_put_sync_autosuspend(dev); | |
918 | ||
919 | return count; | |
920 | } | |
921 | ||
922 | static DEVICE_ATTR(runtime_suspend_scanrate_ms, S_IRUGO|S_IWUSR, | |
923 | cyapa_show_rt_suspend_scanrate, | |
924 | cyapa_update_rt_suspend_scanrate); | |
925 | ||
926 | static struct attribute *cyapa_power_runtime_entries[] = { | |
927 | &dev_attr_runtime_suspend_scanrate_ms.attr, | |
928 | NULL, | |
929 | }; | |
930 | ||
931 | static const struct attribute_group cyapa_power_runtime_group = { | |
932 | .name = power_group_name, | |
933 | .attrs = cyapa_power_runtime_entries, | |
934 | }; | |
935 | ||
936 | static void cyapa_remove_power_runtime_group(void *data) | |
937 | { | |
938 | struct cyapa *cyapa = data; | |
939 | ||
940 | sysfs_unmerge_group(&cyapa->client->dev.kobj, | |
941 | &cyapa_power_runtime_group); | |
942 | } | |
943 | ||
944 | static int cyapa_start_runtime(struct cyapa *cyapa) | |
945 | { | |
946 | struct device *dev = &cyapa->client->dev; | |
947 | int error; | |
948 | ||
949 | cyapa->runtime_suspend_power_mode = PWR_MODE_IDLE; | |
950 | cyapa->runtime_suspend_sleep_time = | |
951 | cyapa_pwr_cmd_to_sleep_time(cyapa->runtime_suspend_power_mode); | |
952 | ||
953 | error = sysfs_merge_group(&dev->kobj, &cyapa_power_runtime_group); | |
954 | if (error) { | |
955 | dev_err(dev, | |
956 | "failed to create power runtime group: %d\n", error); | |
957 | return error; | |
958 | } | |
959 | ||
960 | error = devm_add_action(dev, cyapa_remove_power_runtime_group, cyapa); | |
961 | if (error) { | |
962 | cyapa_remove_power_runtime_group(cyapa); | |
963 | dev_err(dev, | |
964 | "failed to add power runtime cleanup action: %d\n", | |
965 | error); | |
966 | return error; | |
967 | } | |
968 | ||
969 | /* runtime is enabled until device is operational and opened. */ | |
970 | pm_runtime_set_suspended(dev); | |
971 | pm_runtime_use_autosuspend(dev); | |
972 | pm_runtime_set_autosuspend_delay(dev, AUTOSUSPEND_DELAY); | |
973 | ||
974 | return 0; | |
975 | } | |
976 | #else | |
977 | static inline int cyapa_start_runtime(struct cyapa *cyapa) | |
978 | { | |
979 | return 0; | |
980 | } | |
981 | #endif /* CONFIG_PM */ | |
982 | ||
c806b0b8 DD |
983 | static ssize_t cyapa_show_fm_ver(struct device *dev, |
984 | struct device_attribute *attr, char *buf) | |
985 | { | |
986 | int error; | |
987 | struct cyapa *cyapa = dev_get_drvdata(dev); | |
988 | ||
989 | error = mutex_lock_interruptible(&cyapa->state_sync_lock); | |
990 | if (error) | |
991 | return error; | |
992 | error = scnprintf(buf, PAGE_SIZE, "%d.%d\n", cyapa->fw_maj_ver, | |
993 | cyapa->fw_min_ver); | |
994 | mutex_unlock(&cyapa->state_sync_lock); | |
995 | return error; | |
996 | } | |
997 | ||
998 | static ssize_t cyapa_show_product_id(struct device *dev, | |
999 | struct device_attribute *attr, char *buf) | |
1000 | { | |
1001 | struct cyapa *cyapa = dev_get_drvdata(dev); | |
1002 | int size; | |
1003 | int error; | |
1004 | ||
1005 | error = mutex_lock_interruptible(&cyapa->state_sync_lock); | |
1006 | if (error) | |
1007 | return error; | |
1008 | size = scnprintf(buf, PAGE_SIZE, "%s\n", cyapa->product_id); | |
1009 | mutex_unlock(&cyapa->state_sync_lock); | |
1010 | return size; | |
1011 | } | |
1012 | ||
1013 | static int cyapa_firmware(struct cyapa *cyapa, const char *fw_name) | |
1014 | { | |
1015 | struct device *dev = &cyapa->client->dev; | |
1016 | const struct firmware *fw; | |
1017 | int error; | |
1018 | ||
1019 | error = request_firmware(&fw, fw_name, dev); | |
1020 | if (error) { | |
1021 | dev_err(dev, "Could not load firmware from %s: %d\n", | |
1022 | fw_name, error); | |
1023 | return error; | |
1024 | } | |
1025 | ||
1026 | error = cyapa->ops->check_fw(cyapa, fw); | |
1027 | if (error) { | |
1028 | dev_err(dev, "Invalid CYAPA firmware image: %s\n", | |
1029 | fw_name); | |
1030 | goto done; | |
1031 | } | |
1032 | ||
1033 | /* | |
1034 | * Resume the potentially suspended device because doing FW | |
1035 | * update on a device not in the FULL mode has a chance to | |
1036 | * fail. | |
1037 | */ | |
1038 | pm_runtime_get_sync(dev); | |
1039 | ||
1040 | /* Require IRQ support for firmware update commands. */ | |
1041 | cyapa_enable_irq_for_cmd(cyapa); | |
1042 | ||
1043 | error = cyapa->ops->bl_enter(cyapa); | |
1044 | if (error) { | |
1045 | dev_err(dev, "bl_enter failed, %d\n", error); | |
1046 | goto err_detect; | |
1047 | } | |
1048 | ||
1049 | error = cyapa->ops->bl_activate(cyapa); | |
1050 | if (error) { | |
1051 | dev_err(dev, "bl_activate failed, %d\n", error); | |
1052 | goto err_detect; | |
1053 | } | |
1054 | ||
1055 | error = cyapa->ops->bl_initiate(cyapa, fw); | |
1056 | if (error) { | |
1057 | dev_err(dev, "bl_initiate failed, %d\n", error); | |
1058 | goto err_detect; | |
1059 | } | |
1060 | ||
1061 | error = cyapa->ops->update_fw(cyapa, fw); | |
1062 | if (error) { | |
1063 | dev_err(dev, "update_fw failed, %d\n", error); | |
1064 | goto err_detect; | |
1065 | } | |
1066 | ||
1067 | err_detect: | |
1068 | cyapa_disable_irq_for_cmd(cyapa); | |
1069 | pm_runtime_put_noidle(dev); | |
1070 | ||
1071 | done: | |
1072 | release_firmware(fw); | |
1073 | return error; | |
1074 | } | |
1075 | ||
1076 | static ssize_t cyapa_update_fw_store(struct device *dev, | |
1077 | struct device_attribute *attr, | |
1078 | const char *buf, size_t count) | |
1079 | { | |
1080 | struct cyapa *cyapa = dev_get_drvdata(dev); | |
1081 | char fw_name[NAME_MAX]; | |
1082 | int ret, error; | |
1083 | ||
b4810773 | 1084 | if (count >= NAME_MAX) { |
c806b0b8 DD |
1085 | dev_err(dev, "File name too long\n"); |
1086 | return -EINVAL; | |
1087 | } | |
1088 | ||
1089 | memcpy(fw_name, buf, count); | |
1090 | if (fw_name[count - 1] == '\n') | |
1091 | fw_name[count - 1] = '\0'; | |
1092 | else | |
1093 | fw_name[count] = '\0'; | |
1094 | ||
1095 | if (cyapa->input) { | |
1096 | /* | |
1097 | * Force the input device to be registered after the firmware | |
1098 | * image is updated, so if the corresponding parameters updated | |
1099 | * in the new firmware image can taken effect immediately. | |
1100 | */ | |
1101 | input_unregister_device(cyapa->input); | |
1102 | cyapa->input = NULL; | |
1103 | } | |
1104 | ||
1105 | error = mutex_lock_interruptible(&cyapa->state_sync_lock); | |
1106 | if (error) { | |
1107 | /* | |
1108 | * Whatever, do reinitialize to try to recover TP state to | |
1109 | * previous state just as it entered fw update entrance. | |
1110 | */ | |
1111 | cyapa_reinitialize(cyapa); | |
1112 | return error; | |
1113 | } | |
1114 | ||
1115 | error = cyapa_firmware(cyapa, fw_name); | |
1116 | if (error) | |
1117 | dev_err(dev, "firmware update failed: %d\n", error); | |
1118 | else | |
1119 | dev_dbg(dev, "firmware update successfully done.\n"); | |
1120 | ||
1121 | /* | |
94897619 | 1122 | * Re-detect trackpad device states because firmware update process |
c806b0b8 DD |
1123 | * will reset trackpad device into bootloader mode. |
1124 | */ | |
1125 | ret = cyapa_reinitialize(cyapa); | |
1126 | if (ret) { | |
94897619 | 1127 | dev_err(dev, "failed to re-detect after updated: %d\n", ret); |
c806b0b8 DD |
1128 | error = error ? error : ret; |
1129 | } | |
1130 | ||
1131 | mutex_unlock(&cyapa->state_sync_lock); | |
1132 | ||
1133 | return error ? error : count; | |
1134 | } | |
1135 | ||
1136 | static ssize_t cyapa_calibrate_store(struct device *dev, | |
1137 | struct device_attribute *attr, | |
1138 | const char *buf, size_t count) | |
1139 | { | |
1140 | struct cyapa *cyapa = dev_get_drvdata(dev); | |
1141 | int error; | |
1142 | ||
1143 | error = mutex_lock_interruptible(&cyapa->state_sync_lock); | |
1144 | if (error) | |
1145 | return error; | |
1146 | ||
1147 | if (cyapa->operational) { | |
1148 | cyapa_enable_irq_for_cmd(cyapa); | |
1149 | error = cyapa->ops->calibrate_store(dev, attr, buf, count); | |
1150 | cyapa_disable_irq_for_cmd(cyapa); | |
1151 | } else { | |
1152 | error = -EBUSY; /* Still running in bootloader mode. */ | |
1153 | } | |
1154 | ||
1155 | mutex_unlock(&cyapa->state_sync_lock); | |
1156 | return error < 0 ? error : count; | |
1157 | } | |
1158 | ||
1159 | static ssize_t cyapa_show_baseline(struct device *dev, | |
1160 | struct device_attribute *attr, char *buf) | |
1161 | { | |
1162 | struct cyapa *cyapa = dev_get_drvdata(dev); | |
1163 | ssize_t error; | |
1164 | ||
1165 | error = mutex_lock_interruptible(&cyapa->state_sync_lock); | |
1166 | if (error) | |
1167 | return error; | |
1168 | ||
1169 | if (cyapa->operational) { | |
1170 | cyapa_enable_irq_for_cmd(cyapa); | |
1171 | error = cyapa->ops->show_baseline(dev, attr, buf); | |
1172 | cyapa_disable_irq_for_cmd(cyapa); | |
1173 | } else { | |
1174 | error = -EBUSY; /* Still running in bootloader mode. */ | |
1175 | } | |
1176 | ||
1177 | mutex_unlock(&cyapa->state_sync_lock); | |
1178 | return error; | |
1179 | } | |
1180 | ||
1181 | static char *cyapa_state_to_string(struct cyapa *cyapa) | |
1182 | { | |
1183 | switch (cyapa->state) { | |
1184 | case CYAPA_STATE_BL_BUSY: | |
1185 | return "bootloader busy"; | |
1186 | case CYAPA_STATE_BL_IDLE: | |
1187 | return "bootloader idle"; | |
1188 | case CYAPA_STATE_BL_ACTIVE: | |
1189 | return "bootloader active"; | |
1190 | case CYAPA_STATE_GEN5_BL: | |
c2c06c41 | 1191 | case CYAPA_STATE_GEN6_BL: |
c806b0b8 DD |
1192 | return "bootloader"; |
1193 | case CYAPA_STATE_OP: | |
1194 | case CYAPA_STATE_GEN5_APP: | |
c2c06c41 | 1195 | case CYAPA_STATE_GEN6_APP: |
c806b0b8 DD |
1196 | return "operational"; /* Normal valid state. */ |
1197 | default: | |
1198 | return "invalid mode"; | |
1199 | } | |
1200 | } | |
1201 | ||
1202 | static ssize_t cyapa_show_mode(struct device *dev, | |
1203 | struct device_attribute *attr, char *buf) | |
1204 | { | |
1205 | struct cyapa *cyapa = dev_get_drvdata(dev); | |
1206 | int size; | |
1207 | int error; | |
1208 | ||
1209 | error = mutex_lock_interruptible(&cyapa->state_sync_lock); | |
1210 | if (error) | |
1211 | return error; | |
1212 | ||
1213 | size = scnprintf(buf, PAGE_SIZE, "gen%d %s\n", | |
1214 | cyapa->gen, cyapa_state_to_string(cyapa)); | |
1215 | ||
1216 | mutex_unlock(&cyapa->state_sync_lock); | |
1217 | return size; | |
1218 | } | |
1219 | ||
1220 | static DEVICE_ATTR(firmware_version, S_IRUGO, cyapa_show_fm_ver, NULL); | |
1221 | static DEVICE_ATTR(product_id, S_IRUGO, cyapa_show_product_id, NULL); | |
1222 | static DEVICE_ATTR(update_fw, S_IWUSR, NULL, cyapa_update_fw_store); | |
1223 | static DEVICE_ATTR(baseline, S_IRUGO, cyapa_show_baseline, NULL); | |
1224 | static DEVICE_ATTR(calibrate, S_IWUSR, NULL, cyapa_calibrate_store); | |
1225 | static DEVICE_ATTR(mode, S_IRUGO, cyapa_show_mode, NULL); | |
1226 | ||
1227 | static struct attribute *cyapa_sysfs_entries[] = { | |
1228 | &dev_attr_firmware_version.attr, | |
1229 | &dev_attr_product_id.attr, | |
1230 | &dev_attr_update_fw.attr, | |
1231 | &dev_attr_baseline.attr, | |
1232 | &dev_attr_calibrate.attr, | |
1233 | &dev_attr_mode.attr, | |
1234 | NULL, | |
1235 | }; | |
1236 | ||
1237 | static const struct attribute_group cyapa_sysfs_group = { | |
1238 | .attrs = cyapa_sysfs_entries, | |
1239 | }; | |
1240 | ||
1241 | static void cyapa_remove_sysfs_group(void *data) | |
1242 | { | |
1243 | struct cyapa *cyapa = data; | |
1244 | ||
1245 | sysfs_remove_group(&cyapa->client->dev.kobj, &cyapa_sysfs_group); | |
1246 | } | |
1247 | ||
36e9615b DD |
1248 | static void cyapa_disable_regulator(void *data) |
1249 | { | |
1250 | struct cyapa *cyapa = data; | |
1251 | ||
1252 | regulator_disable(cyapa->vcc); | |
1253 | } | |
1254 | ||
d7e34d12 BL |
1255 | static int cyapa_probe(struct i2c_client *client, |
1256 | const struct i2c_device_id *dev_id) | |
1257 | { | |
d7e34d12 | 1258 | struct device *dev = &client->dev; |
b1cfa7b4 DD |
1259 | struct cyapa *cyapa; |
1260 | u8 adapter_func; | |
9f1cd857 | 1261 | union i2c_smbus_data dummy; |
b1cfa7b4 | 1262 | int error; |
d7e34d12 | 1263 | |
6ddaf744 BL |
1264 | adapter_func = cyapa_check_adapter_functionality(client); |
1265 | if (adapter_func == CYAPA_ADAPTER_FUNC_NONE) { | |
1266 | dev_err(dev, "not a supported I2C/SMBus adapter\n"); | |
1267 | return -EIO; | |
1268 | } | |
1269 | ||
9f1cd857 DD |
1270 | /* Make sure there is something at this address */ |
1271 | if (i2c_smbus_xfer(client->adapter, client->addr, 0, | |
1272 | I2C_SMBUS_READ, 0, I2C_SMBUS_BYTE, &dummy) < 0) | |
1273 | return -ENODEV; | |
1274 | ||
b1cfa7b4 DD |
1275 | cyapa = devm_kzalloc(dev, sizeof(struct cyapa), GFP_KERNEL); |
1276 | if (!cyapa) | |
d7e34d12 | 1277 | return -ENOMEM; |
d7e34d12 | 1278 | |
6ddaf744 BL |
1279 | /* i2c isn't supported, use smbus */ |
1280 | if (adapter_func == CYAPA_ADAPTER_FUNC_SMBUS) | |
1281 | cyapa->smbus = true; | |
b1cfa7b4 | 1282 | |
9f1cd857 DD |
1283 | cyapa->client = client; |
1284 | i2c_set_clientdata(client, cyapa); | |
1285 | sprintf(cyapa->phys, "i2c-%d-%04x/input0", client->adapter->nr, | |
1286 | client->addr); | |
d7e34d12 | 1287 | |
36e9615b DD |
1288 | cyapa->vcc = devm_regulator_get(dev, "vcc"); |
1289 | if (IS_ERR(cyapa->vcc)) { | |
1290 | error = PTR_ERR(cyapa->vcc); | |
1291 | dev_err(dev, "failed to get vcc regulator: %d\n", error); | |
1292 | return error; | |
1293 | } | |
1294 | ||
1295 | error = regulator_enable(cyapa->vcc); | |
1296 | if (error) { | |
1297 | dev_err(dev, "failed to enable regulator: %d\n", error); | |
1298 | return error; | |
1299 | } | |
1300 | ||
1301 | error = devm_add_action(dev, cyapa_disable_regulator, cyapa); | |
1302 | if (error) { | |
1303 | cyapa_disable_regulator(cyapa); | |
1304 | dev_err(dev, "failed to add disable regulator action: %d\n", | |
1305 | error); | |
1306 | return error; | |
1307 | } | |
1308 | ||
9f1cd857 | 1309 | error = cyapa_initialize(cyapa); |
b1cfa7b4 | 1310 | if (error) { |
9f1cd857 | 1311 | dev_err(dev, "failed to detect and initialize tp device.\n"); |
b1cfa7b4 | 1312 | return error; |
d7e34d12 BL |
1313 | } |
1314 | ||
c806b0b8 DD |
1315 | error = sysfs_create_group(&client->dev.kobj, &cyapa_sysfs_group); |
1316 | if (error) { | |
1317 | dev_err(dev, "failed to create sysfs entries: %d\n", error); | |
1318 | return error; | |
1319 | } | |
1320 | ||
1321 | error = devm_add_action(dev, cyapa_remove_sysfs_group, cyapa); | |
1322 | if (error) { | |
1323 | cyapa_remove_sysfs_group(cyapa); | |
1324 | dev_err(dev, "failed to add sysfs cleanup action: %d\n", error); | |
1325 | return error; | |
1326 | } | |
1327 | ||
22e7db81 DD |
1328 | error = cyapa_prepare_wakeup_controls(cyapa); |
1329 | if (error) { | |
1330 | dev_err(dev, "failed to prepare wakeup controls: %d\n", error); | |
1331 | return error; | |
1332 | } | |
1333 | ||
67286508 DD |
1334 | error = cyapa_start_runtime(cyapa); |
1335 | if (error) { | |
1336 | dev_err(dev, "failed to start pm_runtime: %d\n", error); | |
1337 | return error; | |
1338 | } | |
1339 | ||
b1cfa7b4 DD |
1340 | error = devm_request_threaded_irq(dev, client->irq, |
1341 | NULL, cyapa_irq, | |
1342 | IRQF_TRIGGER_FALLING | IRQF_ONESHOT, | |
1343 | "cyapa", cyapa); | |
1344 | if (error) { | |
823a11fd | 1345 | dev_err(dev, "failed to request threaded irq: %d\n", error); |
b1cfa7b4 | 1346 | return error; |
d7e34d12 BL |
1347 | } |
1348 | ||
b1cfa7b4 DD |
1349 | /* Disable IRQ until the device is opened */ |
1350 | disable_irq(client->irq); | |
d7e34d12 | 1351 | |
9f1cd857 DD |
1352 | /* |
1353 | * Register the device in the input subsystem when it's operational. | |
1354 | * Otherwise, keep in this driver, so it can be be recovered or updated | |
1355 | * through the sysfs mode and update_fw interfaces by user or apps. | |
1356 | */ | |
1357 | if (cyapa->operational) { | |
1358 | error = cyapa_create_input_dev(cyapa); | |
1359 | if (error) { | |
1360 | dev_err(dev, "create input_dev instance failed: %d\n", | |
1361 | error); | |
1362 | return error; | |
1363 | } | |
b1cfa7b4 | 1364 | } |
d7e34d12 BL |
1365 | |
1366 | return 0; | |
1367 | } | |
1368 | ||
572081a4 | 1369 | static int __maybe_unused cyapa_suspend(struct device *dev) |
d7e34d12 | 1370 | { |
b1cfa7b4 DD |
1371 | struct i2c_client *client = to_i2c_client(dev); |
1372 | struct cyapa *cyapa = i2c_get_clientdata(client); | |
d7e34d12 | 1373 | u8 power_mode; |
b1cfa7b4 DD |
1374 | int error; |
1375 | ||
9f1cd857 | 1376 | error = mutex_lock_interruptible(&cyapa->state_sync_lock); |
b1cfa7b4 DD |
1377 | if (error) |
1378 | return error; | |
d7e34d12 | 1379 | |
67286508 DD |
1380 | /* |
1381 | * Runtime PM is enable only when device is in operational mode and | |
1382 | * users in use, so need check it before disable it to | |
1383 | * avoid unbalance warning. | |
1384 | */ | |
1385 | if (pm_runtime_enabled(dev)) | |
1386 | pm_runtime_disable(dev); | |
b1cfa7b4 | 1387 | disable_irq(client->irq); |
d7e34d12 BL |
1388 | |
1389 | /* | |
1390 | * Set trackpad device to idle mode if wakeup is allowed, | |
1391 | * otherwise turn off. | |
1392 | */ | |
9f1cd857 DD |
1393 | if (cyapa->operational) { |
1394 | power_mode = device_may_wakeup(dev) ? cyapa->suspend_power_mode | |
1395 | : PWR_MODE_OFF; | |
1396 | error = cyapa->ops->set_power_mode(cyapa, power_mode, | |
3cd47869 | 1397 | cyapa->suspend_sleep_time, CYAPA_PM_SUSPEND); |
9f1cd857 DD |
1398 | if (error) |
1399 | dev_err(dev, "suspend set power mode failed: %d\n", | |
1400 | error); | |
1401 | } | |
d7e34d12 | 1402 | |
945525ee DD |
1403 | /* |
1404 | * Disable proximity interrupt when system idle, want true touch to | |
1405 | * wake the system. | |
1406 | */ | |
1407 | if (cyapa->dev_pwr_mode != PWR_MODE_OFF) | |
1408 | cyapa->ops->set_proximity(cyapa, false); | |
1409 | ||
d7e34d12 | 1410 | if (device_may_wakeup(dev)) |
f68a95cd | 1411 | cyapa->irq_wake = (enable_irq_wake(client->irq) == 0); |
b1cfa7b4 | 1412 | |
9f1cd857 | 1413 | mutex_unlock(&cyapa->state_sync_lock); |
d7e34d12 BL |
1414 | return 0; |
1415 | } | |
1416 | ||
572081a4 | 1417 | static int __maybe_unused cyapa_resume(struct device *dev) |
d7e34d12 | 1418 | { |
b1cfa7b4 DD |
1419 | struct i2c_client *client = to_i2c_client(dev); |
1420 | struct cyapa *cyapa = i2c_get_clientdata(client); | |
b1cfa7b4 DD |
1421 | int error; |
1422 | ||
9f1cd857 | 1423 | mutex_lock(&cyapa->state_sync_lock); |
d7e34d12 | 1424 | |
9f1cd857 | 1425 | if (device_may_wakeup(dev) && cyapa->irq_wake) { |
f68a95cd | 1426 | disable_irq_wake(client->irq); |
9f1cd857 DD |
1427 | cyapa->irq_wake = false; |
1428 | } | |
d7e34d12 | 1429 | |
945525ee DD |
1430 | /* |
1431 | * Update device states and runtime PM states. | |
1432 | * Re-Enable proximity interrupt after enter operational mode. | |
1433 | */ | |
9f1cd857 | 1434 | error = cyapa_reinitialize(cyapa); |
b1cfa7b4 | 1435 | if (error) |
9f1cd857 | 1436 | dev_warn(dev, "failed to reinitialize TP device: %d\n", error); |
d7e34d12 | 1437 | |
f68a95cd | 1438 | enable_irq(client->irq); |
b1cfa7b4 | 1439 | |
9f1cd857 | 1440 | mutex_unlock(&cyapa->state_sync_lock); |
d7e34d12 BL |
1441 | return 0; |
1442 | } | |
d7e34d12 | 1443 | |
67286508 DD |
1444 | static int __maybe_unused cyapa_runtime_suspend(struct device *dev) |
1445 | { | |
1446 | struct cyapa *cyapa = dev_get_drvdata(dev); | |
1447 | int error; | |
1448 | ||
1449 | error = cyapa->ops->set_power_mode(cyapa, | |
1450 | cyapa->runtime_suspend_power_mode, | |
757cae5a | 1451 | cyapa->runtime_suspend_sleep_time, |
3cd47869 | 1452 | CYAPA_PM_RUNTIME_SUSPEND); |
67286508 DD |
1453 | if (error) |
1454 | dev_warn(dev, "runtime suspend failed: %d\n", error); | |
1455 | ||
1456 | return 0; | |
1457 | } | |
1458 | ||
1459 | static int __maybe_unused cyapa_runtime_resume(struct device *dev) | |
1460 | { | |
1461 | struct cyapa *cyapa = dev_get_drvdata(dev); | |
1462 | int error; | |
1463 | ||
757cae5a | 1464 | error = cyapa->ops->set_power_mode(cyapa, |
3cd47869 | 1465 | PWR_MODE_FULL_ACTIVE, 0, CYAPA_PM_RUNTIME_RESUME); |
67286508 DD |
1466 | if (error) |
1467 | dev_warn(dev, "runtime resume failed: %d\n", error); | |
1468 | ||
1469 | return 0; | |
1470 | } | |
1471 | ||
1472 | static const struct dev_pm_ops cyapa_pm_ops = { | |
1473 | SET_SYSTEM_SLEEP_PM_OPS(cyapa_suspend, cyapa_resume) | |
1474 | SET_RUNTIME_PM_OPS(cyapa_runtime_suspend, cyapa_runtime_resume, NULL) | |
1475 | }; | |
d7e34d12 BL |
1476 | |
1477 | static const struct i2c_device_id cyapa_id_table[] = { | |
1478 | { "cyapa", 0 }, | |
1479 | { }, | |
1480 | }; | |
1481 | MODULE_DEVICE_TABLE(i2c, cyapa_id_table); | |
1482 | ||
7b2171d7 DD |
1483 | #ifdef CONFIG_ACPI |
1484 | static const struct acpi_device_id cyapa_acpi_id[] = { | |
1485 | { "CYAP0000", 0 }, /* Gen3 trackpad with 0x67 I2C address. */ | |
1486 | { "CYAP0001", 0 }, /* Gen5 trackpad with 0x24 I2C address. */ | |
ce2ae9e3 | 1487 | { "CYAP0002", 0 }, /* Gen6 trackpad with 0x24 I2C address. */ |
7b2171d7 DD |
1488 | { } |
1489 | }; | |
1490 | MODULE_DEVICE_TABLE(acpi, cyapa_acpi_id); | |
1491 | #endif | |
1492 | ||
ddbb299d DD |
1493 | #ifdef CONFIG_OF |
1494 | static const struct of_device_id cyapa_of_match[] = { | |
1495 | { .compatible = "cypress,cyapa" }, | |
1496 | { /* sentinel */ } | |
1497 | }; | |
1498 | MODULE_DEVICE_TABLE(of, cyapa_of_match); | |
1499 | #endif | |
1500 | ||
d7e34d12 BL |
1501 | static struct i2c_driver cyapa_driver = { |
1502 | .driver = { | |
1503 | .name = "cyapa", | |
d7e34d12 | 1504 | .pm = &cyapa_pm_ops, |
7b2171d7 | 1505 | .acpi_match_table = ACPI_PTR(cyapa_acpi_id), |
ddbb299d | 1506 | .of_match_table = of_match_ptr(cyapa_of_match), |
d7e34d12 BL |
1507 | }, |
1508 | ||
1509 | .probe = cyapa_probe, | |
d7e34d12 BL |
1510 | .id_table = cyapa_id_table, |
1511 | }; | |
1512 | ||
1513 | module_i2c_driver(cyapa_driver); | |
1514 | ||
1515 | MODULE_DESCRIPTION("Cypress APA I2C Trackpad Driver"); | |
1516 | MODULE_AUTHOR("Dudley Du <dudl@cypress.com>"); | |
1517 | MODULE_LICENSE("GPL"); |