V4L/DVB (11842): radio-mr800.c: missing mutex include
[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>
30
f7abcd38 31#include "em28xx.h"
d5e52653 32
a9fc52bc
DH
33#define EM28XX_SNAPSHOT_KEY KEY_CAMERA
34#define EM28XX_SBUTTON_QUERY_INTERVAL 500
35#define EM28XX_R0C_USBSUSP_SNAPSHOT 0x20
36
c8793b03 37static unsigned int ir_debug;
d5e52653 38module_param(ir_debug, int, 0644);
6ea54d93 39MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
d5e52653 40
a924a499 41#define i2cdprintk(fmt, arg...) \
6ea54d93
DSL
42 if (ir_debug) { \
43 printk(KERN_DEBUG "%s/ir: " fmt, ir->c.name , ## arg); \
44 }
d5e52653 45
a924a499
MCC
46#define dprintk(fmt, arg...) \
47 if (ir_debug) { \
48 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
49 }
50
51/**********************************************************
52 Polling structure used by em28xx IR's
53 **********************************************************/
54
4b92253a
DH
55struct em28xx_ir_poll_result {
56 unsigned int toggle_bit:1;
57 unsigned int read_count:7;
58 u8 rc_address;
59 u8 rc_data[4]; /* 1 byte on em2860/2880, 4 on em2874 */
60};
61
a924a499
MCC
62struct em28xx_IR {
63 struct em28xx *dev;
64 struct input_dev *input;
65 struct ir_input_state ir;
66 char name[32];
67 char phys[32];
68
69 /* poll external decoder */
70 int polling;
f263bac9 71 struct delayed_work work;
4b92253a
DH
72 unsigned int last_toggle:1;
73 unsigned int last_readcount;
74 unsigned int repeat_interval;
a924a499 75
4b92253a 76 int (*get_key)(struct em28xx_IR *, struct em28xx_ir_poll_result *);
a924a499
MCC
77};
78
79/**********************************************************
80 I2C IR based get keycodes - should be used with ir-kbd-i2c
81 **********************************************************/
d5e52653 82
c8793b03 83int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
e43f14af
MR
84{
85 unsigned char b;
86
87 /* poll IR chip */
6ea54d93 88 if (1 != i2c_master_recv(&ir->c, &b, 1)) {
a924a499 89 i2cdprintk("read error\n");
e43f14af
MR
90 return -EIO;
91 }
92
93 /* it seems that 0xFE indicates that a button is still hold
4f9c05aa
MCC
94 down, while 0xff indicates that no button is hold
95 down. 0xfe sequences are sometimes interrupted by 0xFF */
e43f14af 96
a924a499 97 i2cdprintk("key %02x\n", b);
e43f14af 98
4f9c05aa 99 if (b == 0xff)
e43f14af
MR
100 return 0;
101
4f9c05aa 102 if (b == 0xfe)
e43f14af
MR
103 /* keep old data */
104 return 1;
105
106 *ir_key = b;
107 *ir_raw = b;
108 return 1;
109}
110
c8793b03 111int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
d5e52653
MCC
112{
113 unsigned char buf[2];
114 unsigned char code;
115
116 /* poll IR chip */
6ea54d93 117 if (2 != i2c_master_recv(&ir->c, buf, 2))
d5e52653
MCC
118 return -EIO;
119
120 /* Does eliminate repeated parity code */
6ea54d93 121 if (buf[1] == 0xff)
d5e52653
MCC
122 return 0;
123
6ea54d93 124 ir->old = buf[1];
d5e52653
MCC
125
126 /* Rearranges bits to the right order */
6ea54d93 127 code = ((buf[0]&0x01)<<5) | /* 0010 0000 */
d5e52653
MCC
128 ((buf[0]&0x02)<<3) | /* 0001 0000 */
129 ((buf[0]&0x04)<<1) | /* 0000 1000 */
130 ((buf[0]&0x08)>>1) | /* 0000 0100 */
131 ((buf[0]&0x10)>>3) | /* 0000 0010 */
132 ((buf[0]&0x20)>>5); /* 0000 0001 */
133
a924a499 134 i2cdprintk("ir hauppauge (em2840): code=0x%02x (rcv=0x%02x)\n",
6ea54d93 135 code, buf[0]);
d5e52653
MCC
136
137 /* return key */
138 *ir_key = code;
139 *ir_raw = code;
140 return 1;
141}
142
c8793b03
MCC
143int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
144 u32 *ir_raw)
366cc64b
MR
145{
146 unsigned char buf[3];
147
148 /* poll IR chip */
149
6ea54d93 150 if (3 != i2c_master_recv(&ir->c, buf, 3)) {
a924a499 151 i2cdprintk("read error\n");
366cc64b
MR
152 return -EIO;
153 }
154
a924a499 155 i2cdprintk("key %02x\n", buf[2]&0x3f);
6ea54d93 156 if (buf[0] != 0x00)
366cc64b 157 return 0;
366cc64b
MR
158
159 *ir_key = buf[2]&0x3f;
160 *ir_raw = buf[2]&0x3f;
161
162 return 1;
163}
164
a924a499
MCC
165/**********************************************************
166 Poll based get keycode functions
167 **********************************************************/
168
4b92253a
DH
169/* This is for the em2860/em2880 */
170static int default_polling_getkey(struct em28xx_IR *ir,
171 struct em28xx_ir_poll_result *poll_result)
a924a499
MCC
172{
173 struct em28xx *dev = ir->dev;
174 int rc;
4b92253a 175 u8 msg[3] = { 0, 0, 0 };
a924a499 176
0a6b8a85
MCC
177 /* Read key toggle, brand, and key code
178 on registers 0x45, 0x46 and 0x47
179 */
a924a499 180 rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
0a6b8a85 181 msg, sizeof(msg));
a924a499
MCC
182 if (rc < 0)
183 return rc;
184
4b92253a
DH
185 /* Infrared toggle (Reg 0x45[7]) */
186 poll_result->toggle_bit = (msg[0] >> 7);
187
188 /* Infrared read count (Reg 0x45[6:0] */
189 poll_result->read_count = (msg[0] & 0x7f);
190
191 /* Remote Control Address (Reg 0x46) */
192 poll_result->rc_address = msg[1];
193
194 /* Remote Control Data (Reg 0x47) */
195 poll_result->rc_data[0] = msg[2];
196
197 return 0;
198}
199
200static int em2874_polling_getkey(struct em28xx_IR *ir,
201 struct em28xx_ir_poll_result *poll_result)
202{
203 struct em28xx *dev = ir->dev;
204 int rc;
205 u8 msg[5] = { 0, 0, 0, 0, 0 };
206
207 /* Read key toggle, brand, and key code
208 on registers 0x51-55
209 */
210 rc = dev->em28xx_read_reg_req_len(dev, 0, EM2874_R51_IR,
211 msg, sizeof(msg));
212 if (rc < 0)
213 return rc;
214
215 /* Infrared toggle (Reg 0x51[7]) */
216 poll_result->toggle_bit = (msg[0] >> 7);
217
218 /* Infrared read count (Reg 0x51[6:0] */
219 poll_result->read_count = (msg[0] & 0x7f);
220
221 /* Remote Control Address (Reg 0x52) */
222 poll_result->rc_address = msg[1];
223
224 /* Remote Control Data (Reg 0x53-55) */
225 poll_result->rc_data[0] = msg[2];
226 poll_result->rc_data[1] = msg[3];
227 poll_result->rc_data[2] = msg[4];
228
229 return 0;
a924a499
MCC
230}
231
232/**********************************************************
233 Polling code for em28xx
234 **********************************************************/
235
236static void em28xx_ir_handle_key(struct em28xx_IR *ir)
237{
4b92253a
DH
238 int result;
239 int do_sendkey = 0;
240 struct em28xx_ir_poll_result poll_result;
241
242 /* read the registers containing the IR status */
243 result = ir->get_key(ir, &poll_result);
244 if (result < 0) {
245 dprintk("ir->get_key() failed %d\n", result);
a924a499 246 return;
4b92253a 247 }
a924a499 248
4b92253a
DH
249 dprintk("ir->get_key result tb=%02x rc=%02x lr=%02x data=%02x\n",
250 poll_result.toggle_bit, poll_result.read_count,
251 ir->last_readcount, poll_result.rc_data[0]);
252
253 if (ir->dev->chip_id == CHIP_ID_EM2874) {
254 /* The em2874 clears the readcount field every time the
255 register is read. The em2860/2880 datasheet says that it
256 is supposed to clear the readcount, but it doesn't. So with
257 the em2874, we are looking for a non-zero read count as
258 opposed to a readcount that is incrementing */
259 ir->last_readcount = 0;
260 }
0a6b8a85 261
4b92253a
DH
262 if (poll_result.read_count == 0) {
263 /* The button has not been pressed since the last read */
264 } else if (ir->last_toggle != poll_result.toggle_bit) {
265 /* A button has been pressed */
266 dprintk("button has been pressed\n");
267 ir->last_toggle = poll_result.toggle_bit;
268 ir->repeat_interval = 0;
269 do_sendkey = 1;
270 } else if (poll_result.toggle_bit == ir->last_toggle &&
271 poll_result.read_count > 0 &&
272 poll_result.read_count != ir->last_readcount) {
273 /* The button is still being held down */
274 dprintk("button being held down\n");
275
276 /* Debouncer for first keypress */
277 if (ir->repeat_interval++ > 9) {
278 /* Start repeating after 1 second */
279 do_sendkey = 1;
0a6b8a85 280 }
4b92253a
DH
281 }
282
283 if (do_sendkey) {
284 dprintk("sending keypress\n");
285 ir_input_keydown(ir->input, &ir->ir, poll_result.rc_data[0],
286 poll_result.rc_data[0]);
a924a499
MCC
287 ir_input_nokey(ir->input, &ir->ir);
288 }
4b92253a
DH
289
290 ir->last_readcount = poll_result.read_count;
291 return;
a924a499
MCC
292}
293
a924a499
MCC
294static void em28xx_ir_work(struct work_struct *work)
295{
f263bac9 296 struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work.work);
a924a499
MCC
297
298 em28xx_ir_handle_key(ir);
f263bac9 299 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
a924a499
MCC
300}
301
26cdc76b 302static void em28xx_ir_start(struct em28xx_IR *ir)
a924a499 303{
f263bac9
JD
304 INIT_DELAYED_WORK(&ir->work, em28xx_ir_work);
305 schedule_delayed_work(&ir->work, 0);
a924a499
MCC
306}
307
308static void em28xx_ir_stop(struct em28xx_IR *ir)
309{
f263bac9 310 cancel_delayed_work_sync(&ir->work);
a924a499
MCC
311}
312
313int em28xx_ir_init(struct em28xx *dev)
314{
315 struct em28xx_IR *ir;
316 struct input_dev *input_dev;
4b92253a 317 u8 ir_config;
a924a499
MCC
318 int err = -ENOMEM;
319
505b6d0b 320 if (dev->board.ir_codes == NULL) {
4b92253a
DH
321 /* No remote control support */
322 return 0;
323 }
324
a924a499
MCC
325 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
326 input_dev = input_allocate_device();
327 if (!ir || !input_dev)
328 goto err_out_free;
329
330 ir->input = input_dev;
331
4b92253a
DH
332 /* Setup the proper handler based on the chip */
333 switch (dev->chip_id) {
334 case CHIP_ID_EM2860:
335 case CHIP_ID_EM2883:
336 ir->get_key = default_polling_getkey;
91812fa7 337 break;
4b92253a
DH
338 case CHIP_ID_EM2874:
339 ir->get_key = em2874_polling_getkey;
340 /* For now we only support RC5, so enable it */
341 ir_config = EM2874_IR_RC5;
342 em28xx_write_regs(dev, EM2874_R50_IR_CONFIG, &ir_config, 1);
343 break;
344 default:
345 printk("Unrecognized em28xx chip id: IR not supported\n");
a924a499
MCC
346 goto err_out_free;
347 }
348
4b92253a
DH
349 /* This is how often we ask the chip for IR information */
350 ir->polling = 100; /* ms */
351
a924a499
MCC
352 /* init input device */
353 snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)",
354 dev->name);
355
356 usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
357 strlcat(ir->phys, "/input0", sizeof(ir->phys));
358
505b6d0b 359 ir_input_init(input_dev, &ir->ir, IR_TYPE_OTHER, dev->board.ir_codes);
a924a499
MCC
360 input_dev->name = ir->name;
361 input_dev->phys = ir->phys;
362 input_dev->id.bustype = BUS_USB;
363 input_dev->id.version = 1;
364 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
365 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
366
367 input_dev->dev.parent = &dev->udev->dev;
368 /* record handles to ourself */
369 ir->dev = dev;
370 dev->ir = ir;
371
372 em28xx_ir_start(ir);
373
374 /* all done */
375 err = input_register_device(ir->input);
376 if (err)
377 goto err_out_stop;
378
379 return 0;
380 err_out_stop:
381 em28xx_ir_stop(ir);
382 dev->ir = NULL;
383 err_out_free:
384 input_free_device(input_dev);
385 kfree(ir);
386 return err;
387}
388
389int em28xx_ir_fini(struct em28xx *dev)
390{
391 struct em28xx_IR *ir = dev->ir;
392
393 /* skip detach on non attached boards */
394 if (!ir)
395 return 0;
396
397 em28xx_ir_stop(ir);
398 input_unregister_device(ir->input);
399 kfree(ir);
400
401 /* done */
402 dev->ir = NULL;
403 return 0;
404}
405
406/**********************************************************
407 Handle Webcam snapshot button
408 **********************************************************/
409
a9fc52bc
DH
410static void em28xx_query_sbutton(struct work_struct *work)
411{
412 /* Poll the register and see if the button is depressed */
413 struct em28xx *dev =
414 container_of(work, struct em28xx, sbutton_query_work.work);
415 int ret;
416
417 ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);
418
419 if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
420 u8 cleared;
421 /* Button is depressed, clear the register */
422 cleared = ((u8) ret) & ~EM28XX_R0C_USBSUSP_SNAPSHOT;
423 em28xx_write_regs(dev, EM28XX_R0C_USBSUSP, &cleared, 1);
424
425 /* Not emulate the keypress */
426 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
427 1);
428 /* Now unpress the key */
429 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
430 0);
431 }
432
433 /* Schedule next poll */
434 schedule_delayed_work(&dev->sbutton_query_work,
435 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
436}
437
438void em28xx_register_snapshot_button(struct em28xx *dev)
439{
440 struct input_dev *input_dev;
441 int err;
442
443 em28xx_info("Registering snapshot button...\n");
444 input_dev = input_allocate_device();
445 if (!input_dev) {
446 em28xx_errdev("input_allocate_device failed\n");
447 return;
448 }
449
450 usb_make_path(dev->udev, dev->snapshot_button_path,
451 sizeof(dev->snapshot_button_path));
452 strlcat(dev->snapshot_button_path, "/sbutton",
453 sizeof(dev->snapshot_button_path));
454 INIT_DELAYED_WORK(&dev->sbutton_query_work, em28xx_query_sbutton);
455
456 input_dev->name = "em28xx snapshot button";
457 input_dev->phys = dev->snapshot_button_path;
458 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
459 set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
460 input_dev->keycodesize = 0;
461 input_dev->keycodemax = 0;
462 input_dev->id.bustype = BUS_USB;
463 input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
464 input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
465 input_dev->id.version = 1;
466 input_dev->dev.parent = &dev->udev->dev;
467
468 err = input_register_device(input_dev);
469 if (err) {
470 em28xx_errdev("input_register_device failed\n");
471 input_free_device(input_dev);
472 return;
473 }
474
475 dev->sbutton_input_dev = input_dev;
476 schedule_delayed_work(&dev->sbutton_query_work,
477 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
478 return;
479
480}
481
482void em28xx_deregister_snapshot_button(struct em28xx *dev)
483{
484 if (dev->sbutton_input_dev != NULL) {
485 em28xx_info("Deregistering snapshot button\n");
486 cancel_rearming_delayed_work(&dev->sbutton_query_work);
487 input_unregister_device(dev->sbutton_input_dev);
488 dev->sbutton_input_dev = NULL;
489 }
490 return;
491}