Add byte-swap helpers
[fw/openocd] / src / helper / types.h
index eb836c2458cb9d7f221790b48f2e02190b7cf746..7a845284e4467cd8f4db5fad568eebfe02f50828 100644 (file)
  *   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.             *
+ *   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
@@ -33,8 +34,6 @@
 #include <inttypes.h>
 #endif
 
-typedef struct jtag_tap_s jtag_tap_t;
-
 #ifdef HAVE_STDBOOL_H
 #include <stdbool.h>
 #else  /* HAVE_STDBOOL_H */
@@ -56,6 +55,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
@@ -80,6 +116,11 @@ 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);
@@ -90,6 +131,11 @@ 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);
@@ -111,6 +157,20 @@ static inline void h_u32_to_be(uint8_t* buf, int val)
        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);
@@ -123,6 +183,46 @@ static inline void h_u16_to_be(uint8_t* buf, int val)
        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
@@ -136,6 +236,9 @@ static inline void h_u16_to_be(uint8_t* buf, int val)
 #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;
@@ -154,11 +257,11 @@ typedef uint64_t uintmax_t;
 #define UINT64_MAX (__CONCAT(INT64_MAX, U) * 2ULL + 1ULL)
 #endif
 
-    #ifndef LLONG_MAX
+       #ifndef LLONG_MAX
        #define ULLONG_MAX      UINT64_C(0xFFFFFFFFFFFFFFFF)
        #define LLONG_MAX       INT64_C(0x7FFFFFFFFFFFFFFF)
        #define LLONG_MIN       ULLONG_MAX
-    #endif
+       #endif
 
 
 #define ULLONG_MAX 18446744073709551615