Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | // SPDX-License-Identifier: GPL-2.0+ |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 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. |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 8 | */ |
Simon Glass | a73bda4 | 2015-11-08 23:47:45 -0700 | [diff] [blame] | 9 | #include <console.h> |
Simon Glass | 5f1296b | 2015-03-25 12:22:34 -0600 | [diff] [blame] | 10 | #include <dm.h> |
Simon Glass | 0af6e2d | 2019-08-01 09:46:52 -0600 | [diff] [blame] | 11 | #include <env.h> |
Hans de Goede | f565623 | 2014-09-20 16:54:34 +0200 | [diff] [blame] | 12 | #include <errno.h> |
Simon Glass | 0f2af88 | 2020-05-10 11:40:05 -0600 | [diff] [blame] | 13 | #include <log.h> |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 14 | #include <malloc.h> |
Simon Glass | 2dd337a | 2015-09-02 17:24:58 -0600 | [diff] [blame] | 15 | #include <memalign.h> |
Jean-Christophe PLAGNIOL-VILLARD | 2a7a031 | 2009-05-16 12:14:54 +0200 | [diff] [blame] | 16 | #include <stdio_dev.h> |
Tom Rini | dec7ea0 | 2024-05-20 13:35:03 -0600 | [diff] [blame] | 17 | #include <time.h> |
Michal Simek | 07b3cc9 | 2018-06-27 14:16:54 +0200 | [diff] [blame] | 18 | #include <watchdog.h> |
Christian Eggers | 4e0e8d0 | 2008-05-21 22:12:00 +0200 | [diff] [blame] | 19 | #include <asm/byteorder.h> |
Thomas Watson | d36c85a | 2022-02-10 15:13:14 -0600 | [diff] [blame] | 20 | #ifdef CONFIG_SANDBOX |
| 21 | #include <asm/state.h> |
| 22 | #endif |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 23 | |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 24 | #include <usb.h> |
| 25 | |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 26 | /* |
Janne Grunau | 4a7fda9 | 2024-04-04 08:25:53 +0200 | [diff] [blame] | 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 | |
Janne Grunau | c838172 | 2024-04-04 08:25:54 +0200 | [diff] [blame] | 34 | #define USB_VENDOR_ID_KEYCHRON 0x3434 |
| 35 | |
| 36 | #define USB_HID_QUIRK_POLL_NO_REPORT_IDLE BIT(0) |
| 37 | |
Janne Grunau | 4a7fda9 | 2024-04-04 08:25:53 +0200 | [diff] [blame] | 38 | /* |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 39 | * If overwrite_console returns 1, the stdin, stderr and stdout |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 40 | * are switched to the serial port, else the settings in the |
| 41 | * environment are used |
| 42 | */ |
Jean-Christophe PLAGNIOL-VILLARD | 0383694 | 2008-10-16 15:01:15 +0200 | [diff] [blame] | 43 | #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 44 | extern int overwrite_console(void); |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 45 | #else |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 46 | int overwrite_console(void) |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 47 | { |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 48 | return 0; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 49 | } |
| 50 | #endif |
| 51 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 52 | /* Keyboard sampling rate */ |
Hans de Goede | 650d720 | 2015-05-19 22:51:03 +0200 | [diff] [blame] | 53 | #define REPEAT_RATE 40 /* 40msec -> 25cps */ |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 54 | #define REPEAT_DELAY 10 /* 10 x REPEAT_RATE = 400msec */ |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 55 | |
| 56 | #define NUM_LOCK 0x53 |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 57 | #define CAPS_LOCK 0x39 |
| 58 | #define SCROLL_LOCK 0x47 |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 59 | |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 60 | /* Modifier bits */ |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 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) |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 69 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 70 | /* Size of the keyboard buffer */ |
| 71 | #define USB_KBD_BUFFER_LEN 0x20 |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 72 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 73 | /* Device name */ |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 74 | #define DEVNAME "usbkbd" |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 75 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 76 | /* Keyboard maps */ |
| 77 | static const unsigned char usb_kbd_numkey[] = { |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 78 | '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', |
| 79 | '\r', 0x1b, '\b', '\t', ' ', '-', '=', '[', ']', |
| 80 | '\\', '#', ';', '\'', '`', ',', '.', '/' |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 81 | }; |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 82 | static const unsigned char usb_kbd_numkey_shifted[] = { |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 83 | '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', |
| 84 | '\r', 0x1b, '\b', '\t', ' ', '_', '+', '{', '}', |
| 85 | '|', '~', ':', '"', '~', '<', '>', '?' |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 86 | }; |
| 87 | |
Vincent Palatin | 92f6a62 | 2012-01-09 12:59:36 +0000 | [diff] [blame] | 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 | |
Heinrich Schuchardt | d05aaef | 2019-11-23 18:15:20 +0100 | [diff] [blame] | 94 | static const u8 usb_special_keys[] = { |
Heinrich Schuchardt | 8e505ee | 2019-11-23 18:15:21 +0100 | [diff] [blame] | 95 | #ifdef CONFIG_USB_KEYBOARD_FN_KEYS |
| 96 | '2', 'H', '5', '3', 'F', '6', 'C', 'D', 'B', 'A' |
| 97 | #else |
Heinrich Schuchardt | d05aaef | 2019-11-23 18:15:20 +0100 | [diff] [blame] | 98 | 'C', 'D', 'B', 'A' |
Heinrich Schuchardt | 8e505ee | 2019-11-23 18:15:21 +0100 | [diff] [blame] | 99 | #endif |
Allen Martin | 1bfb4cd | 2012-11-06 13:26:03 -0800 | [diff] [blame] | 100 | }; |
| 101 | |
| 102 | /* |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 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) |
Marek Vasut | 82cf9a4 | 2011-09-25 20:00:37 +0100 | [diff] [blame] | 110 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 111 | #define USB_KBD_LEDMASK \ |
| 112 | (USB_KBD_NUMLOCK | USB_KBD_CAPSLOCK | USB_KBD_SCROLLLOCK) |
Marek Vasut | 82cf9a4 | 2011-09-25 20:00:37 +0100 | [diff] [blame] | 113 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 114 | struct usb_kbd_pdata { |
Hans de Goede | 3c79470 | 2014-09-24 14:06:10 +0200 | [diff] [blame] | 115 | unsigned long intpipe; |
| 116 | int intpktsize; |
| 117 | int intinterval; |
Hans de Goede | 650d720 | 2015-05-19 22:51:03 +0200 | [diff] [blame] | 118 | unsigned long last_report; |
Hans de Goede | 2d02ae7 | 2014-09-24 14:06:11 +0200 | [diff] [blame] | 119 | struct int_queue *intq; |
Hans de Goede | 3c79470 | 2014-09-24 14:06:10 +0200 | [diff] [blame] | 120 | |
Janne Grunau | 4a7fda9 | 2024-04-04 08:25:53 +0200 | [diff] [blame] | 121 | uint32_t ifnum; |
| 122 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 123 | uint32_t repeat_delay; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 124 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 125 | uint32_t usb_in_pointer; |
| 126 | uint32_t usb_out_pointer; |
| 127 | uint8_t usb_kbd_buffer[USB_KBD_BUFFER_LEN]; |
Marek Vasut | 82cf9a4 | 2011-09-25 20:00:37 +0100 | [diff] [blame] | 128 | |
Allen Martin | ef769ca | 2012-10-24 08:32:04 +0000 | [diff] [blame] | 129 | uint8_t *new; |
Adrian Cox | 17472dc | 2014-04-10 14:02:44 +0100 | [diff] [blame] | 130 | uint8_t old[USB_KBD_BOOT_REPORT_SIZE]; |
Marek Vasut | 82cf9a4 | 2011-09-25 20:00:37 +0100 | [diff] [blame] | 131 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 132 | uint8_t flags; |
| 133 | }; |
Marek Vasut | 82cf9a4 | 2011-09-25 20:00:37 +0100 | [diff] [blame] | 134 | |
Jim Lin | c562f97 | 2013-08-13 19:04:22 +0800 | [diff] [blame] | 135 | extern int __maybe_unused net_busy_flag; |
| 136 | |
| 137 | /* The period of time between two calls of usb_kbd_testc(). */ |
Thomas Watson | d36c85a | 2022-02-10 15:13:14 -0600 | [diff] [blame] | 138 | static unsigned long kbd_testc_tms; |
Jim Lin | c562f97 | 2013-08-13 19:04:22 +0800 | [diff] [blame] | 139 | |
Simon Glass | 1880b8a | 2024-09-01 16:26:20 -0600 | [diff] [blame] | 140 | int usb_kbd_remove_for_test(void) |
| 141 | { |
| 142 | return console_remove_by_name(DEVNAME); |
| 143 | } |
| 144 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 145 | /* Puts character in the queue and sets up the in and out pointer. */ |
Heinrich Schuchardt | 90d746f | 2019-11-23 18:15:19 +0100 | [diff] [blame] | 146 | static void usb_kbd_put_queue(struct usb_kbd_pdata *data, u8 c) |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 147 | { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 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; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 152 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 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; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 158 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 159 | data->usb_in_pointer++; |
| 160 | } |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 161 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 162 | data->usb_kbd_buffer[data->usb_in_pointer] = c; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 163 | } |
| 164 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 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. |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 169 | */ |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 170 | static void usb_kbd_setled(struct usb_device *dev) |
| 171 | { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 172 | struct usb_kbd_pdata *data = dev->privptr; |
Janne Grunau | 4a7fda9 | 2024-04-04 08:25:53 +0200 | [diff] [blame] | 173 | struct usb_interface *iface = &dev->config.if_desc[data->ifnum]; |
Hans de Goede | e402b6c | 2014-09-20 16:51:26 +0200 | [diff] [blame] | 174 | ALLOC_ALIGN_BUFFER(uint32_t, leds, 1, USB_DMA_MINALIGN); |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 175 | |
Hans de Goede | e402b6c | 2014-09-20 16:51:26 +0200 | [diff] [blame] | 176 | *leds = data->flags & USB_KBD_LEDMASK; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 177 | usb_control_msg(dev, usb_sndctrlpipe(dev, 0), |
| 178 | USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE, |
Hans de Goede | e402b6c | 2014-09-20 16:51:26 +0200 | [diff] [blame] | 179 | 0x200, iface->desc.bInterfaceNumber, leds, 1, 0); |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 180 | } |
| 181 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 182 | #define CAPITAL_MASK 0x20 |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 183 | /* Translate the scancode in ASCII */ |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 184 | static int usb_kbd_translate(struct usb_kbd_pdata *data, unsigned char scancode, |
| 185 | unsigned char modifier, int pressed) |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 186 | { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 187 | uint8_t keycode = 0; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 188 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 189 | /* Key released */ |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 190 | if (pressed == 0) { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 191 | data->repeat_delay = 0; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 192 | return 0; |
| 193 | } |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 194 | |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 195 | if (pressed == 2) { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 196 | data->repeat_delay++; |
| 197 | if (data->repeat_delay < REPEAT_DELAY) |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 198 | return 0; |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 199 | |
| 200 | data->repeat_delay = REPEAT_DELAY; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 201 | } |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 202 | |
| 203 | /* Alphanumeric values */ |
| 204 | if ((scancode > 3) && (scancode <= 0x1d)) { |
| 205 | keycode = scancode - 4 + 'a'; |
| 206 | |
| 207 | if (data->flags & USB_KBD_CAPSLOCK) |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 208 | keycode &= ~CAPITAL_MASK; |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 209 | |
| 210 | if (modifier & (LEFT_SHIFT | RIGHT_SHIFT)) { |
| 211 | /* Handle CAPSLock + Shift pressed simultaneously */ |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 212 | if (keycode & CAPITAL_MASK) |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 213 | keycode &= ~CAPITAL_MASK; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 214 | else |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 215 | keycode |= CAPITAL_MASK; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 216 | } |
| 217 | } |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 218 | |
Marek Vasut | 0082cd1 | 2016-01-25 22:00:44 +0100 | [diff] [blame] | 219 | if ((scancode > 0x1d) && (scancode < 0x39)) { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 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]; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 225 | } |
Zhang Wei | 37cc4f0 | 2008-01-03 10:51:15 +0800 | [diff] [blame] | 226 | |
Vincent Palatin | 92f6a62 | 2012-01-09 12:59:36 +0000 | [diff] [blame] | 227 | /* Numeric keypad */ |
| 228 | if ((scancode >= 0x54) && (scancode <= 0x67)) |
| 229 | keycode = usb_kbd_num_keypad[scancode - 0x54]; |
| 230 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 231 | if (data->flags & USB_KBD_CTRL) |
Zhang Wei | 37cc4f0 | 2008-01-03 10:51:15 +0800 | [diff] [blame] | 232 | keycode = scancode - 0x3; |
| 233 | |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 234 | if (pressed == 1) { |
| 235 | if (scancode == NUM_LOCK) { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 236 | data->flags ^= USB_KBD_NUMLOCK; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 237 | return 1; |
| 238 | } |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 239 | |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 240 | if (scancode == CAPS_LOCK) { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 241 | data->flags ^= USB_KBD_CAPSLOCK; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 242 | return 1; |
| 243 | } |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 244 | if (scancode == SCROLL_LOCK) { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 245 | data->flags ^= USB_KBD_SCROLLLOCK; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 246 | return 1; |
| 247 | } |
| 248 | } |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 249 | |
| 250 | /* Report keycode if any */ |
Heinrich Schuchardt | d05aaef | 2019-11-23 18:15:20 +0100 | [diff] [blame] | 251 | if (keycode) { |
Vivek Gautam | f94c95d | 2013-04-12 16:34:33 +0530 | [diff] [blame] | 252 | debug("%c", keycode); |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 253 | usb_kbd_put_queue(data, keycode); |
Heinrich Schuchardt | d05aaef | 2019-11-23 18:15:20 +0100 | [diff] [blame] | 254 | return 0; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 255 | } |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 256 | |
Heinrich Schuchardt | 8e505ee | 2019-11-23 18:15:21 +0100 | [diff] [blame] | 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 |
Heinrich Schuchardt | d05aaef | 2019-11-23 18:15:20 +0100 | [diff] [blame] | 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; |
Heinrich Schuchardt | 8e505ee | 2019-11-23 18:15:21 +0100 | [diff] [blame] | 302 | #endif /* CONFIG_USB_KEYBOARD_FN_KEYS */ |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 303 | } |
| 304 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 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 | |
Adrian Cox | 17472dc | 2014-04-10 14:02:44 +0100 | [diff] [blame] | 320 | if ((old[i] > 3) && |
| 321 | (memscan(new + 2, old[i], USB_KBD_BOOT_REPORT_SIZE - 2) == |
| 322 | new + USB_KBD_BOOT_REPORT_SIZE)) { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 323 | res |= usb_kbd_translate(data, old[i], data->new[0], up); |
Adrian Cox | 17472dc | 2014-04-10 14:02:44 +0100 | [diff] [blame] | 324 | } |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 325 | |
| 326 | return res; |
| 327 | } |
| 328 | |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 329 | /* Interrupt service routine */ |
Marek Vasut | 82cf9a4 | 2011-09-25 20:00:37 +0100 | [diff] [blame] | 330 | static int usb_kbd_irq_worker(struct usb_device *dev) |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 331 | { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 332 | struct usb_kbd_pdata *data = dev->privptr; |
| 333 | int i, res = 0; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 334 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 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; |
Zhang Wei | 37cc4f0 | 2008-01-03 10:51:15 +0800 | [diff] [blame] | 341 | |
Adrian Cox | 17472dc | 2014-04-10 14:02:44 +0100 | [diff] [blame] | 342 | for (i = 2; i < USB_KBD_BOOT_REPORT_SIZE; i++) { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 343 | res |= usb_kbd_service_key(dev, i, 0); |
| 344 | res |= usb_kbd_service_key(dev, i, 1); |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 345 | } |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 346 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 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 | |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 351 | if (res == 1) |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 352 | usb_kbd_setled(dev); |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 353 | |
Adrian Cox | 17472dc | 2014-04-10 14:02:44 +0100 | [diff] [blame] | 354 | memcpy(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE); |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 355 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 356 | return 1; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 357 | } |
| 358 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 359 | /* Keyboard interrupt handler */ |
Marek Vasut | 82cf9a4 | 2011-09-25 20:00:37 +0100 | [diff] [blame] | 360 | static int usb_kbd_irq(struct usb_device *dev) |
| 361 | { |
Adrian Cox | 17472dc | 2014-04-10 14:02:44 +0100 | [diff] [blame] | 362 | if ((dev->irq_status != 0) || |
| 363 | (dev->irq_act_len != USB_KBD_BOOT_REPORT_SIZE)) { |
Vivek Gautam | f94c95d | 2013-04-12 16:34:33 +0530 | [diff] [blame] | 364 | debug("USB KBD: Error %lX, len %d\n", |
| 365 | dev->irq_status, dev->irq_act_len); |
Marek Vasut | 82cf9a4 | 2011-09-25 20:00:37 +0100 | [diff] [blame] | 366 | return 1; |
| 367 | } |
| 368 | |
| 369 | return usb_kbd_irq_worker(dev); |
| 370 | } |
| 371 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 372 | /* Interrupt polling */ |
| 373 | static inline void usb_kbd_poll_for_event(struct usb_device *dev) |
| 374 | { |
Hans de Goede | 650d720 | 2015-05-19 22:51:03 +0200 | [diff] [blame] | 375 | #if defined(CONFIG_SYS_USB_EVENT_POLL) |
Hans de Goede | 3c79470 | 2014-09-24 14:06:10 +0200 | [diff] [blame] | 376 | struct usb_kbd_pdata *data = dev->privptr; |
amartin@nvidia.com | 185da95 | 2011-12-20 14:56:16 +0000 | [diff] [blame] | 377 | |
Heinrich Schuchardt | 38ed7fe | 2019-11-23 18:15:18 +0100 | [diff] [blame] | 378 | /* Submit an interrupt transfer request */ |
Michal Suchanek | f5d5af4 | 2019-08-18 10:55:25 +0200 | [diff] [blame] | 379 | if (usb_int_msg(dev, data->intpipe, &data->new[0], |
Michal Suchanek | 1c95b9f | 2019-08-18 10:55:27 +0200 | [diff] [blame] | 380 | data->intpktsize, data->intinterval, true) >= 0) |
Michal Suchanek | 46c83f3 | 2019-08-18 10:55:24 +0200 | [diff] [blame] | 381 | usb_kbd_irq_worker(dev); |
Hans de Goede | 650d720 | 2015-05-19 22:51:03 +0200 | [diff] [blame] | 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) |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 385 | struct usb_interface *iface; |
| 386 | struct usb_kbd_pdata *data = dev->privptr; |
Janne Grunau | 4a7fda9 | 2024-04-04 08:25:53 +0200 | [diff] [blame] | 387 | iface = &dev->config.if_desc[data->ifnum]; |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 388 | usb_get_report(dev, iface->desc.bInterfaceNumber, |
Adrian Cox | 17472dc | 2014-04-10 14:02:44 +0100 | [diff] [blame] | 389 | 1, 0, data->new, USB_KBD_BOOT_REPORT_SIZE); |
Hans de Goede | 650d720 | 2015-05-19 22:51:03 +0200 | [diff] [blame] | 390 | if (memcmp(data->old, data->new, USB_KBD_BOOT_REPORT_SIZE)) { |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 391 | usb_kbd_irq_worker(dev); |
Hans de Goede | 650d720 | 2015-05-19 22:51:03 +0200 | [diff] [blame] | 392 | #else |
Hans de Goede | 2d02ae7 | 2014-09-24 14:06:11 +0200 | [diff] [blame] | 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, |
Hans de Goede | bbd2d2a | 2015-01-11 20:38:28 +0100 | [diff] [blame] | 399 | USB_KBD_BOOT_REPORT_SIZE, data->new, |
| 400 | data->intinterval); |
Hans de Goede | 650d720 | 2015-05-19 22:51:03 +0200 | [diff] [blame] | 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); |
Hans de Goede | 2d02ae7 | 2014-09-24 14:06:11 +0200 | [diff] [blame] | 408 | } |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 409 | #endif |
| 410 | } |
| 411 | |
| 412 | /* test if a character is in the queue */ |
Simon Glass | 0d1e1f7 | 2014-07-23 06:54:59 -0600 | [diff] [blame] | 413 | static int usb_kbd_testc(struct stdio_dev *sdev) |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 414 | { |
| 415 | struct stdio_dev *dev; |
| 416 | struct usb_device *usb_kbd_dev; |
| 417 | struct usb_kbd_pdata *data; |
| 418 | |
Thomas Watson | d36c85a | 2022-02-10 15:13:14 -0600 | [diff] [blame] | 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 | |
Jerome Forissier | 1ff0036 | 2024-10-16 12:04:03 +0200 | [diff] [blame] | 426 | #if defined(CONFIG_CMD_NET) && !defined(CONFIG_NET_LWIP) |
Jim Lin | e2ebec8 | 2013-08-26 20:21:09 +0800 | [diff] [blame] | 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 | */ |
Thomas Watson | d36c85a | 2022-02-10 15:13:14 -0600 | [diff] [blame] | 432 | if (net_busy_flag) |
| 433 | poll_delay = CONFIG_SYS_HZ; |
Jim Lin | e2ebec8 | 2013-08-26 20:21:09 +0800 | [diff] [blame] | 434 | #endif |
Thomas Watson | d36c85a | 2022-02-10 15:13:14 -0600 | [diff] [blame] | 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 | |
Michal Simek | 2b0634d | 2018-06-27 14:35:07 +0200 | [diff] [blame] | 444 | dev = stdio_get_by_name(sdev->name); |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 445 | usb_kbd_dev = (struct usb_device *)dev->priv; |
| 446 | data = usb_kbd_dev->privptr; |
| 447 | |
Thomas Watson | d36c85a | 2022-02-10 15:13:14 -0600 | [diff] [blame] | 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 | } |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 452 | |
| 453 | return !(data->usb_in_pointer == data->usb_out_pointer); |
| 454 | } |
| 455 | |
| 456 | /* gets the character from the queue */ |
Simon Glass | 0d1e1f7 | 2014-07-23 06:54:59 -0600 | [diff] [blame] | 457 | static int usb_kbd_getc(struct stdio_dev *sdev) |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 458 | { |
| 459 | struct stdio_dev *dev; |
| 460 | struct usb_device *usb_kbd_dev; |
| 461 | struct usb_kbd_pdata *data; |
| 462 | |
Michal Simek | 2b0634d | 2018-06-27 14:35:07 +0200 | [diff] [blame] | 463 | dev = stdio_get_by_name(sdev->name); |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 464 | usb_kbd_dev = (struct usb_device *)dev->priv; |
| 465 | data = usb_kbd_dev->privptr; |
| 466 | |
Michal Simek | 07b3cc9 | 2018-06-27 14:16:54 +0200 | [diff] [blame] | 467 | while (data->usb_in_pointer == data->usb_out_pointer) { |
Stefan Roese | 80877fa | 2022-09-02 14:10:46 +0200 | [diff] [blame] | 468 | schedule(); |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 469 | usb_kbd_poll_for_event(usb_kbd_dev); |
Michal Simek | 07b3cc9 | 2018-06-27 14:16:54 +0200 | [diff] [blame] | 470 | } |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 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. */ |
Simon Glass | 02f0c28 | 2015-09-08 11:15:11 -0600 | [diff] [blame] | 481 | static int usb_kbd_probe_dev(struct usb_device *dev, unsigned int ifnum) |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 482 | { |
Tom Rix | 83b9e1d | 2009-10-31 12:37:38 -0500 | [diff] [blame] | 483 | struct usb_interface *iface; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 484 | struct usb_endpoint_descriptor *ep; |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 485 | struct usb_kbd_pdata *data; |
Janne Grunau | c838172 | 2024-04-04 08:25:54 +0200 | [diff] [blame] | 486 | unsigned int quirks = 0; |
Stefan Brüns | 6de61c8 | 2021-02-20 17:26:06 +0100 | [diff] [blame] | 487 | int epNum; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 488 | |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 489 | if (dev->descriptor.bNumConfigurations != 1) |
| 490 | return 0; |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 491 | |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 492 | iface = &dev->config.if_desc[ifnum]; |
| 493 | |
Simon Glass | ab88fdb | 2015-11-08 23:48:04 -0700 | [diff] [blame] | 494 | if (iface->desc.bInterfaceClass != USB_CLASS_HID) |
Tom Rix | 83b9e1d | 2009-10-31 12:37:38 -0500 | [diff] [blame] | 495 | return 0; |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 496 | |
Simon Glass | ab88fdb | 2015-11-08 23:48:04 -0700 | [diff] [blame] | 497 | if (iface->desc.bInterfaceSubClass != USB_SUB_HID_BOOT) |
Tom Rix | 83b9e1d | 2009-10-31 12:37:38 -0500 | [diff] [blame] | 498 | return 0; |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 499 | |
Simon Glass | ab88fdb | 2015-11-08 23:48:04 -0700 | [diff] [blame] | 500 | if (iface->desc.bInterfaceProtocol != USB_PROT_HID_KEYBOARD) |
Tom Rix | 83b9e1d | 2009-10-31 12:37:38 -0500 | [diff] [blame] | 501 | return 0; |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 502 | |
Stefan Brüns | 6de61c8 | 2021-02-20 17:26:06 +0100 | [diff] [blame] | 503 | for (epNum = 0; epNum < iface->desc.bNumEndpoints; epNum++) { |
| 504 | ep = &iface->ep_desc[epNum]; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 505 | |
Stefan Brüns | 6de61c8 | 2021-02-20 17:26:06 +0100 | [diff] [blame] | 506 | /* Check if endpoint is interrupt IN endpoint */ |
| 507 | if ((ep->bmAttributes & 3) != 3) |
| 508 | continue; |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 509 | |
Stefan Brüns | 6de61c8 | 2021-02-20 17:26:06 +0100 | [diff] [blame] | 510 | if (ep->bEndpointAddress & 0x80) |
| 511 | break; |
| 512 | } |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 513 | |
Stefan Brüns | 6de61c8 | 2021-02-20 17:26:06 +0100 | [diff] [blame] | 514 | if (epNum == iface->desc.bNumEndpoints) |
Marek Vasut | b930098 | 2011-10-10 05:34:25 +0000 | [diff] [blame] | 515 | return 0; |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 516 | |
Stefan Brüns | 6de61c8 | 2021-02-20 17:26:06 +0100 | [diff] [blame] | 517 | debug("USB KBD: found interrupt EP: 0x%x\n", ep->bEndpointAddress); |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 518 | |
Janne Grunau | c838172 | 2024-04-04 08:25:54 +0200 | [diff] [blame] | 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 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 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 | |
Allen Martin | ef769ca | 2012-10-24 08:32:04 +0000 | [diff] [blame] | 537 | /* allocate input buffer aligned and sized to USB DMA alignment */ |
Adrian Cox | 17472dc | 2014-04-10 14:02:44 +0100 | [diff] [blame] | 538 | data->new = memalign(USB_DMA_MINALIGN, |
| 539 | roundup(USB_KBD_BOOT_REPORT_SIZE, USB_DMA_MINALIGN)); |
Allen Martin | ef769ca | 2012-10-24 08:32:04 +0000 | [diff] [blame] | 540 | |
Janne Grunau | 4a7fda9 | 2024-04-04 08:25:53 +0200 | [diff] [blame] | 541 | data->ifnum = ifnum; |
| 542 | |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 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 | |
Hans de Goede | 3c79470 | 2014-09-24 14:06:10 +0200 | [diff] [blame] | 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; |
Hans de Goede | 650d720 | 2015-05-19 22:51:03 +0200 | [diff] [blame] | 553 | data->last_report = -1; |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 554 | |
| 555 | /* We found a USB Keyboard, install it. */ |
Stefan Brüns | 6de61c8 | 2021-02-20 17:26:06 +0100 | [diff] [blame] | 556 | debug("USB KBD: set boot protocol\n"); |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 557 | usb_set_protocol(dev, iface->desc.bInterfaceNumber, 0); |
| 558 | |
Hans de Goede | 650d720 | 2015-05-19 22:51:03 +0200 | [diff] [blame] | 559 | #if !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_CONTROL_EP) && \ |
| 560 | !defined(CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE) |
Stefan Brüns | 6de61c8 | 2021-02-20 17:26:06 +0100 | [diff] [blame] | 561 | debug("USB KBD: set idle interval...\n"); |
Hans de Goede | 650d720 | 2015-05-19 22:51:03 +0200 | [diff] [blame] | 562 | usb_set_idle(dev, iface->desc.bInterfaceNumber, REPEAT_RATE / 4, 0); |
Hans de Goede | d4e99a6 | 2015-06-18 22:34:34 +0200 | [diff] [blame] | 563 | #else |
Stefan Brüns | 6de61c8 | 2021-02-20 17:26:06 +0100 | [diff] [blame] | 564 | debug("USB KBD: set idle interval=0...\n"); |
Hans de Goede | d4e99a6 | 2015-06-18 22:34:34 +0200 | [diff] [blame] | 565 | usb_set_idle(dev, iface->desc.bInterfaceNumber, 0, 0); |
Hans de Goede | 650d720 | 2015-05-19 22:51:03 +0200 | [diff] [blame] | 566 | #endif |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 567 | |
Janne Grunau | c838172 | 2024-04-04 08:25:54 +0200 | [diff] [blame] | 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 | } |
Vivek Gautam | f94c95d | 2013-04-12 16:34:33 +0530 | [diff] [blame] | 576 | debug("USB KBD: enable interrupt pipe...\n"); |
Hans de Goede | 2d02ae7 | 2014-09-24 14:06:11 +0200 | [diff] [blame] | 577 | #ifdef CONFIG_SYS_USB_EVENT_POLL_VIA_INT_QUEUE |
| 578 | data->intq = create_int_queue(dev, data->intpipe, 1, |
Hans de Goede | bbd2d2a | 2015-01-11 20:38:28 +0100 | [diff] [blame] | 579 | USB_KBD_BOOT_REPORT_SIZE, data->new, |
| 580 | data->intinterval); |
Hans de Goede | 2d02ae7 | 2014-09-24 14:06:11 +0200 | [diff] [blame] | 581 | if (!data->intq) { |
Stephen Warren | 1fd879e | 2015-11-13 13:34:09 -0700 | [diff] [blame] | 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) { |
Hans de Goede | 2d02ae7 | 2014-09-24 14:06:11 +0200 | [diff] [blame] | 585 | #else |
Michal Suchanek | f5d5af4 | 2019-08-18 10:55:25 +0200 | [diff] [blame] | 586 | if (usb_int_msg(dev, data->intpipe, data->new, data->intpktsize, |
Michal Suchanek | 1c95b9f | 2019-08-18 10:55:27 +0200 | [diff] [blame] | 587 | data->intinterval, false) < 0) { |
Hans de Goede | 2d02ae7 | 2014-09-24 14:06:11 +0200 | [diff] [blame] | 588 | #endif |
Vincent Palatin | 0eab998 | 2013-05-10 19:48:59 -0700 | [diff] [blame] | 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 | } |
Marek Vasut | 7534a3e | 2011-10-10 16:34:26 +0100 | [diff] [blame] | 594 | |
| 595 | /* Success. */ |
wdenk | affae2b | 2002-08-17 09:36:01 +0000 | [diff] [blame] | 596 | return 1; |
| 597 | } |
| 598 | |
Simon Glass | fcdc0c3 | 2015-03-25 12:22:33 -0600 | [diff] [blame] | 599 | static int probe_usb_keyboard(struct usb_device *dev) |
| 600 | { |
| 601 | char *stdinname; |
| 602 | struct stdio_dev usb_kbd_dev; |
Janne Grunau | 4a7fda9 | 2024-04-04 08:25:53 +0200 | [diff] [blame] | 603 | unsigned int ifnum; |
| 604 | unsigned int max_ifnum = min((unsigned int)USB_MAX_ACTIVE_INTERFACES, |
| 605 | (unsigned int)dev->config.no_of_if); |
Simon Glass | fcdc0c3 | 2015-03-25 12:22:33 -0600 | [diff] [blame] | 606 | int error; |
| 607 | |
| 608 | /* Try probing the keyboard */ |
Janne Grunau | 4a7fda9 | 2024-04-04 08:25:53 +0200 | [diff] [blame] | 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) |
Simon Glass | fcdc0c3 | 2015-03-25 12:22:33 -0600 | [diff] [blame] | 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); |
Simon Glass | e21ad26 | 2024-09-01 16:26:19 -0600 | [diff] [blame] | 620 | usb_kbd_dev.flags = DEV_FLAGS_INPUT | DEV_FLAGS_DM; |
Simon Glass | fcdc0c3 | 2015-03-25 12:22:33 -0600 | [diff] [blame] | 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 | |
Simon Glass | 64b723f | 2017-08-03 12:22:12 -0600 | [diff] [blame] | 628 | stdinname = env_get("stdin"); |
Simon Glass | dfc2535 | 2017-01-16 07:03:26 -0700 | [diff] [blame] | 629 | #if CONFIG_IS_ENABLED(CONSOLE_MUX) |
Kory Maincent | 70ffe4e | 2022-06-22 10:59:31 +0200 | [diff] [blame] | 630 | if (strstr(stdinname, DEVNAME) != NULL) { |
| 631 | error = iomux_doenv(stdin, stdinname); |
| 632 | if (error) |
| 633 | return error; |
| 634 | } |
Simon Glass | fcdc0c3 | 2015-03-25 12:22:33 -0600 | [diff] [blame] | 635 | #else |
| 636 | /* Check if this is the standard input device. */ |
Kory Maincent | 70ffe4e | 2022-06-22 10:59:31 +0200 | [diff] [blame] | 637 | if (!strcmp(stdinname, DEVNAME)) { |
| 638 | /* Reassign the console */ |
| 639 | if (overwrite_console()) |
| 640 | return 1; |
Simon Glass | fcdc0c3 | 2015-03-25 12:22:33 -0600 | [diff] [blame] | 641 | |
Kory Maincent | 70ffe4e | 2022-06-22 10:59:31 +0200 | [diff] [blame] | 642 | error = console_assign(stdin, DEVNAME); |
| 643 | if (error) |
| 644 | return error; |
| 645 | } |
Simon Glass | fcdc0c3 | 2015-03-25 12:22:33 -0600 | [diff] [blame] | 646 | #endif |
| 647 | |
| 648 | return 0; |
| 649 | } |
| 650 | |
Simon Glass | 02f0c28 | 2015-09-08 11:15:11 -0600 | [diff] [blame] | 651 | static int usb_kbd_probe(struct udevice *dev) |
| 652 | { |
| 653 | struct usb_device *udev = dev_get_parent_priv(dev); |
Simon Glass | 02f0c28 | 2015-09-08 11:15:11 -0600 | [diff] [blame] | 654 | |
Masahiro Yamada | 9b70df5 | 2016-09-06 22:17:35 +0900 | [diff] [blame] | 655 | return probe_usb_keyboard(udev); |
Simon Glass | 02f0c28 | 2015-09-08 11:15:11 -0600 | [diff] [blame] | 656 | } |
| 657 | |
Simon Glass | 3c3ba90 | 2016-01-03 13:50:31 -0700 | [diff] [blame] | 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; |
Simon Glass | dfc2535 | 2017-01-16 07:03:26 -0700 | [diff] [blame] | 671 | #if CONFIG_IS_ENABLED(CONSOLE_MUX) |
Andy Shevchenko | 05a17e8 | 2021-02-11 17:09:44 +0200 | [diff] [blame] | 672 | if (iomux_replace_device(stdin, DEVNAME, "nulldev")) { |
Simon Glass | 3c3ba90 | 2016-01-03 13:50:31 -0700 | [diff] [blame] | 673 | ret = -ENOLINK; |
| 674 | goto err; |
| 675 | } |
| 676 | #endif |
Andy Shevchenko | 05a17e8 | 2021-02-11 17:09:44 +0200 | [diff] [blame] | 677 | if (stdio_deregister_dev(sdev, true)) { |
| 678 | ret = -EPERM; |
| 679 | goto err; |
| 680 | } |
Simon Glass | 3c3ba90 | 2016-01-03 13:50:31 -0700 | [diff] [blame] | 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 | |
Simon Glass | 02f0c28 | 2015-09-08 11:15:11 -0600 | [diff] [blame] | 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, |
Simon Glass | 3c3ba90 | 2016-01-03 13:50:31 -0700 | [diff] [blame] | 703 | .remove = usb_kbd_remove, |
Simon Glass | 02f0c28 | 2015-09-08 11:15:11 -0600 | [diff] [blame] | 704 | }; |
| 705 | |
Simon Glass | 02f0c28 | 2015-09-08 11:15:11 -0600 | [diff] [blame] | 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, |
Simon Glass | ab88fdb | 2015-11-08 23:48:04 -0700 | [diff] [blame] | 712 | .bInterfaceSubClass = USB_SUB_HID_BOOT, |
| 713 | .bInterfaceProtocol = USB_PROT_HID_KEYBOARD, |
Simon Glass | 02f0c28 | 2015-09-08 11:15:11 -0600 | [diff] [blame] | 714 | }, |
Janne Grunau | 4a7fda9 | 2024-04-04 08:25:53 +0200 | [diff] [blame] | 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 | }, |
Simon Glass | 02f0c28 | 2015-09-08 11:15:11 -0600 | [diff] [blame] | 727 | { } /* Terminating entry */ |
| 728 | }; |
| 729 | |
| 730 | U_BOOT_USB_DEVICE(usb_kbd, kbd_id_table); |