1 /*- 2 * Copyright (c) 2014 Jakub Wojciech Klama <jceel@FreeBSD.org> 3 * Copyright (c) 2015-2016 Vladimir Kondratyev <wulf@FreeBSD.org> 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28 #include <sys/param.h> 29 #include <sys/bus.h> 30 #include <sys/conf.h> 31 #include <sys/kbio.h> 32 #include <sys/kernel.h> 33 #include <sys/lock.h> 34 #include <sys/malloc.h> 35 #include <sys/mutex.h> 36 #include <sys/systm.h> 37 38 #include <dev/evdev/evdev.h> 39 #include <dev/evdev/evdev_private.h> 40 #include <dev/evdev/input.h> 41 42 #define NONE KEY_RESERVED 43 44 static uint16_t evdev_usb_scancodes[256] = { 45 /* 0x00 - 0x27 */ 46 NONE, NONE, NONE, NONE, KEY_A, KEY_B, KEY_C, KEY_D, 47 KEY_E, KEY_F, KEY_G, KEY_H, KEY_I, KEY_J, KEY_K, KEY_L, 48 KEY_M, KEY_N, KEY_O, KEY_P, KEY_Q, KEY_R, KEY_S, KEY_T, 49 KEY_U, KEY_V, KEY_W, KEY_X, KEY_Y, KEY_Z, KEY_1, KEY_2, 50 KEY_3, KEY_4, KEY_5, KEY_6, KEY_7, KEY_8, KEY_9, KEY_0, 51 /* 0x28 - 0x3f */ 52 KEY_ENTER, KEY_ESC, KEY_BACKSPACE, KEY_TAB, 53 KEY_SPACE, KEY_MINUS, KEY_EQUAL, KEY_LEFTBRACE, 54 KEY_RIGHTBRACE, KEY_BACKSLASH, KEY_BACKSLASH, KEY_SEMICOLON, 55 KEY_APOSTROPHE, KEY_GRAVE, KEY_COMMA, KEY_DOT, 56 KEY_SLASH, KEY_CAPSLOCK, KEY_F1, KEY_F2, 57 KEY_F3, KEY_F4, KEY_F5, KEY_F6, 58 /* 0x40 - 0x5f */ 59 KEY_F7, KEY_F8, KEY_F9, KEY_F10, 60 KEY_F11, KEY_F12, KEY_SYSRQ, KEY_SCROLLLOCK, 61 KEY_PAUSE, KEY_INSERT, KEY_HOME, KEY_PAGEUP, 62 KEY_DELETE, KEY_END, KEY_PAGEDOWN, KEY_RIGHT, 63 KEY_LEFT, KEY_DOWN, KEY_UP, KEY_NUMLOCK, 64 KEY_KPSLASH, KEY_KPASTERISK, KEY_KPMINUS, KEY_KPPLUS, 65 KEY_KPENTER, KEY_KP1, KEY_KP2, KEY_KP3, 66 KEY_KP4, KEY_KP5, KEY_KP6, KEY_KP7, 67 /* 0x60 - 0x7f */ 68 KEY_KP8, KEY_KP9, KEY_KP0, KEY_KPDOT, 69 KEY_102ND, KEY_COMPOSE, KEY_POWER, KEY_KPEQUAL, 70 KEY_F13, KEY_F14, KEY_F15, KEY_F16, 71 KEY_F17, KEY_F18, KEY_F19, KEY_F20, 72 KEY_F21, KEY_F22, KEY_F23, KEY_F24, 73 KEY_OPEN, KEY_HELP, KEY_PROPS, KEY_FRONT, 74 KEY_STOP, KEY_AGAIN, KEY_UNDO, KEY_CUT, 75 KEY_COPY, KEY_PASTE, KEY_FIND, KEY_MUTE, 76 /* 0x80 - 0x9f */ 77 KEY_VOLUMEUP, KEY_VOLUMEDOWN, NONE, NONE, 78 NONE, KEY_KPCOMMA, NONE, KEY_RO, 79 KEY_KATAKANAHIRAGANA, KEY_YEN,KEY_HENKAN, KEY_MUHENKAN, 80 KEY_KPJPCOMMA, NONE, NONE, NONE, 81 KEY_HANGEUL, KEY_HANJA, KEY_KATAKANA, KEY_HIRAGANA, 82 KEY_ZENKAKUHANKAKU, NONE, NONE, NONE, 83 NONE, NONE, NONE, NONE, 84 NONE, NONE, NONE, NONE, 85 /* 0xa0 - 0xbf */ 86 NONE, NONE, NONE, NONE, 87 NONE, NONE, NONE, NONE, 88 NONE, NONE, NONE, NONE, 89 NONE, NONE, NONE, NONE, 90 NONE, NONE, NONE, NONE, 91 NONE, NONE, NONE, NONE, 92 NONE, NONE, NONE, NONE, 93 NONE, NONE, NONE, NONE, 94 /* 0xc0 - 0xdf */ 95 KEY_BRIGHTNESSDOWN, KEY_BRIGHTNESSUP, KEY_SCALE, KEY_DASHBOARD, 96 KEY_KBDILLUMDOWN, KEY_KBDILLUMUP, NONE, NONE, 97 NONE, NONE, NONE, NONE, 98 NONE, NONE, NONE, NONE, 99 NONE, NONE, NONE, NONE, 100 NONE, NONE, NONE, NONE, 101 NONE, NONE, NONE, NONE, 102 NONE, NONE, NONE, NONE, 103 /* 0xe0 - 0xff */ 104 KEY_LEFTCTRL, KEY_LEFTSHIFT, KEY_LEFTALT, KEY_LEFTMETA, 105 KEY_RIGHTCTRL, KEY_RIGHTSHIFT, KEY_RIGHTALT, KEY_RIGHTMETA, 106 KEY_PLAYPAUSE, KEY_STOPCD, KEY_PREVIOUSSONG,KEY_NEXTSONG, 107 KEY_EJECTCD, KEY_VOLUMEUP, KEY_VOLUMEDOWN, KEY_MUTE, 108 KEY_WWW, KEY_BACK, KEY_FORWARD, KEY_STOP, 109 KEY_FIND, KEY_SCROLLUP, KEY_SCROLLDOWN, KEY_EDIT, 110 KEY_SLEEP, KEY_COFFEE, KEY_REFRESH, KEY_CALC, 111 /* 112 * last item maps to APPLE_FN_KEY in hkbd.c. using KEY_WAKEUP instead 113 * of KEY_FN as evdev translates the latter to too high of a code for 114 * xkb to parse. 115 */ 116 NONE, NONE, NONE, KEY_WAKEUP, 117 118 }; 119 120 static uint16_t evdev_at_set1_scancodes[] = { 121 /* 0x00 - 0x1f */ 122 NONE, KEY_ESC, KEY_1, KEY_2, 123 KEY_3, KEY_4, KEY_5, KEY_6, 124 KEY_7, KEY_8, KEY_9, KEY_0, 125 KEY_MINUS, KEY_EQUAL, KEY_BACKSPACE, KEY_TAB, 126 KEY_Q, KEY_W, KEY_E, KEY_R, 127 KEY_T, KEY_Y, KEY_U, KEY_I, 128 KEY_O, KEY_P, KEY_LEFTBRACE, KEY_RIGHTBRACE, 129 KEY_ENTER, KEY_LEFTCTRL, KEY_A, KEY_S, 130 /* 0x20 - 0x3f */ 131 KEY_D, KEY_F, KEY_G, KEY_H, 132 KEY_J, KEY_K, KEY_L, KEY_SEMICOLON, 133 KEY_APOSTROPHE, KEY_GRAVE, KEY_LEFTSHIFT, KEY_BACKSLASH, 134 KEY_Z, KEY_X, KEY_C, KEY_V, 135 KEY_B, KEY_N, KEY_M, KEY_COMMA, 136 KEY_DOT, KEY_SLASH, KEY_RIGHTSHIFT, KEY_KPASTERISK, 137 KEY_LEFTALT, KEY_SPACE, KEY_CAPSLOCK, KEY_F1, 138 KEY_F2, KEY_F3, KEY_F4, KEY_F5, 139 /* 0x40 - 0x5f */ 140 KEY_F6, KEY_F7, KEY_F8, KEY_F9, 141 KEY_F10, KEY_NUMLOCK, KEY_SCROLLLOCK, KEY_KP7, 142 KEY_KP8, KEY_KP9, KEY_KPMINUS, KEY_KP4, 143 KEY_KP5, KEY_KP6, KEY_KPPLUS, KEY_KP1, 144 KEY_KP2, KEY_KP3, KEY_KP0, KEY_KPDOT, 145 NONE, NONE, KEY_102ND, KEY_F11, 146 KEY_F12, NONE, NONE, NONE, 147 NONE, KEY_F13, NONE, NONE, 148 /* 0x60 - 0x7f */ 149 NONE, NONE, NONE, NONE, 150 NONE, NONE, NONE, NONE, 151 NONE, NONE, NONE, NONE, 152 NONE, NONE, NONE, NONE, 153 KEY_KATAKANAHIRAGANA, KEY_HANJA, KEY_HANGEUL, KEY_RO, 154 NONE, NONE, KEY_ZENKAKUHANKAKU, KEY_HIRAGANA, 155 KEY_KATAKANA, KEY_HENKAN, NONE, KEY_MUHENKAN, 156 NONE, KEY_YEN, KEY_KPCOMMA, NONE, 157 /* 0x00 - 0x1f. 0xE0 prefixed */ 158 NONE, NONE, NONE, NONE, 159 NONE, NONE, NONE, NONE, 160 NONE, NONE, NONE, NONE, 161 NONE, NONE, NONE, NONE, 162 /* 163 * 0xE0 0x11 - 0xE0 0x1E: ChromeOS EC "Vivaldi" top-row action keys 164 * (see chrome-ec include/keyboard_8042_sharedlib.h). 165 */ 166 KEY_PREVIOUSSONG, KEY_ZOOM, KEY_SCALE, KEY_SYSRQ, 167 KEY_BRIGHTNESSDOWN, KEY_BRIGHTNESSUP, /* 0x14 - 0x15 */ 168 KEY_PRIVACY_SCREEN_TOGGLE, KEY_KBDILLUMDOWN, /* 0x16 - 0x17 */ 169 KEY_KBDILLUMUP, KEY_NEXTSONG, KEY_PLAYPAUSE, KEY_MICMUTE, 170 KEY_KPENTER, KEY_RIGHTCTRL, KEY_KBDILLUMTOGGLE, NONE, 171 /* 0x20 - 0x3f. 0xE0 prefixed */ 172 KEY_MUTE, KEY_CALC, KEY_PLAYPAUSE, NONE, 173 KEY_STOPCD, NONE, NONE, NONE, 174 NONE, NONE, NONE, NONE, 175 NONE, NONE, KEY_VOLUMEDOWN, NONE, 176 KEY_VOLUMEUP, NONE, KEY_HOMEPAGE, NONE, 177 NONE, KEY_KPSLASH, NONE, KEY_SYSRQ, 178 KEY_RIGHTALT, NONE, NONE, KEY_F13, 179 KEY_F14, KEY_F15, KEY_F16, KEY_F17, 180 /* 0x40 - 0x5f. 0xE0 prefixed */ 181 KEY_F18, KEY_F19, KEY_F20, KEY_F21, 182 KEY_F22, NONE, KEY_PAUSE, KEY_HOME, 183 KEY_UP, KEY_PAGEUP, NONE, KEY_LEFT, 184 NONE, KEY_RIGHT, NONE, KEY_END, 185 KEY_DOWN, KEY_PAGEDOWN, KEY_INSERT, KEY_DELETE, 186 NONE, NONE, NONE, KEY_F23, 187 KEY_F24, NONE, NONE, KEY_LEFTMETA, 188 KEY_RIGHTMETA, KEY_MENU, KEY_POWER, KEY_SLEEP, 189 /* 0x60 - 0x7f. 0xE0 prefixed */ 190 NONE, NONE, NONE, KEY_WAKEUP, 191 NONE, KEY_SEARCH, KEY_BOOKMARKS, KEY_REFRESH, 192 KEY_STOP, KEY_FORWARD, KEY_BACK, KEY_COMPUTER, 193 KEY_MAIL, KEY_MEDIA, NONE, NONE, 194 NONE, NONE, NONE, NONE, 195 NONE, NONE, NONE, NONE, 196 NONE, NONE, NONE, NONE, 197 NONE, NONE, NONE, NONE, 198 }; 199 200 static uint16_t evdev_mouse_button_codes[] = { 201 BTN_LEFT, 202 BTN_MIDDLE, 203 BTN_RIGHT, 204 BTN_SIDE, 205 BTN_EXTRA, 206 BTN_FORWARD, 207 BTN_BACK, 208 BTN_TASK, 209 }; 210 211 static uint16_t evdev_led_codes[] = { 212 LED_CAPSL, /* CLKED */ 213 LED_NUML, /* NLKED */ 214 LED_SCROLLL, /* SLKED */ 215 }; 216 217 static uint16_t evdev_nfinger_codes[] = { 218 BTN_TOOL_FINGER, 219 BTN_TOOL_DOUBLETAP, 220 BTN_TOOL_TRIPLETAP, 221 BTN_TOOL_QUADTAP, 222 BTN_TOOL_QUINTTAP, 223 }; 224 225 uint16_t 226 evdev_hid2key(int scancode) 227 { 228 return evdev_usb_scancodes[scancode]; 229 } 230 231 void 232 evdev_support_all_known_keys(struct evdev_dev *evdev) 233 { 234 size_t i; 235 236 for (i = KEY_RESERVED; i < nitems(evdev_at_set1_scancodes); i++) 237 if (evdev_at_set1_scancodes[i] != NONE) 238 evdev_support_key(evdev, evdev_at_set1_scancodes[i]); 239 } 240 241 uint16_t 242 evdev_scancode2key(int *state, int scancode) 243 { 244 uint16_t keycode; 245 246 /* translate the scan code into a keycode */ 247 keycode = evdev_at_set1_scancodes[scancode & 0x7f]; 248 switch (*state) { 249 case 0x00: /* normal scancode */ 250 switch(scancode) { 251 case 0xE0: 252 case 0xE1: 253 *state = scancode; 254 return (NONE); 255 } 256 break; 257 case 0xE0: /* 0xE0 prefix */ 258 *state = 0; 259 keycode = evdev_at_set1_scancodes[0x80 + (scancode & 0x7f)]; 260 break; 261 case 0xE1: /* 0xE1 prefix */ 262 /* 263 * The pause/break key on the 101 keyboard produces: 264 * E1-1D-45 E1-9D-C5 265 * Ctrl-pause/break produces: 266 * E0-46 E0-C6 (See above.) 267 */ 268 *state = 0; 269 if ((scancode & 0x7f) == 0x1D) 270 *state = scancode; 271 return (NONE); 272 /* NOT REACHED */ 273 case 0x1D: /* pause / break */ 274 case 0x9D: 275 if ((*state ^ scancode) & 0x80) 276 return (NONE); 277 *state = 0; 278 if ((scancode & 0x7f) != 0x45) 279 return (NONE); 280 keycode = KEY_PAUSE; 281 break; 282 } 283 284 return (keycode); 285 } 286 287 void 288 evdev_push_mouse_btn(struct evdev_dev *evdev, int buttons) 289 { 290 size_t i; 291 292 for (i = 0; i < nitems(evdev_mouse_button_codes); i++) 293 evdev_push_key(evdev, evdev_mouse_button_codes[i], 294 buttons & (1 << i)); 295 } 296 297 void 298 evdev_push_leds(struct evdev_dev *evdev, int leds) 299 { 300 size_t i; 301 302 /* Some drivers initialize leds before evdev */ 303 if (evdev == NULL) 304 return; 305 306 for (i = 0; i < nitems(evdev_led_codes); i++) 307 evdev_push_led(evdev, evdev_led_codes[i], leds & (1 << i)); 308 } 309 310 void 311 evdev_push_repeats(struct evdev_dev *evdev, keyboard_t *kbd) 312 { 313 /* Some drivers initialize typematics before evdev */ 314 if (evdev == NULL) 315 return; 316 317 evdev_push_event(evdev, EV_REP, REP_DELAY, kbd->kb_delay1); 318 evdev_push_event(evdev, EV_REP, REP_PERIOD, kbd->kb_delay2); 319 } 320 321 void 322 evdev_support_nfingers(struct evdev_dev *evdev, int nfingers) 323 { 324 int i; 325 326 for (i = 0; i < MIN(nitems(evdev_nfinger_codes), nfingers); i++) 327 evdev_support_key(evdev, evdev_nfinger_codes[i]); 328 } 329 330 void 331 evdev_send_nfingers(struct evdev_dev *evdev, int nfingers) 332 { 333 int i; 334 335 EVDEV_LOCK_ASSERT(evdev); 336 337 if (nfingers > nitems(evdev_nfinger_codes)) 338 nfingers = nitems(evdev_nfinger_codes); 339 340 for (i = 0; i < nitems(evdev_nfinger_codes); i++) 341 evdev_send_event(evdev, EV_KEY, evdev_nfinger_codes[i], 342 nfingers == i + 1); 343 } 344 345 void 346 evdev_push_nfingers(struct evdev_dev *evdev, int nfingers) 347 { 348 EVDEV_ENTER(evdev); 349 evdev_send_nfingers(evdev, nfingers); 350 EVDEV_EXIT(evdev); 351 } 352