xref: /freebsd/lib/libc/riscv/softfloat/softfloat.h (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
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 <fenv.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 int 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 int float_rounding_mode;
88 enum {
89     float_round_nearest_even = FE_TONEAREST,
90     float_round_to_zero      = FE_TOWARDZERO,
91     float_round_down         = FE_DOWNWARD,
92     float_round_up           = FE_UPWARD
93 };
94 
95 /*
96 -------------------------------------------------------------------------------
97 Software IEC/IEEE floating-point exception flags.
98 -------------------------------------------------------------------------------
99 */
100 extern int float_exception_flags;
101 extern int float_exception_mask;
102 enum {
103     float_flag_inexact   = FE_INEXACT,
104     float_flag_underflow = FE_UNDERFLOW,
105     float_flag_overflow  = FE_OVERFLOW,
106     float_flag_divbyzero = FE_DIVBYZERO,
107     float_flag_invalid   = FE_INVALID
108 };
109 
110 /*
111 -------------------------------------------------------------------------------
112 Routine to raise any or all of the software IEC/IEEE floating-point
113 exception flags.
114 -------------------------------------------------------------------------------
115 */
116 void float_raise( int );
117 
118 /*
119 -------------------------------------------------------------------------------
120 Software IEC/IEEE integer-to-floating-point conversion routines.
121 -------------------------------------------------------------------------------
122 */
123 float32 int32_to_float32( int );
124 float64 int32_to_float64( int );
125 #ifdef FLOATX80
126 floatx80 int32_to_floatx80( int );
127 #endif
128 #ifdef FLOAT128
129 float128 int32_to_float128( int );
130 #endif
131 #ifndef SOFTFLOAT_FOR_GCC /* __floatdi?f is in libgcc2.c */
132 float32 int64_to_float32( long long );
133 float64 int64_to_float64( long long );
134 #ifdef FLOATX80
135 floatx80 int64_to_floatx80( long long );
136 #endif
137 #ifdef FLOAT128
138 float128 int64_to_float128( long long );
139 #endif
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 #if defined(SOFTFLOAT_FOR_GCC) && defined(SOFTFLOAT_NEED_FIXUNS)
150 unsigned int float32_to_uint32_round_to_zero( float32 );
151 #endif
152 #ifndef SOFTFLOAT_FOR_GCC /* __fix?fdi provided by libgcc2.c */
153 long long float32_to_int64( float32 );
154 long long float32_to_int64_round_to_zero( float32 );
155 #endif
156 float64 float32_to_float64( float32 );
157 #ifdef FLOATX80
158 floatx80 float32_to_floatx80( float32 );
159 #endif
160 #ifdef FLOAT128
161 float128 float32_to_float128( float32 );
162 #endif
163 
164 /*
165 -------------------------------------------------------------------------------
166 Software IEC/IEEE single-precision operations.
167 -------------------------------------------------------------------------------
168 */
169 float32 float32_round_to_int( float32 );
170 float32 float32_add( float32, float32 );
171 float32 float32_sub( float32, float32 );
172 float32 float32_mul( float32, float32 );
173 float32 float32_div( float32, float32 );
174 float32 float32_rem( float32, float32 );
175 float32 float32_sqrt( float32 );
176 int float32_eq( float32, float32 );
177 int float32_le( float32, float32 );
178 int float32_lt( float32, float32 );
179 int float32_eq_signaling( float32, float32 );
180 int float32_le_quiet( float32, float32 );
181 int float32_lt_quiet( float32, float32 );
182 #ifndef SOFTFLOAT_FOR_GCC
183 int float32_is_signaling_nan( float32 );
184 #endif
185 
186 /*
187 -------------------------------------------------------------------------------
188 Software IEC/IEEE double-precision conversion routines.
189 -------------------------------------------------------------------------------
190 */
191 int float64_to_int32( float64 );
192 int float64_to_int32_round_to_zero( float64 );
193 #if defined(SOFTFLOAT_FOR_GCC) && defined(SOFTFLOAT_NEED_FIXUNS)
194 unsigned int float64_to_uint32_round_to_zero( float64 );
195 #endif
196 #ifndef SOFTFLOAT_FOR_GCC /* __fix?fdi provided by libgcc2.c */
197 long long float64_to_int64( float64 );
198 long long float64_to_int64_round_to_zero( float64 );
199 #endif
200 float32 float64_to_float32( float64 );
201 #ifdef FLOATX80
202 floatx80 float64_to_floatx80( float64 );
203 #endif
204 #ifdef FLOAT128
205 float128 float64_to_float128( float64 );
206 #endif
207 
208 /*
209 -------------------------------------------------------------------------------
210 Software IEC/IEEE double-precision operations.
211 -------------------------------------------------------------------------------
212 */
213 float64 float64_round_to_int( float64 );
214 float64 float64_add( float64, float64 );
215 float64 float64_sub( float64, float64 );
216 float64 float64_mul( float64, float64 );
217 float64 float64_div( float64, float64 );
218 float64 float64_rem( float64, float64 );
219 float64 float64_sqrt( float64 );
220 int float64_eq( float64, float64 );
221 int float64_le( float64, float64 );
222 int float64_lt( float64, float64 );
223 int float64_eq_signaling( float64, float64 );
224 int float64_le_quiet( float64, float64 );
225 int float64_lt_quiet( float64, float64 );
226 #ifndef SOFTFLOAT_FOR_GCC
227 int float64_is_signaling_nan( float64 );
228 #endif
229 
230 #ifdef FLOATX80
231 
232 /*
233 -------------------------------------------------------------------------------
234 Software IEC/IEEE extended double-precision conversion routines.
235 -------------------------------------------------------------------------------
236 */
237 int floatx80_to_int32( floatx80 );
238 int floatx80_to_int32_round_to_zero( floatx80 );
239 long long floatx80_to_int64( floatx80 );
240 long long floatx80_to_int64_round_to_zero( floatx80 );
241 float32 floatx80_to_float32( floatx80 );
242 float64 floatx80_to_float64( floatx80 );
243 #ifdef FLOAT128
244 float128 floatx80_to_float128( floatx80 );
245 #endif
246 
247 /*
248 -------------------------------------------------------------------------------
249 Software IEC/IEEE extended double-precision rounding precision.  Valid
250 values are 32, 64, and 80.
251 -------------------------------------------------------------------------------
252 */
253 extern int floatx80_rounding_precision;
254 
255 /*
256 -------------------------------------------------------------------------------
257 Software IEC/IEEE extended double-precision operations.
258 -------------------------------------------------------------------------------
259 */
260 floatx80 floatx80_round_to_int( floatx80 );
261 floatx80 floatx80_add( floatx80, floatx80 );
262 floatx80 floatx80_sub( floatx80, floatx80 );
263 floatx80 floatx80_mul( floatx80, floatx80 );
264 floatx80 floatx80_div( floatx80, floatx80 );
265 floatx80 floatx80_rem( floatx80, floatx80 );
266 floatx80 floatx80_sqrt( floatx80 );
267 int floatx80_eq( floatx80, floatx80 );
268 int floatx80_le( floatx80, floatx80 );
269 int floatx80_lt( floatx80, floatx80 );
270 int floatx80_eq_signaling( floatx80, floatx80 );
271 int floatx80_le_quiet( floatx80, floatx80 );
272 int floatx80_lt_quiet( floatx80, floatx80 );
273 int floatx80_is_signaling_nan( floatx80 );
274 
275 #endif
276 
277 #ifdef FLOAT128
278 
279 /*
280 -------------------------------------------------------------------------------
281 Software IEC/IEEE quadruple-precision conversion routines.
282 -------------------------------------------------------------------------------
283 */
284 int float128_to_int32( float128 );
285 int float128_to_int32_round_to_zero( float128 );
286 long long float128_to_int64( float128 );
287 long long float128_to_int64_round_to_zero( float128 );
288 float32 float128_to_float32( float128 );
289 float64 float128_to_float64( float128 );
290 #ifdef FLOATX80
291 floatx80 float128_to_floatx80( float128 );
292 #endif
293 
294 /*
295 -------------------------------------------------------------------------------
296 Software IEC/IEEE quadruple-precision operations.
297 -------------------------------------------------------------------------------
298 */
299 float128 float128_round_to_int( float128 );
300 float128 float128_add( float128, float128 );
301 float128 float128_sub( float128, float128 );
302 float128 float128_mul( float128, float128 );
303 float128 float128_div( float128, float128 );
304 float128 float128_rem( float128, float128 );
305 float128 float128_sqrt( float128 );
306 int float128_eq( float128, float128 );
307 int float128_le( float128, float128 );
308 int float128_lt( float128, float128 );
309 int float128_eq_signaling( float128, float128 );
310 int float128_le_quiet( float128, float128 );
311 int float128_lt_quiet( float128, float128 );
312 int float128_is_signaling_nan( float128 );
313 
314 #endif
315 
316