Add custom footer to the main library documentation.

[pub/lufa.git] / LUFA / Common / Common.h

diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h
index 3860eff..8e7f239 100644 (file)
--- a/LUFA/Common/Common.h
+++ b/LUFA/Common/Common.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2011.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  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
@@ -85,32 +85,46 @@
                         *
                         *  \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.
                         *
+                        *  \param[in] Condition  Condition that will be evaluated,
+                        *
                         *  \ingroup Group_Debugging
                        */
-                       #define JTAG_DEBUG_ASSERT(x)    MACROS{ if (!(x)) { JTAG_DEBUG_BREAK(); } }MACROE
+                       #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 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.
                         *
-                        *  The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {x} failed."
+                        *  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(x)        MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: "   \
-                                                                    "Assertion \"%s\" failed.\r\n"),     \
-                                                                    __FILE__, __func__, __LINE__, #x); } }MACROE
+                       #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
+                       
+                       /** Forces GCC to use pointer indirection (via the AVR'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-const) structure pointer before
+                        *  use, it will force GCC to use pointer indirection on the elements rather than direct store and load
+                        *  instructions.
+                        *
+                        *  \param[in, out] StructPtr  Pointer to a structure which is to be forced into indirect access mode.
+                        */
+                       #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 pgm_read_ptr()