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