]> Git Repo - linux.git/blob - drivers/staging/panel/panel.c
dm persistent data: eliminate unnecessary return values
[linux.git] / drivers / staging / panel / panel.c
1 /*
2  * Front panel driver for Linux
3  * Copyright (C) 2000-2008, Willy Tarreau <[email protected]>
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version
8  * 2 of the License, or (at your option) any later version.
9  *
10  * This code drives an LCD module (/dev/lcd), and a keypad (/dev/keypad)
11  * connected to a parallel printer port.
12  *
13  * The LCD module may either be an HD44780-like 8-bit parallel LCD, or a 1-bit
14  * serial module compatible with Samsung's KS0074. The pins may be connected in
15  * any combination, everything is programmable.
16  *
17  * The keypad consists in a matrix of push buttons connecting input pins to
18  * data output pins or to the ground. The combinations have to be hard-coded
19  * in the driver, though several profiles exist and adding new ones is easy.
20  *
21  * Several profiles are provided for commonly found LCD+keypad modules on the
22  * market, such as those found in Nexcom's appliances.
23  *
24  * FIXME:
25  *      - the initialization/deinitialization process is very dirty and should
26  *        be rewritten. It may even be buggy.
27  *
28  * TODO:
29  *      - document 24 keys keyboard (3 rows of 8 cols, 32 diodes + 2 inputs)
30  *      - make the LCD a part of a virtual screen of Vx*Vy
31  *      - make the inputs list smp-safe
32  *      - change the keyboard to a double mapping : signals -> key_id -> values
33  *        so that applications can change values without knowing signals
34  *
35  */
36
37 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
38
39 #include <linux/module.h>
40
41 #include <linux/types.h>
42 #include <linux/errno.h>
43 #include <linux/signal.h>
44 #include <linux/sched.h>
45 #include <linux/spinlock.h>
46 #include <linux/interrupt.h>
47 #include <linux/miscdevice.h>
48 #include <linux/slab.h>
49 #include <linux/ioport.h>
50 #include <linux/fcntl.h>
51 #include <linux/init.h>
52 #include <linux/delay.h>
53 #include <linux/kernel.h>
54 #include <linux/ctype.h>
55 #include <linux/parport.h>
56 #include <linux/list.h>
57 #include <linux/notifier.h>
58 #include <linux/reboot.h>
59 #include <generated/utsrelease.h>
60
61 #include <linux/io.h>
62 #include <linux/uaccess.h>
63
64 #define LCD_MINOR               156
65 #define KEYPAD_MINOR            185
66
67 #define PANEL_VERSION           "0.9.5"
68
69 #define LCD_MAXBYTES            256     /* max burst write */
70
71 #define KEYPAD_BUFFER           64
72
73 /* poll the keyboard this every second */
74 #define INPUT_POLL_TIME         (HZ/50)
75 /* a key starts to repeat after this times INPUT_POLL_TIME */
76 #define KEYPAD_REP_START        (10)
77 /* a key repeats this times INPUT_POLL_TIME */
78 #define KEYPAD_REP_DELAY        (2)
79
80 /* keep the light on this times INPUT_POLL_TIME for each flash */
81 #define FLASH_LIGHT_TEMPO       (200)
82
83 /* converts an r_str() input to an active high, bits string : 000BAOSE */
84 #define PNL_PINPUT(a)           ((((unsigned char)(a)) ^ 0x7F) >> 3)
85
86 #define PNL_PBUSY               0x80    /* inverted input, active low */
87 #define PNL_PACK                0x40    /* direct input, active low */
88 #define PNL_POUTPA              0x20    /* direct input, active high */
89 #define PNL_PSELECD             0x10    /* direct input, active high */
90 #define PNL_PERRORP             0x08    /* direct input, active low */
91
92 #define PNL_PBIDIR              0x20    /* bi-directional ports */
93 /* high to read data in or-ed with data out */
94 #define PNL_PINTEN              0x10
95 #define PNL_PSELECP             0x08    /* inverted output, active low */
96 #define PNL_PINITP              0x04    /* direct output, active low */
97 #define PNL_PAUTOLF             0x02    /* inverted output, active low */
98 #define PNL_PSTROBE             0x01    /* inverted output */
99
100 #define PNL_PD0                 0x01
101 #define PNL_PD1                 0x02
102 #define PNL_PD2                 0x04
103 #define PNL_PD3                 0x08
104 #define PNL_PD4                 0x10
105 #define PNL_PD5                 0x20
106 #define PNL_PD6                 0x40
107 #define PNL_PD7                 0x80
108
109 #define PIN_NONE                0
110 #define PIN_STROBE              1
111 #define PIN_D0                  2
112 #define PIN_D1                  3
113 #define PIN_D2                  4
114 #define PIN_D3                  5
115 #define PIN_D4                  6
116 #define PIN_D5                  7
117 #define PIN_D6                  8
118 #define PIN_D7                  9
119 #define PIN_AUTOLF              14
120 #define PIN_INITP               16
121 #define PIN_SELECP              17
122 #define PIN_NOT_SET             127
123
124 #define LCD_FLAG_S              0x0001
125 #define LCD_FLAG_ID             0x0002
126 #define LCD_FLAG_B              0x0004  /* blink on */
127 #define LCD_FLAG_C              0x0008  /* cursor on */
128 #define LCD_FLAG_D              0x0010  /* display on */
129 #define LCD_FLAG_F              0x0020  /* large font mode */
130 #define LCD_FLAG_N              0x0040  /* 2-rows mode */
131 #define LCD_FLAG_L              0x0080  /* backlight enabled */
132
133 /* LCD commands */
134 #define LCD_CMD_DISPLAY_CLEAR   0x01    /* Clear entire display */
135
136 #define LCD_CMD_ENTRY_MODE      0x04    /* Set entry mode */
137 #define LCD_CMD_CURSOR_INC      0x02    /* Increment cursor */
138
139 #define LCD_CMD_DISPLAY_CTRL    0x08    /* Display control */
140 #define LCD_CMD_DISPLAY_ON      0x04    /* Set display on */
141 #define LCD_CMD_CURSOR_ON       0x02    /* Set cursor on */
142 #define LCD_CMD_BLINK_ON        0x01    /* Set blink on */
143
144 #define LCD_CMD_SHIFT           0x10    /* Shift cursor/display */
145 #define LCD_CMD_DISPLAY_SHIFT   0x08    /* Shift display instead of cursor */
146 #define LCD_CMD_SHIFT_RIGHT     0x04    /* Shift display/cursor to the right */
147
148 #define LCD_CMD_FUNCTION_SET    0x20    /* Set function */
149 #define LCD_CMD_DATA_LEN_8BITS  0x10    /* Set data length to 8 bits */
150 #define LCD_CMD_TWO_LINES       0x08    /* Set to two display lines */
151 #define LCD_CMD_FONT_5X10_DOTS  0x04    /* Set char font to 5x10 dots */
152
153 #define LCD_CMD_SET_CGRAM_ADDR  0x40    /* Set char generator RAM address */
154
155 #define LCD_CMD_SET_DDRAM_ADDR  0x80    /* Set display data RAM address */
156
157 #define LCD_ESCAPE_LEN          24      /* max chars for LCD escape command */
158 #define LCD_ESCAPE_CHAR 27      /* use char 27 for escape command */
159
160 #define NOT_SET                 -1
161
162 /* macros to simplify use of the parallel port */
163 #define r_ctr(x)        (parport_read_control((x)->port))
164 #define r_dtr(x)        (parport_read_data((x)->port))
165 #define r_str(x)        (parport_read_status((x)->port))
166 #define w_ctr(x, y)     (parport_write_control((x)->port, (y)))
167 #define w_dtr(x, y)     (parport_write_data((x)->port, (y)))
168
169 /* this defines which bits are to be used and which ones to be ignored */
170 /* logical or of the output bits involved in the scan matrix */
171 static __u8 scan_mask_o;
172 /* logical or of the input bits involved in the scan matrix */
173 static __u8 scan_mask_i;
174
175 typedef __u64 pmask_t;
176
177 enum input_type {
178         INPUT_TYPE_STD,
179         INPUT_TYPE_KBD,
180 };
181
182 enum input_state {
183         INPUT_ST_LOW,
184         INPUT_ST_RISING,
185         INPUT_ST_HIGH,
186         INPUT_ST_FALLING,
187 };
188
189 struct logical_input {
190         struct list_head list;
191         pmask_t mask;
192         pmask_t value;
193         enum input_type type;
194         enum input_state state;
195         __u8 rise_time, fall_time;
196         __u8 rise_timer, fall_timer, high_timer;
197
198         union {
199                 struct {        /* valid when type == INPUT_TYPE_STD */
200                         void (*press_fct)(int);
201                         void (*release_fct)(int);
202                         int press_data;
203                         int release_data;
204                 } std;
205                 struct {        /* valid when type == INPUT_TYPE_KBD */
206                         /* strings can be non null-terminated */
207                         char press_str[sizeof(void *) + sizeof(int)];
208                         char repeat_str[sizeof(void *) + sizeof(int)];
209                         char release_str[sizeof(void *) + sizeof(int)];
210                 } kbd;
211         } u;
212 };
213
214 static LIST_HEAD(logical_inputs);       /* list of all defined logical inputs */
215
216 /* physical contacts history
217  * Physical contacts are a 45 bits string of 9 groups of 5 bits each.
218  * The 8 lower groups correspond to output bits 0 to 7, and the 9th group
219  * corresponds to the ground.
220  * Within each group, bits are stored in the same order as read on the port :
221  * BAPSE (busy=4, ack=3, paper empty=2, select=1, error=0).
222  * So, each __u64 (or pmask_t) is represented like this :
223  * 0000000000000000000BAPSEBAPSEBAPSEBAPSEBAPSEBAPSEBAPSEBAPSEBAPSE
224  * <-----unused------><gnd><d07><d06><d05><d04><d03><d02><d01><d00>
225  */
226
227 /* what has just been read from the I/O ports */
228 static pmask_t phys_read;
229 /* previous phys_read */
230 static pmask_t phys_read_prev;
231 /* stabilized phys_read (phys_read|phys_read_prev) */
232 static pmask_t phys_curr;
233 /* previous phys_curr */
234 static pmask_t phys_prev;
235 /* 0 means that at least one logical signal needs be computed */
236 static char inputs_stable;
237
238 /* these variables are specific to the keypad */
239 static struct {
240         bool enabled;
241 } keypad;
242
243 static char keypad_buffer[KEYPAD_BUFFER];
244 static int keypad_buflen;
245 static int keypad_start;
246 static char keypressed;
247 static wait_queue_head_t keypad_read_wait;
248
249 /* lcd-specific variables */
250 static struct {
251         bool enabled;
252         bool initialized;
253         bool must_clear;
254
255         int height;
256         int width;
257         int bwidth;
258         int hwidth;
259         int charset;
260         int proto;
261         int light_tempo;
262
263         /* TODO: use union here? */
264         struct {
265                 int e;
266                 int rs;
267                 int rw;
268                 int cl;
269                 int da;
270                 int bl;
271         } pins;
272
273         /* contains the LCD config state */
274         unsigned long int flags;
275
276         /* Contains the LCD X and Y offset */
277         struct {
278                 unsigned long int x;
279                 unsigned long int y;
280         } addr;
281
282         /* Current escape sequence and it's length or -1 if outside */
283         struct {
284                 char buf[LCD_ESCAPE_LEN + 1];
285                 int len;
286         } esc_seq;
287 } lcd;
288
289 /* Needed only for init */
290 static int selected_lcd_type = NOT_SET;
291
292 /*
293  * Bit masks to convert LCD signals to parallel port outputs.
294  * _d_ are values for data port, _c_ are for control port.
295  * [0] = signal OFF, [1] = signal ON, [2] = mask
296  */
297 #define BIT_CLR         0
298 #define BIT_SET         1
299 #define BIT_MSK         2
300 #define BIT_STATES      3
301 /*
302  * one entry for each bit on the LCD
303  */
304 #define LCD_BIT_E       0
305 #define LCD_BIT_RS      1
306 #define LCD_BIT_RW      2
307 #define LCD_BIT_BL      3
308 #define LCD_BIT_CL      4
309 #define LCD_BIT_DA      5
310 #define LCD_BITS        6
311
312 /*
313  * each bit can be either connected to a DATA or CTRL port
314  */
315 #define LCD_PORT_C      0
316 #define LCD_PORT_D      1
317 #define LCD_PORTS       2
318
319 static unsigned char lcd_bits[LCD_PORTS][LCD_BITS][BIT_STATES];
320
321 /*
322  * LCD protocols
323  */
324 #define LCD_PROTO_PARALLEL      0
325 #define LCD_PROTO_SERIAL        1
326 #define LCD_PROTO_TI_DA8XX_LCD  2
327
328 /*
329  * LCD character sets
330  */
331 #define LCD_CHARSET_NORMAL      0
332 #define LCD_CHARSET_KS0074      1
333
334 /*
335  * LCD types
336  */
337 #define LCD_TYPE_NONE           0
338 #define LCD_TYPE_CUSTOM         1
339 #define LCD_TYPE_OLD            2
340 #define LCD_TYPE_KS0074         3
341 #define LCD_TYPE_HANTRONIX      4
342 #define LCD_TYPE_NEXCOM         5
343
344 /*
345  * keypad types
346  */
347 #define KEYPAD_TYPE_NONE        0
348 #define KEYPAD_TYPE_OLD         1
349 #define KEYPAD_TYPE_NEW         2
350 #define KEYPAD_TYPE_NEXCOM      3
351
352 /*
353  * panel profiles
354  */
355 #define PANEL_PROFILE_CUSTOM    0
356 #define PANEL_PROFILE_OLD       1
357 #define PANEL_PROFILE_NEW       2
358 #define PANEL_PROFILE_HANTRONIX 3
359 #define PANEL_PROFILE_NEXCOM    4
360 #define PANEL_PROFILE_LARGE     5
361
362 /*
363  * Construct custom config from the kernel's configuration
364  */
365 #define DEFAULT_PARPORT         0
366 #define DEFAULT_PROFILE         PANEL_PROFILE_LARGE
367 #define DEFAULT_KEYPAD_TYPE     KEYPAD_TYPE_OLD
368 #define DEFAULT_LCD_TYPE        LCD_TYPE_OLD
369 #define DEFAULT_LCD_HEIGHT      2
370 #define DEFAULT_LCD_WIDTH       40
371 #define DEFAULT_LCD_BWIDTH      40
372 #define DEFAULT_LCD_HWIDTH      64
373 #define DEFAULT_LCD_CHARSET     LCD_CHARSET_NORMAL
374 #define DEFAULT_LCD_PROTO       LCD_PROTO_PARALLEL
375
376 #define DEFAULT_LCD_PIN_E       PIN_AUTOLF
377 #define DEFAULT_LCD_PIN_RS      PIN_SELECP
378 #define DEFAULT_LCD_PIN_RW      PIN_INITP
379 #define DEFAULT_LCD_PIN_SCL     PIN_STROBE
380 #define DEFAULT_LCD_PIN_SDA     PIN_D0
381 #define DEFAULT_LCD_PIN_BL      PIN_NOT_SET
382
383 #ifdef CONFIG_PANEL_PARPORT
384 #undef DEFAULT_PARPORT
385 #define DEFAULT_PARPORT CONFIG_PANEL_PARPORT
386 #endif
387
388 #ifdef CONFIG_PANEL_PROFILE
389 #undef DEFAULT_PROFILE
390 #define DEFAULT_PROFILE CONFIG_PANEL_PROFILE
391 #endif
392
393 #if DEFAULT_PROFILE == 0        /* custom */
394 #ifdef CONFIG_PANEL_KEYPAD
395 #undef DEFAULT_KEYPAD_TYPE
396 #define DEFAULT_KEYPAD_TYPE CONFIG_PANEL_KEYPAD
397 #endif
398
399 #ifdef CONFIG_PANEL_LCD
400 #undef DEFAULT_LCD_TYPE
401 #define DEFAULT_LCD_TYPE CONFIG_PANEL_LCD
402 #endif
403
404 #ifdef CONFIG_PANEL_LCD_HEIGHT
405 #undef DEFAULT_LCD_HEIGHT
406 #define DEFAULT_LCD_HEIGHT CONFIG_PANEL_LCD_HEIGHT
407 #endif
408
409 #ifdef CONFIG_PANEL_LCD_WIDTH
410 #undef DEFAULT_LCD_WIDTH
411 #define DEFAULT_LCD_WIDTH CONFIG_PANEL_LCD_WIDTH
412 #endif
413
414 #ifdef CONFIG_PANEL_LCD_BWIDTH
415 #undef DEFAULT_LCD_BWIDTH
416 #define DEFAULT_LCD_BWIDTH CONFIG_PANEL_LCD_BWIDTH
417 #endif
418
419 #ifdef CONFIG_PANEL_LCD_HWIDTH
420 #undef DEFAULT_LCD_HWIDTH
421 #define DEFAULT_LCD_HWIDTH CONFIG_PANEL_LCD_HWIDTH
422 #endif
423
424 #ifdef CONFIG_PANEL_LCD_CHARSET
425 #undef DEFAULT_LCD_CHARSET
426 #define DEFAULT_LCD_CHARSET CONFIG_PANEL_LCD_CHARSET
427 #endif
428
429 #ifdef CONFIG_PANEL_LCD_PROTO
430 #undef DEFAULT_LCD_PROTO
431 #define DEFAULT_LCD_PROTO CONFIG_PANEL_LCD_PROTO
432 #endif
433
434 #ifdef CONFIG_PANEL_LCD_PIN_E
435 #undef DEFAULT_LCD_PIN_E
436 #define DEFAULT_LCD_PIN_E CONFIG_PANEL_LCD_PIN_E
437 #endif
438
439 #ifdef CONFIG_PANEL_LCD_PIN_RS
440 #undef DEFAULT_LCD_PIN_RS
441 #define DEFAULT_LCD_PIN_RS CONFIG_PANEL_LCD_PIN_RS
442 #endif
443
444 #ifdef CONFIG_PANEL_LCD_PIN_RW
445 #undef DEFAULT_LCD_PIN_RW
446 #define DEFAULT_LCD_PIN_RW CONFIG_PANEL_LCD_PIN_RW
447 #endif
448
449 #ifdef CONFIG_PANEL_LCD_PIN_SCL
450 #undef DEFAULT_LCD_PIN_SCL
451 #define DEFAULT_LCD_PIN_SCL CONFIG_PANEL_LCD_PIN_SCL
452 #endif
453
454 #ifdef CONFIG_PANEL_LCD_PIN_SDA
455 #undef DEFAULT_LCD_PIN_SDA
456 #define DEFAULT_LCD_PIN_SDA CONFIG_PANEL_LCD_PIN_SDA
457 #endif
458
459 #ifdef CONFIG_PANEL_LCD_PIN_BL
460 #undef DEFAULT_LCD_PIN_BL
461 #define DEFAULT_LCD_PIN_BL CONFIG_PANEL_LCD_PIN_BL
462 #endif
463
464 #endif /* DEFAULT_PROFILE == 0 */
465
466 /* global variables */
467
468 /* Device single-open policy control */
469 static atomic_t lcd_available = ATOMIC_INIT(1);
470 static atomic_t keypad_available = ATOMIC_INIT(1);
471
472 static struct pardevice *pprt;
473
474 static int keypad_initialized;
475
476 static void (*lcd_write_cmd)(int);
477 static void (*lcd_write_data)(int);
478 static void (*lcd_clear_fast)(void);
479
480 static DEFINE_SPINLOCK(pprt_lock);
481 static struct timer_list scan_timer;
482
483 MODULE_DESCRIPTION("Generic parallel port LCD/Keypad driver");
484
485 static int parport = DEFAULT_PARPORT;
486 module_param(parport, int, 0000);
487 MODULE_PARM_DESC(parport, "Parallel port index (0=lpt1, 1=lpt2, ...)");
488
489 static int profile = DEFAULT_PROFILE;
490 module_param(profile, int, 0000);
491 MODULE_PARM_DESC(profile,
492                  "1=16x2 old kp; 2=serial 16x2, new kp; 3=16x2 hantronix; "
493                  "4=16x2 nexcom; default=40x2, old kp");
494
495 static int keypad_type = NOT_SET;
496 module_param(keypad_type, int, 0000);
497 MODULE_PARM_DESC(keypad_type,
498                  "Keypad type: 0=none, 1=old 6 keys, 2=new 6+1 keys, 3=nexcom 4 keys");
499
500 static int lcd_type = NOT_SET;
501 module_param(lcd_type, int, 0000);
502 MODULE_PARM_DESC(lcd_type,
503                  "LCD type: 0=none, 1=compiled-in, 2=old, 3=serial ks0074, 4=hantronix, 5=nexcom");
504
505 static int lcd_height = NOT_SET;
506 module_param(lcd_height, int, 0000);
507 MODULE_PARM_DESC(lcd_height, "Number of lines on the LCD");
508
509 static int lcd_width = NOT_SET;
510 module_param(lcd_width, int, 0000);
511 MODULE_PARM_DESC(lcd_width, "Number of columns on the LCD");
512
513 static int lcd_bwidth = NOT_SET;        /* internal buffer width (usually 40) */
514 module_param(lcd_bwidth, int, 0000);
515 MODULE_PARM_DESC(lcd_bwidth, "Internal LCD line width (40)");
516
517 static int lcd_hwidth = NOT_SET;        /* hardware buffer width (usually 64) */
518 module_param(lcd_hwidth, int, 0000);
519 MODULE_PARM_DESC(lcd_hwidth, "LCD line hardware address (64)");
520
521 static int lcd_charset = NOT_SET;
522 module_param(lcd_charset, int, 0000);
523 MODULE_PARM_DESC(lcd_charset, "LCD character set: 0=standard, 1=KS0074");
524
525 static int lcd_proto = NOT_SET;
526 module_param(lcd_proto, int, 0000);
527 MODULE_PARM_DESC(lcd_proto,
528                  "LCD communication: 0=parallel (//), 1=serial, 2=TI LCD Interface");
529
530 /*
531  * These are the parallel port pins the LCD control signals are connected to.
532  * Set this to 0 if the signal is not used. Set it to its opposite value
533  * (negative) if the signal is negated. -MAXINT is used to indicate that the
534  * pin has not been explicitly specified.
535  *
536  * WARNING! no check will be performed about collisions with keypad !
537  */
538
539 static int lcd_e_pin  = PIN_NOT_SET;
540 module_param(lcd_e_pin, int, 0000);
541 MODULE_PARM_DESC(lcd_e_pin,
542                  "# of the // port pin connected to LCD 'E' signal, with polarity (-17..17)");
543
544 static int lcd_rs_pin = PIN_NOT_SET;
545 module_param(lcd_rs_pin, int, 0000);
546 MODULE_PARM_DESC(lcd_rs_pin,
547                  "# of the // port pin connected to LCD 'RS' signal, with polarity (-17..17)");
548
549 static int lcd_rw_pin = PIN_NOT_SET;
550 module_param(lcd_rw_pin, int, 0000);
551 MODULE_PARM_DESC(lcd_rw_pin,
552                  "# of the // port pin connected to LCD 'RW' signal, with polarity (-17..17)");
553
554 static int lcd_cl_pin = PIN_NOT_SET;
555 module_param(lcd_cl_pin, int, 0000);
556 MODULE_PARM_DESC(lcd_cl_pin,
557                  "# of the // port pin connected to serial LCD 'SCL' signal, with polarity (-17..17)");
558
559 static int lcd_da_pin = PIN_NOT_SET;
560 module_param(lcd_da_pin, int, 0000);
561 MODULE_PARM_DESC(lcd_da_pin,
562                  "# of the // port pin connected to serial LCD 'SDA' signal, with polarity (-17..17)");
563
564 static int lcd_bl_pin = PIN_NOT_SET;
565 module_param(lcd_bl_pin, int, 0000);
566 MODULE_PARM_DESC(lcd_bl_pin,
567                  "# of the // port pin connected to LCD backlight, with polarity (-17..17)");
568
569 /* Deprecated module parameters - consider not using them anymore */
570
571 static int lcd_enabled = NOT_SET;
572 module_param(lcd_enabled, int, 0000);
573 MODULE_PARM_DESC(lcd_enabled, "Deprecated option, use lcd_type instead");
574
575 static int keypad_enabled = NOT_SET;
576 module_param(keypad_enabled, int, 0000);
577 MODULE_PARM_DESC(keypad_enabled, "Deprecated option, use keypad_type instead");
578
579
580 static const unsigned char *lcd_char_conv;
581
582 /* for some LCD drivers (ks0074) we need a charset conversion table. */
583 static const unsigned char lcd_char_conv_ks0074[256] = {
584         /*          0|8   1|9   2|A   3|B   4|C   5|D   6|E   7|F */
585         /* 0x00 */ 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
586         /* 0x08 */ 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
587         /* 0x10 */ 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17,
588         /* 0x18 */ 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
589         /* 0x20 */ 0x20, 0x21, 0x22, 0x23, 0xa2, 0x25, 0x26, 0x27,
590         /* 0x28 */ 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
591         /* 0x30 */ 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
592         /* 0x38 */ 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
593         /* 0x40 */ 0xa0, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
594         /* 0x48 */ 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
595         /* 0x50 */ 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57,
596         /* 0x58 */ 0x58, 0x59, 0x5a, 0xfa, 0xfb, 0xfc, 0x1d, 0xc4,
597         /* 0x60 */ 0x96, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67,
598         /* 0x68 */ 0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f,
599         /* 0x70 */ 0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77,
600         /* 0x78 */ 0x78, 0x79, 0x7a, 0xfd, 0xfe, 0xff, 0xce, 0x20,
601         /* 0x80 */ 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87,
602         /* 0x88 */ 0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f,
603         /* 0x90 */ 0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97,
604         /* 0x98 */ 0x98, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f,
605         /* 0xA0 */ 0x20, 0x40, 0xb1, 0xa1, 0x24, 0xa3, 0xfe, 0x5f,
606         /* 0xA8 */ 0x22, 0xc8, 0x61, 0x14, 0x97, 0x2d, 0xad, 0x96,
607         /* 0xB0 */ 0x80, 0x8c, 0x82, 0x83, 0x27, 0x8f, 0x86, 0xdd,
608         /* 0xB8 */ 0x2c, 0x81, 0x6f, 0x15, 0x8b, 0x8a, 0x84, 0x60,
609         /* 0xC0 */ 0xe2, 0xe2, 0xe2, 0x5b, 0x5b, 0xae, 0xbc, 0xa9,
610         /* 0xC8 */ 0xc5, 0xbf, 0xc6, 0xf1, 0xe3, 0xe3, 0xe3, 0xe3,
611         /* 0xD0 */ 0x44, 0x5d, 0xa8, 0xe4, 0xec, 0xec, 0x5c, 0x78,
612         /* 0xD8 */ 0xab, 0xa6, 0xe5, 0x5e, 0x5e, 0xe6, 0xaa, 0xbe,
613         /* 0xE0 */ 0x7f, 0xe7, 0xaf, 0x7b, 0x7b, 0xaf, 0xbd, 0xc8,
614         /* 0xE8 */ 0xa4, 0xa5, 0xc7, 0xf6, 0xa7, 0xe8, 0x69, 0x69,
615         /* 0xF0 */ 0xed, 0x7d, 0xa8, 0xe4, 0xec, 0x5c, 0x5c, 0x25,
616         /* 0xF8 */ 0xac, 0xa6, 0xea, 0xef, 0x7e, 0xeb, 0xb2, 0x79,
617 };
618
619 static const char old_keypad_profile[][4][9] = {
620         {"S0", "Left\n", "Left\n", ""},
621         {"S1", "Down\n", "Down\n", ""},
622         {"S2", "Up\n", "Up\n", ""},
623         {"S3", "Right\n", "Right\n", ""},
624         {"S4", "Esc\n", "Esc\n", ""},
625         {"S5", "Ret\n", "Ret\n", ""},
626         {"", "", "", ""}
627 };
628
629 /* signals, press, repeat, release */
630 static const char new_keypad_profile[][4][9] = {
631         {"S0", "Left\n", "Left\n", ""},
632         {"S1", "Down\n", "Down\n", ""},
633         {"S2", "Up\n", "Up\n", ""},
634         {"S3", "Right\n", "Right\n", ""},
635         {"S4s5", "", "Esc\n", "Esc\n"},
636         {"s4S5", "", "Ret\n", "Ret\n"},
637         {"S4S5", "Help\n", "", ""},
638         /* add new signals above this line */
639         {"", "", "", ""}
640 };
641
642 /* signals, press, repeat, release */
643 static const char nexcom_keypad_profile[][4][9] = {
644         {"a-p-e-", "Down\n", "Down\n", ""},
645         {"a-p-E-", "Ret\n", "Ret\n", ""},
646         {"a-P-E-", "Esc\n", "Esc\n", ""},
647         {"a-P-e-", "Up\n", "Up\n", ""},
648         /* add new signals above this line */
649         {"", "", "", ""}
650 };
651
652 static const char (*keypad_profile)[4][9] = old_keypad_profile;
653
654 /* FIXME: this should be converted to a bit array containing signals states */
655 static struct {
656         unsigned char e;  /* parallel LCD E (data latch on falling edge) */
657         unsigned char rs; /* parallel LCD RS  (0 = cmd, 1 = data) */
658         unsigned char rw; /* parallel LCD R/W (0 = W, 1 = R) */
659         unsigned char bl; /* parallel LCD backlight (0 = off, 1 = on) */
660         unsigned char cl; /* serial LCD clock (latch on rising edge) */
661         unsigned char da; /* serial LCD data */
662 } bits;
663
664 static void init_scan_timer(void);
665
666 /* sets data port bits according to current signals values */
667 static int set_data_bits(void)
668 {
669         int val, bit;
670
671         val = r_dtr(pprt);
672         for (bit = 0; bit < LCD_BITS; bit++)
673                 val &= lcd_bits[LCD_PORT_D][bit][BIT_MSK];
674
675         val |= lcd_bits[LCD_PORT_D][LCD_BIT_E][bits.e]
676             | lcd_bits[LCD_PORT_D][LCD_BIT_RS][bits.rs]
677             | lcd_bits[LCD_PORT_D][LCD_BIT_RW][bits.rw]
678             | lcd_bits[LCD_PORT_D][LCD_BIT_BL][bits.bl]
679             | lcd_bits[LCD_PORT_D][LCD_BIT_CL][bits.cl]
680             | lcd_bits[LCD_PORT_D][LCD_BIT_DA][bits.da];
681
682         w_dtr(pprt, val);
683         return val;
684 }
685
686 /* sets ctrl port bits according to current signals values */
687 static int set_ctrl_bits(void)
688 {
689         int val, bit;
690
691         val = r_ctr(pprt);
692         for (bit = 0; bit < LCD_BITS; bit++)
693                 val &= lcd_bits[LCD_PORT_C][bit][BIT_MSK];
694
695         val |= lcd_bits[LCD_PORT_C][LCD_BIT_E][bits.e]
696             | lcd_bits[LCD_PORT_C][LCD_BIT_RS][bits.rs]
697             | lcd_bits[LCD_PORT_C][LCD_BIT_RW][bits.rw]
698             | lcd_bits[LCD_PORT_C][LCD_BIT_BL][bits.bl]
699             | lcd_bits[LCD_PORT_C][LCD_BIT_CL][bits.cl]
700             | lcd_bits[LCD_PORT_C][LCD_BIT_DA][bits.da];
701
702         w_ctr(pprt, val);
703         return val;
704 }
705
706 /* sets ctrl & data port bits according to current signals values */
707 static void panel_set_bits(void)
708 {
709         set_data_bits();
710         set_ctrl_bits();
711 }
712
713 /*
714  * Converts a parallel port pin (from -25 to 25) to data and control ports
715  * masks, and data and control port bits. The signal will be considered
716  * unconnected if it's on pin 0 or an invalid pin (<-25 or >25).
717  *
718  * Result will be used this way :
719  *   out(dport, in(dport) & d_val[2] | d_val[signal_state])
720  *   out(cport, in(cport) & c_val[2] | c_val[signal_state])
721  */
722 static void pin_to_bits(int pin, unsigned char *d_val, unsigned char *c_val)
723 {
724         int d_bit, c_bit, inv;
725
726         d_val[0] = 0;
727         c_val[0] = 0;
728         d_val[1] = 0;
729         c_val[1] = 0;
730         d_val[2] = 0xFF;
731         c_val[2] = 0xFF;
732
733         if (pin == 0)
734                 return;
735
736         inv = (pin < 0);
737         if (inv)
738                 pin = -pin;
739
740         d_bit = 0;
741         c_bit = 0;
742
743         switch (pin) {
744         case PIN_STROBE:        /* strobe, inverted */
745                 c_bit = PNL_PSTROBE;
746                 inv = !inv;
747                 break;
748         case PIN_D0...PIN_D7:   /* D0 - D7 = 2 - 9 */
749                 d_bit = 1 << (pin - 2);
750                 break;
751         case PIN_AUTOLF:        /* autofeed, inverted */
752                 c_bit = PNL_PAUTOLF;
753                 inv = !inv;
754                 break;
755         case PIN_INITP:         /* init, direct */
756                 c_bit = PNL_PINITP;
757                 break;
758         case PIN_SELECP:        /* select_in, inverted */
759                 c_bit = PNL_PSELECP;
760                 inv = !inv;
761                 break;
762         default:                /* unknown pin, ignore */
763                 break;
764         }
765
766         if (c_bit) {
767                 c_val[2] &= ~c_bit;
768                 c_val[!inv] = c_bit;
769         } else if (d_bit) {
770                 d_val[2] &= ~d_bit;
771                 d_val[!inv] = d_bit;
772         }
773 }
774
775 /* sleeps that many milliseconds with a reschedule */
776 static void long_sleep(int ms)
777 {
778         if (in_interrupt())
779                 mdelay(ms);
780         else
781                 schedule_timeout_interruptible(msecs_to_jiffies(ms));
782 }
783
784 /*
785  * send a serial byte to the LCD panel. The caller is responsible for locking
786  * if needed.
787  */
788 static void lcd_send_serial(int byte)
789 {
790         int bit;
791
792         /*
793          * the data bit is set on D0, and the clock on STROBE.
794          * LCD reads D0 on STROBE's rising edge.
795          */
796         for (bit = 0; bit < 8; bit++) {
797                 bits.cl = BIT_CLR;      /* CLK low */
798                 panel_set_bits();
799                 bits.da = byte & 1;
800                 panel_set_bits();
801                 udelay(2);  /* maintain the data during 2 us before CLK up */
802                 bits.cl = BIT_SET;      /* CLK high */
803                 panel_set_bits();
804                 udelay(1);  /* maintain the strobe during 1 us */
805                 byte >>= 1;
806         }
807 }
808
809 /* turn the backlight on or off */
810 static void lcd_backlight(int on)
811 {
812         if (lcd.pins.bl == PIN_NONE)
813                 return;
814
815         /* The backlight is activated by setting the AUTOFEED line to +5V  */
816         spin_lock_irq(&pprt_lock);
817         bits.bl = on;
818         panel_set_bits();
819         spin_unlock_irq(&pprt_lock);
820 }
821
822 /* send a command to the LCD panel in serial mode */
823 static void lcd_write_cmd_s(int cmd)
824 {
825         spin_lock_irq(&pprt_lock);
826         lcd_send_serial(0x1F);  /* R/W=W, RS=0 */
827         lcd_send_serial(cmd & 0x0F);
828         lcd_send_serial((cmd >> 4) & 0x0F);
829         udelay(40);             /* the shortest command takes at least 40 us */
830         spin_unlock_irq(&pprt_lock);
831 }
832
833 /* send data to the LCD panel in serial mode */
834 static void lcd_write_data_s(int data)
835 {
836         spin_lock_irq(&pprt_lock);
837         lcd_send_serial(0x5F);  /* R/W=W, RS=1 */
838         lcd_send_serial(data & 0x0F);
839         lcd_send_serial((data >> 4) & 0x0F);
840         udelay(40);             /* the shortest data takes at least 40 us */
841         spin_unlock_irq(&pprt_lock);
842 }
843
844 /* send a command to the LCD panel in 8 bits parallel mode */
845 static void lcd_write_cmd_p8(int cmd)
846 {
847         spin_lock_irq(&pprt_lock);
848         /* present the data to the data port */
849         w_dtr(pprt, cmd);
850         udelay(20);     /* maintain the data during 20 us before the strobe */
851
852         bits.e = BIT_SET;
853         bits.rs = BIT_CLR;
854         bits.rw = BIT_CLR;
855         set_ctrl_bits();
856
857         udelay(40);     /* maintain the strobe during 40 us */
858
859         bits.e = BIT_CLR;
860         set_ctrl_bits();
861
862         udelay(120);    /* the shortest command takes at least 120 us */
863         spin_unlock_irq(&pprt_lock);
864 }
865
866 /* send data to the LCD panel in 8 bits parallel mode */
867 static void lcd_write_data_p8(int data)
868 {
869         spin_lock_irq(&pprt_lock);
870         /* present the data to the data port */
871         w_dtr(pprt, data);
872         udelay(20);     /* maintain the data during 20 us before the strobe */
873
874         bits.e = BIT_SET;
875         bits.rs = BIT_SET;
876         bits.rw = BIT_CLR;
877         set_ctrl_bits();
878
879         udelay(40);     /* maintain the strobe during 40 us */
880
881         bits.e = BIT_CLR;
882         set_ctrl_bits();
883
884         udelay(45);     /* the shortest data takes at least 45 us */
885         spin_unlock_irq(&pprt_lock);
886 }
887
888 /* send a command to the TI LCD panel */
889 static void lcd_write_cmd_tilcd(int cmd)
890 {
891         spin_lock_irq(&pprt_lock);
892         /* present the data to the control port */
893         w_ctr(pprt, cmd);
894         udelay(60);
895         spin_unlock_irq(&pprt_lock);
896 }
897
898 /* send data to the TI LCD panel */
899 static void lcd_write_data_tilcd(int data)
900 {
901         spin_lock_irq(&pprt_lock);
902         /* present the data to the data port */
903         w_dtr(pprt, data);
904         udelay(60);
905         spin_unlock_irq(&pprt_lock);
906 }
907
908 static void lcd_gotoxy(void)
909 {
910         lcd_write_cmd(LCD_CMD_SET_DDRAM_ADDR
911                       | (lcd.addr.y ? lcd.hwidth : 0)
912                       /* we force the cursor to stay at the end of the
913                          line if it wants to go farther */
914                       | ((lcd.addr.x < lcd.bwidth) ? lcd.addr.x &
915                          (lcd.hwidth - 1) : lcd.bwidth - 1));
916 }
917
918 static void lcd_print(char c)
919 {
920         if (lcd.addr.x < lcd.bwidth) {
921                 if (lcd_char_conv != NULL)
922                         c = lcd_char_conv[(unsigned char)c];
923                 lcd_write_data(c);
924                 lcd.addr.x++;
925         }
926         /* prevents the cursor from wrapping onto the next line */
927         if (lcd.addr.x == lcd.bwidth)
928                 lcd_gotoxy();
929 }
930
931 /* fills the display with spaces and resets X/Y */
932 static void lcd_clear_fast_s(void)
933 {
934         int pos;
935
936         lcd.addr.x = 0;
937         lcd.addr.y = 0;
938         lcd_gotoxy();
939
940         spin_lock_irq(&pprt_lock);
941         for (pos = 0; pos < lcd.height * lcd.hwidth; pos++) {
942                 lcd_send_serial(0x5F);  /* R/W=W, RS=1 */
943                 lcd_send_serial(' ' & 0x0F);
944                 lcd_send_serial((' ' >> 4) & 0x0F);
945                 udelay(40);     /* the shortest data takes at least 40 us */
946         }
947         spin_unlock_irq(&pprt_lock);
948
949         lcd.addr.x = 0;
950         lcd.addr.y = 0;
951         lcd_gotoxy();
952 }
953
954 /* fills the display with spaces and resets X/Y */
955 static void lcd_clear_fast_p8(void)
956 {
957         int pos;
958
959         lcd.addr.x = 0;
960         lcd.addr.y = 0;
961         lcd_gotoxy();
962
963         spin_lock_irq(&pprt_lock);
964         for (pos = 0; pos < lcd.height * lcd.hwidth; pos++) {
965                 /* present the data to the data port */
966                 w_dtr(pprt, ' ');
967
968                 /* maintain the data during 20 us before the strobe */
969                 udelay(20);
970
971                 bits.e = BIT_SET;
972                 bits.rs = BIT_SET;
973                 bits.rw = BIT_CLR;
974                 set_ctrl_bits();
975
976                 /* maintain the strobe during 40 us */
977                 udelay(40);
978
979                 bits.e = BIT_CLR;
980                 set_ctrl_bits();
981
982                 /* the shortest data takes at least 45 us */
983                 udelay(45);
984         }
985         spin_unlock_irq(&pprt_lock);
986
987         lcd.addr.x = 0;
988         lcd.addr.y = 0;
989         lcd_gotoxy();
990 }
991
992 /* fills the display with spaces and resets X/Y */
993 static void lcd_clear_fast_tilcd(void)
994 {
995         int pos;
996
997         lcd.addr.x = 0;
998         lcd.addr.y = 0;
999         lcd_gotoxy();
1000
1001         spin_lock_irq(&pprt_lock);
1002         for (pos = 0; pos < lcd.height * lcd.hwidth; pos++) {
1003                 /* present the data to the data port */
1004                 w_dtr(pprt, ' ');
1005                 udelay(60);
1006         }
1007
1008         spin_unlock_irq(&pprt_lock);
1009
1010         lcd.addr.x = 0;
1011         lcd.addr.y = 0;
1012         lcd_gotoxy();
1013 }
1014
1015 /* clears the display and resets X/Y */
1016 static void lcd_clear_display(void)
1017 {
1018         lcd_write_cmd(LCD_CMD_DISPLAY_CLEAR);
1019         lcd.addr.x = 0;
1020         lcd.addr.y = 0;
1021         /* we must wait a few milliseconds (15) */
1022         long_sleep(15);
1023 }
1024
1025 static void lcd_init_display(void)
1026 {
1027         lcd.flags = ((lcd.height > 1) ? LCD_FLAG_N : 0)
1028             | LCD_FLAG_D | LCD_FLAG_C | LCD_FLAG_B;
1029
1030         long_sleep(20);         /* wait 20 ms after power-up for the paranoid */
1031
1032         /* 8bits, 1 line, small fonts; let's do it 3 times */
1033         lcd_write_cmd(LCD_CMD_FUNCTION_SET | LCD_CMD_DATA_LEN_8BITS);
1034         long_sleep(10);
1035         lcd_write_cmd(LCD_CMD_FUNCTION_SET | LCD_CMD_DATA_LEN_8BITS);
1036         long_sleep(10);
1037         lcd_write_cmd(LCD_CMD_FUNCTION_SET | LCD_CMD_DATA_LEN_8BITS);
1038         long_sleep(10);
1039
1040         /* set font height and lines number */
1041         lcd_write_cmd(LCD_CMD_FUNCTION_SET | LCD_CMD_DATA_LEN_8BITS
1042                       | ((lcd.flags & LCD_FLAG_F) ? LCD_CMD_FONT_5X10_DOTS : 0)
1043                       | ((lcd.flags & LCD_FLAG_N) ? LCD_CMD_TWO_LINES : 0)
1044             );
1045         long_sleep(10);
1046
1047         /* display off, cursor off, blink off */
1048         lcd_write_cmd(LCD_CMD_DISPLAY_CTRL);
1049         long_sleep(10);
1050
1051         lcd_write_cmd(LCD_CMD_DISPLAY_CTRL      /* set display mode */
1052                       | ((lcd.flags & LCD_FLAG_D) ? LCD_CMD_DISPLAY_ON : 0)
1053                       | ((lcd.flags & LCD_FLAG_C) ? LCD_CMD_CURSOR_ON : 0)
1054                       | ((lcd.flags & LCD_FLAG_B) ? LCD_CMD_BLINK_ON : 0)
1055             );
1056
1057         lcd_backlight((lcd.flags & LCD_FLAG_L) ? 1 : 0);
1058
1059         long_sleep(10);
1060
1061         /* entry mode set : increment, cursor shifting */
1062         lcd_write_cmd(LCD_CMD_ENTRY_MODE | LCD_CMD_CURSOR_INC);
1063
1064         lcd_clear_display();
1065 }
1066
1067 /*
1068  * These are the file operation function for user access to /dev/lcd
1069  * This function can also be called from inside the kernel, by
1070  * setting file and ppos to NULL.
1071  *
1072  */
1073
1074 static inline int handle_lcd_special_code(void)
1075 {
1076         /* LCD special codes */
1077
1078         int processed = 0;
1079
1080         char *esc = lcd.esc_seq.buf + 2;
1081         int oldflags = lcd.flags;
1082
1083         /* check for display mode flags */
1084         switch (*esc) {
1085         case 'D':       /* Display ON */
1086                 lcd.flags |= LCD_FLAG_D;
1087                 processed = 1;
1088                 break;
1089         case 'd':       /* Display OFF */
1090                 lcd.flags &= ~LCD_FLAG_D;
1091                 processed = 1;
1092                 break;
1093         case 'C':       /* Cursor ON */
1094                 lcd.flags |= LCD_FLAG_C;
1095                 processed = 1;
1096                 break;
1097         case 'c':       /* Cursor OFF */
1098                 lcd.flags &= ~LCD_FLAG_C;
1099                 processed = 1;
1100                 break;
1101         case 'B':       /* Blink ON */
1102                 lcd.flags |= LCD_FLAG_B;
1103                 processed = 1;
1104                 break;
1105         case 'b':       /* Blink OFF */
1106                 lcd.flags &= ~LCD_FLAG_B;
1107                 processed = 1;
1108                 break;
1109         case '+':       /* Back light ON */
1110                 lcd.flags |= LCD_FLAG_L;
1111                 processed = 1;
1112                 break;
1113         case '-':       /* Back light OFF */
1114                 lcd.flags &= ~LCD_FLAG_L;
1115                 processed = 1;
1116                 break;
1117         case '*':
1118                 /* flash back light using the keypad timer */
1119                 if (scan_timer.function != NULL) {
1120                         if (lcd.light_tempo == 0
1121                                         && ((lcd.flags & LCD_FLAG_L) == 0))
1122                                 lcd_backlight(1);
1123                         lcd.light_tempo = FLASH_LIGHT_TEMPO;
1124                 }
1125                 processed = 1;
1126                 break;
1127         case 'f':       /* Small Font */
1128                 lcd.flags &= ~LCD_FLAG_F;
1129                 processed = 1;
1130                 break;
1131         case 'F':       /* Large Font */
1132                 lcd.flags |= LCD_FLAG_F;
1133                 processed = 1;
1134                 break;
1135         case 'n':       /* One Line */
1136                 lcd.flags &= ~LCD_FLAG_N;
1137                 processed = 1;
1138                 break;
1139         case 'N':       /* Two Lines */
1140                 lcd.flags |= LCD_FLAG_N;
1141                 break;
1142         case 'l':       /* Shift Cursor Left */
1143                 if (lcd.addr.x > 0) {
1144                         /* back one char if not at end of line */
1145                         if (lcd.addr.x < lcd.bwidth)
1146                                 lcd_write_cmd(LCD_CMD_SHIFT);
1147                         lcd.addr.x--;
1148                 }
1149                 processed = 1;
1150                 break;
1151         case 'r':       /* shift cursor right */
1152                 if (lcd.addr.x < lcd.width) {
1153                         /* allow the cursor to pass the end of the line */
1154                         if (lcd.addr.x < (lcd.bwidth - 1))
1155                                 lcd_write_cmd(LCD_CMD_SHIFT |
1156                                                 LCD_CMD_SHIFT_RIGHT);
1157                         lcd.addr.x++;
1158                 }
1159                 processed = 1;
1160                 break;
1161         case 'L':       /* shift display left */
1162                 lcd_write_cmd(LCD_CMD_SHIFT | LCD_CMD_DISPLAY_SHIFT);
1163                 processed = 1;
1164                 break;
1165         case 'R':       /* shift display right */
1166                 lcd_write_cmd(LCD_CMD_SHIFT | LCD_CMD_DISPLAY_SHIFT |
1167                                 LCD_CMD_SHIFT_RIGHT);
1168                 processed = 1;
1169                 break;
1170         case 'k': {     /* kill end of line */
1171                 int x;
1172
1173                 for (x = lcd.addr.x; x < lcd.bwidth; x++)
1174                         lcd_write_data(' ');
1175
1176                 /* restore cursor position */
1177                 lcd_gotoxy();
1178                 processed = 1;
1179                 break;
1180         }
1181         case 'I':       /* reinitialize display */
1182                 lcd_init_display();
1183                 processed = 1;
1184                 break;
1185         case 'G': {
1186                 /* Generator : LGcxxxxx...xx; must have <c> between '0'
1187                  * and '7', representing the numerical ASCII code of the
1188                  * redefined character, and <xx...xx> a sequence of 16
1189                  * hex digits representing 8 bytes for each character.
1190                  * Most LCDs will only use 5 lower bits of the 7 first
1191                  * bytes.
1192                  */
1193
1194                 unsigned char cgbytes[8];
1195                 unsigned char cgaddr;
1196                 int cgoffset;
1197                 int shift;
1198                 char value;
1199                 int addr;
1200
1201                 if (strchr(esc, ';') == NULL)
1202                         break;
1203
1204                 esc++;
1205
1206                 cgaddr = *(esc++) - '0';
1207                 if (cgaddr > 7) {
1208                         processed = 1;
1209                         break;
1210                 }
1211
1212                 cgoffset = 0;
1213                 shift = 0;
1214                 value = 0;
1215                 while (*esc && cgoffset < 8) {
1216                         shift ^= 4;
1217                         if (*esc >= '0' && *esc <= '9') {
1218                                 value |= (*esc - '0') << shift;
1219                         } else if (*esc >= 'A' && *esc <= 'Z') {
1220                                 value |= (*esc - 'A' + 10) << shift;
1221                         } else if (*esc >= 'a' && *esc <= 'z') {
1222                                 value |= (*esc - 'a' + 10) << shift;
1223                         } else {
1224                                 esc++;
1225                                 continue;
1226                         }
1227
1228                         if (shift == 0) {
1229                                 cgbytes[cgoffset++] = value;
1230                                 value = 0;
1231                         }
1232
1233                         esc++;
1234                 }
1235
1236                 lcd_write_cmd(LCD_CMD_SET_CGRAM_ADDR | (cgaddr * 8));
1237                 for (addr = 0; addr < cgoffset; addr++)
1238                         lcd_write_data(cgbytes[addr]);
1239
1240                 /* ensures that we stop writing to CGRAM */
1241                 lcd_gotoxy();
1242                 processed = 1;
1243                 break;
1244         }
1245         case 'x':       /* gotoxy : LxXXX[yYYY]; */
1246         case 'y':       /* gotoxy : LyYYY[xXXX]; */
1247                 if (strchr(esc, ';') == NULL)
1248                         break;
1249
1250                 while (*esc) {
1251                         if (*esc == 'x') {
1252                                 esc++;
1253                                 if (kstrtoul(esc, 10, &lcd.addr.x) < 0)
1254                                         break;
1255                         } else if (*esc == 'y') {
1256                                 esc++;
1257                                 if (kstrtoul(esc, 10, &lcd.addr.y) < 0)
1258                                         break;
1259                         } else {
1260                                 break;
1261                         }
1262                 }
1263
1264                 lcd_gotoxy();
1265                 processed = 1;
1266                 break;
1267         }
1268
1269         /* TODO: This indent party here got ugly, clean it! */
1270         /* Check whether one flag was changed */
1271         if (oldflags != lcd.flags) {
1272                 /* check whether one of B,C,D flags were changed */
1273                 if ((oldflags ^ lcd.flags) &
1274                     (LCD_FLAG_B | LCD_FLAG_C | LCD_FLAG_D))
1275                         /* set display mode */
1276                         lcd_write_cmd(LCD_CMD_DISPLAY_CTRL
1277                                       | ((lcd.flags & LCD_FLAG_D)
1278                                                       ? LCD_CMD_DISPLAY_ON : 0)
1279                                       | ((lcd.flags & LCD_FLAG_C)
1280                                                       ? LCD_CMD_CURSOR_ON : 0)
1281                                       | ((lcd.flags & LCD_FLAG_B)
1282                                                       ? LCD_CMD_BLINK_ON : 0));
1283                 /* check whether one of F,N flags was changed */
1284                 else if ((oldflags ^ lcd.flags) & (LCD_FLAG_F | LCD_FLAG_N))
1285                         lcd_write_cmd(LCD_CMD_FUNCTION_SET
1286                                       | LCD_CMD_DATA_LEN_8BITS
1287                                       | ((lcd.flags & LCD_FLAG_F)
1288                                                       ? LCD_CMD_TWO_LINES : 0)
1289                                       | ((lcd.flags & LCD_FLAG_N)
1290                                                       ? LCD_CMD_FONT_5X10_DOTS
1291                                                                       : 0));
1292                 /* check whether L flag was changed */
1293                 else if ((oldflags ^ lcd.flags) & (LCD_FLAG_L)) {
1294                         if (lcd.flags & (LCD_FLAG_L))
1295                                 lcd_backlight(1);
1296                         else if (lcd.light_tempo == 0)
1297                                 /* switch off the light only when the tempo
1298                                    lighting is gone */
1299                                 lcd_backlight(0);
1300                 }
1301         }
1302
1303         return processed;
1304 }
1305
1306 static void lcd_write_char(char c)
1307 {
1308         /* first, we'll test if we're in escape mode */
1309         if ((c != '\n') && lcd.esc_seq.len >= 0) {
1310                 /* yes, let's add this char to the buffer */
1311                 lcd.esc_seq.buf[lcd.esc_seq.len++] = c;
1312                 lcd.esc_seq.buf[lcd.esc_seq.len] = 0;
1313         } else {
1314                 /* aborts any previous escape sequence */
1315                 lcd.esc_seq.len = -1;
1316
1317                 switch (c) {
1318                 case LCD_ESCAPE_CHAR:
1319                         /* start of an escape sequence */
1320                         lcd.esc_seq.len = 0;
1321                         lcd.esc_seq.buf[lcd.esc_seq.len] = 0;
1322                         break;
1323                 case '\b':
1324                         /* go back one char and clear it */
1325                         if (lcd.addr.x > 0) {
1326                                 /* check if we're not at the
1327                                    end of the line */
1328                                 if (lcd.addr.x < lcd.bwidth)
1329                                         /* back one char */
1330                                         lcd_write_cmd(LCD_CMD_SHIFT);
1331                                 lcd.addr.x--;
1332                         }
1333                         /* replace with a space */
1334                         lcd_write_data(' ');
1335                         /* back one char again */
1336                         lcd_write_cmd(LCD_CMD_SHIFT);
1337                         break;
1338                 case '\014':
1339                         /* quickly clear the display */
1340                         lcd_clear_fast();
1341                         break;
1342                 case '\n':
1343                         /* flush the remainder of the current line and
1344                            go to the beginning of the next line */
1345                         for (; lcd.addr.x < lcd.bwidth; lcd.addr.x++)
1346                                 lcd_write_data(' ');
1347                         lcd.addr.x = 0;
1348                         lcd.addr.y = (lcd.addr.y + 1) % lcd.height;
1349                         lcd_gotoxy();
1350                         break;
1351                 case '\r':
1352                         /* go to the beginning of the same line */
1353                         lcd.addr.x = 0;
1354                         lcd_gotoxy();
1355                         break;
1356                 case '\t':
1357                         /* print a space instead of the tab */
1358                         lcd_print(' ');
1359                         break;
1360                 default:
1361                         /* simply print this char */
1362                         lcd_print(c);
1363                         break;
1364                 }
1365         }
1366
1367         /* now we'll see if we're in an escape mode and if the current
1368            escape sequence can be understood. */
1369         if (lcd.esc_seq.len >= 2) {
1370                 int processed = 0;
1371
1372                 if (!strcmp(lcd.esc_seq.buf, "[2J")) {
1373                         /* clear the display */
1374                         lcd_clear_fast();
1375                         processed = 1;
1376                 } else if (!strcmp(lcd.esc_seq.buf, "[H")) {
1377                         /* cursor to home */
1378                         lcd.addr.x = 0;
1379                         lcd.addr.y = 0;
1380                         lcd_gotoxy();
1381                         processed = 1;
1382                 }
1383                 /* codes starting with ^[[L */
1384                 else if ((lcd.esc_seq.len >= 3) &&
1385                          (lcd.esc_seq.buf[0] == '[') &&
1386                          (lcd.esc_seq.buf[1] == 'L')) {
1387                         processed = handle_lcd_special_code();
1388                 }
1389
1390                 /* LCD special escape codes */
1391                 /* flush the escape sequence if it's been processed
1392                    or if it is getting too long. */
1393                 if (processed || (lcd.esc_seq.len >= LCD_ESCAPE_LEN))
1394                         lcd.esc_seq.len = -1;
1395         } /* escape codes */
1396 }
1397
1398 static ssize_t lcd_write(struct file *file,
1399                          const char __user *buf, size_t count, loff_t *ppos)
1400 {
1401         const char __user *tmp = buf;
1402         char c;
1403
1404         for (; count-- > 0; (*ppos)++, tmp++) {
1405                 if (!in_interrupt() && (((count + 1) & 0x1f) == 0))
1406                         /* let's be a little nice with other processes
1407                            that need some CPU */
1408                         schedule();
1409
1410                 if (get_user(c, tmp))
1411                         return -EFAULT;
1412
1413                 lcd_write_char(c);
1414         }
1415
1416         return tmp - buf;
1417 }
1418
1419 static int lcd_open(struct inode *inode, struct file *file)
1420 {
1421         if (!atomic_dec_and_test(&lcd_available))
1422                 return -EBUSY;  /* open only once at a time */
1423
1424         if (file->f_mode & FMODE_READ)  /* device is write-only */
1425                 return -EPERM;
1426
1427         if (lcd.must_clear) {
1428                 lcd_clear_display();
1429                 lcd.must_clear = false;
1430         }
1431         return nonseekable_open(inode, file);
1432 }
1433
1434 static int lcd_release(struct inode *inode, struct file *file)
1435 {
1436         atomic_inc(&lcd_available);
1437         return 0;
1438 }
1439
1440 static const struct file_operations lcd_fops = {
1441         .write   = lcd_write,
1442         .open    = lcd_open,
1443         .release = lcd_release,
1444         .llseek  = no_llseek,
1445 };
1446
1447 static struct miscdevice lcd_dev = {
1448         .minor  = LCD_MINOR,
1449         .name   = "lcd",
1450         .fops   = &lcd_fops,
1451 };
1452
1453 /* public function usable from the kernel for any purpose */
1454 static void panel_lcd_print(const char *s)
1455 {
1456         const char *tmp = s;
1457         int count = strlen(s);
1458
1459         if (lcd.enabled && lcd.initialized) {
1460                 for (; count-- > 0; tmp++) {
1461                         if (!in_interrupt() && (((count + 1) & 0x1f) == 0))
1462                                 /* let's be a little nice with other processes
1463                                    that need some CPU */
1464                                 schedule();
1465
1466                         lcd_write_char(*tmp);
1467                 }
1468         }
1469 }
1470
1471 /* initialize the LCD driver */
1472 static void lcd_init(void)
1473 {
1474         switch (selected_lcd_type) {
1475         case LCD_TYPE_OLD:
1476                 /* parallel mode, 8 bits */
1477                 lcd.proto = LCD_PROTO_PARALLEL;
1478                 lcd.charset = LCD_CHARSET_NORMAL;
1479                 lcd.pins.e = PIN_STROBE;
1480                 lcd.pins.rs = PIN_AUTOLF;
1481
1482                 lcd.width = 40;
1483                 lcd.bwidth = 40;
1484                 lcd.hwidth = 64;
1485                 lcd.height = 2;
1486                 break;
1487         case LCD_TYPE_KS0074:
1488                 /* serial mode, ks0074 */
1489                 lcd.proto = LCD_PROTO_SERIAL;
1490                 lcd.charset = LCD_CHARSET_KS0074;
1491                 lcd.pins.bl = PIN_AUTOLF;
1492                 lcd.pins.cl = PIN_STROBE;
1493                 lcd.pins.da = PIN_D0;
1494
1495                 lcd.width = 16;
1496                 lcd.bwidth = 40;
1497                 lcd.hwidth = 16;
1498                 lcd.height = 2;
1499                 break;
1500         case LCD_TYPE_NEXCOM:
1501                 /* parallel mode, 8 bits, generic */
1502                 lcd.proto = LCD_PROTO_PARALLEL;
1503                 lcd.charset = LCD_CHARSET_NORMAL;
1504                 lcd.pins.e = PIN_AUTOLF;
1505                 lcd.pins.rs = PIN_SELECP;
1506                 lcd.pins.rw = PIN_INITP;
1507
1508                 lcd.width = 16;
1509                 lcd.bwidth = 40;
1510                 lcd.hwidth = 64;
1511                 lcd.height = 2;
1512                 break;
1513         case LCD_TYPE_CUSTOM:
1514                 /* customer-defined */
1515                 lcd.proto = DEFAULT_LCD_PROTO;
1516                 lcd.charset = DEFAULT_LCD_CHARSET;
1517                 /* default geometry will be set later */
1518                 break;
1519         case LCD_TYPE_HANTRONIX:
1520                 /* parallel mode, 8 bits, hantronix-like */
1521         default:
1522                 lcd.proto = LCD_PROTO_PARALLEL;
1523                 lcd.charset = LCD_CHARSET_NORMAL;
1524                 lcd.pins.e = PIN_STROBE;
1525                 lcd.pins.rs = PIN_SELECP;
1526
1527                 lcd.width = 16;
1528                 lcd.bwidth = 40;
1529                 lcd.hwidth = 64;
1530                 lcd.height = 2;
1531                 break;
1532         }
1533
1534         /* Overwrite with module params set on loading */
1535         if (lcd_height != NOT_SET)
1536                 lcd.height = lcd_height;
1537         if (lcd_width != NOT_SET)
1538                 lcd.width = lcd_width;
1539         if (lcd_bwidth != NOT_SET)
1540                 lcd.bwidth = lcd_bwidth;
1541         if (lcd_hwidth != NOT_SET)
1542                 lcd.hwidth = lcd_hwidth;
1543         if (lcd_charset != NOT_SET)
1544                 lcd.charset = lcd_charset;
1545         if (lcd_proto != NOT_SET)
1546                 lcd.proto = lcd_proto;
1547         if (lcd_e_pin != PIN_NOT_SET)
1548                 lcd.pins.e = lcd_e_pin;
1549         if (lcd_rs_pin != PIN_NOT_SET)
1550                 lcd.pins.rs = lcd_rs_pin;
1551         if (lcd_rw_pin != PIN_NOT_SET)
1552                 lcd.pins.rw = lcd_rw_pin;
1553         if (lcd_cl_pin != PIN_NOT_SET)
1554                 lcd.pins.cl = lcd_cl_pin;
1555         if (lcd_da_pin != PIN_NOT_SET)
1556                 lcd.pins.da = lcd_da_pin;
1557         if (lcd_bl_pin != PIN_NOT_SET)
1558                 lcd.pins.bl = lcd_bl_pin;
1559
1560         /* this is used to catch wrong and default values */
1561         if (lcd.width <= 0)
1562                 lcd.width = DEFAULT_LCD_WIDTH;
1563         if (lcd.bwidth <= 0)
1564                 lcd.bwidth = DEFAULT_LCD_BWIDTH;
1565         if (lcd.hwidth <= 0)
1566                 lcd.hwidth = DEFAULT_LCD_HWIDTH;
1567         if (lcd.height <= 0)
1568                 lcd.height = DEFAULT_LCD_HEIGHT;
1569
1570         if (lcd.proto == LCD_PROTO_SERIAL) {    /* SERIAL */
1571                 lcd_write_cmd = lcd_write_cmd_s;
1572                 lcd_write_data = lcd_write_data_s;
1573                 lcd_clear_fast = lcd_clear_fast_s;
1574
1575                 if (lcd.pins.cl == PIN_NOT_SET)
1576                         lcd.pins.cl = DEFAULT_LCD_PIN_SCL;
1577                 if (lcd.pins.da == PIN_NOT_SET)
1578                         lcd.pins.da = DEFAULT_LCD_PIN_SDA;
1579
1580         } else if (lcd.proto == LCD_PROTO_PARALLEL) {   /* PARALLEL */
1581                 lcd_write_cmd = lcd_write_cmd_p8;
1582                 lcd_write_data = lcd_write_data_p8;
1583                 lcd_clear_fast = lcd_clear_fast_p8;
1584
1585                 if (lcd.pins.e == PIN_NOT_SET)
1586                         lcd.pins.e = DEFAULT_LCD_PIN_E;
1587                 if (lcd.pins.rs == PIN_NOT_SET)
1588                         lcd.pins.rs = DEFAULT_LCD_PIN_RS;
1589                 if (lcd.pins.rw == PIN_NOT_SET)
1590                         lcd.pins.rw = DEFAULT_LCD_PIN_RW;
1591         } else {
1592                 lcd_write_cmd = lcd_write_cmd_tilcd;
1593                 lcd_write_data = lcd_write_data_tilcd;
1594                 lcd_clear_fast = lcd_clear_fast_tilcd;
1595         }
1596
1597         if (lcd.pins.bl == PIN_NOT_SET)
1598                 lcd.pins.bl = DEFAULT_LCD_PIN_BL;
1599
1600         if (lcd.pins.e == PIN_NOT_SET)
1601                 lcd.pins.e = PIN_NONE;
1602         if (lcd.pins.rs == PIN_NOT_SET)
1603                 lcd.pins.rs = PIN_NONE;
1604         if (lcd.pins.rw == PIN_NOT_SET)
1605                 lcd.pins.rw = PIN_NONE;
1606         if (lcd.pins.bl == PIN_NOT_SET)
1607                 lcd.pins.bl = PIN_NONE;
1608         if (lcd.pins.cl == PIN_NOT_SET)
1609                 lcd.pins.cl = PIN_NONE;
1610         if (lcd.pins.da == PIN_NOT_SET)
1611                 lcd.pins.da = PIN_NONE;
1612
1613         if (lcd.charset == NOT_SET)
1614                 lcd.charset = DEFAULT_LCD_CHARSET;
1615
1616         if (lcd.charset == LCD_CHARSET_KS0074)
1617                 lcd_char_conv = lcd_char_conv_ks0074;
1618         else
1619                 lcd_char_conv = NULL;
1620
1621         if (lcd.pins.bl != PIN_NONE)
1622                 init_scan_timer();
1623
1624         pin_to_bits(lcd.pins.e, lcd_bits[LCD_PORT_D][LCD_BIT_E],
1625                     lcd_bits[LCD_PORT_C][LCD_BIT_E]);
1626         pin_to_bits(lcd.pins.rs, lcd_bits[LCD_PORT_D][LCD_BIT_RS],
1627                     lcd_bits[LCD_PORT_C][LCD_BIT_RS]);
1628         pin_to_bits(lcd.pins.rw, lcd_bits[LCD_PORT_D][LCD_BIT_RW],
1629                     lcd_bits[LCD_PORT_C][LCD_BIT_RW]);
1630         pin_to_bits(lcd.pins.bl, lcd_bits[LCD_PORT_D][LCD_BIT_BL],
1631                     lcd_bits[LCD_PORT_C][LCD_BIT_BL]);
1632         pin_to_bits(lcd.pins.cl, lcd_bits[LCD_PORT_D][LCD_BIT_CL],
1633                     lcd_bits[LCD_PORT_C][LCD_BIT_CL]);
1634         pin_to_bits(lcd.pins.da, lcd_bits[LCD_PORT_D][LCD_BIT_DA],
1635                     lcd_bits[LCD_PORT_C][LCD_BIT_DA]);
1636
1637         /* before this line, we must NOT send anything to the display.
1638          * Since lcd_init_display() needs to write data, we have to
1639          * enable mark the LCD initialized just before. */
1640         lcd.initialized = true;
1641         lcd_init_display();
1642
1643         /* display a short message */
1644 #ifdef CONFIG_PANEL_CHANGE_MESSAGE
1645 #ifdef CONFIG_PANEL_BOOT_MESSAGE
1646         panel_lcd_print("\x1b[Lc\x1b[Lb\x1b[L*" CONFIG_PANEL_BOOT_MESSAGE);
1647 #endif
1648 #else
1649         panel_lcd_print("\x1b[Lc\x1b[Lb\x1b[L*Linux-" UTS_RELEASE "\nPanel-"
1650                         PANEL_VERSION);
1651 #endif
1652         lcd.addr.x = 0;
1653         lcd.addr.y = 0;
1654         /* clear the display on the next device opening */
1655         lcd.must_clear = true;
1656         lcd_gotoxy();
1657 }
1658
1659 /*
1660  * These are the file operation function for user access to /dev/keypad
1661  */
1662
1663 static ssize_t keypad_read(struct file *file,
1664                            char __user *buf, size_t count, loff_t *ppos)
1665 {
1666         unsigned i = *ppos;
1667         char __user *tmp = buf;
1668
1669         if (keypad_buflen == 0) {
1670                 if (file->f_flags & O_NONBLOCK)
1671                         return -EAGAIN;
1672
1673                 if (wait_event_interruptible(keypad_read_wait,
1674                                              keypad_buflen != 0))
1675                         return -EINTR;
1676         }
1677
1678         for (; count-- > 0 && (keypad_buflen > 0);
1679              ++i, ++tmp, --keypad_buflen) {
1680                 put_user(keypad_buffer[keypad_start], tmp);
1681                 keypad_start = (keypad_start + 1) % KEYPAD_BUFFER;
1682         }
1683         *ppos = i;
1684
1685         return tmp - buf;
1686 }
1687
1688 static int keypad_open(struct inode *inode, struct file *file)
1689 {
1690         if (!atomic_dec_and_test(&keypad_available))
1691                 return -EBUSY;  /* open only once at a time */
1692
1693         if (file->f_mode & FMODE_WRITE) /* device is read-only */
1694                 return -EPERM;
1695
1696         keypad_buflen = 0;      /* flush the buffer on opening */
1697         return 0;
1698 }
1699
1700 static int keypad_release(struct inode *inode, struct file *file)
1701 {
1702         atomic_inc(&keypad_available);
1703         return 0;
1704 }
1705
1706 static const struct file_operations keypad_fops = {
1707         .read    = keypad_read,         /* read */
1708         .open    = keypad_open,         /* open */
1709         .release = keypad_release,      /* close */
1710         .llseek  = default_llseek,
1711 };
1712
1713 static struct miscdevice keypad_dev = {
1714         .minor  = KEYPAD_MINOR,
1715         .name   = "keypad",
1716         .fops   = &keypad_fops,
1717 };
1718
1719 static void keypad_send_key(const char *string, int max_len)
1720 {
1721         /* send the key to the device only if a process is attached to it. */
1722         if (!atomic_read(&keypad_available)) {
1723                 while (max_len-- && keypad_buflen < KEYPAD_BUFFER && *string) {
1724                         keypad_buffer[(keypad_start + keypad_buflen++) %
1725                                       KEYPAD_BUFFER] = *string++;
1726                 }
1727                 wake_up_interruptible(&keypad_read_wait);
1728         }
1729 }
1730
1731 /* this function scans all the bits involving at least one logical signal,
1732  * and puts the results in the bitfield "phys_read" (one bit per established
1733  * contact), and sets "phys_read_prev" to "phys_read".
1734  *
1735  * Note: to debounce input signals, we will only consider as switched a signal
1736  * which is stable across 2 measures. Signals which are different between two
1737  * reads will be kept as they previously were in their logical form (phys_prev).
1738  * A signal which has just switched will have a 1 in
1739  * (phys_read ^ phys_read_prev).
1740  */
1741 static void phys_scan_contacts(void)
1742 {
1743         int bit, bitval;
1744         char oldval;
1745         char bitmask;
1746         char gndmask;
1747
1748         phys_prev = phys_curr;
1749         phys_read_prev = phys_read;
1750         phys_read = 0;          /* flush all signals */
1751
1752         /* keep track of old value, with all outputs disabled */
1753         oldval = r_dtr(pprt) | scan_mask_o;
1754         /* activate all keyboard outputs (active low) */
1755         w_dtr(pprt, oldval & ~scan_mask_o);
1756
1757         /* will have a 1 for each bit set to gnd */
1758         bitmask = PNL_PINPUT(r_str(pprt)) & scan_mask_i;
1759         /* disable all matrix signals */
1760         w_dtr(pprt, oldval);
1761
1762         /* now that all outputs are cleared, the only active input bits are
1763          * directly connected to the ground
1764          */
1765
1766         /* 1 for each grounded input */
1767         gndmask = PNL_PINPUT(r_str(pprt)) & scan_mask_i;
1768
1769         /* grounded inputs are signals 40-44 */
1770         phys_read |= (pmask_t) gndmask << 40;
1771
1772         if (bitmask != gndmask) {
1773                 /* since clearing the outputs changed some inputs, we know
1774                  * that some input signals are currently tied to some outputs.
1775                  * So we'll scan them.
1776                  */
1777                 for (bit = 0; bit < 8; bit++) {
1778                         bitval = 1 << bit;
1779
1780                         if (!(scan_mask_o & bitval))    /* skip unused bits */
1781                                 continue;
1782
1783                         w_dtr(pprt, oldval & ~bitval);  /* enable this output */
1784                         bitmask = PNL_PINPUT(r_str(pprt)) & ~gndmask;
1785                         phys_read |= (pmask_t) bitmask << (5 * bit);
1786                 }
1787                 w_dtr(pprt, oldval);    /* disable all outputs */
1788         }
1789         /* this is easy: use old bits when they are flapping,
1790          * use new ones when stable */
1791         phys_curr = (phys_prev & (phys_read ^ phys_read_prev)) |
1792                     (phys_read & ~(phys_read ^ phys_read_prev));
1793 }
1794
1795 static inline int input_state_high(struct logical_input *input)
1796 {
1797 #if 0
1798         /* FIXME:
1799          * this is an invalid test. It tries to catch
1800          * transitions from single-key to multiple-key, but
1801          * doesn't take into account the contacts polarity.
1802          * The only solution to the problem is to parse keys
1803          * from the most complex to the simplest combinations,
1804          * and mark them as 'caught' once a combination
1805          * matches, then unmatch it for all other ones.
1806          */
1807
1808         /* try to catch dangerous transitions cases :
1809          * someone adds a bit, so this signal was a false
1810          * positive resulting from a transition. We should
1811          * invalidate the signal immediately and not call the
1812          * release function.
1813          * eg: 0 -(press A)-> A -(press B)-> AB : don't match A's release.
1814          */
1815         if (((phys_prev & input->mask) == input->value) &&
1816             ((phys_curr & input->mask) >  input->value)) {
1817                 input->state = INPUT_ST_LOW; /* invalidate */
1818                 return 1;
1819         }
1820 #endif
1821
1822         if ((phys_curr & input->mask) == input->value) {
1823                 if ((input->type == INPUT_TYPE_STD) &&
1824                     (input->high_timer == 0)) {
1825                         input->high_timer++;
1826                         if (input->u.std.press_fct != NULL)
1827                                 input->u.std.press_fct(input->u.std.press_data);
1828                 } else if (input->type == INPUT_TYPE_KBD) {
1829                         /* will turn on the light */
1830                         keypressed = 1;
1831
1832                         if (input->high_timer == 0) {
1833                                 char *press_str = input->u.kbd.press_str;
1834
1835                                 if (press_str[0]) {
1836                                         int s = sizeof(input->u.kbd.press_str);
1837
1838                                         keypad_send_key(press_str, s);
1839                                 }
1840                         }
1841
1842                         if (input->u.kbd.repeat_str[0]) {
1843                                 char *repeat_str = input->u.kbd.repeat_str;
1844
1845                                 if (input->high_timer >= KEYPAD_REP_START) {
1846                                         int s = sizeof(input->u.kbd.repeat_str);
1847
1848                                         input->high_timer -= KEYPAD_REP_DELAY;
1849                                         keypad_send_key(repeat_str, s);
1850                                 }
1851                                 /* we will need to come back here soon */
1852                                 inputs_stable = 0;
1853                         }
1854
1855                         if (input->high_timer < 255)
1856                                 input->high_timer++;
1857                 }
1858                 return 1;
1859         }
1860
1861         /* else signal falling down. Let's fall through. */
1862         input->state = INPUT_ST_FALLING;
1863         input->fall_timer = 0;
1864
1865         return 0;
1866 }
1867
1868 static inline void input_state_falling(struct logical_input *input)
1869 {
1870 #if 0
1871         /* FIXME !!! same comment as in input_state_high */
1872         if (((phys_prev & input->mask) == input->value) &&
1873             ((phys_curr & input->mask) >  input->value)) {
1874                 input->state = INPUT_ST_LOW;    /* invalidate */
1875                 return;
1876         }
1877 #endif
1878
1879         if ((phys_curr & input->mask) == input->value) {
1880                 if (input->type == INPUT_TYPE_KBD) {
1881                         /* will turn on the light */
1882                         keypressed = 1;
1883
1884                         if (input->u.kbd.repeat_str[0]) {
1885                                 char *repeat_str = input->u.kbd.repeat_str;
1886
1887                                 if (input->high_timer >= KEYPAD_REP_START) {
1888                                         int s = sizeof(input->u.kbd.repeat_str);
1889
1890                                         input->high_timer -= KEYPAD_REP_DELAY;
1891                                         keypad_send_key(repeat_str, s);
1892                                 }
1893                                 /* we will need to come back here soon */
1894                                 inputs_stable = 0;
1895                         }
1896
1897                         if (input->high_timer < 255)
1898                                 input->high_timer++;
1899                 }
1900                 input->state = INPUT_ST_HIGH;
1901         } else if (input->fall_timer >= input->fall_time) {
1902                 /* call release event */
1903                 if (input->type == INPUT_TYPE_STD) {
1904                         void (*release_fct)(int) = input->u.std.release_fct;
1905
1906                         if (release_fct != NULL)
1907                                 release_fct(input->u.std.release_data);
1908                 } else if (input->type == INPUT_TYPE_KBD) {
1909                         char *release_str = input->u.kbd.release_str;
1910
1911                         if (release_str[0]) {
1912                                 int s = sizeof(input->u.kbd.release_str);
1913
1914                                 keypad_send_key(release_str, s);
1915                         }
1916                 }
1917
1918                 input->state = INPUT_ST_LOW;
1919         } else {
1920                 input->fall_timer++;
1921                 inputs_stable = 0;
1922         }
1923 }
1924
1925 static void panel_process_inputs(void)
1926 {
1927         struct list_head *item;
1928         struct logical_input *input;
1929
1930         keypressed = 0;
1931         inputs_stable = 1;
1932         list_for_each(item, &logical_inputs) {
1933                 input = list_entry(item, struct logical_input, list);
1934
1935                 switch (input->state) {
1936                 case INPUT_ST_LOW:
1937                         if ((phys_curr & input->mask) != input->value)
1938                                 break;
1939                         /* if all needed ones were already set previously,
1940                          * this means that this logical signal has been
1941                          * activated by the releasing of another combined
1942                          * signal, so we don't want to match.
1943                          * eg: AB -(release B)-> A -(release A)-> 0 :
1944                          *     don't match A.
1945                          */
1946                         if ((phys_prev & input->mask) == input->value)
1947                                 break;
1948                         input->rise_timer = 0;
1949                         input->state = INPUT_ST_RISING;
1950                         /* no break here, fall through */
1951                 case INPUT_ST_RISING:
1952                         if ((phys_curr & input->mask) != input->value) {
1953                                 input->state = INPUT_ST_LOW;
1954                                 break;
1955                         }
1956                         if (input->rise_timer < input->rise_time) {
1957                                 inputs_stable = 0;
1958                                 input->rise_timer++;
1959                                 break;
1960                         }
1961                         input->high_timer = 0;
1962                         input->state = INPUT_ST_HIGH;
1963                         /* no break here, fall through */
1964                 case INPUT_ST_HIGH:
1965                         if (input_state_high(input))
1966                                 break;
1967                         /* no break here, fall through */
1968                 case INPUT_ST_FALLING:
1969                         input_state_falling(input);
1970                 }
1971         }
1972 }
1973
1974 static void panel_scan_timer(void)
1975 {
1976         if (keypad.enabled && keypad_initialized) {
1977                 if (spin_trylock_irq(&pprt_lock)) {
1978                         phys_scan_contacts();
1979
1980                         /* no need for the parport anymore */
1981                         spin_unlock_irq(&pprt_lock);
1982                 }
1983
1984                 if (!inputs_stable || phys_curr != phys_prev)
1985                         panel_process_inputs();
1986         }
1987
1988         if (lcd.enabled && lcd.initialized) {
1989                 if (keypressed) {
1990                         if (lcd.light_tempo == 0
1991                                         && ((lcd.flags & LCD_FLAG_L) == 0))
1992                                 lcd_backlight(1);
1993                         lcd.light_tempo = FLASH_LIGHT_TEMPO;
1994                 } else if (lcd.light_tempo > 0) {
1995                         lcd.light_tempo--;
1996                         if (lcd.light_tempo == 0
1997                                         && ((lcd.flags & LCD_FLAG_L) == 0))
1998                                 lcd_backlight(0);
1999                 }
2000         }
2001
2002         mod_timer(&scan_timer, jiffies + INPUT_POLL_TIME);
2003 }
2004
2005 static void init_scan_timer(void)
2006 {
2007         if (scan_timer.function != NULL)
2008                 return;         /* already started */
2009
2010         setup_timer(&scan_timer, (void *)&panel_scan_timer, 0);
2011         scan_timer.expires = jiffies + INPUT_POLL_TIME;
2012         add_timer(&scan_timer);
2013 }
2014
2015 /* converts a name of the form "({BbAaPpSsEe}{01234567-})*" to a series of bits.
2016  * if <omask> or <imask> are non-null, they will be or'ed with the bits
2017  * corresponding to out and in bits respectively.
2018  * returns 1 if ok, 0 if error (in which case, nothing is written).
2019  */
2020 static int input_name2mask(const char *name, pmask_t *mask, pmask_t *value,
2021                            char *imask, char *omask)
2022 {
2023         static char sigtab[10] = "EeSsPpAaBb";
2024         char im, om;
2025         pmask_t m, v;
2026
2027         om = 0ULL;
2028         im = 0ULL;
2029         m = 0ULL;
2030         v = 0ULL;
2031         while (*name) {
2032                 int in, out, bit, neg;
2033
2034                 for (in = 0; (in < sizeof(sigtab)) && (sigtab[in] != *name);
2035                      in++)
2036                         ;
2037
2038                 if (in >= sizeof(sigtab))
2039                         return 0;       /* input name not found */
2040                 neg = (in & 1); /* odd (lower) names are negated */
2041                 in >>= 1;
2042                 im |= (1 << in);
2043
2044                 name++;
2045                 if (isdigit(*name)) {
2046                         out = *name - '0';
2047                         om |= (1 << out);
2048                 } else if (*name == '-') {
2049                         out = 8;
2050                 } else {
2051                         return 0;       /* unknown bit name */
2052                 }
2053
2054                 bit = (out * 5) + in;
2055
2056                 m |= 1ULL << bit;
2057                 if (!neg)
2058                         v |= 1ULL << bit;
2059                 name++;
2060         }
2061         *mask = m;
2062         *value = v;
2063         if (imask)
2064                 *imask |= im;
2065         if (omask)
2066                 *omask |= om;
2067         return 1;
2068 }
2069
2070 /* tries to bind a key to the signal name <name>. The key will send the
2071  * strings <press>, <repeat>, <release> for these respective events.
2072  * Returns the pointer to the new key if ok, NULL if the key could not be bound.
2073  */
2074 static struct logical_input *panel_bind_key(const char *name, const char *press,
2075                                             const char *repeat,
2076                                             const char *release)
2077 {
2078         struct logical_input *key;
2079
2080         key = kzalloc(sizeof(*key), GFP_KERNEL);
2081         if (!key)
2082                 return NULL;
2083
2084         if (!input_name2mask(name, &key->mask, &key->value, &scan_mask_i,
2085                              &scan_mask_o)) {
2086                 kfree(key);
2087                 return NULL;
2088         }
2089
2090         key->type = INPUT_TYPE_KBD;
2091         key->state = INPUT_ST_LOW;
2092         key->rise_time = 1;
2093         key->fall_time = 1;
2094
2095         strncpy(key->u.kbd.press_str, press, sizeof(key->u.kbd.press_str));
2096         strncpy(key->u.kbd.repeat_str, repeat, sizeof(key->u.kbd.repeat_str));
2097         strncpy(key->u.kbd.release_str, release,
2098                 sizeof(key->u.kbd.release_str));
2099         list_add(&key->list, &logical_inputs);
2100         return key;
2101 }
2102
2103 #if 0
2104 /* tries to bind a callback function to the signal name <name>. The function
2105  * <press_fct> will be called with the <press_data> arg when the signal is
2106  * activated, and so on for <release_fct>/<release_data>
2107  * Returns the pointer to the new signal if ok, NULL if the signal could not
2108  * be bound.
2109  */
2110 static struct logical_input *panel_bind_callback(char *name,
2111                                                  void (*press_fct)(int),
2112                                                  int press_data,
2113                                                  void (*release_fct)(int),
2114                                                  int release_data)
2115 {
2116         struct logical_input *callback;
2117
2118         callback = kmalloc(sizeof(*callback), GFP_KERNEL);
2119         if (!callback)
2120                 return NULL;
2121
2122         memset(callback, 0, sizeof(struct logical_input));
2123         if (!input_name2mask(name, &callback->mask, &callback->value,
2124                              &scan_mask_i, &scan_mask_o))
2125                 return NULL;
2126
2127         callback->type = INPUT_TYPE_STD;
2128         callback->state = INPUT_ST_LOW;
2129         callback->rise_time = 1;
2130         callback->fall_time = 1;
2131         callback->u.std.press_fct = press_fct;
2132         callback->u.std.press_data = press_data;
2133         callback->u.std.release_fct = release_fct;
2134         callback->u.std.release_data = release_data;
2135         list_add(&callback->list, &logical_inputs);
2136         return callback;
2137 }
2138 #endif
2139
2140 static void keypad_init(void)
2141 {
2142         int keynum;
2143
2144         init_waitqueue_head(&keypad_read_wait);
2145         keypad_buflen = 0;      /* flushes any eventual noisy keystroke */
2146
2147         /* Let's create all known keys */
2148
2149         for (keynum = 0; keypad_profile[keynum][0][0]; keynum++) {
2150                 panel_bind_key(keypad_profile[keynum][0],
2151                                keypad_profile[keynum][1],
2152                                keypad_profile[keynum][2],
2153                                keypad_profile[keynum][3]);
2154         }
2155
2156         init_scan_timer();
2157         keypad_initialized = 1;
2158 }
2159
2160 /**************************************************/
2161 /* device initialization                          */
2162 /**************************************************/
2163
2164 static int panel_notify_sys(struct notifier_block *this, unsigned long code,
2165                             void *unused)
2166 {
2167         if (lcd.enabled && lcd.initialized) {
2168                 switch (code) {
2169                 case SYS_DOWN:
2170                         panel_lcd_print
2171                             ("\x0cReloading\nSystem...\x1b[Lc\x1b[Lb\x1b[L+");
2172                         break;
2173                 case SYS_HALT:
2174                         panel_lcd_print
2175                             ("\x0cSystem Halted.\x1b[Lc\x1b[Lb\x1b[L+");
2176                         break;
2177                 case SYS_POWER_OFF:
2178                         panel_lcd_print("\x0cPower off.\x1b[Lc\x1b[Lb\x1b[L+");
2179                         break;
2180                 default:
2181                         break;
2182                 }
2183         }
2184         return NOTIFY_DONE;
2185 }
2186
2187 static struct notifier_block panel_notifier = {
2188         panel_notify_sys,
2189         NULL,
2190         0
2191 };
2192
2193 static void panel_attach(struct parport *port)
2194 {
2195         struct pardev_cb panel_cb;
2196
2197         if (port->number != parport)
2198                 return;
2199
2200         if (pprt) {
2201                 pr_err("%s: port->number=%d parport=%d, already registered!\n",
2202                        __func__, port->number, parport);
2203                 return;
2204         }
2205
2206         memset(&panel_cb, 0, sizeof(panel_cb));
2207         panel_cb.private = &pprt;
2208         /* panel_cb.flags = 0 should be PARPORT_DEV_EXCL? */
2209
2210         pprt = parport_register_dev_model(port, "panel", &panel_cb, 0);
2211         if (pprt == NULL) {
2212                 pr_err("%s: port->number=%d parport=%d, parport_register_device() failed\n",
2213                        __func__, port->number, parport);
2214                 return;
2215         }
2216
2217         if (parport_claim(pprt)) {
2218                 pr_err("could not claim access to parport%d. Aborting.\n",
2219                        parport);
2220                 goto err_unreg_device;
2221         }
2222
2223         /* must init LCD first, just in case an IRQ from the keypad is
2224          * generated at keypad init
2225          */
2226         if (lcd.enabled) {
2227                 lcd_init();
2228                 if (misc_register(&lcd_dev))
2229                         goto err_unreg_device;
2230         }
2231
2232         if (keypad.enabled) {
2233                 keypad_init();
2234                 if (misc_register(&keypad_dev))
2235                         goto err_lcd_unreg;
2236         }
2237         register_reboot_notifier(&panel_notifier);
2238         return;
2239
2240 err_lcd_unreg:
2241         if (lcd.enabled)
2242                 misc_deregister(&lcd_dev);
2243 err_unreg_device:
2244         parport_unregister_device(pprt);
2245         pprt = NULL;
2246 }
2247
2248 static void panel_detach(struct parport *port)
2249 {
2250         if (port->number != parport)
2251                 return;
2252
2253         if (!pprt) {
2254                 pr_err("%s: port->number=%d parport=%d, nothing to unregister.\n",
2255                        __func__, port->number, parport);
2256                 return;
2257         }
2258         if (scan_timer.function != NULL)
2259                 del_timer_sync(&scan_timer);
2260
2261         if (pprt != NULL) {
2262                 if (keypad.enabled) {
2263                         misc_deregister(&keypad_dev);
2264                         keypad_initialized = 0;
2265                 }
2266
2267                 if (lcd.enabled) {
2268                         panel_lcd_print("\x0cLCD driver " PANEL_VERSION
2269                                         "\nunloaded.\x1b[Lc\x1b[Lb\x1b[L-");
2270                         misc_deregister(&lcd_dev);
2271                         lcd.initialized = false;
2272                 }
2273
2274                 /* TODO: free all input signals */
2275                 parport_release(pprt);
2276                 parport_unregister_device(pprt);
2277                 pprt = NULL;
2278                 unregister_reboot_notifier(&panel_notifier);
2279         }
2280 }
2281
2282 static struct parport_driver panel_driver = {
2283         .name = "panel",
2284         .match_port = panel_attach,
2285         .detach = panel_detach,
2286         .devmodel = true,
2287 };
2288
2289 /* init function */
2290 static int __init panel_init_module(void)
2291 {
2292         int selected_keypad_type = NOT_SET, err;
2293
2294         /* take care of an eventual profile */
2295         switch (profile) {
2296         case PANEL_PROFILE_CUSTOM:
2297                 /* custom profile */
2298                 selected_keypad_type = DEFAULT_KEYPAD_TYPE;
2299                 selected_lcd_type = DEFAULT_LCD_TYPE;
2300                 break;
2301         case PANEL_PROFILE_OLD:
2302                 /* 8 bits, 2*16, old keypad */
2303                 selected_keypad_type = KEYPAD_TYPE_OLD;
2304                 selected_lcd_type = LCD_TYPE_OLD;
2305
2306                 /* TODO: This two are a little hacky, sort it out later */
2307                 if (lcd_width == NOT_SET)
2308                         lcd_width = 16;
2309                 if (lcd_hwidth == NOT_SET)
2310                         lcd_hwidth = 16;
2311                 break;
2312         case PANEL_PROFILE_NEW:
2313                 /* serial, 2*16, new keypad */
2314                 selected_keypad_type = KEYPAD_TYPE_NEW;
2315                 selected_lcd_type = LCD_TYPE_KS0074;
2316                 break;
2317         case PANEL_PROFILE_HANTRONIX:
2318                 /* 8 bits, 2*16 hantronix-like, no keypad */
2319                 selected_keypad_type = KEYPAD_TYPE_NONE;
2320                 selected_lcd_type = LCD_TYPE_HANTRONIX;
2321                 break;
2322         case PANEL_PROFILE_NEXCOM:
2323                 /* generic 8 bits, 2*16, nexcom keypad, eg. Nexcom. */
2324                 selected_keypad_type = KEYPAD_TYPE_NEXCOM;
2325                 selected_lcd_type = LCD_TYPE_NEXCOM;
2326                 break;
2327         case PANEL_PROFILE_LARGE:
2328                 /* 8 bits, 2*40, old keypad */
2329                 selected_keypad_type = KEYPAD_TYPE_OLD;
2330                 selected_lcd_type = LCD_TYPE_OLD;
2331                 break;
2332         }
2333
2334         /*
2335          * Overwrite selection with module param values (both keypad and lcd),
2336          * where the deprecated params have lower prio.
2337          */
2338         if (keypad_enabled != NOT_SET)
2339                 selected_keypad_type = keypad_enabled;
2340         if (keypad_type != NOT_SET)
2341                 selected_keypad_type = keypad_type;
2342
2343         keypad.enabled = (selected_keypad_type > 0);
2344
2345         if (lcd_enabled != NOT_SET)
2346                 selected_lcd_type = lcd_enabled;
2347         if (lcd_type != NOT_SET)
2348                 selected_lcd_type = lcd_type;
2349
2350         lcd.enabled = (selected_lcd_type > 0);
2351
2352         if (lcd.enabled) {
2353                 /*
2354                  * Init lcd struct with load-time values to preserve exact
2355                  * current functionality (at least for now).
2356                  */
2357                 lcd.height = lcd_height;
2358                 lcd.width = lcd_width;
2359                 lcd.bwidth = lcd_bwidth;
2360                 lcd.hwidth = lcd_hwidth;
2361                 lcd.charset = lcd_charset;
2362                 lcd.proto = lcd_proto;
2363                 lcd.pins.e = lcd_e_pin;
2364                 lcd.pins.rs = lcd_rs_pin;
2365                 lcd.pins.rw = lcd_rw_pin;
2366                 lcd.pins.cl = lcd_cl_pin;
2367                 lcd.pins.da = lcd_da_pin;
2368                 lcd.pins.bl = lcd_bl_pin;
2369
2370                 /* Leave it for now, just in case */
2371                 lcd.esc_seq.len = -1;
2372         }
2373
2374         switch (selected_keypad_type) {
2375         case KEYPAD_TYPE_OLD:
2376                 keypad_profile = old_keypad_profile;
2377                 break;
2378         case KEYPAD_TYPE_NEW:
2379                 keypad_profile = new_keypad_profile;
2380                 break;
2381         case KEYPAD_TYPE_NEXCOM:
2382                 keypad_profile = nexcom_keypad_profile;
2383                 break;
2384         default:
2385                 keypad_profile = NULL;
2386                 break;
2387         }
2388
2389         if (!lcd.enabled && !keypad.enabled) {
2390                 /* no device enabled, let's exit */
2391                 pr_err("driver version " PANEL_VERSION " disabled.\n");
2392                 return -ENODEV;
2393         }
2394
2395         err = parport_register_driver(&panel_driver);
2396         if (err) {
2397                 pr_err("could not register with parport. Aborting.\n");
2398                 return err;
2399         }
2400
2401         if (pprt)
2402                 pr_info("driver version " PANEL_VERSION
2403                         " registered on parport%d (io=0x%lx).\n", parport,
2404                         pprt->port->base);
2405         else
2406                 pr_info("driver version " PANEL_VERSION
2407                         " not yet registered\n");
2408         return 0;
2409 }
2410
2411 static void __exit panel_cleanup_module(void)
2412 {
2413         parport_unregister_driver(&panel_driver);
2414 }
2415
2416 module_init(panel_init_module);
2417 module_exit(panel_cleanup_module);
2418 MODULE_AUTHOR("Willy Tarreau");
2419 MODULE_LICENSE("GPL");
2420
2421 /*
2422  * Local variables:
2423  *  c-indent-level: 4
2424  *  tab-width: 8
2425  * End:
2426  */
This page took 0.169884 seconds and 4 git commands to generate.