move container_of to types.h
[fw/openocd] / 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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, 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  * Cast a member of a structure out to the containing structure.
65  * @param ptr The pointer to the member.
66  * @param type The type of the container struct this is embedded in.
67  * @param member The name of the member within the struct.
68  *
69  * This is a mechanism which is used throughout the Linux kernel.
70  */
71 #define container_of(ptr, type, member) ({                      \
72         const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
73         (type *)( (char *)__mptr - offsetof(type,member) );})
74
75
76 /* DANGER!!!! here be dragons!
77  *
78  * Leave these fn's as byte accesses because it is safe
79  * across architectures. Clever usage of 32 bit access
80  * will create problems on some hosts.
81  *
82  * Note that the "buf" pointer in memory is probably unaligned.
83  *
84  * Were these functions to be re-written to take a 32 bit wide or 16 bit wide
85  * memory access shortcut, then on some CPU's, i.e. ARM7, the 2 lsbytes of the address are
86  * ignored for 32 bit access, whereas on other CPU's a 32 bit wide unaligned memory access
87  * will cause an exception, and lastly on x86, an unaligned "greater than bytewide"
88  * memory access works as if aligned.  So what follows below will work for all
89  * platforms and gives the compiler leeway to do its own platform specific optimizations.
90  *
91  * Again, note that the "buf" pointer in memory is probably unaligned.
92  */
93
94
95 static inline uint32_t le_to_h_u32(const uint8_t* buf)
96 {
97         return (uint32_t)(buf[0] | buf[1] << 8 | buf[2] << 16 | buf[3] << 24);
98 }
99
100 static inline uint16_t le_to_h_u16(const uint8_t* buf)
101 {
102         return (uint16_t)(buf[0] | buf[1] << 8);
103 }
104
105 static inline uint32_t be_to_h_u32(const uint8_t* buf)
106 {
107         return (uint32_t)(buf[3] | buf[2] << 8 | buf[1] << 16 | buf[0] << 24);
108 }
109
110 static inline uint16_t be_to_h_u16(const uint8_t* buf)
111 {
112         return (uint16_t)(buf[1] | buf[0] << 8);
113 }
114
115 static inline void h_u32_to_le(uint8_t* buf, int val)
116 {
117         buf[3] = (uint8_t) (val >> 24);
118         buf[2] = (uint8_t) (val >> 16);
119         buf[1] = (uint8_t) (val >> 8);
120         buf[0] = (uint8_t) (val >> 0);
121 }
122
123 static inline void h_u32_to_be(uint8_t* buf, int val)
124 {
125         buf[0] = (uint8_t) (val >> 24);
126         buf[1] = (uint8_t) (val >> 16);
127         buf[2] = (uint8_t) (val >> 8);
128         buf[3] = (uint8_t) (val >> 0);
129 }
130
131 static inline void h_u16_to_le(uint8_t* buf, int val)
132 {
133         buf[1] = (uint8_t) (val >> 8);
134         buf[0] = (uint8_t) (val >> 0);
135 }
136
137 static inline void h_u16_to_be(uint8_t* buf, int val)
138 {
139         buf[0] = (uint8_t) (val >> 8);
140         buf[1] = (uint8_t) (val >> 0);
141 }
142
143 #if defined(__ECOS)
144
145 /* eCos plain lacks these definition... A series of upstream patches
146  * could probably repair it, but it seems like too much work to be
147  * worth it.
148  */
149
150 #if !defined(_STDINT_H)
151 #define PRIx32 "x"
152 #define PRId32 "d"
153 #define SCNx32 "x"
154 #define PRIi32 "i"
155 #define PRIu32 "u"
156
157 typedef CYG_ADDRWORD intptr_t;
158 typedef int64_t intmax_t;
159 typedef uint64_t uintmax_t;
160 #define INT8_MAX 0x7f
161 #define INT8_MIN (-INT8_MAX - 1)
162 # define UINT8_MAX              (255)
163 #define INT16_MAX 0x7fff
164 #define INT16_MIN (-INT16_MAX - 1)
165 # define UINT16_MAX             (65535)
166 #define INT32_MAX 0x7fffffffL
167 #define INT32_MIN (-INT32_MAX - 1L)
168 # define UINT32_MAX             (4294967295U)
169 #define INT64_MAX 0x7fffffffffffffffLL
170 #define INT64_MIN (-INT64_MAX - 1LL)
171 #define UINT64_MAX (__CONCAT(INT64_MAX, U) * 2ULL + 1ULL)
172 #endif
173
174     #ifndef LLONG_MAX
175         #define ULLONG_MAX      UINT64_C(0xFFFFFFFFFFFFFFFF)
176         #define LLONG_MAX       INT64_C(0x7FFFFFFFFFFFFFFF)
177         #define LLONG_MIN       ULLONG_MAX
178     #endif
179
180
181 #define ULLONG_MAX 18446744073709551615
182
183 /* C99, eCos is C90 compliant (with bits of C99) */
184 #define isblank(c) ((c) == ' ' || (c) == '\t')
185
186
187 #endif
188
189 #endif /* TYPES_H */