X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/7dc3d3a68f889efeca5af51b22bd043eff8e0926..29ba88cffd4198b02e8ca04c31aed2c175c5502e:/LUFA/Common/Common.h diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h index 837cb0475..355391b2a 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,71 @@ * @{ */ -/** @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 +/** \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. + * Functions for swapping endianness and reversing bit orders of data. */ -#ifndef __COMMON_H__ -#define __COMMON_H__ +#ifndef __LUFA_COMMON_H__ +#define __LUFA_COMMON_H__ + /* Macros: */ + #if !defined(__DOXYGEN__) + #define __INCLUDE_FROM_COMMON_H + #endif + /* 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; + #elif (ARCH == ARCH_UC3B) + #include + + typedef uint32_t uint_reg_t; + + // TODO + #define EEMEM + #define PROGMEM const + #define ISR(Name) void Name (void) + #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__) + + #warning The UC3B architecture support is currently experimental and incomplete! + #endif /* Public Interface - May be used in end-application: */ /* Macros: */ @@ -79,44 +125,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,19 +216,6 @@ */ #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