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