common/usb_kbd.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2001
   4  * Denis Peter, MPL AG Switzerland
   5  *
   6  * Part of this source has been derived from the Linux USB
   7  * project.
   8  */
   9 #include <console.h>
  10 #include <dm.h>
  11 #include <env.h>
  12 #include <errno.h>
  13 #include <log.h>
  14 #include <malloc.h>
  15 #include <memalign.h>
  16 #include <stdio_dev.h>
  17 #include <time.h>
  18 #include <watchdog.h>
  19 #include <asm/byteorder.h>
  20 #ifdef CONFIG_SANDBOX
  21 #include <asm/state.h>
  22 #endif
  23
  24 #include <usb.h>
  25
  26 /*
  27  * USB vendor and product IDs used for quirks.
  28  */
  29 #define USB_VENDOR_ID_APPLE     0x05ac
  30 #define USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2021                 0x029c
  31 #define USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2021     0x029a
  32 #define USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2021          0x029f
  33
  34 #define USB_VENDOR_ID_KEYCHRON  0x3434
  35
  36 #define USB_HID_QUIRK_POLL_NO_REPORT_IDLE       BIT(0)
  37
  38 /*
  39  * If overwrite_console returns 1, the stdin, stderr and stdout
  40  * are switched to the serial port, else the settings in the
  41  * environment are used
  42  */
  43 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
  44 extern int overwrite_console(void);
  45 #else
  46 int overwrite_console(void)
  47 {
  48         return 0;
  49 }
  50 #endif
  51
  52 /* Keyboard sampling rate */
  53 #define REPEAT_RATE     40              /* 40msec -> 25cps */
  54 #define REPEAT_DELAY    10              /* 10 x REPEAT_RATE = 400msec */
  55
  56 #define NUM_LOCK        0x53
  57 #define CAPS_LOCK       0x39
  58 #define SCROLL_LOCK     0x47
  59
  60 /* Modifier bits */
  61 #define LEFT_CNTR       (1 << 0)
  62 #define LEFT_SHIFT      (1 << 1)
  63 #define LEFT_ALT        (1 << 2)
  64 #define LEFT_GUI        (1 << 3)
  65 #define RIGHT_CNTR      (1 << 4)
  66 #define RIGHT_SHIFT     (1 << 5)
  67 #define RIGHT_ALT       (1 << 6)
  68 #define RIGHT_GUI       (1 << 7)
  69
  70 /* Size of the keyboard buffer */
  71 #define USB_KBD_BUFFER_LEN      0x20
  72
  73 /* Device name */
  74 #define DEVNAME                 "usbkbd"
  75
  76 /* Keyboard maps */
  77 static const unsigned char usb_kbd_numkey[] = {
  78         '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
  79         '\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']',
  80         '\\', '#', ';', '\'', '`', ',', '.', '/'
  81 };
  82 static const unsigned char usb_kbd_numkey_shifted[] = {
  83         '!', '@', '#', '$', '%', '^', '&', '*', '(', ')',
  84         '\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}',
  85         '|', '~', ':', '"', '~', '<', '>', '?'
  86 };
  87
  88 static const unsigned char usb_kbd_num_keypad[] = {
  89         '/', '*', '-', '+', '\r',
  90         '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
  91         '.', 0, 0, 0, '='
  92 };
  93
  94 static const u8 usb_special_keys[] = {
  95 #ifdef CONFIG_USB_KEYBOARD_FN_KEYS
  96         '2', 'H', '5', '3', 'F', '6', 'C', 'D', 'B', 'A'
  97 #else
  98         'C', 'D', 'B', 'A'
  99 #endif
 100 };
 101
 102 /*
 103  * NOTE: It's important for the NUM, CAPS, SCROLL-lock bits to be in this
 104  *       order. See usb_kbd_setled() function!
 105  */
 106 #define USB_KBD_NUMLOCK         (1 << 0)
 107 #define USB_KBD_CAPSLOCK        (1 << 1)
 108 #define USB_KBD_SCROLLLOCK      (1 << 2)
 109 #define USB_KBD_CTRL            (1 << 3)
 110
 111 #define USB_KBD_LEDMASK         \
 112         (USB_KBD_NUMLOCK | USB_KBD_CAPSLOCK | USB_KBD_SCROLLLOCK)
 113
 114 struct usb_kbd_pdata {
 115         unsigned long   intpipe;
 116         int             intpktsize;
 117         int             intinterval;
 118         unsigned long   last_report;
 119         struct int_queue *intq;
 120
 121         uint32_t        ifnum;
 122
 123         uint32_t        repeat_delay;
 124
 125         uint32_t        usb_in_pointer;
 126         uint32_t        usb_out_pointer;
 127         uint8_t         usb_kbd_buffer[USB_KBD_BUFFER_LEN];
 128
 129         uint8_t         *new;
 130         uint8_t         old[USB_KBD_BOOT_REPORT_SIZE];
 131
 132         uint8_t         flags;
 133 };
 134
 135 extern int __maybe_unused net_busy_flag;
 136
 137 /* The period of time between two calls of usb_kbd_testc(). */
 138 static unsigned long kbd_testc_tms;
 139
 140 int usb_kbd_remove_for_test(void)
 141 {
 142         return console_remove_by_name(DEVNAME);
 143 }
 144
 145 /* Puts character in the queue and sets up the in and out pointer. */
 146 static void usb_kbd_put_queue(struct usb_kbd_pdata *data, u8 c)
 147 {
 148         if (data->usb_in_pointer == USB_KBD_BUFFER_LEN - 1) {
 149                 /* Check for buffer full. */
 150                 if (data->usb_out_pointer == 0)
 151                         return;
 152
 153                 data->usb_in_pointer = 0;
 154         } else {
 155                 /* Check for buffer full. */
 156                 if (data->usb_in_pointer == data->usb_out_pointer - 1)
 157                         return;
 158
 159                 data->usb_in_pointer++;
 160         }
 161
 162         data->usb_kbd_buffer[data->usb_in_pointer] = c;
 163 }
 164
 165 /*
 166  * Set the LEDs. Since this is used in the irq routine, the control job is
 167  * issued with a timeout of 0. This means, that the job is queued without
 168  * waiting for job completion.
 169  */
 170 static void usb_kbd_setled(struct usb_device *dev)
 171 {
 172         struct usb_kbd_pdata *data = dev->privptr;
 173         struct usb_interface *iface = &dev->config.if_desc[data->ifnum];
 174         ALLOC_ALIGN_BUFFER(uint32_t, leds, 1, USB_DMA_MINALIGN);
 175
 176         *leds = data->flags & USB_KBD_LEDMASK;
 177         usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 178                 USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
 179                 0x200, iface->desc.bInterfaceNumber, leds, 1, 0);
 180 }
 181
 182 #define CAPITAL_MASK    0x20
 183 /* Translate the scancode in ASCII */
 184 static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode,
 185                                 unsigned char modifier, int pressed)
 186 {
 187         uint8_t keycode = 0;
 188
 189         /* Key released */
 190         if (pressed == 0) {
 191                 data->repeat_delay = 0;
 192                 return 0;
 193         }
 194
 195         if (pressed == 2) {
 196                 data->repeat_delay++;
 197                 if (data->repeat_delay < REPEAT_DELAY)
 198                         return 0;
 199
 200                 data->repeat_delay = REPEAT_DELAY;
 201         }
 202
 203         /* Alphanumeric values */
 204         if ((scancode > 3) && (scancode <= 0x1d)) {
 205                 keycode = scancode - 4 + 'a';
 206
 207                 if (data->flags & USB_KBD_CAPSLOCK)
 208                         keycode &= ~CAPITAL_MASK;
 209
 210                 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) {
 211                         /* Handle CAPSLock + Shift pressed simultaneously */
 212                         if (keycode & CAPITAL_MASK)
 213                                 keycode &= ~CAPITAL_MASK;
 214                         else
 215                                 keycode |= CAPITAL_MASK;
 216                 }
 217         }
 218
 219         if ((scancode > 0x1d) && (scancode < 0x39)) {
 220                 /* Shift pressed */
 221                 if (modifier & (LEFT_SHIFT | RIGHT_SHIFT))
 222                         keycode = usb_kbd_numkey_shifted[scancode - 0x1e];
 223                 else
 224                         keycode = usb_kbd_numkey[scancode - 0x1e];
 225         }
 226
 227         /* Numeric keypad */
 228         if ((scancode >= 0x54) && (scancode <= 0x67))
 229                 keycode = usb_kbd_num_keypad[scancode - 0x54];
 230
 231         if (data->flags & USB_KBD_CTRL)
 232                 keycode = scancode - 0x3;
 233
 234         if (pressed == 1) {
 235                 if (scancode == NUM_LOCK) {
 236                         data->flags ^= USB_KBD_NUMLOCK;
 237                         return 1;
 238                 }
 239
 240                 if (scancode == CAPS_LOCK) {
 241                         data->flags ^= USB_KBD_CAPSLOCK;
 242                         return 1;
 243                 }
 244                 if (scancode == SCROLL_LOCK) {
 245                         data->flags ^= USB_KBD_SCROLLLOCK;
 246                         return 1;
 247                 }
 248         }
 249
 250         /* Report keycode if any */
 251         if (keycode) {
 252                 debug("%c", keycode);
 253                 usb_kbd_put_queue(data, keycode);
 254                 return 0;
 255         }
 256
 257 #ifdef CONFIG_USB_KEYBOARD_FN_KEYS
 258         if (scancode < 0x3a || scancode > 0x52 ||
 259             scancode == 0x46 || scancode == 0x47)
 260                 return 1;
 261
 262         usb_kbd_put_queue(data, 0x1b);
 263         if (scancode < 0x3e) {
 264                 /* F1 - F4 */
 265                 usb_kbd_put_queue(data, 0x4f);
 266                 usb_kbd_put_queue(data, scancode - 0x3a + 'P');
 267                 return 0;
 268         }
 269         usb_kbd_put_queue(data, '[');
 270         if (scancode < 0x42) {
 271                 /* F5 - F8 */
 272                 usb_kbd_put_queue(data, '1');
 273                 if (scancode == 0x3e)
 274                         --scancode;
 275                 keycode = scancode - 0x3f + '7';
 276         } else if (scancode < 0x49) {
 277                 /* F9 - F12 */
 278                 usb_kbd_put_queue(data, '2');
 279                 if (scancode > 0x43)
 280                         ++scancode;
 281                 keycode = scancode - 0x42 + '0';
 282         } else {
 283                 /*
 284                  * INSERT, HOME, PAGE UP, DELETE, END, PAGE DOWN,
 285                  * RIGHT, LEFT, DOWN, UP
 286                  */
 287                 keycode = usb_special_keys[scancode - 0x49];
 288         }
 289         usb_kbd_put_queue(data, keycode);
 290         if (scancode < 0x4f && scancode != 0x4a && scancode != 0x4d)
 291                 usb_kbd_put_queue(data, '~');
 292         return 0;
 293 #else
 294         /* Left, Right, Up, Down */
 295         if (scancode > 0x4e && scancode < 0x53) {
 296                 usb_kbd_put_queue(data, 0x1b);
 297                 usb_kbd_put_queue(data, '[');
 298                 usb_kbd_put_queue(data, usb_special_keys[scancode - 0x4f]);
 299                 return 0;
 300         }
 301         return 1;
 302 #endif /* CONFIG_USB_KEYBOARD_FN_KEYS */
 303 }
 304
 305 static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up)
 306 {
 307         uint32_t res = 0;
 308         struct usb_kbd_pdata *data = dev->privptr;
 309         uint8_t *new;
 310         uint8_t *old;
 311
 312         if (up) {
 313                 new = data->old;
 314                 old = data->new;
 315         } else {
 316                 new = data->new;
 317                 old = data->old;
 318         }
 319
 320         if ((old[i] > 3) &&
 321             (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) ==
 322                         new + USB_KBD_BOOT_REPORT_SIZE)) {
 323                 res |= usb_kbd_translate(data, old[i], data->new[0], up);
 324         }
 325
 326         return res;
 327 }
 328
 329 /* Interrupt service routine */
 330 static int usb_kbd_irq_worker(struct usb_device *dev)
 331 {
 332         struct usb_kbd_pdata *data = dev->privptr;
 333         int i, res = 0;
 334
 335         /* No combo key pressed */
 336         if (data->new[0] == 0x00)
 337                 data->flags &= ~USB_KBD_CTRL;
 338         /* Left or Right Ctrl pressed */
 339         else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR))
 340                 data->flags |= USB_KBD_CTRL;
 341
 342         for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) {
 343                 res |= usb_kbd_service_key(dev, i, 0);
 344                 res |= usb_kbd_service_key(dev, i, 1);
 345         }
 346
 347         /* Key is still pressed */
 348         if ((data->new[2] > 3) && (data->old[2] == data->new[2]))
 349                 res |= usb_kbd_translate(data, data->new[2], data->new[0], 2);
 350
 351         if (res == 1)
 352                 usb_kbd_setled(dev);
 353
 354         memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE);
 355
 356         return 1;
 357 }
 358
 359 /* Keyboard interrupt handler */
 360 static int usb_kbd_irq(struct usb_device *dev)
 361 {
 362         if ((dev->irq_status != 0) ||
 363             (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) {
 364                 debug("USB KBD: Error %lX, len %d\n",
 365                       dev->irq_status, dev->irq_act_len);
 366                 return 1;
 367         }
 368
 369         return usb_kbd_irq_worker(dev);
 370 }
 371
 372 /* Interrupt polling */
 373 static inline void usb_kbd_poll_for_event(struct usb_device *dev)
 374 {
 375 #if defined(CONFIG_SYS_USB_EVENT_POLL)
 376         struct usb_kbd_pdata *data = dev->privptr;
 377
 378         /* Submit an interrupt transfer request */
 379         if (usb_int_msg(dev, data->intpipe, &data->new[0],
 380                         data->intpktsize, data->intinterval, true) >= 0)
 381                 usb_kbd_irq_worker(dev);
 382 #elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) || \
 383       defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
 384 #if defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
 385         struct usb_interface *iface;
 386         struct usb_kbd_pdata *data = dev->privptr;
 387         iface = &dev->config.if_desc[data->ifnum];
 388         usb_get_report(dev, iface->desc.bInterfaceNumber,
 389                        1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE);
 390         if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE)) {
 391                 usb_kbd_irq_worker(dev);
 392 #else
 393         struct usb_kbd_pdata *data = dev->privptr;
 394         if (poll_int_queue(dev, data->intq)) {
 395                 usb_kbd_irq_worker(dev);
 396                 /* We've consumed all queued int packets, create new */
 397                 destroy_int_queue(dev, data->intq);
 398                 data->intq = create_int_queue(dev, data->intpipe, 1,
 399                                       USB_KBD_BOOT_REPORT_SIZE, data->new,
 400                                       data->intinterval);
 401 #endif
 402                 data->last_report = get_timer(0);
 403         /* Repeat last usb hid report every REPEAT_RATE ms for keyrepeat */
 404         } else if (data->last_report != -1 &&
 405                    get_timer(data->last_report) > REPEAT_RATE) {
 406                 usb_kbd_irq_worker(dev);
 407                 data->last_report = get_timer(0);
 408         }
 409 #endif
 410 }
 411
 412 /* test if a character is in the queue */
 413 static int usb_kbd_testc(struct stdio_dev *sdev)
 414 {
 415         struct stdio_dev *dev;
 416         struct usb_device *usb_kbd_dev;
 417         struct usb_kbd_pdata *data;
 418
 419         /*
 420          * Polling the keyboard for an event can take dozens of milliseconds.
 421          * Add a delay between polls to avoid blocking activity which polls
 422          * rapidly, like the UEFI console timer.
 423          */
 424         unsigned long poll_delay = CONFIG_SYS_HZ / 50;
 425
 426 #ifdef CONFIG_CMD_NET
 427         /*
 428          * If net_busy_flag is 1, NET transfer is running,
 429          * then we check key-pressed every second (first check may be
 430          * less than 1 second) to improve TFTP booting performance.
 431          */
 432         if (net_busy_flag)
 433                 poll_delay = CONFIG_SYS_HZ;
 434 #endif
 435
 436 #ifdef CONFIG_SANDBOX
 437         /*
 438          * Skip delaying polls if a test requests it.
 439          */
 440         if (state_get_skip_delays())
 441                 poll_delay = 0;
 442 #endif
 443
 444         dev = stdio_get_by_name(sdev->name);
 445         usb_kbd_dev = (struct usb_device *)dev->priv;
 446         data = usb_kbd_dev->privptr;
 447
 448         if (get_timer(kbd_testc_tms) >= poll_delay) {
 449                 usb_kbd_poll_for_event(usb_kbd_dev);
 450                 kbd_testc_tms = get_timer(0);
 451         }
 452
 453         return !(data->usb_in_pointer == data->usb_out_pointer);
 454 }
 455
 456 /* gets the character from the queue */
 457 static int usb_kbd_getc(struct stdio_dev *sdev)
 458 {
 459         struct stdio_dev *dev;
 460         struct usb_device *usb_kbd_dev;
 461         struct usb_kbd_pdata *data;
 462
 463         dev = stdio_get_by_name(sdev->name);
 464         usb_kbd_dev = (struct usb_device *)dev->priv;
 465         data = usb_kbd_dev->privptr;
 466
 467         while (data->usb_in_pointer == data->usb_out_pointer) {
 468                 schedule();
 469                 usb_kbd_poll_for_event(usb_kbd_dev);
 470         }
 471
 472         if (data->usb_out_pointer == USB_KBD_BUFFER_LEN - 1)
 473                 data->usb_out_pointer = 0;
 474         else
 475                 data->usb_out_pointer++;
 476
 477         return data->usb_kbd_buffer[data->usb_out_pointer];
 478 }
 479
 480 /* probes the USB device dev for keyboard type. */
 481 static int usb_kbd_probe_dev(struct usb_device *dev, unsigned int ifnum)
 482 {
 483         struct usb_interface *iface;
 484         struct usb_endpoint_descriptor *ep;
 485         struct usb_kbd_pdata *data;
 486         unsigned int quirks = 0;
 487         int epNum;
 488
 489         if (dev->descriptor.bNumConfigurations != 1)
 490                 return 0;
 491
 492         iface = &dev->config.if_desc[ifnum];
 493
 494         if (iface->desc.bInterfaceClass != USB_CLASS_HID)
 495                 return 0;
 496
 497         if (iface->desc.bInterfaceSubClass != USB_SUB_HID_BOOT)
 498                 return 0;
 499
 500         if (iface->desc.bInterfaceProtocol != USB_PROT_HID_KEYBOARD)
 501                 return 0;
 502
 503         for (epNum = 0; epNum < iface->desc.bNumEndpoints; epNum++) {
 504                 ep = &iface->ep_desc[epNum];
 505
 506                 /* Check if endpoint is interrupt IN endpoint */
 507                 if ((ep->bmAttributes & 3) != 3)
 508                         continue;
 509
 510                 if (ep->bEndpointAddress & 0x80)
 511                         break;
 512         }
 513
 514         if (epNum == iface->desc.bNumEndpoints)
 515                 return 0;
 516
 517         debug("USB KBD: found interrupt EP: 0x%x\n", ep->bEndpointAddress);
 518
 519         switch (dev->descriptor.idVendor) {
 520         case USB_VENDOR_ID_APPLE:
 521         case USB_VENDOR_ID_KEYCHRON:
 522                 quirks |= USB_HID_QUIRK_POLL_NO_REPORT_IDLE;
 523                 break;
 524         default:
 525                 break;
 526         }
 527
 528         data = malloc(sizeof(struct usb_kbd_pdata));
 529         if (!data) {
 530                 printf("USB KBD: Error allocating private data\n");
 531                 return 0;
 532         }
 533
 534         /* Clear private data */
 535         memset(data, 0, sizeof(struct usb_kbd_pdata));
 536
 537         /* allocate input buffer aligned and sized to USB DMA alignment */
 538         data->new = memalign(USB_DMA_MINALIGN,
 539                 roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN));
 540
 541         data->ifnum = ifnum;
 542
 543         /* Insert private data into USB device structure */
 544         dev->privptr = data;
 545
 546         /* Set IRQ handler */
 547         dev->irq_handle = usb_kbd_irq;
 548
 549         data->intpipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
 550         data->intpktsize = min(usb_maxpacket(dev, data->intpipe),
 551                                USB_KBD_BOOT_REPORT_SIZE);
 552         data->intinterval = ep->bInterval;
 553         data->last_report = -1;
 554
 555         /* We found a USB Keyboard, install it. */
 556         debug("USB KBD: set boot protocol\n");
 557         usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);
 558
 559 #if !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) && \
 560     !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
 561         debug("USB KBD: set idle interval...\n");
 562         usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE / 4, 0);
 563 #else
 564         debug("USB KBD: set idle interval=0...\n");
 565         usb_set_idle(dev, iface->desc.bInterfaceNumber, 0, 0);
 566 #endif
 567
 568         /*
 569          * Apple and Keychron keyboards do not report the device state. Reports
 570          * are only returned during key presses.
 571          */
 572         if (quirks & USB_HID_QUIRK_POLL_NO_REPORT_IDLE) {
 573                 debug("USB KBD: quirk: skip testing device state\n");
 574                 return 1;
 575         }
 576         debug("USB KBD: enable interrupt pipe...\n");
 577 #ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
 578         data->intq = create_int_queue(dev, data->intpipe, 1,
 579                                       USB_KBD_BOOT_REPORT_SIZE, data->new,
 580                                       data->intinterval);
 581         if (!data->intq) {
 582 #elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
 583         if (usb_get_report(dev, iface->desc.bInterfaceNumber,
 584                            1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE) < 0) {
 585 #else
 586         if (usb_int_msg(dev, data->intpipe, data->new, data->intpktsize,
 587                         data->intinterval, false) < 0) {
 588 #endif
 589                 printf("Failed to get keyboard state from device %04x:%04x\n",
 590                        dev->descriptor.idVendor, dev->descriptor.idProduct);
 591                 /* Abort, we don't want to use that non-functional keyboard. */
 592                 return 0;
 593         }
 594
 595         /* Success. */
 596         return 1;
 597 }
 598
 599 static int probe_usb_keyboard(struct usb_device *dev)
 600 {
 601         char *stdinname;
 602         struct stdio_dev usb_kbd_dev;
 603         unsigned int ifnum;
 604         unsigned int max_ifnum = min((unsigned int)USB_MAX_ACTIVE_INTERFACES,
 605                                      (unsigned int)dev->config.no_of_if);
 606         int error;
 607
 608         /* Try probing the keyboard */
 609         for (ifnum = 0; ifnum < max_ifnum; ifnum++) {
 610                 if (usb_kbd_probe_dev(dev, ifnum) == 1)
 611                         break;
 612         }
 613         if (ifnum >= max_ifnum)
 614                 return -ENOENT;
 615
 616         /* Register the keyboard */
 617         debug("USB KBD: register.\n");
 618         memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
 619         strcpy(usb_kbd_dev.name, DEVNAME);
 620         usb_kbd_dev.flags = DEV_FLAGS_INPUT | DEV_FLAGS_DM;
 621         usb_kbd_dev.getc = usb_kbd_getc;
 622         usb_kbd_dev.tstc = usb_kbd_testc;
 623         usb_kbd_dev.priv = (void *)dev;
 624         error = stdio_register(&usb_kbd_dev);
 625         if (error)
 626                 return error;
 627
 628         stdinname = env_get("stdin");
 629 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
 630         if (strstr(stdinname, DEVNAME) != NULL) {
 631                 error = iomux_doenv(stdin, stdinname);
 632                 if (error)
 633                         return error;
 634         }
 635 #else
 636         /* Check if this is the standard input device. */
 637         if (!strcmp(stdinname, DEVNAME)) {
 638                 /* Reassign the console */
 639                 if (overwrite_console())
 640                         return 1;
 641
 642                 error = console_assign(stdin, DEVNAME);
 643                 if (error)
 644                         return error;
 645         }
 646 #endif
 647
 648         return 0;
 649 }
 650
 651 static int usb_kbd_probe(struct udevice *dev)
 652 {
 653         struct usb_device *udev = dev_get_parent_priv(dev);
 654
 655         return probe_usb_keyboard(udev);
 656 }
 657
 658 static int usb_kbd_remove(struct udevice *dev)
 659 {
 660         struct usb_device *udev = dev_get_parent_priv(dev);
 661         struct usb_kbd_pdata *data;
 662         struct stdio_dev *sdev;
 663         int ret;
 664
 665         sdev = stdio_get_by_name(DEVNAME);
 666         if (!sdev) {
 667                 ret = -ENXIO;
 668                 goto err;
 669         }
 670         data = udev->privptr;
 671 #if CONFIG_IS_ENABLED(CONSOLE_MUX)
 672         if (iomux_replace_device(stdin, DEVNAME, "nulldev")) {
 673                 ret = -ENOLINK;
 674                 goto err;
 675         }
 676 #endif
 677         if (stdio_deregister_dev(sdev, true)) {
 678                 ret = -EPERM;
 679                 goto err;
 680         }
 681 #ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
 682         destroy_int_queue(udev, data->intq);
 683 #endif
 684         free(data->new);
 685         free(data);
 686
 687         return 0;
 688 err:
 689         printf("%s: warning, ret=%d", __func__, ret);
 690         return ret;
 691 }
 692
 693 static const struct udevice_id usb_kbd_ids[] = {
 694         { .compatible = "usb-keyboard" },
 695         { }
 696 };
 697
 698 U_BOOT_DRIVER(usb_kbd) = {
 699         .name   = "usb_kbd",
 700         .id     = UCLASS_KEYBOARD,
 701         .of_match = usb_kbd_ids,
 702         .probe = usb_kbd_probe,
 703         .remove = usb_kbd_remove,
 704 };
 705
 706 static const struct usb_device_id kbd_id_table[] = {
 707         {
 708                 .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
 709                         USB_DEVICE_ID_MATCH_INT_SUBCLASS |
 710                         USB_DEVICE_ID_MATCH_INT_PROTOCOL,
 711                 .bInterfaceClass = USB_CLASS_HID,
 712                 .bInterfaceSubClass = USB_SUB_HID_BOOT,
 713                 .bInterfaceProtocol = USB_PROT_HID_KEYBOARD,
 714         },
 715         {
 716                 USB_DEVICE(USB_VENDOR_ID_APPLE,
 717                            USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_2021),
 718         },
 719         {
 720                 USB_DEVICE(USB_VENDOR_ID_APPLE,
 721                            USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_FINGERPRINT_2021),
 722         },
 723         {
 724                 USB_DEVICE(USB_VENDOR_ID_APPLE,
 725                            USB_DEVICE_ID_APPLE_MAGIC_KEYBOARD_NUMPAD_2021),
 726         },
 727         { }             /* Terminating entry */
 728 };
 729
 730 U_BOOT_USB_DEVICE(usb_kbd, kbd_id_table);