[u-boot.git] / include / sdhci.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * Copyright 2011, Marvell Semiconductor Inc.
 * Lei Wen <leiwen@marvell.com>
 *
 * Back ported to the 8xx platform (from the 8260 platform) by
 * Murray.Jensen@cmst.csiro.au, 27-Jan-01.
 */
#ifndef __SDHCI_HW_H
#define __SDHCI_HW_H

#include <linux/bitops.h>
#include <linux/types.h>
#include <asm/io.h>
#include <mmc.h>
#include <asm/gpio.h>

/*
 * Controller registers
 */

#define SDHCI_DMA_ADDRESS	0x00

#define SDHCI_BLOCK_SIZE	0x04
#define  SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) | (blksz & 0xFFF))

#define SDHCI_BLOCK_COUNT	0x06

#define SDHCI_ARGUMENT		0x08

#define SDHCI_TRANSFER_MODE	0x0C
#define  SDHCI_TRNS_DMA		BIT(0)
#define  SDHCI_TRNS_BLK_CNT_EN	BIT(1)
#define  SDHCI_TRNS_ACMD12	BIT(2)
#define  SDHCI_TRNS_READ	BIT(4)
#define  SDHCI_TRNS_MULTI	BIT(5)

#define SDHCI_COMMAND		0x0E
#define  SDHCI_CMD_RESP_MASK	0x03
#define  SDHCI_CMD_CRC		0x08
#define  SDHCI_CMD_INDEX	0x10
#define  SDHCI_CMD_DATA		0x20
#define  SDHCI_CMD_ABORTCMD	0xC0

#define  SDHCI_CMD_RESP_NONE	0x00
#define  SDHCI_CMD_RESP_LONG	0x01
#define  SDHCI_CMD_RESP_SHORT	0x02
#define  SDHCI_CMD_RESP_SHORT_BUSY 0x03

#define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) | (f & 0xff))
#define SDHCI_GET_CMD(c) ((c>>8) & 0x3f)

#define SDHCI_RESPONSE		0x10

#define SDHCI_BUFFER		0x20

#define SDHCI_PRESENT_STATE	0x24
#define  SDHCI_CMD_INHIBIT	BIT(0)
#define  SDHCI_DATA_INHIBIT	BIT(1)
#define  SDHCI_DOING_WRITE	BIT(8)
#define  SDHCI_DOING_READ	BIT(9)
#define  SDHCI_SPACE_AVAILABLE	BIT(10)
#define  SDHCI_DATA_AVAILABLE	BIT(11)
#define  SDHCI_CARD_PRESENT	BIT(16)
#define  SDHCI_CARD_STATE_STABLE	BIT(17)
#define  SDHCI_CARD_DETECT_PIN_LEVEL	BIT(18)
#define  SDHCI_WRITE_PROTECT	BIT(19)

#define SDHCI_HOST_CONTROL	0x28
#define  SDHCI_CTRL_LED		BIT(0)
#define  SDHCI_CTRL_4BITBUS	BIT(1)
#define  SDHCI_CTRL_HISPD	BIT(2)
#define  SDHCI_CTRL_DMA_MASK	0x18
#define   SDHCI_CTRL_SDMA	0x00
#define   SDHCI_CTRL_ADMA1	0x08
#define   SDHCI_CTRL_ADMA32	0x10
#define   SDHCI_CTRL_ADMA64	0x18
#define  SDHCI_CTRL_8BITBUS	BIT(5)
#define  SDHCI_CTRL_CD_TEST_INS	BIT(6)
#define  SDHCI_CTRL_CD_TEST	BIT(7)

#define SDHCI_POWER_CONTROL	0x29
#define  SDHCI_POWER_ON		0x01
#define  SDHCI_POWER_180	0x0A
#define  SDHCI_POWER_300	0x0C
#define  SDHCI_POWER_330	0x0E

#define SDHCI_BLOCK_GAP_CONTROL	0x2A

#define SDHCI_WAKE_UP_CONTROL	0x2B
#define  SDHCI_WAKE_ON_INT	BIT(0)
#define  SDHCI_WAKE_ON_INSERT	BIT(1)
#define  SDHCI_WAKE_ON_REMOVE	BIT(2)

#define SDHCI_CLOCK_CONTROL	0x2C
#define  SDHCI_DIVIDER_SHIFT	8
#define  SDHCI_DIVIDER_HI_SHIFT	6
#define  SDHCI_DIV_MASK	0xFF
#define  SDHCI_DIV_MASK_LEN	8
#define  SDHCI_DIV_HI_MASK	0x300
#define  SDHCI_PROG_CLOCK_MODE  BIT(5)
#define  SDHCI_CLOCK_CARD_EN	BIT(2)
#define  SDHCI_CLOCK_INT_STABLE	BIT(1)
#define  SDHCI_CLOCK_INT_EN	BIT(0)

#define SDHCI_TIMEOUT_CONTROL	0x2E

#define SDHCI_SOFTWARE_RESET	0x2F
#define  SDHCI_RESET_ALL	0x01
#define  SDHCI_RESET_CMD	0x02
#define  SDHCI_RESET_DATA	0x04

#define SDHCI_INT_STATUS	0x30
#define SDHCI_INT_ENABLE	0x34
#define SDHCI_SIGNAL_ENABLE	0x38
#define  SDHCI_INT_RESPONSE	BIT(0)
#define  SDHCI_INT_DATA_END	BIT(1)
#define  SDHCI_INT_DMA_END	BIT(3)
#define  SDHCI_INT_SPACE_AVAIL	BIT(4)
#define  SDHCI_INT_DATA_AVAIL	BIT(5)
#define  SDHCI_INT_CARD_INSERT	BIT(6)
#define  SDHCI_INT_CARD_REMOVE	BIT(7)
#define  SDHCI_INT_CARD_INT	BIT(8)
#define  SDHCI_INT_ERROR	BIT(15)
#define  SDHCI_INT_TIMEOUT	BIT(16)
#define  SDHCI_INT_CRC		BIT(17)
#define  SDHCI_INT_END_BIT	BIT(18)
#define  SDHCI_INT_INDEX	BIT(19)
#define  SDHCI_INT_DATA_TIMEOUT	BIT(20)
#define  SDHCI_INT_DATA_CRC	BIT(21)
#define  SDHCI_INT_DATA_END_BIT	BIT(22)
#define  SDHCI_INT_BUS_POWER	BIT(23)
#define  SDHCI_INT_ACMD12ERR	BIT(24)
#define  SDHCI_INT_ADMA_ERROR	BIT(25)

