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_PROTO_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_PROTO_UNKNOWN
, data
,
84 static void ir_enltv_handle_key(struct bttv
*btv
)
86 struct bttv_ir
*ir
= btv
->remote
;
87 u32 gpio
, data
, keyup
;
90 gpio
= bttv_gpio_read(&btv
->c
);
93 data
= ir_extract_bits(gpio
, ir
->mask_keycode
);
95 /* Check if it is keyup */
96 keyup
= (gpio
& ir
->mask_keyup
) ? 1 << 31 : 0;
98 if ((ir
->last_gpio
& 0x7f) != data
) {
99 dprintk("gpio=0x%x code=%d | %s\n",
101 (gpio
& ir
->mask_keyup
) ? " up" : "up/down");
103 rc_keydown_notimeout(ir
->dev
, RC_PROTO_UNKNOWN
, data
, 0);
107 if ((ir
->last_gpio
& 1 << 31) == keyup
)
110 dprintk("(cnt) gpio=0x%x code=%d | %s\n",
112 (gpio
& ir
->mask_keyup
) ? " up" : "down");
117 rc_keydown_notimeout(ir
->dev
, RC_PROTO_UNKNOWN
, data
,
121 ir
->last_gpio
= data
| keyup
;
124 static int bttv_rc5_irq(struct bttv
*btv
);
126 void bttv_input_irq(struct bttv
*btv
)
128 struct bttv_ir
*ir
= btv
->remote
;
132 else if (!ir
->polling
)
136 static void bttv_input_timer(struct timer_list
*t
)
138 struct bttv_ir
*ir
= from_timer(ir
, t
, timer
);
139 struct bttv
*btv
= ir
->btv
;
141 if (btv
->c
.type
== BTTV_BOARD_ENLTV_FM_2
)
142 ir_enltv_handle_key(btv
);
145 mod_timer(&ir
->timer
, jiffies
+ msecs_to_jiffies(ir
->polling
));
149 * FIXME: Nebula digi uses the legacy way to decode RC5, instead of relying
150 * on the rc-core way. As we need to be sure that both IRQ transitions are
151 * properly triggered, Better to touch it only with this hardware for
155 #define RC5_START(x) (((x) >> 12) & 0x03)
156 #define RC5_TOGGLE(x) (((x) >> 11) & 0x01)
157 #define RC5_ADDR(x) (((x) >> 6) & 0x1f)
158 #define RC5_INSTR(x) (((x) >> 0) & 0x3f)
160 /* decode raw bit pattern to RC5 code */
161 static u32
bttv_rc5_decode(unsigned int code
)
163 unsigned int org_code
= code
;
165 unsigned int rc5
= 0;
168 for (i
= 0; i
< 14; ++i
) {
181 dprintk("rc5_decode(%x) bad code\n",
186 dprintk("code=%x, rc5=%x, start=%x, toggle=%x, address=%x, instr=%x\n",
187 rc5
, org_code
, RC5_START(rc5
),
188 RC5_TOGGLE(rc5
), RC5_ADDR(rc5
), RC5_INSTR(rc5
));
192 static void bttv_rc5_timer_end(struct timer_list
*t
)
194 struct bttv_ir
*ir
= from_timer(ir
, t
, timer
);
196 u32 gap
, rc5
, scancode
;
197 u8 toggle
, command
, system
;
202 gap
= ktime_to_us(ktime_sub(tv
, ir
->base_time
));
203 /* avoid overflow with gap >1s */
204 if (gap
> USEC_PER_SEC
) {
207 /* signal we're ready to start a new code */
210 /* Allow some timer jitter (RC5 is ~24ms anyway so this is ok) */
212 dprintk("spurious timer_end\n");
216 if (ir
->last_bit
< 20) {
217 /* ignore spurious codes (caused by light/other remotes) */
218 dprintk("short code: %x\n", ir
->code
);
222 ir
->code
= (ir
->code
<< ir
->shift_by
) | 1;
223 rc5
= bttv_rc5_decode(ir
->code
);
225 toggle
= RC5_TOGGLE(rc5
);
226 system
= RC5_ADDR(rc5
);
227 command
= RC5_INSTR(rc5
);
229 switch (RC5_START(rc5
)) {
239 scancode
= RC_SCANCODE_RC5(system
, command
);
240 rc_keydown(ir
->dev
, RC_PROTO_RC5
, scancode
, toggle
);
241 dprintk("scancode %x, toggle %x\n", scancode
, toggle
);
244 static int bttv_rc5_irq(struct bttv
*btv
)
246 struct bttv_ir
*ir
= btv
->remote
;
250 unsigned long current_jiffies
;
253 gpio
= bttv_gpio_read(&btv
->c
);
255 /* get time of bit */
256 current_jiffies
= jiffies
;
259 gap
= ktime_to_us(ktime_sub(tv
, ir
->base_time
));
260 /* avoid overflow with gap >1s */
261 if (gap
> USEC_PER_SEC
) {
265 dprintk("RC5 IRQ: gap %d us for %s\n",
266 gap
, (gpio
& 0x20) ? "mark" : "space");
272 /* active code => add bit */
274 /* only if in the code (otherwise spurious IRQ or timer
276 if (ir
->last_bit
< 28) {
277 ir
->last_bit
= (gap
- ir_rc5_remote_gap
/ 2) /
279 ir
->code
|= 1 << ir
->last_bit
;
281 /* starting new code */
288 mod_timer(&ir
->timer
, current_jiffies
+ msecs_to_jiffies(30));
291 /* toggle GPIO pin 4 to reset the irq */
292 bttv_gpio_write(&btv
->c
, gpio
& ~(1 << 4));
293 bttv_gpio_write(&btv
->c
, gpio
| (1 << 4));
297 /* ---------------------------------------------------------------------- */
299 static void bttv_ir_start(struct bttv_ir
*ir
)
302 timer_setup(&ir
->timer
, bttv_input_timer
, 0);
303 ir
->timer
.expires
= jiffies
+ msecs_to_jiffies(1000);
304 add_timer(&ir
->timer
);
305 } else if (ir
->rc5_gpio
) {
306 /* set timer_end for code completion */
307 timer_setup(&ir
->timer
, bttv_rc5_timer_end
, 0);
309 ir
->rc5_remote_gap
= ir_rc5_remote_gap
;
313 static void bttv_ir_stop(struct bttv
*btv
)
315 if (btv
->remote
->polling
)
316 del_timer_sync(&btv
->remote
->timer
);
318 if (btv
->remote
->rc5_gpio
) {
321 del_timer_sync(&btv
->remote
->timer
);
323 gpio
= bttv_gpio_read(&btv
->c
);
324 bttv_gpio_write(&btv
->c
, gpio
& ~(1 << 4));
329 * Get_key functions used by I2C remotes
332 static int get_key_pv951(struct IR_i2c
*ir
, enum rc_proto
*protocol
,
333 u32
*scancode
, u8
*toggle
)
338 if (1 != i2c_master_recv(ir
->c
, &b
, 1)) {
339 dprintk("read error\n");
346 dprintk("key %02x\n", b
);
350 * lirc_i2c maps the pv951 code as:
352 * cmd = bit_reverse (b)
353 * So, it seems that this device uses NEC extended
354 * I decided to not fix the table, due to two reasons:
355 * 1) Without the actual device, this is only a guess;
356 * 2) As the addr is not reported via I2C, nor can be changed,
357 * the device is bound to the vendor-provided RC.
360 *protocol
= RC_PROTO_UNKNOWN
;
366 /* Instantiate the I2C IR receiver device, if present */
367 void init_bttv_i2c_ir(struct bttv
*btv
)
369 const unsigned short addr_list
[] = {
370 0x1a, 0x18, 0x64, 0x30, 0x71,
373 struct i2c_board_info info
;
374 struct i2c_client
*i2c_dev
;
376 if (0 != btv
->i2c_rc
)
379 memset(&info
, 0, sizeof(struct i2c_board_info
));
380 memset(&btv
->init_data
, 0, sizeof(btv
->init_data
));
381 strlcpy(info
.type
, "ir_video", I2C_NAME_SIZE
);
383 switch (btv
->c
.type
) {
384 case BTTV_BOARD_PV951
:
385 btv
->init_data
.name
= "PV951";
386 btv
->init_data
.get_key
= get_key_pv951
;
387 btv
->init_data
.ir_codes
= RC_MAP_PV951
;
392 if (btv
->init_data
.name
) {
393 info
.platform_data
= &btv
->init_data
;
394 i2c_dev
= i2c_new_device(&btv
->c
.i2c_adap
, &info
);
397 * The external IR receiver is at i2c address 0x34 (0x35 for
398 * reads). Future Hauppauge cards will have an internal
399 * receiver at 0x30 (0x31 for reads). In theory, both can be
400 * fitted, and Hauppauge suggest an external overrides an
402 * That's why we probe 0x1a (~0x34) first. CB
404 i2c_dev
= i2c_new_probed_device(&btv
->c
.i2c_adap
, &info
, addr_list
, NULL
);
409 #if defined(CONFIG_MODULES) && defined(MODULE)
410 request_module("ir-kbd-i2c");
414 int bttv_input_init(struct bttv
*btv
)
417 char *ir_codes
= NULL
;
421 if (!btv
->has_remote
)
424 ir
= kzalloc(sizeof(*ir
),GFP_KERNEL
);
425 rc
= rc_allocate_device(RC_DRIVER_SCANCODE
);
429 /* detect & configure */
430 switch (btv
->c
.type
) {
431 case BTTV_BOARD_AVERMEDIA
:
432 case BTTV_BOARD_AVPHONE98
:
433 case BTTV_BOARD_AVERMEDIA98
:
434 ir_codes
= RC_MAP_AVERMEDIA
;
435 ir
->mask_keycode
= 0xf88000;
436 ir
->mask_keydown
= 0x010000;
437 ir
->polling
= 50; // ms
440 case BTTV_BOARD_AVDVBT_761
:
441 case BTTV_BOARD_AVDVBT_771
:
442 ir_codes
= RC_MAP_AVERMEDIA_DVBT
;
443 ir
->mask_keycode
= 0x0f00c0;
444 ir
->mask_keydown
= 0x000020;
445 ir
->polling
= 50; // ms
448 case BTTV_BOARD_PXELVWPLTVPAK
:
449 ir_codes
= RC_MAP_PIXELVIEW
;
450 ir
->mask_keycode
= 0x003e00;
451 ir
->mask_keyup
= 0x010000;
452 ir
->polling
= 50; // ms
454 case BTTV_BOARD_PV_M4900
:
455 case BTTV_BOARD_PV_BT878P_9B
:
456 case BTTV_BOARD_PV_BT878P_PLUS
:
457 ir_codes
= RC_MAP_PIXELVIEW
;
458 ir
->mask_keycode
= 0x001f00;
459 ir
->mask_keyup
= 0x008000;
460 ir
->polling
= 50; // ms
463 case BTTV_BOARD_WINFAST2000
:
464 ir_codes
= RC_MAP_WINFAST
;
465 ir
->mask_keycode
= 0x1f8;
467 case BTTV_BOARD_MAGICTVIEW061
:
468 case BTTV_BOARD_MAGICTVIEW063
:
469 ir_codes
= RC_MAP_WINFAST
;
470 ir
->mask_keycode
= 0x0008e000;
471 ir
->mask_keydown
= 0x00200000;
473 case BTTV_BOARD_APAC_VIEWCOMP
:
474 ir_codes
= RC_MAP_APAC_VIEWCOMP
;
475 ir
->mask_keycode
= 0x001f00;
476 ir
->mask_keyup
= 0x008000;
477 ir
->polling
= 50; // ms
479 case BTTV_BOARD_ASKEY_CPH03X
:
480 case BTTV_BOARD_CONCEPTRONIC_CTVFMI2
:
481 case BTTV_BOARD_CONTVFMI
:
482 case BTTV_BOARD_KWORLD_VSTREAM_XPERT
:
483 ir_codes
= RC_MAP_PIXELVIEW
;
484 ir
->mask_keycode
= 0x001F00;
485 ir
->mask_keyup
= 0x006000;
486 ir
->polling
= 50; // ms
488 case BTTV_BOARD_NEBULA_DIGITV
:
489 ir_codes
= RC_MAP_NEBULA
;
492 case BTTV_BOARD_MACHTV_MAGICTV
:
493 ir_codes
= RC_MAP_APAC_VIEWCOMP
;
494 ir
->mask_keycode
= 0x001F00;
495 ir
->mask_keyup
= 0x004000;
496 ir
->polling
= 50; /* ms */
498 case BTTV_BOARD_KOZUMI_KTV_01C
:
499 ir_codes
= RC_MAP_PCTV_SEDNA
;
500 ir
->mask_keycode
= 0x001f00;
501 ir
->mask_keyup
= 0x006000;
502 ir
->polling
= 50; /* ms */
504 case BTTV_BOARD_ENLTV_FM_2
:
505 ir_codes
= RC_MAP_ENCORE_ENLTV2
;
506 ir
->mask_keycode
= 0x00fd00;
507 ir
->mask_keyup
= 0x000080;
508 ir
->polling
= 1; /* ms */
509 ir
->last_gpio
= ir_extract_bits(bttv_gpio_read(&btv
->c
),
515 dprintk("Ooops: IR config error [card=%d]\n", btv
->c
.type
);
522 /* enable remote irq */
523 bttv_gpio_inout(&btv
->c
, (1 << 4), 1 << 4);
524 gpio
= bttv_gpio_read(&btv
->c
);
525 bttv_gpio_write(&btv
->c
, gpio
& ~(1 << 4));
526 bttv_gpio_write(&btv
->c
, gpio
| (1 << 4));
528 /* init hardware-specific stuff */
529 bttv_gpio_inout(&btv
->c
, ir
->mask_keycode
| ir
->mask_keydown
, 0);
532 /* init input device */
536 snprintf(ir
->name
, sizeof(ir
->name
), "bttv IR (card=%d)",
538 snprintf(ir
->phys
, sizeof(ir
->phys
), "pci-%s/ir0",
539 pci_name(btv
->c
.pci
));
541 rc
->device_name
= ir
->name
;
542 rc
->input_phys
= ir
->phys
;
543 rc
->input_id
.bustype
= BUS_PCI
;
544 rc
->input_id
.version
= 1;
545 if (btv
->c
.pci
->subsystem_vendor
) {
546 rc
->input_id
.vendor
= btv
->c
.pci
->subsystem_vendor
;
547 rc
->input_id
.product
= btv
->c
.pci
->subsystem_device
;
549 rc
->input_id
.vendor
= btv
->c
.pci
->vendor
;
550 rc
->input_id
.product
= btv
->c
.pci
->device
;
552 rc
->dev
.parent
= &btv
->c
.pci
->dev
;
553 rc
->map_name
= ir_codes
;
554 rc
->driver_name
= MODULE_NAME
;
560 err
= rc_register_device(rc
);
575 void bttv_input_fini(struct bttv
*btv
)
577 if (btv
->remote
== NULL
)
581 rc_unregister_device(btv
->remote
->dev
);