1 /***************************************************************************
2 * Copyright (C) 2004, 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
20 ***************************************************************************/
22 #ifndef OPENOCD_HELPER_TYPES_H
23 #define OPENOCD_HELPER_TYPES_H
26 #ifdef HAVE_SYS_TYPES_H
27 #include <sys/types.h>
32 #ifdef HAVE_INTTYPES_H
38 #else /* HAVE_STDBOOL_H */
39 #define __bool_true_false_are_defined 1
50 #endif /* __cplusplus */
51 #endif /* HAVE__BOOL */
55 #endif /* HAVE_STDBOOL_H */
57 /// turns a macro argument into a string constant
58 #define stringify(s) __stringify(s)
59 #define __stringify(s) #s
63 * Compute the number of elements of a variable length array.
65 * const char *strs[] = { "a", "b", "c" };
66 * unsigned num_strs = ARRAY_SIZE(strs);
69 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(*(x)))
73 * Cast a member of a structure out to the containing structure.
74 * @param ptr The pointer to the member.
75 * @param type The type of the container struct this is embedded in.
76 * @param member The name of the member within the struct.
78 * This is a mechanism which is used throughout the Linux kernel.
80 #define container_of(ptr, type, member) ({ \
81 const typeof( ((type *)0)->member ) *__mptr = (ptr); \
82 (type *)( (void *) ( (char *)__mptr - offsetof(type,member) ) );})
86 * Rounds @c m up to the nearest multiple of @c n using division.
87 * @param m The value to round up to @c n.
88 * @param n Round @c m up to a multiple of this number.
89 * @returns The rounded integer value.
91 #define DIV_ROUND_UP(m, n) (((m) + (n) - 1) / (n))
94 /* DANGER!!!! here be dragons!
96 * Leave these fn's as byte accesses because it is safe
97 * across architectures. Clever usage of 32 bit access
98 * will create problems on some hosts.
100 * Note that the "buf" pointer in memory is probably unaligned.
102 * Were these functions to be re-written to take a 32 bit wide or 16 bit wide
103 * memory access shortcut, then on some CPU's, i.e. ARM7, the 2 lsbytes of the address are
104 * ignored for 32 bit access, whereas on other CPU's a 32 bit wide unaligned memory access
105 * will cause an exception, and lastly on x86, an unaligned "greater than bytewide"
106 * memory access works as if aligned. So what follows below will work for all
107 * platforms and gives the compiler leeway to do its own platform specific optimizations.
109 * Again, note that the "buf" pointer in memory is probably unaligned.
112 static inline uint64_t le_to_h_u64(const uint8_t *buf
)
114 return (uint64_t)((uint64_t)buf
[0] |
115 (uint64_t)buf
[1] << 8 |
116 (uint64_t)buf
[2] << 16 |
117 (uint64_t)buf
[3] << 24 |
118 (uint64_t)buf
[4] << 32 |
119 (uint64_t)buf
[5] << 40 |
120 (uint64_t)buf
[6] << 48 |
121 (uint64_t)buf
[7] << 56);
124 static inline uint32_t le_to_h_u32(const uint8_t* buf
)
126 return (uint32_t)(buf
[0] | buf
[1] << 8 | buf
[2] << 16 | buf
[3] << 24);
129 static inline uint32_t le_to_h_u24(const uint8_t* buf
)
131 return (uint32_t)(buf
[0] | buf
[1] << 8 | buf
[2] << 16);
134 static inline uint16_t le_to_h_u16(const uint8_t* buf
)
136 return (uint16_t)(buf
[0] | buf
[1] << 8);
139 static inline uint64_t be_to_h_u64(const uint8_t *buf
)
141 return (uint64_t)((uint64_t)buf
[7] |
142 (uint64_t)buf
[6] << 8 |
143 (uint64_t)buf
[5] << 16 |
144 (uint64_t)buf
[4] << 24 |
145 (uint64_t)buf
[3] << 32 |
146 (uint64_t)buf
[2] << 40 |
147 (uint64_t)buf
[1] << 48 |
148 (uint64_t)buf
[0] << 56);
151 static inline uint32_t be_to_h_u32(const uint8_t* buf
)
153 return (uint32_t)(buf
[3] | buf
[2] << 8 | buf
[1] << 16 | buf
[0] << 24);
156 static inline uint32_t be_to_h_u24(const uint8_t* buf
)
158 return (uint32_t)(buf
[2] | buf
[1] << 8 | buf
[0] << 16);
161 static inline uint16_t be_to_h_u16(const uint8_t* buf
)
163 return (uint16_t)(buf
[1] | buf
[0] << 8);
166 static inline void h_u64_to_le(uint8_t *buf
, int64_t val
)
168 buf
[7] = (uint8_t) (val
>> 56);
169 buf
[6] = (uint8_t) (val
>> 48);
170 buf
[5] = (uint8_t) (val
>> 40);
171 buf
[4] = (uint8_t) (val
>> 32);
172 buf
[3] = (uint8_t) (val
>> 24);
173 buf
[2] = (uint8_t) (val
>> 16);
174 buf
[1] = (uint8_t) (val
>> 8);
175 buf
[0] = (uint8_t) (val
>> 0);
178 static inline void h_u64_to_be(uint8_t *buf
, int64_t val
)
180 buf
[0] = (uint8_t) (val
>> 56);
181 buf
[1] = (uint8_t) (val
>> 48);
182 buf
[2] = (uint8_t) (val
>> 40);
183 buf
[3] = (uint8_t) (val
>> 32);
184 buf
[4] = (uint8_t) (val
>> 24);
185 buf
[5] = (uint8_t) (val
>> 16);
186 buf
[6] = (uint8_t) (val
>> 8);
187 buf
[7] = (uint8_t) (val
>> 0);
190 static inline void h_u32_to_le(uint8_t* buf
, int val
)
192 buf
[3] = (uint8_t) (val
>> 24);
193 buf
[2] = (uint8_t) (val
>> 16);
194 buf
[1] = (uint8_t) (val
>> 8);
195 buf
[0] = (uint8_t) (val
>> 0);
198 static inline void h_u32_to_be(uint8_t* buf
, int val
)
200 buf
[0] = (uint8_t) (val
>> 24);
201 buf
[1] = (uint8_t) (val
>> 16);
202 buf
[2] = (uint8_t) (val
>> 8);
203 buf
[3] = (uint8_t) (val
>> 0);
206 static inline void h_u24_to_le(uint8_t* buf
, int val
)
208 buf
[2] = (uint8_t) (val
>> 16);
209 buf
[1] = (uint8_t) (val
>> 8);
210 buf
[0] = (uint8_t) (val
>> 0);
213 static inline void h_u24_to_be(uint8_t* buf
, int val
)
215 buf
[0] = (uint8_t) (val
>> 16);
216 buf
[1] = (uint8_t) (val
>> 8);
217 buf
[2] = (uint8_t) (val
>> 0);
220 static inline void h_u16_to_le(uint8_t* buf
, int val
)
222 buf
[1] = (uint8_t) (val
>> 8);
223 buf
[0] = (uint8_t) (val
>> 0);
226 static inline void h_u16_to_be(uint8_t* buf
, int val
)
228 buf
[0] = (uint8_t) (val
>> 8);
229 buf
[1] = (uint8_t) (val
>> 0);
233 * Byte-swap buffer 16-bit.
235 * Len must be even, dst and src must be either the same or non-overlapping.
237 * @param dst Destination buffer.
238 * @param src Source buffer.
239 * @param len Length of source (and destination) buffer, in bytes.
241 static inline void buf_bswap16(uint8_t *dst
, const uint8_t *src
, size_t len
)
243 assert(len
% 2 == 0);
244 assert(dst
== src
|| dst
+ len
<= src
|| src
+ len
<= dst
);
246 for (size_t n
= 0; n
< len
; n
+= 2) {
247 uint16_t x
= be_to_h_u16(src
+ n
);
248 h_u16_to_le(dst
+ n
, x
);
253 * Byte-swap buffer 32-bit.
255 * Len must be divisible by four, dst and src must be either the same or non-overlapping.
257 * @param dst Destination buffer.
258 * @param src Source buffer.
259 * @param len Length of source (and destination) buffer, in bytes.
261 static inline void buf_bswap32(uint8_t *dst
, const uint8_t *src
, size_t len
)
263 assert(len
% 4 == 0);
264 assert(dst
== src
|| dst
+ len
<= src
|| src
+ len
<= dst
);
266 for (size_t n
= 0; n
< len
; n
+= 4) {
267 uint32_t x
= be_to_h_u32(src
+ n
);
268 h_u32_to_le(dst
+ n
, x
);
273 * Calculate the (even) parity of a 32-bit datum.
274 * @param x The datum.
275 * @return 1 if the number of set bits in x is odd, 0 if it is even.
277 static inline int parity_u32(uint32_t x
)
280 return __builtin_parityl(x
);
293 /* eCos plain lacks these definition... A series of upstream patches
294 * could probably repair it, but it seems like too much work to be
298 #if !defined(_STDINT_H)
308 typedef CYG_ADDRWORD
intptr_t;
309 typedef int64_t intmax_t;
310 typedef uint64_t uintmax_t;
311 #define INT8_MAX 0x7f
312 #define INT8_MIN (-INT8_MAX - 1)
313 # define UINT8_MAX (255)
314 #define INT16_MAX 0x7fff
315 #define INT16_MIN (-INT16_MAX - 1)
316 # define UINT16_MAX (65535)
317 #define INT32_MAX 0x7fffffffL
318 #define INT32_MIN (-INT32_MAX - 1L)
319 # define UINT32_MAX (4294967295U)
320 #define INT64_MAX 0x7fffffffffffffffLL
321 #define INT64_MIN (-INT64_MAX - 1LL)
322 #define UINT64_MAX (__CONCAT(INT64_MAX, U) * 2ULL + 1ULL)
326 #define ULLONG_MAX UINT64_C(0xFFFFFFFFFFFFFFFF)
327 #define LLONG_MAX INT64_C(0x7FFFFFFFFFFFFFFF)
328 #define LLONG_MIN ULLONG_MAX
332 #define ULLONG_MAX 18446744073709551615
334 /* C99, eCos is C90 compliant (with bits of C99) */
335 #define isblank(c) ((c) == ' ' || (c) == '\t')
340 #endif /* OPENOCD_HELPER_TYPES_H */