[J-u-boot.git] / include / mmc.h

/*
 * Copyright 2008,2010 Freescale Semiconductor, Inc
 * Andy Fleming
 *
 * Based (loosely) on the Linux code
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 */

#ifndef _MMC_H_
#define _MMC_H_

#include <linux/list.h>
#include <linux/compiler.h>

#define SD_VERSION_SD	0x20000
#define SD_VERSION_3	(SD_VERSION_SD | 0x300)
#define SD_VERSION_2	(SD_VERSION_SD | 0x200)
#define SD_VERSION_1_0	(SD_VERSION_SD | 0x100)
#define SD_VERSION_1_10	(SD_VERSION_SD | 0x10a)
#define MMC_VERSION_MMC		0x10000
#define MMC_VERSION_UNKNOWN	(MMC_VERSION_MMC)
#define MMC_VERSION_1_2		(MMC_VERSION_MMC | 0x102)
#define MMC_VERSION_1_4		(MMC_VERSION_MMC | 0x104)
#define MMC_VERSION_2_2		(MMC_VERSION_MMC | 0x202)
#define MMC_VERSION_3		(MMC_VERSION_MMC | 0x300)
#define MMC_VERSION_4		(MMC_VERSION_MMC | 0x400)
#define MMC_VERSION_4_1		(MMC_VERSION_MMC | 0x401)
#define MMC_VERSION_4_2		(MMC_VERSION_MMC | 0x402)
#define MMC_VERSION_4_3		(MMC_VERSION_MMC | 0x403)
#define MMC_VERSION_4_41	(MMC_VERSION_MMC | 0x429)
#define MMC_VERSION_4_5		(MMC_VERSION_MMC | 0x405)

#define MMC_MODE_HS		0x001
#define MMC_MODE_HS_52MHz	0x010
#define MMC_MODE_4BIT		0x100
#define MMC_MODE_8BIT		0x200
#define MMC_MODE_SPI		0x400
#define MMC_MODE_HC		0x800

#define MMC_MODE_MASK_WIDTH_BITS (MMC_MODE_4BIT | MMC_MODE_8BIT)
#define MMC_MODE_WIDTH_BITS_SHIFT 8

#define SD_DATA_4BIT	0x00040000

#define IS_SD(x) (x->version & SD_VERSION_SD)

#define MMC_DATA_READ		1
#define MMC_DATA_WRITE		2

#define NO_CARD_ERR		-16 /* No SD/MMC card inserted */
#define UNUSABLE_ERR		-17 /* Unusable Card */
#define COMM_ERR		-18 /* Communications Error */
#define TIMEOUT			-19
#define IN_PROGRESS		-20 /* operation is in progress */

#define MMC_CMD_GO_IDLE_STATE		0
#define MMC_CMD_SEND_OP_COND		1
#define MMC_CMD_ALL_SEND_CID		2
#define MMC_CMD_SET_RELATIVE_ADDR	3
#define MMC_CMD_SET_DSR			4
#define MMC_CMD_SWITCH			6
#define MMC_CMD_SELECT_CARD		7
#define MMC_CMD_SEND_EXT_CSD		8
#define MMC_CMD_SEND_CSD		9
#define MMC_CMD_SEND_CID		10
#define MMC_CMD_STOP_TRANSMISSION	12
#define MMC_CMD_SEND_STATUS		13
#define MMC_CMD_SET_BLOCKLEN		16
#define MMC_CMD_READ_SINGLE_BLOCK	17
#define MMC_CMD_READ_MULTIPLE_BLOCK	18
#define MMC_CMD_WRITE_SINGLE_BLOCK	24
#define MMC_CMD_WRITE_MULTIPLE_BLOCK	25
#define MMC_CMD_ERASE_GROUP_START	35
#define MMC_CMD_ERASE_GROUP_END		36
#define MMC_CMD_ERASE			38
#define MMC_CMD_APP_CMD			55
#define MMC_CMD_SPI_READ_OCR		58
#define MMC_CMD_SPI_CRC_ON_OFF		59

#define SD_CMD_SEND_RELATIVE_ADDR	3
#define SD_CMD_SWITCH_FUNC		6
#define SD_CMD_SEND_IF_COND		8

