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-common.h>
35 #define MODULE_NAME "cx88xx"
37 /* ---------------------------------------------------------------------- */
40 struct cx88_core *core;
41 struct input_dev *input;
42 struct ir_input_state ir;
43 struct ir_dev_props props;
50 /* sample from gpio pin 16 */
54 unsigned long release;
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_input_keydown(ir->input, &ir->ir, data);
129 ir_input_nokey(ir->input, &ir->ir);
131 } else if (ir->mask_keydown) {
132 /* bit set on keydown */
133 if (gpio & ir->mask_keydown) {
134 ir_input_keydown(ir->input, &ir->ir, data);
136 ir_input_nokey(ir->input, &ir->ir);
139 } else if (ir->mask_keyup) {
140 /* bit cleared on keydown */
141 if (0 == (gpio & ir->mask_keyup)) {
142 ir_input_keydown(ir->input, &ir->ir, data);
144 ir_input_nokey(ir->input, &ir->ir);
148 /* can't distinguish keydown/up :-/ */
149 ir_input_keydown(ir->input, &ir->ir, data);
150 ir_input_nokey(ir->input, &ir->ir);
154 static enum hrtimer_restart cx88_ir_work(struct hrtimer *timer)
156 unsigned long missed;
157 struct cx88_IR *ir = container_of(timer, struct cx88_IR, timer);
159 cx88_ir_handle_key(ir);
160 missed = hrtimer_forward_now(&ir->timer,
161 ktime_set(0, ir->polling * 1000000));
163 ir_dprintk("Missed ticks %ld\n", missed - 1);
165 return HRTIMER_RESTART;
168 static int __cx88_ir_start(void *priv)
170 struct cx88_core *core = priv;
173 if (!core || !core->ir)
179 hrtimer_init(&ir->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
180 ir->timer.function = cx88_ir_work;
181 hrtimer_start(&ir->timer,
182 ktime_set(0, ir->polling * 1000000),
186 core->pci_irqmask |= PCI_INT_IR_SMPINT;
187 cx_write(MO_DDS_IO, 0xa80a80); /* 4 kHz sample rate */
188 cx_write(MO_DDSCFG_IO, 0x5); /* enable */
193 static void __cx88_ir_stop(void *priv)
195 struct cx88_core *core = priv;
198 if (!core || !core->ir)
203 cx_write(MO_DDSCFG_IO, 0x0);
204 core->pci_irqmask &= ~PCI_INT_IR_SMPINT;
208 hrtimer_cancel(&ir->timer);
211 int cx88_ir_start(struct cx88_core *core)
214 return __cx88_ir_start(core);
219 void cx88_ir_stop(struct cx88_core *core)
222 __cx88_ir_stop(core);
225 static int cx88_ir_open(void *priv)
227 struct cx88_core *core = priv;
230 return __cx88_ir_start(core);
233 static void cx88_ir_close(void *priv)
235 struct cx88_core *core = priv;
238 if (!core->ir->users)
239 __cx88_ir_stop(core);
242 /* ---------------------------------------------------------------------- */
244 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
247 struct input_dev *input_dev;
248 char *ir_codes = NULL;
249 u64 ir_type = IR_TYPE_OTHER;
252 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
253 input_dev = input_allocate_device();
254 if (!ir || !input_dev)
257 ir->input = input_dev;
259 /* detect & configure */
260 switch (core->boardnr) {
261 case CX88_BOARD_DNTV_LIVE_DVB_T:
262 case CX88_BOARD_KWORLD_DVB_T:
263 case CX88_BOARD_KWORLD_DVB_T_CX22702:
264 ir_codes = RC_MAP_DNTV_LIVE_DVB_T;
265 ir->gpio_addr = MO_GP1_IO;
266 ir->mask_keycode = 0x1f;
267 ir->mask_keyup = 0x60;
268 ir->polling = 50; /* ms */
270 case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
271 ir_codes = RC_MAP_CINERGY_1400;
272 ir_type = IR_TYPE_PD;
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;
287 ir_type = IR_TYPE_RC5;
290 case CX88_BOARD_WINFAST_DTV2000H:
291 case CX88_BOARD_WINFAST_DTV2000H_J:
292 case CX88_BOARD_WINFAST_DTV1800H:
293 ir_codes = RC_MAP_WINFAST;
294 ir->gpio_addr = MO_GP0_IO;
295 ir->mask_keycode = 0x8f8;
296 ir->mask_keyup = 0x100;
297 ir->polling = 50; /* ms */
299 case CX88_BOARD_WINFAST2000XP_EXPERT:
300 case CX88_BOARD_WINFAST_DTV1000:
301 case CX88_BOARD_WINFAST_TV2000_XP_GLOBAL:
302 ir_codes = RC_MAP_WINFAST;
303 ir->gpio_addr = MO_GP0_IO;
304 ir->mask_keycode = 0x8f8;
305 ir->mask_keyup = 0x100;
306 ir->polling = 1; /* ms */
308 case CX88_BOARD_IODATA_GVBCTV7E:
309 ir_codes = RC_MAP_IODATA_BCTV7E;
310 ir->gpio_addr = MO_GP0_IO;
311 ir->mask_keycode = 0xfd;
312 ir->mask_keydown = 0x02;
313 ir->polling = 5; /* ms */
315 case CX88_BOARD_PROLINK_PLAYTVPVR:
316 case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
317 ir_codes = RC_MAP_PIXELVIEW;
318 ir->gpio_addr = MO_GP1_IO;
319 ir->mask_keycode = 0x1f; /* Only command is retrieved */
320 ir->mask_keyup = 0x80;
321 ir->polling = 10; /* ms */
323 case CX88_BOARD_PROLINK_PV_8000GT:
324 case CX88_BOARD_PROLINK_PV_GLOBAL_XTREME:
325 ir_codes = RC_MAP_PIXELVIEW_NEW;
326 ir->gpio_addr = MO_GP1_IO;
327 ir->mask_keycode = 0x3f;
328 ir->mask_keyup = 0x80;
329 ir->polling = 1; /* ms */
331 case CX88_BOARD_KWORLD_LTV883:
332 ir_codes = RC_MAP_PIXELVIEW;
333 ir->gpio_addr = MO_GP1_IO;
334 ir->mask_keycode = 0x1f;
335 ir->mask_keyup = 0x60;
336 ir->polling = 1; /* ms */
338 case CX88_BOARD_ADSTECH_DVB_T_PCI:
339 ir_codes = RC_MAP_ADSTECH_DVB_T_PCI;
340 ir->gpio_addr = MO_GP1_IO;
341 ir->mask_keycode = 0xbf;
342 ir->mask_keyup = 0x40;
343 ir->polling = 50; /* ms */
345 case CX88_BOARD_MSI_TVANYWHERE_MASTER:
346 ir_codes = RC_MAP_MSI_TVANYWHERE;
347 ir->gpio_addr = MO_GP1_IO;
348 ir->mask_keycode = 0x1f;
349 ir->mask_keyup = 0x40;
350 ir->polling = 1; /* ms */
352 case CX88_BOARD_AVERTV_303:
353 case CX88_BOARD_AVERTV_STUDIO_303:
354 ir_codes = RC_MAP_AVERTV_303;
355 ir->gpio_addr = MO_GP2_IO;
356 ir->mask_keycode = 0xfb;
357 ir->mask_keydown = 0x02;
358 ir->polling = 50; /* ms */
360 case CX88_BOARD_OMICOM_SS4_PCI:
361 case CX88_BOARD_SATTRADE_ST4200:
362 case CX88_BOARD_TBS_8920:
363 case CX88_BOARD_TBS_8910:
364 case CX88_BOARD_PROF_7300:
365 case CX88_BOARD_PROF_7301:
366 case CX88_BOARD_PROF_6200:
367 ir_codes = RC_MAP_TBS_NEC;
368 ir_type = IR_TYPE_PD;
369 ir->sampling = 0xff00; /* address */
371 case CX88_BOARD_TEVII_S460:
372 case CX88_BOARD_TEVII_S420:
373 ir_codes = RC_MAP_TEVII_NEC;
374 ir_type = IR_TYPE_PD;
375 ir->sampling = 0xff00; /* address */
377 case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
378 ir_codes = RC_MAP_DNTV_LIVE_DVBT_PRO;
379 ir_type = IR_TYPE_PD;
380 ir->sampling = 0xff00; /* address */
382 case CX88_BOARD_NORWOOD_MICRO:
383 ir_codes = RC_MAP_NORWOOD;
384 ir->gpio_addr = MO_GP1_IO;
385 ir->mask_keycode = 0x0e;
386 ir->mask_keyup = 0x80;
387 ir->polling = 50; /* ms */
389 case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
390 ir_codes = RC_MAP_NPGTECH;
391 ir->gpio_addr = MO_GP0_IO;
392 ir->mask_keycode = 0xfa;
393 ir->polling = 50; /* ms */
395 case CX88_BOARD_PINNACLE_PCTV_HD_800i:
396 ir_codes = RC_MAP_PINNACLE_PCTV_HD;
397 ir_type = IR_TYPE_RC5;
400 case CX88_BOARD_POWERCOLOR_REAL_ANGEL:
401 ir_codes = RC_MAP_POWERCOLOR_REAL_ANGEL;
402 ir->gpio_addr = MO_GP2_IO;
403 ir->mask_keycode = 0x7e;
404 ir->polling = 100; /* ms */
408 if (NULL == ir_codes) {
413 /* init input device */
414 snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)", core->board.name);
415 snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
417 err = ir_input_init(input_dev, &ir->ir, ir_type);
421 input_dev->name = ir->name;
422 input_dev->phys = ir->phys;
423 input_dev->id.bustype = BUS_PCI;
424 input_dev->id.version = 1;
425 if (pci->subsystem_vendor) {
426 input_dev->id.vendor = pci->subsystem_vendor;
427 input_dev->id.product = pci->subsystem_device;
429 input_dev->id.vendor = pci->vendor;
430 input_dev->id.product = pci->device;
432 input_dev->dev.parent = &pci->dev;
433 /* record handles to ourself */
437 ir->props.priv = core;
438 ir->props.open = cx88_ir_open;
439 ir->props.close = cx88_ir_close;
442 err = ir_input_register(ir->input, ir_codes, &ir->props, MODULE_NAME);
454 int cx88_ir_fini(struct cx88_core *core)
456 struct cx88_IR *ir = core->ir;
458 /* skip detach on non attached boards */
463 ir_input_unregister(ir->input);
471 /* ---------------------------------------------------------------------- */
473 void cx88_ir_irq(struct cx88_core *core)
475 struct cx88_IR *ir = core->ir;
477 int i, start, range, toggle, dev, code;
484 samples = cx_read(MO_SAMPLE_IO);
485 if (0 != samples && 0xffffffff != samples) {
486 /* record sample data */
487 if (ir->scount < ARRAY_SIZE(ir->samples))
488 ir->samples[ir->scount++] = samples;
492 /* nothing to sample */
493 if (ir->ir.keypressed && time_after(jiffies, ir->release))
494 ir_input_nokey(ir->input, &ir->ir);
498 /* have a complete sample */
499 if (ir->scount < ARRAY_SIZE(ir->samples))
500 ir->samples[ir->scount++] = samples;
501 for (i = 0; i < ir->scount; i++)
502 ir->samples[i] = ~ir->samples[i];
504 ir_dump_samples(ir->samples, ir->scount);
507 switch (core->boardnr) {
508 case CX88_BOARD_TEVII_S460:
509 case CX88_BOARD_TEVII_S420:
510 case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
511 case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
512 case CX88_BOARD_OMICOM_SS4_PCI:
513 case CX88_BOARD_SATTRADE_ST4200:
514 case CX88_BOARD_TBS_8920:
515 case CX88_BOARD_TBS_8910:
516 case CX88_BOARD_PROF_7300:
517 case CX88_BOARD_PROF_7301:
518 case CX88_BOARD_PROF_6200:
519 ircode = ir_decode_pulsedistance(ir->samples, ir->scount, 1, 4);
521 if (ircode == 0xffffffff) { /* decoding error */
522 ir_dprintk("pulse distance decoding error\n");
526 ir_dprintk("pulse distance decoded: %x\n", ircode);
528 if (ircode == 0) { /* key still pressed */
529 ir_dprintk("pulse distance decoded repeat code\n");
530 ir->release = jiffies + msecs_to_jiffies(120);
534 if ((ircode & 0xffff) != (ir->sampling & 0xffff)) { /* wrong address */
535 ir_dprintk("pulse distance decoded wrong address\n");
539 if (((~ircode >> 24) & 0xff) != ((ircode >> 16) & 0xff)) { /* wrong checksum */
540 ir_dprintk("pulse distance decoded wrong check sum\n");
544 ir_dprintk("Key Code: %x\n", (ircode >> 16) & 0x7f);
546 ir_input_keydown(ir->input, &ir->ir, (ircode >> 16) & 0x7f);
547 ir->release = jiffies + msecs_to_jiffies(120);
549 case CX88_BOARD_HAUPPAUGE:
550 case CX88_BOARD_HAUPPAUGE_DVB_T1:
551 case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
552 case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
553 case CX88_BOARD_HAUPPAUGE_HVR1100:
554 case CX88_BOARD_HAUPPAUGE_HVR3000:
555 case CX88_BOARD_HAUPPAUGE_HVR4000:
556 case CX88_BOARD_HAUPPAUGE_HVR4000LITE:
557 case CX88_BOARD_PCHDTV_HD3000:
558 case CX88_BOARD_PCHDTV_HD5500:
559 case CX88_BOARD_HAUPPAUGE_IRONLY:
560 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
561 ir_dprintk("biphase decoded: %x\n", ircode);
563 * RC5 has an extension bit which adds a new range
564 * of available codes, this is detected here. Also
565 * hauppauge remotes (black/silver) always use
566 * specific device ids. If we do not filter the
567 * device ids then messages destined for devices
568 * such as TVs (id=0) will get through to the
569 * device causing mis-fired events.
571 /* split rc5 data block ... */
572 start = (ircode & 0x2000) >> 13;
573 range = (ircode & 0x1000) >> 12;
574 toggle= (ircode & 0x0800) >> 11;
575 dev = (ircode & 0x07c0) >> 6;
576 code = (ircode & 0x003f) | ((range << 6) ^ 0x0040);
580 if ( dev != 0x1e && dev != 0x1f )
581 /* not a hauppauge remote */
583 ir_input_keydown(ir->input, &ir->ir, code);
584 ir->release = jiffies + msecs_to_jiffies(120);
586 case CX88_BOARD_PINNACLE_PCTV_HD_800i:
587 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
588 ir_dprintk("biphase decoded: %x\n", ircode);
589 if ((ircode & 0xfffff000) != 0x3000)
591 ir_input_keydown(ir->input, &ir->ir, ircode & 0x3f);
592 ir->release = jiffies + msecs_to_jiffies(120);
600 /* ---------------------------------------------------------------------- */
602 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
603 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
604 MODULE_LICENSE("GPL");