]> bbs.cooldavid.org Git - net-next-2.6.git/blame - drivers/media/video/em28xx/em28xx-input.c
V4L/DVB: ir-core: export driver name used by IR via uevent
[net-next-2.6.git] / drivers / media / video / em28xx / em28xx-input.c
CommitLineData
d5e52653 1/*
f7abcd38
MCC
2 handle em28xx IR remotes via linux kernel input layer.
3
4 Copyright (C) 2005 Ludovico Cavedon <cavedon@sssup.it>
5 Markus Rechberger <mrechberger@gmail.com>
2e7c6dc3 6 Mauro Carvalho Chehab <mchehab@infradead.org>
f7abcd38
MCC
7 Sascha Sommer <saschasommer@freenet.de>
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
d5e52653
MCC
22 */
23
24#include <linux/module.h>
d5e52653
MCC
25#include <linux/init.h>
26#include <linux/delay.h>
d5e52653
MCC
27#include <linux/interrupt.h>
28#include <linux/input.h>
29#include <linux/usb.h>
5a0e3ad6 30#include <linux/slab.h>
d5e52653 31
f7abcd38 32#include "em28xx.h"
d5e52653 33
a9fc52bc
DH
34#define EM28XX_SNAPSHOT_KEY KEY_CAMERA
35#define EM28XX_SBUTTON_QUERY_INTERVAL 500
36#define EM28XX_R0C_USBSUSP_SNAPSHOT 0x20
37
c8793b03 38static unsigned int ir_debug;
d5e52653 39module_param(ir_debug, int, 0644);
6ea54d93 40MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
d5e52653 41
727e625c
MCC
42#define MODULE_NAME "em28xx"
43
a924a499 44#define i2cdprintk(fmt, arg...) \
6ea54d93 45 if (ir_debug) { \
1df8e986 46 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
6ea54d93 47 }
d5e52653 48
a924a499
MCC
49#define dprintk(fmt, arg...) \
50 if (ir_debug) { \
51 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
52 }
53
54/**********************************************************
55 Polling structure used by em28xx IR's
56 **********************************************************/
57
4b92253a
DH
58struct em28xx_ir_poll_result {
59 unsigned int toggle_bit:1;
60 unsigned int read_count:7;
61 u8 rc_address;
62 u8 rc_data[4]; /* 1 byte on em2860/2880, 4 on em2874 */
63};
64
a924a499
MCC
65struct em28xx_IR {
66 struct em28xx *dev;
67 struct input_dev *input;
68 struct ir_input_state ir;
69 char name[32];
70 char phys[32];
71
72 /* poll external decoder */
73 int polling;
f263bac9 74 struct delayed_work work;
4b92253a 75 unsigned int last_toggle:1;
0278155c 76 unsigned int full_code:1;
4b92253a
DH
77 unsigned int last_readcount;
78 unsigned int repeat_interval;
a924a499 79
4b92253a 80 int (*get_key)(struct em28xx_IR *, struct em28xx_ir_poll_result *);
950b0f5a
MCC
81
82 /* IR device properties */
83
84 struct ir_dev_props props;
a924a499
MCC
85};
86
87/**********************************************************
88 I2C IR based get keycodes - should be used with ir-kbd-i2c
89 **********************************************************/
d5e52653 90
c8793b03 91int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
e43f14af
MR
92{
93 unsigned char b;
94
95 /* poll IR chip */
c668f32d 96 if (1 != i2c_master_recv(ir->c, &b, 1)) {
a924a499 97 i2cdprintk("read error\n");
e43f14af
MR
98 return -EIO;
99 }
100
101 /* it seems that 0xFE indicates that a button is still hold
4f9c05aa
MCC
102 down, while 0xff indicates that no button is hold
103 down. 0xfe sequences are sometimes interrupted by 0xFF */
e43f14af 104
a924a499 105 i2cdprintk("key %02x\n", b);
e43f14af 106
4f9c05aa 107 if (b == 0xff)
e43f14af
MR
108 return 0;
109
4f9c05aa 110 if (b == 0xfe)
e43f14af
MR
111 /* keep old data */
112 return 1;
113
114 *ir_key = b;
115 *ir_raw = b;
116 return 1;
117}
118
c8793b03 119int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
d5e52653
MCC
120{
121 unsigned char buf[2];
b779974b
MCC
122 u16 code;
123 int size;
d5e52653
MCC
124
125 /* poll IR chip */
b779974b
MCC
126 size = i2c_master_recv(ir->c, buf, sizeof(buf));
127
128 if (size != 2)
d5e52653
MCC
129 return -EIO;
130
131 /* Does eliminate repeated parity code */
6ea54d93 132 if (buf[1] == 0xff)
d5e52653
MCC
133 return 0;
134
6ea54d93 135 ir->old = buf[1];
d5e52653 136
b779974b
MCC
137 /*
138 * Rearranges bits to the right order.
139 * The bit order were determined experimentally by using
140 * The original Hauppauge Grey IR and another RC5 that uses addr=0x08
141 * The RC5 code has 14 bits, but we've experimentally determined
142 * the meaning for only 11 bits.
143 * So, the code translation is not complete. Yet, it is enough to
144 * work with the provided RC5 IR.
145 */
146 code =
147 ((buf[0] & 0x01) ? 0x0020 : 0) | /* 0010 0000 */
148 ((buf[0] & 0x02) ? 0x0010 : 0) | /* 0001 0000 */
149 ((buf[0] & 0x04) ? 0x0008 : 0) | /* 0000 1000 */
150 ((buf[0] & 0x08) ? 0x0004 : 0) | /* 0000 0100 */
151 ((buf[0] & 0x10) ? 0x0002 : 0) | /* 0000 0010 */
152 ((buf[0] & 0x20) ? 0x0001 : 0) | /* 0000 0001 */
153 ((buf[1] & 0x08) ? 0x1000 : 0) | /* 0001 0000 */
154 ((buf[1] & 0x10) ? 0x0800 : 0) | /* 0000 1000 */
155 ((buf[1] & 0x20) ? 0x0400 : 0) | /* 0000 0100 */
156 ((buf[1] & 0x40) ? 0x0200 : 0) | /* 0000 0010 */
157 ((buf[1] & 0x80) ? 0x0100 : 0); /* 0000 0001 */
158
159 i2cdprintk("ir hauppauge (em2840): code=0x%02x (rcv=0x%02x%02x)\n",
160 code, buf[1], buf[0]);
d5e52653
MCC
161
162 /* return key */
163 *ir_key = code;
164 *ir_raw = code;
165 return 1;
166}
167
c8793b03
MCC
168int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
169 u32 *ir_raw)
366cc64b
MR
170{
171 unsigned char buf[3];
172
173 /* poll IR chip */
174
c668f32d 175 if (3 != i2c_master_recv(ir->c, buf, 3)) {
a924a499 176 i2cdprintk("read error\n");
366cc64b
MR
177 return -EIO;
178 }
179
a924a499 180 i2cdprintk("key %02x\n", buf[2]&0x3f);
6ea54d93 181 if (buf[0] != 0x00)
366cc64b 182 return 0;
366cc64b
MR
183
184 *ir_key = buf[2]&0x3f;
185 *ir_raw = buf[2]&0x3f;
186
187 return 1;
188}
189
ca39d84d
MA
190int em28xx_get_key_winfast_usbii_deluxe(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
191{
192 unsigned char subaddr, keydetect, key;
193
194 struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0, .buf = &subaddr, .len = 1},
195
196 { .addr = ir->c->addr, .flags = I2C_M_RD, .buf = &keydetect, .len = 1} };
197
198 subaddr = 0x10;
199 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
200 i2cdprintk("read error\n");
201 return -EIO;
202 }
203 if (keydetect == 0x00)
204 return 0;
205
206 subaddr = 0x00;
207 msg[1].buf = &key;
208 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
209 i2cdprintk("read error\n");
210 return -EIO;
211 }
212 if (key == 0x00)
213 return 0;
214
215 *ir_key = key;
216 *ir_raw = key;
217 return 1;
218}
219
a924a499
MCC
220/**********************************************************
221 Poll based get keycode functions
222 **********************************************************/
223
4b92253a
DH
224/* This is for the em2860/em2880 */
225static int default_polling_getkey(struct em28xx_IR *ir,
226 struct em28xx_ir_poll_result *poll_result)
a924a499
MCC
227{
228 struct em28xx *dev = ir->dev;
229 int rc;
4b92253a 230 u8 msg[3] = { 0, 0, 0 };
a924a499 231
0a6b8a85
MCC
232 /* Read key toggle, brand, and key code
233 on registers 0x45, 0x46 and 0x47
234 */
a924a499 235 rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
0a6b8a85 236 msg, sizeof(msg));
a924a499
MCC
237 if (rc < 0)
238 return rc;
239
4b92253a
DH
240 /* Infrared toggle (Reg 0x45[7]) */
241 poll_result->toggle_bit = (msg[0] >> 7);
242
243 /* Infrared read count (Reg 0x45[6:0] */
244 poll_result->read_count = (msg[0] & 0x7f);
245
246 /* Remote Control Address (Reg 0x46) */
247 poll_result->rc_address = msg[1];
248
249 /* Remote Control Data (Reg 0x47) */
250 poll_result->rc_data[0] = msg[2];
251
252 return 0;
253}
254
255static int em2874_polling_getkey(struct em28xx_IR *ir,
256 struct em28xx_ir_poll_result *poll_result)
257{
258 struct em28xx *dev = ir->dev;
259 int rc;
260 u8 msg[5] = { 0, 0, 0, 0, 0 };
261
262 /* Read key toggle, brand, and key code
263 on registers 0x51-55
264 */
265 rc = dev->em28xx_read_reg_req_len(dev, 0, EM2874_R51_IR,
266 msg, sizeof(msg));
267 if (rc < 0)
268 return rc;
269
270 /* Infrared toggle (Reg 0x51[7]) */
271 poll_result->toggle_bit = (msg[0] >> 7);
272
273 /* Infrared read count (Reg 0x51[6:0] */
274 poll_result->read_count = (msg[0] & 0x7f);
275
276 /* Remote Control Address (Reg 0x52) */
277 poll_result->rc_address = msg[1];
278
279 /* Remote Control Data (Reg 0x53-55) */
280 poll_result->rc_data[0] = msg[2];
281 poll_result->rc_data[1] = msg[3];
282 poll_result->rc_data[2] = msg[4];
283
284 return 0;
a924a499
MCC
285}
286
287/**********************************************************
288 Polling code for em28xx
289 **********************************************************/
290
291static void em28xx_ir_handle_key(struct em28xx_IR *ir)
292{
4b92253a
DH
293 int result;
294 int do_sendkey = 0;
295 struct em28xx_ir_poll_result poll_result;
296
297 /* read the registers containing the IR status */
298 result = ir->get_key(ir, &poll_result);
299 if (result < 0) {
300 dprintk("ir->get_key() failed %d\n", result);
a924a499 301 return;
4b92253a 302 }
a924a499 303
0278155c 304 dprintk("ir->get_key result tb=%02x rc=%02x lr=%02x data=%02x%02x\n",
4b92253a 305 poll_result.toggle_bit, poll_result.read_count,
0278155c
MCC
306 ir->last_readcount, poll_result.rc_address,
307 poll_result.rc_data[0]);
4b92253a
DH
308
309 if (ir->dev->chip_id == CHIP_ID_EM2874) {
310 /* The em2874 clears the readcount field every time the
311 register is read. The em2860/2880 datasheet says that it
312 is supposed to clear the readcount, but it doesn't. So with
313 the em2874, we are looking for a non-zero read count as
314 opposed to a readcount that is incrementing */
315 ir->last_readcount = 0;
316 }
0a6b8a85 317
4b92253a
DH
318 if (poll_result.read_count == 0) {
319 /* The button has not been pressed since the last read */
320 } else if (ir->last_toggle != poll_result.toggle_bit) {
321 /* A button has been pressed */
322 dprintk("button has been pressed\n");
323 ir->last_toggle = poll_result.toggle_bit;
324 ir->repeat_interval = 0;
325 do_sendkey = 1;
326 } else if (poll_result.toggle_bit == ir->last_toggle &&
327 poll_result.read_count > 0 &&
328 poll_result.read_count != ir->last_readcount) {
329 /* The button is still being held down */
330 dprintk("button being held down\n");
331
332 /* Debouncer for first keypress */
333 if (ir->repeat_interval++ > 9) {
334 /* Start repeating after 1 second */
335 do_sendkey = 1;
0a6b8a85 336 }
4b92253a
DH
337 }
338
339 if (do_sendkey) {
340 dprintk("sending keypress\n");
0278155c
MCC
341
342 if (ir->full_code)
343 ir_input_keydown(ir->input, &ir->ir,
344 poll_result.rc_address << 8 |
345 poll_result.rc_data[0]);
346 else
347 ir_input_keydown(ir->input, &ir->ir,
348 poll_result.rc_data[0]);
349
a924a499
MCC
350 ir_input_nokey(ir->input, &ir->ir);
351 }
4b92253a
DH
352
353 ir->last_readcount = poll_result.read_count;
354 return;
a924a499
MCC
355}
356
a924a499
MCC
357static void em28xx_ir_work(struct work_struct *work)
358{
f263bac9 359 struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work.work);
a924a499
MCC
360
361 em28xx_ir_handle_key(ir);
f263bac9 362 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
a924a499
MCC
363}
364
26cdc76b 365static void em28xx_ir_start(struct em28xx_IR *ir)
a924a499 366{
f263bac9
JD
367 INIT_DELAYED_WORK(&ir->work, em28xx_ir_work);
368 schedule_delayed_work(&ir->work, 0);
a924a499
MCC
369}
370
371static void em28xx_ir_stop(struct em28xx_IR *ir)
372{
f263bac9 373 cancel_delayed_work_sync(&ir->work);
a924a499
MCC
374}
375
971e8298 376int em28xx_ir_change_protocol(void *priv, u64 ir_type)
a924a499 377{
950b0f5a
MCC
378 int rc = 0;
379 struct em28xx_IR *ir = priv;
380 struct em28xx *dev = ir->dev;
381 u8 ir_config = EM2874_IR_RC5;
1bad429e
MCC
382
383 /* Adjust xclk based o IR table for RC5/NEC tables */
950b0f5a 384
3f831107 385 dev->board.ir_codes->ir_type = IR_TYPE_OTHER;
950b0f5a 386 if (ir_type == IR_TYPE_RC5) {
1bad429e
MCC
387 dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
388 ir->full_code = 1;
950b0f5a 389 } else if (ir_type == IR_TYPE_NEC) {
1bad429e
MCC
390 dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
391 ir_config = EM2874_IR_NEC;
392 ir->full_code = 1;
950b0f5a
MCC
393 } else
394 rc = -EINVAL;
395
3f831107
MCC
396 dev->board.ir_codes->ir_type = ir_type;
397
1bad429e
MCC
398 em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
399 EM28XX_XCLK_IR_RC5_MODE);
a924a499 400
4b92253a
DH
401 /* Setup the proper handler based on the chip */
402 switch (dev->chip_id) {
403 case CHIP_ID_EM2860:
404 case CHIP_ID_EM2883:
405 ir->get_key = default_polling_getkey;
91812fa7 406 break;
4b92253a
DH
407 case CHIP_ID_EM2874:
408 ir->get_key = em2874_polling_getkey;
4b92253a
DH
409 em28xx_write_regs(dev, EM2874_R50_IR_CONFIG, &ir_config, 1);
410 break;
411 default:
412 printk("Unrecognized em28xx chip id: IR not supported\n");
950b0f5a
MCC
413 rc = -EINVAL;
414 }
415
416 return rc;
417}
418
419int em28xx_ir_init(struct em28xx *dev)
420{
421 struct em28xx_IR *ir;
422 struct input_dev *input_dev;
423 int err = -ENOMEM;
424
425 if (dev->board.ir_codes == NULL) {
426 /* No remote control support */
427 return 0;
a924a499
MCC
428 }
429
950b0f5a
MCC
430 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
431 input_dev = input_allocate_device();
432 if (!ir || !input_dev)
433 goto err_out_free;
434
435 /* record handles to ourself */
436 ir->dev = dev;
437 dev->ir = ir;
438
439 ir->input = input_dev;
440
441 /*
442 * em2874 supports more protocols. For now, let's just announce
443 * the two protocols that were already tested
444 */
445 ir->props.allowed_protos = IR_TYPE_RC5 | IR_TYPE_NEC;
446 ir->props.priv = ir;
447 ir->props.change_protocol = em28xx_ir_change_protocol;
448
4b92253a
DH
449 /* This is how often we ask the chip for IR information */
450 ir->polling = 100; /* ms */
451
a924a499
MCC
452 /* init input device */
453 snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)",
454 dev->name);
455
456 usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
457 strlcat(ir->phys, "/input0", sizeof(ir->phys));
458
950b0f5a
MCC
459 /* Set IR protocol */
460 em28xx_ir_change_protocol(ir, dev->board.ir_codes->ir_type);
579e7d60 461 err = ir_input_init(input_dev, &ir->ir, IR_TYPE_OTHER);
055cd556
MCC
462 if (err < 0)
463 goto err_out_free;
464
a924a499
MCC
465 input_dev->name = ir->name;
466 input_dev->phys = ir->phys;
467 input_dev->id.bustype = BUS_USB;
468 input_dev->id.version = 1;
469 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
470 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
471
472 input_dev->dev.parent = &dev->udev->dev;
950b0f5a 473
a924a499
MCC
474
475 em28xx_ir_start(ir);
476
477 /* all done */
950b0f5a 478 err = ir_input_register(ir->input, dev->board.ir_codes,
727e625c 479 &ir->props, MODULE_NAME);
a924a499
MCC
480 if (err)
481 goto err_out_stop;
482
483 return 0;
484 err_out_stop:
485 em28xx_ir_stop(ir);
486 dev->ir = NULL;
487 err_out_free:
a924a499
MCC
488 kfree(ir);
489 return err;
490}
491
492int em28xx_ir_fini(struct em28xx *dev)
493{
494 struct em28xx_IR *ir = dev->ir;
495
496 /* skip detach on non attached boards */
497 if (!ir)
498 return 0;
499
500 em28xx_ir_stop(ir);
38ef6aa8 501 ir_input_unregister(ir->input);
a924a499
MCC
502 kfree(ir);
503
504 /* done */
505 dev->ir = NULL;
506 return 0;
507}
508
509/**********************************************************
510 Handle Webcam snapshot button
511 **********************************************************/
512
a9fc52bc
DH
513static void em28xx_query_sbutton(struct work_struct *work)
514{
515 /* Poll the register and see if the button is depressed */
516 struct em28xx *dev =
517 container_of(work, struct em28xx, sbutton_query_work.work);
518 int ret;
519
520 ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);
521
522 if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
523 u8 cleared;
524 /* Button is depressed, clear the register */
525 cleared = ((u8) ret) & ~EM28XX_R0C_USBSUSP_SNAPSHOT;
526 em28xx_write_regs(dev, EM28XX_R0C_USBSUSP, &cleared, 1);
527
528 /* Not emulate the keypress */
529 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
530 1);
531 /* Now unpress the key */
532 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
533 0);
534 }
535
536 /* Schedule next poll */
537 schedule_delayed_work(&dev->sbutton_query_work,
538 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
539}
540
541void em28xx_register_snapshot_button(struct em28xx *dev)
542{
543 struct input_dev *input_dev;
544 int err;
545
546 em28xx_info("Registering snapshot button...\n");
547 input_dev = input_allocate_device();
548 if (!input_dev) {
549 em28xx_errdev("input_allocate_device failed\n");
550 return;
551 }
552
553 usb_make_path(dev->udev, dev->snapshot_button_path,
554 sizeof(dev->snapshot_button_path));
555 strlcat(dev->snapshot_button_path, "/sbutton",
556 sizeof(dev->snapshot_button_path));
557 INIT_DELAYED_WORK(&dev->sbutton_query_work, em28xx_query_sbutton);
558
559 input_dev->name = "em28xx snapshot button";
560 input_dev->phys = dev->snapshot_button_path;
561 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
562 set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
563 input_dev->keycodesize = 0;
564 input_dev->keycodemax = 0;
565 input_dev->id.bustype = BUS_USB;
566 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
567 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
568 input_dev->id.version = 1;
569 input_dev->dev.parent = &dev->udev->dev;
570
571 err = input_register_device(input_dev);
572 if (err) {
573 em28xx_errdev("input_register_device failed\n");
574 input_free_device(input_dev);
575 return;
576 }
577
578 dev->sbutton_input_dev = input_dev;
579 schedule_delayed_work(&dev->sbutton_query_work,
580 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
581 return;
582
583}
584
585void em28xx_deregister_snapshot_button(struct em28xx *dev)
586{
587 if (dev->sbutton_input_dev != NULL) {
588 em28xx_info("Deregistering snapshot button\n");
589 cancel_rearming_delayed_work(&dev->sbutton_query_work);
590 input_unregister_device(dev->sbutton_input_dev);
591 dev->sbutton_input_dev = NULL;
592 }
593 return;
594}