V4L/DVB (5683): V4L: cx88 - switch to using msecs_to_jiffies()
[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 #include <linux/moduleparam.h>
31
32 #include "cx88.h"
33 #include <media/ir-common.h>
34
35 /* ---------------------------------------------------------------------- */
36
37 struct cx88_IR {
38         struct cx88_core *core;
39         struct input_dev *input;
40         struct ir_input_state ir;
41         char name[32];
42         char phys[32];
43
44         /* sample from gpio pin 16 */
45         u32 sampling;
46         u32 samples[16];
47         int scount;
48         unsigned long release;
49
50         /* poll external decoder */
51         int polling;
52         struct work_struct work;
53         struct timer_list timer;
54         u32 gpio_addr;
55         u32 last_gpio;
56         u32 mask_keycode;
57         u32 mask_keydown;
58         u32 mask_keyup;
59 };
60
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]");
64
65 #define ir_dprintk(fmt, arg...) if (ir_debug) \
66         printk(KERN_DEBUG "%s IR: " fmt , ir->core->name , ##arg)
67
68 /* ---------------------------------------------------------------------- */
69
70 static void cx88_ir_handle_key(struct cx88_IR *ir)
71 {
72         struct cx88_core *core = ir->core;
73         u32 gpio, data, auxgpio;
74
75         /* read gpio value */
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.
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         } else
94                 auxgpio = gpio;
95
96         if (ir->polling) {
97                 if (ir->last_gpio == auxgpio)
98                         return;
99                 ir->last_gpio = auxgpio;
100         }
101
102         /* extract data */
103         data = ir_extract_bits(gpio, ir->mask_keycode);
104         ir_dprintk("irq gpio=0x%x code=%d | %s%s%s\n",
105                    gpio, data,
106                    ir->polling ? "poll" : "irq",
107                    (gpio & ir->mask_keydown) ? " down" : "",
108                    (gpio & ir->mask_keyup) ? " up" : "");
109
110         if (ir->core->board == CX88_BOARD_NORWOOD_MICRO) {
111                 u32 gpio_key = cx_read(MO_GP0_IO);
112
113                 data = (data << 4) | ((gpio_key & 0xf0) >> 4);
114
115                 ir_input_keydown(ir->input, &ir->ir, data, data);
116                 ir_input_nokey(ir->input, &ir->ir);
117
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);
122                 } else {
123                         ir_input_nokey(ir->input, &ir->ir);
124                 }
125
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);
130                 } else {
131                         ir_input_nokey(ir->input, &ir->ir);
132                 }
133
134         } else {
135                 /* can't distinguish keydown/up :-/ */
136                 ir_input_keydown(ir->input, &ir->ir, data, data);
137                 ir_input_nokey(ir->input, &ir->ir);
138         }
139 }
140
141 static void ir_timer(unsigned long data)
142 {
143         struct cx88_IR *ir = (struct cx88_IR *)data;
144
145         schedule_work(&ir->work);
146 }
147
148 static void cx88_ir_work(struct work_struct *work)
149 {
150         struct cx88_IR *ir = container_of(work, struct cx88_IR, work);
151
152         cx88_ir_handle_key(ir);
153         mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling));
154 }
155
156 static void cx88_ir_start(struct cx88_core *core, struct cx88_IR *ir)
157 {
158         if (ir->polling) {
159                 setup_timer(&ir->timer, ir_timer, (unsigned long)ir);
160                 INIT_WORK(&ir->work, cx88_ir_work);
161                 schedule_work(&ir->work);
162         }
163         if (ir->sampling) {
164                 core->pci_irqmask |= (1 << 18); /* IR_SMP_INT */
165                 cx_write(MO_DDS_IO, 0xa80a80);  /* 4 kHz sample rate */
166                 cx_write(MO_DDSCFG_IO, 0x5);    /* enable */
167         }
168 }
169
170 static void cx88_ir_stop(struct cx88_core *core, struct cx88_IR *ir)
171 {
172         if (ir->sampling) {
173                 cx_write(MO_DDSCFG_IO, 0x0);
174                 core->pci_irqmask &= ~(1 << 18);
175         }
176
177         if (ir->polling) {
178                 del_timer_sync(&ir->timer);
179                 flush_scheduled_work();
180         }
181 }
182
183 /* ---------------------------------------------------------------------- */
184
185 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
186 {
187         struct cx88_IR *ir;
188         struct input_dev *input_dev;
189         IR_KEYTAB_TYPE *ir_codes = NULL;
190         int ir_type = IR_TYPE_OTHER;
191         int err = -ENOMEM;
192
193         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
194         input_dev = input_allocate_device();
195         if (!ir || !input_dev)
196                 goto err_out_free;
197
198         ir->input = input_dev;
199
200         /* detect & configure */
201         switch (core->board) {
202         case CX88_BOARD_DNTV_LIVE_DVB_T:
203         case CX88_BOARD_KWORLD_DVB_T:
204         case CX88_BOARD_KWORLD_DVB_T_CX22702:
205                 ir_codes = ir_codes_dntv_live_dvb_t;
206                 ir->gpio_addr = MO_GP1_IO;
207                 ir->mask_keycode = 0x1f;
208                 ir->mask_keyup = 0x60;
209                 ir->polling = 50; /* ms */
210                 break;
211         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
212                 ir_codes = ir_codes_cinergy_1400;
213                 ir_type = IR_TYPE_PD;
214                 ir->sampling = 0xeb04; /* address */
215                 break;
216         case CX88_BOARD_HAUPPAUGE:
217         case CX88_BOARD_HAUPPAUGE_DVB_T1:
218         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
219         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
220         case CX88_BOARD_HAUPPAUGE_HVR1100:
221         case CX88_BOARD_HAUPPAUGE_HVR1300:
222         case CX88_BOARD_HAUPPAUGE_HVR3000:
223                 ir_codes = ir_codes_hauppauge_new;
224                 ir_type = IR_TYPE_RC5;
225                 ir->sampling = 1;
226                 break;
227         case CX88_BOARD_WINFAST_DTV2000H:
228                 ir_codes = ir_codes_winfast;
229                 ir->gpio_addr = MO_GP0_IO;
230                 ir->mask_keycode = 0x8f8;
231                 ir->mask_keyup = 0x100;
232                 ir->polling = 50; /* ms */
233                 break;
234         case CX88_BOARD_WINFAST2000XP_EXPERT:
235                 ir_codes = ir_codes_winfast;
236                 ir->gpio_addr = MO_GP0_IO;
237                 ir->mask_keycode = 0x8f8;
238                 ir->mask_keyup = 0x100;
239                 ir->polling = 1; /* ms */
240                 break;
241         case CX88_BOARD_IODATA_GVBCTV7E:
242                 ir_codes = ir_codes_iodata_bctv7e;
243                 ir->gpio_addr = MO_GP0_IO;
244                 ir->mask_keycode = 0xfd;
245                 ir->mask_keydown = 0x02;
246                 ir->polling = 5; /* ms */
247                 break;
248         case CX88_BOARD_PROLINK_PLAYTVPVR:
249         case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
250                 ir_codes = ir_codes_pixelview;
251                 ir->gpio_addr = MO_GP1_IO;
252                 ir->mask_keycode = 0x1f;
253                 ir->mask_keyup = 0x80;
254                 ir->polling = 1; /* ms */
255                 break;
256         case CX88_BOARD_KWORLD_LTV883:
257                 ir_codes = ir_codes_pixelview;
258                 ir->gpio_addr = MO_GP1_IO;
259                 ir->mask_keycode = 0x1f;
260                 ir->mask_keyup = 0x60;
261                 ir->polling = 1; /* ms */
262                 break;
263         case CX88_BOARD_ADSTECH_DVB_T_PCI:
264                 ir_codes = ir_codes_adstech_dvb_t_pci;
265                 ir->gpio_addr = MO_GP1_IO;
266                 ir->mask_keycode = 0xbf;
267                 ir->mask_keyup = 0x40;
268                 ir->polling = 50; /* ms */
269                 break;
270         case CX88_BOARD_MSI_TVANYWHERE_MASTER:
271                 ir_codes = ir_codes_msi_tvanywhere;
272                 ir->gpio_addr = MO_GP1_IO;
273                 ir->mask_keycode = 0x1f;
274                 ir->mask_keyup = 0x40;
275                 ir->polling = 1; /* ms */
276                 break;
277         case CX88_BOARD_AVERTV_303:
278         case CX88_BOARD_AVERTV_STUDIO_303:
279                 ir_codes         = ir_codes_avertv_303;
280                 ir->gpio_addr    = MO_GP2_IO;
281                 ir->mask_keycode = 0xfb;
282                 ir->mask_keydown = 0x02;
283                 ir->polling      = 50; /* ms */
284                 break;
285         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
286                 ir_codes = ir_codes_dntv_live_dvbt_pro;
287                 ir_type = IR_TYPE_PD;
288                 ir->sampling = 0xff00; /* address */
289                 break;
290         case CX88_BOARD_NORWOOD_MICRO:
291                 ir_codes         = ir_codes_norwood;
292                 ir->gpio_addr    = MO_GP1_IO;
293                 ir->mask_keycode = 0x0e;
294                 ir->mask_keyup   = 0x80;
295                 ir->polling      = 50; /* ms */
296                 break;
297         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
298                 ir_codes = ir_codes_npgtech;
299                 ir->gpio_addr = MO_GP0_IO;
300                 ir->mask_keycode = 0xfa;
301                 ir->polling = 50; /* ms */
302                 break;
303         }
304
305         if (NULL == ir_codes) {
306                 err = -ENODEV;
307                 goto err_out_free;
308         }
309
310         /* init input device */
311         snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)",
312                  cx88_boards[core->board].name);
313         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
314
315         ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
316         input_dev->name = ir->name;
317         input_dev->phys = ir->phys;
318         input_dev->id.bustype = BUS_PCI;
319         input_dev->id.version = 1;
320         if (pci->subsystem_vendor) {
321                 input_dev->id.vendor = pci->subsystem_vendor;
322                 input_dev->id.product = pci->subsystem_device;
323         } else {
324                 input_dev->id.vendor = pci->vendor;
325                 input_dev->id.product = pci->device;
326         }
327         input_dev->cdev.dev = &pci->dev;
328         /* record handles to ourself */
329         ir->core = core;
330         core->ir = ir;
331
332         cx88_ir_start(core, ir);
333
334         /* all done */
335         err = input_register_device(ir->input);
336         if (err)
337                 goto err_out_stop;
338
339         return 0;
340
341  err_out_stop:
342         cx88_ir_stop(core, ir);
343         core->ir = NULL;
344  err_out_free:
345         input_free_device(input_dev);
346         kfree(ir);
347         return err;
348 }
349
350 int cx88_ir_fini(struct cx88_core *core)
351 {
352         struct cx88_IR *ir = core->ir;
353
354         /* skip detach on non attached boards */
355         if (NULL == ir)
356                 return 0;
357
358         cx88_ir_stop(core, ir);
359         input_unregister_device(ir->input);
360         kfree(ir);
361
362         /* done */
363         core->ir = NULL;
364         return 0;
365 }
366
367 /* ---------------------------------------------------------------------- */
368
369 void cx88_ir_irq(struct cx88_core *core)
370 {
371         struct cx88_IR *ir = core->ir;
372         u32 samples, ircode;
373         int i;
374
375         if (NULL == ir)
376                 return;
377         if (!ir->sampling)
378                 return;
379
380         samples = cx_read(MO_SAMPLE_IO);
381         if (0 != samples && 0xffffffff != samples) {
382                 /* record sample data */
383                 if (ir->scount < ARRAY_SIZE(ir->samples))
384                         ir->samples[ir->scount++] = samples;
385                 return;
386         }
387         if (!ir->scount) {
388                 /* nothing to sample */
389                 if (ir->ir.keypressed && time_after(jiffies, ir->release))
390                         ir_input_nokey(ir->input, &ir->ir);
391                 return;
392         }
393
394         /* have a complete sample */
395         if (ir->scount < ARRAY_SIZE(ir->samples))
396                 ir->samples[ir->scount++] = samples;
397         for (i = 0; i < ir->scount; i++)
398                 ir->samples[i] = ~ir->samples[i];
399         if (ir_debug)
400                 ir_dump_samples(ir->samples, ir->scount);
401
402         /* decode it */
403         switch (core->board) {
404         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
405         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
406                 ircode = ir_decode_pulsedistance(ir->samples, ir->scount, 1, 4);
407
408                 if (ircode == 0xffffffff) { /* decoding error */
409                         ir_dprintk("pulse distance decoding error\n");
410                         break;
411                 }
412
413                 ir_dprintk("pulse distance decoded: %x\n", ircode);
414
415                 if (ircode == 0) { /* key still pressed */
416                         ir_dprintk("pulse distance decoded repeat code\n");
417                         ir->release = jiffies + msecs_to_jiffies(120);
418                         break;
419                 }
420
421                 if ((ircode & 0xffff) != (ir->sampling & 0xffff)) { /* wrong address */
422                         ir_dprintk("pulse distance decoded wrong address\n");
423                         break;
424                 }
425
426                 if (((~ircode >> 24) & 0xff) != ((ircode >> 16) & 0xff)) { /* wrong checksum */
427                         ir_dprintk("pulse distance decoded wrong check sum\n");
428                         break;
429                 }
430
431                 ir_dprintk("Key Code: %x\n", (ircode >> 16) & 0x7f);
432
433                 ir_input_keydown(ir->input, &ir->ir, (ircode >> 16) & 0x7f, (ircode >> 16) & 0xff);
434                 ir->release = jiffies + msecs_to_jiffies(120);
435                 break;
436         case CX88_BOARD_HAUPPAUGE:
437         case CX88_BOARD_HAUPPAUGE_DVB_T1:
438         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
439         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
440         case CX88_BOARD_HAUPPAUGE_HVR1100:
441         case CX88_BOARD_HAUPPAUGE_HVR1300:
442         case CX88_BOARD_HAUPPAUGE_HVR3000:
443                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
444                 ir_dprintk("biphase decoded: %x\n", ircode);
445                 if ((ircode & 0xfffff000) != 0x3000)
446                         break;
447                 ir_input_keydown(ir->input, &ir->ir, ircode & 0x3f, ircode);
448                 ir->release = jiffies + msecs_to_jiffies(120);
449                 break;
450         }
451
452         ir->scount = 0;
453         return;
454 }
455
456 /* ---------------------------------------------------------------------- */
457
458 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
459 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
460 MODULE_LICENSE("GPL");
461 /*
462  * Local variables:
463  * c-basic-offset: 8
464  * End:
465  */