Make #include guard naming consistent
[openocd.git] / src / helper / replacements.h
index 4df7601244013de95d1e1a7baa081e722fff0b82..1e2fbf20f9ef349484cd48dde2aefcc12aede0cd 100644 (file)
@@ -2,6 +2,12 @@
  *   Copyright (C) 2006 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
+ *   Copyright (C) 2007,2008 Ã˜yvind Harboe                                 *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
+ *   Copyright (C) 2008 by Spencer Oliver                                  *
+ *   spen@spen-soft.co.uk                                                  *
+ *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   the Free Software Foundation; either version 2 of the License, or     *
  *   GNU General Public License for more details.                          *
  *                                                                         *
  *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
-#ifndef REPLACEMENTS_H
-#define REPLACEMENTS_H
-
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
 
-#include "types.h"
+#ifndef OPENOCD_HELPER_REPLACEMENTS_H
+#define OPENOCD_HELPER_REPLACEMENTS_H
 
-#if BUILD_ECOSBOARD
-#include <pkgconf/system.h>
-#include <stdlib.h>
-#include <sys/select.h>
+/* MIN,MAX macros */
+#ifndef MIN
+#define MIN(a, b) (((a) < (b)) ? (a) : (b))
 #endif
-
-/* include necessary headers for socket functionality */
-#ifdef _WIN32
-#include <winsock2.h>
-#else
-#include <sys/socket.h>
-#include <sys/poll.h>
-#include <netinet/in.h>
-#include <unistd.h>
-#include <fcntl.h>
+#ifndef MAX
+#define MAX(a, b) (((a) > (b)) ? (a) : (b))
 #endif
 
-#ifdef HAVE_SYS_PARAM_H
-#include <sys/param.h> /* for MIN/MAX macros */
+/* for systems that do not support ENOTSUP
+ * win32 being one of them */
+#ifndef ENOTSUP
+#define ENOTSUP 134            /* Not supported */
 #endif
 
-/* MIN,MAX macros */
-#ifndef MIN
-#define MIN(a,b) (((a)<(b))?(a):(b))
+/* for systems that do not support O_BINARY
+ * linux being one of them */
+#ifndef O_BINARY
+#define O_BINARY 0
 #endif
-#ifndef MAX
-#define MAX(a,b) (((a)>(b))?(a):(b))
-#endif
-                                                                                                                                
-/* gettimeofday() */
-#ifndef HAVE_GETTIMEOFDAY
+
+#ifndef HAVE_SYS_TIME_H
 
 #ifndef _TIMEVAL_DEFINED
 #define _TIMEVAL_DEFINED
@@ -65,19 +54,31 @@ struct timeval {
        long tv_sec;
        long tv_usec;
 };
-#endif /* _TIMEVAL_DEFINED */
 
+#endif /* _TIMEVAL_DEFINED */
+
+#endif
+
+/* gettimeofday() */
+#ifndef HAVE_GETTIMEOFDAY
+
+#ifdef _WIN32
 struct timezone {
-    int tz_minuteswest;
+       int tz_minuteswest;
        int tz_dsttime;
 };
+#endif
+struct timezone;
+
+int gettimeofday(struct timeval *tv, struct timezone *tz);
 
-extern int gettimeofday(struct timeval *tv, struct timezone *tz);
 #endif
 
+#ifndef IN_REPLACEMENTS_C
 /**** clear_malloc & fill_malloc ****/
 void *clear_malloc(size_t size);
 void *fill_malloc(size_t size);
+#endif
 
 /*
  * Now you have 3 ways for the malloc function:
@@ -94,152 +95,189 @@ void *fill_malloc(size_t size);
  *
  * We have figured out that there could exist some malloc problems
  * where variables are using without to be initialise. To find this
- * places, use the fill_malloc function. With this function we want 
- * to initialize memory to some known bad state. This is quite easily 
- * spotted in the debugger and will trap to an invalid address. 
+ * places, use the fill_malloc function. With this function we want
+ * to initialize memory to some known bad state. This is quite easily
+ * spotted in the debugger and will trap to an invalid address.
  *
- * clear_malloc can be used if you want to set not initialise 
+ * clear_malloc can be used if you want to set not initialise
  * variable to 0.
  *
  * If you do not want to change the malloc function, to not use one of
  * the following macros. Which is the default way.
  */
-/* #define malloc(_a) clear_malloc(_a) */
-/* #define malloc(_a) fill_malloc(_a) */
+
+/* #define malloc(_a) clear_malloc(_a)
+ * #define malloc(_a) fill_malloc(_a) */
 
 /* GNU extensions to the C library that may be missing on some systems */
 #ifndef HAVE_STRNDUP
