Projects/AVRISP/Lib/ISPTarget.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Target-related functions for the ISP Protocol decoder.
  34  */
  35
  36 #include "ISPTarget.h"
  37
  38 #if defined(ENABLE_ISP_PROTOCOL) || defined(__DOXYGEN__)
  39
  40 /** Converts the given AVR Studio SCK duration parameter (set by a SET PARAM command from the host) to the nearest
  41  *  possible SPI clock prescaler mask for passing to the SPI_Init() routine.
  42  *
  43  *  \return Nearest SPI prescaler mask for the given SCK frequency
  44  */
  45 uint8_t ISPTarget_GetSPIPrescalerMask(void)
  46 {
  47         static const uint8_t SPIMaskFromSCKDuration[] =
  48         {
  49         #if (F_CPU == 8000000)
  50                 SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   8MHz SPI, Actual =   4MHz SPI
  51                 SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   4MHz SPI, Actual =   4MHz SPI
  52                 SPI_SPEED_FCPU_DIV_4,    // AVRStudio =   2MHz SPI, Actual =   2MHz SPI
  53                 SPI_SPEED_FCPU_DIV_8,    // AVRStudio =   1MHz SPI, Actual =   1MHz SPI
  54                 SPI_SPEED_FCPU_DIV_16,   // AVRStudio = 500KHz SPI, Actual = 500KHz SPI
  55                 SPI_SPEED_FCPU_DIV_32,   // AVRStudio = 250KHz SPI, Actual = 250KHz SPI
  56                 SPI_SPEED_FCPU_DIV_64    // AVRStudio = 125KHz SPI, Actual = 125KHz SPI
  57         #elif (F_CPU == 16000000)
  58                 SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   8MHz SPI, Actual =   8MHz SPI
  59                 SPI_SPEED_FCPU_DIV_4,    // AVRStudio =   4MHz SPI, Actual =   4MHz SPI
  60                 SPI_SPEED_FCPU_DIV_8,    // AVRStudio =   2MHz SPI, Actual =   2MHz SPI
  61                 SPI_SPEED_FCPU_DIV_16,   // AVRStudio =   1MHz SPI, Actual =   1MHz SPI
  62                 SPI_SPEED_FCPU_DIV_32,   // AVRStudio = 500KHz SPI, Actual = 500KHz SPI
  63                 SPI_SPEED_FCPU_DIV_64,   // AVRStudio = 250KHz SPI, Actual = 250KHz SPI
  64                 SPI_SPEED_FCPU_DIV_128   // AVRStudio = 125KHz SPI, Actual = 125KHz SPI
  65         #else
  66                 #error No SPI prescaler masks for chosen F_CPU speed.
  67         #endif
  68         };
  69
  70         uint8_t SCKDuration = V2Params_GetParameterValue(PARAM_SCK_DURATION);
  71
  72         if (SCKDuration >= sizeof(SPIMaskFromSCKDuration))
  73           SCKDuration = (sizeof(SPIMaskFromSCKDuration) - 1);
  74
  75         return SPIMaskFromSCKDuration[SCKDuration];
  76 }
  77
  78 /** Asserts or deasserts the target's reset line, using the correct polarity as set by the host using a SET PARAM command.
  79  *  When not asserted, the line is tristated so as not to interfere with normal device operation.
  80  *
  81  *  \param[in] ResetTarget Boolean true when the target should be held in reset, false otherwise
  82  */
  83 void ISPTarget_ChangeTargetResetLine(const bool ResetTarget)
  84 {
  85         if (ResetTarget)
  86         {
  87                 RESET_LINE_DDR |= RESET_LINE_MASK;
  88
  89                 if (!(V2Params_GetParameterValue(PARAM_RESET_POLARITY)))
  90                   RESET_LINE_PORT |= RESET_LINE_MASK;
  91         }
  92         else
  93         {
  94                 RESET_LINE_DDR  &= ~RESET_LINE_MASK;
  95                 RESET_LINE_PORT &= ~RESET_LINE_MASK;
  96         }
  97 }
  98
  99 /** Waits until the last issued target memory programming command has completed, via the check mode given and using
 100  *  the given parameters.
 101  *
 102  *  \param[in] ProgrammingMode  Programming mode used and completion check to use, a mask of PROG_MODE_* constants
 103  *  \param[in] PollAddress  Memory address to poll for completion if polling check mode used
 104  *  \param[in] PollValue  Poll value to check against if polling check mode used
 105  *  \param[in] DelayMS  Milliseconds to delay before returning if delay check mode used
 106  *  \param[in] ReadMemCommand  Device low-level READ MEMORY command to send if value check mode used
 107  *
 108  *  \return V2 Protocol status \ref STATUS_CMD_OK if the no timeout occurred, \ref STATUS_RDY_BSY_TOUT or
 109  *          \ref STATUS_CMD_TOUT otherwise
 110  */
 111 uint8_t ISPTarget_WaitForProgComplete(const uint8_t ProgrammingMode, const uint16_t PollAddress, const uint8_t PollValue,
 112                                       const uint8_t DelayMS, const uint8_t ReadMemCommand)
 113 {
 114         uint8_t ProgrammingStatus = STATUS_CMD_OK;
 115
 116         /* Determine method of Programming Complete check */
 117         switch (ProgrammingMode & ~(PROG_MODE_PAGED_WRITES_MASK | PROG_MODE_COMMIT_PAGE_MASK))
 118         {
 119                 case PROG_MODE_WORD_TIMEDELAY_MASK:
 120                 case PROG_MODE_PAGED_TIMEDELAY_MASK:
 121                         V2Protocol_DelayMS(DelayMS);
 122                         break;
 123                 case PROG_MODE_WORD_VALUE_MASK:
 124                 case PROG_MODE_PAGED_VALUE_MASK:
 125                         TCNT0 = 0;
 126                         TIFR0 = (1 << OCF1A);
 127
 128                         uint8_t TimeoutMS = TARGET_BUSY_TIMEOUT_MS;
 129
 130                         do
 131                         {
 132                                 SPI_SendByte(ReadMemCommand);
 133                                 SPI_SendByte(PollAddress >> 8);
 134                                 SPI_SendByte(PollAddress & 0xFF);
 135
 136                                 if (TIFR0 & (1 << OCF1A))
 137                                 {
 138                                         TIFR0 = (1 << OCF1A);
 139                                         TimeoutMS--;
 140                                 }
 141                         }
 142                         while ((SPI_TransferByte(0x00) != PollValue) && TimeoutMS);
 143
 144                         if (!(TimeoutMS))
 145                          ProgrammingStatus = STATUS_CMD_TOUT;
 146
 147                         break;
 148                 case PROG_MODE_WORD_READYBUSY_MASK:
 149                 case PROG_MODE_PAGED_READYBUSY_MASK:
 150                         ProgrammingStatus = ISPTarget_WaitWhileTargetBusy();
 151                         break;
 152         }
 153
 154         return ProgrammingStatus;
 155 }
 156
 157 /** Waits until the target has completed the last operation, by continuously polling the device's
 158  *  BUSY flag until it is cleared, or until the \ref TARGET_BUSY_TIMEOUT_MS timeout period has expired.
 159  *
 160  *  \return V2 Protocol status \ref STATUS_CMD_OK if the no timeout occurred, \ref STATUS_RDY_BSY_TOUT otherwise
 161  */
 162 uint8_t ISPTarget_WaitWhileTargetBusy(void)
 163 {
 164         TCNT0 = 0;
 165         TIFR0 = (1 << OCF1A);
 166
 167         uint8_t TimeoutMS = TARGET_BUSY_TIMEOUT_MS;
 168
 169         do
 170         {
 171                 SPI_SendByte(0xF0);
 172                 SPI_SendByte(0x00);
 173
 174                 SPI_SendByte(0x00);
 175
 176                 if (TIFR0 & (1 << OCF1A))
 177                 {
 178                         TIFR0 = (1 << OCF1A);
 179                         TimeoutMS--;
 180                 }
 181         }
 182         while ((SPI_ReceiveByte() & 0x01) && TimeoutMS);
 183
 184         if (!(TimeoutMS))
 185           return STATUS_RDY_BSY_TOUT;
 186         else
 187           return STATUS_CMD_OK;
 188 }
 189
 190 /** Sends a low-level LOAD EXTENDED ADDRESS command to the target, for addressing of memory beyond the
 191  *  64KB boundary. This sends the command with the correct address as indicated by the current address
 192  *  pointer variable set by the host when a SET ADDRESS command is issued.
 193  */
 194 void ISPTarget_LoadExtendedAddress(void)
 195 {
 196         SPI_SendByte(0x4D);
 197         SPI_SendByte(0x00);
 198         SPI_SendByte((CurrentAddress & 0x00FF0000) >> 16);
 199         SPI_SendByte(0x00);
 200 }
 201
 202 #endif