Merge git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
[linux-2.6] / drivers / media / video / saa7134 / saa7134-input.c
1 /*
2  *
3  * handle saa7134 IR remotes via linux kernel input layer.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  */
20
21 #include <linux/module.h>
22 #include <linux/init.h>
23 #include <linux/delay.h>
24 #include <linux/interrupt.h>
25 #include <linux/input.h>
26
27 #include "saa7134-reg.h"
28 #include "saa7134.h"
29
30 static unsigned int disable_ir = 0;
31 module_param(disable_ir, int, 0444);
32 MODULE_PARM_DESC(disable_ir,"disable infrared remote support");
33
34 static unsigned int ir_debug = 0;
35 module_param(ir_debug, int, 0644);
36 MODULE_PARM_DESC(ir_debug,"enable debug messages [IR]");
37
38 static int pinnacle_remote = 0;
39 module_param(pinnacle_remote, int, 0644);    /* Choose Pinnacle PCTV remote */
40 MODULE_PARM_DESC(pinnacle_remote, "Specify Pinnacle PCTV remote: 0=coloured, 1=grey (defaults to 0)");
41
42 static int ir_rc5_remote_gap = 885;
43 module_param(ir_rc5_remote_gap, int, 0644);
44 static int ir_rc5_key_timeout = 115;
45 module_param(ir_rc5_key_timeout, int, 0644);
46
47 static int repeat_delay = 500;
48 module_param(repeat_delay, int, 0644);
49 MODULE_PARM_DESC(repeat_delay, "delay before key repeat started");
50 static int repeat_period = 33;
51 module_param(repeat_period, int, 0644);
52 MODULE_PARM_DESC(repeat_period, "repeat period between "
53     "keypresses when key is down");
54
55 static unsigned int disable_other_ir;
56 module_param(disable_other_ir, int, 0644);
57 MODULE_PARM_DESC(disable_other_ir, "disable full codes of "
58     "alternative remotes from other manufacturers");
59
60 #define dprintk(fmt, arg...)    if (ir_debug) \
61         printk(KERN_DEBUG "%s/ir: " fmt, dev->name , ## arg)
62 #define i2cdprintk(fmt, arg...)    if (ir_debug) \
63         printk(KERN_DEBUG "%s/ir: " fmt, ir->c.name , ## arg)
64
65 /** rc5 functions */
66 static int saa7134_rc5_irq(struct saa7134_dev *dev);
67
68 /* -------------------- GPIO generic keycode builder -------------------- */
69
70 static int build_key(struct saa7134_dev *dev)
71 {
72         struct card_ir *ir = dev->remote;
73         u32 gpio, data;
74
75         /* here comes the additional handshake steps for some cards */
76         switch (dev->board) {
77         case SAA7134_BOARD_GOTVIEW_7135:
78                 saa_setb(SAA7134_GPIO_GPSTATUS1, 0x80);
79                 saa_clearb(SAA7134_GPIO_GPSTATUS1, 0x80);
80                 break;
81         }
82         /* rising SAA7134_GPIO_GPRESCAN reads the status */
83         saa_clearb(SAA7134_GPIO_GPMODE3,SAA7134_GPIO_GPRESCAN);
84         saa_setb(SAA7134_GPIO_GPMODE3,SAA7134_GPIO_GPRESCAN);
85
86         gpio = saa_readl(SAA7134_GPIO_GPSTATUS0 >> 2);
87         if (ir->polling) {
88                 if (ir->last_gpio == gpio)
89                         return 0;
90                 ir->last_gpio = gpio;
91         }
92
93         data = ir_extract_bits(gpio, ir->mask_keycode);
94         dprintk("build_key gpio=0x%x mask=0x%x data=%d\n",
95                 gpio, ir->mask_keycode, data);
96
97         if (ir->polling) {
98                 if ((ir->mask_keydown  &&  (0 != (gpio & ir->mask_keydown))) ||
99                     (ir->mask_keyup    &&  (0 == (gpio & ir->mask_keyup)))) {
100                         ir_input_keydown(ir->dev, &ir->ir, data, data);
101                 } else {
102                         ir_input_nokey(ir->dev, &ir->ir);
103                 }
104         }
105         else {  /* IRQ driven mode - handle key press and release in one go */
106                 if ((ir->mask_keydown  &&  (0 != (gpio & ir->mask_keydown))) ||
107                     (ir->mask_keyup    &&  (0 == (gpio & ir->mask_keyup)))) {
108                         ir_input_keydown(ir->dev, &ir->ir, data, data);
109                         ir_input_nokey(ir->dev, &ir->ir);
110                 }
111         }
112
113         return 0;
114 }
115
116 /* --------------------- Chip specific I2C key builders ----------------- */
117
118 static int get_key_purpletv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
119 {
120         unsigned char b;
121
122         /* poll IR chip */
123         if (1 != i2c_master_recv(&ir->c,&b,1)) {
124                 i2cdprintk("read error\n");
125                 return -EIO;
126         }
127
128         /* no button press */
129         if (b==0)
130                 return 0;
131
132         /* repeating */
133         if (b & 0x80)
134                 return 1;
135
136         *ir_key = b;
137         *ir_raw = b;
138         return 1;
139 }
140
141 static int get_key_hvr1110(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
142 {
143         unsigned char buf[5], cod4, code3, code4;
144
145         /* poll IR chip */
146         if (5 != i2c_master_recv(&ir->c,buf,5))
147                 return -EIO;
148
149         cod4    = buf[4];
150         code4   = (cod4 >> 2);
151         code3   = buf[3];
152         if (code3 == 0)
153                 /* no key pressed */
154                 return 0;
155
156         /* return key */
157         *ir_key = code4;
158         *ir_raw = code4;
159         return 1;
160 }
161
162
163 static int get_key_beholdm6xx(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
164 {
165         unsigned char data[12];
166         u32 gpio;
167
168         struct saa7134_dev *dev = ir->c.adapter->algo_data;
169
170         /* rising SAA7134_GPIO_GPRESCAN reads the status */
171         saa_clearb(SAA7134_GPIO_GPMODE3, SAA7134_GPIO_GPRESCAN);
172         saa_setb(SAA7134_GPIO_GPMODE3, SAA7134_GPIO_GPRESCAN);
173
174         gpio = saa_readl(SAA7134_GPIO_GPSTATUS0 >> 2);
175
176         if (0x400000 & ~gpio)
177                 return 0; /* No button press */
178
179         ir->c.addr = 0x5a >> 1;
180
181         if (12 != i2c_master_recv(&ir->c, data, 12)) {
182                 i2cdprintk("read error\n");
183                 return -EIO;
184         }
185         /* IR of this card normally decode signals NEC-standard from
186          * - Sven IHOO MT 5.1R remote. xxyye718
187          * - Sven DVD HD-10xx remote. xxyyf708
188          * - BBK ...
189          * - mayby others
190          * So, skip not our, if disable full codes mode.
191          */
192         if (data[10] != 0x6b && data[11] != 0x86 && disable_other_ir)
193                 return 0;
194
195         *ir_key = data[9];
196         *ir_raw = data[9];
197
198         return 1;
199 }
200
201 void saa7134_input_irq(struct saa7134_dev *dev)
202 {
203         struct card_ir *ir = dev->remote;
204
205         if (!ir->polling && !ir->rc5_gpio) {
206                 build_key(dev);
207         } else if (ir->rc5_gpio) {
208                 saa7134_rc5_irq(dev);
209         }
210 }
211
212 static void saa7134_input_timer(unsigned long data)
213 {
214         struct saa7134_dev *dev = (struct saa7134_dev *)data;
215         struct card_ir *ir = dev->remote;
216
217         build_key(dev);
218         mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling));
219 }
220
221 void saa7134_ir_start(struct saa7134_dev *dev, struct card_ir *ir)
222 {
223         if (ir->polling) {
224                 setup_timer(&ir->timer, saa7134_input_timer,
225                             (unsigned long)dev);
226                 ir->timer.expires  = jiffies + HZ;
227                 add_timer(&ir->timer);
228         } else if (ir->rc5_gpio) {
229                 /* set timer_end for code completion */
230                 init_timer(&ir->timer_end);
231                 ir->timer_end.function = ir_rc5_timer_end;
232                 ir->timer_end.data = (unsigned long)ir;
233                 init_timer(&ir->timer_keyup);
234                 ir->timer_keyup.function = ir_rc5_timer_keyup;
235                 ir->timer_keyup.data = (unsigned long)ir;
236                 ir->shift_by = 2;
237                 ir->start = 0x2;
238                 ir->addr = 0x17;
239                 ir->rc5_key_timeout = ir_rc5_key_timeout;
240                 ir->rc5_remote_gap = ir_rc5_remote_gap;
241         }
242 }
243
244 void saa7134_ir_stop(struct saa7134_dev *dev)
245 {
246         if (dev->remote->polling)
247                 del_timer_sync(&dev->remote->timer);
248 }
249
250 int saa7134_input_init1(struct saa7134_dev *dev)
251 {
252         struct card_ir *ir;
253         struct input_dev *input_dev;
254         IR_KEYTAB_TYPE *ir_codes = NULL;
255         u32 mask_keycode = 0;
256         u32 mask_keydown = 0;
257         u32 mask_keyup   = 0;
258         int polling      = 0;
259         int rc5_gpio     = 0;
260         int ir_type      = IR_TYPE_OTHER;
261         int err;
262
263         if (dev->has_remote != SAA7134_REMOTE_GPIO)
264                 return -ENODEV;
265         if (disable_ir)
266                 return -ENODEV;
267
268         /* detect & configure */
269         switch (dev->board) {
270         case SAA7134_BOARD_FLYVIDEO2000:
271         case SAA7134_BOARD_FLYVIDEO3000:
272         case SAA7134_BOARD_FLYTVPLATINUM_FM:
273         case SAA7134_BOARD_FLYTVPLATINUM_MINI2:
274                 ir_codes     = ir_codes_flyvideo;
275                 mask_keycode = 0xEC00000;
276                 mask_keydown = 0x0040000;
277                 break;
278         case SAA7134_BOARD_CINERGY400:
279         case SAA7134_BOARD_CINERGY600:
280         case SAA7134_BOARD_CINERGY600_MK3:
281                 ir_codes     = ir_codes_cinergy;
282                 mask_keycode = 0x00003f;
283                 mask_keyup   = 0x040000;
284                 break;
285         case SAA7134_BOARD_ECS_TVP3XP:
286         case SAA7134_BOARD_ECS_TVP3XP_4CB5:
287                 ir_codes     = ir_codes_eztv;
288                 mask_keycode = 0x00017c;
289                 mask_keyup   = 0x000002;
290                 polling      = 50; // ms
291                 break;
292         case SAA7134_BOARD_KWORLD_XPERT:
293         case SAA7134_BOARD_AVACSSMARTTV:
294                 ir_codes     = ir_codes_pixelview;
295                 mask_keycode = 0x00001F;
296                 mask_keyup   = 0x000020;
297                 polling      = 50; // ms
298                 break;
299         case SAA7134_BOARD_MD2819:
300         case SAA7134_BOARD_KWORLD_VSTREAM_XPERT:
301         case SAA7134_BOARD_AVERMEDIA_305:
302         case SAA7134_BOARD_AVERMEDIA_307:
303         case SAA7134_BOARD_AVERMEDIA_STUDIO_305:
304         case SAA7134_BOARD_AVERMEDIA_STUDIO_307:
305         case SAA7134_BOARD_AVERMEDIA_STUDIO_507:
306         case SAA7134_BOARD_AVERMEDIA_GO_007_FM:
307         case SAA7134_BOARD_AVERMEDIA_M102:
308                 ir_codes     = ir_codes_avermedia;
309                 mask_keycode = 0x0007C8;
310                 mask_keydown = 0x000010;
311                 polling      = 50; // ms
312                 /* Set GPIO pin2 to high to enable the IR controller */
313                 saa_setb(SAA7134_GPIO_GPMODE0, 0x4);
314                 saa_setb(SAA7134_GPIO_GPSTATUS0, 0x4);
315                 break;
316         case SAA7134_BOARD_AVERMEDIA_777:
317         case SAA7134_BOARD_AVERMEDIA_A16AR:
318                 ir_codes     = ir_codes_avermedia;
319                 mask_keycode = 0x02F200;
320                 mask_keydown = 0x000400;
321                 polling      = 50; // ms
322                 /* Without this we won't receive key up events */
323                 saa_setb(SAA7134_GPIO_GPMODE1, 0x1);
324                 saa_setb(SAA7134_GPIO_GPSTATUS1, 0x1);
325                 break;
326         case SAA7134_BOARD_KWORLD_TERMINATOR:
327                 ir_codes     = ir_codes_pixelview;
328                 mask_keycode = 0x00001f;
329                 mask_keyup   = 0x000060;
330                 polling      = 50; // ms
331                 break;
332         case SAA7134_BOARD_MANLI_MTV001:
333         case SAA7134_BOARD_MANLI_MTV002:
334         case SAA7134_BOARD_BEHOLD_409FM:
335         case SAA7134_BOARD_BEHOLD_401:
336         case SAA7134_BOARD_BEHOLD_403:
337         case SAA7134_BOARD_BEHOLD_403FM:
338         case SAA7134_BOARD_BEHOLD_405:
339         case SAA7134_BOARD_BEHOLD_405FM:
340         case SAA7134_BOARD_BEHOLD_407:
341         case SAA7134_BOARD_BEHOLD_407FM:
342         case SAA7134_BOARD_BEHOLD_409:
343         case SAA7134_BOARD_BEHOLD_505FM:
344         case SAA7134_BOARD_BEHOLD_507_9FM:
345                 ir_codes     = ir_codes_manli;
346                 mask_keycode = 0x001f00;
347                 mask_keyup   = 0x004000;
348                 polling      = 50; // ms
349                 break;
350         case SAA7134_BOARD_SEDNA_PC_TV_CARDBUS:
351                 ir_codes     = ir_codes_pctv_sedna;
352                 mask_keycode = 0x001f00;
353                 mask_keyup   = 0x004000;
354                 polling      = 50; // ms
355                 break;
356         case SAA7134_BOARD_GOTVIEW_7135:
357                 ir_codes     = ir_codes_gotview7135;
358                 mask_keycode = 0x0003CC;
359                 mask_keydown = 0x000010;
360                 polling      = 5; /* ms */
361                 saa_setb(SAA7134_GPIO_GPMODE1, 0x80);
362                 break;
363         case SAA7134_BOARD_VIDEOMATE_TV_PVR:
364         case SAA7134_BOARD_VIDEOMATE_GOLD_PLUS:
365         case SAA7134_BOARD_VIDEOMATE_TV_GOLD_PLUSII:
366                 ir_codes     = ir_codes_videomate_tv_pvr;
367                 mask_keycode = 0x00003F;
368                 mask_keyup   = 0x400000;
369                 polling      = 50; // ms
370                 break;
371         case SAA7134_BOARD_PROTEUS_2309:
372                 ir_codes     = ir_codes_proteus_2309;
373                 mask_keycode = 0x00007F;
374                 mask_keyup   = 0x000080;
375                 polling      = 50; // ms
376                 break;
377         case SAA7134_BOARD_VIDEOMATE_DVBT_300:
378         case SAA7134_BOARD_VIDEOMATE_DVBT_200:
379                 ir_codes     = ir_codes_videomate_tv_pvr;
380                 mask_keycode = 0x003F00;
381                 mask_keyup   = 0x040000;
382                 break;
383         case SAA7134_BOARD_FLYDVBS_LR300:
384         case SAA7134_BOARD_FLYDVBT_LR301:
385         case SAA7134_BOARD_FLYDVBTDUO:
386                 ir_codes     = ir_codes_flydvb;
387                 mask_keycode = 0x0001F00;
388                 mask_keydown = 0x0040000;
389                 break;
390         case SAA7134_BOARD_ASUSTeK_P7131_DUAL:
391         case SAA7134_BOARD_ASUSTeK_P7131_HYBRID_LNA:
392                 ir_codes     = ir_codes_asus_pc39;
393                 mask_keydown = 0x0040000;
394                 rc5_gpio = 1;
395                 break;
396         case SAA7134_BOARD_ENCORE_ENLTV:
397         case SAA7134_BOARD_ENCORE_ENLTV_FM:
398                 ir_codes     = ir_codes_encore_enltv;
399                 mask_keycode = 0x00007f;
400                 mask_keyup   = 0x040000;
401                 polling      = 50; // ms
402                 break;
403         case SAA7134_BOARD_10MOONSTVMASTER3:
404                 ir_codes     = ir_codes_encore_enltv;
405                 mask_keycode = 0x5f80000;
406                 mask_keyup   = 0x8000000;
407                 polling      = 50; //ms
408                 break;
409         }
410         if (NULL == ir_codes) {
411                 printk("%s: Oops: IR config error [card=%d]\n",
412                        dev->name, dev->board);
413                 return -ENODEV;
414         }
415
416         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
417         input_dev = input_allocate_device();
418         if (!ir || !input_dev) {
419                 err = -ENOMEM;
420                 goto err_out_free;
421         }
422
423         ir->dev = input_dev;
424
425         /* init hardware-specific stuff */
426         ir->mask_keycode = mask_keycode;
427         ir->mask_keydown = mask_keydown;
428         ir->mask_keyup   = mask_keyup;
429         ir->polling      = polling;
430         ir->rc5_gpio     = rc5_gpio;
431
432         /* init input device */
433         snprintf(ir->name, sizeof(ir->name), "saa7134 IR (%s)",
434                  saa7134_boards[dev->board].name);
435         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0",
436                  pci_name(dev->pci));
437
438         ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
439         input_dev->name = ir->name;
440         input_dev->phys = ir->phys;
441         input_dev->id.bustype = BUS_PCI;
442         input_dev->id.version = 1;
443         if (dev->pci->subsystem_vendor) {
444                 input_dev->id.vendor  = dev->pci->subsystem_vendor;
445                 input_dev->id.product = dev->pci->subsystem_device;
446         } else {
447                 input_dev->id.vendor  = dev->pci->vendor;
448                 input_dev->id.product = dev->pci->device;
449         }
450         input_dev->dev.parent = &dev->pci->dev;
451
452         dev->remote = ir;
453         saa7134_ir_start(dev, ir);
454
455         err = input_register_device(ir->dev);
456         if (err)
457                 goto err_out_stop;
458
459         /* the remote isn't as bouncy as a keyboard */
460         ir->dev->rep[REP_DELAY] = repeat_delay;
461         ir->dev->rep[REP_PERIOD] = repeat_period;
462
463         return 0;
464
465  err_out_stop:
466         saa7134_ir_stop(dev);
467         dev->remote = NULL;
468  err_out_free:
469         input_free_device(input_dev);
470         kfree(ir);
471         return err;
472 }
473
474 void saa7134_input_fini(struct saa7134_dev *dev)
475 {
476         if (NULL == dev->remote)
477                 return;
478
479         saa7134_ir_stop(dev);
480         input_unregister_device(dev->remote->dev);
481         kfree(dev->remote);
482         dev->remote = NULL;
483 }
484
485 void saa7134_set_i2c_ir(struct saa7134_dev *dev, struct IR_i2c *ir)
486 {
487         if (disable_ir) {
488                 dprintk("Found supported i2c remote, but IR has been disabled\n");
489                 ir->get_key=NULL;
490                 return;
491         }
492
493         switch (dev->board) {
494         case SAA7134_BOARD_PINNACLE_PCTV_110i:
495         case SAA7134_BOARD_PINNACLE_PCTV_310i:
496                 snprintf(ir->c.name, sizeof(ir->c.name), "Pinnacle PCTV");
497                 if (pinnacle_remote == 0) {
498                         ir->get_key   = get_key_pinnacle_color;
499                         ir->ir_codes = ir_codes_pinnacle_color;
500                 } else {
501                         ir->get_key   = get_key_pinnacle_grey;
502                         ir->ir_codes = ir_codes_pinnacle_grey;
503                 }
504                 break;
505         case SAA7134_BOARD_UPMOST_PURPLE_TV:
506                 snprintf(ir->c.name, sizeof(ir->c.name), "Purple TV");
507                 ir->get_key   = get_key_purpletv;
508                 ir->ir_codes  = ir_codes_purpletv;
509                 break;
510         case SAA7134_BOARD_HAUPPAUGE_HVR1110:
511                 snprintf(ir->c.name, sizeof(ir->c.name), "HVR 1110");
512                 ir->get_key   = get_key_hvr1110;
513                 ir->ir_codes  = ir_codes_hauppauge_new;
514                 break;
515         case SAA7134_BOARD_BEHOLD_607_9FM:
516         case SAA7134_BOARD_BEHOLD_M6:
517                 snprintf(ir->c.name, sizeof(ir->c.name), "BeholdTV");
518                 ir->get_key   = get_key_beholdm6xx;
519                 ir->ir_codes  = ir_codes_behold;
520                 break;
521         default:
522                 dprintk("Shouldn't get here: Unknown board %x for I2C IR?\n",dev->board);
523                 break;
524         }
525
526 }
527
528 static int saa7134_rc5_irq(struct saa7134_dev *dev)
529 {
530         struct card_ir *ir = dev->remote;
531         struct timeval tv;
532         u32 gap;
533         unsigned long current_jiffies, timeout;
534
535         /* get time of bit */
536         current_jiffies = jiffies;
537         do_gettimeofday(&tv);
538
539         /* avoid overflow with gap >1s */
540         if (tv.tv_sec - ir->base_time.tv_sec > 1) {
541                 gap = 200000;
542         } else {
543                 gap = 1000000 * (tv.tv_sec - ir->base_time.tv_sec) +
544                     tv.tv_usec - ir->base_time.tv_usec;
545         }
546
547         /* active code => add bit */
548         if (ir->active) {
549                 /* only if in the code (otherwise spurious IRQ or timer
550                    late) */
551                 if (ir->last_bit < 28) {
552                         ir->last_bit = (gap - ir_rc5_remote_gap / 2) /
553                             ir_rc5_remote_gap;
554                         ir->code |= 1 << ir->last_bit;
555                 }
556                 /* starting new code */
557         } else {
558                 ir->active = 1;
559                 ir->code = 0;
560                 ir->base_time = tv;
561                 ir->last_bit = 0;
562
563                 timeout = current_jiffies + (500 + 30 * HZ) / 1000;
564                 mod_timer(&ir->timer_end, timeout);
565         }
566
567         return 1;
568 }
569
570 /* ----------------------------------------------------------------------
571  * Local variables:
572  * c-basic-offset: 8
573  * End:
574  */