build: add helper/types.h to config.h
[openocd.git] / src / helper / replacements.h
1 /***************************************************************************
2 * Copyright (C) 2006 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26
27 #ifndef REPLACEMENTS_H
28 #define REPLACEMENTS_H
29
30 /* MIN,MAX macros */
31 #ifndef MIN
32 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
33 #endif
34 #ifndef MAX
35 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
36 #endif
37
38 /* for systems that do not support ENOTSUP
39 * win32 being one of them */
40 #ifndef ENOTSUP
41 #define ENOTSUP 134 /* Not supported */
42 #endif
43
44 /* for systems that do not support O_BINARY
45 * linux being one of them */
46 #ifndef O_BINARY
47 #define O_BINARY 0
48 #endif
49
50 #ifndef HAVE_SYS_TIME_H
51
52 #ifndef _TIMEVAL_DEFINED
53 #define _TIMEVAL_DEFINED
54
55 struct timeval {
56 long tv_sec;
57 long tv_usec;
58 };
59
60 #endif /* _TIMEVAL_DEFINED */
61
62 #endif
63
64 /* gettimeofday() */
65 #ifndef HAVE_GETTIMEOFDAY
66
67 #ifdef _WIN32
68 struct timezone {
69 int tz_minuteswest;
70 int tz_dsttime;
71 };
72 #endif
73 struct timezone;
74
75 int gettimeofday(struct timeval *tv, struct timezone *tz);
76
77 #endif
78
79 #ifndef IN_REPLACEMENTS_C
80 /**** clear_malloc & fill_malloc ****/
81 void *clear_malloc(size_t size);
82 void *fill_malloc(size_t size);
83 #endif
84
85 /*
86 * Now you have 3 ways for the malloc function:
87 *
88 * 1. Do not change anything, use the original malloc
89 *
90 * 2. Use the clear_malloc function instead of the original malloc.
91 * In this case you must use the following define:
92 * #define malloc((_a)) clear_malloc((_a))
93 *
94 * 3. Use the fill_malloc function instead of the original malloc.
95 * In this case you must use the following define:
96 * #define malloc((_a)) fill_malloc((_a))
97 *
98 * We have figured out that there could exist some malloc problems
99 * where variables are using without to be initialise. To find this
100 * places, use the fill_malloc function. With this function we want
101 * to initialize memory to some known bad state. This is quite easily
102 * spotted in the debugger and will trap to an invalid address.
103 *
104 * clear_malloc can be used if you want to set not initialise
105 * variable to 0.
106 *
107 * If you do not want to change the malloc function, to not use one of
108 * the following macros. Which is the default way.
109 */
110
111 /* #define malloc(_a) clear_malloc(_a)
112 * #define malloc(_a) fill_malloc(_a) */
113
114 /* GNU extensions to the C library that may be missing on some systems */
115 #ifndef HAVE_STRNDUP
116 char *strndup(const char *s, size_t n);
117 #endif /* HAVE_STRNDUP */
118
119 #ifndef HAVE_STRNLEN
120 size_t strnlen(const char *s, size_t maxlen);
121 #endif /* HAVE_STRNLEN */
122
123 #ifndef HAVE_USLEEP
124 #ifdef _WIN32
125 static inline unsigned usleep(unsigned int usecs)
126 {
127 Sleep((usecs/1000));
128 return 0;
129 }
130 #else
131 #error no usleep defined for your platform
132 #endif
133 #endif /* HAVE_USLEEP */
134
135 /* Windows specific */
136 #ifdef _WIN32
137
138 #define WIN32_LEAN_AND_MEAN
139 #include <windows.h>
140 #include <time.h>
141
142 /* Windows does not declare sockaddr_un */
143 #define UNIX_PATH_LEN 108
144 struct sockaddr_un {
145 uint16_t sun_family;
146 char sun_path[UNIX_PATH_LEN];
147 };
148
149 /* win32 systems do not support ETIMEDOUT */
150
151 #ifndef ETIMEDOUT
152 #define ETIMEDOUT WSAETIMEDOUT
153 #endif
154
155 #if IS_MINGW == 1
156 static inline unsigned char inb(unsigned short int port)
157 {
158 unsigned char _v;
159 __asm__ __volatile__ ("inb %w1,%0" : "=a" (_v) : "Nd" (port));
160 return _v;
161 }
162
163 static inline void outb(unsigned char value, unsigned short int port)
164 {
165 __asm__ __volatile__ ("outb %b0,%w1" : : "a" (value), "Nd" (port));
166 }
167
168 /* mingw does not have ffs, so use gcc builtin types */
169 #define ffs __builtin_ffs
170
171 #endif /* IS_MINGW */
172
173 int win_select(int max_fd, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tv);
174
175 #endif /* _WIN32 */
176
177 /* generic socket functions for Windows and Posix */
178 static inline int write_socket(int handle, const void *buffer, unsigned int count)
179 {
180 #ifdef _WIN32
181 return send(handle, buffer, count, 0);
182 #else
183 return write(handle, buffer, count);
184 #endif
185 }
186
187 static inline int read_socket(int handle, void *buffer, unsigned int count)
188 {
189 #ifdef _WIN32
190 return recv(handle, buffer, count, 0);
191 #else
192 return read(handle, buffer, count);
193 #endif
194 }
195
196 static inline int close_socket(int sock)
197 {
198 #ifdef _WIN32
199 return closesocket(sock);
200 #else
201 return close(sock);
202 #endif
203 }
204
205 static inline void socket_nonblock(int fd)
206 {
207 #ifdef _WIN32
208 unsigned long nonblock = 1;
209 ioctlsocket(fd, FIONBIO, &nonblock);
210 #else
211 int oldopts = fcntl(fd, F_GETFL, 0);
212 fcntl(fd, F_SETFL, oldopts | O_NONBLOCK);
213 #endif
214 }
215
216 static inline int socket_select(int max_fd,
217 fd_set *rfds,
218 fd_set *wfds,
219 fd_set *efds,
220 struct timeval *tv)
221 {
222 #ifdef _WIN32
223 return win_select(max_fd, rfds, wfds, efds, tv);
224 #else
225 return select(max_fd, rfds, wfds, efds, tv);
226 #endif
227 }
228
229 #ifndef HAVE_ELF_H
230
231 typedef uint32_t Elf32_Addr;
232 typedef uint16_t Elf32_Half;
233 typedef uint32_t Elf32_Off;
234 typedef int32_t Elf32_Sword;
235 typedef uint32_t Elf32_Word;
236 typedef uint32_t Elf32_Size;
237 typedef Elf32_Off Elf32_Hashelt;
238
239 typedef struct {
240 unsigned char e_ident[16]; /* Magic number and other info */
241 Elf32_Half e_type; /* Object file type */
242 Elf32_Half e_machine; /* Architecture */
243 Elf32_Word e_version; /* Object file version */
244 Elf32_Addr e_entry; /* Entry point virtual address */
245 Elf32_Off e_phoff; /* Program header table file offset */
246 Elf32_Off e_shoff; /* Section header table file offset */
247 Elf32_Word e_flags; /* Processor-specific flags */
248 Elf32_Half e_ehsize; /* ELF header size in bytes */
249 Elf32_Half e_phentsize; /* Program header table entry size */
250 Elf32_Half e_phnum; /* Program header table entry count */
251 Elf32_Half e_shentsize; /* Section header table entry size */
252 Elf32_Half e_shnum; /* Section header table entry count */
253 Elf32_Half e_shstrndx; /* Section header string table index */
254 } Elf32_Ehdr;
255
256 #define ELFMAG "\177ELF"
257 #define SELFMAG 4
258
259 #define EI_CLASS 4 /* File class byte index */
260 #define ELFCLASS32 1 /* 32-bit objects */
261 #define ELFCLASS64 2 /* 64-bit objects */
262
263 #define EI_DATA 5 /* Data encoding byte index */
264 #define ELFDATA2LSB 1 /* 2's complement, little endian */
265 #define ELFDATA2MSB 2 /* 2's complement, big endian */
266
267 typedef struct {
268 Elf32_Word p_type; /* Segment type */
269 Elf32_Off p_offset; /* Segment file offset */
270 Elf32_Addr p_vaddr; /* Segment virtual address */
271 Elf32_Addr p_paddr; /* Segment physical address */
272 Elf32_Size p_filesz; /* Segment size in file */
273 Elf32_Size p_memsz; /* Segment size in memory */
274 Elf32_Word p_flags; /* Segment flags */
275 Elf32_Size p_align; /* Segment alignment */
276 } Elf32_Phdr;
277
278 #define PT_LOAD 1 /* Loadable program segment */
279
280 #endif /* HAVE_ELF_H */
281
282 #endif /* REPLACEMENTS_H */