59742e247cd9dbc3f0c837877b029d8deb9c1127
[dragonfly.git] / share / man / man4 / man4.i386 / npx.4
1 .\"
2 .\" Copyright (c) 1993 Christopher G. Demetriou
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in the
12 .\"    documentation and/or other materials provided with the distribution.
13 .\" 3. All advertising materials mentioning features or use of this software
14 .\"    must display the following acknowledgement:
15 .\"      This product includes software developed by Christopher G. Demetriou.
16 .\" 3. The name of the author may not be used to endorse or promote products
17 .\"    derived from this software withough specific prior written permission
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 .\"
30 .\"     from: npx.4,v 1.1 1993/08/06 10:58:03 cgd Exp
31 .\" $FreeBSD: src/share/man/man4/man4.i386/npx.4,v 1.9.2.3 2001/08/17 13:08:46 ru Exp $
32 .\" $DragonFly: src/share/man/man4/man4.i386/npx.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
33 .\"
34 .Dd August 28, 1993
35 .Dt NPX 4 i386
36 .Os
37 .Sh NAME
38 .Nm npx
39 .Nd Numeric Processing Extension coprocessor and emulator
40 .Sh SYNOPSIS
41 .Cd "device npx0 at nexus? port IO_NPX flags 0x0 irq 13"
42 .Pp
43 For hosts without a FPU coprocessor add:
44 .Cd "options MATH_EMULATE"
45 or
46 .Cd "options GPL_MATH_EMULATE"
47 .\" XXX this is awful hackery to get it to work right... -- cgd
48 .\" What the heck does he mean? - cracauer
49 .Sh DESCRIPTION
50 The
51 .Nm
52 driver enables the use of the system's Numeric Processing Extension
53 coprocessor,
54 if one is present.  Numeric processing extensions are present in
55 systems with
56 .Sy 486DX
57 CPUs and in systems with
58 .Sy 387
59 or
60 .Sy 487SX
61 coprocessors.  The
62 .Nm
63 driver is required for proper system functioning regardless
64 of whether or not a NPX is present.
65 .Pp
66 If there is no NPX present in the system, the MATH_EMULATE or
67 GPL_MATH_EMULATE option must be defined in the kernel configuration
68 file.
69 It will provide support for the instructions normally executed by the
70 NPX.
71 If there is no NPX in the system and the kernel is not built with math
72 emulation, the system will not boot.
73 .Pp
74 You can choose to use a much more fully-featured math emulator (under the
75 GPL license) by including the option GPL_MATH_EMULATE in your kernel
76 configuration file instead of the MATH_EMULATE option.
77 .Pp
78 The
79 .Sy GENERIC
80 kernel configuration uses the MATH_EMULATE option.
81 .Pp
82 For a description of the possible "flags" values see the LINT kernel
83 configuration file.
84 .Sh CAVEATS
85 The emulator is much slower than the NPX coprocessor.
86 This will result in poor floating-point math performance
87 if the emulator must be used.
88 .Pp
89 The non-GPL emulator does not support the whole set of npx
90 instructions.
91 It is sufficient for booting and configuring a system, but it cannot
92 support a system with normal workload unless care is taken to compile
93 the whole system (including third-party packages) with compiler
94 options that avoid the use of the non-emulated instructions.
95 .Sh BUGS
96 There are lots of them, especially on old cheap motherboards.
97 In particular, some motherboards do not have the interrupt lines from
98 the NPX to the CPU wired properly.
99 If this is the case, the emulator must be used if consistent system
100 operation is desired.
101 .Pp
102 When using the default MATH_EMULATE option,
103 transcendental function instructions are not implemented.
104 Emulation of other instructions is suspect.