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/slab.h>
24 #include <linux/workqueue.h>
25 #include <linux/spi/spi.h>
26 #include <linux/module.h>
28 #include <linux/platform_data/lcd-mipid.h>
32 #define MIPID_MODULE_NAME "lcd_mipid"
34 #define MIPID_CMD_READ_DISP_ID 0x04
35 #define MIPID_CMD_READ_RED 0x06
36 #define MIPID_CMD_READ_GREEN 0x07
37 #define MIPID_CMD_READ_BLUE 0x08
38 #define MIPID_CMD_READ_DISP_STATUS 0x09
39 #define MIPID_CMD_RDDSDR 0x0F
40 #define MIPID_CMD_SLEEP_IN 0x10
41 #define MIPID_CMD_SLEEP_OUT 0x11
42 #define MIPID_CMD_DISP_OFF 0x28
43 #define MIPID_CMD_DISP_ON 0x29
45 #define MIPID_ESD_CHECK_PERIOD msecs_to_jiffies(5000)
47 #define to_mipid_device(p) container_of(p, struct mipid_device, \
52 unsigned int saved_bklight_level;
53 unsigned long hw_guard_end; /* next value of jiffies
55 next sleep in/out command */
56 unsigned long hw_guard_wait; /* max guard time in jiffies */
58 struct omapfb_device *fbdev;
59 struct spi_device *spi;
61 struct lcd_panel panel;
63 struct delayed_work esd_work;
64 void (*esd_check)(struct mipid_device *m);
67 static void mipid_transfer(struct mipid_device *md, int cmd, const u8 *wbuf,
68 int wlen, u8 *rbuf, int rlen)
71 struct spi_transfer *x, xfer[4];
75 BUG_ON(md->spi == NULL);
79 memset(xfer, 0, sizeof(xfer));
86 spi_message_add_tail(x, &m);
93 spi_message_add_tail(x, &m);
100 spi_message_add_tail(x, &m);
103 /* Arrange for the extra clock before the first
106 x->bits_per_word = 9;
110 x->rx_buf = &rbuf[1];
112 spi_message_add_tail(x, &m);
116 r = spi_sync(md->spi, &m);
118 dev_dbg(&md->spi->dev, "spi_sync %d\n", r);
124 static inline void mipid_cmd(struct mipid_device *md, int cmd)
126 mipid_transfer(md, cmd, NULL, 0, NULL, 0);
129 static inline void mipid_write(struct mipid_device *md,
130 int reg, const u8 *buf, int len)
132 mipid_transfer(md, reg, buf, len, NULL, 0);
135 static inline void mipid_read(struct mipid_device *md,
136 int reg, u8 *buf, int len)
138 mipid_transfer(md, reg, NULL, 0, buf, len);
141 static void set_data_lines(struct mipid_device *md, int data_lines)
145 switch (data_lines) {
156 mipid_write(md, 0x3a, (u8 *)&par, 2);
159 static void send_init_string(struct mipid_device *md)
161 u16 initpar[] = { 0x0102, 0x0100, 0x0100 };
163 mipid_write(md, 0xc2, (u8 *)initpar, sizeof(initpar));
164 set_data_lines(md, md->panel.data_lines);
167 static void hw_guard_start(struct mipid_device *md, int guard_msec)
169 md->hw_guard_wait = msecs_to_jiffies(guard_msec);
170 md->hw_guard_end = jiffies + md->hw_guard_wait;
173 static void hw_guard_wait(struct mipid_device *md)
175 unsigned long wait = md->hw_guard_end - jiffies;
177 if ((long)wait > 0 && wait <= md->hw_guard_wait) {
178 set_current_state(TASK_UNINTERRUPTIBLE);
179 schedule_timeout(wait);
183 static void set_sleep_mode(struct mipid_device *md, int on)
185 int cmd, sleep_time = 50;
188 cmd = MIPID_CMD_SLEEP_IN;
190 cmd = MIPID_CMD_SLEEP_OUT;
193 hw_guard_start(md, 120);
195 * When we enable the panel, it seems we _have_ to sleep
196 * 120 ms before sending the init string. When disabling the
197 * panel we'll sleep for the duration of 2 frames, so that the
198 * controller can still provide the PCLK,HS,VS signals.
205 static void set_display_state(struct mipid_device *md, int enabled)
207 int cmd = enabled ? MIPID_CMD_DISP_ON : MIPID_CMD_DISP_OFF;
212 static int mipid_set_bklight_level(struct lcd_panel *panel, unsigned int level)
214 struct mipid_device *md = to_mipid_device(panel);
215 struct mipid_platform_data *pd = md->spi->dev.platform_data;
217 if (pd->get_bklight_max == NULL || pd->set_bklight_level == NULL)
219 if (level > pd->get_bklight_max(pd))
222 md->saved_bklight_level = level;
225 pd->set_bklight_level(pd, level);
230 static unsigned int mipid_get_bklight_level(struct lcd_panel *panel)
232 struct mipid_device *md = to_mipid_device(panel);
233 struct mipid_platform_data *pd = md->spi->dev.platform_data;
235 if (pd->get_bklight_level == NULL)
237 return pd->get_bklight_level(pd);
240 static unsigned int mipid_get_bklight_max(struct lcd_panel *panel)
242 struct mipid_device *md = to_mipid_device(panel);
243 struct mipid_platform_data *pd = md->spi->dev.platform_data;
245 if (pd->get_bklight_max == NULL)
248 return pd->get_bklight_max(pd);
251 static unsigned long mipid_get_caps(struct lcd_panel *panel)
253 return OMAPFB_CAPS_SET_BACKLIGHT;
256 static u16 read_first_pixel(struct mipid_device *md)
261 mutex_lock(&md->mutex);
262 mipid_read(md, MIPID_CMD_READ_RED, &red, 1);
263 mipid_read(md, MIPID_CMD_READ_GREEN, &green, 1);
264 mipid_read(md, MIPID_CMD_READ_BLUE, &blue, 1);
265 mutex_unlock(&md->mutex);
267 switch (md->panel.data_lines) {
269 pixel = ((red >> 1) << 11) | (green << 5) | (blue >> 1);
272 /* 24 bit -> 16 bit */
273 pixel = ((red >> 3) << 11) | ((green >> 2) << 5) |
284 static int mipid_run_test(struct lcd_panel *panel, int test_num)
286 struct mipid_device *md = to_mipid_device(panel);
287 static const u16 test_values[4] = {
288 0x0000, 0xffff, 0xaaaa, 0x5555,
292 if (test_num != MIPID_TEST_RGB_LINES)
293 return MIPID_TEST_INVALID;
295 for (i = 0; i < ARRAY_SIZE(test_values); i++) {
299 omapfb_write_first_pixel(md->fbdev, test_values[i]);
300 tmo = jiffies + msecs_to_jiffies(100);
306 pixel = read_first_pixel(md);
307 if (pixel == test_values[i])
309 if (time_after(jiffies, tmo)) {
310 dev_err(&md->spi->dev,
311 "MIPI LCD RGB I/F test failed: "
312 "expecting %04x, got %04x\n",
313 test_values[i], pixel);
314 return MIPID_TEST_FAILED;
323 static void ls041y3_esd_recover(struct mipid_device *md)
325 dev_err(&md->spi->dev, "performing LCD ESD recovery\n");
326 set_sleep_mode(md, 1);
327 set_sleep_mode(md, 0);
330 static void ls041y3_esd_check_mode1(struct mipid_device *md)
334 mipid_read(md, MIPID_CMD_RDDSDR, &state1, 1);
335 set_sleep_mode(md, 0);
336 mipid_read(md, MIPID_CMD_RDDSDR, &state2, 1);
337 dev_dbg(&md->spi->dev, "ESD mode 1 state1 %02x state2 %02x\n",
339 /* Each sleep out command will trigger a self diagnostic and flip
340 * Bit6 if the test passes.
342 if (!((state1 ^ state2) & (1 << 6)))
343 ls041y3_esd_recover(md);
346 static void ls041y3_esd_check_mode2(struct mipid_device *md)
350 static const struct {
354 } *rd, rd_ctrl[7] = {
355 { 0xb0, 4, { 0x0101, 0x01fe, } },
356 { 0xb1, 4, { 0x01de, 0x0121, } },
357 { 0xc2, 4, { 0x0100, 0x0100, } },
358 { 0xbd, 2, { 0x0100, } },
359 { 0xc2, 4, { 0x01fc, 0x0103, } },
365 for (i = 0; i < 3; i++, rd++)
366 mipid_write(md, rd->cmd, (u8 *)rd->wbuf, rd->wlen);
369 mipid_read(md, rd->cmd, rbuf, 2);
372 for (i = 0; i < 3; i++, rd++) {
374 mipid_write(md, rd->cmd, (u8 *)rd->wbuf, rd->wlen);
377 dev_dbg(&md->spi->dev, "ESD mode 2 state %02x\n", rbuf[1]);
379 ls041y3_esd_recover(md);
382 static void ls041y3_esd_check(struct mipid_device *md)
384 ls041y3_esd_check_mode1(md);
385 if (md->revision >= 0x88)
386 ls041y3_esd_check_mode2(md);
389 static void mipid_esd_start_check(struct mipid_device *md)
391 if (md->esd_check != NULL)
392 schedule_delayed_work(&md->esd_work,
393 MIPID_ESD_CHECK_PERIOD);
396 static void mipid_esd_stop_check(struct mipid_device *md)
398 if (md->esd_check != NULL)
399 cancel_delayed_work_sync(&md->esd_work);
402 static void mipid_esd_work(struct work_struct *work)
404 struct mipid_device *md = container_of(work, struct mipid_device,
407 mutex_lock(&md->mutex);
409 mutex_unlock(&md->mutex);
410 mipid_esd_start_check(md);
413 static int mipid_enable(struct lcd_panel *panel)
415 struct mipid_device *md = to_mipid_device(panel);
417 mutex_lock(&md->mutex);
420 mutex_unlock(&md->mutex);
423 set_sleep_mode(md, 0);
425 send_init_string(md);
426 set_display_state(md, 1);
427 mipid_set_bklight_level(panel, md->saved_bklight_level);
428 mipid_esd_start_check(md);
430 mutex_unlock(&md->mutex);
434 static void mipid_disable(struct lcd_panel *panel)
436 struct mipid_device *md = to_mipid_device(panel);
439 * A final ESD work might be called before returning,
440 * so do this without holding the lock.
442 mipid_esd_stop_check(md);
443 mutex_lock(&md->mutex);
446 mutex_unlock(&md->mutex);
449 md->saved_bklight_level = mipid_get_bklight_level(panel);
450 mipid_set_bklight_level(panel, 0);
451 set_display_state(md, 0);
452 set_sleep_mode(md, 1);
455 mutex_unlock(&md->mutex);
458 static int panel_enabled(struct mipid_device *md)
463 mipid_read(md, MIPID_CMD_READ_DISP_STATUS, (u8 *)&disp_status, 4);
464 disp_status = __be32_to_cpu(disp_status);
465 enabled = (disp_status & (1 << 17)) && (disp_status & (1 << 10));
466 dev_dbg(&md->spi->dev,
467 "LCD panel %senabled by bootloader (status 0x%04x)\n",
468 enabled ? "" : "not ", disp_status);
472 static int mipid_init(struct lcd_panel *panel,
473 struct omapfb_device *fbdev)
475 struct mipid_device *md = to_mipid_device(panel);
478 INIT_DELAYED_WORK(&md->esd_work, mipid_esd_work);
479 mutex_init(&md->mutex);
481 md->enabled = panel_enabled(md);
484 mipid_esd_start_check(md);
486 md->saved_bklight_level = mipid_get_bklight_level(panel);
491 static void mipid_cleanup(struct lcd_panel *panel)
493 struct mipid_device *md = to_mipid_device(panel);
496 mipid_esd_stop_check(md);
499 static struct lcd_panel mipid_panel = {
500 .config = OMAP_LCDC_PANEL_TFT,
505 .pixel_clock = 21940,
514 .cleanup = mipid_cleanup,
515 .enable = mipid_enable,
516 .disable = mipid_disable,
517 .get_caps = mipid_get_caps,
518 .set_bklight_level = mipid_set_bklight_level,
519 .get_bklight_level = mipid_get_bklight_level,
520 .get_bklight_max = mipid_get_bklight_max,
521 .run_test = mipid_run_test,
524 static int mipid_detect(struct mipid_device *md)
526 struct mipid_platform_data *pdata;
529 pdata = md->spi->dev.platform_data;
531 dev_err(&md->spi->dev, "missing platform data\n");
535 mipid_read(md, MIPID_CMD_READ_DISP_ID, display_id, 3);
536 dev_dbg(&md->spi->dev, "MIPI display ID: %02x%02x%02x\n",
537 display_id[0], display_id[1], display_id[2]);
539 switch (display_id[0]) {
541 md->panel.name = "lph8923";
544 md->panel.name = "ls041y3";
545 md->esd_check = ls041y3_esd_check;
548 md->panel.name = "unknown";
549 dev_err(&md->spi->dev, "invalid display ID\n");
553 md->revision = display_id[1];
554 md->panel.data_lines = pdata->data_lines;
555 pr_info("omapfb: %s rev %02x LCD detected, %d data lines\n",
556 md->panel.name, md->revision, md->panel.data_lines);
561 static int mipid_spi_probe(struct spi_device *spi)
563 struct mipid_device *md;
566 md = kzalloc(sizeof(*md), GFP_KERNEL);
568 dev_err(&spi->dev, "out of memory\n");
572 spi->mode = SPI_MODE_0;
574 dev_set_drvdata(&spi->dev, md);
575 md->panel = mipid_panel;
577 r = mipid_detect(md);
581 omapfb_register_panel(&md->panel);
586 static int mipid_spi_remove(struct spi_device *spi)
588 struct mipid_device *md = dev_get_drvdata(&spi->dev);
590 mipid_disable(&md->panel);
596 static struct spi_driver mipid_spi_driver = {
598 .name = MIPID_MODULE_NAME,
600 .probe = mipid_spi_probe,
601 .remove = mipid_spi_remove,
604 module_spi_driver(mipid_spi_driver);
606 MODULE_DESCRIPTION("MIPI display driver");
607 MODULE_LICENSE("GPL");