8683d104de72a4113587bff03440d38749ce048b
[linux-2.6.git] / drivers / media / video / cx88 / cx88-input.c
1 /*
2  *
3  * Device driver for GPIO attached remote control interfaces
4  * on Conexant 2388x based TV/DVB cards.
5  *
6  * Copyright (c) 2003 Pavel Machek
7  * Copyright (c) 2004 Gerd Knorr
8  * Copyright (c) 2004, 2005 Chris Pascoe
9  *
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.
14  *
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.
19  *
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
23  */
24
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
31 #include "cx88.h"
32 #include <media/ir-common.h>
33
34 /* ---------------------------------------------------------------------- */
35
36 struct cx88_IR {
37         struct cx88_core *core;
38         struct input_dev *input;
39         struct ir_input_state ir;
40         char name[32];
41         char phys[32];
42
43         /* sample from gpio pin 16 */
44         u32 sampling;
45         u32 samples[16];
46         int scount;
47         unsigned long release;
48
49         /* poll external decoder */
50         int polling;
51         struct work_struct work;
52         struct timer_list timer;
53         u32 gpio_addr;
54         u32 last_gpio;
55         u32 mask_keycode;
56         u32 mask_keydown;
57         u32 mask_keyup;
58 };
59
60 static int ir_debug;
61 module_param(ir_debug, int, 0644);      /* debug level [IR] */
62 MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
63
64 #define ir_dprintk(fmt, arg...) if (ir_debug) \
65         printk(KERN_DEBUG "%s IR: " fmt , ir->core->name , ##arg)
66
67 /* ---------------------------------------------------------------------- */
68
69 static void cx88_ir_handle_key(struct cx88_IR *ir)
70 {
71         struct cx88_core *core = ir->core;
72         u32 gpio, data, auxgpio;
73
74         /* read gpio value */
75         gpio = cx_read(ir->gpio_addr);
76         switch (core->boardnr) {
77         case 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.
81
82                    Example:
83
84                    for key "5"
85                         gpio = 0x758, auxgpio = 0xe5 or 0xf5
86                    for key "Power"
87                         gpio = 0x758, auxgpio = 0xed or 0xfd
88                  */
89
90                 auxgpio = cx_read(MO_GP1_IO);
91                 /* Take out the parity part */
92                 gpio=(gpio & 0x7fd) + (auxgpio & 0xef);
93                 break;
94         case CX88_BOARD_WINFAST_DTV1000:
95                 gpio = (gpio & 0x6ff) | ((cx_read(MO_GP1_IO) << 8) & 0x900);
96                 auxgpio = gpio;
97                 break;
98         default:
99                 auxgpio = gpio;
100         }
101         if (ir->polling) {
102                 if (ir->last_gpio == auxgpio)
103                         return;
104                 ir->last_gpio = auxgpio;
105         }
106
107         /* extract data */
108         data = ir_extract_bits(gpio, ir->mask_keycode);
109         ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
110                    gpio, data,
111                    ir->polling ? "poll" : "irq",
112                    (gpio & ir->mask_keydown) ? " down" : "",
113                    (gpio & ir->mask_keyup) ? " up" : "");
114
115         if (ir->core->boardnr == CX88_BOARD_NORWOOD_MICRO) {
116                 u32 gpio_key = cx_read(MO_GP0_IO);
117
118                 data = (data << 4) | ((gpio_key & 0xf0) >> 4);
119
120                 ir_input_keydown(ir->input, &ir->ir, data, data);
121                 ir_input_nokey(ir->input, &ir->ir);
122
123         } else if (ir->mask_keydown) {
124                 /* bit set on keydown */
125                 if (gpio & ir->mask_keydown) {
126                         ir_input_keydown(ir->input, &ir->ir, data, data);
127                 } else {
128                         ir_input_nokey(ir->input, &ir->ir);
129                 }
130
131         } else if (ir->mask_keyup) {
132                 /* bit cleared on keydown */
133                 if (0 == (gpio & ir->mask_keyup)) {
134                         ir_input_keydown(ir->input, &ir->ir, data, data);
135                 } else {
136                         ir_input_nokey(ir->input, &ir->ir);
137                 }
138
139         } else {
140                 /* can't distinguish keydown/up :-/ */
141                 ir_input_keydown(ir->input, &ir->ir, data, data);
142                 ir_input_nokey(ir->input, &ir->ir);
143         }
144 }
145
146 static void ir_timer(unsigned long data)
147 {
148         struct cx88_IR *ir = (struct cx88_IR *)data;
149
150         schedule_work(&ir->work);
151 }
152
153 static void cx88_ir_work(struct work_struct *work)
154 {
155         struct cx88_IR *ir = container_of(work, struct cx88_IR, work);
156
157         cx88_ir_handle_key(ir);
158         mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling));
159 }
160
161 void cx88_ir_start(struct cx88_core *core, struct cx88_IR *ir)
162 {
163         if (ir->polling) {
164                 setup_timer(&ir->timer, ir_timer, (unsigned long)ir);
165                 INIT_WORK(&ir->work, cx88_ir_work);
166                 schedule_work(&ir->work);
167         }
168         if (ir->sampling) {
169                 core->pci_irqmask |= PCI_INT_IR_SMPINT;
170                 cx_write(MO_DDS_IO, 0xa80a80);  /* 4 kHz sample rate */
171                 cx_write(MO_DDSCFG_IO, 0x5);    /* enable */
172         }
173 }
174
175 void cx88_ir_stop(struct cx88_core *core, struct cx88_IR *ir)
176 {
177         if (ir->sampling) {
178                 cx_write(MO_DDSCFG_IO, 0x0);
179                 core->pci_irqmask &= ~PCI_INT_IR_SMPINT;
180         }
181
182         if (ir->polling) {
183                 del_timer_sync(&ir->timer);
184                 flush_scheduled_work();
185         }
186 }
187
188 /* ---------------------------------------------------------------------- */
189
190 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
191 {
192         struct cx88_IR *ir;
193         struct input_dev *input_dev;
194         IR_KEYTAB_TYPE *ir_codes = NULL;
195         int ir_type = IR_TYPE_OTHER;
196         int err = -ENOMEM;
197
198         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
199         input_dev = input_allocate_device();
200         if (!ir || !input_dev)
201                 goto err_out_free;
202
203         ir->input = input_dev;
204
205         /* detect & configure */
206         switch (core->boardnr) {
207         case CX88_BOARD_DNTV_LIVE_DVB_T:
208         case CX88_BOARD_KWORLD_DVB_T:
209         case CX88_BOARD_KWORLD_DVB_T_CX22702:
210                 ir_codes = ir_codes_dntv_live_dvb_t;
211                 ir->gpio_addr = MO_GP1_IO;
212                 ir->mask_keycode = 0x1f;
213                 ir->mask_keyup = 0x60;
214                 ir->polling = 50; /* ms */
215                 break;
216         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
217                 ir_codes = ir_codes_cinergy_1400;
218                 ir_type = IR_TYPE_PD;
219                 ir->sampling = 0xeb04; /* address */
220                 break;
221         case CX88_BOARD_HAUPPAUGE:
222         case CX88_BOARD_HAUPPAUGE_DVB_T1:
223         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
224         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
225         case CX88_BOARD_HAUPPAUGE_HVR1100:
226         case CX88_BOARD_HAUPPAUGE_HVR3000:
227         case CX88_BOARD_HAUPPAUGE_HVR4000:
228         case CX88_BOARD_HAUPPAUGE_HVR4000LITE:
229                 ir_codes = ir_codes_hauppauge_new;
230                 ir_type = IR_TYPE_RC5;
231                 ir->sampling = 1;
232                 break;
233         case CX88_BOARD_WINFAST_DTV2000H:
234                 ir_codes = ir_codes_winfast;
235                 ir->gpio_addr = MO_GP0_IO;
236                 ir->mask_keycode = 0x8f8;
237                 ir->mask_keyup = 0x100;
238                 ir->polling = 50; /* ms */
239                 break;
240         case CX88_BOARD_WINFAST2000XP_EXPERT:
241         case CX88_BOARD_WINFAST_DTV1000:
242                 ir_codes = ir_codes_winfast;
243                 ir->gpio_addr = MO_GP0_IO;
244                 ir->mask_keycode = 0x8f8;
245                 ir->mask_keyup = 0x100;
246                 ir->polling = 1; /* ms */
247                 break;
248         case CX88_BOARD_IODATA_GVBCTV7E:
249                 ir_codes = ir_codes_iodata_bctv7e;
250                 ir->gpio_addr = MO_GP0_IO;
251                 ir->mask_keycode = 0xfd;
252                 ir->mask_keydown = 0x02;
253                 ir->polling = 5; /* ms */
254                 break;
255         case CX88_BOARD_PROLINK_PLAYTVPVR:
256         case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
257                 ir_codes = ir_codes_pixelview;
258                 ir->gpio_addr = MO_GP1_IO;
259                 ir->mask_keycode = 0x1f;
260                 ir->mask_keyup = 0x80;
261                 ir->polling = 1; /* ms */
262                 break;
263         case CX88_BOARD_PROLINK_PV_8000GT:
264         case CX88_BOARD_PROLINK_PV_GLOBAL_XTREME:
265                 ir_codes = ir_codes_pixelview_new;
266                 ir->gpio_addr = MO_GP1_IO;
267                 ir->mask_keycode = 0x3f;
268                 ir->mask_keyup = 0x80;
269                 ir->polling = 1; /* ms */
270                 break;
271         case CX88_BOARD_KWORLD_LTV883:
272                 ir_codes = ir_codes_pixelview;
273                 ir->gpio_addr = MO_GP1_IO;
274                 ir->mask_keycode = 0x1f;
275                 ir->mask_keyup = 0x60;
276                 ir->polling = 1; /* ms */
277                 break;
278         case CX88_BOARD_ADSTECH_DVB_T_PCI:
279                 ir_codes = ir_codes_adstech_dvb_t_pci;
280                 ir->gpio_addr = MO_GP1_IO;
281                 ir->mask_keycode = 0xbf;
282                 ir->mask_keyup = 0x40;
283                 ir->polling = 50; /* ms */
284                 break;
285         case CX88_BOARD_MSI_TVANYWHERE_MASTER:
286                 ir_codes = ir_codes_msi_tvanywhere;
287                 ir->gpio_addr = MO_GP1_IO;
288                 ir->mask_keycode = 0x1f;
289                 ir->mask_keyup = 0x40;
290                 ir->polling = 1; /* ms */
291                 break;
292         case CX88_BOARD_AVERTV_303:
293         case CX88_BOARD_AVERTV_STUDIO_303:
294                 ir_codes         = ir_codes_avertv_303;
295                 ir->gpio_addr    = MO_GP2_IO;
296                 ir->mask_keycode = 0xfb;
297                 ir->mask_keydown = 0x02;
298                 ir->polling      = 50; /* ms */
299                 break;
300         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
301                 ir_codes = ir_codes_dntv_live_dvbt_pro;
302                 ir_type = IR_TYPE_PD;
303                 ir->sampling = 0xff00; /* address */
304                 break;
305         case CX88_BOARD_NORWOOD_MICRO:
306                 ir_codes         = ir_codes_norwood;
307                 ir->gpio_addr    = MO_GP1_IO;
308                 ir->mask_keycode = 0x0e;
309                 ir->mask_keyup   = 0x80;
310                 ir->polling      = 50; /* ms */
311                 break;
312         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
313                 ir_codes = ir_codes_npgtech;
314                 ir->gpio_addr = MO_GP0_IO;
315                 ir->mask_keycode = 0xfa;
316                 ir->polling = 50; /* ms */
317                 break;
318         case CX88_BOARD_PINNACLE_PCTV_HD_800i:
319                 ir_codes = ir_codes_pinnacle_pctv_hd;
320                 ir_type = IR_TYPE_RC5;
321                 ir->sampling = 1;
322                 break;
323         case CX88_BOARD_POWERCOLOR_REAL_ANGEL:
324                 ir_codes = ir_codes_powercolor_real_angel;
325                 ir->gpio_addr = MO_GP2_IO;
326                 ir->mask_keycode = 0x7e;
327                 ir->polling = 100; /* ms */
328                 break;
329         }
330
331         if (NULL == ir_codes) {
332                 err = -ENODEV;
333                 goto err_out_free;
334         }
335
336         /* init input device */
337         snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)", core->board.name);
338         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
339
340         ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
341         input_dev->name = ir->name;
342         input_dev->phys = ir->phys;
343         input_dev->id.bustype = BUS_PCI;
344         input_dev->id.version = 1;
345         if (pci->subsystem_vendor) {
346                 input_dev->id.vendor = pci->subsystem_vendor;
347                 input_dev->id.product = pci->subsystem_device;
348         } else {
349                 input_dev->id.vendor = pci->vendor;
350                 input_dev->id.product = pci->device;
351         }
352         input_dev->dev.parent = &pci->dev;
353         /* record handles to ourself */
354         ir->core = core;
355         core->ir = ir;
356
357         cx88_ir_start(core, ir);
358
359         /* all done */
360         err = input_register_device(ir->input);
361         if (err)
362                 goto err_out_stop;
363
364         return 0;
365
366  err_out_stop:
367         cx88_ir_stop(core, ir);
368         core->ir = NULL;
369  err_out_free:
370         input_free_device(input_dev);
371         kfree(ir);
372         return err;
373 }
374
375 int cx88_ir_fini(struct cx88_core *core)
376 {
377         struct cx88_IR *ir = core->ir;
378
379         /* skip detach on non attached boards */
380         if (NULL == ir)
381                 return 0;
382
383         cx88_ir_stop(core, ir);
384         input_unregister_device(ir->input);
385         kfree(ir);
386
387         /* done */
388         core->ir = NULL;
389         return 0;
390 }
391
392 /* ---------------------------------------------------------------------- */
393
394 void cx88_ir_irq(struct cx88_core *core)
395 {
396         struct cx88_IR *ir = core->ir;
397         u32 samples, ircode;
398         int i, start, range, toggle, dev, code;
399
400         if (NULL == ir)
401                 return;
402         if (!ir->sampling)
403                 return;
404
405         samples = cx_read(MO_SAMPLE_IO);
406         if (0 != samples && 0xffffffff != samples) {
407                 /* record sample data */
408                 if (ir->scount < ARRAY_SIZE(ir->samples))
409                         ir->samples[ir->scount++] = samples;
410                 return;
411         }
412         if (!ir->scount) {
413                 /* nothing to sample */
414                 if (ir->ir.keypressed && time_after(jiffies, ir->release))
415                         ir_input_nokey(ir->input, &ir->ir);
416                 return;
417         }
418
419         /* have a complete sample */
420         if (ir->scount < ARRAY_SIZE(ir->samples))
421                 ir->samples[ir->scount++] = samples;
422         for (i = 0; i < ir->scount; i++)
423                 ir->samples[i] = ~ir->samples[i];
424         if (ir_debug)
425                 ir_dump_samples(ir->samples, ir->scount);
426
427         /* decode it */
428         switch (core->boardnr) {
429         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
430         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
431                 ircode = ir_decode_pulsedistance(ir->samples, ir->scount, 1, 4);
432
433                 if (ircode == 0xffffffff) { /* decoding error */
434                         ir_dprintk("pulse distance decoding error\n");
435                         break;
436                 }
437
438                 ir_dprintk("pulse distance decoded: %x\n", ircode);
439
440                 if (ircode == 0) { /* key still pressed */
441                         ir_dprintk("pulse distance decoded repeat code\n");
442                         ir->release = jiffies + msecs_to_jiffies(120);
443                         break;
444                 }
445
446                 if ((ircode & 0xffff) != (ir->sampling & 0xffff)) { /* wrong address */
447                         ir_dprintk("pulse distance decoded wrong address\n");
448                         break;
449                 }
450
451                 if (((~ircode >> 24) & 0xff) != ((ircode >> 16) & 0xff)) { /* wrong checksum */
452                         ir_dprintk("pulse distance decoded wrong check sum\n");
453                         break;
454                 }
455
456                 ir_dprintk("Key Code: %x\n", (ircode >> 16) & 0x7f);
457
458                 ir_input_keydown(ir->input, &ir->ir, (ircode >> 16) & 0x7f, (ircode >> 16) & 0xff);
459                 ir->release = jiffies + msecs_to_jiffies(120);
460                 break;
461         case CX88_BOARD_HAUPPAUGE:
462         case CX88_BOARD_HAUPPAUGE_DVB_T1:
463         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
464         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
465         case CX88_BOARD_HAUPPAUGE_HVR1100:
466         case CX88_BOARD_HAUPPAUGE_HVR3000:
467         case CX88_BOARD_HAUPPAUGE_HVR4000:
468         case CX88_BOARD_HAUPPAUGE_HVR4000LITE:
469                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
470                 ir_dprintk("biphase decoded: %x\n", ircode);
471                 /*
472                  * RC5 has an extension bit which adds a new range
473                  * of available codes, this is detected here. Also
474                  * hauppauge remotes (black/silver) always use
475                  * specific device ids. If we do not filter the
476                  * device ids then messages destined for devices
477                  * such as TVs (id=0) will get through to the
478                  * device causing mis-fired events.
479                  */
480                 /* split rc5 data block ... */
481                 start = (ircode & 0x2000) >> 13;
482                 range = (ircode & 0x1000) >> 12;
483                 toggle= (ircode & 0x0800) >> 11;
484                 dev   = (ircode & 0x07c0) >> 6;
485                 code  = (ircode & 0x003f) | ((range << 6) ^ 0x0040);
486                 if( start != 1)
487                         /* no key pressed */
488                         break;
489                 if ( dev != 0x1e && dev != 0x1f )
490                         /* not a hauppauge remote */
491                         break;
492                 ir_input_keydown(ir->input, &ir->ir, code, ircode);
493                 ir->release = jiffies + msecs_to_jiffies(120);
494                 break;
495         case CX88_BOARD_PINNACLE_PCTV_HD_800i:
496                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
497                 ir_dprintk("biphase decoded: %x\n", ircode);
498                 if ((ircode & 0xfffff000) != 0x3000)
499                         break;
500                 ir_input_keydown(ir->input, &ir->ir, ircode & 0x3f, ircode);
501                 ir->release = jiffies + msecs_to_jiffies(120);
502                 break;
503         }
504
505         ir->scount = 0;
506         return;
507 }
508
509 /* ---------------------------------------------------------------------- */
510
511 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
512 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
513 MODULE_LICENSE("GPL");
514 /*
515  * Local variables:
516  * c-basic-offset: 8
517  * End:
518  */