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