1 /* ir-mce_kbd-decoder.c - A decoder for the RC6-ish keyboard/mouse IR protocol 2 * used by the Microsoft Remote Keyboard for Windows Media Center Edition, 3 * referred to by Microsoft's Windows Media Center remote specification docs 4 * as "an internal protocol called MCIR-2". 5 * 6 * Copyright (C) 2011 by Jarod Wilson <jarod@redhat.com> 7 * 8 * This program is free software; you can redistribute it and/or modify 9 * it under the terms of the GNU General Public License as published by 10 * the Free Software Foundation version 2 of the License. 11 * 12 * This program is distributed in the hope that it will be useful, 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * GNU General Public License for more details. 16 */ 17 #include <linux/module.h> 18 19 #include "rc-core-priv.h" 20 21 /* 22 * This decoder currently supports: 23 * - MCIR-2 29-bit IR signals used for mouse movement and buttons 24 * - MCIR-2 32-bit IR signals used for standard keyboard keys 25 * 26 * The media keys on the keyboard send RC-6 signals that are indistinguishable 27 * from the keys of the same name on the stock MCE remote, and will be handled 28 * by the standard RC-6 decoder, and be made available to the system via the 29 * input device for the remote, rather than the keyboard/mouse one. 30 */ 31 32 #define MCIR2_UNIT 333333 /* ns */ 33 #define MCIR2_HEADER_NBITS 5 34 #define MCIR2_MOUSE_NBITS 29 35 #define MCIR2_KEYBOARD_NBITS 32 36 #define MCIR2_PREFIX_PULSE (8 * MCIR2_UNIT) 37 #define MCIR2_PREFIX_SPACE (1 * MCIR2_UNIT) 38 #define MCIR2_MAX_LEN (3 * MCIR2_UNIT) 39 #define MCIR2_BIT_START (1 * MCIR2_UNIT) 40 #define MCIR2_BIT_END (1 * MCIR2_UNIT) 41 #define MCIR2_BIT_0 (1 * MCIR2_UNIT) 42 #define MCIR2_BIT_SET (2 * MCIR2_UNIT) 43 #define MCIR2_MODE_MASK 0xf /* for the header bits */ 44 #define MCIR2_KEYBOARD_HEADER 0x4 45 #define MCIR2_MOUSE_HEADER 0x1 46 #define MCIR2_MASK_KEYS_START 0xe0 47 48 enum mce_kbd_mode { 49 MCIR2_MODE_KEYBOARD, 50 MCIR2_MODE_MOUSE, 51 MCIR2_MODE_UNKNOWN, 52 }; 53 54 enum mce_kbd_state { 55 STATE_INACTIVE, 56 STATE_HEADER_BIT_START, 57 STATE_HEADER_BIT_END, 58 STATE_BODY_BIT_START, 59 STATE_BODY_BIT_END, 60 STATE_FINISHED, 61 }; 62 63 static unsigned char kbd_keycodes[256] = { 64 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_A, 65 KEY_B, KEY_C, KEY_D, KEY_E, KEY_F, 66 KEY_G, KEY_H, KEY_I, KEY_J, KEY_K, 67 KEY_L, KEY_M, KEY_N, KEY_O, KEY_P, 68 KEY_Q, KEY_R, KEY_S, KEY_T, KEY_U, 69 KEY_V, KEY_W, KEY_X, KEY_Y, KEY_Z, 70 KEY_1, KEY_2, KEY_3, KEY_4, KEY_5, 71 KEY_6, KEY_7, KEY_8, KEY_9, KEY_0, 72 KEY_ENTER, KEY_ESC, KEY_BACKSPACE, KEY_TAB, KEY_SPACE, 73 KEY_MINUS, KEY_EQUAL, KEY_LEFTBRACE, KEY_RIGHTBRACE, KEY_BACKSLASH, 74 KEY_BACKSLASH, KEY_SEMICOLON, KEY_APOSTROPHE, KEY_GRAVE, KEY_COMMA, 75 KEY_DOT, KEY_SLASH, KEY_CAPSLOCK, KEY_F1, KEY_F2, 76 KEY_F3, KEY_F4, KEY_F5, KEY_F6, KEY_F7, 77 KEY_F8, KEY_F9, KEY_F10, KEY_F11, KEY_F12, 78 KEY_SYSRQ, KEY_SCROLLLOCK, KEY_PAUSE, KEY_INSERT, KEY_HOME, 79 KEY_PAGEUP, KEY_DELETE, KEY_END, KEY_PAGEDOWN, KEY_RIGHT, 80 KEY_LEFT, KEY_DOWN, KEY_UP, KEY_NUMLOCK, KEY_KPSLASH, 81 KEY_KPASTERISK, KEY_KPMINUS, KEY_KPPLUS, KEY_KPENTER, KEY_KP1, 82 KEY_KP2, KEY_KP3, KEY_KP4, KEY_KP5, KEY_KP6, 83 KEY_KP7, KEY_KP8, KEY_KP9, KEY_KP0, KEY_KPDOT, 84 KEY_102ND, KEY_COMPOSE, KEY_POWER, KEY_KPEQUAL, KEY_F13, 85 KEY_F14, KEY_F15, KEY_F16, KEY_F17, KEY_F18, 86 KEY_F19, KEY_F20, KEY_F21, KEY_F22, KEY_F23, 87 KEY_F24, KEY_OPEN, KEY_HELP, KEY_PROPS, KEY_FRONT, 88 KEY_STOP, KEY_AGAIN, KEY_UNDO, KEY_CUT, KEY_COPY, 89 KEY_PASTE, KEY_FIND, KEY_MUTE, KEY_VOLUMEUP, KEY_VOLUMEDOWN, 90 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_KPCOMMA, KEY_RESERVED, 91 KEY_RO, KEY_KATAKANAHIRAGANA, KEY_YEN, KEY_HENKAN, KEY_MUHENKAN, 92 KEY_KPJPCOMMA, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_HANGUEL, 93 KEY_HANJA, KEY_KATAKANA, KEY_HIRAGANA, KEY_ZENKAKUHANKAKU, KEY_RESERVED, 94 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 95 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 96 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 97 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 98 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 99 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 100 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 101 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 102 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 103 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 104 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 105 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 106 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 107 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 108 KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, KEY_LEFTCTRL, 109 KEY_LEFTSHIFT, KEY_LEFTALT, KEY_LEFTMETA, KEY_RIGHTCTRL, KEY_RIGHTSHIFT, 110 KEY_RIGHTALT, KEY_RIGHTMETA, KEY_PLAYPAUSE, KEY_STOPCD, KEY_PREVIOUSSONG, 111 KEY_NEXTSONG, KEY_EJECTCD, KEY_VOLUMEUP, KEY_VOLUMEDOWN, KEY_MUTE, 112 KEY_WWW, KEY_BACK, KEY_FORWARD, KEY_STOP, KEY_FIND, 113 KEY_SCROLLUP, KEY_SCROLLDOWN, KEY_EDIT, KEY_SLEEP, KEY_COFFEE, 114 KEY_REFRESH, KEY_CALC, KEY_RESERVED, KEY_RESERVED, KEY_RESERVED, 115 KEY_RESERVED 116 }; 117 118 static void mce_kbd_rx_timeout(struct timer_list *t) 119 { 120 struct ir_raw_event_ctrl *raw = from_timer(raw, t, mce_kbd.rx_timeout); 121 unsigned char maskcode; 122 int i; 123 124 dev_dbg(&raw->dev->dev, "timer callback clearing all keys\n"); 125 126 for (i = 0; i < 7; i++) { 127 maskcode = kbd_keycodes[MCIR2_MASK_KEYS_START + i]; 128 input_report_key(raw->mce_kbd.idev, maskcode, 0); 129 } 130 131 for (i = 0; i < MCIR2_MASK_KEYS_START; i++) 132 input_report_key(raw->mce_kbd.idev, kbd_keycodes[i], 0); 133 } 134 135 static enum mce_kbd_mode mce_kbd_mode(struct mce_kbd_dec *data) 136 { 137 switch (data->header & MCIR2_MODE_MASK) { 138 case MCIR2_KEYBOARD_HEADER: 139 return MCIR2_MODE_KEYBOARD; 140 case MCIR2_MOUSE_HEADER: 141 return MCIR2_MODE_MOUSE; 142 default: 143 return MCIR2_MODE_UNKNOWN; 144 } 145 } 146 147 static void ir_mce_kbd_process_keyboard_data(struct rc_dev *dev, u32 scancode) 148 { 149 struct mce_kbd_dec *data = &dev->raw->mce_kbd; 150 u8 keydata = (scancode >> 8) & 0xff; 151 u8 shiftmask = scancode & 0xff; 152 unsigned char keycode, maskcode; 153 int i, keystate; 154 155 dev_dbg(&dev->dev, "keyboard: keydata = 0x%02x, shiftmask = 0x%02x\n", 156 keydata, shiftmask); 157 158 for (i = 0; i < 7; i++) { 159 maskcode = kbd_keycodes[MCIR2_MASK_KEYS_START + i]; 160 if (shiftmask & (1 << i)) 161 keystate = 1; 162 else 163 keystate = 0; 164 input_report_key(data->idev, maskcode, keystate); 165 } 166 167 if (keydata) { 168 keycode = kbd_keycodes[keydata]; 169 input_report_key(data->idev, keycode, 1); 170 } else { 171 for (i = 0; i < MCIR2_MASK_KEYS_START; i++) 172 input_report_key(data->idev, kbd_keycodes[i], 0); 173 } 174 } 175 176 static void ir_mce_kbd_process_mouse_data(struct rc_dev *dev, u32 scancode) 177 { 178 struct mce_kbd_dec *data = &dev->raw->mce_kbd; 179 /* raw mouse coordinates */ 180 u8 xdata = (scancode >> 7) & 0x7f; 181 u8 ydata = (scancode >> 14) & 0x7f; 182 int x, y; 183 /* mouse buttons */ 184 bool right = scancode & 0x40; 185 bool left = scancode & 0x20; 186 187 if (xdata & 0x40) 188 x = -((~xdata & 0x7f) + 1); 189 else 190 x = xdata; 191 192 if (ydata & 0x40) 193 y = -((~ydata & 0x7f) + 1); 194 else 195 y = ydata; 196 197 dev_dbg(&dev->dev, "mouse: x = %d, y = %d, btns = %s%s\n", 198 x, y, left ? "L" : "", right ? "R" : ""); 199 200 input_report_rel(data->idev, REL_X, x); 201 input_report_rel(data->idev, REL_Y, y); 202 203 input_report_key(data->idev, BTN_LEFT, left); 204 input_report_key(data->idev, BTN_RIGHT, right); 205 } 206 207 /** 208 * ir_mce_kbd_decode() - Decode one mce_kbd pulse or space 209 * @dev: the struct rc_dev descriptor of the device 210 * @ev: the struct ir_raw_event descriptor of the pulse/space 211 * 212 * This function returns -EINVAL if the pulse violates the state machine 213 */ 214 static int ir_mce_kbd_decode(struct rc_dev *dev, struct ir_raw_event ev) 215 { 216 struct mce_kbd_dec *data = &dev->raw->mce_kbd; 217 u32 scancode; 218 unsigned long delay; 219 struct lirc_scancode lsc = {}; 220 221 if (!is_timing_event(ev)) { 222 if (ev.reset) 223 data->state = STATE_INACTIVE; 224 return 0; 225 } 226 227 if (!geq_margin(ev.duration, MCIR2_UNIT, MCIR2_UNIT / 2)) 228 goto out; 229 230 again: 231 dev_dbg(&dev->dev, "started at state %i (%uus %s)\n", 232 data->state, TO_US(ev.duration), TO_STR(ev.pulse)); 233 234 if (!geq_margin(ev.duration, MCIR2_UNIT, MCIR2_UNIT / 2)) 235 return 0; 236 237 switch (data->state) { 238 239 case STATE_INACTIVE: 240 if (!ev.pulse) 241 break; 242 243 /* Note: larger margin on first pulse since each MCIR2_UNIT 244 is quite short and some hardware takes some time to 245 adjust to the signal */ 246 if (!eq_margin(ev.duration, MCIR2_PREFIX_PULSE, MCIR2_UNIT)) 247 break; 248 249 data->state = STATE_HEADER_BIT_START; 250 data->count = 0; 251 data->header = 0; 252 return 0; 253 254 case STATE_HEADER_BIT_START: 255 if (geq_margin(ev.duration, MCIR2_MAX_LEN, MCIR2_UNIT / 2)) 256 break; 257 258 data->header <<= 1; 259 if (ev.pulse) 260 data->header |= 1; 261 data->count++; 262 data->state = STATE_HEADER_BIT_END; 263 return 0; 264 265 case STATE_HEADER_BIT_END: 266 if (!is_transition(&ev, &dev->raw->prev_ev)) 267 break; 268 269 decrease_duration(&ev, MCIR2_BIT_END); 270 271 if (data->count != MCIR2_HEADER_NBITS) { 272 data->state = STATE_HEADER_BIT_START; 273 goto again; 274 } 275 276 switch (mce_kbd_mode(data)) { 277 case MCIR2_MODE_KEYBOARD: 278 data->wanted_bits = MCIR2_KEYBOARD_NBITS; 279 break; 280 case MCIR2_MODE_MOUSE: 281 data->wanted_bits = MCIR2_MOUSE_NBITS; 282 break; 283 default: 284 dev_dbg(&dev->dev, "not keyboard or mouse data\n"); 285 goto out; 286 } 287 288 data->count = 0; 289 data->body = 0; 290 data->state = STATE_BODY_BIT_START; 291 goto again; 292 293 case STATE_BODY_BIT_START: 294 if (geq_margin(ev.duration, MCIR2_MAX_LEN, MCIR2_UNIT / 2)) 295 break; 296 297 data->body <<= 1; 298 if (ev.pulse) 299 data->body |= 1; 300 data->count++; 301 data->state = STATE_BODY_BIT_END; 302 return 0; 303 304 case STATE_BODY_BIT_END: 305 if (!is_transition(&ev, &dev->raw->prev_ev)) 306 break; 307 308 if (data->count == data->wanted_bits) 309 data->state = STATE_FINISHED; 310 else 311 data->state = STATE_BODY_BIT_START; 312 313 decrease_duration(&ev, MCIR2_BIT_END); 314 goto again; 315 316 case STATE_FINISHED: 317 if (ev.pulse) 318 break; 319 320 switch (data->wanted_bits) { 321 case MCIR2_KEYBOARD_NBITS: 322 scancode = data->body & 0xffff; 323 dev_dbg(&dev->dev, "keyboard data 0x%08x\n", 324 data->body); 325 if (dev->timeout) 326 delay = usecs_to_jiffies(dev->timeout / 1000); 327 else 328 delay = msecs_to_jiffies(100); 329 mod_timer(&data->rx_timeout, jiffies + delay); 330 /* Pass data to keyboard buffer parser */ 331 ir_mce_kbd_process_keyboard_data(dev, scancode); 332 lsc.rc_proto = RC_PROTO_MCIR2_KBD; 333 break; 334 case MCIR2_MOUSE_NBITS: 335 scancode = data->body & 0x1fffff; 336 dev_dbg(&dev->dev, "mouse data 0x%06x\n", scancode); 337 /* Pass data to mouse buffer parser */ 338 ir_mce_kbd_process_mouse_data(dev, scancode); 339 lsc.rc_proto = RC_PROTO_MCIR2_MSE; 340 break; 341 default: 342 dev_dbg(&dev->dev, "not keyboard or mouse data\n"); 343 goto out; 344 } 345 346 lsc.scancode = scancode; 347 ir_lirc_scancode_event(dev, &lsc); 348 data->state = STATE_INACTIVE; 349 input_event(data->idev, EV_MSC, MSC_SCAN, scancode); 350 input_sync(data->idev); 351 return 0; 352 } 353 354 out: 355 dev_dbg(&dev->dev, "failed at state %i (%uus %s)\n", 356 data->state, TO_US(ev.duration), TO_STR(ev.pulse)); 357 data->state = STATE_INACTIVE; 358 input_sync(data->idev); 359 return -EINVAL; 360 } 361 362 static int ir_mce_kbd_register(struct rc_dev *dev) 363 { 364 struct mce_kbd_dec *mce_kbd = &dev->raw->mce_kbd; 365 struct input_dev *idev; 366 int i, ret; 367 368 idev = input_allocate_device(); 369 if (!idev) 370 return -ENOMEM; 371 372 snprintf(mce_kbd->name, sizeof(mce_kbd->name), 373 "MCE IR Keyboard/Mouse (%s)", dev->driver_name); 374 strlcat(mce_kbd->phys, "/input0", sizeof(mce_kbd->phys)); 375 376 idev->name = mce_kbd->name; 377 idev->phys = mce_kbd->phys; 378 379 /* Keyboard bits */ 380 set_bit(EV_KEY, idev->evbit); 381 set_bit(EV_REP, idev->evbit); 382 for (i = 0; i < sizeof(kbd_keycodes); i++) 383 set_bit(kbd_keycodes[i], idev->keybit); 384 385 /* Mouse bits */ 386 set_bit(EV_REL, idev->evbit); 387 set_bit(REL_X, idev->relbit); 388 set_bit(REL_Y, idev->relbit); 389 set_bit(BTN_LEFT, idev->keybit); 390 set_bit(BTN_RIGHT, idev->keybit); 391 392 /* Report scancodes too */ 393 set_bit(EV_MSC, idev->evbit); 394 set_bit(MSC_SCAN, idev->mscbit); 395 396 timer_setup(&mce_kbd->rx_timeout, mce_kbd_rx_timeout, 0); 397 398 input_set_drvdata(idev, mce_kbd); 399 400 #if 0 401 /* Adding this reference means two input devices are associated with 402 * this rc-core device, which ir-keytable doesn't cope with yet */ 403 idev->dev.parent = &dev->dev; 404 #endif 405 406 ret = input_register_device(idev); 407 if (ret < 0) { 408 input_free_device(idev); 409 return -EIO; 410 } 411 412 mce_kbd->idev = idev; 413 414 return 0; 415 } 416 417 static int ir_mce_kbd_unregister(struct rc_dev *dev) 418 { 419 struct mce_kbd_dec *mce_kbd = &dev->raw->mce_kbd; 420 struct input_dev *idev = mce_kbd->idev; 421 422 del_timer_sync(&mce_kbd->rx_timeout); 423 input_unregister_device(idev); 424 425 return 0; 426 } 427 428 static const struct ir_raw_timings_manchester ir_mce_kbd_timings = { 429 .leader_pulse = MCIR2_PREFIX_PULSE, 430 .invert = 1, 431 .clock = MCIR2_UNIT, 432 .trailer_space = MCIR2_UNIT * 10, 433 }; 434 435 /** 436 * ir_mce_kbd_encode() - Encode a scancode as a stream of raw events 437 * 438 * @protocol: protocol to encode 439 * @scancode: scancode to encode 440 * @events: array of raw ir events to write into 441 * @max: maximum size of @events 442 * 443 * Returns: The number of events written. 444 * -ENOBUFS if there isn't enough space in the array to fit the 445 * encoding. In this case all @max events will have been written. 446 */ 447 static int ir_mce_kbd_encode(enum rc_proto protocol, u32 scancode, 448 struct ir_raw_event *events, unsigned int max) 449 { 450 struct ir_raw_event *e = events; 451 int len, ret; 452 u64 raw; 453 454 if (protocol == RC_PROTO_MCIR2_KBD) { 455 raw = scancode | 456 ((u64)MCIR2_KEYBOARD_HEADER << MCIR2_KEYBOARD_NBITS); 457 len = MCIR2_KEYBOARD_NBITS + MCIR2_HEADER_NBITS; 458 } else { 459 raw = scancode | 460 ((u64)MCIR2_MOUSE_HEADER << MCIR2_MOUSE_NBITS); 461 len = MCIR2_MOUSE_NBITS + MCIR2_HEADER_NBITS; 462 } 463 464 ret = ir_raw_gen_manchester(&e, max, &ir_mce_kbd_timings, len, raw); 465 if (ret < 0) 466 return ret; 467 468 return e - events; 469 } 470 471 static struct ir_raw_handler mce_kbd_handler = { 472 .protocols = RC_PROTO_BIT_MCIR2_KBD | RC_PROTO_BIT_MCIR2_MSE, 473 .decode = ir_mce_kbd_decode, 474 .encode = ir_mce_kbd_encode, 475 .raw_register = ir_mce_kbd_register, 476 .raw_unregister = ir_mce_kbd_unregister, 477 .carrier = 36000, 478 }; 479 480 static int __init ir_mce_kbd_decode_init(void) 481 { 482 ir_raw_handler_register(&mce_kbd_handler); 483 484 printk(KERN_INFO "IR MCE Keyboard/mouse protocol handler initialized\n"); 485 return 0; 486 } 487 488 static void __exit ir_mce_kbd_decode_exit(void) 489 { 490 ir_raw_handler_unregister(&mce_kbd_handler); 491 } 492 493 module_init(ir_mce_kbd_decode_init); 494 module_exit(ir_mce_kbd_decode_exit); 495 496 MODULE_LICENSE("GPL"); 497 MODULE_AUTHOR("Jarod Wilson <jarod@redhat.com>"); 498 MODULE_DESCRIPTION("MCE Keyboard/mouse IR protocol decoder"); 499