2 handle em28xx IR remotes via linux kernel input layer.
4 Copyright (C) 2005 Ludovico Cavedon <cavedon@sssup.it>
5 Markus Rechberger <mrechberger@gmail.com>
6 Mauro Carvalho Chehab <mchehab@infradead.org>
7 Sascha Sommer <saschasommer@freenet.de>
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/module.h>
25 #include <linux/init.h>
26 #include <linux/delay.h>
27 #include <linux/interrupt.h>
28 #include <linux/input.h>
29 #include <linux/usb.h>
30 #include <linux/slab.h>
34 #define EM28XX_SNAPSHOT_KEY KEY_CAMERA
35 #define EM28XX_SBUTTON_QUERY_INTERVAL 500
36 #define EM28XX_R0C_USBSUSP_SNAPSHOT 0x20
38 static unsigned int ir_debug;
39 module_param(ir_debug, int, 0644);
40 MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
42 #define MODULE_NAME "em28xx"
44 #define i2cdprintk(fmt, arg...) \
46 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
49 #define dprintk(fmt, arg...) \
51 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
54 /**********************************************************
55 Polling structure used by em28xx IR's
56 **********************************************************/
58 struct em28xx_ir_poll_result {
59 unsigned int toggle_bit:1;
60 unsigned int read_count:7;
62 u8 rc_data[4]; /* 1 byte on em2860/2880, 4 on em2874 */
67 struct input_dev *input;
68 struct ir_input_state ir;
72 /* poll external decoder */
74 struct delayed_work work;
75 unsigned int last_toggle:1;
76 unsigned int full_code:1;
77 unsigned int last_readcount;
78 unsigned int repeat_interval;
80 int (*get_key)(struct em28xx_IR *, struct em28xx_ir_poll_result *);
82 /* IR device properties */
84 struct ir_dev_props props;
87 /**********************************************************
88 I2C IR based get keycodes - should be used with ir-kbd-i2c
89 **********************************************************/
91 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
96 if (1 != i2c_master_recv(ir->c, &b, 1)) {
97 i2cdprintk("read error\n");
101 /* it seems that 0xFE indicates that a button is still hold
102 down, while 0xff indicates that no button is hold
103 down. 0xfe sequences are sometimes interrupted by 0xFF */
105 i2cdprintk("key %02x\n", b);
119 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
121 unsigned char buf[2];
126 size = i2c_master_recv(ir->c, buf, sizeof(buf));
131 /* Does eliminate repeated parity code */
138 * Rearranges bits to the right order.
139 * The bit order were determined experimentally by using
140 * The original Hauppauge Grey IR and another RC5 that uses addr=0x08
141 * The RC5 code has 14 bits, but we've experimentally determined
142 * the meaning for only 11 bits.
143 * So, the code translation is not complete. Yet, it is enough to
144 * work with the provided RC5 IR.
147 ((buf[0] & 0x01) ? 0x0020 : 0) | /* 0010 0000 */
148 ((buf[0] & 0x02) ? 0x0010 : 0) | /* 0001 0000 */
149 ((buf[0] & 0x04) ? 0x0008 : 0) | /* 0000 1000 */
150 ((buf[0] & 0x08) ? 0x0004 : 0) | /* 0000 0100 */
151 ((buf[0] & 0x10) ? 0x0002 : 0) | /* 0000 0010 */
152 ((buf[0] & 0x20) ? 0x0001 : 0) | /* 0000 0001 */
153 ((buf[1] & 0x08) ? 0x1000 : 0) | /* 0001 0000 */
154 ((buf[1] & 0x10) ? 0x0800 : 0) | /* 0000 1000 */
155 ((buf[1] & 0x20) ? 0x0400 : 0) | /* 0000 0100 */
156 ((buf[1] & 0x40) ? 0x0200 : 0) | /* 0000 0010 */
157 ((buf[1] & 0x80) ? 0x0100 : 0); /* 0000 0001 */
159 i2cdprintk("ir hauppauge (em2840): code=0x%02x (rcv=0x%02x%02x)\n",
160 code, buf[1], buf[0]);
168 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
171 unsigned char buf[3];
175 if (3 != i2c_master_recv(ir->c, buf, 3)) {
176 i2cdprintk("read error\n");
180 i2cdprintk("key %02x\n", buf[2]&0x3f);
184 *ir_key = buf[2]&0x3f;
185 *ir_raw = buf[2]&0x3f;
190 int em28xx_get_key_winfast_usbii_deluxe(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
192 unsigned char subaddr, keydetect, key;
194 struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0, .buf = &subaddr, .len = 1},
196 { .addr = ir->c->addr, .flags = I2C_M_RD, .buf = &keydetect, .len = 1} };
199 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
200 i2cdprintk("read error\n");
203 if (keydetect == 0x00)
208 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
209 i2cdprintk("read error\n");
220 /**********************************************************
221 Poll based get keycode functions
222 **********************************************************/
224 /* This is for the em2860/em2880 */
225 static int default_polling_getkey(struct em28xx_IR *ir,
226 struct em28xx_ir_poll_result *poll_result)
228 struct em28xx *dev = ir->dev;
230 u8 msg[3] = { 0, 0, 0 };
232 /* Read key toggle, brand, and key code
233 on registers 0x45, 0x46 and 0x47
235 rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
240 /* Infrared toggle (Reg 0x45[7]) */
241 poll_result->toggle_bit = (msg[0] >> 7);
243 /* Infrared read count (Reg 0x45[6:0] */
244 poll_result->read_count = (msg[0] & 0x7f);
246 /* Remote Control Address (Reg 0x46) */
247 poll_result->rc_address = msg[1];
249 /* Remote Control Data (Reg 0x47) */
250 poll_result->rc_data[0] = msg[2];
255 static int em2874_polling_getkey(struct em28xx_IR *ir,
256 struct em28xx_ir_poll_result *poll_result)
258 struct em28xx *dev = ir->dev;
260 u8 msg[5] = { 0, 0, 0, 0, 0 };
262 /* Read key toggle, brand, and key code
265 rc = dev->em28xx_read_reg_req_len(dev, 0, EM2874_R51_IR,
270 /* Infrared toggle (Reg 0x51[7]) */
271 poll_result->toggle_bit = (msg[0] >> 7);
273 /* Infrared read count (Reg 0x51[6:0] */
274 poll_result->read_count = (msg[0] & 0x7f);
276 /* Remote Control Address (Reg 0x52) */
277 poll_result->rc_address = msg[1];
279 /* Remote Control Data (Reg 0x53-55) */
280 poll_result->rc_data[0] = msg[2];
281 poll_result->rc_data[1] = msg[3];
282 poll_result->rc_data[2] = msg[4];
287 /**********************************************************
288 Polling code for em28xx
289 **********************************************************/
291 static void em28xx_ir_handle_key(struct em28xx_IR *ir)
295 struct em28xx_ir_poll_result poll_result;
297 /* read the registers containing the IR status */
298 result = ir->get_key(ir, &poll_result);
300 dprintk("ir->get_key() failed %d\n", result);
304 dprintk("ir->get_key result tb=%02x rc=%02x lr=%02x data=%02x%02x\n",
305 poll_result.toggle_bit, poll_result.read_count,
306 ir->last_readcount, poll_result.rc_address,
307 poll_result.rc_data[0]);
309 if (ir->dev->chip_id == CHIP_ID_EM2874) {
310 /* The em2874 clears the readcount field every time the
311 register is read. The em2860/2880 datasheet says that it
312 is supposed to clear the readcount, but it doesn't. So with
313 the em2874, we are looking for a non-zero read count as
314 opposed to a readcount that is incrementing */
315 ir->last_readcount = 0;
318 if (poll_result.read_count == 0) {
319 /* The button has not been pressed since the last read */
320 } else if (ir->last_toggle != poll_result.toggle_bit) {
321 /* A button has been pressed */
322 dprintk("button has been pressed\n");
323 ir->last_toggle = poll_result.toggle_bit;
324 ir->repeat_interval = 0;
326 } else if (poll_result.toggle_bit == ir->last_toggle &&
327 poll_result.read_count > 0 &&
328 poll_result.read_count != ir->last_readcount) {
329 /* The button is still being held down */
330 dprintk("button being held down\n");
332 /* Debouncer for first keypress */
333 if (ir->repeat_interval++ > 9) {
334 /* Start repeating after 1 second */
340 dprintk("sending keypress\n");
343 ir_input_keydown(ir->input, &ir->ir,
344 poll_result.rc_address << 8 |
345 poll_result.rc_data[0]);
347 ir_input_keydown(ir->input, &ir->ir,
348 poll_result.rc_data[0]);
350 ir_input_nokey(ir->input, &ir->ir);
353 ir->last_readcount = poll_result.read_count;
357 static void em28xx_ir_work(struct work_struct *work)
359 struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work.work);
361 em28xx_ir_handle_key(ir);
362 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
365 static int em28xx_ir_start(void *priv)
367 struct em28xx_IR *ir = priv;
369 INIT_DELAYED_WORK(&ir->work, em28xx_ir_work);
370 schedule_delayed_work(&ir->work, 0);
375 static void em28xx_ir_stop(void *priv)
377 struct em28xx_IR *ir = priv;
379 cancel_delayed_work_sync(&ir->work);
382 int em28xx_ir_change_protocol(void *priv, u64 ir_type)
385 struct em28xx_IR *ir = priv;
386 struct em28xx *dev = ir->dev;
387 u8 ir_config = EM2874_IR_RC5;
389 /* Adjust xclk based o IR table for RC5/NEC tables */
391 if (ir_type == IR_TYPE_RC5) {
392 dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
394 } else if (ir_type == IR_TYPE_NEC) {
395 dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
396 ir_config = EM2874_IR_NEC;
398 } else if (ir_type != IR_TYPE_UNKNOWN)
401 em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
402 EM28XX_XCLK_IR_RC5_MODE);
404 /* Setup the proper handler based on the chip */
405 switch (dev->chip_id) {
408 ir->get_key = default_polling_getkey;
411 ir->get_key = em2874_polling_getkey;
412 em28xx_write_regs(dev, EM2874_R50_IR_CONFIG, &ir_config, 1);
415 printk("Unrecognized em28xx chip id: IR not supported\n");
422 int em28xx_ir_init(struct em28xx *dev)
424 struct em28xx_IR *ir;
425 struct input_dev *input_dev;
428 if (dev->board.ir_codes == NULL) {
429 /* No remote control support */
433 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
434 input_dev = input_allocate_device();
435 if (!ir || !input_dev)
438 /* record handles to ourself */
442 ir->input = input_dev;
445 * em2874 supports more protocols. For now, let's just announce
446 * the two protocols that were already tested
448 ir->props.allowed_protos = IR_TYPE_RC5 | IR_TYPE_NEC;
450 ir->props.change_protocol = em28xx_ir_change_protocol;
451 ir->props.open = em28xx_ir_start;
452 ir->props.close = em28xx_ir_stop;
454 /* By default, keep protocol field untouched */
455 err = em28xx_ir_change_protocol(ir, IR_TYPE_UNKNOWN);
459 /* This is how often we ask the chip for IR information */
460 ir->polling = 100; /* ms */
462 /* init input device */
463 snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)",
466 usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
467 strlcat(ir->phys, "/input0", sizeof(ir->phys));
469 /* Set IR protocol */
470 err = ir_input_init(input_dev, &ir->ir, IR_TYPE_OTHER);
474 input_dev->name = ir->name;
475 input_dev->phys = ir->phys;
476 input_dev->id.bustype = BUS_USB;
477 input_dev->id.version = 1;
478 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
479 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
481 input_dev->dev.parent = &dev->udev->dev;
486 err = ir_input_register(ir->input, dev->board.ir_codes,
487 &ir->props, MODULE_NAME);
499 int em28xx_ir_fini(struct em28xx *dev)
501 struct em28xx_IR *ir = dev->ir;
503 /* skip detach on non attached boards */
508 ir_input_unregister(ir->input);
516 /**********************************************************
517 Handle Webcam snapshot button
518 **********************************************************/
520 static void em28xx_query_sbutton(struct work_struct *work)
522 /* Poll the register and see if the button is depressed */
524 container_of(work, struct em28xx, sbutton_query_work.work);
527 ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);
529 if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
531 /* Button is depressed, clear the register */
532 cleared = ((u8) ret) & ~EM28XX_R0C_USBSUSP_SNAPSHOT;
533 em28xx_write_regs(dev, EM28XX_R0C_USBSUSP, &cleared, 1);
535 /* Not emulate the keypress */
536 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
538 /* Now unpress the key */
539 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
543 /* Schedule next poll */
544 schedule_delayed_work(&dev->sbutton_query_work,
545 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
548 void em28xx_register_snapshot_button(struct em28xx *dev)
550 struct input_dev *input_dev;
553 em28xx_info("Registering snapshot button...\n");
554 input_dev = input_allocate_device();
556 em28xx_errdev("input_allocate_device failed\n");
560 usb_make_path(dev->udev, dev->snapshot_button_path,
561 sizeof(dev->snapshot_button_path));
562 strlcat(dev->snapshot_button_path, "/sbutton",
563 sizeof(dev->snapshot_button_path));
564 INIT_DELAYED_WORK(&dev->sbutton_query_work, em28xx_query_sbutton);
566 input_dev->name = "em28xx snapshot button";
567 input_dev->phys = dev->snapshot_button_path;
568 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
569 set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
570 input_dev->keycodesize = 0;
571 input_dev->keycodemax = 0;
572 input_dev->id.bustype = BUS_USB;
573 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
574 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
575 input_dev->id.version = 1;
576 input_dev->dev.parent = &dev->udev->dev;
578 err = input_register_device(input_dev);
580 em28xx_errdev("input_register_device failed\n");
581 input_free_device(input_dev);
585 dev->sbutton_input_dev = input_dev;
586 schedule_delayed_work(&dev->sbutton_query_work,
587 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
592 void em28xx_deregister_snapshot_button(struct em28xx *dev)
594 if (dev->sbutton_input_dev != NULL) {
595 em28xx_info("Deregistering snapshot button\n");
596 cancel_rearming_delayed_work(&dev->sbutton_query_work);
597 input_unregister_device(dev->sbutton_input_dev);
598 dev->sbutton_input_dev = NULL;