blob: 4a5c3e0bc1327709309ef281e867b6b4796e4887 [file] [log] [blame]
Scott Brandenbf404c02017-04-10 11:45:52 -07001/*
2 * Copyright (c) 2016-2017, ARM Limited and Contributors. All rights reserved.
3 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Scott Brandenbf404c02017-04-10 11:45:52 -07005 */
6
7#ifndef __UTILS_DEF_H__
8#define __UTILS_DEF_H__
9
10/* Compute the number of elements in the given array */
11#define ARRAY_SIZE(a) \
12 (sizeof(a) / sizeof((a)[0]))
13
14#define IS_POWER_OF_TWO(x) \
15 (((x) & ((x) - 1)) == 0)
16
17#define SIZE_FROM_LOG2_WORDS(n) (4 << (n))
18
Julius Werner02eb7272017-12-12 14:23:26 -080019#define BIT(nr) (ULL(1) << (nr))
Scott Brandenbf404c02017-04-10 11:45:52 -070020
Soby Mathew327548c2017-07-13 15:19:51 +010021/*
22 * This variant of div_round_up can be used in macro definition but should not
23 * be used in C code as the `div` parameter is evaluated twice.
24 */
25#define DIV_ROUND_UP_2EVAL(n, d) (((n) + (d) - 1) / (d))
26
Julius Werner54b6d202018-01-22 13:56:13 -080027#define div_round_up(val, div) __extension__ ({ \
28 __typeof__(div) _div = (div); \
29 ((val) + _div - 1) / _div; \
30})
31
Scott Brandenbf404c02017-04-10 11:45:52 -070032#define MIN(x, y) __extension__ ({ \
33 __typeof__(x) _x = (x); \
34 __typeof__(y) _y = (y); \
35 (void)(&_x == &_y); \
36 _x < _y ? _x : _y; \
37})
38
39#define MAX(x, y) __extension__ ({ \
40 __typeof__(x) _x = (x); \
41 __typeof__(y) _y = (y); \
42 (void)(&_x == &_y); \
43 _x > _y ? _x : _y; \
44})
45
46/*
47 * The round_up() macro rounds up a value to the given boundary in a
48 * type-agnostic yet type-safe manner. The boundary must be a power of two.
49 * In other words, it computes the smallest multiple of boundary which is
50 * greater than or equal to value.
51 *
52 * round_down() is similar but rounds the value down instead.
53 */
54#define round_boundary(value, boundary) \
55 ((__typeof__(value))((boundary) - 1))
56
57#define round_up(value, boundary) \
58 ((((value) - 1) | round_boundary(value, boundary)) + 1)
59
60#define round_down(value, boundary) \
61 ((value) & ~round_boundary(value, boundary))
62
63/*
64 * Evaluates to 1 if (ptr + inc) overflows, 0 otherwise.
65 * Both arguments must be unsigned pointer values (i.e. uintptr_t).
66 */
67#define check_uptr_overflow(ptr, inc) \
68 (((ptr) > UINTPTR_MAX - (inc)) ? 1 : 0)
69
70/*
Varun Wadekar05597a92017-05-18 10:32:51 -070071 * For those constants to be shared between C and other sources, apply a 'u'
72 * or 'ull' suffix to the argument only in C, to avoid undefined or unintended
73 * behaviour.
Scott Brandenbf404c02017-04-10 11:45:52 -070074 *
Varun Wadekar05597a92017-05-18 10:32:51 -070075 * The GNU assembler and linker do not support the 'u' and 'ull' suffix (it
76 * causes the build process to fail) therefore the suffix is omitted when used
77 * in linker scripts and assembler files.
Scott Brandenbf404c02017-04-10 11:45:52 -070078*/
79#if defined(__LINKER__) || defined(__ASSEMBLY__)
Varun Wadekar05597a92017-05-18 10:32:51 -070080# define U(_x) (_x)
Scott Brandenbf404c02017-04-10 11:45:52 -070081# define ULL(_x) (_x)
82#else
David Cunadoc1503122018-02-16 21:12:58 +000083# define U(_x) (_x##U)
84# define ULL(_x) (_x##ULL)
Scott Brandenbf404c02017-04-10 11:45:52 -070085#endif
86
Julius Werner02eb7272017-12-12 14:23:26 -080087/* Register size of the current architecture. */
88#ifdef AARCH32
89#define REGSZ U(4)
90#else
91#define REGSZ U(8)
92#endif
93
Jeenu Viswambharan0bc79d92017-08-16 11:44:25 +010094/*
95 * Test for the current architecture version to be at least the version
96 * expected.
97 */
98#define ARM_ARCH_AT_LEAST(_maj, _min) \
99 ((ARM_ARCH_MAJOR > _maj) || \
100 ((ARM_ARCH_MAJOR == _maj) && (ARM_ARCH_MINOR >= _min)))
101
Scott Brandenbf404c02017-04-10 11:45:52 -0700102#endif /* __UTILS_DEF_H__ */