2 * S6E63M0 AMOLED LCD panel driver.
4 * Author: InKi Dae <inki.dae@samsung.com>
6 * Derived from drivers/video/omap/lcd-apollon.c
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #include <linux/wait.h>
25 #include <linux/delay.h>
26 #include <linux/gpio.h>
27 #include <linux/spi/spi.h>
28 #include <linux/irq.h>
29 #include <linux/interrupt.h>
30 #include <linux/kernel.h>
31 #include <linux/lcd.h>
32 #include <linux/backlight.h>
33 #include <linux/module.h>
35 #include "s6e63m0_gamma.h"
37 #define SLEEPMSEC 0x1000
39 #define DEFMASK 0xFF00
40 #define COMMAND_ONLY 0xFE
41 #define DATA_ONLY 0xFF
43 #define MIN_BRIGHTNESS 0
44 #define MAX_BRIGHTNESS 10
46 #define POWER_IS_ON(pwr) ((pwr) <= FB_BLANK_NORMAL)
50 struct spi_device *spi;
52 unsigned int current_brightness;
53 unsigned int gamma_mode;
54 unsigned int gamma_table_count;
55 struct lcd_device *ld;
56 struct backlight_device *bd;
57 struct lcd_platform_data *lcd_pd;
60 static const unsigned short seq_panel_condition_set[] = {
79 static const unsigned short seq_display_condition_set[] = {
93 static const unsigned short seq_gamma_setting[] = {
122 static const unsigned short seq_etc_condition_set[] = {
321 static const unsigned short seq_acl_on[] = {
328 static const unsigned short seq_acl_off[] = {
335 static const unsigned short seq_elvss_on[] = {
342 static const unsigned short seq_elvss_off[] = {
349 static const unsigned short seq_stand_by_off[] = {
355 static const unsigned short seq_stand_by_on[] = {
361 static const unsigned short seq_display_on[] = {
368 static int s6e63m0_spi_write_byte(struct s6e63m0 *lcd, int addr, int data)
371 struct spi_message msg;
373 struct spi_transfer xfer = {
378 buf[0] = (addr << 8) | data;
380 spi_message_init(&msg);
381 spi_message_add_tail(&xfer, &msg);
383 return spi_sync(lcd->spi, &msg);
386 static int s6e63m0_spi_write(struct s6e63m0 *lcd, unsigned char address,
387 unsigned char command)
391 if (address != DATA_ONLY)
392 ret = s6e63m0_spi_write_byte(lcd, 0x0, address);
393 if (command != COMMAND_ONLY)
394 ret = s6e63m0_spi_write_byte(lcd, 0x1, command);
399 static int s6e63m0_panel_send_sequence(struct s6e63m0 *lcd,
400 const unsigned short *wbuf)
404 while ((wbuf[i] & DEFMASK) != ENDDEF) {
405 if ((wbuf[i] & DEFMASK) != SLEEPMSEC) {
406 ret = s6e63m0_spi_write(lcd, wbuf[i], wbuf[i+1]);
418 static int _s6e63m0_gamma_ctl(struct s6e63m0 *lcd, const unsigned int *gamma)
423 /* disable gamma table updating. */
424 ret = s6e63m0_spi_write(lcd, 0xfa, 0x00);
426 dev_err(lcd->dev, "failed to disable gamma table updating.\n");
430 for (i = 0 ; i < GAMMA_TABLE_COUNT; i++) {
431 ret = s6e63m0_spi_write(lcd, DATA_ONLY, gamma[i]);
433 dev_err(lcd->dev, "failed to set gamma table.\n");
438 /* update gamma table. */
439 ret = s6e63m0_spi_write(lcd, 0xfa, 0x01);
441 dev_err(lcd->dev, "failed to update gamma table.\n");
447 static int s6e63m0_gamma_ctl(struct s6e63m0 *lcd, int gamma)
451 ret = _s6e63m0_gamma_ctl(lcd, gamma_table.gamma_22_table[gamma]);
457 static int s6e63m0_ldi_init(struct s6e63m0 *lcd)
460 const unsigned short *init_seq[] = {
461 seq_panel_condition_set,
462 seq_display_condition_set,
464 seq_etc_condition_set,
469 for (i = 0; i < ARRAY_SIZE(init_seq); i++) {
470 ret = s6e63m0_panel_send_sequence(lcd, init_seq[i]);
478 static int s6e63m0_ldi_enable(struct s6e63m0 *lcd)
481 const unsigned short *enable_seq[] = {
486 for (i = 0; i < ARRAY_SIZE(enable_seq); i++) {
487 ret = s6e63m0_panel_send_sequence(lcd, enable_seq[i]);
495 static int s6e63m0_ldi_disable(struct s6e63m0 *lcd)
499 ret = s6e63m0_panel_send_sequence(lcd, seq_stand_by_on);
504 static int s6e63m0_power_on(struct s6e63m0 *lcd)
507 struct lcd_platform_data *pd = NULL;
508 struct backlight_device *bd = NULL;
512 dev_err(lcd->dev, "platform data is NULL.\n");
518 dev_err(lcd->dev, "backlight device is NULL.\n");
523 dev_err(lcd->dev, "power_on is NULL.\n");
526 pd->power_on(lcd->ld, 1);
527 msleep(pd->power_on_delay);
531 dev_err(lcd->dev, "reset is NULL.\n");
535 msleep(pd->reset_delay);
538 ret = s6e63m0_ldi_init(lcd);
540 dev_err(lcd->dev, "failed to initialize ldi.\n");
544 ret = s6e63m0_ldi_enable(lcd);
546 dev_err(lcd->dev, "failed to enable ldi.\n");
550 /* set brightness to current value after power on or resume. */
551 ret = s6e63m0_gamma_ctl(lcd, bd->props.brightness);
553 dev_err(lcd->dev, "lcd gamma setting failed.\n");
560 static int s6e63m0_power_off(struct s6e63m0 *lcd)
563 struct lcd_platform_data *pd = NULL;
567 dev_err(lcd->dev, "platform data is NULL.\n");
571 ret = s6e63m0_ldi_disable(lcd);
573 dev_err(lcd->dev, "lcd setting failed.\n");
577 msleep(pd->power_off_delay);
580 dev_err(lcd->dev, "power_on is NULL.\n");
583 pd->power_on(lcd->ld, 0);
588 static int s6e63m0_power(struct s6e63m0 *lcd, int power)
592 if (POWER_IS_ON(power) && !POWER_IS_ON(lcd->power))
593 ret = s6e63m0_power_on(lcd);
594 else if (!POWER_IS_ON(power) && POWER_IS_ON(lcd->power))
595 ret = s6e63m0_power_off(lcd);
603 static int s6e63m0_set_power(struct lcd_device *ld, int power)
605 struct s6e63m0 *lcd = lcd_get_data(ld);
607 if (power != FB_BLANK_UNBLANK && power != FB_BLANK_POWERDOWN &&
608 power != FB_BLANK_NORMAL) {
609 dev_err(lcd->dev, "power value should be 0, 1 or 4.\n");
613 return s6e63m0_power(lcd, power);
616 static int s6e63m0_get_power(struct lcd_device *ld)
618 struct s6e63m0 *lcd = lcd_get_data(ld);
623 static int s6e63m0_get_brightness(struct backlight_device *bd)
625 return bd->props.brightness;
628 static int s6e63m0_set_brightness(struct backlight_device *bd)
630 int ret = 0, brightness = bd->props.brightness;
631 struct s6e63m0 *lcd = bl_get_data(bd);
633 if (brightness < MIN_BRIGHTNESS ||
634 brightness > bd->props.max_brightness) {
635 dev_err(&bd->dev, "lcd brightness should be %d to %d.\n",
636 MIN_BRIGHTNESS, MAX_BRIGHTNESS);
640 ret = s6e63m0_gamma_ctl(lcd, bd->props.brightness);
642 dev_err(&bd->dev, "lcd brightness setting failed.\n");
649 static struct lcd_ops s6e63m0_lcd_ops = {
650 .set_power = s6e63m0_set_power,
651 .get_power = s6e63m0_get_power,
654 static const struct backlight_ops s6e63m0_backlight_ops = {
655 .get_brightness = s6e63m0_get_brightness,
656 .update_status = s6e63m0_set_brightness,
659 static ssize_t s6e63m0_sysfs_show_gamma_mode(struct device *dev,
660 struct device_attribute *attr, char *buf)
662 struct s6e63m0 *lcd = dev_get_drvdata(dev);
665 switch (lcd->gamma_mode) {
667 sprintf(temp, "2.2 mode\n");
671 sprintf(temp, "1.9 mode\n");
675 sprintf(temp, "1.7 mode\n");
679 dev_info(dev, "gamma mode could be 0:2.2, 1:1.9 or 2:1.7)n");
686 static ssize_t s6e63m0_sysfs_store_gamma_mode(struct device *dev,
687 struct device_attribute *attr,
688 const char *buf, size_t len)
690 struct s6e63m0 *lcd = dev_get_drvdata(dev);
691 struct backlight_device *bd = NULL;
694 rc = kstrtouint(buf, 0, &lcd->gamma_mode);
700 brightness = bd->props.brightness;
702 switch (lcd->gamma_mode) {
704 _s6e63m0_gamma_ctl(lcd, gamma_table.gamma_22_table[brightness]);
707 _s6e63m0_gamma_ctl(lcd, gamma_table.gamma_19_table[brightness]);
710 _s6e63m0_gamma_ctl(lcd, gamma_table.gamma_17_table[brightness]);
713 dev_info(dev, "gamma mode could be 0:2.2, 1:1.9 or 2:1.7\n");
714 _s6e63m0_gamma_ctl(lcd, gamma_table.gamma_22_table[brightness]);
720 static DEVICE_ATTR(gamma_mode, 0644,
721 s6e63m0_sysfs_show_gamma_mode, s6e63m0_sysfs_store_gamma_mode);
723 static ssize_t s6e63m0_sysfs_show_gamma_table(struct device *dev,
724 struct device_attribute *attr, char *buf)
726 struct s6e63m0 *lcd = dev_get_drvdata(dev);
729 sprintf(temp, "%d\n", lcd->gamma_table_count);
734 static DEVICE_ATTR(gamma_table, 0444,
735 s6e63m0_sysfs_show_gamma_table, NULL);
737 static int s6e63m0_probe(struct spi_device *spi)
740 struct s6e63m0 *lcd = NULL;
741 struct lcd_device *ld = NULL;
742 struct backlight_device *bd = NULL;
743 struct backlight_properties props;
745 lcd = devm_kzalloc(&spi->dev, sizeof(struct s6e63m0), GFP_KERNEL);
749 /* s6e63m0 lcd panel uses 3-wire 9bits SPI Mode. */
750 spi->bits_per_word = 9;
752 ret = spi_setup(spi);
754 dev_err(&spi->dev, "spi setup failed.\n");
759 lcd->dev = &spi->dev;
761 lcd->lcd_pd = spi->dev.platform_data;
763 dev_err(&spi->dev, "platform data is NULL.\n");
767 ld = lcd_device_register("s6e63m0", &spi->dev, lcd, &s6e63m0_lcd_ops);
773 memset(&props, 0, sizeof(struct backlight_properties));
774 props.type = BACKLIGHT_RAW;
775 props.max_brightness = MAX_BRIGHTNESS;
777 bd = backlight_device_register("s6e63m0bl-bl", &spi->dev, lcd,
778 &s6e63m0_backlight_ops, &props);
781 goto out_lcd_unregister;
784 bd->props.brightness = MAX_BRIGHTNESS;
788 * it gets gamma table count available so it gets user
791 lcd->gamma_table_count =
792 sizeof(gamma_table) / (MAX_GAMMA_LEVEL * sizeof(int));
794 ret = device_create_file(&(spi->dev), &dev_attr_gamma_mode);
796 dev_err(&(spi->dev), "failed to add sysfs entries\n");
798 ret = device_create_file(&(spi->dev), &dev_attr_gamma_table);
800 dev_err(&(spi->dev), "failed to add sysfs entries\n");
803 * if lcd panel was on from bootloader like u-boot then
806 if (!lcd->lcd_pd->lcd_enabled) {
808 * if lcd panel was off from bootloader then
809 * current lcd status is powerdown and then
810 * it enables lcd panel.
812 lcd->power = FB_BLANK_POWERDOWN;
814 s6e63m0_power(lcd, FB_BLANK_UNBLANK);
816 lcd->power = FB_BLANK_UNBLANK;
818 dev_set_drvdata(&spi->dev, lcd);
820 dev_info(&spi->dev, "s6e63m0 panel driver has been probed.\n");
825 lcd_device_unregister(ld);
829 static int s6e63m0_remove(struct spi_device *spi)
831 struct s6e63m0 *lcd = dev_get_drvdata(&spi->dev);
833 s6e63m0_power(lcd, FB_BLANK_POWERDOWN);
834 device_remove_file(&spi->dev, &dev_attr_gamma_table);
835 device_remove_file(&spi->dev, &dev_attr_gamma_mode);
836 backlight_device_unregister(lcd->bd);
837 lcd_device_unregister(lcd->ld);
842 #if defined(CONFIG_PM)
843 static unsigned int before_power;
845 static int s6e63m0_suspend(struct spi_device *spi, pm_message_t mesg)
848 struct s6e63m0 *lcd = dev_get_drvdata(&spi->dev);
850 dev_dbg(&spi->dev, "lcd->power = %d\n", lcd->power);
852 before_power = lcd->power;
855 * when lcd panel is suspend, lcd panel becomes off
856 * regardless of status.
858 ret = s6e63m0_power(lcd, FB_BLANK_POWERDOWN);
863 static int s6e63m0_resume(struct spi_device *spi)
866 struct s6e63m0 *lcd = dev_get_drvdata(&spi->dev);
869 * after suspended, if lcd panel status is FB_BLANK_UNBLANK
870 * (at that time, before_power is FB_BLANK_UNBLANK) then
871 * it changes that status to FB_BLANK_POWERDOWN to get lcd on.
873 if (before_power == FB_BLANK_UNBLANK)
874 lcd->power = FB_BLANK_POWERDOWN;
876 dev_dbg(&spi->dev, "before_power = %d\n", before_power);
878 ret = s6e63m0_power(lcd, before_power);
883 #define s6e63m0_suspend NULL
884 #define s6e63m0_resume NULL
887 /* Power down all displays on reboot, poweroff or halt. */
888 static void s6e63m0_shutdown(struct spi_device *spi)
890 struct s6e63m0 *lcd = dev_get_drvdata(&spi->dev);
892 s6e63m0_power(lcd, FB_BLANK_POWERDOWN);
895 static struct spi_driver s6e63m0_driver = {
898 .owner = THIS_MODULE,
900 .probe = s6e63m0_probe,
901 .remove = s6e63m0_remove,
902 .shutdown = s6e63m0_shutdown,
903 .suspend = s6e63m0_suspend,
904 .resume = s6e63m0_resume,
907 module_spi_driver(s6e63m0_driver);
909 MODULE_AUTHOR("InKi Dae <inki.dae@samsung.com>");
910 MODULE_DESCRIPTION("S6E63M0 LCD Driver");
911 MODULE_LICENSE("GPL");