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/usb.h>
29 #include <linux/slab.h>
33 #define EM28XX_SNAPSHOT_KEY KEY_CAMERA
34 #define EM28XX_SBUTTON_QUERY_INTERVAL 500
35 #define EM28XX_R0C_USBSUSP_SNAPSHOT 0x20
37 static unsigned int ir_debug;
38 module_param(ir_debug, int, 0644);
39 MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
41 #define MODULE_NAME "em28xx"
43 #define dprintk(fmt, arg...) \
45 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
48 /**********************************************************
49 Polling structure used by em28xx IR's
50 **********************************************************/
52 struct em28xx_ir_poll_result {
53 unsigned int toggle_bit:1;
54 unsigned int read_count:7;
67 struct delayed_work work;
68 unsigned int full_code:1;
69 unsigned int last_readcount;
72 /* i2c slave address of external device (if used) */
75 int (*get_key_i2c)(struct i2c_client *, u32 *);
76 int (*get_key)(struct em28xx_IR *, struct em28xx_ir_poll_result *);
79 /**********************************************************
80 I2C IR based get keycodes - should be used with ir-kbd-i2c
81 **********************************************************/
83 static int em28xx_get_key_terratec(struct i2c_client *i2c_dev, u32 *ir_key)
88 if (1 != i2c_master_recv(i2c_dev, &b, 1))
91 /* it seems that 0xFE indicates that a button is still hold
92 down, while 0xff indicates that no button is hold down. */
105 static int em28xx_get_key_em_haup(struct i2c_client *i2c_dev, u32 *ir_key)
107 unsigned char buf[2];
112 size = i2c_master_recv(i2c_dev, buf, sizeof(buf));
117 /* Does eliminate repeated parity code */
122 * Rearranges bits to the right order.
123 * The bit order were determined experimentally by using
124 * The original Hauppauge Grey IR and another RC5 that uses addr=0x08
125 * The RC5 code has 14 bits, but we've experimentally determined
126 * the meaning for only 11 bits.
127 * So, the code translation is not complete. Yet, it is enough to
128 * work with the provided RC5 IR.
131 ((buf[0] & 0x01) ? 0x0020 : 0) | /* 0010 0000 */
132 ((buf[0] & 0x02) ? 0x0010 : 0) | /* 0001 0000 */
133 ((buf[0] & 0x04) ? 0x0008 : 0) | /* 0000 1000 */
134 ((buf[0] & 0x08) ? 0x0004 : 0) | /* 0000 0100 */
135 ((buf[0] & 0x10) ? 0x0002 : 0) | /* 0000 0010 */
136 ((buf[0] & 0x20) ? 0x0001 : 0) | /* 0000 0001 */
137 ((buf[1] & 0x08) ? 0x1000 : 0) | /* 0001 0000 */
138 ((buf[1] & 0x10) ? 0x0800 : 0) | /* 0000 1000 */
139 ((buf[1] & 0x20) ? 0x0400 : 0) | /* 0000 0100 */
140 ((buf[1] & 0x40) ? 0x0200 : 0) | /* 0000 0010 */
141 ((buf[1] & 0x80) ? 0x0100 : 0); /* 0000 0001 */
148 static int em28xx_get_key_pinnacle_usb_grey(struct i2c_client *i2c_dev,
151 unsigned char buf[3];
155 if (3 != i2c_master_recv(i2c_dev, buf, 3))
161 *ir_key = buf[2]&0x3f;
166 static int em28xx_get_key_winfast_usbii_deluxe(struct i2c_client *i2c_dev,
169 unsigned char subaddr, keydetect, key;
171 struct i2c_msg msg[] = { { .addr = i2c_dev->addr, .flags = 0, .buf = &subaddr, .len = 1},
172 { .addr = i2c_dev->addr, .flags = I2C_M_RD, .buf = &keydetect, .len = 1} };
175 if (2 != i2c_transfer(i2c_dev->adapter, msg, 2))
177 if (keydetect == 0x00)
182 if (2 != i2c_transfer(i2c_dev->adapter, msg, 2))
191 /**********************************************************
192 Poll based get keycode functions
193 **********************************************************/
195 /* This is for the em2860/em2880 */
196 static int default_polling_getkey(struct em28xx_IR *ir,
197 struct em28xx_ir_poll_result *poll_result)
199 struct em28xx *dev = ir->dev;
201 u8 msg[3] = { 0, 0, 0 };
203 /* Read key toggle, brand, and key code
204 on registers 0x45, 0x46 and 0x47
206 rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
211 /* Infrared toggle (Reg 0x45[7]) */
212 poll_result->toggle_bit = (msg[0] >> 7);
214 /* Infrared read count (Reg 0x45[6:0] */
215 poll_result->read_count = (msg[0] & 0x7f);
217 /* Remote Control Address/Data (Regs 0x46/0x47) */
218 poll_result->scancode = msg[1] << 8 | msg[2];
223 static int em2874_polling_getkey(struct em28xx_IR *ir,
224 struct em28xx_ir_poll_result *poll_result)
226 struct em28xx *dev = ir->dev;
228 u8 msg[5] = { 0, 0, 0, 0, 0 };
230 /* Read key toggle, brand, and key code
233 rc = dev->em28xx_read_reg_req_len(dev, 0, EM2874_R51_IR,
238 /* Infrared toggle (Reg 0x51[7]) */
239 poll_result->toggle_bit = (msg[0] >> 7);
241 /* Infrared read count (Reg 0x51[6:0] */
242 poll_result->read_count = (msg[0] & 0x7f);
245 * Remote Control Address (Reg 0x52)
246 * Remote Control Data (Reg 0x53-0x55)
248 switch (ir->rc_type) {
250 poll_result->scancode = msg[1] << 8 | msg[2];
253 if ((msg[3] ^ msg[4]) != 0xff) /* 32 bits NEC */
254 poll_result->scancode = (msg[1] << 24) |
258 else if ((msg[1] ^ msg[2]) != 0xff) /* 24 bits NEC */
259 poll_result->scancode = (msg[1] << 16) |
262 else /* Normal NEC */
263 poll_result->scancode = msg[1] << 8 | msg[3];
266 poll_result->scancode = msg[1] << 8 | msg[2];
269 poll_result->scancode = (msg[1] << 24) | (msg[2] << 16) |
270 (msg[3] << 8) | msg[4];
277 /**********************************************************
278 Polling code for em28xx
279 **********************************************************/
281 static int em28xx_i2c_ir_handle_key(struct em28xx_IR *ir)
283 struct em28xx *dev = ir->dev;
286 struct i2c_client client;
288 client.adapter = &ir->dev->i2c_adap[dev->def_i2c_bus];
289 client.addr = ir->i2c_dev_addr;
291 rc = ir->get_key_i2c(&client, &ir_key);
293 dprintk("ir->get_key_i2c() failed: %d\n", rc);
298 dprintk("%s: keycode = 0x%04x\n", __func__, ir_key);
299 rc_keydown(ir->rc, ir_key, 0);
304 static void em28xx_ir_handle_key(struct em28xx_IR *ir)
307 struct em28xx_ir_poll_result poll_result;
309 /* read the registers containing the IR status */
310 result = ir->get_key(ir, &poll_result);
311 if (unlikely(result < 0)) {
312 dprintk("ir->get_key() failed: %d\n", result);
316 if (unlikely(poll_result.read_count != ir->last_readcount)) {
317 dprintk("%s: toggle: %d, count: %d, key 0x%04x\n", __func__,
318 poll_result.toggle_bit, poll_result.read_count,
319 poll_result.scancode);
322 poll_result.scancode,
323 poll_result.toggle_bit);
326 poll_result.scancode & 0xff,
327 poll_result.toggle_bit);
329 if (ir->dev->chip_id == CHIP_ID_EM2874 ||
330 ir->dev->chip_id == CHIP_ID_EM2884)
331 /* The em2874 clears the readcount field every time the
332 register is read. The em2860/2880 datasheet says that it
333 is supposed to clear the readcount, but it doesn't. So with
334 the em2874, we are looking for a non-zero read count as
335 opposed to a readcount that is incrementing */
336 ir->last_readcount = 0;
338 ir->last_readcount = poll_result.read_count;
342 static void em28xx_ir_work(struct work_struct *work)
344 struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work.work);
346 if (ir->i2c_dev_addr) /* external i2c device */
347 em28xx_i2c_ir_handle_key(ir);
348 else /* internal device */
349 em28xx_ir_handle_key(ir);
350 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
353 static int em28xx_ir_start(struct rc_dev *rc)
355 struct em28xx_IR *ir = rc->priv;
357 INIT_DELAYED_WORK(&ir->work, em28xx_ir_work);
358 schedule_delayed_work(&ir->work, 0);
363 static void em28xx_ir_stop(struct rc_dev *rc)
365 struct em28xx_IR *ir = rc->priv;
367 cancel_delayed_work_sync(&ir->work);
370 static int em2860_ir_change_protocol(struct rc_dev *rc_dev, u64 *rc_type)
372 struct em28xx_IR *ir = rc_dev->priv;
373 struct em28xx *dev = ir->dev;
375 /* Adjust xclk based on IR table for RC5/NEC tables */
376 if (*rc_type & RC_BIT_RC5) {
377 dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
379 *rc_type = RC_BIT_RC5;
380 } else if (*rc_type & RC_BIT_NEC) {
381 dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
383 *rc_type = RC_BIT_NEC;
384 } else if (*rc_type & RC_BIT_UNKNOWN) {
385 *rc_type = RC_BIT_UNKNOWN;
387 *rc_type = ir->rc_type;
390 em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
391 EM28XX_XCLK_IR_RC5_MODE);
393 ir->rc_type = *rc_type;
398 static int em2874_ir_change_protocol(struct rc_dev *rc_dev, u64 *rc_type)
400 struct em28xx_IR *ir = rc_dev->priv;
401 struct em28xx *dev = ir->dev;
402 u8 ir_config = EM2874_IR_RC5;
404 /* Adjust xclk and set type based on IR table for RC5/NEC/RC6 tables */
405 if (*rc_type & RC_BIT_RC5) {
406 dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
408 *rc_type = RC_BIT_RC5;
409 } else if (*rc_type & RC_BIT_NEC) {
410 dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
411 ir_config = EM2874_IR_NEC | EM2874_IR_NEC_NO_PARITY;
413 *rc_type = RC_BIT_NEC;
414 } else if (*rc_type & RC_BIT_RC6_0) {
415 dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
416 ir_config = EM2874_IR_RC6_MODE_0;
418 *rc_type = RC_BIT_RC6_0;
419 } else if (*rc_type & RC_BIT_UNKNOWN) {
420 *rc_type = RC_BIT_UNKNOWN;
422 *rc_type = ir->rc_type;
425 em28xx_write_regs(dev, EM2874_R50_IR_CONFIG, &ir_config, 1);
426 em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
427 EM28XX_XCLK_IR_RC5_MODE);
429 ir->rc_type = *rc_type;
433 static int em28xx_ir_change_protocol(struct rc_dev *rc_dev, u64 *rc_type)
435 struct em28xx_IR *ir = rc_dev->priv;
436 struct em28xx *dev = ir->dev;
438 /* Setup the proper handler based on the chip */
439 switch (dev->chip_id) {
442 return em2860_ir_change_protocol(rc_dev, rc_type);
445 case CHIP_ID_EM28174:
446 return em2874_ir_change_protocol(rc_dev, rc_type);
448 printk("Unrecognized em28xx chip id 0x%02x: IR not supported\n",
454 static int em28xx_probe_i2c_ir(struct em28xx *dev)
457 /* Leadtek winfast tv USBII deluxe can find a non working IR-device */
458 /* at address 0x18, so if that address is needed for another board in */
459 /* the future, please put it after 0x1f. */
460 const unsigned short addr_list[] = {
461 0x1f, 0x30, 0x47, I2C_CLIENT_END
464 while (addr_list[i] != I2C_CLIENT_END) {
465 if (i2c_probe_func_quick_read(&dev->i2c_adap[dev->def_i2c_bus], addr_list[i]) == 1)
473 /**********************************************************
474 Handle Webcam snapshot button
475 **********************************************************/
477 static void em28xx_query_sbutton(struct work_struct *work)
479 /* Poll the register and see if the button is depressed */
481 container_of(work, struct em28xx, sbutton_query_work.work);
484 ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);
486 if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
488 /* Button is depressed, clear the register */
489 cleared = ((u8) ret) & ~EM28XX_R0C_USBSUSP_SNAPSHOT;
490 em28xx_write_regs(dev, EM28XX_R0C_USBSUSP, &cleared, 1);
492 /* Not emulate the keypress */
493 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
495 /* Now unpress the key */
496 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
500 /* Schedule next poll */
501 schedule_delayed_work(&dev->sbutton_query_work,
502 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
505 static void em28xx_register_snapshot_button(struct em28xx *dev)
507 struct input_dev *input_dev;
510 em28xx_info("Registering snapshot button...\n");
511 input_dev = input_allocate_device();
513 em28xx_errdev("input_allocate_device failed\n");
517 usb_make_path(dev->udev, dev->snapshot_button_path,
518 sizeof(dev->snapshot_button_path));
519 strlcat(dev->snapshot_button_path, "/sbutton",
520 sizeof(dev->snapshot_button_path));
521 INIT_DELAYED_WORK(&dev->sbutton_query_work, em28xx_query_sbutton);
523 input_dev->name = "em28xx snapshot button";
524 input_dev->phys = dev->snapshot_button_path;
525 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
526 set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
527 input_dev->keycodesize = 0;
528 input_dev->keycodemax = 0;
529 input_dev->id.bustype = BUS_USB;
530 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
531 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
532 input_dev->id.version = 1;
533 input_dev->dev.parent = &dev->udev->dev;
535 err = input_register_device(input_dev);
537 em28xx_errdev("input_register_device failed\n");
538 input_free_device(input_dev);
542 dev->sbutton_input_dev = input_dev;
543 schedule_delayed_work(&dev->sbutton_query_work,
544 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
549 static void em28xx_deregister_snapshot_button(struct em28xx *dev)
551 if (dev->sbutton_input_dev != NULL) {
552 em28xx_info("Deregistering snapshot button\n");
553 cancel_delayed_work_sync(&dev->sbutton_query_work);
554 input_unregister_device(dev->sbutton_input_dev);
555 dev->sbutton_input_dev = NULL;
560 static int em28xx_ir_init(struct em28xx *dev)
562 struct em28xx_IR *ir;
566 u16 i2c_rc_dev_addr = 0;
568 if (dev->board.has_snapshot_button)
569 em28xx_register_snapshot_button(dev);
571 if (dev->board.has_ir_i2c) {
572 i2c_rc_dev_addr = em28xx_probe_i2c_ir(dev);
573 if (!i2c_rc_dev_addr) {
574 dev->board.has_ir_i2c = 0;
575 em28xx_warn("No i2c IR remote control device found.\n");
580 if (dev->board.ir_codes == NULL && !dev->board.has_ir_i2c) {
581 /* No remote control support */
582 em28xx_warn("Remote control support is not available for "
587 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
588 rc = rc_allocate_device();
592 /* record handles to ourself */
598 rc->open = em28xx_ir_start;
599 rc->close = em28xx_ir_stop;
601 if (dev->board.has_ir_i2c) { /* external i2c device */
602 switch (dev->model) {
603 case EM2800_BOARD_TERRATEC_CINERGY_200:
604 case EM2820_BOARD_TERRATEC_CINERGY_250:
605 rc->map_name = RC_MAP_EM_TERRATEC;
606 ir->get_key_i2c = em28xx_get_key_terratec;
608 case EM2820_BOARD_PINNACLE_USB_2:
609 rc->map_name = RC_MAP_PINNACLE_GREY;
610 ir->get_key_i2c = em28xx_get_key_pinnacle_usb_grey;
612 case EM2820_BOARD_HAUPPAUGE_WINTV_USB_2:
613 rc->map_name = RC_MAP_HAUPPAUGE;
614 ir->get_key_i2c = em28xx_get_key_em_haup;
615 rc->allowed_protos = RC_BIT_RC5;
617 case EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE:
618 rc->map_name = RC_MAP_WINFAST_USBII_DELUXE;
619 ir->get_key_i2c = em28xx_get_key_winfast_usbii_deluxe;
626 ir->i2c_dev_addr = i2c_rc_dev_addr;
627 } else { /* internal device */
628 switch (dev->chip_id) {
631 rc->allowed_protos = RC_BIT_RC5 | RC_BIT_NEC;
632 ir->get_key = default_polling_getkey;
636 case CHIP_ID_EM28174:
637 ir->get_key = em2874_polling_getkey;
638 rc->allowed_protos = RC_BIT_RC5 | RC_BIT_NEC |
646 rc->change_protocol = em28xx_ir_change_protocol;
647 rc->map_name = dev->board.ir_codes;
649 /* By default, keep protocol field untouched */
650 rc_type = RC_BIT_UNKNOWN;
651 err = em28xx_ir_change_protocol(rc, &rc_type);
656 /* This is how often we ask the chip for IR information */
657 ir->polling = 100; /* ms */
659 /* init input device */
660 snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)", dev->name);
662 usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
663 strlcat(ir->phys, "/input0", sizeof(ir->phys));
665 rc->input_name = ir->name;
666 rc->input_phys = ir->phys;
667 rc->input_id.bustype = BUS_USB;
668 rc->input_id.version = 1;
669 rc->input_id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
670 rc->input_id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
671 rc->dev.parent = &dev->udev->dev;
672 rc->driver_name = MODULE_NAME;
675 err = rc_register_device(rc);
688 static int em28xx_ir_fini(struct em28xx *dev)
690 struct em28xx_IR *ir = dev->ir;
692 em28xx_deregister_snapshot_button(dev);
694 /* skip detach on non attached boards */
699 rc_unregister_device(ir->rc);
707 static struct em28xx_ops rc_ops = {
709 .name = "Em28xx Input Extension",
710 .init = em28xx_ir_init,
711 .fini = em28xx_ir_fini,
714 static int __init em28xx_rc_register(void)
716 return em28xx_register_extension(&rc_ops);
719 static void __exit em28xx_rc_unregister(void)
721 em28xx_unregister_extension(&rc_ops);
724 MODULE_LICENSE("GPL");
725 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@redhat.com>");
726 MODULE_DESCRIPTION("Em28xx Input driver");
728 module_init(em28xx_rc_register);
729 module_exit(em28xx_rc_unregister);