From 74298f8ca11dc8d3b0359d1d4e124d6494c3eeac Mon Sep 17 00:00:00 2001 From: Nicolas Schodet Date: Fri, 10 Apr 2009 01:15:42 +0200 Subject: * digital/avr/modules/usb: - imported LUFA. --- .../usb/lufa/LUFA/Common/FunctionAttributes.h | 110 +++++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100644 digital/avr/modules/usb/lufa/LUFA/Common/FunctionAttributes.h (limited to 'digital/avr/modules/usb/lufa/LUFA/Common/FunctionAttributes.h') diff --git a/digital/avr/modules/usb/lufa/LUFA/Common/FunctionAttributes.h b/digital/avr/modules/usb/lufa/LUFA/Common/FunctionAttributes.h new file mode 100644 index 00000000..16503bb5 --- /dev/null +++ b/digital/avr/modules/usb/lufa/LUFA/Common/FunctionAttributes.h @@ -0,0 +1,110 @@ +/* + LUFA Library + Copyright (C) Dean Camera, 2009. + + dean [at] fourwalledcubicle [dot] com + www.fourwalledcubicle.com +*/ + +/* + Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) + + Permission to use, copy, modify, and distribute this software + and its documentation for any purpose and without fee is hereby + granted, 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 + * + * 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 seperated list. + * + * \note Do not include this file directly, rather include the Common.h header file instead to gain this file's + * functionality. + */ + +#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: */ + /** Indicates to the compiler that the function can not ever return, so that any stack restoring or + * return code may be ommited by the compiler in the resulting binary. + */ + #define ATTR_NO_RETURN __attribute__ ((noreturn)) + + /** Places the function in one of the initilization 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 ))) + + /** 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 seperated list the compiler will emmit 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 preample or postample 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_NOINLINE __attribute__ ((noinline)) + + /** Forces the compiler to inline the specified function. When applied, the given function will be + * inlined under all circumstances. + */ + #define ATTR_ALWAYSINLINE __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)) + + /** Marks a function as an alias for another function of name "x". */ + #define ATTR_ALIAS(x) __attribute__ ((alias( #x ))) + +#endif -- cgit v1.2.3