[openocd.git] / src / helper / types.h

/***************************************************************************
 *   Copyright (C) 2004, 2005 by Dominic Rath                              *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
 *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
 *   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     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   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.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
 ***************************************************************************/
#ifndef TYPES_H
#define TYPES_H

#include <stddef.h>
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#ifdef HAVE_STDINT_H
#include <stdint.h>
#endif
#ifdef HAVE_INTTYPES_H
#include <inttypes.h>
#endif

#ifdef HAVE_STDBOOL_H
#include <stdbool.h>
#else   /* HAVE_STDBOOL_H */
#define __bool_true_false_are_defined 1

#ifndef HAVE__BOOL
#ifndef __cplusplus

#define false   0
#define true            1

typedef int _Bool;
#else
typedef bool _Bool;
#endif  /* __cplusplus */
#endif  /* HAVE__BOOL */

#define 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
 * across architectures. Clever usage of 32 bit access
 * will create problems on some hosts.
 *
 * Note that the "buf" pointer in memory is probably unaligned.
 *
 * Were these functions to be re-written to take a 32 bit wide or 16 bit wide
 * memory access shortcut, then on some CPU's, i.e. ARM7, the 2 lsbytes of the address are
 * ignored for 32 bit access, whereas on other CPU's a 32 bit wide unaligned memory access
 * will cause an exception, and lastly on x86, an unaligned "greater than bytewide"
 * memory access works as if aligned.  So what follows below will work for all
 * platforms and gives the compiler leeway to do its own platform specific optimizations.
 *
 * 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 void h_u32_to_be(uint8_t* buf, int val)
{
        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 void h_u24_to_le(uint8_t* buf, int val)
{
        buf[2] = (uint8_t) (val >> 16);
        buf[1] = (uint8_t) (val >> 8);
        buf[0] = (uint8_t) (val >> 0);
}

static inline void h_u24_to_be(uint8_t* buf, int val)
{
        buf[0] = (uint8_t) (val >> 16);
        buf[1] = (uint8_t) (val >> 8);
        buf[2] = (uint8_t) (val >> 0);
}

static inline void h_u16_to_le(uint8_t* buf, int val)
{
        buf[1] = (uint8_t) (val >> 8);
        buf[0] = (uint8_t) (val >> 0);
}

static inline void h_u16_to_be(uint8_t* buf, int val)
{
        buf[0] = (uint8_t) (val >> 8);
        buf[1] = (uint8_t) (val >> 0);
}

/**
 * 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)
{
        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);
        }
}

/**
 * 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)
{
        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);
        }
}

#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 PRIx32 "x"
#define PRId32 "d"
#define SCNx32 "x"
#define PRIi32 "i"
#define PRIu32 "u"
#define PRId8 PRId32
#define SCNx64 "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              (255)
#define INT16_MAX 0x7fff
#define INT16_MIN (-INT16_MAX - 1)
# define UINT16_MAX             (65535)
#define INT32_MAX 0x7fffffffL
#define INT32_MIN (-INT32_MAX - 1L)
# define UINT32_MAX             (4294967295U)
#define INT64_MAX 0x7fffffffffffffffLL
#define INT64_MIN (-INT64_MAX - 1LL)
#define UINT64_MAX (__CONCAT(INT64_MAX, U) * 2ULL + 1ULL)
#endif

        #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

#endif /* TYPES_H */