V4L/DVB (9607): em28xx: Properly implement poll support for IR's
[safe/jmp/linux-2.6] / 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->c.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 {
56         struct em28xx *dev;
57         struct input_dev *input;
58         struct ir_input_state ir;
59         char name[32];
60         char phys[32];
61
62         /* poll external decoder */
63         int polling;
64         struct work_struct work;
65         struct timer_list timer;
66         u32 last_gpio;
67         u32 mask_keycode;
68         u32 mask_keydown;
69         u32 mask_keyup;
70
71         int  (*get_key)(struct em28xx_IR *);
72 };
73
74 /**********************************************************
75  I2C IR based get keycodes - should be used with ir-kbd-i2c
76  **********************************************************/
77
78 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
79 {
80         unsigned char b;
81
82         /* poll IR chip */
83         if (1 != i2c_master_recv(&ir->c, &b, 1)) {
84                 i2cdprintk("read error\n");
85                 return -EIO;
86         }
87
88         /* it seems that 0xFE indicates that a button is still hold
89            down, while 0xff indicates that no button is hold
90            down. 0xfe sequences are sometimes interrupted by 0xFF */
91
92         i2cdprintk("key %02x\n", b);
93
94         if (b == 0xff)
95                 return 0;
96
97         if (b == 0xfe)
98                 /* keep old data */
99                 return 1;
100
101         *ir_key = b;
102         *ir_raw = b;
103         return 1;
104 }
105
106 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
107 {
108         unsigned char buf[2];
109         unsigned char code;
110
111         /* poll IR chip */
112         if (2 != i2c_master_recv(&ir->c, buf, 2))
113                 return -EIO;
114
115         /* Does eliminate repeated parity code */
116         if (buf[1] == 0xff)
117                 return 0;
118
119         ir->old = buf[1];
120
121         /* Rearranges bits to the right order */
122         code =   ((buf[0]&0x01)<<5) | /* 0010 0000 */
123                  ((buf[0]&0x02)<<3) | /* 0001 0000 */
124                  ((buf[0]&0x04)<<1) | /* 0000 1000 */
125                  ((buf[0]&0x08)>>1) | /* 0000 0100 */
126                  ((buf[0]&0x10)>>3) | /* 0000 0010 */
127                  ((buf[0]&0x20)>>5);  /* 0000 0001 */
128
129         i2cdprintk("ir hauppauge (em2840): code=0x%02x (rcv=0x%02x)\n",
130                         code, buf[0]);
131
132         /* return key */
133         *ir_key = code;
134         *ir_raw = code;
135         return 1;
136 }
137
138 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
139                                      u32 *ir_raw)
140 {
141         unsigned char buf[3];
142
143         /* poll IR chip */
144
145         if (3 != i2c_master_recv(&ir->c, buf, 3)) {
146                 i2cdprintk("read error\n");
147                 return -EIO;
148         }
149
150         i2cdprintk("key %02x\n", buf[2]&0x3f);
151         if (buf[0] != 0x00)
152                 return 0;
153
154         *ir_key = buf[2]&0x3f;
155         *ir_raw = buf[2]&0x3f;
156
157         return 1;
158 }
159
160 /**********************************************************
161  Poll based get keycode functions
162  **********************************************************/
163
164 static int default_polling_getkey(struct em28xx_IR *ir)
165 {
166         struct em28xx *dev = ir->dev;
167         int rc;
168         u32 msg;
169
170         /* Read key toggle, brand, and key code */
171         rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
172                                           (u8 *)&msg, sizeof(msg));
173         if (rc < 0)
174                 return rc;
175
176         return (int)(msg & 0x7fffffffl);
177 }
178
179 /**********************************************************
180  Polling code for em28xx
181  **********************************************************/
182
183 static void em28xx_ir_handle_key(struct em28xx_IR *ir)
184 {
185         int    gpio;
186         u32    data;
187
188         /* read gpio value */
189         gpio = ir->get_key(ir);
190         if (gpio < 0)
191                 return;
192
193         if (gpio == ir->last_gpio)
194                 return;
195         ir->last_gpio = gpio;
196
197         /* extract data */
198         data = ir_extract_bits(gpio, ir->mask_keycode);
199         dprintk("irq gpio=0x%x code=%d | poll%s%s\n",
200                    gpio, data,
201                    (gpio & ir->mask_keydown) ? " down" : "",
202                    (gpio & ir->mask_keyup) ? " up" : "");
203
204         /* Generate keyup/keydown events */
205         if (ir->mask_keydown) {
206                 /* bit set on keydown */
207                 if (gpio & ir->mask_keydown)
208                         ir_input_keydown(ir->input, &ir->ir, data, data);
209                 else
210                         ir_input_nokey(ir->input, &ir->ir);
211         } else if (ir->mask_keyup) {
212                 /* bit cleared on keydown */
213                 if (!(gpio & ir->mask_keyup))
214                         ir_input_keydown(ir->input, &ir->ir, data, data);
215                 else
216                         ir_input_nokey(ir->input, &ir->ir);
217         } else {
218                 /* can't distinguish keydown/up :-/ */
219                 ir_input_keydown(ir->input, &ir->ir, data, data);
220                 ir_input_nokey(ir->input, &ir->ir);
221         }
222 }
223
224 static void ir_timer(unsigned long data)
225 {
226         struct em28xx_IR *ir = (struct em28xx_IR *)data;
227
228         schedule_work(&ir->work);
229 }
230
231 static void em28xx_ir_work(struct work_struct *work)
232 {
233         struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work);
234
235         em28xx_ir_handle_key(ir);
236         mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling));
237 }
238
239 void em28xx_ir_start(struct em28xx_IR *ir)
240 {
241         setup_timer(&ir->timer, ir_timer, (unsigned long)ir);
242         INIT_WORK(&ir->work, em28xx_ir_work);
243         schedule_work(&ir->work);
244 }
245
246 static void em28xx_ir_stop(struct em28xx_IR *ir)
247 {
248         del_timer_sync(&ir->timer);
249         flush_scheduled_work();
250 }
251
252 int em28xx_ir_init(struct em28xx *dev)
253 {
254         struct em28xx_IR *ir;
255         struct input_dev *input_dev;
256         IR_KEYTAB_TYPE *ir_codes = NULL;
257         int ir_type = IR_TYPE_OTHER;
258         int err = -ENOMEM;
259
260         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
261         input_dev = input_allocate_device();
262         if (!ir || !input_dev)
263                 goto err_out_free;
264
265         ir->input = input_dev;
266
267         /* */
268         ir->get_key = default_polling_getkey;
269         ir->polling = 50; /* ms */
270
271         /* detect & configure */
272         switch (dev->model) {
273         }
274
275         if (NULL == ir_codes) {
276                 err = -ENODEV;
277                 goto err_out_free;
278         }
279
280         /* Get the current key status, to avoid adding an
281            unexistent key code */
282         ir->last_gpio    = ir->get_key(ir);
283
284         /* init input device */
285         snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)",
286                                                 dev->name);
287
288         usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
289         strlcat(ir->phys, "/input0", sizeof(ir->phys));
290
291         ir_input_init(input_dev, &ir->ir, ir_type, ir_codes);
292         input_dev->name = ir->name;
293         input_dev->phys = ir->phys;
294         input_dev->id.bustype = BUS_USB;
295         input_dev->id.version = 1;
296         input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
297         input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
298
299         input_dev->dev.parent = &dev->udev->dev;
300         /* record handles to ourself */
301         ir->dev = dev;
302         dev->ir = ir;
303
304         em28xx_ir_start(ir);
305
306         /* all done */
307         err = input_register_device(ir->input);
308         if (err)
309                 goto err_out_stop;
310
311         return 0;
312  err_out_stop:
313         em28xx_ir_stop(ir);
314         dev->ir = NULL;
315  err_out_free:
316         input_free_device(input_dev);
317         kfree(ir);
318         return err;
319 }
320
321 int em28xx_ir_fini(struct em28xx *dev)
322 {
323         struct em28xx_IR *ir = dev->ir;
324
325         /* skip detach on non attached boards */
326         if (!ir)
327                 return 0;
328
329         em28xx_ir_stop(ir);
330         input_unregister_device(ir->input);
331         kfree(ir);
332
333         /* done */
334         dev->ir = NULL;
335         return 0;
336 }
337
338 /**********************************************************
339  Handle Webcam snapshot button
340  **********************************************************/
341
342 static void em28xx_query_sbutton(struct work_struct *work)
343 {
344         /* Poll the register and see if the button is depressed */
345         struct em28xx *dev =
346                 container_of(work, struct em28xx, sbutton_query_work.work);
347         int ret;
348
349         ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);
350
351         if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
352                 u8 cleared;
353                 /* Button is depressed, clear the register */
354                 cleared = ((u8) ret) & ~EM28XX_R0C_USBSUSP_SNAPSHOT;
355                 em28xx_write_regs(dev, EM28XX_R0C_USBSUSP, &cleared, 1);
356
357                 /* Not emulate the keypress */
358                 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
359                                  1);
360                 /* Now unpress the key */
361                 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
362                                  0);
363         }
364
365         /* Schedule next poll */
366         schedule_delayed_work(&dev->sbutton_query_work,
367                               msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
368 }
369
370 void em28xx_register_snapshot_button(struct em28xx *dev)
371 {
372         struct input_dev *input_dev;
373         int err;
374
375         em28xx_info("Registering snapshot button...\n");
376         input_dev = input_allocate_device();
377         if (!input_dev) {
378                 em28xx_errdev("input_allocate_device failed\n");
379                 return;
380         }
381
382         usb_make_path(dev->udev, dev->snapshot_button_path,
383                       sizeof(dev->snapshot_button_path));
384         strlcat(dev->snapshot_button_path, "/sbutton",
385                 sizeof(dev->snapshot_button_path));
386         INIT_DELAYED_WORK(&dev->sbutton_query_work, em28xx_query_sbutton);
387
388         input_dev->name = "em28xx snapshot button";
389         input_dev->phys = dev->snapshot_button_path;
390         input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
391         set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
392         input_dev->keycodesize = 0;
393         input_dev->keycodemax = 0;
394         input_dev->id.bustype = BUS_USB;
395         input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
396         input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
397         input_dev->id.version = 1;
398         input_dev->dev.parent = &dev->udev->dev;
399
400         err = input_register_device(input_dev);
401         if (err) {
402                 em28xx_errdev("input_register_device failed\n");
403                 input_free_device(input_dev);
404                 return;
405         }
406
407         dev->sbutton_input_dev = input_dev;
408         schedule_delayed_work(&dev->sbutton_query_work,
409                               msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
410         return;
411
412 }
413
414 void em28xx_deregister_snapshot_button(struct em28xx *dev)
415 {
416         if (dev->sbutton_input_dev != NULL) {
417                 em28xx_info("Deregistering snapshot button\n");
418                 cancel_rearming_delayed_work(&dev->sbutton_query_work);
419                 input_unregister_device(dev->sbutton_input_dev);
420                 dev->sbutton_input_dev = NULL;
421         }
422         return;
423 }