[media] ir-core: make struct rc_dev the primary interface
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / media / video / ir-kbd-i2c.c
CommitLineData
1da177e4 1/*
1da177e4
LT
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>
c365864f
MR
11 * modified for em2820 based USB TV tuners by
12 * Markus Rechberger <mrechberger@gmail.com>
d54d6980
CZ
13 * modified for DViCO Fusion HDTV 5 RT GOLD by
14 * Chaogui Zhang <czhang1974@gmail.com>
ba340b40
BR
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>
cb3bf504
OJ
19 * modified for AVerMedia Cardbus by
20 * Oldrich Jedlicka <oldium.pro@seznam.cz>
1da177e4
LT
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>
1da177e4
LT
39#include <linux/init.h>
40#include <linux/kernel.h>
1da177e4
LT
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>
674434c6 48
0dc50942 49#include <media/ir-core.h>
d5e52653 50#include <media/ir-kbd-i2c.h>
c365864f 51
1da177e4
LT
52/* ----------------------------------------------------------------------- */
53/* insmod parameters */
54
55static int debug;
56module_param(debug, int, 0644); /* debug level (0,1,2) */
57
ff699e6b 58static int hauppauge;
bf47e4e4
A
59module_param(hauppauge, int, 0644); /* Choose Hauppauge remote */
60MODULE_PARM_DESC(hauppauge, "Specify Hauppauge remote: 0=black, 1=grey (defaults to 0)");
61
62
727e625c 63#define MODULE_NAME "ir-kbd-i2c"
1da177e4 64#define dprintk(level, fmt, arg...) if (debug >= level) \
727e625c 65 printk(KERN_DEBUG MODULE_NAME ": " fmt , ## arg)
1da177e4
LT
66
67/* ----------------------------------------------------------------------- */
68
39cf1e81
JF
69static int get_key_haup_common(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw,
70 int size, int offset)
1da177e4 71{
39cf1e81 72 unsigned char buf[6];
34c08029 73 int start, range, toggle, dev, code, ircode;
1da177e4
LT
74
75 /* poll IR chip */
c668f32d 76 if (size != i2c_master_recv(ir->c, buf, size))
1da177e4
LT
77 return -EIO;
78
79 /* split rc5 data block ... */
39cf1e81
JF
80 start = (buf[offset] >> 7) & 1;
81 range = (buf[offset] >> 6) & 1;
82 toggle = (buf[offset] >> 5) & 1;
83 dev = buf[offset] & 0x1f;
84 code = (buf[offset+1] >> 2) & 0x3f;
1da177e4 85
cc7093df
DH
86 /* rc5 has two start bits
87 * the first bit must be one
88 * the second bit defines the command range (1 = 0-63, 0 = 64 - 127)
89 */
90 if (!start)
1da177e4
LT
91 /* no key pressed */
92 return 0;
34c08029
DB
93 /*
94 * Hauppauge remotes (black/silver) always use
95 * specific device ids. If we do not filter the
96 * device ids then messages destined for devices
97 * such as TVs (id=0) will get through causing
98 * mis-fired events.
99 *
100 * We also filter out invalid key presses which
101 * produce annoying debug log entries.
102 */
103 ircode= (start << 12) | (toggle << 11) | (dev << 6) | code;
104 if ((ircode & 0x1fff)==0x1fff)
105 /* invalid key press */
106 return 0;
107
108 if (dev!=0x1e && dev!=0x1f)
109 /* not a hauppauge remote */
110 return 0;
cc7093df
DH
111
112 if (!range)
113 code += 64;
114
115 dprintk(1,"ir hauppauge (rc5): s%d r%d t%d dev=%d code=%d\n",
116 start, range, toggle, dev, code);
1da177e4
LT
117
118 /* return key */
119 *ir_key = code;
34c08029 120 *ir_raw = ircode;
1da177e4
LT
121 return 1;
122}
123
157da276 124static int get_key_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
39cf1e81
JF
125{
126 return get_key_haup_common (ir, ir_key, ir_raw, 3, 0);
127}
128
157da276 129static int get_key_haup_xvr(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
39cf1e81
JF
130{
131 return get_key_haup_common (ir, ir_key, ir_raw, 6, 3);
132}
133
d5e52653 134static int get_key_pixelview(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
1da177e4 135{
4ac97914 136 unsigned char b;
1da177e4
LT
137
138 /* poll IR chip */
c668f32d 139 if (1 != i2c_master_recv(ir->c, &b, 1)) {
1da177e4
LT
140 dprintk(1,"read error\n");
141 return -EIO;
142 }
143 *ir_key = b;
144 *ir_raw = b;
145 return 1;
146}
147
3c44358c 148static int get_key_fusionhdtv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
d54d6980
CZ
149{
150 unsigned char buf[4];
151
152 /* poll IR chip */
c668f32d 153 if (4 != i2c_master_recv(ir->c, buf, 4)) {
d54d6980
CZ
154 dprintk(1,"read error\n");
155 return -EIO;
156 }
157
158 if(buf[0] !=0 || buf[1] !=0 || buf[2] !=0 || buf[3] != 0)
7e28adb2 159 dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__,
d54d6980
CZ
160 buf[0], buf[1], buf[2], buf[3]);
161
162 /* no key pressed or signal from other ir remote */
163 if(buf[0] != 0x1 || buf[1] != 0xfe)
164 return 0;
165
166 *ir_key = buf[2];
167 *ir_raw = (buf[2] << 8) | buf[3];
168
169 return 1;
d54d6980
CZ
170}
171
d5e52653 172static int get_key_knc1(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
1da177e4
LT
173{
174 unsigned char b;
175
176 /* poll IR chip */
c668f32d 177 if (1 != i2c_master_recv(ir->c, &b, 1)) {
1da177e4
LT
178 dprintk(1,"read error\n");
179 return -EIO;
180 }
181
182 /* it seems that 0xFE indicates that a button is still hold
4f9c05aa
MCC
183 down, while 0xff indicates that no button is hold
184 down. 0xfe sequences are sometimes interrupted by 0xFF */
1da177e4
LT
185
186 dprintk(2,"key %02x\n", b);
187
4f9c05aa 188 if (b == 0xff)
1da177e4
LT
189 return 0;
190
4f9c05aa 191 if (b == 0xfe)
1da177e4
LT
192 /* keep old data */
193 return 1;
194
195 *ir_key = b;
196 *ir_raw = b;
197 return 1;
198}
199
cb3bf504
OJ
200static int get_key_avermedia_cardbus(struct IR_i2c *ir,
201 u32 *ir_key, u32 *ir_raw)
202{
203 unsigned char subaddr, key, keygroup;
c668f32d 204 struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0,
cb3bf504 205 .buf = &subaddr, .len = 1},
c668f32d 206 { .addr = ir->c->addr, .flags = I2C_M_RD,
cb3bf504
OJ
207 .buf = &key, .len = 1} };
208 subaddr = 0x0d;
c668f32d 209 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
cb3bf504
OJ
210 dprintk(1, "read error\n");
211 return -EIO;
212 }
213
214 if (key == 0xff)
215 return 0;
216
217 subaddr = 0x0b;
218 msg[1].buf = &keygroup;
c668f32d 219 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
cb3bf504
OJ
220 dprintk(1, "read error\n");
221 return -EIO;
222 }
223
224 if (keygroup == 0xff)
225 return 0;
226
227 dprintk(1, "read key 0x%02x/0x%02x\n", key, keygroup);
228 if (keygroup < 2 || keygroup > 3) {
229 /* Only a warning */
230 dprintk(1, "warning: invalid key group 0x%02x for key 0x%02x\n",
231 keygroup, key);
232 }
233 key |= (keygroup & 1) << 6;
234
235 *ir_key = key;
236 *ir_raw = key;
237 return 1;
238}
239
1da177e4
LT
240/* ----------------------------------------------------------------------- */
241
d5e52653 242static void ir_key_poll(struct IR_i2c *ir)
1da177e4
LT
243{
244 static u32 ir_key, ir_raw;
245 int rc;
246
247 dprintk(2,"ir_poll_key\n");
248 rc = ir->get_key(ir, &ir_key, &ir_raw);
249 if (rc < 0) {
250 dprintk(2,"error\n");
251 return;
252 }
253
0dc50942 254 if (rc)
d8b4b582 255 ir_keydown(ir->rc, ir_key, 0);
1da177e4
LT
256}
257
c4028958 258static void ir_work(struct work_struct *work)
1da177e4 259{
c1089bdc 260 struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work);
8083c520 261
1da177e4 262 ir_key_poll(ir);
c72ba8e6 263 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling_interval));
1da177e4
LT
264}
265
266/* ----------------------------------------------------------------------- */
267
c668f32d 268static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id)
1da177e4 269{
02858eed 270 char *ir_codes = NULL;
9a4cc5ac 271 const char *name = NULL;
62c65031 272 u64 ir_type = IR_TYPE_UNKNOWN;
afd1a0c9 273 struct IR_i2c *ir;
d8b4b582 274 struct rc_dev *rc;
c668f32d
JD
275 struct i2c_adapter *adap = client->adapter;
276 unsigned short addr = client->addr;
b07b4783 277 int err;
1da177e4 278
674434c6 279 ir = kzalloc(sizeof(struct IR_i2c),GFP_KERNEL);
d8b4b582
DH
280 rc = rc_allocate_device();
281 if (!ir || !rc) {
b07b4783
DT
282 err = -ENOMEM;
283 goto err_out_free;
b7df3910
DT
284 }
285
c668f32d 286 ir->c = client;
d8b4b582 287 ir->rc = rc;
c72ba8e6 288 ir->polling_interval = DEFAULT_POLLING_INTERVAL;
c668f32d 289 i2c_set_clientdata(client, ir);
d21838dd 290
1da177e4
LT
291 switch(addr) {
292 case 0x64:
293 name = "Pixelview";
294 ir->get_key = get_key_pixelview;
295 ir_type = IR_TYPE_OTHER;
02858eed 296 ir_codes = RC_MAP_EMPTY;
1da177e4 297 break;
1da177e4 298 case 0x18:
ca39d84d 299 case 0x1f:
1da177e4
LT
300 case 0x1a:
301 name = "Hauppauge";
302 ir->get_key = get_key_haup;
303 ir_type = IR_TYPE_RC5;
bf47e4e4 304 if (hauppauge == 1) {
02858eed 305 ir_codes = RC_MAP_HAUPPAUGE_NEW;
bf47e4e4 306 } else {
02858eed 307 ir_codes = RC_MAP_RC5_TV;
bf47e4e4 308 }
1da177e4
LT
309 break;
310 case 0x30:
d5e52653
MCC
311 name = "KNC One";
312 ir->get_key = get_key_knc1;
313 ir_type = IR_TYPE_OTHER;
02858eed 314 ir_codes = RC_MAP_EMPTY;
1da177e4 315 break;
d54d6980 316 case 0x6b:
3c44358c
MK
317 name = "FusionHDTV";
318 ir->get_key = get_key_fusionhdtv;
d54d6980 319 ir_type = IR_TYPE_RC5;
02858eed 320 ir_codes = RC_MAP_FUSIONHDTV_MCE;
d54d6980 321 break;
cb3bf504
OJ
322 case 0x40:
323 name = "AVerMedia Cardbus remote";
324 ir->get_key = get_key_avermedia_cardbus;
325 ir_type = IR_TYPE_OTHER;
02858eed 326 ir_codes = RC_MAP_AVERMEDIA_CARDBUS;
cb3bf504 327 break;
1da177e4
LT
328 }
329
4d7a2d67
JD
330 /* Let the caller override settings */
331 if (client->dev.platform_data) {
332 const struct IR_i2c_init_data *init_data =
333 client->dev.platform_data;
334
335 ir_codes = init_data->ir_codes;
336 name = init_data->name;
1b6e59e3
AW
337 if (init_data->type)
338 ir_type = init_data->type;
339
c72ba8e6
MCC
340 if (init_data->polling_interval)
341 ir->polling_interval = init_data->polling_interval;
342
1b6e59e3
AW
343 switch (init_data->internal_get_key_func) {
344 case IR_KBD_GET_KEY_CUSTOM:
345 /* The bridge driver provided us its own function */
346 ir->get_key = init_data->get_key;
347 break;
348 case IR_KBD_GET_KEY_PIXELVIEW:
349 ir->get_key = get_key_pixelview;
350 break;
1b6e59e3
AW
351 case IR_KBD_GET_KEY_HAUP:
352 ir->get_key = get_key_haup;
353 break;
354 case IR_KBD_GET_KEY_KNC1:
355 ir->get_key = get_key_knc1;
356 break;
357 case IR_KBD_GET_KEY_FUSIONHDTV:
358 ir->get_key = get_key_fusionhdtv;
359 break;
360 case IR_KBD_GET_KEY_HAUP_XVR:
361 ir->get_key = get_key_haup_xvr;
362 break;
363 case IR_KBD_GET_KEY_AVERMEDIA_CARDBUS:
364 ir->get_key = get_key_avermedia_cardbus;
365 break;
366 }
4d7a2d67
JD
367 }
368
9a4cc5ac 369 /* Make sure we are all setup before going on */
7ef68e60 370 if (!name || !ir->get_key || !ir_type || !ir_codes) {
d995a187 371 dprintk(1, ": Unsupported device at address 0x%02x\n",
9a4cc5ac
JD
372 addr);
373 err = -ENODEV;
374 goto err_out_free;
375 }
376
ac9cd976 377 /* Sets name */
1df8e986 378 snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name);
b07b4783 379 ir->ir_codes = ir_codes;
d5e52653 380
ac9cd976 381 snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0",
c668f32d
JD
382 dev_name(&adap->dev),
383 dev_name(&client->dev));
ac9cd976 384
1da177e4 385 /* init + register input device */
d8b4b582
DH
386 rc->input_id.bustype = BUS_I2C;
387 rc->input_name = ir->name;
388 rc->input_phys = ir->phys;
389 rc->map_name = ir->ir_codes;
390 rc->driver_name = MODULE_NAME;
b7df3910 391
d8b4b582 392 err = rc_register_device(rc);
b07b4783 393 if (err)
c668f32d 394 goto err_out_free;
b07b4783 395
727e625c 396 printk(MODULE_NAME ": %s detected at %s [%s]\n",
d8b4b582 397 ir->name, ir->phys, adap->name);
1da177e4
LT
398
399 /* start polling via eventd */
c1089bdc
JD
400 INIT_DELAYED_WORK(&ir->work, ir_work);
401 schedule_delayed_work(&ir->work, 0);
1da177e4
LT
402
403 return 0;
b07b4783 404
b07b4783 405 err_out_free:
d8b4b582 406 rc_free_device(rc);
b07b4783
DT
407 kfree(ir);
408 return err;
1da177e4
LT
409}
410
c668f32d 411static int ir_remove(struct i2c_client *client)
1da177e4 412{
4ac97914 413 struct IR_i2c *ir = i2c_get_clientdata(client);
1da177e4
LT
414
415 /* kill outstanding polls */
c1089bdc 416 cancel_delayed_work_sync(&ir->work);
1da177e4 417
c668f32d 418 /* unregister device */
d8b4b582 419 rc_unregister_device(ir->rc);
1da177e4
LT
420
421 /* free memory */
422 kfree(ir);
423 return 0;
424}
425
c668f32d
JD
426static const struct i2c_device_id ir_kbd_id[] = {
427 /* Generic entry for any IR receiver */
428 { "ir_video", 0 },
f5d887ae
AW
429 /* IR device specific entries should be added here */
430 { "ir_rx_z8f0811_haup", 0 },
c668f32d
JD
431 { }
432};
cb3bf504 433
c668f32d
JD
434static struct i2c_driver driver = {
435 .driver = {
436 .name = "ir-kbd-i2c",
437 },
438 .probe = ir_probe,
439 .remove = ir_remove,
440 .id_table = ir_kbd_id,
441};
1da177e4
LT
442
443/* ----------------------------------------------------------------------- */
444
445MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller");
446MODULE_DESCRIPTION("input driver for i2c IR remote controls");
447MODULE_LICENSE("GPL");
448
449static int __init ir_init(void)
450{
451 return i2c_add_driver(&driver);
452}
453
454static void __exit ir_fini(void)
455{
456 i2c_del_driver(&driver);
457}
458
459module_init(ir_init);
460module_exit(ir_fini);
461
462/*
463 * Overrides for Emacs so that we follow Linus's tabbing style.
464 * ---------------------------------------------------------------------------
465 * Local variables:
466 * c-basic-offset: 8
467 * End:
468 */