/* SPDX-License-Identifier: BSD-2-Clause */
|
/*
|
* Copyright (c) 2014, STMicroelectronics International N.V.
|
*/
|
#ifndef UTIL_H
|
#define UTIL_H
|
|
#include <compiler.h>
|
#include <inttypes.h>
|
|
#define SIZE_4K UINTPTR_C(0x1000)
|
#define SIZE_1M UINTPTR_C(0x100000)
|
#define SIZE_2M UINTPTR_C(0x200000)
|
#define SIZE_4M UINTPTR_C(0x400000)
|
#define SIZE_8M UINTPTR_C(0x800000)
|
#define SIZE_2G UINTPTR_C(0x80000000)
|
|
#ifndef MAX
|
#ifndef __ASSEMBLER__
|
#define MAX(a, b) \
|
(__extension__({ __typeof__(a) _a = (a); \
|
__typeof__(b) _b = (b); \
|
_a > _b ? _a : _b; }))
|
|
#define MIN(a, b) \
|
(__extension__({ __typeof__(a) _a = (a); \
|
__typeof__(b) _b = (b); \
|
_a < _b ? _a : _b; }))
|
#else
|
#define MAX(a, b) (((a) > (b)) ? (a) : (b))
|
#define MIN(a, b) (((a) < (b)) ? (a) : (b))
|
#endif
|
#endif
|
|
/*
|
* In some particular conditions MAX and MIN macros fail to
|
* build from C source file implmentation. In such case one
|
* need to use MAX_UNSAFE/MIN_UNSAFE instead.
|
*/
|
#define MAX_UNSAFE(a, b) (((a) > (b)) ? (a) : (b))
|
#define MIN_UNSAFE(a, b) (((a) < (b)) ? (a) : (b))
|
|
#ifndef ARRAY_SIZE
|
#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
|
#endif
|
|
#ifndef __ASSEMBLER__
|
/* Round up the even multiple of size, size has to be a multiple of 2 */
|
#define ROUNDUP(v, size) (((v) + ((__typeof__(v))(size) - 1)) & \
|
~((__typeof__(v))(size) - 1))
|
|
#define ROUNDUP_OVERFLOW(v, size, res) (__extension__({ \
|
typeof(*(res)) __roundup_tmp = 0; \
|
typeof(v) __roundup_mask = (typeof(v))(size) - 1; \
|
\
|
ADD_OVERFLOW((v), __roundup_mask, &__roundup_tmp) ? 1 : \
|
(void)(*(res) = __roundup_tmp & ~__roundup_mask), 0; \
|
}))
|
|
/*
|
* Rounds up to the nearest multiple of y and then divides by y. Safe
|
* against overflow, y has to be a multiple of 2.
|
*
|
* This macro is intended to be used to convert from "number of bytes" to
|
* "number of pages" or similar units. Example:
|
* num_pages = ROUNDUP_DIV(num_bytes, SMALL_PAGE_SIZE);
|
*/
|
#define ROUNDUP_DIV(x, y) (__extension__({ \
|
typeof(x) __roundup_x = (x); \
|
typeof(y) __roundup_mask = (typeof(x))(y) - 1; \
|
\
|
(__roundup_x / (y)) + (__roundup_x & __roundup_mask ? 1 : 0); \
|
}))
|
|
/* Round down the even multiple of size, size has to be a multiple of 2 */
|
#define ROUNDDOWN(v, size) ((v) & ~((__typeof__(v))(size) - 1))
|
|
/* Unsigned integer division with nearest rounding variant */
|
#define UDIV_ROUND_NEAREST(x, y) \
|
(__extension__ ({ __typeof__(x) _x = (x); \
|
__typeof__(y) _y = (y); \
|
(_x + (_y / 2)) / _y; }))
|
#else
|
#define ROUNDUP(x, y) ((((x) + (y) - 1) / (y)) * (y))
|
#define ROUNDDOWN(x, y) (((x) / (y)) * (y))
|
#define UDIV_ROUND_NEAREST(x, y) (((x) + ((y) / 2)) / (y))
|
#endif
|
|
/* x has to be of an unsigned type */
|
#define IS_POWER_OF_TWO(x) (((x) != 0) && (((x) & (~(x) + 1)) == (x)))
|
|
#define ALIGNMENT_IS_OK(p, type) \
|
(((uintptr_t)(p) & (__alignof__(type) - 1)) == 0)
|
|
#define TO_STR(x) _TO_STR(x)
|
#define _TO_STR(x) #x
|
|
#define CONCAT(x, y) _CONCAT(x, y)
|
#define _CONCAT(x, y) x##y
|
|
#define container_of(ptr, type, member) \
|
(__extension__({ \
|
const typeof(((type *)0)->member) *__ptr = (ptr); \
|
(type *)((unsigned long)(__ptr) - offsetof(type, member)); \
|
}))
|
|
#define MEMBER_SIZE(type, member) sizeof(((type *)0)->member)
|
|
#ifdef __ASSEMBLER__
|
#define BIT32(nr) (1 << (nr))
|
#define BIT64(nr) (1 << (nr))
|
#define SHIFT_U32(v, shift) ((v) << (shift))
|
#define SHIFT_U64(v, shift) ((v) << (shift))
|
#else
|
#define BIT32(nr) (UINT32_C(1) << (nr))
|
#define BIT64(nr) (UINT64_C(1) << (nr))
|
#define SHIFT_U32(v, shift) ((uint32_t)(v) << (shift))
|
#define SHIFT_U64(v, shift) ((uint64_t)(v) << (shift))
|
#endif
|
#define BIT(nr) BIT32(nr)
|
|
/*
|
* Create a contiguous bitmask starting at bit position @l and ending at
|
* position @h. For example
|
* GENMASK_64(39, 21) gives us the 64bit vector 0x000000ffffe00000.
|
*/
|
#define GENMASK_32(h, l) \
|
(((~UINT32_C(0)) << (l)) & (~UINT32_C(0) >> (32 - 1 - (h))))
|
|
#define GENMASK_64(h, l) \
|
(((~UINT64_C(0)) << (l)) & (~UINT64_C(0) >> (64 - 1 - (h))))
|
|
/*
|
* Checking overflow for addition, subtraction and multiplication. Result
|
* of operation is stored in res which is a pointer to some kind of
|
* integer.
|
*
|
* The macros return true if an overflow occurred and *res is undefined.
|
*/
|
#define ADD_OVERFLOW(a, b, res) __compiler_add_overflow((a), (b), (res))
|
#define SUB_OVERFLOW(a, b, res) __compiler_sub_overflow((a), (b), (res))
|
#define MUL_OVERFLOW(a, b, res) __compiler_mul_overflow((a), (b), (res))
|
|
/* Return a signed +1, 0 or -1 value based on data comparison */
|
#define CMP_TRILEAN(a, b) \
|
(__extension__({ \
|
__typeof__(a) _a = (a); \
|
__typeof__(b) _b = (b); \
|
\
|
_a > _b ? 1 : _a < _b ? -1 : 0; \
|
}))
|
|
#ifndef __ASSEMBLER__
|
static inline uint64_t reg_pair_to_64(uint32_t reg0, uint32_t reg1)
|
{
|
return (uint64_t)reg0 << 32 | reg1;
|
}
|
|
static inline void reg_pair_from_64(uint64_t val, uint32_t *reg0,
|
uint32_t *reg1)
|
{
|
*reg0 = val >> 32;
|
*reg1 = val;
|
}
|
#endif
|
|
#endif /*UTIL_H*/
|