#define SD_CMD_APP_SET_BUS_WIDTH	6
#define SD_CMD_ERASE_WR_BLK_START	32
#define SD_CMD_ERASE_WR_BLK_END		33
#define SD_CMD_APP_SEND_OP_COND		41
#define SD_CMD_APP_SEND_SCR		51

/* SCR definitions in different words */
#define SD_HIGHSPEED_BUSY	0x00020000
#define SD_HIGHSPEED_SUPPORTED	0x00020000

#define MMC_HS_TIMING		0x00000100
#define MMC_HS_52MHZ		0x2

#define OCR_BUSY		0x80000000
#define OCR_HCS			0x40000000
#define OCR_VOLTAGE_MASK	0x007FFF80
#define OCR_ACCESS_MODE		0x60000000

#define SECURE_ERASE		0x80000000

#define MMC_STATUS_MASK		(~0x0206BF7F)
#define MMC_STATUS_RDY_FOR_DATA (1 << 8)
#define MMC_STATUS_CURR_STATE	(0xf << 9)
#define MMC_STATUS_ERROR	(1 << 19)

#define MMC_STATE_PRG		(7 << 9)

#define MMC_VDD_165_195		0x00000080	/* VDD voltage 1.65 - 1.95 */
#define MMC_VDD_20_21		0x00000100	/* VDD voltage 2.0 ~ 2.1 */
#define MMC_VDD_21_22		0x00000200	/* VDD voltage 2.1 ~ 2.2 */
#define MMC_VDD_22_23		0x00000400	/* VDD voltage 2.2 ~ 2.3 */
#define MMC_VDD_23_24		0x00000800	/* VDD voltage 2.3 ~ 2.4 */
#define MMC_VDD_24_25		0x00001000	/* VDD voltage 2.4 ~ 2.5 */
#define MMC_VDD_25_26		0x00002000	/* VDD voltage 2.5 ~ 2.6 */
#define MMC_VDD_26_27		0x00004000	/* VDD voltage 2.6 ~ 2.7 */
#define MMC_VDD_27_28		0x00008000	/* VDD voltage 2.7 ~ 2.8 */
#define MMC_VDD_28_29		0x00010000	/* VDD voltage 2.8 ~ 2.9 */
#define MMC_VDD_29_30		0x00020000	/* VDD voltage 2.9 ~ 3.0 */
#define MMC_VDD_30_31		0x00040000	/* VDD voltage 3.0 ~ 3.1 */
#define MMC_VDD_31_32		0x00080000	/* VDD voltage 3.1 ~ 3.2 */
#define MMC_VDD_32_33		0x00100000	/* VDD voltage 3.2 ~ 3.3 */
#define MMC_VDD_33_34		0x00200000	/* VDD voltage 3.3 ~ 3.4 */
#define MMC_VDD_34_35		0x00400000	/* VDD voltage 3.4 ~ 3.5 */
#define MMC_VDD_35_36		0x00800000	/* VDD voltage 3.5 ~ 3.6 */

#define MMC_SWITCH_MODE_CMD_SET		0x00 /* Change the command set */
#define MMC_SWITCH_MODE_SET_BITS	0x01 /* Set bits in EXT_CSD byte
						addressed by index which are
						1 in value field */
#define MMC_SWITCH_MODE_CLEAR_BITS	0x02 /* Clear bits in EXT_CSD byte
						addressed by index, which are
						1 in value field */
#define MMC_SWITCH_MODE_WRITE_BYTE	0x03 /* Set target byte to value */

#define SD_SWITCH_CHECK		0
#define SD_SWITCH_SWITCH	1

/*
 * EXT_CSD fields
 */
#define EXT_CSD_PARTITIONING_SUPPORT	160	/* RO */
#define EXT_CSD_ERASE_GROUP_DEF		175	/* R/W */
#define EXT_CSD_PART_CONF		179	/* R/W */
#define EXT_CSD_BUS_WIDTH		183	/* R/W */
#define EXT_CSD_HS_TIMING		185	/* R/W */
#define EXT_CSD_REV			192	/* RO */
#define EXT_CSD_CARD_TYPE		196	/* RO */
#define EXT_CSD_SEC_CNT			212	/* RO, 4 bytes */
#define EXT_CSD_HC_ERASE_GRP_SIZE	224	/* RO */
#define EXT_CSD_BOOT_MULT		226	/* RO */

/*
 * EXT_CSD field definitions
 */

