Projects/AVRISP/Lib/V2ProtocolTarget.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 V2 Protocol decoder.
  34  */
  35
  36 #include "V2ProtocolTarget.h"
  37
  38 /** Current memory address for FLASH/EEPROM memory read/write commands */
  39 uint32_t CurrentAddress;
  40
  41 /** Converts the given AVR Studio SCK duration parameter (set by a SET PARAM command from the host) to the nearest
  42  *  possible SPI clock prescaler mask for passing to the SPI_Init() routine.
  43  *
  44  *  \return Nearest SPI prescaler mask for the given SCK frequency
  45  */
  46 uint8_t V2Protocol_GetSPIPrescalerMask(void)
  47 {
  48         static const uint8_t SPIMaskFromSCKDuration[] =
  49         {
  50         #if (F_CPU == 8000000)
  51                 SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   8MHz SPI, Actual =   4MHz SPI
  52                 SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   4MHz SPI, Actual =   4MHz SPI
  53                 SPI_SPEED_FCPU_DIV_4,    // AVRStudio =   2MHz SPI, Actual =   2MHz SPI
  54                 SPI_SPEED_FCPU_DIV_8,    // AVRStudio =   1MHz SPI, Actual =   1MHz SPI
  55                 SPI_SPEED_FCPU_DIV_16,   // AVRStudio = 500KHz SPI, Actual = 500KHz SPI
  56                 SPI_SPEED_FCPU_DIV_32,   // AVRStudio = 250KHz SPI, Actual = 250KHz SPI
  57                 SPI_SPEED_FCPU_DIV_64    // AVRStudio = 125KHz SPI, Actual = 125KHz SPI
  58         #elif (F_CPU == 16000000)
  59                 SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   8MHz SPI, Actual =   8MHz SPI
  60                 SPI_SPEED_FCPU_DIV_4,    // AVRStudio =   4MHz SPI, Actual =   4MHz SPI
  61                 SPI_SPEED_FCPU_DIV_8,    // AVRStudio =   2MHz SPI, Actual =   2MHz SPI
  62                 SPI_SPEED_FCPU_DIV_16,   // AVRStudio =   1MHz SPI, Actual =   1MHz SPI
  63                 SPI_SPEED_FCPU_DIV_32,   // AVRStudio = 500KHz SPI, Actual = 500KHz SPI
  64                 SPI_SPEED_FCPU_DIV_64,   // AVRStudio = 250KHz SPI, Actual = 250KHz SPI
  65                 SPI_SPEED_FCPU_DIV_128   // AVRStudio = 125KHz SPI, Actual = 125KHz SPI
  66         #else
  67                 #error No SPI prescaler masks for chosen F_CPU speed.
  68         #endif
  69         };
  70
  71         uint8_t SCKDuration = V2Params_GetParameterValue(PARAM_SCK_DURATION);
  72
  73         if (SCKDuration >= sizeof(SPIMaskFromSCKDuration))
  74           SCKDuration = (sizeof(SPIMaskFromSCKDuration) - 1);
  75
  76         return SPIMaskFromSCKDuration[SCKDuration];
  77 }
  78
  79 /** Asserts or deasserts the target's reset line, using the correct polarity as set by the host using a SET PARAM command.
  80  *  When not asserted, the line is tristated so as not to interfere with normal device operation.
  81  *
  82  *  \param[in] ResetTarget Boolean true when the target should be held in reset, false otherwise
  83  */
  84 void V2Protocol_ChangeTargetResetLine(bool ResetTarget)
  85 {
  86         if (ResetTarget)
  87         {
  88                 RESET_LINE_DDR |= RESET_LINE_MASK;
  89
  90                 if (!(V2Params_GetParameterValue(PARAM_RESET_POLARITY)))
  91                   RESET_LINE_PORT |= RESET_LINE_MASK;
  92         }
  93         else
  94         {
  95                 RESET_LINE_DDR  &= ~RESET_LINE_MASK;
  96                 RESET_LINE_PORT &= ~RESET_LINE_MASK;
  97         }
  98 }
  99
 100 /** Waits until the last issued target memory programming command has completed, via the check mode given and using
 101  *  the given parameters.
 102  *
 103  *  \param[in] ProgrammingMode  Programming mode used and completion check to use, a mask of PROG_MODE_* constants
 104  *  \param[in] PollAddress  Memory address to poll for completion if polling check mode used
 105  *  \param[in] PollValue  Poll value to check against if polling check mode used
 106  *  \param[in] DelayMS  Milliseconds to delay before returning if delay check mode used
 107  *  \param[in] ReadMemCommand  Device low-level READ MEMORY command to send if value check mode used
 108  *
 109  *  \return V2 Protocol status \ref STATUS_CMD_OK if the no timeout occurred, \ref STATUS_RDY_BSY_TOUT or
 110  *          \ref STATUS_CMD_TOUT otherwise
 111  */
 112 uint8_t V2Protocol_WaitForProgComplete(uint8_t ProgrammingMode, uint16_t PollAddress, uint8_t PollValue,
 113                                        uint8_t DelayMS, uint8_t ReadMemCommand)
 114 {
 115         uint8_t ProgrammingStatus = STATUS_CMD_OK;
 116
 117         /* Determine method of Programming Complete check */
 118         switch (ProgrammingMode & ~(PROG_MODE_PAGED_WRITES_MASK | PROG_MODE_COMMIT_PAGE_MASK))
 119         {
 120                 case PROG_MODE_WORD_TIMEDELAY_MASK:
 121                 case PROG_MODE_PAGED_TIMEDELAY_MASK:
 122                         V2Protocol_DelayMS(DelayMS);
 123                         break;
 124                 case PROG_MODE_WORD_VALUE_MASK:
 125                 case PROG_MODE_PAGED_VALUE_MASK:
 126                         TCNT0 = 0;
 127
 128                         do
 129                         {
 130                                 SPI_SendByte(ReadMemCommand);
 131                                 SPI_SendByte(PollAddress >> 8);
 132                                 SPI_SendByte(PollAddress & 0xFF);
 133                         }
 134                         while ((SPI_TransferByte(0x00) != PollValue) && (TCNT0 < TARGET_BUSY_TIMEOUT_MS));
 135
 136                         if (TCNT0 >= TARGET_BUSY_TIMEOUT_MS)
 137                          ProgrammingStatus = STATUS_CMD_TOUT;
 138
 139                         break;
 140                 case PROG_MODE_WORD_READYBUSY_MASK:
 141                 case PROG_MODE_PAGED_READYBUSY_MASK:
 142                         ProgrammingStatus = V2Protocol_WaitWhileTargetBusy();
 143                         break;
 144         }
 145
 146         return ProgrammingStatus;
 147 }
 148
 149 /** Waits until the target has completed the last operation, by continuously polling the device's
 150  *  BUSY flag until it is cleared, or until the \ref TARGET_BUSY_TIMEOUT_MS timeout period has expired.
 151  *
 152  *  \return V2 Protocol status \ref STATUS_CMD_OK if the no timeout occurred, \ref STATUS_RDY_BSY_TOUT otherwise
 153  */
 154 uint8_t V2Protocol_WaitWhileTargetBusy(void)
 155 {
 156         TCNT0 = 0;
 157
 158         do
 159         {
 160                 SPI_SendByte(0xF0);
 161                 SPI_SendByte(0x00);
 162
 163                 SPI_SendByte(0x00);
 164         }
 165         while ((SPI_ReceiveByte() & 0x01) && (TCNT0 < TARGET_BUSY_TIMEOUT_MS));
 166
 167         if (TCNT0 >= TARGET_BUSY_TIMEOUT_MS)
 168           return STATUS_RDY_BSY_TOUT;
 169         else
 170           return STATUS_CMD_OK;
 171 }
 172
 173 /** Sends a low-level LOAD EXTENDED ADDRESS command to the target, for addressing of memory beyond the
 174  *  64KB boundary. This sends the command with the correct address as indicated by the current address
 175  *  pointer variable set by the host when a SET ADDRESS command is issued.
 176  */
 177 void V2Protocol_LoadExtendedAddress(void)
 178 {
 179         SPI_SendByte(0x4D);
 180         SPI_SendByte(0x00);
 181         SPI_SendByte((CurrentAddress & 0x00FF0000) >> 16);
 182         SPI_SendByte(0x00);
 183 }