sir_ir.c 9.6 KB
Newer Older
1
/*
2
 * IR SIR driver, (C) 2000 Milan Pikula <www@fornax.sk>
3
 *
4
 * sir_ir - Device driver for use with SIR (serial infra red)
5 6 7 8 9 10 11 12
 * mode of IrDA on many notebooks.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 */

13 14
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

15 16 17 18
#include <linux/module.h>
#include <linux/interrupt.h>
#include <linux/kernel.h>
#include <linux/serial_reg.h>
19
#include <linux/ktime.h>
20
#include <linux/delay.h>
21
#include <linux/platform_device.h>
22

23
#include <media/rc-core.h>
24 25 26 27 28

/* SECTION: Definitions */
#define PULSE '['

/* 9bit * 1s/115200bit in milli seconds = 78.125ms*/
29
#define TIME_CONST (9000000ul / 115200ul)
30 31

/* timeout for sequences in jiffies (=5/100s), must be longer than TIME_CONST */
32
#define SIR_TIMEOUT	(HZ * 5 / 100)
33 34

/* onboard sir ports are typically com3 */
35 36
static int io = 0x3e8;
static int irq = 4;
37 38 39 40 41
static int threshold = 3;

static DEFINE_SPINLOCK(timer_lock);
static struct timer_list timerlist;
/* time of last signal change detected */
42
static ktime_t last;
43
/* time of last UART data ready interrupt */
44
static ktime_t last_intr_time;
45
static int last_value;
46
static struct rc_dev *rcdev;
47

48
static struct platform_device *sir_ir_dev;
49 50 51 52 53 54 55 56 57 58 59

static DEFINE_SPINLOCK(hardware_lock);

/* SECTION: Prototypes */

/* Communication with user-space */
static void add_read_queue(int flag, unsigned long val);
/* Hardware */
static irqreturn_t sir_interrupt(int irq, void *dev_id);
static void send_space(unsigned long len);
static void send_pulse(unsigned long len);
60
static void init_hardware(void);
61 62 63 64 65 66 67 68 69 70 71 72 73 74
static void drop_hardware(void);
/* Initialisation */

static inline unsigned int sinp(int offset)
{
	return inb(io + offset);
}

static inline void soutp(int offset, int value)
{
	outb(value, io + offset);
}

/* SECTION: Communication with user-space */
75 76
static int sir_tx_ir(struct rc_dev *dev, unsigned int *tx_buf,
		     unsigned int count)
77 78
{
	unsigned long flags;
79 80
	int i;

81
	local_irq_save(flags);
82
	for (i = 0; i < count;) {
83 84 85 86 87 88 89 90 91 92 93
		if (tx_buf[i])
			send_pulse(tx_buf[i]);
		i++;
		if (i >= count)
			break;
		if (tx_buf[i])
			send_space(tx_buf[i]);
		i++;
	}
	local_irq_restore(flags);

94
	return count;
95 96 97 98
}

static void add_read_queue(int flag, unsigned long val)
{
99
	DEFINE_IR_RAW_EVENT(ev);
100

101
	pr_debug("add flag %d with val %lu\n", flag, val);
102 103 104 105 106 107 108

	/*
	 * statistically, pulses are ~TIME_CONST/2 too long. we could
	 * maybe make this more exact, but this is good enough
	 */
	if (flag) {
		/* pulse */
109 110
		if (val > TIME_CONST / 2)
			val -= TIME_CONST / 2;
111
		else /* should not ever happen */
112 113
			val = 1;
		ev.pulse = true;
114
	} else {
115
		val += TIME_CONST / 2;
116
	}
117
	ev.duration = US_TO_NS(val);
118

119
	ir_raw_event_store_with_filter(rcdev, &ev);
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
}

/* SECTION: Hardware */
static void sir_timeout(unsigned long data)
{
	/*
	 * if last received signal was a pulse, but receiving stopped
	 * within the 9 bit frame, we need to finish this pulse and
	 * simulate a signal change to from pulse to space. Otherwise
	 * upper layers will receive two sequences next time.
	 */

	unsigned long flags;
	unsigned long pulse_end;

	/* avoid interference with interrupt */
	spin_lock_irqsave(&timer_lock, flags);
	if (last_value) {
		/* clear unread bits in UART and restart */
		outb(UART_FCR_CLEAR_RCVR, io + UART_FCR);
		/* determine 'virtual' pulse end: */
141 142
		pulse_end = min_t(unsigned long,
				  ktime_us_delta(last, last_intr_time),
143 144 145
				  IR_MAX_DURATION);
		dev_dbg(&sir_ir_dev->dev, "timeout add %d for %lu usec\n",
			last_value, pulse_end);
146 147
		add_read_queue(last_value, pulse_end);
		last_value = 0;
148
		last = last_intr_time;
149 150
	}
	spin_unlock_irqrestore(&timer_lock, flags);
151
	ir_raw_event_handle(rcdev);
152 153 154 155 156
}

