9c6d0ae58b1f4cdfcc6d540885417d80042f34c3
[linux-2.6.git] / drivers / media / video / ir-kbd-i2c.c
1 /*
2  *
3  * keyboard input driver for i2c IR remote controls
4  *
5  * Copyright (c) 2000-2003 Gerd Knorr <kraxel@bytesex.org>
6  * modified for PixelView (BT878P+W/FM) by
7  *      Michal Kochanowicz <mkochano@pld.org.pl>
8  *      Christoph Bartelmus <lirc@bartelmus.de>
9  * modified for KNC ONE TV Station/Anubis Typhoon TView Tuner by
10  *      Ulrich Mueller <ulrich.mueller42@web.de>
11  * modified for em2820 based USB TV tuners by
12  *      Markus Rechberger <mrechberger@gmail.com>
13  * modified for DViCO Fusion HDTV 5 RT GOLD by
14  *      Chaogui Zhang <czhang1974@gmail.com>
15  * modified for MSI TV@nywhere Plus by
16  *      Henry Wong <henry@stuffedcow.net>
17  *      Mark Schultz <n9xmj@yahoo.com>
18  *      Brian Rogers <brian_rogers@comcast.net>
19  * modified for AVerMedia Cardbus by
20  *      Oldrich Jedlicka <oldium.pro@seznam.cz>
21  *
22  *  This program is free software; you can redistribute it and/or modify
23  *  it under the terms of the GNU General Public License as published by
24  *  the Free Software Foundation; either version 2 of the License, or
25  *  (at your option) any later version.
26  *
27  *  This program is distributed in the hope that it will be useful,
28  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
29  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30  *  GNU General Public License for more details.
31  *
32  *  You should have received a copy of the GNU General Public License
33  *  along with this program; if not, write to the Free Software
34  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
35  *
36  */
37
38 #include <linux/module.h>
39 #include <linux/init.h>
40 #include <linux/kernel.h>
41 #include <linux/string.h>
42 #include <linux/timer.h>
43 #include <linux/delay.h>
44 #include <linux/errno.h>
45 #include <linux/slab.h>
46 #include <linux/i2c.h>
47 #include <linux/i2c-id.h>
48 #include <linux/workqueue.h>
49
50 #include <media/ir-common.h>
51 #include <media/ir-kbd-i2c.h>
52
53 /* ----------------------------------------------------------------------- */
54 /* insmod parameters                                                       */
55
56 static int debug;
57 module_param(debug, int, 0644);    /* debug level (0,1,2) */
58
59 static int hauppauge;
60 module_param(hauppauge, int, 0644);    /* Choose Hauppauge remote */
61 MODULE_PARM_DESC(hauppauge, "Specify Hauppauge remote: 0=black, 1=grey (defaults to 0)");
62
63
64 #define DEVNAME "ir-kbd-i2c"
65 #define dprintk(level, fmt, arg...)     if (debug >= level) \
66         printk(KERN_DEBUG DEVNAME ": " fmt , ## arg)
67
68 /* ----------------------------------------------------------------------- */
69
70 static int get_key_haup_common(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw,
71                                int size, int offset)
72 {
73         unsigned char buf[6];
74         int start, range, toggle, dev, code, ircode;
75
76         /* poll IR chip */
77         if (size != i2c_master_recv(ir->c, buf, size))
78                 return -EIO;
79
80         /* split rc5 data block ... */
81         start  = (buf[offset] >> 7) &    1;
82         range  = (buf[offset] >> 6) &    1;
83         toggle = (buf[offset] >> 5) &    1;
84         dev    =  buf[offset]       & 0x1f;
85         code   = (buf[offset+1] >> 2) & 0x3f;
86
87         /* rc5 has two start bits
88          * the first bit must be one
89          * the second bit defines the command range (1 = 0-63, 0 = 64 - 127)
90          */
91         if (!start)
92                 /* no key pressed */
93                 return 0;
94         /*
95          * Hauppauge remotes (black/silver) always use
96          * specific device ids. If we do not filter the
97          * device ids then messages destined for devices
98          * such as TVs (id=0) will get through causing
99          * mis-fired events.
100          *
101          * We also filter out invalid key presses which
102          * produce annoying debug log entries.
103          */
104         ircode= (start << 12) | (toggle << 11) | (dev << 6) | code;
105         if ((ircode & 0x1fff)==0x1fff)
106                 /* invalid key press */
107                 return 0;
108
109         if (dev!=0x1e && dev!=0x1f)
110                 /* not a hauppauge remote */
111                 return 0;
112
113         if (!range)
114                 code += 64;
115
116         dprintk(1,"ir hauppauge (rc5): s%d r%d t%d dev=%d code=%d\n",
117                 start, range, toggle, dev, code);
118
119         /* return key */
120         *ir_key = code;
121         *ir_raw = ircode;
122         return 1;
123 }
124
125 static int get_key_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
126 {
127         return get_key_haup_common (ir, ir_key, ir_raw, 3, 0);
128 }
129
130 static int get_key_haup_xvr(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
131 {
132         return get_key_haup_common (ir, ir_key, ir_raw, 6, 3);
133 }
134
135 static int get_key_pixelview(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
136 {
137         unsigned char b;
138
139         /* poll IR chip */
140         if (1 != i2c_master_recv(ir->c, &b, 1)) {
141                 dprintk(1,"read error\n");
142                 return -EIO;
143         }
144         *ir_key = b;
145         *ir_raw = b;
146         return 1;
147 }
148
149 static int get_key_pv951(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
150 {
151         unsigned char b;
152
153         /* poll IR chip */
154         if (1 != i2c_master_recv(ir->c, &b, 1)) {
155                 dprintk(1,"read error\n");
156                 return -EIO;
157         }
158
159         /* ignore 0xaa */
160         if (b==0xaa)
161                 return 0;
162         dprintk(2,"key %02x\n", b);
163
164         *ir_key = b;
165         *ir_raw = b;
166         return 1;
167 }
168
169 static int get_key_fusionhdtv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
170 {
171         unsigned char buf[4];
172
173         /* poll IR chip */
174         if (4 != i2c_master_recv(ir->c, buf, 4)) {
175                 dprintk(1,"read error\n");
176                 return -EIO;
177         }
178
179         if(buf[0] !=0 || buf[1] !=0 || buf[2] !=0 || buf[3] != 0)
180                 dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__,
181                         buf[0], buf[1], buf[2], buf[3]);
182
183         /* no key pressed or signal from other ir remote */
184         if(buf[0] != 0x1 ||  buf[1] != 0xfe)
185                 return 0;
186
187         *ir_key = buf[2];
188         *ir_raw = (buf[2] << 8) | buf[3];
189
190         return 1;
191 }
192
193 static int get_key_knc1(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
194 {
195         unsigned char b;
196
197         /* poll IR chip */
198         if (1 != i2c_master_recv(ir->c, &b, 1)) {
199                 dprintk(1,"read error\n");
200                 return -EIO;
201         }
202
203         /* it seems that 0xFE indicates that a button is still hold
204            down, while 0xff indicates that no button is hold
205            down. 0xfe sequences are sometimes interrupted by 0xFF */
206
207         dprintk(2,"key %02x\n", b);
208
209         if (b == 0xff)
210                 return 0;
211
212         if (b == 0xfe)
213                 /* keep old data */
214                 return 1;
215
216         *ir_key = b;
217         *ir_raw = b;
218         return 1;
219 }
220
221 static int get_key_avermedia_cardbus(struct IR_i2c *ir,
222                                      u32 *ir_key, u32 *ir_raw)
223 {
224         unsigned char subaddr, key, keygroup;
225         struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0,
226                                    .buf = &subaddr, .len = 1},
227                                  { .addr = ir->c->addr, .flags = I2C_M_RD,
228                                   .buf = &key, .len = 1} };
229         subaddr = 0x0d;
230         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
231                 dprintk(1, "read error\n");
232                 return -EIO;
233         }
234
235         if (key == 0xff)
236                 return 0;
237
238         subaddr = 0x0b;
239         msg[1].buf = &keygroup;
240         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
241                 dprintk(1, "read error\n");
242                 return -EIO;
243         }
244
245         if (keygroup == 0xff)
246                 return 0;
247
248         dprintk(1, "read key 0x%02x/0x%02x\n", key, keygroup);
249         if (keygroup < 2 || keygroup > 3) {
250                 /* Only a warning */
251                 dprintk(1, "warning: invalid key group 0x%02x for key 0x%02x\n",
252                                                                 keygroup, key);
253         }
254         key |= (keygroup & 1) << 6;
255
256         *ir_key = key;
257         *ir_raw = key;
258         return 1;
259 }
260
261 /* ----------------------------------------------------------------------- */
262
263 static void ir_key_poll(struct IR_i2c *ir)
264 {
265         static u32 ir_key, ir_raw;
266         int rc;
267
268         dprintk(2,"ir_poll_key\n");
269         rc = ir->get_key(ir, &ir_key, &ir_raw);
270         if (rc < 0) {
271                 dprintk(2,"error\n");
272                 return;
273         }
274
275         if (0 == rc) {
276                 ir_input_nokey(ir->input, &ir->ir);
277         } else {
278                 ir_input_keydown(ir->input, &ir->ir, ir_key);
279         }
280 }
281
282 static void ir_work(struct work_struct *work)
283 {
284         struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work);
285         int polling_interval = 100;
286
287         /* MSI TV@nywhere Plus requires more frequent polling
288            otherwise it will miss some keypresses */
289         if (ir->c->adapter->id == I2C_HW_SAA7134 && ir->c->addr == 0x30)
290                 polling_interval = 50;
291
292         ir_key_poll(ir);
293         schedule_delayed_work(&ir->work, msecs_to_jiffies(polling_interval));
294 }
295
296 /* ----------------------------------------------------------------------- */
297
298 static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id)
299 {
300         struct ir_scancode_table *ir_codes = NULL;
301         const char *name = NULL;
302         int ir_type = 0;
303         struct IR_i2c *ir;
304         struct input_dev *input_dev;
305         struct i2c_adapter *adap = client->adapter;
306         unsigned short addr = client->addr;
307         int err;
308
309         ir = kzalloc(sizeof(struct IR_i2c),GFP_KERNEL);
310         input_dev = input_allocate_device();
311         if (!ir || !input_dev) {
312                 err = -ENOMEM;
313                 goto err_out_free;
314         }
315
316         ir->c = client;
317         ir->input = input_dev;
318         i2c_set_clientdata(client, ir);
319
320         switch(addr) {
321         case 0x64:
322                 name        = "Pixelview";
323                 ir->get_key = get_key_pixelview;
324                 ir_type     = IR_TYPE_OTHER;
325                 ir_codes    = &ir_codes_empty_table;
326                 break;
327         case 0x4b:
328                 name        = "PV951";
329                 ir->get_key = get_key_pv951;
330                 ir_type     = IR_TYPE_OTHER;
331                 ir_codes    = &ir_codes_pv951_table;
332                 break;
333         case 0x18:
334         case 0x1a:
335                 name        = "Hauppauge";
336                 ir->get_key = get_key_haup;
337                 ir_type     = IR_TYPE_RC5;
338                 if (hauppauge == 1) {
339                         ir_codes    = &ir_codes_hauppauge_new_table;
340                 } else {
341                         ir_codes    = &ir_codes_rc5_tv_table;
342                 }
343                 break;
344         case 0x30:
345                 name        = "KNC One";
346                 ir->get_key = get_key_knc1;
347                 ir_type     = IR_TYPE_OTHER;
348                 ir_codes    = &ir_codes_empty_table;
349                 break;
350         case 0x6b:
351                 name        = "FusionHDTV";
352                 ir->get_key = get_key_fusionhdtv;
353                 ir_type     = IR_TYPE_RC5;
354                 ir_codes    = &ir_codes_fusionhdtv_mce_table;
355                 break;
356         case 0x47:
357         case 0x71:
358                 if (adap->id == I2C_HW_B_CX2388x ||
359                     adap->id == I2C_HW_B_CX2341X) {
360                         /* Handled by cx88-input */
361                         name = adap->id == I2C_HW_B_CX2341X ? "CX2341x remote"
362                                                             : "CX2388x remote";
363                         ir_type     = IR_TYPE_RC5;
364                         ir->get_key = get_key_haup_xvr;
365                         if (hauppauge == 1) {
366                                 ir_codes    = &ir_codes_hauppauge_new_table;
367                         } else {
368                                 ir_codes    = &ir_codes_rc5_tv_table;
369                         }
370                 } else {
371                         /* Handled by saa7134-input */
372                         name        = "SAA713x remote";
373                         ir_type     = IR_TYPE_OTHER;
374                 }
375                 break;
376         case 0x40:
377                 name        = "AVerMedia Cardbus remote";
378                 ir->get_key = get_key_avermedia_cardbus;
379                 ir_type     = IR_TYPE_OTHER;
380                 ir_codes    = &ir_codes_avermedia_cardbus_table;
381                 break;
382         }
383
384         /* Let the caller override settings */
385         if (client->dev.platform_data) {
386                 const struct IR_i2c_init_data *init_data =
387                                                 client->dev.platform_data;
388
389                 ir_codes = init_data->ir_codes;
390                 name = init_data->name;
391                 if (init_data->type)
392                         ir_type = init_data->type;
393
394                 switch (init_data->internal_get_key_func) {
395                 case IR_KBD_GET_KEY_CUSTOM:
396                         /* The bridge driver provided us its own function */
397                         ir->get_key = init_data->get_key;
398                         break;
399                 case IR_KBD_GET_KEY_PIXELVIEW:
400                         ir->get_key = get_key_pixelview;
401                         break;
402                 case IR_KBD_GET_KEY_PV951:
403                         ir->get_key = get_key_pv951;
404                         break;
405                 case IR_KBD_GET_KEY_HAUP:
406                         ir->get_key = get_key_haup;
407                         break;
408                 case IR_KBD_GET_KEY_KNC1:
409                         ir->get_key = get_key_knc1;
410                         break;
411                 case IR_KBD_GET_KEY_FUSIONHDTV:
412                         ir->get_key = get_key_fusionhdtv;
413                         break;
414                 case IR_KBD_GET_KEY_HAUP_XVR:
415                         ir->get_key = get_key_haup_xvr;
416                         break;
417                 case IR_KBD_GET_KEY_AVERMEDIA_CARDBUS:
418                         ir->get_key = get_key_avermedia_cardbus;
419                         break;
420                 }
421         }
422
423         /* Make sure we are all setup before going on */
424         if (!name || !ir->get_key || !ir_type || !ir_codes) {
425                 dprintk(1, DEVNAME ": Unsupported device at address 0x%02x\n",
426                         addr);
427                 err = -ENODEV;
428                 goto err_out_free;
429         }
430
431         /* Sets name */
432         snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name);
433         ir->ir_codes = ir_codes;
434
435         snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0",
436                  dev_name(&adap->dev),
437                  dev_name(&client->dev));
438
439         /* init + register input device */
440         ir_input_init(input_dev, &ir->ir, ir_type, ir->ir_codes);
441         input_dev->id.bustype = BUS_I2C;
442         input_dev->name       = ir->name;
443         input_dev->phys       = ir->phys;
444
445         err = input_register_device(ir->input);
446         if (err)
447                 goto err_out_free;
448
449         printk(DEVNAME ": %s detected at %s [%s]\n",
450                ir->input->name, ir->input->phys, adap->name);
451
452         /* start polling via eventd */
453         INIT_DELAYED_WORK(&ir->work, ir_work);
454         schedule_delayed_work(&ir->work, 0);
455
456         return 0;
457
458  err_out_free:
459         input_free_device(input_dev);
460         kfree(ir);
461         return err;
462 }
463
464 static int ir_remove(struct i2c_client *client)
465 {
466         struct IR_i2c *ir = i2c_get_clientdata(client);
467
468         /* kill outstanding polls */
469         cancel_delayed_work_sync(&ir->work);
470
471         /* unregister device */
472         input_unregister_device(ir->input);
473
474         /* free memory */
475         kfree(ir);
476         return 0;
477 }
478
479 static const struct i2c_device_id ir_kbd_id[] = {
480         /* Generic entry for any IR receiver */
481         { "ir_video", 0 },
482         /* IR device specific entries should be added here */
483         { "ir_rx_z8f0811_haup", 0 },
484         { }
485 };
486
487 static struct i2c_driver driver = {
488         .driver = {
489                 .name   = "ir-kbd-i2c",
490         },
491         .probe          = ir_probe,
492         .remove         = ir_remove,
493         .id_table       = ir_kbd_id,
494 };
495
496 /* ----------------------------------------------------------------------- */
497
498 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller");
499 MODULE_DESCRIPTION("input driver for i2c IR remote controls");
500 MODULE_LICENSE("GPL");
501
502 static int __init ir_init(void)
503 {
504         return i2c_add_driver(&driver);
505 }
506
507 static void __exit ir_fini(void)
508 {
509         i2c_del_driver(&driver);
510 }
511
512 module_init(ir_init);
513 module_exit(ir_fini);
514
515 /*
516  * Overrides for Emacs so that we follow Linus's tabbing style.
517  * ---------------------------------------------------------------------------
518  * Local variables:
519  * c-basic-offset: 8
520  * End:
521  */