#define  SDHCI_INT_NORMAL_MASK	0x00007FFF
#define  SDHCI_INT_ERROR_MASK	0xFFFF8000

#define  SDHCI_INT_CMD_MASK	(SDHCI_INT_RESPONSE | SDHCI_INT_TIMEOUT | \
		SDHCI_INT_CRC | SDHCI_INT_END_BIT | SDHCI_INT_INDEX)
#define  SDHCI_INT_DATA_MASK	(SDHCI_INT_DATA_END | SDHCI_INT_DMA_END | \
		SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL | \
		SDHCI_INT_DATA_TIMEOUT | SDHCI_INT_DATA_CRC | \
		SDHCI_INT_DATA_END_BIT | SDHCI_INT_ADMA_ERROR)
#define SDHCI_INT_ALL_MASK	((unsigned int)-1)

#define SDHCI_ACMD12_ERR	0x3C

#define SDHCI_HOST_CONTROL2	0x3E
#define  SDHCI_CTRL_UHS_MASK	0x0007
#define  SDHCI_CTRL_UHS_SDR12	0x0000
#define  SDHCI_CTRL_UHS_SDR25	0x0001
#define  SDHCI_CTRL_UHS_SDR50	0x0002
#define  SDHCI_CTRL_UHS_SDR104	0x0003
#define  SDHCI_CTRL_UHS_DDR50	0x0004
#define  SDHCI_CTRL_HS400	0x0005 /* Non-standard */
#define  SDHCI_CTRL_VDD_180	0x0008
#define  SDHCI_CTRL_DRV_TYPE_MASK	0x0030
#define  SDHCI_CTRL_DRV_TYPE_B	0x0000
#define  SDHCI_CTRL_DRV_TYPE_A	0x0010
#define  SDHCI_CTRL_DRV_TYPE_C	0x0020
#define  SDHCI_CTRL_DRV_TYPE_D	0x0030
#define  SDHCI_CTRL_EXEC_TUNING	0x0040
#define  SDHCI_CTRL_TUNED_CLK	0x0080
#define  SDHCI_CTRL_PRESET_VAL_ENABLE	0x8000

#define SDHCI_CAPABILITIES	0x40
#define  SDHCI_TIMEOUT_CLK_MASK	0x0000003F
#define  SDHCI_TIMEOUT_CLK_SHIFT 0
#define  SDHCI_TIMEOUT_CLK_UNIT	0x00000080
#define  SDHCI_CLOCK_BASE_MASK	0x00003F00
#define  SDHCI_CLOCK_V3_BASE_MASK	0x0000FF00
#define  SDHCI_CLOCK_BASE_SHIFT	8
#define  SDHCI_MAX_BLOCK_MASK	0x00030000
#define  SDHCI_MAX_BLOCK_SHIFT  16
#define  SDHCI_CAN_DO_8BIT	BIT(18)
#define  SDHCI_CAN_DO_ADMA2	BIT(19)
#define  SDHCI_CAN_DO_ADMA1	BIT(20)
#define  SDHCI_CAN_DO_HISPD	BIT(21)
#define  SDHCI_CAN_DO_SDMA	BIT(22)
#define  SDHCI_CAN_VDD_330	BIT(24)
#define  SDHCI_CAN_VDD_300	BIT(25)
#define  SDHCI_CAN_VDD_180	BIT(26)
#define  SDHCI_CAN_64BIT	BIT(28)

#define SDHCI_CAPABILITIES_1	0x44
#define  SDHCI_SUPPORT_SDR50	0x00000001
#define  SDHCI_SUPPORT_SDR104	0x00000002
#define  SDHCI_SUPPORT_DDR50	0x00000004
#define  SDHCI_USE_SDR50_TUNING	0x00002000

#define  SDHCI_CLOCK_MUL_MASK	0x00FF0000
#define  SDHCI_CLOCK_MUL_SHIFT	16

#define SDHCI_MAX_CURRENT	0x48

/* 4C-4F reserved for more max current */

#define SDHCI_SET_ACMD12_ERROR	0x50
#define SDHCI_SET_INT_ERROR	0x52

#define SDHCI_ADMA_ERROR	0x54

/* 55-57 reserved */

#define SDHCI_ADMA_ADDRESS	0x58
#define SDHCI_ADMA_ADDRESS_HI	0x5c

/* 60-FB reserved */

#define SDHCI_SLOT_INT_STATUS	0xFC

#define SDHCI_HOST_VERSION	0xFE
#define  SDHCI_VENDOR_VER_MASK	0xFF00
#define  SDHCI_VENDOR_VER_SHIFT	8
#define  SDHCI_SPEC_VER_MASK	0x00FF
#define  SDHCI_SPEC_VER_SHIFT	0
#define   SDHCI_SPEC_100	0
#define   SDHCI_SPEC_200	1
#define   SDHCI_SPEC_300	2

#define SDHCI_GET_VERSION(x) (x->version & SDHCI_SPEC_VER_MASK)

/*
 * End of controller registers.
 */

#define SDHCI_MAX_DIV_SPEC_200	256
#define SDHCI_MAX_DIV_SPEC_300	2046

/*
 * quirks
 */
