xref: /netbsd-src/lib/libc/arch/arm/softfloat/softfloat.h (revision 5e4c038a45edbc7d63b7c2daa76e29f88b64a4e3)
1 /*	$NetBSD: softfloat.h,v 1.6 2002/05/12 13:12:46 bjh21 Exp $	*/
2 
3 /* This is a derivative work. */
4 
5 /*
6 ===============================================================================
7 
8 This C header file is part of the SoftFloat IEC/IEEE Floating-point
9 Arithmetic Package, Release 2a.
10 
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'.
20 
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.
26 
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.
31 
32 ===============================================================================
33 */
34 
35 /*
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 -------------------------------------------------------------------------------
43 */
44 /* #define FLOATX80 */
45 /* #define FLOAT128 */
46 
47 #include <machine/ieeefp.h>
48 
49 /*
50 -------------------------------------------------------------------------------
51 Software IEC/IEEE floating-point types.
52 -------------------------------------------------------------------------------
53 */
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
67 
68 /*
69 -------------------------------------------------------------------------------
70 Software IEC/IEEE floating-point underflow tininess-detection mode.
71 -------------------------------------------------------------------------------
72 */
73 extern int float_detect_tininess;
74 enum {
75     float_tininess_after_rounding  = 0,
76     float_tininess_before_rounding = 1
77 };
78 
79 /*
80 -------------------------------------------------------------------------------
81 Software IEC/IEEE floating-point rounding mode.
82 -------------------------------------------------------------------------------
83 */
84 extern fp_rnd float_rounding_mode;
85 enum {
86     float_round_nearest_even = FP_RN,
87     float_round_to_zero      = FP_RZ,
88     float_round_down         = FP_RM,
89     float_round_up           = FP_RP
90 };
91 
92 /*
93 -------------------------------------------------------------------------------
94 Software IEC/IEEE floating-point exception flags.
95 -------------------------------------------------------------------------------
96 */
97 extern fp_except float_exception_flags;
98 extern fp_except float_exception_mask;
99 enum {
100     float_flag_inexact   = FP_X_IMP,
101     float_flag_underflow = FP_X_UFL,
102     float_flag_overflow  = FP_X_OFL,
103     float_flag_divbyzero = FP_X_DZ,
104     float_flag_invalid   = FP_X_INV
105 };
106 
107 /*
108 -------------------------------------------------------------------------------
109 Routine to raise any or all of the software IEC/IEEE floating-point
110 exception flags.
111 -------------------------------------------------------------------------------
112 */
113 void float_raise( fp_except );
114 
115 /*
116 -------------------------------------------------------------------------------
117 Software IEC/IEEE integer-to-floating-point conversion routines.
118 -------------------------------------------------------------------------------
119 */
120 float32 int32_to_float32( int );
121 float64 int32_to_float64( int );
122 #ifdef FLOATX80
123 floatx80 int32_to_floatx80( int );
124 #endif
125 #ifdef FLOAT128
126 float128 int32_to_float128( int );
127 #endif
128 #ifndef SOFTFLOAT_FOR_GCC /* __floatdi?f is in libgcc2.c */
129 float32 int64_to_float32( long long );
130 float64 int64_to_float64( long long );
131 #ifdef FLOATX80
132 floatx80 int64_to_floatx80( long long );
133 #endif
134 #ifdef FLOAT128
135 float128 int64_to_float128( long long );
136 #endif
137 #endif
138 
139 /*
140 -------------------------------------------------------------------------------
141 Software IEC/IEEE single-precision conversion routines.
142 -------------------------------------------------------------------------------
143 */
144 int float32_to_int32( float32 );
145 int float32_to_int32_round_to_zero( float32 );
146 #if defined(SOFTFLOAT_FOR_GCC) && defined(SOFTFLOAT_NEED_FIXUNS)
147 unsigned int float32_to_uint32_round_to_zero( float32 );
148 #endif
149 #ifndef SOFTFLOAT_FOR_GCC /* __fix?fdi provided by libgcc2.c */
150 long long float32_to_int64( float32 );
151 long long float32_to_int64_round_to_zero( float32 );
152 #endif
153 float64 float32_to_float64( float32 );
154 #ifdef FLOATX80
155 floatx80 float32_to_floatx80( float32 );
156 #endif
157 #ifdef FLOAT128
158 float128 float32_to_float128( float32 );
159 #endif
160 
161 /*
162 -------------------------------------------------------------------------------
163 Software IEC/IEEE single-precision operations.
164 -------------------------------------------------------------------------------
165 */
166 float32 float32_round_to_int( float32 );
167 float32 float32_add( float32, float32 );
168 float32 float32_sub( float32, float32 );
169 float32 float32_mul( float32, float32 );
170 float32 float32_div( float32, float32 );
171 float32 float32_rem( float32, float32 );
172 float32 float32_sqrt( float32 );
173 int float32_eq( float32, float32 );
174 int float32_le( float32, float32 );
175 int float32_lt( float32, float32 );
176 int float32_eq_signaling( float32, float32 );
177 int float32_le_quiet( float32, float32 );
178 int float32_lt_quiet( float32, float32 );
179 #ifndef SOFTFLOAT_FOR_GCC
180 int float32_is_signaling_nan( float32 );
181 #endif
182 
183 /*
184 -------------------------------------------------------------------------------
185 Software IEC/IEEE double-precision conversion routines.
186 -------------------------------------------------------------------------------
187 */
188 int float64_to_int32( float64 );
189 int float64_to_int32_round_to_zero( float64 );
190 #if defined(SOFTFLOAT_FOR_GCC) && defined(SOFTFLOAT_NEED_FIXUNS)
191 unsigned int float64_to_uint32_round_to_zero( float64 );
192 #endif
193 #ifndef SOFTFLOAT_FOR_GCC /* __fix?fdi provided by libgcc2.c */
194 long long float64_to_int64( float64 );
195 long long float64_to_int64_round_to_zero( float64 );
196 #endif
197 float32 float64_to_float32( float64 );
198 #ifdef FLOATX80
199 floatx80 float64_to_floatx80( float64 );
200 #endif
201 #ifdef FLOAT128
202 float128 float64_to_float128( float64 );
203 #endif
204 
205 /*
206 -------------------------------------------------------------------------------
207 Software IEC/IEEE double-precision operations.
208 -------------------------------------------------------------------------------
209 */
210 float64 float64_round_to_int( float64 );
211 float64 float64_add( float64, float64 );
212 float64 float64_sub( float64, float64 );
213 float64 float64_mul( float64, float64 );
214 float64 float64_div( float64, float64 );
215 float64 float64_rem( float64, float64 );
216 float64 float64_sqrt( float64 );
217 int float64_eq( float64, float64 );
218 int float64_le( float64, float64 );
219 int float64_lt( float64, float64 );
220 int float64_eq_signaling( float64, float64 );
221 int float64_le_quiet( float64, float64 );
222 int float64_lt_quiet( float64, float64 );
223 #ifndef SOFTFLOAT_FOR_GCC
224 int float64_is_signaling_nan( float64 );
225 #endif
226 
227 #ifdef FLOATX80
228 
229 /*
230 -------------------------------------------------------------------------------
231 Software IEC/IEEE extended double-precision conversion routines.
232 -------------------------------------------------------------------------------
233 */
234 int floatx80_to_int32( floatx80 );
235 int floatx80_to_int32_round_to_zero( floatx80 );
236 long long floatx80_to_int64( floatx80 );
237 long long floatx80_to_int64_round_to_zero( floatx80 );
238 float32 floatx80_to_float32( floatx80 );
239 float64 floatx80_to_float64( floatx80 );
240 #ifdef FLOAT128
241 float128 floatx80_to_float128( floatx80 );
242 #endif
243 
244 /*
245 -------------------------------------------------------------------------------
246 Software IEC/IEEE extended double-precision rounding precision.  Valid
247 values are 32, 64, and 80.
248 -------------------------------------------------------------------------------
249 */
250 extern int floatx80_rounding_precision;
251 
252 /*
253 -------------------------------------------------------------------------------
254 Software IEC/IEEE extended double-precision operations.
255 -------------------------------------------------------------------------------
256 */
257 floatx80 floatx80_round_to_int( floatx80 );
258 floatx80 floatx80_add( floatx80, floatx80 );
259 floatx80 floatx80_sub( floatx80, floatx80 );
260 floatx80 floatx80_mul( floatx80, floatx80 );
261 floatx80 floatx80_div( floatx80, floatx80 );
262 floatx80 floatx80_rem( floatx80, floatx80 );
263 floatx80 floatx80_sqrt( floatx80 );
264 int floatx80_eq( floatx80, floatx80 );
265 int floatx80_le( floatx80, floatx80 );
266 int floatx80_lt( floatx80, floatx80 );
267 int floatx80_eq_signaling( floatx80, floatx80 );
268 int floatx80_le_quiet( floatx80, floatx80 );
269 int floatx80_lt_quiet( floatx80, floatx80 );
270 int floatx80_is_signaling_nan( floatx80 );
271 
272 #endif
273 
274 #ifdef FLOAT128
275 
276 /*
277 -------------------------------------------------------------------------------
278 Software IEC/IEEE quadruple-precision conversion routines.
279 -------------------------------------------------------------------------------
280 */
281 int float128_to_int32( float128 );
282 int float128_to_int32_round_to_zero( float128 );
283 long long float128_to_int64( float128 );
284 long long float128_to_int64_round_to_zero( float128 );
285 float32 float128_to_float32( float128 );
286 float64 float128_to_float64( float128 );
287 #ifdef FLOATX80
288 floatx80 float128_to_floatx80( float128 );
289 #endif
290 
291 /*
292 -------------------------------------------------------------------------------
293 Software IEC/IEEE quadruple-precision operations.
294 -------------------------------------------------------------------------------
295 */
296 float128 float128_round_to_int( float128 );
297 float128 float128_add( float128, float128 );
298 float128 float128_sub( float128, float128 );
299 float128 float128_mul( float128, float128 );
300 float128 float128_div( float128, float128 );
301 float128 float128_rem( float128, float128 );
302 float128 float128_sqrt( float128 );
303 int float128_eq( float128, float128 );
304 int float128_le( float128, float128 );
305 int float128_lt( float128, float128 );
306 int float128_eq_signaling( float128, float128 );
307 int float128_le_quiet( float128, float128 );
308 int float128_lt_quiet( float128, float128 );
309 int float128_is_signaling_nan( float128 );
310 
311 #endif
312 
313