1 /* 2 * Copyright (c) 2016-2022, ARM Limited and Contributors. All rights reserved. 3 * Copyright (c) 2020, NVIDIA Corporation. All rights reserved. 4 * 5 * SPDX-License-Identifier: BSD-3-Clause 6 */ 7 8 #ifndef UTILS_DEF_H 9 #define UTILS_DEF_H 10 11 #include <export/lib/utils_def_exp.h> 12 13 /* Compute the number of elements in the given array */ 14 #define ARRAY_SIZE(a) \ 15 (sizeof(a) / sizeof((a)[0])) 16 17 #define IS_POWER_OF_TWO(x) \ 18 (((x) & ((x) - 1)) == 0) 19 20 #define SIZE_FROM_LOG2_WORDS(n) (U(4) << (n)) 21 22 #define BIT_32(nr) (U(1) << (nr)) 23 #define BIT_64(nr) (ULL(1) << (nr)) 24 25 #ifdef __aarch64__ 26 #define BIT BIT_64 27 #else 28 #define BIT BIT_32 29 #endif 30 31 /* 32 * Create a contiguous bitmask starting at bit position @l and ending at 33 * position @h. For example 34 * GENMASK_64(39, 21) gives us the 64bit vector 0x000000ffffe00000. 35 */ 36 #if defined(__LINKER__) || defined(__ASSEMBLER__) 37 #define GENMASK_32(h, l) \ 38 (((0xFFFFFFFF) << (l)) & (0xFFFFFFFF >> (32 - 1 - (h)))) 39 40 #define GENMASK_64(h, l) \ 41 ((~0 << (l)) & (~0 >> (64 - 1 - (h)))) 42 #else 43 #define GENMASK_32(h, l) \ 44 (((~UINT32_C(0)) << (l)) & (~UINT32_C(0) >> (32 - 1 - (h)))) 45 46 #define GENMASK_64(h, l) \ 47 (((~UINT64_C(0)) << (l)) & (~UINT64_C(0) >> (64 - 1 - (h)))) 48 #endif 49 50 #ifdef __aarch64__ 51 #define GENMASK GENMASK_64 52 #else 53 #define GENMASK GENMASK_32 54 #endif 55 56 /* 57 * This variant of div_round_up can be used in macro definition but should not 58 * be used in C code as the `div` parameter is evaluated twice. 59 */ 60 #define DIV_ROUND_UP_2EVAL(n, d) (((n) + (d) - 1) / (d)) 61 62 #define div_round_up(val, div) __extension__ ({ \ 63 __typeof__(div) _div = (div); \ 64 ((val) + _div - (__typeof__(div)) 1) / _div; \ 65 }) 66 67 #define MIN(x, y) __extension__ ({ \ 68 __typeof__(x) _x = (x); \ 69 __typeof__(y) _y = (y); \ 70 (void)(&_x == &_y); \ 71 _x < _y ? _x : _y; \ 72 }) 73 74 #define MAX(x, y) __extension__ ({ \ 75 __typeof__(x) _x = (x); \ 76 __typeof__(y) _y = (y); \ 77 (void)(&_x == &_y); \ 78 _x > _y ? _x : _y; \ 79 }) 80 81 #define CLAMP(x, min, max) __extension__ ({ \ 82 __typeof__(x) _x = (x); \ 83 __typeof__(min) _min = (min); \ 84 __typeof__(max) _max = (max); \ 85 (void)(&_x == &_min); \ 86 (void)(&_x == &_max); \ 87 (_x > _max ? _max : (_x < _min ? _min : _x)); \ 88 }) 89 90 /* 91 * The round_up() macro rounds up a value to the given boundary in a 92 * type-agnostic yet type-safe manner. The boundary must be a power of two. 93 * In other words, it computes the smallest multiple of boundary which is 94 * greater than or equal to value. 95 * 96 * round_down() is similar but rounds the value down instead. 97 */ 98 #define round_boundary(value, boundary) \ 99 ((__typeof__(value))((boundary) - 1)) 100 101 #define round_up(value, boundary) \ 102 ((((value) - 1) | round_boundary(value, boundary)) + 1) 103 104 #define round_down(value, boundary) \ 105 ((value) & ~round_boundary(value, boundary)) 106 107 /** 108 * Helper macro to ensure a value lies on a given boundary. 109 */ 110 #define is_aligned(value, boundary) \ 111 (round_up((uintptr_t) value, boundary) == \ 112 round_down((uintptr_t) value, boundary)) 113 114 /* 115 * Evaluates to 1 if (ptr + inc) overflows, 0 otherwise. 116 * Both arguments must be unsigned pointer values (i.e. uintptr_t). 117 */ 118 #define check_uptr_overflow(_ptr, _inc) \ 119 ((_ptr) > (UINTPTR_MAX - (_inc))) 120 121 /* 122 * Evaluates to 1 if (u32 + inc) overflows, 0 otherwise. 123 * Both arguments must be 32-bit unsigned integers (i.e. effectively uint32_t). 124 */ 125 #define check_u32_overflow(_u32, _inc) \ 126 ((_u32) > (UINT32_MAX - (_inc))) 127 128 /* Register size of the current architecture. */ 129 #ifdef __aarch64__ 130 #define REGSZ U(8) 131 #else 132 #define REGSZ U(4) 133 #endif 134 135 /* 136 * Test for the current architecture version to be at least the version 137 * expected. 138 */ 139 #define ARM_ARCH_AT_LEAST(_maj, _min) \ 140 ((ARM_ARCH_MAJOR > (_maj)) || \ 141 ((ARM_ARCH_MAJOR == (_maj)) && (ARM_ARCH_MINOR >= (_min)))) 142 143 /* 144 * Import an assembly or linker symbol as a C expression with the specified 145 * type 146 */ 147 #define IMPORT_SYM(type, sym, name) \ 148 extern char sym[];\ 149 static const __attribute__((unused)) type name = (type) sym; 150 151 /* 152 * When the symbol is used to hold a pointer, its alignment can be asserted 153 * with this macro. For example, if there is a linker symbol that is going to 154 * be used as a 64-bit pointer, the value of the linker symbol must also be 155 * aligned to 64 bit. This macro makes sure this is the case. 156 */ 157 #define ASSERT_SYM_PTR_ALIGN(sym) assert(((size_t)(sym) % __alignof__(*(sym))) == 0) 158 159 #define COMPILER_BARRIER() __asm__ volatile ("" ::: "memory") 160 161 /* Compiler builtin of GCC >= 9 and planned in llvm */ 162 #ifdef __HAVE_SPECULATION_SAFE_VALUE 163 # define SPECULATION_SAFE_VALUE(var) __builtin_speculation_safe_value(var) 164 #else 165 # define SPECULATION_SAFE_VALUE(var) var 166 #endif 167 168 /* 169 * Ticks elapsed in one second with a signal of 1 MHz 170 */ 171 #define MHZ_TICKS_PER_SEC U(1000000) 172 173 /* 174 * Ticks elapsed in one second with a signal of 1 KHz 175 */ 176 #define KHZ_TICKS_PER_SEC U(1000) 177 178 #endif /* UTILS_DEF_H */ 179