[people/ms/u-boot.git] / include / mmc.h

/*
 * Copyright 2008,2010 Freescale Semiconductor, Inc
 * Andy Fleming
 *
 * Based (loosely) on the Linux code
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#ifndef _MMC_H_
#define _MMC_H_

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

/* SD/MMC version bits; 8 flags, 8 major, 8 minor, 8 change */
#define SD_VERSION_SD	(1U << 31)
#define MMC_VERSION_MMC	(1U << 30)

#define MAKE_SDMMC_VERSION(a, b, c)	\
	((((u32)(a)) << 16) | ((u32)(b) << 8) | (u32)(c))
#define MAKE_SD_VERSION(a, b, c)	\
	(SD_VERSION_SD | MAKE_SDMMC_VERSION(a, b, c))
#define MAKE_MMC_VERSION(a, b, c)	\
	(MMC_VERSION_MMC | MAKE_SDMMC_VERSION(a, b, c))

#define EXTRACT_SDMMC_MAJOR_VERSION(x)	\
	(((u32)(x) >> 16) & 0xff)
#define EXTRACT_SDMMC_MINOR_VERSION(x)	\
	(((u32)(x) >> 8) & 0xff)
#define EXTRACT_SDMMC_CHANGE_VERSION(x)	\
	((u32)(x) & 0xff)

#define SD_VERSION_3		MAKE_SD_VERSION(3, 0, 0)
#define SD_VERSION_2		MAKE_SD_VERSION(2, 0, 0)
#define SD_VERSION_1_0		MAKE_SD_VERSION(1, 0, 0)
#define SD_VERSION_1_10		MAKE_SD_VERSION(1, 10, 0)

#define MMC_VERSION_UNKNOWN	MAKE_MMC_VERSION(0, 0, 0)
#define MMC_VERSION_1_2		MAKE_MMC_VERSION(1, 2, 0)
#define MMC_VERSION_1_4		MAKE_MMC_VERSION(1, 4, 0)
#define MMC_VERSION_2_2		MAKE_MMC_VERSION(2, 2, 0)
#define MMC_VERSION_3		MAKE_MMC_VERSION(3, 0, 0)
#define MMC_VERSION_4		MAKE_MMC_VERSION(4, 0, 0)
#define MMC_VERSION_4_1		MAKE_MMC_VERSION(4, 1, 0)
#define MMC_VERSION_4_2		MAKE_MMC_VERSION(4, 2, 0)
#define MMC_VERSION_4_3		MAKE_MMC_VERSION(4, 3, 0)
#define MMC_VERSION_4_41	MAKE_MMC_VERSION(4, 4, 1)
#define MMC_VERSION_4_5		MAKE_MMC_VERSION(4, 5, 0)
#define MMC_VERSION_5_0		MAKE_MMC_VERSION(5, 0, 0)

#define MMC_MODE_HS		(1 << 0)
#define MMC_MODE_HS_52MHz	(1 << 1)
#define MMC_MODE_4BIT		(1 << 2)
#define MMC_MODE_8BIT		(1 << 3)
#define MMC_MODE_SPI		(1 << 4)
#define MMC_MODE_DDR_52MHz	(1 << 5)

#define SD_DATA_4BIT	0x00040000

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

#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 SWITCH_ERR		-20 /* Card reports failure to switch mode */

#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_SET_BLOCK_COUNT         23
#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 MMC_CMD_RES_MAN			62

#define MMC_CMD62_ARG1			0xefac62ec
#define MMC_CMD62_ARG2			0xcbaea7


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

#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 OCR_BUSY		0x80000000
#define OCR_HCS			0x40000000
#define OCR_VOLTAGE_MASK	0x007FFF80
#define OCR_ACCESS_MODE		0x60000000

#define MMC_ERASE_ARG		0x00000000
#define MMC_SECURE_ERASE_ARG	0x80000000
#define MMC_TRIM_ARG		0x00000001
#define MMC_DISCARD_ARG		0x00000003
#define MMC_SECURE_TRIM1_ARG	0x80000001
#define MMC_SECURE_TRIM2_ARG	0x80008000

#define MMC_STATUS_MASK		(~0x0206BF7F)
#define MMC_STATUS_SWITCH_ERROR	(1 << 7)
#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_ENH_START_ADDR		136	/* R/W */
#define EXT_CSD_ENH_SIZE_MULT		140	/* R/W */
#define EXT_CSD_GP_SIZE_MULT		143	/* R/W */
#define EXT_CSD_PARTITION_SETTING	155	/* R/W */
#define EXT_CSD_PARTITIONS_ATTRIBUTE	156	/* R/W */
#define EXT_CSD_MAX_ENH_SIZE_MULT	157	/* R */
#define EXT_CSD_PARTITIONING_SUPPORT	160	/* RO */
#define EXT_CSD_RST_N_FUNCTION		162	/* R/W */
#define EXT_CSD_WR_REL_PARAM		166	/* R */
#define EXT_CSD_WR_REL_SET		167	/* R/W */
#define EXT_CSD_RPMB_MULT		168	/* RO */
#define EXT_CSD_ERASE_GROUP_DEF		175	/* R/W */
#define EXT_CSD_BOOT_BUS_WIDTH		177
#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_WP_GRP_SIZE		221	/* RO */
#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_CARD_TYPE_DDR_1_8V	(1 << 2)
#define EXT_CSD_CARD_TYPE_DDR_1_2V	(1 << 3)
#define EXT_CSD_CARD_TYPE_DDR_52	(EXT_CSD_CARD_TYPE_DDR_1_8V \
					| EXT_CSD_CARD_TYPE_DDR_1_2V)

