git-svn-id: svn://svn.berlios.de/openocd/trunk@228 b42882b7-edfa-0310-969c-e2dbd0fdcd60
[fw/openocd] / src / helper / replacements.h
1 /***************************************************************************
2  *   Copyright (C) 2006 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   This program is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU General Public License as published by  *
7  *   the Free Software Foundation; either version 2 of the License, or     *
8  *   (at your option) any later version.                                   *
9  *                                                                         *
10  *   This program is distributed in the hope that it will be useful,       *
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
13  *   GNU General Public License for more details.                          *
14  *                                                                         *
15  *   You should have received a copy of the GNU General Public License     *
16  *   along with this program; if not, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
19  ***************************************************************************/
20 #ifndef REPLACEMENTS_H
21 #define REPLACEMENTS_H
22
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26
27 #include "types.h"
28
29 /* include necessary headers for socket functionality */
30 #ifdef _WIN32
31 #include <winsock2.h>
32 #else
33 #include <sys/socket.h>
34 #include <sys/poll.h>
35 #include <netinet/in.h>
36 #include <unistd.h>
37 #include <fcntl.h>
38 #endif
39
40 #ifdef HAVE_SYS_PARAM_H
41 #include <sys/param.h> /* for MIN/MAX macros */
42 #endif
43
44 /* MIN,MAX macros */
45 #ifndef MIN
46 #define MIN(a,b) (((a)<(b))?(a):(b))
47 #endif
48 #ifndef MAX
49 #define MAX(a,b) (((a)>(b))?(a):(b))
50 #endif
51                                                                                                                                  
52 /* gettimeofday() */
53 #ifndef HAVE_GETTIMEOFDAY
54
55 #ifndef _TIMEVAL_DEFINED
56 #define _TIMEVAL_DEFINED
57
58 struct timeval {
59         long tv_sec;
60         long tv_usec;
61 };
62 #endif /* _TIMEVAL_DEFINED */
63
64 struct timezone {
65     int tz_minuteswest;
66         int tz_dsttime;
67 };
68
69 extern int gettimeofday(struct timeval *tv, struct timezone *tz);
70 #endif\r
71 \r
72 /**** clear_malloc & fill_malloc ****/
73 void *clear_malloc(size_t size);
74 void *fill_malloc(size_t size);
75 \r
76 /*\r
77  * Now you have 3 ways for the malloc function:\r
78  *\r
79  * 1. Do not change anything, use the original malloc\r
80  *\r
81  * 2. Use the clear_malloc function instead of the original malloc.\r
82  *    In this case you must use the following define:\r
83  *    #define malloc((_a)) clear_malloc((_a))\r
84  *\r
85  * 3. Use the fill_malloc function instead of the original malloc.\r
86  *    In this case you must use the following define:\r
87  *    #define malloc((_a)) fill_malloc((_a))\r
88  *\r
89  * We have figured out that there could exist some malloc problems\r
90  * where variables are using without to be initialise. To find this\r
91  * places, use the fill_malloc function. With this function we want \r
92  * to initialize memory to some known bad state. This is quite easily \r
93  * spotted in the debugger and will trap to an invalid address. \r
94  *\r
95  * clear_malloc can be used if you want to set not initialise \r
96  * variable to 0.\r
97  *\r
98  * If you do not want to change the malloc function, to not use one of\r
99  * the following macros. Which is the default way.\r
100  */\r
101 //#define malloc((_a)) clear_malloc((_a))
102 //#define malloc((_a)) fill_malloc((_a))
103
104 /* GNU extensions to the C library that may be missing on some systems */
105 #ifndef HAVE_STRNDUP
106 extern char* strndup(const char *s, size_t n);
107 #endif /* HAVE_STRNDUP */
108
109 #ifndef HAVE_STRNLEN
110 extern size_t strnlen(const char *s, size_t maxlen);
111 #endif /* HAVE_STRNLEN */
112
113 #ifndef HAVE_USLEEP
114 static __inline unsigned usleep(unsigned int usecs)
115 {
116 #ifdef _WIN32
117         Sleep((usecs/1000));
118         return 0;
119 #else
120 #error no usleep defined for your platform
121 #endif
122 }
123 #endif /* HAVE_USLEEP */
124
125 /* Windows specific */
126 #ifdef _WIN32
127
128 #define WIN32_LEAN_AND_MEAN
129 #include <windows.h>
130 #include <time.h>
131
132 #undef ERROR
133
134 #if IS_MINGW == 1
135 static __inline unsigned char inb(unsigned short int port)
136 {
137         unsigned char _v;
138         __asm__ __volatile__ ("inb %w1,%0":"=a" (_v):"Nd" (port));
139         return _v;
140 }
141
142 static __inline void outb(unsigned char value, unsigned short int port)
143 {
144         __asm__ __volatile__ ("outb %b0,%w1": :"a" (value), "Nd" (port));
145 }
146
147 #endif /* IS_MINGW */
148 #endif  /* _WIN32 */
149
150 /* generic socket functions for Windows and Posix */
151 static __inline int write_socket( int handle, const void *buffer, unsigned int count )
152 {
153 #ifdef _WIN32
154     return send(handle, buffer, count, 0);
155 #else
156     return write(handle, buffer, count);
157 #endif
158 }
159
160 static __inline int read_socket( int handle, void *buffer, unsigned int count )
161 {
162 #ifdef _WIN32
163     return recv(handle, buffer, count, 0);
164 #else
165     return read(handle, buffer, count);
166 #endif
167 }
168
169 static __inline int close_socket(int sock)
170 {
171 #ifdef _WIN32
172     return closesocket(sock);
173 #else
174     return close(sock);
175 #endif
176 }
177
178 static __inline void socket_nonblock(int fd)
179 {
180 #ifdef _WIN32
181         long nonblock = 1;
182         ioctlsocket(fd, FIONBIO, &nonblock );
183 #else
184         int oldopts = fcntl(fd, F_GETFL, 0);
185         fcntl(fd, F_SETFL, oldopts | O_NONBLOCK);
186 #endif
187 }
188
189 #ifndef HAVE_ELF_H
190
191 typedef struct
192 {
193         unsigned char   e_ident[16];    /* Magic number and other info */
194         u16     e_type;                 /* Object file type */
195         u16     e_machine;              /* Architecture */
196         u32     e_version;              /* Object file version */
197         u32 e_entry;            /* Entry point virtual address */
198         u32 e_phoff;            /* Program header table file offset */
199         u32     e_shoff;                /* Section header table file offset */
200         u32     e_flags;                /* Processor-specific flags */
201         u16     e_ehsize;               /* ELF header size in bytes */
202         u16     e_phentsize;            /* Program header table entry size */
203         u16     e_phnum;                /* Program header table entry count */
204         u16     e_shentsize;            /* Section header table entry size */
205         u16     e_shnum;                /* Section header table entry count */
206         u16     e_shstrndx;             /* Section header string table index */
207 } Elf32_Ehdr;
208
209 #define ELFMAG          "\177ELF"
210 #define SELFMAG         4
211
212 #define EI_CLASS        4               /* File class byte index */
213 #define ELFCLASS32      1               /* 32-bit objects */
214 #define ELFCLASS64      2               /* 64-bit objects */
215
216 #define EI_DATA         5               /* Data encoding byte index */
217 #define ELFDATA2LSB     1               /* 2's complement, little endian */
218 #define ELFDATA2MSB     2               /* 2's complement, big endian */
219
220 typedef struct
221 {
222         u32 p_type;                     /* Segment type */
223         u32 p_offset;           /* Segment file offset */
224         u32 p_vaddr;            /* Segment virtual address */
225         u32 p_paddr;            /* Segment physical address */
226         u32 p_filesz;           /* Segment size in file */
227         u32 p_memsz;            /* Segment size in memory */
228         u32 p_flags;            /* Segment flags */
229         u32 p_align;            /* Segment alignment */
230 } Elf32_Phdr;
231
232 #define PT_LOAD         1               /* Loadable program segment */
233
234 #endif /* HAVE_ELF_H */
235
236 #endif /* REPLACEMENTS_H */