X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/5e7319058268e021ae39ca4b9fcabaec0060117b..b6a3c78fa3e46fea1dd6f4b93352686837983dfd:/LUFA/Common/Common.h diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h index 62aee31df..4efa27ecb 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. * * \copydetails Group_Common */ /** \defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h - * \brief Common library convenience macros and functions. + * \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. @@ -44,13 +44,15 @@ */ /** \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 + * \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 __LUFA_COMMON_H__ @@ -65,6 +67,7 @@ #include #include #include + #include #include "Architectures.h" #include "Attributes.h" @@ -79,6 +82,16 @@ #include #include #include + + typedef uint8_t uintN_t; + typedef int8_t intN_t; + #elif (ARCH == ARCH_UC3B) + #include + + typedef uint32_t uintN_t; + typedef int32_t intN_t; + + #warning The UC3B architecture support is currently experimental and incomplete! #endif /* Public Interface - May be used in end-application: */ @@ -142,10 +155,11 @@ #define JTAG_DEBUG_BREAK() __asm__ __volatile__ ("BREAK" ::) #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. + /** 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. * @@ -163,8 +177,8 @@ #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 AVR's USART - * peripheral. + * 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." * @@ -177,7 +191,7 @@ __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