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