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 static int repeat_delay = 500;
  35 module_param(repeat_delay, int, 0644);
  36 static int repeat_period = 33;
  37 module_param(repeat_period, int, 0644);
  38
  39 static int ir_rc5_remote_gap = 885;
  40 module_param(ir_rc5_remote_gap, int, 0644);
  41 static int ir_rc5_key_timeout = 200;
  42 module_param(ir_rc5_key_timeout, int, 0644);
  43
  44 #undef dprintk
  45 #define dprintk(arg...) do {    \
  46         if (ir_debug >= 1)      \
  47                 printk(arg);    \
  48 } while (0)
  49
  50 #define DEVNAME "bttv-input"
  51
  52 #define MODULE_NAME "bttv"
  53
  54 /* ---------------------------------------------------------------------- */
  55
  56 static void ir_handle_key(struct bttv *btv)
  57 {
  58         struct card_ir *ir = btv->remote;
  59         u32 gpio,data;
  60
  61         /* read gpio value */
  62         gpio = bttv_gpio_read(&btv->c);
  63         if (ir->polling) {
  64                 if (ir->last_gpio == gpio)
  65                         return;
  66                 ir->last_gpio = gpio;
  67         }
  68
  69         /* extract data */
  70         data = ir_extract_bits(gpio, ir->mask_keycode);
  71         dprintk(KERN_INFO DEVNAME ": irq gpio=0x%x code=%d | %s%s%s\n",
  72                 gpio, data,
  73                 ir->polling               ? "poll"  : "irq",
  74                 (gpio & ir->mask_keydown) ? " down" : "",
  75                 (gpio & ir->mask_keyup)   ? " up"   : "");
  76
  77         if ((ir->mask_keydown  &&  (0 != (gpio & ir->mask_keydown))) ||
  78             (ir->mask_keyup    &&  (0 == (gpio & ir->mask_keyup)))) {
  79                 ir_input_keydown(ir->dev, &ir->ir, data);
  80         } else {
  81                 /* HACK: Probably, ir->mask_keydown is missing
  82                    for this board */
  83                 if (btv->c.type == BTTV_BOARD_WINFAST2000)
  84                         ir_input_keydown(ir->dev, &ir->ir, data);
  85
  86                 ir_input_nokey(ir->dev,&ir->ir);
  87         }
  88
  89 }
  90
  91 static void ir_enltv_handle_key(struct bttv *btv)
  92 {
  93         struct card_ir *ir = btv->remote;
  94         u32 gpio, data, keyup;
  95
  96         /* read gpio value */
  97         gpio = bttv_gpio_read(&btv->c);
  98
  99         /* extract data */
 100         data = ir_extract_bits(gpio, ir->mask_keycode);
 101
 102         /* Check if it is keyup */
 103         keyup = (gpio & ir->mask_keyup) ? 1 << 31 : 0;
 104
 105         if ((ir->last_gpio & 0x7f) != data) {
 106                 dprintk(KERN_INFO DEVNAME ": gpio=0x%x code=%d | %s\n",
 107                         gpio, data,
 108                         (gpio & ir->mask_keyup) ? " up" : "up/down");
 109
 110                 ir_input_keydown(ir->dev, &ir->ir, data);
 111                 if (keyup)
 112                         ir_input_nokey(ir->dev, &ir->ir);
 113         } else {
 114                 if ((ir->last_gpio & 1 << 31) == keyup)
 115                         return;
 116
 117                 dprintk(KERN_INFO DEVNAME ":(cnt) gpio=0x%x code=%d | %s\n",
 118                         gpio, data,
 119                         (gpio & ir->mask_keyup) ? " up" : "down");
 120
 121                 if (keyup)
 122                         ir_input_nokey(ir->dev, &ir->ir);
 123                 else
 124                         ir_input_keydown(ir->dev, &ir->ir, data);
 125         }
 126
 127         ir->last_gpio = data | keyup;
 128 }
 129
 130 void bttv_input_irq(struct bttv *btv)
 131 {
 132         struct card_ir *ir = btv->remote;
 133
 134         if (!ir->polling)
 135                 ir_handle_key(btv);
 136 }
 137
 138 static void bttv_input_timer(unsigned long data)
 139 {
 140         struct bttv *btv = (struct bttv*)data;
 141         struct card_ir *ir = btv->remote;
 142
 143         if (btv->c.type == BTTV_BOARD_ENLTV_FM_2)
 144                 ir_enltv_handle_key(btv);
 145         else
 146                 ir_handle_key(btv);
 147         mod_timer(&ir->timer, jiffies + msecs_to_jiffies(ir->polling));
 148 }
 149
 150 /* ---------------------------------------------------------------*/
 151
 152 static int bttv_rc5_irq(struct bttv *btv)
 153 {
 154         struct card_ir *ir = btv->remote;
 155         struct timeval tv;
 156         u32 gpio;
 157         u32 gap;
 158         unsigned long current_jiffies;
 159
 160         /* read gpio port */
 161         gpio = bttv_gpio_read(&btv->c);
 162
 163         /* remote IRQ? */
 164         if (!(gpio & 0x20))
 165                 return 0;
 166
 167         /* get time of bit */
 168         current_jiffies = jiffies;
 169         do_gettimeofday(&tv);
 170
 171         /* avoid overflow with gap >1s */
 172         if (tv.tv_sec - ir->base_time.tv_sec > 1) {
 173                 gap = 200000;
 174         } else {
 175                 gap = 1000000 * (tv.tv_sec - ir->base_time.tv_sec) +
 176                     tv.tv_usec - ir->base_time.tv_usec;
 177         }
 178
 179         /* active code => add bit */
 180         if (ir->active) {
 181                 /* only if in the code (otherwise spurious IRQ or timer
 182                    late) */
 183                 if (ir->last_bit < 28) {
 184                         ir->last_bit = (gap - ir_rc5_remote_gap / 2) /
 185                             ir_rc5_remote_gap;
 186                         ir->code |= 1 << ir->last_bit;
 187                 }
 188                 /* starting new code */
 189         } else {
 190                 ir->active = 1;
 191                 ir->code = 0;
 192                 ir->base_time = tv;
 193                 ir->last_bit = 0;
 194
 195                 mod_timer(&ir->timer_end,
 196                           current_jiffies + msecs_to_jiffies(30));
 197         }
 198
 199         /* toggle GPIO pin 4 to reset the irq */
 200         bttv_gpio_write(&btv->c, gpio & ~(1 << 4));
 201         bttv_gpio_write(&btv->c, gpio | (1 << 4));
 202         return 1;
 203 }
 204
 205 /* ---------------------------------------------------------------------- */
 206
 207 static void bttv_ir_start(struct bttv *btv, struct card_ir *ir)
 208 {
 209         if (ir->polling) {
 210                 setup_timer(&ir->timer, bttv_input_timer, (unsigned long)btv);
 211                 ir->timer.expires  = jiffies + msecs_to_jiffies(1000);
 212                 add_timer(&ir->timer);
 213         } else if (ir->rc5_gpio) {
 214                 /* set timer_end for code completion */
 215                 init_timer(&ir->timer_end);
 216                 ir->timer_end.function = ir_rc5_timer_end;
 217                 ir->timer_end.data = (unsigned long)ir;
 218
 219                 init_timer(&ir->timer_keyup);
 220                 ir->timer_keyup.function = ir_rc5_timer_keyup;
 221                 ir->timer_keyup.data = (unsigned long)ir;
 222                 ir->shift_by = 1;
 223                 ir->start = 3;
 224                 ir->addr = 0x0;
 225                 ir->rc5_key_timeout = ir_rc5_key_timeout;
 226                 ir->rc5_remote_gap = ir_rc5_remote_gap;
 227         }
 228 }
 229
 230 static void bttv_ir_stop(struct bttv *btv)
 231 {
 232         if (btv->remote->polling) {
 233                 del_timer_sync(&btv->remote->timer);
 234                 flush_scheduled_work();
 235         }
 236
 237         if (btv->remote->rc5_gpio) {
 238                 u32 gpio;
 239
 240                 del_timer_sync(&btv->remote->timer_end);
 241                 flush_scheduled_work();
 242
 243                 gpio = bttv_gpio_read(&btv->c);
 244                 bttv_gpio_write(&btv->c, gpio & ~(1 << 4));
 245         }
 246 }
 247
 248 /*
 249  * Get_key functions used by I2C remotes
 250  */
 251
 252 static int get_key_pv951(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 253 {
 254         unsigned char b;
 255
 256         /* poll IR chip */
 257         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 258                 dprintk(KERN_INFO DEVNAME ": read error\n");
 259                 return -EIO;
 260         }
 261
 262         /* ignore 0xaa */
 263         if (b==0xaa)
 264                 return 0;
 265         dprintk(KERN_INFO DEVNAME ": key %02x\n", b);
 266
 267         *ir_key = b;
 268         *ir_raw = b;
 269         return 1;
 270 }
 271
 272 /* Instantiate the I2C IR receiver device, if present */
 273 void __devinit init_bttv_i2c_ir(struct bttv *btv)
 274 {
 275         const unsigned short addr_list[] = {
 276                 0x1a, 0x18, 0x64, 0x30, 0x71,
 277                 I2C_CLIENT_END
 278         };
 279         struct i2c_board_info info;
 280
 281         if (0 != btv->i2c_rc)
 282                 return;
 283
 284         memset(&info, 0, sizeof(struct i2c_board_info));
 285         memset(&btv->init_data, 0, sizeof(btv->init_data));
 286         strlcpy(info.type, "ir_video", I2C_NAME_SIZE);
 287
 288         switch (btv->c.type) {
 289         case BTTV_BOARD_PV951:
 290                 btv->init_data.name = "PV951";
 291                 btv->init_data.get_key = get_key_pv951;
 292                 btv->init_data.ir_codes = RC_MAP_PV951;
 293                 btv->init_data.type = IR_TYPE_OTHER;
 294                 info.addr = 0x4b;
 295                 break;
 296         default:
 297                 /*
 298                  * The external IR receiver is at i2c address 0x34 (0x35 for
 299                  * reads).  Future Hauppauge cards will have an internal
 300                  * receiver at 0x30 (0x31 for reads).  In theory, both can be
 301                  * fitted, and Hauppauge suggest an external overrides an
 302                  * internal.
 303                  * That's why we probe 0x1a (~0x34) first. CB
 304                  */
 305
 306                 i2c_new_probed_device(&btv->c.i2c_adap, &info, addr_list, NULL);
 307                 return;
 308         }
 309
 310         if (btv->init_data.name)
 311                 info.platform_data = &btv->init_data;
 312         i2c_new_device(&btv->c.i2c_adap, &info);
 313
 314         return;
 315 }
 316
 317 int __devexit fini_bttv_i2c(struct bttv *btv)
 318 {
 319         if (0 != btv->i2c_rc)
 320                 return 0;
 321
 322         return i2c_del_adapter(&btv->c.i2c_adap);
 323 }
 324
 325 int bttv_input_init(struct bttv *btv)
 326 {
 327         struct card_ir *ir;
 328         char *ir_codes = NULL;
 329         struct input_dev *input_dev;
 330         u64 ir_type = IR_TYPE_OTHER;
 331         int err = -ENOMEM;
 332
 333         if (!btv->has_remote)
 334                 return -ENODEV;
 335
 336         ir = kzalloc(sizeof(*ir),GFP_KERNEL);
 337         input_dev = input_allocate_device();
 338         if (!ir || !input_dev)
 339                 goto err_out_free;
 340
 341         /* detect & configure */
 342         switch (btv->c.type) {
 343         case BTTV_BOARD_AVERMEDIA:
 344         case BTTV_BOARD_AVPHONE98:
 345         case BTTV_BOARD_AVERMEDIA98:
 346                 ir_codes         = RC_MAP_AVERMEDIA;
 347                 ir->mask_keycode = 0xf88000;
 348                 ir->mask_keydown = 0x010000;
 349                 ir->polling      = 50; // ms
 350                 break;
 351
 352         case BTTV_BOARD_AVDVBT_761:
 353         case BTTV_BOARD_AVDVBT_771:
 354                 ir_codes         = RC_MAP_AVERMEDIA_DVBT;
 355                 ir->mask_keycode = 0x0f00c0;
 356                 ir->mask_keydown = 0x000020;
 357                 ir->polling      = 50; // ms
 358                 break;
 359
 360         case BTTV_BOARD_PXELVWPLTVPAK:
 361                 ir_codes         = RC_MAP_PIXELVIEW;
 362                 ir->mask_keycode = 0x003e00;
 363                 ir->mask_keyup   = 0x010000;
 364                 ir->polling      = 50; // ms
 365                 break;
 366         case BTTV_BOARD_PV_M4900:
 367         case BTTV_BOARD_PV_BT878P_9B:
 368         case BTTV_BOARD_PV_BT878P_PLUS:
 369                 ir_codes         = RC_MAP_PIXELVIEW;
 370                 ir->mask_keycode = 0x001f00;
 371                 ir->mask_keyup   = 0x008000;
 372                 ir->polling      = 50; // ms
 373                 break;
 374
 375         case BTTV_BOARD_WINFAST2000:
 376                 ir_codes         = RC_MAP_WINFAST;
 377                 ir->mask_keycode = 0x1f8;
 378                 break;
 379         case BTTV_BOARD_MAGICTVIEW061:
 380         case BTTV_BOARD_MAGICTVIEW063:
 381                 ir_codes         = RC_MAP_WINFAST;
 382                 ir->mask_keycode = 0x0008e000;
 383                 ir->mask_keydown = 0x00200000;
 384                 break;
 385         case BTTV_BOARD_APAC_VIEWCOMP:
 386                 ir_codes         = RC_MAP_APAC_VIEWCOMP;
 387                 ir->mask_keycode = 0x001f00;
 388                 ir->mask_keyup   = 0x008000;
 389                 ir->polling      = 50; // ms
 390                 break;
 391         case BTTV_BOARD_ASKEY_CPH03X:
 392         case BTTV_BOARD_CONCEPTRONIC_CTVFMI2:
 393         case BTTV_BOARD_CONTVFMI:
 394                 ir_codes         = RC_MAP_PIXELVIEW;
 395                 ir->mask_keycode = 0x001F00;
 396                 ir->mask_keyup   = 0x006000;
 397                 ir->polling      = 50; // ms
 398                 break;
 399         case BTTV_BOARD_NEBULA_DIGITV:
 400                 ir_codes = RC_MAP_NEBULA;
 401                 btv->custom_irq = bttv_rc5_irq;
 402                 ir->rc5_gpio = 1;
 403                 break;
 404         case BTTV_BOARD_MACHTV_MAGICTV:
 405                 ir_codes         = RC_MAP_APAC_VIEWCOMP;
 406                 ir->mask_keycode = 0x001F00;
 407                 ir->mask_keyup   = 0x004000;
 408                 ir->polling      = 50; /* ms */
 409                 break;
 410         case BTTV_BOARD_KOZUMI_KTV_01C:
 411                 ir_codes         = RC_MAP_PCTV_SEDNA;
 412                 ir->mask_keycode = 0x001f00;
 413                 ir->mask_keyup   = 0x006000;
 414                 ir->polling      = 50; /* ms */
 415                 break;
 416         case BTTV_BOARD_ENLTV_FM_2:
 417                 ir_codes         = RC_MAP_ENCORE_ENLTV2;
 418                 ir->mask_keycode = 0x00fd00;
 419                 ir->mask_keyup   = 0x000080;
 420                 ir->polling      = 1; /* ms */
 421                 ir->last_gpio    = ir_extract_bits(bttv_gpio_read(&btv->c),
 422                                                    ir->mask_keycode);
 423                 break;
 424         }
 425         if (NULL == ir_codes) {
 426                 dprintk(KERN_INFO "Ooops: IR config error [card=%d]\n", btv->c.type);
 427                 err = -ENODEV;
 428                 goto err_out_free;
 429         }
 430
 431         if (ir->rc5_gpio) {
 432                 u32 gpio;
 433                 /* enable remote irq */
 434                 bttv_gpio_inout(&btv->c, (1 << 4), 1 << 4);
 435                 gpio = bttv_gpio_read(&btv->c);
 436                 bttv_gpio_write(&btv->c, gpio & ~(1 << 4));
 437                 bttv_gpio_write(&btv->c, gpio | (1 << 4));
 438         } else {
 439                 /* init hardware-specific stuff */
 440                 bttv_gpio_inout(&btv->c, ir->mask_keycode | ir->mask_keydown, 0);
 441         }
 442
 443         /* init input device */
 444         ir->dev = input_dev;
 445
 446         snprintf(ir->name, sizeof(ir->name), "bttv IR (card=%d)",
 447                  btv->c.type);
 448         snprintf(ir->phys, sizeof(ir->phys), "pci-%s/ir0",
 449                  pci_name(btv->c.pci));
 450
 451         err = ir_input_init(input_dev, &ir->ir, ir_type);
 452         if (err < 0)
 453                 goto err_out_free;
 454
 455         input_dev->name = ir->name;
 456         input_dev->phys = ir->phys;
 457         input_dev->id.bustype = BUS_PCI;
 458         input_dev->id.version = 1;
 459         if (btv->c.pci->subsystem_vendor) {
 460                 input_dev->id.vendor  = btv->c.pci->subsystem_vendor;
 461                 input_dev->id.product = btv->c.pci->subsystem_device;
 462         } else {
 463                 input_dev->id.vendor  = btv->c.pci->vendor;
 464                 input_dev->id.product = btv->c.pci->device;
 465         }
 466         input_dev->dev.parent = &btv->c.pci->dev;
 467
 468         btv->remote = ir;
 469         bttv_ir_start(btv, ir);
 470
 471         /* all done */
 472         err = ir_input_register(btv->remote->dev, ir_codes, NULL, MODULE_NAME);
 473         if (err)
 474                 goto err_out_stop;
 475
 476         /* the remote isn't as bouncy as a keyboard */
 477         ir->dev->rep[REP_DELAY] = repeat_delay;
 478         ir->dev->rep[REP_PERIOD] = repeat_period;
 479
 480         return 0;
 481
 482  err_out_stop:
 483         bttv_ir_stop(btv);
 484         btv->remote = NULL;
 485  err_out_free:
 486         kfree(ir);
 487         return err;
 488 }
 489
 490 void bttv_input_fini(struct bttv *btv)
 491 {
 492         if (btv->remote == NULL)
 493                 return;
 494
 495         bttv_ir_stop(btv);
 496         ir_input_unregister(btv->remote->dev);
 497         kfree(btv->remote);
 498         btv->remote = NULL;
 499 }