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