src/flash/nor/virtual.c

   1 /***************************************************************************
   2  *   Copyright (C) 2010 by Spencer Oliver                                  *
   3  *   spen@spen-soft.co.uk                                                  *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  17  ***************************************************************************/
  18
  19 #ifdef HAVE_CONFIG_H
  20 #include "config.h"
  21 #endif
  22
  23 #include "imp.h"
  24
  25 static struct flash_bank *virtual_get_master_bank(struct flash_bank *bank)
  26 {
  27         struct flash_bank *master_bank;
  28
  29         master_bank = get_flash_bank_by_name_noprobe(bank->driver_priv);
  30         if (master_bank == NULL)
  31                 LOG_ERROR("master flash bank '%s' does not exist", (char *)bank->driver_priv);
  32
  33         return master_bank;
  34 }
  35
  36 static void virtual_update_bank_info(struct flash_bank *bank)
  37 {
  38         struct flash_bank *master_bank = virtual_get_master_bank(bank);
  39
  40         if (master_bank == NULL)
  41                 return;
  42
  43         /* update the info we do not have */
  44         bank->size = master_bank->size;
  45         bank->chip_width = master_bank->chip_width;
  46         bank->bus_width = master_bank->bus_width;
  47         bank->default_padded_value = master_bank->default_padded_value;
  48         bank->num_sectors = master_bank->num_sectors;
  49         bank->sectors = master_bank->sectors;
  50 }
  51
  52 FLASH_BANK_COMMAND_HANDLER(virtual_flash_bank_command)
  53 {
  54         if (CMD_ARGC < 7)
  55                 return ERROR_COMMAND_SYNTAX_ERROR;
  56
  57         /* get the master flash bank */
  58         const char *bank_name = CMD_ARGV[6];
  59         struct flash_bank *master_bank = get_flash_bank_by_name_noprobe(bank_name);
  60
  61         if (master_bank == NULL) {
  62                 LOG_ERROR("master flash bank '%s' does not exist", bank_name);
  63                 return ERROR_FLASH_OPERATION_FAILED;
  64         }
  65
  66         /* save master bank name - use this to get settings later */
  67         bank->driver_priv = strdup(bank_name);
  68
  69         return ERROR_OK;
  70 }
  71
  72 static int virtual_protect(struct flash_bank *bank, int set, int first, int last)
  73 {
  74         struct flash_bank *master_bank = virtual_get_master_bank(bank);
  75         int retval;
  76
  77         if (master_bank == NULL)
  78                 return ERROR_FLASH_OPERATION_FAILED;
  79
  80         /* call master handler */
  81         retval = master_bank->driver->protect(master_bank, set, first, last);
  82         if (retval != ERROR_OK)
  83                 return retval;
  84
  85         return ERROR_OK;
  86 }
  87
  88 static int virtual_protect_check(struct flash_bank *bank)
  89 {
  90         struct flash_bank *master_bank = virtual_get_master_bank(bank);
  91         int retval;
  92
  93         if (master_bank == NULL)
  94                 return ERROR_FLASH_OPERATION_FAILED;
  95
  96         /* call master handler */
  97         retval = master_bank->driver->protect_check(master_bank);
  98         if (retval != ERROR_OK)
  99                 return retval;
 100
 101         return ERROR_OK;
 102 }
 103
 104 static int virtual_erase(struct flash_bank *bank, int first, int last)
 105 {
 106         struct flash_bank *master_bank = virtual_get_master_bank(bank);
 107         int retval;
 108
 109         if (master_bank == NULL)
 110                 return ERROR_FLASH_OPERATION_FAILED;
 111
 112         /* call master handler */
 113         retval = master_bank->driver->erase(master_bank, first, last);
 114         if (retval != ERROR_OK)
 115                 return retval;
 116
 117         return ERROR_OK;
 118 }
 119
 120 static int virtual_write(struct flash_bank *bank, const uint8_t *buffer,
 121                 uint32_t offset, uint32_t count)
 122 {
 123         struct flash_bank *master_bank = virtual_get_master_bank(bank);
 124         int retval;
 125
 126         if (master_bank == NULL)
 127                 return ERROR_FLASH_OPERATION_FAILED;
 128
 129         /* call master handler */
 130         retval = master_bank->driver->write(master_bank, buffer, offset, count);
 131         if (retval != ERROR_OK)
 132                 return retval;
 133
 134         return ERROR_OK;
 135 }
 136
 137 static int virtual_probe(struct flash_bank *bank)
 138 {
 139         struct flash_bank *master_bank = virtual_get_master_bank(bank);
 140         int retval;
 141
 142         if (master_bank == NULL)
 143                 return ERROR_FLASH_OPERATION_FAILED;
 144
 145         /* call master handler */
 146         retval = master_bank->driver->probe(master_bank);
 147         if (retval != ERROR_OK)
 148                 return retval;
 149
 150         /* update the info we do not have */
 151         virtual_update_bank_info(bank);
 152
 153         return ERROR_OK;
 154 }
 155
 156 static int virtual_auto_probe(struct flash_bank *bank)
 157 {
 158         struct flash_bank *master_bank = virtual_get_master_bank(bank);
 159         int retval;
 160
 161         if (master_bank == NULL)
 162                 return ERROR_FLASH_OPERATION_FAILED;
 163
 164         /* call master handler */
 165         retval = master_bank->driver->auto_probe(master_bank);
 166         if (retval != ERROR_OK)
 167                 return retval;
 168
 169         /* update the info we do not have */
 170         virtual_update_bank_info(bank);
 171
 172         return ERROR_OK;
 173 }
 174
 175 static int virtual_info(struct flash_bank *bank, char *buf, int buf_size)
 176 {
 177         struct flash_bank *master_bank = virtual_get_master_bank(bank);
 178
 179         if (master_bank == NULL)
 180                 return ERROR_FLASH_OPERATION_FAILED;
 181
 182         snprintf(buf, buf_size, "%s driver for flash bank %s at 0x%8.8" PRIx32 "",
 183                         bank->driver->name, master_bank->name, master_bank->base);
 184
 185         return ERROR_OK;
 186 }
 187
 188 static int virtual_blank_check(struct flash_bank *bank)
 189 {
 190         struct flash_bank *master_bank = virtual_get_master_bank(bank);
 191         int retval;
 192
 193         if (master_bank == NULL)
 194                 return ERROR_FLASH_OPERATION_FAILED;
 195
 196         /* call master handler */
 197         retval = master_bank->driver->erase_check(master_bank);
 198         if (retval != ERROR_OK)
 199                 return retval;
 200
 201         return ERROR_OK;
 202 }
 203
 204 static int virtual_flash_read(struct flash_bank *bank,
 205                 uint8_t *buffer, uint32_t offset, uint32_t count)
 206 {
 207         struct flash_bank *master_bank = virtual_get_master_bank(bank);
 208         int retval;
 209
 210         if (master_bank == NULL)
 211                 return ERROR_FLASH_OPERATION_FAILED;
 212
 213         /* call master handler */
 214         retval = master_bank->driver->read(master_bank, buffer, offset, count);
 215         if (retval != ERROR_OK)
 216                 return retval;
 217
 218         return ERROR_OK;
 219 }
 220
 221 struct flash_driver virtual_flash = {
 222         .name = "virtual",
 223         .flash_bank_command = virtual_flash_bank_command,
 224         .erase = virtual_erase,
 225         .protect = virtual_protect,
 226         .write = virtual_write,
 227         .read = virtual_flash_read,
 228         .probe = virtual_probe,
 229         .auto_probe = virtual_auto_probe,
 230         .erase_check = virtual_blank_check,
 231         .protect_check = virtual_protect_check,
 232         .info = virtual_info,
 233 };