helper/types.h: Add missing #includes
[openocd.git] / src / helper / types.h
index f993ba21dc848ad20773fe71e5614e03f34daf72..a7dd2a8164982a37cb589ccc221c08f8d5fa8310 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2004, 2005 by Dominic Rath                              *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   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 TYPES_H
-#define TYPES_H
 
+#ifndef OPENOCD_HELPER_TYPES_H
+#define OPENOCD_HELPER_TYPES_H
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <stddef.h>
+#include <assert.h>
 #ifdef HAVE_SYS_TYPES_H
 #include <sys/types.h>
 #endif
 #ifdef HAVE_STDINT_H
 #include <stdint.h>
 #endif
-
-#ifndef u8
-typedef unsigned char u8;
-#endif
-
-#ifndef u16
-typedef unsigned short u16;
-#endif
-
-#ifndef u32
-typedef unsigned int u32;
-#endif
-
-#ifndef u64
-typedef unsigned long long u64;
+#ifdef HAVE_INTTYPES_H
+#include <inttypes.h>
 #endif
 
-typedef struct jtag_tap_s jtag_tap_t;
-
 #ifdef HAVE_STDBOOL_H
 #include <stdbool.h>
 #else  /* HAVE_STDBOOL_H */
@@ -69,6 +59,43 @@ typedef bool _Bool;
 
 #endif /* HAVE_STDBOOL_H */
 
+/// turns a macro argument into a string constant
+#define stringify(s) __stringify(s)
+#define __stringify(s) #s
+
+
+/**
+ * Compute the number of elements of a variable length array.
+ * <code>
+ * const char *strs[] = { "a", "b", "c" };
+ * unsigned num_strs = ARRAY_SIZE(strs);
+ * </code>
+ */
+#define ARRAY_SIZE(x) (sizeof(x) / sizeof(*(x)))
+
+
+/**
+ * Cast a member of a structure out to the containing structure.
+ * @param ptr The pointer to the member.
+ * @param type The type of the container struct this is embedded in.
+ * @param member The name of the member within the struct.
+ *
+ * This is a mechanism which is used throughout the Linux kernel.
+ */
+#define container_of(ptr, type, member) ({                     \
+       const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
+       (type *)( (void *) ( (char *)__mptr - offsetof(type,member) ) );})
+
+
+/**
+ * Rounds @c m up to the nearest multiple of @c n using division.
+ * @param m The value to round up to @c n.
+ * @param n Round @c m up to a multiple of this number.
+ * @returns The rounded integer value.
+ */
+#define DIV_ROUND_UP(m, n)     (((m) + (n) - 1) / (n))
+
+
 /* DANGER!!!! here be dragons!
  *
  * Leave these fn's as byte accesses because it is safe
@@ -87,72 +114,258 @@ typedef bool _Bool;
  * Again, note that the "buf" pointer in memory is probably unaligned.
  */
 
+static inline uint64_t le_to_h_u64(const uint8_t *buf)
+{
+       return (uint64_t)((uint64_t)buf[0] |
+                         (uint64_t)buf[1] << 8 |
+                         (uint64_t)buf[2] << 16 |
+                         (uint64_t)buf[3] << 24 |
+                         (uint64_t)buf[4] << 32 |
+                         (uint64_t)buf[5] << 40 |
+                         (uint64_t)buf[6] << 48 |
+                         (uint64_t)buf[7] << 56);
+}
+
+static inline uint32_t le_to_h_u32(const uint8_t* buf)
+{
+       return (uint32_t)(buf[0] | buf[1] << 8 | buf[2] << 16 | buf[3] << 24);
+}
+
+static inline uint32_t le_to_h_u24(const uint8_t* buf)
+{
+       return (uint32_t)(buf[0] | buf[1] << 8 | buf[2] << 16);
+}
+
+static inline uint16_t le_to_h_u16(const uint8_t* buf)
+{
+       return (uint16_t)(buf[0] | buf[1] << 8);
+}
+
+static inline uint64_t be_to_h_u64(const uint8_t *buf)
+{
+       return (uint64_t)((uint64_t)buf[7] |
+                         (uint64_t)buf[6] << 8 |
+                         (uint64_t)buf[5] << 16 |
+                         (uint64_t)buf[4] << 24 |
+                         (uint64_t)buf[3] << 32 |
+                         (uint64_t)buf[2] << 40 |
+                         (uint64_t)buf[1] << 48 |
+                         (uint64_t)buf[0] << 56);
+}
+
+static inline uint32_t be_to_h_u32(const uint8_t* buf)
+{
+       return (uint32_t)(buf[3] | buf[2] << 8 | buf[1] << 16 | buf[0] << 24);
+}
+
+static inline uint32_t be_to_h_u24(const uint8_t* buf)
+{
+       return (uint32_t)(buf[2] | buf[1] << 8 | buf[0] << 16);
+}
+
+static inline uint16_t be_to_h_u16(const uint8_t* buf)
+{
+       return (uint16_t)(buf[1] | buf[0] << 8);
+}
+
+static inline void h_u64_to_le(uint8_t *buf, int64_t val)
+{
+       buf[7] = (uint8_t) (val >> 56);
+       buf[6] = (uint8_t) (val >> 48);
+       buf[5] = (uint8_t) (val >> 40);
+       buf[4] = (uint8_t) (val >> 32);
+       buf[3] = (uint8_t) (val >> 24);
+       buf[2] = (uint8_t) (val >> 16);
+       buf[1] = (uint8_t) (val >> 8);
+       buf[0] = (uint8_t) (val >> 0);
+}
+
+static inline void h_u64_to_be(uint8_t *buf, int64_t val)
+{
+       buf[0] = (uint8_t) (val >> 56);
+       buf[1] = (uint8_t) (val >> 48);
+       buf[2] = (uint8_t) (val >> 40);
+       buf[3] = (uint8_t) (val >> 32);
+       buf[4] = (uint8_t) (val >> 24);
+       buf[5] = (uint8_t) (val >> 16);
+       buf[6] = (uint8_t) (val >> 8);
+       buf[7] = (uint8_t) (val >> 0);
+}
+
+static inline void h_u32_to_le(uint8_t* buf, int val)
+{
+       buf[3] = (uint8_t) (val >> 24);
+       buf[2] = (uint8_t) (val >> 16);
+       buf[1] = (uint8_t) (val >> 8);
+       buf[0] = (uint8_t) (val >> 0);
+}
 
