1 /***************************************************************************
2 * Copyright (C) 2011 by Rodrigo L. Rosa *
3 * rodrigorosa.LG@gmail.com *
5 * Based on a file written by: *
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
15 * This program is distributed in the hope that it will be useful, *
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
18 * GNU General Public License for more details. *
20 * You should have received a copy of the GNU General Public License *
21 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
22 ***************************************************************************/
25 * @file dsp5680xx_flash.c
26 * @author Rodrigo L. Rosa <rodrigorosa.LG@gmail.com>
27 * @date Thu Jun 9 18:21:58 2011
29 * @brief This file implements the basic functions to run flashing commands
30 * from the TCL interface.
31 * It allows the user to flash the Freescale 5680xx DSP.
41 #include <helper/binarybuffer.h>
42 #include <helper/time_support.h>
43 #include <target/algorithm.h>
44 #include <target/dsp5680xx.h>
46 static int dsp5680xx_build_sector_list(struct flash_bank *bank)
48 uint32_t offset = HFM_FLASH_BASE_ADDR;
50 bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
52 for (unsigned int i = 0; i < bank->num_sectors; ++i) {
53 bank->sectors[i].offset = i * HFM_SECTOR_SIZE;
54 bank->sectors[i].size = HFM_SECTOR_SIZE;
55 offset += bank->sectors[i].size;
56 bank->sectors[i].is_erased = -1;
57 bank->sectors[i].is_protected = -1;
59 LOG_USER("%s not tested yet.", __func__);
64 /* flash bank dsp5680xx 0 0 0 0 <target#> */
65 FLASH_BANK_COMMAND_HANDLER(dsp5680xx_flash_bank_command)
67 bank->base = HFM_FLASH_BASE_ADDR;
68 bank->size = HFM_SIZE_BYTES; /* top 4k not accessible */
69 bank->num_sectors = HFM_SECTOR_COUNT;
70 dsp5680xx_build_sector_list(bank);
76 * A memory mapped register (PROT) holds information regarding sector protection.
77 * Protection refers to undesired core access.
78 * The value in this register is loaded from flash upon reset.
84 static int dsp5680xx_flash_protect_check(struct flash_bank *bank)
86 int retval = ERROR_OK;
88 uint16_t protected = 0;
90 retval = dsp5680xx_f_protect_check(bank->target, &protected);
91 if (retval != ERROR_OK) {
92 for (int i = 0; i < HFM_SECTOR_COUNT; i++)
93 bank->sectors[i].is_protected = -1;
96 for (int i = 0; i < HFM_SECTOR_COUNT / 2; i++) {
98 bank->sectors[2 * i].is_protected = 1;
99 bank->sectors[2 * i + 1].is_protected = 1;
101 bank->sectors[2 * i].is_protected = 0;
102 bank->sectors[2 * i + 1].is_protected = 0;
104 protected = (protected >> 1);
110 * Protection functionality is not implemented.
111 * The current implementation applies/removes security on the chip.
112 * The chip is effectively secured/unsecured after the first reset
113 * following the execution of this function.
116 * @param set Apply or remove security on the chip.
117 * @param first This parameter is ignored.
118 * @param last This parameter is ignored.
122 static int dsp5680xx_flash_protect(struct flash_bank *bank, int set,
123 unsigned int first, unsigned int last)
126 * This applies security to flash module after next reset, it does
127 * not actually apply protection (protection refers to undesired access from the core)
132 retval = dsp5680xx_f_lock(bank->target);
134 retval = dsp5680xx_f_unlock(bank->target);
135 if (retval == ERROR_OK) {
136 /* mark all as erased */
137 for (int i = 0; i <= (HFM_SECTOR_COUNT - 1); i++)
138 /* FM does not recognize it as erased if erased via JTAG. */
139 bank->sectors[i].is_erased = 1;
146 * The dsp5680xx use word addressing. The "/2" that appear in the following code
147 * are a workaround for the fact that OpenOCD uses byte addressing.
150 * @param buffer Data to write to flash.
152 * @param count In bytes (2 bytes per address).
156 static int dsp5680xx_flash_write(struct flash_bank *bank, const uint8_t *buffer,
157 uint32_t offset, uint32_t count)
161 if ((offset + count / 2) > bank->size) {
162 LOG_ERROR("%s: Flash bank cannot fit data.", __func__);
167 * Writing to odd addresses not supported.
168 * This chip uses word addressing, Openocd only supports byte addressing.
169 * The workaround results in disabling writing to odd byte addresses
171 LOG_ERROR("%s: Writing to odd addresses not supported for this target", __func__);
174 retval = dsp5680xx_f_wr(bank->target, buffer, bank->base + offset / 2, count, 0);
177 for (addr_word = bank->base + offset / 2; addr_word < count / 2;
178 addr_word += (HFM_SECTOR_SIZE / 2)) {
179 if (retval == ERROR_OK)
180 bank->sectors[addr_word / (HFM_SECTOR_SIZE / 2)].is_erased = 0;
182 bank->sectors[addr_word / (HFM_SECTOR_SIZE / 2)].is_erased = -1;
187 static int dsp5680xx_probe(struct flash_bank *bank)
189 LOG_DEBUG("%s not implemented", __func__);
194 * The flash module (FM) on the dsp5680xx supports both individual sector
195 * and mass erase of the flash memory.
196 * If this function is called with @a first == @a last == 0 or if @a first is the
197 * first sector (#0) and @a last is the last sector then the mass erase command
198 * is executed (much faster than erasing each sector individually).
206 static int dsp5680xx_flash_erase(struct flash_bank *bank, unsigned int first,
211 retval = dsp5680xx_f_erase(bank->target, (uint32_t) first, (uint32_t) last);
212 if ((!(first | last)) || ((first == 0) && (last == (HFM_SECTOR_COUNT - 1))))
213 last = HFM_SECTOR_COUNT - 1;
214 if (retval == ERROR_OK)
215 for (unsigned int i = first; i <= last; i++)
216 bank->sectors[i].is_erased = 1;
219 * If an error occurred unknown status
220 *is set even though some sector could have been correctly erased.
222 for (unsigned int i = first; i <= last; i++)
223 bank->sectors[i].is_erased = -1;
228 * The flash module (FM) on the dsp5680xx support a blank check function.
229 * This function executes the FM's blank check functionality on each and every sector.
235 static int dsp5680xx_flash_erase_check(struct flash_bank *bank)
237 int retval = ERROR_OK;
243 for (i = 0; i < HFM_SECTOR_COUNT; i++) {
244 if (bank->sectors[i].is_erased == -1) {
245 retval = dsp5680xx_f_erase_check(bank->target, &erased, i);
246 if (retval != ERROR_OK) {
247 bank->sectors[i].is_erased = -1;
250 bank->sectors[i].is_erased = 1;
252 bank->sectors[i].is_erased = 0;
259 const struct flash_driver dsp5680xx_flash = {
260 .name = "dsp5680xx_flash",
261 .flash_bank_command = dsp5680xx_flash_bank_command,
262 .erase = dsp5680xx_flash_erase,
263 .protect = dsp5680xx_flash_protect,
264 .write = dsp5680xx_flash_write,
265 /* .read = default_flash_read, */
266 .probe = dsp5680xx_probe,
267 .auto_probe = dsp5680xx_probe,
268 .erase_check = dsp5680xx_flash_erase_check,
269 .protect_check = dsp5680xx_flash_protect_check,