byteorder.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2015-2016, Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SYS_BYTEORDER_H_
#define ZEPHYR_INCLUDE_SYS_BYTEORDER_H_
 
#include <zephyr/types.h>
#include <stddef.h>
#include <string.h>
#include <zephyr/sys/__assert.h>
#include <zephyr/sys/util_macro.h>
#include <zephyr/toolchain.h>
 
#define BSWAP_16(x) ((uint16_t) ((((x) >> 8) & 0xff) | (((x) & 0xff) << 8)))
#define BSWAP_24(x) ((uint32_t) ((((x) >> 16) & 0xff) | \
                                   (((x)) & 0xff00) | \
                                   (((x) & 0xff) << 16)))
#define BSWAP_32(x) ((uint32_t) ((((x) >> 24) & 0xff) | \
                                   (((x) >> 8) & 0xff00) | \
                                   (((x) & 0xff00) << 8) | \
                                   (((x) & 0xff) << 24)))
#define BSWAP_40(x) ((uint64_t) ((((x) >> 32) & 0xff) | \
                                   (((x) >> 16) & 0xff00) | \
                                   (((x)) & 0xff0000) | \
                                   (((x) & 0xff00) << 16) | \
                                   (((x) & 0xff) << 32)))
#define BSWAP_48(x) ((uint64_t) ((((x) >> 40) & 0xff) | \
                                   (((x) >> 24) & 0xff00) | \
                                   (((x) >> 8) & 0xff0000) | \
                                   (((x) & 0xff0000) << 8) | \
                                   (((x) & 0xff00) << 24) | \
                                   (((x) & 0xff) << 40)))
#define BSWAP_64(x) ((uint64_t) ((((x) >> 56) & 0xff) | \
                                   (((x) >> 40) & 0xff00) | \
                                   (((x) >> 24) & 0xff0000) | \
                                   (((x) >> 8) & 0xff000000) | \
                                   (((x) & 0xff000000) << 8) | \
                                   (((x) & 0xff0000) << 24) | \
                                   (((x) & 0xff00) << 40) | \
                                   (((x) & 0xff) << 56)))
 
#ifdef CONFIG_LITTLE_ENDIAN
#define sys_le16_to_cpu(val) (val)
#define sys_cpu_to_le16(val) (val)
#define sys_le24_to_cpu(val) (val)
#define sys_cpu_to_le24(val) (val)
#define sys_le32_to_cpu(val) (val)
#define sys_cpu_to_le32(val) (val)
#define sys_le40_to_cpu(val) (val)
#define sys_cpu_to_le40(val) (val)
#define sys_le48_to_cpu(val) (val)
#define sys_cpu_to_le48(val) (val)
#define sys_le64_to_cpu(val) (val)
#define sys_cpu_to_le64(val) (val)
#define sys_be16_to_cpu(val) BSWAP_16(val)
#define sys_cpu_to_be16(val) BSWAP_16(val)
#define sys_be24_to_cpu(val) BSWAP_24(val)
#define sys_cpu_to_be24(val) BSWAP_24(val)
#define sys_be32_to_cpu(val) BSWAP_32(val)
#define sys_cpu_to_be32(val) BSWAP_32(val)
#define sys_be40_to_cpu(val) BSWAP_40(val)
#define sys_cpu_to_be40(val) BSWAP_40(val)
#define sys_be48_to_cpu(val) BSWAP_48(val)
#define sys_cpu_to_be48(val) BSWAP_48(val)
#define sys_be64_to_cpu(val) BSWAP_64(val)
#define sys_cpu_to_be64(val) BSWAP_64(val)
 
#define sys_uint16_to_array(val) {              \
        ((val) & 0xff),                         \
        (((val) >> 8) & 0xff)}
 
#define sys_uint32_to_array(val) {              \
        ((val) & 0xff),                         \
        (((val) >> 8) & 0xff),                  \
        (((val) >> 16) & 0xff),                 \
        (((val) >> 24) & 0xff)}
 
#define sys_uint64_to_array(val) {              \
        ((val) & 0xff),                         \
        (((val) >> 8) & 0xff),                  \
        (((val) >> 16) & 0xff),                 \
        (((val) >> 24) & 0xff),                 \
        (((val) >> 32) & 0xff),                 \
        (((val) >> 40) & 0xff),                 \
        (((val) >> 48) & 0xff),                 \
        (((val) >> 56) & 0xff)}
 
