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