4 * lirc_serial - Device driver that records pulse- and pause-lengths
5 * (space-lengths) between DDCD event on a serial port.
7 * Copyright (C) 1996,97 Ralph Metzler <rjkm@thp.uni-koeln.de>
8 * Copyright (C) 1998 Trent Piepho <xyzzy@u.washington.edu>
9 * Copyright (C) 1998 Ben Pfaff <blp@gnu.org>
10 * Copyright (C) 1999 Christoph Bartelmus <lirc@bartelmus.de>
11 * Copyright (C) 2007 Andrei Tanas <andrei@tanas.ca> (suspend/resume support)
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 * Steve's changes to improve transmission fidelity:
30 * - for systems with the rdtsc instruction and the clock counter, a
31 * send_pule that times the pulses directly using the counter.
32 * This means that the LIRC_SERIAL_TRANSMITTER_LATENCY fudge is
33 * not needed. Measurement shows very stable waveform, even where
34 * PCI activity slows the access to the UART, which trips up other
36 * - For other system, non-integer-microsecond pulse/space lengths,
37 * done using fixed point binary. So, much more accurate carrier
39 * - fine tuned transmitter latency, taking advantage of fractional
40 * microseconds in previous change
41 * - Fixed bug in the way transmitter latency was accounted for by
42 * tuning the pulse lengths down - the send_pulse routine ignored
43 * this overhead as it timed the overall pulse length - so the
44 * pulse frequency was right but overall pulse length was too
45 * long. Fixed by accounting for latency on each pulse/space
48 * Steve Davies <steve@daviesfam.org> July 2001
51 #include <linux/module.h>
52 #include <linux/errno.h>
53 #include <linux/signal.h>
54 #include <linux/sched.h>
56 #include <linux/interrupt.h>
57 #include <linux/ioport.h>
58 #include <linux/kernel.h>
59 #include <linux/serial_reg.h>
60 #include <linux/time.h>
61 #include <linux/string.h>
62 #include <linux/types.h>
63 #include <linux/wait.h>
65 #include <linux/delay.h>
66 #include <linux/poll.h>
67 #include <linux/platform_device.h>
70 #include <linux/irq.h>
71 #include <linux/fcntl.h>
72 #include <linux/spinlock.h>
74 #ifdef CONFIG_LIRC_SERIAL_NSLU2
75 #include <asm/hardware.h>
77 /* From Intel IXP42X Developer's Manual (#252480-005): */
78 /* ftp://download.intel.com/design/network/manuals/25248005.pdf */
79 #define UART_IE_IXP42X_UUE 0x40 /* IXP42X UART Unit enable */
80 #define UART_IE_IXP42X_RTOIE 0x10 /* IXP42X Receiver Data Timeout int.enable */
82 #include <media/lirc.h>
83 #include <media/lirc_dev.h>
85 #define LIRC_DRIVER_NAME "lirc_serial"
89 int signal_pin_change;
92 long (*send_pulse)(unsigned long length);
93 void (*send_space)(long length);
98 #define LIRC_HOMEBREW 0
100 #define LIRC_IRDEO_REMOTE 2
101 #define LIRC_ANIMAX 3
105 /*** module parameters ***/
111 static bool softcarrier = 1;
112 static bool share_irq;
114 static int sense = -1; /* -1 = auto, 0 = active high, 1 = active low */
115 static bool txsense; /* 0 = active high, 1 = active low */
117 #define dprintk(fmt, args...) \
120 printk(KERN_DEBUG LIRC_DRIVER_NAME ": " \
124 /* forward declarations */
125 static long send_pulse_irdeo(unsigned long length);
126 static long send_pulse_homebrew(unsigned long length);
127 static void send_space_irdeo(long length);
128 static void send_space_homebrew(long length);
130 static struct lirc_serial hardware[] = {
132 .lock = __SPIN_LOCK_UNLOCKED(hardware[LIRC_HOMEBREW].lock),
133 .signal_pin = UART_MSR_DCD,
134 .signal_pin_change = UART_MSR_DDCD,
135 .on = (UART_MCR_RTS | UART_MCR_OUT2 | UART_MCR_DTR),
136 .off = (UART_MCR_RTS | UART_MCR_OUT2),
137 .send_pulse = send_pulse_homebrew,
138 .send_space = send_space_homebrew,
139 #ifdef CONFIG_LIRC_SERIAL_TRANSMITTER
140 .features = (LIRC_CAN_SET_SEND_DUTY_CYCLE |
141 LIRC_CAN_SET_SEND_CARRIER |
142 LIRC_CAN_SEND_PULSE | LIRC_CAN_REC_MODE2)
144 .features = LIRC_CAN_REC_MODE2
149 .lock = __SPIN_LOCK_UNLOCKED(hardware[LIRC_IRDEO].lock),
150 .signal_pin = UART_MSR_DSR,
151 .signal_pin_change = UART_MSR_DDSR,
153 .off = (UART_MCR_RTS | UART_MCR_DTR | UART_MCR_OUT2),
154 .send_pulse = send_pulse_irdeo,
155 .send_space = send_space_irdeo,
156 .features = (LIRC_CAN_SET_SEND_DUTY_CYCLE |
157 LIRC_CAN_SEND_PULSE | LIRC_CAN_REC_MODE2)
160 [LIRC_IRDEO_REMOTE] = {
161 .lock = __SPIN_LOCK_UNLOCKED(hardware[LIRC_IRDEO_REMOTE].lock),
162 .signal_pin = UART_MSR_DSR,
163 .signal_pin_change = UART_MSR_DDSR,
164 .on = (UART_MCR_RTS | UART_MCR_DTR | UART_MCR_OUT2),
165 .off = (UART_MCR_RTS | UART_MCR_DTR | UART_MCR_OUT2),
166 .send_pulse = send_pulse_irdeo,
167 .send_space = send_space_irdeo,
168 .features = (LIRC_CAN_SET_SEND_DUTY_CYCLE |
169 LIRC_CAN_SEND_PULSE | LIRC_CAN_REC_MODE2)
173 .lock = __SPIN_LOCK_UNLOCKED(hardware[LIRC_ANIMAX].lock),
174 .signal_pin = UART_MSR_DCD,
175 .signal_pin_change = UART_MSR_DDCD,
177 .off = (UART_MCR_RTS | UART_MCR_DTR | UART_MCR_OUT2),
180 .features = LIRC_CAN_REC_MODE2
184 .lock = __SPIN_LOCK_UNLOCKED(hardware[LIRC_IGOR].lock),
185 .signal_pin = UART_MSR_DSR,
186 .signal_pin_change = UART_MSR_DDSR,
187 .on = (UART_MCR_RTS | UART_MCR_OUT2 | UART_MCR_DTR),
188 .off = (UART_MCR_RTS | UART_MCR_OUT2),
189 .send_pulse = send_pulse_homebrew,
190 .send_space = send_space_homebrew,
191 #ifdef CONFIG_LIRC_SERIAL_TRANSMITTER
192 .features = (LIRC_CAN_SET_SEND_DUTY_CYCLE |
193 LIRC_CAN_SET_SEND_CARRIER |
194 LIRC_CAN_SEND_PULSE | LIRC_CAN_REC_MODE2)
196 .features = LIRC_CAN_REC_MODE2
200 #ifdef CONFIG_LIRC_SERIAL_NSLU2
202 * Modified Linksys Network Storage Link USB 2.0 (NSLU2):
203 * We receive on CTS of the 2nd serial port (R142,LHS), we
204 * transmit with a IR diode between GPIO[1] (green status LED),
205 * and ground (Matthias Goebl <matthias.goebl@goebl.net>).
206 * See also http://www.nslu2-linux.org for this device
209 .lock = __SPIN_LOCK_UNLOCKED(hardware[LIRC_NSLU2].lock),
210 .signal_pin = UART_MSR_CTS,
211 .signal_pin_change = UART_MSR_DCTS,
212 .on = (UART_MCR_RTS | UART_MCR_OUT2 | UART_MCR_DTR),
213 .off = (UART_MCR_RTS | UART_MCR_OUT2),
214 .send_pulse = send_pulse_homebrew,
215 .send_space = send_space_homebrew,
216 #ifdef CONFIG_LIRC_SERIAL_TRANSMITTER
217 .features = (LIRC_CAN_SET_SEND_DUTY_CYCLE |
218 LIRC_CAN_SET_SEND_CARRIER |
219 LIRC_CAN_SEND_PULSE | LIRC_CAN_REC_MODE2)
221 .features = LIRC_CAN_REC_MODE2
228 #define RS_ISR_PASS_LIMIT 256
231 * A long pulse code from a remote might take up to 300 bytes. The
232 * daemon should read the bytes as soon as they are generated, so take
233 * the number of keys you think you can push before the daemon runs
234 * and multiply by 300. The driver will warn you if you overrun this
235 * buffer. If you have a slow computer or non-busmastering IDE disks,
236 * maybe you will need to increase this.
239 /* This MUST be a power of two! It has to be larger than 1 as well. */
243 static struct timeval lasttv = {0, 0};
245 static struct lirc_buffer rbuf;
247 static unsigned int freq = 38000;
248 static unsigned int duty_cycle = 50;
250 /* Initialized in init_timing_params() */
251 static unsigned long period;
252 static unsigned long pulse_width;
253 static unsigned long space_width;
255 #if defined(__i386__)
258 * Linux I/O port programming mini-HOWTO
259 * Author: Riku Saikkonen <Riku.Saikkonen@hut.fi>
260 * v, 28 December 1997
263 * Actually, a port I/O instruction on most ports in the 0-0x3ff range
264 * takes almost exactly 1 microsecond, so if you're, for example, using
265 * the parallel port directly, just do additional inb()s from that port
269 /* transmitter latency 1.5625us 0x1.90 - this figure arrived at from
270 * comment above plus trimming to match actual measured frequency.
271 * This will be sensitive to cpu speed, though hopefully most of the 1.5us
272 * is spent in the uart access. Still - for reference test machine was a
273 * 1.13GHz Athlon system - Steve
277 * changed from 400 to 450 as this works better on slower machines;
278 * faster machines will use the rdtsc code anyway
280 #define LIRC_SERIAL_TRANSMITTER_LATENCY 450
284 /* does anybody have information on other platforms ? */
286 #define LIRC_SERIAL_TRANSMITTER_LATENCY 256
288 #endif /* __i386__ */
290 * FIXME: should we be using hrtimers instead of this
291 * LIRC_SERIAL_TRANSMITTER_LATENCY nonsense?
294 /* fetch serial input packet (1 byte) from register offset */
295 static u8 sinp(int offset)
298 /* the register is memory-mapped */
301 return inb(io + offset);
304 /* write serial output packet (1 byte) of value to register offset */
305 static void soutp(int offset, u8 value)
308 /* the register is memory-mapped */
311 outb(value, io + offset);
316 #ifdef CONFIG_LIRC_SERIAL_NSLU2
318 * On NSLU2, we put the transmit diode between the output of the green
319 * status LED and ground
321 if (type == LIRC_NSLU2) {
322 gpio_line_set(NSLU2_LED_GRN, IXP4XX_GPIO_LOW);
327 soutp(UART_MCR, hardware[type].off);
329 soutp(UART_MCR, hardware[type].on);
332 static void off(void)
334 #ifdef CONFIG_LIRC_SERIAL_NSLU2
335 if (type == LIRC_NSLU2) {
336 gpio_line_set(NSLU2_LED_GRN, IXP4XX_GPIO_HIGH);
341 soutp(UART_MCR, hardware[type].on);
343 soutp(UART_MCR, hardware[type].off);
346 #ifndef MAX_UDELAY_MS
347 #define MAX_UDELAY_US 5000
349 #define MAX_UDELAY_US (MAX_UDELAY_MS*1000)
352 static void safe_udelay(unsigned long usecs)
354 while (usecs > MAX_UDELAY_US) {
355 udelay(MAX_UDELAY_US);
356 usecs -= MAX_UDELAY_US;
363 * This is an overflow/precision juggle, complicated in that we can't
364 * do long long divide in the kernel
368 * When we use the rdtsc instruction to measure clocks, we keep the
369 * pulse and space widths as clock cycles. As this is CPU speed
370 * dependent, the widths must be calculated in init_port and ioctl
374 /* So send_pulse can quickly convert microseconds to clocks */
375 static unsigned long conv_us_to_clocks;
377 static int init_timing_params(unsigned int new_duty_cycle,
378 unsigned int new_freq)
380 __u64 loops_per_sec, work;
382 duty_cycle = new_duty_cycle;
385 loops_per_sec = __this_cpu_read(cpu.info.loops_per_jiffy);
388 /* How many clocks in a microsecond?, avoiding long long divide */
389 work = loops_per_sec;
390 work *= 4295; /* 4295 = 2^32 / 1e6 */
391 conv_us_to_clocks = (work >> 32);
394 * Carrier period in clocks, approach good up to 32GHz clock,
395 * gets carrier frequency within 8Hz
397 period = loops_per_sec >> 3;
398 period /= (freq >> 3);
400 /* Derive pulse and space from the period */
401 pulse_width = period * duty_cycle / 100;
402 space_width = period - pulse_width;
403 dprintk("in init_timing_params, freq=%d, duty_cycle=%d, "
404 "clk/jiffy=%ld, pulse=%ld, space=%ld, "
405 "conv_us_to_clocks=%ld\n",
406 freq, duty_cycle, __this_cpu_read(cpu_info.loops_per_jiffy),
407 pulse_width, space_width, conv_us_to_clocks);
410 #else /* ! USE_RDTSC */
411 static int init_timing_params(unsigned int new_duty_cycle,
412 unsigned int new_freq)
415 * period, pulse/space width are kept with 8 binary places -
416 * IE multiplied by 256.
418 if (256 * 1000000L / new_freq * new_duty_cycle / 100 <=
419 LIRC_SERIAL_TRANSMITTER_LATENCY)
421 if (256 * 1000000L / new_freq * (100 - new_duty_cycle) / 100 <=
422 LIRC_SERIAL_TRANSMITTER_LATENCY)
424 duty_cycle = new_duty_cycle;
426 period = 256 * 1000000L / freq;
427 pulse_width = period * duty_cycle / 100;
428 space_width = period - pulse_width;
429 dprintk("in init_timing_params, freq=%d pulse=%ld, "
430 "space=%ld\n", freq, pulse_width, space_width);
433 #endif /* USE_RDTSC */
436 /* return value: space length delta */
438 static long send_pulse_irdeo(unsigned long length)
442 unsigned char output;
443 unsigned char chunk, shifted;
445 /* how many bits have to be sent ? */
446 rawbits = length * 1152 / 10000;
451 for (i = 0, output = 0x7f; rawbits > 0; rawbits -= 3) {
452 shifted = chunk << (i * 3);
454 output &= (~shifted);
457 soutp(UART_TX, output);
458 while (!(sinp(UART_LSR) & UART_LSR_THRE))
465 soutp(UART_TX, output);
466 while (!(sinp(UART_LSR) & UART_LSR_TEMT))
471 ret = (-rawbits) * 10000 / 1152;
473 ret = (3 - i) * 3 * 10000 / 1152 + (-rawbits) * 10000 / 1152;
479 /* Version that uses Pentium rdtsc instruction to measure clocks */
482 * This version does sub-microsecond timing using rdtsc instruction,
483 * and does away with the fudged LIRC_SERIAL_TRANSMITTER_LATENCY
484 * Implicitly i586 architecture... - Steve
487 static long send_pulse_homebrew_softcarrier(unsigned long length)
490 unsigned long target, start, now;
492 /* Get going quick as we can */
495 /* Convert length from microseconds to clocks */
496 length *= conv_us_to_clocks;
497 /* And loop till time is up - flipping at right intervals */
499 target = pulse_width;
502 * FIXME: This looks like a hard busy wait, without even an occasional,
503 * polite, cpu_relax() call. There's got to be a better way?
505 * The i2c code has the result of a lot of bit-banging work, I wonder if
506 * there's something there which could be helpful here.
508 while ((now - start) < length) {
509 /* Delay till flip time */
512 } while ((now - start) < target);
518 target += space_width;
521 target += pulse_width;
526 return ((now - start) - length) / conv_us_to_clocks;
528 #else /* ! USE_RDTSC */
529 /* Version using udelay() */
532 * here we use fixed point arithmetic, with 8
533 * fractional bits. that gets us within 0.1% or so of the right average
534 * frequency, albeit with some jitter in pulse length - Steve
537 /* To match 8 fractional bits used for pulse/space length */
539 static long send_pulse_homebrew_softcarrier(unsigned long length)
542 unsigned long actual, target, d;
545 actual = 0; target = 0; flag = 0;
546 while (actual < length) {
549 target += space_width;
552 target += pulse_width;
554 d = (target - actual -
555 LIRC_SERIAL_TRANSMITTER_LATENCY + 128) >> 8;
557 * Note - we've checked in ioctl that the pulse/space
558 * widths are big enough so that d is > 0
561 actual += (d << 8) + LIRC_SERIAL_TRANSMITTER_LATENCY;
564 return (actual-length) >> 8;
566 #endif /* USE_RDTSC */
568 static long send_pulse_homebrew(unsigned long length)
574 return send_pulse_homebrew_softcarrier(length);
582 static void send_space_irdeo(long length)
590 static void send_space_homebrew(long length)
598 static void rbwrite(int l)
600 if (lirc_buffer_full(&rbuf)) {
601 /* no new signals will be accepted */
602 dprintk("Buffer overrun\n");
605 lirc_buffer_write(&rbuf, (void *)&l);
608 static void frbwrite(int l)
610 /* simple noise filter */
611 static int pulse, space;
612 static unsigned int ptr;
614 if (ptr > 0 && (l & PULSE_BIT)) {
615 pulse += l & PULSE_MASK;
618 rbwrite(pulse | PULSE_BIT);
624 if (!(l & PULSE_BIT)) {
634 if (space > PULSE_MASK)
637 if (space > PULSE_MASK)
643 rbwrite(pulse | PULSE_BIT);
651 static irqreturn_t irq_handler(int i, void *blah)
658 static int last_dcd = -1;
660 if ((sinp(UART_IIR) & UART_IIR_NO_INT)) {
661 /* not our interrupt */
668 status = sinp(UART_MSR);
669 if (counter > RS_ISR_PASS_LIMIT) {
670 printk(KERN_WARNING LIRC_DRIVER_NAME ": AIEEEE: "
674 if ((status & hardware[type].signal_pin_change)
676 /* get current time */
677 do_gettimeofday(&tv);
679 /* New mode, written by Trent Piepho
680 <xyzzy@u.washington.edu>. */
683 * The old format was not very portable.
684 * We now use an int to pass pulses
685 * and spaces to user space.
687 * If PULSE_BIT is set a pulse has been
688 * received, otherwise a space has been
689 * received. The driver needs to know if your
690 * receiver is active high or active low, or
691 * the space/pulse sense could be
692 * inverted. The bits denoted by PULSE_MASK are
693 * the length in microseconds. Lengths greater
694 * than or equal to 16 seconds are clamped to
695 * PULSE_MASK. All other bits are unused.
696 * This is a much simpler interface for user
697 * programs, as well as eliminating "out of
698 * phase" errors with space/pulse
702 /* calc time since last interrupt in microseconds */
703 dcd = (status & hardware[type].signal_pin) ? 1 : 0;
705 if (dcd == last_dcd) {
706 printk(KERN_WARNING LIRC_DRIVER_NAME
707 ": ignoring spike: %d %d %lx %lx %lx %lx\n",
709 tv.tv_sec, lasttv.tv_sec,
710 tv.tv_usec, lasttv.tv_usec);
714 deltv = tv.tv_sec-lasttv.tv_sec;
715 if (tv.tv_sec < lasttv.tv_sec ||
716 (tv.tv_sec == lasttv.tv_sec &&
717 tv.tv_usec < lasttv.tv_usec)) {
718 printk(KERN_WARNING LIRC_DRIVER_NAME
719 ": AIEEEE: your clock just jumped "
721 printk(KERN_WARNING LIRC_DRIVER_NAME
722 ": %d %d %lx %lx %lx %lx\n",
724 tv.tv_sec, lasttv.tv_sec,
725 tv.tv_usec, lasttv.tv_usec);
727 } else if (deltv > 15) {
728 data = PULSE_MASK; /* really long time */
731 printk(KERN_WARNING LIRC_DRIVER_NAME
733 "%d %d %lx %lx %lx %lx\n",
735 tv.tv_sec, lasttv.tv_sec,
736 tv.tv_usec, lasttv.tv_usec);
738 * detecting pulse while this
741 sense = sense ? 0 : 1;
744 data = (int) (deltv*1000000 +
747 frbwrite(dcd^sense ? data : (data|PULSE_BIT));
750 wake_up_interruptible(&rbuf.wait_poll);
752 } while (!(sinp(UART_IIR) & UART_IIR_NO_INT)); /* still pending ? */
757 static int hardware_init_port(void)
759 u8 scratch, scratch2, scratch3;
762 * This is a simple port existence test, borrowed from the autoconfig
763 * function in drivers/serial/8250.c
765 scratch = sinp(UART_IER);
770 scratch2 = sinp(UART_IER) & 0x0f;
771 soutp(UART_IER, 0x0f);
775 scratch3 = sinp(UART_IER) & 0x0f;
776 soutp(UART_IER, scratch);
777 if (scratch2 != 0 || scratch3 != 0x0f) {
778 /* we fail, there's nothing here */
779 printk(KERN_ERR LIRC_DRIVER_NAME ": port existence test "
780 "failed, cannot continue\n");
787 soutp(UART_LCR, sinp(UART_LCR) & (~UART_LCR_DLAB));
789 /* First of all, disable all interrupts */
790 soutp(UART_IER, sinp(UART_IER) &
791 (~(UART_IER_MSI|UART_IER_RLSI|UART_IER_THRI|UART_IER_RDI)));
793 /* Clear registers. */
799 #ifdef CONFIG_LIRC_SERIAL_NSLU2
800 if (type == LIRC_NSLU2) {
801 /* Setup NSLU2 UART */
804 soutp(UART_IER, sinp(UART_IER) | UART_IE_IXP42X_UUE);
805 /* Disable Receiver data Time out interrupt */
806 soutp(UART_IER, sinp(UART_IER) & ~UART_IE_IXP42X_RTOIE);
807 /* set out2 = interrupt unmask; off() doesn't set MCR
809 soutp(UART_MCR, UART_MCR_RTS|UART_MCR_OUT2);
813 /* Set line for power source */
816 /* Clear registers again to be sure. */
824 case LIRC_IRDEO_REMOTE:
825 /* setup port to 7N1 @ 115200 Baud */
826 /* 7N1+start = 9 bits at 115200 ~ 3 bits at 38kHz */
829 soutp(UART_LCR, sinp(UART_LCR) | UART_LCR_DLAB);
830 /* Set divisor to 1 => 115200 Baud */
833 /* Set DLAB 0 + 7N1 */
834 soutp(UART_LCR, UART_LCR_WLEN7);
835 /* THR interrupt already disabled at this point */
844 static int lirc_serial_probe(struct platform_device *dev)
846 int i, nlow, nhigh, result;
848 result = request_irq(irq, irq_handler,
849 (share_irq ? IRQF_SHARED : 0),
850 LIRC_DRIVER_NAME, (void *)&hardware);
852 if (result == -EBUSY)
853 printk(KERN_ERR LIRC_DRIVER_NAME ": IRQ %d busy\n",
855 else if (result == -EINVAL)
856 printk(KERN_ERR LIRC_DRIVER_NAME
857 ": Bad irq number or handler\n");
861 /* Reserve io region. */
863 * Future MMAP-Developers: Attention!
864 * For memory mapped I/O you *might* need to use ioremap() first,
865 * for the NSLU2 it's done in boot code.
868 && (request_mem_region(iommap, 8 << ioshift,
869 LIRC_DRIVER_NAME) == NULL))
871 && (request_region(io, 8, LIRC_DRIVER_NAME) == NULL))) {
872 printk(KERN_ERR LIRC_DRIVER_NAME
873 ": port %04x already in use\n", io);
874 printk(KERN_WARNING LIRC_DRIVER_NAME
875 ": use 'setserial /dev/ttySX uart none'\n");
876 printk(KERN_WARNING LIRC_DRIVER_NAME
877 ": or compile the serial port driver as module and\n");
878 printk(KERN_WARNING LIRC_DRIVER_NAME
879 ": make sure this module is loaded first\n");
884 result = hardware_init_port();
886 goto exit_release_region;
888 /* Initialize pulse/space widths */
889 init_timing_params(duty_cycle, freq);
891 /* If pin is high, then this must be an active low receiver. */
893 /* wait 1/2 sec for the power supply */
897 * probe 9 times every 0.04s, collect "votes" for
902 for (i = 0; i < 9; i++) {
903 if (sinp(UART_MSR) & hardware[type].signal_pin)
909 sense = (nlow >= nhigh ? 1 : 0);
910 printk(KERN_INFO LIRC_DRIVER_NAME ": auto-detected active "
911 "%s receiver\n", sense ? "low" : "high");
913 printk(KERN_INFO LIRC_DRIVER_NAME ": Manually using active "
914 "%s receiver\n", sense ? "low" : "high");
916 dprintk("Interrupt %d, port %04x obtained\n", irq, io);
921 release_mem_region(iommap, 8 << ioshift);
923 release_region(io, 8);
925 free_irq(irq, (void *)&hardware);
930 static int lirc_serial_remove(struct platform_device *dev)
932 free_irq(irq, (void *)&hardware);
935 release_mem_region(iommap, 8 << ioshift);
937 release_region(io, 8);
942 static int set_use_inc(void *data)
946 /* initialize timestamp */
947 do_gettimeofday(&lasttv);
949 spin_lock_irqsave(&hardware[type].lock, flags);
952 soutp(UART_LCR, sinp(UART_LCR) & (~UART_LCR_DLAB));
954 soutp(UART_IER, sinp(UART_IER)|UART_IER_MSI);
956 spin_unlock_irqrestore(&hardware[type].lock, flags);
961 static void set_use_dec(void *data)
962 { unsigned long flags;
964 spin_lock_irqsave(&hardware[type].lock, flags);
967 soutp(UART_LCR, sinp(UART_LCR) & (~UART_LCR_DLAB));
969 /* First of all, disable all interrupts */
970 soutp(UART_IER, sinp(UART_IER) &
971 (~(UART_IER_MSI|UART_IER_RLSI|UART_IER_THRI|UART_IER_RDI)));
972 spin_unlock_irqrestore(&hardware[type].lock, flags);
975 static ssize_t lirc_write(struct file *file, const char *buf,
976 size_t n, loff_t *ppos)
983 if (!(hardware[type].features & LIRC_CAN_SEND_PULSE))
986 count = n / sizeof(int);
987 if (n % sizeof(int) || count % 2 == 0)
989 wbuf = memdup_user(buf, n);
991 return PTR_ERR(wbuf);
992 spin_lock_irqsave(&hardware[type].lock, flags);
993 if (type == LIRC_IRDEO) {
997 for (i = 0; i < count; i++) {
999 hardware[type].send_space(wbuf[i] - delta);
1001 delta = hardware[type].send_pulse(wbuf[i]);
1004 spin_unlock_irqrestore(&hardware[type].lock, flags);
1009 static long lirc_ioctl(struct file *filep, unsigned int cmd, unsigned long arg)
1015 case LIRC_GET_SEND_MODE:
1016 if (!(hardware[type].features&LIRC_CAN_SEND_MASK))
1017 return -ENOIOCTLCMD;
1019 result = put_user(LIRC_SEND2MODE
1020 (hardware[type].features&LIRC_CAN_SEND_MASK),
1026 case LIRC_SET_SEND_MODE:
1027 if (!(hardware[type].features&LIRC_CAN_SEND_MASK))
1028 return -ENOIOCTLCMD;
1030 result = get_user(value, (__u32 *) arg);
1033 /* only LIRC_MODE_PULSE supported */
1034 if (value != LIRC_MODE_PULSE)
1038 case LIRC_GET_LENGTH:
1039 return -ENOIOCTLCMD;
1042 case LIRC_SET_SEND_DUTY_CYCLE:
1043 dprintk("SET_SEND_DUTY_CYCLE\n");
1044 if (!(hardware[type].features&LIRC_CAN_SET_SEND_DUTY_CYCLE))
1045 return -ENOIOCTLCMD;
1047 result = get_user(value, (__u32 *) arg);
1050 if (value <= 0 || value > 100)
1052 return init_timing_params(value, freq);
1055 case LIRC_SET_SEND_CARRIER:
1056 dprintk("SET_SEND_CARRIER\n");
1057 if (!(hardware[type].features&LIRC_CAN_SET_SEND_CARRIER))
1058 return -ENOIOCTLCMD;
1060 result = get_user(value, (__u32 *) arg);
1063 if (value > 500000 || value < 20000)
1065 return init_timing_params(duty_cycle, value);
1069 return lirc_dev_fop_ioctl(filep, cmd, arg);
1074 static const struct file_operations lirc_fops = {
1075 .owner = THIS_MODULE,
1076 .write = lirc_write,
1077 .unlocked_ioctl = lirc_ioctl,
1078 #ifdef CONFIG_COMPAT
1079 .compat_ioctl = lirc_ioctl,
1081 .read = lirc_dev_fop_read,
1082 .poll = lirc_dev_fop_poll,
1083 .open = lirc_dev_fop_open,
1084 .release = lirc_dev_fop_close,
1085 .llseek = no_llseek,
1088 static struct lirc_driver driver = {
1089 .name = LIRC_DRIVER_NAME,
1096 .set_use_inc = set_use_inc,
1097 .set_use_dec = set_use_dec,
1100 .owner = THIS_MODULE,
1103 static struct platform_device *lirc_serial_dev;
1105 static int lirc_serial_suspend(struct platform_device *dev,
1109 soutp(UART_LCR, sinp(UART_LCR) & (~UART_LCR_DLAB));
1111 /* Disable all interrupts */
1112 soutp(UART_IER, sinp(UART_IER) &
1113 (~(UART_IER_MSI|UART_IER_RLSI|UART_IER_THRI|UART_IER_RDI)));
1115 /* Clear registers. */
1124 /* twisty maze... need a forward-declaration here... */
1125 static void lirc_serial_exit(void);
1127 static int lirc_serial_resume(struct platform_device *dev)
1129 unsigned long flags;
1132 result = hardware_init_port();
1136 spin_lock_irqsave(&hardware[type].lock, flags);
1137 /* Enable Interrupt */
1138 do_gettimeofday(&lasttv);
1139 soutp(UART_IER, sinp(UART_IER)|UART_IER_MSI);
1142 lirc_buffer_clear(&rbuf);
1144 spin_unlock_irqrestore(&hardware[type].lock, flags);
1149 static struct platform_driver lirc_serial_driver = {
1150 .probe = lirc_serial_probe,
1151 .remove = lirc_serial_remove,
1152 .suspend = lirc_serial_suspend,
1153 .resume = lirc_serial_resume,
1155 .name = "lirc_serial",
1156 .owner = THIS_MODULE,
1160 static int __init lirc_serial_init(void)
1164 /* Init read buffer. */
1165 result = lirc_buffer_init(&rbuf, sizeof(int), RBUF_LEN);
1169 result = platform_driver_register(&lirc_serial_driver);
1171 printk("lirc register returned %d\n", result);
1172 goto exit_buffer_free;
1175 lirc_serial_dev = platform_device_alloc("lirc_serial", 0);
1176 if (!lirc_serial_dev) {
1178 goto exit_driver_unregister;
1181 result = platform_device_add(lirc_serial_dev);
1183 goto exit_device_put;
1188 platform_device_put(lirc_serial_dev);
1189 exit_driver_unregister:
1190 platform_driver_unregister(&lirc_serial_driver);
1192 lirc_buffer_free(&rbuf);
1196 static void lirc_serial_exit(void)
1198 platform_device_unregister(lirc_serial_dev);
1199 platform_driver_unregister(&lirc_serial_driver);
1200 lirc_buffer_free(&rbuf);
1203 static int __init lirc_serial_init_module(void)
1210 case LIRC_IRDEO_REMOTE:
1213 /* if nothing specified, use ttyS0/com1 and irq 4 */
1214 io = io ? io : 0x3f8;
1215 irq = irq ? irq : 4;
1217 #ifdef CONFIG_LIRC_SERIAL_NSLU2
1219 io = io ? io : IRQ_IXP4XX_UART2;
1220 irq = irq ? irq : (IXP4XX_UART2_BASE_VIRT + REG_OFFSET);
1221 iommap = iommap ? iommap : IXP4XX_UART2_BASE_PHYS;
1222 ioshift = ioshift ? ioshift : 2;
1232 #ifdef CONFIG_LIRC_SERIAL_NSLU2
1235 hardware[type].features &=
1236 ~(LIRC_CAN_SET_SEND_DUTY_CYCLE|
1237 LIRC_CAN_SET_SEND_CARRIER);
1242 /* make sure sense is either -1, 0, or 1 */
1246 result = lirc_serial_init();
1250 driver.features = hardware[type].features;
1251 driver.dev = &lirc_serial_dev->dev;
1252 driver.minor = lirc_register_driver(&driver);
1253 if (driver.minor < 0) {
1254 printk(KERN_ERR LIRC_DRIVER_NAME
1255 ": register_chrdev failed!\n");
1257 return driver.minor;
1262 static void __exit lirc_serial_exit_module(void)
1264 lirc_unregister_driver(driver.minor);
1266 dprintk("cleaned up module\n");
1270 module_init(lirc_serial_init_module);
1271 module_exit(lirc_serial_exit_module);
1273 MODULE_DESCRIPTION("Infra-red receiver driver for serial ports.");
1274 MODULE_AUTHOR("Ralph Metzler, Trent Piepho, Ben Pfaff, "
1275 "Christoph Bartelmus, Andrei Tanas");
1276 MODULE_LICENSE("GPL");
1278 module_param(type, int, S_IRUGO);
1279 MODULE_PARM_DESC(type, "Hardware type (0 = home-brew, 1 = IRdeo,"
1280 " 2 = IRdeo Remote, 3 = AnimaX, 4 = IgorPlug,"
1281 " 5 = NSLU2 RX:CTS2/TX:GreenLED)");
1283 module_param(io, int, S_IRUGO);
1284 MODULE_PARM_DESC(io, "I/O address base (0x3f8 or 0x2f8)");
1286 /* some architectures (e.g. intel xscale) have memory mapped registers */
1287 module_param(iommap, bool, S_IRUGO);
1288 MODULE_PARM_DESC(iommap, "physical base for memory mapped I/O"
1289 " (0 = no memory mapped io)");
1292 * some architectures (e.g. intel xscale) align the 8bit serial registers
1293 * on 32bit word boundaries.
1294 * See linux-kernel/drivers/tty/serial/8250/8250.c serial_in()/out()
1296 module_param(ioshift, int, S_IRUGO);
1297 MODULE_PARM_DESC(ioshift, "shift I/O register offset (0 = no shift)");
1299 module_param(irq, int, S_IRUGO);
1300 MODULE_PARM_DESC(irq, "Interrupt (4 or 3)");
1302 module_param(share_irq, bool, S_IRUGO);
1303 MODULE_PARM_DESC(share_irq, "Share interrupts (0 = off, 1 = on)");
1305 module_param(sense, int, S_IRUGO);
1306 MODULE_PARM_DESC(sense, "Override autodetection of IR receiver circuit"
1307 " (0 = active high, 1 = active low )");
1309 #ifdef CONFIG_LIRC_SERIAL_TRANSMITTER
1310 module_param(txsense, bool, S_IRUGO);
1311 MODULE_PARM_DESC(txsense, "Sense of transmitter circuit"
1312 " (0 = active high, 1 = active low )");
1315 module_param(softcarrier, bool, S_IRUGO);
1316 MODULE_PARM_DESC(softcarrier, "Software carrier (0 = off, 1 = on, default on)");
1318 module_param(debug, bool, S_IRUGO | S_IWUSR);
1319 MODULE_PARM_DESC(debug, "Enable debugging messages");