Update UC3 platform driver support to use the bitmasks defined in the header files...
[pub/USBasp.git] / Projects / AVRISP-MKII / Lib / ISP / ISPTarget.h
index 705dd39..3bfa071 100644 (file)
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+
   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 2011  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 <LUFA/Drivers/USB/USB.h>
                #include <LUFA/Drivers/Peripheral/SPI.h>
 
                #include <LUFA/Drivers/USB/USB.h>
                #include <LUFA/Drivers/Peripheral/SPI.h>
-               
+
                #include "../V2ProtocolParams.h"
 
        /* Preprocessor Checks: */
                #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
                        #undef ENABLE_ISP_PROTOCOL
                #include "../V2ProtocolParams.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
 
        /* Macros: */
                        #if !defined(ENABLE_XPROG_PROTOCOL)
                                #define ENABLE_XPROG_PROTOCOL
                        #endif
                #endif
 
        /* Macros: */
-               /** Total number of allowable ISP programming speeds supported by the device */
-               #define TOTAL_ISP_PROGRAMMING_SPEEDS  7
-               
+               /** Low level device command to issue an extended FLASH address, for devices with other 128KB of FLASH. */
                #define LOAD_EXTENDED_ADDRESS_CMD     0x4D
                #define LOAD_EXTENDED_ADDRESS_CMD     0x4D
-               
+
+               /** Macro to convert an ISP frequency to a number of timer clock cycles for the software SPI driver. */
+               #define TIMER_COMP(freq)              (((F_CPU / 8) / 2 / freq) - 1)
+
+               /** ISP rescue clock speed in Hz, for clocking targets with incorrectly set fuses. */
+               #define ISP_RESCUE_CLOCK_SPEED        4000000
+
+       /* External Variables: */
+               extern bool HardwareSPIMode;
+
        /* Function Prototypes: */
        /* Function Prototypes: */
-               uint8_t ISPTarget_GetSPIPrescalerMask(void);
+               void    ISPTarget_EnableTargetISP(void);
+               void    ISPTarget_DisableTargetISP(void);
+               void    ISPTarget_ConfigureRescueClock(void);
+               void    ISPTarget_ConfigureSoftwareSPI(const uint8_t SCKDuration);
+               uint8_t ISPTarget_TransferSoftSPIByte(const uint8_t Byte);
                void    ISPTarget_ChangeTargetResetLine(const bool ResetTarget);
                void    ISPTarget_ChangeTargetResetLine(const bool ResetTarget);
-               uint8_t ISPTarget_WaitForProgComplete(const uint8_t ProgrammingMode, const uint16_t PollAddress,
-                                                     const uint8_t PollValue, const uint8_t DelayMS,
-                                                     const uint8_t ReadMemCommand);
                uint8_t ISPTarget_WaitWhileTargetBusy(void);
                void    ISPTarget_LoadExtendedAddress(void);
                uint8_t ISPTarget_WaitWhileTargetBusy(void);
                void    ISPTarget_LoadExtendedAddress(void);
+               uint8_t ISPTarget_WaitForProgComplete(const uint8_t ProgrammingMode,
+                                                     const uint16_t PollAddress,
+                                                     const uint8_t PollValue,
+                                                     const uint8_t DelayMS,
+                                                     const uint8_t ReadMemCommand);
+
+       /* Inline Functions: */
+               /** Sends a byte of ISP data to the attached target, using the appropriate SPI hardware or
+                *  software routines depending on the selected ISP speed.
+                *
+                *  \param[in] Byte  Byte of data to send to the attached target
+                */
+               static inline void ISPTarget_SendByte(const uint8_t Byte)
+               {
+                       if (HardwareSPIMode)
+                         SPI_SendByte(Byte);
+                       else
+                         ISPTarget_TransferSoftSPIByte(Byte);
+               }
+
+               /** Receives a byte of ISP data from the attached target, using the appropriate
+                *  SPI hardware or software routines depending on the selected ISP speed.
+                *
+                *  \return Received byte of data from the attached target
+                */
+               static inline uint8_t ISPTarget_ReceiveByte(void)
+               {
+                       if (HardwareSPIMode)
+                         return SPI_ReceiveByte();
+                       else
+                         return ISPTarget_TransferSoftSPIByte(0x00);
+               }
+
+               /** Sends and receives a byte of ISP data to and from the attached target, using the
+                *  appropriate SPI hardware or software routines depending on the selected ISP speed.
+                *
+                *  \param[in] Byte  Byte of data to send to the attached target
+                *
+                *  \return Received byte of data from the attached target
+                */
+               static inline uint8_t ISPTarget_TransferByte(const uint8_t Byte)
+               {
+                       if (HardwareSPIMode)
+                         return SPI_TransferByte(Byte);
+                       else
+                         return ISPTarget_TransferSoftSPIByte(Byte);
+               }
 
 #endif
 
 #endif
+