-extern char* strndup(const char *s, size_t n);
-#endif /* HAVE_STRNDUP */
+char *strndup(const char *s, size_t n);
+#endif /* HAVE_STRNDUP */
 
 #ifndef HAVE_STRNLEN
-extern size_t strnlen(const char *s, size_t maxlen);
-#endif /* HAVE_STRNLEN */
+size_t strnlen(const char *s, size_t maxlen);
+#endif /* HAVE_STRNLEN */
 
 #ifndef HAVE_USLEEP
 #ifdef _WIN32
-static __inline unsigned usleep(unsigned int usecs)
+static inline unsigned usleep(unsigned int usecs)
 {
        Sleep((usecs/1000));
        return 0;
 }
 #else
-#if BUILD_ECOSBOARD
-void usleep(int us);
-#else 
 #error no usleep defined for your platform
 #endif
-#endif
-#endif /* HAVE_USLEEP */
+#endif /* HAVE_USLEEP */
 
 /* Windows specific */
 #ifdef _WIN32
 
-#define WIN32_LEAN_AND_MEAN
 #include <windows.h>
 #include <time.h>
 
+/* Windows does not declare sockaddr_un */
+#define UNIX_PATH_LEN 108
+struct sockaddr_un {
+       uint16_t sun_family;
+       char sun_path[UNIX_PATH_LEN];
+};
+
+/* win32 systems do not support ETIMEDOUT */
+
+#ifndef ETIMEDOUT
+#define ETIMEDOUT WSAETIMEDOUT
+#endif
+
 #if IS_MINGW == 1
-static __inline unsigned char inb(unsigned short int port)
+static inline unsigned char inb(unsigned short int port)
 {
        unsigned char _v;
-       __asm__ __volatile__ ("inb %w1,%0":"=a" (_v):"Nd" (port));
+       __asm__ __volatile__ ("inb %w1,%0" : "=a" (_v) : "Nd" (port));
        return _v;
 }
 
-static __inline void outb(unsigned char value, unsigned short int port)
+static inline void outb(unsigned char value, unsigned short int port)
 {
-       __asm__ __volatile__ ("outb %b0,%w1": :"a" (value), "Nd" (port));
+       __asm__ __volatile__ ("outb %b0,%w1" : : "a" (value), "Nd" (port));
 }
 
-#endif /* IS_MINGW */
-#endif  /* _WIN32 */
+/* mingw does not have ffs, so use gcc builtin types */
+#define ffs __builtin_ffs
+
+#endif /* IS_MINGW */
+
+int win_select(int max_fd, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tv);
+
+#endif /* _WIN32 */
 
 /* generic socket functions for Windows and Posix */
-static __inline int write_socket( int handle, const void *buffer, unsigned int count )
+static inline int write_socket(int handle, const void *buffer, unsigned int count)
 {
 #ifdef _WIN32
-    return send(handle, buffer, count, 0);
+       return send(handle, buffer, count, 0);
 #else
-    return write(handle, buffer, count);
+       return write(handle, buffer, count);
 #endif
 }
 
-static __inline int read_socket( int handle, void *buffer, unsigned int count )
+static inline int read_socket(int handle, void *buffer, unsigned int count)
 {
 #ifdef _WIN32
-    return recv(handle, buffer, count, 0);
+       return recv(handle, buffer, count, 0);
 #else
-    return read(handle, buffer, count);
+       return read(handle, buffer, count);
 #endif
 }
 
-static __inline int close_socket(int sock)
+static inline int close_socket(int sock)
 {
 #ifdef _WIN32
-    return closesocket(sock);
+       return closesocket(sock);
 #else
-    return close(sock);
+       return close(sock);
 #endif
 }
 
-static __inline void socket_nonblock(int fd)
+static inline void socket_nonblock(int fd)
 {
 #ifdef _WIN32
-       long nonblock = 1;
-       ioctlsocket(fd, FIONBIO, &nonblock );
+       unsigned long nonblock = 1;
+       ioctlsocket(fd, FIONBIO, &nonblock);
 #else
        int oldopts = fcntl(fd, F_GETFL, 0);
        fcntl(fd, F_SETFL, oldopts | O_NONBLOCK);
 #endif
 }
 
