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