Projects/AVRISP-MKII/Lib/ISP/ISPTarget.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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 /** List of SPI prescaler masks for possible AVRStudio ISP programming speeds. */
  41 static uint8_t SPIMaskFromSCKDuration[] PROGMEM =
  42 {
  43 #if (F_CPU == 8000000)
  44         SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   8MHz SPI, Actual =   4MHz SPI
  45         SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   4MHz SPI, Actual =   4MHz SPI
  46         SPI_SPEED_FCPU_DIV_4,    // AVRStudio =   2MHz SPI, Actual =   2MHz SPI
  47         SPI_SPEED_FCPU_DIV_8,    // AVRStudio =   1MHz SPI, Actual =   1MHz SPI
  48         SPI_SPEED_FCPU_DIV_16,   // AVRStudio = 500KHz SPI, Actual = 500KHz SPI
  49         SPI_SPEED_FCPU_DIV_32,   // AVRStudio = 250KHz SPI, Actual = 250KHz SPI
  50         SPI_SPEED_FCPU_DIV_64,   // AVRStudio = 125KHz SPI, Actual = 125KHz SPI
  51 #elif (F_CPU == 16000000)
  52         SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   8MHz SPI, Actual =   8MHz SPI
  53         SPI_SPEED_FCPU_DIV_4,    // AVRStudio =   4MHz SPI, Actual =   4MHz SPI
  54         SPI_SPEED_FCPU_DIV_8,    // AVRStudio =   2MHz SPI, Actual =   2MHz SPI
  55         SPI_SPEED_FCPU_DIV_16,   // AVRStudio =   1MHz SPI, Actual =   1MHz SPI
  56         SPI_SPEED_FCPU_DIV_32,   // AVRStudio = 500KHz SPI, Actual = 500KHz SPI
  57         SPI_SPEED_FCPU_DIV_64,   // AVRStudio = 250KHz SPI, Actual = 250KHz SPI
  58         SPI_SPEED_FCPU_DIV_128   // AVRStudio = 125KHz SPI, Actual = 125KHz SPI
  59 #else
  60         #error No SPI prescaler masks for chosen F_CPU speed.
  61 #endif
  62 };
  63
  64 /** Converts the given AVR Studio SCK duration parameter (set by a SET PARAM command from the host) to the nearest
  65  *  possible SPI clock prescaler mask for passing to the SPI_Init() routine.
  66  *
  67  *  \return Nearest SPI prescaler mask for the given SCK frequency
  68  */
  69 uint8_t ISPTarget_GetSPIPrescalerMask(void)
  70 {
  71         uint8_t SCKDuration = V2Params_GetParameterValue(PARAM_SCK_DURATION);
  72
  73         if (SCKDuration >= sizeof(SPIMaskFromSCKDuration))
  74           SCKDuration = (sizeof(SPIMaskFromSCKDuration) - 1);
  75
  76         return pgm_read_byte(&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 ISPTarget_ChangeTargetResetLine(const bool ResetTarget)
  85 {
  86         if (ResetTarget)
  87         {
  88                 AUX_LINE_DDR |= AUX_LINE_MASK;
  89
  90                 if (!(V2Params_GetParameterValue(PARAM_RESET_POLARITY)))
  91                   AUX_LINE_PORT |= AUX_LINE_MASK;
  92         }
  93         else
  94         {
  95                 AUX_LINE_DDR  &= ~AUX_LINE_MASK;
  96                 AUX_LINE_PORT &= ~AUX_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 ISPTarget_WaitForProgComplete(const uint8_t ProgrammingMode, const uint16_t PollAddress, const uint8_t PollValue,
 113                                       const uint8_t DelayMS, const 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                         ISPProtocol_DelayMS(DelayMS);
 123                         break;
 124                 case PROG_MODE_WORD_VALUE_MASK:
 125                 case PROG_MODE_PAGED_VALUE_MASK:
 126                         do
 127                         {
 128                                 SPI_SendByte(ReadMemCommand);
 129                                 SPI_SendByte(PollAddress >> 8);
 130                                 SPI_SendByte(PollAddress & 0xFF);
 131                         }
 132                         while ((SPI_TransferByte(0x00) == PollValue) && TimeoutTicksRemaining);
 133
 134                         if (!(TimeoutTicksRemaining))
 135                          ProgrammingStatus = STATUS_CMD_TOUT;
 136
 137                         break;
 138                 case PROG_MODE_WORD_READYBUSY_MASK:
 139                 case PROG_MODE_PAGED_READYBUSY_MASK:
 140                         ProgrammingStatus = ISPTarget_WaitWhileTargetBusy();
 141                         break;
 142         }
 143
 144         return ProgrammingStatus;
 145 }
 146
 147 /** Waits until the target has completed the last operation, by continuously polling the device's
 148  *  BUSY flag until it is cleared, or until the command timeout period has expired.
 149  *
 150  *  \return V2 Protocol status \ref STATUS_CMD_OK if the no timeout occurred, \ref STATUS_RDY_BSY_TOUT otherwise
 151  */
 152 uint8_t ISPTarget_WaitWhileTargetBusy(void)
 153 {
 154         do
 155         {
 156                 SPI_SendByte(0xF0);
 157                 SPI_SendByte(0x00);
 158                 SPI_SendByte(0x00);
 159         }
 160         while ((SPI_ReceiveByte() & 0x01) && TimeoutTicksRemaining);
 161
 162         return TimeoutTicksRemaining ? STATUS_CMD_OK : STATUS_RDY_BSY_TOUT;
 163 }
 164
 165 /** Sends a low-level LOAD EXTENDED ADDRESS command to the target, for addressing of memory beyond the
 166  *  64KB boundary. This sends the command with the correct address as indicated by the current address
 167  *  pointer variable set by the host when a SET ADDRESS command is issued.
 168  */
 169 void ISPTarget_LoadExtendedAddress(void)
 170 {
 171         SPI_SendByte(LOAD_EXTENDED_ADDRESS_CMD);
 172         SPI_SendByte(0x00);
 173         SPI_SendByte((CurrentAddress & 0x00FF0000) >> 16);
 174         SPI_SendByte(0x00);
 175 }
 176
 177 #endif