ISPTarget.c 6.79 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  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 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
33
 *  Target-related functions for the ISP Protocol decoder.
34
35
 */

36
#include "ISPTarget.h"
37

38
39
#if defined(ENABLE_ISP_PROTOCOL) || defined(__DOXYGEN__)

40
41
42
43
44
/** Converts the given AVR Studio SCK duration parameter (set by a SET PARAM command from the host) to the nearest
 *  possible SPI clock prescaler mask for passing to the SPI_Init() routine.
 *
 *  \return Nearest SPI prescaler mask for the given SCK frequency
 */
45
uint8_t ISPTarget_GetSPIPrescalerMask(void)
46
{
47
	static const uint8_t SPIMaskFromSCKDuration[] =
48
	{
49
50
51
52
53
54
55
	#if (F_CPU == 8000000)
		SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   8MHz SPI, Actual =   4MHz SPI
		SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   4MHz SPI, Actual =   4MHz SPI
		SPI_SPEED_FCPU_DIV_4,    // AVRStudio =   2MHz SPI, Actual =   2MHz SPI
		SPI_SPEED_FCPU_DIV_8,    // AVRStudio =   1MHz SPI, Actual =   1MHz SPI
		SPI_SPEED_FCPU_DIV_16,   // AVRStudio = 500KHz SPI, Actual = 500KHz SPI
		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
59
60
61
62
		SPI_SPEED_FCPU_DIV_2,    // AVRStudio =   8MHz SPI, Actual =   8MHz SPI
		SPI_SPEED_FCPU_DIV_4,    // AVRStudio =   4MHz SPI, Actual =   4MHz SPI
		SPI_SPEED_FCPU_DIV_8,    // AVRStudio =   2MHz SPI, Actual =   2MHz SPI
		SPI_SPEED_FCPU_DIV_16,   // AVRStudio =   1MHz SPI, Actual =   1MHz SPI
		SPI_SPEED_FCPU_DIV_32,   // AVRStudio = 500KHz SPI, Actual = 500KHz SPI
63
		SPI_SPEED_FCPU_DIV_64,   // AVRStudio = 250KHz SPI, Actual = 250KHz SPI
64
65
66
67
		SPI_SPEED_FCPU_DIV_128   // AVRStudio = 125KHz SPI, Actual = 125KHz SPI
	#else
		#error No SPI prescaler masks for chosen F_CPU speed.
	#endif
68
69
70
71
72
73
74
75
76
77
	};

	uint8_t SCKDuration = V2Params_GetParameterValue(PARAM_SCK_DURATION);

	if (SCKDuration >= sizeof(SPIMaskFromSCKDuration))
	  SCKDuration = (sizeof(SPIMaskFromSCKDuration) - 1);
	  
	return SPIMaskFromSCKDuration[SCKDuration];
}

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
86
{
	if (ResetTarget)
	{
87
		AUX_LINE_DDR |= AUX_LINE_MASK;
88
89
		
		if (!(V2Params_GetParameterValue(PARAM_RESET_POLARITY)))
90
		  AUX_LINE_PORT |= AUX_LINE_MASK;
91
92
93
	}
	else
	{
94
95
		AUX_LINE_DDR  &= ~AUX_LINE_MASK;
		AUX_LINE_PORT &= ~AUX_LINE_MASK;
96
97
98
	}
}

99
100
101
/** Waits until the last issued target memory programming command has completed, via the check mode given and using
 *  the given parameters.
 *
102
103
104
105
106
 *  \param[in] ProgrammingMode  Programming mode used and completion check to use, a mask of PROG_MODE_* constants
 *  \param[in] PollAddress  Memory address to poll for completion if polling check mode used
 *  \param[in] PollValue  Poll value to check against if polling check mode used
 *  \param[in] DelayMS  Milliseconds to delay before returning if delay check mode used
 *  \param[in] ReadMemCommand  Device low-level READ MEMORY command to send if value check mode used
107
108
109
110
 *
 *  \return V2 Protocol status \ref STATUS_CMD_OK if the no timeout occurred, \ref STATUS_RDY_BSY_TOUT or
 *          \ref STATUS_CMD_TOUT otherwise
 */
111
112
uint8_t ISPTarget_WaitForProgComplete(const uint8_t ProgrammingMode, const uint16_t PollAddress, const uint8_t PollValue,
                                      const uint8_t DelayMS, const uint8_t ReadMemCommand)
113
{
114
	uint8_t ProgrammingStatus  = STATUS_CMD_OK;
115

116
117
118
119
120
	/* Determine method of Programming Complete check */
	switch (ProgrammingMode & ~(PROG_MODE_PAGED_WRITES_MASK | PROG_MODE_COMMIT_PAGE_MASK))
	{
		case PROG_MODE_WORD_TIMEDELAY_MASK:
		case PROG_MODE_PAGED_TIMEDELAY_MASK:
121
			ISPProtocol_DelayMS(DelayMS);
122
123
124
125
126
			break;
		case PROG_MODE_WORD_VALUE_MASK:
		case PROG_MODE_PAGED_VALUE_MASK:
			do
			{
127
128
129
				SPI_SendByte(ReadMemCommand);
				SPI_SendByte(PollAddress >> 8);
				SPI_SendByte(PollAddress & 0xFF);
130
			}
131
			while ((SPI_TransferByte(0x00) == PollValue) && TimeoutMSRemaining);
132

133
			if (!(TimeoutMSRemaining))
134
			 ProgrammingStatus = STATUS_CMD_TOUT;
135
136
137
138
			
			break;		
		case PROG_MODE_WORD_READYBUSY_MASK:
		case PROG_MODE_PAGED_READYBUSY_MASK:
139
			ProgrammingStatus = ISPTarget_WaitWhileTargetBusy();
140
			break;
141
142
	}

143
144
145
	if (ProgrammingStatus == STATUS_CMD_OK)
	  TimeoutMSRemaining = COMMAND_TIMEOUT_MS;

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 command timeout period has expired.
151
152
153
 *
 *  \return V2 Protocol status \ref STATUS_CMD_OK if the no timeout occurred, \ref STATUS_RDY_BSY_TOUT otherwise
 */
154
uint8_t ISPTarget_WaitWhileTargetBusy(void)
155
156
157
{
	do
	{
158
159
160
		SPI_SendByte(0xF0);
		SPI_SendByte(0x00);
		SPI_SendByte(0x00);
161
	}
162
	while ((SPI_ReceiveByte() & 0x01) && TimeoutMSRemaining);
163

164
165
166
167
168
169
170
171
172
	if (TimeoutMSRemaining)
	{
		TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
		return STATUS_CMD_OK;
	}
	else
	{
		return STATUS_RDY_BSY_TOUT;
	}
173
174
}

175
176
177
178
/** Sends a low-level LOAD EXTENDED ADDRESS command to the target, for addressing of memory beyond the
 *  64KB boundary. This sends the command with the correct address as indicated by the current address
 *  pointer variable set by the host when a SET ADDRESS command is issued.
 */
179
void ISPTarget_LoadExtendedAddress(void)
180
{
181
182
183
184
	SPI_SendByte(LOAD_EXTENDED_ADDRESS_CMD);
	SPI_SendByte(0x00);
	SPI_SendByte((CurrentAddress & 0x00FF0000) >> 16);
	SPI_SendByte(0x00);	
185
}
186
187

#endif