#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 EXT_CSD_DDR_BUS_WIDTH_4	5	/* Card is in 4 bit DDR mode */
#define EXT_CSD_DDR_BUS_WIDTH_8	6	/* Card is in 8 bit DDR mode */

#define EXT_CSD_BOOT_ACK_ENABLE			(1 << 6)
#define EXT_CSD_BOOT_PARTITION_ENABLE		(1 << 3)
#define EXT_CSD_PARTITION_ACCESS_ENABLE		(1 << 0)
#define EXT_CSD_PARTITION_ACCESS_DISABLE	(0 << 0)

#define EXT_CSD_BOOT_ACK(x)		(x << 6)
#define EXT_CSD_BOOT_PART_NUM(x)	(x << 3)
#define EXT_CSD_PARTITION_ACCESS(x)	(x << 0)

#define EXT_CSD_BOOT_BUS_WIDTH_MODE(x)	(x << 3)
#define EXT_CSD_BOOT_BUS_WIDTH_RESET(x)	(x << 2)
#define EXT_CSD_BOOT_BUS_WIDTH_WIDTH(x)	(x)

#define EXT_CSD_PARTITION_SETTING_COMPLETED	(1 << 0)

#define EXT_CSD_ENH_USR		(1 << 0)	/* user data area is enhanced */
#define EXT_CSD_ENH_GP(x)	(1 << ((x)+1))	/* GP part (x+1) is enhanced */

#define EXT_CSD_HS_CTRL_REL	(1 << 0)	/* host controlled WR_REL_SET */

#define EXT_CSD_WR_DATA_REL_USR		(1 << 0)	/* user data area WR_REL */
#define EXT_CSD_WR_DATA_REL_GP(x)	(1 << ((x)+1))	/* GP part (x+1) WR_REL */

#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)
#define ENHNCD_SUPPORT		(0x2)
#define PART_ENH_ATTRIB		(0x1f)

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

/* The number of MMC physical partitions.  These consist of:
 * boot partitions (2), general purpose partitions (4) in MMC v4.4.
 */
#define MMC_NUM_BOOT_PARTITION	2
#define MMC_PART_RPMB           3       /* RPMB partition number */

/* Driver model support */

/**
 * struct mmc_uclass_priv - Holds information about a device used by the uclass
 */
struct mmc_uclass_priv {
	struct mmc *mmc;
};

/**
 * mmc_get_mmc_dev() - get the MMC struct pointer for a device
 *
 * Provided that the device is already probed and ready for use, this value
 * will be available.
 *
 * @dev:	Device
 * @return associated mmc struct pointer if available, else NULL
 */
struct mmc *mmc_get_mmc_dev(struct udevice *dev);

/* End of driver model support */

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;
};

/* forward decl. */
struct mmc;

struct mmc_ops {
	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);
};

struct mmc_config {
	const char *name;
	const struct mmc_ops *ops;
	uint host_caps;
	uint voltages;
	uint f_min;
	uint f_max;
	uint b_max;
	unsigned char part_type;
};

/* TODO struct mmc should be in mmc_private but it's hard to fix right now */
struct mmc {
#ifndef CONFIG_BLK
	struct list_head link;
#endif
	const struct mmc_config *cfg;	/* provided configuration */
	uint version;
	void *priv;
	uint has_init;
	int high_capacity;
	uint bus_width;
	uint clock;
	uint card_caps;
	uint ocr;
	uint dsr;
	uint dsr_imp;
	uint scr[2];
	uint csd[4];
	uint cid[4];
	ushort rca;
	u8 part_support;
	u8 part_attr;
	u8 wr_rel_set;
	char part_config;
	uint tran_speed;
	uint read_bl_len;
	uint write_bl_len;
	uint erase_grp_size;	/* in 512-byte sectors */
	uint hc_wp_grp_size;	/* in 512-byte sectors */
	u64 capacity;
	u64 capacity_user;
	u64 capacity_boot;
	u64 capacity_rpmb;
	u64 capacity_gp[4];
	u64 enh_user_start;
	u64 enh_user_size;
#ifndef CONFIG_BLK
	struct blk_desc block_dev;
#endif
	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 */
	int ddr_mode;
#ifdef CONFIG_DM_MMC
	struct udevice *dev;	/* Device for this MMC controller */
#endif
};

struct mmc_hwpart_conf {
	struct {
		uint enh_start;	/* in 512-byte sectors */
		uint enh_size;	/* in 512-byte sectors, if 0 no enh area */
		unsigned wr_rel_change : 1;
		unsigned wr_rel_set : 1;
	} user;
	struct {
		uint size;	/* in 512-byte sectors */
		unsigned enhanced : 1;
		unsigned wr_rel_change : 1;
		unsigned wr_rel_set : 1;
	} gp_part[4];
};

enum mmc_hwpart_conf_mode {
	MMC_HWPART_CONF_CHECK,
	MMC_HWPART_CONF_SET,
	MMC_HWPART_CONF_COMPLETE,
};

