1 /*
2 * tm6000-input.c - driver for TM5600/TM6000/TM6010 USB video capture devices
3 *
4 * Copyright (C) 2010 Stefan Ringel <stefan.ringel@arcor.de>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation version 2
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19
20 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/delay.h>
23
24 #include <linux/input.h>
25 #include <linux/usb.h>
26
27 #include <media/rc-core.h>
28
29 #include "tm6000.h"
30 #include "tm6000-regs.h"
31
32 static unsigned int ir_debug;
33 module_param(ir_debug, int, 0644);
34 MODULE_PARM_DESC(ir_debug, "debug message level");
35
36 static unsigned int enable_ir = 1;
37 module_param(enable_ir, int, 0644);
38 MODULE_PARM_DESC(enable_ir, "enable ir (default is enable)");
39
40 static unsigned int ir_clock_mhz = 12;
41 module_param(ir_clock_mhz, int, 0644);
42 MODULE_PARM_DESC(enable_ir, "ir clock, in MHz");
43
44 #define URB_SUBMIT_DELAY 100 /* ms - Delay to submit an URB request on retrial and init */
45 #define URB_INT_LED_DELAY 100 /* ms - Delay to turn led on again on int mode */
46
47 #undef dprintk
48
49 #define dprintk(level, fmt, arg...) do {\
50 if (ir_debug >= level) \
51 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
52 } while (0)
53
54 struct tm6000_ir_poll_result {
55 u16 rc_data;
56 };
57
58 struct tm6000_IR {
59 struct tm6000_core *dev;
60 struct rc_dev *rc;
61 char name[32];
62 char phys[32];
63
64 /* poll expernal decoder */
65 int polling;
66 struct delayed_work work;
67 u8 wait:1;
68 u8 pwled:2;
69 u8 submit_urb:1;
70 u16 key_addr;
71 struct urb *int_urb;
72
73 /* IR device properties */
74 u64 rc_type;
75 };
76
tm6000_ir_wait(struct tm6000_core * dev,u8 state)77 void tm6000_ir_wait(struct tm6000_core *dev, u8 state)
78 {
79 struct tm6000_IR *ir = dev->ir;
80
81 if (!dev->ir)
82 return;
83
84 dprintk(2, "%s: %i\n",__func__, ir->wait);
85
86 if (state)
87 ir->wait = 1;
88 else
89 ir->wait = 0;
90 }
91
tm6000_ir_config(struct tm6000_IR * ir)92 static int tm6000_ir_config(struct tm6000_IR *ir)
93 {
94 struct tm6000_core *dev = ir->dev;
95 u32 pulse = 0, leader = 0;
96
97 dprintk(2, "%s\n",__func__);
98
99 /*
100 * The IR decoder supports RC-5 or NEC, with a configurable timing.
101 * The timing configuration there is not that accurate, as it uses
102 * approximate values. The NEC spec mentions a 562.5 unit period,
103 * and RC-5 uses a 888.8 period.
104 * Currently, driver assumes a clock provided by a 12 MHz XTAL, but
105 * a modprobe parameter can adjust it.
106 * Adjustments are required for other timings.
107 * It seems that the 900ms timing for NEC is used to detect a RC-5
108 * IR, in order to discard such decoding
109 */
110
111 switch (ir->rc_type) {
112 case RC_TYPE_NEC:
113 leader = 900; /* ms */
114 pulse = 700; /* ms - the actual value would be 562 */
115 break;
116 default:
117 case RC_TYPE_RC5:
118 leader = 900; /* ms - from the NEC decoding */
119 pulse = 1780; /* ms - The actual value would be 1776 */
120 break;
121 }
122
123 pulse = ir_clock_mhz * pulse;
124 leader = ir_clock_mhz * leader;
125 if (ir->rc_type == RC_TYPE_NEC)
126 leader = leader | 0x8000;
127
128 dprintk(2, "%s: %s, %d MHz, leader = 0x%04x, pulse = 0x%06x \n",
129 __func__,
130 (ir->rc_type == RC_TYPE_NEC) ? "NEC" : "RC-5",
131 ir_clock_mhz, leader, pulse);
132
133 /* Remote WAKEUP = enable, normal mode, from IR decoder output */
134 tm6000_set_reg(dev, TM6010_REQ07_RE5_REMOTE_WAKEUP, 0xfe);
135
136 /* Enable IR reception on non-busrt mode */
137 tm6000_set_reg(dev, TM6010_REQ07_RD8_IR, 0x2f);
138
139 /* IR_WKUP_SEL = Low byte in decoded IR data */
140 tm6000_set_reg(dev, TM6010_REQ07_RDA_IR_WAKEUP_SEL, 0xff);
141 /* IR_WKU_ADD code */
142 tm6000_set_reg(dev, TM6010_REQ07_RDB_IR_WAKEUP_ADD, 0xff);
143
144 tm6000_set_reg(dev, TM6010_REQ07_RDC_IR_LEADER1, leader >> 8);
145 tm6000_set_reg(dev, TM6010_REQ07_RDD_IR_LEADER0, leader);
146
147 tm6000_set_reg(dev, TM6010_REQ07_RDE_IR_PULSE_CNT1, pulse >> 8);
148 tm6000_set_reg(dev, TM6010_REQ07_RDF_IR_PULSE_CNT0, pulse);
149
150 if (!ir->polling)
151 tm6000_set_reg(dev, REQ_04_EN_DISABLE_MCU_INT, 2, 0);
152 else
153 tm6000_set_reg(dev, REQ_04_EN_DISABLE_MCU_INT, 2, 1);
154 msleep(10);
155
156 /* Shows that IR is working via the LED */
157 tm6000_flash_led(dev, 0);
158 msleep(100);
159 tm6000_flash_led(dev, 1);
160 ir->pwled = 1;
161
162 return 0;
163 }
164
tm6000_ir_urb_received(struct urb * urb)165 static void tm6000_ir_urb_received(struct urb *urb)
166 {
167 struct tm6000_core *dev = urb->context;
168 struct tm6000_IR *ir = dev->ir;
169 struct tm6000_ir_poll_result poll_result;
170 char *buf;
171 int rc;
172
173 dprintk(2, "%s\n",__func__);
174 if (urb->status < 0 || urb->actual_length <= 0) {
175 printk(KERN_INFO "tm6000: IR URB failure: status: %i, length %i\n",
176 urb->status, urb->actual_length);
177 ir->submit_urb = 1;
178 schedule_delayed_work(&ir->work, msecs_to_jiffies(URB_SUBMIT_DELAY));
179 return;
180 }
181 buf = urb->transfer_buffer;
182
183 if (ir_debug)
184 print_hex_dump(KERN_DEBUG, "tm6000: IR data: ",
185 DUMP_PREFIX_OFFSET,16, 1,
186 buf, urb->actual_length, false);
187
188 poll_result.rc_data = buf[0];
189 if (urb->actual_length > 1)
190 poll_result.rc_data |= buf[1] << 8;
191
192 dprintk(1, "%s, scancode: 0x%04x\n",__func__, poll_result.rc_data);
193 rc_keydown(ir->rc, poll_result.rc_data, 0);
194
195 rc = usb_submit_urb(urb, GFP_ATOMIC);
196 /*
197 * Flash the led. We can't do it here, as it is running on IRQ context.
198 * So, use the scheduler to do it, in a few ms.
199 */
200 ir->pwled = 2;
201 schedule_delayed_work(&ir->work, msecs_to_jiffies(10));
202 }
203
tm6000_ir_handle_key(struct work_struct * work)204 static void tm6000_ir_handle_key(struct work_struct *work)
205 {
206 struct tm6000_IR *ir = container_of(work, struct tm6000_IR, work.work);
207 struct tm6000_core *dev = ir->dev;
208 struct tm6000_ir_poll_result poll_result;
209 int rc;
210 u8 buf[2];
211
212 if (ir->wait)
213 return;
214
215 dprintk(3, "%s\n",__func__);
216
217 rc = tm6000_read_write_usb(dev, USB_DIR_IN |
218 USB_TYPE_VENDOR | USB_RECIP_DEVICE,
219 REQ_02_GET_IR_CODE, 0, 0, buf, 2);
220 if (rc < 0)
221 return;
222
223 if (rc > 1)
224 poll_result.rc_data = buf[0] | buf[1] << 8;
225 else
226 poll_result.rc_data = buf[0];
227
228 /* Check if something was read */
229 if ((poll_result.rc_data & 0xff) == 0xff) {
230 if (!ir->pwled) {
231 tm6000_flash_led(dev, 1);
232 ir->pwled = 1;
233 }
234 return;
235 }
236
237 dprintk(1, "%s, scancode: 0x%04x\n",__func__, poll_result.rc_data);
238 rc_keydown(ir->rc, poll_result.rc_data, 0);
239 tm6000_flash_led(dev, 0);
240 ir->pwled = 0;
241
242 /* Re-schedule polling */
243 schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
244 }
245
tm6000_ir_int_work(struct work_struct * work)246 static void tm6000_ir_int_work(struct work_struct *work)
247 {
248 struct tm6000_IR *ir = container_of(work, struct tm6000_IR, work.work);
249 struct tm6000_core *dev = ir->dev;
250 int rc;
251
252 dprintk(3, "%s, submit_urb = %d, pwled = %d\n",__func__, ir->submit_urb,
253 ir->pwled);
254
255 if (ir->submit_urb) {
256 dprintk(3, "Resubmit urb\n");
257 tm6000_set_reg(dev, REQ_04_EN_DISABLE_MCU_INT, 2, 0);
258
259 rc = usb_submit_urb(ir->int_urb, GFP_ATOMIC);
260 if (rc < 0) {
261 printk(KERN_ERR "tm6000: Can't submit an IR interrupt. Error %i\n",
262 rc);
263 /* Retry in 100 ms */
264 schedule_delayed_work(&ir->work, msecs_to_jiffies(URB_SUBMIT_DELAY));
265 return;
266 }
267 ir->submit_urb = 0;
268 }
269
270 /* Led is enabled only if USB submit doesn't fail */
271 if (ir->pwled == 2) {
272 tm6000_flash_led(dev, 0);
273 ir->pwled = 0;
274 schedule_delayed_work(&ir->work, msecs_to_jiffies(URB_INT_LED_DELAY));
275 } else if (!ir->pwled) {
276 tm6000_flash_led(dev, 1);
277 ir->pwled = 1;
278 }
279 }
280
tm6000_ir_start(struct rc_dev * rc)281 static int tm6000_ir_start(struct rc_dev *rc)
282 {
283 struct tm6000_IR *ir = rc->priv;
284
285 dprintk(2, "%s\n",__func__);
286
287 schedule_delayed_work(&ir->work, 0);
288
289 return 0;
290 }
291
tm6000_ir_stop(struct rc_dev * rc)292 static void tm6000_ir_stop(struct rc_dev *rc)
293 {
294 struct tm6000_IR *ir = rc->priv;
295
296 dprintk(2, "%s\n",__func__);
297
298 cancel_delayed_work_sync(&ir->work);
299 }
300
tm6000_ir_change_protocol(struct rc_dev * rc,u64 rc_type)301 static int tm6000_ir_change_protocol(struct rc_dev *rc, u64 rc_type)
302 {
303 struct tm6000_IR *ir = rc->priv;
304
305 if (!ir)
306 return 0;
307
308 dprintk(2, "%s\n",__func__);
309
310 if ((rc->rc_map.scan) && (rc_type == RC_TYPE_NEC))
311 ir->key_addr = ((rc->rc_map.scan[0].scancode >> 8) & 0xffff);
312
313 ir->rc_type = rc_type;
314
315 tm6000_ir_config(ir);
316 /* TODO */
317 return 0;
318 }
319
__tm6000_ir_int_start(struct rc_dev * rc)320 static int __tm6000_ir_int_start(struct rc_dev *rc)
321 {
322 struct tm6000_IR *ir = rc->priv;
323 struct tm6000_core *dev = ir->dev;
324 int pipe, size;
325 int err = -ENOMEM;
326
327 if (!ir)
328 return -ENODEV;
329
330 dprintk(2, "%s\n",__func__);
331
332 ir->int_urb = usb_alloc_urb(0, GFP_ATOMIC);
333 if (!ir->int_urb)
334 return -ENOMEM;
335
336 pipe = usb_rcvintpipe(dev->udev,
337 dev->int_in.endp->desc.bEndpointAddress
338 & USB_ENDPOINT_NUMBER_MASK);
339
340 size = usb_maxpacket(dev->udev, pipe, usb_pipeout(pipe));
341 dprintk(1, "IR max size: %d\n", size);
342
343 ir->int_urb->transfer_buffer = kzalloc(size, GFP_ATOMIC);
344 if (ir->int_urb->transfer_buffer == NULL) {
345 usb_free_urb(ir->int_urb);
346 return err;
347 }
348 dprintk(1, "int interval: %d\n", dev->int_in.endp->desc.bInterval);
349
350 usb_fill_int_urb(ir->int_urb, dev->udev, pipe,
351 ir->int_urb->transfer_buffer, size,
352 tm6000_ir_urb_received, dev,
353 dev->int_in.endp->desc.bInterval);
354
355 ir->submit_urb = 1;
356 schedule_delayed_work(&ir->work, msecs_to_jiffies(URB_SUBMIT_DELAY));
357
358 return 0;
359 }
360
__tm6000_ir_int_stop(struct rc_dev * rc)361 static void __tm6000_ir_int_stop(struct rc_dev *rc)
362 {
363 struct tm6000_IR *ir = rc->priv;
364
365 if (!ir || !ir->int_urb)
366 return;
367
368 dprintk(2, "%s\n",__func__);
369
370 usb_kill_urb(ir->int_urb);
371 kfree(ir->int_urb->transfer_buffer);
372 usb_free_urb(ir->int_urb);
373 ir->int_urb = NULL;
374 }
375
tm6000_ir_int_start(struct tm6000_core * dev)376 int tm6000_ir_int_start(struct tm6000_core *dev)
377 {
378 struct tm6000_IR *ir = dev->ir;
379
380 if (!ir)
381 return 0;
382
383 return __tm6000_ir_int_start(ir->rc);
384 }
385
tm6000_ir_int_stop(struct tm6000_core * dev)386 void tm6000_ir_int_stop(struct tm6000_core *dev)
387 {
388 struct tm6000_IR *ir = dev->ir;
389
390 if (!ir || !ir->rc)
391 return;
392
393 __tm6000_ir_int_stop(ir->rc);
394 }
395
tm6000_ir_init(struct tm6000_core * dev)396 int tm6000_ir_init(struct tm6000_core *dev)
397 {
398 struct tm6000_IR *ir;
399 struct rc_dev *rc;
400 int err = -ENOMEM;
401
402 if (!enable_ir)
403 return -ENODEV;
404
405 if (!dev->caps.has_remote)
406 return 0;
407
408 if (!dev->ir_codes)
409 return 0;
410
411 ir = kzalloc(sizeof(*ir), GFP_ATOMIC);
412 rc = rc_allocate_device();
413 if (!ir || !rc)
414 goto out;
415
416 dprintk(2, "%s\n", __func__);
417
418 /* record handles to ourself */
419 ir->dev = dev;
420 dev->ir = ir;
421 ir->rc = rc;
422
423 /* input setup */
424 rc->allowed_protos = RC_TYPE_RC5 | RC_TYPE_NEC;
425 /* Neded, in order to support NEC remotes with 24 or 32 bits */
426 rc->scanmask = 0xffff;
427 rc->priv = ir;
428 rc->change_protocol = tm6000_ir_change_protocol;
429 if (dev->int_in.endp) {
430 rc->open = __tm6000_ir_int_start;
431 rc->close = __tm6000_ir_int_stop;
432 INIT_DELAYED_WORK(&ir->work, tm6000_ir_int_work);
433 } else {
434 rc->open = tm6000_ir_start;
435 rc->close = tm6000_ir_stop;
436 ir->polling = 50;
437 INIT_DELAYED_WORK(&ir->work, tm6000_ir_handle_key);
438 }
439 rc->driver_type = RC_DRIVER_SCANCODE;
440
441 snprintf(ir->name, sizeof(ir->name), "tm5600/60x0 IR (%s)",
442 dev->name);
443
444 usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
445 strlcat(ir->phys, "/input0", sizeof(ir->phys));
446
447 tm6000_ir_change_protocol(rc, RC_TYPE_UNKNOWN);
448
449 rc->input_name = ir->name;
450 rc->input_phys = ir->phys;
451 rc->input_id.bustype = BUS_USB;
452 rc->input_id.version = 1;
453 rc->input_id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
454 rc->input_id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
455 rc->map_name = dev->ir_codes;
456 rc->driver_name = "tm6000";
457 rc->dev.parent = &dev->udev->dev;
458
459 /* ir register */
460 err = rc_register_device(rc);
461 if (err)
462 goto out;
463
464 return 0;
465
466 out:
467 dev->ir = NULL;
468 rc_free_device(rc);
469 kfree(ir);
470 return err;
471 }
472
tm6000_ir_fini(struct tm6000_core * dev)473 int tm6000_ir_fini(struct tm6000_core *dev)
474 {
475 struct tm6000_IR *ir = dev->ir;
476
477 /* skip detach on non attached board */
478
479 if (!ir)
480 return 0;
481
482 dprintk(2, "%s\n",__func__);
483
484 if (!ir->polling)
485 __tm6000_ir_int_stop(ir->rc);
486
487 tm6000_ir_stop(ir->rc);
488
489 /* Turn off the led */
490 tm6000_flash_led(dev, 0);
491 ir->pwled = 0;
492
493 rc_unregister_device(ir->rc);
494
495 kfree(ir);
496 dev->ir = NULL;
497
498 return 0;
499 }
500