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