drivers/gpu/drm/omapdrm/displays/panel-dsi-cm.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Generic DSI Command Mode panel driver
   4  *
   5  * Copyright (C) 2013 Texas Instruments Incorporated - http://www.ti.com/
   6  * Author: Tomi Valkeinen <tomi.valkeinen@ti.com>
   7  */
   8
   9 /* #define DEBUG */
  10
  11 #include <linux/backlight.h>
  12 #include <linux/delay.h>
  13 #include <linux/gpio/consumer.h>
  14 #include <linux/interrupt.h>
  15 #include <linux/jiffies.h>
  16 #include <linux/module.h>
  17 #include <linux/platform_device.h>
  18 #include <linux/sched/signal.h>
  19 #include <linux/slab.h>
  20 #include <linux/workqueue.h>
  21 #include <linux/of_device.h>
  22 #include <linux/regulator/consumer.h>
  23
  24 #include <drm/drm_connector.h>
  25
  26 #include <video/mipi_display.h>
  27 #include <video/of_display_timing.h>
  28
  29 #include "../dss/omapdss.h"
  30
  31 /* DSI Virtual channel. Hardcoded for now. */
  32 #define TCH 0
  33
  34 #define DCS_READ_NUM_ERRORS     0x05
  35 #define DCS_BRIGHTNESS          0x51
  36 #define DCS_CTRL_DISPLAY        0x53
  37 #define DCS_GET_ID1             0xda
  38 #define DCS_GET_ID2             0xdb
  39 #define DCS_GET_ID3             0xdc
  40
  41 struct panel_drv_data {
  42         struct omap_dss_device dssdev;
  43         struct omap_dss_device *src;
  44
  45         struct videomode vm;
  46
  47         struct platform_device *pdev;
  48
  49         struct mutex lock;
  50
  51         struct backlight_device *bldev;
  52         struct backlight_device *extbldev;
  53
  54         unsigned long   hw_guard_end;   /* next value of jiffies when we can
  55                                          * issue the next sleep in/out command
  56                                          */
  57         unsigned long   hw_guard_wait;  /* max guard time in jiffies */
  58
  59         /* panel HW configuration from DT or platform data */
  60         struct gpio_desc *reset_gpio;
  61         struct gpio_desc *ext_te_gpio;
  62
  63         struct regulator *vpnl;
  64         struct regulator *vddi;
  65
  66         bool use_dsi_backlight;
  67
  68         int width_mm;
  69         int height_mm;
  70
  71         struct omap_dsi_pin_config pin_config;
  72
  73         /* runtime variables */
  74         bool enabled;
  75
  76         bool te_enabled;
  77
  78         atomic_t do_update;
  79         int channel;
  80
  81         struct delayed_work te_timeout_work;
  82
  83         bool intro_printed;
  84
  85         struct workqueue_struct *workqueue;
  86
  87         bool ulps_enabled;
  88         unsigned int ulps_timeout;
  89         struct delayed_work ulps_work;
  90 };
  91
  92 #define to_panel_data(p) container_of(p, struct panel_drv_data, dssdev)
  93
  94 static irqreturn_t dsicm_te_isr(int irq, void *data);
  95 static void dsicm_te_timeout_work_callback(struct work_struct *work);
  96 static int _dsicm_enable_te(struct panel_drv_data *ddata, bool enable);
  97
  98 static int dsicm_panel_reset(struct panel_drv_data *ddata);
  99
 100 static void dsicm_ulps_work(struct work_struct *work);
 101
 102 static void dsicm_bl_power(struct panel_drv_data *ddata, bool enable)
 103 {
 104         struct backlight_device *backlight;
 105
 106         if (ddata->bldev)
 107                 backlight = ddata->bldev;
 108         else if (ddata->extbldev)
 109                 backlight = ddata->extbldev;
 110         else
 111                 return;
 112
 113         if (enable) {
 114                 backlight->props.fb_blank = FB_BLANK_UNBLANK;
 115                 backlight->props.state = ~(BL_CORE_FBBLANK | BL_CORE_SUSPENDED);
 116                 backlight->props.power = FB_BLANK_UNBLANK;
 117         } else {
 118                 backlight->props.fb_blank = FB_BLANK_NORMAL;
 119                 backlight->props.power = FB_BLANK_POWERDOWN;
 120                 backlight->props.state |= BL_CORE_FBBLANK | BL_CORE_SUSPENDED;
 121         }
 122
 123         backlight_update_status(backlight);
 124 }
 125
 126 static void hw_guard_start(struct panel_drv_data *ddata, int guard_msec)
 127 {
 128         ddata->hw_guard_wait = msecs_to_jiffies(guard_msec);
 129         ddata->hw_guard_end = jiffies + ddata->hw_guard_wait;
 130 }
 131
 132 static void hw_guard_wait(struct panel_drv_data *ddata)
 133 {
 134         unsigned long wait = ddata->hw_guard_end - jiffies;
 135
 136         if ((long)wait > 0 && wait <= ddata->hw_guard_wait) {
 137                 set_current_state(TASK_UNINTERRUPTIBLE);
 138                 schedule_timeout(wait);
 139         }
 140 }
 141
 142 static int dsicm_dcs_read_1(struct panel_drv_data *ddata, u8 dcs_cmd, u8 *data)
 143 {
 144         struct omap_dss_device *src = ddata->src;
 145         int r;
 146         u8 buf[1];
 147
 148         r = src->ops->dsi.dcs_read(src, ddata->channel, dcs_cmd, buf, 1);
 149
 150         if (r < 0)
 151                 return r;
 152
 153         *data = buf[0];
 154
 155         return 0;
 156 }
 157
 158 static int dsicm_dcs_write_0(struct panel_drv_data *ddata, u8 dcs_cmd)
 159 {
 160         struct omap_dss_device *src = ddata->src;
 161
 162         return src->ops->dsi.dcs_write(src, ddata->channel, &dcs_cmd, 1);
 163 }
 164
 165 static int dsicm_dcs_write_1(struct panel_drv_data *ddata, u8 dcs_cmd, u8 param)
 166 {
 167         struct omap_dss_device *src = ddata->src;
 168         u8 buf[2] = { dcs_cmd, param };
 169
 170         return src->ops->dsi.dcs_write(src, ddata->channel, buf, 2);
 171 }
 172
 173 static int dsicm_sleep_in(struct panel_drv_data *ddata)
 174
 175 {
 176         struct omap_dss_device *src = ddata->src;
 177         u8 cmd;
 178         int r;
 179
 180         hw_guard_wait(ddata);
 181
 182         cmd = MIPI_DCS_ENTER_SLEEP_MODE;
 183         r = src->ops->dsi.dcs_write_nosync(src, ddata->channel, &cmd, 1);
 184         if (r)
 185                 return r;
 186
 187         hw_guard_start(ddata, 120);
 188
 189         usleep_range(5000, 10000);
 190
 191         return 0;
 192 }
 193
 194 static int dsicm_sleep_out(struct panel_drv_data *ddata)
 195 {
 196         int r;
 197
 198         hw_guard_wait(ddata);
 199
 200         r = dsicm_dcs_write_0(ddata, MIPI_DCS_EXIT_SLEEP_MODE);
 201         if (r)
 202                 return r;
 203
 204         hw_guard_start(ddata, 120);
 205
 206         usleep_range(5000, 10000);
 207
 208         return 0;
 209 }
 210
 211 static int dsicm_get_id(struct panel_drv_data *ddata, u8 *id1, u8 *id2, u8 *id3)
 212 {
 213         int r;
 214
 215         r = dsicm_dcs_read_1(ddata, DCS_GET_ID1, id1);
 216         if (r)
 217                 return r;
 218         r = dsicm_dcs_read_1(ddata, DCS_GET_ID2, id2);
 219         if (r)
 220                 return r;
 221         r = dsicm_dcs_read_1(ddata, DCS_GET_ID3, id3);
 222         if (r)
 223                 return r;
 224
 225         return 0;
 226 }
 227
 228 static int dsicm_set_update_window(struct panel_drv_data *ddata,
 229                 u16 x, u16 y, u16 w, u16 h)
 230 {
 231         struct omap_dss_device *src = ddata->src;
 232         int r;
 233         u16 x1 = x;
 234         u16 x2 = x + w - 1;
 235         u16 y1 = y;
 236         u16 y2 = y + h - 1;
 237
 238         u8 buf[5];
 239         buf[0] = MIPI_DCS_SET_COLUMN_ADDRESS;
 240         buf[1] = (x1 >> 8) & 0xff;
 241         buf[2] = (x1 >> 0) & 0xff;
 242         buf[3] = (x2 >> 8) & 0xff;
 243         buf[4] = (x2 >> 0) & 0xff;
 244
 245         r = src->ops->dsi.dcs_write_nosync(src, ddata->channel, buf, sizeof(buf));
 246         if (r)
 247                 return r;
 248
 249         buf[0] = MIPI_DCS_SET_PAGE_ADDRESS;
 250         buf[1] = (y1 >> 8) & 0xff;
 251         buf[2] = (y1 >> 0) & 0xff;
 252         buf[3] = (y2 >> 8) & 0xff;
 253         buf[4] = (y2 >> 0) & 0xff;
 254
 255         r = src->ops->dsi.dcs_write_nosync(src, ddata->channel, buf, sizeof(buf));
 256         if (r)
 257                 return r;
 258
 259         src->ops->dsi.bta_sync(src, ddata->channel);
 260
 261         return r;
 262 }
 263
 264 static void dsicm_queue_ulps_work(struct panel_drv_data *ddata)
 265 {
 266         if (ddata->ulps_timeout > 0)
 267                 queue_delayed_work(ddata->workqueue, &ddata->ulps_work,
 268                                 msecs_to_jiffies(ddata->ulps_timeout));
 269 }
 270
 271 static void dsicm_cancel_ulps_work(struct panel_drv_data *ddata)
 272 {
 273         cancel_delayed_work(&ddata->ulps_work);
 274 }
 275
 276 static int dsicm_enter_ulps(struct panel_drv_data *ddata)
 277 {
 278         struct omap_dss_device *src = ddata->src;
 279         int r;
 280
 281         if (ddata->ulps_enabled)
 282                 return 0;
 283
 284         dsicm_cancel_ulps_work(ddata);
 285
 286         r = _dsicm_enable_te(ddata, false);
 287         if (r)
 288                 goto err;
 289
 290         if (ddata->ext_te_gpio)
 291                 disable_irq(gpiod_to_irq(ddata->ext_te_gpio));
 292
 293         src->ops->dsi.disable(src, false, true);
 294
 295         ddata->ulps_enabled = true;
 296
 297         return 0;
 298
 299 err:
 300         dev_err(&ddata->pdev->dev, "enter ULPS failed");
 301         dsicm_panel_reset(ddata);
 302
 303         ddata->ulps_enabled = false;
 304
 305         dsicm_queue_ulps_work(ddata);
 306
 307         return r;
 308 }
 309
 310 static int dsicm_exit_ulps(struct panel_drv_data *ddata)
 311 {
 312         struct omap_dss_device *src = ddata->src;
 313         int r;
 314
 315         if (!ddata->ulps_enabled)
 316                 return 0;
 317
 318         src->ops->enable(src);
 319         src->ops->dsi.enable_hs(src, ddata->channel, true);
 320
 321         r = _dsicm_enable_te(ddata, true);
 322         if (r) {
 323                 dev_err(&ddata->pdev->dev, "failed to re-enable TE");
 324                 goto err2;
 325         }
 326
 327         if (ddata->ext_te_gpio)
 328                 enable_irq(gpiod_to_irq(ddata->ext_te_gpio));
 329
 330         dsicm_queue_ulps_work(ddata);
 331
 332         ddata->ulps_enabled = false;
 333
 334         return 0;
 335
 336 err2:
 337         dev_err(&ddata->pdev->dev, "failed to exit ULPS");
 338
 339         r = dsicm_panel_reset(ddata);
 340         if (!r) {
 341                 if (ddata->ext_te_gpio)
 342                         enable_irq(gpiod_to_irq(ddata->ext_te_gpio));
 343                 ddata->ulps_enabled = false;
 344         }
 345
 346         dsicm_queue_ulps_work(ddata);
 347
 348         return r;
 349 }
 350
 351 static int dsicm_wake_up(struct panel_drv_data *ddata)
 352 {
 353         if (ddata->ulps_enabled)
 354                 return dsicm_exit_ulps(ddata);
 355
 356         dsicm_cancel_ulps_work(ddata);
 357         dsicm_queue_ulps_work(ddata);
 358         return 0;
 359 }
 360
 361 static int dsicm_bl_update_status(struct backlight_device *dev)
 362 {
 363         struct panel_drv_data *ddata = dev_get_drvdata(&dev->dev);
 364         struct omap_dss_device *src = ddata->src;
 365         int r = 0;
 366         int level;
 367
 368         if (dev->props.fb_blank == FB_BLANK_UNBLANK &&
 369                         dev->props.power == FB_BLANK_UNBLANK)
 370                 level = dev->props.brightness;
 371         else
 372                 level = 0;
 373
 374         dev_dbg(&ddata->pdev->dev, "update brightness to %d\n", level);
 375
 376         mutex_lock(&ddata->lock);
 377
 378         if (ddata->enabled) {
 379                 src->ops->dsi.bus_lock(src);
 380
 381                 r = dsicm_wake_up(ddata);
 382                 if (!r)
 383                         r = dsicm_dcs_write_1(ddata, DCS_BRIGHTNESS, level);
 384
 385                 src->ops->dsi.bus_unlock(src);
 386         }
 387
 388         mutex_unlock(&ddata->lock);
 389
 390         return r;
 391 }
 392
 393 static int dsicm_bl_get_intensity(struct backlight_device *dev)
 394 {
 395         if (dev->props.fb_blank == FB_BLANK_UNBLANK &&
 396                         dev->props.power == FB_BLANK_UNBLANK)
 397                 return dev->props.brightness;
 398
 399         return 0;
 400 }
 401
 402 static const struct backlight_ops dsicm_bl_ops = {
 403         .get_brightness = dsicm_bl_get_intensity,
 404         .update_status  = dsicm_bl_update_status,
 405 };
 406
 407 static ssize_t dsicm_num_errors_show(struct device *dev,
 408                 struct device_attribute *attr, char *buf)
 409 {
 410         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 411         struct omap_dss_device *src = ddata->src;
 412         u8 errors = 0;
 413         int r;
 414
 415         mutex_lock(&ddata->lock);
 416
 417         if (ddata->enabled) {
 418                 src->ops->dsi.bus_lock(src);
 419
 420                 r = dsicm_wake_up(ddata);
 421                 if (!r)
 422                         r = dsicm_dcs_read_1(ddata, DCS_READ_NUM_ERRORS,
 423                                         &errors);
 424
 425                 src->ops->dsi.bus_unlock(src);
 426         } else {
 427                 r = -ENODEV;
 428         }
 429
 430         mutex_unlock(&ddata->lock);
 431
 432         if (r)
 433                 return r;
 434
 435         return snprintf(buf, PAGE_SIZE, "%d\n", errors);
 436 }
 437
 438 static ssize_t dsicm_hw_revision_show(struct device *dev,
 439                 struct device_attribute *attr, char *buf)
 440 {
 441         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 442         struct omap_dss_device *src = ddata->src;
 443         u8 id1, id2, id3;
 444         int r;
 445
 446         mutex_lock(&ddata->lock);
 447
 448         if (ddata->enabled) {
 449                 src->ops->dsi.bus_lock(src);
 450
 451                 r = dsicm_wake_up(ddata);
 452                 if (!r)
 453                         r = dsicm_get_id(ddata, &id1, &id2, &id3);
 454
 455                 src->ops->dsi.bus_unlock(src);
 456         } else {
 457                 r = -ENODEV;
 458         }
 459
 460         mutex_unlock(&ddata->lock);
 461
 462         if (r)
 463                 return r;
 464
 465         return snprintf(buf, PAGE_SIZE, "%02x.%02x.%02x\n", id1, id2, id3);
 466 }
 467
 468 static ssize_t dsicm_store_ulps(struct device *dev,
 469                 struct device_attribute *attr,
 470                 const char *buf, size_t count)
 471 {
 472         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 473         struct omap_dss_device *src = ddata->src;
 474         unsigned long t;
 475         int r;
 476
 477         r = kstrtoul(buf, 0, &t);
 478         if (r)
 479                 return r;
 480
 481         mutex_lock(&ddata->lock);
 482
 483         if (ddata->enabled) {
 484                 src->ops->dsi.bus_lock(src);
 485
 486                 if (t)
 487                         r = dsicm_enter_ulps(ddata);
 488                 else
 489                         r = dsicm_wake_up(ddata);
 490
 491                 src->ops->dsi.bus_unlock(src);
 492         }
 493
 494         mutex_unlock(&ddata->lock);
 495
 496         if (r)
 497                 return r;
 498
 499         return count;
 500 }
 501
 502 static ssize_t dsicm_show_ulps(struct device *dev,
 503                 struct device_attribute *attr,
 504                 char *buf)
 505 {
 506         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 507         unsigned int t;
 508
 509         mutex_lock(&ddata->lock);
 510         t = ddata->ulps_enabled;
 511         mutex_unlock(&ddata->lock);
 512
 513         return snprintf(buf, PAGE_SIZE, "%u\n", t);
 514 }
 515
 516 static ssize_t dsicm_store_ulps_timeout(struct device *dev,
 517                 struct device_attribute *attr,
 518                 const char *buf, size_t count)
 519 {
 520         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 521         struct omap_dss_device *src = ddata->src;
 522         unsigned long t;
 523         int r;
 524
 525         r = kstrtoul(buf, 0, &t);
 526         if (r)
 527                 return r;
 528
 529         mutex_lock(&ddata->lock);
 530         ddata->ulps_timeout = t;
 531
 532         if (ddata->enabled) {
 533                 /* dsicm_wake_up will restart the timer */
 534                 src->ops->dsi.bus_lock(src);
 535                 r = dsicm_wake_up(ddata);
 536                 src->ops->dsi.bus_unlock(src);
 537         }
 538
 539         mutex_unlock(&ddata->lock);
 540
 541         if (r)
 542                 return r;
 543
 544         return count;
 545 }
 546
 547 static ssize_t dsicm_show_ulps_timeout(struct device *dev,
 548                 struct device_attribute *attr,
 549                 char *buf)
 550 {
 551         struct panel_drv_data *ddata = dev_get_drvdata(dev);
 552         unsigned int t;
 553
 554         mutex_lock(&ddata->lock);
 555         t = ddata->ulps_timeout;
 556         mutex_unlock(&ddata->lock);
 557
 558         return snprintf(buf, PAGE_SIZE, "%u\n", t);
 559 }
 560
 561 static DEVICE_ATTR(num_dsi_errors, S_IRUGO, dsicm_num_errors_show, NULL);
 562 static DEVICE_ATTR(hw_revision, S_IRUGO, dsicm_hw_revision_show, NULL);
 563 static DEVICE_ATTR(ulps, S_IRUGO | S_IWUSR,
 564                 dsicm_show_ulps, dsicm_store_ulps);
 565 static DEVICE_ATTR(ulps_timeout, S_IRUGO | S_IWUSR,
 566                 dsicm_show_ulps_timeout, dsicm_store_ulps_timeout);
 567
 568 static struct attribute *dsicm_attrs[] = {
 569         &dev_attr_num_dsi_errors.attr,
 570         &dev_attr_hw_revision.attr,
 571         &dev_attr_ulps.attr,
 572         &dev_attr_ulps_timeout.attr,
 573         NULL,
 574 };
 575
 576 static const struct attribute_group dsicm_attr_group = {
 577         .attrs = dsicm_attrs,
 578 };
 579
 580 static void dsicm_hw_reset(struct panel_drv_data *ddata)
 581 {
 582         gpiod_set_value(ddata->reset_gpio, 1);
 583         udelay(10);
 584         /* reset the panel */
 585         gpiod_set_value(ddata->reset_gpio, 0);
 586         /* assert reset */
 587         udelay(10);
 588         gpiod_set_value(ddata->reset_gpio, 1);
 589         /* wait after releasing reset */
 590         usleep_range(5000, 10000);
 591 }
 592
 593 static int dsicm_power_on(struct panel_drv_data *ddata)
 594 {
 595         struct omap_dss_device *src = ddata->src;
 596         u8 id1, id2, id3;
 597         int r;
 598         struct omap_dss_dsi_config dsi_config = {
 599                 .mode = OMAP_DSS_DSI_CMD_MODE,
 600                 .pixel_format = OMAP_DSS_DSI_FMT_RGB888,
 601                 .vm = &ddata->vm,
 602                 .hs_clk_min = 150000000,
 603                 .hs_clk_max = 300000000,
 604                 .lp_clk_min = 7000000,
 605                 .lp_clk_max = 10000000,
 606         };
 607
 608         if (ddata->vpnl) {
 609                 r = regulator_enable(ddata->vpnl);
 610                 if (r) {
 611                         dev_err(&ddata->pdev->dev,
 612                                 "failed to enable VPNL: %d\n", r);
 613                         return r;
 614                 }
 615         }
 616
 617         if (ddata->vddi) {
 618                 r = regulator_enable(ddata->vddi);
 619                 if (r) {
 620                         dev_err(&ddata->pdev->dev,
 621                                 "failed to enable VDDI: %d\n", r);
 622                         goto err_vpnl;
 623                 }
 624         }
 625
 626         if (ddata->pin_config.num_pins > 0) {
 627                 r = src->ops->dsi.configure_pins(src, &ddata->pin_config);
 628                 if (r) {
 629                         dev_err(&ddata->pdev->dev,
 630                                 "failed to configure DSI pins\n");
 631                         goto err_vddi;
 632                 }
 633         }
 634
 635         r = src->ops->dsi.set_config(src, &dsi_config);
 636         if (r) {
 637                 dev_err(&ddata->pdev->dev, "failed to configure DSI\n");
 638                 goto err_vddi;
 639         }
 640
 641         src->ops->enable(src);
 642
 643         dsicm_hw_reset(ddata);
 644
 645         src->ops->dsi.enable_hs(src, ddata->channel, false);
 646
 647         r = dsicm_sleep_out(ddata);
 648         if (r)
 649                 goto err;
 650
 651         r = dsicm_get_id(ddata, &id1, &id2, &id3);
 652         if (r)
 653                 goto err;
 654
 655         r = dsicm_dcs_write_1(ddata, DCS_BRIGHTNESS, 0xff);
 656         if (r)
 657                 goto err;
 658
 659         r = dsicm_dcs_write_1(ddata, DCS_CTRL_DISPLAY,
 660                         (1<<2) | (1<<5));       /* BL | BCTRL */
 661         if (r)
 662                 goto err;
 663
 664         r = dsicm_dcs_write_1(ddata, MIPI_DCS_SET_PIXEL_FORMAT,
 665                 MIPI_DCS_PIXEL_FMT_24BIT);
 666         if (r)
 667                 goto err;
 668
 669         r = dsicm_dcs_write_0(ddata, MIPI_DCS_SET_DISPLAY_ON);
 670         if (r)
 671                 goto err;
 672
 673         r = _dsicm_enable_te(ddata, ddata->te_enabled);
 674         if (r)
 675                 goto err;
 676
 677         r = src->ops->dsi.enable_video_output(src, ddata->channel);
 678         if (r)
 679                 goto err;
 680
 681         ddata->enabled = 1;
 682
 683         if (!ddata->intro_printed) {
 684                 dev_info(&ddata->pdev->dev, "panel revision %02x.%02x.%02x\n",
 685                         id1, id2, id3);
 686                 ddata->intro_printed = true;
 687         }
 688
 689         src->ops->dsi.enable_hs(src, ddata->channel, true);
 690
 691         return 0;
 692 err:
 693         dev_err(&ddata->pdev->dev, "error while enabling panel, issuing HW reset\n");
 694
 695         dsicm_hw_reset(ddata);
 696
 697         src->ops->dsi.disable(src, true, false);
 698 err_vddi:
 699         if (ddata->vddi)
 700                 regulator_disable(ddata->vddi);
 701 err_vpnl:
 702         if (ddata->vpnl)
 703                 regulator_disable(ddata->vpnl);
 704
 705         return r;
 706 }
 707
 708 static void dsicm_power_off(struct panel_drv_data *ddata)
 709 {
 710         struct omap_dss_device *src = ddata->src;
 711         int r;
 712
 713         src->ops->dsi.disable_video_output(src, ddata->channel);
 714
 715         r = dsicm_dcs_write_0(ddata, MIPI_DCS_SET_DISPLAY_OFF);
 716         if (!r)
 717                 r = dsicm_sleep_in(ddata);
 718
 719         if (r) {
 720                 dev_err(&ddata->pdev->dev,
 721                                 "error disabling panel, issuing HW reset\n");
 722                 dsicm_hw_reset(ddata);
 723         }
 724
 725         src->ops->dsi.disable(src, true, false);
 726
 727         if (ddata->vddi)
 728                 regulator_disable(ddata->vddi);
 729         if (ddata->vpnl)
 730                 regulator_disable(ddata->vpnl);
 731
 732         ddata->enabled = 0;
 733 }
 734
 735 static int dsicm_panel_reset(struct panel_drv_data *ddata)
 736 {
 737         dev_err(&ddata->pdev->dev, "performing LCD reset\n");
 738
 739         dsicm_power_off(ddata);
 740         dsicm_hw_reset(ddata);
 741         return dsicm_power_on(ddata);
 742 }
 743
 744 static int dsicm_connect(struct omap_dss_device *src,
 745                          struct omap_dss_device *dst)
 746 {
 747         struct panel_drv_data *ddata = to_panel_data(dst);
 748         struct device *dev = &ddata->pdev->dev;
 749         int r;
 750
 751         r = src->ops->dsi.request_vc(src, &ddata->channel);
 752         if (r) {
 753                 dev_err(dev, "failed to get virtual channel\n");
 754                 return r;
 755         }
 756
 757         r = src->ops->dsi.set_vc_id(src, ddata->channel, TCH);
 758         if (r) {
 759                 dev_err(dev, "failed to set VC_ID\n");
 760                 src->ops->dsi.release_vc(src, ddata->channel);
 761                 return r;
 762         }
 763
 764         ddata->src = src;
 765         return 0;
 766 }
 767
 768 static void dsicm_disconnect(struct omap_dss_device *src,
 769                              struct omap_dss_device *dst)
 770 {
 771         struct panel_drv_data *ddata = to_panel_data(dst);
 772
 773         src->ops->dsi.release_vc(src, ddata->channel);
 774         ddata->src = NULL;
 775 }
 776
 777 static void dsicm_enable(struct omap_dss_device *dssdev)
 778 {
 779         struct panel_drv_data *ddata = to_panel_data(dssdev);
 780         struct omap_dss_device *src = ddata->src;
 781         int r;
 782
 783         mutex_lock(&ddata->lock);
 784
 785         src->ops->dsi.bus_lock(src);
 786
 787         r = dsicm_power_on(ddata);
 788
 789         src->ops->dsi.bus_unlock(src);
 790
 791         if (r)
 792                 goto err;
 793
 794         mutex_unlock(&ddata->lock);
 795
 796         dsicm_bl_power(ddata, true);
 797
 798         return;
 799 err:
 800         dev_dbg(&ddata->pdev->dev, "enable failed (%d)\n", r);
 801         mutex_unlock(&ddata->lock);
 802 }
 803
 804 static void dsicm_disable(struct omap_dss_device *dssdev)
 805 {
 806         struct panel_drv_data *ddata = to_panel_data(dssdev);
 807         struct omap_dss_device *src = ddata->src;
 808         int r;
 809
 810         dsicm_bl_power(ddata, false);
 811
 812         mutex_lock(&ddata->lock);
 813
 814         dsicm_cancel_ulps_work(ddata);
 815
 816         src->ops->dsi.bus_lock(src);
 817
 818         r = dsicm_wake_up(ddata);
 819         if (!r)
 820                 dsicm_power_off(ddata);
 821
 822         src->ops->dsi.bus_unlock(src);
 823
 824         mutex_unlock(&ddata->lock);
 825 }
 826
 827 static void dsicm_framedone_cb(int err, void *data)
 828 {
 829         struct panel_drv_data *ddata = data;
 830         struct omap_dss_device *src = ddata->src;
 831
 832         dev_dbg(&ddata->pdev->dev, "framedone, err %d\n", err);
 833         src->ops->dsi.bus_unlock(src);
 834 }
 835
 836 static irqreturn_t dsicm_te_isr(int irq, void *data)
 837 {
 838         struct panel_drv_data *ddata = data;
 839         struct omap_dss_device *src = ddata->src;
 840         int old;
 841         int r;
 842
 843         old = atomic_cmpxchg(&ddata->do_update, 1, 0);
 844
 845         if (old) {
 846                 cancel_delayed_work(&ddata->te_timeout_work);
 847
 848                 r = src->ops->dsi.update(src, ddata->channel, dsicm_framedone_cb,
 849                                 ddata);
 850                 if (r)
 851                         goto err;
 852         }
 853
 854         return IRQ_HANDLED;
 855 err:
 856         dev_err(&ddata->pdev->dev, "start update failed\n");
 857         src->ops->dsi.bus_unlock(src);
 858         return IRQ_HANDLED;
 859 }
 860
 861 static void dsicm_te_timeout_work_callback(struct work_struct *work)
 862 {
 863         struct panel_drv_data *ddata = container_of(work, struct panel_drv_data,
 864                                         te_timeout_work.work);
 865         struct omap_dss_device *src = ddata->src;
 866
 867         dev_err(&ddata->pdev->dev, "TE not received for 250ms!\n");
 868
 869         atomic_set(&ddata->do_update, 0);
 870         src->ops->dsi.bus_unlock(src);
 871 }
 872
 873 static int dsicm_update(struct omap_dss_device *dssdev,
 874                                     u16 x, u16 y, u16 w, u16 h)
 875 {
 876         struct panel_drv_data *ddata = to_panel_data(dssdev);
 877         struct omap_dss_device *src = ddata->src;
 878         int r;
 879
 880         dev_dbg(&ddata->pdev->dev, "update %d, %d, %d x %d\n", x, y, w, h);
 881
 882         mutex_lock(&ddata->lock);
 883         src->ops->dsi.bus_lock(src);
 884
 885         r = dsicm_wake_up(ddata);
 886         if (r)
 887                 goto err;
 888
 889         if (!ddata->enabled) {
 890                 r = 0;
 891                 goto err;
 892         }
 893
 894         /* XXX no need to send this every frame, but dsi break if not done */
 895         r = dsicm_set_update_window(ddata, 0, 0, ddata->vm.hactive,
 896                                     ddata->vm.vactive);
 897         if (r)
 898                 goto err;
 899
 900         if (ddata->te_enabled && ddata->ext_te_gpio) {
 901                 schedule_delayed_work(&ddata->te_timeout_work,
 902                                 msecs_to_jiffies(250));
 903                 atomic_set(&ddata->do_update, 1);
 904         } else {
 905                 r = src->ops->dsi.update(src, ddata->channel, dsicm_framedone_cb,
 906                                 ddata);
 907                 if (r)
 908                         goto err;
 909         }
 910
 911         /* note: no bus_unlock here. unlock is src framedone_cb */
 912         mutex_unlock(&ddata->lock);
 913         return 0;
 914 err:
 915         src->ops->dsi.bus_unlock(src);
 916         mutex_unlock(&ddata->lock);
 917         return r;
 918 }
 919
 920 static int dsicm_sync(struct omap_dss_device *dssdev)
 921 {
 922         struct panel_drv_data *ddata = to_panel_data(dssdev);
 923         struct omap_dss_device *src = ddata->src;
 924
 925         dev_dbg(&ddata->pdev->dev, "sync\n");
 926
 927         mutex_lock(&ddata->lock);
 928         src->ops->dsi.bus_lock(src);
 929         src->ops->dsi.bus_unlock(src);
 930         mutex_unlock(&ddata->lock);
 931
 932         dev_dbg(&ddata->pdev->dev, "sync done\n");
 933
 934         return 0;
 935 }
 936
 937 static int _dsicm_enable_te(struct panel_drv_data *ddata, bool enable)
 938 {
 939         struct omap_dss_device *src = ddata->src;
 940         int r;
 941
 942         if (enable)
 943                 r = dsicm_dcs_write_1(ddata, MIPI_DCS_SET_TEAR_ON, 0);
 944         else
 945                 r = dsicm_dcs_write_0(ddata, MIPI_DCS_SET_TEAR_OFF);
 946
 947         if (!ddata->ext_te_gpio)
 948                 src->ops->dsi.enable_te(src, enable);
 949
 950         /* possible panel bug */
 951         msleep(100);
 952
 953         return r;
 954 }
 955
 956 static int dsicm_enable_te(struct omap_dss_device *dssdev, bool enable)
 957 {
 958         struct panel_drv_data *ddata = to_panel_data(dssdev);
 959         struct omap_dss_device *src = ddata->src;
 960         int r;
 961
 962         mutex_lock(&ddata->lock);
 963
 964         if (ddata->te_enabled == enable)
 965                 goto end;
 966
 967         src->ops->dsi.bus_lock(src);
 968
 969         if (ddata->enabled) {
 970                 r = dsicm_wake_up(ddata);
 971                 if (r)
 972                         goto err;
 973
 974                 r = _dsicm_enable_te(ddata, enable);
 975                 if (r)
 976                         goto err;
 977         }
 978
 979         ddata->te_enabled = enable;
 980
 981         src->ops->dsi.bus_unlock(src);
 982 end:
 983         mutex_unlock(&ddata->lock);
 984
 985         return 0;
 986 err:
 987         src->ops->dsi.bus_unlock(src);
 988         mutex_unlock(&ddata->lock);
 989
 990         return r;
 991 }
 992
 993 static int dsicm_get_te(struct omap_dss_device *dssdev)
 994 {
 995         struct panel_drv_data *ddata = to_panel_data(dssdev);
 996         int r;
 997
 998         mutex_lock(&ddata->lock);
 999         r = ddata->te_enabled;
1000         mutex_unlock(&ddata->lock);
1001
1002         return r;
1003 }
1004
1005 static int dsicm_memory_read(struct omap_dss_device *dssdev,
1006                 void *buf, size_t size,
1007                 u16 x, u16 y, u16 w, u16 h)
1008 {
1009         struct panel_drv_data *ddata = to_panel_data(dssdev);
1010         struct omap_dss_device *src = ddata->src;
1011         int r;
1012         int first = 1;
1013         int plen;
1014         unsigned int buf_used = 0;
1015
1016         if (size < w * h * 3)
1017                 return -ENOMEM;
1018
1019         mutex_lock(&ddata->lock);
1020
1021         if (!ddata->enabled) {
1022                 r = -ENODEV;
1023                 goto err1;
1024         }
1025
1026         size = min((u32)w * h * 3,
1027                    ddata->vm.hactive * ddata->vm.vactive * 3);
1028
1029         src->ops->dsi.bus_lock(src);
1030
1031         r = dsicm_wake_up(ddata);
1032         if (r)
1033                 goto err2;
1034
1035         /* plen 1 or 2 goes into short packet. until checksum error is fixed,
1036          * use short packets. plen 32 works, but bigger packets seem to cause
1037          * an error. */
1038         if (size % 2)
1039                 plen = 1;
1040         else
1041                 plen = 2;
1042
1043         dsicm_set_update_window(ddata, x, y, w, h);
1044
1045         r = src->ops->dsi.set_max_rx_packet_size(src, ddata->channel, plen);
1046         if (r)
1047                 goto err2;
1048
1049         while (buf_used < size) {
1050                 u8 dcs_cmd = first ? 0x2e : 0x3e;
1051                 first = 0;
1052
1053                 r = src->ops->dsi.dcs_read(src, ddata->channel, dcs_cmd,
1054                                 buf + buf_used, size - buf_used);
1055
1056                 if (r < 0) {
1057                         dev_err(dssdev->dev, "read error\n");
1058                         goto err3;
1059                 }
1060
1061                 buf_used += r;
1062
1063                 if (r < plen) {
1064                         dev_err(&ddata->pdev->dev, "short read\n");
1065                         break;
1066                 }
1067
1068                 if (signal_pending(current)) {
1069                         dev_err(&ddata->pdev->dev, "signal pending, "
1070                                         "aborting memory read\n");
1071                         r = -ERESTARTSYS;
1072                         goto err3;
1073                 }
1074         }
1075
1076         r = buf_used;
1077
1078 err3:
1079         src->ops->dsi.set_max_rx_packet_size(src, ddata->channel, 1);
1080 err2:
1081         src->ops->dsi.bus_unlock(src);
1082 err1:
1083         mutex_unlock(&ddata->lock);
1084         return r;
1085 }
1086
1087 static void dsicm_ulps_work(struct work_struct *work)
1088 {
1089         struct panel_drv_data *ddata = container_of(work, struct panel_drv_data,
1090                         ulps_work.work);
1091         struct omap_dss_device *dssdev = &ddata->dssdev;
1092         struct omap_dss_device *src = ddata->src;
1093
1094         mutex_lock(&ddata->lock);
1095
1096         if (dssdev->state != OMAP_DSS_DISPLAY_ACTIVE || !ddata->enabled) {
1097                 mutex_unlock(&ddata->lock);
1098                 return;
1099         }
1100
1101         src->ops->dsi.bus_lock(src);
1102
1103         dsicm_enter_ulps(ddata);
1104
1105         src->ops->dsi.bus_unlock(src);
1106         mutex_unlock(&ddata->lock);
1107 }
1108
1109 static int dsicm_get_modes(struct omap_dss_device *dssdev,
1110                            struct drm_connector *connector)
1111 {
1112         struct panel_drv_data *ddata = to_panel_data(dssdev);
1113
1114         connector->display_info.width_mm = ddata->width_mm;
1115         connector->display_info.height_mm = ddata->height_mm;
1116
1117         return omapdss_display_get_modes(connector, &ddata->vm);
1118 }
1119
1120 static int dsicm_check_timings(struct omap_dss_device *dssdev,
1121                                struct drm_display_mode *mode)
1122 {
1123         struct panel_drv_data *ddata = to_panel_data(dssdev);
1124         int ret = 0;
1125
1126         if (mode->hdisplay != ddata->vm.hactive)
1127                 ret = -EINVAL;
1128
1129         if (mode->vdisplay != ddata->vm.vactive)
1130                 ret = -EINVAL;
1131
1132         if (ret) {
1133                 dev_warn(dssdev->dev, "wrong resolution: %d x %d",
1134                          mode->hdisplay, mode->vdisplay);
1135                 dev_warn(dssdev->dev, "panel resolution: %d x %d",
1136                          ddata->vm.hactive, ddata->vm.vactive);
1137         }
1138
1139         return ret;
1140 }
1141
1142 static const struct omap_dss_device_ops dsicm_ops = {
1143         .connect        = dsicm_connect,
1144         .disconnect     = dsicm_disconnect,
1145
1146         .enable         = dsicm_enable,
1147         .disable        = dsicm_disable,
1148
1149         .get_modes      = dsicm_get_modes,
1150         .check_timings  = dsicm_check_timings,
1151 };
1152
1153 static const struct omap_dss_driver dsicm_dss_driver = {
1154         .update         = dsicm_update,
1155         .sync           = dsicm_sync,
1156
1157         .enable_te      = dsicm_enable_te,
1158         .get_te         = dsicm_get_te,
1159
1160         .memory_read    = dsicm_memory_read,
1161 };
1162
1163 static int dsicm_probe_of(struct platform_device *pdev)
1164 {
1165         struct device_node *node = pdev->dev.of_node;
1166         struct device_node *backlight;
1167         struct panel_drv_data *ddata = platform_get_drvdata(pdev);
1168         struct display_timing timing;
1169         int err;
1170
1171         ddata->reset_gpio = devm_gpiod_get(&pdev->dev, "reset", GPIOD_OUT_LOW);
1172         if (IS_ERR(ddata->reset_gpio)) {
1173                 err = PTR_ERR(ddata->reset_gpio);
1174                 dev_err(&pdev->dev, "reset gpio request failed: %d", err);
1175                 return err;
1176         }
1177
1178         ddata->ext_te_gpio = devm_gpiod_get_optional(&pdev->dev, "te",
1179                                                      GPIOD_IN);
1180         if (IS_ERR(ddata->ext_te_gpio)) {
1181                 err = PTR_ERR(ddata->ext_te_gpio);
1182                 dev_err(&pdev->dev, "TE gpio request failed: %d", err);
1183                 return err;
1184         }
1185
1186         err = of_get_display_timing(node, "panel-timing", &timing);
1187         if (!err) {
1188                 videomode_from_timing(&timing, &ddata->vm);
1189                 if (!ddata->vm.pixelclock)
1190                         ddata->vm.pixelclock =
1191                                 ddata->vm.hactive * ddata->vm.vactive * 60;
1192         } else {
1193                 dev_warn(&pdev->dev,
1194                          "failed to get video timing, using defaults\n");
1195         }
1196
1197         ddata->width_mm = 0;
1198         of_property_read_u32(node, "width-mm", &ddata->width_mm);
1199
1200         ddata->height_mm = 0;
1201         of_property_read_u32(node, "height-mm", &ddata->height_mm);
1202
1203         ddata->vpnl = devm_regulator_get_optional(&pdev->dev, "vpnl");
1204         if (IS_ERR(ddata->vpnl)) {
1205                 err = PTR_ERR(ddata->vpnl);
1206                 if (err == -EPROBE_DEFER)
1207                         return err;
1208                 ddata->vpnl = NULL;
1209         }
1210
1211         ddata->vddi = devm_regulator_get_optional(&pdev->dev, "vddi");
1212         if (IS_ERR(ddata->vddi)) {
1213                 err = PTR_ERR(ddata->vddi);
1214                 if (err == -EPROBE_DEFER)
1215                         return err;
1216                 ddata->vddi = NULL;
1217         }
1218
1219         backlight = of_parse_phandle(node, "backlight", 0);
1220         if (backlight) {
1221                 ddata->extbldev = of_find_backlight_by_node(backlight);
1222                 of_node_put(backlight);
1223
1224                 if (!ddata->extbldev)
1225                         return -EPROBE_DEFER;
1226         } else {
1227                 /* assume native backlight support */
1228                 ddata->use_dsi_backlight = true;
1229         }
1230
1231         /* TODO: ulps */
1232
1233         return 0;
1234 }
1235
1236 static int dsicm_probe(struct platform_device *pdev)
1237 {
1238         struct panel_drv_data *ddata;
1239         struct backlight_device *bldev = NULL;
1240         struct device *dev = &pdev->dev;
1241         struct omap_dss_device *dssdev;
1242         int r;
1243
1244         dev_dbg(dev, "probe\n");
1245
1246         ddata = devm_kzalloc(dev, sizeof(*ddata), GFP_KERNEL);
1247         if (!ddata)
1248                 return -ENOMEM;
1249
1250         platform_set_drvdata(pdev, ddata);
1251         ddata->pdev = pdev;
1252
1253         ddata->vm.hactive = 864;
1254         ddata->vm.vactive = 480;
1255         ddata->vm.pixelclock = 864 * 480 * 60;
1256
1257         r = dsicm_probe_of(pdev);
1258         if (r)
1259                 return r;
1260
1261         dssdev = &ddata->dssdev;
1262         dssdev->dev = dev;
1263         dssdev->ops = &dsicm_ops;
1264         dssdev->driver = &dsicm_dss_driver;
1265         dssdev->type = OMAP_DISPLAY_TYPE_DSI;
1266         dssdev->display = true;
1267         dssdev->owner = THIS_MODULE;
1268         dssdev->of_ports = BIT(0);
1269         dssdev->ops_flags = OMAP_DSS_DEVICE_OP_MODES;
1270
1271         dssdev->caps = OMAP_DSS_DISPLAY_CAP_MANUAL_UPDATE |
1272                 OMAP_DSS_DISPLAY_CAP_TEAR_ELIM;
1273
1274         omapdss_display_init(dssdev);
1275         omapdss_device_register(dssdev);
1276
1277         mutex_init(&ddata->lock);
1278
1279         atomic_set(&ddata->do_update, 0);
1280
1281         if (ddata->ext_te_gpio) {
1282                 r = devm_request_irq(dev, gpiod_to_irq(ddata->ext_te_gpio),
1283                                 dsicm_te_isr,
1284                                 IRQF_TRIGGER_RISING,
1285                                 "taal vsync", ddata);
1286
1287                 if (r) {
1288                         dev_err(dev, "IRQ request failed\n");
1289                         goto err_reg;
1290                 }
1291
1292                 INIT_DEFERRABLE_WORK(&ddata->te_timeout_work,
1293                                         dsicm_te_timeout_work_callback);
1294
1295                 dev_dbg(dev, "Using GPIO TE\n");
1296         }
1297
1298         ddata->workqueue = create_singlethread_workqueue("dsicm_wq");
1299         if (!ddata->workqueue) {
1300                 r = -ENOMEM;
1301                 goto err_reg;
1302         }
1303         INIT_DELAYED_WORK(&ddata->ulps_work, dsicm_ulps_work);
1304
1305         dsicm_hw_reset(ddata);
1306
1307         if (ddata->use_dsi_backlight) {
1308                 struct backlight_properties props = { 0 };
1309                 props.max_brightness = 255;
1310                 props.type = BACKLIGHT_RAW;
1311
1312                 bldev = devm_backlight_device_register(dev, dev_name(dev),
1313                         dev, ddata, &dsicm_bl_ops, &props);
1314                 if (IS_ERR(bldev)) {
1315                         r = PTR_ERR(bldev);
1316                         goto err_bl;
1317                 }
1318
1319                 ddata->bldev = bldev;
1320         }
1321
1322         r = sysfs_create_group(&dev->kobj, &dsicm_attr_group);
1323         if (r) {
1324                 dev_err(dev, "failed to create sysfs files\n");
1325                 goto err_bl;
1326         }
1327
1328         return 0;
1329
1330 err_bl:
1331         destroy_workqueue(ddata->workqueue);
1332 err_reg:
1333         if (ddata->extbldev)
1334                 put_device(&ddata->extbldev->dev);
1335
1336         return r;
1337 }
1338
1339 static int __exit dsicm_remove(struct platform_device *pdev)
1340 {
1341         struct panel_drv_data *ddata = platform_get_drvdata(pdev);
1342         struct omap_dss_device *dssdev = &ddata->dssdev;
1343
1344         dev_dbg(&pdev->dev, "remove\n");
1345
1346         omapdss_device_unregister(dssdev);
1347
1348         if (omapdss_device_is_enabled(dssdev))
1349                 dsicm_disable(dssdev);
1350         omapdss_device_disconnect(ddata->src, dssdev);
1351
1352         sysfs_remove_group(&pdev->dev.kobj, &dsicm_attr_group);
1353
1354         if (ddata->extbldev)
1355                 put_device(&ddata->extbldev->dev);
1356
1357         dsicm_cancel_ulps_work(ddata);
1358         destroy_workqueue(ddata->workqueue);
1359
1360         /* reset, to be sure that the panel is in a valid state */
1361         dsicm_hw_reset(ddata);
1362
1363         return 0;
1364 }
1365
1366 static const struct of_device_id dsicm_of_match[] = {
1367         { .compatible = "omapdss,panel-dsi-cm", },
1368         {},
1369 };
1370
1371 MODULE_DEVICE_TABLE(of, dsicm_of_match);
1372
1373 static struct platform_driver dsicm_driver = {
1374         .probe = dsicm_probe,
1375         .remove = __exit_p(dsicm_remove),
1376         .driver = {
1377                 .name = "panel-dsi-cm",
1378                 .of_match_table = dsicm_of_match,
1379                 .suppress_bind_attrs = true,
1380         },
1381 };
1382
1383 module_platform_driver(dsicm_driver);
1384
1385 MODULE_AUTHOR("Tomi Valkeinen <tomi.valkeinen@ti.com>");
1386 MODULE_DESCRIPTION("Generic DSI Command Mode Panel Driver");
1387 MODULE_LICENSE("GPL");