src/helper/types.h

   1 /***************************************************************************
   2  *   Copyright (C) 2004, 2005 by Dominic Rath                              *
   3  *   Dominic.Rath@gmx.de                                                   *
   4  *                                                                         *
   5  *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
   6  *   oyvind.harboe@zylin.com                                               *
   7  *                                                                         *
   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.                                   *
  12  *                                                                         *
  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.                          *
  17  *                                                                         *
  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  ***************************************************************************/
  21
  22 #ifndef OPENOCD_HELPER_TYPES_H
  23 #define OPENOCD_HELPER_TYPES_H
  24
  25 #include <stddef.h>
  26 #ifdef HAVE_SYS_TYPES_H
  27 #include <sys/types.h>
  28 #endif
  29 #ifdef HAVE_STDINT_H
  30 #include <stdint.h>
  31 #endif
  32 #ifdef HAVE_INTTYPES_H
  33 #include <inttypes.h>
  34 #endif
  35
  36 #ifdef HAVE_STDBOOL_H
  37 #include <stdbool.h>
  38 #else   /* HAVE_STDBOOL_H */
  39 #define __bool_true_false_are_defined 1
  40
  41 #ifndef HAVE__BOOL
  42 #ifndef __cplusplus
  43
  44 #define false   0
  45 #define true            1
  46
  47 typedef int _Bool;
  48 #else
  49 typedef bool _Bool;
  50 #endif  /* __cplusplus */
  51 #endif  /* HAVE__BOOL */
  52
  53 #define bool _Bool
  54
  55 #endif  /* HAVE_STDBOOL_H */
  56
  57 /// turns a macro argument into a string constant
  58 #define stringify(s) __stringify(s)
  59 #define __stringify(s) #s
  60
  61
  62 /**
  63  * Compute the number of elements of a variable length array.
  64  * <code>
  65  * const char *strs[] = { "a", "b", "c" };
  66  * unsigned num_strs = ARRAY_SIZE(strs);
  67  * </code>
  68  */
  69 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(*(x)))
  70
  71
  72 /**
  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.
  77  *
  78  * This is a mechanism which is used throughout the Linux kernel.
  79  */
  80 #define container_of(ptr, type, member) ({                      \
  81         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
  82         (type *)( (void *) ( (char *)__mptr - offsetof(type,member) ) );})
  83
  84
  85 /**
  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.
  90  */
  91 #define DIV_ROUND_UP(m, n)      (((m) + (n) - 1) / (n))
  92
  93
  94 /* DANGER!!!! here be dragons!
  95  *
  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.
  99  *
 100  * Note that the "buf" pointer in memory is probably unaligned.
 101  *
 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.
 108  *
 109  * Again, note that the "buf" pointer in memory is probably unaligned.
 110  */
 111
 112 static inline uint64_t le_to_h_u64(const uint8_t *buf)
 113 {
 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);
 122 }
 123
 124 static inline uint32_t le_to_h_u32(const uint8_t* buf)
 125 {
 126         return (uint32_t)(buf[0] | buf[1] << 8 | buf[2] << 16 | buf[3] << 24);
 127 }
 128
 129 static inline uint32_t le_to_h_u24(const uint8_t* buf)
 130 {
 131         return (uint32_t)(buf[0] | buf[1] << 8 | buf[2] << 16);
 132 }
 133
 134 static inline uint16_t le_to_h_u16(const uint8_t* buf)
 135 {
 136         return (uint16_t)(buf[0] | buf[1] << 8);
 137 }
 138
 139 static inline uint64_t be_to_h_u64(const uint8_t *buf)
 140 {
 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);
 149 }
 150
 151 static inline uint32_t be_to_h_u32(const uint8_t* buf)
 152 {
 153         return (uint32_t)(buf[3] | buf[2] << 8 | buf[1] << 16 | buf[0] << 24);
 154 }
 155
 156 static inline uint32_t be_to_h_u24(const uint8_t* buf)
 157 {
 158         return (uint32_t)(buf[2] | buf[1] << 8 | buf[0] << 16);
 159 }
 160
 161 static inline uint16_t be_to_h_u16(const uint8_t* buf)
 162 {
 163         return (uint16_t)(buf[1] | buf[0] << 8);
 164 }
 165
 166 static inline void h_u64_to_le(uint8_t *buf, int64_t val)
 167 {
 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);
 176 }
 177
 178 static inline void h_u64_to_be(uint8_t *buf, int64_t val)
 179 {
 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);
 188 }
 189
 190 static inline void h_u32_to_le(uint8_t* buf, int val)
 191 {
 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);
 196 }
 197
 198 static inline void h_u32_to_be(uint8_t* buf, int val)
 199 {
 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);
 204 }
 205
 206 static inline void h_u24_to_le(uint8_t* buf, int val)
 207 {
 208         buf[2] = (uint8_t) (val >> 16);
 209         buf[1] = (uint8_t) (val >> 8);
 210         buf[0] = (uint8_t) (val >> 0);
 211 }
 212
 213 static inline void h_u24_to_be(uint8_t* buf, int val)
 214 {
 215         buf[0] = (uint8_t) (val >> 16);
 216         buf[1] = (uint8_t) (val >> 8);
 217         buf[2] = (uint8_t) (val >> 0);
 218 }
 219
 220 static inline void h_u16_to_le(uint8_t* buf, int val)
 221 {
 222         buf[1] = (uint8_t) (val >> 8);
 223         buf[0] = (uint8_t) (val >> 0);
 224 }
 225
 226 static inline void h_u16_to_be(uint8_t* buf, int val)
 227 {
 228         buf[0] = (uint8_t) (val >> 8);
 229         buf[1] = (uint8_t) (val >> 0);
 230 }
 231
 232 /**
 233  * Byte-swap buffer 16-bit.
 234  *
 235  * Len must be even, dst and src must be either the same or non-overlapping.
 236  *
 237  * @param dst Destination buffer.
 238  * @param src Source buffer.
 239  * @param len Length of source (and destination) buffer, in bytes.
 240  */
 241 static inline void buf_bswap16(uint8_t *dst, const uint8_t *src, size_t len)
 242 {
 243         assert(len % 2 == 0);
 244         assert(dst == src || dst + len <= src || src + len <= dst);
 245
 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);
 249         }
 250 }
 251
 252 /**
 253  * Byte-swap buffer 32-bit.
 254  *
 255  * Len must be divisible by four, dst and src must be either the same or non-overlapping.
 256  *
 257  * @param dst Destination buffer.
 258  * @param src Source buffer.
 259  * @param len Length of source (and destination) buffer, in bytes.
 260  */
 261 static inline void buf_bswap32(uint8_t *dst, const uint8_t *src, size_t len)
 262 {
 263         assert(len % 4 == 0);
 264         assert(dst == src || dst + len <= src || src + len <= dst);
 265
 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);
 269         }
 270 }
 271
 272 /**
 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.
 276  */
 277 static inline int parity_u32(uint32_t x)
 278 {
 279 #ifdef __GNUC__
 280         return __builtin_parityl(x);
 281 #else
 282         x ^= x >> 16;
 283         x ^= x >> 8;
 284         x ^= x >> 4;
 285         x ^= x >> 2;
 286         x ^= x >> 1;
 287         return x & 1;
 288 #endif
 289 }
 290
 291 #if defined(__ECOS)
 292
 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
 295  * worth it.
 296  */
 297
 298 #if !defined(_STDINT_H)
 299 #define PRId32 "d"
 300 #define PRIi32 "i"
 301 #define PRIo32 "o"
 302 #define PRIu32 "u"
 303 #define PRIx32 "x"
 304 #define PRIX32 "X"
 305 #define SCNx32 "x"
 306 #define PRId8 PRId32
 307 #define SCNx64 "llx"
 308 #define PRId64 "lld"
 309 #define PRIi64 "lli"
 310 #define PRIo64 "llo"
 311 #define PRIu64 "llu"
 312 #define PRIx64 "llx"
 313 #define PRIX64 "llX"
 314
 315 typedef CYG_ADDRWORD intptr_t;
 316 typedef int64_t intmax_t;
 317 typedef uint64_t uintmax_t;
 318 #define INT8_MAX 0x7f
 319 #define INT8_MIN (-INT8_MAX - 1)
 320 # define UINT8_MAX              (255)
 321 #define INT16_MAX 0x7fff
 322 #define INT16_MIN (-INT16_MAX - 1)
 323 # define UINT16_MAX             (65535)
 324 #define INT32_MAX 0x7fffffffL
 325 #define INT32_MIN (-INT32_MAX - 1L)
 326 # define UINT32_MAX             (4294967295U)
 327 #define INT64_MAX 0x7fffffffffffffffLL
 328 #define INT64_MIN (-INT64_MAX - 1LL)
 329 #define UINT64_MAX (__CONCAT(INT64_MAX, U) * 2ULL + 1ULL)
 330 #endif
 331
 332         #ifndef LLONG_MAX
 333         #define ULLONG_MAX      UINT64_C(0xFFFFFFFFFFFFFFFF)
 334         #define LLONG_MAX       INT64_C(0x7FFFFFFFFFFFFFFF)
 335         #define LLONG_MIN       ULLONG_MAX
 336         #endif
 337
 338
 339 #define ULLONG_MAX 18446744073709551615
 340
 341 /* C99, eCos is C90 compliant (with bits of C99) */
 342 #define isblank(c) ((c) == ' ' || (c) == '\t')
 343
 344
 345 #endif
 346
 347 #if BUILD_TARGET64
 348 typedef uint64_t target_addr_t;
 349 #define TARGET_ADDR_MAX UINT64_MAX
 350 #define TARGET_PRIdADDR PRId64
 351 #define TARGET_PRIuADDR PRIu64
 352 #define TARGET_PRIoADDR PRIo64
 353 #define TARGET_PRIxADDR PRIx64
 354 #define TARGET_PRIXADDR PRIX64
 355 #else
 356 typedef uint32_t target_addr_t;
 357 #define TARGET_ADDR_MAX UINT32_MAX
 358 #define TARGET_PRIdADDR PRId32
 359 #define TARGET_PRIuADDR PRIu32
 360 #define TARGET_PRIoADDR PRIo32
 361 #define TARGET_PRIxADDR PRIx32
 362 #define TARGET_PRIXADDR PRIX32
 363 #endif
 364 #define TARGET_ADDR_FMT "0x%8.8" TARGET_PRIxADDR
 365
 366 #endif /* OPENOCD_HELPER_TYPES_H */