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 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 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 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 int em28xx_get_key_winfast_usbii_deluxe(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
184 unsigned char subaddr, keydetect, key;
186 struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0, .buf = &subaddr, .len = 1},
188 { .addr = ir->c->addr, .flags = I2C_M_RD, .buf = &keydetect, .len = 1} };
191 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
192 i2cdprintk("read error\n");
195 if (keydetect == 0x00)
200 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
201 i2cdprintk("read error\n");
212 /**********************************************************
213 Poll based get keycode functions
214 **********************************************************/
216 /* This is for the em2860/em2880 */
217 static int default_polling_getkey(struct em28xx_IR *ir,
218 struct em28xx_ir_poll_result *poll_result)
220 struct em28xx *dev = ir->dev;
222 u8 msg[3] = { 0, 0, 0 };
224 /* Read key toggle, brand, and key code
225 on registers 0x45, 0x46 and 0x47
227 rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
232 /* Infrared toggle (Reg 0x45[7]) */
233 poll_result->toggle_bit = (msg[0] >> 7);
235 /* Infrared read count (Reg 0x45[6:0] */
236 poll_result->read_count = (msg[0] & 0x7f);
238 /* Remote Control Address (Reg 0x46) */
239 poll_result->rc_address = msg[1];
241 /* Remote Control Data (Reg 0x47) */
242 poll_result->rc_data[0] = msg[2];
247 static int em2874_polling_getkey(struct em28xx_IR *ir,
248 struct em28xx_ir_poll_result *poll_result)
250 struct em28xx *dev = ir->dev;
252 u8 msg[5] = { 0, 0, 0, 0, 0 };
254 /* Read key toggle, brand, and key code
257 rc = dev->em28xx_read_reg_req_len(dev, 0, EM2874_R51_IR,
262 /* Infrared toggle (Reg 0x51[7]) */
263 poll_result->toggle_bit = (msg[0] >> 7);
265 /* Infrared read count (Reg 0x51[6:0] */
266 poll_result->read_count = (msg[0] & 0x7f);
268 /* Remote Control Address (Reg 0x52) */
269 poll_result->rc_address = msg[1];
271 /* Remote Control Data (Reg 0x53-55) */
272 poll_result->rc_data[0] = msg[2];
273 poll_result->rc_data[1] = msg[3];
274 poll_result->rc_data[2] = msg[4];
279 /**********************************************************
280 Polling code for em28xx
281 **********************************************************/
283 static void em28xx_ir_handle_key(struct em28xx_IR *ir)
286 struct em28xx_ir_poll_result poll_result;
288 /* read the registers containing the IR status */
289 result = ir->get_key(ir, &poll_result);
290 if (unlikely(result < 0)) {
291 dprintk("ir->get_key() failed %d\n", result);
295 if (unlikely(poll_result.read_count != ir->last_readcount)) {
296 dprintk("%s: toggle: %d, count: %d, key 0x%02x%02x\n", __func__,
297 poll_result.toggle_bit, poll_result.read_count,
298 poll_result.rc_address, poll_result.rc_data[0]);
301 poll_result.rc_address << 8 |
302 poll_result.rc_data[0],
303 poll_result.toggle_bit);
306 poll_result.rc_data[0],
307 poll_result.toggle_bit);
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;
317 ir->last_readcount = poll_result.read_count;
321 static void em28xx_ir_work(struct work_struct *work)
323 struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work.work);
325 em28xx_ir_handle_key(ir);
326 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
329 static int em28xx_ir_start(struct rc_dev *rc)
331 struct em28xx_IR *ir = rc->priv;
333 INIT_DELAYED_WORK(&ir->work, em28xx_ir_work);
334 schedule_delayed_work(&ir->work, 0);
339 static void em28xx_ir_stop(struct rc_dev *rc)
341 struct em28xx_IR *ir = rc->priv;
343 cancel_delayed_work_sync(&ir->work);
346 int em28xx_ir_change_protocol(struct rc_dev *rc_dev, u64 rc_type)
349 struct em28xx_IR *ir = rc_dev->priv;
350 struct em28xx *dev = ir->dev;
351 u8 ir_config = EM2874_IR_RC5;
353 /* Adjust xclk based o IR table for RC5/NEC tables */
355 if (rc_type == RC_TYPE_RC5) {
356 dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
358 } else if (rc_type == RC_TYPE_NEC) {
359 dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
360 ir_config = EM2874_IR_NEC;
362 } else if (rc_type != RC_TYPE_UNKNOWN)
365 em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
366 EM28XX_XCLK_IR_RC5_MODE);
368 /* Setup the proper handler based on the chip */
369 switch (dev->chip_id) {
372 ir->get_key = default_polling_getkey;
375 case CHIP_ID_EM28174:
376 ir->get_key = em2874_polling_getkey;
377 em28xx_write_regs(dev, EM2874_R50_IR_CONFIG, &ir_config, 1);
380 printk("Unrecognized em28xx chip id: IR not supported\n");
387 int em28xx_ir_init(struct em28xx *dev)
389 struct em28xx_IR *ir;
393 if (dev->board.ir_codes == NULL) {
394 /* No remote control support */
398 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
399 rc = rc_allocate_device();
403 /* record handles to ourself */
409 * em2874 supports more protocols. For now, let's just announce
410 * the two protocols that were already tested
412 rc->allowed_protos = RC_TYPE_RC5 | RC_TYPE_NEC;
414 rc->change_protocol = em28xx_ir_change_protocol;
415 rc->open = em28xx_ir_start;
416 rc->close = em28xx_ir_stop;
418 /* By default, keep protocol field untouched */
419 err = em28xx_ir_change_protocol(rc, RC_TYPE_UNKNOWN);
423 /* This is how often we ask the chip for IR information */
424 ir->polling = 100; /* ms */
426 /* init input device */
427 snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)",
430 usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
431 strlcat(ir->phys, "/input0", sizeof(ir->phys));
433 rc->input_name = ir->name;
434 rc->input_phys = ir->phys;
435 rc->input_id.bustype = BUS_USB;
436 rc->input_id.version = 1;
437 rc->input_id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
438 rc->input_id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
439 rc->dev.parent = &dev->udev->dev;
440 rc->map_name = dev->board.ir_codes;
441 rc->driver_name = MODULE_NAME;
444 err = rc_register_device(rc);
458 int em28xx_ir_fini(struct em28xx *dev)
460 struct em28xx_IR *ir = dev->ir;
462 /* skip detach on non attached boards */
466 em28xx_ir_stop(ir->rc);
467 rc_unregister_device(ir->rc);
475 /**********************************************************
476 Handle Webcam snapshot button
477 **********************************************************/
479 static void em28xx_query_sbutton(struct work_struct *work)
481 /* Poll the register and see if the button is depressed */
483 container_of(work, struct em28xx, sbutton_query_work.work);
486 ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);
488 if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
490 /* Button is depressed, clear the register */
491 cleared = ((u8) ret) & ~EM28XX_R0C_USBSUSP_SNAPSHOT;
492 em28xx_write_regs(dev, EM28XX_R0C_USBSUSP, &cleared, 1);
494 /* Not emulate the keypress */
495 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
497 /* Now unpress the key */
498 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
502 /* Schedule next poll */
503 schedule_delayed_work(&dev->sbutton_query_work,
504 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
507 void em28xx_register_snapshot_button(struct em28xx *dev)
509 struct input_dev *input_dev;
512 em28xx_info("Registering snapshot button...\n");
513 input_dev = input_allocate_device();
515 em28xx_errdev("input_allocate_device failed\n");
519 usb_make_path(dev->udev, dev->snapshot_button_path,
520 sizeof(dev->snapshot_button_path));
521 strlcat(dev->snapshot_button_path, "/sbutton",
522 sizeof(dev->snapshot_button_path));
523 INIT_DELAYED_WORK(&dev->sbutton_query_work, em28xx_query_sbutton);
525 input_dev->name = "em28xx snapshot button";
526 input_dev->phys = dev->snapshot_button_path;
527 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
528 set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
529 input_dev->keycodesize = 0;
530 input_dev->keycodemax = 0;
531 input_dev->id.bustype = BUS_USB;
532 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
533 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
534 input_dev->id.version = 1;
535 input_dev->dev.parent = &dev->udev->dev;
537 err = input_register_device(input_dev);
539 em28xx_errdev("input_register_device failed\n");
540 input_free_device(input_dev);
544 dev->sbutton_input_dev = input_dev;
545 schedule_delayed_work(&dev->sbutton_query_work,
546 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
551 void em28xx_deregister_snapshot_button(struct em28xx *dev)
553 if (dev->sbutton_input_dev != NULL) {
554 em28xx_info("Deregistering snapshot button\n");
555 cancel_delayed_work_sync(&dev->sbutton_query_work);
556 input_unregister_device(dev->sbutton_input_dev);
557 dev->sbutton_input_dev = NULL;