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