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 */
87 * German keymap. Special letters are mapped according to code page 437.
89 static const uchar kbd_plain_xlate_german[] = {
90 0xff, 0x1b, '1', '2', '3', '4', '5', '6', /* scan 00-07 */
91 '7', '8', '9', '0', 0xe1, '\'', 0x08, '\t', /* scan 08-0F */
92 'q', 'w', 'e', 'r', 't', 'z', 'u', 'i', /* scan 10-17 */
93 'o', 'p', 0x81, '+', '\r', 0xff, 'a', 's', /* scan 18-1F */
94 'd', 'f', 'g', 'h', 'j', 'k', 'l', 0x94, /* scan 20-27 */
95 0x84, '^', 0xff, '#', 'y', 'x', 'c', 'v', /* scan 28-2F */
96 'b', 'n', 'm', ',', '.', '-', 0xff, '*', /* scan 30-37 */
97 ' ', ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 38-3F */
98 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7', /* scan 40-47 */
99 '8', '9', '-', '4', '5', '6', '+', '1', /* scan 48-4F */
100 '2', '3', '0', ',', 0xff, 0xff, '<', 0xff, /* scan 50-57 */
101 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 58-5F */
102 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 60-67 */
103 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 68-6F */
104 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 70-77 */
105 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 78-7F */
106 '\r', 0xff, '/', '*',
109 static unsigned char kbd_shift_xlate_german[] = {
110 0xff, 0x1b, '!', '"', 0x15, '$', '%', '&', /* scan 00-07 */
111 '/', '(', ')', '=', '?', '`', 0x08, '\t', /* scan 08-0F */
112 'Q', 'W', 'E', 'R', 'T', 'Z', 'U', 'I', /* scan 10-17 */
113 'O', 'P', 0x9a, '*', '\r', 0xff, 'A', 'S', /* scan 18-1F */
114 'D', 'F', 'G', 'H', 'J', 'K', 'L', 0x99, /* scan 20-27 */
115 0x8e, 0xf8, 0xff, '\'', 'Y', 'X', 'C', 'V', /* scan 28-2F */
116 'B', 'N', 'M', ';', ':', '_', 0xff, '*', /* scan 30-37 */
117 ' ', ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 38-3F */
118 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7', /* scan 40-47 */
119 '8', '9', '-', '4', '5', '6', '+', '1', /* scan 48-4F */
120 '2', '3', '0', ',', 0xff, 0xff, '>', 0xff, /* scan 50-57 */
121 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 58-5F */
122 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 60-67 */
123 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 68-6F */
124 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 70-77 */
125 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 78-7F */
126 '\r', 0xff, '/', '*',
129 static unsigned char kbd_right_alt_xlate_german[] = {
130 0xff, 0xff, 0xff, 0xfd, 0xff, 0xff, 0xff, 0xff, /* scan 00-07 */
131 '{', '[', ']', '}', '\\', 0xff, 0xff, 0xff, /* scan 08-0F */
132 '@', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 10-17 */
133 0xff, 0xff, 0xff, '~', 0xff, 0xff, 0xff, 0xff, /* scan 18-1F */
134 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 20-27 */
135 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 28-2F */
136 0xff, 0xff, 0xe6, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 30-37 */
137 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 38-3F */
138 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 40-47 */
139 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 48-4F */
140 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '|', 0xff, /* scan 50-57 */
144 KBD_ENGLISH = 1 << 0,
148 static struct kbd_entry {
149 int kbd_mask; /* Which languages this is for */
150 int left_keycode; /* Left keycode to select this map */
151 int right_keycode; /* Right keycode to select this map */
152 const uchar *xlate; /* Ascii code for each keycode */
153 int num_entries; /* Number of entries in xlate */
155 { KBD_ENGLISH, -1, -1,
156 kbd_plain_xlate, ARRAY_SIZE(kbd_plain_xlate) },
157 { KBD_GERMAN, -1, -1,
158 kbd_plain_xlate_german, ARRAY_SIZE(kbd_plain_xlate_german) },
159 { KBD_ENGLISH, KEY_LEFTSHIFT, KEY_RIGHTSHIFT,
160 kbd_shift_xlate, ARRAY_SIZE(kbd_shift_xlate) },
161 { KBD_GERMAN, KEY_LEFTSHIFT, KEY_RIGHTSHIFT,
162 kbd_shift_xlate_german, ARRAY_SIZE(kbd_shift_xlate_german) },
163 { KBD_ENGLISH | KBD_GERMAN, KEY_LEFTCTRL, KEY_RIGHTCTRL,
164 kbd_ctrl_xlate, ARRAY_SIZE(kbd_ctrl_xlate) },
165 { KBD_GERMAN, -1, KEY_RIGHTALT,
166 kbd_right_alt_xlate_german,
167 ARRAY_SIZE(kbd_right_alt_xlate_german) },
172 * Scan key code to ANSI 3.64 escape sequence table. This table is
173 * incomplete in that it does not include all possible extra keys.
178 } kbd_to_ansi364[] = {
180 { KEY_DOWN, "\033[B"},
181 { KEY_RIGHT, "\033[C"},
182 { KEY_LEFT, "\033[D"},
185 /* Maximum number of output characters that an ANSI sequence expands to */
186 #define ANSI_CHAR_MAX 3
188 static int input_queue_ascii(struct input_config *config, int ch)
190 if (config->fifo_in + 1 == INPUT_BUFFER_LEN) {
191 if (!config->fifo_out)
192 return -1; /* buffer full */
196 if (config->fifo_in + 1 == config->fifo_out)
197 return -1; /* buffer full */
200 debug(" {%02x} ", ch);
201 config->fifo[config->fifo_in] = (uchar)ch;
206 int input_tstc(struct input_config *config)
208 if (config->fifo_in == config->fifo_out && config->read_keys) {
209 if (!(*config->read_keys)(config))
212 return config->fifo_in != config->fifo_out;
215 int input_getc(struct input_config *config)
219 while (config->fifo_in == config->fifo_out) {
220 if (config->read_keys)
221 err = (*config->read_keys)(config);
226 if (++config->fifo_out == INPUT_BUFFER_LEN)
227 config->fifo_out = 0;
229 return config->fifo[config->fifo_out];
233 * Process a modifier/special key press or release and decide which key
234 * translation array should be used as a result.
236 * TODO: Should keep track of modifier press/release
238 * @param config Input state
239 * @param key Key code to process
240 * @param release 0 if a press, 1 if a release
241 * @return pointer to keycode->ascii translation table that should be used
243 static struct input_key_xlate *process_modifier(struct input_config *config,
244 int key, int release)
246 #ifdef CONFIG_DM_KEYBOARD
247 struct udevice *dev = config->dev;
248 struct keyboard_ops *ops = keyboard_get_ops(dev);
250 struct input_key_xlate *table;
253 /* Start with the main table, and see what modifiers change it */
254 assert(config->num_tables > 0);
255 table = &config->table[0];
256 for (i = 1; i < config->num_tables; i++) {
257 struct input_key_xlate *tab = &config->table[i];
259 if (key == tab->left_keycode || key == tab->right_keycode)
263 /* Handle the lighted keys */
269 flip = FLAG_SCROLL_LOCK;
272 flip = FLAG_NUM_LOCK;
275 flip = FLAG_CAPS_LOCK;
282 config->flags ^= flip;
283 if (config->flags & FLAG_NUM_LOCK)
284 leds |= INPUT_LED_NUM;
285 if (config->flags & FLAG_CAPS_LOCK)
286 leds |= INPUT_LED_CAPS;
287 if (config->flags & FLAG_SCROLL_LOCK)
288 leds |= INPUT_LED_SCROLL;
290 config->leds_changed = flip;
292 #ifdef CONFIG_DM_KEYBOARD
293 if (ops->update_leds) {
294 if (ops->update_leds(dev, config->leds))
295 debug("Update keyboard's LED failed\n");
305 * Search an int array for a key value
307 * @param array Array to search
308 * @param count Number of elements in array
309 * @param key Key value to find
310 * @return element where value was first found, -1 if none
312 static int array_search(int *array, int count, int key)
316 for (i = 0; i < count; i++) {
325 * Sort an array so that those elements that exist in the ordering are
326 * first in the array, and in the same order as the ordering. The algorithm
327 * is O(count * ocount) and designed for small arrays.
329 * TODO: Move this to common / lib?
331 * @param dest Array with elements to sort, also destination array
332 * @param count Number of elements to sort
333 * @param order Array containing ordering elements
334 * @param ocount Number of ordering elements
335 * @return number of elements in dest that are in order (these will be at the
338 static int sort_array_by_ordering(int *dest, int count, int *order,
343 int same; /* number of elements which are the same */
346 /* setup output items, copy items to be sorted into our temp area */
347 memcpy(temp, dest, count * sizeof(*dest));
350 /* work through the ordering, move over the elements we agree on */
351 for (i = 0; i < ocount; i++) {
352 if (array_search(temp, count, order[i]) != -1)
353 dest[dest_count++] = order[i];
357 /* now move over the elements that are not in the ordering */
358 for (i = 0; i < count; i++) {
359 if (array_search(order, ocount, temp[i]) == -1)
360 dest[dest_count++] = temp[i];
362 assert(dest_count == count);
367 * Check a list of key codes against the previous key scan
369 * Given a list of new key codes, we check how many of these are the same
372 * @param config Input state
373 * @param keycode List of key codes to examine
374 * @param num_keycodes Number of key codes
375 * @param same Returns number of key codes which are the same
377 static int input_check_keycodes(struct input_config *config,
378 int keycode[], int num_keycodes, int *same)
380 /* Select the 'plain' xlate table to start with */
381 if (!config->num_tables) {
382 debug("%s: No xlate tables: cannot decode keys\n", __func__);
386 /* sort the keycodes into the same order as the previous ones */
387 *same = sort_array_by_ordering(keycode, num_keycodes,
388 config->prev_keycodes, config->num_prev_keycodes);
390 memcpy(config->prev_keycodes, keycode, num_keycodes * sizeof(int));
391 config->num_prev_keycodes = num_keycodes;
393 return *same != num_keycodes;
397 * Checks and converts a special key code into ANSI 3.64 escape sequence.
399 * @param config Input state
400 * @param keycode Key code to examine
401 * @param output_ch Buffer to place output characters into. It should
402 * be at least ANSI_CHAR_MAX bytes long, to allow for
404 * @param max_chars Maximum number of characters to add to output_ch
405 * @return number of characters output, if the key was converted, otherwise 0.
406 * This may be larger than max_chars, in which case the overflow
407 * characters are not output.
409 static int input_keycode_to_ansi364(struct input_config *config,
410 int keycode, char output_ch[], int max_chars)
416 for (i = ch_count = 0; i < ARRAY_SIZE(kbd_to_ansi364); i++) {
417 if (keycode != kbd_to_ansi364[i].kbd_scan_code)
419 for (escape = kbd_to_ansi364[i].escape; *escape; escape++) {
420 if (ch_count < max_chars)
421 output_ch[ch_count] = *escape;
431 * Converts and queues a list of key codes in escaped ASCII string form
432 * Convert a list of key codes into ASCII
434 * You must call input_check_keycodes() before this. It turns the keycode
435 * list into a list of ASCII characters and sends them to the input layer.
437 * Characters which were seen last time do not generate fresh ASCII output.
438 * The output (calls to queue_ascii) may be longer than num_keycodes, if the
439 * keycode contains special keys that was encoded to longer escaped sequence.
441 * @param config Input state
442 * @param keycode List of key codes to examine
443 * @param num_keycodes Number of key codes
444 * @param output_ch Buffer to place output characters into. It should
445 * be at last ANSI_CHAR_MAX * num_keycodes, to allow for
447 * @param max_chars Maximum number of characters to add to output_ch
448 * @param same Number of key codes which are the same
449 * @return number of characters written into output_ch, or -1 if we would
450 * exceed max_chars chars.
452 static int input_keycodes_to_ascii(struct input_config *config,
453 int keycode[], int num_keycodes, char output_ch[],
454 int max_chars, int same)
456 struct input_key_xlate *table;
460 table = &config->table[0];
462 /* deal with modifiers first */
463 for (i = 0; i < num_keycodes; i++) {
464 int key = keycode[i] & KEY_MASK;
466 if (key >= table->num_entries || table->xlate[key] == 0xff) {
467 table = process_modifier(config, key,
468 keycode[i] & KEY_RELEASE);
472 /* Start conversion by looking for the first new keycode (by same). */
473 for (i = same; i < num_keycodes; i++) {
474 int key = keycode[i];
478 * For a normal key (with an ASCII value), add it; otherwise
479 * translate special key to escape sequence if possible.
481 if (key < table->num_entries) {
482 ch = table->xlate[key];
483 if ((config->flags & FLAG_CAPS_LOCK) &&
484 ch >= 'a' && ch <= 'z')
486 /* ban digit numbers if 'Num Lock' is not on */
487 if (!(config->flags & FLAG_NUM_LOCK)) {
488 if (key >= KEY_KP7 && key <= KEY_KPDOT &&
489 key != KEY_KPMINUS && key != KEY_KPPLUS)
492 if (ch_count < max_chars && ch != 0xff)
493 output_ch[ch_count++] = (uchar)ch;
495 ch_count += input_keycode_to_ansi364(config, key,
496 output_ch, max_chars);
500 if (ch_count > max_chars) {
501 debug("%s: Output char buffer overflow size=%d, need=%d\n",
502 __func__, max_chars, ch_count);
506 /* ok, so return keys */
510 static int _input_send_keycodes(struct input_config *config, int keycode[],
511 int num_keycodes, bool do_send)
513 char ch[num_keycodes * ANSI_CHAR_MAX];
514 int count, i, same = 0;
518 config->modifiers = 0;
519 if (!input_check_keycodes(config, keycode, num_keycodes, &same)) {
521 * Same as last time - is it time for another repeat?
522 * TODO(sjg@chromium.org) We drop repeats here and since
523 * the caller may not call in again for a while, our
524 * auto-repeat speed is not quite correct. We should
525 * insert another character if we later realise that we
526 * have missed a repeat slot.
528 is_repeat = config->allow_repeats || (config->repeat_rate_ms &&
529 (int)get_timer(config->next_repeat_ms) >= 0);
534 count = input_keycodes_to_ascii(config, keycode, num_keycodes,
535 ch, sizeof(ch), is_repeat ? 0 : same);
537 for (i = 0; i < count; i++)
538 input_queue_ascii(config, ch[i]);
540 delay_ms = is_repeat ?
541 config->repeat_rate_ms :
542 config->repeat_delay_ms;
544 config->next_repeat_ms = get_timer(0) + delay_ms;
549 int input_send_keycodes(struct input_config *config, int keycode[],
552 return _input_send_keycodes(config, keycode, num_keycodes, true);
555 int input_add_keycode(struct input_config *config, int new_keycode,
558 int keycode[INPUT_MAX_MODIFIERS + 1];
561 /* Add the old keycodes which are not removed by this new one */
562 for (i = 0, count = 0; i < config->num_prev_keycodes; i++) {
563 int code = config->prev_keycodes[i];
565 if (new_keycode == code) {
570 keycode[count++] = code;
573 if (!release && new_keycode != -1)
574 keycode[count++] = new_keycode;
575 debug("\ncodes for %02x/%d: ", new_keycode, release);
576 for (i = 0; i < count; i++)
577 debug("%02x ", keycode[i]);
580 /* Don't output any ASCII characters if this is a key release */
581 return _input_send_keycodes(config, keycode, count, !release);
584 int input_add_table(struct input_config *config, int left_keycode,
585 int right_keycode, const uchar *xlate, int num_entries)
587 struct input_key_xlate *table;
589 if (config->num_tables == INPUT_MAX_MODIFIERS) {
590 debug("%s: Too many modifier tables\n", __func__);
594 table = &config->table[config->num_tables++];
595 table->left_keycode = left_keycode;
596 table->right_keycode = right_keycode;
597 table->xlate = xlate;
598 table->num_entries = num_entries;
603 void input_set_delays(struct input_config *config, int repeat_delay_ms,
606 config->repeat_delay_ms = repeat_delay_ms;
607 config->repeat_rate_ms = repeat_rate_ms;
610 void input_allow_repeats(struct input_config *config, bool allow_repeats)
612 config->allow_repeats = allow_repeats;
615 int input_leds_changed(struct input_config *config)
617 if (config->leds_changed)
623 int input_add_tables(struct input_config *config, bool german)
625 struct kbd_entry *entry;
629 mask = german ? KBD_GERMAN : KBD_ENGLISH;
630 for (entry = kbd_entry; entry->kbd_mask; entry++) {
631 if (!(mask & entry->kbd_mask))
633 ret = input_add_table(config, entry->left_keycode,
634 entry->right_keycode, entry->xlate,
643 int input_init(struct input_config *config, int leds)
645 memset(config, '\0', sizeof(*config));
651 int input_stdio_register(struct stdio_dev *dev)
655 error = stdio_register(dev);
657 /* check if this is the standard input device */
658 if (!error && strcmp(env_get("stdin"), dev->name) == 0) {
659 /* reassign the console */
660 if (OVERWRITE_CONSOLE ||
661 console_assign(stdin, dev->name))