#define EXT_CSD_CMD_SET_NORMAL		(1 << 0)
#define EXT_CSD_CMD_SET_SECURE		(1 << 1)
#define EXT_CSD_CMD_SET_CPSECURE	(1 << 2)

#define EXT_CSD_CARD_TYPE_26	(1 << 0)	/* Card can run at 26MHz */
#define EXT_CSD_CARD_TYPE_52	(1 << 1)	/* Card can run at 52MHz */

#define EXT_CSD_BUS_WIDTH_1	0	/* Card is in 1 bit mode */
#define EXT_CSD_BUS_WIDTH_4	1	/* Card is in 4 bit mode */
#define EXT_CSD_BUS_WIDTH_8	2	/* Card is in 8 bit mode */

#define R1_ILLEGAL_COMMAND		(1 << 22)
#define R1_APP_CMD			(1 << 5)

#define MMC_RSP_PRESENT (1 << 0)
#define MMC_RSP_136	(1 << 1)		/* 136 bit response */
#define MMC_RSP_CRC	(1 << 2)		/* expect valid crc */
#define MMC_RSP_BUSY	(1 << 3)		/* card may send busy */
#define MMC_RSP_OPCODE	(1 << 4)		/* response contains opcode */

#define MMC_RSP_NONE	(0)
#define MMC_RSP_R1	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
#define MMC_RSP_R1b	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE| \
			MMC_RSP_BUSY)
#define MMC_RSP_R2	(MMC_RSP_PRESENT|MMC_RSP_136|MMC_RSP_CRC)
#define MMC_RSP_R3	(MMC_RSP_PRESENT)
#define MMC_RSP_R4	(MMC_RSP_PRESENT)
#define MMC_RSP_R5	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
#define MMC_RSP_R6	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)
#define MMC_RSP_R7	(MMC_RSP_PRESENT|MMC_RSP_CRC|MMC_RSP_OPCODE)

#define MMCPART_NOAVAILABLE	(0xff)
#define PART_ACCESS_MASK	(0x7)
#define PART_SUPPORT		(0x1)

/* Maximum block size for MMC */
#define MMC_MAX_BLOCK_LEN	512

struct mmc_cid {
	unsigned long psn;
	unsigned short oid;
	unsigned char mid;
	unsigned char prv;
	unsigned char mdt;
	char pnm[7];
};

struct mmc_cmd {
	ushort cmdidx;
	uint resp_type;
	uint cmdarg;
	uint response[4];
};

struct mmc_data {
	union {
		char *dest;
		const char *src; /* src buffers don't get written to */
	};
	uint flags;
	uint blocks;
	uint blocksize;
};

struct mmc {
	struct list_head link;
	char name[32];
	void *priv;
	uint voltages;
	uint version;
	uint has_init;
	uint f_min;
	uint f_max;
	int high_capacity;
	uint bus_width;
	uint clock;
	uint card_caps;
	uint host_caps;
	uint ocr;
	uint scr[2];
	uint csd[4];
	uint cid[4];
	ushort rca;
	char part_config;
	char part_num;
	uint tran_speed;
	uint read_bl_len;
	uint write_bl_len;
	uint erase_grp_size;
	u64 capacity;
	block_dev_desc_t block_dev;
	int (*send_cmd)(struct mmc *mmc,
			struct mmc_cmd *cmd, struct mmc_data *data);
	void (*set_ios)(struct mmc *mmc);
	int (*init)(struct mmc *mmc);
	int (*getcd)(struct mmc *mmc);
	int (*getwp)(struct mmc *mmc);
	uint b_max;
	char op_cond_pending;	/* 1 if we are waiting on an op_cond command */
	char init_in_progress;	/* 1 if we have done mmc_start_init() */
	char preinit;		/* start init as early as possible */
	uint op_cond_response;	/* the response byte from the last op_cond */
};

int mmc_register(struct mmc *mmc);
int mmc_initialize(bd_t *bis);
int mmc_init(struct mmc *mmc);
int mmc_read(struct mmc *mmc, u64 src, uchar *dst, int size);
void mmc_set_clock(struct mmc *mmc, uint clock);
struct mmc *find_mmc_device(int dev_num);
int mmc_set_dev(int dev_num);
void print_mmc_devices(char separator);
int get_mmc_num(void);
int board_mmc_getcd(struct mmc *mmc);
int mmc_switch_part(int dev_num, unsigned int part_num);
int mmc_getcd(struct mmc *mmc);
int mmc_getwp(struct mmc *mmc);
void spl_mmc_load(void) __noreturn;

