[mirror_ubuntu-bionic-kernel.git] / drivers / mmc / host / dw_mmc.h

/*
 * Synopsys DesignWare Multimedia Card Interface driver
 *  (Based on NXP driver for lpc 31xx)
 *
 * Copyright (C) 2009 NXP Semiconductors
 * Copyright (C) 2009, 2010 Imagination Technologies Ltd.
 *
 * 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.
 */

#ifndef _DW_MMC_H_
#define _DW_MMC_H_

#define DW_MMC_240A		0x240a
#define DW_MMC_280A		0x280a

#define SDMMC_CTRL		0x000
#define SDMMC_PWREN		0x004
#define SDMMC_CLKDIV		0x008
#define SDMMC_CLKSRC		0x00c
#define SDMMC_CLKENA		0x010
#define SDMMC_TMOUT		0x014
#define SDMMC_CTYPE		0x018
#define SDMMC_BLKSIZ		0x01c
#define SDMMC_BYTCNT		0x020
#define SDMMC_INTMASK		0x024
#define SDMMC_CMDARG		0x028
#define SDMMC_CMD		0x02c
#define SDMMC_RESP0		0x030
#define SDMMC_RESP1		0x034
#define SDMMC_RESP2		0x038
#define SDMMC_RESP3		0x03c
#define SDMMC_MINTSTS		0x040
#define SDMMC_RINTSTS		0x044
#define SDMMC_STATUS		0x048
#define SDMMC_FIFOTH		0x04c
#define SDMMC_CDETECT		0x050
#define SDMMC_WRTPRT		0x054
#define SDMMC_GPIO		0x058
#define SDMMC_TCBCNT		0x05c
#define SDMMC_TBBCNT		0x060
#define SDMMC_DEBNCE		0x064
#define SDMMC_USRID		0x068
#define SDMMC_VERID		0x06c
#define SDMMC_HCON		0x070
#define SDMMC_UHS_REG		0x074
#define SDMMC_RST_N		0x078
#define SDMMC_BMOD		0x080
#define SDMMC_PLDMND		0x084
#define SDMMC_DBADDR		0x088
#define SDMMC_IDSTS		0x08c
#define SDMMC_IDINTEN		0x090
#define SDMMC_DSCADDR		0x094
#define SDMMC_BUFADDR		0x098
#define SDMMC_CDTHRCTL		0x100
#define SDMMC_DATA(x)		(x)
/*
* Registers to support idmac 64-bit address mode
*/
#define SDMMC_DBADDRL		0x088
#define SDMMC_DBADDRU		0x08c
#define SDMMC_IDSTS64		0x090
#define SDMMC_IDINTEN64		0x094
#define SDMMC_DSCADDRL		0x098
#define SDMMC_DSCADDRU		0x09c
#define SDMMC_BUFADDRL		0x0A0
#define SDMMC_BUFADDRU		0x0A4

/*
 * Data offset is difference according to Version
 * Lower than 2.40a : data register offest is 0x100
 */
#define DATA_OFFSET		0x100
#define DATA_240A_OFFSET	0x200

/* shift bit field */
#define _SBF(f, v)		((v) << (f))

