aboutsummaryrefslogtreecommitdiff
path: root/src/flash/nor/dsp5680xx_flash.c
blob: 858b669815f6d5958331206e3a2f6b6c7d6de8bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/***************************************************************************
 *   Copyright (C) 2011 by Rodrigo L. Rosa                                 *
 *   rodrigorosa.LG@gmail.com                                              *
 *                                                                         *
 *   Based on a file written by:                                           *
 *   Kevin McGuire                                                         *
 *   Marcel Wijlaars                                                       *
 *   Michael Ashton                                                        *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
 ***************************************************************************/

/**
 * @file   dsp5680xx_flash.c
 * @author Rodrigo L. Rosa <rodrigorosa.LG@gmail.com>
 * @date   Thu Jun  9 18:21:58 2011
 *
 * @brief  This file implements the basic functions to run flashing commands
 * from the TCL interface.
 * It allows the user to flash the Freescale 5680xx DSP.
 *
 *
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "imp.h"
#include <helper/binarybuffer.h>
#include <helper/time_support.h>
#include <target/algorithm.h>
#include <target/dsp5680xx.h>

static int dsp5680xx_build_sector_list(struct flash_bank *bank)
{
	bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);

	for (unsigned int i = 0; i < bank->num_sectors; ++i) {
		bank->sectors[i].offset = i * HFM_SECTOR_SIZE;
		bank->sectors[i].size = HFM_SECTOR_SIZE;
		bank->sectors[i].is_erased = -1;
		bank->sectors[i].is_protected = -1;
	}
	LOG_USER("%s not tested yet.", __func__);
	return ERROR_OK;

}

/* flash bank dsp5680xx 0 0 0 0 <target#> */
FLASH_BANK_COMMAND_HANDLER(dsp5680xx_flash_bank_command)
{
	bank->base = HFM_FLASH_BASE_ADDR;
	bank->size = HFM_SIZE_BYTES; /* top 4k not accessible */
	bank->num_sectors = HFM_SECTOR_COUNT;
	dsp5680xx_build_sector_list(bank);

	return ERROR_OK;
}

/**
 * A memory mapped register (PROT) holds information regarding sector protection.
 * Protection refers to undesired core access.
 * The value in this register is loaded from flash upon reset.
 *
 * @param bank
 *
 * @return
 */
static int dsp5680xx_flash_protect_check(struct flash_bank *bank)
{
	int retval = ERROR_OK;

	uint16_t protected = 0;

	retval = dsp5680xx_f_protect_check(bank->target, &protected);
	if (retval != ERROR_OK) {
		for (int i = 0; i < HFM_SECTOR_COUNT; i++)
			bank->sectors[i].is_protected = -1;
		return ERROR_OK;
	}
	for (int i = 0; i < HFM_SECTOR_COUNT / 2; i++) {
		if (protected & 1) {
			bank->sectors[2 * i].is_protected = 1;
			bank->sectors[2 * i + 1].is_protected = 1;
		} else {
			bank->sectors[2 * i].is_protected = 0;
			bank->sectors[2 * i + 1].is_protected = 0;
		}
		protected = (protected >> 1);
	}
	return retval;
}

/**
 * Protection functionality is not implemented.
 * The current implementation applies/removes security on the chip.
 * The chip is effectively secured/unsecured after the first reset
 * following the execution of this function.
 *
 * @param bank
 * @param set Apply or remove security on the chip.
 * @param first This parameter is ignored.
 * @param last This parameter is ignored.
 *
 * @return
 */
static int dsp5680xx_flash_protect(struct flash_bank *bank, int set,
		unsigned int first, unsigned int last)
{
/**
 * This applies security to flash module after next reset, it does
 * not actually apply protection (protection refers to undesired access from the core)
 */
	int retval;

	if (set)
		retval = dsp5680xx_f_lock(bank->target);
	else
		retval = dsp5680xx_f_unlock(bank->target);

	return retval;
}

/**
 * The dsp5680xx use word addressing. The "/2" that appear in the following code
 * are a workaround for the fact that OpenOCD uses byte addressing.
 *
 * @param bank
 * @param buffer Data to write to flash.
 * @param offset
 * @param count In bytes (2 bytes per address).
 *
 * @return
 */
static int dsp5680xx_flash_write(struct flash_bank *bank, const uint8_t *buffer,
				 uint32_t offset, uint32_t count)
{
	if ((offset + count / 2) > bank->size) {
		LOG_ERROR("%s: Flash bank cannot fit data.", __func__);
		return ERROR_FAIL;
	}
	if (offset % 2) {
		/**
		 * Writing to odd addresses not supported.
		 * This chip uses word addressing, Openocd only supports byte addressing.
		 * The workaround results in disabling writing to odd byte addresses
		 */
		LOG_ERROR("%s: Writing to odd addresses not supported for this target", __func__);
		return ERROR_FAIL;
	}
	return dsp5680xx_f_wr(bank->target, buffer, bank->base + offset / 2, count, 0);
}

static int dsp5680xx_probe(struct flash_bank *bank)
{
	LOG_DEBUG("%s not implemented", __func__);
	return ERROR_OK;
}

/**
 * The flash module (FM) on the dsp5680xx supports both individual sector
 * and mass erase of the flash memory.
 * If this function is called with @a first == @a last == 0 or if @a first is the
 * first sector (#0) and @a last is the last sector then the mass erase command
 * is executed (much faster than erasing each sector individually).
 *
 * @param bank
 * @param first
 * @param last
 *
 * @return
 */
static int dsp5680xx_flash_erase(struct flash_bank *bank, unsigned int first,
		unsigned int last)
{
	return dsp5680xx_f_erase(bank->target, (uint32_t) first, (uint32_t) last);
}

/**
 * The flash module (FM) on the dsp5680xx support a blank check function.
 * This function executes the FM's blank check functionality on each and every sector.
 *
 * @param bank
 *
 * @return
 */
static int dsp5680xx_flash_erase_check(struct flash_bank *bank)
{
	int retval = ERROR_OK;

	uint8_t erased = 0;

	uint32_t i;

	for (i = 0; i < HFM_SECTOR_COUNT; i++) {
		retval = dsp5680xx_f_erase_check(bank->target, &erased, i);
		if (retval != ERROR_OK) {
			bank->sectors[i].is_erased = -1;
		} else {
			if (erased)
				bank->sectors[i].is_erased = 1;
			else
				bank->sectors[i].is_erased = 0;
		}
	}
	return retval;
}

const struct flash_driver dsp5680xx_flash = {
	.name = "dsp5680xx_flash",
	.flash_bank_command = dsp5680xx_flash_bank_command,
	.erase = dsp5680xx_flash_erase,
	.protect = dsp5680xx_flash_protect,
	.write = dsp5680xx_flash_write,
	/* .read = default_flash_read, */
	.probe = dsp5680xx_probe,
	.auto_probe = dsp5680xx_probe,
	.erase_check = dsp5680xx_flash_erase_check,
	.protect_check = dsp5680xx_flash_protect_check,
};