Minor fixups to the documentation and preprocessor tokens.
[pub/USBasp.git] / Projects / AVRISP-MKII / Lib / XPROG / XPROGTarget.h
index 7aca20b..41bc14a 100644 (file)
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r
-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\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, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  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
+  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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r
 \r
 /** \file\r
  *\r
 \r
 /** \file\r
  *\r
- *  Header file for PDITarget.c.\r
+ *  Header file for XPROGTarget.c.\r
  */\r
 \r
  */\r
 \r
-#ifndef _PDI_TARGET_\r
-#define _PDI_TARGET_\r
+#ifndef _XPROG_TARGET_\r
+#define _XPROG_TARGET_\r
 \r
        /* Includes: */\r
                #include <avr/io.h>\r
 \r
        /* Includes: */\r
                #include <avr/io.h>\r
@@ -44,6 +44,7 @@
                #include <LUFA/Common/Common.h>\r
                \r
                #include "../V2Protocol.h"\r
                #include <LUFA/Common/Common.h>\r
                \r
                #include "../V2Protocol.h"\r
+               #include "XPROGProtocol.h"\r
        \r
        /* Preprocessor Checks: */\r
                #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))\r
        \r
        /* Preprocessor Checks: */\r
                #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))\r
 \r
        /* Defines: */\r
                #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))\r
 \r
        /* Defines: */\r
                #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))\r
-//                     #define XPROG_VIA_HARDWARE_USART\r
-\r
-                       #define BITBANG_PDIDATA_PORT     PORTD\r
-                       #define BITBANG_PDIDATA_DDR      DDRD\r
-                       #define BITBANG_PDIDATA_PIN      PIND\r
-                       #define BITBANG_PDIDATA_MASK     (1 << 3)\r
-                       \r
-                       #define BITBANG_PDICLOCK_PORT    PORTD\r
-                       #define BITBANG_PDICLOCK_DDR     DDRD\r
-                       #define BITBANG_PDICLOCK_PIN     PIND\r
-                       #define BITBANG_PDICLOCK_MASK    (1 << 5)\r
-\r
-                       #define BITBANG_TPIDATA_PORT     PORTB\r
-                       #define BITBANG_TPIDATA_DDR      DDRB\r
-                       #define BITBANG_TPIDATA_PIN      PINB\r
-                       #define BITBANG_TPIDATA_MASK     (1 << 3)\r
-                               \r
-                       #define BITBANG_TPICLOCK_PORT    PORTB\r
-                       #define BITBANG_TPICLOCK_DDR     DDRB\r
-                       #define BITBANG_TPICLOCK_PIN     PINB\r
-                       #define BITBANG_TPICLOCK_MASK    (1 << 1)\r
-\r
-\r
+                       #define XPROG_VIA_HARDWARE_USART\r
                #else\r
                        #define BITBANG_PDIDATA_PORT     PORTB\r
                        #define BITBANG_PDIDATA_DDR      DDRB\r
                        #define BITBANG_PDIDATA_PIN      PINB\r
                        #define BITBANG_PDIDATA_MASK     (1 << 3)\r
                        \r
                #else\r
                        #define BITBANG_PDIDATA_PORT     PORTB\r
                        #define BITBANG_PDIDATA_DDR      DDRB\r
                        #define BITBANG_PDIDATA_PIN      PINB\r
                        #define BITBANG_PDIDATA_MASK     (1 << 3)\r
                        \r
-                       #define BITBANG_PDICLOCK_PORT    RESET_LINE_PORT\r
-                       #define BITBANG_PDICLOCK_DDR     RESET_LINE_DDR\r
-                       #define BITBANG_PDICLOCK_PIN     RESET_LINE_PIN\r
-                       #define BITBANG_PDICLOCK_MASK    RESET_LINE_MASK\r
+                       #define BITBANG_PDICLOCK_PORT    AUX_LINE_PORT\r
+                       #define BITBANG_PDICLOCK_DDR     AUX_LINE_DDR\r
+                       #define BITBANG_PDICLOCK_PIN     AUX_LINE_PIN\r
+                       #define BITBANG_PDICLOCK_MASK    AUX_LINE_MASK\r
 \r
                        #define BITBANG_TPIDATA_PORT     PORTB\r
                        #define BITBANG_TPIDATA_DDR      DDRB\r
 \r
                        #define BITBANG_TPIDATA_PORT     PORTB\r
                        #define BITBANG_TPIDATA_DDR      DDRB\r
                        #define BITBANG_TPICLOCK_MASK    (1 << 1)\r
                #endif\r
                \r
                        #define BITBANG_TPICLOCK_MASK    (1 << 1)\r
                #endif\r
                \r
+               /** Number of cycles between each clock when software USART mode is used */\r
+               #define BITS_BETWEEN_USART_CLOCKS  200\r
+               \r
                /** Total number of bits in a single USART frame */\r
                /** Total number of bits in a single USART frame */\r
-               #define BITS_IN_USART_FRAME      12\r
+               #define BITS_IN_USART_FRAME        12\r
                \r
                \r
