2 * Sony ACX565AKM LCD Panel driver
4 * Copyright (C) 2010 Nokia Corporation
6 * Original Driver Author: Imre Deak <imre.deak@nokia.com>
7 * Based on panel-generic.c by Tomi Valkeinen <tomi.valkeinen@nokia.com>
8 * Adapted to new DSS2 framework: Roger Quadros <roger.quadros@nokia.com>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License version 2 as published by
12 * the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
19 * You should have received a copy of the GNU General Public License along with
20 * this program. If not, see <http://www.gnu.org/licenses/>.
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/platform_device.h>
26 #include <linux/delay.h>
27 #include <linux/spi/spi.h>
28 #include <linux/jiffies.h>
29 #include <linux/sched.h>
30 #include <linux/backlight.h>
32 #include <linux/gpio.h>
34 #include <video/omapdss.h>
35 #include <video/omap-panel-data.h>
37 #define MIPID_CMD_READ_DISP_ID 0x04
38 #define MIPID_CMD_READ_RED 0x06
39 #define MIPID_CMD_READ_GREEN 0x07
40 #define MIPID_CMD_READ_BLUE 0x08
41 #define MIPID_CMD_READ_DISP_STATUS 0x09
42 #define MIPID_CMD_RDDSDR 0x0F
43 #define MIPID_CMD_SLEEP_IN 0x10
44 #define MIPID_CMD_SLEEP_OUT 0x11
45 #define MIPID_CMD_DISP_OFF 0x28
46 #define MIPID_CMD_DISP_ON 0x29
47 #define MIPID_CMD_WRITE_DISP_BRIGHTNESS 0x51
48 #define MIPID_CMD_READ_DISP_BRIGHTNESS 0x52
49 #define MIPID_CMD_WRITE_CTRL_DISP 0x53
51 #define CTRL_DISP_BRIGHTNESS_CTRL_ON (1 << 5)
52 #define CTRL_DISP_AMBIENT_LIGHT_CTRL_ON (1 << 4)
53 #define CTRL_DISP_BACKLIGHT_ON (1 << 2)
54 #define CTRL_DISP_AUTO_BRIGHTNESS_ON (1 << 1)
56 #define MIPID_CMD_READ_CTRL_DISP 0x54
57 #define MIPID_CMD_WRITE_CABC 0x55
58 #define MIPID_CMD_READ_CABC 0x56
60 #define MIPID_VER_LPH8923 3
61 #define MIPID_VER_LS041Y3 4
62 #define MIPID_VER_L4F00311 8
63 #define MIPID_VER_ACX565AKM 9
65 struct panel_drv_data {
66 struct omap_dss_device dssdev;
67 struct omap_dss_device *in;
72 struct omap_video_timings videomode;
82 unsigned long hw_guard_end; /* next value of jiffies
84 next sleep in/out command */
85 unsigned long hw_guard_wait; /* max guard time in jiffies */
87 struct spi_device *spi;
90 struct backlight_device *bl_dev;
93 static const struct omap_video_timings acx565akm_panel_timings = {
104 .vsync_level = OMAPDSS_SIG_ACTIVE_LOW,
105 .hsync_level = OMAPDSS_SIG_ACTIVE_LOW,
107 .data_pclk_edge = OMAPDSS_DRIVE_SIG_RISING_EDGE,
108 .de_level = OMAPDSS_SIG_ACTIVE_HIGH,
109 .sync_pclk_edge = OMAPDSS_DRIVE_SIG_OPPOSITE_EDGES,
112 #define to_panel_data(p) container_of(p, struct panel_drv_data, dssdev)
114 static void acx565akm_transfer(struct panel_drv_data *ddata, int cmd,
115 const u8 *wbuf, int wlen, u8 *rbuf, int rlen)
117 struct spi_message m;
118 struct spi_transfer *x, xfer[5];
121 BUG_ON(ddata->spi == NULL);
123 spi_message_init(&m);
125 memset(xfer, 0, sizeof(xfer));
130 x->bits_per_word = 9;
133 if (rlen > 1 && wlen == 0) {
135 * Between the command and the response data there is a
136 * dummy clock cycle. Add an extra bit after the command
137 * word to account for this.
139 x->bits_per_word = 10;
142 spi_message_add_tail(x, &m);
148 x->bits_per_word = 9;
149 spi_message_add_tail(x, &m);
156 spi_message_add_tail(x, &m);
159 r = spi_sync(ddata->spi, &m);
161 dev_dbg(&ddata->spi->dev, "spi_sync %d\n", r);
164 static inline void acx565akm_cmd(struct panel_drv_data *ddata, int cmd)
166 acx565akm_transfer(ddata, cmd, NULL, 0, NULL, 0);
169 static inline void acx565akm_write(struct panel_drv_data *ddata,
170 int reg, const u8 *buf, int len)
172 acx565akm_transfer(ddata, reg, buf, len, NULL, 0);
175 static inline void acx565akm_read(struct panel_drv_data *ddata,
176 int reg, u8 *buf, int len)
178 acx565akm_transfer(ddata, reg, NULL, 0, buf, len);
181 static void hw_guard_start(struct panel_drv_data *ddata, int guard_msec)
183 ddata->hw_guard_wait = msecs_to_jiffies(guard_msec);
184 ddata->hw_guard_end = jiffies + ddata->hw_guard_wait;
187 static void hw_guard_wait(struct panel_drv_data *ddata)
189 unsigned long wait = ddata->hw_guard_end - jiffies;
191 if ((long)wait > 0 && wait <= ddata->hw_guard_wait) {
192 set_current_state(TASK_UNINTERRUPTIBLE);
193 schedule_timeout(wait);
197 static void set_sleep_mode(struct panel_drv_data *ddata, int on)
202 cmd = MIPID_CMD_SLEEP_IN;
204 cmd = MIPID_CMD_SLEEP_OUT;
206 * We have to keep 120msec between sleep in/out commands.
209 hw_guard_wait(ddata);
210 acx565akm_cmd(ddata, cmd);
211 hw_guard_start(ddata, 120);
214 static void set_display_state(struct panel_drv_data *ddata, int enabled)
216 int cmd = enabled ? MIPID_CMD_DISP_ON : MIPID_CMD_DISP_OFF;
218 acx565akm_cmd(ddata, cmd);
221 static int panel_enabled(struct panel_drv_data *ddata)
226 acx565akm_read(ddata, MIPID_CMD_READ_DISP_STATUS,
227 (u8 *)&disp_status, 4);
228 disp_status = __be32_to_cpu(disp_status);
229 enabled = (disp_status & (1 << 17)) && (disp_status & (1 << 10));
230 dev_dbg(&ddata->spi->dev,
231 "LCD panel %senabled by bootloader (status 0x%04x)\n",
232 enabled ? "" : "not ", disp_status);
236 static int panel_detect(struct panel_drv_data *ddata)
238 acx565akm_read(ddata, MIPID_CMD_READ_DISP_ID, ddata->display_id, 3);
239 dev_dbg(&ddata->spi->dev, "MIPI display ID: %02x%02x%02x\n",
240 ddata->display_id[0],
241 ddata->display_id[1],
242 ddata->display_id[2]);
244 switch (ddata->display_id[0]) {
246 ddata->model = MIPID_VER_ACX565AKM;
247 ddata->name = "acx565akm";
252 ddata->model = MIPID_VER_L4F00311;
253 ddata->name = "l4f00311";
256 ddata->model = MIPID_VER_LPH8923;
257 ddata->name = "lph8923";
260 ddata->model = MIPID_VER_LS041Y3;
261 ddata->name = "ls041y3";
264 ddata->name = "unknown";
265 dev_err(&ddata->spi->dev, "invalid display ID\n");
269 ddata->revision = ddata->display_id[1];
271 dev_info(&ddata->spi->dev, "omapfb: %s rev %02x LCD detected\n",
272 ddata->name, ddata->revision);
277 /*----------------------Backlight Control-------------------------*/
279 static void enable_backlight_ctrl(struct panel_drv_data *ddata, int enable)
283 acx565akm_read(ddata, MIPID_CMD_READ_CTRL_DISP, (u8 *)&ctrl, 1);
285 ctrl |= CTRL_DISP_BRIGHTNESS_CTRL_ON |
286 CTRL_DISP_BACKLIGHT_ON;
288 ctrl &= ~(CTRL_DISP_BRIGHTNESS_CTRL_ON |
289 CTRL_DISP_BACKLIGHT_ON);
293 acx565akm_write(ddata, MIPID_CMD_WRITE_CTRL_DISP, (u8 *)&ctrl, 2);
296 static void set_cabc_mode(struct panel_drv_data *ddata, unsigned mode)
300 ddata->cabc_mode = mode;
304 acx565akm_read(ddata, MIPID_CMD_READ_CABC, (u8 *)&cabc_ctrl, 1);
306 cabc_ctrl |= (1 << 8) | (mode & 3);
307 acx565akm_write(ddata, MIPID_CMD_WRITE_CABC, (u8 *)&cabc_ctrl, 2);
310 static unsigned get_cabc_mode(struct panel_drv_data *ddata)
312 return ddata->cabc_mode;
315 static unsigned get_hw_cabc_mode(struct panel_drv_data *ddata)
319 acx565akm_read(ddata, MIPID_CMD_READ_CABC, &cabc_ctrl, 1);
320 return cabc_ctrl & 3;
323 static void acx565akm_set_brightness(struct panel_drv_data *ddata, int level)
327 bv = level | (1 << 8);
328 acx565akm_write(ddata, MIPID_CMD_WRITE_DISP_BRIGHTNESS, (u8 *)&bv, 2);
331 enable_backlight_ctrl(ddata, 1);
333 enable_backlight_ctrl(ddata, 0);
336 static int acx565akm_get_actual_brightness(struct panel_drv_data *ddata)
340 acx565akm_read(ddata, MIPID_CMD_READ_DISP_BRIGHTNESS, &bv, 1);
346 static int acx565akm_bl_update_status(struct backlight_device *dev)
348 struct panel_drv_data *ddata = dev_get_drvdata(&dev->dev);
352 dev_dbg(&ddata->spi->dev, "%s\n", __func__);
354 mutex_lock(&ddata->mutex);
356 if (dev->props.fb_blank == FB_BLANK_UNBLANK &&
357 dev->props.power == FB_BLANK_UNBLANK)
358 level = dev->props.brightness;
364 acx565akm_set_brightness(ddata, level);
368 mutex_unlock(&ddata->mutex);
373 static int acx565akm_bl_get_intensity(struct backlight_device *dev)
375 struct panel_drv_data *ddata = dev_get_drvdata(&dev->dev);
377 dev_dbg(&dev->dev, "%s\n", __func__);
382 if (dev->props.fb_blank == FB_BLANK_UNBLANK &&
383 dev->props.power == FB_BLANK_UNBLANK) {
385 return acx565akm_get_actual_brightness(ddata);
387 return dev->props.brightness;
393 static const struct backlight_ops acx565akm_bl_ops = {
394 .get_brightness = acx565akm_bl_get_intensity,
395 .update_status = acx565akm_bl_update_status,
398 /*--------------------Auto Brightness control via Sysfs---------------------*/
400 static const char * const cabc_modes[] = {
401 "off", /* always used when CABC is not supported */
407 static ssize_t show_cabc_mode(struct device *dev,
408 struct device_attribute *attr,
411 struct panel_drv_data *ddata = dev_get_drvdata(dev);
412 const char *mode_str;
416 if (!ddata->has_cabc)
419 mode = get_cabc_mode(ddata);
420 mode_str = "unknown";
421 if (mode >= 0 && mode < ARRAY_SIZE(cabc_modes))
422 mode_str = cabc_modes[mode];
423 len = snprintf(buf, PAGE_SIZE, "%s\n", mode_str);
425 return len < PAGE_SIZE - 1 ? len : PAGE_SIZE - 1;
428 static ssize_t store_cabc_mode(struct device *dev,
429 struct device_attribute *attr,
430 const char *buf, size_t count)
432 struct panel_drv_data *ddata = dev_get_drvdata(dev);
435 for (i = 0; i < ARRAY_SIZE(cabc_modes); i++) {
436 const char *mode_str = cabc_modes[i];
437 int cmp_len = strlen(mode_str);
439 if (count > 0 && buf[count - 1] == '\n')
441 if (count != cmp_len)
444 if (strncmp(buf, mode_str, cmp_len) == 0)
448 if (i == ARRAY_SIZE(cabc_modes))
451 if (!ddata->has_cabc && i != 0)
454 mutex_lock(&ddata->mutex);
455 set_cabc_mode(ddata, i);
456 mutex_unlock(&ddata->mutex);
461 static ssize_t show_cabc_available_modes(struct device *dev,
462 struct device_attribute *attr,
465 struct panel_drv_data *ddata = dev_get_drvdata(dev);
469 if (!ddata->has_cabc)
470 return snprintf(buf, PAGE_SIZE, "%s\n", cabc_modes[0]);
473 len < PAGE_SIZE && i < ARRAY_SIZE(cabc_modes); i++)
474 len += snprintf(&buf[len], PAGE_SIZE - len, "%s%s%s",
475 i ? " " : "", cabc_modes[i],
476 i == ARRAY_SIZE(cabc_modes) - 1 ? "\n" : "");
478 return len < PAGE_SIZE ? len : PAGE_SIZE - 1;
481 static DEVICE_ATTR(cabc_mode, S_IRUGO | S_IWUSR,
482 show_cabc_mode, store_cabc_mode);
483 static DEVICE_ATTR(cabc_available_modes, S_IRUGO,
484 show_cabc_available_modes, NULL);
486 static struct attribute *bldev_attrs[] = {
487 &dev_attr_cabc_mode.attr,
488 &dev_attr_cabc_available_modes.attr,
492 static struct attribute_group bldev_attr_group = {
493 .attrs = bldev_attrs,
496 static int acx565akm_connect(struct omap_dss_device *dssdev)
498 struct panel_drv_data *ddata = to_panel_data(dssdev);
499 struct omap_dss_device *in = ddata->in;
502 if (omapdss_device_is_connected(dssdev))
505 r = in->ops.sdi->connect(in, dssdev);
512 static void acx565akm_disconnect(struct omap_dss_device *dssdev)
514 struct panel_drv_data *ddata = to_panel_data(dssdev);
515 struct omap_dss_device *in = ddata->in;
517 if (!omapdss_device_is_connected(dssdev))
520 in->ops.sdi->disconnect(in, dssdev);
523 static int acx565akm_panel_power_on(struct omap_dss_device *dssdev)
525 struct panel_drv_data *ddata = to_panel_data(dssdev);
526 struct omap_dss_device *in = ddata->in;
529 dev_dbg(&ddata->spi->dev, "%s\n", __func__);
531 in->ops.sdi->set_timings(in, &ddata->videomode);
532 in->ops.sdi->set_datapairs(in, ddata->datapairs);
534 r = in->ops.sdi->enable(in);
536 pr_err("%s sdi enable failed\n", __func__);
543 if (gpio_is_valid(ddata->reset_gpio))
544 gpio_set_value(ddata->reset_gpio, 1);
546 if (ddata->enabled) {
547 dev_dbg(&ddata->spi->dev, "panel already enabled\n");
552 * We have to meet all the following delay requirements:
553 * 1. tRW: reset pulse width 10usec (7.12.1)
554 * 2. tRT: reset cancel time 5msec (7.12.1)
555 * 3. Providing PCLK,HS,VS signals for 2 frames = ~50msec worst
557 * 4. 120msec before the sleep out command (7.12.1)
561 set_sleep_mode(ddata, 0);
564 /* 5msec between sleep out and the next command. (8.2.16) */
565 usleep_range(5000, 10000);
566 set_display_state(ddata, 1);
567 set_cabc_mode(ddata, ddata->cabc_mode);
569 mutex_unlock(&ddata->mutex);
571 return acx565akm_bl_update_status(ddata->bl_dev);
574 static void acx565akm_panel_power_off(struct omap_dss_device *dssdev)
576 struct panel_drv_data *ddata = to_panel_data(dssdev);
577 struct omap_dss_device *in = ddata->in;
579 dev_dbg(dssdev->dev, "%s\n", __func__);
584 set_display_state(ddata, 0);
585 set_sleep_mode(ddata, 1);
588 * We have to provide PCLK,HS,VS signals for 2 frames (worst case
589 * ~50msec) after sending the sleep in command and asserting the
590 * reset signal. We probably could assert the reset w/o the delay
591 * but we still delay to avoid possible artifacts. (7.6.1)
595 if (gpio_is_valid(ddata->reset_gpio))
596 gpio_set_value(ddata->reset_gpio, 0);
598 /* FIXME need to tweak this delay */
601 in->ops.sdi->disable(in);
604 static int acx565akm_enable(struct omap_dss_device *dssdev)
606 struct panel_drv_data *ddata = to_panel_data(dssdev);
609 dev_dbg(dssdev->dev, "%s\n", __func__);
611 if (!omapdss_device_is_connected(dssdev))
614 if (omapdss_device_is_enabled(dssdev))
617 mutex_lock(&ddata->mutex);
618 r = acx565akm_panel_power_on(dssdev);
619 mutex_unlock(&ddata->mutex);
624 dssdev->state = OMAP_DSS_DISPLAY_ACTIVE;
629 static void acx565akm_disable(struct omap_dss_device *dssdev)
631 struct panel_drv_data *ddata = to_panel_data(dssdev);
633 dev_dbg(dssdev->dev, "%s\n", __func__);
635 if (!omapdss_device_is_enabled(dssdev))
638 mutex_lock(&ddata->mutex);
639 acx565akm_panel_power_off(dssdev);
640 mutex_unlock(&ddata->mutex);
642 dssdev->state = OMAP_DSS_DISPLAY_DISABLED;
645 static void acx565akm_set_timings(struct omap_dss_device *dssdev,
646 struct omap_video_timings *timings)
648 struct panel_drv_data *ddata = to_panel_data(dssdev);
649 struct omap_dss_device *in = ddata->in;
651 ddata->videomode = *timings;
652 dssdev->panel.timings = *timings;
654 in->ops.sdi->set_timings(in, timings);
657 static void acx565akm_get_timings(struct omap_dss_device *dssdev,
658 struct omap_video_timings *timings)
660 struct panel_drv_data *ddata = to_panel_data(dssdev);
662 *timings = ddata->videomode;
665 static int acx565akm_check_timings(struct omap_dss_device *dssdev,
666 struct omap_video_timings *timings)
668 struct panel_drv_data *ddata = to_panel_data(dssdev);
669 struct omap_dss_device *in = ddata->in;
671 return in->ops.sdi->check_timings(in, timings);
674 static struct omap_dss_driver acx565akm_ops = {
675 .connect = acx565akm_connect,
676 .disconnect = acx565akm_disconnect,
678 .enable = acx565akm_enable,
679 .disable = acx565akm_disable,
681 .set_timings = acx565akm_set_timings,
682 .get_timings = acx565akm_get_timings,
683 .check_timings = acx565akm_check_timings,
685 .get_resolution = omapdss_default_get_resolution,
688 static int acx565akm_probe_pdata(struct spi_device *spi)
690 const struct panel_acx565akm_platform_data *pdata;
691 struct panel_drv_data *ddata = dev_get_drvdata(&spi->dev);
692 struct omap_dss_device *dssdev, *in;
694 pdata = dev_get_platdata(&spi->dev);
696 ddata->reset_gpio = pdata->reset_gpio;
698 in = omap_dss_find_output(pdata->source);
700 dev_err(&spi->dev, "failed to find video source '%s'\n",
702 return -EPROBE_DEFER;
706 ddata->datapairs = pdata->datapairs;
708 dssdev = &ddata->dssdev;
709 dssdev->name = pdata->name;
714 static int acx565akm_probe(struct spi_device *spi)
716 struct panel_drv_data *ddata;
717 struct omap_dss_device *dssdev;
718 struct backlight_device *bldev;
719 int max_brightness, brightness;
720 struct backlight_properties props;
723 dev_dbg(&spi->dev, "%s\n", __func__);
725 spi->mode = SPI_MODE_3;
727 ddata = devm_kzalloc(&spi->dev, sizeof(*ddata), GFP_KERNEL);
731 dev_set_drvdata(&spi->dev, ddata);
735 mutex_init(&ddata->mutex);
737 if (dev_get_platdata(&spi->dev)) {
738 r = acx565akm_probe_pdata(spi);
745 if (gpio_is_valid(ddata->reset_gpio)) {
746 r = devm_gpio_request_one(&spi->dev, ddata->reset_gpio,
747 GPIOF_OUT_INIT_LOW, "lcd reset");
752 if (gpio_is_valid(ddata->reset_gpio))
753 gpio_set_value(ddata->reset_gpio, 1);
756 * After reset we have to wait 5 msec before the first
757 * command can be sent.
759 usleep_range(5000, 10000);
761 ddata->enabled = panel_enabled(ddata);
763 r = panel_detect(ddata);
765 if (!ddata->enabled && gpio_is_valid(ddata->reset_gpio))
766 gpio_set_value(ddata->reset_gpio, 0);
769 dev_err(&spi->dev, "%s panel detect error\n", __func__);
773 memset(&props, 0, sizeof(props));
774 props.fb_blank = FB_BLANK_UNBLANK;
775 props.power = FB_BLANK_UNBLANK;
776 props.type = BACKLIGHT_RAW;
778 bldev = backlight_device_register("acx565akm", &ddata->spi->dev,
779 ddata, &acx565akm_bl_ops, &props);
780 ddata->bl_dev = bldev;
781 if (ddata->has_cabc) {
782 r = sysfs_create_group(&bldev->dev.kobj, &bldev_attr_group);
785 "%s failed to create sysfs files\n", __func__);
788 ddata->cabc_mode = get_hw_cabc_mode(ddata);
791 max_brightness = 255;
794 brightness = acx565akm_get_actual_brightness(ddata);
798 bldev->props.max_brightness = max_brightness;
799 bldev->props.brightness = brightness;
801 acx565akm_bl_update_status(bldev);
804 ddata->videomode = acx565akm_panel_timings;
806 dssdev = &ddata->dssdev;
807 dssdev->dev = &spi->dev;
808 dssdev->driver = &acx565akm_ops;
809 dssdev->type = OMAP_DISPLAY_TYPE_SDI;
810 dssdev->owner = THIS_MODULE;
811 dssdev->panel.timings = ddata->videomode;
813 r = omapdss_register_display(dssdev);
815 dev_err(&spi->dev, "Failed to register panel\n");
822 sysfs_remove_group(&bldev->dev.kobj, &bldev_attr_group);
824 backlight_device_unregister(bldev);
827 omap_dss_put_device(ddata->in);
831 static int acx565akm_remove(struct spi_device *spi)
833 struct panel_drv_data *ddata = dev_get_drvdata(&spi->dev);
834 struct omap_dss_device *dssdev = &ddata->dssdev;
835 struct omap_dss_device *in = ddata->in;
837 dev_dbg(&ddata->spi->dev, "%s\n", __func__);
839 sysfs_remove_group(&ddata->bl_dev->dev.kobj, &bldev_attr_group);
840 backlight_device_unregister(ddata->bl_dev);
842 omapdss_unregister_display(dssdev);
844 acx565akm_disable(dssdev);
845 acx565akm_disconnect(dssdev);
847 omap_dss_put_device(in);
852 static struct spi_driver acx565akm_driver = {
855 .owner = THIS_MODULE,
857 .probe = acx565akm_probe,
858 .remove = acx565akm_remove,
861 module_spi_driver(acx565akm_driver);
863 MODULE_AUTHOR("Nokia Corporation");
864 MODULE_DESCRIPTION("acx565akm LCD Driver");
865 MODULE_LICENSE("GPL");