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 <errno.h> 12 #include <malloc.h> 13 #include <stdio_dev.h> 14 #include <asm/byteorder.h> 15 16 #include <usb.h> 17 18 /* 19 * If overwrite_console returns 1, the stdin, stderr and stdout 20 * are switched to the serial port, else the settings in the 21 * environment are used 22 */ 23 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 24 extern int overwrite_console(void); 25 #else 26 int overwrite_console(void) 27 { 28 return 0; 29 } 30 #endif 31 32 /* Keyboard sampling rate */ 33 #define REPEAT_RATE (40 / 4) /* 40msec -> 25cps */ 34 #define REPEAT_DELAY 10 /* 10 x REPEAT_RATE = 400msec */ 35 36 #define NUM_LOCK 0x53 37 #define CAPS_LOCK 0x39 38 #define SCROLL_LOCK 0x47 39 40 /* Modifier bits */ 41 #define LEFT_CNTR (1 << 0) 42 #define LEFT_SHIFT (1 << 1) 43 #define LEFT_ALT (1 << 2) 44 #define LEFT_GUI (1 << 3) 45 #define RIGHT_CNTR (1 << 4) 46 #define RIGHT_SHIFT (1 << 5) 47 #define RIGHT_ALT (1 << 6) 48 #define RIGHT_GUI (1 << 7) 49 50 /* Size of the keyboard buffer */ 51 #define USB_KBD_BUFFER_LEN 0x20 52 53 /* Device name */ 54 #define DEVNAME "usbkbd" 55 56 /* Keyboard maps */ 57 static const unsigned char usb_kbd_numkey[] = { 58 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', 59 '\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']', 60 '\\', '#', ';', '\'', '`', ',', '.', '/' 61 }; 62 static const unsigned char usb_kbd_numkey_shifted[] = { 63 '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', 64 '\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}', 65 '|', '~', ':', '"', '~', '<', '>', '?' 66 }; 67 68 static const unsigned char usb_kbd_num_keypad[] = { 69 '/', '*', '-', '+', '\r', 70 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', 71 '.', 0, 0, 0, '=' 72 }; 73 74 /* 75 * map arrow keys to ^F/^B ^N/^P, can't really use the proper 76 * ANSI sequence for arrow keys because the queuing code breaks 77 * when a single keypress expands to 3 queue elements 78 */ 79 static const unsigned char usb_kbd_arrow[] = { 80 0x6, 0x2, 0xe, 0x10 81 }; 82 83 /* 84 * NOTE: It's important for the NUM, CAPS, SCROLL-lock bits to be in this 85 * order. See usb_kbd_setled() function! 86 */ 87 #define USB_KBD_NUMLOCK (1 << 0) 88 #define USB_KBD_CAPSLOCK (1 << 1) 89 #define USB_KBD_SCROLLLOCK (1 << 2) 90 #define USB_KBD_CTRL (1 << 3) 91 92 #define USB_KBD_LEDMASK \ 93 (USB_KBD_NUMLOCK | USB_KBD_CAPSLOCK | USB_KBD_SCROLLLOCK) 94 95 /* 96 * USB Keyboard reports are 8 bytes in boot protocol. 97 * Appendix B of HID Device Class Definition 1.11 98 */ 99 #define USB_KBD_BOOT_REPORT_SIZE 8 100 101 struct usb_kbd_pdata { 102 unsigned long intpipe; 103 int intpktsize; 104 int intinterval; 105 struct int_queue *intq; 106 107 uint32_t repeat_delay; 108 109 uint32_t usb_in_pointer; 110 uint32_t usb_out_pointer; 111 uint8_t usb_kbd_buffer[USB_KBD_BUFFER_LEN]; 112 113 uint8_t *new; 114 uint8_t old[USB_KBD_BOOT_REPORT_SIZE]; 115 116 uint8_t flags; 117 }; 118 119 extern int __maybe_unused net_busy_flag; 120 121 /* The period of time between two calls of usb_kbd_testc(). */ 122 static unsigned long __maybe_unused kbd_testc_tms; 123 124 /* Puts character in the queue and sets up the in and out pointer. */ 125 static void usb_kbd_put_queue(struct usb_kbd_pdata *data, char c) 126 { 127 if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) { 128 /* Check for buffer full. */ 129 if (data->usb_out_pointer == 0) 130 return; 131 132 data->usb_in_pointer = 0; 133 } else { 134 /* Check for buffer full. */ 135 if (data->usb_in_pointer == data->usb_out_pointer - 1) 136 return; 137 138 data->usb_in_pointer++; 139 } 140 141 data->usb_kbd_buffer[data->usb_in_pointer] = c; 142 } 143 144 /* 145 * Set the LEDs. Since this is used in the irq routine, the control job is 146 * issued with a timeout of 0. This means, that the job is queued without 147 * waiting for job completion. 148 */ 149 static void usb_kbd_setled(struct usb_device *dev) 150 { 151 struct usb_interface *iface = &dev->config.if_desc[0]; 152 struct usb_kbd_pdata *data = dev->privptr; 153 ALLOC_ALIGN_BUFFER(uint32_t, leds, 1, USB_DMA_MINALIGN); 154 155 *leds = data->flags & USB_KBD_LEDMASK; 156 usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 157 USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE, 158 0x200, iface->desc.bInterfaceNumber, leds, 1, 0); 159 } 160 161 #define CAPITAL_MASK 0x20 162 /* Translate the scancode in ASCII */ 163 static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode, 164 unsigned char modifier, int pressed) 165 { 166 uint8_t keycode = 0; 167 168 /* Key released */ 169 if (pressed == 0) { 170 data->repeat_delay = 0; 171 return 0; 172 } 173 174 if (pressed == 2) { 175 data->repeat_delay++; 176 if (data->repeat_delay < REPEAT_DELAY) 177 return 0; 178 179 data->repeat_delay = REPEAT_DELAY; 180 } 181 182 /* Alphanumeric values */ 183 if ((scancode > 3) && (scancode <= 0x1d)) { 184 keycode = scancode - 4 + 'a'; 185 186 if (data->flags & USB_KBD_CAPSLOCK) 187 keycode &= ~CAPITAL_MASK; 188 189 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) { 190 /* Handle CAPSLock + Shift pressed simultaneously */ 191 if (keycode & CAPITAL_MASK) 192 keycode &= ~CAPITAL_MASK; 193 else 194 keycode |= CAPITAL_MASK; 195 } 196 } 197 198 if ((scancode > 0x1d) && (scancode < 0x3a)) { 199 /* Shift pressed */ 200 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) 201 keycode = usb_kbd_numkey_shifted[scancode - 0x1e]; 202 else 203 keycode = usb_kbd_numkey[scancode - 0x1e]; 204 } 205 206 /* Arrow keys */ 207 if ((scancode >= 0x4f) && (scancode <= 0x52)) 208 keycode = usb_kbd_arrow[scancode - 0x4f]; 209 210 /* Numeric keypad */ 211 if ((scancode >= 0x54) && (scancode <= 0x67)) 212 keycode = usb_kbd_num_keypad[scancode - 0x54]; 213 214 if (data->flags & USB_KBD_CTRL) 215 keycode = scancode - 0x3; 216 217 if (pressed == 1) { 218 if (scancode == NUM_LOCK) { 219 data->flags ^= USB_KBD_NUMLOCK; 220 return 1; 221 } 222 223 if (scancode == CAPS_LOCK) { 224 data->flags ^= USB_KBD_CAPSLOCK; 225 return 1; 226 } 227 if (scancode == SCROLL_LOCK) { 228 data->flags ^= USB_KBD_SCROLLLOCK; 229 return 1; 230 } 231 } 232 233 /* Report keycode if any */ 234 if (keycode) { 235 debug("%c", keycode); 236 usb_kbd_put_queue(data, keycode); 237 } 238 239 return 0; 240 } 241 242 static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up) 243 { 244 uint32_t res = 0; 245 struct usb_kbd_pdata *data = dev->privptr; 246 uint8_t *new; 247 uint8_t *old; 248 249 if (up) { 250 new = data->old; 251 old = data->new; 252 } else { 253 new = data->new; 254 old = data->old; 255 } 256 257 if ((old[i] > 3) && 258 (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) == 259 new + USB_KBD_BOOT_REPORT_SIZE)) { 260 res |= usb_kbd_translate(data, old[i], data->new[0], up); 261 } 262 263 return res; 264 } 265 266 /* Interrupt service routine */ 267 static int usb_kbd_irq_worker(struct usb_device *dev) 268 { 269 struct usb_kbd_pdata *data = dev->privptr; 270 int i, res = 0; 271 272 /* No combo key pressed */ 273 if (data->new[0] == 0x00) 274 data->flags &= ~USB_KBD_CTRL; 275 /* Left or Right Ctrl pressed */ 276 else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR)) 277 data->flags |= USB_KBD_CTRL; 278 279 for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) { 280 res |= usb_kbd_service_key(dev, i, 0); 281 res |= usb_kbd_service_key(dev, i, 1); 282 } 283 284 /* Key is still pressed */ 285 if ((data->new[2] > 3) && (data->old[2] == data->new[2])) 286 res |= usb_kbd_translate(data, data->new[2], data->new[0], 2); 287 288 if (res == 1) 289 usb_kbd_setled(dev); 290 291 memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE); 292 293 return 1; 294 } 295 296 /* Keyboard interrupt handler */ 297 static int usb_kbd_irq(struct usb_device *dev) 298 { 299 if ((dev->irq_status != 0) || 300 (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) { 301 debug("USB KBD: Error %lX, len %d\n", 302 dev->irq_status, dev->irq_act_len); 303 return 1; 304 } 305 306 return usb_kbd_irq_worker(dev); 307 } 308 309 /* Interrupt polling */ 310 static inline void usb_kbd_poll_for_event(struct usb_device *dev) 311 { 312 #if defined(CONFIG_SYS_USB_EVENT_POLL) 313 struct usb_kbd_pdata *data = dev->privptr; 314 315 /* Submit a interrupt transfer request */ 316 usb_submit_int_msg(dev, data->intpipe, &data->new[0], data->intpktsize, 317 data->intinterval); 318 319 usb_kbd_irq_worker(dev); 320 #elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) 321 struct usb_interface *iface; 322 struct usb_kbd_pdata *data = dev->privptr; 323 iface = &dev->config.if_desc[0]; 324 usb_get_report(dev, iface->desc.bInterfaceNumber, 325 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE); 326 if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE)) 327 usb_kbd_irq_worker(dev); 328 #elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE) 329 struct usb_kbd_pdata *data = dev->privptr; 330 if (poll_int_queue(dev, data->intq)) { 331 usb_kbd_irq_worker(dev); 332 /* We've consumed all queued int packets, create new */ 333 destroy_int_queue(dev, data->intq); 334 data->intq = create_int_queue(dev, data->intpipe, 1, 335 USB_KBD_BOOT_REPORT_SIZE, data->new, 336 data->intinterval); 337 } 338 #endif 339 } 340 341 /* test if a character is in the queue */ 342 static int usb_kbd_testc(struct stdio_dev *sdev) 343 { 344 struct stdio_dev *dev; 345 struct usb_device *usb_kbd_dev; 346 struct usb_kbd_pdata *data; 347 348 #ifdef CONFIG_CMD_NET 349 /* 350 * If net_busy_flag is 1, NET transfer is running, 351 * then we check key-pressed every second (first check may be 352 * less than 1 second) to improve TFTP booting performance. 353 */ 354 if (net_busy_flag && (get_timer(kbd_testc_tms) < CONFIG_SYS_HZ)) 355 return 0; 356 kbd_testc_tms = get_timer(0); 357 #endif 358 dev = stdio_get_by_name(DEVNAME); 359 usb_kbd_dev = (struct usb_device *)dev->priv; 360 data = usb_kbd_dev->privptr; 361 362 usb_kbd_poll_for_event(usb_kbd_dev); 363 364 return !(data->usb_in_pointer == data->usb_out_pointer); 365 } 366 367 /* gets the character from the queue */ 368 static int usb_kbd_getc(struct stdio_dev *sdev) 369 { 370 struct stdio_dev *dev; 371 struct usb_device *usb_kbd_dev; 372 struct usb_kbd_pdata *data; 373 374 dev = stdio_get_by_name(DEVNAME); 375 usb_kbd_dev = (struct usb_device *)dev->priv; 376 data = usb_kbd_dev->privptr; 377 378 while (data->usb_in_pointer == data->usb_out_pointer) 379 usb_kbd_poll_for_event(usb_kbd_dev); 380 381 if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1) 382 data->usb_out_pointer = 0; 383 else 384 data->usb_out_pointer++; 385 386 return data->usb_kbd_buffer[data->usb_out_pointer]; 387 } 388 389 /* probes the USB device dev for keyboard type. */ 390 static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum) 391 { 392 struct usb_interface *iface; 393 struct usb_endpoint_descriptor *ep; 394 struct usb_kbd_pdata *data; 395 396 if (dev->descriptor.bNumConfigurations != 1) 397 return 0; 398 399 iface = &dev->config.if_desc[ifnum]; 400 401 if (iface->desc.bInterfaceClass != 3) 402 return 0; 403 404 if (iface->desc.bInterfaceSubClass != 1) 405 return 0; 406 407 if (iface->desc.bInterfaceProtocol != 1) 408 return 0; 409 410 if (iface->desc.bNumEndpoints != 1) 411 return 0; 412 413 ep = &iface->ep_desc[0]; 414 415 /* Check if endpoint 1 is interrupt endpoint */ 416 if (!(ep->bEndpointAddress & 0x80)) 417 return 0; 418 419 if ((ep->bmAttributes & 3) != 3) 420 return 0; 421 422 debug("USB KBD: found set protocol...\n"); 423 424 data = malloc(sizeof(struct usb_kbd_pdata)); 425 if (!data) { 426 printf("USB KBD: Error allocating private data\n"); 427 return 0; 428 } 429 430 /* Clear private data */ 431 memset(data, 0, sizeof(struct usb_kbd_pdata)); 432 433 /* allocate input buffer aligned and sized to USB DMA alignment */ 434 data->new = memalign(USB_DMA_MINALIGN, 435 roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN)); 436 437 /* Insert private data into USB device structure */ 438 dev->privptr = data; 439 440 /* Set IRQ handler */ 441 dev->irq_handle = usb_kbd_irq; 442 443 data->intpipe = usb_rcvintpipe(dev, ep->bEndpointAddress); 444 data->intpktsize = min(usb_maxpacket(dev, data->intpipe), 445 USB_KBD_BOOT_REPORT_SIZE); 446 data->intinterval = ep->bInterval; 447 448 /* We found a USB Keyboard, install it. */ 449 usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0); 450 451 debug("USB KBD: found set idle...\n"); 452 usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE, 0); 453 454 debug("USB KBD: enable interrupt pipe...\n"); 455 #ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE 456 data->intq = create_int_queue(dev, data->intpipe, 1, 457 USB_KBD_BOOT_REPORT_SIZE, data->new, 458 data->intinterval); 459 if (!data->intq) { 460 #else 461 if (usb_submit_int_msg(dev, data->intpipe, data->new, data->intpktsize, 462 data->intinterval) < 0) { 463 #endif 464 printf("Failed to get keyboard state from device %04x:%04x\n", 465 dev->descriptor.idVendor, dev->descriptor.idProduct); 466 /* Abort, we don't want to use that non-functional keyboard. */ 467 return 0; 468 } 469 470 /* Success. */ 471 return 1; 472 } 473 474 /* Search for keyboard and register it if found. */ 475 int drv_usb_kbd_init(void) 476 { 477 struct stdio_dev usb_kbd_dev; 478 struct usb_device *dev; 479 char *stdinname = getenv("stdin"); 480 int error, i; 481 482 /* Scan all USB Devices */ 483 for (i = 0; i < USB_MAX_DEVICE; i++) { 484 /* Get USB device. */ 485 dev = usb_get_dev_index(i); 486 if (!dev) 487 return -1; 488 489 if (dev->devnum == -1) 490 continue; 491 492 /* Try probing the keyboard */ 493 if (usb_kbd_probe(dev, 0) != 1) 494 continue; 495 496 /* Register the keyboard */ 497 debug("USB KBD: register.\n"); 498 memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev)); 499 strcpy(usb_kbd_dev.name, DEVNAME); 500 usb_kbd_dev.flags = DEV_FLAGS_INPUT | DEV_FLAGS_SYSTEM; 501 usb_kbd_dev.getc = usb_kbd_getc; 502 usb_kbd_dev.tstc = usb_kbd_testc; 503 usb_kbd_dev.priv = (void *)dev; 504 error = stdio_register(&usb_kbd_dev); 505 if (error) 506 return error; 507 508 #ifdef CONFIG_CONSOLE_MUX 509 error = iomux_doenv(stdin, stdinname); 510 if (error) 511 return error; 512 #else 513 /* Check if this is the standard input device. */ 514 if (strcmp(stdinname, DEVNAME)) 515 return 1; 516 517 /* Reassign the console */ 518 if (overwrite_console()) 519 return 1; 520 521 error = console_assign(stdin, DEVNAME); 522 if (error) 523 return error; 524 #endif 525 526 return 1; 527 } 528 529 /* No USB Keyboard found */ 530 return -1; 531 } 532 533 /* Deregister the keyboard. */ 534 int usb_kbd_deregister(int force) 535 { 536 #ifdef CONFIG_SYS_STDIO_DEREGISTER 537 struct stdio_dev *dev; 538 struct usb_device *usb_kbd_dev; 539 struct usb_kbd_pdata *data; 540 541 dev = stdio_get_by_name(DEVNAME); 542 if (dev) { 543 usb_kbd_dev = (struct usb_device *)dev->priv; 544 data = usb_kbd_dev->privptr; 545 if (stdio_deregister_dev(dev, force) != 0) 546 return 1; 547 #ifdef CONFIG_CONSOLE_MUX 548 if (iomux_doenv(stdin, getenv("stdin")) != 0) 549 return 1; 550 #endif 551 #ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE 552 destroy_int_queue(usb_kbd_dev, data->intq); 553 #endif 554 free(data->new); 555 free(data); 556 } 557 558 return 0; 559 #else 560 return 1; 561 #endif 562 } 563