include/sys/endian.h

/****************************************************************************
 * include/sys/endian.h
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 ****************************************************************************/

#ifndef __INCLUDE_SYS_ENDIAN_H
#define __INCLUDE_SYS_ENDIAN_H

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>
#include <nuttx/compiler.h>
#include <stdint.h>

/****************************************************************************
 * Preprocessor definitions
 ****************************************************************************/

/* The endian.h header must define at least the following macros for use in
 * determining host byte order for integer types:
 *
 *   BYTE_ORDER    This macro will have a value equal to one of the *_ENDIAN
 *                 macros in this header.
 *   LITTLE_ENDIAN If BYTE_ORDER == LITTLE_ENDIAN, the host byte order is
 *                 from least significant to most significant.
 *   BIG_ENDIAN    If BYTE_ORDER == BIG_ENDIAN, the host byte order is from
 *                 most significant to least significant.
 */

#define LITTLE_ENDIAN         1234
#define __LITTLE_ENDIAN       1234
#define BIG_ENDIAN            4321
#define __BIG_ENDIAN          4321

/* Common byte swapping macros */

#ifdef CONFIG_HAVE_BUILTIN_BSWAP16
#  define __swap_uint16(n) ((uint16_t)__builtin_bswap16(n))
#else
#  define __swap_uint16(n) \
    (uint16_t)(((((uint16_t)(n)) & 0x00ff) << 8) | \
               ((((uint16_t)(n)) >> 8) & 0x00ff))
#endif

#ifdef CONFIG_HAVE_BUILTIN_BSWAP32
#  define __swap_uint32(n) ((uint32_t)__builtin_bswap32(n))
#else
#  define __swap_uint32(n) \
    (uint32_t)(((((uint32_t)(n)) & 0x000000ffUL) << 24) | \
               ((((uint32_t)(n)) & 0x0000ff00UL) <<  8) | \
               ((((uint32_t)(n)) & 0x00ff0000UL) >>  8) | \
               ((((uint32_t)(n)) & 0xff000000UL) >> 24))
#endif

#ifdef CONFIG_HAVE_LONG_LONG
#  ifdef CONFIG_HAVE_BUILTIN_BSWAP64
#    define __swap_uint64(n) ((uint64_t)__builtin_bswap64(n))
#  else
#    define __swap_uint64(n) \
        (uint64_t)(((((uint64_t)(n)) & 0x00000000000000ffULL) << 56) | \
                   ((((uint64_t)(n)) & 0x000000000000ff00ULL) << 40) | \
                   ((((uint64_t)(n)) & 0x0000000000ff0000ULL) << 24) | \
                   ((((uint64_t)(n)) & 0x00000000ff000000ULL) <<  8) | \
                   ((((uint64_t)(n)) & 0x000000ff00000000ULL) >>  8) | \
                   ((((uint64_t)(n)) & 0x0000ff0000000000ULL) >> 24) | \
                   ((((uint64_t)(n)) & 0x00ff000000000000ULL) >> 40) | \
                   ((((uint64_t)(n)) & 0xff00000000000000ULL) >> 56))
#  endif
#endif

/* Endian-specific definitions */

#ifdef CONFIG_ENDIAN_BIG
/* Big-endian byte order */

#  define BYTE_ORDER          BIG_ENDIAN
#  define __BYTE_ORDER        __BIG_ENDIAN

/* Big-endian byte order macros */

#  define htobe16(n)          ((uint16_t)(n))
#  define htole16(n)          __swap_uint16(n)
#  define be16toh(n)          ((uint16_t)(n))
#  define le16toh(n)          __swap_uint16(n)

#  define htobe32(n)          ((uint32_t)(n))
#  define htole32(n)          __swap_uint32(n)
#  define be32toh(n)          ((uint32_t)(n))
#  define le32toh(n)          __swap_uint32(n)

#  ifdef CONFIG_HAVE_LONG_LONG
#    define htobe64(n)        ((uint64_t)(n))
#    define htole64(n)        __swap_uint64(n)
#    define be64toh(n)        ((uint64_t)(n))
#    define le64toh(n)        __swap_uint64(n)
#  endif

#else
/* Little-endian byte order */

#  define BYTE_ORDER          LITTLE_ENDIAN
#  define __BYTE_ORDER        __LITTLE_ENDIAN

/* Little-endian byte order macros */

#  define htobe16(n)          __swap_uint16(n)
#  define htole16(n)          ((uint16_t)(n))
#  define be16toh(n)          __swap_uint16(n)
#  define le16toh(n)          ((uint16_t)(n))

#  define htobe32(n)          __swap_uint32(n)
#  define htole32(n)          ((uint32_t)(n))
#  define be32toh(n)          __swap_uint32(n)
#  define le32toh(n)          ((uint32_t)(n))

#  ifdef CONFIG_HAVE_LONG_LONG
#    define htobe64(n)        __swap_uint64(n)
#    define htole64(n)        ((uint64_t)(n))
#    define be64toh(n)        __swap_uint64(n)
#    define le64toh(n)        ((uint64_t)(n))
#  endif
#endif

/* OpenBSD style */

#define swap16                __swap_uint16
#define swap32                __swap_uint32
#define swap64                __swap_uint64

#define betoh16               be16toh
#define letoh16               le16toh
#define bemtoh16(x)           betoh16(*(FAR uint16_t *)(x))
#define htobem16(x, v)        (*(FAR uint16_t *)(x) = htobe16(v))
#define lemtoh16(x)           letoh16(*(FAR uint16_t *)(x))
#define htolem16(x, v)        (*(FAR uint16_t *)(x) = htole16(v))
#define betoh32               be32toh
#define letoh32               le32toh
#define bemtoh32(x)           betoh32(*(FAR uint32_t *)(x))
#define htobem32(x, v)        (*(FAR uint32_t *)(x) = htobe32(v))
#define lemtoh32(x)           letoh32(*(FAR uint32_t *)(x))
#define htolem32(x, v)        (*(FAR uint32_t *)(x) = htole32(v))

#ifdef CONFIG_HAVE_LONG_LONG
#  define betoh64             be64toh
#  define letoh64             le64toh
#  define bemtoh64(x)         betoh64(*(FAR uint64_t *)(x))
#  define htobem64(x, v)      (*(FAR uint64_t *)(x) = htobe64(v))
#  define lemtoh64(x)         letoh64(*(FAR uint64_t *)(x))
#  define htolem64(x, v)      (*(FAR uint64_t *)(x) = htole64(v))
#endif

#endif /* __INCLUDE_SYS_ENDIAN_H */