X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/77f354609f0411fb6541da31a889186ad402838e..e1803e3adb7754ad612a0251f0772f3e37d805aa:/LUFA/Common/Common.h diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h index 4d08e783d..d2d657a39 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 @@ -28,6 +28,13 @@ this software. */ +/** \dir + * \brief Common library header files. + * + * This folder contains header files which are common to all parts of the LUFA library. They may be used freely in + * user applications. + */ + /** \file * \brief Common library convenience headers, macros and functions. * @@ -42,7 +49,7 @@ * * @{ */ - + /** \defgroup Group_GlobalInt Global Interrupt Macros * \brief Convenience macros for the management of interrupts globally within the device. * @@ -54,23 +61,23 @@ /* Macros: */ #define __INCLUDE_FROM_COMMON_H - + /* Includes: */ #include #include #include #include - - #if defined(USE_LUFA_CONFIG_HEADER) - #include "LUFAConfig.h" - #endif #include "Architectures.h" #include "BoardTypes.h" #include "ArchitectureSpecific.h" #include "CompilerSpecific.h" #include "Attributes.h" - + + #if defined(USE_LUFA_CONFIG_HEADER) + #include "LUFAConfig.h" + #endif + /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { @@ -89,10 +96,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 @@ -101,16 +109,17 @@ #include "Endianness.h" #elif (ARCH == ARCH_UC3) #include + #include // === TODO: Find abstracted way to handle these === - #define PROGMEM const + #define PROGMEM #define pgm_read_byte(x) *x #define memcmp_P(...) memcmp(__VA_ARGS__) #define memcpy_P(...) memcpy(__VA_ARGS__) // ================================================= typedef uint32_t uint_reg_t; - + #define ARCH_BIG_ENDIAN #include "Endianness.h" @@ -119,16 +128,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 @@ -151,8 +161,8 @@ /** Convenience macro to determine the larger of two values. * - * \note This macro should only be used with operands that do not have side effects from being evaluated - * multiple times. + * \attention This macro should only be used with operands that do not have side effects from being evaluated + * multiple times. * * \param[in] x First value to compare * \param[in] y First value to compare @@ -165,8 +175,8 @@ /** Convenience macro to determine the smaller of two values. * - * \note This macro should only be used with operands that do not have side effects from being evaluated - * multiple times. + * \attention This macro should only be used with operands that do not have side effects from being evaluated + * multiple times. * * \param[in] x First value to compare * \param[in] y First value to compare @@ -176,7 +186,7 @@ #if !defined(MIN) || defined(__DOXYGEN__) #define MIN(x, y) (((x) < (y)) ? (x) : (y)) #endif - + #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. @@ -210,9 +220,9 @@ * * \ingroup Group_GlobalInt * - * \param Name Unique name of the interrupt service routine. + * \param[in] 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: */ @@ -256,7 +266,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)) @@ -267,7 +277,7 @@ { while (Milliseconds--) _delay_ms(1); - } + } #endif } @@ -291,8 +301,6 @@ #elif (ARCH == ARCH_XMEGA) return SREG; #endif - - GCC_MEMORY_BARRIER(); } /** Sets the global interrupt enable state of the microcontroller to the mask passed into the function. @@ -316,12 +324,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 @@ -340,7 +348,7 @@ #endif GCC_MEMORY_BARRIER(); - } + } /** Disabled global interrupt handling for the device, preventing interrupts from being handled. *