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 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 118 extern int __maybe_unused net_busy_flag; 119 120 /* The period of time between two calls of usb_kbd_testc(). */ 121 static unsigned long __maybe_unused kbd_testc_tms; 122 123 /* Puts character in the queue and sets up the in and out pointer. */ 124 static void usb_kbd_put_queue(struct usb_kbd_pdata *data, char c) 125 { 126 if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) { 127 /* Check for buffer full. */ 128 if (data->usb_out_pointer == 0) 129 return; 130 131 data->usb_in_pointer = 0; 132 } else { 133 /* Check for buffer full. */ 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 * Set the LEDs. Since this is used in the irq routine, the control job is 145 * issued with a timeout of 0. This means, that the job is queued without 146 * waiting for job completion. 147 */ 148 static 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 /* Translate the scancode in ASCII */ 162 static 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 /* Key released */ 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 /* Alphanumeric values */ 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 /* Handle CAPSLock + Shift pressed simultaneously */ 190 if (keycode & CAPITAL_MASK) 191 keycode &= ~CAPITAL_MASK; 192 else 193 keycode |= CAPITAL_MASK; 194 } 195 } 196 197 if ((scancode > 0x1d) && (scancode < 0x3a)) { 198 /* Shift pressed */ 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 /* Arrow keys */ 206 if ((scancode >= 0x4f) && (scancode <= 0x52)) 207 keycode = usb_kbd_arrow[scancode - 0x4f]; 208 209 /* Numeric keypad */ 210 if ((scancode >= 0x54) && (scancode <= 0x67)) 211 keycode = usb_kbd_num_keypad[scancode - 0x54]; 212 213 if (data->flags & USB_KBD_CTRL) 214 keycode = scancode - 0x3; 215 216 if (pressed == 1) { 217 if (scancode == NUM_LOCK) { 218 data->flags ^= USB_KBD_NUMLOCK; 219 return 1; 220 } 221 222 if (scancode == CAPS_LOCK) { 223 data->flags ^= USB_KBD_CAPSLOCK; 224 return 1; 225 } 226 if (scancode == SCROLL_LOCK) { 227 data->flags ^= USB_KBD_SCROLLLOCK; 228 return 1; 229 } 230 } 231 232 /* Report keycode if any */ 233 if (keycode) { 234 debug("%c", keycode); 235 usb_kbd_put_queue(data, keycode); 236 } 237 238 return 0; 239 } 240 241 static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up) 242 { 243 uint32_t res = 0; 244 struct usb_kbd_pdata *data = dev->privptr; 245 uint8_t *new; 246 uint8_t *old; 247 248 if (up) { 249 new = data->old; 250 old = data->new; 251 } else { 252 new = data->new; 253 old = data->old; 254 } 255 256 if ((old[i] > 3) && 257 (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) == 258 new + USB_KBD_BOOT_REPORT_SIZE)) { 259 res |= usb_kbd_translate(data, old[i], data->new[0], up); 260 } 261 262 return res; 263 } 264 265 /* Interrupt service routine */ 266 static int usb_kbd_irq_worker(struct usb_device *dev) 267 { 268 struct usb_kbd_pdata *data = dev->privptr; 269 int i, res = 0; 270 271 /* No combo key pressed */ 272 if (data->new[0] == 0x00) 273 data->flags &= ~USB_KBD_CTRL; 274 /* Left or Right Ctrl pressed */ 275 else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR)) 276 data->flags |= USB_KBD_CTRL; 277 278 for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) { 279 res |= usb_kbd_service_key(dev, i, 0); 280 res |= usb_kbd_service_key(dev, i, 1); 281 } 282 283 /* Key is still pressed */ 284 if ((data->new[2] > 3) && (data->old[2] == data->new[2])) 285 res |= usb_kbd_translate(data, data->new[2], data->new[0], 2); 286 287 if (res == 1) 288 usb_kbd_setled(dev); 289 290 memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE); 291 292 return 1; 293 } 294 295 /* Keyboard interrupt handler */ 296 static int usb_kbd_irq(struct usb_device *dev) 297 { 298 if ((dev->irq_status != 0) || 299 (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) { 300 debug("USB KBD: Error %lX, len %d\n", 301 dev->irq_status, dev->irq_act_len); 302 return 1; 303 } 304 305 return usb_kbd_irq_worker(dev); 306 } 307 308 /* Interrupt polling */ 309 static inline void usb_kbd_poll_for_event(struct usb_device *dev) 310 { 311 #if defined(CONFIG_SYS_USB_EVENT_POLL) 312 struct usb_kbd_pdata *data = dev->privptr; 313 314 /* Submit a interrupt transfer request */ 315 usb_submit_int_msg(dev, data->intpipe, &data->new[0], data->intpktsize, 316 data->intinterval); 317 318 usb_kbd_irq_worker(dev); 319 #elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) 320 struct usb_interface *iface; 321 struct usb_kbd_pdata *data = dev->privptr; 322 iface = &dev->config.if_desc[0]; 323 usb_get_report(dev, iface->desc.bInterfaceNumber, 324 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE); 325 if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE)) 326 usb_kbd_irq_worker(dev); 327 #endif 328 } 329 330 /* test if a character is in the queue */ 331 static int usb_kbd_testc(struct stdio_dev *sdev) 332 { 333 struct stdio_dev *dev; 334 struct usb_device *usb_kbd_dev; 335 struct usb_kbd_pdata *data; 336 337 #ifdef CONFIG_CMD_NET 338 /* 339 * If net_busy_flag is 1, NET transfer is running, 340 * then we check key-pressed every second (first check may be 341 * less than 1 second) to improve TFTP booting performance. 342 */ 343 if (net_busy_flag && (get_timer(kbd_testc_tms) < CONFIG_SYS_HZ)) 344 return 0; 345 kbd_testc_tms = get_timer(0); 346 #endif 347 dev = stdio_get_by_name(DEVNAME); 348 usb_kbd_dev = (struct usb_device *)dev->priv; 349 data = usb_kbd_dev->privptr; 350 351 usb_kbd_poll_for_event(usb_kbd_dev); 352 353 return !(data->usb_in_pointer == data->usb_out_pointer); 354 } 355 356 /* gets the character from the queue */ 357 static int usb_kbd_getc(struct stdio_dev *sdev) 358 { 359 struct stdio_dev *dev; 360 struct usb_device *usb_kbd_dev; 361 struct usb_kbd_pdata *data; 362 363 dev = stdio_get_by_name(DEVNAME); 364 usb_kbd_dev = (struct usb_device *)dev->priv; 365 data = usb_kbd_dev->privptr; 366 367 while (data->usb_in_pointer == data->usb_out_pointer) 368 usb_kbd_poll_for_event(usb_kbd_dev); 369 370 if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1) 371 data->usb_out_pointer = 0; 372 else 373 data->usb_out_pointer++; 374 375 return data->usb_kbd_buffer[data->usb_out_pointer]; 376 } 377 378 /* probes the USB device dev for keyboard type. */ 379 static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum) 380 { 381 struct usb_interface *iface; 382 struct usb_endpoint_descriptor *ep; 383 struct usb_kbd_pdata *data; 384 385 if (dev->descriptor.bNumConfigurations != 1) 386 return 0; 387 388 iface = &dev->config.if_desc[ifnum]; 389 390 if (iface->desc.bInterfaceClass != 3) 391 return 0; 392 393 if (iface->desc.bInterfaceSubClass != 1) 394 return 0; 395 396 if (iface->desc.bInterfaceProtocol != 1) 397 return 0; 398 399 if (iface->desc.bNumEndpoints != 1) 400 return 0; 401 402 ep = &iface->ep_desc[0]; 403 404 /* Check if endpoint 1 is interrupt endpoint */ 405 if (!(ep->bEndpointAddress & 0x80)) 406 return 0; 407 408 if ((ep->bmAttributes & 3) != 3) 409 return 0; 410 411 debug("USB KBD: found set protocol...\n"); 412 413 data = malloc(sizeof(struct usb_kbd_pdata)); 414 if (!data) { 415 printf("USB KBD: Error allocating private data\n"); 416 return 0; 417 } 418 419 /* Clear private data */ 420 memset(data, 0, sizeof(struct usb_kbd_pdata)); 421 422 /* allocate input buffer aligned and sized to USB DMA alignment */ 423 data->new = memalign(USB_DMA_MINALIGN, 424 roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN)); 425 426 /* Insert private data into USB device structure */ 427 dev->privptr = data; 428 429 /* Set IRQ handler */ 430 dev->irq_handle = usb_kbd_irq; 431 432 data->intpipe = usb_rcvintpipe(dev, ep->bEndpointAddress); 433 data->intpktsize = min(usb_maxpacket(dev, data->intpipe), 434 USB_KBD_BOOT_REPORT_SIZE); 435 data->intinterval = ep->bInterval; 436 437 /* We found a USB Keyboard, install it. */ 438 usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0); 439 440 debug("USB KBD: found set idle...\n"); 441 usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE, 0); 442 443 debug("USB KBD: enable interrupt pipe...\n"); 444 if (usb_submit_int_msg(dev, data->intpipe, data->new, data->intpktsize, 445 data->intinterval) < 0) { 446 printf("Failed to get keyboard state from device %04x:%04x\n", 447 dev->descriptor.idVendor, dev->descriptor.idProduct); 448 /* Abort, we don't want to use that non-functional keyboard. */ 449 return 0; 450 } 451 452 /* Success. */ 453 return 1; 454 } 455 456 /* Search for keyboard and register it if found. */ 457 int drv_usb_kbd_init(void) 458 { 459 struct stdio_dev usb_kbd_dev; 460 struct usb_device *dev; 461 char *stdinname = getenv("stdin"); 462 int error, i; 463 464 /* Scan all USB Devices */ 465 for (i = 0; i < USB_MAX_DEVICE; i++) { 466 /* Get USB device. */ 467 dev = usb_get_dev_index(i); 468 if (!dev) 469 return -1; 470 471 if (dev->devnum == -1) 472 continue; 473 474 /* Try probing the keyboard */ 475 if (usb_kbd_probe(dev, 0) != 1) 476 continue; 477 478 /* Register the keyboard */ 479 debug("USB KBD: register.\n"); 480 memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev)); 481 strcpy(usb_kbd_dev.name, DEVNAME); 482 usb_kbd_dev.flags = DEV_FLAGS_INPUT | DEV_FLAGS_SYSTEM; 483 usb_kbd_dev.getc = usb_kbd_getc; 484 usb_kbd_dev.tstc = usb_kbd_testc; 485 usb_kbd_dev.priv = (void *)dev; 486 error = stdio_register(&usb_kbd_dev); 487 if (error) 488 return error; 489 490 #ifdef CONFIG_CONSOLE_MUX 491 error = iomux_doenv(stdin, stdinname); 492 if (error) 493 return error; 494 #else 495 /* Check if this is the standard input device. */ 496 if (strcmp(stdinname, DEVNAME)) 497 return 1; 498 499 /* Reassign the console */ 500 if (overwrite_console()) 501 return 1; 502 503 error = console_assign(stdin, DEVNAME); 504 if (error) 505 return error; 506 #endif 507 508 return 1; 509 } 510 511 /* No USB Keyboard found */ 512 return -1; 513 } 514 515 /* Deregister the keyboard. */ 516 int usb_kbd_deregister(int force) 517 { 518 #ifdef CONFIG_SYS_STDIO_DEREGISTER 519 struct stdio_dev *dev; 520 struct usb_device *usb_kbd_dev; 521 struct usb_kbd_pdata *data; 522 523 dev = stdio_get_by_name(DEVNAME); 524 if (dev) { 525 usb_kbd_dev = (struct usb_device *)dev->priv; 526 data = usb_kbd_dev->privptr; 527 if (stdio_deregister_dev(dev, force) != 0) 528 return 1; 529 free(data->new); 530 free(data); 531 } 532 533 return 0; 534 #else 535 return 1; 536 #endif 537 } 538