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