Merge master.kernel.org:/pub/scm/linux/kernel/git/mchehab/v4l-dvb
[sfrench/cifs-2.6.git] / drivers / media / video / bt8xx / bttv-input.c
1 /*
2  *
3  * Copyright (c) 2003 Gerd Knorr
4  * Copyright (c) 2003 Pavel Machek
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  */
20
21 #include <linux/module.h>
22 #include <linux/moduleparam.h>
23 #include <linux/init.h>
24 #include <linux/delay.h>
25 #include <linux/interrupt.h>
26 #include <linux/input.h>
27
28 #include "bttv.h"
29 #include "bttvp.h"
30
31
32 static int debug;
33 module_param(debug, int, 0644);    /* debug level (0,1,2) */
34 static int repeat_delay = 500;
35 module_param(repeat_delay, int, 0644);
36 static int repeat_period = 33;
37 module_param(repeat_period, int, 0644);
38
39 #define DEVNAME "bttv-input"
40
41 /* ---------------------------------------------------------------------- */
42
43 static void ir_handle_key(struct bttv *btv)
44 {
45         struct bttv_ir *ir = btv->remote;
46         u32 gpio,data;
47
48         /* read gpio value */
49         gpio = bttv_gpio_read(&btv->c);
50         if (ir->polling) {
51                 if (ir->last_gpio == gpio)
52                         return;
53                 ir->last_gpio = gpio;
54         }
55
56         /* extract data */
57         data = ir_extract_bits(gpio, ir->mask_keycode);
58         dprintk(KERN_INFO DEVNAME ": irq gpio=0x%x code=%d | %s%s%s\n",
59                 gpio, data,
60                 ir->polling               ? "poll"  : "irq",
61                 (gpio & ir->mask_keydown) ? " down" : "",
62                 (gpio & ir->mask_keyup)   ? " up"   : "");
63
64         if ((ir->mask_keydown  &&  (0 != (gpio & ir->mask_keydown))) ||
65             (ir->mask_keyup    &&  (0 == (gpio & ir->mask_keyup)))) {
66                 ir_input_keydown(ir->dev,&ir->ir,data,data);
67         } else {
68                 ir_input_nokey(ir->dev,&ir->ir);
69         }
70
71 }
72
73 void bttv_input_irq(struct bttv *btv)
74 {
75         struct bttv_ir *ir = btv->remote;
76
77         if (!ir->polling)
78                 ir_handle_key(btv);
79 }
80
81 static void bttv_input_timer(unsigned long data)
82 {
83         struct bttv *btv = (struct bttv*)data;
84         struct bttv_ir *ir = btv->remote;
85         unsigned long timeout;
86
87         ir_handle_key(btv);
88         timeout = jiffies + (ir->polling * HZ / 1000);
89         mod_timer(&ir->timer, timeout);
90 }
91
92 /* ---------------------------------------------------------------*/
93
94 static int rc5_remote_gap = 885;
95 module_param(rc5_remote_gap, int, 0644);
96 static int rc5_key_timeout = 200;
97 module_param(rc5_key_timeout, int, 0644);
98
99 #define RC5_START(x)    (((x)>>12)&3)
100 #define RC5_TOGGLE(x)   (((x)>>11)&1)
101 #define RC5_ADDR(x)     (((x)>>6)&31)
102 #define RC5_INSTR(x)    ((x)&63)
103
104 /* decode raw bit pattern to RC5 code */
105 static u32 rc5_decode(unsigned int code)
106 {
107         unsigned int org_code = code;
108         unsigned int pair;
109         unsigned int rc5 = 0;
110         int i;
111
112         code = (code << 1) | 1;
113         for (i = 0; i < 14; ++i) {
114                 pair = code & 0x3;
115                 code >>= 2;
116
117                 rc5 <<= 1;
118                 switch (pair) {
119                 case 0:
120                 case 2:
121                         break;
122                 case 1:
123                         rc5 |= 1;
124                         break;
125                 case 3:
126                         dprintk(KERN_WARNING "bad code: %x\n", org_code);
127                         return 0;
128                 }
129         }
130         dprintk(KERN_WARNING "code=%x, rc5=%x, start=%x, toggle=%x, address=%x, "
131                 "instr=%x\n", rc5, org_code, RC5_START(rc5),
132                 RC5_TOGGLE(rc5), RC5_ADDR(rc5), RC5_INSTR(rc5));
133         return rc5;
134 }
135
136 static int bttv_rc5_irq(struct bttv *btv)
137 {
138         struct bttv_ir *ir = btv->remote;
139         struct timeval tv;
140         u32 gpio;
141         u32 gap;
142         unsigned long current_jiffies, timeout;
143
144         /* read gpio port */
145         gpio = bttv_gpio_read(&btv->c);
146
147         /* remote IRQ? */
148         if (!(gpio & 0x20))
149                 return 0;
150
151         /* get time of bit */
152         current_jiffies = jiffies;
153         do_gettimeofday(&tv);
154
155         /* avoid overflow with gap >1s */
156         if (tv.tv_sec - ir->base_time.tv_sec > 1) {
157                 gap = 200000;
158         } else {
159                 gap = 1000000 * (tv.tv_sec - ir->base_time.tv_sec) +
160                     tv.tv_usec - ir->base_time.tv_usec;
161         }
162
163         /* active code => add bit */
164         if (ir->active) {
165                 /* only if in the code (otherwise spurious IRQ or timer
166                    late) */
167                 if (ir->last_bit < 28) {
168                         ir->last_bit = (gap - rc5_remote_gap / 2) /
169                             rc5_remote_gap;
170                         ir->code |= 1 << ir->last_bit;
171                 }
172                 /* starting new code */
173         } else {
174                 ir->active = 1;
175                 ir->code = 0;
176                 ir->base_time = tv;
177                 ir->last_bit = 0;
178
179                 timeout = current_jiffies + (500 + 30 * HZ) / 1000;
180                 mod_timer(&ir->timer_end, timeout);
181         }
182
183         /* toggle GPIO pin 4 to reset the irq */
184         bttv_gpio_write(&btv->c, gpio & ~(1 << 4));
185         bttv_gpio_write(&btv->c, gpio | (1 << 4));
186         return 1;
187 }
188
189
190 static void bttv_rc5_timer_end(unsigned long data)
191 {
192         struct bttv_ir *ir = (struct bttv_ir *)data;
193         struct timeval tv;
194         unsigned long current_jiffies, timeout;
195         u32 gap;
196
197         /* get time */
198         current_jiffies = jiffies;
199         do_gettimeofday(&tv);
200
201         /* avoid overflow with gap >1s */
202         if (tv.tv_sec - ir->base_time.tv_sec > 1) {
203                 gap = 200000;
204         } else {
205                 gap = 1000000 * (tv.tv_sec - ir->base_time.tv_sec) +
206                     tv.tv_usec - ir->base_time.tv_usec;
207         }
208
209         /* Allow some timmer jitter (RC5 is ~24ms anyway so this is ok) */
210         if (gap < 28000) {
211                 dprintk(KERN_WARNING "spurious timer_end\n");
212                 return;
213         }
214
215         ir->active = 0;
216         if (ir->last_bit < 20) {
217                 /* ignore spurious codes (caused by light/other remotes) */
218                 dprintk(KERN_WARNING "short code: %x\n", ir->code);
219         } else {
220                 u32 rc5 = rc5_decode(ir->code);
221
222                 /* two start bits? */
223                 if (RC5_START(rc5) != 3) {
224                         dprintk(KERN_WARNING "rc5 start bits invalid: %u\n", RC5_START(rc5));
225
226                         /* right address? */
227                 } else if (RC5_ADDR(rc5) == 0x0) {
228                         u32 toggle = RC5_TOGGLE(rc5);
229                         u32 instr = RC5_INSTR(rc5);
230
231                         /* Good code, decide if repeat/repress */
232                         if (toggle != RC5_TOGGLE(ir->last_rc5) ||
233                             instr != RC5_INSTR(ir->last_rc5)) {
234                                 dprintk(KERN_WARNING "instruction %x, toggle %x\n", instr,
235                                         toggle);
236                                 ir_input_nokey(ir->dev, &ir->ir);
237                                 ir_input_keydown(ir->dev, &ir->ir, instr,
238                                                  instr);
239                         }
240
241                         /* Set/reset key-up timer */
242                         timeout = current_jiffies + (500 + rc5_key_timeout
243                                                      * HZ) / 1000;
244                         mod_timer(&ir->timer_keyup, timeout);
245
246                         /* Save code for repeat test */
247                         ir->last_rc5 = rc5;
248                 }
249         }
250 }
251
252 static void bttv_rc5_timer_keyup(unsigned long data)
253 {
254         struct bttv_ir *ir = (struct bttv_ir *)data;
255
256         dprintk(KERN_DEBUG "key released\n");
257         ir_input_nokey(ir->dev, &ir->ir);
258 }
259
260 /* ---------------------------------------------------------------------- */
261
262 int bttv_input_init(struct bttv *btv)
263 {
264         struct bttv_ir *ir;
265         IR_KEYTAB_TYPE *ir_codes = NULL;
266         struct input_dev *input_dev;
267         int ir_type = IR_TYPE_OTHER;
268
269         if (!btv->has_remote)
270                 return -ENODEV;
271
272         ir = kzalloc(sizeof(*ir),GFP_KERNEL);
273         input_dev = input_allocate_device();
274         if (!ir || !input_dev) {
275                 kfree(ir);
276                 input_free_device(input_dev);
277                 return -ENOMEM;
278         }
279         memset(ir,0,sizeof(*ir));
280
281         /* detect & configure */
282         switch (btv->c.type) {
283         case BTTV_BOARD_AVERMEDIA:
284         case BTTV_BOARD_AVPHONE98:
285         case BTTV_BOARD_AVERMEDIA98:
286                 ir_codes         = ir_codes_avermedia;
287                 ir->mask_keycode = 0xf88000;
288                 ir->mask_keydown = 0x010000;
289                 ir->polling      = 50; // ms
290                 break;
291
292         case BTTV_BOARD_AVDVBT_761:
293         case BTTV_BOARD_AVDVBT_771:
294                 ir_codes         = ir_codes_avermedia_dvbt;
295                 ir->mask_keycode = 0x0f00c0;
296                 ir->mask_keydown = 0x000020;
297                 ir->polling      = 50; // ms
298                 break;
299
300         case BTTV_BOARD_PXELVWPLTVPAK:
301                 ir_codes         = ir_codes_pixelview;
302                 ir->mask_keycode = 0x003e00;
303                 ir->mask_keyup   = 0x010000;
304                 ir->polling      = 50; // ms
305                 break;
306         case BTTV_BOARD_PV_M4900:
307         case BTTV_BOARD_PV_BT878P_9B:
308         case BTTV_BOARD_PV_BT878P_PLUS:
309                 ir_codes         = ir_codes_pixelview;
310                 ir->mask_keycode = 0x001f00;
311                 ir->mask_keyup   = 0x008000;
312                 ir->polling      = 50; // ms
313                 break;
314
315         case BTTV_BOARD_WINFAST2000:
316                 ir_codes         = ir_codes_winfast;
317                 ir->mask_keycode = 0x1f8;
318                 break;
319         case BTTV_BOARD_MAGICTVIEW061:
320         case BTTV_BOARD_MAGICTVIEW063:
321                 ir_codes         = ir_codes_winfast;
322                 ir->mask_keycode = 0x0008e000;
323                 ir->mask_keydown = 0x00200000;
324                 break;
325         case BTTV_BOARD_APAC_VIEWCOMP:
326                 ir_codes         = ir_codes_apac_viewcomp;
327                 ir->mask_keycode = 0x001f00;
328                 ir->mask_keyup   = 0x008000;
329                 ir->polling      = 50; // ms
330                 break;
331         case BTTV_BOARD_CONCEPTRONIC_CTVFMI2:
332         case BTTV_BOARD_CONTVFMI:
333                 ir_codes         = ir_codes_pixelview;
334                 ir->mask_keycode = 0x001F00;
335                 ir->mask_keyup   = 0x006000;
336                 ir->polling      = 50; // ms
337                 break;
338         case BTTV_BOARD_NEBULA_DIGITV:
339                 ir_codes = ir_codes_nebula;
340                 btv->custom_irq = bttv_rc5_irq;
341                 ir->rc5_gpio = 1;
342                 break;
343         case BTTV_BOARD_MACHTV_MAGICTV:
344                 ir_codes         = ir_codes_apac_viewcomp;
345                 ir->mask_keycode = 0x001F00;
346                 ir->mask_keyup   = 0x004000;
347                 ir->polling      = 50; /* ms */
348                 break;
349         }
350         if (NULL == ir_codes) {
351                 dprintk(KERN_INFO "Ooops: IR config error [card=%d]\n",btv->c.type);
352                 kfree(ir);
353                 input_free_device(input_dev);
354                 return -ENODEV;
355         }
356
357         if (ir->rc5_gpio) {
358                 u32 gpio;
359                 /* enable remote irq */
360                 bttv_gpio_inout(&btv->c, (1 << 4), 1 << 4);
361                 gpio = bttv_gpio_read(&btv->c);
362                 bttv_gpio_write(&btv->c, gpio & ~(1 << 4));
363                 bttv_gpio_write(&btv->c, gpio | (1 << 4));
364         } else {
365                 /* init hardware-specific stuff */
366                 bttv_gpio_inout(&btv->c, ir->mask_keycode | ir->mask_keydown, 0);
367         }
368
369         /* init input device */
370         ir->dev = input_dev;
371
372         snprintf(ir->name, sizeof(ir->name), "bttv IR (card=%d)",
373                  btv->c.type);
374         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0",
375                  pci_name(btv->c.pci));
376
377         ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
378         input_dev->name = ir->name;
379         input_dev->phys = ir->phys;
380         input_dev->id.bustype = BUS_PCI;
381         input_dev->id.version = 1;
382         if (btv->c.pci->subsystem_vendor) {
383                 input_dev->id.vendor  = btv->c.pci->subsystem_vendor;
384                 input_dev->id.product = btv->c.pci->subsystem_device;
385         } else {
386                 input_dev->id.vendor  = btv->c.pci->vendor;
387                 input_dev->id.product = btv->c.pci->device;
388         }
389         input_dev->cdev.dev = &btv->c.pci->dev;
390
391         btv->remote = ir;
392         if (ir->polling) {
393                 init_timer(&ir->timer);
394                 ir->timer.function = bttv_input_timer;
395                 ir->timer.data     = (unsigned long)btv;
396                 ir->timer.expires  = jiffies + HZ;
397                 add_timer(&ir->timer);
398         } else if (ir->rc5_gpio) {
399                 /* set timer_end for code completion */
400                 init_timer(&ir->timer_end);
401                 ir->timer_end.function = bttv_rc5_timer_end;
402                 ir->timer_end.data = (unsigned long)ir;
403
404                 init_timer(&ir->timer_keyup);
405                 ir->timer_keyup.function = bttv_rc5_timer_keyup;
406                 ir->timer_keyup.data = (unsigned long)ir;
407         }
408
409         /* all done */
410         input_register_device(btv->remote->dev);
411         printk(DEVNAME ": %s detected at %s\n",ir->name,ir->phys);
412
413         /* the remote isn't as bouncy as a keyboard */
414         ir->dev->rep[REP_DELAY] = repeat_delay;
415         ir->dev->rep[REP_PERIOD] = repeat_period;
416
417         return 0;
418 }
419
420 void bttv_input_fini(struct bttv *btv)
421 {
422         if (btv->remote == NULL)
423                 return;
424
425         if (btv->remote->polling) {
426                 del_timer_sync(&btv->remote->timer);
427                 flush_scheduled_work();
428         }
429
430
431         if (btv->remote->rc5_gpio) {
432                 u32 gpio;
433
434                 del_timer_sync(&btv->remote->timer_end);
435                 flush_scheduled_work();
436
437                 gpio = bttv_gpio_read(&btv->c);
438                 bttv_gpio_write(&btv->c, gpio & ~(1 << 4));
439         }
440
441         input_unregister_device(btv->remote->dev);
442         kfree(btv->remote);
443         btv->remote = NULL;
444 }
445
446
447 /*
448  * Local variables:
449  * c-basic-offset: 8
450  * End:
451  */