drivers/input/touchscreen/atmel_mxt_ts.c

   1 /*
   2  * Atmel maXTouch Touchscreen driver
   3  *
   4  * Copyright (C) 2010 Samsung Electronics Co.Ltd
   5  * Copyright (C) 2011-2014 Atmel Corporation
   6  * Copyright (C) 2012 Google, Inc.
   7  *
   8  * Author: Joonyoung Shim <jy0922.shim@samsung.com>
   9  *
  10  * This program is free software; you can redistribute  it and/or modify it
  11  * under  the terms of  the GNU General  Public License as published by the
  12  * Free Software Foundation;  either version 2 of the  License, or (at your
  13  * option) any later version.
  14  *
  15  */
  16
  17 #include <linux/acpi.h>
  18 #include <linux/dmi.h>
  19 #include <linux/module.h>
  20 #include <linux/init.h>
  21 #include <linux/completion.h>
  22 #include <linux/delay.h>
  23 #include <linux/firmware.h>
  24 #include <linux/i2c.h>
  25 #include <linux/platform_data/atmel_mxt_ts.h>
  26 #include <linux/input/mt.h>
  27 #include <linux/interrupt.h>
  28 #include <linux/of.h>
  29 #include <linux/slab.h>
  30 #include <asm/unaligned.h>
  31
  32 /* Firmware files */
  33 #define MXT_FW_NAME             "maxtouch.fw"
  34 #define MXT_CFG_NAME            "maxtouch.cfg"
  35 #define MXT_CFG_MAGIC           "OBP_RAW V1"
  36
  37 /* Registers */
  38 #define MXT_OBJECT_START        0x07
  39 #define MXT_OBJECT_SIZE         6
  40 #define MXT_INFO_CHECKSUM_SIZE  3
  41 #define MXT_MAX_BLOCK_WRITE     256
  42
  43 /* Object types */
  44 #define MXT_DEBUG_DIAGNOSTIC_T37        37
  45 #define MXT_GEN_MESSAGE_T5              5
  46 #define MXT_GEN_COMMAND_T6              6
  47 #define MXT_GEN_POWER_T7                7
  48 #define MXT_GEN_ACQUIRE_T8              8
  49 #define MXT_GEN_DATASOURCE_T53          53
  50 #define MXT_TOUCH_MULTI_T9              9
  51 #define MXT_TOUCH_KEYARRAY_T15          15
  52 #define MXT_TOUCH_PROXIMITY_T23         23
  53 #define MXT_TOUCH_PROXKEY_T52           52
  54 #define MXT_PROCI_GRIPFACE_T20          20
  55 #define MXT_PROCG_NOISE_T22             22
  56 #define MXT_PROCI_ONETOUCH_T24          24
  57 #define MXT_PROCI_TWOTOUCH_T27          27
  58 #define MXT_PROCI_GRIP_T40              40
  59 #define MXT_PROCI_PALM_T41              41
  60 #define MXT_PROCI_TOUCHSUPPRESSION_T42  42
  61 #define MXT_PROCI_STYLUS_T47            47
  62 #define MXT_PROCG_NOISESUPPRESSION_T48  48
  63 #define MXT_SPT_COMMSCONFIG_T18         18
  64 #define MXT_SPT_GPIOPWM_T19             19
  65 #define MXT_SPT_SELFTEST_T25            25
  66 #define MXT_SPT_CTECONFIG_T28           28
  67 #define MXT_SPT_USERDATA_T38            38
  68 #define MXT_SPT_DIGITIZER_T43           43
  69 #define MXT_SPT_MESSAGECOUNT_T44        44
  70 #define MXT_SPT_CTECONFIG_T46           46
  71 #define MXT_TOUCH_MULTITOUCHSCREEN_T100 100
  72
  73 /* MXT_GEN_MESSAGE_T5 object */
  74 #define MXT_RPTID_NOMSG         0xff
  75
  76 /* MXT_GEN_COMMAND_T6 field */
  77 #define MXT_COMMAND_RESET       0
  78 #define MXT_COMMAND_BACKUPNV    1
  79 #define MXT_COMMAND_CALIBRATE   2
  80 #define MXT_COMMAND_REPORTALL   3
  81 #define MXT_COMMAND_DIAGNOSTIC  5
  82
  83 /* Define for T6 status byte */
  84 #define MXT_T6_STATUS_RESET     (1 << 7)
  85 #define MXT_T6_STATUS_OFL       (1 << 6)
  86 #define MXT_T6_STATUS_SIGERR    (1 << 5)
  87 #define MXT_T6_STATUS_CAL       (1 << 4)
  88 #define MXT_T6_STATUS_CFGERR    (1 << 3)
  89 #define MXT_T6_STATUS_COMSERR   (1 << 2)
  90
  91 /* MXT_GEN_POWER_T7 field */
  92 struct t7_config {
  93         u8 idle;
  94         u8 active;
  95 } __packed;
  96
  97 #define MXT_POWER_CFG_RUN               0
  98 #define MXT_POWER_CFG_DEEPSLEEP         1
  99
 100 /* MXT_TOUCH_MULTI_T9 field */
 101 #define MXT_T9_CTRL             0
 102 #define MXT_T9_ORIENT           9
 103 #define MXT_T9_RANGE            18
 104
 105 /* MXT_TOUCH_MULTI_T9 status */
 106 #define MXT_T9_UNGRIP           (1 << 0)
 107 #define MXT_T9_SUPPRESS         (1 << 1)
 108 #define MXT_T9_AMP              (1 << 2)
 109 #define MXT_T9_VECTOR           (1 << 3)
 110 #define MXT_T9_MOVE             (1 << 4)
 111 #define MXT_T9_RELEASE          (1 << 5)
 112 #define MXT_T9_PRESS            (1 << 6)
 113 #define MXT_T9_DETECT           (1 << 7)
 114
 115 struct t9_range {
 116         u16 x;
 117         u16 y;
 118 } __packed;
 119
 120 /* MXT_TOUCH_MULTI_T9 orient */
 121 #define MXT_T9_ORIENT_SWITCH    (1 << 0)
 122
 123 /* MXT_SPT_COMMSCONFIG_T18 */
 124 #define MXT_COMMS_CTRL          0
 125 #define MXT_COMMS_CMD           1
 126
 127 /* Define for MXT_GEN_COMMAND_T6 */
 128 #define MXT_BOOT_VALUE          0xa5
 129 #define MXT_RESET_VALUE         0x01
 130 #define MXT_BACKUP_VALUE        0x55
 131
 132 /* T100 Multiple Touch Touchscreen */
 133 #define MXT_T100_CTRL           0
 134 #define MXT_T100_CFG1           1
 135 #define MXT_T100_TCHAUX         3
 136 #define MXT_T100_XRANGE         13
 137 #define MXT_T100_YRANGE         24
 138
 139 #define MXT_T100_CFG_SWITCHXY   BIT(5)
 140
 141 #define MXT_T100_TCHAUX_VECT    BIT(0)
 142 #define MXT_T100_TCHAUX_AMPL    BIT(1)
 143 #define MXT_T100_TCHAUX_AREA    BIT(2)
 144
 145 #define MXT_T100_DETECT         BIT(7)
 146 #define MXT_T100_TYPE_MASK      0x70
 147
 148 enum t100_type {
 149         MXT_T100_TYPE_FINGER            = 1,
 150         MXT_T100_TYPE_PASSIVE_STYLUS    = 2,
 151         MXT_T100_TYPE_HOVERING_FINGER   = 4,
 152         MXT_T100_TYPE_GLOVE             = 5,
 153         MXT_T100_TYPE_LARGE_TOUCH       = 6,
 154 };
 155
 156 #define MXT_DISTANCE_ACTIVE_TOUCH       0
 157 #define MXT_DISTANCE_HOVERING           1
 158
 159 #define MXT_TOUCH_MAJOR_DEFAULT         1
 160 #define MXT_PRESSURE_DEFAULT            1
 161
 162 /* Delay times */
 163 #define MXT_BACKUP_TIME         50      /* msec */
 164 #define MXT_RESET_TIME          200     /* msec */
 165 #define MXT_RESET_TIMEOUT       3000    /* msec */
 166 #define MXT_CRC_TIMEOUT         1000    /* msec */
 167 #define MXT_FW_RESET_TIME       3000    /* msec */
 168 #define MXT_FW_CHG_TIMEOUT      300     /* msec */
 169
 170 /* Command to unlock bootloader */
 171 #define MXT_UNLOCK_CMD_MSB      0xaa
 172 #define MXT_UNLOCK_CMD_LSB      0xdc
 173
 174 /* Bootloader mode status */
 175 #define MXT_WAITING_BOOTLOAD_CMD        0xc0    /* valid 7 6 bit only */
 176 #define MXT_WAITING_FRAME_DATA  0x80    /* valid 7 6 bit only */
 177 #define MXT_FRAME_CRC_CHECK     0x02
 178 #define MXT_FRAME_CRC_FAIL      0x03
 179 #define MXT_FRAME_CRC_PASS      0x04
 180 #define MXT_APP_CRC_FAIL        0x40    /* valid 7 8 bit only */
 181 #define MXT_BOOT_STATUS_MASK    0x3f
 182 #define MXT_BOOT_EXTENDED_ID    (1 << 5)
 183 #define MXT_BOOT_ID_MASK        0x1f
 184
 185 /* Touchscreen absolute values */
 186 #define MXT_MAX_AREA            0xff
 187
 188 #define MXT_PIXELS_PER_MM       20
 189
 190 struct mxt_info {
 191         u8 family_id;
 192         u8 variant_id;
 193         u8 version;
 194         u8 build;
 195         u8 matrix_xsize;
 196         u8 matrix_ysize;
 197         u8 object_num;
 198 };
 199
 200 struct mxt_object {
 201         u8 type;
 202         u16 start_address;
 203         u8 size_minus_one;
 204         u8 instances_minus_one;
 205         u8 num_report_ids;
 206 } __packed;
 207
 208 /* Each client has this additional data */
 209 struct mxt_data {
 210         struct i2c_client *client;
 211         struct input_dev *input_dev;
 212         char phys[64];          /* device physical location */
 213         const struct mxt_platform_data *pdata;
 214         struct mxt_object *object_table;
 215         struct mxt_info info;
 216         unsigned int irq;
 217         unsigned int max_x;
 218         unsigned int max_y;
 219         bool in_bootloader;
 220         u16 mem_size;
 221         u8 t100_aux_ampl;
 222         u8 t100_aux_area;
 223         u8 t100_aux_vect;
 224         u8 max_reportid;
 225         u32 config_crc;
 226         u32 info_crc;
 227         u8 bootloader_addr;
 228         u8 *msg_buf;
 229         u8 t6_status;
 230         bool update_input;
 231         u8 last_message_count;
 232         u8 num_touchids;
 233         u8 multitouch;
 234         struct t7_config t7_cfg;
 235
 236         /* Cached parameters from object table */
 237         u16 T5_address;
 238         u8 T5_msg_size;
 239         u8 T6_reportid;
 240         u16 T6_address;
 241         u16 T7_address;
 242         u8 T9_reportid_min;
 243         u8 T9_reportid_max;
 244         u8 T19_reportid;
 245         u16 T44_address;
 246         u8 T100_reportid_min;
 247         u8 T100_reportid_max;
 248
 249         /* for fw update in bootloader */
 250         struct completion bl_completion;
 251
 252         /* for reset handling */
 253         struct completion reset_completion;
 254
 255         /* for config update handling */
 256         struct completion crc_completion;
 257 };
 258
 259 static size_t mxt_obj_size(const struct mxt_object *obj)
 260 {
 261         return obj->size_minus_one + 1;
 262 }
 263
 264 static size_t mxt_obj_instances(const struct mxt_object *obj)
 265 {
 266         return obj->instances_minus_one + 1;
 267 }
 268
 269 static bool mxt_object_readable(unsigned int type)
 270 {
 271         switch (type) {
 272         case MXT_GEN_COMMAND_T6:
 273         case MXT_GEN_POWER_T7:
 274         case MXT_GEN_ACQUIRE_T8:
 275         case MXT_GEN_DATASOURCE_T53:
 276         case MXT_TOUCH_MULTI_T9:
 277         case MXT_TOUCH_KEYARRAY_T15:
 278         case MXT_TOUCH_PROXIMITY_T23:
 279         case MXT_TOUCH_PROXKEY_T52:
 280         case MXT_PROCI_GRIPFACE_T20:
 281         case MXT_PROCG_NOISE_T22:
 282         case MXT_PROCI_ONETOUCH_T24:
 283         case MXT_PROCI_TWOTOUCH_T27:
 284         case MXT_PROCI_GRIP_T40:
 285         case MXT_PROCI_PALM_T41:
 286         case MXT_PROCI_TOUCHSUPPRESSION_T42:
 287         case MXT_PROCI_STYLUS_T47:
 288         case MXT_PROCG_NOISESUPPRESSION_T48:
 289         case MXT_SPT_COMMSCONFIG_T18:
 290         case MXT_SPT_GPIOPWM_T19:
 291         case MXT_SPT_SELFTEST_T25:
 292         case MXT_SPT_CTECONFIG_T28:
 293         case MXT_SPT_USERDATA_T38:
 294         case MXT_SPT_DIGITIZER_T43:
 295         case MXT_SPT_CTECONFIG_T46:
 296                 return true;
 297         default:
 298                 return false;
 299         }
 300 }
 301
 302 static void mxt_dump_message(struct mxt_data *data, u8 *message)
 303 {
 304         dev_dbg(&data->client->dev, "message: %*ph\n",
 305                 data->T5_msg_size, message);
 306 }
 307
 308 static int mxt_wait_for_completion(struct mxt_data *data,
 309                                    struct completion *comp,
 310                                    unsigned int timeout_ms)
 311 {
 312         struct device *dev = &data->client->dev;
 313         unsigned long timeout = msecs_to_jiffies(timeout_ms);
 314         long ret;
 315
 316         ret = wait_for_completion_interruptible_timeout(comp, timeout);
 317         if (ret < 0) {
 318                 return ret;
 319         } else if (ret == 0) {
 320                 dev_err(dev, "Wait for completion timed out.\n");
 321                 return -ETIMEDOUT;
 322         }
 323         return 0;
 324 }
 325
 326 static int mxt_bootloader_read(struct mxt_data *data,
 327                                u8 *val, unsigned int count)
 328 {
 329         int ret;
 330         struct i2c_msg msg;
 331
 332         msg.addr = data->bootloader_addr;
 333         msg.flags = data->client->flags & I2C_M_TEN;
 334         msg.flags |= I2C_M_RD;
 335         msg.len = count;
 336         msg.buf = val;
 337
 338         ret = i2c_transfer(data->client->adapter, &msg, 1);
 339         if (ret == 1) {
 340                 ret = 0;
 341         } else {
 342                 ret = ret < 0 ? ret : -EIO;
 343                 dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
 344                         __func__, ret);
 345         }
 346
 347         return ret;
 348 }
 349
 350 static int mxt_bootloader_write(struct mxt_data *data,
 351                                 const u8 * const val, unsigned int count)
 352 {
 353         int ret;
 354         struct i2c_msg msg;
 355
 356         msg.addr = data->bootloader_addr;
 357         msg.flags = data->client->flags & I2C_M_TEN;
 358         msg.len = count;
 359         msg.buf = (u8 *)val;
 360
 361         ret = i2c_transfer(data->client->adapter, &msg, 1);
 362         if (ret == 1) {
 363                 ret = 0;
 364         } else {
 365                 ret = ret < 0 ? ret : -EIO;
 366                 dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
 367                         __func__, ret);
 368         }
 369
 370         return ret;
 371 }
 372
 373 static int mxt_lookup_bootloader_address(struct mxt_data *data, bool retry)
 374 {
 375         u8 appmode = data->client->addr;
 376         u8 bootloader;
 377
 378         switch (appmode) {
 379         case 0x4a:
 380         case 0x4b:
 381                 /* Chips after 1664S use different scheme */
 382                 if (retry || data->info.family_id >= 0xa2) {
 383                         bootloader = appmode - 0x24;
 384                         break;
 385                 }
 386                 /* Fall through for normal case */
 387         case 0x4c:
 388         case 0x4d:
 389         case 0x5a:
 390         case 0x5b:
 391                 bootloader = appmode - 0x26;
 392                 break;
 393
 394         default:
 395                 dev_err(&data->client->dev,
 396                         "Appmode i2c address 0x%02x not found\n",
 397                         appmode);
 398                 return -EINVAL;
 399         }
 400
 401         data->bootloader_addr = bootloader;
 402         return 0;
 403 }
 404
 405 static int mxt_probe_bootloader(struct mxt_data *data, bool alt_address)
 406 {
 407         struct device *dev = &data->client->dev;
 408         int error;
 409         u8 val;
 410         bool crc_failure;
 411
 412         error = mxt_lookup_bootloader_address(data, alt_address);
 413         if (error)
 414                 return error;
 415
 416         error = mxt_bootloader_read(data, &val, 1);
 417         if (error)
 418                 return error;
 419
 420         /* Check app crc fail mode */
 421         crc_failure = (val & ~MXT_BOOT_STATUS_MASK) == MXT_APP_CRC_FAIL;
 422
 423         dev_err(dev, "Detected bootloader, status:%02X%s\n",
 424                         val, crc_failure ? ", APP_CRC_FAIL" : "");
 425
 426         return 0;
 427 }
 428
 429 static u8 mxt_get_bootloader_version(struct mxt_data *data, u8 val)
 430 {
 431         struct device *dev = &data->client->dev;
 432         u8 buf[3];
 433
 434         if (val & MXT_BOOT_EXTENDED_ID) {
 435                 if (mxt_bootloader_read(data, &buf[0], 3) != 0) {
 436                         dev_err(dev, "%s: i2c failure\n", __func__);
 437                         return val;
 438                 }
 439
 440                 dev_dbg(dev, "Bootloader ID:%d Version:%d\n", buf[1], buf[2]);
 441
 442                 return buf[0];
 443         } else {
 444                 dev_dbg(dev, "Bootloader ID:%d\n", val & MXT_BOOT_ID_MASK);
 445
 446                 return val;
 447         }
 448 }
 449
 450 static int mxt_check_bootloader(struct mxt_data *data, unsigned int state,
 451                                 bool wait)
 452 {
 453         struct device *dev = &data->client->dev;
 454         u8 val;
 455         int ret;
 456
 457 recheck:
 458         if (wait) {
 459                 /*
 460                  * In application update mode, the interrupt
 461                  * line signals state transitions. We must wait for the
 462                  * CHG assertion before reading the status byte.
 463                  * Once the status byte has been read, the line is deasserted.
 464                  */
 465                 ret = mxt_wait_for_completion(data, &data->bl_completion,
 466                                               MXT_FW_CHG_TIMEOUT);
 467                 if (ret) {
 468                         /*
 469                          * TODO: handle -ERESTARTSYS better by terminating
 470                          * fw update process before returning to userspace
 471                          * by writing length 0x000 to device (iff we are in
 472                          * WAITING_FRAME_DATA state).
 473                          */
 474                         dev_err(dev, "Update wait error %d\n", ret);
 475                         return ret;
 476                 }
 477         }
 478
 479         ret = mxt_bootloader_read(data, &val, 1);
 480         if (ret)
 481                 return ret;
 482
 483         if (state == MXT_WAITING_BOOTLOAD_CMD)
 484                 val = mxt_get_bootloader_version(data, val);
 485
 486         switch (state) {
 487         case MXT_WAITING_BOOTLOAD_CMD:
 488         case MXT_WAITING_FRAME_DATA:
 489         case MXT_APP_CRC_FAIL:
 490                 val &= ~MXT_BOOT_STATUS_MASK;
 491                 break;
 492         case MXT_FRAME_CRC_PASS:
 493                 if (val == MXT_FRAME_CRC_CHECK) {
 494                         goto recheck;
 495                 } else if (val == MXT_FRAME_CRC_FAIL) {
 496                         dev_err(dev, "Bootloader CRC fail\n");
 497                         return -EINVAL;
 498                 }
 499                 break;
 500         default:
 501                 return -EINVAL;
 502         }
 503
 504         if (val != state) {
 505                 dev_err(dev, "Invalid bootloader state %02X != %02X\n",
 506                         val, state);
 507                 return -EINVAL;
 508         }
 509
 510         return 0;
 511 }
 512
 513 static int mxt_send_bootloader_cmd(struct mxt_data *data, bool unlock)
 514 {
 515         int ret;
 516         u8 buf[2];
 517
 518         if (unlock) {
 519                 buf[0] = MXT_UNLOCK_CMD_LSB;
 520                 buf[1] = MXT_UNLOCK_CMD_MSB;
 521         } else {
 522                 buf[0] = 0x01;
 523                 buf[1] = 0x01;
 524         }
 525
 526         ret = mxt_bootloader_write(data, buf, 2);
 527         if (ret)
 528                 return ret;
 529
 530         return 0;
 531 }
 532
 533 static int __mxt_read_reg(struct i2c_client *client,
 534                                u16 reg, u16 len, void *val)
 535 {
 536         struct i2c_msg xfer[2];
 537         u8 buf[2];
 538         int ret;
 539
 540         buf[0] = reg & 0xff;
 541         buf[1] = (reg >> 8) & 0xff;
 542
 543         /* Write register */
 544         xfer[0].addr = client->addr;
 545         xfer[0].flags = 0;
 546         xfer[0].len = 2;
 547         xfer[0].buf = buf;
 548
 549         /* Read data */
 550         xfer[1].addr = client->addr;
 551         xfer[1].flags = I2C_M_RD;
 552         xfer[1].len = len;
 553         xfer[1].buf = val;
 554
 555         ret = i2c_transfer(client->adapter, xfer, 2);
 556         if (ret == 2) {
 557                 ret = 0;
 558         } else {
 559                 if (ret >= 0)
 560                         ret = -EIO;
 561                 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
 562                         __func__, ret);
 563         }
 564
 565         return ret;
 566 }
 567
 568 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
 569                            const void *val)
 570 {
 571         u8 *buf;
 572         size_t count;
 573         int ret;
 574
 575         count = len + 2;
 576         buf = kmalloc(count, GFP_KERNEL);
 577         if (!buf)
 578                 return -ENOMEM;
 579
 580         buf[0] = reg & 0xff;
 581         buf[1] = (reg >> 8) & 0xff;
 582         memcpy(&buf[2], val, len);
 583
 584         ret = i2c_master_send(client, buf, count);
 585         if (ret == count) {
 586                 ret = 0;
 587         } else {
 588                 if (ret >= 0)
 589                         ret = -EIO;
 590                 dev_err(&client->dev, "%s: i2c send failed (%d)\n",
 591                         __func__, ret);
 592         }
 593
 594         kfree(buf);
 595         return ret;
 596 }
 597
 598 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
 599 {
 600         return __mxt_write_reg(client, reg, 1, &val);
 601 }
 602
 603 static struct mxt_object *
 604 mxt_get_object(struct mxt_data *data, u8 type)
 605 {
 606         struct mxt_object *object;
 607         int i;
 608
 609         for (i = 0; i < data->info.object_num; i++) {
 610                 object = data->object_table + i;
 611                 if (object->type == type)
 612                         return object;
 613         }
 614
 615         dev_warn(&data->client->dev, "Invalid object type T%u\n", type);
 616         return NULL;
 617 }
 618
 619 static void mxt_proc_t6_messages(struct mxt_data *data, u8 *msg)
 620 {
 621         struct device *dev = &data->client->dev;
 622         u8 status = msg[1];
 623         u32 crc = msg[2] | (msg[3] << 8) | (msg[4] << 16);
 624
 625         complete(&data->crc_completion);
 626
 627         if (crc != data->config_crc) {
 628                 data->config_crc = crc;
 629                 dev_dbg(dev, "T6 Config Checksum: 0x%06X\n", crc);
 630         }
 631
 632         /* Detect reset */
 633         if (status & MXT_T6_STATUS_RESET)
 634                 complete(&data->reset_completion);
 635
 636         /* Output debug if status has changed */
 637         if (status != data->t6_status)
 638                 dev_dbg(dev, "T6 Status 0x%02X%s%s%s%s%s%s%s\n",
 639                         status,
 640                         status == 0 ? " OK" : "",
 641                         status & MXT_T6_STATUS_RESET ? " RESET" : "",
 642                         status & MXT_T6_STATUS_OFL ? " OFL" : "",
 643                         status & MXT_T6_STATUS_SIGERR ? " SIGERR" : "",
 644                         status & MXT_T6_STATUS_CAL ? " CAL" : "",
 645                         status & MXT_T6_STATUS_CFGERR ? " CFGERR" : "",
 646                         status & MXT_T6_STATUS_COMSERR ? " COMSERR" : "");
 647
 648         /* Save current status */
 649         data->t6_status = status;
 650 }
 651
 652 static int mxt_write_object(struct mxt_data *data,
 653                                  u8 type, u8 offset, u8 val)
 654 {
 655         struct mxt_object *object;
 656         u16 reg;
 657
 658         object = mxt_get_object(data, type);
 659         if (!object || offset >= mxt_obj_size(object))
 660                 return -EINVAL;
 661
 662         reg = object->start_address;
 663         return mxt_write_reg(data->client, reg + offset, val);
 664 }
 665
 666 static void mxt_input_button(struct mxt_data *data, u8 *message)
 667 {
 668         struct input_dev *input = data->input_dev;
 669         const struct mxt_platform_data *pdata = data->pdata;
 670         int i;
 671
 672         for (i = 0; i < pdata->t19_num_keys; i++) {
 673                 if (pdata->t19_keymap[i] == KEY_RESERVED)
 674                         continue;
 675
 676                 /* Active-low switch */
 677                 input_report_key(input, pdata->t19_keymap[i],
 678                                  !(message[1] & BIT(i)));
 679         }
 680 }
 681
 682 static void mxt_input_sync(struct mxt_data *data)
 683 {
 684         input_mt_report_pointer_emulation(data->input_dev,
 685                                           data->pdata->t19_num_keys);
 686         input_sync(data->input_dev);
 687 }
 688
 689 static void mxt_proc_t9_message(struct mxt_data *data, u8 *message)
 690 {
 691         struct device *dev = &data->client->dev;
 692         struct input_dev *input_dev = data->input_dev;
 693         int id;
 694         u8 status;
 695         int x;
 696         int y;
 697         int area;
 698         int amplitude;
 699
 700         id = message[0] - data->T9_reportid_min;
 701         status = message[1];
 702         x = (message[2] << 4) | ((message[4] >> 4) & 0xf);
 703         y = (message[3] << 4) | ((message[4] & 0xf));
 704
 705         /* Handle 10/12 bit switching */
 706         if (data->max_x < 1024)
 707                 x >>= 2;
 708         if (data->max_y < 1024)
 709                 y >>= 2;
 710
 711         area = message[5];
 712         amplitude = message[6];
 713
 714         dev_dbg(dev,
 715                 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
 716                 id,
 717                 (status & MXT_T9_DETECT) ? 'D' : '.',
 718                 (status & MXT_T9_PRESS) ? 'P' : '.',
 719                 (status & MXT_T9_RELEASE) ? 'R' : '.',
 720                 (status & MXT_T9_MOVE) ? 'M' : '.',
 721                 (status & MXT_T9_VECTOR) ? 'V' : '.',
 722                 (status & MXT_T9_AMP) ? 'A' : '.',
 723                 (status & MXT_T9_SUPPRESS) ? 'S' : '.',
 724                 (status & MXT_T9_UNGRIP) ? 'U' : '.',
 725                 x, y, area, amplitude);
 726
 727         input_mt_slot(input_dev, id);
 728
 729         if (status & MXT_T9_DETECT) {
 730                 /*
 731                  * Multiple bits may be set if the host is slow to read
 732                  * the status messages, indicating all the events that
 733                  * have happened.
 734                  */
 735                 if (status & MXT_T9_RELEASE) {
 736                         input_mt_report_slot_state(input_dev,
 737                                                    MT_TOOL_FINGER, 0);
 738                         mxt_input_sync(data);
 739                 }
 740
 741                 /* Touch active */
 742                 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
 743                 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
 744                 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
 745                 input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
 746                 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
 747         } else {
 748                 /* Touch no longer active, close out slot */
 749                 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 0);
 750         }
 751
 752         data->update_input = true;
 753 }
 754
 755 static void mxt_proc_t100_message(struct mxt_data *data, u8 *message)
 756 {
 757         struct device *dev = &data->client->dev;
 758         struct input_dev *input_dev = data->input_dev;
 759         int id;
 760         u8 status;
 761         u8 type = 0;
 762         u16 x;
 763         u16 y;
 764         int distance = 0;
 765         int tool = 0;
 766         u8 major = 0;
 767         u8 pressure = 0;
 768         u8 orientation = 0;
 769
 770         id = message[0] - data->T100_reportid_min - 2;
 771
 772         /* ignore SCRSTATUS events */
 773         if (id < 0)
 774                 return;
 775
 776         status = message[1];
 777         x = get_unaligned_le16(&message[2]);
 778         y = get_unaligned_le16(&message[4]);
 779
 780         if (status & MXT_T100_DETECT) {
 781                 type = (status & MXT_T100_TYPE_MASK) >> 4;
 782
 783                 switch (type) {
 784                 case MXT_T100_TYPE_HOVERING_FINGER:
 785                         tool = MT_TOOL_FINGER;
 786                         distance = MXT_DISTANCE_HOVERING;
 787
 788                         if (data->t100_aux_vect)
 789                                 orientation = message[data->t100_aux_vect];
 790
 791                         break;
 792
 793                 case MXT_T100_TYPE_FINGER:
 794                 case MXT_T100_TYPE_GLOVE:
 795                         tool = MT_TOOL_FINGER;
 796                         distance = MXT_DISTANCE_ACTIVE_TOUCH;
 797
 798                         if (data->t100_aux_area)
 799                                 major = message[data->t100_aux_area];
 800
 801                         if (data->t100_aux_ampl)
 802                                 pressure = message[data->t100_aux_ampl];
 803
 804                         if (data->t100_aux_vect)
 805                                 orientation = message[data->t100_aux_vect];
 806
 807                         break;
 808
 809                 case MXT_T100_TYPE_PASSIVE_STYLUS:
 810                         tool = MT_TOOL_PEN;
 811
 812                         /*
 813                          * Passive stylus is reported with size zero so
 814                          * hardcode.
 815                          */
 816                         major = MXT_TOUCH_MAJOR_DEFAULT;
 817
 818                         if (data->t100_aux_ampl)
 819                                 pressure = message[data->t100_aux_ampl];
 820
 821                         break;
 822
 823                 case MXT_T100_TYPE_LARGE_TOUCH:
 824                         /* Ignore suppressed touch */
 825                         break;
 826
 827                 default:
 828                         dev_dbg(dev, "Unexpected T100 type\n");
 829                         return;
 830                 }
 831         }
 832
 833         /*
 834          * Values reported should be non-zero if tool is touching the
 835          * device
 836          */
 837         if (!pressure && type != MXT_T100_TYPE_HOVERING_FINGER)
 838                 pressure = MXT_PRESSURE_DEFAULT;
 839
 840         input_mt_slot(input_dev, id);
 841
 842         if (status & MXT_T100_DETECT) {
 843                 dev_dbg(dev, "[%u] type:%u x:%u y:%u a:%02X p:%02X v:%02X\n",
 844                         id, type, x, y, major, pressure, orientation);
 845
 846                 input_mt_report_slot_state(input_dev, tool, 1);
 847                 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
 848                 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
 849                 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, major);
 850                 input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
 851                 input_report_abs(input_dev, ABS_MT_DISTANCE, distance);
 852                 input_report_abs(input_dev, ABS_MT_ORIENTATION, orientation);
 853         } else {
 854                 dev_dbg(dev, "[%u] release\n", id);
 855
 856                 /* close out slot */
 857                 input_mt_report_slot_state(input_dev, 0, 0);
 858         }
 859
 860         data->update_input = true;
 861 }
 862
 863 static int mxt_proc_message(struct mxt_data *data, u8 *message)
 864 {
 865         u8 report_id = message[0];
 866
 867         if (report_id == MXT_RPTID_NOMSG)
 868                 return 0;
 869
 870         if (report_id == data->T6_reportid) {
 871                 mxt_proc_t6_messages(data, message);
 872         } else if (!data->input_dev) {
 873                 /*
 874                  * Do not report events if input device
 875                  * is not yet registered.
 876                  */
 877                 mxt_dump_message(data, message);
 878         } else if (report_id >= data->T9_reportid_min &&
 879                    report_id <= data->T9_reportid_max) {
 880                 mxt_proc_t9_message(data, message);
 881         } else if (report_id >= data->T100_reportid_min &&
 882                    report_id <= data->T100_reportid_max) {
 883                 mxt_proc_t100_message(data, message);
 884         } else if (report_id == data->T19_reportid) {
 885                 mxt_input_button(data, message);
 886                 data->update_input = true;
 887         } else {
 888                 mxt_dump_message(data, message);
 889         }
 890
 891         return 1;
 892 }
 893
 894 static int mxt_read_and_process_messages(struct mxt_data *data, u8 count)
 895 {
 896         struct device *dev = &data->client->dev;
 897         int ret;
 898         int i;
 899         u8 num_valid = 0;
 900
 901         /* Safety check for msg_buf */
 902         if (count > data->max_reportid)
 903                 return -EINVAL;
 904
 905         /* Process remaining messages if necessary */
 906         ret = __mxt_read_reg(data->client, data->T5_address,
 907                                 data->T5_msg_size * count, data->msg_buf);
 908         if (ret) {
 909                 dev_err(dev, "Failed to read %u messages (%d)\n", count, ret);
 910                 return ret;
 911         }
 912
 913         for (i = 0;  i < count; i++) {
 914                 ret = mxt_proc_message(data,
 915                         data->msg_buf + data->T5_msg_size * i);
 916
 917                 if (ret == 1)
 918                         num_valid++;
 919         }
 920
 921         /* return number of messages read */
 922         return num_valid;
 923 }
 924
 925 static irqreturn_t mxt_process_messages_t44(struct mxt_data *data)
 926 {
 927         struct device *dev = &data->client->dev;
 928         int ret;
 929         u8 count, num_left;
 930
 931         /* Read T44 and T5 together */
 932         ret = __mxt_read_reg(data->client, data->T44_address,
 933                 data->T5_msg_size + 1, data->msg_buf);
 934         if (ret) {
 935                 dev_err(dev, "Failed to read T44 and T5 (%d)\n", ret);
 936                 return IRQ_NONE;
 937         }
 938
 939         count = data->msg_buf[0];
 940
 941         if (count == 0) {
 942                 /*
 943                  * This condition is caused by the CHG line being configured
 944                  * in Mode 0. It results in unnecessary I2C operations but it
 945                  * is benign.
 946                  */
 947                 dev_dbg(dev, "Interrupt triggered but zero messages\n");
 948                 return IRQ_NONE;
 949         } else if (count > data->max_reportid) {
 950                 dev_err(dev, "T44 count %d exceeded max report id\n", count);
 951                 count = data->max_reportid;
 952         }
 953
 954         /* Process first message */
 955         ret = mxt_proc_message(data, data->msg_buf + 1);
 956         if (ret < 0) {
 957                 dev_warn(dev, "Unexpected invalid message\n");
 958                 return IRQ_NONE;
 959         }
 960
 961         num_left = count - 1;
 962
 963         /* Process remaining messages if necessary */
 964         if (num_left) {
 965                 ret = mxt_read_and_process_messages(data, num_left);
 966                 if (ret < 0)
 967                         goto end;
 968                 else if (ret != num_left)
 969                         dev_warn(dev, "Unexpected invalid message\n");
 970         }
 971
 972 end:
 973         if (data->update_input) {
 974                 mxt_input_sync(data);
 975                 data->update_input = false;
 976         }
 977
 978         return IRQ_HANDLED;
 979 }
 980
 981 static int mxt_process_messages_until_invalid(struct mxt_data *data)
 982 {
 983         struct device *dev = &data->client->dev;
 984         int count, read;
 985         u8 tries = 2;
 986
 987         count = data->max_reportid;
 988
 989         /* Read messages until we force an invalid */
 990         do {
 991                 read = mxt_read_and_process_messages(data, count);
 992                 if (read < count)
 993                         return 0;
 994         } while (--tries);
 995
 996         if (data->update_input) {
 997                 mxt_input_sync(data);
 998                 data->update_input = false;
 999         }
1000
1001         dev_err(dev, "CHG pin isn't cleared\n");
1002         return -EBUSY;
1003 }
1004
1005 static irqreturn_t mxt_process_messages(struct mxt_data *data)
1006 {
1007         int total_handled, num_handled;
1008         u8 count = data->last_message_count;
1009
1010         if (count < 1 || count > data->max_reportid)
1011                 count = 1;
1012
1013         /* include final invalid message */
1014         total_handled = mxt_read_and_process_messages(data, count + 1);
1015         if (total_handled < 0)
1016                 return IRQ_NONE;
1017         /* if there were invalid messages, then we are done */
1018         else if (total_handled <= count)
1019                 goto update_count;
1020
1021         /* keep reading two msgs until one is invalid or reportid limit */
1022         do {
1023                 num_handled = mxt_read_and_process_messages(data, 2);
1024                 if (num_handled < 0)
1025                         return IRQ_NONE;
1026
1027                 total_handled += num_handled;
1028
1029                 if (num_handled < 2)
1030                         break;
1031         } while (total_handled < data->num_touchids);
1032
1033 update_count:
1034         data->last_message_count = total_handled;
1035
1036         if (data->update_input) {
1037                 mxt_input_sync(data);
1038                 data->update_input = false;
1039         }
1040
1041         return IRQ_HANDLED;
1042 }
1043
1044 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
1045 {
1046         struct mxt_data *data = dev_id;
1047
1048         if (data->in_bootloader) {
1049                 /* bootloader state transition completion */
1050                 complete(&data->bl_completion);
1051                 return IRQ_HANDLED;
1052         }
1053
1054         if (!data->object_table)
1055                 return IRQ_HANDLED;
1056
1057         if (data->T44_address) {
1058                 return mxt_process_messages_t44(data);
1059         } else {
1060                 return mxt_process_messages(data);
1061         }
1062 }
1063
1064 static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
1065                           u8 value, bool wait)
1066 {
1067         u16 reg;
1068         u8 command_register;
1069         int timeout_counter = 0;
1070         int ret;
1071
1072         reg = data->T6_address + cmd_offset;
1073
1074         ret = mxt_write_reg(data->client, reg, value);
1075         if (ret)
1076                 return ret;
1077
1078         if (!wait)
1079                 return 0;
1080
1081         do {
1082                 msleep(20);
1083                 ret = __mxt_read_reg(data->client, reg, 1, &command_register);
1084                 if (ret)
1085                         return ret;
1086         } while (command_register != 0 && timeout_counter++ <= 100);
1087
1088         if (timeout_counter > 100) {
1089                 dev_err(&data->client->dev, "Command failed!\n");
1090                 return -EIO;
1091         }
1092
1093         return 0;
1094 }
1095
1096 static int mxt_soft_reset(struct mxt_data *data)
1097 {
1098         struct device *dev = &data->client->dev;
1099         int ret = 0;
1100
1101         dev_info(dev, "Resetting device\n");
1102
1103         disable_irq(data->irq);
1104
1105         reinit_completion(&data->reset_completion);
1106
1107         ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
1108         if (ret)
1109                 return ret;
1110
1111         /* Ignore CHG line for 100ms after reset */
1112         msleep(100);
1113
1114         enable_irq(data->irq);
1115
1116         ret = mxt_wait_for_completion(data, &data->reset_completion,
1117                                       MXT_RESET_TIMEOUT);
1118         if (ret)
1119                 return ret;
1120
1121         return 0;
1122 }
1123
1124 static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
1125 {
1126         /*
1127          * On failure, CRC is set to 0 and config will always be
1128          * downloaded.
1129          */
1130         data->config_crc = 0;
1131         reinit_completion(&data->crc_completion);
1132
1133         mxt_t6_command(data, cmd, value, true);
1134
1135         /*
1136          * Wait for crc message. On failure, CRC is set to 0 and config will
1137          * always be downloaded.
1138          */
1139         mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
1140 }
1141
1142 static void mxt_calc_crc24(u32 *crc, u8 firstbyte, u8 secondbyte)
1143 {
1144         static const unsigned int crcpoly = 0x80001B;
1145         u32 result;
1146         u32 data_word;
1147
1148         data_word = (secondbyte << 8) | firstbyte;
1149         result = ((*crc << 1) ^ data_word);
1150
1151         if (result & 0x1000000)
1152                 result ^= crcpoly;
1153
1154         *crc = result;
1155 }
1156
1157 static u32 mxt_calculate_crc(u8 *base, off_t start_off, off_t end_off)
1158 {
1159         u32 crc = 0;
1160         u8 *ptr = base + start_off;
1161         u8 *last_val = base + end_off - 1;
1162
1163         if (end_off < start_off)
1164                 return -EINVAL;
1165
1166         while (ptr < last_val) {
1167                 mxt_calc_crc24(&crc, *ptr, *(ptr + 1));
1168                 ptr += 2;
1169         }
1170
1171         /* if len is odd, fill the last byte with 0 */
1172         if (ptr == last_val)
1173                 mxt_calc_crc24(&crc, *ptr, 0);
1174
1175         /* Mask to 24-bit */
1176         crc &= 0x00FFFFFF;
1177
1178         return crc;
1179 }
1180
1181 static int mxt_prepare_cfg_mem(struct mxt_data *data,
1182                                const struct firmware *cfg,
1183                                unsigned int data_pos,
1184                                unsigned int cfg_start_ofs,
1185                                u8 *config_mem,
1186                                size_t config_mem_size)
1187 {
1188         struct device *dev = &data->client->dev;
1189         struct mxt_object *object;
1190         unsigned int type, instance, size, byte_offset;
1191         int offset;
1192         int ret;
1193         int i;
1194         u16 reg;
1195         u8 val;
1196
1197         while (data_pos < cfg->size) {
1198                 /* Read type, instance, length */
1199                 ret = sscanf(cfg->data + data_pos, "%x %x %x%n",
1200                              &type, &instance, &size, &offset);
1201                 if (ret == 0) {
1202                         /* EOF */
1203                         break;
1204                 } else if (ret != 3) {
1205                         dev_err(dev, "Bad format: failed to parse object\n");
1206                         return -EINVAL;
1207                 }
1208                 data_pos += offset;
1209
1210                 object = mxt_get_object(data, type);
1211                 if (!object) {
1212                         /* Skip object */
1213                         for (i = 0; i < size; i++) {
1214                                 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1215                                              &val, &offset);
1216                                 if (ret != 1) {
1217                                         dev_err(dev, "Bad format in T%d at %d\n",
1218                                                 type, i);
1219                                         return -EINVAL;
1220                                 }
1221                                 data_pos += offset;
1222                         }
1223                         continue;
1224                 }
1225
1226                 if (size > mxt_obj_size(object)) {
1227                         /*
1228                          * Either we are in fallback mode due to wrong
1229                          * config or config from a later fw version,
1230                          * or the file is corrupt or hand-edited.
1231                          */
1232                         dev_warn(dev, "Discarding %zu byte(s) in T%u\n",
1233                                  size - mxt_obj_size(object), type);
1234                 } else if (mxt_obj_size(object) > size) {
1235                         /*
1236                          * If firmware is upgraded, new bytes may be added to
1237                          * end of objects. It is generally forward compatible
1238                          * to zero these bytes - previous behaviour will be
1239                          * retained. However this does invalidate the CRC and
1240                          * will force fallback mode until the configuration is
1241                          * updated. We warn here but do nothing else - the
1242                          * malloc has zeroed the entire configuration.
1243                          */
1244                         dev_warn(dev, "Zeroing %zu byte(s) in T%d\n",
1245                                  mxt_obj_size(object) - size, type);
1246                 }
1247
1248                 if (instance >= mxt_obj_instances(object)) {
1249                         dev_err(dev, "Object instances exceeded!\n");
1250                         return -EINVAL;
1251                 }
1252
1253                 reg = object->start_address + mxt_obj_size(object) * instance;
1254
1255                 for (i = 0; i < size; i++) {
1256                         ret = sscanf(cfg->data + data_pos, "%hhx%n",
1257                                      &val,
1258                                      &offset);
1259                         if (ret != 1) {
1260                                 dev_err(dev, "Bad format in T%d at %d\n",
1261                                         type, i);
1262                                 return -EINVAL;
1263                         }
1264                         data_pos += offset;
1265
1266                         if (i > mxt_obj_size(object))
1267                                 continue;
1268
1269                         byte_offset = reg + i - cfg_start_ofs;
1270
1271                         if (byte_offset >= 0 && byte_offset < config_mem_size) {
1272                                 *(config_mem + byte_offset) = val;
1273                         } else {
1274                                 dev_err(dev, "Bad object: reg:%d, T%d, ofs=%d\n",
1275                                         reg, object->type, byte_offset);
1276                                 return -EINVAL;
1277                         }
1278                 }
1279         }
1280
1281         return 0;
1282 }
1283
1284 static int mxt_upload_cfg_mem(struct mxt_data *data, unsigned int cfg_start,
1285                               u8 *config_mem, size_t config_mem_size)
1286 {
1287         unsigned int byte_offset = 0;
1288         int error;
1289
1290         /* Write configuration as blocks */
1291         while (byte_offset < config_mem_size) {
1292                 unsigned int size = config_mem_size - byte_offset;
1293
1294                 if (size > MXT_MAX_BLOCK_WRITE)
1295                         size = MXT_MAX_BLOCK_WRITE;
1296
1297                 error = __mxt_write_reg(data->client,
1298                                         cfg_start + byte_offset,
1299                                         size, config_mem + byte_offset);
1300                 if (error) {
1301                         dev_err(&data->client->dev,
1302                                 "Config write error, ret=%d\n", error);
1303                         return error;
1304                 }
1305
1306                 byte_offset += size;
1307         }
1308
1309         return 0;
1310 }
1311
1312 static int mxt_init_t7_power_cfg(struct mxt_data *data);
1313
1314 /*
1315  * mxt_update_cfg - download configuration to chip
1316  *
1317  * Atmel Raw Config File Format
1318  *
1319  * The first four lines of the raw config file contain:
1320  *  1) Version
1321  *  2) Chip ID Information (first 7 bytes of device memory)
1322  *  3) Chip Information Block 24-bit CRC Checksum
1323  *  4) Chip Configuration 24-bit CRC Checksum
1324  *
1325  * The rest of the file consists of one line per object instance:
1326  *   <TYPE> <INSTANCE> <SIZE> <CONTENTS>
1327  *
1328  *   <TYPE> - 2-byte object type as hex
1329  *   <INSTANCE> - 2-byte object instance number as hex
1330  *   <SIZE> - 2-byte object size as hex
1331  *   <CONTENTS> - array of <SIZE> 1-byte hex values
1332  */
1333 static int mxt_update_cfg(struct mxt_data *data, const struct firmware *cfg)
1334 {
1335         struct device *dev = &data->client->dev;
1336         struct mxt_info cfg_info;
1337         int ret;
1338         int offset;
1339         int data_pos;
1340         int i;
1341         int cfg_start_ofs;
1342         u32 info_crc, config_crc, calculated_crc;
1343         u8 *config_mem;
1344         size_t config_mem_size;
1345
1346         mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
1347
1348         if (strncmp(cfg->data, MXT_CFG_MAGIC, strlen(MXT_CFG_MAGIC))) {
1349                 dev_err(dev, "Unrecognised config file\n");
1350                 return -EINVAL;
1351         }
1352
1353         data_pos = strlen(MXT_CFG_MAGIC);
1354
1355         /* Load information block and check */
1356         for (i = 0; i < sizeof(struct mxt_info); i++) {
1357                 ret = sscanf(cfg->data + data_pos, "%hhx%n",
1358                              (unsigned char *)&cfg_info + i,
1359                              &offset);
1360                 if (ret != 1) {
1361                         dev_err(dev, "Bad format\n");
1362                         return -EINVAL;
1363                 }
1364
1365                 data_pos += offset;
1366         }
1367
1368         if (cfg_info.family_id != data->info.family_id) {
1369                 dev_err(dev, "Family ID mismatch!\n");
1370                 return -EINVAL;
1371         }
1372
1373         if (cfg_info.variant_id != data->info.variant_id) {
1374                 dev_err(dev, "Variant ID mismatch!\n");
1375                 return -EINVAL;
1376         }
1377
1378         /* Read CRCs */
1379         ret = sscanf(cfg->data + data_pos, "%x%n", &info_crc, &offset);
1380         if (ret != 1) {
1381                 dev_err(dev, "Bad format: failed to parse Info CRC\n");
1382                 return -EINVAL;
1383         }
1384         data_pos += offset;
1385
1386         ret = sscanf(cfg->data + data_pos, "%x%n", &config_crc, &offset);
1387         if (ret != 1) {
1388                 dev_err(dev, "Bad format: failed to parse Config CRC\n");
1389                 return -EINVAL;
1390         }
1391         data_pos += offset;
1392
1393         /*
1394          * The Info Block CRC is calculated over mxt_info and the object
1395          * table. If it does not match then we are trying to load the
1396          * configuration from a different chip or firmware version, so
1397          * the configuration CRC is invalid anyway.
1398          */
1399         if (info_crc == data->info_crc) {
1400                 if (config_crc == 0 || data->config_crc == 0) {
1401                         dev_info(dev, "CRC zero, attempting to apply config\n");
1402                 } else if (config_crc == data->config_crc) {
1403                         dev_dbg(dev, "Config CRC 0x%06X: OK\n",
1404                                  data->config_crc);
1405                         return 0;
1406                 } else {
1407                         dev_info(dev, "Config CRC 0x%06X: does not match file 0x%06X\n",
1408                                  data->config_crc, config_crc);
1409                 }
1410         } else {
1411                 dev_warn(dev,
1412                          "Warning: Info CRC error - device=0x%06X file=0x%06X\n",
1413                          data->info_crc, info_crc);
1414         }
1415
1416         /* Malloc memory to store configuration */
1417         cfg_start_ofs = MXT_OBJECT_START +
1418                         data->info.object_num * sizeof(struct mxt_object) +
1419                         MXT_INFO_CHECKSUM_SIZE;
1420         config_mem_size = data->mem_size - cfg_start_ofs;
1421         config_mem = kzalloc(config_mem_size, GFP_KERNEL);
1422         if (!config_mem) {
1423                 dev_err(dev, "Failed to allocate memory\n");
1424                 return -ENOMEM;
1425         }
1426
1427         ret = mxt_prepare_cfg_mem(data, cfg, data_pos, cfg_start_ofs,
1428                                   config_mem, config_mem_size);
1429         if (ret)
1430                 goto release_mem;
1431
1432         /* Calculate crc of the received configs (not the raw config file) */
1433         if (data->T7_address < cfg_start_ofs) {
1434                 dev_err(dev, "Bad T7 address, T7addr = %x, config offset %x\n",
1435                         data->T7_address, cfg_start_ofs);
1436                 ret = 0;
1437                 goto release_mem;
1438         }
1439
1440         calculated_crc = mxt_calculate_crc(config_mem,
1441                                            data->T7_address - cfg_start_ofs,
1442                                            config_mem_size);
1443
1444         if (config_crc > 0 && config_crc != calculated_crc)
1445                 dev_warn(dev, "Config CRC error, calculated=%06X, file=%06X\n",
1446                          calculated_crc, config_crc);
1447
1448         ret = mxt_upload_cfg_mem(data, cfg_start_ofs,
1449                                  config_mem, config_mem_size);
1450         if (ret)
1451                 goto release_mem;
1452
1453         mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
1454
1455         ret = mxt_soft_reset(data);
1456         if (ret)
1457                 goto release_mem;
1458
1459         dev_info(dev, "Config successfully updated\n");
1460
1461         /* T7 config may have changed */
1462         mxt_init_t7_power_cfg(data);
1463
1464 release_mem:
1465         kfree(config_mem);
1466         return ret;
1467 }
1468
1469 static int mxt_acquire_irq(struct mxt_data *data)
1470 {
1471         int error;
1472
1473         enable_irq(data->irq);
1474
1475         error = mxt_process_messages_until_invalid(data);
1476         if (error)
1477                 return error;
1478
1479         return 0;
1480 }
1481
1482 static int mxt_get_info(struct mxt_data *data)
1483 {
1484         struct i2c_client *client = data->client;
1485         struct mxt_info *info = &data->info;
1486         int error;
1487
1488         /* Read 7-byte info block starting at address 0 */
1489         error = __mxt_read_reg(client, 0, sizeof(*info), info);
1490         if (error)
1491                 return error;
1492
1493         return 0;
1494 }
1495
1496 static void mxt_free_input_device(struct mxt_data *data)
1497 {
1498         if (data->input_dev) {
1499                 input_unregister_device(data->input_dev);
1500                 data->input_dev = NULL;
1501         }
1502 }
1503
1504 static void mxt_free_object_table(struct mxt_data *data)
1505 {
1506         kfree(data->object_table);
1507         data->object_table = NULL;
1508         kfree(data->msg_buf);
1509         data->msg_buf = NULL;
1510         data->T5_address = 0;
1511         data->T5_msg_size = 0;
1512         data->T6_reportid = 0;
1513         data->T7_address = 0;
1514         data->T9_reportid_min = 0;
1515         data->T9_reportid_max = 0;
1516         data->T19_reportid = 0;
1517         data->T44_address = 0;
1518         data->T100_reportid_min = 0;
1519         data->T100_reportid_max = 0;
1520         data->max_reportid = 0;
1521 }
1522
1523 static int mxt_get_object_table(struct mxt_data *data)
1524 {
1525         struct i2c_client *client = data->client;
1526         size_t table_size;
1527         struct mxt_object *object_table;
1528         int error;
1529         int i;
1530         u8 reportid;
1531         u16 end_address;
1532
1533         table_size = data->info.object_num * sizeof(struct mxt_object);
1534         object_table = kzalloc(table_size, GFP_KERNEL);
1535         if (!object_table) {
1536                 dev_err(&data->client->dev, "Failed to allocate memory\n");
1537                 return -ENOMEM;
1538         }
1539
1540         error = __mxt_read_reg(client, MXT_OBJECT_START, table_size,
1541                         object_table);
1542         if (error) {
1543                 kfree(object_table);
1544                 return error;
1545         }
1546
1547         /* Valid Report IDs start counting from 1 */
1548         reportid = 1;
1549         data->mem_size = 0;
1550         for (i = 0; i < data->info.object_num; i++) {
1551                 struct mxt_object *object = object_table + i;
1552                 u8 min_id, max_id;
1553
1554                 le16_to_cpus(&object->start_address);
1555
1556                 if (object->num_report_ids) {
1557                         min_id = reportid;
1558                         reportid += object->num_report_ids *
1559                                         mxt_obj_instances(object);
1560                         max_id = reportid - 1;
1561                 } else {
1562                         min_id = 0;
1563                         max_id = 0;
1564                 }
1565
1566                 dev_dbg(&data->client->dev,
1567                         "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1568                         object->type, object->start_address,
1569                         mxt_obj_size(object), mxt_obj_instances(object),
1570                         min_id, max_id);
1571
1572                 switch (object->type) {
1573                 case MXT_GEN_MESSAGE_T5:
1574                         if (data->info.family_id == 0x80 &&
1575                             data->info.version < 0x20) {
1576                                 /*
1577                                  * On mXT224 firmware versions prior to V2.0
1578                                  * read and discard unused CRC byte otherwise
1579                                  * DMA reads are misaligned.
1580                                  */
1581                                 data->T5_msg_size = mxt_obj_size(object);
1582                         } else {
1583                                 /* CRC not enabled, so skip last byte */
1584                                 data->T5_msg_size = mxt_obj_size(object) - 1;
1585                         }
1586                         data->T5_address = object->start_address;
1587                         break;
1588                 case MXT_GEN_COMMAND_T6:
1589                         data->T6_reportid = min_id;
1590                         data->T6_address = object->start_address;
1591                         break;
1592                 case MXT_GEN_POWER_T7:
1593                         data->T7_address = object->start_address;
1594                         break;
1595                 case MXT_TOUCH_MULTI_T9:
1596                         data->multitouch = MXT_TOUCH_MULTI_T9;
1597                         data->T9_reportid_min = min_id;
1598                         data->T9_reportid_max = max_id;
1599                         data->num_touchids = object->num_report_ids
1600                                                 * mxt_obj_instances(object);
1601                         break;
1602                 case MXT_SPT_MESSAGECOUNT_T44:
1603                         data->T44_address = object->start_address;
1604                         break;
1605                 case MXT_SPT_GPIOPWM_T19:
1606                         data->T19_reportid = min_id;
1607                         break;
1608                 case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1609                         data->multitouch = MXT_TOUCH_MULTITOUCHSCREEN_T100;
1610                         data->T100_reportid_min = min_id;
1611                         data->T100_reportid_max = max_id;
1612                         /* first two report IDs reserved */
1613                         data->num_touchids = object->num_report_ids - 2;
1614                         break;
1615                 }
1616
1617                 end_address = object->start_address
1618                         + mxt_obj_size(object) * mxt_obj_instances(object) - 1;
1619
1620                 if (end_address >= data->mem_size)
1621                         data->mem_size = end_address + 1;
1622         }
1623
1624         /* Store maximum reportid */
1625         data->max_reportid = reportid;
1626
1627         /* If T44 exists, T5 position has to be directly after */
1628         if (data->T44_address && (data->T5_address != data->T44_address + 1)) {
1629                 dev_err(&client->dev, "Invalid T44 position\n");
1630                 error = -EINVAL;
1631                 goto free_object_table;
1632         }
1633
1634         data->msg_buf = kcalloc(data->max_reportid,
1635                                 data->T5_msg_size, GFP_KERNEL);
1636         if (!data->msg_buf) {
1637                 dev_err(&client->dev, "Failed to allocate message buffer\n");
1638                 error = -ENOMEM;
1639                 goto free_object_table;
1640         }
1641
1642         data->object_table = object_table;
1643
1644         return 0;
1645
1646 free_object_table:
1647         mxt_free_object_table(data);
1648         return error;
1649 }
1650
1651 static int mxt_read_t9_resolution(struct mxt_data *data)
1652 {
1653         struct i2c_client *client = data->client;
1654         int error;
1655         struct t9_range range;
1656         unsigned char orient;
1657         struct mxt_object *object;
1658
1659         object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
1660         if (!object)
1661                 return -EINVAL;
1662
1663         error = __mxt_read_reg(client,
1664                                object->start_address + MXT_T9_RANGE,
1665                                sizeof(range), &range);
1666         if (error)
1667                 return error;
1668
1669         le16_to_cpus(&range.x);
1670         le16_to_cpus(&range.y);
1671
1672         error =  __mxt_read_reg(client,
1673                                 object->start_address + MXT_T9_ORIENT,
1674                                 1, &orient);
1675         if (error)
1676                 return error;
1677
1678         /* Handle default values */
1679         if (range.x == 0)
1680                 range.x = 1023;
1681
1682         if (range.y == 0)
1683                 range.y = 1023;
1684
1685         if (orient & MXT_T9_ORIENT_SWITCH) {
1686                 data->max_x = range.y;
1687                 data->max_y = range.x;
1688         } else {
1689                 data->max_x = range.x;
1690                 data->max_y = range.y;
1691         }
1692
1693         dev_dbg(&client->dev,
1694                 "Touchscreen size X%uY%u\n", data->max_x, data->max_y);
1695
1696         return 0;
1697 }
1698
1699 static int mxt_read_t100_config(struct mxt_data *data)
1700 {
1701         struct i2c_client *client = data->client;
1702         int error;
1703         struct mxt_object *object;
1704         u16 range_x, range_y;
1705         u8 cfg, tchaux;
1706         u8 aux;
1707
1708         object = mxt_get_object(data, MXT_TOUCH_MULTITOUCHSCREEN_T100);
1709         if (!object)
1710                 return -EINVAL;
1711
1712         error = __mxt_read_reg(client,
1713                                object->start_address + MXT_T100_XRANGE,
1714                                sizeof(range_x), &range_x);
1715         if (error)
1716                 return error;
1717
1718         le16_to_cpus(&range_x);
1719
1720         error = __mxt_read_reg(client,
1721                                object->start_address + MXT_T100_YRANGE,
1722                                sizeof(range_y), &range_y);
1723         if (error)
1724                 return error;
1725
1726         le16_to_cpus(&range_y);
1727
1728         error =  __mxt_read_reg(client,
1729                                 object->start_address + MXT_T100_CFG1,
1730                                 1, &cfg);
1731         if (error)
1732                 return error;
1733
1734         error =  __mxt_read_reg(client,
1735                                 object->start_address + MXT_T100_TCHAUX,
1736                                 1, &tchaux);
1737         if (error)
1738                 return error;
1739
1740         /* Handle default values */
1741         if (range_x == 0)
1742                 range_x = 1023;
1743
1744         if (range_y == 0)
1745                 range_y = 1023;
1746
1747         if (cfg & MXT_T100_CFG_SWITCHXY) {
1748                 data->max_x = range_y;
1749                 data->max_y = range_x;
1750         } else {
1751                 data->max_x = range_x;
1752                 data->max_y = range_y;
1753         }
1754
1755         /* allocate aux bytes */
1756         aux = 6;
1757
1758         if (tchaux & MXT_T100_TCHAUX_VECT)
1759                 data->t100_aux_vect = aux++;
1760
1761         if (tchaux & MXT_T100_TCHAUX_AMPL)
1762                 data->t100_aux_ampl = aux++;
1763
1764         if (tchaux & MXT_T100_TCHAUX_AREA)
1765                 data->t100_aux_area = aux++;
1766
1767         dev_dbg(&client->dev,
1768                 "T100 aux mappings vect:%u ampl:%u area:%u\n",
1769                 data->t100_aux_vect, data->t100_aux_ampl, data->t100_aux_area);
1770
1771         dev_info(&client->dev,
1772                  "T100 Touchscreen size X%uY%u\n", data->max_x, data->max_y);
1773
1774         return 0;
1775 }
1776
1777 static int mxt_input_open(struct input_dev *dev);
1778 static void mxt_input_close(struct input_dev *dev);
1779
1780 static void mxt_set_up_as_touchpad(struct input_dev *input_dev,
1781                                    struct mxt_data *data)
1782 {
1783         const struct mxt_platform_data *pdata = data->pdata;
1784         int i;
1785
1786         input_dev->name = "Atmel maXTouch Touchpad";
1787
1788         __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1789
1790         input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1791         input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1792         input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1793                           MXT_PIXELS_PER_MM);
1794         input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1795                           MXT_PIXELS_PER_MM);
1796
1797         for (i = 0; i < pdata->t19_num_keys; i++)
1798                 if (pdata->t19_keymap[i] != KEY_RESERVED)
1799                         input_set_capability(input_dev, EV_KEY,
1800                                              pdata->t19_keymap[i]);
1801 }
1802
1803 static int mxt_initialize_input_device(struct mxt_data *data)
1804 {
1805         const struct mxt_platform_data *pdata = data->pdata;
1806         struct device *dev = &data->client->dev;
1807         struct input_dev *input_dev;
1808         int error;
1809         unsigned int num_mt_slots;
1810         unsigned int mt_flags = 0;
1811
1812         switch (data->multitouch) {
1813         case MXT_TOUCH_MULTI_T9:
1814                 num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1815                 error = mxt_read_t9_resolution(data);
1816                 if (error)
1817                         dev_warn(dev, "Failed to initialize T9 resolution\n");
1818                 break;
1819
1820         case MXT_TOUCH_MULTITOUCHSCREEN_T100:
1821                 num_mt_slots = data->num_touchids;
1822                 error = mxt_read_t100_config(data);
1823                 if (error)
1824                         dev_warn(dev, "Failed to read T100 config\n");
1825                 break;
1826
1827         default:
1828                 dev_err(dev, "Invalid multitouch object\n");
1829                 return -EINVAL;
1830         }
1831
1832         input_dev = input_allocate_device();
1833         if (!input_dev) {
1834                 dev_err(dev, "Failed to allocate memory\n");
1835                 return -ENOMEM;
1836         }
1837
1838         input_dev->name = "Atmel maXTouch Touchscreen";
1839         input_dev->phys = data->phys;
1840         input_dev->id.bustype = BUS_I2C;
1841         input_dev->dev.parent = dev;
1842         input_dev->open = mxt_input_open;
1843         input_dev->close = mxt_input_close;
1844
1845         input_set_capability(input_dev, EV_KEY, BTN_TOUCH);
1846
1847         /* For single touch */
1848         input_set_abs_params(input_dev, ABS_X, 0, data->max_x, 0, 0);
1849         input_set_abs_params(input_dev, ABS_Y, 0, data->max_y, 0, 0);
1850
1851         if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
1852             (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1853              data->t100_aux_ampl)) {
1854                 input_set_abs_params(input_dev, ABS_PRESSURE, 0, 255, 0, 0);
1855         }
1856
1857         /* If device has buttons we assume it is a touchpad */
1858         if (pdata->t19_num_keys) {
1859                 mxt_set_up_as_touchpad(input_dev, data);
1860                 mt_flags |= INPUT_MT_POINTER;
1861         } else {
1862                 mt_flags |= INPUT_MT_DIRECT;
1863         }
1864
1865         /* For multi touch */
1866         error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
1867         if (error) {
1868                 dev_err(dev, "Error %d initialising slots\n", error);
1869                 goto err_free_mem;
1870         }
1871
1872         if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100) {
1873                 input_set_abs_params(input_dev, ABS_MT_TOOL_TYPE,
1874                                      0, MT_TOOL_MAX, 0, 0);
1875                 input_set_abs_params(input_dev, ABS_MT_DISTANCE,
1876                                      MXT_DISTANCE_ACTIVE_TOUCH,
1877                                      MXT_DISTANCE_HOVERING,
1878                                      0, 0);
1879         }
1880
1881         input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1882                              0, data->max_x, 0, 0);
1883         input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1884                              0, data->max_y, 0, 0);
1885
1886         if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
1887             (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1888              data->t100_aux_area)) {
1889                 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1890                                      0, MXT_MAX_AREA, 0, 0);
1891         }
1892
1893         if (data->multitouch == MXT_TOUCH_MULTI_T9 ||
1894             (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1895              data->t100_aux_ampl)) {
1896                 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1897                                      0, 255, 0, 0);
1898         }
1899
1900         if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1901             data->t100_aux_vect) {
1902                 input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
1903                                      0, 255, 0, 0);
1904         }
1905
1906         if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1907             data->t100_aux_ampl) {
1908                 input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1909                                      0, 255, 0, 0);
1910         }
1911
1912         if (data->multitouch == MXT_TOUCH_MULTITOUCHSCREEN_T100 &&
1913             data->t100_aux_vect) {
1914                 input_set_abs_params(input_dev, ABS_MT_ORIENTATION,
1915                                      0, 255, 0, 0);
1916         }
1917
1918         input_set_drvdata(input_dev, data);
1919
1920         error = input_register_device(input_dev);
1921         if (error) {
1922                 dev_err(dev, "Error %d registering input device\n", error);
1923                 goto err_free_mem;
1924         }
1925
1926         data->input_dev = input_dev;
1927
1928         return 0;
1929
1930 err_free_mem:
1931         input_free_device(input_dev);
1932         return error;
1933 }
1934
1935 static int mxt_configure_objects(struct mxt_data *data,
1936                                  const struct firmware *cfg);
1937
1938 static void mxt_config_cb(const struct firmware *cfg, void *ctx)
1939 {
1940         mxt_configure_objects(ctx, cfg);
1941         release_firmware(cfg);
1942 }
1943
1944 static int mxt_initialize(struct mxt_data *data)
1945 {
1946         struct i2c_client *client = data->client;
1947         int recovery_attempts = 0;
1948         int error;
1949
1950         while (1) {
1951                 error = mxt_get_info(data);
1952                 if (!error)
1953                         break;
1954
1955                 /* Check bootloader state */
1956                 error = mxt_probe_bootloader(data, false);
1957                 if (error) {
1958                         dev_info(&client->dev, "Trying alternate bootloader address\n");
1959                         error = mxt_probe_bootloader(data, true);
1960                         if (error) {
1961                                 /* Chip is not in appmode or bootloader mode */
1962                                 return error;
1963                         }
1964                 }
1965
1966                 /* OK, we are in bootloader, see if we can recover */
1967                 if (++recovery_attempts > 1) {
1968                         dev_err(&client->dev, "Could not recover from bootloader mode\n");
1969                         /*
1970                          * We can reflash from this state, so do not
1971                          * abort initialization.
1972                          */
1973                         data->in_bootloader = true;
1974                         return 0;
1975                 }
1976
1977                 /* Attempt to exit bootloader into app mode */
1978                 mxt_send_bootloader_cmd(data, false);
1979                 msleep(MXT_FW_RESET_TIME);
1980         }
1981
1982         /* Get object table information */
1983         error = mxt_get_object_table(data);
1984         if (error) {
1985                 dev_err(&client->dev, "Error %d reading object table\n", error);
1986                 return error;
1987         }
1988
1989         error = mxt_acquire_irq(data);
1990         if (error)
1991                 goto err_free_object_table;
1992
1993         error = request_firmware_nowait(THIS_MODULE, true, MXT_CFG_NAME,
1994                                         &client->dev, GFP_KERNEL, data,
1995                                         mxt_config_cb);
1996         if (error) {
1997                 dev_err(&client->dev, "Failed to invoke firmware loader: %d\n",
1998                         error);
1999                 goto err_free_object_table;
2000         }
2001
2002         return 0;
2003
2004 err_free_object_table:
2005         mxt_free_object_table(data);
2006         return error;
2007 }
2008
2009 static int mxt_set_t7_power_cfg(struct mxt_data *data, u8 sleep)
2010 {
2011         struct device *dev = &data->client->dev;
2012         int error;
2013         struct t7_config *new_config;
2014         struct t7_config deepsleep = { .active = 0, .idle = 0 };
2015
2016         if (sleep == MXT_POWER_CFG_DEEPSLEEP)
2017                 new_config = &deepsleep;
2018         else
2019                 new_config = &data->t7_cfg;
2020
2021         error = __mxt_write_reg(data->client, data->T7_address,
2022                                 sizeof(data->t7_cfg), new_config);
2023         if (error)
2024                 return error;
2025
2026         dev_dbg(dev, "Set T7 ACTV:%d IDLE:%d\n",
2027                 new_config->active, new_config->idle);
2028
2029         return 0;
2030 }
2031
2032 static int mxt_init_t7_power_cfg(struct mxt_data *data)
2033 {
2034         struct device *dev = &data->client->dev;
2035         int error;
2036         bool retry = false;
2037
2038 recheck:
2039         error = __mxt_read_reg(data->client, data->T7_address,
2040                                 sizeof(data->t7_cfg), &data->t7_cfg);
2041         if (error)
2042                 return error;
2043
2044         if (data->t7_cfg.active == 0 || data->t7_cfg.idle == 0) {
2045                 if (!retry) {
2046                         dev_dbg(dev, "T7 cfg zero, resetting\n");
2047                         mxt_soft_reset(data);
2048                         retry = true;
2049                         goto recheck;
2050                 } else {
2051                         dev_dbg(dev, "T7 cfg zero after reset, overriding\n");
2052                         data->t7_cfg.active = 20;
2053                         data->t7_cfg.idle = 100;
2054                         return mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2055                 }
2056         }
2057
2058         dev_dbg(dev, "Initialized power cfg: ACTV %d, IDLE %d\n",
2059                 data->t7_cfg.active, data->t7_cfg.idle);
2060         return 0;
2061 }
2062
2063 static int mxt_configure_objects(struct mxt_data *data,
2064                                  const struct firmware *cfg)
2065 {
2066         struct device *dev = &data->client->dev;
2067         struct mxt_info *info = &data->info;
2068         int error;
2069
2070         error = mxt_init_t7_power_cfg(data);
2071         if (error) {
2072                 dev_err(dev, "Failed to initialize power cfg\n");
2073                 return error;
2074         }
2075
2076         if (cfg) {
2077                 error = mxt_update_cfg(data, cfg);
2078                 if (error)
2079                         dev_warn(dev, "Error %d updating config\n", error);
2080         }
2081
2082         if (data->multitouch) {
2083                 error = mxt_initialize_input_device(data);
2084                 if (error)
2085                         return error;
2086         } else {
2087                 dev_warn(dev, "No touch object detected\n");
2088         }
2089
2090         dev_info(dev,
2091                  "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
2092                  info->family_id, info->variant_id, info->version >> 4,
2093                  info->version & 0xf, info->build, info->object_num);
2094
2095         return 0;
2096 }
2097
2098 /* Firmware Version is returned as Major.Minor.Build */
2099 static ssize_t mxt_fw_version_show(struct device *dev,
2100                                    struct device_attribute *attr, char *buf)
2101 {
2102         struct mxt_data *data = dev_get_drvdata(dev);
2103         struct mxt_info *info = &data->info;
2104         return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
2105                          info->version >> 4, info->version & 0xf, info->build);
2106 }
2107
2108 /* Hardware Version is returned as FamilyID.VariantID */
2109 static ssize_t mxt_hw_version_show(struct device *dev,
2110                                    struct device_attribute *attr, char *buf)
2111 {
2112         struct mxt_data *data = dev_get_drvdata(dev);
2113         struct mxt_info *info = &data->info;
2114         return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
2115                          info->family_id, info->variant_id);
2116 }
2117
2118 static ssize_t mxt_show_instance(char *buf, int count,
2119                                  struct mxt_object *object, int instance,
2120                                  const u8 *val)
2121 {
2122         int i;
2123
2124         if (mxt_obj_instances(object) > 1)
2125                 count += scnprintf(buf + count, PAGE_SIZE - count,
2126                                    "Instance %u\n", instance);
2127
2128         for (i = 0; i < mxt_obj_size(object); i++)
2129                 count += scnprintf(buf + count, PAGE_SIZE - count,
2130                                 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
2131         count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
2132
2133         return count;
2134 }
2135
2136 static ssize_t mxt_object_show(struct device *dev,
2137                                     struct device_attribute *attr, char *buf)
2138 {
2139         struct mxt_data *data = dev_get_drvdata(dev);
2140         struct mxt_object *object;
2141         int count = 0;
2142         int i, j;
2143         int error;
2144         u8 *obuf;
2145
2146         /* Pre-allocate buffer large enough to hold max sized object. */
2147         obuf = kmalloc(256, GFP_KERNEL);
2148         if (!obuf)
2149                 return -ENOMEM;
2150
2151         error = 0;
2152         for (i = 0; i < data->info.object_num; i++) {
2153                 object = data->object_table + i;
2154
2155                 if (!mxt_object_readable(object->type))
2156                         continue;
2157
2158                 count += scnprintf(buf + count, PAGE_SIZE - count,
2159                                 "T%u:\n", object->type);
2160
2161                 for (j = 0; j < mxt_obj_instances(object); j++) {
2162                         u16 size = mxt_obj_size(object);
2163                         u16 addr = object->start_address + j * size;
2164
2165                         error = __mxt_read_reg(data->client, addr, size, obuf);
2166                         if (error)
2167                                 goto done;
2168
2169                         count = mxt_show_instance(buf, count, object, j, obuf);
2170                 }
2171         }
2172
2173 done:
2174         kfree(obuf);
2175         return error ?: count;
2176 }
2177
2178 static int mxt_check_firmware_format(struct device *dev,
2179                                      const struct firmware *fw)
2180 {
2181         unsigned int pos = 0;
2182         char c;
2183
2184         while (pos < fw->size) {
2185                 c = *(fw->data + pos);
2186
2187                 if (c < '0' || (c > '9' && c < 'A') || c > 'F')
2188                         return 0;
2189
2190                 pos++;
2191         }
2192
2193         /*
2194          * To convert file try:
2195          * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
2196          */
2197         dev_err(dev, "Aborting: firmware file must be in binary format\n");
2198
2199         return -EINVAL;
2200 }
2201
2202 static int mxt_load_fw(struct device *dev, const char *fn)
2203 {
2204         struct mxt_data *data = dev_get_drvdata(dev);
2205         const struct firmware *fw = NULL;
2206         unsigned int frame_size;
2207         unsigned int pos = 0;
2208         unsigned int retry = 0;
2209         unsigned int frame = 0;
2210         int ret;
2211
2212         ret = request_firmware(&fw, fn, dev);
2213         if (ret) {
2214                 dev_err(dev, "Unable to open firmware %s\n", fn);
2215                 return ret;
2216         }
2217
2218         /* Check for incorrect enc file */
2219         ret = mxt_check_firmware_format(dev, fw);
2220         if (ret)
2221                 goto release_firmware;
2222
2223         if (!data->in_bootloader) {
2224                 /* Change to the bootloader mode */
2225                 data->in_bootloader = true;
2226
2227                 ret = mxt_t6_command(data, MXT_COMMAND_RESET,
2228                                      MXT_BOOT_VALUE, false);
2229                 if (ret)
2230                         goto release_firmware;
2231
2232                 msleep(MXT_RESET_TIME);
2233
2234                 /* Do not need to scan since we know family ID */
2235                 ret = mxt_lookup_bootloader_address(data, 0);
2236                 if (ret)
2237                         goto release_firmware;
2238
2239                 mxt_free_input_device(data);
2240                 mxt_free_object_table(data);
2241         } else {
2242                 enable_irq(data->irq);
2243         }
2244
2245         reinit_completion(&data->bl_completion);
2246
2247         ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD, false);
2248         if (ret) {
2249                 /* Bootloader may still be unlocked from previous attempt */
2250                 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, false);
2251                 if (ret)
2252                         goto disable_irq;
2253         } else {
2254                 dev_info(dev, "Unlocking bootloader\n");
2255
2256                 /* Unlock bootloader */
2257                 ret = mxt_send_bootloader_cmd(data, true);
2258                 if (ret)
2259                         goto disable_irq;
2260         }
2261
2262         while (pos < fw->size) {
2263                 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA, true);
2264                 if (ret)
2265                         goto disable_irq;
2266
2267                 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
2268
2269                 /* Take account of CRC bytes */
2270                 frame_size += 2;
2271
2272                 /* Write one frame to device */
2273                 ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
2274                 if (ret)
2275                         goto disable_irq;
2276
2277                 ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS, true);
2278                 if (ret) {
2279                         retry++;
2280
2281                         /* Back off by 20ms per retry */
2282                         msleep(retry * 20);
2283
2284                         if (retry > 20) {
2285                                 dev_err(dev, "Retry count exceeded\n");
2286                                 goto disable_irq;
2287                         }
2288                 } else {
2289                         retry = 0;
2290                         pos += frame_size;
2291                         frame++;
2292                 }
2293
2294                 if (frame % 50 == 0)
2295                         dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
2296                                 frame, pos, fw->size);
2297         }
2298
2299         /* Wait for flash. */
2300         ret = mxt_wait_for_completion(data, &data->bl_completion,
2301                                       MXT_FW_RESET_TIME);
2302         if (ret)
2303                 goto disable_irq;
2304
2305         dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
2306
2307         /*
2308          * Wait for device to reset. Some bootloader versions do not assert
2309          * the CHG line after bootloading has finished, so ignore potential
2310          * errors.
2311          */
2312         mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
2313
2314         data->in_bootloader = false;
2315
2316 disable_irq:
2317         disable_irq(data->irq);
2318 release_firmware:
2319         release_firmware(fw);
2320         return ret;
2321 }
2322
2323 static ssize_t mxt_update_fw_store(struct device *dev,
2324                                         struct device_attribute *attr,
2325                                         const char *buf, size_t count)
2326 {
2327         struct mxt_data *data = dev_get_drvdata(dev);
2328         int error;
2329
2330         error = mxt_load_fw(dev, MXT_FW_NAME);
2331         if (error) {
2332                 dev_err(dev, "The firmware update failed(%d)\n", error);
2333                 count = error;
2334         } else {
2335                 dev_info(dev, "The firmware update succeeded\n");
2336
2337                 error = mxt_initialize(data);
2338                 if (error)
2339                         return error;
2340         }
2341
2342         return count;
2343 }
2344
2345 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
2346 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
2347 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
2348 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
2349
2350 static struct attribute *mxt_attrs[] = {
2351         &dev_attr_fw_version.attr,
2352         &dev_attr_hw_version.attr,
2353         &dev_attr_object.attr,
2354         &dev_attr_update_fw.attr,
2355         NULL
2356 };
2357
2358 static const struct attribute_group mxt_attr_group = {
2359         .attrs = mxt_attrs,
2360 };
2361
2362 static void mxt_start(struct mxt_data *data)
2363 {
2364         switch (data->pdata->suspend_mode) {
2365         case MXT_SUSPEND_T9_CTRL:
2366                 mxt_soft_reset(data);
2367
2368                 /* Touch enable */
2369                 /* 0x83 = SCANEN | RPTEN | ENABLE */
2370                 mxt_write_object(data,
2371                                 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0x83);
2372                 break;
2373
2374         case MXT_SUSPEND_DEEP_SLEEP:
2375         default:
2376                 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_RUN);
2377
2378                 /* Recalibrate since chip has been in deep sleep */
2379                 mxt_t6_command(data, MXT_COMMAND_CALIBRATE, 1, false);
2380                 break;
2381         }
2382
2383 }
2384
2385 static void mxt_stop(struct mxt_data *data)
2386 {
2387         switch (data->pdata->suspend_mode) {
2388         case MXT_SUSPEND_T9_CTRL:
2389                 /* Touch disable */
2390                 mxt_write_object(data,
2391                                 MXT_TOUCH_MULTI_T9, MXT_T9_CTRL, 0);
2392                 break;
2393
2394         case MXT_SUSPEND_DEEP_SLEEP:
2395         default:
2396                 mxt_set_t7_power_cfg(data, MXT_POWER_CFG_DEEPSLEEP);
2397                 break;
2398         }
2399 }
2400
2401 static int mxt_input_open(struct input_dev *dev)
2402 {
2403         struct mxt_data *data = input_get_drvdata(dev);
2404
2405         mxt_start(data);
2406
2407         return 0;
2408 }
2409
2410 static void mxt_input_close(struct input_dev *dev)
2411 {
2412         struct mxt_data *data = input_get_drvdata(dev);
2413
2414         mxt_stop(data);
2415 }
2416
2417 #ifdef CONFIG_OF
2418 static const struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
2419 {
2420         struct mxt_platform_data *pdata;
2421         struct device_node *np = client->dev.of_node;
2422         u32 *keymap;
2423         int proplen, ret;
2424
2425         if (!np)
2426                 return ERR_PTR(-ENOENT);
2427
2428         pdata = devm_kzalloc(&client->dev, sizeof(*pdata), GFP_KERNEL);
2429         if (!pdata)
2430                 return ERR_PTR(-ENOMEM);
2431
2432         if (of_find_property(np, "linux,gpio-keymap", &proplen)) {
2433                 pdata->t19_num_keys = proplen / sizeof(u32);
2434
2435                 keymap = devm_kzalloc(&client->dev,
2436                                 pdata->t19_num_keys * sizeof(keymap[0]),
2437                                 GFP_KERNEL);
2438                 if (!keymap)
2439                         return ERR_PTR(-ENOMEM);
2440
2441                 ret = of_property_read_u32_array(np, "linux,gpio-keymap",
2442                                                  keymap, pdata->t19_num_keys);
2443                 if (ret)
2444                         dev_warn(&client->dev,
2445                                  "Couldn't read linux,gpio-keymap: %d\n", ret);
2446
2447                 pdata->t19_keymap = keymap;
2448         }
2449
2450         pdata->suspend_mode = MXT_SUSPEND_DEEP_SLEEP;
2451
2452         return pdata;
2453 }
2454 #else
2455 static const struct mxt_platform_data *mxt_parse_dt(struct i2c_client *client)
2456 {
2457         return ERR_PTR(-ENOENT);
2458 }
2459 #endif
2460
2461 #ifdef CONFIG_ACPI
2462
2463 struct mxt_acpi_platform_data {
2464         const char *hid;
2465         struct mxt_platform_data pdata;
2466 };
2467
2468 static unsigned int samus_touchpad_buttons[] = {
2469         KEY_RESERVED,
2470         KEY_RESERVED,
2471         KEY_RESERVED,
2472         BTN_LEFT
2473 };
2474
2475 static struct mxt_acpi_platform_data samus_platform_data[] = {
2476         {
2477                 /* Touchpad */
2478                 .hid    = "ATML0000",
2479                 .pdata  = {
2480                         .t19_num_keys   = ARRAY_SIZE(samus_touchpad_buttons),
2481                         .t19_keymap     = samus_touchpad_buttons,
2482                 },
2483         },
2484         {
2485                 /* Touchscreen */
2486                 .hid    = "ATML0001",
2487         },
2488         { }
2489 };
2490
2491 static const struct dmi_system_id mxt_dmi_table[] = {
2492         {
2493                 /* 2015 Google Pixel */
2494                 .ident = "Chromebook Pixel 2",
2495                 .matches = {
2496                         DMI_MATCH(DMI_SYS_VENDOR, "GOOGLE"),
2497                         DMI_MATCH(DMI_PRODUCT_NAME, "Samus"),
2498                 },
2499                 .driver_data = samus_platform_data,
2500         },
2501         { }
2502 };
2503
2504 static const struct mxt_platform_data *mxt_parse_acpi(struct i2c_client *client)
2505 {
2506         struct acpi_device *adev;
2507         const struct dmi_system_id *system_id;
2508         const struct mxt_acpi_platform_data *acpi_pdata;
2509
2510         /*
2511          * Ignore ACPI devices representing bootloader mode.
2512          *
2513          * This is a bit of a hack: Google Chromebook BIOS creates ACPI
2514          * devices for both application and bootloader modes, but we are
2515          * interested in application mode only (if device is in bootloader
2516          * mode we'll end up switching into application anyway). So far
2517          * application mode addresses were all above 0x40, so we'll use it
2518          * as a threshold.
2519          */
2520         if (client->addr < 0x40)
2521                 return ERR_PTR(-ENXIO);
2522
2523         adev = ACPI_COMPANION(&client->dev);
2524         if (!adev)
2525                 return ERR_PTR(-ENOENT);
2526
2527         system_id = dmi_first_match(mxt_dmi_table);
2528         if (!system_id)
2529                 return ERR_PTR(-ENOENT);
2530
2531         acpi_pdata = system_id->driver_data;
2532         if (!acpi_pdata)
2533                 return ERR_PTR(-ENOENT);
2534
2535         while (acpi_pdata->hid) {
2536                 if (!strcmp(acpi_device_hid(adev), acpi_pdata->hid))
2537                         return &acpi_pdata->pdata;
2538
2539                 acpi_pdata++;
2540         }
2541
2542         return ERR_PTR(-ENOENT);
2543 }
2544 #else
2545 static const struct mxt_platform_data *mxt_parse_acpi(struct i2c_client *client)
2546 {
2547         return ERR_PTR(-ENOENT);
2548 }
2549 #endif
2550
2551 static const struct mxt_platform_data *
2552 mxt_get_platform_data(struct i2c_client *client)
2553 {
2554         const struct mxt_platform_data *pdata;
2555
2556         pdata = dev_get_platdata(&client->dev);
2557         if (pdata)
2558                 return pdata;
2559
2560         pdata = mxt_parse_dt(client);
2561         if (!IS_ERR(pdata) || PTR_ERR(pdata) != -ENOENT)
2562                 return pdata;
2563
2564         pdata = mxt_parse_acpi(client);
2565         if (!IS_ERR(pdata) || PTR_ERR(pdata) != -ENOENT)
2566                 return pdata;
2567
2568         dev_err(&client->dev, "No platform data specified\n");
2569         return ERR_PTR(-EINVAL);
2570 }
2571
2572 static int mxt_probe(struct i2c_client *client, const struct i2c_device_id *id)
2573 {
2574         struct mxt_data *data;
2575         const struct mxt_platform_data *pdata;
2576         int error;
2577
2578         pdata = mxt_get_platform_data(client);
2579         if (IS_ERR(pdata))
2580                 return PTR_ERR(pdata);
2581
2582         data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
2583         if (!data) {
2584                 dev_err(&client->dev, "Failed to allocate memory\n");
2585                 return -ENOMEM;
2586         }
2587
2588         snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
2589                  client->adapter->nr, client->addr);
2590
2591         data->client = client;
2592         data->pdata = pdata;
2593         data->irq = client->irq;
2594         i2c_set_clientdata(client, data);
2595
2596         init_completion(&data->bl_completion);
2597         init_completion(&data->reset_completion);
2598         init_completion(&data->crc_completion);
2599
2600         error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
2601                                      pdata->irqflags | IRQF_ONESHOT,
2602                                      client->name, data);
2603         if (error) {
2604                 dev_err(&client->dev, "Failed to register interrupt\n");
2605                 goto err_free_mem;
2606         }
2607
2608         disable_irq(client->irq);
2609
2610         error = mxt_initialize(data);
2611         if (error)
2612                 goto err_free_irq;
2613
2614         error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
2615         if (error) {
2616                 dev_err(&client->dev, "Failure %d creating sysfs group\n",
2617                         error);
2618                 goto err_free_object;
2619         }
2620
2621         return 0;
2622
2623 err_free_object:
2624         mxt_free_input_device(data);
2625         mxt_free_object_table(data);
2626 err_free_irq:
2627         free_irq(client->irq, data);
2628 err_free_mem:
2629         kfree(data);
2630         return error;
2631 }
2632
2633 static int mxt_remove(struct i2c_client *client)
2634 {
2635         struct mxt_data *data = i2c_get_clientdata(client);
2636
2637         sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
2638         free_irq(data->irq, data);
2639         mxt_free_input_device(data);
2640         mxt_free_object_table(data);
2641         kfree(data);
2642
2643         return 0;
2644 }
2645
2646 static int __maybe_unused mxt_suspend(struct device *dev)
2647 {
2648         struct i2c_client *client = to_i2c_client(dev);
2649         struct mxt_data *data = i2c_get_clientdata(client);
2650         struct input_dev *input_dev = data->input_dev;
2651
2652         if (!input_dev)
2653                 return 0;
2654
2655         mutex_lock(&input_dev->mutex);
2656
2657         if (input_dev->users)
2658                 mxt_stop(data);
2659
2660         mutex_unlock(&input_dev->mutex);
2661
2662         return 0;
2663 }
2664
2665 static int __maybe_unused mxt_resume(struct device *dev)
2666 {
2667         struct i2c_client *client = to_i2c_client(dev);
2668         struct mxt_data *data = i2c_get_clientdata(client);
2669         struct input_dev *input_dev = data->input_dev;
2670
2671         if (!input_dev)
2672                 return 0;
2673
2674         mutex_lock(&input_dev->mutex);
2675
2676         if (input_dev->users)
2677                 mxt_start(data);
2678
2679         mutex_unlock(&input_dev->mutex);
2680
2681         return 0;
2682 }
2683
2684 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
2685
2686 static const struct of_device_id mxt_of_match[] = {
2687         { .compatible = "atmel,maxtouch", },
2688         {},
2689 };
2690 MODULE_DEVICE_TABLE(of, mxt_of_match);
2691
2692 #ifdef CONFIG_ACPI
2693 static const struct acpi_device_id mxt_acpi_id[] = {
2694         { "ATML0000", 0 },      /* Touchpad */
2695         { "ATML0001", 0 },      /* Touchscreen */
2696         { }
2697 };
2698 MODULE_DEVICE_TABLE(acpi, mxt_acpi_id);
2699 #endif
2700
2701 static const struct i2c_device_id mxt_id[] = {
2702         { "qt602240_ts", 0 },
2703         { "atmel_mxt_ts", 0 },
2704         { "atmel_mxt_tp", 0 },
2705         { "mXT224", 0 },
2706         { }
2707 };
2708 MODULE_DEVICE_TABLE(i2c, mxt_id);
2709
2710 static struct i2c_driver mxt_driver = {
2711         .driver = {
2712                 .name   = "atmel_mxt_ts",
2713                 .of_match_table = of_match_ptr(mxt_of_match),
2714                 .acpi_match_table = ACPI_PTR(mxt_acpi_id),
2715                 .pm     = &mxt_pm_ops,
2716         },
2717         .probe          = mxt_probe,
2718         .remove         = mxt_remove,
2719         .id_table       = mxt_id,
2720 };
2721
2722 module_i2c_driver(mxt_driver);
2723
2724 /* Module information */
2725 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
2726 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
2727 MODULE_LICENSE("GPL");