Sync usage with man page.
[netbsd-mini2440.git] / lib / libc / arch / m68k / softfloat / softfloat.h
blobc4b1262830d1b56c1d212cfa847d66a9da3f5700
1 /* $NetBSD: softfloat.h,v 1.1 2004/09/26 21:13:27 jmmv Exp $ */
3 /* This is a derivative work. */
5 /*
6 ===============================================================================
8 This C header file is part of the SoftFloat IEC/IEEE Floating-point
9 Arithmetic Package, Release 2a.
11 Written by John R. Hauser. This work was made possible in part by the
12 International Computer Science Institute, located at Suite 600, 1947 Center
13 Street, Berkeley, California 94704. Funding was partially provided by the
14 National Science Foundation under grant MIP-9311980. The original version
15 of this code was written as part of a project to build a fixed-point vector
16 processor in collaboration with the University of California at Berkeley,
17 overseen by Profs. Nelson Morgan and John Wawrzynek. More information
18 is available through the Web page `http://HTTP.CS.Berkeley.EDU/~jhauser/
19 arithmetic/SoftFloat.html'.
21 THIS SOFTWARE IS DISTRIBUTED AS IS, FOR FREE. Although reasonable effort
22 has been made to avoid it, THIS SOFTWARE MAY CONTAIN FAULTS THAT WILL AT
23 TIMES RESULT IN INCORRECT BEHAVIOR. USE OF THIS SOFTWARE IS RESTRICTED TO
24 PERSONS AND ORGANIZATIONS WHO CAN AND WILL TAKE FULL RESPONSIBILITY FOR ANY
25 AND ALL LOSSES, COSTS, OR OTHER PROBLEMS ARISING FROM ITS USE.
27 Derivative works are acceptable, even for commercial purposes, so long as
28 (1) they include prominent notice that the work is derivative, and (2) they
29 include prominent notice akin to these four paragraphs for those parts of
30 this code that are retained.
32 ===============================================================================
36 -------------------------------------------------------------------------------
37 The macro `FLOATX80' must be defined to enable the extended double-precision
38 floating-point format `floatx80'. If this macro is not defined, the
39 `floatx80' type will not be defined, and none of the functions that either
40 input or output the `floatx80' type will be defined. The same applies to
41 the `FLOAT128' macro and the quadruple-precision format `float128'.
42 -------------------------------------------------------------------------------
44 #define FLOATX80
45 /* #define FLOAT128 */
47 #include <machine/ieeefp.h>
50 -------------------------------------------------------------------------------
51 Software IEC/IEEE floating-point types.
52 -------------------------------------------------------------------------------
54 typedef unsigned int float32;
55 typedef unsigned long long float64;
56 #ifdef FLOATX80
57 typedef struct {
58 unsigned short high;
59 unsigned long long low;
60 } floatx80;
61 #endif
62 #ifdef FLOAT128
63 typedef struct {
64 unsigned long long high, low;
65 } float128;
66 #endif
69 -------------------------------------------------------------------------------
70 Software IEC/IEEE floating-point underflow tininess-detection mode.
71 -------------------------------------------------------------------------------
73 #ifndef SOFTFLOAT_FOR_GCC
74 extern int8 float_detect_tininess;
75 #endif
76 enum {
77 float_tininess_after_rounding = 0,
78 float_tininess_before_rounding = 1
82 -------------------------------------------------------------------------------
83 Software IEC/IEEE floating-point rounding mode.
84 -------------------------------------------------------------------------------
86 extern fp_rnd float_rounding_mode;
87 enum {
88 float_round_nearest_even = FP_RN,
89 float_round_to_zero = FP_RZ,
90 float_round_down = FP_RM,
91 float_round_up = FP_RP
95 -------------------------------------------------------------------------------
96 Software IEC/IEEE floating-point exception flags.
97 -------------------------------------------------------------------------------
99 extern fp_except float_exception_flags;
100 extern fp_except float_exception_mask;
101 enum {
102 float_flag_inexact = FP_X_IMP,
103 float_flag_underflow = FP_X_UFL,
104 float_flag_overflow = FP_X_OFL,
105 float_flag_divbyzero = FP_X_DZ,
106 float_flag_invalid = FP_X_INV
110 -------------------------------------------------------------------------------
111 Routine to raise any or all of the software IEC/IEEE floating-point
112 exception flags.
113 -------------------------------------------------------------------------------
115 void float_raise( fp_except );
118 -------------------------------------------------------------------------------
119 Software IEC/IEEE integer-to-floating-point conversion routines.
120 -------------------------------------------------------------------------------
122 float32 int32_to_float32( int );
123 float64 int32_to_float64( int );
124 #ifdef FLOATX80
125 floatx80 int32_to_floatx80( int );
126 #endif
127 #ifdef FLOAT128
128 float128 int32_to_float128( int );
129 #endif
130 float32 int64_to_float32( long long );
131 float64 int64_to_float64( long long );
132 #ifdef FLOATX80
133 floatx80 int64_to_floatx80( long long );
134 #endif
135 #ifdef FLOAT128
136 float128 int64_to_float128( long long );
137 #endif
140 -------------------------------------------------------------------------------
141 Software IEC/IEEE single-precision conversion routines.
142 -------------------------------------------------------------------------------
144 int float32_to_int32( float32 );
145 int float32_to_int32_round_to_zero( float32 );
146 unsigned int float32_to_uint32_round_to_zero( float32 );
147 long long float32_to_int64( float32 );
148 long long float32_to_int64_round_to_zero( float32 );
149 float64 float32_to_float64( float32 );
150 #ifdef FLOATX80
151 floatx80 float32_to_floatx80( float32 );
152 #endif
153 #ifdef FLOAT128
154 float128 float32_to_float128( float32 );
155 #endif
158 -------------------------------------------------------------------------------
159 Software IEC/IEEE single-precision operations.
160 -------------------------------------------------------------------------------
162 float32 float32_round_to_int( float32 );
163 float32 float32_add( float32, float32 );
164 float32 float32_sub( float32, float32 );
165 float32 float32_mul( float32, float32 );
166 float32 float32_div( float32, float32 );
167 float32 float32_rem( float32, float32 );
168 float32 float32_sqrt( float32 );
169 flag float32_eq( float32, float32 );
170 flag float32_le( float32, float32 );
171 flag float32_lt( float32, float32 );
172 flag float32_eq_signaling( float32, float32 );
173 flag float32_le_quiet( float32, float32 );
174 flag float32_lt_quiet( float32, float32 );
175 #ifndef SOFTFLOAT_FOR_GCC
176 flag float32_is_signaling_nan( float32 );
177 #endif
180 -------------------------------------------------------------------------------
181 Software IEC/IEEE double-precision conversion routines.
182 -------------------------------------------------------------------------------
184 int float64_to_int32( float64 );
185 int float64_to_int32_round_to_zero( float64 );
186 unsigned int float64_to_uint32_round_to_zero( float64 );
187 long long float64_to_int64( float64 );
188 long long float64_to_int64_round_to_zero( float64 );
189 float32 float64_to_float32( float64 );
190 #ifdef FLOATX80
191 floatx80 float64_to_floatx80( float64 );
192 #endif
193 #ifdef FLOAT128
194 float128 float64_to_float128( float64 );
195 #endif
198 -------------------------------------------------------------------------------
199 Software IEC/IEEE double-precision operations.
200 -------------------------------------------------------------------------------
202 float64 float64_round_to_int( float64 );
203 float64 float64_add( float64, float64 );
204 float64 float64_sub( float64, float64 );
205 float64 float64_mul( float64, float64 );
206 float64 float64_div( float64, float64 );
207 float64 float64_rem( float64, float64 );
208 float64 float64_sqrt( float64 );
209 flag float64_eq( float64, float64 );
210 flag float64_le( float64, float64 );
211 flag float64_lt( float64, float64 );
212 flag float64_eq_signaling( float64, float64 );
213 flag float64_le_quiet( float64, float64 );
214 flag float64_lt_quiet( float64, float64 );
215 flag float64_is_signaling_nan( float64 );
217 #ifdef FLOATX80
220 -------------------------------------------------------------------------------
221 Software IEC/IEEE extended double-precision conversion routines.
222 -------------------------------------------------------------------------------
224 int floatx80_to_int32( floatx80 );
225 int floatx80_to_int32_round_to_zero( floatx80 );
226 long long floatx80_to_int64( floatx80 );
227 long long floatx80_to_int64_round_to_zero( floatx80 );
228 float32 floatx80_to_float32( floatx80 );
229 float64 floatx80_to_float64( floatx80 );
230 #ifdef FLOAT128
231 float128 floatx80_to_float128( floatx80 );
232 #endif
235 -------------------------------------------------------------------------------
236 Software IEC/IEEE extended double-precision rounding precision. Valid
237 values are 32, 64, and 80.
238 -------------------------------------------------------------------------------
240 extern int floatx80_rounding_precision;
243 -------------------------------------------------------------------------------
244 Software IEC/IEEE extended double-precision operations.
245 -------------------------------------------------------------------------------
247 floatx80 floatx80_round_to_int( floatx80 );
248 floatx80 floatx80_add( floatx80, floatx80 );
249 floatx80 floatx80_sub( floatx80, floatx80 );
250 floatx80 floatx80_mul( floatx80, floatx80 );
251 floatx80 floatx80_div( floatx80, floatx80 );
252 floatx80 floatx80_rem( floatx80, floatx80 );
253 floatx80 floatx80_sqrt( floatx80 );
254 flag floatx80_eq( floatx80, floatx80 );
255 flag floatx80_le( floatx80, floatx80 );
256 flag floatx80_lt( floatx80, floatx80 );
257 flag floatx80_eq_signaling( floatx80, floatx80 );
258 flag floatx80_le_quiet( floatx80, floatx80 );
259 flag floatx80_lt_quiet( floatx80, floatx80 );
260 flag floatx80_is_signaling_nan( floatx80 );
261 flag floatx80_is_nan( floatx80 );
263 #endif
265 #ifdef FLOAT128
268 -------------------------------------------------------------------------------
269 Software IEC/IEEE quadruple-precision conversion routines.
270 -------------------------------------------------------------------------------
272 int float128_to_int32( float128 );
273 int float128_to_int32_round_to_zero( float128 );
274 long long float128_to_int64( float128 );
275 long long float128_to_int64_round_to_zero( float128 );
276 float32 float128_to_float32( float128 );
277 float64 float128_to_float64( float128 );
278 #ifdef FLOATX80
279 floatx80 float128_to_floatx80( float128 );
280 #endif
283 -------------------------------------------------------------------------------
284 Software IEC/IEEE quadruple-precision operations.
285 -------------------------------------------------------------------------------
287 float128 float128_round_to_int( float128 );
288 float128 float128_add( float128, float128 );
289 float128 float128_sub( float128, float128 );
290 float128 float128_mul( float128, float128 );
291 float128 float128_div( float128, float128 );
292 float128 float128_rem( float128, float128 );
293 float128 float128_sqrt( float128 );
294 flag float128_eq( float128, float128 );
295 flag float128_le( float128, float128 );
296 flag float128_lt( float128, float128 );
297 flag float128_eq_signaling( float128, float128 );
298 flag float128_le_quiet( float128, float128 );
299 flag float128_lt_quiet( float128, float128 );
300 flag float128_is_signaling_nan( float128 );
302 #endif