src/flash/nor/dsp5680xx_flash.c

   1 /***************************************************************************
   2  *   Copyright (C) 2011 by Rodrigo L. Rosa                                 *
   3  *   rodrigorosa.LG@gmail.com                                              *
   4  *                                                                         *
   5  *   Based on a file written by:                                           *
   6  *   Kevin McGuire                                                         *
   7  *   Marcel Wijlaars                                                       *
   8  *   Michael Ashton                                                        *
   9  *                                                                         *
  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.                                   *
  14  *                                                                         *
  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.                          *
  19  *                                                                         *
  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  ***************************************************************************/
  25
  26 #ifdef HAVE_CONFIG_H
  27 #include "config.h"
  28 #endif
  29
  30 #ifndef DSP5680XX_FLASH_H
  31 #define DSP5680XX_FLASH_H
  32
  33 #include "imp.h"
  34 #include <helper/binarybuffer.h>
  35 #include <helper/time_support.h>
  36 #include <target/algorithm.h>
  37 #include <target/dsp5680xx.h>
  38
  39 struct dsp5680xx_flash_bank {
  40         struct working_area *write_algorithm;
  41 };
  42
  43 static int dsp5680xx_build_sector_list(struct flash_bank *bank){
  44   uint32_t offset = HFM_FLASH_BASE_ADDR;
  45   bank->sectors = malloc(sizeof(struct flash_sector) * bank->num_sectors);
  46   int i;
  47   for (i = 0; i < bank->num_sectors; ++i){
  48     bank->sectors[i].offset = i*HFM_SECTOR_SIZE;
  49     bank->sectors[i].size = HFM_SECTOR_SIZE;
  50     offset += bank->sectors[i].size;
  51     bank->sectors[i].is_erased = -1;
  52     bank->sectors[i].is_protected = -1;
  53   }
  54   LOG_USER("%s not tested yet.",__FUNCTION__);
  55   return ERROR_OK;
  56
  57 }
  58
  59 // flash bank dsp5680xx 0 0 0 0 <target#>
  60 FLASH_BANK_COMMAND_HANDLER(dsp5680xx_flash_bank_command){
  61   struct dsp5680xx_flash_bank *nbank;
  62
  63   nbank = malloc(sizeof(struct dsp5680xx_flash_bank));
  64
  65   bank->base = HFM_FLASH_BASE_ADDR;
  66   bank->size = HFM_SIZE_BYTES; // top 4k not accessible
  67   bank->driver_priv = nbank;
  68   bank->num_sectors = HFM_SECTOR_COUNT;
  69   dsp5680xx_build_sector_list(bank);
  70
  71   return ERROR_OK;
  72 }
  73
  74 static int dsp5680xx_flash_protect_check(struct flash_bank *bank){
  75   int retval = ERROR_OK;
  76   uint16_t protected = 0;
  77     retval = dsp5680xx_f_protect_check(bank->target,&protected);
  78   if(retval != ERROR_OK){
  79     for(int i = 0;i<HFM_SECTOR_COUNT;i++)
  80       bank->sectors[i].is_protected = -1;
  81     return ERROR_OK;
  82   }
  83   for(int i = 0;i<HFM_SECTOR_COUNT/2;i++){
  84     if(protected & 1){
  85       bank->sectors[2*i].is_protected = 1;
  86       bank->sectors[2*i+1].is_protected = 1;
  87     }else{
  88       bank->sectors[2*i].is_protected = 0;
  89       bank->sectors[2*i+1].is_protected = 0;
  90     }
  91     protected = (protected >> 1);
  92   }
  93   return retval;
  94 }
  95
  96 static int dsp5680xx_flash_protect(struct flash_bank *bank, int set, int first, int last){
  97   // This applies security to flash module after next reset, it does not actually apply protection (protection refers to undesired access from the core)
  98   int retval;
  99   if(set){
 100     retval = dsp5680xx_f_lock(bank->target);
 101     if(retval == ERROR_OK){
 102       for(int i = first;i<last;i++)
 103         bank->sectors[i].is_protected = 1;
 104     }
 105   }else{
 106     retval = dsp5680xx_f_unlock(bank->target);
 107     if(retval == ERROR_OK)
 108       for(int i = first;i<last;i++)
 109         bank->sectors[i].is_protected = 0;
 110   }
 111   return retval;
 112 }
 113
 114 /*
 115 static int dsp5680xx_write_block(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count){
 116   LOG_USER("%s not implemented",__FUNCTION__);
 117   return ERROR_OK;
 118 }
 119
 120 static int dsp5680xx_write_single(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count){
 121   LOG_USER("%s not implemented",__FUNCTION__);
 122   return ERROR_OK;
 123 }
 124 */
 125
 126 //-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
 127 //-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
 128 //  Flash stuff test
 129 //-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
 130 //-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
 131
 132 static int dsp5680xx_flash_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count){
 133   int retval;
 134   if((offset + count/2)>bank->size){
 135     LOG_ERROR("%s: Flash bank cannot fit data.",__FUNCTION__);
 136     return ERROR_FAIL;
 137   }
 138   if(offset%2){
 139     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__);
 140     return ERROR_FAIL;
 141   }
 142   retval = dsp5680xx_f_wr(bank->target,  buffer, bank->base + offset/2,  count);
 143   if(retval == ERROR_OK)
 144     bank->sectors[0].is_erased = 0;
 145   else
 146     bank->sectors[0].is_erased = -1;
 147   return retval;
 148 }
 149
 150 static int dsp5680xx_probe(struct flash_bank *bank){
 151   LOG_DEBUG("%s not implemented",__FUNCTION__);
 152   return ERROR_OK;
 153 }
 154
 155 static int dsp5680xx_flash_info(struct flash_bank *bank, char *buf, int buf_size){
 156         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.");
 157         return ERROR_OK;
 158 }
 159 /*
 160 static int dsp5680xx_set_write_enable(struct target *target, int enable){
 161         LOG_USER("%s not implemented",__FUNCTION__);
 162         return ERROR_OK;
 163 }
 164
 165
 166 static int dsp5680xx_check_flash_completion(struct target* target, unsigned int timeout_ms){
 167   LOG_USER("%s not implemented",__FUNCTION__);
 168   return ERROR_OK;
 169 }
 170 */
 171
 172 static int dsp5680xx_flash_erase(struct flash_bank * bank, int first, int last){
 173   int retval;
 174   retval = dsp5680xx_f_erase(bank->target, (uint32_t) first, (uint32_t) last);
 175   if(retval == ERROR_OK)
 176     for(int i = first;i<=last;i++)
 177       bank->sectors[i].is_erased = 1;
 178   else
 179         // If an error occurred unknown status is set even though some sector could have been correctly erased.
 180     for(int i = first;i<=last;i++)
 181       bank->sectors[i].is_erased = -1;
 182   return retval;
 183 }
 184
 185 static int dsp5680xx_flash_erase_check(struct flash_bank * bank){
 186   int retval = ERROR_OK;
 187   uint8_t erased = 0;
 188   uint32_t i;
 189   for(i=0;i<HFM_SECTOR_COUNT;i++){
 190     if(bank->sectors[i].is_erased == -1){
 191       retval = dsp5680xx_f_erase_check(bank->target,&erased,i);
 192     if (retval != ERROR_OK){
 193         bank->sectors[i].is_erased = -1;
 194     }else{
 195       if(erased)
 196         bank->sectors[i].is_erased = 1;
 197       else
 198         bank->sectors[i].is_erased = 0;
 199       }
 200     }
 201   }
 202   return retval;
 203 }
 204
 205 struct flash_driver dsp5680xx_flash = {
 206   .name = "dsp5680xx_flash",
 207   .flash_bank_command = dsp5680xx_flash_bank_command,
 208   .erase = dsp5680xx_flash_erase,
 209   .protect = dsp5680xx_flash_protect,
 210   .write = dsp5680xx_flash_write,
 211   //.read = default_flash_read,
 212   .probe = dsp5680xx_probe,
 213   .auto_probe = dsp5680xx_probe,
 214   .erase_check = dsp5680xx_flash_erase_check,
 215   .protect_check = dsp5680xx_flash_protect_check,
 216   .info = dsp5680xx_flash_info
 217 };
 218 #endif // dsp5680xx_flash.h