xref: /rk3399_rockchip-uboot/include/mmc.h (revision 5d4fc8d907ed12844b9c9190601fef2919f3ec25)
1 /*
2  * Copyright 2008,2010 Freescale Semiconductor, Inc
3  * Andy Fleming
4  *
5  * Based (loosely) on the Linux code
6  *
7  * See file CREDITS for list of people who contributed to this
8  * project.
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License as
12  * published by the Free Software Foundation; either version 2 of
13  * the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
23  * MA 02111-1307 USA
24  */
25 
26 #ifndef _MMC_H_
27 #define _MMC_H_
28 
29 #include <linux/list.h>
30 
31 #define SD_VERSION_SD	0x20000
32 #define SD_VERSION_2	(SD_VERSION_SD | 0x20)
33 #define SD_VERSION_1_0	(SD_VERSION_SD | 0x10)
34 #define SD_VERSION_1_10	(SD_VERSION_SD | 0x1a)
35 #define MMC_VERSION_MMC		0x10000
36 #define MMC_VERSION_UNKNOWN	(MMC_VERSION_MMC)
37 #define MMC_VERSION_1_2		(MMC_VERSION_MMC | 0x12)
38 #define MMC_VERSION_1_4		(MMC_VERSION_MMC | 0x14)
39 #define MMC_VERSION_2_2		(MMC_VERSION_MMC | 0x22)
40 #define MMC_VERSION_3		(MMC_VERSION_MMC | 0x30)
41 #define MMC_VERSION_4		(MMC_VERSION_MMC | 0x40)
42 
43 #define MMC_MODE_HS		0x001
44 #define MMC_MODE_HS_52MHz	0x010
45 #define MMC_MODE_4BIT		0x100
46 #define MMC_MODE_8BIT		0x200
47 #define MMC_MODE_SPI		0x400
48 
49 #define SD_DATA_4BIT	0x00040000
50 
51 #define IS_SD(x) (x->version & SD_VERSION_SD)
52 
53 #define MMC_DATA_READ		1
54 #define MMC_DATA_WRITE		2
55 
56 #define NO_CARD_ERR		-16 /* No SD/MMC card inserted */
57 #define UNUSABLE_ERR		-17 /* Unusable Card */
58 #define COMM_ERR		-18 /* Communications Error */
59 #define TIMEOUT			-19
60 
61 #define MMC_CMD_GO_IDLE_STATE		0
62 #define MMC_CMD_SEND_OP_COND		1
63 #define MMC_CMD_ALL_SEND_CID		2
64 #define MMC_CMD_SET_RELATIVE_ADDR	3
65 #define MMC_CMD_SET_DSR			4
66 #define MMC_CMD_SWITCH			6
67 #define MMC_CMD_SELECT_CARD		7
68 #define MMC_CMD_SEND_EXT_CSD		8
69 #define MMC_CMD_SEND_CSD		9
70 #define MMC_CMD_SEND_CID		10
71 #define MMC_CMD_STOP_TRANSMISSION	12
72 #define MMC_CMD_SEND_STATUS		13
73 #define MMC_CMD_SET_BLOCKLEN		16
74 #define MMC_CMD_READ_SINGLE_BLOCK	17
75 #define MMC_CMD_READ_MULTIPLE_BLOCK	18
76 #define MMC_CMD_WRITE_SINGLE_BLOCK	24
77 #define MMC_CMD_WRITE_MULTIPLE_BLOCK	25
78 #define MMC_CMD_APP_CMD			55
79 #define MMC_CMD_SPI_READ_OCR		58
80 #define MMC_CMD_SPI_CRC_ON_OFF		59
81 
82 #define SD_CMD_SEND_RELATIVE_ADDR	3
83 #define SD_CMD_SWITCH_FUNC		6
84 #define SD_CMD_SEND_IF_COND		8
85 
86 #define SD_CMD_APP_SET_BUS_WIDTH	6
87 #define SD_CMD_APP_SEND_OP_COND		41
88 #define SD_CMD_APP_SEND_SCR		51
89 
90 /* SCR definitions in different words */
91 #define SD_HIGHSPEED_BUSY	0x00020000
92 #define SD_HIGHSPEED_SUPPORTED	0x00020000
93 
94 #define MMC_HS_TIMING		0x00000100
95 #define MMC_HS_52MHZ		0x2
96 
97 #define OCR_BUSY	0x80000000
98 #define OCR_HCS		0x40000000
99 
100 #define MMC_STATUS_MASK		(~0x0206BF7F)
101 #define MMC_STATUS_RDY_FOR_DATA (1<<8)
102 #define MMC_STATUS_CURR_STATE	(0xf<<9)
103 
104 #define MMC_VDD_165_195		0x00000080	/* VDD voltage 1.65 - 1.95 */
105 #define MMC_VDD_20_21		0x00000100	/* VDD voltage 2.0 ~ 2.1 */
106 #define MMC_VDD_21_22		0x00000200	/* VDD voltage 2.1 ~ 2.2 */
107 #define MMC_VDD_22_23		0x00000400	/* VDD voltage 2.2 ~ 2.3 */
108 #define MMC_VDD_23_24		0x00000800	/* VDD voltage 2.3 ~ 2.4 */
109 #define MMC_VDD_24_25		0x00001000	/* VDD voltage 2.4 ~ 2.5 */
110 #define MMC_VDD_25_26		0x00002000	/* VDD voltage 2.5 ~ 2.6 */
111 #define MMC_VDD_26_27		0x00004000	/* VDD voltage 2.6 ~ 2.7 */
112 #define MMC_VDD_27_28		0x00008000	/* VDD voltage 2.7 ~ 2.8 */
113 #define MMC_VDD_28_29		0x00010000	/* VDD voltage 2.8 ~ 2.9 */
114 #define MMC_VDD_29_30		0x00020000	/* VDD voltage 2.9 ~ 3.0 */
115 #define MMC_VDD_30_31		0x00040000	/* VDD voltage 3.0 ~ 3.1 */
116 #define MMC_VDD_31_32		0x00080000	/* VDD voltage 3.1 ~ 3.2 */
117 #define MMC_VDD_32_33		0x00100000	/* VDD voltage 3.2 ~ 3.3 */
118 #define MMC_VDD_33_34		0x00200000	/* VDD voltage 3.3 ~ 3.4 */
119 #define MMC_VDD_34_35		0x00400000	/* VDD voltage 3.4 ~ 3.5 */
120 #define MMC_VDD_35_36		0x00800000	/* VDD voltage 3.5 ~ 3.6 */
121 
122 #define MMC_SWITCH_MODE_CMD_SET		0x00 /* Change the command set */
123 #define MMC_SWITCH_MODE_SET_BITS	0x01 /* Set bits in EXT_CSD byte
124 						addressed by index which are
125 						1 in value field */
126 #define MMC_SWITCH_MODE_CLEAR_BITS	0x02 /* Clear bits in EXT_CSD byte
127 						addressed by index, which are
128 						1 in value field */
129 #define MMC_SWITCH_MODE_WRITE_BYTE	0x03 /* Set target byte to value */
130 
131 #define SD_SWITCH_CHECK		0
132 #define SD_SWITCH_SWITCH	1
133 
134 /*
135  * EXT_CSD fields
136  */
137 
138 #define EXT_CSD_BUS_WIDTH	183	/* R/W */
139 #define EXT_CSD_HS_TIMING	185	/* R/W */
140 #define EXT_CSD_CARD_TYPE	196	/* RO */
141 #define EXT_CSD_REV		192	/* RO */
142 #define EXT_CSD_SEC_CNT		212	/* RO, 4 bytes */
143 
144 /*
145  * EXT_CSD field definitions
146  */
147 
148 #define EXT_CSD_CMD_SET_NORMAL		(1<<0)
149 #define EXT_CSD_CMD_SET_SECURE		(1<<1)
150 #define EXT_CSD_CMD_SET_CPSECURE	(1<<2)
151 
152 #define EXT_CSD_CARD_TYPE_26	(1<<0)	/* Card can run at 26MHz */
153 #define EXT_CSD_CARD_TYPE_52	(1<<1)	/* Card can run at 52MHz */
154 
155 #define EXT_CSD_BUS_WIDTH_1	0	/* Card is in 1 bit mode */
156 #define EXT_CSD_BUS_WIDTH_4	1	/* Card is in 4 bit mode */
157 #define EXT_CSD_BUS_WIDTH_8	2	/* Card is in 8 bit mode */
158 
159 #define R1_ILLEGAL_COMMAND		(1 << 22)
160 #define R1_APP_CMD			(1 << 5)
161 
162 #define MMC_RSP_PRESENT (1 << 0)
163 #define MMC_RSP_136     (1 << 1)                /* 136 bit response */
164 #define MMC_RSP_CRC     (1 << 2)                /* expect valid crc */
165 #define MMC_RSP_BUSY    (1 << 3)                /* card may send busy */
166 #define MMC_RSP_OPCODE  (1 << 4)                /* response contains opcode */
167 
168 #define MMC_RSP_NONE    (0)
169 #define MMC_RSP_R1      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
170 #define MMC_RSP_R1b	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE| \
171 			MMC_RSP_BUSY)
172 #define MMC_RSP_R2      (MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
173 #define MMC_RSP_R3      (MMC_RSP_PRESENT)
174 #define MMC_RSP_R4      (MMC_RSP_PRESENT)
175 #define MMC_RSP_R5      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
176 #define MMC_RSP_R6      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
177 #define MMC_RSP_R7      (MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
178 
179 
180 struct mmc_cid {
181 	unsigned long psn;
182 	unsigned short oid;
183 	unsigned char mid;
184 	unsigned char prv;
185 	unsigned char mdt;
186 	char pnm[7];
187 };
188 
189 /*
190  * WARNING!
191  *
192  * This structure is used by atmel_mci.c only.
193  * It works for the AVR32 architecture but NOT
194  * for ARM/AT91 architectures.
195  * Its use is highly depreciated.
196  * After the atmel_mci.c driver for AVR32 has
197  * been replaced this structure will be removed.
198  */
199 struct mmc_csd
200 {
201 	u8	csd_structure:2,
202 		spec_vers:4,
203 		rsvd1:2;
204 	u8	taac;
205 	u8	nsac;
206 	u8	tran_speed;
207 	u16	ccc:12,
208 		read_bl_len:4;
209 	u64	read_bl_partial:1,
210 		write_blk_misalign:1,
211 		read_blk_misalign:1,
212 		dsr_imp:1,
213 		rsvd2:2,
214 		c_size:12,
215 		vdd_r_curr_min:3,
216 		vdd_r_curr_max:3,
217 		vdd_w_curr_min:3,
218 		vdd_w_curr_max:3,
219 		c_size_mult:3,
220 		sector_size:5,
221 		erase_grp_size:5,
222 		wp_grp_size:5,
223 		wp_grp_enable:1,
224 		default_ecc:2,
225 		r2w_factor:3,
226 		write_bl_len:4,
227 		write_bl_partial:1,
228 		rsvd3:5;
229 	u8	file_format_grp:1,
230 		copy:1,
231 		perm_write_protect:1,
232 		tmp_write_protect:1,
233 		file_format:2,
234 		ecc:2;
235 	u8	crc:7;
236 	u8	one:1;
237 };
238 
239 struct mmc_cmd {
240 	ushort cmdidx;
241 	uint resp_type;
242 	uint cmdarg;
243 	uint response[4];
244 	uint flags;
245 };
246 
247 struct mmc_data {
248 	union {
249 		char *dest;
250 		const char *src; /* src buffers don't get written to */
251 	};
252 	uint flags;
253 	uint blocks;
254 	uint blocksize;
255 };
256 
257 struct mmc {
258 	struct list_head link;
259 	char name[32];
260 	void *priv;
261 	uint voltages;
262 	uint version;
263 	uint f_min;
264 	uint f_max;
265 	int high_capacity;
266 	uint bus_width;
267 	uint clock;
268 	uint card_caps;
269 	uint host_caps;
270 	uint ocr;
271 	uint scr[2];
272 	uint csd[4];
273 	uint cid[4];
274 	ushort rca;
275 	uint tran_speed;
276 	uint read_bl_len;
277 	uint write_bl_len;
278 	u64 capacity;
279 	block_dev_desc_t block_dev;
280 	int (*send_cmd)(struct mmc *mmc,
281 			struct mmc_cmd *cmd, struct mmc_data *data);
282 	void (*set_ios)(struct mmc *mmc);
283 	int (*init)(struct mmc *mmc);
284 #ifdef CONFIG_MMC_MBLOCK
285 	uint b_max;
286 #endif
287 };
288 
289 int mmc_register(struct mmc *mmc);
290 int mmc_initialize(bd_t *bis);
291 int mmc_init(struct mmc *mmc);
292 int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
293 void mmc_set_clock(struct mmc *mmc, uint clock);
294 struct mmc *find_mmc_device(int dev_num);
295 int mmc_set_dev(int dev_num);
296 void print_mmc_devices(char separator);
297 int board_mmc_getcd(u8 *cd, struct mmc *mmc);
298 
299 #ifdef CONFIG_GENERIC_MMC
300 int atmel_mci_init(void *regs);
301 #define mmc_host_is_spi(mmc)	((mmc)->host_caps & MMC_MODE_SPI)
302 struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);
303 #else
304 int mmc_legacy_init(int verbose);
305 #endif
306 
307 #endif /* _MMC_H_ */
308