]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - common/usb_kbd.c
karo: add support for TXA5 (SAMA5D4) modules
[karo-tx-uboot.git] / common / usb_kbd.c
index 4efbcfe90d369fdc60028640c74efba05d3442b6..ecc3085cc0811b5471cab07415904221153abf33 100644 (file)
@@ -5,38 +5,16 @@
  * Part of this source has been derived from the Linux USB
  * project.
  *
- * See file CREDITS for list of people who contributed to this
- * project.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of
- * the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
- * MA 02111-1307 USA
- *
+ * SPDX-License-Identifier:    GPL-2.0+
  */
 #include <common.h>
+#include <errno.h>
 #include <malloc.h>
 #include <stdio_dev.h>
 #include <asm/byteorder.h>
 
 #include <usb.h>
 
-#ifdef USB_KBD_DEBUG
-#define USB_KBD_PRINTF(fmt, args...)   printf(fmt, ##args)
-#else
-#define USB_KBD_PRINTF(fmt, args...)
-#endif
-
 /*
  * If overwrite_console returns 1, the stdin, stderr and stdout
  * are switched to the serial port, else the settings in the
@@ -114,7 +92,18 @@ static const unsigned char usb_kbd_arrow[] = {
 #define USB_KBD_LEDMASK                \
        (USB_KBD_NUMLOCK | USB_KBD_CAPSLOCK | USB_KBD_SCROLLLOCK)
 
+/*
+ * USB Keyboard reports are 8 bytes in boot protocol.
+ * Appendix B of HID Device Class Definition 1.11
+ */
+#define USB_KBD_BOOT_REPORT_SIZE 8
+
 struct usb_kbd_pdata {
+       unsigned long   intpipe;
+       int             intpktsize;
+       int             intinterval;
+       struct int_queue *intq;
+
        uint32_t        repeat_delay;
 
        uint32_t        usb_in_pointer;
@@ -122,35 +111,15 @@ struct usb_kbd_pdata {
        uint8_t         usb_kbd_buffer[USB_KBD_BUFFER_LEN];
 
        uint8_t         *new;
-       uint8_t         old[8];
+       uint8_t         old[USB_KBD_BOOT_REPORT_SIZE];
 
        uint8_t         flags;
 };
 
-/* 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);
+extern int __maybe_unused net_busy_flag;
 
-       /* Submit a interrupt transfer request */
-       maxp = usb_maxpacket(usb_kbd_dev, pipe);
-       usb_submit_int_msg(usb_kbd_dev, pipe, data->new,
-                       maxp > 8 ? 8 : maxp, ep->bInterval);
-}
+/* The period of time between two calls of usb_kbd_testc(). */
+static unsigned long __maybe_unused kbd_testc_tms;
 
 /* 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)
@@ -181,11 +150,12 @@ static void usb_kbd_setled(struct usb_device *dev)
 {
        struct usb_interface *iface = &dev->config.if_desc[0];
        struct usb_kbd_pdata *data = dev->privptr;
-       uint32_t leds = data->flags & USB_KBD_LEDMASK;
+       ALLOC_ALIGN_BUFFER(uint32_t, leds, 1, USB_DMA_MINALIGN);
 
+       *leds = data->flags & USB_KBD_LEDMASK;
        usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
                USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
-               0x200, iface->desc.bInterfaceNumber, (void *)&leds, 1, 0);
+               0x200, iface->desc.bInterfaceNumber, leds, 1, 0);
 }
 
 #define CAPITAL_MASK   0x20
@@ -262,7 +232,7 @@ static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode,
 
        /* Report keycode if any */
        if (keycode) {
-               USB_KBD_PRINTF("%c", keycode);
+               debug("%c", keycode);
                usb_kbd_put_queue(data, keycode);
        }
 
@@ -284,8 +254,11 @@ static uint32_t usb_kbd_service_key(struct usb_device *dev, int i, int up)
                old = data->old;
        }
 
-       if ((old[i] > 3) && (memscan(new + 2, old[i], 6) == new + 8))
+       if ((old[i] > 3) &&
+           (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) ==
+                       new + USB_KBD_BOOT_REPORT_SIZE)) {
                res |= usb_kbd_translate(data, old[i], data->new[0], up);
+       }
 
        return res;
 }
@@ -303,7 +276,7 @@ static int usb_kbd_irq_worker(struct usb_device *dev)
        else if ((data->new[0] == LEFT_CNTR) || (data->new[0] == RIGHT_CNTR))
                data->flags |= USB_KBD_CTRL;
 
-       for (i = 2; i < 8; i++) {
+       for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) {
                res |= usb_kbd_service_key(dev, i, 0);
                res |= usb_kbd_service_key(dev, i, 1);
        }
@@ -315,7 +288,7 @@ static int usb_kbd_irq_worker(struct usb_device *dev)
        if (res == 1)
                usb_kbd_setled(dev);
 
-       memcpy(data->old, data->new, 8);
+       memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE);
 
        return 1;
 }
