drivers/staging/media/lirc/lirc_zilog.c

   1 /*
   2  * i2c IR lirc driver for devices with zilog IR processors
   3  *
   4  * Copyright (c) 2000 Gerd Knorr <kraxel@goldbach.in-berlin.de>
   5  * modified for PixelView (BT878P+W/FM) by
   6  *      Michal Kochanowicz <mkochano@pld.org.pl>
   7  *      Christoph Bartelmus <lirc@bartelmus.de>
   8  * modified for KNC ONE TV Station/Anubis Typhoon TView Tuner by
   9  *      Ulrich Mueller <ulrich.mueller42@web.de>
  10  * modified for Asus TV-Box and Creative/VisionTek BreakOut-Box by
  11  *      Stefan Jahn <stefan@lkcc.org>
  12  * modified for inclusion into kernel sources by
  13  *      Jerome Brock <jbrock@users.sourceforge.net>
  14  * modified for Leadtek Winfast PVR2000 by
  15  *      Thomas Reitmayr (treitmayr@yahoo.com)
  16  * modified for Hauppauge PVR-150 IR TX device by
  17  *      Mark Weaver <mark@npsl.co.uk>
  18  * changed name from lirc_pvr150 to lirc_zilog, works on more than pvr-150
  19  *      Jarod Wilson <jarod@redhat.com>
  20  *
  21  * parts are cut&pasted from the lirc_i2c.c driver
  22  *
  23  * Numerous changes updating lirc_zilog.c in kernel 2.6.38 and later are
  24  * Copyright (C) 2011 Andy Walls <awalls@md.metrocast.net>
  25  *
  26  *  This program is free software; you can redistribute it and/or modify
  27  *  it under the terms of the GNU General Public License as published by
  28  *  the Free Software Foundation; either version 2 of the License, or
  29  *  (at your option) any later version.
  30  *
  31  *  This program is distributed in the hope that it will be useful,
  32  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  33  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  34  *  GNU General Public License for more details.
  35  *
  36  *  You should have received a copy of the GNU General Public License
  37  *  along with this program; if not, write to the Free Software
  38  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  39  *
  40  */
  41
  42 #include <linux/module.h>
  43 #include <linux/kmod.h>
  44 #include <linux/kernel.h>
  45 #include <linux/sched/signal.h>
  46 #include <linux/fs.h>
  47 #include <linux/poll.h>
  48 #include <linux/string.h>
  49 #include <linux/timer.h>
  50 #include <linux/delay.h>
  51 #include <linux/completion.h>
  52 #include <linux/errno.h>
  53 #include <linux/slab.h>
  54 #include <linux/i2c.h>
  55 #include <linux/firmware.h>
  56 #include <linux/vmalloc.h>
  57
  58 #include <linux/mutex.h>
  59 #include <linux/kthread.h>
  60
  61 #include <media/lirc_dev.h>
  62 #include <media/lirc.h>
  63
  64 /* Max transfer size done by I2C transfer functions */
  65 #define MAX_XFER_SIZE  64
  66
  67 struct IR;
  68
  69 struct IR_rx {
  70         struct kref ref;
  71         struct IR *ir;
  72
  73         /* RX device */
  74         struct mutex client_lock;
  75         struct i2c_client *c;
  76
  77         /* RX polling thread data */
  78         struct task_struct *task;
  79
  80         /* RX read data */
  81         unsigned char b[3];
  82         bool hdpvr_data_fmt;
  83 };
  84
  85 struct IR_tx {
  86         struct kref ref;
  87         struct IR *ir;
  88
  89         /* TX device */
  90         struct mutex client_lock;
  91         struct i2c_client *c;
  92
  93         /* TX additional actions needed */
  94         int need_boot;
  95         bool post_tx_ready_poll;
  96 };
  97
  98 struct IR {
  99         struct kref ref;
 100         struct list_head list;
 101
 102         /* FIXME spinlock access to l.features */
 103         struct lirc_driver l;
 104         struct lirc_buffer rbuf;
 105
 106         struct mutex ir_lock;
 107         atomic_t open_count;
 108
 109         struct i2c_adapter *adapter;
 110
 111         spinlock_t rx_ref_lock; /* struct IR_rx kref get()/put() */
 112         struct IR_rx *rx;
 113
 114         spinlock_t tx_ref_lock; /* struct IR_tx kref get()/put() */
 115         struct IR_tx *tx;
 116 };
 117
 118 /* IR transceiver instance object list */
 119 /*
 120  * This lock is used for the following:
 121  * a. ir_devices_list access, insertions, deletions
 122  * b. struct IR kref get()s and put()s
 123  * c. serialization of ir_probe() for the two i2c_clients for a Z8
 124  */
 125 static DEFINE_MUTEX(ir_devices_lock);
 126 static LIST_HEAD(ir_devices_list);
 127
 128 /* Block size for IR transmitter */
 129 #define TX_BLOCK_SIZE   99
 130
 131 /* Hauppauge IR transmitter data */
 132 struct tx_data_struct {
 133         /* Boot block */
 134         unsigned char *boot_data;
 135
 136         /* Start of binary data block */
 137         unsigned char *datap;
 138
 139         /* End of binary data block */
 140         unsigned char *endp;
 141
 142         /* Number of installed codesets */
 143         unsigned int num_code_sets;
 144
 145         /* Pointers to codesets */
 146         unsigned char **code_sets;
 147
 148         /* Global fixed data template */
 149         int fixed[TX_BLOCK_SIZE];
 150 };
 151
 152 static struct tx_data_struct *tx_data;
 153 static struct mutex tx_data_lock;
 154
 155
 156 /* module parameters */
 157 static bool debug;      /* debug output */
 158 static bool tx_only;    /* only handle the IR Tx function */
 159
 160
 161 /* struct IR reference counting */
 162 static struct IR *get_ir_device(struct IR *ir, bool ir_devices_lock_held)
 163 {
 164         if (ir_devices_lock_held) {
 165                 kref_get(&ir->ref);
 166         } else {
 167                 mutex_lock(&ir_devices_lock);
 168                 kref_get(&ir->ref);
 169                 mutex_unlock(&ir_devices_lock);
 170         }
 171         return ir;
 172 }
 173
 174 static void release_ir_device(struct kref *ref)
 175 {
 176         struct IR *ir = container_of(ref, struct IR, ref);
 177
 178         /*
 179          * Things should be in this state by now:
 180          * ir->rx set to NULL and deallocated - happens before ir->rx->ir put()
 181          * ir->rx->task kthread stopped - happens before ir->rx->ir put()
 182          * ir->tx set to NULL and deallocated - happens before ir->tx->ir put()
 183          * ir->open_count ==  0 - happens on final close()
 184          * ir_lock, tx_ref_lock, rx_ref_lock, all released
 185          */
 186         if (ir->l.minor >= 0) {
 187                 lirc_unregister_driver(ir->l.minor);
 188                 ir->l.minor = -1;
 189         }
 190
 191         if (kfifo_initialized(&ir->rbuf.fifo))
 192                 lirc_buffer_free(&ir->rbuf);
 193         list_del(&ir->list);
 194         kfree(ir);
 195 }
 196
 197 static int put_ir_device(struct IR *ir, bool ir_devices_lock_held)
 198 {
 199         int released;
 200
 201         if (ir_devices_lock_held)
 202                 return kref_put(&ir->ref, release_ir_device);
 203
 204         mutex_lock(&ir_devices_lock);
 205         released = kref_put(&ir->ref, release_ir_device);
 206         mutex_unlock(&ir_devices_lock);
 207
 208         return released;
 209 }
 210
 211 /* struct IR_rx reference counting */
 212 static struct IR_rx *get_ir_rx(struct IR *ir)
 213 {
 214         struct IR_rx *rx;
 215
 216         spin_lock(&ir->rx_ref_lock);
 217         rx = ir->rx;
 218         if (rx)
 219                 kref_get(&rx->ref);
 220         spin_unlock(&ir->rx_ref_lock);
 221         return rx;
 222 }
 223
 224 static void destroy_rx_kthread(struct IR_rx *rx, bool ir_devices_lock_held)
 225 {
 226         /* end up polling thread */
 227         if (!IS_ERR_OR_NULL(rx->task)) {
 228                 kthread_stop(rx->task);
 229                 rx->task = NULL;
 230                 /* Put the ir ptr that ir_probe() gave to the rx poll thread */
 231                 put_ir_device(rx->ir, ir_devices_lock_held);
 232         }
 233 }
 234
 235 static void release_ir_rx(struct kref *ref)
 236 {
 237         struct IR_rx *rx = container_of(ref, struct IR_rx, ref);
 238         struct IR *ir = rx->ir;
 239
 240         /*
 241          * This release function can't do all the work, as we want
 242          * to keep the rx_ref_lock a spinlock, and killing the poll thread
 243          * and releasing the ir reference can cause a sleep.  That work is
 244          * performed by put_ir_rx()
 245          */
 246         ir->l.features &= ~LIRC_CAN_REC_LIRCCODE;
 247         /* Don't put_ir_device(rx->ir) here; lock can't be freed yet */
 248         ir->rx = NULL;
 249         /* Don't do the kfree(rx) here; we still need to kill the poll thread */
 250 }
 251
 252 static int put_ir_rx(struct IR_rx *rx, bool ir_devices_lock_held)
 253 {
 254         int released;
 255         struct IR *ir = rx->ir;
 256
 257         spin_lock(&ir->rx_ref_lock);
 258         released = kref_put(&rx->ref, release_ir_rx);
 259         spin_unlock(&ir->rx_ref_lock);
 260         /* Destroy the rx kthread while not holding the spinlock */
 261         if (released) {
 262                 destroy_rx_kthread(rx, ir_devices_lock_held);
 263                 kfree(rx);
 264                 /* Make sure we're not still in a poll_table somewhere */
 265                 wake_up_interruptible(&ir->rbuf.wait_poll);
 266         }
 267         /* Do a reference put() for the rx->ir reference, if we released rx */
 268         if (released)
 269                 put_ir_device(ir, ir_devices_lock_held);
 270         return released;
 271 }
 272
 273 /* struct IR_tx reference counting */
 274 static struct IR_tx *get_ir_tx(struct IR *ir)
 275 {
 276         struct IR_tx *tx;
 277
 278         spin_lock(&ir->tx_ref_lock);
 279         tx = ir->tx;
 280         if (tx)
 281                 kref_get(&tx->ref);
 282         spin_unlock(&ir->tx_ref_lock);
 283         return tx;
 284 }
 285
 286 static void release_ir_tx(struct kref *ref)
 287 {
 288         struct IR_tx *tx = container_of(ref, struct IR_tx, ref);
 289         struct IR *ir = tx->ir;
 290
 291         ir->l.features &= ~LIRC_CAN_SEND_PULSE;
 292         /* Don't put_ir_device(tx->ir) here, so our lock doesn't get freed */
 293         ir->tx = NULL;
 294         kfree(tx);
 295 }
 296
 297 static int put_ir_tx(struct IR_tx *tx, bool ir_devices_lock_held)
 298 {
 299         int released;
 300         struct IR *ir = tx->ir;
 301
 302         spin_lock(&ir->tx_ref_lock);
 303         released = kref_put(&tx->ref, release_ir_tx);
 304         spin_unlock(&ir->tx_ref_lock);
 305         /* Do a reference put() for the tx->ir reference, if we released tx */
 306         if (released)
 307                 put_ir_device(ir, ir_devices_lock_held);
 308         return released;
 309 }
 310
 311 static int add_to_buf(struct IR *ir)
 312 {
 313         __u16 code;
 314         unsigned char codes[2];
 315         unsigned char keybuf[6];
 316         int got_data = 0;
 317         int ret;
 318         int failures = 0;
 319         unsigned char sendbuf[1] = { 0 };
 320         struct lirc_buffer *rbuf = ir->l.rbuf;
 321         struct IR_rx *rx;
 322         struct IR_tx *tx;
 323
 324         if (lirc_buffer_full(rbuf)) {
 325                 dev_dbg(ir->l.dev, "buffer overflow\n");
 326                 return -EOVERFLOW;
 327         }
 328
 329         rx = get_ir_rx(ir);
 330         if (!rx)
 331                 return -ENXIO;
 332
 333         /* Ensure our rx->c i2c_client remains valid for the duration */
 334         mutex_lock(&rx->client_lock);
 335         if (!rx->c) {
 336                 mutex_unlock(&rx->client_lock);
 337                 put_ir_rx(rx, false);
 338                 return -ENXIO;
 339         }
 340
 341         tx = get_ir_tx(ir);
 342
 343         /*
 344          * service the device as long as it is returning
 345          * data and we have space
 346          */
 347         do {
 348                 if (kthread_should_stop()) {
 349                         ret = -ENODATA;
 350                         break;
 351                 }
 352
 353                 /*
 354                  * Lock i2c bus for the duration.  RX/TX chips interfere so
 355                  * this is worth it
 356                  */
 357                 mutex_lock(&ir->ir_lock);
 358
 359                 if (kthread_should_stop()) {
 360                         mutex_unlock(&ir->ir_lock);
 361                         ret = -ENODATA;
 362                         break;
 363                 }
 364
 365                 /*
 366                  * Send random "poll command" (?)  Windows driver does this
 367                  * and it is a good point to detect chip failure.
 368                  */
 369                 ret = i2c_master_send(rx->c, sendbuf, 1);
 370                 if (ret != 1) {
 371                         dev_err(ir->l.dev, "i2c_master_send failed with %d\n",
 372                                 ret);
 373                         if (failures >= 3) {
 374                                 mutex_unlock(&ir->ir_lock);
 375                                 dev_err(ir->l.dev,
 376                                         "unable to read from the IR chip after 3 resets, giving up\n");
 377                                 break;
 378                         }
 379
 380                         /* Looks like the chip crashed, reset it */
 381                         dev_err(ir->l.dev,
 382                                 "polling the IR receiver chip failed, trying reset\n");
 383
 384                         set_current_state(TASK_UNINTERRUPTIBLE);
 385                         if (kthread_should_stop()) {
 386                                 mutex_unlock(&ir->ir_lock);
 387                                 ret = -ENODATA;
 388                                 break;
 389                         }
 390                         schedule_timeout((100 * HZ + 999) / 1000);
 391                         if (tx)
 392                                 tx->need_boot = 1;
 393
 394                         ++failures;
 395                         mutex_unlock(&ir->ir_lock);
 396                         ret = 0;
 397                         continue;
 398                 }
 399
 400                 if (kthread_should_stop()) {
 401                         mutex_unlock(&ir->ir_lock);
 402                         ret = -ENODATA;
 403                         break;
 404                 }
 405                 ret = i2c_master_recv(rx->c, keybuf, sizeof(keybuf));
 406                 mutex_unlock(&ir->ir_lock);
 407                 if (ret != sizeof(keybuf)) {
 408                         dev_err(ir->l.dev,
 409                                 "i2c_master_recv failed with %d -- keeping last read buffer\n",
 410                                 ret);
 411                 } else {
 412                         rx->b[0] = keybuf[3];
 413                         rx->b[1] = keybuf[4];
 414                         rx->b[2] = keybuf[5];
 415                         dev_dbg(ir->l.dev,
 416                                 "key (0x%02x/0x%02x)\n",
 417                                 rx->b[0], rx->b[1]);
 418                 }
 419
 420                 /* key pressed ? */
 421                 if (rx->hdpvr_data_fmt) {
 422                         if (got_data && (keybuf[0] == 0x80)) {
 423                                 ret = 0;
 424                                 break;
 425                         } else if (got_data && (keybuf[0] == 0x00)) {
 426                                 ret = -ENODATA;
 427                                 break;
 428                         }
 429                 } else if ((rx->b[0] & 0x80) == 0) {
 430                         ret = got_data ? 0 : -ENODATA;
 431                         break;
 432                 }
 433
 434                 /* look what we have */
 435                 code = (((__u16)rx->b[0] & 0x7f) << 6) | (rx->b[1] >> 2);
 436
 437                 codes[0] = (code >> 8) & 0xff;
 438                 codes[1] = code & 0xff;
 439
 440                 /* return it */
 441                 lirc_buffer_write(rbuf, codes);
 442                 ++got_data;
 443                 ret = 0;
 444         } while (!lirc_buffer_full(rbuf));
 445
 446         mutex_unlock(&rx->client_lock);
 447         if (tx)
 448                 put_ir_tx(tx, false);
 449         put_ir_rx(rx, false);
 450         return ret;
 451 }
 452
 453 /*
 454  * Main function of the polling thread -- from lirc_dev.
 455  * We don't fit the LIRC model at all anymore.  This is horrible, but
 456  * basically we have a single RX/TX device with a nasty failure mode
 457  * that needs to be accounted for across the pair.  lirc lets us provide
 458  * fops, but prevents us from using the internal polling, etc. if we do
 459  * so.  Hence the replication.  Might be neater to extend the LIRC model
 460  * to account for this but I'd think it's a very special case of seriously
 461  * messed up hardware.
 462  */
 463 static int lirc_thread(void *arg)
 464 {
 465         struct IR *ir = arg;
 466         struct lirc_buffer *rbuf = ir->l.rbuf;
 467
 468         dev_dbg(ir->l.dev, "poll thread started\n");
 469
 470         while (!kthread_should_stop()) {
 471                 set_current_state(TASK_INTERRUPTIBLE);
 472
 473                 /* if device not opened, we can sleep half a second */
 474                 if (atomic_read(&ir->open_count) == 0) {
 475                         schedule_timeout(HZ / 2);
 476                         continue;
 477                 }
 478
 479                 /*
 480                  * This is ~113*2 + 24 + jitter (2*repeat gap + code length).
 481                  * We use this interval as the chip resets every time you poll
 482                  * it (bad!).  This is therefore just sufficient to catch all
 483                  * of the button presses.  It makes the remote much more
 484                  * responsive.  You can see the difference by running irw and
 485                  * holding down a button.  With 100ms, the old polling
 486                  * interval, you'll notice breaks in the repeat sequence
 487                  * corresponding to lost keypresses.
 488                  */
 489                 schedule_timeout((260 * HZ) / 1000);
 490                 if (kthread_should_stop())
 491                         break;
 492                 if (!add_to_buf(ir))
 493                         wake_up_interruptible(&rbuf->wait_poll);
 494         }
 495
 496         dev_dbg(ir->l.dev, "poll thread ended\n");
 497         return 0;
 498 }
 499
 500 /* safe read of a uint32 (always network byte order) */
 501 static int read_uint32(unsigned char **data,
 502                        unsigned char *endp, unsigned int *val)
 503 {
 504         if (*data + 4 > endp)
 505                 return 0;
 506         *val = ((*data)[0] << 24) | ((*data)[1] << 16) |
 507                ((*data)[2] << 8) | (*data)[3];
 508         *data += 4;
 509         return 1;
 510 }
 511
 512 /* safe read of a uint8 */
 513 static int read_uint8(unsigned char **data,
 514                       unsigned char *endp, unsigned char *val)
 515 {
 516         if (*data + 1 > endp)
 517                 return 0;
 518         *val = *((*data)++);
 519         return 1;
 520 }
 521
 522 /* safe skipping of N bytes */
 523 static int skip(unsigned char **data,
 524                 unsigned char *endp, unsigned int distance)
 525 {
 526         if (*data + distance > endp)
 527                 return 0;
 528         *data += distance;
 529         return 1;
 530 }
 531
 532 /* decompress key data into the given buffer */
 533 static int get_key_data(unsigned char *buf,
 534                         unsigned int codeset, unsigned int key)
 535 {
 536         unsigned char *data, *endp, *diffs, *key_block;
 537         unsigned char keys, ndiffs, id;
 538         unsigned int base, lim, pos, i;
 539
 540         /* Binary search for the codeset */
 541         for (base = 0, lim = tx_data->num_code_sets; lim; lim >>= 1) {
 542                 pos = base + (lim >> 1);
 543                 data = tx_data->code_sets[pos];
 544
 545                 if (!read_uint32(&data, tx_data->endp, &i))
 546                         goto corrupt;
 547
 548                 if (i == codeset) {
 549                         break;
 550                 } else if (codeset > i) {
 551                         base = pos + 1;
 552                         --lim;
 553                 }
 554         }
 555         /* Not found? */
 556         if (!lim)
 557                 return -EPROTO;
 558
 559         /* Set end of data block */
 560         endp = pos < tx_data->num_code_sets - 1 ?
 561                 tx_data->code_sets[pos + 1] : tx_data->endp;
 562
 563         /* Read the block header */
 564         if (!read_uint8(&data, endp, &keys) ||
 565             !read_uint8(&data, endp, &ndiffs) ||
 566             ndiffs > TX_BLOCK_SIZE || keys == 0)
 567                 goto corrupt;
 568
 569         /* Save diffs & skip */
 570         diffs = data;
 571         if (!skip(&data, endp, ndiffs))
 572                 goto corrupt;
 573
 574         /* Read the id of the first key */
 575         if (!read_uint8(&data, endp, &id))
 576                 goto corrupt;
 577
 578         /* Unpack the first key's data */
 579         for (i = 0; i < TX_BLOCK_SIZE; ++i) {
 580                 if (tx_data->fixed[i] == -1) {
 581                         if (!read_uint8(&data, endp, &buf[i]))
 582                                 goto corrupt;
 583                 } else {
 584                         buf[i] = (unsigned char)tx_data->fixed[i];
 585                 }
 586         }
 587
 588         /* Early out key found/not found */
 589         if (key == id)
 590                 return 0;
 591         if (keys == 1)
 592                 return -EPROTO;
 593
 594         /* Sanity check */
 595         key_block = data;
 596         if (!skip(&data, endp, (keys - 1) * (ndiffs + 1)))
 597                 goto corrupt;
 598
 599         /* Binary search for the key */
 600         for (base = 0, lim = keys - 1; lim; lim >>= 1) {
 601                 /* Seek to block */
 602                 unsigned char *key_data;
 603
 604                 pos = base + (lim >> 1);
 605                 key_data = key_block + (ndiffs + 1) * pos;
 606
 607                 if (*key_data == key) {
 608                         /* skip key id */
 609                         ++key_data;
 610
 611                         /* found, so unpack the diffs */
 612                         for (i = 0; i < ndiffs; ++i) {
 613                                 unsigned char val;
 614
 615                                 if (!read_uint8(&key_data, endp, &val) ||
 616                                     diffs[i] >= TX_BLOCK_SIZE)
 617                                         goto corrupt;
 618                                 buf[diffs[i]] = val;
 619                         }
 620
 621                         return 0;
 622                 } else if (key > *key_data) {
 623                         base = pos + 1;
 624                         --lim;
 625                 }
 626         }
 627         /* Key not found */
 628         return -EPROTO;
 629
 630 corrupt:
 631         pr_err("firmware is corrupt\n");
 632         return -EFAULT;
 633 }
 634
 635 /* send a block of data to the IR TX device */
 636 static int send_data_block(struct IR_tx *tx, unsigned char *data_block)
 637 {
 638         int i, j, ret;
 639         unsigned char buf[5];
 640
 641         for (i = 0; i < TX_BLOCK_SIZE;) {
 642                 int tosend = TX_BLOCK_SIZE - i;
 643
 644                 if (tosend > 4)
 645                         tosend = 4;
 646                 buf[0] = (unsigned char)(i + 1);
 647                 for (j = 0; j < tosend; ++j)
 648                         buf[1 + j] = data_block[i + j];
 649                 dev_dbg(tx->ir->l.dev, "%*ph", 5, buf);
 650                 ret = i2c_master_send(tx->c, buf, tosend + 1);
 651                 if (ret != tosend + 1) {
 652                         dev_err(tx->ir->l.dev,
 653                                 "i2c_master_send failed with %d\n", ret);
 654                         return ret < 0 ? ret : -EFAULT;
 655                 }
 656                 i += tosend;
 657         }
 658         return 0;
 659 }
 660
 661 /* send boot data to the IR TX device */
 662 static int send_boot_data(struct IR_tx *tx)
 663 {
 664         int ret, i;
 665         unsigned char buf[4];
 666
 667         /* send the boot block */
 668         ret = send_data_block(tx, tx_data->boot_data);
 669         if (ret != 0)
 670                 return ret;
 671
 672         /* Hit the go button to activate the new boot data */
 673         buf[0] = 0x00;
 674         buf[1] = 0x20;
 675         ret = i2c_master_send(tx->c, buf, 2);
 676         if (ret != 2) {
 677                 dev_err(tx->ir->l.dev, "i2c_master_send failed with %d\n", ret);
 678                 return ret < 0 ? ret : -EFAULT;
 679         }
 680
 681         /*
 682          * Wait for zilog to settle after hitting go post boot block upload.
 683          * Without this delay, the HD-PVR and HVR-1950 both return an -EIO
 684          * upon attempting to get firmware revision, and tx probe thus fails.
 685          */
 686         for (i = 0; i < 10; i++) {
 687                 ret = i2c_master_send(tx->c, buf, 1);
 688                 if (ret == 1)
 689                         break;
 690                 udelay(100);
 691         }
 692
 693         if (ret != 1) {
 694                 dev_err(tx->ir->l.dev, "i2c_master_send failed with %d\n", ret);
 695                 return ret < 0 ? ret : -EFAULT;
 696         }
 697
 698         /* Here comes the firmware version... (hopefully) */
 699         ret = i2c_master_recv(tx->c, buf, 4);
 700         if (ret != 4) {
 701                 dev_err(tx->ir->l.dev, "i2c_master_recv failed with %d\n", ret);
 702                 return 0;
 703         }
 704         if ((buf[0] != 0x80) && (buf[0] != 0xa0)) {
 705                 dev_err(tx->ir->l.dev, "unexpected IR TX init response: %02x\n",
 706                         buf[0]);
 707                 return 0;
 708         }
 709         dev_notice(tx->ir->l.dev,
 710                    "Zilog/Hauppauge IR blaster firmware version %d.%d.%d loaded\n",
 711                    buf[1], buf[2], buf[3]);
 712
 713         return 0;
 714 }
 715
 716 /* unload "firmware", lock held */
 717 static void fw_unload_locked(void)
 718 {
 719         if (tx_data) {
 720                 vfree(tx_data->code_sets);
 721
 722                 vfree(tx_data->datap);
 723
 724                 vfree(tx_data);
 725                 tx_data = NULL;
 726                 pr_debug("successfully unloaded IR blaster firmware\n");
 727         }
 728 }
 729
 730 /* unload "firmware" for the IR TX device */
 731 static void fw_unload(void)
 732 {
 733         mutex_lock(&tx_data_lock);
 734         fw_unload_locked();
 735         mutex_unlock(&tx_data_lock);
 736 }
 737
 738 /* load "firmware" for the IR TX device */
 739 static int fw_load(struct IR_tx *tx)
 740 {
 741         int ret;
 742         unsigned int i;
 743         unsigned char *data, version, num_global_fixed;
 744         const struct firmware *fw_entry;
 745
 746         /* Already loaded? */
 747         mutex_lock(&tx_data_lock);
 748         if (tx_data) {
 749                 ret = 0;
 750                 goto out;
 751         }
 752
 753         /* Request codeset data file */
 754         ret = reject_firmware(&fw_entry, "/*(DEBLOBBED)*/", tx->ir->l.dev);
 755         if (ret != 0) {
 756                 dev_err(tx->ir->l.dev,
 757                         "firmware /*(DEBLOBBED)*/ not available (%d)\n",
 758                         ret);
 759                 ret = ret < 0 ? ret : -EFAULT;
 760                 goto out;
 761         }
 762         dev_dbg(tx->ir->l.dev, "firmware of size %zu loaded\n", fw_entry->size);
 763
 764         /* Parse the file */
 765         tx_data = vmalloc(sizeof(*tx_data));
 766         if (!tx_data) {
 767                 release_firmware(fw_entry);
 768                 ret = -ENOMEM;
 769                 goto out;
 770         }
 771         tx_data->code_sets = NULL;
 772
 773         /* Copy the data so hotplug doesn't get confused and timeout */
 774         tx_data->datap = vmalloc(fw_entry->size);
 775         if (!tx_data->datap) {
 776                 release_firmware(fw_entry);
 777                 vfree(tx_data);
 778                 ret = -ENOMEM;
 779                 goto out;
 780         }
 781         memcpy(tx_data->datap, fw_entry->data, fw_entry->size);
 782         tx_data->endp = tx_data->datap + fw_entry->size;
 783         release_firmware(fw_entry); fw_entry = NULL;
 784
 785         /* Check version */
 786         data = tx_data->datap;
 787         if (!read_uint8(&data, tx_data->endp, &version))
 788                 goto corrupt;
 789         if (version != 1) {
 790                 dev_err(tx->ir->l.dev,
 791                         "unsupported code set file version (%u, expected 1) -- please upgrade to a newer driver\n",
 792                         version);
 793                 fw_unload_locked();
 794                 ret = -EFAULT;
 795                 goto out;
 796         }
 797
 798         /* Save boot block for later */
 799         tx_data->boot_data = data;
 800         if (!skip(&data, tx_data->endp, TX_BLOCK_SIZE))
 801                 goto corrupt;
 802
 803         if (!read_uint32(&data, tx_data->endp,
 804                          &tx_data->num_code_sets))
 805                 goto corrupt;
 806
 807         dev_dbg(tx->ir->l.dev, "%u IR blaster codesets loaded\n",
 808                 tx_data->num_code_sets);
 809
 810         tx_data->code_sets = vmalloc(
 811                 tx_data->num_code_sets * sizeof(char *));
 812         if (!tx_data->code_sets) {
 813                 fw_unload_locked();
 814                 ret = -ENOMEM;
 815                 goto out;
 816         }
 817
 818         for (i = 0; i < TX_BLOCK_SIZE; ++i)
 819                 tx_data->fixed[i] = -1;
 820
 821         /* Read global fixed data template */
 822         if (!read_uint8(&data, tx_data->endp, &num_global_fixed) ||
 823             num_global_fixed > TX_BLOCK_SIZE)
 824                 goto corrupt;
 825         for (i = 0; i < num_global_fixed; ++i) {
 826                 unsigned char pos, val;
 827
 828                 if (!read_uint8(&data, tx_data->endp, &pos) ||
 829                     !read_uint8(&data, tx_data->endp, &val) ||
 830                     pos >= TX_BLOCK_SIZE)
 831                         goto corrupt;
 832                 tx_data->fixed[pos] = (int)val;
 833         }
 834
 835         /* Filch out the position of each code set */
 836         for (i = 0; i < tx_data->num_code_sets; ++i) {
 837                 unsigned int id;
 838                 unsigned char keys;
 839                 unsigned char ndiffs;
 840
 841                 /* Save the codeset position */
 842                 tx_data->code_sets[i] = data;
 843
 844                 /* Read header */
 845                 if (!read_uint32(&data, tx_data->endp, &id) ||
 846                     !read_uint8(&data, tx_data->endp, &keys) ||
 847                     !read_uint8(&data, tx_data->endp, &ndiffs) ||
 848                     ndiffs > TX_BLOCK_SIZE || keys == 0)
 849                         goto corrupt;
 850
 851                 /* skip diff positions */
 852                 if (!skip(&data, tx_data->endp, ndiffs))
 853                         goto corrupt;
 854
 855                 /*
 856                  * After the diffs we have the first key id + data -
 857                  * global fixed
 858                  */
 859                 if (!skip(&data, tx_data->endp,
 860                           1 + TX_BLOCK_SIZE - num_global_fixed))
 861                         goto corrupt;
 862
 863                 /* Then we have keys-1 blocks of key id+diffs */
 864                 if (!skip(&data, tx_data->endp,
 865                           (ndiffs + 1) * (keys - 1)))
 866                         goto corrupt;
 867         }
 868         ret = 0;
 869         goto out;
 870
 871 corrupt:
 872         dev_err(tx->ir->l.dev, "firmware is corrupt\n");
 873         fw_unload_locked();
 874         ret = -EFAULT;
 875
 876 out:
 877         mutex_unlock(&tx_data_lock);
 878         return ret;
 879 }
 880
 881 /* copied from lirc_dev */
 882 static ssize_t read(struct file *filep, char __user *outbuf, size_t n,
 883                     loff_t *ppos)
 884 {
 885         struct IR *ir = filep->private_data;
 886         struct IR_rx *rx;
 887         struct lirc_buffer *rbuf = ir->l.rbuf;
 888         int ret = 0, written = 0, retries = 0;
 889         unsigned int m;
 890         DECLARE_WAITQUEUE(wait, current);
 891
 892         dev_dbg(ir->l.dev, "read called\n");
 893         if (n % rbuf->chunk_size) {
 894                 dev_dbg(ir->l.dev, "read result = -EINVAL\n");
 895                 return -EINVAL;
 896         }
 897
 898         rx = get_ir_rx(ir);
 899         if (!rx)
 900                 return -ENXIO;
 901
 902         /*
 903          * we add ourselves to the task queue before buffer check
 904          * to avoid losing scan code (in case when queue is awaken somewhere
 905          * between while condition checking and scheduling)
 906          */
 907         add_wait_queue(&rbuf->wait_poll, &wait);
 908         set_current_state(TASK_INTERRUPTIBLE);
 909
 910         /*
 911          * while we didn't provide 'length' bytes, device is opened in blocking
 912          * mode and 'copy_to_user' is happy, wait for data.
 913          */
 914         while (written < n && ret == 0) {
 915                 if (lirc_buffer_empty(rbuf)) {
 916                         /*
 917                          * According to the read(2) man page, 'written' can be
 918                          * returned as less than 'n', instead of blocking
 919                          * again, returning -EWOULDBLOCK, or returning
 920                          * -ERESTARTSYS
 921                          */
 922                         if (written)
 923                                 break;
 924                         if (filep->f_flags & O_NONBLOCK) {
 925                                 ret = -EWOULDBLOCK;
 926                                 break;
 927                         }
 928                         if (signal_pending(current)) {
 929                                 ret = -ERESTARTSYS;
 930                                 break;
 931                         }
 932                         schedule();
 933                         set_current_state(TASK_INTERRUPTIBLE);
 934                 } else {
 935                         unsigned char buf[MAX_XFER_SIZE];
 936
 937                         if (rbuf->chunk_size > sizeof(buf)) {
 938                                 dev_err(ir->l.dev,
 939                                         "chunk_size is too big (%d)!\n",
 940                                         rbuf->chunk_size);
 941                                 ret = -EINVAL;
 942                                 break;
 943                         }
 944                         m = lirc_buffer_read(rbuf, buf);
 945                         if (m == rbuf->chunk_size) {
 946                                 ret = copy_to_user(outbuf + written, buf,
 947                                                    rbuf->chunk_size);
 948                                 written += rbuf->chunk_size;
 949                         } else {
 950                                 retries++;
 951                         }
 952                         if (retries >= 5) {
 953                                 dev_err(ir->l.dev, "Buffer read failed!\n");
 954                                 ret = -EIO;
 955                         }
 956                 }
 957         }
 958
 959         remove_wait_queue(&rbuf->wait_poll, &wait);
 960         put_ir_rx(rx, false);
 961         set_current_state(TASK_RUNNING);
 962
 963         dev_dbg(ir->l.dev, "read result = %d (%s)\n", ret,
 964                 ret ? "Error" : "OK");
 965
 966         return ret ? ret : written;
 967 }
 968
 969 /* send a keypress to the IR TX device */
 970 static int send_code(struct IR_tx *tx, unsigned int code, unsigned int key)
 971 {
 972         unsigned char data_block[TX_BLOCK_SIZE];
 973         unsigned char buf[2];
 974         int i, ret;
 975
 976         /* Get data for the codeset/key */
 977         ret = get_key_data(data_block, code, key);
 978
 979         if (ret == -EPROTO) {
 980                 dev_err(tx->ir->l.dev,
 981                         "failed to get data for code %u, key %u -- check lircd.conf entries\n",
 982                         code, key);
 983                 return ret;
 984         } else if (ret != 0) {
 985                 return ret;
 986         }
 987
 988         /* Send the data block */
 989         ret = send_data_block(tx, data_block);
 990         if (ret != 0)
 991                 return ret;
 992
 993         /* Send data block length? */
 994         buf[0] = 0x00;
 995         buf[1] = 0x40;
 996         ret = i2c_master_send(tx->c, buf, 2);
 997         if (ret != 2) {
 998                 dev_err(tx->ir->l.dev, "i2c_master_send failed with %d\n", ret);
 999                 return ret < 0 ? ret : -EFAULT;
1000         }
1001
1002         /* Give the z8 a moment to process data block */
1003         for (i = 0; i < 10; i++) {
1004                 ret = i2c_master_send(tx->c, buf, 1);
1005                 if (ret == 1)
1006                         break;
1007                 udelay(100);
1008         }
1009
1010         if (ret != 1) {
1011                 dev_err(tx->ir->l.dev, "i2c_master_send failed with %d\n", ret);
1012                 return ret < 0 ? ret : -EFAULT;
1013         }
1014
1015         /* Send finished download? */
1016         ret = i2c_master_recv(tx->c, buf, 1);
1017         if (ret != 1) {
1018                 dev_err(tx->ir->l.dev, "i2c_master_recv failed with %d\n", ret);
1019                 return ret < 0 ? ret : -EFAULT;
1020         }
1021         if (buf[0] != 0xA0) {
1022                 dev_err(tx->ir->l.dev, "unexpected IR TX response #1: %02x\n",
1023                         buf[0]);
1024                 return -EFAULT;
1025         }
1026
1027         /* Send prepare command? */
1028         buf[0] = 0x00;
1029         buf[1] = 0x80;
1030         ret = i2c_master_send(tx->c, buf, 2);
1031         if (ret != 2) {
1032                 dev_err(tx->ir->l.dev, "i2c_master_send failed with %d\n", ret);
1033                 return ret < 0 ? ret : -EFAULT;
1034         }
1035
1036         /*
1037          * The sleep bits aren't necessary on the HD PVR, and in fact, the
1038          * last i2c_master_recv always fails with a -5, so for now, we're
1039          * going to skip this whole mess and say we're done on the HD PVR
1040          */
1041         if (!tx->post_tx_ready_poll) {
1042                 dev_dbg(tx->ir->l.dev, "sent code %u, key %u\n", code, key);
1043                 return 0;
1044         }
1045
1046         /*
1047          * This bit NAKs until the device is ready, so we retry it
1048          * sleeping a bit each time.  This seems to be what the windows
1049          * driver does, approximately.
1050          * Try for up to 1s.
1051          */
1052         for (i = 0; i < 20; ++i) {
1053                 set_current_state(TASK_UNINTERRUPTIBLE);
1054                 schedule_timeout((50 * HZ + 999) / 1000);
1055                 ret = i2c_master_send(tx->c, buf, 1);
1056                 if (ret == 1)
1057                         break;
1058                 dev_dbg(tx->ir->l.dev,
1059                         "NAK expected: i2c_master_send failed with %d (try %d)\n",
1060                         ret, i + 1);
1061         }
1062         if (ret != 1) {
1063                 dev_err(tx->ir->l.dev,
1064                         "IR TX chip never got ready: last i2c_master_send failed with %d\n",
1065                         ret);
1066                 return ret < 0 ? ret : -EFAULT;
1067         }
1068
1069         /* Seems to be an 'ok' response */
1070         i = i2c_master_recv(tx->c, buf, 1);
1071         if (i != 1) {
1072                 dev_err(tx->ir->l.dev, "i2c_master_recv failed with %d\n", ret);
1073                 return -EFAULT;
1074         }
1075         if (buf[0] != 0x80) {
1076                 dev_err(tx->ir->l.dev, "unexpected IR TX response #2: %02x\n",
1077                         buf[0]);
1078                 return -EFAULT;
1079         }
1080
1081         /* Oh good, it worked */
1082         dev_dbg(tx->ir->l.dev, "sent code %u, key %u\n", code, key);
1083         return 0;
1084 }
1085
1086 /*
1087  * Write a code to the device.  We take in a 32-bit number (an int) and then
1088  * decode this to a codeset/key index.  The key data is then decompressed and
1089  * sent to the device.  We have a spin lock as per i2c documentation to prevent
1090  * multiple concurrent sends which would probably cause the device to explode.
1091  */
1092 static ssize_t write(struct file *filep, const char __user *buf, size_t n,
1093                      loff_t *ppos)
1094 {
1095         struct IR *ir = filep->private_data;
1096         struct IR_tx *tx;
1097         size_t i;
1098         int failures = 0;
1099
1100         /* Validate user parameters */
1101         if (n % sizeof(int))
1102                 return -EINVAL;
1103
1104         /* Get a struct IR_tx reference */
1105         tx = get_ir_tx(ir);
1106         if (!tx)
1107                 return -ENXIO;
1108
1109         /* Ensure our tx->c i2c_client remains valid for the duration */
1110         mutex_lock(&tx->client_lock);
1111         if (!tx->c) {
1112                 mutex_unlock(&tx->client_lock);
1113                 put_ir_tx(tx, false);
1114                 return -ENXIO;
1115         }
1116
1117         /* Lock i2c bus for the duration */
1118         mutex_lock(&ir->ir_lock);
1119
1120         /* Send each keypress */
1121         for (i = 0; i < n;) {
1122                 int ret = 0;
1123                 int command;
1124
1125                 if (copy_from_user(&command, buf + i, sizeof(command))) {
1126                         mutex_unlock(&ir->ir_lock);
1127                         mutex_unlock(&tx->client_lock);
1128                         put_ir_tx(tx, false);
1129                         return -EFAULT;
1130                 }
1131
1132                 /* Send boot data first if required */
1133                 if (tx->need_boot == 1) {
1134                         /* Make sure we have the 'firmware' loaded, first */
1135                         ret = fw_load(tx);
1136                         if (ret != 0) {
1137                                 mutex_unlock(&ir->ir_lock);
1138                                 mutex_unlock(&tx->client_lock);
1139                                 put_ir_tx(tx, false);
1140                                 if (ret != -ENOMEM)
1141                                         ret = -EIO;
1142                                 return ret;
1143                         }
1144                         /* Prep the chip for transmitting codes */
1145                         ret = send_boot_data(tx);
1146                         if (ret == 0)
1147                                 tx->need_boot = 0;
1148                 }
1149
1150                 /* Send the code */
1151                 if (ret == 0) {
1152                         ret = send_code(tx, (unsigned int)command >> 16,
1153                                             (unsigned int)command & 0xFFFF);
1154                         if (ret == -EPROTO) {
1155                                 mutex_unlock(&ir->ir_lock);
1156                                 mutex_unlock(&tx->client_lock);
1157                                 put_ir_tx(tx, false);
1158                                 return ret;
1159                         }
1160                 }
1161
1162                 /*
1163                  * Hmm, a failure.  If we've had a few then give up, otherwise
1164                  * try a reset
1165                  */
1166                 if (ret != 0) {
1167                         /* Looks like the chip crashed, reset it */
1168                         dev_err(tx->ir->l.dev,
1169                                 "sending to the IR transmitter chip failed, trying reset\n");
1170
1171                         if (failures >= 3) {
1172                                 dev_err(tx->ir->l.dev,
1173                                         "unable to send to the IR chip after 3 resets, giving up\n");
1174                                 mutex_unlock(&ir->ir_lock);
1175                                 mutex_unlock(&tx->client_lock);
1176                                 put_ir_tx(tx, false);
1177                                 return ret;
1178                         }
1179                         set_current_state(TASK_UNINTERRUPTIBLE);
1180                         schedule_timeout((100 * HZ + 999) / 1000);
1181                         tx->need_boot = 1;
1182                         ++failures;
1183                 } else {
1184                         i += sizeof(int);
1185                 }
1186         }
1187
1188         /* Release i2c bus */
1189         mutex_unlock(&ir->ir_lock);
1190
1191         mutex_unlock(&tx->client_lock);
1192
1193         /* Give back our struct IR_tx reference */
1194         put_ir_tx(tx, false);
1195
1196         /* All looks good */
1197         return n;
1198 }
1199
1200 /* copied from lirc_dev */
1201 static unsigned int poll(struct file *filep, poll_table *wait)
1202 {
1203         struct IR *ir = filep->private_data;
1204         struct IR_rx *rx;
1205         struct lirc_buffer *rbuf = ir->l.rbuf;
1206         unsigned int ret;
1207
1208         dev_dbg(ir->l.dev, "%s called\n", __func__);
1209
1210         rx = get_ir_rx(ir);
1211         if (!rx) {
1212                 /*
1213                  * Revisit this, if our poll function ever reports writeable
1214                  * status for Tx
1215                  */
1216                 dev_dbg(ir->l.dev, "%s result = POLLERR\n", __func__);
1217                 return POLLERR;
1218         }
1219
1220         /*
1221          * Add our lirc_buffer's wait_queue to the poll_table. A wake up on
1222          * that buffer's wait queue indicates we may have a new poll status.
1223          */
1224         poll_wait(filep, &rbuf->wait_poll, wait);
1225
1226         /* Indicate what ops could happen immediately without blocking */
1227         ret = lirc_buffer_empty(rbuf) ? 0 : (POLLIN | POLLRDNORM);
1228
1229         dev_dbg(ir->l.dev, "%s result = %s\n", __func__,
1230                 ret ? "POLLIN|POLLRDNORM" : "none");
1231         put_ir_rx(rx, false);
1232         return ret;
1233 }
1234
1235 static long ioctl(struct file *filep, unsigned int cmd, unsigned long arg)
1236 {
1237         struct IR *ir = filep->private_data;
1238         unsigned long __user *uptr = (unsigned long __user *)arg;
1239         int result;
1240         unsigned long mode, features;
1241
1242         features = ir->l.features;
1243
1244         switch (cmd) {
1245         case LIRC_GET_LENGTH:
1246                 result = put_user(13UL, uptr);
1247                 break;
1248         case LIRC_GET_FEATURES:
1249                 result = put_user(features, uptr);
1250                 break;
1251         case LIRC_GET_REC_MODE:
1252                 if (!(features & LIRC_CAN_REC_MASK))
1253                         return -ENOTTY;
1254
1255                 result = put_user(LIRC_REC2MODE
1256                                   (features & LIRC_CAN_REC_MASK),
1257                                   uptr);
1258                 break;
1259         case LIRC_SET_REC_MODE:
1260                 if (!(features & LIRC_CAN_REC_MASK))
1261                         return -ENOTTY;
1262
1263                 result = get_user(mode, uptr);
1264                 if (!result && !(LIRC_MODE2REC(mode) & features))
1265                         result = -ENOTTY;
1266                 break;
1267         case LIRC_GET_SEND_MODE:
1268                 if (!(features & LIRC_CAN_SEND_MASK))
1269                         return -ENOTTY;
1270
1271                 result = put_user(LIRC_MODE_PULSE, uptr);
1272                 break;
1273         case LIRC_SET_SEND_MODE:
1274                 if (!(features & LIRC_CAN_SEND_MASK))
1275                         return -ENOTTY;
1276
1277                 result = get_user(mode, uptr);
1278                 if (!result && mode != LIRC_MODE_PULSE)
1279                         return -EINVAL;
1280                 break;
1281         default:
1282                 return -EINVAL;
1283         }
1284         return result;
1285 }
1286
1287 static struct IR *get_ir_device_by_minor(unsigned int minor)
1288 {
1289         struct IR *ir;
1290         struct IR *ret = NULL;
1291
1292         mutex_lock(&ir_devices_lock);
1293
1294         if (!list_empty(&ir_devices_list)) {
1295                 list_for_each_entry(ir, &ir_devices_list, list) {
1296                         if (ir->l.minor == minor) {
1297                                 ret = get_ir_device(ir, true);
1298                                 break;
1299                         }
1300                 }
1301         }
1302
1303         mutex_unlock(&ir_devices_lock);
1304         return ret;
1305 }
1306
1307 /*
1308  * Open the IR device.  Get hold of our IR structure and
1309  * stash it in private_data for the file
1310  */
1311 static int open(struct inode *node, struct file *filep)
1312 {
1313         struct IR *ir;
1314         unsigned int minor = MINOR(node->i_rdev);
1315
1316         /* find our IR struct */
1317         ir = get_ir_device_by_minor(minor);
1318
1319         if (!ir)
1320                 return -ENODEV;
1321
1322         atomic_inc(&ir->open_count);
1323
1324         /* stash our IR struct */
1325         filep->private_data = ir;
1326
1327         nonseekable_open(node, filep);
1328         return 0;
1329 }
1330
1331 /* Close the IR device */
1332 static int close(struct inode *node, struct file *filep)
1333 {
1334         /* find our IR struct */
1335         struct IR *ir = filep->private_data;
1336
1337         if (!ir) {
1338                 pr_err("ir: %s: no private_data attached to the file!\n",
1339                        __func__);
1340                 return -ENODEV;
1341         }
1342
1343         atomic_dec(&ir->open_count);
1344
1345         put_ir_device(ir, false);
1346         return 0;
1347 }
1348
1349 static int ir_remove(struct i2c_client *client);
1350 static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id);
1351
1352 #define ID_FLAG_TX      0x01
1353 #define ID_FLAG_HDPVR   0x02
1354
1355 static const struct i2c_device_id ir_transceiver_id[] = {
1356         { "ir_tx_z8f0811_haup",  ID_FLAG_TX                 },
1357         { "ir_rx_z8f0811_haup",  0                          },
1358         { "ir_tx_z8f0811_hdpvr", ID_FLAG_HDPVR | ID_FLAG_TX },
1359         { "ir_rx_z8f0811_hdpvr", ID_FLAG_HDPVR              },
1360         { }
1361 };
1362 MODULE_DEVICE_TABLE(i2c, ir_transceiver_id);
1363
1364 static struct i2c_driver driver = {
1365         .driver = {
1366                 .name   = "Zilog/Hauppauge i2c IR",
1367         },
1368         .probe          = ir_probe,
1369         .remove         = ir_remove,
1370         .id_table       = ir_transceiver_id,
1371 };
1372
1373 static const struct file_operations lirc_fops = {
1374         .owner          = THIS_MODULE,
1375         .llseek         = no_llseek,
1376         .read           = read,
1377         .write          = write,
1378         .poll           = poll,
1379         .unlocked_ioctl = ioctl,
1380 #ifdef CONFIG_COMPAT
1381         .compat_ioctl   = ioctl,
1382 #endif
1383         .open           = open,
1384         .release        = close
1385 };
1386
1387 static struct lirc_driver lirc_template = {
1388         .name           = "lirc_zilog",
1389         .minor          = -1,
1390         .code_length    = 13,
1391         .buffer_size    = BUFLEN / 2,
1392         .chunk_size     = 2,
1393         .fops           = &lirc_fops,
1394         .owner          = THIS_MODULE,
1395 };
1396
1397 static int ir_remove(struct i2c_client *client)
1398 {
1399         if (strncmp("ir_tx_z8", client->name, 8) == 0) {
1400                 struct IR_tx *tx = i2c_get_clientdata(client);
1401
1402                 if (tx) {
1403                         mutex_lock(&tx->client_lock);
1404                         tx->c = NULL;
1405                         mutex_unlock(&tx->client_lock);
1406                         put_ir_tx(tx, false);
1407                 }
1408         } else if (strncmp("ir_rx_z8", client->name, 8) == 0) {
1409                 struct IR_rx *rx = i2c_get_clientdata(client);
1410
1411                 if (rx) {
1412                         mutex_lock(&rx->client_lock);
1413                         rx->c = NULL;
1414                         mutex_unlock(&rx->client_lock);
1415                         put_ir_rx(rx, false);
1416                 }
1417         }
1418         return 0;
1419 }
1420
1421 /* ir_devices_lock must be held */
1422 static struct IR *get_ir_device_by_adapter(struct i2c_adapter *adapter)
1423 {
1424         struct IR *ir;
1425
1426         if (list_empty(&ir_devices_list))
1427                 return NULL;
1428
1429         list_for_each_entry(ir, &ir_devices_list, list)
1430                 if (ir->adapter == adapter) {
1431                         get_ir_device(ir, true);
1432                         return ir;
1433                 }
1434
1435         return NULL;
1436 }
1437
1438 static int ir_probe(struct i2c_client *client, const struct i2c_device_id *id)
1439 {
1440         struct IR *ir;
1441         struct IR_tx *tx;
1442         struct IR_rx *rx;
1443         struct i2c_adapter *adap = client->adapter;
1444         int ret;
1445         bool tx_probe = false;
1446
1447         dev_dbg(&client->dev, "%s: %s on i2c-%d (%s), client addr=0x%02x\n",
1448                 __func__, id->name, adap->nr, adap->name, client->addr);
1449
1450         /*
1451          * The IR receiver    is at i2c address 0x71.
1452          * The IR transmitter is at i2c address 0x70.
1453          */
1454
1455         if (id->driver_data & ID_FLAG_TX)
1456                 tx_probe = true;
1457         else if (tx_only) /* module option */
1458                 return -ENXIO;
1459
1460         pr_info("probing IR %s on %s (i2c-%d)\n",
1461                 tx_probe ? "Tx" : "Rx", adap->name, adap->nr);
1462
1463         mutex_lock(&ir_devices_lock);
1464
1465         /* Use a single struct IR instance for both the Rx and Tx functions */
1466         ir = get_ir_device_by_adapter(adap);
1467         if (!ir) {
1468                 ir = kzalloc(sizeof(*ir), GFP_KERNEL);
1469                 if (!ir) {
1470                         ret = -ENOMEM;
1471                         goto out_no_ir;
1472                 }
1473                 kref_init(&ir->ref);
1474
1475                 /* store for use in ir_probe() again, and open() later on */
1476                 INIT_LIST_HEAD(&ir->list);
1477                 list_add_tail(&ir->list, &ir_devices_list);
1478
1479                 ir->adapter = adap;
1480                 mutex_init(&ir->ir_lock);
1481                 atomic_set(&ir->open_count, 0);
1482                 spin_lock_init(&ir->tx_ref_lock);
1483                 spin_lock_init(&ir->rx_ref_lock);
1484
1485                 /* set lirc_dev stuff */
1486                 memcpy(&ir->l, &lirc_template, sizeof(struct lirc_driver));
1487                 /*
1488                  * FIXME this is a pointer reference to us, but no refcount.
1489                  *
1490                  * This OK for now, since lirc_dev currently won't touch this
1491                  * buffer as we provide our own lirc_fops.
1492                  *
1493                  * Currently our own lirc_fops rely on this ir->l.rbuf pointer
1494                  */
1495                 ir->l.rbuf = &ir->rbuf;
1496                 ir->l.dev  = &adap->dev;
1497                 ret = lirc_buffer_init(ir->l.rbuf,
1498                                        ir->l.chunk_size, ir->l.buffer_size);
1499                 if (ret)
1500                         goto out_put_ir;
1501         }
1502
1503         if (tx_probe) {
1504                 /* Get the IR_rx instance for later, if already allocated */
1505                 rx = get_ir_rx(ir);
1506
1507                 /* Set up a struct IR_tx instance */
1508                 tx = kzalloc(sizeof(*tx), GFP_KERNEL);
1509                 if (!tx) {
1510                         ret = -ENOMEM;
1511                         goto out_put_xx;
1512                 }
1513                 kref_init(&tx->ref);
1514                 ir->tx = tx;
1515
1516                 ir->l.features |= LIRC_CAN_SEND_PULSE;
1517                 mutex_init(&tx->client_lock);
1518                 tx->c = client;
1519                 tx->need_boot = 1;
1520                 tx->post_tx_ready_poll =
1521                                (id->driver_data & ID_FLAG_HDPVR) ? false : true;
1522
1523                 /* An ir ref goes to the struct IR_tx instance */
1524                 tx->ir = get_ir_device(ir, true);
1525
1526                 /* A tx ref goes to the i2c_client */
1527                 i2c_set_clientdata(client, get_ir_tx(ir));
1528
1529                 /*
1530                  * Load the 'firmware'.  We do this before registering with
1531                  * lirc_dev, so the first firmware load attempt does not happen
1532                  * after a open() or write() call on the device.
1533                  *
1534                  * Failure here is not deemed catastrophic, so the receiver will
1535                  * still be usable.  Firmware load will be retried in write(),
1536                  * if it is needed.
1537                  */
1538                 fw_load(tx);
1539
1540                 /* Proceed only if the Rx client is also ready or not needed */
1541                 if (!rx && !tx_only) {
1542                         dev_info(tx->ir->l.dev,
1543                                  "probe of IR Tx on %s (i2c-%d) done. Waiting on IR Rx.\n",
1544                                  adap->name, adap->nr);
1545                         goto out_ok;
1546                 }
1547         } else {
1548                 /* Get the IR_tx instance for later, if already allocated */
1549                 tx = get_ir_tx(ir);
1550
1551                 /* Set up a struct IR_rx instance */
1552                 rx = kzalloc(sizeof(*rx), GFP_KERNEL);
1553                 if (!rx) {
1554                         ret = -ENOMEM;
1555                         goto out_put_xx;
1556                 }
1557                 kref_init(&rx->ref);
1558                 ir->rx = rx;
1559
1560                 ir->l.features |= LIRC_CAN_REC_LIRCCODE;
1561                 mutex_init(&rx->client_lock);
1562                 rx->c = client;
1563                 rx->hdpvr_data_fmt =
1564                                (id->driver_data & ID_FLAG_HDPVR) ? true : false;
1565
1566                 /* An ir ref goes to the struct IR_rx instance */
1567                 rx->ir = get_ir_device(ir, true);
1568
1569                 /* An rx ref goes to the i2c_client */
1570                 i2c_set_clientdata(client, get_ir_rx(ir));
1571
1572                 /*
1573                  * Start the polling thread.
1574                  * It will only perform an empty loop around schedule_timeout()
1575                  * until we register with lirc_dev and the first user open()
1576                  */
1577                 /* An ir ref goes to the new rx polling kthread */
1578                 rx->task = kthread_run(lirc_thread, get_ir_device(ir, true),
1579                                        "zilog-rx-i2c-%d", adap->nr);
1580                 if (IS_ERR(rx->task)) {
1581                         ret = PTR_ERR(rx->task);
1582                         dev_err(tx->ir->l.dev,
1583                                 "%s: could not start IR Rx polling thread\n",
1584                                 __func__);
1585                         /* Failed kthread, so put back the ir ref */
1586                         put_ir_device(ir, true);
1587                         /* Failure exit, so put back rx ref from i2c_client */
1588                         i2c_set_clientdata(client, NULL);
1589                         put_ir_rx(rx, true);
1590                         ir->l.features &= ~LIRC_CAN_REC_LIRCCODE;
1591                         goto out_put_tx;
1592                 }
1593
1594                 /* Proceed only if the Tx client is also ready */
1595                 if (!tx) {
1596                         pr_info("probe of IR Rx on %s (i2c-%d) done. Waiting on IR Tx.\n",
1597                                 adap->name, adap->nr);
1598                         goto out_ok;
1599                 }
1600         }
1601
1602         /* register with lirc */
1603         ir->l.minor = lirc_register_driver(&ir->l);
1604         if (ir->l.minor < 0) {
1605                 dev_err(tx->ir->l.dev,
1606                         "%s: lirc_register_driver() failed: %i\n",
1607                         __func__, ir->l.minor);
1608                 ret = -EBADRQC;
1609                 goto out_put_xx;
1610         }
1611         dev_info(ir->l.dev,
1612                  "IR unit on %s (i2c-%d) registered as lirc%d and ready\n",
1613                  adap->name, adap->nr, ir->l.minor);
1614
1615 out_ok:
1616         if (rx)
1617                 put_ir_rx(rx, true);
1618         if (tx)
1619                 put_ir_tx(tx, true);
1620         put_ir_device(ir, true);
1621         dev_info(ir->l.dev,
1622                  "probe of IR %s on %s (i2c-%d) done\n",
1623                  tx_probe ? "Tx" : "Rx", adap->name, adap->nr);
1624         mutex_unlock(&ir_devices_lock);
1625         return 0;
1626
1627 out_put_xx:
1628         if (rx)
1629                 put_ir_rx(rx, true);
1630 out_put_tx:
1631         if (tx)
1632                 put_ir_tx(tx, true);
1633 out_put_ir:
1634         put_ir_device(ir, true);
1635 out_no_ir:
1636         dev_err(&client->dev,
1637                 "%s: probing IR %s on %s (i2c-%d) failed with %d\n",
1638                 __func__, tx_probe ? "Tx" : "Rx", adap->name, adap->nr, ret);
1639         mutex_unlock(&ir_devices_lock);
1640         return ret;
1641 }
1642
1643 static int __init zilog_init(void)
1644 {
1645         int ret;
1646
1647         pr_notice("Zilog/Hauppauge IR driver initializing\n");
1648
1649         mutex_init(&tx_data_lock);
1650
1651         request_module("firmware_class");
1652
1653         ret = i2c_add_driver(&driver);
1654         if (ret)
1655                 pr_err("initialization failed\n");
1656         else
1657                 pr_notice("initialization complete\n");
1658
1659         return ret;
1660 }
1661
1662 static void __exit zilog_exit(void)
1663 {
1664         i2c_del_driver(&driver);
1665         /* if loaded */
1666         fw_unload();
1667         pr_notice("Zilog/Hauppauge IR driver unloaded\n");
1668 }
1669
1670 module_init(zilog_init);
1671 module_exit(zilog_exit);
1672
1673 MODULE_DESCRIPTION("Zilog/Hauppauge infrared transmitter driver (i2c stack)");
1674 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, Ulrich Mueller, Stefan Jahn, Jerome Brock, Mark Weaver, Andy Walls");
1675 MODULE_LICENSE("GPL");
1676 /* for compat with old name, which isn't all that accurate anymore */
1677 MODULE_ALIAS("lirc_pvr150");
1678
1679 module_param(debug, bool, 0644);
1680 MODULE_PARM_DESC(debug, "Enable debugging messages");
1681
1682 module_param(tx_only, bool, 0644);
1683 MODULE_PARM_DESC(tx_only, "Only handle the IR transmit function");