blob: b6bc9af678287f14e5441df64d6d9697545d6a55 [file] [log] [blame]
Sandrine Bailleux7659a262016-07-05 09:55:03 +01001/*
David Cunado2e36de82017-01-19 10:26:16 +00002 * Copyright (c) 2016-2017, ARM Limited and Contributors. All rights reserved.
Sandrine Bailleux7659a262016-07-05 09:55:03 +01003 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * Redistributions of source code must retain the above copyright notice, this
8 * list of conditions and the following disclaimer.
9 *
10 * Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 *
14 * Neither the name of ARM nor the names of its contributors may be used
15 * to endorse or promote products derived from this software without specific
16 * prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef __UTILS_H__
32#define __UTILS_H__
33
34/* Compute the number of elements in the given array */
35#define ARRAY_SIZE(a) \
36 (sizeof(a) / sizeof((a)[0]))
37
38#define IS_POWER_OF_TWO(x) \
39 (((x) & ((x) - 1)) == 0)
40
Soby Mathewc53ac5e2016-07-20 14:38:36 +010041#define SIZE_FROM_LOG2_WORDS(n) (4 << (n))
42
Masahiro Yamada73dfd2e2016-12-05 14:28:59 +090043#define BIT(nr) (1UL << (nr))
44
Sandrine Bailleux66552da2016-06-16 15:05:39 +010045/*
46 * The round_up() macro rounds up a value to the given boundary in a
47 * type-agnostic yet type-safe manner. The boundary must be a power of two.
48 * In other words, it computes the smallest multiple of boundary which is
49 * greater than or equal to value.
50 *
51 * round_down() is similar but rounds the value down instead.
52 */
53#define round_boundary(value, boundary) \
54 ((__typeof__(value))((boundary) - 1))
55
56#define round_up(value, boundary) \
57 ((((value) - 1) | round_boundary(value, boundary)) + 1)
58
59#define round_down(value, boundary) \
60 ((value) & ~round_boundary(value, boundary))
61
Sandrine Bailleux4ec7e2d2016-07-12 09:12:24 +010062/*
63 * Evaluates to 1 if (ptr + inc) overflows, 0 otherwise.
64 * Both arguments must be unsigned pointer values (i.e. uintptr_t).
65 */
66#define check_uptr_overflow(ptr, inc) \
67 (((ptr) > UINTPTR_MAX - (inc)) ? 1 : 0)
68
David Cunado2e36de82017-01-19 10:26:16 +000069/*
70 * For those constants to be shared between C and other sources, apply a 'ull'
71 * suffix to the argument only in C, to avoid undefined or unintended behaviour.
72 *
73 * The GNU assembler and linker do not support the 'ull' suffix (it causes the
74 * build process to fail) therefore the suffix is omitted when used in linker
75 * scripts and assembler files.
76*/
77#if defined(__LINKER__) || defined(__ASSEMBLY__)
78# define ULL(_x) (_x)
79#else
80# define ULL(_x) (_x##ull)
81#endif
82
Sandrine Bailleux7659a262016-07-05 09:55:03 +010083#endif /* __UTILS_H__ */