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