blob: ecc3085cc0811b5471cab07415904221153abf33 [file] [log] [blame]
wdenkaffae2b2002-08-17 09:36:01 +00001/*
2 * (C) Copyright 2001
3 * Denis Peter, MPL AG Switzerland
4 *
5 * Part of this source has been derived from the Linux USB
6 * project.
7 *
Wolfgang Denkd79de1d2013-07-08 09:37:19 +02008 * SPDX-License-Identifier: GPL-2.0+
wdenkaffae2b2002-08-17 09:36:01 +00009 */
10#include <common.h>
Hans de Goedef5656232014-09-20 16:54:34 +020011#include <errno.h>
Marek Vasut7534a3e2011-10-10 16:34:26 +010012#include <malloc.h>
Jean-Christophe PLAGNIOL-VILLARD2a7a0312009-05-16 12:14:54 +020013#include <stdio_dev.h>
Christian Eggers4e0e8d02008-05-21 22:12:00 +020014#include <asm/byteorder.h>
wdenkaffae2b2002-08-17 09:36:01 +000015
wdenkaffae2b2002-08-17 09:36:01 +000016#include <usb.h>
17
wdenkaffae2b2002-08-17 09:36:01 +000018/*
Marek Vasutb9300982011-10-10 05:34:25 +000019 * If overwrite_console returns 1, the stdin, stderr and stdout
wdenkaffae2b2002-08-17 09:36:01 +000020 * are switched to the serial port, else the settings in the
21 * environment are used
22 */
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +020023#ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
Marek Vasutb9300982011-10-10 05:34:25 +000024extern int overwrite_console(void);
wdenkaffae2b2002-08-17 09:36:01 +000025#else
Marek Vasutb9300982011-10-10 05:34:25 +000026int overwrite_console(void)
wdenkaffae2b2002-08-17 09:36:01 +000027{
Marek Vasutb9300982011-10-10 05:34:25 +000028 return 0;
wdenkaffae2b2002-08-17 09:36:01 +000029}
30#endif
31
Marek Vasut7534a3e2011-10-10 16:34:26 +010032/* Keyboard sampling rate */
33#define REPEAT_RATE (40 / 4) /* 40msec -> 25cps */
34#define REPEAT_DELAY 10 /* 10 x REPEAT_RATE = 400msec */
wdenkaffae2b2002-08-17 09:36:01 +000035
36#define NUM_LOCK 0x53
Marek Vasutb9300982011-10-10 05:34:25 +000037#define CAPS_LOCK 0x39
38#define SCROLL_LOCK 0x47
wdenkaffae2b2002-08-17 09:36:01 +000039
wdenkaffae2b2002-08-17 09:36:01 +000040/* Modifier bits */
Marek Vasut7534a3e2011-10-10 16:34:26 +010041#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)
wdenkaffae2b2002-08-17 09:36:01 +000049
Marek Vasut7534a3e2011-10-10 16:34:26 +010050/* Size of the keyboard buffer */
51#define USB_KBD_BUFFER_LEN 0x20
wdenkaffae2b2002-08-17 09:36:01 +000052
Marek Vasut7534a3e2011-10-10 16:34:26 +010053/* Device name */
Marek Vasutb9300982011-10-10 05:34:25 +000054#define DEVNAME "usbkbd"
wdenkaffae2b2002-08-17 09:36:01 +000055
Marek Vasut7534a3e2011-10-10 16:34:26 +010056/* Keyboard maps */
57static const unsigned char usb_kbd_numkey[] = {
Marek Vasutb9300982011-10-10 05:34:25 +000058 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
59 '\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']',
60 '\\', '#', ';', '\'', '`', ',', '.', '/'
wdenkaffae2b2002-08-17 09:36:01 +000061};
Marek Vasut7534a3e2011-10-10 16:34:26 +010062static const unsigned char usb_kbd_numkey_shifted[] = {
Marek Vasutb9300982011-10-10 05:34:25 +000063 '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
64 '\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}',
65 '|', '~', ':', '"', '~', '<', '>', '?'
wdenkaffae2b2002-08-17 09:36:01 +000066};
67
Vincent Palatin92f6a622012-01-09 12:59:36 +000068static const unsigned char usb_kbd_num_keypad[] = {
69 '/', '*', '-', '+', '\r',
70 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
71 '.', 0, 0, 0, '='
72};
73
Marek Vasut7534a3e2011-10-10 16:34:26 +010074/*
Allen Martin1bfb4cd2012-11-06 13:26:03 -080075 * 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
78 */
79static const unsigned char usb_kbd_arrow[] = {
80 0x6, 0x2, 0xe, 0x10
81};
82
83/*
Marek Vasut7534a3e2011-10-10 16:34:26 +010084 * NOTE: It's important for the NUM, CAPS, SCROLL-lock bits to be in this
85 * order. See usb_kbd_setled() function!
86 */
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)
Marek Vasut82cf9a42011-09-25 20:00:37 +010091
Marek Vasut7534a3e2011-10-10 16:34:26 +010092#define USB_KBD_LEDMASK \
93 (USB_KBD_NUMLOCK | USB_KBD_CAPSLOCK | USB_KBD_SCROLLLOCK)
Marek Vasut82cf9a42011-09-25 20:00:37 +010094
Adrian Cox17472dc2014-04-10 14:02:44 +010095/*
96 * USB Keyboard reports are 8 bytes in boot protocol.
97 * Appendix B of HID Device Class Definition 1.11
98 */
99#define USB_KBD_BOOT_REPORT_SIZE 8
100
Marek Vasut7534a3e2011-10-10 16:34:26 +0100101struct usb_kbd_pdata {
Hans de Goede3c794702014-09-24 14:06:10 +0200102 unsigned long intpipe;
103 int intpktsize;
104 int intinterval;
Hans de Goede2d02ae72014-09-24 14:06:11 +0200105 struct int_queue *intq;
Hans de Goede3c794702014-09-24 14:06:10 +0200106
Marek Vasut7534a3e2011-10-10 16:34:26 +0100107 uint32_t repeat_delay;
wdenkaffae2b2002-08-17 09:36:01 +0000108
Marek Vasut7534a3e2011-10-10 16:34:26 +0100109 uint32_t usb_in_pointer;
110 uint32_t usb_out_pointer;
111 uint8_t usb_kbd_buffer[USB_KBD_BUFFER_LEN];
Marek Vasut82cf9a42011-09-25 20:00:37 +0100112
Allen Martinef769ca2012-10-24 08:32:04 +0000113 uint8_t *new;
Adrian Cox17472dc2014-04-10 14:02:44 +0100114 uint8_t old[USB_KBD_BOOT_REPORT_SIZE];
Marek Vasut82cf9a42011-09-25 20:00:37 +0100115
Marek Vasut7534a3e2011-10-10 16:34:26 +0100116 uint8_t flags;
117};
Marek Vasut82cf9a42011-09-25 20:00:37 +0100118
Jim Linc562f972013-08-13 19:04:22 +0800119extern int __maybe_unused net_busy_flag;
120
121/* The period of time between two calls of usb_kbd_testc(). */
122static unsigned long __maybe_unused kbd_testc_tms;
123
Marek Vasut7534a3e2011-10-10 16:34:26 +0100124/* Puts character in the queue and sets up the in and out pointer. */
125static void usb_kbd_put_queue(struct usb_kbd_pdata *data, char c)
wdenkaffae2b2002-08-17 09:36:01 +0000126{
Marek Vasut7534a3e2011-10-10 16:34:26 +0100127 if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) {
128 /* Check for buffer full. */
129 if (data->usb_out_pointer == 0)
130 return;
wdenkaffae2b2002-08-17 09:36:01 +0000131
Marek Vasut7534a3e2011-10-10 16:34:26 +0100132 data->usb_in_pointer = 0;
133 } else {
134 /* Check for buffer full. */
135 if (data->usb_in_pointer == data->usb_out_pointer - 1)
136 return;
wdenkaffae2b2002-08-17 09:36:01 +0000137
Marek Vasut7534a3e2011-10-10 16:34:26 +0100138 data->usb_in_pointer++;
139 }
wdenkaffae2b2002-08-17 09:36:01 +0000140
Marek Vasut7534a3e2011-10-10 16:34:26 +0100141 data->usb_kbd_buffer[data->usb_in_pointer] = c;
wdenkaffae2b2002-08-17 09:36:01 +0000142}
143
Marek Vasut7534a3e2011-10-10 16:34:26 +0100144/*
145 * Set the LEDs. Since this is used in the irq routine, the control job is
146 * issued with a timeout of 0. This means, that the job is queued without
147 * waiting for job completion.
wdenkaffae2b2002-08-17 09:36:01 +0000148 */
wdenkaffae2b2002-08-17 09:36:01 +0000149static void usb_kbd_setled(struct usb_device *dev)
150{
Marek Vasut7534a3e2011-10-10 16:34:26 +0100151 struct usb_interface *iface = &dev->config.if_desc[0];
152 struct usb_kbd_pdata *data = dev->privptr;
Hans de Goedee402b6c2014-09-20 16:51:26 +0200153 ALLOC_ALIGN_BUFFER(uint32_t, leds, 1, USB_DMA_MINALIGN);
Marek Vasut7534a3e2011-10-10 16:34:26 +0100154
Hans de Goedee402b6c2014-09-20 16:51:26 +0200155 *leds = data->flags & USB_KBD_LEDMASK;
wdenkaffae2b2002-08-17 09:36:01 +0000156 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
157 USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Hans de Goedee402b6c2014-09-20 16:51:26 +0200158 0x200, iface->desc.bInterfaceNumber, leds, 1, 0);
wdenkaffae2b2002-08-17 09:36:01 +0000159}
160
Marek Vasut7534a3e2011-10-10 16:34:26 +0100161#define CAPITAL_MASK 0x20
wdenkaffae2b2002-08-17 09:36:01 +0000162/* Translate the scancode in ASCII */
Marek Vasut7534a3e2011-10-10 16:34:26 +0100163static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode,
164 unsigned char modifier, int pressed)
wdenkaffae2b2002-08-17 09:36:01 +0000165{
Marek Vasut7534a3e2011-10-10 16:34:26 +0100166 uint8_t keycode = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000167
Marek Vasut7534a3e2011-10-10 16:34:26 +0100168 /* Key released */
Marek Vasutb9300982011-10-10 05:34:25 +0000169 if (pressed == 0) {
Marek Vasut7534a3e2011-10-10 16:34:26 +0100170 data->repeat_delay = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000171 return 0;
172 }
Marek Vasut7534a3e2011-10-10 16:34:26 +0100173
Marek Vasutb9300982011-10-10 05:34:25 +0000174 if (pressed == 2) {
Marek Vasut7534a3e2011-10-10 16:34:26 +0100175 data->repeat_delay++;
176 if (data->repeat_delay < REPEAT_DELAY)
wdenkaffae2b2002-08-17 09:36:01 +0000177 return 0;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100178
179 data->repeat_delay = REPEAT_DELAY;
wdenkaffae2b2002-08-17 09:36:01 +0000180 }
Marek Vasut7534a3e2011-10-10 16:34:26 +0100181
182 /* Alphanumeric values */
183 if ((scancode > 3) && (scancode <= 0x1d)) {
184 keycode = scancode - 4 + 'a';
185
186 if (data->flags & USB_KBD_CAPSLOCK)
Marek Vasutb9300982011-10-10 05:34:25 +0000187 keycode &= ~CAPITAL_MASK;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100188
189 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) {
190 /* Handle CAPSLock + Shift pressed simultaneously */
Marek Vasutb9300982011-10-10 05:34:25 +0000191 if (keycode & CAPITAL_MASK)
Marek Vasutb9300982011-10-10 05:34:25 +0000192 keycode &= ~CAPITAL_MASK;
wdenkaffae2b2002-08-17 09:36:01 +0000193 else
Marek Vasutb9300982011-10-10 05:34:25 +0000194 keycode |= CAPITAL_MASK;
wdenkaffae2b2002-08-17 09:36:01 +0000195 }
196 }
Marek Vasut7534a3e2011-10-10 16:34:26 +0100197
198 if ((scancode > 0x1d) && (scancode < 0x3a)) {
199 /* Shift pressed */
200 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT))
201 keycode = usb_kbd_numkey_shifted[scancode - 0x1e];
202 else
203 keycode = usb_kbd_numkey[scancode - 0x1e];
wdenkaffae2b2002-08-17 09:36:01 +0000204 }
Zhang Wei37cc4f02008-01-03 10:51:15 +0800205
Allen Martin1bfb4cd2012-11-06 13:26:03 -0800206 /* Arrow keys */
207 if ((scancode >= 0x4f) && (scancode <= 0x52))
208 keycode = usb_kbd_arrow[scancode - 0x4f];
209
Vincent Palatin92f6a622012-01-09 12:59:36 +0000210 /* Numeric keypad */
211 if ((scancode >= 0x54) && (scancode <= 0x67))
212 keycode = usb_kbd_num_keypad[scancode - 0x54];
213
Marek Vasut7534a3e2011-10-10 16:34:26 +0100214 if (data->flags & USB_KBD_CTRL)
Zhang Wei37cc4f02008-01-03 10:51:15 +0800215 keycode = scancode - 0x3;
216
Marek Vasutb9300982011-10-10 05:34:25 +0000217 if (pressed == 1) {
218 if (scancode == NUM_LOCK) {
Marek Vasut7534a3e2011-10-10 16:34:26 +0100219 data->flags ^= USB_KBD_NUMLOCK;
wdenkaffae2b2002-08-17 09:36:01 +0000220 return 1;
221 }
Marek Vasut7534a3e2011-10-10 16:34:26 +0100222
Marek Vasutb9300982011-10-10 05:34:25 +0000223 if (scancode == CAPS_LOCK) {
Marek Vasut7534a3e2011-10-10 16:34:26 +0100224 data->flags ^= USB_KBD_CAPSLOCK;
wdenkaffae2b2002-08-17 09:36:01 +0000225 return 1;
226 }
Marek Vasutb9300982011-10-10 05:34:25 +0000227 if (scancode == SCROLL_LOCK) {
Marek Vasut7534a3e2011-10-10 16:34:26 +0100228 data->flags ^= USB_KBD_SCROLLLOCK;
wdenkaffae2b2002-08-17 09:36:01 +0000229 return 1;
230 }
231 }
Marek Vasut7534a3e2011-10-10 16:34:26 +0100232
233 /* Report keycode if any */
234 if (keycode) {
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530235 debug("%c", keycode);
Marek Vasut7534a3e2011-10-10 16:34:26 +0100236 usb_kbd_put_queue(data, keycode);
wdenkaffae2b2002-08-17 09:36:01 +0000237 }
Marek Vasut7534a3e2011-10-10 16:34:26 +0100238
wdenkaffae2b2002-08-17 09:36:01 +0000239 return 0;
240}
241
Marek Vasut7534a3e2011-10-10 16:34:26 +0100242static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up)
243{
244 uint32_t res = 0;
245 struct usb_kbd_pdata *data = dev->privptr;
246 uint8_t *new;
247 uint8_t *old;
248
249 if (up) {
250 new = data->old;
251 old = data->new;
252 } else {
253 new = data->new;
254 old = data->old;
255 }
256
Adrian Cox17472dc2014-04-10 14:02:44 +0100257 if ((old[i] > 3) &&
258 (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) ==
259 new + USB_KBD_BOOT_REPORT_SIZE)) {
Marek Vasut7534a3e2011-10-10 16:34:26 +0100260 res |= usb_kbd_translate(data, old[i], data->new[0], up);
Adrian Cox17472dc2014-04-10 14:02:44 +0100261 }
Marek Vasut7534a3e2011-10-10 16:34:26 +0100262
263 return res;
264}
265
wdenkaffae2b2002-08-17 09:36:01 +0000266/* Interrupt service routine */
Marek Vasut82cf9a42011-09-25 20:00:37 +0100267static int usb_kbd_irq_worker(struct usb_device *dev)
wdenkaffae2b2002-08-17 09:36:01 +0000268{
Marek Vasut7534a3e2011-10-10 16:34:26 +0100269 struct usb_kbd_pdata *data = dev->privptr;
270 int i, res = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000271
Marek Vasut7534a3e2011-10-10 16:34:26 +0100272 /* No combo key pressed */
273 if (data->new[0] == 0x00)
274 data->flags &= ~USB_KBD_CTRL;
275 /* Left or Right Ctrl pressed */
276 else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR))
277 data->flags |= USB_KBD_CTRL;
Zhang Wei37cc4f02008-01-03 10:51:15 +0800278
Adrian Cox17472dc2014-04-10 14:02:44 +0100279 for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) {
Marek Vasut7534a3e2011-10-10 16:34:26 +0100280 res |= usb_kbd_service_key(dev, i, 0);
281 res |= usb_kbd_service_key(dev, i, 1);
wdenkaffae2b2002-08-17 09:36:01 +0000282 }
Marek Vasutb9300982011-10-10 05:34:25 +0000283
Marek Vasut7534a3e2011-10-10 16:34:26 +0100284 /* Key is still pressed */
285 if ((data->new[2] > 3) && (data->old[2] == data->new[2]))
286 res |= usb_kbd_translate(data, data->new[2], data->new[0], 2);
287
Marek Vasutb9300982011-10-10 05:34:25 +0000288 if (res == 1)
wdenkaffae2b2002-08-17 09:36:01 +0000289 usb_kbd_setled(dev);
Marek Vasutb9300982011-10-10 05:34:25 +0000290
Adrian Cox17472dc2014-04-10 14:02:44 +0100291 memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE);
Marek Vasutb9300982011-10-10 05:34:25 +0000292
Marek Vasut7534a3e2011-10-10 16:34:26 +0100293 return 1;
wdenkaffae2b2002-08-17 09:36:01 +0000294}
295
Marek Vasut7534a3e2011-10-10 16:34:26 +0100296/* Keyboard interrupt handler */
Marek Vasut82cf9a42011-09-25 20:00:37 +0100297static int usb_kbd_irq(struct usb_device *dev)
298{
Adrian Cox17472dc2014-04-10 14:02:44 +0100299 if ((dev->irq_status != 0) ||
300 (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) {
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530301 debug("USB KBD: Error %lX, len %d\n",
302 dev->irq_status, dev->irq_act_len);
Marek Vasut82cf9a42011-09-25 20:00:37 +0100303 return 1;
304 }
305
306 return usb_kbd_irq_worker(dev);
307}
308
Marek Vasut7534a3e2011-10-10 16:34:26 +0100309/* Interrupt polling */
310static inline void usb_kbd_poll_for_event(struct usb_device *dev)
311{
312#if defined(CONFIG_SYS_USB_EVENT_POLL)
Hans de Goede3c794702014-09-24 14:06:10 +0200313 struct usb_kbd_pdata *data = dev->privptr;
amartin@nvidia.com185da952011-12-20 14:56:16 +0000314
315 /* Submit a interrupt transfer request */
Hans de Goede3c794702014-09-24 14:06:10 +0200316 usb_submit_int_msg(dev, data->intpipe, &data->new[0], data->intpktsize,
317 data->intinterval);
amartin@nvidia.com185da952011-12-20 14:56:16 +0000318
Marek Vasut7534a3e2011-10-10 16:34:26 +0100319 usb_kbd_irq_worker(dev);
320#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
321 struct usb_interface *iface;
322 struct usb_kbd_pdata *data = dev->privptr;
323 iface = &dev->config.if_desc[0];
324 usb_get_report(dev, iface->desc.bInterfaceNumber,
Adrian Cox17472dc2014-04-10 14:02:44 +0100325 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE);
326 if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE))
Marek Vasut7534a3e2011-10-10 16:34:26 +0100327 usb_kbd_irq_worker(dev);
Hans de Goede2d02ae72014-09-24 14:06:11 +0200328#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
329 struct usb_kbd_pdata *data = dev->privptr;
330 if (poll_int_queue(dev, data->intq)) {
331 usb_kbd_irq_worker(dev);
332 /* We've consumed all queued int packets, create new */
333 destroy_int_queue(dev, data->intq);
334 data->intq = create_int_queue(dev, data->intpipe, 1,
Hans de Goedebbd2d2a2015-01-11 20:38:28 +0100335 USB_KBD_BOOT_REPORT_SIZE, data->new,
336 data->intinterval);
Hans de Goede2d02ae72014-09-24 14:06:11 +0200337 }
Marek Vasut7534a3e2011-10-10 16:34:26 +0100338#endif
339}
340
341/* test if a character is in the queue */
Simon Glass0d1e1f72014-07-23 06:54:59 -0600342static int usb_kbd_testc(struct stdio_dev *sdev)
Marek Vasut7534a3e2011-10-10 16:34:26 +0100343{
344 struct stdio_dev *dev;
345 struct usb_device *usb_kbd_dev;
346 struct usb_kbd_pdata *data;
347
Jim Line2ebec82013-08-26 20:21:09 +0800348#ifdef CONFIG_CMD_NET
349 /*
350 * If net_busy_flag is 1, NET transfer is running,
351 * then we check key-pressed every second (first check may be
352 * less than 1 second) to improve TFTP booting performance.
353 */
354 if (net_busy_flag && (get_timer(kbd_testc_tms) < CONFIG_SYS_HZ))
355 return 0;
356 kbd_testc_tms = get_timer(0);
357#endif
Marek Vasut7534a3e2011-10-10 16:34:26 +0100358 dev = stdio_get_by_name(DEVNAME);
359 usb_kbd_dev = (struct usb_device *)dev->priv;
360 data = usb_kbd_dev->privptr;
361
362 usb_kbd_poll_for_event(usb_kbd_dev);
363
364 return !(data->usb_in_pointer == data->usb_out_pointer);
365}
366
367/* gets the character from the queue */
Simon Glass0d1e1f72014-07-23 06:54:59 -0600368static int usb_kbd_getc(struct stdio_dev *sdev)
Marek Vasut7534a3e2011-10-10 16:34:26 +0100369{
370 struct stdio_dev *dev;
371 struct usb_device *usb_kbd_dev;
372 struct usb_kbd_pdata *data;
373
374 dev = stdio_get_by_name(DEVNAME);
375 usb_kbd_dev = (struct usb_device *)dev->priv;
376 data = usb_kbd_dev->privptr;
377
378 while (data->usb_in_pointer == data->usb_out_pointer)
379 usb_kbd_poll_for_event(usb_kbd_dev);
380
381 if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1)
382 data->usb_out_pointer = 0;
383 else
384 data->usb_out_pointer++;
385
386 return data->usb_kbd_buffer[data->usb_out_pointer];
387}
388
389/* probes the USB device dev for keyboard type. */
wdenkaffae2b2002-08-17 09:36:01 +0000390static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
391{
Tom Rix83b9e1d2009-10-31 12:37:38 -0500392 struct usb_interface *iface;
wdenkaffae2b2002-08-17 09:36:01 +0000393 struct usb_endpoint_descriptor *ep;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100394 struct usb_kbd_pdata *data;
wdenkaffae2b2002-08-17 09:36:01 +0000395
Marek Vasutb9300982011-10-10 05:34:25 +0000396 if (dev->descriptor.bNumConfigurations != 1)
397 return 0;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100398
wdenkaffae2b2002-08-17 09:36:01 +0000399 iface = &dev->config.if_desc[ifnum];
400
Tom Rix83b9e1d2009-10-31 12:37:38 -0500401 if (iface->desc.bInterfaceClass != 3)
402 return 0;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100403
Tom Rix83b9e1d2009-10-31 12:37:38 -0500404 if (iface->desc.bInterfaceSubClass != 1)
405 return 0;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100406
Tom Rix83b9e1d2009-10-31 12:37:38 -0500407 if (iface->desc.bInterfaceProtocol != 1)
408 return 0;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100409
Tom Rix83b9e1d2009-10-31 12:37:38 -0500410 if (iface->desc.bNumEndpoints != 1)
411 return 0;
wdenkaffae2b2002-08-17 09:36:01 +0000412
413 ep = &iface->ep_desc[0];
414
Marek Vasut7534a3e2011-10-10 16:34:26 +0100415 /* Check if endpoint 1 is interrupt endpoint */
Marek Vasutb9300982011-10-10 05:34:25 +0000416 if (!(ep->bEndpointAddress & 0x80))
417 return 0;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100418
Marek Vasutb9300982011-10-10 05:34:25 +0000419 if ((ep->bmAttributes & 3) != 3)
420 return 0;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100421
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530422 debug("USB KBD: found set protocol...\n");
Marek Vasut7534a3e2011-10-10 16:34:26 +0100423
424 data = malloc(sizeof(struct usb_kbd_pdata));
425 if (!data) {
426 printf("USB KBD: Error allocating private data\n");
427 return 0;
428 }
429
430 /* Clear private data */
431 memset(data, 0, sizeof(struct usb_kbd_pdata));
432
Allen Martinef769ca2012-10-24 08:32:04 +0000433 /* allocate input buffer aligned and sized to USB DMA alignment */
Adrian Cox17472dc2014-04-10 14:02:44 +0100434 data->new = memalign(USB_DMA_MINALIGN,
435 roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN));
Allen Martinef769ca2012-10-24 08:32:04 +0000436
Marek Vasut7534a3e2011-10-10 16:34:26 +0100437 /* Insert private data into USB device structure */
438 dev->privptr = data;
439
440 /* Set IRQ handler */
441 dev->irq_handle = usb_kbd_irq;
442
Hans de Goede3c794702014-09-24 14:06:10 +0200443 data->intpipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
444 data->intpktsize = min(usb_maxpacket(dev, data->intpipe),
445 USB_KBD_BOOT_REPORT_SIZE);
446 data->intinterval = ep->bInterval;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100447
448 /* We found a USB Keyboard, install it. */
449 usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);
450
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530451 debug("USB KBD: found set idle...\n");
Marek Vasut7534a3e2011-10-10 16:34:26 +0100452 usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE, 0);
453
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530454 debug("USB KBD: enable interrupt pipe...\n");
Hans de Goede2d02ae72014-09-24 14:06:11 +0200455#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
456 data->intq = create_int_queue(dev, data->intpipe, 1,
Hans de Goedebbd2d2a2015-01-11 20:38:28 +0100457 USB_KBD_BOOT_REPORT_SIZE, data->new,
458 data->intinterval);
Hans de Goede2d02ae72014-09-24 14:06:11 +0200459 if (!data->intq) {
460#else
Hans de Goede3c794702014-09-24 14:06:10 +0200461 if (usb_submit_int_msg(dev, data->intpipe, data->new, data->intpktsize,
462 data->intinterval) < 0) {
Hans de Goede2d02ae72014-09-24 14:06:11 +0200463#endif
Vincent Palatin0eab9982013-05-10 19:48:59 -0700464 printf("Failed to get keyboard state from device %04x:%04x\n",
465 dev->descriptor.idVendor, dev->descriptor.idProduct);
466 /* Abort, we don't want to use that non-functional keyboard. */
467 return 0;
468 }
Marek Vasut7534a3e2011-10-10 16:34:26 +0100469
470 /* Success. */
wdenkaffae2b2002-08-17 09:36:01 +0000471 return 1;
472}
473
Marek Vasut7534a3e2011-10-10 16:34:26 +0100474/* Search for keyboard and register it if found. */
475int drv_usb_kbd_init(void)
476{
Hans de Goede7d21c8b2014-09-20 16:54:36 +0200477 struct stdio_dev usb_kbd_dev;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100478 struct usb_device *dev;
479 char *stdinname = getenv("stdin");
480 int error, i;
481
482 /* Scan all USB Devices */
483 for (i = 0; i < USB_MAX_DEVICE; i++) {
484 /* Get USB device. */
485 dev = usb_get_dev_index(i);
486 if (!dev)
487 return -1;
488
489 if (dev->devnum == -1)
490 continue;
491
492 /* Try probing the keyboard */
493 if (usb_kbd_probe(dev, 0) != 1)
494 continue;
495
Marek Vasut7534a3e2011-10-10 16:34:26 +0100496 /* Register the keyboard */
Vivek Gautamf94c95d2013-04-12 16:34:33 +0530497 debug("USB KBD: register.\n");
Marek Vasut7534a3e2011-10-10 16:34:26 +0100498 memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
499 strcpy(usb_kbd_dev.name, DEVNAME);
500 usb_kbd_dev.flags = DEV_FLAGS_INPUT | DEV_FLAGS_SYSTEM;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100501 usb_kbd_dev.getc = usb_kbd_getc;
502 usb_kbd_dev.tstc = usb_kbd_testc;
503 usb_kbd_dev.priv = (void *)dev;
504 error = stdio_register(&usb_kbd_dev);
505 if (error)
506 return error;
507
amartin@nvidia.comc9d62022011-12-23 10:29:48 +0000508#ifdef CONFIG_CONSOLE_MUX
509 error = iomux_doenv(stdin, stdinname);
510 if (error)
511 return error;
512#else
Marek Vasut7534a3e2011-10-10 16:34:26 +0100513 /* Check if this is the standard input device. */
514 if (strcmp(stdinname, DEVNAME))
515 return 1;
516
517 /* Reassign the console */
518 if (overwrite_console())
519 return 1;
520
521 error = console_assign(stdin, DEVNAME);
522 if (error)
523 return error;
amartin@nvidia.comc9d62022011-12-23 10:29:48 +0000524#endif
Marek Vasut7534a3e2011-10-10 16:34:26 +0100525
526 return 1;
527 }
528
529 /* No USB Keyboard found */
530 return -1;
531}
532
533/* Deregister the keyboard. */
Hans de Goede3e51df02014-09-20 16:54:38 +0200534int usb_kbd_deregister(int force)
Marek Vasut7534a3e2011-10-10 16:34:26 +0100535{
536#ifdef CONFIG_SYS_STDIO_DEREGISTER
Hans de Goede55a54512014-09-24 14:06:08 +0200537 struct stdio_dev *dev;
538 struct usb_device *usb_kbd_dev;
539 struct usb_kbd_pdata *data;
540
541 dev = stdio_get_by_name(DEVNAME);
542 if (dev) {
543 usb_kbd_dev = (struct usb_device *)dev->priv;
544 data = usb_kbd_dev->privptr;
545 if (stdio_deregister_dev(dev, force) != 0)
546 return 1;
Hans de Goedee8790a22015-01-11 20:34:44 +0100547#ifdef CONFIG_CONSOLE_MUX
548 if (iomux_doenv(stdin, getenv("stdin")) != 0)
549 return 1;
550#endif
Hans de Goede2d02ae72014-09-24 14:06:11 +0200551#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
552 destroy_int_queue(usb_kbd_dev, data->intq);
553#endif
Hans de Goede55a54512014-09-24 14:06:08 +0200554 free(data->new);
555 free(data);
556 }
Hans de Goedef5656232014-09-20 16:54:34 +0200557
558 return 0;
Marek Vasut7534a3e2011-10-10 16:34:26 +0100559#else
560 return 1;
561#endif
562}