Add missing U2S board definition, update build tests and documentation.

[pub/USBasp.git] / LUFA / Common / Endianness.h

diff --git a/LUFA/Common/Endianness.h b/LUFA/Common/Endianness.h
index 6e84626..41f1795 100644 (file)
--- a/LUFA/Common/Endianness.h
+++ b/LUFA/Common/Endianness.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2013.

 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*

-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -18,7 +18,7 @@
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 
   advertising or publicity pertaining to distribution of the
   software without specific, written prior permission.
 

-  The author disclaim all warranties with regard to this
+  The author disclaims all warranties with regard to this

   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages
   software, including all implied warranties of merchantability
   and fitness.  In no event shall the author be liable for any
   special, indirect or consequential damages or any damages


@@ -65,7 +65,7 @@
                #if !defined(__INCLUDE_FROM_COMMON_H)
                        #error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.
                #endif
                #if !defined(__INCLUDE_FROM_COMMON_H)
                        #error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.
                #endif

-               
+

                #if !(defined(ARCH_BIG_ENDIAN) || defined(ARCH_LITTLE_ENDIAN))
                        #error ARCH_BIG_ENDIAN or ARCH_LITTLE_ENDIAN not set for the specified architecture.
                #endif
                #if !(defined(ARCH_BIG_ENDIAN) || defined(ARCH_LITTLE_ENDIAN))
                        #error ARCH_BIG_ENDIAN or ARCH_LITTLE_ENDIAN not set for the specified architecture.
                #endif


@@ -77,6 +77,8 @@
                         *  inside struct or other variable initializers outside of a function, something that is not possible with the
                         *  inline function variant.
                         *
                         *  inside struct or other variable initializers outside of a function, something that is not possible with the
                         *  inline function variant.
                         *

+                        *  \hideinitializer
+                        *

                         *  \ingroup Group_ByteSwapping
                         *
                         *  \param[in] x  16-bit value whose byte ordering is to be swapped.
                         *  \ingroup Group_ByteSwapping
                         *
                         *  \param[in] x  16-bit value whose byte ordering is to be swapped.


@@ -90,6 +92,8 @@
                         *  inside struct or other variable initializers outside of a function, something that is not possible with the
                         *  inline function variant.
                         *
                         *  inside struct or other variable initializers outside of a function, something that is not possible with the
                         *  inline function variant.
                         *

+                        *  \hideinitializer
+                        *

                         *  \ingroup Group_ByteSwapping
                         *
                         *  \param[in] x  32-bit value whose byte ordering is to be swapped.
                         *  \ingroup Group_ByteSwapping
                         *
                         *  \param[in] x  32-bit value whose byte ordering is to be swapped.


@@ -115,11 +119,11 @@
                                #define CPU_TO_LE16(x)           SWAPENDIAN_16(x)
                                #define CPU_TO_LE32(x)           SWAPENDIAN_32(x)
                                #define CPU_TO_BE16(x)           (x)
                                #define CPU_TO_LE16(x)           SWAPENDIAN_16(x)
                                #define CPU_TO_LE32(x)           SWAPENDIAN_32(x)
                                #define CPU_TO_BE16(x)           (x)

-                               #define CPU_TO_BE32(x)           (x)                    
+                               #define CPU_TO_BE32(x)           (x)

                        #elif !defined(le16_to_cpu)
                                /** \name Run-time endianness conversion */
                                //@{
                        #elif !defined(le16_to_cpu)
                                /** \name Run-time endianness conversion */
                                //@{

-                       
+

                                /** Performs a conversion between a Little Endian encoded 16-bit piece of data and the
                                 *  Endianness of the currently selected CPU architecture.
                                 *
                                /** Performs a conversion between a Little Endian encoded 16-bit piece of data and the
                                 *  Endianness of the currently selected CPU architecture.
                                 *


@@ -390,13 +394,15 @@
                         *  \ingroup Group_ByteSwapping
                         *
                         *  \param[in] Word  Word of data whose bytes are to be swapped.
                         *  \ingroup Group_ByteSwapping
                         *
                         *  \param[in] Word  Word of data whose bytes are to be swapped.

+                        *
+                        *  \return Input data with the individual bytes reversed.

                         */
                        static inline uint16_t SwapEndian_16(const uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
                        static inline uint16_t SwapEndian_16(const uint16_t Word)
                        {
                                if (GCC_IS_COMPILE_CONST(Word))
                                  return SWAPENDIAN_16(Word);
                         */
                        static inline uint16_t SwapEndian_16(const uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
                        static inline uint16_t SwapEndian_16(const uint16_t Word)
                        {
                                if (GCC_IS_COMPILE_CONST(Word))
                                  return SWAPENDIAN_16(Word);

-                       
+

                                uint8_t Temp;
 
                                union
                                uint8_t Temp;
 
                                union


@@ -419,6 +425,8 @@
                         *  \ingroup Group_ByteSwapping
                         *
                         *  \param[in] DWord  Double word of data whose bytes are to be swapped.
                         *  \ingroup Group_ByteSwapping
                         *
                         *  \param[in] DWord  Double word of data whose bytes are to be swapped.

+                        *
+                        *  \return Input data with the individual bytes reversed.

                         */
                        static inline uint32_t SwapEndian_32(const uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
                        static inline uint32_t SwapEndian_32(const uint32_t DWord)
                         */
                        static inline uint32_t SwapEndian_32(const uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
                        static inline uint32_t SwapEndian_32(const uint32_t DWord)


@@ -453,6 +461,8 @@
                         *
                         *  \param[in,out] Data    Pointer to a number containing an even number of bytes to be reversed.
                         *  \param[in]     Length  Length of the data in bytes.
                         *
                         *  \param[in,out] Data    Pointer to a number containing an even number of bytes to be reversed.
                         *  \param[in]     Length  Length of the data in bytes.

+                        *
+                        *  \return Input data with the individual bytes reversed.

                         */
                        static inline void SwapEndian_n(void* const Data,
                                                        uint8_t Length) ATTR_NON_NULL_PTR_ARG(1);
                         */
                        static inline void SwapEndian_n(void* const Data,
                                                        uint8_t Length) ATTR_NON_NULL_PTR_ARG(1);


@@ -480,3 +490,4 @@
 #endif
 
 /** @} */
 #endif
 
 /** @} */

+