blob: 0227024441710041a4cbcb2fd5c30920ad9078a6 [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 Denk1a459662013-07-08 09:37:19 +02008 * SPDX-License-Identifier: GPL-2.0+
wdenkaffae2b2002-08-17 09:36:01 +00009 */
10#include <common.h>
Simon Glass697033c2015-03-25 12:22:34 -060011#include <dm.h>
Hans de Goede0ea09df2014-09-20 16:54:34 +020012#include <errno.h>
Marek Vasut9a8c72a2011-10-10 16:34:26 +010013#include <malloc.h>
Jean-Christophe PLAGNIOL-VILLARD52cb4d42009-05-16 12:14:54 +020014#include <stdio_dev.h>
Christian Eggersc9182612008-05-21 22:12:00 +020015#include <asm/byteorder.h>
wdenkaffae2b2002-08-17 09:36:01 +000016
wdenkaffae2b2002-08-17 09:36:01 +000017#include <usb.h>
18
wdenkaffae2b2002-08-17 09:36:01 +000019/*
Marek Vasut00b7d6e2011-10-10 05:34:25 +000020 * If overwrite_console returns 1, the stdin, stderr and stdout
wdenkaffae2b2002-08-17 09:36:01 +000021 * are switched to the serial port, else the settings in the
22 * environment are used
23 */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020024#ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
Marek Vasut00b7d6e2011-10-10 05:34:25 +000025extern int overwrite_console(void);
wdenkaffae2b2002-08-17 09:36:01 +000026#else
Marek Vasut00b7d6e2011-10-10 05:34:25 +000027int overwrite_console(void)
wdenkaffae2b2002-08-17 09:36:01 +000028{
Marek Vasut00b7d6e2011-10-10 05:34:25 +000029 return 0;
wdenkaffae2b2002-08-17 09:36:01 +000030}
31#endif
32
Marek Vasut9a8c72a2011-10-10 16:34:26 +010033/* Keyboard sampling rate */
Hans de Goede8454c842015-05-19 22:51:03 +020034#define REPEAT_RATE 40 /* 40msec -> 25cps */
Marek Vasut9a8c72a2011-10-10 16:34:26 +010035#define REPEAT_DELAY 10 /* 10 x REPEAT_RATE = 400msec */
wdenkaffae2b2002-08-17 09:36:01 +000036
37#define NUM_LOCK 0x53
Marek Vasut00b7d6e2011-10-10 05:34:25 +000038#define CAPS_LOCK 0x39
39#define SCROLL_LOCK 0x47
wdenkaffae2b2002-08-17 09:36:01 +000040
wdenkaffae2b2002-08-17 09:36:01 +000041/* Modifier bits */
Marek Vasut9a8c72a2011-10-10 16:34:26 +010042#define LEFT_CNTR (1 << 0)
43#define LEFT_SHIFT (1 << 1)
44#define LEFT_ALT (1 << 2)
45#define LEFT_GUI (1 << 3)
46#define RIGHT_CNTR (1 << 4)
47#define RIGHT_SHIFT (1 << 5)
48#define RIGHT_ALT (1 << 6)
49#define RIGHT_GUI (1 << 7)
wdenkaffae2b2002-08-17 09:36:01 +000050
Marek Vasut9a8c72a2011-10-10 16:34:26 +010051/* Size of the keyboard buffer */
52#define USB_KBD_BUFFER_LEN 0x20
wdenkaffae2b2002-08-17 09:36:01 +000053
Marek Vasut9a8c72a2011-10-10 16:34:26 +010054/* Device name */
Marek Vasut00b7d6e2011-10-10 05:34:25 +000055#define DEVNAME "usbkbd"
wdenkaffae2b2002-08-17 09:36:01 +000056
Marek Vasut9a8c72a2011-10-10 16:34:26 +010057/* Keyboard maps */
58static const unsigned char usb_kbd_numkey[] = {
Marek Vasut00b7d6e2011-10-10 05:34:25 +000059 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
60 '\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']',
61 '\\', '#', ';', '\'', '`', ',', '.', '/'
wdenkaffae2b2002-08-17 09:36:01 +000062};
Marek Vasut9a8c72a2011-10-10 16:34:26 +010063static const unsigned char usb_kbd_numkey_shifted[] = {
Marek Vasut00b7d6e2011-10-10 05:34:25 +000064 '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
65 '\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}',
66 '|', '~', ':', '"', '~', '<', '>', '?'
wdenkaffae2b2002-08-17 09:36:01 +000067};
68
Vincent Palatind53da842012-01-09 12:59:36 +000069static const unsigned char usb_kbd_num_keypad[] = {
70 '/', '*', '-', '+', '\r',
71 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
72 '.', 0, 0, 0, '='
73};
74
Marek Vasut9a8c72a2011-10-10 16:34:26 +010075/*
Allen Martin4151a402012-11-06 13:26:03 -080076 * map arrow keys to ^F/^B ^N/^P, can't really use the proper
77 * ANSI sequence for arrow keys because the queuing code breaks
78 * when a single keypress expands to 3 queue elements
79 */
80static const unsigned char usb_kbd_arrow[] = {
81 0x6, 0x2, 0xe, 0x10
82};
83
84/*
Marek Vasut9a8c72a2011-10-10 16:34:26 +010085 * NOTE: It's important for the NUM, CAPS, SCROLL-lock bits to be in this
86 * order. See usb_kbd_setled() function!
87 */
88#define USB_KBD_NUMLOCK (1 << 0)
89#define USB_KBD_CAPSLOCK (1 << 1)
90#define USB_KBD_SCROLLLOCK (1 << 2)
91#define USB_KBD_CTRL (1 << 3)
Marek Vasut48c80732011-09-25 20:00:37 +010092
Marek Vasut9a8c72a2011-10-10 16:34:26 +010093#define USB_KBD_LEDMASK \
94 (USB_KBD_NUMLOCK | USB_KBD_CAPSLOCK | USB_KBD_SCROLLLOCK)
95
Adrian Cox08a98b82014-04-10 14:02:44 +010096/*
97 * USB Keyboard reports are 8 bytes in boot protocol.
98 * Appendix B of HID Device Class Definition 1.11
99 */
100#define USB_KBD_BOOT_REPORT_SIZE 8
101
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100102struct 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(). */
124static unsigned long __maybe_unused kbd_testc_tms;
125
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100126/* Puts character in the queue and sets up the in and out pointer. */
127static void usb_kbd_put_queue(struct usb_kbd_pdata *data, char c)
128{
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
200 if ((scancode > 0x1d) && (scancode < 0x3a)) {
201 /* 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
Allen Martin4151a402012-11-06 13:26:03 -0800208 /* Arrow keys */
209 if ((scancode >= 0x4f) && (scancode <= 0x52))
210 keycode = usb_kbd_arrow[scancode - 0x4f];
211
Vincent Palatind53da842012-01-09 12:59:36 +0000212 /* Numeric keypad */
213 if ((scancode >= 0x54) && (scancode <= 0x67))
214 keycode = usb_kbd_num_keypad[scancode - 0x54];
215
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100216 if (data->flags & USB_KBD_CTRL)
217 keycode = scancode - 0x3;
218
219 if (pressed == 1) {
220 if (scancode == NUM_LOCK) {
221 data->flags ^= USB_KBD_NUMLOCK;
222 return 1;
223 }
224
225 if (scancode == CAPS_LOCK) {
226 data->flags ^= USB_KBD_CAPSLOCK;
227 return 1;
228 }
229 if (scancode == SCROLL_LOCK) {
230 data->flags ^= USB_KBD_SCROLLLOCK;
231 return 1;
232 }
233 }
234
235 /* Report keycode if any */
236 if (keycode) {
Vivek Gautamceb49722013-04-12 16:34:33 +0530237 debug("%c", keycode);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100238 usb_kbd_put_queue(data, keycode);
239 }
240
241 return 0;
242}
243
244static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up)
245{
246 uint32_t res = 0;
247 struct usb_kbd_pdata *data = dev->privptr;
248 uint8_t *new;
249 uint8_t *old;
250
251 if (up) {
252 new = data->old;
253 old = data->new;
254 } else {
255 new = data->new;
256 old = data->old;
257 }
258
Adrian Cox08a98b82014-04-10 14:02:44 +0100259 if ((old[i] > 3) &&
260 (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) ==
261 new + USB_KBD_BOOT_REPORT_SIZE)) {
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100262 res |= usb_kbd_translate(data, old[i], data->new[0], up);
Adrian Cox08a98b82014-04-10 14:02:44 +0100263 }
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100264
265 return res;
266}
267
268/* Interrupt service routine */
269static int usb_kbd_irq_worker(struct usb_device *dev)
270{
271 struct usb_kbd_pdata *data = dev->privptr;
272 int i, res = 0;
273
274 /* No combo key pressed */
275 if (data->new[0] == 0x00)
276 data->flags &= ~USB_KBD_CTRL;
277 /* Left or Right Ctrl pressed */
278 else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR))
279 data->flags |= USB_KBD_CTRL;
280
Adrian Cox08a98b82014-04-10 14:02:44 +0100281 for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) {
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100282 res |= usb_kbd_service_key(dev, i, 0);
283 res |= usb_kbd_service_key(dev, i, 1);
284 }
285
286 /* Key is still pressed */
287 if ((data->new[2] > 3) && (data->old[2] == data->new[2]))
288 res |= usb_kbd_translate(data, data->new[2], data->new[0], 2);
289
290 if (res == 1)
291 usb_kbd_setled(dev);
292
Adrian Cox08a98b82014-04-10 14:02:44 +0100293 memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100294
295 return 1;
296}
297
298/* Keyboard interrupt handler */
299static int usb_kbd_irq(struct usb_device *dev)
300{
Adrian Cox08a98b82014-04-10 14:02:44 +0100301 if ((dev->irq_status != 0) ||
302 (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) {
Vivek Gautamceb49722013-04-12 16:34:33 +0530303 debug("USB KBD: Error %lX, len %d\n",
304 dev->irq_status, dev->irq_act_len);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100305 return 1;
306 }
307
308 return usb_kbd_irq_worker(dev);
309}
310
311/* Interrupt polling */
Marek Vasut48c80732011-09-25 20:00:37 +0100312static inline void usb_kbd_poll_for_event(struct usb_device *dev)
313{
Hans de Goede8454c842015-05-19 22:51:03 +0200314#if defined(CONFIG_SYS_USB_EVENT_POLL)
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200315 struct usb_kbd_pdata *data = dev->privptr;
amartin@nvidia.comf9636e82011-12-20 14:56:16 +0000316
317 /* Submit a interrupt transfer request */
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200318 usb_submit_int_msg(dev, data->intpipe, &data->new[0], data->intpktsize,
319 data->intinterval);
amartin@nvidia.comf9636e82011-12-20 14:56:16 +0000320
Marek Vasut48c80732011-09-25 20:00:37 +0100321 usb_kbd_irq_worker(dev);
Hans de Goede8454c842015-05-19 22:51:03 +0200322#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) || \
323 defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
324#if defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
Marek Vasut48c80732011-09-25 20:00:37 +0100325 struct usb_interface *iface;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100326 struct usb_kbd_pdata *data = dev->privptr;
Marek Vasut48c80732011-09-25 20:00:37 +0100327 iface = &dev->config.if_desc[0];
328 usb_get_report(dev, iface->desc.bInterfaceNumber,
Adrian Cox08a98b82014-04-10 14:02:44 +0100329 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE);
Hans de Goede8454c842015-05-19 22:51:03 +0200330 if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE)) {
Marek Vasut48c80732011-09-25 20:00:37 +0100331 usb_kbd_irq_worker(dev);
Hans de Goede8454c842015-05-19 22:51:03 +0200332#else
Hans de Goede8e553112014-09-24 14:06:11 +0200333 struct usb_kbd_pdata *data = dev->privptr;
334 if (poll_int_queue(dev, data->intq)) {
335 usb_kbd_irq_worker(dev);
336 /* We've consumed all queued int packets, create new */
337 destroy_int_queue(dev, data->intq);
338 data->intq = create_int_queue(dev, data->intpipe, 1,
Hans de Goede8bb6c1d2015-01-11 20:38:28 +0100339 USB_KBD_BOOT_REPORT_SIZE, data->new,
340 data->intinterval);
Hans de Goede8454c842015-05-19 22:51:03 +0200341#endif
342 data->last_report = get_timer(0);
343 /* Repeat last usb hid report every REPEAT_RATE ms for keyrepeat */
344 } else if (data->last_report != -1 &&
345 get_timer(data->last_report) > REPEAT_RATE) {
346 usb_kbd_irq_worker(dev);
347 data->last_report = get_timer(0);
Hans de Goede8e553112014-09-24 14:06:11 +0200348 }
Marek Vasut48c80732011-09-25 20:00:37 +0100349#endif
350}
351
wdenkaffae2b2002-08-17 09:36:01 +0000352/* test if a character is in the queue */
Simon Glass709ea542014-07-23 06:54:59 -0600353static int usb_kbd_testc(struct stdio_dev *sdev)
wdenkaffae2b2002-08-17 09:36:01 +0000354{
Marek Vasut48c80732011-09-25 20:00:37 +0100355 struct stdio_dev *dev;
356 struct usb_device *usb_kbd_dev;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100357 struct usb_kbd_pdata *data;
Marek Vasut48c80732011-09-25 20:00:37 +0100358
Jim Linc95e2b92013-08-26 20:21:09 +0800359#ifdef CONFIG_CMD_NET
360 /*
361 * If net_busy_flag is 1, NET transfer is running,
362 * then we check key-pressed every second (first check may be
363 * less than 1 second) to improve TFTP booting performance.
364 */
365 if (net_busy_flag && (get_timer(kbd_testc_tms) < CONFIG_SYS_HZ))
366 return 0;
367 kbd_testc_tms = get_timer(0);
368#endif
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100369 dev = stdio_get_by_name(DEVNAME);
Marek Vasut48c80732011-09-25 20:00:37 +0100370 usb_kbd_dev = (struct usb_device *)dev->priv;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100371 data = usb_kbd_dev->privptr;
Marek Vasut48c80732011-09-25 20:00:37 +0100372
373 usb_kbd_poll_for_event(usb_kbd_dev);
374
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100375 return !(data->usb_in_pointer == data->usb_out_pointer);
wdenkaffae2b2002-08-17 09:36:01 +0000376}
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100377
wdenkaffae2b2002-08-17 09:36:01 +0000378/* gets the character from the queue */
Simon Glass709ea542014-07-23 06:54:59 -0600379static int usb_kbd_getc(struct stdio_dev *sdev)
wdenkaffae2b2002-08-17 09:36:01 +0000380{
Marek Vasut48c80732011-09-25 20:00:37 +0100381 struct stdio_dev *dev;
382 struct usb_device *usb_kbd_dev;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100383 struct usb_kbd_pdata *data;
Marek Vasut48c80732011-09-25 20:00:37 +0100384
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100385 dev = stdio_get_by_name(DEVNAME);
Marek Vasut48c80732011-09-25 20:00:37 +0100386 usb_kbd_dev = (struct usb_device *)dev->priv;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100387 data = usb_kbd_dev->privptr;
Marek Vasut48c80732011-09-25 20:00:37 +0100388
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100389 while (data->usb_in_pointer == data->usb_out_pointer)
Marek Vasut48c80732011-09-25 20:00:37 +0100390 usb_kbd_poll_for_event(usb_kbd_dev);
391
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100392 if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1)
393 data->usb_out_pointer = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000394 else
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100395 data->usb_out_pointer++;
wdenkaffae2b2002-08-17 09:36:01 +0000396
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100397 return data->usb_kbd_buffer[data->usb_out_pointer];
wdenkaffae2b2002-08-17 09:36:01 +0000398}
399
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100400/* probes the USB device dev for keyboard type. */
401static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
402{
403 struct usb_interface *iface;
404 struct usb_endpoint_descriptor *ep;
405 struct usb_kbd_pdata *data;
wdenkaffae2b2002-08-17 09:36:01 +0000406
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100407 if (dev->descriptor.bNumConfigurations != 1)
408 return 0;
409
410 iface = &dev->config.if_desc[ifnum];
411
412 if (iface->desc.bInterfaceClass != 3)
413 return 0;
414
415 if (iface->desc.bInterfaceSubClass != 1)
416 return 0;
417
418 if (iface->desc.bInterfaceProtocol != 1)
419 return 0;
420
421 if (iface->desc.bNumEndpoints != 1)
422 return 0;
423
424 ep = &iface->ep_desc[0];
425
426 /* Check if endpoint 1 is interrupt endpoint */
427 if (!(ep->bEndpointAddress & 0x80))
428 return 0;
429
430 if ((ep->bmAttributes & 3) != 3)
431 return 0;
432
Vivek Gautamceb49722013-04-12 16:34:33 +0530433 debug("USB KBD: found set protocol...\n");
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100434
435 data = malloc(sizeof(struct usb_kbd_pdata));
436 if (!data) {
437 printf("USB KBD: Error allocating private data\n");
438 return 0;
439 }
440
441 /* Clear private data */
442 memset(data, 0, sizeof(struct usb_kbd_pdata));
443
Allen Martind7475382012-10-24 08:32:04 +0000444 /* allocate input buffer aligned and sized to USB DMA alignment */
Adrian Cox08a98b82014-04-10 14:02:44 +0100445 data->new = memalign(USB_DMA_MINALIGN,
446 roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN));
Allen Martind7475382012-10-24 08:32:04 +0000447
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100448 /* Insert private data into USB device structure */
449 dev->privptr = data;
450
451 /* Set IRQ handler */
452 dev->irq_handle = usb_kbd_irq;
453
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200454 data->intpipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
455 data->intpktsize = min(usb_maxpacket(dev, data->intpipe),
456 USB_KBD_BOOT_REPORT_SIZE);
457 data->intinterval = ep->bInterval;
Hans de Goede8454c842015-05-19 22:51:03 +0200458 data->last_report = -1;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100459
460 /* We found a USB Keyboard, install it. */
461 usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);
462
Hans de Goedede451492015-06-18 22:34:34 +0200463 debug("USB KBD: found set idle...\n");
Hans de Goede8454c842015-05-19 22:51:03 +0200464#if !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) && \
465 !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
Hans de Goede8454c842015-05-19 22:51:03 +0200466 usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE / 4, 0);
Hans de Goedede451492015-06-18 22:34:34 +0200467#else
468 usb_set_idle(dev, iface->desc.bInterfaceNumber, 0, 0);
Hans de Goede8454c842015-05-19 22:51:03 +0200469#endif
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100470
Vivek Gautamceb49722013-04-12 16:34:33 +0530471 debug("USB KBD: enable interrupt pipe...\n");
Hans de Goede8e553112014-09-24 14:06:11 +0200472#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
473 data->intq = create_int_queue(dev, data->intpipe, 1,
Hans de Goede8bb6c1d2015-01-11 20:38:28 +0100474 USB_KBD_BOOT_REPORT_SIZE, data->new,
475 data->intinterval);
Hans de Goede8e553112014-09-24 14:06:11 +0200476 if (!data->intq) {
477#else
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200478 if (usb_submit_int_msg(dev, data->intpipe, data->new, data->intpktsize,
479 data->intinterval) < 0) {
Hans de Goede8e553112014-09-24 14:06:11 +0200480#endif
Vincent Palatin5da2dc92013-05-10 19:48:59 -0700481 printf("Failed to get keyboard state from device %04x:%04x\n",
482 dev->descriptor.idVendor, dev->descriptor.idProduct);
483 /* Abort, we don't want to use that non-functional keyboard. */
484 return 0;
485 }
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100486
487 /* Success. */
488 return 1;
489}
490
Simon Glass603afaf2015-03-25 12:22:33 -0600491static int probe_usb_keyboard(struct usb_device *dev)
492{
493 char *stdinname;
494 struct stdio_dev usb_kbd_dev;
495 int error;
496
497 /* Try probing the keyboard */
498 if (usb_kbd_probe(dev, 0) != 1)
499 return -ENOENT;
500
501 /* Register the keyboard */
502 debug("USB KBD: register.\n");
503 memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
504 strcpy(usb_kbd_dev.name, DEVNAME);
505 usb_kbd_dev.flags = DEV_FLAGS_INPUT | DEV_FLAGS_SYSTEM;
506 usb_kbd_dev.getc = usb_kbd_getc;
507 usb_kbd_dev.tstc = usb_kbd_testc;
508 usb_kbd_dev.priv = (void *)dev;
509 error = stdio_register(&usb_kbd_dev);
510 if (error)
511 return error;
512
513 stdinname = getenv("stdin");
514#ifdef CONFIG_CONSOLE_MUX
515 error = iomux_doenv(stdin, stdinname);
516 if (error)
517 return error;
518#else
519 /* Check if this is the standard input device. */
520 if (strcmp(stdinname, DEVNAME))
521 return 1;
522
523 /* Reassign the console */
524 if (overwrite_console())
525 return 1;
526
527 error = console_assign(stdin, DEVNAME);
528 if (error)
529 return error;
530#endif
531
532 return 0;
533}
534
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100535/* Search for keyboard and register it if found. */
wdenkaffae2b2002-08-17 09:36:01 +0000536int drv_usb_kbd_init(void)
537{
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100538 int error, i;
wdenkaffae2b2002-08-17 09:36:01 +0000539
Simon Glass697033c2015-03-25 12:22:34 -0600540 debug("%s: Probing for keyboard\n", __func__);
541#ifdef CONFIG_DM_USB
542 /*
Simon Glassabb59cf2015-07-06 16:47:51 -0600543 * TODO: We should add U_BOOT_USB_DEVICE() declarations to each USB
544 * keyboard driver and then most of this file can be removed.
Simon Glass697033c2015-03-25 12:22:34 -0600545 */
546 struct udevice *bus;
547 struct uclass *uc;
548 int ret;
549
550 ret = uclass_get(UCLASS_USB, &uc);
551 if (ret)
552 return ret;
553 uclass_foreach_dev(bus, uc) {
554 for (i = 0; i < USB_MAX_DEVICE; i++) {
555 struct usb_device *dev;
556
557 dev = usb_get_dev_index(bus, i); /* get device */
558 debug("i=%d, %p\n", i, dev);
559 if (!dev)
560 break; /* no more devices available */
561
562 error = probe_usb_keyboard(dev);
563 if (!error)
564 return 1;
565 if (error && error != -ENOENT)
566 return error;
567 } /* for */
568 }
569#else
570 /* Scan all USB Devices */
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100571 for (i = 0; i < USB_MAX_DEVICE; i++) {
Simon Glass603afaf2015-03-25 12:22:33 -0600572 struct usb_device *dev;
573
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100574 /* Get USB device. */
575 dev = usb_get_dev_index(i);
576 if (!dev)
Simon Glass603afaf2015-03-25 12:22:33 -0600577 break;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100578
579 if (dev->devnum == -1)
580 continue;
581
Simon Glass603afaf2015-03-25 12:22:33 -0600582 error = probe_usb_keyboard(dev);
583 if (!error)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100584 return 1;
Simon Glass603afaf2015-03-25 12:22:33 -0600585 if (error && error != -ENOENT)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100586 return error;
wdenkaffae2b2002-08-17 09:36:01 +0000587 }
Simon Glass697033c2015-03-25 12:22:34 -0600588#endif
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100589
590 /* No USB Keyboard found */
wdenkaffae2b2002-08-17 09:36:01 +0000591 return -1;
592}
593
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100594/* Deregister the keyboard. */
Hans de Goede8a8a2252014-09-20 16:54:38 +0200595int usb_kbd_deregister(int force)
wdenkaffae2b2002-08-17 09:36:01 +0000596{
Jean-Christophe PLAGNIOL-VILLARD52cb4d42009-05-16 12:14:54 +0200597#ifdef CONFIG_SYS_STDIO_DEREGISTER
Hans de Goededfe5b1c2014-09-24 14:06:08 +0200598 struct stdio_dev *dev;
599 struct usb_device *usb_kbd_dev;
600 struct usb_kbd_pdata *data;
601
602 dev = stdio_get_by_name(DEVNAME);
603 if (dev) {
604 usb_kbd_dev = (struct usb_device *)dev->priv;
605 data = usb_kbd_dev->privptr;
606 if (stdio_deregister_dev(dev, force) != 0)
607 return 1;
Hans de Goede3cbcb282015-01-11 20:34:44 +0100608#ifdef CONFIG_CONSOLE_MUX
609 if (iomux_doenv(stdin, getenv("stdin")) != 0)
610 return 1;
611#endif
Hans de Goede8e553112014-09-24 14:06:11 +0200612#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
613 destroy_int_queue(usb_kbd_dev, data->intq);
614#endif
Hans de Goededfe5b1c2014-09-24 14:06:08 +0200615 free(data->new);
616 free(data);
617 }
Hans de Goede0ea09df2014-09-20 16:54:34 +0200618
619 return 0;
Jean-Christophe PLAGNIOL-VILLARDfea91ed2008-12-02 21:58:04 +0100620#else
621 return 1;
622#endif
wdenkaffae2b2002-08-17 09:36:01 +0000623}