]> git.ipfire.org Git - people/ms/u-boot.git/blobdiff - common/usb_kbd.c
Migrate generic bootcount to Kconfig
[people/ms/u-boot.git] / common / usb_kbd.c
index fdc083c70cf9952ec000429355b605b2ec4ff43c..8cbdba6ac2984fd667e6e7130311249126ca6c78 100644 (file)
@@ -8,8 +8,11 @@
  * SPDX-License-Identifier:    GPL-2.0+
  */
 #include <common.h>
+#include <console.h>
+#include <dm.h>
 #include <errno.h>
 #include <malloc.h>
+#include <memalign.h>
 #include <stdio_dev.h>
 #include <asm/byteorder.h>
 
@@ -30,7 +33,7 @@ int overwrite_console(void)
 #endif
 
 /* Keyboard sampling rate */
-#define REPEAT_RATE    (40 / 4)        /* 40msec -> 25cps */
+#define REPEAT_RATE    40              /* 40msec -> 25cps */
 #define REPEAT_DELAY   10              /* 10 x REPEAT_RATE = 400msec */
 
 #define NUM_LOCK       0x53
@@ -99,6 +102,12 @@ static const unsigned char usb_kbd_arrow[] = {
 #define USB_KBD_BOOT_REPORT_SIZE 8
 
 struct usb_kbd_pdata {
+       unsigned long   intpipe;
+       int             intpktsize;
+       int             intinterval;
+       unsigned long   last_report;
+       struct int_queue *intq;
+
        uint32_t        repeat_delay;
 
        uint32_t        usb_in_pointer;
@@ -116,32 +125,6 @@ extern int __maybe_unused net_busy_flag;
 /* The period of time between two calls of usb_kbd_testc(). */
 static unsigned long __maybe_unused kbd_testc_tms;
 
-/* Generic keyboard event polling. */
-void usb_kbd_generic_poll(void)
-{
-       struct stdio_dev *dev;
-       struct usb_device *usb_kbd_dev;
-       struct usb_kbd_pdata *data;
-       struct usb_interface *iface;
-       struct usb_endpoint_descriptor *ep;
-       int pipe;
-       int maxp;
-
-       /* Get the pointer to USB Keyboard device pointer */
-       dev = stdio_get_by_name(DEVNAME);
-       usb_kbd_dev = (struct usb_device *)dev->priv;
-       data = usb_kbd_dev->privptr;
-       iface = &usb_kbd_dev->config.if_desc[0];
-       ep = &iface->ep_desc[0];
-       pipe = usb_rcvintpipe(usb_kbd_dev, ep->bEndpointAddress);
-
-       /* Submit a interrupt transfer request */
-       maxp = usb_maxpacket(usb_kbd_dev, pipe);
-       usb_submit_int_msg(usb_kbd_dev, pipe, data->new,
-               min(maxp, USB_KBD_BOOT_REPORT_SIZE),
-               ep->bInterval);
-}
-
 /* Puts character in the queue and sets up the in and out pointer. */
 static void usb_kbd_put_queue(struct usb_kbd_pdata *data, char c)
 {
@@ -216,7 +199,7 @@ static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode,
                }
        }
 
-       if ((scancode > 0x1d) && (scancode < 0x3a)) {
+       if ((scancode > 0x1d) && (scancode < 0x39)) {
                /* Shift pressed */
                if (modifier & (LEFT_SHIFT | RIGHT_SHIFT))
                        keycode = usb_kbd_numkey_shifted[scancode - 0x1e];
@@ -330,34 +313,41 @@ static int usb_kbd_irq(struct usb_device *dev)
 /* Interrupt polling */
 static inline void usb_kbd_poll_for_event(struct usb_device *dev)
 {
-#if    defined(CONFIG_SYS_USB_EVENT_POLL)
-       struct usb_interface *iface;
-       struct usb_endpoint_descriptor *ep;
-       struct usb_kbd_pdata *data;
-       int pipe;
-       int maxp;
-
-       /* Get the pointer to USB Keyboard device pointer */
-       data = dev->privptr;
-       iface = &dev->config.if_desc[0];
-       ep = &iface->ep_desc[0];
-       pipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
+#if defined(CONFIG_SYS_USB_EVENT_POLL)
+       struct usb_kbd_pdata *data = dev->privptr;
 
        /* Submit a interrupt transfer request */
-       maxp = usb_maxpacket(dev, pipe);
-       usb_submit_int_msg(dev, pipe, &data->new[0],
-               min(maxp, USB_KBD_BOOT_REPORT_SIZE),
-               ep->bInterval);
+       usb_submit_int_msg(dev, data->intpipe, &data->new[0], data->intpktsize,
+                          data->intinterval);
 
        usb_kbd_irq_worker(dev);
-#elif  defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
+#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) || \
+      defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
+#if defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
        struct usb_interface *iface;
        struct usb_kbd_pdata *data = dev->privptr;
        iface = &dev->config.if_desc[0];
        usb_get_report(dev, iface->desc.bInterfaceNumber,
                       1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE);
-       if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE))
+       if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE)) {
                usb_kbd_irq_worker(dev);
+#else
+       struct usb_kbd_pdata *data = dev->privptr;
+       if (poll_int_queue(dev, data->intq)) {
+               usb_kbd_irq_worker(dev);
+               /* We've consumed all queued int packets, create new */
+               destroy_int_queue(dev, data->intq);
+               data->intq = create_int_queue(dev, data->intpipe, 1,
+                                     USB_KBD_BOOT_REPORT_SIZE, data->new,
+                                     data->intinterval);
+#endif
+               data->last_report = get_timer(0);
+       /* Repeat last usb hid report every REPEAT_RATE ms for keyrepeat */
+       } else if (data->last_report != -1 &&
+                  get_timer(data->last_report) > REPEAT_RATE) {
+               usb_kbd_irq_worker(dev);
+               data->last_report = get_timer(0);
+       }
 #endif
 }
 
