GNU Linux-libre 4.14.251-gnu1
[releases.git] / drivers / media / rc / ir-mce_kbd-decoder.c
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(unsigned long data)
119 {
120         struct mce_kbd_dec *mce_kbd = (struct mce_kbd_dec *)data;
121         int i;
122         unsigned char maskcode;
123
124         IR_dprintk(2, "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(mce_kbd->idev, maskcode, 0);
129         }
130
131         for (i = 0; i < MCIR2_MASK_KEYS_START; i++)
132                 input_report_key(mce_kbd->idev, kbd_keycodes[i], 0);
133
134         input_sync(mce_kbd->idev);
135 }
136
137 static enum mce_kbd_mode mce_kbd_mode(struct mce_kbd_dec *data)
138 {
139         switch (data->header & MCIR2_MODE_MASK) {
140         case MCIR2_KEYBOARD_HEADER:
141                 return MCIR2_MODE_KEYBOARD;
142         case MCIR2_MOUSE_HEADER:
143                 return MCIR2_MODE_MOUSE;
144         default:
145                 return MCIR2_MODE_UNKNOWN;
146         }
147 }
148
149 static void ir_mce_kbd_process_keyboard_data(struct input_dev *idev,
150                                              u32 scancode)
151 {
152         u8 keydata   = (scancode >> 8) & 0xff;
153         u8 shiftmask = scancode & 0xff;
154         unsigned char keycode, maskcode;
155         int i, keystate;
156
157         IR_dprintk(1, "keyboard: keydata = 0x%02x, shiftmask = 0x%02x\n",
158                    keydata, shiftmask);
159
160         for (i = 0; i < 7; i++) {
161                 maskcode = kbd_keycodes[MCIR2_MASK_KEYS_START + i];
162                 if (shiftmask & (1 << i))
163                         keystate = 1;
164                 else
165                         keystate = 0;
166                 input_report_key(idev, maskcode, keystate);
167         }
168
169         if (keydata) {
170                 keycode = kbd_keycodes[keydata];
171                 input_report_key(idev, keycode, 1);
172         } else {
173                 for (i = 0; i < MCIR2_MASK_KEYS_START; i++)
174                         input_report_key(idev, kbd_keycodes[i], 0);
175         }
176 }
177
178 static void ir_mce_kbd_process_mouse_data(struct input_dev *idev, u32 scancode)
179 {
180         /* raw mouse coordinates */
181         u8 xdata = (scancode >> 7) & 0x7f;
182         u8 ydata = (scancode >> 14) & 0x7f;
183         int x, y;
184         /* mouse buttons */
185         bool right = scancode & 0x40;
186         bool left  = scancode & 0x20;
187
188         if (xdata & 0x40)
189                 x = -((~xdata & 0x7f) + 1);
190         else
191                 x = xdata;
192
193         if (ydata & 0x40)
194                 y = -((~ydata & 0x7f) + 1);
195         else
196                 y = ydata;
197
198         IR_dprintk(1, "mouse: x = %d, y = %d, btns = %s%s\n",
199                    x, y, left ? "L" : "", right ? "R" : "");
200
201         input_report_rel(idev, REL_X, x);
202         input_report_rel(idev, REL_Y, y);
203
204         input_report_key(idev, BTN_LEFT, left);
205         input_report_key(idev, BTN_RIGHT, right);
206 }
207
208 /**
209  * ir_mce_kbd_decode() - Decode one mce_kbd pulse or space
210  * @dev:        the struct rc_dev descriptor of the device
211  * @ev:         the struct ir_raw_event descriptor of the pulse/space
212  *
213  * This function returns -EINVAL if the pulse violates the state machine
214  */
215 static int ir_mce_kbd_decode(struct rc_dev *dev, struct ir_raw_event ev)
216 {
217         struct mce_kbd_dec *data = &dev->raw->mce_kbd;
218         u32 scancode;
219         unsigned long delay;
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         IR_dprintk(2, "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                         IR_dprintk(1, "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                         IR_dprintk(1, "keyboard data 0x%08x\n", data->body);
324                         if (dev->timeout)
325                                 delay = usecs_to_jiffies(dev->timeout / 1000);
326                         else
327                                 delay = msecs_to_jiffies(100);
328                         mod_timer(&data->rx_timeout, jiffies + delay);
329                         /* Pass data to keyboard buffer parser */
330                         ir_mce_kbd_process_keyboard_data(data->idev, scancode);
331                         break;
332                 case MCIR2_MOUSE_NBITS:
333                         scancode = data->body & 0x1fffff;
334                         IR_dprintk(1, "mouse data 0x%06x\n", scancode);
335                         /* Pass data to mouse buffer parser */
336                         ir_mce_kbd_process_mouse_data(data->idev, scancode);
337                         break;
338                 default:
339                         IR_dprintk(1, "not keyboard or mouse data\n");
340                         goto out;
341                 }
342
343                 data->state = STATE_INACTIVE;
344                 input_event(data->idev, EV_MSC, MSC_SCAN, scancode);
345                 input_sync(data->idev);
346                 return 0;
347         }
348
349 out:
350         IR_dprintk(1, "failed at state %i (%uus %s)\n",
351                    data->state, TO_US(ev.duration), TO_STR(ev.pulse));
352         data->state = STATE_INACTIVE;
353         input_sync(data->idev);
354         return -EINVAL;
355 }
356
357 static int ir_mce_kbd_register(struct rc_dev *dev)
358 {
359         struct mce_kbd_dec *mce_kbd = &dev->raw->mce_kbd;
360         struct input_dev *idev;
361         int i, ret;
362
363         if (dev->driver_type == RC_DRIVER_IR_RAW_TX)
364                 return 0;
365
366         idev = input_allocate_device();
367         if (!idev)
368                 return -ENOMEM;
369
370         snprintf(mce_kbd->name, sizeof(mce_kbd->name),
371                  "MCE IR Keyboard/Mouse (%s)", dev->driver_name);
372         strlcat(mce_kbd->phys, "/input0", sizeof(mce_kbd->phys));
373
374         idev->name = mce_kbd->name;
375         idev->phys = mce_kbd->phys;
376
377         /* Keyboard bits */
378         set_bit(EV_KEY, idev->evbit);
379         set_bit(EV_REP, idev->evbit);
380         for (i = 0; i < sizeof(kbd_keycodes); i++)
381                 set_bit(kbd_keycodes[i], idev->keybit);
382
383         /* Mouse bits */
384         set_bit(EV_REL, idev->evbit);
385         set_bit(REL_X, idev->relbit);
386         set_bit(REL_Y, idev->relbit);
387         set_bit(BTN_LEFT, idev->keybit);
388         set_bit(BTN_RIGHT, idev->keybit);
389
390         /* Report scancodes too */
391         set_bit(EV_MSC, idev->evbit);
392         set_bit(MSC_SCAN, idev->mscbit);
393
394         setup_timer(&mce_kbd->rx_timeout, mce_kbd_rx_timeout,
395                     (unsigned long)mce_kbd);
396
397         input_set_drvdata(idev, mce_kbd);
398
399 #if 0
400         /* Adding this reference means two input devices are associated with
401          * this rc-core device, which ir-keytable doesn't cope with yet */
402         idev->dev.parent = &dev->dev;
403 #endif
404
405         ret = input_register_device(idev);
406         if (ret < 0) {
407                 input_free_device(idev);
408                 return -EIO;
409         }
410
411         mce_kbd->idev = idev;
412
413         return 0;
414 }
415
416 static int ir_mce_kbd_unregister(struct rc_dev *dev)
417 {
418         struct mce_kbd_dec *mce_kbd = &dev->raw->mce_kbd;
419         struct input_dev *idev = mce_kbd->idev;
420
421         if (dev->driver_type == RC_DRIVER_IR_RAW_TX)
422                 return 0;
423
424         del_timer_sync(&mce_kbd->rx_timeout);
425         input_unregister_device(idev);
426
427         return 0;
428 }
429
430 static const struct ir_raw_timings_manchester ir_mce_kbd_timings = {
431         .leader         = MCIR2_PREFIX_PULSE,
432         .invert         = 1,
433         .clock          = MCIR2_UNIT,
434         .trailer_space  = MCIR2_UNIT * 10,
435 };
436
437 /**
438  * ir_mce_kbd_encode() - Encode a scancode as a stream of raw events
439  *
440  * @protocol:   protocol to encode
441  * @scancode:   scancode to encode
442  * @events:     array of raw ir events to write into
443  * @max:        maximum size of @events
444  *
445  * Returns:     The number of events written.
446  *              -ENOBUFS if there isn't enough space in the array to fit the
447  *              encoding. In this case all @max events will have been written.
448  */
449 static int ir_mce_kbd_encode(enum rc_proto protocol, u32 scancode,
450                              struct ir_raw_event *events, unsigned int max)
451 {
452         struct ir_raw_event *e = events;
453         int len, ret;
454         u64 raw;
455
456         if (protocol == RC_PROTO_MCIR2_KBD) {
457                 raw = scancode |
458                       ((u64)MCIR2_KEYBOARD_HEADER << MCIR2_KEYBOARD_NBITS);
459                 len = MCIR2_KEYBOARD_NBITS + MCIR2_HEADER_NBITS + 1;
460         } else {
461                 raw = scancode |
462                       ((u64)MCIR2_MOUSE_HEADER << MCIR2_MOUSE_NBITS);
463                 len = MCIR2_MOUSE_NBITS + MCIR2_HEADER_NBITS + 1;
464         }
465
466         ret = ir_raw_gen_manchester(&e, max, &ir_mce_kbd_timings, len, raw);
467         if (ret < 0)
468                 return ret;
469
470         return e - events;
471 }
472
473 static struct ir_raw_handler mce_kbd_handler = {
474         .protocols      = RC_PROTO_BIT_MCIR2_KBD | RC_PROTO_BIT_MCIR2_MSE,
475         .decode         = ir_mce_kbd_decode,
476         .encode         = ir_mce_kbd_encode,
477         .raw_register   = ir_mce_kbd_register,
478         .raw_unregister = ir_mce_kbd_unregister,
479 };
480
481 static int __init ir_mce_kbd_decode_init(void)
482 {
483         ir_raw_handler_register(&mce_kbd_handler);
484
485         printk(KERN_INFO "IR MCE Keyboard/mouse protocol handler initialized\n");
486         return 0;
487 }
488
489 static void __exit ir_mce_kbd_decode_exit(void)
490 {
491         ir_raw_handler_unregister(&mce_kbd_handler);
492 }
493
494 module_init(ir_mce_kbd_decode_init);
495 module_exit(ir_mce_kbd_decode_exit);
496
497 MODULE_LICENSE("GPL");
498 MODULE_AUTHOR("Jarod Wilson <jarod@redhat.com>");
499 MODULE_DESCRIPTION("MCE Keyboard/mouse IR protocol decoder");