Fork of LUFA CDC Bootloader

Initial commit

3 files changed, 543 insertions, 0 deletions

diff --git a/LUFA/Common/Attributes.h b/LUFA/Common/Attributes.h
new file mode 100644
index 0000000..053a9b8
--- /dev/null
+++ b/LUFA/Common/Attributes.h
@@ -0,0 +1,139 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2010.

+

+  dean [at] fourwalledcubicle [dot] com

+           www.lufa-lib.org

+*/

+

+/*

+  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

+ *  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.

+ *

+ *  \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] SectionIndex  Initialization section number where the function should be placed.

+			 */

+			#define ATTR_INIT_SECTION(SectionIndex) __attribute__ ((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 )))

+#endif

+

+/** @} */

+

diff --git a/LUFA/Common/BoardTypes.h b/LUFA/Common/BoardTypes.h
new file mode 100644
index 0000000..7a9bb59
--- /dev/null
+++ b/LUFA/Common/BoardTypes.h
@@ -0,0 +1,151 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2010.

+

+  dean [at] fourwalledcubicle [dot] com

+           www.lufa-lib.org

+*/

+

+/*

+  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 Supported board hardware defines.

+ *

+ *  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.

+ */

+

+/** \ingroup Group_Common

+ *  @defgroup Group_BoardTypes Board Types

+ *

+ *  Macros for indicating the chosen physical board hardware to the library. These macros should be used when

+ *  defining the BOARD token to the chosen hardware via the -D switch in the project makefile.

+ *

+ *  @{

+ */

+

+#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 Temperature, Button, Dataflash, Joystick and LED drivers. */

+			#define BOARD_USBKEY        0

+

+			/** Selects the STK525 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */

+			#define BOARD_STK525        1

+

+			/** Selects the STK526 specific board drivers, including Temperature, Button, 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

+

+			/** Selects the BUMBLEB specific board drivers, using the officially recommended peripheral layout. */

+			#define BOARD_BUMBLEB       6

+

+			/** Selects the XPLAIN (Revision 2 or newer) specific board drivers, including LED and Dataflash driver. */

+			#define BOARD_XPLAIN        7

+

+			/** Selects the XPLAIN (Revision 1) specific board drivers, including LED and Dataflash driver. */

+			#define BOARD_XPLAIN_REV1   8

+

+			/** Selects the EVK527 specific board drivers, including Temperature, Button, Dataflash, Joystick and LED drivers. */

+			#define BOARD_EVK527        9

+

+			/** Disables board drivers when operation will not be adversely affected (e.g. LEDs) - use of board drivers

+			 *  such as the Joystick driver, where the removal would adversely affect the code's operation is still disallowed. */

+			#define BOARD_NONE          10

+

+			/** Selects the Teensy (all versions) specific board drivers, including the driver for the board LEDs. */

+			#define BOARD_TEENSY        11

+

+			/** Selects the USBTINY MKII specific board drivers, including the Button and LEDs drivers. */

+			#define BOARD_USBTINYMKII   12

+

+			/** Selects the Benito specific board drivers, including the Button and LEDs drivers. */

+			#define BOARD_BENITO        13

+

+			/** Selects the JM-DB-U2 specific board drivers, including the Button and LEDs drivers. */

+			#define BOARD_JMDBU2        14

+

+			/** Selects the Olimex AVR-USB-162 specific board drivers, including the Button and LEDs drivers. */

+			#define BOARD_OLIMEX162     15

+

+			/** Selects the UDIP specific board drivers, including the Button and LEDs drivers. */

+			#define BOARD_UDIP          16

+

+			/** Selects the BUI specific board drivers, including the driver for the board LEDs. */

+			#define BOARD_BUI           17

+

+			/** Selects the Arduino Uno specific board drivers, including the driver for the board LEDs. */

+			#define BOARD_UNO           18

+

+			/** Selects the CUL V3 specific board drivers, including the Button and LEDs drivers. */

+			#define BOARD_CULV3         19

+

+			/** Selects the Blackcat USB JTAG specific board drivers, including the driver for the board LEDs. */

+			#define BOARD_BLACKCAT      20

+

+			/** Selects the Maximus specific board drivers, including the driver for the board LEDs. */

+			#define BOARD_MAXIMUS       21

+

+			/** Selects the Minimus specific board drivers, including the Button and LEDs drivers. */

+			#define BOARD_MINIMUS       22

+

+			/** Selects the Adafruit U4 specific board drivers, including the Button driver. */

+			#define BOARD_ADAFRUITU4    23

+

+			/** Selects the Microsin AVR-USB162 specific board drivers, including the Button and LEDs drivers. */

