Fork of LUFA CDC Bootloader

Initial commit

4 files changed, 495 insertions, 0 deletions

diff --git a/LUFA/CodeTemplates/DriverStubs/Buttons.h b/LUFA/CodeTemplates/DriverStubs/Buttons.h
new file mode 100644
index 0000000..33f963f
--- /dev/null
+++ b/LUFA/CodeTemplates/DriverStubs/Buttons.h
@@ -0,0 +1,86 @@
+/*

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

+*/

+

+/*

+   This is a stub driver header file, for implementing custom board

+   layout hardware with compatible LUFA board specific drivers. If

+   the library is configured to use the BOARD_USER board mode, this

+   driver file should be completed and copied into the "/Board/" folder

+   inside the application's folder.

+

+   This stub is for the board-specific component of the LUFA Buttons driver,

+   for the control of physical board-mounted GPIO pushbuttons.

+*/

+

+#ifndef __BUTTONS_USER_H__

+#define __BUTTONS_USER_H__

+

+	/* Includes: */

+		#include <avr/io.h>

+		#include <stdbool.h>

+

+		// TODO: Add any required includes here

+

+	/* Enable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			extern "C" {

+		#endif

+

+	/* Preprocessor Checks: */

+		#if !defined(__INCLUDE_FROM_BUTTONS_H)

+			#error Do not include this file directly. Include LUFA/Drivers/Board/Buttons.h instead.

+		#endif

+

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

+		/* Macros: */

+			/** Button mask for the first button on the board. */

+			#define BUTTONS_BUTTON1          // TODO: Add mask for first board button here

+

+		/* Inline Functions: */

+		#if !defined(__DOXYGEN__)

+			static inline void Buttons_Init(void)

+			{

+				// TODO: Initialize the appropriate port pins as an inputs here, with pull-ups

+			}

+

+			static inline uint8_t Buttons_GetStatus(void) ATTR_WARN_UNUSED_RESULT;

+			static inline uint8_t Buttons_GetStatus(void)

+			{

+				// TODO: Return current button status here, debounced if required

+			}

+		#endif

+

+	/* Disable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			}

+		#endif

+

+#endif

+

diff --git a/LUFA/CodeTemplates/DriverStubs/Dataflash.h b/LUFA/CodeTemplates/DriverStubs/Dataflash.h
new file mode 100644
index 0000000..e07117f
--- /dev/null
+++ b/LUFA/CodeTemplates/DriverStubs/Dataflash.h
@@ -0,0 +1,186 @@
+/*

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

+*/

+

+/*

+   This is a stub driver header file, for implementing custom board

+   layout hardware with compatible LUFA board specific drivers. If

+   the library is configured to use the BOARD_USER board mode, this

+   driver file should be completed and copied into the "/Board/" folder

+   inside the application's folder.

+

+   This stub is for the board-specific component of the LUFA Dataflash

+   driver.

+*/

+

+#ifndef __DATAFLASH_USER_H__

+#define __DATAFLASH_USER_H__

+

+	/* Includes: */

+		// TODO: Add any required includes here

+

+	/* Preprocessor Checks: */

+		#if !defined(__INCLUDE_FROM_DATAFLASH_H)

+			#error Do not include this file directly. Include LUFA/Drivers/Board/Dataflash.h instead.

+		#endif

+

+	/* Private Interface - For use in library only: */

+	#if !defined(__DOXYGEN__)

+		/* Macros: */

+			#define DATAFLASH_CHIPCS_MASK                // TODO: Replace this with a mask of all the /CS pins of all Dataflashes

+			#define DATAFLASH_CHIPCS_DDR                 // TODO: Replace with the DDR register name for the board's Dataflash ICs

+			#define DATAFLASH_CHIPCS_PORT                // TODO: Replace with the PORT register name for the board's Dataflash ICs

+	#endif

+

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

+		/* Macros: */

+			/** Constant indicating the total number of dataflash ICs mounted on the selected board. */

