endian.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2024 Otto-von-Guericke-Universität Magdeburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef DOXYGEN
#define LITTLE_ENDIAN   magic-number

#define BIG_ENDIAN      magic-number

#define PDP_ENDIAN      magic-number

#define BYTE_ORDER      <LITTLE_ENDIAN or BIG_ENDIAN>
 
uint16_t htobe16(uint16_t host_16bits);         
uint16_t htole16(uint16_t host_16bits);         
uint16_t be16toh(uint16_t big_endian_16bits);   
uint16_t le16toh(uint16_t little_endian_16bits);
 
uint32_t htobe32(uint32_t host_32bits);         
uint32_t htole32(uint32_t host_32bits);         
uint32_t be32toh(uint32_t big_endian_32bits);   
uint32_t le32toh(uint32_t little_endian_32bits);
 
uint64_t htobe64(uint64_t host_64bits);         
uint64_t htole64(uint64_t host_64bits);         
uint64_t be64toh(uint64_t big_endian_64bits);   
uint64_t le64toh(uint64_t little_endian_64bits);
 
#else /* DOXYGEN */
 
/* Depending on the version of newlib used, newlib may provide them indirectly
 * as well. We don't want to redefine them in this case */
#ifndef LITTLE_ENDIAN
#  define LITTLE_ENDIAN 1234
#endif
#ifndef BIG_ENDIAN
#  define BIG_ENDIAN    4321
#endif
#ifndef PDP_ENDIAN
#  define PDP_ENDIAN    3412
#endif
#ifndef BYTE_ORDER
#  define BYTE_ORDER    __BYTE_ORDER__
#endif
 
/* But to avoid lots of pain in the ass: Let's at least make sure everyone
 * agrees on what magic number is what */
#if (LITTLE_ENDIAN != 1234) || (BIG_ENDIAN != 4321) || (PDP_ENDIAN != 3412)
#  error "Mismatching magic numbers to refer to endianness"
#endif
 
#if BYTE_ORDER == LITTLE_ENDIAN
#  ifndef htobe16
#  define htobe16(_x) __builtin_bswap16(_x)
#  endif
#  ifndef htole16
#  define htole16(_x) ((uint16_t)(_x))
#  endif
#  ifndef be16toh
#  define be16toh(_x) __builtin_bswap16(_x)
#  endif
#  ifndef le16toh
#  define le16toh(_x) ((uint16_t)(_x))
#  endif
#  ifndef htobe32
#  define htobe32(_x) __builtin_bswap32(_x)
#  endif
#  ifndef htole32
#  define htole32(_x) ((uint32_t)(_x))
#  endif
#  ifndef be32toh
#  define be32toh(_x) __builtin_bswap32(_x)
#  endif
#  ifndef le32toh
#  define le32toh(_x) ((uint32_t)(_x))
#  endif
#  ifndef htobe64
#  define htobe64(_x) __builtin_bswap64(_x)
#  endif
#  ifndef htole64
#  define htole64(_x) ((uint64_t)(_x))
#  endif
#  ifndef be64toh
#  define be64toh(_x) __builtin_bswap64(_x)
#  endif
#  ifndef le64toh
#  define le64toh(_x) ((uint64_t)(_x))
#  endif
#elif BYTE_ORDER == BIG_ENDIAN
#  ifndef htole16
#  define htole16(_x) __builtin_bswap16(_x)
#  endif
#  ifndef htobe16
#  define htobe16(_x) ((uint16_t)(_x))
#  endif
#  ifndef le16toh
#  define le16toh(_x) __builtin_bswap16(_x)
#  endif
#  ifndef be16toh
#  define be16toh(_x) ((uint16_t)(_x))
#  endif
#  ifndef htole32
#  define htole32(_x) __builtin_bswap32(_x)
#  endif
#  ifndef htobe32
#  define htobe32(_x) ((uint32_t)(_x))
#  endif
#  ifndef le32toh
#  define le32toh(_x) __builtin_bswap32(_x)
#  endif
#  ifndef be32toh
#  define be32toh(_x) ((uint32_t)(_x))
#  endif
#  ifndef htole64
#  define htole64(_x) __builtin_bswap64(_x)
#  endif
#  ifndef htobe64
#  define htobe64(_x) ((uint64_t)(_x))
#  endif
#  ifndef le64toh
#  define le64toh(_x) __builtin_bswap64(_x)
#  endif
#  ifndef be64toh
#  define be64toh(_x) ((uint64_t)(_x))
#  endif
#else
#  error "Byte order not supported"
#endif
 
#endif /* DOXYGEN */
 
#ifdef __cplusplus
}
#endif