3 * Device driver for GPIO attached remote control interfaces
4 * on Conexant 2388x based TV/DVB cards.
6 * Copyright (c) 2003 Pavel Machek
7 * Copyright (c) 2004 Gerd Knorr
8 * Copyright (c) 2004, 2005 Chris Pascoe
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include <linux/init.h>
26 #include <linux/hrtimer.h>
27 #include <linux/input.h>
28 #include <linux/pci.h>
29 #include <linux/slab.h>
30 #include <linux/module.h>
33 #include <media/ir-core.h>
34 #include <media/ir-common.h>
36 #define MODULE_NAME "cx88xx"
38 /* ---------------------------------------------------------------------- */
41 struct cx88_core
*core
;
42 struct input_dev
*input
;
43 struct ir_dev_props props
;
51 /* sample from gpio pin 16 */
56 /* poll external decoder */
67 module_param(ir_debug
, int, 0644); /* debug level [IR] */
68 MODULE_PARM_DESC(ir_debug
, "enable debug messages [IR]");
70 #define ir_dprintk(fmt, arg...) if (ir_debug) \
71 printk(KERN_DEBUG "%s IR: " fmt , ir->core->name , ##arg)
73 /* ---------------------------------------------------------------------- */
75 static void cx88_ir_handle_key(struct cx88_IR
*ir
)
77 struct cx88_core
*core
= ir
->core
;
78 u32 gpio
, data
, auxgpio
;
81 gpio
= cx_read(ir
->gpio_addr
);
82 switch (core
->boardnr
) {
83 case CX88_BOARD_NPGTECH_REALTV_TOP10FM
:
84 /* This board apparently uses a combination of 2 GPIO
85 to represent the keys. Additionally, the second GPIO
86 can be used for parity.
91 gpio = 0x758, auxgpio = 0xe5 or 0xf5
93 gpio = 0x758, auxgpio = 0xed or 0xfd
96 auxgpio
= cx_read(MO_GP1_IO
);
97 /* Take out the parity part */
98 gpio
=(gpio
& 0x7fd) + (auxgpio
& 0xef);
100 case CX88_BOARD_WINFAST_DTV1000
:
101 case CX88_BOARD_WINFAST_DTV1800H
:
102 case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL
:
103 gpio
= (gpio
& 0x6ff) | ((cx_read(MO_GP1_IO
) << 8) & 0x900);
110 if (ir
->last_gpio
== auxgpio
)
112 ir
->last_gpio
= auxgpio
;
116 data
= ir_extract_bits(gpio
, ir
->mask_keycode
);
117 ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
119 ir
->polling
? "poll" : "irq",
120 (gpio
& ir
->mask_keydown
) ? " down" : "",
121 (gpio
& ir
->mask_keyup
) ? " up" : "");
123 if (ir
->core
->boardnr
== CX88_BOARD_NORWOOD_MICRO
) {
124 u32 gpio_key
= cx_read(MO_GP0_IO
);
126 data
= (data
<< 4) | ((gpio_key
& 0xf0) >> 4);
128 ir_keydown(ir
->input
, data
, 0);
130 } else if (ir
->mask_keydown
) {
131 /* bit set on keydown */
132 if (gpio
& ir
->mask_keydown
)
133 ir_keydown(ir
->input
, data
, 0);
135 } else if (ir
->mask_keyup
) {
136 /* bit cleared on keydown */
137 if (0 == (gpio
& ir
->mask_keyup
))
138 ir_keydown(ir
->input
, data
, 0);
141 /* can't distinguish keydown/up :-/ */
142 ir_keydown(ir
->input
, data
, 0);
146 static enum hrtimer_restart
cx88_ir_work(struct hrtimer
*timer
)
148 unsigned long missed
;
149 struct cx88_IR
*ir
= container_of(timer
, struct cx88_IR
, timer
);
151 cx88_ir_handle_key(ir
);
152 missed
= hrtimer_forward_now(&ir
->timer
,
153 ktime_set(0, ir
->polling
* 1000000));
155 ir_dprintk("Missed ticks %ld\n", missed
- 1);
157 return HRTIMER_RESTART
;
160 static int __cx88_ir_start(void *priv
)
162 struct cx88_core
*core
= priv
;
165 if (!core
|| !core
->ir
)
171 hrtimer_init(&ir
->timer
, CLOCK_MONOTONIC
, HRTIMER_MODE_REL
);
172 ir
->timer
.function
= cx88_ir_work
;
173 hrtimer_start(&ir
->timer
,
174 ktime_set(0, ir
->polling
* 1000000),
178 core
->pci_irqmask
|= PCI_INT_IR_SMPINT
;
179 cx_write(MO_DDS_IO
, 0xa80a80); /* 4 kHz sample rate */
180 cx_write(MO_DDSCFG_IO
, 0x5); /* enable */
185 static void __cx88_ir_stop(void *priv
)
187 struct cx88_core
*core
= priv
;
190 if (!core
|| !core
->ir
)
195 cx_write(MO_DDSCFG_IO
, 0x0);
196 core
->pci_irqmask
&= ~PCI_INT_IR_SMPINT
;
200 hrtimer_cancel(&ir
->timer
);
203 int cx88_ir_start(struct cx88_core
*core
)
206 return __cx88_ir_start(core
);
211 void cx88_ir_stop(struct cx88_core
*core
)
214 __cx88_ir_stop(core
);
217 static int cx88_ir_open(void *priv
)
219 struct cx88_core
*core
= priv
;
222 return __cx88_ir_start(core
);
225 static void cx88_ir_close(void *priv
)
227 struct cx88_core
*core
= priv
;
230 if (!core
->ir
->users
)
231 __cx88_ir_stop(core
);
234 /* ---------------------------------------------------------------------- */
236 int cx88_ir_init(struct cx88_core
*core
, struct pci_dev
*pci
)
239 struct input_dev
*input_dev
;
240 char *ir_codes
= NULL
;
241 u64 ir_type
= IR_TYPE_OTHER
;
243 u32 hardware_mask
= 0; /* For devices with a hardware mask, when
244 * used with a full-code IR table
247 ir
= kzalloc(sizeof(*ir
), GFP_KERNEL
);
248 input_dev
= input_allocate_device();
249 if (!ir
|| !input_dev
)
252 ir
->input
= input_dev
;
254 /* detect & configure */
255 switch (core
->boardnr
) {
256 case CX88_BOARD_DNTV_LIVE_DVB_T
:
257 case CX88_BOARD_KWORLD_DVB_T
:
258 case CX88_BOARD_KWORLD_DVB_T_CX22702
:
259 ir_codes
= RC_MAP_DNTV_LIVE_DVB_T
;
260 ir
->gpio_addr
= MO_GP1_IO
;
261 ir
->mask_keycode
= 0x1f;
262 ir
->mask_keyup
= 0x60;
263 ir
->polling
= 50; /* ms */
265 case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1
:
266 ir_codes
= RC_MAP_CINERGY_1400
;
267 ir_type
= IR_TYPE_NEC
;
268 ir
->sampling
= 0xeb04; /* address */
270 case CX88_BOARD_HAUPPAUGE
:
271 case CX88_BOARD_HAUPPAUGE_DVB_T1
:
272 case CX88_BOARD_HAUPPAUGE_NOVASE2_S1
:
273 case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1
:
274 case CX88_BOARD_HAUPPAUGE_HVR1100
:
275 case CX88_BOARD_HAUPPAUGE_HVR3000
:
276 case CX88_BOARD_HAUPPAUGE_HVR4000
:
277 case CX88_BOARD_HAUPPAUGE_HVR4000LITE
:
278 case CX88_BOARD_PCHDTV_HD3000
:
279 case CX88_BOARD_PCHDTV_HD5500
:
280 case CX88_BOARD_HAUPPAUGE_IRONLY
:
281 ir_codes
= RC_MAP_HAUPPAUGE_NEW
;
282 ir_type
= IR_TYPE_RC5
;
285 case CX88_BOARD_WINFAST_DTV2000H
:
286 case CX88_BOARD_WINFAST_DTV2000H_J
:
287 case CX88_BOARD_WINFAST_DTV1800H
:
288 ir_codes
= RC_MAP_WINFAST
;
289 ir
->gpio_addr
= MO_GP0_IO
;
290 ir
->mask_keycode
= 0x8f8;
291 ir
->mask_keyup
= 0x100;
292 ir
->polling
= 50; /* ms */
294 case CX88_BOARD_WINFAST2000XP_EXPERT
:
295 case CX88_BOARD_WINFAST_DTV1000
:
296 case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL
:
297 ir_codes
= RC_MAP_WINFAST
;
298 ir
->gpio_addr
= MO_GP0_IO
;
299 ir
->mask_keycode
= 0x8f8;
300 ir
->mask_keyup
= 0x100;
301 ir
->polling
= 1; /* ms */
303 case CX88_BOARD_IODATA_GVBCTV7E
:
304 ir_codes
= RC_MAP_IODATA_BCTV7E
;
305 ir
->gpio_addr
= MO_GP0_IO
;
306 ir
->mask_keycode
= 0xfd;
307 ir
->mask_keydown
= 0x02;
308 ir
->polling
= 5; /* ms */
310 case CX88_BOARD_PROLINK_PLAYTVPVR
:
311 case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO
:
313 * It seems that this hardware is paired with NEC extended
314 * address 0x866b. So, unfortunately, its usage with other
315 * IR's with different address won't work. Still, there are
316 * other IR's from the same manufacturer that works, like the
317 * 002-T mini RC, provided with newer PV hardware
319 ir_codes
= RC_MAP_PIXELVIEW_MK12
;
320 ir
->gpio_addr
= MO_GP1_IO
;
321 ir
->mask_keyup
= 0x80;
322 ir
->polling
= 10; /* ms */
323 hardware_mask
= 0x3f; /* Hardware returns only 6 bits from command part */
325 case CX88_BOARD_PROLINK_PV_8000GT
:
326 case CX88_BOARD_PROLINK_PV_GLOBAL_XTREME
:
327 ir_codes
= RC_MAP_PIXELVIEW_NEW
;
328 ir
->gpio_addr
= MO_GP1_IO
;
329 ir
->mask_keycode
= 0x3f;
330 ir
->mask_keyup
= 0x80;
331 ir
->polling
= 1; /* ms */
333 case CX88_BOARD_KWORLD_LTV883
:
334 ir_codes
= RC_MAP_PIXELVIEW
;
335 ir
->gpio_addr
= MO_GP1_IO
;
336 ir
->mask_keycode
= 0x1f;
337 ir
->mask_keyup
= 0x60;
338 ir
->polling
= 1; /* ms */
340 case CX88_BOARD_ADSTECH_DVB_T_PCI
:
341 ir_codes
= RC_MAP_ADSTECH_DVB_T_PCI
;
342 ir
->gpio_addr
= MO_GP1_IO
;
343 ir
->mask_keycode
= 0xbf;
344 ir
->mask_keyup
= 0x40;
345 ir
->polling
= 50; /* ms */
347 case CX88_BOARD_MSI_TVANYWHERE_MASTER
:
348 ir_codes
= RC_MAP_MSI_TVANYWHERE
;
349 ir
->gpio_addr
= MO_GP1_IO
;
350 ir
->mask_keycode
= 0x1f;
351 ir
->mask_keyup
= 0x40;
352 ir
->polling
= 1; /* ms */
354 case CX88_BOARD_AVERTV_303
:
355 case CX88_BOARD_AVERTV_STUDIO_303
:
356 ir_codes
= RC_MAP_AVERTV_303
;
357 ir
->gpio_addr
= MO_GP2_IO
;
358 ir
->mask_keycode
= 0xfb;
359 ir
->mask_keydown
= 0x02;
360 ir
->polling
= 50; /* ms */
362 case CX88_BOARD_OMICOM_SS4_PCI
:
363 case CX88_BOARD_SATTRADE_ST4200
:
364 case CX88_BOARD_TBS_8920
:
365 case CX88_BOARD_TBS_8910
:
366 case CX88_BOARD_PROF_7300
:
367 case CX88_BOARD_PROF_7301
:
368 case CX88_BOARD_PROF_6200
:
369 ir_codes
= RC_MAP_TBS_NEC
;
370 ir_type
= IR_TYPE_NEC
;
371 ir
->sampling
= 0xff00; /* address */
373 case CX88_BOARD_TEVII_S460
:
374 case CX88_BOARD_TEVII_S420
:
375 ir_codes
= RC_MAP_TEVII_NEC
;
376 ir_type
= IR_TYPE_NEC
;
377 ir
->sampling
= 0xff00; /* address */
379 case CX88_BOARD_DNTV_LIVE_DVB_T_PRO
:
380 ir_codes
= RC_MAP_DNTV_LIVE_DVBT_PRO
;
381 ir_type
= IR_TYPE_NEC
;
382 ir
->sampling
= 0xff00; /* address */
384 case CX88_BOARD_NORWOOD_MICRO
:
385 ir_codes
= RC_MAP_NORWOOD
;
386 ir
->gpio_addr
= MO_GP1_IO
;
387 ir
->mask_keycode
= 0x0e;
388 ir
->mask_keyup
= 0x80;
389 ir
->polling
= 50; /* ms */
391 case CX88_BOARD_NPGTECH_REALTV_TOP10FM
:
392 ir_codes
= RC_MAP_NPGTECH
;
393 ir
->gpio_addr
= MO_GP0_IO
;
394 ir
->mask_keycode
= 0xfa;
395 ir
->polling
= 50; /* ms */
397 case CX88_BOARD_PINNACLE_PCTV_HD_800i
:
398 ir_codes
= RC_MAP_PINNACLE_PCTV_HD
;
399 ir_type
= IR_TYPE_RC5
;
402 case CX88_BOARD_POWERCOLOR_REAL_ANGEL
:
403 ir_codes
= RC_MAP_POWERCOLOR_REAL_ANGEL
;
404 ir
->gpio_addr
= MO_GP2_IO
;
405 ir
->mask_keycode
= 0x7e;
406 ir
->polling
= 100; /* ms */
408 case CX88_BOARD_TWINHAN_VP1027_DVBS
:
409 ir_codes
= RC_MAP_TWINHAN_VP1027_DVBS
;
410 ir_type
= IR_TYPE_NEC
;
411 ir
->sampling
= 0xff00; /* address */
415 if (NULL
== ir_codes
) {
421 * The usage of mask_keycode were very convenient, due to several
422 * reasons. Among others, the scancode tables were using the scancode
423 * as the index elements. So, the less bits it was used, the smaller
424 * the table were stored. After the input changes, the better is to use
425 * the full scancodes, since it allows replacing the IR remote by
426 * another one. Unfortunately, there are still some hardware, like
427 * Pixelview Ultra Pro, where only part of the scancode is sent via
428 * GPIO. So, there's no way to get the full scancode. Due to that,
429 * hardware_mask were introduced here: it represents those hardware
430 * that has such limits.
432 if (hardware_mask
&& !ir
->mask_keycode
)
433 ir
->mask_keycode
= hardware_mask
;
435 /* init input device */
436 snprintf(ir
->name
, sizeof(ir
->name
), "cx88 IR (%s)", core
->board
.name
);
437 snprintf(ir
->phys
, sizeof(ir
->phys
), "pci-%s/ir0", pci_name(pci
));
439 ir
->ir_type
= ir_type
;
441 input_dev
->name
= ir
->name
;
442 input_dev
->phys
= ir
->phys
;
443 input_dev
->id
.bustype
= BUS_PCI
;
444 input_dev
->id
.version
= 1;
445 if (pci
->subsystem_vendor
) {
446 input_dev
->id
.vendor
= pci
->subsystem_vendor
;
447 input_dev
->id
.product
= pci
->subsystem_device
;
449 input_dev
->id
.vendor
= pci
->vendor
;
450 input_dev
->id
.product
= pci
->device
;
452 input_dev
->dev
.parent
= &pci
->dev
;
453 /* record handles to ourself */
457 ir
->props
.priv
= core
;
458 ir
->props
.open
= cx88_ir_open
;
459 ir
->props
.close
= cx88_ir_close
;
460 ir
->props
.scanmask
= hardware_mask
;
463 err
= ir_input_register(ir
->input
, ir_codes
, &ir
->props
, MODULE_NAME
);
475 int cx88_ir_fini(struct cx88_core
*core
)
477 struct cx88_IR
*ir
= core
->ir
;
479 /* skip detach on non attached boards */
484 ir_input_unregister(ir
->input
);
492 /* ---------------------------------------------------------------------- */
494 void cx88_ir_irq(struct cx88_core
*core
)
496 struct cx88_IR
*ir
= core
->ir
;
498 int i
, start
, range
, toggle
, dev
, code
;
505 samples
= cx_read(MO_SAMPLE_IO
);
506 if (0 != samples
&& 0xffffffff != samples
) {
507 /* record sample data */
508 if (ir
->scount
< ARRAY_SIZE(ir
->samples
))
509 ir
->samples
[ir
->scount
++] = samples
;
513 /* nothing to sample */
517 /* have a complete sample */
518 if (ir
->scount
< ARRAY_SIZE(ir
->samples
))
519 ir
->samples
[ir
->scount
++] = samples
;
520 for (i
= 0; i
< ir
->scount
; i
++)
521 ir
->samples
[i
] = ~ir
->samples
[i
];
523 ir_dump_samples(ir
->samples
, ir
->scount
);
526 switch (core
->boardnr
) {
527 case CX88_BOARD_TEVII_S460
:
528 case CX88_BOARD_TEVII_S420
:
529 case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1
:
530 case CX88_BOARD_DNTV_LIVE_DVB_T_PRO
:
531 case CX88_BOARD_OMICOM_SS4_PCI
:
532 case CX88_BOARD_SATTRADE_ST4200
:
533 case CX88_BOARD_TBS_8920
:
534 case CX88_BOARD_TBS_8910
:
535 case CX88_BOARD_PROF_7300
:
536 case CX88_BOARD_PROF_7301
:
537 case CX88_BOARD_PROF_6200
:
538 case CX88_BOARD_TWINHAN_VP1027_DVBS
:
539 ircode
= ir_decode_pulsedistance(ir
->samples
, ir
->scount
, 1, 4);
541 if (ircode
== 0xffffffff) { /* decoding error */
542 ir_dprintk("pulse distance decoding error\n");
546 ir_dprintk("pulse distance decoded: %x\n", ircode
);
548 if (ircode
== 0) { /* key still pressed */
549 ir_dprintk("pulse distance decoded repeat code\n");
550 ir_repeat(ir
->input
);
554 if ((ircode
& 0xffff) != (ir
->sampling
& 0xffff)) { /* wrong address */
555 ir_dprintk("pulse distance decoded wrong address\n");
559 if (((~ircode
>> 24) & 0xff) != ((ircode
>> 16) & 0xff)) { /* wrong checksum */
560 ir_dprintk("pulse distance decoded wrong check sum\n");
564 ir_dprintk("Key Code: %x\n", (ircode
>> 16) & 0xff);
565 ir_keydown(ir
->input
, (ircode
>> 16) & 0xff, 0);
567 case CX88_BOARD_HAUPPAUGE
:
568 case CX88_BOARD_HAUPPAUGE_DVB_T1
:
569 case CX88_BOARD_HAUPPAUGE_NOVASE2_S1
:
570 case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1
:
571 case CX88_BOARD_HAUPPAUGE_HVR1100
:
572 case CX88_BOARD_HAUPPAUGE_HVR3000
:
573 case CX88_BOARD_HAUPPAUGE_HVR4000
:
574 case CX88_BOARD_HAUPPAUGE_HVR4000LITE
:
575 case CX88_BOARD_PCHDTV_HD3000
:
576 case CX88_BOARD_PCHDTV_HD5500
:
577 case CX88_BOARD_HAUPPAUGE_IRONLY
:
578 ircode
= ir_decode_biphase(ir
->samples
, ir
->scount
, 5, 7);
579 ir_dprintk("biphase decoded: %x\n", ircode
);
581 * RC5 has an extension bit which adds a new range
582 * of available codes, this is detected here. Also
583 * hauppauge remotes (black/silver) always use
584 * specific device ids. If we do not filter the
585 * device ids then messages destined for devices
586 * such as TVs (id=0) will get through to the
587 * device causing mis-fired events.
589 /* split rc5 data block ... */
590 start
= (ircode
& 0x2000) >> 13;
591 range
= (ircode
& 0x1000) >> 12;
592 toggle
= (ircode
& 0x0800) >> 11;
593 dev
= (ircode
& 0x07c0) >> 6;
594 code
= (ircode
& 0x003f) | ((range
<< 6) ^ 0x0040);
598 if ( dev
!= 0x1e && dev
!= 0x1f )
599 /* not a hauppauge remote */
601 ir_keydown(ir
->input
, code
, toggle
);
603 case CX88_BOARD_PINNACLE_PCTV_HD_800i
:
604 ircode
= ir_decode_biphase(ir
->samples
, ir
->scount
, 5, 7);
605 ir_dprintk("biphase decoded: %x\n", ircode
);
606 if ((ircode
& 0xfffff000) != 0x3000)
608 /* Note: bit 0x800 being the toggle is assumed, not checked
609 with real hardware */
610 ir_keydown(ir
->input
, ircode
& 0x3f, ircode
& 0x0800 ? 1 : 0);
619 void cx88_i2c_init_ir(struct cx88_core
*core
)
621 struct i2c_board_info info
;
622 const unsigned short addr_list
[] = {
626 const unsigned short *addrp
;
627 /* Instantiate the IR receiver device, if present */
628 if (0 != core
->i2c_rc
)
631 memset(&info
, 0, sizeof(struct i2c_board_info
));
632 strlcpy(info
.type
, "ir_video", I2C_NAME_SIZE
);
635 * We can't call i2c_new_probed_device() because it uses
636 * quick writes for probing and at least some RC receiver
637 * devices only reply to reads.
638 * Also, Hauppauge XVR needs to be specified, as address 0x71
639 * conflicts with another remote type used with saa7134
641 for (addrp
= addr_list
; *addrp
!= I2C_CLIENT_END
; addrp
++) {
642 info
.platform_data
= NULL
;
643 memset(&core
->init_data
, 0, sizeof(core
->init_data
));
645 if (*addrp
== 0x71) {
647 core
->init_data
.name
= "cx88 Hauppauge XVR remote";
648 core
->init_data
.ir_codes
= RC_MAP_HAUPPAUGE_NEW
;
649 core
->init_data
.type
= IR_TYPE_RC5
;
650 core
->init_data
.internal_get_key_func
= IR_KBD_GET_KEY_HAUP_XVR
;
652 info
.platform_data
= &core
->init_data
;
654 if (i2c_smbus_xfer(&core
->i2c_adap
, *addrp
, 0,
656 I2C_SMBUS_QUICK
, NULL
) >= 0) {
658 i2c_new_device(&core
->i2c_adap
, &info
);
664 /* ---------------------------------------------------------------------- */
666 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
667 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
668 MODULE_LICENSE("GPL");