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         return get_key_haup_common (ir, ir_key, ir_raw, 6, 3);
 132 }
 133
 134 static int get_key_pixelview(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 135 {
 136         unsigned char b;
 137
 138         /* poll IR chip */
 139         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 140                 dprintk(1,"read error\n");
 141                 return -EIO;
 142         }
 143         *ir_key = b;
 144         *ir_raw = b;
 145         return 1;
 146 }
 147
 148 static int get_key_fusionhdtv(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 149 {
 150         unsigned char buf[4];
 151
 152         /* poll IR chip */
 153         if (4 != i2c_master_recv(ir->c, buf, 4)) {
 154                 dprintk(1,"read error\n");
 155                 return -EIO;
 156         }
 157
 158         if(buf[0] !=0 || buf[1] !=0 || buf[2] !=0 || buf[3] != 0)
 159                 dprintk(2, "%s: 0x%2x 0x%2x 0x%2x 0x%2x\n", __func__,
 160                         buf[0], buf[1], buf[2], buf[3]);
 161
 162         /* no key pressed or signal from other ir remote */
 163         if(buf[0] != 0x1 ||  buf[1] != 0xfe)
 164                 return 0;
 165
 166         *ir_key = buf[2];
 167         *ir_raw = (buf[2] << 8) | buf[3];
 168
 169         return 1;
 170 }
 171
 172 static int get_key_knc1(struct IR_i2c *ir, u32 *ir_key, u32 *ir_raw)
 173 {
 174         unsigned char b;
 175
 176         /* poll IR chip */
 177         if (1 != i2c_master_recv(ir->c, &b, 1)) {
 178                 dprintk(1,"read error\n");
 179                 return -EIO;
 180         }
 181
 182         /* it seems that 0xFE indicates that a button is still hold
 183            down, while 0xff indicates that no button is hold
 184            down. 0xfe sequences are sometimes interrupted by 0xFF */
 185
 186         dprintk(2,"key %02x\n", b);
 187
 188         if (b == 0xff)
 189                 return 0;
 190
 191         if (b == 0xfe)
 192                 /* keep old data */
 193                 return 1;
 194
 195         *ir_key = b;
 196         *ir_raw = b;
 197         return 1;
 198 }
 199
 200 static int get_key_avermedia_cardbus(struct IR_i2c *ir,
 201                                      u32 *ir_key, u32 *ir_raw)
 202 {
 203         unsigned char subaddr, key, keygroup;
 204         struct i2c_msg msg[] = { { .addr = ir->c->addr, .flags = 0,
 205                                    .buf = &subaddr, .len = 1},
 206                                  { .addr = ir->c->addr, .flags = I2C_M_RD,
 207                                   .buf = &key, .len = 1} };
 208         subaddr = 0x0d;
 209         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
 210                 dprintk(1, "read error\n");
 211                 return -EIO;
 212         }
 213
 214         if (key == 0xff)
 215                 return 0;
 216
 217         subaddr = 0x0b;
 218         msg[1].buf = &keygroup;
 219         if (2 != i2c_transfer(ir->c->adapter, msg, 2)) {
 220                 dprintk(1, "read error\n");
 221                 return -EIO;
 222         }
 223
 224         if (keygroup == 0xff)
 225                 return 0;
 226
 227         dprintk(1, "read key 0x%02x/0x%02x\n", key, keygroup);
 228         if (keygroup < 2 || keygroup > 3) {
 229                 /* Only a warning */
 230                 dprintk(1, "warning: invalid key group 0x%02x for key 0x%02x\n",
 231                                                                 keygroup, key);
 232         }
 233         key |= (keygroup & 1) << 6;
 234
 235         *ir_key = key;
 236         *ir_raw = key;
 237         return 1;
 238 }
 239
 240 /* ----------------------------------------------------------------------- */
 241
 242 static void ir_key_poll(struct IR_i2c *ir)
 243 {
 244         static u32 ir_key, ir_raw;
 245         int rc;
 246
 247         dprintk(3, "%s\n", __func__);
 248         rc = ir->get_key(ir, &ir_key, &ir_raw);
 249         if (rc < 0) {
 250                 dprintk(2,"error\n");
 251                 return;
 252         }
 253
 254         if (rc) {
 255                 dprintk(1, "%s: keycode = 0x%04x\n", __func__, ir_key);
 256                 rc_keydown(ir->rc, ir_key, 0);
 257         }
 258 }
 259
 260 static void ir_work(struct work_struct *work)
 261 {
 262         struct IR_i2c *ir = container_of(work, struct IR_i2c, work.work);
 263
 264         ir_key_poll(ir);
 265         schedule_delayed_work(&ir->work, msecs_to_jiffies(ir->polling_interval));
 266 }
 267
 268 /* ----------------------------------------------------------------------- */
 269
 270 static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id)
 271 {
 272         char *ir_codes = NULL;
 273         const char *name = NULL;
 274         u64 rc_type = RC_TYPE_UNKNOWN;
 275         struct IR_i2c *ir;
 276         struct rc_dev *rc = NULL;
 277         struct i2c_adapter *adap = client->adapter;
 278         unsigned short addr = client->addr;
 279         int err;
 280
 281         ir = kzalloc(sizeof(struct IR_i2c), GFP_KERNEL);
 282         if (!ir)
 283                 return -ENOMEM;
 284
 285         ir->c = client;
 286         ir->polling_interval = DEFAULT_POLLING_INTERVAL;
 287         i2c_set_clientdata(client, ir);
 288
 289         switch(addr) {
 290         case 0x64:
 291                 name        = "Pixelview";
 292                 ir->get_key = get_key_pixelview;
 293                 rc_type     = RC_TYPE_OTHER;
 294                 ir_codes    = RC_MAP_EMPTY;
 295                 break;
 296         case 0x18:
 297         case 0x1f:
 298         case 0x1a:
 299                 name        = "Hauppauge";
 300                 ir->get_key = get_key_haup;
 301                 rc_type     = RC_TYPE_RC5;
 302                 if (hauppauge == 1) {
 303                         ir_codes    = RC_MAP_HAUPPAUGE_NEW;
 304                 } else {
 305                         ir_codes    = RC_MAP_RC5_TV;
 306                 }
 307                 break;
 308         case 0x30:
 309                 name        = "KNC One";
 310                 ir->get_key = get_key_knc1;
 311                 rc_type     = RC_TYPE_OTHER;
 312                 ir_codes    = RC_MAP_EMPTY;
 313                 break;
 314         case 0x6b:
 315                 name        = "FusionHDTV";
 316                 ir->get_key = get_key_fusionhdtv;
 317                 rc_type     = RC_TYPE_RC5;
 318                 ir_codes    = RC_MAP_FUSIONHDTV_MCE;
 319                 break;
 320         case 0x40:
 321                 name        = "AVerMedia Cardbus remote";
 322                 ir->get_key = get_key_avermedia_cardbus;
 323                 rc_type     = RC_TYPE_OTHER;
 324                 ir_codes    = RC_MAP_AVERMEDIA_CARDBUS;
 325                 break;
 326         case 0x71:
 327                 name        = "Hauppauge/Zilog Z8";
 328                 ir->get_key = get_key_haup_xvr;
 329                 rc_type     = RC_TYPE_RC5;
 330                 ir_codes    = hauppauge ? RC_MAP_HAUPPAUGE_NEW : RC_MAP_RC5_TV;
 331                 break;
 332         }
 333
 334         /* Let the caller override settings */
 335         if (client->dev.platform_data) {
 336                 const struct IR_i2c_init_data *init_data =
 337                                                 client->dev.platform_data;
 338
 339                 ir_codes = init_data->ir_codes;
 340                 rc = init_data->rc_dev;
 341
 342                 name = init_data->name;
 343                 if (init_data->type)
 344                         rc_type = init_data->type;
 345
 346                 if (init_data->polling_interval)
 347                         ir->polling_interval = init_data->polling_interval;
 348
 349                 switch (init_data->internal_get_key_func) {
 350                 case IR_KBD_GET_KEY_CUSTOM:
 351                         /* The bridge driver provided us its own function */
 352                         ir->get_key = init_data->get_key;
 353                         break;
 354                 case IR_KBD_GET_KEY_PIXELVIEW:
 355                         ir->get_key = get_key_pixelview;
 356                         break;
 357                 case IR_KBD_GET_KEY_HAUP:
 358                         ir->get_key = get_key_haup;
 359                         break;
 360                 case IR_KBD_GET_KEY_KNC1:
 361                         ir->get_key = get_key_knc1;
 362                         break;
 363                 case IR_KBD_GET_KEY_FUSIONHDTV:
 364                         ir->get_key = get_key_fusionhdtv;
 365                         break;
 366                 case IR_KBD_GET_KEY_HAUP_XVR:
 367                         ir->get_key = get_key_haup_xvr;
 368                         break;
 369                 case IR_KBD_GET_KEY_AVERMEDIA_CARDBUS:
 370                         ir->get_key = get_key_avermedia_cardbus;
 371                         break;
 372                 }
 373         }
 374
 375         if (!rc) {
 376                 /*
 377                  * If platform_data doesn't specify rc_dev, initilize it
 378                  * internally
 379                  */
 380                 rc = rc_allocate_device();
 381                 if (!rc) {
 382                         err = -ENOMEM;
 383                         goto err_out_free;
 384                 }
 385         }
 386         ir->rc = rc;
 387
 388         /* Make sure we are all setup before going on */
 389         if (!name || !ir->get_key || !rc_type || !ir_codes) {
 390                 dprintk(1, ": Unsupported device at address 0x%02x\n",
 391                         addr);
 392                 err = -ENODEV;
 393                 goto err_out_free;
 394         }
 395
 396         /* Sets name */
 397         snprintf(ir->name, sizeof(ir->name), "i2c IR (%s)", name);
 398         ir->ir_codes = ir_codes;
 399
 400         snprintf(ir->phys, sizeof(ir->phys), "%s/%s/ir0",
 401                  dev_name(&adap->dev),
 402                  dev_name(&client->dev));
 403
 404         /*
 405          * Initialize input_dev fields
 406          * It doesn't make sense to allow overriding them via platform_data
 407          */
 408         rc->input_id.bustype = BUS_I2C;
 409         rc->input_phys       = ir->phys;
 410         rc->input_name       = ir->name;
 411
 412         /*
 413          * Initialize the other fields of rc_dev
 414          */
 415         rc->map_name       = ir->ir_codes;
 416         rc->allowed_protos = rc_type;
 417         if (!rc->driver_name)
 418                 rc->driver_name = MODULE_NAME;
 419
 420         err = rc_register_device(rc);
 421         if (err)
 422                 goto err_out_free;
 423
 424         printk(MODULE_NAME ": %s detected at %s [%s]\n",
 425                ir->name, ir->phys, adap->name);
 426
 427         /* start polling via eventd */
 428         INIT_DELAYED_WORK(&ir->work, ir_work);
 429         schedule_delayed_work(&ir->work, 0);
 430
 431         return 0;
 432
 433  err_out_free:
 434         /* Only frees rc if it were allocated internally */
 435         rc_free_device(rc);
 436         kfree(ir);
 437         return err;
 438 }
 439
 440 static int ir_remove(struct i2c_client *client)
 441 {
 442         struct IR_i2c *ir = i2c_get_clientdata(client);
 443
 444         /* kill outstanding polls */
 445         cancel_delayed_work_sync(&ir->work);
 446
 447         /* unregister device */
 448         rc_unregister_device(ir->rc);
 449
 450         /* free memory */
 451         kfree(ir);
 452         return 0;
 453 }
 454
 455 static const struct i2c_device_id ir_kbd_id[] = {
 456         /* Generic entry for any IR receiver */
 457         { "ir_video", 0 },
 458         /* IR device specific entries should be added here */
 459         { "ir_rx_z8f0811_haup", 0 },
 460         { "ir_rx_z8f0811_hdpvr", 0 },
 461         { }
 462 };
 463
 464 static struct i2c_driver driver = {
 465         .driver = {
 466                 .name   = "ir-kbd-i2c",
 467         },
 468         .probe          = ir_probe,
 469         .remove         = ir_remove,
 470         .id_table       = ir_kbd_id,
 471 };
 472
 473 /* ----------------------------------------------------------------------- */
 474
 475 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller");
 476 MODULE_DESCRIPTION("input driver for i2c IR remote controls");
 477 MODULE_LICENSE("GPL");
 478
 479 static int __init ir_init(void)
 480 {
 481         return i2c_add_driver(&driver);
 482 }
 483
 484 static void __exit ir_fini(void)
 485 {
 486         i2c_del_driver(&driver);
 487 }
 488
 489 module_init(ir_init);
 490 module_exit(ir_fini);
 491
 492 /*
 493  * Overrides for Emacs so that we follow Linus's tabbing style.
 494  * ---------------------------------------------------------------------------
 495  * Local variables:
 496  * c-basic-offset: 8
 497  * End:
 498  */