struct mmc *mmc_create(const struct mmc_config *cfg, void *priv);

/**
 * mmc_bind() - Set up a new MMC device ready for probing
 *
 * A child block device is bound with the IF_TYPE_MMC interface type. This
 * allows the device to be used with CONFIG_BLK
 *
 * @dev:	MMC device to set up
 * @mmc:	MMC struct
 * @cfg:	MMC configuration
 * @return 0 if OK, -ve on error
 */
int mmc_bind(struct udevice *dev, struct mmc *mmc,
	     const struct mmc_config *cfg);
void mmc_destroy(struct mmc *mmc);

/**
 * mmc_unbind() - Unbind a MMC device's child block device
 *
 * @dev:	MMC device
 * @return 0 if OK, -ve on error
 */
int mmc_unbind(struct udevice *dev);
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 mmc_hwpart_config(struct mmc *mmc, const struct mmc_hwpart_conf *conf,
		      enum mmc_hwpart_conf_mode mode);
int mmc_getcd(struct mmc *mmc);
int board_mmc_getcd(struct mmc *mmc);
int mmc_getwp(struct mmc *mmc);
int board_mmc_getwp(struct mmc *mmc);
int mmc_set_dsr(struct mmc *mmc, u16 val);
/* Function to change the size of boot partition and rpmb partitions */
int mmc_boot_partition_size_change(struct mmc *mmc, unsigned long bootsize,
					unsigned long rpmbsize);
/* Function to modify the PARTITION_CONFIG field of EXT_CSD */
int mmc_set_part_conf(struct mmc *mmc, u8 ack, u8 part_num, u8 access);
/* Function to modify the BOOT_BUS_WIDTH field of EXT_CSD */
int mmc_set_boot_bus_width(struct mmc *mmc, u8 width, u8 reset, u8 mode);
/* Function to modify the RST_n_FUNCTION field of EXT_CSD */
int mmc_set_rst_n_function(struct mmc *mmc, u8 enable);
/* Functions to read / write the RPMB partition */
int mmc_rpmb_set_key(struct mmc *mmc, void *key);
int mmc_rpmb_get_counter(struct mmc *mmc, unsigned long *counter);
int mmc_rpmb_read(struct mmc *mmc, void *addr, unsigned short blk,
		  unsigned short cnt, unsigned char *key);
int mmc_rpmb_write(struct mmc *mmc, void *addr, unsigned short blk,
		   unsigned short cnt, unsigned char *key);
/**
 * 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_MMC_SPI
#define mmc_host_is_spi(mmc)	((mmc)->cfg->host_caps & MMC_MODE_SPI)
#else
#define mmc_host_is_spi(mmc)	0
#endif
struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);

void board_mmc_power_init(void);
int board_mmc_init(bd_t *bis);
int cpu_mmc_init(bd_t *bis);
int mmc_get_env_addr(struct mmc *mmc, int copy, u32 *env_addr);
int mmc_get_env_dev(void);

struct pci_device_id;

/**
 * pci_mmc_init() - set up PCI MMC devices
 *
 * This finds all the matching PCI IDs and sets them up as MMC devices.
 *
 * @name:		Name to use for devices
 * @mmc_supported:	PCI IDs to search for, terminated by {0, 0}
 */
int pci_mmc_init(const char *name, struct pci_device_id *mmc_supported);

/* Set block count limit because of 16 bit register limit on some hardware*/
#ifndef CONFIG_SYS_MMC_MAX_BLK_COUNT
#define CONFIG_SYS_MMC_MAX_BLK_COUNT 65535
#endif

/**
 * mmc_get_blk_desc() - Get the block descriptor for an MMC device
 *
 * @mmc:	MMC device
 * @return block device if found, else NULL
 */
struct blk_desc *mmc_get_blk_desc(struct mmc *mmc);

#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	6	*
1a459660	7	* SPDX-License-Identifier: GPL-2.0+
71f95118 WD	8	*/
	9
	10	#ifndef _MMC_H_
	11	#define _MMC_H_
