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 MODULE_NAME "em28xx"
44 #define i2cdprintk(fmt, arg...) \
46 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
49 #define dprintk(fmt, arg...) \
51 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
54 /**********************************************************
55 Polling structure used by em28xx IR's
56 **********************************************************/
58 struct em28xx_ir_poll_result {
59 unsigned int toggle_bit:1;
60 unsigned int read_count:7;
62 u8 rc_data[4]; /* 1 byte on em2860/2880, 4 on em2874 */
67 struct input_dev *input;
71 /* poll external decoder */
73 struct delayed_work work;
74 unsigned int full_code:1;
75 unsigned int last_readcount;
77 int (*get_key)(struct em28xx_IR *, struct em28xx_ir_poll_result *);
79 /* IR device properties */
81 struct ir_dev_props props;
84 /**********************************************************
85 I2C IR based get keycodes - should be used with ir-kbd-i2c
86 **********************************************************/
88 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
93 if (1 != i2c_master_recv(ir->c, &b, 1)) {
94 i2cdprintk("read error\n");
98 /* it seems that 0xFE indicates that a button is still hold
99 down, while 0xff indicates that no button is hold
100 down. 0xfe sequences are sometimes interrupted by 0xFF */
102 i2cdprintk("key %02x\n", b);
116 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
118 unsigned char buf[2];
123 size = i2c_master_recv(ir->c, buf, sizeof(buf));
128 /* Does eliminate repeated parity code */
135 * Rearranges bits to the right order.
136 * The bit order were determined experimentally by using
137 * The original Hauppauge Grey IR and another RC5 that uses addr=0x08
138 * The RC5 code has 14 bits, but we've experimentally determined
139 * the meaning for only 11 bits.
140 * So, the code translation is not complete. Yet, it is enough to
141 * work with the provided RC5 IR.
144 ((buf[0] & 0x01) ? 0x0020 : 0) | /* 0010 0000 */
145 ((buf[0] & 0x02) ? 0x0010 : 0) | /* 0001 0000 */
146 ((buf[0] & 0x04) ? 0x0008 : 0) | /* 0000 1000 */
147 ((buf[0] & 0x08) ? 0x0004 : 0) | /* 0000 0100 */
148 ((buf[0] & 0x10) ? 0x0002 : 0) | /* 0000 0010 */
149 ((buf[0] & 0x20) ? 0x0001 : 0) | /* 0000 0001 */
150 ((buf[1] & 0x08) ? 0x1000 : 0) | /* 0001 0000 */
151 ((buf[1] & 0x10) ? 0x0800 : 0) | /* 0000 1000 */
152 ((buf[1] & 0x20) ? 0x0400 : 0) | /* 0000 0100 */
153 ((buf[1] & 0x40) ? 0x0200 : 0) | /* 0000 0010 */
154 ((buf[1] & 0x80) ? 0x0100 : 0); /* 0000 0001 */
156 i2cdprintk("ir hauppauge (em2840): code=0x%02x (rcv=0x%02x%02x)\n",
157 code, buf[1], buf[0]);
165 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
168 unsigned char buf[3];
172 if (3 != i2c_master_recv(ir->c, buf, 3)) {
173 i2cdprintk("read error\n");
177 i2cdprintk("key %02x\n", buf[2]&0x3f);
181 *ir_key = buf[2]&0x3f;
182 *ir_raw = buf[2]&0x3f;
187 int em28xx_get_key_winfast_usbii_deluxe(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
189 unsigned char subaddr, keydetect, key;
191 struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0, .buf = &subaddr, .len = 1},
193 { .addr = ir->c->addr, .flags = I2C_M_RD, .buf = &keydetect, .len = 1} };
196 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
197 i2cdprintk("read error\n");
200 if (keydetect == 0x00)
205 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
206 i2cdprintk("read error\n");
217 /**********************************************************
218 Poll based get keycode functions
219 **********************************************************/
221 /* This is for the em2860/em2880 */
222 static int default_polling_getkey(struct em28xx_IR *ir,
223 struct em28xx_ir_poll_result *poll_result)
225 struct em28xx *dev = ir->dev;
227 u8 msg[3] = { 0, 0, 0 };
229 /* Read key toggle, brand, and key code
230 on registers 0x45, 0x46 and 0x47
232 rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
237 /* Infrared toggle (Reg 0x45[7]) */
238 poll_result->toggle_bit = (msg[0] >> 7);
240 /* Infrared read count (Reg 0x45[6:0] */
241 poll_result->read_count = (msg[0] & 0x7f);
243 /* Remote Control Address (Reg 0x46) */
244 poll_result->rc_address = msg[1];
246 /* Remote Control Data (Reg 0x47) */
247 poll_result->rc_data[0] = msg[2];
252 static int em2874_polling_getkey(struct em28xx_IR *ir,
253 struct em28xx_ir_poll_result *poll_result)
255 struct em28xx *dev = ir->dev;
257 u8 msg[5] = { 0, 0, 0, 0, 0 };
259 /* Read key toggle, brand, and key code
262 rc = dev->em28xx_read_reg_req_len(dev, 0, EM2874_R51_IR,
267 /* Infrared toggle (Reg 0x51[7]) */
268 poll_result->toggle_bit = (msg[0] >> 7);
270 /* Infrared read count (Reg 0x51[6:0] */
271 poll_result->read_count = (msg[0] & 0x7f);
273 /* Remote Control Address (Reg 0x52) */
274 poll_result->rc_address = msg[1];
276 /* Remote Control Data (Reg 0x53-55) */
277 poll_result->rc_data[0] = msg[2];
278 poll_result->rc_data[1] = msg[3];
279 poll_result->rc_data[2] = msg[4];
284 /**********************************************************
285 Polling code for em28xx
286 **********************************************************/
288 static void em28xx_ir_handle_key(struct em28xx_IR *ir)
291 struct em28xx_ir_poll_result poll_result;
293 /* read the registers containing the IR status */
294 result = ir->get_key(ir, &poll_result);
295 if (unlikely(result < 0)) {
296 dprintk("ir->get_key() failed %d\n", result);
300 if (unlikely(poll_result.read_count != ir->last_readcount)) {
301 dprintk("%s: toggle: %d, count: %d, key 0x%02x%02x\n", __func__,
302 poll_result.toggle_bit, poll_result.read_count,
303 poll_result.rc_address, poll_result.rc_data[0]);
305 ir_keydown(ir->input,
306 poll_result.rc_address << 8 |
307 poll_result.rc_data[0],
308 poll_result.toggle_bit);
310 ir_keydown(ir->input,
311 poll_result.rc_data[0],
312 poll_result.toggle_bit);
314 if (ir->dev->chip_id == CHIP_ID_EM2874)
315 /* The em2874 clears the readcount field every time the
316 register is read. The em2860/2880 datasheet says that it
317 is supposed to clear the readcount, but it doesn't. So with
318 the em2874, we are looking for a non-zero read count as
319 opposed to a readcount that is incrementing */
320 ir->last_readcount = 0;
322 ir->last_readcount = poll_result.read_count;
326 static void em28xx_ir_work(struct work_struct *work)
328 struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work.work);
330 em28xx_ir_handle_key(ir);
331 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
334 static int em28xx_ir_start(void *priv)
336 struct em28xx_IR *ir = priv;
338 INIT_DELAYED_WORK(&ir->work, em28xx_ir_work);
339 schedule_delayed_work(&ir->work, 0);
344 static void em28xx_ir_stop(void *priv)
346 struct em28xx_IR *ir = priv;
348 cancel_delayed_work_sync(&ir->work);
351 int em28xx_ir_change_protocol(void *priv, u64 ir_type)
354 struct em28xx_IR *ir = priv;
355 struct em28xx *dev = ir->dev;
356 u8 ir_config = EM2874_IR_RC5;
358 /* Adjust xclk based o IR table for RC5/NEC tables */
360 if (ir_type == IR_TYPE_RC5) {
361 dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
363 } else if (ir_type == IR_TYPE_NEC) {
364 dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
365 ir_config = EM2874_IR_NEC;
367 } else if (ir_type != IR_TYPE_UNKNOWN)
370 em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
371 EM28XX_XCLK_IR_RC5_MODE);
373 /* Setup the proper handler based on the chip */
374 switch (dev->chip_id) {
377 ir->get_key = default_polling_getkey;
380 ir->get_key = em2874_polling_getkey;
381 em28xx_write_regs(dev, EM2874_R50_IR_CONFIG, &ir_config, 1);
384 printk("Unrecognized em28xx chip id: IR not supported\n");
391 int em28xx_ir_init(struct em28xx *dev)
393 struct em28xx_IR *ir;
394 struct input_dev *input_dev;
397 if (dev->board.ir_codes == NULL) {
398 /* No remote control support */
402 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
403 input_dev = input_allocate_device();
404 if (!ir || !input_dev)
407 /* record handles to ourself */
411 ir->input = input_dev;
414 * em2874 supports more protocols. For now, let's just announce
415 * the two protocols that were already tested
417 ir->props.allowed_protos = IR_TYPE_RC5 | IR_TYPE_NEC;
419 ir->props.change_protocol = em28xx_ir_change_protocol;
420 ir->props.open = em28xx_ir_start;
421 ir->props.close = em28xx_ir_stop;
423 /* By default, keep protocol field untouched */
424 err = em28xx_ir_change_protocol(ir, IR_TYPE_UNKNOWN);
428 /* This is how often we ask the chip for IR information */
429 ir->polling = 100; /* ms */
431 /* init input device */
432 snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)",
435 usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
436 strlcat(ir->phys, "/input0", sizeof(ir->phys));
438 input_dev->name = ir->name;
439 input_dev->phys = ir->phys;
440 input_dev->id.bustype = BUS_USB;
441 input_dev->id.version = 1;
442 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
443 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
445 input_dev->dev.parent = &dev->udev->dev;
450 err = ir_input_register(ir->input, dev->board.ir_codes,
451 &ir->props, MODULE_NAME);
463 int em28xx_ir_fini(struct em28xx *dev)
465 struct em28xx_IR *ir = dev->ir;
467 /* skip detach on non attached boards */
472 ir_input_unregister(ir->input);
480 /**********************************************************
481 Handle Webcam snapshot button
482 **********************************************************/
484 static void em28xx_query_sbutton(struct work_struct *work)
486 /* Poll the register and see if the button is depressed */
488 container_of(work, struct em28xx, sbutton_query_work.work);
491 ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);
493 if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
495 /* Button is depressed, clear the register */
496 cleared = ((u8) ret) & ~EM28XX_R0C_USBSUSP_SNAPSHOT;
497 em28xx_write_regs(dev, EM28XX_R0C_USBSUSP, &cleared, 1);
499 /* Not emulate the keypress */
500 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
502 /* Now unpress the key */
503 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
507 /* Schedule next poll */
508 schedule_delayed_work(&dev->sbutton_query_work,
509 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
512 void em28xx_register_snapshot_button(struct em28xx *dev)
514 struct input_dev *input_dev;
517 em28xx_info("Registering snapshot button...\n");
518 input_dev = input_allocate_device();
520 em28xx_errdev("input_allocate_device failed\n");
524 usb_make_path(dev->udev, dev->snapshot_button_path,
525 sizeof(dev->snapshot_button_path));
526 strlcat(dev->snapshot_button_path, "/sbutton",
527 sizeof(dev->snapshot_button_path));
528 INIT_DELAYED_WORK(&dev->sbutton_query_work, em28xx_query_sbutton);
530 input_dev->name = "em28xx snapshot button";
531 input_dev->phys = dev->snapshot_button_path;
532 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
533 set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
534 input_dev->keycodesize = 0;
535 input_dev->keycodemax = 0;
536 input_dev->id.bustype = BUS_USB;
537 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
538 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
539 input_dev->id.version = 1;
540 input_dev->dev.parent = &dev->udev->dev;
542 err = input_register_device(input_dev);
544 em28xx_errdev("input_register_device failed\n");
545 input_free_device(input_dev);
549 dev->sbutton_input_dev = input_dev;
550 schedule_delayed_work(&dev->sbutton_query_work,
551 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
556 void em28xx_deregister_snapshot_button(struct em28xx *dev)
558 if (dev->sbutton_input_dev != NULL) {
559 em28xx_info("Deregistering snapshot button\n");
560 cancel_rearming_delayed_work(&dev->sbutton_query_work);
561 input_unregister_device(dev->sbutton_input_dev);
562 dev->sbutton_input_dev = NULL;