xref: /rk3399_rockchip-uboot/include/mmc.h (revision ad77484a25657c67fa9e48ed7e125617670297bf)
1 /*
2  * Copyright 2008,2010 Freescale Semiconductor, Inc
3  * Andy Fleming
4  *
5  * Based (loosely) on the Linux code
6  *
7  * SPDX-License-Identifier:	GPL-2.0+
8  */
9 
10 #ifndef _MMC_H_
11 #define _MMC_H_
12 
13 #include <linux/list.h>
14 #include <linux/sizes.h>
15 #include <linux/compiler.h>
16 #include <part.h>
17 
18 /* SD/MMC version bits; 8 flags, 8 major, 8 minor, 8 change */
19 #define SD_VERSION_SD	(1U << 31)
20 #define MMC_VERSION_MMC	(1U << 30)
21 
22 #define MAKE_SDMMC_VERSION(a, b, c)	\
23 	((((u32)(a)) << 16) | ((u32)(b) << 8) | (u32)(c))
24 #define MAKE_SD_VERSION(a, b, c)	\
25 	(SD_VERSION_SD | MAKE_SDMMC_VERSION(a, b, c))
26 #define MAKE_MMC_VERSION(a, b, c)	\
27 	(MMC_VERSION_MMC | MAKE_SDMMC_VERSION(a, b, c))
28 
29 #define EXTRACT_SDMMC_MAJOR_VERSION(x)	\
30 	(((u32)(x) >> 16) & 0xff)
31 #define EXTRACT_SDMMC_MINOR_VERSION(x)	\
32 	(((u32)(x) >> 8) & 0xff)
33 #define EXTRACT_SDMMC_CHANGE_VERSION(x)	\
34 	((u32)(x) & 0xff)
35 
36 #define SD_VERSION_3		MAKE_SD_VERSION(3, 0, 0)
37 #define SD_VERSION_2		MAKE_SD_VERSION(2, 0, 0)
38 #define SD_VERSION_1_0		MAKE_SD_VERSION(1, 0, 0)
39 #define SD_VERSION_1_10		MAKE_SD_VERSION(1, 10, 0)
40 
41 #define MMC_VERSION_UNKNOWN	MAKE_MMC_VERSION(0, 0, 0)
42 #define MMC_VERSION_1_2		MAKE_MMC_VERSION(1, 2, 0)
43 #define MMC_VERSION_1_4		MAKE_MMC_VERSION(1, 4, 0)
44 #define MMC_VERSION_2_2		MAKE_MMC_VERSION(2, 2, 0)
45 #define MMC_VERSION_3		MAKE_MMC_VERSION(3, 0, 0)
46 #define MMC_VERSION_4		MAKE_MMC_VERSION(4, 0, 0)
47 #define MMC_VERSION_4_1		MAKE_MMC_VERSION(4, 1, 0)
48 #define MMC_VERSION_4_2		MAKE_MMC_VERSION(4, 2, 0)
49 #define MMC_VERSION_4_3		MAKE_MMC_VERSION(4, 3, 0)
50 #define MMC_VERSION_4_41	MAKE_MMC_VERSION(4, 4, 1)
51 #define MMC_VERSION_4_5		MAKE_MMC_VERSION(4, 5, 0)
52 #define MMC_VERSION_5_0		MAKE_MMC_VERSION(5, 0, 0)
53 #define MMC_VERSION_5_1		MAKE_MMC_VERSION(5, 1, 0)
54 
55 #define MMC_MODE_HS		(1 << 0)
56 #define MMC_MODE_HS_52MHz	(1 << 1)
57 #define MMC_MODE_4BIT		(1 << 2)
58 #define MMC_MODE_8BIT		(1 << 3)
59 #define MMC_MODE_SPI		(1 << 4)
60 #define MMC_MODE_DDR_52MHz	(1 << 5)
61 #define MMC_MODE_HS200		(1 << 6)
62 #define MMC_MODE_HS400		(1 << 7)
63 #define MMC_MODE_HS400ES	(1 << 8)
64 
65 #define SD_DATA_4BIT	0x00040000
66 
67 #define IS_SD(x)	((x)->version & SD_VERSION_SD)
68 #define IS_MMC(x)	((x)->version & MMC_VERSION_MMC)
69 
70 #define MMC_DATA_READ		1
71 #define MMC_DATA_WRITE		2
72 
73 #define MMC_CMD_GO_IDLE_STATE		0
74 #define MMC_CMD_SEND_OP_COND		1
75 #define MMC_CMD_ALL_SEND_CID		2
76 #define MMC_CMD_SET_RELATIVE_ADDR	3
77 #define MMC_CMD_SET_DSR			4
78 #define MMC_CMD_SWITCH			6
79 #define MMC_CMD_SELECT_CARD		7
80 #define MMC_CMD_SEND_EXT_CSD		8
81 #define MMC_CMD_SEND_CSD		9
82 #define MMC_CMD_SEND_CID		10
83 #define MMC_CMD_STOP_TRANSMISSION	12
84 #define MMC_CMD_SEND_STATUS		13
85 #define MMC_CMD_SET_BLOCKLEN		16
86 #define MMC_CMD_READ_SINGLE_BLOCK	17
87 #define MMC_CMD_READ_MULTIPLE_BLOCK	18
88 #define MMC_CMD_SET_BLOCK_COUNT         23
89 #define MMC_CMD_WRITE_SINGLE_BLOCK	24
90 #define MMC_CMD_WRITE_MULTIPLE_BLOCK	25
91 #define MMC_CMD_ERASE_GROUP_START	35
92 #define MMC_CMD_ERASE_GROUP_END		36
93 #define MMC_CMD_ERASE			38
94 #define MMC_CMD_APP_CMD			55
95 #define MMC_CMD_SPI_READ_OCR		58
96 #define MMC_CMD_SPI_CRC_ON_OFF		59
97 #define MMC_CMD_RES_MAN			62
98 
99 #define MMC_CMD62_ARG1			0xefac62ec
100 #define MMC_CMD62_ARG2			0xcbaea7
101 
102 
103 #define SD_CMD_SEND_RELATIVE_ADDR	3
104 #define SD_CMD_SWITCH_FUNC		6
105 #define SD_CMD_SEND_IF_COND		8
106 #define SD_CMD_SWITCH_UHS18V		11
107 
108 #define SD_CMD_APP_SET_BUS_WIDTH	6
109 #define SD_CMD_APP_SD_STATUS		13
110 #define SD_CMD_ERASE_WR_BLK_START	32
111 #define SD_CMD_ERASE_WR_BLK_END		33
112 #define SD_CMD_APP_SEND_OP_COND		41
113 #define SD_CMD_APP_SEND_SCR		51
114 
115 /* SCR definitions in different words */
116 #define SD_HIGHSPEED_BUSY	0x00020000
117 #define SD_HIGHSPEED_SUPPORTED	0x00020000
118 
119 #define OCR_BUSY		0x80000000
120 #define OCR_HCS			0x40000000
121 #define OCR_VOLTAGE_MASK	0x007FFF80
122 #define OCR_ACCESS_MODE		0x60000000
123 
124 #define MMC_ERASE_ARG		0x00000000
125 #define MMC_SECURE_ERASE_ARG	0x80000000
126 #define MMC_TRIM_ARG		0x00000001
127 #define MMC_DISCARD_ARG		0x00000003
128 #define MMC_SECURE_TRIM1_ARG	0x80000001
129 #define MMC_SECURE_TRIM2_ARG	0x80008000
130 
131 #define MMC_STATUS_MASK		(~0x0206BF7F)
132 #define MMC_STATUS_SWITCH_ERROR	(1 << 7)
133 #define MMC_STATUS_RDY_FOR_DATA (1 << 8)
134 #define MMC_STATUS_CURR_STATE	(0xf << 9)
135 #define MMC_STATUS_ERROR	(1 << 19)
136 
137 #define MMC_STATE_PRG		(7 << 9)
138 
139 #define MMC_VDD_165_195		0x00000080	/* VDD voltage 1.65 - 1.95 */
140 #define MMC_VDD_20_21		0x00000100	/* VDD voltage 2.0 ~ 2.1 */
141 #define MMC_VDD_21_22		0x00000200	/* VDD voltage 2.1 ~ 2.2 */
142 #define MMC_VDD_22_23		0x00000400	/* VDD voltage 2.2 ~ 2.3 */
143 #define MMC_VDD_23_24		0x00000800	/* VDD voltage 2.3 ~ 2.4 */
144 #define MMC_VDD_24_25		0x00001000	/* VDD voltage 2.4 ~ 2.5 */
145 #define MMC_VDD_25_26		0x00002000	/* VDD voltage 2.5 ~ 2.6 */
146 #define MMC_VDD_26_27		0x00004000	/* VDD voltage 2.6 ~ 2.7 */
147 #define MMC_VDD_27_28		0x00008000	/* VDD voltage 2.7 ~ 2.8 */
148 #define MMC_VDD_28_29		0x00010000	/* VDD voltage 2.8 ~ 2.9 */
149 #define MMC_VDD_29_30		0x00020000	/* VDD voltage 2.9 ~ 3.0 */
150 #define MMC_VDD_30_31		0x00040000	/* VDD voltage 3.0 ~ 3.1 */
151 #define MMC_VDD_31_32		0x00080000	/* VDD voltage 3.1 ~ 3.2 */
152 #define MMC_VDD_32_33		0x00100000	/* VDD voltage 3.2 ~ 3.3 */
153 #define MMC_VDD_33_34		0x00200000	/* VDD voltage 3.3 ~ 3.4 */
154 #define MMC_VDD_34_35		0x00400000	/* VDD voltage 3.4 ~ 3.5 */
155 #define MMC_VDD_35_36		0x00800000	/* VDD voltage 3.5 ~ 3.6 */
156 
157 #define MMC_SWITCH_MODE_CMD_SET		0x00 /* Change the command set */
158 #define MMC_SWITCH_MODE_SET_BITS	0x01 /* Set bits in EXT_CSD byte
159 						addressed by index which are
160 						1 in value field */
161 #define MMC_SWITCH_MODE_CLEAR_BITS	0x02 /* Clear bits in EXT_CSD byte
162 						addressed by index, which are
163 						1 in value field */
164 #define MMC_SWITCH_MODE_WRITE_BYTE	0x03 /* Set target byte to value */
165 
166 #define SD_SWITCH_CHECK		0
167 #define SD_SWITCH_SWITCH	1
168 
169 /*
170  * EXT_CSD fields
171  */
172 #define EXT_CSD_ENH_START_ADDR		136	/* R/W */
173 #define EXT_CSD_ENH_SIZE_MULT		140	/* R/W */
174 #define EXT_CSD_GP_SIZE_MULT		143	/* R/W */
175 #define EXT_CSD_PARTITION_SETTING	155	/* R/W */
176 #define EXT_CSD_PARTITIONS_ATTRIBUTE	156	/* R/W */
177 #define EXT_CSD_MAX_ENH_SIZE_MULT	157	/* R */
178 #define EXT_CSD_PARTITIONING_SUPPORT	160	/* RO */
179 #define EXT_CSD_RST_N_FUNCTION		162	/* R/W */
180 #define EXT_CSD_BKOPS_EN		163	/* R/W & R/W/E */
181 #define EXT_CSD_WR_REL_PARAM		166	/* R */
182 #define EXT_CSD_WR_REL_SET		167	/* R/W */
183 #define EXT_CSD_RPMB_MULT		168	/* RO */
184 #define EXT_CSD_ERASE_GROUP_DEF		175	/* R/W */
185 #define EXT_CSD_BOOT_BUS_WIDTH		177
186 #define EXT_CSD_PART_CONF		179	/* R/W */
187 #define EXT_CSD_BUS_WIDTH		183	/* R/W */
188 #define EXT_CSD_STROBE_SUPPORT		184	/* RO */
189 #define EXT_CSD_HS_TIMING		185	/* R/W */
190 #define EXT_CSD_REV			192	/* RO */
191 #define EXT_CSD_CARD_TYPE		196	/* RO */
192 #define EXT_CSD_SEC_CNT			212	/* RO, 4 bytes */
193 #define EXT_CSD_HC_WP_GRP_SIZE		221	/* RO */
194 #define EXT_CSD_HC_ERASE_GRP_SIZE	224	/* RO */
195 #define EXT_CSD_BOOT_MULT		226	/* RO */
196 #define EXT_CSD_BKOPS_SUPPORT		502	/* RO */
197 
198 /*
199  * EXT_CSD field definitions
200  */
201 
202 #define EXT_CSD_CMD_SET_NORMAL		(1 << 0)
203 #define EXT_CSD_CMD_SET_SECURE		(1 << 1)
204 #define EXT_CSD_CMD_SET_CPSECURE	(1 << 2)
205 
206 #define EXT_CSD_CARD_TYPE_26	(1 << 0)	/* Card can run at 26MHz */
207 #define EXT_CSD_CARD_TYPE_52	(1 << 1)	/* Card can run at 52MHz */
208 #define EXT_CSD_CARD_TYPE_HS	(EXT_CSD_CARD_TYPE_26 | \
209 				 EXT_CSD_CARD_TYPE_52)
210 #define EXT_CSD_CARD_TYPE_HS200_1_8V	BIT(4)	/* Card can run at 200MHz */
211 #define EXT_CSD_CARD_TYPE_HS200_1_2V	BIT(5)	/* Card can run at 200MHz */
212 #define EXT_CSD_CARD_TYPE_HS200		(EXT_CSD_CARD_TYPE_HS200_1_8V | \
213 					 EXT_CSD_CARD_TYPE_HS200_1_2V)
214 #define EXT_CSD_CARD_TYPE_HS400_1_8V	BIT(6)	/* Card can run at 200MHz DDR, 1.8V */
215 #define EXT_CSD_CARD_TYPE_HS400_1_2V	BIT(7)	/* Card can run at 200MHz DDR, 1.2V */
216 #define EXT_CSD_CARD_TYPE_HS400		(EXT_CSD_CARD_TYPE_HS400_1_8V | \
217 					 EXT_CSD_CARD_TYPE_HS400_1_2V)
218 #define EXT_CSD_CARD_TYPE_HS400ES	BIT(8)	/* Card can run at HS400ES */
219 
220 #define EXT_CSD_CARD_TYPE_DDR_1_8V	(1 << 2)
221 #define EXT_CSD_CARD_TYPE_DDR_1_2V	(1 << 3)
222 #define EXT_CSD_CARD_TYPE_DDR_52	(EXT_CSD_CARD_TYPE_DDR_1_8V \
223 					| EXT_CSD_CARD_TYPE_DDR_1_2V)
224 
225 #define EXT_CSD_BUS_WIDTH_1	0	/* Card is in 1 bit mode */
226 #define EXT_CSD_BUS_WIDTH_4	1	/* Card is in 4 bit mode */
227 #define EXT_CSD_BUS_WIDTH_8	2	/* Card is in 8 bit mode */
228 #define EXT_CSD_DDR_BUS_WIDTH_4	5	/* Card is in 4 bit DDR mode */
229 #define EXT_CSD_DDR_BUS_WIDTH_8	6	/* Card is in 8 bit DDR mode */
230 
231 #define EXT_CSD_TIMING_BC	0	/* Backwards compatility */
232 #define EXT_CSD_TIMING_HS	1	/* High speed */
233 #define EXT_CSD_TIMING_HS200	2	/* HS200 */
234 #define EXT_CSD_TIMING_HS400	3	/* HS400 */
235 #define EXT_CSD_DRV_STR_SHIFT	4	/* Driver Strength shift */
236 
237 #define EXT_CSD_BOOT_ACK_ENABLE			(1 << 6)
238 #define EXT_CSD_BOOT_PARTITION_ENABLE		(1 << 3)
239 #define EXT_CSD_PARTITION_ACCESS_ENABLE		(1 << 0)
240 #define EXT_CSD_PARTITION_ACCESS_DISABLE	(0 << 0)
241 
242 #define EXT_CSD_BOOT_ACK(x)		(x << 6)
243 #define EXT_CSD_BOOT_PART_NUM(x)	(x << 3)
244 #define EXT_CSD_PARTITION_ACCESS(x)	(x << 0)
245 
246 #define EXT_CSD_EXTRACT_BOOT_ACK(x)		(((x) >> 6) & 0x1)
247 #define EXT_CSD_EXTRACT_BOOT_PART(x)		(((x) >> 3) & 0x7)
248 #define EXT_CSD_EXTRACT_PARTITION_ACCESS(x)	((x) & 0x7)
249 
250 #define EXT_CSD_BOOT_BUS_WIDTH_MODE(x)	(x << 3)
251 #define EXT_CSD_BOOT_BUS_WIDTH_RESET(x)	(x << 2)
252 #define EXT_CSD_BOOT_BUS_WIDTH_WIDTH(x)	(x)
253 
254 #define EXT_CSD_PARTITION_SETTING_COMPLETED	(1 << 0)
255 
256 #define EXT_CSD_ENH_USR		(1 << 0)	/* user data area is enhanced */
257 #define EXT_CSD_ENH_GP(x)	(1 << ((x)+1))	/* GP part (x+1) is enhanced */
258 
259 #define EXT_CSD_HS_CTRL_REL	(1 << 0)	/* host controlled WR_REL_SET */
260 
261 #define EXT_CSD_WR_DATA_REL_USR		(1 << 0)	/* user data area WR_REL */
262 #define EXT_CSD_WR_DATA_REL_GP(x)	(1 << ((x)+1))	/* GP part (x+1) WR_REL */
263 
264 #define R1_ILLEGAL_COMMAND		(1 << 22)
265 #define R1_APP_CMD			(1 << 5)
266 
267 #define MMC_RSP_PRESENT (1 << 0)
268 #define MMC_RSP_136	(1 << 1)		/* 136 bit response */
269 #define MMC_RSP_CRC	(1 << 2)		/* expect valid crc */
270 #define MMC_RSP_BUSY	(1 << 3)		/* card may send busy */
271 #define MMC_RSP_OPCODE	(1 << 4)		/* response contains opcode */
272 
273 #define MMC_RSP_NONE	(0)
274 #define MMC_RSP_R1	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
275 #define MMC_RSP_R1b	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE| \
276 			MMC_RSP_BUSY)
277 #define MMC_RSP_R2	(MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
278 #define MMC_RSP_R3	(MMC_RSP_PRESENT)
279 #define MMC_RSP_R4	(MMC_RSP_PRESENT)
280 #define MMC_RSP_R5	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
281 #define MMC_RSP_R6	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
282 #define MMC_RSP_R7	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
283 
284 #define MMCPART_NOAVAILABLE	(0xff)
285 #define PART_ACCESS_MASK	(0x7)
286 #define PART_SUPPORT		(0x1)
287 #define ENHNCD_SUPPORT		(0x2)
288 #define PART_ENH_ATTRIB		(0x1f)
289 
290 /* Maximum block size for MMC */
291 #define MMC_MAX_BLOCK_LEN	512
292 
293 /* The number of MMC physical partitions.  These consist of:
294  * boot partitions (2), general purpose partitions (4) in MMC v4.4.
295  */
296 #define MMC_NUM_BOOT_PARTITION	2
297 #define MMC_PART_RPMB           3       /* RPMB partition number */
298 
299 /* Driver model support */
300 
301 /**
302  * struct mmc_uclass_priv - Holds information about a device used by the uclass
303  */
304 struct mmc_uclass_priv {
305 	struct mmc *mmc;
306 };
307 
308 /**
309  * mmc_get_mmc_dev() - get the MMC struct pointer for a device
310  *
311  * Provided that the device is already probed and ready for use, this value
312  * will be available.
313  *
314  * @dev:	Device
315  * @return associated mmc struct pointer if available, else NULL
316  */
317 struct mmc *mmc_get_mmc_dev(struct udevice *dev);
318 
319 /* End of driver model support */
320 
321 struct mmc_cid {
322 	unsigned long psn;
323 	unsigned short oid;
324 	unsigned char mid;
325 	unsigned char prv;
326 	unsigned char mdt;
327 	char pnm[7];
328 };
329 
330 struct mmc_cmd {
331 	ushort cmdidx;
332 	uint resp_type;
333 	uint cmdarg;
334 	uint response[4];
335 };
336 
337 struct mmc_data {
338 	union {
339 		char *dest;
340 		const char *src; /* src buffers don't get written to */
341 	};
342 	uint flags;
343 	uint blocks;
344 	uint blocksize;
345 };
346 
347 /* forward decl. */
348 struct mmc;
349 
350 #if CONFIG_IS_ENABLED(DM_MMC)
351 struct dm_mmc_ops {
352 	/**
353 	 * send_cmd() - Send a command to the MMC device
354 	 *
355 	 * @dev:	Device to receive the command
356 	 * @cmd:	Command to send
357 	 * @data:	Additional data to send/receive
358 	 * @return 0 if OK, -ve on error
359 	 */
360 	int (*send_cmd)(struct udevice *dev, struct mmc_cmd *cmd,
361 			struct mmc_data *data);
362 
363 	/**
364 	 * card_busy() - Query the card device status
365 	 *
366 	 * @dev:	Device to update
367 	 * @return true if card device is busy
368 	 */
369 	bool (*card_busy)(struct udevice *dev);
370 
371 	/**
372 	 * set_ios() - Set the I/O speed/width for an MMC device
373 	 *
374 	 * @dev:	Device to update
375 	 * @return 0 if OK, -ve on error
376 	 */
377 	int (*set_ios)(struct udevice *dev);
378 
379 	/**
380 	 * get_cd() - See whether a card is present
381 	 *
382 	 * @dev:	Device to check
383 	 * @return 0 if not present, 1 if present, -ve on error
384 	 */
385 	int (*get_cd)(struct udevice *dev);
386 
387 	/**
388 	 * get_wp() - See whether a card has write-protect enabled
389 	 *
390 	 * @dev:	Device to check
391 	 * @return 0 if write-enabled, 1 if write-protected, -ve on error
392 	 */
393 	int (*get_wp)(struct udevice *dev);
394 };
395 
396 #define mmc_get_ops(dev)        ((struct dm_mmc_ops *)(dev)->driver->ops)
397 
398 int dm_mmc_send_cmd(struct udevice *dev, struct mmc_cmd *cmd,
399 		    struct mmc_data *data);
400 int dm_mmc_set_ios(struct udevice *dev);
401 int dm_mmc_get_cd(struct udevice *dev);
402 int dm_mmc_get_wp(struct udevice *dev);
403 
404 /* Transition functions for compatibility */
405 bool mmc_card_busy(struct mmc *mmc);
406 bool mmc_can_card_busy(struct mmc *mmc);
407 int mmc_set_ios(struct mmc *mmc);
408 int mmc_getcd(struct mmc *mmc);
409 int mmc_getwp(struct mmc *mmc);
410 
411 #else
412 struct mmc_ops {
413 	bool (*card_busy)(struct mmc *mmc);
414 	int (*send_cmd)(struct mmc *mmc,
415 			struct mmc_cmd *cmd, struct mmc_data *data);
416 	int (*set_ios)(struct mmc *mmc);
417 	int (*init)(struct mmc *mmc);
418 	int (*getcd)(struct mmc *mmc);
419 	int (*getwp)(struct mmc *mmc);
420 };
421 #endif
422 
423 struct mmc_config {
424 	const char *name;
425 #if !CONFIG_IS_ENABLED(DM_MMC)
426 	const struct mmc_ops *ops;
427 #endif
428 	uint host_caps;
429 	uint voltages;
430 	uint f_min;
431 	uint f_max;
432 	uint b_max;
433 	unsigned char part_type;
434 };
435 
436 struct sd_ssr {
437 	unsigned int au;		/* In sectors */
438 	unsigned int erase_timeout;	/* In milliseconds */
439 	unsigned int erase_offset;	/* In milliseconds */
440 };
441 
442 /*
443  * With CONFIG_DM_MMC enabled, struct mmc can be accessed from the MMC device
444  * with mmc_get_mmc_dev().
445  *
446  * TODO struct mmc should be in mmc_private but it's hard to fix right now
447  */
448 struct mmc {
449 #if !CONFIG_IS_ENABLED(BLK)
450 	struct list_head link;
451 #endif
452 	const struct mmc_config *cfg;	/* provided configuration */
453 	uint version;
454 	void *priv;
455 	uint has_init;
456 	int high_capacity;
457 	uint bus_width;
458 	uint timing;
459 
460 #define MMC_TIMING_LEGACY	0
461 #define MMC_TIMING_MMC_HS	1
462 #define MMC_TIMING_SD_HS	2
463 #define MMC_TIMING_UHS_SDR12	3
464 #define MMC_TIMING_UHS_SDR25	4
465 #define MMC_TIMING_UHS_SDR50	5
466 #define MMC_TIMING_UHS_SDR104	6
467 #define MMC_TIMING_UHS_DDR50	7
468 #define MMC_TIMING_MMC_DDR52	8
469 #define MMC_TIMING_MMC_HS200	9
470 #define MMC_TIMING_MMC_HS400	10
471 #define MMC_TIMING_MMC_HS400ES	11
472 
473 	uint clock;
474 	uint card_caps;
475 	uint ocr;
476 	uint dsr;
477 	uint dsr_imp;
478 	uint scr[2];
479 	uint csd[4];
480 	uint cid[4];
481 	ushort rca;
482 	u8 part_support;
483 	u8 part_attr;
484 	u8 wr_rel_set;
485 	u8 part_config;
486 	uint tran_speed;
487 	uint read_bl_len;
488 	uint write_bl_len;
489 	uint erase_grp_size;	/* in 512-byte sectors */
490 	uint hc_wp_grp_size;	/* in 512-byte sectors */
491 	struct sd_ssr	ssr;	/* SD status register */
492 	u64 capacity;
493 	u64 capacity_user;
494 	u64 capacity_boot;
495 	u64 capacity_rpmb;
496 	u64 capacity_gp[4];
497 	u64 enh_user_start;
498 	u64 enh_user_size;
499 #if !CONFIG_IS_ENABLED(BLK)
500 	struct blk_desc block_dev;
501 #endif
502 	char op_cond_pending;	/* 1 if we are waiting on an op_cond command */
503 	char init_in_progress;	/* 1 if we have done mmc_start_init() */
504 	char preinit;		/* start init as early as possible */
505 	int ddr_mode;
506 #if CONFIG_IS_ENABLED(DM_MMC)
507 	struct udevice *dev;	/* Device for this MMC controller */
508 #endif
509 };
510 
511 struct mmc_hwpart_conf {
512 	struct {
513 		uint enh_start;	/* in 512-byte sectors */
514 		uint enh_size;	/* in 512-byte sectors, if 0 no enh area */
515 		unsigned wr_rel_change : 1;
516 		unsigned wr_rel_set : 1;
517 	} user;
518 	struct {
519 		uint size;	/* in 512-byte sectors */
520 		unsigned enhanced : 1;
521 		unsigned wr_rel_change : 1;
522 		unsigned wr_rel_set : 1;
523 	} gp_part[4];
524 };
525 
526 enum mmc_hwpart_conf_mode {
527 	MMC_HWPART_CONF_CHECK,
528 	MMC_HWPART_CONF_SET,
529 	MMC_HWPART_CONF_COMPLETE,
530 };
531 
532 static inline bool mmc_card_hs(struct mmc *mmc)
533 {
534 	return (mmc->timing == MMC_TIMING_MMC_HS) ||
535 		(mmc->timing == MMC_TIMING_SD_HS);
536 }
537 
538 static inline bool mmc_card_ddr(struct mmc *mmc)
539 {
540 	return (mmc->timing == MMC_TIMING_UHS_DDR50) ||
541 		(mmc->timing == MMC_TIMING_MMC_DDR52) ||
542 		(mmc->timing == MMC_TIMING_MMC_HS400) ||
543 		(mmc->timing == MMC_TIMING_MMC_HS400ES);
544 }
545 
546 static inline bool mmc_card_hs200(struct mmc *mmc)
547 {
548 	return mmc->timing == MMC_TIMING_MMC_HS200;
549 }
550 
551 static inline bool mmc_card_ddr52(struct mmc *mmc)
552 {
553 	return mmc->timing == MMC_TIMING_MMC_DDR52;
554 }
555 
556 static inline bool mmc_card_hs400(struct mmc *mmc)
557 {
558 	return mmc->timing == MMC_TIMING_MMC_HS400;
559 }
560 
561 static inline bool mmc_card_hs400es(struct mmc *mmc)
562 {
563 	return mmc->timing == MMC_TIMING_MMC_HS400ES;
564 }
565 
566 struct mmc *mmc_create(const struct mmc_config *cfg, void *priv);
567 
568 /**
569  * mmc_bind() - Set up a new MMC device ready for probing
570  *
571  * A child block device is bound with the IF_TYPE_MMC interface type. This
572  * allows the device to be used with CONFIG_BLK
573  *
574  * @dev:	MMC device to set up
575  * @mmc:	MMC struct
576  * @cfg:	MMC configuration
577  * @return 0 if OK, -ve on error
578  */
579 int mmc_bind(struct udevice *dev, struct mmc *mmc,
580 	     const struct mmc_config *cfg);
581 void mmc_destroy(struct mmc *mmc);
582 
583 /**
584  * mmc_unbind() - Unbind a MMC device's child block device
585  *
586  * @dev:	MMC device
587  * @return 0 if OK, -ve on error
588  */
589 int mmc_unbind(struct udevice *dev);
590 int mmc_initialize(bd_t *bis);
591 int mmc_init(struct mmc *mmc);
592 int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
593 void mmc_set_clock(struct mmc *mmc, uint clock);
594 struct mmc *find_mmc_device(int dev_num);
595 int mmc_set_dev(int dev_num);
596 void print_mmc_devices(char separator);
597 
598 /**
599  * get_mmc_num() - get the total MMC device number
600  *
601  * @return 0 if there is no MMC device, else the number of devices
602  */
603 int get_mmc_num(void);
604 int mmc_switch_part(struct mmc *mmc, unsigned int part_num);
605 int mmc_hwpart_config(struct mmc *mmc, const struct mmc_hwpart_conf *conf,
606 		      enum mmc_hwpart_conf_mode mode);
607 
608 #if !CONFIG_IS_ENABLED(DM_MMC)
609 int mmc_getcd(struct mmc *mmc);
610 int board_mmc_getcd(struct mmc *mmc);
611 int mmc_getwp(struct mmc *mmc);
612 int board_mmc_getwp(struct mmc *mmc);
613 #endif
614 
615 int mmc_set_dsr(struct mmc *mmc, u16 val);
616 /* Function to change the size of boot partition and rpmb partitions */
617 int mmc_boot_partition_size_change(struct mmc *mmc, unsigned long bootsize,
618 					unsigned long rpmbsize);
619 /* Function to modify the PARTITION_CONFIG field of EXT_CSD */
620 int mmc_set_part_conf(struct mmc *mmc, u8 ack, u8 part_num, u8 access);
621 /* Function to modify the BOOT_BUS_WIDTH field of EXT_CSD */
622 int mmc_set_boot_bus_width(struct mmc *mmc, u8 width, u8 reset, u8 mode);
623 /* Function to modify the RST_n_FUNCTION field of EXT_CSD */
624 int mmc_set_rst_n_function(struct mmc *mmc, u8 enable);
625 /* Functions to read / write the RPMB partition */
626 int mmc_rpmb_set_key(struct mmc *mmc, void *key);
627 int mmc_rpmb_get_counter(struct mmc *mmc, unsigned long *counter);
628 int mmc_rpmb_read(struct mmc *mmc, void *addr, unsigned short blk,
629 		  unsigned short cnt, unsigned char *key);
630 int mmc_rpmb_write(struct mmc *mmc, void *addr, unsigned short blk,
631 		   unsigned short cnt, unsigned char *key);
632 #ifdef CONFIG_CMD_BKOPS_ENABLE
633 int mmc_set_bkops_enable(struct mmc *mmc);
634 #endif
635 
636 /**
637  * Start device initialization and return immediately; it does not block on
638  * polling OCR (operation condition register) status.  Then you should call
639  * mmc_init, which would block on polling OCR status and complete the device
640  * initializatin.
641  *
642  * @param mmc	Pointer to a MMC device struct
643  * @return 0 on success, IN_PROGRESS on waiting for OCR status, <0 on error.
644  */
645 int mmc_start_init(struct mmc *mmc);
646 
647 /**
648  * Set preinit flag of mmc device.
649  *
650  * This will cause the device to be pre-inited during mmc_initialize(),
651  * which may save boot time if the device is not accessed until later.
652  * Some eMMC devices take 200-300ms to init, but unfortunately they
653  * must be sent a series of commands to even get them to start preparing
654  * for operation.
655  *
656  * @param mmc		Pointer to a MMC device struct
657  * @param preinit	preinit flag value
658  */
659 void mmc_set_preinit(struct mmc *mmc, int preinit);
660 
661 #ifdef CONFIG_MMC_SPI
662 #define mmc_host_is_spi(mmc)	((mmc)->cfg->host_caps & MMC_MODE_SPI)
663 #else
664 #define mmc_host_is_spi(mmc)	0
665 #endif
666 struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);
667 
668 void board_mmc_power_init(void);
669 int board_mmc_init(bd_t *bis);
670 int cpu_mmc_init(bd_t *bis);
671 int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
672 int mmc_get_env_dev(void);
673 
674 /* Set block count limit because of 16 bit register limit on some hardware*/
675 #ifndef CONFIG_SYS_MMC_MAX_BLK_COUNT
676 #define CONFIG_SYS_MMC_MAX_BLK_COUNT 65535
677 #endif
678 
679 /**
680  * mmc_get_blk_desc() - Get the block descriptor for an MMC device
681  *
682  * @mmc:	MMC device
683  * @return block device if found, else NULL
684  */
685 struct blk_desc *mmc_get_blk_desc(struct mmc *mmc);
686 
687 #endif /* _MMC_H_ */
688