src/flash/nor/imp.h

   1 /***************************************************************************
   2  *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  18  ***************************************************************************/
  19 #ifndef FLASH_NOR_IMP_H
  20 #define FLASH_NOR_IMP_H
  21
  22 // this is an internal header
  23 #include "core.h"
  24 #include "driver.h"
  25 // almost all drivers will need this file
  26 #include <target/target.h>
  27
  28 /**
  29  * Adds a new NOR bank to the global list of banks.
  30  * @param bank The bank that should be added.
  31  */
  32 void flash_bank_add(struct flash_bank *bank);
  33
  34 /**
  35  * @return The first bank in the global list.
  36  */
  37 struct flash_bank *flash_bank_list(void);
  38
  39 int flash_driver_erase(struct flash_bank *bank, int first, int last);
  40 int flash_driver_protect(struct flash_bank *bank, int set, int first, int last);
  41 int flash_driver_write(struct flash_bank *bank,
  42                 uint8_t *buffer, uint32_t offset, uint32_t count);
  43 int flash_driver_read(struct flash_bank *bank,
  44                 uint8_t *buffer, uint32_t offset, uint32_t count);
  45
  46 /* write (optional verify) an image to flash memory of the given target */
  47 int flash_write_unlock(struct target *target, struct image *image,
  48                 uint32_t *written, int erase, bool unlock);
  49
  50 #endif // FLASH_NOR_IMP_H