1
2
3
4
5
6
7
8
9#include <common.h>
10#include <console.h>
11#include <dm.h>
12#include <env.h>
13#include <errno.h>
14#include <log.h>
15#include <malloc.h>
16#include <memalign.h>
17#include <stdio_dev.h>
18#include <watchdog.h>
19#include <asm/byteorder.h>
20
21#include <usb.h>
22
23
24
25
26
27
28#ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
29extern int overwrite_console(void);
30#else
31int overwrite_console(void)
32{
33 return 0;
34}
35#endif
36
37
38#define REPEAT_RATE 40
39#define REPEAT_DELAY 10
40
41#define NUM_LOCK 0x53
42#define CAPS_LOCK 0x39
43#define SCROLL_LOCK 0x47
44
45
46#define LEFT_CNTR (1 << 0)
47#define LEFT_SHIFT (1 << 1)
48#define LEFT_ALT (1 << 2)
49#define LEFT_GUI (1 << 3)
50#define RIGHT_CNTR (1 << 4)
51#define RIGHT_SHIFT (1 << 5)
52#define RIGHT_ALT (1 << 6)
53#define RIGHT_GUI (1 << 7)
54
55
56#define USB_KBD_BUFFER_LEN 0x20
57
58
59#define DEVNAME "usbkbd"
60
61
62static const unsigned char usb_kbd_numkey[] = {
63 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
64 '\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']',
65 '\\', '#', ';', '\'', '`', ',', '.', '/'
66};
67static const unsigned char usb_kbd_numkey_shifted[] = {
68 '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
69 '\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}',
70 '|', '~', ':', '"', '~', '<', '>', '?'
71};
72
73static const unsigned char usb_kbd_num_keypad[] = {
74 '/', '*', '-', '+', '\r',
75 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
76 '.', 0, 0, 0, '='
77};
78
79static const u8 usb_special_keys[] = {
80#ifdef CONFIG_USB_KEYBOARD_FN_KEYS
81 '2', 'H', '5', '3', 'F', '6', 'C', 'D', 'B', 'A'
82#else
83 'C', 'D', 'B', 'A'
84#endif
85};
86
87
88
89
90
91#define USB_KBD_NUMLOCK (1 << 0)
92#define USB_KBD_CAPSLOCK (1 << 1)
93#define USB_KBD_SCROLLLOCK (1 << 2)
94#define USB_KBD_CTRL (1 << 3)
95
96#define USB_KBD_LEDMASK \
97 (USB_KBD_NUMLOCK | USB_KBD_CAPSLOCK | USB_KBD_SCROLLLOCK)
98
99struct usb_kbd_pdata {
100 unsigned long intpipe;
101 int intpktsize;
102 int intinterval;
103 unsigned long last_report;
104 struct int_queue *intq;
105
106 uint32_t repeat_delay;
107
108 uint32_t usb_in_pointer;
109 uint32_t usb_out_pointer;
110 uint8_t usb_kbd_buffer[USB_KBD_BUFFER_LEN];
111
112 uint8_t *new;
113 uint8_t old[USB_KBD_BOOT_REPORT_SIZE];
114
115 uint8_t flags;
116};
117
118extern int __maybe_unused net_busy_flag;
119
120
121static unsigned long __maybe_unused kbd_testc_tms;
122
123
124static void usb_kbd_put_queue(struct usb_kbd_pdata *data, u8 c)
125{
126 if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) {
127
128 if (data->usb_out_pointer == 0)
129 return;
130
131 data->usb_in_pointer = 0;
132 } else {
133
134 if (data->usb_in_pointer == data->usb_out_pointer - 1)
135 return;
136
137 data->usb_in_pointer++;
138 }
139
140 data->usb_kbd_buffer[data->usb_in_pointer] = c;
141}
142
143
144
145
146
147
148static void usb_kbd_setled(struct usb_device *dev)
149{
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);
153
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);
158}
159
160#define CAPITAL_MASK 0x20
161
162static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode,
163 unsigned char modifier, int pressed)
164{
165 uint8_t keycode = 0;
166
167
168 if (pressed == 0) {
169 data->repeat_delay = 0;
170 return 0;
171 }
172
173 if (pressed == 2) {
174 data->repeat_delay++;
175 if (data->repeat_delay < REPEAT_DELAY)
176 return 0;
177
178 data->repeat_delay = REPEAT_DELAY;
179 }
180
181
182 if ((scancode > 3) && (scancode <= 0x1d)) {
183 keycode = scancode - 4 + 'a';
184
185 if (data->flags & USB_KBD_CAPSLOCK)
186 keycode &= ~CAPITAL_MASK;
187
188 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) {
189
190 if (keycode & CAPITAL_MASK)
191 keycode &= ~CAPITAL_MASK;
192 else
193 keycode |= CAPITAL_MASK;
194 }
195 }
196
197 if ((scancode > 0x1d) && (scancode < 0x39)) {
198
199 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT))
200 keycode = usb_kbd_numkey_shifted[scancode - 0x1e];
201 else
202 keycode = usb_kbd_numkey[scancode - 0x1e];
203 }
204
205
206 if ((scancode >= 0x54) && (scancode <= 0x67))
207 keycode = usb_kbd_num_keypad[scancode - 0x54];
208
209 if (data->flags & USB_KBD_CTRL)
210 keycode = scancode - 0x3;
211
212 if (pressed == 1) {
213 if (scancode == NUM_LOCK) {
214 data->flags ^= USB_KBD_NUMLOCK;
215 return 1;
216 }
217
218 if (scancode == CAPS_LOCK) {
219 data->flags ^= USB_KBD_CAPSLOCK;
220 return 1;
221 }
222 if (scancode == SCROLL_LOCK) {
223 data->flags ^= USB_KBD_SCROLLLOCK;
224 return 1;
225 }
226 }
227
228
229 if (keycode) {
230 debug("%c", keycode);
231 usb_kbd_put_queue(data, keycode);
232 return 0;
233 }
234
235#ifdef CONFIG_USB_KEYBOARD_FN_KEYS
236 if (scancode < 0x3a || scancode > 0x52 ||
237 scancode == 0x46 || scancode == 0x47)
238 return 1;
239
240 usb_kbd_put_queue(data, 0x1b);
241 if (scancode < 0x3e) {
242
243 usb_kbd_put_queue(data, 0x4f);
244 usb_kbd_put_queue(data, scancode - 0x3a + 'P');
245 return 0;
246 }
247 usb_kbd_put_queue(data, '[');
248 if (scancode < 0x42) {
249
250 usb_kbd_put_queue(data, '1');
251 if (scancode == 0x3e)
252 --scancode;
253 keycode = scancode - 0x3f + '7';
254 } else if (scancode < 0x49) {
255
256 usb_kbd_put_queue(data, '2');
257 if (scancode > 0x43)
258 ++scancode;
259 keycode = scancode - 0x42 + '0';
260 } else {
261
262
263
264
265 keycode = usb_special_keys[scancode - 0x49];
266 }
267 usb_kbd_put_queue(data, keycode);
268 if (scancode < 0x4f && scancode != 0x4a && scancode != 0x4d)
269 usb_kbd_put_queue(data, '~');
270 return 0;
271#else
272
273 if (scancode > 0x4e && scancode < 0x53) {
274 usb_kbd_put_queue(data, 0x1b);
275 usb_kbd_put_queue(data, '[');
276 usb_kbd_put_queue(data, usb_special_keys[scancode - 0x4f]);
277 return 0;
278 }
279 return 1;
280#endif
281}
282
283static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up)
284{
285 uint32_t res = 0;
286 struct usb_kbd_pdata *data = dev->privptr;
287 uint8_t *new;
288 uint8_t *old;
289
290 if (up) {
291 new = data->old;
292 old = data->new;
293 } else {
294 new = data->new;
295 old = data->old;
296 }
297
298 if ((old[i] > 3) &&
299 (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) ==
300 new + USB_KBD_BOOT_REPORT_SIZE)) {
301 res |= usb_kbd_translate(data, old[i], data->new[0], up);
302 }
303
304 return res;
305}
306
307
308static int usb_kbd_irq_worker(struct usb_device *dev)
309{
310 struct usb_kbd_pdata *data = dev->privptr;
311 int i, res = 0;
312
313
314 if (data->new[0] == 0x00)
315 data->flags &= ~USB_KBD_CTRL;
316
317 else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR))
318 data->flags |= USB_KBD_CTRL;
319
320 for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) {
321 res |= usb_kbd_service_key(dev, i, 0);
322 res |= usb_kbd_service_key(dev, i, 1);
323 }
324
325
326 if ((data->new[2] > 3) && (data->old[2] == data->new[2]))
327 res |= usb_kbd_translate(data, data->new[2], data->new[0], 2);
328
329 if (res == 1)
330 usb_kbd_setled(dev);
331
332 memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE);
333
334 return 1;
335}
336
337
338static int usb_kbd_irq(struct usb_device *dev)
339{
340 if ((dev->irq_status != 0) ||
341 (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) {
342 debug("USB KBD: Error %lX, len %d\n",
343 dev->irq_status, dev->irq_act_len);
344 return 1;
345 }
346
347 return usb_kbd_irq_worker(dev);
348}
349
350
351static inline void usb_kbd_poll_for_event(struct usb_device *dev)
352{
353#if defined(CONFIG_SYS_USB_EVENT_POLL)
354 struct usb_kbd_pdata *data = dev->privptr;
355
356
357 if (usb_int_msg(dev, data->intpipe, &data->new[0],
358 data->intpktsize, data->intinterval, true) >= 0)
359 usb_kbd_irq_worker(dev);
360#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) || \
361 defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
362#if defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
363 struct usb_interface *iface;
364 struct usb_kbd_pdata *data = dev->privptr;
365 iface = &dev->config.if_desc[0];
366 usb_get_report(dev, iface->desc.bInterfaceNumber,
367 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE);
368 if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE)) {
369 usb_kbd_irq_worker(dev);
370#else
371 struct usb_kbd_pdata *data = dev->privptr;
372 if (poll_int_queue(dev, data->intq)) {
373 usb_kbd_irq_worker(dev);
374
375 destroy_int_queue(dev, data->intq);
376 data->intq = create_int_queue(dev, data->intpipe, 1,
377 USB_KBD_BOOT_REPORT_SIZE, data->new,
378 data->intinterval);
379#endif
380 data->last_report = get_timer(0);
381
382 } else if (data->last_report != -1 &&
383 get_timer(data->last_report) > REPEAT_RATE) {
384 usb_kbd_irq_worker(dev);
385 data->last_report = get_timer(0);
386 }
387#endif
388}
389
390
391static int usb_kbd_testc(struct stdio_dev *sdev)
392{
393 struct stdio_dev *dev;
394 struct usb_device *usb_kbd_dev;
395 struct usb_kbd_pdata *data;
396
397#ifdef CONFIG_CMD_NET
398
399
400
401
402
403 if (net_busy_flag && (get_timer(kbd_testc_tms) < CONFIG_SYS_HZ))
404 return 0;
405 kbd_testc_tms = get_timer(0);
406#endif
407 dev = stdio_get_by_name(sdev->name);
408 usb_kbd_dev = (struct usb_device *)dev->priv;
409 data = usb_kbd_dev->privptr;
410
411 usb_kbd_poll_for_event(usb_kbd_dev);
412
413 return !(data->usb_in_pointer == data->usb_out_pointer);
414}
415
416
417static int usb_kbd_getc(struct stdio_dev *sdev)
418{
419 struct stdio_dev *dev;
420 struct usb_device *usb_kbd_dev;
421 struct usb_kbd_pdata *data;
422
423 dev = stdio_get_by_name(sdev->name);
424 usb_kbd_dev = (struct usb_device *)dev->priv;
425 data = usb_kbd_dev->privptr;
426
427 while (data->usb_in_pointer == data->usb_out_pointer) {
428 WATCHDOG_RESET();
429 usb_kbd_poll_for_event(usb_kbd_dev);
430 }
431
432 if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1)
433 data->usb_out_pointer = 0;
434 else
435 data->usb_out_pointer++;
436
437 return data->usb_kbd_buffer[data->usb_out_pointer];
438}
439
440
441static int usb_kbd_probe_dev(struct usb_device *dev, unsigned int ifnum)
442{
443 struct usb_interface *iface;
444 struct usb_endpoint_descriptor *ep;
445 struct usb_kbd_pdata *data;
446 int epNum;
447
448 if (dev->descriptor.bNumConfigurations != 1)
449 return 0;
450
451 iface = &dev->config.if_desc[ifnum];
452
453 if (iface->desc.bInterfaceClass != USB_CLASS_HID)
454 return 0;
455
456 if (iface->desc.bInterfaceSubClass != USB_SUB_HID_BOOT)
457 return 0;
458
459 if (iface->desc.bInterfaceProtocol != USB_PROT_HID_KEYBOARD)
460 return 0;
461
462 for (epNum = 0; epNum < iface->desc.bNumEndpoints; epNum++) {
463 ep = &iface->ep_desc[epNum];
464
465
466 if ((ep->bmAttributes & 3) != 3)
467 continue;
468
469 if (ep->bEndpointAddress & 0x80)
470 break;
471 }
472
473 if (epNum == iface->desc.bNumEndpoints)
474 return 0;
475
476 debug("USB KBD: found interrupt EP: 0x%x\n", ep->bEndpointAddress);
477
478 data = malloc(sizeof(struct usb_kbd_pdata));
479 if (!data) {
480 printf("USB KBD: Error allocating private data\n");
481 return 0;
482 }
483
484
485 memset(data, 0, sizeof(struct usb_kbd_pdata));
486
487
488 data->new = memalign(USB_DMA_MINALIGN,
489 roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN));
490
491
492 dev->privptr = data;
493
494
495 dev->irq_handle = usb_kbd_irq;
496
497 data->intpipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
498 data->intpktsize = min(usb_maxpacket(dev, data->intpipe),
499 USB_KBD_BOOT_REPORT_SIZE);
500 data->intinterval = ep->bInterval;
501 data->last_report = -1;
502
503
504 debug("USB KBD: set boot protocol\n");
505 usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);
506
507#if !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) && \
508 !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
509 debug("USB KBD: set idle interval...\n");
510 usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE / 4, 0);
511#else
512 debug("USB KBD: set idle interval=0...\n");
513 usb_set_idle(dev, iface->desc.bInterfaceNumber, 0, 0);
514#endif
515
516 debug("USB KBD: enable interrupt pipe...\n");
517#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
518 data->intq = create_int_queue(dev, data->intpipe, 1,
519 USB_KBD_BOOT_REPORT_SIZE, data->new,
520 data->intinterval);
521 if (!data->intq) {
522#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
523 if (usb_get_report(dev, iface->desc.bInterfaceNumber,
524 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE) < 0) {
525#else
526 if (usb_int_msg(dev, data->intpipe, data->new, data->intpktsize,
527 data->intinterval, false) < 0) {
528#endif
529 printf("Failed to get keyboard state from device %04x:%04x\n",
530 dev->descriptor.idVendor, dev->descriptor.idProduct);
531
532 return 0;
533 }
534
535
536 return 1;
537}
538
539static int probe_usb_keyboard(struct usb_device *dev)
540{
541 char *stdinname;
542 struct stdio_dev usb_kbd_dev;
543 int error;
544
545
546 if (usb_kbd_probe_dev(dev, 0) != 1)
547 return -ENOENT;
548
549
550 debug("USB KBD: register.\n");
551 memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
552 strcpy(usb_kbd_dev.name, DEVNAME);
553 usb_kbd_dev.flags = DEV_FLAGS_INPUT;
554 usb_kbd_dev.getc = usb_kbd_getc;
555 usb_kbd_dev.tstc = usb_kbd_testc;
556 usb_kbd_dev.priv = (void *)dev;
557 error = stdio_register(&usb_kbd_dev);
558 if (error)
559 return error;
560
561 stdinname = env_get("stdin");
562#if CONFIG_IS_ENABLED(CONSOLE_MUX)
563 error = iomux_doenv(stdin, stdinname);
564 if (error)
565 return error;
566#else
567
568 if (strcmp(stdinname, DEVNAME))
569 return 1;
570
571
572 if (overwrite_console())
573 return 1;
574
575 error = console_assign(stdin, DEVNAME);
576 if (error)
577 return error;
578#endif
579
580 return 0;
581}
582
583#if !CONFIG_IS_ENABLED(DM_USB)
584
585int drv_usb_kbd_init(void)
586{
587 int error, i;
588
589 debug("%s: Probing for keyboard\n", __func__);
590
591 for (i = 0; i < USB_MAX_DEVICE; i++) {
592 struct usb_device *dev;
593
594
595 dev = usb_get_dev_index(i);
596 if (!dev)
597 break;
598
599 if (dev->devnum == -1)
600 continue;
601
602 error = probe_usb_keyboard(dev);
603 if (!error)
604 return 1;
605 if (error && error != -ENOENT)
606 return error;
607 }
608
609
610 return -1;
611}
612
613
614int usb_kbd_deregister(int force)
615{
616#if CONFIG_IS_ENABLED(SYS_STDIO_DEREGISTER)
617 struct stdio_dev *dev;
618 struct usb_device *usb_kbd_dev;
619 struct usb_kbd_pdata *data;
620
621 dev = stdio_get_by_name(DEVNAME);
622 if (dev) {
623 usb_kbd_dev = (struct usb_device *)dev->priv;
624 data = usb_kbd_dev->privptr;
625#if CONFIG_IS_ENABLED(CONSOLE_MUX)
626 if (iomux_replace_device(stdin, DEVNAME, force ? "nulldev" : ""))
627 return 1;
628#endif
629 if (stdio_deregister_dev(dev, force) != 0)
630 return 1;
631#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
632 destroy_int_queue(usb_kbd_dev, data->intq);
633#endif
634 free(data->new);
635 free(data);
636 }
637
638 return 0;
639#else
640 return 1;
641#endif
642}
643
644#endif
645
646#if CONFIG_IS_ENABLED(DM_USB)
647
648static int usb_kbd_probe(struct udevice *dev)
649{
650 struct usb_device *udev = dev_get_parent_priv(dev);
651
652 return probe_usb_keyboard(udev);
653}
654
655static int usb_kbd_remove(struct udevice *dev)
656{
657 struct usb_device *udev = dev_get_parent_priv(dev);
658 struct usb_kbd_pdata *data;
659 struct stdio_dev *sdev;
660 int ret;
661
662 sdev = stdio_get_by_name(DEVNAME);
663 if (!sdev) {
664 ret = -ENXIO;
665 goto err;
666 }
667 data = udev->privptr;
668#if CONFIG_IS_ENABLED(CONSOLE_MUX)
669 if (iomux_replace_device(stdin, DEVNAME, "nulldev")) {
670 ret = -ENOLINK;
671 goto err;
672 }
673#endif
674 if (stdio_deregister_dev(sdev, true)) {
675 ret = -EPERM;
676 goto err;
677 }
678#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
679 destroy_int_queue(udev, data->intq);
680#endif
681 free(data->new);
682 free(data);
683
684 return 0;
685err:
686 printf("%s: warning, ret=%d", __func__, ret);
687 return ret;
688}
689
690static const struct udevice_id usb_kbd_ids[] = {
691 { .compatible = "usb-keyboard" },
692 { }
693};
694
695U_BOOT_DRIVER(usb_kbd) = {
696 .name = "usb_kbd",
697 .id = UCLASS_KEYBOARD,
698 .of_match = usb_kbd_ids,
699 .probe = usb_kbd_probe,
700 .remove = usb_kbd_remove,
701};
702
703static const struct usb_device_id kbd_id_table[] = {
704 {
705 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
706 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
707 USB_DEVICE_ID_MATCH_INT_PROTOCOL,
708 .bInterfaceClass = USB_CLASS_HID,
709 .bInterfaceSubClass = USB_SUB_HID_BOOT,
710 .bInterfaceProtocol = USB_PROT_HID_KEYBOARD,
711 },
712 { }
713};
714
715U_BOOT_USB_DEVICE(usb_kbd, kbd_id_table);
716
717#endif
718