drivers/media/video/ir-kbd-i2c.c

   1 /*
   2  *
   3  * keyboard input driver for i2c IR remote controls
   4  *
   5  * Copyright (c) 2000-2003 Gerd Knorr <kraxel@bytesex.org>
   6  * modified for PixelView (BT878P+W/FM) by
   7  *      Michal Kochanowicz <mkochano@pld.org.pl>
   8  *      Christoph Bartelmus <lirc@bartelmus.de>
   9  * modified for KNC ONE TV Station/Anubis Typhoon TView Tuner by
  10  *      Ulrich Mueller <ulrich.mueller42@web.de>
  11  * modified for em2820 based USB TV tuners by
  12  *      Markus Rechberger <mrechberger@gmail.com>
  13  * modified for DViCO Fusion HDTV 5 RT GOLD by
  14  *      Chaogui Zhang <czhang1974@gmail.com>
  15  * modified for MSI TV@nywhere Plus by
  16  *      Henry Wong <henry@stuffedcow.net>
  17  *      Mark Schultz <n9xmj@yahoo.com>
  18  *      Brian Rogers <brian_rogers@comcast.net>
  19  * modified for AVerMedia Cardbus by
  20  *      Oldrich Jedlicka <oldium.pro@seznam.cz>
  21  *
  22  *  This program is free software; you can redistribute it and/or modify
  23  *  it under the terms of the GNU General Public License as published by
  24  *  the Free Software Foundation; either version 2 of the License, or
  25  *  (at your option) any later version.
  26  *
  27  *  This program is distributed in the hope that it will be useful,
  28  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  29  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  30  *  GNU General Public License for more details.
  31  *
  32  *  You should have received a copy of the GNU General Public License
  33  *  along with this program; if not, write to the Free Software
  34  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  35  *
  36  */
  37
  38 #include <linux/module.h>
  39 #include <linux/init.h>
  40 #include <linux/kernel.h>
  41 #include <linux/string.h>
  42 #include <linux/timer.h>
  43 #include <linux/delay.h>
  44 #include <linux/errno.h>
  45 #include <linux/slab.h>
  46 #include <linux/i2c.h>
  47 #include <linux/workqueue.h>
  48
  49 #include <media/rc-core.h>
  50 #include <media/ir-kbd-i2c.h>
  51
  52 /* ----------------------------------------------------------------------- */
  53 /* insmod parameters                                                       */
  54
  55 static int debug;
  56 module_param(debug, int, 0644);    /* debug level (0,1,2) */
  57
  58 static int hauppauge;
  59 module_param(hauppauge, int, 0644);    /* Choose Hauppauge remote */
  60 MODULE_PARM_DESC(hauppauge, "Specify Hauppauge remote: 0=black, 1=grey (defaults to 0)");
  61
  62
  63 #define MODULE_NAME "ir-kbd-i2c"
  64 #define dprintk(level, fmt, arg...)     if (debug >= level) \
  65         printk(KERN_DEBUG MODULE_NAME ": " fmt , ## arg)
  66
  67 /* ----------------------------------------------------------------------- */
  68
  69 static int get_key_haup_common(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw,
  70                                int size, int offset)
  71 {
  72         unsigned char buf[6];
  73         int start, range, toggle, dev, code, ircode;
  74
  75         /* poll IR chip */
  76         if (size != i2c_master_recv(ir->c, buf, size))
  77                 return -EIO;
  78
  79         /* split rc5 data block ... */
  80         start  = (buf[offset] >> 7) &    1;
  81         range  = (buf[offset] >> 6) &    1;
  82         toggle = (buf[offset] >> 5) &    1;
  83         dev    =  buf[offset]       & 0x1f;
  84         code   = (buf[offset+1] >> 2) & 0x3f;
  85
  86         /* rc5 has two start bits
  87          * the first bit must be one
  88          * the second bit defines the command range (1 = 0-63, 0 = 64 - 127)
  89          */
  90         if (!start)
  91                 /* no key pressed */
  92                 return 0;
  93         /*
  94          * Hauppauge remotes (black/silver) always use
  95          * specific device ids. If we do not filter the
  96          * device ids then messages destined for devices
  97          * such as TVs (id=0) will get through causing
  98          * mis-fired events.
  99          *
 100          * We also filter out invalid key presses which
 101          * produce annoying debug log entries.
 102          */
 103         ircode= (start << 12) | (toggle << 11) | (dev << 6) | code;
 104         if ((ircode & 0x1fff)==0x1fff)
 105                 /* invalid key press */
 106                 return 0;
 107
 108         if (dev!=0x1e && dev!=0x1f)
 109                 /* not a hauppauge remote */
 110                 return 0;
 111
 112         if (!range)
 113                 code += 64;
 114
 115         dprintk(1,"ir hauppauge (rc5): s%d r%d t%d dev=%d code=%d\n",
 116                 start, range, toggle, dev, code);
 117
 118         /* return key */
 119         *ir_key = code;
 120         *ir_raw = ircode;
 121         return 1;
 122 }
 123
 124 static int get_key_haup(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 125 {
 126         return get_key_haup_common (ir, ir_key, ir_raw, 3, 0);
 127 }
 128
 129 static int get_key_haup_xvr(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 130 {
 131         int ret;
 132         unsigned char buf[1] = { 0 };
 133
 134         /*
 135          * This is the same apparent "are you ready?" poll command observed
 136          * watching Windows driver traffic and implemented in lirc_zilog. With
 137          * this added, we get far saner remote behavior with z8 chips on usb
 138          * connected devices, even with the default polling interval of 100ms.
 139          */
 140         ret = i2c_master_send(ir->c, buf, 1);
 141         if (ret != 1)
 142                 return (ret < 0) ? ret : -EINVAL;
 143
 144         return get_key_haup_common (ir, ir_key, ir_raw, 6, 3);
 145 }
 146
 147 static int get_key_pixelview(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 148 {
 149         unsigned char b;
 150
 151         /* poll IR chip */
 152         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 153                 dprintk(1,"read error\n");
 154                 return -EIO;
 155         }
 156         *ir_key = b;
 157         *ir_raw = b;
 158         return 1;
 159 }
 160
 161 static int get_key_fusionhdtv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 162 {
 163         unsigned char buf[4];
 164
 165         /* poll IR chip */
 166         if (4 != i2c_master_recv(ir->c, buf, 4)) {
 167                 dprintk(1,"read error\n");
 168                 return -EIO;
 169         }
 170
 171         if(buf[0] !=0 || buf[1] !=0 || buf[2] !=0 || buf[3] != 0)
 172                 dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__,
 173                         buf[0], buf[1], buf[2], buf[3]);
 174
 175         /* no key pressed or signal from other ir remote */
 176         if(buf[0] != 0x1 ||  buf[1] != 0xfe)
 177                 return 0;
 178
 179         *ir_key = buf[2];
 180         *ir_raw = (buf[2] << 8) | buf[3];
 181
 182         return 1;
 183 }
 184
 185 static int get_key_knc1(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 186 {
 187         unsigned char b;
 188
 189         /* poll IR chip */
 190         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 191                 dprintk(1,"read error\n");
 192                 return -EIO;
 193         }
 194
 195         /* it seems that 0xFE indicates that a button is still hold
 196            down, while 0xff indicates that no button is hold
 197            down. 0xfe sequences are sometimes interrupted by 0xFF */
 198
 199         dprintk(2,"key %02x\n", b);
 200
 201         if (b == 0xff)
 202                 return 0;
 203
 204         if (b == 0xfe)
 205                 /* keep old data */
 206                 return 1;
 207
 208         *ir_key = b;
 209         *ir_raw = b;
 210         return 1;
 211 }
 212
 213 static int get_key_avermedia_cardbus(struct IR_i2c *ir,
 214                                      u32 *ir_key, u32 *ir_raw)
 215 {
 216         unsigned char subaddr, key, keygroup;
 217         struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0,
 218                                    .buf = &subaddr, .len = 1},
 219                                  { .addr = ir->c->addr, .flags = I2C_M_RD,
 220                                   .buf = &key, .len = 1} };
 221         subaddr = 0x0d;
 222         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
 223                 dprintk(1, "read error\n");
 224                 return -EIO;
 225         }
 226
 227         if (key == 0xff)
 228                 return 0;
 229
 230         subaddr = 0x0b;
 231         msg[1].buf = &keygroup;
 232         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
 233                 dprintk(1, "read error\n");
 234                 return -EIO;
 235         }
 236
 237         if (keygroup == 0xff)
 238                 return 0;
 239
 240         dprintk(1, "read key 0x%02x/0x%02x\n", key, keygroup);
 241         if (keygroup < 2 || keygroup > 3) {
 242                 /* Only a warning */
 243                 dprintk(1, "warning: invalid key group 0x%02x for key 0x%02x\n",
 244                                                                 keygroup, key);
 245         }
 246         key |= (keygroup & 1) << 6;
 247
 248         *ir_key = key;
 249         *ir_raw = key;
 250         return 1;
 251 }
 252
 253 /* ----------------------------------------------------------------------- */
 254
 255 static void ir_key_poll(struct IR_i2c *ir)
 256 {
 257         static u32 ir_key, ir_raw;
 258         int rc;
 259
 260         dprintk(3, "%s\n", __func__);
 261         rc = ir->get_key(ir, &ir_key, &ir_raw);
 262         if (rc < 0) {
 263                 dprintk(2,"error\n");
 264                 return;
 265         }
 266
 267         if (rc) {
 268                 dprintk(1, "%s: keycode = 0x%04x\n", __func__, ir_key);
 269                 rc_keydown(ir->rc, ir_key, 0);
 270         }
 271 }
 272
 273 static void ir_work(struct work_struct *work)
 274 {
 275         struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work);
 276
 277         ir_key_poll(ir);
 278         schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling_interval));
 279 }
 280
 281 /* ----------------------------------------------------------------------- */
 282
 283 static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id)
 284 {
 285         char *ir_codes = NULL;
 286         const char *name = NULL;
 287         u64 rc_type = RC_TYPE_UNKNOWN;
 288         struct IR_i2c *ir;
 289         struct rc_dev *rc = NULL;
 290         struct i2c_adapter *adap = client->adapter;
 291         unsigned short addr = client->addr;
 292         int err;
 293
 294         ir = kzalloc(sizeof(struct IR_i2c), GFP_KERNEL);
 295         if (!ir)
 296                 return -ENOMEM;
 297
 298         ir->c = client;
 299         ir->polling_interval = DEFAULT_POLLING_INTERVAL;
 300         i2c_set_clientdata(client, ir);
 301
 302         switch(addr) {
 303         case 0x64:
 304                 name        = "Pixelview";
 305                 ir->get_key = get_key_pixelview;
 306                 rc_type     = RC_TYPE_OTHER;
 307                 ir_codes    = RC_MAP_EMPTY;
 308                 break;
 309         case 0x18:
 310         case 0x1f:
 311         case 0x1a:
 312                 name        = "Hauppauge";
 313                 ir->get_key = get_key_haup;
 314                 rc_type     = RC_TYPE_RC5;
 315                 if (hauppauge == 1) {
 316                         ir_codes    = RC_MAP_HAUPPAUGE_NEW;
 317                 } else {
 318                         ir_codes    = RC_MAP_RC5_TV;
 319                 }
 320                 break;
 321         case 0x30:
 322                 name        = "KNC One";
 323                 ir->get_key = get_key_knc1;
 324                 rc_type     = RC_TYPE_OTHER;
 325                 ir_codes    = RC_MAP_EMPTY;
 326                 break;
 327         case 0x6b:
 328                 name        = "FusionHDTV";
 329                 ir->get_key = get_key_fusionhdtv;
 330                 rc_type     = RC_TYPE_RC5;
 331                 ir_codes    = RC_MAP_FUSIONHDTV_MCE;
 332                 break;
 333         case 0x40:
 334                 name        = "AVerMedia Cardbus remote";
 335                 ir->get_key = get_key_avermedia_cardbus;
 336                 rc_type     = RC_TYPE_OTHER;
 337                 ir_codes    = RC_MAP_AVERMEDIA_CARDBUS;
 338                 break;
 339         case 0x71:
 340                 name        = "Hauppauge/Zilog Z8";
 341                 ir->get_key = get_key_haup_xvr;
 342                 rc_type     = RC_TYPE_RC5;
 343                 ir_codes    = hauppauge ? RC_MAP_HAUPPAUGE_NEW : RC_MAP_RC5_TV;
 344                 break;
 345         }
 346
 347         /* Let the caller override settings */
 348         if (client->dev.platform_data) {
 349                 const struct IR_i2c_init_data *init_data =
 350                                                 client->dev.platform_data;
 351
 352                 ir_codes = init_data->ir_codes;
 353                 rc = init_data->rc_dev;
 354
 355                 name = init_data->name;
 356                 if (init_data->type)
 357                         rc_type = init_data->type;
 358
 359                 if (init_data->polling_interval)
 360                         ir->polling_interval = init_data->polling_interval;
 361
 362                 switch (init_data->internal_get_key_func) {
 363                 case IR_KBD_GET_KEY_CUSTOM:
 364                         /* The bridge driver provided us its own function */
 365                         ir->get_key = init_data->get_key;
 366                         break;
 367                 case IR_KBD_GET_KEY_PIXELVIEW:
 368                         ir->get_key = get_key_pixelview;
 369                         break;
 370                 case IR_KBD_GET_KEY_HAUP:
 371                         ir->get_key = get_key_haup;
 372                         break;
 373                 case IR_KBD_GET_KEY_KNC1:
 374                         ir->get_key = get_key_knc1;
 375                         break;
 376                 case IR_KBD_GET_KEY_FUSIONHDTV:
 377                         ir->get_key = get_key_fusionhdtv;
 378                         break;
 379                 case IR_KBD_GET_KEY_HAUP_XVR:
 380                         ir->get_key = get_key_haup_xvr;
 381                         break;
 382                 case IR_KBD_GET_KEY_AVERMEDIA_CARDBUS:
 383                         ir->get_key = get_key_avermedia_cardbus;
 384                         break;
 385                 }
 386         }
 387
 388         if (!rc) {
 389                 /*
 390                  * If platform_data doesn't specify rc_dev, initilize it
 391                  * internally
 392                  */
 393                 rc = rc_allocate_device();
 394                 if (!rc) {
 395                         err = -ENOMEM;
 396                         goto err_out_free;
 397                 }
 398         }
 399         ir->rc = rc;
 400
 401         /* Make sure we are all setup before going on */
 402         if (!name || !ir->get_key || !rc_type || !ir_codes) {
 403                 dprintk(1, ": Unsupported device at address 0x%02x\n",
 404                         addr);
 405                 err = -ENODEV;
 406                 goto err_out_free;
 407         }
 408
 409         /* Sets name */
 410         snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name);
 411         ir->ir_codes = ir_codes;
 412
 413         snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0",
 414                  dev_name(&adap->dev),
 415                  dev_name(&client->dev));
 416
 417         /*
 418          * Initialize input_dev fields
 419          * It doesn't make sense to allow overriding them via platform_data
 420          */
 421         rc->input_id.bustype = BUS_I2C;
 422         rc->input_phys       = ir->phys;
 423         rc->input_name       = ir->name;
 424
 425         /*
 426          * Initialize the other fields of rc_dev
 427          */
 428         rc->map_name       = ir->ir_codes;
 429         rc->allowed_protos = rc_type;
 430         if (!rc->driver_name)
 431                 rc->driver_name = MODULE_NAME;
 432
 433         err = rc_register_device(rc);
 434         if (err)
 435                 goto err_out_free;
 436
 437         printk(MODULE_NAME ": %s detected at %s [%s]\n",
 438                ir->name, ir->phys, adap->name);
 439
 440         /* start polling via eventd */
 441         INIT_DELAYED_WORK(&ir->work, ir_work);
 442         schedule_delayed_work(&ir->work, 0);
 443
 444         return 0;
 445
 446  err_out_free:
 447         /* Only frees rc if it were allocated internally */
 448         rc_free_device(rc);
 449         kfree(ir);
 450         return err;
 451 }
 452
 453 static int ir_remove(struct i2c_client *client)
 454 {
 455         struct IR_i2c *ir = i2c_get_clientdata(client);
 456
 457         /* kill outstanding polls */
 458         cancel_delayed_work_sync(&ir->work);
 459
 460         /* unregister device */
 461         rc_unregister_device(ir->rc);
 462
 463         /* free memory */
 464         kfree(ir);
 465         return 0;
 466 }
 467
 468 static const struct i2c_device_id ir_kbd_id[] = {
 469         /* Generic entry for any IR receiver */
 470         { "ir_video", 0 },
 471         /* IR device specific entries should be added here */
 472         { "ir_rx_z8f0811_haup", 0 },
 473         { "ir_rx_z8f0811_hdpvr", 0 },
 474         { }
 475 };
 476
 477 static struct i2c_driver driver = {
 478         .driver = {
 479                 .name   = "ir-kbd-i2c",
 480         },
 481         .probe          = ir_probe,
 482         .remove         = ir_remove,
 483         .id_table       = ir_kbd_id,
 484 };
 485
 486 /* ----------------------------------------------------------------------- */
 487
 488 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller");
 489 MODULE_DESCRIPTION("input driver for i2c IR remote controls");
 490 MODULE_LICENSE("GPL");
 491
 492 static int __init ir_init(void)
 493 {
 494         return i2c_add_driver(&driver);
 495 }
 496
 497 static void __exit ir_fini(void)
 498 {
 499         i2c_del_driver(&driver);
 500 }
 501
 502 module_init(ir_init);
 503 module_exit(ir_fini);
 504
 505 /*
 506  * Overrides for Emacs so that we follow Linus's tabbing style.
 507  * ---------------------------------------------------------------------------
 508  * Local variables:
 509  * c-basic-offset: 8
 510  * End:
 511  */