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