2 * (C) Copyright 2004 Intracom S.A.
3 * Pantelis Antoniou <panto@intracom.gr>
5 * See file CREDITS for list of people who contributed to this
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
27 * A phone based console
29 * Virtual display of 80x24 characters.
30 * The actual display is much smaller and panned to show the virtual one.
31 * Input is made by a numeric keypad utilizing the input method of
32 * mobile phones. Sorry no T9 lexicons...
39 #include <linux/types.h>
44 /*************************************************************************************************/
49 #define REFRESH_HZ (CFG_HZ/50) /* refresh every 20ms */
50 #define BLINK_HZ (CFG_HZ/2) /* cursor blink every 500ms */
52 /*************************************************************************************************/
54 #define DISPLAY_BACKLIT_PORT ((volatile immap_t *)CFG_IMMR)->im_ioport.iop_pcdat
55 #define DISPLAY_BACKLIT_MASK 0x0010
57 /*************************************************************************************************/
59 #define KP_STABLE_HZ (CFG_HZ/100) /* stable for 10ms */
60 #define KP_REPEAT_DELAY_HZ (CFG_HZ/4) /* delay before repeat 250ms */
61 #define KP_REPEAT_HZ (CFG_HZ/20) /* repeat every 50ms */
62 #define KP_FORCE_DELAY_HZ (CFG_HZ/2) /* key was force pressed */
63 #define KP_IDLE_DELAY_HZ (CFG_HZ/2) /* key was released and idle */
65 #define KP_SPI_RXD_PORT (((volatile immap_t *)CFG_IMMR)->im_ioport.iop_pcdat)
66 #define KP_SPI_RXD_MASK 0x0008
68 #define KP_SPI_TXD_PORT (((volatile immap_t *)CFG_IMMR)->im_ioport.iop_pcdat)
69 #define KP_SPI_TXD_MASK 0x0004
71 #define KP_SPI_CLK_PORT (((volatile immap_t *)CFG_IMMR)->im_ioport.iop_pcdat)
72 #define KP_SPI_CLK_MASK 0x0001
74 #define KP_CS_PORT (((volatile immap_t *)CFG_IMMR)->im_cpm.cp_pedat)
75 #define KP_CS_MASK 0x00000010
77 #define KP_SPI_RXD() (KP_SPI_RXD_PORT & KP_SPI_RXD_MASK)
79 #define KP_SPI_TXD(x) \
82 KP_SPI_TXD_PORT |= KP_SPI_TXD_MASK; \
84 KP_SPI_TXD_PORT &= ~KP_SPI_TXD_MASK; \
87 #define KP_SPI_CLK(x) \
90 KP_SPI_CLK_PORT |= KP_SPI_CLK_MASK; \
92 KP_SPI_CLK_PORT &= ~KP_SPI_CLK_MASK; \
95 #define KP_SPI_CLK_TOGGLE() (KP_SPI_CLK_PORT ^= KP_SPI_CLK_MASK)
97 #define KP_SPI_BIT_DELAY() /* no delay */
102 KP_CS_PORT |= KP_CS_MASK; \
104 KP_CS_PORT &= ~KP_CS_MASK; \
110 #define KP_ROWS_MASK ((1 << KP_ROWS) - 1)
111 #define KP_COLS_MASK ((1 << KP_COLS) - 1)
114 #define SCAN_FILTER 1
116 #define SCAN_COL_FILTER 3
119 #define KP_F1 0 /* leftmost dot (tab) */
120 #define KP_F2 1 /* middle left dot */
121 #define KP_F3 2 /* up */
122 #define KP_F4 3 /* middle right dot */
123 #define KP_F5 4 /* rightmost dot */
124 #define KP_F6 5 /* C */
125 #define KP_F7 6 /* left */
126 #define KP_F8 7 /* down */
127 #define KP_F9 8 /* right */
128 #define KP_F10 9 /* enter */
129 #define KP_F11 10 /* R */
130 #define KP_F12 11 /* save */
131 #define KP_F13 12 /* redial */
132 #define KP_F14 13 /* speaker */
133 #define KP_F15 14 /* unused */
134 #define KP_F16 15 /* unused */
136 #define KP_RELEASE -1 /* key depressed */
137 #define KP_FORCE -2 /* key was pressed for more than force hz */
138 #define KP_IDLE -3 /* key was released and idle */
153 /*************************************************************************************************/
155 static int curs_disabled;
156 static int curs_col, curs_row;
157 static int disp_col, disp_row;
159 static int width, height;
161 /* the simulated vty buffer */
162 static char vty_buf[ROWS * COLS];
163 static char last_visible_buf[ROWS * COLS]; /* worst case */
164 static char *last_visible_curs_ptr;
165 static int last_visible_curs_rev;
166 static int blinked_state;
167 static int last_input_mode;
168 static int refresh_time;
169 static int blink_time;
170 static char last_fast_punct;
171 static int last_tab_indicator = -1;
173 /*************************************************************************************************/
179 static int input_mode;
180 static char fast_punct;
181 static int tab_indicator;
182 static const char *fast_punct_list = ",.:;*";
184 static const char *input_mode_txt[] = { "abc", "ABC", "123" };
186 static const char *punct = ".,!;?'\"-()@/:_+&%*=<>$[]{}\\~^#|";
187 static const char *whspace = " 0\n";
188 /* per mode character select (for 2-9) */
189 static const char *digits_sel[2][8] = {
211 /*****************************************************************************/
213 static void update(void);
214 static void ensure_visible(int col, int row, int dx, int dy);
216 static void console_init(void)
225 input_mode = IM_SMALL;
227 last_fast_punct = '\0';
228 refresh_time = REFRESH_HZ;
229 blink_time = BLINK_HZ;
233 memset(vty_buf, ' ', sizeof(vty_buf));
235 memset(last_visible_buf, ' ', sizeof(last_visible_buf));
236 last_visible_curs_ptr = NULL;
237 last_input_mode = -1;
238 last_visible_curs_rev = 0;
243 width = sed156x_text_width;
244 height = sed156x_text_height - 1;
247 /*****************************************************************************/
249 void phone_putc(const char c);
251 /*****************************************************************************/
253 static int queued_char = -1;
254 static int enabled = 0;
256 /*****************************************************************************/
259 int phone_start(void)
267 queued_char = 'U' - '@';
270 DISPLAY_BACKLIT_PORT &= ~DISPLAY_BACKLIT_MASK;
283 DISPLAY_BACKLIT_PORT |= DISPLAY_BACKLIT_MASK;
288 void phone_puts(const char *s)
290 int count = strlen(s);
298 return queued_char >= 0 ? 1 : 0;
314 /*****************************************************************************/
316 int drv_phone_init(void)
318 device_t console_dev;
322 * Force console i/o to serial ?
324 if ((penv = getenv("console")) != NULL && strcmp(penv, "serial") == 0)
329 memset(&console_dev, 0, sizeof(console_dev));
330 strcpy(console_dev.name, "phone");
331 console_dev.ext = DEV_EXT_VIDEO; /* Video extensions */
332 console_dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT | DEV_FLAGS_SYSTEM;
333 console_dev.start = phone_start;
334 console_dev.stop = phone_stop;
335 console_dev.putc = phone_putc; /* 'putc' function */
336 console_dev.puts = phone_puts; /* 'puts' function */
337 console_dev.tstc = phone_tstc; /* 'tstc' function */
338 console_dev.getc = phone_getc; /* 'getc' function */
340 if (device_register(&console_dev) == 0)
348 int drv_phone_use_me(void)
353 static void kp_do_poll(void);
355 void phone_console_do_poll(void)
363 blink_time -= PHONE_CONSOLE_POLL_HZ;
364 if (blink_time <= 0) {
365 blink_time += BLINK_HZ;
366 if (last_visible_curs_ptr) {
367 i = last_visible_curs_ptr - last_visible_buf;
368 x = i % width; y = i / width;
369 sed156x_reverse_at(x, y, 1);
370 last_visible_curs_rev ^= 1;
375 refresh_time -= PHONE_CONSOLE_POLL_HZ;
376 if (refresh_time <= 0) {
377 refresh_time += REFRESH_HZ;
384 static int last_scancode = -1;
385 static int forced_scancode = 0;
386 static int input_state = -1;
387 static int input_scancode = -1;
388 static int input_selected_char = -1;
389 static char input_covered_char;
391 static void putchar_at_cursor(char c)
393 vty_buf[curs_row * COLS + curs_col] = c;
394 ensure_visible(curs_col, curs_row, 1, 1);
397 static char getchar_at_cursor(void)
399 return vty_buf[curs_row * COLS + curs_col];
402 static void queue_input_char(char c)
410 static void terminate_input(void)
415 if (input_selected_char >= 0)
416 queue_input_char(input_selected_char);
419 input_selected_char = -1;
420 putchar_at_cursor(input_covered_char);
423 blink_time = BLINK_HZ;
427 static void handle_enabled_scancode(int scancode)
430 int new_disp_col, new_disp_row;
436 /* key was released */
444 switch (last_scancode) {
446 if (input_mode == IM_NUMBER) {
447 input_mode = IM_CAPITAL;
448 /* queue backspace to erase # */
449 queue_input_char('\b');
451 input_mode = IM_NUMBER;
458 case '2': case '3': case '4': case '5':
459 case '6': case '7': case '8': case '9':
464 input_selected_char = last_scancode;
465 putchar_at_cursor((char)input_selected_char);
476 /* release and idle */
484 /* change input mode */
486 if (last_scancode == '#') /* no repeat */
489 if (input_mode == IM_NUMBER) {
490 input_scancode = scancode;
492 input_selected_char = scancode;
493 input_covered_char = getchar_at_cursor();
494 putchar_at_cursor((char)input_selected_char);
499 if (input_mode == IM_SMALL)
500 input_mode = IM_CAPITAL;
502 input_mode = IM_SMALL;
509 if (last_scancode == scancode)
512 if (input_state >= 0)
515 input_scancode = fast_punct;
517 input_selected_char = input_scancode;
518 input_covered_char = getchar_at_cursor();
519 putchar_at_cursor((char)input_selected_char);
525 case '2': case '3': case '4': case '5':
526 case '6': case '7': case '8': case '9':
529 if (last_scancode == scancode)
532 if (input_mode == IM_NUMBER) {
533 input_scancode = scancode;
535 input_selected_char = scancode;
536 input_covered_char = getchar_at_cursor();
537 putchar_at_cursor((char)input_selected_char);
542 if (input_state >= 0 && input_scancode != scancode)
545 if (input_state < 0) {
547 input_scancode = scancode;
549 input_covered_char = getchar_at_cursor();
555 else if (scancode == '1')
558 sel = digits_sel[input_mode][scancode - '2'];
559 c = *(sel + input_state);
565 input_selected_char = (int)c;
566 putchar_at_cursor((char)input_selected_char);
571 /* move visible display */
572 case KP_F3: case KP_F8: case KP_F7: case KP_F9:
574 new_disp_col = disp_col;
575 new_disp_row = disp_row;
580 if (new_disp_row <= 0)
587 if (new_disp_row >= ROWS - height)
594 if (new_disp_col <= 0)
601 if (new_disp_col >= COLS - width)
608 if (disp_col == new_disp_col && disp_row == new_disp_row)
611 disp_col = new_disp_col;
612 disp_row = new_disp_row;
617 case KP_F6: /* backspace */
618 /* inputing something; no backspace sent, just cancel input */
619 if (input_state >= 0) {
620 input_selected_char = -1; /* cancel */
624 queue_input_char('\b');
627 case KP_F10: /* enter */
628 /* inputing something; first cancel input */
629 if (input_state >= 0)
631 queue_input_char('\r');
634 case KP_F11: /* R -> Ctrl-C (abort) */
635 if (input_state >= 0)
637 queue_input_char('C' - 'Q'); /* ctrl-c */
640 case KP_F5: /* F% -> Ctrl-U (clear line) */
641 if (input_state >= 0)
643 queue_input_char('U' - 'Q'); /* ctrl-c */
647 case KP_F1: /* tab */
648 /* inputing something; first cancel input */
649 if (input_state >= 0)
651 queue_input_char('\t');
654 case KP_F2: /* change fast punct */
655 sel = strchr(fast_punct_list, fast_punct);
657 sel = &fast_punct_list[0];
660 sel = &fast_punct_list[0];
668 if (scancode != KP_FORCE && scancode != KP_IDLE) /* don't record forced or idle scancode */
669 last_scancode = scancode;
672 static void scancode_action(int scancode)
675 if (scancode == KP_RELEASE)
676 printf(" RELEASE\n");
677 else if (scancode == KP_FORCE)
679 else if (scancode == KP_IDLE)
681 else if (scancode < 32)
682 printf(" F%d", scancode + 1);
684 printf(" %c", (char)scancode);
689 handle_enabled_scancode(scancode);
693 if (scancode == KP_FORCE && last_scancode == '*')
696 last_scancode = scancode;
699 /**************************************************************************************/
701 /* update the display; make sure to update only the differences */
702 static void update(void)
705 char *s, *e, *t, *r, *b, *cp;
707 if (input_mode != last_input_mode)
708 sed156x_output_at(sed156x_text_width - 3, sed156x_text_height - 1, input_mode_txt[input_mode], 3);
710 if (tab_indicator != last_tab_indicator)
711 sed156x_output_at(0, sed156x_text_height - 1, "\\t", 2);
713 if (fast_punct != last_fast_punct)
714 sed156x_output_at(4, sed156x_text_height - 1, &fast_punct, 1);
717 curs_col < disp_col || curs_col >= (disp_col + width) ||
718 curs_row < disp_row || curs_row >= (disp_row + height)) {
721 cp = last_visible_buf + (curs_row - disp_row) * width + (curs_col - disp_col);
724 /* printf("(%d,%d) (%d,%d) %s\n", curs_col, curs_row, disp_col, disp_row, cp ? "YES" : "no"); */
726 /* clear previous cursor */
727 if (last_visible_curs_ptr && last_visible_curs_rev == 0) {
728 i = last_visible_curs_ptr - last_visible_buf;
729 sed156x_reverse_at(i % width, i / width, 1);
732 b = vty_buf + disp_row * COLS + disp_col;
733 t = last_visible_buf;
734 for (i = 0; i < height; i++) {
737 /* update only the differences */
739 while (s < e && *s == *t) {
743 if (s == e) /* no more */
748 while (s < e && *s != *t)
752 sed156x_output_at(r - b, i, r, s - r);
761 last_visible_curs_ptr = cp;
762 i = last_visible_curs_ptr - last_visible_buf;
763 sed156x_reverse_at(i % width, i / width, 1);
764 last_visible_curs_rev = 0;
766 last_visible_curs_ptr = NULL;
769 last_input_mode = input_mode;
770 last_fast_punct = fast_punct;
771 last_tab_indicator = tab_indicator;
774 /* ensure visibility; the trick is to minimize the screen movement */
775 static void ensure_visible(int col, int row, int dx, int dy)
777 int x1, y1, x2, y2, a1, b1, a2, b2;
779 /* clamp visible region */
801 /* move to easier to use vars */
802 x1 = disp_col; y1 = disp_row;
803 x2 = x1 + width; y2 = y1 + height;
805 a2 = a1 + dx; b2 = b1 + dy;
807 /* printf("(%d,%d) - (%d,%d) : (%d, %d) - (%d, %d)\n", x1, y1, x2, y2, a1, b1, a2, b2); */
810 /* move to the right */
817 } else if (a1 < x1) {
818 /* move to the left */
835 } else if (b1 < y1) {
845 /* printf("(%d,%d) - (%d,%d) : (%d, %d) - (%d, %d)\n", x1, y1, x2, y2, a1, b1, a2, b2); */
848 if (disp_col == x1 && disp_row == y1)
855 /**************************************************************************************/
857 static void newline(void)
860 if (curs_row + 1 < ROWS)
863 memmove(vty_buf, vty_buf + COLS, COLS * (ROWS - 1));
864 memset(vty_buf + (ROWS - 1) * COLS, ' ', COLS);
868 void phone_putc(const char c)
872 if (input_mode != -1) {
873 input_selected_char = -1;
880 blink_time = BLINK_HZ;
883 case 13: /* ignore */
886 case '\n': /* next line */
888 ensure_visible(curs_col, curs_row, 1, 1);
902 ensure_visible(curs_col, curs_row, 1, 1);
905 case 8: /* backspace */
910 /* make sure that we see a couple of characters before */
912 ensure_visible(curs_col - 4, curs_row, 4, 1);
914 ensure_visible(curs_col, curs_row, 1, 1);
918 default: /* draw the char */
919 putchar_at_cursor(c);
924 if (curs_col + 1 < COLS)
929 ensure_visible(curs_col, curs_row, 1, 1);
935 blink_time = BLINK_HZ;
939 /**************************************************************************************/
941 static inline unsigned int kp_transfer(unsigned int val)
948 KP_SPI_TXD(val & 0x80);
962 unsigned int kp_data_transfer(unsigned int val)
966 val = kp_transfer(val);
972 unsigned int kp_get_col_mask(unsigned int row_mask)
974 unsigned int val, col_mask;
976 val = 0x80 | (row_mask & 0x7F);
977 (void)kp_data_transfer(val);
978 col_mask = kp_data_transfer(val) & 0x0F;
980 /* printf("col_mask(row_mask = 0x%x) -> col_mask = 0x%x\n", row_mask, col_mask); */
984 /**************************************************************************************/
986 static const int kp_scancodes[KP_ROWS * KP_COLS] = {
987 KP_F1, KP_F3, KP_F4, KP_F2,
988 KP_F6, KP_F8, KP_F9, KP_F7,
989 KP_1, KP_3, KP_F11, KP_2,
990 KP_4, KP_6, KP_F12, KP_5,
991 KP_7, KP_9, KP_F13, KP_8,
992 KP_STAR, KP_HASH, KP_F14, KP_0,
993 KP_F5, KP_F15, KP_F16, KP_F10,
996 static const int kp_repeats[KP_ROWS * KP_COLS] = {
1006 static int kp_state = SCAN;
1007 static int kp_last_col_mask;
1008 static int kp_cur_row, kp_cur_col;
1009 static int kp_scancode;
1010 static int kp_stable;
1011 static int kp_repeat;
1012 static int kp_repeat_time;
1013 static int kp_force_time;
1014 static int kp_idle_time;
1016 static void kp_do_poll(void)
1018 unsigned int col_mask;
1023 if (kp_idle_time > 0) {
1024 kp_idle_time -= PHONE_CONSOLE_POLL_HZ;
1025 if (kp_idle_time <= 0)
1026 scancode_action(KP_IDLE);
1029 col_mask = kp_get_col_mask(KP_ROWS_MASK);
1030 if (col_mask == KP_COLS_MASK)
1031 break; /* nothing */
1032 kp_last_col_mask = col_mask;
1034 kp_state = SCAN_FILTER;
1038 col_mask = kp_get_col_mask(KP_ROWS_MASK);
1039 if (col_mask != kp_last_col_mask) {
1044 kp_stable += PHONE_CONSOLE_POLL_HZ;
1045 if (kp_stable < KP_STABLE_HZ)
1050 kp_state = SCAN_COL;
1052 (void)kp_get_col_mask(1 << kp_cur_row);
1056 col_mask = kp_get_col_mask(1 << kp_cur_row);
1057 if (col_mask == KP_COLS_MASK) {
1058 if (++kp_cur_row >= KP_ROWS) {
1062 kp_get_col_mask(1 << kp_cur_row);
1065 kp_last_col_mask = col_mask;
1067 kp_state = SCAN_COL_FILTER;
1070 case SCAN_COL_FILTER:
1071 col_mask = kp_get_col_mask(1 << kp_cur_row);
1072 if (col_mask != kp_last_col_mask || col_mask == KP_COLS_MASK) {
1077 kp_stable += PHONE_CONSOLE_POLL_HZ;
1078 if (kp_stable < KP_STABLE_HZ)
1081 for (col = 0; col < KP_COLS; col++)
1082 if ((col_mask & (1 << col)) == 0)
1086 kp_scancode = kp_scancodes[kp_cur_row * KP_COLS + kp_cur_col];
1087 kp_repeat = kp_repeats[kp_cur_row * KP_COLS + kp_cur_col];
1090 kp_repeat_time = KP_REPEAT_DELAY_HZ;
1091 kp_force_time = KP_FORCE_DELAY_HZ;
1093 scancode_action(kp_scancode);
1098 col_mask = kp_get_col_mask(1 << kp_cur_row);
1099 if (col_mask != kp_last_col_mask) {
1101 scancode_action(KP_RELEASE);
1102 kp_idle_time = KP_IDLE_DELAY_HZ;
1107 kp_repeat_time -= PHONE_CONSOLE_POLL_HZ;
1108 if (kp_repeat_time <= 0) {
1109 kp_repeat_time += KP_REPEAT_HZ;
1110 scancode_action(kp_scancode);
1114 if (kp_force_time > 0) {
1115 kp_force_time -= PHONE_CONSOLE_POLL_HZ;
1116 if (kp_force_time <= 0)
1117 scancode_action(KP_FORCE);