3ab875d036e10cdc1a530cffb75246a76bdc3d2f
[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/workqueue.h>
48
49 #include <media/rc-core.h>
50 #include <media/ir-kbd-i2c.h>
51
52 /* ----------------------------------------------------------------------- */
53 /* insmod parameters                                                       */
54
55 static int debug;
56 module_param(debug, int, 0644);    /* debug level (0,1,2) */
57
58
59 #define MODULE_NAME "ir-kbd-i2c"
60 #define dprintk(level, fmt, arg...)     if (debug >= level) \
61         printk(KERN_DEBUG MODULE_NAME ": " fmt , ## arg)
62
63 /* ----------------------------------------------------------------------- */
64
65 static int get_key_haup_common(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw,
66                                int size, int offset)
67 {
68         unsigned char buf[6];
69         int start, range, toggle, dev, code, ircode;
70
71         /* poll IR chip */
72         if (size != i2c_master_recv(ir->c, buf, size))
73                 return -EIO;
74
75         /* split rc5 data block ... */
76         start  = (buf[offset] >> 7) &    1;
77         range  = (buf[offset] >> 6) &    1;
78         toggle = (buf[offset] >> 5) &    1;
79         dev    =  buf[offset]       & 0x1f;
80         code   = (buf[offset+1] >> 2) & 0x3f;
81
82         /* rc5 has two start bits
83          * the first bit must be one
84          * the second bit defines the command range (1 = 0-63, 0 = 64 - 127)
85          */
86         if (!start)
87                 /* no key pressed */
88                 return 0;
89         /*
90          * Hauppauge remotes (black/silver) always use
91          * specific device ids. If we do not filter the
92          * device ids then messages destined for devices
93          * such as TVs (id=0) will get through causing
94          * mis-fired events.
95          *
96          * We also filter out invalid key presses which
97          * produce annoying debug log entries.
98          */
99         ircode= (start << 12) | (toggle << 11) | (dev << 6) | code;
100         if ((ircode & 0x1fff)==0x1fff)
101                 /* invalid key press */
102                 return 0;
103
104         if (!range)
105                 code += 64;
106
107         dprintk(1,"ir hauppauge (rc5): s%d r%d t%d dev=%d code=%d\n",
108                 start, range, toggle, dev, code);
109
110         /* return key */
111         *ir_key = (dev << 8) | code;
112         *ir_raw = ircode;
113         return 1;
114 }
115
116 static int get_key_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
117 {
118         return get_key_haup_common (ir, ir_key, ir_raw, 3, 0);
119 }
120
121 static int get_key_haup_xvr(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
122 {
123         int ret;
124         unsigned char buf[1] = { 0 };
125
126         /*
127          * This is the same apparent "are you ready?" poll command observed
128          * watching Windows driver traffic and implemented in lirc_zilog. With
129          * this added, we get far saner remote behavior with z8 chips on usb
130          * connected devices, even with the default polling interval of 100ms.
131          */
132         ret = i2c_master_send(ir->c, buf, 1);
133         if (ret != 1)
134                 return (ret < 0) ? ret : -EINVAL;
135
136         return get_key_haup_common (ir, ir_key, ir_raw, 6, 3);
137 }
138
139 static int get_key_pixelview(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
140 {
141         unsigned char b;
142
143         /* poll IR chip */
144         if (1 != i2c_master_recv(ir->c, &b, 1)) {
145                 dprintk(1,"read error\n");
146                 return -EIO;
147         }
148         *ir_key = b;
149         *ir_raw = b;
150         return 1;
151 }
152
153 static int get_key_fusionhdtv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
154 {
155         unsigned char buf[4];
156
157         /* poll IR chip */
158         if (4 != i2c_master_recv(ir->c, buf, 4)) {
159                 dprintk(1,"read error\n");
160                 return -EIO;
161         }
162
163         if(buf[0] !=0 || buf[1] !=0 || buf[2] !=0 || buf[3] != 0)
164                 dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__,
165                         buf[0], buf[1], buf[2], buf[3]);
166
167         /* no key pressed or signal from other ir remote */
168         if(buf[0] != 0x1 ||  buf[1] != 0xfe)
169                 return 0;
170
171         *ir_key = buf[2];
172         *ir_raw = (buf[2] << 8) | buf[3];
173
174         return 1;
175 }
176
177 static int get_key_knc1(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
178 {
179         unsigned char b;
180
181         /* poll IR chip */
182         if (1 != i2c_master_recv(ir->c, &b, 1)) {
183                 dprintk(1,"read error\n");
184                 return -EIO;
185         }
186
187         /* it seems that 0xFE indicates that a button is still hold
188            down, while 0xff indicates that no button is hold
189            down. 0xfe sequences are sometimes interrupted by 0xFF */
190
191         dprintk(2,"key %02x\n", b);
192
193         if (b == 0xff)
194                 return 0;
195
196         if (b == 0xfe)
197                 /* keep old data */
198                 return 1;
199
200         *ir_key = b;
201         *ir_raw = b;
202         return 1;
203 }
204
205 static int get_key_avermedia_cardbus(struct IR_i2c *ir,
206                                      u32 *ir_key, u32 *ir_raw)
207 {
208         unsigned char subaddr, key, keygroup;
209         struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0,
210                                    .buf = &subaddr, .len = 1},
211                                  { .addr = ir->c->addr, .flags = I2C_M_RD,
212                                   .buf = &key, .len = 1} };
213         subaddr = 0x0d;
214         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
215                 dprintk(1, "read error\n");
216                 return -EIO;
217         }
218
219         if (key == 0xff)
220                 return 0;
221
222         subaddr = 0x0b;
223         msg[1].buf = &keygroup;
224         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
225                 dprintk(1, "read error\n");
226                 return -EIO;
227         }
228
229         if (keygroup == 0xff)
230                 return 0;
231
232         dprintk(1, "read key 0x%02x/0x%02x\n", key, keygroup);
233         if (keygroup < 2 || keygroup > 3) {
234                 /* Only a warning */
235                 dprintk(1, "warning: invalid key group 0x%02x for key 0x%02x\n",
236                                                                 keygroup, key);
237         }
238         key |= (keygroup & 1) << 6;
239
240         *ir_key = key;
241         *ir_raw = key;
242         return 1;
243 }
244
245 /* ----------------------------------------------------------------------- */
246
247 static void ir_key_poll(struct IR_i2c *ir)
248 {
249         static u32 ir_key, ir_raw;
250         int rc;
251
252         dprintk(3, "%s\n", __func__);
253         rc = ir->get_key(ir, &ir_key, &ir_raw);
254         if (rc < 0) {
255                 dprintk(2,"error\n");
256                 return;
257         }
258
259         if (rc) {
260                 dprintk(1, "%s: keycode = 0x%04x\n", __func__, ir_key);
261                 rc_keydown(ir->rc, ir_key, 0);
262         }
263 }
264
265 static void ir_work(struct work_struct *work)
266 {
267         struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work);
268
269         ir_key_poll(ir);
270         schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling_interval));
271 }
272
273 /* ----------------------------------------------------------------------- */
274
275 static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id)
276 {
277         char *ir_codes = NULL;
278         const char *name = NULL;
279         u64 rc_type = RC_TYPE_UNKNOWN;
280         struct IR_i2c *ir;
281         struct rc_dev *rc = NULL;
282         struct i2c_adapter *adap = client->adapter;
283         unsigned short addr = client->addr;
284         int err;
285
286         ir = kzalloc(sizeof(struct IR_i2c), GFP_KERNEL);
287         if (!ir)
288                 return -ENOMEM;
289
290         ir->c = client;
291         ir->polling_interval = DEFAULT_POLLING_INTERVAL;
292         i2c_set_clientdata(client, ir);
293
294         switch(addr) {
295         case 0x64:
296                 name        = "Pixelview";
297                 ir->get_key = get_key_pixelview;
298                 rc_type     = RC_TYPE_OTHER;
299                 ir_codes    = RC_MAP_EMPTY;
300                 break;
301         case 0x18:
302         case 0x1f:
303         case 0x1a:
304                 name        = "Hauppauge";
305                 ir->get_key = get_key_haup;
306                 rc_type     = RC_TYPE_RC5;
307                 ir_codes    = RC_MAP_HAUPPAUGE;
308                 break;
309         case 0x30:
310                 name        = "KNC One";
311                 ir->get_key = get_key_knc1;
312                 rc_type     = RC_TYPE_OTHER;
313                 ir_codes    = RC_MAP_EMPTY;
314                 break;
315         case 0x6b:
316                 name        = "FusionHDTV";
317                 ir->get_key = get_key_fusionhdtv;
318                 rc_type     = RC_TYPE_RC5;
319                 ir_codes    = RC_MAP_FUSIONHDTV_MCE;
320                 break;
321         case 0x40:
322                 name        = "AVerMedia Cardbus remote";
323                 ir->get_key = get_key_avermedia_cardbus;
324                 rc_type     = RC_TYPE_OTHER;
325                 ir_codes    = RC_MAP_AVERMEDIA_CARDBUS;
326                 break;
327         case 0x71:
328                 name        = "Hauppauge/Zilog Z8";
329                 ir->get_key = get_key_haup_xvr;
330                 rc_type     = RC_TYPE_RC5;
331                 ir_codes    = RC_MAP_HAUPPAUGE;
332                 break;
333         }
334
335         /* Let the caller override settings */
336         if (client->dev.platform_data) {
337                 const struct IR_i2c_init_data *init_data =
338                                                 client->dev.platform_data;
339
340                 ir_codes = init_data->ir_codes;
341                 rc = init_data->rc_dev;
342
343                 name = init_data->name;
344                 if (init_data->type)
345                         rc_type = init_data->type;
346
347                 if (init_data->polling_interval)
348                         ir->polling_interval = init_data->polling_interval;
349
350                 switch (init_data->internal_get_key_func) {
351                 case IR_KBD_GET_KEY_CUSTOM:
352                         /* The bridge driver provided us its own function */
353                         ir->get_key = init_data->get_key;
354                         break;
355                 case IR_KBD_GET_KEY_PIXELVIEW:
356                         ir->get_key = get_key_pixelview;
357                         break;
358                 case IR_KBD_GET_KEY_HAUP:
359                         ir->get_key = get_key_haup;
360                         break;
361                 case IR_KBD_GET_KEY_KNC1:
362                         ir->get_key = get_key_knc1;
363                         break;
364                 case IR_KBD_GET_KEY_FUSIONHDTV:
365                         ir->get_key = get_key_fusionhdtv;
366                         break;
367                 case IR_KBD_GET_KEY_HAUP_XVR:
368                         ir->get_key = get_key_haup_xvr;
369                         break;
370                 case IR_KBD_GET_KEY_AVERMEDIA_CARDBUS:
371                         ir->get_key = get_key_avermedia_cardbus;
372                         break;
373                 }
374         }
375
376         if (!rc) {
377                 /*
378                  * If platform_data doesn't specify rc_dev, initilize it
379                  * internally
380                  */
381                 rc = rc_allocate_device();
382                 if (!rc) {
383                         err = -ENOMEM;
384                         goto err_out_free;
385                 }
386         }
387         ir->rc = rc;
388
389         /* Make sure we are all setup before going on */
390         if (!name || !ir->get_key || !rc_type || !ir_codes) {
391                 dprintk(1, ": Unsupported device at address 0x%02x\n",
392                         addr);
393                 err = -ENODEV;
394                 goto err_out_free;
395         }
396
397         /* Sets name */
398         snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name);
399         ir->ir_codes = ir_codes;
400
401         snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0",
402                  dev_name(&adap->dev),
403                  dev_name(&client->dev));
404
405         /*
406          * Initialize input_dev fields
407          * It doesn't make sense to allow overriding them via platform_data
408          */
409         rc->input_id.bustype = BUS_I2C;
410         rc->input_phys       = ir->phys;
411         rc->input_name       = ir->name;
412
413         /*
414          * Initialize the other fields of rc_dev
415          */
416         rc->map_name       = ir->ir_codes;
417         rc->allowed_protos = rc_type;
418         if (!rc->driver_name)
419                 rc->driver_name = MODULE_NAME;
420
421         err = rc_register_device(rc);
422         if (err)
423                 goto err_out_free;
424
425         printk(MODULE_NAME ": %s detected at %s [%s]\n",
426                ir->name, ir->phys, adap->name);
427
428         /* start polling via eventd */
429         INIT_DELAYED_WORK(&ir->work, ir_work);
430         schedule_delayed_work(&ir->work, 0);
431
432         return 0;
433
434  err_out_free:
435         /* Only frees rc if it were allocated internally */
436         rc_free_device(rc);
437         kfree(ir);
438         return err;
439 }
440
441 static int ir_remove(struct i2c_client *client)
442 {
443         struct IR_i2c *ir = i2c_get_clientdata(client);
444
445         /* kill outstanding polls */
446         cancel_delayed_work_sync(&ir->work);
447
448         /* unregister device */
449         rc_unregister_device(ir->rc);
450
451         /* free memory */
452         kfree(ir);
453         return 0;
454 }
455
456 static const struct i2c_device_id ir_kbd_id[] = {
457         /* Generic entry for any IR receiver */
458         { "ir_video", 0 },
459         /* IR device specific entries should be added here */
460         { "ir_rx_z8f0811_haup", 0 },
461         { "ir_rx_z8f0811_hdpvr", 0 },
462         { }
463 };
464
465 static struct i2c_driver driver = {
466         .driver = {
467                 .name   = "ir-kbd-i2c",
468         },
469         .probe          = ir_probe,
470         .remove         = ir_remove,
471         .id_table       = ir_kbd_id,
472 };
473
474 /* ----------------------------------------------------------------------- */
475
476 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller");
477 MODULE_DESCRIPTION("input driver for i2c IR remote controls");
478 MODULE_LICENSE("GPL");
479
480 static int __init ir_init(void)
481 {
482         return i2c_add_driver(&driver);
483 }
484
485 static void __exit ir_fini(void)
486 {
487         i2c_del_driver(&driver);
488 }
489
490 module_init(ir_init);
491 module_exit(ir_fini);
492
493 /*
494  * Overrides for Emacs so that we follow Linus's tabbing style.
495  * ---------------------------------------------------------------------------
496  * Local variables:
497  * c-basic-offset: 8
498  * End:
499  */