Factor system #includes out of replacements.h into new system.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 #ifndef REPLACEMENTS_H
27 #define REPLACEMENTS_H
28
29 #ifdef HAVE_CONFIG_H
30 #include "config.h"
31 #endif
32
33 #include "types.h"
34 #include "system.h"
35
36 /* MIN,MAX macros */
37 #ifndef MIN
38 #define MIN(a,b) (((a)<(b))?(a):(b))
39 #endif
40 #ifndef MAX
41 #define MAX(a,b) (((a)>(b))?(a):(b))
42 #endif
43
44 /* for systems that do not support ENOTSUP
45 * win32 being one of them */
46 #ifndef ENOTSUP
47 #define ENOTSUP 134 /* Not supported */
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 extern int gettimeofday(struct timeval *tv, struct timezone *tz);
76 #endif
77
78 #ifndef IN_REPLACEMENTS_C
79 /**** clear_malloc & fill_malloc ****/
80 void *clear_malloc(size_t size);
81 void *fill_malloc(size_t size);
82 #endif
83
84 /*
85 * Now you have 3 ways for the malloc function:
86 *
87 * 1. Do not change anything, use the original malloc
88 *
89 * 2. Use the clear_malloc function instead of the original malloc.
90 * In this case you must use the following define:
91 * #define malloc((_a)) clear_malloc((_a))
92 *
93 * 3. Use the fill_malloc function instead of the original malloc.
94 * In this case you must use the following define:
95 * #define malloc((_a)) fill_malloc((_a))
96 *
97 * We have figured out that there could exist some malloc problems
98 * where variables are using without to be initialise. To find this
99 * places, use the fill_malloc function. With this function we want
100 * to initialize memory to some known bad state. This is quite easily
101 * spotted in the debugger and will trap to an invalid address.
102 *
103 * clear_malloc can be used if you want to set not initialise
104 * variable to 0.
105 *
106 * If you do not want to change the malloc function, to not use one of
107 * the following macros. Which is the default way.
108 */
109
110 /* #define malloc(_a) clear_malloc(_a) */
111 /* #define malloc(_a) fill_malloc(_a) */
112
113 /* GNU extensions to the C library that may be missing on some systems */
114 #ifndef HAVE_STRNDUP
115 extern char* strndup(const char *s, size_t n);
116 #endif /* HAVE_STRNDUP */
117
118 #ifndef HAVE_STRNLEN
119 extern size_t strnlen(const char *s, size_t maxlen);
120 #endif /* HAVE_STRNLEN */
121
122 #ifndef HAVE_USLEEP
123 #ifdef _WIN32
124 static __inline unsigned usleep(unsigned int usecs)
125 {
126 Sleep((usecs/1000));
127 return 0;
128 }
129 #else
130 #if BUILD_ECOSBOARD
131 void usleep(int us);
132 #else
133 #error no usleep defined for your platform
134 #endif
135 #endif
136 #endif /* HAVE_USLEEP */
137
138 /* Windows specific */
139 #ifdef _WIN32
140
141 #define WIN32_LEAN_AND_MEAN
142 #include <windows.h>
143 #include <time.h>
144
145 /* win32 systems do not support ETIMEDOUT */
146
147 #ifndef ETIMEDOUT
148 #define ETIMEDOUT WSAETIMEDOUT
149 #endif
150
151 #if IS_MINGW == 1
152 static __inline unsigned char inb(unsigned short int port)
153 {
154 unsigned char _v;
155 __asm__ __volatile__ ("inb %w1,%0":"=a" (_v):"Nd" (port));
156 return _v;
157 }
158
159 static __inline void outb(unsigned char value, unsigned short int port)
160 {
161 __asm__ __volatile__ ("outb %b0,%w1": :"a" (value), "Nd" (port));
162 }
163
164 #endif /* IS_MINGW */
165
166 int win_select(int max_fd, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tv);
167
168 #endif /* _WIN32 */
169
170 /* generic socket functions for Windows and Posix */
171 static __inline int write_socket( int handle, const void *buffer, unsigned int count )
172 {
173 #ifdef _WIN32
174 return send(handle, buffer, count, 0);
175 #else
176 return write(handle, buffer, count);
177 #endif
178 }
179
180 static __inline int read_socket( int handle, void *buffer, unsigned int count )
181 {
182 #ifdef _WIN32
183 return recv(handle, buffer, count, 0);
184 #else
185 return read(handle, buffer, count);
186 #endif
187 }
188
189 static __inline int close_socket(int sock)
190 {
191 #ifdef _WIN32
192 return closesocket(sock);
193 #else
194 return close(sock);
195 #endif
196 }
197
198 static __inline void socket_nonblock(int fd)
199 {
200 #ifdef _WIN32
201 unsigned long nonblock = 1;
202 ioctlsocket(fd, FIONBIO, &nonblock );
203 #else
204 int oldopts = fcntl(fd, F_GETFL, 0);
205 fcntl(fd, F_SETFL, oldopts | O_NONBLOCK);
206 #endif
207 }
208
209 static __inline int socket_select(int max_fd, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tv)
210 {
211 #ifdef _WIN32
212 return win_select(max_fd, rfds, wfds, efds, tv);
213 #else
214 return select(max_fd, rfds, wfds, efds, tv);
215 #endif
216 }
217
218 #ifndef HAVE_ELF_H
219
220 typedef struct
221 {
222 unsigned char e_ident[16]; /* Magic number and other info */
223 u16 e_type; /* Object file type */
224 u16 e_machine; /* Architecture */
225 u32 e_version; /* Object file version */
226 u32 e_entry; /* Entry point virtual address */
227 u32 e_phoff; /* Program header table file offset */
228 u32 e_shoff; /* Section header table file offset */
229 u32 e_flags; /* Processor-specific flags */
230 u16 e_ehsize; /* ELF header size in bytes */
231 u16 e_phentsize; /* Program header table entry size */
232 u16 e_phnum; /* Program header table entry count */
233 u16 e_shentsize; /* Section header table entry size */
234 u16 e_shnum; /* Section header table entry count */
235 u16 e_shstrndx; /* Section header string table index */
236 } Elf32_Ehdr;
237
238 #define ELFMAG "\177ELF"
239 #define SELFMAG 4
240
241 #define EI_CLASS 4 /* File class byte index */
242 #define ELFCLASS32 1 /* 32-bit objects */
243 #define ELFCLASS64 2 /* 64-bit objects */
244
245 #define EI_DATA 5 /* Data encoding byte index */
246 #define ELFDATA2LSB 1 /* 2's complement, little endian */
247 #define ELFDATA2MSB 2 /* 2's complement, big endian */
248
249 typedef struct
250 {
251 u32 p_type; /* Segment type */
252 u32 p_offset; /* Segment file offset */
253 u32 p_vaddr; /* Segment virtual address */
254 u32 p_paddr; /* Segment physical address */
255 u32 p_filesz; /* Segment size in file */
256 u32 p_memsz; /* Segment size in memory */
257 u32 p_flags; /* Segment flags */
258 u32 p_align; /* Segment alignment */
259 } Elf32_Phdr;
260
261 #define PT_LOAD 1 /* Loadable program segment */
262
263 #endif /* HAVE_ELF_H */
264
265 #endif /* REPLACEMENTS_H */