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. --- .../avr/modules/usb/lufa/LUFA/Common/BoardTypes.h | 72 +++++++++ .../avr/modules/usb/lufa/LUFA/Common/ButtLoadTag.h | 77 ++++++++++ digital/avr/modules/usb/lufa/LUFA/Common/Common.h | 171 +++++++++++++++++++++ .../usb/lufa/LUFA/Common/FunctionAttributes.h | 110 +++++++++++++ 4 files changed, 430 insertions(+) create mode 100644 digital/avr/modules/usb/lufa/LUFA/Common/BoardTypes.h create mode 100644 digital/avr/modules/usb/lufa/LUFA/Common/ButtLoadTag.h create mode 100644 digital/avr/modules/usb/lufa/LUFA/Common/Common.h create mode 100644 digital/avr/modules/usb/lufa/LUFA/Common/FunctionAttributes.h (limited to 'digital/avr/modules/usb/lufa/LUFA/Common') diff --git a/digital/avr/modules/usb/lufa/LUFA/Common/BoardTypes.h b/digital/avr/modules/usb/lufa/LUFA/Common/BoardTypes.h new file mode 100644 index 00000000..d4a36550 --- /dev/null +++ b/digital/avr/modules/usb/lufa/LUFA/Common/BoardTypes.h @@ -0,0 +1,72 @@ +/* + 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 constants which can be passed to the compiler (via setting the macro BOARD) in the + * user project makefile using the -D option to configure the library board-specific drivers. + * + * \note Do not include this file directly, rather include the Common.h header file instead to gain this file's + * functionality. + */ + +#ifndef __BOARDTYPES_H__ +#define __BOARDTYPES_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: */ + /** Selects the USBKEY specific board drivers, including Dataflash, Joystick and LED drivers. */ + #define BOARD_USBKEY 0 + + /** Selects the STK525 specific board drivers, including Dataflash, Joystick and LED drivers. */ + #define BOARD_STK525 1 + + /** Selects the STK526 specific board drivers, including Dataflash, Joystick and LED drivers. */ + #define BOARD_STK526 2 + + /** Selects the RZUSBSTICK specific board drivers, including the driver for the boards LEDs. */ + #define BOARD_RZUSBSTICK 3 + + /** Selects the ATAVRUSBRF01 specific board drivers, including the driver for the board LEDs. */ + #define BOARD_ATAVRUSBRF01 4 + + /** Selects the user-defined board drivers, which should be placed in the user project's folder + * under a directory named /Board/. Each board driver should be named identically to the LUFA + * master board driver (i.e., driver in the LUFA/Drivers/Board director) so that the library + * can correctly identify it. + */ + #define BOARD_USER 5 + +#endif diff --git a/digital/avr/modules/usb/lufa/LUFA/Common/ButtLoadTag.h b/digital/avr/modules/usb/lufa/LUFA/Common/ButtLoadTag.h new file mode 100644 index 00000000..54fab0f0 --- /dev/null +++ b/digital/avr/modules/usb/lufa/LUFA/Common/ButtLoadTag.h @@ -0,0 +1,77 @@ +/* + 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 the embedding of compile-time strings into the resultant project binary for + * identification purposes. It is designed to prefix "tags" with the magic string of "@(#)" so that the tags + * can easily be identified in the binary data. + * + * These tags are compatible with the ButtLoad project at http://www.fourwalledcubicle.com/ButtLoad.php . + */ + +#ifndef __BUTTLOADTAG_H__ +#define __BUTTLOADTAG_H__ + + /* Includes: */ + #include + #include + + /* Public Interface - May be used in end-application: */ + /* Macros: */ + /** Creates a new tag in the resultant binary, containing the specified data array. The macro id + * parameter is only for identification purposes (so that the tag data can be referenced in code) + * and is not visible in the compiled binary. + */ + #define BUTTLOADTAG(id, data) const struct ButtLoadTagData BUTTTAG_##id \ + PROGMEM __attribute__((used, externally_visible)) = \ + {MagicString: BT_TAGHEADER, TagData: data} + + /** Macro for retrieving a reference to the specified tag's contents. The tag data is located in + * the program memory (FLASH) space, and so must be read out with the macros in avr-libc which + * deal with embedded data. + */ + #define BUTTLOADTAG_DATA(id) BUTTTAG_##id.TagData + + /* Structures: */ + /** Structure for ButtLoad compatible binary tags. */ + struct ButtLoadTagData + { + char MagicString[4]; /**< Magic tag header, containing the string "@(#)". */ + char TagData[]; /**< Tag contents as a char array. */ + }; + + /* Private Interface - For use in library only: */ + #if !defined(__DOXYGEN__) + /* Macros: */ + #define BT_TAGHEADER {'@','(','#',')'} + #endif + +#endif diff --git a/digital/avr/modules/usb/lufa/LUFA/Common/Common.h b/digital/avr/modules/usb/lufa/LUFA/Common/Common.h new file mode 100644 index 00000000..97e9ce93 --- /dev/null +++ b/digital/avr/modules/usb/lufa/LUFA/Common/Common.h @@ -0,0 +1,171 @@ +/* + 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 which are common to all library elements, and which may be useful in user code. It + * also includes other common headees, such as Atomic.h, FunctionAttributes.h and BoardTypes.h. + */ + +#ifndef __COMMON_H__ +#define __COMMON_H__ + + /* Includes: */ + #include + #include + #include + + #include "FunctionAttributes.h" + #include "BoardTypes.h" + + #include + + /* Public Interface - May be used in end-application: */ + /* Macros: */ + /** Macro for encasing other multi-statment macros. This should be used along with an opening brace + * before the start of any multi-statement macro, so that the macros contents as a whole are treated + * as a discreete block and not as a list of seperate statements which may cause problems when used as + * a block (such as inline IF statments). + */ + #define MACROS do + + /** Macro for encasing other multi-statment macros. This should be used along with a preceeding closing + * brace at the end of any multi-statement macro, so that the macros contents as a whole are treated + * as a discreete block and not as a list of seperate statements which may cause problems when used as + * a block (such as inline IF statments). + */ + #define MACROE while (0) + + /** Defines a volatile NOP statment which cannot be optimized out by the compiler, and thus can always + * be set as a breakpoint in the resulting code. Useful for debugging purposes, where the optimizer + * removes/reorders code to the point where break points cannot reliably be set. + */ + #define JTAG_DEBUG_POINT() asm volatile ("NOP" ::) + + /** Defines an explicit JTAG break point in the resulting binary via the ASM BREAK statment. When + * a JTAG is used, this causes the program execution to halt when reached until manually resumed. */ + #define JTAG_DEBUG_BREAK() asm volatile ("BREAK" ::) + + /** Macro for testing condition "x" and breaking via JTAG_DEBUG_BREAK() if the condition is false. */ + #define JTAG_DEBUG_ASSERT(x) MACROS{ if (!(x)) { JTAG_DEBUG_BREAK(); } }MACROE + + /** Macro for testing condition "x" and writing debug data to the serial stream if false. As a + * prerequisite for this macro, the serial stream should be configured via the Serial_Stream driver. + * + * The serial output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion + * {x} failed." + */ + #define SERIAL_STREAM_ASSERT(x) MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: " \ + "Assertion \"%s\" failed.\r\n"), \ + __FILE__, __func__, __LINE__, #x); \ + } }MACROE + + /* Inline Functions: */ + /** Function for reliably setting the AVR's system clock prescaler, using inline assembly. This function + * is guaranteed to operate reliably regardless of optimization setting or other compile time options. + * + * \param PrescalerMask The mask of the new prescaler setting for CLKPR + */ + static inline void SetSystemClockPrescaler(uint8_t PrescalerMask) + { + uint8_t tmp = (1 << CLKPCE); + __asm__ __volatile__ ( + "in __tmp_reg__,__SREG__" "\n\t" + "cli" "\n\t" + "sts %1, %0" "\n\t" + "sts %1, %2" "\n\t" + "out __SREG__, __tmp_reg__" + : /* no outputs */ + : "d" (tmp), + "M" (_SFR_MEM_ADDR(CLKPR)), + "d" (PrescalerMask) + : "r0"); + } + + /** Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1, + * etc. + * + * \param Byte Byte of data whose bits are to be reversed + */ + static inline uint8_t BitReverse(uint8_t Byte) ATTR_WARN_UNUSED_RESULT ATTR_CONST; + static inline uint8_t BitReverse(uint8_t Byte) + { + Byte = (((Byte & 0xF0) >> 4) | ((Byte & 0x0F) << 4)); + Byte = (((Byte & 0xCC) >> 2) | ((Byte & 0x33) << 2)); + Byte = (((Byte & 0xAA) >> 1) | ((Byte & 0x55) << 1)); + + return Byte; + } + + /** Function to reverse the byte ordering of the individual bytes in a 16 bit number. + * + * \param Word Word of data whose bytes are to be swapped + */ + static inline uint16_t SwapEndian_16(uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST; + static inline uint16_t SwapEndian_16(uint16_t Word) + { + return ((Word >> 8) | (Word << 8)); + } + + /** Function to reverse the byte ordering of the individual bytes in a 32 bit number. + * + * \param DWord Double word of data whose bytes are to be swapped + */ + static inline uint32_t SwapEndian_32(uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST; + static inline uint32_t SwapEndian_32(uint32_t DWord) + { + return (((DWord & 0xFF000000) >> 24) | + ((DWord & 0x00FF0000) >> 8) | + ((DWord & 0x0000FF00) << 8) | + ((DWord & 0x000000FF) << 24)); + } + + /** Function to reverse the byte ordering of the individual bytes in a n byte number. + * + * \param Data Pointer to a number containing an even number of bytes to be reversed + * \param Bytes Length of the data in bytes + */ + static inline void SwapEndian_n(uint8_t* Data, uint8_t Bytes); + static inline void SwapEndian_n(uint8_t* Data, uint8_t Bytes) + { + uint8_t Temp; + + while (Bytes) + { + Temp = *Data; + *Data = *(Data + Bytes - 1); + *(Data + Bytes) = Temp; + + Data++; + Bytes -= 2; + } + } + +#endif 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