- split fileio handling into fileio part and image handling
[openocd.git] / src / flash / cfi.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 CFI_H
21 #define CFI_H
22
23 #include "flash.h"
24 #include "target.h"
25
26 typedef struct cfi_flash_bank_s
27 {
28 struct target_s *target;
29 working_area_t *write_algorithm;
30 working_area_t *erase_check_algorithm;
31
32 int x16_as_x8;
33 int jedec_probe;
34 int not_cfi;
35
36 u16 manufacturer;
37 u16 device_id;
38
39 char qry[3];
40
41 /* identification string */
42 u16 pri_id;
43 u16 pri_addr;
44 u16 alt_id;
45 u16 alt_addr;
46
47 /* device-system interface */
48 u8 vcc_min;
49 u8 vcc_max;
50 u8 vpp_min;
51 u8 vpp_max;
52 u8 word_write_timeout_typ;
53 u8 buf_write_timeout_typ;
54 u8 block_erase_timeout_typ;
55 u8 chip_erase_timeout_typ;
56 u8 word_write_timeout_max;
57 u8 buf_write_timeout_max;
58 u8 block_erase_timeout_max;
59 u8 chip_erase_timeout_max;
60
61 /* flash geometry */
62 u8 dev_size;
63 u16 interface_desc;
64 u16 max_buf_write_size;
65 u8 num_erase_regions;
66 u32 *erase_region_info;
67
68 void *pri_ext;
69 void *alt_ext;
70 } cfi_flash_bank_t;
71
72 /* Intel primary extended query table
73 * as defined for the Advanced+ Boot Block Flash Memory (C3)
74 * and used by the linux kernel cfi driver (as of 2.6.14)
75 */
76 typedef struct cfi_intel_pri_ext_s
77 {
78 char pri[3];
79 u8 major_version;
80 u8 minor_version;
81 u32 feature_support;
82 u8 suspend_cmd_support;
83 u16 blk_status_reg_mask;
84 u8 vcc_optimal;
85 u8 vpp_optimal;
86 u8 num_protection_fields;
87 u16 prot_reg_addr;
88 u8 fact_prot_reg_size;
89 u8 user_prot_reg_size;
90 u8 extra[0];
91 } cfi_intel_pri_ext_t;
92
93 /* Spansion primary extended query table as defined for and used by
94 * the linux kernel cfi driver (as of 2.6.15)
95 */
96 typedef struct cfi_spansion_pri_ext_s
97 {
98 u8 pri[3];
99 u8 major_version;
100 u8 minor_version;
101 u8 SiliconRevision; /* bits 1-0: Address Sensitive Unlock */
102 u8 EraseSuspend;
103 u8 BlkProt;
104 u8 TmpBlkUnprotect;
105 u8 BlkProtUnprot;
106 u8 SimultaneousOps;
107 u8 BurstMode;
108 u8 PageMode;
109 u8 VppMin;
110 u8 VppMax;
111 u8 TopBottom;
112 int _reversed_geometry;
113 u32 _unlock1;
114 u32 _unlock2;
115 } cfi_spansion_pri_ext_t;
116
117 /* Atmel primary extended query table as defined for and used by
118 * the linux kernel cfi driver (as of 2.6.20+)
119 */
120 typedef struct cfi_atmel_pri_ext_s
121 {
122 u8 pri[3];
123 u8 major_version;
124 u8 minor_version;
125 u8 features;
126 u8 bottom_boot;
127 u8 burst_mode;
128 u8 page_mode;
129 } cfi_atmel_pri_ext_t;
130
131 enum {
132 CFI_UNLOCK_555_2AA,
133 CFI_UNLOCK_5555_2AAA,
134 };
135
136 typedef struct cfi_unlock_addresses_s
137 {
138 u32 unlock1;
139 u32 unlock2;
140 } cfi_unlock_addresses_t;
141
142 typedef struct cfi_fixup_s
143 {
144 u16 mfr;
145 u16 id;
146 void (*fixup)(flash_bank_t *flash, void *param);
147 void *param;
148 } cfi_fixup_t;
149
150 #define CFI_MFR_AMD 0x0001
151 #define CFI_MFR_ATMEL 0x001F
152 #define CFI_MFR_ST 0x0020 /* STMicroelectronics */
153 #define CFI_MFR_SST 0x00BF
154
155 #define CFI_MFR_ANY 0xffff
156 #define CFI_ID_ANY 0xffff
157
158 #endif /* CFI_H */