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