xref: /openbmc/u-boot/include/mtd/cfi_flash.h (revision b46694df)
1 /*
2  * (C) Copyright 2009
3  * Stefan Roese, DENX Software Engineering, sr@denx.de.
4  *
5  * See file CREDITS for list of people who contributed to this
6  * project.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as
10  * published by the Free Software Foundation; either version 2 of
11  * the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21  * MA 02111-1307 USA
22  *
23  */
24 
25 #ifndef __CFI_FLASH_H__
26 #define __CFI_FLASH_H__
27 
28 #define FLASH_CMD_CFI			0x98
29 #define FLASH_CMD_READ_ID		0x90
30 #define FLASH_CMD_RESET			0xff
31 #define FLASH_CMD_BLOCK_ERASE		0x20
32 #define FLASH_CMD_ERASE_CONFIRM		0xD0
33 #define FLASH_CMD_WRITE			0x40
34 #define FLASH_CMD_PROTECT		0x60
35 #define FLASH_CMD_SETUP			0x60
36 #define FLASH_CMD_SET_CR_CONFIRM	0x03
37 #define FLASH_CMD_PROTECT_SET		0x01
38 #define FLASH_CMD_PROTECT_CLEAR		0xD0
39 #define FLASH_CMD_CLEAR_STATUS		0x50
40 #define FLASH_CMD_READ_STATUS		0x70
41 #define FLASH_CMD_WRITE_TO_BUFFER	0xE8
42 #define FLASH_CMD_WRITE_BUFFER_PROG	0xE9
43 #define FLASH_CMD_WRITE_BUFFER_CONFIRM	0xD0
44 
45 #define FLASH_STATUS_DONE		0x80
46 #define FLASH_STATUS_ESS		0x40
47 #define FLASH_STATUS_ECLBS		0x20
48 #define FLASH_STATUS_PSLBS		0x10
49 #define FLASH_STATUS_VPENS		0x08
50 #define FLASH_STATUS_PSS		0x04
51 #define FLASH_STATUS_DPS		0x02
52 #define FLASH_STATUS_R			0x01
53 #define FLASH_STATUS_PROTECT		0x01
54 
55 #define AMD_CMD_RESET			0xF0
56 #define AMD_CMD_WRITE			0xA0
57 #define AMD_CMD_ERASE_START		0x80
58 #define AMD_CMD_ERASE_SECTOR		0x30
59 #define AMD_CMD_UNLOCK_START		0xAA
60 #define AMD_CMD_UNLOCK_ACK		0x55
61 #define AMD_CMD_WRITE_TO_BUFFER		0x25
62 #define AMD_CMD_WRITE_BUFFER_CONFIRM	0x29
63 #define AMD_CMD_SET_PPB_ENTRY		0xC0
64 #define AMD_CMD_SET_PPB_EXIT_BC1	0x90
65 #define AMD_CMD_SET_PPB_EXIT_BC2	0x00
66 #define AMD_CMD_PPB_UNLOCK_BC1		0x80
67 #define AMD_CMD_PPB_UNLOCK_BC2		0x30
68 #define AMD_CMD_PPB_LOCK_BC1		0xA0
69 #define AMD_CMD_PPB_LOCK_BC2		0x00
70 
71 #define AMD_STATUS_TOGGLE		0x40
72 #define AMD_STATUS_ERROR		0x20
73 
74 #define ATM_CMD_UNLOCK_SECT		0x70
75 #define ATM_CMD_SOFTLOCK_START		0x80
76 #define ATM_CMD_LOCK_SECT		0x40
77 
78 #define FLASH_CONTINUATION_CODE		0x7F
79 
80 #define FLASH_OFFSET_MANUFACTURER_ID	0x00
81 #define FLASH_OFFSET_DEVICE_ID		0x01
82 #define FLASH_OFFSET_DEVICE_ID2		0x0E
83 #define FLASH_OFFSET_DEVICE_ID3		0x0F
84 #define FLASH_OFFSET_CFI		0x55
85 #define FLASH_OFFSET_CFI_ALT		0x555
86 #define FLASH_OFFSET_CFI_RESP		0x10
87 #define FLASH_OFFSET_PRIMARY_VENDOR	0x13
88 /* extended query table primary address */
89 #define FLASH_OFFSET_EXT_QUERY_T_P_ADDR	0x15
90 #define FLASH_OFFSET_WTOUT		0x1F
91 #define FLASH_OFFSET_WBTOUT		0x20
92 #define FLASH_OFFSET_ETOUT		0x21
93 #define FLASH_OFFSET_CETOUT		0x22
94 #define FLASH_OFFSET_WMAX_TOUT		0x23
95 #define FLASH_OFFSET_WBMAX_TOUT		0x24
96 #define FLASH_OFFSET_EMAX_TOUT		0x25
97 #define FLASH_OFFSET_CEMAX_TOUT		0x26
98 #define FLASH_OFFSET_SIZE		0x27
99 #define FLASH_OFFSET_INTERFACE		0x28
100 #define FLASH_OFFSET_BUFFER_SIZE	0x2A
101 #define FLASH_OFFSET_NUM_ERASE_REGIONS	0x2C
102 #define FLASH_OFFSET_ERASE_REGIONS	0x2D
103 #define FLASH_OFFSET_PROTECT		0x02
104 #define FLASH_OFFSET_USER_PROTECTION	0x85
105 #define FLASH_OFFSET_INTEL_PROTECTION	0x81
106 
107 #define CFI_CMDSET_NONE			0
108 #define CFI_CMDSET_INTEL_EXTENDED	1
109 #define CFI_CMDSET_AMD_STANDARD		2
110 #define CFI_CMDSET_INTEL_STANDARD	3
111 #define CFI_CMDSET_AMD_EXTENDED		4
112 #define CFI_CMDSET_MITSU_STANDARD	256
113 #define CFI_CMDSET_MITSU_EXTENDED	257
114 #define CFI_CMDSET_SST			258
115 #define CFI_CMDSET_INTEL_PROG_REGIONS	512
116 
117 #ifdef CONFIG_SYS_FLASH_CFI_AMD_RESET /* needed for STM_ID_29W320DB on UC100 */
118 # undef  FLASH_CMD_RESET
119 # define FLASH_CMD_RESET	AMD_CMD_RESET /* use AMD-Reset instead */
120 #endif
121 
122 #define NUM_ERASE_REGIONS	4 /* max. number of erase regions */
123 
124 typedef union {
125 	unsigned char c;
126 	unsigned short w;
127 	unsigned long l;
128 	unsigned long long ll;
129 } cfiword_t;
130 
131 /* CFI standard query structure */
132 /* The offsets and sizes of this packed structure members correspond
133  * to the actual layout in CFI Flash chips. Some 16- and 32-bit members
134  * are unaligned and must be accessed with explicit unaligned access macros.
135  */
136 struct cfi_qry {
137 	u8	qry[3];
138 	u16	p_id;			/* unaligned */
139 	u16	p_adr;			/* unaligned */
140 	u16	a_id;			/* unaligned */
141 	u16	a_adr;			/* unaligned */
142 	u8	vcc_min;
143 	u8	vcc_max;
144 	u8	vpp_min;
145 	u8	vpp_max;
146 	u8	word_write_timeout_typ;
147 	u8	buf_write_timeout_typ;
148 	u8	block_erase_timeout_typ;
149 	u8	chip_erase_timeout_typ;
150 	u8	word_write_timeout_max;
151 	u8	buf_write_timeout_max;
152 	u8	block_erase_timeout_max;
153 	u8	chip_erase_timeout_max;
154 	u8	dev_size;
155 	u16	interface_desc;		/* aligned */
156 	u16	max_buf_write_size;	/* aligned */
157 	u8	num_erase_regions;
158 	u32	erase_region_info[NUM_ERASE_REGIONS];	/* unaligned */
159 } __attribute__((packed));
160 
161 struct cfi_pri_hdr {
162 	u8	pri[3];
163 	u8	major_version;
164 	u8	minor_version;
165 } __attribute__((packed));
166 
167 #ifndef CONFIG_SYS_FLASH_BANKS_LIST
168 #define CONFIG_SYS_FLASH_BANKS_LIST { CONFIG_SYS_FLASH_BASE }
169 #endif
170 
171 /*
172  * CFI_MAX_FLASH_BANKS only used for flash_info struct declaration.
173  *
174  * Use CONFIG_SYS_MAX_FLASH_BANKS_DETECT if defined
175  */
176 #if defined(CONFIG_SYS_MAX_FLASH_BANKS_DETECT)
177 #define CONFIG_SYS_MAX_FLASH_BANKS	(cfi_flash_num_flash_banks)
178 #define CFI_MAX_FLASH_BANKS	CONFIG_SYS_MAX_FLASH_BANKS_DETECT
179 /* board code can update this variable before CFI detection */
180 extern int cfi_flash_num_flash_banks;
181 #else
182 #define CFI_MAX_FLASH_BANKS	CONFIG_SYS_MAX_FLASH_BANKS
183 #endif
184 
185 void flash_write_cmd(flash_info_t * info, flash_sect_t sect,
186 		     uint offset, u32 cmd);
187 
188 #endif /* __CFI_FLASH_H__ */
189