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 /* external device (if used) */
73 struct i2c_client
*i2c_dev
;
75 int (*get_key_i2c
)(struct i2c_client
*, u32
*, 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
,
84 u32
*ir_key
, u32
*ir_raw
)
89 if (1 != i2c_master_recv(i2c_dev
, &b
, 1))
92 /* it seems that 0xFE indicates that a button is still hold
93 down, while 0xff indicates that no button is hold
94 down. 0xfe sequences are sometimes interrupted by 0xFF */
108 static int em28xx_get_key_em_haup(struct i2c_client
*i2c_dev
,
109 u32
*ir_key
, u32
*ir_raw
)
111 unsigned char buf
[2];
116 size
= i2c_master_recv(i2c_dev
, buf
, sizeof(buf
));
121 /* Does eliminate repeated parity code */
126 * Rearranges bits to the right order.
127 * The bit order were determined experimentally by using
128 * The original Hauppauge Grey IR and another RC5 that uses addr=0x08
129 * The RC5 code has 14 bits, but we've experimentally determined
130 * the meaning for only 11 bits.
131 * So, the code translation is not complete. Yet, it is enough to
132 * work with the provided RC5 IR.
135 ((buf
[0] & 0x01) ? 0x0020 : 0) | /* 0010 0000 */
136 ((buf
[0] & 0x02) ? 0x0010 : 0) | /* 0001 0000 */
137 ((buf
[0] & 0x04) ? 0x0008 : 0) | /* 0000 1000 */
138 ((buf
[0] & 0x08) ? 0x0004 : 0) | /* 0000 0100 */
139 ((buf
[0] & 0x10) ? 0x0002 : 0) | /* 0000 0010 */
140 ((buf
[0] & 0x20) ? 0x0001 : 0) | /* 0000 0001 */
141 ((buf
[1] & 0x08) ? 0x1000 : 0) | /* 0001 0000 */
142 ((buf
[1] & 0x10) ? 0x0800 : 0) | /* 0000 1000 */
143 ((buf
[1] & 0x20) ? 0x0400 : 0) | /* 0000 0100 */
144 ((buf
[1] & 0x40) ? 0x0200 : 0) | /* 0000 0010 */
145 ((buf
[1] & 0x80) ? 0x0100 : 0); /* 0000 0001 */
153 static int em28xx_get_key_pinnacle_usb_grey(struct i2c_client
*i2c_dev
,
154 u32
*ir_key
, u32
*ir_raw
)
156 unsigned char buf
[3];
160 if (3 != i2c_master_recv(i2c_dev
, buf
, 3))
166 *ir_key
= buf
[2]&0x3f;
167 *ir_raw
= buf
[2]&0x3f;
172 static int em28xx_get_key_winfast_usbii_deluxe(struct i2c_client
*i2c_dev
,
173 u32
*ir_key
, u32
*ir_raw
)
175 unsigned char subaddr
, keydetect
, key
;
177 struct i2c_msg msg
[] = { { .addr
= i2c_dev
->addr
, .flags
= 0, .buf
= &subaddr
, .len
= 1},
179 { .addr
= i2c_dev
->addr
, .flags
= I2C_M_RD
, .buf
= &keydetect
, .len
= 1} };
182 if (2 != i2c_transfer(i2c_dev
->adapter
, msg
, 2))
184 if (keydetect
== 0x00)
189 if (2 != i2c_transfer(i2c_dev
->adapter
, msg
, 2))
199 /**********************************************************
200 Poll based get keycode functions
201 **********************************************************/
203 /* This is for the em2860/em2880 */
204 static int default_polling_getkey(struct em28xx_IR
*ir
,
205 struct em28xx_ir_poll_result
*poll_result
)
207 struct em28xx
*dev
= ir
->dev
;
209 u8 msg
[3] = { 0, 0, 0 };
211 /* Read key toggle, brand, and key code
212 on registers 0x45, 0x46 and 0x47
214 rc
= dev
->em28xx_read_reg_req_len(dev
, 0, EM28XX_R45_IR
,
219 /* Infrared toggle (Reg 0x45[7]) */
220 poll_result
->toggle_bit
= (msg
[0] >> 7);
222 /* Infrared read count (Reg 0x45[6:0] */
223 poll_result
->read_count
= (msg
[0] & 0x7f);
225 /* Remote Control Address/Data (Regs 0x46/0x47) */
226 poll_result
->scancode
= msg
[1] << 8 | msg
[2];
231 static int em2874_polling_getkey(struct em28xx_IR
*ir
,
232 struct em28xx_ir_poll_result
*poll_result
)
234 struct em28xx
*dev
= ir
->dev
;
236 u8 msg
[5] = { 0, 0, 0, 0, 0 };
238 /* Read key toggle, brand, and key code
241 rc
= dev
->em28xx_read_reg_req_len(dev
, 0, EM2874_R51_IR
,
246 /* Infrared toggle (Reg 0x51[7]) */
247 poll_result
->toggle_bit
= (msg
[0] >> 7);
249 /* Infrared read count (Reg 0x51[6:0] */
250 poll_result
->read_count
= (msg
[0] & 0x7f);
253 * Remote Control Address (Reg 0x52)
254 * Remote Control Data (Reg 0x53-0x55)
256 switch (ir
->rc_type
) {
258 poll_result
->scancode
= msg
[1] << 8 | msg
[2];
261 if ((msg
[3] ^ msg
[4]) != 0xff) /* 32 bits NEC */
262 poll_result
->scancode
= (msg
[1] << 24) |
266 else if ((msg
[1] ^ msg
[2]) != 0xff) /* 24 bits NEC */
267 poll_result
->scancode
= (msg
[1] << 16) |
270 else /* Normal NEC */
271 poll_result
->scancode
= msg
[1] << 8 | msg
[3];
274 poll_result
->scancode
= msg
[1] << 8 | msg
[2];
277 poll_result
->scancode
= (msg
[1] << 24) | (msg
[2] << 16) |
278 (msg
[3] << 8) | msg
[4];
285 /**********************************************************
286 Polling code for em28xx
287 **********************************************************/
289 static int em28xx_i2c_ir_handle_key(struct em28xx_IR
*ir
)
291 static u32 ir_key
, ir_raw
;
294 rc
= ir
->get_key_i2c(ir
->i2c_dev
, &ir_key
, &ir_raw
);
296 dprintk("ir->get_key_i2c() failed: %d\n", rc
);
301 dprintk("%s: keycode = 0x%04x\n", __func__
, ir_key
);
302 rc_keydown(ir
->rc
, ir_key
, 0);
307 static void em28xx_ir_handle_key(struct em28xx_IR
*ir
)
310 struct em28xx_ir_poll_result poll_result
;
312 /* read the registers containing the IR status */
313 result
= ir
->get_key(ir
, &poll_result
);
314 if (unlikely(result
< 0)) {
315 dprintk("ir->get_key() failed: %d\n", result
);
319 if (unlikely(poll_result
.read_count
!= ir
->last_readcount
)) {
320 dprintk("%s: toggle: %d, count: %d, key 0x%04x\n", __func__
,
321 poll_result
.toggle_bit
, poll_result
.read_count
,
322 poll_result
.scancode
);
325 poll_result
.scancode
,
326 poll_result
.toggle_bit
);
329 poll_result
.scancode
& 0xff,
330 poll_result
.toggle_bit
);
332 if (ir
->dev
->chip_id
== CHIP_ID_EM2874
||
333 ir
->dev
->chip_id
== CHIP_ID_EM2884
)
334 /* The em2874 clears the readcount field every time the
335 register is read. The em2860/2880 datasheet says that it
336 is supposed to clear the readcount, but it doesn't. So with
337 the em2874, we are looking for a non-zero read count as
338 opposed to a readcount that is incrementing */
339 ir
->last_readcount
= 0;
341 ir
->last_readcount
= poll_result
.read_count
;
345 static void em28xx_i2c_ir_work(struct work_struct
*work
)
347 struct em28xx_IR
*ir
= container_of(work
, struct em28xx_IR
, work
.work
);
349 em28xx_i2c_ir_handle_key(ir
);
350 schedule_delayed_work(&ir
->work
, msecs_to_jiffies(ir
->polling
));
353 static void em28xx_ir_work(struct work_struct
*work
)
355 struct em28xx_IR
*ir
= container_of(work
, struct em28xx_IR
, work
.work
);
357 em28xx_ir_handle_key(ir
);
358 schedule_delayed_work(&ir
->work
, msecs_to_jiffies(ir
->polling
));
361 static int em28xx_ir_start(struct rc_dev
*rc
)
363 struct em28xx_IR
*ir
= rc
->priv
;
365 if (ir
->i2c_dev
) /* external i2c device */
366 INIT_DELAYED_WORK(&ir
->work
, em28xx_i2c_ir_work
);
367 else /* internal device */
368 INIT_DELAYED_WORK(&ir
->work
, em28xx_ir_work
);
369 schedule_delayed_work(&ir
->work
, 0);
374 static void em28xx_ir_stop(struct rc_dev
*rc
)
376 struct em28xx_IR
*ir
= rc
->priv
;
378 cancel_delayed_work_sync(&ir
->work
);
381 static int em2860_ir_change_protocol(struct rc_dev
*rc_dev
, u64
*rc_type
)
383 struct em28xx_IR
*ir
= rc_dev
->priv
;
384 struct em28xx
*dev
= ir
->dev
;
386 /* Adjust xclk based on IR table for RC5/NEC tables */
387 if (*rc_type
& RC_BIT_RC5
) {
388 dev
->board
.xclk
|= EM28XX_XCLK_IR_RC5_MODE
;
390 *rc_type
= RC_BIT_RC5
;
391 } else if (*rc_type
& RC_BIT_NEC
) {
392 dev
->board
.xclk
&= ~EM28XX_XCLK_IR_RC5_MODE
;
394 *rc_type
= RC_BIT_NEC
;
395 } else if (*rc_type
& RC_BIT_UNKNOWN
) {
396 *rc_type
= RC_BIT_UNKNOWN
;
398 *rc_type
= ir
->rc_type
;
401 em28xx_write_reg_bits(dev
, EM28XX_R0F_XCLK
, dev
->board
.xclk
,
402 EM28XX_XCLK_IR_RC5_MODE
);
404 ir
->rc_type
= *rc_type
;
409 static int em2874_ir_change_protocol(struct rc_dev
*rc_dev
, u64
*rc_type
)
411 struct em28xx_IR
*ir
= rc_dev
->priv
;
412 struct em28xx
*dev
= ir
->dev
;
413 u8 ir_config
= EM2874_IR_RC5
;
415 /* Adjust xclk and set type based on IR table for RC5/NEC/RC6 tables */
416 if (*rc_type
& RC_BIT_RC5
) {
417 dev
->board
.xclk
|= EM28XX_XCLK_IR_RC5_MODE
;
419 *rc_type
= RC_BIT_RC5
;
420 } else if (*rc_type
& RC_BIT_NEC
) {
421 dev
->board
.xclk
&= ~EM28XX_XCLK_IR_RC5_MODE
;
422 ir_config
= EM2874_IR_NEC
| EM2874_IR_NEC_NO_PARITY
;
424 *rc_type
= RC_BIT_NEC
;
425 } else if (*rc_type
& RC_BIT_RC6_0
) {
426 dev
->board
.xclk
|= EM28XX_XCLK_IR_RC5_MODE
;
427 ir_config
= EM2874_IR_RC6_MODE_0
;
429 *rc_type
= RC_BIT_RC6_0
;
430 } else if (*rc_type
& RC_BIT_UNKNOWN
) {
431 *rc_type
= RC_BIT_UNKNOWN
;
433 *rc_type
= ir
->rc_type
;
436 em28xx_write_regs(dev
, EM2874_R50_IR_CONFIG
, &ir_config
, 1);
437 em28xx_write_reg_bits(dev
, EM28XX_R0F_XCLK
, dev
->board
.xclk
,
438 EM28XX_XCLK_IR_RC5_MODE
);
440 ir
->rc_type
= *rc_type
;
444 static int em28xx_ir_change_protocol(struct rc_dev
*rc_dev
, u64
*rc_type
)
446 struct em28xx_IR
*ir
= rc_dev
->priv
;
447 struct em28xx
*dev
= ir
->dev
;
449 /* Setup the proper handler based on the chip */
450 switch (dev
->chip_id
) {
453 return em2860_ir_change_protocol(rc_dev
, rc_type
);
456 case CHIP_ID_EM28174
:
457 return em2874_ir_change_protocol(rc_dev
, rc_type
);
459 printk("Unrecognized em28xx chip id 0x%02x: IR not supported\n",
465 static struct i2c_client
*em28xx_probe_i2c_ir(struct em28xx
*dev
)
468 struct i2c_client
*i2c_dev
= NULL
;
469 /* Leadtek winfast tv USBII deluxe can find a non working IR-device */
470 /* at address 0x18, so if that address is needed for another board in */
471 /* the future, please put it after 0x1f. */
472 const unsigned short addr_list
[] = {
473 0x1f, 0x30, 0x47, I2C_CLIENT_END
476 while (addr_list
[i
] != I2C_CLIENT_END
) {
477 if (i2c_probe_func_quick_read(&dev
->i2c_adap
, addr_list
[i
]) == 1) {
478 i2c_dev
= kzalloc(sizeof(*i2c_dev
), GFP_KERNEL
);
480 i2c_dev
->addr
= addr_list
[i
];
481 i2c_dev
->adapter
= &dev
->i2c_adap
;
482 /* NOTE: as long as we don't register the device
483 * at the i2c subsystem, no other fields need to
494 /**********************************************************
495 Handle Webcam snapshot button
496 **********************************************************/
498 static void em28xx_query_sbutton(struct work_struct
*work
)
500 /* Poll the register and see if the button is depressed */
502 container_of(work
, struct em28xx
, sbutton_query_work
.work
);
505 ret
= em28xx_read_reg(dev
, EM28XX_R0C_USBSUSP
);
507 if (ret
& EM28XX_R0C_USBSUSP_SNAPSHOT
) {
509 /* Button is depressed, clear the register */
510 cleared
= ((u8
) ret
) & ~EM28XX_R0C_USBSUSP_SNAPSHOT
;
511 em28xx_write_regs(dev
, EM28XX_R0C_USBSUSP
, &cleared
, 1);
513 /* Not emulate the keypress */
514 input_report_key(dev
->sbutton_input_dev
, EM28XX_SNAPSHOT_KEY
,
516 /* Now unpress the key */
517 input_report_key(dev
->sbutton_input_dev
, EM28XX_SNAPSHOT_KEY
,
521 /* Schedule next poll */
522 schedule_delayed_work(&dev
->sbutton_query_work
,
523 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL
));
526 static void em28xx_register_snapshot_button(struct em28xx
*dev
)
528 struct input_dev
*input_dev
;
531 em28xx_info("Registering snapshot button...\n");
532 input_dev
= input_allocate_device();
534 em28xx_errdev("input_allocate_device failed\n");
538 usb_make_path(dev
->udev
, dev
->snapshot_button_path
,
539 sizeof(dev
->snapshot_button_path
));
540 strlcat(dev
->snapshot_button_path
, "/sbutton",
541 sizeof(dev
->snapshot_button_path
));
542 INIT_DELAYED_WORK(&dev
->sbutton_query_work
, em28xx_query_sbutton
);
544 input_dev
->name
= "em28xx snapshot button";
545 input_dev
->phys
= dev
->snapshot_button_path
;
546 input_dev
->evbit
[0] = BIT_MASK(EV_KEY
) | BIT_MASK(EV_REP
);
547 set_bit(EM28XX_SNAPSHOT_KEY
, input_dev
->keybit
);
548 input_dev
->keycodesize
= 0;
549 input_dev
->keycodemax
= 0;
550 input_dev
->id
.bustype
= BUS_USB
;
551 input_dev
->id
.vendor
= le16_to_cpu(dev
->udev
->descriptor
.idVendor
);
552 input_dev
->id
.product
= le16_to_cpu(dev
->udev
->descriptor
.idProduct
);
553 input_dev
->id
.version
= 1;
554 input_dev
->dev
.parent
= &dev
->udev
->dev
;
556 err
= input_register_device(input_dev
);
558 em28xx_errdev("input_register_device failed\n");
559 input_free_device(input_dev
);
563 dev
->sbutton_input_dev
= input_dev
;
564 schedule_delayed_work(&dev
->sbutton_query_work
,
565 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL
));
570 static void em28xx_deregister_snapshot_button(struct em28xx
*dev
)
572 if (dev
->sbutton_input_dev
!= NULL
) {
573 em28xx_info("Deregistering snapshot button\n");
574 cancel_delayed_work_sync(&dev
->sbutton_query_work
);
575 input_unregister_device(dev
->sbutton_input_dev
);
576 dev
->sbutton_input_dev
= NULL
;
581 static int em28xx_ir_init(struct em28xx
*dev
)
583 struct em28xx_IR
*ir
;
587 struct i2c_client
*i2c_rc_dev
= NULL
;
589 if (dev
->board
.has_snapshot_button
)
590 em28xx_register_snapshot_button(dev
);
592 if (dev
->board
.has_ir_i2c
) {
593 i2c_rc_dev
= em28xx_probe_i2c_ir(dev
);
595 dev
->board
.has_ir_i2c
= 0;
596 em28xx_warn("No i2c IR remote control device found.\n");
601 if (dev
->board
.ir_codes
== NULL
&& !dev
->board
.has_ir_i2c
) {
602 /* No remote control support */
603 em28xx_warn("Remote control support is not available for "
608 ir
= kzalloc(sizeof(*ir
), GFP_KERNEL
);
609 rc
= rc_allocate_device();
613 /* record handles to ourself */
619 rc
->open
= em28xx_ir_start
;
620 rc
->close
= em28xx_ir_stop
;
622 if (dev
->board
.has_ir_i2c
) { /* external i2c device */
623 switch (dev
->model
) {
624 case EM2800_BOARD_TERRATEC_CINERGY_200
:
625 case EM2820_BOARD_TERRATEC_CINERGY_250
:
626 rc
->map_name
= RC_MAP_EM_TERRATEC
;
627 ir
->get_key_i2c
= em28xx_get_key_terratec
;
629 case EM2820_BOARD_PINNACLE_USB_2
:
630 rc
->map_name
= RC_MAP_PINNACLE_GREY
;
631 ir
->get_key_i2c
= em28xx_get_key_pinnacle_usb_grey
;
633 case EM2820_BOARD_HAUPPAUGE_WINTV_USB_2
:
634 rc
->map_name
= RC_MAP_HAUPPAUGE
;
635 ir
->get_key_i2c
= em28xx_get_key_em_haup
;
636 rc
->allowed_protos
= RC_BIT_RC5
;
638 case EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE
:
639 rc
->map_name
= RC_MAP_WINFAST_USBII_DELUXE
;
640 ir
->get_key_i2c
= em28xx_get_key_winfast_usbii_deluxe
;
647 ir
->i2c_dev
= i2c_rc_dev
;
648 } else { /* internal device */
649 switch (dev
->chip_id
) {
652 rc
->allowed_protos
= RC_BIT_RC5
| RC_BIT_NEC
;
653 ir
->get_key
= default_polling_getkey
;
657 case CHIP_ID_EM28174
:
658 ir
->get_key
= em2874_polling_getkey
;
659 rc
->allowed_protos
= RC_BIT_RC5
| RC_BIT_NEC
|
667 rc
->change_protocol
= em28xx_ir_change_protocol
;
668 rc
->map_name
= dev
->board
.ir_codes
;
670 /* By default, keep protocol field untouched */
671 rc_type
= RC_BIT_UNKNOWN
;
672 err
= em28xx_ir_change_protocol(rc
, &rc_type
);
677 /* This is how often we ask the chip for IR information */
678 ir
->polling
= 100; /* ms */
680 /* init input device */
681 snprintf(ir
->name
, sizeof(ir
->name
), "em28xx IR (%s)", dev
->name
);
683 usb_make_path(dev
->udev
, ir
->phys
, sizeof(ir
->phys
));
684 strlcat(ir
->phys
, "/input0", sizeof(ir
->phys
));
686 rc
->input_name
= ir
->name
;
687 rc
->input_phys
= ir
->phys
;
688 rc
->input_id
.bustype
= BUS_USB
;
689 rc
->input_id
.version
= 1;
690 rc
->input_id
.vendor
= le16_to_cpu(dev
->udev
->descriptor
.idVendor
);
691 rc
->input_id
.product
= le16_to_cpu(dev
->udev
->descriptor
.idProduct
);
692 rc
->dev
.parent
= &dev
->udev
->dev
;
693 rc
->driver_name
= MODULE_NAME
;
696 err
= rc_register_device(rc
);
703 if (ir
&& ir
->i2c_dev
)
711 static int em28xx_ir_fini(struct em28xx
*dev
)
713 struct em28xx_IR
*ir
= dev
->ir
;
715 em28xx_deregister_snapshot_button(dev
);
717 /* skip detach on non attached boards */
722 rc_unregister_device(ir
->rc
);
732 static struct em28xx_ops rc_ops
= {
734 .name
= "Em28xx Input Extension",
735 .init
= em28xx_ir_init
,
736 .fini
= em28xx_ir_fini
,
739 static int __init
em28xx_rc_register(void)
741 return em28xx_register_extension(&rc_ops
);
744 static void __exit
em28xx_rc_unregister(void)
746 em28xx_unregister_extension(&rc_ops
);
749 MODULE_LICENSE("GPL");
750 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@redhat.com>");
751 MODULE_DESCRIPTION("Em28xx Input driver");
753 module_init(em28xx_rc_register
);
754 module_exit(em28xx_rc_unregister
);