+/*\r
+ LUFA Library\r
+ Copyright (C) Dean Camera, 2011.\r
+\r
+ dean [at] fourwalledcubicle [dot] com\r
+ www.lufa-lib.org\r
+*/\r
+\r
+/*\r
+ Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+ Permission to use, copy, modify, distribute, and sell this\r
+ software and its documentation for any purpose is hereby granted\r
+ without fee, provided that the above copyright notice appear in\r
+ all copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting\r
+ documentation, and that the name of the author not be used in\r
+ advertising or publicity pertaining to distribution of the\r
+ software without specific, written prior permission.\r
+\r
+ The author disclaim all warranties with regard to this\r
+ software, including all implied warranties of merchantability\r
+ and fitness. In no event shall the author be liable for any\r
+ special, indirect or consequential damages or any damages\r
+ whatsoever resulting from loss of use, data or profits, whether\r
+ in an action of contract, negligence or other tortious action,\r
+ arising out of or in connection with the use or performance of\r
+ this software.\r
+*/\r
+\r
+/** \file\r
+ * \brief Endianness and Byte Ordering macros and functions.\r
+ *\r
+ * \copydetails Group_Endianness\r
+ */\r
+\r
+/** \ingroup Group_Endianness\r
+ * \defgroup Group_ByteSwapping Byte Reordering\r
+ * \brief Macros and functions for forced byte reordering.\r
+ */\r
+\r
+/** \ingroup Group_Endianness\r
+ * \defgroup Group_EndianConversion Endianness Conversion\r
+ * \brief Macros and functions for automatic endianness conversion.\r
+ */\r
+\r
+/** \ingroup Group_Common\r
+ * \defgroup Group_Endianness Endianness and Byte Ordering\r
+ * \brief Convenience macros and functions relating to byte (re-)ordering\r
+ *\r
+ * Common library convenience macros and functions relating to byte (re-)ordering.\r
+ *\r
+ * @{\r
+ */\r
+\r
+#ifndef __LUFA_ENDIANNESS_H__\r
+#define __LUFA_ENDIANNESS_H__\r
+\r
+ /* Preprocessor Checks: */\r
+ #if !defined(__INCLUDE_FROM_COMMON_H)\r
+ #error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.\r
+ #endif\r
+\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Macros: */\r
+ /** Swaps the byte ordering of a 16-bit value at compile-time. Do not use this macro for swapping byte orderings\r
+ * of dynamic values computed at runtime, use \ref SwapEndian_16() instead. The result of this macro can be used\r
+ * inside struct or other variable initializers outside of a function, something that is not possible with the\r
+ * inline function variant.\r
+ *\r
+ * \ingroup Group_ByteSwapping\r
+ *\r
+ * \param[in] x 16-bit value whose byte ordering is to be swapped.\r
+ *\r
+ * \return Input value with the byte ordering reversed.\r
+ */\r
+ #define SWAPENDIAN_16(x) ((((x) & 0xFF00) >> 8) | (((x) & 0x00FF) << 8))\r
+\r
+ /** Swaps the byte ordering of a 32-bit value at compile-time. Do not use this macro for swapping byte orderings\r
+ * of dynamic values computed at runtime- use \ref SwapEndian_32() instead. The result of this macro can be used\r
+ * inside struct or other variable initializers outside of a function, something that is not possible with the\r
+ * inline function variant.\r
+ *\r
+ * \ingroup Group_ByteSwapping\r
+ *\r
+ * \param[in] x 32-bit value whose byte ordering is to be swapped.\r
+ *\r
+ * \return Input value with the byte ordering reversed.\r
+ */\r
+ #define SWAPENDIAN_32(x) ((((x) & 0xFF000000UL) >> 24UL) | (((x) & 0x00FF0000UL) >> 8UL) | \\r
+ (((x) & 0x0000FF00UL) << 8UL) | (((x) & 0x000000FFUL) << 24UL))\r
+\r
+ #if defined(ARCH_BIG_ENDIAN) && !defined(le16_to_cpu)\r
+ #define le16_to_cpu(x) SwapEndian_16(x)\r
+ #define le32_to_cpu(x) SwapEndian_32(x)\r
+ #define be16_to_cpu(x) x\r
+ #define be32_to_cpu(x) x\r
+ #define cpu_to_le16(x) SwapEndian_16(x)\r
+ #define cpu_to_le32(x) SwapEndian_32(x)\r
+ #define cpu_to_be16(x) x\r
+ #define cpu_to_be32(x) x\r
+ #define LE16_TO_CPU(x) SWAPENDIAN_16(x)\r
+ #define LE32_TO_CPU(x) SWAPENDIAN_32(x)\r
+ #define BE16_TO_CPU(x) x\r
+ #define BE32_TO_CPU(x) x\r
+ #define CPU_TO_LE16(x) SWAPENDIAN_16(x)\r
+ #define CPU_TO_LE32(x) SWAPENDIAN_32(x)\r
+ #define CPU_TO_BE16(x) x\r
+ #define CPU_TO_BE32(x) x \r
+ #elif !defined(le16_to_cpu)\r
+ /** \name Run-time endianness conversion */\r
+ //@{\r
+ \r
+ /** Performs a conversion between a Little Endian encoded 16-bit piece of data and the\r
+ * Endianness of the currently selected CPU architecture.\r
+ *\r
+ * On little endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for run-time conversion of data - for compile-time endianness\r
+ * conversion, use \ref LE16_TO_CPU instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define le16_to_cpu(x) x\r
+\r
+ /** Performs a conversion between a Little Endian encoded 32-bit piece of data and the\r
+ * Endianness of the currently selected CPU architecture.\r
+ *\r
+ * On little endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for run-time conversion of data - for compile-time endianness\r
+ * conversion, use \ref LE32_TO_CPU instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define le32_to_cpu(x) x\r
+\r
+ /** Performs a conversion between a Big Endian encoded 16-bit piece of data and the\r
+ * Endianness of the currently selected CPU architecture.\r
+ *\r
+ * On big endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for run-time conversion of data - for compile-time endianness\r
+ * conversion, use \ref BE16_TO_CPU instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define be16_to_cpu(x) SwapEndian_16(x)\r
+\r
+ /** Performs a conversion between a Big Endian encoded 32-bit piece of data and the\r
+ * Endianness of the currently selected CPU architecture.\r
+ *\r
+ * On big endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for run-time conversion of data - for compile-time endianness\r
+ * conversion, use \ref BE32_TO_CPU instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define be32_to_cpu(x) SwapEndian_32(x)\r
+\r
+ /** Performs a conversion on a natively encoded 16-bit piece of data to ensure that it\r
+ * is in Little Endian format regardless of the currently selected CPU architecture.\r
+ *\r
+ * On little endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for run-time conversion of data - for compile-time endianness\r
+ * conversion, use \ref CPU_TO_LE16 instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define cpu_to_le16(x) x\r
+\r
+ /** Performs a conversion on a natively encoded 32-bit piece of data to ensure that it\r
+ * is in Little Endian format regardless of the currently selected CPU architecture.\r
+ *\r
+ * On little endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for run-time conversion of data - for compile-time endianness\r
+ * conversion, use \ref CPU_TO_LE32 instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define cpu_to_le32(x) x\r
+\r
+ /** Performs a conversion on a natively encoded 16-bit piece of data to ensure that it\r
+ * is in Big Endian format regardless of the currently selected CPU architecture.\r
+ *\r
+ * On big endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for run-time conversion of data - for compile-time endianness\r
+ * conversion, use \ref CPU_TO_BE16 instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define cpu_to_be16(x) SwapEndian_16(x)\r
+\r
+ /** Performs a conversion on a natively encoded 32-bit piece of data to ensure that it\r
+ * is in Big Endian format regardless of the currently selected CPU architecture.\r
+ *\r
+ * On big endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for run-time conversion of data - for compile-time endianness\r
+ * conversion, use \ref CPU_TO_BE32 instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define cpu_to_be32(x) SwapEndian_32(x)\r
+\r
+ //@}\r
+\r
+ /** \name Compile-time endianness conversion */\r
+ //@{\r
+\r
+ /** Performs a conversion between a Little Endian encoded 16-bit piece of data and the\r
+ * Endianness of the currently selected CPU architecture.\r
+ *\r
+ * On little endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for compile-time conversion of data - for run time endianness\r
+ * conversion, use \ref le16_to_cpu instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define LE16_TO_CPU(x) x\r
+\r
+ /** Performs a conversion between a Little Endian encoded 32-bit piece of data and the\r
+ * Endianness of the currently selected CPU architecture.\r
+ *\r
+ * On little endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for compile-time conversion of data - for run time endianness\r
+ * conversion, use \ref le32_to_cpu instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define LE32_TO_CPU(x) x\r
+\r
+ /** Performs a conversion between a Big Endian encoded 16-bit piece of data and the\r
+ * Endianness of the currently selected CPU architecture.\r
+ *\r
+ * On big endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for compile-time conversion of data - for run-time endianness\r
+ * conversion, use \ref be16_to_cpu instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define BE16_TO_CPU(x) SWAPENDIAN_16(x)\r
+\r
+ /** Performs a conversion between a Big Endian encoded 32-bit piece of data and the\r
+ * Endianness of the currently selected CPU architecture.\r
+ *\r
+ * On big endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for compile-time conversion of data - for run-time endianness\r
+ * conversion, use \ref be32_to_cpu instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define BE32_TO_CPU(x) SWAPENDIAN_32(x)\r
+\r
+ /** Performs a conversion on a natively encoded 16-bit piece of data to ensure that it\r
+ * is in Little Endian format regardless of the currently selected CPU architecture.\r
+ *\r
+ * On little endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for compile-time conversion of data - for run-time endianness\r
+ * conversion, use \ref cpu_to_le16 instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define CPU_TO_LE16(x) x\r
+\r
+ /** Performs a conversion on a natively encoded 32-bit piece of data to ensure that it\r
+ * is in Little Endian format regardless of the currently selected CPU architecture.\r
+ *\r
+ * On little endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for compile-time conversion of data - for run-time endianness\r
+ * conversion, use \ref cpu_to_le32 instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define CPU_TO_LE32(x) x\r
+\r
+ /** Performs a conversion on a natively encoded 16-bit piece of data to ensure that it\r
+ * is in Big Endian format regardless of the currently selected CPU architecture.\r
+ *\r
+ * On big endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for compile-time conversion of data - for run-time endianness\r
+ * conversion, use \ref cpu_to_be16 instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define CPU_TO_BE16(x) SWAPENDIAN_16(x)\r
+\r
+ /** Performs a conversion on a natively encoded 32-bit piece of data to ensure that it\r
+ * is in Big Endian format regardless of the currently selected CPU architecture.\r
+ *\r
+ * On big endian architectures, this macro does nothing.\r
+ *\r
+ * \note This macro is designed for compile-time conversion of data - for run-time endianness\r
+ * conversion, use \ref cpu_to_be32 instead.\r
+ *\r
+ * \ingroup Group_EndianConversion\r
+ *\r
+ * \param[in] x Data to perform the endianness conversion on.\r
+ *\r
+ * \return Endian corrected version of the input value.\r
+ */\r
+ #define CPU_TO_BE32(x) SWAPENDIAN_32(x)\r
+\r
+ //! @}\r
+ #endif\r
+\r
+ /* Inline Functions: */\r
+ /** Function to reverse the byte ordering of the individual bytes in a 16 bit value.\r
+ *\r
+ * \ingroup Group_ByteSwapping\r
+ *\r
+ * \param[in] Word Word of data whose bytes are to be swapped.\r
+ */\r
+ static inline uint16_t SwapEndian_16(const uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST;\r
+ static inline uint16_t SwapEndian_16(const uint16_t Word)\r
+ {\r
+ uint8_t Temp;\r
+\r
+ union\r
+ {\r
+ uint16_t Word;\r
+ uint8_t Bytes[2];\r
+ } Data;\r
+\r
+ Data.Word = Word;\r
+\r
+ Temp = Data.Bytes[0];\r
+ Data.Bytes[0] = Data.Bytes[1];\r
+ Data.Bytes[1] = Temp;\r
+\r
+ return Data.Word;\r
+ }\r
+\r
+ /** Function to reverse the byte ordering of the individual bytes in a 32 bit value.\r
+ *\r
+ * \ingroup Group_ByteSwapping\r
+ *\r
+ * \param[in] DWord Double word of data whose bytes are to be swapped.\r
+ */\r
+ static inline uint32_t SwapEndian_32(const uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST;\r
+ static inline uint32_t SwapEndian_32(const uint32_t DWord)\r
+ {\r
+ uint8_t Temp;\r
+\r
+ union\r
+ {\r
+ uint32_t DWord;\r
+ uint8_t Bytes[4];\r
+ } Data;\r
+\r
+ Data.DWord = DWord;\r
+\r
+ Temp = Data.Bytes[0];\r
+ Data.Bytes[0] = Data.Bytes[3];\r
+ Data.Bytes[3] = Temp;\r
+\r
+ Temp = Data.Bytes[1];\r
+ Data.Bytes[1] = Data.Bytes[2];\r
+ Data.Bytes[2] = Temp;\r
+\r
+ return Data.DWord;\r
+ }\r
+\r
+ /** Function to reverse the byte ordering of the individual bytes in a n byte value.\r
+ *\r
+ * \ingroup Group_ByteSwapping\r
+ *\r
+ * \param[in,out] Data Pointer to a number containing an even number of bytes to be reversed.\r
+ * \param[in] Bytes Length of the data in bytes.\r
+ */\r
+ static inline void SwapEndian_n(void* Data,\r
+ uint8_t Bytes) ATTR_NON_NULL_PTR_ARG(1);\r
+ static inline void SwapEndian_n(void* Data,\r
+ uint8_t Bytes)\r
+ {\r
+ uint8_t* CurrDataPos = (uint8_t*)Data;\r
+\r
+ while (Bytes > 1)\r
+ {\r
+ uint8_t Temp = *CurrDataPos;\r
+ *CurrDataPos = *(CurrDataPos + Bytes - 1);\r
+ *(CurrDataPos + Bytes - 1) = Temp;\r
+\r
+ CurrDataPos++;\r
+ Bytes -= 2;\r
+ }\r
+ }\r
+\r
+#endif\r
+\r
+/** @} */\r
projects / pub / USBasp.git / commitdiff