drivers/input/mouse/cyapa.c

   1 /*
   2  * Cypress APA trackpad with I2C interface
   3  *
   4  * Author: Dudley Du <dudl@cypress.com>
   5  * Further cleanup and restructuring by:
   6  *   Daniel Kurtz <djkurtz@chromium.org>
   7  *   Benson Leung <bleung@chromium.org>
   8  *
   9  * Copyright (C) 2011-2015 Cypress Semiconductor, Inc.
  10  * Copyright (C) 2011-2012 Google, Inc.
  11  *
  12  * This file is subject to the terms and conditions of the GNU General Public
  13  * License.  See the file COPYING in the main directory of this archive for
  14  * more details.
  15  */
  16
  17 #include <linux/delay.h>
  18 #include <linux/i2c.h>
  19 #include <linux/input.h>
  20 #include <linux/input/mt.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/module.h>
  23 #include <linux/mutex.h>
  24 #include <linux/regulator/consumer.h>
  25 #include <linux/slab.h>
  26 #include <linux/uaccess.h>
  27 #include <linux/pm_runtime.h>
  28 #include <linux/acpi.h>
  29 #include <linux/of.h>
  30 #include "cyapa.h"
  31
  32
  33 #define CYAPA_ADAPTER_FUNC_NONE   0
  34 #define CYAPA_ADAPTER_FUNC_I2C    1
  35 #define CYAPA_ADAPTER_FUNC_SMBUS  2
  36 #define CYAPA_ADAPTER_FUNC_BOTH   3
  37
  38 #define CYAPA_FW_NAME           "cyapa.bin"
  39
  40 const char product_id[] = "CYTRA";
  41
  42 static int cyapa_reinitialize(struct cyapa *cyapa);
  43
  44 bool cyapa_is_pip_bl_mode(struct cyapa *cyapa)
  45 {
  46         if (cyapa->gen == CYAPA_GEN6 && cyapa->state == CYAPA_STATE_GEN6_BL)
  47                 return true;
  48
  49         if (cyapa->gen == CYAPA_GEN5 && cyapa->state == CYAPA_STATE_GEN5_BL)
  50                 return true;
  51
  52         return false;
  53 }
  54
  55 bool cyapa_is_pip_app_mode(struct cyapa *cyapa)
  56 {
  57         if (cyapa->gen == CYAPA_GEN6 && cyapa->state == CYAPA_STATE_GEN6_APP)
  58                 return true;
  59
  60         if (cyapa->gen == CYAPA_GEN5 && cyapa->state == CYAPA_STATE_GEN5_APP)
  61                 return true;
  62
  63         return false;
  64 }
  65
  66 static bool cyapa_is_bootloader_mode(struct cyapa *cyapa)
  67 {
  68         if (cyapa_is_pip_bl_mode(cyapa))
  69                 return true;
  70
  71         if (cyapa->gen == CYAPA_GEN3 &&
  72                 cyapa->state >= CYAPA_STATE_BL_BUSY &&
  73                 cyapa->state <= CYAPA_STATE_BL_ACTIVE)
  74                 return true;
  75
  76         return false;
  77 }
  78
  79 static inline bool cyapa_is_operational_mode(struct cyapa *cyapa)
  80 {
  81         if (cyapa_is_pip_app_mode(cyapa))
  82                 return true;
  83
  84         if (cyapa->gen == CYAPA_GEN3 && cyapa->state == CYAPA_STATE_OP)
  85                 return true;
  86
  87         return false;
  88 }
  89
  90 /* Returns 0 on success, else negative errno on failure. */
  91 static ssize_t cyapa_i2c_read(struct cyapa *cyapa, u8 reg, size_t len,
  92                                         u8 *values)
  93 {
  94         struct i2c_client *client = cyapa->client;
  95         struct i2c_msg msgs[] = {
  96                 {
  97                         .addr = client->addr,
  98                         .flags = 0,
  99                         .len = 1,
 100                         .buf = &reg,
 101                 },
 102                 {
 103                         .addr = client->addr,
 104                         .flags = I2C_M_RD,
 105                         .len = len,
 106                         .buf = values,
 107                 },
 108         };
 109         int ret;
 110
 111         ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
 112
 113         if (ret != ARRAY_SIZE(msgs))
 114                 return ret < 0 ? ret : -EIO;
 115
 116         return 0;
 117 }
 118
 119 /**
 120  * cyapa_i2c_write - Execute i2c block data write operation
 121  * @cyapa: Handle to this driver
 122  * @ret: Offset of the data to written in the register map
 123  * @len: number of bytes to write
 124  * @values: Data to be written
 125  *
 126  * Return negative errno code on error; return zero when success.
 127  */
 128 static int cyapa_i2c_write(struct cyapa *cyapa, u8 reg,
 129                                          size_t len, const void *values)
 130 {
 131         struct i2c_client *client = cyapa->client;
 132         char buf[32];
 133         int ret;
 134
 135         if (len > sizeof(buf) - 1)
 136                 return -ENOMEM;
 137
 138         buf[0] = reg;
 139         memcpy(&buf[1], values, len);
 140
 141         ret = i2c_master_send(client, buf, len + 1);
 142         if (ret != len + 1)
 143                 return ret < 0 ? ret : -EIO;
 144
 145         return 0;
 146 }
 147
 148 static u8 cyapa_check_adapter_functionality(struct i2c_client *client)
 149 {
 150         u8 ret = CYAPA_ADAPTER_FUNC_NONE;
 151
 152         if (i2c_check_functionality(client->adapter, I2C_FUNC_I2C))
 153                 ret |= CYAPA_ADAPTER_FUNC_I2C;
 154         if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA |
 155                                      I2C_FUNC_SMBUS_BLOCK_DATA |
 156                                      I2C_FUNC_SMBUS_I2C_BLOCK))
 157                 ret |= CYAPA_ADAPTER_FUNC_SMBUS;
 158         return ret;
 159 }
 160
 161 /*
 162  * Query device for its current operating state.
 163  */
 164 static int cyapa_get_state(struct cyapa *cyapa)
 165 {
 166         u8 status[BL_STATUS_SIZE];
 167         u8 cmd[32];
 168         /* The i2c address of gen4 and gen5 trackpad device must be even. */
 169         bool even_addr = ((cyapa->client->addr & 0x0001) == 0);
 170         bool smbus = false;
 171         int retries = 2;
 172         int error;
 173
 174         cyapa->state = CYAPA_STATE_NO_DEVICE;
 175
 176         /*
 177          * Get trackpad status by reading 3 registers starting from 0.
 178          * If the device is in the bootloader, this will be BL_HEAD.
 179          * If the device is in operation mode, this will be the DATA regs.
 180          *
 181          */
 182         error = cyapa_i2c_reg_read_block(cyapa, BL_HEAD_OFFSET, BL_STATUS_SIZE,
 183                                        status);
 184
 185         /*
 186          * On smbus systems in OP mode, the i2c_reg_read will fail with
 187          * -ETIMEDOUT.  In this case, try again using the smbus equivalent
 188          * command.  This should return a BL_HEAD indicating CYAPA_STATE_OP.
 189          */
 190         if (cyapa->smbus && (error == -ETIMEDOUT || error == -ENXIO)) {
 191                 if (!even_addr)
 192                         error = cyapa_read_block(cyapa,
 193                                         CYAPA_CMD_BL_STATUS, status);
 194                 smbus = true;
 195         }
 196
 197         if (error != BL_STATUS_SIZE)
 198                 goto error;
 199
 200         /*
 201          * Detect trackpad protocol based on characteristic registers and bits.
 202          */
 203         do {
 204                 cyapa->status[REG_OP_STATUS] = status[REG_OP_STATUS];
 205                 cyapa->status[REG_BL_STATUS] = status[REG_BL_STATUS];
 206                 cyapa->status[REG_BL_ERROR] = status[REG_BL_ERROR];
 207
 208                 if (cyapa->gen == CYAPA_GEN_UNKNOWN ||
 209                                 cyapa->gen == CYAPA_GEN3) {
 210                         error = cyapa_gen3_ops.state_parse(cyapa,
 211                                         status, BL_STATUS_SIZE);
 212                         if (!error)
 213                                 goto out_detected;
 214                 }
 215                 if (cyapa->gen == CYAPA_GEN_UNKNOWN ||
 216                                 cyapa->gen == CYAPA_GEN6 ||
 217                                 cyapa->gen == CYAPA_GEN5) {
 218                         error = cyapa_pip_state_parse(cyapa,
 219                                         status, BL_STATUS_SIZE);
 220                         if (!error)
 221                                 goto out_detected;
 222                 }
 223                 /* For old Gen5 trackpads detecting. */
 224                 if ((cyapa->gen == CYAPA_GEN_UNKNOWN ||
 225                                 cyapa->gen == CYAPA_GEN5) &&
 226                         !smbus && even_addr) {
 227                         error = cyapa_gen5_ops.state_parse(cyapa,
 228                                         status, BL_STATUS_SIZE);
 229                         if (!error)
 230                                 goto out_detected;
 231                 }
 232
 233                 /*
 234                  * Write 0x00 0x00 to trackpad device to force update its
 235                  * status, then redo the detection again.
 236                  */
 237                 if (!smbus) {
 238                         cmd[0] = 0x00;
 239                         cmd[1] = 0x00;
 240                         error = cyapa_i2c_write(cyapa, 0, 2, cmd);
 241                         if (error)
 242                                 goto error;
 243
 244                         msleep(50);
 245
 246                         error = cyapa_i2c_read(cyapa, BL_HEAD_OFFSET,
 247                                         BL_STATUS_SIZE, status);
 248                         if (error)
 249                                 goto error;
 250                 }
 251         } while (--retries > 0 && !smbus);
 252
 253         goto error;
 254
 255 out_detected:
 256         if (cyapa->state <= CYAPA_STATE_BL_BUSY)
 257                 return -EAGAIN;
 258         return 0;
 259
 260 error:
 261         return (error < 0) ? error : -EAGAIN;
 262 }
 263
 264 /*
 265  * Poll device for its status in a loop, waiting up to timeout for a response.
 266  *
 267  * When the device switches state, it usually takes ~300 ms.
 268  * However, when running a new firmware image, the device must calibrate its
 269  * sensors, which can take as long as 2 seconds.
 270  *
 271  * Note: The timeout has granularity of the polling rate, which is 100 ms.
 272  *
 273  * Returns:
 274  *   0 when the device eventually responds with a valid non-busy state.
 275  *   -ETIMEDOUT if device never responds (too many -EAGAIN)
 276  *   -EAGAIN    if bootload is busy, or unknown state.
 277  *   < 0        other errors
 278  */
 279 int cyapa_poll_state(struct cyapa *cyapa, unsigned int timeout)
 280 {
 281         int error;
 282         int tries = timeout / 100;
 283
 284         do {
 285                 error = cyapa_get_state(cyapa);
 286                 if (!error && cyapa->state > CYAPA_STATE_BL_BUSY)
 287                         return 0;
 288
 289                 msleep(100);
 290         } while (tries--);
 291
 292         return (error == -EAGAIN || error == -ETIMEDOUT) ? -ETIMEDOUT : error;
 293 }
 294
 295 /*
 296  * Check if device is operational.
 297  *
 298  * An operational device is responding, has exited bootloader, and has
 299  * firmware supported by this driver.
 300  *
 301  * Returns:
 302  *   -ENODEV no device
 303  *   -EBUSY  no device or in bootloader
 304  *   -EIO    failure while reading from device
 305  *   -ETIMEDOUT timeout failure for bus idle or bus no response
 306  *   -EAGAIN device is still in bootloader
 307  *           if ->state = CYAPA_STATE_BL_IDLE, device has invalid firmware
 308  *   -EINVAL device is in operational mode, but not supported by this driver
 309  *   0       device is supported
 310  */
 311 static int cyapa_check_is_operational(struct cyapa *cyapa)
 312 {
 313         int error;
 314
 315         error = cyapa_poll_state(cyapa, 4000);
 316         if (error)
 317                 return error;
 318
 319         switch (cyapa->gen) {
 320         case CYAPA_GEN6:
 321                 cyapa->ops = &cyapa_gen6_ops;
 322                 break;
 323         case CYAPA_GEN5:
 324                 cyapa->ops = &cyapa_gen5_ops;
 325                 break;
 326         case CYAPA_GEN3:
 327                 cyapa->ops = &cyapa_gen3_ops;
 328                 break;
 329         default:
 330                 return -ENODEV;
 331         }
 332
 333         error = cyapa->ops->operational_check(cyapa);
 334         if (!error && cyapa_is_operational_mode(cyapa))
 335                 cyapa->operational = true;
 336         else
 337                 cyapa->operational = false;
 338
 339         return error;
 340 }
 341
 342
 343 /*
 344  * Returns 0 on device detected, negative errno on no device detected.
 345  * And when the device is detected and operational, it will be reset to
 346  * full power active mode automatically.
 347  */
 348 static int cyapa_detect(struct cyapa *cyapa)
 349 {
 350         struct device *dev = &cyapa->client->dev;
 351         int error;
 352
 353         error = cyapa_check_is_operational(cyapa);
 354         if (error) {
 355                 if (error != -ETIMEDOUT && error != -ENODEV &&
 356                         cyapa_is_bootloader_mode(cyapa)) {
 357                         dev_warn(dev, "device detected but not operational\n");
 358                         return 0;
 359                 }
 360
 361                 dev_err(dev, "no device detected: %d\n", error);
 362                 return error;
 363         }
 364
 365         return 0;
 366 }
 367
 368 static int cyapa_open(struct input_dev *input)
 369 {
 370         struct cyapa *cyapa = input_get_drvdata(input);
 371         struct i2c_client *client = cyapa->client;
 372         struct device *dev = &client->dev;
 373         int error;
 374
 375         error = mutex_lock_interruptible(&cyapa->state_sync_lock);
 376         if (error)
 377                 return error;
 378
 379         if (cyapa->operational) {
 380                 /*
 381                  * though failed to set active power mode,
 382                  * but still may be able to work in lower scan rate
 383                  * when in operational mode.
 384                  */
 385                 error = cyapa->ops->set_power_mode(cyapa,
 386                                 PWR_MODE_FULL_ACTIVE, 0, false);
 387                 if (error) {
 388                         dev_warn(dev, "set active power failed: %d\n", error);
 389                         goto out;
 390                 }
 391         } else {
 392                 error = cyapa_reinitialize(cyapa);
 393                 if (error || !cyapa->operational) {
 394                         error = error ? error : -EAGAIN;
 395                         goto out;
 396                 }
 397         }
 398
 399         enable_irq(client->irq);
 400         if (!pm_runtime_enabled(dev)) {
 401                 pm_runtime_set_active(dev);
 402                 pm_runtime_enable(dev);
 403         }
 404
 405         pm_runtime_get_sync(dev);
 406         pm_runtime_mark_last_busy(dev);
 407         pm_runtime_put_sync_autosuspend(dev);
 408 out:
 409         mutex_unlock(&cyapa->state_sync_lock);
 410         return error;
 411 }
 412
 413 static void cyapa_close(struct input_dev *input)
 414 {
 415         struct cyapa *cyapa = input_get_drvdata(input);
 416         struct i2c_client *client = cyapa->client;
 417         struct device *dev = &cyapa->client->dev;
 418
 419         mutex_lock(&cyapa->state_sync_lock);
 420
 421         disable_irq(client->irq);
 422         if (pm_runtime_enabled(dev))
 423                 pm_runtime_disable(dev);
 424         pm_runtime_set_suspended(dev);
 425
 426         if (cyapa->operational)
 427                 cyapa->ops->set_power_mode(cyapa, PWR_MODE_OFF, 0, false);
 428
 429         mutex_unlock(&cyapa->state_sync_lock);
 430 }
 431
 432 static int cyapa_create_input_dev(struct cyapa *cyapa)
 433 {
 434         struct device *dev = &cyapa->client->dev;
 435         struct input_dev *input;
 436         int error;
 437
 438         if (!cyapa->physical_size_x || !cyapa->physical_size_y)
 439                 return -EINVAL;
 440
 441         input = devm_input_allocate_device(dev);
 442         if (!input) {
 443                 dev_err(dev, "failed to allocate memory for input device.\n");
 444                 return -ENOMEM;
 445         }
 446
 447         input->name = CYAPA_NAME;
 448         input->phys = cyapa->phys;
 449         input->id.bustype = BUS_I2C;
 450         input->id.version = 1;
 451         input->id.product = 0;  /* Means any product in eventcomm. */
 452         input->dev.parent = &cyapa->client->dev;
 453
 454         input->open = cyapa_open;
 455         input->close = cyapa_close;
 456
 457         input_set_drvdata(input, cyapa);
 458
 459         __set_bit(EV_ABS, input->evbit);
 460
 461         /* Finger position */
 462         input_set_abs_params(input, ABS_MT_POSITION_X, 0, cyapa->max_abs_x, 0,
 463                              0);
 464         input_set_abs_params(input, ABS_MT_POSITION_Y, 0, cyapa->max_abs_y, 0,
 465                              0);
 466         input_set_abs_params(input, ABS_MT_PRESSURE, 0, cyapa->max_z, 0, 0);
 467         if (cyapa->gen > CYAPA_GEN3) {
 468                 input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0);
 469                 input_set_abs_params(input, ABS_MT_TOUCH_MINOR, 0, 255, 0, 0);
 470                 /*
 471                  * Orientation is the angle between the vertical axis and
 472                  * the major axis of the contact ellipse.
 473                  * The range is -127 to 127.
 474                  * the positive direction is clockwise form the vertical axis.
 475                  * If the ellipse of contact degenerates into a circle,
 476                  * orientation is reported as 0.
 477                  *
 478                  * Also, for Gen5 trackpad the accurate of this orientation
 479                  * value is value + (-30 ~ 30).
 480                  */
 481                 input_set_abs_params(input, ABS_MT_ORIENTATION,
 482                                 -127, 127, 0, 0);
 483         }
 484         if (cyapa->gen >= CYAPA_GEN5) {
 485                 input_set_abs_params(input, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0);
 486                 input_set_abs_params(input, ABS_MT_WIDTH_MINOR, 0, 255, 0, 0);
 487                 input_set_abs_params(input, ABS_DISTANCE, 0, 1, 0, 0);
 488         }
 489
 490         input_abs_set_res(input, ABS_MT_POSITION_X,
 491                           cyapa->max_abs_x / cyapa->physical_size_x);
 492         input_abs_set_res(input, ABS_MT_POSITION_Y,
 493                           cyapa->max_abs_y / cyapa->physical_size_y);
 494
 495         if (cyapa->btn_capability & CAPABILITY_LEFT_BTN_MASK)
 496                 __set_bit(BTN_LEFT, input->keybit);
 497         if (cyapa->btn_capability & CAPABILITY_MIDDLE_BTN_MASK)
 498                 __set_bit(BTN_MIDDLE, input->keybit);
 499         if (cyapa->btn_capability & CAPABILITY_RIGHT_BTN_MASK)
 500                 __set_bit(BTN_RIGHT, input->keybit);
 501
 502         if (cyapa->btn_capability == CAPABILITY_LEFT_BTN_MASK)
 503                 __set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
 504
 505         /* Handle pointer emulation and unused slots in core */
 506         error = input_mt_init_slots(input, CYAPA_MAX_MT_SLOTS,
 507                                     INPUT_MT_POINTER | INPUT_MT_DROP_UNUSED);
 508         if (error) {
 509                 dev_err(dev, "failed to initialize MT slots: %d\n", error);
 510                 return error;
 511         }
 512
 513         /* Register the device in input subsystem */
 514         error = input_register_device(input);
 515         if (error) {
 516                 dev_err(dev, "failed to register input device: %d\n", error);
 517                 return error;
 518         }
 519
 520         cyapa->input = input;
 521         return 0;
 522 }
 523
 524 static void cyapa_enable_irq_for_cmd(struct cyapa *cyapa)
 525 {
 526         struct input_dev *input = cyapa->input;
 527
 528         if (!input || !input->users) {
 529                 /*
 530                  * When input is NULL, TP must be in deep sleep mode.
 531                  * In this mode, later non-power I2C command will always failed
 532                  * if not bring it out of deep sleep mode firstly,
 533                  * so must command TP to active mode here.
 534                  */
 535                 if (!input || cyapa->operational)
 536                         cyapa->ops->set_power_mode(cyapa,
 537                                 PWR_MODE_FULL_ACTIVE, 0, false);
 538                 /* Gen3 always using polling mode for command. */
 539                 if (cyapa->gen >= CYAPA_GEN5)
 540                         enable_irq(cyapa->client->irq);
 541         }
 542 }
 543
 544 static void cyapa_disable_irq_for_cmd(struct cyapa *cyapa)
 545 {
 546         struct input_dev *input = cyapa->input;
 547
 548         if (!input || !input->users) {
 549                 if (cyapa->gen >= CYAPA_GEN5)
 550                         disable_irq(cyapa->client->irq);
 551                 if (!input || cyapa->operational)
 552                         cyapa->ops->set_power_mode(cyapa,
 553                                                    PWR_MODE_OFF, 0, false);
 554         }
 555 }
 556
 557 /*
 558  * cyapa_sleep_time_to_pwr_cmd and cyapa_pwr_cmd_to_sleep_time
 559  *
 560  * These are helper functions that convert to and from integer idle
 561  * times and register settings to write to the PowerMode register.
 562  * The trackpad supports between 20ms to 1000ms scan intervals.
 563  * The time will be increased in increments of 10ms from 20ms to 100ms.
 564  * From 100ms to 1000ms, time will be increased in increments of 20ms.
 565  *
 566  * When Idle_Time < 100, the format to convert Idle_Time to Idle_Command is:
 567  *   Idle_Command = Idle Time / 10;
 568  * When Idle_Time >= 100, the format to convert Idle_Time to Idle_Command is:
 569  *   Idle_Command = Idle Time / 20 + 5;
 570  */
 571 u8 cyapa_sleep_time_to_pwr_cmd(u16 sleep_time)
 572 {
 573         u16 encoded_time;
 574
 575         sleep_time = clamp_val(sleep_time, 20, 1000);
 576         encoded_time = sleep_time < 100 ? sleep_time / 10 : sleep_time / 20 + 5;
 577         return (encoded_time << 2) & PWR_MODE_MASK;
 578 }
 579
 580 u16 cyapa_pwr_cmd_to_sleep_time(u8 pwr_mode)
 581 {
 582         u8 encoded_time = pwr_mode >> 2;
 583
 584         return (encoded_time < 10) ? encoded_time * 10
 585                                    : (encoded_time - 5) * 20;
 586 }
 587
 588 /* 0 on driver initialize and detected successfully, negative on failure. */
 589 static int cyapa_initialize(struct cyapa *cyapa)
 590 {
 591         int error = 0;
 592
 593         cyapa->state = CYAPA_STATE_NO_DEVICE;
 594         cyapa->gen = CYAPA_GEN_UNKNOWN;
 595         mutex_init(&cyapa->state_sync_lock);
 596
 597         /*
 598          * Set to hard code default, they will be updated with trackpad set
 599          * default values after probe and initialized.
 600          */
 601         cyapa->suspend_power_mode = PWR_MODE_SLEEP;
 602         cyapa->suspend_sleep_time =
 603                 cyapa_pwr_cmd_to_sleep_time(cyapa->suspend_power_mode);
 604
 605         /* ops.initialize() is aimed to prepare for module communications. */
 606         error = cyapa_gen3_ops.initialize(cyapa);
 607         if (!error)
 608                 error = cyapa_gen5_ops.initialize(cyapa);
 609         if (!error)
 610                 error = cyapa_gen6_ops.initialize(cyapa);
 611         if (error)
 612                 return error;
 613
 614         error = cyapa_detect(cyapa);
 615         if (error)
 616                 return error;
 617
 618         /* Power down the device until we need it. */
 619         if (cyapa->operational)
 620                 cyapa->ops->set_power_mode(cyapa, PWR_MODE_OFF, 0, false);
 621
 622         return 0;
 623 }
 624
 625 static int cyapa_reinitialize(struct cyapa *cyapa)
 626 {
 627         struct device *dev = &cyapa->client->dev;
 628         struct input_dev *input = cyapa->input;
 629         int error;
 630
 631         if (pm_runtime_enabled(dev))
 632                 pm_runtime_disable(dev);
 633
 634         /* Avoid command failures when TP was in OFF state. */
 635         if (cyapa->operational)
 636                 cyapa->ops->set_power_mode(cyapa,
 637                                            PWR_MODE_FULL_ACTIVE, 0, false);
 638
 639         error = cyapa_detect(cyapa);
 640         if (error)
 641                 goto out;
 642
 643         if (!input && cyapa->operational) {
 644                 error = cyapa_create_input_dev(cyapa);
 645                 if (error) {
 646                         dev_err(dev, "create input_dev instance failed: %d\n",
 647                                         error);
 648                         goto out;
 649                 }
 650         }
 651
 652 out:
 653         if (!input || !input->users) {
 654                 /* Reset to power OFF state to save power when no user open. */
 655                 if (cyapa->operational)
 656                         cyapa->ops->set_power_mode(cyapa,
 657                                                    PWR_MODE_OFF, 0, false);
 658         } else if (!error && cyapa->operational) {
 659                 /*
 660                  * Make sure only enable runtime PM when device is
 661                  * in operational mode and input->users > 0.
 662                  */
 663                 pm_runtime_set_active(dev);
 664                 pm_runtime_enable(dev);
 665
 666                 pm_runtime_get_sync(dev);
 667                 pm_runtime_mark_last_busy(dev);
 668                 pm_runtime_put_sync_autosuspend(dev);
 669         }
 670
 671         return error;
 672 }
 673
 674 static irqreturn_t cyapa_irq(int irq, void *dev_id)
 675 {
 676         struct cyapa *cyapa = dev_id;
 677         struct device *dev = &cyapa->client->dev;
 678         int error;
 679
 680         if (device_may_wakeup(dev))
 681                 pm_wakeup_event(dev, 0);
 682
 683         /* Interrupt event can be caused by host command to trackpad device. */
 684         if (cyapa->ops->irq_cmd_handler(cyapa)) {
 685                 /*
 686                  * Interrupt event maybe from trackpad device input reporting.
 687                  */
 688                 if (!cyapa->input) {
 689                         /*
 690                          * Still in probing or in firmware image
 691                          * updating or reading.
 692                          */
 693                         cyapa->ops->sort_empty_output_data(cyapa,
 694                                         NULL, NULL, NULL);
 695                         goto out;
 696                 }
 697
 698                 if (cyapa->operational) {
 699                         error = cyapa->ops->irq_handler(cyapa);
 700
 701                         /*
 702                          * Apply runtime power management to touch report event
 703                          * except the events caused by the command responses.
 704                          * Note:
 705                          * It will introduce about 20~40 ms additional delay
 706                          * time in receiving for first valid touch report data.
 707                          * The time is used to execute device runtime resume
 708                          * process.
 709                          */
 710                         pm_runtime_get_sync(dev);
 711                         pm_runtime_mark_last_busy(dev);
 712                         pm_runtime_put_sync_autosuspend(dev);
 713                 }
 714
 715                 if (!cyapa->operational || error) {
 716                         if (!mutex_trylock(&cyapa->state_sync_lock)) {
 717                                 cyapa->ops->sort_empty_output_data(cyapa,
 718                                         NULL, NULL, NULL);
 719                                 goto out;
 720                         }
 721                         cyapa_reinitialize(cyapa);
 722                         mutex_unlock(&cyapa->state_sync_lock);
 723                 }
 724         }
 725
 726 out:
 727         return IRQ_HANDLED;
 728 }
 729
 730 /*
 731  **************************************************************
 732  * sysfs interface
 733  **************************************************************
 734 */
 735 #ifdef CONFIG_PM_SLEEP
 736 static ssize_t cyapa_show_suspend_scanrate(struct device *dev,
 737                                            struct device_attribute *attr,
 738                                            char *buf)
 739 {
 740         struct cyapa *cyapa = dev_get_drvdata(dev);
 741         u8 pwr_cmd = cyapa->suspend_power_mode;
 742         u16 sleep_time;
 743         int len;
 744         int error;
 745
 746         error = mutex_lock_interruptible(&cyapa->state_sync_lock);
 747         if (error)
 748                 return error;
 749
 750         pwr_cmd = cyapa->suspend_power_mode;
 751         sleep_time = cyapa->suspend_sleep_time;
 752
 753         mutex_unlock(&cyapa->state_sync_lock);
 754
 755         switch (pwr_cmd) {
 756         case PWR_MODE_BTN_ONLY:
 757                 len = scnprintf(buf, PAGE_SIZE, "%s\n", BTN_ONLY_MODE_NAME);
 758                 break;
 759
 760         case PWR_MODE_OFF:
 761                 len = scnprintf(buf, PAGE_SIZE, "%s\n", OFF_MODE_NAME);
 762                 break;
 763
 764         default:
 765                 len = scnprintf(buf, PAGE_SIZE, "%u\n",
 766                                 cyapa->gen == CYAPA_GEN3 ?
 767                                         cyapa_pwr_cmd_to_sleep_time(pwr_cmd) :
 768                                         sleep_time);
 769                 break;
 770         }
 771
 772         return len;
 773 }
 774
 775 static ssize_t cyapa_update_suspend_scanrate(struct device *dev,
 776                                              struct device_attribute *attr,
 777                                              const char *buf, size_t count)
 778 {
 779         struct cyapa *cyapa = dev_get_drvdata(dev);
 780         u16 sleep_time;
 781         int error;
 782
 783         error = mutex_lock_interruptible(&cyapa->state_sync_lock);
 784         if (error)
 785                 return error;
 786
 787         if (sysfs_streq(buf, BTN_ONLY_MODE_NAME)) {
 788                 cyapa->suspend_power_mode = PWR_MODE_BTN_ONLY;
 789         } else if (sysfs_streq(buf, OFF_MODE_NAME)) {
 790                 cyapa->suspend_power_mode = PWR_MODE_OFF;
 791         } else if (!kstrtou16(buf, 10, &sleep_time)) {
 792                 cyapa->suspend_sleep_time = min_t(u16, sleep_time, 1000);
 793                 cyapa->suspend_power_mode =
 794                         cyapa_sleep_time_to_pwr_cmd(cyapa->suspend_sleep_time);
 795         } else {
 796                 count = -EINVAL;
 797         }
 798
 799         mutex_unlock(&cyapa->state_sync_lock);
 800
 801         return count;
 802 }
 803
 804 static DEVICE_ATTR(suspend_scanrate_ms, S_IRUGO|S_IWUSR,
 805                    cyapa_show_suspend_scanrate,
 806                    cyapa_update_suspend_scanrate);
 807
 808 static struct attribute *cyapa_power_wakeup_entries[] = {
 809         &dev_attr_suspend_scanrate_ms.attr,
 810         NULL,
 811 };
 812
 813 static const struct attribute_group cyapa_power_wakeup_group = {
 814         .name = power_group_name,
 815         .attrs = cyapa_power_wakeup_entries,
 816 };
 817
 818 static void cyapa_remove_power_wakeup_group(void *data)
 819 {
 820         struct cyapa *cyapa = data;
 821
 822         sysfs_unmerge_group(&cyapa->client->dev.kobj,
 823                                 &cyapa_power_wakeup_group);
 824 }
 825
 826 static int cyapa_prepare_wakeup_controls(struct cyapa *cyapa)
 827 {
 828         struct i2c_client *client = cyapa->client;
 829         struct device *dev = &client->dev;
 830         int error;
 831
 832         if (device_can_wakeup(dev)) {
 833                 error = sysfs_merge_group(&client->dev.kobj,
 834                                         &cyapa_power_wakeup_group);
 835                 if (error) {
 836                         dev_err(dev, "failed to add power wakeup group: %d\n",
 837                                 error);
 838                         return error;
 839                 }
 840
 841                 error = devm_add_action(dev,
 842                                 cyapa_remove_power_wakeup_group, cyapa);
 843                 if (error) {
 844                         cyapa_remove_power_wakeup_group(cyapa);
 845                         dev_err(dev, "failed to add power cleanup action: %d\n",
 846                                 error);
 847                         return error;
 848                 }
 849         }
 850
 851         return 0;
 852 }
 853 #else
 854 static inline int cyapa_prepare_wakeup_controls(struct cyapa *cyapa)
 855 {
 856         return 0;
 857 }
 858 #endif /* CONFIG_PM_SLEEP */
 859
 860 #ifdef CONFIG_PM
 861 static ssize_t cyapa_show_rt_suspend_scanrate(struct device *dev,
 862                                               struct device_attribute *attr,
 863                                               char *buf)
 864 {
 865         struct cyapa *cyapa = dev_get_drvdata(dev);
 866         u8 pwr_cmd;
 867         u16 sleep_time;
 868         int error;
 869
 870         error = mutex_lock_interruptible(&cyapa->state_sync_lock);
 871         if (error)
 872                 return error;
 873
 874         pwr_cmd = cyapa->runtime_suspend_power_mode;
 875         sleep_time = cyapa->runtime_suspend_sleep_time;
 876
 877         mutex_unlock(&cyapa->state_sync_lock);
 878
 879         return scnprintf(buf, PAGE_SIZE, "%u\n",
 880                          cyapa->gen == CYAPA_GEN3 ?
 881                                 cyapa_pwr_cmd_to_sleep_time(pwr_cmd) :
 882                                 sleep_time);
 883 }
 884
 885 static ssize_t cyapa_update_rt_suspend_scanrate(struct device *dev,
 886                                                 struct device_attribute *attr,
 887                                                 const char *buf, size_t count)
 888 {
 889         struct cyapa *cyapa = dev_get_drvdata(dev);
 890         u16 time;
 891         int error;
 892
 893         if (buf == NULL || count == 0 || kstrtou16(buf, 10, &time)) {
 894                 dev_err(dev, "invalid runtime suspend scanrate ms parameter\n");
 895                 return -EINVAL;
 896         }
 897
 898         /*
 899          * When the suspend scanrate is changed, pm_runtime_get to resume
 900          * a potentially suspended device, update to the new pwr_cmd
 901          * and then pm_runtime_put to suspend into the new power mode.
 902          */
 903         pm_runtime_get_sync(dev);
 904
 905         error = mutex_lock_interruptible(&cyapa->state_sync_lock);
 906         if (error)
 907                 return error;
 908
 909         cyapa->runtime_suspend_sleep_time = min_t(u16, time, 1000);
 910         cyapa->runtime_suspend_power_mode =
 911                 cyapa_sleep_time_to_pwr_cmd(cyapa->runtime_suspend_sleep_time);
 912
 913         mutex_unlock(&cyapa->state_sync_lock);
 914
 915         pm_runtime_put_sync_autosuspend(dev);
 916
 917         return count;
 918 }
 919
 920 static DEVICE_ATTR(runtime_suspend_scanrate_ms, S_IRUGO|S_IWUSR,
 921                    cyapa_show_rt_suspend_scanrate,
 922                    cyapa_update_rt_suspend_scanrate);
 923
 924 static struct attribute *cyapa_power_runtime_entries[] = {
 925         &dev_attr_runtime_suspend_scanrate_ms.attr,
 926         NULL,
 927 };
 928
 929 static const struct attribute_group cyapa_power_runtime_group = {
 930         .name = power_group_name,
 931         .attrs = cyapa_power_runtime_entries,
 932 };
 933
 934 static void cyapa_remove_power_runtime_group(void *data)
 935 {
 936         struct cyapa *cyapa = data;
 937
 938         sysfs_unmerge_group(&cyapa->client->dev.kobj,
 939                                 &cyapa_power_runtime_group);
 940 }
 941
 942 static int cyapa_start_runtime(struct cyapa *cyapa)
 943 {
 944         struct device *dev = &cyapa->client->dev;
 945         int error;
 946
 947         cyapa->runtime_suspend_power_mode = PWR_MODE_IDLE;
 948         cyapa->runtime_suspend_sleep_time =
 949                 cyapa_pwr_cmd_to_sleep_time(cyapa->runtime_suspend_power_mode);
 950
 951         error = sysfs_merge_group(&dev->kobj, &cyapa_power_runtime_group);
 952         if (error) {
 953                 dev_err(dev,
 954                         "failed to create power runtime group: %d\n", error);
 955                 return error;
 956         }
 957
 958         error = devm_add_action(dev, cyapa_remove_power_runtime_group, cyapa);
 959         if (error) {
 960                 cyapa_remove_power_runtime_group(cyapa);
 961                 dev_err(dev,
 962                         "failed to add power runtime cleanup action: %d\n",
 963                         error);
 964                 return error;
 965         }
 966
 967         /* runtime is enabled until device is operational and opened. */
 968         pm_runtime_set_suspended(dev);
 969         pm_runtime_use_autosuspend(dev);
 970         pm_runtime_set_autosuspend_delay(dev, AUTOSUSPEND_DELAY);
 971
 972         return 0;
 973 }
 974 #else
 975 static inline int cyapa_start_runtime(struct cyapa *cyapa)
 976 {
 977         return 0;
 978 }
 979 #endif /* CONFIG_PM */
 980
 981 static ssize_t cyapa_show_fm_ver(struct device *dev,
 982                                  struct device_attribute *attr, char *buf)
 983 {
 984         int error;
 985         struct cyapa *cyapa = dev_get_drvdata(dev);
 986
 987         error = mutex_lock_interruptible(&cyapa->state_sync_lock);
 988         if (error)
 989                 return error;
 990         error = scnprintf(buf, PAGE_SIZE, "%d.%d\n", cyapa->fw_maj_ver,
 991                          cyapa->fw_min_ver);
 992         mutex_unlock(&cyapa->state_sync_lock);
 993         return error;
 994 }
 995
 996 static ssize_t cyapa_show_product_id(struct device *dev,
 997                                      struct device_attribute *attr, char *buf)
 998 {
 999         struct cyapa *cyapa = dev_get_drvdata(dev);
1000         int size;
1001         int error;
1002
1003         error = mutex_lock_interruptible(&cyapa->state_sync_lock);
1004         if (error)
1005                 return error;
1006         size = scnprintf(buf, PAGE_SIZE, "%s\n", cyapa->product_id);
1007         mutex_unlock(&cyapa->state_sync_lock);
1008         return size;
1009 }
1010
1011 static int cyapa_firmware(struct cyapa *cyapa, const char *fw_name)
1012 {
1013         struct device *dev = &cyapa->client->dev;
1014         const struct firmware *fw;
1015         int error;
1016
1017         error = request_firmware(&fw, fw_name, dev);
1018         if (error) {
1019                 dev_err(dev, "Could not load firmware from %s: %d\n",
1020                         fw_name, error);
1021                 return error;
1022         }
1023
1024         error = cyapa->ops->check_fw(cyapa, fw);
1025         if (error) {
1026                 dev_err(dev, "Invalid CYAPA firmware image: %s\n",
1027                                 fw_name);
1028                 goto done;
1029         }
1030
1031         /*
1032          * Resume the potentially suspended device because doing FW
1033          * update on a device not in the FULL mode has a chance to
1034          * fail.
1035          */
1036         pm_runtime_get_sync(dev);
1037
1038         /* Require IRQ support for firmware update commands. */
1039         cyapa_enable_irq_for_cmd(cyapa);
1040
1041         error = cyapa->ops->bl_enter(cyapa);
1042         if (error) {
1043                 dev_err(dev, "bl_enter failed, %d\n", error);
1044                 goto err_detect;
1045         }
1046
1047         error = cyapa->ops->bl_activate(cyapa);
1048         if (error) {
1049                 dev_err(dev, "bl_activate failed, %d\n", error);
1050                 goto err_detect;
1051         }
1052
1053         error = cyapa->ops->bl_initiate(cyapa, fw);
1054         if (error) {
1055                 dev_err(dev, "bl_initiate failed, %d\n", error);
1056                 goto err_detect;
1057         }
1058
1059         error = cyapa->ops->update_fw(cyapa, fw);
1060         if (error) {
1061                 dev_err(dev, "update_fw failed, %d\n", error);
1062                 goto err_detect;
1063         }
1064
1065 err_detect:
1066         cyapa_disable_irq_for_cmd(cyapa);
1067         pm_runtime_put_noidle(dev);
1068
1069 done:
1070         release_firmware(fw);
1071         return error;
1072 }
1073
1074 static ssize_t cyapa_update_fw_store(struct device *dev,
1075                                      struct device_attribute *attr,
1076                                      const char *buf, size_t count)
1077 {
1078         struct cyapa *cyapa = dev_get_drvdata(dev);
1079         char fw_name[NAME_MAX];
1080         int ret, error;
1081
1082         if (count >= NAME_MAX) {
1083                 dev_err(dev, "File name too long\n");
1084                 return -EINVAL;
1085         }
1086
1087         memcpy(fw_name, buf, count);
1088         if (fw_name[count - 1] == '\n')
1089                 fw_name[count - 1] = '\0';
1090         else
1091                 fw_name[count] = '\0';
1092
1093         if (cyapa->input) {
1094                 /*
1095                  * Force the input device to be registered after the firmware
1096                  * image is updated, so if the corresponding parameters updated
1097                  * in the new firmware image can taken effect immediately.
1098                  */
1099                 input_unregister_device(cyapa->input);
1100                 cyapa->input = NULL;
1101         }
1102
1103         error = mutex_lock_interruptible(&cyapa->state_sync_lock);
1104         if (error) {
1105                 /*
1106                  * Whatever, do reinitialize to try to recover TP state to
1107                  * previous state just as it entered fw update entrance.
1108                  */
1109                 cyapa_reinitialize(cyapa);
1110                 return error;
1111         }
1112
1113         error = cyapa_firmware(cyapa, fw_name);
1114         if (error)
1115                 dev_err(dev, "firmware update failed: %d\n", error);
1116         else
1117                 dev_dbg(dev, "firmware update successfully done.\n");
1118
1119         /*
1120          * Re-detect trackpad device states because firmware update process
1121          * will reset trackpad device into bootloader mode.
1122          */
1123         ret = cyapa_reinitialize(cyapa);
1124         if (ret) {
1125                 dev_err(dev, "failed to re-detect after updated: %d\n", ret);
1126                 error = error ? error : ret;
1127         }
1128
1129         mutex_unlock(&cyapa->state_sync_lock);
1130
1131         return error ? error : count;
1132 }
1133
1134 static ssize_t cyapa_calibrate_store(struct device *dev,
1135                                      struct device_attribute *attr,
1136                                      const char *buf, size_t count)
1137 {
1138         struct cyapa *cyapa = dev_get_drvdata(dev);
1139         int error;
1140
1141         error = mutex_lock_interruptible(&cyapa->state_sync_lock);
1142         if (error)
1143                 return error;
1144
1145         if (cyapa->operational) {
1146                 cyapa_enable_irq_for_cmd(cyapa);
1147                 error = cyapa->ops->calibrate_store(dev, attr, buf, count);
1148                 cyapa_disable_irq_for_cmd(cyapa);
1149         } else {
1150                 error = -EBUSY;  /* Still running in bootloader mode. */
1151         }
1152
1153         mutex_unlock(&cyapa->state_sync_lock);
1154         return error < 0 ? error : count;
1155 }
1156
1157 static ssize_t cyapa_show_baseline(struct device *dev,
1158                                    struct device_attribute *attr, char *buf)
1159 {
1160         struct cyapa *cyapa = dev_get_drvdata(dev);
1161         ssize_t error;
1162
1163         error = mutex_lock_interruptible(&cyapa->state_sync_lock);
1164         if (error)
1165                 return error;
1166
1167         if (cyapa->operational) {
1168                 cyapa_enable_irq_for_cmd(cyapa);
1169                 error = cyapa->ops->show_baseline(dev, attr, buf);
1170                 cyapa_disable_irq_for_cmd(cyapa);
1171         } else {
1172                 error = -EBUSY;  /* Still running in bootloader mode. */
1173         }
1174
1175         mutex_unlock(&cyapa->state_sync_lock);
1176         return error;
1177 }
1178
1179 static char *cyapa_state_to_string(struct cyapa *cyapa)
1180 {
1181         switch (cyapa->state) {
1182         case CYAPA_STATE_BL_BUSY:
1183                 return "bootloader busy";
1184         case CYAPA_STATE_BL_IDLE:
1185                 return "bootloader idle";
1186         case CYAPA_STATE_BL_ACTIVE:
1187                 return "bootloader active";
1188         case CYAPA_STATE_GEN5_BL:
1189         case CYAPA_STATE_GEN6_BL:
1190                 return "bootloader";
1191         case CYAPA_STATE_OP:
1192         case CYAPA_STATE_GEN5_APP:
1193         case CYAPA_STATE_GEN6_APP:
1194                 return "operational";  /* Normal valid state. */
1195         default:
1196                 return "invalid mode";
1197         }
1198 }
1199
1200 static ssize_t cyapa_show_mode(struct device *dev,
1201                                    struct device_attribute *attr, char *buf)
1202 {
1203         struct cyapa *cyapa = dev_get_drvdata(dev);
1204         int size;
1205         int error;
1206
1207         error = mutex_lock_interruptible(&cyapa->state_sync_lock);
1208         if (error)
1209                 return error;
1210
1211         size = scnprintf(buf, PAGE_SIZE, "gen%d %s\n",
1212                         cyapa->gen, cyapa_state_to_string(cyapa));
1213
1214         mutex_unlock(&cyapa->state_sync_lock);
1215         return size;
1216 }
1217
1218 static DEVICE_ATTR(firmware_version, S_IRUGO, cyapa_show_fm_ver, NULL);
1219 static DEVICE_ATTR(product_id, S_IRUGO, cyapa_show_product_id, NULL);
1220 static DEVICE_ATTR(update_fw, S_IWUSR, NULL, cyapa_update_fw_store);
1221 static DEVICE_ATTR(baseline, S_IRUGO, cyapa_show_baseline, NULL);
1222 static DEVICE_ATTR(calibrate, S_IWUSR, NULL, cyapa_calibrate_store);
1223 static DEVICE_ATTR(mode, S_IRUGO, cyapa_show_mode, NULL);
1224
1225 static struct attribute *cyapa_sysfs_entries[] = {
1226         &dev_attr_firmware_version.attr,
1227         &dev_attr_product_id.attr,
1228         &dev_attr_update_fw.attr,
1229         &dev_attr_baseline.attr,
1230         &dev_attr_calibrate.attr,
1231         &dev_attr_mode.attr,
1232         NULL,
1233 };
1234
1235 static const struct attribute_group cyapa_sysfs_group = {
1236         .attrs = cyapa_sysfs_entries,
1237 };
1238
1239 static void cyapa_remove_sysfs_group(void *data)
1240 {
1241         struct cyapa *cyapa = data;
1242
1243         sysfs_remove_group(&cyapa->client->dev.kobj, &cyapa_sysfs_group);
1244 }
1245
1246 static void cyapa_disable_regulator(void *data)
1247 {
1248         struct cyapa *cyapa = data;
1249
1250         regulator_disable(cyapa->vcc);
1251 }
1252
1253 static int cyapa_probe(struct i2c_client *client,
1254                        const struct i2c_device_id *dev_id)
1255 {
1256         struct device *dev = &client->dev;
1257         struct cyapa *cyapa;
1258         u8 adapter_func;
1259         union i2c_smbus_data dummy;
1260         int error;
1261
1262         adapter_func = cyapa_check_adapter_functionality(client);
1263         if (adapter_func == CYAPA_ADAPTER_FUNC_NONE) {
1264                 dev_err(dev, "not a supported I2C/SMBus adapter\n");
1265                 return -EIO;
1266         }
1267
1268         /* Make sure there is something at this address */
1269         if (i2c_smbus_xfer(client->adapter, client->addr, 0,
1270                         I2C_SMBUS_READ, 0, I2C_SMBUS_BYTE, &dummy) < 0)
1271                 return -ENODEV;
1272
1273         cyapa = devm_kzalloc(dev, sizeof(struct cyapa), GFP_KERNEL);
1274         if (!cyapa)
1275                 return -ENOMEM;
1276
1277         /* i2c isn't supported, use smbus */
1278         if (adapter_func == CYAPA_ADAPTER_FUNC_SMBUS)
1279                 cyapa->smbus = true;
1280
1281         cyapa->client = client;
1282         i2c_set_clientdata(client, cyapa);
1283         sprintf(cyapa->phys, "i2c-%d-%04x/input0", client->adapter->nr,
1284                 client->addr);
1285
1286         cyapa->vcc = devm_regulator_get(dev, "vcc");
1287         if (IS_ERR(cyapa->vcc)) {
1288                 error = PTR_ERR(cyapa->vcc);
1289                 dev_err(dev, "failed to get vcc regulator: %d\n", error);
1290                 return error;
1291         }
1292
1293         error = regulator_enable(cyapa->vcc);
1294         if (error) {
1295                 dev_err(dev, "failed to enable regulator: %d\n", error);
1296                 return error;
1297         }
1298
1299         error = devm_add_action(dev, cyapa_disable_regulator, cyapa);
1300         if (error) {
1301                 cyapa_disable_regulator(cyapa);
1302                 dev_err(dev, "failed to add disable regulator action: %d\n",
1303                         error);
1304                 return error;
1305         }
1306
1307         error = cyapa_initialize(cyapa);
1308         if (error) {
1309                 dev_err(dev, "failed to detect and initialize tp device.\n");
1310                 return error;
1311         }
1312
1313         error = sysfs_create_group(&client->dev.kobj, &cyapa_sysfs_group);
1314         if (error) {
1315                 dev_err(dev, "failed to create sysfs entries: %d\n", error);
1316                 return error;
1317         }
1318
1319         error = devm_add_action(dev, cyapa_remove_sysfs_group, cyapa);
1320         if (error) {
1321                 cyapa_remove_sysfs_group(cyapa);
1322                 dev_err(dev, "failed to add sysfs cleanup action: %d\n", error);
1323                 return error;
1324         }
1325
1326         error = cyapa_prepare_wakeup_controls(cyapa);
1327         if (error) {
1328                 dev_err(dev, "failed to prepare wakeup controls: %d\n", error);
1329                 return error;
1330         }
1331
1332         error = cyapa_start_runtime(cyapa);
1333         if (error) {
1334                 dev_err(dev, "failed to start pm_runtime: %d\n", error);
1335                 return error;
1336         }
1337
1338         error = devm_request_threaded_irq(dev, client->irq,
1339                                           NULL, cyapa_irq,
1340                                           IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
1341                                           "cyapa", cyapa);
1342         if (error) {
1343                 dev_err(dev, "failed to request threaded irq: %d\n", error);
1344                 return error;
1345         }
1346
1347         /* Disable IRQ until the device is opened */
1348         disable_irq(client->irq);
1349
1350         /*
1351          * Register the device in the input subsystem when it's operational.
1352          * Otherwise, keep in this driver, so it can be be recovered or updated
1353          * through the sysfs mode and update_fw interfaces by user or apps.
1354          */
1355         if (cyapa->operational) {
1356                 error = cyapa_create_input_dev(cyapa);
1357                 if (error) {
1358                         dev_err(dev, "create input_dev instance failed: %d\n",
1359                                         error);
1360                         return error;
1361                 }
1362         }
1363
1364         return 0;
1365 }
1366
1367 static int __maybe_unused cyapa_suspend(struct device *dev)
1368 {
1369         struct i2c_client *client = to_i2c_client(dev);
1370         struct cyapa *cyapa = i2c_get_clientdata(client);
1371         u8 power_mode;
1372         int error;
1373
1374         error = mutex_lock_interruptible(&cyapa->state_sync_lock);
1375         if (error)
1376                 return error;
1377
1378         /*
1379          * Runtime PM is enable only when device is in operational mode and
1380          * users in use, so need check it before disable it to
1381          * avoid unbalance warning.
1382          */
1383         if (pm_runtime_enabled(dev))
1384                 pm_runtime_disable(dev);
1385         disable_irq(client->irq);
1386
1387         /*
1388          * Set trackpad device to idle mode if wakeup is allowed,
1389          * otherwise turn off.
1390          */
1391         if (cyapa->operational) {
1392                 power_mode = device_may_wakeup(dev) ? cyapa->suspend_power_mode
1393                                                     : PWR_MODE_OFF;
1394                 error = cyapa->ops->set_power_mode(cyapa, power_mode,
1395                                 cyapa->suspend_sleep_time, true);
1396                 if (error)
1397                         dev_err(dev, "suspend set power mode failed: %d\n",
1398                                         error);
1399         }
1400
1401         /*
1402          * Disable proximity interrupt when system idle, want true touch to
1403          * wake the system.
1404          */
1405         if (cyapa->dev_pwr_mode != PWR_MODE_OFF)
1406                 cyapa->ops->set_proximity(cyapa, false);
1407
1408         if (device_may_wakeup(dev))
1409                 cyapa->irq_wake = (enable_irq_wake(client->irq) == 0);
1410
1411         mutex_unlock(&cyapa->state_sync_lock);
1412         return 0;
1413 }
1414
1415 static int __maybe_unused cyapa_resume(struct device *dev)
1416 {
1417         struct i2c_client *client = to_i2c_client(dev);
1418         struct cyapa *cyapa = i2c_get_clientdata(client);
1419         int error;
1420
1421         mutex_lock(&cyapa->state_sync_lock);
1422
1423         if (device_may_wakeup(dev) && cyapa->irq_wake) {
1424                 disable_irq_wake(client->irq);
1425                 cyapa->irq_wake = false;
1426         }
1427
1428         /*
1429          * Update device states and runtime PM states.
1430          * Re-Enable proximity interrupt after enter operational mode.
1431          */
1432         error = cyapa_reinitialize(cyapa);
1433         if (error)
1434                 dev_warn(dev, "failed to reinitialize TP device: %d\n", error);
1435
1436         enable_irq(client->irq);
1437
1438         mutex_unlock(&cyapa->state_sync_lock);
1439         return 0;
1440 }
1441
1442 static int __maybe_unused cyapa_runtime_suspend(struct device *dev)
1443 {
1444         struct cyapa *cyapa = dev_get_drvdata(dev);
1445         int error;
1446
1447         error = cyapa->ops->set_power_mode(cyapa,
1448                         cyapa->runtime_suspend_power_mode,
1449                         cyapa->runtime_suspend_sleep_time,
1450                         false);
1451         if (error)
1452                 dev_warn(dev, "runtime suspend failed: %d\n", error);
1453
1454         return 0;
1455 }
1456
1457 static int __maybe_unused cyapa_runtime_resume(struct device *dev)
1458 {
1459         struct cyapa *cyapa = dev_get_drvdata(dev);
1460         int error;
1461
1462         error = cyapa->ops->set_power_mode(cyapa,
1463                                            PWR_MODE_FULL_ACTIVE, 0, false);
1464         if (error)
1465                 dev_warn(dev, "runtime resume failed: %d\n", error);
1466
1467         return 0;
1468 }
1469
1470 static const struct dev_pm_ops cyapa_pm_ops = {
1471         SET_SYSTEM_SLEEP_PM_OPS(cyapa_suspend, cyapa_resume)
1472         SET_RUNTIME_PM_OPS(cyapa_runtime_suspend, cyapa_runtime_resume, NULL)
1473 };
1474
1475 static const struct i2c_device_id cyapa_id_table[] = {
1476         { "cyapa", 0 },
1477         { },
1478 };
1479 MODULE_DEVICE_TABLE(i2c, cyapa_id_table);
1480
1481 #ifdef CONFIG_ACPI
1482 static const struct acpi_device_id cyapa_acpi_id[] = {
1483         { "CYAP0000", 0 },  /* Gen3 trackpad with 0x67 I2C address. */
1484         { "CYAP0001", 0 },  /* Gen5 trackpad with 0x24 I2C address. */
1485         { "CYAP0002", 0 },  /* Gen6 trackpad with 0x24 I2C address. */
1486         { }
1487 };
1488 MODULE_DEVICE_TABLE(acpi, cyapa_acpi_id);
1489 #endif
1490
1491 #ifdef CONFIG_OF
1492 static const struct of_device_id cyapa_of_match[] = {
1493         { .compatible = "cypress,cyapa" },
1494         { /* sentinel */ }
1495 };
1496 MODULE_DEVICE_TABLE(of, cyapa_of_match);
1497 #endif
1498
1499 static struct i2c_driver cyapa_driver = {
1500         .driver = {
1501                 .name = "cyapa",
1502                 .pm = &cyapa_pm_ops,
1503                 .acpi_match_table = ACPI_PTR(cyapa_acpi_id),
1504                 .of_match_table = of_match_ptr(cyapa_of_match),
1505         },
1506
1507         .probe = cyapa_probe,
1508         .id_table = cyapa_id_table,
1509 };
1510
1511 module_i2c_driver(cyapa_driver);
1512
1513 MODULE_DESCRIPTION("Cypress APA I2C Trackpad Driver");
1514 MODULE_AUTHOR("Dudley Du <dudl@cypress.com>");
1515 MODULE_LICENSE("GPL");