71f95118	12
272cc70b	13	#include <linux/list.h>
0d986e61	14	#include <linux/compiler.h>
07a2d42c	15	#include <part.h>
272cc70b	16
4b7cee53 PA	17	/* SD/MMC version bits; 8 flags, 8 major, 8 minor, 8 change */
	18	#define SD_VERSION_SD (1U << 31)
	19	#define MMC_VERSION_MMC (1U << 30)
	20
	21	#define MAKE_SDMMC_VERSION(a, b, c) \
	22	((((u32)(a)) << 16) \| ((u32)(b) << 8) \| (u32)(c))
	23	#define MAKE_SD_VERSION(a, b, c) \
	24	(SD_VERSION_SD \| MAKE_SDMMC_VERSION(a, b, c))
	25	#define MAKE_MMC_VERSION(a, b, c) \
	26	(MMC_VERSION_MMC \| MAKE_SDMMC_VERSION(a, b, c))
	27
	28	#define EXTRACT_SDMMC_MAJOR_VERSION(x) \
	29	(((u32)(x) >> 16) & 0xff)
	30	#define EXTRACT_SDMMC_MINOR_VERSION(x) \
	31	(((u32)(x) >> 8) & 0xff)
	32	#define EXTRACT_SDMMC_CHANGE_VERSION(x) \
	33	((u32)(x) & 0xff)
	34
	35	#define SD_VERSION_3 MAKE_SD_VERSION(3, 0, 0)
	36	#define SD_VERSION_2 MAKE_SD_VERSION(2, 0, 0)
	37	#define SD_VERSION_1_0 MAKE_SD_VERSION(1, 0, 0)
	38	#define SD_VERSION_1_10 MAKE_SD_VERSION(1, 10, 0)
	39
	40	#define MMC_VERSION_UNKNOWN MAKE_MMC_VERSION(0, 0, 0)
	41	#define MMC_VERSION_1_2 MAKE_MMC_VERSION(1, 2, 0)
	42	#define MMC_VERSION_1_4 MAKE_MMC_VERSION(1, 4, 0)
	43	#define MMC_VERSION_2_2 MAKE_MMC_VERSION(2, 2, 0)
	44	#define MMC_VERSION_3 MAKE_MMC_VERSION(3, 0, 0)
	45	#define MMC_VERSION_4 MAKE_MMC_VERSION(4, 0, 0)
	46	#define MMC_VERSION_4_1 MAKE_MMC_VERSION(4, 1, 0)
	47	#define MMC_VERSION_4_2 MAKE_MMC_VERSION(4, 2, 0)
	48	#define MMC_VERSION_4_3 MAKE_MMC_VERSION(4, 3, 0)
	49	#define MMC_VERSION_4_41 MAKE_MMC_VERSION(4, 4, 1)
	50	#define MMC_VERSION_4_5 MAKE_MMC_VERSION(4, 5, 0)
	51	#define MMC_VERSION_5_0 MAKE_MMC_VERSION(5, 0, 0)
272cc70b	52
8caf46d1 JC	53	#define MMC_MODE_HS (1 << 0)
	54	#define MMC_MODE_HS_52MHz (1 << 1)
	55	#define MMC_MODE_4BIT (1 << 2)
	56	#define MMC_MODE_8BIT (1 << 3)
	57	#define MMC_MODE_SPI (1 << 4)
5a20397b	58	#define MMC_MODE_DDR_52MHz (1 << 5)
62722036	59
272cc70b AF	60	#define SD_DATA_4BIT 0x00040000
272cc70b AF	61
4b7cee53	62	#define IS_SD(x) ((x)->version & SD_VERSION_SD)
3f2da751	63	#define IS_MMC(x) ((x)->version & MMC_VERSION_MMC)
272cc70b AF	64
	65	#define MMC_DATA_READ 1
	66	#define MMC_DATA_WRITE 2
	67
	68	#define NO_CARD_ERR -16 /* No SD/MMC card inserted */
	69	#define UNUSABLE_ERR -17 /* Unusable Card */
	70	#define COMM_ERR -18 /* Communications Error */
	71	#define TIMEOUT -19
bd47c135	72	#define SWITCH_ERR -20 /* Card reports failure to switch mode */
272cc70b	73
341188b9 HS	74	#define MMC_CMD_GO_IDLE_STATE 0
	75	#define MMC_CMD_SEND_OP_COND 1
	76	#define MMC_CMD_ALL_SEND_CID 2
	77	#define MMC_CMD_SET_RELATIVE_ADDR 3
	78	#define MMC_CMD_SET_DSR 4
272cc70b	79	#define MMC_CMD_SWITCH 6
341188b9	80	#define MMC_CMD_SELECT_CARD 7
272cc70b	81	#define MMC_CMD_SEND_EXT_CSD 8
341188b9 HS	82	#define MMC_CMD_SEND_CSD 9
341188b9 HS	83	#define MMC_CMD_SEND_CID 10
272cc70b	84	#define MMC_CMD_STOP_TRANSMISSION 12
341188b9 HS	85	#define MMC_CMD_SEND_STATUS 13
	86	#define MMC_CMD_SET_BLOCKLEN 16
	87	#define MMC_CMD_READ_SINGLE_BLOCK 17
	88	#define MMC_CMD_READ_MULTIPLE_BLOCK 18
91fdabc6	89	#define MMC_CMD_SET_BLOCK_COUNT 23
272cc70b AF	90	#define MMC_CMD_WRITE_SINGLE_BLOCK 24
272cc70b AF	91	#define MMC_CMD_WRITE_MULTIPLE_BLOCK 25
e6f99a56 LW	92	#define MMC_CMD_ERASE_GROUP_START 35
	93	#define MMC_CMD_ERASE_GROUP_END 36
	94	#define MMC_CMD_ERASE 38
341188b9	95	#define MMC_CMD_APP_CMD 55
d52ebf10 TC	96	#define MMC_CMD_SPI_READ_OCR 58
d52ebf10 TC	97	#define MMC_CMD_SPI_CRC_ON_OFF 59
3690d6d6 A	98	#define MMC_CMD_RES_MAN 62
	99
	100	#define MMC_CMD62_ARG1 0xefac62ec
	101	#define MMC_CMD62_ARG2 0xcbaea7
	102
