4 * serial_ir - 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 * Copyright (C) 2016 Sean Young <sean@mess.org> (port to rc-core)
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
24 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
26 #include <linux/module.h>
27 #include <linux/errno.h>
28 #include <linux/interrupt.h>
29 #include <linux/kernel.h>
30 #include <linux/serial_reg.h>
31 #include <linux/types.h>
32 #include <linux/delay.h>
33 #include <linux/platform_device.h>
34 #include <linux/spinlock.h>
35 #include <media/rc-core.h>
39 int signal_pin_change;
42 unsigned set_send_carrier:1;
43 unsigned set_duty_cycle:1;
44 void (*send_pulse)(unsigned int length, ktime_t edge);
45 void (*send_space)(void);
51 #define IR_IRDEO_REMOTE 2
55 /* module parameters */
61 static bool softcarrier = true;
62 static bool share_irq;
63 static int sense = -1; /* -1 = auto, 0 = active high, 1 = active low */
64 static bool txsense; /* 0 = active high, 1 = active low */
66 /* forward declarations */
67 static void send_pulse_irdeo(unsigned int length, ktime_t edge);
68 static void send_space_irdeo(void);
69 #ifdef CONFIG_IR_SERIAL_TRANSMITTER
70 static void send_pulse_homebrew(unsigned int length, ktime_t edge);
71 static void send_space_homebrew(void);
74 static struct serial_ir_hw hardware[] = {
76 .lock = __SPIN_LOCK_UNLOCKED(hardware[IR_HOMEBREW].lock),
77 .signal_pin = UART_MSR_DCD,
78 .signal_pin_change = UART_MSR_DDCD,
79 .on = (UART_MCR_RTS | UART_MCR_OUT2 | UART_MCR_DTR),
80 .off = (UART_MCR_RTS | UART_MCR_OUT2),
81 #ifdef CONFIG_IR_SERIAL_TRANSMITTER
82 .send_pulse = send_pulse_homebrew,
83 .send_space = send_space_homebrew,
84 .set_send_carrier = true,
85 .set_duty_cycle = true,
90 .lock = __SPIN_LOCK_UNLOCKED(hardware[IR_IRDEO].lock),
91 .signal_pin = UART_MSR_DSR,
92 .signal_pin_change = UART_MSR_DDSR,
94 .off = (UART_MCR_RTS | UART_MCR_DTR | UART_MCR_OUT2),
95 .send_pulse = send_pulse_irdeo,
96 .send_space = send_space_irdeo,
97 .set_duty_cycle = true,
100 [IR_IRDEO_REMOTE] = {
101 .lock = __SPIN_LOCK_UNLOCKED(hardware[IR_IRDEO_REMOTE].lock),
102 .signal_pin = UART_MSR_DSR,
103 .signal_pin_change = UART_MSR_DDSR,
104 .on = (UART_MCR_RTS | UART_MCR_DTR | UART_MCR_OUT2),
105 .off = (UART_MCR_RTS | UART_MCR_DTR | UART_MCR_OUT2),
106 .send_pulse = send_pulse_irdeo,
107 .send_space = send_space_irdeo,
108 .set_duty_cycle = true,
112 .lock = __SPIN_LOCK_UNLOCKED(hardware[IR_ANIMAX].lock),
113 .signal_pin = UART_MSR_DCD,
114 .signal_pin_change = UART_MSR_DDCD,
116 .off = (UART_MCR_RTS | UART_MCR_DTR | UART_MCR_OUT2),
120 .lock = __SPIN_LOCK_UNLOCKED(hardware[IR_IGOR].lock),
121 .signal_pin = UART_MSR_DSR,
122 .signal_pin_change = UART_MSR_DDSR,
123 .on = (UART_MCR_RTS | UART_MCR_OUT2 | UART_MCR_DTR),
124 .off = (UART_MCR_RTS | UART_MCR_OUT2),
125 #ifdef CONFIG_IR_SERIAL_TRANSMITTER
126 .send_pulse = send_pulse_homebrew,
127 .send_space = send_space_homebrew,
128 .set_send_carrier = true,
129 .set_duty_cycle = true,
134 #define RS_ISR_PASS_LIMIT 256
138 struct rc_dev *rcdev;
139 struct platform_device *pdev;
140 struct timer_list timeout_timer;
142 unsigned int carrier;
143 unsigned int duty_cycle;
146 static struct serial_ir serial_ir;
148 /* fetch serial input packet (1 byte) from register offset */
149 static u8 sinp(int offset)
152 /* the register is memory-mapped */
155 return inb(io + offset);
158 /* write serial output packet (1 byte) of value to register offset */
159 static void soutp(int offset, u8 value)
162 /* the register is memory-mapped */
165 outb(value, io + offset);
171 soutp(UART_MCR, hardware[type].off);
173 soutp(UART_MCR, hardware[type].on);
176 static void off(void)
179 soutp(UART_MCR, hardware[type].on);
181 soutp(UART_MCR, hardware[type].off);
184 static void send_pulse_irdeo(unsigned int length, ktime_t target)
188 unsigned char output;
189 unsigned char chunk, shifted;
191 /* how many bits have to be sent ? */
192 rawbits = length * 1152 / 10000;
193 if (serial_ir.duty_cycle > 50)
197 for (i = 0, output = 0x7f; rawbits > 0; rawbits -= 3) {
198 shifted = chunk << (i * 3);
200 output &= (~shifted);
203 soutp(UART_TX, output);
204 while (!(sinp(UART_LSR) & UART_LSR_THRE))
211 soutp(UART_TX, output);
212 while (!(sinp(UART_LSR) & UART_LSR_TEMT))
217 static void send_space_irdeo(void)
221 #ifdef CONFIG_IR_SERIAL_TRANSMITTER
222 static void send_pulse_homebrew_softcarrier(unsigned int length, ktime_t edge)
224 ktime_t now, target = ktime_add_us(edge, length);
226 * delta should never exceed 4 seconds and on m68k
227 * ndelay(s64) does not compile; so use s32 rather than s64.
230 unsigned int pulse, space;
232 /* Ensure the dividend fits into 32 bit */
233 pulse = DIV_ROUND_CLOSEST(serial_ir.duty_cycle * (NSEC_PER_SEC / 100),
235 space = DIV_ROUND_CLOSEST((100 - serial_ir.duty_cycle) *
236 (NSEC_PER_SEC / 100), serial_ir.carrier);
240 if (ktime_compare(now, target) >= 0)
243 edge = ktime_add_ns(edge, pulse);
244 delta = ktime_to_ns(ktime_sub(edge, now));
249 if (ktime_compare(now, target) >= 0)
251 edge = ktime_add_ns(edge, space);
252 delta = ktime_to_ns(ktime_sub(edge, now));
258 static void send_pulse_homebrew(unsigned int length, ktime_t edge)
261 send_pulse_homebrew_softcarrier(length, edge);
266 static void send_space_homebrew(void)
272 static void frbwrite(unsigned int l, bool is_pulse)
274 /* simple noise filter */
275 static unsigned int ptr, pulse, space;
276 DEFINE_IR_RAW_EVENT(ev);
278 if (ptr > 0 && is_pulse) {
280 if (pulse > 250000) {
283 ir_raw_event_store_with_filter(serial_ir.rcdev, &ev);
286 ir_raw_event_store_with_filter(serial_ir.rcdev, &ev);
302 if (space > IR_MAX_DURATION)
303 space = IR_MAX_DURATION;
305 if (space > IR_MAX_DURATION)
306 space = IR_MAX_DURATION;
313 ir_raw_event_store_with_filter(serial_ir.rcdev, &ev);
316 ir_raw_event_store_with_filter(serial_ir.rcdev, &ev);
324 ir_raw_event_store_with_filter(serial_ir.rcdev, &ev);
327 static irqreturn_t serial_ir_irq_handler(int i, void *blah)
334 static int last_dcd = -1;
336 if ((sinp(UART_IIR) & UART_IIR_NO_INT)) {
337 /* not our interrupt */
344 status = sinp(UART_MSR);
345 if (counter > RS_ISR_PASS_LIMIT) {
346 dev_err(&serial_ir.pdev->dev, "Trapped in interrupt");
349 if ((status & hardware[type].signal_pin_change) &&
351 /* get current time */
355 * The driver needs to know if your receiver is
356 * active high or active low, or the space/pulse
357 * sense could be inverted.
360 /* calc time since last interrupt in nanoseconds */
361 dcd = (status & hardware[type].signal_pin) ? 1 : 0;
363 if (dcd == last_dcd) {
364 dev_err(&serial_ir.pdev->dev,
365 "ignoring spike: %d %d %lldns %lldns\n",
366 dcd, sense, ktime_to_ns(kt),
367 ktime_to_ns(serial_ir.lastkt));
371 delkt = ktime_sub(kt, serial_ir.lastkt);
372 if (ktime_compare(delkt, ktime_set(15, 0)) > 0) {
373 data = IR_MAX_DURATION; /* really long time */
374 if (!(dcd ^ sense)) {
376 dev_err(&serial_ir.pdev->dev,
377 "dcd unexpected: %d %d %lldns %lldns\n",
378 dcd, sense, ktime_to_ns(kt),
379 ktime_to_ns(serial_ir.lastkt));
381 * detecting pulse while this
384 sense = sense ? 0 : 1;
387 data = ktime_to_ns(delkt);
389 frbwrite(data, !(dcd ^ sense));
390 serial_ir.lastkt = kt;
393 } while (!(sinp(UART_IIR) & UART_IIR_NO_INT)); /* still pending ? */
395 mod_timer(&serial_ir.timeout_timer,
396 jiffies + nsecs_to_jiffies(serial_ir.rcdev->timeout));
398 ir_raw_event_handle(serial_ir.rcdev);
403 static int hardware_init_port(void)
405 u8 scratch, scratch2, scratch3;
408 * This is a simple port existence test, borrowed from the autoconfig
409 * function in drivers/tty/serial/8250/8250_port.c
411 scratch = sinp(UART_IER);
416 scratch2 = sinp(UART_IER) & 0x0f;
417 soutp(UART_IER, 0x0f);
421 scratch3 = sinp(UART_IER) & 0x0f;
422 soutp(UART_IER, scratch);
423 if (scratch2 != 0 || scratch3 != 0x0f) {
424 /* we fail, there's nothing here */
425 pr_err("port existence test failed, cannot continue\n");
430 soutp(UART_LCR, sinp(UART_LCR) & (~UART_LCR_DLAB));
432 /* First of all, disable all interrupts */
433 soutp(UART_IER, sinp(UART_IER) &
434 (~(UART_IER_MSI | UART_IER_RLSI | UART_IER_THRI | UART_IER_RDI)));
436 /* Clear registers. */
442 /* Set line for power source */
445 /* Clear registers again to be sure. */
453 case IR_IRDEO_REMOTE:
454 /* setup port to 7N1 @ 115200 Baud */
455 /* 7N1+start = 9 bits at 115200 ~ 3 bits at 38kHz */
458 soutp(UART_LCR, sinp(UART_LCR) | UART_LCR_DLAB);
459 /* Set divisor to 1 => 115200 Baud */
462 /* Set DLAB 0 + 7N1 */
463 soutp(UART_LCR, UART_LCR_WLEN7);
464 /* THR interrupt already disabled at this point */
473 static void serial_ir_timeout(struct timer_list *unused)
475 DEFINE_IR_RAW_EVENT(ev);
478 ev.duration = serial_ir.rcdev->timeout;
479 ir_raw_event_store_with_filter(serial_ir.rcdev, &ev);
480 ir_raw_event_handle(serial_ir.rcdev);
483 /* Needed by serial_ir_probe() */
484 static int serial_ir_tx(struct rc_dev *dev, unsigned int *txbuf,
486 static int serial_ir_tx_duty_cycle(struct rc_dev *dev, u32 cycle);
487 static int serial_ir_tx_carrier(struct rc_dev *dev, u32 carrier);
488 static int serial_ir_open(struct rc_dev *rcdev);
489 static void serial_ir_close(struct rc_dev *rcdev);
491 static int serial_ir_probe(struct platform_device *dev)
493 struct rc_dev *rcdev;
494 int i, nlow, nhigh, result;
496 rcdev = devm_rc_allocate_device(&dev->dev, RC_DRIVER_IR_RAW);
500 if (hardware[type].send_pulse && hardware[type].send_space)
501 rcdev->tx_ir = serial_ir_tx;
502 if (hardware[type].set_send_carrier)
503 rcdev->s_tx_carrier = serial_ir_tx_carrier;
504 if (hardware[type].set_duty_cycle)
505 rcdev->s_tx_duty_cycle = serial_ir_tx_duty_cycle;
509 rcdev->device_name = "Serial IR type home-brew";
512 rcdev->device_name = "Serial IR type IRdeo";
514 case IR_IRDEO_REMOTE:
515 rcdev->device_name = "Serial IR type IRdeo remote";
518 rcdev->device_name = "Serial IR type AnimaX";
521 rcdev->device_name = "Serial IR type IgorPlug";
525 rcdev->input_phys = KBUILD_MODNAME "/input0";
526 rcdev->input_id.bustype = BUS_HOST;
527 rcdev->input_id.vendor = 0x0001;
528 rcdev->input_id.product = 0x0001;
529 rcdev->input_id.version = 0x0100;
530 rcdev->open = serial_ir_open;
531 rcdev->close = serial_ir_close;
532 rcdev->dev.parent = &serial_ir.pdev->dev;
533 rcdev->allowed_protocols = RC_PROTO_BIT_ALL_IR_DECODER;
534 rcdev->driver_name = KBUILD_MODNAME;
535 rcdev->map_name = RC_MAP_RC6_MCE;
536 rcdev->min_timeout = 1;
537 rcdev->timeout = IR_DEFAULT_TIMEOUT;
538 rcdev->max_timeout = 10 * IR_DEFAULT_TIMEOUT;
539 rcdev->rx_resolution = 250000;
541 serial_ir.rcdev = rcdev;
543 timer_setup(&serial_ir.timeout_timer, serial_ir_timeout, 0);
545 result = devm_request_irq(&dev->dev, irq, serial_ir_irq_handler,
546 share_irq ? IRQF_SHARED : 0,
547 KBUILD_MODNAME, &hardware);
549 if (result == -EBUSY)
550 dev_err(&dev->dev, "IRQ %d busy\n", irq);
551 else if (result == -EINVAL)
552 dev_err(&dev->dev, "Bad irq number or handler\n");
556 /* Reserve io region. */
558 (devm_request_mem_region(&dev->dev, iommap, 8 << ioshift,
559 KBUILD_MODNAME) == NULL)) ||
560 (!iommap && (devm_request_region(&dev->dev, io, 8,
561 KBUILD_MODNAME) == NULL))) {
562 dev_err(&dev->dev, "port %04x already in use\n", io);
563 dev_warn(&dev->dev, "use 'setserial /dev/ttySX uart none'\n");
565 "or compile the serial port driver as module and\n");
566 dev_warn(&dev->dev, "make sure this module is loaded first\n");
570 result = hardware_init_port();
574 /* Initialize pulse/space widths */
575 serial_ir.duty_cycle = 50;
576 serial_ir.carrier = 38000;
578 /* If pin is high, then this must be an active low receiver. */
580 /* wait 1/2 sec for the power supply */
584 * probe 9 times every 0.04s, collect "votes" for
589 for (i = 0; i < 9; i++) {
590 if (sinp(UART_MSR) & hardware[type].signal_pin)
596 sense = nlow >= nhigh ? 1 : 0;
597 dev_info(&dev->dev, "auto-detected active %s receiver\n",
598 sense ? "low" : "high");
600 dev_info(&dev->dev, "Manually using active %s receiver\n",
601 sense ? "low" : "high");
603 dev_dbg(&dev->dev, "Interrupt %d, port %04x obtained\n", irq, io);
605 return devm_rc_register_device(&dev->dev, rcdev);
608 static int serial_ir_open(struct rc_dev *rcdev)
612 /* initialize timestamp */
613 serial_ir.lastkt = ktime_get();
615 spin_lock_irqsave(&hardware[type].lock, flags);
618 soutp(UART_LCR, sinp(UART_LCR) & (~UART_LCR_DLAB));
620 soutp(UART_IER, sinp(UART_IER) | UART_IER_MSI);
622 spin_unlock_irqrestore(&hardware[type].lock, flags);
627 static void serial_ir_close(struct rc_dev *rcdev)
631 spin_lock_irqsave(&hardware[type].lock, flags);
634 soutp(UART_LCR, sinp(UART_LCR) & (~UART_LCR_DLAB));
636 /* First of all, disable all interrupts */
637 soutp(UART_IER, sinp(UART_IER) &
638 (~(UART_IER_MSI | UART_IER_RLSI | UART_IER_THRI | UART_IER_RDI)));
639 spin_unlock_irqrestore(&hardware[type].lock, flags);
642 static int serial_ir_tx(struct rc_dev *dev, unsigned int *txbuf,
650 spin_lock_irqsave(&hardware[type].lock, flags);
651 if (type == IR_IRDEO) {
657 for (i = 0; i < count; i++) {
659 hardware[type].send_space();
661 hardware[type].send_pulse(txbuf[i], edge);
663 edge = ktime_add_us(edge, txbuf[i]);
664 delta = ktime_us_delta(edge, ktime_get());
666 spin_unlock_irqrestore(&hardware[type].lock, flags);
667 usleep_range(delta - 25, delta + 25);
668 spin_lock_irqsave(&hardware[type].lock, flags);
669 } else if (delta > 0) {
674 spin_unlock_irqrestore(&hardware[type].lock, flags);
678 static int serial_ir_tx_duty_cycle(struct rc_dev *dev, u32 cycle)
680 serial_ir.duty_cycle = cycle;
684 static int serial_ir_tx_carrier(struct rc_dev *dev, u32 carrier)
686 if (carrier > 500000 || carrier < 20000)
689 serial_ir.carrier = carrier;
693 static int serial_ir_suspend(struct platform_device *dev,
697 soutp(UART_LCR, sinp(UART_LCR) & (~UART_LCR_DLAB));
699 /* Disable all interrupts */
700 soutp(UART_IER, sinp(UART_IER) &
701 (~(UART_IER_MSI | UART_IER_RLSI | UART_IER_THRI | UART_IER_RDI)));
703 /* Clear registers. */
712 static int serial_ir_resume(struct platform_device *dev)
717 result = hardware_init_port();
721 spin_lock_irqsave(&hardware[type].lock, flags);
722 /* Enable Interrupt */
723 serial_ir.lastkt = ktime_get();
724 soutp(UART_IER, sinp(UART_IER) | UART_IER_MSI);
727 spin_unlock_irqrestore(&hardware[type].lock, flags);
732 static struct platform_driver serial_ir_driver = {
733 .probe = serial_ir_probe,
734 .suspend = serial_ir_suspend,
735 .resume = serial_ir_resume,
741 static int __init serial_ir_init(void)
745 result = platform_driver_register(&serial_ir_driver);
749 serial_ir.pdev = platform_device_alloc("serial_ir", 0);
750 if (!serial_ir.pdev) {
752 goto exit_driver_unregister;
755 result = platform_device_add(serial_ir.pdev);
757 goto exit_device_put;
762 platform_device_put(serial_ir.pdev);
763 exit_driver_unregister:
764 platform_driver_unregister(&serial_ir_driver);
768 static void serial_ir_exit(void)
770 platform_device_unregister(serial_ir.pdev);
771 platform_driver_unregister(&serial_ir_driver);
774 static int __init serial_ir_init_module(void)
781 case IR_IRDEO_REMOTE:
784 /* if nothing specified, use ttyS0/com1 and irq 4 */
785 io = io ? io : 0x3f8;
795 hardware[type].set_send_carrier = false;
796 hardware[type].set_duty_cycle = false;
801 /* make sure sense is either -1, 0, or 1 */
805 result = serial_ir_init();
813 static void __exit serial_ir_exit_module(void)
815 del_timer_sync(&serial_ir.timeout_timer);
819 module_init(serial_ir_init_module);
820 module_exit(serial_ir_exit_module);
822 MODULE_DESCRIPTION("Infra-red receiver driver for serial ports.");
823 MODULE_AUTHOR("Ralph Metzler, Trent Piepho, Ben Pfaff, Christoph Bartelmus, Andrei Tanas");
824 MODULE_LICENSE("GPL");
826 module_param(type, int, 0444);
827 MODULE_PARM_DESC(type, "Hardware type (0 = home-brew, 1 = IRdeo, 2 = IRdeo Remote, 3 = AnimaX, 4 = IgorPlug");
829 module_param_hw(io, int, ioport, 0444);
830 MODULE_PARM_DESC(io, "I/O address base (0x3f8 or 0x2f8)");
832 /* some architectures (e.g. intel xscale) have memory mapped registers */
833 module_param_hw(iommap, ulong, other, 0444);
834 MODULE_PARM_DESC(iommap, "physical base for memory mapped I/O (0 = no memory mapped io)");
837 * some architectures (e.g. intel xscale) align the 8bit serial registers
838 * on 32bit word boundaries.
839 * See linux-kernel/drivers/tty/serial/8250/8250.c serial_in()/out()
841 module_param_hw(ioshift, int, other, 0444);
842 MODULE_PARM_DESC(ioshift, "shift I/O register offset (0 = no shift)");
844 module_param_hw(irq, int, irq, 0444);
845 MODULE_PARM_DESC(irq, "Interrupt (4 or 3)");
847 module_param_hw(share_irq, bool, other, 0444);
848 MODULE_PARM_DESC(share_irq, "Share interrupts (0 = off, 1 = on)");
850 module_param(sense, int, 0444);
851 MODULE_PARM_DESC(sense, "Override autodetection of IR receiver circuit (0 = active high, 1 = active low )");
853 #ifdef CONFIG_IR_SERIAL_TRANSMITTER
854 module_param(txsense, bool, 0444);
855 MODULE_PARM_DESC(txsense, "Sense of transmitter circuit (0 = active high, 1 = active low )");
858 module_param(softcarrier, bool, 0444);
859 MODULE_PARM_DESC(softcarrier, "Software carrier (0 = off, 1 = on, default on)");