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 i2cdprintk(fmt, arg...) \
45 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
48 #define dprintk(fmt, arg...) \
50 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
53 /**********************************************************
54 Polling structure used by em28xx IR's
55 **********************************************************/
57 struct em28xx_ir_poll_result
{
58 unsigned int toggle_bit
:1;
59 unsigned int read_count
:7;
61 u8 rc_data
[4]; /* 1 byte on em2860/2880, 4 on em2874 */
70 /* poll external decoder */
72 struct delayed_work work
;
73 unsigned int full_code
:1;
74 unsigned int last_readcount
;
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 IR_i2c
*ir
, u32
*ir_key
, u32
*ir_raw
)
88 if (1 != i2c_master_recv(ir
->c
, &b
, 1)) {
89 i2cdprintk("read error\n");
93 /* it seems that 0xFE indicates that a button is still hold
94 down, while 0xff indicates that no button is hold
95 down. 0xfe sequences are sometimes interrupted by 0xFF */
97 i2cdprintk("key %02x\n", b
);
111 static int em28xx_get_key_em_haup(struct IR_i2c
*ir
, u32
*ir_key
, u32
*ir_raw
)
113 unsigned char buf
[2];
118 size
= i2c_master_recv(ir
->c
, buf
, sizeof(buf
));
123 /* Does eliminate repeated parity code */
130 * Rearranges bits to the right order.
131 * The bit order were determined experimentally by using
132 * The original Hauppauge Grey IR and another RC5 that uses addr=0x08
133 * The RC5 code has 14 bits, but we've experimentally determined
134 * the meaning for only 11 bits.
135 * So, the code translation is not complete. Yet, it is enough to
136 * work with the provided RC5 IR.
139 ((buf
[0] & 0x01) ? 0x0020 : 0) | /* 0010 0000 */
140 ((buf
[0] & 0x02) ? 0x0010 : 0) | /* 0001 0000 */
141 ((buf
[0] & 0x04) ? 0x0008 : 0) | /* 0000 1000 */
142 ((buf
[0] & 0x08) ? 0x0004 : 0) | /* 0000 0100 */
143 ((buf
[0] & 0x10) ? 0x0002 : 0) | /* 0000 0010 */
144 ((buf
[0] & 0x20) ? 0x0001 : 0) | /* 0000 0001 */
145 ((buf
[1] & 0x08) ? 0x1000 : 0) | /* 0001 0000 */
146 ((buf
[1] & 0x10) ? 0x0800 : 0) | /* 0000 1000 */
147 ((buf
[1] & 0x20) ? 0x0400 : 0) | /* 0000 0100 */
148 ((buf
[1] & 0x40) ? 0x0200 : 0) | /* 0000 0010 */
149 ((buf
[1] & 0x80) ? 0x0100 : 0); /* 0000 0001 */
151 i2cdprintk("ir hauppauge (em2840): code=0x%02x (rcv=0x%02x%02x)\n",
152 code
, buf
[1], buf
[0]);
160 static int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c
*ir
, u32
*ir_key
,
163 unsigned char buf
[3];
167 if (3 != i2c_master_recv(ir
->c
, buf
, 3)) {
168 i2cdprintk("read error\n");
172 i2cdprintk("key %02x\n", buf
[2]&0x3f);
176 *ir_key
= buf
[2]&0x3f;
177 *ir_raw
= buf
[2]&0x3f;
182 static int em28xx_get_key_winfast_usbii_deluxe(struct IR_i2c
*ir
, u32
*ir_key
,
185 unsigned char subaddr
, keydetect
, key
;
187 struct i2c_msg msg
[] = { { .addr
= ir
->c
->addr
, .flags
= 0, .buf
= &subaddr
, .len
= 1},
189 { .addr
= ir
->c
->addr
, .flags
= I2C_M_RD
, .buf
= &keydetect
, .len
= 1} };
192 if (2 != i2c_transfer(ir
->c
->adapter
, msg
, 2)) {
193 i2cdprintk("read error\n");
196 if (keydetect
== 0x00)
201 if (2 != i2c_transfer(ir
->c
->adapter
, msg
, 2)) {
202 i2cdprintk("read error\n");
213 /**********************************************************
214 Poll based get keycode functions
215 **********************************************************/
217 /* This is for the em2860/em2880 */
218 static int default_polling_getkey(struct em28xx_IR
*ir
,
219 struct em28xx_ir_poll_result
*poll_result
)
221 struct em28xx
*dev
= ir
->dev
;
223 u8 msg
[3] = { 0, 0, 0 };
225 /* Read key toggle, brand, and key code
226 on registers 0x45, 0x46 and 0x47
228 rc
= dev
->em28xx_read_reg_req_len(dev
, 0, EM28XX_R45_IR
,
233 /* Infrared toggle (Reg 0x45[7]) */
234 poll_result
->toggle_bit
= (msg
[0] >> 7);
236 /* Infrared read count (Reg 0x45[6:0] */
237 poll_result
->read_count
= (msg
[0] & 0x7f);
239 /* Remote Control Address (Reg 0x46) */
240 poll_result
->rc_address
= msg
[1];
242 /* Remote Control Data (Reg 0x47) */
243 poll_result
->rc_data
[0] = msg
[2];
248 static int em2874_polling_getkey(struct em28xx_IR
*ir
,
249 struct em28xx_ir_poll_result
*poll_result
)
251 struct em28xx
*dev
= ir
->dev
;
253 u8 msg
[5] = { 0, 0, 0, 0, 0 };
255 /* Read key toggle, brand, and key code
258 rc
= dev
->em28xx_read_reg_req_len(dev
, 0, EM2874_R51_IR
,
263 /* Infrared toggle (Reg 0x51[7]) */
264 poll_result
->toggle_bit
= (msg
[0] >> 7);
266 /* Infrared read count (Reg 0x51[6:0] */
267 poll_result
->read_count
= (msg
[0] & 0x7f);
269 /* Remote Control Address (Reg 0x52) */
270 poll_result
->rc_address
= msg
[1];
272 /* Remote Control Data (Reg 0x53-55) */
273 poll_result
->rc_data
[0] = msg
[2];
274 poll_result
->rc_data
[1] = msg
[3];
275 poll_result
->rc_data
[2] = msg
[4];
280 /**********************************************************
281 Polling code for em28xx
282 **********************************************************/
284 static void em28xx_ir_handle_key(struct em28xx_IR
*ir
)
287 struct em28xx_ir_poll_result poll_result
;
289 /* read the registers containing the IR status */
290 result
= ir
->get_key(ir
, &poll_result
);
291 if (unlikely(result
< 0)) {
292 dprintk("ir->get_key() failed %d\n", result
);
296 if (unlikely(poll_result
.read_count
!= ir
->last_readcount
)) {
297 dprintk("%s: toggle: %d, count: %d, key 0x%02x%02x\n", __func__
,
298 poll_result
.toggle_bit
, poll_result
.read_count
,
299 poll_result
.rc_address
, poll_result
.rc_data
[0]);
302 poll_result
.rc_address
<< 8 |
303 poll_result
.rc_data
[0],
304 poll_result
.toggle_bit
);
307 poll_result
.rc_data
[0],
308 poll_result
.toggle_bit
);
310 if (ir
->dev
->chip_id
== CHIP_ID_EM2874
||
311 ir
->dev
->chip_id
== CHIP_ID_EM2884
)
312 /* The em2874 clears the readcount field every time the
313 register is read. The em2860/2880 datasheet says that it
314 is supposed to clear the readcount, but it doesn't. So with
315 the em2874, we are looking for a non-zero read count as
316 opposed to a readcount that is incrementing */
317 ir
->last_readcount
= 0;
319 ir
->last_readcount
= poll_result
.read_count
;
323 static void em28xx_ir_work(struct work_struct
*work
)
325 struct em28xx_IR
*ir
= container_of(work
, struct em28xx_IR
, work
.work
);
327 em28xx_ir_handle_key(ir
);
328 schedule_delayed_work(&ir
->work
, msecs_to_jiffies(ir
->polling
));
331 static int em28xx_ir_start(struct rc_dev
*rc
)
333 struct em28xx_IR
*ir
= rc
->priv
;
335 INIT_DELAYED_WORK(&ir
->work
, em28xx_ir_work
);
336 schedule_delayed_work(&ir
->work
, 0);
341 static void em28xx_ir_stop(struct rc_dev
*rc
)
343 struct em28xx_IR
*ir
= rc
->priv
;
345 cancel_delayed_work_sync(&ir
->work
);
348 int em28xx_ir_change_protocol(struct rc_dev
*rc_dev
, u64 rc_type
)
351 struct em28xx_IR
*ir
= rc_dev
->priv
;
352 struct em28xx
*dev
= ir
->dev
;
353 u8 ir_config
= EM2874_IR_RC5
;
355 /* Adjust xclk based o IR table for RC5/NEC tables */
357 if (rc_type
== RC_TYPE_RC5
) {
358 dev
->board
.xclk
|= EM28XX_XCLK_IR_RC5_MODE
;
360 } else if (rc_type
== RC_TYPE_NEC
) {
361 dev
->board
.xclk
&= ~EM28XX_XCLK_IR_RC5_MODE
;
362 ir_config
= EM2874_IR_NEC
;
364 } else if (rc_type
!= RC_TYPE_UNKNOWN
)
367 em28xx_write_reg_bits(dev
, EM28XX_R0F_XCLK
, dev
->board
.xclk
,
368 EM28XX_XCLK_IR_RC5_MODE
);
370 /* Setup the proper handler based on the chip */
371 switch (dev
->chip_id
) {
374 ir
->get_key
= default_polling_getkey
;
378 case CHIP_ID_EM28174
:
379 ir
->get_key
= em2874_polling_getkey
;
380 em28xx_write_regs(dev
, EM2874_R50_IR_CONFIG
, &ir_config
, 1);
383 printk("Unrecognized em28xx chip id 0x%02x: IR not supported\n",
391 static void em28xx_register_i2c_ir(struct em28xx
*dev
)
393 /* Leadtek winfast tv USBII deluxe can find a non working IR-device */
394 /* at address 0x18, so if that address is needed for another board in */
395 /* the future, please put it after 0x1f. */
396 struct i2c_board_info info
;
397 const unsigned short addr_list
[] = {
398 0x1f, 0x30, 0x47, I2C_CLIENT_END
401 memset(&info
, 0, sizeof(struct i2c_board_info
));
402 memset(&dev
->init_data
, 0, sizeof(dev
->init_data
));
403 strlcpy(info
.type
, "ir_video", I2C_NAME_SIZE
);
405 /* detect & configure */
406 switch (dev
->model
) {
407 case EM2800_BOARD_TERRATEC_CINERGY_200
:
408 case EM2820_BOARD_TERRATEC_CINERGY_250
:
409 dev
->init_data
.ir_codes
= RC_MAP_EM_TERRATEC
;
410 dev
->init_data
.get_key
= em28xx_get_key_terratec
;
411 dev
->init_data
.name
= "i2c IR (EM28XX Terratec)";
413 case EM2820_BOARD_PINNACLE_USB_2
:
414 dev
->init_data
.ir_codes
= RC_MAP_PINNACLE_GREY
;
415 dev
->init_data
.get_key
= em28xx_get_key_pinnacle_usb_grey
;
416 dev
->init_data
.name
= "i2c IR (EM28XX Pinnacle PCTV)";
418 case EM2820_BOARD_HAUPPAUGE_WINTV_USB_2
:
419 dev
->init_data
.ir_codes
= RC_MAP_HAUPPAUGE
;
420 dev
->init_data
.get_key
= em28xx_get_key_em_haup
;
421 dev
->init_data
.name
= "i2c IR (EM2840 Hauppauge)";
423 case EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE
:
424 dev
->init_data
.ir_codes
= RC_MAP_WINFAST_USBII_DELUXE
;
425 dev
->init_data
.get_key
= em28xx_get_key_winfast_usbii_deluxe
;
426 dev
->init_data
.name
= "i2c IR (EM2820 Winfast TV USBII Deluxe)";
430 if (dev
->init_data
.name
)
431 info
.platform_data
= &dev
->init_data
;
432 i2c_new_probed_device(&dev
->i2c_adap
, &info
, addr_list
, NULL
);
435 /**********************************************************
436 Handle Webcam snapshot button
437 **********************************************************/
439 static void em28xx_query_sbutton(struct work_struct
*work
)
441 /* Poll the register and see if the button is depressed */
443 container_of(work
, struct em28xx
, sbutton_query_work
.work
);
446 ret
= em28xx_read_reg(dev
, EM28XX_R0C_USBSUSP
);
448 if (ret
& EM28XX_R0C_USBSUSP_SNAPSHOT
) {
450 /* Button is depressed, clear the register */
451 cleared
= ((u8
) ret
) & ~EM28XX_R0C_USBSUSP_SNAPSHOT
;
452 em28xx_write_regs(dev
, EM28XX_R0C_USBSUSP
, &cleared
, 1);
454 /* Not emulate the keypress */
455 input_report_key(dev
->sbutton_input_dev
, EM28XX_SNAPSHOT_KEY
,
457 /* Now unpress the key */
458 input_report_key(dev
->sbutton_input_dev
, EM28XX_SNAPSHOT_KEY
,
462 /* Schedule next poll */
463 schedule_delayed_work(&dev
->sbutton_query_work
,
464 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL
));
467 static void em28xx_register_snapshot_button(struct em28xx
*dev
)
469 struct input_dev
*input_dev
;
472 em28xx_info("Registering snapshot button...\n");
473 input_dev
= input_allocate_device();
475 em28xx_errdev("input_allocate_device failed\n");
479 usb_make_path(dev
->udev
, dev
->snapshot_button_path
,
480 sizeof(dev
->snapshot_button_path
));
481 strlcat(dev
->snapshot_button_path
, "/sbutton",
482 sizeof(dev
->snapshot_button_path
));
483 INIT_DELAYED_WORK(&dev
->sbutton_query_work
, em28xx_query_sbutton
);
485 input_dev
->name
= "em28xx snapshot button";
486 input_dev
->phys
= dev
->snapshot_button_path
;
487 input_dev
->evbit
[0] = BIT_MASK(EV_KEY
) | BIT_MASK(EV_REP
);
488 set_bit(EM28XX_SNAPSHOT_KEY
, input_dev
->keybit
);
489 input_dev
->keycodesize
= 0;
490 input_dev
->keycodemax
= 0;
491 input_dev
->id
.bustype
= BUS_USB
;
492 input_dev
->id
.vendor
= le16_to_cpu(dev
->udev
->descriptor
.idVendor
);
493 input_dev
->id
.product
= le16_to_cpu(dev
->udev
->descriptor
.idProduct
);
494 input_dev
->id
.version
= 1;
495 input_dev
->dev
.parent
= &dev
->udev
->dev
;
497 err
= input_register_device(input_dev
);
499 em28xx_errdev("input_register_device failed\n");
500 input_free_device(input_dev
);
504 dev
->sbutton_input_dev
= input_dev
;
505 schedule_delayed_work(&dev
->sbutton_query_work
,
506 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL
));
511 static void em28xx_deregister_snapshot_button(struct em28xx
*dev
)
513 if (dev
->sbutton_input_dev
!= NULL
) {
514 em28xx_info("Deregistering snapshot button\n");
515 cancel_delayed_work_sync(&dev
->sbutton_query_work
);
516 input_unregister_device(dev
->sbutton_input_dev
);
517 dev
->sbutton_input_dev
= NULL
;
522 static int em28xx_ir_init(struct em28xx
*dev
)
524 struct em28xx_IR
*ir
;
528 if (dev
->board
.ir_codes
== NULL
) {
529 /* No remote control support */
533 ir
= kzalloc(sizeof(*ir
), GFP_KERNEL
);
534 rc
= rc_allocate_device();
538 /* record handles to ourself */
544 * em2874 supports more protocols. For now, let's just announce
545 * the two protocols that were already tested
547 rc
->allowed_protos
= RC_TYPE_RC5
| RC_TYPE_NEC
;
549 rc
->change_protocol
= em28xx_ir_change_protocol
;
550 rc
->open
= em28xx_ir_start
;
551 rc
->close
= em28xx_ir_stop
;
553 /* By default, keep protocol field untouched */
554 err
= em28xx_ir_change_protocol(rc
, RC_TYPE_UNKNOWN
);
558 /* This is how often we ask the chip for IR information */
559 ir
->polling
= 100; /* ms */
561 /* init input device */
562 snprintf(ir
->name
, sizeof(ir
->name
), "em28xx IR (%s)",
565 usb_make_path(dev
->udev
, ir
->phys
, sizeof(ir
->phys
));
566 strlcat(ir
->phys
, "/input0", sizeof(ir
->phys
));
568 rc
->input_name
= ir
->name
;
569 rc
->input_phys
= ir
->phys
;
570 rc
->input_id
.bustype
= BUS_USB
;
571 rc
->input_id
.version
= 1;
572 rc
->input_id
.vendor
= le16_to_cpu(dev
->udev
->descriptor
.idVendor
);
573 rc
->input_id
.product
= le16_to_cpu(dev
->udev
->descriptor
.idProduct
);
574 rc
->dev
.parent
= &dev
->udev
->dev
;
575 rc
->map_name
= dev
->board
.ir_codes
;
576 rc
->driver_name
= MODULE_NAME
;
579 err
= rc_register_device(rc
);
583 em28xx_register_i2c_ir(dev
);
585 #if defined(CONFIG_MODULES) && defined(MODULE)
586 if (dev
->board
.has_ir_i2c
)
587 request_module("ir-kbd-i2c");
589 if (dev
->board
.has_snapshot_button
)
590 em28xx_register_snapshot_button(dev
);
602 static int em28xx_ir_fini(struct em28xx
*dev
)
604 struct em28xx_IR
*ir
= dev
->ir
;
606 em28xx_deregister_snapshot_button(dev
);
608 /* skip detach on non attached boards */
613 rc_unregister_device(ir
->rc
);
621 static struct em28xx_ops rc_ops
= {
623 .name
= "Em28xx Input Extension",
624 .init
= em28xx_ir_init
,
625 .fini
= em28xx_ir_fini
,
628 static int __init
em28xx_rc_register(void)
630 return em28xx_register_extension(&rc_ops
);
633 static void __exit
em28xx_rc_unregister(void)
635 em28xx_unregister_extension(&rc_ops
);
638 MODULE_LICENSE("GPL");
639 MODULE_AUTHOR("Mauro Carvalho Chehab <mchehab@redhat.com>");
640 MODULE_DESCRIPTION("Em28xx Input driver");
642 module_init(em28xx_rc_register
);
643 module_exit(em28xx_rc_unregister
);