Minor documentation improvements.
[pub/USBasp.git] / Projects / AVRISP-MKII / Lib / XPROG / XPROGProtocol.h
index 4bb6009..870350f 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2009  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 XPROGProtocol.c.\r
- */\r
-\r
-#ifndef _XPROG_PROTOCOL_\r
-#define _XPROG_PROTOCOL_\r
-\r
-       /* Includes: */\r
-               #include <avr/io.h>\r
-               #include <util/delay.h>\r
-               #include <stdio.h>\r
-               \r
-               #include <LUFA/Drivers/USB/USB.h>\r
-               #include <LUFA/Drivers/Peripheral/SerialStream.h>\r
-       \r
-               #include "../V2Protocol.h"\r
-               #include "XPROGTarget.h"\r
-               #include "XMEGANVM.h"\r
-               #include "TINYNVM.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
-               #define XPRG_CMD_ENTER_PROGMODE             0x01\r
-               #define XPRG_CMD_LEAVE_PROGMODE             0x02\r
-               #define XPRG_CMD_ERASE                      0x03\r
-               #define XPRG_CMD_WRITE_MEM                  0x04\r
-               #define XPRG_CMD_READ_MEM                   0x05\r
-               #define XPRG_CMD_CRC                        0x06\r
-               #define XPRG_CMD_SET_PARAM                  0x07\r
-\r
-               #define XPRG_MEM_TYPE_APPL                  1\r
-               #define XPRG_MEM_TYPE_BOOT                  2\r
-               #define XPRG_MEM_TYPE_EEPROM                3\r
-               #define XPRG_MEM_TYPE_FUSE                  4\r
-               #define XPRG_MEM_TYPE_LOCKBITS              5\r
-               #define XPRG_MEM_TYPE_USERSIG               6\r
-               #define XPRG_MEM_TYPE_FACTORY_CALIBRATION   7\r
-\r
-               #define XPRG_ERASE_CHIP                     1\r
-               #define XPRG_ERASE_APP                      2\r
-               #define XPRG_ERASE_BOOT                     3\r
-               #define XPRG_ERASE_EEPROM                   4\r
-               #define XPRG_ERASE_APP_PAGE                 5\r
-               #define XPRG_ERASE_BOOT_PAGE                6\r
-               #define XPRG_ERASE_EEPROM_PAGE              7\r
-               #define XPRG_ERASE_USERSIG                  8\r
-\r
-               #define XPRG_MEM_WRITE_ERASE                0\r
-               #define XPRG_MEM_WRITE_WRITE                1\r
-\r
-               #define XPRG_CRC_APP                        1\r
-               #define XPRG_CRC_BOOT                       2\r
-               #define XPRG_CRC_FLASH                      3\r
-\r
-               #define XPRG_ERR_OK                         0\r
-               #define XPRG_ERR_FAILED                     1\r
-               #define XPRG_ERR_COLLISION                  2\r
-               #define XPRG_ERR_TIMEOUT                    3\r
-\r
-               #define XPRG_PARAM_NVMBASE                  0x01\r
-               #define XPRG_PARAM_EEPPAGESIZE              0x02\r
-               #define XPRG_PARAM_NVMCMD                   0x03\r
-               #define XPRG_PARAM_NVMCSR                   0x04\r
-               \r
-               #define XPRG_PROTOCOL_PDI                   0x00\r
-               #define XPRG_PROTOCOL_JTAG                  0x01\r
-               #define XPRG_PROTOCOL_TPI                   0x02\r
-               \r
-               #define XPRG_PAGEMODE_WRITE                 (1 << 1)\r
-               #define XPRG_PAGEMODE_ERASE                 (1 << 0)\r
-       \r
-       /* External Variables: */\r
-               extern uint32_t XPROG_Param_NVMBase;\r
-               extern uint16_t XPROG_Param_EEPageSize;\r
-               extern uint8_t  XPROG_Param_NVMCSRRegAddr;\r
-               extern uint8_t  XPROG_Param_NVMCMDRegAddr;\r
-               \r
-       /* Function Prototypes: */\r
-               void XPROGProtocol_SetMode(void);\r
-               void XPROGProtocol_Command(void);\r
-               \r
-               #if defined(INCLUDE_FROM_XPROGPROTOCOL_C)\r
-                       static void XPROGProtocol_EnterXPROGMode(void);\r
-                       static void XPROGProtocol_LeaveXPROGMode(void);\r
-                       static void XPROGProtocol_SetParam(void);\r
-                       static void XPROGProtocol_Erase(void);\r
-                       static void XPROGProtocol_WriteMemory(void);\r
-                       static void XPROGProtocol_ReadMemory(void);\r
-                       static void XPROGProtocol_ReadCRC(void);\r
-               #endif\r
-               \r
-#endif\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2012.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2012  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 disclaims 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 XPROGProtocol.c.
+ */
+
+#ifndef _XPROG_PROTOCOL_
+#define _XPROG_PROTOCOL_
+
+       /* Includes: */
+               #include <avr/io.h>
+               #include <util/delay.h>
+               #include <stdio.h>
+
+               #include <LUFA/Drivers/USB/USB.h>
+
+               #include "../V2Protocol.h"
+               #include "XMEGANVM.h"
+               #include "TINYNVM.h"
+               #include "Config/AppConfig.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 and force-enable XPROG.
+                        */
+                       #undef ENABLE_ISP_PROTOCOL
+
+                       #if !defined(ENABLE_XPROG_PROTOCOL)
+                               #define ENABLE_XPROG_PROTOCOL
+                       #endif
+               #endif
+
+       /* Macros: */
+               #define XPRG_CMD_ENTER_PROGMODE             0x01
+               #define XPRG_CMD_LEAVE_PROGMODE             0x02
+               #define XPRG_CMD_ERASE                      0x03
+               #define XPRG_CMD_WRITE_MEM                  0x04
+               #define XPRG_CMD_READ_MEM                   0x05
+               #define XPRG_CMD_CRC                        0x06
+               #define XPRG_CMD_SET_PARAM                  0x07
+
+               #define XPRG_MEM_TYPE_APPL                  1
+               #define XPRG_MEM_TYPE_BOOT                  2
+               #define XPRG_MEM_TYPE_EEPROM                3
+               #define XPRG_MEM_TYPE_FUSE                  4
+               #define XPRG_MEM_TYPE_LOCKBITS              5
+               #define XPRG_MEM_TYPE_USERSIG               6
+               #define XPRG_MEM_TYPE_FACTORY_CALIBRATION   7
+
+               #define XPRG_ERASE_CHIP                     1
+               #define XPRG_ERASE_APP                      2
+               #define XPRG_ERASE_BOOT                     3
+               #define XPRG_ERASE_EEPROM                   4
+               #define XPRG_ERASE_APP_PAGE                 5
+               #define XPRG_ERASE_BOOT_PAGE                6
+               #define XPRG_ERASE_EEPROM_PAGE              7
+               #define XPRG_ERASE_USERSIG                  8
+
+               #define XPRG_MEM_WRITE_ERASE                0
+               #define XPRG_MEM_WRITE_WRITE                1
+
+               #define XPRG_CRC_APP                        1
+               #define XPRG_CRC_BOOT                       2
+               #define XPRG_CRC_FLASH                      3
+
+               #define XPRG_ERR_OK                         0
+               #define XPRG_ERR_FAILED                     1
+               #define XPRG_ERR_COLLISION                  2
+               #define XPRG_ERR_TIMEOUT                    3
+
+               #define XPRG_PARAM_NVMBASE                  0x01
+               #define XPRG_PARAM_EEPPAGESIZE              0x02
+               #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_TPI                   0x02
+
+               #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;
+
+       /* 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);
+                       static void XPROGProtocol_SetParam(void);
+                       static void XPROGProtocol_Erase(void);
+                       static void XPROGProtocol_WriteMemory(void);
+                       static void XPROGProtocol_ReadMemory(void);
+                       static void XPROGProtocol_ReadCRC(void);
+               #endif
+
+#endif
+