static irqreturn_t sir_interrupt(int irq, void *dev_id)
{
	unsigned char data;
157 158 159
	ktime_t curr_time;
	static unsigned long delt;
	unsigned long deltintr;
160
	unsigned long flags;
161
	int counter = 0;
162 163 164
	int iir, lsr;

	while ((iir = inb(io + UART_IIR) & UART_IIR_ID)) {
165 166 167 168 169
		if (++counter > 256) {
			dev_err(&sir_ir_dev->dev, "Trapped in interrupt");
			break;
		}

170
		switch (iir & UART_IIR_ID) { /* FIXME toto treba preriedit */
171
		case UART_IIR_MSI:
172
			(void)inb(io + UART_MSR);
173 174 175
			break;
		case UART_IIR_RLSI:
		case UART_IIR_THRI:
176
			(void)inb(io + UART_LSR);
177 178 179 180 181 182 183
			break;
		case UART_IIR_RDI:
			/* avoid interference with timer */
			spin_lock_irqsave(&timer_lock, flags);
			do {
				del_timer(&timerlist);
				data = inb(io + UART_RX);
184 185 186
				curr_time = ktime_get();
				delt = min_t(unsigned long,
					     ktime_us_delta(last, curr_time),
187
					     IR_MAX_DURATION);
188 189 190
				deltintr = min_t(unsigned long,
						 ktime_us_delta(last_intr_time,
								curr_time),
191 192 193
						 IR_MAX_DURATION);
				dev_dbg(&sir_ir_dev->dev, "t %lu, d %d\n",
					deltintr, (int)data);
194 195 196 197
				/*
				 * if nothing came in last X cycles,
				 * it was gap
				 */
198
				if (deltintr > TIME_CONST * threshold) {
199
					if (last_value) {
200
						dev_dbg(&sir_ir_dev->dev, "GAP\n");
201 202
						/* simulate signal change */
						add_read_queue(last_value,
203 204
							       delt -
							       deltintr);
205
						last_value = 0;
206 207
						last = last_intr_time;
						delt = deltintr;
208 209 210 211 212
					}
				}
				data = 1;
				if (data ^ last_value) {
					/*
213
					 * deltintr > 2*TIME_CONST, remember?
214 215 216
					 * the other case is timeout
					 */
					add_read_queue(last_value,
217
						       delt - TIME_CONST);
218
					last_value = data;
219 220 221
					last = curr_time;
					last = ktime_sub_us(last,
							    TIME_CONST);
222
				}
223
				last_intr_time = curr_time;
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
				if (data) {
					/*
					 * start timer for end of
					 * sequence detection
					 */
					timerlist.expires = jiffies +
								SIR_TIMEOUT;
					add_timer(&timerlist);
				}

				lsr = inb(io + UART_LSR);
			} while (lsr & UART_LSR_DR); /* data ready */
			spin_unlock_irqrestore(&timer_lock, flags);
			break;
		default:
			break;
		}
	}
242
	ir_raw_event_handle(rcdev);
243 244 245 246 247
	return IRQ_RETVAL(IRQ_HANDLED);
}

static void send_space(unsigned long len)
{
248
	usleep_range(len, len + 25);
249 250 251 252 253 254
}

static void send_pulse(unsigned long len)
{
	long bytes_out = len / TIME_CONST;

255
	if (bytes_out == 0)
256
		bytes_out++;
257

258 259 260 261 262 263 264 265
	while (bytes_out--) {
		outb(PULSE, io + UART_TX);
		/* FIXME treba seriozne cakanie z char/serial.c */
		while (!(inb(io + UART_LSR) & UART_LSR_THRE))
			;
	}
}

266
static void init_hardware(void)
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
{
	unsigned long flags;

	spin_lock_irqsave(&hardware_lock, flags);
	/* reset UART */
	outb(0, io + UART_MCR);
	outb(0, io + UART_IER);
	/* init UART */
	/* set DLAB, speed = 115200 */
	outb(UART_LCR_DLAB | UART_LCR_WLEN7, io + UART_LCR);
	outb(1, io + UART_DLL); outb(0, io + UART_DLM);
	/* 7N1+start = 9 bits at 115200 ~ 3 bits at 44000 */
	outb(UART_LCR_WLEN7, io + UART_LCR);
	/* FIFO operation */
	outb(UART_FCR_ENABLE_FIFO, io + UART_FCR);
	/* interrupts */
	/* outb(UART_IER_RLSI|UART_IER_RDI|UART_IER_THRI, io + UART_IER); */
	outb(UART_IER_RDI, io + UART_IER);
	/* turn on UART */
286
	outb(UART_MCR_DTR | UART_MCR_RTS | UART_MCR_OUT2, io + UART_MCR);
287 288 289 290 291 292 293 294 295 296 297
	spin_unlock_irqrestore(&hardware_lock, flags);
}

