Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / Projects / AVRISP-MKII / Lib / XPROG / XMEGANVM.h
index d2e2a25..48fa8eb 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 XMEGANVM.c.\r
- */\r
-\r
-#ifndef _XMEGA_NVM_\r
-#define _XMEGA_NVM_\r
-\r
-       /* Includes: */\r
-               #include <avr/io.h>\r
-               #include <avr/interrupt.h>\r
-               #include <stdbool.h>\r
-               \r
-               #include <LUFA/Common/Common.h>\r
-               \r
-               #include "XPROGProtocol.h"\r
-               #include "XPROGTarget.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
-       /* Defines: */\r
-               #define XMEGA_NVM_REG_ADDR0                  0x00\r
-               #define XMEGA_NVM_REG_ADDR1                  0x01\r
-               #define XMEGA_NVM_REG_ADDR2                  0x02\r
-               #define XMEGA_NVM_REG_DAT0                   0x04\r
-               #define XMEGA_NVM_REG_DAT1                   0x05\r
-               #define XMEGA_NVM_REG_DAT2                   0x06\r
-               #define XMEGA_NVM_REG_CMD                    0x0A\r
-               #define XMEGA_NVM_REG_CTRLA                  0x0B\r
-               #define XMEGA_NVM_REG_CTRLB                  0x0C\r
-               #define XMEGA_NVM_REG_INTCTRL                0x0D\r
-               #define XMEGA_NVM_REG_STATUS                 0x0F\r
-               #define XMEGA_NVM_REG_LOCKBITS               0x10\r
-               \r
-               #define XMEGA_NVM_CMD_NOOP                   0x00\r
-               #define XMEGA_NVM_CMD_CHIPERASE              0x40\r
-               #define XMEGA_NVM_CMD_READNVM                0x43\r
-               #define XMEGA_NVM_CMD_LOADFLASHPAGEBUFF      0x23\r
-               #define XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF     0x26\r
-               #define XMEGA_NVM_CMD_ERASEFLASHPAGE         0x2B\r
-               #define XMEGA_NVM_CMD_WRITEFLASHPAGE         0x2E\r
-               #define XMEGA_NVM_CMD_ERASEWRITEFLASH        0x2F\r
-               #define XMEGA_NVM_CMD_FLASHCRC               0x78\r
-               #define XMEGA_NVM_CMD_ERASEAPPSEC            0x20\r
-               #define XMEGA_NVM_CMD_ERASEAPPSECPAGE        0x22\r
-               #define XMEGA_NVM_CMD_WRITEAPPSECPAGE        0x24\r
-               #define XMEGA_NVM_CMD_ERASEWRITEAPPSECPAGE   0x25\r
-               #define XMEGA_NVM_CMD_APPCRC                 0x38\r
-               #define XMEGA_NVM_CMD_ERASEBOOTSEC           0x68\r
-               #define XMEGA_NVM_CMD_ERASEBOOTSECPAGE       0x2A\r
-               #define XMEGA_NVM_CMD_WRITEBOOTSECPAGE       0x2C\r
-               #define XMEGA_NVM_CMD_ERASEWRITEBOOTSECPAGE  0x2D\r
-               #define XMEGA_NVM_CMD_BOOTCRC                0x39\r
-               #define XMEGA_NVM_CMD_READUSERSIG            0x03\r
-               #define XMEGA_NVM_CMD_ERASEUSERSIG           0x18\r
-               #define XMEGA_NVM_CMD_WRITEUSERSIG           0x1A\r
-               #define XMEGA_NVM_CMD_READCALIBRATION        0x02\r
-               #define XMEGA_NVM_CMD_READFUSE               0x07\r
-               #define XMEGA_NVM_CMD_WRITEFUSE              0x4C\r
-               #define XMEGA_NVM_CMD_WRITELOCK              0x08\r
-               #define XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF     0x33\r
-               #define XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF    0x36\r
-               #define XMEGA_NVM_CMD_ERASEEEPROM            0x30\r
-               #define XMEGA_NVM_CMD_ERASEEEPROMPAGE        0x32\r
-               #define XMEGA_NVM_CMD_WRITEEEPROMPAGE        0x34\r
-               #define XMEGA_NVM_CMD_ERASEWRITEEEPROMPAGE   0x35\r
-               #define XMEGA_NVM_CMD_READEEPROM             0x06\r
-\r
-       /* Function Prototypes: */\r
-               void XMEGANVM_SendNVMRegAddress(const uint8_t Register);\r
-               void XMEGANVM_SendAddress(const uint32_t AbsoluteAddress);\r
-               bool XMEGANVM_WaitWhileNVMBusBusy(void);\r
-               bool XMEGANVM_WaitWhileNVMControllerBusy(void);\r
-               bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand, uint32_t* const CRCDest);\r
-               bool XMEGANVM_ReadMemory(const uint32_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize);\r
-               bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand, const uint32_t WriteAddress, const uint8_t Byte);\r
-               bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand, const uint8_t EraseBuffCommand,\r
-                                             const uint8_t WritePageCommand, const uint8_t PageMode, const uint32_t WriteAddress,\r
-                                             const uint8_t* WriteBuffer, uint16_t WriteSize);\r
-               bool XMEGANVM_EraseMemory(const uint8_t EraseCommand, const uint32_t Address);\r
-\r
-#endif\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 XMEGANVM.c.
+ */
+
+#ifndef _XMEGA_NVM_
+#define _XMEGA_NVM_
+
+       /* Includes: */
+               #include <avr/io.h>
+               #include <avr/interrupt.h>
+               #include <stdbool.h>
+
+               #include <LUFA/Common/Common.h>
+
+               #include "XPROGProtocol.h"
+               #include "XPROGTarget.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
+
+       /* Defines: */
+               #define XMEGA_CRC_LENGTH                     3
+
+               #define XMEGA_NVM_REG_ADDR0                  0x00
+               #define XMEGA_NVM_REG_ADDR1                  0x01
+               #define XMEGA_NVM_REG_ADDR2                  0x02
+               #define XMEGA_NVM_REG_DAT0                   0x04
+               #define XMEGA_NVM_REG_DAT1                   0x05
+               #define XMEGA_NVM_REG_DAT2                   0x06
+               #define XMEGA_NVM_REG_CMD                    0x0A
+               #define XMEGA_NVM_REG_CTRLA                  0x0B
+               #define XMEGA_NVM_REG_CTRLB                  0x0C
+               #define XMEGA_NVM_REG_INTCTRL                0x0D
+               #define XMEGA_NVM_REG_STATUS                 0x0F
+               #define XMEGA_NVM_REG_LOCKBITS               0x10
+
+               #define XMEGA_NVM_CMD_NOOP                   0x00
+               #define XMEGA_NVM_CMD_CHIPERASE              0x40
+               #define XMEGA_NVM_CMD_READNVM                0x43
+               #define XMEGA_NVM_CMD_LOADFLASHPAGEBUFF      0x23
+               #define XMEGA_NVM_CMD_ERASEFLASHPAGEBUFF     0x26
+               #define XMEGA_NVM_CMD_ERASEFLASHPAGE         0x2B
+               #define XMEGA_NVM_CMD_WRITEFLASHPAGE         0x2E
+               #define XMEGA_NVM_CMD_ERASEWRITEFLASH        0x2F
+               #define XMEGA_NVM_CMD_FLASHCRC               0x78
+               #define XMEGA_NVM_CMD_ERASEAPPSEC            0x20
+               #define XMEGA_NVM_CMD_ERASEAPPSECPAGE        0x22
+               #define XMEGA_NVM_CMD_WRITEAPPSECPAGE        0x24
+               #define XMEGA_NVM_CMD_ERASEWRITEAPPSECPAGE   0x25
+               #define XMEGA_NVM_CMD_APPCRC                 0x38
+               #define XMEGA_NVM_CMD_ERASEBOOTSEC           0x68
+               #define XMEGA_NVM_CMD_ERASEBOOTSECPAGE       0x2A
+               #define XMEGA_NVM_CMD_WRITEBOOTSECPAGE       0x2C
+               #define XMEGA_NVM_CMD_ERASEWRITEBOOTSECPAGE  0x2D
+               #define XMEGA_NVM_CMD_BOOTCRC                0x39
+               #define XMEGA_NVM_CMD_READUSERSIG            0x03
+               #define XMEGA_NVM_CMD_ERASEUSERSIG           0x18
+               #define XMEGA_NVM_CMD_WRITEUSERSIG           0x1A
+               #define XMEGA_NVM_CMD_READCALIBRATION        0x02
+               #define XMEGA_NVM_CMD_READFUSE               0x07
+               #define XMEGA_NVM_CMD_WRITEFUSE              0x4C
+               #define XMEGA_NVM_CMD_WRITELOCK              0x08
+               #define XMEGA_NVM_CMD_LOADEEPROMPAGEBUFF     0x33
+               #define XMEGA_NVM_CMD_ERASEEEPROMPAGEBUFF    0x36
+               #define XMEGA_NVM_CMD_ERASEEEPROM            0x30
+               #define XMEGA_NVM_CMD_ERASEEEPROMPAGE        0x32
+               #define XMEGA_NVM_CMD_WRITEEEPROMPAGE        0x34
+               #define XMEGA_NVM_CMD_ERASEWRITEEEPROMPAGE   0x35
+               #define XMEGA_NVM_CMD_READEEPROM             0x06
+
+       /* Function Prototypes: */
+               bool XMEGANVM_WaitWhileNVMBusBusy(void);
+               bool XMEGANVM_WaitWhileNVMControllerBusy(void);
+               bool XMEGANVM_EnablePDI(void);
+               void XMEGANVM_DisablePDI(void);
+               bool XMEGANVM_GetMemoryCRC(const uint8_t CRCCommand, uint32_t* const CRCDest);
+               bool XMEGANVM_ReadMemory(const uint32_t ReadAddress, uint8_t* ReadBuffer, uint16_t ReadSize);
+               bool XMEGANVM_WriteByteMemory(const uint8_t WriteCommand, const uint32_t WriteAddress, const uint8_t Byte);
+               bool XMEGANVM_WritePageMemory(const uint8_t WriteBuffCommand, const uint8_t EraseBuffCommand,
+                                             const uint8_t WritePageCommand, const uint8_t PageMode, const uint32_t WriteAddress,
+                                             const uint8_t* WriteBuffer, uint16_t WriteSize);
+               bool XMEGANVM_EraseMemory(const uint8_t EraseCommand, const uint32_t Address);
+
+               #if defined(INCLUDE_FROM_XMEGANVM_C)
+                       static void XMEGANVM_SendNVMRegAddress(const uint8_t Register);
+                       static void XMEGANVM_SendAddress(const uint32_t AbsoluteAddress);
+               #endif
+
+#endif
+