+			#define DATAFLASH_TOTALCHIPS                 1 // TODO: Replace with the number of Dataflashes on the board, max 2

+

+			/** Mask for no dataflash chip selected. */

+			#define DATAFLASH_NO_CHIP                    DATAFLASH_CHIPCS_MASK

+

+			/** Mask for the first dataflash chip selected. */

+			#define DATAFLASH_CHIP1                      // TODO: Replace with mask to hold /CS of first Dataflash low, and all others high

+

+			/** Mask for the second dataflash chip selected. */

+			#define DATAFLASH_CHIP2                      // TODO: Replace with mask to hold /CS of second Dataflash low, and all others high

+

+			/** Internal main memory page size for the board's dataflash ICs. */

+			#define DATAFLASH_PAGE_SIZE                  // TODO: Replace with the page size for the Dataflash ICs

+

+			/** Total number of pages inside each of the board's dataflash ICs. */

+			#define DATAFLASH_PAGES                      // TODO: Replace with the total number of pages inside one of the Dataflash ICs

+

+		/* Inline Functions: */

+			/** Initialises the dataflash driver so that commands and data may be sent to an attached dataflash IC.

+			 *  The AVR's SPI driver MUST be initialized before any of the dataflash commands are used.

+			 */

+			static inline void Dataflash_Init(void)

+			{

+				DATAFLASH_CHIPCS_DDR  |= DATAFLASH_CHIPCS_MASK;

+				DATAFLASH_CHIPCS_PORT |= DATAFLASH_CHIPCS_MASK;

+			}

+

+			/** Determines the currently selected dataflash chip.

+			 *

+			 *  \return Mask of the currently selected Dataflash chip, either \ref DATAFLASH_NO_CHIP if no chip is selected

+			 *          or a DATAFLASH_CHIPn mask (where n is the chip number).

+			 */

+			static inline uint8_t Dataflash_GetSelectedChip(void) ATTR_ALWAYS_INLINE ATTR_WARN_UNUSED_RESULT;

+			static inline uint8_t Dataflash_GetSelectedChip(void)

+			{

+				return (DATAFLASH_CHIPCS_PORT & DATAFLASH_CHIPCS_MASK);

+			}

+

+			/** Selects the given dataflash chip.

+			 *

+			 *  \param[in]  ChipMask  Mask of the Dataflash IC to select, in the form of DATAFLASH_CHIPn mask (where n is

+			 *              the chip number).

+			 */

+			static inline void Dataflash_SelectChip(const uint8_t ChipMask) ATTR_ALWAYS_INLINE;

+			static inline void Dataflash_SelectChip(const uint8_t ChipMask)

+			{

+				DATAFLASH_CHIPCS_PORT = ((DATAFLASH_CHIPCS_PORT & ~DATAFLASH_CHIPCS_MASK) | ChipMask);

+			}

+

+			/** Deselects the current dataflash chip, so that no dataflash is selected. */

+			static inline void Dataflash_DeselectChip(void) ATTR_ALWAYS_INLINE;

+			static inline void Dataflash_DeselectChip(void)

+			{

+				Dataflash_SelectChip(DATAFLASH_NO_CHIP);

+			}

+

+			/** Selects a dataflash IC from the given page number, which should range from 0 to

+			 *  ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1). For boards containing only one

+			 *  dataflash IC, this will select DATAFLASH_CHIP1. If the given page number is outside

+			 *  the total number of pages contained in the boards dataflash ICs, all dataflash ICs

+			 *  are deselected.

+			 *

+			 *  \param[in] PageAddress  Address of the page to manipulate, ranging from

+			 *                          ((DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS) - 1).

+			 */

+			static inline void Dataflash_SelectChipFromPage(const uint16_t PageAddress)