/**
 * Start device initialization and return immediately; it does not block on
 * polling OCR (operation condition register) status.  Then you should call
 * mmc_init, which would block on polling OCR status and complete the device
 * initializatin.
 *
 * @param mmc	Pointer to a MMC device struct
 * @return 0 on success, IN_PROGRESS on waiting for OCR status, <0 on error.
 */
int mmc_start_init(struct mmc *mmc);

/**
 * Set preinit flag of mmc device.
 *
 * This will cause the device to be pre-inited during mmc_initialize(),
 * which may save boot time if the device is not accessed until later.
 * Some eMMC devices take 200-300ms to init, but unfortunately they
 * must be sent a series of commands to even get them to start preparing
 * for operation.
 *
 * @param mmc		Pointer to a MMC device struct
 * @param preinit	preinit flag value
 */
void mmc_set_preinit(struct mmc *mmc, int preinit);

#ifdef CONFIG_GENERIC_MMC
#define mmc_host_is_spi(mmc)	((mmc)->host_caps & MMC_MODE_SPI)
struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);
#else
int mmc_legacy_init(int verbose);
#endif

#endif /* _MMC_H_ */
Commit	Line	Data
71f95118	1	/*
4a6ee172	2	* Copyright 2008,2010 Freescale Semiconductor, Inc
272cc70b AF	3	* Andy Fleming
	4	*
	5	* Based (loosely) on the Linux code
71f95118 WD	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
abe2c93f	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
71f95118 WD	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_
71f95118	28
272cc70b	29	#include <linux/list.h>
0d986e61	30	#include <linux/compiler.h>
272cc70b AF	31
272cc70b AF	32	#define SD_VERSION_SD 0x20000
1741c64d	33	#define SD_VERSION_3 (SD_VERSION_SD \| 0x300)
64f4a619 JC	34	#define SD_VERSION_2 (SD_VERSION_SD \| 0x200)
	35	#define SD_VERSION_1_0 (SD_VERSION_SD \| 0x100)
	36	#define SD_VERSION_1_10 (SD_VERSION_SD \| 0x10a)
272cc70b AF	37	#define MMC_VERSION_MMC 0x10000
272cc70b AF	38	#define MMC_VERSION_UNKNOWN (MMC_VERSION_MMC)
64f4a619 JC	39	#define MMC_VERSION_1_2 (MMC_VERSION_MMC \| 0x102)
	40	#define MMC_VERSION_1_4 (MMC_VERSION_MMC \| 0x104)
	41	#define MMC_VERSION_2_2 (MMC_VERSION_MMC \| 0x202)
	42	#define MMC_VERSION_3 (MMC_VERSION_MMC \| 0x300)
	43	#define MMC_VERSION_4 (MMC_VERSION_MMC \| 0x400)
	44	#define MMC_VERSION_4_1 (MMC_VERSION_MMC \| 0x401)
	45	#define MMC_VERSION_4_2 (MMC_VERSION_MMC \| 0x402)
	46	#define MMC_VERSION_4_3 (MMC_VERSION_MMC \| 0x403)
	47	#define MMC_VERSION_4_41 (MMC_VERSION_MMC \| 0x429)
	48	#define MMC_VERSION_4_5 (MMC_VERSION_MMC \| 0x405)
272cc70b AF	49
	50	#define MMC_MODE_HS 0x001
	51	#define MMC_MODE_HS_52MHz 0x010
	52	#define MMC_MODE_4BIT 0x100
	53	#define MMC_MODE_8BIT 0x200
d52ebf10	54	#define MMC_MODE_SPI 0x400
b1f1e821	55	#define MMC_MODE_HC 0x800
272cc70b	56
62722036 ŁM	57	#define MMC_MODE_MASK_WIDTH_BITS (MMC_MODE_4BIT \| MMC_MODE_8BIT)
	58	#define MMC_MODE_WIDTH_BITS_SHIFT 8
	59
272cc70b AF	60	#define SD_DATA_4BIT 0x00040000
272cc70b AF	61
79b91de9	62	#define IS_SD(x) (x->version & SD_VERSION_SD)
272cc70b AF	63
	64	#define MMC_DATA_READ 1
	65	#define MMC_DATA_WRITE 2
	66
	67	#define NO_CARD_ERR -16 /* No SD/MMC card inserted */
	68	#define UNUSABLE_ERR -17 /* Unusable Card */
	69	#define COMM_ERR -18 /* Communications Error */
	70	#define TIMEOUT -19