/* Control register defines */
#define SDMMC_CTRL_USE_IDMAC		BIT(25)
#define SDMMC_CTRL_CEATA_INT_EN		BIT(11)
#define SDMMC_CTRL_SEND_AS_CCSD		BIT(10)
#define SDMMC_CTRL_SEND_CCSD		BIT(9)
#define SDMMC_CTRL_ABRT_READ_DATA	BIT(8)
#define SDMMC_CTRL_SEND_IRQ_RESP	BIT(7)
#define SDMMC_CTRL_READ_WAIT		BIT(6)
#define SDMMC_CTRL_DMA_ENABLE		BIT(5)
#define SDMMC_CTRL_INT_ENABLE		BIT(4)
#define SDMMC_CTRL_DMA_RESET		BIT(2)
#define SDMMC_CTRL_FIFO_RESET		BIT(1)
#define SDMMC_CTRL_RESET		BIT(0)
/* Clock Enable register defines */
#define SDMMC_CLKEN_LOW_PWR		BIT(16)
#define SDMMC_CLKEN_ENABLE		BIT(0)
/* time-out register defines */
#define SDMMC_TMOUT_DATA(n)		_SBF(8, (n))
#define SDMMC_TMOUT_DATA_MSK		0xFFFFFF00
#define SDMMC_TMOUT_RESP(n)		((n) & 0xFF)
#define SDMMC_TMOUT_RESP_MSK		0xFF
/* card-type register defines */
#define SDMMC_CTYPE_8BIT		BIT(16)
#define SDMMC_CTYPE_4BIT		BIT(0)
#define SDMMC_CTYPE_1BIT		0
/* Interrupt status & mask register defines */
#define SDMMC_INT_SDIO(n)		BIT(16 + (n))
#define SDMMC_INT_EBE			BIT(15)
#define SDMMC_INT_ACD			BIT(14)
#define SDMMC_INT_SBE			BIT(13)
#define SDMMC_INT_HLE			BIT(12)
#define SDMMC_INT_FRUN			BIT(11)
#define SDMMC_INT_HTO			BIT(10)
#define SDMMC_INT_VOLT_SWITCH		BIT(10) /* overloads bit 10! */
#define SDMMC_INT_DRTO			BIT(9)
#define SDMMC_INT_RTO			BIT(8)
#define SDMMC_INT_DCRC			BIT(7)
#define SDMMC_INT_RCRC			BIT(6)
#define SDMMC_INT_RXDR			BIT(5)
#define SDMMC_INT_TXDR			BIT(4)
#define SDMMC_INT_DATA_OVER		BIT(3)
#define SDMMC_INT_CMD_DONE		BIT(2)
#define SDMMC_INT_RESP_ERR		BIT(1)
#define SDMMC_INT_CD			BIT(0)
#define SDMMC_INT_ERROR			0xbfc2
/* Command register defines */
#define SDMMC_CMD_START			BIT(31)
#define SDMMC_CMD_USE_HOLD_REG	BIT(29)
#define SDMMC_CMD_VOLT_SWITCH		BIT(28)
#define SDMMC_CMD_CCS_EXP		BIT(23)
#define SDMMC_CMD_CEATA_RD		BIT(22)
#define SDMMC_CMD_UPD_CLK		BIT(21)
#define SDMMC_CMD_INIT			BIT(15)
#define SDMMC_CMD_STOP			BIT(14)
#define SDMMC_CMD_PRV_DAT_WAIT		BIT(13)
#define SDMMC_CMD_SEND_STOP		BIT(12)
#define SDMMC_CMD_STRM_MODE		BIT(11)
#define SDMMC_CMD_DAT_WR		BIT(10)
#define SDMMC_CMD_DAT_EXP		BIT(9)
#define SDMMC_CMD_RESP_CRC		BIT(8)
#define SDMMC_CMD_RESP_LONG		BIT(7)
#define SDMMC_CMD_RESP_EXP		BIT(6)
#define SDMMC_CMD_INDX(n)		((n) & 0x1F)
/* Status register defines */
#define SDMMC_GET_FCNT(x)		(((x)>>17) & 0x1FFF)
#define SDMMC_STATUS_DMA_REQ		BIT(31)
#define SDMMC_STATUS_BUSY		BIT(9)
/* FIFOTH register defines */
#define SDMMC_SET_FIFOTH(m, r, t)	(((m) & 0x7) << 28 | \
					 ((r) & 0xFFF) << 16 | \
					 ((t) & 0xFFF))