+			{

+				Dataflash_DeselectChip();

+

+				if (PageAddress >= (DATAFLASH_PAGES * DATAFLASH_TOTALCHIPS))

+				  return;

+

+				#if (DATAFLASH_TOTALCHIPS == 2)

+					if (PageAddress & 0x01)

+					  Dataflash_SelectChip(DATAFLASH_CHIP2);

+					else

+					  Dataflash_SelectChip(DATAFLASH_CHIP1);

+				#else

+					Dataflash_SelectChip(DATAFLASH_CHIP1);

+				#endif

+			}

+

+			/** Toggles the select line of the currently selected dataflash IC, so that it is ready to receive

+			 *  a new command.

+			 */

+			static inline void Dataflash_ToggleSelectedChipCS(void)

+			{

+				uint8_t SelectedChipMask = Dataflash_GetSelectedChip();

+

+				Dataflash_DeselectChip();

+				Dataflash_SelectChip(SelectedChipMask);

+			}

+

+			/** Spin-loops while the currently selected dataflash is busy executing a command, such as a main

+			 *  memory page program or main memory to buffer transfer.

+			 */

+			static inline void Dataflash_WaitWhileBusy(void)

+			{

+				Dataflash_ToggleSelectedChipCS();

+				Dataflash_SendByte(DF_CMD_GETSTATUS);

+				while (!(Dataflash_ReceiveByte() & DF_STATUS_READY));

+				Dataflash_ToggleSelectedChipCS();

+			}

+

+			/** Sends a set of page and buffer address bytes to the currently selected dataflash IC, for use with

+			 *  dataflash commands which require a complete 24-byte address.

+			 *

+			 *  \param[in] PageAddress  Page address within the selected dataflash IC

+			 *  \param[in] BufferByte   Address within the dataflash's buffer

+			 */

+			static inline void Dataflash_SendAddressBytes(uint16_t PageAddress, const uint16_t BufferByte)

+			{

+				#if (DATAFLASH_TOTALCHIPS == 2)

+					PageAddress >>= 1;

+				#endif

+

+				Dataflash_SendByte(PageAddress >> 5);

+				Dataflash_SendByte((PageAddress << 3) | (BufferByte >> 8));

+				Dataflash_SendByte(BufferByte);

+			}

+

+#endif

+

diff --git a/LUFA/CodeTemplates/DriverStubs/Joystick.h b/LUFA/CodeTemplates/DriverStubs/Joystick.h
new file mode 100644
index 0000000..f542fa3
--- /dev/null
+++ b/LUFA/CodeTemplates/DriverStubs/Joystick.h
@@ -0,0 +1,98 @@
+/*

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

+*/

+

+/*

+   This is a stub driver header file, for implementing custom board

+   layout hardware with compatible LUFA board specific drivers. If

+   the library is configured to use the BOARD_USER board mode, this

+   driver file should be completed and copied into the "/Board/" folder

+   inside the application's folder.

+

+   This stub is for the board-specific component of the LUFA Joystick

+   driver, a small surface mount four-way (plus button) digital joystick

+   on most USB AVR boards.

+*/

+

+#ifndef __JOYSTICK_USER_H__

+#define __JOYSTICK_USER_H__

+

+	/* Includes: */

+		#include <avr/io.h>

+

+		// TODO: Add any required includes here

+

+	/* Enable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			extern "C" {

+		#endif

+

+	/* Preprocessor Checks: */

+		#if !defined(__INCLUDE_FROM_JOYSTICK_H)

+			#error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead.

+		#endif

+

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

+		/* Macros: */

+			/** Mask for the joystick being pushed in the left direction. */

+			#define JOY_LEFT                  // TODO: Add mask to indicate joystick left position here

+

+			/** Mask for the joystick being pushed in the right direction. */

+			#define JOY_RIGHT                 // TODO: Add mask to indicate joystick right position here

+

+			/** Mask for the joystick being pushed in the upward direction. */

+			#define JOY_UP                    // TODO: Add mask to indicate joystick up position here

+