-#ifndef HAVE_ELF_H
-
-typedef struct
+static inline int socket_select(int max_fd,
+       fd_set *rfds,
+       fd_set *wfds,
+       fd_set *efds,
+       struct timeval *tv)
 {
-       unsigned char   e_ident[16];    /* Magic number and other info */
-       u16     e_type;                 /* Object file type */
-       u16     e_machine;              /* Architecture */
-       u32     e_version;              /* Object file version */
-       u32 e_entry;            /* Entry point virtual address */
-       u32 e_phoff;            /* Program header table file offset */
-       u32     e_shoff;                /* Section header table file offset */
-       u32     e_flags;                /* Processor-specific flags */
-       u16     e_ehsize;               /* ELF header size in bytes */
-       u16     e_phentsize;            /* Program header table entry size */
-       u16     e_phnum;                /* Program header table entry count */
-       u16     e_shentsize;            /* Section header table entry size */
-       u16     e_shnum;                /* Section header table entry count */
-       u16     e_shstrndx;             /* Section header string table index */
-} Elf32_Ehdr;
-
-#define        ELFMAG          "\177ELF"
-#define        SELFMAG         4
+#ifdef _WIN32
+       return win_select(max_fd, rfds, wfds, efds, tv);
+#else
+       return select(max_fd, rfds, wfds, efds, tv);
+#endif
+}
 
-#define EI_CLASS       4               /* File class byte index */
-#define ELFCLASS32     1               /* 32-bit objects */
-#define ELFCLASS64     2               /* 64-bit objects */
+#ifndef HAVE_ELF_H
 
-#define EI_DATA                5               /* Data encoding byte index */
-#define ELFDATA2LSB    1               /* 2's complement, little endian */
-#define ELFDATA2MSB    2               /* 2's complement, big endian */
+typedef uint32_t Elf32_Addr;
+typedef uint16_t Elf32_Half;
+typedef uint32_t Elf32_Off;
+typedef int32_t Elf32_Sword;
+typedef uint32_t Elf32_Word;
+typedef uint32_t Elf32_Size;
+typedef Elf32_Off Elf32_Hashelt;
+
+typedef struct {
+       unsigned char e_ident[16];      /* Magic number and other info */
+       Elf32_Half e_type;                      /* Object file type */
+       Elf32_Half e_machine;                   /* Architecture */
+       Elf32_Word e_version;                   /* Object file version */
+       Elf32_Addr e_entry;                     /* Entry point virtual address */
+       Elf32_Off e_phoff;                      /* Program header table file offset */
+       Elf32_Off e_shoff;                      /* Section header table file offset */
+       Elf32_Word e_flags;                     /* Processor-specific flags */
+       Elf32_Half e_ehsize;                    /* ELF header size in bytes */
+       Elf32_Half e_phentsize;         /* Program header table entry size */
+       Elf32_Half e_phnum;                     /* Program header table entry count */
+       Elf32_Half e_shentsize;         /* Section header table entry size */
+       Elf32_Half e_shnum;                     /* Section header table entry count */
+       Elf32_Half e_shstrndx;                  /* Section header string table index */
+} Elf32_Ehdr;
 
-typedef struct
-{
-       u32 p_type;                     /* Segment type */
-       u32 p_offset;           /* Segment file offset */
-       u32 p_vaddr;            /* Segment virtual address */
-       u32 p_paddr;            /* Segment physical address */
-       u32 p_filesz;           /* Segment size in file */
-       u32 p_memsz;            /* Segment size in memory */
-       u32 p_flags;            /* Segment flags */
-       u32 p_align;            /* Segment alignment */
+#define ELFMAG                 "\177ELF"
+#define SELFMAG                        4
+
+#define EI_CLASS               4               /* File class byte index */
+#define ELFCLASS32             1               /* 32-bit objects */
+#define ELFCLASS64             2               /* 64-bit objects */
+
+#define EI_DATA                        5               /* Data encoding byte index */
+#define ELFDATA2LSB            1               /* 2's complement, little endian */
+#define ELFDATA2MSB            2               /* 2's complement, big endian */
+
+typedef struct {
+       Elf32_Word p_type;              /* Segment type */
+       Elf32_Off p_offset;             /* Segment file offset */
+       Elf32_Addr p_vaddr;             /* Segment virtual address */
+       Elf32_Addr p_paddr;             /* Segment physical address */
+       Elf32_Size p_filesz;    /* Segment size in file */
+       Elf32_Size p_memsz;             /* Segment size in memory */
+       Elf32_Word p_flags;             /* Segment flags */
+       Elf32_Size p_align;             /* Segment alignment */
 } Elf32_Phdr;
 
-#define PT_LOAD                1               /* Loadable program segment */
+#define PT_LOAD                        1               /* Loadable program segment */
+
+#endif /* HAVE_ELF_H */
 
-#endif /* HAVE_ELF_H */
+#if defined HAVE_LIBUSB1 && !defined HAVE_LIBUSB_ERROR_NAME
+const char *libusb_error_name(int error_code);
+#endif /* defined HAVE_LIBUSB1 && !defined HAVE_LIBUSB_ERROR_NAME */
 
-#endif /* REPLACEMENTS_H */
+#endif /* OPENOCD_HELPER_REPLACEMENTS_H */

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)