1 /* 2 * Copyright (c) 2014, STMicroelectronics International N.V. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright notice, 12 * this list of conditions and the following disclaimer in the documentation 13 * and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 25 * POSSIBILITY OF SUCH DAMAGE. 26 */ 27 #ifndef UTIL_H 28 #define UTIL_H 29 30 #include <compiler.h> 31 #include <stdint.h> 32 33 #define SIZE_4K UINTPTR_C(0x1000) 34 #define SIZE_1M UINTPTR_C(0x100000) 35 #define SIZE_2M UINTPTR_C(0x200000) 36 #define SIZE_4M UINTPTR_C(0x400000) 37 #define SIZE_8M UINTPTR_C(0x800000) 38 #define SIZE_2G UINTPTR_C(0x80000000) 39 40 #ifndef MAX 41 #define MAX(a, b) \ 42 (__extension__({ __typeof__(a) _a = (a); \ 43 __typeof__(b) _b = (b); \ 44 _a > _b ? _a : _b; })) 45 46 #define MIN(a, b) \ 47 (__extension__({ __typeof__(a) _a = (a); \ 48 __typeof__(b) _b = (b); \ 49 _a < _b ? _a : _b; })) 50 #endif 51 52 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) 53 54 /* Round up the even multiple of size, size has to be a multiple of 2 */ 55 #define ROUNDUP(v, size) (((v) + ((__typeof__(v))(size) - 1)) & \ 56 ~((__typeof__(v))(size) - 1)) 57 58 /* Round down the even multiple of size, size has to be a multiple of 2 */ 59 #define ROUNDDOWN(v, size) ((v) & ~((__typeof__(v))(size) - 1)) 60 61 /* x has to be of an unsigned type */ 62 #define IS_POWER_OF_TWO(x) (((x) != 0) && (((x) & (~(x) + 1)) == (x))) 63 64 #define ALIGNMENT_IS_OK(p, type) \ 65 (((uintptr_t)(p) & (__alignof__(type) - 1)) == 0) 66 67 #define TO_STR(x) _TO_STR(x) 68 #define _TO_STR(x) #x 69 70 #define container_of(ptr, type, member) \ 71 (__extension__({ \ 72 const typeof(((type *)0)->member) *__ptr = (ptr); \ 73 (type *)((unsigned long)(__ptr) - offsetof(type, member)); \ 74 })) 75 76 #define MEMBER_SIZE(type, member) sizeof(((type *)0)->member) 77 78 #ifdef ASM 79 #define BIT32(nr) (1 << (nr)) 80 #define BIT64(nr) (1 << (nr)) 81 #define SHIFT_U32(v, shift) ((v) << (shift)) 82 #define SHIFT_U64(v, shift) ((v) << (shift)) 83 #else 84 #define BIT32(nr) (UINT32_C(1) << (nr)) 85 #define BIT64(nr) (UINT64_C(1) << (nr)) 86 #define SHIFT_U32(v, shift) ((uint32_t)(v) << (shift)) 87 #define SHIFT_U64(v, shift) ((uint64_t)(v) << (shift)) 88 #endif 89 #define BIT(nr) BIT32(nr) 90 91 /* 92 * Create a contiguous bitmask starting at bit position @l and ending at 93 * position @h. For example 94 * GENMASK_64(39, 21) gives us the 64bit vector 0x000000ffffe00000. 95 */ 96 #define GENMASK_32(h, l) \ 97 (((~UINT32_C(0)) << (l)) & (~UINT32_C(0) >> (32 - 1 - (h)))) 98 99 #define GENMASK_64(h, l) \ 100 (((~UINT64_C(0)) << (l)) & (~UINT64_C(0) >> (64 - 1 - (h)))) 101 102 /* 103 * Checking overflow for addition, subtraction and multiplication. Result 104 * of operation is stored in res which is a pointer to some kind of 105 * integer. 106 * 107 * The macros return true if an overflow occurred and *res is undefined. 108 */ 109 #define ADD_OVERFLOW(a, b, res) __compiler_add_overflow((a), (b), (res)) 110 #define SUB_OVERFLOW(a, b, res) __compiler_sub_overflow((a), (b), (res)) 111 #define MUL_OVERFLOW(a, b, res) __compiler_mul_overflow((a), (b), (res)) 112 113 /* Return a signed +1, 0 or -1 value based on data comparison */ 114 #define CMP_TRILEAN(a, b) \ 115 (__extension__({ \ 116 __typeof__(a) _a = (a); \ 117 __typeof__(b) _b = (b); \ 118 \ 119 _a > _b ? 1 : _a < _b ? -1 : 0; \ 120 })) 121 122 #endif /*UTIL_H*/ 123