no-OS
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
no_os_util.h
Go to the documentation of this file.
1/***************************************************************************/
33#ifndef _NO_OS_UTIL_H_
34#define _NO_OS_UTIL_H_
35
36#include <stdint.h>
37#include <stdlib.h>
38#include <stdbool.h>
39#define NO_OS_BIT(x) (1 << (x))
40
41#define NO_OS_BIT_ULL(x) ((uint64_t) 1 << (x))
42
43#define NO_OS_ARRAY_SIZE(x) \
44 (sizeof(x) / sizeof((x)[0]))
45
46#define NO_OS_DIV_ROUND_UP(x,y) \
47 (((x) + (y) - 1) / (y))
48#define NO_OS_DIV_ROUND_CLOSEST(x, y) \
49 (((x) + (y) / 2) / (y))
50#define NO_OS_DIV_ROUND_CLOSEST_ULL(x, y) \
51 NO_OS_DIV_ROUND_CLOSEST(x, y)
52
53#define no_os_min(x, y) \
54 (((x) < (y)) ? (x) : (y))
55#define no_os_min_t(type, x, y) \
56 (type)no_os_min((type)(x), (type)(y))
57
58#define no_os_max(x, y) \
59 (((x) > (y)) ? (x) : (y))
60#define no_os_max_t(type, x, y) \
61 (type)no_os_max((type)(x), (type)(y))
62
63#define no_os_clamp(val, min_val, max_val) \
64 (no_os_max(no_os_min((val), (max_val)), (min_val)))
65#define no_os_clamp_t(type, val, min_val, max_val) \
66 (type)no_os_clamp((type)(val), (type)(min_val), (type)(max_val))
67
68#define no_os_swap(x, y) \
69 {typeof(x) _tmp_ = (x); (x) = (y); (y) = _tmp_;}
70
71#define no_os_round_up(x,y) \
72 (((x)+(y)-1)/(y))
73
74#define NO_OS_BITS_PER_LONG 32
75
76#define NO_OS_GENMASK(h, l) ({ \
77 uint32_t t = (uint32_t)(~0UL); \
78 t = t << (NO_OS_BITS_PER_LONG - (h - l + 1)); \
79 t = t >> (NO_OS_BITS_PER_LONG - (h + 1)); \
80 t; \
81})
82#define NO_OS_GENMASK_ULL(h, l) ({ \
83 unsigned long long t = (unsigned long long)(~0ULL); \
84 t = t << (64 - (h - l + 1)); \
85 t = t >> (64 - (h + 1)); \
86 t; \
87})
88
89#define no_os_bswap_constant_32(x) \
90 ((((x) & 0xff000000) >> 24) | (((x) & 0x00ff0000) >> 8) | \
91 (((x) & 0x0000ff00) << 8) | (((x) & 0x000000ff) << 24))
92
93#define no_os_bswap_constant_16(x) ((((x) & (uint16_t)0xff00) >> 8) | \
94 (((x) & (uint16_t)0x00ff) << 8))
95
96#define no_os_bit_swap_constant_8(x) \
97 ((((x) & 0x80) >> 7) | \
98 (((x) & 0x40) >> 5) | \
99 (((x) & 0x20) >> 3) | \
100 (((x) & 0x10) >> 1) | \
101 (((x) & 0x08) << 1) | \
102 (((x) & 0x04) << 3) | \
103 (((x) & 0x02) << 5) | \
104 (((x) & 0x01) << 7))
105
106#define NO_OS_U16_MAX ((uint16_t)~0U)
107#define NO_OS_S16_MAX ((int16_t)(NO_OS_U16_MAX>>1))
108
109#define NO_OS_DIV_U64(x, y) (x / y)
110
111#define NO_OS_UNUSED_PARAM(x) ((void)x)
112
113#define no_os_shift_right(x, s) ((x) < 0 ? -(-(x) >> (s)) : (x) >> (s))
114
115#define no_os_align(x, align) (((x) + ((typeof(x))(align) - 1)) & ~((typeof(x))(align) - 1))
116
117#define no_os_bcd2bin(x) (((x) & 0x0f) + ((x) >> 4) * 10)
118#define no_os_bin2bcd(x) ((((x) / 10) << 4) + (x) % 10)
119
120#define NO_OS_CONTAINER_OF(ptr, type, name) ((type *)((char *)(ptr) - offsetof(type, name)))
121
122/* Check if bit set */
123inline int no_os_test_bit(int pos, const volatile void * addr)
124{
125 return (((const int *)addr)[pos / 32] >> pos) & 1UL;
126}
127
128/* Find first set bit in word. */
129uint32_t no_os_find_first_set_bit(uint32_t word);
130uint64_t no_os_find_first_set_bit_u64(uint64_t word);
131/* Find last set bit in word. */
132uint32_t no_os_find_last_set_bit(uint32_t word);
133/* Locate the closest element in an array. */
134uint32_t no_os_find_closest(int32_t val,
135 const int32_t *array,
136 uint32_t size);
137/* Shift the value and apply the specified mask. */
138uint32_t no_os_field_prep(uint32_t mask, uint32_t val);
139uint64_t no_os_field_prep_u64(uint64_t mask, uint64_t val);
140/* Get a field specified by a mask from a word. */
141uint32_t no_os_field_get(uint32_t mask, uint32_t word);
142/* Produce the maximum value representable by a field */
143uint32_t no_os_field_max(uint32_t mask);
144uint64_t no_os_field_max_u64(uint64_t mask);
145
146/* Log base 2 of the given number. */
147int32_t no_os_log_base_2(uint32_t x);
148/* Find greatest common divisor of the given two numbers. */
150 uint32_t b);
152 uint64_t b);
153/* Find lowest common multiple of the given two numbers. */
154uint32_t no_os_lowest_common_multiple(uint32_t a, uint32_t b);
155/* Calculate best rational approximation for a given fraction. */
156void no_os_rational_best_approximation(uint32_t given_numerator,
157 uint32_t given_denominator,
158 uint32_t max_numerator,
159 uint32_t max_denominator,
160 uint32_t *best_numerator,
161 uint32_t *best_denominator);
162void no_os_rational_best_approximation_u64(uint64_t given_numerator,
163 uint64_t given_denominator,
164 uint64_t max_numerator,
165 uint64_t max_denominator,
166 uint64_t *best_numerator,
167 uint64_t *best_denominator);
168/* Calculate the number of set bits (8-bit size). */
169unsigned int no_os_hweight8(uint8_t word);
170/* Calculate the number of set bits (16-bit size). */
171unsigned int no_os_hweight16(uint16_t word);
172/* Calculate the number of set bits (32-bit size). */
173unsigned int no_os_hweight32(uint32_t word);
174/* Calculate the quotient and the remainder of an integer division. */
175uint64_t no_os_do_div(uint64_t* n,
176 uint64_t base);
177/* Unsigned 64bit divide with 64bit divisor and remainder */
178uint64_t no_os_div64_u64_rem(uint64_t dividend, uint64_t divisor,
179 uint64_t *remainder);
180/* Unsigned 64bit divide with 32bit divisor with remainder */
181uint64_t no_os_div_u64_rem(uint64_t dividend, uint32_t divisor,
182 uint32_t *remainder);
183int64_t no_os_div_s64_rem(int64_t dividend, int32_t divisor,
184 int32_t *remainder);
185/* Unsigned 64bit divide with 32bit divisor */
186uint64_t no_os_div_u64(uint64_t dividend, uint32_t divisor);
187int64_t no_os_div_s64(int64_t dividend, int32_t divisor);
188/* Converts from string to int32_t */
189int32_t no_os_str_to_int32(const char *str);
190/* Converts from string to uint32_t */
191uint32_t no_os_str_to_uint32(const char *str);
192
193void no_os_put_unaligned_be16(uint16_t val, uint8_t *buf);
194uint16_t no_os_get_unaligned_be16(uint8_t *buf);
195void no_os_put_unaligned_le16(uint16_t val, uint8_t *buf);
196uint16_t no_os_get_unaligned_le16(uint8_t *buf);
197void no_os_put_unaligned_be24(uint32_t val, uint8_t *buf);
198uint32_t no_os_get_unaligned_be24(uint8_t *buf);
199void no_os_put_unaligned_le24(uint32_t val, uint8_t *buf);
200uint32_t no_os_get_unaligned_le24(uint8_t *buf);
201void no_os_put_unaligned_be32(uint32_t val, uint8_t *buf);
202uint32_t no_os_get_unaligned_be32(uint8_t *buf);
203void no_os_put_unaligned_le32(uint32_t val, uint8_t *buf);
204uint32_t no_os_get_unaligned_le32(uint8_t *buf);
205
206int16_t no_os_sign_extend16(uint16_t value, int index);
207int32_t no_os_sign_extend32(uint32_t value, int index);
208uint64_t no_os_mul_u32_u32(uint32_t a, uint32_t b);
209uint64_t no_os_mul_u64_u32_shr(uint64_t a, uint32_t mul, unsigned int shift);
210uint64_t no_os_mul_u64_u32_div(uint64_t a, uint32_t mul, uint32_t divisor);
211
213void no_os_memswap64(void *buf, uint32_t bytes, uint32_t step);
214
215#endif // _NO_OS_UTIL_H_
int64_t no_os_div_s64_rem(int64_t dividend, int32_t divisor, int32_t *remainder)
unsigned int no_os_hweight32(uint32_t word)
int32_t no_os_sign_extend32(uint32_t value, int index)
uint64_t no_os_div64_u64_rem(uint64_t dividend, uint64_t divisor, uint64_t *remainder)
void no_os_memswap64(void *buf, uint32_t bytes, uint32_t step)
uint32_t no_os_find_first_set_bit(uint32_t word)
uint64_t no_os_find_first_set_bit_u64(uint64_t word)
uint32_t no_os_field_max(uint32_t mask)
void no_os_put_unaligned_le16(uint16_t val, uint8_t *buf)
void no_os_put_unaligned_be32(uint32_t val, uint8_t *buf)
uint64_t no_os_field_prep_u64(uint64_t mask, uint64_t val)
int16_t no_os_sign_extend16(uint16_t value, int index)
uint32_t no_os_find_closest(int32_t val, const int32_t *array, uint32_t size)
uint64_t no_os_field_max_u64(uint64_t mask)
uint64_t no_os_mul_u64_u32_shr(uint64_t a, uint32_t mul, unsigned int shift)
uint64_t no_os_do_div(uint64_t *n, uint64_t base)
uint64_t no_os_div_u64(uint64_t dividend, uint32_t divisor)
uint32_t no_os_get_unaligned_be32(uint8_t *buf)
uint16_t no_os_get_unaligned_be16(uint8_t *buf)
bool no_os_is_big_endian(void)
uint64_t no_os_greatest_common_divisor_u64(uint64_t a, uint64_t b)
uint32_t no_os_get_unaligned_le32(uint8_t *buf)
uint32_t no_os_get_unaligned_le24(uint8_t *buf)
uint32_t no_os_str_to_uint32(const char *str)
uint32_t no_os_field_prep(uint32_t mask, uint32_t val)
void no_os_put_unaligned_le24(uint32_t val, uint8_t *buf)
uint32_t no_os_lowest_common_multiple(uint32_t a, uint32_t b)
unsigned int no_os_hweight8(uint8_t word)
int64_t no_os_div_s64(int64_t dividend, int32_t divisor)
uint32_t no_os_field_get(uint32_t mask, uint32_t word)
uint32_t no_os_greatest_common_divisor(uint32_t a, uint32_t b)
void no_os_put_unaligned_be16(uint16_t val, uint8_t *buf)
unsigned int no_os_hweight16(uint16_t word)
int32_t no_os_str_to_int32(const char *str)
void no_os_put_unaligned_le32(uint32_t val, uint8_t *buf)
uint16_t no_os_get_unaligned_le16(uint8_t *buf)
void no_os_put_unaligned_be24(uint32_t val, uint8_t *buf)
uint32_t no_os_find_last_set_bit(uint32_t word)
int32_t no_os_log_base_2(uint32_t x)
uint64_t no_os_mul_u32_u32(uint32_t a, uint32_t b)
uint64_t no_os_mul_u64_u32_div(uint64_t a, uint32_t mul, uint32_t divisor)
uint64_t no_os_div_u64_rem(uint64_t dividend, uint32_t divisor, uint32_t *remainder)
void no_os_rational_best_approximation_u64(uint64_t given_numerator, uint64_t given_denominator, uint64_t max_numerator, uint64_t max_denominator, uint64_t *best_numerator, uint64_t *best_denominator)
uint32_t no_os_get_unaligned_be24(uint8_t *buf)
int no_os_test_bit(int pos, const volatile void *addr)
Definition no_os_util.h:123
void no_os_rational_best_approximation(uint32_t given_numerator, uint32_t given_denominator, uint32_t max_numerator, uint32_t max_denominator, uint32_t *best_numerator, uint32_t *best_denominator)