xref: /optee_os/lib/libutils/ext/include/util.h (revision 63988d7cb5d649265ec68a2887296e63503da579)
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 <stdint.h>
31 
32 #ifndef MAX
33 #define MAX(a, b) \
34 	(__extension__({ __typeof__(a) _a = (a); \
35 	   __typeof__(b) _b = (b); \
36 	 _a > _b ? _a : _b; }))
37 
38 #define MIN(a, b) \
39 	(__extension__({ __typeof__(a) _a = (a); \
40 	   __typeof__(b) _b = (b); \
41 	 _a < _b ? _a : _b; }))
42 #endif
43 
44 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
45 
46 /* Round up the even multiple of size, size has to be a multiple of 2 */
47 #define ROUNDUP(v, size) (((v) + ((__typeof__(v))(size) - 1)) & \
48 			  ~((__typeof__(v))(size) - 1))
49 
50 /* Round down the even multiple of size, size has to be a multiple of 2 */
51 #define ROUNDDOWN(v, size) ((v) & ~((__typeof__(v))(size) - 1))
52 
53 /* x has to be of an unsigned type */
54 #define IS_POWER_OF_TWO(x) (((x) != 0) && (((x) & (~(x) + 1)) == (x)))
55 
56 #define ALIGNMENT_IS_OK(p, type) \
57 	(((uintptr_t)(p) & (__alignof__(type) - 1)) == 0)
58 
59 #define TO_STR(x) _TO_STR(x)
60 #define _TO_STR(x) #x
61 
62 #define container_of(ptr, type, member) \
63 	(__extension__({ \
64 		const typeof(((type *)0)->member) *__ptr = (ptr); \
65 		(type *)((unsigned long)(__ptr) - offsetof(type, member)); \
66 	}))
67 
68 #define MEMBER_SIZE(type, member) sizeof(((type *)0)->member)
69 
70 #ifdef ASM
71 #define BIT32(nr)		(1 << (nr))
72 #define BIT64(nr)		(1 << (nr))
73 #define SHIFT_U32(v, shift)	((v) << (shift))
74 #define SHIFT_U64(v, shift)	((v) << (shift))
75 #else
76 #define BIT32(nr)		(UINT32_C(1) << (nr))
77 #define BIT64(nr)		(UINT64_C(1) << (nr))
78 #define SHIFT_U32(v, shift)	((uint32_t)(v) << (shift))
79 #define SHIFT_U64(v, shift)	((uint64_t)(v) << (shift))
80 #endif
81 #define BIT(nr)			BIT32(nr)
82 
83 /*
84  * Create a contiguous bitmask starting at bit position @l and ending at
85  * position @h. For example
86  * GENMASK_64(39, 21) gives us the 64bit vector 0x000000ffffe00000.
87  */
88 #define GENMASK_32(h, l) \
89 	(((~UINT32_C(0)) << (l)) & (~UINT32_C(0) >> (32 - 1 - (h))))
90 
91 #define GENMASK_64(h, l) \
92 	(((~UINT64_C(0)) << (l)) & (~UINT64_C(0) >> (64 - 1 - (h))))
93 
94 #endif /*UTIL_H*/
95