Minor documentation adjustments to the demos, projects and bootloaders to ensure...

[pub/USBasp.git] / LUFA / Common / Attributes.h

diff --git a/LUFA/Common/Attributes.h b/LUFA/Common/Attributes.h
index ac0b11f..ee83db1 100644 (file)
--- a/LUFA/Common/Attributes.h
+++ b/LUFA/Common/Attributes.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
+     Copyright (C) Dean Camera, 2012.

 
   dean [at] fourwalledcubicle [dot] com
 
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  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
 
   Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted


@@ -29,34 +29,34 @@
 */
 
 /** \file
 */
 
 /** \file

- *  \brief AVR-GCC special function/variable attribute macros.
+ *  \brief Special function/variable attribute macros.

  *
  *

- *  This file contains macros for applying GCC specific attributes to functions and variables to control various
- *  optimiser and code generation features of the compiler. Attributes may be placed in the function prototype
- *  or variable declaration in any order, and multiple attributes can be specified for a single item via a space
- *  separated list.
- *
- *  On incompatible versions of GCC or on other compilers, these macros evaluate to nothing unless they are
- *  critical to the code's function and thus must throw a compiler error when used.
+ *  \copydetails Group_FuncVarAttributes

  *
  *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
  *        functionality.
  */
 
 /** \ingroup Group_Common
  *
  *  \note Do not include this file directly, rather include the Common.h header file instead to gain this file's
  *        functionality.
  */
 
 /** \ingroup Group_Common

- *  @defgroup Group_GCCAttr Function/Variable Attributes
+ *  \defgroup Group_FuncVarAttributes Function/Variable Attributes
+ *  \brief Special function/variable attribute macros.

  *
  *

- *  Macros for easy access GCC function and variable attributes, which can be applied to function prototypes or
- *  variable attributes.
+ *  This module contains macros for applying specific attributes to functions and variables to control various
+ *  optimizer and code generation features of the compiler. Attributes may be placed in the function prototype
+ *  or variable declaration in any order, and multiple attributes can be specified for a single item via a space
+ *  separated list.
+ *
+ *  On incompatible versions of GCC or on other compilers, these macros evaluate to nothing unless they are
+ *  critical to the code's function and thus must throw a compile error when used.

  *
  *  @{
  */
 
  *
  *  @{
  */
 

-#ifndef __FUNCATTR_H__
-#define __FUNCATTR_H__
+#ifndef __LUFA_FUNCATTR_H__
+#define __LUFA_FUNCATTR_H__

 
        /* Preprocessor Checks: */
 
        /* Preprocessor Checks: */

-               #if !defined(__COMMON_H__)
+               #if !defined(__INCLUDE_FROM_COMMON_H)

                        #error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.
                #endif
 
                        #error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.
                #endif
 


@@ -73,9 +73,9 @@
                                 */
                                #define ATTR_WARN_UNUSED_RESULT     __attribute__ ((warn_unused_result))
 
                                 */
                                #define ATTR_WARN_UNUSED_RESULT     __attribute__ ((warn_unused_result))
 

-                               /** Indicates that the specified parameters of the function are pointers which should never be NULL.
+                               /** Indicates that the specified parameters of the function are pointers which should never be \c NULL.

                                 *  When applied as a 1-based comma separated list the compiler will emit a warning if the specified
                                 *  When applied as a 1-based comma separated list the compiler will emit a warning if the specified

-                                *  parameters are known at compiler time to be NULL at the point of calling the function.
+                                *  parameters are known at compiler time to be \c NULL at the point of calling the function.

                                 */
                                #define ATTR_NON_NULL_PTR_ARG(...)  __attribute__ ((nonnull (__VA_ARGS__)))
 
                                 */
                                #define ATTR_NON_NULL_PTR_ARG(...)  __attribute__ ((nonnull (__VA_ARGS__)))
 


@@ -85,13 +85,13 @@
                                 */
                                #define ATTR_NAKED                  __attribute__ ((naked))
 
                                 */
                                #define ATTR_NAKED                  __attribute__ ((naked))
 

-                               /** Prevents the compiler from considering a specified function for inlining. When applied, the given
-                                *  function will not be inlined under any circumstances.
+                               /** Prevents the compiler from considering a specified function for in-lining. When applied, the given
+                                *  function will not be in-lined under any circumstances.

                                 */
                                #define ATTR_NO_INLINE              __attribute__ ((noinline))
 
                                /** Forces the compiler to inline the specified function. When applied, the given function will be
                                 */
                                #define ATTR_NO_INLINE              __attribute__ ((noinline))
 
                                /** Forces the compiler to inline the specified function. When applied, the given function will be

-                                *  inlined under all circumstances.
+                                *  in-lined under all circumstances.

                                 */
                                #define ATTR_ALWAYS_INLINE          __attribute__ ((always_inline))
 
                                 */
                                #define ATTR_ALWAYS_INLINE          __attribute__ ((always_inline))
 


@@ -112,27 +112,38 @@
                                 *  identical name (in which case the weak reference is discarded at link time).
                                 */
                                #define ATTR_WEAK                   __attribute__ ((weak))
                                 *  identical name (in which case the weak reference is discarded at link time).
                                 */
                                #define ATTR_WEAK                   __attribute__ ((weak))

-
-                               /** Forces the compiler to not automatically zero the given global variable on startup, so that the
-                                *  current RAM contents is retained. Under most conditions this value will be random due to the
-                                *  behaviour of volatile memory once power is removed, but may be used in some specific circumstances,
-                                *  like the passing of values back after a system watchdog reset.
-                                */
-                               #define ATTR_NO_INIT                __attribute__ ((section (".noinit")))

                        #endif
 
                        #endif
 

+                       /** Forces the compiler to not automatically zero the given global variable on startup, so that the
+                        *  current RAM contents is retained. Under most conditions this value will be random due to the
+                        *  behaviour of volatile memory once power is removed, but may be used in some specific circumstances,
+                        *  like the passing of values back after a system watchdog reset.
+                        */
+                       #define ATTR_NO_INIT                    __attribute__ ((section (".noinit")))
+

                        /** Places the function in one of the initialization sections, which execute before the main function
                         *  of the application. Refer to the avr-libc manual for more information on the initialization sections.
                         *
                         *  \param[in] SectionIndex  Initialization section number where the function should be placed.
                         */
                        /** Places the function in one of the initialization sections, which execute before the main function
                         *  of the application. Refer to the avr-libc manual for more information on the initialization sections.
                         *
                         *  \param[in] SectionIndex  Initialization section number where the function should be placed.
                         */

-                       #define ATTR_INIT_SECTION(SectionIndex) __attribute__ ((naked, section (".init" #SectionIndex )))
+                       #define ATTR_INIT_SECTION(SectionIndex) __attribute__ ((used, naked, section (".init" #SectionIndex )))

 
                        /** Marks a function as an alias for another function.
                         *
                         *  \param[in] Func  Name of the function which the given function name should alias.
                         */
                        #define ATTR_ALIAS(Func)               __attribute__ ((alias( #Func )))
 
                        /** Marks a function as an alias for another function.
                         *
                         *  \param[in] Func  Name of the function which the given function name should alias.
                         */
                        #define ATTR_ALIAS(Func)               __attribute__ ((alias( #Func )))

+
+                       /** Marks a variable or struct element for packing into the smallest space available, omitting any
+                        *  alignment bytes usually added between fields to optimize field accesses.
+                        */
+                       #define ATTR_PACKED                     __attribute__ ((packed))
+
+                       /** Indicates the minimum alignment in bytes for a variable or struct element.
+                        *
+                        *  \param[in] Bytes  Minimum number of bytes the item should be aligned to.
+                        */
+                       #define ATTR_ALIGNED(Bytes)            __attribute__ ((aligned(Bytes)))

 #endif
 
 /** @} */
 #endif
 
 /** @} */