e9550449	71	#define IN_PROGRESS -20 /* operation is in progress */
272cc70b	72
341188b9 HS	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
272cc70b	78	#define MMC_CMD_SWITCH 6
341188b9	79	#define MMC_CMD_SELECT_CARD 7
272cc70b	80	#define MMC_CMD_SEND_EXT_CSD 8
341188b9 HS	81	#define MMC_CMD_SEND_CSD 9
341188b9 HS	82	#define MMC_CMD_SEND_CID 10
272cc70b	83	#define MMC_CMD_STOP_TRANSMISSION 12
341188b9 HS	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
272cc70b AF	88	#define MMC_CMD_WRITE_SINGLE_BLOCK 24
272cc70b AF	89	#define MMC_CMD_WRITE_MULTIPLE_BLOCK 25
e6f99a56 LW	90	#define MMC_CMD_ERASE_GROUP_START 35
	91	#define MMC_CMD_ERASE_GROUP_END 36
	92	#define MMC_CMD_ERASE 38
341188b9	93	#define MMC_CMD_APP_CMD 55
d52ebf10 TC	94	#define MMC_CMD_SPI_READ_OCR 58
d52ebf10 TC	95	#define MMC_CMD_SPI_CRC_ON_OFF 59
341188b9	96
341188b9	97	#define SD_CMD_SEND_RELATIVE_ADDR 3
272cc70b	98	#define SD_CMD_SWITCH_FUNC 6
341188b9 HS	99	#define SD_CMD_SEND_IF_COND 8
	100
	101	#define SD_CMD_APP_SET_BUS_WIDTH 6
e6f99a56 LW	102	#define SD_CMD_ERASE_WR_BLK_START 32
e6f99a56 LW	103	#define SD_CMD_ERASE_WR_BLK_END 33
341188b9	104	#define SD_CMD_APP_SEND_OP_COND 41
272cc70b AF	105	#define SD_CMD_APP_SEND_SCR 51
	106
	107	/* SCR definitions in different words */
	108	#define SD_HIGHSPEED_BUSY 0x00020000
	109	#define SD_HIGHSPEED_SUPPORTED 0x00020000
	110
	111	#define MMC_HS_TIMING 0x00000100
	112	#define MMC_HS_52MHZ 0x2
	113
abe2c93f TC	114	#define OCR_BUSY 0x80000000
abe2c93f TC	115	#define OCR_HCS 0x40000000
31cacbab RR	116	#define OCR_VOLTAGE_MASK 0x007FFF80
31cacbab RR	117	#define OCR_ACCESS_MODE 0x60000000
272cc70b	118
e6f99a56 LW	119	#define SECURE_ERASE 0x80000000
e6f99a56 LW	120
5d4fc8d9	121	#define MMC_STATUS_MASK (~0x0206BF7F)
abe2c93f TC	122	#define MMC_STATUS_RDY_FOR_DATA (1 << 8)
abe2c93f TC	123	#define MMC_STATUS_CURR_STATE (0xf << 9)
ed018b21	124	#define MMC_STATUS_ERROR (1 << 19)
5d4fc8d9	125
d617c426 JK	126	#define MMC_STATE_PRG (7 << 9)
d617c426 JK	127
272cc70b AF	128	#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
	129	#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
	130	#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
	131	#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
	132	#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
	133	#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
	134	#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
	135	#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
	136	#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
	137	#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
	138	#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
	139	#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
	140	#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
	141	#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
	142	#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
	143	#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
	144	#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
	145
	146	#define MMC_SWITCH_MODE_CMD_SET 0x00 /* Change the command set */
	147	#define MMC_SWITCH_MODE_SET_BITS 0x01 /* Set bits in EXT_CSD byte
	148	addressed by index which are
	149	1 in value field */
	150	#define MMC_SWITCH_MODE_CLEAR_BITS 0x02 /* Clear bits in EXT_CSD byte
	151	addressed by index, which are
	152	1 in value field */
	153	#define MMC_SWITCH_MODE_WRITE_BYTE 0x03 /* Set target byte to value */
	154
	155	#define SD_SWITCH_CHECK 0
	156	#define SD_SWITCH_SWITCH 1
	157
	158	/*
	159	* EXT_CSD fields
	160	*/
