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+
12 #include <stdio_dev.h>
14 #include <linux/input.h>
17 /* These correspond to the lights on the keyboard */
18 FLAG_NUM_LOCK = 1 << 0,
19 FLAG_CAPS_LOCK = 1 << 1,
20 FLAG_SCROLL_LOCK = 1 << 2,
22 /* Special flag ORed with key code to indicate release */
23 KEY_RELEASE = 1 << 15,
28 * These takes map key codes to ASCII. 0xff means no key, or special key.
29 * Three tables are provided - one for plain keys, one for when the shift
30 * 'modifier' key is pressed and one for when the ctrl modifier key is
33 static const uchar kbd_plain_xlate[] = {
34 0xff, 0x1b, '1', '2', '3', '4', '5', '6',
35 '7', '8', '9', '0', '-', '=', '\b', '\t', /* 0x00 - 0x0f */
36 'q', 'w', 'e', 'r', 't', 'y', 'u', 'i',
37 'o', 'p', '[', ']', '\r', 0xff, 'a', 's', /* 0x10 - 0x1f */
38 'd', 'f', 'g', 'h', 'j', 'k', 'l', ';',
39 '\'', '`', 0xff, '\\', 'z', 'x', 'c', 'v', /* 0x20 - 0x2f */
40 'b', 'n', 'm', ',' , '.', '/', 0xff, 0xff, 0xff,
41 ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x30 - 0x3f */
42 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7',
43 '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
44 '2', '3', '0', '.', 0xff, 0xff, 0xff, 0xff,
45 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x50 - 0x5F */
49 static unsigned char kbd_shift_xlate[] = {
50 0xff, 0x1b, '!', '@', '#', '$', '%', '^',
51 '&', '*', '(', ')', '_', '+', '\b', '\t', /* 0x00 - 0x0f */
52 'Q', 'W', 'E', 'R', 'T', 'Y', 'U', 'I',
53 'O', 'P', '{', '}', '\r', 0xff, 'A', 'S', /* 0x10 - 0x1f */
54 'D', 'F', 'G', 'H', 'J', 'K', 'L', ':',
55 '"', '~', 0xff, '|', 'Z', 'X', 'C', 'V', /* 0x20 - 0x2f */
56 'B', 'N', 'M', '<', '>', '?', 0xff, 0xff, 0xff,
57 ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x30 - 0x3f */
58 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7',
59 '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
60 '2', '3', '0', '.', 0xff, 0xff, 0xff, 0xff, 0xff,
61 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x50 - 0x5F */
65 static unsigned char kbd_ctrl_xlate[] = {
66 0xff, 0x1b, '1', 0x00, '3', '4', '5', 0x1E,
67 '7', '8', '9', '0', 0x1F, '=', '\b', '\t', /* 0x00 - 0x0f */
68 0x11, 0x17, 0x05, 0x12, 0x14, 0x19, 0x15, 0x09,
69 0x0f, 0x10, 0x1b, 0x1d, '\n', 0xff, 0x01, 0x13, /* 0x10 - 0x1f */
70 0x04, 0x06, 0x08, 0x09, 0x0a, 0x0b, 0x0c, ';',
71 '\'', '~', 0x00, 0x1c, 0x1a, 0x18, 0x03, 0x16, /* 0x20 - 0x2f */
72 0x02, 0x0e, 0x0d, '<', '>', '?', 0xff, 0xff,
73 0xff, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x30 - 0x3f */
74 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7',
75 '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
76 '2', '3', '0', '.', 0xff, 0xff, 0xff, 0xff,
77 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x50 - 0x5F */
81 static const uchar kbd_plain_xlate_german[] = {
82 0xff, 0x1b, '1', '2', '3', '4', '5', '6', /* scan 00-07 */
83 '7', '8', '9', '0', 0xe1, '\'', 0x08, '\t', /* scan 08-0F */
84 'q', 'w', 'e', 'r', 't', 'z', 'u', 'i', /* scan 10-17 */
85 'o', 'p', 0x81, '+', '\r', 0xff, 'a', 's', /* scan 18-1F */
86 'd', 'f', 'g', 'h', 'j', 'k', 'l', 0x94, /* scan 20-27 */
87 0x84, '^', 0xff, '#', 'y', 'x', 'c', 'v', /* scan 28-2F */
88 'b', 'n', 'm', ',', '.', '-', 0xff, '*', /* scan 30-37 */
89 ' ', ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 38-3F */
90 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7', /* scan 40-47 */
91 '8', '9', '-', '4', '5', '6', '+', '1', /* scan 48-4F */
92 '2', '3', '0', ',', 0xff, 0xff, '<', 0xff, /* scan 50-57 */
93 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 58-5F */
94 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 60-67 */
95 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 68-6F */
96 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 70-77 */
97 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 78-7F */
101 static unsigned char kbd_shift_xlate_german[] = {
102 0xff, 0x1b, '!', '"', 0x15, '$', '%', '&', /* scan 00-07 */
103 '/', '(', ')', '=', '?', '`', 0x08, '\t', /* scan 08-0F */
104 'Q', 'W', 'E', 'R', 'T', 'Z', 'U', 'I', /* scan 10-17 */
105 'O', 'P', 0x9a, '*', '\r', 0xff, 'A', 'S', /* scan 18-1F */
106 'D', 'F', 'G', 'H', 'J', 'K', 'L', 0x99, /* scan 20-27 */
107 0x8e, 0xf8, 0xff, '\'', 'Y', 'X', 'C', 'V', /* scan 28-2F */
108 'B', 'N', 'M', ';', ':', '_', 0xff, '*', /* scan 30-37 */
109 ' ', ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 38-3F */
110 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7', /* scan 40-47 */
111 '8', '9', '-', '4', '5', '6', '+', '1', /* scan 48-4F */
112 '2', '3', '0', ',', 0xff, 0xff, '>', 0xff, /* scan 50-57 */
113 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 58-5F */
114 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 60-67 */
115 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 68-6F */
116 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 70-77 */
117 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 78-7F */
118 '\r', 0xff, '/', '*',
121 static unsigned char kbd_right_alt_xlate_german[] = {
122 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 00-07 */
123 '{', '[', ']', '}', '\\', 0xff, 0xff, 0xff, /* scan 08-0F */
124 '@', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 10-17 */
125 0xff, 0xff, 0xff, '~', 0xff, 0xff, 0xff, 0xff, /* scan 18-1F */
126 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 20-27 */
127 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 28-2F */
128 0xff, 0xff, 0xe6, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 30-37 */
129 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 38-3F */
130 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 40-47 */
131 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 48-4F */
132 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '|', 0xff, /* scan 50-57 */
136 KBD_ENGLISH = 1 << 0,
140 static struct kbd_entry {
141 int kbd_mask; /* Which languages this is for */
142 int left_keycode; /* Left keycode to select this map */
143 int right_keycode; /* Right keycode to select this map */
144 const uchar *xlate; /* Ascii code for each keycode */
145 int num_entries; /* Number of entries in xlate */
147 { KBD_ENGLISH, -1, -1,
148 kbd_plain_xlate, ARRAY_SIZE(kbd_plain_xlate) },
149 { KBD_GERMAN, -1, -1,
150 kbd_plain_xlate_german, ARRAY_SIZE(kbd_plain_xlate_german) },
151 { KBD_ENGLISH, KEY_LEFTSHIFT, KEY_RIGHTSHIFT,
152 kbd_shift_xlate, ARRAY_SIZE(kbd_shift_xlate) },
153 { KBD_GERMAN, KEY_LEFTSHIFT, KEY_RIGHTSHIFT,
154 kbd_shift_xlate_german, ARRAY_SIZE(kbd_shift_xlate_german) },
155 { KBD_ENGLISH | KBD_GERMAN, KEY_LEFTCTRL, KEY_RIGHTCTRL,
156 kbd_ctrl_xlate, ARRAY_SIZE(kbd_ctrl_xlate) },
157 { KBD_GERMAN, -1, KEY_RIGHTALT,
158 kbd_right_alt_xlate_german,
159 ARRAY_SIZE(kbd_right_alt_xlate_german) },
164 * Scan key code to ANSI 3.64 escape sequence table. This table is
165 * incomplete in that it does not include all possible extra keys.
170 } kbd_to_ansi364[] = {
172 { KEY_DOWN, "\033[B"},
173 { KEY_RIGHT, "\033[C"},
174 { KEY_LEFT, "\033[D"},
177 /* Maximum number of output characters that an ANSI sequence expands to */
178 #define ANSI_CHAR_MAX 3
180 static int input_queue_ascii(struct input_config *config, int ch)
182 if (config->fifo_in + 1 == INPUT_BUFFER_LEN) {
183 if (!config->fifo_out)
184 return -1; /* buffer full */
188 if (config->fifo_in + 1 == config->fifo_out)
189 return -1; /* buffer full */
192 debug(" {%02x} ", ch);
193 config->fifo[config->fifo_in] = (uchar)ch;
198 int input_tstc(struct input_config *config)
200 if (config->fifo_in == config->fifo_out && config->read_keys) {
201 if (!(*config->read_keys)(config))
204 return config->fifo_in != config->fifo_out;
207 int input_getc(struct input_config *config)
211 while (config->fifo_in == config->fifo_out) {
212 if (config->read_keys)
213 err = (*config->read_keys)(config);
218 if (++config->fifo_out == INPUT_BUFFER_LEN)
219 config->fifo_out = 0;
221 return config->fifo[config->fifo_out];
225 * Process a modifier/special key press or release and decide which key
226 * translation array should be used as a result.
228 * TODO: Should keep track of modifier press/release
230 * @param config Input state
231 * @param key Key code to process
232 * @param release 0 if a press, 1 if a release
233 * @return pointer to keycode->ascii translation table that should be used
235 static struct input_key_xlate *process_modifier(struct input_config *config,
236 int key, int release)
238 struct input_key_xlate *table;
241 /* Start with the main table, and see what modifiers change it */
242 assert(config->num_tables > 0);
243 table = &config->table[0];
244 for (i = 1; i < config->num_tables; i++) {
245 struct input_key_xlate *tab = &config->table[i];
247 if (key == tab->left_keycode || key == tab->right_keycode)
251 /* Handle the lighted keys */
257 flip = FLAG_SCROLL_LOCK;
260 flip = FLAG_NUM_LOCK;
263 flip = FLAG_CAPS_LOCK;
270 config->leds ^= flip;
271 if (config->flags & FLAG_NUM_LOCK)
272 leds |= INPUT_LED_NUM;
273 if (config->flags & FLAG_CAPS_LOCK)
274 leds |= INPUT_LED_CAPS;
275 if (config->flags & FLAG_SCROLL_LOCK)
276 leds |= INPUT_LED_SCROLL;
278 config->leds_changed = flip;
286 * Search an int array for a key value
288 * @param array Array to search
289 * @param count Number of elements in array
290 * @param key Key value to find
291 * @return element where value was first found, -1 if none
293 static int array_search(int *array, int count, int key)
297 for (i = 0; i < count; i++) {
306 * Sort an array so that those elements that exist in the ordering are
307 * first in the array, and in the same order as the ordering. The algorithm
308 * is O(count * ocount) and designed for small arrays.
310 * TODO: Move this to common / lib?
312 * @param dest Array with elements to sort, also destination array
313 * @param count Number of elements to sort
314 * @param order Array containing ordering elements
315 * @param ocount Number of ordering elements
316 * @return number of elements in dest that are in order (these will be at the
319 static int sort_array_by_ordering(int *dest, int count, int *order,
324 int same; /* number of elements which are the same */
327 /* setup output items, copy items to be sorted into our temp area */
328 memcpy(temp, dest, count * sizeof(*dest));
331 /* work through the ordering, move over the elements we agree on */
332 for (i = 0; i < ocount; i++) {
333 if (array_search(temp, count, order[i]) != -1)
334 dest[dest_count++] = order[i];
338 /* now move over the elements that are not in the ordering */
339 for (i = 0; i < count; i++) {
340 if (array_search(order, ocount, temp[i]) == -1)
341 dest[dest_count++] = temp[i];
343 assert(dest_count == count);
348 * Check a list of key codes against the previous key scan
350 * Given a list of new key codes, we check how many of these are the same
353 * @param config Input state
354 * @param keycode List of key codes to examine
355 * @param num_keycodes Number of key codes
356 * @param same Returns number of key codes which are the same
358 static int input_check_keycodes(struct input_config *config,
359 int keycode[], int num_keycodes, int *same)
361 /* Select the 'plain' xlate table to start with */
362 if (!config->num_tables) {
363 debug("%s: No xlate tables: cannot decode keys\n", __func__);
367 /* sort the keycodes into the same order as the previous ones */
368 *same = sort_array_by_ordering(keycode, num_keycodes,
369 config->prev_keycodes, config->num_prev_keycodes);
371 memcpy(config->prev_keycodes, keycode, num_keycodes * sizeof(int));
372 config->num_prev_keycodes = num_keycodes;
374 return *same != num_keycodes;
378 * Checks and converts a special key code into ANSI 3.64 escape sequence.
380 * @param config Input state
381 * @param keycode Key code to examine
382 * @param output_ch Buffer to place output characters into. It should
383 * be at least ANSI_CHAR_MAX bytes long, to allow for
385 * @param max_chars Maximum number of characters to add to output_ch
386 * @return number of characters output, if the key was converted, otherwise 0.
387 * This may be larger than max_chars, in which case the overflow
388 * characters are not output.
390 static int input_keycode_to_ansi364(struct input_config *config,
391 int keycode, char output_ch[], int max_chars)
397 for (i = ch_count = 0; i < ARRAY_SIZE(kbd_to_ansi364); i++) {
398 if (keycode != kbd_to_ansi364[i].kbd_scan_code)
400 for (escape = kbd_to_ansi364[i].escape; *escape; escape++) {
401 if (ch_count < max_chars)
402 output_ch[ch_count] = *escape;
412 * Converts and queues a list of key codes in escaped ASCII string form
413 * Convert a list of key codes into ASCII
415 * You must call input_check_keycodes() before this. It turns the keycode
416 * list into a list of ASCII characters and sends them to the input layer.
418 * Characters which were seen last time do not generate fresh ASCII output.
419 * The output (calls to queue_ascii) may be longer than num_keycodes, if the
420 * keycode contains special keys that was encoded to longer escaped sequence.
422 * @param config Input state
423 * @param keycode List of key codes to examine
424 * @param num_keycodes Number of key codes
425 * @param output_ch Buffer to place output characters into. It should
426 * be at last ANSI_CHAR_MAX * num_keycodes, to allow for
428 * @param max_chars Maximum number of characters to add to output_ch
429 * @param same Number of key codes which are the same
430 * @return number of characters written into output_ch, or -1 if we would
431 * exceed max_chars chars.
433 static int input_keycodes_to_ascii(struct input_config *config,
434 int keycode[], int num_keycodes, char output_ch[],
435 int max_chars, int same)
437 struct input_key_xlate *table;
441 table = &config->table[0];
443 /* deal with modifiers first */
444 for (i = 0; i < num_keycodes; i++) {
445 int key = keycode[i] & KEY_MASK;
447 if (key >= table->num_entries || table->xlate[key] == 0xff) {
448 table = process_modifier(config, key,
449 keycode[i] & KEY_RELEASE);
453 /* Start conversion by looking for the first new keycode (by same). */
454 for (i = same; i < num_keycodes; i++) {
455 int key = keycode[i];
459 * For a normal key (with an ASCII value), add it; otherwise
460 * translate special key to escape sequence if possible.
462 if (key < table->num_entries) {
463 ch = table->xlate[key];
464 if ((config->flags & FLAG_CAPS_LOCK) &&
465 ch >= 'a' && ch <= 'z')
467 if (ch_count < max_chars && ch != 0xff)
468 output_ch[ch_count++] = (uchar)ch;
470 ch_count += input_keycode_to_ansi364(config, key,
471 output_ch, max_chars);
475 if (ch_count > max_chars) {
476 debug("%s: Output char buffer overflow size=%d, need=%d\n",
477 __func__, max_chars, ch_count);
481 /* ok, so return keys */
485 static int _input_send_keycodes(struct input_config *config, int keycode[],
486 int num_keycodes, bool do_send)
488 char ch[num_keycodes * ANSI_CHAR_MAX];
489 int count, i, same = 0;
493 config->modifiers = 0;
494 if (!input_check_keycodes(config, keycode, num_keycodes, &same)) {
496 * Same as last time - is it time for another repeat?
497 * TODO(sjg@chromium.org) We drop repeats here and since
498 * the caller may not call in again for a while, our
499 * auto-repeat speed is not quite correct. We should
500 * insert another character if we later realise that we
501 * have missed a repeat slot.
503 is_repeat = config->allow_repeats || (config->repeat_rate_ms &&
504 (int)get_timer(config->next_repeat_ms) >= 0);
509 count = input_keycodes_to_ascii(config, keycode, num_keycodes,
510 ch, sizeof(ch), is_repeat ? 0 : same);
512 for (i = 0; i < count; i++)
513 input_queue_ascii(config, ch[i]);
515 delay_ms = is_repeat ?
516 config->repeat_rate_ms :
517 config->repeat_delay_ms;
519 config->next_repeat_ms = get_timer(0) + delay_ms;
524 int input_send_keycodes(struct input_config *config, int keycode[],
527 return _input_send_keycodes(config, keycode, num_keycodes, true);
530 int input_add_keycode(struct input_config *config, int new_keycode,
533 int keycode[INPUT_MAX_MODIFIERS + 1];
536 /* Add the old keycodes which are not removed by this new one */
537 for (i = 0, count = 0; i < config->num_prev_keycodes; i++) {
538 int code = config->prev_keycodes[i];
540 if (new_keycode == code) {
545 keycode[count++] = code;
548 if (!release && new_keycode != -1)
549 keycode[count++] = new_keycode;
550 debug("\ncodes for %02x/%d: ", new_keycode, release);
551 for (i = 0; i < count; i++)
552 debug("%02x ", keycode[i]);
555 /* Don't output any ASCII characters if this is a key release */
556 return _input_send_keycodes(config, keycode, count, !release);
559 int input_add_table(struct input_config *config, int left_keycode,
560 int right_keycode, const uchar *xlate, int num_entries)
562 struct input_key_xlate *table;
564 if (config->num_tables == INPUT_MAX_MODIFIERS) {
565 debug("%s: Too many modifier tables\n", __func__);
569 table = &config->table[config->num_tables++];
570 table->left_keycode = left_keycode;
571 table->right_keycode = right_keycode;
572 table->xlate = xlate;
573 table->num_entries = num_entries;
578 void input_set_delays(struct input_config *config, int repeat_delay_ms,
581 config->repeat_delay_ms = repeat_delay_ms;
582 config->repeat_rate_ms = repeat_rate_ms;
585 void input_allow_repeats(struct input_config *config, bool allow_repeats)
587 config->allow_repeats = allow_repeats;
590 int input_leds_changed(struct input_config *config)
592 if (config->leds_changed)
598 int input_add_tables(struct input_config *config, bool german)
600 struct kbd_entry *entry;
604 mask = german ? KBD_GERMAN : KBD_ENGLISH;
605 for (entry = kbd_entry; entry->kbd_mask; entry++) {
606 if (!(mask & entry->kbd_mask))
608 ret = input_add_table(config, entry->left_keycode,
609 entry->right_keycode, entry->xlate,
618 int input_init(struct input_config *config, int leds)
620 memset(config, '\0', sizeof(*config));
626 int input_stdio_register(struct stdio_dev *dev)
630 error = stdio_register(dev);
632 /* check if this is the standard input device */
633 if (!error && strcmp(getenv("stdin"), dev->name) == 0) {
634 /* reassign the console */
635 if (OVERWRITE_CONSOLE ||
636 console_assign(stdin, dev->name))