Home | History | Annotate | Line # | Download | only in softfloat
      1 /*	$NetBSD: softfloat.h,v 1.1 2014/09/03 19:34:26 matt 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 #ifndef SOFTFLOAT_FOR_GCC
     74 extern int8 float_detect_tininess;
     75 #endif
     76 enum {
     77     float_tininess_after_rounding  = 0,
     78     float_tininess_before_rounding = 1
     79 };
     80 
     81 /*
     82 -------------------------------------------------------------------------------
     83 Software IEC/IEEE floating-point rounding mode.
     84 -------------------------------------------------------------------------------
     85 */
     86 extern 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 -------------------------------------------------------------------------------
     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( int32 );
    121 float32 uint32_to_float32( uint32 );
    122 float64 int32_to_float64( int32 );
    123 float64 uint32_to_float64( uint32 );
    124 #ifdef FLOATX80
    125 floatx80 int32_to_floatx80( int32 );
    126 floatx80 uint32_to_floatx80( uint32 );
    127 #endif
    128 #ifdef FLOAT128
    129 float128 int32_to_float128( int32 );
    130 float128 uint32_to_float128( uint32 );
    131 #endif
    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 
    141 /*
    142 -------------------------------------------------------------------------------
    143 Software IEC/IEEE single-precision conversion routines.
    144 -------------------------------------------------------------------------------
    145 */
    146 int float32_to_int32( float32 );
    147 int float32_to_int32_round_to_zero( float32 );
    148 unsigned int float32_to_uint32_round_to_zero( float32 );
    149 long long float32_to_int64( float32 );
    150 long long float32_to_int64_round_to_zero( float32 );
    151 float64 float32_to_float64( float32 );
    152 #ifdef FLOATX80
    153 floatx80 float32_to_floatx80( float32 );
    154 #endif
    155 #ifdef FLOAT128
    156 float128 float32_to_float128( float32 );
    157 #endif
    158 
    159 /*
    160 -------------------------------------------------------------------------------
    161 Software IEC/IEEE single-precision operations.
    162 -------------------------------------------------------------------------------
    163 */
    164 float32 float32_round_to_int( float32 );
    165 float32 float32_add( float32, float32 );
    166 float32 float32_sub( float32, float32 );
    167 float32 float32_mul( float32, float32 );
    168 float32 float32_div( float32, float32 );
    169 float32 float32_rem( float32, float32 );
    170 float32 float32_sqrt( float32 );
    171 flag float32_eq( float32, float32 );
    172 flag float32_le( float32, float32 );
    173 flag float32_lt( float32, float32 );
    174 flag float32_eq_signaling( float32, float32 );
    175 flag float32_le_quiet( float32, float32 );
    176 flag float32_lt_quiet( float32, float32 );
    177 #ifndef SOFTFLOAT_FOR_GCC
    178 flag float32_is_signaling_nan( float32 );
    179 #endif
    180 
    181 /*
    182 -------------------------------------------------------------------------------
    183 Software IEC/IEEE double-precision conversion routines.
    184 -------------------------------------------------------------------------------
    185 */
    186 int float64_to_int32( float64 );
    187 int float64_to_int32_round_to_zero( float64 );
    188 unsigned int float64_to_uint32_round_to_zero( float64 );
    189 long long float64_to_int64( float64 );
    190 long long float64_to_int64_round_to_zero( float64 );
    191 float32 float64_to_float32( float64 );
    192 #ifdef FLOATX80
    193 floatx80 float64_to_floatx80( float64 );
    194 #endif
    195 #ifdef FLOAT128
    196 float128 float64_to_float128( float64 );
    197 #endif
    198 
    199 /*
    200 -------------------------------------------------------------------------------
    201 Software IEC/IEEE double-precision operations.
    202 -------------------------------------------------------------------------------
    203 */
    204 float64 float64_round_to_int( float64 );
    205 float64 float64_add( float64, float64 );
    206 float64 float64_sub( float64, float64 );
    207 float64 float64_mul( float64, float64 );
    208 float64 float64_div( float64, float64 );
    209 float64 float64_rem( float64, float64 );
    210 float64 float64_sqrt( float64 );
    211 flag float64_eq( float64, float64 );
    212 flag float64_le( float64, float64 );
    213 flag float64_lt( float64, float64 );
    214 flag float64_eq_signaling( float64, float64 );
    215 flag float64_le_quiet( float64, float64 );
    216 flag float64_lt_quiet( float64, float64 );
    217 #ifndef SOFTFLOAT_FOR_GCC
    218 flag float64_is_signaling_nan( float64 );
    219 #endif
    220 
    221 #ifdef FLOATX80
    222 
    223 /*
    224 -------------------------------------------------------------------------------
    225 Software IEC/IEEE extended double-precision conversion routines.
    226 -------------------------------------------------------------------------------
    227 */
    228 int floatx80_to_int32( floatx80 );
    229 int floatx80_to_int32_round_to_zero( floatx80 );
    230 long long floatx80_to_int64( floatx80 );
    231 long long floatx80_to_int64_round_to_zero( floatx80 );
    232 float32 floatx80_to_float32( floatx80 );
    233 float64 floatx80_to_float64( floatx80 );
    234 #ifdef FLOAT128
    235 float128 floatx80_to_float128( floatx80 );
    236 #endif
    237 
    238 /*
    239 -------------------------------------------------------------------------------
    240 Software IEC/IEEE extended double-precision rounding precision.  Valid
    241 values are 32, 64, and 80.
    242 -------------------------------------------------------------------------------
    243 */
    244 extern int floatx80_rounding_precision;
    245 
    246 /*
    247 -------------------------------------------------------------------------------
    248 Software IEC/IEEE extended double-precision operations.
    249 -------------------------------------------------------------------------------
    250 */
    251 floatx80 floatx80_round_to_int( floatx80 );
    252 floatx80 floatx80_add( floatx80, floatx80 );
    253 floatx80 floatx80_sub( floatx80, floatx80 );
    254 floatx80 floatx80_mul( floatx80, floatx80 );
    255 floatx80 floatx80_div( floatx80, floatx80 );
    256 floatx80 floatx80_rem( floatx80, floatx80 );
    257 floatx80 floatx80_sqrt( floatx80 );
    258 flag floatx80_eq( floatx80, floatx80 );
    259 flag floatx80_le( floatx80, floatx80 );
    260 flag floatx80_lt( floatx80, floatx80 );
    261 flag floatx80_eq_signaling( floatx80, floatx80 );
    262 flag floatx80_le_quiet( floatx80, floatx80 );
    263 flag floatx80_lt_quiet( floatx80, floatx80 );
    264 flag floatx80_is_signaling_nan( floatx80 );
    265 
    266 #endif
    267 
    268 #ifdef FLOAT128
    269 
    270 /*
    271 -------------------------------------------------------------------------------
    272 Software IEC/IEEE quadruple-precision conversion routines.
    273 -------------------------------------------------------------------------------
    274 */
    275 int float128_to_int32( float128 );
    276 int float128_to_int32_round_to_zero( float128 );
    277 long long float128_to_int64( float128 );
    278 long long float128_to_int64_round_to_zero( float128 );
    279 float32 float128_to_float32( float128 );
    280 float64 float128_to_float64( float128 );
    281 #ifdef FLOATX80
    282 floatx80 float128_to_floatx80( float128 );
    283 #endif
    284 
    285 /*
    286 -------------------------------------------------------------------------------
    287 Software IEC/IEEE quadruple-precision operations.
    288 -------------------------------------------------------------------------------
    289 */
    290 float128 float128_round_to_int( float128 );
    291 float128 float128_add( float128, float128 );
    292 float128 float128_sub( float128, float128 );
    293 float128 float128_mul( float128, float128 );
    294 float128 float128_div( float128, float128 );
    295 float128 float128_rem( float128, float128 );
    296 float128 float128_sqrt( float128 );
    297 flag float128_eq( float128, float128 );
    298 flag float128_le( float128, float128 );
    299 flag float128_lt( float128, float128 );
    300 flag float128_eq_signaling( float128, float128 );
    301 flag float128_le_quiet( float128, float128 );
    302 flag float128_lt_quiet( float128, float128 );
    303 flag float128_is_signaling_nan( float128 );
    304 
    305 #endif
    306