Pull ibm into release branch
[firefly-linux-kernel-4.4.55.git] / 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/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 "saa7134-reg.h"
29 #include "saa7134.h"
30
31 static unsigned int disable_ir = 0;
32 module_param(disable_ir, int, 0444);
33 MODULE_PARM_DESC(disable_ir,"disable infrared remote support");
34
35 static unsigned int ir_debug = 0;
36 module_param(ir_debug, int, 0644);
37 MODULE_PARM_DESC(ir_debug,"enable debug messages [IR]");
38
39 static int pinnacle_remote = 0;
40 module_param(pinnacle_remote, int, 0644);    /* Choose Pinnacle PCTV remote */
41 MODULE_PARM_DESC(pinnacle_remote, "Specify Pinnacle PCTV remote: 0=coloured, 1=grey (defaults to 0)");
42
43 static int ir_rc5_remote_gap = 885;
44 module_param(ir_rc5_remote_gap, int, 0644);
45 static int ir_rc5_key_timeout = 115;
46 module_param(ir_rc5_key_timeout, int, 0644);
47
48 #define dprintk(fmt, arg...)    if (ir_debug) \
49         printk(KERN_DEBUG "%s/ir: " fmt, dev->name , ## arg)
50 #define i2cdprintk(fmt, arg...)    if (ir_debug) \
51         printk(KERN_DEBUG "%s/ir: " fmt, ir->c.name , ## arg)
52
53 /** rc5 functions */
54 static int saa7134_rc5_irq(struct saa7134_dev *dev);
55
56 /* -------------------- GPIO generic keycode builder -------------------- */
57
58 static int build_key(struct saa7134_dev *dev)
59 {
60         struct card_ir *ir = dev->remote;
61         u32 gpio, data;
62
63         /* rising SAA7134_GPIO_GPRESCAN reads the status */
64         saa_clearb(SAA7134_GPIO_GPMODE3,SAA7134_GPIO_GPRESCAN);
65         saa_setb(SAA7134_GPIO_GPMODE3,SAA7134_GPIO_GPRESCAN);
66
67         gpio = saa_readl(SAA7134_GPIO_GPSTATUS0 >> 2);
68         if (ir->polling) {
69                 if (ir->last_gpio == gpio)
70                         return 0;
71                 ir->last_gpio = gpio;
72         }
73
74         data = ir_extract_bits(gpio, ir->mask_keycode);
75         dprintk("build_key gpio=0x%x mask=0x%x data=%d\n",
76                 gpio, ir->mask_keycode, data);
77
78         if (ir->polling) {
79                 if ((ir->mask_keydown  &&  (0 != (gpio & ir->mask_keydown))) ||
80                     (ir->mask_keyup    &&  (0 == (gpio & ir->mask_keyup)))) {
81                         ir_input_keydown(ir->dev, &ir->ir, data, data);
82                 } else {
83                         ir_input_nokey(ir->dev, &ir->ir);
84                 }
85         }
86         else {  /* IRQ driven mode - handle key press and release in one go */
87                 if ((ir->mask_keydown  &&  (0 != (gpio & ir->mask_keydown))) ||
88                     (ir->mask_keyup    &&  (0 == (gpio & ir->mask_keyup)))) {
89                         ir_input_keydown(ir->dev, &ir->ir, data, data);
90                         ir_input_nokey(ir->dev, &ir->ir);
91                 }
92         }
93
94         return 0;
95 }
96
97 /* --------------------- Chip specific I2C key builders ----------------- */
98
99 static int get_key_purpletv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
100 {
101         unsigned char b;
102
103         /* poll IR chip */
104         if (1 != i2c_master_recv(&ir->c,&b,1)) {
105                 i2cdprintk("read error\n");
106                 return -EIO;
107         }
108
109         /* no button press */
110         if (b==0)
111                 return 0;
112
113         /* repeating */
114         if (b & 0x80)
115                 return 1;
116
117         *ir_key = b;
118         *ir_raw = b;
119         return 1;
120 }
121
122 static int get_key_hvr1110(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
123 {
124         unsigned char buf[5], cod4, code3, code4;
125
126         /* poll IR chip */
127         if (5 != i2c_master_recv(&ir->c,buf,5))
128                 return -EIO;
129
130         cod4    = buf[4];
131         code4   = (cod4 >> 2);
132         code3   = buf[3];
133         if (code3 == 0)
134                 /* no key pressed */
135                 return 0;
136
137         /* return key */
138         *ir_key = code4;
139         *ir_raw = code4;
140         return 1;
141 }
142
143 void saa7134_input_irq(struct saa7134_dev *dev)
144 {
145         struct card_ir *ir = dev->remote;
146
147         if (!ir->polling && !ir->rc5_gpio) {
148                 build_key(dev);
149         } else if (ir->rc5_gpio) {
150                 saa7134_rc5_irq(dev);
151         }
152 }
153
154 static void saa7134_input_timer(unsigned long data)
155 {
156         struct saa7134_dev *dev = (struct saa7134_dev*)data;
157         struct card_ir *ir = dev->remote;
158         unsigned long timeout;
159
160         build_key(dev);
161         timeout = jiffies + (ir->polling * HZ / 1000);
162         mod_timer(&ir->timer, timeout);
163 }
164
165 static void saa7134_ir_start(struct saa7134_dev *dev, struct card_ir *ir)
166 {
167         if (ir->polling) {
168                 init_timer(&ir->timer);
169                 ir->timer.function = saa7134_input_timer;
170                 ir->timer.data     = (unsigned long)dev;
171                 ir->timer.expires  = jiffies + HZ;
172                 add_timer(&ir->timer);
173         } else if (ir->rc5_gpio) {
174                 /* set timer_end for code completion */
175                 init_timer(&ir->timer_end);
176                 ir->timer_end.function = ir_rc5_timer_end;
177                 ir->timer_end.data = (unsigned long)ir;
178                 init_timer(&ir->timer_keyup);
179                 ir->timer_keyup.function = ir_rc5_timer_keyup;
180                 ir->timer_keyup.data = (unsigned long)ir;
181                 ir->shift_by = 2;
182                 ir->start = 0x2;
183                 ir->addr = 0x17;
184                 ir->rc5_key_timeout = ir_rc5_key_timeout;
185                 ir->rc5_remote_gap = ir_rc5_remote_gap;
186         }
187 }
188
189 static void saa7134_ir_stop(struct saa7134_dev *dev)
190 {
191         if (dev->remote->polling)
192                 del_timer_sync(&dev->remote->timer);
193 }
194
195 int saa7134_input_init1(struct saa7134_dev *dev)
196 {
197         struct card_ir *ir;
198         struct input_dev *input_dev;
199         IR_KEYTAB_TYPE *ir_codes = NULL;
200         u32 mask_keycode = 0;
201         u32 mask_keydown = 0;
202         u32 mask_keyup   = 0;
203         int polling      = 0;
204         int rc5_gpio     = 0;
205         int ir_type      = IR_TYPE_OTHER;
206         int err;
207
208         if (dev->has_remote != SAA7134_REMOTE_GPIO)
209                 return -ENODEV;
210         if (disable_ir)
211                 return -ENODEV;
212
213         /* detect & configure */
214         switch (dev->board) {
215         case SAA7134_BOARD_FLYVIDEO2000:
216         case SAA7134_BOARD_FLYVIDEO3000:
217         case SAA7134_BOARD_FLYTVPLATINUM_FM:
218         case SAA7134_BOARD_FLYTVPLATINUM_MINI2:
219                 ir_codes     = ir_codes_flyvideo;
220                 mask_keycode = 0xEC00000;
221                 mask_keydown = 0x0040000;
222                 break;
223         case SAA7134_BOARD_CINERGY400:
224         case SAA7134_BOARD_CINERGY600:
225         case SAA7134_BOARD_CINERGY600_MK3:
226                 ir_codes     = ir_codes_cinergy;
227                 mask_keycode = 0x00003f;
228                 mask_keyup   = 0x040000;
229                 break;
230         case SAA7134_BOARD_ECS_TVP3XP:
231         case SAA7134_BOARD_ECS_TVP3XP_4CB5:
232                 ir_codes     = ir_codes_eztv;
233                 mask_keycode = 0x00017c;
234                 mask_keyup   = 0x000002;
235                 polling      = 50; // ms
236                 break;
237         case SAA7134_BOARD_KWORLD_XPERT:
238         case SAA7134_BOARD_AVACSSMARTTV:
239                 ir_codes     = ir_codes_pixelview;
240                 mask_keycode = 0x00001F;
241                 mask_keyup   = 0x000020;
242                 polling      = 50; // ms
243                 break;
244         case SAA7134_BOARD_MD2819:
245         case SAA7134_BOARD_KWORLD_VSTREAM_XPERT:
246         case SAA7134_BOARD_AVERMEDIA_305:
247         case SAA7134_BOARD_AVERMEDIA_307:
248         case SAA7134_BOARD_AVERMEDIA_STUDIO_305:
249         case SAA7134_BOARD_AVERMEDIA_STUDIO_307:
250         case SAA7134_BOARD_AVERMEDIA_STUDIO_507:
251         case SAA7134_BOARD_AVERMEDIA_GO_007_FM:
252                 ir_codes     = ir_codes_avermedia;
253                 mask_keycode = 0x0007C8;
254                 mask_keydown = 0x000010;
255                 polling      = 50; // ms
256                 /* Set GPIO pin2 to high to enable the IR controller */
257                 saa_setb(SAA7134_GPIO_GPMODE0, 0x4);
258                 saa_setb(SAA7134_GPIO_GPSTATUS0, 0x4);
259                 break;
260         case SAA7134_BOARD_AVERMEDIA_777:
261         case SAA7134_BOARD_AVERMEDIA_A16AR:
262                 ir_codes     = ir_codes_avermedia;
263                 mask_keycode = 0x02F200;
264                 mask_keydown = 0x000400;
265                 polling      = 50; // ms
266                 /* Without this we won't receive key up events */
267                 saa_setb(SAA7134_GPIO_GPMODE1, 0x1);
268                 saa_setb(SAA7134_GPIO_GPSTATUS1, 0x1);
269                 break;
270         case SAA7134_BOARD_KWORLD_TERMINATOR:
271                 ir_codes     = ir_codes_pixelview;
272                 mask_keycode = 0x00001f;
273                 mask_keyup   = 0x000060;
274                 polling      = 50; // ms
275                 break;
276         case SAA7134_BOARD_MANLI_MTV001:
277         case SAA7134_BOARD_MANLI_MTV002:
278         case SAA7134_BOARD_BEHOLD_409FM:
279                 ir_codes     = ir_codes_manli;
280                 mask_keycode = 0x001f00;
281                 mask_keyup   = 0x004000;
282                 polling      = 50; // ms
283                 break;
284         case SAA7134_BOARD_SEDNA_PC_TV_CARDBUS:
285                 ir_codes     = ir_codes_pctv_sedna;
286                 mask_keycode = 0x001f00;
287                 mask_keyup   = 0x004000;
288                 polling      = 50; // ms
289                 break;
290         case SAA7134_BOARD_GOTVIEW_7135:
291                 ir_codes     = ir_codes_gotview7135;
292                 mask_keycode = 0x0003EC;
293                 mask_keyup   = 0x008000;
294                 mask_keydown = 0x000010;
295                 polling      = 50; // ms
296                 break;
297         case SAA7134_BOARD_VIDEOMATE_TV_PVR:
298         case SAA7134_BOARD_VIDEOMATE_GOLD_PLUS:
299         case SAA7134_BOARD_VIDEOMATE_TV_GOLD_PLUSII:
300                 ir_codes     = ir_codes_videomate_tv_pvr;
301                 mask_keycode = 0x00003F;
302                 mask_keyup   = 0x400000;
303                 polling      = 50; // ms
304                 break;
305         case SAA7134_BOARD_PROTEUS_2309:
306                 ir_codes     = ir_codes_proteus_2309;
307                 mask_keycode = 0x00007F;
308                 mask_keyup   = 0x000080;
309                 polling      = 50; // ms
310                 break;
311         case SAA7134_BOARD_VIDEOMATE_DVBT_300:
312         case SAA7134_BOARD_VIDEOMATE_DVBT_200:
313                 ir_codes     = ir_codes_videomate_tv_pvr;
314                 mask_keycode = 0x003F00;
315                 mask_keyup   = 0x040000;
316                 break;
317         case SAA7134_BOARD_FLYDVBT_LR301:
318         case SAA7134_BOARD_FLYDVBTDUO:
319                 ir_codes     = ir_codes_flydvb;
320                 mask_keycode = 0x0001F00;
321                 mask_keydown = 0x0040000;
322                 break;
323         case SAA7134_BOARD_ASUSTeK_P7131_DUAL:
324                 ir_codes     = ir_codes_asus_pc39;
325                 mask_keydown = 0x0040000;
326                 rc5_gpio = 1;
327                 break;
328         case SAA7134_BOARD_ENCORE_ENLTV:
329         case SAA7134_BOARD_ENCORE_ENLTV_FM:
330                 ir_codes     = ir_codes_encore_enltv;
331                 mask_keycode = 0x00007f;
332                 mask_keyup   = 0x040000;
333                 polling      = 50; // ms
334                 break;
335         }
336         if (NULL == ir_codes) {
337                 printk("%s: Oops: IR config error [card=%d]\n",
338                        dev->name, dev->board);
339                 return -ENODEV;
340         }
341
342         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
343         input_dev = input_allocate_device();
344         if (!ir || !input_dev) {
345                 err = -ENOMEM;
346                 goto err_out_free;
347         }
348
349         ir->dev = input_dev;
350
351         /* init hardware-specific stuff */
352         ir->mask_keycode = mask_keycode;
353         ir->mask_keydown = mask_keydown;
354         ir->mask_keyup   = mask_keyup;
355         ir->polling      = polling;
356         ir->rc5_gpio     = rc5_gpio;
357
358         /* init input device */
359         snprintf(ir->name, sizeof(ir->name), "saa7134 IR (%s)",
360                  saa7134_boards[dev->board].name);
361         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0",
362                  pci_name(dev->pci));
363
364         ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
365         input_dev->name = ir->name;
366         input_dev->phys = ir->phys;
367         input_dev->id.bustype = BUS_PCI;
368         input_dev->id.version = 1;
369         if (dev->pci->subsystem_vendor) {
370                 input_dev->id.vendor  = dev->pci->subsystem_vendor;
371                 input_dev->id.product = dev->pci->subsystem_device;
372         } else {
373                 input_dev->id.vendor  = dev->pci->vendor;
374                 input_dev->id.product = dev->pci->device;
375         }
376         input_dev->cdev.dev = &dev->pci->dev;
377
378         dev->remote = ir;
379         saa7134_ir_start(dev, ir);
380
381         err = input_register_device(ir->dev);
382         if (err)
383                 goto err_out_stop;
384
385         return 0;
386
387  err_out_stop:
388         saa7134_ir_stop(dev);
389         dev->remote = NULL;
390  err_out_free:
391         input_free_device(input_dev);
392         kfree(ir);
393         return err;
394 }
395
396 void saa7134_input_fini(struct saa7134_dev *dev)
397 {
398         if (NULL == dev->remote)
399                 return;
400
401         saa7134_ir_stop(dev);
402         input_unregister_device(dev->remote->dev);
403         kfree(dev->remote);
404         dev->remote = NULL;
405 }
406
407 void saa7134_set_i2c_ir(struct saa7134_dev *dev, struct IR_i2c *ir)
408 {
409         if (disable_ir) {
410                 dprintk("Found supported i2c remote, but IR has been disabled\n");
411                 ir->get_key=NULL;
412                 return;
413         }
414
415         switch (dev->board) {
416         case SAA7134_BOARD_PINNACLE_PCTV_110i:
417         case SAA7134_BOARD_PINNACLE_PCTV_310i:
418                 snprintf(ir->c.name, sizeof(ir->c.name), "Pinnacle PCTV");
419                 if (pinnacle_remote == 0) {
420                         ir->get_key   = get_key_pinnacle_color;
421                         ir->ir_codes = ir_codes_pinnacle_color;
422                 } else {
423                         ir->get_key   = get_key_pinnacle_grey;
424                         ir->ir_codes = ir_codes_pinnacle_grey;
425                 }
426                 break;
427         case SAA7134_BOARD_UPMOST_PURPLE_TV:
428                 snprintf(ir->c.name, sizeof(ir->c.name), "Purple TV");
429                 ir->get_key   = get_key_purpletv;
430                 ir->ir_codes  = ir_codes_purpletv;
431                 break;
432         case SAA7134_BOARD_HAUPPAUGE_HVR1110:
433                 snprintf(ir->c.name, sizeof(ir->c.name), "HVR 1110");
434                 ir->get_key   = get_key_hvr1110;
435                 ir->ir_codes  = ir_codes_hauppauge_new;
436                 break;
437         default:
438                 dprintk("Shouldn't get here: Unknown board %x for I2C IR?\n",dev->board);
439                 break;
440         }
441
442 }
443
444 static int saa7134_rc5_irq(struct saa7134_dev *dev)
445 {
446         struct card_ir *ir = dev->remote;
447         struct timeval tv;
448         u32 gap;
449         unsigned long current_jiffies, timeout;
450
451         /* get time of bit */
452         current_jiffies = jiffies;
453         do_gettimeofday(&tv);
454
455         /* avoid overflow with gap >1s */
456         if (tv.tv_sec - ir->base_time.tv_sec > 1) {
457                 gap = 200000;
458         } else {
459                 gap = 1000000 * (tv.tv_sec - ir->base_time.tv_sec) +
460                     tv.tv_usec - ir->base_time.tv_usec;
461         }
462
463         /* active code => add bit */
464         if (ir->active) {
465                 /* only if in the code (otherwise spurious IRQ or timer
466                    late) */
467                 if (ir->last_bit < 28) {
468                         ir->last_bit = (gap - ir_rc5_remote_gap / 2) /
469                             ir_rc5_remote_gap;
470                         ir->code |= 1 << ir->last_bit;
471                 }
472                 /* starting new code */
473         } else {
474                 ir->active = 1;
475                 ir->code = 0;
476                 ir->base_time = tv;
477                 ir->last_bit = 0;
478
479                 timeout = current_jiffies + (500 + 30 * HZ) / 1000;
480                 mod_timer(&ir->timer_end, timeout);
481         }
482
483         return 1;
484 }
485
486 /* ----------------------------------------------------------------------
487  * Local variables:
488  * c-basic-offset: 8
489  * End:
490  */