341188b9	103
341188b9	104	#define SD_CMD_SEND_RELATIVE_ADDR 3
272cc70b	105	#define SD_CMD_SWITCH_FUNC 6
341188b9	106	#define SD_CMD_SEND_IF_COND 8
f022d36e	107	#define SD_CMD_SWITCH_UHS18V 11
341188b9 HS	108
341188b9 HS	109	#define SD_CMD_APP_SET_BUS_WIDTH 6
e6f99a56 LW	110	#define SD_CMD_ERASE_WR_BLK_START 32
e6f99a56 LW	111	#define SD_CMD_ERASE_WR_BLK_END 33
341188b9	112	#define SD_CMD_APP_SEND_OP_COND 41
272cc70b AF	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
abe2c93f TC	119	#define OCR_BUSY 0x80000000
abe2c93f TC	120	#define OCR_HCS 0x40000000
31cacbab RR	121	#define OCR_VOLTAGE_MASK 0x007FFF80
31cacbab RR	122	#define OCR_ACCESS_MODE 0x60000000
272cc70b	123
1aa2d074 EN	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
e6f99a56	130
5d4fc8d9	131	#define MMC_STATUS_MASK (~0x0206BF7F)
6b2221b0	132	#define MMC_STATUS_SWITCH_ERROR (1 << 7)
abe2c93f TC	133	#define MMC_STATUS_RDY_FOR_DATA (1 << 8)
abe2c93f TC	134	#define MMC_STATUS_CURR_STATE (0xf << 9)
ed018b21	135	#define MMC_STATUS_ERROR (1 << 19)
5d4fc8d9	136
d617c426 JK	137	#define MMC_STATE_PRG (7 << 9)
d617c426 JK	138
272cc70b AF	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	*/
a7f852b6 DSC	172	#define EXT_CSD_ENH_START_ADDR 136 /* R/W */
a7f852b6 DSC	173	#define EXT_CSD_ENH_SIZE_MULT 140 /* R/W */
f866a46d	174	#define EXT_CSD_GP_SIZE_MULT 143 /* R/W */
d7b29129	175	#define EXT_CSD_PARTITION_SETTING 155 /* R/W */
1937e5aa	176	#define EXT_CSD_PARTITIONS_ATTRIBUTE 156 /* R/W */
ac9da0e0	177	#define EXT_CSD_MAX_ENH_SIZE_MULT 157 /* R */
0560db18	178	#define EXT_CSD_PARTITIONING_SUPPORT 160 /* RO */
33ace362	179	#define EXT_CSD_RST_N_FUNCTION 162 /* R/W */
8dda5b0e DSC	180	#define EXT_CSD_WR_REL_PARAM 166 /* R */
8dda5b0e DSC	181	#define EXT_CSD_WR_REL_SET 167 /* R/W */
f866a46d	182	#define EXT_CSD_RPMB_MULT 168 /* RO */
0560db18	183	#define EXT_CSD_ERASE_GROUP_DEF 175 /* R/W */
3690d6d6	184	#define EXT_CSD_BOOT_BUS_WIDTH 177
0560db18 LW	185	#define EXT_CSD_PART_CONF 179 /* R/W */
	186	#define EXT_CSD_BUS_WIDTH 183 /* R/W */
	187	#define EXT_CSD_HS_TIMING 185 /* R/W */
	188	#define EXT_CSD_REV 192 /* RO */
	189	#define EXT_CSD_CARD_TYPE 196 /* RO */
	190	#define EXT_CSD_SEC_CNT 212 /* RO, 4 bytes */
f866a46d	191	#define EXT_CSD_HC_WP_GRP_SIZE 221 /* RO */
0560db18	192	#define EXT_CSD_HC_ERASE_GRP_SIZE 224 /* RO */
8948ea83	193	#define EXT_CSD_BOOT_MULT 226 /* RO */
272cc70b AF	194
	195	/*
	196	* EXT_CSD field definitions
	197	*/
	198
abe2c93f TC	199	#define EXT_CSD_CMD_SET_NORMAL (1 << 0)
	200	#define EXT_CSD_CMD_SET_SECURE (1 << 1)
	201	#define EXT_CSD_CMD_SET_CPSECURE (1 << 2)
272cc70b	202
abe2c93f TC	203	#define EXT_CSD_CARD_TYPE_26 (1 << 0) /* Card can run at 26MHz */
abe2c93f TC	204	#define EXT_CSD_CARD_TYPE_52 (1 << 1) /* Card can run at 52MHz */
d22e3d46 JC	205	#define EXT_CSD_CARD_TYPE_DDR_1_8V (1 << 2)
	206	#define EXT_CSD_CARD_TYPE_DDR_1_2V (1 << 3)
	207	#define EXT_CSD_CARD_TYPE_DDR_52 (EXT_CSD_CARD_TYPE_DDR_1_8V \
	208	\| EXT_CSD_CARD_TYPE_DDR_1_2V)
272cc70b AF	209
	210	#define EXT_CSD_BUS_WIDTH_1 0 /* Card is in 1 bit mode */
	211	#define EXT_CSD_BUS_WIDTH_4 1 /* Card is in 4 bit mode */
	212	#define EXT_CSD_BUS_WIDTH_8 2 /* Card is in 8 bit mode */