#define SDHCI_QUIRK_32BIT_DMA_ADDR	(1 << 0)
#define SDHCI_QUIRK_REG32_RW		(1 << 1)
#define SDHCI_QUIRK_BROKEN_R1B		(1 << 2)
#define SDHCI_QUIRK_NO_HISPD_BIT	(1 << 3)
#define SDHCI_QUIRK_BROKEN_VOLTAGE	(1 << 4)
/*
 * SDHCI_QUIRK_BROKEN_HISPD_MODE
 * the hardware cannot operate correctly in high-speed mode,
 * this quirk forces the sdhci host-controller to non high-speed mode
 */
#define SDHCI_QUIRK_BROKEN_HISPD_MODE	BIT(5)
#define SDHCI_QUIRK_WAIT_SEND_CMD	(1 << 6)
#define SDHCI_QUIRK_USE_WIDE8		(1 << 8)

/* to make gcc happy */
struct sdhci_host;

/*
 * Host SDMA buffer boundary. Valid values from 4K to 512K in powers of 2.
 */
#define SDHCI_DEFAULT_BOUNDARY_SIZE	(512 * 1024)
#define SDHCI_DEFAULT_BOUNDARY_ARG	(7)
struct sdhci_ops {
#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
	u32	(*read_l)(struct sdhci_host *host, int reg);
	u16	(*read_w)(struct sdhci_host *host, int reg);
	u8	(*read_b)(struct sdhci_host *host, int reg);
	void	(*write_l)(struct sdhci_host *host, u32 val, int reg);
	void	(*write_w)(struct sdhci_host *host, u16 val, int reg);
	void	(*write_b)(struct sdhci_host *host, u8 val, int reg);
#endif
	int	(*get_cd)(struct sdhci_host *host);
	void	(*set_control_reg)(struct sdhci_host *host);
	int	(*set_ios_post)(struct sdhci_host *host);
	void	(*set_clock)(struct sdhci_host *host, u32 div);
	int (*platform_execute_tuning)(struct mmc *host, u8 opcode);
	void (*set_delay)(struct sdhci_host *host);
	int	(*deferred_probe)(struct sdhci_host *host);
};

#if CONFIG_IS_ENABLED(MMC_SDHCI_ADMA)
#define ADMA_MAX_LEN	65532
#ifdef CONFIG_DMA_ADDR_T_64BIT
#define ADMA_DESC_LEN	16
#else
#define ADMA_DESC_LEN	8
#endif
#define ADMA_TABLE_NO_ENTRIES (CONFIG_SYS_MMC_MAX_BLK_COUNT * \
			       MMC_MAX_BLOCK_LEN) / ADMA_MAX_LEN

#define ADMA_TABLE_SZ (ADMA_TABLE_NO_ENTRIES * ADMA_DESC_LEN)

/* Decriptor table defines */
#define ADMA_DESC_ATTR_VALID		BIT(0)
#define ADMA_DESC_ATTR_END		BIT(1)
#define ADMA_DESC_ATTR_INT		BIT(2)
#define ADMA_DESC_ATTR_ACT1		BIT(4)
#define ADMA_DESC_ATTR_ACT2		BIT(5)

#define ADMA_DESC_TRANSFER_DATA		ADMA_DESC_ATTR_ACT2
#define ADMA_DESC_LINK_DESC	(ADMA_DESC_ATTR_ACT1 | ADMA_DESC_ATTR_ACT2)

struct sdhci_adma_desc {
	u8 attr;
	u8 reserved;
	u16 len;
	u32 addr_lo;
#ifdef CONFIG_DMA_ADDR_T_64BIT
	u32 addr_hi;
#endif
} __packed;
#endif
struct sdhci_host {
	const char *name;
	void *ioaddr;
	unsigned int quirks;
	unsigned int host_caps;
	unsigned int version;
	unsigned int max_clk;   /* Maximum Base Clock frequency */
	unsigned int clk_mul;   /* Clock Multiplier value */
	unsigned int clock;
	struct mmc *mmc;
	const struct sdhci_ops *ops;
	int index;

	int bus_width;
	struct gpio_desc pwr_gpio;	/* Power GPIO */
	struct gpio_desc cd_gpio;		/* Card Detect GPIO */

	uint	voltages;

	struct mmc_config cfg;
	void *align_buffer;
	bool force_align_buffer;
	dma_addr_t start_addr;
	int flags;
#define USE_SDMA	(0x1 << 0)
#define USE_ADMA	(0x1 << 1)
#define USE_ADMA64	(0x1 << 2)
#define USE_DMA		(USE_SDMA | USE_ADMA | USE_ADMA64)
	dma_addr_t adma_addr;
#if CONFIG_IS_ENABLED(MMC_SDHCI_ADMA)
	struct sdhci_adma_desc *adma_desc_table;
	uint desc_slot;
#endif
};

#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS

static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
{
	if (unlikely(host->ops->write_l))
		host->ops->write_l(host, val, reg);
	else
		writel(val, host->ioaddr + reg);
}

static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
{
	if (unlikely(host->ops->write_w))
		host->ops->write_w(host, val, reg);
	else
		writew(val, host->ioaddr + reg);
}

static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
{
	if (unlikely(host->ops->write_b))
		host->ops->write_b(host, val, reg);
	else
		writeb(val, host->ioaddr + reg);
}

static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
{
	if (unlikely(host->ops->read_l))
		return host->ops->read_l(host, reg);
	else
		return readl(host->ioaddr + reg);
}

static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
{
	if (unlikely(host->ops->read_w))
		return host->ops->read_w(host, reg);
	else
		return readw(host->ioaddr + reg);
}

static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
{
	if (unlikely(host->ops->read_b))
		return host->ops->read_b(host, reg);
	else
		return readb(host->ioaddr + reg);
}

#else

static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
{
	writel(val, host->ioaddr + reg);
}

static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
{
	writew(val, host->ioaddr + reg);
}