0560db18 LW	161	#define EXT_CSD_PARTITIONING_SUPPORT 160 /* RO */
	162	#define EXT_CSD_ERASE_GROUP_DEF 175 /* R/W */
	163	#define EXT_CSD_PART_CONF 179 /* R/W */
	164	#define EXT_CSD_BUS_WIDTH 183 /* R/W */
	165	#define EXT_CSD_HS_TIMING 185 /* R/W */
	166	#define EXT_CSD_REV 192 /* RO */
	167	#define EXT_CSD_CARD_TYPE 196 /* RO */
	168	#define EXT_CSD_SEC_CNT 212 /* RO, 4 bytes */
	169	#define EXT_CSD_HC_ERASE_GRP_SIZE 224 /* RO */
8948ea83	170	#define EXT_CSD_BOOT_MULT 226 /* RO */
272cc70b AF	171
	172	/*
	173	* EXT_CSD field definitions
	174	*/
	175
abe2c93f TC	176	#define EXT_CSD_CMD_SET_NORMAL (1 << 0)
	177	#define EXT_CSD_CMD_SET_SECURE (1 << 1)
	178	#define EXT_CSD_CMD_SET_CPSECURE (1 << 2)
272cc70b	179
abe2c93f TC	180	#define EXT_CSD_CARD_TYPE_26 (1 << 0) /* Card can run at 26MHz */
abe2c93f TC	181	#define EXT_CSD_CARD_TYPE_52 (1 << 1) /* Card can run at 52MHz */
272cc70b AF	182
	183	#define EXT_CSD_BUS_WIDTH_1 0 /* Card is in 1 bit mode */
	184	#define EXT_CSD_BUS_WIDTH_4 1 /* Card is in 4 bit mode */
	185	#define EXT_CSD_BUS_WIDTH_8 2 /* Card is in 8 bit mode */
341188b9	186
1de97f98 AF	187	#define R1_ILLEGAL_COMMAND (1 << 22)
	188	#define R1_APP_CMD (1 << 5)
	189
272cc70b	190	#define MMC_RSP_PRESENT (1 << 0)
abe2c93f TC	191	#define MMC_RSP_136 (1 << 1) /* 136 bit response */
	192	#define MMC_RSP_CRC (1 << 2) /* expect valid crc */
	193	#define MMC_RSP_BUSY (1 << 3) /* card may send busy */
	194	#define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */
272cc70b	195
abe2c93f TC	196	#define MMC_RSP_NONE (0)
abe2c93f TC	197	#define MMC_RSP_R1 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
272cc70b AF	198	#define MMC_RSP_R1b (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE\| \
272cc70b AF	199	MMC_RSP_BUSY)
abe2c93f TC	200	#define MMC_RSP_R2 (MMC_RSP_PRESENT\|MMC_RSP_136\|MMC_RSP_CRC)
	201	#define MMC_RSP_R3 (MMC_RSP_PRESENT)
	202	#define MMC_RSP_R4 (MMC_RSP_PRESENT)
	203	#define MMC_RSP_R5 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
	204	#define MMC_RSP_R6 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
	205	#define MMC_RSP_R7 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
272cc70b	206
bc897b1d LW	207	#define MMCPART_NOAVAILABLE (0xff)
	208	#define PART_ACCESS_MASK (0x7)
	209	#define PART_SUPPORT (0x1)
71f95118	210
8bfa195e SG	211	/* Maximum block size for MMC */
	212	#define MMC_MAX_BLOCK_LEN 512
	213
1de97f98 AF	214	struct mmc_cid {
	215	unsigned long psn;
	216	unsigned short oid;
	217	unsigned char mid;
	218	unsigned char prv;
	219	unsigned char mdt;
	220	char pnm[7];
	221	};
	222
