2 * Support for ACX565AKM LCD Panel used on Nokia N900
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>
33 #include <video/omapdss.h>
35 #define MIPID_CMD_READ_DISP_ID 0x04
36 #define MIPID_CMD_READ_RED 0x06
37 #define MIPID_CMD_READ_GREEN 0x07
38 #define MIPID_CMD_READ_BLUE 0x08
39 #define MIPID_CMD_READ_DISP_STATUS 0x09
40 #define MIPID_CMD_RDDSDR 0x0F
41 #define MIPID_CMD_SLEEP_IN 0x10
42 #define MIPID_CMD_SLEEP_OUT 0x11
43 #define MIPID_CMD_DISP_OFF 0x28
44 #define MIPID_CMD_DISP_ON 0x29
45 #define MIPID_CMD_WRITE_DISP_BRIGHTNESS 0x51
46 #define MIPID_CMD_READ_DISP_BRIGHTNESS 0x52
47 #define MIPID_CMD_WRITE_CTRL_DISP 0x53
49 #define CTRL_DISP_BRIGHTNESS_CTRL_ON (1 << 5)
50 #define CTRL_DISP_AMBIENT_LIGHT_CTRL_ON (1 << 4)
51 #define CTRL_DISP_BACKLIGHT_ON (1 << 2)
52 #define CTRL_DISP_AUTO_BRIGHTNESS_ON (1 << 1)
54 #define MIPID_CMD_READ_CTRL_DISP 0x54
55 #define MIPID_CMD_WRITE_CABC 0x55
56 #define MIPID_CMD_READ_CABC 0x56
58 #define MIPID_VER_LPH8923 3
59 #define MIPID_VER_LS041Y3 4
60 #define MIPID_VER_L4F00311 8
61 #define MIPID_VER_ACX565AKM 9
63 struct acx565akm_device
{
72 unsigned long hw_guard_end
; /* next value of jiffies
74 next sleep in/out command */
75 unsigned long hw_guard_wait
; /* max guard time in jiffies */
77 struct spi_device
*spi
;
80 struct omap_dss_device
*dssdev
;
81 struct backlight_device
*bl_dev
;
84 static struct acx565akm_device acx_dev
;
85 static int acx565akm_bl_update_status(struct backlight_device
*dev
);
87 /*--------------------MIPID interface-----------------------------*/
89 static void acx565akm_transfer(struct acx565akm_device
*md
, int cmd
,
90 const u8
*wbuf
, int wlen
, u8
*rbuf
, int rlen
)
93 struct spi_transfer
*x
, xfer
[5];
96 BUG_ON(md
->spi
== NULL
);
100 memset(xfer
, 0, sizeof(xfer
));
105 x
->bits_per_word
= 9;
108 if (rlen
> 1 && wlen
== 0) {
110 * Between the command and the response data there is a
111 * dummy clock cycle. Add an extra bit after the command
112 * word to account for this.
114 x
->bits_per_word
= 10;
117 spi_message_add_tail(x
, &m
);
123 x
->bits_per_word
= 9;
124 spi_message_add_tail(x
, &m
);
131 spi_message_add_tail(x
, &m
);
134 r
= spi_sync(md
->spi
, &m
);
136 dev_dbg(&md
->spi
->dev
, "spi_sync %d\n", r
);
139 static inline void acx565akm_cmd(struct acx565akm_device
*md
, int cmd
)
141 acx565akm_transfer(md
, cmd
, NULL
, 0, NULL
, 0);
144 static inline void acx565akm_write(struct acx565akm_device
*md
,
145 int reg
, const u8
*buf
, int len
)
147 acx565akm_transfer(md
, reg
, buf
, len
, NULL
, 0);
150 static inline void acx565akm_read(struct acx565akm_device
*md
,
151 int reg
, u8
*buf
, int len
)
153 acx565akm_transfer(md
, reg
, NULL
, 0, buf
, len
);
156 static void hw_guard_start(struct acx565akm_device
*md
, int guard_msec
)
158 md
->hw_guard_wait
= msecs_to_jiffies(guard_msec
);
159 md
->hw_guard_end
= jiffies
+ md
->hw_guard_wait
;
162 static void hw_guard_wait(struct acx565akm_device
*md
)
164 unsigned long wait
= md
->hw_guard_end
- jiffies
;
166 if ((long)wait
> 0 && wait
<= md
->hw_guard_wait
) {
167 set_current_state(TASK_UNINTERRUPTIBLE
);
168 schedule_timeout(wait
);
172 /*----------------------MIPID wrappers----------------------------*/
174 static void set_sleep_mode(struct acx565akm_device
*md
, int on
)
179 cmd
= MIPID_CMD_SLEEP_IN
;
181 cmd
= MIPID_CMD_SLEEP_OUT
;
183 * We have to keep 120msec between sleep in/out commands.
187 acx565akm_cmd(md
, cmd
);
188 hw_guard_start(md
, 120);
191 static void set_display_state(struct acx565akm_device
*md
, int enabled
)
193 int cmd
= enabled
? MIPID_CMD_DISP_ON
: MIPID_CMD_DISP_OFF
;
195 acx565akm_cmd(md
, cmd
);
198 static int panel_enabled(struct acx565akm_device
*md
)
203 acx565akm_read(md
, MIPID_CMD_READ_DISP_STATUS
, (u8
*)&disp_status
, 4);
204 disp_status
= __be32_to_cpu(disp_status
);
205 enabled
= (disp_status
& (1 << 17)) && (disp_status
& (1 << 10));
206 dev_dbg(&md
->spi
->dev
,
207 "LCD panel %senabled by bootloader (status 0x%04x)\n",
208 enabled
? "" : "not ", disp_status
);
212 static int panel_detect(struct acx565akm_device
*md
)
214 acx565akm_read(md
, MIPID_CMD_READ_DISP_ID
, md
->display_id
, 3);
215 dev_dbg(&md
->spi
->dev
, "MIPI display ID: %02x%02x%02x\n",
216 md
->display_id
[0], md
->display_id
[1], md
->display_id
[2]);
218 switch (md
->display_id
[0]) {
220 md
->model
= MIPID_VER_ACX565AKM
;
221 md
->name
= "acx565akm";
226 md
->model
= MIPID_VER_L4F00311
;
227 md
->name
= "l4f00311";
230 md
->model
= MIPID_VER_LPH8923
;
231 md
->name
= "lph8923";
234 md
->model
= MIPID_VER_LS041Y3
;
235 md
->name
= "ls041y3";
238 md
->name
= "unknown";
239 dev_err(&md
->spi
->dev
, "invalid display ID\n");
243 md
->revision
= md
->display_id
[1];
245 dev_info(&md
->spi
->dev
, "omapfb: %s rev %02x LCD detected\n",
246 md
->name
, md
->revision
);
251 /*----------------------Backlight Control-------------------------*/
253 static void enable_backlight_ctrl(struct acx565akm_device
*md
, int enable
)
257 acx565akm_read(md
, MIPID_CMD_READ_CTRL_DISP
, (u8
*)&ctrl
, 1);
259 ctrl
|= CTRL_DISP_BRIGHTNESS_CTRL_ON
|
260 CTRL_DISP_BACKLIGHT_ON
;
262 ctrl
&= ~(CTRL_DISP_BRIGHTNESS_CTRL_ON
|
263 CTRL_DISP_BACKLIGHT_ON
);
267 acx565akm_write(md
, MIPID_CMD_WRITE_CTRL_DISP
, (u8
*)&ctrl
, 2);
270 static void set_cabc_mode(struct acx565akm_device
*md
, unsigned mode
)
274 md
->cabc_mode
= mode
;
278 acx565akm_read(md
, MIPID_CMD_READ_CABC
, (u8
*)&cabc_ctrl
, 1);
280 cabc_ctrl
|= (1 << 8) | (mode
& 3);
281 acx565akm_write(md
, MIPID_CMD_WRITE_CABC
, (u8
*)&cabc_ctrl
, 2);
284 static unsigned get_cabc_mode(struct acx565akm_device
*md
)
286 return md
->cabc_mode
;
289 static unsigned get_hw_cabc_mode(struct acx565akm_device
*md
)
293 acx565akm_read(md
, MIPID_CMD_READ_CABC
, &cabc_ctrl
, 1);
294 return cabc_ctrl
& 3;
297 static void acx565akm_set_brightness(struct acx565akm_device
*md
, int level
)
301 bv
= level
| (1 << 8);
302 acx565akm_write(md
, MIPID_CMD_WRITE_DISP_BRIGHTNESS
, (u8
*)&bv
, 2);
305 enable_backlight_ctrl(md
, 1);
307 enable_backlight_ctrl(md
, 0);
310 static int acx565akm_get_actual_brightness(struct acx565akm_device
*md
)
314 acx565akm_read(md
, MIPID_CMD_READ_DISP_BRIGHTNESS
, &bv
, 1);
320 static int acx565akm_bl_update_status(struct backlight_device
*dev
)
322 struct acx565akm_device
*md
= dev_get_drvdata(&dev
->dev
);
326 dev_dbg(&md
->spi
->dev
, "%s\n", __func__
);
328 mutex_lock(&md
->mutex
);
330 if (dev
->props
.fb_blank
== FB_BLANK_UNBLANK
&&
331 dev
->props
.power
== FB_BLANK_UNBLANK
)
332 level
= dev
->props
.brightness
;
338 acx565akm_set_brightness(md
, level
);
339 else if (md
->dssdev
->set_backlight
)
340 r
= md
->dssdev
->set_backlight(md
->dssdev
, level
);
344 mutex_unlock(&md
->mutex
);
349 static int acx565akm_bl_get_intensity(struct backlight_device
*dev
)
351 struct acx565akm_device
*md
= dev_get_drvdata(&dev
->dev
);
353 dev_dbg(&dev
->dev
, "%s\n", __func__
);
355 if (!md
->has_bc
&& md
->dssdev
->set_backlight
== NULL
)
358 if (dev
->props
.fb_blank
== FB_BLANK_UNBLANK
&&
359 dev
->props
.power
== FB_BLANK_UNBLANK
) {
361 return acx565akm_get_actual_brightness(md
);
363 return dev
->props
.brightness
;
369 static const struct backlight_ops acx565akm_bl_ops
= {
370 .get_brightness
= acx565akm_bl_get_intensity
,
371 .update_status
= acx565akm_bl_update_status
,
374 /*--------------------Auto Brightness control via Sysfs---------------------*/
376 static const char *cabc_modes
[] = {
377 "off", /* always used when CABC is not supported */
383 static ssize_t
show_cabc_mode(struct device
*dev
,
384 struct device_attribute
*attr
,
387 struct acx565akm_device
*md
= dev_get_drvdata(dev
);
388 const char *mode_str
;
395 mode
= get_cabc_mode(md
);
396 mode_str
= "unknown";
397 if (mode
>= 0 && mode
< ARRAY_SIZE(cabc_modes
))
398 mode_str
= cabc_modes
[mode
];
399 len
= snprintf(buf
, PAGE_SIZE
, "%s\n", mode_str
);
401 return len
< PAGE_SIZE
- 1 ? len
: PAGE_SIZE
- 1;
404 static ssize_t
store_cabc_mode(struct device
*dev
,
405 struct device_attribute
*attr
,
406 const char *buf
, size_t count
)
408 struct acx565akm_device
*md
= dev_get_drvdata(dev
);
411 for (i
= 0; i
< ARRAY_SIZE(cabc_modes
); i
++) {
412 const char *mode_str
= cabc_modes
[i
];
413 int cmp_len
= strlen(mode_str
);
415 if (count
> 0 && buf
[count
- 1] == '\n')
417 if (count
!= cmp_len
)
420 if (strncmp(buf
, mode_str
, cmp_len
) == 0)
424 if (i
== ARRAY_SIZE(cabc_modes
))
427 if (!md
->has_cabc
&& i
!= 0)
430 mutex_lock(&md
->mutex
);
431 set_cabc_mode(md
, i
);
432 mutex_unlock(&md
->mutex
);
437 static ssize_t
show_cabc_available_modes(struct device
*dev
,
438 struct device_attribute
*attr
,
441 struct acx565akm_device
*md
= dev_get_drvdata(dev
);
446 return snprintf(buf
, PAGE_SIZE
, "%s\n", cabc_modes
[0]);
449 len
< PAGE_SIZE
&& i
< ARRAY_SIZE(cabc_modes
); i
++)
450 len
+= snprintf(&buf
[len
], PAGE_SIZE
- len
, "%s%s%s",
451 i
? " " : "", cabc_modes
[i
],
452 i
== ARRAY_SIZE(cabc_modes
) - 1 ? "\n" : "");
454 return len
< PAGE_SIZE
? len
: PAGE_SIZE
- 1;
457 static DEVICE_ATTR(cabc_mode
, S_IRUGO
| S_IWUSR
,
458 show_cabc_mode
, store_cabc_mode
);
459 static DEVICE_ATTR(cabc_available_modes
, S_IRUGO
,
460 show_cabc_available_modes
, NULL
);
462 static struct attribute
*bldev_attrs
[] = {
463 &dev_attr_cabc_mode
.attr
,
464 &dev_attr_cabc_available_modes
.attr
,
468 static struct attribute_group bldev_attr_group
= {
469 .attrs
= bldev_attrs
,
473 /*---------------------------ACX Panel----------------------------*/
475 static int acx_get_recommended_bpp(struct omap_dss_device
*dssdev
)
480 static struct omap_video_timings acx_panel_timings
= {
483 .pixel_clock
= 24000,
492 static int acx_panel_probe(struct omap_dss_device
*dssdev
)
495 struct acx565akm_device
*md
= &acx_dev
;
496 struct backlight_device
*bldev
;
497 int max_brightness
, brightness
;
498 struct backlight_properties props
;
500 dev_dbg(&dssdev
->dev
, "%s\n", __func__
);
501 dssdev
->panel
.config
= OMAP_DSS_LCD_TFT
| OMAP_DSS_LCD_IVS
|
503 /* FIXME AC bias ? */
504 dssdev
->panel
.timings
= acx_panel_timings
;
506 if (dssdev
->platform_enable
)
507 dssdev
->platform_enable(dssdev
);
509 * After reset we have to wait 5 msec before the first
510 * command can be sent.
514 md
->enabled
= panel_enabled(md
);
516 r
= panel_detect(md
);
518 dev_err(&dssdev
->dev
, "%s panel detect error\n", __func__
);
519 if (!md
->enabled
&& dssdev
->platform_disable
)
520 dssdev
->platform_disable(dssdev
);
524 mutex_lock(&acx_dev
.mutex
);
525 acx_dev
.dssdev
= dssdev
;
526 mutex_unlock(&acx_dev
.mutex
);
529 if (dssdev
->platform_disable
)
530 dssdev
->platform_disable(dssdev
);
533 /*------- Backlight control --------*/
535 props
.fb_blank
= FB_BLANK_UNBLANK
;
536 props
.power
= FB_BLANK_UNBLANK
;
537 props
.type
= BACKLIGHT_RAW
;
539 bldev
= backlight_device_register("acx565akm", &md
->spi
->dev
,
540 md
, &acx565akm_bl_ops
, &props
);
543 r
= sysfs_create_group(&bldev
->dev
.kobj
, &bldev_attr_group
);
546 "%s failed to create sysfs files\n", __func__
);
547 backlight_device_unregister(bldev
);
550 md
->cabc_mode
= get_hw_cabc_mode(md
);
554 max_brightness
= 255;
556 max_brightness
= dssdev
->max_backlight_level
;
559 brightness
= acx565akm_get_actual_brightness(md
);
560 else if (dssdev
->get_backlight
)
561 brightness
= dssdev
->get_backlight(dssdev
);
565 bldev
->props
.max_brightness
= max_brightness
;
566 bldev
->props
.brightness
= brightness
;
568 acx565akm_bl_update_status(bldev
);
572 static void acx_panel_remove(struct omap_dss_device
*dssdev
)
574 struct acx565akm_device
*md
= &acx_dev
;
576 dev_dbg(&dssdev
->dev
, "%s\n", __func__
);
577 sysfs_remove_group(&md
->bl_dev
->dev
.kobj
, &bldev_attr_group
);
578 backlight_device_unregister(md
->bl_dev
);
579 mutex_lock(&acx_dev
.mutex
);
580 acx_dev
.dssdev
= NULL
;
581 mutex_unlock(&acx_dev
.mutex
);
584 static int acx_panel_power_on(struct omap_dss_device
*dssdev
)
586 struct acx565akm_device
*md
= &acx_dev
;
589 dev_dbg(&dssdev
->dev
, "%s\n", __func__
);
591 if (dssdev
->state
== OMAP_DSS_DISPLAY_ACTIVE
)
594 mutex_lock(&md
->mutex
);
596 r
= omapdss_sdi_display_enable(dssdev
);
598 pr_err("%s sdi enable failed\n", __func__
);
605 if (dssdev
->platform_enable
) {
606 r
= dssdev
->platform_enable(dssdev
);
612 dev_dbg(&md
->spi
->dev
, "panel already enabled\n");
613 mutex_unlock(&md
->mutex
);
618 * We have to meet all the following delay requirements:
619 * 1. tRW: reset pulse width 10usec (7.12.1)
620 * 2. tRT: reset cancel time 5msec (7.12.1)
621 * 3. Providing PCLK,HS,VS signals for 2 frames = ~50msec worst
623 * 4. 120msec before the sleep out command (7.12.1)
627 set_sleep_mode(md
, 0);
630 /* 5msec between sleep out and the next command. (8.2.16) */
632 set_display_state(md
, 1);
633 set_cabc_mode(md
, md
->cabc_mode
);
635 mutex_unlock(&md
->mutex
);
637 return acx565akm_bl_update_status(md
->bl_dev
);
639 omapdss_sdi_display_disable(dssdev
);
641 mutex_unlock(&md
->mutex
);
645 static void acx_panel_power_off(struct omap_dss_device
*dssdev
)
647 struct acx565akm_device
*md
= &acx_dev
;
649 dev_dbg(&dssdev
->dev
, "%s\n", __func__
);
651 if (dssdev
->state
!= OMAP_DSS_DISPLAY_ACTIVE
)
654 mutex_lock(&md
->mutex
);
657 mutex_unlock(&md
->mutex
);
660 set_display_state(md
, 0);
661 set_sleep_mode(md
, 1);
664 * We have to provide PCLK,HS,VS signals for 2 frames (worst case
665 * ~50msec) after sending the sleep in command and asserting the
666 * reset signal. We probably could assert the reset w/o the delay
667 * but we still delay to avoid possible artifacts. (7.6.1)
671 if (dssdev
->platform_disable
)
672 dssdev
->platform_disable(dssdev
);
674 /* FIXME need to tweak this delay */
677 omapdss_sdi_display_disable(dssdev
);
679 mutex_unlock(&md
->mutex
);
682 static int acx_panel_enable(struct omap_dss_device
*dssdev
)
686 dev_dbg(&dssdev
->dev
, "%s\n", __func__
);
687 r
= acx_panel_power_on(dssdev
);
692 dssdev
->state
= OMAP_DSS_DISPLAY_ACTIVE
;
696 static void acx_panel_disable(struct omap_dss_device
*dssdev
)
698 dev_dbg(&dssdev
->dev
, "%s\n", __func__
);
699 acx_panel_power_off(dssdev
);
700 dssdev
->state
= OMAP_DSS_DISPLAY_DISABLED
;
703 static int acx_panel_suspend(struct omap_dss_device
*dssdev
)
705 dev_dbg(&dssdev
->dev
, "%s\n", __func__
);
706 acx_panel_power_off(dssdev
);
707 dssdev
->state
= OMAP_DSS_DISPLAY_SUSPENDED
;
711 static int acx_panel_resume(struct omap_dss_device
*dssdev
)
715 dev_dbg(&dssdev
->dev
, "%s\n", __func__
);
716 r
= acx_panel_power_on(dssdev
);
720 dssdev
->state
= OMAP_DSS_DISPLAY_ACTIVE
;
724 static void acx_panel_set_timings(struct omap_dss_device
*dssdev
,
725 struct omap_video_timings
*timings
)
729 if (dssdev
->state
== OMAP_DSS_DISPLAY_ACTIVE
)
730 omapdss_sdi_display_disable(dssdev
);
732 dssdev
->panel
.timings
= *timings
;
734 if (dssdev
->state
== OMAP_DSS_DISPLAY_ACTIVE
) {
735 r
= omapdss_sdi_display_enable(dssdev
);
737 dev_err(&dssdev
->dev
, "%s enable failed\n", __func__
);
741 static void acx_panel_get_timings(struct omap_dss_device
*dssdev
,
742 struct omap_video_timings
*timings
)
744 *timings
= dssdev
->panel
.timings
;
747 static int acx_panel_check_timings(struct omap_dss_device
*dssdev
,
748 struct omap_video_timings
*timings
)
754 static struct omap_dss_driver acx_panel_driver
= {
755 .probe
= acx_panel_probe
,
756 .remove
= acx_panel_remove
,
758 .enable
= acx_panel_enable
,
759 .disable
= acx_panel_disable
,
760 .suspend
= acx_panel_suspend
,
761 .resume
= acx_panel_resume
,
763 .set_timings
= acx_panel_set_timings
,
764 .get_timings
= acx_panel_get_timings
,
765 .check_timings
= acx_panel_check_timings
,
767 .get_recommended_bpp
= acx_get_recommended_bpp
,
770 .name
= "panel-acx565akm",
771 .owner
= THIS_MODULE
,
775 /*--------------------SPI probe-------------------------*/
777 static int acx565akm_spi_probe(struct spi_device
*spi
)
779 struct acx565akm_device
*md
= &acx_dev
;
781 dev_dbg(&spi
->dev
, "%s\n", __func__
);
783 spi
->mode
= SPI_MODE_3
;
785 mutex_init(&md
->mutex
);
786 dev_set_drvdata(&spi
->dev
, md
);
788 omap_dss_register_driver(&acx_panel_driver
);
793 static int acx565akm_spi_remove(struct spi_device
*spi
)
795 struct acx565akm_device
*md
= dev_get_drvdata(&spi
->dev
);
797 dev_dbg(&md
->spi
->dev
, "%s\n", __func__
);
798 omap_dss_unregister_driver(&acx_panel_driver
);
803 static struct spi_driver acx565akm_spi_driver
= {
806 .owner
= THIS_MODULE
,
808 .probe
= acx565akm_spi_probe
,
809 .remove
= __devexit_p(acx565akm_spi_remove
),
812 static int __init
acx565akm_init(void)
814 return spi_register_driver(&acx565akm_spi_driver
);
817 static void __exit
acx565akm_exit(void)
819 spi_unregister_driver(&acx565akm_spi_driver
);
822 module_init(acx565akm_init
);
823 module_exit(acx565akm_exit
);
825 MODULE_AUTHOR("Nokia Corporation");
826 MODULE_DESCRIPTION("acx565akm LCD Driver");
827 MODULE_LICENSE("GPL");