d22e3d46 JC	213	#define EXT_CSD_DDR_BUS_WIDTH_4 5 /* Card is in 4 bit DDR mode */
d22e3d46 JC	214	#define EXT_CSD_DDR_BUS_WIDTH_8 6 /* Card is in 8 bit DDR mode */
341188b9	215
3690d6d6 A	216	#define EXT_CSD_BOOT_ACK_ENABLE (1 << 6)
	217	#define EXT_CSD_BOOT_PARTITION_ENABLE (1 << 3)
	218	#define EXT_CSD_PARTITION_ACCESS_ENABLE (1 << 0)
	219	#define EXT_CSD_PARTITION_ACCESS_DISABLE (0 << 0)
	220
	221	#define EXT_CSD_BOOT_ACK(x) (x << 6)
	222	#define EXT_CSD_BOOT_PART_NUM(x) (x << 3)
	223	#define EXT_CSD_PARTITION_ACCESS(x) (x << 0)
	224
5a99b9de TR	225	#define EXT_CSD_BOOT_BUS_WIDTH_MODE(x) (x << 3)
	226	#define EXT_CSD_BOOT_BUS_WIDTH_RESET(x) (x << 2)
	227	#define EXT_CSD_BOOT_BUS_WIDTH_WIDTH(x) (x)
3690d6d6	228
d7b29129 MN	229	#define EXT_CSD_PARTITION_SETTING_COMPLETED (1 << 0)
d7b29129 MN	230
c3dbb4f9 DSC	231	#define EXT_CSD_ENH_USR (1 << 0) /* user data area is enhanced */
	232	#define EXT_CSD_ENH_GP(x) (1 << ((x)+1)) /* GP part (x+1) is enhanced */
	233
8dda5b0e DSC	234	#define EXT_CSD_HS_CTRL_REL (1 << 0) /* host controlled WR_REL_SET */
	235
	236	#define EXT_CSD_WR_DATA_REL_USR (1 << 0) /* user data area WR_REL */
	237	#define EXT_CSD_WR_DATA_REL_GP(x) (1 << ((x)+1)) /* GP part (x+1) WR_REL */
	238
1de97f98 AF	239	#define R1_ILLEGAL_COMMAND (1 << 22)
	240	#define R1_APP_CMD (1 << 5)
	241
272cc70b	242	#define MMC_RSP_PRESENT (1 << 0)
abe2c93f TC	243	#define MMC_RSP_136 (1 << 1) /* 136 bit response */
	244	#define MMC_RSP_CRC (1 << 2) /* expect valid crc */
	245	#define MMC_RSP_BUSY (1 << 3) /* card may send busy */
	246	#define MMC_RSP_OPCODE (1 << 4) /* response contains opcode */
272cc70b	247
abe2c93f TC	248	#define MMC_RSP_NONE (0)
abe2c93f TC	249	#define MMC_RSP_R1 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
272cc70b AF	250	#define MMC_RSP_R1b (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE\| \
272cc70b AF	251	MMC_RSP_BUSY)
abe2c93f TC	252	#define MMC_RSP_R2 (MMC_RSP_PRESENT\|MMC_RSP_136\|MMC_RSP_CRC)
	253	#define MMC_RSP_R3 (MMC_RSP_PRESENT)
	254	#define MMC_RSP_R4 (MMC_RSP_PRESENT)
	255	#define MMC_RSP_R5 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
	256	#define MMC_RSP_R6 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
	257	#define MMC_RSP_R7 (MMC_RSP_PRESENT\|MMC_RSP_CRC\|MMC_RSP_OPCODE)
272cc70b	258
bc897b1d LW	259	#define MMCPART_NOAVAILABLE (0xff)
	260	#define PART_ACCESS_MASK (0x7)
	261	#define PART_SUPPORT (0x1)
c3dbb4f9	262	#define ENHNCD_SUPPORT (0x2)
1937e5aa	263	#define PART_ENH_ATTRIB (0x1f)
71f95118	264
8bfa195e SG	265	/* Maximum block size for MMC */
	266	#define MMC_MAX_BLOCK_LEN 512
	267
3690d6d6 A	268	/* The number of MMC physical partitions. These consist of:
	269	* boot partitions (2), general purpose partitions (4) in MMC v4.4.
	270	*/
	271	#define MMC_NUM_BOOT_PARTITION 2
91fdabc6	272	#define MMC_PART_RPMB 3 /* RPMB partition number */
3690d6d6	273
e7ecf7cb SG	274	/* Driver model support */
	275
	276	/**
	277	* struct mmc_uclass_priv - Holds information about a device used by the uclass
	278	*/
	279	struct mmc_uclass_priv {
	280	struct mmc *mmc;
	281	};
	282
	283	/**
	284	* mmc_get_mmc_dev() - get the MMC struct pointer for a device
	285	*
	286	* Provided that the device is already probed and ready for use, this value
	287	* will be available.
	288	*
	289	* @dev: Device
	290	* @return associated mmc struct pointer if available, else NULL
	291	*/
	292	struct mmc mmc_get_mmc_dev(struct udevice dev);
	293
	294	/* End of driver model support */
	295
1de97f98 AF	296	struct mmc_cid {
	297	unsigned long psn;
	298	unsigned short oid;
	299	unsigned char mid;
	300	unsigned char prv;
	301	unsigned char mdt;
	302	char pnm[7];
	303	};
	304
272cc70b AF	305	struct mmc_cmd {
	306	ushort cmdidx;
	307	uint resp_type;
	308	uint cmdarg;
0b453ffe	309	uint response[4];
272cc70b AF	310	};
	311
	312	struct mmc_data {
	313	union {
	314	char *dest;
	315	const char src; / src buffers don't get written to */
	316	};
	317	uint flags;
	318	uint blocks;
	319	uint blocksize;
	320	};
	321
