Merge master.kernel.org:/home/rmk/linux-2.6-arm
[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 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 = 0;
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                 ir_codes = ir_codes_hauppauge_new;
228                 ir_type = IR_TYPE_RC5;
229                 ir->sampling = 1;
230                 break;
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 */
237                 break;
238         case CX88_BOARD_WINFAST2000XP_EXPERT:
239         case CX88_BOARD_WINFAST_DTV1000:
240                 ir_codes = ir_codes_winfast;
241                 ir->gpio_addr = MO_GP0_IO;
242                 ir->mask_keycode = 0x8f8;
243                 ir->mask_keyup = 0x100;
244                 ir->polling = 1; /* ms */
245                 break;
246         case CX88_BOARD_IODATA_GVBCTV7E:
247                 ir_codes = ir_codes_iodata_bctv7e;
248                 ir->gpio_addr = MO_GP0_IO;
249                 ir->mask_keycode = 0xfd;
250                 ir->mask_keydown = 0x02;
251                 ir->polling = 5; /* ms */
252                 break;
253         case CX88_BOARD_PROLINK_PLAYTVPVR:
254         case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
255                 ir_codes = ir_codes_pixelview;
256                 ir->gpio_addr = MO_GP1_IO;
257                 ir->mask_keycode = 0x1f;
258                 ir->mask_keyup = 0x80;
259                 ir->polling = 1; /* ms */
260                 break;
261         case CX88_BOARD_KWORLD_LTV883:
262                 ir_codes = ir_codes_pixelview;
263                 ir->gpio_addr = MO_GP1_IO;
264                 ir->mask_keycode = 0x1f;
265                 ir->mask_keyup = 0x60;
266                 ir->polling = 1; /* ms */
267                 break;
268         case CX88_BOARD_ADSTECH_DVB_T_PCI:
269                 ir_codes = ir_codes_adstech_dvb_t_pci;
270                 ir->gpio_addr = MO_GP1_IO;
271                 ir->mask_keycode = 0xbf;
272                 ir->mask_keyup = 0x40;
273                 ir->polling = 50; /* ms */
274                 break;
275         case CX88_BOARD_MSI_TVANYWHERE_MASTER:
276                 ir_codes = ir_codes_msi_tvanywhere;
277                 ir->gpio_addr = MO_GP1_IO;
278                 ir->mask_keycode = 0x1f;
279                 ir->mask_keyup = 0x40;
280                 ir->polling = 1; /* ms */
281                 break;
282         case CX88_BOARD_AVERTV_303:
283         case CX88_BOARD_AVERTV_STUDIO_303:
284                 ir_codes         = ir_codes_avertv_303;
285                 ir->gpio_addr    = MO_GP2_IO;
286                 ir->mask_keycode = 0xfb;
287                 ir->mask_keydown = 0x02;
288                 ir->polling      = 50; /* ms */
289                 break;
290         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
291                 ir_codes = ir_codes_dntv_live_dvbt_pro;
292                 ir_type = IR_TYPE_PD;
293                 ir->sampling = 0xff00; /* address */
294                 break;
295         case CX88_BOARD_NORWOOD_MICRO:
296                 ir_codes         = ir_codes_norwood;
297                 ir->gpio_addr    = MO_GP1_IO;
298                 ir->mask_keycode = 0x0e;
299                 ir->mask_keyup   = 0x80;
300                 ir->polling      = 50; /* ms */
301                 break;
302         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
303                 ir_codes = ir_codes_npgtech;
304                 ir->gpio_addr = MO_GP0_IO;
305                 ir->mask_keycode = 0xfa;
306                 ir->polling = 50; /* ms */
307                 break;
308         }
309
310         if (NULL == ir_codes) {
311                 err = -ENODEV;
312                 goto err_out_free;
313         }
314
315         /* init input device */
316         snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)", core->board.name);
317         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
318
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;
327         } else {
328                 input_dev->id.vendor = pci->vendor;
329                 input_dev->id.product = pci->device;
330         }
331         input_dev->dev.parent = &pci->dev;
332         /* record handles to ourself */
333         ir->core = core;
334         core->ir = ir;
335
336         cx88_ir_start(core, ir);
337
338         /* all done */
339         err = input_register_device(ir->input);
340         if (err)
341                 goto err_out_stop;
342
343         return 0;
344
345  err_out_stop:
346         cx88_ir_stop(core, ir);
347         core->ir = NULL;
348  err_out_free:
349         input_free_device(input_dev);
350         kfree(ir);
351         return err;
352 }
353
354 int cx88_ir_fini(struct cx88_core *core)
355 {
356         struct cx88_IR *ir = core->ir;
357
358         /* skip detach on non attached boards */
359         if (NULL == ir)
360                 return 0;
361
362         cx88_ir_stop(core, ir);
363         input_unregister_device(ir->input);
364         kfree(ir);
365
366         /* done */
367         core->ir = NULL;
368         return 0;
369 }
370
371 /* ---------------------------------------------------------------------- */
372
373 void cx88_ir_irq(struct cx88_core *core)
374 {
375         struct cx88_IR *ir = core->ir;
376         u32 samples, ircode;
377         int i;
378
379         if (NULL == ir)
380                 return;
381         if (!ir->sampling)
382                 return;
383
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;
389                 return;
390         }
391         if (!ir->scount) {
392                 /* nothing to sample */
393                 if (ir->ir.keypressed && time_after(jiffies, ir->release))
394                         ir_input_nokey(ir->input, &ir->ir);
395                 return;
396         }
397
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];
403         if (ir_debug)
404                 ir_dump_samples(ir->samples, ir->scount);
405
406         /* decode it */
407         switch (core->boardnr) {
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);
411
412                 if (ircode == 0xffffffff) { /* decoding error */
413                         ir_dprintk("pulse distance decoding error\n");
414                         break;
415                 }
416
417                 ir_dprintk("pulse distance decoded: %x\n", ircode);
418
419                 if (ircode == 0) { /* key still pressed */
420                         ir_dprintk("pulse distance decoded repeat code\n");
421                         ir->release = jiffies + msecs_to_jiffies(120);
422                         break;
423                 }
424
425                 if ((ircode & 0xffff) != (ir->sampling & 0xffff)) { /* wrong address */
426                         ir_dprintk("pulse distance decoded wrong address\n");
427                         break;
428                 }
429
430                 if (((~ircode >> 24) & 0xff) != ((ircode >> 16) & 0xff)) { /* wrong checksum */
431                         ir_dprintk("pulse distance decoded wrong check sum\n");
432                         break;
433                 }
434
435                 ir_dprintk("Key Code: %x\n", (ircode >> 16) & 0x7f);
436
437                 ir_input_keydown(ir->input, &ir->ir, (ircode >> 16) & 0x7f, (ircode >> 16) & 0xff);
438                 ir->release = jiffies + msecs_to_jiffies(120);
439                 break;
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_HVR3000:
446                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
447                 ir_dprintk("biphase decoded: %x\n", ircode);
448                 if ((ircode & 0xfffff000) != 0x3000)
449                         break;
450                 ir_input_keydown(ir->input, &ir->ir, ircode & 0x3f, ircode);
451                 ir->release = jiffies + msecs_to_jiffies(120);
452                 break;
453         }
454
455         ir->scount = 0;
456         return;
457 }
458
459 /* ---------------------------------------------------------------------- */
460
461 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
462 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
463 MODULE_LICENSE("GPL");
464 /*
465  * Local variables:
466  * c-basic-offset: 8
467  * End:
468  */