2 * Translate key codes into ASCII
4 * Copyright (c) 2011 The Chromium OS Authors.
5 * (C) Copyright 2004 DENX Software Engineering, Wolfgang Denk, wd@denx.de
7 * SPDX-License-Identifier: GPL-2.0+
14 #include <stdio_dev.h>
16 #ifdef CONFIG_DM_KEYBOARD
19 #include <linux/input.h>
22 /* These correspond to the lights on the keyboard */
23 FLAG_SCROLL_LOCK = 1 << 0,
24 FLAG_NUM_LOCK = 1 << 1,
25 FLAG_CAPS_LOCK = 1 << 2,
27 /* Special flag ORed with key code to indicate release */
28 KEY_RELEASE = 1 << 15,
33 * These takes map key codes to ASCII. 0xff means no key, or special key.
34 * Three tables are provided - one for plain keys, one for when the shift
35 * 'modifier' key is pressed and one for when the ctrl modifier key is
38 static const uchar kbd_plain_xlate[] = {
39 0xff, 0x1b, '1', '2', '3', '4', '5', '6',
40 '7', '8', '9', '0', '-', '=', '\b', '\t', /* 0x00 - 0x0f */
41 'q', 'w', 'e', 'r', 't', 'y', 'u', 'i',
42 'o', 'p', '[', ']', '\r', 0xff, 'a', 's', /* 0x10 - 0x1f */
43 'd', 'f', 'g', 'h', 'j', 'k', 'l', ';',
44 '\'', '`', 0xff, '\\', 'z', 'x', 'c', 'v', /* 0x20 - 0x2f */
45 'b', 'n', 'm', ',' , '.', '/', 0xff, 0xff, 0xff,
46 ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x30 - 0x3f */
47 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7',
48 '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
49 '2', '3', '0', '.', 0xff, 0xff, 0xff, 0xff,
50 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x50 - 0x5F */
54 static unsigned char kbd_shift_xlate[] = {
55 0xff, 0x1b, '!', '@', '#', '$', '%', '^',
56 '&', '*', '(', ')', '_', '+', '\b', '\t', /* 0x00 - 0x0f */
57 'Q', 'W', 'E', 'R', 'T', 'Y', 'U', 'I',
58 'O', 'P', '{', '}', '\r', 0xff, 'A', 'S', /* 0x10 - 0x1f */
59 'D', 'F', 'G', 'H', 'J', 'K', 'L', ':',
60 '"', '~', 0xff, '|', 'Z', 'X', 'C', 'V', /* 0x20 - 0x2f */
61 'B', 'N', 'M', '<', '>', '?', 0xff, 0xff, 0xff,
62 ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x30 - 0x3f */
63 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7',
64 '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
65 '2', '3', '0', '.', 0xff, 0xff, 0xff, 0xff, 0xff,
66 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x50 - 0x5F */
70 static unsigned char kbd_ctrl_xlate[] = {
71 0xff, 0x1b, '1', 0x00, '3', '4', '5', 0x1E,
72 '7', '8', '9', '0', 0x1F, '=', '\b', '\t', /* 0x00 - 0x0f */
73 0x11, 0x17, 0x05, 0x12, 0x14, 0x19, 0x15, 0x09,
74 0x0f, 0x10, 0x1b, 0x1d, '\n', 0xff, 0x01, 0x13, /* 0x10 - 0x1f */
75 0x04, 0x06, 0x08, 0x09, 0x0a, 0x0b, 0x0c, ';',
76 '\'', '~', 0x00, 0x1c, 0x1a, 0x18, 0x03, 0x16, /* 0x20 - 0x2f */
77 0x02, 0x0e, 0x0d, '<', '>', '?', 0xff, 0xff,
78 0xff, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x30 - 0x3f */
79 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7',
80 '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
81 '2', '3', '0', '.', 0xff, 0xff, 0xff, 0xff,
82 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x50 - 0x5F */
86 static const uchar kbd_plain_xlate_german[] = {
87 0xff, 0x1b, '1', '2', '3', '4', '5', '6', /* scan 00-07 */
88 '7', '8', '9', '0', 0xe1, '\'', 0x08, '\t', /* scan 08-0F */
89 'q', 'w', 'e', 'r', 't', 'z', 'u', 'i', /* scan 10-17 */
90 'o', 'p', 0x81, '+', '\r', 0xff, 'a', 's', /* scan 18-1F */
91 'd', 'f', 'g', 'h', 'j', 'k', 'l', 0x94, /* scan 20-27 */
92 0x84, '^', 0xff, '#', 'y', 'x', 'c', 'v', /* scan 28-2F */
93 'b', 'n', 'm', ',', '.', '-', 0xff, '*', /* scan 30-37 */
94 ' ', ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 38-3F */
95 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7', /* scan 40-47 */
96 '8', '9', '-', '4', '5', '6', '+', '1', /* scan 48-4F */
97 '2', '3', '0', ',', 0xff, 0xff, '<', 0xff, /* scan 50-57 */
98 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 58-5F */
99 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 60-67 */
100 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 68-6F */
101 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 70-77 */
102 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 78-7F */
103 '\r', 0xff, '/', '*',
106 static unsigned char kbd_shift_xlate_german[] = {
107 0xff, 0x1b, '!', '"', 0x15, '$', '%', '&', /* scan 00-07 */
108 '/', '(', ')', '=', '?', '`', 0x08, '\t', /* scan 08-0F */
109 'Q', 'W', 'E', 'R', 'T', 'Z', 'U', 'I', /* scan 10-17 */
110 'O', 'P', 0x9a, '*', '\r', 0xff, 'A', 'S', /* scan 18-1F */
111 'D', 'F', 'G', 'H', 'J', 'K', 'L', 0x99, /* scan 20-27 */
112 0x8e, 0xf8, 0xff, '\'', 'Y', 'X', 'C', 'V', /* scan 28-2F */
113 'B', 'N', 'M', ';', ':', '_', 0xff, '*', /* scan 30-37 */
114 ' ', ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 38-3F */
115 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7', /* scan 40-47 */
116 '8', '9', '-', '4', '5', '6', '+', '1', /* scan 48-4F */
117 '2', '3', '0', ',', 0xff, 0xff, '>', 0xff, /* scan 50-57 */
118 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 58-5F */
119 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 60-67 */
120 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 68-6F */
121 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 70-77 */
122 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 78-7F */
123 '\r', 0xff, '/', '*',
126 static unsigned char kbd_right_alt_xlate_german[] = {
127 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 00-07 */
128 '{', '[', ']', '}', '\\', 0xff, 0xff, 0xff, /* scan 08-0F */
129 '@', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 10-17 */
130 0xff, 0xff, 0xff, '~', 0xff, 0xff, 0xff, 0xff, /* scan 18-1F */
131 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 20-27 */
132 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 28-2F */
133 0xff, 0xff, 0xe6, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 30-37 */
134 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 38-3F */
135 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 40-47 */
136 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 48-4F */
137 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '|', 0xff, /* scan 50-57 */
141 KBD_ENGLISH = 1 << 0,
145 static struct kbd_entry {
146 int kbd_mask; /* Which languages this is for */
147 int left_keycode; /* Left keycode to select this map */
148 int right_keycode; /* Right keycode to select this map */
149 const uchar *xlate; /* Ascii code for each keycode */
150 int num_entries; /* Number of entries in xlate */
152 { KBD_ENGLISH, -1, -1,
153 kbd_plain_xlate, ARRAY_SIZE(kbd_plain_xlate) },
154 { KBD_GERMAN, -1, -1,
155 kbd_plain_xlate_german, ARRAY_SIZE(kbd_plain_xlate_german) },
156 { KBD_ENGLISH, KEY_LEFTSHIFT, KEY_RIGHTSHIFT,
157 kbd_shift_xlate, ARRAY_SIZE(kbd_shift_xlate) },
158 { KBD_GERMAN, KEY_LEFTSHIFT, KEY_RIGHTSHIFT,
159 kbd_shift_xlate_german, ARRAY_SIZE(kbd_shift_xlate_german) },
160 { KBD_ENGLISH | KBD_GERMAN, KEY_LEFTCTRL, KEY_RIGHTCTRL,
161 kbd_ctrl_xlate, ARRAY_SIZE(kbd_ctrl_xlate) },
162 { KBD_GERMAN, -1, KEY_RIGHTALT,
163 kbd_right_alt_xlate_german,
164 ARRAY_SIZE(kbd_right_alt_xlate_german) },
169 * Scan key code to ANSI 3.64 escape sequence table. This table is
170 * incomplete in that it does not include all possible extra keys.
175 } kbd_to_ansi364[] = {
177 { KEY_DOWN, "\033[B"},
178 { KEY_RIGHT, "\033[C"},
179 { KEY_LEFT, "\033[D"},
182 /* Maximum number of output characters that an ANSI sequence expands to */
183 #define ANSI_CHAR_MAX 3
185 static int input_queue_ascii(struct input_config *config, int ch)
187 if (config->fifo_in + 1 == INPUT_BUFFER_LEN) {
188 if (!config->fifo_out)
189 return -1; /* buffer full */
193 if (config->fifo_in + 1 == config->fifo_out)
194 return -1; /* buffer full */
197 debug(" {%02x} ", ch);
198 config->fifo[config->fifo_in] = (uchar)ch;
203 int input_tstc(struct input_config *config)
205 if (config->fifo_in == config->fifo_out && config->read_keys) {
206 if (!(*config->read_keys)(config))
209 return config->fifo_in != config->fifo_out;
212 int input_getc(struct input_config *config)
216 while (config->fifo_in == config->fifo_out) {
217 if (config->read_keys)
218 err = (*config->read_keys)(config);
223 if (++config->fifo_out == INPUT_BUFFER_LEN)
224 config->fifo_out = 0;
226 return config->fifo[config->fifo_out];
230 * Process a modifier/special key press or release and decide which key
231 * translation array should be used as a result.
233 * TODO: Should keep track of modifier press/release
235 * @param config Input state
236 * @param key Key code to process
237 * @param release 0 if a press, 1 if a release
238 * @return pointer to keycode->ascii translation table that should be used
240 static struct input_key_xlate *process_modifier(struct input_config *config,
241 int key, int release)
243 #ifdef CONFIG_DM_KEYBOARD
244 struct udevice *dev = config->dev;
245 struct keyboard_ops *ops = keyboard_get_ops(dev);
247 struct input_key_xlate *table;
250 /* Start with the main table, and see what modifiers change it */
251 assert(config->num_tables > 0);
252 table = &config->table[0];
253 for (i = 1; i < config->num_tables; i++) {
254 struct input_key_xlate *tab = &config->table[i];
256 if (key == tab->left_keycode || key == tab->right_keycode)
260 /* Handle the lighted keys */
266 flip = FLAG_SCROLL_LOCK;
269 flip = FLAG_NUM_LOCK;
272 flip = FLAG_CAPS_LOCK;
279 config->flags ^= flip;
280 if (config->flags & FLAG_NUM_LOCK)
281 leds |= INPUT_LED_NUM;
282 if (config->flags & FLAG_CAPS_LOCK)
283 leds |= INPUT_LED_CAPS;
284 if (config->flags & FLAG_SCROLL_LOCK)
285 leds |= INPUT_LED_SCROLL;
287 config->leds_changed = flip;
289 #ifdef CONFIG_DM_KEYBOARD
290 if (ops->update_leds) {
291 if (ops->update_leds(dev, config->leds))
292 debug("Update keyboard's LED failed\n");
302 * Search an int array for a key value
304 * @param array Array to search
305 * @param count Number of elements in array
306 * @param key Key value to find
307 * @return element where value was first found, -1 if none
309 static int array_search(int *array, int count, int key)
313 for (i = 0; i < count; i++) {
322 * Sort an array so that those elements that exist in the ordering are
323 * first in the array, and in the same order as the ordering. The algorithm
324 * is O(count * ocount) and designed for small arrays.
326 * TODO: Move this to common / lib?
328 * @param dest Array with elements to sort, also destination array
329 * @param count Number of elements to sort
330 * @param order Array containing ordering elements
331 * @param ocount Number of ordering elements
332 * @return number of elements in dest that are in order (these will be at the
335 static int sort_array_by_ordering(int *dest, int count, int *order,
340 int same; /* number of elements which are the same */
343 /* setup output items, copy items to be sorted into our temp area */
344 memcpy(temp, dest, count * sizeof(*dest));
347 /* work through the ordering, move over the elements we agree on */
348 for (i = 0; i < ocount; i++) {
349 if (array_search(temp, count, order[i]) != -1)
350 dest[dest_count++] = order[i];
354 /* now move over the elements that are not in the ordering */
355 for (i = 0; i < count; i++) {
356 if (array_search(order, ocount, temp[i]) == -1)
357 dest[dest_count++] = temp[i];
359 assert(dest_count == count);
364 * Check a list of key codes against the previous key scan
366 * Given a list of new key codes, we check how many of these are the same
369 * @param config Input state
370 * @param keycode List of key codes to examine
371 * @param num_keycodes Number of key codes
372 * @param same Returns number of key codes which are the same
374 static int input_check_keycodes(struct input_config *config,
375 int keycode[], int num_keycodes, int *same)
377 /* Select the 'plain' xlate table to start with */
378 if (!config->num_tables) {
379 debug("%s: No xlate tables: cannot decode keys\n", __func__);
383 /* sort the keycodes into the same order as the previous ones */
384 *same = sort_array_by_ordering(keycode, num_keycodes,
385 config->prev_keycodes, config->num_prev_keycodes);
387 memcpy(config->prev_keycodes, keycode, num_keycodes * sizeof(int));
388 config->num_prev_keycodes = num_keycodes;
390 return *same != num_keycodes;
394 * Checks and converts a special key code into ANSI 3.64 escape sequence.
396 * @param config Input state
397 * @param keycode Key code to examine
398 * @param output_ch Buffer to place output characters into. It should
399 * be at least ANSI_CHAR_MAX bytes long, to allow for
401 * @param max_chars Maximum number of characters to add to output_ch
402 * @return number of characters output, if the key was converted, otherwise 0.
403 * This may be larger than max_chars, in which case the overflow
404 * characters are not output.
406 static int input_keycode_to_ansi364(struct input_config *config,
407 int keycode, char output_ch[], int max_chars)
413 for (i = ch_count = 0; i < ARRAY_SIZE(kbd_to_ansi364); i++) {
414 if (keycode != kbd_to_ansi364[i].kbd_scan_code)
416 for (escape = kbd_to_ansi364[i].escape; *escape; escape++) {
417 if (ch_count < max_chars)
418 output_ch[ch_count] = *escape;
428 * Converts and queues a list of key codes in escaped ASCII string form
429 * Convert a list of key codes into ASCII
431 * You must call input_check_keycodes() before this. It turns the keycode
432 * list into a list of ASCII characters and sends them to the input layer.
434 * Characters which were seen last time do not generate fresh ASCII output.
435 * The output (calls to queue_ascii) may be longer than num_keycodes, if the
436 * keycode contains special keys that was encoded to longer escaped sequence.
438 * @param config Input state
439 * @param keycode List of key codes to examine
440 * @param num_keycodes Number of key codes
441 * @param output_ch Buffer to place output characters into. It should
442 * be at last ANSI_CHAR_MAX * num_keycodes, to allow for
444 * @param max_chars Maximum number of characters to add to output_ch
445 * @param same Number of key codes which are the same
446 * @return number of characters written into output_ch, or -1 if we would
447 * exceed max_chars chars.
449 static int input_keycodes_to_ascii(struct input_config *config,
450 int keycode[], int num_keycodes, char output_ch[],
451 int max_chars, int same)
453 struct input_key_xlate *table;
457 table = &config->table[0];
459 /* deal with modifiers first */
460 for (i = 0; i < num_keycodes; i++) {
461 int key = keycode[i] & KEY_MASK;
463 if (key >= table->num_entries || table->xlate[key] == 0xff) {
464 table = process_modifier(config, key,
465 keycode[i] & KEY_RELEASE);
469 /* Start conversion by looking for the first new keycode (by same). */
470 for (i = same; i < num_keycodes; i++) {
471 int key = keycode[i];
475 * For a normal key (with an ASCII value), add it; otherwise
476 * translate special key to escape sequence if possible.
478 if (key < table->num_entries) {
479 ch = table->xlate[key];
480 if ((config->flags & FLAG_CAPS_LOCK) &&
481 ch >= 'a' && ch <= 'z')
483 /* ban digit numbers if 'Num Lock' is not on */
484 if (!(config->flags & FLAG_NUM_LOCK)) {
485 if (key >= KEY_KP7 && key <= KEY_KPDOT &&
486 key != KEY_KPMINUS && key != KEY_KPPLUS)
489 if (ch_count < max_chars && ch != 0xff)
490 output_ch[ch_count++] = (uchar)ch;
492 ch_count += input_keycode_to_ansi364(config, key,
493 output_ch, max_chars);
497 if (ch_count > max_chars) {
498 debug("%s: Output char buffer overflow size=%d, need=%d\n",
499 __func__, max_chars, ch_count);
503 /* ok, so return keys */
507 static int _input_send_keycodes(struct input_config *config, int keycode[],
508 int num_keycodes, bool do_send)
510 char ch[num_keycodes * ANSI_CHAR_MAX];
511 int count, i, same = 0;
515 config->modifiers = 0;
516 if (!input_check_keycodes(config, keycode, num_keycodes, &same)) {
518 * Same as last time - is it time for another repeat?
519 * TODO(sjg@chromium.org) We drop repeats here and since
520 * the caller may not call in again for a while, our
521 * auto-repeat speed is not quite correct. We should
522 * insert another character if we later realise that we
523 * have missed a repeat slot.
525 is_repeat = config->allow_repeats || (config->repeat_rate_ms &&
526 (int)get_timer(config->next_repeat_ms) >= 0);
531 count = input_keycodes_to_ascii(config, keycode, num_keycodes,
532 ch, sizeof(ch), is_repeat ? 0 : same);
534 for (i = 0; i < count; i++)
535 input_queue_ascii(config, ch[i]);
537 delay_ms = is_repeat ?
538 config->repeat_rate_ms :
539 config->repeat_delay_ms;
541 config->next_repeat_ms = get_timer(0) + delay_ms;
546 int input_send_keycodes(struct input_config *config, int keycode[],
549 return _input_send_keycodes(config, keycode, num_keycodes, true);
552 int input_add_keycode(struct input_config *config, int new_keycode,
555 int keycode[INPUT_MAX_MODIFIERS + 1];
558 /* Add the old keycodes which are not removed by this new one */
559 for (i = 0, count = 0; i < config->num_prev_keycodes; i++) {
560 int code = config->prev_keycodes[i];
562 if (new_keycode == code) {
567 keycode[count++] = code;
570 if (!release && new_keycode != -1)
571 keycode[count++] = new_keycode;
572 debug("\ncodes for %02x/%d: ", new_keycode, release);
573 for (i = 0; i < count; i++)
574 debug("%02x ", keycode[i]);
577 /* Don't output any ASCII characters if this is a key release */
578 return _input_send_keycodes(config, keycode, count, !release);
581 int input_add_table(struct input_config *config, int left_keycode,
582 int right_keycode, const uchar *xlate, int num_entries)
584 struct input_key_xlate *table;
586 if (config->num_tables == INPUT_MAX_MODIFIERS) {
587 debug("%s: Too many modifier tables\n", __func__);
591 table = &config->table[config->num_tables++];
592 table->left_keycode = left_keycode;
593 table->right_keycode = right_keycode;
594 table->xlate = xlate;
595 table->num_entries = num_entries;
600 void input_set_delays(struct input_config *config, int repeat_delay_ms,
603 config->repeat_delay_ms = repeat_delay_ms;
604 config->repeat_rate_ms = repeat_rate_ms;
607 void input_allow_repeats(struct input_config *config, bool allow_repeats)
609 config->allow_repeats = allow_repeats;
612 int input_leds_changed(struct input_config *config)
614 if (config->leds_changed)
620 int input_add_tables(struct input_config *config, bool german)
622 struct kbd_entry *entry;
626 mask = german ? KBD_GERMAN : KBD_ENGLISH;
627 for (entry = kbd_entry; entry->kbd_mask; entry++) {
628 if (!(mask & entry->kbd_mask))
630 ret = input_add_table(config, entry->left_keycode,
631 entry->right_keycode, entry->xlate,
640 int input_init(struct input_config *config, int leds)
642 memset(config, '\0', sizeof(*config));
648 int input_stdio_register(struct stdio_dev *dev)
652 error = stdio_register(dev);
654 /* check if this is the standard input device */
655 if (!error && strcmp(getenv("stdin"), dev->name) == 0) {
656 /* reassign the console */
657 if (OVERWRITE_CONSOLE ||
658 console_assign(stdin, dev->name))