X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/7dc3d3a68f889efeca5af51b22bd043eff8e0926..f6f4ac588cec25ad7f9baa67fc3c22c9306f962e:/LUFA/Common/Common.h diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h index 837cb0475..b7d564aa3 100644 --- a/LUFA/Common/Common.h +++ b/LUFA/Common/Common.h @@ -29,13 +29,13 @@ */ /** \file - * \brief Common library convenience macros and functions. + * \brief Common library convenience headers, macros and functions. * - * This file contains macros which are common to all library elements, and which may be useful in user code. It - * also includes other common code headers. + * \copydetails Group_Common */ -/** @defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h +/** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h + * \brief Common library convenience headers, macros and functions. * * Common utility headers containing macros, functions, enums and types which are common to all * aspects of the library. @@ -43,25 +43,67 @@ * @{ */ -/** @defgroup Group_Debugging Debugging Macros +/** \defgroup Group_Debugging Debugging Macros + * \brief Convenience macros to aid in debugging applications. * - * Macros for debugging use. + * Macros to aid debugging of a user application. */ -/** @defgroup Group_BitManip Endian and Bit Macros - * - * Functions for swapping endianness and reversing bit orders. - */ - -#ifndef __COMMON_H__ -#define __COMMON_H__ +#ifndef __LUFA_COMMON_H__ +#define __LUFA_COMMON_H__ + /* Macros: */ + #define __INCLUDE_FROM_COMMON_H + /* Includes: */ #include #include - + #include + #include + + #include "Architectures.h" #include "Attributes.h" #include "BoardTypes.h" + + /* Architecture specific utility includes: */ + #if defined(__DOXYGEN__) + /** Type define for an unsigned integer the same width as the selected architecture's machine register. */ + typedef MACHINE_REG_t uint_reg_t; + #elif (ARCH == ARCH_AVR8) + #include + #include + #include + #include + #include + #include + #include + + typedef uint8_t uint_reg_t; + + #define ARCH_LITTLE_ENDIAN + #include "Endianness.h" + #elif (ARCH == ARCH_UC3) + #include + + // === 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 _delay_ms(x) + #define memcmp_P(...) memcmp(__VA_ARGS__) + #define memcpy_P(...) memcpy(__VA_ARGS__) + #define USE_RAM_DESCRIPTORS + // ================================================== + + typedef uint32_t uint_reg_t; + + #define ARCH_BIG_ENDIAN + #include "Endianness.h" + #else + #error Unknown device architecture specified. + #endif /* Public Interface - May be used in end-application: */ /* Macros: */ @@ -79,44 +121,88 @@ */ #define MACROE while (0) - /** Defines a volatile \c 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 optimiser - * removes/reorders code to the point where break points cannot reliably be set. - * - * \ingroup Group_Debugging - */ - #define JTAG_DEBUG_POINT() __asm__ __volatile__ ("NOP" ::) - - /** Defines an explicit JTAG break point in the resulting binary via the assembly \c BREAK statement. When - * a JTAG is used, this causes the program execution to halt when reached until manually resumed. + /** Convenience macro to determine the larger of two values. * - * \ingroup Group_Debugging - */ - #define JTAG_DEBUG_BREAK() __asm__ __volatile__ ("BREAK" ::) - - /** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false. + * \note This macro should only be used with operands that do not have side effects from being evaluated + * multiple times. * - * \param[in] Condition Condition that will be evaluated, + * \param[in] x First value to compare + * \param[in] y First value to compare * - * \ingroup Group_Debugging - */ - #define JTAG_DEBUG_ASSERT(Condition) MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE + * \return The larger of the two input parameters + */ + #if !defined(MAX) || defined(__DOXYGEN__) + #define MAX(x, y) ((x > y) ? x : y) + #endif - /** Macro for testing condition "x" and writing debug data to the stdout stream if \c false. The stdout stream - * must be pre-initialized before this macro is run and linked to an output device, such as the AVR's USART - * peripheral. + /** Convenience macro to determine the smaller of two values. * - * The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {Condition} failed." + * \note This macro should only be used with operands that do not have side effects from being evaluated + * multiple times. * - * \param[in] Condition Condition that will be evaluated, + * \param[in] x First value to compare + * \param[in] y First value to compare * - * \ingroup Group_Debugging + * \return The smaller of the two input parameters */ - #define STDOUT_ASSERT(Condition) MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: " \ - "Assertion \"%s\" failed.\r\n"), \ - __FILE__, __func__, __LINE__, #Condition); } }MACROE + #if !defined(MIN) || defined(__DOXYGEN__) + #define MIN(x, y) ((x < y) ? x : y) + #endif + + #if (ARCH == ARCH_AVR8) || defined(__DOXYGEN__) + /** Defines a volatile \c 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 optimiser + * removes/reorders code to the point where break points cannot reliably be set. + * + * \ingroup Group_Debugging + */ + #define JTAG_DEBUG_POINT() __asm__ __volatile__ ("NOP" ::) + + /** Defines an explicit JTAG break point in the resulting binary via the assembly \c BREAK statement. When + * a JTAG is used, this causes the program execution to halt when reached until manually resumed. + * + * \ingroup Group_Debugging + */ + #define JTAG_DEBUG_BREAK() __asm__ __volatile__ ("BREAK" ::) + + #if !defined(pgm_read_ptr) || defined(__DOXYGEN__) + /** Reads a pointer out of PROGMEM space on the AVR8 architecture. This is currently a wrapper for the + * avr-libc \c pgm_read_ptr() macro with a \c 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. + * + * \param[in] Addr Address of the pointer to read. + * + * \return Pointer retrieved from PROGMEM space. + */ + #define pgm_read_ptr(Addr) (void*)pgm_read_word(Addr) + #endif + + /** Macro for testing condition "x" and breaking via \ref JTAG_DEBUG_BREAK() if the condition is false. + * + * \param[in] Condition Condition that will be evaluated, + * + * \ingroup Group_Debugging + */ + #define JTAG_DEBUG_ASSERT(Condition) MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE + + /** Macro for testing condition "x" and writing debug data to the stdout stream if \c false. The stdout stream + * must be pre-initialized before this macro is run and linked to an output device, such as the microcontroller's + * USART peripheral. + * + * The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {Condition} failed." + * + * \param[in] Condition Condition that will be evaluated, + * + * \ingroup Group_Debugging + */ + #define STDOUT_ASSERT(Condition) MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: " \ + "Assertion \"%s\" failed.\r\n"), \ + __FILE__, __func__, __LINE__, #Condition); } }MACROE + #endif - /** Forces GCC to use pointer indirection (via the AVR's pointer register pairs) when accessing the given + /** Forces GCC to use pointer indirection (via the device's pointer register pairs) when accessing the given * struct pointer. In some cases GCC will emit non-optimal assembly code when accessing a structure through * a pointer, resulting in a larger binary. When this macro is used on a (non \c const) structure pointer before * use, it will force GCC to use pointer indirection on the elements rather than direct store and load @@ -126,48 +212,16 @@ */ #define GCC_FORCE_POINTER_ACCESS(StructPtr) __asm__ __volatile__("" : "=b" (StructPtr) : "0" (StructPtr)) - #if !defined(pgm_read_ptr) || defined(__DOXYGEN__) - /** Reads a pointer out of PROGMEM space. This is currently a wrapper for the avr-libc \c pgm_read_ptr() - * macro with a \c 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. - * - * \param[in] Addr Address of the pointer to read. - * - * \return Pointer retrieved from PROGMEM space. - */ - #define pgm_read_ptr(Addr) (void*)pgm_read_word(Addr) - #endif - - /** 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; @@ -180,87 +234,6 @@ 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 /** @} */