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 / 4) /* 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 struct int_queue *intq; 107 108 uint32_t repeat_delay; 109 110 uint32_t usb_in_pointer; 111 uint32_t usb_out_pointer; 112 uint8_t usb_kbd_buffer[USB_KBD_BUFFER_LEN]; 113 114 uint8_t *new; 115 uint8_t old[USB_KBD_BOOT_REPORT_SIZE]; 116 117 uint8_t flags; 118 }; 119 120 extern int __maybe_unused net_busy_flag; 121 122 /* The period of time between two calls of usb_kbd_testc(). */ 123 static unsigned long __maybe_unused kbd_testc_tms; 124 125 /* Puts character in the queue and sets up the in and out pointer. */ 126 static void usb_kbd_put_queue(struct usb_kbd_pdata *data, char c) 127 { 128 if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) { 129 /* Check for buffer full. */ 130 if (data->usb_out_pointer == 0) 131 return; 132 133 data->usb_in_pointer = 0; 134 } else { 135 /* Check for buffer full. */ 136 if (data->usb_in_pointer == data->usb_out_pointer - 1) 137 return; 138 139 data->usb_in_pointer++; 140 } 141 142 data->usb_kbd_buffer[data->usb_in_pointer] = c; 143 } 144 145 /* 146 * Set the LEDs. Since this is used in the irq routine, the control job is 147 * issued with a timeout of 0. This means, that the job is queued without 148 * waiting for job completion. 149 */ 150 static void usb_kbd_setled(struct usb_device *dev) 151 { 152 struct usb_interface *iface = &dev->config.if_desc[0]; 153 struct usb_kbd_pdata *data = dev->privptr; 154 ALLOC_ALIGN_BUFFER(uint32_t, leds, 1, USB_DMA_MINALIGN); 155 156 *leds = data->flags & USB_KBD_LEDMASK; 157 usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 158 USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE, 159 0x200, iface->desc.bInterfaceNumber, leds, 1, 0); 160 } 161 162 #define CAPITAL_MASK 0x20 163 /* Translate the scancode in ASCII */ 164 static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode, 165 unsigned char modifier, int pressed) 166 { 167 uint8_t keycode = 0; 168 169 /* Key released */ 170 if (pressed == 0) { 171 data->repeat_delay = 0; 172 return 0; 173 } 174 175 if (pressed == 2) { 176 data->repeat_delay++; 177 if (data->repeat_delay < REPEAT_DELAY) 178 return 0; 179 180 data->repeat_delay = REPEAT_DELAY; 181 } 182 183 /* Alphanumeric values */ 184 if ((scancode > 3) && (scancode <= 0x1d)) { 185 keycode = scancode - 4 + 'a'; 186 187 if (data->flags & USB_KBD_CAPSLOCK) 188 keycode &= ~CAPITAL_MASK; 189 190 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) { 191 /* Handle CAPSLock + Shift pressed simultaneously */ 192 if (keycode & CAPITAL_MASK) 193 keycode &= ~CAPITAL_MASK; 194 else 195 keycode |= CAPITAL_MASK; 196 } 197 } 198 199 if ((scancode > 0x1d) && (scancode < 0x3a)) { 200 /* Shift pressed */ 201 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) 202 keycode = usb_kbd_numkey_shifted[scancode - 0x1e]; 203 else 204 keycode = usb_kbd_numkey[scancode - 0x1e]; 205 } 206 207 /* Arrow keys */ 208 if ((scancode >= 0x4f) && (scancode <= 0x52)) 209 keycode = usb_kbd_arrow[scancode - 0x4f]; 210 211 /* Numeric keypad */ 212 if ((scancode >= 0x54) && (scancode <= 0x67)) 213 keycode = usb_kbd_num_keypad[scancode - 0x54]; 214 215 if (data->flags & USB_KBD_CTRL) 216 keycode = scancode - 0x3; 217 218 if (pressed == 1) { 219 if (scancode == NUM_LOCK) { 220 data->flags ^= USB_KBD_NUMLOCK; 221 return 1; 222 } 223 224 if (scancode == CAPS_LOCK) { 225 data->flags ^= USB_KBD_CAPSLOCK; 226 return 1; 227 } 228 if (scancode == SCROLL_LOCK) { 229 data->flags ^= USB_KBD_SCROLLLOCK; 230 return 1; 231 } 232 } 233 234 /* Report keycode if any */ 235 if (keycode) { 236 debug("%c", keycode); 237 usb_kbd_put_queue(data, keycode); 238 } 239 240 return 0; 241 } 242 243 static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up) 244 { 245 uint32_t res = 0; 246 struct usb_kbd_pdata *data = dev->privptr; 247 uint8_t *new; 248 uint8_t *old; 249 250 if (up) { 251 new = data->old; 252 old = data->new; 253 } else { 254 new = data->new; 255 old = data->old; 256 } 257 258 if ((old[i] > 3) && 259 (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) == 260 new + USB_KBD_BOOT_REPORT_SIZE)) { 261 res |= usb_kbd_translate(data, old[i], data->new[0], up); 262 } 263 264 return res; 265 } 266 267 /* Interrupt service routine */ 268 static int usb_kbd_irq_worker(struct usb_device *dev) 269 { 270 struct usb_kbd_pdata *data = dev->privptr; 271 int i, res = 0; 272 273 /* No combo key pressed */ 274 if (data->new[0] == 0x00) 275 data->flags &= ~USB_KBD_CTRL; 276 /* Left or Right Ctrl pressed */ 277 else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR)) 278 data->flags |= USB_KBD_CTRL; 279 280 for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) { 281 res |= usb_kbd_service_key(dev, i, 0); 282 res |= usb_kbd_service_key(dev, i, 1); 283 } 284 285 /* Key is still pressed */ 286 if ((data->new[2] > 3) && (data->old[2] == data->new[2])) 287 res |= usb_kbd_translate(data, data->new[2], data->new[0], 2); 288 289 if (res == 1) 290 usb_kbd_setled(dev); 291 292 memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE); 293 294 return 1; 295 } 296 297 /* Keyboard interrupt handler */ 298 static int usb_kbd_irq(struct usb_device *dev) 299 { 300 if ((dev->irq_status != 0) || 301 (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) { 302 debug("USB KBD: Error %lX, len %d\n", 303 dev->irq_status, dev->irq_act_len); 304 return 1; 305 } 306 307 return usb_kbd_irq_worker(dev); 308 } 309 310 /* Interrupt polling */ 311 static inline void usb_kbd_poll_for_event(struct usb_device *dev) 312 { 313 #if defined(CONFIG_SYS_USB_EVENT_POLL) 314 struct usb_kbd_pdata *data = dev->privptr; 315 316 /* Submit a interrupt transfer request */ 317 usb_submit_int_msg(dev, data->intpipe, &data->new[0], data->intpktsize, 318 data->intinterval); 319 320 usb_kbd_irq_worker(dev); 321 #elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) 322 struct usb_interface *iface; 323 struct usb_kbd_pdata *data = dev->privptr; 324 iface = &dev->config.if_desc[0]; 325 usb_get_report(dev, iface->desc.bInterfaceNumber, 326 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE); 327 if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE)) 328 usb_kbd_irq_worker(dev); 329 #elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE) 330 struct usb_kbd_pdata *data = dev->privptr; 331 if (poll_int_queue(dev, data->intq)) { 332 usb_kbd_irq_worker(dev); 333 /* We've consumed all queued int packets, create new */ 334 destroy_int_queue(dev, data->intq); 335 data->intq = create_int_queue(dev, data->intpipe, 1, 336 USB_KBD_BOOT_REPORT_SIZE, data->new, 337 data->intinterval); 338 } 339 #endif 340 } 341 342 /* test if a character is in the queue */ 343 static int usb_kbd_testc(struct stdio_dev *sdev) 344 { 345 struct stdio_dev *dev; 346 struct usb_device *usb_kbd_dev; 347 struct usb_kbd_pdata *data; 348 349 #ifdef CONFIG_CMD_NET 350 /* 351 * If net_busy_flag is 1, NET transfer is running, 352 * then we check key-pressed every second (first check may be 353 * less than 1 second) to improve TFTP booting performance. 354 */ 355 if (net_busy_flag && (get_timer(kbd_testc_tms) < CONFIG_SYS_HZ)) 356 return 0; 357 kbd_testc_tms = get_timer(0); 358 #endif 359 dev = stdio_get_by_name(DEVNAME); 360 usb_kbd_dev = (struct usb_device *)dev->priv; 361 data = usb_kbd_dev->privptr; 362 363 usb_kbd_poll_for_event(usb_kbd_dev); 364 365 return !(data->usb_in_pointer == data->usb_out_pointer); 366 } 367 368 /* gets the character from the queue */ 369 static int usb_kbd_getc(struct stdio_dev *sdev) 370 { 371 struct stdio_dev *dev; 372 struct usb_device *usb_kbd_dev; 373 struct usb_kbd_pdata *data; 374 375 dev = stdio_get_by_name(DEVNAME); 376 usb_kbd_dev = (struct usb_device *)dev->priv; 377 data = usb_kbd_dev->privptr; 378 379 while (data->usb_in_pointer == data->usb_out_pointer) 380 usb_kbd_poll_for_event(usb_kbd_dev); 381 382 if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1) 383 data->usb_out_pointer = 0; 384 else 385 data->usb_out_pointer++; 386 387 return data->usb_kbd_buffer[data->usb_out_pointer]; 388 } 389 390 /* probes the USB device dev for keyboard type. */ 391 static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum) 392 { 393 struct usb_interface *iface; 394 struct usb_endpoint_descriptor *ep; 395 struct usb_kbd_pdata *data; 396 397 if (dev->descriptor.bNumConfigurations != 1) 398 return 0; 399 400 iface = &dev->config.if_desc[ifnum]; 401 402 if (iface->desc.bInterfaceClass != 3) 403 return 0; 404 405 if (iface->desc.bInterfaceSubClass != 1) 406 return 0; 407 408 if (iface->desc.bInterfaceProtocol != 1) 409 return 0; 410 411 if (iface->desc.bNumEndpoints != 1) 412 return 0; 413 414 ep = &iface->ep_desc[0]; 415 416 /* Check if endpoint 1 is interrupt endpoint */ 417 if (!(ep->bEndpointAddress & 0x80)) 418 return 0; 419 420 if ((ep->bmAttributes & 3) != 3) 421 return 0; 422 423 debug("USB KBD: found set protocol...\n"); 424 425 data = malloc(sizeof(struct usb_kbd_pdata)); 426 if (!data) { 427 printf("USB KBD: Error allocating private data\n"); 428 return 0; 429 } 430 431 /* Clear private data */ 432 memset(data, 0, sizeof(struct usb_kbd_pdata)); 433 434 /* allocate input buffer aligned and sized to USB DMA alignment */ 435 data->new = memalign(USB_DMA_MINALIGN, 436 roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN)); 437 438 /* Insert private data into USB device structure */ 439 dev->privptr = data; 440 441 /* Set IRQ handler */ 442 dev->irq_handle = usb_kbd_irq; 443 444 data->intpipe = usb_rcvintpipe(dev, ep->bEndpointAddress); 445 data->intpktsize = min(usb_maxpacket(dev, data->intpipe), 446 USB_KBD_BOOT_REPORT_SIZE); 447 data->intinterval = ep->bInterval; 448 449 /* We found a USB Keyboard, install it. */ 450 usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0); 451 452 debug("USB KBD: found set idle...\n"); 453 usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE, 0); 454 455 debug("USB KBD: enable interrupt pipe...\n"); 456 #ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE 457 data->intq = create_int_queue(dev, data->intpipe, 1, 458 USB_KBD_BOOT_REPORT_SIZE, data->new, 459 data->intinterval); 460 if (!data->intq) { 461 #else 462 if (usb_submit_int_msg(dev, data->intpipe, data->new, data->intpktsize, 463 data->intinterval) < 0) { 464 #endif 465 printf("Failed to get keyboard state from device %04x:%04x\n", 466 dev->descriptor.idVendor, dev->descriptor.idProduct); 467 /* Abort, we don't want to use that non-functional keyboard. */ 468 return 0; 469 } 470 471 /* Success. */ 472 return 1; 473 } 474 475 static int probe_usb_keyboard(struct usb_device *dev) 476 { 477 char *stdinname; 478 struct stdio_dev usb_kbd_dev; 479 int error; 480 481 /* Try probing the keyboard */ 482 if (usb_kbd_probe(dev, 0) != 1) 483 return -ENOENT; 484 485 /* Register the keyboard */ 486 debug("USB KBD: register.\n"); 487 memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev)); 488 strcpy(usb_kbd_dev.name, DEVNAME); 489 usb_kbd_dev.flags = DEV_FLAGS_INPUT | DEV_FLAGS_SYSTEM; 490 usb_kbd_dev.getc = usb_kbd_getc; 491 usb_kbd_dev.tstc = usb_kbd_testc; 492 usb_kbd_dev.priv = (void *)dev; 493 error = stdio_register(&usb_kbd_dev); 494 if (error) 495 return error; 496 497 stdinname = getenv("stdin"); 498 #ifdef CONFIG_CONSOLE_MUX 499 error = iomux_doenv(stdin, stdinname); 500 if (error) 501 return error; 502 #else 503 /* Check if this is the standard input device. */ 504 if (strcmp(stdinname, DEVNAME)) 505 return 1; 506 507 /* Reassign the console */ 508 if (overwrite_console()) 509 return 1; 510 511 error = console_assign(stdin, DEVNAME); 512 if (error) 513 return error; 514 #endif 515 516 return 0; 517 } 518 519 /* Search for keyboard and register it if found. */ 520 int drv_usb_kbd_init(void) 521 { 522 int error, i; 523 524 debug("%s: Probing for keyboard\n", __func__); 525 #ifdef CONFIG_DM_USB 526 /* 527 * TODO: We should add USB_DEVICE() declarations to each USB ethernet 528 * driver and then most of this file can be removed. 529 */ 530 struct udevice *bus; 531 struct uclass *uc; 532 int ret; 533 534 ret = uclass_get(UCLASS_USB, &uc); 535 if (ret) 536 return ret; 537 uclass_foreach_dev(bus, uc) { 538 for (i = 0; i < USB_MAX_DEVICE; i++) { 539 struct usb_device *dev; 540 541 dev = usb_get_dev_index(bus, i); /* get device */ 542 debug("i=%d, %p\n", i, dev); 543 if (!dev) 544 break; /* no more devices available */ 545 546 error = probe_usb_keyboard(dev); 547 if (!error) 548 return 1; 549 if (error && error != -ENOENT) 550 return error; 551 } /* for */ 552 } 553 #else 554 /* Scan all USB Devices */ 555 for (i = 0; i < USB_MAX_DEVICE; i++) { 556 struct usb_device *dev; 557 558 /* Get USB device. */ 559 dev = usb_get_dev_index(i); 560 if (!dev) 561 break; 562 563 if (dev->devnum == -1) 564 continue; 565 566 error = probe_usb_keyboard(dev); 567 if (!error) 568 return 1; 569 if (error && error != -ENOENT) 570 return error; 571 } 572 #endif 573 574 /* No USB Keyboard found */ 575 return -1; 576 } 577 578 /* Deregister the keyboard. */ 579 int usb_kbd_deregister(int force) 580 { 581 #ifdef CONFIG_SYS_STDIO_DEREGISTER 582 struct stdio_dev *dev; 583 struct usb_device *usb_kbd_dev; 584 struct usb_kbd_pdata *data; 585 586 dev = stdio_get_by_name(DEVNAME); 587 if (dev) { 588 usb_kbd_dev = (struct usb_device *)dev->priv; 589 data = usb_kbd_dev->privptr; 590 if (stdio_deregister_dev(dev, force) != 0) 591 return 1; 592 #ifdef CONFIG_CONSOLE_MUX 593 if (iomux_doenv(stdin, getenv("stdin")) != 0) 594 return 1; 595 #endif 596 #ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE 597 destroy_int_queue(usb_kbd_dev, data->intq); 598 #endif 599 free(data->new); 600 free(data); 601 } 602 603 return 0; 604 #else 605 return 1; 606 #endif 607 } 608