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