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, write to the *
22 * Free Software Foundation, Inc., *
23 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
24 ***************************************************************************/
27 * @file dsp5680xx_flash.c
28 * @author Rodrigo L. Rosa <rodrigorosa.LG@gmail.com>
29 * @date Thu Jun 9 18:21:58 2011
31 * @brief This file implements the basic functions to run flashing commands
32 * from the TCL interface.
33 * It allows the user to flash the Freescale 5680xx DSP.
43 #ifndef DSP5680XX_FLASH_H
44 #define DSP5680XX_FLASH_H
47 #include <helper/binarybuffer.h>
48 #include <helper/time_support.h>
49 #include <target/algorithm.h>
50 #include <target/dsp5680xx.h>
52 struct dsp5680xx_flash_bank {
53 struct working_area *write_algorithm;
56 static int dsp5680xx_build_sector_list(struct flash_bank *bank){
57 uint32_t offset = HFM_FLASH_BASE_ADDR;
58 bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
60 for (i = 0; i < bank->num_sectors; ++i){
61 bank->sectors[i].offset = i*HFM_SECTOR_SIZE;
62 bank->sectors[i].size = HFM_SECTOR_SIZE;
63 offset += bank->sectors[i].size;
64 bank->sectors[i].is_erased = -1;
65 bank->sectors[i].is_protected = -1;
67 LOG_USER("%s not tested yet.",__FUNCTION__);
72 // flash bank dsp5680xx 0 0 0 0 <target#>
73 FLASH_BANK_COMMAND_HANDLER(dsp5680xx_flash_bank_command){
74 struct dsp5680xx_flash_bank *nbank;
76 nbank = malloc(sizeof(struct dsp5680xx_flash_bank));
78 bank->base = HFM_FLASH_BASE_ADDR;
79 bank->size = HFM_SIZE_BYTES; // top 4k not accessible
80 bank->driver_priv = nbank;
81 bank->num_sectors = HFM_SECTOR_COUNT;
82 dsp5680xx_build_sector_list(bank);
88 * A memory mapped register (PROT) holds information regarding sector protection.
89 * Protection refers to undesired core access.
90 * The value in this register is loaded from flash upon reset.
96 static int dsp5680xx_flash_protect_check(struct flash_bank *bank){
97 int retval = ERROR_OK;
98 uint16_t protected = 0;
99 retval = dsp5680xx_f_protect_check(bank->target,&protected);
100 if(retval != ERROR_OK){
101 for(int i = 0;i<HFM_SECTOR_COUNT;i++)
102 bank->sectors[i].is_protected = -1;
105 for(int i = 0;i<HFM_SECTOR_COUNT/2;i++){
107 bank->sectors[2*i].is_protected = 1;
108 bank->sectors[2*i+1].is_protected = 1;
110 bank->sectors[2*i].is_protected = 0;
111 bank->sectors[2*i+1].is_protected = 0;
113 protected = (protected >> 1);
119 * Protection funcionality is not implemented.
120 * The current implementation applies/removes security on the chip.
121 * The chip is effectively secured/unsecured after the first reset following the execution of this function.
124 * @param set Apply or remove security on the chip.
125 * @param first This parameter is ignored.
126 * @param last This parameter is ignored.
130 static int dsp5680xx_flash_protect(struct flash_bank *bank, int set, int first, int last){
131 // This applies security to flash module after next reset, it does not actually apply protection (protection refers to undesired access from the core)
134 retval = dsp5680xx_f_lock(bank->target);
136 retval = dsp5680xx_f_unlock(bank->target);
141 * The dsp5680xx use word addressing. The "/2" that appear in the following code are a workaround for the fact that OpenOCD uses byte addressing.
144 * @param buffer Data to write to flash.
146 * @param count In bytes (2 bytes per address).
150 static int dsp5680xx_flash_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count){
152 if((offset + count/2)>bank->size){
153 LOG_ERROR("%s: Flash bank cannot fit data.",__FUNCTION__);
157 LOG_ERROR("%s: 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.",__FUNCTION__);
160 retval = dsp5680xx_f_wr(bank->target, buffer, bank->base + offset/2, count, 0);
162 for(addr_word = bank->base + offset/2;addr_word<count/2;addr_word+=(HFM_SECTOR_SIZE/2)){
163 if(retval == ERROR_OK)
164 bank->sectors[addr_word/(HFM_SECTOR_SIZE/2)].is_erased = 0;
166 bank->sectors[addr_word/(HFM_SECTOR_SIZE/2)].is_erased = -1;
171 static int dsp5680xx_probe(struct flash_bank *bank){
172 LOG_DEBUG("%s not implemented",__FUNCTION__);
176 static int dsp5680xx_flash_info(struct flash_bank *bank, char *buf, int buf_size){
177 snprintf(buf, buf_size, "\ndsp5680xx flash driver info:\n - Currently only full erase/lock/unlock are implemented. \n - Call with bank==0 and sector 0 to 0.\n - Protect requires arp_init-reset to complete. \n - Before removing protection the master tap must be selected, and arp_init-reset is required to complete unlocking.");
182 * The flash module (FM) on the dsp5680xx supports both individual sector and mass erase of the flash memory.
183 * If this function is called with @first == @last == 0 or if @first is the first sector (#0) and @last is the last sector then the mass erase command is executed (much faster than erasing each sector individually).
191 static int dsp5680xx_flash_erase(struct flash_bank * bank, int first, int last){
193 retval = dsp5680xx_f_erase(bank->target, (uint32_t) first, (uint32_t) last);
194 if(retval == ERROR_OK)
195 for(int i = first;i<=last;i++)
196 bank->sectors[i].is_erased = 1;
198 // If an error occurred unknown status is set even though some sector could have been correctly erased.
199 for(int i = first;i<=last;i++)
200 bank->sectors[i].is_erased = -1;
205 * The flash module (FM) on the dsp5680xx support a blank check function.
206 * This function executes the FM's blank check functionality on each and every sector.
212 static int dsp5680xx_flash_erase_check(struct flash_bank * bank){
213 int retval = ERROR_OK;
216 for(i=0;i<HFM_SECTOR_COUNT;i++){
217 if(bank->sectors[i].is_erased == -1){
218 retval = dsp5680xx_f_erase_check(bank->target,&erased,i);
219 if (retval != ERROR_OK){
220 bank->sectors[i].is_erased = -1;
223 bank->sectors[i].is_erased = 1;
225 bank->sectors[i].is_erased = 0;
232 struct flash_driver dsp5680xx_flash = {
233 .name = "dsp5680xx_flash",
234 .flash_bank_command = dsp5680xx_flash_bank_command,
235 .erase = dsp5680xx_flash_erase,
236 .protect = dsp5680xx_flash_protect,
237 .write = dsp5680xx_flash_write,
238 //.read = default_flash_read,
239 .probe = dsp5680xx_probe,
240 .auto_probe = dsp5680xx_probe,
241 .erase_check = dsp5680xx_flash_erase_check,
242 .protect_check = dsp5680xx_flash_protect_check,
243 .info = dsp5680xx_flash_info
245 #endif // dsp5680xx_flash.h