-static inline u32 le_to_h_u32(const u8* buf)
+static inline void h_u32_to_be(uint8_t* buf, int val)
 {
-       return (u32)(buf[0] | buf[1] << 8 | buf[2] << 16 | buf[3] << 24);
+       buf[0] = (uint8_t) (val >> 24);
+       buf[1] = (uint8_t) (val >> 16);
+       buf[2] = (uint8_t) (val >> 8);
+       buf[3] = (uint8_t) (val >> 0);
 }
 
-static inline u16 le_to_h_u16(const u8* buf)
+static inline void h_u24_to_le(uint8_t* buf, int val)
 {
-       return (u16)(buf[0] | buf[1] << 8);
+       buf[2] = (uint8_t) (val >> 16);
+       buf[1] = (uint8_t) (val >> 8);
+       buf[0] = (uint8_t) (val >> 0);
 }
 
-static inline u32 be_to_h_u32(const u8* buf)
+static inline void h_u24_to_be(uint8_t* buf, int val)
 {
-       return (u32)(buf[3] | buf[2] << 8 | buf[1] << 16 | buf[0] << 24);
+       buf[0] = (uint8_t) (val >> 16);
+       buf[1] = (uint8_t) (val >> 8);
+       buf[2] = (uint8_t) (val >> 0);
 }
 
-static inline u16 be_to_h_u16(const u8* buf)
+static inline void h_u16_to_le(uint8_t* buf, int val)
 {
-       return (u16)(buf[1] | buf[0] << 8);
+       buf[1] = (uint8_t) (val >> 8);
+       buf[0] = (uint8_t) (val >> 0);
 }
 
-static inline void h_u32_to_le(u8* buf, int val)
+static inline void h_u16_to_be(uint8_t* buf, int val)
 {
-       buf[3] = (u8) (val >> 24);
-       buf[2] = (u8) (val >> 16);
-       buf[1] = (u8) (val >> 8);
-       buf[0] = (u8) (val >> 0);
+       buf[0] = (uint8_t) (val >> 8);
+       buf[1] = (uint8_t) (val >> 0);
 }
 
-static inline void h_u32_to_be(u8* buf, int val)
+/**
+ * Byte-swap buffer 16-bit.
+ *
+ * Len must be even, dst and src must be either the same or non-overlapping.
+ *
+ * @param dst Destination buffer.
+ * @param src Source buffer.
+ * @param len Length of source (and destination) buffer, in bytes.
+ */
+static inline void buf_bswap16(uint8_t *dst, const uint8_t *src, size_t len)
 {
-       buf[0] = (u8) (val >> 24);
-       buf[1] = (u8) (val >> 16);
-       buf[2] = (u8) (val >> 8);
-       buf[3] = (u8) (val >> 0);
+       assert(len % 2 == 0);
+       assert(dst == src || dst + len <= src || src + len <= dst);
+
+       for (size_t n = 0; n < len; n += 2) {
+               uint16_t x = be_to_h_u16(src + n);
+               h_u16_to_le(dst + n, x);
+       }
 }
 
