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 == 0 || 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 struct mms114_touch *t; 221 int packet_size; 222 int event_size; 223 int touch_size; 224 int index; 225 int error; 226 227 packet_size = mms114_read_reg(data, MMS114_PACKET_SIZE); 228 if (packet_size <= 0) 229 goto out; 230 231 if (packet_size > sizeof(touch)) { 232 dev_err(&client->dev, "Invalid packet size %d (max %zu)\n", 233 packet_size, sizeof(touch)); 234 goto out; 235 } 236 237 /* MMS136 has slightly different event size */ 238 if (data->type == TYPE_MMS134S || data->type == TYPE_MMS136) 239 event_size = MMS136_EVENT_SIZE; 240 else 241 event_size = MMS114_EVENT_SIZE; 242 243 touch_size = packet_size / event_size; 244 245 error = __mms114_read_reg(data, MMS114_INFORMATION, packet_size, 246 (u8 *)touch); 247 if (error < 0) 248 goto out; 249 250 for (index = 0; index < touch_size; index++) { 251 t = (struct mms114_touch *)((u8 *)touch + index * event_size); 252 253 switch (t->type) { 254 case MMS114_TYPE_TOUCHSCREEN: 255 mms114_process_mt(data, t); 256 break; 257 258 case MMS114_TYPE_TOUCHKEY: 259 mms114_process_touchkey(data, t); 260 break; 261 262 default: 263 dev_err(&client->dev, "Wrong touch type (%d)\n", 264 t->type); 265 break; 266 } 267 } 268 269 input_mt_report_pointer_emulation(data->input_dev, true); 270 input_sync(data->input_dev); 271 272 out: 273 return IRQ_HANDLED; 274 } 275 276 static int mms114_set_active(struct mms114_data *data, bool active) 277 { 278 int val; 279 280 val = mms114_read_reg(data, MMS114_MODE_CONTROL); 281 if (val < 0) 282 return val; 283 284 val &= ~MMS114_OPERATION_MODE_MASK; 285 286 /* If active is false, sleep mode */ 287 if (active) 288 val |= MMS114_ACTIVE; 289 290 return mms114_write_reg(data, MMS114_MODE_CONTROL, val); 291 } 292 293 static int mms114_get_version(struct mms114_data *data) 294 { 295 struct device *dev = &data->client->dev; 296 u8 buf[6]; 297 int group; 298 int error; 299 300 switch (data->type) { 301 case TYPE_MMS345L: 302 error = __mms114_read_reg(data, MMS152_FW_REV, 3, buf); 303 if (error) 304 return error; 305 306 dev_info(dev, "TSP FW Rev: bootloader 0x%x / core 0x%x / config 0x%x\n", 307 buf[0], buf[1], buf[2]); 308 break; 309 310 case TYPE_MMS152: 311 error = __mms114_read_reg(data, MMS152_FW_REV, 3, buf); 312 if (error) 313 return error; 314 315 group = i2c_smbus_read_byte_data(data->client, 316 MMS152_COMPAT_GROUP); 317 if (group < 0) 318 return group; 319 320 dev_info(dev, "TSP FW Rev: bootloader 0x%x / core 0x%x / config 0x%x, Compat group: %c\n", 321 buf[0], buf[1], buf[2], group); 322 break; 323 324 case TYPE_MMS114: 325 case TYPE_MMS134S: 326 case TYPE_MMS136: 327 error = __mms114_read_reg(data, MMS114_TSP_REV, 6, buf); 328 if (error) 329 return error; 330 331 dev_info(dev, "TSP Rev: 0x%x, HW Rev: 0x%x, Firmware Ver: 0x%x\n", 332 buf[0], buf[1], buf[3]); 333 break; 334 } 335 336 return 0; 337 } 338 339 static int mms114_setup_regs(struct mms114_data *data) 340 { 341 const struct touchscreen_properties *props = &data->props; 342 int val; 343 int error; 344 345 error = mms114_get_version(data); 346 if (error < 0) 347 return error; 348 349 /* MMS114, MMS134S and MMS136 have configuration and power on registers */ 350 if (data->type != TYPE_MMS114 && data->type != TYPE_MMS134S && 351 data->type != TYPE_MMS136) 352 return 0; 353 354 error = mms114_set_active(data, true); 355 if (error < 0) 356 return error; 357 358 val = (props->max_x >> 8) & 0xf; 359 val |= ((props->max_y >> 8) & 0xf) << 4; 360 error = mms114_write_reg(data, MMS114_XY_RESOLUTION_H, val); 361 if (error < 0) 362 return error; 363 364 val = props->max_x & 0xff; 365 error = mms114_write_reg(data, MMS114_X_RESOLUTION, val); 366 if (error < 0) 367 return error; 368 369 val = props->max_x & 0xff; 370 error = mms114_write_reg(data, MMS114_Y_RESOLUTION, val); 371 if (error < 0) 372 return error; 373 374 if (data->contact_threshold) { 375 error = mms114_write_reg(data, MMS114_CONTACT_THRESHOLD, 376 data->contact_threshold); 377 if (error < 0) 378 return error; 379 } 380 381 if (data->moving_threshold) { 382 error = mms114_write_reg(data, MMS114_MOVING_THRESHOLD, 383 data->moving_threshold); 384 if (error < 0) 385 return error; 386 } 387 388 return 0; 389 } 390 391 static int mms114_start(struct mms114_data *data) 392 { 393 struct i2c_client *client = data->client; 394 int error; 395 396 error = regulator_enable(data->core_reg); 397 if (error) { 398 dev_err(&client->dev, "Failed to enable avdd: %d\n", error); 399 return error; 400 } 401 402 error = regulator_enable(data->io_reg); 403 if (error) { 404 dev_err(&client->dev, "Failed to enable vdd: %d\n", error); 405 regulator_disable(data->core_reg); 406 return error; 407 } 408 409 msleep(MMS114_POWERON_DELAY); 410 411 error = mms114_setup_regs(data); 412 if (error < 0) { 413 regulator_disable(data->io_reg); 414 regulator_disable(data->core_reg); 415 return error; 416 } 417 418 enable_irq(client->irq); 419 420 return 0; 421 } 422 423 static void mms114_stop(struct mms114_data *data) 424 { 425 struct i2c_client *client = data->client; 426 int error; 427 428 disable_irq(client->irq); 429 430 error = regulator_disable(data->io_reg); 431 if (error) 432 dev_warn(&client->dev, "Failed to disable vdd: %d\n", error); 433 434 error = regulator_disable(data->core_reg); 435 if (error) 436 dev_warn(&client->dev, "Failed to disable avdd: %d\n", error); 437 } 438 439 static int mms114_input_open(struct input_dev *dev) 440 { 441 struct mms114_data *data = input_get_drvdata(dev); 442 443 return mms114_start(data); 444 } 445 446 static void mms114_input_close(struct input_dev *dev) 447 { 448 struct mms114_data *data = input_get_drvdata(dev); 449 450 mms114_stop(data); 451 } 452 453 static int mms114_parse_legacy_bindings(struct mms114_data *data) 454 { 455 struct device *dev = &data->client->dev; 456 struct touchscreen_properties *props = &data->props; 457 458 if (device_property_read_u32(dev, "x-size", &props->max_x)) { 459 dev_dbg(dev, "failed to get legacy x-size property\n"); 460 return -EINVAL; 461 } 462 463 if (device_property_read_u32(dev, "y-size", &props->max_y)) { 464 dev_dbg(dev, "failed to get legacy y-size property\n"); 465 return -EINVAL; 466 } 467 468 device_property_read_u32(dev, "contact-threshold", 469 &data->contact_threshold); 470 device_property_read_u32(dev, "moving-threshold", 471 &data->moving_threshold); 472 473 if (device_property_read_bool(dev, "x-invert")) 474 props->invert_x = true; 475 if (device_property_read_bool(dev, "y-invert")) 476 props->invert_y = true; 477 478 props->swap_x_y = false; 479 480 return 0; 481 } 482 483 static int mms114_probe(struct i2c_client *client) 484 { 485 struct mms114_data *data; 486 struct input_dev *input_dev; 487 const void *match_data; 488 int error; 489 int i; 490 491 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) { 492 dev_err(&client->dev, "Not supported I2C adapter\n"); 493 return -ENODEV; 494 } 495 496 data = devm_kzalloc(&client->dev, sizeof(struct mms114_data), 497 GFP_KERNEL); 498 input_dev = devm_input_allocate_device(&client->dev); 499 if (!data || !input_dev) { 500 dev_err(&client->dev, "Failed to allocate memory\n"); 501 return -ENOMEM; 502 } 503 504 data->client = client; 505 data->input_dev = input_dev; 506 507 match_data = device_get_match_data(&client->dev); 508 if (!match_data) 509 return -EINVAL; 510 511 data->type = (enum mms_type)match_data; 512 513 data->num_keycodes = device_property_count_u32(&client->dev, 514 "linux,keycodes"); 515 if (data->num_keycodes == -EINVAL) { 516 data->num_keycodes = 0; 517 } else if (data->num_keycodes < 0) { 518 dev_err(&client->dev, 519 "Unable to parse linux,keycodes property: %d\n", 520 data->num_keycodes); 521 return data->num_keycodes; 522 } else if (data->num_keycodes > MMS114_MAX_TOUCHKEYS) { 523 dev_warn(&client->dev, 524 "Found %d linux,keycodes but max is %d, ignoring the rest\n", 525 data->num_keycodes, MMS114_MAX_TOUCHKEYS); 526 data->num_keycodes = MMS114_MAX_TOUCHKEYS; 527 } 528 529 if (data->num_keycodes > 0) { 530 error = device_property_read_u32_array(&client->dev, 531 "linux,keycodes", 532 data->keycodes, 533 data->num_keycodes); 534 if (error) { 535 dev_err(&client->dev, 536 "Unable to read linux,keycodes values: %d\n", 537 error); 538 return error; 539 } 540 541 input_dev->keycode = data->keycodes; 542 input_dev->keycodemax = data->num_keycodes; 543 input_dev->keycodesize = sizeof(data->keycodes[0]); 544 for (i = 0; i < data->num_keycodes; i++) 545 input_set_capability(input_dev, 546 EV_KEY, data->keycodes[i]); 547 } 548 549 input_set_capability(input_dev, EV_ABS, ABS_MT_POSITION_X); 550 input_set_capability(input_dev, EV_ABS, ABS_MT_POSITION_Y); 551 input_set_abs_params(input_dev, ABS_MT_PRESSURE, 0, 255, 0, 0); 552 input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR, 553 0, MMS114_MAX_AREA, 0, 0); 554 555 touchscreen_parse_properties(input_dev, true, &data->props); 556 if (!data->props.max_x || !data->props.max_y) { 557 dev_dbg(&client->dev, 558 "missing X/Y size properties, trying legacy bindings\n"); 559 error = mms114_parse_legacy_bindings(data); 560 if (error) 561 return error; 562 563 input_set_abs_params(input_dev, ABS_MT_POSITION_X, 564 0, data->props.max_x, 0, 0); 565 input_set_abs_params(input_dev, ABS_MT_POSITION_Y, 566 0, data->props.max_y, 0, 0); 567 } 568 569 if (data->type == TYPE_MMS114 || data->type == TYPE_MMS134S || 570 data->type == TYPE_MMS136) { 571 /* 572 * The firmware handles movement and pressure fuzz, so 573 * don't duplicate that in software. 574 */ 575 data->moving_threshold = input_abs_get_fuzz(input_dev, 576 ABS_MT_POSITION_X); 577 data->contact_threshold = input_abs_get_fuzz(input_dev, 578 ABS_MT_PRESSURE); 579 input_abs_set_fuzz(input_dev, ABS_MT_POSITION_X, 0); 580 input_abs_set_fuzz(input_dev, ABS_MT_POSITION_Y, 0); 581 input_abs_set_fuzz(input_dev, ABS_MT_PRESSURE, 0); 582 } 583 584 input_dev->name = devm_kasprintf(&client->dev, GFP_KERNEL, 585 "MELFAS MMS%d Touchscreen", 586 data->type); 587 if (!input_dev->name) 588 return -ENOMEM; 589 590 input_dev->id.bustype = BUS_I2C; 591 input_dev->dev.parent = &client->dev; 592 input_dev->open = mms114_input_open; 593 input_dev->close = mms114_input_close; 594 595 error = input_mt_init_slots(input_dev, MMS114_MAX_TOUCH, 596 INPUT_MT_DIRECT); 597 if (error) 598 return error; 599 600 input_set_drvdata(input_dev, data); 601 i2c_set_clientdata(client, data); 602 603 data->core_reg = devm_regulator_get(&client->dev, "avdd"); 604 if (IS_ERR(data->core_reg)) { 605 error = PTR_ERR(data->core_reg); 606 dev_err(&client->dev, 607 "Unable to get the Core regulator (%d)\n", error); 608 return error; 609 } 610 611 data->io_reg = devm_regulator_get(&client->dev, "vdd"); 612 if (IS_ERR(data->io_reg)) { 613 error = PTR_ERR(data->io_reg); 614 dev_err(&client->dev, 615 "Unable to get the IO regulator (%d)\n", error); 616 return error; 617 } 618 619 error = devm_request_threaded_irq(&client->dev, client->irq, 620 NULL, mms114_interrupt, 621 IRQF_ONESHOT | IRQF_NO_AUTOEN, 622 dev_name(&client->dev), data); 623 if (error) { 624 dev_err(&client->dev, "Failed to register interrupt\n"); 625 return error; 626 } 627 628 error = input_register_device(data->input_dev); 629 if (error) { 630 dev_err(&client->dev, "Failed to register input device\n"); 631 return error; 632 } 633 634 return 0; 635 } 636 637 static int mms114_suspend(struct device *dev) 638 { 639 struct i2c_client *client = to_i2c_client(dev); 640 struct mms114_data *data = i2c_get_clientdata(client); 641 struct input_dev *input_dev = data->input_dev; 642 int id; 643 644 /* Release all touch */ 645 for (id = 0; id < MMS114_MAX_TOUCH; id++) { 646 input_mt_slot(input_dev, id); 647 input_mt_report_slot_inactive(input_dev); 648 } 649 650 input_mt_report_pointer_emulation(input_dev, true); 651 input_sync(input_dev); 652 653 guard(mutex)(&input_dev->mutex); 654 655 if (input_device_enabled(input_dev)) 656 mms114_stop(data); 657 658 return 0; 659 } 660 661 static int mms114_resume(struct device *dev) 662 { 663 struct i2c_client *client = to_i2c_client(dev); 664 struct mms114_data *data = i2c_get_clientdata(client); 665 struct input_dev *input_dev = data->input_dev; 666 int error; 667 668 guard(mutex)(&input_dev->mutex); 669 670 if (input_device_enabled(input_dev)) { 671 error = mms114_start(data); 672 if (error) 673 return error; 674 } 675 676 return 0; 677 } 678 679 static DEFINE_SIMPLE_DEV_PM_OPS(mms114_pm_ops, mms114_suspend, mms114_resume); 680 681 static const struct i2c_device_id mms114_id[] = { 682 { .name = "mms114" }, 683 { } 684 }; 685 MODULE_DEVICE_TABLE(i2c, mms114_id); 686 687 #ifdef CONFIG_OF 688 static const struct of_device_id mms114_dt_match[] = { 689 { 690 .compatible = "melfas,mms114", 691 .data = (void *)TYPE_MMS114, 692 }, { 693 .compatible = "melfas,mms134s", 694 .data = (void *)TYPE_MMS134S, 695 }, { 696 .compatible = "melfas,mms136", 697 .data = (void *)TYPE_MMS136, 698 }, { 699 .compatible = "melfas,mms152", 700 .data = (void *)TYPE_MMS152, 701 }, { 702 .compatible = "melfas,mms345l", 703 .data = (void *)TYPE_MMS345L, 704 }, 705 { } 706 }; 707 MODULE_DEVICE_TABLE(of, mms114_dt_match); 708 #endif 709 710 static struct i2c_driver mms114_driver = { 711 .driver = { 712 .name = "mms114", 713 .pm = pm_sleep_ptr(&mms114_pm_ops), 714 .of_match_table = of_match_ptr(mms114_dt_match), 715 }, 716 .probe = mms114_probe, 717 .id_table = mms114_id, 718 }; 719 720 module_i2c_driver(mms114_driver); 721 722 /* Module information */ 723 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>"); 724 MODULE_DESCRIPTION("MELFAS mms114 Touchscreen driver"); 725 MODULE_LICENSE("GPL v2"); 726