272cc70b AF	223	struct mmc_cmd {
	224	ushort cmdidx;
	225	uint resp_type;
	226	uint cmdarg;
0b453ffe	227	uint response[4];
272cc70b AF	228	};
	229
	230	struct mmc_data {
	231	union {
	232	char *dest;
	233	const char src; / src buffers don't get written to */
	234	};
	235	uint flags;
	236	uint blocks;
	237	uint blocksize;
	238	};
	239
	240	struct mmc {
	241	struct list_head link;
	242	char name[32];
	243	void *priv;
	244	uint voltages;
	245	uint version;
bc897b1d	246	uint has_init;
272cc70b AF	247	uint f_min;
	248	uint f_max;
	249	int high_capacity;
	250	uint bus_width;
	251	uint clock;
	252	uint card_caps;
	253	uint host_caps;
	254	uint ocr;
	255	uint scr[2];
	256	uint csd[4];
0b453ffe	257	uint cid[4];
272cc70b	258	ushort rca;
bc897b1d LW	259	char part_config;
bc897b1d LW	260	char part_num;
272cc70b AF	261	uint tran_speed;
	262	uint read_bl_len;
	263	uint write_bl_len;
e6f99a56	264	uint erase_grp_size;
272cc70b AF	265	u64 capacity;
	266	block_dev_desc_t block_dev;
	267	int (send_cmd)(struct mmc mmc,
	268	struct mmc_cmd cmd, struct mmc_data data);
	269	void (set_ios)(struct mmc mmc);
	270	int (init)(struct mmc mmc);
48972d90	271	int (getcd)(struct mmc mmc);
d23d8d7e	272	int (getwp)(struct mmc mmc);
57418d21	273	uint b_max;
e9550449 CLC	274	char op_cond_pending; /* 1 if we are waiting on an op_cond command */
	275	char init_in_progress; /* 1 if we have done mmc_start_init() */
	276	char preinit; /* start init as early as possible */
	277	uint op_cond_response; /* the response byte from the last op_cond */
272cc70b AF	278	};
	279
	280	int mmc_register(struct mmc *mmc);
	281	int mmc_initialize(bd_t *bis);
	282	int mmc_init(struct mmc *mmc);
	283	int mmc_read(struct mmc mmc, u64 src, uchar dst, int size);
4a6ee172	284	void mmc_set_clock(struct mmc *mmc, uint clock);
272cc70b	285	struct mmc *find_mmc_device(int dev_num);
89716964	286	int mmc_set_dev(int dev_num);
272cc70b	287	void print_mmc_devices(char separator);
ea6ebe21	288	int get_mmc_num(void);
314284b1	289	int board_mmc_getcd(struct mmc *mmc);
bc897b1d	290	int mmc_switch_part(int dev_num, unsigned int part_num);
48972d90	291	int mmc_getcd(struct mmc *mmc);
d23d8d7e	292	int mmc_getwp(struct mmc *mmc);
0d986e61	293	void spl_mmc_load(void) __noreturn;
272cc70b	294
e9550449 CLC	295	/**
	296	* Start device initialization and return immediately; it does not block on
	297	* polling OCR (operation condition register) status. Then you should call
	298	* mmc_init, which would block on polling OCR status and complete the device
	299	* initializatin.
	300	*
	301	* @param mmc Pointer to a MMC device struct
	302	* @return 0 on success, IN_PROGRESS on waiting for OCR status, <0 on error.
	303	*/
	304	int mmc_start_init(struct mmc *mmc);
	305
	306	/**
	307	* Set preinit flag of mmc device.
	308	*
	309	* This will cause the device to be pre-inited during mmc_initialize(),
	310	* which may save boot time if the device is not accessed until later.
	311	* Some eMMC devices take 200-300ms to init, but unfortunately they
	312	* must be sent a series of commands to even get them to start preparing
	313	* for operation.
	314	*
	315	* @param mmc Pointer to a MMC device struct
	316	* @param preinit preinit flag value
	317	*/
	318	void mmc_set_preinit(struct mmc *mmc, int preinit);
	319
1592ef85	320	#ifdef CONFIG_GENERIC_MMC
d52ebf10 TC	321	#define mmc_host_is_spi(mmc) ((mmc)->host_caps & MMC_MODE_SPI)
d52ebf10 TC	322	struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);
1592ef85	323	#else
272cc70b AF	324	int mmc_legacy_init(int verbose);
272cc70b AF	325	#endif
1592ef85	326
71f95118	327	#endif /* _MMC_H_ */