drivers/video/omap2/displays/panel-tpo-td043mtea1.c

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