+			/** Mask for the joystick being pushed in the downward direction. */

+			#define JOY_DOWN                  // TODO: Add mask to indicate joystick down position here

+

+			/** Mask for the joystick being pushed inward. */

+			#define JOY_PRESS                 // TODO: Add mask to indicate joystick pressed position here

+

+		/* Inline Functions: */

+		#if !defined(__DOXYGEN__)

+			static inline void Joystick_Init(void)

+			{

+				// TODO: Initialize joystick port pins as inputs with pull-ups

+			}

+

+			static inline uint8_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;

+			static inline uint8_t Joystick_GetStatus(void)

+			{

+				// TODO: Return current joystick position data which can be obtained by masking against the JOY_* macros

+			}

+		#endif

+

+	/* Disable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			}

+		#endif

+

+#endif

+

diff --git a/LUFA/CodeTemplates/DriverStubs/LEDs.h b/LUFA/CodeTemplates/DriverStubs/LEDs.h
new file mode 100644
index 0000000..46309a1
--- /dev/null
+++ b/LUFA/CodeTemplates/DriverStubs/LEDs.h
@@ -0,0 +1,125 @@
+/*

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

+*/

+

+/*

+   This is a stub driver header file, for implementing custom board

+   layout hardware with compatible LUFA board specific drivers. If

+   the library is configured to use the BOARD_USER board mode, this

+   driver file should be completed and copied into the "/Board/" folder

+   inside the application's folder.

+

+   This stub is for the board-specific component of the LUFA LEDs driver,

+   for the LEDs (up to four) mounted on most USB AVR boards.

+*/

+

+#ifndef __LEDS_USER_H__

+#define __LEDS_USER_H__

+

+	/* Includes: */

+		#include <avr/io.h>

+

+		// TODO: Add any required includes here

+

+/* Enable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			extern "C" {

+		#endif

+

+	/* Preprocessor Checks: */

+		#if !defined(__INCLUDE_FROM_LEDS_H)

+			#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.

+		#endif

+

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

+		/* Macros: */

+			/** LED mask for the first LED on the board. */

+			#define LEDS_LED1        // TODO: Add mask for first board LED here

+

+			/** LED mask for the second LED on the board. */

+			#define LEDS_LED2        // TODO: Add mask for second board LED here

+

+			/** LED mask for the third LED on the board. */

+			#define LEDS_LED3        // TODO: Add mask for third board LED here

+

+			/** LED mask for the fourth LED on the board. */

+			#define LEDS_LED4        // TODO: Add mask for fourth board LED here

+

+			/** LED mask for all the LEDs on the board. */

+			#define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)

+

+			/** LED mask for none of the board LEDs. */

+			#define LEDS_NO_LEDS     0

+

+		/* Inline Functions: */

+		#if !defined(__DOXYGEN__)

+			static inline void LEDs_Init(void)

+			{

+				// TODO: Add code to initialize LED port pins as outputs here

+			}

+

+			static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)

+			{

+				// TODO: Add code to turn on LEDs given in the LEDMask mask here, leave others as-is

+			}

+

+			static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)

+			{

+				// TODO: Add code to turn off LEDs given in the LEDMask mask here, leave others as-is

+			}

+

+			static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)

+			{

+				// TODO: Add code to turn on only LEDs given in the LEDMask mask here, all others off

+			}

+

+			static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask)

+			{

+				// TODO: Add code to set the Leds in the given LEDMask to the status given in ActiveMask here

+			}

+

+			static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)

+			{

+				// TODO: Add code to toggle the Leds in the given LEDMask, ignoring all others

+			}

+

+			static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;

+			static inline uint8_t LEDs_GetLEDs(void)

+			{

+				// TODO: Add code to return the current LEDs status' here which can be masked against LED_LED* macros

+			}

+		#endif

+

+	/* Disable C linkage for C++ Compilers: */

+		#if defined(__cplusplus)

+			}

+		#endif

+

+#endif

+