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