drivers/media/usb/tm6000/tm6000-input.c

   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
  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
  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_BIT_NEC:
 113                 leader = 900;   /* ms */
 114                 pulse  = 700;   /* ms - the actual value would be 562 */
 115                 break;
 116         default:
 117         case RC_BIT_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_BIT_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_BIT_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
 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
 172         dprintk(2, "%s\n",__func__);
 173         if (urb->status < 0 || urb->actual_length <= 0) {
 174                 printk(KERN_INFO "tm6000: IR URB failure: status: %i, length %i\n",
 175                        urb->status, urb->actual_length);
 176                 ir->submit_urb = 1;
 177                 schedule_delayed_work(&ir->work, msecs_to_jiffies(URB_SUBMIT_DELAY));
 178                 return;
 179         }
 180         buf = urb->transfer_buffer;
 181
 182         if (ir_debug)
 183                 print_hex_dump(KERN_DEBUG, "tm6000: IR data: ",
 184                                DUMP_PREFIX_OFFSET,16, 1,
 185                                buf, urb->actual_length, false);
 186
 187         poll_result.rc_data = buf[0];
 188         if (urb->actual_length > 1)
 189                 poll_result.rc_data |= buf[1] << 8;
 190
 191         dprintk(1, "%s, scancode: 0x%04x\n",__func__, poll_result.rc_data);
 192         rc_keydown(ir->rc, poll_result.rc_data, 0);
 193
 194         usb_submit_urb(urb, GFP_ATOMIC);
 195         /*
 196          * Flash the led. We can't do it here, as it is running on IRQ context.
 197          * So, use the scheduler to do it, in a few ms.
 198          */
 199         ir->pwled = 2;
 200         schedule_delayed_work(&ir->work, msecs_to_jiffies(10));
 201 }
 202
 203 static void tm6000_ir_handle_key(struct work_struct *work)
 204 {
 205         struct tm6000_IR *ir = container_of(work, struct tm6000_IR, work.work);
 206         struct tm6000_core *dev = ir->dev;
 207         struct tm6000_ir_poll_result poll_result;
 208         int rc;
 209         u8 buf[2];
 210
 211         if (ir->wait)
 212                 return;
 213
 214         dprintk(3, "%s\n",__func__);
 215
 216         rc = tm6000_read_write_usb(dev, USB_DIR_IN |
 217                 USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 218                 REQ_02_GET_IR_CODE, 0, 0, buf, 2);
 219         if (rc < 0)
 220                 return;
 221
 222         if (rc > 1)
 223                 poll_result.rc_data = buf[0] | buf[1] << 8;
 224         else
 225                 poll_result.rc_data = buf[0];
 226
 227         /* Check if something was read */
 228         if ((poll_result.rc_data & 0xff) == 0xff) {
 229                 if (!ir->pwled) {
 230                         tm6000_flash_led(dev, 1);
 231                         ir->pwled = 1;
 232                 }
 233                 return;
 234         }
 235
 236         dprintk(1, "%s, scancode: 0x%04x\n",__func__, poll_result.rc_data);
 237         rc_keydown(ir->rc, poll_result.rc_data, 0);
 238         tm6000_flash_led(dev, 0);
 239         ir->pwled = 0;
 240
 241         /* Re-schedule polling */
 242         schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
 243 }
 244
 245 static void tm6000_ir_int_work(struct work_struct *work)
 246 {
 247         struct tm6000_IR *ir = container_of(work, struct tm6000_IR, work.work);
 248         struct tm6000_core *dev = ir->dev;
 249         int rc;
 250
 251         dprintk(3, "%s, submit_urb = %d, pwled = %d\n",__func__, ir->submit_urb,
 252                 ir->pwled);
 253
 254         if (ir->submit_urb) {
 255                 dprintk(3, "Resubmit urb\n");
 256                 tm6000_set_reg(dev, REQ_04_EN_DISABLE_MCU_INT, 2, 0);
 257
 258                 rc = usb_submit_urb(ir->int_urb, GFP_ATOMIC);
 259                 if (rc < 0) {
 260                         printk(KERN_ERR "tm6000: Can't submit an IR interrupt. Error %i\n",
 261                                rc);
 262                         /* Retry in 100 ms */
 263                         schedule_delayed_work(&ir->work, msecs_to_jiffies(URB_SUBMIT_DELAY));
 264                         return;
 265                 }
 266                 ir->submit_urb = 0;
 267         }
 268
 269         /* Led is enabled only if USB submit doesn't fail */
 270         if (ir->pwled == 2) {
 271                 tm6000_flash_led(dev, 0);
 272                 ir->pwled = 0;
 273                 schedule_delayed_work(&ir->work, msecs_to_jiffies(URB_INT_LED_DELAY));
 274         } else if (!ir->pwled) {
 275                 tm6000_flash_led(dev, 1);
 276                 ir->pwled = 1;
 277         }
 278 }
 279
 280 static int tm6000_ir_start(struct rc_dev *rc)
 281 {
 282         struct tm6000_IR *ir = rc->priv;
 283
 284         dprintk(2, "%s\n",__func__);
 285
 286         schedule_delayed_work(&ir->work, 0);
 287
 288         return 0;
 289 }
 290
 291 static void tm6000_ir_stop(struct rc_dev *rc)
 292 {
 293         struct tm6000_IR *ir = rc->priv;
 294
 295         dprintk(2, "%s\n",__func__);
 296
 297         cancel_delayed_work_sync(&ir->work);
 298 }
 299
 300 static int tm6000_ir_change_protocol(struct rc_dev *rc, u64 *rc_type)
 301 {
 302         struct tm6000_IR *ir = rc->priv;
 303
 304         if (!ir)
 305                 return 0;
 306
 307         dprintk(2, "%s\n",__func__);
 308
 309         if ((rc->rc_map.scan) && (*rc_type == RC_BIT_NEC))
 310                 ir->key_addr = ((rc->rc_map.scan[0].scancode >> 8) & 0xffff);
 311
 312         ir->rc_type = *rc_type;
 313
 314         tm6000_ir_config(ir);
 315         /* TODO */
 316         return 0;
 317 }
 318
 319 static int __tm6000_ir_int_start(struct rc_dev *rc)
 320 {
 321         struct tm6000_IR *ir = rc->priv;
 322         struct tm6000_core *dev;
 323         int pipe, size;
 324         int err = -ENOMEM;
 325
 326         if (!ir)
 327                 return -ENODEV;
 328         dev = ir->dev;
 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
 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
 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
 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
 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         u64 rc_type;
 402
 403         if (!enable_ir)
 404                 return -ENODEV;
 405
 406         if (!dev->caps.has_remote)
 407                 return 0;
 408
 409         if (!dev->ir_codes)
 410                 return 0;
 411
 412         ir = kzalloc(sizeof(*ir), GFP_ATOMIC);
 413         rc = rc_allocate_device();
 414         if (!ir || !rc)
 415                 goto out;
 416
 417         dprintk(2, "%s\n", __func__);
 418
 419         /* record handles to ourself */
 420         ir->dev = dev;
 421         dev->ir = ir;
 422         ir->rc = rc;
 423
 424         /* input setup */
 425         rc_set_allowed_protocols(rc, RC_BIT_RC5 | RC_BIT_NEC);
 426         /* Neded, in order to support NEC remotes with 24 or 32 bits */
 427         rc->scanmask = 0xffff;
 428         rc->priv = ir;
 429         rc->change_protocol = tm6000_ir_change_protocol;
 430         if (dev->int_in.endp) {
 431                 rc->open    = __tm6000_ir_int_start;
 432                 rc->close   = __tm6000_ir_int_stop;
 433                 INIT_DELAYED_WORK(&ir->work, tm6000_ir_int_work);
 434         } else {
 435                 rc->open  = tm6000_ir_start;
 436                 rc->close = tm6000_ir_stop;
 437                 ir->polling = 50;
 438                 INIT_DELAYED_WORK(&ir->work, tm6000_ir_handle_key);
 439         }
 440         rc->driver_type = RC_DRIVER_SCANCODE;
 441
 442         snprintf(ir->name, sizeof(ir->name), "tm5600/60x0 IR (%s)",
 443                                                 dev->name);
 444
 445         usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
 446         strlcat(ir->phys, "/input0", sizeof(ir->phys));
 447
 448         rc_type = RC_BIT_UNKNOWN;
 449         tm6000_ir_change_protocol(rc, &rc_type);
 450
 451         rc->input_name = ir->name;
 452         rc->input_phys = ir->phys;
 453         rc->input_id.bustype = BUS_USB;
 454         rc->input_id.version = 1;
 455         rc->input_id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
 456         rc->input_id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
 457         rc->map_name = dev->ir_codes;
 458         rc->driver_name = "tm6000";
 459         rc->dev.parent = &dev->udev->dev;
 460
 461         /* ir register */
 462         err = rc_register_device(rc);
 463         if (err)
 464                 goto out;
 465
 466         return 0;
 467
 468 out:
 469         dev->ir = NULL;
 470         rc_free_device(rc);
 471         kfree(ir);
 472         return err;
 473 }
 474
 475 int tm6000_ir_fini(struct tm6000_core *dev)
 476 {
 477         struct tm6000_IR *ir = dev->ir;
 478
 479         /* skip detach on non attached board */
 480
 481         if (!ir)
 482                 return 0;
 483
 484         dprintk(2, "%s\n",__func__);
 485
 486         if (!ir->polling)
 487                 __tm6000_ir_int_stop(ir->rc);
 488
 489         tm6000_ir_stop(ir->rc);
 490
 491         /* Turn off the led */
 492         tm6000_flash_led(dev, 0);
 493         ir->pwled = 0;
 494
 495         rc_unregister_device(ir->rc);
 496
 497         kfree(ir);
 498         dev->ir = NULL;
 499
 500         return 0;
 501 }