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, see <http://www.gnu.org/licenses/>. *
  23  ***************************************************************************/
  24
  25 #ifndef OPENOCD_HELPER_REPLACEMENTS_H
  26 #define OPENOCD_HELPER_REPLACEMENTS_H
  27
  28 #include <stdint.h>
  29
  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
  37
  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
  43
  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
  49
  50 #ifndef HAVE_SYS_TIME_H
  51
  52 #ifndef _TIMEVAL_DEFINED
  53 #define _TIMEVAL_DEFINED
  54
  55 struct timeval {
  56         long tv_sec;
  57         long tv_usec;
  58 };
  59
  60 #endif  /* _TIMEVAL_DEFINED */
  61
  62 #endif
  63
  64 /* gettimeofday() */
  65 #ifndef HAVE_GETTIMEOFDAY
  66
  67 #ifdef _WIN32
  68 struct timezone {
  69         int tz_minuteswest;
  70         int tz_dsttime;
  71 };
  72 #endif
  73 struct timezone;
  74
  75 int gettimeofday(struct timeval *tv, struct timezone *tz);
  76
  77 #endif
  78
  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
  84
  85 /*
  86  * Now you have 3 ways for the malloc function:
  87  *
  88  * 1. Do not change anything, use the original malloc
  89  *
  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))
  93  *
  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))
  97  *
  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.
 103  *
 104  * clear_malloc can be used if you want to set not initialise
 105  * variable to 0.
 106  *
 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.
 109  */
 110
 111 /* #define malloc(_a) clear_malloc(_a)
 112  * #define malloc(_a) fill_malloc(_a) */
 113
 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 */
 118
 119 #ifndef HAVE_STRNLEN
 120 size_t strnlen(const char *s, size_t maxlen);
 121 #endif  /* HAVE_STRNLEN */
 122
 123 #ifndef HAVE_USLEEP
 124 #ifdef _WIN32
 125 static inline unsigned usleep(unsigned int usecs)
 126 {
 127         Sleep((usecs/1000));
 128         return 0;
 129 }
 130 #else
 131 #error no usleep defined for your platform
 132 #endif
 133 #endif  /* HAVE_USLEEP */
 134
 135 /* Windows specific */
 136 #ifdef _WIN32
 137
 138 #include <windows.h>
 139 #include <time.h>
 140
 141 /* Windows does not declare sockaddr_un */
 142 #define UNIX_PATH_LEN 108
 143 struct sockaddr_un {
 144         uint16_t sun_family;
 145         char sun_path[UNIX_PATH_LEN];
 146 };
 147
 148 /* win32 systems do not support ETIMEDOUT */
 149
 150 #ifndef ETIMEDOUT
 151 #define ETIMEDOUT WSAETIMEDOUT
 152 #endif
 153
 154 #if IS_MINGW == 1
 155 static inline unsigned char inb(unsigned short int port)
 156 {
 157         unsigned char _v;
 158         __asm__ __volatile__ ("inb %w1,%0" : "=a" (_v) : "Nd" (port));
 159         return _v;
 160 }
 161
 162 static inline void outb(unsigned char value, unsigned short int port)
 163 {
 164         __asm__ __volatile__ ("outb %b0,%w1" : : "a" (value), "Nd" (port));
 165 }
 166
 167 /* mingw does not have ffs, so use gcc builtin types */
 168 #define ffs __builtin_ffs
 169
 170 #endif  /* IS_MINGW */
 171
 172 int win_select(int max_fd, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tv);
 173
 174 #endif  /* _WIN32 */
 175
 176 /* generic socket functions for Windows and Posix */
 177 static inline int write_socket(int handle, const void *buffer, unsigned int count)
 178 {
 179 #ifdef _WIN32
 180         return send(handle, buffer, count, 0);
 181 #else
 182         return write(handle, buffer, count);
 183 #endif
 184 }
 185
 186 static inline int read_socket(int handle, void *buffer, unsigned int count)
 187 {
 188 #ifdef _WIN32
 189         return recv(handle, buffer, count, 0);
 190 #else
 191         return read(handle, buffer, count);
 192 #endif
 193 }
 194
 195 static inline int close_socket(int sock)
 196 {
 197 #ifdef _WIN32
 198         return closesocket(sock);
 199 #else
 200         return close(sock);
 201 #endif
 202 }
 203
 204 static inline void socket_block(int fd)
 205 {
 206 #ifdef _WIN32
 207         unsigned long nonblock = 0;
 208         ioctlsocket(fd, FIONBIO, &nonblock);
 209 #else
 210         int oldopts = fcntl(fd, F_GETFL, 0);
 211         fcntl(fd, F_SETFL, oldopts & ~O_NONBLOCK);
 212 #endif
 213 }
 214
 215 static inline void socket_nonblock(int fd)
 216 {
 217 #ifdef _WIN32
 218         unsigned long nonblock = 1;
 219         ioctlsocket(fd, FIONBIO, &nonblock);
 220 #else
 221         int oldopts = fcntl(fd, F_GETFL, 0);
 222         fcntl(fd, F_SETFL, oldopts | O_NONBLOCK);
 223 #endif
 224 }
 225
 226 static inline int socket_select(int max_fd,
 227         fd_set *rfds,
 228         fd_set *wfds,
 229         fd_set *efds,
 230         struct timeval *tv)
 231 {
 232 #ifdef _WIN32
 233         return win_select(max_fd, rfds, wfds, efds, tv);
 234 #else
 235         return select(max_fd, rfds, wfds, efds, tv);
 236 #endif
 237 }
 238
 239 #ifndef HAVE_ELF_H
 240
 241 typedef uint32_t Elf32_Addr;
 242 typedef uint16_t Elf32_Half;
 243 typedef uint32_t Elf32_Off;
 244 typedef int32_t Elf32_Sword;
 245 typedef uint32_t Elf32_Word;
 246 typedef uint32_t Elf32_Size;
 247 typedef Elf32_Off Elf32_Hashelt;
 248
 249 typedef struct {
 250         unsigned char e_ident[16];      /* Magic number and other info */
 251         Elf32_Half e_type;                      /* Object file type */
 252         Elf32_Half e_machine;                   /* Architecture */
 253         Elf32_Word e_version;                   /* Object file version */
 254         Elf32_Addr e_entry;                     /* Entry point virtual address */
 255         Elf32_Off e_phoff;                      /* Program header table file offset */
 256         Elf32_Off e_shoff;                      /* Section header table file offset */
 257         Elf32_Word e_flags;                     /* Processor-specific flags */
 258         Elf32_Half e_ehsize;                    /* ELF header size in bytes */
 259         Elf32_Half e_phentsize;         /* Program header table entry size */
 260         Elf32_Half e_phnum;                     /* Program header table entry count */
 261         Elf32_Half e_shentsize;         /* Section header table entry size */
 262         Elf32_Half e_shnum;                     /* Section header table entry count */
 263         Elf32_Half 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         Elf32_Word p_type;              /* Segment type */
 279         Elf32_Off p_offset;             /* Segment file offset */
 280         Elf32_Addr p_vaddr;             /* Segment virtual address */
 281         Elf32_Addr p_paddr;             /* Segment physical address */
 282         Elf32_Size p_filesz;    /* Segment size in file */
 283         Elf32_Size p_memsz;             /* Segment size in memory */
 284         Elf32_Word p_flags;             /* Segment flags */
 285         Elf32_Size p_align;             /* Segment alignment */
 286 } Elf32_Phdr;
 287
 288 #define PT_LOAD                 1               /* Loadable program segment */
 289
 290 #endif  /* HAVE_ELF_H */
 291
 292 #if defined HAVE_LIBUSB1 && !defined HAVE_LIBUSB_ERROR_NAME
 293 const char *libusb_error_name(int error_code);
 294 #endif /* defined HAVE_LIBUSB1 && !defined HAVE_LIBUSB_ERROR_NAME */
 295
 296 #endif /* OPENOCD_HELPER_REPLACEMENTS_H */