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