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 error;
 230         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 231
 232         error = i2c_smbus_read_block_data(client, ETP_SMBUS_RANGE_CMD, val);
 233         if (error) {
 234                 dev_err(&client->dev, "failed to get dimensions: %d\n", error);
 235                 return error;
 236         }
 237
 238         *max_x = (0x0f & val[0]) << 8 | val[1];
 239         *max_y = (0xf0 & val[0]) << 4 | val[2];
 240
 241         return 0;
 242 }
 243
 244 static int elan_smbus_get_resolution(struct i2c_client *client,
 245                                      u8 *hw_res_x, u8 *hw_res_y)
 246 {
 247         int error;
 248         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 249
 250         error = i2c_smbus_read_block_data(client,
 251                                           ETP_SMBUS_RESOLUTION_CMD, val);
 252         if (error) {
 253                 dev_err(&client->dev, "failed to get resolution: %d\n", error);
 254                 return error;
 255         }
 256
 257         *hw_res_x = val[1] & 0x0F;
 258         *hw_res_y = (val[1] & 0xF0) >> 4;
 259
 260         return 0;
 261 }
 262
 263 static int elan_smbus_get_num_traces(struct i2c_client *client,
 264                                      unsigned int *x_traces,
 265                                      unsigned int *y_traces)
 266 {
 267         int error;
 268         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 269
 270         error = i2c_smbus_read_block_data(client,
 271                                           ETP_SMBUS_XY_TRACENUM_CMD, val);
 272         if (error) {
 273                 dev_err(&client->dev, "failed to get trace info: %d\n", error);
 274                 return error;
 275         }
 276
 277         *x_traces = val[1];
 278         *y_traces = val[2];
 279
 280         return 0;
 281 }
 282
 283 static int elan_smbus_get_pressure_adjustment(struct i2c_client *client,
 284                                               int *adjustment)
 285 {
 286         *adjustment = ETP_PRESSURE_OFFSET;
 287         return 0;
 288 }
 289
 290 static int elan_smbus_iap_get_mode(struct i2c_client *client,
 291                                    enum tp_mode *mode)
 292 {
 293         int error;
 294         u16 constant;
 295         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 296
 297         error = i2c_smbus_read_block_data(client, ETP_SMBUS_IAP_CTRL_CMD, val);
 298         if (error < 0) {
 299                 dev_err(&client->dev, "failed to read iap ctrol register: %d\n",
 300                         error);
 301                 return error;
 302         }
 303
 304         constant = be16_to_cpup((__be16 *)val);
 305         dev_dbg(&client->dev, "iap control reg: 0x%04x.\n", constant);
 306
 307         *mode = (constant & ETP_SMBUS_IAP_MODE_ON) ? IAP_MODE : MAIN_MODE;
 308
 309         return 0;
 310 }
 311
 312 static int elan_smbus_iap_reset(struct i2c_client *client)
 313 {
 314         int error;
 315
 316         error = i2c_smbus_write_byte(client, ETP_SMBUS_IAP_RESET_CMD);
 317         if (error) {
 318                 dev_err(&client->dev, "cannot reset IC: %d\n", error);
 319                 return error;
 320         }
 321
 322         return 0;
 323 }
 324
 325 static int elan_smbus_set_flash_key(struct i2c_client *client)
 326 {
 327         int error;
 328         u8 cmd[4] = { 0x00, 0x0B, 0x00, 0x5A };
 329
 330         error = i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
 331                                            sizeof(cmd), cmd);
 332         if (error) {
 333                 dev_err(&client->dev, "cannot set flash key: %d\n", error);
 334                 return error;
 335         }
 336
 337         return 0;
 338 }
 339
 340 static int elan_smbus_prepare_fw_update(struct i2c_client *client)
 341 {
 342         struct device *dev = &client->dev;
 343         int len;
 344         int error;
 345         enum tp_mode mode;
 346         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 347         u8 cmd[4] = {0x0F, 0x78, 0x00, 0x06};
 348         u16 password;
 349
 350         /* Get FW in which mode (IAP_MODE/MAIN_MODE)  */
 351         error = elan_smbus_iap_get_mode(client, &mode);
 352         if (error)
 353                 return error;
 354
 355         if (mode == MAIN_MODE) {
 356
 357                 /* set flash key */
 358                 error = elan_smbus_set_flash_key(client);
 359                 if (error)
 360                         return error;
 361
 362                 /* write iap password */
 363                 if (i2c_smbus_write_byte(client,
 364                                          ETP_SMBUS_IAP_PASSWORD_WRITE) < 0) {
 365                         dev_err(dev, "cannot write iap password\n");
 366                         return -EIO;
 367                 }
 368
 369                 error = i2c_smbus_write_block_data(client, ETP_SMBUS_IAP_CMD,
 370                                                    sizeof(cmd), cmd);
 371                 if (error) {
 372                         dev_err(dev, "failed to write iap password: %d\n",
 373                                 error);
 374                         return error;
 375                 }
 376
 377                 /*
 378                  * Read back password to make sure we enabled flash
 379                  * successfully.
 380                  */
 381                 len = i2c_smbus_read_block_data(client,
 382                                                 ETP_SMBUS_IAP_PASSWORD_READ,
 383                                                 val);
 384                 if (len < sizeof(u16)) {
 385                         error = len < 0 ? len : -EIO;
 386                         dev_err(dev, "failed to read iap password: %d\n",
 387                                 error);
 388                         return error;
 389                 }
 390
 391                 password = be16_to_cpup((__be16 *)val);
 392                 if (password != ETP_SMBUS_IAP_PASSWORD) {
 393                         dev_err(dev, "wrong iap password = 0x%X\n", password);
 394                         return -EIO;
 395                 }
 396
 397                 /* Wait 30ms for MAIN_MODE change to IAP_MODE */
 398                 msleep(30);
 399         }
 400
 401         error = elan_smbus_set_flash_key(client);
 402         if (error)
 403                 return error;
 404
 405         /* Reset IC */
 406         error = elan_smbus_iap_reset(client);
 407         if (error)
 408                 return error;
 409
 410         return 0;
 411 }
 412
 413
 414 static int elan_smbus_write_fw_block(struct i2c_client *client,
 415                                      const u8 *page, u16 checksum, int idx)
 416 {
 417         struct device *dev = &client->dev;
 418         int error;
 419         u16 result;
 420         u8 val[I2C_SMBUS_BLOCK_MAX] = {0};
 421
 422         /*
 423          * Due to the limitation of smbus protocol limiting
 424          * transfer to 32 bytes at a time, we must split block
 425          * in 2 transfers.
 426          */
 427         error = i2c_smbus_write_block_data(client,
 428                                            ETP_SMBUS_WRITE_FW_BLOCK,
 429                                            ETP_FW_PAGE_SIZE / 2,
 430                                            page);
 431         if (error) {
 432                 dev_err(dev, "Failed to write page %d (part %d): %d\n",
 433                         idx, 1, error);
 434                 return error;
 435         }
 436
 437         error = i2c_smbus_write_block_data(client,
 438                                            ETP_SMBUS_WRITE_FW_BLOCK,
 439                                            ETP_FW_PAGE_SIZE / 2,
 440                                            page + ETP_FW_PAGE_SIZE / 2);
 441         if (error) {
 442                 dev_err(dev, "Failed to write page %d (part %d): %d\n",
 443                         idx, 2, error);
 444                 return error;
 445         }
 446
 447
 448         /* Wait for F/W to update one page ROM data. */
 449         usleep_range(8000, 10000);
 450
 451         error = i2c_smbus_read_block_data(client,
 452                                           ETP_SMBUS_IAP_CTRL_CMD, val);
 453         if (error < 0) {
 454                 dev_err(dev, "Failed to read IAP write result: %d\n",
 455                         error);
 456                 return error;
 457         }
 458
 459         result = be16_to_cpup((__be16 *)val);
 460         if (result & (ETP_FW_IAP_PAGE_ERR | ETP_FW_IAP_INTF_ERR)) {
 461                 dev_err(dev, "IAP reports failed write: %04hx\n",
 462                         result);
 463                 return -EIO;
 464         }
 465
 466         return 0;
 467 }
 468
 469 static int elan_smbus_get_report(struct i2c_client *client, u8 *report)
 470 {
 471         int len;
 472
 473         BUILD_BUG_ON(I2C_SMBUS_BLOCK_MAX > ETP_SMBUS_REPORT_LEN);
 474
 475         len = i2c_smbus_read_block_data(client,
 476                                         ETP_SMBUS_PACKET_QUERY,
 477                                         &report[ETP_SMBUS_REPORT_OFFSET]);
 478         if (len < 0) {
 479                 dev_err(&client->dev, "failed to read report data: %d\n", len);
 480                 return len;
 481         }
 482
 483         if (len != ETP_SMBUS_REPORT_LEN) {
 484                 dev_err(&client->dev,
 485                         "wrong report length (%d vs %d expected)\n",
 486                         len, ETP_SMBUS_REPORT_LEN);
 487                 return -EIO;
 488         }
 489
 490         return 0;
 491 }
 492
 493 static int elan_smbus_finish_fw_update(struct i2c_client *client,
 494                                        struct completion *fw_completion)
 495 {
 496         /* No special handling unlike I2C transport */
 497         return 0;
 498 }
 499
 500 const struct elan_transport_ops elan_smbus_ops = {
 501         .initialize             = elan_smbus_initialize,
 502         .sleep_control          = elan_smbus_sleep_control,
 503         .power_control          = elan_smbus_power_control,
 504         .set_mode               = elan_smbus_set_mode,
 505
 506         .calibrate              = elan_smbus_calibrate,
 507         .calibrate_result       = elan_smbus_calibrate_result,
 508
 509         .get_baseline_data      = elan_smbus_get_baseline_data,
 510
 511         .get_version            = elan_smbus_get_version,
 512         .get_sm_version         = elan_smbus_get_sm_version,
 513         .get_product_id         = elan_smbus_get_product_id,
 514         .get_checksum           = elan_smbus_get_checksum,
 515         .get_pressure_adjustment = elan_smbus_get_pressure_adjustment,
 516
 517         .get_max                = elan_smbus_get_max,
 518         .get_resolution         = elan_smbus_get_resolution,
 519         .get_num_traces         = elan_smbus_get_num_traces,
 520
 521         .iap_get_mode           = elan_smbus_iap_get_mode,
 522         .iap_reset              = elan_smbus_iap_reset,
 523
 524         .prepare_fw_update      = elan_smbus_prepare_fw_update,
 525         .write_fw_block         = elan_smbus_write_fw_block,
 526         .finish_fw_update       = elan_smbus_finish_fw_update,
 527
 528         .get_report             = elan_smbus_get_report,
 529 };