]>
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 | |
1da177e4 | 50 | #include <media/ir-common.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 | ||
1da177e4 LT |
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 | ||
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 | ||
39cf1e81 JF |
125 | static inline 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 inline 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 | ||
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 | ||
d5e52653 | 149 | static int get_key_pv951(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw) |
1da177e4 | 150 | { |
4ac97914 | 151 | unsigned char b; |
1da177e4 LT |
152 | |
153 | /* poll IR chip */ | |
c668f32d | 154 | if (1 != i2c_master_recv(ir->c, &b, 1)) { |
1da177e4 LT |
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 | ||
3c44358c | 169 | static int get_key_fusionhdtv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw) |
d54d6980 CZ |
170 | { |
171 | unsigned char buf[4]; | |
172 | ||
173 | /* poll IR chip */ | |
c668f32d | 174 | if (4 != i2c_master_recv(ir->c, buf, 4)) { |
d54d6980 CZ |
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) | |
7e28adb2 | 180 | dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__, |
d54d6980 CZ |
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; | |
d54d6980 CZ |
191 | } |
192 | ||
d5e52653 | 193 | static int get_key_knc1(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw) |
1da177e4 LT |
194 | { |
195 | unsigned char b; | |
196 | ||
197 | /* poll IR chip */ | |
c668f32d | 198 | if (1 != i2c_master_recv(ir->c, &b, 1)) { |
1da177e4 LT |
199 | dprintk(1,"read error\n"); |
200 | return -EIO; | |
201 | } | |
202 | ||
203 | /* it seems that 0xFE indicates that a button is still hold | |
4f9c05aa MCC |
204 | down, while 0xff indicates that no button is hold |
205 | down. 0xfe sequences are sometimes interrupted by 0xFF */ | |
1da177e4 LT |
206 | |
207 | dprintk(2,"key %02x\n", b); | |
208 | ||
4f9c05aa | 209 | if (b == 0xff) |
1da177e4 LT |
210 | return 0; |
211 | ||
4f9c05aa | 212 | if (b == 0xfe) |
1da177e4 LT |
213 | /* keep old data */ |
214 | return 1; | |
215 | ||
216 | *ir_key = b; | |
217 | *ir_raw = b; | |
218 | return 1; | |
219 | } | |
220 | ||
cb3bf504 OJ |
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; | |
c668f32d | 225 | struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0, |
cb3bf504 | 226 | .buf = &subaddr, .len = 1}, |
c668f32d | 227 | { .addr = ir->c->addr, .flags = I2C_M_RD, |
cb3bf504 OJ |
228 | .buf = &key, .len = 1} }; |
229 | subaddr = 0x0d; | |
c668f32d | 230 | if (2 != i2c_transfer(ir->c->adapter, msg, 2)) { |
cb3bf504 OJ |
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; | |
c668f32d | 240 | if (2 != i2c_transfer(ir->c->adapter, msg, 2)) { |
cb3bf504 OJ |
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 | ||
1da177e4 LT |
261 | /* ----------------------------------------------------------------------- */ |
262 | ||
d5e52653 | 263 | static void ir_key_poll(struct IR_i2c *ir) |
1da177e4 LT |
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) { | |
b7df3910 | 276 | ir_input_nokey(ir->input, &ir->ir); |
1da177e4 | 277 | } else { |
b7df3910 | 278 | ir_input_keydown(ir->input, &ir->ir, ir_key, ir_raw); |
1da177e4 LT |
279 | } |
280 | } | |
281 | ||
c4028958 | 282 | static void ir_work(struct work_struct *work) |
1da177e4 | 283 | { |
c1089bdc | 284 | struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work); |
ba340b40 BR |
285 | int polling_interval = 100; |
286 | ||
287 | /* MSI TV@nywhere Plus requires more frequent polling | |
288 | otherwise it will miss some keypresses */ | |
c668f32d | 289 | if (ir->c->adapter->id == I2C_HW_SAA7134 && ir->c->addr == 0x30) |
ba340b40 | 290 | polling_interval = 50; |
8083c520 | 291 | |
1da177e4 | 292 | ir_key_poll(ir); |
c1089bdc | 293 | schedule_delayed_work(&ir->work, msecs_to_jiffies(polling_interval)); |
1da177e4 LT |
294 | } |
295 | ||
296 | /* ----------------------------------------------------------------------- */ | |
297 | ||
c668f32d | 298 | static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id) |
1da177e4 LT |
299 | { |
300 | IR_KEYTAB_TYPE *ir_codes = NULL; | |
4d7a2d67 | 301 | const char *name; |
1da177e4 | 302 | int ir_type; |
afd1a0c9 | 303 | struct IR_i2c *ir; |
b7df3910 | 304 | struct input_dev *input_dev; |
c668f32d JD |
305 | struct i2c_adapter *adap = client->adapter; |
306 | unsigned short addr = client->addr; | |
b07b4783 | 307 | int err; |
1da177e4 | 308 | |
674434c6 | 309 | ir = kzalloc(sizeof(struct IR_i2c),GFP_KERNEL); |
b7df3910 DT |
310 | input_dev = input_allocate_device(); |
311 | if (!ir || !input_dev) { | |
b07b4783 DT |
312 | err = -ENOMEM; |
313 | goto err_out_free; | |
b7df3910 DT |
314 | } |
315 | ||
c668f32d | 316 | ir->c = client; |
b7df3910 | 317 | ir->input = input_dev; |
c668f32d | 318 | i2c_set_clientdata(client, ir); |
d21838dd | 319 | |
1da177e4 LT |
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; | |
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; | |
332 | break; | |
333 | case 0x18: | |
334 | case 0x1a: | |
335 | name = "Hauppauge"; | |
336 | ir->get_key = get_key_haup; | |
337 | ir_type = IR_TYPE_RC5; | |
bf47e4e4 | 338 | if (hauppauge == 1) { |
4c0f631e | 339 | ir_codes = ir_codes_hauppauge_new; |
bf47e4e4 A |
340 | } else { |
341 | ir_codes = ir_codes_rc5_tv; | |
342 | } | |
1da177e4 LT |
343 | break; |
344 | case 0x30: | |
d5e52653 MCC |
345 | name = "KNC One"; |
346 | ir->get_key = get_key_knc1; | |
347 | ir_type = IR_TYPE_OTHER; | |
348 | ir_codes = ir_codes_empty; | |
1da177e4 | 349 | break; |
d54d6980 | 350 | case 0x6b: |
3c44358c MK |
351 | name = "FusionHDTV"; |
352 | ir->get_key = get_key_fusionhdtv; | |
d54d6980 | 353 | ir_type = IR_TYPE_RC5; |
3c44358c | 354 | ir_codes = ir_codes_fusionhdtv_mce; |
d54d6980 | 355 | break; |
1da177e4 | 356 | case 0x7a: |
ac9cd976 | 357 | case 0x47: |
177aaaf8 | 358 | case 0x71: |
e8018c9e | 359 | case 0x2d: |
39cf1e81 JF |
360 | if (adap->id == I2C_HW_B_CX2388x) { |
361 | /* Handled by cx88-input */ | |
362 | name = "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; | |
367 | } else { | |
368 | ir_codes = ir_codes_rc5_tv; | |
369 | } | |
370 | } else { | |
371 | /* Handled by saa7134-input */ | |
372 | name = "SAA713x remote"; | |
373 | ir_type = IR_TYPE_OTHER; | |
374 | } | |
1da177e4 | 375 | break; |
cb3bf504 OJ |
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; | |
381 | break; | |
1da177e4 LT |
382 | default: |
383 | /* shouldn't happen */ | |
b07b4783 DT |
384 | printk(DEVNAME ": Huh? unknown i2c address (0x%02x)?\n", addr); |
385 | err = -ENODEV; | |
386 | goto err_out_free; | |
1da177e4 LT |
387 | } |
388 | ||
4d7a2d67 JD |
389 | /* Let the caller override settings */ |
390 | if (client->dev.platform_data) { | |
391 | const struct IR_i2c_init_data *init_data = | |
392 | client->dev.platform_data; | |
393 | ||
394 | ir_codes = init_data->ir_codes; | |
395 | name = init_data->name; | |
396 | ir->get_key = init_data->get_key; | |
397 | } | |
398 | ||
ac9cd976 | 399 | /* Sets name */ |
1df8e986 | 400 | snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name); |
b07b4783 | 401 | ir->ir_codes = ir_codes; |
d5e52653 | 402 | |
ac9cd976 | 403 | snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0", |
c668f32d JD |
404 | dev_name(&adap->dev), |
405 | dev_name(&client->dev)); | |
ac9cd976 | 406 | |
1da177e4 | 407 | /* init + register input device */ |
b07b4783 | 408 | ir_input_init(input_dev, &ir->ir, ir_type, ir->ir_codes); |
d21838dd | 409 | input_dev->id.bustype = BUS_I2C; |
1df8e986 | 410 | input_dev->name = ir->name; |
d21838dd | 411 | input_dev->phys = ir->phys; |
b7df3910 | 412 | |
b07b4783 DT |
413 | err = input_register_device(ir->input); |
414 | if (err) | |
c668f32d | 415 | goto err_out_free; |
b07b4783 | 416 | |
d21838dd | 417 | printk(DEVNAME ": %s detected at %s [%s]\n", |
b07b4783 | 418 | ir->input->name, ir->input->phys, adap->name); |
1da177e4 LT |
419 | |
420 | /* start polling via eventd */ | |
c1089bdc JD |
421 | INIT_DELAYED_WORK(&ir->work, ir_work); |
422 | schedule_delayed_work(&ir->work, 0); | |
1da177e4 LT |
423 | |
424 | return 0; | |
b07b4783 | 425 | |
b07b4783 DT |
426 | err_out_free: |
427 | input_free_device(input_dev); | |
428 | kfree(ir); | |
429 | return err; | |
1da177e4 LT |
430 | } |
431 | ||
c668f32d | 432 | static int ir_remove(struct i2c_client *client) |
1da177e4 | 433 | { |
4ac97914 | 434 | struct IR_i2c *ir = i2c_get_clientdata(client); |
1da177e4 LT |
435 | |
436 | /* kill outstanding polls */ | |
c1089bdc | 437 | cancel_delayed_work_sync(&ir->work); |
1da177e4 | 438 | |
c668f32d | 439 | /* unregister device */ |
b7df3910 | 440 | input_unregister_device(ir->input); |
1da177e4 LT |
441 | |
442 | /* free memory */ | |
443 | kfree(ir); | |
444 | return 0; | |
445 | } | |
446 | ||
c668f32d JD |
447 | static const struct i2c_device_id ir_kbd_id[] = { |
448 | /* Generic entry for any IR receiver */ | |
449 | { "ir_video", 0 }, | |
450 | /* IR device specific entries could be added here */ | |
451 | { } | |
452 | }; | |
cb3bf504 | 453 | |
c668f32d JD |
454 | static struct i2c_driver driver = { |
455 | .driver = { | |
456 | .name = "ir-kbd-i2c", | |
457 | }, | |
458 | .probe = ir_probe, | |
459 | .remove = ir_remove, | |
460 | .id_table = ir_kbd_id, | |
461 | }; | |
1da177e4 LT |
462 | |
463 | /* ----------------------------------------------------------------------- */ | |
464 | ||
465 | MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller"); | |
466 | MODULE_DESCRIPTION("input driver for i2c IR remote controls"); | |
467 | MODULE_LICENSE("GPL"); | |
468 | ||
469 | static int __init ir_init(void) | |
470 | { | |
471 | return i2c_add_driver(&driver); | |
472 | } | |
473 | ||
474 | static void __exit ir_fini(void) | |
475 | { | |
476 | i2c_del_driver(&driver); | |
477 | } | |
478 | ||
479 | module_init(ir_init); | |
480 | module_exit(ir_fini); | |
481 | ||
482 | /* | |
483 | * Overrides for Emacs so that we follow Linus's tabbing style. | |
484 | * --------------------------------------------------------------------------- | |
485 | * Local variables: | |
486 | * c-basic-offset: 8 | |
487 | * End: | |
488 | */ |