X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/99d8a3936384d1e9286dfecfb6f7896294cd6c11..46f2e488b0508d12be63b14213b8e0499eb01fc0:/LUFA/Common/Common.h diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h index e52aae8e0..3860eff67 100644 --- a/LUFA/Common/Common.h +++ b/LUFA/Common/Common.h @@ -1,21 +1,21 @@ /* LUFA Library Copyright (C) Dean Camera, 2010. - + dean [at] fourwalledcubicle [dot] com - www.fourwalledcubicle.com + www.lufa-lib.org */ /* Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com) - Permission to use, copy, modify, distribute, and sell this + Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted - without fee, provided that the above copyright notice appear in + without fee, provided that the above copyright notice appear in all copies and that both that the copyright notice and this - permission notice and warranty disclaimer appear in supporting - documentation, and that the name of the author not be used in - advertising or publicity pertaining to distribution of the + permission notice and warranty disclaimer appear in supporting + documentation, and that the name of the author not be used in + advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this @@ -34,7 +34,7 @@ * This file contains macros which are common to all library elements, and which may be useful in user code. It * also includes other common headers, such as Atomic.h, Attributes.h and BoardTypes.h. */ - + /** @defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h * * Common utility headers containing macros, functions, enums and types which are common to all @@ -47,7 +47,7 @@ * * Macros for debugging use. */ - + /** @defgroup Group_BitManip Endian and Bit Macros * * Functions for swapping endianness and reversing bit orders. @@ -59,12 +59,12 @@ /* Includes: */ #include #include - + #include "Attributes.h" #include "BoardTypes.h" /* Public Interface - May be used in end-application: */ - /* Macros: */ + /* Macros: */ /** Macro for encasing other multi-statement macros. This should be used along with an opening brace * before the start of any multi-statement macro, so that the macros contents as a whole are treated * as a discrete block and not as a list of separate statements which may cause problems when used as @@ -78,22 +78,22 @@ * a block (such as inline IF statements). */ #define MACROE while (0) - + /** Defines a volatile 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 + * 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" ::) + #define JTAG_DEBUG_POINT() __asm__ volatile ("NOP" ::) /** Defines an explicit JTAG break point in the resulting binary via the ASM 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" ::) - + #define JTAG_DEBUG_BREAK() __asm__ volatile ("BREAK" ::) + /** Macro for testing condition "x" and breaking via JTAG_DEBUG_BREAK() if the condition is false. * * \ingroup Group_Debugging @@ -114,7 +114,7 @@ #if !defined(pgm_read_ptr) || defined(__DOXYGEN__) /** Reads a pointer out of PROGMEM space. This is currently a wrapper for the avr-libc pgm_read_ptr() - * macro with a void* cast, so that its value can be assigned diretly to a pointer variable or used + * macro with a 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. * @@ -165,15 +165,15 @@ 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(uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST; - static inline uint16_t SwapEndian_16(uint16_t Word) + 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; @@ -182,13 +182,13 @@ 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; } @@ -198,8 +198,8 @@ * * \param[in] DWord Double word of data whose bytes are to be swapped. */ - static inline uint32_t SwapEndian_32(uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST; - static inline uint32_t SwapEndian_32(uint32_t DWord) + 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; @@ -208,17 +208,17 @@ 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; } @@ -229,11 +229,13 @@ * \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); - static inline void SwapEndian_n(void* Data, uint8_t 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; @@ -248,3 +250,4 @@ #endif /** @} */ +