-static inline void h_u16_to_le(u8* buf, int val)
+/**
+ * Byte-swap buffer 32-bit.
+ *
+ * Len must be divisible by four, dst and src must be either the same or non-overlapping.
+ *
+ * @param dst Destination buffer.
+ * @param src Source buffer.
+ * @param len Length of source (and destination) buffer, in bytes.
+ */
+static inline void buf_bswap32(uint8_t *dst, const uint8_t *src, size_t len)
 {
-       buf[1] = (u8) (val >> 8);
-       buf[0] = (u8) (val >> 0);
+       assert(len % 4 == 0);
+       assert(dst == src || dst + len <= src || src + len <= dst);
+
+       for (size_t n = 0; n < len; n += 4) {
+               uint32_t x = be_to_h_u32(src + n);
+               h_u32_to_le(dst + n, x);
+       }
 }
 
-static inline void h_u16_to_be(u8* buf, int val)
+/**
+ * Calculate the (even) parity of a 32-bit datum.
+ * @param x The datum.
+ * @return 1 if the number of set bits in x is odd, 0 if it is even.
+ */
+static inline int parity_u32(uint32_t x)
 {
-       buf[0] = (u8) (val >> 8);
-       buf[1] = (u8) (val >> 0);
+#ifdef __GNUC__
+       return __builtin_parityl(x);
+#else
+       x ^= x >> 16;
+       x ^= x >> 8;
+       x ^= x >> 4;
+       x ^= x >> 2;
+       x ^= x >> 1;
+       return x & 1;
+#endif
 }
 
-#ifdef __ECOS
-/* eCos plain lacks this definition... */
+#if defined(__ECOS)
+
+/* eCos plain lacks these definition... A series of upstream patches
+ * could probably repair it, but it seems like too much work to be
+ * worth it.
+ */
+
+#if !defined(_STDINT_H)
+#define PRId32 "d"
+#define PRIi32 "i"
+#define PRIo32 "o"
+#define PRIu32 "u"
+#define PRIx32 "x"
+#define PRIX32 "X"
+#define SCNx32 "x"
+#define PRId8 PRId32
+#define SCNx64 "llx"
+#define PRId64 "lld"
+#define PRIi64 "lli"
+#define PRIo64 "llo"
+#define PRIu64 "llu"
+#define PRIx64 "llx"
+#define PRIX64 "llX"
+
 typedef CYG_ADDRWORD intptr_t;
 typedef int64_t intmax_t;
 typedef uint64_t uintmax_t;
 #define INT8_MAX 0x7f
 #define INT8_MIN (-INT8_MAX - 1)
-#define UINT8_MAX (__CONCAT(INT8_MAX, U) * 2U + 1U)
+# define UINT8_MAX             (255)
 #define INT16_MAX 0x7fff
 #define INT16_MIN (-INT16_MAX - 1)
-#define UINT16_MAX (__CONCAT(INT16_MAX, U) * 2U + 1U)
+# define UINT16_MAX            (65535)
 #define INT32_MAX 0x7fffffffL
 #define INT32_MIN (-INT32_MAX - 1L)
-#define UINT32_MAX (__CONCAT(INT32_MAX, U) * 2UL + 1UL)
+# define UINT32_MAX            (4294967295U)
 #define INT64_MAX 0x7fffffffffffffffLL
 #define INT64_MIN (-INT64_MAX - 1LL)
 #define UINT64_MAX (__CONCAT(INT64_MAX, U) * 2ULL + 1ULL)
 #endif
 
-#endif /* TYPES_H */
+       #ifndef LLONG_MAX
+       #define ULLONG_MAX      UINT64_C(0xFFFFFFFFFFFFFFFF)
+       #define LLONG_MAX       INT64_C(0x7FFFFFFFFFFFFFFF)
+       #define LLONG_MIN       ULLONG_MAX
+       #endif
+
+
+#define ULLONG_MAX 18446744073709551615
+
+/* C99, eCos is C90 compliant (with bits of C99) */
+#define isblank(c) ((c) == ' ' || (c) == '\t')
+
+
+#endif
+
+#if BUILD_TARGET64
+typedef uint64_t target_addr_t;
+#define TARGET_ADDR_MAX UINT64_MAX
+#define TARGET_PRIdADDR PRId64
+#define TARGET_PRIuADDR PRIu64
+#define TARGET_PRIoADDR PRIo64
+#define TARGET_PRIxADDR PRIx64
+#define TARGET_PRIXADDR PRIX64
+#else
+typedef uint32_t target_addr_t;
+#define TARGET_ADDR_MAX UINT32_MAX
+#define TARGET_PRIdADDR PRId32
+#define TARGET_PRIuADDR PRIu32
+#define TARGET_PRIoADDR PRIo32
+#define TARGET_PRIxADDR PRIx32
+#define TARGET_PRIXADDR PRIX32
+#endif
+#define TARGET_ADDR_FMT "0x%8.8" TARGET_PRIxADDR
+
+#endif /* OPENOCD_HELPER_TYPES_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)