1 // SPDX-License-Identifier: GPL-2.0 2 // Melfas MMS114/MMS136/MMS152 touchscreen device driver 3 // 4 // Copyright (c) 2012 Samsung Electronics Co., Ltd. 5 // Author: Joonyoung Shim <jy0922.shim@samsung.com> 6 7 #include <linux/module.h> 8 #include <linux/delay.h> 9 #include <linux/of.h> 10 #include <linux/i2c.h> 11 #include <linux/input/mt.h> 12 #include <linux/input/touchscreen.h> 13 #include <linux/interrupt.h> 14 #include <linux/regulator/consumer.h> 15 #include <linux/slab.h> 16 17 /* Write only registers */ 18 #define MMS114_MODE_CONTROL 0x01 19 #define MMS114_OPERATION_MODE_MASK 0xE 20 #define MMS114_ACTIVE BIT(1) 21 22 #define MMS114_XY_RESOLUTION_H 0x02 23 #define MMS114_X_RESOLUTION 0x03 24 #define MMS114_Y_RESOLUTION 0x04 25 #define MMS114_CONTACT_THRESHOLD 0x05 26 #define MMS114_MOVING_THRESHOLD 0x06 27 28 /* Read only registers */ 29 #define MMS114_PACKET_SIZE 0x0F 30 #define MMS114_INFORMATION 0x10 31 #define MMS114_TSP_REV 0xF0 32 33 #define MMS152_FW_REV 0xE1 34 #define MMS152_COMPAT_GROUP 0xF2 35 36 /* Minimum delay time is 50us between stop and start signal of i2c */ 37 #define MMS114_I2C_DELAY 50 38 39 /* 200ms needs after power on */ 40 #define MMS114_POWERON_DELAY 200 41 42 /* Touchscreen absolute values */ 43 #define MMS114_MAX_AREA 0xff 44 45 #define MMS114_MAX_TOUCHKEYS 15 46 #define MMS114_MAX_TOUCH 10 47 #define MMS114_EVENT_SIZE 8 48 #define MMS136_EVENT_SIZE 6 49 50 /* Touch type */ 51 #define MMS114_TYPE_NONE 0 52 #define MMS114_TYPE_TOUCHSCREEN 1 53 #define MMS114_TYPE_TOUCHKEY 2 54 55 enum mms_type { 56 TYPE_MMS114 = 114, 57 TYPE_MMS134S = 134, 58 TYPE_MMS136 = 136, 59 TYPE_MMS152 = 152, 60 TYPE_MMS345L = 345, 61 }; 62 63 struct mms114_data { 64 struct i2c_client *client; 65 struct input_dev *input_dev; 66 struct regulator *core_reg; 67 struct regulator *io_reg; 68 struct touchscreen_properties props; 69 enum mms_type type; 70 unsigned int contact_threshold; 71 unsigned int moving_threshold; 72 73 u32 keycodes[MMS114_MAX_TOUCHKEYS]; 74 int num_keycodes; 75 76 /* Use cache data for mode control register(write only) */ 77 u8 cache_mode_control; 78 }; 79 80 struct mms114_touch { 81 u8 id:4, reserved_bit4:1, type:2, pressed:1; 82 u8 x_hi:4, y_hi:4; 83 u8 x_lo; 84 u8 y_lo; 85 u8 width; 86 u8 strength; 87 u8 reserved[2]; 88 } __packed; 89 90 static int __mms114_read_reg(struct mms114_data *data, unsigned int reg, 91 unsigned int len, u8 *val) 92 { 93 struct i2c_client *client = data->client; 94 struct i2c_msg xfer[2]; 95 u8 buf = reg & 0xff; 96 int error; 97 98 if (reg <= MMS114_MODE_CONTROL && reg + len > MMS114_MODE_CONTROL) 99 BUG(); 100 101 /* Write register */ 102 xfer[0].addr = client->addr; 103 xfer[0].flags = client->flags & I2C_M_TEN; 104 xfer[0].len = 1; 105 xfer[0].buf = &buf; 106 107 /* Read data */ 108 xfer[1].addr = client->addr; 109 xfer[1].flags = (client->flags & I2C_M_TEN) | I2C_M_RD; 110 xfer[1].len = len; 111 xfer[1].buf = val; 112 113 error = i2c_transfer(client->adapter, xfer, 2); 114 if (error != 2) { 115 dev_err(&client->dev, 116 "%s: i2c transfer failed (%d)\n", __func__, error); 117 return error < 0 ? error : -EIO; 118 } 119 udelay(MMS114_I2C_DELAY); 120 121 return 0; 122 } 123 124 static int mms114_read_reg(struct mms114_data *data, unsigned int reg) 125 { 126 u8 val; 127 int error; 128 129 if (reg == MMS114_MODE_CONTROL) 130 return data->cache_mode_control; 131 132 error = __mms114_read_reg(data, reg, 1, &val); 133 return error < 0 ? error : val; 134 } 135 136 static int mms114_write_reg(struct mms114_data *data, unsigned int reg, 137 unsigned int val) 138 { 139 struct i2c_client *client = data->client; 140 u8 buf[2]; 141 int error; 142 143 buf[0] = reg & 0xff; 144 buf[1] = val & 0xff; 145 146 error = i2c_master_send(client, buf, 2); 147 if (error != 2) { 148 dev_err(&client->dev, 149 "%s: i2c send failed (%d)\n", __func__, error); 150 return error < 0 ? error : -EIO; 151 } 152 udelay(MMS114_I2C_DELAY); 153 154 if (reg == MMS114_MODE_CONTROL) 155 data->cache_mode_control = val; 156 157 return 0; 158 } 159 160 static void mms114_process_mt(struct mms114_data *data, struct mms114_touch *touch) 161 { 162 struct i2c_client *client = data->client; 163 struct input_dev *input_dev = data->input_dev; 164 unsigned int id; 165 unsigned int x; 166 unsigned int y; 167 168 if (touch->id > MMS114_MAX_TOUCH) { 169 dev_err(&client->dev, "Wrong touch id (%d)\n", touch->id); 170 return; 171 } 172 173 id = touch->id - 1; 174 x = touch->x_lo | touch->x_hi << 8; 175 y = touch->y_lo | touch->y_hi << 8; 176 177 dev_dbg(&client->dev, 178 "id: %d, type: %d, pressed: %d, x: %d, y: %d, width: %d, strength: %d\n", 179 id, touch->type, touch->pressed, 180 x, y, touch->width, touch->strength); 181 182 input_mt_slot(input_dev, id); 183 input_mt_report_slot_state(input_dev, MT_TOOL_FINGER, touch->pressed); 184 185 if (touch->pressed) { 186 touchscreen_report_pos(input_dev, &data->props, x, y, true); 187 input_report_abs(input_dev, ABS_MT_TOUCH_MAJOR, touch->width); 188 input_report_abs(input_dev, ABS_MT_PRESSURE, touch->strength); 189 } 190 } 191 192 static void mms114_process_touchkey(struct mms114_data *data, 193 struct mms114_touch *touch) 194 { 195 struct i2c_client *client = data->client; 196 struct input_dev *input_dev = data->input_dev; 197 unsigned int keycode_id; 198 199 if (touch->id == 0) 200 return; 201 202 if (touch->id > data->num_keycodes) { 203 dev_err(&client->dev, "Wrong touch id for touchkey (%d)\n", 204 touch->id); 205 return; 206 } 207 208 keycode_id = touch->id - 1; 209 dev_dbg(&client->dev, "keycode id: %d, pressed: %d\n", keycode_id, 210 touch->pressed); 211 212 input_report_key(input_dev, data->keycodes[keycode_id], touch->pressed); 213 } 214 215 static irqreturn_t mms114_interrupt(int irq, void *dev_id) 216 { 217 struct mms114_data *data = dev_id; 218 struct i2c_client *client = data->client; 219 struct mms114_touch touch[MMS114_MAX_TOUCH]; 220 int packet_size; 221 int touch_size; 222 int index; 223 int error; 224 225 packet_size = mms114_read_reg(data, MMS114_PACKET_SIZE); 226 if (packet_size <= 0) 227 goto out; 228 229 /* MMS136 has slightly different event size */ 230 if (data->type == TYPE_MMS134S || data->type == TYPE_MMS136) 231 touch_size = packet_size / MMS136_EVENT_SIZE; 232 else 233 touch_size = packet_size / MMS114_EVENT_SIZE; 234 235 error = __mms114_read_reg(data, MMS114_INFORMATION, packet_size, 236 (u8 *)touch); 237 if (error < 0) 238 goto out; 239 240 for (index = 0; index < touch_size; index++) { 241 switch (touch[index].type) { 242 case MMS114_TYPE_TOUCHSCREEN: 243 mms114_process_mt(data, touch + index); 244 break; 245 246 case MMS114_TYPE_TOUCHKEY: 247 mms114_process_touchkey(data, touch + index); 248 break; 249 250 default: 251 dev_err(&client->dev, "Wrong touch type (%d)\n", 252 touch[index].type); 253 break; 254 } 255 } 256 257 input_mt_report_pointer_emulation(data->input_dev, true); 258 input_sync(data->input_dev); 259 260 out: 261 return IRQ_HANDLED; 262 } 263 264 static int mms114_set_active(struct mms114_data *data, bool active) 265 { 266 int val; 267 268 val = mms114_read_reg(data, MMS114_MODE_CONTROL); 269 if (val < 0) 270 return val; 271 272 val &= ~MMS114_OPERATION_MODE_MASK; 273 274 /* If active is false, sleep mode */ 275 if (active) 276 val |= MMS114_ACTIVE; 277 278 return mms114_write_reg(data, MMS114_MODE_CONTROL, val); 279 } 280 281 static int mms114_get_version(struct mms114_data *data) 282 { 283 struct device *dev = &data->client->dev; 284 u8 buf[6]; 285 int group; 286 int error; 287 288 switch (data->type) { 289 case TYPE_MMS345L: 290 error = __mms114_read_reg(data, MMS152_FW_REV, 3, buf); 291 if (error) 292 return error; 293 294 dev_info(dev, "TSP FW Rev: bootloader 0x%x / core 0x%x / config 0x%x\n", 295 buf[0], buf[1], buf[2]); 296 break; 297 298 case TYPE_MMS152: 299 error = __mms114_read_reg(data, MMS152_FW_REV, 3, buf); 300 if (error) 301 return error; 302 303 group = i2c_smbus_read_byte_data(data->client, 304 MMS152_COMPAT_GROUP); 305 if (group < 0) 306 return group; 307 308 dev_info(dev, "TSP FW Rev: bootloader 0x%x / core 0x%x / config 0x%x, Compat group: %c\n", 309 buf[0], buf[1], buf[2], group); 310 break; 311 312 case TYPE_MMS114: 313 case TYPE_MMS134S: 314 case TYPE_MMS136: 315 error = __mms114_read_reg(data, MMS114_TSP_REV, 6, buf); 316 if (error) 317 return error; 318 319 dev_info(dev, "TSP Rev: 0x%x, HW Rev: 0x%x, Firmware Ver: 0x%x\n", 320 buf[0], buf[1], buf[3]); 321 break; 322 } 323 324 return 0; 325 } 326 327 static int mms114_setup_regs(struct mms114_data *data) 328 { 329 const struct touchscreen_properties *props = &data->props; 330 int val; 331 int error; 332 333 error = mms114_get_version(data); 334 if (error < 0) 335 return error; 336 337 /* MMS114, MMS134S and MMS136 have configuration and power on registers */ 338 if (data->type != TYPE_MMS114 && data->type != TYPE_MMS134S && 339 data->type != TYPE_MMS136) 340 return 0; 341 342 error = mms114_set_active(data, true); 343 if (error < 0) 344 return error; 345 346 val = (props->max_x >> 8) & 0xf; 347 val |= ((props->max_y >> 8) & 0xf) << 4; 348 error = mms114_write_reg(data, MMS114_XY_RESOLUTION_H, val); 349 if (error < 0) 350 return error; 351 352 val = props->max_x & 0xff; 353 error = mms114_write_reg(data, MMS114_X_RESOLUTION, val); 354 if (error < 0) 355 return error; 356 357 val = props->max_x & 0xff; 358 error = mms114_write_reg(data, MMS114_Y_RESOLUTION, val); 359 if (error < 0) 360 return error; 361 362 if (data->contact_threshold) { 363 error = mms114_write_reg(data, MMS114_CONTACT_THRESHOLD, 364 data->contact_threshold); 365 if (error < 0) 366 return error; 367 } 368 369 if (data->moving_threshold) { 370 error = mms114_write_reg(data, MMS114_MOVING_THRESHOLD, 371 data->moving_threshold); 372 if (error < 0) 373 return error; 374 } 375 376 return 0; 377 } 378 379 static int mms114_start(struct mms114_data *data) 380 { 381 struct i2c_client *client = data->client; 382 int error; 383 384 error = regulator_enable(data->core_reg); 385 if (error) { 386 dev_err(&client->dev, "Failed to enable avdd: %d\n", error); 387 return error; 388 } 389 390 error = regulator_enable(data->io_reg); 391 if (error) { 392 dev_err(&client->dev, "Failed to enable vdd: %d\n", error); 393 regulator_disable(data->core_reg); 394 return error; 395 } 396 397 msleep(MMS114_POWERON_DELAY); 398 399 error = mms114_setup_regs(data); 400 if (error < 0) { 401 regulator_disable(data->io_reg); 402 regulator_disable(data->core_reg); 403 return error; 404 } 405 406 enable_irq(client->irq); 407 408 return 0; 409 } 410 411 static void mms114_stop(struct mms114_data *data) 412 { 413 struct i2c_client *client = data->client; 414 int error; 415 416 disable_irq(client->irq); 417 418 error = regulator_disable(data->io_reg); 419 if (error) 420 dev_warn(&client->dev, "Failed to disable vdd: %d\n", error); 421 422 error = regulator_disable(data->core_reg); 423 if (error) 424 dev_warn(&client->dev, "Failed to disable avdd: %d\n", error); 425 } 426 427 static int mms114_input_open(struct input_dev *dev) 428 { 429 struct mms114_data *data = input_get_drvdata(dev); 430 431 return mms114_start(data); 432 } 433 434 static void mms114_input_close(struct input_dev *dev) 435 { 436 struct mms114_data *data = input_get_drvdata(dev); 437 438 mms114_stop(data); 439 } 440 441 static int mms114_parse_legacy_bindings(struct mms114_data *data) 442 { 443 struct device *dev = &data->client->dev; 444 struct touchscreen_properties *props = &data->props; 445 446 if (device_property_read_u32(dev, "x-size", &props->max_x)) { 447 dev_dbg(dev, "failed to get legacy x-size property\n"); 448 return -EINVAL; 449 } 450 451 if (device_property_read_u32(dev, "y-size", &props->max_y)) { 452 dev_dbg(dev, "failed to get legacy y-size property\n"); 453 return -EINVAL; 454 } 455 456 device_property_read_u32(dev, "contact-threshold", 457 &data->contact_threshold); 458 device_property_read_u32(dev, "moving-threshold", 459 &data->moving_threshold); 460 461 if (device_property_read_bool(dev, "x-invert")) 462 props->invert_x = true; 463 if (device_property_read_bool(dev, "y-invert")) 464 props->invert_y = true; 465 466 props->swap_x_y = false; 467 468 return 0; 469 } 470 471 static int mms114_probe(struct i2c_client *client) 472 { 473 struct mms114_data *data; 474 struct input_dev *input_dev; 475 const void *match_data; 476 int error; 477 int i; 478 479 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) { 480 dev_err(&client->dev, "Not supported I2C adapter\n"); 481 return -ENODEV; 482 } 483 484 data = devm_kzalloc(&client->dev, sizeof(struct mms114_data), 485 GFP_KERNEL); 486 input_dev = devm_input_allocate_device(&client->dev); 487 if (!data || !input_dev) { 488 dev_err(&client->dev, "Failed to allocate memory\n"); 489 return -ENOMEM; 490 } 491 492 data->client = client; 493 data->input_dev = input_dev; 494 495 match_data = device_get_match_data(&client->dev); 496 if (!match_data) 497 return -EINVAL; 498 499 data->type = (enum mms_type)match_data; 500 501 data->num_keycodes = device_property_count_u32(&client->dev, 502 "linux,keycodes"); 503 if (data->num_keycodes == -EINVAL) { 504 data->num_keycodes = 0; 505 } else if (data->num_keycodes < 0) { 506 dev_err(&client->dev, 507 "Unable to parse linux,keycodes property: %d\n", 508 data->num_keycodes); 509 return data->num_keycodes; 510 } else if (data->num_keycodes > MMS114_MAX_TOUCHKEYS) { 511 dev_warn(&client->dev, 512 "Found %d linux,keycodes but max is %d, ignoring the rest\n", 513 data->num_keycodes, MMS114_MAX_TOUCHKEYS); 514 data->num_keycodes = MMS114_MAX_TOUCHKEYS; 515 } 516 517 if (data->num_keycodes > 0) { 518 error = device_property_read_u32_array(&client->dev, 519 "linux,keycodes", 520 data->keycodes, 521 data->num_keycodes); 522 if (error) { 523 dev_err(&client->dev, 524 "Unable to read linux,keycodes values: %d\n", 525 error); 526 return error; 527 } 528 529 input_dev->keycode = data->keycodes; 530 input_dev->keycodemax = data->num_keycodes; 531 input_dev->keycodesize = sizeof(data->keycodes[0]); 532 for (i = 0; i < data->num_keycodes; i++) 533 input_set_capability(input_dev, 534 EV_KEY, data->keycodes[i]); 535 } 536 537 input_set_capability(input_dev, EV_ABS, ABS_MT_POSITION_X); 538 input_set_capability(input_dev, EV_ABS, ABS_MT_POSITION_Y); 539 input_set_abs_params(input_dev, ABS_MT_PRESSURE, 0, 255, 0, 0); 540 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR, 541 0, MMS114_MAX_AREA, 0, 0); 542 543 touchscreen_parse_properties(input_dev, true, &data->props); 544 if (!data->props.max_x || !data->props.max_y) { 545 dev_dbg(&client->dev, 546 "missing X/Y size properties, trying legacy bindings\n"); 547 error = mms114_parse_legacy_bindings(data); 548 if (error) 549 return error; 550 551 input_set_abs_params(input_dev, ABS_MT_POSITION_X, 552 0, data->props.max_x, 0, 0); 553 input_set_abs_params(input_dev, ABS_MT_POSITION_Y, 554 0, data->props.max_y, 0, 0); 555 } 556 557 if (data->type == TYPE_MMS114 || data->type == TYPE_MMS134S || 558 data->type == TYPE_MMS136) { 559 /* 560 * The firmware handles movement and pressure fuzz, so 561 * don't duplicate that in software. 562 */ 563 data->moving_threshold = input_abs_get_fuzz(input_dev, 564 ABS_MT_POSITION_X); 565 data->contact_threshold = input_abs_get_fuzz(input_dev, 566 ABS_MT_PRESSURE); 567 input_abs_set_fuzz(input_dev, ABS_MT_POSITION_X, 0); 568 input_abs_set_fuzz(input_dev, ABS_MT_POSITION_Y, 0); 569 input_abs_set_fuzz(input_dev, ABS_MT_PRESSURE, 0); 570 } 571 572 input_dev->name = devm_kasprintf(&client->dev, GFP_KERNEL, 573 "MELFAS MMS%d Touchscreen", 574 data->type); 575 if (!input_dev->name) 576 return -ENOMEM; 577 578 input_dev->id.bustype = BUS_I2C; 579 input_dev->dev.parent = &client->dev; 580 input_dev->open = mms114_input_open; 581 input_dev->close = mms114_input_close; 582 583 error = input_mt_init_slots(input_dev, MMS114_MAX_TOUCH, 584 INPUT_MT_DIRECT); 585 if (error) 586 return error; 587 588 input_set_drvdata(input_dev, data); 589 i2c_set_clientdata(client, data); 590 591 data->core_reg = devm_regulator_get(&client->dev, "avdd"); 592 if (IS_ERR(data->core_reg)) { 593 error = PTR_ERR(data->core_reg); 594 dev_err(&client->dev, 595 "Unable to get the Core regulator (%d)\n", error); 596 return error; 597 } 598 599 data->io_reg = devm_regulator_get(&client->dev, "vdd"); 600 if (IS_ERR(data->io_reg)) { 601 error = PTR_ERR(data->io_reg); 602 dev_err(&client->dev, 603 "Unable to get the IO regulator (%d)\n", error); 604 return error; 605 } 606 607 error = devm_request_threaded_irq(&client->dev, client->irq, 608 NULL, mms114_interrupt, 609 IRQF_ONESHOT | IRQF_NO_AUTOEN, 610 dev_name(&client->dev), data); 611 if (error) { 612 dev_err(&client->dev, "Failed to register interrupt\n"); 613 return error; 614 } 615 616 error = input_register_device(data->input_dev); 617 if (error) { 618 dev_err(&client->dev, "Failed to register input device\n"); 619 return error; 620 } 621 622 return 0; 623 } 624 625 static int mms114_suspend(struct device *dev) 626 { 627 struct i2c_client *client = to_i2c_client(dev); 628 struct mms114_data *data = i2c_get_clientdata(client); 629 struct input_dev *input_dev = data->input_dev; 630 int id; 631 632 /* Release all touch */ 633 for (id = 0; id < MMS114_MAX_TOUCH; id++) { 634 input_mt_slot(input_dev, id); 635 input_mt_report_slot_inactive(input_dev); 636 } 637 638 input_mt_report_pointer_emulation(input_dev, true); 639 input_sync(input_dev); 640 641 guard(mutex)(&input_dev->mutex); 642 643 if (input_device_enabled(input_dev)) 644 mms114_stop(data); 645 646 return 0; 647 } 648 649 static int mms114_resume(struct device *dev) 650 { 651 struct i2c_client *client = to_i2c_client(dev); 652 struct mms114_data *data = i2c_get_clientdata(client); 653 struct input_dev *input_dev = data->input_dev; 654 int error; 655 656 guard(mutex)(&input_dev->mutex); 657 658 if (input_device_enabled(input_dev)) { 659 error = mms114_start(data); 660 if (error) 661 return error; 662 } 663 664 return 0; 665 } 666 667 static DEFINE_SIMPLE_DEV_PM_OPS(mms114_pm_ops, mms114_suspend, mms114_resume); 668 669 static const struct i2c_device_id mms114_id[] = { 670 { "mms114" }, 671 { } 672 }; 673 MODULE_DEVICE_TABLE(i2c, mms114_id); 674 675 #ifdef CONFIG_OF 676 static const struct of_device_id mms114_dt_match[] = { 677 { 678 .compatible = "melfas,mms114", 679 .data = (void *)TYPE_MMS114, 680 }, { 681 .compatible = "melfas,mms134s", 682 .data = (void *)TYPE_MMS134S, 683 }, { 684 .compatible = "melfas,mms136", 685 .data = (void *)TYPE_MMS136, 686 }, { 687 .compatible = "melfas,mms152", 688 .data = (void *)TYPE_MMS152, 689 }, { 690 .compatible = "melfas,mms345l", 691 .data = (void *)TYPE_MMS345L, 692 }, 693 { } 694 }; 695 MODULE_DEVICE_TABLE(of, mms114_dt_match); 696 #endif 697 698 static struct i2c_driver mms114_driver = { 699 .driver = { 700 .name = "mms114", 701 .pm = pm_sleep_ptr(&mms114_pm_ops), 702 .of_match_table = of_match_ptr(mms114_dt_match), 703 }, 704 .probe = mms114_probe, 705 .id_table = mms114_id, 706 }; 707 708 module_i2c_driver(mms114_driver); 709 710 /* Module information */ 711 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>"); 712 MODULE_DESCRIPTION("MELFAS mms114 Touchscreen driver"); 713 MODULE_LICENSE("GPL v2"); 714