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 i2cdprintk(fmt, arg...) \
44 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
47 #define dprintk(fmt, arg...) \
49 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
52 /**********************************************************
53 Polling structure used by em28xx IR's
54 **********************************************************/
56 struct em28xx_ir_poll_result {
57 unsigned int toggle_bit:1;
58 unsigned int read_count:7;
60 u8 rc_data[4]; /* 1 byte on em2860/2880, 4 on em2874 */
65 struct input_dev *input;
66 struct ir_input_state ir;
70 /* poll external decoder */
72 struct delayed_work work;
73 unsigned int last_toggle:1;
74 unsigned int full_code:1;
75 unsigned int last_readcount;
76 unsigned int repeat_interval;
78 int (*get_key)(struct em28xx_IR *, struct em28xx_ir_poll_result *);
80 /* IR device properties */
82 struct ir_dev_props props;
85 /**********************************************************
86 I2C IR based get keycodes - should be used with ir-kbd-i2c
87 **********************************************************/
89 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
94 if (1 != i2c_master_recv(ir->c, &b, 1)) {
95 i2cdprintk("read error\n");
99 /* it seems that 0xFE indicates that a button is still hold
100 down, while 0xff indicates that no button is hold
101 down. 0xfe sequences are sometimes interrupted by 0xFF */
103 i2cdprintk("key %02x\n", b);
117 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
119 unsigned char buf[2];
124 size = i2c_master_recv(ir->c, buf, sizeof(buf));
129 /* Does eliminate repeated parity code */
136 * Rearranges bits to the right order.
137 * The bit order were determined experimentally by using
138 * The original Hauppauge Grey IR and another RC5 that uses addr=0x08
139 * The RC5 code has 14 bits, but we've experimentally determined
140 * the meaning for only 11 bits.
141 * So, the code translation is not complete. Yet, it is enough to
142 * work with the provided RC5 IR.
145 ((buf[0] & 0x01) ? 0x0020 : 0) | /* 0010 0000 */
146 ((buf[0] & 0x02) ? 0x0010 : 0) | /* 0001 0000 */
147 ((buf[0] & 0x04) ? 0x0008 : 0) | /* 0000 1000 */
148 ((buf[0] & 0x08) ? 0x0004 : 0) | /* 0000 0100 */
149 ((buf[0] & 0x10) ? 0x0002 : 0) | /* 0000 0010 */
150 ((buf[0] & 0x20) ? 0x0001 : 0) | /* 0000 0001 */
151 ((buf[1] & 0x08) ? 0x1000 : 0) | /* 0001 0000 */
152 ((buf[1] & 0x10) ? 0x0800 : 0) | /* 0000 1000 */
153 ((buf[1] & 0x20) ? 0x0400 : 0) | /* 0000 0100 */
154 ((buf[1] & 0x40) ? 0x0200 : 0) | /* 0000 0010 */
155 ((buf[1] & 0x80) ? 0x0100 : 0); /* 0000 0001 */
157 i2cdprintk("ir hauppauge (em2840): code=0x%02x (rcv=0x%02x%02x)\n",
158 code, buf[1], buf[0]);
166 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
169 unsigned char buf[3];
173 if (3 != i2c_master_recv(ir->c, buf, 3)) {
174 i2cdprintk("read error\n");
178 i2cdprintk("key %02x\n", buf[2]&0x3f);
182 *ir_key = buf[2]&0x3f;
183 *ir_raw = buf[2]&0x3f;
188 int em28xx_get_key_winfast_usbii_deluxe(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
190 unsigned char subaddr, keydetect, key;
192 struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0, .buf = &subaddr, .len = 1},
194 { .addr = ir->c->addr, .flags = I2C_M_RD, .buf = &keydetect, .len = 1} };
197 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
198 i2cdprintk("read error\n");
201 if (keydetect == 0x00)
206 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
207 i2cdprintk("read error\n");
218 /**********************************************************
219 Poll based get keycode functions
220 **********************************************************/
222 /* This is for the em2860/em2880 */
223 static int default_polling_getkey(struct em28xx_IR *ir,
224 struct em28xx_ir_poll_result *poll_result)
226 struct em28xx *dev = ir->dev;
228 u8 msg[3] = { 0, 0, 0 };
230 /* Read key toggle, brand, and key code
231 on registers 0x45, 0x46 and 0x47
233 rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
238 /* Infrared toggle (Reg 0x45[7]) */
239 poll_result->toggle_bit = (msg[0] >> 7);
241 /* Infrared read count (Reg 0x45[6:0] */
242 poll_result->read_count = (msg[0] & 0x7f);
244 /* Remote Control Address (Reg 0x46) */
245 poll_result->rc_address = msg[1];
247 /* Remote Control Data (Reg 0x47) */
248 poll_result->rc_data[0] = msg[2];
253 static int em2874_polling_getkey(struct em28xx_IR *ir,
254 struct em28xx_ir_poll_result *poll_result)
256 struct em28xx *dev = ir->dev;
258 u8 msg[5] = { 0, 0, 0, 0, 0 };
260 /* Read key toggle, brand, and key code
263 rc = dev->em28xx_read_reg_req_len(dev, 0, EM2874_R51_IR,
268 /* Infrared toggle (Reg 0x51[7]) */
269 poll_result->toggle_bit = (msg[0] >> 7);
271 /* Infrared read count (Reg 0x51[6:0] */
272 poll_result->read_count = (msg[0] & 0x7f);
274 /* Remote Control Address (Reg 0x52) */
275 poll_result->rc_address = msg[1];
277 /* Remote Control Data (Reg 0x53-55) */
278 poll_result->rc_data[0] = msg[2];
279 poll_result->rc_data[1] = msg[3];
280 poll_result->rc_data[2] = msg[4];
285 /**********************************************************
286 Polling code for em28xx
287 **********************************************************/
289 static void em28xx_ir_handle_key(struct em28xx_IR *ir)
293 struct em28xx_ir_poll_result poll_result;
295 /* read the registers containing the IR status */
296 result = ir->get_key(ir, &poll_result);
298 dprintk("ir->get_key() failed %d\n", result);
302 dprintk("ir->get_key result tb=%02x rc=%02x lr=%02x data=%02x%02x\n",
303 poll_result.toggle_bit, poll_result.read_count,
304 ir->last_readcount, poll_result.rc_address,
305 poll_result.rc_data[0]);
307 if (ir->dev->chip_id == CHIP_ID_EM2874) {
308 /* The em2874 clears the readcount field every time the
309 register is read. The em2860/2880 datasheet says that it
310 is supposed to clear the readcount, but it doesn't. So with
311 the em2874, we are looking for a non-zero read count as
312 opposed to a readcount that is incrementing */
313 ir->last_readcount = 0;
316 if (poll_result.read_count == 0) {
317 /* The button has not been pressed since the last read */
318 } else if (ir->last_toggle != poll_result.toggle_bit) {
319 /* A button has been pressed */
320 dprintk("button has been pressed\n");
321 ir->last_toggle = poll_result.toggle_bit;
322 ir->repeat_interval = 0;
324 } else if (poll_result.toggle_bit == ir->last_toggle &&
325 poll_result.read_count > 0 &&
326 poll_result.read_count != ir->last_readcount) {
327 /* The button is still being held down */
328 dprintk("button being held down\n");
330 /* Debouncer for first keypress */
331 if (ir->repeat_interval++ > 9) {
332 /* Start repeating after 1 second */
338 dprintk("sending keypress\n");
341 ir_input_keydown(ir->input, &ir->ir,
342 poll_result.rc_address << 8 |
343 poll_result.rc_data[0]);
345 ir_input_keydown(ir->input, &ir->ir,
346 poll_result.rc_data[0]);
348 ir_input_nokey(ir->input, &ir->ir);
351 ir->last_readcount = poll_result.read_count;
355 static void em28xx_ir_work(struct work_struct *work)
357 struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work.work);
359 em28xx_ir_handle_key(ir);
360 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
363 static void em28xx_ir_start(struct em28xx_IR *ir)
365 INIT_DELAYED_WORK(&ir->work, em28xx_ir_work);
366 schedule_delayed_work(&ir->work, 0);
369 static void em28xx_ir_stop(struct em28xx_IR *ir)
371 cancel_delayed_work_sync(&ir->work);
374 int em28xx_ir_change_protocol(void *priv, u64 ir_type)
377 struct em28xx_IR *ir = priv;
378 struct em28xx *dev = ir->dev;
379 u8 ir_config = EM2874_IR_RC5;
381 /* Adjust xclk based o IR table for RC5/NEC tables */
383 dev->board.ir_codes->ir_type = IR_TYPE_OTHER;
384 if (ir_type == IR_TYPE_RC5) {
385 dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
387 } else if (ir_type == IR_TYPE_NEC) {
388 dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
389 ir_config = EM2874_IR_NEC;
394 dev->board.ir_codes->ir_type = ir_type;
396 em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
397 EM28XX_XCLK_IR_RC5_MODE);
399 /* Setup the proper handler based on the chip */
400 switch (dev->chip_id) {
403 ir->get_key = default_polling_getkey;
406 ir->get_key = em2874_polling_getkey;
407 em28xx_write_regs(dev, EM2874_R50_IR_CONFIG, &ir_config, 1);
410 printk("Unrecognized em28xx chip id: IR not supported\n");
417 int em28xx_ir_init(struct em28xx *dev)
419 struct em28xx_IR *ir;
420 struct input_dev *input_dev;
423 if (dev->board.ir_codes == NULL) {
424 /* No remote control support */
428 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
429 input_dev = input_allocate_device();
430 if (!ir || !input_dev)
433 /* record handles to ourself */
437 ir->input = input_dev;
440 * em2874 supports more protocols. For now, let's just announce
441 * the two protocols that were already tested
443 ir->props.allowed_protos = IR_TYPE_RC5 | IR_TYPE_NEC;
445 ir->props.change_protocol = em28xx_ir_change_protocol;
447 /* This is how often we ask the chip for IR information */
448 ir->polling = 100; /* ms */
450 /* init input device */
451 snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)",
454 usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
455 strlcat(ir->phys, "/input0", sizeof(ir->phys));
457 /* Set IR protocol */
458 em28xx_ir_change_protocol(ir, dev->board.ir_codes->ir_type);
459 err = ir_input_init(input_dev, &ir->ir, IR_TYPE_OTHER);
463 input_dev->name = ir->name;
464 input_dev->phys = ir->phys;
465 input_dev->id.bustype = BUS_USB;
466 input_dev->id.version = 1;
467 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
468 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
470 input_dev->dev.parent = &dev->udev->dev;
476 err = ir_input_register(ir->input, dev->board.ir_codes,
490 int em28xx_ir_fini(struct em28xx *dev)
492 struct em28xx_IR *ir = dev->ir;
494 /* skip detach on non attached boards */
499 ir_input_unregister(ir->input);
507 /**********************************************************
508 Handle Webcam snapshot button
509 **********************************************************/
511 static void em28xx_query_sbutton(struct work_struct *work)
513 /* Poll the register and see if the button is depressed */
515 container_of(work, struct em28xx, sbutton_query_work.work);
518 ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);
520 if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
522 /* Button is depressed, clear the register */
523 cleared = ((u8) ret) & ~EM28XX_R0C_USBSUSP_SNAPSHOT;
524 em28xx_write_regs(dev, EM28XX_R0C_USBSUSP, &cleared, 1);
526 /* Not emulate the keypress */
527 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
529 /* Now unpress the key */
530 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
534 /* Schedule next poll */
535 schedule_delayed_work(&dev->sbutton_query_work,
536 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
539 void em28xx_register_snapshot_button(struct em28xx *dev)
541 struct input_dev *input_dev;
544 em28xx_info("Registering snapshot button...\n");
545 input_dev = input_allocate_device();
547 em28xx_errdev("input_allocate_device failed\n");
551 usb_make_path(dev->udev, dev->snapshot_button_path,
552 sizeof(dev->snapshot_button_path));
553 strlcat(dev->snapshot_button_path, "/sbutton",
554 sizeof(dev->snapshot_button_path));
555 INIT_DELAYED_WORK(&dev->sbutton_query_work, em28xx_query_sbutton);
557 input_dev->name = "em28xx snapshot button";
558 input_dev->phys = dev->snapshot_button_path;
559 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
560 set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
561 input_dev->keycodesize = 0;
562 input_dev->keycodemax = 0;
563 input_dev->id.bustype = BUS_USB;
564 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
565 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
566 input_dev->id.version = 1;
567 input_dev->dev.parent = &dev->udev->dev;
569 err = input_register_device(input_dev);
571 em28xx_errdev("input_register_device failed\n");
572 input_free_device(input_dev);
576 dev->sbutton_input_dev = input_dev;
577 schedule_delayed_work(&dev->sbutton_query_work,
578 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
583 void em28xx_deregister_snapshot_button(struct em28xx *dev)
585 if (dev->sbutton_input_dev != NULL) {
586 em28xx_info("Deregistering snapshot button\n");
587 cancel_rearming_delayed_work(&dev->sbutton_query_work);
588 input_unregister_device(dev->sbutton_input_dev);
589 dev->sbutton_input_dev = NULL;