drivers/input/mouse/elan_i2c_smbus.c

   1 /*
   2  * Elan I2C/SMBus Touchpad driver - SMBus interface
   3  *
   4  * Copyright (c) 2013 ELAN Microelectronics Corp.
   5  *
   6  * Author: 林政維 (Duson Lin) <dusonlin@emc.com.tw>
   7  *
   8  * Based on cyapa driver:
   9  * copyright (c) 2011-2012 Cypress Semiconductor, Inc.
  10  * copyright (c) 2011-2012 Google, Inc.
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License version 2 as published
  14  * by the Free Software Foundation.
  15  *
  16  * Trademarks are the property of their respective owners.
  17  */
  18
  19 #include <linux/delay.h>
  20 #include <linux/i2c.h>
  21 #include <linux/init.h>
  22 #include <linux/kernel.h>
  23
  24 #include "elan_i2c.h"
  25
  26 /* Elan SMbus commands */
  27 #define ETP_SMBUS_IAP_CMD               0x00
  28 #define ETP_SMBUS_ENABLE_TP             0x20
  29 #define ETP_SMBUS_SLEEP_CMD             0x21
  30 #define ETP_SMBUS_IAP_PASSWORD_WRITE    0x29
  31 #define ETP_SMBUS_IAP_PASSWORD_READ     0x80
  32 #define ETP_SMBUS_WRITE_FW_BLOCK        0x2A
  33 #define ETP_SMBUS_IAP_RESET_CMD         0x2B
  34 #define ETP_SMBUS_RANGE_CMD             0xA0
  35 #define ETP_SMBUS_FW_VERSION_CMD        0xA1
  36 #define ETP_SMBUS_XY_TRACENUM_CMD       0xA2
  37 #define ETP_SMBUS_SM_VERSION_CMD        0xA3
  38 #define ETP_SMBUS_UNIQUEID_CMD          0xA3
  39 #define ETP_SMBUS_RESOLUTION_CMD        0xA4
  40 #define ETP_SMBUS_HELLOPACKET_CMD       0xA7
  41 #define ETP_SMBUS_PACKET_QUERY          0xA8
  42 #define ETP_SMBUS_IAP_VERSION_CMD       0xAC
  43 #define ETP_SMBUS_IAP_CTRL_CMD          0xAD
  44 #define ETP_SMBUS_IAP_CHECKSUM_CMD      0xAE
  45 #define ETP_SMBUS_FW_CHECKSUM_CMD       0xAF
  46 #define ETP_SMBUS_MAX_BASELINE_CMD      0xC3
  47 #define ETP_SMBUS_MIN_BASELINE_CMD      0xC4
  48 #define ETP_SMBUS_CALIBRATE_QUERY       0xC5
  49
  50 #define ETP_SMBUS_REPORT_LEN            32
  51 #define ETP_SMBUS_REPORT_OFFSET         2
  52 #define ETP_SMBUS_HELLOPACKET_LEN       5
  53 #define ETP_SMBUS_IAP_PASSWORD          0x1234
  54 #define ETP_SMBUS_IAP_MODE_ON           (1 << 6)
  55
  56 static int elan_smbus_initialize(struct i2c_client *client)
  57 {
  58         u8 check[ETP_SMBUS_HELLOPACKET_LEN] = { 0x55, 0x55, 0x55, 0x55, 0x55 };
  59         u8 values[I2C_SMBUS_BLOCK_MAX] = {0};
  60         int len, error;
  61
  62         /* Get hello packet */
  63         len = i2c_smbus_read_block_data(client,
  64                                         ETP_SMBUS_HELLOPACKET_CMD, values);
  65         if (len != ETP_SMBUS_HELLOPACKET_LEN) {
  66                 dev_err(&client->dev, "hello packet length fail: %d\n", len);
  67                 error = len < 0 ? len : -EIO;
  68                 return error;
  69         }
  70
  71         /* compare hello packet */
  72         if (memcmp(values, check, ETP_SMBUS_HELLOPACKET_LEN)) {
  73                 dev_err(&client->dev, "hello packet fail [%*ph]\n",
  74                         ETP_SMBUS_HELLOPACKET_LEN, values);
  75                 return -ENXIO;
  76         }
  77
  78         /* enable tp */
  79         error = i2c_smbus_write_byte(client, ETP_SMBUS_ENABLE_TP);
  80         if (error) {
  81                 dev_err(&client->dev, "failed to enable touchpad: %d\n", error);
  82                 return error;
  83         }
  84
  85         return 0;
  86 }
  87
  88 static int elan_smbus_set_mode(struct i2c_client *client, u8 mode)
  89 {
  90         u8 cmd[4] = { 0x00, 0x07, 0x00, mode };
  91
  92         return i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
  93                                           sizeof(cmd), cmd);
  94 }
  95
  96 static int elan_smbus_sleep_control(struct i2c_client *client, bool sleep)
  97 {
  98         if (sleep)
  99                 return i2c_smbus_write_byte(client, ETP_SMBUS_SLEEP_CMD);
 100         else
 101                 return 0; /* XXX should we send ETP_SMBUS_ENABLE_TP here? */
 102 }
 103
 104 static int elan_smbus_power_control(struct i2c_client *client, bool enable)
 105 {
 106         return 0; /* A no-op */
 107 }
 108
 109 static int elan_smbus_calibrate(struct i2c_client *client)
 110 {
 111         u8 cmd[4] = { 0x00, 0x08, 0x00, 0x01 };
 112
 113         return i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
 114                                           sizeof(cmd), cmd);
 115 }
 116
 117 static int elan_smbus_calibrate_result(struct i2c_client *client, u8 *val)
 118 {
 119         int error;
 120         u8 buf[I2C_SMBUS_BLOCK_MAX] = {0};
 121
 122         BUILD_BUG_ON(ETP_CALIBRATE_MAX_LEN > sizeof(buf));
 123
 124         error = i2c_smbus_read_block_data(client,
 125                                           ETP_SMBUS_CALIBRATE_QUERY, buf);
 126         if (error < 0)
 127                 return error;
 128
 129         memcpy(val, buf, ETP_CALIBRATE_MAX_LEN);
 130         return 0;
 131 }
 132
 133 static int elan_smbus_get_baseline_data(struct i2c_client *client,
 134                                         bool max_baseline, u8 *value)
 135 {
 136         int error;
 137         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 138
 139         error = i2c_smbus_read_block_data(client,
 140                                           max_baseline ?
 141                                                 ETP_SMBUS_MAX_BASELINE_CMD :
 142                                                 ETP_SMBUS_MIN_BASELINE_CMD,
 143                                           val);
 144         if (error < 0)
 145                 return error;
 146
 147         *value = be16_to_cpup((__be16 *)val);
 148
 149         return 0;
 150 }
 151
 152 static int elan_smbus_get_version(struct i2c_client *client,
 153                                   bool iap, u8 *version)
 154 {
 155         int error;
 156         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 157
 158         error = i2c_smbus_read_block_data(client,
 159                                           iap ? ETP_SMBUS_IAP_VERSION_CMD :
 160                                                 ETP_SMBUS_FW_VERSION_CMD,
 161                                           val);
 162         if (error < 0) {
 163                 dev_err(&client->dev, "failed to get %s version: %d\n",
 164                         iap ? "IAP" : "FW", error);
 165                 return error;
 166         }
 167
 168         *version = val[2];
 169         return 0;
 170 }
 171
 172 static int elan_smbus_get_sm_version(struct i2c_client *client,
 173                                      u8 *ic_type, u8 *version)
 174 {
 175         int error;
 176         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 177
 178         error = i2c_smbus_read_block_data(client,
 179                                           ETP_SMBUS_SM_VERSION_CMD, val);
 180         if (error < 0) {
 181                 dev_err(&client->dev, "failed to get SM version: %d\n", error);
 182                 return error;
 183         }
 184
 185         *version = val[0];
 186         *ic_type = val[1];
 187         return 0;
 188 }
 189
 190 static int elan_smbus_get_product_id(struct i2c_client *client, u16 *id)
 191 {
 192         int error;
 193         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 194
 195         error = i2c_smbus_read_block_data(client,
 196                                           ETP_SMBUS_UNIQUEID_CMD, val);
 197         if (error < 0) {
 198                 dev_err(&client->dev, "failed to get product ID: %d\n", error);
 199                 return error;
 200         }
 201
 202         *id = be16_to_cpup((__be16 *)val);
 203         return 0;
 204 }
 205
 206 static int elan_smbus_get_checksum(struct i2c_client *client,
 207                                    bool iap, u16 *csum)
 208 {
 209         int error;
 210         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 211
 212         error = i2c_smbus_read_block_data(client,
 213                                           iap ? ETP_SMBUS_FW_CHECKSUM_CMD :
 214                                                 ETP_SMBUS_IAP_CHECKSUM_CMD,
 215                                           val);
 216         if (error < 0) {
 217                 dev_err(&client->dev, "failed to get %s checksum: %d\n",
 218                         iap ? "IAP" : "FW", error);
 219                 return error;
 220         }
 221
 222         *csum = be16_to_cpup((__be16 *)val);
 223         return 0;
 224 }
 225
 226 static int elan_smbus_get_max(struct i2c_client *client,
 227                               unsigned int *max_x, unsigned int *max_y)
 228 {
 229         int ret;
 230         int error;
 231         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 232
 233         ret = i2c_smbus_read_block_data(client, ETP_SMBUS_RANGE_CMD, val);
 234         if (ret != 3) {
 235                 error = ret < 0 ? ret : -EIO;
 236                 dev_err(&client->dev, "failed to get dimensions: %d\n", error);
 237                 return error;
 238         }
 239
 240         *max_x = (0x0f & val[0]) << 8 | val[1];
 241         *max_y = (0xf0 & val[0]) << 4 | val[2];
 242
 243         return 0;
 244 }
 245
 246 static int elan_smbus_get_resolution(struct i2c_client *client,
 247                                      u8 *hw_res_x, u8 *hw_res_y)
 248 {
 249         int ret;
 250         int error;
 251         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 252
 253         ret = i2c_smbus_read_block_data(client, ETP_SMBUS_RESOLUTION_CMD, val);
 254         if (ret != 3) {
 255                 error = ret < 0 ? ret : -EIO;
 256                 dev_err(&client->dev, "failed to get resolution: %d\n", error);
 257                 return error;
 258         }
 259
 260         *hw_res_x = val[1] & 0x0F;
 261         *hw_res_y = (val[1] & 0xF0) >> 4;
 262
 263         return 0;
 264 }
 265
 266 static int elan_smbus_get_num_traces(struct i2c_client *client,
 267                                      unsigned int *x_traces,
 268                                      unsigned int *y_traces)
 269 {
 270         int ret;
 271         int error;
 272         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 273
 274         ret = i2c_smbus_read_block_data(client, ETP_SMBUS_XY_TRACENUM_CMD, val);
 275         if (ret != 3) {
 276                 error = ret < 0 ? ret : -EIO;
 277                 dev_err(&client->dev, "failed to get trace info: %d\n", error);
 278                 return error;
 279         }
 280
 281         *x_traces = val[1];
 282         *y_traces = val[2];
 283
 284         return 0;
 285 }
 286
 287 static int elan_smbus_get_pressure_adjustment(struct i2c_client *client,
 288                                               int *adjustment)
 289 {
 290         *adjustment = ETP_PRESSURE_OFFSET;
 291         return 0;
 292 }
 293
 294 static int elan_smbus_iap_get_mode(struct i2c_client *client,
 295                                    enum tp_mode *mode)
 296 {
 297         int error;
 298         u16 constant;
 299         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 300
 301         error = i2c_smbus_read_block_data(client, ETP_SMBUS_IAP_CTRL_CMD, val);
 302         if (error < 0) {
 303                 dev_err(&client->dev, "failed to read iap ctrol register: %d\n",
 304                         error);
 305                 return error;
 306         }
 307
 308         constant = be16_to_cpup((__be16 *)val);
 309         dev_dbg(&client->dev, "iap control reg: 0x%04x.\n", constant);
 310
 311         *mode = (constant & ETP_SMBUS_IAP_MODE_ON) ? IAP_MODE : MAIN_MODE;
 312
 313         return 0;
 314 }
 315
 316 static int elan_smbus_iap_reset(struct i2c_client *client)
 317 {
 318         int error;
 319
 320         error = i2c_smbus_write_byte(client, ETP_SMBUS_IAP_RESET_CMD);
 321         if (error) {
 322                 dev_err(&client->dev, "cannot reset IC: %d\n", error);
 323                 return error;
 324         }
 325
 326         return 0;
 327 }
 328
 329 static int elan_smbus_set_flash_key(struct i2c_client *client)
 330 {
 331         int error;
 332         u8 cmd[4] = { 0x00, 0x0B, 0x00, 0x5A };
 333
 334         error = i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
 335                                            sizeof(cmd), cmd);
 336         if (error) {
 337                 dev_err(&client->dev, "cannot set flash key: %d\n", error);
 338                 return error;
 339         }
 340
 341         return 0;
 342 }
 343
 344 static int elan_smbus_prepare_fw_update(struct i2c_client *client)
 345 {
 346         struct device *dev = &client->dev;
 347         int len;
 348         int error;
 349         enum tp_mode mode;
 350         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 351         u8 cmd[4] = {0x0F, 0x78, 0x00, 0x06};
 352         u16 password;
 353
 354         /* Get FW in which mode (IAP_MODE/MAIN_MODE)  */
 355         error = elan_smbus_iap_get_mode(client, &mode);
 356         if (error)
 357                 return error;
 358
 359         if (mode == MAIN_MODE) {
 360
 361                 /* set flash key */
 362                 error = elan_smbus_set_flash_key(client);
 363                 if (error)
 364                         return error;
 365
 366                 /* write iap password */
 367                 if (i2c_smbus_write_byte(client,
 368                                          ETP_SMBUS_IAP_PASSWORD_WRITE) < 0) {
 369                         dev_err(dev, "cannot write iap password\n");
 370                         return -EIO;
 371                 }
 372
 373                 error = i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
 374                                                    sizeof(cmd), cmd);
 375                 if (error) {
 376                         dev_err(dev, "failed to write iap password: %d\n",
 377                                 error);
 378                         return error;
 379                 }
 380
 381                 /*
 382                  * Read back password to make sure we enabled flash
 383                  * successfully.
 384                  */
 385                 len = i2c_smbus_read_block_data(client,
 386                                                 ETP_SMBUS_IAP_PASSWORD_READ,
 387                                                 val);
 388                 if (len < sizeof(u16)) {
 389                         error = len < 0 ? len : -EIO;
 390                         dev_err(dev, "failed to read iap password: %d\n",
 391                                 error);
 392                         return error;
 393                 }
 394
 395                 password = be16_to_cpup((__be16 *)val);
 396                 if (password != ETP_SMBUS_IAP_PASSWORD) {
 397                         dev_err(dev, "wrong iap password = 0x%X\n", password);
 398                         return -EIO;
 399                 }
 400
 401                 /* Wait 30ms for MAIN_MODE change to IAP_MODE */
 402                 msleep(30);
 403         }
 404
 405         error = elan_smbus_set_flash_key(client);
 406         if (error)
 407                 return error;
 408
 409         /* Reset IC */
 410         error = elan_smbus_iap_reset(client);
 411         if (error)
 412                 return error;
 413
 414         return 0;
 415 }
 416
 417
 418 static int elan_smbus_write_fw_block(struct i2c_client *client,
 419                                      const u8 *page, u16 checksum, int idx)
 420 {
 421         struct device *dev = &client->dev;
 422         int error;
 423         u16 result;
 424         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 425
 426         /*
 427          * Due to the limitation of smbus protocol limiting
 428          * transfer to 32 bytes at a time, we must split block
 429          * in 2 transfers.
 430          */
 431         error = i2c_smbus_write_block_data(client,
 432                                            ETP_SMBUS_WRITE_FW_BLOCK,
 433                                            ETP_FW_PAGE_SIZE / 2,
 434                                            page);
 435         if (error) {
 436                 dev_err(dev, "Failed to write page %d (part %d): %d\n",
 437                         idx, 1, error);
 438                 return error;
 439         }
 440
 441         error = i2c_smbus_write_block_data(client,
 442                                            ETP_SMBUS_WRITE_FW_BLOCK,
 443                                            ETP_FW_PAGE_SIZE / 2,
 444                                            page + ETP_FW_PAGE_SIZE / 2);
 445         if (error) {
 446                 dev_err(dev, "Failed to write page %d (part %d): %d\n",
 447                         idx, 2, error);
 448                 return error;
 449         }
 450
 451
 452         /* Wait for F/W to update one page ROM data. */
 453         usleep_range(8000, 10000);
 454
 455         error = i2c_smbus_read_block_data(client,
 456                                           ETP_SMBUS_IAP_CTRL_CMD, val);
 457         if (error < 0) {
 458                 dev_err(dev, "Failed to read IAP write result: %d\n",
 459                         error);
 460                 return error;
 461         }
 462
 463         result = be16_to_cpup((__be16 *)val);
 464         if (result & (ETP_FW_IAP_PAGE_ERR | ETP_FW_IAP_INTF_ERR)) {
 465                 dev_err(dev, "IAP reports failed write: %04hx\n",
 466                         result);
 467                 return -EIO;
 468         }
 469
 470         return 0;
 471 }
 472
 473 static int elan_smbus_get_report(struct i2c_client *client, u8 *report)
 474 {
 475         int len;
 476
 477         BUILD_BUG_ON(I2C_SMBUS_BLOCK_MAX > ETP_SMBUS_REPORT_LEN);
 478
 479         len = i2c_smbus_read_block_data(client,
 480                                         ETP_SMBUS_PACKET_QUERY,
 481                                         &report[ETP_SMBUS_REPORT_OFFSET]);
 482         if (len < 0) {
 483                 dev_err(&client->dev, "failed to read report data: %d\n", len);
 484                 return len;
 485         }
 486
 487         if (len != ETP_SMBUS_REPORT_LEN) {
 488                 dev_err(&client->dev,
 489                         "wrong report length (%d vs %d expected)\n",
 490                         len, ETP_SMBUS_REPORT_LEN);
 491                 return -EIO;
 492         }
 493
 494         return 0;
 495 }
 496
 497 static int elan_smbus_finish_fw_update(struct i2c_client *client,
 498                                        struct completion *fw_completion)
 499 {
 500         /* No special handling unlike I2C transport */
 501         return 0;
 502 }
 503
 504 const struct elan_transport_ops elan_smbus_ops = {
 505         .initialize             = elan_smbus_initialize,
 506         .sleep_control          = elan_smbus_sleep_control,
 507         .power_control          = elan_smbus_power_control,
 508         .set_mode               = elan_smbus_set_mode,
 509
 510         .calibrate              = elan_smbus_calibrate,
 511         .calibrate_result       = elan_smbus_calibrate_result,
 512
 513         .get_baseline_data      = elan_smbus_get_baseline_data,
 514
 515         .get_version            = elan_smbus_get_version,
 516         .get_sm_version         = elan_smbus_get_sm_version,
 517         .get_product_id         = elan_smbus_get_product_id,
 518         .get_checksum           = elan_smbus_get_checksum,
 519         .get_pressure_adjustment = elan_smbus_get_pressure_adjustment,
 520
 521         .get_max                = elan_smbus_get_max,
 522         .get_resolution         = elan_smbus_get_resolution,
 523         .get_num_traces         = elan_smbus_get_num_traces,
 524
 525         .iap_get_mode           = elan_smbus_iap_get_mode,
 526         .iap_reset              = elan_smbus_iap_reset,
 527
 528         .prepare_fw_update      = elan_smbus_prepare_fw_update,
 529         .write_fw_block         = elan_smbus_write_fw_block,
 530         .finish_fw_update       = elan_smbus_finish_fw_update,
 531
 532         .get_report             = elan_smbus_get_report,
 533 };