Pileus Git - ~andy/linux/blob - drivers/input/touchscreen/atmel_mxt_ts.c

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