3 * Copyright (c) 2003 Gerd Knorr
4 * Copyright (c) 2003 Pavel Machek
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 #include <linux/module.h>
20 #include <linux/init.h>
21 #include <linux/delay.h>
22 #include <linux/interrupt.h>
23 #include <linux/input.h>
24 #include <linux/slab.h>
31 module_param(ir_debug
, int, 0644);
33 static int ir_rc5_remote_gap
= 885;
34 module_param(ir_rc5_remote_gap
, int, 0644);
37 #define dprintk(fmt, ...) \
40 pr_info(fmt, ##__VA_ARGS__); \
43 #define DEVNAME "bttv-input"
45 #define MODULE_NAME "bttv"
47 /* ---------------------------------------------------------------------- */
49 static void ir_handle_key(struct bttv
*btv
)
51 struct bttv_ir
*ir
= btv
->remote
;
55 gpio
= bttv_gpio_read(&btv
->c
);
57 if (ir
->last_gpio
== gpio
)
63 data
= ir_extract_bits(gpio
, ir
->mask_keycode
);
64 dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
66 ir
->polling
? "poll" : "irq",
67 (gpio
& ir
->mask_keydown
) ? " down" : "",
68 (gpio
& ir
->mask_keyup
) ? " up" : "");
70 if ((ir
->mask_keydown
&& (gpio
& ir
->mask_keydown
)) ||
71 (ir
->mask_keyup
&& !(gpio
& ir
->mask_keyup
))) {
72 rc_keydown_notimeout(ir
->dev
, RC_TYPE_UNKNOWN
, data
, 0);
74 /* HACK: Probably, ir->mask_keydown is missing
76 if (btv
->c
.type
== BTTV_BOARD_WINFAST2000
)
77 rc_keydown_notimeout(ir
->dev
, RC_TYPE_UNKNOWN
, data
, 0);
83 static void ir_enltv_handle_key(struct bttv
*btv
)
85 struct bttv_ir
*ir
= btv
->remote
;
86 u32 gpio
, data
, keyup
;
89 gpio
= bttv_gpio_read(&btv
->c
);
92 data
= ir_extract_bits(gpio
, ir
->mask_keycode
);
94 /* Check if it is keyup */
95 keyup
= (gpio
& ir
->mask_keyup
) ? 1 << 31 : 0;
97 if ((ir
->last_gpio
& 0x7f) != data
) {
98 dprintk("gpio=0x%x code=%d | %s\n",
100 (gpio
& ir
->mask_keyup
) ? " up" : "up/down");
102 rc_keydown_notimeout(ir
->dev
, RC_TYPE_UNKNOWN
, data
, 0);
106 if ((ir
->last_gpio
& 1 << 31) == keyup
)
109 dprintk("(cnt) gpio=0x%x code=%d | %s\n",
111 (gpio
& ir
->mask_keyup
) ? " up" : "down");
116 rc_keydown_notimeout(ir
->dev
, RC_TYPE_UNKNOWN
, data
, 0);
119 ir
->last_gpio
= data
| keyup
;
122 static int bttv_rc5_irq(struct bttv
*btv
);
124 void bttv_input_irq(struct bttv
*btv
)
126 struct bttv_ir
*ir
= btv
->remote
;
130 else if (!ir
->polling
)
134 static void bttv_input_timer(unsigned long data
)
136 struct bttv
*btv
= (struct bttv
*)data
;
137 struct bttv_ir
*ir
= btv
->remote
;
139 if (btv
->c
.type
== BTTV_BOARD_ENLTV_FM_2
)
140 ir_enltv_handle_key(btv
);
143 mod_timer(&ir
->timer
, jiffies
+ msecs_to_jiffies(ir
->polling
));
147 * FIXME: Nebula digi uses the legacy way to decode RC5, instead of relying
148 * on the rc-core way. As we need to be sure that both IRQ transitions are
149 * properly triggered, Better to touch it only with this hardware for
153 #define RC5_START(x) (((x) >> 12) & 0x03)
154 #define RC5_TOGGLE(x) (((x) >> 11) & 0x01)
155 #define RC5_ADDR(x) (((x) >> 6) & 0x1f)
156 #define RC5_INSTR(x) (((x) >> 0) & 0x3f)
158 /* decode raw bit pattern to RC5 code */
159 static u32
bttv_rc5_decode(unsigned int code
)
161 unsigned int org_code
= code
;
163 unsigned int rc5
= 0;
166 for (i
= 0; i
< 14; ++i
) {
179 dprintk("rc5_decode(%x) bad code\n",
184 dprintk("code=%x, rc5=%x, start=%x, toggle=%x, address=%x, instr=%x\n",
185 rc5
, org_code
, RC5_START(rc5
),
186 RC5_TOGGLE(rc5
), RC5_ADDR(rc5
), RC5_INSTR(rc5
));
190 static void bttv_rc5_timer_end(unsigned long data
)
192 struct bttv_ir
*ir
= (struct bttv_ir
*)data
;
194 u32 gap
, rc5
, scancode
;
195 u8 toggle
, command
, system
;
200 gap
= ktime_to_us(ktime_sub(tv
, ir
->base_time
));
201 /* avoid overflow with gap >1s */
202 if (gap
> USEC_PER_SEC
) {
205 /* signal we're ready to start a new code */
208 /* Allow some timer jitter (RC5 is ~24ms anyway so this is ok) */
210 dprintk("spurious timer_end\n");
214 if (ir
->last_bit
< 20) {
215 /* ignore spurious codes (caused by light/other remotes) */
216 dprintk("short code: %x\n", ir
->code
);
220 ir
->code
= (ir
->code
<< ir
->shift_by
) | 1;
221 rc5
= bttv_rc5_decode(ir
->code
);
223 toggle
= RC5_TOGGLE(rc5
);
224 system
= RC5_ADDR(rc5
);
225 command
= RC5_INSTR(rc5
);
227 switch (RC5_START(rc5
)) {
237 scancode
= RC_SCANCODE_RC5(system
, command
);
238 rc_keydown(ir
->dev
, RC_TYPE_RC5
, scancode
, toggle
);
239 dprintk("scancode %x, toggle %x\n", scancode
, toggle
);
242 static int bttv_rc5_irq(struct bttv
*btv
)
244 struct bttv_ir
*ir
= btv
->remote
;
248 unsigned long current_jiffies
;
251 gpio
= bttv_gpio_read(&btv
->c
);
253 /* get time of bit */
254 current_jiffies
= jiffies
;
257 gap
= ktime_to_us(ktime_sub(tv
, ir
->base_time
));
258 /* avoid overflow with gap >1s */
259 if (gap
> USEC_PER_SEC
) {
263 dprintk("RC5 IRQ: gap %d us for %s\n",
264 gap
, (gpio
& 0x20) ? "mark" : "space");
270 /* active code => add bit */
272 /* only if in the code (otherwise spurious IRQ or timer
274 if (ir
->last_bit
< 28) {
275 ir
->last_bit
= (gap
- ir_rc5_remote_gap
/ 2) /
277 ir
->code
|= 1 << ir
->last_bit
;
279 /* starting new code */
286 mod_timer(&ir
->timer
, current_jiffies
+ msecs_to_jiffies(30));
289 /* toggle GPIO pin 4 to reset the irq */
290 bttv_gpio_write(&btv
->c
, gpio
& ~(1 << 4));
291 bttv_gpio_write(&btv
->c
, gpio
| (1 << 4));
295 /* ---------------------------------------------------------------------- */
297 static void bttv_ir_start(struct bttv
*btv
, struct bttv_ir
*ir
)
300 setup_timer(&ir
->timer
, bttv_input_timer
, (unsigned long)btv
);
301 ir
->timer
.expires
= jiffies
+ msecs_to_jiffies(1000);
302 add_timer(&ir
->timer
);
303 } else if (ir
->rc5_gpio
) {
304 /* set timer_end for code completion */
305 setup_timer(&ir
->timer
, bttv_rc5_timer_end
, (unsigned long)ir
);
307 ir
->rc5_remote_gap
= ir_rc5_remote_gap
;
311 static void bttv_ir_stop(struct bttv
*btv
)
313 if (btv
->remote
->polling
)
314 del_timer_sync(&btv
->remote
->timer
);
316 if (btv
->remote
->rc5_gpio
) {
319 del_timer_sync(&btv
->remote
->timer
);
321 gpio
= bttv_gpio_read(&btv
->c
);
322 bttv_gpio_write(&btv
->c
, gpio
& ~(1 << 4));
327 * Get_key functions used by I2C remotes
330 static int get_key_pv951(struct IR_i2c
*ir
, enum rc_type
*protocol
,
331 u32
*scancode
, u8
*toggle
)
336 if (1 != i2c_master_recv(ir
->c
, &b
, 1)) {
337 dprintk("read error\n");
344 dprintk("key %02x\n", b
);
348 * lirc_i2c maps the pv951 code as:
350 * cmd = bit_reverse (b)
351 * So, it seems that this device uses NEC extended
352 * I decided to not fix the table, due to two reasons:
353 * 1) Without the actual device, this is only a guess;
354 * 2) As the addr is not reported via I2C, nor can be changed,
355 * the device is bound to the vendor-provided RC.
358 *protocol
= RC_TYPE_UNKNOWN
;
364 /* Instantiate the I2C IR receiver device, if present */
365 void init_bttv_i2c_ir(struct bttv
*btv
)
367 const unsigned short addr_list
[] = {
368 0x1a, 0x18, 0x64, 0x30, 0x71,
371 struct i2c_board_info info
;
372 struct i2c_client
*i2c_dev
;
374 if (0 != btv
->i2c_rc
)
377 memset(&info
, 0, sizeof(struct i2c_board_info
));
378 memset(&btv
->init_data
, 0, sizeof(btv
->init_data
));
379 strlcpy(info
.type
, "ir_video", I2C_NAME_SIZE
);
381 switch (btv
->c
.type
) {
382 case BTTV_BOARD_PV951
:
383 btv
->init_data
.name
= "PV951";
384 btv
->init_data
.get_key
= get_key_pv951
;
385 btv
->init_data
.ir_codes
= RC_MAP_PV951
;
390 if (btv
->init_data
.name
) {
391 info
.platform_data
= &btv
->init_data
;
392 i2c_dev
= i2c_new_device(&btv
->c
.i2c_adap
, &info
);
395 * The external IR receiver is at i2c address 0x34 (0x35 for
396 * reads). Future Hauppauge cards will have an internal
397 * receiver at 0x30 (0x31 for reads). In theory, both can be
398 * fitted, and Hauppauge suggest an external overrides an
400 * That's why we probe 0x1a (~0x34) first. CB
402 i2c_dev
= i2c_new_probed_device(&btv
->c
.i2c_adap
, &info
, addr_list
, NULL
);
407 #if defined(CONFIG_MODULES) && defined(MODULE)
408 request_module("ir-kbd-i2c");
412 int bttv_input_init(struct bttv
*btv
)
415 char *ir_codes
= NULL
;
419 if (!btv
->has_remote
)
422 ir
= kzalloc(sizeof(*ir
),GFP_KERNEL
);
423 rc
= rc_allocate_device(RC_DRIVER_SCANCODE
);
427 /* detect & configure */
428 switch (btv
->c
.type
) {
429 case BTTV_BOARD_AVERMEDIA
:
430 case BTTV_BOARD_AVPHONE98
:
431 case BTTV_BOARD_AVERMEDIA98
:
432 ir_codes
= RC_MAP_AVERMEDIA
;
433 ir
->mask_keycode
= 0xf88000;
434 ir
->mask_keydown
= 0x010000;
435 ir
->polling
= 50; // ms
438 case BTTV_BOARD_AVDVBT_761
:
439 case BTTV_BOARD_AVDVBT_771
:
440 ir_codes
= RC_MAP_AVERMEDIA_DVBT
;
441 ir
->mask_keycode
= 0x0f00c0;
442 ir
->mask_keydown
= 0x000020;
443 ir
->polling
= 50; // ms
446 case BTTV_BOARD_PXELVWPLTVPAK
:
447 ir_codes
= RC_MAP_PIXELVIEW
;
448 ir
->mask_keycode
= 0x003e00;
449 ir
->mask_keyup
= 0x010000;
450 ir
->polling
= 50; // ms
452 case BTTV_BOARD_PV_M4900
:
453 case BTTV_BOARD_PV_BT878P_9B
:
454 case BTTV_BOARD_PV_BT878P_PLUS
:
455 ir_codes
= RC_MAP_PIXELVIEW
;
456 ir
->mask_keycode
= 0x001f00;
457 ir
->mask_keyup
= 0x008000;
458 ir
->polling
= 50; // ms
461 case BTTV_BOARD_WINFAST2000
:
462 ir_codes
= RC_MAP_WINFAST
;
463 ir
->mask_keycode
= 0x1f8;
465 case BTTV_BOARD_MAGICTVIEW061
:
466 case BTTV_BOARD_MAGICTVIEW063
:
467 ir_codes
= RC_MAP_WINFAST
;
468 ir
->mask_keycode
= 0x0008e000;
469 ir
->mask_keydown
= 0x00200000;
471 case BTTV_BOARD_APAC_VIEWCOMP
:
472 ir_codes
= RC_MAP_APAC_VIEWCOMP
;
473 ir
->mask_keycode
= 0x001f00;
474 ir
->mask_keyup
= 0x008000;
475 ir
->polling
= 50; // ms
477 case BTTV_BOARD_ASKEY_CPH03X
:
478 case BTTV_BOARD_CONCEPTRONIC_CTVFMI2
:
479 case BTTV_BOARD_CONTVFMI
:
480 case BTTV_BOARD_KWORLD_VSTREAM_XPERT
:
481 ir_codes
= RC_MAP_PIXELVIEW
;
482 ir
->mask_keycode
= 0x001F00;
483 ir
->mask_keyup
= 0x006000;
484 ir
->polling
= 50; // ms
486 case BTTV_BOARD_NEBULA_DIGITV
:
487 ir_codes
= RC_MAP_NEBULA
;
490 case BTTV_BOARD_MACHTV_MAGICTV
:
491 ir_codes
= RC_MAP_APAC_VIEWCOMP
;
492 ir
->mask_keycode
= 0x001F00;
493 ir
->mask_keyup
= 0x004000;
494 ir
->polling
= 50; /* ms */
496 case BTTV_BOARD_KOZUMI_KTV_01C
:
497 ir_codes
= RC_MAP_PCTV_SEDNA
;
498 ir
->mask_keycode
= 0x001f00;
499 ir
->mask_keyup
= 0x006000;
500 ir
->polling
= 50; /* ms */
502 case BTTV_BOARD_ENLTV_FM_2
:
503 ir_codes
= RC_MAP_ENCORE_ENLTV2
;
504 ir
->mask_keycode
= 0x00fd00;
505 ir
->mask_keyup
= 0x000080;
506 ir
->polling
= 1; /* ms */
507 ir
->last_gpio
= ir_extract_bits(bttv_gpio_read(&btv
->c
),
513 dprintk("Ooops: IR config error [card=%d]\n", btv
->c
.type
);
520 /* enable remote irq */
521 bttv_gpio_inout(&btv
->c
, (1 << 4), 1 << 4);
522 gpio
= bttv_gpio_read(&btv
->c
);
523 bttv_gpio_write(&btv
->c
, gpio
& ~(1 << 4));
524 bttv_gpio_write(&btv
->c
, gpio
| (1 << 4));
526 /* init hardware-specific stuff */
527 bttv_gpio_inout(&btv
->c
, ir
->mask_keycode
| ir
->mask_keydown
, 0);
530 /* init input device */
533 snprintf(ir
->name
, sizeof(ir
->name
), "bttv IR (card=%d)",
535 snprintf(ir
->phys
, sizeof(ir
->phys
), "pci-%s/ir0",
536 pci_name(btv
->c
.pci
));
538 rc
->input_name
= ir
->name
;
539 rc
->input_phys
= ir
->phys
;
540 rc
->input_id
.bustype
= BUS_PCI
;
541 rc
->input_id
.version
= 1;
542 if (btv
->c
.pci
->subsystem_vendor
) {
543 rc
->input_id
.vendor
= btv
->c
.pci
->subsystem_vendor
;
544 rc
->input_id
.product
= btv
->c
.pci
->subsystem_device
;
546 rc
->input_id
.vendor
= btv
->c
.pci
->vendor
;
547 rc
->input_id
.product
= btv
->c
.pci
->device
;
549 rc
->dev
.parent
= &btv
->c
.pci
->dev
;
550 rc
->map_name
= ir_codes
;
551 rc
->driver_name
= MODULE_NAME
;
554 bttv_ir_start(btv
, ir
);
557 err
= rc_register_device(rc
);
572 void bttv_input_fini(struct bttv
*btv
)
574 if (btv
->remote
== NULL
)
578 rc_unregister_device(btv
->remote
->dev
);