xref: /linux/arch/mips/math-emu/ieee754.h (revision 38db37ba)
1 /*
2  * MIPS floating point support
3  * Copyright (C) 1994-2000 Algorithmics Ltd.
4  *
5  *  This program is free software; you can distribute it and/or modify it
6  *  under the terms of the GNU General Public License (Version 2) as
7  *  published by the Free Software Foundation.
8  *
9  *  This program is distributed in the hope it will be useful, but WITHOUT
10  *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  *  for more details.
13  *
14  *  You should have received a copy of the GNU General Public License along
15  *  with this program; if not, write to the Free Software Foundation, Inc.,
16  *  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA.
17  *
18  *  Nov 7, 2000
19  *  Modification to allow integration with Linux kernel
20  *
21  *  Kevin D. Kissell, kevink@mips.com and Carsten Langgard, carstenl@mips.com
22  *  Copyright (C) 2000 MIPS Technologies, Inc. All rights reserved.
23  */
24 #ifndef __ARCH_MIPS_MATH_EMU_IEEE754_H
25 #define __ARCH_MIPS_MATH_EMU_IEEE754_H
26 
27 #include <linux/compiler.h>
28 #include <asm/byteorder.h>
29 #include <linux/kernel.h>
30 #include <linux/types.h>
31 #include <linux/sched.h>
32 #include <asm/bitfield.h>
33 
34 union ieee754dp {
35 	struct {
36 		__BITFIELD_FIELD(unsigned int sign:1,
37 		__BITFIELD_FIELD(unsigned int bexp:11,
38 		__BITFIELD_FIELD(u64 mant:52,
39 		;)))
40 	};
41 	u64 bits;
42 };
43 
44 union ieee754sp {
45 	struct {
46 		__BITFIELD_FIELD(unsigned sign:1,
47 		__BITFIELD_FIELD(unsigned bexp:8,
48 		__BITFIELD_FIELD(unsigned mant:23,
49 		;)))
50 	};
51 	u32 bits;
52 };
53 
54 /*
55  * single precision (often aka float)
56 */
57 int ieee754sp_class(union ieee754sp x);
58 
59 union ieee754sp ieee754sp_abs(union ieee754sp x);
60 union ieee754sp ieee754sp_neg(union ieee754sp x);
61 
62 union ieee754sp ieee754sp_add(union ieee754sp x, union ieee754sp y);
63 union ieee754sp ieee754sp_sub(union ieee754sp x, union ieee754sp y);
64 union ieee754sp ieee754sp_mul(union ieee754sp x, union ieee754sp y);
65 union ieee754sp ieee754sp_div(union ieee754sp x, union ieee754sp y);
66 
67 union ieee754sp ieee754sp_fint(int x);
68 union ieee754sp ieee754sp_flong(s64 x);
69 union ieee754sp ieee754sp_fdp(union ieee754dp x);
70 
71 int ieee754sp_tint(union ieee754sp x);
72 s64 ieee754sp_tlong(union ieee754sp x);
73 
74 int ieee754sp_cmp(union ieee754sp x, union ieee754sp y, int cop, int sig);
75 
76 union ieee754sp ieee754sp_sqrt(union ieee754sp x);
77 
78 union ieee754sp ieee754sp_maddf(union ieee754sp z, union ieee754sp x,
79 				union ieee754sp y);
80 union ieee754sp ieee754sp_msubf(union ieee754sp z, union ieee754sp x,
81 				union ieee754sp y);
82 int ieee754sp_2008class(union ieee754sp x);
83 
84 /*
85  * double precision (often aka double)
86 */
87 int ieee754dp_class(union ieee754dp x);
88 
89 union ieee754dp ieee754dp_add(union ieee754dp x, union ieee754dp y);
90 union ieee754dp ieee754dp_sub(union ieee754dp x, union ieee754dp y);
91 union ieee754dp ieee754dp_mul(union ieee754dp x, union ieee754dp y);
92 union ieee754dp ieee754dp_div(union ieee754dp x, union ieee754dp y);
93 
94 union ieee754dp ieee754dp_abs(union ieee754dp x);
95 union ieee754dp ieee754dp_neg(union ieee754dp x);
96 
97 union ieee754dp ieee754dp_fint(int x);
98 union ieee754dp ieee754dp_flong(s64 x);
99 union ieee754dp ieee754dp_fsp(union ieee754sp x);
100 
101 int ieee754dp_tint(union ieee754dp x);
102 s64 ieee754dp_tlong(union ieee754dp x);
103 
104 int ieee754dp_cmp(union ieee754dp x, union ieee754dp y, int cop, int sig);
105 
106 union ieee754dp ieee754dp_sqrt(union ieee754dp x);
107 
108 union ieee754dp ieee754dp_maddf(union ieee754dp z, union ieee754dp x,
109 				union ieee754dp y);
110 union ieee754dp ieee754dp_msubf(union ieee754dp z, union ieee754dp x,
111 				union ieee754dp y);
112 int ieee754dp_2008class(union ieee754dp x);
113 
114 
115 /* 5 types of floating point number
116 */
117 enum {
118 	IEEE754_CLASS_NORM	= 0x00,
119 	IEEE754_CLASS_ZERO	= 0x01,
120 	IEEE754_CLASS_DNORM	= 0x02,
121 	IEEE754_CLASS_INF	= 0x03,
122 	IEEE754_CLASS_SNAN	= 0x04,
123 	IEEE754_CLASS_QNAN	= 0x05,
124 };
125 
126 /* exception numbers */
127 #define IEEE754_INEXACT			0x01
128 #define IEEE754_UNDERFLOW		0x02
129 #define IEEE754_OVERFLOW		0x04
130 #define IEEE754_ZERO_DIVIDE		0x08
131 #define IEEE754_INVALID_OPERATION	0x10
132 
133 /* cmp operators
134 */
135 #define IEEE754_CLT	0x01
136 #define IEEE754_CEQ	0x02
137 #define IEEE754_CGT	0x04
138 #define IEEE754_CUN	0x08
139 
140 /*
141  * The control status register
142  */
143 struct _ieee754_csr {
144 	__BITFIELD_FIELD(unsigned fcc:7,	/* condition[7:1] */
145 	__BITFIELD_FIELD(unsigned nod:1,	/* set 1 for no denormals */
146 	__BITFIELD_FIELD(unsigned c:1,		/* condition[0] */
147 	__BITFIELD_FIELD(unsigned pad0:3,
148 	__BITFIELD_FIELD(unsigned abs2008:1,	/* IEEE 754-2008 ABS/NEG.fmt */
149 	__BITFIELD_FIELD(unsigned nan2008:1,	/* IEEE 754-2008 NaN mode */
150 	__BITFIELD_FIELD(unsigned cx:6,		/* exceptions this operation */
151 	__BITFIELD_FIELD(unsigned mx:5,		/* exception enable  mask */
152 	__BITFIELD_FIELD(unsigned sx:5,		/* exceptions total */
153 	__BITFIELD_FIELD(unsigned rm:2,		/* current rounding mode */
154 	;))))))))))
155 };
156 #define ieee754_csr (*(struct _ieee754_csr *)(&current->thread.fpu.fcr31))
157 
158 static inline unsigned ieee754_getrm(void)
159 {
160 	return (ieee754_csr.rm);
161 }
162 static inline unsigned ieee754_setrm(unsigned rm)
163 {
164 	return (ieee754_csr.rm = rm);
165 }
166 
167 /*
168  * get current exceptions
169  */
170 static inline unsigned ieee754_getcx(void)
171 {
172 	return (ieee754_csr.cx);
173 }
174 
175 /* test for current exception condition
176  */
177 static inline int ieee754_cxtest(unsigned n)
178 {
179 	return (ieee754_csr.cx & n);
180 }
181 
182 /*
183  * get sticky exceptions
184  */
185 static inline unsigned ieee754_getsx(void)
186 {
187 	return (ieee754_csr.sx);
188 }
189 
190 /* clear sticky conditions
191 */
192 static inline unsigned ieee754_clrsx(void)
193 {
194 	return (ieee754_csr.sx = 0);
195 }
196 
197 /* test for sticky exception condition
198  */
199 static inline int ieee754_sxtest(unsigned n)
200 {
201 	return (ieee754_csr.sx & n);
202 }
203 
204 /* debugging */
205 union ieee754sp ieee754sp_dump(char *s, union ieee754sp x);
206 union ieee754dp ieee754dp_dump(char *s, union ieee754dp x);
207 
208 #define IEEE754_SPCVAL_PZERO		0	/* +0.0 */
209 #define IEEE754_SPCVAL_NZERO		1	/* -0.0 */
210 #define IEEE754_SPCVAL_PONE		2	/* +1.0 */
211 #define IEEE754_SPCVAL_NONE		3	/* -1.0 */
212 #define IEEE754_SPCVAL_PTEN		4	/* +10.0 */
213 #define IEEE754_SPCVAL_NTEN		5	/* -10.0 */
214 #define IEEE754_SPCVAL_PINFINITY	6	/* +inf */
215 #define IEEE754_SPCVAL_NINFINITY	7	/* -inf */
216 #define IEEE754_SPCVAL_INDEF		8	/* quiet NaN */
217 #define IEEE754_SPCVAL_PMAX		9	/* +max norm */
218 #define IEEE754_SPCVAL_NMAX		10	/* -max norm */
219 #define IEEE754_SPCVAL_PMIN		11	/* +min norm */
220 #define IEEE754_SPCVAL_NMIN		12	/* -min norm */
221 #define IEEE754_SPCVAL_PMIND		13	/* +min denorm */
222 #define IEEE754_SPCVAL_NMIND		14	/* -min denorm */
223 #define IEEE754_SPCVAL_P1E31		15	/* + 1.0e31 */
224 #define IEEE754_SPCVAL_P1E63		16	/* + 1.0e63 */
225 
226 extern const union ieee754dp __ieee754dp_spcvals[];
227 extern const union ieee754sp __ieee754sp_spcvals[];
228 #define ieee754dp_spcvals ((const union ieee754dp *)__ieee754dp_spcvals)
229 #define ieee754sp_spcvals ((const union ieee754sp *)__ieee754sp_spcvals)
230 
231 /*
232  * Return infinity with given sign
233  */
234 #define ieee754dp_inf(sn)     (ieee754dp_spcvals[IEEE754_SPCVAL_PINFINITY+(sn)])
235 #define ieee754dp_zero(sn)	(ieee754dp_spcvals[IEEE754_SPCVAL_PZERO+(sn)])
236 #define ieee754dp_one(sn)	(ieee754dp_spcvals[IEEE754_SPCVAL_PONE+(sn)])
237 #define ieee754dp_ten(sn)	(ieee754dp_spcvals[IEEE754_SPCVAL_PTEN+(sn)])
238 #define ieee754dp_indef()	(ieee754dp_spcvals[IEEE754_SPCVAL_INDEF])
239 #define ieee754dp_max(sn)	(ieee754dp_spcvals[IEEE754_SPCVAL_PMAX+(sn)])
240 #define ieee754dp_min(sn)	(ieee754dp_spcvals[IEEE754_SPCVAL_PMIN+(sn)])
241 #define ieee754dp_mind(sn)	(ieee754dp_spcvals[IEEE754_SPCVAL_PMIND+(sn)])
242 #define ieee754dp_1e31()	(ieee754dp_spcvals[IEEE754_SPCVAL_P1E31])
243 #define ieee754dp_1e63()	(ieee754dp_spcvals[IEEE754_SPCVAL_P1E63])
244 
245 #define ieee754sp_inf(sn)     (ieee754sp_spcvals[IEEE754_SPCVAL_PINFINITY+(sn)])
246 #define ieee754sp_zero(sn)	(ieee754sp_spcvals[IEEE754_SPCVAL_PZERO+(sn)])
247 #define ieee754sp_one(sn)	(ieee754sp_spcvals[IEEE754_SPCVAL_PONE+(sn)])
248 #define ieee754sp_ten(sn)	(ieee754sp_spcvals[IEEE754_SPCVAL_PTEN+(sn)])
249 #define ieee754sp_indef()	(ieee754sp_spcvals[IEEE754_SPCVAL_INDEF])
250 #define ieee754sp_max(sn)	(ieee754sp_spcvals[IEEE754_SPCVAL_PMAX+(sn)])
251 #define ieee754sp_min(sn)	(ieee754sp_spcvals[IEEE754_SPCVAL_PMIN+(sn)])
252 #define ieee754sp_mind(sn)	(ieee754sp_spcvals[IEEE754_SPCVAL_PMIND+(sn)])
253 #define ieee754sp_1e31()	(ieee754sp_spcvals[IEEE754_SPCVAL_P1E31])
254 #define ieee754sp_1e63()	(ieee754sp_spcvals[IEEE754_SPCVAL_P1E63])
255 
256 /*
257  * Indefinite integer value
258  */
259 static inline int ieee754si_indef(void)
260 {
261 	return INT_MAX;
262 }
263 
264 static inline s64 ieee754di_indef(void)
265 {
266 	return S64_MAX;
267 }
268 
269 /* result types for xctx.rt */
270 #define IEEE754_RT_SP	0
271 #define IEEE754_RT_DP	1
272 #define IEEE754_RT_XP	2
273 #define IEEE754_RT_SI	3
274 #define IEEE754_RT_DI	4
275 
276 /* compat */
277 #define ieee754dp_fix(x)	ieee754dp_tint(x)
278 #define ieee754sp_fix(x)	ieee754sp_tint(x)
279 
280 #endif /* __ARCH_MIPS_MATH_EMU_IEEE754_H */
281