2 * LCD driver for MIPI DBI-C / DCS compatible LCDs
4 * Copyright (C) 2006 Nokia Corporation
5 * Author: Imre Deak <imre.deak@nokia.com>
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2 of the License, or (at your
10 * option) any later version.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 #include <linux/device.h>
22 #include <linux/delay.h>
23 #include <linux/workqueue.h>
24 #include <linux/spi/spi.h>
26 #include <plat/lcd_mipid.h>
30 #define MIPID_MODULE_NAME "lcd_mipid"
32 #define MIPID_CMD_READ_DISP_ID 0x04
33 #define MIPID_CMD_READ_RED 0x06
34 #define MIPID_CMD_READ_GREEN 0x07
35 #define MIPID_CMD_READ_BLUE 0x08
36 #define MIPID_CMD_READ_DISP_STATUS 0x09
37 #define MIPID_CMD_RDDSDR 0x0F
38 #define MIPID_CMD_SLEEP_IN 0x10
39 #define MIPID_CMD_SLEEP_OUT 0x11
40 #define MIPID_CMD_DISP_OFF 0x28
41 #define MIPID_CMD_DISP_ON 0x29
43 #define MIPID_ESD_CHECK_PERIOD msecs_to_jiffies(5000)
45 #define to_mipid_device(p) container_of(p, struct mipid_device, \
50 unsigned int saved_bklight_level;
51 unsigned long hw_guard_end; /* next value of jiffies
53 next sleep in/out command */
54 unsigned long hw_guard_wait; /* max guard time in jiffies */
56 struct omapfb_device *fbdev;
57 struct spi_device *spi;
59 struct lcd_panel panel;
61 struct workqueue_struct *esd_wq;
62 struct delayed_work esd_work;
63 void (*esd_check)(struct mipid_device *m);
66 static void mipid_transfer(struct mipid_device *md, int cmd, const u8 *wbuf,
67 int wlen, u8 *rbuf, int rlen)
70 struct spi_transfer *x, xfer[4];
74 BUG_ON(md->spi == NULL);
78 memset(xfer, 0, sizeof(xfer));
85 spi_message_add_tail(x, &m);
92 spi_message_add_tail(x, &m);
99 spi_message_add_tail(x, &m);
102 /* Arrange for the extra clock before the first
105 x->bits_per_word = 9;
109 x->rx_buf = &rbuf[1];
111 spi_message_add_tail(x, &m);
115 r = spi_sync(md->spi, &m);
117 dev_dbg(&md->spi->dev, "spi_sync %d\n", r);
123 static inline void mipid_cmd(struct mipid_device *md, int cmd)
125 mipid_transfer(md, cmd, NULL, 0, NULL, 0);
128 static inline void mipid_write(struct mipid_device *md,
129 int reg, const u8 *buf, int len)
131 mipid_transfer(md, reg, buf, len, NULL, 0);
134 static inline void mipid_read(struct mipid_device *md,
135 int reg, u8 *buf, int len)
137 mipid_transfer(md, reg, NULL, 0, buf, len);
140 static void set_data_lines(struct mipid_device *md, int data_lines)
144 switch (data_lines) {
155 mipid_write(md, 0x3a, (u8 *)&par, 2);
158 static void send_init_string(struct mipid_device *md)
160 u16 initpar[] = { 0x0102, 0x0100, 0x0100 };
162 mipid_write(md, 0xc2, (u8 *)initpar, sizeof(initpar));
163 set_data_lines(md, md->panel.data_lines);
166 static void hw_guard_start(struct mipid_device *md, int guard_msec)
168 md->hw_guard_wait = msecs_to_jiffies(guard_msec);
169 md->hw_guard_end = jiffies + md->hw_guard_wait;
172 static void hw_guard_wait(struct mipid_device *md)
174 unsigned long wait = md->hw_guard_end - jiffies;
176 if ((long)wait > 0 && wait <= md->hw_guard_wait) {
177 set_current_state(TASK_UNINTERRUPTIBLE);
178 schedule_timeout(wait);
182 static void set_sleep_mode(struct mipid_device *md, int on)
184 int cmd, sleep_time = 50;
187 cmd = MIPID_CMD_SLEEP_IN;
189 cmd = MIPID_CMD_SLEEP_OUT;
192 hw_guard_start(md, 120);
194 * When we enable the panel, it seems we _have_ to sleep
195 * 120 ms before sending the init string. When disabling the
196 * panel we'll sleep for the duration of 2 frames, so that the
197 * controller can still provide the PCLK,HS,VS signals.
204 static void set_display_state(struct mipid_device *md, int enabled)
206 int cmd = enabled ? MIPID_CMD_DISP_ON : MIPID_CMD_DISP_OFF;
211 static int mipid_set_bklight_level(struct lcd_panel *panel, unsigned int level)
213 struct mipid_device *md = to_mipid_device(panel);
214 struct mipid_platform_data *pd = md->spi->dev.platform_data;
216 if (pd->get_bklight_max == NULL || pd->set_bklight_level == NULL)
218 if (level > pd->get_bklight_max(pd))
221 md->saved_bklight_level = level;
224 pd->set_bklight_level(pd, level);
229 static unsigned int mipid_get_bklight_level(struct lcd_panel *panel)
231 struct mipid_device *md = to_mipid_device(panel);
232 struct mipid_platform_data *pd = md->spi->dev.platform_data;
234 if (pd->get_bklight_level == NULL)
236 return pd->get_bklight_level(pd);
239 static unsigned int mipid_get_bklight_max(struct lcd_panel *panel)
241 struct mipid_device *md = to_mipid_device(panel);
242 struct mipid_platform_data *pd = md->spi->dev.platform_data;
244 if (pd->get_bklight_max == NULL)
247 return pd->get_bklight_max(pd);
250 static unsigned long mipid_get_caps(struct lcd_panel *panel)
252 return OMAPFB_CAPS_SET_BACKLIGHT;
255 static u16 read_first_pixel(struct mipid_device *md)
260 mutex_lock(&md->mutex);
261 mipid_read(md, MIPID_CMD_READ_RED, &red, 1);
262 mipid_read(md, MIPID_CMD_READ_GREEN, &green, 1);
263 mipid_read(md, MIPID_CMD_READ_BLUE, &blue, 1);
264 mutex_unlock(&md->mutex);
266 switch (md->panel.data_lines) {
268 pixel = ((red >> 1) << 11) | (green << 5) | (blue >> 1);
271 /* 24 bit -> 16 bit */
272 pixel = ((red >> 3) << 11) | ((green >> 2) << 5) |
283 static int mipid_run_test(struct lcd_panel *panel, int test_num)
285 struct mipid_device *md = to_mipid_device(panel);
286 static const u16 test_values[4] = {
287 0x0000, 0xffff, 0xaaaa, 0x5555,
291 if (test_num != MIPID_TEST_RGB_LINES)
292 return MIPID_TEST_INVALID;
294 for (i = 0; i < ARRAY_SIZE(test_values); i++) {
298 omapfb_write_first_pixel(md->fbdev, test_values[i]);
299 tmo = jiffies + msecs_to_jiffies(100);
305 pixel = read_first_pixel(md);
306 if (pixel == test_values[i])
308 if (time_after(jiffies, tmo)) {
309 dev_err(&md->spi->dev,
310 "MIPI LCD RGB I/F test failed: "
311 "expecting %04x, got %04x\n",
312 test_values[i], pixel);
313 return MIPID_TEST_FAILED;
322 static void ls041y3_esd_recover(struct mipid_device *md)
324 dev_err(&md->spi->dev, "performing LCD ESD recovery\n");
325 set_sleep_mode(md, 1);
326 set_sleep_mode(md, 0);
329 static void ls041y3_esd_check_mode1(struct mipid_device *md)
333 mipid_read(md, MIPID_CMD_RDDSDR, &state1, 1);
334 set_sleep_mode(md, 0);
335 mipid_read(md, MIPID_CMD_RDDSDR, &state2, 1);
336 dev_dbg(&md->spi->dev, "ESD mode 1 state1 %02x state2 %02x\n",
338 /* Each sleep out command will trigger a self diagnostic and flip
339 * Bit6 if the test passes.
341 if (!((state1 ^ state2) & (1 << 6)))
342 ls041y3_esd_recover(md);
345 static void ls041y3_esd_check_mode2(struct mipid_device *md)
349 static const struct {
353 } *rd, rd_ctrl[7] = {
354 { 0xb0, 4, { 0x0101, 0x01fe, } },
355 { 0xb1, 4, { 0x01de, 0x0121, } },
356 { 0xc2, 4, { 0x0100, 0x0100, } },
357 { 0xbd, 2, { 0x0100, } },
358 { 0xc2, 4, { 0x01fc, 0x0103, } },
364 for (i = 0; i < 3; i++, rd++)
365 mipid_write(md, rd->cmd, (u8 *)rd->wbuf, rd->wlen);
368 mipid_read(md, rd->cmd, rbuf, 2);
371 for (i = 0; i < 3; i++, rd++) {
373 mipid_write(md, rd->cmd, (u8 *)rd->wbuf, rd->wlen);
376 dev_dbg(&md->spi->dev, "ESD mode 2 state %02x\n", rbuf[1]);
378 ls041y3_esd_recover(md);
381 static void ls041y3_esd_check(struct mipid_device *md)
383 ls041y3_esd_check_mode1(md);
384 if (md->revision >= 0x88)
385 ls041y3_esd_check_mode2(md);
388 static void mipid_esd_start_check(struct mipid_device *md)
390 if (md->esd_check != NULL)
391 queue_delayed_work(md->esd_wq, &md->esd_work,
392 MIPID_ESD_CHECK_PERIOD);
395 static void mipid_esd_stop_check(struct mipid_device *md)
397 if (md->esd_check != NULL)
398 cancel_rearming_delayed_workqueue(md->esd_wq, &md->esd_work);
401 static void mipid_esd_work(struct work_struct *work)
403 struct mipid_device *md = container_of(work, struct mipid_device,
406 mutex_lock(&md->mutex);
408 mutex_unlock(&md->mutex);
409 mipid_esd_start_check(md);
412 static int mipid_enable(struct lcd_panel *panel)
414 struct mipid_device *md = to_mipid_device(panel);
416 mutex_lock(&md->mutex);
419 mutex_unlock(&md->mutex);
422 set_sleep_mode(md, 0);
424 send_init_string(md);
425 set_display_state(md, 1);
426 mipid_set_bklight_level(panel, md->saved_bklight_level);
427 mipid_esd_start_check(md);
429 mutex_unlock(&md->mutex);
433 static void mipid_disable(struct lcd_panel *panel)
435 struct mipid_device *md = to_mipid_device(panel);
438 * A final ESD work might be called before returning,
439 * so do this without holding the lock.
441 mipid_esd_stop_check(md);
442 mutex_lock(&md->mutex);
445 mutex_unlock(&md->mutex);
448 md->saved_bklight_level = mipid_get_bklight_level(panel);
449 mipid_set_bklight_level(panel, 0);
450 set_display_state(md, 0);
451 set_sleep_mode(md, 1);
454 mutex_unlock(&md->mutex);
457 static int panel_enabled(struct mipid_device *md)
462 mipid_read(md, MIPID_CMD_READ_DISP_STATUS, (u8 *)&disp_status, 4);
463 disp_status = __be32_to_cpu(disp_status);
464 enabled = (disp_status & (1 << 17)) && (disp_status & (1 << 10));
465 dev_dbg(&md->spi->dev,
466 "LCD panel %senabled by bootloader (status 0x%04x)\n",
467 enabled ? "" : "not ", disp_status);
471 static int mipid_init(struct lcd_panel *panel,
472 struct omapfb_device *fbdev)
474 struct mipid_device *md = to_mipid_device(panel);
477 md->esd_wq = create_singlethread_workqueue("mipid_esd");
478 if (md->esd_wq == NULL) {
479 dev_err(&md->spi->dev, "can't create ESD workqueue\n");
482 INIT_DELAYED_WORK(&md->esd_work, mipid_esd_work);
483 mutex_init(&md->mutex);
485 md->enabled = panel_enabled(md);
488 mipid_esd_start_check(md);
490 md->saved_bklight_level = mipid_get_bklight_level(panel);
495 static void mipid_cleanup(struct lcd_panel *panel)
497 struct mipid_device *md = to_mipid_device(panel);
500 mipid_esd_stop_check(md);
501 destroy_workqueue(md->esd_wq);
504 static struct lcd_panel mipid_panel = {
505 .config = OMAP_LCDC_PANEL_TFT,
510 .pixel_clock = 21940,
519 .cleanup = mipid_cleanup,
520 .enable = mipid_enable,
521 .disable = mipid_disable,
522 .get_caps = mipid_get_caps,
523 .set_bklight_level = mipid_set_bklight_level,
524 .get_bklight_level = mipid_get_bklight_level,
525 .get_bklight_max = mipid_get_bklight_max,
526 .run_test = mipid_run_test,
529 static int mipid_detect(struct mipid_device *md)
531 struct mipid_platform_data *pdata;
534 pdata = md->spi->dev.platform_data;
536 dev_err(&md->spi->dev, "missing platform data\n");
540 mipid_read(md, MIPID_CMD_READ_DISP_ID, display_id, 3);
541 dev_dbg(&md->spi->dev, "MIPI display ID: %02x%02x%02x\n",
542 display_id[0], display_id[1], display_id[2]);
544 switch (display_id[0]) {
546 md->panel.name = "lph8923";
549 md->panel.name = "ls041y3";
550 md->esd_check = ls041y3_esd_check;
553 md->panel.name = "unknown";
554 dev_err(&md->spi->dev, "invalid display ID\n");
558 md->revision = display_id[1];
559 md->panel.data_lines = pdata->data_lines;
560 pr_info("omapfb: %s rev %02x LCD detected, %d data lines\n",
561 md->panel.name, md->revision, md->panel.data_lines);
566 static int mipid_spi_probe(struct spi_device *spi)
568 struct mipid_device *md;
571 md = kzalloc(sizeof(*md), GFP_KERNEL);
573 dev_err(&spi->dev, "out of memory\n");
577 spi->mode = SPI_MODE_0;
579 dev_set_drvdata(&spi->dev, md);
580 md->panel = mipid_panel;
582 r = mipid_detect(md);
586 omapfb_register_panel(&md->panel);
591 static int mipid_spi_remove(struct spi_device *spi)
593 struct mipid_device *md = dev_get_drvdata(&spi->dev);
595 mipid_disable(&md->panel);
601 static struct spi_driver mipid_spi_driver = {
603 .name = MIPID_MODULE_NAME,
604 .bus = &spi_bus_type,
605 .owner = THIS_MODULE,
607 .probe = mipid_spi_probe,
608 .remove = __devexit_p(mipid_spi_remove),
611 static int __init mipid_drv_init(void)
613 spi_register_driver(&mipid_spi_driver);
617 module_init(mipid_drv_init);
619 static void __exit mipid_drv_cleanup(void)
621 spi_unregister_driver(&mipid_spi_driver);
623 module_exit(mipid_drv_cleanup);
625 MODULE_DESCRIPTION("MIPI display driver");
626 MODULE_LICENSE("GPL");