+			#define BOARD_MICROSIN162   24

+

+			#if !defined(__DOXYGEN__)

+				#define BOARD_          BOARD_NONE

+

+				#if !defined(BOARD)

+					#define BOARD       BOARD_NONE

+				#endif

+			#endif

+

+#endif

+

+/** @} */

+

diff --git a/LUFA/Common/Common.h b/LUFA/Common/Common.h
new file mode 100644
index 0000000..3c3fd0d
--- /dev/null
+++ b/LUFA/Common/Common.h
@@ -0,0 +1,253 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2010.

+

+  dean [at] fourwalledcubicle [dot] com

+           www.lufa-lib.org

+*/

+

+/*

+  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 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, Attributes.h and BoardTypes.h.

+ */

+

+/** @defgroup Group_Common Common Utility Headers - LUFA/Drivers/Common/Common.h

+ *

+ *  Common utility headers containing macros, functions, enums and types which are common to all

+ *  aspects of the library.

+ *

+ *  @{

+ */

+

+/** @defgroup Group_Debugging Debugging Macros

+ *

+ *  Macros for debugging use.

+ */

+

+/** @defgroup Group_BitManip Endian and Bit Macros

+ *

+ *  Functions for swapping endianness and reversing bit orders.

+ */

+

+#ifndef __COMMON_H__

+#define __COMMON_H__

+

+	/* Includes: */

+		#include <stdint.h>

+		#include <stdbool.h>

+

+		#include "Attributes.h"

+		#include "BoardTypes.h"

+

+	/* Public Interface - May be used in end-application: */

+		/* Macros: */

+			/** Macro for encasing other multi-statement 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 discrete block and not as a list of separate statements which may cause problems when used as

+			 *  a block (such as inline IF statements).

+			 */

+			#define MACROS                  do

+

+			/** Macro for encasing other multi-statement macros. This should be used along with a preceding closing

+			 *  brace at the end of any multi-statement macro, so that the macros contents as a whole are treated

+			 *  as a discrete block and not as a list of separate statements which may cause problems when used as

+			 *  a block (such as inline IF statements).

+			 */

+			#define MACROE                  while (0)

+

+			/** Defines a volatile NOP statement 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 optimiser

+			 *  removes/reorders code to the point where break points cannot reliably be set.

+			 *

+			 *  \ingroup Group_Debugging

+			 */

+			#define JTAG_DEBUG_POINT()      __asm__ volatile ("NOP" ::)

+

+			/** Defines an explicit JTAG break point in the resulting binary via the ASM BREAK statement. When

+			 *  a JTAG is used, this causes the program execution to halt when reached until manually resumed.

+			 *

+			 *  \ingroup Group_Debugging

+			 */

+			#define JTAG_DEBUG_BREAK()      __asm__ volatile ("BREAK" ::)

+

+			/** Macro for testing condition "x" and breaking via JTAG_DEBUG_BREAK() if the condition is false.

+			 *

+			 *  \ingroup Group_Debugging

+			*/

+			#define JTAG_DEBUG_ASSERT(x)    MACROS{ if (!(x)) { JTAG_DEBUG_BREAK(); } }MACROE

+

+			/** Macro for testing condition "x" and writing debug data to the stdout stream if false. The stdout stream

+			 *  must be pre-initialized before this macro is run and linked to an output device, such as the AVR's USART

+			 *  peripheral.

+			 *

+			 *  The output takes the form "{FILENAME}: Function {FUNCTION NAME}, Line {LINE NUMBER}: Assertion {x} failed."

+			 *

+			 *  \ingroup Group_Debugging

+			 */

+			#define STDOUT_ASSERT(x)        MACROS{ if (!(x)) { printf_P(PSTR("%s: Function \"%s\", Line %d: "   \

+			                                             "Assertion \"%s\" failed.\r\n"),     \

+			                                             __FILE__, __func__, __LINE__, #x); } }MACROE

+

+			#if !defined(pgm_read_ptr) || defined(__DOXYGEN__)

+				/** Reads a pointer out of PROGMEM space. This is currently a wrapper for the avr-libc pgm_read_ptr()

+				 *  macro with a void* cast, so that its value can be assigned directly to a pointer variable or used

+				 *  in pointer arithmetic without further casting in C. In a future avr-libc distribution this will be

+				 *  part of the standard API and will be implemented in a more formal manner.

+				 *

+				 *  \param[in] Addr  Address of the pointer to read.

+				 *

+				 *  \return Pointer retrieved from PROGMEM space.

+				 */

+				#define pgm_read_ptr(Addr)    (void*)pgm_read_word(Addr)

