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) 2012 Google, Inc.
   6  *
   7  * Author: Joonyoung Shim <jy0922.shim@samsung.com>
   8  *
   9  * This program is free software; you can redistribute  it and/or modify it
  10  * under  the terms of  the GNU General  Public License as published by the
  11  * Free Software Foundation;  either version 2 of the  License, or (at your
  12  * option) any later version.
  13  *
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/init.h>
  18 #include <linux/completion.h>
  19 #include <linux/delay.h>
  20 #include <linux/firmware.h>
  21 #include <linux/i2c.h>
  22 #include <linux/i2c/atmel_mxt_ts.h>
  23 #include <linux/input/mt.h>
  24 #include <linux/interrupt.h>
  25 #include <linux/slab.h>
  26
  27 /* Version */
  28 #define MXT_VER_20              20
  29 #define MXT_VER_21              21
  30 #define MXT_VER_22              22
  31
  32 /* Firmware */
  33 #define MXT_FW_NAME             "maxtouch.fw"
  34
  35 /* Registers */
  36 #define MXT_INFO                0x00
  37 #define MXT_FAMILY_ID           0x00
  38 #define MXT_VARIANT_ID          0x01
  39 #define MXT_VERSION             0x02
  40 #define MXT_BUILD               0x03
  41 #define MXT_MATRIX_X_SIZE       0x04
  42 #define MXT_MATRIX_Y_SIZE       0x05
  43 #define MXT_OBJECT_NUM          0x06
  44 #define MXT_OBJECT_START        0x07
  45
  46 #define MXT_OBJECT_SIZE         6
  47
  48 /* Object types */
  49 #define MXT_DEBUG_DIAGNOSTIC_T37        37
  50 #define MXT_GEN_MESSAGE_T5              5
  51 #define MXT_GEN_COMMAND_T6              6
  52 #define MXT_GEN_POWER_T7                7
  53 #define MXT_GEN_ACQUIRE_T8              8
  54 #define MXT_GEN_DATASOURCE_T53          53
  55 #define MXT_TOUCH_MULTI_T9              9
  56 #define MXT_TOUCH_KEYARRAY_T15          15
  57 #define MXT_TOUCH_PROXIMITY_T23         23
  58 #define MXT_TOUCH_PROXKEY_T52           52
  59 #define MXT_PROCI_GRIPFACE_T20          20
  60 #define MXT_PROCG_NOISE_T22             22
  61 #define MXT_PROCI_ONETOUCH_T24          24
  62 #define MXT_PROCI_TWOTOUCH_T27          27
  63 #define MXT_PROCI_GRIP_T40              40
  64 #define MXT_PROCI_PALM_T41              41
  65 #define MXT_PROCI_TOUCHSUPPRESSION_T42  42
  66 #define MXT_PROCI_STYLUS_T47            47
  67 #define MXT_PROCG_NOISESUPPRESSION_T48  48
  68 #define MXT_SPT_COMMSCONFIG_T18         18
  69 #define MXT_SPT_GPIOPWM_T19             19
  70 #define MXT_SPT_SELFTEST_T25            25
  71 #define MXT_SPT_CTECONFIG_T28           28
  72 #define MXT_SPT_USERDATA_T38            38
  73 #define MXT_SPT_DIGITIZER_T43           43
  74 #define MXT_SPT_MESSAGECOUNT_T44        44
  75 #define MXT_SPT_CTECONFIG_T46           46
  76
  77 /* MXT_GEN_COMMAND_T6 field */
  78 #define MXT_COMMAND_RESET       0
  79 #define MXT_COMMAND_BACKUPNV    1
  80 #define MXT_COMMAND_CALIBRATE   2
  81 #define MXT_COMMAND_REPORTALL   3
  82 #define MXT_COMMAND_DIAGNOSTIC  5
  83
  84 /* Define for T6 status byte */
  85 #define MXT_T6_STATUS_RESET     (1 << 7)
  86
  87 /* MXT_GEN_POWER_T7 field */
  88 #define MXT_POWER_IDLEACQINT    0
  89 #define MXT_POWER_ACTVACQINT    1
  90 #define MXT_POWER_ACTV2IDLETO   2
  91
  92 /* MXT_GEN_ACQUIRE_T8 field */
  93 #define MXT_ACQUIRE_CHRGTIME    0
  94 #define MXT_ACQUIRE_TCHDRIFT    2
  95 #define MXT_ACQUIRE_DRIFTST     3
  96 #define MXT_ACQUIRE_TCHAUTOCAL  4
  97 #define MXT_ACQUIRE_SYNC        5
  98 #define MXT_ACQUIRE_ATCHCALST   6
  99 #define MXT_ACQUIRE_ATCHCALSTHR 7
 100
 101 /* MXT_TOUCH_MULTI_T9 field */
 102 #define MXT_TOUCH_CTRL          0
 103 #define MXT_T9_ORIENT           9
 104 #define MXT_T9_RANGE            18
 105
 106 /* MXT_TOUCH_MULTI_T9 status */
 107 #define MXT_T9_UNGRIP           (1 << 0)
 108 #define MXT_T9_SUPPRESS         (1 << 1)
 109 #define MXT_T9_AMP              (1 << 2)
 110 #define MXT_T9_VECTOR           (1 << 3)
 111 #define MXT_T9_MOVE             (1 << 4)
 112 #define MXT_T9_RELEASE          (1 << 5)
 113 #define MXT_T9_PRESS            (1 << 6)
 114 #define MXT_T9_DETECT           (1 << 7)
 115
 116 struct t9_range {
 117         u16 x;
 118         u16 y;
 119 } __packed;
 120
 121 /* MXT_TOUCH_MULTI_T9 orient */
 122 #define MXT_T9_ORIENT_SWITCH    (1 << 0)
 123
 124 /* MXT_PROCI_GRIPFACE_T20 field */
 125 #define MXT_GRIPFACE_CTRL       0
 126 #define MXT_GRIPFACE_XLOGRIP    1
 127 #define MXT_GRIPFACE_XHIGRIP    2
 128 #define MXT_GRIPFACE_YLOGRIP    3
 129 #define MXT_GRIPFACE_YHIGRIP    4
 130 #define MXT_GRIPFACE_MAXTCHS    5
 131 #define MXT_GRIPFACE_SZTHR1     7
 132 #define MXT_GRIPFACE_SZTHR2     8
 133 #define MXT_GRIPFACE_SHPTHR1    9
 134 #define MXT_GRIPFACE_SHPTHR2    10
 135 #define MXT_GRIPFACE_SUPEXTTO   11
 136
 137 /* MXT_PROCI_NOISE field */
 138 #define MXT_NOISE_CTRL          0
 139 #define MXT_NOISE_OUTFLEN       1
 140 #define MXT_NOISE_GCAFUL_LSB    3
 141 #define MXT_NOISE_GCAFUL_MSB    4
 142 #define MXT_NOISE_GCAFLL_LSB    5
 143 #define MXT_NOISE_GCAFLL_MSB    6
 144 #define MXT_NOISE_ACTVGCAFVALID 7
 145 #define MXT_NOISE_NOISETHR      8
 146 #define MXT_NOISE_FREQHOPSCALE  10
 147 #define MXT_NOISE_FREQ0         11
 148 #define MXT_NOISE_FREQ1         12
 149 #define MXT_NOISE_FREQ2         13
 150 #define MXT_NOISE_FREQ3         14
 151 #define MXT_NOISE_FREQ4         15
 152 #define MXT_NOISE_IDLEGCAFVALID 16
 153
 154 /* MXT_SPT_COMMSCONFIG_T18 */
 155 #define MXT_COMMS_CTRL          0
 156 #define MXT_COMMS_CMD           1
 157
 158 /* MXT_SPT_CTECONFIG_T28 field */
 159 #define MXT_CTE_CTRL            0
 160 #define MXT_CTE_CMD             1
 161 #define MXT_CTE_MODE            2
 162 #define MXT_CTE_IDLEGCAFDEPTH   3
 163 #define MXT_CTE_ACTVGCAFDEPTH   4
 164 #define MXT_CTE_VOLTAGE         5
 165
 166 #define MXT_VOLTAGE_DEFAULT     2700000
 167 #define MXT_VOLTAGE_STEP        10000
 168
 169 /* Define for MXT_GEN_COMMAND_T6 */
 170 #define MXT_BOOT_VALUE          0xa5
 171 #define MXT_RESET_VALUE         0x01
 172 #define MXT_BACKUP_VALUE        0x55
 173
 174 /* Delay times */
 175 #define MXT_BACKUP_TIME         50      /* msec */
 176 #define MXT_RESET_TIME          200     /* msec */
 177 #define MXT_RESET_TIMEOUT       3000    /* msec */
 178 #define MXT_CRC_TIMEOUT         1000    /* msec */
 179 #define MXT_FW_RESET_TIME       3000    /* msec */
 180 #define MXT_FW_CHG_TIMEOUT      300     /* msec */
 181
 182 /* Command to unlock bootloader */
 183 #define MXT_UNLOCK_CMD_MSB      0xaa
 184 #define MXT_UNLOCK_CMD_LSB      0xdc
 185
 186 /* Bootloader mode status */
 187 #define MXT_WAITING_BOOTLOAD_CMD        0xc0    /* valid 7 6 bit only */
 188 #define MXT_WAITING_FRAME_DATA  0x80    /* valid 7 6 bit only */
 189 #define MXT_FRAME_CRC_CHECK     0x02
 190 #define MXT_FRAME_CRC_FAIL      0x03
 191 #define MXT_FRAME_CRC_PASS      0x04
 192 #define MXT_APP_CRC_FAIL        0x40    /* valid 7 8 bit only */
 193 #define MXT_BOOT_STATUS_MASK    0x3f
 194 #define MXT_BOOT_EXTENDED_ID    (1 << 5)
 195 #define MXT_BOOT_ID_MASK        0x1f
 196
 197 /* Touchscreen absolute values */
 198 #define MXT_MAX_AREA            0xff
 199
 200 #define MXT_PIXELS_PER_MM       20
 201
 202 struct mxt_info {
 203         u8 family_id;
 204         u8 variant_id;
 205         u8 version;
 206         u8 build;
 207         u8 matrix_xsize;
 208         u8 matrix_ysize;
 209         u8 object_num;
 210 };
 211
 212 struct mxt_object {
 213         u8 type;
 214         u16 start_address;
 215         u8 size_minus_one;
 216         u8 instances_minus_one;
 217         u8 num_report_ids;
 218 } __packed;
 219
 220 struct mxt_message {
 221         u8 reportid;
 222         u8 message[7];
 223 };
 224
 225 /* Each client has this additional data */
 226 struct mxt_data {
 227         struct i2c_client *client;
 228         struct input_dev *input_dev;
 229         char phys[64];          /* device physical location */
 230         const struct mxt_platform_data *pdata;
 231         struct mxt_object *object_table;
 232         struct mxt_info info;
 233         unsigned int irq;
 234         unsigned int max_x;
 235         unsigned int max_y;
 236         bool in_bootloader;
 237         u32 config_crc;
 238         u8 bootloader_addr;
 239
 240         /* Cached parameters from object table */
 241         u8 T6_reportid;
 242         u16 T6_address;
 243         u8 T9_reportid_min;
 244         u8 T9_reportid_max;
 245         u8 T19_reportid;
 246
 247         /* for fw update in bootloader */
 248         struct completion bl_completion;
 249
 250         /* for reset handling */
 251         struct completion reset_completion;
 252
 253         /* for config update handling */
 254         struct completion crc_completion;
 255 };
 256
 257 static size_t mxt_obj_size(const struct mxt_object *obj)
 258 {
 259         return obj->size_minus_one + 1;
 260 }
 261
 262 static size_t mxt_obj_instances(const struct mxt_object *obj)
 263 {
 264         return obj->instances_minus_one + 1;
 265 }
 266
 267 static bool mxt_object_readable(unsigned int type)
 268 {
 269         switch (type) {
 270         case MXT_GEN_COMMAND_T6:
 271         case MXT_GEN_POWER_T7:
 272         case MXT_GEN_ACQUIRE_T8:
 273         case MXT_GEN_DATASOURCE_T53:
 274         case MXT_TOUCH_MULTI_T9:
 275         case MXT_TOUCH_KEYARRAY_T15:
 276         case MXT_TOUCH_PROXIMITY_T23:
 277         case MXT_TOUCH_PROXKEY_T52:
 278         case MXT_PROCI_GRIPFACE_T20:
 279         case MXT_PROCG_NOISE_T22:
 280         case MXT_PROCI_ONETOUCH_T24:
 281         case MXT_PROCI_TWOTOUCH_T27:
 282         case MXT_PROCI_GRIP_T40:
 283         case MXT_PROCI_PALM_T41:
 284         case MXT_PROCI_TOUCHSUPPRESSION_T42:
 285         case MXT_PROCI_STYLUS_T47:
 286         case MXT_PROCG_NOISESUPPRESSION_T48:
 287         case MXT_SPT_COMMSCONFIG_T18:
 288         case MXT_SPT_GPIOPWM_T19:
 289         case MXT_SPT_SELFTEST_T25:
 290         case MXT_SPT_CTECONFIG_T28:
 291         case MXT_SPT_USERDATA_T38:
 292         case MXT_SPT_DIGITIZER_T43:
 293         case MXT_SPT_CTECONFIG_T46:
 294                 return true;
 295         default:
 296                 return false;
 297         }
 298 }
 299
 300 static bool mxt_object_writable(unsigned int type)
 301 {
 302         switch (type) {
 303         case MXT_GEN_COMMAND_T6:
 304         case MXT_GEN_POWER_T7:
 305         case MXT_GEN_ACQUIRE_T8:
 306         case MXT_TOUCH_MULTI_T9:
 307         case MXT_TOUCH_KEYARRAY_T15:
 308         case MXT_TOUCH_PROXIMITY_T23:
 309         case MXT_TOUCH_PROXKEY_T52:
 310         case MXT_PROCI_GRIPFACE_T20:
 311         case MXT_PROCG_NOISE_T22:
 312         case MXT_PROCI_ONETOUCH_T24:
 313         case MXT_PROCI_TWOTOUCH_T27:
 314         case MXT_PROCI_GRIP_T40:
 315         case MXT_PROCI_PALM_T41:
 316         case MXT_PROCI_TOUCHSUPPRESSION_T42:
 317         case MXT_PROCI_STYLUS_T47:
 318         case MXT_PROCG_NOISESUPPRESSION_T48:
 319         case MXT_SPT_COMMSCONFIG_T18:
 320         case MXT_SPT_GPIOPWM_T19:
 321         case MXT_SPT_SELFTEST_T25:
 322         case MXT_SPT_CTECONFIG_T28:
 323         case MXT_SPT_DIGITIZER_T43:
 324         case MXT_SPT_CTECONFIG_T46:
 325                 return true;
 326         default:
 327                 return false;
 328         }
 329 }
 330
 331 static void mxt_dump_message(struct device *dev,
 332                              struct mxt_message *message)
 333 {
 334         dev_dbg(dev, "reportid: %u\tmessage: %*ph\n",
 335                 message->reportid, 7, message->message);
 336 }
 337
 338 static int mxt_wait_for_completion(struct mxt_data *data,
 339                                    struct completion *comp,
 340                                    unsigned int timeout_ms)
 341 {
 342         struct device *dev = &data->client->dev;
 343         unsigned long timeout = msecs_to_jiffies(timeout_ms);
 344         long ret;
 345
 346         ret = wait_for_completion_interruptible_timeout(comp, timeout);
 347         if (ret < 0) {
 348                 return ret;
 349         } else if (ret == 0) {
 350                 dev_err(dev, "Wait for completion timed out.\n");
 351                 return -ETIMEDOUT;
 352         }
 353         return 0;
 354 }
 355
 356 static int mxt_bootloader_read(struct mxt_data *data,
 357                                u8 *val, unsigned int count)
 358 {
 359         int ret;
 360         struct i2c_msg msg;
 361
 362         msg.addr = data->bootloader_addr;
 363         msg.flags = data->client->flags & I2C_M_TEN;
 364         msg.flags |= I2C_M_RD;
 365         msg.len = count;
 366         msg.buf = val;
 367
 368         ret = i2c_transfer(data->client->adapter, &msg, 1);
 369
 370         if (ret == 1) {
 371                 ret = 0;
 372         } else {
 373                 ret = ret < 0 ? ret : -EIO;
 374                 dev_err(&data->client->dev, "%s: i2c recv failed (%d)\n",
 375                         __func__, ret);
 376         }
 377
 378         return ret;
 379 }
 380
 381 static int mxt_bootloader_write(struct mxt_data *data,
 382                                 const u8 * const val, unsigned int count)
 383 {
 384         int ret;
 385         struct i2c_msg msg;
 386
 387         msg.addr = data->bootloader_addr;
 388         msg.flags = data->client->flags & I2C_M_TEN;
 389         msg.len = count;
 390         msg.buf = (u8 *)val;
 391
 392         ret = i2c_transfer(data->client->adapter, &msg, 1);
 393         if (ret == 1) {
 394                 ret = 0;
 395         } else {
 396                 ret = ret < 0 ? ret : -EIO;
 397                 dev_err(&data->client->dev, "%s: i2c send failed (%d)\n",
 398                         __func__, ret);
 399         }
 400
 401         return ret;
 402 }
 403
 404 static int mxt_lookup_bootloader_address(struct mxt_data *data)
 405 {
 406         u8 appmode = data->client->addr;
 407         u8 bootloader;
 408
 409         switch (appmode) {
 410         case 0x4a:
 411         case 0x4b:
 412         case 0x4c:
 413         case 0x4d:
 414         case 0x5a:
 415         case 0x5b:
 416                 bootloader = appmode - 0x26;
 417                 break;
 418         default:
 419                 dev_err(&data->client->dev,
 420                         "Appmode i2c address 0x%02x not found\n",
 421                         appmode);
 422                 return -EINVAL;
 423         }
 424
 425         data->bootloader_addr = bootloader;
 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 {
 452         struct device *dev = &data->client->dev;
 453         u8 val;
 454         int ret;
 455
 456 recheck:
 457         if (state != MXT_WAITING_BOOTLOAD_CMD) {
 458                 /*
 459                  * In application update mode, the interrupt
 460                  * line signals state transitions. We must wait for the
 461                  * CHG assertion before reading the status byte.
 462                  * Once the status byte has been read, the line is deasserted.
 463                  */
 464                 ret = mxt_wait_for_completion(data, &data->bl_completion,
 465                                               MXT_FW_CHG_TIMEOUT);
 466                 if (ret) {
 467                         /*
 468                          * TODO: handle -ERESTARTSYS better by terminating
 469                          * fw update process before returning to userspace
 470                          * by writing length 0x000 to device (iff we are in
 471                          * WAITING_FRAME_DATA state).
 472                          */
 473                         dev_err(dev, "Update wait error %d\n", ret);
 474                         return ret;
 475                 }
 476         }
 477
 478         ret = mxt_bootloader_read(data, &val, 1);
 479         if (ret)
 480                 return ret;
 481
 482         if (state == MXT_WAITING_BOOTLOAD_CMD)
 483                 val = mxt_get_bootloader_version(data, val);
 484
 485         switch (state) {
 486         case MXT_WAITING_BOOTLOAD_CMD:
 487         case MXT_WAITING_FRAME_DATA:
 488                 val &= ~MXT_BOOT_STATUS_MASK;
 489                 break;
 490         case MXT_FRAME_CRC_PASS:
 491                 if (val == MXT_FRAME_CRC_CHECK) {
 492                         goto recheck;
 493                 } else if (val == MXT_FRAME_CRC_FAIL) {
 494                         dev_err(dev, "Bootloader CRC fail\n");
 495                         return -EINVAL;
 496                 }
 497                 break;
 498         default:
 499                 return -EINVAL;
 500         }
 501
 502         if (val != state) {
 503                 dev_err(dev, "Invalid bootloader state %02X != %02X\n",
 504                         val, state);
 505                 return -EINVAL;
 506         }
 507
 508         return 0;
 509 }
 510
 511 static int mxt_unlock_bootloader(struct mxt_data *data)
 512 {
 513         int ret;
 514         u8 buf[2];
 515
 516         buf[0] = MXT_UNLOCK_CMD_LSB;
 517         buf[1] = MXT_UNLOCK_CMD_MSB;
 518
 519         ret = mxt_bootloader_write(data, buf, 2);
 520         if (ret)
 521                 return ret;
 522
 523         return 0;
 524 }
 525
 526 static int __mxt_read_reg(struct i2c_client *client,
 527                                u16 reg, u16 len, void *val)
 528 {
 529         struct i2c_msg xfer[2];
 530         u8 buf[2];
 531         int ret;
 532
 533         buf[0] = reg & 0xff;
 534         buf[1] = (reg >> 8) & 0xff;
 535
 536         /* Write register */
 537         xfer[0].addr = client->addr;
 538         xfer[0].flags = 0;
 539         xfer[0].len = 2;
 540         xfer[0].buf = buf;
 541
 542         /* Read data */
 543         xfer[1].addr = client->addr;
 544         xfer[1].flags = I2C_M_RD;
 545         xfer[1].len = len;
 546         xfer[1].buf = val;
 547
 548         ret = i2c_transfer(client->adapter, xfer, 2);
 549         if (ret == 2) {
 550                 ret = 0;
 551         } else {
 552                 if (ret >= 0)
 553                         ret = -EIO;
 554                 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
 555                         __func__, ret);
 556         }
 557
 558         return ret;
 559 }
 560
 561 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
 562                            const void *val)
 563 {
 564         u8 *buf;
 565         size_t count;
 566         int ret;
 567
 568         count = len + 2;
 569         buf = kmalloc(count, GFP_KERNEL);
 570         if (!buf)
 571                 return -ENOMEM;
 572
 573         buf[0] = reg & 0xff;
 574         buf[1] = (reg >> 8) & 0xff;
 575         memcpy(&buf[2], val, len);
 576
 577         ret = i2c_master_send(client, buf, count);
 578         if (ret == count) {
 579                 ret = 0;
 580         } else {
 581                 if (ret >= 0)
 582                         ret = -EIO;
 583                 dev_err(&client->dev, "%s: i2c send failed (%d)\n",
 584                         __func__, ret);
 585         }
 586
 587         kfree(buf);
 588         return ret;
 589 }
 590
 591 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
 592 {
 593         return __mxt_write_reg(client, reg, 1, &val);
 594 }
 595
 596 static struct mxt_object *
 597 mxt_get_object(struct mxt_data *data, u8 type)
 598 {
 599         struct mxt_object *object;
 600         int i;
 601
 602         for (i = 0; i < data->info.object_num; i++) {
 603                 object = data->object_table + i;
 604                 if (object->type == type)
 605                         return object;
 606         }
 607
 608         dev_err(&data->client->dev, "Invalid object type T%u\n", type);
 609         return NULL;
 610 }
 611
 612 static int mxt_read_message(struct mxt_data *data,
 613                                  struct mxt_message *message)
 614 {
 615         struct mxt_object *object;
 616         u16 reg;
 617
 618         object = mxt_get_object(data, MXT_GEN_MESSAGE_T5);
 619         if (!object)
 620                 return -EINVAL;
 621
 622         reg = object->start_address;
 623         return __mxt_read_reg(data->client, reg,
 624                         sizeof(struct mxt_message), message);
 625 }
 626
 627 static int mxt_write_object(struct mxt_data *data,
 628                                  u8 type, u8 offset, u8 val)
 629 {
 630         struct mxt_object *object;
 631         u16 reg;
 632
 633         object = mxt_get_object(data, type);
 634         if (!object || offset >= mxt_obj_size(object))
 635                 return -EINVAL;
 636
 637         reg = object->start_address;
 638         return mxt_write_reg(data->client, reg + offset, val);
 639 }
 640
 641 static void mxt_input_button(struct mxt_data *data, struct mxt_message *message)
 642 {
 643         struct input_dev *input = data->input_dev;
 644         const struct mxt_platform_data *pdata = data->pdata;
 645         bool button;
 646         int i;
 647
 648         /* Active-low switch */
 649         for (i = 0; i < pdata->t19_num_keys; i++) {
 650                 if (pdata->t19_keymap[i] == KEY_RESERVED)
 651                         continue;
 652                 button = !(message->message[0] & (1 << i));
 653                 input_report_key(input, pdata->t19_keymap[i], button);
 654         }
 655 }
 656
 657 static void mxt_input_sync(struct input_dev *input_dev)
 658 {
 659         input_mt_report_pointer_emulation(input_dev, false);
 660         input_sync(input_dev);
 661 }
 662
 663 static void mxt_input_touchevent(struct mxt_data *data,
 664                                       struct mxt_message *message, int id)
 665 {
 666         struct device *dev = &data->client->dev;
 667         u8 status = message->message[0];
 668         struct input_dev *input_dev = data->input_dev;
 669         int x;
 670         int y;
 671         int area;
 672         int amplitude;
 673
 674         x = (message->message[1] << 4) | ((message->message[3] >> 4) & 0xf);
 675         y = (message->message[2] << 4) | ((message->message[3] & 0xf));
 676
 677         /* Handle 10/12 bit switching */
 678         if (data->max_x < 1024)
 679                 x >>= 2;
 680         if (data->max_y < 1024)
 681                 y >>= 2;
 682
 683         area = message->message[4];
 684         amplitude = message->message[5];
 685
 686         dev_dbg(dev,
 687                 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
 688                 id,
 689                 (status & MXT_T9_DETECT) ? 'D' : '.',
 690                 (status & MXT_T9_PRESS) ? 'P' : '.',
 691                 (status & MXT_T9_RELEASE) ? 'R' : '.',
 692                 (status & MXT_T9_MOVE) ? 'M' : '.',
 693                 (status & MXT_T9_VECTOR) ? 'V' : '.',
 694                 (status & MXT_T9_AMP) ? 'A' : '.',
 695                 (status & MXT_T9_SUPPRESS) ? 'S' : '.',
 696                 (status & MXT_T9_UNGRIP) ? 'U' : '.',
 697                 x, y, area, amplitude);
 698
 699         input_mt_slot(input_dev, id);
 700
 701         if (status & MXT_T9_DETECT) {
 702                 /*
 703                  * Multiple bits may be set if the host is slow to read
 704                  * the status messages, indicating all the events that
 705                  * have happened.
 706                  */
 707                 if (status & MXT_T9_RELEASE) {
 708                         input_mt_report_slot_state(input_dev,
 709                                                    MT_TOOL_FINGER, 0);
 710                         mxt_input_sync(input_dev);
 711                 }
 712
 713                 /* Touch active */
 714                 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 1);
 715                 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
 716                 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
 717                 input_report_abs(input_dev, ABS_MT_PRESSURE, amplitude);
 718                 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
 719         } else {
 720                 /* Touch no longer active, close out slot */
 721                 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, 0);
 722         }
 723 }
 724
 725 static u16 mxt_extract_T6_csum(const u8 *csum)
 726 {
 727         return csum[0] | (csum[1] << 8) | (csum[2] << 16);
 728 }
 729
 730 static bool mxt_is_T9_message(struct mxt_data *data, struct mxt_message *msg)
 731 {
 732         u8 id = msg->reportid;
 733         return (id >= data->T9_reportid_min && id <= data->T9_reportid_max);
 734 }
 735
 736 static irqreturn_t mxt_process_messages_until_invalid(struct mxt_data *data)
 737 {
 738         struct mxt_message message;
 739         const u8 *payload = &message.message[0];
 740         struct device *dev = &data->client->dev;
 741         u8 reportid;
 742         bool update_input = false;
 743         u32 crc;
 744
 745         do {
 746                 if (mxt_read_message(data, &message)) {
 747                         dev_err(dev, "Failed to read message\n");
 748                         return IRQ_NONE;
 749                 }
 750
 751                 reportid = message.reportid;
 752
 753                 if (reportid == data->T6_reportid) {
 754                         u8 status = payload[0];
 755
 756                         crc = mxt_extract_T6_csum(&payload[1]);
 757                         if (crc != data->config_crc) {
 758                                 data->config_crc = crc;
 759                                 complete(&data->crc_completion);
 760                         }
 761
 762                         dev_dbg(dev, "Status: %02x Config Checksum: %06x\n",
 763                                 status, data->config_crc);
 764
 765                         if (status & MXT_T6_STATUS_RESET)
 766                                 complete(&data->reset_completion);
 767                 } else if (!data->input_dev) {
 768                         /*
 769                          * do not report events if input device
 770                          * is not yet registered
 771                          */
 772                         mxt_dump_message(dev, &message);
 773                 } else if (mxt_is_T9_message(data, &message)) {
 774                         int id = reportid - data->T9_reportid_min;
 775                         mxt_input_touchevent(data, &message, id);
 776                         update_input = true;
 777                 } else if (message.reportid == data->T19_reportid) {
 778                         mxt_input_button(data, &message);
 779                         update_input = true;
 780                 } else {
 781                         mxt_dump_message(dev, &message);
 782                 }
 783         } while (reportid != 0xff);
 784
 785         if (update_input)
 786                 mxt_input_sync(data->input_dev);
 787
 788         return IRQ_HANDLED;
 789 }
 790
 791 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
 792 {
 793         struct mxt_data *data = dev_id;
 794
 795         if (data->in_bootloader) {
 796                 /* bootloader state transition completion */
 797                 complete(&data->bl_completion);
 798                 return IRQ_HANDLED;
 799         }
 800
 801         if (!data->object_table)
 802                 return IRQ_HANDLED;
 803
 804         return mxt_process_messages_until_invalid(data);
 805 }
 806
 807 static int mxt_t6_command(struct mxt_data *data, u16 cmd_offset,
 808                           u8 value, bool wait)
 809 {
 810         u16 reg;
 811         u8 command_register;
 812         int timeout_counter = 0;
 813         int ret;
 814
 815         reg = data->T6_address + cmd_offset;
 816
 817         ret = mxt_write_reg(data->client, reg, value);
 818         if (ret)
 819                 return ret;
 820
 821         if (!wait)
 822                 return 0;
 823
 824         do {
 825                 msleep(20);
 826                 ret = __mxt_read_reg(data->client, reg, 1, &command_register);
 827                 if (ret)
 828                         return ret;
 829         } while (command_register != 0 && timeout_counter++ <= 100);
 830
 831         if (timeout_counter > 100) {
 832                 dev_err(&data->client->dev, "Command failed!\n");
 833                 return -EIO;
 834         }
 835
 836         return 0;
 837 }
 838
 839 static int mxt_soft_reset(struct mxt_data *data)
 840 {
 841         struct device *dev = &data->client->dev;
 842         int ret = 0;
 843
 844         dev_info(dev, "Resetting chip\n");
 845
 846         reinit_completion(&data->reset_completion);
 847
 848         ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_RESET_VALUE, false);
 849         if (ret)
 850                 return ret;
 851
 852         ret = mxt_wait_for_completion(data, &data->reset_completion,
 853                                       MXT_RESET_TIMEOUT);
 854         if (ret)
 855                 return ret;
 856
 857         return 0;
 858 }
 859
 860 static void mxt_update_crc(struct mxt_data *data, u8 cmd, u8 value)
 861 {
 862         /*
 863          * On failure, CRC is set to 0 and config will always be
 864          * downloaded.
 865          */
 866         data->config_crc = 0;
 867         reinit_completion(&data->crc_completion);
 868
 869         mxt_t6_command(data, cmd, value, true);
 870
 871         /*
 872          * Wait for crc message. On failure, CRC is set to 0 and config will
 873          * always be downloaded.
 874          */
 875         mxt_wait_for_completion(data, &data->crc_completion, MXT_CRC_TIMEOUT);
 876 }
 877
 878 static int mxt_check_reg_init(struct mxt_data *data)
 879 {
 880         const struct mxt_platform_data *pdata = data->pdata;
 881         struct mxt_object *object;
 882         struct device *dev = &data->client->dev;
 883         int index = 0;
 884         int i, size;
 885         int ret;
 886
 887         if (!pdata->config) {
 888                 dev_dbg(dev, "No cfg data defined, skipping reg init\n");
 889                 return 0;
 890         }
 891
 892         mxt_update_crc(data, MXT_COMMAND_REPORTALL, 1);
 893
 894         if (data->config_crc == pdata->config_crc) {
 895                 dev_info(dev, "Config CRC 0x%06X: OK\n", data->config_crc);
 896                 return 0;
 897         }
 898
 899         dev_info(dev, "Config CRC 0x%06X: does not match 0x%06X\n",
 900                  data->config_crc, pdata->config_crc);
 901
 902         for (i = 0; i < data->info.object_num; i++) {
 903                 object = data->object_table + i;
 904
 905                 if (!mxt_object_writable(object->type))
 906                         continue;
 907
 908                 size = mxt_obj_size(object) * mxt_obj_instances(object);
 909                 if (index + size > pdata->config_length) {
 910                         dev_err(dev, "Not enough config data!\n");
 911                         return -EINVAL;
 912                 }
 913
 914                 ret = __mxt_write_reg(data->client, object->start_address,
 915                                 size, &pdata->config[index]);
 916                 if (ret)
 917                         return ret;
 918                 index += size;
 919         }
 920
 921         mxt_update_crc(data, MXT_COMMAND_BACKUPNV, MXT_BACKUP_VALUE);
 922
 923         ret = mxt_soft_reset(data);
 924         if (ret)
 925                 return ret;
 926
 927         dev_info(dev, "Config successfully updated\n");
 928
 929         return 0;
 930 }
 931
 932 static int mxt_make_highchg(struct mxt_data *data)
 933 {
 934         struct device *dev = &data->client->dev;
 935         struct mxt_message message;
 936         int count = 10;
 937         int error;
 938
 939         /* Read dummy message to make high CHG pin */
 940         do {
 941                 error = mxt_read_message(data, &message);
 942                 if (error)
 943                         return error;
 944         } while (message.reportid != 0xff && --count);
 945
 946         if (!count) {
 947                 dev_err(dev, "CHG pin isn't cleared\n");
 948                 return -EBUSY;
 949         }
 950
 951         return 0;
 952 }
 953
 954 static int mxt_acquire_irq(struct mxt_data *data)
 955 {
 956         int error;
 957
 958         enable_irq(data->irq);
 959
 960         error = mxt_make_highchg(data);
 961         if (error)
 962                 return error;
 963
 964         return 0;
 965 }
 966
 967 static int mxt_get_info(struct mxt_data *data)
 968 {
 969         struct i2c_client *client = data->client;
 970         struct mxt_info *info = &data->info;
 971         int error;
 972
 973         /* Read 7-byte info block starting at address 0 */
 974         error = __mxt_read_reg(client, MXT_INFO, sizeof(*info), info);
 975         if (error)
 976                 return error;
 977
 978         return 0;
 979 }
 980
 981 static int mxt_get_object_table(struct mxt_data *data)
 982 {
 983         struct i2c_client *client = data->client;
 984         size_t table_size;
 985         struct mxt_object *object_table;
 986         int error;
 987         int i;
 988         u8 reportid;
 989
 990         table_size = data->info.object_num * sizeof(struct mxt_object);
 991         object_table = kzalloc(table_size, GFP_KERNEL);
 992         if (!object_table) {
 993                 dev_err(&data->client->dev, "Failed to allocate memory\n");
 994                 return -ENOMEM;
 995         }
 996
 997         error = __mxt_read_reg(client, MXT_OBJECT_START, table_size,
 998                         object_table);
 999         if (error) {
1000                 kfree(object_table);
1001                 return error;
1002         }
1003
1004         /* Valid Report IDs start counting from 1 */
1005         reportid = 1;
1006         for (i = 0; i < data->info.object_num; i++) {
1007                 struct mxt_object *object = object_table + i;
1008                 u8 min_id, max_id;
1009
1010                 le16_to_cpus(&object->start_address);
1011
1012                 if (object->num_report_ids) {
1013                         min_id = reportid;
1014                         reportid += object->num_report_ids *
1015                                         mxt_obj_instances(object);
1016                         max_id = reportid - 1;
1017                 } else {
1018                         min_id = 0;
1019                         max_id = 0;
1020                 }
1021
1022                 dev_dbg(&data->client->dev,
1023                         "T%u Start:%u Size:%zu Instances:%zu Report IDs:%u-%u\n",
1024                         object->type, object->start_address,
1025                         mxt_obj_size(object), mxt_obj_instances(object),
1026                         min_id, max_id);
1027
1028                 switch (object->type) {
1029                 case MXT_GEN_COMMAND_T6:
1030                         data->T6_reportid = min_id;
1031                         data->T6_address = object->start_address;
1032                         break;
1033                 case MXT_TOUCH_MULTI_T9:
1034                         data->T9_reportid_min = min_id;
1035                         data->T9_reportid_max = max_id;
1036                         break;
1037                 case MXT_SPT_GPIOPWM_T19:
1038                         data->T19_reportid = min_id;
1039                         break;
1040                 }
1041         }
1042
1043         data->object_table = object_table;
1044
1045         return 0;
1046 }
1047
1048 static void mxt_free_object_table(struct mxt_data *data)
1049 {
1050         input_unregister_device(data->input_dev);
1051         data->input_dev = NULL;
1052
1053         kfree(data->object_table);
1054         data->object_table = NULL;
1055         data->T6_reportid = 0;
1056         data->T9_reportid_min = 0;
1057         data->T9_reportid_max = 0;
1058         data->T19_reportid = 0;
1059 }
1060
1061 static int mxt_read_t9_resolution(struct mxt_data *data)
1062 {
1063         struct i2c_client *client = data->client;
1064         int error;
1065         struct t9_range range;
1066         unsigned char orient;
1067         struct mxt_object *object;
1068
1069         object = mxt_get_object(data, MXT_TOUCH_MULTI_T9);
1070         if (!object)
1071                 return -EINVAL;
1072
1073         error = __mxt_read_reg(client,
1074                                object->start_address + MXT_T9_RANGE,
1075                                sizeof(range), &range);
1076         if (error)
1077                 return error;
1078
1079         le16_to_cpus(&range.x);
1080         le16_to_cpus(&range.y);
1081
1082         error =  __mxt_read_reg(client,
1083                                 object->start_address + MXT_T9_ORIENT,
1084                                 1, &orient);
1085         if (error)
1086                 return error;
1087
1088         /* Handle default values */
1089         if (range.x == 0)
1090                 range.x = 1023;
1091
1092         if (range.y == 0)
1093                 range.y = 1023;
1094
1095         if (orient & MXT_T9_ORIENT_SWITCH) {
1096                 data->max_x = range.y;
1097                 data->max_y = range.x;
1098         } else {
1099                 data->max_x = range.x;
1100                 data->max_y = range.y;
1101         }
1102
1103         dev_dbg(&client->dev,
1104                 "Touchscreen size X%uY%u\n", data->max_x, data->max_y);
1105
1106         return 0;
1107 }
1108
1109 static int mxt_input_open(struct input_dev *dev);
1110 static void mxt_input_close(struct input_dev *dev);
1111
1112 static int mxt_initialize_t9_input_device(struct mxt_data *data)
1113 {
1114         struct device *dev = &data->client->dev;
1115         const struct mxt_platform_data *pdata = data->pdata;
1116         struct input_dev *input_dev;
1117         int error;
1118         unsigned int num_mt_slots;
1119         unsigned int mt_flags = 0;
1120         int i;
1121
1122         error = mxt_read_t9_resolution(data);
1123         if (error)
1124                 dev_warn(dev, "Failed to initialize T9 resolution\n");
1125
1126         input_dev = input_allocate_device();
1127         if (!input_dev) {
1128                 dev_err(dev, "Failed to allocate memory\n");
1129                 return -ENOMEM;
1130         }
1131
1132         input_dev->name = "Atmel maXTouch Touchscreen";
1133         input_dev->phys = data->phys;
1134         input_dev->id.bustype = BUS_I2C;
1135         input_dev->dev.parent = dev;
1136         input_dev->open = mxt_input_open;
1137         input_dev->close = mxt_input_close;
1138
1139         __set_bit(EV_ABS, input_dev->evbit);
1140         __set_bit(EV_KEY, input_dev->evbit);
1141         __set_bit(BTN_TOUCH, input_dev->keybit);
1142
1143         if (pdata->t19_num_keys) {
1144                 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1145
1146                 for (i = 0; i < pdata->t19_num_keys; i++)
1147                         if (pdata->t19_keymap[i] != KEY_RESERVED)
1148                                 input_set_capability(input_dev, EV_KEY,
1149                                                      pdata->t19_keymap[i]);
1150
1151                 mt_flags |= INPUT_MT_POINTER;
1152
1153                 input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1154                 input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1155                 input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1156                                   MXT_PIXELS_PER_MM);
1157                 input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1158                                   MXT_PIXELS_PER_MM);
1159
1160                 input_dev->name = "Atmel maXTouch Touchpad";
1161         }
1162
1163         /* For single touch */
1164         input_set_abs_params(input_dev, ABS_X,
1165                              0, data->max_x, 0, 0);
1166         input_set_abs_params(input_dev, ABS_Y,
1167                              0, data->max_y, 0, 0);
1168         input_set_abs_params(input_dev, ABS_PRESSURE,
1169                              0, 255, 0, 0);
1170
1171         /* For multi touch */
1172         num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1173         error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
1174         if (error) {
1175                 dev_err(dev, "Error %d initialising slots\n", error);
1176                 goto err_free_mem;
1177         }
1178
1179         input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1180                              0, MXT_MAX_AREA, 0, 0);
1181         input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1182                              0, data->max_x, 0, 0);
1183         input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1184                              0, data->max_y, 0, 0);
1185         input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1186                              0, 255, 0, 0);
1187
1188         input_set_drvdata(input_dev, data);
1189
1190         error = input_register_device(input_dev);
1191         if (error) {
1192                 dev_err(dev, "Error %d registering input device\n", error);
1193                 goto err_free_mem;
1194         }
1195
1196         data->input_dev = input_dev;
1197
1198         return 0;
1199
1200 err_free_mem:
1201         input_free_device(input_dev);
1202         return error;
1203 }
1204
1205 static int mxt_initialize(struct mxt_data *data)
1206 {
1207         struct i2c_client *client = data->client;
1208         struct mxt_info *info = &data->info;
1209         int error;
1210
1211         error = mxt_get_info(data);
1212         if (error)
1213                 return error;
1214
1215         /* Get object table information */
1216         error = mxt_get_object_table(data);
1217         if (error) {
1218                 dev_err(&client->dev, "Error %d reading object table\n", error);
1219                 return error;
1220         }
1221
1222         mxt_acquire_irq(data);
1223         if (error)
1224                 goto err_free_object_table;
1225
1226         /* Check register init values */
1227         error = mxt_check_reg_init(data);
1228         if (error) {
1229                 dev_err(&client->dev, "Error %d initializing configuration\n",
1230                         error);
1231                 goto err_free_object_table;
1232         }
1233
1234         error = mxt_initialize_t9_input_device(data);
1235         if (error)
1236                 goto err_free_object_table;
1237
1238         dev_info(&client->dev,
1239                  "Family: %u Variant: %u Firmware V%u.%u.%02X Objects: %u\n",
1240                  info->family_id, info->variant_id, info->version >> 4,
1241                  info->version & 0xf, info->build, info->object_num);
1242
1243         return 0;
1244
1245 err_free_object_table:
1246         mxt_free_object_table(data);
1247         return error;
1248 }
1249
1250 /* Firmware Version is returned as Major.Minor.Build */
1251 static ssize_t mxt_fw_version_show(struct device *dev,
1252                                    struct device_attribute *attr, char *buf)
1253 {
1254         struct mxt_data *data = dev_get_drvdata(dev);
1255         struct mxt_info *info = &data->info;
1256         return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
1257                          info->version >> 4, info->version & 0xf, info->build);
1258 }
1259
1260 /* Hardware Version is returned as FamilyID.VariantID */
1261 static ssize_t mxt_hw_version_show(struct device *dev,
1262                                    struct device_attribute *attr, char *buf)
1263 {
1264         struct mxt_data *data = dev_get_drvdata(dev);
1265         struct mxt_info *info = &data->info;
1266         return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
1267                          info->family_id, info->variant_id);
1268 }
1269
1270 static ssize_t mxt_show_instance(char *buf, int count,
1271                                  struct mxt_object *object, int instance,
1272                                  const u8 *val)
1273 {
1274         int i;
1275
1276         if (mxt_obj_instances(object) > 1)
1277                 count += scnprintf(buf + count, PAGE_SIZE - count,
1278                                    "Instance %u\n", instance);
1279
1280         for (i = 0; i < mxt_obj_size(object); i++)
1281                 count += scnprintf(buf + count, PAGE_SIZE - count,
1282                                 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
1283         count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
1284
1285         return count;
1286 }
1287
1288 static ssize_t mxt_object_show(struct device *dev,
1289                                     struct device_attribute *attr, char *buf)
1290 {
1291         struct mxt_data *data = dev_get_drvdata(dev);
1292         struct mxt_object *object;
1293         int count = 0;
1294         int i, j;
1295         int error;
1296         u8 *obuf;
1297
1298         /* Pre-allocate buffer large enough to hold max sized object. */
1299         obuf = kmalloc(256, GFP_KERNEL);
1300         if (!obuf)
1301                 return -ENOMEM;
1302
1303         error = 0;
1304         for (i = 0; i < data->info.object_num; i++) {
1305                 object = data->object_table + i;
1306
1307                 if (!mxt_object_readable(object->type))
1308                         continue;
1309
1310                 count += scnprintf(buf + count, PAGE_SIZE - count,
1311                                 "T%u:\n", object->type);
1312
1313                 for (j = 0; j < mxt_obj_instances(object); j++) {
1314                         u16 size = mxt_obj_size(object);
1315                         u16 addr = object->start_address + j * size;
1316
1317                         error = __mxt_read_reg(data->client, addr, size, obuf);
1318                         if (error)
1319                                 goto done;
1320
1321                         count = mxt_show_instance(buf, count, object, j, obuf);
1322                 }
1323         }
1324
1325 done:
1326         kfree(obuf);
1327         return error ?: count;
1328 }
1329
1330 static int mxt_check_firmware_format(struct device *dev,
1331                                      const struct firmware *fw)
1332 {
1333         unsigned int pos = 0;
1334         char c;
1335
1336         while (pos < fw->size) {
1337                 c = *(fw->data + pos);
1338
1339                 if (c < '0' || (c > '9' && c < 'A') || c > 'F')
1340                         return 0;
1341
1342                 pos++;
1343         }
1344
1345         /*
1346          * To convert file try:
1347          * xxd -r -p mXTXXX__APP_VX-X-XX.enc > maxtouch.fw
1348          */
1349         dev_err(dev, "Aborting: firmware file must be in binary format\n");
1350
1351         return -EINVAL;
1352 }
1353
1354 static int mxt_load_fw(struct device *dev, const char *fn)
1355 {
1356         struct mxt_data *data = dev_get_drvdata(dev);
1357         const struct firmware *fw = NULL;
1358         unsigned int frame_size;
1359         unsigned int pos = 0;
1360         unsigned int retry = 0;
1361         unsigned int frame = 0;
1362         int ret;
1363
1364         ret = request_firmware(&fw, fn, dev);
1365         if (ret) {
1366                 dev_err(dev, "Unable to open firmware %s\n", fn);
1367                 return ret;
1368         }
1369
1370         /* Check for incorrect enc file */
1371         ret = mxt_check_firmware_format(dev, fw);
1372         if (ret)
1373                 goto release_firmware;
1374
1375         ret = mxt_lookup_bootloader_address(data);
1376         if (ret)
1377                 goto release_firmware;
1378
1379         /* Change to the bootloader mode */
1380         data->in_bootloader = true;
1381
1382         ret = mxt_t6_command(data, MXT_COMMAND_RESET, MXT_BOOT_VALUE, false);
1383         if (ret)
1384                 goto release_firmware;
1385
1386         msleep(MXT_RESET_TIME);
1387
1388         reinit_completion(&data->bl_completion);
1389
1390         ret = mxt_check_bootloader(data, MXT_WAITING_BOOTLOAD_CMD);
1391         if (ret)
1392                 goto disable_irq;
1393
1394         /* Unlock bootloader */
1395         mxt_unlock_bootloader(data);
1396
1397         while (pos < fw->size) {
1398                 ret = mxt_check_bootloader(data, MXT_WAITING_FRAME_DATA);
1399                 if (ret)
1400                         goto disable_irq;
1401
1402                 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
1403
1404                 /* Take account of CRC bytes */
1405                 frame_size += 2;
1406
1407                 /* Write one frame to device */
1408                 ret = mxt_bootloader_write(data, fw->data + pos, frame_size);
1409                 if (ret)
1410                         goto disable_irq;
1411
1412                 ret = mxt_check_bootloader(data, MXT_FRAME_CRC_PASS);
1413                 if (ret) {
1414                         retry++;
1415
1416                         /* Back off by 20ms per retry */
1417                         msleep(retry * 20);
1418
1419                         if (retry > 20) {
1420                                 dev_err(dev, "Retry count exceeded\n");
1421                                 goto disable_irq;
1422                         }
1423                 } else {
1424                         retry = 0;
1425                         pos += frame_size;
1426                         frame++;
1427                 }
1428
1429                 if (frame % 50 == 0)
1430                         dev_dbg(dev, "Sent %d frames, %d/%zd bytes\n",
1431                                 frame, pos, fw->size);
1432         }
1433
1434         /* Wait for flash. */
1435         ret = mxt_wait_for_completion(data, &data->bl_completion,
1436                                       MXT_FW_RESET_TIME);
1437         if (ret)
1438                 goto disable_irq;
1439
1440         dev_dbg(dev, "Sent %d frames, %d bytes\n", frame, pos);
1441
1442         /*
1443          * Wait for device to reset. Some bootloader versions do not assert
1444          * the CHG line after bootloading has finished, so ignore potential
1445          * errors.
1446          */
1447         mxt_wait_for_completion(data, &data->bl_completion, MXT_FW_RESET_TIME);
1448
1449         data->in_bootloader = false;
1450
1451 disable_irq:
1452         disable_irq(data->irq);
1453 release_firmware:
1454         release_firmware(fw);
1455         return ret;
1456 }
1457
1458 static ssize_t mxt_update_fw_store(struct device *dev,
1459                                         struct device_attribute *attr,
1460                                         const char *buf, size_t count)
1461 {
1462         struct mxt_data *data = dev_get_drvdata(dev);
1463         int error;
1464
1465         error = mxt_load_fw(dev, MXT_FW_NAME);
1466         if (error) {
1467                 dev_err(dev, "The firmware update failed(%d)\n", error);
1468                 count = error;
1469         } else {
1470                 dev_info(dev, "The firmware update succeeded\n");
1471
1472                 mxt_free_object_table(data);
1473
1474                 error = mxt_initialize(data);
1475                 if (error)
1476                         return error;
1477         }
1478
1479         return count;
1480 }
1481
1482 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
1483 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
1484 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
1485 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
1486
1487 static struct attribute *mxt_attrs[] = {
1488         &dev_attr_fw_version.attr,
1489         &dev_attr_hw_version.attr,
1490         &dev_attr_object.attr,
1491         &dev_attr_update_fw.attr,
1492         NULL
1493 };
1494
1495 static const struct attribute_group mxt_attr_group = {
1496         .attrs = mxt_attrs,
1497 };
1498
1499 static void mxt_start(struct mxt_data *data)
1500 {
1501         /* Touch enable */
1502         mxt_write_object(data,
1503                         MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0x83);
1504 }
1505
1506 static void mxt_stop(struct mxt_data *data)
1507 {
1508         /* Touch disable */
1509         mxt_write_object(data,
1510                         MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0);
1511 }
1512
1513 static int mxt_input_open(struct input_dev *dev)
1514 {
1515         struct mxt_data *data = input_get_drvdata(dev);
1516
1517         mxt_start(data);
1518
1519         return 0;
1520 }
1521
1522 static void mxt_input_close(struct input_dev *dev)
1523 {
1524         struct mxt_data *data = input_get_drvdata(dev);
1525
1526         mxt_stop(data);
1527 }
1528
1529 static int mxt_probe(struct i2c_client *client,
1530                 const struct i2c_device_id *id)
1531 {
1532         struct mxt_data *data;
1533         const struct mxt_platform_data *pdata = dev_get_platdata(&client->dev);
1534         int error;
1535
1536         if (!pdata)
1537                 return -EINVAL;
1538
1539         data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
1540         if (!data) {
1541                 dev_err(&client->dev, "Failed to allocate memory\n");
1542                 return -ENOMEM;
1543         }
1544
1545         snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
1546                  client->adapter->nr, client->addr);
1547
1548         data->client = client;
1549         data->pdata = pdata;
1550         data->irq = client->irq;
1551         i2c_set_clientdata(client, data);
1552
1553         init_completion(&data->bl_completion);
1554         init_completion(&data->reset_completion);
1555         init_completion(&data->crc_completion);
1556
1557         error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
1558                                      pdata->irqflags | IRQF_ONESHOT,
1559                                      client->name, data);
1560         if (error) {
1561                 dev_err(&client->dev, "Failed to register interrupt\n");
1562                 goto err_free_mem;
1563         }
1564
1565         disable_irq(client->irq);
1566
1567         error = mxt_initialize(data);
1568         if (error)
1569                 goto err_free_irq;
1570
1571         error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
1572         if (error) {
1573                 dev_err(&client->dev, "Failure %d creating sysfs group\n",
1574                         error);
1575                 goto err_free_object;
1576         }
1577
1578         return 0;
1579
1580 err_free_object:
1581         kfree(data->object_table);
1582 err_free_irq:
1583         free_irq(client->irq, data);
1584 err_free_mem:
1585         kfree(data);
1586         return error;
1587 }
1588
1589 static int mxt_remove(struct i2c_client *client)
1590 {
1591         struct mxt_data *data = i2c_get_clientdata(client);
1592
1593         sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
1594         free_irq(data->irq, data);
1595         input_unregister_device(data->input_dev);
1596         kfree(data->object_table);
1597         kfree(data);
1598
1599         return 0;
1600 }
1601
1602 #ifdef CONFIG_PM_SLEEP
1603 static int mxt_suspend(struct device *dev)
1604 {
1605         struct i2c_client *client = to_i2c_client(dev);
1606         struct mxt_data *data = i2c_get_clientdata(client);
1607         struct input_dev *input_dev = data->input_dev;
1608
1609         mutex_lock(&input_dev->mutex);
1610
1611         if (input_dev->users)
1612                 mxt_stop(data);
1613
1614         mutex_unlock(&input_dev->mutex);
1615
1616         return 0;
1617 }
1618
1619 static int mxt_resume(struct device *dev)
1620 {
1621         struct i2c_client *client = to_i2c_client(dev);
1622         struct mxt_data *data = i2c_get_clientdata(client);
1623         struct input_dev *input_dev = data->input_dev;
1624
1625         mxt_soft_reset(data);
1626
1627         mutex_lock(&input_dev->mutex);
1628
1629         if (input_dev->users)
1630                 mxt_start(data);
1631
1632         mutex_unlock(&input_dev->mutex);
1633
1634         return 0;
1635 }
1636 #endif
1637
1638 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
1639
1640 static const struct i2c_device_id mxt_id[] = {
1641         { "qt602240_ts", 0 },
1642         { "atmel_mxt_ts", 0 },
1643         { "atmel_mxt_tp", 0 },
1644         { "mXT224", 0 },
1645         { }
1646 };
1647 MODULE_DEVICE_TABLE(i2c, mxt_id);
1648
1649 static struct i2c_driver mxt_driver = {
1650         .driver = {
1651                 .name   = "atmel_mxt_ts",
1652                 .owner  = THIS_MODULE,
1653                 .pm     = &mxt_pm_ops,
1654         },
1655         .probe          = mxt_probe,
1656         .remove         = mxt_remove,
1657         .id_table       = mxt_id,
1658 };
1659
1660 module_i2c_driver(mxt_driver);
1661
1662 /* Module information */
1663 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
1664 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
1665 MODULE_LICENSE("GPL");