/* HCON register defines */
#define DMA_INTERFACE_IDMA		(0x0)
#define DMA_INTERFACE_DWDMA		(0x1)
#define DMA_INTERFACE_GDMA		(0x2)
#define DMA_INTERFACE_NODMA		(0x3)
#define SDMMC_GET_TRANS_MODE(x)		(((x)>>16) & 0x3)
#define SDMMC_GET_SLOT_NUM(x)		((((x)>>1) & 0x1F) + 1)
#define SDMMC_GET_HDATA_WIDTH(x)	(((x)>>7) & 0x7)
#define SDMMC_GET_ADDR_CONFIG(x)	(((x)>>27) & 0x1)
/* Internal DMAC interrupt defines */
#define SDMMC_IDMAC_INT_AI		BIT(9)
#define SDMMC_IDMAC_INT_NI		BIT(8)
#define SDMMC_IDMAC_INT_CES		BIT(5)
#define SDMMC_IDMAC_INT_DU		BIT(4)
#define SDMMC_IDMAC_INT_FBE		BIT(2)
#define SDMMC_IDMAC_INT_RI		BIT(1)
#define SDMMC_IDMAC_INT_TI		BIT(0)
/* Internal DMAC bus mode bits */
#define SDMMC_IDMAC_ENABLE		BIT(7)
#define SDMMC_IDMAC_FB			BIT(1)
#define SDMMC_IDMAC_SWRESET		BIT(0)
/* H/W reset */
#define SDMMC_RST_HWACTIVE		0x1
/* Version ID register define */
#define SDMMC_GET_VERID(x)		((x) & 0xFFFF)
/* Card read threshold */
#define SDMMC_SET_THLD(v, x)		(((v) & 0xFFF) << 16 | (x))
#define SDMMC_CARD_WR_THR_EN		BIT(2)
#define SDMMC_CARD_RD_THR_EN		BIT(0)
/* UHS-1 register defines */
#define SDMMC_UHS_18V			BIT(0)
/* All ctrl reset bits */
#define SDMMC_CTRL_ALL_RESET_FLAGS \
	(SDMMC_CTRL_RESET | SDMMC_CTRL_FIFO_RESET | SDMMC_CTRL_DMA_RESET)

/* FIFO register access macros. These should not change the data endian-ness
 * as they are written to memory to be dealt with by the upper layers */
#define mci_fifo_readw(__reg)	__raw_readw(__reg)
#define mci_fifo_readl(__reg)	__raw_readl(__reg)
#define mci_fifo_readq(__reg)	__raw_readq(__reg)

#define mci_fifo_writew(__value, __reg)	__raw_writew(__reg, __value)
#define mci_fifo_writel(__value, __reg)	__raw_writel(__reg, __value)
#define mci_fifo_writeq(__value, __reg)	__raw_writeq(__reg, __value)

