[media] rc-core: Code cleanup after merging rc-sysfs and rc-map into rc-main
[linux-2.6-block.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;
a924a499
MCC
68 char name[32];
69 char phys[32];
70
71 /* poll external decoder */
72 int polling;
f263bac9 73 struct delayed_work work;
0278155c 74 unsigned int full_code:1;
4b92253a 75 unsigned int last_readcount;
a924a499 76
4b92253a 77 int (*get_key)(struct em28xx_IR *, struct em28xx_ir_poll_result *);
950b0f5a
MCC
78
79 /* IR device properties */
80
81 struct ir_dev_props props;
a924a499
MCC
82};
83
84/**********************************************************
85 I2C IR based get keycodes - should be used with ir-kbd-i2c
86 **********************************************************/
d5e52653 87
c8793b03 88int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
e43f14af
MR
89{
90 unsigned char b;
91
92 /* poll IR chip */
c668f32d 93 if (1 != i2c_master_recv(ir->c, &b, 1)) {
a924a499 94 i2cdprintk("read error\n");
e43f14af
MR
95 return -EIO;
96 }
97
98 /* it seems that 0xFE indicates that a button is still hold
4f9c05aa
MCC
99 down, while 0xff indicates that no button is hold
100 down. 0xfe sequences are sometimes interrupted by 0xFF */
e43f14af 101
a924a499 102 i2cdprintk("key %02x\n", b);
e43f14af 103
4f9c05aa 104 if (b == 0xff)
e43f14af
MR
105 return 0;
106
4f9c05aa 107 if (b == 0xfe)
e43f14af
MR
108 /* keep old data */
109 return 1;
110
111 *ir_key = b;
112 *ir_raw = b;
113 return 1;
114}
115
c8793b03 116int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
d5e52653
MCC
117{
118 unsigned char buf[2];
b779974b
MCC
119 u16 code;
120 int size;
d5e52653
MCC
121
122 /* poll IR chip */
b779974b
MCC
123 size = i2c_master_recv(ir->c, buf, sizeof(buf));
124
125 if (size != 2)
d5e52653
MCC
126 return -EIO;
127
128 /* Does eliminate repeated parity code */
6ea54d93 129 if (buf[1] == 0xff)
d5e52653
MCC
130 return 0;
131
6ea54d93 132 ir->old = buf[1];
d5e52653 133
b779974b
MCC
134 /*
135 * Rearranges bits to the right order.
136 * The bit order were determined experimentally by using
137 * The original Hauppauge Grey IR and another RC5 that uses addr=0x08
138 * The RC5 code has 14 bits, but we've experimentally determined
139 * the meaning for only 11 bits.
140 * So, the code translation is not complete. Yet, it is enough to
141 * work with the provided RC5 IR.
142 */
143 code =
144 ((buf[0] & 0x01) ? 0x0020 : 0) | /* 0010 0000 */
145 ((buf[0] & 0x02) ? 0x0010 : 0) | /* 0001 0000 */
146 ((buf[0] & 0x04) ? 0x0008 : 0) | /* 0000 1000 */
147 ((buf[0] & 0x08) ? 0x0004 : 0) | /* 0000 0100 */
148 ((buf[0] & 0x10) ? 0x0002 : 0) | /* 0000 0010 */
149 ((buf[0] & 0x20) ? 0x0001 : 0) | /* 0000 0001 */
150 ((buf[1] & 0x08) ? 0x1000 : 0) | /* 0001 0000 */
151 ((buf[1] & 0x10) ? 0x0800 : 0) | /* 0000 1000 */
152 ((buf[1] & 0x20) ? 0x0400 : 0) | /* 0000 0100 */
153 ((buf[1] & 0x40) ? 0x0200 : 0) | /* 0000 0010 */
154 ((buf[1] & 0x80) ? 0x0100 : 0); /* 0000 0001 */
155
156 i2cdprintk("ir hauppauge (em2840): code=0x%02x (rcv=0x%02x%02x)\n",
157 code, buf[1], buf[0]);
d5e52653
MCC
158
159 /* return key */
160 *ir_key = code;
161 *ir_raw = code;
162 return 1;
163}
164
c8793b03
MCC
165int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
166 u32 *ir_raw)
366cc64b
MR
167{
168 unsigned char buf[3];
169
170 /* poll IR chip */
171
c668f32d 172 if (3 != i2c_master_recv(ir->c, buf, 3)) {
a924a499 173 i2cdprintk("read error\n");
366cc64b
MR
174 return -EIO;
175 }
176
a924a499 177 i2cdprintk("key %02x\n", buf[2]&0x3f);
6ea54d93 178 if (buf[0] != 0x00)
366cc64b 179 return 0;
366cc64b
MR
180
181 *ir_key = buf[2]&0x3f;
182 *ir_raw = buf[2]&0x3f;
183
184 return 1;
185}
186
ca39d84d
MA
187int em28xx_get_key_winfast_usbii_deluxe(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
188{
189 unsigned char subaddr, keydetect, key;
190
191 struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0, .buf = &subaddr, .len = 1},
192
193 { .addr = ir->c->addr, .flags = I2C_M_RD, .buf = &keydetect, .len = 1} };
194
195 subaddr = 0x10;
196 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
197 i2cdprintk("read error\n");
198 return -EIO;
199 }
200 if (keydetect == 0x00)
201 return 0;
202
203 subaddr = 0x00;
204 msg[1].buf = &key;
205 if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
206 i2cdprintk("read error\n");
207 return -EIO;
208 }
209 if (key == 0x00)
210 return 0;
211
212 *ir_key = key;
213 *ir_raw = key;
214 return 1;
215}
216
a924a499
MCC
217/**********************************************************
218 Poll based get keycode functions
219 **********************************************************/
220
4b92253a
DH
221/* This is for the em2860/em2880 */
222static int default_polling_getkey(struct em28xx_IR *ir,
223 struct em28xx_ir_poll_result *poll_result)
a924a499
MCC
224{
225 struct em28xx *dev = ir->dev;
226 int rc;
4b92253a 227 u8 msg[3] = { 0, 0, 0 };
a924a499 228
0a6b8a85
MCC
229 /* Read key toggle, brand, and key code
230 on registers 0x45, 0x46 and 0x47
231 */
a924a499 232 rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
0a6b8a85 233 msg, sizeof(msg));
a924a499
MCC
234 if (rc < 0)
235 return rc;
236
4b92253a
DH
237 /* Infrared toggle (Reg 0x45[7]) */
238 poll_result->toggle_bit = (msg[0] >> 7);
239
240 /* Infrared read count (Reg 0x45[6:0] */
241 poll_result->read_count = (msg[0] & 0x7f);
242
243 /* Remote Control Address (Reg 0x46) */
244 poll_result->rc_address = msg[1];
245
246 /* Remote Control Data (Reg 0x47) */
247 poll_result->rc_data[0] = msg[2];
248
249 return 0;
250}
251
252static int em2874_polling_getkey(struct em28xx_IR *ir,
253 struct em28xx_ir_poll_result *poll_result)
254{
255 struct em28xx *dev = ir->dev;
256 int rc;
257 u8 msg[5] = { 0, 0, 0, 0, 0 };
258
259 /* Read key toggle, brand, and key code
260 on registers 0x51-55
261 */
262 rc = dev->em28xx_read_reg_req_len(dev, 0, EM2874_R51_IR,
263 msg, sizeof(msg));
264 if (rc < 0)
265 return rc;
266
267 /* Infrared toggle (Reg 0x51[7]) */
268 poll_result->toggle_bit = (msg[0] >> 7);
269
270 /* Infrared read count (Reg 0x51[6:0] */
271 poll_result->read_count = (msg[0] & 0x7f);
272
273 /* Remote Control Address (Reg 0x52) */
274 poll_result->rc_address = msg[1];
275
276 /* Remote Control Data (Reg 0x53-55) */
277 poll_result->rc_data[0] = msg[2];
278 poll_result->rc_data[1] = msg[3];
279 poll_result->rc_data[2] = msg[4];
280
281 return 0;
a924a499
MCC
282}
283
284/**********************************************************
285 Polling code for em28xx
286 **********************************************************/
287
288static void em28xx_ir_handle_key(struct em28xx_IR *ir)
289{
4b92253a 290 int result;
4b92253a
DH
291 struct em28xx_ir_poll_result poll_result;
292
293 /* read the registers containing the IR status */
294 result = ir->get_key(ir, &poll_result);
603044d8 295 if (unlikely(result < 0)) {
4b92253a 296 dprintk("ir->get_key() failed %d\n", result);
a924a499 297 return;
4b92253a 298 }
a924a499 299
603044d8
MCC
300 if (unlikely(poll_result.read_count != ir->last_readcount)) {
301 dprintk("%s: toggle: %d, count: %d, key 0x%02x%02x\n", __func__,
302 poll_result.toggle_bit, poll_result.read_count,
303 poll_result.rc_address, poll_result.rc_data[0]);
a469585b
DH
304 if (ir->full_code)
305 ir_keydown(ir->input,
306 poll_result.rc_address << 8 |
307 poll_result.rc_data[0],
308 poll_result.toggle_bit);
309 else
310 ir_keydown(ir->input,
311 poll_result.rc_data[0],
312 poll_result.toggle_bit);
a469585b 313
603044d8
MCC
314 if (ir->dev->chip_id == CHIP_ID_EM2874)
315 /* The em2874 clears the readcount field every time the
316 register is read. The em2860/2880 datasheet says that it
317 is supposed to clear the readcount, but it doesn't. So with
318 the em2874, we are looking for a non-zero read count as
319 opposed to a readcount that is incrementing */
320 ir->last_readcount = 0;
321 else
322 ir->last_readcount = poll_result.read_count;
323 }
a924a499
MCC
324}
325
a924a499
MCC
326static void em28xx_ir_work(struct work_struct *work)
327{
f263bac9 328 struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work.work);
a924a499
MCC
329
330 em28xx_ir_handle_key(ir);
f263bac9 331 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
a924a499
MCC
332}
333
c373cabf 334static int em28xx_ir_start(void *priv)
a924a499 335{
c373cabf
MCC
336 struct em28xx_IR *ir = priv;
337
f263bac9
JD
338 INIT_DELAYED_WORK(&ir->work, em28xx_ir_work);
339 schedule_delayed_work(&ir->work, 0);
c373cabf
MCC
340
341 return 0;
a924a499
MCC
342}
343
c373cabf 344static void em28xx_ir_stop(void *priv)
a924a499 345{
c373cabf
MCC
346 struct em28xx_IR *ir = priv;
347
f263bac9 348 cancel_delayed_work_sync(&ir->work);
a924a499
MCC
349}
350
971e8298 351int em28xx_ir_change_protocol(void *priv, u64 ir_type)
a924a499 352{
950b0f5a
MCC
353 int rc = 0;
354 struct em28xx_IR *ir = priv;
355 struct em28xx *dev = ir->dev;
356 u8 ir_config = EM2874_IR_RC5;
1bad429e
MCC
357
358 /* Adjust xclk based o IR table for RC5/NEC tables */
950b0f5a
MCC
359
360 if (ir_type == IR_TYPE_RC5) {
1bad429e
MCC
361 dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
362 ir->full_code = 1;
950b0f5a 363 } else if (ir_type == IR_TYPE_NEC) {
1bad429e
MCC
364 dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
365 ir_config = EM2874_IR_NEC;
366 ir->full_code = 1;
c373cabf 367 } else if (ir_type != IR_TYPE_UNKNOWN)
950b0f5a
MCC
368 rc = -EINVAL;
369
1bad429e
MCC
370 em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
371 EM28XX_XCLK_IR_RC5_MODE);
a924a499 372
4b92253a
DH
373 /* Setup the proper handler based on the chip */
374 switch (dev->chip_id) {
375 case CHIP_ID_EM2860:
376 case CHIP_ID_EM2883:
377 ir->get_key = default_polling_getkey;
91812fa7 378 break;
4b92253a
DH
379 case CHIP_ID_EM2874:
380 ir->get_key = em2874_polling_getkey;
4b92253a
DH
381 em28xx_write_regs(dev, EM2874_R50_IR_CONFIG, &ir_config, 1);
382 break;
383 default:
384 printk("Unrecognized em28xx chip id: IR not supported\n");
950b0f5a
MCC
385 rc = -EINVAL;
386 }
387
388 return rc;
389}
390
391int em28xx_ir_init(struct em28xx *dev)
392{
393 struct em28xx_IR *ir;
394 struct input_dev *input_dev;
395 int err = -ENOMEM;
396
397 if (dev->board.ir_codes == NULL) {
398 /* No remote control support */
399 return 0;
a924a499
MCC
400 }
401
950b0f5a
MCC
402 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
403 input_dev = input_allocate_device();
404 if (!ir || !input_dev)
405 goto err_out_free;
406
407 /* record handles to ourself */
408 ir->dev = dev;
409 dev->ir = ir;
410
411 ir->input = input_dev;
412
413 /*
414 * em2874 supports more protocols. For now, let's just announce
415 * the two protocols that were already tested
416 */
417 ir->props.allowed_protos = IR_TYPE_RC5 | IR_TYPE_NEC;
418 ir->props.priv = ir;
419 ir->props.change_protocol = em28xx_ir_change_protocol;
c373cabf
MCC
420 ir->props.open = em28xx_ir_start;
421 ir->props.close = em28xx_ir_stop;
422
423 /* By default, keep protocol field untouched */
424 err = em28xx_ir_change_protocol(ir, IR_TYPE_UNKNOWN);
425 if (err)
426 goto err_out_free;
950b0f5a 427
4b92253a
DH
428 /* This is how often we ask the chip for IR information */
429 ir->polling = 100; /* ms */
430
a924a499
MCC
431 /* init input device */
432 snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)",
433 dev->name);
434
435 usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
436 strlcat(ir->phys, "/input0", sizeof(ir->phys));
437
a924a499
MCC
438 input_dev->name = ir->name;
439 input_dev->phys = ir->phys;
440 input_dev->id.bustype = BUS_USB;
441 input_dev->id.version = 1;
442 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
443 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
444
445 input_dev->dev.parent = &dev->udev->dev;
950b0f5a 446
a924a499 447
a924a499
MCC
448
449 /* all done */
02858eed 450 err = ir_input_register(ir->input, dev->board.ir_codes,
727e625c 451 &ir->props, MODULE_NAME);
a924a499
MCC
452 if (err)
453 goto err_out_stop;
454
455 return 0;
456 err_out_stop:
a924a499
MCC
457 dev->ir = NULL;
458 err_out_free:
a924a499
MCC
459 kfree(ir);
460 return err;
461}
462
463int em28xx_ir_fini(struct em28xx *dev)
464{
465 struct em28xx_IR *ir = dev->ir;
466
467 /* skip detach on non attached boards */
468 if (!ir)
469 return 0;
470
471 em28xx_ir_stop(ir);
38ef6aa8 472 ir_input_unregister(ir->input);
a924a499
MCC
473 kfree(ir);
474
475 /* done */
476 dev->ir = NULL;
477 return 0;
478}
479
480/**********************************************************
481 Handle Webcam snapshot button
482 **********************************************************/
483
a9fc52bc
DH
484static void em28xx_query_sbutton(struct work_struct *work)
485{
486 /* Poll the register and see if the button is depressed */
487 struct em28xx *dev =
488 container_of(work, struct em28xx, sbutton_query_work.work);
489 int ret;
490
491 ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);
492
493 if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
494 u8 cleared;
495 /* Button is depressed, clear the register */
496 cleared = ((u8) ret) & ~EM28XX_R0C_USBSUSP_SNAPSHOT;
497 em28xx_write_regs(dev, EM28XX_R0C_USBSUSP, &cleared, 1);
498
499 /* Not emulate the keypress */
500 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
501 1);
502 /* Now unpress the key */
503 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
504 0);
505 }
506
507 /* Schedule next poll */
508 schedule_delayed_work(&dev->sbutton_query_work,
509 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
510}
511
512void em28xx_register_snapshot_button(struct em28xx *dev)
513{
514 struct input_dev *input_dev;
515 int err;
516
517 em28xx_info("Registering snapshot button...\n");
518 input_dev = input_allocate_device();
519 if (!input_dev) {
520 em28xx_errdev("input_allocate_device failed\n");
521 return;
522 }
523
524 usb_make_path(dev->udev, dev->snapshot_button_path,
525 sizeof(dev->snapshot_button_path));
526 strlcat(dev->snapshot_button_path, "/sbutton",
527 sizeof(dev->snapshot_button_path));
528 INIT_DELAYED_WORK(&dev->sbutton_query_work, em28xx_query_sbutton);
529
530 input_dev->name = "em28xx snapshot button";
531 input_dev->phys = dev->snapshot_button_path;
532 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
533 set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
534 input_dev->keycodesize = 0;
535 input_dev->keycodemax = 0;
536 input_dev->id.bustype = BUS_USB;
537 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
538 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
539 input_dev->id.version = 1;
540 input_dev->dev.parent = &dev->udev->dev;
541
542 err = input_register_device(input_dev);
543 if (err) {
544 em28xx_errdev("input_register_device failed\n");
545 input_free_device(input_dev);
546 return;
547 }
548
549 dev->sbutton_input_dev = input_dev;
550 schedule_delayed_work(&dev->sbutton_query_work,
551 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
552 return;
553
554}
555
556void em28xx_deregister_snapshot_button(struct em28xx *dev)
557{
558 if (dev->sbutton_input_dev != NULL) {
559 em28xx_info("Deregistering snapshot button\n");
560 cancel_rearming_delayed_work(&dev->sbutton_query_work);
561 input_unregister_device(dev->sbutton_input_dev);
562 dev->sbutton_input_dev = NULL;
563 }
564 return;
565}