Another major mmx/xmm/FP commit. This is a combination of several patches
[dragonfly.git] / sys / platform / pc32 / isa / npx.c
1 /*-
2  * Copyright (c) 1990 William Jolitz.
3  * Copyright (c) 1991 The Regents of the University of California.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *      This product includes software developed by the University of
17  *      California, Berkeley and its contributors.
18  * 4. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *      from: @(#)npx.c 7.2 (Berkeley) 5/12/91
35  * $FreeBSD: src/sys/i386/isa/npx.c,v 1.80.2.3 2001/10/20 19:04:38 tegge Exp $
36  * $DragonFly: src/sys/platform/pc32/isa/npx.c,v 1.19 2004/05/05 19:26:44 dillon Exp $
37  */
38
39 #include "opt_cpu.h"
40 #include "opt_debug_npx.h"
41 #include "opt_math_emulate.h"
42
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/bus.h>
46 #include <sys/kernel.h>
47 #include <sys/malloc.h>
48 #include <sys/module.h>
49 #include <sys/sysctl.h>
50 #include <sys/proc.h>
51 #include <machine/bus.h>
52 #include <sys/rman.h>
53 #ifdef NPX_DEBUG
54 #include <sys/syslog.h>
55 #endif
56 #include <sys/signalvar.h>
57 #include <sys/thread2.h>
58
59 #ifndef SMP
60 #include <machine/asmacros.h>
61 #endif
62 #include <machine/cputypes.h>
63 #include <machine/frame.h>
64 #include <machine/ipl.h>
65 #include <machine/md_var.h>
66 #include <machine/pcb.h>
67 #include <machine/psl.h>
68 #ifndef SMP
69 #include <machine/clock.h>
70 #endif
71 #include <machine/resource.h>
72 #include <machine/specialreg.h>
73 #include <machine/segments.h>
74 #include <machine/globaldata.h>
75
76 #ifndef SMP
77 #include <i386/isa/icu.h>
78 #include <i386/isa/intr_machdep.h>
79 #include <bus/isa/i386/isa.h>
80 #endif
81
82 /*
83  * 387 and 287 Numeric Coprocessor Extension (NPX) Driver.
84  */
85
86 /* Configuration flags. */
87 #define NPX_DISABLE_I586_OPTIMIZED_BCOPY        (1 << 0)
88 #define NPX_DISABLE_I586_OPTIMIZED_BZERO        (1 << 1)
89 #define NPX_DISABLE_I586_OPTIMIZED_COPYIO       (1 << 2)
90 #define NPX_PREFER_EMULATOR                     (1 << 3)
91
92 #ifdef  __GNUC__
93
94 #define fldcw(addr)             __asm("fldcw %0" : : "m" (*(addr)))
95 #define fnclex()                __asm("fnclex")
96 #define fninit()                __asm("fninit")
97 #define fnop()                  __asm("fnop")
98 #define fnsave(addr)            __asm __volatile("fnsave %0" : "=m" (*(addr)))
99 #define fnstcw(addr)            __asm __volatile("fnstcw %0" : "=m" (*(addr)))
100 #define fnstsw(addr)            __asm __volatile("fnstsw %0" : "=m" (*(addr)))
101 #define fp_divide_by_0()        __asm("fldz; fld1; fdiv %st,%st(1); fnop")
102 #define frstor(addr)            __asm("frstor %0" : : "m" (*(addr)))
103 #ifndef CPU_DISABLE_SSE
104 #define fxrstor(addr)           __asm("fxrstor %0" : : "m" (*(addr)))
105 #define fxsave(addr)            __asm __volatile("fxsave %0" : "=m" (*(addr)))
106 #endif
107 #define start_emulating()       __asm("smsw %%ax; orb %0,%%al; lmsw %%ax" \
108                                       : : "n" (CR0_TS) : "ax")
109 #define stop_emulating()        __asm("clts")
110
111 #else   /* not __GNUC__ */
112
113 void    fldcw           (caddr_t addr);
114 void    fnclex          (void);
115 void    fninit          (void);
116 void    fnop            (void);
117 void    fnsave          (caddr_t addr);
118 void    fnstcw          (caddr_t addr);
119 void    fnstsw          (caddr_t addr);
120 void    fp_divide_by_0  (void);
121 void    frstor          (caddr_t addr);
122 #ifndef CPU_DISABLE_SSE
123 void    fxsave          (caddr_t addr);
124 void    fxrstor         (caddr_t addr);
125 #endif
126 void    start_emulating (void);
127 void    stop_emulating  (void);
128
129 #endif  /* __GNUC__ */
130
131 #ifndef CPU_DISABLE_SSE
132 #define GET_FPU_EXSW_PTR(td) \
133         (cpu_fxsr ? \
134                 &(td)->td_savefpu->sv_xmm.sv_ex_sw : \
135                 &(td)->td_savefpu->sv_87.sv_ex_sw)
136 #else /* CPU_DISABLE_SSE */
137 #define GET_FPU_EXSW_PTR(td) \
138         (&(td)->td_savefpu->sv_87.sv_ex_sw)
139 #endif /* CPU_DISABLE_SSE */
140
141 typedef u_char bool_t;
142
143 static  int     npx_attach      (device_t dev);
144         void    npx_intr        (void *);
145 static  void    npx_identify    (driver_t *driver, device_t parent);
146 static  int     npx_probe       (device_t dev);
147 static  int     npx_probe1      (device_t dev);
148 static  void    fpusave         (union savefpu *);
149 static  void    fpurstor        (union savefpu *);
150
151 int     hw_float;               /* XXX currently just alias for npx_exists */
152
153 SYSCTL_INT(_hw,HW_FLOATINGPT, floatingpoint,
154         CTLFLAG_RD, &hw_float, 0, 
155         "Floatingpoint instructions executed in hardware");
156
157 #ifndef SMP
158 static  u_int                   npx0_imask = SWI_CLOCK_MASK;
159 static  struct gate_descriptor  npx_idt_probeintr;
160 static  int                     npx_intrno;
161 static  volatile u_int          npx_intrs_while_probing;
162 static  volatile u_int          npx_traps_while_probing;
163 #endif
164
165 static  bool_t                  npx_ex16;
166 static  bool_t                  npx_exists;
167 static  bool_t                  npx_irq13;
168 static  int                     npx_irq;        /* irq number */
169
170 #ifndef SMP
171 /*
172  * Special interrupt handlers.  Someday intr0-intr15 will be used to count
173  * interrupts.  We'll still need a special exception 16 handler.  The busy
174  * latch stuff in probeintr() can be moved to npxprobe().
175  */
176 inthand_t probeintr;
177 __asm("                                                         \n\
178         .text                                                   \n\
179         .p2align 2,0x90                                         \n\
180         .type   " __XSTRING(CNAME(probeintr)) ",@function       \n\
181 " __XSTRING(CNAME(probeintr)) ":                                \n\
182         ss                                                      \n\
183         incl    " __XSTRING(CNAME(npx_intrs_while_probing)) "   \n\
184         pushl   %eax                                            \n\
185         movb    $0x20,%al       # EOI (asm in strings loses cpp features) \n\
186         outb    %al,$0xa0       # IO_ICU2                       \n\
187         outb    %al,$0x20       # IO_ICU1                       \n\
188         movb    $0,%al                                          \n\
189         outb    %al,$0xf0       # clear BUSY# latch             \n\
190         popl    %eax                                            \n\
191         iret                                                    \n\
192 ");
193
194 inthand_t probetrap;
195 __asm("                                                         \n\
196         .text                                                   \n\
197         .p2align 2,0x90                                         \n\
198         .type   " __XSTRING(CNAME(probetrap)) ",@function       \n\
199 " __XSTRING(CNAME(probetrap)) ":                                \n\
200         ss                                                      \n\
201         incl    " __XSTRING(CNAME(npx_traps_while_probing)) "   \n\
202         fnclex                                                  \n\
203         iret                                                    \n\
204 ");
205 #endif /* SMP */
206
207 /*
208  * Identify routine.  Create a connection point on our parent for probing.
209  */
210 static void
211 npx_identify(driver_t *driver, device_t parent)
212 {
213         device_t child;
214
215         child = BUS_ADD_CHILD(parent, 0, "npx", 0);
216         if (child == NULL)
217                 panic("npx_identify");
218 }
219
220 /*
221  * Probe routine.  Initialize cr0 to give correct behaviour for [f]wait
222  * whether the device exists or not (XXX should be elsewhere).  Set flags
223  * to tell npxattach() what to do.  Modify device struct if npx doesn't
224  * need to use interrupts.  Return 1 if device exists.
225  */
226 static int
227 npx_probe(device_t dev)
228 {
229 #ifdef SMP
230
231         if (resource_int_value("npx", 0, "irq", &npx_irq) != 0)
232                 npx_irq = 13;
233         return npx_probe1(dev);
234
235 #else /* SMP */
236
237         int     result;
238         u_long  save_eflags;
239         u_char  save_icu1_mask;
240         u_char  save_icu2_mask;
241         struct  gate_descriptor save_idt_npxintr;
242         struct  gate_descriptor save_idt_npxtrap;
243         /*
244          * This routine is now just a wrapper for npxprobe1(), to install
245          * special npx interrupt and trap handlers, to enable npx interrupts
246          * and to disable other interrupts.  Someday isa_configure() will
247          * install suitable handlers and run with interrupts enabled so we
248          * won't need to do so much here.
249          */
250         if (resource_int_value("npx", 0, "irq", &npx_irq) != 0)
251                 npx_irq = 13;
252         npx_intrno = NRSVIDT + npx_irq;
253         save_eflags = read_eflags();
254         cpu_disable_intr();
255         save_icu1_mask = inb(IO_ICU1 + 1);
256         save_icu2_mask = inb(IO_ICU2 + 1);
257         save_idt_npxintr = idt[npx_intrno];
258         save_idt_npxtrap = idt[16];
259         outb(IO_ICU1 + 1, ~IRQ_SLAVE);
260         outb(IO_ICU2 + 1, ~(1 << (npx_irq - 8)));
261         setidt(16, probetrap, SDT_SYS386TGT, SEL_KPL, GSEL(GCODE_SEL, SEL_KPL));
262         setidt(npx_intrno, probeintr, SDT_SYS386IGT, SEL_KPL, GSEL(GCODE_SEL, SEL_KPL));
263         npx_idt_probeintr = idt[npx_intrno];
264         cpu_enable_intr();
265         result = npx_probe1(dev);
266         cpu_disable_intr();
267         outb(IO_ICU1 + 1, save_icu1_mask);
268         outb(IO_ICU2 + 1, save_icu2_mask);
269         idt[npx_intrno] = save_idt_npxintr;
270         idt[16] = save_idt_npxtrap;
271         write_eflags(save_eflags);
272         return (result);
273
274 #endif /* SMP */
275 }
276
277 static int
278 npx_probe1(device_t dev)
279 {
280 #ifndef SMP
281         u_short control;
282         u_short status;
283 #endif
284
285         /*
286          * Partially reset the coprocessor, if any.  Some BIOS's don't reset
287          * it after a warm boot.
288          */
289         outb(0xf1, 0);          /* full reset on some systems, NOP on others */
290         outb(0xf0, 0);          /* clear BUSY# latch */
291         /*
292          * Prepare to trap all ESC (i.e., NPX) instructions and all WAIT
293          * instructions.  We must set the CR0_MP bit and use the CR0_TS
294          * bit to control the trap, because setting the CR0_EM bit does
295          * not cause WAIT instructions to trap.  It's important to trap
296          * WAIT instructions - otherwise the "wait" variants of no-wait
297          * control instructions would degenerate to the "no-wait" variants
298          * after FP context switches but work correctly otherwise.  It's
299          * particularly important to trap WAITs when there is no NPX -
300          * otherwise the "wait" variants would always degenerate.
301          *
302          * Try setting CR0_NE to get correct error reporting on 486DX's.
303          * Setting it should fail or do nothing on lesser processors.
304          */
305         load_cr0(rcr0() | CR0_MP | CR0_NE);
306         /*
307          * But don't trap while we're probing.
308          */
309         stop_emulating();
310         /*
311          * Finish resetting the coprocessor, if any.  If there is an error
312          * pending, then we may get a bogus IRQ13, but probeintr() will handle
313          * it OK.  Bogus halts have never been observed, but we enabled
314          * IRQ13 and cleared the BUSY# latch early to handle them anyway.
315          */
316         fninit();
317
318 #ifdef SMP
319         /*
320          * Exception 16 MUST work for SMP.
321          */
322         npx_irq13 = 0;
323         npx_ex16 = hw_float = npx_exists = 1;
324         device_set_desc(dev, "math processor");
325         return (0);
326
327 #else /* !SMP */
328         device_set_desc(dev, "math processor");
329
330         /*
331          * Don't use fwait here because it might hang.
332          * Don't use fnop here because it usually hangs if there is no FPU.
333          */
334         DELAY(1000);            /* wait for any IRQ13 */
335 #ifdef DIAGNOSTIC
336         if (npx_intrs_while_probing != 0)
337                 printf("fninit caused %u bogus npx interrupt(s)\n",
338                        npx_intrs_while_probing);
339         if (npx_traps_while_probing != 0)
340                 printf("fninit caused %u bogus npx trap(s)\n",
341                        npx_traps_while_probing);
342 #endif
343         /*
344          * Check for a status of mostly zero.
345          */
346         status = 0x5a5a;
347         fnstsw(&status);
348         if ((status & 0xb8ff) == 0) {
349                 /*
350                  * Good, now check for a proper control word.
351                  */
352                 control = 0x5a5a;
353                 fnstcw(&control);
354                 if ((control & 0x1f3f) == 0x033f) {
355                         hw_float = npx_exists = 1;
356                         /*
357                          * We have an npx, now divide by 0 to see if exception
358                          * 16 works.
359                          */
360                         control &= ~(1 << 2);   /* enable divide by 0 trap */
361                         fldcw(&control);
362                         npx_traps_while_probing = npx_intrs_while_probing = 0;
363                         fp_divide_by_0();
364                         if (npx_traps_while_probing != 0) {
365                                 /*
366                                  * Good, exception 16 works.
367                                  */
368                                 npx_ex16 = 1;
369                                 return (0);
370                         }
371                         if (npx_intrs_while_probing != 0) {
372                                 int     rid;
373                                 struct  resource *r;
374                                 void    *intr;
375                                 /*
376                                  * Bad, we are stuck with IRQ13.
377                                  */
378                                 npx_irq13 = 1;
379                                 /*
380                                  * npxattach would be too late to set npx0_imask
381                                  */
382                                 npx0_imask |= (1 << npx_irq);
383
384                                 /*
385                                  * We allocate these resources permanently,
386                                  * so there is no need to keep track of them.
387                                  */
388                                 rid = 0;
389                                 r = bus_alloc_resource(dev, SYS_RES_IOPORT,
390                                                        &rid, IO_NPX, IO_NPX,
391                                                        IO_NPXSIZE, RF_ACTIVE);
392                                 if (r == 0)
393                                         panic("npx: can't get ports");
394                                 rid = 0;
395                                 r = bus_alloc_resource(dev, SYS_RES_IRQ,
396                                                        &rid, npx_irq, npx_irq,
397                                                        1, RF_ACTIVE);
398                                 if (r == 0)
399                                         panic("npx: can't get IRQ");
400                                 BUS_SETUP_INTR(device_get_parent(dev),
401                                                dev, r, INTR_TYPE_MISC,
402                                                npx_intr, 0, &intr);
403                                 if (intr == 0)
404                                         panic("npx: can't create intr");
405
406                                 return (0);
407                         }
408                         /*
409                          * Worse, even IRQ13 is broken.  Use emulator.
410                          */
411                 }
412         }
413         /*
414          * Probe failed, but we want to get to npxattach to initialize the
415          * emulator and say that it has been installed.  XXX handle devices
416          * that aren't really devices better.
417          */
418         return (0);
419 #endif /* SMP */
420 }
421
422 /*
423  * Attach routine - announce which it is, and wire into system
424  */
425 int
426 npx_attach(device_t dev)
427 {
428         int flags;
429 #if (defined(I586_CPU) || defined(I686_CPU)) && !defined(CPU_DISABLE_SSE)
430         int mmxopt = 0;
431 #endif
432
433         if (resource_int_value("npx", 0, "flags", &flags) != 0)
434                 flags = 0;
435
436         if (flags)
437                 device_printf(dev, "flags 0x%x ", flags);
438         if (npx_irq13) {
439                 device_printf(dev, "using IRQ 13 interface\n");
440         } else {
441 #if defined(MATH_EMULATE) || defined(GPL_MATH_EMULATE)
442                 if (npx_ex16) {
443                         if (!(flags & NPX_PREFER_EMULATOR))
444                                 device_printf(dev, "INT 16 interface\n");
445                         else {
446                                 device_printf(dev, "FPU exists, but flags request "
447                                     "emulator\n");
448                                 hw_float = npx_exists = 0;
449                         }
450                 } else if (npx_exists) {
451                         device_printf(dev, "error reporting broken; using 387 emulator\n");
452                         hw_float = npx_exists = 0;
453                 } else
454                         device_printf(dev, "387 emulator\n");
455 #else
456                 if (npx_ex16) {
457                         device_printf(dev, "INT 16 interface\n");
458                         if (flags & NPX_PREFER_EMULATOR) {
459                                 device_printf(dev, "emulator requested, but none compiled "
460                                     "into kernel, using FPU\n");
461                         }
462                 } else
463                         device_printf(dev, "no 387 emulator in kernel and no FPU!\n");
464 #endif
465         }
466         npxinit(__INITIAL_NPXCW__);
467
468 #if (defined(I586_CPU) || defined(I686_CPU)) && !defined(CPU_DISABLE_SSE)
469         /*
470          * The asm_mmx_*() routines actually use XMM as well, so only 
471          * enable them if we have SSE2 and are using FXSR (fxsave/fxrstore).
472          */
473         TUNABLE_INT_FETCH("kern.mmxopt", &mmxopt);
474         if ((cpu_feature & CPUID_MMX) && (cpu_feature & CPUID_SSE) &&
475             (cpu_feature & CPUID_SSE2) && 
476             npx_ex16 && npx_exists && mmxopt && cpu_fxsr
477         ) {
478                 if ((flags & NPX_DISABLE_I586_OPTIMIZED_BCOPY) == 0) {
479                         bcopy_vector = (void **)asm_xmm_bcopy;
480                         ovbcopy_vector = (void **)asm_xmm_bcopy;
481                         memcpy_vector = (void **)asm_xmm_memcpy;
482                         printf("Using XMM optimized bcopy/copyin/copyout\n");
483                 }
484                 if ((flags & NPX_DISABLE_I586_OPTIMIZED_BZERO) == 0) {
485                         /* XXX */
486                 }
487         } else if ((cpu_feature & CPUID_MMX) && (cpu_feature & CPUID_SSE) &&
488             npx_ex16 && npx_exists && mmxopt && cpu_fxsr
489         ) {
490                 if ((flags & NPX_DISABLE_I586_OPTIMIZED_BCOPY) == 0) {
491                         bcopy_vector = (void **)asm_mmx_bcopy;
492                         ovbcopy_vector = (void **)asm_mmx_bcopy;
493                         memcpy_vector = (void **)asm_mmx_memcpy;
494                         printf("Using MMX optimized bcopy/copyin/copyout\n");
495                 }
496                 if ((flags & NPX_DISABLE_I586_OPTIMIZED_BZERO) == 0) {
497                         /* XXX */
498                 }
499         }
500 #endif
501 #if 0
502         if (cpu_class == CPUCLASS_586 && npx_ex16 && npx_exists &&
503             timezero("i586_bzero()", i586_bzero) <
504             timezero("bzero()", bzero) * 4 / 5) {
505                 if (!(flags & NPX_DISABLE_I586_OPTIMIZED_BCOPY)) {
506                         bcopy_vector = i586_bcopy;
507                         ovbcopy_vector = i586_bcopy;
508                 }
509                 if (!(flags & NPX_DISABLE_I586_OPTIMIZED_BZERO))
510                         bzero = i586_bzero;
511                 if (!(flags & NPX_DISABLE_I586_OPTIMIZED_COPYIO)) {
512                         copyin_vector = i586_copyin;
513                         copyout_vector = i586_copyout;
514                 }
515         }
516 #endif
517         return (0);             /* XXX unused */
518 }
519
520 /*
521  * Initialize the floating point unit.
522  */
523 void
524 npxinit(u_short control)
525 {
526         static union savefpu dummy;
527
528         if (!npx_exists)
529                 return;
530         /*
531          * fninit has the same h/w bugs as fnsave.  Use the detoxified
532          * fnsave to throw away any junk in the fpu.  npxsave() initializes
533          * the fpu and sets npxthread = NULL as important side effects.
534          */
535         npxsave(&dummy);
536         crit_enter();
537         stop_emulating();
538         fldcw(&control);
539         fpusave(curthread->td_savefpu);
540         mdcpu->gd_npxthread = NULL;
541         start_emulating();
542         crit_exit();
543 }
544
545 /*
546  * Free coprocessor (if we have it).
547  */
548 void
549 npxexit(struct proc *p)
550 {
551         if (p->p_thread == mdcpu->gd_npxthread)
552                 npxsave(curthread->td_savefpu);
553 #ifdef NPX_DEBUG
554         if (npx_exists) {
555                 u_int   masked_exceptions;
556
557                 masked_exceptions = 
558                     curthread->td_savefpu->sv_87.sv_env.en_cw
559                     & curthread->td_savefpu->sv_87.sv_env.en_sw & 0x7f;
560                 /*
561                  * Log exceptions that would have trapped with the old
562                  * control word (overflow, divide by 0, and invalid operand).
563                  */
564                 if (masked_exceptions & 0x0d)
565                         log(LOG_ERR,
566         "pid %d (%s) exited with masked floating point exceptions 0x%02x\n",
567                             p->p_pid, p->p_comm, masked_exceptions);
568         }
569 #endif
570 }
571
572 /* 
573  * The following mechanism is used to ensure that the FPE_... value
574  * that is passed as a trapcode to the signal handler of the user
575  * process does not have more than one bit set.
576  * 
577  * Multiple bits may be set if the user process modifies the control
578  * word while a status word bit is already set.  While this is a sign
579  * of bad coding, we have no choise than to narrow them down to one
580  * bit, since we must not send a trapcode that is not exactly one of
581  * the FPE_ macros.
582  *
583  * The mechanism has a static table with 127 entries.  Each combination
584  * of the 7 FPU status word exception bits directly translates to a
585  * position in this table, where a single FPE_... value is stored.
586  * This FPE_... value stored there is considered the "most important"
587  * of the exception bits and will be sent as the signal code.  The
588  * precedence of the bits is based upon Intel Document "Numerical
589  * Applications", Chapter "Special Computational Situations".
590  *
591  * The macro to choose one of these values does these steps: 1) Throw
592  * away status word bits that cannot be masked.  2) Throw away the bits
593  * currently masked in the control word, assuming the user isn't
594  * interested in them anymore.  3) Reinsert status word bit 7 (stack
595  * fault) if it is set, which cannot be masked but must be presered.
596  * 4) Use the remaining bits to point into the trapcode table.
597  *
598  * The 6 maskable bits in order of their preference, as stated in the
599  * above referenced Intel manual:
600  * 1  Invalid operation (FP_X_INV)
601  * 1a   Stack underflow
602  * 1b   Stack overflow
603  * 1c   Operand of unsupported format
604  * 1d   SNaN operand.
605  * 2  QNaN operand (not an exception, irrelavant here)
606  * 3  Any other invalid-operation not mentioned above or zero divide
607  *      (FP_X_INV, FP_X_DZ)
608  * 4  Denormal operand (FP_X_DNML)
609  * 5  Numeric over/underflow (FP_X_OFL, FP_X_UFL)
610  * 6  Inexact result (FP_X_IMP) 
611  */
612 static char fpetable[128] = {
613         0,
614         FPE_FLTINV,     /*  1 - INV */
615         FPE_FLTUND,     /*  2 - DNML */
616         FPE_FLTINV,     /*  3 - INV | DNML */
617         FPE_FLTDIV,     /*  4 - DZ */
618         FPE_FLTINV,     /*  5 - INV | DZ */
619         FPE_FLTDIV,     /*  6 - DNML | DZ */
620         FPE_FLTINV,     /*  7 - INV | DNML | DZ */
621         FPE_FLTOVF,     /*  8 - OFL */
622         FPE_FLTINV,     /*  9 - INV | OFL */
623         FPE_FLTUND,     /*  A - DNML | OFL */
624         FPE_FLTINV,     /*  B - INV | DNML | OFL */
625         FPE_FLTDIV,     /*  C - DZ | OFL */
626         FPE_FLTINV,     /*  D - INV | DZ | OFL */
627         FPE_FLTDIV,     /*  E - DNML | DZ | OFL */
628         FPE_FLTINV,     /*  F - INV | DNML | DZ | OFL */
629         FPE_FLTUND,     /* 10 - UFL */
630         FPE_FLTINV,     /* 11 - INV | UFL */
631         FPE_FLTUND,     /* 12 - DNML | UFL */
632         FPE_FLTINV,     /* 13 - INV | DNML | UFL */
633         FPE_FLTDIV,     /* 14 - DZ | UFL */
634         FPE_FLTINV,     /* 15 - INV | DZ | UFL */
635         FPE_FLTDIV,     /* 16 - DNML | DZ | UFL */
636         FPE_FLTINV,     /* 17 - INV | DNML | DZ | UFL */
637         FPE_FLTOVF,     /* 18 - OFL | UFL */
638         FPE_FLTINV,     /* 19 - INV | OFL | UFL */
639         FPE_FLTUND,     /* 1A - DNML | OFL | UFL */
640         FPE_FLTINV,     /* 1B - INV | DNML | OFL | UFL */
641         FPE_FLTDIV,     /* 1C - DZ | OFL | UFL */
642         FPE_FLTINV,     /* 1D - INV | DZ | OFL | UFL */
643         FPE_FLTDIV,     /* 1E - DNML | DZ | OFL | UFL */
644         FPE_FLTINV,     /* 1F - INV | DNML | DZ | OFL | UFL */
645         FPE_FLTRES,     /* 20 - IMP */
646         FPE_FLTINV,     /* 21 - INV | IMP */
647         FPE_FLTUND,     /* 22 - DNML | IMP */
648         FPE_FLTINV,     /* 23 - INV | DNML | IMP */
649         FPE_FLTDIV,     /* 24 - DZ | IMP */
650         FPE_FLTINV,     /* 25 - INV | DZ | IMP */
651         FPE_FLTDIV,     /* 26 - DNML | DZ | IMP */
652         FPE_FLTINV,     /* 27 - INV | DNML | DZ | IMP */
653         FPE_FLTOVF,     /* 28 - OFL | IMP */
654         FPE_FLTINV,     /* 29 - INV | OFL | IMP */
655         FPE_FLTUND,     /* 2A - DNML | OFL | IMP */
656         FPE_FLTINV,     /* 2B - INV | DNML | OFL | IMP */
657         FPE_FLTDIV,     /* 2C - DZ | OFL | IMP */
658         FPE_FLTINV,     /* 2D - INV | DZ | OFL | IMP */
659         FPE_FLTDIV,     /* 2E - DNML | DZ | OFL | IMP */
660         FPE_FLTINV,     /* 2F - INV | DNML | DZ | OFL | IMP */
661         FPE_FLTUND,     /* 30 - UFL | IMP */
662         FPE_FLTINV,     /* 31 - INV | UFL | IMP */
663         FPE_FLTUND,     /* 32 - DNML | UFL | IMP */
664         FPE_FLTINV,     /* 33 - INV | DNML | UFL | IMP */
665         FPE_FLTDIV,     /* 34 - DZ | UFL | IMP */
666         FPE_FLTINV,     /* 35 - INV | DZ | UFL | IMP */
667         FPE_FLTDIV,     /* 36 - DNML | DZ | UFL | IMP */
668         FPE_FLTINV,     /* 37 - INV | DNML | DZ | UFL | IMP */
669         FPE_FLTOVF,     /* 38 - OFL | UFL | IMP */
670         FPE_FLTINV,     /* 39 - INV | OFL | UFL | IMP */
671         FPE_FLTUND,     /* 3A - DNML | OFL | UFL | IMP */
672         FPE_FLTINV,     /* 3B - INV | DNML | OFL | UFL | IMP */
673         FPE_FLTDIV,     /* 3C - DZ | OFL | UFL | IMP */
674         FPE_FLTINV,     /* 3D - INV | DZ | OFL | UFL | IMP */
675         FPE_FLTDIV,     /* 3E - DNML | DZ | OFL | UFL | IMP */
676         FPE_FLTINV,     /* 3F - INV | DNML | DZ | OFL | UFL | IMP */
677         FPE_FLTSUB,     /* 40 - STK */
678         FPE_FLTSUB,     /* 41 - INV | STK */
679         FPE_FLTUND,     /* 42 - DNML | STK */
680         FPE_FLTSUB,     /* 43 - INV | DNML | STK */
681         FPE_FLTDIV,     /* 44 - DZ | STK */
682         FPE_FLTSUB,     /* 45 - INV | DZ | STK */
683         FPE_FLTDIV,     /* 46 - DNML | DZ | STK */
684         FPE_FLTSUB,     /* 47 - INV | DNML | DZ | STK */
685         FPE_FLTOVF,     /* 48 - OFL | STK */
686         FPE_FLTSUB,     /* 49 - INV | OFL | STK */
687         FPE_FLTUND,     /* 4A - DNML | OFL | STK */
688         FPE_FLTSUB,     /* 4B - INV | DNML | OFL | STK */
689         FPE_FLTDIV,     /* 4C - DZ | OFL | STK */
690         FPE_FLTSUB,     /* 4D - INV | DZ | OFL | STK */
691         FPE_FLTDIV,     /* 4E - DNML | DZ | OFL | STK */
692         FPE_FLTSUB,     /* 4F - INV | DNML | DZ | OFL | STK */
693         FPE_FLTUND,     /* 50 - UFL | STK */
694         FPE_FLTSUB,     /* 51 - INV | UFL | STK */
695         FPE_FLTUND,     /* 52 - DNML | UFL | STK */
696         FPE_FLTSUB,     /* 53 - INV | DNML | UFL | STK */
697         FPE_FLTDIV,     /* 54 - DZ | UFL | STK */
698         FPE_FLTSUB,     /* 55 - INV | DZ | UFL | STK */
699         FPE_FLTDIV,     /* 56 - DNML | DZ | UFL | STK */
700         FPE_FLTSUB,     /* 57 - INV | DNML | DZ | UFL | STK */
701         FPE_FLTOVF,     /* 58 - OFL | UFL | STK */
702         FPE_FLTSUB,     /* 59 - INV | OFL | UFL | STK */
703         FPE_FLTUND,     /* 5A - DNML | OFL | UFL | STK */
704         FPE_FLTSUB,     /* 5B - INV | DNML | OFL | UFL | STK */
705         FPE_FLTDIV,     /* 5C - DZ | OFL | UFL | STK */
706         FPE_FLTSUB,     /* 5D - INV | DZ | OFL | UFL | STK */
707         FPE_FLTDIV,     /* 5E - DNML | DZ | OFL | UFL | STK */
708         FPE_FLTSUB,     /* 5F - INV | DNML | DZ | OFL | UFL | STK */
709         FPE_FLTRES,     /* 60 - IMP | STK */
710         FPE_FLTSUB,     /* 61 - INV | IMP | STK */
711         FPE_FLTUND,     /* 62 - DNML | IMP | STK */
712         FPE_FLTSUB,     /* 63 - INV | DNML | IMP | STK */
713         FPE_FLTDIV,     /* 64 - DZ | IMP | STK */
714         FPE_FLTSUB,     /* 65 - INV | DZ | IMP | STK */
715         FPE_FLTDIV,     /* 66 - DNML | DZ | IMP | STK */
716         FPE_FLTSUB,     /* 67 - INV | DNML | DZ | IMP | STK */
717         FPE_FLTOVF,     /* 68 - OFL | IMP | STK */
718         FPE_FLTSUB,     /* 69 - INV | OFL | IMP | STK */
719         FPE_FLTUND,     /* 6A - DNML | OFL | IMP | STK */
720         FPE_FLTSUB,     /* 6B - INV | DNML | OFL | IMP | STK */
721         FPE_FLTDIV,     /* 6C - DZ | OFL | IMP | STK */
722         FPE_FLTSUB,     /* 6D - INV | DZ | OFL | IMP | STK */
723         FPE_FLTDIV,     /* 6E - DNML | DZ | OFL | IMP | STK */
724         FPE_FLTSUB,     /* 6F - INV | DNML | DZ | OFL | IMP | STK */
725         FPE_FLTUND,     /* 70 - UFL | IMP | STK */
726         FPE_FLTSUB,     /* 71 - INV | UFL | IMP | STK */
727         FPE_FLTUND,     /* 72 - DNML | UFL | IMP | STK */
728         FPE_FLTSUB,     /* 73 - INV | DNML | UFL | IMP | STK */
729         FPE_FLTDIV,     /* 74 - DZ | UFL | IMP | STK */
730         FPE_FLTSUB,     /* 75 - INV | DZ | UFL | IMP | STK */
731         FPE_FLTDIV,     /* 76 - DNML | DZ | UFL | IMP | STK */
732         FPE_FLTSUB,     /* 77 - INV | DNML | DZ | UFL | IMP | STK */
733         FPE_FLTOVF,     /* 78 - OFL | UFL | IMP | STK */
734         FPE_FLTSUB,     /* 79 - INV | OFL | UFL | IMP | STK */
735         FPE_FLTUND,     /* 7A - DNML | OFL | UFL | IMP | STK */
736         FPE_FLTSUB,     /* 7B - INV | DNML | OFL | UFL | IMP | STK */
737         FPE_FLTDIV,     /* 7C - DZ | OFL | UFL | IMP | STK */
738         FPE_FLTSUB,     /* 7D - INV | DZ | OFL | UFL | IMP | STK */
739         FPE_FLTDIV,     /* 7E - DNML | DZ | OFL | UFL | IMP | STK */
740         FPE_FLTSUB,     /* 7F - INV | DNML | DZ | OFL | UFL | IMP | STK */
741 };
742
743 /*
744  * Preserve the FP status word, clear FP exceptions, then generate a SIGFPE.
745  *
746  * Clearing exceptions is necessary mainly to avoid IRQ13 bugs.  We now
747  * depend on longjmp() restoring a usable state.  Restoring the state
748  * or examining it might fail if we didn't clear exceptions.
749  *
750  * The error code chosen will be one of the FPE_... macros. It will be
751  * sent as the second argument to old BSD-style signal handlers and as
752  * "siginfo_t->si_code" (second argument) to SA_SIGINFO signal handlers.
753  *
754  * XXX the FP state is not preserved across signal handlers.  So signal
755  * handlers cannot afford to do FP unless they preserve the state or
756  * longjmp() out.  Both preserving the state and longjmp()ing may be
757  * destroyed by IRQ13 bugs.  Clearing FP exceptions is not an acceptable
758  * solution for signals other than SIGFPE.
759  *
760  * The MP lock is not held on entry (see i386/i386/exception.s) and
761  * should not be held on exit.
762  */
763 void
764 npx_intr(void *dummy)
765 {
766         int code;
767         u_short control;
768         struct intrframe *frame;
769         u_long *exstat;
770
771         if (mdcpu->gd_npxthread == NULL || !npx_exists) {
772                 get_mplock();
773                 printf("npxintr: npxthread = %p, curthread = %p, npx_exists = %d\n",
774                        mdcpu->gd_npxthread, curthread, npx_exists);
775                 panic("npxintr from nowhere");
776         }
777         if (mdcpu->gd_npxthread != curthread) {
778                 get_mplock();
779                 printf("npxintr: npxthread = %p, curthread = %p, npx_exists = %d\n",
780                        mdcpu->gd_npxthread, curthread, npx_exists);
781                 panic("npxintr from non-current process");
782         }
783
784         exstat = GET_FPU_EXSW_PTR(curthread);
785         outb(0xf0, 0);
786         fnstsw(exstat);
787         fnstcw(&control);
788         fnclex();
789
790         get_mplock();
791
792         /*
793          * Pass exception to process.
794          */
795         frame = (struct intrframe *)&dummy;     /* XXX */
796         if ((ISPL(frame->if_cs) == SEL_UPL) || (frame->if_eflags & PSL_VM)) {
797                 /*
798                  * Interrupt is essentially a trap, so we can afford to call
799                  * the SIGFPE handler (if any) as soon as the interrupt
800                  * returns.
801                  *
802                  * XXX little or nothing is gained from this, and plenty is
803                  * lost - the interrupt frame has to contain the trap frame
804                  * (this is otherwise only necessary for the rescheduling trap
805                  * in doreti, and the frame for that could easily be set up
806                  * just before it is used).
807                  */
808                 curproc->p_md.md_regs = INTR_TO_TRAPFRAME(frame);
809                 /*
810                  * Encode the appropriate code for detailed information on
811                  * this exception.
812                  */
813                 code = 
814                     fpetable[(*exstat & ~control & 0x3f) | (*exstat & 0x40)];
815                 trapsignal(curproc, SIGFPE, code);
816         } else {
817                 /*
818                  * Nested interrupt.  These losers occur when:
819                  *      o an IRQ13 is bogusly generated at a bogus time, e.g.:
820                  *              o immediately after an fnsave or frstor of an
821                  *                error state.
822                  *              o a couple of 386 instructions after
823                  *                "fstpl _memvar" causes a stack overflow.
824                  *        These are especially nasty when combined with a
825                  *        trace trap.
826                  *      o an IRQ13 occurs at the same time as another higher-
827                  *        priority interrupt.
828                  *
829                  * Treat them like a true async interrupt.
830                  */
831                 psignal(curproc, SIGFPE);
832         }
833         rel_mplock();
834 }
835
836 /*
837  * Implement the device not available (DNA) exception.  gd_npxthread had 
838  * better be NULL.  Restore the current thread's FP state and set gd_npxthread
839  * to curthread.
840  */
841 int
842 npxdna(void)
843 {
844         u_long *exstat;
845
846         if (!npx_exists)
847                 return (0);
848         if (mdcpu->gd_npxthread != NULL) {
849                 printf("npxdna: npxthread = %p, curthread = %p\n",
850                        mdcpu->gd_npxthread, curthread);
851                 panic("npxdna");
852         }
853         /*
854          * The setting of gd_npxthread and the call to fpurstor() must not
855          * be preempted by an interrupt thread or we will take an npxdna
856          * trap and potentially save our current fpstate (which is garbage)
857          * and then restore the garbage rather then the originally saved
858          * fpstate.
859          */
860         crit_enter();
861         stop_emulating();
862         /*
863          * Record new context early in case frstor causes an IRQ13.
864          */
865         mdcpu->gd_npxthread = curthread;
866         exstat = GET_FPU_EXSW_PTR(curthread);
867         *exstat = 0;
868         /*
869          * The following frstor may cause an IRQ13 when the state being
870          * restored has a pending error.  The error will appear to have been
871          * triggered by the current (npx) user instruction even when that
872          * instruction is a no-wait instruction that should not trigger an
873          * error (e.g., fnclex).  On at least one 486 system all of the
874          * no-wait instructions are broken the same as frstor, so our
875          * treatment does not amplify the breakage.  On at least one
876          * 386/Cyrix 387 system, fnclex works correctly while frstor and
877          * fnsave are broken, so our treatment breaks fnclex if it is the
878          * first FPU instruction after a context switch.
879          */
880         fpurstor(curthread->td_savefpu);
881         crit_exit();
882
883         return (1);
884 }
885
886 /*
887  * Wrapper for the fnsave instruction to handle h/w bugs.  If there is an error
888  * pending, then fnsave generates a bogus IRQ13 on some systems.  Force
889  * any IRQ13 to be handled immediately, and then ignore it.  This routine is
890  * often called at splhigh so it must not use many system services.  In
891  * particular, it's much easier to install a special handler than to
892  * guarantee that it's safe to use npxintr() and its supporting code.
893  *
894  * WARNING!  This call is made during a switch and the MP lock will be
895  * setup for the new target thread rather then the current thread, so we
896  * cannot do anything here that depends on the *_mplock() functions as
897  * we may trip over their assertions.
898  *
899  * WARNING!  When using fxsave we MUST fninit after saving the FP state.  The
900  * kernel will always assume that the FP state is 'safe' (will not cause
901  * exceptions) for mmx/xmm use if npxthread is NULL.  The kernel must still
902  * setup a custom save area before actually using the FP unit, but it will
903  * not bother calling fninit.  This greatly improves kernel performance when
904  * it wishes to use the FP unit.
905  */
906 void
907 npxsave(union savefpu *addr)
908 {
909 #if defined(SMP) || !defined(CPU_DISABLE_SSE)
910
911         crit_enter();
912         stop_emulating();
913         fpusave(addr);
914         mdcpu->gd_npxthread = NULL;
915         fninit();
916         start_emulating();
917         crit_exit();
918
919 #else /* !SMP and CPU_DISABLE_SSE */
920
921         u_char  icu1_mask;
922         u_char  icu2_mask;
923         u_char  old_icu1_mask;
924         u_char  old_icu2_mask;
925         struct gate_descriptor  save_idt_npxintr;
926         u_long  save_eflags;
927
928         save_eflags = read_eflags();
929         cpu_disable_intr();
930         old_icu1_mask = inb(IO_ICU1 + 1);
931         old_icu2_mask = inb(IO_ICU2 + 1);
932         save_idt_npxintr = idt[npx_intrno];
933         outb(IO_ICU1 + 1, old_icu1_mask & ~(IRQ_SLAVE | npx0_imask));
934         outb(IO_ICU2 + 1, old_icu2_mask & ~(npx0_imask >> 8));
935         idt[npx_intrno] = npx_idt_probeintr;
936         cpu_enable_intr();
937         stop_emulating();
938         fnsave(addr);
939         fnop();
940         cpu_disable_intr();
941         mdcpu->gd_npxthread = NULL;
942         start_emulating();
943         icu1_mask = inb(IO_ICU1 + 1);   /* masks may have changed */
944         icu2_mask = inb(IO_ICU2 + 1);
945         outb(IO_ICU1 + 1,
946              (icu1_mask & ~npx0_imask) | (old_icu1_mask & npx0_imask));
947         outb(IO_ICU2 + 1,
948              (icu2_mask & ~(npx0_imask >> 8))
949              | (old_icu2_mask & (npx0_imask >> 8)));
950         idt[npx_intrno] = save_idt_npxintr;
951         write_eflags(save_eflags);      /* back to usual state */
952
953 #endif /* SMP */
954 }
955
956 static void
957 fpusave(union savefpu *addr)
958 {
959 #ifndef CPU_DISABLE_SSE
960         if (cpu_fxsr)
961                 fxsave(addr);
962         else
963 #endif
964                 fnsave(addr);
965 }
966
967 static void
968 fpurstor(union savefpu *addr)
969 {
970 #ifndef CPU_DISABLE_SSE
971         if (cpu_fxsr)
972                 fxrstor(addr);
973         else
974 #endif
975                 frstor(addr);
976 }
977
978 static device_method_t npx_methods[] = {
979         /* Device interface */
980         DEVMETHOD(device_identify,      npx_identify),
981         DEVMETHOD(device_probe,         npx_probe),
982         DEVMETHOD(device_attach,        npx_attach),
983         DEVMETHOD(device_detach,        bus_generic_detach),
984         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
985         DEVMETHOD(device_suspend,       bus_generic_suspend),
986         DEVMETHOD(device_resume,        bus_generic_resume),
987         
988         { 0, 0 }
989 };
990
991 static driver_t npx_driver = {
992         "npx",
993         npx_methods,
994         1,                      /* no softc */
995 };
996
997 static devclass_t npx_devclass;
998
999 /*
1000  * We prefer to attach to the root nexus so that the usual case (exception 16)
1001  * doesn't describe the processor as being `on isa'.
1002  */
1003 DRIVER_MODULE(npx, nexus, npx_driver, npx_devclass, 0, 0);