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