blob: 020f0d4117f7d07f1b22debe8e78b1c78f3f2f64 [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>
Hans de Goede0ea09df2014-09-20 16:54:34 +020012#include <errno.h>
Marek Vasut9a8c72a2011-10-10 16:34:26 +010013#include <malloc.h>
Simon Glasscf92e052015-09-02 17:24:58 -060014#include <memalign.h>
Jean-Christophe PLAGNIOL-VILLARD52cb4d42009-05-16 12:14:54 +020015#include <stdio_dev.h>
Michal Simekf8f3e0e2018-06-27 14:16:54 +020016#include <watchdog.h>
Christian Eggersc9182612008-05-21 22:12:00 +020017#include <asm/byteorder.h>
wdenkaffae2b2002-08-17 09:36:01 +000018
wdenkaffae2b2002-08-17 09:36:01 +000019#include <usb.h>
20
wdenkaffae2b2002-08-17 09:36:01 +000021/*
Marek Vasut00b7d6e2011-10-10 05:34:25 +000022 * If overwrite_console returns 1, the stdin, stderr and stdout
wdenkaffae2b2002-08-17 09:36:01 +000023 * are switched to the serial port, else the settings in the
24 * environment are used
25 */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020026#ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
Marek Vasut00b7d6e2011-10-10 05:34:25 +000027extern int overwrite_console(void);
wdenkaffae2b2002-08-17 09:36:01 +000028#else
Marek Vasut00b7d6e2011-10-10 05:34:25 +000029int overwrite_console(void)
wdenkaffae2b2002-08-17 09:36:01 +000030{
Marek Vasut00b7d6e2011-10-10 05:34:25 +000031 return 0;
wdenkaffae2b2002-08-17 09:36:01 +000032}
33#endif
34
Marek Vasut9a8c72a2011-10-10 16:34:26 +010035/* Keyboard sampling rate */
Hans de Goede8454c842015-05-19 22:51:03 +020036#define REPEAT_RATE 40 /* 40msec -> 25cps */
Marek Vasut9a8c72a2011-10-10 16:34:26 +010037#define REPEAT_DELAY 10 /* 10 x REPEAT_RATE = 400msec */
wdenkaffae2b2002-08-17 09:36:01 +000038
39#define NUM_LOCK 0x53
Marek Vasut00b7d6e2011-10-10 05:34:25 +000040#define CAPS_LOCK 0x39
41#define SCROLL_LOCK 0x47
wdenkaffae2b2002-08-17 09:36:01 +000042
wdenkaffae2b2002-08-17 09:36:01 +000043/* Modifier bits */
Marek Vasut9a8c72a2011-10-10 16:34:26 +010044#define LEFT_CNTR (1 << 0)
45#define LEFT_SHIFT (1 << 1)
46#define LEFT_ALT (1 << 2)
47#define LEFT_GUI (1 << 3)
48#define RIGHT_CNTR (1 << 4)
49#define RIGHT_SHIFT (1 << 5)
50#define RIGHT_ALT (1 << 6)
51#define RIGHT_GUI (1 << 7)
wdenkaffae2b2002-08-17 09:36:01 +000052
Marek Vasut9a8c72a2011-10-10 16:34:26 +010053/* Size of the keyboard buffer */
54#define USB_KBD_BUFFER_LEN 0x20
wdenkaffae2b2002-08-17 09:36:01 +000055
Marek Vasut9a8c72a2011-10-10 16:34:26 +010056/* Device name */
Marek Vasut00b7d6e2011-10-10 05:34:25 +000057#define DEVNAME "usbkbd"
wdenkaffae2b2002-08-17 09:36:01 +000058
Marek Vasut9a8c72a2011-10-10 16:34:26 +010059/* Keyboard maps */
60static const unsigned char usb_kbd_numkey[] = {
Marek Vasut00b7d6e2011-10-10 05:34:25 +000061 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
62 '\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']',
63 '\\', '#', ';', '\'', '`', ',', '.', '/'
wdenkaffae2b2002-08-17 09:36:01 +000064};
Marek Vasut9a8c72a2011-10-10 16:34:26 +010065static const unsigned char usb_kbd_numkey_shifted[] = {
Marek Vasut00b7d6e2011-10-10 05:34:25 +000066 '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
67 '\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}',
68 '|', '~', ':', '"', '~', '<', '>', '?'
wdenkaffae2b2002-08-17 09:36:01 +000069};
70
Vincent Palatind53da842012-01-09 12:59:36 +000071static const unsigned char usb_kbd_num_keypad[] = {
72 '/', '*', '-', '+', '\r',
73 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
74 '.', 0, 0, 0, '='
75};
76
Marek Vasut9a8c72a2011-10-10 16:34:26 +010077/*
Allen Martin4151a402012-11-06 13:26:03 -080078 * map arrow keys to ^F/^B ^N/^P, can't really use the proper
79 * ANSI sequence for arrow keys because the queuing code breaks
80 * when a single keypress expands to 3 queue elements
81 */
82static const unsigned char usb_kbd_arrow[] = {
83 0x6, 0x2, 0xe, 0x10
84};
85
86/*
Marek Vasut9a8c72a2011-10-10 16:34:26 +010087 * NOTE: It's important for the NUM, CAPS, SCROLL-lock bits to be in this
88 * order. See usb_kbd_setled() function!
89 */
90#define USB_KBD_NUMLOCK (1 << 0)
91#define USB_KBD_CAPSLOCK (1 << 1)
92#define USB_KBD_SCROLLLOCK (1 << 2)
93#define USB_KBD_CTRL (1 << 3)
Marek Vasut48c80732011-09-25 20:00:37 +010094
Marek Vasut9a8c72a2011-10-10 16:34:26 +010095#define USB_KBD_LEDMASK \
96 (USB_KBD_NUMLOCK | USB_KBD_CAPSLOCK | USB_KBD_SCROLLLOCK)
97
Adrian Cox08a98b82014-04-10 14:02:44 +010098/*
99 * USB Keyboard reports are 8 bytes in boot protocol.
100 * Appendix B of HID Device Class Definition 1.11
101 */
102#define USB_KBD_BOOT_REPORT_SIZE 8
103
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100104struct usb_kbd_pdata {
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200105 unsigned long intpipe;
106 int intpktsize;
107 int intinterval;
Hans de Goede8454c842015-05-19 22:51:03 +0200108 unsigned long last_report;
Hans de Goede8e553112014-09-24 14:06:11 +0200109 struct int_queue *intq;
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200110
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100111 uint32_t repeat_delay;
112
113 uint32_t usb_in_pointer;
114 uint32_t usb_out_pointer;
115 uint8_t usb_kbd_buffer[USB_KBD_BUFFER_LEN];
116
Allen Martind7475382012-10-24 08:32:04 +0000117 uint8_t *new;
Adrian Cox08a98b82014-04-10 14:02:44 +0100118 uint8_t old[USB_KBD_BOOT_REPORT_SIZE];
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100119
120 uint8_t flags;
121};
122
Jim Lin07551f22013-08-13 19:04:22 +0800123extern int __maybe_unused net_busy_flag;
124
125/* The period of time between two calls of usb_kbd_testc(). */
126static unsigned long __maybe_unused kbd_testc_tms;
127
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100128/* Puts character in the queue and sets up the in and out pointer. */
129static void usb_kbd_put_queue(struct usb_kbd_pdata *data, char c)
130{
131 if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) {
132 /* Check for buffer full. */
133 if (data->usb_out_pointer == 0)
134 return;
135
136 data->usb_in_pointer = 0;
137 } else {
138 /* Check for buffer full. */
139 if (data->usb_in_pointer == data->usb_out_pointer - 1)
140 return;
141
142 data->usb_in_pointer++;
143 }
144
145 data->usb_kbd_buffer[data->usb_in_pointer] = c;
146}
147
148/*
149 * Set the LEDs. Since this is used in the irq routine, the control job is
150 * issued with a timeout of 0. This means, that the job is queued without
151 * waiting for job completion.
152 */
153static void usb_kbd_setled(struct usb_device *dev)
154{
155 struct usb_interface *iface = &dev->config.if_desc[0];
156 struct usb_kbd_pdata *data = dev->privptr;
Hans de Goede9b239382014-09-20 16:51:26 +0200157 ALLOC_ALIGN_BUFFER(uint32_t, leds, 1, USB_DMA_MINALIGN);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100158
Hans de Goede9b239382014-09-20 16:51:26 +0200159 *leds = data->flags & USB_KBD_LEDMASK;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100160 usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
161 USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
Hans de Goede9b239382014-09-20 16:51:26 +0200162 0x200, iface->desc.bInterfaceNumber, leds, 1, 0);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100163}
164
165#define CAPITAL_MASK 0x20
166/* Translate the scancode in ASCII */
167static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode,
168 unsigned char modifier, int pressed)
169{
170 uint8_t keycode = 0;
171
172 /* Key released */
173 if (pressed == 0) {
174 data->repeat_delay = 0;
175 return 0;
176 }
177
178 if (pressed == 2) {
179 data->repeat_delay++;
180 if (data->repeat_delay < REPEAT_DELAY)
181 return 0;
182
183 data->repeat_delay = REPEAT_DELAY;
184 }
185
186 /* Alphanumeric values */
187 if ((scancode > 3) && (scancode <= 0x1d)) {
188 keycode = scancode - 4 + 'a';
189
190 if (data->flags & USB_KBD_CAPSLOCK)
191 keycode &= ~CAPITAL_MASK;
192
193 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) {
194 /* Handle CAPSLock + Shift pressed simultaneously */
195 if (keycode & CAPITAL_MASK)
196 keycode &= ~CAPITAL_MASK;
197 else
198 keycode |= CAPITAL_MASK;
199 }
200 }
201
Marek Vasutbdbcbe72016-01-25 22:00:44 +0100202 if ((scancode > 0x1d) && (scancode < 0x39)) {
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100203 /* Shift pressed */
204 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT))
205 keycode = usb_kbd_numkey_shifted[scancode - 0x1e];
206 else
207 keycode = usb_kbd_numkey[scancode - 0x1e];
208 }
209
Allen Martin4151a402012-11-06 13:26:03 -0800210 /* Arrow keys */
211 if ((scancode >= 0x4f) && (scancode <= 0x52))
212 keycode = usb_kbd_arrow[scancode - 0x4f];
213
Vincent Palatind53da842012-01-09 12:59:36 +0000214 /* Numeric keypad */
215 if ((scancode >= 0x54) && (scancode <= 0x67))
216 keycode = usb_kbd_num_keypad[scancode - 0x54];
217
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100218 if (data->flags & USB_KBD_CTRL)
219 keycode = scancode - 0x3;
220
221 if (pressed == 1) {
222 if (scancode == NUM_LOCK) {
223 data->flags ^= USB_KBD_NUMLOCK;
224 return 1;
225 }
226
227 if (scancode == CAPS_LOCK) {
228 data->flags ^= USB_KBD_CAPSLOCK;
229 return 1;
230 }
231 if (scancode == SCROLL_LOCK) {
232 data->flags ^= USB_KBD_SCROLLLOCK;
233 return 1;
234 }
235 }
236
237 /* Report keycode if any */
238 if (keycode) {
Vivek Gautamceb49722013-04-12 16:34:33 +0530239 debug("%c", keycode);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100240 usb_kbd_put_queue(data, keycode);
241 }
242
243 return 0;
244}
245
246static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up)
247{
248 uint32_t res = 0;
249 struct usb_kbd_pdata *data = dev->privptr;
250 uint8_t *new;
251 uint8_t *old;
252
253 if (up) {
254 new = data->old;
255 old = data->new;
256 } else {
257 new = data->new;
258 old = data->old;
259 }
260
Adrian Cox08a98b82014-04-10 14:02:44 +0100261 if ((old[i] > 3) &&
262 (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) ==
263 new + USB_KBD_BOOT_REPORT_SIZE)) {
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100264 res |= usb_kbd_translate(data, old[i], data->new[0], up);
Adrian Cox08a98b82014-04-10 14:02:44 +0100265 }
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100266
267 return res;
268}
269
270/* Interrupt service routine */
271static int usb_kbd_irq_worker(struct usb_device *dev)
272{
273 struct usb_kbd_pdata *data = dev->privptr;
274 int i, res = 0;
275
276 /* No combo key pressed */
277 if (data->new[0] == 0x00)
278 data->flags &= ~USB_KBD_CTRL;
279 /* Left or Right Ctrl pressed */
280 else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR))
281 data->flags |= USB_KBD_CTRL;
282
Adrian Cox08a98b82014-04-10 14:02:44 +0100283 for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) {
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100284 res |= usb_kbd_service_key(dev, i, 0);
285 res |= usb_kbd_service_key(dev, i, 1);
286 }
287
288 /* Key is still pressed */
289 if ((data->new[2] > 3) && (data->old[2] == data->new[2]))
290 res |= usb_kbd_translate(data, data->new[2], data->new[0], 2);
291
292 if (res == 1)
293 usb_kbd_setled(dev);
294
Adrian Cox08a98b82014-04-10 14:02:44 +0100295 memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100296
297 return 1;
298}
299
300/* Keyboard interrupt handler */
301static int usb_kbd_irq(struct usb_device *dev)
302{
Adrian Cox08a98b82014-04-10 14:02:44 +0100303 if ((dev->irq_status != 0) ||
304 (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) {
Vivek Gautamceb49722013-04-12 16:34:33 +0530305 debug("USB KBD: Error %lX, len %d\n",
306 dev->irq_status, dev->irq_act_len);
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100307 return 1;
308 }
309
310 return usb_kbd_irq_worker(dev);
311}
312
313/* Interrupt polling */
Marek Vasut48c80732011-09-25 20:00:37 +0100314static inline void usb_kbd_poll_for_event(struct usb_device *dev)
315{
Hans de Goede8454c842015-05-19 22:51:03 +0200316#if defined(CONFIG_SYS_USB_EVENT_POLL)
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200317 struct usb_kbd_pdata *data = dev->privptr;
amartin@nvidia.comf9636e82011-12-20 14:56:16 +0000318
319 /* Submit a interrupt transfer request */
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200320 usb_submit_int_msg(dev, data->intpipe, &data->new[0], data->intpktsize,
321 data->intinterval);
amartin@nvidia.comf9636e82011-12-20 14:56:16 +0000322
Marek Vasut48c80732011-09-25 20:00:37 +0100323 usb_kbd_irq_worker(dev);
Hans de Goede8454c842015-05-19 22:51:03 +0200324#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) || \
325 defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
326#if defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
Marek Vasut48c80732011-09-25 20:00:37 +0100327 struct usb_interface *iface;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100328 struct usb_kbd_pdata *data = dev->privptr;
Marek Vasut48c80732011-09-25 20:00:37 +0100329 iface = &dev->config.if_desc[0];
330 usb_get_report(dev, iface->desc.bInterfaceNumber,
Adrian Cox08a98b82014-04-10 14:02:44 +0100331 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE);
Hans de Goede8454c842015-05-19 22:51:03 +0200332 if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE)) {
Marek Vasut48c80732011-09-25 20:00:37 +0100333 usb_kbd_irq_worker(dev);
Hans de Goede8454c842015-05-19 22:51:03 +0200334#else
Hans de Goede8e553112014-09-24 14:06:11 +0200335 struct usb_kbd_pdata *data = dev->privptr;
336 if (poll_int_queue(dev, data->intq)) {
337 usb_kbd_irq_worker(dev);
338 /* We've consumed all queued int packets, create new */
339 destroy_int_queue(dev, data->intq);
340 data->intq = create_int_queue(dev, data->intpipe, 1,
Hans de Goede8bb6c1d2015-01-11 20:38:28 +0100341 USB_KBD_BOOT_REPORT_SIZE, data->new,
342 data->intinterval);
Hans de Goede8454c842015-05-19 22:51:03 +0200343#endif
344 data->last_report = get_timer(0);
345 /* Repeat last usb hid report every REPEAT_RATE ms for keyrepeat */
346 } else if (data->last_report != -1 &&
347 get_timer(data->last_report) > REPEAT_RATE) {
348 usb_kbd_irq_worker(dev);
349 data->last_report = get_timer(0);
Hans de Goede8e553112014-09-24 14:06:11 +0200350 }
Marek Vasut48c80732011-09-25 20:00:37 +0100351#endif
352}
353
wdenkaffae2b2002-08-17 09:36:01 +0000354/* test if a character is in the queue */
Simon Glass709ea542014-07-23 06:54:59 -0600355static int usb_kbd_testc(struct stdio_dev *sdev)
wdenkaffae2b2002-08-17 09:36:01 +0000356{
Marek Vasut48c80732011-09-25 20:00:37 +0100357 struct stdio_dev *dev;
358 struct usb_device *usb_kbd_dev;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100359 struct usb_kbd_pdata *data;
Marek Vasut48c80732011-09-25 20:00:37 +0100360
Jim Linc95e2b92013-08-26 20:21:09 +0800361#ifdef CONFIG_CMD_NET
362 /*
363 * If net_busy_flag is 1, NET transfer is running,
364 * then we check key-pressed every second (first check may be
365 * less than 1 second) to improve TFTP booting performance.
366 */
367 if (net_busy_flag && (get_timer(kbd_testc_tms) < CONFIG_SYS_HZ))
368 return 0;
369 kbd_testc_tms = get_timer(0);
370#endif
Michal Simek4fb67f42018-06-27 14:35:07 +0200371 dev = stdio_get_by_name(sdev->name);
Marek Vasut48c80732011-09-25 20:00:37 +0100372 usb_kbd_dev = (struct usb_device *)dev->priv;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100373 data = usb_kbd_dev->privptr;
Marek Vasut48c80732011-09-25 20:00:37 +0100374
375 usb_kbd_poll_for_event(usb_kbd_dev);
376
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100377 return !(data->usb_in_pointer == data->usb_out_pointer);
wdenkaffae2b2002-08-17 09:36:01 +0000378}
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100379
wdenkaffae2b2002-08-17 09:36:01 +0000380/* gets the character from the queue */
Simon Glass709ea542014-07-23 06:54:59 -0600381static int usb_kbd_getc(struct stdio_dev *sdev)
wdenkaffae2b2002-08-17 09:36:01 +0000382{
Marek Vasut48c80732011-09-25 20:00:37 +0100383 struct stdio_dev *dev;
384 struct usb_device *usb_kbd_dev;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100385 struct usb_kbd_pdata *data;
Marek Vasut48c80732011-09-25 20:00:37 +0100386
Michal Simek4fb67f42018-06-27 14:35:07 +0200387 dev = stdio_get_by_name(sdev->name);
Marek Vasut48c80732011-09-25 20:00:37 +0100388 usb_kbd_dev = (struct usb_device *)dev->priv;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100389 data = usb_kbd_dev->privptr;
Marek Vasut48c80732011-09-25 20:00:37 +0100390
Michal Simekf8f3e0e2018-06-27 14:16:54 +0200391 while (data->usb_in_pointer == data->usb_out_pointer) {
392 WATCHDOG_RESET();
Marek Vasut48c80732011-09-25 20:00:37 +0100393 usb_kbd_poll_for_event(usb_kbd_dev);
Michal Simekf8f3e0e2018-06-27 14:16:54 +0200394 }
Marek Vasut48c80732011-09-25 20:00:37 +0100395
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100396 if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1)
397 data->usb_out_pointer = 0;
wdenkaffae2b2002-08-17 09:36:01 +0000398 else
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100399 data->usb_out_pointer++;
wdenkaffae2b2002-08-17 09:36:01 +0000400
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100401 return data->usb_kbd_buffer[data->usb_out_pointer];
wdenkaffae2b2002-08-17 09:36:01 +0000402}
403
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100404/* probes the USB device dev for keyboard type. */
Simon Glass34ab37e2015-09-08 11:15:11 -0600405static int usb_kbd_probe_dev(struct usb_device *dev, unsigned int ifnum)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100406{
407 struct usb_interface *iface;
408 struct usb_endpoint_descriptor *ep;
409 struct usb_kbd_pdata *data;
wdenkaffae2b2002-08-17 09:36:01 +0000410
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100411 if (dev->descriptor.bNumConfigurations != 1)
412 return 0;
413
414 iface = &dev->config.if_desc[ifnum];
415
Simon Glass2cdb58e2015-11-08 23:48:04 -0700416 if (iface->desc.bInterfaceClass != USB_CLASS_HID)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100417 return 0;
418
Simon Glass2cdb58e2015-11-08 23:48:04 -0700419 if (iface->desc.bInterfaceSubClass != USB_SUB_HID_BOOT)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100420 return 0;
421
Simon Glass2cdb58e2015-11-08 23:48:04 -0700422 if (iface->desc.bInterfaceProtocol != USB_PROT_HID_KEYBOARD)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100423 return 0;
424
425 if (iface->desc.bNumEndpoints != 1)
426 return 0;
427
428 ep = &iface->ep_desc[0];
429
430 /* Check if endpoint 1 is interrupt endpoint */
431 if (!(ep->bEndpointAddress & 0x80))
432 return 0;
433
434 if ((ep->bmAttributes & 3) != 3)
435 return 0;
436
Vivek Gautamceb49722013-04-12 16:34:33 +0530437 debug("USB KBD: found set protocol...\n");
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100438
439 data = malloc(sizeof(struct usb_kbd_pdata));
440 if (!data) {
441 printf("USB KBD: Error allocating private data\n");
442 return 0;
443 }
444
445 /* Clear private data */
446 memset(data, 0, sizeof(struct usb_kbd_pdata));
447
Allen Martind7475382012-10-24 08:32:04 +0000448 /* allocate input buffer aligned and sized to USB DMA alignment */
Adrian Cox08a98b82014-04-10 14:02:44 +0100449 data->new = memalign(USB_DMA_MINALIGN,
450 roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN));
Allen Martind7475382012-10-24 08:32:04 +0000451
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100452 /* Insert private data into USB device structure */
453 dev->privptr = data;
454
455 /* Set IRQ handler */
456 dev->irq_handle = usb_kbd_irq;
457
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200458 data->intpipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
459 data->intpktsize = min(usb_maxpacket(dev, data->intpipe),
460 USB_KBD_BOOT_REPORT_SIZE);
461 data->intinterval = ep->bInterval;
Hans de Goede8454c842015-05-19 22:51:03 +0200462 data->last_report = -1;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100463
464 /* We found a USB Keyboard, install it. */
465 usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);
466
Hans de Goedede451492015-06-18 22:34:34 +0200467 debug("USB KBD: found set idle...\n");
Hans de Goede8454c842015-05-19 22:51:03 +0200468#if !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) && \
469 !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
Hans de Goede8454c842015-05-19 22:51:03 +0200470 usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE / 4, 0);
Hans de Goedede451492015-06-18 22:34:34 +0200471#else
472 usb_set_idle(dev, iface->desc.bInterfaceNumber, 0, 0);
Hans de Goede8454c842015-05-19 22:51:03 +0200473#endif
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100474
Vivek Gautamceb49722013-04-12 16:34:33 +0530475 debug("USB KBD: enable interrupt pipe...\n");
Hans de Goede8e553112014-09-24 14:06:11 +0200476#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
477 data->intq = create_int_queue(dev, data->intpipe, 1,
Hans de Goede8bb6c1d2015-01-11 20:38:28 +0100478 USB_KBD_BOOT_REPORT_SIZE, data->new,
479 data->intinterval);
Hans de Goede8e553112014-09-24 14:06:11 +0200480 if (!data->intq) {
Stephen Warrene4b70d82015-11-13 13:34:09 -0700481#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
482 if (usb_get_report(dev, iface->desc.bInterfaceNumber,
483 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE) < 0) {
Hans de Goede8e553112014-09-24 14:06:11 +0200484#else
Hans de Goede8f8d7d22014-09-24 14:06:10 +0200485 if (usb_submit_int_msg(dev, data->intpipe, data->new, data->intpktsize,
486 data->intinterval) < 0) {
Hans de Goede8e553112014-09-24 14:06:11 +0200487#endif
Vincent Palatin5da2dc92013-05-10 19:48:59 -0700488 printf("Failed to get keyboard state from device %04x:%04x\n",
489 dev->descriptor.idVendor, dev->descriptor.idProduct);
490 /* Abort, we don't want to use that non-functional keyboard. */
491 return 0;
492 }
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100493
494 /* Success. */
495 return 1;
496}
497
Simon Glass603afaf2015-03-25 12:22:33 -0600498static int probe_usb_keyboard(struct usb_device *dev)
499{
500 char *stdinname;
501 struct stdio_dev usb_kbd_dev;
502 int error;
503
504 /* Try probing the keyboard */
Simon Glass34ab37e2015-09-08 11:15:11 -0600505 if (usb_kbd_probe_dev(dev, 0) != 1)
Simon Glass603afaf2015-03-25 12:22:33 -0600506 return -ENOENT;
507
508 /* Register the keyboard */
509 debug("USB KBD: register.\n");
510 memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
511 strcpy(usb_kbd_dev.name, DEVNAME);
Bin Meng1caf9342015-11-03 23:23:37 -0800512 usb_kbd_dev.flags = DEV_FLAGS_INPUT;
Simon Glass603afaf2015-03-25 12:22:33 -0600513 usb_kbd_dev.getc = usb_kbd_getc;
514 usb_kbd_dev.tstc = usb_kbd_testc;
515 usb_kbd_dev.priv = (void *)dev;
516 error = stdio_register(&usb_kbd_dev);
517 if (error)
518 return error;
519
Simon Glass00caae62017-08-03 12:22:12 -0600520 stdinname = env_get("stdin");
Simon Glassb0265422017-01-16 07:03:26 -0700521#if CONFIG_IS_ENABLED(CONSOLE_MUX)
Simon Glass603afaf2015-03-25 12:22:33 -0600522 error = iomux_doenv(stdin, stdinname);
523 if (error)
524 return error;
525#else
526 /* Check if this is the standard input device. */
527 if (strcmp(stdinname, DEVNAME))
528 return 1;
529
530 /* Reassign the console */
531 if (overwrite_console())
532 return 1;
533
534 error = console_assign(stdin, DEVNAME);
535 if (error)
536 return error;
537#endif
538
539 return 0;
540}
541
Sven Schwermerfd09c202018-11-21 08:43:56 +0100542#if !CONFIG_IS_ENABLED(DM_USB)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100543/* Search for keyboard and register it if found. */
wdenkaffae2b2002-08-17 09:36:01 +0000544int drv_usb_kbd_init(void)
545{
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100546 int error, i;
wdenkaffae2b2002-08-17 09:36:01 +0000547
Simon Glass697033c2015-03-25 12:22:34 -0600548 debug("%s: Probing for keyboard\n", __func__);
Simon Glass697033c2015-03-25 12:22:34 -0600549 /* Scan all USB Devices */
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100550 for (i = 0; i < USB_MAX_DEVICE; i++) {
Simon Glass603afaf2015-03-25 12:22:33 -0600551 struct usb_device *dev;
552
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100553 /* Get USB device. */
554 dev = usb_get_dev_index(i);
555 if (!dev)
Simon Glass603afaf2015-03-25 12:22:33 -0600556 break;
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100557
558 if (dev->devnum == -1)
559 continue;
560
Simon Glass603afaf2015-03-25 12:22:33 -0600561 error = probe_usb_keyboard(dev);
562 if (!error)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100563 return 1;
Simon Glass603afaf2015-03-25 12:22:33 -0600564 if (error && error != -ENOENT)
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100565 return error;
wdenkaffae2b2002-08-17 09:36:01 +0000566 }
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100567
568 /* No USB Keyboard found */
wdenkaffae2b2002-08-17 09:36:01 +0000569 return -1;
570}
571
Marek Vasut9a8c72a2011-10-10 16:34:26 +0100572/* Deregister the keyboard. */
Hans de Goede8a8a2252014-09-20 16:54:38 +0200573int usb_kbd_deregister(int force)
wdenkaffae2b2002-08-17 09:36:01 +0000574{
Simon Glass869588d2016-10-17 20:13:02 -0600575#if CONFIG_IS_ENABLED(SYS_STDIO_DEREGISTER)
Hans de Goededfe5b1c2014-09-24 14:06:08 +0200576 struct stdio_dev *dev;
577 struct usb_device *usb_kbd_dev;
578 struct usb_kbd_pdata *data;
579
580 dev = stdio_get_by_name(DEVNAME);
581 if (dev) {
582 usb_kbd_dev = (struct usb_device *)dev->priv;
583 data = usb_kbd_dev->privptr;
584 if (stdio_deregister_dev(dev, force) != 0)
585 return 1;
Simon Glassb0265422017-01-16 07:03:26 -0700586#if CONFIG_IS_ENABLED(CONSOLE_MUX)
Simon Glass00caae62017-08-03 12:22:12 -0600587 if (iomux_doenv(stdin, env_get("stdin")) != 0)
Hans de Goede3cbcb282015-01-11 20:34:44 +0100588 return 1;
589#endif
Hans de Goede8e553112014-09-24 14:06:11 +0200590#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
591 destroy_int_queue(usb_kbd_dev, data->intq);
592#endif
Hans de Goededfe5b1c2014-09-24 14:06:08 +0200593 free(data->new);
594 free(data);
595 }
Hans de Goede0ea09df2014-09-20 16:54:34 +0200596
597 return 0;
Jean-Christophe PLAGNIOL-VILLARDfea91ed2008-12-02 21:58:04 +0100598#else
599 return 1;
600#endif
wdenkaffae2b2002-08-17 09:36:01 +0000601}
Simon Glass34ab37e2015-09-08 11:15:11 -0600602
Hans de Goede9a80e712016-04-03 09:18:53 +0200603#endif
604
Sven Schwermerfd09c202018-11-21 08:43:56 +0100605#if CONFIG_IS_ENABLED(DM_USB)
Simon Glass34ab37e2015-09-08 11:15:11 -0600606
607static int usb_kbd_probe(struct udevice *dev)
608{
609 struct usb_device *udev = dev_get_parent_priv(dev);
Simon Glass34ab37e2015-09-08 11:15:11 -0600610
Masahiro Yamada8319aeb2016-09-06 22:17:35 +0900611 return probe_usb_keyboard(udev);
Simon Glass34ab37e2015-09-08 11:15:11 -0600612}
613
Simon Glass8a834872016-01-03 13:50:31 -0700614static int usb_kbd_remove(struct udevice *dev)
615{
616 struct usb_device *udev = dev_get_parent_priv(dev);
617 struct usb_kbd_pdata *data;
618 struct stdio_dev *sdev;
619 int ret;
620
621 sdev = stdio_get_by_name(DEVNAME);
622 if (!sdev) {
623 ret = -ENXIO;
624 goto err;
625 }
626 data = udev->privptr;
627 if (stdio_deregister_dev(sdev, true)) {
628 ret = -EPERM;
629 goto err;
630 }
Simon Glassb0265422017-01-16 07:03:26 -0700631#if CONFIG_IS_ENABLED(CONSOLE_MUX)
Simon Glass00caae62017-08-03 12:22:12 -0600632 if (iomux_doenv(stdin, env_get("stdin"))) {
Simon Glass8a834872016-01-03 13:50:31 -0700633 ret = -ENOLINK;
634 goto err;
635 }
636#endif
637#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
638 destroy_int_queue(udev, data->intq);
639#endif
640 free(data->new);
641 free(data);
642
643 return 0;
644err:
645 printf("%s: warning, ret=%d", __func__, ret);
646 return ret;
647}
648
Simon Glass34ab37e2015-09-08 11:15:11 -0600649static const struct udevice_id usb_kbd_ids[] = {
650 { .compatible = "usb-keyboard" },
651 { }
652};
653
654U_BOOT_DRIVER(usb_kbd) = {
655 .name = "usb_kbd",
656 .id = UCLASS_KEYBOARD,
657 .of_match = usb_kbd_ids,
658 .probe = usb_kbd_probe,
Simon Glass8a834872016-01-03 13:50:31 -0700659 .remove = usb_kbd_remove,
Simon Glass34ab37e2015-09-08 11:15:11 -0600660};
661
Simon Glass34ab37e2015-09-08 11:15:11 -0600662static const struct usb_device_id kbd_id_table[] = {
663 {
664 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
665 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
666 USB_DEVICE_ID_MATCH_INT_PROTOCOL,
667 .bInterfaceClass = USB_CLASS_HID,
Simon Glass2cdb58e2015-11-08 23:48:04 -0700668 .bInterfaceSubClass = USB_SUB_HID_BOOT,
669 .bInterfaceProtocol = USB_PROT_HID_KEYBOARD,
Simon Glass34ab37e2015-09-08 11:15:11 -0600670 },
671 { } /* Terminating entry */
672};
673
674U_BOOT_USB_DEVICE(usb_kbd, kbd_id_table);
675
676#endif