Update Doxygen configuration files for all projects.
[pub/USBasp.git] / Projects / AVRISP-MKII / Lib / XPROG / XPROGProtocol.h
index c812578..523fc15 100644 (file)
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2012.
+
   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com
-      www.fourwalledcubicle.com
+           www.lufa-lib.org
 */
 
 /*
 */
 
 /*
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)
 
 
-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this
   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted
-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in
   all copies and that both that the copyright notice and this
   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 
+  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 without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
                #include <avr/io.h>
                #include <util/delay.h>
                #include <stdio.h>
                #include <avr/io.h>
                #include <util/delay.h>
                #include <stdio.h>
-               
+
                #include <LUFA/Drivers/USB/USB.h>
                #include <LUFA/Drivers/USB/USB.h>
-               #include <LUFA/Drivers/Peripheral/SerialStream.h>
-       
+
                #include "../V2Protocol.h"
                #include "../V2Protocol.h"
-               #include "XPROGTarget.h"
                #include "XMEGANVM.h"
                #include "TINYNVM.h"
 
        /* Preprocessor Checks: */
                #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
                #include "XMEGANVM.h"
                #include "TINYNVM.h"
 
        /* Preprocessor Checks: */
                #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
+                       /* On the XPLAIN board, we only need PDI programming
+                          for the ATXMEGA128A1 - disable ISP to prevent hardware
+                          damage.
+                        */
                        #undef ENABLE_ISP_PROTOCOL
                        #undef ENABLE_ISP_PROTOCOL
-                       
+
                        #if !defined(ENABLE_XPROG_PROTOCOL)
                                #define ENABLE_XPROG_PROTOCOL
                        #endif
                #endif
                        #if !defined(ENABLE_XPROG_PROTOCOL)
                                #define ENABLE_XPROG_PROTOCOL
                        #endif
                #endif
-       
+
        /* Macros: */
                #define XPRG_CMD_ENTER_PROGMODE             0x01
                #define XPRG_CMD_LEAVE_PROGMODE             0x02
        /* Macros: */
                #define XPRG_CMD_ENTER_PROGMODE             0x01
                #define XPRG_CMD_LEAVE_PROGMODE             0x02
 
                #define XPRG_PARAM_NVMBASE                  0x01
                #define XPRG_PARAM_EEPPAGESIZE              0x02
 
                #define XPRG_PARAM_NVMBASE                  0x01
                #define XPRG_PARAM_EEPPAGESIZE              0x02
-               #define XPRG_PARAM_NVMCMD_REG               0x03 /* Undocumented, Reverse-engineered */
-               #define XPRG_PARAM_NVMCSR_REG               0x04 /* Undocumented, Reverse-engineered */
-               
+               #define XPRG_PARAM_NVMCMD_REG               0x03
+               #define XPRG_PARAM_NVMCSR_REG               0x04
+               #define XPRG_PARAM_UNKNOWN_1                0x05
+
                #define XPRG_PROTOCOL_PDI                   0x00
                #define XPRG_PROTOCOL_JTAG                  0x01
                #define XPRG_PROTOCOL_PDI                   0x00
                #define XPRG_PROTOCOL_JTAG                  0x01
-               #define XPRG_PROTOCOL_TPI                   0x02 /* Undocumented, Reverse-engineered */
-               
+               #define XPRG_PROTOCOL_TPI                   0x02
+
                #define XPRG_PAGEMODE_WRITE                 (1 << 1)
                #define XPRG_PAGEMODE_ERASE                 (1 << 0)
                #define XPRG_PAGEMODE_WRITE                 (1 << 1)
                #define XPRG_PAGEMODE_ERASE                 (1 << 0)
-       
+
        /* External Variables: */
                extern uint32_t XPROG_Param_NVMBase;
                extern uint16_t XPROG_Param_EEPageSize;
                extern uint8_t  XPROG_Param_NVMCSRRegAddr;
                extern uint8_t  XPROG_Param_NVMCMDRegAddr;
        /* External Variables: */
                extern uint32_t XPROG_Param_NVMBase;
                extern uint16_t XPROG_Param_EEPageSize;
                extern uint8_t  XPROG_Param_NVMCSRRegAddr;
                extern uint8_t  XPROG_Param_NVMCMDRegAddr;
-               extern uint8_t  XPROG_SelectedProtocol;
-               
+
        /* Function Prototypes: */
                void XPROGProtocol_SetMode(void);
                void XPROGProtocol_Command(void);
        /* Function Prototypes: */
                void XPROGProtocol_SetMode(void);
                void XPROGProtocol_Command(void);
-               
+
                #if (defined(INCLUDE_FROM_XPROGPROTOCOL_C) && defined(ENABLE_XPROG_PROTOCOL))
                        static void XPROGProtocol_EnterXPROGMode(void);
                        static void XPROGProtocol_LeaveXPROGMode(void);
                #if (defined(INCLUDE_FROM_XPROGPROTOCOL_C) && defined(ENABLE_XPROG_PROTOCOL))
                        static void XPROGProtocol_EnterXPROGMode(void);
                        static void XPROGProtocol_LeaveXPROGMode(void);
                        static void XPROGProtocol_ReadMemory(void);
                        static void XPROGProtocol_ReadCRC(void);
                #endif
                        static void XPROGProtocol_ReadMemory(void);
                        static void XPROGProtocol_ReadCRC(void);
                #endif
-               
+
 #endif
 #endif
+