static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
{
	writeb(val, host->ioaddr + reg);
}
static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
{
	return readl(host->ioaddr + reg);
}

static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
{
	return readw(host->ioaddr + reg);
}

static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
{
	return readb(host->ioaddr + reg);
}
#endif

#ifdef CONFIG_BLK
/**
 * sdhci_setup_cfg() - Set up the configuration for DWMMC
 *
 * This is used to set up an SDHCI device when you are using CONFIG_BLK.
 *
 * This should be called from your MMC driver's probe() method once you have
 * the information required.
 *
 * Generally your driver will have a platform data structure which holds both
 * the configuration (struct mmc_config) and the MMC device info (struct mmc).
 * For example:
 *
 * struct msm_sdhc_plat {
 *	struct mmc_config cfg;
 *	struct mmc mmc;
 * };
 *
 * ...
 *
 * Inside U_BOOT_DRIVER():
 *	.platdata_auto_alloc_size = sizeof(struct msm_sdhc_plat),
 *
 * To access platform data:
 *	struct msm_sdhc_plat *plat = dev_get_platdata(dev);
 *
 * See msm_sdhci.c for an example.
 *
 * @cfg:	Configuration structure to fill in (generally &plat->mmc)
 * @host:	SDHCI host structure
 * @f_max:	Maximum supported clock frequency in HZ (0 for default)
 * @f_min:	Minimum supported clock frequency in HZ (0 for default)
 */
int sdhci_setup_cfg(struct mmc_config *cfg, struct sdhci_host *host,
		    u32 f_max, u32 f_min);

/**
 * sdhci_bind() - Set up a new MMC block device
 *
 * This is used to set up an SDHCI block device when you are using CONFIG_BLK.
 * It should be called from your driver's bind() method.
 *
 * See msm_sdhci.c for an example.
 *
 * @dev:	Device to set up
 * @mmc:	Pointer to mmc structure (normally &plat->mmc)
 * @cfg:	Empty configuration structure (generally &plat->cfg). This is
 *		normally all zeroes at this point. The only purpose of passing
 *		this in is to set mmc->cfg to it.
 * @return 0 if OK, -ve if the block device could not be created
 */
int sdhci_bind(struct udevice *dev, struct mmc *mmc, struct mmc_config *cfg);
#else

/**
 * add_sdhci() - Add a new SDHCI interface
 *
 * This is used when you are not using CONFIG_BLK. Convert your driver over!
 *
 * @host:	SDHCI host structure
 * @f_max:	Maximum supported clock frequency in HZ (0 for default)
 * @f_min:	Minimum supported clock frequency in HZ (0 for default)
 * @return 0 if OK, -ve on error
 */
int add_sdhci(struct sdhci_host *host, u32 f_max, u32 f_min);
#endif /* !CONFIG_BLK */

void sdhci_set_uhs_timing(struct sdhci_host *host);
#ifdef CONFIG_DM_MMC
/* Export the operations to drivers */
int sdhci_probe(struct udevice *dev);
int sdhci_set_clock(struct mmc *mmc, unsigned int clock);
extern const struct dm_mmc_ops sdhci_ops;
#else
#endif

#endif /* __SDHCI_HW_H */
Commit	Line	Data
83d290c5	1	/* SPDX-License-Identifier: GPL-2.0+ */
af62a557 LW	2	/*
	3	* Copyright 2011, Marvell Semiconductor Inc.
	4	* Lei Wen <leiwen@marvell.com>
	5	*
af62a557 LW	6	* Back ported to the 8xx platform (from the 8260 platform) by
	7	* Murray.Jensen@cmst.csiro.au, 27-Jan-01.
	8	*/
	9	#ifndef __SDHCI_HW_H
	10	#define __SDHCI_HW_H
	11
cd93d625	12	#include <linux/bitops.h>
f5df6aa1	13	#include <linux/types.h>
af62a557	14	#include <asm/io.h>
6cf1b17c	15	#include <mmc.h>
0347960b	16	#include <asm/gpio.h>
6cf1b17c	17
af62a557 LW	18	/*
	19	* Controller registers
	20	*/
	21
	22	#define SDHCI_DMA_ADDRESS 0x00
	23
	24	#define SDHCI_BLOCK_SIZE 0x04
	25	#define SDHCI_MAKE_BLKSZ(dma, blksz) (((dma & 0x7) << 12) \| (blksz & 0xFFF))
	26
	27	#define SDHCI_BLOCK_COUNT 0x06
	28
	29	#define SDHCI_ARGUMENT 0x08
	30
	31	#define SDHCI_TRANSFER_MODE 0x0C
91914581 JC	32	#define SDHCI_TRNS_DMA BIT(0)
	33	#define SDHCI_TRNS_BLK_CNT_EN BIT(1)
	34	#define SDHCI_TRNS_ACMD12 BIT(2)
	35	#define SDHCI_TRNS_READ BIT(4)
	36	#define SDHCI_TRNS_MULTI BIT(5)
af62a557 LW	37
	38	#define SDHCI_COMMAND 0x0E
	39	#define SDHCI_CMD_RESP_MASK 0x03
	40	#define SDHCI_CMD_CRC 0x08
	41	#define SDHCI_CMD_INDEX 0x10
	42	#define SDHCI_CMD_DATA 0x20
	43	#define SDHCI_CMD_ABORTCMD 0xC0
	44
	45	#define SDHCI_CMD_RESP_NONE 0x00
	46	#define SDHCI_CMD_RESP_LONG 0x01
	47	#define SDHCI_CMD_RESP_SHORT 0x02
	48	#define SDHCI_CMD_RESP_SHORT_BUSY 0x03
	49
	50	#define SDHCI_MAKE_CMD(c, f) (((c & 0xff) << 8) \| (f & 0xff))
	51	#define SDHCI_GET_CMD(c) ((c>>8) & 0x3f)
	52
	53	#define SDHCI_RESPONSE 0x10
	54
	55	#define SDHCI_BUFFER 0x20
	56
	57	#define SDHCI_PRESENT_STATE 0x24
