drivers/gpu/drm/omapdrm/displays/panel-tpo-td043mtea1.c

   1 /*
   2  * TPO TD043MTEA1 Panel driver
   3  *
   4  * Author: Gražvydas Ignotas <notasas@gmail.com>
   5  * Converted to new DSS device model: Tomi Valkeinen <tomi.valkeinen@ti.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  */
  12
  13 #include <linux/module.h>
  14 #include <linux/delay.h>
  15 #include <linux/spi/spi.h>
  16 #include <linux/regulator/consumer.h>
  17 #include <linux/gpio/consumer.h>
  18 #include <linux/err.h>
  19 #include <linux/slab.h>
  20 #include <linux/of_gpio.h>
  21
  22 #include "../dss/omapdss.h"
  23
  24 #define TPO_R02_MODE(x)         ((x) & 7)
  25 #define TPO_R02_MODE_800x480    7
  26 #define TPO_R02_NCLK_RISING     BIT(3)
  27 #define TPO_R02_HSYNC_HIGH      BIT(4)
  28 #define TPO_R02_VSYNC_HIGH      BIT(5)
  29
  30 #define TPO_R03_NSTANDBY        BIT(0)
  31 #define TPO_R03_EN_CP_CLK       BIT(1)
  32 #define TPO_R03_EN_VGL_PUMP     BIT(2)
  33 #define TPO_R03_EN_PWM          BIT(3)
  34 #define TPO_R03_DRIVING_CAP_100 BIT(4)
  35 #define TPO_R03_EN_PRE_CHARGE   BIT(6)
  36 #define TPO_R03_SOFTWARE_CTL    BIT(7)
  37
  38 #define TPO_R04_NFLIP_H         BIT(0)
  39 #define TPO_R04_NFLIP_V         BIT(1)
  40 #define TPO_R04_CP_CLK_FREQ_1H  BIT(2)
  41 #define TPO_R04_VGL_FREQ_1H     BIT(4)
  42
  43 #define TPO_R03_VAL_NORMAL (TPO_R03_NSTANDBY | TPO_R03_EN_CP_CLK | \
  44                         TPO_R03_EN_VGL_PUMP |  TPO_R03_EN_PWM | \
  45                         TPO_R03_DRIVING_CAP_100 | TPO_R03_EN_PRE_CHARGE | \
  46                         TPO_R03_SOFTWARE_CTL)
  47
  48 #define TPO_R03_VAL_STANDBY (TPO_R03_DRIVING_CAP_100 | \
  49                         TPO_R03_EN_PRE_CHARGE | TPO_R03_SOFTWARE_CTL)
  50
  51 static const u16 tpo_td043_def_gamma[12] = {
  52         105, 315, 381, 431, 490, 537, 579, 686, 780, 837, 880, 1023
  53 };
  54
  55 struct panel_drv_data {
  56         struct omap_dss_device  dssdev;
  57         struct omap_dss_device *in;
  58
  59         struct videomode vm;
  60
  61         struct spi_device *spi;
  62         struct regulator *vcc_reg;
  63         int nreset_gpio;
  64         u16 gamma[12];
  65         u32 mode;
  66         u32 hmirror:1;
  67         u32 vmirror:1;
  68         u32 powered_on:1;
  69         u32 spi_suspended:1;
  70         u32 power_on_resume:1;
  71 };
  72
  73 static const struct videomode tpo_td043_vm = {
  74         .hactive        = 800,
  75         .vactive        = 480,
  76
  77         .pixelclock     = 36000000,
  78
  79         .hsync_len      = 1,
  80         .hfront_porch   = 68,
  81         .hback_porch    = 214,
  82
  83         .vsync_len      = 1,
  84         .vfront_porch   = 39,
  85         .vback_porch    = 34,
  86
  87         .flags          = DISPLAY_FLAGS_HSYNC_LOW | DISPLAY_FLAGS_VSYNC_LOW |
  88                           DISPLAY_FLAGS_DE_HIGH | DISPLAY_FLAGS_SYNC_POSEDGE |
  89                           DISPLAY_FLAGS_PIXDATA_NEGEDGE,
  90         /*
  91          * Note: According to the panel documentation:
  92          * SYNC needs to be driven on the FALLING edge
  93          */
  94 };
  95
  96 #define to_panel_data(p) container_of(p, struct panel_drv_data, dssdev)
  97
  98 static int tpo_td043_write(struct spi_device *spi, u8 addr, u8 data)
  99 {
 100         struct spi_message      m;
 101         struct spi_transfer     xfer;
 102         u16                     w;
 103         int                     r;
 104
 105         spi_message_init(&m);
 106
 107         memset(&xfer, 0, sizeof(xfer));
 108
 109         w = ((u16)addr << 10) | (1 << 8) | data;
 110         xfer.tx_buf = &w;
 111         xfer.bits_per_word = 16;
 112         xfer.len = 2;
 113         spi_message_add_tail(&xfer, &m);
 114
 115         r = spi_sync(spi, &m);
 116         if (r < 0)
 117                 dev_warn(&spi->dev, "failed to write to LCD reg (%d)\n", r);
 118         return r;
 119 }
 120
 121 static void tpo_td043_write_gamma(struct spi_device *spi, u16 gamma[12])
 122 {
 123         u8 i, val;
 124
 125         /* gamma bits [9:8] */
 126         for (val = i = 0; i < 4; i++)
 127                 val |= (gamma[i] & 0x300) >> ((i + 1) * 2);
 128         tpo_td043_write(spi, 0x11, val);
 129
 130         for (val = i = 0; i < 4; i++)
 131                 val |= (gamma[i+4] & 0x300) >> ((i + 1) * 2);
 132         tpo_td043_write(spi, 0x12, val);
 133
 134         for (val = i = 0; i < 4; i++)
 135                 val |= (gamma[i+8] & 0x300) >> ((i + 1) * 2);
 136         tpo_td043_write(spi, 0x13, val);
 137
 138         /* gamma bits [7:0] */
 139         for (val = i = 0; i < 12; i++)
 140                 tpo_td043_write(spi, 0x14 + i, gamma[i] & 0xff);
 141 }
 142
 143 static int tpo_td043_write_mirror(struct spi_device *spi, bool h, bool v)
 144 {
 145         u8 reg4 = TPO_R04_NFLIP_H | TPO_R04_NFLIP_V |
 146                 TPO_R04_CP_CLK_FREQ_1H | TPO_R04_VGL_FREQ_1H;
 147         if (h)
 148                 reg4 &= ~TPO_R04_NFLIP_H;
 149         if (v)
 150                 reg4 &= ~TPO_R04_NFLIP_V;
 151
 152         return tpo_td043_write(spi, 4, reg4);
 153 }
 154
 155 static int tpo_td043_set_hmirror(struct omap_dss_device *dssdev, bool enable)
 156 {
 157         struct panel_drv_data *ddata = dev_get_drvdata(dssdev->dev);
 158
 159         ddata->hmirror = enable;
 160         return tpo_td043_write_mirror(ddata->spi, ddata->hmirror,
 161                         ddata->vmirror);
 162 }
 163
 164 static bool tpo_td043_get_hmirror(struct omap_dss_device *dssdev)
 165 {
 166         struct panel_drv_data *ddata = dev_get_drvdata(dssdev->dev);
 167
 168         return ddata->hmirror;
 169 }
 170
 171 static ssize_t tpo_td043_vmirror_show(struct device *dev,
 172         struct device_attribute *attr, char *buf)
 173 {
 174         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 175
 176         return snprintf(buf, PAGE_SIZE, "%d\n", ddata->vmirror);
 177 }
 178
 179 static ssize_t tpo_td043_vmirror_store(struct device *dev,
 180         struct device_attribute *attr, const char *buf, size_t count)
 181 {
 182         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 183         int val;
 184         int ret;
 185
 186         ret = kstrtoint(buf, 0, &val);
 187         if (ret < 0)
 188                 return ret;
 189
 190         val = !!val;
 191
 192         ret = tpo_td043_write_mirror(ddata->spi, ddata->hmirror, val);
 193         if (ret < 0)
 194                 return ret;
 195
 196         ddata->vmirror = val;
 197
 198         return count;
 199 }
 200
 201 static ssize_t tpo_td043_mode_show(struct device *dev,
 202         struct device_attribute *attr, char *buf)
 203 {
 204         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 205
 206         return snprintf(buf, PAGE_SIZE, "%d\n", ddata->mode);
 207 }
 208
 209 static ssize_t tpo_td043_mode_store(struct device *dev,
 210         struct device_attribute *attr, const char *buf, size_t count)
 211 {
 212         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 213         long val;
 214         int ret;
 215
 216         ret = kstrtol(buf, 0, &val);
 217         if (ret != 0 || val & ~7)
 218                 return -EINVAL;
 219
 220         ddata->mode = val;
 221
 222         val |= TPO_R02_NCLK_RISING;
 223         tpo_td043_write(ddata->spi, 2, val);
 224
 225         return count;
 226 }
 227
 228 static ssize_t tpo_td043_gamma_show(struct device *dev,
 229         struct device_attribute *attr, char *buf)
 230 {
 231         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 232         ssize_t len = 0;
 233         int ret;
 234         int i;
 235
 236         for (i = 0; i < ARRAY_SIZE(ddata->gamma); i++) {
 237                 ret = snprintf(buf + len, PAGE_SIZE - len, "%u ",
 238                                 ddata->gamma[i]);
 239                 if (ret < 0)
 240                         return ret;
 241                 len += ret;
 242         }
 243         buf[len - 1] = '\n';
 244
 245         return len;
 246 }
 247
 248 static ssize_t tpo_td043_gamma_store(struct device *dev,
 249         struct device_attribute *attr, const char *buf, size_t count)
 250 {
 251         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 252         unsigned int g[12];
 253         int ret;
 254         int i;
 255
 256         ret = sscanf(buf, "%u %u %u %u %u %u %u %u %u %u %u %u",
 257                         &g[0], &g[1], &g[2], &g[3], &g[4], &g[5],
 258                         &g[6], &g[7], &g[8], &g[9], &g[10], &g[11]);
 259
 260         if (ret != 12)
 261                 return -EINVAL;
 262
 263         for (i = 0; i < 12; i++)
 264                 ddata->gamma[i] = g[i];
 265
 266         tpo_td043_write_gamma(ddata->spi, ddata->gamma);
 267
 268         return count;
 269 }
 270
 271 static DEVICE_ATTR(vmirror, S_IRUGO | S_IWUSR,
 272                 tpo_td043_vmirror_show, tpo_td043_vmirror_store);
 273 static DEVICE_ATTR(mode, S_IRUGO | S_IWUSR,
 274                 tpo_td043_mode_show, tpo_td043_mode_store);
 275 static DEVICE_ATTR(gamma, S_IRUGO | S_IWUSR,
 276                 tpo_td043_gamma_show, tpo_td043_gamma_store);
 277
 278 static struct attribute *tpo_td043_attrs[] = {
 279         &dev_attr_vmirror.attr,
 280         &dev_attr_mode.attr,
 281         &dev_attr_gamma.attr,
 282         NULL,
 283 };
 284
 285 static const struct attribute_group tpo_td043_attr_group = {
 286         .attrs = tpo_td043_attrs,
 287 };
 288
 289 static int tpo_td043_power_on(struct panel_drv_data *ddata)
 290 {
 291         int r;
 292
 293         if (ddata->powered_on)
 294                 return 0;
 295
 296         r = regulator_enable(ddata->vcc_reg);
 297         if (r != 0)
 298                 return r;
 299
 300         /* wait for panel to stabilize */
 301         msleep(160);
 302
 303         if (gpio_is_valid(ddata->nreset_gpio))
 304                 gpio_set_value(ddata->nreset_gpio, 1);
 305
 306         tpo_td043_write(ddata->spi, 2,
 307                         TPO_R02_MODE(ddata->mode) | TPO_R02_NCLK_RISING);
 308         tpo_td043_write(ddata->spi, 3, TPO_R03_VAL_NORMAL);
 309         tpo_td043_write(ddata->spi, 0x20, 0xf0);
 310         tpo_td043_write(ddata->spi, 0x21, 0xf0);
 311         tpo_td043_write_mirror(ddata->spi, ddata->hmirror,
 312                         ddata->vmirror);
 313         tpo_td043_write_gamma(ddata->spi, ddata->gamma);
 314
 315         ddata->powered_on = 1;
 316         return 0;
 317 }
 318
 319 static void tpo_td043_power_off(struct panel_drv_data *ddata)
 320 {
 321         if (!ddata->powered_on)
 322                 return;
 323
 324         tpo_td043_write(ddata->spi, 3,
 325                         TPO_R03_VAL_STANDBY | TPO_R03_EN_PWM);
 326
 327         if (gpio_is_valid(ddata->nreset_gpio))
 328                 gpio_set_value(ddata->nreset_gpio, 0);
 329
 330         /* wait for at least 2 vsyncs before cutting off power */
 331         msleep(50);
 332
 333         tpo_td043_write(ddata->spi, 3, TPO_R03_VAL_STANDBY);
 334
 335         regulator_disable(ddata->vcc_reg);
 336
 337         ddata->powered_on = 0;
 338 }
 339
 340 static int tpo_td043_connect(struct omap_dss_device *dssdev)
 341 {
 342         struct panel_drv_data *ddata = to_panel_data(dssdev);
 343         struct omap_dss_device *in;
 344         int r;
 345
 346         if (omapdss_device_is_connected(dssdev))
 347                 return 0;
 348
 349         in = omapdss_of_find_source_for_first_ep(dssdev->dev->of_node);
 350         if (IS_ERR(in)) {
 351                 dev_err(dssdev->dev, "failed to find video source\n");
 352                 return PTR_ERR(in);
 353         }
 354
 355         r = in->ops.dpi->connect(in, dssdev);
 356         if (r) {
 357                 omap_dss_put_device(in);
 358                 return r;
 359         }
 360
 361         ddata->in = in;
 362         return 0;
 363 }
 364
 365 static void tpo_td043_disconnect(struct omap_dss_device *dssdev)
 366 {
 367         struct panel_drv_data *ddata = to_panel_data(dssdev);
 368         struct omap_dss_device *in = ddata->in;
 369
 370         if (!omapdss_device_is_connected(dssdev))
 371                 return;
 372
 373         in->ops.dpi->disconnect(in, dssdev);
 374
 375         omap_dss_put_device(in);
 376         ddata->in = NULL;
 377 }
 378
 379 static int tpo_td043_enable(struct omap_dss_device *dssdev)
 380 {
 381         struct panel_drv_data *ddata = to_panel_data(dssdev);
 382         struct omap_dss_device *in = ddata->in;
 383         int r;
 384
 385         if (!omapdss_device_is_connected(dssdev))
 386                 return -ENODEV;
 387
 388         if (omapdss_device_is_enabled(dssdev))
 389                 return 0;
 390
 391         in->ops.dpi->set_timings(in, &ddata->vm);
 392
 393         r = in->ops.dpi->enable(in);
 394         if (r)
 395                 return r;
 396
 397         /*
 398          * If we are resuming from system suspend, SPI clocks might not be
 399          * enabled yet, so we'll program the LCD from SPI PM resume callback.
 400          */
 401         if (!ddata->spi_suspended) {
 402                 r = tpo_td043_power_on(ddata);
 403                 if (r) {
 404                         in->ops.dpi->disable(in);
 405                         return r;
 406                 }
 407         }
 408
 409         dssdev->state = OMAP_DSS_DISPLAY_ACTIVE;
 410
 411         return 0;
 412 }
 413
 414 static void tpo_td043_disable(struct omap_dss_device *dssdev)
 415 {
 416         struct panel_drv_data *ddata = to_panel_data(dssdev);
 417         struct omap_dss_device *in = ddata->in;
 418
 419         if (!omapdss_device_is_enabled(dssdev))
 420                 return;
 421
 422         in->ops.dpi->disable(in);
 423
 424         if (!ddata->spi_suspended)
 425                 tpo_td043_power_off(ddata);
 426
 427         dssdev->state = OMAP_DSS_DISPLAY_DISABLED;
 428 }
 429
 430 static void tpo_td043_set_timings(struct omap_dss_device *dssdev,
 431                                   struct videomode *vm)
 432 {
 433         struct panel_drv_data *ddata = to_panel_data(dssdev);
 434         struct omap_dss_device *in = ddata->in;
 435
 436         ddata->vm = *vm;
 437         dssdev->panel.vm = *vm;
 438
 439         in->ops.dpi->set_timings(in, vm);
 440 }
 441
 442 static void tpo_td043_get_timings(struct omap_dss_device *dssdev,
 443                                   struct videomode *vm)
 444 {
 445         struct panel_drv_data *ddata = to_panel_data(dssdev);
 446
 447         *vm = ddata->vm;
 448 }
 449
 450 static int tpo_td043_check_timings(struct omap_dss_device *dssdev,
 451                                    struct videomode *vm)
 452 {
 453         struct panel_drv_data *ddata = to_panel_data(dssdev);
 454         struct omap_dss_device *in = ddata->in;
 455
 456         return in->ops.dpi->check_timings(in, vm);
 457 }
 458
 459 static struct omap_dss_driver tpo_td043_ops = {
 460         .connect        = tpo_td043_connect,
 461         .disconnect     = tpo_td043_disconnect,
 462
 463         .enable         = tpo_td043_enable,
 464         .disable        = tpo_td043_disable,
 465
 466         .set_timings    = tpo_td043_set_timings,
 467         .get_timings    = tpo_td043_get_timings,
 468         .check_timings  = tpo_td043_check_timings,
 469
 470         .set_mirror     = tpo_td043_set_hmirror,
 471         .get_mirror     = tpo_td043_get_hmirror,
 472 };
 473
 474 static int tpo_td043_probe_of(struct spi_device *spi)
 475 {
 476         struct device_node *node = spi->dev.of_node;
 477         struct panel_drv_data *ddata = dev_get_drvdata(&spi->dev);
 478         int gpio;
 479
 480         gpio = of_get_named_gpio(node, "reset-gpios", 0);
 481         if (!gpio_is_valid(gpio)) {
 482                 dev_err(&spi->dev, "failed to parse enable gpio\n");
 483                 return gpio;
 484         }
 485         ddata->nreset_gpio = gpio;
 486
 487         return 0;
 488 }
 489
 490 static int tpo_td043_probe(struct spi_device *spi)
 491 {
 492         struct panel_drv_data *ddata;
 493         struct omap_dss_device *dssdev;
 494         int r;
 495
 496         dev_dbg(&spi->dev, "%s\n", __func__);
 497
 498         spi->bits_per_word = 16;
 499         spi->mode = SPI_MODE_0;
 500
 501         r = spi_setup(spi);
 502         if (r < 0) {
 503                 dev_err(&spi->dev, "spi_setup failed: %d\n", r);
 504                 return r;
 505         }
 506
 507         ddata = devm_kzalloc(&spi->dev, sizeof(*ddata), GFP_KERNEL);
 508         if (ddata == NULL)
 509                 return -ENOMEM;
 510
 511         dev_set_drvdata(&spi->dev, ddata);
 512
 513         ddata->spi = spi;
 514
 515         r = tpo_td043_probe_of(spi);
 516         if (r)
 517                 return r;
 518
 519         ddata->mode = TPO_R02_MODE_800x480;
 520         memcpy(ddata->gamma, tpo_td043_def_gamma, sizeof(ddata->gamma));
 521
 522         ddata->vcc_reg = devm_regulator_get(&spi->dev, "vcc");
 523         if (IS_ERR(ddata->vcc_reg)) {
 524                 dev_err(&spi->dev, "failed to get LCD VCC regulator\n");
 525                 r = PTR_ERR(ddata->vcc_reg);
 526                 goto err_regulator;
 527         }
 528
 529         if (gpio_is_valid(ddata->nreset_gpio)) {
 530                 r = devm_gpio_request_one(&spi->dev,
 531                                 ddata->nreset_gpio, GPIOF_OUT_INIT_LOW,
 532                                 "lcd reset");
 533                 if (r < 0) {
 534                         dev_err(&spi->dev, "couldn't request reset GPIO\n");
 535                         goto err_gpio_req;
 536                 }
 537         }
 538
 539         r = sysfs_create_group(&spi->dev.kobj, &tpo_td043_attr_group);
 540         if (r) {
 541                 dev_err(&spi->dev, "failed to create sysfs files\n");
 542                 goto err_sysfs;
 543         }
 544
 545         ddata->vm = tpo_td043_vm;
 546
 547         dssdev = &ddata->dssdev;
 548         dssdev->dev = &spi->dev;
 549         dssdev->driver = &tpo_td043_ops;
 550         dssdev->type = OMAP_DISPLAY_TYPE_DPI;
 551         dssdev->owner = THIS_MODULE;
 552         dssdev->panel.vm = ddata->vm;
 553
 554         r = omapdss_register_display(dssdev);
 555         if (r) {
 556                 dev_err(&spi->dev, "Failed to register panel\n");
 557                 goto err_reg;
 558         }
 559
 560         return 0;
 561
 562 err_reg:
 563         sysfs_remove_group(&spi->dev.kobj, &tpo_td043_attr_group);
 564 err_sysfs:
 565 err_gpio_req:
 566 err_regulator:
 567         return r;
 568 }
 569
 570 static int tpo_td043_remove(struct spi_device *spi)
 571 {
 572         struct panel_drv_data *ddata = dev_get_drvdata(&spi->dev);
 573         struct omap_dss_device *dssdev = &ddata->dssdev;
 574
 575         dev_dbg(&ddata->spi->dev, "%s\n", __func__);
 576
 577         omapdss_unregister_display(dssdev);
 578
 579         tpo_td043_disable(dssdev);
 580         tpo_td043_disconnect(dssdev);
 581
 582         sysfs_remove_group(&spi->dev.kobj, &tpo_td043_attr_group);
 583
 584         return 0;
 585 }
 586
 587 #ifdef CONFIG_PM_SLEEP
 588 static int tpo_td043_spi_suspend(struct device *dev)
 589 {
 590         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 591
 592         dev_dbg(dev, "tpo_td043_spi_suspend, tpo %p\n", ddata);
 593
 594         ddata->power_on_resume = ddata->powered_on;
 595         tpo_td043_power_off(ddata);
 596         ddata->spi_suspended = 1;
 597
 598         return 0;
 599 }
 600
 601 static int tpo_td043_spi_resume(struct device *dev)
 602 {
 603         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 604         int ret;
 605
 606         dev_dbg(dev, "tpo_td043_spi_resume\n");
 607
 608         if (ddata->power_on_resume) {
 609                 ret = tpo_td043_power_on(ddata);
 610                 if (ret)
 611                         return ret;
 612         }
 613         ddata->spi_suspended = 0;
 614
 615         return 0;
 616 }
 617 #endif
 618
 619 static SIMPLE_DEV_PM_OPS(tpo_td043_spi_pm,
 620         tpo_td043_spi_suspend, tpo_td043_spi_resume);
 621
 622 static const struct of_device_id tpo_td043_of_match[] = {
 623         { .compatible = "omapdss,tpo,td043mtea1", },
 624         {},
 625 };
 626
 627 MODULE_DEVICE_TABLE(of, tpo_td043_of_match);
 628
 629 static struct spi_driver tpo_td043_spi_driver = {
 630         .driver = {
 631                 .name   = "panel-tpo-td043mtea1",
 632                 .pm     = &tpo_td043_spi_pm,
 633                 .of_match_table = tpo_td043_of_match,
 634                 .suppress_bind_attrs = true,
 635         },
 636         .probe  = tpo_td043_probe,
 637         .remove = tpo_td043_remove,
 638 };
 639
 640 module_spi_driver(tpo_td043_spi_driver);
 641
 642 MODULE_ALIAS("spi:tpo,td043mtea1");
 643 MODULE_AUTHOR("Gražvydas Ignotas <notasas@gmail.com>");
 644 MODULE_DESCRIPTION("TPO TD043MTEA1 LCD Driver");
 645 MODULE_LICENSE("GPL");