29adecfae794eb5543173057eee375662db12738
[fw/openocd] / src / flash / nor / str9x.h
1 /***************************************************************************
2  *   Copyright (C) 2005 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   Copyright (C) 2008 by Spencer Oliver                                  *
6  *   spen@spen-soft.co.uk                                                  *
7  *                                                                         *
8  *   This program is free software; you can redistribute it and/or modify  *
9  *   it under the terms of the GNU General Public License as published by  *
10  *   the Free Software Foundation; either version 2 of the License, or     *
11  *   (at your option) any later version.                                   *
12  *                                                                         *
13  *   This program is distributed in the hope that it will be useful,       *
14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
16  *   GNU General Public License for more details.                          *
17  *                                                                         *
18  *   You should have received a copy of the GNU General Public License     *
19  *   along with this program; if not, write to the                         *
20  *   Free Software Foundation, Inc.,                                       *
21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
22  ***************************************************************************/
23 #ifndef STR9X_H
24 #define STR9X_H
25
26 #include <flash/flash.h>
27
28 struct str9x_flash_bank
29 {
30         uint32_t *sector_bits;
31         int variant;
32         int bank1;
33         struct working_area *write_algorithm;
34 };
35
36 enum str9x_status_codes
37 {
38         STR9X_CMD_SUCCESS = 0,
39         STR9X_INVALID_COMMAND = 1,
40         STR9X_SRC_ADDR_ERROR = 2,
41         STR9X_DST_ADDR_ERROR = 3,
42         STR9X_SRC_ADDR_NOT_MAPPED = 4,
43         STR9X_DST_ADDR_NOT_MAPPED = 5,
44         STR9X_COUNT_ERROR = 6,
45         STR9X_INVALID_SECTOR = 7,
46         STR9X_SECTOR_NOT_BLANK = 8,
47         STR9X_SECTOR_NOT_PREPARED = 9,
48         STR9X_COMPARE_ERROR = 10,
49         STR9X_BUSY = 11
50 };
51
52 /* Flash registers */
53
54 #define FLASH_BBSR              0x54000000              /* Boot Bank Size Register                */
55 #define FLASH_NBBSR             0x54000004              /* Non-Boot Bank Size Register            */
56 #define FLASH_BBADR             0x5400000C              /* Boot Bank Base Address Register        */
57 #define FLASH_NBBADR    0x54000010              /* Non-Boot Bank Base Address Register    */
58 #define FLASH_CR                0x54000018              /* Control Register                       */
59 #define FLASH_SR                0x5400001C              /* Status Register                        */
60 #define FLASH_BCE5ADDR  0x54000020              /* BC Fifth Entry Target Address Register */
61
62 #endif /* STR9X_H */