blob: 8a6506e7c6f9f237386861ae5ec5ec60f379b292 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Simon Glass9bc590e2012-04-17 09:01:30 +00002/*
3 * Translate key codes into ASCII
4 *
5 * Copyright (c) 2011 The Chromium OS Authors.
6 * (C) Copyright 2004 DENX Software Engineering, Wolfgang Denk, wd@denx.de
Simon Glass9bc590e2012-04-17 09:01:30 +00007 */
8
9#include <common.h>
Simon Glass24b852a2015-11-08 23:47:45 -070010#include <console.h>
Bin Mengcd810912015-11-12 05:33:02 -080011#include <dm.h>
Simon Glass7b51b572019-08-01 09:46:52 -060012#include <env.h>
Simon Glass92778b22015-10-18 21:17:12 -060013#include <errno.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060014#include <log.h>
Simon Glass9bc590e2012-04-17 09:01:30 +000015#include <stdio_dev.h>
16#include <input.h>
Bin Mengcd810912015-11-12 05:33:02 -080017#ifdef CONFIG_DM_KEYBOARD
18#include <keyboard.h>
19#endif
Simon Glass9bc590e2012-04-17 09:01:30 +000020#include <linux/input.h>
21
22enum {
23 /* These correspond to the lights on the keyboard */
Bin Meng377a0692015-11-12 05:33:03 -080024 FLAG_SCROLL_LOCK = 1 << 0,
25 FLAG_NUM_LOCK = 1 << 1,
26 FLAG_CAPS_LOCK = 1 << 2,
Simon Glass9bc590e2012-04-17 09:01:30 +000027
28 /* Special flag ORed with key code to indicate release */
29 KEY_RELEASE = 1 << 15,
30 KEY_MASK = 0xfff,
31};
32
33/*
34 * These takes map key codes to ASCII. 0xff means no key, or special key.
35 * Three tables are provided - one for plain keys, one for when the shift
36 * 'modifier' key is pressed and one for when the ctrl modifier key is
37 * pressed.
38 */
39static const uchar kbd_plain_xlate[] = {
40 0xff, 0x1b, '1', '2', '3', '4', '5', '6',
41 '7', '8', '9', '0', '-', '=', '\b', '\t', /* 0x00 - 0x0f */
42 'q', 'w', 'e', 'r', 't', 'y', 'u', 'i',
43 'o', 'p', '[', ']', '\r', 0xff, 'a', 's', /* 0x10 - 0x1f */
44 'd', 'f', 'g', 'h', 'j', 'k', 'l', ';',
45 '\'', '`', 0xff, '\\', 'z', 'x', 'c', 'v', /* 0x20 - 0x2f */
46 'b', 'n', 'm', ',' , '.', '/', 0xff, 0xff, 0xff,
47 ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x30 - 0x3f */
48 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7',
49 '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
50 '2', '3', '0', '.', 0xff, 0xff, 0xff, 0xff,
51 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x50 - 0x5F */
Simon Glass77c7f042015-10-18 21:17:23 -060052 '\r', 0xff, '/', '*',
Simon Glass9bc590e2012-04-17 09:01:30 +000053};
54
55static unsigned char kbd_shift_xlate[] = {
56 0xff, 0x1b, '!', '@', '#', '$', '%', '^',
57 '&', '*', '(', ')', '_', '+', '\b', '\t', /* 0x00 - 0x0f */
58 'Q', 'W', 'E', 'R', 'T', 'Y', 'U', 'I',
59 'O', 'P', '{', '}', '\r', 0xff, 'A', 'S', /* 0x10 - 0x1f */
60 'D', 'F', 'G', 'H', 'J', 'K', 'L', ':',
61 '"', '~', 0xff, '|', 'Z', 'X', 'C', 'V', /* 0x20 - 0x2f */
62 'B', 'N', 'M', '<', '>', '?', 0xff, 0xff, 0xff,
63 ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x30 - 0x3f */
64 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7',
65 '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
66 '2', '3', '0', '.', 0xff, 0xff, 0xff, 0xff, 0xff,
67 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x50 - 0x5F */
Simon Glass77c7f042015-10-18 21:17:23 -060068 '\r', 0xff, '/', '*',
Simon Glass9bc590e2012-04-17 09:01:30 +000069};
70
71static unsigned char kbd_ctrl_xlate[] = {
72 0xff, 0x1b, '1', 0x00, '3', '4', '5', 0x1E,
73 '7', '8', '9', '0', 0x1F, '=', '\b', '\t', /* 0x00 - 0x0f */
Simon Glass2e5513b2015-10-18 21:17:22 -060074 0x11, 0x17, 0x05, 0x12, 0x14, 0x19, 0x15, 0x09,
Simon Glass9bc590e2012-04-17 09:01:30 +000075 0x0f, 0x10, 0x1b, 0x1d, '\n', 0xff, 0x01, 0x13, /* 0x10 - 0x1f */
76 0x04, 0x06, 0x08, 0x09, 0x0a, 0x0b, 0x0c, ';',
77 '\'', '~', 0x00, 0x1c, 0x1a, 0x18, 0x03, 0x16, /* 0x20 - 0x2f */
78 0x02, 0x0e, 0x0d, '<', '>', '?', 0xff, 0xff,
79 0xff, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x30 - 0x3f */
80 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7',
81 '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
82 '2', '3', '0', '.', 0xff, 0xff, 0xff, 0xff,
83 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* 0x50 - 0x5F */
Simon Glass77c7f042015-10-18 21:17:23 -060084 '\r', 0xff, '/', '*',
Simon Glass9bc590e2012-04-17 09:01:30 +000085};
86
Heinrich Schuchardta84f5592018-03-02 21:11:35 +010087/*
88 * German keymap. Special letters are mapped according to code page 437.
89 */
Simon Glassb1d7a182015-11-11 10:05:37 -070090static const uchar kbd_plain_xlate_german[] = {
91 0xff, 0x1b, '1', '2', '3', '4', '5', '6', /* scan 00-07 */
92 '7', '8', '9', '0', 0xe1, '\'', 0x08, '\t', /* scan 08-0F */
93 'q', 'w', 'e', 'r', 't', 'z', 'u', 'i', /* scan 10-17 */
94 'o', 'p', 0x81, '+', '\r', 0xff, 'a', 's', /* scan 18-1F */
95 'd', 'f', 'g', 'h', 'j', 'k', 'l', 0x94, /* scan 20-27 */
96 0x84, '^', 0xff, '#', 'y', 'x', 'c', 'v', /* scan 28-2F */
97 'b', 'n', 'm', ',', '.', '-', 0xff, '*', /* scan 30-37 */
98 ' ', ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 38-3F */
99 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7', /* scan 40-47 */
100 '8', '9', '-', '4', '5', '6', '+', '1', /* scan 48-4F */
101 '2', '3', '0', ',', 0xff, 0xff, '<', 0xff, /* scan 50-57 */
102 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 58-5F */
103 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 60-67 */
104 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 68-6F */
105 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 70-77 */
106 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 78-7F */
107 '\r', 0xff, '/', '*',
108};
109
110static unsigned char kbd_shift_xlate_german[] = {
111 0xff, 0x1b, '!', '"', 0x15, '$', '%', '&', /* scan 00-07 */
112 '/', '(', ')', '=', '?', '`', 0x08, '\t', /* scan 08-0F */
113 'Q', 'W', 'E', 'R', 'T', 'Z', 'U', 'I', /* scan 10-17 */
114 'O', 'P', 0x9a, '*', '\r', 0xff, 'A', 'S', /* scan 18-1F */
115 'D', 'F', 'G', 'H', 'J', 'K', 'L', 0x99, /* scan 20-27 */
116 0x8e, 0xf8, 0xff, '\'', 'Y', 'X', 'C', 'V', /* scan 28-2F */
117 'B', 'N', 'M', ';', ':', '_', 0xff, '*', /* scan 30-37 */
118 ' ', ' ', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 38-3F */
119 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '7', /* scan 40-47 */
120 '8', '9', '-', '4', '5', '6', '+', '1', /* scan 48-4F */
121 '2', '3', '0', ',', 0xff, 0xff, '>', 0xff, /* scan 50-57 */
122 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 58-5F */
123 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 60-67 */
124 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 68-6F */
125 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 70-77 */
126 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 78-7F */
127 '\r', 0xff, '/', '*',
128};
129
130static unsigned char kbd_right_alt_xlate_german[] = {
Heinrich Schuchardta84f5592018-03-02 21:11:35 +0100131 0xff, 0xff, 0xff, 0xfd, 0xff, 0xff, 0xff, 0xff, /* scan 00-07 */
Simon Glassb1d7a182015-11-11 10:05:37 -0700132 '{', '[', ']', '}', '\\', 0xff, 0xff, 0xff, /* scan 08-0F */
133 '@', 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 10-17 */
134 0xff, 0xff, 0xff, '~', 0xff, 0xff, 0xff, 0xff, /* scan 18-1F */
135 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 20-27 */
136 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 28-2F */
137 0xff, 0xff, 0xe6, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 30-37 */
138 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 38-3F */
139 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 40-47 */
140 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, /* scan 48-4F */
141 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, '|', 0xff, /* scan 50-57 */
142};
143
144enum kbd_mask {
145 KBD_ENGLISH = 1 << 0,
146 KBD_GERMAN = 1 << 1,
147};
148
149static struct kbd_entry {
150 int kbd_mask; /* Which languages this is for */
151 int left_keycode; /* Left keycode to select this map */
152 int right_keycode; /* Right keycode to select this map */
153 const uchar *xlate; /* Ascii code for each keycode */
154 int num_entries; /* Number of entries in xlate */
155} kbd_entry[] = {
156 { KBD_ENGLISH, -1, -1,
157 kbd_plain_xlate, ARRAY_SIZE(kbd_plain_xlate) },
158 { KBD_GERMAN, -1, -1,
159 kbd_plain_xlate_german, ARRAY_SIZE(kbd_plain_xlate_german) },
160 { KBD_ENGLISH, KEY_LEFTSHIFT, KEY_RIGHTSHIFT,
161 kbd_shift_xlate, ARRAY_SIZE(kbd_shift_xlate) },
162 { KBD_GERMAN, KEY_LEFTSHIFT, KEY_RIGHTSHIFT,
163 kbd_shift_xlate_german, ARRAY_SIZE(kbd_shift_xlate_german) },
164 { KBD_ENGLISH | KBD_GERMAN, KEY_LEFTCTRL, KEY_RIGHTCTRL,
165 kbd_ctrl_xlate, ARRAY_SIZE(kbd_ctrl_xlate) },
166 { KBD_GERMAN, -1, KEY_RIGHTALT,
167 kbd_right_alt_xlate_german,
168 ARRAY_SIZE(kbd_right_alt_xlate_german) },
169 {},
170};
171
Hung-Te Lin44abe472012-10-11 15:15:53 +0000172/*
Heinrich Schuchardtb055a052020-10-23 20:52:26 +0200173 * The table contains conversions from scan key codes to ECMA-48 escape
174 * sequences. The same sequences exist in the withdrawn ANSI 3.64 standard.
175 *
176 * As all escape sequences start with 0x1b this byte has been removed.
177 *
178 * This table is incomplete in that it does not include all possible extra keys.
Hung-Te Lin44abe472012-10-11 15:15:53 +0000179 */
180static struct {
181 int kbd_scan_code;
182 char *escape;
183} kbd_to_ansi364[] = {
Heinrich Schuchardtb055a052020-10-23 20:52:26 +0200184 { KEY_UP, "[A"},
185 { KEY_LEFT, "[D"},
186 { KEY_RIGHT, "[C"},
187 { KEY_DOWN, "[B"},
188 { KEY_F1, "OP"},
189 { KEY_F2, "OQ"},
190 { KEY_F3, "OR"},
191 { KEY_F4, "OS"},
192 { KEY_F5, "[15~"},
193 { KEY_F6, "[17~"},
194 { KEY_F7, "[18~"},
195 { KEY_F8, "[19~"},
196 { KEY_F9, "[20~"},
197 { KEY_F10, "[21~"},
Hung-Te Lin44abe472012-10-11 15:15:53 +0000198};
199
200/* Maximum number of output characters that an ANSI sequence expands to */
Heinrich Schuchardtb055a052020-10-23 20:52:26 +0200201#define ANSI_CHAR_MAX 5
Simon Glass9bc590e2012-04-17 09:01:30 +0000202
Kim Phillipsc14e94e2012-10-29 13:34:42 +0000203static int input_queue_ascii(struct input_config *config, int ch)
Simon Glass9bc590e2012-04-17 09:01:30 +0000204{
205 if (config->fifo_in + 1 == INPUT_BUFFER_LEN) {
206 if (!config->fifo_out)
207 return -1; /* buffer full */
208 else
209 config->fifo_in = 0;
210 } else {
211 if (config->fifo_in + 1 == config->fifo_out)
212 return -1; /* buffer full */
213 config->fifo_in++;
214 }
Simon Glass3a85e432015-10-18 21:17:24 -0600215 debug(" {%02x} ", ch);
Simon Glass9bc590e2012-04-17 09:01:30 +0000216 config->fifo[config->fifo_in] = (uchar)ch;
217
218 return 0;
219}
220
221int input_tstc(struct input_config *config)
222{
223 if (config->fifo_in == config->fifo_out && config->read_keys) {
224 if (!(*config->read_keys)(config))
225 return 0;
226 }
227 return config->fifo_in != config->fifo_out;
228}
229
230int input_getc(struct input_config *config)
231{
232 int err = 0;
233
234 while (config->fifo_in == config->fifo_out) {
235 if (config->read_keys)
236 err = (*config->read_keys)(config);
237 if (err)
238 return -1;
239 }
240
241 if (++config->fifo_out == INPUT_BUFFER_LEN)
242 config->fifo_out = 0;
243
244 return config->fifo[config->fifo_out];
245}
246
247/**
248 * Process a modifier/special key press or release and decide which key
249 * translation array should be used as a result.
250 *
251 * TODO: Should keep track of modifier press/release
252 *
253 * @param config Input state
254 * @param key Key code to process
255 * @param release 0 if a press, 1 if a release
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100256 * Return: pointer to keycode->ascii translation table that should be used
Simon Glass9bc590e2012-04-17 09:01:30 +0000257 */
258static struct input_key_xlate *process_modifier(struct input_config *config,
259 int key, int release)
260{
Bin Mengcd810912015-11-12 05:33:02 -0800261#ifdef CONFIG_DM_KEYBOARD
262 struct udevice *dev = config->dev;
263 struct keyboard_ops *ops = keyboard_get_ops(dev);
264#endif
Simon Glass9bc590e2012-04-17 09:01:30 +0000265 struct input_key_xlate *table;
Simon Glass9bc590e2012-04-17 09:01:30 +0000266 int i;
267
268 /* Start with the main table, and see what modifiers change it */
269 assert(config->num_tables > 0);
270 table = &config->table[0];
271 for (i = 1; i < config->num_tables; i++) {
272 struct input_key_xlate *tab = &config->table[i];
273
274 if (key == tab->left_keycode || key == tab->right_keycode)
275 table = tab;
276 }
277
278 /* Handle the lighted keys */
279 if (!release) {
Simon Glassa683d0d2015-11-11 10:05:38 -0700280 int flip = -1;
281
Simon Glass9bc590e2012-04-17 09:01:30 +0000282 switch (key) {
283 case KEY_SCROLLLOCK:
284 flip = FLAG_SCROLL_LOCK;
285 break;
286 case KEY_NUMLOCK:
287 flip = FLAG_NUM_LOCK;
288 break;
289 case KEY_CAPSLOCK:
290 flip = FLAG_CAPS_LOCK;
291 break;
292 }
Simon Glass9bc590e2012-04-17 09:01:30 +0000293
Simon Glassa683d0d2015-11-11 10:05:38 -0700294 if (flip != -1) {
295 int leds = 0;
Simon Glass9bc590e2012-04-17 09:01:30 +0000296
Bin Meng533c81a2015-11-12 05:33:01 -0800297 config->flags ^= flip;
Simon Glassa683d0d2015-11-11 10:05:38 -0700298 if (config->flags & FLAG_NUM_LOCK)
299 leds |= INPUT_LED_NUM;
300 if (config->flags & FLAG_CAPS_LOCK)
301 leds |= INPUT_LED_CAPS;
302 if (config->flags & FLAG_SCROLL_LOCK)
303 leds |= INPUT_LED_SCROLL;
304 config->leds = leds;
Simon Glass3b5f6f52015-11-11 10:05:40 -0700305 config->leds_changed = flip;
Bin Mengcd810912015-11-12 05:33:02 -0800306
307#ifdef CONFIG_DM_KEYBOARD
308 if (ops->update_leds) {
309 if (ops->update_leds(dev, config->leds))
310 debug("Update keyboard's LED failed\n");
311 }
312#endif
Simon Glassa683d0d2015-11-11 10:05:38 -0700313 }
Simon Glass9bc590e2012-04-17 09:01:30 +0000314 }
315
316 return table;
317}
318
319/**
320 * Search an int array for a key value
321 *
322 * @param array Array to search
323 * @param count Number of elements in array
324 * @param key Key value to find
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100325 * Return: element where value was first found, -1 if none
Simon Glass9bc590e2012-04-17 09:01:30 +0000326 */
327static int array_search(int *array, int count, int key)
328{
329 int i;
330
331 for (i = 0; i < count; i++) {
332 if (array[i] == key)
333 return i;
334 }
335
336 return -1;
337}
338
339/**
340 * Sort an array so that those elements that exist in the ordering are
341 * first in the array, and in the same order as the ordering. The algorithm
342 * is O(count * ocount) and designed for small arrays.
343 *
344 * TODO: Move this to common / lib?
345 *
346 * @param dest Array with elements to sort, also destination array
347 * @param count Number of elements to sort
348 * @param order Array containing ordering elements
349 * @param ocount Number of ordering elements
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100350 * Return: number of elements in dest that are in order (these will be at the
Simon Glass9bc590e2012-04-17 09:01:30 +0000351 * start of dest).
352 */
353static int sort_array_by_ordering(int *dest, int count, int *order,
354 int ocount)
355{
356 int temp[count];
357 int dest_count;
358 int same; /* number of elements which are the same */
359 int i;
360
361 /* setup output items, copy items to be sorted into our temp area */
362 memcpy(temp, dest, count * sizeof(*dest));
363 dest_count = 0;
364
365 /* work through the ordering, move over the elements we agree on */
366 for (i = 0; i < ocount; i++) {
367 if (array_search(temp, count, order[i]) != -1)
368 dest[dest_count++] = order[i];
369 }
370 same = dest_count;
371
372 /* now move over the elements that are not in the ordering */
373 for (i = 0; i < count; i++) {
374 if (array_search(order, ocount, temp[i]) == -1)
375 dest[dest_count++] = temp[i];
376 }
377 assert(dest_count == count);
378 return same;
379}
380
381/**
382 * Check a list of key codes against the previous key scan
383 *
384 * Given a list of new key codes, we check how many of these are the same
385 * as last time.
386 *
387 * @param config Input state
388 * @param keycode List of key codes to examine
389 * @param num_keycodes Number of key codes
390 * @param same Returns number of key codes which are the same
391 */
392static int input_check_keycodes(struct input_config *config,
393 int keycode[], int num_keycodes, int *same)
394{
395 /* Select the 'plain' xlate table to start with */
396 if (!config->num_tables) {
397 debug("%s: No xlate tables: cannot decode keys\n", __func__);
398 return -1;
399 }
400
401 /* sort the keycodes into the same order as the previous ones */
402 *same = sort_array_by_ordering(keycode, num_keycodes,
403 config->prev_keycodes, config->num_prev_keycodes);
404
405 memcpy(config->prev_keycodes, keycode, num_keycodes * sizeof(int));
406 config->num_prev_keycodes = num_keycodes;
407
408 return *same != num_keycodes;
409}
410
411/**
Hung-Te Lin44abe472012-10-11 15:15:53 +0000412 * Checks and converts a special key code into ANSI 3.64 escape sequence.
413 *
414 * @param config Input state
415 * @param keycode Key code to examine
416 * @param output_ch Buffer to place output characters into. It should
417 * be at least ANSI_CHAR_MAX bytes long, to allow for
418 * an ANSI sequence.
419 * @param max_chars Maximum number of characters to add to output_ch
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100420 * Return: number of characters output, if the key was converted, otherwise 0.
Hung-Te Lin44abe472012-10-11 15:15:53 +0000421 * This may be larger than max_chars, in which case the overflow
422 * characters are not output.
423 */
424static int input_keycode_to_ansi364(struct input_config *config,
425 int keycode, char output_ch[], int max_chars)
426{
427 const char *escape;
428 int ch_count;
429 int i;
430
431 for (i = ch_count = 0; i < ARRAY_SIZE(kbd_to_ansi364); i++) {
432 if (keycode != kbd_to_ansi364[i].kbd_scan_code)
433 continue;
Heinrich Schuchardtb055a052020-10-23 20:52:26 +0200434 output_ch[ch_count++] = 0x1b;
Hung-Te Lin44abe472012-10-11 15:15:53 +0000435 for (escape = kbd_to_ansi364[i].escape; *escape; escape++) {
436 if (ch_count < max_chars)
437 output_ch[ch_count] = *escape;
438 ch_count++;
439 }
440 return ch_count;
441 }
442
443 return 0;
444}
445
446/**
447 * Converts and queues a list of key codes in escaped ASCII string form
Simon Glass9bc590e2012-04-17 09:01:30 +0000448 * Convert a list of key codes into ASCII
449 *
450 * You must call input_check_keycodes() before this. It turns the keycode
Hung-Te Lin44abe472012-10-11 15:15:53 +0000451 * list into a list of ASCII characters and sends them to the input layer.
Simon Glass9bc590e2012-04-17 09:01:30 +0000452 *
453 * Characters which were seen last time do not generate fresh ASCII output.
Hung-Te Lin44abe472012-10-11 15:15:53 +0000454 * The output (calls to queue_ascii) may be longer than num_keycodes, if the
455 * keycode contains special keys that was encoded to longer escaped sequence.
Simon Glass9bc590e2012-04-17 09:01:30 +0000456 *
457 * @param config Input state
458 * @param keycode List of key codes to examine
459 * @param num_keycodes Number of key codes
Hung-Te Lin44abe472012-10-11 15:15:53 +0000460 * @param output_ch Buffer to place output characters into. It should
461 * be at last ANSI_CHAR_MAX * num_keycodes, to allow for
462 * ANSI sequences.
463 * @param max_chars Maximum number of characters to add to output_ch
Simon Glass9bc590e2012-04-17 09:01:30 +0000464 * @param same Number of key codes which are the same
Heinrich Schuchardt185f8122022-01-19 18:05:50 +0100465 * Return: number of characters written into output_ch, or -1 if we would
Hung-Te Lin44abe472012-10-11 15:15:53 +0000466 * exceed max_chars chars.
Simon Glass9bc590e2012-04-17 09:01:30 +0000467 */
468static int input_keycodes_to_ascii(struct input_config *config,
Hung-Te Lin44abe472012-10-11 15:15:53 +0000469 int keycode[], int num_keycodes, char output_ch[],
470 int max_chars, int same)
Simon Glass9bc590e2012-04-17 09:01:30 +0000471{
472 struct input_key_xlate *table;
Hung-Te Lin44abe472012-10-11 15:15:53 +0000473 int ch_count = 0;
Simon Glass9bc590e2012-04-17 09:01:30 +0000474 int i;
475
476 table = &config->table[0];
477
478 /* deal with modifiers first */
479 for (i = 0; i < num_keycodes; i++) {
480 int key = keycode[i] & KEY_MASK;
481
482 if (key >= table->num_entries || table->xlate[key] == 0xff) {
483 table = process_modifier(config, key,
484 keycode[i] & KEY_RELEASE);
485 }
486 }
487
Hung-Te Lin44abe472012-10-11 15:15:53 +0000488 /* Start conversion by looking for the first new keycode (by same). */
489 for (i = same; i < num_keycodes; i++) {
Simon Glass9bc590e2012-04-17 09:01:30 +0000490 int key = keycode[i];
Heinrich Schuchardtb055a052020-10-23 20:52:26 +0200491 int ch = 0xff;
Simon Glass9bc590e2012-04-17 09:01:30 +0000492
Hung-Te Lin44abe472012-10-11 15:15:53 +0000493 /*
494 * For a normal key (with an ASCII value), add it; otherwise
495 * translate special key to escape sequence if possible.
496 */
Simon Glassba420342015-11-11 10:05:39 -0700497 if (key < table->num_entries) {
498 ch = table->xlate[key];
499 if ((config->flags & FLAG_CAPS_LOCK) &&
500 ch >= 'a' && ch <= 'z')
501 ch -= 'a' - 'A';
Bin Menge5f330c2015-11-12 05:33:04 -0800502 /* ban digit numbers if 'Num Lock' is not on */
503 if (!(config->flags & FLAG_NUM_LOCK)) {
504 if (key >= KEY_KP7 && key <= KEY_KPDOT &&
505 key != KEY_KPMINUS && key != KEY_KPPLUS)
506 ch = 0xff;
507 }
Simon Glassba420342015-11-11 10:05:39 -0700508 if (ch_count < max_chars && ch != 0xff)
509 output_ch[ch_count++] = (uchar)ch;
Heinrich Schuchardtb055a052020-10-23 20:52:26 +0200510 }
511 if (ch == 0xff)
Hung-Te Lin44abe472012-10-11 15:15:53 +0000512 ch_count += input_keycode_to_ansi364(config, key,
513 output_ch, max_chars);
Simon Glass9bc590e2012-04-17 09:01:30 +0000514 }
515
Hung-Te Lin44abe472012-10-11 15:15:53 +0000516 if (ch_count > max_chars) {
517 debug("%s: Output char buffer overflow size=%d, need=%d\n",
518 __func__, max_chars, ch_count);
519 return -1;
520 }
521
Simon Glass9bc590e2012-04-17 09:01:30 +0000522 /* ok, so return keys */
523 return ch_count;
524}
525
Simon Glass3a85e432015-10-18 21:17:24 -0600526static int _input_send_keycodes(struct input_config *config, int keycode[],
527 int num_keycodes, bool do_send)
Simon Glass9bc590e2012-04-17 09:01:30 +0000528{
Hung-Te Lin44abe472012-10-11 15:15:53 +0000529 char ch[num_keycodes * ANSI_CHAR_MAX];
Simon Glass9bc590e2012-04-17 09:01:30 +0000530 int count, i, same = 0;
531 int is_repeat = 0;
532 unsigned delay_ms;
533
534 config->modifiers = 0;
535 if (!input_check_keycodes(config, keycode, num_keycodes, &same)) {
536 /*
537 * Same as last time - is it time for another repeat?
538 * TODO(sjg@chromium.org) We drop repeats here and since
539 * the caller may not call in again for a while, our
540 * auto-repeat speed is not quite correct. We should
541 * insert another character if we later realise that we
542 * have missed a repeat slot.
543 */
Simon Glass0b186c02015-10-18 21:17:25 -0600544 is_repeat = config->allow_repeats || (config->repeat_rate_ms &&
545 (int)get_timer(config->next_repeat_ms) >= 0);
Simon Glass9bc590e2012-04-17 09:01:30 +0000546 if (!is_repeat)
547 return 0;
548 }
549
550 count = input_keycodes_to_ascii(config, keycode, num_keycodes,
Hung-Te Lin44abe472012-10-11 15:15:53 +0000551 ch, sizeof(ch), is_repeat ? 0 : same);
Simon Glass3a85e432015-10-18 21:17:24 -0600552 if (do_send) {
553 for (i = 0; i < count; i++)
554 input_queue_ascii(config, ch[i]);
555 }
Simon Glass9bc590e2012-04-17 09:01:30 +0000556 delay_ms = is_repeat ?
557 config->repeat_rate_ms :
558 config->repeat_delay_ms;
559
560 config->next_repeat_ms = get_timer(0) + delay_ms;
Hung-Te Lin44abe472012-10-11 15:15:53 +0000561
562 return count;
Simon Glass9bc590e2012-04-17 09:01:30 +0000563}
564
Simon Glass3a85e432015-10-18 21:17:24 -0600565int input_send_keycodes(struct input_config *config, int keycode[],
566 int num_keycodes)
567{
568 return _input_send_keycodes(config, keycode, num_keycodes, true);
569}
570
571int input_add_keycode(struct input_config *config, int new_keycode,
572 bool release)
573{
574 int keycode[INPUT_MAX_MODIFIERS + 1];
575 int count, i;
576
577 /* Add the old keycodes which are not removed by this new one */
578 for (i = 0, count = 0; i < config->num_prev_keycodes; i++) {
579 int code = config->prev_keycodes[i];
580
581 if (new_keycode == code) {
582 if (release)
583 continue;
584 new_keycode = -1;
585 }
586 keycode[count++] = code;
587 }
588
589 if (!release && new_keycode != -1)
590 keycode[count++] = new_keycode;
591 debug("\ncodes for %02x/%d: ", new_keycode, release);
592 for (i = 0; i < count; i++)
593 debug("%02x ", keycode[i]);
594 debug("\n");
595
596 /* Don't output any ASCII characters if this is a key release */
597 return _input_send_keycodes(config, keycode, count, !release);
598}
599
Simon Glass9bc590e2012-04-17 09:01:30 +0000600int input_add_table(struct input_config *config, int left_keycode,
601 int right_keycode, const uchar *xlate, int num_entries)
602{
603 struct input_key_xlate *table;
604
605 if (config->num_tables == INPUT_MAX_MODIFIERS) {
606 debug("%s: Too many modifier tables\n", __func__);
607 return -1;
608 }
609
610 table = &config->table[config->num_tables++];
611 table->left_keycode = left_keycode;
612 table->right_keycode = right_keycode;
613 table->xlate = xlate;
614 table->num_entries = num_entries;
615
616 return 0;
617}
618
Simon Glass1b1d3e62012-09-27 15:18:41 +0000619void input_set_delays(struct input_config *config, int repeat_delay_ms,
Simon Glass9bc590e2012-04-17 09:01:30 +0000620 int repeat_rate_ms)
621{
Simon Glass1b1d3e62012-09-27 15:18:41 +0000622 config->repeat_delay_ms = repeat_delay_ms;
623 config->repeat_rate_ms = repeat_rate_ms;
624}
625
Simon Glass0b186c02015-10-18 21:17:25 -0600626void input_allow_repeats(struct input_config *config, bool allow_repeats)
627{
628 config->allow_repeats = allow_repeats;
629}
630
Simon Glass3b5f6f52015-11-11 10:05:40 -0700631int input_leds_changed(struct input_config *config)
632{
633 if (config->leds_changed)
634 return config->leds;
635
636 return -1;
637}
638
Simon Glassb1d7a182015-11-11 10:05:37 -0700639int input_add_tables(struct input_config *config, bool german)
Simon Glass66877b02015-10-18 21:17:13 -0600640{
Simon Glassb1d7a182015-11-11 10:05:37 -0700641 struct kbd_entry *entry;
642 int mask;
Simon Glass66877b02015-10-18 21:17:13 -0600643 int ret;
644
Simon Glassb1d7a182015-11-11 10:05:37 -0700645 mask = german ? KBD_GERMAN : KBD_ENGLISH;
646 for (entry = kbd_entry; entry->kbd_mask; entry++) {
647 if (!(mask & entry->kbd_mask))
648 continue;
649 ret = input_add_table(config, entry->left_keycode,
650 entry->right_keycode, entry->xlate,
651 entry->num_entries);
652 if (ret)
653 return ret;
654 }
Simon Glass66877b02015-10-18 21:17:13 -0600655
Simon Glassb1d7a182015-11-11 10:05:37 -0700656 return 0;
Simon Glass66877b02015-10-18 21:17:13 -0600657}
658
Simon Glass1b1d3e62012-09-27 15:18:41 +0000659int input_init(struct input_config *config, int leds)
660{
Simon Glass9bc590e2012-04-17 09:01:30 +0000661 memset(config, '\0', sizeof(*config));
662 config->leds = leds;
Simon Glass9bc590e2012-04-17 09:01:30 +0000663
664 return 0;
665}
666
667int input_stdio_register(struct stdio_dev *dev)
668{
669 int error;
670
671 error = stdio_register(dev);
Heinrich Schuchardt2d307fb2023-10-03 03:09:01 +0200672
673 if (!CONFIG_IS_ENABLED(ENV_SUPPORT))
674 return 0;
675
676 if (!error) {
677 const char *cstdin;
678
679 /* check if this is the standard input device */
680 cstdin = env_get("stdin");
681 if (cstdin && !strcmp(cstdin, dev->name)) {
682 /* reassign the console */
683 if (OVERWRITE_CONSOLE ||
684 console_assign(stdin, dev->name))
685 return -1;
686 }
Simon Glass9bc590e2012-04-17 09:01:30 +0000687 }
Simon Glass9bc590e2012-04-17 09:01:30 +0000688
689 return 0;
690}