@@ -410,25 +400,24 @@ static int usb_kbd_getc(struct stdio_dev *sdev)
 }
 
 /* probes the USB device dev for keyboard type. */
-static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
+static int usb_kbd_probe_dev(struct usb_device *dev, unsigned int ifnum)
 {
        struct usb_interface *iface;
        struct usb_endpoint_descriptor *ep;
        struct usb_kbd_pdata *data;
-       int pipe, maxp;
 
        if (dev->descriptor.bNumConfigurations != 1)
                return 0;
 
        iface = &dev->config.if_desc[ifnum];
 
-       if (iface->desc.bInterfaceClass != 3)
+       if (iface->desc.bInterfaceClass != USB_CLASS_HID)
                return 0;
 
-       if (iface->desc.bInterfaceSubClass != 1)
+       if (iface->desc.bInterfaceSubClass != USB_SUB_HID_BOOT)
                return 0;
 
-       if (iface->desc.bInterfaceProtocol != 1)
+       if (iface->desc.bInterfaceProtocol != USB_PROT_HID_KEYBOARD)
                return 0;
 
        if (iface->desc.bNumEndpoints != 1)
@@ -464,19 +453,36 @@ static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
        /* Set IRQ handler */
        dev->irq_handle = usb_kbd_irq;
 
-       pipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
-       maxp = usb_maxpacket(dev, pipe);
+       data->intpipe = usb_rcvintpipe(dev, ep->bEndpointAddress);
+       data->intpktsize = min(usb_maxpacket(dev, data->intpipe),
+                              USB_KBD_BOOT_REPORT_SIZE);
+       data->intinterval = ep->bInterval;
+       data->last_report = -1;
 
        /* We found a USB Keyboard, install it. */
        usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);
 
        debug("USB KBD: found set idle...\n");
-       usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE, 0);
+#if !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) && \
+    !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
+       usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE / 4, 0);
+#else
+       usb_set_idle(dev, iface->desc.bInterfaceNumber, 0, 0);
+#endif
 
        debug("USB KBD: enable interrupt pipe...\n");
