blob: 7335103b1b1521931535a4d27e6e4ade7cf02997 [file] [log] [blame]
Scott Brandenbf404c02017-04-10 11:45:52 -07001/*
Joel Hutton5cc3bc82018-03-21 11:40:57 +00002 * Copyright (c) 2016-2018, ARM Limited and Contributors. All rights reserved.
Scott Brandenbf404c02017-04-10 11:45:52 -07003 *
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
Yann Gautierc70fed52018-06-14 13:28:31 +020019#define BIT_32(nr) (U(1) << (nr))
20#define BIT_64(nr) (ULL(1) << (nr))
21
22#ifdef AARCH32
23#define BIT BIT_32
24#else
25#define BIT BIT_64
26#endif
Scott Brandenbf404c02017-04-10 11:45:52 -070027
Soby Mathew327548c2017-07-13 15:19:51 +010028/*
Yann Gautier953e94d2018-06-14 18:35:33 +020029 * Create a contiguous bitmask starting at bit position @l and ending at
30 * position @h. For example
31 * GENMASK_64(39, 21) gives us the 64bit vector 0x000000ffffe00000.
32 */
33#define GENMASK_32(h, l) \
34 (((~UINT32_C(0)) << (l)) & (~UINT32_C(0) >> (32 - 1 - (h))))
35
36#define GENMASK_64(h, l) \
37 (((~UINT64_C(0)) << (l)) & (~UINT64_C(0) >> (64 - 1 - (h))))
38
39#ifdef AARCH32
40#define GENMASK GENMASK_32
41#else
42#define GENMASK GENMASK_64
43#endif
44
45/*
Soby Mathew327548c2017-07-13 15:19:51 +010046 * This variant of div_round_up can be used in macro definition but should not
47 * be used in C code as the `div` parameter is evaluated twice.
48 */
49#define DIV_ROUND_UP_2EVAL(n, d) (((n) + (d) - 1) / (d))
50
Julius Werner54b6d202018-01-22 13:56:13 -080051#define div_round_up(val, div) __extension__ ({ \
52 __typeof__(div) _div = (div); \
53 ((val) + _div - 1) / _div; \
54})
55
Scott Brandenbf404c02017-04-10 11:45:52 -070056#define MIN(x, y) __extension__ ({ \
57 __typeof__(x) _x = (x); \
58 __typeof__(y) _y = (y); \
59 (void)(&_x == &_y); \
60 _x < _y ? _x : _y; \
61})
62
63#define MAX(x, y) __extension__ ({ \
64 __typeof__(x) _x = (x); \
65 __typeof__(y) _y = (y); \
66 (void)(&_x == &_y); \
67 _x > _y ? _x : _y; \
68})
69
70/*
71 * The round_up() macro rounds up a value to the given boundary in a
72 * type-agnostic yet type-safe manner. The boundary must be a power of two.
73 * In other words, it computes the smallest multiple of boundary which is
74 * greater than or equal to value.
75 *
76 * round_down() is similar but rounds the value down instead.
77 */
78#define round_boundary(value, boundary) \
79 ((__typeof__(value))((boundary) - 1))
80
81#define round_up(value, boundary) \
82 ((((value) - 1) | round_boundary(value, boundary)) + 1)
83
84#define round_down(value, boundary) \
85 ((value) & ~round_boundary(value, boundary))
86
87/*
88 * Evaluates to 1 if (ptr + inc) overflows, 0 otherwise.
89 * Both arguments must be unsigned pointer values (i.e. uintptr_t).
90 */
91#define check_uptr_overflow(ptr, inc) \
92 (((ptr) > UINTPTR_MAX - (inc)) ? 1 : 0)
93
94/*
Jeenu Viswambharan19f6cf22017-12-07 08:43:05 +000095 * Evaluates to 1 if (u32 + inc) overflows, 0 otherwise.
96 * Both arguments must be 32-bit unsigned integers (i.e. effectively uint32_t).
97 */
98#define check_u32_overflow(u32, inc) \
99 ((u32) > (UINT32_MAX - (inc)) ? 1 : 0)
100
101/*
Varun Wadekar05597a92017-05-18 10:32:51 -0700102 * For those constants to be shared between C and other sources, apply a 'u'
103 * or 'ull' suffix to the argument only in C, to avoid undefined or unintended
104 * behaviour.
Scott Brandenbf404c02017-04-10 11:45:52 -0700105 *
Varun Wadekar05597a92017-05-18 10:32:51 -0700106 * The GNU assembler and linker do not support the 'u' and 'ull' suffix (it
107 * causes the build process to fail) therefore the suffix is omitted when used
108 * in linker scripts and assembler files.
Scott Brandenbf404c02017-04-10 11:45:52 -0700109*/
110#if defined(__LINKER__) || defined(__ASSEMBLY__)
Varun Wadekar05597a92017-05-18 10:32:51 -0700111# define U(_x) (_x)
Scott Brandenbf404c02017-04-10 11:45:52 -0700112# define ULL(_x) (_x)
113#else
David Cunadoc1503122018-02-16 21:12:58 +0000114# define U(_x) (_x##U)
115# define ULL(_x) (_x##ULL)
Scott Brandenbf404c02017-04-10 11:45:52 -0700116#endif
117
Julius Werner02eb7272017-12-12 14:23:26 -0800118/* Register size of the current architecture. */
119#ifdef AARCH32
120#define REGSZ U(4)
121#else
122#define REGSZ U(8)
123#endif
124
Jeenu Viswambharan0bc79d92017-08-16 11:44:25 +0100125/*
126 * Test for the current architecture version to be at least the version
127 * expected.
128 */
129#define ARM_ARCH_AT_LEAST(_maj, _min) \
130 ((ARM_ARCH_MAJOR > _maj) || \
131 ((ARM_ARCH_MAJOR == _maj) && (ARM_ARCH_MINOR >= _min)))
132
Joel Hutton5cc3bc82018-03-21 11:40:57 +0000133/*
134 * Import an assembly or linker symbol as a C expression with the specified
135 * type
136 */
137#define IMPORT_SYM(type, sym, name) \
138 extern char sym[];\
139 static const __attribute__((unused)) type name = (type) sym;
140
141/*
142 * When the symbol is used to hold a pointer, its alignment can be asserted
143 * with this macro. For example, if there is a linker symbol that is going to
144 * be used as a 64-bit pointer, the value of the linker symbol must also be
145 * aligned to 64 bit. This macro makes sure this is the case.
146 */
147#define ASSERT_SYM_PTR_ALIGN(sym) assert(((size_t)(sym) % __alignof__(*(sym))) == 0)
148
149
Scott Brandenbf404c02017-04-10 11:45:52 -0700150#endif /* __UTILS_DEF_H__ */