+			#endif

+

+			/** Swaps the byte ordering of a 16-bit value at compile time. Do not use this macro for swapping byte orderings

+			 *  of dynamic values computed at runtime, use \ref SwapEndian_16() instead. The result of this macro can be used

+			 *  inside struct or other variable initializers outside of a function, something that is not possible with the

+			 *  inline function variant.

+			 *

+			 *  \param[in]  x  16-bit value whose byte ordering is to be swapped.

+			 *

+			 *  \return Input value with the byte ordering reversed.

+			 */

+			#define SWAPENDIAN_16(x)          ((((x) & 0xFF00) >> 8) | (((x) & 0x00FF) << 8))

+

+			/** Swaps the byte ordering of a 32-bit value at compile time. Do not use this macro for swapping byte orderings

+			 *  of dynamic values computed at runtime- use \ref SwapEndian_32() instead. The result of this macro can be used

+			 *  inside struct or other variable initializers outside of a function, something that is not possible with the

+			 *  inline function variant.

+			 *

+			 *  \param[in]  x  32-bit value whose byte ordering is to be swapped.

+			 *

+			 *  \return Input value with the byte ordering reversed.

+			 */

+			#define SWAPENDIAN_32(x)          ((((x) & 0xFF000000UL) >> 24UL) | (((x) & 0x00FF0000UL) >> 8UL) | \

+			                                   (((x) & 0x0000FF00UL) << 8UL)  | (((x) & 0x000000FFUL) << 24UL))

+

+		/* Inline Functions: */

+			/** Function to reverse the individual bits in a byte - i.e. bit 7 is moved to bit 0, bit 6 to bit 1,

+			 *  etc.

+			 *

+			 *  \ingroup Group_BitManip

+			 *

+			 *  \param[in] 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.

+			 *

+			 *  \ingroup Group_BitManip

+			 *

+			 *  \param[in] Word  Word of data whose bytes are to be swapped.

+			 */

+			static inline uint16_t SwapEndian_16(const uint16_t Word) ATTR_WARN_UNUSED_RESULT ATTR_CONST;

+			static inline uint16_t SwapEndian_16(const uint16_t Word)

+			{

+				uint8_t Temp;

+

+				union

+				{

+					uint16_t Word;

+					uint8_t  Bytes[2];

+				} Data;

+

+				Data.Word = Word;

+

+				Temp = Data.Bytes[0];

+				Data.Bytes[0] = Data.Bytes[1];

+				Data.Bytes[1] = Temp;

+

+				return Data.Word;

+			}

+

+			/** Function to reverse the byte ordering of the individual bytes in a 32 bit number.

+			 *

+			 *  \ingroup Group_BitManip

+			 *

+			 *  \param[in] DWord  Double word of data whose bytes are to be swapped.

+			 */

+			static inline uint32_t SwapEndian_32(const uint32_t DWord) ATTR_WARN_UNUSED_RESULT ATTR_CONST;

+			static inline uint32_t SwapEndian_32(const uint32_t DWord)

+			{

+				uint8_t Temp;

+

+				union

+				{

+					uint32_t DWord;

+					uint8_t  Bytes[4];

+				} Data;

+

+				Data.DWord = DWord;

+

+				Temp = Data.Bytes[0];

+				Data.Bytes[0] = Data.Bytes[3];

+				Data.Bytes[3] = Temp;

+

+				Temp = Data.Bytes[1];

+				Data.Bytes[1] = Data.Bytes[2];

+				Data.Bytes[2] = Temp;

+

+				return Data.DWord;

+			}

+

+			/** Function to reverse the byte ordering of the individual bytes in a n byte number.

+			 *

+			 *  \ingroup Group_BitManip

+			 *

+			 *  \param[in,out] Data   Pointer to a number containing an even number of bytes to be reversed.

+			 *  \param[in]     Bytes  Length of the data in bytes.

+			 */

+			static inline void SwapEndian_n(void* Data,

+			                                uint8_t Bytes) ATTR_NON_NULL_PTR_ARG(1);

+			static inline void SwapEndian_n(void* Data,

+			                                uint8_t Bytes)

+			{

+				uint8_t* CurrDataPos = (uint8_t*)Data;

+

+				while (Bytes > 1)

+				{

+					uint8_t Temp = *CurrDataPos;

+					*CurrDataPos = *(CurrDataPos + Bytes - 1);

+					*(CurrDataPos + Bytes - 1) = Temp;

+

+					CurrDataPos++;

+					Bytes -= 2;

+				}

+			}

+

+#endif

+

+/** @} */

+