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