git.gag.com Git - fw/openocd/blob - 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, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  22  ***************************************************************************/
  23 #ifndef TYPES_H
  24 #define TYPES_H
  25
  26 #include <stddef.h>
  27 #ifdef HAVE_SYS_TYPES_H
  28 #include <sys/types.h>
  29 #endif
  30 #ifdef HAVE_STDINT_H
  31 #include <stdint.h>
  32 #endif
  33 #ifdef HAVE_INTTYPES_H
  34 #include <inttypes.h>
  35 #endif
  36
  37 #ifdef HAVE_STDBOOL_H
  38 #include <stdbool.h>
  39 #else   /* HAVE_STDBOOL_H */
  40 #define __bool_true_false_are_defined 1
  41
  42 #ifndef HAVE__BOOL
  43 #ifndef __cplusplus
  44
  45 #define false   0
  46 #define true            1
  47
  48 typedef int _Bool;
  49 #else
  50 typedef bool _Bool;
  51 #endif  /* __cplusplus */
  52 #endif  /* HAVE__BOOL */
  53
  54 #define bool _Bool
  55
  56 #endif  /* HAVE_STDBOOL_H */
  57
  58 /// turns a macro argument into a string constant
  59 #define stringify(s) __stringify(s)
  60 #define __stringify(s) #s
  61
  62
  63 /**
  64  * Compute the number of elements of a variable length array.
  65  * <code>
  66  * const char *strs[] = { "a", "b", "c" };
  67  * unsigned num_strs = ARRAY_SIZE(strs);
  68  * </code>
  69  */
  70 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(*(x)))
  71
  72
  73 /**
  74  * Cast a member of a structure out to the containing structure.
  75  * @param ptr The pointer to the member.
  76  * @param type The type of the container struct this is embedded in.
  77  * @param member The name of the member within the struct.
  78  *
  79  * This is a mechanism which is used throughout the Linux kernel.
  80  */
  81 #define container_of(ptr, type, member) ({                      \
  82         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
  83         (type *)( (void *) ( (char *)__mptr - offsetof(type,member) ) );})
  84
  85
  86 /**
  87  * Rounds @c m up to the nearest multiple of @c n using division.
  88  * @param m The value to round up to @c n.
  89  * @param n Round @c m up to a multiple of this number.
  90  * @returns The rounded integer value.
  91  */
  92 #define DIV_ROUND_UP(m, n)      (((m) + (n) - 1) / (n))
  93
  94
  95 /* DANGER!!!! here be dragons!
  96  *
  97  * Leave these fn's as byte accesses because it is safe
  98  * across architectures. Clever usage of 32 bit access
  99  * will create problems on some hosts.
 100  *
 101  * Note that the "buf" pointer in memory is probably unaligned.
 102  *
 103  * Were these functions to be re-written to take a 32 bit wide or 16 bit wide
 104  * memory access shortcut, then on some CPU's, i.e. ARM7, the 2 lsbytes of the address are
 105  * ignored for 32 bit access, whereas on other CPU's a 32 bit wide unaligned memory access
 106  * will cause an exception, and lastly on x86, an unaligned "greater than bytewide"
 107  * memory access works as if aligned.  So what follows below will work for all
 108  * platforms and gives the compiler leeway to do its own platform specific optimizations.
 109  *
 110  * Again, note that the "buf" pointer in memory is probably unaligned.
 111  */
 112
 113
 114 static inline uint32_t le_to_h_u32(const uint8_t* buf)
 115 {
 116         return (uint32_t)(buf[0] | buf[1] << 8 | buf[2] << 16 | buf[3] << 24);
 117 }
 118
 119 static inline uint32_t le_to_h_u24(const uint8_t* buf)
 120 {
 121         return (uint32_t)(buf[0] | buf[1] << 8 | buf[2] << 16);
 122 }
 123
 124 static inline uint16_t le_to_h_u16(const uint8_t* buf)
 125 {
 126         return (uint16_t)(buf[0] | buf[1] << 8);
 127 }
 128
 129 static inline uint32_t be_to_h_u32(const uint8_t* buf)
 130 {
 131         return (uint32_t)(buf[3] | buf[2] << 8 | buf[1] << 16 | buf[0] << 24);
 132 }
 133
 134 static inline uint32_t be_to_h_u24(const uint8_t* buf)
 135 {
 136         return (uint32_t)(buf[2] | buf[1] << 8 | buf[0] << 16);
 137 }
 138
 139 static inline uint16_t be_to_h_u16(const uint8_t* buf)
 140 {
 141         return (uint16_t)(buf[1] | buf[0] << 8);
 142 }
 143
 144 static inline void h_u32_to_le(uint8_t* buf, int val)
 145 {
 146         buf[3] = (uint8_t) (val >> 24);
 147         buf[2] = (uint8_t) (val >> 16);
 148         buf[1] = (uint8_t) (val >> 8);
 149         buf[0] = (uint8_t) (val >> 0);
 150 }
 151
 152 static inline void h_u32_to_be(uint8_t* buf, int val)
 153 {
 154         buf[0] = (uint8_t) (val >> 24);
 155         buf[1] = (uint8_t) (val >> 16);
 156         buf[2] = (uint8_t) (val >> 8);
 157         buf[3] = (uint8_t) (val >> 0);
 158 }
 159
 160 static inline void h_u24_to_le(uint8_t* buf, int val)
 161 {
 162         buf[2] = (uint8_t) (val >> 16);
 163         buf[1] = (uint8_t) (val >> 8);
 164         buf[0] = (uint8_t) (val >> 0);
 165 }
 166
 167 static inline void h_u24_to_be(uint8_t* buf, int val)
 168 {
 169         buf[0] = (uint8_t) (val >> 16);
 170         buf[1] = (uint8_t) (val >> 8);
 171         buf[2] = (uint8_t) (val >> 0);
 172 }
 173
 174 static inline void h_u16_to_le(uint8_t* buf, int val)
 175 {
 176         buf[1] = (uint8_t) (val >> 8);
 177         buf[0] = (uint8_t) (val >> 0);
 178 }
 179
 180 static inline void h_u16_to_be(uint8_t* buf, int val)
 181 {
 182         buf[0] = (uint8_t) (val >> 8);
 183         buf[1] = (uint8_t) (val >> 0);
 184 }
 185
 186 #if defined(__ECOS)
 187
 188 /* eCos plain lacks these definition... A series of upstream patches
 189  * could probably repair it, but it seems like too much work to be
 190  * worth it.
 191  */
 192
 193 #if !defined(_STDINT_H)
 194 #define PRIx32 "x"
 195 #define PRId32 "d"
 196 #define SCNx32 "x"
 197 #define PRIi32 "i"
 198 #define PRIu32 "u"
 199 #define PRId8 PRId32
 200 #define SCNx64 "llx"
 201 #define PRIx64 "llx"
 202
 203 typedef CYG_ADDRWORD intptr_t;
 204 typedef int64_t intmax_t;
 205 typedef uint64_t uintmax_t;
 206 #define INT8_MAX 0x7f
 207 #define INT8_MIN (-INT8_MAX - 1)
 208 # define UINT8_MAX              (255)
 209 #define INT16_MAX 0x7fff
 210 #define INT16_MIN (-INT16_MAX - 1)
 211 # define UINT16_MAX             (65535)
 212 #define INT32_MAX 0x7fffffffL
 213 #define INT32_MIN (-INT32_MAX - 1L)
 214 # define UINT32_MAX             (4294967295U)
 215 #define INT64_MAX 0x7fffffffffffffffLL
 216 #define INT64_MIN (-INT64_MAX - 1LL)
 217 #define UINT64_MAX (__CONCAT(INT64_MAX, U) * 2ULL + 1ULL)
 218 #endif
 219
 220         #ifndef LLONG_MAX
 221         #define ULLONG_MAX      UINT64_C(0xFFFFFFFFFFFFFFFF)
 222         #define LLONG_MAX       INT64_C(0x7FFFFFFFFFFFFFFF)
 223         #define LLONG_MIN       ULLONG_MAX
 224         #endif
 225
 226
 227 #define ULLONG_MAX 18446744073709551615
 228
 229 /* C99, eCos is C90 compliant (with bits of C99) */
 230 #define isblank(c) ((c) == ' ' || (c) == '\t')
 231
 232
 233 #endif
 234
 235 #endif /* TYPES_H */