Remove FSF address from GPL notices
[openocd.git] / src / helper / replacements.h
blobb6cf7f55a485d1304fafbe8f49bd8a16a18503bf
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, see <http://www.gnu.org/licenses/>. *
23 ***************************************************************************/
25 #ifndef REPLACEMENTS_H
26 #define REPLACEMENTS_H
28 /* MIN,MAX macros */
29 #ifndef MIN
30 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
31 #endif
32 #ifndef MAX
33 #define MAX(a, b) (((a) > (b)) ? (a) : (b))
34 #endif
36 /* for systems that do not support ENOTSUP
37 * win32 being one of them */
38 #ifndef ENOTSUP
39 #define ENOTSUP 134 /* Not supported */
40 #endif
42 /* for systems that do not support O_BINARY
43 * linux being one of them */
44 #ifndef O_BINARY
45 #define O_BINARY 0
46 #endif
48 #ifndef HAVE_SYS_TIME_H
50 #ifndef _TIMEVAL_DEFINED
51 #define _TIMEVAL_DEFINED
53 struct timeval {
54 long tv_sec;
55 long tv_usec;
58 #endif /* _TIMEVAL_DEFINED */
60 #endif
62 /* gettimeofday() */
63 #ifndef HAVE_GETTIMEOFDAY
65 #ifdef _WIN32
66 struct timezone {
67 int tz_minuteswest;
68 int tz_dsttime;
70 #endif
71 struct timezone;
73 int gettimeofday(struct timeval *tv, struct timezone *tz);
75 #endif
77 #ifndef IN_REPLACEMENTS_C
78 /**** clear_malloc & fill_malloc ****/
79 void *clear_malloc(size_t size);
80 void *fill_malloc(size_t size);
81 #endif
84 * Now you have 3 ways for the malloc function:
86 * 1. Do not change anything, use the original malloc
88 * 2. Use the clear_malloc function instead of the original malloc.
89 * In this case you must use the following define:
90 * #define malloc((_a)) clear_malloc((_a))
92 * 3. Use the fill_malloc function instead of the original malloc.
93 * In this case you must use the following define:
94 * #define malloc((_a)) fill_malloc((_a))
96 * We have figured out that there could exist some malloc problems
97 * where variables are using without to be initialise. To find this
98 * places, use the fill_malloc function. With this function we want
99 * to initialize memory to some known bad state. This is quite easily
100 * spotted in the debugger and will trap to an invalid address.
102 * clear_malloc can be used if you want to set not initialise
103 * variable to 0.
105 * If you do not want to change the malloc function, to not use one of
106 * the following macros. Which is the default way.
109 /* #define malloc(_a) clear_malloc(_a)
110 * #define malloc(_a) fill_malloc(_a) */
112 /* GNU extensions to the C library that may be missing on some systems */
113 #ifndef HAVE_STRNDUP
114 char *strndup(const char *s, size_t n);
115 #endif /* HAVE_STRNDUP */
117 #ifndef HAVE_STRNLEN
118 size_t strnlen(const char *s, size_t maxlen);
119 #endif /* HAVE_STRNLEN */
121 #ifndef HAVE_USLEEP
122 #ifdef _WIN32
123 static inline unsigned usleep(unsigned int usecs)
125 Sleep((usecs/1000));
126 return 0;
128 #else
129 #error no usleep defined for your platform
130 #endif
131 #endif /* HAVE_USLEEP */
133 /* Windows specific */
134 #ifdef _WIN32
136 #include <windows.h>
137 #include <time.h>
139 /* Windows does not declare sockaddr_un */
140 #define UNIX_PATH_LEN 108
141 struct sockaddr_un {
142 uint16_t sun_family;
143 char sun_path[UNIX_PATH_LEN];
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 typedef uint32_t Elf32_Addr;
229 typedef uint16_t Elf32_Half;
230 typedef uint32_t Elf32_Off;
231 typedef int32_t Elf32_Sword;
232 typedef uint32_t Elf32_Word;
233 typedef uint32_t Elf32_Size;
234 typedef Elf32_Off Elf32_Hashelt;
236 typedef struct {
237 unsigned char e_ident[16]; /* Magic number and other info */
238 Elf32_Half e_type; /* Object file type */
239 Elf32_Half e_machine; /* Architecture */
240 Elf32_Word e_version; /* Object file version */
241 Elf32_Addr e_entry; /* Entry point virtual address */
242 Elf32_Off e_phoff; /* Program header table file offset */
243 Elf32_Off e_shoff; /* Section header table file offset */
244 Elf32_Word e_flags; /* Processor-specific flags */
245 Elf32_Half e_ehsize; /* ELF header size in bytes */
246 Elf32_Half e_phentsize; /* Program header table entry size */
247 Elf32_Half e_phnum; /* Program header table entry count */
248 Elf32_Half e_shentsize; /* Section header table entry size */
249 Elf32_Half e_shnum; /* Section header table entry count */
250 Elf32_Half e_shstrndx; /* Section header string table index */
251 } Elf32_Ehdr;
253 #define ELFMAG "\177ELF"
254 #define SELFMAG 4
256 #define EI_CLASS 4 /* File class byte index */
257 #define ELFCLASS32 1 /* 32-bit objects */
258 #define ELFCLASS64 2 /* 64-bit objects */
260 #define EI_DATA 5 /* Data encoding byte index */
261 #define ELFDATA2LSB 1 /* 2's complement, little endian */
262 #define ELFDATA2MSB 2 /* 2's complement, big endian */
264 typedef struct {
265 Elf32_Word p_type; /* Segment type */
266 Elf32_Off p_offset; /* Segment file offset */
267 Elf32_Addr p_vaddr; /* Segment virtual address */
268 Elf32_Addr p_paddr; /* Segment physical address */
269 Elf32_Size p_filesz; /* Segment size in file */
270 Elf32_Size p_memsz; /* Segment size in memory */
271 Elf32_Word p_flags; /* Segment flags */
272 Elf32_Size p_align; /* Segment alignment */
273 } Elf32_Phdr;
275 #define PT_LOAD 1 /* Loadable program segment */
277 #endif /* HAVE_ELF_H */
279 #if defined HAVE_LIBUSB1 && !defined HAVE_LIBUSB_ERROR_NAME
280 const char *libusb_error_name(int error_code);
281 #endif /* defined HAVE_LIBUSB1 && !defined HAVE_LIBUSB_ERROR_NAME */
283 #endif /* REPLACEMENTS_H */