7  * This code drives an LCD module (/dev/lcd), and a keypad (/dev/keypad)
10  * The LCD module may either be an HD44780-like 8-bit parallel LCD, or a 1-bit
18  * Several profiles are provided for commonly found LCD+keypad modules on the
27  *      - make the LCD a part of a virtual screen of Vx*Vy
199 /* lcd-specific variables */
218 } lcd;  variable
224  * Bit masks to convert LCD signals to parallel port outputs.
233  * one entry for each bit on the LCD
253  * LCD protocols
260  * LCD character sets
266  * LCD types
407 MODULE_DESCRIPTION("Generic parallel port LCD/Keypad driver");
427 		 "LCD type: 0=none, 1=compiled-in, 2=old, 3=serial ks0074, 4=hantronix, 5=nexcom");
431 MODULE_PARM_DESC(lcd_height, "Number of lines on the LCD");
435 MODULE_PARM_DESC(lcd_width, "Number of columns on the LCD");
439 MODULE_PARM_DESC(lcd_bwidth, "Internal LCD line width (40)");
443 MODULE_PARM_DESC(lcd_hwidth, "LCD line hardware address (64)");
447 MODULE_PARM_DESC(lcd_charset, "LCD character set: 0=standard, 1=KS0074");
452 		 "LCD communication: 0=parallel (//), 1=serial, 2=TI LCD Interface");
455  * These are the parallel port pins the LCD control signals are connected to.
466 		 "# of the // port pin connected to LCD 'E' signal, with polarity (-17..17)");
471 		 "# of the // port pin connected to LCD 'RS' signal, with polarity (-17..17)");
476 		 "# of the // port pin connected to LCD 'RW' signal, with polarity (-17..17)");
481 		 "# of the // port pin connected to serial LCD 'SCL' signal, with polarity (-17..17)");
486 		 "# of the // port pin connected to serial LCD 'SDA' signal, with polarity (-17..17)");
491 		 "# of the // port pin connected to LCD backlight, with polarity (-17..17)");
503 /* for some LCD drivers (ks0074) we need a charset conversion table. */
680  * send a serial byte to the LCD panel. The caller is responsible for locking
689 	 * LCD reads D0 on STROBE's rising edge.  in lcd_send_serial()
712 	if (lcd.pins.bl == PIN_NONE)  in lcd_backlight()
725 /* send a command to the LCD panel in serial mode */
736 /* send data to the LCD panel in serial mode */
747 /* send a command to the LCD panel in 8 bits parallel mode */
769 /* send data to the LCD panel in 8 bits parallel mode */
791 /* send a command to the TI LCD panel */
801 /* send data to the TI LCD panel */
828 /* initialize the LCD driver */
839 	hdc->hd44780 = &lcd;  in lcd_init()
842 	 * Init lcd struct with load-time values to preserve exact  in lcd_init()
853 		lcd.proto = LCD_PROTO_PARALLEL;  in lcd_init()
854 		lcd.charset = LCD_CHARSET_NORMAL;  in lcd_init()
855 		lcd.pins.e = PIN_STROBE;  in lcd_init()
856 		lcd.pins.rs = PIN_AUTOLF;  in lcd_init()
865 		lcd.proto = LCD_PROTO_SERIAL;  in lcd_init()
866 		lcd.charset = LCD_CHARSET_KS0074;  in lcd_init()
867 		lcd.pins.bl = PIN_AUTOLF;  in lcd_init()
868 		lcd.pins.cl = PIN_STROBE;  in lcd_init()
869 		lcd.pins.da = PIN_D0;  in lcd_init()
878 		lcd.proto = LCD_PROTO_PARALLEL;  in lcd_init()
879 		lcd.charset = LCD_CHARSET_NORMAL;  in lcd_init()
880 		lcd.pins.e = PIN_AUTOLF;  in lcd_init()
881 		lcd.pins.rs = PIN_SELECP;  in lcd_init()
882 		lcd.pins.rw = PIN_INITP;  in lcd_init()
891 		lcd.proto = DEFAULT_LCD_PROTO;  in lcd_init()
892 		lcd.charset = DEFAULT_LCD_CHARSET;  in lcd_init()
898 		lcd.proto = LCD_PROTO_PARALLEL;  in lcd_init()
899 		lcd.charset = LCD_CHARSET_NORMAL;  in lcd_init()
900 		lcd.pins.e = PIN_STROBE;  in lcd_init()
901 		lcd.pins.rs = PIN_SELECP;  in lcd_init()
920 		lcd.charset = lcd_charset;  in lcd_init()
922 		lcd.proto = lcd_proto;  in lcd_init()
924 		lcd.pins.e = lcd_e_pin;  in lcd_init()
926 		lcd.pins.rs = lcd_rs_pin;  in lcd_init()
928 		lcd.pins.rw = lcd_rw_pin;  in lcd_init()
930 		lcd.pins.cl = lcd_cl_pin;  in lcd_init()
932 		lcd.pins.da = lcd_da_pin;  in lcd_init()
934 		lcd.pins.bl = lcd_bl_pin;  in lcd_init()
946 	if (lcd.proto == LCD_PROTO_SERIAL) {	/* SERIAL */  in lcd_init()
951 		if (lcd.pins.cl == PIN_NOT_SET)  in lcd_init()
952 			lcd.pins.cl = DEFAULT_LCD_PIN_SCL;  in lcd_init()
953 		if (lcd.pins.da == PIN_NOT_SET)  in lcd_init()
954 			lcd.pins.da = DEFAULT_LCD_PIN_SDA;  in lcd_init()
956 	} else if (lcd.proto == LCD_PROTO_PARALLEL) {	/* PARALLEL */  in lcd_init()
961 		if (lcd.pins.e == PIN_NOT_SET)  in lcd_init()
962 			lcd.pins.e = DEFAULT_LCD_PIN_E;  in lcd_init()
963 		if (lcd.pins.rs == PIN_NOT_SET)  in lcd_init()
964 			lcd.pins.rs = DEFAULT_LCD_PIN_RS;  in lcd_init()
965 		if (lcd.pins.rw == PIN_NOT_SET)  in lcd_init()
966 			lcd.pins.rw = DEFAULT_LCD_PIN_RW;  in lcd_init()
973 	if (lcd.pins.bl == PIN_NOT_SET)  in lcd_init()
974 		lcd.pins.bl = DEFAULT_LCD_PIN_BL;  in lcd_init()
976 	if (lcd.pins.e == PIN_NOT_SET)  in lcd_init()
977 		lcd.pins.e = PIN_NONE;  in lcd_init()
978 	if (lcd.pins.rs == PIN_NOT_SET)  in lcd_init()
979 		lcd.pins.rs = PIN_NONE;  in lcd_init()
980 	if (lcd.pins.rw == PIN_NOT_SET)  in lcd_init()
981 		lcd.pins.rw = PIN_NONE;  in lcd_init()
982 	if (lcd.pins.bl == PIN_NOT_SET)  in lcd_init()
983 		lcd.pins.bl = PIN_NONE;  in lcd_init()
984 	if (lcd.pins.cl == PIN_NOT_SET)  in lcd_init()
985 		lcd.pins.cl = PIN_NONE;  in lcd_init()
986 	if (lcd.pins.da == PIN_NOT_SET)  in lcd_init()
987 		lcd.pins.da = PIN_NONE;  in lcd_init()
989 	if (lcd.charset == NOT_SET)  in lcd_init()
990 		lcd.charset = DEFAULT_LCD_CHARSET;  in lcd_init()
992 	if (lcd.charset == LCD_CHARSET_KS0074)  in lcd_init()
997 	pin_to_bits(lcd.pins.e, lcd_bits[LCD_PORT_D][LCD_BIT_E],  in lcd_init()
999 	pin_to_bits(lcd.pins.rs, lcd_bits[LCD_PORT_D][LCD_BIT_RS],  in lcd_init()
1001 	pin_to_bits(lcd.pins.rw, lcd_bits[LCD_PORT_D][LCD_BIT_RW],  in lcd_init()
1003 	pin_to_bits(lcd.pins.bl, lcd_bits[LCD_PORT_D][LCD_BIT_BL],  in lcd_init()
1005 	pin_to_bits(lcd.pins.cl, lcd_bits[LCD_PORT_D][LCD_BIT_CL],  in lcd_init()
1007 	pin_to_bits(lcd.pins.da, lcd_bits[LCD_PORT_D][LCD_BIT_DA],  in lcd_init()
1010 	lcd.charlcd = charlcd;  in lcd_init()
1011 	lcd.initialized = true;  in lcd_init()
1350 	if (keypressed && lcd.enabled && lcd.initialized)  in panel_scan_timer()
1351 		charlcd_poke(lcd.charlcd);  in panel_scan_timer()
1560 	 * Overwrite selection with module param values (both keypad and lcd),  in panel_attach()
1575 	lcd.enabled = (selected_lcd_type > 0);  in panel_attach()
1577 	if (lcd.enabled) {  in panel_attach()
1579 		 * Init lcd struct with load-time values to preserve exact  in panel_attach()
1582 		lcd.charset = lcd_charset;  in panel_attach()
1583 		lcd.proto = lcd_proto;  in panel_attach()
1584 		lcd.pins.e = lcd_e_pin;  in panel_attach()
1585 		lcd.pins.rs = lcd_rs_pin;  in panel_attach()
1586 		lcd.pins.rw = lcd_rw_pin;  in panel_attach()
1587 		lcd.pins.cl = lcd_cl_pin;  in panel_attach()
1588 		lcd.pins.da = lcd_da_pin;  in panel_attach()
1589 		lcd.pins.bl = lcd_bl_pin;  in panel_attach()
1607 	if (!lcd.enabled && !keypad.enabled) {  in panel_attach()
1639 	/* must init LCD first, just in case an IRQ from the keypad is  in panel_attach()
1642 	if (lcd.enabled) {  in panel_attach()
1644 		if (!lcd.charlcd || charlcd_register(lcd.charlcd))  in panel_attach()
1658 	if (lcd.enabled)  in panel_attach()
1659 		charlcd_unregister(lcd.charlcd);  in panel_attach()
1661 	hd44780_common_free(lcd.charlcd);  in panel_attach()
1662 	lcd.charlcd = NULL;  in panel_attach()
1685 	if (lcd.enabled) {  in panel_detach()
1686 		charlcd_unregister(lcd.charlcd);  in panel_detach()
1687 		lcd.initialized = false;  in panel_detach()
1688 		hd44780_common_free(lcd.charlcd);  in panel_detach()
1689 		lcd.charlcd = NULL;  in panel_detach()