91914581 JC	58	#define SDHCI_CMD_INHIBIT BIT(0)
	59	#define SDHCI_DATA_INHIBIT BIT(1)
	60	#define SDHCI_DOING_WRITE BIT(8)
	61	#define SDHCI_DOING_READ BIT(9)
	62	#define SDHCI_SPACE_AVAILABLE BIT(10)
	63	#define SDHCI_DATA_AVAILABLE BIT(11)
	64	#define SDHCI_CARD_PRESENT BIT(16)
	65	#define SDHCI_CARD_STATE_STABLE BIT(17)
	66	#define SDHCI_CARD_DETECT_PIN_LEVEL BIT(18)
	67	#define SDHCI_WRITE_PROTECT BIT(19)
af62a557 LW	68
af62a557 LW	69	#define SDHCI_HOST_CONTROL 0x28
91914581 JC	70	#define SDHCI_CTRL_LED BIT(0)
	71	#define SDHCI_CTRL_4BITBUS BIT(1)
	72	#define SDHCI_CTRL_HISPD BIT(2)
af62a557 LW	73	#define SDHCI_CTRL_DMA_MASK 0x18
	74	#define SDHCI_CTRL_SDMA 0x00
	75	#define SDHCI_CTRL_ADMA1 0x08
	76	#define SDHCI_CTRL_ADMA32 0x10
	77	#define SDHCI_CTRL_ADMA64 0x18
91914581 JC	78	#define SDHCI_CTRL_8BITBUS BIT(5)
	79	#define SDHCI_CTRL_CD_TEST_INS BIT(6)
	80	#define SDHCI_CTRL_CD_TEST BIT(7)
af62a557 LW	81
	82	#define SDHCI_POWER_CONTROL 0x29
	83	#define SDHCI_POWER_ON 0x01
	84	#define SDHCI_POWER_180 0x0A
	85	#define SDHCI_POWER_300 0x0C
	86	#define SDHCI_POWER_330 0x0E
	87
	88	#define SDHCI_BLOCK_GAP_CONTROL 0x2A
	89
	90	#define SDHCI_WAKE_UP_CONTROL 0x2B
91914581 JC	91	#define SDHCI_WAKE_ON_INT BIT(0)
	92	#define SDHCI_WAKE_ON_INSERT BIT(1)
	93	#define SDHCI_WAKE_ON_REMOVE BIT(2)
af62a557 LW	94
	95	#define SDHCI_CLOCK_CONTROL 0x2C
	96	#define SDHCI_DIVIDER_SHIFT 8
	97	#define SDHCI_DIVIDER_HI_SHIFT 6
	98	#define SDHCI_DIV_MASK 0xFF
	99	#define SDHCI_DIV_MASK_LEN 8
	100	#define SDHCI_DIV_HI_MASK 0x300
91914581 JC	101	#define SDHCI_PROG_CLOCK_MODE BIT(5)
	102	#define SDHCI_CLOCK_CARD_EN BIT(2)
	103	#define SDHCI_CLOCK_INT_STABLE BIT(1)
	104	#define SDHCI_CLOCK_INT_EN BIT(0)
af62a557 LW	105
	106	#define SDHCI_TIMEOUT_CONTROL 0x2E
	107
	108	#define SDHCI_SOFTWARE_RESET 0x2F
	109	#define SDHCI_RESET_ALL 0x01
	110	#define SDHCI_RESET_CMD 0x02
	111	#define SDHCI_RESET_DATA 0x04
	112
	113	#define SDHCI_INT_STATUS 0x30
	114	#define SDHCI_INT_ENABLE 0x34
	115	#define SDHCI_SIGNAL_ENABLE 0x38
91914581 JC	116	#define SDHCI_INT_RESPONSE BIT(0)
	117	#define SDHCI_INT_DATA_END BIT(1)
	118	#define SDHCI_INT_DMA_END BIT(3)
	119	#define SDHCI_INT_SPACE_AVAIL BIT(4)
	120	#define SDHCI_INT_DATA_AVAIL BIT(5)
	121	#define SDHCI_INT_CARD_INSERT BIT(6)
	122	#define SDHCI_INT_CARD_REMOVE BIT(7)
	123	#define SDHCI_INT_CARD_INT BIT(8)
	124	#define SDHCI_INT_ERROR BIT(15)
	125	#define SDHCI_INT_TIMEOUT BIT(16)
	126	#define SDHCI_INT_CRC BIT(17)
	127	#define SDHCI_INT_END_BIT BIT(18)
	128	#define SDHCI_INT_INDEX BIT(19)
	129	#define SDHCI_INT_DATA_TIMEOUT BIT(20)
	130	#define SDHCI_INT_DATA_CRC BIT(21)
	131	#define SDHCI_INT_DATA_END_BIT BIT(22)
	132	#define SDHCI_INT_BUS_POWER BIT(23)
	133	#define SDHCI_INT_ACMD12ERR BIT(24)
	134	#define SDHCI_INT_ADMA_ERROR BIT(25)
af62a557 LW	135
	136	#define SDHCI_INT_NORMAL_MASK 0x00007FFF
	137	#define SDHCI_INT_ERROR_MASK 0xFFFF8000
	138
	139	#define SDHCI_INT_CMD_MASK (SDHCI_INT_RESPONSE \| SDHCI_INT_TIMEOUT \| \
	140	SDHCI_INT_CRC \| SDHCI_INT_END_BIT \| SDHCI_INT_INDEX)
	141	#define SDHCI_INT_DATA_MASK (SDHCI_INT_DATA_END \| SDHCI_INT_DMA_END \| \
	142	SDHCI_INT_DATA_AVAIL \| SDHCI_INT_SPACE_AVAIL \| \
	143	SDHCI_INT_DATA_TIMEOUT \| SDHCI_INT_DATA_CRC \| \
	144	SDHCI_INT_DATA_END_BIT \| SDHCI_INT_ADMA_ERROR)
	145	#define SDHCI_INT_ALL_MASK ((unsigned int)-1)
	146
	147	#define SDHCI_ACMD12_ERR 0x3C
	148
