1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Atmel maXTouch Touchscreen driver 4 * 5 * Copyright (C) 2010 Samsung Electronics Co.Ltd 6 * Copyright (C) 2011-2014 Atmel Corporation 7 * Copyright (C) 2012 Google, Inc. 8 * Copyright (C) 2016 Zodiac Inflight Innovations 9 * 10 * Author: Joonyoung Shim <jy0922.shim@samsung.com> 11 */ 12 13 #include <linux/acpi.h> 14 #include <linux/dmi.h> 15 #include <linux/module.h> 16 #include <linux/init.h> 17 #include <linux/completion.h> 18 #include <linux/delay.h> 19 #include <linux/firmware.h> 20 #include <linux/i2c.h> 21 #include <linux/input/mt.h> 22 #include <linux/input/touchscreen.h> 23 #include <linux/interrupt.h> 24 #include <linux/irq.h> 25 #include <linux/of.h> 26 #include <linux/property.h> 27 #include <linux/slab.h> 28 #include <linux/regulator/consumer.h> 29 #include <linux/gpio/consumer.h> 30 #include <linux/unaligned.h> 31 #include <media/v4l2-device.h> 32 #include <media/v4l2-ioctl.h> 33 #include <media/videobuf2-v4l2.h> 34 #include <media/videobuf2-vmalloc.h> 35 #include <dt-bindings/input/atmel-maxtouch.h> 36 37 /* Firmware files */ 38 #define MXT_FW_NAME "maxtouch.fw" 39 #define MXT_CFG_NAME "maxtouch.cfg" 40 #define MXT_CFG_MAGIC "OBP_RAW V1" 41 42 /* Registers */ 43 #define MXT_OBJECT_START 0x07 44 #define MXT_OBJECT_SIZE 6 45 #define MXT_INFO_CHECKSUM_SIZE 3 46 #define MXT_MAX_BLOCK_WRITE 256 47 48 /* Object types */ 49 #define MXT_DEBUG_DIAGNOSTIC_T37 37 50 #define MXT_GEN_MESSAGE_T5 5 51 #define MXT_GEN_COMMAND_T6 6 52 #define MXT_GEN_POWER_T7 7 53 #define MXT_GEN_ACQUIRE_T8 8 54 #define MXT_GEN_DATASOURCE_T53 53 55 #define MXT_TOUCH_MULTI_T9 9 56 #define MXT_TOUCH_KEYARRAY_T15 15 57 #define MXT_TOUCH_PROXIMITY_T23 23 58 #define MXT_TOUCH_PROXKEY_T52 52 59 #define MXT_TOUCH_PTC_KEYS_T97 97 60 #define MXT_PROCI_GRIPFACE_T20 20 61 #define MXT_PROCG_NOISE_T22 22 62 #define MXT_PROCI_ONETOUCH_T24 24 63 #define MXT_PROCI_TWOTOUCH_T27 27 64 #define MXT_PROCI_GRIP_T40 40 65 #define MXT_PROCI_PALM_T41 41 66 #define MXT_PROCI_TOUCHSUPPRESSION_T42 42 67 #define MXT_PROCI_STYLUS_T47 47 68 #define MXT_PROCG_NOISESUPPRESSION_T48 48 69 #define MXT_SPT_COMMSCONFIG_T18 18 70 #define MXT_SPT_GPIOPWM_T19 19 71 #define MXT_SPT_SELFTEST_T25 25 72 #define MXT_SPT_CTECONFIG_T28 28 73 #define MXT_SPT_USERDATA_T38 38 74 #define MXT_SPT_DIGITIZER_T43 43 75 #define MXT_SPT_MESSAGECOUNT_T44 44 76 #define MXT_SPT_CTECONFIG_T46 46 77 #define MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71 71 78 #define MXT_TOUCH_MULTITOUCHSCREEN_T100 100 79 80 /* MXT_GEN_MESSAGE_T5 object */ 81 #define MXT_RPTID_NOMSG 0xff 82 83 /* MXT_GEN_COMMAND_T6 field */ 84 #define MXT_COMMAND_RESET 0 85 #define MXT_COMMAND_BACKUPNV 1 86 #define MXT_COMMAND_CALIBRATE 2 87 #define MXT_COMMAND_REPORTALL 3 88 #define MXT_COMMAND_DIAGNOSTIC 5 89 90 /* Define for T6 status byte */ 91 #define MXT_T6_STATUS_RESET BIT(7) 92 #define MXT_T6_STATUS_OFL BIT(6) 93 #define MXT_T6_STATUS_SIGERR BIT(5) 94 #define MXT_T6_STATUS_CAL BIT(4) 95 #define MXT_T6_STATUS_CFGERR BIT(3) 96 #define MXT_T6_STATUS_COMSERR BIT(2) 97 98 /* MXT_GEN_POWER_T7 field */ 99 struct t7_config { 100 u8 idle; 101 u8 active; 102 } __packed; 103 104 #define MXT_POWER_CFG_RUN 0 105 #define MXT_POWER_CFG_DEEPSLEEP 1 106 107 /* MXT_TOUCH_MULTI_T9 field */ 108 #define MXT_T9_CTRL 0 109 #define MXT_T9_XSIZE 3 110 #define MXT_T9_YSIZE 4 111 #define MXT_T9_ORIENT 9 112 #define MXT_T9_RANGE 18 113 114 /* MXT_TOUCH_MULTI_T9 status */ 115 #define MXT_T9_UNGRIP BIT(0) 116 #define MXT_T9_SUPPRESS BIT(1) 117 #define MXT_T9_AMP BIT(2) 118 #define MXT_T9_VECTOR BIT(3) 119 #define MXT_T9_MOVE BIT(4) 120 #define MXT_T9_RELEASE BIT(5) 121 #define MXT_T9_PRESS BIT(6) 122 #define MXT_T9_DETECT BIT(7) 123 124 struct t9_range { 125 __le16 x; 126 __le16 y; 127 } __packed; 128 129 /* MXT_TOUCH_MULTI_T9 orient */ 130 #define MXT_T9_ORIENT_SWITCH BIT(0) 131 #define MXT_T9_ORIENT_INVERTX BIT(1) 132 #define MXT_T9_ORIENT_INVERTY BIT(2) 133 134 /* MXT_SPT_COMMSCONFIG_T18 */ 135 #define MXT_COMMS_CTRL 0 136 #define MXT_COMMS_CMD 1 137 #define MXT_COMMS_RETRIGEN BIT(6) 138 139 /* MXT_DEBUG_DIAGNOSTIC_T37 */ 140 #define MXT_DIAGNOSTIC_PAGEUP 0x01 141 #define MXT_DIAGNOSTIC_DELTAS 0x10 142 #define MXT_DIAGNOSTIC_REFS 0x11 143 #define MXT_DIAGNOSTIC_SIZE 128 144 145 #define MXT_FAMILY_1386 160 146 #define MXT1386_COLUMNS 3 147 #define MXT1386_PAGES_PER_COLUMN 8 148 149 struct t37_debug { 150 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37 151 u8 mode; 152 u8 page; 153 u8 data[MXT_DIAGNOSTIC_SIZE]; 154 #endif 155 }; 156 157 /* Define for MXT_GEN_COMMAND_T6 */ 158 #define MXT_BOOT_VALUE 0xa5 159 #define MXT_RESET_VALUE 0x01 160 #define MXT_BACKUP_VALUE 0x55 161 162 /* T100 Multiple Touch Touchscreen */ 163 #define MXT_T100_CTRL 0 164 #define MXT_T100_CFG1 1 165 #define MXT_T100_TCHAUX 3 166 #define MXT_T100_XSIZE 9 167 #define MXT_T100_XRANGE 13 168 #define MXT_T100_YSIZE 20 169 #define MXT_T100_YRANGE 24 170 171 #define MXT_T100_CFG_SWITCHXY BIT(5) 172 #define MXT_T100_CFG_INVERTY BIT(6) 173 #define MXT_T100_CFG_INVERTX BIT(7) 174 175 #define MXT_T100_TCHAUX_VECT BIT(0) 176 #define MXT_T100_TCHAUX_AMPL BIT(1) 177 #define MXT_T100_TCHAUX_AREA BIT(2) 178 179 #define MXT_T100_DETECT BIT(7) 180 #define MXT_T100_TYPE_MASK 0x70 181 182 enum t100_type { 183 MXT_T100_TYPE_FINGER = 1, 184 MXT_T100_TYPE_PASSIVE_STYLUS = 2, 185 MXT_T100_TYPE_HOVERING_FINGER = 4, 186 MXT_T100_TYPE_GLOVE = 5, 187 MXT_T100_TYPE_LARGE_TOUCH = 6, 188 }; 189 190 #define MXT_DISTANCE_ACTIVE_TOUCH 0 191 #define MXT_DISTANCE_HOVERING 1 192 193 #define MXT_TOUCH_MAJOR_DEFAULT 1 194 #define MXT_PRESSURE_DEFAULT 1 195 196 /* Delay times */ 197 #define MXT_BACKUP_TIME 50 /* msec */ 198 #define MXT_RESET_GPIO_TIME 20 /* msec */ 199 #define MXT_RESET_INVALID_CHG 100 /* msec */ 200 #define MXT_RESET_TIME 200 /* msec */ 201 #define MXT_RESET_TIMEOUT 3000 /* msec */ 202 #define MXT_CRC_TIMEOUT 1000 /* msec */ 203 #define MXT_FW_RESET_TIME 3000 /* msec */ 204 #define MXT_FW_CHG_TIMEOUT 300 /* msec */ 205 #define MXT_WAKEUP_TIME 25 /* msec */ 206 207 /* Command to unlock bootloader */ 208 #define MXT_UNLOCK_CMD_MSB 0xaa 209 #define MXT_UNLOCK_CMD_LSB 0xdc 210 211 /* Bootloader mode status */ 212 #define MXT_WAITING_BOOTLOAD_CMD 0xc0 /* valid 7 6 bit only */ 213 #define MXT_WAITING_FRAME_DATA 0x80 /* valid 7 6 bit only */ 214 #define MXT_FRAME_CRC_CHECK 0x02 215 #define MXT_FRAME_CRC_FAIL 0x03 216 #define MXT_FRAME_CRC_PASS 0x04 217 #define MXT_APP_CRC_FAIL 0x40 /* valid 7 8 bit only */ 218 #define MXT_BOOT_STATUS_MASK 0x3f 219 #define MXT_BOOT_EXTENDED_ID BIT(5) 220 #define MXT_BOOT_ID_MASK 0x1f 221 222 /* Touchscreen absolute values */ 223 #define MXT_MAX_AREA 0xff 224 225 #define MXT_PIXELS_PER_MM 20 226 227 struct mxt_info { 228 u8 family_id; 229 u8 variant_id; 230 u8 version; 231 u8 build; 232 u8 matrix_xsize; 233 u8 matrix_ysize; 234 u8 object_num; 235 }; 236 237 struct mxt_object { 238 u8 type; 239 u16 start_address; 240 u8 size_minus_one; 241 u8 instances_minus_one; 242 u8 num_report_ids; 243 } __packed; 244 245 struct mxt_dbg { 246 u16 t37_address; 247 u16 diag_cmd_address; 248 struct t37_debug *t37_buf; 249 unsigned int t37_pages; 250 unsigned int t37_nodes; 251 252 struct v4l2_device v4l2; 253 struct v4l2_pix_format format; 254 struct video_device vdev; 255 struct vb2_queue queue; 256 struct mutex lock; 257 int input; 258 }; 259 260 enum v4l_dbg_inputs { 261 MXT_V4L_INPUT_DELTAS, 262 MXT_V4L_INPUT_REFS, 263 MXT_V4L_INPUT_MAX, 264 }; 265 266 enum mxt_suspend_mode { 267 MXT_SUSPEND_DEEP_SLEEP = 0, 268 MXT_SUSPEND_T9_CTRL = 1, 269 }; 270 271 /* Config update context */ 272 struct mxt_cfg { 273 u8 *raw; 274 size_t raw_size; 275 off_t raw_pos; 276 277 u8 *mem; 278 size_t mem_size; 279 int start_ofs; 280 281 struct mxt_info info; 282 }; 283 284 /* Each client has this additional data */ 285 struct mxt_data { 286 struct i2c_client *client; 287 struct input_dev *input_dev; 288 char phys[64]; /* device physical location */ 289 struct mxt_object *object_table; 290 struct mxt_info *info; 291 void *raw_info_block; 292 unsigned int irq; 293 unsigned int max_x; 294 unsigned int max_y; 295 bool invertx; 296 bool inverty; 297 bool xy_switch; 298 u8 xsize; 299 u8 ysize; 300 bool in_bootloader; 301 u16 mem_size; 302 u8 t100_aux_ampl; 303 u8 t100_aux_area; 304 u8 t100_aux_vect; 305 u8 max_reportid; 306 u32 config_crc; 307 u32 info_crc; 308 u8 bootloader_addr; 309 u8 *msg_buf; 310 u8 t6_status; 311 bool update_input; 312 u8 last_message_count; 313 u8 num_touchids; 314 u8 multitouch; 315 struct t7_config t7_cfg; 316 struct mxt_dbg dbg; 317 struct regulator_bulk_data regulators[2]; 318 struct gpio_desc *reset_gpio; 319 struct gpio_desc *wake_gpio; 320 bool use_retrigen_workaround; 321 322 /* Cached parameters from object table */ 323 u16 T5_address; 324 u8 T5_msg_size; 325 u8 T6_reportid; 326 u16 T6_address; 327 u16 T7_address; 328 u16 T71_address; 329 u8 T9_reportid_min; 330 u8 T9_reportid_max; 331 u8 T15_reportid_min; 332 u8 T15_reportid_max; 333 u16 T18_address; 334 u8 T19_reportid; 335 u16 T44_address; 336 u8 T97_reportid_min; 337 u8 T97_reportid_max; 338 u8 T100_reportid_min; 339 u8 T100_reportid_max; 340 341 /* for fw update in bootloader */ 342 struct completion bl_completion; 343 344 /* for reset handling */ 345 struct completion reset_completion; 346 347 /* for config update handling */ 348 struct completion crc_completion; 349 350 u32 *t19_keymap; 351 unsigned int t19_num_keys; 352 353 u32 *t15_keymap; 354 unsigned int t15_num_keys; 355 356 enum mxt_suspend_mode suspend_mode; 357 358 u32 wakeup_method; 359 360 struct touchscreen_properties prop; 361 }; 362 363 struct mxt_vb2_buffer { 364 struct vb2_buffer vb; 365 struct list_head list; 366 }; 367 368 static size_t mxt_obj_size(const struct mxt_object *obj) 369 { 370 return obj->size_minus_one + 1; 371 } 372 373 static size_t mxt_obj_instances(const struct mxt_object *obj) 374 { 375 return obj->instances_minus_one + 1; 376 } 377 378 static bool mxt_object_readable(unsigned int type) 379 { 380 switch (type) { 381 case MXT_GEN_COMMAND_T6: 382 case MXT_GEN_POWER_T7: 383 case MXT_GEN_ACQUIRE_T8: 384 case MXT_GEN_DATASOURCE_T53: 385 case MXT_TOUCH_MULTI_T9: 386 case MXT_TOUCH_KEYARRAY_T15: 387 case MXT_TOUCH_PROXIMITY_T23: 388 case MXT_TOUCH_PROXKEY_T52: 389 case MXT_TOUCH_PTC_KEYS_T97: 390 case MXT_TOUCH_MULTITOUCHSCREEN_T100: 391 case MXT_PROCI_GRIPFACE_T20: 392 case MXT_PROCG_NOISE_T22: 393 case MXT_PROCI_ONETOUCH_T24: 394 case MXT_PROCI_TWOTOUCH_T27: 395 case MXT_PROCI_GRIP_T40: 396 case MXT_PROCI_PALM_T41: 397 case MXT_PROCI_TOUCHSUPPRESSION_T42: 398 case MXT_PROCI_STYLUS_T47: 399 case MXT_PROCG_NOISESUPPRESSION_T48: 400 case MXT_SPT_COMMSCONFIG_T18: 401 case MXT_SPT_GPIOPWM_T19: 402 case MXT_SPT_SELFTEST_T25: 403 case MXT_SPT_CTECONFIG_T28: 404 case MXT_SPT_USERDATA_T38: 405 case MXT_SPT_DIGITIZER_T43: 406 case MXT_SPT_CTECONFIG_T46: 407 case MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71: 408 return true; 409 default: 410 return false; 411 } 412 } 413 414 static void mxt_dump_message(struct mxt_data *data, u8 *message) 415 { 416 dev_dbg(&data->client->dev, "message: %*ph\n", 417 data->T5_msg_size, message); 418 } 419 420 static int mxt_wait_for_completion(struct mxt_data *data, 421 struct completion *comp, 422 unsigned int timeout_ms) 423 { 424 struct device *dev = &data->client->dev; 425 unsigned long timeout = msecs_to_jiffies(timeout_ms); 426 long ret; 427 428 ret = wait_for_completion_interruptible_timeout(comp, timeout); 429 if (ret < 0) { 430 return ret; 431 } else if (ret == 0) { 432 dev_err(dev, "Wait for completion timed out.\n"); 433 return -ETIMEDOUT; 434 } 435 return 0; 436 } 437 438 static int mxt_bootloader_read(struct mxt_data *data, 439 u8 *val, unsigned int count) 440 { 441 int ret; 442 struct i2c_msg msg; 443 444 msg.addr = data->bootloader_addr; 445 msg.flags = data->client->flags & I2C_M_TEN; 446 msg.flags |= I2C_M_RD; 447 msg.len = count; 448 msg.buf = val; 449 450 ret = i2c_transfer(data->client->adapter, &msg, 1); 451 if (ret == 1) { 452 ret = 0; 453 } else { 454 ret = ret < 0 ? ret : -EIO; 455 dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n", 456 __func__, ret); 457 } 458 459 return ret; 460 } 461 462 static int mxt_bootloader_write(struct mxt_data *data, 463 const u8 * const val, unsigned int count) 464 { 465 int ret; 466 struct i2c_msg msg; 467 468 msg.addr = data->bootloader_addr; 469 msg.flags = data->client->flags & I2C_M_TEN; 470 msg.len = count; 471 msg.buf = (u8 *)val; 472 473 ret = i2c_transfer(data->client->adapter, &msg, 1); 474 if (ret == 1) { 475 ret = 0; 476 } else { 477 ret = ret < 0 ? ret : -EIO; 478 dev_err(&data->client->dev, "%s: i2c send failed (%d)\n", 479 __func__, ret); 480 } 481 482 return ret; 483 } 484 485 static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry) 486 { 487 u8 appmode = data->client->addr; 488 u8 bootloader; 489 u8 family_id = data->info ? data->info->family_id : 0; 490 491 switch (appmode) { 492 case 0x4a: 493 case 0x4b: 494 /* Chips after 1664S use different scheme */ 495 if (retry || family_id >= 0xa2) { 496 bootloader = appmode - 0x24; 497 break; 498 } 499 fallthrough; /* for normal case */ 500 case 0x4c: 501 case 0x4d: 502 case 0x5a: 503 case 0x5b: 504 bootloader = appmode - 0x26; 505 break; 506 507 default: 508 dev_err(&data->client->dev, 509 "Appmode i2c address 0x%02x not found\n", 510 appmode); 511 return -EINVAL; 512 } 513 514 data->bootloader_addr = bootloader; 515 return 0; 516 } 517 518 static int mxt_probe_bootloader(struct mxt_data *data, bool alt_address) 519 { 520 struct device *dev = &data->client->dev; 521 int error; 522 u8 val; 523 bool crc_failure; 524 525 error = mxt_lookup_bootloader_address(data, alt_address); 526 if (error) 527 return error; 528 529 error = mxt_bootloader_read(data, &val, 1); 530 if (error) 531 return error; 532 533 /* Check app crc fail mode */ 534 crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL; 535 536 dev_err(dev, "Detected bootloader, status:%02X%s\n", 537 val, crc_failure ? ", APP_CRC_FAIL" : ""); 538 539 return 0; 540 } 541 542 static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val) 543 { 544 struct device *dev = &data->client->dev; 545 u8 buf[3]; 546 547 if (val & MXT_BOOT_EXTENDED_ID) { 548 if (mxt_bootloader_read(data, &buf[0], 3) != 0) { 549 dev_err(dev, "%s: i2c failure\n", __func__); 550 return val; 551 } 552 553 dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]); 554 555 return buf[0]; 556 } else { 557 dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK); 558 559 return val; 560 } 561 } 562 563 static int mxt_check_bootloader(struct mxt_data *data, unsigned int state, 564 bool wait) 565 { 566 struct device *dev = &data->client->dev; 567 u8 val; 568 int ret; 569 570 recheck: 571 if (wait) { 572 /* 573 * In application update mode, the interrupt 574 * line signals state transitions. We must wait for the 575 * CHG assertion before reading the status byte. 576 * Once the status byte has been read, the line is deasserted. 577 */ 578 ret = mxt_wait_for_completion(data, &data->bl_completion, 579 MXT_FW_CHG_TIMEOUT); 580 if (ret) { 581 /* 582 * TODO: handle -ERESTARTSYS better by terminating 583 * fw update process before returning to userspace 584 * by writing length 0x000 to device (iff we are in 585 * WAITING_FRAME_DATA state). 586 */ 587 dev_err(dev, "Update wait error %d\n", ret); 588 return ret; 589 } 590 } 591 592 ret = mxt_bootloader_read(data, &val, 1); 593 if (ret) 594 return ret; 595 596 if (state == MXT_WAITING_BOOTLOAD_CMD) 597 val = mxt_get_bootloader_version(data, val); 598 599 switch (state) { 600 case MXT_WAITING_BOOTLOAD_CMD: 601 case MXT_WAITING_FRAME_DATA: 602 case MXT_APP_CRC_FAIL: 603 val &= ~MXT_BOOT_STATUS_MASK; 604 break; 605 case MXT_FRAME_CRC_PASS: 606 if (val == MXT_FRAME_CRC_CHECK) { 607 goto recheck; 608 } else if (val == MXT_FRAME_CRC_FAIL) { 609 dev_err(dev, "Bootloader CRC fail\n"); 610 return -EINVAL; 611 } 612 break; 613 default: 614 return -EINVAL; 615 } 616 617 if (val != state) { 618 dev_err(dev, "Invalid bootloader state %02X != %02X\n", 619 val, state); 620 return -EINVAL; 621 } 622 623 return 0; 624 } 625 626 static int mxt_send_bootloader_cmd(struct mxt_data *data, bool unlock) 627 { 628 u8 buf[2]; 629 630 if (unlock) { 631 buf[0] = MXT_UNLOCK_CMD_LSB; 632 buf[1] = MXT_UNLOCK_CMD_MSB; 633 } else { 634 buf[0] = 0x01; 635 buf[1] = 0x01; 636 } 637 638 return mxt_bootloader_write(data, buf, sizeof(buf)); 639 } 640 641 static bool mxt_wakeup_toggle(struct i2c_client *client, 642 bool wake_up, bool in_i2c) 643 { 644 struct mxt_data *data = i2c_get_clientdata(client); 645 646 switch (data->wakeup_method) { 647 case ATMEL_MXT_WAKEUP_I2C_SCL: 648 if (!in_i2c) 649 return false; 650 break; 651 652 case ATMEL_MXT_WAKEUP_GPIO: 653 if (in_i2c) 654 return false; 655 656 gpiod_set_value(data->wake_gpio, wake_up); 657 break; 658 659 default: 660 return false; 661 } 662 663 if (wake_up) { 664 dev_dbg(&client->dev, "waking up controller\n"); 665 666 msleep(MXT_WAKEUP_TIME); 667 } 668 669 return true; 670 } 671 672 static int __mxt_read_reg(struct i2c_client *client, 673 u16 reg, u16 len, void *val) 674 { 675 struct i2c_msg xfer[2]; 676 bool retried = false; 677 u8 buf[2]; 678 int ret; 679 680 buf[0] = reg & 0xff; 681 buf[1] = (reg >> 8) & 0xff; 682 683 /* Write register */ 684 xfer[0].addr = client->addr; 685 xfer[0].flags = 0; 686 xfer[0].len = 2; 687 xfer[0].buf = buf; 688 689 /* Read data */ 690 xfer[1].addr = client->addr; 691 xfer[1].flags = I2C_M_RD; 692 xfer[1].len = len; 693 xfer[1].buf = val; 694 695 retry: 696 ret = i2c_transfer(client->adapter, xfer, 2); 697 if (ret == 2) { 698 ret = 0; 699 } else if (!retried && mxt_wakeup_toggle(client, true, true)) { 700 retried = true; 701 goto retry; 702 } else { 703 if (ret >= 0) 704 ret = -EIO; 705 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n", 706 __func__, ret); 707 } 708 709 return ret; 710 } 711 712 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len, 713 const void *val) 714 { 715 bool retried = false; 716 size_t count = len + 2; 717 int error; 718 int ret; 719 720 u8 *buf __free(kfree) = kmalloc(count, GFP_KERNEL); 721 if (!buf) 722 return -ENOMEM; 723 724 buf[0] = reg & 0xff; 725 buf[1] = (reg >> 8) & 0xff; 726 memcpy(&buf[2], val, len); 727 728 retry: 729 ret = i2c_master_send(client, buf, count); 730 if (ret == count) 731 return 0; 732 733 if (!retried && mxt_wakeup_toggle(client, true, true)) { 734 retried = true; 735 goto retry; 736 } 737 738 error = ret < 0 ? ret : -EIO; 739 dev_err(&client->dev, "%s: i2c send failed (%d)\n", __func__, error); 740 return error; 741 } 742 743 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val) 744 { 745 return __mxt_write_reg(client, reg, 1, &val); 746 } 747 748 static struct mxt_object * 749 mxt_get_object(struct mxt_data *data, u8 type) 750 { 751 struct mxt_object *object; 752 int i; 753 754 for (i = 0; i < data->info->object_num; i++) { 755 object = data->object_table + i; 756 if (object->type == type) 757 return object; 758 } 759 760 dev_warn(&data->client->dev, "Invalid object type T%u\n", type); 761 return NULL; 762 } 763 764 static void mxt_proc_t6_messages(struct mxt_data *data, u8 *msg) 765 { 766 struct device *dev = &data->client->dev; 767 u8 status = msg[1]; 768 u32 crc = msg[2] | (msg[3] << 8) | (msg[4] << 16); 769 770 if (crc != data->config_crc) { 771 data->config_crc = crc; 772 dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc); 773 } 774 775 complete(&data->crc_completion); 776 777 /* Detect reset */ 778 if (status & MXT_T6_STATUS_RESET) 779 complete(&data->reset_completion); 780 781 /* Output debug if status has changed */ 782 if (status != data->t6_status) 783 dev_dbg(dev, "T6 Status 0x%02X%s%s%s%s%s%s%s\n", 784 status, 785 status == 0 ? " OK" : "", 786 status & MXT_T6_STATUS_RESET ? " RESET" : "", 787 status & MXT_T6_STATUS_OFL ? " OFL" : "", 788 status & MXT_T6_STATUS_SIGERR ? " SIGERR" : "", 789 status & MXT_T6_STATUS_CAL ? " CAL" : "", 790 status & MXT_T6_STATUS_CFGERR ? " CFGERR" : "", 791 status & MXT_T6_STATUS_COMSERR ? " COMSERR" : ""); 792 793 /* Save current status */ 794 data->t6_status = status; 795 } 796 797 static int mxt_write_object(struct mxt_data *data, 798 u8 type, u8 offset, u8 val) 799 { 800 struct mxt_object *object; 801 u16 reg; 802 803 object = mxt_get_object(data, type); 804 if (!object || offset >= mxt_obj_size(object)) 805 return -EINVAL; 806 807 reg = object->start_address; 808 return mxt_write_reg(data->client, reg + offset, val); 809 } 810 811 static void mxt_input_button(struct mxt_data *data, u8 *message) 812 { 813 struct input_dev *input = data->input_dev; 814 int i; 815 816 for (i = 0; i < data->t19_num_keys; i++) { 817 if (data->t19_keymap[i] == KEY_RESERVED) 818 continue; 819 820 /* Active-low switch */ 821 input_report_key(input, data->t19_keymap[i], 822 !(message[1] & BIT(i))); 823 } 824 } 825 826 static void mxt_input_sync(struct mxt_data *data) 827 { 828 input_mt_report_pointer_emulation(data->input_dev, 829 data->t19_num_keys); 830 input_sync(data->input_dev); 831 } 832 833 static void mxt_proc_t9_message(struct mxt_data *data, u8 *message) 834 { 835 struct device *dev = &data->client->dev; 836 struct input_dev *input_dev = data->input_dev; 837 int id; 838 u8 status; 839 int x; 840 int y; 841 int area; 842 int amplitude; 843 844 id = message[0] - data->T9_reportid_min; 845 status = message[1]; 846 x = (message[2] << 4) | ((message[4] >> 4) & 0xf); 847 y = (message[3] << 4) | ((message[4] & 0xf)); 848 849 /* Handle 10/12 bit switching */ 850 if (data->max_x < 1024) 851 x >>= 2; 852 if (data->max_y < 1024) 853 y >>= 2; 854 855 area = message[5]; 856 amplitude = message[6]; 857 858 dev_dbg(dev, 859 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n", 860 id, 861 (status & MXT_T9_DETECT) ? 'D' : '.', 862 (status & MXT_T9_PRESS) ? 'P' : '.', 863 (status & MXT_T9_RELEASE) ? 'R' : '.', 864 (status & MXT_T9_MOVE) ? 'M' : '.', 865 (status & MXT_T9_VECTOR) ? 'V' : '.', 866 (status & MXT_T9_AMP) ? 'A' : '.', 867 (status & MXT_T9_SUPPRESS) ? 'S' : '.', 868 (status & MXT_T9_UNGRIP) ? 'U' : '.', 869 x, y, area, amplitude); 870 871 input_mt_slot(input_dev, id); 872 873 if (status & MXT_T9_DETECT) { 874 /* 875 * Multiple bits may be set if the host is slow to read 876 * the status messages, indicating all the events that 877 * have happened. 878 */ 879 if (status & MXT_T9_RELEASE) { 880 input_mt_report_slot_inactive(input_dev); 881 mxt_input_sync(data); 882 } 883 884 /* if active, pressure must be non-zero */ 885 if (!amplitude) 886 amplitude = MXT_PRESSURE_DEFAULT; 887 888 /* Touch active */ 889 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1); 890 touchscreen_report_pos(input_dev, &data->prop, x, y, true); 891 input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude); 892 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area); 893 } else { 894 /* Touch no longer active, close out slot */ 895 input_mt_report_slot_inactive(input_dev); 896 } 897 898 data->update_input = true; 899 } 900 901 static void mxt_proc_t15_messages(struct mxt_data *data, u8 *message) 902 { 903 struct input_dev *input_dev = data->input_dev; 904 unsigned long keystates = get_unaligned_le32(&message[2]); 905 int key; 906 907 for (key = 0; key < data->t15_num_keys; key++) 908 input_report_key(input_dev, data->t15_keymap[key], 909 keystates & BIT(key)); 910 911 data->update_input = true; 912 } 913 914 static void mxt_proc_t97_messages(struct mxt_data *data, u8 *message) 915 { 916 mxt_proc_t15_messages(data, message); 917 } 918 919 static void mxt_proc_t100_message(struct mxt_data *data, u8 *message) 920 { 921 struct device *dev = &data->client->dev; 922 struct input_dev *input_dev = data->input_dev; 923 int id; 924 u8 status; 925 u8 type = 0; 926 u16 x; 927 u16 y; 928 int distance = 0; 929 int tool = 0; 930 u8 major = 0; 931 u8 pressure = 0; 932 u8 orientation = 0; 933 934 id = message[0] - data->T100_reportid_min - 2; 935 936 /* ignore SCRSTATUS events */ 937 if (id < 0) 938 return; 939 940 status = message[1]; 941 x = get_unaligned_le16(&message[2]); 942 y = get_unaligned_le16(&message[4]); 943 944 if (status & MXT_T100_DETECT) { 945 type = (status & MXT_T100_TYPE_MASK) >> 4; 946 947 switch (type) { 948 case MXT_T100_TYPE_HOVERING_FINGER: 949 tool = MT_TOOL_FINGER; 950 distance = MXT_DISTANCE_HOVERING; 951 952 if (data->t100_aux_vect) 953 orientation = message[data->t100_aux_vect]; 954 955 break; 956 957 case MXT_T100_TYPE_FINGER: 958 case MXT_T100_TYPE_GLOVE: 959 tool = MT_TOOL_FINGER; 960 distance = MXT_DISTANCE_ACTIVE_TOUCH; 961 962 if (data->t100_aux_area) 963 major = message[data->t100_aux_area]; 964 965 if (data->t100_aux_ampl) 966 pressure = message[data->t100_aux_ampl]; 967 968 if (data->t100_aux_vect) 969 orientation = message[data->t100_aux_vect]; 970 971 break; 972 973 case MXT_T100_TYPE_PASSIVE_STYLUS: 974 tool = MT_TOOL_PEN; 975 976 /* 977 * Passive stylus is reported with size zero so 978 * hardcode. 979 */ 980 major = MXT_TOUCH_MAJOR_DEFAULT; 981 982 if (data->t100_aux_ampl) 983 pressure = message[data->t100_aux_ampl]; 984 985 break; 986 987 case MXT_T100_TYPE_LARGE_TOUCH: 988 /* Ignore suppressed touch */ 989 break; 990 991 default: 992 dev_dbg(dev, "Unexpected T100 type\n"); 993 return; 994 } 995 } 996 997 /* 998 * Values reported should be non-zero if tool is touching the 999 * device 1000 */ 1001 if (!pressure && type != MXT_T100_TYPE_HOVERING_FINGER) 1002 pressure = MXT_PRESSURE_DEFAULT; 1003 1004 input_mt_slot(input_dev, id); 1005 1006 if (status & MXT_T100_DETECT) { 1007 dev_dbg(dev, "[%u] type:%u x:%u y:%u a:%02X p:%02X v:%02X\n", 1008 id, type, x, y, major, pressure, orientation); 1009 1010 input_mt_report_slot_state(input_dev, tool, 1); 1011 touchscreen_report_pos(input_dev, &data->prop, x, y, true); 1012 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, major); 1013 input_report_abs(input_dev, ABS_MT_PRESSURE, pressure); 1014 input_report_abs(input_dev, ABS_MT_DISTANCE, distance); 1015 input_report_abs(input_dev, ABS_MT_ORIENTATION, orientation); 1016 } else { 1017 dev_dbg(dev, "[%u] release\n", id); 1018 1019 /* close out slot */ 1020 input_mt_report_slot_inactive(input_dev); 1021 } 1022 1023 data->update_input = true; 1024 } 1025 1026 static int mxt_proc_message(struct mxt_data *data, u8 *message) 1027 { 1028 u8 report_id = message[0]; 1029 1030 if (report_id == MXT_RPTID_NOMSG) 1031 return 0; 1032 1033 if (report_id == data->T6_reportid) { 1034 mxt_proc_t6_messages(data, message); 1035 } else if (!data->input_dev) { 1036 /* 1037 * Do not report events if input device 1038 * is not yet registered. 1039 */ 1040 mxt_dump_message(data, message); 1041 } else if (report_id >= data->T9_reportid_min && 1042 report_id <= data->T9_reportid_max) { 1043 mxt_proc_t9_message(data, message); 1044 } else if (report_id >= data->T15_reportid_min && 1045 report_id <= data->T15_reportid_max) { 1046 mxt_proc_t15_messages(data, message); 1047 } else if (report_id >= data->T97_reportid_min && 1048 report_id <= data->T97_reportid_max) { 1049 mxt_proc_t97_messages(data, message); 1050 } else if (report_id >= data->T100_reportid_min && 1051 report_id <= data->T100_reportid_max) { 1052 mxt_proc_t100_message(data, message); 1053 } else if (report_id == data->T19_reportid) { 1054 mxt_input_button(data, message); 1055 data->update_input = true; 1056 } else { 1057 mxt_dump_message(data, message); 1058 } 1059 1060 return 1; 1061 } 1062 1063 static int mxt_read_and_process_messages(struct mxt_data *data, u8 count) 1064 { 1065 struct device *dev = &data->client->dev; 1066 int ret; 1067 int i; 1068 u8 num_valid = 0; 1069 1070 /* Safety check for msg_buf */ 1071 if (count > data->max_reportid) 1072 return -EINVAL; 1073 1074 /* Process remaining messages if necessary */ 1075 ret = __mxt_read_reg(data->client, data->T5_address, 1076 data->T5_msg_size * count, data->msg_buf); 1077 if (ret) { 1078 dev_err(dev, "Failed to read %u messages (%d)\n", count, ret); 1079 return ret; 1080 } 1081 1082 for (i = 0; i < count; i++) { 1083 ret = mxt_proc_message(data, 1084 data->msg_buf + data->T5_msg_size * i); 1085 1086 if (ret == 1) 1087 num_valid++; 1088 } 1089 1090 /* return number of messages read */ 1091 return num_valid; 1092 } 1093 1094 static irqreturn_t mxt_process_messages_t44(struct mxt_data *data) 1095 { 1096 struct device *dev = &data->client->dev; 1097 int ret; 1098 u8 count, num_left; 1099 1100 /* Read T44 and T5 together */ 1101 ret = __mxt_read_reg(data->client, data->T44_address, 1102 data->T5_msg_size + 1, data->msg_buf); 1103 if (ret) { 1104 dev_err(dev, "Failed to read T44 and T5 (%d)\n", ret); 1105 return IRQ_NONE; 1106 } 1107 1108 count = data->msg_buf[0]; 1109 1110 /* 1111 * This condition may be caused by the CHG line being configured in 1112 * Mode 0. It results in unnecessary I2C operations but it is benign. 1113 */ 1114 if (count == 0) 1115 return IRQ_NONE; 1116 1117 if (count > data->max_reportid) { 1118 dev_warn(dev, "T44 count %d exceeded max report id\n", count); 1119 count = data->max_reportid; 1120 } 1121 1122 /* Process first message */ 1123 ret = mxt_proc_message(data, data->msg_buf + 1); 1124 if (ret < 0) { 1125 dev_warn(dev, "Unexpected invalid message\n"); 1126 return IRQ_NONE; 1127 } 1128 1129 num_left = count - 1; 1130 1131 /* Process remaining messages if necessary */ 1132 if (num_left) { 1133 ret = mxt_read_and_process_messages(data, num_left); 1134 if (ret < 0) 1135 goto end; 1136 else if (ret != num_left) 1137 dev_warn(dev, "Unexpected invalid message\n"); 1138 } 1139 1140 end: 1141 if (data->update_input) { 1142 mxt_input_sync(data); 1143 data->update_input = false; 1144 } 1145 1146 return IRQ_HANDLED; 1147 } 1148 1149 static int mxt_process_messages_until_invalid(struct mxt_data *data) 1150 { 1151 struct device *dev = &data->client->dev; 1152 int count, read; 1153 u8 tries = 2; 1154 1155 count = data->max_reportid; 1156 1157 /* Read messages until we force an invalid */ 1158 do { 1159 read = mxt_read_and_process_messages(data, count); 1160 if (read < count) 1161 return 0; 1162 } while (--tries); 1163 1164 if (data->update_input) { 1165 mxt_input_sync(data); 1166 data->update_input = false; 1167 } 1168 1169 dev_err(dev, "CHG pin isn't cleared\n"); 1170 return -EBUSY; 1171 } 1172 1173 static irqreturn_t mxt_process_messages(struct mxt_data *data) 1174 { 1175 int total_handled, num_handled; 1176 u8 count = data->last_message_count; 1177 1178 if (count < 1 || count > data->max_reportid) 1179 count = 1; 1180 1181 /* include final invalid message */ 1182 total_handled = mxt_read_and_process_messages(data, count + 1); 1183 if (total_handled < 0) 1184 return IRQ_NONE; 1185 /* if there were invalid messages, then we are done */ 1186 else if (total_handled <= count) 1187 goto update_count; 1188 1189 /* keep reading two msgs until one is invalid or reportid limit */ 1190 do { 1191 num_handled = mxt_read_and_process_messages(data, 2); 1192 if (num_handled < 0) 1193 return IRQ_NONE; 1194 1195 total_handled += num_handled; 1196 1197 if (num_handled < 2) 1198 break; 1199 } while (total_handled < data->num_touchids); 1200 1201 update_count: 1202 data->last_message_count = total_handled; 1203 1204 if (data->update_input) { 1205 mxt_input_sync(data); 1206 data->update_input = false; 1207 } 1208 1209 return IRQ_HANDLED; 1210 } 1211 1212 static irqreturn_t mxt_interrupt(int irq, void *dev_id) 1213 { 1214 struct mxt_data *data = dev_id; 1215 1216 if (data->in_bootloader) { 1217 /* bootloader state transition completion */ 1218 complete(&data->bl_completion); 1219 return IRQ_HANDLED; 1220 } 1221 1222 if (!data->object_table) 1223 return IRQ_HANDLED; 1224 1225 if (data->T44_address) { 1226 return mxt_process_messages_t44(data); 1227 } else { 1228 return mxt_process_messages(data); 1229 } 1230 } 1231 1232 static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset, 1233 u8 value, bool wait) 1234 { 1235 u16 reg; 1236 u8 command_register; 1237 int timeout_counter = 0; 1238 int ret; 1239 1240 reg = data->T6_address + cmd_offset; 1241 1242 ret = mxt_write_reg(data->client, reg, value); 1243 if (ret) 1244 return ret; 1245 1246 if (!wait) 1247 return 0; 1248 1249 do { 1250 msleep(20); 1251 ret = __mxt_read_reg(data->client, reg, 1, &command_register); 1252 if (ret) 1253 return ret; 1254 } while (command_register != 0 && timeout_counter++ <= 100); 1255 1256 if (timeout_counter > 100) { 1257 dev_err(&data->client->dev, "Command failed!\n"); 1258 return -EIO; 1259 } 1260 1261 return 0; 1262 } 1263 1264 static int mxt_acquire_irq(struct mxt_data *data) 1265 { 1266 int error; 1267 1268 enable_irq(data->irq); 1269 1270 if (data->use_retrigen_workaround) { 1271 error = mxt_process_messages_until_invalid(data); 1272 if (error) 1273 return error; 1274 } 1275 1276 return 0; 1277 } 1278 1279 static int mxt_soft_reset(struct mxt_data *data) 1280 { 1281 struct device *dev = &data->client->dev; 1282 int ret = 0; 1283 1284 dev_info(dev, "Resetting device\n"); 1285 1286 disable_irq(data->irq); 1287 1288 reinit_completion(&data->reset_completion); 1289 1290 ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false); 1291 if (ret) 1292 return ret; 1293 1294 /* Ignore CHG line for 100ms after reset */ 1295 msleep(MXT_RESET_INVALID_CHG); 1296 1297 mxt_acquire_irq(data); 1298 1299 ret = mxt_wait_for_completion(data, &data->reset_completion, 1300 MXT_RESET_TIMEOUT); 1301 if (ret) 1302 return ret; 1303 1304 return 0; 1305 } 1306 1307 static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value) 1308 { 1309 /* 1310 * On failure, CRC is set to 0 and config will always be 1311 * downloaded. 1312 */ 1313 data->config_crc = 0; 1314 reinit_completion(&data->crc_completion); 1315 1316 mxt_t6_command(data, cmd, value, true); 1317 1318 /* 1319 * Wait for crc message. On failure, CRC is set to 0 and config will 1320 * always be downloaded. 1321 */ 1322 mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT); 1323 } 1324 1325 static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte) 1326 { 1327 static const unsigned int crcpoly = 0x80001B; 1328 u32 result; 1329 u32 data_word; 1330 1331 data_word = (secondbyte << 8) | firstbyte; 1332 result = ((*crc << 1) ^ data_word); 1333 1334 if (result & 0x1000000) 1335 result ^= crcpoly; 1336 1337 *crc = result; 1338 } 1339 1340 static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off) 1341 { 1342 u32 crc = 0; 1343 u8 *ptr = base + start_off; 1344 u8 *last_val = base + end_off - 1; 1345 1346 if (end_off < start_off) 1347 return -EINVAL; 1348 1349 while (ptr < last_val) { 1350 mxt_calc_crc24(&crc, *ptr, *(ptr + 1)); 1351 ptr += 2; 1352 } 1353 1354 /* if len is odd, fill the last byte with 0 */ 1355 if (ptr == last_val) 1356 mxt_calc_crc24(&crc, *ptr, 0); 1357 1358 /* Mask to 24-bit */ 1359 crc &= 0x00FFFFFF; 1360 1361 return crc; 1362 } 1363 1364 static int mxt_check_retrigen(struct mxt_data *data) 1365 { 1366 struct i2c_client *client = data->client; 1367 int error; 1368 int val; 1369 struct irq_data *irqd; 1370 1371 data->use_retrigen_workaround = false; 1372 1373 irqd = irq_get_irq_data(data->irq); 1374 if (!irqd) 1375 return -EINVAL; 1376 1377 if (irqd_is_level_type(irqd)) 1378 return 0; 1379 1380 if (data->T18_address) { 1381 error = __mxt_read_reg(client, 1382 data->T18_address + MXT_COMMS_CTRL, 1383 1, &val); 1384 if (error) 1385 return error; 1386 1387 if (val & MXT_COMMS_RETRIGEN) 1388 return 0; 1389 } 1390 1391 dev_warn(&client->dev, "Enabling RETRIGEN workaround\n"); 1392 data->use_retrigen_workaround = true; 1393 return 0; 1394 } 1395 1396 static int mxt_prepare_cfg_mem(struct mxt_data *data, struct mxt_cfg *cfg) 1397 { 1398 struct device *dev = &data->client->dev; 1399 struct mxt_object *object; 1400 unsigned int type, instance, size, byte_offset; 1401 int offset; 1402 int ret; 1403 int i; 1404 u16 reg; 1405 u8 val; 1406 1407 while (cfg->raw_pos < cfg->raw_size) { 1408 /* Read type, instance, length */ 1409 ret = sscanf(cfg->raw + cfg->raw_pos, "%x %x %x%n", 1410 &type, &instance, &size, &offset); 1411 if (ret == 0) { 1412 /* EOF */ 1413 break; 1414 } else if (ret != 3) { 1415 dev_err(dev, "Bad format: failed to parse object\n"); 1416 return -EINVAL; 1417 } 1418 cfg->raw_pos += offset; 1419 1420 object = mxt_get_object(data, type); 1421 if (!object) { 1422 /* Skip object */ 1423 for (i = 0; i < size; i++) { 1424 ret = sscanf(cfg->raw + cfg->raw_pos, "%hhx%n", 1425 &val, &offset); 1426 if (ret != 1) { 1427 dev_err(dev, "Bad format in T%d at %d\n", 1428 type, i); 1429 return -EINVAL; 1430 } 1431 cfg->raw_pos += offset; 1432 } 1433 continue; 1434 } 1435 1436 if (size > mxt_obj_size(object)) { 1437 /* 1438 * Either we are in fallback mode due to wrong 1439 * config or config from a later fw version, 1440 * or the file is corrupt or hand-edited. 1441 */ 1442 dev_warn(dev, "Discarding %zu byte(s) in T%u\n", 1443 size - mxt_obj_size(object), type); 1444 } else if (mxt_obj_size(object) > size) { 1445 /* 1446 * If firmware is upgraded, new bytes may be added to 1447 * end of objects. It is generally forward compatible 1448 * to zero these bytes - previous behaviour will be 1449 * retained. However this does invalidate the CRC and 1450 * will force fallback mode until the configuration is 1451 * updated. We warn here but do nothing else - the 1452 * malloc has zeroed the entire configuration. 1453 */ 1454 dev_warn(dev, "Zeroing %zu byte(s) in T%d\n", 1455 mxt_obj_size(object) - size, type); 1456 } 1457 1458 if (instance >= mxt_obj_instances(object)) { 1459 dev_err(dev, "Object instances exceeded!\n"); 1460 return -EINVAL; 1461 } 1462 1463 reg = object->start_address + mxt_obj_size(object) * instance; 1464 1465 for (i = 0; i < size; i++) { 1466 ret = sscanf(cfg->raw + cfg->raw_pos, "%hhx%n", 1467 &val, 1468 &offset); 1469 if (ret != 1) { 1470 dev_err(dev, "Bad format in T%d at %d\n", 1471 type, i); 1472 return -EINVAL; 1473 } 1474 cfg->raw_pos += offset; 1475 1476 if (i > mxt_obj_size(object)) 1477 continue; 1478 1479 byte_offset = reg + i - cfg->start_ofs; 1480 1481 if (byte_offset >= 0 && byte_offset < cfg->mem_size) { 1482 *(cfg->mem + byte_offset) = val; 1483 } else { 1484 dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n", 1485 reg, object->type, byte_offset); 1486 return -EINVAL; 1487 } 1488 } 1489 } 1490 1491 return 0; 1492 } 1493 1494 static int mxt_upload_cfg_mem(struct mxt_data *data, struct mxt_cfg *cfg) 1495 { 1496 unsigned int byte_offset = 0; 1497 int error; 1498 1499 /* Write configuration as blocks */ 1500 while (byte_offset < cfg->mem_size) { 1501 unsigned int size = cfg->mem_size - byte_offset; 1502 1503 if (size > MXT_MAX_BLOCK_WRITE) 1504 size = MXT_MAX_BLOCK_WRITE; 1505 1506 error = __mxt_write_reg(data->client, 1507 cfg->start_ofs + byte_offset, 1508 size, cfg->mem + byte_offset); 1509 if (error) { 1510 dev_err(&data->client->dev, 1511 "Config write error, ret=%d\n", error); 1512 return error; 1513 } 1514 1515 byte_offset += size; 1516 } 1517 1518 return 0; 1519 } 1520 1521 static int mxt_init_t7_power_cfg(struct mxt_data *data); 1522 1523 /* 1524 * mxt_update_cfg - download configuration to chip 1525 * 1526 * Atmel Raw Config File Format 1527 * 1528 * The first four lines of the raw config file contain: 1529 * 1) Version 1530 * 2) Chip ID Information (first 7 bytes of device memory) 1531 * 3) Chip Information Block 24-bit CRC Checksum 1532 * 4) Chip Configuration 24-bit CRC Checksum 1533 * 1534 * The rest of the file consists of one line per object instance: 1535 * <TYPE> <INSTANCE> <SIZE> <CONTENTS> 1536 * 1537 * <TYPE> - 2-byte object type as hex 1538 * <INSTANCE> - 2-byte object instance number as hex 1539 * <SIZE> - 2-byte object size as hex 1540 * <CONTENTS> - array of <SIZE> 1-byte hex values 1541 */ 1542 static int mxt_update_cfg(struct mxt_data *data, const struct firmware *fw) 1543 { 1544 struct device *dev = &data->client->dev; 1545 struct mxt_cfg cfg; 1546 int error; 1547 int offset; 1548 int i; 1549 u32 info_crc, config_crc, calculated_crc; 1550 u16 crc_start = 0; 1551 1552 /* Make zero terminated copy of the OBP_RAW file */ 1553 u8 *raw_buf __free(kfree) = cfg.raw = kmemdup_nul(fw->data, fw->size, 1554 GFP_KERNEL); 1555 if (!cfg.raw) 1556 return -ENOMEM; 1557 1558 cfg.raw_size = fw->size; 1559 1560 mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1); 1561 1562 if (strncmp(cfg.raw, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) { 1563 dev_err(dev, "Unrecognised config file\n"); 1564 return -EINVAL; 1565 } 1566 1567 cfg.raw_pos = strlen(MXT_CFG_MAGIC); 1568 1569 /* Load information block and check */ 1570 for (i = 0; i < sizeof(struct mxt_info); i++) { 1571 if (sscanf(cfg.raw + cfg.raw_pos, "%hhx%n", 1572 (unsigned char *)&cfg.info + i, &offset) != 1) { 1573 dev_err(dev, "Bad format\n"); 1574 return -EINVAL; 1575 } 1576 1577 cfg.raw_pos += offset; 1578 } 1579 1580 if (cfg.info.family_id != data->info->family_id) { 1581 dev_err(dev, "Family ID mismatch!\n"); 1582 return -EINVAL; 1583 } 1584 1585 if (cfg.info.variant_id != data->info->variant_id) { 1586 dev_err(dev, "Variant ID mismatch!\n"); 1587 return -EINVAL; 1588 } 1589 1590 /* Read CRCs */ 1591 if (sscanf(cfg.raw + cfg.raw_pos, "%x%n", &info_crc, &offset) != 1) { 1592 dev_err(dev, "Bad format: failed to parse Info CRC\n"); 1593 return -EINVAL; 1594 } 1595 cfg.raw_pos += offset; 1596 1597 if (sscanf(cfg.raw + cfg.raw_pos, "%x%n", &config_crc, &offset) != 1) { 1598 dev_err(dev, "Bad format: failed to parse Config CRC\n"); 1599 return -EINVAL; 1600 } 1601 cfg.raw_pos += offset; 1602 1603 /* 1604 * The Info Block CRC is calculated over mxt_info and the object 1605 * table. If it does not match then we are trying to load the 1606 * configuration from a different chip or firmware version, so 1607 * the configuration CRC is invalid anyway. 1608 */ 1609 if (info_crc == data->info_crc) { 1610 if (config_crc == 0 || data->config_crc == 0) { 1611 dev_info(dev, "CRC zero, attempting to apply config\n"); 1612 } else if (config_crc == data->config_crc) { 1613 dev_dbg(dev, "Config CRC 0x%06X: OK\n", 1614 data->config_crc); 1615 return 0; 1616 } else { 1617 dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n", 1618 data->config_crc, config_crc); 1619 } 1620 } else { 1621 dev_warn(dev, 1622 "Warning: Info CRC error - device=0x%06X file=0x%06X\n", 1623 data->info_crc, info_crc); 1624 } 1625 1626 /* Malloc memory to store configuration */ 1627 cfg.start_ofs = MXT_OBJECT_START + 1628 data->info->object_num * sizeof(struct mxt_object) + 1629 MXT_INFO_CHECKSUM_SIZE; 1630 cfg.mem_size = data->mem_size - cfg.start_ofs; 1631 1632 u8 *mem_buf __free(kfree) = cfg.mem = kzalloc(cfg.mem_size, GFP_KERNEL); 1633 if (!cfg.mem) 1634 return -ENOMEM; 1635 1636 error = mxt_prepare_cfg_mem(data, &cfg); 1637 if (error) 1638 return error; 1639 1640 /* Calculate crc of the received configs (not the raw config file) */ 1641 if (data->T71_address) 1642 crc_start = data->T71_address; 1643 else if (data->T7_address) 1644 crc_start = data->T7_address; 1645 else 1646 dev_warn(dev, "Could not find CRC start\n"); 1647 1648 if (crc_start > cfg.start_ofs) { 1649 calculated_crc = mxt_calculate_crc(cfg.mem, 1650 crc_start - cfg.start_ofs, 1651 cfg.mem_size); 1652 1653 if (config_crc > 0 && config_crc != calculated_crc) 1654 dev_warn(dev, "Config CRC in file inconsistent, calculated=%06X, file=%06X\n", 1655 calculated_crc, config_crc); 1656 } 1657 1658 error = mxt_upload_cfg_mem(data, &cfg); 1659 if (error) 1660 return error; 1661 1662 mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE); 1663 1664 error = mxt_check_retrigen(data); 1665 if (error) 1666 return error; 1667 1668 error = mxt_soft_reset(data); 1669 if (error) 1670 return error; 1671 1672 dev_info(dev, "Config successfully updated\n"); 1673 1674 /* T7 config may have changed */ 1675 mxt_init_t7_power_cfg(data); 1676 1677 return 0; 1678 } 1679 1680 static void mxt_free_input_device(struct mxt_data *data) 1681 { 1682 if (data->input_dev) { 1683 input_unregister_device(data->input_dev); 1684 data->input_dev = NULL; 1685 } 1686 } 1687 1688 static void mxt_free_object_table(struct mxt_data *data) 1689 { 1690 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37 1691 video_unregister_device(&data->dbg.vdev); 1692 v4l2_device_unregister(&data->dbg.v4l2); 1693 #endif 1694 data->object_table = NULL; 1695 data->info = NULL; 1696 kfree(data->raw_info_block); 1697 data->raw_info_block = NULL; 1698 kfree(data->msg_buf); 1699 data->msg_buf = NULL; 1700 data->T5_address = 0; 1701 data->T5_msg_size = 0; 1702 data->T6_reportid = 0; 1703 data->T7_address = 0; 1704 data->T71_address = 0; 1705 data->T9_reportid_min = 0; 1706 data->T9_reportid_max = 0; 1707 data->T15_reportid_min = 0; 1708 data->T15_reportid_max = 0; 1709 data->T18_address = 0; 1710 data->T19_reportid = 0; 1711 data->T44_address = 0; 1712 data->T97_reportid_min = 0; 1713 data->T97_reportid_max = 0; 1714 data->T100_reportid_min = 0; 1715 data->T100_reportid_max = 0; 1716 data->max_reportid = 0; 1717 } 1718 1719 static int mxt_parse_object_table(struct mxt_data *data, 1720 struct mxt_object *object_table) 1721 { 1722 struct i2c_client *client = data->client; 1723 int i; 1724 u8 reportid; 1725 u16 end_address; 1726 1727 /* Valid Report IDs start counting from 1 */ 1728 reportid = 1; 1729 data->mem_size = 0; 1730 for (i = 0; i < data->info->object_num; i++) { 1731 struct mxt_object *object = object_table + i; 1732 u8 min_id, max_id; 1733 1734 le16_to_cpus(&object->start_address); 1735 1736 if (object->num_report_ids) { 1737 min_id = reportid; 1738 reportid += object->num_report_ids * 1739 mxt_obj_instances(object); 1740 max_id = reportid - 1; 1741 } else { 1742 min_id = 0; 1743 max_id = 0; 1744 } 1745 1746 dev_dbg(&data->client->dev, 1747 "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n", 1748 object->type, object->start_address, 1749 mxt_obj_size(object), mxt_obj_instances(object), 1750 min_id, max_id); 1751 1752 switch (object->type) { 1753 case MXT_GEN_MESSAGE_T5: 1754 if (data->info->family_id == 0x80 && 1755 data->info->version < 0x20) { 1756 /* 1757 * On mXT224 firmware versions prior to V2.0 1758 * read and discard unused CRC byte otherwise 1759 * DMA reads are misaligned. 1760 */ 1761 data->T5_msg_size = mxt_obj_size(object); 1762 } else { 1763 /* CRC not enabled, so skip last byte */ 1764 data->T5_msg_size = mxt_obj_size(object) - 1; 1765 } 1766 data->T5_address = object->start_address; 1767 break; 1768 case MXT_GEN_COMMAND_T6: 1769 data->T6_reportid = min_id; 1770 data->T6_address = object->start_address; 1771 break; 1772 case MXT_GEN_POWER_T7: 1773 data->T7_address = object->start_address; 1774 break; 1775 case MXT_SPT_DYNAMICCONFIGURATIONCONTAINER_T71: 1776 data->T71_address = object->start_address; 1777 break; 1778 case MXT_TOUCH_MULTI_T9: 1779 data->multitouch = MXT_TOUCH_MULTI_T9; 1780 /* Only handle messages from first T9 instance */ 1781 data->T9_reportid_min = min_id; 1782 data->T9_reportid_max = min_id + 1783 object->num_report_ids - 1; 1784 data->num_touchids = object->num_report_ids; 1785 break; 1786 case MXT_TOUCH_KEYARRAY_T15: 1787 data->T15_reportid_min = min_id; 1788 data->T15_reportid_max = max_id; 1789 break; 1790 case MXT_SPT_COMMSCONFIG_T18: 1791 data->T18_address = object->start_address; 1792 break; 1793 case MXT_SPT_MESSAGECOUNT_T44: 1794 data->T44_address = object->start_address; 1795 break; 1796 case MXT_SPT_GPIOPWM_T19: 1797 data->T19_reportid = min_id; 1798 break; 1799 case MXT_TOUCH_PTC_KEYS_T97: 1800 data->T97_reportid_min = min_id; 1801 data->T97_reportid_max = max_id; 1802 break; 1803 case MXT_TOUCH_MULTITOUCHSCREEN_T100: 1804 data->multitouch = MXT_TOUCH_MULTITOUCHSCREEN_T100; 1805 data->T100_reportid_min = min_id; 1806 data->T100_reportid_max = max_id; 1807 /* first two report IDs reserved */ 1808 data->num_touchids = object->num_report_ids - 2; 1809 break; 1810 } 1811 1812 end_address = object->start_address 1813 + mxt_obj_size(object) * mxt_obj_instances(object) - 1; 1814 1815 if (end_address >= data->mem_size) 1816 data->mem_size = end_address + 1; 1817 } 1818 1819 /* Store maximum reportid */ 1820 data->max_reportid = reportid; 1821 1822 /* If T44 exists, T5 position has to be directly after */ 1823 if (data->T44_address && (data->T5_address != data->T44_address + 1)) { 1824 dev_err(&client->dev, "Invalid T44 position\n"); 1825 return -EINVAL; 1826 } 1827 1828 data->msg_buf = kcalloc(data->max_reportid, 1829 data->T5_msg_size, GFP_KERNEL); 1830 if (!data->msg_buf) 1831 return -ENOMEM; 1832 1833 return 0; 1834 } 1835 1836 static int mxt_read_info_block(struct mxt_data *data) 1837 { 1838 struct i2c_client *client = data->client; 1839 int error; 1840 size_t size; 1841 uint8_t num_objects; 1842 u32 calculated_crc; 1843 u8 *crc_ptr; 1844 1845 /* If info block already allocated, free it */ 1846 if (data->raw_info_block) 1847 mxt_free_object_table(data); 1848 1849 /* Read 7-byte ID information block starting at address 0 */ 1850 size = sizeof(struct mxt_info); 1851 void *id_buf __free(kfree) = kzalloc(size, GFP_KERNEL); 1852 if (!id_buf) 1853 return -ENOMEM; 1854 1855 error = __mxt_read_reg(client, 0, size, id_buf); 1856 if (error) 1857 return error; 1858 1859 /* Resize buffer to give space for rest of info block */ 1860 num_objects = ((struct mxt_info *)id_buf)->object_num; 1861 size += (num_objects * sizeof(struct mxt_object)) 1862 + MXT_INFO_CHECKSUM_SIZE; 1863 1864 void *buf = krealloc(id_buf, size, GFP_KERNEL); 1865 if (!buf) 1866 return -ENOMEM; 1867 1868 id_buf = buf; 1869 1870 /* Read rest of info block */ 1871 error = __mxt_read_reg(client, MXT_OBJECT_START, 1872 size - MXT_OBJECT_START, 1873 id_buf + MXT_OBJECT_START); 1874 if (error) 1875 return error; 1876 1877 /* Extract & calculate checksum */ 1878 crc_ptr = id_buf + size - MXT_INFO_CHECKSUM_SIZE; 1879 data->info_crc = crc_ptr[0] | (crc_ptr[1] << 8) | (crc_ptr[2] << 16); 1880 1881 calculated_crc = mxt_calculate_crc(id_buf, 0, 1882 size - MXT_INFO_CHECKSUM_SIZE); 1883 1884 /* 1885 * CRC mismatch can be caused by data corruption due to I2C comms 1886 * issue or else device is not using Object Based Protocol (eg i2c-hid) 1887 */ 1888 if ((data->info_crc == 0) || (data->info_crc != calculated_crc)) { 1889 dev_err(&client->dev, 1890 "Info Block CRC error calculated=0x%06X read=0x%06X\n", 1891 calculated_crc, data->info_crc); 1892 return -EIO; 1893 } 1894 1895 data->raw_info_block = no_free_ptr(id_buf); 1896 data->info = (struct mxt_info *)data->raw_info_block; 1897 1898 dev_info(&client->dev, 1899 "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n", 1900 data->info->family_id, data->info->variant_id, 1901 data->info->version >> 4, data->info->version & 0xf, 1902 data->info->build, data->info->object_num); 1903 1904 /* Parse object table information */ 1905 error = mxt_parse_object_table(data, 1906 data->raw_info_block + MXT_OBJECT_START); 1907 if (error) { 1908 dev_err(&client->dev, "Error %d parsing object table\n", error); 1909 mxt_free_object_table(data); 1910 return error; 1911 } 1912 1913 data->object_table = 1914 (struct mxt_object *)(data->raw_info_block + MXT_OBJECT_START); 1915 1916 return 0; 1917 } 1918 1919 static int mxt_read_t9_resolution(struct mxt_data *data) 1920 { 1921 struct i2c_client *client = data->client; 1922 int error; 1923 struct t9_range range; 1924 unsigned char orient; 1925 struct mxt_object *object; 1926 1927 object = mxt_get_object(data, MXT_TOUCH_MULTI_T9); 1928 if (!object) 1929 return -EINVAL; 1930 1931 error = __mxt_read_reg(client, 1932 object->start_address + MXT_T9_XSIZE, 1933 sizeof(data->xsize), &data->xsize); 1934 if (error) 1935 return error; 1936 1937 error = __mxt_read_reg(client, 1938 object->start_address + MXT_T9_YSIZE, 1939 sizeof(data->ysize), &data->ysize); 1940 if (error) 1941 return error; 1942 1943 error = __mxt_read_reg(client, 1944 object->start_address + MXT_T9_RANGE, 1945 sizeof(range), &range); 1946 if (error) 1947 return error; 1948 1949 data->max_x = get_unaligned_le16(&range.x); 1950 data->max_y = get_unaligned_le16(&range.y); 1951 1952 error = __mxt_read_reg(client, 1953 object->start_address + MXT_T9_ORIENT, 1954 1, &orient); 1955 if (error) 1956 return error; 1957 1958 data->xy_switch = orient & MXT_T9_ORIENT_SWITCH; 1959 data->invertx = orient & MXT_T9_ORIENT_INVERTX; 1960 data->inverty = orient & MXT_T9_ORIENT_INVERTY; 1961 1962 return 0; 1963 } 1964 1965 static int mxt_read_t100_config(struct mxt_data *data) 1966 { 1967 struct i2c_client *client = data->client; 1968 int error; 1969 struct mxt_object *object; 1970 u16 range_x, range_y; 1971 u8 cfg, tchaux; 1972 u8 aux; 1973 1974 object = mxt_get_object(data, MXT_TOUCH_MULTITOUCHSCREEN_T100); 1975 if (!object) 1976 return -EINVAL; 1977 1978 /* read touchscreen dimensions */ 1979 error = __mxt_read_reg(client, 1980 object->start_address + MXT_T100_XRANGE, 1981 sizeof(range_x), &range_x); 1982 if (error) 1983 return error; 1984 1985 data->max_x = get_unaligned_le16(&range_x); 1986 1987 error = __mxt_read_reg(client, 1988 object->start_address + MXT_T100_YRANGE, 1989 sizeof(range_y), &range_y); 1990 if (error) 1991 return error; 1992 1993 data->max_y = get_unaligned_le16(&range_y); 1994 1995 error = __mxt_read_reg(client, 1996 object->start_address + MXT_T100_XSIZE, 1997 sizeof(data->xsize), &data->xsize); 1998 if (error) 1999 return error; 2000 2001 error = __mxt_read_reg(client, 2002 object->start_address + MXT_T100_YSIZE, 2003 sizeof(data->ysize), &data->ysize); 2004 if (error) 2005 return error; 2006 2007 /* read orientation config */ 2008 error = __mxt_read_reg(client, 2009 object->start_address + MXT_T100_CFG1, 2010 1, &cfg); 2011 if (error) 2012 return error; 2013 2014 data->xy_switch = cfg & MXT_T100_CFG_SWITCHXY; 2015 data->invertx = cfg & MXT_T100_CFG_INVERTX; 2016 data->inverty = cfg & MXT_T100_CFG_INVERTY; 2017 2018 /* allocate aux bytes */ 2019 error = __mxt_read_reg(client, 2020 object->start_address + MXT_T100_TCHAUX, 2021 1, &tchaux); 2022 if (error) 2023 return error; 2024 2025 aux = 6; 2026 2027 if (tchaux & MXT_T100_TCHAUX_VECT) 2028 data->t100_aux_vect = aux++; 2029 2030 if (tchaux & MXT_T100_TCHAUX_AMPL) 2031 data->t100_aux_ampl = aux++; 2032 2033 if (tchaux & MXT_T100_TCHAUX_AREA) 2034 data->t100_aux_area = aux++; 2035 2036 dev_dbg(&client->dev, 2037 "T100 aux mappings vect:%u ampl:%u area:%u\n", 2038 data->t100_aux_vect, data->t100_aux_ampl, data->t100_aux_area); 2039 2040 return 0; 2041 } 2042 2043 static int mxt_input_open(struct input_dev *dev); 2044 static void mxt_input_close(struct input_dev *dev); 2045 2046 static void mxt_set_up_as_touchpad(struct input_dev *input_dev, 2047 struct mxt_data *data) 2048 { 2049 int i; 2050 2051 input_dev->name = "Atmel maXTouch Touchpad"; 2052 2053 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit); 2054 2055 input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM); 2056 input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM); 2057 input_abs_set_res(input_dev, ABS_MT_POSITION_X, 2058 MXT_PIXELS_PER_MM); 2059 input_abs_set_res(input_dev, ABS_MT_POSITION_Y, 2060 MXT_PIXELS_PER_MM); 2061 2062 for (i = 0; i < data->t19_num_keys; i++) 2063 if (data->t19_keymap[i] != KEY_RESERVED) 2064 input_set_capability(input_dev, EV_KEY, 2065 data->t19_keymap[i]); 2066 } 2067 2068 static int mxt_initialize_input_device(struct mxt_data *data) 2069 { 2070 struct device *dev = &data->client->dev; 2071 struct input_dev *input_dev; 2072 int error; 2073 unsigned int num_mt_slots; 2074 unsigned int mt_flags = 0; 2075 int i; 2076 2077 switch (data->multitouch) { 2078 case MXT_TOUCH_MULTI_T9: 2079 num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1; 2080 error = mxt_read_t9_resolution(data); 2081 if (error) 2082 dev_warn(dev, "Failed to initialize T9 resolution\n"); 2083 break; 2084 2085 case MXT_TOUCH_MULTITOUCHSCREEN_T100: 2086 num_mt_slots = data->num_touchids; 2087 error = mxt_read_t100_config(data); 2088 if (error) 2089 dev_warn(dev, "Failed to read T100 config\n"); 2090 break; 2091 2092 default: 2093 dev_err(dev, "Invalid multitouch object\n"); 2094 return -EINVAL; 2095 } 2096 2097 /* Handle default values and orientation switch */ 2098 if (data->max_x == 0) 2099 data->max_x = 1023; 2100 2101 if (data->max_y == 0) 2102 data->max_y = 1023; 2103 2104 if (data->xy_switch) 2105 swap(data->max_x, data->max_y); 2106 2107 dev_info(dev, "Touchscreen size X%uY%u\n", data->max_x, data->max_y); 2108 2109 /* Register input device */ 2110 input_dev = input_allocate_device(); 2111 if (!input_dev) 2112 return -ENOMEM; 2113 2114 input_dev->name = "Atmel maXTouch Touchscreen"; 2115 input_dev->phys = data->phys; 2116 input_dev->id.bustype = BUS_I2C; 2117 input_dev->dev.parent = dev; 2118 input_dev->open = mxt_input_open; 2119 input_dev->close = mxt_input_close; 2120 2121 input_dev->keycode = data->t15_keymap; 2122 input_dev->keycodemax = data->t15_num_keys; 2123 input_dev->keycodesize = sizeof(data->t15_keymap[0]); 2124 2125 input_set_capability(input_dev, EV_KEY, BTN_TOUCH); 2126 2127 /* For single touch */ 2128 input_set_abs_params(input_dev, ABS_X, 0, data->max_x, 0, 0); 2129 input_set_abs_params(input_dev, ABS_Y, 0, data->max_y, 0, 0); 2130 2131 if (data->multitouch == MXT_TOUCH_MULTI_T9 || 2132 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 && 2133 data->t100_aux_ampl)) { 2134 input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0); 2135 } 2136 2137 /* If device has buttons we assume it is a touchpad */ 2138 if (data->t19_num_keys) { 2139 mxt_set_up_as_touchpad(input_dev, data); 2140 mt_flags |= INPUT_MT_POINTER; 2141 } else { 2142 mt_flags |= INPUT_MT_DIRECT; 2143 } 2144 2145 /* For multi touch */ 2146 error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags); 2147 if (error) { 2148 dev_err(dev, "Error %d initialising slots\n", error); 2149 goto err_free_mem; 2150 } 2151 2152 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100) { 2153 input_set_abs_params(input_dev, ABS_MT_TOOL_TYPE, 2154 0, MT_TOOL_MAX, 0, 0); 2155 input_set_abs_params(input_dev, ABS_MT_DISTANCE, 2156 MXT_DISTANCE_ACTIVE_TOUCH, 2157 MXT_DISTANCE_HOVERING, 2158 0, 0); 2159 } 2160 2161 input_set_abs_params(input_dev, ABS_MT_POSITION_X, 2162 0, data->max_x, 0, 0); 2163 input_set_abs_params(input_dev, ABS_MT_POSITION_Y, 2164 0, data->max_y, 0, 0); 2165 2166 if (data->multitouch == MXT_TOUCH_MULTI_T9 || 2167 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 && 2168 data->t100_aux_area)) { 2169 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR, 2170 0, MXT_MAX_AREA, 0, 0); 2171 } 2172 2173 if (data->multitouch == MXT_TOUCH_MULTI_T9 || 2174 (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 && 2175 data->t100_aux_ampl)) { 2176 input_set_abs_params(input_dev, ABS_MT_PRESSURE, 2177 0, 255, 0, 0); 2178 } 2179 2180 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 && 2181 data->t100_aux_vect) { 2182 input_set_abs_params(input_dev, ABS_MT_ORIENTATION, 2183 0, 255, 0, 0); 2184 } 2185 2186 if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 && 2187 data->t100_aux_vect) { 2188 input_set_abs_params(input_dev, ABS_MT_ORIENTATION, 2189 0, 255, 0, 0); 2190 } 2191 2192 touchscreen_parse_properties(input_dev, true, &data->prop); 2193 2194 /* For T15 and T97 Key Array */ 2195 if (data->T15_reportid_min || data->T97_reportid_min) { 2196 for (i = 0; i < data->t15_num_keys; i++) 2197 input_set_capability(input_dev, 2198 EV_KEY, data->t15_keymap[i]); 2199 } 2200 2201 input_set_drvdata(input_dev, data); 2202 2203 error = input_register_device(input_dev); 2204 if (error) { 2205 dev_err(dev, "Error %d registering input device\n", error); 2206 goto err_free_mem; 2207 } 2208 2209 data->input_dev = input_dev; 2210 2211 return 0; 2212 2213 err_free_mem: 2214 input_free_device(input_dev); 2215 return error; 2216 } 2217 2218 static int mxt_configure_objects(struct mxt_data *data, 2219 const struct firmware *cfg); 2220 2221 static void mxt_config_cb(const struct firmware *cfg, void *ctx) 2222 { 2223 mxt_configure_objects(ctx, cfg); 2224 release_firmware(cfg); 2225 } 2226 2227 static int mxt_initialize(struct mxt_data *data) 2228 { 2229 struct i2c_client *client = data->client; 2230 int recovery_attempts = 0; 2231 int error; 2232 2233 while (1) { 2234 error = mxt_read_info_block(data); 2235 if (!error) 2236 break; 2237 2238 /* Check bootloader state */ 2239 error = mxt_probe_bootloader(data, false); 2240 if (error) { 2241 dev_info(&client->dev, "Trying alternate bootloader address\n"); 2242 error = mxt_probe_bootloader(data, true); 2243 if (error) { 2244 /* Chip is not in appmode or bootloader mode */ 2245 return error; 2246 } 2247 } 2248 2249 /* OK, we are in bootloader, see if we can recover */ 2250 if (++recovery_attempts > 1) { 2251 dev_err(&client->dev, "Could not recover from bootloader mode\n"); 2252 /* 2253 * We can reflash from this state, so do not 2254 * abort initialization. 2255 */ 2256 data->in_bootloader = true; 2257 return 0; 2258 } 2259 2260 /* Attempt to exit bootloader into app mode */ 2261 mxt_send_bootloader_cmd(data, false); 2262 msleep(MXT_FW_RESET_TIME); 2263 } 2264 2265 error = mxt_check_retrigen(data); 2266 if (error) 2267 return error; 2268 2269 error = mxt_acquire_irq(data); 2270 if (error) 2271 return error; 2272 2273 error = request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME, 2274 &client->dev, GFP_KERNEL, data, 2275 mxt_config_cb); 2276 if (error) { 2277 dev_err(&client->dev, "Failed to invoke firmware loader: %d\n", 2278 error); 2279 return error; 2280 } 2281 2282 return 0; 2283 } 2284 2285 static int mxt_set_t7_power_cfg(struct mxt_data *data, u8 sleep) 2286 { 2287 struct device *dev = &data->client->dev; 2288 int error; 2289 struct t7_config *new_config; 2290 struct t7_config deepsleep = { .active = 0, .idle = 0 }; 2291 2292 if (sleep == MXT_POWER_CFG_DEEPSLEEP) 2293 new_config = &deepsleep; 2294 else 2295 new_config = &data->t7_cfg; 2296 2297 error = __mxt_write_reg(data->client, data->T7_address, 2298 sizeof(data->t7_cfg), new_config); 2299 if (error) 2300 return error; 2301 2302 dev_dbg(dev, "Set T7 ACTV:%d IDLE:%d\n", 2303 new_config->active, new_config->idle); 2304 2305 return 0; 2306 } 2307 2308 static int mxt_init_t7_power_cfg(struct mxt_data *data) 2309 { 2310 struct device *dev = &data->client->dev; 2311 int error; 2312 bool retry = false; 2313 2314 recheck: 2315 error = __mxt_read_reg(data->client, data->T7_address, 2316 sizeof(data->t7_cfg), &data->t7_cfg); 2317 if (error) 2318 return error; 2319 2320 if (data->t7_cfg.active == 0 || data->t7_cfg.idle == 0) { 2321 if (!retry) { 2322 dev_dbg(dev, "T7 cfg zero, resetting\n"); 2323 mxt_soft_reset(data); 2324 retry = true; 2325 goto recheck; 2326 } else { 2327 dev_dbg(dev, "T7 cfg zero after reset, overriding\n"); 2328 data->t7_cfg.active = 20; 2329 data->t7_cfg.idle = 100; 2330 return mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN); 2331 } 2332 } 2333 2334 dev_dbg(dev, "Initialized power cfg: ACTV %d, IDLE %d\n", 2335 data->t7_cfg.active, data->t7_cfg.idle); 2336 return 0; 2337 } 2338 2339 #ifdef CONFIG_TOUCHSCREEN_ATMEL_MXT_T37 2340 static const struct v4l2_file_operations mxt_video_fops = { 2341 .owner = THIS_MODULE, 2342 .open = v4l2_fh_open, 2343 .release = vb2_fop_release, 2344 .unlocked_ioctl = video_ioctl2, 2345 .read = vb2_fop_read, 2346 .mmap = vb2_fop_mmap, 2347 .poll = vb2_fop_poll, 2348 }; 2349 2350 static u16 mxt_get_debug_value(struct mxt_data *data, unsigned int x, 2351 unsigned int y) 2352 { 2353 struct mxt_info *info = data->info; 2354 struct mxt_dbg *dbg = &data->dbg; 2355 unsigned int ofs, page; 2356 unsigned int col = 0; 2357 unsigned int col_width; 2358 2359 if (info->family_id == MXT_FAMILY_1386) { 2360 col_width = info->matrix_ysize / MXT1386_COLUMNS; 2361 col = y / col_width; 2362 y = y % col_width; 2363 } else { 2364 col_width = info->matrix_ysize; 2365 } 2366 2367 ofs = (y + (x * col_width)) * sizeof(u16); 2368 page = ofs / MXT_DIAGNOSTIC_SIZE; 2369 ofs %= MXT_DIAGNOSTIC_SIZE; 2370 2371 if (info->family_id == MXT_FAMILY_1386) 2372 page += col * MXT1386_PAGES_PER_COLUMN; 2373 2374 return get_unaligned_le16(&dbg->t37_buf[page].data[ofs]); 2375 } 2376 2377 static int mxt_convert_debug_pages(struct mxt_data *data, u16 *outbuf) 2378 { 2379 struct mxt_dbg *dbg = &data->dbg; 2380 unsigned int x = 0; 2381 unsigned int y = 0; 2382 unsigned int i, rx, ry; 2383 2384 for (i = 0; i < dbg->t37_nodes; i++) { 2385 /* Handle orientation */ 2386 rx = data->xy_switch ? y : x; 2387 ry = data->xy_switch ? x : y; 2388 rx = data->invertx ? (data->xsize - 1 - rx) : rx; 2389 ry = data->inverty ? (data->ysize - 1 - ry) : ry; 2390 2391 outbuf[i] = mxt_get_debug_value(data, rx, ry); 2392 2393 /* Next value */ 2394 if (++x >= (data->xy_switch ? data->ysize : data->xsize)) { 2395 x = 0; 2396 y++; 2397 } 2398 } 2399 2400 return 0; 2401 } 2402 2403 static int mxt_read_diagnostic_debug(struct mxt_data *data, u8 mode, 2404 u16 *outbuf) 2405 { 2406 struct mxt_dbg *dbg = &data->dbg; 2407 int retries = 0; 2408 int page; 2409 int ret; 2410 u8 cmd = mode; 2411 struct t37_debug *p; 2412 u8 cmd_poll; 2413 2414 for (page = 0; page < dbg->t37_pages; page++) { 2415 p = dbg->t37_buf + page; 2416 2417 ret = mxt_write_reg(data->client, dbg->diag_cmd_address, 2418 cmd); 2419 if (ret) 2420 return ret; 2421 2422 retries = 0; 2423 msleep(20); 2424 wait_cmd: 2425 /* Read back command byte */ 2426 ret = __mxt_read_reg(data->client, dbg->diag_cmd_address, 2427 sizeof(cmd_poll), &cmd_poll); 2428 if (ret) 2429 return ret; 2430 2431 /* Field is cleared once the command has been processed */ 2432 if (cmd_poll) { 2433 if (retries++ > 100) 2434 return -EINVAL; 2435 2436 msleep(20); 2437 goto wait_cmd; 2438 } 2439 2440 /* Read T37 page */ 2441 ret = __mxt_read_reg(data->client, dbg->t37_address, 2442 sizeof(struct t37_debug), p); 2443 if (ret) 2444 return ret; 2445 2446 if (p->mode != mode || p->page != page) { 2447 dev_err(&data->client->dev, "T37 page mismatch\n"); 2448 return -EINVAL; 2449 } 2450 2451 dev_dbg(&data->client->dev, "%s page:%d retries:%d\n", 2452 __func__, page, retries); 2453 2454 /* For remaining pages, write PAGEUP rather than mode */ 2455 cmd = MXT_DIAGNOSTIC_PAGEUP; 2456 } 2457 2458 return mxt_convert_debug_pages(data, outbuf); 2459 } 2460 2461 static int mxt_queue_setup(struct vb2_queue *q, 2462 unsigned int *nbuffers, unsigned int *nplanes, 2463 unsigned int sizes[], struct device *alloc_devs[]) 2464 { 2465 struct mxt_data *data = q->drv_priv; 2466 size_t size = data->dbg.t37_nodes * sizeof(u16); 2467 2468 if (*nplanes) 2469 return sizes[0] < size ? -EINVAL : 0; 2470 2471 *nplanes = 1; 2472 sizes[0] = size; 2473 2474 return 0; 2475 } 2476 2477 static void mxt_buffer_queue(struct vb2_buffer *vb) 2478 { 2479 struct mxt_data *data = vb2_get_drv_priv(vb->vb2_queue); 2480 u16 *ptr; 2481 int ret; 2482 u8 mode; 2483 2484 ptr = vb2_plane_vaddr(vb, 0); 2485 if (!ptr) { 2486 dev_err(&data->client->dev, "Error acquiring frame ptr\n"); 2487 goto fault; 2488 } 2489 2490 switch (data->dbg.input) { 2491 case MXT_V4L_INPUT_DELTAS: 2492 default: 2493 mode = MXT_DIAGNOSTIC_DELTAS; 2494 break; 2495 2496 case MXT_V4L_INPUT_REFS: 2497 mode = MXT_DIAGNOSTIC_REFS; 2498 break; 2499 } 2500 2501 ret = mxt_read_diagnostic_debug(data, mode, ptr); 2502 if (ret) 2503 goto fault; 2504 2505 vb2_set_plane_payload(vb, 0, data->dbg.t37_nodes * sizeof(u16)); 2506 vb2_buffer_done(vb, VB2_BUF_STATE_DONE); 2507 return; 2508 2509 fault: 2510 vb2_buffer_done(vb, VB2_BUF_STATE_ERROR); 2511 } 2512 2513 /* V4L2 structures */ 2514 static const struct vb2_ops mxt_queue_ops = { 2515 .queue_setup = mxt_queue_setup, 2516 .buf_queue = mxt_buffer_queue, 2517 }; 2518 2519 static const struct vb2_queue mxt_queue = { 2520 .type = V4L2_BUF_TYPE_VIDEO_CAPTURE, 2521 .io_modes = VB2_MMAP | VB2_USERPTR | VB2_DMABUF | VB2_READ, 2522 .buf_struct_size = sizeof(struct mxt_vb2_buffer), 2523 .ops = &mxt_queue_ops, 2524 .mem_ops = &vb2_vmalloc_memops, 2525 .timestamp_flags = V4L2_BUF_FLAG_TIMESTAMP_MONOTONIC, 2526 .min_queued_buffers = 1, 2527 }; 2528 2529 static int mxt_vidioc_querycap(struct file *file, void *priv, 2530 struct v4l2_capability *cap) 2531 { 2532 struct mxt_data *data = video_drvdata(file); 2533 2534 strscpy(cap->driver, "atmel_mxt_ts", sizeof(cap->driver)); 2535 strscpy(cap->card, "atmel_mxt_ts touch", sizeof(cap->card)); 2536 snprintf(cap->bus_info, sizeof(cap->bus_info), 2537 "I2C:%s", dev_name(&data->client->dev)); 2538 return 0; 2539 } 2540 2541 static int mxt_vidioc_enum_input(struct file *file, void *priv, 2542 struct v4l2_input *i) 2543 { 2544 if (i->index >= MXT_V4L_INPUT_MAX) 2545 return -EINVAL; 2546 2547 i->type = V4L2_INPUT_TYPE_TOUCH; 2548 2549 switch (i->index) { 2550 case MXT_V4L_INPUT_REFS: 2551 strscpy(i->name, "Mutual Capacitance References", 2552 sizeof(i->name)); 2553 break; 2554 case MXT_V4L_INPUT_DELTAS: 2555 strscpy(i->name, "Mutual Capacitance Deltas", sizeof(i->name)); 2556 break; 2557 } 2558 2559 return 0; 2560 } 2561 2562 static int mxt_set_input(struct mxt_data *data, unsigned int i) 2563 { 2564 struct v4l2_pix_format *f = &data->dbg.format; 2565 2566 if (i >= MXT_V4L_INPUT_MAX) 2567 return -EINVAL; 2568 2569 if (i == MXT_V4L_INPUT_DELTAS) 2570 f->pixelformat = V4L2_TCH_FMT_DELTA_TD16; 2571 else 2572 f->pixelformat = V4L2_TCH_FMT_TU16; 2573 2574 f->width = data->xy_switch ? data->ysize : data->xsize; 2575 f->height = data->xy_switch ? data->xsize : data->ysize; 2576 f->field = V4L2_FIELD_NONE; 2577 f->colorspace = V4L2_COLORSPACE_RAW; 2578 f->bytesperline = f->width * sizeof(u16); 2579 f->sizeimage = f->width * f->height * sizeof(u16); 2580 2581 data->dbg.input = i; 2582 2583 return 0; 2584 } 2585 2586 static int mxt_vidioc_s_input(struct file *file, void *priv, unsigned int i) 2587 { 2588 return mxt_set_input(video_drvdata(file), i); 2589 } 2590 2591 static int mxt_vidioc_g_input(struct file *file, void *priv, unsigned int *i) 2592 { 2593 struct mxt_data *data = video_drvdata(file); 2594 2595 *i = data->dbg.input; 2596 2597 return 0; 2598 } 2599 2600 static int mxt_vidioc_fmt(struct file *file, void *priv, struct v4l2_format *f) 2601 { 2602 struct mxt_data *data = video_drvdata(file); 2603 2604 f->type = V4L2_BUF_TYPE_VIDEO_CAPTURE; 2605 f->fmt.pix = data->dbg.format; 2606 2607 return 0; 2608 } 2609 2610 static int mxt_vidioc_enum_fmt(struct file *file, void *priv, 2611 struct v4l2_fmtdesc *fmt) 2612 { 2613 if (fmt->type != V4L2_BUF_TYPE_VIDEO_CAPTURE) 2614 return -EINVAL; 2615 2616 switch (fmt->index) { 2617 case 0: 2618 fmt->pixelformat = V4L2_TCH_FMT_TU16; 2619 break; 2620 2621 case 1: 2622 fmt->pixelformat = V4L2_TCH_FMT_DELTA_TD16; 2623 break; 2624 2625 default: 2626 return -EINVAL; 2627 } 2628 2629 return 0; 2630 } 2631 2632 static int mxt_vidioc_g_parm(struct file *file, void *fh, 2633 struct v4l2_streamparm *a) 2634 { 2635 if (a->type != V4L2_BUF_TYPE_VIDEO_CAPTURE) 2636 return -EINVAL; 2637 2638 a->parm.capture.readbuffers = 1; 2639 a->parm.capture.timeperframe.numerator = 1; 2640 a->parm.capture.timeperframe.denominator = 10; 2641 return 0; 2642 } 2643 2644 static const struct v4l2_ioctl_ops mxt_video_ioctl_ops = { 2645 .vidioc_querycap = mxt_vidioc_querycap, 2646 2647 .vidioc_enum_fmt_vid_cap = mxt_vidioc_enum_fmt, 2648 .vidioc_s_fmt_vid_cap = mxt_vidioc_fmt, 2649 .vidioc_g_fmt_vid_cap = mxt_vidioc_fmt, 2650 .vidioc_try_fmt_vid_cap = mxt_vidioc_fmt, 2651 .vidioc_g_parm = mxt_vidioc_g_parm, 2652 2653 .vidioc_enum_input = mxt_vidioc_enum_input, 2654 .vidioc_g_input = mxt_vidioc_g_input, 2655 .vidioc_s_input = mxt_vidioc_s_input, 2656 2657 .vidioc_reqbufs = vb2_ioctl_reqbufs, 2658 .vidioc_create_bufs = vb2_ioctl_create_bufs, 2659 .vidioc_querybuf = vb2_ioctl_querybuf, 2660 .vidioc_qbuf = vb2_ioctl_qbuf, 2661 .vidioc_dqbuf = vb2_ioctl_dqbuf, 2662 .vidioc_expbuf = vb2_ioctl_expbuf, 2663 2664 .vidioc_streamon = vb2_ioctl_streamon, 2665 .vidioc_streamoff = vb2_ioctl_streamoff, 2666 }; 2667 2668 static const struct video_device mxt_video_device = { 2669 .name = "Atmel maxTouch", 2670 .fops = &mxt_video_fops, 2671 .ioctl_ops = &mxt_video_ioctl_ops, 2672 .release = video_device_release_empty, 2673 .device_caps = V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_TOUCH | 2674 V4L2_CAP_READWRITE | V4L2_CAP_STREAMING, 2675 }; 2676 2677 static void mxt_debug_init(struct mxt_data *data) 2678 { 2679 struct mxt_info *info = data->info; 2680 struct mxt_dbg *dbg = &data->dbg; 2681 struct mxt_object *object; 2682 int error; 2683 2684 object = mxt_get_object(data, MXT_GEN_COMMAND_T6); 2685 if (!object) 2686 goto error; 2687 2688 dbg->diag_cmd_address = object->start_address + MXT_COMMAND_DIAGNOSTIC; 2689 2690 object = mxt_get_object(data, MXT_DEBUG_DIAGNOSTIC_T37); 2691 if (!object) 2692 goto error; 2693 2694 if (mxt_obj_size(object) != sizeof(struct t37_debug)) { 2695 dev_warn(&data->client->dev, "Bad T37 size"); 2696 goto error; 2697 } 2698 2699 dbg->t37_address = object->start_address; 2700 2701 /* Calculate size of data and allocate buffer */ 2702 dbg->t37_nodes = data->xsize * data->ysize; 2703 2704 if (info->family_id == MXT_FAMILY_1386) 2705 dbg->t37_pages = MXT1386_COLUMNS * MXT1386_PAGES_PER_COLUMN; 2706 else 2707 dbg->t37_pages = DIV_ROUND_UP(data->xsize * 2708 info->matrix_ysize * 2709 sizeof(u16), 2710 sizeof(dbg->t37_buf->data)); 2711 2712 dbg->t37_buf = devm_kmalloc_array(&data->client->dev, dbg->t37_pages, 2713 sizeof(struct t37_debug), GFP_KERNEL); 2714 if (!dbg->t37_buf) 2715 goto error; 2716 2717 /* init channel to zero */ 2718 mxt_set_input(data, 0); 2719 2720 /* register video device */ 2721 snprintf(dbg->v4l2.name, sizeof(dbg->v4l2.name), "%s", "atmel_mxt_ts"); 2722 error = v4l2_device_register(&data->client->dev, &dbg->v4l2); 2723 if (error) 2724 goto error; 2725 2726 /* initialize the queue */ 2727 mutex_init(&dbg->lock); 2728 dbg->queue = mxt_queue; 2729 dbg->queue.drv_priv = data; 2730 dbg->queue.lock = &dbg->lock; 2731 dbg->queue.dev = &data->client->dev; 2732 2733 error = vb2_queue_init(&dbg->queue); 2734 if (error) 2735 goto error_unreg_v4l2; 2736 2737 dbg->vdev = mxt_video_device; 2738 dbg->vdev.v4l2_dev = &dbg->v4l2; 2739 dbg->vdev.lock = &dbg->lock; 2740 dbg->vdev.vfl_dir = VFL_DIR_RX; 2741 dbg->vdev.queue = &dbg->queue; 2742 video_set_drvdata(&dbg->vdev, data); 2743 2744 error = video_register_device(&dbg->vdev, VFL_TYPE_TOUCH, -1); 2745 if (error) 2746 goto error_unreg_v4l2; 2747 2748 return; 2749 2750 error_unreg_v4l2: 2751 v4l2_device_unregister(&dbg->v4l2); 2752 error: 2753 dev_warn(&data->client->dev, "Error initializing T37\n"); 2754 } 2755 #else 2756 static void mxt_debug_init(struct mxt_data *data) 2757 { 2758 } 2759 #endif 2760 2761 static int mxt_configure_objects(struct mxt_data *data, 2762 const struct firmware *cfg) 2763 { 2764 struct device *dev = &data->client->dev; 2765 int error; 2766 2767 error = mxt_init_t7_power_cfg(data); 2768 if (error) { 2769 dev_err(dev, "Failed to initialize power cfg\n"); 2770 return error; 2771 } 2772 2773 if (cfg) { 2774 error = mxt_update_cfg(data, cfg); 2775 if (error) 2776 dev_warn(dev, "Error %d updating config\n", error); 2777 } 2778 2779 if (data->multitouch) { 2780 error = mxt_initialize_input_device(data); 2781 if (error) 2782 return error; 2783 } else { 2784 dev_warn(dev, "No touch object detected\n"); 2785 } 2786 2787 mxt_debug_init(data); 2788 2789 return 0; 2790 } 2791 2792 /* Firmware Version is returned as Major.Minor.Build */ 2793 static ssize_t mxt_fw_version_show(struct device *dev, 2794 struct device_attribute *attr, char *buf) 2795 { 2796 struct mxt_data *data = dev_get_drvdata(dev); 2797 struct mxt_info *info = data->info; 2798 return sysfs_emit(buf, "%u.%u.%02X\n", 2799 info->version >> 4, info->version & 0xf, info->build); 2800 } 2801 2802 /* Hardware Version is returned as FamilyID.VariantID */ 2803 static ssize_t mxt_hw_version_show(struct device *dev, 2804 struct device_attribute *attr, char *buf) 2805 { 2806 struct mxt_data *data = dev_get_drvdata(dev); 2807 struct mxt_info *info = data->info; 2808 return sysfs_emit(buf, "%u.%u\n", info->family_id, info->variant_id); 2809 } 2810 2811 static ssize_t mxt_show_instance(char *buf, int count, 2812 struct mxt_object *object, int instance, 2813 const u8 *val) 2814 { 2815 int i; 2816 2817 if (mxt_obj_instances(object) > 1) 2818 count += sysfs_emit_at(buf, count, "Instance %u\n", instance); 2819 2820 for (i = 0; i < mxt_obj_size(object); i++) 2821 count += sysfs_emit_at(buf, count, "\t[%2u]: %02x (%d)\n", 2822 i, val[i], val[i]); 2823 count += sysfs_emit_at(buf, count, "\n"); 2824 2825 return count; 2826 } 2827 2828 static ssize_t mxt_object_show(struct device *dev, 2829 struct device_attribute *attr, char *buf) 2830 { 2831 struct mxt_data *data = dev_get_drvdata(dev); 2832 struct mxt_object *object; 2833 int count = 0; 2834 int i, j; 2835 int error; 2836 u8 *obuf; 2837 2838 /* Pre-allocate buffer large enough to hold max sized object. */ 2839 obuf = kmalloc(256, GFP_KERNEL); 2840 if (!obuf) 2841 return -ENOMEM; 2842 2843 error = 0; 2844 for (i = 0; i < data->info->object_num; i++) { 2845 object = data->object_table + i; 2846 2847 if (!mxt_object_readable(object->type)) 2848 continue; 2849 2850 count += sysfs_emit_at(buf, count, "T%u:\n", object->type); 2851 2852 for (j = 0; j < mxt_obj_instances(object); j++) { 2853 u16 size = mxt_obj_size(object); 2854 u16 addr = object->start_address + j * size; 2855 2856 error = __mxt_read_reg(data->client, addr, size, obuf); 2857 if (error) 2858 goto done; 2859 2860 count = mxt_show_instance(buf, count, object, j, obuf); 2861 } 2862 } 2863 2864 done: 2865 kfree(obuf); 2866 return error ?: count; 2867 } 2868 2869 static int mxt_check_firmware_format(struct device *dev, 2870 const struct firmware *fw) 2871 { 2872 unsigned int pos = 0; 2873 char c; 2874 2875 while (pos < fw->size) { 2876 c = *(fw->data + pos); 2877 2878 if (c < '0' || (c > '9' && c < 'A') || c > 'F') 2879 return 0; 2880 2881 pos++; 2882 } 2883 2884 /* 2885 * To convert file try: 2886 * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw 2887 */ 2888 dev_err(dev, "Aborting: firmware file must be in binary format\n"); 2889 2890 return -EINVAL; 2891 } 2892 2893 static int mxt_flash_fw(struct mxt_data *data, const struct firmware *fw) 2894 { 2895 struct device *dev = &data->client->dev; 2896 unsigned int frame_size; 2897 unsigned int pos = 0; 2898 unsigned int retry = 0; 2899 unsigned int frame = 0; 2900 int error; 2901 2902 reinit_completion(&data->bl_completion); 2903 2904 error = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false); 2905 if (error) { 2906 /* Bootloader may still be unlocked from previous attempt */ 2907 error = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, 2908 false); 2909 if (error) 2910 return error; 2911 } else { 2912 dev_info(dev, "Unlocking bootloader\n"); 2913 2914 /* Unlock bootloader */ 2915 error = mxt_send_bootloader_cmd(data, true); 2916 if (error) 2917 return error; 2918 } 2919 2920 while (pos < fw->size) { 2921 error = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, 2922 true); 2923 if (error) 2924 return error; 2925 2926 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1)); 2927 2928 /* Take account of CRC bytes */ 2929 frame_size += 2; 2930 2931 /* Write one frame to device */ 2932 error = mxt_bootloader_write(data, fw->data + pos, frame_size); 2933 if (error) 2934 return error; 2935 2936 error = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true); 2937 if (error) { 2938 retry++; 2939 2940 /* Back off by 20ms per retry */ 2941 msleep(retry * 20); 2942 2943 if (retry > 20) { 2944 dev_err(dev, "Retry count exceeded\n"); 2945 return error; 2946 } 2947 } else { 2948 retry = 0; 2949 pos += frame_size; 2950 frame++; 2951 } 2952 2953 if (frame % 50 == 0) 2954 dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n", 2955 frame, pos, fw->size); 2956 } 2957 2958 /* Wait for flash. */ 2959 error = mxt_wait_for_completion(data, &data->bl_completion, 2960 MXT_FW_RESET_TIME); 2961 if (error) 2962 return error; 2963 2964 dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos); 2965 2966 /* 2967 * Wait for device to reset. Some bootloader versions do not assert 2968 * the CHG line after bootloading has finished, so ignore potential 2969 * errors. 2970 */ 2971 mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME); 2972 data->in_bootloader = false; 2973 2974 return 0; 2975 } 2976 2977 static int mxt_load_fw(struct device *dev, const char *fn) 2978 { 2979 struct mxt_data *data = dev_get_drvdata(dev); 2980 int retval; 2981 int error; 2982 2983 const struct firmware *fw __free(firmware) = NULL; 2984 error = request_firmware(&fw, fn, dev); 2985 if (error) { 2986 dev_err(dev, "Unable to open firmware %s\n", fn); 2987 return error; 2988 } 2989 2990 /* Check for incorrect enc file */ 2991 error = mxt_check_firmware_format(dev, fw); 2992 if (error) 2993 return error; 2994 2995 if (!data->in_bootloader) { 2996 /* Change to the bootloader mode */ 2997 data->in_bootloader = true; 2998 2999 error = mxt_t6_command(data, MXT_COMMAND_RESET, 3000 MXT_BOOT_VALUE, false); 3001 if (error) 3002 return error; 3003 3004 msleep(MXT_RESET_TIME); 3005 3006 /* Do not need to scan since we know family ID */ 3007 error = mxt_lookup_bootloader_address(data, 0); 3008 if (error) 3009 return error; 3010 3011 mxt_free_input_device(data); 3012 mxt_free_object_table(data); 3013 } else { 3014 enable_irq(data->irq); 3015 } 3016 3017 retval = mxt_flash_fw(data, fw); 3018 3019 disable_irq(data->irq); 3020 3021 return retval; 3022 } 3023 3024 static ssize_t mxt_update_fw_store(struct device *dev, 3025 struct device_attribute *attr, 3026 const char *buf, size_t count) 3027 { 3028 struct mxt_data *data = dev_get_drvdata(dev); 3029 int error; 3030 3031 error = mxt_load_fw(dev, MXT_FW_NAME); 3032 if (error) { 3033 dev_err(dev, "The firmware update failed(%d)\n", error); 3034 count = error; 3035 } else { 3036 dev_info(dev, "The firmware update succeeded\n"); 3037 3038 error = mxt_initialize(data); 3039 if (error) 3040 return error; 3041 } 3042 3043 return count; 3044 } 3045 3046 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL); 3047 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL); 3048 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL); 3049 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store); 3050 3051 static struct attribute *mxt_attrs[] = { 3052 &dev_attr_fw_version.attr, 3053 &dev_attr_hw_version.attr, 3054 &dev_attr_object.attr, 3055 &dev_attr_update_fw.attr, 3056 NULL 3057 }; 3058 3059 ATTRIBUTE_GROUPS(mxt); 3060 3061 static void mxt_start(struct mxt_data *data) 3062 { 3063 mxt_wakeup_toggle(data->client, true, false); 3064 3065 switch (data->suspend_mode) { 3066 case MXT_SUSPEND_T9_CTRL: 3067 mxt_soft_reset(data); 3068 3069 /* Touch enable */ 3070 /* 0x83 = SCANEN | RPTEN | ENABLE */ 3071 mxt_write_object(data, 3072 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0x83); 3073 break; 3074 3075 case MXT_SUSPEND_DEEP_SLEEP: 3076 default: 3077 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN); 3078 3079 /* Recalibrate since chip has been in deep sleep */ 3080 mxt_t6_command(data, MXT_COMMAND_CALIBRATE, 1, false); 3081 break; 3082 } 3083 } 3084 3085 static void mxt_stop(struct mxt_data *data) 3086 { 3087 switch (data->suspend_mode) { 3088 case MXT_SUSPEND_T9_CTRL: 3089 /* Touch disable */ 3090 mxt_write_object(data, 3091 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0); 3092 break; 3093 3094 case MXT_SUSPEND_DEEP_SLEEP: 3095 default: 3096 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_DEEPSLEEP); 3097 break; 3098 } 3099 3100 mxt_wakeup_toggle(data->client, false, false); 3101 } 3102 3103 static int mxt_input_open(struct input_dev *dev) 3104 { 3105 struct mxt_data *data = input_get_drvdata(dev); 3106 3107 mxt_start(data); 3108 3109 return 0; 3110 } 3111 3112 static void mxt_input_close(struct input_dev *dev) 3113 { 3114 struct mxt_data *data = input_get_drvdata(dev); 3115 3116 mxt_stop(data); 3117 } 3118 3119 static int mxt_parse_device_properties(struct mxt_data *data) 3120 { 3121 static const char keymap_property[] = "linux,gpio-keymap"; 3122 static const char buttons_property[] = "linux,keycodes"; 3123 struct device *dev = &data->client->dev; 3124 u32 *keymap; 3125 u32 *buttonmap; 3126 int n_keys; 3127 int error; 3128 3129 if (device_property_present(dev, keymap_property)) { 3130 n_keys = device_property_count_u32(dev, keymap_property); 3131 if (n_keys <= 0) { 3132 error = n_keys < 0 ? n_keys : -EINVAL; 3133 dev_err(dev, "invalid/malformed '%s' property: %d\n", 3134 keymap_property, error); 3135 return error; 3136 } 3137 3138 keymap = devm_kmalloc_array(dev, n_keys, sizeof(*keymap), 3139 GFP_KERNEL); 3140 if (!keymap) 3141 return -ENOMEM; 3142 3143 error = device_property_read_u32_array(dev, keymap_property, 3144 keymap, n_keys); 3145 if (error) { 3146 dev_err(dev, "failed to parse '%s' property: %d\n", 3147 keymap_property, error); 3148 return error; 3149 } 3150 3151 data->t19_keymap = keymap; 3152 data->t19_num_keys = n_keys; 3153 } 3154 3155 if (device_property_present(dev, buttons_property)) { 3156 n_keys = device_property_count_u32(dev, buttons_property); 3157 if (n_keys <= 0) { 3158 error = n_keys < 0 ? n_keys : -EINVAL; 3159 dev_err(dev, "invalid/malformed '%s' property: %d\n", 3160 buttons_property, error); 3161 return error; 3162 } 3163 3164 buttonmap = devm_kmalloc_array(dev, n_keys, sizeof(*buttonmap), 3165 GFP_KERNEL); 3166 if (!buttonmap) 3167 return -ENOMEM; 3168 3169 error = device_property_read_u32_array(dev, buttons_property, 3170 buttonmap, n_keys); 3171 if (error) { 3172 dev_err(dev, "failed to parse '%s' property: %d\n", 3173 buttons_property, error); 3174 return error; 3175 } 3176 3177 data->t15_keymap = buttonmap; 3178 data->t15_num_keys = n_keys; 3179 } 3180 3181 return 0; 3182 } 3183 3184 static const struct dmi_system_id chromebook_T9_suspend_dmi[] = { 3185 { 3186 .matches = { 3187 DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"), 3188 DMI_MATCH(DMI_PRODUCT_NAME, "Link"), 3189 }, 3190 }, 3191 { 3192 .matches = { 3193 DMI_MATCH(DMI_PRODUCT_NAME, "Peppy"), 3194 }, 3195 }, 3196 { } 3197 }; 3198 3199 static int mxt_probe(struct i2c_client *client) 3200 { 3201 struct mxt_data *data; 3202 int error; 3203 3204 /* 3205 * Ignore devices that do not have device properties attached to 3206 * them, as we need help determining whether we are dealing with 3207 * touch screen or touchpad. 3208 * 3209 * So far on x86 the only users of Atmel touch controllers are 3210 * Chromebooks, and chromeos_laptop driver will ensure that 3211 * necessary properties are provided (if firmware does not do that). 3212 */ 3213 if (!device_property_present(&client->dev, "compatible")) 3214 return -ENXIO; 3215 3216 /* 3217 * Ignore ACPI devices representing bootloader mode. 3218 * 3219 * This is a bit of a hack: Google Chromebook BIOS creates ACPI 3220 * devices for both application and bootloader modes, but we are 3221 * interested in application mode only (if device is in bootloader 3222 * mode we'll end up switching into application anyway). So far 3223 * application mode addresses were all above 0x40, so we'll use it 3224 * as a threshold. 3225 */ 3226 if (ACPI_COMPANION(&client->dev) && client->addr < 0x40) 3227 return -ENXIO; 3228 3229 data = devm_kzalloc(&client->dev, sizeof(struct mxt_data), GFP_KERNEL); 3230 if (!data) 3231 return -ENOMEM; 3232 3233 snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0", 3234 client->adapter->nr, client->addr); 3235 3236 data->client = client; 3237 data->irq = client->irq; 3238 i2c_set_clientdata(client, data); 3239 3240 init_completion(&data->bl_completion); 3241 init_completion(&data->reset_completion); 3242 init_completion(&data->crc_completion); 3243 3244 data->suspend_mode = dmi_check_system(chromebook_T9_suspend_dmi) ? 3245 MXT_SUSPEND_T9_CTRL : MXT_SUSPEND_DEEP_SLEEP; 3246 3247 error = mxt_parse_device_properties(data); 3248 if (error) 3249 return error; 3250 3251 /* 3252 * VDDA is the analog voltage supply 2.57..3.47 V 3253 * VDD is the digital voltage supply 1.71..3.47 V 3254 */ 3255 data->regulators[0].supply = "vdda"; 3256 data->regulators[1].supply = "vdd"; 3257 error = devm_regulator_bulk_get(&client->dev, ARRAY_SIZE(data->regulators), 3258 data->regulators); 3259 if (error) { 3260 if (error != -EPROBE_DEFER) 3261 dev_err(&client->dev, "Failed to get regulators %d\n", 3262 error); 3263 return error; 3264 } 3265 3266 /* Request the RESET line as asserted so we go into reset */ 3267 data->reset_gpio = devm_gpiod_get_optional(&client->dev, 3268 "reset", GPIOD_OUT_HIGH); 3269 if (IS_ERR(data->reset_gpio)) { 3270 error = PTR_ERR(data->reset_gpio); 3271 dev_err(&client->dev, "Failed to get reset gpio: %d\n", error); 3272 return error; 3273 } 3274 3275 /* Request the WAKE line as asserted so we go out of sleep */ 3276 data->wake_gpio = devm_gpiod_get_optional(&client->dev, 3277 "wake", GPIOD_OUT_HIGH); 3278 if (IS_ERR(data->wake_gpio)) { 3279 error = PTR_ERR(data->wake_gpio); 3280 dev_err(&client->dev, "Failed to get wake gpio: %d\n", error); 3281 return error; 3282 } 3283 3284 error = devm_request_threaded_irq(&client->dev, client->irq, 3285 NULL, mxt_interrupt, 3286 IRQF_ONESHOT | IRQF_NO_AUTOEN, 3287 client->name, data); 3288 if (error) { 3289 dev_err(&client->dev, "Failed to register interrupt\n"); 3290 return error; 3291 } 3292 3293 error = regulator_bulk_enable(ARRAY_SIZE(data->regulators), 3294 data->regulators); 3295 if (error) { 3296 dev_err(&client->dev, "failed to enable regulators: %d\n", 3297 error); 3298 return error; 3299 } 3300 /* 3301 * The device takes 40ms to come up after power-on according 3302 * to the mXT224 datasheet, page 13. 3303 */ 3304 msleep(MXT_BACKUP_TIME); 3305 3306 if (data->reset_gpio) { 3307 /* Wait a while and then de-assert the RESET GPIO line */ 3308 msleep(MXT_RESET_GPIO_TIME); 3309 gpiod_set_value_cansleep(data->reset_gpio, 0); 3310 msleep(MXT_RESET_INVALID_CHG); 3311 } 3312 3313 /* 3314 * Controllers like mXT1386 have a dedicated WAKE line that could be 3315 * connected to a GPIO or to I2C SCL pin, or permanently asserted low. 3316 * 3317 * This WAKE line is used for waking controller from a deep-sleep and 3318 * it needs to be asserted low for 25 milliseconds before I2C transfers 3319 * could be accepted by controller if it was in a deep-sleep mode. 3320 * Controller will go into sleep automatically after 2 seconds of 3321 * inactivity if WAKE line is deasserted and deep sleep is activated. 3322 * 3323 * If WAKE line is connected to I2C SCL pin, then the first I2C transfer 3324 * will get an instant NAK and transfer needs to be retried after 25ms. 3325 * 3326 * If WAKE line is connected to a GPIO line, the line must be asserted 3327 * 25ms before the host attempts to communicate with the controller. 3328 */ 3329 device_property_read_u32(&client->dev, "atmel,wakeup-method", 3330 &data->wakeup_method); 3331 3332 error = mxt_initialize(data); 3333 if (error) 3334 goto err_disable_regulators; 3335 3336 return 0; 3337 3338 err_disable_regulators: 3339 regulator_bulk_disable(ARRAY_SIZE(data->regulators), 3340 data->regulators); 3341 return error; 3342 } 3343 3344 static void mxt_remove(struct i2c_client *client) 3345 { 3346 struct mxt_data *data = i2c_get_clientdata(client); 3347 3348 disable_irq(data->irq); 3349 mxt_free_input_device(data); 3350 mxt_free_object_table(data); 3351 regulator_bulk_disable(ARRAY_SIZE(data->regulators), 3352 data->regulators); 3353 } 3354 3355 static int mxt_suspend(struct device *dev) 3356 { 3357 struct i2c_client *client = to_i2c_client(dev); 3358 struct mxt_data *data = i2c_get_clientdata(client); 3359 struct input_dev *input_dev = data->input_dev; 3360 3361 if (!input_dev) 3362 return 0; 3363 3364 scoped_guard(mutex, &input_dev->mutex) { 3365 if (input_device_enabled(input_dev)) 3366 mxt_stop(data); 3367 } 3368 3369 disable_irq(data->irq); 3370 3371 return 0; 3372 } 3373 3374 static int mxt_resume(struct device *dev) 3375 { 3376 struct i2c_client *client = to_i2c_client(dev); 3377 struct mxt_data *data = i2c_get_clientdata(client); 3378 struct input_dev *input_dev = data->input_dev; 3379 3380 if (!input_dev) 3381 return 0; 3382 3383 enable_irq(data->irq); 3384 3385 scoped_guard(mutex, &input_dev->mutex) { 3386 if (input_device_enabled(input_dev)) 3387 mxt_start(data); 3388 } 3389 3390 return 0; 3391 } 3392 3393 static DEFINE_SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume); 3394 3395 static const struct of_device_id mxt_of_match[] = { 3396 { .compatible = "atmel,maxtouch", }, 3397 /* Compatibles listed below are deprecated */ 3398 { .compatible = "atmel,qt602240_ts", }, 3399 { .compatible = "atmel,atmel_mxt_ts", }, 3400 { .compatible = "atmel,atmel_mxt_tp", }, 3401 { .compatible = "atmel,mXT224", }, 3402 {}, 3403 }; 3404 MODULE_DEVICE_TABLE(of, mxt_of_match); 3405 3406 #ifdef CONFIG_ACPI 3407 static const struct acpi_device_id mxt_acpi_id[] = { 3408 { "ATML0000", 0 }, /* Touchpad */ 3409 { "ATML0001", 0 }, /* Touchscreen */ 3410 { } 3411 }; 3412 MODULE_DEVICE_TABLE(acpi, mxt_acpi_id); 3413 #endif 3414 3415 static const struct i2c_device_id mxt_id[] = { 3416 { "qt602240_ts" }, 3417 { "atmel_mxt_ts" }, 3418 { "atmel_mxt_tp" }, 3419 { "maxtouch" }, 3420 { "mXT224" }, 3421 { } 3422 }; 3423 MODULE_DEVICE_TABLE(i2c, mxt_id); 3424 3425 static struct i2c_driver mxt_driver = { 3426 .driver = { 3427 .name = "atmel_mxt_ts", 3428 .dev_groups = mxt_groups, 3429 .of_match_table = mxt_of_match, 3430 .acpi_match_table = ACPI_PTR(mxt_acpi_id), 3431 .pm = pm_sleep_ptr(&mxt_pm_ops), 3432 }, 3433 .probe = mxt_probe, 3434 .remove = mxt_remove, 3435 .id_table = mxt_id, 3436 }; 3437 3438 module_i2c_driver(mxt_driver); 3439 3440 /* Module information */ 3441 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>"); 3442 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver"); 3443 MODULE_LICENSE("GPL"); 3444