Clarify in the documentation that the Audio demos and driver is for the Audio 1.0...

[pub/lufa.git] / LUFA / Common / Common.h

diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h
index 7fd1555..e939b66 100644 (file)
--- a/LUFA/Common/Common.h
+++ b/LUFA/Common/Common.h
@@ -57,13 +57,14 @@
 #define __COMMON_H__
 
        /* Includes: */
-               #include <avr/io.h>
+               #include <stdint.h>
+               #include <stdbool.h>
        
                #include "Attributes.h"
                #include "BoardTypes.h"
 
        /* Public Interface - May be used in end-application: */
-               /* Macros: */           
+               /* Macros: */
                        /** Macro for encasing other multi-statement macros. This should be used along with an opening brace
                         *  before the start of any multi-statement macro, so that the macros contents as a whole are treated
                         *  as a discrete block and not as a list of separate statements which may cause problems when used as
@@ -79,7 +80,7 @@
                        #define MACROE                  while (0)
                        
                        /** Defines a volatile NOP statement which cannot be optimized out by the compiler, and thus can always
-                        *  be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimizer
+                        *  be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimiser
                         *  removes/reorders code to the point where break points cannot reliably be set.
                         *
                         *  \ingroup Group_Debugging
@@ -113,7 +114,7 @@
 
                        #if !defined(pgm_read_ptr) || defined(__DOXYGEN__)
                                /** Reads a pointer out of PROGMEM space. This is currently a wrapper for the avr-libc pgm_read_ptr()
-                                *  macro with a void* cast, so that its value can be assigned diretly to a pointer variable or used
+                                *  macro with a void* cast, so that its value can be assigned directly to a pointer variable or used
                                 *  in pointer arithmetic without further casting in C. In a future avr-libc distribution this will be
                                 *  part of the standard API and will be implemented in a more formal manner.
                                 *
@@ -171,10 +172,24 @@
                         *
                         *  \param[in] Word  Word of data whose bytes are to be swapped.
                         */
-                       static inline uint16_t SwapEndian_16(uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
-                       static inline uint16_t SwapEndian_16(uint16_t 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)
                        {
-                               return ((Word >> 8) | (Word << 8));                             
+                               uint8_t Temp;
+
+                               union
+                               {
+                                       uint16_t Word;
+                                       uint8_t  Bytes[2];
+                               } Data;
+                               
+                               Data.Word = Word;
+                               
+                               Temp = Data.Bytes[0];
+                               Data.Bytes[0] = Data.Bytes[1];
+                               Data.Bytes[1] = Temp;
+                               
+                               return Data.Word;
                        }
 
                        /** Function to reverse the byte ordering of the individual bytes in a 32 bit number.
@@ -183,13 +198,28 @@
                         *
                         *  \param[in] DWord  Double word of data whose bytes are to be swapped.
                         */
-                       static inline uint32_t SwapEndian_32(uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
-                       static inline uint32_t SwapEndian_32(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)
                        {
-                               return (((DWord & 0xFF000000) >> 24) |
-                                       ((DWord & 0x00FF0000) >> 8)  |
-                                               ((DWord & 0x0000FF00) << 8)  |
-                                               ((DWord & 0x000000FF) << 24));
+                               uint8_t Temp;
+
+                               union
+                               {
+                                       uint32_t DWord;
+                                       uint8_t  Bytes[4];
+                               } Data;
+                               
+                               Data.DWord = DWord;
+                               
+                               Temp = Data.Bytes[0];
+                               Data.Bytes[0] = Data.Bytes[3];
+                               Data.Bytes[3] = Temp;
+                               
+                               Temp = Data.Bytes[1];
+                               Data.Bytes[1] = Data.Bytes[2];
+                               Data.Bytes[2] = Temp;
+                               
+                               return Data.DWord;
                        }
 
                        /** Function to reverse the byte ordering of the individual bytes in a n byte number.
@@ -199,8 +229,10 @@
                         *  \param[in,out] Data   Pointer to a number containing an even number of bytes to be reversed.
                         *  \param[in]     Bytes  Length of the data in bytes.
                         */
-                       static inline void SwapEndian_n(void* Data, uint8_t Bytes);
-                       static inline void SwapEndian_n(void* Data, uint8_t Bytes)
+                       static inline void SwapEndian_n(void* Data,
+                                                       uint8_t Bytes) ATTR_NON_NULL_PTR_ARG(1);
+                       static inline void SwapEndian_n(void* Data,
+                                                       uint8_t Bytes)
                        {
                                uint8_t* CurrDataPos = (uint8_t*)Data;