blob: d385bea532e24d86259c937f29a788cfce6a46c3 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
wdenkaffae2b2002-08-17 09:36:01 +00002/*
3 * (C) Copyright 2001
4 * Denis Peter, MPL AG Switzerland
5 *
6 * Part of this source has been derived from the Linux USB
7 * project.
wdenkaffae2b2002-08-17 09:36:01 +00008 */
9#include <common.h>
Simon Glass24b852a2015-11-08 23:47:45 -070010#include <console.h>
Simon Glass697033c2015-03-25 12:22:34 -060011#include <dm.h>
Simon Glass7b51b572019-08-01 09:46:52 -060012#include <env.h>
Hans de Goede0ea09df2014-09-20 16:54:34 +020013#include <errno.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060014#include <log.h>
Marek Vasut9a8c72a2011-10-10 16:34:26 +010015#include <malloc.h>
Simon Glasscf92e052015-09-02 17:24:58 -060016#include <memalign.h>
Jean-Christophe PLAGNIOL-VILLARD52cb4d42009-05-16 12:14:54 +020017#include <stdio_dev.h>
Michal Simekf8f3e0e2018-06-27 14:16:54 +020018#include <watchdog.h>
Christian Eggersc9182612008-05-21 22:12:00 +020019#include <asm/byteorder.h>
Thomas Watson96991e62022-02-10 15:13:14 -060020#ifdef CONFIG_SANDBOX
21#include <asm/state.h>
22#endif
wdenkaffae2b2002-08-17 09:36:01 +000023
wdenkaffae2b2002-08-17 09:36:01 +000024#include <usb.h>
25
wdenkaffae2b2002-08-17 09:36:01 +000026/*
Marek Vasut00b7d6e2011-10-10 05:34:25 +000027 * If overwrite_console returns 1, the stdin, stderr and stdout
wdenkaffae2b2002-08-17 09:36:01 +000028 * are switched to the serial port, else the settings in the
29 * environment are used
30 */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020031#ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
Marek Vasut00b7d6e2011-10-10 05:34:25 +000032extern int overwrite_console(void);
wdenkaffae2b2002-08-17 09:36:01 +000033#else
Marek Vasut00b7d6e2011-10-10 05:34:25 +000034int overwrite_console(void)
wdenkaffae2b2002-08-17 09:36:01 +000035{
Marek Vasut00b7d6e2011-10-10 05:34:25 +000036 return 0;
wdenkaffae2b2002-08-17 09:36:01 +000037}
38#endif
39
Marek Vasut9a8c72a2011-10-10 16:34:26 +010040/* Keyboard sampling rate */
Hans de Goede8454c842015-05-19 22:51:03 +020041#define REPEAT_RATE 40 /* 40msec -> 25cps */
Marek Vasut9a8c72a2011-10-10 16:34:26 +010042#define REPEAT_DELAY 10 /* 10 x REPEAT_RATE = 400msec */
wdenkaffae2b2002-08-17 09:36:01 +000043
44#define NUM_LOCK 0x53
Marek Vasut00b7d6e2011-10-10 05:34:25 +000045#define CAPS_LOCK 0x39
46#define SCROLL_LOCK 0x47
wdenkaffae2b2002-08-17 09:36:01 +000047
wdenkaffae2b2002-08-17 09:36:01 +000048/* Modifier bits */
Marek Vasut9a8c72a2011-10-10 16:34:26 +010049#define LEFT_CNTR (1 << 0)
50#define LEFT_SHIFT (1 << 1)
51#define LEFT_ALT (1 << 2)
52#define LEFT_GUI (1 << 3)
53#define RIGHT_CNTR (1 << 4)
54#define RIGHT_SHIFT (1 << 5)
55#define RIGHT_ALT (1 << 6)
56#define RIGHT_GUI (1 << 7)
wdenkaffae2b2002-08-17 09:36:01 +000057
Marek Vasut9a8c72a2011-10-10 16:34:26 +010058/* Size of the keyboard buffer */
59#define USB_KBD_BUFFER_LEN 0x20
wdenkaffae2b2002-08-17 09:36:01 +000060
Marek Vasut9a8c72a2011-10-10 16:34:26 +010061/* Device name */
Marek Vasut00b7d6e2011-10-10 05:34:25 +000062#define DEVNAME "usbkbd"
wdenkaffae2b2002-08-17 09:36:01 +000063
Marek Vasut9a8c72a2011-10-10 16:34:26 +010064/* Keyboard maps */
65static const unsigned char usb_kbd_numkey[] = {
Marek Vasut00b7d6e2011-10-10 05:34:25 +000066 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
67 '\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']',
68 '\\', '#', ';', '\'', '`', ',', '.', '/'
wdenkaffae2b2002-08-17 09:36:01 +000069};
Marek Vasut9a8c72a2011-10-10 16:34:26 +010070static const unsigned char usb_kbd_numkey_shifted[] = {
Marek Vasut00b7d6e2011-10-10 05:34:25 +000071 '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
72 '\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}',
73 '|', '~', ':', '"', '~', '<', '>', '?'
wdenkaffae2b2002-08-17 09:36:01 +000074};
75
Vincent Palatind53da842012-01-09 12:59:36 +000076static const unsigned char usb_kbd_num_keypad[] = {
77 '/', '*', '-', '+', '\r',
78 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
79 '.', 0, 0, 0, '='
80};
81
Heinrich Schuchardt3352c212019-11-23 18:15:20 +010082static const u8 usb_special_keys[] = {
Heinrich Schuchardt87e91bc2019-11-23 18:15:21 +010083#ifdef CONFIG_USB_KEYBOARD_FN_KEYS
84 '2', 'H', '5', '3', 'F', '6', 'C', 'D', 'B', 'A'
85#else
Heinrich Schuchardt3352c212019-11-23 18:15:20 +010086 'C', 'D', 'B', 'A'
Heinrich Schuchardt87e91bc2019-11-23 18:15:21 +010087#endif
Allen Martin4151a402012-11-06 13:26:03 -080088};
89
90/*
Marek Vasut9a8c72a2011-10-10 16:34:26 +010091 * NOTE: It's important for the NUM, CAPS, SCROLL-lock bits to be in this
92 * order. See usb_kbd_setled() function!
93 */
94#define USB_KBD_NUMLOCK (1 << 0)
95#define USB_KBD_CAPSLOCK (1 << 1)
96#define USB_KBD_SCROLLLOCK (1 << 2)
97#define USB_KBD_CTRL (1 << 3)
Marek Vasut48c80732011-09-25 20:00:37 +010098
Marek Vasut9a8c72a2011-10-10 16:34:26 +010099#define USB_KBD_LEDMASK \
100 (USB_KBD_NUMLOCK | USB_KBD_CAPSLOCK | USB_KBD_SCROLLLOCK)
101
102struct usb_kbd_pdata {
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200103 unsigned long intpipe;
104 int intpktsize;
105 int intinterval;
Hans de Goede8454c842015-05-19 22:51:03 +0200106 unsigned long last_report;
Hans de Goede8e553112014-09-24 14:06:11 +0200107 struct int_queue *intq;
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200108
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100109 uint32_t repeat_delay;
110
111 uint32_t usb_in_pointer;
112 uint32_t usb_out_pointer;
113 uint8_t usb_kbd_buffer[USB_KBD_BUFFER_LEN];
114
Allen Martind7475382012-10-24 08:32:04 +0000115 uint8_t *new;
Adrian Cox08a98b82014-04-10 14:02:44 +0100116 uint8_t old[USB_KBD_BOOT_REPORT_SIZE];
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100117
118 uint8_t flags;
119};
120
Jim Lin07551f22013-08-13 19:04:22 +0800121extern int __maybe_unused net_busy_flag;
122
123/* The period of time between two calls of usb_kbd_testc(). */
Thomas Watson96991e62022-02-10 15:13:14 -0600124static unsigned long kbd_testc_tms;
Jim Lin07551f22013-08-13 19:04:22 +0800125
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100126/* Puts character in the queue and sets up the in and out pointer. */
Heinrich Schuchardt28dfa7d2019-11-23 18:15:19 +0100127static void usb_kbd_put_queue(struct usb_kbd_pdata *data, u8 c)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100128{
129 if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) {
130 /* Check for buffer full. */
131 if (data->usb_out_pointer == 0)
132 return;
133
134 data->usb_in_pointer = 0;
135 } else {
136 /* Check for buffer full. */
137 if (data->usb_in_pointer == data->usb_out_pointer - 1)
138 return;
139
140 data->usb_in_pointer++;
141 }
142
143 data->usb_kbd_buffer[data->usb_in_pointer] = c;
144}
145
146/*
147 * Set the LEDs. Since this is used in the irq routine, the control job is
148 * issued with a timeout of 0. This means, that the job is queued without
149 * waiting for job completion.
150 */
151static void usb_kbd_setled(struct usb_device *dev)
152{
153 struct usb_interface *iface = &dev->config.if_desc[0];
154 struct usb_kbd_pdata *data = dev->privptr;
Hans de Goede9b239382014-09-20 16:51:26 +0200155 ALLOC_ALIGN_BUFFER(uint32_t, leds, 1, USB_DMA_MINALIGN);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100156
Hans de Goede9b239382014-09-20 16:51:26 +0200157 *leds = data->flags & USB_KBD_LEDMASK;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100158 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
159 USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Hans de Goede9b239382014-09-20 16:51:26 +0200160 0x200, iface->desc.bInterfaceNumber, leds, 1, 0);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100161}
162
163#define CAPITAL_MASK 0x20
164/* Translate the scancode in ASCII */
165static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode,
166 unsigned char modifier, int pressed)
167{
168 uint8_t keycode = 0;
169
170 /* Key released */
171 if (pressed == 0) {
172 data->repeat_delay = 0;
173 return 0;
174 }
175
176 if (pressed == 2) {
177 data->repeat_delay++;
178 if (data->repeat_delay < REPEAT_DELAY)
179 return 0;
180
181 data->repeat_delay = REPEAT_DELAY;
182 }
183
184 /* Alphanumeric values */
185 if ((scancode > 3) && (scancode <= 0x1d)) {
186 keycode = scancode - 4 + 'a';
187
188 if (data->flags & USB_KBD_CAPSLOCK)
189 keycode &= ~CAPITAL_MASK;
190
191 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) {
192 /* Handle CAPSLock + Shift pressed simultaneously */
193 if (keycode & CAPITAL_MASK)
194 keycode &= ~CAPITAL_MASK;
195 else
196 keycode |= CAPITAL_MASK;
197 }
198 }
199
Marek Vasutbdbcbe72016-01-25 22:00:44 +0100200 if ((scancode > 0x1d) && (scancode < 0x39)) {
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100201 /* Shift pressed */
202 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT))
203 keycode = usb_kbd_numkey_shifted[scancode - 0x1e];
204 else
205 keycode = usb_kbd_numkey[scancode - 0x1e];
206 }
207
Vincent Palatind53da842012-01-09 12:59:36 +0000208 /* Numeric keypad */
209 if ((scancode >= 0x54) && (scancode <= 0x67))
210 keycode = usb_kbd_num_keypad[scancode - 0x54];
211
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100212 if (data->flags & USB_KBD_CTRL)
213 keycode = scancode - 0x3;
214
215 if (pressed == 1) {
216 if (scancode == NUM_LOCK) {
217 data->flags ^= USB_KBD_NUMLOCK;
218 return 1;
219 }
220
221 if (scancode == CAPS_LOCK) {
222 data->flags ^= USB_KBD_CAPSLOCK;
223 return 1;
224 }
225 if (scancode == SCROLL_LOCK) {
226 data->flags ^= USB_KBD_SCROLLLOCK;
227 return 1;
228 }
229 }
230
231 /* Report keycode if any */
Heinrich Schuchardt3352c212019-11-23 18:15:20 +0100232 if (keycode) {
Vivek Gautamceb49722013-04-12 16:34:33 +0530233 debug("%c", keycode);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100234 usb_kbd_put_queue(data, keycode);
Heinrich Schuchardt3352c212019-11-23 18:15:20 +0100235 return 0;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100236 }
237
Heinrich Schuchardt87e91bc2019-11-23 18:15:21 +0100238#ifdef CONFIG_USB_KEYBOARD_FN_KEYS
239 if (scancode < 0x3a || scancode > 0x52 ||
240 scancode == 0x46 || scancode == 0x47)
241 return 1;
242
243 usb_kbd_put_queue(data, 0x1b);
244 if (scancode < 0x3e) {
245 /* F1 - F4 */
246 usb_kbd_put_queue(data, 0x4f);
247 usb_kbd_put_queue(data, scancode - 0x3a + 'P');
248 return 0;
249 }
250 usb_kbd_put_queue(data, '[');
251 if (scancode < 0x42) {
252 /* F5 - F8 */
253 usb_kbd_put_queue(data, '1');
254 if (scancode == 0x3e)
255 --scancode;
256 keycode = scancode - 0x3f + '7';
257 } else if (scancode < 0x49) {
258 /* F9 - F12 */
259 usb_kbd_put_queue(data, '2');
260 if (scancode > 0x43)
261 ++scancode;
262 keycode = scancode - 0x42 + '0';
263 } else {
264 /*
265 * INSERT, HOME, PAGE UP, DELETE, END, PAGE DOWN,
266 * RIGHT, LEFT, DOWN, UP
267 */
268 keycode = usb_special_keys[scancode - 0x49];
269 }
270 usb_kbd_put_queue(data, keycode);
271 if (scancode < 0x4f && scancode != 0x4a && scancode != 0x4d)
272 usb_kbd_put_queue(data, '~');
273 return 0;
274#else
Heinrich Schuchardt3352c212019-11-23 18:15:20 +0100275 /* Left, Right, Up, Down */
276 if (scancode > 0x4e && scancode < 0x53) {
277 usb_kbd_put_queue(data, 0x1b);
278 usb_kbd_put_queue(data, '[');
279 usb_kbd_put_queue(data, usb_special_keys[scancode - 0x4f]);
280 return 0;
281 }
282 return 1;
Heinrich Schuchardt87e91bc2019-11-23 18:15:21 +0100283#endif /* CONFIG_USB_KEYBOARD_FN_KEYS */
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100284}
285
286static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up)
287{
288 uint32_t res = 0;
289 struct usb_kbd_pdata *data = dev->privptr;
290 uint8_t *new;
291 uint8_t *old;
292
293 if (up) {
294 new = data->old;
295 old = data->new;
296 } else {
297 new = data->new;
298 old = data->old;
299 }
300
Adrian Cox08a98b82014-04-10 14:02:44 +0100301 if ((old[i] > 3) &&
302 (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) ==
303 new + USB_KBD_BOOT_REPORT_SIZE)) {
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100304 res |= usb_kbd_translate(data, old[i], data->new[0], up);
Adrian Cox08a98b82014-04-10 14:02:44 +0100305 }
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100306
307 return res;
308}
309
310/* Interrupt service routine */
311static int usb_kbd_irq_worker(struct usb_device *dev)
312{
313 struct usb_kbd_pdata *data = dev->privptr;
314 int i, res = 0;
315
316 /* No combo key pressed */
317 if (data->new[0] == 0x00)
318 data->flags &= ~USB_KBD_CTRL;
319 /* Left or Right Ctrl pressed */
320 else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR))
321 data->flags |= USB_KBD_CTRL;
322
Adrian Cox08a98b82014-04-10 14:02:44 +0100323 for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) {
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100324 res |= usb_kbd_service_key(dev, i, 0);
325 res |= usb_kbd_service_key(dev, i, 1);
326 }
327
328 /* Key is still pressed */
329 if ((data->new[2] > 3) && (data->old[2] == data->new[2]))
330 res |= usb_kbd_translate(data, data->new[2], data->new[0], 2);
331
332 if (res == 1)
333 usb_kbd_setled(dev);
334
Adrian Cox08a98b82014-04-10 14:02:44 +0100335 memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100336
337 return 1;
338}
339
340/* Keyboard interrupt handler */
341static int usb_kbd_irq(struct usb_device *dev)
342{
Adrian Cox08a98b82014-04-10 14:02:44 +0100343 if ((dev->irq_status != 0) ||
344 (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) {
Vivek Gautamceb49722013-04-12 16:34:33 +0530345 debug("USB KBD: Error %lX, len %d\n",
346 dev->irq_status, dev->irq_act_len);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100347 return 1;
348 }
349
350 return usb_kbd_irq_worker(dev);
351}
352
353/* Interrupt polling */
Marek Vasut48c80732011-09-25 20:00:37 +0100354static inline void usb_kbd_poll_for_event(struct usb_device *dev)
355{
Hans de Goede8454c842015-05-19 22:51:03 +0200356#if defined(CONFIG_SYS_USB_EVENT_POLL)
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200357 struct usb_kbd_pdata *data = dev->privptr;
amartin@nvidia.comf9636e82011-12-20 14:56:16 +0000358
Heinrich Schuchardt216db3a2019-11-23 18:15:18 +0100359 /* Submit an interrupt transfer request */
Michal Suchanekfdd135b2019-08-18 10:55:25 +0200360 if (usb_int_msg(dev, data->intpipe, &data->new[0],
Michal Suchanek34371212019-08-18 10:55:27 +0200361 data->intpktsize, data->intinterval, true) >= 0)
Michal Suchanek3e816a22019-08-18 10:55:24 +0200362 usb_kbd_irq_worker(dev);
Hans de Goede8454c842015-05-19 22:51:03 +0200363#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) || \
364 defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
365#if defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
Marek Vasut48c80732011-09-25 20:00:37 +0100366 struct usb_interface *iface;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100367 struct usb_kbd_pdata *data = dev->privptr;
Marek Vasut48c80732011-09-25 20:00:37 +0100368 iface = &dev->config.if_desc[0];
369 usb_get_report(dev, iface->desc.bInterfaceNumber,
Adrian Cox08a98b82014-04-10 14:02:44 +0100370 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE);
Hans de Goede8454c842015-05-19 22:51:03 +0200371 if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE)) {
Marek Vasut48c80732011-09-25 20:00:37 +0100372 usb_kbd_irq_worker(dev);
Hans de Goede8454c842015-05-19 22:51:03 +0200373#else
Hans de Goede8e553112014-09-24 14:06:11 +0200374 struct usb_kbd_pdata *data = dev->privptr;
375 if (poll_int_queue(dev, data->intq)) {
376 usb_kbd_irq_worker(dev);
377 /* We've consumed all queued int packets, create new */
378 destroy_int_queue(dev, data->intq);
379 data->intq = create_int_queue(dev, data->intpipe, 1,
Hans de Goede8bb6c1d2015-01-11 20:38:28 +0100380 USB_KBD_BOOT_REPORT_SIZE, data->new,
381 data->intinterval);
Hans de Goede8454c842015-05-19 22:51:03 +0200382#endif
383 data->last_report = get_timer(0);
384 /* Repeat last usb hid report every REPEAT_RATE ms for keyrepeat */
385 } else if (data->last_report != -1 &&
386 get_timer(data->last_report) > REPEAT_RATE) {
387 usb_kbd_irq_worker(dev);
388 data->last_report = get_timer(0);
Hans de Goede8e553112014-09-24 14:06:11 +0200389 }
Marek Vasut48c80732011-09-25 20:00:37 +0100390#endif
391}
392
wdenkaffae2b2002-08-17 09:36:01 +0000393/* test if a character is in the queue */
Simon Glass709ea542014-07-23 06:54:59 -0600394static int usb_kbd_testc(struct stdio_dev *sdev)
wdenkaffae2b2002-08-17 09:36:01 +0000395{
Marek Vasut48c80732011-09-25 20:00:37 +0100396 struct stdio_dev *dev;
397 struct usb_device *usb_kbd_dev;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100398 struct usb_kbd_pdata *data;
Marek Vasut48c80732011-09-25 20:00:37 +0100399
Thomas Watson96991e62022-02-10 15:13:14 -0600400 /*
401 * Polling the keyboard for an event can take dozens of milliseconds.
402 * Add a delay between polls to avoid blocking activity which polls
403 * rapidly, like the UEFI console timer.
404 */
405 unsigned long poll_delay = CONFIG_SYS_HZ / 50;
406
Jim Linc95e2b92013-08-26 20:21:09 +0800407#ifdef CONFIG_CMD_NET
408 /*
409 * If net_busy_flag is 1, NET transfer is running,
410 * then we check key-pressed every second (first check may be
411 * less than 1 second) to improve TFTP booting performance.
412 */
Thomas Watson96991e62022-02-10 15:13:14 -0600413 if (net_busy_flag)
414 poll_delay = CONFIG_SYS_HZ;
Jim Linc95e2b92013-08-26 20:21:09 +0800415#endif
Thomas Watson96991e62022-02-10 15:13:14 -0600416
417#ifdef CONFIG_SANDBOX
418 /*
419 * Skip delaying polls if a test requests it.
420 */
421 if (state_get_skip_delays())
422 poll_delay = 0;
423#endif
424
Michal Simek4fb67f42018-06-27 14:35:07 +0200425 dev = stdio_get_by_name(sdev->name);
Marek Vasut48c80732011-09-25 20:00:37 +0100426 usb_kbd_dev = (struct usb_device *)dev->priv;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100427 data = usb_kbd_dev->privptr;
Marek Vasut48c80732011-09-25 20:00:37 +0100428
Thomas Watson96991e62022-02-10 15:13:14 -0600429 if (get_timer(kbd_testc_tms) >= poll_delay) {
430 usb_kbd_poll_for_event(usb_kbd_dev);
431 kbd_testc_tms = get_timer(0);
432 }
Marek Vasut48c80732011-09-25 20:00:37 +0100433
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100434 return !(data->usb_in_pointer == data->usb_out_pointer);
wdenkaffae2b2002-08-17 09:36:01 +0000435}
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100436
wdenkaffae2b2002-08-17 09:36:01 +0000437/* gets the character from the queue */
Simon Glass709ea542014-07-23 06:54:59 -0600438static int usb_kbd_getc(struct stdio_dev *sdev)
wdenkaffae2b2002-08-17 09:36:01 +0000439{
Marek Vasut48c80732011-09-25 20:00:37 +0100440 struct stdio_dev *dev;
441 struct usb_device *usb_kbd_dev;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100442 struct usb_kbd_pdata *data;
Marek Vasut48c80732011-09-25 20:00:37 +0100443
Michal Simek4fb67f42018-06-27 14:35:07 +0200444 dev = stdio_get_by_name(sdev->name);
Marek Vasut48c80732011-09-25 20:00:37 +0100445 usb_kbd_dev = (struct usb_device *)dev->priv;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100446 data = usb_kbd_dev->privptr;
Marek Vasut48c80732011-09-25 20:00:37 +0100447
Michal Simekf8f3e0e2018-06-27 14:16:54 +0200448 while (data->usb_in_pointer == data->usb_out_pointer) {
449 WATCHDOG_RESET();
Marek Vasut48c80732011-09-25 20:00:37 +0100450 usb_kbd_poll_for_event(usb_kbd_dev);
Michal Simekf8f3e0e2018-06-27 14:16:54 +0200451 }
Marek Vasut48c80732011-09-25 20:00:37 +0100452
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100453 if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1)
454 data->usb_out_pointer = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000455 else
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100456 data->usb_out_pointer++;
wdenkaffae2b2002-08-17 09:36:01 +0000457
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100458 return data->usb_kbd_buffer[data->usb_out_pointer];
wdenkaffae2b2002-08-17 09:36:01 +0000459}
460
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100461/* probes the USB device dev for keyboard type. */
Simon Glass34ab37e2015-09-08 11:15:11 -0600462static int usb_kbd_probe_dev(struct usb_device *dev, unsigned int ifnum)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100463{
464 struct usb_interface *iface;
465 struct usb_endpoint_descriptor *ep;
466 struct usb_kbd_pdata *data;
Stefan Brünsba0b9842021-02-20 17:26:06 +0100467 int epNum;
wdenkaffae2b2002-08-17 09:36:01 +0000468
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100469 if (dev->descriptor.bNumConfigurations != 1)
470 return 0;
471
472 iface = &dev->config.if_desc[ifnum];
473
Simon Glass2cdb58e2015-11-08 23:48:04 -0700474 if (iface->desc.bInterfaceClass != USB_CLASS_HID)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100475 return 0;
476
Simon Glass2cdb58e2015-11-08 23:48:04 -0700477 if (iface->desc.bInterfaceSubClass != USB_SUB_HID_BOOT)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100478 return 0;
479
Simon Glass2cdb58e2015-11-08 23:48:04 -0700480 if (iface->desc.bInterfaceProtocol != USB_PROT_HID_KEYBOARD)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100481 return 0;
482
Stefan Brünsba0b9842021-02-20 17:26:06 +0100483 for (epNum = 0; epNum < iface->desc.bNumEndpoints; epNum++) {
484 ep = &iface->ep_desc[epNum];
485
486 /* Check if endpoint is interrupt IN endpoint */
487 if ((ep->bmAttributes & 3) != 3)
488 continue;
489
490 if (ep->bEndpointAddress & 0x80)
491 break;
492 }
493
494 if (epNum == iface->desc.bNumEndpoints)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100495 return 0;
496
Stefan Brünsba0b9842021-02-20 17:26:06 +0100497 debug("USB KBD: found interrupt EP: 0x%x\n", ep->bEndpointAddress);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100498
499 data = malloc(sizeof(struct usb_kbd_pdata));
500 if (!data) {
501 printf("USB KBD: Error allocating private data\n");
502 return 0;
503 }
504
505 /* Clear private data */
506 memset(data, 0, sizeof(struct usb_kbd_pdata));
507
Allen Martind7475382012-10-24 08:32:04 +0000508 /* allocate input buffer aligned and sized to USB DMA alignment */
Adrian Cox08a98b82014-04-10 14:02:44 +0100509 data->new = memalign(USB_DMA_MINALIGN,
510 roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN));
Allen Martind7475382012-10-24 08:32:04 +0000511
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100512 /* Insert private data into USB device structure */
513 dev->privptr = data;
514
515 /* Set IRQ handler */
516 dev->irq_handle = usb_kbd_irq;
517
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200518 data->intpipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
519 data->intpktsize = min(usb_maxpacket(dev, data->intpipe),
520 USB_KBD_BOOT_REPORT_SIZE);
521 data->intinterval = ep->bInterval;
Hans de Goede8454c842015-05-19 22:51:03 +0200522 data->last_report = -1;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100523
524 /* We found a USB Keyboard, install it. */
Stefan Brünsba0b9842021-02-20 17:26:06 +0100525 debug("USB KBD: set boot protocol\n");
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100526 usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);
527
Hans de Goede8454c842015-05-19 22:51:03 +0200528#if !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) && \
529 !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
Stefan Brünsba0b9842021-02-20 17:26:06 +0100530 debug("USB KBD: set idle interval...\n");
Hans de Goede8454c842015-05-19 22:51:03 +0200531 usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE / 4, 0);
Hans de Goedede451492015-06-18 22:34:34 +0200532#else
Stefan Brünsba0b9842021-02-20 17:26:06 +0100533 debug("USB KBD: set idle interval=0...\n");
Hans de Goedede451492015-06-18 22:34:34 +0200534 usb_set_idle(dev, iface->desc.bInterfaceNumber, 0, 0);
Hans de Goede8454c842015-05-19 22:51:03 +0200535#endif
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100536
Vivek Gautamceb49722013-04-12 16:34:33 +0530537 debug("USB KBD: enable interrupt pipe...\n");
Hans de Goede8e553112014-09-24 14:06:11 +0200538#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
539 data->intq = create_int_queue(dev, data->intpipe, 1,
Hans de Goede8bb6c1d2015-01-11 20:38:28 +0100540 USB_KBD_BOOT_REPORT_SIZE, data->new,
541 data->intinterval);
Hans de Goede8e553112014-09-24 14:06:11 +0200542 if (!data->intq) {
Stephen Warrene4b70d82015-11-13 13:34:09 -0700543#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
544 if (usb_get_report(dev, iface->desc.bInterfaceNumber,
545 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE) < 0) {
Hans de Goede8e553112014-09-24 14:06:11 +0200546#else
Michal Suchanekfdd135b2019-08-18 10:55:25 +0200547 if (usb_int_msg(dev, data->intpipe, data->new, data->intpktsize,
Michal Suchanek34371212019-08-18 10:55:27 +0200548 data->intinterval, false) < 0) {
Hans de Goede8e553112014-09-24 14:06:11 +0200549#endif
Vincent Palatin5da2dc92013-05-10 19:48:59 -0700550 printf("Failed to get keyboard state from device %04x:%04x\n",
551 dev->descriptor.idVendor, dev->descriptor.idProduct);
552 /* Abort, we don't want to use that non-functional keyboard. */
553 return 0;
554 }
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100555
556 /* Success. */
557 return 1;
558}
559
Simon Glass603afaf2015-03-25 12:22:33 -0600560static int probe_usb_keyboard(struct usb_device *dev)
561{
562 char *stdinname;
563 struct stdio_dev usb_kbd_dev;
564 int error;
565
566 /* Try probing the keyboard */
Simon Glass34ab37e2015-09-08 11:15:11 -0600567 if (usb_kbd_probe_dev(dev, 0) != 1)
Simon Glass603afaf2015-03-25 12:22:33 -0600568 return -ENOENT;
569
570 /* Register the keyboard */
571 debug("USB KBD: register.\n");
572 memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
573 strcpy(usb_kbd_dev.name, DEVNAME);
Bin Meng1caf9342015-11-03 23:23:37 -0800574 usb_kbd_dev.flags = DEV_FLAGS_INPUT;
Simon Glass603afaf2015-03-25 12:22:33 -0600575 usb_kbd_dev.getc = usb_kbd_getc;
576 usb_kbd_dev.tstc = usb_kbd_testc;
577 usb_kbd_dev.priv = (void *)dev;
578 error = stdio_register(&usb_kbd_dev);
579 if (error)
580 return error;
581
Simon Glass00caae62017-08-03 12:22:12 -0600582 stdinname = env_get("stdin");
Simon Glassb0265422017-01-16 07:03:26 -0700583#if CONFIG_IS_ENABLED(CONSOLE_MUX)
Kory Maincent98ac7852022-06-22 10:59:31 +0200584 if (strstr(stdinname, DEVNAME) != NULL) {
585 error = iomux_doenv(stdin, stdinname);
586 if (error)
587 return error;
588 }
Simon Glass603afaf2015-03-25 12:22:33 -0600589#else
590 /* Check if this is the standard input device. */
Kory Maincent98ac7852022-06-22 10:59:31 +0200591 if (!strcmp(stdinname, DEVNAME)) {
592 /* Reassign the console */
593 if (overwrite_console())
594 return 1;
Simon Glass603afaf2015-03-25 12:22:33 -0600595
Kory Maincent98ac7852022-06-22 10:59:31 +0200596 error = console_assign(stdin, DEVNAME);
597 if (error)
598 return error;
599 }
Simon Glass603afaf2015-03-25 12:22:33 -0600600#endif
601
602 return 0;
603}
604
Sven Schwermerfd09c202018-11-21 08:43:56 +0100605#if !CONFIG_IS_ENABLED(DM_USB)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100606/* Search for keyboard and register it if found. */
wdenkaffae2b2002-08-17 09:36:01 +0000607int drv_usb_kbd_init(void)
608{
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100609 int error, i;
wdenkaffae2b2002-08-17 09:36:01 +0000610
Simon Glass697033c2015-03-25 12:22:34 -0600611 debug("%s: Probing for keyboard\n", __func__);
Simon Glass697033c2015-03-25 12:22:34 -0600612 /* Scan all USB Devices */
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100613 for (i = 0; i < USB_MAX_DEVICE; i++) {
Simon Glass603afaf2015-03-25 12:22:33 -0600614 struct usb_device *dev;
615
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100616 /* Get USB device. */
617 dev = usb_get_dev_index(i);
618 if (!dev)
Simon Glass603afaf2015-03-25 12:22:33 -0600619 break;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100620
621 if (dev->devnum == -1)
622 continue;
623
Simon Glass603afaf2015-03-25 12:22:33 -0600624 error = probe_usb_keyboard(dev);
625 if (!error)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100626 return 1;
Simon Glass603afaf2015-03-25 12:22:33 -0600627 if (error && error != -ENOENT)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100628 return error;
wdenkaffae2b2002-08-17 09:36:01 +0000629 }
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100630
631 /* No USB Keyboard found */
wdenkaffae2b2002-08-17 09:36:01 +0000632 return -1;
633}
634
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100635/* Deregister the keyboard. */
Hans de Goede8a8a2252014-09-20 16:54:38 +0200636int usb_kbd_deregister(int force)
wdenkaffae2b2002-08-17 09:36:01 +0000637{
Simon Glass869588d2016-10-17 20:13:02 -0600638#if CONFIG_IS_ENABLED(SYS_STDIO_DEREGISTER)
Hans de Goededfe5b1c2014-09-24 14:06:08 +0200639 struct stdio_dev *dev;
640 struct usb_device *usb_kbd_dev;
641 struct usb_kbd_pdata *data;
642
643 dev = stdio_get_by_name(DEVNAME);
644 if (dev) {
645 usb_kbd_dev = (struct usb_device *)dev->priv;
646 data = usb_kbd_dev->privptr;
Simon Glassb0265422017-01-16 07:03:26 -0700647#if CONFIG_IS_ENABLED(CONSOLE_MUX)
Andy Shevchenkoeb5fd9e2021-02-11 17:09:44 +0200648 if (iomux_replace_device(stdin, DEVNAME, force ? "nulldev" : ""))
Hans de Goede3cbcb282015-01-11 20:34:44 +0100649 return 1;
650#endif
Andy Shevchenkoeb5fd9e2021-02-11 17:09:44 +0200651 if (stdio_deregister_dev(dev, force) != 0)
652 return 1;
Hans de Goede8e553112014-09-24 14:06:11 +0200653#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
654 destroy_int_queue(usb_kbd_dev, data->intq);
655#endif
Hans de Goededfe5b1c2014-09-24 14:06:08 +0200656 free(data->new);
657 free(data);
658 }
Hans de Goede0ea09df2014-09-20 16:54:34 +0200659
660 return 0;
Jean-Christophe PLAGNIOL-VILLARDfea91ed2008-12-02 21:58:04 +0100661#else
662 return 1;
663#endif
wdenkaffae2b2002-08-17 09:36:01 +0000664}
Simon Glass34ab37e2015-09-08 11:15:11 -0600665
Hans de Goede9a80e712016-04-03 09:18:53 +0200666#endif
667
Sven Schwermerfd09c202018-11-21 08:43:56 +0100668#if CONFIG_IS_ENABLED(DM_USB)
Simon Glass34ab37e2015-09-08 11:15:11 -0600669
670static int usb_kbd_probe(struct udevice *dev)
671{
672 struct usb_device *udev = dev_get_parent_priv(dev);
Simon Glass34ab37e2015-09-08 11:15:11 -0600673
Masahiro Yamada8319aeb2016-09-06 22:17:35 +0900674 return probe_usb_keyboard(udev);
Simon Glass34ab37e2015-09-08 11:15:11 -0600675}
676
Simon Glass8a834872016-01-03 13:50:31 -0700677static int usb_kbd_remove(struct udevice *dev)
678{
679 struct usb_device *udev = dev_get_parent_priv(dev);
680 struct usb_kbd_pdata *data;
681 struct stdio_dev *sdev;
682 int ret;
683
684 sdev = stdio_get_by_name(DEVNAME);
685 if (!sdev) {
686 ret = -ENXIO;
687 goto err;
688 }
689 data = udev->privptr;
Simon Glassb0265422017-01-16 07:03:26 -0700690#if CONFIG_IS_ENABLED(CONSOLE_MUX)
Andy Shevchenkoeb5fd9e2021-02-11 17:09:44 +0200691 if (iomux_replace_device(stdin, DEVNAME, "nulldev")) {
Simon Glass8a834872016-01-03 13:50:31 -0700692 ret = -ENOLINK;
693 goto err;
694 }
695#endif
Andy Shevchenkoeb5fd9e2021-02-11 17:09:44 +0200696 if (stdio_deregister_dev(sdev, true)) {
697 ret = -EPERM;
698 goto err;
699 }
Simon Glass8a834872016-01-03 13:50:31 -0700700#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
701 destroy_int_queue(udev, data->intq);
702#endif
703 free(data->new);
704 free(data);
705
706 return 0;
707err:
708 printf("%s: warning, ret=%d", __func__, ret);
709 return ret;
710}
711
Simon Glass34ab37e2015-09-08 11:15:11 -0600712static const struct udevice_id usb_kbd_ids[] = {
713 { .compatible = "usb-keyboard" },
714 { }
715};
716
717U_BOOT_DRIVER(usb_kbd) = {
718 .name = "usb_kbd",
719 .id = UCLASS_KEYBOARD,
720 .of_match = usb_kbd_ids,
721 .probe = usb_kbd_probe,
Simon Glass8a834872016-01-03 13:50:31 -0700722 .remove = usb_kbd_remove,
Simon Glass34ab37e2015-09-08 11:15:11 -0600723};
724
Simon Glass34ab37e2015-09-08 11:15:11 -0600725static const struct usb_device_id kbd_id_table[] = {
726 {
727 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
728 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
729 USB_DEVICE_ID_MATCH_INT_PROTOCOL,
730 .bInterfaceClass = USB_CLASS_HID,
Simon Glass2cdb58e2015-11-08 23:48:04 -0700731 .bInterfaceSubClass = USB_SUB_HID_BOOT,
732 .bInterfaceProtocol = USB_PROT_HID_KEYBOARD,
Simon Glass34ab37e2015-09-08 11:15:11 -0600733 },
734 { } /* Terminating entry */
735};
736
737U_BOOT_USB_DEVICE(usb_kbd, kbd_id_table);
738
739#endif