d1c0a220 FA	149	#define SDHCI_HOST_CONTROL2 0x3E
	150	#define SDHCI_CTRL_UHS_MASK 0x0007
	151	#define SDHCI_CTRL_UHS_SDR12 0x0000
	152	#define SDHCI_CTRL_UHS_SDR25 0x0001
	153	#define SDHCI_CTRL_UHS_SDR50 0x0002
	154	#define SDHCI_CTRL_UHS_SDR104 0x0003
	155	#define SDHCI_CTRL_UHS_DDR50 0x0004
	156	#define SDHCI_CTRL_HS400 0x0005 /* Non-standard */
	157	#define SDHCI_CTRL_VDD_180 0x0008
	158	#define SDHCI_CTRL_DRV_TYPE_MASK 0x0030
	159	#define SDHCI_CTRL_DRV_TYPE_B 0x0000
	160	#define SDHCI_CTRL_DRV_TYPE_A 0x0010
	161	#define SDHCI_CTRL_DRV_TYPE_C 0x0020
	162	#define SDHCI_CTRL_DRV_TYPE_D 0x0030
	163	#define SDHCI_CTRL_EXEC_TUNING 0x0040
	164	#define SDHCI_CTRL_TUNED_CLK 0x0080
	165	#define SDHCI_CTRL_PRESET_VAL_ENABLE 0x8000
af62a557 LW	166
	167	#define SDHCI_CAPABILITIES 0x40
	168	#define SDHCI_TIMEOUT_CLK_MASK 0x0000003F
	169	#define SDHCI_TIMEOUT_CLK_SHIFT 0
	170	#define SDHCI_TIMEOUT_CLK_UNIT 0x00000080
	171	#define SDHCI_CLOCK_BASE_MASK 0x00003F00
	172	#define SDHCI_CLOCK_V3_BASE_MASK 0x0000FF00
	173	#define SDHCI_CLOCK_BASE_SHIFT 8
	174	#define SDHCI_MAX_BLOCK_MASK 0x00030000
	175	#define SDHCI_MAX_BLOCK_SHIFT 16
91914581 JC	176	#define SDHCI_CAN_DO_8BIT BIT(18)
	177	#define SDHCI_CAN_DO_ADMA2 BIT(19)
	178	#define SDHCI_CAN_DO_ADMA1 BIT(20)
	179	#define SDHCI_CAN_DO_HISPD BIT(21)
	180	#define SDHCI_CAN_DO_SDMA BIT(22)
	181	#define SDHCI_CAN_VDD_330 BIT(24)
	182	#define SDHCI_CAN_VDD_300 BIT(25)
	183	#define SDHCI_CAN_VDD_180 BIT(26)
	184	#define SDHCI_CAN_64BIT BIT(28)
af62a557 LW	185
af62a557 LW	186	#define SDHCI_CAPABILITIES_1 0x44
b8e25ef1 SDPP	187	#define SDHCI_SUPPORT_SDR50 0x00000001
	188	#define SDHCI_SUPPORT_SDR104 0x00000002
	189	#define SDHCI_SUPPORT_DDR50 0x00000004
	190	#define SDHCI_USE_SDR50_TUNING 0x00002000
	191
a0d0d86f WY	192	#define SDHCI_CLOCK_MUL_MASK 0x00FF0000
a0d0d86f WY	193	#define SDHCI_CLOCK_MUL_SHIFT 16
af62a557 LW	194
	195	#define SDHCI_MAX_CURRENT 0x48
	196
	197	/* 4C-4F reserved for more max current */
	198
	199	#define SDHCI_SET_ACMD12_ERROR 0x50
	200	#define SDHCI_SET_INT_ERROR 0x52
	201
	202	#define SDHCI_ADMA_ERROR 0x54
	203
	204	/* 55-57 reserved */
	205
	206	#define SDHCI_ADMA_ADDRESS 0x58
37cb626d	207	#define SDHCI_ADMA_ADDRESS_HI 0x5c
af62a557 LW	208
	209	/* 60-FB reserved */
	210
	211	#define SDHCI_SLOT_INT_STATUS 0xFC
	212
	213	#define SDHCI_HOST_VERSION 0xFE
	214	#define SDHCI_VENDOR_VER_MASK 0xFF00
	215	#define SDHCI_VENDOR_VER_SHIFT 8
	216	#define SDHCI_SPEC_VER_MASK 0x00FF
	217	#define SDHCI_SPEC_VER_SHIFT 0
	218	#define SDHCI_SPEC_100 0
	219	#define SDHCI_SPEC_200 1
	220	#define SDHCI_SPEC_300 2
	221
113e5dfc JC	222	#define SDHCI_GET_VERSION(x) (x->version & SDHCI_SPEC_VER_MASK)
113e5dfc JC	223
af62a557 LW	224	/*
	225	* End of controller registers.
	226	*/
	227
	228	#define SDHCI_MAX_DIV_SPEC_200 256
	229	#define SDHCI_MAX_DIV_SPEC_300 2046
	230
	231	/*
	232	* quirks
	233	*/
	234	#define SDHCI_QUIRK_32BIT_DMA_ADDR (1 << 0)
