1 /* 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 * 8 * SPDX-License-Identifier: GPL-2.0+ 9 */ 10 #include <common.h> 11 #include <dm.h> 12 #include <errno.h> 13 #include <malloc.h> 14 #include <stdio_dev.h> 15 #include <asm/byteorder.h> 16 17 #include <usb.h> 18 19 /* 20 * If overwrite_console returns 1, the stdin, stderr and stdout 21 * are switched to the serial port, else the settings in the 22 * environment are used 23 */ 24 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 25 extern int overwrite_console(void); 26 #else 27 int overwrite_console(void) 28 { 29 return 0; 30 } 31 #endif 32 33 /* Keyboard sampling rate */ 34 #define REPEAT_RATE 40 /* 40msec -> 25cps */ 35 #define REPEAT_DELAY 10 /* 10 x REPEAT_RATE = 400msec */ 36 37 #define NUM_LOCK 0x53 38 #define CAPS_LOCK 0x39 39 #define SCROLL_LOCK 0x47 40 41 /* Modifier bits */ 42 #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) 50 51 /* Size of the keyboard buffer */ 52 #define USB_KBD_BUFFER_LEN 0x20 53 54 /* Device name */ 55 #define DEVNAME "usbkbd" 56 57 /* Keyboard maps */ 58 static const unsigned char usb_kbd_numkey[] = { 59 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', 60 '\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']', 61 '\\', '#', ';', '\'', '`', ',', '.', '/' 62 }; 63 static const unsigned char usb_kbd_numkey_shifted[] = { 64 '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', 65 '\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}', 66 '|', '~', ':', '"', '~', '<', '>', '?' 67 }; 68 69 static 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 75 /* 76 * 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 */ 80 static const unsigned char usb_kbd_arrow[] = { 81 0x6, 0x2, 0xe, 0x10 82 }; 83 84 /* 85 * 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) 92 93 #define USB_KBD_LEDMASK \ 94 (USB_KBD_NUMLOCK | USB_KBD_CAPSLOCK | USB_KBD_SCROLLLOCK) 95 96 /* 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 102 struct usb_kbd_pdata { 103 unsigned long intpipe; 104 int intpktsize; 105 int intinterval; 106 unsigned long last_report; 107 struct int_queue *intq; 108 109 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 115 uint8_t *new; 116 uint8_t old[USB_KBD_BOOT_REPORT_SIZE]; 117 118 uint8_t flags; 119 }; 120 121 extern int __maybe_unused net_busy_flag; 122 123 /* The period of time between two calls of usb_kbd_testc(). */ 124 static unsigned long __maybe_unused kbd_testc_tms; 125 126 /* Puts character in the queue and sets up the in and out pointer. */ 127 static 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 */ 151 static 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; 155 ALLOC_ALIGN_BUFFER(uint32_t, leds, 1, USB_DMA_MINALIGN); 156 157 *leds = data->flags & USB_KBD_LEDMASK; 158 usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 159 USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE, 160 0x200, iface->desc.bInterfaceNumber, leds, 1, 0); 161 } 162 163 #define CAPITAL_MASK 0x20 164 /* Translate the scancode in ASCII */ 165 static 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 208 /* Arrow keys */ 209 if ((scancode >= 0x4f) && (scancode <= 0x52)) 210 keycode = usb_kbd_arrow[scancode - 0x4f]; 211 212 /* Numeric keypad */ 213 if ((scancode >= 0x54) && (scancode <= 0x67)) 214 keycode = usb_kbd_num_keypad[scancode - 0x54]; 215 216 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) { 237 debug("%c", keycode); 238 usb_kbd_put_queue(data, keycode); 239 } 240 241 return 0; 242 } 243 244 static 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 259 if ((old[i] > 3) && 260 (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) == 261 new + USB_KBD_BOOT_REPORT_SIZE)) { 262 res |= usb_kbd_translate(data, old[i], data->new[0], up); 263 } 264 265 return res; 266 } 267 268 /* Interrupt service routine */ 269 static 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 281 for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) { 282 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 293 memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE); 294 295 return 1; 296 } 297 298 /* Keyboard interrupt handler */ 299 static int usb_kbd_irq(struct usb_device *dev) 300 { 301 if ((dev->irq_status != 0) || 302 (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) { 303 debug("USB KBD: Error %lX, len %d\n", 304 dev->irq_status, dev->irq_act_len); 305 return 1; 306 } 307 308 return usb_kbd_irq_worker(dev); 309 } 310 311 /* Interrupt polling */ 312 static inline void usb_kbd_poll_for_event(struct usb_device *dev) 313 { 314 #if defined(CONFIG_SYS_USB_EVENT_POLL) 315 struct usb_kbd_pdata *data = dev->privptr; 316 317 /* Submit a interrupt transfer request */ 318 usb_submit_int_msg(dev, data->intpipe, &data->new[0], data->intpktsize, 319 data->intinterval); 320 321 usb_kbd_irq_worker(dev); 322 #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) 325 struct usb_interface *iface; 326 struct usb_kbd_pdata *data = dev->privptr; 327 iface = &dev->config.if_desc[0]; 328 usb_get_report(dev, iface->desc.bInterfaceNumber, 329 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE); 330 if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE)) { 331 usb_kbd_irq_worker(dev); 332 #else 333 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, 339 USB_KBD_BOOT_REPORT_SIZE, data->new, 340 data->intinterval); 341 #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); 348 } 349 #endif 350 } 351 352 /* test if a character is in the queue */ 353 static int usb_kbd_testc(struct stdio_dev *sdev) 354 { 355 struct stdio_dev *dev; 356 struct usb_device *usb_kbd_dev; 357 struct usb_kbd_pdata *data; 358 359 #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 369 dev = stdio_get_by_name(DEVNAME); 370 usb_kbd_dev = (struct usb_device *)dev->priv; 371 data = usb_kbd_dev->privptr; 372 373 usb_kbd_poll_for_event(usb_kbd_dev); 374 375 return !(data->usb_in_pointer == data->usb_out_pointer); 376 } 377 378 /* gets the character from the queue */ 379 static int usb_kbd_getc(struct stdio_dev *sdev) 380 { 381 struct stdio_dev *dev; 382 struct usb_device *usb_kbd_dev; 383 struct usb_kbd_pdata *data; 384 385 dev = stdio_get_by_name(DEVNAME); 386 usb_kbd_dev = (struct usb_device *)dev->priv; 387 data = usb_kbd_dev->privptr; 388 389 while (data->usb_in_pointer == data->usb_out_pointer) 390 usb_kbd_poll_for_event(usb_kbd_dev); 391 392 if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1) 393 data->usb_out_pointer = 0; 394 else 395 data->usb_out_pointer++; 396 397 return data->usb_kbd_buffer[data->usb_out_pointer]; 398 } 399 400 /* probes the USB device dev for keyboard type. */ 401 static 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; 406 407 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 433 debug("USB KBD: found set protocol...\n"); 434 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 444 /* allocate input buffer aligned and sized to USB DMA alignment */ 445 data->new = memalign(USB_DMA_MINALIGN, 446 roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN)); 447 448 /* Insert private data into USB device structure */ 449 dev->privptr = data; 450 451 /* Set IRQ handler */ 452 dev->irq_handle = usb_kbd_irq; 453 454 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; 458 data->last_report = -1; 459 460 /* We found a USB Keyboard, install it. */ 461 usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0); 462 463 debug("USB KBD: found set idle...\n"); 464 #if !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) && \ 465 !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE) 466 usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE / 4, 0); 467 #else 468 usb_set_idle(dev, iface->desc.bInterfaceNumber, 0, 0); 469 #endif 470 471 debug("USB KBD: enable interrupt pipe...\n"); 472 #ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE 473 data->intq = create_int_queue(dev, data->intpipe, 1, 474 USB_KBD_BOOT_REPORT_SIZE, data->new, 475 data->intinterval); 476 if (!data->intq) { 477 #else 478 if (usb_submit_int_msg(dev, data->intpipe, data->new, data->intpktsize, 479 data->intinterval) < 0) { 480 #endif 481 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 } 486 487 /* Success. */ 488 return 1; 489 } 490 491 static 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 535 /* Search for keyboard and register it if found. */ 536 int drv_usb_kbd_init(void) 537 { 538 int error, i; 539 540 debug("%s: Probing for keyboard\n", __func__); 541 #ifdef CONFIG_DM_USB 542 /* 543 * TODO: We should add USB_DEVICE() declarations to each USB ethernet 544 * driver and then most of this file can be removed. 545 */ 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 */ 571 for (i = 0; i < USB_MAX_DEVICE; i++) { 572 struct usb_device *dev; 573 574 /* Get USB device. */ 575 dev = usb_get_dev_index(i); 576 if (!dev) 577 break; 578 579 if (dev->devnum == -1) 580 continue; 581 582 error = probe_usb_keyboard(dev); 583 if (!error) 584 return 1; 585 if (error && error != -ENOENT) 586 return error; 587 } 588 #endif 589 590 /* No USB Keyboard found */ 591 return -1; 592 } 593 594 /* Deregister the keyboard. */ 595 int usb_kbd_deregister(int force) 596 { 597 #ifdef CONFIG_SYS_STDIO_DEREGISTER 598 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; 608 #ifdef CONFIG_CONSOLE_MUX 609 if (iomux_doenv(stdin, getenv("stdin")) != 0) 610 return 1; 611 #endif 612 #ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE 613 destroy_int_queue(usb_kbd_dev, data->intq); 614 #endif 615 free(data->new); 616 free(data); 617 } 618 619 return 0; 620 #else 621 return 1; 622 #endif 623 } 624