@@ -323,9 +296,10 @@ static int usb_kbd_irq_worker(struct usb_device *dev)
 /* Keyboard interrupt handler */
 static int usb_kbd_irq(struct usb_device *dev)
 {
-       if ((dev->irq_status != 0) || (dev->irq_act_len != 8)) {
-               USB_KBD_PRINTF("USB KBD: Error %lX, len %d\n",
-                               dev->irq_status, dev->irq_act_len);
+       if ((dev->irq_status != 0) ||
+           (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) {
+               debug("USB KBD: Error %lX, len %d\n",
+                     dev->irq_status, dev->irq_act_len);
                return 1;
        }
 
@@ -336,22 +310,11 @@ static int usb_kbd_irq(struct usb_device *dev)
 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);
+       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],
-                       maxp > 8 ? 8 : maxp, 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)
@@ -359,19 +322,39 @@ static inline void usb_kbd_poll_for_event(struct usb_device *dev)
        struct usb_kbd_pdata *data = dev->privptr;
        iface = &dev->config.if_desc[0];
        usb_get_report(dev, iface->desc.bInterfaceNumber,
-                       1, 0, data->new, sizeof(data->new));
-       if (memcmp(data->old, data->new, sizeof(data->new)))
+                      1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE);
+       if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE))
                usb_kbd_irq_worker(dev);
+#elif  defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE)
+       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
 }
 
 /* test if a character is in the queue */
-static int usb_kbd_testc(void)
+static int usb_kbd_testc(struct stdio_dev *sdev)
 {
        struct stdio_dev *dev;
        struct usb_device *usb_kbd_dev;
        struct usb_kbd_pdata *data;
 
+#ifdef CONFIG_CMD_NET
+       /*
+        * If net_busy_flag is 1, NET transfer is running,
+        * then we check key-pressed every second (first check may be
+        * less than 1 second) to improve TFTP booting performance.
+        */
+       if (net_busy_flag && (get_timer(kbd_testc_tms) < CONFIG_SYS_HZ))
+               return 0;
+       kbd_testc_tms = get_timer(0);
+#endif
        dev = stdio_get_by_name(DEVNAME);
        usb_kbd_dev = (struct usb_device *)dev->priv;
        data = usb_kbd_dev->privptr;
@@ -382,7 +365,7 @@ static int usb_kbd_testc(void)
 }
 
 /* gets the character from the queue */
-static int usb_kbd_getc(void)
+static int usb_kbd_getc(struct stdio_dev *sdev)
 {
        struct stdio_dev *dev;
        struct usb_device *usb_kbd_dev;
@@ -409,7 +392,6 @@ static int usb_kbd_probe(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;
@@ -437,7 +419,7 @@ static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
        if ((ep->bmAttributes & 3) != 3)
                return 0;
 
-       USB_KBD_PRINTF("USB KBD: found set protocol...\n");
+       debug("USB KBD: found set protocol...\n");
 
        data = malloc(sizeof(struct usb_kbd_pdata));
        if (!data) {
@@ -449,7 +431,8 @@ static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
        memset(data, 0, sizeof(struct usb_kbd_pdata));
 
        /* allocate input buffer aligned and sized to USB DMA alignment */
-       data->new = memalign(USB_DMA_MINALIGN, roundup(8, USB_DMA_MINALIGN));
+       data->new = memalign(USB_DMA_MINALIGN,
+               roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN));
 
        /* Insert private data into USB device structure */
        dev->privptr = data;
@@ -457,18 +440,32 @@ 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;
 
        /* We found a USB Keyboard, install it. */
        usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0);
 
-       USB_KBD_PRINTF("USB KBD: found set idle...\n");
+       debug("USB KBD: found set idle...\n");
        usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE, 0);
 
-       USB_KBD_PRINTF("USB KBD: enable interrupt pipe...\n");
-       usb_submit_int_msg(dev, pipe, data->new, maxp > 8 ? 8 : maxp,
-                               ep->bInterval);
+       debug("USB KBD: enable interrupt pipe...\n");
+#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) {
+#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. */
+               return 0;
+       }
 
        /* Success. */
        return 1;
@@ -477,7 +474,7 @@ static int usb_kbd_probe(struct usb_device *dev, unsigned int ifnum)
 /* Search for keyboard and register it if found. */
 int drv_usb_kbd_init(void)
 {
-       struct stdio_dev usb_kbd_dev, *old_dev;
+       struct stdio_dev usb_kbd_dev;
        struct usb_device *dev;
        char *stdinname = getenv("stdin");
        int error, i;
@@ -496,22 +493,11 @@ int drv_usb_kbd_init(void)
                if (usb_kbd_probe(dev, 0) != 1)
                        continue;
 
-               /* We found a keyboard, check if it is already registered. */
-               USB_KBD_PRINTF("USB KBD: found set up device.\n");
-               old_dev = stdio_get_by_name(DEVNAME);
-               if (old_dev) {
-                       /* Already registered, just return ok. */
-                       USB_KBD_PRINTF("USB KBD: is already registered.\n");
-                       return 1;
-               }
-
                /* Register the keyboard */
-               USB_KBD_PRINTF("USB KBD: register.\n");
+               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.putc = NULL;
-               usb_kbd_dev.puts = NULL;
                usb_kbd_dev.getc = usb_kbd_getc;
                usb_kbd_dev.tstc = usb_kbd_testc;
                usb_kbd_dev.priv = (void *)dev;
@@ -545,10 +531,31 @@ int drv_usb_kbd_init(void)
 }
 
 /* Deregister the keyboard. */
-int usb_kbd_deregister(void)
+int usb_kbd_deregister(int force)
 {
 #ifdef CONFIG_SYS_STDIO_DEREGISTER
-       return stdio_deregister(DEVNAME);
+       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;
+#ifdef CONFIG_CONSOLE_MUX
+               if (iomux_doenv(stdin, getenv("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