2 handle em28xx IR remotes via linux kernel input layer.
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>
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.
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.
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
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>
33 #define EM28XX_SNAPSHOT_KEY KEY_CAMERA
34 #define EM28XX_SBUTTON_QUERY_INTERVAL 500
35 #define EM28XX_R0C_USBSUSP_SNAPSHOT 0x20
37 static unsigned int ir_debug;
38 module_param(ir_debug, int, 0644);
39 MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
41 #define i2cdprintk(fmt, arg...) \
43 printk(KERN_DEBUG "%s/ir: " fmt, ir->c.name , ## arg); \
46 #define dprintk(fmt, arg...) \
48 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
51 /**********************************************************
52 Polling structure used by em28xx IR's
53 **********************************************************/
57 struct input_dev *input;
58 struct ir_input_state ir;
62 /* poll external decoder */
64 struct work_struct work;
65 struct timer_list timer;
71 int (*get_key)(struct em28xx_IR *);
74 /**********************************************************
75 I2C IR based get keycodes - should be used with ir-kbd-i2c
76 **********************************************************/
78 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
83 if (1 != i2c_master_recv(&ir->c, &b, 1)) {
84 i2cdprintk("read error\n");
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 */
92 i2cdprintk("key %02x\n", b);
106 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
108 unsigned char buf[2];
112 if (2 != i2c_master_recv(&ir->c, buf, 2))
115 /* Does eliminate repeated parity code */
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 */
129 i2cdprintk("ir hauppauge (em2840): code=0x%02x (rcv=0x%02x)\n",
138 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
141 unsigned char buf[3];
145 if (3 != i2c_master_recv(&ir->c, buf, 3)) {
146 i2cdprintk("read error\n");
150 i2cdprintk("key %02x\n", buf[2]&0x3f);
154 *ir_key = buf[2]&0x3f;
155 *ir_raw = buf[2]&0x3f;
160 /**********************************************************
161 Poll based get keycode functions
162 **********************************************************/
164 static int default_polling_getkey(struct em28xx_IR *ir)
166 struct em28xx *dev = ir->dev;
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));
176 return (int)(msg & 0x7fffffffl);
179 /**********************************************************
180 Polling code for em28xx
181 **********************************************************/
183 static void em28xx_ir_handle_key(struct em28xx_IR *ir)
188 /* read gpio value */
189 gpio = ir->get_key(ir);
193 if (gpio == ir->last_gpio)
195 ir->last_gpio = gpio;
198 data = ir_extract_bits(gpio, ir->mask_keycode);
199 dprintk("irq gpio=0x%x code=%d | poll%s%s\n",
201 (gpio & ir->mask_keydown) ? " down" : "",
202 (gpio & ir->mask_keyup) ? " up" : "");
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);
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);
216 ir_input_nokey(ir->input, &ir->ir);
218 /* can't distinguish keydown/up :-/ */
219 ir_input_keydown(ir->input, &ir->ir, data, data);
220 ir_input_nokey(ir->input, &ir->ir);
224 static void ir_timer(unsigned long data)
226 struct em28xx_IR *ir = (struct em28xx_IR *)data;
228 schedule_work(&ir->work);
231 static void em28xx_ir_work(struct work_struct *work)
233 struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work);
235 em28xx_ir_handle_key(ir);
236 mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling));
239 void em28xx_ir_start(struct em28xx_IR *ir)
241 setup_timer(&ir->timer, ir_timer, (unsigned long)ir);
242 INIT_WORK(&ir->work, em28xx_ir_work);
243 schedule_work(&ir->work);
246 static void em28xx_ir_stop(struct em28xx_IR *ir)
248 del_timer_sync(&ir->timer);
249 flush_scheduled_work();
252 int em28xx_ir_init(struct em28xx *dev)
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;
260 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
261 input_dev = input_allocate_device();
262 if (!ir || !input_dev)
265 ir->input = input_dev;
268 ir->get_key = default_polling_getkey;
269 ir->polling = 50; /* ms */
271 /* detect & configure */
272 switch (dev->model) {
275 if (NULL == ir_codes) {
280 /* Get the current key status, to avoid adding an
281 unexistent key code */
282 ir->last_gpio = ir->get_key(ir);
284 /* init input device */
285 snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)",
288 usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
289 strlcat(ir->phys, "/input0", sizeof(ir->phys));
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);
299 input_dev->dev.parent = &dev->udev->dev;
300 /* record handles to ourself */
307 err = input_register_device(ir->input);
316 input_free_device(input_dev);
321 int em28xx_ir_fini(struct em28xx *dev)
323 struct em28xx_IR *ir = dev->ir;
325 /* skip detach on non attached boards */
330 input_unregister_device(ir->input);
338 /**********************************************************
339 Handle Webcam snapshot button
340 **********************************************************/
342 static void em28xx_query_sbutton(struct work_struct *work)
344 /* Poll the register and see if the button is depressed */
346 container_of(work, struct em28xx, sbutton_query_work.work);
349 ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);
351 if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
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);
357 /* Not emulate the keypress */
358 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
360 /* Now unpress the key */
361 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
365 /* Schedule next poll */
366 schedule_delayed_work(&dev->sbutton_query_work,
367 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
370 void em28xx_register_snapshot_button(struct em28xx *dev)
372 struct input_dev *input_dev;
375 em28xx_info("Registering snapshot button...\n");
376 input_dev = input_allocate_device();
378 em28xx_errdev("input_allocate_device failed\n");
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);
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;
400 err = input_register_device(input_dev);
402 em28xx_errdev("input_register_device failed\n");
403 input_free_device(input_dev);
407 dev->sbutton_input_dev = input_dev;
408 schedule_delayed_work(&dev->sbutton_query_work,
409 msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
414 void em28xx_deregister_snapshot_button(struct em28xx *dev)
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;