2 * i2c IR lirc driver for devices with zilog IR processors
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>
21 * parts are cut&pasted from the lirc_i2c.c driver
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>
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.
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.
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
42 #include <linux/module.h>
43 #include <linux/kmod.h>
44 #include <linux/kernel.h>
45 #include <linux/sched.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>
58 #include <linux/mutex.h>
59 #include <linux/kthread.h>
61 #include <media/lirc_dev.h>
62 #include <media/lirc.h>
64 /* Max transfer size done by I2C transfer functions */
65 #define MAX_XFER_SIZE 64
74 struct mutex client_lock
;
77 /* RX polling thread data */
78 struct task_struct
*task
;
90 struct mutex client_lock
;
93 /* TX additional actions needed */
95 bool post_tx_ready_poll
;
100 struct list_head list
;
102 /* FIXME spinlock access to l.features */
103 struct lirc_driver l
;
104 struct lirc_buffer rbuf
;
106 struct mutex ir_lock
;
109 struct i2c_adapter
*adapter
;
111 spinlock_t rx_ref_lock
; /* struct IR_rx kref get()/put() */
114 spinlock_t tx_ref_lock
; /* struct IR_tx kref get()/put() */
118 /* IR transceiver instance object list */
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
125 static DEFINE_MUTEX(ir_devices_lock
);
126 static LIST_HEAD(ir_devices_list
);
128 /* Block size for IR transmitter */
129 #define TX_BLOCK_SIZE 99
131 /* Hauppauge IR transmitter data */
132 struct tx_data_struct
{
134 unsigned char *boot_data
;
136 /* Start of binary data block */
137 unsigned char *datap
;
139 /* End of binary data block */
142 /* Number of installed codesets */
143 unsigned int num_code_sets
;
145 /* Pointers to codesets */
146 unsigned char **code_sets
;
148 /* Global fixed data template */
149 int fixed
[TX_BLOCK_SIZE
];
152 static struct tx_data_struct
*tx_data
;
153 static struct mutex tx_data_lock
;
156 /* module parameters */
157 static bool debug
; /* debug output */
158 static bool tx_only
; /* only handle the IR Tx function */
159 static int minor
= -1; /* minor number */
162 /* struct IR reference counting */
163 static struct IR
*get_ir_device(struct IR
*ir
, bool ir_devices_lock_held
)
165 if (ir_devices_lock_held
) {
168 mutex_lock(&ir_devices_lock
);
170 mutex_unlock(&ir_devices_lock
);
175 static void release_ir_device(struct kref
*ref
)
177 struct IR
*ir
= container_of(ref
, struct IR
, ref
);
180 * Things should be in this state by now:
181 * ir->rx set to NULL and deallocated - happens before ir->rx->ir put()
182 * ir->rx->task kthread stopped - happens before ir->rx->ir put()
183 * ir->tx set to NULL and deallocated - happens before ir->tx->ir put()
184 * ir->open_count == 0 - happens on final close()
185 * ir_lock, tx_ref_lock, rx_ref_lock, all released
187 if (ir
->l
.minor
>= 0 && ir
->l
.minor
< MAX_IRCTL_DEVICES
) {
188 lirc_unregister_driver(ir
->l
.minor
);
189 ir
->l
.minor
= MAX_IRCTL_DEVICES
;
191 if (kfifo_initialized(&ir
->rbuf
.fifo
))
192 lirc_buffer_free(&ir
->rbuf
);
197 static int put_ir_device(struct IR
*ir
, bool ir_devices_lock_held
)
201 if (ir_devices_lock_held
)
202 return kref_put(&ir
->ref
, release_ir_device
);
204 mutex_lock(&ir_devices_lock
);
205 released
= kref_put(&ir
->ref
, release_ir_device
);
206 mutex_unlock(&ir_devices_lock
);
211 /* struct IR_rx reference counting */
212 static struct IR_rx
*get_ir_rx(struct IR
*ir
)
216 spin_lock(&ir
->rx_ref_lock
);
220 spin_unlock(&ir
->rx_ref_lock
);
224 static void destroy_rx_kthread(struct IR_rx
*rx
, bool ir_devices_lock_held
)
226 /* end up polling thread */
227 if (!IS_ERR_OR_NULL(rx
->task
)) {
228 kthread_stop(rx
->task
);
230 /* Put the ir ptr that ir_probe() gave to the rx poll thread */
231 put_ir_device(rx
->ir
, ir_devices_lock_held
);
235 static void release_ir_rx(struct kref
*ref
)
237 struct IR_rx
*rx
= container_of(ref
, struct IR_rx
, ref
);
238 struct IR
*ir
= rx
->ir
;
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()
246 ir
->l
.features
&= ~LIRC_CAN_REC_LIRCCODE
;
247 /* Don't put_ir_device(rx->ir) here; lock can't be freed yet */
249 /* Don't do the kfree(rx) here; we still need to kill the poll thread */
252 static int put_ir_rx(struct IR_rx
*rx
, bool ir_devices_lock_held
)
255 struct IR
*ir
= rx
->ir
;
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 */
262 destroy_rx_kthread(rx
, ir_devices_lock_held
);
264 /* Make sure we're not still in a poll_table somewhere */
265 wake_up_interruptible(&ir
->rbuf
.wait_poll
);
267 /* Do a reference put() for the rx->ir reference, if we released rx */
269 put_ir_device(ir
, ir_devices_lock_held
);
273 /* struct IR_tx reference counting */
274 static struct IR_tx
*get_ir_tx(struct IR
*ir
)
278 spin_lock(&ir
->tx_ref_lock
);
282 spin_unlock(&ir
->tx_ref_lock
);
286 static void release_ir_tx(struct kref
*ref
)
288 struct IR_tx
*tx
= container_of(ref
, struct IR_tx
, ref
);
289 struct IR
*ir
= tx
->ir
;
291 ir
->l
.features
&= ~LIRC_CAN_SEND_PULSE
;
292 /* Don't put_ir_device(tx->ir) here, so our lock doesn't get freed */
297 static int put_ir_tx(struct IR_tx
*tx
, bool ir_devices_lock_held
)
300 struct IR
*ir
= tx
->ir
;
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 */
307 put_ir_device(ir
, ir_devices_lock_held
);
311 static int add_to_buf(struct IR
*ir
)
314 unsigned char codes
[2];
315 unsigned char keybuf
[6];
319 unsigned char sendbuf
[1] = { 0 };
320 struct lirc_buffer
*rbuf
= ir
->l
.rbuf
;
324 if (lirc_buffer_full(rbuf
)) {
325 dev_dbg(ir
->l
.dev
, "buffer overflow\n");
333 /* Ensure our rx->c i2c_client remains valid for the duration */
334 mutex_lock(&rx
->client_lock
);
336 mutex_unlock(&rx
->client_lock
);
337 put_ir_rx(rx
, false);
344 * service the device as long as it is returning
345 * data and we have space
348 if (kthread_should_stop()) {
354 * Lock i2c bus for the duration. RX/TX chips interfere so
357 mutex_lock(&ir
->ir_lock
);
359 if (kthread_should_stop()) {
360 mutex_unlock(&ir
->ir_lock
);
366 * Send random "poll command" (?) Windows driver does this
367 * and it is a good point to detect chip failure.
369 ret
= i2c_master_send(rx
->c
, sendbuf
, 1);
371 dev_err(ir
->l
.dev
, "i2c_master_send failed with %d\n",
374 mutex_unlock(&ir
->ir_lock
);
375 dev_err(ir
->l
.dev
, "unable to read from the IR chip "
376 "after 3 resets, giving up\n");
380 /* Looks like the chip crashed, reset it */
381 dev_err(ir
->l
.dev
, "polling the IR receiver chip failed, "
384 set_current_state(TASK_UNINTERRUPTIBLE
);
385 if (kthread_should_stop()) {
386 mutex_unlock(&ir
->ir_lock
);
390 schedule_timeout((100 * HZ
+ 999) / 1000);
395 mutex_unlock(&ir
->ir_lock
);
400 if (kthread_should_stop()) {
401 mutex_unlock(&ir
->ir_lock
);
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
, "i2c_master_recv failed with %d -- "
409 "keeping last read buffer\n", ret
);
411 rx
->b
[0] = keybuf
[3];
412 rx
->b
[1] = keybuf
[4];
413 rx
->b
[2] = keybuf
[5];
414 dev_dbg(ir
->l
.dev
, "key (0x%02x/0x%02x)\n",
419 if (rx
->hdpvr_data_fmt
) {
420 if (got_data
&& (keybuf
[0] == 0x80)) {
423 } else if (got_data
&& (keybuf
[0] == 0x00)) {
427 } else if ((rx
->b
[0] & 0x80) == 0) {
428 ret
= got_data
? 0 : -ENODATA
;
432 /* look what we have */
433 code
= (((__u16
)rx
->b
[0] & 0x7f) << 6) | (rx
->b
[1] >> 2);
435 codes
[0] = (code
>> 8) & 0xff;
436 codes
[1] = code
& 0xff;
439 lirc_buffer_write(rbuf
, codes
);
442 } while (!lirc_buffer_full(rbuf
));
444 mutex_unlock(&rx
->client_lock
);
446 put_ir_tx(tx
, false);
447 put_ir_rx(rx
, false);
452 * Main function of the polling thread -- from lirc_dev.
453 * We don't fit the LIRC model at all anymore. This is horrible, but
454 * basically we have a single RX/TX device with a nasty failure mode
455 * that needs to be accounted for across the pair. lirc lets us provide
456 * fops, but prevents us from using the internal polling, etc. if we do
457 * so. Hence the replication. Might be neater to extend the LIRC model
458 * to account for this but I'd think it's a very special case of seriously
459 * messed up hardware.
461 static int lirc_thread(void *arg
)
464 struct lirc_buffer
*rbuf
= ir
->l
.rbuf
;
466 dev_dbg(ir
->l
.dev
, "poll thread started\n");
468 while (!kthread_should_stop()) {
469 set_current_state(TASK_INTERRUPTIBLE
);
471 /* if device not opened, we can sleep half a second */
472 if (atomic_read(&ir
->open_count
) == 0) {
473 schedule_timeout(HZ
/2);
478 * This is ~113*2 + 24 + jitter (2*repeat gap + code length).
479 * We use this interval as the chip resets every time you poll
480 * it (bad!). This is therefore just sufficient to catch all
481 * of the button presses. It makes the remote much more
482 * responsive. You can see the difference by running irw and
483 * holding down a button. With 100ms, the old polling
484 * interval, you'll notice breaks in the repeat sequence
485 * corresponding to lost keypresses.
487 schedule_timeout((260 * HZ
) / 1000);
488 if (kthread_should_stop())
491 wake_up_interruptible(&rbuf
->wait_poll
);
494 dev_dbg(ir
->l
.dev
, "poll thread ended\n");
498 static int set_use_inc(void *data
)
503 static void set_use_dec(void *data
)
507 /* safe read of a uint32 (always network byte order) */
508 static int read_uint32(unsigned char **data
,
509 unsigned char *endp
, unsigned int *val
)
511 if (*data
+ 4 > endp
)
513 *val
= ((*data
)[0] << 24) | ((*data
)[1] << 16) |
514 ((*data
)[2] << 8) | (*data
)[3];
519 /* safe read of a uint8 */
520 static int read_uint8(unsigned char **data
,
521 unsigned char *endp
, unsigned char *val
)
523 if (*data
+ 1 > endp
)
529 /* safe skipping of N bytes */
530 static int skip(unsigned char **data
,
531 unsigned char *endp
, unsigned int distance
)
533 if (*data
+ distance
> endp
)
539 /* decompress key data into the given buffer */
540 static int get_key_data(unsigned char *buf
,
541 unsigned int codeset
, unsigned int key
)
543 unsigned char *data
, *endp
, *diffs
, *key_block
;
544 unsigned char keys
, ndiffs
, id
;
545 unsigned int base
, lim
, pos
, i
;
547 /* Binary search for the codeset */
548 for (base
= 0, lim
= tx_data
->num_code_sets
; lim
; lim
>>= 1) {
549 pos
= base
+ (lim
>> 1);
550 data
= tx_data
->code_sets
[pos
];
552 if (!read_uint32(&data
, tx_data
->endp
, &i
))
557 else if (codeset
> i
) {
566 /* Set end of data block */
567 endp
= pos
< tx_data
->num_code_sets
- 1 ?
568 tx_data
->code_sets
[pos
+ 1] : tx_data
->endp
;
570 /* Read the block header */
571 if (!read_uint8(&data
, endp
, &keys
) ||
572 !read_uint8(&data
, endp
, &ndiffs
) ||
573 ndiffs
> TX_BLOCK_SIZE
|| keys
== 0)
576 /* Save diffs & skip */
578 if (!skip(&data
, endp
, ndiffs
))
581 /* Read the id of the first key */
582 if (!read_uint8(&data
, endp
, &id
))
585 /* Unpack the first key's data */
586 for (i
= 0; i
< TX_BLOCK_SIZE
; ++i
) {
587 if (tx_data
->fixed
[i
] == -1) {
588 if (!read_uint8(&data
, endp
, &buf
[i
]))
591 buf
[i
] = (unsigned char)tx_data
->fixed
[i
];
595 /* Early out key found/not found */
603 if (!skip(&data
, endp
, (keys
- 1) * (ndiffs
+ 1)))
606 /* Binary search for the key */
607 for (base
= 0, lim
= keys
- 1; lim
; lim
>>= 1) {
609 unsigned char *key_data
;
611 pos
= base
+ (lim
>> 1);
612 key_data
= key_block
+ (ndiffs
+ 1) * pos
;
614 if (*key_data
== key
) {
618 /* found, so unpack the diffs */
619 for (i
= 0; i
< ndiffs
; ++i
) {
622 if (!read_uint8(&key_data
, endp
, &val
) ||
623 diffs
[i
] >= TX_BLOCK_SIZE
)
629 } else if (key
> *key_data
) {
638 pr_err("firmware is corrupt\n");
642 /* send a block of data to the IR TX device */
643 static int send_data_block(struct IR_tx
*tx
, unsigned char *data_block
)
646 unsigned char buf
[5];
648 for (i
= 0; i
< TX_BLOCK_SIZE
;) {
649 int tosend
= TX_BLOCK_SIZE
- i
;
653 buf
[0] = (unsigned char)(i
+ 1);
654 for (j
= 0; j
< tosend
; ++j
)
655 buf
[1 + j
] = data_block
[i
+ j
];
656 dev_dbg(tx
->ir
->l
.dev
, "%*ph", 5, buf
);
657 ret
= i2c_master_send(tx
->c
, buf
, tosend
+ 1);
658 if (ret
!= tosend
+ 1) {
659 dev_err(tx
->ir
->l
.dev
, "i2c_master_send failed with %d\n",
661 return ret
< 0 ? ret
: -EFAULT
;
668 /* send boot data to the IR TX device */
669 static int send_boot_data(struct IR_tx
*tx
)
672 unsigned char buf
[4];
674 /* send the boot block */
675 ret
= send_data_block(tx
, tx_data
->boot_data
);
679 /* Hit the go button to activate the new boot data */
682 ret
= i2c_master_send(tx
->c
, buf
, 2);
684 dev_err(tx
->ir
->l
.dev
, "i2c_master_send failed with %d\n", ret
);
685 return ret
< 0 ? ret
: -EFAULT
;
689 * Wait for zilog to settle after hitting go post boot block upload.
690 * Without this delay, the HD-PVR and HVR-1950 both return an -EIO
691 * upon attempting to get firmware revision, and tx probe thus fails.
693 for (i
= 0; i
< 10; i
++) {
694 ret
= i2c_master_send(tx
->c
, buf
, 1);
701 dev_err(tx
->ir
->l
.dev
, "i2c_master_send failed with %d\n", ret
);
702 return ret
< 0 ? ret
: -EFAULT
;
705 /* Here comes the firmware version... (hopefully) */
706 ret
= i2c_master_recv(tx
->c
, buf
, 4);
708 dev_err(tx
->ir
->l
.dev
, "i2c_master_recv failed with %d\n", ret
);
711 if ((buf
[0] != 0x80) && (buf
[0] != 0xa0)) {
712 dev_err(tx
->ir
->l
.dev
, "unexpected IR TX init response: %02x\n",
716 dev_notice(tx
->ir
->l
.dev
, "Zilog/Hauppauge IR blaster firmware version "
717 "%d.%d.%d loaded\n", buf
[1], buf
[2], buf
[3]);
722 /* unload "firmware", lock held */
723 static void fw_unload_locked(void)
726 vfree(tx_data
->code_sets
);
728 vfree(tx_data
->datap
);
732 pr_debug("successfully unloaded IR blaster firmware\n");
736 /* unload "firmware" for the IR TX device */
737 static void fw_unload(void)
739 mutex_lock(&tx_data_lock
);
741 mutex_unlock(&tx_data_lock
);
744 /* load "firmware" for the IR TX device */
745 static int fw_load(struct IR_tx
*tx
)
749 unsigned char *data
, version
, num_global_fixed
;
750 const struct firmware
*fw_entry
;
752 /* Already loaded? */
753 mutex_lock(&tx_data_lock
);
759 /* Request codeset data file */
760 ret
= request_firmware(&fw_entry
, "haup-ir-blaster.bin", tx
->ir
->l
.dev
);
762 dev_err(tx
->ir
->l
.dev
, "firmware haup-ir-blaster.bin not available (%d)\n",
764 ret
= ret
< 0 ? ret
: -EFAULT
;
767 dev_dbg(tx
->ir
->l
.dev
, "firmware of size %zu loaded\n", fw_entry
->size
);
770 tx_data
= vmalloc(sizeof(*tx_data
));
771 if (tx_data
== NULL
) {
772 release_firmware(fw_entry
);
776 tx_data
->code_sets
= NULL
;
778 /* Copy the data so hotplug doesn't get confused and timeout */
779 tx_data
->datap
= vmalloc(fw_entry
->size
);
780 if (tx_data
->datap
== NULL
) {
781 release_firmware(fw_entry
);
786 memcpy(tx_data
->datap
, fw_entry
->data
, fw_entry
->size
);
787 tx_data
->endp
= tx_data
->datap
+ fw_entry
->size
;
788 release_firmware(fw_entry
); fw_entry
= NULL
;
791 data
= tx_data
->datap
;
792 if (!read_uint8(&data
, tx_data
->endp
, &version
))
795 dev_err(tx
->ir
->l
.dev
, "unsupported code set file version (%u, expected"
796 "1) -- please upgrade to a newer driver",
803 /* Save boot block for later */
804 tx_data
->boot_data
= data
;
805 if (!skip(&data
, tx_data
->endp
, TX_BLOCK_SIZE
))
808 if (!read_uint32(&data
, tx_data
->endp
,
809 &tx_data
->num_code_sets
))
812 dev_dbg(tx
->ir
->l
.dev
, "%u IR blaster codesets loaded\n",
813 tx_data
->num_code_sets
);
815 tx_data
->code_sets
= vmalloc(
816 tx_data
->num_code_sets
* sizeof(char *));
817 if (tx_data
->code_sets
== NULL
) {
823 for (i
= 0; i
< TX_BLOCK_SIZE
; ++i
)
824 tx_data
->fixed
[i
] = -1;
826 /* Read global fixed data template */
827 if (!read_uint8(&data
, tx_data
->endp
, &num_global_fixed
) ||
828 num_global_fixed
> TX_BLOCK_SIZE
)
830 for (i
= 0; i
< num_global_fixed
; ++i
) {
831 unsigned char pos
, val
;
833 if (!read_uint8(&data
, tx_data
->endp
, &pos
) ||
834 !read_uint8(&data
, tx_data
->endp
, &val
) ||
835 pos
>= TX_BLOCK_SIZE
)
837 tx_data
->fixed
[pos
] = (int)val
;
840 /* Filch out the position of each code set */
841 for (i
= 0; i
< tx_data
->num_code_sets
; ++i
) {
844 unsigned char ndiffs
;
846 /* Save the codeset position */
847 tx_data
->code_sets
[i
] = data
;
850 if (!read_uint32(&data
, tx_data
->endp
, &id
) ||
851 !read_uint8(&data
, tx_data
->endp
, &keys
) ||
852 !read_uint8(&data
, tx_data
->endp
, &ndiffs
) ||
853 ndiffs
> TX_BLOCK_SIZE
|| keys
== 0)
856 /* skip diff positions */
857 if (!skip(&data
, tx_data
->endp
, ndiffs
))
861 * After the diffs we have the first key id + data -
864 if (!skip(&data
, tx_data
->endp
,
865 1 + TX_BLOCK_SIZE
- num_global_fixed
))
868 /* Then we have keys-1 blocks of key id+diffs */
869 if (!skip(&data
, tx_data
->endp
,
870 (ndiffs
+ 1) * (keys
- 1)))
877 dev_err(tx
->ir
->l
.dev
, "firmware is corrupt\n");
882 mutex_unlock(&tx_data_lock
);
886 /* copied from lirc_dev */
887 static ssize_t
read(struct file
*filep
, char __user
*outbuf
, size_t n
,
890 struct IR
*ir
= filep
->private_data
;
892 struct lirc_buffer
*rbuf
= ir
->l
.rbuf
;
893 int ret
= 0, written
= 0, retries
= 0;
895 DECLARE_WAITQUEUE(wait
, current
);
897 dev_dbg(ir
->l
.dev
, "read called\n");
898 if (n
% rbuf
->chunk_size
) {
899 dev_dbg(ir
->l
.dev
, "read result = -EINVAL\n");
908 * we add ourselves to the task queue before buffer check
909 * to avoid losing scan code (in case when queue is awaken somewhere
910 * between while condition checking and scheduling)
912 add_wait_queue(&rbuf
->wait_poll
, &wait
);
913 set_current_state(TASK_INTERRUPTIBLE
);
916 * while we didn't provide 'length' bytes, device is opened in blocking
917 * mode and 'copy_to_user' is happy, wait for data.
919 while (written
< n
&& ret
== 0) {
920 if (lirc_buffer_empty(rbuf
)) {
922 * According to the read(2) man page, 'written' can be
923 * returned as less than 'n', instead of blocking
924 * again, returning -EWOULDBLOCK, or returning
929 if (filep
->f_flags
& O_NONBLOCK
) {
933 if (signal_pending(current
)) {
938 set_current_state(TASK_INTERRUPTIBLE
);
940 unsigned char buf
[MAX_XFER_SIZE
];
942 if (rbuf
->chunk_size
> sizeof(buf
)) {
943 dev_err(ir
->l
.dev
, "chunk_size is too big (%d)!\n",
948 m
= lirc_buffer_read(rbuf
, buf
);
949 if (m
== rbuf
->chunk_size
) {
950 ret
= copy_to_user(outbuf
+ written
, buf
,
952 written
+= rbuf
->chunk_size
;
957 dev_err(ir
->l
.dev
, "Buffer read failed!\n");
963 remove_wait_queue(&rbuf
->wait_poll
, &wait
);
964 put_ir_rx(rx
, false);
965 set_current_state(TASK_RUNNING
);
967 dev_dbg(ir
->l
.dev
, "read result = %d (%s)\n",
968 ret
, ret
? "Error" : "OK");
970 return ret
? ret
: written
;
973 /* send a keypress to the IR TX device */
974 static int send_code(struct IR_tx
*tx
, unsigned int code
, unsigned int key
)
976 unsigned char data_block
[TX_BLOCK_SIZE
];
977 unsigned char buf
[2];
980 /* Get data for the codeset/key */
981 ret
= get_key_data(data_block
, code
, key
);
983 if (ret
== -EPROTO
) {
984 dev_err(tx
->ir
->l
.dev
, "failed to get data for code %u, key %u -- check "
985 "lircd.conf entries\n", code
, key
);
990 /* Send the data block */
991 ret
= send_data_block(tx
, data_block
);
995 /* Send data block length? */
998 ret
= i2c_master_send(tx
->c
, buf
, 2);
1000 dev_err(tx
->ir
->l
.dev
, "i2c_master_send failed with %d\n", ret
);
1001 return ret
< 0 ? ret
: -EFAULT
;
1004 /* Give the z8 a moment to process data block */
1005 for (i
= 0; i
< 10; i
++) {
1006 ret
= i2c_master_send(tx
->c
, buf
, 1);
1013 dev_err(tx
->ir
->l
.dev
, "i2c_master_send failed with %d\n", ret
);
1014 return ret
< 0 ? ret
: -EFAULT
;
1017 /* Send finished download? */
1018 ret
= i2c_master_recv(tx
->c
, buf
, 1);
1020 dev_err(tx
->ir
->l
.dev
, "i2c_master_recv failed with %d\n", ret
);
1021 return ret
< 0 ? ret
: -EFAULT
;
1023 if (buf
[0] != 0xA0) {
1024 dev_err(tx
->ir
->l
.dev
, "unexpected IR TX response #1: %02x\n",
1029 /* Send prepare command? */
1032 ret
= i2c_master_send(tx
->c
, buf
, 2);
1034 dev_err(tx
->ir
->l
.dev
, "i2c_master_send failed with %d\n", ret
);
1035 return ret
< 0 ? ret
: -EFAULT
;
1039 * The sleep bits aren't necessary on the HD PVR, and in fact, the
1040 * last i2c_master_recv always fails with a -5, so for now, we're
1041 * going to skip this whole mess and say we're done on the HD PVR
1043 if (!tx
->post_tx_ready_poll
) {
1044 dev_dbg(tx
->ir
->l
.dev
, "sent code %u, key %u\n", code
, key
);
1049 * This bit NAKs until the device is ready, so we retry it
1050 * sleeping a bit each time. This seems to be what the windows
1051 * driver does, approximately.
1054 for (i
= 0; i
< 20; ++i
) {
1055 set_current_state(TASK_UNINTERRUPTIBLE
);
1056 schedule_timeout((50 * HZ
+ 999) / 1000);
1057 ret
= i2c_master_send(tx
->c
, buf
, 1);
1060 dev_dbg(tx
->ir
->l
.dev
, "NAK expected: i2c_master_send "
1061 "failed with %d (try %d)\n", ret
, i
+1);
1064 dev_err(tx
->ir
->l
.dev
, "IR TX chip never got ready: last i2c_master_send "
1065 "failed with %d\n", ret
);
1066 return ret
< 0 ? ret
: -EFAULT
;
1069 /* Seems to be an 'ok' response */
1070 i
= i2c_master_recv(tx
->c
, buf
, 1);
1072 dev_err(tx
->ir
->l
.dev
, "i2c_master_recv failed with %d\n", ret
);
1075 if (buf
[0] != 0x80) {
1076 dev_err(tx
->ir
->l
.dev
, "unexpected IR TX response #2: %02x\n",
1081 /* Oh good, it worked */
1082 dev_dbg(tx
->ir
->l
.dev
, "sent code %u, key %u\n", code
, key
);
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.
1092 static ssize_t
write(struct file
*filep
, const char __user
*buf
, size_t n
,
1095 struct IR
*ir
= filep
->private_data
;
1100 /* Validate user parameters */
1101 if (n
% sizeof(int))
1104 /* Get a struct IR_tx reference */
1109 /* Ensure our tx->c i2c_client remains valid for the duration */
1110 mutex_lock(&tx
->client_lock
);
1111 if (tx
->c
== NULL
) {
1112 mutex_unlock(&tx
->client_lock
);
1113 put_ir_tx(tx
, false);
1117 /* Lock i2c bus for the duration */
1118 mutex_lock(&ir
->ir_lock
);
1120 /* Send each keypress */
1121 for (i
= 0; i
< n
;) {
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);
1132 /* Send boot data first if required */
1133 if (tx
->need_boot
== 1) {
1134 /* Make sure we have the 'firmware' loaded, first */
1137 mutex_unlock(&ir
->ir_lock
);
1138 mutex_unlock(&tx
->client_lock
);
1139 put_ir_tx(tx
, false);
1144 /* Prep the chip for transmitting codes */
1145 ret
= send_boot_data(tx
);
1152 ret
= send_code(tx
, (unsigned)command
>> 16,
1153 (unsigned)command
& 0xFFFF);
1154 if (ret
== -EPROTO
) {
1155 mutex_unlock(&ir
->ir_lock
);
1156 mutex_unlock(&tx
->client_lock
);
1157 put_ir_tx(tx
, false);
1163 * Hmm, a failure. If we've had a few then give up, otherwise
1167 /* Looks like the chip crashed, reset it */
1168 dev_err(tx
->ir
->l
.dev
, "sending to the IR transmitter chip "
1169 "failed, trying reset\n");
1171 if (failures
>= 3) {
1172 dev_err(tx
->ir
->l
.dev
, "unable to send to the IR chip "
1173 "after 3 resets, giving up\n");
1174 mutex_unlock(&ir
->ir_lock
);
1175 mutex_unlock(&tx
->client_lock
);
1176 put_ir_tx(tx
, false);
1179 set_current_state(TASK_UNINTERRUPTIBLE
);
1180 schedule_timeout((100 * HZ
+ 999) / 1000);
1187 /* Release i2c bus */
1188 mutex_unlock(&ir
->ir_lock
);
1190 mutex_unlock(&tx
->client_lock
);
1192 /* Give back our struct IR_tx reference */
1193 put_ir_tx(tx
, false);
1195 /* All looks good */
1199 /* copied from lirc_dev */
1200 static unsigned int poll(struct file
*filep
, poll_table
*wait
)
1202 struct IR
*ir
= filep
->private_data
;
1204 struct lirc_buffer
*rbuf
= ir
->l
.rbuf
;
1207 dev_dbg(ir
->l
.dev
, "poll called\n");
1212 * Revisit this, if our poll function ever reports writeable
1215 dev_dbg(ir
->l
.dev
, "poll result = POLLERR\n");
1220 * Add our lirc_buffer's wait_queue to the poll_table. A wake up on
1221 * that buffer's wait queue indicates we may have a new poll status.
1223 poll_wait(filep
, &rbuf
->wait_poll
, wait
);
1225 /* Indicate what ops could happen immediately without blocking */
1226 ret
= lirc_buffer_empty(rbuf
) ? 0 : (POLLIN
|POLLRDNORM
);
1228 dev_dbg(ir
->l
.dev
, "poll result = %s\n",
1229 ret
? "POLLIN|POLLRDNORM" : "none");
1233 static long ioctl(struct file
*filep
, unsigned int cmd
, unsigned long arg
)
1235 struct IR
*ir
= filep
->private_data
;
1236 unsigned long __user
*uptr
= (unsigned long __user
*)arg
;
1238 unsigned long mode
, features
;
1240 features
= ir
->l
.features
;
1243 case LIRC_GET_LENGTH
:
1244 result
= put_user(13UL, uptr
);
1246 case LIRC_GET_FEATURES
:
1247 result
= put_user(features
, uptr
);
1249 case LIRC_GET_REC_MODE
:
1250 if (!(features
&LIRC_CAN_REC_MASK
))
1253 result
= put_user(LIRC_REC2MODE
1254 (features
&LIRC_CAN_REC_MASK
),
1257 case LIRC_SET_REC_MODE
:
1258 if (!(features
&LIRC_CAN_REC_MASK
))
1261 result
= get_user(mode
, uptr
);
1262 if (!result
&& !(LIRC_MODE2REC(mode
) & features
))
1265 case LIRC_GET_SEND_MODE
:
1266 if (!(features
&LIRC_CAN_SEND_MASK
))
1269 result
= put_user(LIRC_MODE_PULSE
, uptr
);
1271 case LIRC_SET_SEND_MODE
:
1272 if (!(features
&LIRC_CAN_SEND_MASK
))
1275 result
= get_user(mode
, uptr
);
1276 if (!result
&& mode
!= LIRC_MODE_PULSE
)
1285 static struct IR
*get_ir_device_by_minor(unsigned int minor
)
1288 struct IR
*ret
= NULL
;
1290 mutex_lock(&ir_devices_lock
);
1292 if (!list_empty(&ir_devices_list
)) {
1293 list_for_each_entry(ir
, &ir_devices_list
, list
) {
1294 if (ir
->l
.minor
== minor
) {
1295 ret
= get_ir_device(ir
, true);
1301 mutex_unlock(&ir_devices_lock
);
1306 * Open the IR device. Get hold of our IR structure and
1307 * stash it in private_data for the file
1309 static int open(struct inode
*node
, struct file
*filep
)
1312 unsigned int minor
= MINOR(node
->i_rdev
);
1314 /* find our IR struct */
1315 ir
= get_ir_device_by_minor(minor
);
1320 atomic_inc(&ir
->open_count
);
1322 /* stash our IR struct */
1323 filep
->private_data
= ir
;
1325 nonseekable_open(node
, filep
);
1329 /* Close the IR device */
1330 static int close(struct inode
*node
, struct file
*filep
)
1332 /* find our IR struct */
1333 struct IR
*ir
= filep
->private_data
;
1336 dev_err(ir
->l
.dev
, "close: no private_data attached to the file!\n");
1340 atomic_dec(&ir
->open_count
);
1342 put_ir_device(ir
, false);
1346 static int ir_remove(struct i2c_client
*client
);
1347 static int ir_probe(struct i2c_client
*client
, const struct i2c_device_id
*id
);
1349 #define ID_FLAG_TX 0x01
1350 #define ID_FLAG_HDPVR 0x02
1352 static const struct i2c_device_id ir_transceiver_id
[] = {
1353 { "ir_tx_z8f0811_haup", ID_FLAG_TX
},
1354 { "ir_rx_z8f0811_haup", 0 },
1355 { "ir_tx_z8f0811_hdpvr", ID_FLAG_HDPVR
| ID_FLAG_TX
},
1356 { "ir_rx_z8f0811_hdpvr", ID_FLAG_HDPVR
},
1360 static struct i2c_driver driver
= {
1362 .owner
= THIS_MODULE
,
1363 .name
= "Zilog/Hauppauge i2c IR",
1366 .remove
= ir_remove
,
1367 .id_table
= ir_transceiver_id
,
1370 static const struct file_operations lirc_fops
= {
1371 .owner
= THIS_MODULE
,
1372 .llseek
= no_llseek
,
1376 .unlocked_ioctl
= ioctl
,
1377 #ifdef CONFIG_COMPAT
1378 .compat_ioctl
= ioctl
,
1384 static struct lirc_driver lirc_template
= {
1385 .name
= "lirc_zilog",
1388 .buffer_size
= BUFLEN
/ 2,
1389 .sample_rate
= 0, /* tell lirc_dev to not start its own kthread */
1391 .set_use_inc
= set_use_inc
,
1392 .set_use_dec
= set_use_dec
,
1394 .owner
= THIS_MODULE
,
1397 static int ir_remove(struct i2c_client
*client
)
1399 if (strncmp("ir_tx_z8", client
->name
, 8) == 0) {
1400 struct IR_tx
*tx
= i2c_get_clientdata(client
);
1403 mutex_lock(&tx
->client_lock
);
1405 mutex_unlock(&tx
->client_lock
);
1406 put_ir_tx(tx
, false);
1408 } else if (strncmp("ir_rx_z8", client
->name
, 8) == 0) {
1409 struct IR_rx
*rx
= i2c_get_clientdata(client
);
1412 mutex_lock(&rx
->client_lock
);
1414 mutex_unlock(&rx
->client_lock
);
1415 put_ir_rx(rx
, false);
1422 /* ir_devices_lock must be held */
1423 static struct IR
*get_ir_device_by_adapter(struct i2c_adapter
*adapter
)
1427 if (list_empty(&ir_devices_list
))
1430 list_for_each_entry(ir
, &ir_devices_list
, list
)
1431 if (ir
->adapter
== adapter
) {
1432 get_ir_device(ir
, true);
1439 static int ir_probe(struct i2c_client
*client
, const struct i2c_device_id
*id
)
1444 struct i2c_adapter
*adap
= client
->adapter
;
1446 bool tx_probe
= false;
1448 dev_dbg(&client
->dev
, "%s: %s on i2c-%d (%s), client addr=0x%02x\n",
1449 __func__
, id
->name
, adap
->nr
, adap
->name
, client
->addr
);
1452 * The IR receiver is at i2c address 0x71.
1453 * The IR transmitter is at i2c address 0x70.
1456 if (id
->driver_data
& ID_FLAG_TX
)
1458 else if (tx_only
) /* module option */
1461 pr_info("probing IR %s on %s (i2c-%d)\n",
1462 tx_probe
? "Tx" : "Rx", adap
->name
, adap
->nr
);
1464 mutex_lock(&ir_devices_lock
);
1466 /* Use a single struct IR instance for both the Rx and Tx functions */
1467 ir
= get_ir_device_by_adapter(adap
);
1469 ir
= kzalloc(sizeof(struct IR
), GFP_KERNEL
);
1474 kref_init(&ir
->ref
);
1476 /* store for use in ir_probe() again, and open() later on */
1477 INIT_LIST_HEAD(&ir
->list
);
1478 list_add_tail(&ir
->list
, &ir_devices_list
);
1481 mutex_init(&ir
->ir_lock
);
1482 atomic_set(&ir
->open_count
, 0);
1483 spin_lock_init(&ir
->tx_ref_lock
);
1484 spin_lock_init(&ir
->rx_ref_lock
);
1486 /* set lirc_dev stuff */
1487 memcpy(&ir
->l
, &lirc_template
, sizeof(struct lirc_driver
));
1489 * FIXME this is a pointer reference to us, but no refcount.
1491 * This OK for now, since lirc_dev currently won't touch this
1492 * buffer as we provide our own lirc_fops.
1494 * Currently our own lirc_fops rely on this ir->l.rbuf pointer
1496 ir
->l
.rbuf
= &ir
->rbuf
;
1497 ir
->l
.dev
= &adap
->dev
;
1498 ret
= lirc_buffer_init(ir
->l
.rbuf
,
1499 ir
->l
.chunk_size
, ir
->l
.buffer_size
);
1505 /* Get the IR_rx instance for later, if already allocated */
1508 /* Set up a struct IR_tx instance */
1509 tx
= kzalloc(sizeof(struct IR_tx
), GFP_KERNEL
);
1514 kref_init(&tx
->ref
);
1517 ir
->l
.features
|= LIRC_CAN_SEND_PULSE
;
1518 mutex_init(&tx
->client_lock
);
1521 tx
->post_tx_ready_poll
=
1522 (id
->driver_data
& ID_FLAG_HDPVR
) ? false : true;
1524 /* An ir ref goes to the struct IR_tx instance */
1525 tx
->ir
= get_ir_device(ir
, true);
1527 /* A tx ref goes to the i2c_client */
1528 i2c_set_clientdata(client
, get_ir_tx(ir
));
1531 * Load the 'firmware'. We do this before registering with
1532 * lirc_dev, so the first firmware load attempt does not happen
1533 * after a open() or write() call on the device.
1535 * Failure here is not deemed catastrophic, so the receiver will
1536 * still be usable. Firmware load will be retried in write(),
1541 /* Proceed only if the Rx client is also ready or not needed */
1542 if (rx
== NULL
&& !tx_only
) {
1543 dev_info(tx
->ir
->l
.dev
, "probe of IR Tx on %s (i2c-%d) done. Waiting"
1544 " on IR Rx.\n", adap
->name
, adap
->nr
);
1548 /* Get the IR_tx instance for later, if already allocated */
1551 /* Set up a struct IR_rx instance */
1552 rx
= kzalloc(sizeof(struct IR_rx
), GFP_KERNEL
);
1557 kref_init(&rx
->ref
);
1560 ir
->l
.features
|= LIRC_CAN_REC_LIRCCODE
;
1561 mutex_init(&rx
->client_lock
);
1563 rx
->hdpvr_data_fmt
=
1564 (id
->driver_data
& ID_FLAG_HDPVR
) ? true : false;
1566 /* An ir ref goes to the struct IR_rx instance */
1567 rx
->ir
= get_ir_device(ir
, true);
1569 /* An rx ref goes to the i2c_client */
1570 i2c_set_clientdata(client
, get_ir_rx(ir
));
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()
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
, "%s: could not start IR Rx polling thread"
1584 /* Failed kthread, so put back the ir ref */
1585 put_ir_device(ir
, true);
1586 /* Failure exit, so put back rx ref from i2c_client */
1587 i2c_set_clientdata(client
, NULL
);
1588 put_ir_rx(rx
, true);
1589 ir
->l
.features
&= ~LIRC_CAN_REC_LIRCCODE
;
1593 /* Proceed only if the Tx client is also ready */
1595 pr_info("probe of IR Rx on %s (i2c-%d) done. Waiting"
1596 " on IR Tx.\n", adap
->name
, adap
->nr
);
1601 /* register with lirc */
1602 ir
->l
.minor
= minor
; /* module option: user requested minor number */
1603 ir
->l
.minor
= lirc_register_driver(&ir
->l
);
1604 if (ir
->l
.minor
< 0 || ir
->l
.minor
>= MAX_IRCTL_DEVICES
) {
1605 dev_err(tx
->ir
->l
.dev
, "%s: \"minor\" must be between 0 and %d (%d)!\n",
1606 __func__
, MAX_IRCTL_DEVICES
-1, ir
->l
.minor
);
1610 dev_info(ir
->l
.dev
, "IR unit on %s (i2c-%d) registered as lirc%d and ready\n",
1611 adap
->name
, adap
->nr
, ir
->l
.minor
);
1615 put_ir_rx(rx
, true);
1617 put_ir_tx(tx
, true);
1618 put_ir_device(ir
, true);
1619 dev_info(ir
->l
.dev
, "probe of IR %s on %s (i2c-%d) done\n",
1620 tx_probe
? "Tx" : "Rx", adap
->name
, adap
->nr
);
1621 mutex_unlock(&ir_devices_lock
);
1626 put_ir_rx(rx
, true);
1628 put_ir_tx(tx
, true);
1630 put_ir_device(ir
, true);
1632 dev_err(&client
->dev
, "%s: probing IR %s on %s (i2c-%d) failed with %d\n",
1633 __func__
, tx_probe
? "Tx" : "Rx", adap
->name
, adap
->nr
,
1635 mutex_unlock(&ir_devices_lock
);
1639 static int __init
zilog_init(void)
1643 pr_notice("Zilog/Hauppauge IR driver initializing\n");
1645 mutex_init(&tx_data_lock
);
1647 request_module("firmware_class");
1649 ret
= i2c_add_driver(&driver
);
1651 pr_err("initialization failed\n");
1653 pr_notice("initialization complete\n");
1658 static void __exit
zilog_exit(void)
1660 i2c_del_driver(&driver
);
1663 pr_notice("Zilog/Hauppauge IR driver unloaded\n");
1666 module_init(zilog_init
);
1667 module_exit(zilog_exit
);
1669 MODULE_DESCRIPTION("Zilog/Hauppauge infrared transmitter driver (i2c stack)");
1670 MODULE_AUTHOR("Gerd Knorr, Michal Kochanowicz, Christoph Bartelmus, "
1671 "Ulrich Mueller, Stefan Jahn, Jerome Brock, Mark Weaver, "
1673 MODULE_LICENSE("GPL");
1674 /* for compat with old name, which isn't all that accurate anymore */
1675 MODULE_ALIAS("lirc_pvr150");
1677 module_param(minor
, int, 0444);
1678 MODULE_PARM_DESC(minor
, "Preferred minor device number");
1680 module_param(debug
, bool, 0644);
1681 MODULE_PARM_DESC(debug
, "Enable debugging messages");
1683 module_param(tx_only
, bool, 0644);
1684 MODULE_PARM_DESC(tx_only
, "Only handle the IR transmit function");