X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d9643cf6ece3b36fbdb950c56957162dfb0226af..1132488e8f80b43473ce4e53db9dd8ce12e87e13:/LUFA/Common/Common.h?ds=inline diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h index d46f92153..4c9aa4932 100644 --- a/LUFA/Common/Common.h +++ b/LUFA/Common/Common.h @@ -1,13 +1,13 @@ /* LUFA Library - Copyright (C) Dean Camera, 2011. + Copyright (C) Dean Camera, 2012. dean [at] fourwalledcubicle [dot] com www.lufa-lib.org */ /* - Copyright 2011 Dean Camera (dean [at] fourwalledcubicle [dot] com) + Copyright 2012 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 @@ -43,12 +43,6 @@ * @{ */ -/** \defgroup Group_Debugging Debugging Macros - * \brief Convenience macros to aid in debugging applications. - * - * Macros to aid debugging of a user application. - */ - /** \defgroup Group_GlobalInt Global Interrupt Macros * \brief Convenience macros for the management of interrupts globally within the device. * @@ -60,22 +54,23 @@ /* Macros: */ #define __INCLUDE_FROM_COMMON_H - + /* Includes: */ #include #include #include #include - + #if defined(USE_LUFA_CONFIG_HEADER) #include "LUFAConfig.h" #endif - #include "CompilerSpecific.h" #include "Architectures.h" - #include "Attributes.h" #include "BoardTypes.h" - + #include "ArchitectureSpecific.h" + #include "CompilerSpecific.h" + #include "Attributes.h" + /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { @@ -94,10 +89,11 @@ #include #include #include + #include #include - + typedef uint8_t uint_reg_t; - + #define ARCH_HAS_EEPROM_ADDRESS_SPACE #define ARCH_HAS_FLASH_ADDRESS_SPACE #define ARCH_HAS_MULTI_ADDRESS_SPACE @@ -115,7 +111,7 @@ // ================================================= typedef uint32_t uint_reg_t; - + #define ARCH_BIG_ENDIAN #include "Endianness.h" @@ -124,16 +120,17 @@ #include #include #include + #include #include - + typedef uint8_t uint_reg_t; - + #define ARCH_HAS_EEPROM_ADDRESS_SPACE #define ARCH_HAS_FLASH_ADDRESS_SPACE #define ARCH_HAS_MULTI_ADDRESS_SPACE #define ARCH_LITTLE_ENDIAN - #include "Endianness.h" + #include "Endianness.h" #else #error Unknown device architecture specified. #endif @@ -165,7 +162,7 @@ * \return The larger of the two input parameters */ #if !defined(MAX) || defined(__DOXYGEN__) - #define MAX(x, y) ((x > y) ? x : y) + #define MAX(x, y) (((x) > (y)) ? (x) : (y)) #endif /** Convenience macro to determine the smaller of two values. @@ -179,70 +176,27 @@ * \return The smaller of the two input parameters */ #if !defined(MIN) || defined(__DOXYGEN__) - #define MIN(x, y) ((x < y) ? x : y) + #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 optimizer - * removes/reorders code to the point where break points cannot reliably be set. - * - * \note This macro is not available for all architectures. - * - * \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. + #if !defined(STRINGIFY) || defined(__DOXYGEN__) + /** Converts the given input into a string, via the C Preprocessor. This macro puts literal quotation + * marks around the input, converting the source into a string literal. * - * \note This macro is not available for all architectures. + * \param[in] x Input to convert into a string literal. * - * \ingroup Group_Debugging + * \return String version of the input. */ - #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 is not available for all architectures. - * - * \param[in] Condition Condition that will be evaluated. - * - * \ingroup Group_Debugging - */ - #define JTAG_DEBUG_ASSERT(Condition) MACROS{ if (!(Condition)) { JTAG_DEBUG_BREAK(); } }MACROE + #define STRINGIFY(x) #x - /** 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." + /** Converts the given input into a string after macro expansion, via the C Preprocessor. This macro puts + * literal quotation marks around the expanded input, converting the source into a string literal. * - * \note This macro is not available for all architectures. + * \param[in] x Input to expand and convert into a string literal. * - * \param[in] Condition Condition that will be evaluated, - * - * \ingroup Group_Debugging + * \return String version of the expanded input. */ - #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(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. - * - * \note This macro is not available for all architectures. - * - * \param[in] Address Address of the pointer to read. - * - * \return Pointer retrieved from PROGMEM space. - */ - #define pgm_read_ptr(Address) (void*)pgm_read_word(Address) - #endif + #define STRINGIFY_EXPANDED(x) STRINGIFY(x) #endif #if !defined(ISR) || defined(__DOXYGEN__) @@ -260,7 +214,7 @@ * * \param Name Unique name of the interrupt service routine. */ - #define ISR(Name, ...) void Name (void) __attribute__((__interrupt__)) __VA_ARGS__; void Name (void) + #define ISR(Name, ...) void Name (void) __attribute__((__interrupt__)) __VA_ARGS__; void Name (void) #endif /* Inline Functions: */ @@ -268,6 +222,8 @@ * etc. * * \param[in] Byte Byte of data whose bits are to be reversed. + * + * \return Input data with the individual bits reversed (mirrored). */ static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST; static inline uint8_t BitReverse(uint8_t Byte) @@ -285,8 +241,8 @@ * * \param[in] Milliseconds Number of milliseconds to delay */ - static inline void Delay_MS(uint8_t Milliseconds) ATTR_ALWAYS_INLINE; - static inline void Delay_MS(uint8_t Milliseconds) + static inline void Delay_MS(uint16_t Milliseconds) ATTR_ALWAYS_INLINE; + static inline void Delay_MS(uint16_t Milliseconds) { #if (ARCH == ARCH_AVR8) if (GCC_IS_COMPILE_CONST(Milliseconds)) @@ -302,7 +258,7 @@ while (Milliseconds--) { __builtin_mtsr(AVR32_COUNT, 0); - while (__builtin_mfsr(AVR32_COUNT) < (F_CPU / 1000)); + while ((uint32_t)__builtin_mfsr(AVR32_COUNT) < (F_CPU / 1000)); } #elif (ARCH == ARCH_XMEGA) if (GCC_IS_COMPILE_CONST(Milliseconds)) @@ -313,7 +269,7 @@ { while (Milliseconds--) _delay_ms(1); - } + } #endif } @@ -362,12 +318,12 @@ else __builtin_csrf(AVR32_SR_GM_OFFSET); #elif (ARCH == ARCH_XMEGA) - SREG = GlobalIntState; + SREG = GlobalIntState; #endif - + GCC_MEMORY_BARRIER(); } - + /** Enables global interrupt handling for the device, allowing interrupts to be handled. * * \ingroup Group_GlobalInt @@ -386,7 +342,7 @@ #endif GCC_MEMORY_BARRIER(); - } + } /** Disabled global interrupt handling for the device, preventing interrupts from being handled. *