fpu/softfloat.h

   1 /*============================================================================
   2
   3 This C header file is part of the SoftFloat IEC/IEEE Floating-point Arithmetic
   4 Package, Release 2b.
   5
   6 Written by John R. Hauser.  This work was made possible in part by the
   7 International Computer Science Institute, located at Suite 600, 1947 Center
   8 Street, Berkeley, California 94704.  Funding was partially provided by the
   9 National Science Foundation under grant MIP-9311980.  The original version
  10 of this code was written as part of a project to build a fixed-point vector
  11 processor in collaboration with the University of California at Berkeley,
  12 overseen by Profs. Nelson Morgan and John Wawrzynek.  More information
  13 is available through the Web page `http://www.cs.berkeley.edu/~jhauser/
  14 arithmetic/SoftFloat.html'.
  15
  16 THIS SOFTWARE IS DISTRIBUTED AS IS, FOR FREE.  Although reasonable effort has
  17 been made to avoid it, THIS SOFTWARE MAY CONTAIN FAULTS THAT WILL AT TIMES
  18 RESULT IN INCORRECT BEHAVIOR.  USE OF THIS SOFTWARE IS RESTRICTED TO PERSONS
  19 AND ORGANIZATIONS WHO CAN AND WILL TAKE FULL RESPONSIBILITY FOR ALL LOSSES,
  20 COSTS, OR OTHER PROBLEMS THEY INCUR DUE TO THE SOFTWARE, AND WHO FURTHERMORE
  21 EFFECTIVELY INDEMNIFY JOHN HAUSER AND THE INTERNATIONAL COMPUTER SCIENCE
  22 INSTITUTE (possibly via similar legal warning) AGAINST ALL LOSSES, COSTS, OR
  23 OTHER PROBLEMS INCURRED BY THEIR CUSTOMERS AND CLIENTS DUE TO THE SOFTWARE.
  24
  25 Derivative works are acceptable, even for commercial purposes, so long as
  26 (1) the source code for the derivative work includes prominent notice that
  27 the work is derivative, and (2) the source code includes prominent notice with
  28 these four paragraphs for those parts of this code that are retained.
  29
  30 =============================================================================*/
  31
  32 #ifndef SOFTFLOAT_H
  33 #define SOFTFLOAT_H
  34
  35 #include <inttypes.h>
  36 #include "config.h"
  37
  38 /*----------------------------------------------------------------------------
  39 | Each of the following `typedef's defines the most convenient type that holds
  40 | integers of at least as many bits as specified.  For example, `uint8' should
  41 | be the most convenient type that can hold unsigned integers of as many as
  42 | 8 bits.  The `flag' type must be able to hold either a 0 or 1.  For most
  43 | implementations of C, `flag', `uint8', and `int8' should all be `typedef'ed
  44 | to the same as `int'.
  45 *----------------------------------------------------------------------------*/
  46 typedef char flag;
  47 typedef uint8_t uint8;
  48 typedef int8_t int8;
  49 typedef int uint16;
  50 typedef int int16;
  51 typedef unsigned int uint32;
  52 typedef signed int int32;
  53 typedef uint64_t uint64;
  54 typedef int64_t int64;
  55
  56 /*----------------------------------------------------------------------------
  57 | Each of the following `typedef's defines a type that holds integers
  58 | of _exactly_ the number of bits specified.  For instance, for most
  59 | implementation of C, `bits16' and `sbits16' should be `typedef'ed to
  60 | `unsigned short int' and `signed short int' (or `short int'), respectively.
  61 *----------------------------------------------------------------------------*/
  62 typedef uint8_t bits8;
  63 typedef int8_t sbits8;
  64 typedef uint16_t bits16;
  65 typedef int16_t sbits16;
  66 typedef uint32_t bits32;
  67 typedef int32_t sbits32;
  68 typedef uint64_t bits64;
  69 typedef int64_t sbits64;
  70
  71 #define LIT64( a ) a##LL
  72 #define INLINE static inline
  73
  74 /*----------------------------------------------------------------------------
  75 | The macro `FLOATX80' must be defined to enable the extended double-precision
  76 | floating-point format `floatx80'.  If this macro is not defined, the
  77 | `floatx80' type will not be defined, and none of the functions that either
  78 | input or output the `floatx80' type will be defined.  The same applies to
  79 | the `FLOAT128' macro and the quadruple-precision format `float128'.
  80 *----------------------------------------------------------------------------*/
  81 #ifdef CONFIG_SOFTFLOAT
  82 /* bit exact soft float support */
  83 #define FLOATX80
  84 #define FLOAT128
  85 #else
  86 /* native float support */
  87 #if (defined(__i386__) || defined(__x86_64__)) && !defined(_BSD)
  88 #define FLOATX80
  89 #endif
  90 #endif /* !CONFIG_SOFTFLOAT */
  91
  92 #define STATUS_PARAM , float_status *status
  93 #define STATUS(field) status->field
  94 #define STATUS_VAR , status
  95
  96 #ifdef CONFIG_SOFTFLOAT
  97 /*----------------------------------------------------------------------------
  98 | Software IEC/IEEE floating-point types.
  99 *----------------------------------------------------------------------------*/
 100 typedef uint32_t float32;
 101 typedef uint64_t float64;
 102 #ifdef FLOATX80
 103 typedef struct {
 104     uint64_t low;
 105     uint16_t high;
 106 } floatx80;
 107 #endif
 108 #ifdef FLOAT128
 109 typedef struct {
 110 #ifdef WORDS_BIGENDIAN
 111     uint64_t high, low;
 112 #else
 113     uint64_t low, high;
 114 #endif
 115 } float128;
 116 #endif
 117
 118 /*----------------------------------------------------------------------------
 119 | Software IEC/IEEE floating-point underflow tininess-detection mode.
 120 *----------------------------------------------------------------------------*/
 121 enum {
 122     float_tininess_after_rounding  = 0,
 123     float_tininess_before_rounding = 1
 124 };
 125
 126 /*----------------------------------------------------------------------------
 127 | Software IEC/IEEE floating-point rounding mode.
 128 *----------------------------------------------------------------------------*/
 129 enum {
 130     float_round_nearest_even = 0,
 131     float_round_down         = 1,
 132     float_round_up           = 2,
 133     float_round_to_zero      = 3
 134 };
 135
 136 /*----------------------------------------------------------------------------
 137 | Software IEC/IEEE floating-point exception flags.
 138 *----------------------------------------------------------------------------*/
 139 enum {
 140     float_flag_invalid   =  1,
 141     float_flag_divbyzero =  4,
 142     float_flag_overflow  =  8,
 143     float_flag_underflow = 16,
 144     float_flag_inexact   = 32
 145 };
 146
 147 typedef struct float_status {
 148     signed char float_detect_tininess;
 149     signed char float_rounding_mode;
 150     signed char float_exception_flags;
 151 #ifdef FLOATX80
 152     signed char floatx80_rounding_precision;
 153 #endif
 154 } float_status;
 155
 156 void set_float_rounding_mode(int val STATUS_PARAM);
 157 #ifdef FLOATX80
 158 void set_floatx80_rounding_precision(int val STATUS_PARAM);
 159 #endif
 160
 161 /*----------------------------------------------------------------------------
 162 | Routine to raise any or all of the software IEC/IEEE floating-point
 163 | exception flags.
 164 *----------------------------------------------------------------------------*/
 165 void float_raise( signed char STATUS_PARAM);
 166
 167 /*----------------------------------------------------------------------------
 168 | Software IEC/IEEE integer-to-floating-point conversion routines.
 169 *----------------------------------------------------------------------------*/
 170 float32 int32_to_float32( int STATUS_PARAM );
 171 float64 int32_to_float64( int STATUS_PARAM );
 172 #ifdef FLOATX80
 173 floatx80 int32_to_floatx80( int STATUS_PARAM );
 174 #endif
 175 #ifdef FLOAT128
 176 float128 int32_to_float128( int STATUS_PARAM );
 177 #endif
 178 float32 int64_to_float32( int64_t STATUS_PARAM );
 179 float64 int64_to_float64( int64_t STATUS_PARAM );
 180 #ifdef FLOATX80
 181 floatx80 int64_to_floatx80( int64_t STATUS_PARAM );
 182 #endif
 183 #ifdef FLOAT128
 184 float128 int64_to_float128( int64_t STATUS_PARAM );
 185 #endif
 186
 187 /*----------------------------------------------------------------------------
 188 | Software IEC/IEEE single-precision conversion routines.
 189 *----------------------------------------------------------------------------*/
 190 int float32_to_int32( float32 STATUS_PARAM );
 191 int float32_to_int32_round_to_zero( float32 STATUS_PARAM );
 192 int64_t float32_to_int64( float32 STATUS_PARAM );
 193 int64_t float32_to_int64_round_to_zero( float32 STATUS_PARAM );
 194 float64 float32_to_float64( float32 STATUS_PARAM );
 195 #ifdef FLOATX80
 196 floatx80 float32_to_floatx80( float32 STATUS_PARAM );
 197 #endif
 198 #ifdef FLOAT128
 199 float128 float32_to_float128( float32 STATUS_PARAM );
 200 #endif
 201
 202 /*----------------------------------------------------------------------------
 203 | Software IEC/IEEE single-precision operations.
 204 *----------------------------------------------------------------------------*/
 205 float32 float32_round_to_int( float32 STATUS_PARAM );
 206 float32 float32_add( float32, float32 STATUS_PARAM );
 207 float32 float32_sub( float32, float32 STATUS_PARAM );
 208 float32 float32_mul( float32, float32 STATUS_PARAM );
 209 float32 float32_div( float32, float32 STATUS_PARAM );
 210 float32 float32_rem( float32, float32 STATUS_PARAM );
 211 float32 float32_sqrt( float32 STATUS_PARAM );
 212 char float32_eq( float32, float32 STATUS_PARAM );
 213 char float32_le( float32, float32 STATUS_PARAM );
 214 char float32_lt( float32, float32 STATUS_PARAM );
 215 char float32_eq_signaling( float32, float32 STATUS_PARAM );
 216 char float32_le_quiet( float32, float32 STATUS_PARAM );
 217 char float32_lt_quiet( float32, float32 STATUS_PARAM );
 218 char float32_is_signaling_nan( float32 );
 219
 220 /*----------------------------------------------------------------------------
 221 | Software IEC/IEEE double-precision conversion routines.
 222 *----------------------------------------------------------------------------*/
 223 int float64_to_int32( float64 STATUS_PARAM );
 224 int float64_to_int32_round_to_zero( float64 STATUS_PARAM );
 225 int64_t float64_to_int64( float64 STATUS_PARAM );
 226 int64_t float64_to_int64_round_to_zero( float64 STATUS_PARAM );
 227 float32 float64_to_float32( float64 STATUS_PARAM );
 228 #ifdef FLOATX80
 229 floatx80 float64_to_floatx80( float64 STATUS_PARAM );
 230 #endif
 231 #ifdef FLOAT128
 232 float128 float64_to_float128( float64 STATUS_PARAM );
 233 #endif
 234
 235 /*----------------------------------------------------------------------------
 236 | Software IEC/IEEE double-precision operations.
 237 *----------------------------------------------------------------------------*/
 238 float64 float64_round_to_int( float64 STATUS_PARAM );
 239 float64 float64_add( float64, float64 STATUS_PARAM );
 240 float64 float64_sub( float64, float64 STATUS_PARAM );
 241 float64 float64_mul( float64, float64 STATUS_PARAM );
 242 float64 float64_div( float64, float64 STATUS_PARAM );
 243 float64 float64_rem( float64, float64 STATUS_PARAM );
 244 float64 float64_sqrt( float64 STATUS_PARAM );
 245 char float64_eq( float64, float64 STATUS_PARAM );
 246 char float64_le( float64, float64 STATUS_PARAM );
 247 char float64_lt( float64, float64 STATUS_PARAM );
 248 char float64_eq_signaling( float64, float64 STATUS_PARAM );
 249 char float64_le_quiet( float64, float64 STATUS_PARAM );
 250 char float64_lt_quiet( float64, float64 STATUS_PARAM );
 251 char float64_is_signaling_nan( float64 );
 252
 253 #ifdef FLOATX80
 254
 255 /*----------------------------------------------------------------------------
 256 | Software IEC/IEEE extended double-precision conversion routines.
 257 *----------------------------------------------------------------------------*/
 258 int floatx80_to_int32( floatx80 STATUS_PARAM );
 259 int floatx80_to_int32_round_to_zero( floatx80 STATUS_PARAM );
 260 int64_t floatx80_to_int64( floatx80 STATUS_PARAM );
 261 int64_t floatx80_to_int64_round_to_zero( floatx80 STATUS_PARAM );
 262 float32 floatx80_to_float32( floatx80 STATUS_PARAM );
 263 float64 floatx80_to_float64( floatx80 STATUS_PARAM );
 264 #ifdef FLOAT128
 265 float128 floatx80_to_float128( floatx80 STATUS_PARAM );
 266 #endif
 267
 268 /*----------------------------------------------------------------------------
 269 | Software IEC/IEEE extended double-precision operations.
 270 *----------------------------------------------------------------------------*/
 271 floatx80 floatx80_round_to_int( floatx80 STATUS_PARAM );
 272 floatx80 floatx80_add( floatx80, floatx80 STATUS_PARAM );
 273 floatx80 floatx80_sub( floatx80, floatx80 STATUS_PARAM );
 274 floatx80 floatx80_mul( floatx80, floatx80 STATUS_PARAM );
 275 floatx80 floatx80_div( floatx80, floatx80 STATUS_PARAM );
 276 floatx80 floatx80_rem( floatx80, floatx80 STATUS_PARAM );
 277 floatx80 floatx80_sqrt( floatx80 STATUS_PARAM );
 278 char floatx80_eq( floatx80, floatx80 STATUS_PARAM );
 279 char floatx80_le( floatx80, floatx80 STATUS_PARAM );
 280 char floatx80_lt( floatx80, floatx80 STATUS_PARAM );
 281 char floatx80_eq_signaling( floatx80, floatx80 STATUS_PARAM );
 282 char floatx80_le_quiet( floatx80, floatx80 STATUS_PARAM );
 283 char floatx80_lt_quiet( floatx80, floatx80 STATUS_PARAM );
 284 char floatx80_is_signaling_nan( floatx80 );
 285
 286 #endif
 287
 288 #ifdef FLOAT128
 289
 290 /*----------------------------------------------------------------------------
 291 | Software IEC/IEEE quadruple-precision conversion routines.
 292 *----------------------------------------------------------------------------*/
 293 int float128_to_int32( float128 STATUS_PARAM );
 294 int float128_to_int32_round_to_zero( float128 STATUS_PARAM );
 295 int64_t float128_to_int64( float128 STATUS_PARAM );
 296 int64_t float128_to_int64_round_to_zero( float128 STATUS_PARAM );
 297 float32 float128_to_float32( float128 STATUS_PARAM );
 298 float64 float128_to_float64( float128 STATUS_PARAM );
 299 #ifdef FLOATX80
 300 floatx80 float128_to_floatx80( float128 STATUS_PARAM );
 301 #endif
 302
 303 /*----------------------------------------------------------------------------
 304 | Software IEC/IEEE quadruple-precision operations.
 305 *----------------------------------------------------------------------------*/
 306 float128 float128_round_to_int( float128 STATUS_PARAM );
 307 float128 float128_add( float128, float128 STATUS_PARAM );
 308 float128 float128_sub( float128, float128 STATUS_PARAM );
 309 float128 float128_mul( float128, float128 STATUS_PARAM );
 310 float128 float128_div( float128, float128 STATUS_PARAM );
 311 float128 float128_rem( float128, float128 STATUS_PARAM );
 312 float128 float128_sqrt( float128 STATUS_PARAM );
 313 char float128_eq( float128, float128 STATUS_PARAM );
 314 char float128_le( float128, float128 STATUS_PARAM );
 315 char float128_lt( float128, float128 STATUS_PARAM );
 316 char float128_eq_signaling( float128, float128 STATUS_PARAM );
 317 char float128_le_quiet( float128, float128 STATUS_PARAM );
 318 char float128_lt_quiet( float128, float128 STATUS_PARAM );
 319 char float128_is_signaling_nan( float128 );
 320
 321 #endif
 322
 323 #else /* CONFIG_SOFTFLOAT */
 324
 325 #include "softfloat-native.h"
 326
 327 #endif /* !CONFIG_SOFTFLOAT */
 328
 329 #endif /* !SOFTFLOAT_H */