-       if (usb_submit_int_msg(dev, pipe, data->new,
-                              min(maxp, USB_KBD_BOOT_REPORT_SIZE),
-                              ep->bInterval) < 0) {
+#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
+       data->intq = create_int_queue(dev, data->intpipe, 1,
+                                     USB_KBD_BOOT_REPORT_SIZE, data->new,
+                                     data->intinterval);
+       if (!data->intq) {
+#elif defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP)
+       if (usb_get_report(dev, iface->desc.bInterfaceNumber,
+                          1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE) < 0) {
+#else
+       if (usb_submit_int_msg(dev, data->intpipe, data->new, data->intpktsize,
+                              data->intinterval) < 0) {
+#endif
                printf("Failed to get keyboard state from device %04x:%04x\n",
                       dev->descriptor.idVendor, dev->descriptor.idProduct);
                /* Abort, we don't want to use that non-functional keyboard. */
@@ -487,59 +493,74 @@ static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
        return 1;
 }
 
+static int probe_usb_keyboard(struct usb_device *dev)
+{
+       char *stdinname;
+       struct stdio_dev usb_kbd_dev;
+       int error;
+
+       /* Try probing the keyboard */
+       if (usb_kbd_probe_dev(dev, 0) != 1)
+               return -ENOENT;
+
+       /* Register the keyboard */
+       debug("USB KBD: register.\n");
+       memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
+       strcpy(usb_kbd_dev.name, DEVNAME);
+       usb_kbd_dev.flags =  DEV_FLAGS_INPUT;
+       usb_kbd_dev.getc = usb_kbd_getc;
+       usb_kbd_dev.tstc = usb_kbd_testc;
+       usb_kbd_dev.priv = (void *)dev;
+       error = stdio_register(&usb_kbd_dev);
+       if (error)
+               return error;
+
+       stdinname = env_get("stdin");
+#if CONFIG_IS_ENABLED(CONSOLE_MUX)
+       error = iomux_doenv(stdin, stdinname);
+       if (error)
+               return error;
+#else
+       /* Check if this is the standard input device. */
+       if (strcmp(stdinname, DEVNAME))
+               return 1;
+
+       /* Reassign the console */
+       if (overwrite_console())
+               return 1;
+
+       error = console_assign(stdin, DEVNAME);
+       if (error)
+               return error;
+#endif
+
+       return 0;
+}
+
+#ifndef CONFIG_DM_USB
 /* Search for keyboard and register it if found. */
 int drv_usb_kbd_init(void)
 {
-       struct stdio_dev usb_kbd_dev;
-       struct usb_device *dev;
-       char *stdinname = getenv("stdin");
        int error, i;
 
+       debug("%s: Probing for keyboard\n", __func__);
        /* Scan all USB Devices */
        for (i = 0; i < USB_MAX_DEVICE; i++) {
+               struct usb_device *dev;
+
                /* Get USB device. */
                dev = usb_get_dev_index(i);
                if (!dev)
-                       return -1;
+                       break;
 
                if (dev->devnum == -1)
                        continue;
 
-               /* Try probing the keyboard */
-               if (usb_kbd_probe(dev, 0) != 1)
-                       continue;
-
-               /* Register the keyboard */
-               debug("USB KBD: register.\n");
-               memset(&usb_kbd_dev, 0, sizeof(struct stdio_dev));
-               strcpy(usb_kbd_dev.name, DEVNAME);
-               usb_kbd_dev.flags =  DEV_FLAGS_INPUT | DEV_FLAGS_SYSTEM;
-               usb_kbd_dev.getc = usb_kbd_getc;
-               usb_kbd_dev.tstc = usb_kbd_testc;
-               usb_kbd_dev.priv = (void *)dev;
-               error = stdio_register(&usb_kbd_dev);
-               if (error)
-                       return error;
-
-#ifdef CONFIG_CONSOLE_MUX
-               error = iomux_doenv(stdin, stdinname);
-               if (error)
-                       return error;
-#else
-               /* Check if this is the standard input device. */
-               if (strcmp(stdinname, DEVNAME))
-                       return 1;
-
-               /* Reassign the console */
-               if (overwrite_console())
+               error = probe_usb_keyboard(dev);
+               if (!error)
                        return 1;
-
-               error = console_assign(stdin, DEVNAME);
-               if (error)
+               if (error && error != -ENOENT)
                        return error;
-#endif
-
-               return 1;
        }
 
        /* No USB Keyboard found */
@@ -549,13 +570,105 @@ int drv_usb_kbd_init(void)
 /* Deregister the keyboard. */
 int usb_kbd_deregister(int force)
 {
-#ifdef CONFIG_SYS_STDIO_DEREGISTER
-       int ret = stdio_deregister(DEVNAME, force);
-       if (ret && ret != -ENODEV)
-               return ret;
+#if CONFIG_IS_ENABLED(SYS_STDIO_DEREGISTER)
+       struct stdio_dev *dev;
+       struct usb_device *usb_kbd_dev;
+       struct usb_kbd_pdata *data;
+
+       dev = stdio_get_by_name(DEVNAME);
+       if (dev) {
+               usb_kbd_dev = (struct usb_device *)dev->priv;
+               data = usb_kbd_dev->privptr;
+               if (stdio_deregister_dev(dev, force) != 0)
+                       return 1;
+#if CONFIG_IS_ENABLED(CONSOLE_MUX)
+               if (iomux_doenv(stdin, env_get("stdin")) != 0)
+                       return 1;
+#endif
+#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
+               destroy_int_queue(usb_kbd_dev, data->intq);
+#endif
+               free(data->new);
+               free(data);
+       }
 
        return 0;
 #else
        return 1;
 #endif
 }
+
+#endif
+
+#ifdef CONFIG_DM_USB
+
+static int usb_kbd_probe(struct udevice *dev)
+{
+       struct usb_device *udev = dev_get_parent_priv(dev);
+
+       return probe_usb_keyboard(udev);
+}
+
+static int usb_kbd_remove(struct udevice *dev)
+{
+       struct usb_device *udev = dev_get_parent_priv(dev);
+       struct usb_kbd_pdata *data;
+       struct stdio_dev *sdev;
+       int ret;
+
+       sdev = stdio_get_by_name(DEVNAME);
+       if (!sdev) {
+               ret = -ENXIO;
+               goto err;
+       }
+       data = udev->privptr;
+       if (stdio_deregister_dev(sdev, true)) {
+               ret = -EPERM;
+               goto err;
+       }
+#if CONFIG_IS_ENABLED(CONSOLE_MUX)
+       if (iomux_doenv(stdin, env_get("stdin"))) {
+               ret = -ENOLINK;
+               goto err;
+       }
+#endif
+#ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE
+       destroy_int_queue(udev, data->intq);
+#endif
+       free(data->new);
+       free(data);
+
+       return 0;
+err:
+       printf("%s: warning, ret=%d", __func__, ret);
+       return ret;
+}
+
+static const struct udevice_id usb_kbd_ids[] = {
+       { .compatible = "usb-keyboard" },
+       { }
+};
+
+U_BOOT_DRIVER(usb_kbd) = {
+       .name   = "usb_kbd",
+       .id     = UCLASS_KEYBOARD,
+       .of_match = usb_kbd_ids,
+       .probe = usb_kbd_probe,
+       .remove = usb_kbd_remove,
+};
+
+static const struct usb_device_id kbd_id_table[] = {
+       {
+               .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS |
+                       USB_DEVICE_ID_MATCH_INT_SUBCLASS |
+                       USB_DEVICE_ID_MATCH_INT_PROTOCOL,
+               .bInterfaceClass = USB_CLASS_HID,
+               .bInterfaceSubClass = USB_SUB_HID_BOOT,
+               .bInterfaceProtocol = USB_PROT_HID_KEYBOARD,
+       },
+       { }             /* Terminating entry */
+};
+
+U_BOOT_USB_DEVICE(usb_kbd, kbd_id_table);
+
+#endif