Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / Projects / AVRISP-MKII / Lib / V2Protocol.h
index 862ea48..8e9e6ff 100644 (file)
@@ -1,85 +1,95 @@
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *\r
- *  Header file for V2Protocol.c.\r
- */\r
-\r
-#ifndef _V2_PROTOCOL_\r
-#define _V2_PROTOCOL_\r
-\r
-       /* Includes: */\r
-               #include <LUFA/Drivers/USB/USB.h>\r
-               #include <LUFA/Drivers/Peripheral/SPI.h>\r
-               \r
-               #include "../Descriptors.h"\r
-               #include "V2ProtocolConstants.h"\r
-               #include "V2ProtocolParams.h"\r
-               #include "ISP/ISPProtocol.h"\r
-               #include "XPROG/XPROGProtocol.h"\r
-\r
-       /* Preprocessor Checks: */\r
-               #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))\r
-                       #undef ENABLE_ISP_PROTOCOL\r
-                       \r
-                       #if !defined(ENABLE_XPROG_PROTOCOL)\r
-                               #define ENABLE_XPROG_PROTOCOL\r
-                       #endif\r
-               #endif\r
-\r
-       /* Macros: */\r
-               /** Programmer ID string, returned to the host during the CMD_SIGN_ON command processing */\r
-               #define PROGRAMMER_ID       "AVRISP_MK2"\r
-               \r
-               /** Timeout period for each issued command from the host before it is aborted */\r
-               #define COMMAND_TIMEOUT_MS   200\r
-               \r
-               /** Command timeout counter register, GPIOR for speed */\r
-               #define TimeoutMSRemaining   GPIOR0\r
-\r
-       /* External Variables: */\r
-               extern uint32_t CurrentAddress;\r
-               extern bool     MustSetAddress;\r
-\r
-       /* Function Prototypes: */\r
-               void V2Protocol_Init(void);\r
-               void V2Protocol_ProcessCommand(void);\r
-               \r
-               #if defined(INCLUDE_FROM_V2PROTOCOL_C)\r
-                       static void V2Protocol_UnknownCommand(uint8_t V2Command);\r
-                       static void V2Protocol_SignOn(void);\r
-                       static void V2Protocol_GetSetParam(uint8_t V2Command);\r
-                       static void V2Protocol_ResetProtection(void);\r
-                       static void V2Protocol_LoadAddress(void);\r
-               #endif\r
-\r
-#endif\r
-\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2011.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2011  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
+ *
+ *  Header file for V2Protocol.c.
+ */
+
+#ifndef _V2_PROTOCOL_
+#define _V2_PROTOCOL_
+
+       /* Includes: */
+               #include <avr/io.h>
+               #include <avr/interrupt.h>
+               #include <avr/wdt.h>
+       
+               #include <LUFA/Drivers/USB/USB.h>
+
+               #include "../Descriptors.h"
+               #include "V2ProtocolConstants.h"
+               #include "V2ProtocolParams.h"
+               #include "ISP/ISPProtocol.h"
+               #include "XPROG/XPROGProtocol.h"
+
+       /* Preprocessor Checks: */
+               #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
+                       #undef ENABLE_ISP_PROTOCOL
+
+                       #if !defined(ENABLE_XPROG_PROTOCOL)
+                               #define ENABLE_XPROG_PROTOCOL
+                       #endif
+               #endif
+
+               #if defined(USB_SERIES_4_AVR) && ((VTARGET_ADC_CHANNEL == 2) || (VTARGET_ADC_CHANNEL == 3))
+                       #error The U4 AVR chips do not contain ADC channels 2 or 3. Please change VTARGET_ADC_CHANNEL or define NO_VTARGET_DETECT in the makefile.
+               #endif
+
+       /* Macros: */
+               /** Programmer ID string, returned to the host during the CMD_SIGN_ON command processing. */
+               #define PROGRAMMER_ID              "AVRISP_MK2"
+
+               /** Timeout period for each issued command from the host before it is aborted (in 10ms ticks). */
+               #define COMMAND_TIMEOUT_TICKS      100
+
+               /** Command timeout expiration flag, GPIOR for speed. */
+               #define TimeoutExpired             GPIOR1
+
+               /** MUX mask for the VTARGET ADC channel number. */
+               #define VTARGET_ADC_CHANNEL_MASK   ADC_GET_CHANNEL_MASK(VTARGET_ADC_CHANNEL)
+
+       /* External Variables: */
+               extern uint32_t CurrentAddress;
+               extern bool     MustLoadExtendedAddress;
+
+       /* Function Prototypes: */
+               void V2Protocol_Init(void);
+               void V2Protocol_ProcessCommand(void);
+
+               #if defined(INCLUDE_FROM_V2PROTOCOL_C)
+                       static void V2Protocol_UnknownCommand(const uint8_t V2Command);
+                       static void V2Protocol_SignOn(void);
+                       static void V2Protocol_GetSetParam(const uint8_t V2Command);
+                       static void V2Protocol_ResetProtection(void);
+                       static void V2Protocol_LoadAddress(void);
+               #endif
+
+#endif
+