#else
#define sys_le16_to_cpu(val) BSWAP_16(val)
#define sys_cpu_to_le16(val) BSWAP_16(val)
#define sys_le24_to_cpu(val) BSWAP_24(val)
#define sys_cpu_to_le24(val) BSWAP_24(val)
#define sys_le32_to_cpu(val) BSWAP_32(val)
#define sys_cpu_to_le32(val) BSWAP_32(val)
#define sys_le40_to_cpu(val) BSWAP_40(val)
#define sys_cpu_to_le40(val) BSWAP_40(val)
#define sys_le48_to_cpu(val) BSWAP_48(val)
#define sys_cpu_to_le48(val) BSWAP_48(val)
#define sys_le64_to_cpu(val) BSWAP_64(val)
#define sys_cpu_to_le64(val) BSWAP_64(val)
#define sys_be16_to_cpu(val) (val)
#define sys_cpu_to_be16(val) (val)
#define sys_be24_to_cpu(val) (val)
#define sys_cpu_to_be24(val) (val)
#define sys_be32_to_cpu(val) (val)
#define sys_cpu_to_be32(val) (val)
#define sys_be40_to_cpu(val) (val)
#define sys_cpu_to_be40(val) (val)
#define sys_be48_to_cpu(val) (val)
#define sys_cpu_to_be48(val) (val)
#define sys_be64_to_cpu(val) (val)
#define sys_cpu_to_be64(val) (val)
 
#define sys_uint16_to_array(val) {              \
        (((val) >> 8) & 0xff),                  \
        ((val) & 0xff)}
 
#define sys_uint32_to_array(val) {              \
        (((val) >> 24) & 0xff),                 \
        (((val) >> 16) & 0xff),                 \
        (((val) >> 8) & 0xff),                  \
        ((val) & 0xff)}
 
#define sys_uint64_to_array(val) {              \
        (((val) >> 56) & 0xff),                 \
        (((val) >> 48) & 0xff),                 \
        (((val) >> 40) & 0xff),                 \
        (((val) >> 32) & 0xff),                 \
        (((val) >> 24) & 0xff),                 \
        (((val) >> 16) & 0xff),                 \
        (((val) >> 8) & 0xff),                  \
        ((val) & 0xff)}
 
#endif
 
static inline void sys_put_be16(uint16_t val, uint8_t dst[2])
{
        dst[0] = val >> 8;
        dst[1] = val;
}
 
static inline void sys_put_be24(uint32_t val, uint8_t dst[3])
{
        dst[0] = val >> 16;
        sys_put_be16(val, &dst[1]);
}
 
static inline void sys_put_be32(uint32_t val, uint8_t dst[4])
{
        sys_put_be16(val >> 16, dst);
        sys_put_be16(val, &dst[2]);
}
static inline void sys_put_be40(uint64_t val, uint8_t dst[5])
{
        dst[0] = val >> 32;
        sys_put_be32(val, &dst[1]);
}
 
static inline void sys_put_be48(uint64_t val, uint8_t dst[6])
{
        sys_put_be16(val >> 32, dst);
        sys_put_be32(val, &dst[2]);
}
 
static inline void sys_put_be64(uint64_t val, uint8_t dst[8])
{
        sys_put_be32(val >> 32, dst);
        sys_put_be32(val, &dst[4]);
}
 
static inline void sys_put_le16(uint16_t val, uint8_t dst[2])
{
        dst[0] = val;
        dst[1] = val >> 8;
}
 
static inline void sys_put_le24(uint32_t val, uint8_t dst[3])
{
        sys_put_le16(val, dst);
        dst[2] = val >> 16;
}
 
static inline void sys_put_le32(uint32_t val, uint8_t dst[4])
{
        sys_put_le16(val, dst);
        sys_put_le16(val >> 16, &dst[2]);
}
 
static inline void sys_put_le40(uint64_t val, uint8_t dst[5])
{
        sys_put_le32(val, dst);
        dst[4] = val >> 32;
}
 
static inline void sys_put_le48(uint64_t val, uint8_t dst[6])
{
        sys_put_le32(val, dst);
        sys_put_le16(val >> 32, &dst[4]);
}
 
static inline void sys_put_le64(uint64_t val, uint8_t dst[8])
{
        sys_put_le32(val, dst);
        sys_put_le32(val >> 32, &dst[4]);
}
 
static inline uint16_t sys_get_be16(const uint8_t src[2])
{
        return ((uint16_t)src[0] << 8) | src[1];
}
 
static inline uint32_t sys_get_be24(const uint8_t src[3])
{
        return ((uint32_t)src[0] << 16) | sys_get_be16(&src[1]);
}
 
static inline uint32_t sys_get_be32(const uint8_t src[4])
{
        return ((uint32_t)sys_get_be16(&src[0]) << 16) | sys_get_be16(&src[2]);
}
 