5af9a569	235	#define SDHCI_QUIRK_REG32_RW (1 << 1)
3a638320	236	#define SDHCI_QUIRK_BROKEN_R1B (1 << 2)
236bfecf JC	237	#define SDHCI_QUIRK_NO_HISPD_BIT (1 << 3)
236bfecf JC	238	#define SDHCI_QUIRK_BROKEN_VOLTAGE (1 << 4)
88a57125 HS	239	/*
	240	* SDHCI_QUIRK_BROKEN_HISPD_MODE
	241	* the hardware cannot operate correctly in high-speed mode,
	242	* this quirk forces the sdhci host-controller to non high-speed mode
	243	*/
	244	#define SDHCI_QUIRK_BROKEN_HISPD_MODE BIT(5)
13243f2e	245	#define SDHCI_QUIRK_WAIT_SEND_CMD (1 << 6)
113e5dfc	246	#define SDHCI_QUIRK_USE_WIDE8 (1 << 8)
af62a557	247
0d2f15f9 LW	248	/* to make gcc happy */
	249	struct sdhci_host;
	250
af62a557 LW	251	/*
	252	* Host SDMA buffer boundary. Valid values from 4K to 512K in powers of 2.
	253	*/
	254	#define SDHCI_DEFAULT_BOUNDARY_SIZE (512 * 1024)
	255	#define SDHCI_DEFAULT_BOUNDARY_ARG (7)
	256	struct sdhci_ops {
	257	#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
62226b68 JC	258	u32 (read_l)(struct sdhci_host host, int reg);
	259	u16 (read_w)(struct sdhci_host host, int reg);
	260	u8 (read_b)(struct sdhci_host host, int reg);
	261	void (write_l)(struct sdhci_host host, u32 val, int reg);
	262	void (write_w)(struct sdhci_host host, u16 val, int reg);
	263	void (write_b)(struct sdhci_host host, u8 val, int reg);
af62a557	264	#endif
62226b68 JC	265	int (get_cd)(struct sdhci_host host);
62226b68 JC	266	void (set_control_reg)(struct sdhci_host host);
a8185c50	267	int (set_ios_post)(struct sdhci_host host);
62226b68	268	void (set_clock)(struct sdhci_host host, u32 div);
2fc3ed5d SDPP	269	int (platform_execute_tuning)(struct mmc host, u8 opcode);
2fc3ed5d SDPP	270	void (set_delay)(struct sdhci_host host);
cb884347	271	int (deferred_probe)(struct sdhci_host host);
af62a557 LW	272	};
af62a557 LW	273
37cb626d FA	274	#if CONFIG_IS_ENABLED(MMC_SDHCI_ADMA)
	275	#define ADMA_MAX_LEN 65532
	276	#ifdef CONFIG_DMA_ADDR_T_64BIT
	277	#define ADMA_DESC_LEN 16
	278	#else
	279	#define ADMA_DESC_LEN 8
	280	#endif
	281	#define ADMA_TABLE_NO_ENTRIES (CONFIG_SYS_MMC_MAX_BLK_COUNT * \
	282	MMC_MAX_BLOCK_LEN) / ADMA_MAX_LEN
	283
	284	#define ADMA_TABLE_SZ (ADMA_TABLE_NO_ENTRIES * ADMA_DESC_LEN)
	285
	286	/* Decriptor table defines */
	287	#define ADMA_DESC_ATTR_VALID BIT(0)
	288	#define ADMA_DESC_ATTR_END BIT(1)
	289	#define ADMA_DESC_ATTR_INT BIT(2)
	290	#define ADMA_DESC_ATTR_ACT1 BIT(4)
	291	#define ADMA_DESC_ATTR_ACT2 BIT(5)
	292
	293	#define ADMA_DESC_TRANSFER_DATA ADMA_DESC_ATTR_ACT2
	294	#define ADMA_DESC_LINK_DESC (ADMA_DESC_ATTR_ACT1 \| ADMA_DESC_ATTR_ACT2)
	295
	296	struct sdhci_adma_desc {
	297	u8 attr;
	298	u8 reserved;
	299	u16 len;
	300	u32 addr_lo;
	301	#ifdef CONFIG_DMA_ADDR_T_64BIT
	302	u32 addr_hi;
	303	#endif
	304	} __packed;
	305	#endif
af62a557	306	struct sdhci_host {
cacd1d2f	307	const char *name;
af62a557 LW	308	void *ioaddr;
af62a557 LW	309	unsigned int quirks;
236bfecf	310	unsigned int host_caps;
af62a557	311	unsigned int version;
6d0e34bf	312	unsigned int max_clk; /* Maximum Base Clock frequency */
6dffdbc3	313	unsigned int clk_mul; /* Clock Multiplier value */
af62a557	314	unsigned int clock;
6cf1b17c	315	struct mmc *mmc;
af62a557	316	const struct sdhci_ops *ops;
b09ed6e4	317	int index;
236bfecf	318
3577fe8b	319	int bus_width;
0347960b SG	320	struct gpio_desc pwr_gpio; /* Power GPIO */
0347960b SG	321	struct gpio_desc cd_gpio; /* Card Detect GPIO */
3577fe8b	322
236bfecf	323	uint voltages;
93bfd616 PA	324
93bfd616 PA	325	struct mmc_config cfg;
c8cc18b7	326	void *align_buffer;
f5df6aa1	327	bool force_align_buffer;
6d6af205 FA	328	dma_addr_t start_addr;
	329	int flags;
	330	#define USE_SDMA (0x1 << 0)
37cb626d FA	331	#define USE_ADMA (0x1 << 1)
	332	#define USE_ADMA64 (0x1 << 2)
	333	#define USE_DMA (USE_SDMA \| USE_ADMA \| USE_ADMA64)
	334	dma_addr_t adma_addr;
	335	#if CONFIG_IS_ENABLED(MMC_SDHCI_ADMA)
	336	struct sdhci_adma_desc *adma_desc_table;
	337	uint desc_slot;
	338	#endif
af62a557 LW	339	};
	340
	341	#ifdef CONFIG_MMC_SDHCI_IO_ACCESSORS
	342
	343	static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
	344	{
	345	if (unlikely(host->ops->write_l))
	346	host->ops->write_l(host, val, reg);
	347	else
	348	writel(val, host->ioaddr + reg);
	349	}
	350
	351	static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
	352	{
	353	if (unlikely(host->ops->write_w))
	354	host->ops->write_w(host, val, reg);
	355	else
	356	writew(val, host->ioaddr + reg);
	357	}
	358
	359	static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
	360	{
	361	if (unlikely(host->ops->write_b))
	362	host->ops->write_b(host, val, reg);
	363	else
	364	writeb(val, host->ioaddr + reg);
	365	}
	366
	367	static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
	368	{
	369	if (unlikely(host->ops->read_l))
	370	return host->ops->read_l(host, reg);
	371	else
	372	return readl(host->ioaddr + reg);
	373	}
	374
	375	static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
	376	{
	377	if (unlikely(host->ops->read_w))
	378	return host->ops->read_w(host, reg);
	379	else
	380	return readw(host->ioaddr + reg);
	381	}
	382
	383	static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
	384	{
	385	if (unlikely(host->ops->read_b))
	386	return host->ops->read_b(host, reg);
	387	else
	388	return readb(host->ioaddr + reg);
	389	}
	390
	391	#else
	392
	393	static inline void sdhci_writel(struct sdhci_host *host, u32 val, int reg)
	394	{
	395	writel(val, host->ioaddr + reg);
	396	}
	397
	398	static inline void sdhci_writew(struct sdhci_host *host, u16 val, int reg)
	399	{
	400	writew(val, host->ioaddr + reg);
	401	}
	402
