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 #include <linux/slab.h>
  31
  32 #include "em28xx.h"
  33
  34 #define EM28XX_SNAPSHOT_KEY KEY_CAMERA
  35 #define EM28XX_SBUTTON_QUERY_INTERVAL 500
  36 #define EM28XX_R0C_USBSUSP_SNAPSHOT 0x20
  37
  38 static unsigned int ir_debug;
  39 module_param(ir_debug, int, 0644);
  40 MODULE_PARM_DESC(ir_debug, "enable debug messages [IR]");
  41
  42 #define MODULE_NAME "em28xx"
  43
  44 #define i2cdprintk(fmt, arg...) \
  45         if (ir_debug) { \
  46                 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
  47         }
  48
  49 #define dprintk(fmt, arg...) \
  50         if (ir_debug) { \
  51                 printk(KERN_DEBUG "%s/ir: " fmt, ir->name , ## arg); \
  52         }
  53
  54 /**********************************************************
  55  Polling structure used by em28xx IR's
  56  **********************************************************/
  57
  58 struct em28xx_ir_poll_result {
  59         unsigned int toggle_bit:1;
  60         unsigned int read_count:7;
  61         u8 rc_address;
  62         u8 rc_data[4]; /* 1 byte on em2860/2880, 4 on em2874 */
  63 };
  64
  65 struct em28xx_IR {
  66         struct em28xx *dev;
  67         struct input_dev *input;
  68         struct ir_input_state ir;
  69         char name[32];
  70         char phys[32];
  71
  72         /* poll external decoder */
  73         int polling;
  74         struct delayed_work work;
  75         unsigned int last_toggle:1;
  76         unsigned int full_code:1;
  77         unsigned int last_readcount;
  78         unsigned int repeat_interval;
  79
  80         int  (*get_key)(struct em28xx_IR *, struct em28xx_ir_poll_result *);
  81
  82         /* IR device properties */
  83
  84         struct ir_dev_props props;
  85 };
  86
  87 /**********************************************************
  88  I2C IR based get keycodes - should be used with ir-kbd-i2c
  89  **********************************************************/
  90
  91 int em28xx_get_key_terratec(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
  92 {
  93         unsigned char b;
  94
  95         /* poll IR chip */
  96         if (1 != i2c_master_recv(ir->c, &b, 1)) {
  97                 i2cdprintk("read error\n");
  98                 return -EIO;
  99         }
 100
 101         /* it seems that 0xFE indicates that a button is still hold
 102            down, while 0xff indicates that no button is hold
 103            down. 0xfe sequences are sometimes interrupted by 0xFF */
 104
 105         i2cdprintk("key %02x\n", b);
 106
 107         if (b == 0xff)
 108                 return 0;
 109
 110         if (b == 0xfe)
 111                 /* keep old data */
 112                 return 1;
 113
 114         *ir_key = b;
 115         *ir_raw = b;
 116         return 1;
 117 }
 118
 119 int em28xx_get_key_em_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 120 {
 121         unsigned char buf[2];
 122         u16 code;
 123         int size;
 124
 125         /* poll IR chip */
 126         size = i2c_master_recv(ir->c, buf, sizeof(buf));
 127
 128         if (size != 2)
 129                 return -EIO;
 130
 131         /* Does eliminate repeated parity code */
 132         if (buf[1] == 0xff)
 133                 return 0;
 134
 135         ir->old = buf[1];
 136
 137         /*
 138          * Rearranges bits to the right order.
 139          * The bit order were determined experimentally by using
 140          * The original Hauppauge Grey IR and another RC5 that uses addr=0x08
 141          * The RC5 code has 14 bits, but we've experimentally determined
 142          * the meaning for only 11 bits.
 143          * So, the code translation is not complete. Yet, it is enough to
 144          * work with the provided RC5 IR.
 145          */
 146         code =
 147                  ((buf[0] & 0x01) ? 0x0020 : 0) | /*            0010 0000 */
 148                  ((buf[0] & 0x02) ? 0x0010 : 0) | /*            0001 0000 */
 149                  ((buf[0] & 0x04) ? 0x0008 : 0) | /*            0000 1000 */
 150                  ((buf[0] & 0x08) ? 0x0004 : 0) | /*            0000 0100 */
 151                  ((buf[0] & 0x10) ? 0x0002 : 0) | /*            0000 0010 */
 152                  ((buf[0] & 0x20) ? 0x0001 : 0) | /*            0000 0001 */
 153                  ((buf[1] & 0x08) ? 0x1000 : 0) | /* 0001 0000            */
 154                  ((buf[1] & 0x10) ? 0x0800 : 0) | /* 0000 1000            */
 155                  ((buf[1] & 0x20) ? 0x0400 : 0) | /* 0000 0100            */
 156                  ((buf[1] & 0x40) ? 0x0200 : 0) | /* 0000 0010            */
 157                  ((buf[1] & 0x80) ? 0x0100 : 0);  /* 0000 0001            */
 158
 159         i2cdprintk("ir hauppauge (em2840): code=0x%02x (rcv=0x%02x%02x)\n",
 160                         code, buf[1], buf[0]);
 161
 162         /* return key */
 163         *ir_key = code;
 164         *ir_raw = code;
 165         return 1;
 166 }
 167
 168 int em28xx_get_key_pinnacle_usb_grey(struct IR_i2c *ir, u32 *ir_key,
 169                                      u32 *ir_raw)
 170 {
 171         unsigned char buf[3];
 172
 173         /* poll IR chip */
 174
 175         if (3 != i2c_master_recv(ir->c, buf, 3)) {
 176                 i2cdprintk("read error\n");
 177                 return -EIO;
 178         }
 179
 180         i2cdprintk("key %02x\n", buf[2]&0x3f);
 181         if (buf[0] != 0x00)
 182                 return 0;
 183
 184         *ir_key = buf[2]&0x3f;
 185         *ir_raw = buf[2]&0x3f;
 186
 187         return 1;
 188 }
 189
 190 int em28xx_get_key_winfast_usbii_deluxe(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 191 {
 192         unsigned char subaddr, keydetect, key;
 193
 194         struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0, .buf = &subaddr, .len = 1},
 195
 196                                 { .addr = ir->c->addr, .flags = I2C_M_RD, .buf = &keydetect, .len = 1} };
 197
 198         subaddr = 0x10;
 199         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
 200                 i2cdprintk("read error\n");
 201                 return -EIO;
 202         }
 203         if (keydetect == 0x00)
 204                 return 0;
 205
 206         subaddr = 0x00;
 207         msg[1].buf = &key;
 208         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
 209                 i2cdprintk("read error\n");
 210         return -EIO;
 211         }
 212         if (key == 0x00)
 213                 return 0;
 214
 215         *ir_key = key;
 216         *ir_raw = key;
 217         return 1;
 218 }
 219
 220 /**********************************************************
 221  Poll based get keycode functions
 222  **********************************************************/
 223
 224 /* This is for the em2860/em2880 */
 225 static int default_polling_getkey(struct em28xx_IR *ir,
 226                                   struct em28xx_ir_poll_result *poll_result)
 227 {
 228         struct em28xx *dev = ir->dev;
 229         int rc;
 230         u8 msg[3] = { 0, 0, 0 };
 231
 232         /* Read key toggle, brand, and key code
 233            on registers 0x45, 0x46 and 0x47
 234          */
 235         rc = dev->em28xx_read_reg_req_len(dev, 0, EM28XX_R45_IR,
 236                                           msg, sizeof(msg));
 237         if (rc < 0)
 238                 return rc;
 239
 240         /* Infrared toggle (Reg 0x45[7]) */
 241         poll_result->toggle_bit = (msg[0] >> 7);
 242
 243         /* Infrared read count (Reg 0x45[6:0] */
 244         poll_result->read_count = (msg[0] & 0x7f);
 245
 246         /* Remote Control Address (Reg 0x46) */
 247         poll_result->rc_address = msg[1];
 248
 249         /* Remote Control Data (Reg 0x47) */
 250         poll_result->rc_data[0] = msg[2];
 251
 252         return 0;
 253 }
 254
 255 static int em2874_polling_getkey(struct em28xx_IR *ir,
 256                                  struct em28xx_ir_poll_result *poll_result)
 257 {
 258         struct em28xx *dev = ir->dev;
 259         int rc;
 260         u8 msg[5] = { 0, 0, 0, 0, 0 };
 261
 262         /* Read key toggle, brand, and key code
 263            on registers 0x51-55
 264          */
 265         rc = dev->em28xx_read_reg_req_len(dev, 0, EM2874_R51_IR,
 266                                           msg, sizeof(msg));
 267         if (rc < 0)
 268                 return rc;
 269
 270         /* Infrared toggle (Reg 0x51[7]) */
 271         poll_result->toggle_bit = (msg[0] >> 7);
 272
 273         /* Infrared read count (Reg 0x51[6:0] */
 274         poll_result->read_count = (msg[0] & 0x7f);
 275
 276         /* Remote Control Address (Reg 0x52) */
 277         poll_result->rc_address = msg[1];
 278
 279         /* Remote Control Data (Reg 0x53-55) */
 280         poll_result->rc_data[0] = msg[2];
 281         poll_result->rc_data[1] = msg[3];
 282         poll_result->rc_data[2] = msg[4];
 283
 284         return 0;
 285 }
 286
 287 /**********************************************************
 288  Polling code for em28xx
 289  **********************************************************/
 290
 291 static void em28xx_ir_handle_key(struct em28xx_IR *ir)
 292 {
 293         int result;
 294         int do_sendkey = 0;
 295         struct em28xx_ir_poll_result poll_result;
 296
 297         /* read the registers containing the IR status */
 298         result = ir->get_key(ir, &poll_result);
 299         if (result < 0) {
 300                 dprintk("ir->get_key() failed %d\n", result);
 301                 return;
 302         }
 303
 304         dprintk("ir->get_key result tb=%02x rc=%02x lr=%02x data=%02x%02x\n",
 305                 poll_result.toggle_bit, poll_result.read_count,
 306                 ir->last_readcount, poll_result.rc_address,
 307                 poll_result.rc_data[0]);
 308
 309         if (ir->dev->chip_id == CHIP_ID_EM2874) {
 310                 /* The em2874 clears the readcount field every time the
 311                    register is read.  The em2860/2880 datasheet says that it
 312                    is supposed to clear the readcount, but it doesn't.  So with
 313                    the em2874, we are looking for a non-zero read count as
 314                    opposed to a readcount that is incrementing */
 315                 ir->last_readcount = 0;
 316         }
 317
 318         if (poll_result.read_count == 0) {
 319                 /* The button has not been pressed since the last read */
 320         } else if (ir->last_toggle != poll_result.toggle_bit) {
 321                 /* A button has been pressed */
 322                 dprintk("button has been pressed\n");
 323                 ir->last_toggle = poll_result.toggle_bit;
 324                 ir->repeat_interval = 0;
 325                 do_sendkey = 1;
 326         } else if (poll_result.toggle_bit == ir->last_toggle &&
 327                    poll_result.read_count > 0 &&
 328                    poll_result.read_count != ir->last_readcount) {
 329                 /* The button is still being held down */
 330                 dprintk("button being held down\n");
 331
 332                 /* Debouncer for first keypress */
 333                 if (ir->repeat_interval++ > 9) {
 334                         /* Start repeating after 1 second */
 335                         do_sendkey = 1;
 336                 }
 337         }
 338
 339         if (do_sendkey) {
 340                 dprintk("sending keypress\n");
 341
 342                 if (ir->full_code)
 343                         ir_input_keydown(ir->input, &ir->ir,
 344                                          poll_result.rc_address << 8 |
 345                                          poll_result.rc_data[0]);
 346                 else
 347                         ir_input_keydown(ir->input, &ir->ir,
 348                                          poll_result.rc_data[0]);
 349
 350                 ir_input_nokey(ir->input, &ir->ir);
 351         }
 352
 353         ir->last_readcount = poll_result.read_count;
 354         return;
 355 }
 356
 357 static void em28xx_ir_work(struct work_struct *work)
 358 {
 359         struct em28xx_IR *ir = container_of(work, struct em28xx_IR, work.work);
 360
 361         em28xx_ir_handle_key(ir);
 362         schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling));
 363 }
 364
 365 static void em28xx_ir_start(struct em28xx_IR *ir)
 366 {
 367         INIT_DELAYED_WORK(&ir->work, em28xx_ir_work);
 368         schedule_delayed_work(&ir->work, 0);
 369 }
 370
 371 static void em28xx_ir_stop(struct em28xx_IR *ir)
 372 {
 373         cancel_delayed_work_sync(&ir->work);
 374 }
 375
 376 int em28xx_ir_change_protocol(void *priv, u64 ir_type)
 377 {
 378         int rc = 0;
 379         struct em28xx_IR *ir = priv;
 380         struct em28xx *dev = ir->dev;
 381         u8 ir_config = EM2874_IR_RC5;
 382
 383         /* Adjust xclk based o IR table for RC5/NEC tables */
 384
 385         if (ir_type == IR_TYPE_RC5) {
 386                 dev->board.xclk |= EM28XX_XCLK_IR_RC5_MODE;
 387                 ir->full_code = 1;
 388         } else if (ir_type == IR_TYPE_NEC) {
 389                 dev->board.xclk &= ~EM28XX_XCLK_IR_RC5_MODE;
 390                 ir_config = EM2874_IR_NEC;
 391                 ir->full_code = 1;
 392         } else
 393                 rc = -EINVAL;
 394
 395         em28xx_write_reg_bits(dev, EM28XX_R0F_XCLK, dev->board.xclk,
 396                               EM28XX_XCLK_IR_RC5_MODE);
 397
 398         /* Setup the proper handler based on the chip */
 399         switch (dev->chip_id) {
 400         case CHIP_ID_EM2860:
 401         case CHIP_ID_EM2883:
 402                 ir->get_key = default_polling_getkey;
 403                 break;
 404         case CHIP_ID_EM2874:
 405                 ir->get_key = em2874_polling_getkey;
 406                 em28xx_write_regs(dev, EM2874_R50_IR_CONFIG, &ir_config, 1);
 407                 break;
 408         default:
 409                 printk("Unrecognized em28xx chip id: IR not supported\n");
 410                 rc = -EINVAL;
 411         }
 412
 413         return rc;
 414 }
 415
 416 int em28xx_ir_init(struct em28xx *dev)
 417 {
 418         struct em28xx_IR *ir;
 419         struct input_dev *input_dev;
 420         int err = -ENOMEM;
 421
 422         if (dev->board.ir_codes == NULL) {
 423                 /* No remote control support */
 424                 return 0;
 425         }
 426
 427         ir = kzalloc(sizeof(*ir), GFP_KERNEL);
 428         input_dev = input_allocate_device();
 429         if (!ir || !input_dev)
 430                 goto err_out_free;
 431
 432         /* record handles to ourself */
 433         ir->dev = dev;
 434         dev->ir = ir;
 435
 436         ir->input = input_dev;
 437
 438         /*
 439          * em2874 supports more protocols. For now, let's just announce
 440          * the two protocols that were already tested
 441          */
 442         ir->props.allowed_protos = IR_TYPE_RC5 | IR_TYPE_NEC;
 443         ir->props.priv = ir;
 444         ir->props.change_protocol = em28xx_ir_change_protocol;
 445
 446         /* This is how often we ask the chip for IR information */
 447         ir->polling = 100; /* ms */
 448
 449         /* init input device */
 450         snprintf(ir->name, sizeof(ir->name), "em28xx IR (%s)",
 451                                                 dev->name);
 452
 453         usb_make_path(dev->udev, ir->phys, sizeof(ir->phys));
 454         strlcat(ir->phys, "/input0", sizeof(ir->phys));
 455
 456         /* Set IR protocol */
 457         err = ir_input_init(input_dev, &ir->ir, IR_TYPE_OTHER);
 458         if (err < 0)
 459                 goto err_out_free;
 460
 461         input_dev->name = ir->name;
 462         input_dev->phys = ir->phys;
 463         input_dev->id.bustype = BUS_USB;
 464         input_dev->id.version = 1;
 465         input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
 466         input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
 467
 468         input_dev->dev.parent = &dev->udev->dev;
 469
 470
 471         em28xx_ir_start(ir);
 472
 473         /* all done */
 474         err = ir_input_register(ir->input, dev->board.ir_codes,
 475                                 &ir->props, MODULE_NAME);
 476         if (err)
 477                 goto err_out_stop;
 478
 479         return 0;
 480  err_out_stop:
 481         em28xx_ir_stop(ir);
 482         dev->ir = NULL;
 483  err_out_free:
 484         kfree(ir);
 485         return err;
 486 }
 487
 488 int em28xx_ir_fini(struct em28xx *dev)
 489 {
 490         struct em28xx_IR *ir = dev->ir;
 491
 492         /* skip detach on non attached boards */
 493         if (!ir)
 494                 return 0;
 495
 496         em28xx_ir_stop(ir);
 497         ir_input_unregister(ir->input);
 498         kfree(ir);
 499
 500         /* done */
 501         dev->ir = NULL;
 502         return 0;
 503 }
 504
 505 /**********************************************************
 506  Handle Webcam snapshot button
 507  **********************************************************/
 508
 509 static void em28xx_query_sbutton(struct work_struct *work)
 510 {
 511         /* Poll the register and see if the button is depressed */
 512         struct em28xx *dev =
 513                 container_of(work, struct em28xx, sbutton_query_work.work);
 514         int ret;
 515
 516         ret = em28xx_read_reg(dev, EM28XX_R0C_USBSUSP);
 517
 518         if (ret & EM28XX_R0C_USBSUSP_SNAPSHOT) {
 519                 u8 cleared;
 520                 /* Button is depressed, clear the register */
 521                 cleared = ((u8) ret) & ~EM28XX_R0C_USBSUSP_SNAPSHOT;
 522                 em28xx_write_regs(dev, EM28XX_R0C_USBSUSP, &cleared, 1);
 523
 524                 /* Not emulate the keypress */
 525                 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
 526                                  1);
 527                 /* Now unpress the key */
 528                 input_report_key(dev->sbutton_input_dev, EM28XX_SNAPSHOT_KEY,
 529                                  0);
 530         }
 531
 532         /* Schedule next poll */
 533         schedule_delayed_work(&dev->sbutton_query_work,
 534                               msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
 535 }
 536
 537 void em28xx_register_snapshot_button(struct em28xx *dev)
 538 {
 539         struct input_dev *input_dev;
 540         int err;
 541
 542         em28xx_info("Registering snapshot button...\n");
 543         input_dev = input_allocate_device();
 544         if (!input_dev) {
 545                 em28xx_errdev("input_allocate_device failed\n");
 546                 return;
 547         }
 548
 549         usb_make_path(dev->udev, dev->snapshot_button_path,
 550                       sizeof(dev->snapshot_button_path));
 551         strlcat(dev->snapshot_button_path, "/sbutton",
 552                 sizeof(dev->snapshot_button_path));
 553         INIT_DELAYED_WORK(&dev->sbutton_query_work, em28xx_query_sbutton);
 554
 555         input_dev->name = "em28xx snapshot button";
 556         input_dev->phys = dev->snapshot_button_path;
 557         input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
 558         set_bit(EM28XX_SNAPSHOT_KEY, input_dev->keybit);
 559         input_dev->keycodesize = 0;
 560         input_dev->keycodemax = 0;
 561         input_dev->id.bustype = BUS_USB;
 562         input_dev->id.vendor = le16_to_cpu(dev->udev->descriptor.idVendor);
 563         input_dev->id.product = le16_to_cpu(dev->udev->descriptor.idProduct);
 564         input_dev->id.version = 1;
 565         input_dev->dev.parent = &dev->udev->dev;
 566
 567         err = input_register_device(input_dev);
 568         if (err) {
 569                 em28xx_errdev("input_register_device failed\n");
 570                 input_free_device(input_dev);
 571                 return;
 572         }
 573
 574         dev->sbutton_input_dev = input_dev;
 575         schedule_delayed_work(&dev->sbutton_query_work,
 576                               msecs_to_jiffies(EM28XX_SBUTTON_QUERY_INTERVAL));
 577         return;
 578
 579 }
 580
 581 void em28xx_deregister_snapshot_button(struct em28xx *dev)
 582 {
 583         if (dev->sbutton_input_dev != NULL) {
 584                 em28xx_info("Deregistering snapshot button\n");
 585                 cancel_rearming_delayed_work(&dev->sbutton_query_work);
 586                 input_unregister_device(dev->sbutton_input_dev);
 587                 dev->sbutton_input_dev = NULL;
 588         }
 589         return;
 590 }