static inline uint64_t sys_get_be40(const uint8_t src[5])
{
        return ((uint64_t)sys_get_be32(&src[0]) << 8) | src[4];
}
 
static inline uint64_t sys_get_be48(const uint8_t src[6])
{
        return ((uint64_t)sys_get_be32(&src[0]) << 16) | sys_get_be16(&src[4]);
}
 
static inline uint64_t sys_get_be64(const uint8_t src[8])
{
        return ((uint64_t)sys_get_be32(&src[0]) << 32) | sys_get_be32(&src[4]);
}
 
static inline uint16_t sys_get_le16(const uint8_t src[2])
{
        return ((uint16_t)src[1] << 8) | src[0];
}
 
static inline uint32_t sys_get_le24(const uint8_t src[3])
{
        return ((uint32_t)src[2] << 16) | sys_get_le16(&src[0]);
}
 
static inline uint32_t sys_get_le32(const uint8_t src[4])
{
        return ((uint32_t)sys_get_le16(&src[2]) << 16) | sys_get_le16(&src[0]);
}
 
static inline uint64_t sys_get_le40(const uint8_t src[5])
{
        return ((uint64_t)sys_get_le32(&src[1]) << 8) | src[0];
}
 
static inline uint64_t sys_get_le48(const uint8_t src[6])
{
        return ((uint64_t)sys_get_le32(&src[2]) << 16) | sys_get_le16(&src[0]);
}
 
static inline uint64_t sys_get_le64(const uint8_t src[8])
{
        return ((uint64_t)sys_get_le32(&src[4]) << 32) | sys_get_le32(&src[0]);
}
 
static inline void sys_memcpy_swap(void *dst, const void *src, size_t length)
{
        uint8_t *pdst = (uint8_t *)dst;
        const uint8_t *psrc = (const uint8_t *)src;
 
        __ASSERT(((psrc < pdst && (psrc + length) <= pdst) ||
                  (psrc > pdst && (pdst + length) <= psrc)),
                 "Source and destination buffers must not overlap");
 
        psrc += length - 1;
 
        for (; length > 0; length--) {
                *pdst++ = *psrc--;
        }
}
 
static inline void sys_mem_swap(void *buf, size_t length)
{
        size_t i;
 
        for (i = 0; i < (length/2); i++) {
                uint8_t tmp = ((uint8_t *)buf)[i];
 
                ((uint8_t *)buf)[i] = ((uint8_t *)buf)[length - 1 - i];
                ((uint8_t *)buf)[length - 1 - i] = tmp;
        }
}
 
static inline void sys_le_to_cpu(void *buf, size_t length)
{
        if (IS_ENABLED(CONFIG_BIG_ENDIAN)) {
                sys_mem_swap(buf, length);
        }
}
 
static inline void sys_cpu_to_le(void *buf, size_t length)
{
        if (IS_ENABLED(CONFIG_BIG_ENDIAN)) {
                sys_mem_swap(buf, length);
        }
}
 
static inline void sys_be_to_cpu(void *buf, size_t length)
{
        if (IS_ENABLED(CONFIG_LITTLE_ENDIAN)) {
                sys_mem_swap(buf, length);
        }
}
 
static inline void sys_cpu_to_be(void *buf, size_t length)
{
        if (IS_ENABLED(CONFIG_LITTLE_ENDIAN)) {
                sys_mem_swap(buf, length);
        }
}
 
static inline void sys_put_le(void *dst, const void *src, size_t length)
{
        if (IS_ENABLED(CONFIG_LITTLE_ENDIAN)) {
                (void)memcpy(dst, src, length);
        } else {
                sys_memcpy_swap(dst, src, length);
        }
}
 
static inline void sys_put_be(void *dst, const void *src, size_t length)
{
        if (IS_ENABLED(CONFIG_LITTLE_ENDIAN)) {
                sys_memcpy_swap(dst, src, length);
        } else {
                (void)memcpy(dst, src, length);
        }
}
 
static inline void sys_get_le(void *dst, const void *src, size_t length)
{
        if (IS_ENABLED(CONFIG_LITTLE_ENDIAN)) {
                (void)memcpy(dst, src, length);
        } else {
                sys_memcpy_swap(dst, src, length);
        }
}
 
static inline void sys_get_be(void *dst, const void *src, size_t length)
{
        if (IS_ENABLED(CONFIG_LITTLE_ENDIAN)) {
                sys_memcpy_swap(dst, src, length);
        } else {
                (void)memcpy(dst, src, length);
        }
}
 
#endif /* ZEPHYR_INCLUDE_SYS_BYTEORDER_H_ */