doxygen: use correct comment syntax
[openocd/andreasf.git] / src / helper / replacements.h
blob6f2e959519090163e3ca645b3479df698b58d2fc
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 ***************************************************************************/
27 #ifndef REPLACEMENTS_H
28 #define REPLACEMENTS_H
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
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
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
50 #ifndef HAVE_SYS_TIME_H
52 #ifndef _TIMEVAL_DEFINED
53 #define _TIMEVAL_DEFINED
55 struct timeval {
56 long tv_sec;
57 long tv_usec;
60 #endif /* _TIMEVAL_DEFINED */
62 #endif
64 /* gettimeofday() */
65 #ifndef HAVE_GETTIMEOFDAY
67 #ifdef _WIN32
68 struct timezone {
69 int tz_minuteswest;
70 int tz_dsttime;
72 #endif
73 struct timezone;
75 int gettimeofday(struct timeval *tv, struct timezone *tz);
77 #endif
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
86 * Now you have 3 ways for the malloc function:
88 * 1. Do not change anything, use the original malloc
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))
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))
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.
104 * clear_malloc can be used if you want to set not initialise
105 * variable to 0.
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.
111 /* #define malloc(_a) clear_malloc(_a)
112 * #define malloc(_a) fill_malloc(_a) */
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 */
119 #ifndef HAVE_STRNLEN
120 size_t strnlen(const char *s, size_t maxlen);
121 #endif /* HAVE_STRNLEN */
123 #ifndef HAVE_USLEEP
124 #ifdef _WIN32
125 static inline unsigned usleep(unsigned int usecs)
127 Sleep((usecs/1000));
128 return 0;
130 #else
131 #if BUILD_ECOSBOARD
132 void usleep(int us);
133 #else
134 #error no usleep defined for your platform
135 #endif
136 #endif
137 #endif /* HAVE_USLEEP */
139 /* Windows specific */
140 #ifdef _WIN32
142 #define WIN32_LEAN_AND_MEAN
143 #include <windows.h>
144 #include <time.h>
146 /* win32 systems do not support ETIMEDOUT */
148 #ifndef ETIMEDOUT
149 #define ETIMEDOUT WSAETIMEDOUT
150 #endif
152 #if IS_MINGW == 1
153 static inline unsigned char inb(unsigned short int port)
155 unsigned char _v;
156 __asm__ __volatile__ ("inb %w1,%0" : "=a" (_v) : "Nd" (port));
157 return _v;
160 static inline void outb(unsigned char value, unsigned short int port)
162 __asm__ __volatile__ ("outb %b0,%w1" : : "a" (value), "Nd" (port));
165 /* mingw does not have ffs, so use gcc builtin types */
166 #define ffs __builtin_ffs
168 #endif /* IS_MINGW */
170 int win_select(int max_fd, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tv);
172 #endif /* _WIN32 */
174 /* generic socket functions for Windows and Posix */
175 static inline int write_socket(int handle, const void *buffer, unsigned int count)
177 #ifdef _WIN32
178 return send(handle, buffer, count, 0);
179 #else
180 return write(handle, buffer, count);
181 #endif
184 static inline int read_socket(int handle, void *buffer, unsigned int count)
186 #ifdef _WIN32
187 return recv(handle, buffer, count, 0);
188 #else
189 return read(handle, buffer, count);
190 #endif
193 static inline int close_socket(int sock)
195 #ifdef _WIN32
196 return closesocket(sock);
197 #else
198 return close(sock);
199 #endif
202 static inline void socket_nonblock(int fd)
204 #ifdef _WIN32
205 unsigned long nonblock = 1;
206 ioctlsocket(fd, FIONBIO, &nonblock);
207 #else
208 int oldopts = fcntl(fd, F_GETFL, 0);
209 fcntl(fd, F_SETFL, oldopts | O_NONBLOCK);
210 #endif
213 static inline int socket_select(int max_fd,
214 fd_set *rfds,
215 fd_set *wfds,
216 fd_set *efds,
217 struct timeval *tv)
219 #ifdef _WIN32
220 return win_select(max_fd, rfds, wfds, efds, tv);
221 #else
222 return select(max_fd, rfds, wfds, efds, tv);
223 #endif
226 #ifndef HAVE_ELF_H
228 #include <helper/types.h>
230 typedef uint32_t Elf32_Addr;
231 typedef uint16_t Elf32_Half;
232 typedef uint32_t Elf32_Off;
233 typedef int32_t Elf32_Sword;
234 typedef uint32_t Elf32_Word;
235 typedef uint32_t Elf32_Size;
236 typedef Elf32_Off Elf32_Hashelt;
238 typedef struct {
239 unsigned char e_ident[16]; /* Magic number and other info */
240 Elf32_Half e_type; /* Object file type */
241 Elf32_Half e_machine; /* Architecture */
242 Elf32_Word e_version; /* Object file version */
243 Elf32_Addr e_entry; /* Entry point virtual address */
244 Elf32_Off e_phoff; /* Program header table file offset */
245 Elf32_Off e_shoff; /* Section header table file offset */
246 Elf32_Word e_flags; /* Processor-specific flags */
247 Elf32_Half e_ehsize; /* ELF header size in bytes */
248 Elf32_Half e_phentsize; /* Program header table entry size */
249 Elf32_Half e_phnum; /* Program header table entry count */
250 Elf32_Half e_shentsize; /* Section header table entry size */
251 Elf32_Half e_shnum; /* Section header table entry count */
252 Elf32_Half e_shstrndx; /* Section header string table index */
253 } Elf32_Ehdr;
255 #define ELFMAG "\177ELF"
256 #define SELFMAG 4
258 #define EI_CLASS 4 /* File class byte index */
259 #define ELFCLASS32 1 /* 32-bit objects */
260 #define ELFCLASS64 2 /* 64-bit objects */
262 #define EI_DATA 5 /* Data encoding byte index */
263 #define ELFDATA2LSB 1 /* 2's complement, little endian */
264 #define ELFDATA2MSB 2 /* 2's complement, big endian */
266 typedef struct {
267 Elf32_Word p_type; /* Segment type */
268 Elf32_Off p_offset; /* Segment file offset */
269 Elf32_Addr p_vaddr; /* Segment virtual address */
270 Elf32_Addr p_paddr; /* Segment physical address */
271 Elf32_Size p_filesz; /* Segment size in file */
272 Elf32_Size p_memsz; /* Segment size in memory */
273 Elf32_Word p_flags; /* Segment flags */
274 Elf32_Size p_align; /* Segment alignment */
275 } Elf32_Phdr;
277 #define PT_LOAD 1 /* Loadable program segment */
279 #endif /* HAVE_ELF_H */
281 #endif /* REPLACEMENTS_H */