xref: /openbmc/linux/arch/x86/kernel/i8259.c (revision 92ed1a76)
1 #include <linux/linkage.h>
2 #include <linux/errno.h>
3 #include <linux/signal.h>
4 #include <linux/sched.h>
5 #include <linux/ioport.h>
6 #include <linux/interrupt.h>
7 #include <linux/timex.h>
8 #include <linux/random.h>
9 #include <linux/init.h>
10 #include <linux/kernel_stat.h>
11 #include <linux/sysdev.h>
12 #include <linux/bitops.h>
13 #include <linux/acpi.h>
14 #include <linux/io.h>
15 #include <linux/delay.h>
16 
17 #include <asm/atomic.h>
18 #include <asm/system.h>
19 #include <asm/timer.h>
20 #include <asm/hw_irq.h>
21 #include <asm/pgtable.h>
22 #include <asm/desc.h>
23 #include <asm/apic.h>
24 #include <asm/i8259.h>
25 
26 /*
27  * This is the 'legacy' 8259A Programmable Interrupt Controller,
28  * present in the majority of PC/AT boxes.
29  * plus some generic x86 specific things if generic specifics makes
30  * any sense at all.
31  */
32 static void init_8259A(int auto_eoi);
33 
34 static int i8259A_auto_eoi;
35 DEFINE_RAW_SPINLOCK(i8259A_lock);
36 
37 /*
38  * 8259A PIC functions to handle ISA devices:
39  */
40 
41 /*
42  * This contains the irq mask for both 8259A irq controllers,
43  */
44 unsigned int cached_irq_mask = 0xffff;
45 
46 /*
47  * Not all IRQs can be routed through the IO-APIC, eg. on certain (older)
48  * boards the timer interrupt is not really connected to any IO-APIC pin,
49  * it's fed to the master 8259A's IR0 line only.
50  *
51  * Any '1' bit in this mask means the IRQ is routed through the IO-APIC.
52  * this 'mixed mode' IRQ handling costs nothing because it's only used
53  * at IRQ setup time.
54  */
55 unsigned long io_apic_irqs;
56 
57 static void mask_8259A_irq(unsigned int irq)
58 {
59 	unsigned int mask = 1 << irq;
60 	unsigned long flags;
61 
62 	raw_spin_lock_irqsave(&i8259A_lock, flags);
63 	cached_irq_mask |= mask;
64 	if (irq & 8)
65 		outb(cached_slave_mask, PIC_SLAVE_IMR);
66 	else
67 		outb(cached_master_mask, PIC_MASTER_IMR);
68 	raw_spin_unlock_irqrestore(&i8259A_lock, flags);
69 }
70 
71 static void disable_8259A_irq(struct irq_data *data)
72 {
73 	mask_8259A_irq(data->irq);
74 }
75 
76 static void unmask_8259A_irq(unsigned int irq)
77 {
78 	unsigned int mask = ~(1 << irq);
79 	unsigned long flags;
80 
81 	raw_spin_lock_irqsave(&i8259A_lock, flags);
82 	cached_irq_mask &= mask;
83 	if (irq & 8)
84 		outb(cached_slave_mask, PIC_SLAVE_IMR);
85 	else
86 		outb(cached_master_mask, PIC_MASTER_IMR);
87 	raw_spin_unlock_irqrestore(&i8259A_lock, flags);
88 }
89 
90 static void enable_8259A_irq(struct irq_data *data)
91 {
92 	unmask_8259A_irq(data->irq);
93 }
94 
95 static int i8259A_irq_pending(unsigned int irq)
96 {
97 	unsigned int mask = 1<<irq;
98 	unsigned long flags;
99 	int ret;
100 
101 	raw_spin_lock_irqsave(&i8259A_lock, flags);
102 	if (irq < 8)
103 		ret = inb(PIC_MASTER_CMD) & mask;
104 	else
105 		ret = inb(PIC_SLAVE_CMD) & (mask >> 8);
106 	raw_spin_unlock_irqrestore(&i8259A_lock, flags);
107 
108 	return ret;
109 }
110 
111 static void make_8259A_irq(unsigned int irq)
112 {
113 	disable_irq_nosync(irq);
114 	io_apic_irqs &= ~(1<<irq);
115 	set_irq_chip_and_handler_name(irq, &i8259A_chip, handle_level_irq,
116 				      i8259A_chip.name);
117 	enable_irq(irq);
118 }
119 
120 /*
121  * This function assumes to be called rarely. Switching between
122  * 8259A registers is slow.
123  * This has to be protected by the irq controller spinlock
124  * before being called.
125  */
126 static inline int i8259A_irq_real(unsigned int irq)
127 {
128 	int value;
129 	int irqmask = 1<<irq;
130 
131 	if (irq < 8) {
132 		outb(0x0B, PIC_MASTER_CMD);	/* ISR register */
133 		value = inb(PIC_MASTER_CMD) & irqmask;
134 		outb(0x0A, PIC_MASTER_CMD);	/* back to the IRR register */
135 		return value;
136 	}
137 	outb(0x0B, PIC_SLAVE_CMD);	/* ISR register */
138 	value = inb(PIC_SLAVE_CMD) & (irqmask >> 8);
139 	outb(0x0A, PIC_SLAVE_CMD);	/* back to the IRR register */
140 	return value;
141 }
142 
143 /*
144  * Careful! The 8259A is a fragile beast, it pretty
145  * much _has_ to be done exactly like this (mask it
146  * first, _then_ send the EOI, and the order of EOI
147  * to the two 8259s is important!
148  */
149 static void mask_and_ack_8259A(struct irq_data *data)
150 {
151 	unsigned int irq = data->irq;
152 	unsigned int irqmask = 1 << irq;
153 	unsigned long flags;
154 
155 	raw_spin_lock_irqsave(&i8259A_lock, flags);
156 	/*
157 	 * Lightweight spurious IRQ detection. We do not want
158 	 * to overdo spurious IRQ handling - it's usually a sign
159 	 * of hardware problems, so we only do the checks we can
160 	 * do without slowing down good hardware unnecessarily.
161 	 *
162 	 * Note that IRQ7 and IRQ15 (the two spurious IRQs
163 	 * usually resulting from the 8259A-1|2 PICs) occur
164 	 * even if the IRQ is masked in the 8259A. Thus we
165 	 * can check spurious 8259A IRQs without doing the
166 	 * quite slow i8259A_irq_real() call for every IRQ.
167 	 * This does not cover 100% of spurious interrupts,
168 	 * but should be enough to warn the user that there
169 	 * is something bad going on ...
170 	 */
171 	if (cached_irq_mask & irqmask)
172 		goto spurious_8259A_irq;
173 	cached_irq_mask |= irqmask;
174 
175 handle_real_irq:
176 	if (irq & 8) {
177 		inb(PIC_SLAVE_IMR);	/* DUMMY - (do we need this?) */
178 		outb(cached_slave_mask, PIC_SLAVE_IMR);
179 		/* 'Specific EOI' to slave */
180 		outb(0x60+(irq&7), PIC_SLAVE_CMD);
181 		 /* 'Specific EOI' to master-IRQ2 */
182 		outb(0x60+PIC_CASCADE_IR, PIC_MASTER_CMD);
183 	} else {
184 		inb(PIC_MASTER_IMR);	/* DUMMY - (do we need this?) */
185 		outb(cached_master_mask, PIC_MASTER_IMR);
186 		outb(0x60+irq, PIC_MASTER_CMD);	/* 'Specific EOI to master */
187 	}
188 	raw_spin_unlock_irqrestore(&i8259A_lock, flags);
189 	return;
190 
191 spurious_8259A_irq:
192 	/*
193 	 * this is the slow path - should happen rarely.
194 	 */
195 	if (i8259A_irq_real(irq))
196 		/*
197 		 * oops, the IRQ _is_ in service according to the
198 		 * 8259A - not spurious, go handle it.
199 		 */
200 		goto handle_real_irq;
201 
202 	{
203 		static int spurious_irq_mask;
204 		/*
205 		 * At this point we can be sure the IRQ is spurious,
206 		 * lets ACK and report it. [once per IRQ]
207 		 */
208 		if (!(spurious_irq_mask & irqmask)) {
209 			printk(KERN_DEBUG
210 			       "spurious 8259A interrupt: IRQ%d.\n", irq);
211 			spurious_irq_mask |= irqmask;
212 		}
213 		atomic_inc(&irq_err_count);
214 		/*
215 		 * Theoretically we do not have to handle this IRQ,
216 		 * but in Linux this does not cause problems and is
217 		 * simpler for us.
218 		 */
219 		goto handle_real_irq;
220 	}
221 }
222 
223 struct irq_chip i8259A_chip = {
224 	.name		= "XT-PIC",
225 	.irq_mask	= disable_8259A_irq,
226 	.irq_disable	= disable_8259A_irq,
227 	.irq_unmask	= enable_8259A_irq,
228 	.irq_mask_ack	= mask_and_ack_8259A,
229 };
230 
231 static char irq_trigger[2];
232 /**
233  * ELCR registers (0x4d0, 0x4d1) control edge/level of IRQ
234  */
235 static void restore_ELCR(char *trigger)
236 {
237 	outb(trigger[0], 0x4d0);
238 	outb(trigger[1], 0x4d1);
239 }
240 
241 static void save_ELCR(char *trigger)
242 {
243 	/* IRQ 0,1,2,8,13 are marked as reserved */
244 	trigger[0] = inb(0x4d0) & 0xF8;
245 	trigger[1] = inb(0x4d1) & 0xDE;
246 }
247 
248 static int i8259A_resume(struct sys_device *dev)
249 {
250 	init_8259A(i8259A_auto_eoi);
251 	restore_ELCR(irq_trigger);
252 	return 0;
253 }
254 
255 static int i8259A_suspend(struct sys_device *dev, pm_message_t state)
256 {
257 	save_ELCR(irq_trigger);
258 	return 0;
259 }
260 
261 static int i8259A_shutdown(struct sys_device *dev)
262 {
263 	/* Put the i8259A into a quiescent state that
264 	 * the kernel initialization code can get it
265 	 * out of.
266 	 */
267 	outb(0xff, PIC_MASTER_IMR);	/* mask all of 8259A-1 */
268 	outb(0xff, PIC_SLAVE_IMR);	/* mask all of 8259A-1 */
269 	return 0;
270 }
271 
272 static struct sysdev_class i8259_sysdev_class = {
273 	.name = "i8259",
274 	.suspend = i8259A_suspend,
275 	.resume = i8259A_resume,
276 	.shutdown = i8259A_shutdown,
277 };
278 
279 static struct sys_device device_i8259A = {
280 	.id	= 0,
281 	.cls	= &i8259_sysdev_class,
282 };
283 
284 static void mask_8259A(void)
285 {
286 	unsigned long flags;
287 
288 	raw_spin_lock_irqsave(&i8259A_lock, flags);
289 
290 	outb(0xff, PIC_MASTER_IMR);	/* mask all of 8259A-1 */
291 	outb(0xff, PIC_SLAVE_IMR);	/* mask all of 8259A-2 */
292 
293 	raw_spin_unlock_irqrestore(&i8259A_lock, flags);
294 }
295 
296 static void unmask_8259A(void)
297 {
298 	unsigned long flags;
299 
300 	raw_spin_lock_irqsave(&i8259A_lock, flags);
301 
302 	outb(cached_master_mask, PIC_MASTER_IMR); /* restore master IRQ mask */
303 	outb(cached_slave_mask, PIC_SLAVE_IMR);	  /* restore slave IRQ mask */
304 
305 	raw_spin_unlock_irqrestore(&i8259A_lock, flags);
306 }
307 
308 static void init_8259A(int auto_eoi)
309 {
310 	unsigned long flags;
311 
312 	i8259A_auto_eoi = auto_eoi;
313 
314 	raw_spin_lock_irqsave(&i8259A_lock, flags);
315 
316 	outb(0xff, PIC_MASTER_IMR);	/* mask all of 8259A-1 */
317 	outb(0xff, PIC_SLAVE_IMR);	/* mask all of 8259A-2 */
318 
319 	/*
320 	 * outb_pic - this has to work on a wide range of PC hardware.
321 	 */
322 	outb_pic(0x11, PIC_MASTER_CMD);	/* ICW1: select 8259A-1 init */
323 
324 	/* ICW2: 8259A-1 IR0-7 mapped to 0x30-0x37 on x86-64,
325 	   to 0x20-0x27 on i386 */
326 	outb_pic(IRQ0_VECTOR, PIC_MASTER_IMR);
327 
328 	/* 8259A-1 (the master) has a slave on IR2 */
329 	outb_pic(1U << PIC_CASCADE_IR, PIC_MASTER_IMR);
330 
331 	if (auto_eoi)	/* master does Auto EOI */
332 		outb_pic(MASTER_ICW4_DEFAULT | PIC_ICW4_AEOI, PIC_MASTER_IMR);
333 	else		/* master expects normal EOI */
334 		outb_pic(MASTER_ICW4_DEFAULT, PIC_MASTER_IMR);
335 
336 	outb_pic(0x11, PIC_SLAVE_CMD);	/* ICW1: select 8259A-2 init */
337 
338 	/* ICW2: 8259A-2 IR0-7 mapped to IRQ8_VECTOR */
339 	outb_pic(IRQ8_VECTOR, PIC_SLAVE_IMR);
340 	/* 8259A-2 is a slave on master's IR2 */
341 	outb_pic(PIC_CASCADE_IR, PIC_SLAVE_IMR);
342 	/* (slave's support for AEOI in flat mode is to be investigated) */
343 	outb_pic(SLAVE_ICW4_DEFAULT, PIC_SLAVE_IMR);
344 
345 	if (auto_eoi)
346 		/*
347 		 * In AEOI mode we just have to mask the interrupt
348 		 * when acking.
349 		 */
350 		i8259A_chip.irq_mask_ack = disable_8259A_irq;
351 	else
352 		i8259A_chip.irq_mask_ack = mask_and_ack_8259A;
353 
354 	udelay(100);		/* wait for 8259A to initialize */
355 
356 	outb(cached_master_mask, PIC_MASTER_IMR); /* restore master IRQ mask */
357 	outb(cached_slave_mask, PIC_SLAVE_IMR);	  /* restore slave IRQ mask */
358 
359 	raw_spin_unlock_irqrestore(&i8259A_lock, flags);
360 }
361 
362 /*
363  * make i8259 a driver so that we can select pic functions at run time. the goal
364  * is to make x86 binary compatible among pc compatible and non-pc compatible
365  * platforms, such as x86 MID.
366  */
367 
368 static void legacy_pic_noop(void) { };
369 static void legacy_pic_uint_noop(unsigned int unused) { };
370 static void legacy_pic_int_noop(int unused) { };
371 static int legacy_pic_irq_pending_noop(unsigned int irq)
372 {
373 	return 0;
374 }
375 
376 struct legacy_pic null_legacy_pic = {
377 	.nr_legacy_irqs = 0,
378 	.chip = &dummy_irq_chip,
379 	.mask = legacy_pic_uint_noop,
380 	.unmask = legacy_pic_uint_noop,
381 	.mask_all = legacy_pic_noop,
382 	.restore_mask = legacy_pic_noop,
383 	.init = legacy_pic_int_noop,
384 	.irq_pending = legacy_pic_irq_pending_noop,
385 	.make_irq = legacy_pic_uint_noop,
386 };
387 
388 struct legacy_pic default_legacy_pic = {
389 	.nr_legacy_irqs = NR_IRQS_LEGACY,
390 	.chip  = &i8259A_chip,
391 	.mask = mask_8259A_irq,
392 	.unmask = unmask_8259A_irq,
393 	.mask_all = mask_8259A,
394 	.restore_mask = unmask_8259A,
395 	.init = init_8259A,
396 	.irq_pending = i8259A_irq_pending,
397 	.make_irq = make_8259A_irq,
398 };
399 
400 struct legacy_pic *legacy_pic = &default_legacy_pic;
401 
402 static int __init i8259A_init_sysfs(void)
403 {
404 	int error;
405 
406 	if (legacy_pic != &default_legacy_pic)
407 		return 0;
408 
409 	error = sysdev_class_register(&i8259_sysdev_class);
410 	if (!error)
411 		error = sysdev_register(&device_i8259A);
412 	return error;
413 }
414 
415 device_initcall(i8259A_init_sysfs);
416