drivers/media/video/bt8xx/bttv-input.c

   1 /*
   2  *
   3  * Copyright (c) 2003 Gerd Knorr
   4  * Copyright (c) 2003 Pavel Machek
   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; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19  */
  20
  21 #include <linux/module.h>
  22 #include <linux/init.h>
  23 #include <linux/delay.h>
  24 #include <linux/interrupt.h>
  25 #include <linux/input.h>
  26 #include <linux/slab.h>
  27
  28 #include "bttv.h"
  29 #include "bttvp.h"
  30
  31
  32 static int ir_debug;
  33 module_param(ir_debug, int, 0644);
  34
  35 static int ir_rc5_remote_gap = 885;
  36 module_param(ir_rc5_remote_gap, int, 0644);
  37
  38 #undef dprintk
  39 #define dprintk(arg...) do {    \
  40         if (ir_debug >= 1)      \
  41                 printk(arg);    \
  42 } while (0)
  43
  44 #define DEVNAME "bttv-input"
  45
  46 #define MODULE_NAME "bttv"
  47
  48 /* ---------------------------------------------------------------------- */
  49
  50 static void ir_handle_key(struct bttv *btv)
  51 {
  52         struct bttv_ir *ir = btv->remote;
  53         u32 gpio,data;
  54
  55         /* read gpio value */
  56         gpio = bttv_gpio_read(&btv->c);
  57         if (ir->polling) {
  58                 if (ir->last_gpio == gpio)
  59                         return;
  60                 ir->last_gpio = gpio;
  61         }
  62
  63         /* extract data */
  64         data = ir_extract_bits(gpio, ir->mask_keycode);
  65         dprintk(KERN_INFO DEVNAME ": irq gpio=0x%x code=%d | %s%s%s\n",
  66                 gpio, data,
  67                 ir->polling               ? "poll"  : "irq",
  68                 (gpio & ir->mask_keydown) ? " down" : "",
  69                 (gpio & ir->mask_keyup)   ? " up"   : "");
  70
  71         if ((ir->mask_keydown && (gpio & ir->mask_keydown)) ||
  72             (ir->mask_keyup   && !(gpio & ir->mask_keyup))) {
  73                 rc_keydown_notimeout(ir->dev, data, 0);
  74         } else {
  75                 /* HACK: Probably, ir->mask_keydown is missing
  76                    for this board */
  77                 if (btv->c.type == BTTV_BOARD_WINFAST2000)
  78                         rc_keydown_notimeout(ir->dev, data, 0);
  79
  80                 rc_keyup(ir->dev);
  81         }
  82 }
  83
  84 static void ir_enltv_handle_key(struct bttv *btv)
  85 {
  86         struct bttv_ir *ir = btv->remote;
  87         u32 gpio, data, keyup;
  88
  89         /* read gpio value */
  90         gpio = bttv_gpio_read(&btv->c);
  91
  92         /* extract data */
  93         data = ir_extract_bits(gpio, ir->mask_keycode);
  94
  95         /* Check if it is keyup */
  96         keyup = (gpio & ir->mask_keyup) ? 1 << 31 : 0;
  97
  98         if ((ir->last_gpio & 0x7f) != data) {
  99                 dprintk(KERN_INFO DEVNAME ": gpio=0x%x code=%d | %s\n",
 100                         gpio, data,
 101                         (gpio & ir->mask_keyup) ? " up" : "up/down");
 102
 103                 rc_keydown_notimeout(ir->dev, data, 0);
 104                 if (keyup)
 105                         rc_keyup(ir->dev);
 106         } else {
 107                 if ((ir->last_gpio & 1 << 31) == keyup)
 108                         return;
 109
 110                 dprintk(KERN_INFO DEVNAME ":(cnt) gpio=0x%x code=%d | %s\n",
 111                         gpio, data,
 112                         (gpio & ir->mask_keyup) ? " up" : "down");
 113
 114                 if (keyup)
 115                         rc_keyup(ir->dev);
 116                 else
 117                         rc_keydown_notimeout(ir->dev, data, 0);
 118         }
 119
 120         ir->last_gpio = data | keyup;
 121 }
 122
 123 static int bttv_rc5_irq(struct bttv *btv);
 124
 125 void bttv_input_irq(struct bttv *btv)
 126 {
 127         struct bttv_ir *ir = btv->remote;
 128
 129         if (ir->rc5_gpio)
 130                 bttv_rc5_irq(btv);
 131         else if (!ir->polling)
 132                 ir_handle_key(btv);
 133 }
 134
 135 static void bttv_input_timer(unsigned long data)
 136 {
 137         struct bttv *btv = (struct bttv*)data;
 138         struct bttv_ir *ir = btv->remote;
 139
 140         if (btv->c.type == BTTV_BOARD_ENLTV_FM_2)
 141                 ir_enltv_handle_key(btv);
 142         else
 143                 ir_handle_key(btv);
 144         mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling));
 145 }
 146
 147 /*
 148  * FIXME: Nebula digi uses the legacy way to decode RC5, instead of relying
 149  * on the rc-core way. As we need to be sure that both IRQ transitions are
 150  * properly triggered, Better to touch it only with this hardware for
 151  * testing.
 152  */
 153
 154 #define RC5_START(x)    (((x) >> 12) & 3)
 155 #define RC5_TOGGLE(x)   (((x) >> 11) & 1)
 156 #define RC5_ADDR(x)     (((x) >> 6) & 31)
 157 #define RC5_INSTR(x)    ((x) & 63)
 158
 159 /* decode raw bit pattern to RC5 code */
 160 static u32 bttv_rc5_decode(unsigned int code)
 161 {
 162         unsigned int org_code = code;
 163         unsigned int pair;
 164         unsigned int rc5 = 0;
 165         int i;
 166
 167         for (i = 0; i < 14; ++i) {
 168                 pair = code & 0x3;
 169                 code >>= 2;
 170
 171                 rc5 <<= 1;
 172                 switch (pair) {
 173                 case 0:
 174                 case 2:
 175                         break;
 176                 case 1:
 177                         rc5 |= 1;
 178                 break;
 179                 case 3:
 180                         dprintk(KERN_INFO DEVNAME ":rc5_decode(%x) bad code\n",
 181                                 org_code);
 182                         return 0;
 183                 }
 184         }
 185         dprintk(KERN_INFO DEVNAME ":"
 186                 "code=%x, rc5=%x, start=%x, toggle=%x, address=%x, "
 187                 "instr=%x\n", rc5, org_code, RC5_START(rc5),
 188                 RC5_TOGGLE(rc5), RC5_ADDR(rc5), RC5_INSTR(rc5));
 189         return rc5;
 190 }
 191
 192 static void bttv_rc5_timer_end(unsigned long data)
 193 {
 194         struct bttv_ir *ir = (struct bttv_ir *)data;
 195         struct timeval tv;
 196         unsigned long current_jiffies;
 197         u32 gap;
 198         u32 rc5 = 0;
 199
 200         /* get time */
 201         current_jiffies = jiffies;
 202         do_gettimeofday(&tv);
 203
 204         /* avoid overflow with gap >1s */
 205         if (tv.tv_sec - ir->base_time.tv_sec > 1) {
 206                 gap = 200000;
 207         } else {
 208                 gap = 1000000 * (tv.tv_sec - ir->base_time.tv_sec) +
 209                     tv.tv_usec - ir->base_time.tv_usec;
 210         }
 211
 212         /* signal we're ready to start a new code */
 213         ir->active = false;
 214
 215         /* Allow some timer jitter (RC5 is ~24ms anyway so this is ok) */
 216         if (gap < 28000) {
 217                 dprintk(KERN_INFO DEVNAME ": spurious timer_end\n");
 218                 return;
 219         }
 220
 221         if (ir->last_bit < 20) {
 222                 /* ignore spurious codes (caused by light/other remotes) */
 223                 dprintk(KERN_INFO DEVNAME ": short code: %x\n", ir->code);
 224         } else {
 225                 ir->code = (ir->code << ir->shift_by) | 1;
 226                 rc5 = bttv_rc5_decode(ir->code);
 227
 228                 /* two start bits? */
 229                 if (RC5_START(rc5) != ir->start) {
 230                         printk(KERN_INFO DEVNAME ":"
 231                                " rc5 start bits invalid: %u\n", RC5_START(rc5));
 232
 233                         /* right address? */
 234                 } else if (RC5_ADDR(rc5) == ir->addr) {
 235                         u32 toggle = RC5_TOGGLE(rc5);
 236                         u32 instr = RC5_INSTR(rc5);
 237
 238                         /* Good code */
 239                         rc_keydown(ir->dev, instr, toggle);
 240                         dprintk(KERN_INFO DEVNAME ":"
 241                                 " instruction %x, toggle %x\n",
 242                                 instr, toggle);
 243                 }
 244         }
 245 }
 246
 247 static int bttv_rc5_irq(struct bttv *btv)
 248 {
 249         struct bttv_ir *ir = btv->remote;
 250         struct timeval tv;
 251         u32 gpio;
 252         u32 gap;
 253         unsigned long current_jiffies;
 254
 255         /* read gpio port */
 256         gpio = bttv_gpio_read(&btv->c);
 257
 258         /* get time of bit */
 259         current_jiffies = jiffies;
 260         do_gettimeofday(&tv);
 261
 262         /* avoid overflow with gap >1s */
 263         if (tv.tv_sec - ir->base_time.tv_sec > 1) {
 264                 gap = 200000;
 265         } else {
 266                 gap = 1000000 * (tv.tv_sec - ir->base_time.tv_sec) +
 267                     tv.tv_usec - ir->base_time.tv_usec;
 268         }
 269
 270         dprintk(KERN_INFO DEVNAME ": RC5 IRQ: gap %d us for %s\n",
 271                 gap, (gpio & 0x20) ? "mark" : "space");
 272
 273         /* remote IRQ? */
 274         if (!(gpio & 0x20))
 275                 return 0;
 276
 277         /* active code => add bit */
 278         if (ir->active) {
 279                 /* only if in the code (otherwise spurious IRQ or timer
 280                    late) */
 281                 if (ir->last_bit < 28) {
 282                         ir->last_bit = (gap - ir_rc5_remote_gap / 2) /
 283                             ir_rc5_remote_gap;
 284                         ir->code |= 1 << ir->last_bit;
 285                 }
 286                 /* starting new code */
 287         } else {
 288                 ir->active = true;
 289                 ir->code = 0;
 290                 ir->base_time = tv;
 291                 ir->last_bit = 0;
 292
 293                 mod_timer(&ir->timer, current_jiffies + msecs_to_jiffies(30));
 294         }
 295
 296         /* toggle GPIO pin 4 to reset the irq */
 297         bttv_gpio_write(&btv->c, gpio & ~(1 << 4));
 298         bttv_gpio_write(&btv->c, gpio | (1 << 4));
 299         return 1;
 300 }
 301
 302 /* ---------------------------------------------------------------------- */
 303
 304 static void bttv_ir_start(struct bttv *btv, struct bttv_ir *ir)
 305 {
 306         if (ir->polling) {
 307                 setup_timer(&ir->timer, bttv_input_timer, (unsigned long)btv);
 308                 ir->timer.expires  = jiffies + msecs_to_jiffies(1000);
 309                 add_timer(&ir->timer);
 310         } else if (ir->rc5_gpio) {
 311                 /* set timer_end for code completion */
 312                 setup_timer(&ir->timer, bttv_rc5_timer_end, (unsigned long)ir);
 313                 ir->shift_by = 1;
 314                 ir->start = 3;
 315                 ir->addr = 0x0;
 316                 ir->rc5_remote_gap = ir_rc5_remote_gap;
 317         }
 318 }
 319
 320 static void bttv_ir_stop(struct bttv *btv)
 321 {
 322         if (btv->remote->polling)
 323                 del_timer_sync(&btv->remote->timer);
 324
 325         if (btv->remote->rc5_gpio) {
 326                 u32 gpio;
 327
 328                 del_timer_sync(&btv->remote->timer);
 329
 330                 gpio = bttv_gpio_read(&btv->c);
 331                 bttv_gpio_write(&btv->c, gpio & ~(1 << 4));
 332         }
 333 }
 334
 335 /*
 336  * Get_key functions used by I2C remotes
 337  */
 338
 339 static int get_key_pv951(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 340 {
 341         unsigned char b;
 342
 343         /* poll IR chip */
 344         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 345                 dprintk(KERN_INFO DEVNAME ": read error\n");
 346                 return -EIO;
 347         }
 348
 349         /* ignore 0xaa */
 350         if (b==0xaa)
 351                 return 0;
 352         dprintk(KERN_INFO DEVNAME ": key %02x\n", b);
 353
 354         /*
 355          * NOTE:
 356          * lirc_i2c maps the pv951 code as:
 357          *      addr = 0x61D6
 358          *      cmd = bit_reverse (b)
 359          * So, it seems that this device uses NEC extended
 360          * I decided to not fix the table, due to two reasons:
 361          *      1) Without the actual device, this is only a guess;
 362          *      2) As the addr is not reported via I2C, nor can be changed,
 363          *         the device is bound to the vendor-provided RC.
 364          */
 365
 366         *ir_key = b;
 367         *ir_raw = b;
 368         return 1;
 369 }
 370
 371 /* Instantiate the I2C IR receiver device, if present */
 372 void __devinit init_bttv_i2c_ir(struct bttv *btv)
 373 {
 374         const unsigned short addr_list[] = {
 375                 0x1a, 0x18, 0x64, 0x30, 0x71,
 376                 I2C_CLIENT_END
 377         };
 378         struct i2c_board_info info;
 379
 380         if (0 != btv->i2c_rc)
 381                 return;
 382
 383         memset(&info, 0, sizeof(struct i2c_board_info));
 384         memset(&btv->init_data, 0, sizeof(btv->init_data));
 385         strlcpy(info.type, "ir_video", I2C_NAME_SIZE);
 386
 387         switch (btv->c.type) {
 388         case BTTV_BOARD_PV951:
 389                 btv->init_data.name = "PV951";
 390                 btv->init_data.get_key = get_key_pv951;
 391                 btv->init_data.ir_codes = RC_MAP_PV951;
 392                 info.addr = 0x4b;
 393                 break;
 394         default:
 395                 /*
 396                  * The external IR receiver is at i2c address 0x34 (0x35 for
 397                  * reads).  Future Hauppauge cards will have an internal
 398                  * receiver at 0x30 (0x31 for reads).  In theory, both can be
 399                  * fitted, and Hauppauge suggest an external overrides an
 400                  * internal.
 401                  * That's why we probe 0x1a (~0x34) first. CB
 402                  */
 403
 404                 i2c_new_probed_device(&btv->c.i2c_adap, &info, addr_list, NULL);
 405                 return;
 406         }
 407
 408         if (btv->init_data.name)
 409                 info.platform_data = &btv->init_data;
 410         i2c_new_device(&btv->c.i2c_adap, &info);
 411
 412         return;
 413 }
 414
 415 int __devexit fini_bttv_i2c(struct bttv *btv)
 416 {
 417         if (0 != btv->i2c_rc)
 418                 return 0;
 419
 420         return i2c_del_adapter(&btv->c.i2c_adap);
 421 }
 422
 423 int bttv_input_init(struct bttv *btv)
 424 {
 425         struct bttv_ir *ir;
 426         char *ir_codes = NULL;
 427         struct rc_dev *rc;
 428         int err = -ENOMEM;
 429
 430         if (!btv->has_remote)
 431                 return -ENODEV;
 432
 433         ir = kzalloc(sizeof(*ir),GFP_KERNEL);
 434         rc = rc_allocate_device();
 435         if (!ir || !rc)
 436                 goto err_out_free;
 437
 438         /* detect & configure */
 439         switch (btv->c.type) {
 440         case BTTV_BOARD_AVERMEDIA:
 441         case BTTV_BOARD_AVPHONE98:
 442         case BTTV_BOARD_AVERMEDIA98:
 443                 ir_codes         = RC_MAP_AVERMEDIA;
 444                 ir->mask_keycode = 0xf88000;
 445                 ir->mask_keydown = 0x010000;
 446                 ir->polling      = 50; // ms
 447                 break;
 448
 449         case BTTV_BOARD_AVDVBT_761:
 450         case BTTV_BOARD_AVDVBT_771:
 451                 ir_codes         = RC_MAP_AVERMEDIA_DVBT;
 452                 ir->mask_keycode = 0x0f00c0;
 453                 ir->mask_keydown = 0x000020;
 454                 ir->polling      = 50; // ms
 455                 break;
 456
 457         case BTTV_BOARD_PXELVWPLTVPAK:
 458                 ir_codes         = RC_MAP_PIXELVIEW;
 459                 ir->mask_keycode = 0x003e00;
 460                 ir->mask_keyup   = 0x010000;
 461                 ir->polling      = 50; // ms
 462                 break;
 463         case BTTV_BOARD_PV_M4900:
 464         case BTTV_BOARD_PV_BT878P_9B:
 465         case BTTV_BOARD_PV_BT878P_PLUS:
 466                 ir_codes         = RC_MAP_PIXELVIEW;
 467                 ir->mask_keycode = 0x001f00;
 468                 ir->mask_keyup   = 0x008000;
 469                 ir->polling      = 50; // ms
 470                 break;
 471
 472         case BTTV_BOARD_WINFAST2000:
 473                 ir_codes         = RC_MAP_WINFAST;
 474                 ir->mask_keycode = 0x1f8;
 475                 break;
 476         case BTTV_BOARD_MAGICTVIEW061:
 477         case BTTV_BOARD_MAGICTVIEW063:
 478                 ir_codes         = RC_MAP_WINFAST;
 479                 ir->mask_keycode = 0x0008e000;
 480                 ir->mask_keydown = 0x00200000;
 481                 break;
 482         case BTTV_BOARD_APAC_VIEWCOMP:
 483                 ir_codes         = RC_MAP_APAC_VIEWCOMP;
 484                 ir->mask_keycode = 0x001f00;
 485                 ir->mask_keyup   = 0x008000;
 486                 ir->polling      = 50; // ms
 487                 break;
 488         case BTTV_BOARD_ASKEY_CPH03X:
 489         case BTTV_BOARD_CONCEPTRONIC_CTVFMI2:
 490         case BTTV_BOARD_CONTVFMI:
 491                 ir_codes         = RC_MAP_PIXELVIEW;
 492                 ir->mask_keycode = 0x001F00;
 493                 ir->mask_keyup   = 0x006000;
 494                 ir->polling      = 50; // ms
 495                 break;
 496         case BTTV_BOARD_NEBULA_DIGITV:
 497                 ir_codes = RC_MAP_NEBULA;
 498                 ir->rc5_gpio = true;
 499                 break;
 500         case BTTV_BOARD_MACHTV_MAGICTV:
 501                 ir_codes         = RC_MAP_APAC_VIEWCOMP;
 502                 ir->mask_keycode = 0x001F00;
 503                 ir->mask_keyup   = 0x004000;
 504                 ir->polling      = 50; /* ms */
 505                 break;
 506         case BTTV_BOARD_KOZUMI_KTV_01C:
 507                 ir_codes         = RC_MAP_PCTV_SEDNA;
 508                 ir->mask_keycode = 0x001f00;
 509                 ir->mask_keyup   = 0x006000;
 510                 ir->polling      = 50; /* ms */
 511                 break;
 512         case BTTV_BOARD_ENLTV_FM_2:
 513                 ir_codes         = RC_MAP_ENCORE_ENLTV2;
 514                 ir->mask_keycode = 0x00fd00;
 515                 ir->mask_keyup   = 0x000080;
 516                 ir->polling      = 1; /* ms */
 517                 ir->last_gpio    = ir_extract_bits(bttv_gpio_read(&btv->c),
 518                                                    ir->mask_keycode);
 519                 break;
 520         }
 521         if (NULL == ir_codes) {
 522                 dprintk(KERN_INFO "Ooops: IR config error [card=%d]\n", btv->c.type);
 523                 err = -ENODEV;
 524                 goto err_out_free;
 525         }
 526
 527         if (ir->rc5_gpio) {
 528                 u32 gpio;
 529                 /* enable remote irq */
 530                 bttv_gpio_inout(&btv->c, (1 << 4), 1 << 4);
 531                 gpio = bttv_gpio_read(&btv->c);
 532                 bttv_gpio_write(&btv->c, gpio & ~(1 << 4));
 533                 bttv_gpio_write(&btv->c, gpio | (1 << 4));
 534         } else {
 535                 /* init hardware-specific stuff */
 536                 bttv_gpio_inout(&btv->c, ir->mask_keycode | ir->mask_keydown, 0);
 537         }
 538
 539         /* init input device */
 540         ir->dev = rc;
 541
 542         snprintf(ir->name, sizeof(ir->name), "bttv IR (card=%d)",
 543                  btv->c.type);
 544         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0",
 545                  pci_name(btv->c.pci));
 546
 547         rc->input_name = ir->name;
 548         rc->input_phys = ir->phys;
 549         rc->input_id.bustype = BUS_PCI;
 550         rc->input_id.version = 1;
 551         if (btv->c.pci->subsystem_vendor) {
 552                 rc->input_id.vendor  = btv->c.pci->subsystem_vendor;
 553                 rc->input_id.product = btv->c.pci->subsystem_device;
 554         } else {
 555                 rc->input_id.vendor  = btv->c.pci->vendor;
 556                 rc->input_id.product = btv->c.pci->device;
 557         }
 558         rc->dev.parent = &btv->c.pci->dev;
 559         rc->map_name = ir_codes;
 560         rc->driver_name = MODULE_NAME;
 561
 562         btv->remote = ir;
 563         bttv_ir_start(btv, ir);
 564
 565         /* all done */
 566         err = rc_register_device(rc);
 567         if (err)
 568                 goto err_out_stop;
 569
 570         return 0;
 571
 572  err_out_stop:
 573         bttv_ir_stop(btv);
 574         btv->remote = NULL;
 575  err_out_free:
 576         rc_free_device(rc);
 577         kfree(ir);
 578         return err;
 579 }
 580
 581 void bttv_input_fini(struct bttv *btv)
 582 {
 583         if (btv->remote == NULL)
 584                 return;
 585
 586         bttv_ir_stop(btv);
 587         rc_unregister_device(btv->remote->dev);
 588         kfree(btv->remote);
 589         btv->remote = NULL;
 590 }