1 /*
2   handle em28xx IR remotes via linux kernel input layer.
3 
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>
8 
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.
13 
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.
18 
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
22  */
23 
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>
30 
31 #include "em28xx.h"
32 
33 #define EM28XX_SNAPSHOT_KEY				KEY_CAMERA
34 #define EM28XX_BUTTONS_DEBOUNCED_QUERY_INTERVAL		500 /* [ms] */
35 #define EM28XX_BUTTONS_VOLATILE_QUERY_INTERVAL		100 /* [ms] */
36 
37 static unsigned int ir_debug;
38 module_param(ir_debug, int, 0644);
39 MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
40 
41 #define MODULE_NAME "em28xx"
42 
43 #define dprintk(fmt, arg...) \
44 	if (ir_debug) { \
45 		printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
46 	}
47 
48 /**********************************************************
49  Polling structure used by em28xx IR's
50  **********************************************************/
51 
52 struct em28xx_ir_poll_result {
53 	unsigned int toggle_bit:1;
54 	unsigned int read_count:7;
55 
56 	u32 scancode;
57 };
58 
59 struct em28xx_IR {
60 	struct em28xx *dev;
61 	struct rc_dev *rc;
62 	char name[32];
63 	char phys[32];
64 
65 	/* poll decoder */
66 	int polling;
67 	struct delayed_work work;
68 	unsigned int full_code:1;
69 	unsigned int last_readcount;
70 	u64 rc_type;
71 
72 	/* i2c slave address of external device (if used) */
73 	u16 i2c_dev_addr;
74 
75 	int  (*get_key_i2c)(struct i2c_client *, u32 *);
76 	int  (*get_key)(struct em28xx_IR *, struct em28xx_ir_poll_result *);
77 };
78 
79 /**********************************************************
80  I2C IR based get keycodes - should be used with ir-kbd-i2c
81  **********************************************************/
82 
83 static int em28xx_get_key_terratec(struct i2c_client *i2c_dev, u32 *ir_key)
84 {
85 	unsigned char b;
86 
87 	/* poll IR chip */
88 	if (1 != i2c_master_recv(i2c_dev, &b, 1))
89 		return -EIO;
90 
91 	/* it seems that 0xFE indicates that a button is still hold
92 	   down, while 0xff indicates that no button is hold down. */
93 
94 	if (b == 0xff)
95 		return 0;
96 
97 	if (b == 0xfe)
98 		/* keep old data */
99 		return 1;
100 
101 	*ir_key = b;
102 	return 1;
103 }
104 
105 static int em28xx_get_key_em_haup(struct i2c_client *i2c_dev, u32 *ir_key)
106 {
107 	unsigned char buf[2];
108 	u16 code;
109 	int size;
110 
111 	/* poll IR chip */
112 	size = i2c_master_recv(i2c_dev, buf, sizeof(buf));
113 
114 	if (size != 2)
115 		return -EIO;
116 
117 	/* Does eliminate repeated parity code */
118 	if (buf[1] == 0xff)
119 		return 0;
120 
121 	/*
122 	 * Rearranges bits to the right order.
123 	 * The bit order were determined experimentally by using
124 	 * The original Hauppauge Grey IR and another RC5 that uses addr=0x08
125 	 * The RC5 code has 14 bits, but we've experimentally determined
126 	 * the meaning for only 11 bits.
127 	 * So, the code translation is not complete. Yet, it is enough to
128 	 * work with the provided RC5 IR.
129 	 */
130 	code =
131 		 ((buf[0] & 0x01) ? 0x0020 : 0) | /* 		0010 0000 */
132 		 ((buf[0] & 0x02) ? 0x0010 : 0) | /* 		0001 0000 */
133 		 ((buf[0] & 0x04) ? 0x0008 : 0) | /* 		0000 1000 */
134 		 ((buf[0] & 0x08) ? 0x0004 : 0) | /* 		0000 0100 */
135 		 ((buf[0] & 0x10) ? 0x0002 : 0) | /* 		0000 0010 */
136 		 ((buf[0] & 0x20) ? 0x0001 : 0) | /* 		0000 0001 */
137 		 ((buf[1] & 0x08) ? 0x1000 : 0) | /* 0001 0000		  */
138 		 ((buf[1] & 0x10) ? 0x0800 : 0) | /* 0000 1000		  */
139 		 ((buf[1] & 0x20) ? 0x0400 : 0) | /* 0000 0100		  */
140 		 ((buf[1] & 0x40) ? 0x0200 : 0) | /* 0000 0010		  */
141 		 ((buf[1] & 0x80) ? 0x0100 : 0);  /* 0000 0001		  */
142 
143 	/* return key */
144 	*ir_key = code;
145 	return 1;
146 }
147 
148 static int em28xx_get_key_pinnacle_usb_grey(struct i2c_client *i2c_dev,
149 					    u32 *ir_key)
150 {
151 	unsigned char buf[3];
152 
153 	/* poll IR chip */
154 
155 	if (3 != i2c_master_recv(i2c_dev, buf, 3))
156 		return -EIO;
157 
158 	if (buf[0] != 0x00)
159 		return 0;
160 
161 	*ir_key = buf[2]&0x3f;
162 
163 	return 1;
164 }
165 
166 static int em28xx_get_key_winfast_usbii_deluxe(struct i2c_client *i2c_dev,
167 					       u32 *ir_key)
168 {
169 	unsigned char subaddr, keydetect, key;
170 
171 	struct i2c_msg msg[] = { { .addr = i2c_dev->addr, .flags = 0, .buf = &subaddr, .len = 1},
172 				 { .addr = i2c_dev->addr, .flags = I2C_M_RD, .buf = &keydetect, .len = 1} };
173 
174 	subaddr = 0x10;
175 	if (2 != i2c_transfer(i2c_dev->adapter, msg, 2))
176 		return -EIO;
177 	if (keydetect == 0x00)
178 		return 0;
179 
180 	subaddr = 0x00;
181 	msg[1].buf = &key;
182 	if (2 != i2c_transfer(i2c_dev->adapter, msg, 2))
183 		return -EIO;
184 	if (key == 0x00)
185 		return 0;
186 
187 	*ir_key = key;
188 	return 1;
189 }
190 
191 /**********************************************************
192  Poll based get keycode functions
193  **********************************************************/
194 
195 /* This is for the em2860/em2880 */
196 static int default_polling_getkey(struct em28xx_IR *ir,
197 				  struct em28xx_ir_poll_result *poll_result)
198 {
199 	struct em28xx *dev = ir->dev;
200 	int rc;
201 	u8 msg[3] = { 0, 0, 0 };
202 
203 	/* Read key toggle, brand, and key code
204 	   on registers 0x45, 0x46 and 0x47
205 	 */
206 	rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
207 					  msg, sizeof(msg));
208 	if (rc < 0)
209 		return rc;
210 
211 	/* Infrared toggle (Reg 0x45[7]) */
212 	poll_result->toggle_bit = (msg[0] >> 7);
213 
214 	/* Infrared read count (Reg 0x45[6:0] */
215 	poll_result->read_count = (msg[0] & 0x7f);
216 
217 	/* Remote Control Address/Data (Regs 0x46/0x47) */
218 	poll_result->scancode = msg[1] << 8 | msg[2];
219 
220 	return 0;
221 }
222 
223 static int em2874_polling_getkey(struct em28xx_IR *ir,
224 				 struct em28xx_ir_poll_result *poll_result)
225 {
226 	struct em28xx *dev = ir->dev;
227 	int rc;
228 	u8 msg[5] = { 0, 0, 0, 0, 0 };
229 
230 	/* Read key toggle, brand, and key code
231 	   on registers 0x51-55
232 	 */
233 	rc = dev->em28xx_read_reg_req_len(dev, 0, EM2874_R51_IR,
234 					  msg, sizeof(msg));
235 	if (rc < 0)
236 		return rc;
237 
238 	/* Infrared toggle (Reg 0x51[7]) */
239 	poll_result->toggle_bit = (msg[0] >> 7);
240 
241 	/* Infrared read count (Reg 0x51[6:0] */
242 	poll_result->read_count = (msg[0] & 0x7f);
243 
244 	/*
245 	 * Remote Control Address (Reg 0x52)
246 	 * Remote Control Data (Reg 0x53-0x55)
247 	 */
248 	switch (ir->rc_type) {
249 	case RC_BIT_RC5:
250 		poll_result->scancode = msg[1] << 8 | msg[2];
251 		break;
252 	case RC_BIT_NEC:
253 		if ((msg[3] ^ msg[4]) != 0xff)		/* 32 bits NEC */
254 			poll_result->scancode = (msg[1] << 24) |
255 						(msg[2] << 16) |
256 						(msg[3] << 8)  |
257 						 msg[4];
258 		else if ((msg[1] ^ msg[2]) != 0xff)	/* 24 bits NEC */
259 			poll_result->scancode = (msg[1] << 16) |
260 						(msg[2] << 8)  |
261 						 msg[3];
262 		else					/* Normal NEC */
263 			poll_result->scancode = msg[1] << 8 | msg[3];
264 		break;
265 	case RC_BIT_RC6_0:
266 		poll_result->scancode = msg[1] << 8 | msg[2];
267 		break;
268 	default:
269 		poll_result->scancode = (msg[1] << 24) | (msg[2] << 16) |
270 					(msg[3] << 8)  | msg[4];
271 		break;
272 	}
273 
274 	return 0;
275 }
276 
277 /**********************************************************
278  Polling code for em28xx
279  **********************************************************/
280 
281 static int em28xx_i2c_ir_handle_key(struct em28xx_IR *ir)
282 {
283 	struct em28xx *dev = ir->dev;
284 	static u32 ir_key;
285 	int rc;
286 	struct i2c_client client;
287 
288 	client.adapter = &ir->dev->i2c_adap[dev->def_i2c_bus];
289 	client.addr = ir->i2c_dev_addr;
290 
291 	rc = ir->get_key_i2c(&client, &ir_key);
292 	if (rc < 0) {
293 		dprintk("ir->get_key_i2c() failed: %d\n", rc);
294 		return rc;
295 	}
296 
297 	if (rc) {
298 		dprintk("%s: keycode = 0x%04x\n", __func__, ir_key);
299 		rc_keydown(ir->rc, ir_key, 0);
300 	}
301 	return 0;
302 }
303 
304 static void em28xx_ir_handle_key(struct em28xx_IR *ir)
305 {
306 	int result;
307 	struct em28xx_ir_poll_result poll_result;
308 
309 	/* read the registers containing the IR status */
310 	result = ir->get_key(ir, &poll_result);
311 	if (unlikely(result < 0)) {
312 		dprintk("ir->get_key() failed: %d\n", result);
313 		return;
314 	}
315 
316 	if (unlikely(poll_result.read_count != ir->last_readcount)) {
317 		dprintk("%s: toggle: %d, count: %d, key 0x%04x\n", __func__,
318 			poll_result.toggle_bit, poll_result.read_count,
319 			poll_result.scancode);
320 		if (ir->full_code)
321 			rc_keydown(ir->rc,
322 				   poll_result.scancode,
323 				   poll_result.toggle_bit);
324 		else
325 			rc_keydown(ir->rc,
326 				   poll_result.scancode & 0xff,
327 				   poll_result.toggle_bit);
328 
329 		if (ir->dev->chip_id == CHIP_ID_EM2874 ||
330 		    ir->dev->chip_id == CHIP_ID_EM2884)
331 			/* The em2874 clears the readcount field every time the
332 			   register is read.  The em2860/2880 datasheet says that it
333 			   is supposed to clear the readcount, but it doesn't.  So with
334 			   the em2874, we are looking for a non-zero read count as
335 			   opposed to a readcount that is incrementing */
336 			ir->last_readcount = 0;
337 		else
338 			ir->last_readcount = poll_result.read_count;
339 	}
340 }
341 
342 static void em28xx_ir_work(struct work_struct *work)
343 {
344 	struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work.work);
345 
346 	if (ir->i2c_dev_addr) /* external i2c device */
347 		em28xx_i2c_ir_handle_key(ir);
348 	else /* internal device */
349 		em28xx_ir_handle_key(ir);
350 	schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
351 }
352 
353 static int em28xx_ir_start(struct rc_dev *rc)
354 {
355 	struct em28xx_IR *ir = rc->priv;
356 
357 	INIT_DELAYED_WORK(&ir->work, em28xx_ir_work);
358 	schedule_delayed_work(&ir->work, 0);
359 
360 	return 0;
361 }
362 
363 static void em28xx_ir_stop(struct rc_dev *rc)
364 {
365 	struct em28xx_IR *ir = rc->priv;
366 
367 	cancel_delayed_work_sync(&ir->work);
368 }
369 
370 static int em2860_ir_change_protocol(struct rc_dev *rc_dev, u64 *rc_type)
371 {
372 	struct em28xx_IR *ir = rc_dev->priv;
373 	struct em28xx *dev = ir->dev;
374 
375 	/* Adjust xclk based on IR table for RC5/NEC tables */
376 	if (*rc_type & RC_BIT_RC5) {
377 		dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
378 		ir->full_code = 1;
379 		*rc_type = RC_BIT_RC5;
380 	} else if (*rc_type & RC_BIT_NEC) {
381 		dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
382 		ir->full_code = 1;
383 		*rc_type = RC_BIT_NEC;
384 	} else if (*rc_type & RC_BIT_UNKNOWN) {
385 		*rc_type = RC_BIT_UNKNOWN;
386 	} else {
387 		*rc_type = ir->rc_type;
388 		return -EINVAL;
389 	}
390 	em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
391 			      EM28XX_XCLK_IR_RC5_MODE);
392 
393 	ir->rc_type = *rc_type;
394 
395 	return 0;
396 }
397 
398 static int em2874_ir_change_protocol(struct rc_dev *rc_dev, u64 *rc_type)
399 {
400 	struct em28xx_IR *ir = rc_dev->priv;
401 	struct em28xx *dev = ir->dev;
402 	u8 ir_config = EM2874_IR_RC5;
403 
404 	/* Adjust xclk and set type based on IR table for RC5/NEC/RC6 tables */
405 	if (*rc_type & RC_BIT_RC5) {
406 		dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
407 		ir->full_code = 1;
408 		*rc_type = RC_BIT_RC5;
409 	} else if (*rc_type & RC_BIT_NEC) {
410 		dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
411 		ir_config = EM2874_IR_NEC | EM2874_IR_NEC_NO_PARITY;
412 		ir->full_code = 1;
413 		*rc_type = RC_BIT_NEC;
414 	} else if (*rc_type & RC_BIT_RC6_0) {
415 		dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
416 		ir_config = EM2874_IR_RC6_MODE_0;
417 		ir->full_code = 1;
418 		*rc_type = RC_BIT_RC6_0;
419 	} else if (*rc_type & RC_BIT_UNKNOWN) {
420 		*rc_type = RC_BIT_UNKNOWN;
421 	} else {
422 		*rc_type = ir->rc_type;
423 		return -EINVAL;
424 	}
425 	em28xx_write_regs(dev, EM2874_R50_IR_CONFIG, &ir_config, 1);
426 	em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
427 			      EM28XX_XCLK_IR_RC5_MODE);
428 
429 	ir->rc_type = *rc_type;
430 
431 	return 0;
432 }
433 static int em28xx_ir_change_protocol(struct rc_dev *rc_dev, u64 *rc_type)
434 {
435 	struct em28xx_IR *ir = rc_dev->priv;
436 	struct em28xx *dev = ir->dev;
437 
438 	/* Setup the proper handler based on the chip */
439 	switch (dev->chip_id) {
440 	case CHIP_ID_EM2860:
441 	case CHIP_ID_EM2883:
442 		return em2860_ir_change_protocol(rc_dev, rc_type);
443 	case CHIP_ID_EM2884:
444 	case CHIP_ID_EM2874:
445 	case CHIP_ID_EM28174:
446 	case CHIP_ID_EM28178:
447 		return em2874_ir_change_protocol(rc_dev, rc_type);
448 	default:
449 		printk("Unrecognized em28xx chip id 0x%02x: IR not supported\n",
450 			dev->chip_id);
451 		return -EINVAL;
452 	}
453 }
454 
455 static int em28xx_probe_i2c_ir(struct em28xx *dev)
456 {
457 	int i = 0;
458 	/* Leadtek winfast tv USBII deluxe can find a non working IR-device */
459 	/* at address 0x18, so if that address is needed for another board in */
460 	/* the future, please put it after 0x1f. */
461 	const unsigned short addr_list[] = {
462 		 0x1f, 0x30, 0x47, I2C_CLIENT_END
463 	};
464 
465 	while (addr_list[i] != I2C_CLIENT_END) {
466 		if (i2c_probe_func_quick_read(&dev->i2c_adap[dev->def_i2c_bus], addr_list[i]) == 1)
467 			return addr_list[i];
468 		i++;
469 	}
470 
471 	return -ENODEV;
472 }
473 
474 /**********************************************************
475  Handle buttons
476  **********************************************************/
477 
478 static void em28xx_query_buttons(struct work_struct *work)
479 {
480 	struct em28xx *dev =
481 		container_of(work, struct em28xx, buttons_query_work.work);
482 	u8 i, j;
483 	int regval;
484 	bool is_pressed, was_pressed;
485 	const struct em28xx_led *led;
486 
487 	/* Poll and evaluate all addresses */
488 	for (i = 0; i < dev->num_button_polling_addresses; i++) {
489 		/* Read value from register */
490 		regval = em28xx_read_reg(dev, dev->button_polling_addresses[i]);
491 		if (regval < 0)
492 			continue;
493 		/* Check states of the buttons and act */
494 		j = 0;
495 		while (dev->board.buttons[j].role >= 0 &&
496 			 dev->board.buttons[j].role < EM28XX_NUM_BUTTON_ROLES) {
497 			struct em28xx_button *button = &dev->board.buttons[j];
498 			/* Check if button uses the current address */
499 			if (button->reg_r != dev->button_polling_addresses[i]) {
500 				j++;
501 				continue;
502 			}
503 			/* Determine if button is and was pressed last time */
504 			is_pressed = regval & button->mask;
505 			was_pressed = dev->button_polling_last_values[i]
506 				       & button->mask;
507 			if (button->inverted) {
508 				is_pressed = !is_pressed;
509 				was_pressed = !was_pressed;
510 			}
511 			/* Clear button state (if needed) */
512 			if (is_pressed && button->reg_clearing)
513 				em28xx_write_reg(dev, button->reg_clearing,
514 						 (~regval & button->mask)
515 						    | (regval & ~button->mask));
516 			/* Handle button state */
517 			if (!is_pressed || was_pressed) {
518 				j++;
519 				continue;
520 			}
521 			switch (button->role) {
522 			case EM28XX_BUTTON_SNAPSHOT:
523 				/* Emulate the keypress */
524 				input_report_key(dev->sbutton_input_dev,
525 						 EM28XX_SNAPSHOT_KEY, 1);
526 				/* Unpress the key */
527 				input_report_key(dev->sbutton_input_dev,
528 						 EM28XX_SNAPSHOT_KEY, 0);
529 				break;
530 			case EM28XX_BUTTON_ILLUMINATION:
531 				led = em28xx_find_led(dev,
532 						      EM28XX_LED_ILLUMINATION);
533 				/* Switch illumination LED on/off */
534 				if (led)
535 					em28xx_toggle_reg_bits(dev,
536 							       led->gpio_reg,
537 							       led->gpio_mask);
538 				break;
539 			default:
540 				WARN_ONCE(1, "BUG: unhandled button role.");
541 			}
542 			/* Next button */
543 			j++;
544 		}
545 		/* Save current value for comparison during the next polling */
546 		dev->button_polling_last_values[i] = regval;
547 	}
548 	/* Schedule next poll */
549 	schedule_delayed_work(&dev->buttons_query_work,
550 			      msecs_to_jiffies(dev->button_polling_interval));
551 }
552 
553 static int em28xx_register_snapshot_button(struct em28xx *dev)
554 {
555 	struct input_dev *input_dev;
556 	int err;
557 
558 	em28xx_info("Registering snapshot button...\n");
559 	input_dev = input_allocate_device();
560 	if (!input_dev)
561 		return -ENOMEM;
562 
563 	usb_make_path(dev->udev, dev->snapshot_button_path,
564 		      sizeof(dev->snapshot_button_path));
565 	strlcat(dev->snapshot_button_path, "/sbutton",
566 		sizeof(dev->snapshot_button_path));
567 
568 	input_dev->name = "em28xx snapshot button";
569 	input_dev->phys = dev->snapshot_button_path;
570 	input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
571 	set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
572 	input_dev->keycodesize = 0;
573 	input_dev->keycodemax = 0;
574 	input_dev->id.bustype = BUS_USB;
575 	input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
576 	input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
577 	input_dev->id.version = 1;
578 	input_dev->dev.parent = &dev->udev->dev;
579 
580 	err = input_register_device(input_dev);
581 	if (err) {
582 		em28xx_errdev("input_register_device failed\n");
583 		input_free_device(input_dev);
584 		return err;
585 	}
586 
587 	dev->sbutton_input_dev = input_dev;
588 	return 0;
589 }
590 
591 static void em28xx_init_buttons(struct em28xx *dev)
592 {
593 	u8  i = 0, j = 0;
594 	bool addr_new = 0;
595 
596 	dev->button_polling_interval = EM28XX_BUTTONS_DEBOUNCED_QUERY_INTERVAL;
597 	while (dev->board.buttons[i].role >= 0 &&
598 			 dev->board.buttons[i].role < EM28XX_NUM_BUTTON_ROLES) {
599 		struct em28xx_button *button = &dev->board.buttons[i];
600 		/* Check if polling address is already on the list */
601 		addr_new = 1;
602 		for (j = 0; j < dev->num_button_polling_addresses; j++) {
603 			if (button->reg_r == dev->button_polling_addresses[j]) {
604 				addr_new = 0;
605 				break;
606 			}
607 		}
608 		/* Check if max. number of polling addresses is exceeded */
609 		if (addr_new && dev->num_button_polling_addresses
610 					   >= EM28XX_NUM_BUTTON_ADDRESSES_MAX) {
611 			WARN_ONCE(1, "BUG: maximum number of button polling addresses exceeded.");
612 			goto next_button;
613 		}
614 		/* Button role specific checks and actions */
615 		if (button->role == EM28XX_BUTTON_SNAPSHOT) {
616 			/* Register input device */
617 			if (em28xx_register_snapshot_button(dev) < 0)
618 				goto next_button;
619 		} else if (button->role == EM28XX_BUTTON_ILLUMINATION) {
620 			/* Check sanity */
621 			if (!em28xx_find_led(dev, EM28XX_LED_ILLUMINATION)) {
622 				em28xx_errdev("BUG: illumination button defined, but no illumination LED.\n");
623 				goto next_button;
624 			}
625 		}
626 		/* Add read address to list of polling addresses */
627 		if (addr_new) {
628 			unsigned int index = dev->num_button_polling_addresses;
629 			dev->button_polling_addresses[index] = button->reg_r;
630 			dev->num_button_polling_addresses++;
631 		}
632 		/* Reduce polling interval if necessary */
633 		if (!button->reg_clearing)
634 			dev->button_polling_interval =
635 					 EM28XX_BUTTONS_VOLATILE_QUERY_INTERVAL;
636 next_button:
637 		/* Next button */
638 		i++;
639 	}
640 
641 	/* Start polling */
642 	if (dev->num_button_polling_addresses) {
643 		memset(dev->button_polling_last_values, 0,
644 					       EM28XX_NUM_BUTTON_ADDRESSES_MAX);
645 		INIT_DELAYED_WORK(&dev->buttons_query_work,
646 							  em28xx_query_buttons);
647 		schedule_delayed_work(&dev->buttons_query_work,
648 			       msecs_to_jiffies(dev->button_polling_interval));
649 	}
650 }
651 
652 static void em28xx_shutdown_buttons(struct em28xx *dev)
653 {
654 	/* Cancel polling */
655 	cancel_delayed_work_sync(&dev->buttons_query_work);
656 	/* Clear polling addresses list */
657 	dev->num_button_polling_addresses = 0;
658 	/* Deregister input devices */
659 	if (dev->sbutton_input_dev != NULL) {
660 		em28xx_info("Deregistering snapshot button\n");
661 		input_unregister_device(dev->sbutton_input_dev);
662 		dev->sbutton_input_dev = NULL;
663 	}
664 }
665 
666 static int em28xx_ir_init(struct em28xx *dev)
667 {
668 	struct em28xx_IR *ir;
669 	struct rc_dev *rc;
670 	int err = -ENOMEM;
671 	u64 rc_type;
672 	u16 i2c_rc_dev_addr = 0;
673 
674 	if (dev->is_audio_only) {
675 		/* Shouldn't initialize IR for this interface */
676 		return 0;
677 	}
678 
679 	kref_get(&dev->ref);
680 
681 	if (dev->board.buttons)
682 		em28xx_init_buttons(dev);
683 
684 	if (dev->board.has_ir_i2c) {
685 		i2c_rc_dev_addr = em28xx_probe_i2c_ir(dev);
686 		if (!i2c_rc_dev_addr) {
687 			dev->board.has_ir_i2c = 0;
688 			em28xx_warn("No i2c IR remote control device found.\n");
689 			return -ENODEV;
690 		}
691 	}
692 
693 	if (dev->board.ir_codes == NULL && !dev->board.has_ir_i2c) {
694 		/* No remote control support */
695 		em28xx_warn("Remote control support is not available for "
696 				"this card.\n");
697 		return 0;
698 	}
699 
700 	em28xx_info("Registering input extension\n");
701 
702 	ir = kzalloc(sizeof(*ir), GFP_KERNEL);
703 	rc = rc_allocate_device();
704 	if (!ir || !rc)
705 		goto error;
706 
707 	/* record handles to ourself */
708 	ir->dev = dev;
709 	dev->ir = ir;
710 	ir->rc = rc;
711 
712 	rc->priv = ir;
713 	rc->open = em28xx_ir_start;
714 	rc->close = em28xx_ir_stop;
715 
716 	if (dev->board.has_ir_i2c) {	/* external i2c device */
717 		switch (dev->model) {
718 		case EM2800_BOARD_TERRATEC_CINERGY_200:
719 		case EM2820_BOARD_TERRATEC_CINERGY_250:
720 			rc->map_name = RC_MAP_EM_TERRATEC;
721 			ir->get_key_i2c = em28xx_get_key_terratec;
722 			break;
723 		case EM2820_BOARD_PINNACLE_USB_2:
724 			rc->map_name = RC_MAP_PINNACLE_GREY;
725 			ir->get_key_i2c = em28xx_get_key_pinnacle_usb_grey;
726 			break;
727 		case EM2820_BOARD_HAUPPAUGE_WINTV_USB_2:
728 			rc->map_name = RC_MAP_HAUPPAUGE;
729 			ir->get_key_i2c = em28xx_get_key_em_haup;
730 			rc_set_allowed_protocols(rc, RC_BIT_RC5);
731 			break;
732 		case EM2820_BOARD_LEADTEK_WINFAST_USBII_DELUXE:
733 			rc->map_name = RC_MAP_WINFAST_USBII_DELUXE;
734 			ir->get_key_i2c = em28xx_get_key_winfast_usbii_deluxe;
735 			break;
736 		default:
737 			err = -ENODEV;
738 			goto error;
739 		}
740 
741 		ir->i2c_dev_addr = i2c_rc_dev_addr;
742 	} else {	/* internal device */
743 		switch (dev->chip_id) {
744 		case CHIP_ID_EM2860:
745 		case CHIP_ID_EM2883:
746 			rc_set_allowed_protocols(rc, RC_BIT_RC5 | RC_BIT_NEC);
747 			ir->get_key = default_polling_getkey;
748 			break;
749 		case CHIP_ID_EM2884:
750 		case CHIP_ID_EM2874:
751 		case CHIP_ID_EM28174:
752 		case CHIP_ID_EM28178:
753 			ir->get_key = em2874_polling_getkey;
754 			rc_set_allowed_protocols(rc, RC_BIT_RC5 | RC_BIT_NEC |
755 						 RC_BIT_RC6_0);
756 			break;
757 		default:
758 			err = -ENODEV;
759 			goto error;
760 		}
761 
762 		rc->change_protocol = em28xx_ir_change_protocol;
763 		rc->map_name = dev->board.ir_codes;
764 
765 		/* By default, keep protocol field untouched */
766 		rc_type = RC_BIT_UNKNOWN;
767 		err = em28xx_ir_change_protocol(rc, &rc_type);
768 		if (err)
769 			goto error;
770 	}
771 
772 	/* This is how often we ask the chip for IR information */
773 	ir->polling = 100; /* ms */
774 
775 	/* init input device */
776 	snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)", dev->name);
777 
778 	usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
779 	strlcat(ir->phys, "/input0", sizeof(ir->phys));
780 
781 	rc->input_name = ir->name;
782 	rc->input_phys = ir->phys;
783 	rc->input_id.bustype = BUS_USB;
784 	rc->input_id.version = 1;
785 	rc->input_id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
786 	rc->input_id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
787 	rc->dev.parent = &dev->udev->dev;
788 	rc->driver_name = MODULE_NAME;
789 
790 	/* all done */
791 	err = rc_register_device(rc);
792 	if (err)
793 		goto error;
794 
795 	em28xx_info("Input extension successfully initalized\n");
796 
797 	return 0;
798 
799 error:
800 	dev->ir = NULL;
801 	rc_free_device(rc);
802 	kfree(ir);
803 	return err;
804 }
805 
806 static int em28xx_ir_fini(struct em28xx *dev)
807 {
808 	struct em28xx_IR *ir = dev->ir;
809 
810 	if (dev->is_audio_only) {
811 		/* Shouldn't initialize IR for this interface */
812 		return 0;
813 	}
814 
815 	em28xx_info("Closing input extension");
816 
817 	em28xx_shutdown_buttons(dev);
818 
819 	/* skip detach on non attached boards */
820 	if (!ir)
821 		goto ref_put;
822 
823 	if (ir->rc)
824 		rc_unregister_device(ir->rc);
825 
826 	/* done */
827 	kfree(ir);
828 	dev->ir = NULL;
829 
830 ref_put:
831 	kref_put(&dev->ref, em28xx_free_device);
832 
833 	return 0;
834 }
835 
836 static int em28xx_ir_suspend(struct em28xx *dev)
837 {
838 	struct em28xx_IR *ir = dev->ir;
839 
840 	if (dev->is_audio_only)
841 		return 0;
842 
843 	em28xx_info("Suspending input extension");
844 	if (ir)
845 		cancel_delayed_work_sync(&ir->work);
846 	cancel_delayed_work_sync(&dev->buttons_query_work);
847 	/* is canceling delayed work sufficient or does the rc event
848 	   kthread needs stopping? kthread is stopped in
849 	   ir_raw_event_unregister() */
850 	return 0;
851 }
852 
853 static int em28xx_ir_resume(struct em28xx *dev)
854 {
855 	struct em28xx_IR *ir = dev->ir;
856 
857 	if (dev->is_audio_only)
858 		return 0;
859 
860 	em28xx_info("Resuming input extension");
861 	/* if suspend calls ir_raw_event_unregister(), the should call
862 	   ir_raw_event_register() */
863 	if (ir)
864 		schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
865 	if (dev->num_button_polling_addresses)
866 		schedule_delayed_work(&dev->buttons_query_work,
867 			       msecs_to_jiffies(dev->button_polling_interval));
868 	return 0;
869 }
870 
871 static struct em28xx_ops rc_ops = {
872 	.id   = EM28XX_RC,
873 	.name = "Em28xx Input Extension",
874 	.init = em28xx_ir_init,
875 	.fini = em28xx_ir_fini,
876 	.suspend = em28xx_ir_suspend,
877 	.resume = em28xx_ir_resume,
878 };
879 
880 static int __init em28xx_rc_register(void)
881 {
882 	return em28xx_register_extension(&rc_ops);
883 }
884 
885 static void __exit em28xx_rc_unregister(void)
886 {
887 	em28xx_unregister_extension(&rc_ops);
888 }
889 
890 MODULE_LICENSE("GPL");
891 MODULE_AUTHOR("Mauro Carvalho Chehab");
892 MODULE_DESCRIPTION(DRIVER_DESC " - input interface");
893 MODULE_VERSION(EM28XX_VERSION);
894 
895 module_init(em28xx_rc_register);
896 module_exit(em28xx_rc_unregister);
897