ite-cir.c revision e44ba033c5654dbfda53461c9b1f7dd9bd1d198f
1/*
2 * Driver for ITE Tech Inc. IT8712F/IT8512 CIR
3 *
4 * Copyright (C) 2010 Juan Jesús García de Soria <skandalfo@gmail.com>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 of the
9 * License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19 * USA.
20 *
21 * Inspired by the original lirc_it87 and lirc_ite8709 drivers, on top of the
22 * skeleton provided by the nuvoton-cir driver.
23 *
24 * The lirc_it87 driver was originally written by Hans-Gunter Lutke Uphues
25 * <hg_lu@web.de> in 2001, with enhancements by Christoph Bartelmus
26 * <lirc@bartelmus.de>, Andrew Calkin <r_tay@hotmail.com> and James Edwards
27 * <jimbo-lirc@edwardsclan.net>.
28 *
29 * The lirc_ite8709 driver was written by Grégory Lardière
30 * <spmf2004-lirc@yahoo.fr> in 2008.
31 */
32
33#include <linux/kernel.h>
34#include <linux/module.h>
35#include <linux/pnp.h>
36#include <linux/io.h>
37#include <linux/interrupt.h>
38#include <linux/sched.h>
39#include <linux/delay.h>
40#include <linux/slab.h>
41#include <linux/input.h>
42#include <linux/bitops.h>
43#include <media/rc-core.h>
44#include <linux/pci_ids.h>
45
46#include "ite-cir.h"
47
48/* module parameters */
49
50/* debug level */
51static int debug;
52module_param(debug, int, S_IRUGO | S_IWUSR);
53MODULE_PARM_DESC(debug, "Enable debugging output");
54
55/* low limit for RX carrier freq, Hz, 0 for no RX demodulation */
56static int rx_low_carrier_freq;
57module_param(rx_low_carrier_freq, int, S_IRUGO | S_IWUSR);
58MODULE_PARM_DESC(rx_low_carrier_freq, "Override low RX carrier frequency, Hz, "
59		 "0 for no RX demodulation");
60
61/* high limit for RX carrier freq, Hz, 0 for no RX demodulation */
62static int rx_high_carrier_freq;
63module_param(rx_high_carrier_freq, int, S_IRUGO | S_IWUSR);
64MODULE_PARM_DESC(rx_high_carrier_freq, "Override high RX carrier frequency, "
65		 "Hz, 0 for no RX demodulation");
66
67/* override tx carrier frequency */
68static int tx_carrier_freq;
69module_param(tx_carrier_freq, int, S_IRUGO | S_IWUSR);
70MODULE_PARM_DESC(tx_carrier_freq, "Override TX carrier frequency, Hz");
71
72/* override tx duty cycle */
73static int tx_duty_cycle;
74module_param(tx_duty_cycle, int, S_IRUGO | S_IWUSR);
75MODULE_PARM_DESC(tx_duty_cycle, "Override TX duty cycle, 1-100");
76
77/* override default sample period */
78static long sample_period;
79module_param(sample_period, long, S_IRUGO | S_IWUSR);
80MODULE_PARM_DESC(sample_period, "Override carrier sample period, us");
81
82/* override detected model id */
83static int model_number = -1;
84module_param(model_number, int, S_IRUGO | S_IWUSR);
85MODULE_PARM_DESC(model_number, "Use this model number, don't autodetect");
86
87
88/* HW-independent code functions */
89
90/* check whether carrier frequency is high frequency */
91static inline bool ite_is_high_carrier_freq(unsigned int freq)
92{
93	return freq >= ITE_HCF_MIN_CARRIER_FREQ;
94}
95
96/* get the bits required to program the carrier frequency in CFQ bits,
97 * unshifted */
98static u8 ite_get_carrier_freq_bits(unsigned int freq)
99{
100	if (ite_is_high_carrier_freq(freq)) {
101		if (freq < 425000)
102			return ITE_CFQ_400;
103
104		else if (freq < 465000)
105			return ITE_CFQ_450;
106
107		else if (freq < 490000)
108			return ITE_CFQ_480;
109
110		else
111			return ITE_CFQ_500;
112	} else {
113			/* trim to limits */
114		if (freq < ITE_LCF_MIN_CARRIER_FREQ)
115			freq = ITE_LCF_MIN_CARRIER_FREQ;
116		if (freq > ITE_LCF_MAX_CARRIER_FREQ)
117			freq = ITE_LCF_MAX_CARRIER_FREQ;
118
119		/* convert to kHz and subtract the base freq */
120		freq =
121		    DIV_ROUND_CLOSEST(freq - ITE_LCF_MIN_CARRIER_FREQ,
122				      1000);
123
124		return (u8) freq;
125	}
126}
127
128/* get the bits required to program the pulse with in TXMPW */
129static u8 ite_get_pulse_width_bits(unsigned int freq, int duty_cycle)
130{
131	unsigned long period_ns, on_ns;
132
133	/* sanitize freq into range */
134	if (freq < ITE_LCF_MIN_CARRIER_FREQ)
135		freq = ITE_LCF_MIN_CARRIER_FREQ;
136	if (freq > ITE_HCF_MAX_CARRIER_FREQ)
137		freq = ITE_HCF_MAX_CARRIER_FREQ;
138
139	period_ns = 1000000000UL / freq;
140	on_ns = period_ns * duty_cycle / 100;
141
142	if (ite_is_high_carrier_freq(freq)) {
143		if (on_ns < 750)
144			return ITE_TXMPW_A;
145
146		else if (on_ns < 850)
147			return ITE_TXMPW_B;
148
149		else if (on_ns < 950)
150			return ITE_TXMPW_C;
151
152		else if (on_ns < 1080)
153			return ITE_TXMPW_D;
154
155		else
156			return ITE_TXMPW_E;
157	} else {
158		if (on_ns < 6500)
159			return ITE_TXMPW_A;
160
161		else if (on_ns < 7850)
162			return ITE_TXMPW_B;
163
164		else if (on_ns < 9650)
165			return ITE_TXMPW_C;
166
167		else if (on_ns < 11950)
168			return ITE_TXMPW_D;
169
170		else
171			return ITE_TXMPW_E;
172	}
173}
174
175/* decode raw bytes as received by the hardware, and push them to the ir-core
176 * layer */
177static void ite_decode_bytes(struct ite_dev *dev, const u8 * data, int
178			     length)
179{
180	u32 sample_period;
181	unsigned long *ldata;
182	unsigned int next_one, next_zero, size;
183	DEFINE_IR_RAW_EVENT(ev);
184
185	if (length == 0)
186		return;
187
188	sample_period = dev->params.sample_period;
189	ldata = (unsigned long *)data;
190	size = length << 3;
191	next_one = find_next_bit_le(ldata, size, 0);
192	if (next_one > 0) {
193		ev.pulse = true;
194		ev.duration =
195		    ITE_BITS_TO_NS(next_one, sample_period);
196		ir_raw_event_store_with_filter(dev->rdev, &ev);
197	}
198
199	while (next_one < size) {
200		next_zero = find_next_zero_bit_le(ldata, size, next_one + 1);
201		ev.pulse = false;
202		ev.duration = ITE_BITS_TO_NS(next_zero - next_one, sample_period);
203		ir_raw_event_store_with_filter(dev->rdev, &ev);
204
205		if (next_zero < size) {
206			next_one =
207			    find_next_bit_le(ldata,
208						     size,
209						     next_zero + 1);
210			ev.pulse = true;
211			ev.duration =
212			    ITE_BITS_TO_NS(next_one - next_zero,
213					   sample_period);
214			ir_raw_event_store_with_filter
215			    (dev->rdev, &ev);
216		} else
217			next_one = size;
218	}
219
220	ir_raw_event_handle(dev->rdev);
221
222	ite_dbg_verbose("decoded %d bytes.", length);
223}
224
225/* set all the rx/tx carrier parameters; this must be called with the device
226 * spinlock held */
227static void ite_set_carrier_params(struct ite_dev *dev)
228{
229	unsigned int freq, low_freq, high_freq;
230	int allowance;
231	bool use_demodulator;
232	bool for_tx = dev->transmitting;
233
234	ite_dbg("%s called", __func__);
235
236	if (for_tx) {
237		/* we don't need no stinking calculations */
238		freq = dev->params.tx_carrier_freq;
239		allowance = ITE_RXDCR_DEFAULT;
240		use_demodulator = false;
241	} else {
242		low_freq = dev->params.rx_low_carrier_freq;
243		high_freq = dev->params.rx_high_carrier_freq;
244
245		if (low_freq == 0) {
246			/* don't demodulate */
247			freq =
248			ITE_DEFAULT_CARRIER_FREQ;
249			allowance = ITE_RXDCR_DEFAULT;
250			use_demodulator = false;
251		} else {
252			/* calculate the middle freq */
253			freq = (low_freq + high_freq) / 2;
254
255			/* calculate the allowance */
256			allowance =
257			    DIV_ROUND_CLOSEST(10000 * (high_freq - low_freq),
258					      ITE_RXDCR_PER_10000_STEP
259					      * (high_freq + low_freq));
260
261			if (allowance < 1)
262				allowance = 1;
263
264			if (allowance > ITE_RXDCR_MAX)
265				allowance = ITE_RXDCR_MAX;
266		}
267	}
268
269	/* set the carrier parameters in a device-dependent way */
270	dev->params.set_carrier_params(dev, ite_is_high_carrier_freq(freq),
271		 use_demodulator, ite_get_carrier_freq_bits(freq), allowance,
272		 ite_get_pulse_width_bits(freq, dev->params.tx_duty_cycle));
273}
274
275/* interrupt service routine for incoming and outgoing CIR data */
276static irqreturn_t ite_cir_isr(int irq, void *data)
277{
278	struct ite_dev *dev = data;
279	unsigned long flags;
280	irqreturn_t ret = IRQ_RETVAL(IRQ_NONE);
281	u8 rx_buf[ITE_RX_FIFO_LEN];
282	int rx_bytes;
283	int iflags;
284
285	ite_dbg_verbose("%s firing", __func__);
286
287	/* grab the spinlock */
288	spin_lock_irqsave(&dev->lock, flags);
289
290	/* read the interrupt flags */
291	iflags = dev->params.get_irq_causes(dev);
292
293	/* check for the receive interrupt */
294	if (iflags & (ITE_IRQ_RX_FIFO | ITE_IRQ_RX_FIFO_OVERRUN)) {
295		/* read the FIFO bytes */
296		rx_bytes =
297			dev->params.get_rx_bytes(dev, rx_buf,
298					     ITE_RX_FIFO_LEN);
299
300		if (rx_bytes > 0) {
301			/* drop the spinlock, since the ir-core layer
302			 * may call us back again through
303			 * ite_s_idle() */
304			spin_unlock_irqrestore(&dev->
305									 lock,
306									 flags);
307
308			/* decode the data we've just received */
309			ite_decode_bytes(dev, rx_buf,
310								   rx_bytes);
311
312			/* reacquire the spinlock */
313			spin_lock_irqsave(&dev->lock,
314								    flags);
315
316			/* mark the interrupt as serviced */
317			ret = IRQ_RETVAL(IRQ_HANDLED);
318		}
319	} else if (iflags & ITE_IRQ_TX_FIFO) {
320		/* FIFO space available interrupt */
321		ite_dbg_verbose("got interrupt for TX FIFO");
322
323		/* wake any sleeping transmitter */
324		wake_up_interruptible(&dev->tx_queue);
325
326		/* mark the interrupt as serviced */
327		ret = IRQ_RETVAL(IRQ_HANDLED);
328	}
329
330	/* drop the spinlock */
331	spin_unlock_irqrestore(&dev->lock, flags);
332
333	ite_dbg_verbose("%s done returning %d", __func__, (int)ret);
334
335	return ret;
336}
337
338/* set the rx carrier freq range, guess it's in Hz... */
339static int ite_set_rx_carrier_range(struct rc_dev *rcdev, u32 carrier_low, u32
340				    carrier_high)
341{
342	unsigned long flags;
343	struct ite_dev *dev = rcdev->priv;
344
345	spin_lock_irqsave(&dev->lock, flags);
346	dev->params.rx_low_carrier_freq = carrier_low;
347	dev->params.rx_high_carrier_freq = carrier_high;
348	ite_set_carrier_params(dev);
349	spin_unlock_irqrestore(&dev->lock, flags);
350
351	return 0;
352}
353
354/* set the tx carrier freq, guess it's in Hz... */
355static int ite_set_tx_carrier(struct rc_dev *rcdev, u32 carrier)
356{
357	unsigned long flags;
358	struct ite_dev *dev = rcdev->priv;
359
360	spin_lock_irqsave(&dev->lock, flags);
361	dev->params.tx_carrier_freq = carrier;
362	ite_set_carrier_params(dev);
363	spin_unlock_irqrestore(&dev->lock, flags);
364
365	return 0;
366}
367
368/* set the tx duty cycle by controlling the pulse width */
369static int ite_set_tx_duty_cycle(struct rc_dev *rcdev, u32 duty_cycle)
370{
371	unsigned long flags;
372	struct ite_dev *dev = rcdev->priv;
373
374	spin_lock_irqsave(&dev->lock, flags);
375	dev->params.tx_duty_cycle = duty_cycle;
376	ite_set_carrier_params(dev);
377	spin_unlock_irqrestore(&dev->lock, flags);
378
379	return 0;
380}
381
382/* transmit out IR pulses; what you get here is a batch of alternating
383 * pulse/space/pulse/space lengths that we should write out completely through
384 * the FIFO, blocking on a full FIFO */
385static int ite_tx_ir(struct rc_dev *rcdev, int *txbuf, u32 n)
386{
387	unsigned long flags;
388	struct ite_dev *dev = rcdev->priv;
389	bool is_pulse = false;
390	int remaining_us, fifo_avail, fifo_remaining, last_idx = 0;
391	int max_rle_us, next_rle_us;
392	int ret = n;
393	u8 last_sent[ITE_TX_FIFO_LEN];
394	u8 val;
395
396	ite_dbg("%s called", __func__);
397
398	/* clear the array just in case */
399	memset(last_sent, 0, ARRAY_SIZE(last_sent));
400
401	/* n comes in bytes; convert to ints */
402	n /= sizeof(int);
403
404	spin_lock_irqsave(&dev->lock, flags);
405
406	/* let everybody know we're now transmitting */
407	dev->transmitting = true;
408
409	/* and set the carrier values for transmission */
410	ite_set_carrier_params(dev);
411
412	/* calculate how much time we can send in one byte */
413	max_rle_us =
414	    (ITE_BAUDRATE_DIVISOR * dev->params.sample_period *
415	     ITE_TX_MAX_RLE) / 1000;
416
417	/* disable the receiver */
418	dev->params.disable_rx(dev);
419
420	/* this is where we'll begin filling in the FIFO, until it's full.
421	 * then we'll just activate the interrupt, wait for it to wake us up
422	 * again, disable it, continue filling the FIFO... until everything
423	 * has been pushed out */
424	fifo_avail =
425	    ITE_TX_FIFO_LEN - dev->params.get_tx_used_slots(dev);
426
427	while (n > 0 && dev->in_use) {
428		/* transmit the next sample */
429		is_pulse = !is_pulse;
430		remaining_us = *(txbuf++);
431		n--;
432
433		ite_dbg("%s: %ld",
434				      ((is_pulse) ? "pulse" : "space"),
435				      (long int)
436				      remaining_us);
437
438		/* repeat while the pulse is non-zero length */
439		while (remaining_us > 0 && dev->in_use) {
440			if (remaining_us > max_rle_us)
441				next_rle_us = max_rle_us;
442
443			else
444				next_rle_us = remaining_us;
445
446			remaining_us -= next_rle_us;
447
448			/* check what's the length we have to pump out */
449			val = (ITE_TX_MAX_RLE * next_rle_us) / max_rle_us;
450
451			/* put it into the sent buffer */
452			last_sent[last_idx++] = val;
453			last_idx &= (ITE_TX_FIFO_LEN);
454
455			/* encode it for 7 bits */
456			val = (val - 1) & ITE_TX_RLE_MASK;
457
458			/* take into account pulse/space prefix */
459			if (is_pulse)
460				val |= ITE_TX_PULSE;
461
462			else
463				val |= ITE_TX_SPACE;
464
465			/*
466			 * if we get to 0 available, read again, just in case
467			 * some other slot got freed
468			 */
469			if (fifo_avail <= 0)
470				fifo_avail = ITE_TX_FIFO_LEN - dev->params.get_tx_used_slots(dev);
471
472			/* if it's still full */
473			if (fifo_avail <= 0) {
474				/* enable the tx interrupt */
475				dev->params.
476				enable_tx_interrupt(dev);
477
478				/* drop the spinlock */
479				spin_unlock_irqrestore(&dev->lock, flags);
480
481				/* wait for the FIFO to empty enough */
482				wait_event_interruptible(dev->tx_queue, (fifo_avail = ITE_TX_FIFO_LEN - dev->params.get_tx_used_slots(dev)) >= 8);
483
484				/* get the spinlock again */
485				spin_lock_irqsave(&dev->lock, flags);
486
487				/* disable the tx interrupt again. */
488				dev->params.
489				disable_tx_interrupt(dev);
490			}
491
492			/* now send the byte through the FIFO */
493			dev->params.put_tx_byte(dev, val);
494			fifo_avail--;
495		}
496	}
497
498	/* wait and don't return until the whole FIFO has been sent out;
499	 * otherwise we could configure the RX carrier params instead of the
500	 * TX ones while the transmission is still being performed! */
501	fifo_remaining = dev->params.get_tx_used_slots(dev);
502	remaining_us = 0;
503	while (fifo_remaining > 0) {
504		fifo_remaining--;
505		last_idx--;
506		last_idx &= (ITE_TX_FIFO_LEN - 1);
507		remaining_us += last_sent[last_idx];
508	}
509	remaining_us = (remaining_us * max_rle_us) / (ITE_TX_MAX_RLE);
510
511	/* drop the spinlock while we sleep */
512	spin_unlock_irqrestore(&dev->lock, flags);
513
514	/* sleep remaining_us microseconds */
515	mdelay(DIV_ROUND_UP(remaining_us, 1000));
516
517	/* reacquire the spinlock */
518	spin_lock_irqsave(&dev->lock, flags);
519
520	/* now we're not transmitting anymore */
521	dev->transmitting = false;
522
523	/* and set the carrier values for reception */
524	ite_set_carrier_params(dev);
525
526	/* reenable the receiver */
527	if (dev->in_use)
528		dev->params.enable_rx(dev);
529
530	/* notify transmission end */
531	wake_up_interruptible(&dev->tx_ended);
532
533	spin_unlock_irqrestore(&dev->lock, flags);
534
535	return ret;
536}
537
538/* idle the receiver if needed */
539static void ite_s_idle(struct rc_dev *rcdev, bool enable)
540{
541	unsigned long flags;
542	struct ite_dev *dev = rcdev->priv;
543
544	ite_dbg("%s called", __func__);
545
546	if (enable) {
547		spin_lock_irqsave(&dev->lock, flags);
548		dev->params.idle_rx(dev);
549		spin_unlock_irqrestore(&dev->lock, flags);
550	}
551}
552
553
554/* IT8712F HW-specific functions */
555
556/* retrieve a bitmask of the current causes for a pending interrupt; this may
557 * be composed of ITE_IRQ_TX_FIFO, ITE_IRQ_RX_FIFO and ITE_IRQ_RX_FIFO_OVERRUN
558 * */
559static int it87_get_irq_causes(struct ite_dev *dev)
560{
561	u8 iflags;
562	int ret = 0;
563
564	ite_dbg("%s called", __func__);
565
566	/* read the interrupt flags */
567	iflags = inb(dev->cir_addr + IT87_IIR) & IT87_II;
568
569	switch (iflags) {
570	case IT87_II_RXDS:
571		ret = ITE_IRQ_RX_FIFO;
572		break;
573	case IT87_II_RXFO:
574		ret = ITE_IRQ_RX_FIFO_OVERRUN;
575		break;
576	case IT87_II_TXLDL:
577		ret = ITE_IRQ_TX_FIFO;
578		break;
579	}
580
581	return ret;
582}
583
584/* set the carrier parameters; to be called with the spinlock held */
585static void it87_set_carrier_params(struct ite_dev *dev, bool high_freq,
586				    bool use_demodulator,
587				    u8 carrier_freq_bits, u8 allowance_bits,
588				    u8 pulse_width_bits)
589{
590	u8 val;
591
592	ite_dbg("%s called", __func__);
593
594	/* program the RCR register */
595	val = inb(dev->cir_addr + IT87_RCR)
596		& ~(IT87_HCFS | IT87_RXEND | IT87_RXDCR);
597
598	if (high_freq)
599		val |= IT87_HCFS;
600
601	if (use_demodulator)
602		val |= IT87_RXEND;
603
604	val |= allowance_bits;
605
606	outb(val, dev->cir_addr + IT87_RCR);
607
608	/* program the TCR2 register */
609	outb((carrier_freq_bits << IT87_CFQ_SHIFT) | pulse_width_bits,
610		dev->cir_addr + IT87_TCR2);
611}
612
613/* read up to buf_size bytes from the RX FIFO; to be called with the spinlock
614 * held */
615static int it87_get_rx_bytes(struct ite_dev *dev, u8 * buf, int buf_size)
616{
617	int fifo, read = 0;
618
619	ite_dbg("%s called", __func__);
620
621	/* read how many bytes are still in the FIFO */
622	fifo = inb(dev->cir_addr + IT87_RSR) & IT87_RXFBC;
623
624	while (fifo > 0 && buf_size > 0) {
625		*(buf++) = inb(dev->cir_addr + IT87_DR);
626		fifo--;
627		read++;
628		buf_size--;
629	}
630
631	return read;
632}
633
634/* return how many bytes are still in the FIFO; this will be called
635 * with the device spinlock NOT HELD while waiting for the TX FIFO to get
636 * empty; let's expect this won't be a problem */
637static int it87_get_tx_used_slots(struct ite_dev *dev)
638{
639	ite_dbg("%s called", __func__);
640
641	return inb(dev->cir_addr + IT87_TSR) & IT87_TXFBC;
642}
643
644/* put a byte to the TX fifo; this should be called with the spinlock held */
645static void it87_put_tx_byte(struct ite_dev *dev, u8 value)
646{
647	outb(value, dev->cir_addr + IT87_DR);
648}
649
650/* idle the receiver so that we won't receive samples until another
651  pulse is detected; this must be called with the device spinlock held */
652static void it87_idle_rx(struct ite_dev *dev)
653{
654	ite_dbg("%s called", __func__);
655
656	/* disable streaming by clearing RXACT writing it as 1 */
657	outb(inb(dev->cir_addr + IT87_RCR) | IT87_RXACT,
658		dev->cir_addr + IT87_RCR);
659
660	/* clear the FIFO */
661	outb(inb(dev->cir_addr + IT87_TCR1) | IT87_FIFOCLR,
662		dev->cir_addr + IT87_TCR1);
663}
664
665/* disable the receiver; this must be called with the device spinlock held */
666static void it87_disable_rx(struct ite_dev *dev)
667{
668	ite_dbg("%s called", __func__);
669
670	/* disable the receiver interrupts */
671	outb(inb(dev->cir_addr + IT87_IER) & ~(IT87_RDAIE | IT87_RFOIE),
672		dev->cir_addr + IT87_IER);
673
674	/* disable the receiver */
675	outb(inb(dev->cir_addr + IT87_RCR) & ~IT87_RXEN,
676		dev->cir_addr + IT87_RCR);
677
678	/* clear the FIFO and RXACT (actually RXACT should have been cleared
679	* in the previous outb() call) */
680	it87_idle_rx(dev);
681}
682
683/* enable the receiver; this must be called with the device spinlock held */
684static void it87_enable_rx(struct ite_dev *dev)
685{
686	ite_dbg("%s called", __func__);
687
688	/* enable the receiver by setting RXEN */
689	outb(inb(dev->cir_addr + IT87_RCR) | IT87_RXEN,
690		dev->cir_addr + IT87_RCR);
691
692	/* just prepare it to idle for the next reception */
693	it87_idle_rx(dev);
694
695	/* enable the receiver interrupts and master enable flag */
696	outb(inb(dev->cir_addr + IT87_IER) | IT87_RDAIE | IT87_RFOIE | IT87_IEC,
697		dev->cir_addr + IT87_IER);
698}
699
700/* disable the transmitter interrupt; this must be called with the device
701 * spinlock held */
702static void it87_disable_tx_interrupt(struct ite_dev *dev)
703{
704	ite_dbg("%s called", __func__);
705
706	/* disable the transmitter interrupts */
707	outb(inb(dev->cir_addr + IT87_IER) & ~IT87_TLDLIE,
708		dev->cir_addr + IT87_IER);
709}
710
711/* enable the transmitter interrupt; this must be called with the device
712 * spinlock held */
713static void it87_enable_tx_interrupt(struct ite_dev *dev)
714{
715	ite_dbg("%s called", __func__);
716
717	/* enable the transmitter interrupts and master enable flag */
718	outb(inb(dev->cir_addr + IT87_IER) | IT87_TLDLIE | IT87_IEC,
719		dev->cir_addr + IT87_IER);
720}
721
722/* disable the device; this must be called with the device spinlock held */
723static void it87_disable(struct ite_dev *dev)
724{
725	ite_dbg("%s called", __func__);
726
727	/* clear out all interrupt enable flags */
728	outb(inb(dev->cir_addr + IT87_IER) &
729		~(IT87_IEC | IT87_RFOIE | IT87_RDAIE | IT87_TLDLIE),
730		dev->cir_addr + IT87_IER);
731
732	/* disable the receiver */
733	it87_disable_rx(dev);
734
735	/* erase the FIFO */
736	outb(IT87_FIFOCLR | inb(dev->cir_addr + IT87_TCR1),
737		dev->cir_addr + IT87_TCR1);
738}
739
740/* initialize the hardware */
741static void it87_init_hardware(struct ite_dev *dev)
742{
743	ite_dbg("%s called", __func__);
744
745	/* enable just the baud rate divisor register,
746	disabling all the interrupts at the same time */
747	outb((inb(dev->cir_addr + IT87_IER) &
748		~(IT87_IEC | IT87_RFOIE | IT87_RDAIE | IT87_TLDLIE)) | IT87_BR,
749		dev->cir_addr + IT87_IER);
750
751	/* write out the baud rate divisor */
752	outb(ITE_BAUDRATE_DIVISOR & 0xff, dev->cir_addr + IT87_BDLR);
753	outb((ITE_BAUDRATE_DIVISOR >> 8) & 0xff, dev->cir_addr + IT87_BDHR);
754
755	/* disable the baud rate divisor register again */
756	outb(inb(dev->cir_addr + IT87_IER) & ~IT87_BR,
757		dev->cir_addr + IT87_IER);
758
759	/* program the RCR register defaults */
760	outb(ITE_RXDCR_DEFAULT, dev->cir_addr + IT87_RCR);
761
762	/* program the TCR1 register */
763	outb(IT87_TXMPM_DEFAULT | IT87_TXENDF | IT87_TXRLE
764		| IT87_FIFOTL_DEFAULT | IT87_FIFOCLR,
765		dev->cir_addr + IT87_TCR1);
766
767	/* program the carrier parameters */
768	ite_set_carrier_params(dev);
769}
770
771/* IT8512F on ITE8708 HW-specific functions */
772
773/* retrieve a bitmask of the current causes for a pending interrupt; this may
774 * be composed of ITE_IRQ_TX_FIFO, ITE_IRQ_RX_FIFO and ITE_IRQ_RX_FIFO_OVERRUN
775 * */
776static int it8708_get_irq_causes(struct ite_dev *dev)
777{
778	u8 iflags;
779	int ret = 0;
780
781	ite_dbg("%s called", __func__);
782
783	/* read the interrupt flags */
784	iflags = inb(dev->cir_addr + IT8708_C0IIR);
785
786	if (iflags & IT85_TLDLI)
787		ret |= ITE_IRQ_TX_FIFO;
788	if (iflags & IT85_RDAI)
789		ret |= ITE_IRQ_RX_FIFO;
790	if (iflags & IT85_RFOI)
791		ret |= ITE_IRQ_RX_FIFO_OVERRUN;
792
793	return ret;
794}
795
796/* set the carrier parameters; to be called with the spinlock held */
797static void it8708_set_carrier_params(struct ite_dev *dev, bool high_freq,
798				      bool use_demodulator,
799				      u8 carrier_freq_bits, u8 allowance_bits,
800				      u8 pulse_width_bits)
801{
802	u8 val;
803
804	ite_dbg("%s called", __func__);
805
806	/* program the C0CFR register, with HRAE=1 */
807	outb(inb(dev->cir_addr + IT8708_BANKSEL) | IT8708_HRAE,
808		dev->cir_addr + IT8708_BANKSEL);
809
810	val = (inb(dev->cir_addr + IT8708_C0CFR)
811		& ~(IT85_HCFS | IT85_CFQ)) | carrier_freq_bits;
812
813	if (high_freq)
814		val |= IT85_HCFS;
815
816	outb(val, dev->cir_addr + IT8708_C0CFR);
817
818	outb(inb(dev->cir_addr + IT8708_BANKSEL) & ~IT8708_HRAE,
819		   dev->cir_addr + IT8708_BANKSEL);
820
821	/* program the C0RCR register */
822	val = inb(dev->cir_addr + IT8708_C0RCR)
823		& ~(IT85_RXEND | IT85_RXDCR);
824
825	if (use_demodulator)
826		val |= IT85_RXEND;
827
828	val |= allowance_bits;
829
830	outb(val, dev->cir_addr + IT8708_C0RCR);
831
832	/* program the C0TCR register */
833	val = inb(dev->cir_addr + IT8708_C0TCR) & ~IT85_TXMPW;
834	val |= pulse_width_bits;
835	outb(val, dev->cir_addr + IT8708_C0TCR);
836}
837
838/* read up to buf_size bytes from the RX FIFO; to be called with the spinlock
839 * held */
840static int it8708_get_rx_bytes(struct ite_dev *dev, u8 * buf, int buf_size)
841{
842	int fifo, read = 0;
843
844	ite_dbg("%s called", __func__);
845
846	/* read how many bytes are still in the FIFO */
847	fifo = inb(dev->cir_addr + IT8708_C0RFSR) & IT85_RXFBC;
848
849	while (fifo > 0 && buf_size > 0) {
850		*(buf++) = inb(dev->cir_addr + IT8708_C0DR);
851		fifo--;
852		read++;
853		buf_size--;
854	}
855
856	return read;
857}
858
859/* return how many bytes are still in the FIFO; this will be called
860 * with the device spinlock NOT HELD while waiting for the TX FIFO to get
861 * empty; let's expect this won't be a problem */
862static int it8708_get_tx_used_slots(struct ite_dev *dev)
863{
864	ite_dbg("%s called", __func__);
865
866	return inb(dev->cir_addr + IT8708_C0TFSR) & IT85_TXFBC;
867}
868
869/* put a byte to the TX fifo; this should be called with the spinlock held */
870static void it8708_put_tx_byte(struct ite_dev *dev, u8 value)
871{
872	outb(value, dev->cir_addr + IT8708_C0DR);
873}
874
875/* idle the receiver so that we won't receive samples until another
876  pulse is detected; this must be called with the device spinlock held */
877static void it8708_idle_rx(struct ite_dev *dev)
878{
879	ite_dbg("%s called", __func__);
880
881	/* disable streaming by clearing RXACT writing it as 1 */
882	outb(inb(dev->cir_addr + IT8708_C0RCR) | IT85_RXACT,
883		dev->cir_addr + IT8708_C0RCR);
884
885	/* clear the FIFO */
886	outb(inb(dev->cir_addr + IT8708_C0MSTCR) | IT85_FIFOCLR,
887		dev->cir_addr + IT8708_C0MSTCR);
888}
889
890/* disable the receiver; this must be called with the device spinlock held */
891static void it8708_disable_rx(struct ite_dev *dev)
892{
893	ite_dbg("%s called", __func__);
894
895	/* disable the receiver interrupts */
896	outb(inb(dev->cir_addr + IT8708_C0IER) &
897		~(IT85_RDAIE | IT85_RFOIE),
898		dev->cir_addr + IT8708_C0IER);
899
900	/* disable the receiver */
901	outb(inb(dev->cir_addr + IT8708_C0RCR) & ~IT85_RXEN,
902		dev->cir_addr + IT8708_C0RCR);
903
904	/* clear the FIFO and RXACT (actually RXACT should have been cleared
905	 * in the previous outb() call) */
906	it8708_idle_rx(dev);
907}
908
909/* enable the receiver; this must be called with the device spinlock held */
910static void it8708_enable_rx(struct ite_dev *dev)
911{
912	ite_dbg("%s called", __func__);
913
914	/* enable the receiver by setting RXEN */
915	outb(inb(dev->cir_addr + IT8708_C0RCR) | IT85_RXEN,
916		dev->cir_addr + IT8708_C0RCR);
917
918	/* just prepare it to idle for the next reception */
919	it8708_idle_rx(dev);
920
921	/* enable the receiver interrupts and master enable flag */
922	outb(inb(dev->cir_addr + IT8708_C0IER)
923		|IT85_RDAIE | IT85_RFOIE | IT85_IEC,
924		dev->cir_addr + IT8708_C0IER);
925}
926
927/* disable the transmitter interrupt; this must be called with the device
928 * spinlock held */
929static void it8708_disable_tx_interrupt(struct ite_dev *dev)
930{
931	ite_dbg("%s called", __func__);
932
933	/* disable the transmitter interrupts */
934	outb(inb(dev->cir_addr + IT8708_C0IER) & ~IT85_TLDLIE,
935		dev->cir_addr + IT8708_C0IER);
936}
937
938/* enable the transmitter interrupt; this must be called with the device
939 * spinlock held */
940static void it8708_enable_tx_interrupt(struct ite_dev *dev)
941{
942	ite_dbg("%s called", __func__);
943
944	/* enable the transmitter interrupts and master enable flag */
945	outb(inb(dev->cir_addr + IT8708_C0IER)
946		|IT85_TLDLIE | IT85_IEC,
947		dev->cir_addr + IT8708_C0IER);
948}
949
950/* disable the device; this must be called with the device spinlock held */
951static void it8708_disable(struct ite_dev *dev)
952{
953	ite_dbg("%s called", __func__);
954
955	/* clear out all interrupt enable flags */
956	outb(inb(dev->cir_addr + IT8708_C0IER) &
957		~(IT85_IEC | IT85_RFOIE | IT85_RDAIE | IT85_TLDLIE),
958		dev->cir_addr + IT8708_C0IER);
959
960	/* disable the receiver */
961	it8708_disable_rx(dev);
962
963	/* erase the FIFO */
964	outb(IT85_FIFOCLR | inb(dev->cir_addr + IT8708_C0MSTCR),
965		dev->cir_addr + IT8708_C0MSTCR);
966}
967
968/* initialize the hardware */
969static void it8708_init_hardware(struct ite_dev *dev)
970{
971	ite_dbg("%s called", __func__);
972
973	/* disable all the interrupts */
974	outb(inb(dev->cir_addr + IT8708_C0IER) &
975		~(IT85_IEC | IT85_RFOIE | IT85_RDAIE | IT85_TLDLIE),
976		dev->cir_addr + IT8708_C0IER);
977
978	/* program the baud rate divisor */
979	outb(inb(dev->cir_addr + IT8708_BANKSEL) | IT8708_HRAE,
980		dev->cir_addr + IT8708_BANKSEL);
981
982	outb(ITE_BAUDRATE_DIVISOR & 0xff, dev->cir_addr + IT8708_C0BDLR);
983	outb((ITE_BAUDRATE_DIVISOR >> 8) & 0xff,
984		   dev->cir_addr + IT8708_C0BDHR);
985
986	outb(inb(dev->cir_addr + IT8708_BANKSEL) & ~IT8708_HRAE,
987		   dev->cir_addr + IT8708_BANKSEL);
988
989	/* program the C0MSTCR register defaults */
990	outb((inb(dev->cir_addr + IT8708_C0MSTCR) &
991			~(IT85_ILSEL | IT85_ILE | IT85_FIFOTL |
992			  IT85_FIFOCLR | IT85_RESET)) |
993		       IT85_FIFOTL_DEFAULT,
994		       dev->cir_addr + IT8708_C0MSTCR);
995
996	/* program the C0RCR register defaults */
997	outb((inb(dev->cir_addr + IT8708_C0RCR) &
998			~(IT85_RXEN | IT85_RDWOS | IT85_RXEND |
999			  IT85_RXACT | IT85_RXDCR)) |
1000		       ITE_RXDCR_DEFAULT,
1001		       dev->cir_addr + IT8708_C0RCR);
1002
1003	/* program the C0TCR register defaults */
1004	outb((inb(dev->cir_addr + IT8708_C0TCR) &
1005			~(IT85_TXMPM | IT85_TXMPW))
1006		       |IT85_TXRLE | IT85_TXENDF |
1007		       IT85_TXMPM_DEFAULT | IT85_TXMPW_DEFAULT,
1008		       dev->cir_addr + IT8708_C0TCR);
1009
1010	/* program the carrier parameters */
1011	ite_set_carrier_params(dev);
1012}
1013
1014/* IT8512F on ITE8709 HW-specific functions */
1015
1016/* read a byte from the SRAM module */
1017static inline u8 it8709_rm(struct ite_dev *dev, int index)
1018{
1019	outb(index, dev->cir_addr + IT8709_RAM_IDX);
1020	return inb(dev->cir_addr + IT8709_RAM_VAL);
1021}
1022
1023/* write a byte to the SRAM module */
1024static inline void it8709_wm(struct ite_dev *dev, u8 val, int index)
1025{
1026	outb(index, dev->cir_addr + IT8709_RAM_IDX);
1027	outb(val, dev->cir_addr + IT8709_RAM_VAL);
1028}
1029
1030static void it8709_wait(struct ite_dev *dev)
1031{
1032	int i = 0;
1033	/*
1034	 * loop until device tells it's ready to continue
1035	 * iterations count is usually ~750 but can sometimes achieve 13000
1036	 */
1037	for (i = 0; i < 15000; i++) {
1038		udelay(2);
1039		if (it8709_rm(dev, IT8709_MODE) == IT8709_IDLE)
1040			break;
1041	}
1042}
1043
1044/* read the value of a CIR register */
1045static u8 it8709_rr(struct ite_dev *dev, int index)
1046{
1047	/* just wait in case the previous access was a write */
1048	it8709_wait(dev);
1049	it8709_wm(dev, index, IT8709_REG_IDX);
1050	it8709_wm(dev, IT8709_READ, IT8709_MODE);
1051
1052	/* wait for the read data to be available */
1053	it8709_wait(dev);
1054
1055	/* return the read value */
1056	return it8709_rm(dev, IT8709_REG_VAL);
1057}
1058
1059/* write the value of a CIR register */
1060static void it8709_wr(struct ite_dev *dev, u8 val, int index)
1061{
1062	/* we wait before writing, and not afterwards, since this allows us to
1063	 * pipeline the host CPU with the microcontroller */
1064	it8709_wait(dev);
1065	it8709_wm(dev, val, IT8709_REG_VAL);
1066	it8709_wm(dev, index, IT8709_REG_IDX);
1067	it8709_wm(dev, IT8709_WRITE, IT8709_MODE);
1068}
1069
1070/* retrieve a bitmask of the current causes for a pending interrupt; this may
1071 * be composed of ITE_IRQ_TX_FIFO, ITE_IRQ_RX_FIFO and ITE_IRQ_RX_FIFO_OVERRUN
1072 * */
1073static int it8709_get_irq_causes(struct ite_dev *dev)
1074{
1075	u8 iflags;
1076	int ret = 0;
1077
1078	ite_dbg("%s called", __func__);
1079
1080	/* read the interrupt flags */
1081	iflags = it8709_rm(dev, IT8709_IIR);
1082
1083	if (iflags & IT85_TLDLI)
1084		ret |= ITE_IRQ_TX_FIFO;
1085	if (iflags & IT85_RDAI)
1086		ret |= ITE_IRQ_RX_FIFO;
1087	if (iflags & IT85_RFOI)
1088		ret |= ITE_IRQ_RX_FIFO_OVERRUN;
1089
1090	return ret;
1091}
1092
1093/* set the carrier parameters; to be called with the spinlock held */
1094static void it8709_set_carrier_params(struct ite_dev *dev, bool high_freq,
1095				      bool use_demodulator,
1096				      u8 carrier_freq_bits, u8 allowance_bits,
1097				      u8 pulse_width_bits)
1098{
1099	u8 val;
1100
1101	ite_dbg("%s called", __func__);
1102
1103	val = (it8709_rr(dev, IT85_C0CFR)
1104		     &~(IT85_HCFS | IT85_CFQ)) |
1105	    carrier_freq_bits;
1106
1107	if (high_freq)
1108		val |= IT85_HCFS;
1109
1110	it8709_wr(dev, val, IT85_C0CFR);
1111
1112	/* program the C0RCR register */
1113	val = it8709_rr(dev, IT85_C0RCR)
1114		& ~(IT85_RXEND | IT85_RXDCR);
1115
1116	if (use_demodulator)
1117		val |= IT85_RXEND;
1118
1119	val |= allowance_bits;
1120
1121	it8709_wr(dev, val, IT85_C0RCR);
1122
1123	/* program the C0TCR register */
1124	val = it8709_rr(dev, IT85_C0TCR) & ~IT85_TXMPW;
1125	val |= pulse_width_bits;
1126	it8709_wr(dev, val, IT85_C0TCR);
1127}
1128
1129/* read up to buf_size bytes from the RX FIFO; to be called with the spinlock
1130 * held */
1131static int it8709_get_rx_bytes(struct ite_dev *dev, u8 * buf, int buf_size)
1132{
1133	int fifo, read = 0;
1134
1135	ite_dbg("%s called", __func__);
1136
1137	/* read how many bytes are still in the FIFO */
1138	fifo = it8709_rm(dev, IT8709_RFSR) & IT85_RXFBC;
1139
1140	while (fifo > 0 && buf_size > 0) {
1141		*(buf++) = it8709_rm(dev, IT8709_FIFO + read);
1142		fifo--;
1143		read++;
1144		buf_size--;
1145	}
1146
1147	/* 'clear' the FIFO by setting the writing index to 0; this is
1148	 * completely bound to be racy, but we can't help it, since it's a
1149	 * limitation of the protocol */
1150	it8709_wm(dev, 0, IT8709_RFSR);
1151
1152	return read;
1153}
1154
1155/* return how many bytes are still in the FIFO; this will be called
1156 * with the device spinlock NOT HELD while waiting for the TX FIFO to get
1157 * empty; let's expect this won't be a problem */
1158static int it8709_get_tx_used_slots(struct ite_dev *dev)
1159{
1160	ite_dbg("%s called", __func__);
1161
1162	return it8709_rr(dev, IT85_C0TFSR) & IT85_TXFBC;
1163}
1164
1165/* put a byte to the TX fifo; this should be called with the spinlock held */
1166static void it8709_put_tx_byte(struct ite_dev *dev, u8 value)
1167{
1168	it8709_wr(dev, value, IT85_C0DR);
1169}
1170
1171/* idle the receiver so that we won't receive samples until another
1172  pulse is detected; this must be called with the device spinlock held */
1173static void it8709_idle_rx(struct ite_dev *dev)
1174{
1175	ite_dbg("%s called", __func__);
1176
1177	/* disable streaming by clearing RXACT writing it as 1 */
1178	it8709_wr(dev, it8709_rr(dev, IT85_C0RCR) | IT85_RXACT,
1179			    IT85_C0RCR);
1180
1181	/* clear the FIFO */
1182	it8709_wr(dev, it8709_rr(dev, IT85_C0MSTCR) | IT85_FIFOCLR,
1183			    IT85_C0MSTCR);
1184}
1185
1186/* disable the receiver; this must be called with the device spinlock held */
1187static void it8709_disable_rx(struct ite_dev *dev)
1188{
1189	ite_dbg("%s called", __func__);
1190
1191	/* disable the receiver interrupts */
1192	it8709_wr(dev, it8709_rr(dev, IT85_C0IER) &
1193			    ~(IT85_RDAIE | IT85_RFOIE),
1194			    IT85_C0IER);
1195
1196	/* disable the receiver */
1197	it8709_wr(dev, it8709_rr(dev, IT85_C0RCR) & ~IT85_RXEN,
1198			    IT85_C0RCR);
1199
1200	/* clear the FIFO and RXACT (actually RXACT should have been cleared
1201	 * in the previous it8709_wr(dev, ) call) */
1202	it8709_idle_rx(dev);
1203}
1204
1205/* enable the receiver; this must be called with the device spinlock held */
1206static void it8709_enable_rx(struct ite_dev *dev)
1207{
1208	ite_dbg("%s called", __func__);
1209
1210	/* enable the receiver by setting RXEN */
1211	it8709_wr(dev, it8709_rr(dev, IT85_C0RCR) | IT85_RXEN,
1212			    IT85_C0RCR);
1213
1214	/* just prepare it to idle for the next reception */
1215	it8709_idle_rx(dev);
1216
1217	/* enable the receiver interrupts and master enable flag */
1218	it8709_wr(dev, it8709_rr(dev, IT85_C0IER)
1219			    |IT85_RDAIE | IT85_RFOIE | IT85_IEC,
1220			    IT85_C0IER);
1221}
1222
1223/* disable the transmitter interrupt; this must be called with the device
1224 * spinlock held */
1225static void it8709_disable_tx_interrupt(struct ite_dev *dev)
1226{
1227	ite_dbg("%s called", __func__);
1228
1229	/* disable the transmitter interrupts */
1230	it8709_wr(dev, it8709_rr(dev, IT85_C0IER) & ~IT85_TLDLIE,
1231			    IT85_C0IER);
1232}
1233
1234/* enable the transmitter interrupt; this must be called with the device
1235 * spinlock held */
1236static void it8709_enable_tx_interrupt(struct ite_dev *dev)
1237{
1238	ite_dbg("%s called", __func__);
1239
1240	/* enable the transmitter interrupts and master enable flag */
1241	it8709_wr(dev, it8709_rr(dev, IT85_C0IER)
1242			    |IT85_TLDLIE | IT85_IEC,
1243			    IT85_C0IER);
1244}
1245
1246/* disable the device; this must be called with the device spinlock held */
1247static void it8709_disable(struct ite_dev *dev)
1248{
1249	ite_dbg("%s called", __func__);
1250
1251	/* clear out all interrupt enable flags */
1252	it8709_wr(dev, it8709_rr(dev, IT85_C0IER) &
1253			~(IT85_IEC | IT85_RFOIE | IT85_RDAIE | IT85_TLDLIE),
1254		  IT85_C0IER);
1255
1256	/* disable the receiver */
1257	it8709_disable_rx(dev);
1258
1259	/* erase the FIFO */
1260	it8709_wr(dev, IT85_FIFOCLR | it8709_rr(dev, IT85_C0MSTCR),
1261			    IT85_C0MSTCR);
1262}
1263
1264/* initialize the hardware */
1265static void it8709_init_hardware(struct ite_dev *dev)
1266{
1267	ite_dbg("%s called", __func__);
1268
1269	/* disable all the interrupts */
1270	it8709_wr(dev, it8709_rr(dev, IT85_C0IER) &
1271			~(IT85_IEC | IT85_RFOIE | IT85_RDAIE | IT85_TLDLIE),
1272		  IT85_C0IER);
1273
1274	/* program the baud rate divisor */
1275	it8709_wr(dev, ITE_BAUDRATE_DIVISOR & 0xff, IT85_C0BDLR);
1276	it8709_wr(dev, (ITE_BAUDRATE_DIVISOR >> 8) & 0xff,
1277			IT85_C0BDHR);
1278
1279	/* program the C0MSTCR register defaults */
1280	it8709_wr(dev, (it8709_rr(dev, IT85_C0MSTCR) &
1281			~(IT85_ILSEL | IT85_ILE | IT85_FIFOTL
1282			  | IT85_FIFOCLR | IT85_RESET)) | IT85_FIFOTL_DEFAULT,
1283		  IT85_C0MSTCR);
1284
1285	/* program the C0RCR register defaults */
1286	it8709_wr(dev, (it8709_rr(dev, IT85_C0RCR) &
1287			~(IT85_RXEN | IT85_RDWOS | IT85_RXEND | IT85_RXACT
1288			  | IT85_RXDCR)) | ITE_RXDCR_DEFAULT,
1289		  IT85_C0RCR);
1290
1291	/* program the C0TCR register defaults */
1292	it8709_wr(dev, (it8709_rr(dev, IT85_C0TCR) & ~(IT85_TXMPM | IT85_TXMPW))
1293			| IT85_TXRLE | IT85_TXENDF | IT85_TXMPM_DEFAULT
1294			| IT85_TXMPW_DEFAULT,
1295		  IT85_C0TCR);
1296
1297	/* program the carrier parameters */
1298	ite_set_carrier_params(dev);
1299}
1300
1301
1302/* generic hardware setup/teardown code */
1303
1304/* activate the device for use */
1305static int ite_open(struct rc_dev *rcdev)
1306{
1307	struct ite_dev *dev = rcdev->priv;
1308	unsigned long flags;
1309
1310	ite_dbg("%s called", __func__);
1311
1312	spin_lock_irqsave(&dev->lock, flags);
1313	dev->in_use = true;
1314
1315	/* enable the receiver */
1316	dev->params.enable_rx(dev);
1317
1318	spin_unlock_irqrestore(&dev->lock, flags);
1319
1320	return 0;
1321}
1322
1323/* deactivate the device for use */
1324static void ite_close(struct rc_dev *rcdev)
1325{
1326	struct ite_dev *dev = rcdev->priv;
1327	unsigned long flags;
1328
1329	ite_dbg("%s called", __func__);
1330
1331	spin_lock_irqsave(&dev->lock, flags);
1332	dev->in_use = false;
1333
1334	/* wait for any transmission to end */
1335	spin_unlock_irqrestore(&dev->lock, flags);
1336	wait_event_interruptible(dev->tx_ended, !dev->transmitting);
1337	spin_lock_irqsave(&dev->lock, flags);
1338
1339	dev->params.disable(dev);
1340
1341	spin_unlock_irqrestore(&dev->lock, flags);
1342}
1343
1344/* supported models and their parameters */
1345static const struct ite_dev_params ite_dev_descs[] = {
1346	{	/* 0: ITE8704 */
1347	       .model = "ITE8704 CIR transceiver",
1348	       .io_region_size = IT87_IOREG_LENGTH,
1349	       .hw_tx_capable = true,
1350	       .sample_period = (u32) (1000000000ULL / 115200),
1351	       .tx_carrier_freq = 38000,
1352	       .tx_duty_cycle = 33,
1353	       .rx_low_carrier_freq = 0,
1354	       .rx_high_carrier_freq = 0,
1355
1356		/* operations */
1357	       .get_irq_causes = it87_get_irq_causes,
1358	       .enable_rx = it87_enable_rx,
1359	       .idle_rx = it87_idle_rx,
1360	       .disable_rx = it87_idle_rx,
1361	       .get_rx_bytes = it87_get_rx_bytes,
1362	       .enable_tx_interrupt = it87_enable_tx_interrupt,
1363	       .disable_tx_interrupt = it87_disable_tx_interrupt,
1364	       .get_tx_used_slots = it87_get_tx_used_slots,
1365	       .put_tx_byte = it87_put_tx_byte,
1366	       .disable = it87_disable,
1367	       .init_hardware = it87_init_hardware,
1368	       .set_carrier_params = it87_set_carrier_params,
1369	       },
1370	{	/* 1: ITE8713 */
1371	       .model = "ITE8713 CIR transceiver",
1372	       .io_region_size = IT87_IOREG_LENGTH,
1373	       .hw_tx_capable = true,
1374	       .sample_period = (u32) (1000000000ULL / 115200),
1375	       .tx_carrier_freq = 38000,
1376	       .tx_duty_cycle = 33,
1377	       .rx_low_carrier_freq = 0,
1378	       .rx_high_carrier_freq = 0,
1379
1380		/* operations */
1381	       .get_irq_causes = it87_get_irq_causes,
1382	       .enable_rx = it87_enable_rx,
1383	       .idle_rx = it87_idle_rx,
1384	       .disable_rx = it87_idle_rx,
1385	       .get_rx_bytes = it87_get_rx_bytes,
1386	       .enable_tx_interrupt = it87_enable_tx_interrupt,
1387	       .disable_tx_interrupt = it87_disable_tx_interrupt,
1388	       .get_tx_used_slots = it87_get_tx_used_slots,
1389	       .put_tx_byte = it87_put_tx_byte,
1390	       .disable = it87_disable,
1391	       .init_hardware = it87_init_hardware,
1392	       .set_carrier_params = it87_set_carrier_params,
1393	       },
1394	{	/* 2: ITE8708 */
1395	       .model = "ITE8708 CIR transceiver",
1396	       .io_region_size = IT8708_IOREG_LENGTH,
1397	       .hw_tx_capable = true,
1398	       .sample_period = (u32) (1000000000ULL / 115200),
1399	       .tx_carrier_freq = 38000,
1400	       .tx_duty_cycle = 33,
1401	       .rx_low_carrier_freq = 0,
1402	       .rx_high_carrier_freq = 0,
1403
1404		/* operations */
1405	       .get_irq_causes = it8708_get_irq_causes,
1406	       .enable_rx = it8708_enable_rx,
1407	       .idle_rx = it8708_idle_rx,
1408	       .disable_rx = it8708_idle_rx,
1409	       .get_rx_bytes = it8708_get_rx_bytes,
1410	       .enable_tx_interrupt = it8708_enable_tx_interrupt,
1411	       .disable_tx_interrupt =
1412	       it8708_disable_tx_interrupt,
1413	       .get_tx_used_slots = it8708_get_tx_used_slots,
1414	       .put_tx_byte = it8708_put_tx_byte,
1415	       .disable = it8708_disable,
1416	       .init_hardware = it8708_init_hardware,
1417	       .set_carrier_params = it8708_set_carrier_params,
1418	       },
1419	{	/* 3: ITE8709 */
1420	       .model = "ITE8709 CIR transceiver",
1421	       .io_region_size = IT8709_IOREG_LENGTH,
1422	       .hw_tx_capable = true,
1423	       .sample_period = (u32) (1000000000ULL / 115200),
1424	       .tx_carrier_freq = 38000,
1425	       .tx_duty_cycle = 33,
1426	       .rx_low_carrier_freq = 0,
1427	       .rx_high_carrier_freq = 0,
1428
1429		/* operations */
1430	       .get_irq_causes = it8709_get_irq_causes,
1431	       .enable_rx = it8709_enable_rx,
1432	       .idle_rx = it8709_idle_rx,
1433	       .disable_rx = it8709_idle_rx,
1434	       .get_rx_bytes = it8709_get_rx_bytes,
1435	       .enable_tx_interrupt = it8709_enable_tx_interrupt,
1436	       .disable_tx_interrupt =
1437	       it8709_disable_tx_interrupt,
1438	       .get_tx_used_slots = it8709_get_tx_used_slots,
1439	       .put_tx_byte = it8709_put_tx_byte,
1440	       .disable = it8709_disable,
1441	       .init_hardware = it8709_init_hardware,
1442	       .set_carrier_params = it8709_set_carrier_params,
1443	       },
1444};
1445
1446static const struct pnp_device_id ite_ids[] = {
1447	{"ITE8704", 0},		/* Default model */
1448	{"ITE8713", 1},		/* CIR found in EEEBox 1501U */
1449	{"ITE8708", 2},		/* Bridged IT8512 */
1450	{"ITE8709", 3},		/* SRAM-Bridged IT8512 */
1451	{"", 0},
1452};
1453
1454/* allocate memory, probe hardware, and initialize everything */
1455static int ite_probe(struct pnp_dev *pdev, const struct pnp_device_id
1456		     *dev_id)
1457{
1458	const struct ite_dev_params *dev_desc = NULL;
1459	struct ite_dev *itdev = NULL;
1460	struct rc_dev *rdev = NULL;
1461	int ret = -ENOMEM;
1462	int model_no;
1463
1464	ite_dbg("%s called", __func__);
1465
1466	itdev = kzalloc(sizeof(struct ite_dev), GFP_KERNEL);
1467	if (!itdev)
1468		return ret;
1469
1470	/* input device for IR remote (and tx) */
1471	rdev = rc_allocate_device();
1472	if (!rdev)
1473		goto failure;
1474
1475	ret = -ENODEV;
1476
1477	/* get the model number */
1478	model_no = (int)dev_id->driver_data;
1479	ite_pr(KERN_NOTICE, "Auto-detected model: %s\n",
1480		ite_dev_descs[model_no].model);
1481
1482	if (model_number >= 0 && model_number < ARRAY_SIZE(ite_dev_descs)) {
1483		model_no = model_number;
1484		ite_pr(KERN_NOTICE, "The model has been fixed by a module "
1485			"parameter.");
1486	}
1487
1488	ite_pr(KERN_NOTICE, "Using model: %s\n", ite_dev_descs[model_no].model);
1489
1490	/* get the description for the device */
1491	dev_desc = &ite_dev_descs[model_no];
1492
1493	/* validate pnp resources */
1494	if (!pnp_port_valid(pdev, 0) ||
1495	    pnp_port_len(pdev, 0) != dev_desc->io_region_size) {
1496		dev_err(&pdev->dev, "IR PNP Port not valid!\n");
1497		goto failure;
1498	}
1499
1500	if (!pnp_irq_valid(pdev, 0)) {
1501		dev_err(&pdev->dev, "PNP IRQ not valid!\n");
1502		goto failure;
1503	}
1504
1505	/* store resource values */
1506	itdev->cir_addr = pnp_port_start(pdev, 0);
1507	itdev->cir_irq = pnp_irq(pdev, 0);
1508
1509	/* initialize spinlocks */
1510	spin_lock_init(&itdev->lock);
1511
1512	/* initialize raw event */
1513	init_ir_raw_event(&itdev->rawir);
1514
1515	ret = -EBUSY;
1516	/* now claim resources */
1517	if (!request_region(itdev->cir_addr,
1518				dev_desc->io_region_size, ITE_DRIVER_NAME))
1519		goto failure;
1520
1521	if (request_irq(itdev->cir_irq, ite_cir_isr, IRQF_SHARED,
1522			ITE_DRIVER_NAME, (void *)itdev))
1523		goto failure;
1524
1525	/* set driver data into the pnp device */
1526	pnp_set_drvdata(pdev, itdev);
1527	itdev->pdev = pdev;
1528
1529	/* initialize waitqueues for transmission */
1530	init_waitqueue_head(&itdev->tx_queue);
1531	init_waitqueue_head(&itdev->tx_ended);
1532
1533	/* copy model-specific parameters */
1534	itdev->params = *dev_desc;
1535
1536	/* apply any overrides */
1537	if (sample_period > 0)
1538		itdev->params.sample_period = sample_period;
1539
1540	if (tx_carrier_freq > 0)
1541		itdev->params.tx_carrier_freq = tx_carrier_freq;
1542
1543	if (tx_duty_cycle > 0 && tx_duty_cycle <= 100)
1544		itdev->params.tx_duty_cycle = tx_duty_cycle;
1545
1546	if (rx_low_carrier_freq > 0)
1547		itdev->params.rx_low_carrier_freq = rx_low_carrier_freq;
1548
1549	if (rx_high_carrier_freq > 0)
1550		itdev->params.rx_high_carrier_freq = rx_high_carrier_freq;
1551
1552	/* print out parameters */
1553	ite_pr(KERN_NOTICE, "TX-capable: %d\n", (int)
1554			 itdev->params.hw_tx_capable);
1555	ite_pr(KERN_NOTICE, "Sample period (ns): %ld\n", (long)
1556		     itdev->params.sample_period);
1557	ite_pr(KERN_NOTICE, "TX carrier frequency (Hz): %d\n", (int)
1558		     itdev->params.tx_carrier_freq);
1559	ite_pr(KERN_NOTICE, "TX duty cycle (%%): %d\n", (int)
1560		     itdev->params.tx_duty_cycle);
1561	ite_pr(KERN_NOTICE, "RX low carrier frequency (Hz): %d\n", (int)
1562		     itdev->params.rx_low_carrier_freq);
1563	ite_pr(KERN_NOTICE, "RX high carrier frequency (Hz): %d\n", (int)
1564		     itdev->params.rx_high_carrier_freq);
1565
1566	/* set up hardware initial state */
1567	itdev->params.init_hardware(itdev);
1568
1569	/* set up ir-core props */
1570	rdev->priv = itdev;
1571	rdev->driver_type = RC_DRIVER_IR_RAW;
1572	rdev->allowed_protos = RC_TYPE_ALL;
1573	rdev->open = ite_open;
1574	rdev->close = ite_close;
1575	rdev->s_idle = ite_s_idle;
1576	rdev->s_rx_carrier_range = ite_set_rx_carrier_range;
1577	rdev->min_timeout = ITE_MIN_IDLE_TIMEOUT;
1578	rdev->max_timeout = ITE_MAX_IDLE_TIMEOUT;
1579	rdev->timeout = ITE_IDLE_TIMEOUT;
1580	rdev->rx_resolution = ITE_BAUDRATE_DIVISOR *
1581				itdev->params.sample_period;
1582	rdev->tx_resolution = ITE_BAUDRATE_DIVISOR *
1583				itdev->params.sample_period;
1584
1585	/* set up transmitter related values if needed */
1586	if (itdev->params.hw_tx_capable) {
1587		rdev->tx_ir = ite_tx_ir;
1588		rdev->s_tx_carrier = ite_set_tx_carrier;
1589		rdev->s_tx_duty_cycle = ite_set_tx_duty_cycle;
1590	}
1591
1592	rdev->input_name = dev_desc->model;
1593	rdev->input_id.bustype = BUS_HOST;
1594	rdev->input_id.vendor = PCI_VENDOR_ID_ITE;
1595	rdev->input_id.product = 0;
1596	rdev->input_id.version = 0;
1597	rdev->driver_name = ITE_DRIVER_NAME;
1598	rdev->map_name = RC_MAP_RC6_MCE;
1599
1600	ret = rc_register_device(rdev);
1601	if (ret)
1602		goto failure;
1603
1604	itdev->rdev = rdev;
1605	ite_pr(KERN_NOTICE, "driver has been successfully loaded\n");
1606
1607	return 0;
1608
1609failure:
1610	if (itdev->cir_irq)
1611		free_irq(itdev->cir_irq, itdev);
1612
1613	if (itdev->cir_addr)
1614		release_region(itdev->cir_addr, itdev->params.io_region_size);
1615
1616	rc_free_device(rdev);
1617	kfree(itdev);
1618
1619	return ret;
1620}
1621
1622static void __devexit ite_remove(struct pnp_dev *pdev)
1623{
1624	struct ite_dev *dev = pnp_get_drvdata(pdev);
1625	unsigned long flags;
1626
1627	ite_dbg("%s called", __func__);
1628
1629	spin_lock_irqsave(&dev->lock, flags);
1630
1631	/* disable hardware */
1632	dev->params.disable(dev);
1633
1634	spin_unlock_irqrestore(&dev->lock, flags);
1635
1636	/* free resources */
1637	free_irq(dev->cir_irq, dev);
1638	release_region(dev->cir_addr, dev->params.io_region_size);
1639
1640	rc_unregister_device(dev->rdev);
1641
1642	kfree(dev);
1643}
1644
1645static int ite_suspend(struct pnp_dev *pdev, pm_message_t state)
1646{
1647	struct ite_dev *dev = pnp_get_drvdata(pdev);
1648	unsigned long flags;
1649
1650	ite_dbg("%s called", __func__);
1651
1652	/* wait for any transmission to end */
1653	wait_event_interruptible(dev->tx_ended, !dev->transmitting);
1654
1655	spin_lock_irqsave(&dev->lock, flags);
1656
1657	/* disable all interrupts */
1658	dev->params.disable(dev);
1659
1660	spin_unlock_irqrestore(&dev->lock, flags);
1661
1662	return 0;
1663}
1664
1665static int ite_resume(struct pnp_dev *pdev)
1666{
1667	int ret = 0;
1668	struct ite_dev *dev = pnp_get_drvdata(pdev);
1669	unsigned long flags;
1670
1671	ite_dbg("%s called", __func__);
1672
1673	spin_lock_irqsave(&dev->lock, flags);
1674
1675	/* reinitialize hardware config registers */
1676	dev->params.init_hardware(dev);
1677	/* enable the receiver */
1678	dev->params.enable_rx(dev);
1679
1680	spin_unlock_irqrestore(&dev->lock, flags);
1681
1682	return ret;
1683}
1684
1685static void ite_shutdown(struct pnp_dev *pdev)
1686{
1687	struct ite_dev *dev = pnp_get_drvdata(pdev);
1688	unsigned long flags;
1689
1690	ite_dbg("%s called", __func__);
1691
1692	spin_lock_irqsave(&dev->lock, flags);
1693
1694	/* disable all interrupts */
1695	dev->params.disable(dev);
1696
1697	spin_unlock_irqrestore(&dev->lock, flags);
1698}
1699
1700static struct pnp_driver ite_driver = {
1701	.name		= ITE_DRIVER_NAME,
1702	.id_table	= ite_ids,
1703	.probe		= ite_probe,
1704	.remove		= __devexit_p(ite_remove),
1705	.suspend	= ite_suspend,
1706	.resume		= ite_resume,
1707	.shutdown	= ite_shutdown,
1708};
1709
1710int ite_init(void)
1711{
1712	return pnp_register_driver(&ite_driver);
1713}
1714
1715void ite_exit(void)
1716{
1717	pnp_unregister_driver(&ite_driver);
1718}
1719
1720MODULE_DEVICE_TABLE(pnp, ite_ids);
1721MODULE_DESCRIPTION("ITE Tech Inc. IT8712F/ITE8512F CIR driver");
1722
1723MODULE_AUTHOR("Juan J. Garcia de Soria <skandalfo@gmail.com>");
1724MODULE_LICENSE("GPL");
1725
1726module_init(ite_init);
1727module_exit(ite_exit);
1728