153d9c9c8SScott Branden /* 253d9c9c8SScott Branden * Copyright (c) 2016-2017, ARM Limited and Contributors. All rights reserved. 353d9c9c8SScott Branden * 482cb2c1aSdp-arm * SPDX-License-Identifier: BSD-3-Clause 553d9c9c8SScott Branden */ 653d9c9c8SScott Branden 753d9c9c8SScott Branden #ifndef __UTILS_DEF_H__ 853d9c9c8SScott Branden #define __UTILS_DEF_H__ 953d9c9c8SScott Branden 1053d9c9c8SScott Branden /* Compute the number of elements in the given array */ 1153d9c9c8SScott Branden #define ARRAY_SIZE(a) \ 1253d9c9c8SScott Branden (sizeof(a) / sizeof((a)[0])) 1353d9c9c8SScott Branden 1453d9c9c8SScott Branden #define IS_POWER_OF_TWO(x) \ 1553d9c9c8SScott Branden (((x) & ((x) - 1)) == 0) 1653d9c9c8SScott Branden 1753d9c9c8SScott Branden #define SIZE_FROM_LOG2_WORDS(n) (4 << (n)) 1853d9c9c8SScott Branden 19e47ac1fdSAntonio Nino Diaz #define BIT(nr) (1ULL << (nr)) 2053d9c9c8SScott Branden 21*ebf1ca10SSoby Mathew /* 22*ebf1ca10SSoby Mathew * This variant of div_round_up can be used in macro definition but should not 23*ebf1ca10SSoby Mathew * be used in C code as the `div` parameter is evaluated twice. 24*ebf1ca10SSoby Mathew */ 25*ebf1ca10SSoby Mathew #define DIV_ROUND_UP_2EVAL(n, d) (((n) + (d) - 1) / (d)) 26*ebf1ca10SSoby Mathew 2753d9c9c8SScott Branden #define MIN(x, y) __extension__ ({ \ 2853d9c9c8SScott Branden __typeof__(x) _x = (x); \ 2953d9c9c8SScott Branden __typeof__(y) _y = (y); \ 3053d9c9c8SScott Branden (void)(&_x == &_y); \ 3153d9c9c8SScott Branden _x < _y ? _x : _y; \ 3253d9c9c8SScott Branden }) 3353d9c9c8SScott Branden 3453d9c9c8SScott Branden #define MAX(x, y) __extension__ ({ \ 3553d9c9c8SScott Branden __typeof__(x) _x = (x); \ 3653d9c9c8SScott Branden __typeof__(y) _y = (y); \ 3753d9c9c8SScott Branden (void)(&_x == &_y); \ 3853d9c9c8SScott Branden _x > _y ? _x : _y; \ 3953d9c9c8SScott Branden }) 4053d9c9c8SScott Branden 4153d9c9c8SScott Branden /* 4253d9c9c8SScott Branden * The round_up() macro rounds up a value to the given boundary in a 4353d9c9c8SScott Branden * type-agnostic yet type-safe manner. The boundary must be a power of two. 4453d9c9c8SScott Branden * In other words, it computes the smallest multiple of boundary which is 4553d9c9c8SScott Branden * greater than or equal to value. 4653d9c9c8SScott Branden * 4753d9c9c8SScott Branden * round_down() is similar but rounds the value down instead. 4853d9c9c8SScott Branden */ 4953d9c9c8SScott Branden #define round_boundary(value, boundary) \ 5053d9c9c8SScott Branden ((__typeof__(value))((boundary) - 1)) 5153d9c9c8SScott Branden 5253d9c9c8SScott Branden #define round_up(value, boundary) \ 5353d9c9c8SScott Branden ((((value) - 1) | round_boundary(value, boundary)) + 1) 5453d9c9c8SScott Branden 5553d9c9c8SScott Branden #define round_down(value, boundary) \ 5653d9c9c8SScott Branden ((value) & ~round_boundary(value, boundary)) 5753d9c9c8SScott Branden 58*ebf1ca10SSoby Mathew #define div_round_up(val, div) __extension__ ({ \ 59*ebf1ca10SSoby Mathew __typeof__(div) _div = (div); \ 60*ebf1ca10SSoby Mathew round_up((val), _div)/_div; \ 61*ebf1ca10SSoby Mathew }) 62*ebf1ca10SSoby Mathew 6353d9c9c8SScott Branden /* 6453d9c9c8SScott Branden * Evaluates to 1 if (ptr + inc) overflows, 0 otherwise. 6553d9c9c8SScott Branden * Both arguments must be unsigned pointer values (i.e. uintptr_t). 6653d9c9c8SScott Branden */ 6753d9c9c8SScott Branden #define check_uptr_overflow(ptr, inc) \ 6853d9c9c8SScott Branden (((ptr) > UINTPTR_MAX - (inc)) ? 1 : 0) 6953d9c9c8SScott Branden 7053d9c9c8SScott Branden /* 716176b4fcSVarun Wadekar * For those constants to be shared between C and other sources, apply a 'u' 726176b4fcSVarun Wadekar * or 'ull' suffix to the argument only in C, to avoid undefined or unintended 736176b4fcSVarun Wadekar * behaviour. 7453d9c9c8SScott Branden * 756176b4fcSVarun Wadekar * The GNU assembler and linker do not support the 'u' and 'ull' suffix (it 766176b4fcSVarun Wadekar * causes the build process to fail) therefore the suffix is omitted when used 776176b4fcSVarun Wadekar * in linker scripts and assembler files. 7853d9c9c8SScott Branden */ 7953d9c9c8SScott Branden #if defined(__LINKER__) || defined(__ASSEMBLY__) 806176b4fcSVarun Wadekar # define U(_x) (_x) 8153d9c9c8SScott Branden # define ULL(_x) (_x) 8253d9c9c8SScott Branden #else 836176b4fcSVarun Wadekar # define U(_x) (_x##u) 8453d9c9c8SScott Branden # define ULL(_x) (_x##ull) 8553d9c9c8SScott Branden #endif 8653d9c9c8SScott Branden 87f45e232aSJeenu Viswambharan /* 88f45e232aSJeenu Viswambharan * Test for the current architecture version to be at least the version 89f45e232aSJeenu Viswambharan * expected. 90f45e232aSJeenu Viswambharan */ 91f45e232aSJeenu Viswambharan #define ARM_ARCH_AT_LEAST(_maj, _min) \ 92f45e232aSJeenu Viswambharan ((ARM_ARCH_MAJOR > _maj) || \ 93f45e232aSJeenu Viswambharan ((ARM_ARCH_MAJOR == _maj) && (ARM_ARCH_MINOR >= _min))) 94f45e232aSJeenu Viswambharan 9553d9c9c8SScott Branden #endif /* __UTILS_DEF_H__ */ 96