0cd1f196265a119065f6af3e6b6235d12cd514db
[fw/openocd] / src / flash / str9x.h
1 /***************************************************************************
2  *   Copyright (C) 2005 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
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, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
19  ***************************************************************************/
20 #ifndef STR9X_H
21 #define STR9X_H
22
23 #include "flash.h"
24 #include "target.h"
25
26 typedef struct str9x_flash_bank_s
27 {
28         struct target_s *target;
29         u32 *sector_bits;
30         working_area_t *write_algorithm;
31 } str9x_flash_bank_t;
32
33 enum str9x_status_codes
34 {
35         STR9X_CMD_SUCCESS = 0,
36         STR9X_INVALID_COMMAND = 1,
37         STR9X_SRC_ADDR_ERROR = 2,
38         STR9X_DST_ADDR_ERROR = 3,
39         STR9X_SRC_ADDR_NOT_MAPPED = 4,
40         STR9X_DST_ADDR_NOT_MAPPED = 5,
41         STR9X_COUNT_ERROR = 6,
42         STR9X_INVALID_SECTOR = 7,
43         STR9X_SECTOR_NOT_BLANK = 8,
44         STR9X_SECTOR_NOT_PREPARED = 9,
45         STR9X_COMPARE_ERROR = 10,
46         STR9X_BUSY = 11
47 };
48
49 /* FMI sectors */
50
51 #define FMI_BANK_0      (0x5400000C << 2)                       /* FMI Bank 0 */
52 #define FMI_BANK_1      (0x54000010 << 2)                       /* FMI Bank 1 */
53
54 #define FMI_B0S0        (0x00000000 + FMI_BANK_0)       /* Bank 0 sector 0 */
55 #define FMI_B0S1        (0x00010000 + FMI_BANK_0)       /* Bank 0 sector 1 */
56 #define FMI_B0S2        (0x00020000 + FMI_BANK_0)       /* Bank 0 sector 2 */
57 #define FMI_B0S3        (0x00030000 + FMI_BANK_0)       /* Bank 0 sector 3 */
58 #define FMI_B0S4        (0x00040000 + FMI_BANK_0)       /* Bank 0 sector 4 */
59 #define FMI_B0S5        (0x00050000 + FMI_BANK_0)       /* Bank 0 sector 5 */
60 #define FMI_B0S6        (0x00060000 + FMI_BANK_0)       /* Bank 0 sector 6 */
61 #define FMI_B0S7        (0x00070000 + FMI_BANK_0)       /* Bank 0 sector 7 */
62
63 #define FMI_B1S0        (0x00000000 + FMI_BANK_1)       /* Bank 1 sector 0 */
64 #define FMI_B1S1        (0x00002000 + FMI_BANK_1)       /* Bank 1 sector 1 */
65 #define FMI_B1S2        (0x00004000 + FMI_BANK_1)       /* Bank 1 sector 2 */
66 #define FMI_B1S3        (0x00006000 + FMI_BANK_1)       /* Bank 1 sector 3 */
67
68 /*  Flash registers */
69
70 #define FLASH_BBSR              0x54000000              /* Boot Bank Size Register                */
71 #define FLASH_NBBSR             0x54000004              /* Non-Boot Bank Size Register            */
72 #define FLASH_BBADR             0x5400000C              /* Boot Bank Base Address Register        */
73 #define FLASH_NBBADR    0x54000010              /* Non-Boot Bank Base Address Register    */
74 #define FLASH_CR                0x54000018              /* Control Register                       */
75 #define FLASH_SR                0x5400001C              /* Status Register                        */
76 #define FLASH_BCE5ADDR  0x54000020              /* BC Fifth Entry Target Address Register */
77
78 typedef struct str9x_mem_layout_s {
79         u32 sector_start;
80         u32 sector_size;
81         u32 sector_bit;
82 } str9x_mem_layout_t;
83
84 #endif /* STR9X_H */
85