From 3eb81df998349e90c3d973e6301f19382c5b2e84 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Thu, 15 Apr 2010 11:04:24 +0000 Subject: Rename FunctionAttributes.h to Attributes.h, as some attributes are applicable to variables also. Add new ATTR_NOINIT attribute for global variables. Add the beginnings of a SDP implentation to the incomplete BluetoothHost demo. Add const attribute to the Mass Storage Host driver functions where it was applicable, but missing. --- LUFA/Common/Attributes.h | 134 +++++++++++++++++++++++++++++++++++++++ LUFA/Common/Common.h | 4 +- LUFA/Common/FunctionAttributes.h | 125 ------------------------------------ 3 files changed, 136 insertions(+), 127 deletions(-) create mode 100644 LUFA/Common/Attributes.h delete mode 100644 LUFA/Common/FunctionAttributes.h (limited to 'LUFA/Common') diff --git a/LUFA/Common/Attributes.h b/LUFA/Common/Attributes.h new file mode 100644 index 000000000..62d40734a --- /dev/null +++ b/LUFA/Common/Attributes.h @@ -0,0 +1,134 @@ +/* + 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. The init function number can be specified as "x", as an integer. Refer to the + * avr-libc manual for more information on the initialization sections. + */ + #define ATTR_INIT_SECTION(x) __attribute__ ((naked, section (".init" #x ))) + + /** Marks a function as an alias for another function of name "x". */ + #define ATTR_ALIAS(x) __attribute__ ((alias( #x ))) +#endif + +/** @} */ diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h index f64de8ff8..5f1b2eae5 100644 --- a/LUFA/Common/Common.h +++ b/LUFA/Common/Common.h @@ -32,7 +32,7 @@ * \brief Common library convenience macros and functions. * * 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, FunctionAttributes.h and BoardTypes.h. + * 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 @@ -59,7 +59,7 @@ /* Includes: */ #include - #include "FunctionAttributes.h" + #include "Attributes.h" #include "BoardTypes.h" /* Public Interface - May be used in end-application: */ diff --git a/LUFA/Common/FunctionAttributes.h b/LUFA/Common/FunctionAttributes.h deleted file mode 100644 index a3c9a8a3a..000000000 --- a/LUFA/Common/FunctionAttributes.h +++ /dev/null @@ -1,125 +0,0 @@ -/* - 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 attribute macros. - * - * This file contains macros for applying GCC specific attributes to functions to control various optimizer - * and code generation features of the compiler. Attributes may be placed in the function prototype in any - * order, and multiple attributes can be specified for a single function 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_FuncAttr Function Attributes - * - * Macros for easy access GCC function attributes, which can be applied to function prototypes. - * - * @{ - */ - -#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)) - #endif - - /** Places the function in one of the initialization sections, which execute before the main function - * of the application. The init function number can be specified as "x", as an integer. Refer to the - * avr-libc manual for more information on the initialization sections. - */ - #define ATTR_INIT_SECTION(x) __attribute__ ((naked, section (".init" #x ))) - - /** Marks a function as an alias for another function of name "x". */ - #define ATTR_ALIAS(x) __attribute__ ((alias( #x ))) -#endif - -/** @} */ -- cgit v1.2.3