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/delay.h>
27 #include <linux/input.h>
28 #include <linux/pci.h>
29 #include <linux/module.h>
30 #include <linux/moduleparam.h>
33 #include <media/ir-common.h>
35 /* ---------------------------------------------------------------------- */
38 struct cx88_core *core;
39 struct input_dev *input;
40 struct ir_input_state ir;
44 /* sample from gpio pin 16 */
48 unsigned long release;
50 /* poll external decoder */
52 struct work_struct work;
53 struct timer_list timer;
61 static int ir_debug = 0;
62 module_param(ir_debug, int, 0644); /* debug level [IR] */
63 MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
65 #define ir_dprintk(fmt, arg...) if (ir_debug) \
66 printk(KERN_DEBUG "%s IR: " fmt , ir->core->name , ##arg)
68 /* ---------------------------------------------------------------------- */
70 static void cx88_ir_handle_key(struct cx88_IR *ir)
72 struct cx88_core *core = ir->core;
73 u32 gpio, data, auxgpio;
76 gpio = cx_read(ir->gpio_addr);
77 if (core->board == CX88_BOARD_NPGTECH_REALTV_TOP10FM) {
78 /* This board apparently uses a combination of 2 GPIO
79 to represent the keys. Additionally, the second GPIO
80 can be used for parity.
85 gpio = 0x758, auxgpio = 0xe5 or 0xf5
87 gpio = 0x758, auxgpio = 0xed or 0xfd
90 auxgpio = cx_read(MO_GP1_IO);
91 /* Take out the parity part */
92 gpio=(gpio & 0x7fd) + (auxgpio & 0xef);
97 if (ir->last_gpio == auxgpio)
99 ir->last_gpio = auxgpio;
103 data = ir_extract_bits(gpio, ir->mask_keycode);
104 ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
106 ir->polling ? "poll" : "irq",
107 (gpio & ir->mask_keydown) ? " down" : "",
108 (gpio & ir->mask_keyup) ? " up" : "");
110 if (ir->core->board == CX88_BOARD_NORWOOD_MICRO) {
111 u32 gpio_key = cx_read(MO_GP0_IO);
113 data = (data << 4) | ((gpio_key & 0xf0) >> 4);
115 ir_input_keydown(ir->input, &ir->ir, data, data);
116 ir_input_nokey(ir->input, &ir->ir);
118 } else if (ir->mask_keydown) {
119 /* bit set on keydown */
120 if (gpio & ir->mask_keydown) {
121 ir_input_keydown(ir->input, &ir->ir, data, data);
123 ir_input_nokey(ir->input, &ir->ir);
126 } else if (ir->mask_keyup) {
127 /* bit cleared on keydown */
128 if (0 == (gpio & ir->mask_keyup)) {
129 ir_input_keydown(ir->input, &ir->ir, data, data);
131 ir_input_nokey(ir->input, &ir->ir);
135 /* can't distinguish keydown/up :-/ */
136 ir_input_keydown(ir->input, &ir->ir, data, data);
137 ir_input_nokey(ir->input, &ir->ir);
141 static void ir_timer(unsigned long data)
143 struct cx88_IR *ir = (struct cx88_IR *)data;
145 schedule_work(&ir->work);
148 static void cx88_ir_work(struct work_struct *work)
150 struct cx88_IR *ir = container_of(work, struct cx88_IR, work);
151 unsigned long timeout;
153 cx88_ir_handle_key(ir);
154 timeout = jiffies + (ir->polling * HZ / 1000);
155 mod_timer(&ir->timer, timeout);
158 static void cx88_ir_start(struct cx88_core *core, struct cx88_IR *ir)
161 INIT_WORK(&ir->work, cx88_ir_work);
162 init_timer(&ir->timer);
163 ir->timer.function = ir_timer;
164 ir->timer.data = (unsigned long)ir;
165 schedule_work(&ir->work);
168 core->pci_irqmask |= (1 << 18); /* IR_SMP_INT */
169 cx_write(MO_DDS_IO, 0xa80a80); /* 4 kHz sample rate */
170 cx_write(MO_DDSCFG_IO, 0x5); /* enable */
174 static void cx88_ir_stop(struct cx88_core *core, struct cx88_IR *ir)
177 cx_write(MO_DDSCFG_IO, 0x0);
178 core->pci_irqmask &= ~(1 << 18);
182 del_timer_sync(&ir->timer);
183 flush_scheduled_work();
187 /* ---------------------------------------------------------------------- */
189 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
192 struct input_dev *input_dev;
193 IR_KEYTAB_TYPE *ir_codes = NULL;
194 int ir_type = IR_TYPE_OTHER;
197 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
198 input_dev = input_allocate_device();
199 if (!ir || !input_dev)
202 ir->input = input_dev;
204 /* detect & configure */
205 switch (core->board) {
206 case CX88_BOARD_DNTV_LIVE_DVB_T:
207 case CX88_BOARD_KWORLD_DVB_T:
208 case CX88_BOARD_KWORLD_DVB_T_CX22702:
209 ir_codes = ir_codes_dntv_live_dvb_t;
210 ir->gpio_addr = MO_GP1_IO;
211 ir->mask_keycode = 0x1f;
212 ir->mask_keyup = 0x60;
213 ir->polling = 50; /* ms */
215 case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
216 ir_codes = ir_codes_cinergy_1400;
217 ir_type = IR_TYPE_PD;
218 ir->sampling = 0xeb04; /* address */
220 case CX88_BOARD_HAUPPAUGE:
221 case CX88_BOARD_HAUPPAUGE_DVB_T1:
222 case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
223 case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
224 case CX88_BOARD_HAUPPAUGE_HVR1100:
225 case CX88_BOARD_HAUPPAUGE_HVR1300:
226 case CX88_BOARD_HAUPPAUGE_HVR3000:
227 ir_codes = ir_codes_hauppauge_new;
228 ir_type = IR_TYPE_RC5;
231 case CX88_BOARD_WINFAST_DTV2000H:
232 ir_codes = ir_codes_winfast;
233 ir->gpio_addr = MO_GP0_IO;
234 ir->mask_keycode = 0x8f8;
235 ir->mask_keyup = 0x100;
236 ir->polling = 50; /* ms */
238 case CX88_BOARD_WINFAST2000XP_EXPERT:
239 ir_codes = ir_codes_winfast;
240 ir->gpio_addr = MO_GP0_IO;
241 ir->mask_keycode = 0x8f8;
242 ir->mask_keyup = 0x100;
243 ir->polling = 1; /* ms */
245 case CX88_BOARD_IODATA_GVBCTV7E:
246 ir_codes = ir_codes_iodata_bctv7e;
247 ir->gpio_addr = MO_GP0_IO;
248 ir->mask_keycode = 0xfd;
249 ir->mask_keydown = 0x02;
250 ir->polling = 5; /* ms */
252 case CX88_BOARD_PROLINK_PLAYTVPVR:
253 case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
254 ir_codes = ir_codes_pixelview;
255 ir->gpio_addr = MO_GP1_IO;
256 ir->mask_keycode = 0x1f;
257 ir->mask_keyup = 0x80;
258 ir->polling = 1; /* ms */
260 case CX88_BOARD_KWORLD_LTV883:
261 ir_codes = ir_codes_pixelview;
262 ir->gpio_addr = MO_GP1_IO;
263 ir->mask_keycode = 0x1f;
264 ir->mask_keyup = 0x60;
265 ir->polling = 1; /* ms */
267 case CX88_BOARD_ADSTECH_DVB_T_PCI:
268 ir_codes = ir_codes_adstech_dvb_t_pci;
269 ir->gpio_addr = MO_GP1_IO;
270 ir->mask_keycode = 0xbf;
271 ir->mask_keyup = 0x40;
272 ir->polling = 50; /* ms */
274 case CX88_BOARD_MSI_TVANYWHERE_MASTER:
275 ir_codes = ir_codes_msi_tvanywhere;
276 ir->gpio_addr = MO_GP1_IO;
277 ir->mask_keycode = 0x1f;
278 ir->mask_keyup = 0x40;
279 ir->polling = 1; /* ms */
281 case CX88_BOARD_AVERTV_303:
282 case CX88_BOARD_AVERTV_STUDIO_303:
283 ir_codes = ir_codes_avertv_303;
284 ir->gpio_addr = MO_GP2_IO;
285 ir->mask_keycode = 0xfb;
286 ir->mask_keydown = 0x02;
287 ir->polling = 50; /* ms */
289 case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
290 ir_codes = ir_codes_dntv_live_dvbt_pro;
291 ir_type = IR_TYPE_PD;
292 ir->sampling = 0xff00; /* address */
294 case CX88_BOARD_NORWOOD_MICRO:
295 ir_codes = ir_codes_norwood;
296 ir->gpio_addr = MO_GP1_IO;
297 ir->mask_keycode = 0x0e;
298 ir->mask_keyup = 0x80;
299 ir->polling = 50; /* ms */
301 case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
302 ir_codes = ir_codes_npgtech;
303 ir->gpio_addr = MO_GP0_IO;
304 ir->mask_keycode = 0xfa;
305 ir->polling = 50; /* ms */
309 if (NULL == ir_codes) {
314 /* init input device */
315 snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)",
316 cx88_boards[core->board].name);
317 snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
319 ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
320 input_dev->name = ir->name;
321 input_dev->phys = ir->phys;
322 input_dev->id.bustype = BUS_PCI;
323 input_dev->id.version = 1;
324 if (pci->subsystem_vendor) {
325 input_dev->id.vendor = pci->subsystem_vendor;
326 input_dev->id.product = pci->subsystem_device;
328 input_dev->id.vendor = pci->vendor;
329 input_dev->id.product = pci->device;
331 input_dev->cdev.dev = &pci->dev;
332 /* record handles to ourself */
336 cx88_ir_start(core, ir);
339 err = input_register_device(ir->input);
346 cx88_ir_stop(core, ir);
349 input_free_device(input_dev);
354 int cx88_ir_fini(struct cx88_core *core)
356 struct cx88_IR *ir = core->ir;
358 /* skip detach on non attached boards */
362 cx88_ir_stop(core, ir);
363 input_unregister_device(ir->input);
371 /* ---------------------------------------------------------------------- */
373 void cx88_ir_irq(struct cx88_core *core)
375 struct cx88_IR *ir = core->ir;
384 samples = cx_read(MO_SAMPLE_IO);
385 if (0 != samples && 0xffffffff != samples) {
386 /* record sample data */
387 if (ir->scount < ARRAY_SIZE(ir->samples))
388 ir->samples[ir->scount++] = samples;
392 /* nothing to sample */
393 if (ir->ir.keypressed && time_after(jiffies, ir->release))
394 ir_input_nokey(ir->input, &ir->ir);
398 /* have a complete sample */
399 if (ir->scount < ARRAY_SIZE(ir->samples))
400 ir->samples[ir->scount++] = samples;
401 for (i = 0; i < ir->scount; i++)
402 ir->samples[i] = ~ir->samples[i];
404 ir_dump_samples(ir->samples, ir->scount);
407 switch (core->board) {
408 case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
409 case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
410 ircode = ir_decode_pulsedistance(ir->samples, ir->scount, 1, 4);
412 if (ircode == 0xffffffff) { /* decoding error */
413 ir_dprintk("pulse distance decoding error\n");
417 ir_dprintk("pulse distance decoded: %x\n", ircode);
419 if (ircode == 0) { /* key still pressed */
420 ir_dprintk("pulse distance decoded repeat code\n");
421 ir->release = jiffies + msecs_to_jiffies(120);
425 if ((ircode & 0xffff) != (ir->sampling & 0xffff)) { /* wrong address */
426 ir_dprintk("pulse distance decoded wrong address\n");
430 if (((~ircode >> 24) & 0xff) != ((ircode >> 16) & 0xff)) { /* wrong checksum */
431 ir_dprintk("pulse distance decoded wrong check sum\n");
435 ir_dprintk("Key Code: %x\n", (ircode >> 16) & 0x7f);
437 ir_input_keydown(ir->input, &ir->ir, (ircode >> 16) & 0x7f, (ircode >> 16) & 0xff);
438 ir->release = jiffies + msecs_to_jiffies(120);
440 case CX88_BOARD_HAUPPAUGE:
441 case CX88_BOARD_HAUPPAUGE_DVB_T1:
442 case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
443 case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
444 case CX88_BOARD_HAUPPAUGE_HVR1100:
445 case CX88_BOARD_HAUPPAUGE_HVR1300:
446 case CX88_BOARD_HAUPPAUGE_HVR3000:
447 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
448 ir_dprintk("biphase decoded: %x\n", ircode);
449 if ((ircode & 0xfffff000) != 0x3000)
451 ir_input_keydown(ir->input, &ir->ir, ircode & 0x3f, ircode);
452 ir->release = jiffies + msecs_to_jiffies(120);
460 /* ---------------------------------------------------------------------- */
462 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
463 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
464 MODULE_LICENSE("GPL");