403	static inline void sdhci_writeb(struct sdhci_host *host, u8 val, int reg)
404	{
405	writeb(val, host->ioaddr + reg);
406	}
407	static inline u32 sdhci_readl(struct sdhci_host *host, int reg)
408	{
409	return readl(host->ioaddr + reg);
410	}
411
412	static inline u16 sdhci_readw(struct sdhci_host *host, int reg)
413	{
414	return readw(host->ioaddr + reg);
415	}
416
417	static inline u8 sdhci_readb(struct sdhci_host *host, int reg)
418	{
419	return readb(host->ioaddr + reg);
420	}
421	#endif
422
ef1e4eda SG	423	#ifdef CONFIG_BLK
	424	/**
	425	* sdhci_setup_cfg() - Set up the configuration for DWMMC
	426	*
	427	* This is used to set up an SDHCI device when you are using CONFIG_BLK.
	428	*
	429	* This should be called from your MMC driver's probe() method once you have
	430	* the information required.
	431	*
	432	* Generally your driver will have a platform data structure which holds both
	433	* the configuration (struct mmc_config) and the MMC device info (struct mmc).
	434	* For example:
	435	*
	436	* struct msm_sdhc_plat {
	437	* struct mmc_config cfg;
	438	* struct mmc mmc;
	439	* };
	440	*
	441	* ...
	442	*
	443	* Inside U_BOOT_DRIVER():
	444	* .platdata_auto_alloc_size = sizeof(struct msm_sdhc_plat),
	445	*
	446	* To access platform data:
	447	* struct msm_sdhc_plat *plat = dev_get_platdata(dev);
	448	*
	449	* See msm_sdhci.c for an example.
	450	*
	451	* @cfg: Configuration structure to fill in (generally &plat->mmc)
14bed52d	452	* @host: SDHCI host structure
6d0e34bf SH	453	* @f_max: Maximum supported clock frequency in HZ (0 for default)
6d0e34bf SH	454	* @f_min: Minimum supported clock frequency in HZ (0 for default)
ef1e4eda	455	*/
14bed52d	456	int sdhci_setup_cfg(struct mmc_config cfg, struct sdhci_host host,
6d0e34bf	457	u32 f_max, u32 f_min);
ef1e4eda SG	458
	459	/**
	460	* sdhci_bind() - Set up a new MMC block device
	461	*
	462	* This is used to set up an SDHCI block device when you are using CONFIG_BLK.
	463	* It should be called from your driver's bind() method.
	464	*
	465	* See msm_sdhci.c for an example.
	466	*
	467	* @dev: Device to set up
	468	* @mmc: Pointer to mmc structure (normally &plat->mmc)
	469	* @cfg: Empty configuration structure (generally &plat->cfg). This is
	470	* normally all zeroes at this point. The only purpose of passing
	471	* this in is to set mmc->cfg to it.
	472	* @return 0 if OK, -ve if the block device could not be created
	473	*/
	474	int sdhci_bind(struct udevice dev, struct mmc mmc, struct mmc_config *cfg);
	475	#else
	476
	477	/**
	478	* add_sdhci() - Add a new SDHCI interface
	479	*
	480	* This is used when you are not using CONFIG_BLK. Convert your driver over!
	481	*
	482	* @host: SDHCI host structure
6d0e34bf SH	483	* @f_max: Maximum supported clock frequency in HZ (0 for default)
6d0e34bf SH	484	* @f_min: Minimum supported clock frequency in HZ (0 for default)
ef1e4eda SG	485	* @return 0 if OK, -ve on error
ef1e4eda SG	486	*/
6d0e34bf	487	int add_sdhci(struct sdhci_host *host, u32 f_max, u32 f_min);
ef1e4eda SG	488	#endif /* !CONFIG_BLK */
ef1e4eda SG	489
d1c0a220	490	void sdhci_set_uhs_timing(struct sdhci_host *host);
e7881d85	491	#ifdef CONFIG_DM_MMC
ef1e4eda SG	492	/* Export the operations to drivers */
ef1e4eda SG	493	int sdhci_probe(struct udevice *dev);
3966c7d0	494	int sdhci_set_clock(struct mmc *mmc, unsigned int clock);
ef1e4eda SG	495	extern const struct dm_mmc_ops sdhci_ops;
	496	#else
	497	#endif
	498
af62a557	499	#endif /* __SDHCI_HW_H */