ab769f22 PA	322	/* forward decl. */
	323	struct mmc;
	324
	325	struct mmc_ops {
	326	int (send_cmd)(struct mmc mmc,
	327	struct mmc_cmd cmd, struct mmc_data data);
	328	void (set_ios)(struct mmc mmc);
	329	int (init)(struct mmc mmc);
	330	int (getcd)(struct mmc mmc);
	331	int (getwp)(struct mmc mmc);
	332	};
	333
93bfd616 PA	334	struct mmc_config {
	335	const char *name;
	336	const struct mmc_ops *ops;
	337	uint host_caps;
	338	uint voltages;
	339	uint f_min;
	340	uint f_max;
	341	uint b_max;
	342	unsigned char part_type;
	343	};
	344
	345	/* TODO struct mmc should be in mmc_private but it's hard to fix right now */
272cc70b	346	struct mmc {
33fb211d	347	#ifndef CONFIG_BLK
272cc70b	348	struct list_head link;
33fb211d	349	#endif
93bfd616	350	const struct mmc_config cfg; / provided configuration */
272cc70b	351	uint version;
93bfd616	352	void *priv;
bc897b1d	353	uint has_init;
272cc70b AF	354	int high_capacity;
	355	uint bus_width;
	356	uint clock;
	357	uint card_caps;
272cc70b	358	uint ocr;
ab71188c MN	359	uint dsr;
ab71188c MN	360	uint dsr_imp;
272cc70b AF	361	uint scr[2];
272cc70b AF	362	uint csd[4];
0b453ffe	363	uint cid[4];
272cc70b	364	ushort rca;
c3dbb4f9 DSC	365	u8 part_support;
c3dbb4f9 DSC	366	u8 part_attr;
9e41a00b	367	u8 wr_rel_set;
bc897b1d	368	char part_config;
272cc70b AF	369	uint tran_speed;
	370	uint read_bl_len;
	371	uint write_bl_len;
a4ff9f83	372	uint erase_grp_size; /* in 512-byte sectors */
037dc0ab	373	uint hc_wp_grp_size; /* in 512-byte sectors */
272cc70b	374	u64 capacity;
f866a46d SW	375	u64 capacity_user;
	376	u64 capacity_boot;
	377	u64 capacity_rpmb;
	378	u64 capacity_gp[4];
a7f852b6 DSC	379	u64 enh_user_start;
a7f852b6 DSC	380	u64 enh_user_size;
33fb211d	381	#ifndef CONFIG_BLK
4101f687	382	struct blk_desc block_dev;
33fb211d	383	#endif
e9550449 CLC	384	char op_cond_pending; /* 1 if we are waiting on an op_cond command */
	385	char init_in_progress; /* 1 if we have done mmc_start_init() */
	386	char preinit; /* start init as early as possible */
786e8f81	387	int ddr_mode;
cffe5d86 SG	388	#ifdef CONFIG_DM_MMC
	389	struct udevice dev; / Device for this MMC controller */
	390	#endif
272cc70b AF	391	};
272cc70b AF	392
ac9da0e0 DSC	393	struct mmc_hwpart_conf {
	394	struct {
	395	uint enh_start; /* in 512-byte sectors */
	396	uint enh_size; /* in 512-byte sectors, if 0 no enh area */
8dda5b0e DSC	397	unsigned wr_rel_change : 1;
8dda5b0e DSC	398	unsigned wr_rel_set : 1;
ac9da0e0 DSC	399	} user;
	400	struct {
	401	uint size; /* in 512-byte sectors */
8dda5b0e DSC	402	unsigned enhanced : 1;
	403	unsigned wr_rel_change : 1;
	404	unsigned wr_rel_set : 1;
ac9da0e0 DSC	405	} gp_part[4];
	406	};
	407
	408	enum mmc_hwpart_conf_mode {
	409	MMC_HWPART_CONF_CHECK,
	410	MMC_HWPART_CONF_SET,
	411	MMC_HWPART_CONF_COMPLETE,
	412	};
	413
93bfd616	414	struct mmc mmc_create(const struct mmc_config cfg, void *priv);
ad27dd5e SG	415
	416	/**
	417	* mmc_bind() - Set up a new MMC device ready for probing
	418	*
	419	* A child block device is bound with the IF_TYPE_MMC interface type. This
	420	* allows the device to be used with CONFIG_BLK
	421	*
	422	* @dev: MMC device to set up
	423	* @mmc: MMC struct
	424	* @cfg: MMC configuration
	425	* @return 0 if OK, -ve on error
	426	*/
	427	int mmc_bind(struct udevice dev, struct mmc mmc,
	428	const struct mmc_config *cfg);
93bfd616	429	void mmc_destroy(struct mmc *mmc);
ad27dd5e SG	430
	431	/**
	432	* mmc_unbind() - Unbind a MMC device's child block device
	433	*
	434	* @dev: MMC device
	435	* @return 0 if OK, -ve on error
	436	*/
	437	int mmc_unbind(struct udevice *dev);
272cc70b AF	438	int mmc_initialize(bd_t *bis);
	439	int mmc_init(struct mmc *mmc);
	440	int mmc_read(struct mmc mmc, u64 src, uchar dst, int size);
