Home | History | Annotate | Line # | Download | only in softfloat
      1 /*	$NetBSD: softfloat.h,v 1.12 2025/09/29 02:47:18 nat 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 #ifndef __mcoldfire__
     45 #define FLOATX80
     46 #endif
     47 /* #define FLOAT128 */
     48 
     49 #include <machine/ieeefp.h>
     50 
     51 /*
     52 -------------------------------------------------------------------------------
     53 Software IEC/IEEE floating-point types.
     54 -------------------------------------------------------------------------------
     55 */
     56 typedef unsigned int float32;
     57 typedef unsigned long long float64;
     58 #ifdef FLOATX80
     59 #define X80SHIFT	16
     60 #define X80M68K
     61 
     62 typedef struct {
     63     unsigned long high;
     64     unsigned long long low;
     65 }__packed floatx80;
     66 #endif
     67 #ifdef FLOAT128
     68 typedef struct {
     69     unsigned long long high, low;
     70 } float128;
     71 #endif
     72 
     73 /*
     74 -------------------------------------------------------------------------------
     75 Software IEC/IEEE floating-point underflow tininess-detection mode.
     76 -------------------------------------------------------------------------------
     77 */
     78 #ifndef SOFTFLOAT_FOR_GCC
     79 extern int8 float_detect_tininess;
     80 #endif
     81 enum {
     82     float_tininess_after_rounding  = 0,
     83     float_tininess_before_rounding = 1
     84 };
     85 
     86 /*
     87 -------------------------------------------------------------------------------
     88 Software IEC/IEEE floating-point rounding mode.
     89 -------------------------------------------------------------------------------
     90 */
     91 extern fp_rnd float_rounding_mode;
     92 #define float_round_nearest_even FP_RN
     93 #define float_round_to_zero      FP_RZ
     94 #define float_round_down         FP_RM
     95 #define float_round_up           FP_RP
     96 
     97 /*
     98 -------------------------------------------------------------------------------
     99 Software IEC/IEEE floating-point exception flags.
    100 -------------------------------------------------------------------------------
    101 */
    102 extern fp_except float_exception_flags;
    103 extern fp_except float_exception_mask;
    104 enum {
    105     float_flag_inexact   = FP_X_IMP,
    106     float_flag_underflow = FP_X_UFL,
    107     float_flag_overflow  = FP_X_OFL,
    108     float_flag_divbyzero = FP_X_DZ,
    109     float_flag_invalid   = FP_X_INV
    110 };
    111 
    112 /*
    113 -------------------------------------------------------------------------------
    114 Routine to raise any or all of the software IEC/IEEE floating-point
    115 exception flags.
    116 -------------------------------------------------------------------------------
    117 */
    118 void float_raise( fp_except );
    119 
    120 /*
    121 -------------------------------------------------------------------------------
    122 Software IEC/IEEE integer-to-floating-point conversion routines.
    123 -------------------------------------------------------------------------------
    124 */
    125 float32 int32_to_float32( int32 );
    126 float32 uint32_to_float32( uint32 );
    127 float64 int32_to_float64( int32 );
    128 float64 uint32_to_float64( uint32 );
    129 #ifdef FLOATX80
    130 floatx80 int32_to_floatx80( int32 );
    131 floatx80 uint32_to_floatx80( uint32 );
    132 #endif
    133 #ifdef FLOAT128
    134 float128 int32_to_float128( int32 );
    135 float128 uint32_to_float128( uint32 );
    136 #endif
    137 float32 int64_to_float32( long long );
    138 float64 int64_to_float64( long long );
    139 #ifdef FLOATX80
    140 floatx80 int64_to_floatx80( long long );
    141 #endif
    142 #ifdef FLOAT128
    143 float128 int64_to_float128( long long );
    144 #endif
    145 
    146 /*
    147 -------------------------------------------------------------------------------
    148 Software IEC/IEEE single-precision conversion routines.
    149 -------------------------------------------------------------------------------
    150 */
    151 int float32_to_int32( float32 );
    152 int float32_to_int32_round_to_zero( float32 );
    153 unsigned int float32_to_uint32_round_to_zero( float32 );
    154 long long float32_to_int64( float32 );
    155 long long float32_to_int64_round_to_zero( float32 );
    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 flag float32_eq( float32, float32 );
    177 flag float32_le( float32, float32 );
    178 flag float32_lt( float32, float32 );
    179 flag float32_eq_signaling( float32, float32 );
    180 flag float32_le_quiet( float32, float32 );
    181 flag float32_lt_quiet( float32, float32 );
    182 #if !defined(SOFTFLOAT_FOR_GCC) || defined(SOFTFLOATM68K_FOR_GCC)
    183 flag 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 unsigned int float64_to_uint32_round_to_zero( float64 );
    194 long long float64_to_int64( float64 );
    195 long long float64_to_int64_round_to_zero( float64 );
    196 float32 float64_to_float32( float64 );
    197 #ifdef FLOATX80
    198 floatx80 float64_to_floatx80( float64 );
    199 #endif
    200 #ifdef FLOAT128
    201 float128 float64_to_float128( float64 );
    202 #endif
    203 
    204 /*
    205 -------------------------------------------------------------------------------
    206 Software IEC/IEEE double-precision operations.
    207 -------------------------------------------------------------------------------
    208 */
    209 float64 float64_round_to_int( float64 );
    210 float64 float64_add( float64, float64 );
    211 float64 float64_sub( float64, float64 );
    212 float64 float64_mul( float64, float64 );
    213 float64 float64_div( float64, float64 );
    214 float64 float64_rem( float64, float64 );
    215 float64 float64_sqrt( float64 );
    216 flag float64_eq( float64, float64 );
    217 flag float64_le( float64, float64 );
    218 flag float64_lt( float64, float64 );
    219 flag float64_eq_signaling( float64, float64 );
    220 flag float64_le_quiet( float64, float64 );
    221 flag float64_lt_quiet( float64, float64 );
    222 #if !defined(SOFTFLOAT_FOR_GCC) || defined(SOFTFLOATM68K_FOR_GCC)
    223 flag float64_is_signaling_nan( float64 );
    224 #endif
    225 
    226 #ifdef FLOATX80
    227 
    228 /*
    229 -------------------------------------------------------------------------------
    230 Software IEC/IEEE extended double-precision conversion routines.
    231 -------------------------------------------------------------------------------
    232 */
    233 int floatx80_to_int32( floatx80 );
    234 int floatx80_to_int32_round_to_zero( floatx80 );
    235 long long floatx80_to_int64( floatx80 );
    236 long long floatx80_to_int64_round_to_zero( floatx80 );
    237 float32 floatx80_to_float32( floatx80 );
    238 float64 floatx80_to_float64( floatx80 );
    239 #ifdef FLOAT128
    240 float128 floatx80_to_float128( floatx80 );
    241 #endif
    242 
    243 /*
    244 -------------------------------------------------------------------------------
    245 Software IEC/IEEE extended double-precision rounding precision.  Valid
    246 values are 32, 64, and 80.
    247 -------------------------------------------------------------------------------
    248 */
    249 extern int floatx80_rounding_precision;
    250 
    251 /*
    252 -------------------------------------------------------------------------------
    253 Software IEC/IEEE extended double-precision operations.
    254 -------------------------------------------------------------------------------
    255 */
    256 floatx80 floatx80_round_to_int( floatx80 );
    257 floatx80 floatx80_add( floatx80, floatx80 );
    258 floatx80 floatx80_sub( floatx80, floatx80 );
    259 floatx80 floatx80_mul( floatx80, floatx80 );
    260 floatx80 floatx80_div( floatx80, floatx80 );
    261 floatx80 floatx80_rem( floatx80, floatx80 );
    262 floatx80 floatx80_sqrt( floatx80 );
    263 flag floatx80_eq_internal( floatx80, floatx80 );
    264 flag floatx80_le_internal( floatx80, floatx80 );
    265 flag floatx80_lt_internal( floatx80, floatx80 );
    266 flag floatx80_eq_signaling_internal( floatx80, floatx80 );
    267 flag floatx80_le_quiet_internal( floatx80, floatx80 );
    268 flag floatx80_lt_quiet_internal( floatx80, floatx80 );
    269 flag floatx80_eq( floatx80, floatx80 );
    270 flag floatx80_le( floatx80, floatx80 );
    271 flag floatx80_lt( floatx80, floatx80 );
    272 flag floatx80_eq_signaling( floatx80, floatx80 );
    273 flag floatx80_le_quiet( floatx80, floatx80 );
    274 flag floatx80_lt_quiet( floatx80, floatx80 );
    275 flag floatx80_is_signaling_nan( floatx80 );
    276 flag floatx80_is_nan( floatx80 );
    277 
    278 #endif
    279 
    280 #ifdef FLOAT128
    281 
    282 /*
    283 -------------------------------------------------------------------------------
    284 Software IEC/IEEE quadruple-precision conversion routines.
    285 -------------------------------------------------------------------------------
    286 */
    287 int float128_to_int32( float128 );
    288 int float128_to_int32_round_to_zero( float128 );
    289 long long float128_to_int64( float128 );
    290 long long float128_to_int64_round_to_zero( float128 );
    291 float32 float128_to_float32( float128 );
    292 float64 float128_to_float64( float128 );
    293 #ifdef FLOATX80
    294 floatx80 float128_to_floatx80( float128 );
    295 #endif
    296 
    297 /*
    298 -------------------------------------------------------------------------------
    299 Software IEC/IEEE quadruple-precision operations.
    300 -------------------------------------------------------------------------------
    301 */
    302 float128 float128_round_to_int( float128 );
    303 float128 float128_add( float128, float128 );
    304 float128 float128_sub( float128, float128 );
    305 float128 float128_mul( float128, float128 );
    306 float128 float128_div( float128, float128 );
    307 float128 float128_rem( float128, float128 );
    308 float128 float128_sqrt( float128 );
    309 flag float128_eq( float128, float128 );
    310 flag float128_le( float128, float128 );
    311 flag float128_lt( float128, float128 );
    312 flag float128_eq_signaling( float128, float128 );
    313 flag float128_le_quiet( float128, float128 );
    314 flag float128_lt_quiet( float128, float128 );
    315 flag float128_is_signaling_nan( float128 );
    316 
    317 #endif
    318