3 * Denis Peter, MPL AG Switzerland
5 * Part of this source has been derived from the Linux USB
8 * SPDX-License-Identifier: GPL-2.0+
13 #include <stdio_dev.h>
14 #include <asm/byteorder.h>
19 * If overwrite_console returns 1, the stdin, stderr and stdout
20 * are switched to the serial port, else the settings in the
21 * environment are used
23 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
24 extern int overwrite_console(void);
26 int overwrite_console(void)
32 /* Keyboard sampling rate */
33 #define REPEAT_RATE (40 / 4) /* 40msec -> 25cps */
34 #define REPEAT_DELAY 10 /* 10 x REPEAT_RATE = 400msec */
37 #define CAPS_LOCK 0x39
38 #define SCROLL_LOCK 0x47
41 #define LEFT_CNTR (1 << 0)
42 #define LEFT_SHIFT (1 << 1)
43 #define LEFT_ALT (1 << 2)
44 #define LEFT_GUI (1 << 3)
45 #define RIGHT_CNTR (1 << 4)
46 #define RIGHT_SHIFT (1 << 5)
47 #define RIGHT_ALT (1 << 6)
48 #define RIGHT_GUI (1 << 7)
50 /* Size of the keyboard buffer */
51 #define USB_KBD_BUFFER_LEN 0x20
54 #define DEVNAME "usbkbd"
57 static const unsigned char usb_kbd_numkey[] = {
58 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
59 '\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']',
60 '\\', '#', ';', '\'', '`', ',', '.', '/'
62 static const unsigned char usb_kbd_numkey_shifted[] = {
63 '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
64 '\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}',
65 '|', '~', ':', '"', '~', '<', '>', '?'
68 static const unsigned char usb_kbd_num_keypad[] = {
69 '/', '*', '-', '+', '\r',
70 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
75 * map arrow keys to ^F/^B ^N/^P, can't really use the proper
76 * ANSI sequence for arrow keys because the queuing code breaks
77 * when a single keypress expands to 3 queue elements
79 static const unsigned char usb_kbd_arrow[] = {
84 * NOTE: It's important for the NUM, CAPS, SCROLL-lock bits to be in this
85 * order. See usb_kbd_setled() function!
87 #define USB_KBD_NUMLOCK (1 << 0)
88 #define USB_KBD_CAPSLOCK (1 << 1)
89 #define USB_KBD_SCROLLLOCK (1 << 2)
90 #define USB_KBD_CTRL (1 << 3)
92 #define USB_KBD_LEDMASK \
93 (USB_KBD_NUMLOCK | USB_KBD_CAPSLOCK | USB_KBD_SCROLLLOCK)
96 * USB Keyboard reports are 8 bytes in boot protocol.
97 * Appendix B of HID Device Class Definition 1.11
99 #define USB_KBD_BOOT_REPORT_SIZE 8
101 struct usb_kbd_pdata {
102 unsigned long intpipe;
106 uint32_t repeat_delay;
108 uint32_t usb_in_pointer;
109 uint32_t usb_out_pointer;
110 uint8_t usb_kbd_buffer[USB_KBD_BUFFER_LEN];
113 uint8_t old[USB_KBD_BOOT_REPORT_SIZE];
118 extern int __maybe_unused net_busy_flag;
120 /* The period of time between two calls of usb_kbd_testc(). */
121 static unsigned long __maybe_unused kbd_testc_tms;
123 /* Puts character in the queue and sets up the in and out pointer. */
124 static void usb_kbd_put_queue(struct usb_kbd_pdata *data, char c)
126 if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) {
127 /* Check for buffer full. */
128 if (data->usb_out_pointer == 0)
131 data->usb_in_pointer = 0;
133 /* Check for buffer full. */
134 if (data->usb_in_pointer == data->usb_out_pointer - 1)
137 data->usb_in_pointer++;
140 data->usb_kbd_buffer[data->usb_in_pointer] = c;
144 * Set the LEDs. Since this is used in the irq routine, the control job is
145 * issued with a timeout of 0. This means, that the job is queued without
146 * waiting for job completion.
148 static void usb_kbd_setled(struct usb_device *dev)
150 struct usb_interface *iface = &dev->config.if_desc[0];
151 struct usb_kbd_pdata *data = dev->privptr;
152 ALLOC_ALIGN_BUFFER(uint32_t, leds, 1, USB_DMA_MINALIGN);
154 *leds = data->flags & USB_KBD_LEDMASK;
155 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
156 USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
157 0x200, iface->desc.bInterfaceNumber, leds, 1, 0);
160 #define CAPITAL_MASK 0x20
161 /* Translate the scancode in ASCII */
162 static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode,
163 unsigned char modifier, int pressed)
169 data->repeat_delay = 0;
174 data->repeat_delay++;
175 if (data->repeat_delay < REPEAT_DELAY)
178 data->repeat_delay = REPEAT_DELAY;
181 /* Alphanumeric values */
182 if ((scancode > 3) && (scancode <= 0x1d)) {
183 keycode = scancode - 4 + 'a';
185 if (data->flags & USB_KBD_CAPSLOCK)
186 keycode &= ~CAPITAL_MASK;
188 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) {
189 /* Handle CAPSLock + Shift pressed simultaneously */
190 if (keycode & CAPITAL_MASK)
191 keycode &= ~CAPITAL_MASK;
193 keycode |= CAPITAL_MASK;
197 if ((scancode > 0x1d) && (scancode < 0x3a)) {
199 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT))
200 keycode = usb_kbd_numkey_shifted[scancode - 0x1e];
202 keycode = usb_kbd_numkey[scancode - 0x1e];
206 if ((scancode >= 0x4f) && (scancode <= 0x52))
207 keycode = usb_kbd_arrow[scancode - 0x4f];
210 if ((scancode >= 0x54) && (scancode <= 0x67))
211 keycode = usb_kbd_num_keypad[scancode - 0x54];
213 if (data->flags & USB_KBD_CTRL)
214 keycode = scancode - 0x3;
217 if (scancode == NUM_LOCK) {
218 data->flags ^= USB_KBD_NUMLOCK;
222 if (scancode == CAPS_LOCK) {
223 data->flags ^= USB_KBD_CAPSLOCK;
226 if (scancode == SCROLL_LOCK) {
227 data->flags ^= USB_KBD_SCROLLLOCK;
232 /* Report keycode if any */
234 debug("%c", keycode);
235 usb_kbd_put_queue(data, keycode);
241 static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up)
244 struct usb_kbd_pdata *data = dev->privptr;
257 (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) ==
258 new + USB_KBD_BOOT_REPORT_SIZE)) {
259 res |= usb_kbd_translate(data, old[i], data->new[0], up);
265 /* Interrupt service routine */
266 static int usb_kbd_irq_worker(struct usb_device *dev)
268 struct usb_kbd_pdata *data = dev->privptr;
271 /* No combo key pressed */
272 if (data->new[0] == 0x00)
273 data->flags &= ~USB_KBD_CTRL;
274 /* Left or Right Ctrl pressed */
275 else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR))
276 data->flags |= USB_KBD_CTRL;
278 for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) {
279 res |= usb_kbd_service_key(dev, i, 0);
280 res |= usb_kbd_service_key(dev, i, 1);
283 /* Key is still pressed */
284 if ((data->new[2] > 3) && (data->old[2] == data->new[2]))
285 res |= usb_kbd_translate(data, data->new[2], data->new[0], 2);
290 memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE);
295 /* Keyboard interrupt handler */
296 static int usb_kbd_irq(struct usb_device *dev)
298 if ((dev->irq_status != 0) ||
299 (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) {
300 debug("USB KBD: Error %lX, len %d\n",
301 dev->irq_status, dev->irq_act_len);
305 return usb_kbd_irq_worker(dev);
308 /* Interrupt polling */
309 static inline void usb_kbd_poll_for_event(struct usb_device *dev)
311 #if defined(CONFIG_SYS_USB_EVENT_POLL)
312 struct usb_kbd_pdata *data = dev->privptr;
314 /* Submit a interrupt transfer request */
315 usb_submit_int_msg(dev, data->intpipe, &data->new[0], data->intpktsize,
318 usb_kbd_irq_worker(dev);
319 #elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
320 struct usb_interface *iface;
321 struct usb_kbd_pdata *data = dev->privptr;
322 iface = &dev->config.if_desc[0];
323 usb_get_report(dev, iface->desc.bInterfaceNumber,
324 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE);
325 if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE))
326 usb_kbd_irq_worker(dev);
330 /* test if a character is in the queue */
331 static int usb_kbd_testc(struct stdio_dev *sdev)
333 struct stdio_dev *dev;
334 struct usb_device *usb_kbd_dev;
335 struct usb_kbd_pdata *data;
337 #ifdef CONFIG_CMD_NET
339 * If net_busy_flag is 1, NET transfer is running,
340 * then we check key-pressed every second (first check may be
341 * less than 1 second) to improve TFTP booting performance.
343 if (net_busy_flag && (get_timer(kbd_testc_tms) < CONFIG_SYS_HZ))
345 kbd_testc_tms = get_timer(0);
347 dev = stdio_get_by_name(DEVNAME);
348 usb_kbd_dev = (struct usb_device *)dev->priv;
349 data = usb_kbd_dev->privptr;
351 usb_kbd_poll_for_event(usb_kbd_dev);
353 return !(data->usb_in_pointer == data->usb_out_pointer);
356 /* gets the character from the queue */
357 static int usb_kbd_getc(struct stdio_dev *sdev)
359 struct stdio_dev *dev;
360 struct usb_device *usb_kbd_dev;
361 struct usb_kbd_pdata *data;
363 dev = stdio_get_by_name(DEVNAME);
364 usb_kbd_dev = (struct usb_device *)dev->priv;
365 data = usb_kbd_dev->privptr;
367 while (data->usb_in_pointer == data->usb_out_pointer)
368 usb_kbd_poll_for_event(usb_kbd_dev);
370 if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1)
371 data->usb_out_pointer = 0;
373 data->usb_out_pointer++;
375 return data->usb_kbd_buffer[data->usb_out_pointer];
378 /* probes the USB device dev for keyboard type. */
379 static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
381 struct usb_interface *iface;
382 struct usb_endpoint_descriptor *ep;
383 struct usb_kbd_pdata *data;
385 if (dev->descriptor.bNumConfigurations != 1)
388 iface = &dev->config.if_desc[ifnum];
390 if (iface->desc.bInterfaceClass != 3)
393 if (iface->desc.bInterfaceSubClass != 1)
396 if (iface->desc.bInterfaceProtocol != 1)
399 if (iface->desc.bNumEndpoints != 1)
402 ep = &iface->ep_desc[0];
404 /* Check if endpoint 1 is interrupt endpoint */
405 if (!(ep->bEndpointAddress & 0x80))
408 if ((ep->bmAttributes & 3) != 3)
411 debug("USB KBD: found set protocol...\n");
413 data = malloc(sizeof(struct usb_kbd_pdata));
415 printf("USB KBD: Error allocating private data\n");
419 /* Clear private data */
420 memset(data, 0, sizeof(struct usb_kbd_pdata));
422 /* allocate input buffer aligned and sized to USB DMA alignment */
423 data->new = memalign(USB_DMA_MINALIGN,
424 roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN));
426 /* Insert private data into USB device structure */
429 /* Set IRQ handler */
430 dev->irq_handle = usb_kbd_irq;
432 data->intpipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
433 data->intpktsize = min(usb_maxpacket(dev, data->intpipe),
434 USB_KBD_BOOT_REPORT_SIZE);
435 data->intinterval = ep->bInterval;
437 /* We found a USB Keyboard, install it. */
438 usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);
440 debug("USB KBD: found set idle...\n");
441 usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE, 0);
443 debug("USB KBD: enable interrupt pipe...\n");
444 if (usb_submit_int_msg(dev, data->intpipe, data->new, data->intpktsize,
445 data->intinterval) < 0) {
446 printf("Failed to get keyboard state from device %04x:%04x\n",
447 dev->descriptor.idVendor, dev->descriptor.idProduct);
448 /* Abort, we don't want to use that non-functional keyboard. */
456 /* Search for keyboard and register it if found. */
457 int drv_usb_kbd_init(void)
459 struct stdio_dev usb_kbd_dev;
460 struct usb_device *dev;
461 char *stdinname = getenv("stdin");
464 /* Scan all USB Devices */
465 for (i = 0; i < USB_MAX_DEVICE; i++) {
466 /* Get USB device. */
467 dev = usb_get_dev_index(i);
471 if (dev->devnum == -1)
474 /* Try probing the keyboard */
475 if (usb_kbd_probe(dev, 0) != 1)
478 /* Register the keyboard */
479 debug("USB KBD: register.\n");
480 memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
481 strcpy(usb_kbd_dev.name, DEVNAME);
482 usb_kbd_dev.flags = DEV_FLAGS_INPUT | DEV_FLAGS_SYSTEM;
483 usb_kbd_dev.getc = usb_kbd_getc;
484 usb_kbd_dev.tstc = usb_kbd_testc;
485 usb_kbd_dev.priv = (void *)dev;
486 error = stdio_register(&usb_kbd_dev);
490 #ifdef CONFIG_CONSOLE_MUX
491 error = iomux_doenv(stdin, stdinname);
495 /* Check if this is the standard input device. */
496 if (strcmp(stdinname, DEVNAME))
499 /* Reassign the console */
500 if (overwrite_console())
503 error = console_assign(stdin, DEVNAME);
511 /* No USB Keyboard found */
515 /* Deregister the keyboard. */
516 int usb_kbd_deregister(int force)
518 #ifdef CONFIG_SYS_STDIO_DEREGISTER
519 struct stdio_dev *dev;
520 struct usb_device *usb_kbd_dev;
521 struct usb_kbd_pdata *data;
523 dev = stdio_get_by_name(DEVNAME);
525 usb_kbd_dev = (struct usb_device *)dev->priv;
526 data = usb_kbd_dev->privptr;
527 if (stdio_deregister_dev(dev, force) != 0)