4a6ee172	441	void mmc_set_clock(struct mmc *mmc, uint clock);
272cc70b	442	struct mmc *find_mmc_device(int dev_num);
89716964	443	int mmc_set_dev(int dev_num);
272cc70b	444	void print_mmc_devices(char separator);
ea6ebe21	445	int get_mmc_num(void);
ac9da0e0 DSC	446	int mmc_hwpart_config(struct mmc mmc, const struct mmc_hwpart_conf conf,
ac9da0e0 DSC	447	enum mmc_hwpart_conf_mode mode);
48972d90	448	int mmc_getcd(struct mmc *mmc);
750121c3	449	int board_mmc_getcd(struct mmc *mmc);
d23d8d7e	450	int mmc_getwp(struct mmc *mmc);
750121c3	451	int board_mmc_getwp(struct mmc *mmc);
ab71188c	452	int mmc_set_dsr(struct mmc *mmc, u16 val);
3690d6d6 A	453	/* Function to change the size of boot partition and rpmb partitions */
	454	int mmc_boot_partition_size_change(struct mmc *mmc, unsigned long bootsize,
	455	unsigned long rpmbsize);
792970b0 TR	456	/* Function to modify the PARTITION_CONFIG field of EXT_CSD */
792970b0 TR	457	int mmc_set_part_conf(struct mmc *mmc, u8 ack, u8 part_num, u8 access);
5a99b9de TR	458	/* Function to modify the BOOT_BUS_WIDTH field of EXT_CSD */
5a99b9de TR	459	int mmc_set_boot_bus_width(struct mmc *mmc, u8 width, u8 reset, u8 mode);
33ace362 TR	460	/* Function to modify the RST_n_FUNCTION field of EXT_CSD */
33ace362 TR	461	int mmc_set_rst_n_function(struct mmc *mmc, u8 enable);
91fdabc6 PA	462	/* Functions to read / write the RPMB partition */
	463	int mmc_rpmb_set_key(struct mmc mmc, void key);
	464	int mmc_rpmb_get_counter(struct mmc mmc, unsigned long counter);
	465	int mmc_rpmb_read(struct mmc mmc, void addr, unsigned short blk,
	466	unsigned short cnt, unsigned char *key);
	467	int mmc_rpmb_write(struct mmc mmc, void addr, unsigned short blk,
	468	unsigned short cnt, unsigned char *key);
e9550449 CLC	469	/**
	470	* Start device initialization and return immediately; it does not block on
	471	* polling OCR (operation condition register) status. Then you should call
	472	* mmc_init, which would block on polling OCR status and complete the device
	473	* initializatin.
	474	*
	475	* @param mmc Pointer to a MMC device struct
	476	* @return 0 on success, IN_PROGRESS on waiting for OCR status, <0 on error.
	477	*/
	478	int mmc_start_init(struct mmc *mmc);
	479
	480	/**
	481	* Set preinit flag of mmc device.
	482	*
	483	* This will cause the device to be pre-inited during mmc_initialize(),
	484	* which may save boot time if the device is not accessed until later.
	485	* Some eMMC devices take 200-300ms to init, but unfortunately they
	486	* must be sent a series of commands to even get them to start preparing
	487	* for operation.
	488	*
	489	* @param mmc Pointer to a MMC device struct
	490	* @param preinit preinit flag value
	491	*/
	492	void mmc_set_preinit(struct mmc *mmc, int preinit);
	493
8687d5c8	494	#ifdef CONFIG_MMC_SPI
0b2da7e2	495	#define mmc_host_is_spi(mmc) ((mmc)->cfg->host_caps & MMC_MODE_SPI)
8687d5c8 PB	496	#else
	497	#define mmc_host_is_spi(mmc) 0
	498	#endif
d52ebf10	499	struct mmc *mmc_spi_init(uint bus, uint cs, uint speed, uint mode);
1592ef85	500
95de9ab2	501	void board_mmc_power_init(void);
3c7ca967	502	int board_mmc_init(bd_t *bis);
750121c3	503	int cpu_mmc_init(bd_t *bis);
aeb80555	504	int mmc_get_env_addr(struct mmc mmc, int copy, u32 env_addr);
aa844fe1	505	int mmc_get_env_dev(void);
3c7ca967	506
91785f70 SG	507	struct pci_device_id;
	508
	509	/**
	510	* pci_mmc_init() - set up PCI MMC devices
	511	*
	512	* This finds all the matching PCI IDs and sets them up as MMC devices.
	513	*
	514	* @name: Name to use for devices
4abe8e40	515	* @mmc_supported: PCI IDs to search for, terminated by {0, 0}
91785f70	516	*/
4abe8e40	517	int pci_mmc_init(const char name, struct pci_device_id mmc_supported);
91785f70	518
93bfd616 PA	519	/* Set block count limit because of 16 bit register limit on some hardware*/
	520	#ifndef CONFIG_SYS_MMC_MAX_BLK_COUNT
	521	#define CONFIG_SYS_MMC_MAX_BLK_COUNT 65535
	522	#endif
	523
cb5ec33d SG	524	/**
	525	* mmc_get_blk_desc() - Get the block descriptor for an MMC device
	526	*
	527	* @mmc: MMC device
	528	* @return block device if found, else NULL
	529	*/
	530	struct blk_desc mmc_get_blk_desc(struct mmc mmc);
	531
71f95118	532	#endif /* _MMC_H_ */