/* Register access macros */
#define mci_readl(dev, reg)			\
	readl_relaxed((dev)->regs + SDMMC_##reg)
#define mci_writel(dev, reg, value)			\
	writel_relaxed((value), (dev)->regs + SDMMC_##reg)

/* 16-bit FIFO access macros */
#define mci_readw(dev, reg)			\
	readw_relaxed((dev)->regs + SDMMC_##reg)
#define mci_writew(dev, reg, value)			\
	writew_relaxed((value), (dev)->regs + SDMMC_##reg)

/* 64-bit FIFO access macros */
#ifdef readq
#define mci_readq(dev, reg)			\
	readq_relaxed((dev)->regs + SDMMC_##reg)
#define mci_writeq(dev, reg, value)			\
	writeq_relaxed((value), (dev)->regs + SDMMC_##reg)
#else
/*
 * Dummy readq implementation for architectures that don't define it.
 *
 * We would assume that none of these architectures would configure
 * the IP block with a 64bit FIFO width, so this code will never be
 * executed on those machines. Defining these macros here keeps the
 * rest of the code free from ifdefs.
 */
#define mci_readq(dev, reg)			\
	(*(volatile u64 __force *)((dev)->regs + SDMMC_##reg))
#define mci_writeq(dev, reg, value)			\
	(*(volatile u64 __force *)((dev)->regs + SDMMC_##reg) = (value))

#define __raw_writeq(__value, __reg) \
	(*(volatile u64 __force *)(__reg) = (__value))
#define __raw_readq(__reg) (*(volatile u64 __force *)(__reg))
#endif

extern int dw_mci_probe(struct dw_mci *host);
extern void dw_mci_remove(struct dw_mci *host);
#ifdef CONFIG_PM_SLEEP
extern int dw_mci_suspend(struct dw_mci *host);
extern int dw_mci_resume(struct dw_mci *host);
#endif

/**
 * struct dw_mci_slot - MMC slot state
 * @mmc: The mmc_host representing this slot.
 * @host: The MMC controller this slot is using.
 * @ctype: Card type for this slot.
 * @mrq: mmc_request currently being processed or waiting to be
 *	processed, or NULL when the slot is idle.
 * @queue_node: List node for placing this node in the @queue list of
 *	&struct dw_mci.
 * @clock: Clock rate configured by set_ios(). Protected by host->lock.
 * @__clk_old: The last clock value that was requested from core.
 *	Keeping track of this helps us to avoid spamming the console.
 * @flags: Random state bits associated with the slot.
 * @id: Number of this slot.
 * @sdio_id: Number of this slot in the SDIO interrupt registers.
 */
struct dw_mci_slot {
	struct mmc_host		*mmc;
	struct dw_mci		*host;

	u32			ctype;

	struct mmc_request	*mrq;
	struct list_head	queue_node;

	unsigned int		clock;
	unsigned int		__clk_old;

	unsigned long		flags;
#define DW_MMC_CARD_PRESENT	0
#define DW_MMC_CARD_NEED_INIT	1
#define DW_MMC_CARD_NO_LOW_PWR	2
#define DW_MMC_CARD_NO_USE_HOLD 3
	int			id;
	int			sdio_id;
};

/**
 * dw_mci driver data - dw-mshc implementation specific driver data.
 * @caps: mmc subsystem specified capabilities of the controller(s).
 * @init: early implementation specific initialization.
 * @set_ios: handle bus specific extensions.
 * @parse_dt: parse implementation specific device tree properties.
 * @execute_tuning: implementation specific tuning procedure.
 *
 * Provide controller implementation specific extensions. The usage of this
 * data structure is fully optional and usage of each member in this structure
 * is optional as well.
 */
struct dw_mci_drv_data {
	unsigned long	*caps;
	int		(*init)(struct dw_mci *host);
	void		(*set_ios)(struct dw_mci *host, struct mmc_ios *ios);
	int		(*parse_dt)(struct dw_mci *host);
	int		(*execute_tuning)(struct dw_mci_slot *slot, u32 opcode);
	int		(*prepare_hs400_tuning)(struct dw_mci *host,
						struct mmc_ios *ios);
	int		(*switch_voltage)(struct mmc_host *mmc,
					  struct mmc_ios *ios);
};
#endif /* _DW_MMC_H_ */
Commit	Line	Data
f95f3850 WN	1	/*
	2	* Synopsys DesignWare Multimedia Card Interface driver
	3	* (Based on NXP driver for lpc 31xx)
	4	*
	5	* Copyright (C) 2009 NXP Semiconductors
	6	* Copyright (C) 2009, 2010 Imagination Technologies Ltd.
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*/
	13
	14	#ifndef _DW_MMC_H_
	15	#define _DW_MMC_H_
	16
4e0a5adf	17	#define DW_MMC_240A 0x240a
7e4bf1bc	18	#define DW_MMC_280A 0x280a
4e0a5adf	19
f95f3850 WN	20	#define SDMMC_CTRL 0x000
	21	#define SDMMC_PWREN 0x004
	22	#define SDMMC_CLKDIV 0x008
	23	#define SDMMC_CLKSRC 0x00c
	24	#define SDMMC_CLKENA 0x010
	25	#define SDMMC_TMOUT 0x014
	26	#define SDMMC_CTYPE 0x018
	27	#define SDMMC_BLKSIZ 0x01c
	28	#define SDMMC_BYTCNT 0x020
	29	#define SDMMC_INTMASK 0x024
	30	#define SDMMC_CMDARG 0x028
	31	#define SDMMC_CMD 0x02c
	32	#define SDMMC_RESP0 0x030
	33	#define SDMMC_RESP1 0x034
	34	#define SDMMC_RESP2 0x038
	35	#define SDMMC_RESP3 0x03c
	36	#define SDMMC_MINTSTS 0x040
	37	#define SDMMC_RINTSTS 0x044
	38	#define SDMMC_STATUS 0x048
	39	#define SDMMC_FIFOTH 0x04c
	40	#define SDMMC_CDETECT 0x050
	41	#define SDMMC_WRTPRT 0x054
	42	#define SDMMC_GPIO 0x058
	43	#define SDMMC_TCBCNT 0x05c
	44	#define SDMMC_TBBCNT 0x060
	45	#define SDMMC_DEBNCE 0x064
	46	#define SDMMC_USRID 0x068
	47	#define SDMMC_VERID 0x06c
	48	#define SDMMC_HCON 0x070
41babf75	49	#define SDMMC_UHS_REG 0x074
935a665e	50	#define SDMMC_RST_N 0x078
f95f3850 WN	51	#define SDMMC_BMOD 0x080
	52	#define SDMMC_PLDMND 0x084
	53	#define SDMMC_DBADDR 0x088
	54	#define SDMMC_IDSTS 0x08c
	55	#define SDMMC_IDINTEN 0x090
	56	#define SDMMC_DSCADDR 0x094
	57	#define SDMMC_BUFADDR 0x098
f1d2736c	58	#define SDMMC_CDTHRCTL 0x100
4e0a5adf	59	#define SDMMC_DATA(x) (x)
69d99fdc PT	60	/*
	61	* Registers to support idmac 64-bit address mode
	62	*/
	63	#define SDMMC_DBADDRL 0x088
	64	#define SDMMC_DBADDRU 0x08c
	65	#define SDMMC_IDSTS64 0x090
	66	#define SDMMC_IDINTEN64 0x094
	67	#define SDMMC_DSCADDRL 0x098
	68	#define SDMMC_DSCADDRU 0x09c
	69	#define SDMMC_BUFADDRL 0x0A0
	70	#define SDMMC_BUFADDRU 0x0A4
4e0a5adf JC	71
	72	/*
	73	* Data offset is difference according to Version
	74	* Lower than 2.40a : data register offest is 0x100
	75	*/
	76	#define DATA_OFFSET 0x100
	77	#define DATA_240A_OFFSET 0x200
f95f3850 WN	78
	79	/* shift bit field */
	80	#define _SBF(f, v) ((v) << (f))
	81
	82	/* Control register defines */
	83	#define SDMMC_CTRL_USE_IDMAC BIT(25)
	84	#define SDMMC_CTRL_CEATA_INT_EN BIT(11)
	85	#define SDMMC_CTRL_SEND_AS_CCSD BIT(10)
	86	#define SDMMC_CTRL_SEND_CCSD BIT(9)
	87	#define SDMMC_CTRL_ABRT_READ_DATA BIT(8)
	88	#define SDMMC_CTRL_SEND_IRQ_RESP BIT(7)
	89	#define SDMMC_CTRL_READ_WAIT BIT(6)
	90	#define SDMMC_CTRL_DMA_ENABLE BIT(5)
	91	#define SDMMC_CTRL_INT_ENABLE BIT(4)
	92	#define SDMMC_CTRL_DMA_RESET BIT(2)
	93	#define SDMMC_CTRL_FIFO_RESET BIT(1)
	94	#define SDMMC_CTRL_RESET BIT(0)
	95	/* Clock Enable register defines */
	96	#define SDMMC_CLKEN_LOW_PWR BIT(16)
	97	#define SDMMC_CLKEN_ENABLE BIT(0)
	98	/* time-out register defines */
	99	#define SDMMC_TMOUT_DATA(n) _SBF(8, (n))
	100	#define SDMMC_TMOUT_DATA_MSK 0xFFFFFF00
	101	#define SDMMC_TMOUT_RESP(n) ((n) & 0xFF)
	102	#define SDMMC_TMOUT_RESP_MSK 0xFF
	103	/* card-type register defines */
	104	#define SDMMC_CTYPE_8BIT BIT(16)
	105	#define SDMMC_CTYPE_4BIT BIT(0)
	106	#define SDMMC_CTYPE_1BIT 0
	107	/* Interrupt status & mask register defines */
1a5c8e1f	108	#define SDMMC_INT_SDIO(n) BIT(16 + (n))
f95f3850 WN	109	#define SDMMC_INT_EBE BIT(15)
	110	#define SDMMC_INT_ACD BIT(14)
	111	#define SDMMC_INT_SBE BIT(13)
	112	#define SDMMC_INT_HLE BIT(12)
	113	#define SDMMC_INT_FRUN BIT(11)
	114	#define SDMMC_INT_HTO BIT(10)
01730558	115	#define SDMMC_INT_VOLT_SWITCH BIT(10) /* overloads bit 10! */
3f7eec62	116	#define SDMMC_INT_DRTO BIT(9)
f95f3850 WN	117	#define SDMMC_INT_RTO BIT(8)
	118	#define SDMMC_INT_DCRC BIT(7)
	119	#define SDMMC_INT_RCRC BIT(6)
	120	#define SDMMC_INT_RXDR BIT(5)
	121	#define SDMMC_INT_TXDR BIT(4)
	122	#define SDMMC_INT_DATA_OVER BIT(3)
	123	#define SDMMC_INT_CMD_DONE BIT(2)
	124	#define SDMMC_INT_RESP_ERR BIT(1)
	125	#define SDMMC_INT_CD BIT(0)
	126	#define SDMMC_INT_ERROR 0xbfc2
	127	/* Command register defines */
	128	#define SDMMC_CMD_START BIT(31)
eede2111	129	#define SDMMC_CMD_USE_HOLD_REG BIT(29)
01730558	130	#define SDMMC_CMD_VOLT_SWITCH BIT(28)
f95f3850 WN	131	#define SDMMC_CMD_CCS_EXP BIT(23)
	132	#define SDMMC_CMD_CEATA_RD BIT(22)
	133	#define SDMMC_CMD_UPD_CLK BIT(21)
	134	#define SDMMC_CMD_INIT BIT(15)
	135	#define SDMMC_CMD_STOP BIT(14)
	136	#define SDMMC_CMD_PRV_DAT_WAIT BIT(13)
	137	#define SDMMC_CMD_SEND_STOP BIT(12)
	138	#define SDMMC_CMD_STRM_MODE BIT(11)
	139	#define SDMMC_CMD_DAT_WR BIT(10)
	140	#define SDMMC_CMD_DAT_EXP BIT(9)
	141	#define SDMMC_CMD_RESP_CRC BIT(8)
	142	#define SDMMC_CMD_RESP_LONG BIT(7)
	143	#define SDMMC_CMD_RESP_EXP BIT(6)
	144	#define SDMMC_CMD_INDX(n) ((n) & 0x1F)
	145	/* Status register defines */
ee5d19b2	146	#define SDMMC_GET_FCNT(x) (((x)>>17) & 0x1FFF)
3a33a94c	147	#define SDMMC_STATUS_DMA_REQ BIT(31)
01730558	148	#define SDMMC_STATUS_BUSY BIT(9)
52426899 SJ	149	/* FIFOTH register defines */
	150	#define SDMMC_SET_FIFOTH(m, r, t) (((m) & 0x7) << 28 \| \
	151	((r) & 0xFFF) << 16 \| \
	152	((t) & 0xFFF))
3fc7eaef SL	153	/* HCON register defines */
	154	#define DMA_INTERFACE_IDMA (0x0)
	155	#define DMA_INTERFACE_DWDMA (0x1)
	156	#define DMA_INTERFACE_GDMA (0x2)
	157	#define DMA_INTERFACE_NODMA (0x3)
	158	#define SDMMC_GET_TRANS_MODE(x) (((x)>>16) & 0x3)
70692752 SL	159	#define SDMMC_GET_SLOT_NUM(x) ((((x)>>1) & 0x1F) + 1)
	160	#define SDMMC_GET_HDATA_WIDTH(x) (((x)>>7) & 0x7)
	161	#define SDMMC_GET_ADDR_CONFIG(x) (((x)>>27) & 0x1)
f95f3850 WN	162	/* Internal DMAC interrupt defines */
	163	#define SDMMC_IDMAC_INT_AI BIT(9)
	164	#define SDMMC_IDMAC_INT_NI BIT(8)
	165	#define SDMMC_IDMAC_INT_CES BIT(5)
	166	#define SDMMC_IDMAC_INT_DU BIT(4)
	167	#define SDMMC_IDMAC_INT_FBE BIT(2)
	168	#define SDMMC_IDMAC_INT_RI BIT(1)
	169	#define SDMMC_IDMAC_INT_TI BIT(0)
	170	/* Internal DMAC bus mode bits */
	171	#define SDMMC_IDMAC_ENABLE BIT(7)
	172	#define SDMMC_IDMAC_FB BIT(1)
	173	#define SDMMC_IDMAC_SWRESET BIT(0)
935a665e SL	174	/* H/W reset */
935a665e SL	175	#define SDMMC_RST_HWACTIVE 0x1
4e0a5adf JC	176	/* Version ID register define */
4e0a5adf JC	177	#define SDMMC_GET_VERID(x) ((x) & 0xFFFF)
f1d2736c	178	/* Card read threshold */
7e4bf1bc JC	179	#define SDMMC_SET_THLD(v, x) (((v) & 0xFFF) << 16 \| (x))
	180	#define SDMMC_CARD_WR_THR_EN BIT(2)
	181	#define SDMMC_CARD_RD_THR_EN BIT(0)
	182	/* UHS-1 register defines */
01730558	183	#define SDMMC_UHS_18V BIT(0)
3a33a94c SR	184	/* All ctrl reset bits */
	185	#define SDMMC_CTRL_ALL_RESET_FLAGS \
	186	(SDMMC_CTRL_RESET \| SDMMC_CTRL_FIFO_RESET \| SDMMC_CTRL_DMA_RESET)
	187
76184ac1 BD	188	/* FIFO register access macros. These should not change the data endian-ness
	189	* as they are written to memory to be dealt with by the upper layers */
	190	#define mci_fifo_readw(__reg) __raw_readw(__reg)
	191	#define mci_fifo_readl(__reg) __raw_readl(__reg)
	192	#define mci_fifo_readq(__reg) __raw_readq(__reg)
	193
	194	#define mci_fifo_writew(__value, __reg) __raw_writew(__reg, __value)
	195	#define mci_fifo_writel(__value, __reg) __raw_writel(__reg, __value)
	196	#define mci_fifo_writeq(__value, __reg) __raw_writeq(__reg, __value)
	197
f95f3850 WN	198	/* Register access macros */
f95f3850 WN	199	#define mci_readl(dev, reg) \
a2f17680	200	readl_relaxed((dev)->regs + SDMMC_##reg)
f95f3850	201	#define mci_writel(dev, reg, value) \
a2f17680	202	writel_relaxed((value), (dev)->regs + SDMMC_##reg)
f95f3850 WN	203
	204	/* 16-bit FIFO access macros */
	205	#define mci_readw(dev, reg) \
a2f17680	206	readw_relaxed((dev)->regs + SDMMC_##reg)
f95f3850	207	#define mci_writew(dev, reg, value) \
a2f17680	208	writew_relaxed((value), (dev)->regs + SDMMC_##reg)
f95f3850 WN	209
	210	/* 64-bit FIFO access macros */
	211	#ifdef readq
	212	#define mci_readq(dev, reg) \
a2f17680	213	readq_relaxed((dev)->regs + SDMMC_##reg)
f95f3850	214	#define mci_writeq(dev, reg, value) \
a2f17680	215	writeq_relaxed((value), (dev)->regs + SDMMC_##reg)
f95f3850 WN	216	#else
	217	/*
	218	* Dummy readq implementation for architectures that don't define it.
	219	*
	220	* We would assume that none of these architectures would configure
	221	* the IP block with a 64bit FIFO width, so this code will never be
	222	* executed on those machines. Defining these macros here keeps the
	223	* rest of the code free from ifdefs.
	224	*/
	225	#define mci_readq(dev, reg) \
892b1e31	226	((volatile u64 __force )((dev)->regs + SDMMC_##reg))
f95f3850	227	#define mci_writeq(dev, reg, value) \
892b1e31	228	((volatile u64 __force )((dev)->regs + SDMMC_##reg) = (value))
76184ac1 BD	229
	230	#define __raw_writeq(__value, __reg) \
	231	((volatile u64 __force )(__reg) = (__value))
	232	#define __raw_readq(__reg) ((volatile u64 __force )(__reg))
f95f3850 WN	233	#endif
f95f3850 WN	234
62ca8034 SH	235	extern int dw_mci_probe(struct dw_mci *host);
62ca8034 SH	236	extern void dw_mci_remove(struct dw_mci *host);
370aede6	237	#ifdef CONFIG_PM_SLEEP
62ca8034 SH	238	extern int dw_mci_suspend(struct dw_mci *host);
	239	extern int dw_mci_resume(struct dw_mci *host);
	240	#endif
	241
0976f16d SJ	242	/**
	243	* struct dw_mci_slot - MMC slot state
	244	* @mmc: The mmc_host representing this slot.
	245	* @host: The MMC controller this slot is using.
0976f16d SJ	246	* @ctype: Card type for this slot.
	247	* @mrq: mmc_request currently being processed or waiting to be
	248	* processed, or NULL when the slot is idle.
	249	* @queue_node: List node for placing this node in the @queue list of
	250	* &struct dw_mci.
	251	* @clock: Clock rate configured by set_ios(). Protected by host->lock.
005d675a JC	252	* @__clk_old: The last clock value that was requested from core.
005d675a JC	253	* Keeping track of this helps us to avoid spamming the console.
0976f16d SJ	254	* @flags: Random state bits associated with the slot.
0976f16d SJ	255	* @id: Number of this slot.
76756234	256	* @sdio_id: Number of this slot in the SDIO interrupt registers.
0976f16d SJ	257	*/
	258	struct dw_mci_slot {
	259	struct mmc_host *mmc;
	260	struct dw_mci *host;
	261
0976f16d SJ	262	u32 ctype;
	263
	264	struct mmc_request *mrq;
	265	struct list_head queue_node;
	266
	267	unsigned int clock;
005d675a	268	unsigned int __clk_old;
0976f16d SJ	269
	270	unsigned long flags;
	271	#define DW_MMC_CARD_PRESENT 0
	272	#define DW_MMC_CARD_NEED_INIT 1
b24c8b26	273	#define DW_MMC_CARD_NO_LOW_PWR 2
aaaaeb7a	274	#define DW_MMC_CARD_NO_USE_HOLD 3
0976f16d	275	int id;
76756234	276	int sdio_id;
0976f16d SJ	277	};
0976f16d SJ	278
800d78bf TA	279	/**
	280	* dw_mci driver data - dw-mshc implementation specific driver data.
	281	* @caps: mmc subsystem specified capabilities of the controller(s).
	282	* @init: early implementation specific initialization.
800d78bf TA	283	* @set_ios: handle bus specific extensions.
800d78bf TA	284	* @parse_dt: parse implementation specific device tree properties.
5532ec51	285	* @execute_tuning: implementation specific tuning procedure.
800d78bf TA	286	*
	287	* Provide controller implementation specific extensions. The usage of this
	288	* data structure is fully optional and usage of each member in this structure
	289	* is optional as well.
	290	*/
	291	struct dw_mci_drv_data {
	292	unsigned long *caps;
	293	int (init)(struct dw_mci host);
800d78bf TA	294	void (set_ios)(struct dw_mci host, struct mmc_ios *ios);
800d78bf TA	295	int (parse_dt)(struct dw_mci host);
9979dbe5	296	int (execute_tuning)(struct dw_mci_slot slot, u32 opcode);
80113132 SJ	297	int (prepare_hs400_tuning)(struct dw_mci host,
80113132 SJ	298	struct mmc_ios *ios);
8f7849c4 ZG	299	int (switch_voltage)(struct mmc_host mmc,
8f7849c4 ZG	300	struct mmc_ios *ios);
800d78bf	301	};
f95f3850	302	#endif /* _DW_MMC_H_ */