ade7297a4ff7a7fb39c45dc494933534464ace72
[fw/openocd] / 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
25 /**
26  * Adds a new NOR bank to the global list of banks.
27  * @params bank The bank that should be added.
28  */
29 void flash_bank_add(struct flash_bank *bank);
30
31 /**
32  * @return The first bank in the global list.
33  */
34 struct flash_bank *flash_bank_list(void);
35
36 int flash_driver_erase(struct flash_bank *bank, int first, int last);
37 int flash_driver_protect(struct flash_bank *bank, int set, int first, int last);
38 int flash_driver_write(struct flash_bank *bank,
39                 uint8_t *buffer, uint32_t offset, uint32_t count);
40
41 /* write (optional verify) an image to flash memory of the given target */
42 int flash_write_unlock(struct target *target, struct image *image,
43                 uint32_t *written, int erase, bool unlock);
44
45 #endif // FLASH_NOR_IMP_H