Fix a comment. The slave is connected to IRQ 2 on the first 8259, not
[dragonfly.git] / sys / i386 / isa / intr_machdep.c
1 /*-
2  * Copyright (c) 1991 The Regents of the University of California.
3  * All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * William Jolitz.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *      from: @(#)isa.c 7.2 (Berkeley) 5/13/91
37  * $FreeBSD: src/sys/i386/isa/intr_machdep.c,v 1.29.2.5 2001/10/14 06:54:27 luigi Exp $
38  * $DragonFly: src/sys/i386/isa/Attic/intr_machdep.c,v 1.42 2005/11/04 19:39:25 dillon Exp $
39  */
40 /*
41  * This file contains an aggregated module marked:
42  * Copyright (c) 1997, Stefan Esser <se@freebsd.org>
43  * All rights reserved.
44  * See the notice for details.
45  */
46
47 #include "use_isa.h"
48 #include "opt_auto_eoi.h"
49
50 #include <sys/param.h>
51 #ifndef SMP
52 #include <machine/lock.h>
53 #endif
54 #include <sys/systm.h>
55 #include <sys/syslog.h>
56 #include <sys/malloc.h>
57 #include <sys/errno.h>
58 #include <sys/interrupt.h>
59 #include <machine/ipl.h>
60 #include <machine/md_var.h>
61 #include <machine/segments.h>
62 #include <sys/bus.h> 
63 #include <machine/globaldata.h>
64 #include <sys/proc.h>
65 #include <sys/thread2.h>
66 #include <sys/machintr.h>
67
68 #include <machine/smp.h>
69 #include <bus/isa/i386/isa.h>
70 #include <i386/icu/icu.h>
71
72 #if NISA > 0
73 #include <bus/isa/isavar.h>
74 #endif
75 #include <i386/isa/intr_machdep.h>
76 #include <bus/isa/isavar.h>
77 #include <sys/interrupt.h>
78 #include <machine/clock.h>
79 #include <machine/cpu.h>
80
81 /* XXX should be in suitable include files */
82 #define ICU_IMR_OFFSET          1               /* IO_ICU{1,2} + 1 */
83
84 #ifdef APIC_IO
85 /*
86  * This is to accommodate "mixed-mode" programming for 
87  * motherboards that don't connect the 8254 to the IO APIC.
88  */
89 #define AUTO_EOI_1      1
90 #endif
91
92 static void     init_i8259(void);
93
94 #define NMI_PARITY (1 << 7)
95 #define NMI_IOCHAN (1 << 6)
96 #define ENMI_WATCHDOG (1 << 7)
97 #define ENMI_BUSTIMER (1 << 6)
98 #define ENMI_IOSTATUS (1 << 5)
99
100 /*
101  * Handle a NMI, possibly a machine check.
102  * return true to panic system, false to ignore.
103  */
104 int
105 isa_nmi(cd)
106         int cd;
107 {
108         int retval = 0;
109         int isa_port = inb(0x61);
110         int eisa_port = inb(0x461);
111
112         log(LOG_CRIT, "NMI ISA %x, EISA %x\n", isa_port, eisa_port);
113         
114         if (isa_port & NMI_PARITY) {
115                 log(LOG_CRIT, "RAM parity error, likely hardware failure.");
116                 retval = 1;
117         }
118
119         if (isa_port & NMI_IOCHAN) {
120                 log(LOG_CRIT, "I/O channel check, likely hardware failure.");
121                 retval = 1;
122         }
123
124         /*
125          * On a real EISA machine, this will never happen.  However it can
126          * happen on ISA machines which implement XT style floating point
127          * error handling (very rare).  Save them from a meaningless panic.
128          */
129         if (eisa_port == 0xff)
130                 return(retval);
131
132         if (eisa_port & ENMI_WATCHDOG) {
133                 log(LOG_CRIT, "EISA watchdog timer expired, likely hardware failure.");
134                 retval = 1;
135         }
136
137         if (eisa_port & ENMI_BUSTIMER) {
138                 log(LOG_CRIT, "EISA bus timeout, likely hardware failure.");
139                 retval = 1;
140         }
141
142         if (eisa_port & ENMI_IOSTATUS) {
143                 log(LOG_CRIT, "EISA I/O port status error.");
144                 retval = 1;
145         }
146         return(retval);
147 }
148
149 /*
150  *  ICU reinitialize when ICU configuration has lost.
151  */
152 void
153 icu_reinit()
154 {
155         int i;
156
157         init_i8259();
158         for (i = 0; i < MAX_HARDINTS; ++i) {
159                 if (count_registered_ints(i))
160                         machintr_intren(i);
161         }
162 }
163
164 /*
165  * Fill in default interrupt table (in case of spurious interrupt
166  * during configuration of kernel, setup interrupt control unit
167  */
168 void
169 isa_defaultirq()
170 {
171         int i;
172
173         /* icu vectors */
174         for (i = 0; i < MAX_HARDINTS; i++)
175                 machintr_vector_setdefault(i);
176         init_i8259();
177 }
178
179 static void
180 init_i8259(void)
181 {
182
183         /* initialize 8259's */
184         outb(IO_ICU1, 0x11);            /* reset; program device, four bytes */
185         outb(IO_ICU1+ICU_IMR_OFFSET, IDT_OFFSET);       /* starting at this vector index */
186         outb(IO_ICU1+ICU_IMR_OFFSET, 1 << ICU_IRQ_SLAVE); /* slave on line 2 */
187 #ifdef AUTO_EOI_1
188         outb(IO_ICU1+ICU_IMR_OFFSET, 2 | 1);            /* auto EOI, 8086 mode */
189 #else
190         outb(IO_ICU1+ICU_IMR_OFFSET, 1);                /* 8086 mode */
191 #endif
192         outb(IO_ICU1+ICU_IMR_OFFSET, 0xff);             /* leave interrupts masked */
193         outb(IO_ICU1, 0x0a);            /* default to IRR on read */
194         outb(IO_ICU1, 0xc0 | (3 - 1));  /* pri order 3-7, 0-2 (com2 first) */
195         outb(IO_ICU2, 0x11);            /* reset; program device, four bytes */
196         outb(IO_ICU2+ICU_IMR_OFFSET, IDT_OFFSET+8); /* staring at this vector index */
197         outb(IO_ICU2+ICU_IMR_OFFSET, ICU_IRQ_SLAVE);
198 #ifdef AUTO_EOI_2
199         outb(IO_ICU2+ICU_IMR_OFFSET, 2 | 1);            /* auto EOI, 8086 mode */
200 #else
201         outb(IO_ICU2+ICU_IMR_OFFSET,1);         /* 8086 mode */
202 #endif
203         outb(IO_ICU2+ICU_IMR_OFFSET, 0xff);          /* leave interrupts masked */
204         outb(IO_ICU2, 0x0a);            /* default to IRR on read */
205 }
206
207 #if NISA > 0
208 /*
209  * Return a bitmap of the current interrupt requests.  This is 8259-specific
210  * and is only suitable for use at probe time.
211  */
212 intrmask_t
213 isa_irq_pending(void)
214 {
215         u_char irr1;
216         u_char irr2;
217
218         irr1 = inb(IO_ICU1);
219         irr2 = inb(IO_ICU2);
220         return ((irr2 << 8) | irr1);
221 }
222
223 #endif
224
225 /* The following notice applies beyond this point in the file */
226
227 /*
228  * Copyright (c) 1997, Stefan Esser <se@freebsd.org>
229  * All rights reserved.
230  *
231  * Redistribution and use in source and binary forms, with or without
232  * modification, are permitted provided that the following conditions
233  * are met:
234  * 1. Redistributions of source code must retain the above copyright
235  *    notice unmodified, this list of conditions, and the following
236  *    disclaimer.
237  * 2. Redistributions in binary form must reproduce the above copyright
238  *    notice, this list of conditions and the following disclaimer in the
239  *    documentation and/or other materials provided with the distribution.
240  *
241  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
242  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
243  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
244  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
245  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
246  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
247  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
248  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
249  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
250  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
251  *
252  * $FreeBSD: src/sys/i386/isa/intr_machdep.c,v 1.29.2.5 2001/10/14 06:54:27 luigi Exp $
253  *
254  */
255
256 /*
257  * Create and activate an interrupt handler descriptor data structure.
258  *
259  * The dev_instance pointer is required for resource management, and will
260  * only be passed through to resource_claim().
261  *
262  * There will be functions that derive a driver and unit name from a
263  * dev_instance variable, and those functions will be used to maintain the
264  * interrupt counter label array referenced by systat and vmstat to report
265  * device interrupt rates (->update_intrlabels).
266  *
267  * Add the interrupt handler descriptor data structure created by an
268  * earlier call of create_intr() to the linked list for its irq.
269  *
270  * WARNING: This is an internal function and not to be used by device
271  * drivers.  It is subject to change without notice.
272  */
273
274 void *
275 inthand_add(const char *name, int irq, inthand2_t handler, void *arg,
276              int flags, lwkt_serialize_t serializer)
277 {
278         int errcode = 0;
279         void *id;
280
281         if (irq < 0 || irq >= MAX_HARDINTS) {
282                 printf("create_intr: requested irq%d too high, limit is %d\n",
283                        irq, MAX_HARDINTS);
284                 return (NULL);
285         }
286         /*
287          * Register the interrupt, then setup the ICU
288          */
289         id = register_int(irq, handler, arg, name, serializer, flags);
290
291         if (id == NULL) {
292                 printf("Unable to install handler for %s\n", name);
293                 printf("\tdevice combination not supported on irq %d\n", irq);
294                 return(NULL);
295         }
296
297         crit_enter();
298         if (count_registered_ints(irq) == 1) {
299                 if (machintr_vector_setup(irq, flags))
300                         errcode = -1;
301         }
302         crit_exit();
303
304         /*
305          * Cleanup
306          */
307         if (errcode != 0) {
308                 if (bootverbose) {
309                         printf("\tinthand_add(irq%d) failed, result=%d\n", 
310                                irq, errcode);
311                 }
312                 unregister_int(id);
313                 id = NULL;
314         }
315         return (id);
316 }
317
318 /*
319  * Deactivate and remove the interrupt handler descriptor data connected
320  * created by an earlier call of intr_connect() from the linked list.
321  *
322  * Return the memory held by the interrupt handler descriptor data structure
323  * to the system. Make sure, the handler is not actively used anymore, before.
324  */
325 int
326 inthand_remove(void *id)
327 {
328         int irq;
329
330         if (id == NULL)
331                 return(-1);
332
333         crit_enter();
334         irq = get_registered_intr(id);
335         if (unregister_int(id) == 0) {
336                 machintr_vector_teardown(irq);
337         }
338         crit_exit();
339         return (0);
340 }
341
342 #ifdef SMP
343 /*
344  * forward_fast_remote()
345  *
346  *      This function is called from the receiving end of an IPIQ when a
347  *      remote cpu wishes to forward a fast interrupt to us.  All we have to
348  *      do is set the interrupt pending and let the IPI's doreti deal with it.
349  */
350 void
351 forward_fastint_remote(void *arg)
352 {
353     int irq = (int)arg;
354     struct mdglobaldata *gd = mdcpu;
355
356     atomic_set_int_nonlocked(&gd->gd_fpending, 1 << irq);
357     atomic_set_int_nonlocked(&gd->mi.gd_reqflags, RQF_INTPEND);
358 }
359
360 #endif