1 /* SPDX-License-Identifier: BSD-2-Clause */ 2 /* 3 * Copyright (c) 2014, STMicroelectronics International N.V. 4 */ 5 #ifndef UTIL_H 6 #define UTIL_H 7 8 #include <compiler.h> 9 #include <inttypes.h> 10 11 #define SIZE_4K UINTPTR_C(0x1000) 12 #define SIZE_1M UINTPTR_C(0x100000) 13 #define SIZE_2M UINTPTR_C(0x200000) 14 #define SIZE_4M UINTPTR_C(0x400000) 15 #define SIZE_8M UINTPTR_C(0x800000) 16 #define SIZE_2G UINTPTR_C(0x80000000) 17 18 #ifndef MAX 19 #ifndef ASM 20 #define MAX(a, b) \ 21 (__extension__({ __typeof__(a) _a = (a); \ 22 __typeof__(b) _b = (b); \ 23 _a > _b ? _a : _b; })) 24 25 #define MIN(a, b) \ 26 (__extension__({ __typeof__(a) _a = (a); \ 27 __typeof__(b) _b = (b); \ 28 _a < _b ? _a : _b; })) 29 #else 30 #define MAX(a, b) (((a) > (b)) ? (a) : (b)) 31 #define MIN(a, b) (((a) < (b)) ? (a) : (b)) 32 #endif 33 #endif 34 35 /* 36 * In some particular conditions MAX and MIN macros fail to 37 * build from C source file implmentation. In such case one 38 * need to use MAX_UNSAFE/MIN_UNSAFE instead. 39 */ 40 #define MAX_UNSAFE(a, b) (((a) > (b)) ? (a) : (b)) 41 #define MIN_UNSAFE(a, b) (((a) < (b)) ? (a) : (b)) 42 43 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) 44 45 #ifndef ASM 46 /* Round up the even multiple of size, size has to be a multiple of 2 */ 47 #define ROUNDUP(v, size) (((v) + ((__typeof__(v))(size) - 1)) & \ 48 ~((__typeof__(v))(size) - 1)) 49 50 /* Round down the even multiple of size, size has to be a multiple of 2 */ 51 #define ROUNDDOWN(v, size) ((v) & ~((__typeof__(v))(size) - 1)) 52 53 /* Unsigned integer division with nearest rounding variant */ 54 #define UDIV_ROUND_NEAREST(x, y) \ 55 (__extension__ ({ __typeof__(x) _x = (x); \ 56 __typeof__(y) _y = (y); \ 57 (_x + (_y / 2)) / _y; })) 58 #else 59 #define ROUNDUP(x, y) ((((x) + (y) - 1) / (y)) * (y)) 60 #define ROUNDDOWN(x, y) (((x) / (y)) * (y)) 61 #define UDIV_ROUND_NEAREST(x, y) (((x) + ((y) / 2)) / (y)) 62 #endif 63 64 /* x has to be of an unsigned type */ 65 #define IS_POWER_OF_TWO(x) (((x) != 0) && (((x) & (~(x) + 1)) == (x))) 66 67 #define ALIGNMENT_IS_OK(p, type) \ 68 (((uintptr_t)(p) & (__alignof__(type) - 1)) == 0) 69 70 #define TO_STR(x) _TO_STR(x) 71 #define _TO_STR(x) #x 72 73 #define CONCAT(x, y) _CONCAT(x, y) 74 #define _CONCAT(x, y) x##y 75 76 #define container_of(ptr, type, member) \ 77 (__extension__({ \ 78 const typeof(((type *)0)->member) *__ptr = (ptr); \ 79 (type *)((unsigned long)(__ptr) - offsetof(type, member)); \ 80 })) 81 82 #define MEMBER_SIZE(type, member) sizeof(((type *)0)->member) 83 84 #ifdef ASM 85 #define BIT32(nr) (1 << (nr)) 86 #define BIT64(nr) (1 << (nr)) 87 #define SHIFT_U32(v, shift) ((v) << (shift)) 88 #define SHIFT_U64(v, shift) ((v) << (shift)) 89 #else 90 #define BIT32(nr) (UINT32_C(1) << (nr)) 91 #define BIT64(nr) (UINT64_C(1) << (nr)) 92 #define SHIFT_U32(v, shift) ((uint32_t)(v) << (shift)) 93 #define SHIFT_U64(v, shift) ((uint64_t)(v) << (shift)) 94 #endif 95 #define BIT(nr) BIT32(nr) 96 97 /* 98 * Create a contiguous bitmask starting at bit position @l and ending at 99 * position @h. For example 100 * GENMASK_64(39, 21) gives us the 64bit vector 0x000000ffffe00000. 101 */ 102 #define GENMASK_32(h, l) \ 103 (((~UINT32_C(0)) << (l)) & (~UINT32_C(0) >> (32 - 1 - (h)))) 104 105 #define GENMASK_64(h, l) \ 106 (((~UINT64_C(0)) << (l)) & (~UINT64_C(0) >> (64 - 1 - (h)))) 107 108 /* 109 * Checking overflow for addition, subtraction and multiplication. Result 110 * of operation is stored in res which is a pointer to some kind of 111 * integer. 112 * 113 * The macros return true if an overflow occurred and *res is undefined. 114 */ 115 #define ADD_OVERFLOW(a, b, res) __compiler_add_overflow((a), (b), (res)) 116 #define SUB_OVERFLOW(a, b, res) __compiler_sub_overflow((a), (b), (res)) 117 #define MUL_OVERFLOW(a, b, res) __compiler_mul_overflow((a), (b), (res)) 118 119 /* Return a signed +1, 0 or -1 value based on data comparison */ 120 #define CMP_TRILEAN(a, b) \ 121 (__extension__({ \ 122 __typeof__(a) _a = (a); \ 123 __typeof__(b) _b = (b); \ 124 \ 125 _a > _b ? 1 : _a < _b ? -1 : 0; \ 126 })) 127 128 #endif /*UTIL_H*/ 129