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/pci.h>
28 #include <linux/slab.h>
29 #include <linux/module.h>
32 #include <media/rc-core.h>
34 #define MODULE_NAME "cx88xx"
36 /* ---------------------------------------------------------------------- */
39 struct cx88_core
*core
;
47 /* sample from gpio pin 16 */
50 /* poll external decoder */
60 static unsigned ir_samplerate
= 4;
61 module_param(ir_samplerate
, uint
, 0444);
62 MODULE_PARM_DESC(ir_samplerate
, "IR samplerate in kHz, 1 - 20, default 4");
65 module_param(ir_debug
, int, 0644); /* debug level [IR] */
66 MODULE_PARM_DESC(ir_debug
, "enable debug messages [IR]");
68 #define ir_dprintk(fmt, arg...) if (ir_debug) \
69 printk(KERN_DEBUG "%s IR: " fmt , ir->core->name , ##arg)
71 #define dprintk(fmt, arg...) if (ir_debug) \
72 printk(KERN_DEBUG "cx88 IR: " fmt , ##arg)
74 /* ---------------------------------------------------------------------- */
76 static void cx88_ir_handle_key(struct cx88_IR
*ir
)
78 struct cx88_core
*core
= ir
->core
;
79 u32 gpio
, data
, auxgpio
;
82 gpio
= cx_read(ir
->gpio_addr
);
83 switch (core
->boardnr
) {
84 case CX88_BOARD_NPGTECH_REALTV_TOP10FM
:
85 /* This board apparently uses a combination of 2 GPIO
86 to represent the keys. Additionally, the second GPIO
87 can be used for parity.
92 gpio = 0x758, auxgpio = 0xe5 or 0xf5
94 gpio = 0x758, auxgpio = 0xed or 0xfd
97 auxgpio
= cx_read(MO_GP1_IO
);
98 /* Take out the parity part */
99 gpio
=(gpio
& 0x7fd) + (auxgpio
& 0xef);
101 case CX88_BOARD_WINFAST_DTV1000
:
102 case CX88_BOARD_WINFAST_DTV1800H
:
103 case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL
:
104 gpio
= (gpio
& 0x6ff) | ((cx_read(MO_GP1_IO
) << 8) & 0x900);
111 if (ir
->last_gpio
== auxgpio
)
113 ir
->last_gpio
= auxgpio
;
117 data
= ir_extract_bits(gpio
, ir
->mask_keycode
);
118 ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
120 ir
->polling
? "poll" : "irq",
121 (gpio
& ir
->mask_keydown
) ? " down" : "",
122 (gpio
& ir
->mask_keyup
) ? " up" : "");
124 if (ir
->core
->boardnr
== CX88_BOARD_NORWOOD_MICRO
) {
125 u32 gpio_key
= cx_read(MO_GP0_IO
);
127 data
= (data
<< 4) | ((gpio_key
& 0xf0) >> 4);
129 rc_keydown(ir
->dev
, data
, 0);
131 } else if (ir
->mask_keydown
) {
132 /* bit set on keydown */
133 if (gpio
& ir
->mask_keydown
)
134 rc_keydown_notimeout(ir
->dev
, data
, 0);
138 } else if (ir
->mask_keyup
) {
139 /* bit cleared on keydown */
140 if (0 == (gpio
& ir
->mask_keyup
))
141 rc_keydown_notimeout(ir
->dev
, data
, 0);
146 /* can't distinguish keydown/up :-/ */
147 rc_keydown_notimeout(ir
->dev
, data
, 0);
152 static enum hrtimer_restart
cx88_ir_work(struct hrtimer
*timer
)
154 unsigned long missed
;
155 struct cx88_IR
*ir
= container_of(timer
, struct cx88_IR
, timer
);
157 cx88_ir_handle_key(ir
);
158 missed
= hrtimer_forward_now(&ir
->timer
,
159 ktime_set(0, ir
->polling
* 1000000));
161 ir_dprintk("Missed ticks %ld\n", missed
- 1);
163 return HRTIMER_RESTART
;
166 static int __cx88_ir_start(void *priv
)
168 struct cx88_core
*core
= priv
;
171 if (!core
|| !core
->ir
)
177 hrtimer_init(&ir
->timer
, CLOCK_MONOTONIC
, HRTIMER_MODE_REL
);
178 ir
->timer
.function
= cx88_ir_work
;
179 hrtimer_start(&ir
->timer
,
180 ktime_set(0, ir
->polling
* 1000000),
184 core
->pci_irqmask
|= PCI_INT_IR_SMPINT
;
185 cx_write(MO_DDS_IO
, 0x33F286 * ir_samplerate
); /* samplerate */
186 cx_write(MO_DDSCFG_IO
, 0x5); /* enable */
191 static void __cx88_ir_stop(void *priv
)
193 struct cx88_core
*core
= priv
;
196 if (!core
|| !core
->ir
)
201 cx_write(MO_DDSCFG_IO
, 0x0);
202 core
->pci_irqmask
&= ~PCI_INT_IR_SMPINT
;
206 hrtimer_cancel(&ir
->timer
);
209 int cx88_ir_start(struct cx88_core
*core
)
212 return __cx88_ir_start(core
);
217 void cx88_ir_stop(struct cx88_core
*core
)
220 __cx88_ir_stop(core
);
223 static int cx88_ir_open(struct rc_dev
*rc
)
225 struct cx88_core
*core
= rc
->priv
;
228 return __cx88_ir_start(core
);
231 static void cx88_ir_close(struct rc_dev
*rc
)
233 struct cx88_core
*core
= rc
->priv
;
236 if (!core
->ir
->users
)
237 __cx88_ir_stop(core
);
240 /* ---------------------------------------------------------------------- */
242 int cx88_ir_init(struct cx88_core
*core
, struct pci_dev
*pci
)
246 char *ir_codes
= NULL
;
247 u64 rc_type
= RC_TYPE_OTHER
;
249 u32 hardware_mask
= 0; /* For devices with a hardware mask, when
250 * used with a full-code IR table
253 ir
= kzalloc(sizeof(*ir
), GFP_KERNEL
);
254 dev
= rc_allocate_device();
260 /* detect & configure */
261 switch (core
->boardnr
) {
262 case CX88_BOARD_DNTV_LIVE_DVB_T
:
263 case CX88_BOARD_KWORLD_DVB_T
:
264 case CX88_BOARD_KWORLD_DVB_T_CX22702
:
265 ir_codes
= RC_MAP_DNTV_LIVE_DVB_T
;
266 ir
->gpio_addr
= MO_GP1_IO
;
267 ir
->mask_keycode
= 0x1f;
268 ir
->mask_keyup
= 0x60;
269 ir
->polling
= 50; /* ms */
271 case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1
:
272 ir_codes
= RC_MAP_CINERGY_1400
;
273 ir
->sampling
= 0xeb04; /* address */
275 case CX88_BOARD_HAUPPAUGE
:
276 case CX88_BOARD_HAUPPAUGE_DVB_T1
:
277 case CX88_BOARD_HAUPPAUGE_NOVASE2_S1
:
278 case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1
:
279 case CX88_BOARD_HAUPPAUGE_HVR1100
:
280 case CX88_BOARD_HAUPPAUGE_HVR3000
:
281 case CX88_BOARD_HAUPPAUGE_HVR4000
:
282 case CX88_BOARD_HAUPPAUGE_HVR4000LITE
:
283 case CX88_BOARD_PCHDTV_HD3000
:
284 case CX88_BOARD_PCHDTV_HD5500
:
285 case CX88_BOARD_HAUPPAUGE_IRONLY
:
286 ir_codes
= RC_MAP_HAUPPAUGE_NEW
;
289 case CX88_BOARD_WINFAST_DTV2000H
:
290 case CX88_BOARD_WINFAST_DTV2000H_J
:
291 case CX88_BOARD_WINFAST_DTV1800H
:
292 ir_codes
= RC_MAP_WINFAST
;
293 ir
->gpio_addr
= MO_GP0_IO
;
294 ir
->mask_keycode
= 0x8f8;
295 ir
->mask_keyup
= 0x100;
296 ir
->polling
= 50; /* ms */
298 case CX88_BOARD_WINFAST2000XP_EXPERT
:
299 case CX88_BOARD_WINFAST_DTV1000
:
300 case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL
:
301 ir_codes
= RC_MAP_WINFAST
;
302 ir
->gpio_addr
= MO_GP0_IO
;
303 ir
->mask_keycode
= 0x8f8;
304 ir
->mask_keyup
= 0x100;
305 ir
->polling
= 1; /* ms */
307 case CX88_BOARD_IODATA_GVBCTV7E
:
308 ir_codes
= RC_MAP_IODATA_BCTV7E
;
309 ir
->gpio_addr
= MO_GP0_IO
;
310 ir
->mask_keycode
= 0xfd;
311 ir
->mask_keydown
= 0x02;
312 ir
->polling
= 5; /* ms */
314 case CX88_BOARD_PROLINK_PLAYTVPVR
:
315 case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO
:
317 * It seems that this hardware is paired with NEC extended
318 * address 0x866b. So, unfortunately, its usage with other
319 * IR's with different address won't work. Still, there are
320 * other IR's from the same manufacturer that works, like the
321 * 002-T mini RC, provided with newer PV hardware
323 ir_codes
= RC_MAP_PIXELVIEW_MK12
;
324 ir
->gpio_addr
= MO_GP1_IO
;
325 ir
->mask_keyup
= 0x80;
326 ir
->polling
= 10; /* ms */
327 hardware_mask
= 0x3f; /* Hardware returns only 6 bits from command part */
329 case CX88_BOARD_PROLINK_PV_8000GT
:
330 case CX88_BOARD_PROLINK_PV_GLOBAL_XTREME
:
331 ir_codes
= RC_MAP_PIXELVIEW_NEW
;
332 ir
->gpio_addr
= MO_GP1_IO
;
333 ir
->mask_keycode
= 0x3f;
334 ir
->mask_keyup
= 0x80;
335 ir
->polling
= 1; /* ms */
337 case CX88_BOARD_KWORLD_LTV883
:
338 ir_codes
= RC_MAP_PIXELVIEW
;
339 ir
->gpio_addr
= MO_GP1_IO
;
340 ir
->mask_keycode
= 0x1f;
341 ir
->mask_keyup
= 0x60;
342 ir
->polling
= 1; /* ms */
344 case CX88_BOARD_ADSTECH_DVB_T_PCI
:
345 ir_codes
= RC_MAP_ADSTECH_DVB_T_PCI
;
346 ir
->gpio_addr
= MO_GP1_IO
;
347 ir
->mask_keycode
= 0xbf;
348 ir
->mask_keyup
= 0x40;
349 ir
->polling
= 50; /* ms */
351 case CX88_BOARD_MSI_TVANYWHERE_MASTER
:
352 ir_codes
= RC_MAP_MSI_TVANYWHERE
;
353 ir
->gpio_addr
= MO_GP1_IO
;
354 ir
->mask_keycode
= 0x1f;
355 ir
->mask_keyup
= 0x40;
356 ir
->polling
= 1; /* ms */
358 case CX88_BOARD_AVERTV_303
:
359 case CX88_BOARD_AVERTV_STUDIO_303
:
360 ir_codes
= RC_MAP_AVERTV_303
;
361 ir
->gpio_addr
= MO_GP2_IO
;
362 ir
->mask_keycode
= 0xfb;
363 ir
->mask_keydown
= 0x02;
364 ir
->polling
= 50; /* ms */
366 case CX88_BOARD_OMICOM_SS4_PCI
:
367 case CX88_BOARD_SATTRADE_ST4200
:
368 case CX88_BOARD_TBS_8920
:
369 case CX88_BOARD_TBS_8910
:
370 case CX88_BOARD_PROF_7300
:
371 case CX88_BOARD_PROF_7301
:
372 case CX88_BOARD_PROF_6200
:
373 ir_codes
= RC_MAP_TBS_NEC
;
374 ir
->sampling
= 0xff00; /* address */
376 case CX88_BOARD_TEVII_S460
:
377 case CX88_BOARD_TEVII_S420
:
378 ir_codes
= RC_MAP_TEVII_NEC
;
379 ir
->sampling
= 0xff00; /* address */
381 case CX88_BOARD_DNTV_LIVE_DVB_T_PRO
:
382 ir_codes
= RC_MAP_DNTV_LIVE_DVBT_PRO
;
383 ir
->sampling
= 0xff00; /* address */
385 case CX88_BOARD_NORWOOD_MICRO
:
386 ir_codes
= RC_MAP_NORWOOD
;
387 ir
->gpio_addr
= MO_GP1_IO
;
388 ir
->mask_keycode
= 0x0e;
389 ir
->mask_keyup
= 0x80;
390 ir
->polling
= 50; /* ms */
392 case CX88_BOARD_NPGTECH_REALTV_TOP10FM
:
393 ir_codes
= RC_MAP_NPGTECH
;
394 ir
->gpio_addr
= MO_GP0_IO
;
395 ir
->mask_keycode
= 0xfa;
396 ir
->polling
= 50; /* ms */
398 case CX88_BOARD_PINNACLE_PCTV_HD_800i
:
399 ir_codes
= RC_MAP_PINNACLE_PCTV_HD
;
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 rc_type
= RC_TYPE_NEC
;
411 ir
->sampling
= 0xff00; /* address */
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 dev
->input_name
= ir
->name
;
440 dev
->input_phys
= ir
->phys
;
441 dev
->input_id
.bustype
= BUS_PCI
;
442 dev
->input_id
.version
= 1;
443 if (pci
->subsystem_vendor
) {
444 dev
->input_id
.vendor
= pci
->subsystem_vendor
;
445 dev
->input_id
.product
= pci
->subsystem_device
;
447 dev
->input_id
.vendor
= pci
->vendor
;
448 dev
->input_id
.product
= pci
->device
;
450 dev
->dev
.parent
= &pci
->dev
;
451 dev
->map_name
= ir_codes
;
452 dev
->driver_name
= MODULE_NAME
;
454 dev
->open
= cx88_ir_open
;
455 dev
->close
= cx88_ir_close
;
456 dev
->scanmask
= hardware_mask
;
459 dev
->driver_type
= RC_DRIVER_IR_RAW
;
460 dev
->timeout
= 10 * 1000 * 1000; /* 10 ms */
462 dev
->driver_type
= RC_DRIVER_SCANCODE
;
463 dev
->allowed_protos
= rc_type
;
470 err
= rc_register_device(dev
);
483 int cx88_ir_fini(struct cx88_core
*core
)
485 struct cx88_IR
*ir
= core
->ir
;
487 /* skip detach on non attached boards */
492 rc_unregister_device(ir
->dev
);
500 /* ---------------------------------------------------------------------- */
502 void cx88_ir_irq(struct cx88_core
*core
)
504 struct cx88_IR
*ir
= core
->ir
;
507 struct ir_raw_event ev
;
509 if (!ir
|| !ir
->sampling
)
513 * Samples are stored in a 32 bit register, oldest sample in
514 * the msb. A set bit represents space and an unset bit
515 * represents a pulse.
517 samples
= cx_read(MO_SAMPLE_IO
);
519 if (samples
== 0xff && ir
->dev
->idle
)
522 init_ir_raw_event(&ev
);
523 for (todo
= 32; todo
> 0; todo
-= bits
) {
524 ev
.pulse
= samples
& 0x80000000 ? false : true;
525 bits
= min(todo
, 32U - fls(ev
.pulse
? samples
: ~samples
));
526 ev
.duration
= (bits
* NSEC_PER_SEC
) / (1000 * ir_samplerate
);
527 ir_raw_event_store_with_filter(ir
->dev
, &ev
);
530 ir_raw_event_handle(ir
->dev
);
533 static int get_key_pvr2000(struct IR_i2c
*ir
, u32
*ir_key
, u32
*ir_raw
)
538 flags
= i2c_smbus_read_byte_data(ir
->c
, 0x10);
540 dprintk("read error\n");
544 if (0 == (flags
& 0x80))
547 /* read actual key code */
548 code
= i2c_smbus_read_byte_data(ir
->c
, 0x00);
550 dprintk("read error\n");
554 dprintk("IR Key/Flags: (0x%02x/0x%02x)\n",
555 code
& 0xff, flags
& 0xff);
557 *ir_key
= code
& 0xff;
562 void cx88_i2c_init_ir(struct cx88_core
*core
)
564 struct i2c_board_info info
;
565 const unsigned short default_addr_list
[] = {
569 const unsigned short pvr2000_addr_list
[] = {
573 const unsigned short *addr_list
= default_addr_list
;
574 const unsigned short *addrp
;
575 /* Instantiate the IR receiver device, if present */
576 if (0 != core
->i2c_rc
)
579 memset(&info
, 0, sizeof(struct i2c_board_info
));
580 strlcpy(info
.type
, "ir_video", I2C_NAME_SIZE
);
582 switch (core
->boardnr
) {
583 case CX88_BOARD_LEADTEK_PVR2000
:
584 addr_list
= pvr2000_addr_list
;
585 core
->init_data
.name
= "cx88 Leadtek PVR 2000 remote";
586 core
->init_data
.type
= RC_TYPE_UNKNOWN
;
587 core
->init_data
.get_key
= get_key_pvr2000
;
588 core
->init_data
.ir_codes
= RC_MAP_EMPTY
;
593 * We can't call i2c_new_probed_device() because it uses
594 * quick writes for probing and at least some RC receiver
595 * devices only reply to reads.
596 * Also, Hauppauge XVR needs to be specified, as address 0x71
597 * conflicts with another remote type used with saa7134
599 for (addrp
= addr_list
; *addrp
!= I2C_CLIENT_END
; addrp
++) {
600 info
.platform_data
= NULL
;
601 memset(&core
->init_data
, 0, sizeof(core
->init_data
));
603 if (*addrp
== 0x71) {
605 core
->init_data
.name
= "cx88 Hauppauge XVR remote";
606 core
->init_data
.ir_codes
= RC_MAP_HAUPPAUGE_NEW
;
607 core
->init_data
.type
= RC_TYPE_RC5
;
608 core
->init_data
.internal_get_key_func
= IR_KBD_GET_KEY_HAUP_XVR
;
610 info
.platform_data
= &core
->init_data
;
612 if (i2c_smbus_xfer(&core
->i2c_adap
, *addrp
, 0,
614 I2C_SMBUS_QUICK
, NULL
) >= 0) {
616 i2c_new_device(&core
->i2c_adap
, &info
);
622 /* ---------------------------------------------------------------------- */
624 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
625 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
626 MODULE_LICENSE("GPL");