Fix bugs in the new VirtualSerialMassStorage demo (thanks to Martin Degelsegger).
[pub/USBasp.git] / LUFA / Common / Common.h
index 76e1be1..b7d564a 100644 (file)
  *  Macros to aid debugging of a user application.
  */
 
-/** \defgroup Group_BitManip Endian and Bit Macros
- *  \brief Convenience macros to aid in bit manipulations and endianness transforms.
- *
- *  Functions for swapping endianness and reversing bit orders of data.
- */
-
 #ifndef __LUFA_COMMON_H__
 #define __LUFA_COMMON_H__
 
        /* Macros: */
-               #if !defined(__DOXYGEN__)
-                       #define __INCLUDE_FROM_COMMON_H
-               #endif
+               #define __INCLUDE_FROM_COMMON_H
                
        /* Includes: */
                #include <stdint.h>
                        #include <util/delay.h>
                        
                        typedef uint8_t uint_reg_t;
-               #elif (ARCH == ARCH_UC3B)
+                       
+                       #define  ARCH_LITTLE_ENDIAN
+                       #include "Endianness.h"
+               #elif (ARCH == ARCH_UC3)
                        #include <avr32/io.h>
 
-                       typedef uint32_t uint_reg_t;
-                       
-                       // TODO
-                       #define EEMEM
-                       #define PROGMEM                  const
+                       // === TODO: Find abstracted way to handle these ===
                        #define ISR(Name)                void Name (void) __attribute__((__interrupt__)); void Name (void)
+                       #define PROGMEM                  const
                        #define ATOMIC_BLOCK(x)          if (1)
                        #define ATOMIC_RESTORESTATE
                        #define pgm_read_byte(x)         *x
-                       #define eeprom_read_byte(x)      *x
-                       #define eeprom_update_byte(x, y) *x = y
-                       #define eeprom_write_byte(x, y)  *x = y
                        #define _delay_ms(x)
                        #define memcmp_P(...)            memcmp(__VA_ARGS__)
                        #define memcpy_P(...)            memcpy(__VA_ARGS__)
-                       #define cpu_irq_enable()         do { asm volatile("" ::: "memory"); __builtin_csrf(AVR32_SR_GM_OFFSET); } while (0)
-                       #define cpu_irq_disable()        do { __builtin_ssrf(AVR32_SR_GM_OFFSET); asm volatile("" ::: "memory"); } while (0)
+                       #define USE_RAM_DESCRIPTORS
+                       // ==================================================
+
+                       typedef uint32_t uint_reg_t;
                        
-                       #warning The UC3B architecture support is currently experimental and incomplete!
+                       #define  ARCH_BIG_ENDIAN
+                       #include "Endianness.h"
+               #else
+                       #error Unknown device architecture specified.
                #endif
 
        /* Public Interface - May be used in end-application: */
                         */
                        #define GCC_FORCE_POINTER_ACCESS(StructPtr) __asm__ __volatile__("" : "=b" (StructPtr) : "0" (StructPtr))
 
-                       /** Swaps the byte ordering of a 16-bit value at compile time. Do not use this macro for swapping byte orderings
-                        *  of dynamic values computed at runtime, use \ref SwapEndian_16() instead. The result of this macro can be used
-                        *  inside struct or other variable initializers outside of a function, something that is not possible with the
-                        *  inline function variant.
-                        *
-                        *  \param[in]  x  16-bit value whose byte ordering is to be swapped.
-                        *
-                        *  \return Input value with the byte ordering reversed.
-                        */
-                       #define SWAPENDIAN_16(x)          ((((x) & 0xFF00) >> 8) | (((x) & 0x00FF) << 8))
-
-                       /** Swaps the byte ordering of a 32-bit value at compile time. Do not use this macro for swapping byte orderings
-                        *  of dynamic values computed at runtime- use \ref SwapEndian_32() instead. The result of this macro can be used
-                        *  inside struct or other variable initializers outside of a function, something that is not possible with the
-                        *  inline function variant.
-                        *
-                        *  \param[in]  x  32-bit value whose byte ordering is to be swapped.
-                        *
-                        *  \return Input value with the byte ordering reversed.
+                       /** Forces GCC to create a memory barrier, ensuring that memory accesses are not reordered past the barrier point.
+                        *  This can be used before ordering-critical operations, to ensure that the compiler does not re-order the resulting
+                        *  assembly output in an unexpected manner on sections of code that are ordering-specific.
                         */
-                       #define SWAPENDIAN_32(x)          ((((x) & 0xFF000000UL) >> 24UL) | (((x) & 0x00FF0000UL) >> 8UL) | \
-                                                          (((x) & 0x0000FF00UL) << 8UL)  | (((x) & 0x000000FFUL) << 24UL))
+                       #define GCC_MEMORY_BARRIER()                __asm__ __volatile__("" ::: "memory");
 
                /* Inline Functions: */
                        /** Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1,
                         *  etc.
                         *
-                        *  \ingroup Group_BitManip
-                        *
                         *  \param[in] Byte  Byte of data whose bits are to be reversed.
                         */
                        static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST;
                                return Byte;
                        }
 
-                       /** Function to reverse the byte ordering of the individual bytes in a 16 bit number.
-                        *
-                        *  \ingroup Group_BitManip
-                        *
-                        *  \param[in] Word  Word of data whose bytes are to be swapped.
-                        */
-                       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)
-                       {
-                               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.
-                        *
-                        *  \ingroup Group_BitManip
-                        *
-                        *  \param[in] DWord  Double word of data whose bytes are to be swapped.
-                        */
-                       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)
-                       {
-                               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.
-                        *
-                        *  \ingroup Group_BitManip
-                        *
-                        *  \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) ATTR_NON_NULL_PTR_ARG(1);
-                       static inline void SwapEndian_n(void* Data,
-                                                       uint8_t Bytes)
-                       {
-                               uint8_t* CurrDataPos = (uint8_t*)Data;
-
-                               while (Bytes > 1)
-                               {
-                                       uint8_t Temp = *CurrDataPos;
-                                       *CurrDataPos = *(CurrDataPos + Bytes - 1);
-                                       *(CurrDataPos + Bytes - 1) = Temp;
-
-                                       CurrDataPos++;
-                                       Bytes -= 2;
-                               }
-                       }
-
 #endif
 
 /** @} */