Merge git://git.infradead.org/~dwmw2/cafe-2.6
[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(void *data)
149 {
150         struct cx88_IR *ir = data;
151         unsigned long timeout;
152
153         cx88_ir_handle_key(ir);
154         timeout = jiffies + (ir->polling * HZ / 1000);
155         mod_timer(&ir->timer, timeout);
156 }
157
158 /* ---------------------------------------------------------------------- */
159
160 int cx88_ir_init(struct cx88_core *core, struct pci_dev *pci)
161 {
162         struct cx88_IR *ir;
163         struct input_dev *input_dev;
164         IR_KEYTAB_TYPE *ir_codes = NULL;
165         int ir_type = IR_TYPE_OTHER;
166
167         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
168         input_dev = input_allocate_device();
169         if (!ir || !input_dev) {
170                 kfree(ir);
171                 input_free_device(input_dev);
172                 return -ENOMEM;
173         }
174
175         ir->input = input_dev;
176
177         /* detect & configure */
178         switch (core->board) {
179         case CX88_BOARD_DNTV_LIVE_DVB_T:
180         case CX88_BOARD_KWORLD_DVB_T:
181         case CX88_BOARD_KWORLD_DVB_T_CX22702:
182                 ir_codes = ir_codes_dntv_live_dvb_t;
183                 ir->gpio_addr = MO_GP1_IO;
184                 ir->mask_keycode = 0x1f;
185                 ir->mask_keyup = 0x60;
186                 ir->polling = 50; /* ms */
187                 break;
188         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
189                 ir_codes = ir_codes_cinergy_1400;
190                 ir_type = IR_TYPE_PD;
191                 ir->sampling = 0xeb04; /* address */
192                 break;
193         case CX88_BOARD_HAUPPAUGE:
194         case CX88_BOARD_HAUPPAUGE_DVB_T1:
195         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
196         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
197         case CX88_BOARD_HAUPPAUGE_HVR1100:
198         case CX88_BOARD_HAUPPAUGE_HVR1300:
199         case CX88_BOARD_HAUPPAUGE_HVR3000:
200                 ir_codes = ir_codes_hauppauge_new;
201                 ir_type = IR_TYPE_RC5;
202                 ir->sampling = 1;
203                 break;
204         case CX88_BOARD_WINFAST_DTV2000H:
205         case CX88_BOARD_WINFAST2000XP_EXPERT:
206                 ir_codes = ir_codes_winfast;
207                 ir->gpio_addr = MO_GP0_IO;
208                 ir->mask_keycode = 0x8f8;
209                 ir->mask_keyup = 0x100;
210                 ir->polling = 50; /* ms */
211                 break;
212         case CX88_BOARD_IODATA_GVBCTV7E:
213                 ir_codes = ir_codes_iodata_bctv7e;
214                 ir->gpio_addr = MO_GP0_IO;
215                 ir->mask_keycode = 0xfd;
216                 ir->mask_keydown = 0x02;
217                 ir->polling = 5; /* ms */
218                 break;
219        case CX88_BOARD_PROLINK_PLAYTVPVR:
220         case CX88_BOARD_PIXELVIEW_PLAYTV_ULTRA_PRO:
221                 ir_codes = ir_codes_pixelview;
222                 ir->gpio_addr = MO_GP1_IO;
223                 ir->mask_keycode = 0x1f;
224                 ir->mask_keyup = 0x80;
225                 ir->polling = 1; /* ms */
226                 break;
227         case CX88_BOARD_KWORLD_LTV883:
228                 ir_codes = ir_codes_pixelview;
229                 ir->gpio_addr = MO_GP1_IO;
230                 ir->mask_keycode = 0x1f;
231                 ir->mask_keyup = 0x60;
232                 ir->polling = 1; /* ms */
233                 break;
234         case CX88_BOARD_ADSTECH_DVB_T_PCI:
235                 ir_codes = ir_codes_adstech_dvb_t_pci;
236                 ir->gpio_addr = MO_GP1_IO;
237                 ir->mask_keycode = 0xbf;
238                 ir->mask_keyup = 0x40;
239                 ir->polling = 50; /* ms */
240                 break;
241         case CX88_BOARD_MSI_TVANYWHERE_MASTER:
242                 ir_codes = ir_codes_msi_tvanywhere;
243                 ir->gpio_addr = MO_GP1_IO;
244                 ir->mask_keycode = 0x1f;
245                 ir->mask_keyup = 0x40;
246                 ir->polling = 1; /* ms */
247                 break;
248         case CX88_BOARD_AVERTV_303:
249         case CX88_BOARD_AVERTV_STUDIO_303:
250                 ir_codes         = ir_codes_avertv_303;
251                 ir->gpio_addr    = MO_GP2_IO;
252                 ir->mask_keycode = 0xfb;
253                 ir->mask_keydown = 0x02;
254                 ir->polling      = 50; /* ms */
255                 break;
256         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
257                 ir_codes = ir_codes_dntv_live_dvbt_pro;
258                 ir_type = IR_TYPE_PD;
259                 ir->sampling = 0xff00; /* address */
260                 break;
261         case CX88_BOARD_NORWOOD_MICRO:
262                 ir_codes         = ir_codes_norwood;
263                 ir->gpio_addr    = MO_GP1_IO;
264                 ir->mask_keycode = 0x0e;
265                 ir->mask_keyup   = 0x80;
266                 ir->polling      = 50; /* ms */
267                 break;
268         case CX88_BOARD_NPGTECH_REALTV_TOP10FM:
269                 ir_codes = ir_codes_npgtech;
270                 ir->gpio_addr = MO_GP0_IO;
271                 ir->mask_keycode = 0xfa;
272                 ir->polling = 50; /* ms */
273                 break;
274         }
275
276         if (NULL == ir_codes) {
277                 kfree(ir);
278                 input_free_device(input_dev);
279                 return -ENODEV;
280         }
281
282         /* init input device */
283         snprintf(ir->name, sizeof(ir->name), "cx88 IR (%s)",
284                  cx88_boards[core->board].name);
285         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0", pci_name(pci));
286
287         ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
288         input_dev->name = ir->name;
289         input_dev->phys = ir->phys;
290         input_dev->id.bustype = BUS_PCI;
291         input_dev->id.version = 1;
292         if (pci->subsystem_vendor) {
293                 input_dev->id.vendor = pci->subsystem_vendor;
294                 input_dev->id.product = pci->subsystem_device;
295         } else {
296                 input_dev->id.vendor = pci->vendor;
297                 input_dev->id.product = pci->device;
298         }
299         input_dev->cdev.dev = &pci->dev;
300         /* record handles to ourself */
301         ir->core = core;
302         core->ir = ir;
303
304         if (ir->polling) {
305                 INIT_WORK(&ir->work, cx88_ir_work, ir);
306                 init_timer(&ir->timer);
307                 ir->timer.function = ir_timer;
308                 ir->timer.data = (unsigned long)ir;
309                 schedule_work(&ir->work);
310         }
311         if (ir->sampling) {
312                 core->pci_irqmask |= (1 << 18); /* IR_SMP_INT */
313                 cx_write(MO_DDS_IO, 0xa80a80);  /* 4 kHz sample rate */
314                 cx_write(MO_DDSCFG_IO, 0x5);    /* enable */
315         }
316
317         /* all done */
318         input_register_device(ir->input);
319
320         return 0;
321 }
322
323 int cx88_ir_fini(struct cx88_core *core)
324 {
325         struct cx88_IR *ir = core->ir;
326
327         /* skip detach on non attached boards */
328         if (NULL == ir)
329                 return 0;
330
331         if (ir->sampling) {
332                 cx_write(MO_DDSCFG_IO, 0x0);
333                 core->pci_irqmask &= ~(1 << 18);
334         }
335         if (ir->polling) {
336                 del_timer(&ir->timer);
337                 flush_scheduled_work();
338         }
339
340         input_unregister_device(ir->input);
341         kfree(ir);
342
343         /* done */
344         core->ir = NULL;
345         return 0;
346 }
347
348 /* ---------------------------------------------------------------------- */
349
350 void cx88_ir_irq(struct cx88_core *core)
351 {
352         struct cx88_IR *ir = core->ir;
353         u32 samples, ircode;
354         int i;
355
356         if (NULL == ir)
357                 return;
358         if (!ir->sampling)
359                 return;
360
361         samples = cx_read(MO_SAMPLE_IO);
362         if (0 != samples && 0xffffffff != samples) {
363                 /* record sample data */
364                 if (ir->scount < ARRAY_SIZE(ir->samples))
365                         ir->samples[ir->scount++] = samples;
366                 return;
367         }
368         if (!ir->scount) {
369                 /* nothing to sample */
370                 if (ir->ir.keypressed && time_after(jiffies, ir->release))
371                         ir_input_nokey(ir->input, &ir->ir);
372                 return;
373         }
374
375         /* have a complete sample */
376         if (ir->scount < ARRAY_SIZE(ir->samples))
377                 ir->samples[ir->scount++] = samples;
378         for (i = 0; i < ir->scount; i++)
379                 ir->samples[i] = ~ir->samples[i];
380         if (ir_debug)
381                 ir_dump_samples(ir->samples, ir->scount);
382
383         /* decode it */
384         switch (core->board) {
385         case CX88_BOARD_TERRATEC_CINERGY_1400_DVB_T1:
386         case CX88_BOARD_DNTV_LIVE_DVB_T_PRO:
387                 ircode = ir_decode_pulsedistance(ir->samples, ir->scount, 1, 4);
388
389                 if (ircode == 0xffffffff) { /* decoding error */
390                         ir_dprintk("pulse distance decoding error\n");
391                         break;
392                 }
393
394                 ir_dprintk("pulse distance decoded: %x\n", ircode);
395
396                 if (ircode == 0) { /* key still pressed */
397                         ir_dprintk("pulse distance decoded repeat code\n");
398                         ir->release = jiffies + msecs_to_jiffies(120);
399                         break;
400                 }
401
402                 if ((ircode & 0xffff) != (ir->sampling & 0xffff)) { /* wrong address */
403                         ir_dprintk("pulse distance decoded wrong address\n");
404                         break;
405                 }
406
407                 if (((~ircode >> 24) & 0xff) != ((ircode >> 16) & 0xff)) { /* wrong checksum */
408                         ir_dprintk("pulse distance decoded wrong check sum\n");
409                         break;
410                 }
411
412                 ir_dprintk("Key Code: %x\n", (ircode >> 16) & 0x7f);
413
414                 ir_input_keydown(ir->input, &ir->ir, (ircode >> 16) & 0x7f, (ircode >> 16) & 0xff);
415                 ir->release = jiffies + msecs_to_jiffies(120);
416                 break;
417         case CX88_BOARD_HAUPPAUGE:
418         case CX88_BOARD_HAUPPAUGE_DVB_T1:
419         case CX88_BOARD_HAUPPAUGE_NOVASE2_S1:
420         case CX88_BOARD_HAUPPAUGE_NOVASPLUS_S1:
421         case CX88_BOARD_HAUPPAUGE_HVR1100:
422         case CX88_BOARD_HAUPPAUGE_HVR1300:
423         case CX88_BOARD_HAUPPAUGE_HVR3000:
424                 ircode = ir_decode_biphase(ir->samples, ir->scount, 5, 7);
425                 ir_dprintk("biphase decoded: %x\n", ircode);
426                 if ((ircode & 0xfffff000) != 0x3000)
427                         break;
428                 ir_input_keydown(ir->input, &ir->ir, ircode & 0x3f, ircode);
429                 ir->release = jiffies + msecs_to_jiffies(120);
430                 break;
431         }
432
433         ir->scount = 0;
434         return;
435 }
436
437 /* ---------------------------------------------------------------------- */
438
439 MODULE_AUTHOR("Gerd Knorr, Pavel Machek, Chris Pascoe");
440 MODULE_DESCRIPTION("input driver for cx88 GPIO-based IR remote controls");
441 MODULE_LICENSE("GPL");
442 /*
443  * Local variables:
444  * c-basic-offset: 8
445  * End:
446  */