-               #define PDI_CMD_LDS              0x00\r
-               #define PDI_CMD_LD               0x20\r
-               #define PDI_CMD_STS              0x40\r
-               #define PDI_CMD_ST               0x60\r
-               #define PDI_CMD_LDCS             0x80\r
-               #define PDI_CMD_REPEAT           0xA0\r
-               #define PDI_CMD_STCS             0xC0\r
-               #define PDI_CMD_KEY              0xE0\r
+               #define PDI_CMD_LDS                0x00\r
+               #define PDI_CMD_LD                 0x20\r
+               #define PDI_CMD_STS                0x40\r
+               #define PDI_CMD_ST                 0x60\r
+               #define PDI_CMD_LDCS               0x80\r
+               #define PDI_CMD_REPEAT             0xA0\r
+               #define PDI_CMD_STCS               0xC0\r
+               #define PDI_CMD_KEY                0xE0\r
                \r
                \r
-               #define PDI_STATUS_REG           0\r
-               #define PDI_RESET_REG            1\r
-               #define PDI_CTRL_REG             2\r
+               #define PDI_STATUS_REG             0\r
+               #define PDI_RESET_REG              1\r
+               #define PDI_CTRL_REG               2\r
                \r
                \r
-               #define PDI_STATUS_NVM           (1 << 1)\r
-               #define PDI_RESET_KEY            0x59\r
+               #define PDI_STATUS_NVM             (1 << 1)\r
 \r
 \r
-               #define PDI_NVMENABLE_KEY        (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}\r
+               #define PDI_RESET_KEY              0x59\r
+               #define PDI_NVMENABLE_KEY          (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}\r
 \r
 \r
-               #define PDI_DATSIZE_1BYTE        0\r
-               #define PDI_DATSIZE_2BYTES       1\r
-               #define PDI_DATSIZE_3BYTES       2\r
-               #define PDI_DATSIZE_4BYTES       3\r
+               #define PDI_DATSIZE_1BYTE          0\r
+               #define PDI_DATSIZE_2BYTES         1\r
+               #define PDI_DATSIZE_3BYTES         2\r
+               #define PDI_DATSIZE_4BYTES         3\r
                \r
                \r
-               #define PDI_POINTER_INDIRECT     0\r
-               #define PDI_POINTER_INDIRECT_PI  1\r
-               #define PDI_POINTER_DIRECT       2\r
-\r
-               #define TPI_CMD_SLD              0x20\r
-               #define TPI_CMD_SST              0x60\r
-               #define TPI_CMD_SSTPR            0x68\r
-               #define TPI_CMD_SIN              0x10\r
-               #define TPI_CMD_SOUT             0x90\r
-               #define TPI_CMD_SLDCS            0x80\r
-               #define TPI_CMD_SSTCS            0xC0\r
-               #define TPI_CMD_SKEY             0xE0\r
-\r
-               #define TPI_STATUS_REG           0x00\r
-               #define TPI_CTRL_REG             0x02\r
-               #define TPI_ID_REG               0x0F\r
+               #define PDI_POINTER_INDIRECT       0\r
+               #define PDI_POINTER_INDIRECT_PI    1\r
+               #define PDI_POINTER_DIRECT         2\r
+\r
+               #define TPI_CMD_SLD                0x20\r
+               #define TPI_CMD_SST                0x60\r
+               #define TPI_CMD_SSTPR              0x68\r
+               #define TPI_CMD_SIN                0x10\r
+               #define TPI_CMD_SOUT               0x90\r
+               #define TPI_CMD_SLDCS              0x80\r
+               #define TPI_CMD_SSTCS              0xC0\r
+               #define TPI_CMD_SKEY               0xE0\r
+\r
+               #define TPI_STATUS_REG             0x00\r
+               #define TPI_CTRL_REG               0x02\r
+               #define TPI_ID_REG                 0x0F\r
                \r
                \r
-               #define TPI_STATUS_NVM           (1 << 1)\r
+               #define TPI_STATUS_NVM             (1 << 1)\r
 \r
 \r
-               #define TPI_NVMENABLE_KEY        (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}\r
+               #define TPI_NVMENABLE_KEY          (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}\r
 \r
 \r
-               #define TPI_POINTER_INDIRECT     0\r
-               #define TPI_POINTER_INDIRECT_PI  (1 << 2)\r
+               #define TPI_POINTER_INDIRECT       0\r
+               #define TPI_POINTER_INDIRECT_PI    (1 << 2)\r
                \r
        /* Function Prototypes: */\r
                void    XPROGTarget_EnableTargetPDI(void);\r
                \r
        /* Function Prototypes: */\r
                void    XPROGTarget_EnableTargetPDI(void);\r
                uint8_t XPROGTarget_ReceiveByte(void);\r
                void    XPROGTarget_SendBreak(void);\r
                bool    XPROGTarget_WaitWhileNVMBusBusy(void);\r
                uint8_t XPROGTarget_ReceiveByte(void);\r
                void    XPROGTarget_SendBreak(void);\r
                bool    XPROGTarget_WaitWhileNVMBusBusy(void);\r
+               \r
+               #if defined(INCLUDE_FROM_XPROGTARGET_C)\r
+                       static void XPROGTarget_SetTxMode(void);\r
+                       static void XPROGTarget_SetRxMode(void);\r
+               #endif\r
 \r
 #endif\r
 \r
 #endif\r