541 lines · c
1/*2 * Copyright 2012-15 Advanced Micro Devices, Inc.3 *4 * Permission is hereby granted, free of charge, to any person obtaining a5 * copy of this software and associated documentation files (the "Software"),6 * to deal in the Software without restriction, including without limitation7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,8 * and/or sell copies of the Software, and to permit persons to whom the9 * Software is furnished to do so, subject to the following conditions:10 *11 * The above copyright notice and this permission notice shall be included in12 * all copies or substantial portions of the Software.13 *14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR20 * OTHER DEALINGS IN THE SOFTWARE.21 *22 * Authors: AMD23 *24 */25 26#ifndef __DAL_FIXED31_32_H__27#define __DAL_FIXED31_32_H__28 29#ifndef LLONG_MAX30#define LLONG_MAX 9223372036854775807ll31#endif32#ifndef LLONG_MIN33#define LLONG_MIN (-LLONG_MAX - 1ll)34#endif35 36#define FIXED31_32_BITS_PER_FRACTIONAL_PART 3237#ifndef LLONG_MIN38#define LLONG_MIN (1LL<<63)39#endif40#ifndef LLONG_MAX41#define LLONG_MAX (-1LL>>1)42#endif43 44/*45 * @brief46 * Arithmetic operations on real numbers47 * represented as fixed-point numbers.48 * There are: 1 bit for sign,49 * 31 bit for integer part,50 * 32 bits for fractional part.51 *52 * @note53 * Currently, overflows and underflows are asserted;54 * no special result returned.55 */56 57struct fixed31_32 {58 long long value;59};60 61 62/*63 * @brief64 * Useful constants65 */66 67static const struct fixed31_32 dc_fixpt_zero = { 0 };68static const struct fixed31_32 dc_fixpt_epsilon = { 1LL };69static const struct fixed31_32 dc_fixpt_half = { 0x80000000LL };70static const struct fixed31_32 dc_fixpt_one = { 0x100000000LL };71 72/*73 * @brief74 * Initialization routines75 */76 77/*78 * @brief79 * result = numerator / denominator80 */81struct fixed31_32 dc_fixpt_from_fraction(long long numerator, long long denominator);82 83/*84 * @brief85 * result = arg86 */87static inline struct fixed31_32 dc_fixpt_from_int(int arg)88{89 struct fixed31_32 res;90 91 res.value = (long long) arg << FIXED31_32_BITS_PER_FRACTIONAL_PART;92 93 return res;94}95 96/*97 * @brief98 * Unary operators99 */100 101/*102 * @brief103 * result = -arg104 */105static inline struct fixed31_32 dc_fixpt_neg(struct fixed31_32 arg)106{107 struct fixed31_32 res;108 109 res.value = -arg.value;110 111 return res;112}113 114/*115 * @brief116 * result = abs(arg) := (arg >= 0) ? arg : -arg117 */118static inline struct fixed31_32 dc_fixpt_abs(struct fixed31_32 arg)119{120 if (arg.value < 0)121 return dc_fixpt_neg(arg);122 else123 return arg;124}125 126/*127 * @brief128 * Binary relational operators129 */130 131/*132 * @brief133 * result = arg1 < arg2134 */135static inline bool dc_fixpt_lt(struct fixed31_32 arg1, struct fixed31_32 arg2)136{137 return arg1.value < arg2.value;138}139 140/*141 * @brief142 * result = arg1 <= arg2143 */144static inline bool dc_fixpt_le(struct fixed31_32 arg1, struct fixed31_32 arg2)145{146 return arg1.value <= arg2.value;147}148 149/*150 * @brief151 * result = arg1 == arg2152 */153static inline bool dc_fixpt_eq(struct fixed31_32 arg1, struct fixed31_32 arg2)154{155 return arg1.value == arg2.value;156}157 158/*159 * @brief160 * result = min(arg1, arg2) := (arg1 <= arg2) ? arg1 : arg2161 */162static inline struct fixed31_32 dc_fixpt_min(struct fixed31_32 arg1, struct fixed31_32 arg2)163{164 if (arg1.value <= arg2.value)165 return arg1;166 else167 return arg2;168}169 170/*171 * @brief172 * result = max(arg1, arg2) := (arg1 <= arg2) ? arg2 : arg1173 */174static inline struct fixed31_32 dc_fixpt_max(struct fixed31_32 arg1, struct fixed31_32 arg2)175{176 if (arg1.value <= arg2.value)177 return arg2;178 else179 return arg1;180}181 182/*183 * @brief184 * | min_value, when arg <= min_value185 * result = | arg, when min_value < arg < max_value186 * | max_value, when arg >= max_value187 */188static inline struct fixed31_32 dc_fixpt_clamp(189 struct fixed31_32 arg,190 struct fixed31_32 min_value,191 struct fixed31_32 max_value)192{193 if (dc_fixpt_le(arg, min_value))194 return min_value;195 else if (dc_fixpt_le(max_value, arg))196 return max_value;197 else198 return arg;199}200 201/*202 * @brief203 * Binary shift operators204 */205 206/*207 * @brief208 * result = arg << shift209 */210static inline struct fixed31_32 dc_fixpt_shl(struct fixed31_32 arg, unsigned char shift)211{212 ASSERT(((arg.value >= 0) && (arg.value <= LLONG_MAX >> shift)) ||213 ((arg.value < 0) && (arg.value >= ~(LLONG_MAX >> shift))));214 215 arg.value = arg.value << shift;216 217 return arg;218}219 220/*221 * @brief222 * result = arg >> shift223 */224static inline struct fixed31_32 dc_fixpt_shr(struct fixed31_32 arg, unsigned char shift)225{226 bool negative = arg.value < 0;227 228 if (negative)229 arg.value = -arg.value;230 arg.value = arg.value >> shift;231 if (negative)232 arg.value = -arg.value;233 return arg;234}235 236/*237 * @brief238 * Binary additive operators239 */240 241/*242 * @brief243 * result = arg1 + arg2244 */245static inline struct fixed31_32 dc_fixpt_add(struct fixed31_32 arg1, struct fixed31_32 arg2)246{247 struct fixed31_32 res;248 249 ASSERT(((arg1.value >= 0) && (LLONG_MAX - arg1.value >= arg2.value)) ||250 ((arg1.value < 0) && (LLONG_MIN - arg1.value <= arg2.value)));251 252 res.value = arg1.value + arg2.value;253 254 return res;255}256 257/*258 * @brief259 * result = arg1 + arg2260 */261static inline struct fixed31_32 dc_fixpt_add_int(struct fixed31_32 arg1, int arg2)262{263 return dc_fixpt_add(arg1, dc_fixpt_from_int(arg2));264}265 266/*267 * @brief268 * result = arg1 - arg2269 */270static inline struct fixed31_32 dc_fixpt_sub(struct fixed31_32 arg1, struct fixed31_32 arg2)271{272 struct fixed31_32 res;273 274 ASSERT(((arg2.value >= 0) && (LLONG_MIN + arg2.value <= arg1.value)) ||275 ((arg2.value < 0) && (LLONG_MAX + arg2.value >= arg1.value)));276 277 res.value = arg1.value - arg2.value;278 279 return res;280}281 282/*283 * @brief284 * result = arg1 - arg2285 */286static inline struct fixed31_32 dc_fixpt_sub_int(struct fixed31_32 arg1, int arg2)287{288 return dc_fixpt_sub(arg1, dc_fixpt_from_int(arg2));289}290 291 292/*293 * @brief294 * Binary multiplicative operators295 */296 297/*298 * @brief299 * result = arg1 * arg2300 */301struct fixed31_32 dc_fixpt_mul(struct fixed31_32 arg1, struct fixed31_32 arg2);302 303 304/*305 * @brief306 * result = arg1 * arg2307 */308static inline struct fixed31_32 dc_fixpt_mul_int(struct fixed31_32 arg1, int arg2)309{310 return dc_fixpt_mul(arg1, dc_fixpt_from_int(arg2));311}312 313/*314 * @brief315 * result = square(arg) := arg * arg316 */317struct fixed31_32 dc_fixpt_sqr(struct fixed31_32 arg);318 319/*320 * @brief321 * result = arg1 / arg2322 */323static inline struct fixed31_32 dc_fixpt_div_int(struct fixed31_32 arg1, long long arg2)324{325 return dc_fixpt_from_fraction(arg1.value, dc_fixpt_from_int((int)arg2).value);326}327 328/*329 * @brief330 * result = arg1 / arg2331 */332static inline struct fixed31_32 dc_fixpt_div(struct fixed31_32 arg1, struct fixed31_32 arg2)333{334 return dc_fixpt_from_fraction(arg1.value, arg2.value);335}336 337/*338 * @brief339 * Reciprocal function340 */341 342/*343 * @brief344 * result = reciprocal(arg) := 1 / arg345 *346 * @note347 * No special actions taken in case argument is zero.348 */349struct fixed31_32 dc_fixpt_recip(struct fixed31_32 arg);350 351/*352 * @brief353 * Trigonometric functions354 */355 356/*357 * @brief358 * result = sinc(arg) := sin(arg) / arg359 *360 * @note361 * Argument specified in radians,362 * internally it's normalized to [-2pi...2pi] range.363 */364struct fixed31_32 dc_fixpt_sinc(struct fixed31_32 arg);365 366/*367 * @brief368 * result = sin(arg)369 *370 * @note371 * Argument specified in radians,372 * internally it's normalized to [-2pi...2pi] range.373 */374struct fixed31_32 dc_fixpt_sin(struct fixed31_32 arg);375 376/*377 * @brief378 * result = cos(arg)379 *380 * @note381 * Argument specified in radians382 * and should be in [-2pi...2pi] range -383 * passing arguments outside that range384 * will cause incorrect result!385 */386struct fixed31_32 dc_fixpt_cos(struct fixed31_32 arg);387 388/*389 * @brief390 * Transcendent functions391 */392 393/*394 * @brief395 * result = exp(arg)396 *397 * @note398 * Currently, function is verified for abs(arg) <= 1.399 */400struct fixed31_32 dc_fixpt_exp(struct fixed31_32 arg);401 402/*403 * @brief404 * result = log(arg)405 *406 * @note407 * Currently, abs(arg) should be less than 1.408 * No normalization is done.409 * Currently, no special actions taken410 * in case of invalid argument(s). Take care!411 */412struct fixed31_32 dc_fixpt_log(struct fixed31_32 arg);413 414/*415 * @brief416 * Power function417 */418 419/*420 * @brief421 * result = pow(arg1, arg2)422 *423 * @note424 * Currently, abs(arg1) should be less than 1. Take care!425 */426static inline struct fixed31_32 dc_fixpt_pow(struct fixed31_32 arg1, struct fixed31_32 arg2)427{428 if (arg1.value == 0)429 return arg2.value == 0 ? dc_fixpt_one : dc_fixpt_zero;430 431 return dc_fixpt_exp(432 dc_fixpt_mul(433 dc_fixpt_log(arg1),434 arg2));435}436 437/*438 * @brief439 * Rounding functions440 */441 442/*443 * @brief444 * result = floor(arg) := greatest integer lower than or equal to arg445 */446static inline int dc_fixpt_floor(struct fixed31_32 arg)447{448 unsigned long long arg_value = arg.value > 0 ? arg.value : -arg.value;449 450 if (arg.value >= 0)451 return (int)(arg_value >> FIXED31_32_BITS_PER_FRACTIONAL_PART);452 else453 return -(int)(arg_value >> FIXED31_32_BITS_PER_FRACTIONAL_PART);454}455 456/*457 * @brief458 * result = round(arg) := integer nearest to arg459 */460static inline int dc_fixpt_round(struct fixed31_32 arg)461{462 unsigned long long arg_value = arg.value > 0 ? arg.value : -arg.value;463 464 const long long summand = dc_fixpt_half.value;465 466 ASSERT(LLONG_MAX - (long long)arg_value >= summand);467 468 arg_value += summand;469 470 if (arg.value >= 0)471 return (int)(arg_value >> FIXED31_32_BITS_PER_FRACTIONAL_PART);472 else473 return -(int)(arg_value >> FIXED31_32_BITS_PER_FRACTIONAL_PART);474}475 476/*477 * @brief478 * result = ceil(arg) := lowest integer greater than or equal to arg479 */480static inline int dc_fixpt_ceil(struct fixed31_32 arg)481{482 unsigned long long arg_value = arg.value > 0 ? arg.value : -arg.value;483 484 const long long summand = dc_fixpt_one.value -485 dc_fixpt_epsilon.value;486 487 ASSERT(LLONG_MAX - (long long)arg_value >= summand);488 489 arg_value += summand;490 491 if (arg.value >= 0)492 return (int)(arg_value >> FIXED31_32_BITS_PER_FRACTIONAL_PART);493 else494 return -(int)(arg_value >> FIXED31_32_BITS_PER_FRACTIONAL_PART);495}496 497/* the following two function are used in scaler hw programming to convert fixed498 * point value to format 2 bits from integer part and 19 bits from fractional499 * part. The same applies for u0d19, 0 bits from integer part and 19 bits from500 * fractional501 */502 503unsigned int dc_fixpt_u4d19(struct fixed31_32 arg);504 505unsigned int dc_fixpt_u3d19(struct fixed31_32 arg);506 507unsigned int dc_fixpt_u2d19(struct fixed31_32 arg);508 509unsigned int dc_fixpt_u0d19(struct fixed31_32 arg);510 511unsigned int dc_fixpt_clamp_u0d14(struct fixed31_32 arg);512 513unsigned int dc_fixpt_clamp_u0d10(struct fixed31_32 arg);514 515int dc_fixpt_s4d19(struct fixed31_32 arg);516 517static inline struct fixed31_32 dc_fixpt_truncate(struct fixed31_32 arg, unsigned int frac_bits)518{519 bool negative = arg.value < 0;520 521 if (frac_bits >= FIXED31_32_BITS_PER_FRACTIONAL_PART) {522 ASSERT(frac_bits == FIXED31_32_BITS_PER_FRACTIONAL_PART);523 return arg;524 }525 526 if (negative)527 arg.value = -arg.value;528 arg.value &= (~0ULL) << (FIXED31_32_BITS_PER_FRACTIONAL_PART - frac_bits);529 if (negative)530 arg.value = -arg.value;531 return arg;532}533 534struct fixed31_32 dc_fixpt_from_ux_dy(unsigned int value, unsigned int integer_bits, unsigned int fractional_bits);535struct fixed31_32 dc_fixpt_from_int_dy(unsigned int int_value,536 unsigned int frac_value,537 unsigned int integer_bits,538 unsigned int fractional_bits);539 540#endif541