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/delay.h>
  18 #include <linux/firmware.h>
  19 #include <linux/i2c.h>
  20 #include <linux/i2c/atmel_mxt_ts.h>
  21 #include <linux/input/mt.h>
  22 #include <linux/interrupt.h>
  23 #include <linux/slab.h>
  24
  25 /* Version */
  26 #define MXT_VER_20              20
  27 #define MXT_VER_21              21
  28 #define MXT_VER_22              22
  29
  30 /* Slave addresses */
  31 #define MXT_APP_LOW             0x4a
  32 #define MXT_APP_HIGH            0x4b
  33 #define MXT_BOOT_LOW            0x24
  34 #define MXT_BOOT_HIGH           0x25
  35
  36 /* Firmware */
  37 #define MXT_FW_NAME             "maxtouch.fw"
  38
  39 /* Registers */
  40 #define MXT_INFO                0x00
  41 #define MXT_FAMILY_ID           0x00
  42 #define MXT_VARIANT_ID          0x01
  43 #define MXT_VERSION             0x02
  44 #define MXT_BUILD               0x03
  45 #define MXT_MATRIX_X_SIZE       0x04
  46 #define MXT_MATRIX_Y_SIZE       0x05
  47 #define MXT_OBJECT_NUM          0x06
  48 #define MXT_OBJECT_START        0x07
  49
  50 #define MXT_OBJECT_SIZE         6
  51
  52 /* Object types */
  53 #define MXT_DEBUG_DIAGNOSTIC_T37        37
  54 #define MXT_GEN_MESSAGE_T5              5
  55 #define MXT_GEN_COMMAND_T6              6
  56 #define MXT_GEN_POWER_T7                7
  57 #define MXT_GEN_ACQUIRE_T8              8
  58 #define MXT_GEN_DATASOURCE_T53          53
  59 #define MXT_TOUCH_MULTI_T9              9
  60 #define MXT_TOUCH_KEYARRAY_T15          15
  61 #define MXT_TOUCH_PROXIMITY_T23         23
  62 #define MXT_TOUCH_PROXKEY_T52           52
  63 #define MXT_PROCI_GRIPFACE_T20          20
  64 #define MXT_PROCG_NOISE_T22             22
  65 #define MXT_PROCI_ONETOUCH_T24          24
  66 #define MXT_PROCI_TWOTOUCH_T27          27
  67 #define MXT_PROCI_GRIP_T40              40
  68 #define MXT_PROCI_PALM_T41              41
  69 #define MXT_PROCI_TOUCHSUPPRESSION_T42  42
  70 #define MXT_PROCI_STYLUS_T47            47
  71 #define MXT_PROCG_NOISESUPPRESSION_T48  48
  72 #define MXT_SPT_COMMSCONFIG_T18         18
  73 #define MXT_SPT_GPIOPWM_T19             19
  74 #define MXT_SPT_SELFTEST_T25            25
  75 #define MXT_SPT_CTECONFIG_T28           28
  76 #define MXT_SPT_USERDATA_T38            38
  77 #define MXT_SPT_DIGITIZER_T43           43
  78 #define MXT_SPT_MESSAGECOUNT_T44        44
  79 #define MXT_SPT_CTECONFIG_T46           46
  80
  81 /* MXT_GEN_COMMAND_T6 field */
  82 #define MXT_COMMAND_RESET       0
  83 #define MXT_COMMAND_BACKUPNV    1
  84 #define MXT_COMMAND_CALIBRATE   2
  85 #define MXT_COMMAND_REPORTALL   3
  86 #define MXT_COMMAND_DIAGNOSTIC  5
  87
  88 /* MXT_GEN_POWER_T7 field */
  89 #define MXT_POWER_IDLEACQINT    0
  90 #define MXT_POWER_ACTVACQINT    1
  91 #define MXT_POWER_ACTV2IDLETO   2
  92
  93 /* MXT_GEN_ACQUIRE_T8 field */
  94 #define MXT_ACQUIRE_CHRGTIME    0
  95 #define MXT_ACQUIRE_TCHDRIFT    2
  96 #define MXT_ACQUIRE_DRIFTST     3
  97 #define MXT_ACQUIRE_TCHAUTOCAL  4
  98 #define MXT_ACQUIRE_SYNC        5
  99 #define MXT_ACQUIRE_ATCHCALST   6
 100 #define MXT_ACQUIRE_ATCHCALSTHR 7
 101
 102 /* MXT_TOUCH_MULTI_T9 field */
 103 #define MXT_TOUCH_CTRL          0
 104 #define MXT_TOUCH_XORIGIN       1
 105 #define MXT_TOUCH_YORIGIN       2
 106 #define MXT_TOUCH_XSIZE         3
 107 #define MXT_TOUCH_YSIZE         4
 108 #define MXT_TOUCH_BLEN          6
 109 #define MXT_TOUCH_TCHTHR        7
 110 #define MXT_TOUCH_TCHDI         8
 111 #define MXT_TOUCH_ORIENT        9
 112 #define MXT_TOUCH_MOVHYSTI      11
 113 #define MXT_TOUCH_MOVHYSTN      12
 114 #define MXT_TOUCH_NUMTOUCH      14
 115 #define MXT_TOUCH_MRGHYST       15
 116 #define MXT_TOUCH_MRGTHR        16
 117 #define MXT_TOUCH_AMPHYST       17
 118 #define MXT_TOUCH_XRANGE_LSB    18
 119 #define MXT_TOUCH_XRANGE_MSB    19
 120 #define MXT_TOUCH_YRANGE_LSB    20
 121 #define MXT_TOUCH_YRANGE_MSB    21
 122 #define MXT_TOUCH_XLOCLIP       22
 123 #define MXT_TOUCH_XHICLIP       23
 124 #define MXT_TOUCH_YLOCLIP       24
 125 #define MXT_TOUCH_YHICLIP       25
 126 #define MXT_TOUCH_XEDGECTRL     26
 127 #define MXT_TOUCH_XEDGEDIST     27
 128 #define MXT_TOUCH_YEDGECTRL     28
 129 #define MXT_TOUCH_YEDGEDIST     29
 130 #define MXT_TOUCH_JUMPLIMIT     30
 131
 132 /* MXT_PROCI_GRIPFACE_T20 field */
 133 #define MXT_GRIPFACE_CTRL       0
 134 #define MXT_GRIPFACE_XLOGRIP    1
 135 #define MXT_GRIPFACE_XHIGRIP    2
 136 #define MXT_GRIPFACE_YLOGRIP    3
 137 #define MXT_GRIPFACE_YHIGRIP    4
 138 #define MXT_GRIPFACE_MAXTCHS    5
 139 #define MXT_GRIPFACE_SZTHR1     7
 140 #define MXT_GRIPFACE_SZTHR2     8
 141 #define MXT_GRIPFACE_SHPTHR1    9
 142 #define MXT_GRIPFACE_SHPTHR2    10
 143 #define MXT_GRIPFACE_SUPEXTTO   11
 144
 145 /* MXT_PROCI_NOISE field */
 146 #define MXT_NOISE_CTRL          0
 147 #define MXT_NOISE_OUTFLEN       1
 148 #define MXT_NOISE_GCAFUL_LSB    3
 149 #define MXT_NOISE_GCAFUL_MSB    4
 150 #define MXT_NOISE_GCAFLL_LSB    5
 151 #define MXT_NOISE_GCAFLL_MSB    6
 152 #define MXT_NOISE_ACTVGCAFVALID 7
 153 #define MXT_NOISE_NOISETHR      8
 154 #define MXT_NOISE_FREQHOPSCALE  10
 155 #define MXT_NOISE_FREQ0         11
 156 #define MXT_NOISE_FREQ1         12
 157 #define MXT_NOISE_FREQ2         13
 158 #define MXT_NOISE_FREQ3         14
 159 #define MXT_NOISE_FREQ4         15
 160 #define MXT_NOISE_IDLEGCAFVALID 16
 161
 162 /* MXT_SPT_COMMSCONFIG_T18 */
 163 #define MXT_COMMS_CTRL          0
 164 #define MXT_COMMS_CMD           1
 165
 166 /* MXT_SPT_CTECONFIG_T28 field */
 167 #define MXT_CTE_CTRL            0
 168 #define MXT_CTE_CMD             1
 169 #define MXT_CTE_MODE            2
 170 #define MXT_CTE_IDLEGCAFDEPTH   3
 171 #define MXT_CTE_ACTVGCAFDEPTH   4
 172 #define MXT_CTE_VOLTAGE         5
 173
 174 #define MXT_VOLTAGE_DEFAULT     2700000
 175 #define MXT_VOLTAGE_STEP        10000
 176
 177 /* Define for MXT_GEN_COMMAND_T6 */
 178 #define MXT_BOOT_VALUE          0xa5
 179 #define MXT_BACKUP_VALUE        0x55
 180 #define MXT_BACKUP_TIME         50      /* msec */
 181 #define MXT_RESET_TIME          200     /* msec */
 182
 183 #define MXT_FWRESET_TIME        175     /* msec */
 184
 185 /* Command to unlock bootloader */
 186 #define MXT_UNLOCK_CMD_MSB      0xaa
 187 #define MXT_UNLOCK_CMD_LSB      0xdc
 188
 189 /* Bootloader mode status */
 190 #define MXT_WAITING_BOOTLOAD_CMD        0xc0    /* valid 7 6 bit only */
 191 #define MXT_WAITING_FRAME_DATA  0x80    /* valid 7 6 bit only */
 192 #define MXT_FRAME_CRC_CHECK     0x02
 193 #define MXT_FRAME_CRC_FAIL      0x03
 194 #define MXT_FRAME_CRC_PASS      0x04
 195 #define MXT_APP_CRC_FAIL        0x40    /* valid 7 8 bit only */
 196 #define MXT_BOOT_STATUS_MASK    0x3f
 197
 198 /* Touch status */
 199 #define MXT_UNGRIP              (1 << 0)
 200 #define MXT_SUPPRESS            (1 << 1)
 201 #define MXT_AMP                 (1 << 2)
 202 #define MXT_VECTOR              (1 << 3)
 203 #define MXT_MOVE                (1 << 4)
 204 #define MXT_RELEASE             (1 << 5)
 205 #define MXT_PRESS               (1 << 6)
 206 #define MXT_DETECT              (1 << 7)
 207
 208 /* Touch orient bits */
 209 #define MXT_XY_SWITCH           (1 << 0)
 210 #define MXT_X_INVERT            (1 << 1)
 211 #define MXT_Y_INVERT            (1 << 2)
 212
 213 /* Touchscreen absolute values */
 214 #define MXT_MAX_AREA            0xff
 215
 216 #define MXT_PIXELS_PER_MM       20
 217
 218 struct mxt_info {
 219         u8 family_id;
 220         u8 variant_id;
 221         u8 version;
 222         u8 build;
 223         u8 matrix_xsize;
 224         u8 matrix_ysize;
 225         u8 object_num;
 226 };
 227
 228 struct mxt_object {
 229         u8 type;
 230         u16 start_address;
 231         u8 size_minus_one;
 232         u8 instances_minus_one;
 233         u8 num_report_ids;
 234 } __packed;
 235
 236 struct mxt_message {
 237         u8 reportid;
 238         u8 message[7];
 239 };
 240
 241 /* Each client has this additional data */
 242 struct mxt_data {
 243         struct i2c_client *client;
 244         struct input_dev *input_dev;
 245         char phys[64];          /* device physical location */
 246         const struct mxt_platform_data *pdata;
 247         struct mxt_object *object_table;
 248         struct mxt_info info;
 249
 250         unsigned int irq;
 251         unsigned int max_x;
 252         unsigned int max_y;
 253
 254         /* Cached parameters from object table */
 255         u8 T6_reportid;
 256         u8 T9_reportid_min;
 257         u8 T9_reportid_max;
 258         u8 T19_reportid;
 259 };
 260
 261 static size_t mxt_obj_size(const struct mxt_object *obj)
 262 {
 263         return obj->size_minus_one + 1;
 264 }
 265
 266 static size_t mxt_obj_instances(const struct mxt_object *obj)
 267 {
 268         return obj->instances_minus_one + 1;
 269 }
 270
 271 static bool mxt_object_readable(unsigned int type)
 272 {
 273         switch (type) {
 274         case MXT_GEN_COMMAND_T6:
 275         case MXT_GEN_POWER_T7:
 276         case MXT_GEN_ACQUIRE_T8:
 277         case MXT_GEN_DATASOURCE_T53:
 278         case MXT_TOUCH_MULTI_T9:
 279         case MXT_TOUCH_KEYARRAY_T15:
 280         case MXT_TOUCH_PROXIMITY_T23:
 281         case MXT_TOUCH_PROXKEY_T52:
 282         case MXT_PROCI_GRIPFACE_T20:
 283         case MXT_PROCG_NOISE_T22:
 284         case MXT_PROCI_ONETOUCH_T24:
 285         case MXT_PROCI_TWOTOUCH_T27:
 286         case MXT_PROCI_GRIP_T40:
 287         case MXT_PROCI_PALM_T41:
 288         case MXT_PROCI_TOUCHSUPPRESSION_T42:
 289         case MXT_PROCI_STYLUS_T47:
 290         case MXT_PROCG_NOISESUPPRESSION_T48:
 291         case MXT_SPT_COMMSCONFIG_T18:
 292         case MXT_SPT_GPIOPWM_T19:
 293         case MXT_SPT_SELFTEST_T25:
 294         case MXT_SPT_CTECONFIG_T28:
 295         case MXT_SPT_USERDATA_T38:
 296         case MXT_SPT_DIGITIZER_T43:
 297         case MXT_SPT_CTECONFIG_T46:
 298                 return true;
 299         default:
 300                 return false;
 301         }
 302 }
 303
 304 static bool mxt_object_writable(unsigned int type)
 305 {
 306         switch (type) {
 307         case MXT_GEN_COMMAND_T6:
 308         case MXT_GEN_POWER_T7:
 309         case MXT_GEN_ACQUIRE_T8:
 310         case MXT_TOUCH_MULTI_T9:
 311         case MXT_TOUCH_KEYARRAY_T15:
 312         case MXT_TOUCH_PROXIMITY_T23:
 313         case MXT_TOUCH_PROXKEY_T52:
 314         case MXT_PROCI_GRIPFACE_T20:
 315         case MXT_PROCG_NOISE_T22:
 316         case MXT_PROCI_ONETOUCH_T24:
 317         case MXT_PROCI_TWOTOUCH_T27:
 318         case MXT_PROCI_GRIP_T40:
 319         case MXT_PROCI_PALM_T41:
 320         case MXT_PROCI_TOUCHSUPPRESSION_T42:
 321         case MXT_PROCI_STYLUS_T47:
 322         case MXT_PROCG_NOISESUPPRESSION_T48:
 323         case MXT_SPT_COMMSCONFIG_T18:
 324         case MXT_SPT_GPIOPWM_T19:
 325         case MXT_SPT_SELFTEST_T25:
 326         case MXT_SPT_CTECONFIG_T28:
 327         case MXT_SPT_DIGITIZER_T43:
 328         case MXT_SPT_CTECONFIG_T46:
 329                 return true;
 330         default:
 331                 return false;
 332         }
 333 }
 334
 335 static void mxt_dump_message(struct device *dev,
 336                              struct mxt_message *message)
 337 {
 338         dev_dbg(dev, "reportid: %u\tmessage: %*ph\n",
 339                 message->reportid, 7, message->message);
 340 }
 341
 342 static int mxt_check_bootloader(struct i2c_client *client,
 343                                      unsigned int state)
 344 {
 345         u8 val;
 346
 347 recheck:
 348         if (i2c_master_recv(client, &val, 1) != 1) {
 349                 dev_err(&client->dev, "%s: i2c recv failed\n", __func__);
 350                 return -EIO;
 351         }
 352
 353         switch (state) {
 354         case MXT_WAITING_BOOTLOAD_CMD:
 355         case MXT_WAITING_FRAME_DATA:
 356                 val &= ~MXT_BOOT_STATUS_MASK;
 357                 break;
 358         case MXT_FRAME_CRC_PASS:
 359                 if (val == MXT_FRAME_CRC_CHECK)
 360                         goto recheck;
 361                 break;
 362         default:
 363                 return -EINVAL;
 364         }
 365
 366         if (val != state) {
 367                 dev_err(&client->dev, "Unvalid bootloader mode state\n");
 368                 return -EINVAL;
 369         }
 370
 371         return 0;
 372 }
 373
 374 static int mxt_unlock_bootloader(struct i2c_client *client)
 375 {
 376         u8 buf[2];
 377
 378         buf[0] = MXT_UNLOCK_CMD_LSB;
 379         buf[1] = MXT_UNLOCK_CMD_MSB;
 380
 381         if (i2c_master_send(client, buf, 2) != 2) {
 382                 dev_err(&client->dev, "%s: i2c send failed\n", __func__);
 383                 return -EIO;
 384         }
 385
 386         return 0;
 387 }
 388
 389 static int mxt_fw_write(struct i2c_client *client,
 390                              const u8 *data, unsigned int frame_size)
 391 {
 392         if (i2c_master_send(client, data, frame_size) != frame_size) {
 393                 dev_err(&client->dev, "%s: i2c send failed\n", __func__);
 394                 return -EIO;
 395         }
 396
 397         return 0;
 398 }
 399
 400 static int __mxt_read_reg(struct i2c_client *client,
 401                                u16 reg, u16 len, void *val)
 402 {
 403         struct i2c_msg xfer[2];
 404         u8 buf[2];
 405         int ret;
 406
 407         buf[0] = reg & 0xff;
 408         buf[1] = (reg >> 8) & 0xff;
 409
 410         /* Write register */
 411         xfer[0].addr = client->addr;
 412         xfer[0].flags = 0;
 413         xfer[0].len = 2;
 414         xfer[0].buf = buf;
 415
 416         /* Read data */
 417         xfer[1].addr = client->addr;
 418         xfer[1].flags = I2C_M_RD;
 419         xfer[1].len = len;
 420         xfer[1].buf = val;
 421
 422         ret = i2c_transfer(client->adapter, xfer, 2);
 423         if (ret == 2) {
 424                 ret = 0;
 425         } else {
 426                 if (ret >= 0)
 427                         ret = -EIO;
 428                 dev_err(&client->dev, "%s: i2c transfer failed (%d)\n",
 429                         __func__, ret);
 430         }
 431
 432         return ret;
 433 }
 434
 435 static int mxt_read_reg(struct i2c_client *client, u16 reg, u8 *val)
 436 {
 437         return __mxt_read_reg(client, reg, 1, val);
 438 }
 439
 440 static int __mxt_write_reg(struct i2c_client *client, u16 reg, u16 len,
 441                            const void *val)
 442 {
 443         u8 *buf;
 444         size_t count;
 445         int ret;
 446
 447         count = len + 2;
 448         buf = kmalloc(count, GFP_KERNEL);
 449         if (!buf)
 450                 return -ENOMEM;
 451
 452         buf[0] = reg & 0xff;
 453         buf[1] = (reg >> 8) & 0xff;
 454         memcpy(&buf[2], val, len);
 455
 456         ret = i2c_master_send(client, buf, count);
 457         if (ret == count) {
 458                 ret = 0;
 459         } else {
 460                 if (ret >= 0)
 461                         ret = -EIO;
 462                 dev_err(&client->dev, "%s: i2c send failed (%d)\n",
 463                         __func__, ret);
 464         }
 465
 466         kfree(buf);
 467         return ret;
 468 }
 469
 470 static int mxt_write_reg(struct i2c_client *client, u16 reg, u8 val)
 471 {
 472         return __mxt_write_reg(client, reg, 1, &val);
 473 }
 474
 475 static struct mxt_object *
 476 mxt_get_object(struct mxt_data *data, u8 type)
 477 {
 478         struct mxt_object *object;
 479         int i;
 480
 481         for (i = 0; i < data->info.object_num; i++) {
 482                 object = data->object_table + i;
 483                 if (object->type == type)
 484                         return object;
 485         }
 486
 487         dev_err(&data->client->dev, "Invalid object type\n");
 488         return NULL;
 489 }
 490
 491 static int mxt_read_message(struct mxt_data *data,
 492                                  struct mxt_message *message)
 493 {
 494         struct mxt_object *object;
 495         u16 reg;
 496
 497         object = mxt_get_object(data, MXT_GEN_MESSAGE_T5);
 498         if (!object)
 499                 return -EINVAL;
 500
 501         reg = object->start_address;
 502         return __mxt_read_reg(data->client, reg,
 503                         sizeof(struct mxt_message), message);
 504 }
 505
 506 static int mxt_write_object(struct mxt_data *data,
 507                                  u8 type, u8 offset, u8 val)
 508 {
 509         struct mxt_object *object;
 510         u16 reg;
 511
 512         object = mxt_get_object(data, type);
 513         if (!object || offset >= mxt_obj_size(object))
 514                 return -EINVAL;
 515
 516         reg = object->start_address;
 517         return mxt_write_reg(data->client, reg + offset, val);
 518 }
 519
 520 static void mxt_input_button(struct mxt_data *data, struct mxt_message *message)
 521 {
 522         struct input_dev *input = data->input_dev;
 523         const struct mxt_platform_data *pdata = data->pdata;
 524         bool button;
 525         int i;
 526
 527         /* Active-low switch */
 528         for (i = 0; i < pdata->t19_num_keys; i++) {
 529                 if (pdata->t19_keymap[i] == KEY_RESERVED)
 530                         continue;
 531                 button = !(message->message[0] & (1 << i));
 532                 input_report_key(input, pdata->t19_keymap[i], button);
 533         }
 534 }
 535
 536 static void mxt_input_touchevent(struct mxt_data *data,
 537                                       struct mxt_message *message, int id)
 538 {
 539         struct device *dev = &data->client->dev;
 540         u8 status = message->message[0];
 541         struct input_dev *input_dev = data->input_dev;
 542         int x;
 543         int y;
 544         int area;
 545         int pressure;
 546
 547         x = (message->message[1] << 4) | ((message->message[3] >> 4) & 0xf);
 548         y = (message->message[2] << 4) | ((message->message[3] & 0xf));
 549         if (data->max_x < 1024)
 550                 x = x >> 2;
 551         if (data->max_y < 1024)
 552                 y = y >> 2;
 553
 554         area = message->message[4];
 555         pressure = message->message[5];
 556
 557         dev_dbg(dev,
 558                 "[%u] %c%c%c%c%c%c%c%c x: %5u y: %5u area: %3u amp: %3u\n",
 559                 id,
 560                 (status & MXT_DETECT) ? 'D' : '.',
 561                 (status & MXT_PRESS) ? 'P' : '.',
 562                 (status & MXT_RELEASE) ? 'R' : '.',
 563                 (status & MXT_MOVE) ? 'M' : '.',
 564                 (status & MXT_VECTOR) ? 'V' : '.',
 565                 (status & MXT_AMP) ? 'A' : '.',
 566                 (status & MXT_SUPPRESS) ? 'S' : '.',
 567                 (status & MXT_UNGRIP) ? 'U' : '.',
 568                 x, y, area, pressure);
 569
 570         input_mt_slot(input_dev, id);
 571         input_mt_report_slot_state(input_dev, MT_TOOL_FINGER,
 572                                    status & MXT_DETECT);
 573
 574         if (status & MXT_DETECT) {
 575                 input_report_abs(input_dev, ABS_MT_POSITION_X, x);
 576                 input_report_abs(input_dev, ABS_MT_POSITION_Y, y);
 577                 input_report_abs(input_dev, ABS_MT_PRESSURE, pressure);
 578                 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, area);
 579         }
 580 }
 581
 582 static unsigned mxt_extract_T6_csum(const u8 *csum)
 583 {
 584         return csum[0] | (csum[1] << 8) | (csum[2] << 16);
 585 }
 586
 587 static bool mxt_is_T9_message(struct mxt_data *data, struct mxt_message *msg)
 588 {
 589         u8 id = msg->reportid;
 590         return (id >= data->T9_reportid_min && id <= data->T9_reportid_max);
 591 }
 592
 593 static irqreturn_t mxt_interrupt(int irq, void *dev_id)
 594 {
 595         struct mxt_data *data = dev_id;
 596         struct mxt_message message;
 597         const u8 *payload = &message.message[0];
 598         struct device *dev = &data->client->dev;
 599         u8 reportid;
 600         bool update_input = false;
 601
 602         do {
 603                 if (mxt_read_message(data, &message)) {
 604                         dev_err(dev, "Failed to read message\n");
 605                         return IRQ_NONE;
 606                 }
 607
 608                 reportid = message.reportid;
 609
 610                 if (reportid == data->T6_reportid) {
 611                         u8 status = payload[0];
 612                         unsigned csum = mxt_extract_T6_csum(&payload[1]);
 613                         dev_dbg(dev, "Status: %02x Config Checksum: %06x\n",
 614                                 status, csum);
 615                 } else if (mxt_is_T9_message(data, &message)) {
 616                         int id = reportid - data->T9_reportid_min;
 617                         mxt_input_touchevent(data, &message, id);
 618                         update_input = true;
 619                 } else if (message.reportid == data->T19_reportid) {
 620                         mxt_input_button(data, &message);
 621                         update_input = true;
 622                 } else {
 623                         mxt_dump_message(dev, &message);
 624                 }
 625         } while (reportid != 0xff);
 626
 627         if (update_input) {
 628                 input_mt_report_pointer_emulation(data->input_dev, false);
 629                 input_sync(data->input_dev);
 630         }
 631
 632         return IRQ_HANDLED;
 633 }
 634
 635 static int mxt_check_reg_init(struct mxt_data *data)
 636 {
 637         const struct mxt_platform_data *pdata = data->pdata;
 638         struct mxt_object *object;
 639         struct device *dev = &data->client->dev;
 640         int index = 0;
 641         int i, size;
 642         int ret;
 643
 644         if (!pdata->config) {
 645                 dev_dbg(dev, "No cfg data defined, skipping reg init\n");
 646                 return 0;
 647         }
 648
 649         for (i = 0; i < data->info.object_num; i++) {
 650                 object = data->object_table + i;
 651
 652                 if (!mxt_object_writable(object->type))
 653                         continue;
 654
 655                 size = mxt_obj_size(object) * mxt_obj_instances(object);
 656                 if (index + size > pdata->config_length) {
 657                         dev_err(dev, "Not enough config data!\n");
 658                         return -EINVAL;
 659                 }
 660
 661                 ret = __mxt_write_reg(data->client, object->start_address,
 662                                 size, &pdata->config[index]);
 663                 if (ret)
 664                         return ret;
 665                 index += size;
 666         }
 667
 668         return 0;
 669 }
 670
 671 static int mxt_make_highchg(struct mxt_data *data)
 672 {
 673         struct device *dev = &data->client->dev;
 674         struct mxt_message message;
 675         int count = 10;
 676         int error;
 677
 678         /* Read dummy message to make high CHG pin */
 679         do {
 680                 error = mxt_read_message(data, &message);
 681                 if (error)
 682                         return error;
 683         } while (message.reportid != 0xff && --count);
 684
 685         if (!count) {
 686                 dev_err(dev, "CHG pin isn't cleared\n");
 687                 return -EBUSY;
 688         }
 689
 690         return 0;
 691 }
 692
 693 static int mxt_get_info(struct mxt_data *data)
 694 {
 695         struct i2c_client *client = data->client;
 696         struct mxt_info *info = &data->info;
 697         int error;
 698
 699         /* Read 7-byte info block starting at address 0 */
 700         error = __mxt_read_reg(client, MXT_INFO, sizeof(*info), info);
 701         if (error)
 702                 return error;
 703
 704         return 0;
 705 }
 706
 707 static int mxt_get_object_table(struct mxt_data *data)
 708 {
 709         struct i2c_client *client = data->client;
 710         size_t table_size;
 711         int error;
 712         int i;
 713         u8 reportid;
 714
 715         table_size = data->info.object_num * sizeof(struct mxt_object);
 716         error = __mxt_read_reg(client, MXT_OBJECT_START, table_size,
 717                         data->object_table);
 718         if (error)
 719                 return error;
 720
 721         /* Valid Report IDs start counting from 1 */
 722         reportid = 1;
 723         for (i = 0; i < data->info.object_num; i++) {
 724                 struct mxt_object *object = data->object_table + i;
 725                 u8 min_id, max_id;
 726
 727                 le16_to_cpus(&object->start_address);
 728
 729                 if (object->num_report_ids) {
 730                         min_id = reportid;
 731                         reportid += object->num_report_ids *
 732                                         mxt_obj_instances(object);
 733                         max_id = reportid - 1;
 734                 } else {
 735                         min_id = 0;
 736                         max_id = 0;
 737                 }
 738
 739                 dev_dbg(&data->client->dev,
 740                         "Type %2d Start %3d Size %3zd Instances %2zd ReportIDs %3u : %3u\n",
 741                         object->type, object->start_address,
 742                         mxt_obj_size(object), mxt_obj_instances(object),
 743                         min_id, max_id);
 744
 745                 switch (object->type) {
 746                 case MXT_GEN_COMMAND_T6:
 747                         data->T6_reportid = min_id;
 748                         break;
 749                 case MXT_TOUCH_MULTI_T9:
 750                         data->T9_reportid_min = min_id;
 751                         data->T9_reportid_max = max_id;
 752                         break;
 753                 case MXT_SPT_GPIOPWM_T19:
 754                         data->T19_reportid = min_id;
 755                         break;
 756                 }
 757         }
 758
 759         return 0;
 760 }
 761
 762 static void mxt_free_object_table(struct mxt_data *data)
 763 {
 764         kfree(data->object_table);
 765         data->object_table = NULL;
 766         data->T6_reportid = 0;
 767         data->T9_reportid_min = 0;
 768         data->T9_reportid_max = 0;
 769         data->T19_reportid = 0;
 770 }
 771
 772 static int mxt_initialize(struct mxt_data *data)
 773 {
 774         struct i2c_client *client = data->client;
 775         struct mxt_info *info = &data->info;
 776         int error;
 777         u8 val;
 778
 779         error = mxt_get_info(data);
 780         if (error)
 781                 return error;
 782
 783         data->object_table = kcalloc(info->object_num,
 784                                      sizeof(struct mxt_object),
 785                                      GFP_KERNEL);
 786         if (!data->object_table) {
 787                 dev_err(&client->dev, "Failed to allocate memory\n");
 788                 return -ENOMEM;
 789         }
 790
 791         /* Get object table information */
 792         error = mxt_get_object_table(data);
 793         if (error)
 794                 goto err_free_object_table;
 795
 796         /* Check register init values */
 797         error = mxt_check_reg_init(data);
 798         if (error)
 799                 goto err_free_object_table;
 800
 801         /* Backup to memory */
 802         mxt_write_object(data, MXT_GEN_COMMAND_T6,
 803                         MXT_COMMAND_BACKUPNV,
 804                         MXT_BACKUP_VALUE);
 805         msleep(MXT_BACKUP_TIME);
 806
 807         /* Soft reset */
 808         mxt_write_object(data, MXT_GEN_COMMAND_T6,
 809                         MXT_COMMAND_RESET, 1);
 810         msleep(MXT_RESET_TIME);
 811
 812         /* Update matrix size at info struct */
 813         error = mxt_read_reg(client, MXT_MATRIX_X_SIZE, &val);
 814         if (error)
 815                 goto err_free_object_table;
 816         info->matrix_xsize = val;
 817
 818         error = mxt_read_reg(client, MXT_MATRIX_Y_SIZE, &val);
 819         if (error)
 820                 goto err_free_object_table;
 821         info->matrix_ysize = val;
 822
 823         dev_info(&client->dev,
 824                         "Family ID: %u Variant ID: %u Major.Minor.Build: %u.%u.%02X\n",
 825                         info->family_id, info->variant_id, info->version >> 4,
 826                         info->version & 0xf, info->build);
 827
 828         dev_info(&client->dev,
 829                         "Matrix X Size: %u Matrix Y Size: %u Object Num: %u\n",
 830                         info->matrix_xsize, info->matrix_ysize,
 831                         info->object_num);
 832
 833         return 0;
 834
 835 err_free_object_table:
 836         mxt_free_object_table(data);
 837         return error;
 838 }
 839
 840 static void mxt_calc_resolution(struct mxt_data *data)
 841 {
 842         unsigned int max_x = data->pdata->x_size - 1;
 843         unsigned int max_y = data->pdata->y_size - 1;
 844
 845         if (data->pdata->orient & MXT_XY_SWITCH) {
 846                 data->max_x = max_y;
 847                 data->max_y = max_x;
 848         } else {
 849                 data->max_x = max_x;
 850                 data->max_y = max_y;
 851         }
 852 }
 853
 854 /* Firmware Version is returned as Major.Minor.Build */
 855 static ssize_t mxt_fw_version_show(struct device *dev,
 856                                    struct device_attribute *attr, char *buf)
 857 {
 858         struct mxt_data *data = dev_get_drvdata(dev);
 859         struct mxt_info *info = &data->info;
 860         return scnprintf(buf, PAGE_SIZE, "%u.%u.%02X\n",
 861                          info->version >> 4, info->version & 0xf, info->build);
 862 }
 863
 864 /* Hardware Version is returned as FamilyID.VariantID */
 865 static ssize_t mxt_hw_version_show(struct device *dev,
 866                                    struct device_attribute *attr, char *buf)
 867 {
 868         struct mxt_data *data = dev_get_drvdata(dev);
 869         struct mxt_info *info = &data->info;
 870         return scnprintf(buf, PAGE_SIZE, "%u.%u\n",
 871                          info->family_id, info->variant_id);
 872 }
 873
 874 static ssize_t mxt_show_instance(char *buf, int count,
 875                                  struct mxt_object *object, int instance,
 876                                  const u8 *val)
 877 {
 878         int i;
 879
 880         if (mxt_obj_instances(object) > 1)
 881                 count += scnprintf(buf + count, PAGE_SIZE - count,
 882                                    "Instance %u\n", instance);
 883
 884         for (i = 0; i < mxt_obj_size(object); i++)
 885                 count += scnprintf(buf + count, PAGE_SIZE - count,
 886                                 "\t[%2u]: %02x (%d)\n", i, val[i], val[i]);
 887         count += scnprintf(buf + count, PAGE_SIZE - count, "\n");
 888
 889         return count;
 890 }
 891
 892 static ssize_t mxt_object_show(struct device *dev,
 893                                     struct device_attribute *attr, char *buf)
 894 {
 895         struct mxt_data *data = dev_get_drvdata(dev);
 896         struct mxt_object *object;
 897         int count = 0;
 898         int i, j;
 899         int error;
 900         u8 *obuf;
 901
 902         /* Pre-allocate buffer large enough to hold max sized object. */
 903         obuf = kmalloc(256, GFP_KERNEL);
 904         if (!obuf)
 905                 return -ENOMEM;
 906
 907         error = 0;
 908         for (i = 0; i < data->info.object_num; i++) {
 909                 object = data->object_table + i;
 910
 911                 if (!mxt_object_readable(object->type))
 912                         continue;
 913
 914                 count += scnprintf(buf + count, PAGE_SIZE - count,
 915                                 "T%u:\n", object->type);
 916
 917                 for (j = 0; j < mxt_obj_instances(object); j++) {
 918                         u16 size = mxt_obj_size(object);
 919                         u16 addr = object->start_address + j * size;
 920
 921                         error = __mxt_read_reg(data->client, addr, size, obuf);
 922                         if (error)
 923                                 goto done;
 924
 925                         count = mxt_show_instance(buf, count, object, j, obuf);
 926                 }
 927         }
 928
 929 done:
 930         kfree(obuf);
 931         return error ?: count;
 932 }
 933
 934 static int mxt_load_fw(struct device *dev, const char *fn)
 935 {
 936         struct mxt_data *data = dev_get_drvdata(dev);
 937         struct i2c_client *client = data->client;
 938         const struct firmware *fw = NULL;
 939         unsigned int frame_size;
 940         unsigned int pos = 0;
 941         int ret;
 942
 943         ret = request_firmware(&fw, fn, dev);
 944         if (ret) {
 945                 dev_err(dev, "Unable to open firmware %s\n", fn);
 946                 return ret;
 947         }
 948
 949         /* Change to the bootloader mode */
 950         mxt_write_object(data, MXT_GEN_COMMAND_T6,
 951                         MXT_COMMAND_RESET, MXT_BOOT_VALUE);
 952         msleep(MXT_RESET_TIME);
 953
 954         /* Change to slave address of bootloader */
 955         if (client->addr == MXT_APP_LOW)
 956                 client->addr = MXT_BOOT_LOW;
 957         else
 958                 client->addr = MXT_BOOT_HIGH;
 959
 960         ret = mxt_check_bootloader(client, MXT_WAITING_BOOTLOAD_CMD);
 961         if (ret)
 962                 goto out;
 963
 964         /* Unlock bootloader */
 965         mxt_unlock_bootloader(client);
 966
 967         while (pos < fw->size) {
 968                 ret = mxt_check_bootloader(client,
 969                                                 MXT_WAITING_FRAME_DATA);
 970                 if (ret)
 971                         goto out;
 972
 973                 frame_size = ((*(fw->data + pos) << 8) | *(fw->data + pos + 1));
 974
 975                 /* We should add 2 at frame size as the the firmware data is not
 976                  * included the CRC bytes.
 977                  */
 978                 frame_size += 2;
 979
 980                 /* Write one frame to device */
 981                 mxt_fw_write(client, fw->data + pos, frame_size);
 982
 983                 ret = mxt_check_bootloader(client,
 984                                                 MXT_FRAME_CRC_PASS);
 985                 if (ret)
 986                         goto out;
 987
 988                 pos += frame_size;
 989
 990                 dev_dbg(dev, "Updated %d bytes / %zd bytes\n", pos, fw->size);
 991         }
 992
 993 out:
 994         release_firmware(fw);
 995
 996         /* Change to slave address of application */
 997         if (client->addr == MXT_BOOT_LOW)
 998                 client->addr = MXT_APP_LOW;
 999         else
1000                 client->addr = MXT_APP_HIGH;
1001
1002         return ret;
1003 }
1004
1005 static ssize_t mxt_update_fw_store(struct device *dev,
1006                                         struct device_attribute *attr,
1007                                         const char *buf, size_t count)
1008 {
1009         struct mxt_data *data = dev_get_drvdata(dev);
1010         int error;
1011
1012         disable_irq(data->irq);
1013
1014         error = mxt_load_fw(dev, MXT_FW_NAME);
1015         if (error) {
1016                 dev_err(dev, "The firmware update failed(%d)\n", error);
1017                 count = error;
1018         } else {
1019                 dev_dbg(dev, "The firmware update succeeded\n");
1020
1021                 /* Wait for reset */
1022                 msleep(MXT_FWRESET_TIME);
1023
1024                 mxt_free_object_table(data);
1025
1026                 mxt_initialize(data);
1027         }
1028
1029         enable_irq(data->irq);
1030
1031         error = mxt_make_highchg(data);
1032         if (error)
1033                 return error;
1034
1035         return count;
1036 }
1037
1038 static DEVICE_ATTR(fw_version, S_IRUGO, mxt_fw_version_show, NULL);
1039 static DEVICE_ATTR(hw_version, S_IRUGO, mxt_hw_version_show, NULL);
1040 static DEVICE_ATTR(object, S_IRUGO, mxt_object_show, NULL);
1041 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, mxt_update_fw_store);
1042
1043 static struct attribute *mxt_attrs[] = {
1044         &dev_attr_fw_version.attr,
1045         &dev_attr_hw_version.attr,
1046         &dev_attr_object.attr,
1047         &dev_attr_update_fw.attr,
1048         NULL
1049 };
1050
1051 static const struct attribute_group mxt_attr_group = {
1052         .attrs = mxt_attrs,
1053 };
1054
1055 static void mxt_start(struct mxt_data *data)
1056 {
1057         /* Touch enable */
1058         mxt_write_object(data,
1059                         MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0x83);
1060 }
1061
1062 static void mxt_stop(struct mxt_data *data)
1063 {
1064         /* Touch disable */
1065         mxt_write_object(data,
1066                         MXT_TOUCH_MULTI_T9, MXT_TOUCH_CTRL, 0);
1067 }
1068
1069 static int mxt_input_open(struct input_dev *dev)
1070 {
1071         struct mxt_data *data = input_get_drvdata(dev);
1072
1073         mxt_start(data);
1074
1075         return 0;
1076 }
1077
1078 static void mxt_input_close(struct input_dev *dev)
1079 {
1080         struct mxt_data *data = input_get_drvdata(dev);
1081
1082         mxt_stop(data);
1083 }
1084
1085 static int mxt_probe(struct i2c_client *client,
1086                 const struct i2c_device_id *id)
1087 {
1088         const struct mxt_platform_data *pdata = dev_get_platdata(&client->dev);
1089         struct mxt_data *data;
1090         struct input_dev *input_dev;
1091         int error;
1092         unsigned int num_mt_slots;
1093         unsigned int mt_flags = 0;
1094         int i;
1095
1096         if (!pdata)
1097                 return -EINVAL;
1098
1099         data = kzalloc(sizeof(struct mxt_data), GFP_KERNEL);
1100         input_dev = input_allocate_device();
1101         if (!data || !input_dev) {
1102                 dev_err(&client->dev, "Failed to allocate memory\n");
1103                 error = -ENOMEM;
1104                 goto err_free_mem;
1105         }
1106
1107         input_dev->name = "Atmel maXTouch Touchscreen";
1108         snprintf(data->phys, sizeof(data->phys), "i2c-%u-%04x/input0",
1109                  client->adapter->nr, client->addr);
1110
1111         input_dev->phys = data->phys;
1112
1113         input_dev->id.bustype = BUS_I2C;
1114         input_dev->dev.parent = &client->dev;
1115         input_dev->open = mxt_input_open;
1116         input_dev->close = mxt_input_close;
1117
1118         data->client = client;
1119         data->input_dev = input_dev;
1120         data->pdata = pdata;
1121         data->irq = client->irq;
1122
1123         mxt_calc_resolution(data);
1124
1125         error = mxt_initialize(data);
1126         if (error)
1127                 goto err_free_mem;
1128
1129         __set_bit(EV_ABS, input_dev->evbit);
1130         __set_bit(EV_KEY, input_dev->evbit);
1131         __set_bit(BTN_TOUCH, input_dev->keybit);
1132
1133         if (pdata->t19_num_keys) {
1134                 __set_bit(INPUT_PROP_BUTTONPAD, input_dev->propbit);
1135
1136                 for (i = 0; i < pdata->t19_num_keys; i++)
1137                         if (pdata->t19_keymap[i] != KEY_RESERVED)
1138                                 input_set_capability(input_dev, EV_KEY,
1139                                                      pdata->t19_keymap[i]);
1140
1141                 mt_flags |= INPUT_MT_POINTER;
1142
1143                 input_abs_set_res(input_dev, ABS_X, MXT_PIXELS_PER_MM);
1144                 input_abs_set_res(input_dev, ABS_Y, MXT_PIXELS_PER_MM);
1145                 input_abs_set_res(input_dev, ABS_MT_POSITION_X,
1146                                   MXT_PIXELS_PER_MM);
1147                 input_abs_set_res(input_dev, ABS_MT_POSITION_Y,
1148                                   MXT_PIXELS_PER_MM);
1149
1150                 input_dev->name = "Atmel maXTouch Touchpad";
1151         }
1152
1153         /* For single touch */
1154         input_set_abs_params(input_dev, ABS_X,
1155                              0, data->max_x, 0, 0);
1156         input_set_abs_params(input_dev, ABS_Y,
1157                              0, data->max_y, 0, 0);
1158         input_set_abs_params(input_dev, ABS_PRESSURE,
1159                              0, 255, 0, 0);
1160
1161         /* For multi touch */
1162         num_mt_slots = data->T9_reportid_max - data->T9_reportid_min + 1;
1163         error = input_mt_init_slots(input_dev, num_mt_slots, mt_flags);
1164         if (error)
1165                 goto err_free_object;
1166         input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR,
1167                              0, MXT_MAX_AREA, 0, 0);
1168         input_set_abs_params(input_dev, ABS_MT_POSITION_X,
1169                              0, data->max_x, 0, 0);
1170         input_set_abs_params(input_dev, ABS_MT_POSITION_Y,
1171                              0, data->max_y, 0, 0);
1172         input_set_abs_params(input_dev, ABS_MT_PRESSURE,
1173                              0, 255, 0, 0);
1174
1175         input_set_drvdata(input_dev, data);
1176         i2c_set_clientdata(client, data);
1177
1178         error = request_threaded_irq(client->irq, NULL, mxt_interrupt,
1179                                      pdata->irqflags | IRQF_ONESHOT,
1180                                      client->name, data);
1181         if (error) {
1182                 dev_err(&client->dev, "Failed to register interrupt\n");
1183                 goto err_free_object;
1184         }
1185
1186         error = mxt_make_highchg(data);
1187         if (error)
1188                 goto err_free_irq;
1189
1190         error = input_register_device(input_dev);
1191         if (error)
1192                 goto err_free_irq;
1193
1194         error = sysfs_create_group(&client->dev.kobj, &mxt_attr_group);
1195         if (error)
1196                 goto err_unregister_device;
1197
1198         return 0;
1199
1200 err_unregister_device:
1201         input_unregister_device(input_dev);
1202         input_dev = NULL;
1203 err_free_irq:
1204         free_irq(client->irq, data);
1205 err_free_object:
1206         kfree(data->object_table);
1207 err_free_mem:
1208         input_free_device(input_dev);
1209         kfree(data);
1210         return error;
1211 }
1212
1213 static int mxt_remove(struct i2c_client *client)
1214 {
1215         struct mxt_data *data = i2c_get_clientdata(client);
1216
1217         sysfs_remove_group(&client->dev.kobj, &mxt_attr_group);
1218         free_irq(data->irq, data);
1219         input_unregister_device(data->input_dev);
1220         kfree(data->object_table);
1221         kfree(data);
1222
1223         return 0;
1224 }
1225
1226 #ifdef CONFIG_PM_SLEEP
1227 static int mxt_suspend(struct device *dev)
1228 {
1229         struct i2c_client *client = to_i2c_client(dev);
1230         struct mxt_data *data = i2c_get_clientdata(client);
1231         struct input_dev *input_dev = data->input_dev;
1232
1233         mutex_lock(&input_dev->mutex);
1234
1235         if (input_dev->users)
1236                 mxt_stop(data);
1237
1238         mutex_unlock(&input_dev->mutex);
1239
1240         return 0;
1241 }
1242
1243 static int mxt_resume(struct device *dev)
1244 {
1245         struct i2c_client *client = to_i2c_client(dev);
1246         struct mxt_data *data = i2c_get_clientdata(client);
1247         struct input_dev *input_dev = data->input_dev;
1248
1249         /* Soft reset */
1250         mxt_write_object(data, MXT_GEN_COMMAND_T6,
1251                         MXT_COMMAND_RESET, 1);
1252
1253         msleep(MXT_RESET_TIME);
1254
1255         mutex_lock(&input_dev->mutex);
1256
1257         if (input_dev->users)
1258                 mxt_start(data);
1259
1260         mutex_unlock(&input_dev->mutex);
1261
1262         return 0;
1263 }
1264 #endif
1265
1266 static SIMPLE_DEV_PM_OPS(mxt_pm_ops, mxt_suspend, mxt_resume);
1267
1268 static const struct i2c_device_id mxt_id[] = {
1269         { "qt602240_ts", 0 },
1270         { "atmel_mxt_ts", 0 },
1271         { "atmel_mxt_tp", 0 },
1272         { "mXT224", 0 },
1273         { }
1274 };
1275 MODULE_DEVICE_TABLE(i2c, mxt_id);
1276
1277 static struct i2c_driver mxt_driver = {
1278         .driver = {
1279                 .name   = "atmel_mxt_ts",
1280                 .owner  = THIS_MODULE,
1281                 .pm     = &mxt_pm_ops,
1282         },
1283         .probe          = mxt_probe,
1284         .remove         = mxt_remove,
1285         .id_table       = mxt_id,
1286 };
1287
1288 module_i2c_driver(mxt_driver);
1289
1290 /* Module information */
1291 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
1292 MODULE_DESCRIPTION("Atmel maXTouch Touchscreen driver");
1293 MODULE_LICENSE("GPL");