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