-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2010.\r
- \r
- dean [at] fourwalledcubicle [dot] com\r
- www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
- Copyright 2010 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, distribute, and sell this \r
- software and its documentation for any purpose is hereby granted\r
- without fee, provided that the above copyright notice appear in \r
- all copies and that both that the copyright notice and this\r
- permission notice and warranty disclaimer appear in supporting \r
- documentation, and that the name of the author not be used in \r
- advertising or publicity pertaining to distribution of the \r
- software without specific, written prior permission.\r
-\r
- The author disclaim all warranties with regard to this\r
- software, including all implied warranties of merchantability\r
- and fitness. In no event shall the author be liable for any\r
- special, indirect or consequential damages or any damages\r
- whatsoever resulting from loss of use, data or profits, whether\r
- in an action of contract, negligence or other tortious action,\r
- arising out of or in connection with the use or performance of\r
- this software.\r
-*/\r
-\r
-/** \file\r
- * \brief AVR-GCC special function/variable attribute macros.\r
- *\r
- * This file contains macros for applying GCC specific attributes to functions and variables to control various\r
- * optimizer and code generation features of the compiler. Attributes may be placed in the function prototype \r
- * or variable declaration in any order, and multiple attributes can be specified for a single item via a space\r
- * separated list.\r
- *\r
- * On incompatible versions of GCC or on other compilers, these macros evaluate to nothing unless they are\r
- * critical to the code's function and thus must throw a compiler error when used.\r
- *\r
- * \note Do not include this file directly, rather include the Common.h header file instead to gain this file's\r
- * functionality.\r
- */\r
- \r
-/** \ingroup Group_Common\r
- * @defgroup Group_GCCAttr Function/Variable Attributes\r
- *\r
- * Macros for easy access GCC function and variable attributes, which can be applied to function prototypes or\r
- * variable attributes.\r
- *\r
- * @{\r
- */\r
-\r
-#ifndef __FUNCATTR_H__\r
-#define __FUNCATTR_H__\r
-\r
- /* Preprocessor Checks: */\r
- #if !defined(__COMMON_H__)\r
- #error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.\r
- #endif\r
-\r
- /* Public Interface - May be used in end-application: */\r
- /* Macros: */\r
- #if (__GNUC__ >= 3) || defined(__DOXYGEN__)\r
- /** Indicates to the compiler that the function can not ever return, so that any stack restoring or\r
- * return code may be omitted by the compiler in the resulting binary.\r
- */\r
- #define ATTR_NO_RETURN __attribute__ ((noreturn))\r
- \r
- /** Indicates that the function returns a value which should not be ignored by the user code. When\r
- * applied, any ignored return value from calling the function will produce a compiler warning.\r
- */\r
- #define ATTR_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))\r
-\r
- /** Indicates that the specified parameters of the function are pointers which should never be NULL.\r
- * When applied as a 1-based comma separated list the compiler will emit a warning if the specified\r
- * parameters are known at compiler time to be NULL at the point of calling the function.\r
- */\r
- #define ATTR_NON_NULL_PTR_ARG(...) __attribute__ ((nonnull (__VA_ARGS__)))\r
-\r
- /** Removes any preamble or postamble from the function. When used, the function will not have any\r
- * register or stack saving code. This should be used with caution, and when used the programmer\r
- * is responsible for maintaining stack and register integrity.\r
- */\r
- #define ATTR_NAKED __attribute__ ((naked))\r
- \r
- /** Prevents the compiler from considering a specified function for inlining. When applied, the given\r
- * function will not be inlined under any circumstances.\r
- */\r
- #define ATTR_NO_INLINE __attribute__ ((noinline))\r
-\r
- /** Forces the compiler to inline the specified function. When applied, the given function will be\r
- * inlined under all circumstances.\r
- */\r
- #define ATTR_ALWAYS_INLINE __attribute__ ((always_inline))\r
- \r
- /** Indicates that the specified function is pure, in that it has no side-effects other than global\r
- * or parameter variable access.\r
- */\r
- #define ATTR_PURE __attribute__ ((pure))\r
- \r
- /** Indicates that the specified function is constant, in that it has no side effects other than\r
- * parameter access.\r
- */\r
- #define ATTR_CONST __attribute__ ((const))\r
- \r
- /** Marks a given function as deprecated, which produces a warning if the function is called. */\r
- #define ATTR_DEPRECATED __attribute__ ((deprecated))\r
- \r
- /** Marks a function as a weak reference, which can be overridden by other functions with an\r
- * identical name (in which case the weak reference is discarded at link time).\r
- */\r
- #define ATTR_WEAK __attribute__ ((weak))\r
- \r
- /** Forces the compiler to not automatically zero the given global variable on startup, so that the\r
- * current RAM contents is retained. Under most conditions this value will be random due to the\r
- * behaviour of volatile memory once power is removed, but may be used in some specific circumstances,\r
- * like the passing of values back after a system watchdog reset.\r
- */\r
- #define ATTR_NO_INIT __attribute__ ((section (".noinit")))\r
- #endif\r
-\r
- /** Places the function in one of the initialization sections, which execute before the main function\r
- * of the application. Refer to the avr-libc manual for more information on the initialization sections.\r
- *\r
- * \param[in] x Initialization section number where the function should be placed\r
- */\r
- #define ATTR_INIT_SECTION(x) __attribute__ ((naked, section (".init" #x )))\r
- \r
- /** Marks a function as an alias for another function.\r
- *\r
- * \param[in] x Name of the function which the given function name should alias\r
- */\r
- #define ATTR_ALIAS(x) __attribute__ ((alias( #x )))\r
-#endif\r
-\r
-/** @} */\r
+/*
+ LUFA Library
+ Copyright (C) Dean Camera, 2010.
+
+ dean [at] fourwalledcubicle [dot] com
+ www.fourwalledcubicle.com
+*/
+
+/*
+ Copyright 2010 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
+ 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
+ software without specific, written prior permission.
+
+ The author disclaim all warranties with regard to this
+ software, including all implied warranties of merchantability
+ and fitness. In no event shall the author be liable for any
+ special, indirect or consequential damages or any damages
+ whatsoever resulting from loss of use, data or profits, whether
+ in an action of contract, negligence or other tortious action,
+ arising out of or in connection with the use or performance of
+ this software.
+*/
+
+/** \file
+ * \brief AVR-GCC special function/variable attribute macros.
+ *
+ * This file contains macros for applying GCC 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 compiler error when used.
+ *
+ * \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
+ *
+ * Macros for easy access GCC function and variable attributes, which can be applied to function prototypes or
+ * variable attributes.
+ *
+ * @{
+ */
+
+#ifndef __FUNCATTR_H__
+#define __FUNCATTR_H__
+
+ /* Preprocessor Checks: */
+ #if !defined(__COMMON_H__)
+ #error Do not include this file directly. Include LUFA/Common/Common.h instead to gain this functionality.
+ #endif
+
+ /* Public Interface - May be used in end-application: */
+ /* Macros: */
+ #if (__GNUC__ >= 3) || defined(__DOXYGEN__)
+ /** Indicates to the compiler that the function can not ever return, so that any stack restoring or
+ * return code may be omitted by the compiler in the resulting binary.
+ */
+ #define ATTR_NO_RETURN __attribute__ ((noreturn))
+
+ /** Indicates that the function returns a value which should not be ignored by the user code. When
+ * applied, any ignored return value from calling the function will produce a compiler warning.
+ */
+ #define ATTR_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
+
+ /** Indicates that the specified parameters of the function are pointers which should never be NULL.
+ * 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.
+ */
+ #define ATTR_NON_NULL_PTR_ARG(...) __attribute__ ((nonnull (__VA_ARGS__)))
+
+ /** Removes any preamble or postamble from the function. When used, the function will not have any
+ * register or stack saving code. This should be used with caution, and when used the programmer
+ * is responsible for maintaining stack and register integrity.
+ */
+ #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.
+ */
+ #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.
+ */
+ #define ATTR_ALWAYS_INLINE __attribute__ ((always_inline))
+
+ /** Indicates that the specified function is pure, in that it has no side-effects other than global
+ * or parameter variable access.
+ */
+ #define ATTR_PURE __attribute__ ((pure))
+
+ /** Indicates that the specified function is constant, in that it has no side effects other than
+ * parameter access.
+ */
+ #define ATTR_CONST __attribute__ ((const))
+
+ /** Marks a given function as deprecated, which produces a warning if the function is called. */
+ #define ATTR_DEPRECATED __attribute__ ((deprecated))
+
+ /** Marks a function as a weak reference, which can be overridden by other functions with an
+ * 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
+
+ /** 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] x Initialization section number where the function should be placed
+ */
+ #define ATTR_INIT_SECTION(x) __attribute__ ((naked, section (".init" #x )))
+
+ /** Marks a function as an alias for another function.
+ *
+ * \param[in] x Name of the function which the given function name should alias
+ */
+ #define ATTR_ALIAS(x) __attribute__ ((alias( #x )))
+#endif
+
+/** @} */
projects / pub / USBasp.git / blobdiff