static void drop_hardware(void)
{
	unsigned long flags;

	spin_lock_irqsave(&hardware_lock, flags);

	/* turn off interrupts */
	outb(0, io + UART_IER);
298

299 300 301 302
	spin_unlock_irqrestore(&hardware_lock, flags);
}

/* SECTION: Initialisation */
303
static int sir_ir_probe(struct platform_device *dev)
304 305 306
{
	int retval;

307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
	rcdev = devm_rc_allocate_device(&sir_ir_dev->dev, RC_DRIVER_IR_RAW);
	if (!rcdev)
		return -ENOMEM;

	rcdev->input_name = "SIR IrDA port";
	rcdev->input_phys = KBUILD_MODNAME "/input0";
	rcdev->input_id.bustype = BUS_HOST;
	rcdev->input_id.vendor = 0x0001;
	rcdev->input_id.product = 0x0001;
	rcdev->input_id.version = 0x0100;
	rcdev->tx_ir = sir_tx_ir;
	rcdev->allowed_protocols = RC_BIT_ALL_IR_DECODER;
	rcdev->driver_name = KBUILD_MODNAME;
	rcdev->map_name = RC_MAP_RC6_MCE;
	rcdev->timeout = IR_DEFAULT_TIMEOUT;
	rcdev->dev.parent = &sir_ir_dev->dev;

324 325
	setup_timer(&timerlist, sir_timeout, 0);

326
	/* get I/O port access and IRQ line */
327
	if (!devm_request_region(&sir_ir_dev->dev, io, 8, KBUILD_MODNAME)) {
328
		pr_err("i/o port 0x%.4x already in use.\n", io);
329 330
		return -EBUSY;
	}
331 332
	retval = devm_request_irq(&sir_ir_dev->dev, irq, sir_interrupt, 0,
				  KBUILD_MODNAME, NULL);
333
	if (retval < 0) {
334
		pr_err("IRQ %d already in use.\n", irq);
335 336
		return retval;
	}
337
	pr_info("I/O port 0x%.4x, IRQ %d.\n", io, irq);
338

339
	retval = devm_rc_register_device(&sir_ir_dev->dev, rcdev);
340 341 342
	if (retval < 0)
		return retval;

343 344 345
	init_hardware();

	return 0;
346 347
}

348
static int sir_ir_remove(struct platform_device *dev)
349
{
350
	drop_hardware();
351
	del_timer_sync(&timerlist);
352 353 354
	return 0;
}

355 356 357
static struct platform_driver sir_ir_driver = {
	.probe		= sir_ir_probe,
	.remove		= sir_ir_remove,
358
	.driver		= {
359
		.name	= "sir_ir",
360 361
	},
};
362

363
static int __init sir_ir_init(void)
364 365 366
{
	int retval;

367
	retval = platform_driver_register(&sir_ir_driver);
368 369
	if (retval)
		return retval;
370

371 372
	sir_ir_dev = platform_device_alloc("sir_ir", 0);
	if (!sir_ir_dev) {
373 374 375 376
		retval = -ENOMEM;
		goto pdev_alloc_fail;
	}

377
	retval = platform_device_add(sir_ir_dev);
378
	if (retval)
379 380
		goto pdev_add_fail;

381
	return 0;
382 383

pdev_add_fail:
384
	platform_device_put(sir_ir_dev);
385
pdev_alloc_fail:
386
	platform_driver_unregister(&sir_ir_driver);
387
	return retval;
388 389
}

390
static void __exit sir_ir_exit(void)
391
{
392 393
	platform_device_unregister(sir_ir_dev);
	platform_driver_unregister(&sir_ir_driver);
394 395
}

396 397
module_init(sir_ir_init);
module_exit(sir_ir_exit);
398 399 400 401 402

MODULE_DESCRIPTION("Infrared receiver driver for SIR type serial ports");
MODULE_AUTHOR("Milan Pikula");
MODULE_LICENSE("GPL");

403
module_param_hw(io, int, ioport, 0444);
404 405
MODULE_PARM_DESC(io, "I/O address base (0x3f8 or 0x2f8)");

406
module_param_hw(irq, int, irq, 0444);
407 408
MODULE_PARM_DESC(irq, "Interrupt (4 or 3)");

409
module_param(threshold, int, 0444);
410
MODULE_PARM_DESC(threshold, "space detection threshold (3)");