1 // SPDX-License-Identifier: GPL-2.0+
3 * Character LCD driver for Linux
5 * Copyright (C) 2000-2008, Willy Tarreau <w@1wt.eu>
6 * Copyright (C) 2016-2017 Glider bvba
9 #include <linux/atomic.h>
10 #include <linux/ctype.h>
11 #include <linux/delay.h>
13 #include <linux/miscdevice.h>
14 #include <linux/module.h>
15 #include <linux/notifier.h>
16 #include <linux/reboot.h>
17 #include <linux/slab.h>
18 #include <linux/uaccess.h>
19 #include <linux/workqueue.h>
21 #include <generated/utsrelease.h>
27 #define DEFAULT_LCD_BWIDTH 40
28 #define DEFAULT_LCD_HWIDTH 64
30 /* Keep the backlight on this many seconds for each flash */
31 #define LCD_BL_TEMPO_PERIOD 4
33 #define LCD_FLAG_B 0x0004 /* Blink on */
34 #define LCD_FLAG_C 0x0008 /* Cursor on */
35 #define LCD_FLAG_D 0x0010 /* Display on */
36 #define LCD_FLAG_F 0x0020 /* Large font mode */
37 #define LCD_FLAG_N 0x0040 /* 2-rows mode */
38 #define LCD_FLAG_L 0x0080 /* Backlight enabled */
41 #define LCD_CMD_DISPLAY_CLEAR 0x01 /* Clear entire display */
43 #define LCD_CMD_ENTRY_MODE 0x04 /* Set entry mode */
44 #define LCD_CMD_CURSOR_INC 0x02 /* Increment cursor */
46 #define LCD_CMD_DISPLAY_CTRL 0x08 /* Display control */
47 #define LCD_CMD_DISPLAY_ON 0x04 /* Set display on */
48 #define LCD_CMD_CURSOR_ON 0x02 /* Set cursor on */
49 #define LCD_CMD_BLINK_ON 0x01 /* Set blink on */
51 #define LCD_CMD_SHIFT 0x10 /* Shift cursor/display */
52 #define LCD_CMD_DISPLAY_SHIFT 0x08 /* Shift display instead of cursor */
53 #define LCD_CMD_SHIFT_RIGHT 0x04 /* Shift display/cursor to the right */
55 #define LCD_CMD_FUNCTION_SET 0x20 /* Set function */
56 #define LCD_CMD_DATA_LEN_8BITS 0x10 /* Set data length to 8 bits */
57 #define LCD_CMD_TWO_LINES 0x08 /* Set to two display lines */
58 #define LCD_CMD_FONT_5X10_DOTS 0x04 /* Set char font to 5x10 dots */
60 #define LCD_CMD_SET_CGRAM_ADDR 0x40 /* Set char generator RAM address */
62 #define LCD_CMD_SET_DDRAM_ADDR 0x80 /* Set display data RAM address */
64 #define LCD_ESCAPE_LEN 24 /* Max chars for LCD escape command */
65 #define LCD_ESCAPE_CHAR 27 /* Use char 27 for escape command */
70 struct delayed_work bl_work;
71 struct mutex bl_tempo_lock; /* Protects access to bl_tempo */
76 /* contains the LCD config state */
77 unsigned long int flags;
79 /* Contains the LCD X and Y offset */
85 /* Current escape sequence and it's length or -1 if outside */
87 char buf[LCD_ESCAPE_LEN + 1];
91 unsigned long long drvdata[0];
94 #define charlcd_to_priv(p) container_of(p, struct charlcd_priv, lcd)
96 /* Device single-open policy control */
97 static atomic_t charlcd_available = ATOMIC_INIT(1);
99 /* sleeps that many milliseconds with a reschedule */
100 static void long_sleep(int ms)
102 schedule_timeout_interruptible(msecs_to_jiffies(ms));
105 /* turn the backlight on or off */
106 static void charlcd_backlight(struct charlcd *lcd, int on)
108 struct charlcd_priv *priv = charlcd_to_priv(lcd);
110 if (!lcd->ops->backlight)
113 mutex_lock(&priv->bl_tempo_lock);
115 lcd->ops->backlight(lcd, on);
116 mutex_unlock(&priv->bl_tempo_lock);
119 static void charlcd_bl_off(struct work_struct *work)
121 struct delayed_work *dwork = to_delayed_work(work);
122 struct charlcd_priv *priv =
123 container_of(dwork, struct charlcd_priv, bl_work);
125 mutex_lock(&priv->bl_tempo_lock);
126 if (priv->bl_tempo) {
127 priv->bl_tempo = false;
128 if (!(priv->flags & LCD_FLAG_L))
129 priv->lcd.ops->backlight(&priv->lcd, 0);
131 mutex_unlock(&priv->bl_tempo_lock);
134 /* turn the backlight on for a little while */
135 void charlcd_poke(struct charlcd *lcd)
137 struct charlcd_priv *priv = charlcd_to_priv(lcd);
139 if (!lcd->ops->backlight)
142 cancel_delayed_work_sync(&priv->bl_work);
144 mutex_lock(&priv->bl_tempo_lock);
145 if (!priv->bl_tempo && !(priv->flags & LCD_FLAG_L))
146 lcd->ops->backlight(lcd, 1);
147 priv->bl_tempo = true;
148 schedule_delayed_work(&priv->bl_work, LCD_BL_TEMPO_PERIOD * HZ);
149 mutex_unlock(&priv->bl_tempo_lock);
151 EXPORT_SYMBOL_GPL(charlcd_poke);
153 static void charlcd_gotoxy(struct charlcd *lcd)
155 struct charlcd_priv *priv = charlcd_to_priv(lcd);
159 * we force the cursor to stay at the end of the
160 * line if it wants to go farther
162 addr = priv->addr.x < lcd->bwidth ? priv->addr.x & (lcd->hwidth - 1)
164 if (priv->addr.y & 1)
166 if (priv->addr.y & 2)
168 lcd->ops->write_cmd(lcd, LCD_CMD_SET_DDRAM_ADDR | addr);
171 static void charlcd_home(struct charlcd *lcd)
173 struct charlcd_priv *priv = charlcd_to_priv(lcd);
180 static void charlcd_print(struct charlcd *lcd, char c)
182 struct charlcd_priv *priv = charlcd_to_priv(lcd);
184 if (priv->addr.x < lcd->bwidth) {
186 c = lcd->char_conv[(unsigned char)c];
187 lcd->ops->write_data(lcd, c);
190 /* prevents the cursor from wrapping onto the next line */
191 if (priv->addr.x == lcd->bwidth)
196 static void charlcd_clear_fast(struct charlcd *lcd)
202 if (lcd->ops->clear_fast)
203 lcd->ops->clear_fast(lcd);
205 for (pos = 0; pos < min(2, lcd->height) * lcd->hwidth; pos++)
206 lcd->ops->write_data(lcd, ' ');
211 /* clears the display and resets X/Y */
212 static void charlcd_clear_display(struct charlcd *lcd)
214 struct charlcd_priv *priv = charlcd_to_priv(lcd);
216 lcd->ops->write_cmd(lcd, LCD_CMD_DISPLAY_CLEAR);
219 /* we must wait a few milliseconds (15) */
223 static int charlcd_init_display(struct charlcd *lcd)
225 void (*write_cmd_raw)(struct charlcd *lcd, int cmd);
226 struct charlcd_priv *priv = charlcd_to_priv(lcd);
229 if (lcd->ifwidth != 4 && lcd->ifwidth != 8)
232 priv->flags = ((lcd->height > 1) ? LCD_FLAG_N : 0) | LCD_FLAG_D |
233 LCD_FLAG_C | LCD_FLAG_B;
235 long_sleep(20); /* wait 20 ms after power-up for the paranoid */
238 * 8-bit mode, 1 line, small fonts; let's do it 3 times, to make sure
239 * the LCD is in 8-bit mode afterwards
241 init = LCD_CMD_FUNCTION_SET | LCD_CMD_DATA_LEN_8BITS;
242 if (lcd->ifwidth == 4) {
244 write_cmd_raw = lcd->ops->write_cmd_raw4;
246 write_cmd_raw = lcd->ops->write_cmd;
248 write_cmd_raw(lcd, init);
250 write_cmd_raw(lcd, init);
252 write_cmd_raw(lcd, init);
255 if (lcd->ifwidth == 4) {
256 /* Switch to 4-bit mode, 1 line, small fonts */
257 lcd->ops->write_cmd_raw4(lcd, LCD_CMD_FUNCTION_SET >> 4);
261 /* set font height and lines number */
262 lcd->ops->write_cmd(lcd,
263 LCD_CMD_FUNCTION_SET |
264 ((lcd->ifwidth == 8) ? LCD_CMD_DATA_LEN_8BITS : 0) |
265 ((priv->flags & LCD_FLAG_F) ? LCD_CMD_FONT_5X10_DOTS : 0) |
266 ((priv->flags & LCD_FLAG_N) ? LCD_CMD_TWO_LINES : 0));
269 /* display off, cursor off, blink off */
270 lcd->ops->write_cmd(lcd, LCD_CMD_DISPLAY_CTRL);
273 lcd->ops->write_cmd(lcd,
274 LCD_CMD_DISPLAY_CTRL | /* set display mode */
275 ((priv->flags & LCD_FLAG_D) ? LCD_CMD_DISPLAY_ON : 0) |
276 ((priv->flags & LCD_FLAG_C) ? LCD_CMD_CURSOR_ON : 0) |
277 ((priv->flags & LCD_FLAG_B) ? LCD_CMD_BLINK_ON : 0));
279 charlcd_backlight(lcd, (priv->flags & LCD_FLAG_L) ? 1 : 0);
283 /* entry mode set : increment, cursor shifting */
284 lcd->ops->write_cmd(lcd, LCD_CMD_ENTRY_MODE | LCD_CMD_CURSOR_INC);
286 charlcd_clear_display(lcd);
291 * Parses a movement command of the form "(.*);", where the group can be
292 * any number of subcommands of the form "(x|y)[0-9]+".
294 * Returns whether the command is valid. The position arguments are
295 * only written if the parsing was successful.
298 * - ";" returns (<original x>, <original y>).
299 * - "x1;" returns (1, <original y>).
300 * - "y2x1;" returns (1, 2).
301 * - "x12y34x56;" returns (56, 34).
307 * - "x12yy12;" fails.
310 static bool parse_xy(const char *s, unsigned long *x, unsigned long *y)
312 unsigned long new_x = *x;
313 unsigned long new_y = *y;
324 new_x = simple_strtoul(s + 1, &p, 10);
328 } else if (*s == 'y') {
329 new_y = simple_strtoul(s + 1, &p, 10);
344 * These are the file operation function for user access to /dev/lcd
345 * This function can also be called from inside the kernel, by
346 * setting file and ppos to NULL.
350 static inline int handle_lcd_special_code(struct charlcd *lcd)
352 struct charlcd_priv *priv = charlcd_to_priv(lcd);
354 /* LCD special codes */
358 char *esc = priv->esc_seq.buf + 2;
359 int oldflags = priv->flags;
361 /* check for display mode flags */
363 case 'D': /* Display ON */
364 priv->flags |= LCD_FLAG_D;
367 case 'd': /* Display OFF */
368 priv->flags &= ~LCD_FLAG_D;
371 case 'C': /* Cursor ON */
372 priv->flags |= LCD_FLAG_C;
375 case 'c': /* Cursor OFF */
376 priv->flags &= ~LCD_FLAG_C;
379 case 'B': /* Blink ON */
380 priv->flags |= LCD_FLAG_B;
383 case 'b': /* Blink OFF */
384 priv->flags &= ~LCD_FLAG_B;
387 case '+': /* Back light ON */
388 priv->flags |= LCD_FLAG_L;
391 case '-': /* Back light OFF */
392 priv->flags &= ~LCD_FLAG_L;
395 case '*': /* Flash back light */
399 case 'f': /* Small Font */
400 priv->flags &= ~LCD_FLAG_F;
403 case 'F': /* Large Font */
404 priv->flags |= LCD_FLAG_F;
407 case 'n': /* One Line */
408 priv->flags &= ~LCD_FLAG_N;
411 case 'N': /* Two Lines */
412 priv->flags |= LCD_FLAG_N;
415 case 'l': /* Shift Cursor Left */
416 if (priv->addr.x > 0) {
417 /* back one char if not at end of line */
418 if (priv->addr.x < lcd->bwidth)
419 lcd->ops->write_cmd(lcd, LCD_CMD_SHIFT);
424 case 'r': /* shift cursor right */
425 if (priv->addr.x < lcd->width) {
426 /* allow the cursor to pass the end of the line */
427 if (priv->addr.x < (lcd->bwidth - 1))
428 lcd->ops->write_cmd(lcd,
429 LCD_CMD_SHIFT | LCD_CMD_SHIFT_RIGHT);
434 case 'L': /* shift display left */
435 lcd->ops->write_cmd(lcd, LCD_CMD_SHIFT | LCD_CMD_DISPLAY_SHIFT);
438 case 'R': /* shift display right */
439 lcd->ops->write_cmd(lcd,
440 LCD_CMD_SHIFT | LCD_CMD_DISPLAY_SHIFT |
441 LCD_CMD_SHIFT_RIGHT);
444 case 'k': { /* kill end of line */
447 for (x = priv->addr.x; x < lcd->bwidth; x++)
448 lcd->ops->write_data(lcd, ' ');
450 /* restore cursor position */
455 case 'I': /* reinitialize display */
456 charlcd_init_display(lcd);
460 /* Generator : LGcxxxxx...xx; must have <c> between '0'
461 * and '7', representing the numerical ASCII code of the
462 * redefined character, and <xx...xx> a sequence of 16
463 * hex digits representing 8 bytes for each character.
464 * Most LCDs will only use 5 lower bits of the 7 first
468 unsigned char cgbytes[8];
469 unsigned char cgaddr;
475 if (!strchr(esc, ';'))
480 cgaddr = *(esc++) - '0';
489 while (*esc && cgoffset < 8) {
491 if (*esc >= '0' && *esc <= '9') {
492 value |= (*esc - '0') << shift;
493 } else if (*esc >= 'A' && *esc <= 'F') {
494 value |= (*esc - 'A' + 10) << shift;
495 } else if (*esc >= 'a' && *esc <= 'f') {
496 value |= (*esc - 'a' + 10) << shift;
503 cgbytes[cgoffset++] = value;
510 lcd->ops->write_cmd(lcd, LCD_CMD_SET_CGRAM_ADDR | (cgaddr * 8));
511 for (addr = 0; addr < cgoffset; addr++)
512 lcd->ops->write_data(lcd, cgbytes[addr]);
514 /* ensures that we stop writing to CGRAM */
519 case 'x': /* gotoxy : LxXXX[yYYY]; */
520 case 'y': /* gotoxy : LyYYY[xXXX]; */
521 if (priv->esc_seq.buf[priv->esc_seq.len - 1] != ';')
524 /* If the command is valid, move to the new address */
525 if (parse_xy(esc, &priv->addr.x, &priv->addr.y))
528 /* Regardless of its validity, mark as processed */
533 /* TODO: This indent party here got ugly, clean it! */
534 /* Check whether one flag was changed */
535 if (oldflags == priv->flags)
538 /* check whether one of B,C,D flags were changed */
539 if ((oldflags ^ priv->flags) &
540 (LCD_FLAG_B | LCD_FLAG_C | LCD_FLAG_D))
541 /* set display mode */
542 lcd->ops->write_cmd(lcd,
543 LCD_CMD_DISPLAY_CTRL |
544 ((priv->flags & LCD_FLAG_D) ? LCD_CMD_DISPLAY_ON : 0) |
545 ((priv->flags & LCD_FLAG_C) ? LCD_CMD_CURSOR_ON : 0) |
546 ((priv->flags & LCD_FLAG_B) ? LCD_CMD_BLINK_ON : 0));
547 /* check whether one of F,N flags was changed */
548 else if ((oldflags ^ priv->flags) & (LCD_FLAG_F | LCD_FLAG_N))
549 lcd->ops->write_cmd(lcd,
550 LCD_CMD_FUNCTION_SET |
551 ((lcd->ifwidth == 8) ? LCD_CMD_DATA_LEN_8BITS : 0) |
552 ((priv->flags & LCD_FLAG_F) ? LCD_CMD_FONT_5X10_DOTS : 0) |
553 ((priv->flags & LCD_FLAG_N) ? LCD_CMD_TWO_LINES : 0));
554 /* check whether L flag was changed */
555 else if ((oldflags ^ priv->flags) & LCD_FLAG_L)
556 charlcd_backlight(lcd, !!(priv->flags & LCD_FLAG_L));
561 static void charlcd_write_char(struct charlcd *lcd, char c)
563 struct charlcd_priv *priv = charlcd_to_priv(lcd);
565 /* first, we'll test if we're in escape mode */
566 if ((c != '\n') && priv->esc_seq.len >= 0) {
567 /* yes, let's add this char to the buffer */
568 priv->esc_seq.buf[priv->esc_seq.len++] = c;
569 priv->esc_seq.buf[priv->esc_seq.len] = '\0';
571 /* aborts any previous escape sequence */
572 priv->esc_seq.len = -1;
575 case LCD_ESCAPE_CHAR:
576 /* start of an escape sequence */
577 priv->esc_seq.len = 0;
578 priv->esc_seq.buf[priv->esc_seq.len] = '\0';
581 /* go back one char and clear it */
582 if (priv->addr.x > 0) {
584 * check if we're not at the
587 if (priv->addr.x < lcd->bwidth)
589 lcd->ops->write_cmd(lcd, LCD_CMD_SHIFT);
592 /* replace with a space */
593 lcd->ops->write_data(lcd, ' ');
594 /* back one char again */
595 lcd->ops->write_cmd(lcd, LCD_CMD_SHIFT);
598 /* quickly clear the display */
599 charlcd_clear_fast(lcd);
603 * flush the remainder of the current line and
604 * go to the beginning of the next line
606 for (; priv->addr.x < lcd->bwidth; priv->addr.x++)
607 lcd->ops->write_data(lcd, ' ');
609 priv->addr.y = (priv->addr.y + 1) % lcd->height;
613 /* go to the beginning of the same line */
618 /* print a space instead of the tab */
619 charlcd_print(lcd, ' ');
622 /* simply print this char */
623 charlcd_print(lcd, c);
629 * now we'll see if we're in an escape mode and if the current
630 * escape sequence can be understood.
632 if (priv->esc_seq.len >= 2) {
635 if (!strcmp(priv->esc_seq.buf, "[2J")) {
636 /* clear the display */
637 charlcd_clear_fast(lcd);
639 } else if (!strcmp(priv->esc_seq.buf, "[H")) {
644 /* codes starting with ^[[L */
645 else if ((priv->esc_seq.len >= 3) &&
646 (priv->esc_seq.buf[0] == '[') &&
647 (priv->esc_seq.buf[1] == 'L')) {
648 processed = handle_lcd_special_code(lcd);
651 /* LCD special escape codes */
653 * flush the escape sequence if it's been processed
654 * or if it is getting too long.
656 if (processed || (priv->esc_seq.len >= LCD_ESCAPE_LEN))
657 priv->esc_seq.len = -1;
661 static struct charlcd *the_charlcd;
663 static ssize_t charlcd_write(struct file *file, const char __user *buf,
664 size_t count, loff_t *ppos)
666 const char __user *tmp = buf;
669 for (; count-- > 0; (*ppos)++, tmp++) {
670 if (!in_interrupt() && (((count + 1) & 0x1f) == 0))
672 * let's be a little nice with other processes
677 if (get_user(c, tmp))
680 charlcd_write_char(the_charlcd, c);
686 static int charlcd_open(struct inode *inode, struct file *file)
688 struct charlcd_priv *priv = charlcd_to_priv(the_charlcd);
692 if (!atomic_dec_and_test(&charlcd_available))
693 goto fail; /* open only once at a time */
696 if (file->f_mode & FMODE_READ) /* device is write-only */
699 if (priv->must_clear) {
700 charlcd_clear_display(&priv->lcd);
701 priv->must_clear = false;
703 return nonseekable_open(inode, file);
706 atomic_inc(&charlcd_available);
710 static int charlcd_release(struct inode *inode, struct file *file)
712 atomic_inc(&charlcd_available);
716 static const struct file_operations charlcd_fops = {
717 .write = charlcd_write,
718 .open = charlcd_open,
719 .release = charlcd_release,
723 static struct miscdevice charlcd_dev = {
726 .fops = &charlcd_fops,
729 static void charlcd_puts(struct charlcd *lcd, const char *s)
732 int count = strlen(s);
734 for (; count-- > 0; tmp++) {
735 if (!in_interrupt() && (((count + 1) & 0x1f) == 0))
737 * let's be a little nice with other processes
742 charlcd_write_char(lcd, *tmp);
746 #ifdef CONFIG_PANEL_BOOT_MESSAGE
747 #define LCD_INIT_TEXT CONFIG_PANEL_BOOT_MESSAGE
749 #define LCD_INIT_TEXT "Linux-" UTS_RELEASE "\n"
752 #ifdef CONFIG_CHARLCD_BL_ON
753 #define LCD_INIT_BL "\x1b[L+"
754 #elif defined(CONFIG_CHARLCD_BL_FLASH)
755 #define LCD_INIT_BL "\x1b[L*"
757 #define LCD_INIT_BL "\x1b[L-"
760 /* initialize the LCD driver */
761 static int charlcd_init(struct charlcd *lcd)
763 struct charlcd_priv *priv = charlcd_to_priv(lcd);
766 if (lcd->ops->backlight) {
767 mutex_init(&priv->bl_tempo_lock);
768 INIT_DELAYED_WORK(&priv->bl_work, charlcd_bl_off);
772 * before this line, we must NOT send anything to the display.
773 * Since charlcd_init_display() needs to write data, we have to
774 * enable mark the LCD initialized just before.
776 ret = charlcd_init_display(lcd);
780 /* display a short message */
781 charlcd_puts(lcd, "\x1b[Lc\x1b[Lb" LCD_INIT_BL LCD_INIT_TEXT);
783 /* clear the display on the next device opening */
784 priv->must_clear = true;
789 struct charlcd *charlcd_alloc(unsigned int drvdata_size)
791 struct charlcd_priv *priv;
794 priv = kzalloc(sizeof(*priv) + drvdata_size, GFP_KERNEL);
798 priv->esc_seq.len = -1;
802 lcd->bwidth = DEFAULT_LCD_BWIDTH;
803 lcd->hwidth = DEFAULT_LCD_HWIDTH;
804 lcd->drvdata = priv->drvdata;
808 EXPORT_SYMBOL_GPL(charlcd_alloc);
810 void charlcd_free(struct charlcd *lcd)
812 kfree(charlcd_to_priv(lcd));
814 EXPORT_SYMBOL_GPL(charlcd_free);
816 static int panel_notify_sys(struct notifier_block *this, unsigned long code,
819 struct charlcd *lcd = the_charlcd;
824 "\x0cReloading\nSystem...\x1b[Lc\x1b[Lb\x1b[L+");
827 charlcd_puts(lcd, "\x0cSystem Halted.\x1b[Lc\x1b[Lb\x1b[L+");
830 charlcd_puts(lcd, "\x0cPower off.\x1b[Lc\x1b[Lb\x1b[L+");
838 static struct notifier_block panel_notifier = {
844 int charlcd_register(struct charlcd *lcd)
848 ret = charlcd_init(lcd);
852 ret = misc_register(&charlcd_dev);
857 register_reboot_notifier(&panel_notifier);
860 EXPORT_SYMBOL_GPL(charlcd_register);
862 int charlcd_unregister(struct charlcd *lcd)
864 struct charlcd_priv *priv = charlcd_to_priv(lcd);
866 unregister_reboot_notifier(&panel_notifier);
867 charlcd_puts(lcd, "\x0cLCD driver unloaded.\x1b[Lc\x1b[Lb\x1b[L-");
868 misc_deregister(&charlcd_dev);
870 if (lcd->ops->backlight) {
871 cancel_delayed_work_sync(&priv->bl_work);
872 priv->lcd.ops->backlight(&priv->lcd, 0);
877 EXPORT_SYMBOL_GPL(charlcd_unregister);
879 MODULE_LICENSE("GPL");