xref: /openbmc/linux/drivers/mmc/host/dw_mmc.h (revision c4313e75)
12874c5fdSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */
2f95f3850SWill Newton /*
3f95f3850SWill Newton  * Synopsys DesignWare Multimedia Card Interface driver
4f95f3850SWill Newton  *  (Based on NXP driver for lpc 31xx)
5f95f3850SWill Newton  *
6f95f3850SWill Newton  * Copyright (C) 2009 NXP Semiconductors
7f95f3850SWill Newton  * Copyright (C) 2009, 2010 Imagination Technologies Ltd.
8f95f3850SWill Newton  */
9f95f3850SWill Newton 
10f95f3850SWill Newton #ifndef _DW_MMC_H_
11f95f3850SWill Newton #define _DW_MMC_H_
12f95f3850SWill Newton 
130f21c58cSUlf Hansson #include <linux/scatterlist.h>
140f21c58cSUlf Hansson #include <linux/mmc/core.h>
150f21c58cSUlf Hansson #include <linux/dmaengine.h>
160f21c58cSUlf Hansson #include <linux/reset.h>
172b8ac062SVincent Whitchurch #include <linux/fault-inject.h>
182b8ac062SVincent Whitchurch #include <linux/hrtimer.h>
19b8789ec4SUlf Hansson #include <linux/interrupt.h>
200f21c58cSUlf Hansson 
210f21c58cSUlf Hansson enum dw_mci_state {
220f21c58cSUlf Hansson 	STATE_IDLE = 0,
230f21c58cSUlf Hansson 	STATE_SENDING_CMD,
240f21c58cSUlf Hansson 	STATE_SENDING_DATA,
250f21c58cSUlf Hansson 	STATE_DATA_BUSY,
260f21c58cSUlf Hansson 	STATE_SENDING_STOP,
270f21c58cSUlf Hansson 	STATE_DATA_ERROR,
280f21c58cSUlf Hansson 	STATE_SENDING_CMD11,
290f21c58cSUlf Hansson 	STATE_WAITING_CMD11_DONE,
300f21c58cSUlf Hansson };
310f21c58cSUlf Hansson 
320f21c58cSUlf Hansson enum {
330f21c58cSUlf Hansson 	EVENT_CMD_COMPLETE = 0,
340f21c58cSUlf Hansson 	EVENT_XFER_COMPLETE,
350f21c58cSUlf Hansson 	EVENT_DATA_COMPLETE,
360f21c58cSUlf Hansson 	EVENT_DATA_ERROR,
370f21c58cSUlf Hansson };
380f21c58cSUlf Hansson 
390f21c58cSUlf Hansson enum dw_mci_cookie {
400f21c58cSUlf Hansson 	COOKIE_UNMAPPED,
410f21c58cSUlf Hansson 	COOKIE_PRE_MAPPED,	/* mapped by pre_req() of dwmmc */
420f21c58cSUlf Hansson 	COOKIE_MAPPED,		/* mapped by prepare_data() of dwmmc */
430f21c58cSUlf Hansson };
440f21c58cSUlf Hansson 
450f21c58cSUlf Hansson struct mmc_data;
460f21c58cSUlf Hansson 
470f21c58cSUlf Hansson enum {
480f21c58cSUlf Hansson 	TRANS_MODE_PIO = 0,
490f21c58cSUlf Hansson 	TRANS_MODE_IDMAC,
500f21c58cSUlf Hansson 	TRANS_MODE_EDMAC
510f21c58cSUlf Hansson };
520f21c58cSUlf Hansson 
530f21c58cSUlf Hansson struct dw_mci_dma_slave {
540f21c58cSUlf Hansson 	struct dma_chan *ch;
550f21c58cSUlf Hansson 	enum dma_transfer_direction direction;
560f21c58cSUlf Hansson };
570f21c58cSUlf Hansson 
580f21c58cSUlf Hansson /**
590f21c58cSUlf Hansson  * struct dw_mci - MMC controller state shared between all slots
600f21c58cSUlf Hansson  * @lock: Spinlock protecting the queue and associated data.
610f21c58cSUlf Hansson  * @irq_lock: Spinlock protecting the INTMASK setting.
620f21c58cSUlf Hansson  * @regs: Pointer to MMIO registers.
630f21c58cSUlf Hansson  * @fifo_reg: Pointer to MMIO registers for data FIFO
640f21c58cSUlf Hansson  * @sg: Scatterlist entry currently being processed by PIO code, if any.
650f21c58cSUlf Hansson  * @sg_miter: PIO mapping scatterlist iterator.
664b514fa2SAlexey Roslyakov  * @mrq: The request currently being processed on @slot,
670f21c58cSUlf Hansson  *	or NULL if the controller is idle.
680f21c58cSUlf Hansson  * @cmd: The command currently being sent to the card, or NULL.
690f21c58cSUlf Hansson  * @data: The data currently being transferred, or NULL if no data
700f21c58cSUlf Hansson  *	transfer is in progress.
710f21c58cSUlf Hansson  * @stop_abort: The command currently prepared for stoping transfer.
720f21c58cSUlf Hansson  * @prev_blksz: The former transfer blksz record.
730f21c58cSUlf Hansson  * @timing: Record of current ios timing.
742afcbdb0SZiyuan  * @use_dma: Which DMA channel is in use for the current transfer, zero
752afcbdb0SZiyuan  *	denotes PIO mode.
760f21c58cSUlf Hansson  * @using_dma: Whether DMA is in use for the current transfer.
770f21c58cSUlf Hansson  * @dma_64bit_address: Whether DMA supports 64-bit address mode or not.
780f21c58cSUlf Hansson  * @sg_dma: Bus address of DMA buffer.
790f21c58cSUlf Hansson  * @sg_cpu: Virtual address of DMA buffer.
800f21c58cSUlf Hansson  * @dma_ops: Pointer to platform-specific DMA callbacks.
810f21c58cSUlf Hansson  * @cmd_status: Snapshot of SR taken upon completion of the current
820f21c58cSUlf Hansson  * @ring_size: Buffer size for idma descriptors.
830f21c58cSUlf Hansson  *	command. Only valid when EVENT_CMD_COMPLETE is pending.
840f21c58cSUlf Hansson  * @dms: structure of slave-dma private data.
850f21c58cSUlf Hansson  * @phy_regs: physical address of controller's register map
860f21c58cSUlf Hansson  * @data_status: Snapshot of SR taken upon completion of the current
870f21c58cSUlf Hansson  *	data transfer. Only valid when EVENT_DATA_COMPLETE or
880f21c58cSUlf Hansson  *	EVENT_DATA_ERROR is pending.
890f21c58cSUlf Hansson  * @stop_cmdr: Value to be loaded into CMDR when the stop command is
900f21c58cSUlf Hansson  *	to be sent.
910f21c58cSUlf Hansson  * @dir_status: Direction of current transfer.
920f21c58cSUlf Hansson  * @tasklet: Tasklet running the request state machine.
930f21c58cSUlf Hansson  * @pending_events: Bitmask of events flagged by the interrupt handler
940f21c58cSUlf Hansson  *	to be processed by the tasklet.
950f21c58cSUlf Hansson  * @completed_events: Bitmask of events which the state machine has
960f21c58cSUlf Hansson  *	processed.
970f21c58cSUlf Hansson  * @state: Tasklet state.
980f21c58cSUlf Hansson  * @queue: List of slots waiting for access to the controller.
990f21c58cSUlf Hansson  * @bus_hz: The rate of @mck in Hz. This forms the basis for MMC bus
1000f21c58cSUlf Hansson  *	rate and timeout calculations.
1010f21c58cSUlf Hansson  * @current_speed: Configured rate of the controller.
102*c4313e75SPeter Geis  * @minimum_speed: Stored minimum rate of the controller.
1030f21c58cSUlf Hansson  * @fifoth_val: The value of FIFOTH register.
1040f21c58cSUlf Hansson  * @verid: Denote Version ID.
1050f21c58cSUlf Hansson  * @dev: Device associated with the MMC controller.
1060f21c58cSUlf Hansson  * @pdata: Platform data associated with the MMC controller.
1070f21c58cSUlf Hansson  * @drv_data: Driver specific data for identified variant of the controller
1080f21c58cSUlf Hansson  * @priv: Implementation defined private data.
1090f21c58cSUlf Hansson  * @biu_clk: Pointer to bus interface unit clock instance.
1100f21c58cSUlf Hansson  * @ciu_clk: Pointer to card interface unit clock instance.
1110f21c58cSUlf Hansson  * @slot: Slots sharing this MMC controller.
1120f21c58cSUlf Hansson  * @fifo_depth: depth of FIFO.
113a0361c1aSJun Nie  * @data_addr_override: override fifo reg offset with this value.
114d6fced83SJun Nie  * @wm_aligned: force fifo watermark equal with data length in PIO mode.
115d6fced83SJun Nie  *	Set as true if alignment is needed.
1160f21c58cSUlf Hansson  * @data_shift: log2 of FIFO item size.
1170f21c58cSUlf Hansson  * @part_buf_start: Start index in part_buf.
1180f21c58cSUlf Hansson  * @part_buf_count: Bytes of partial data in part_buf.
1190f21c58cSUlf Hansson  * @part_buf: Simple buffer for partial fifo reads/writes.
1200f21c58cSUlf Hansson  * @push_data: Pointer to FIFO push function.
1210f21c58cSUlf Hansson  * @pull_data: Pointer to FIFO pull function.
1221a6fe7bbSMårten Lindahl  * @quirks: Set of quirks that apply to specific versions of the IP.
1230f21c58cSUlf Hansson  * @vqmmc_enabled: Status of vqmmc, should be true or false.
1240f21c58cSUlf Hansson  * @irq_flags: The flags to be passed to request_irq.
1250f21c58cSUlf Hansson  * @irq: The irq value to be passed to request_irq.
1260f21c58cSUlf Hansson  * @sdio_id0: Number of slot0 in the SDIO interrupt registers.
1270f21c58cSUlf Hansson  * @cmd11_timer: Timer for SD3.0 voltage switch over scheme.
12803de1921SAddy Ke  * @cto_timer: Timer for broken command transfer over scheme.
1290f21c58cSUlf Hansson  * @dto_timer: Timer for broken data transfer over scheme.
1300f21c58cSUlf Hansson  *
1310f21c58cSUlf Hansson  * Locking
1320f21c58cSUlf Hansson  * =======
1330f21c58cSUlf Hansson  *
1340f21c58cSUlf Hansson  * @lock is a softirq-safe spinlock protecting @queue as well as
1354b514fa2SAlexey Roslyakov  * @slot, @mrq and @state. These must always be updated
1360f21c58cSUlf Hansson  * at the same time while holding @lock.
1374b514fa2SAlexey Roslyakov  * The @mrq field of struct dw_mci_slot is also protected by @lock,
1384b514fa2SAlexey Roslyakov  * and must always be written at the same time as the slot is added to
1394b514fa2SAlexey Roslyakov  * @queue.
1400f21c58cSUlf Hansson  *
1410f21c58cSUlf Hansson  * @irq_lock is an irq-safe spinlock protecting the INTMASK register
1420f21c58cSUlf Hansson  * to allow the interrupt handler to modify it directly.  Held for only long
1430f21c58cSUlf Hansson  * enough to read-modify-write INTMASK and no other locks are grabbed when
1440f21c58cSUlf Hansson  * holding this one.
1450f21c58cSUlf Hansson  *
1460f21c58cSUlf Hansson  * @pending_events and @completed_events are accessed using atomic bit
1470f21c58cSUlf Hansson  * operations, so they don't need any locking.
1480f21c58cSUlf Hansson  *
1490f21c58cSUlf Hansson  * None of the fields touched by the interrupt handler need any
1500f21c58cSUlf Hansson  * locking. However, ordering is important: Before EVENT_DATA_ERROR or
1510f21c58cSUlf Hansson  * EVENT_DATA_COMPLETE is set in @pending_events, all data-related
1520f21c58cSUlf Hansson  * interrupts must be disabled and @data_status updated with a
1530f21c58cSUlf Hansson  * snapshot of SR. Similarly, before EVENT_CMD_COMPLETE is set, the
1540f21c58cSUlf Hansson  * CMDRDY interrupt must be disabled and @cmd_status updated with a
1550f21c58cSUlf Hansson  * snapshot of SR, and before EVENT_XFER_COMPLETE can be set, the
1560f21c58cSUlf Hansson  * bytes_xfered field of @data must be written. This is ensured by
1570f21c58cSUlf Hansson  * using barriers.
1580f21c58cSUlf Hansson  */
1590f21c58cSUlf Hansson struct dw_mci {
1600f21c58cSUlf Hansson 	spinlock_t		lock;
1610f21c58cSUlf Hansson 	spinlock_t		irq_lock;
1620f21c58cSUlf Hansson 	void __iomem		*regs;
1630f21c58cSUlf Hansson 	void __iomem		*fifo_reg;
164a0361c1aSJun Nie 	u32			data_addr_override;
165d6fced83SJun Nie 	bool			wm_aligned;
1660f21c58cSUlf Hansson 
1670f21c58cSUlf Hansson 	struct scatterlist	*sg;
1680f21c58cSUlf Hansson 	struct sg_mapping_iter	sg_miter;
1690f21c58cSUlf Hansson 
1700f21c58cSUlf Hansson 	struct mmc_request	*mrq;
1710f21c58cSUlf Hansson 	struct mmc_command	*cmd;
1720f21c58cSUlf Hansson 	struct mmc_data		*data;
1730f21c58cSUlf Hansson 	struct mmc_command	stop_abort;
1740f21c58cSUlf Hansson 	unsigned int		prev_blksz;
1750f21c58cSUlf Hansson 	unsigned char		timing;
1760f21c58cSUlf Hansson 
1770f21c58cSUlf Hansson 	/* DMA interface members*/
1780f21c58cSUlf Hansson 	int			use_dma;
1790f21c58cSUlf Hansson 	int			using_dma;
1800f21c58cSUlf Hansson 	int			dma_64bit_address;
1810f21c58cSUlf Hansson 
1820f21c58cSUlf Hansson 	dma_addr_t		sg_dma;
1830f21c58cSUlf Hansson 	void			*sg_cpu;
1840f21c58cSUlf Hansson 	const struct dw_mci_dma_ops	*dma_ops;
1850f21c58cSUlf Hansson 	/* For idmac */
1860f21c58cSUlf Hansson 	unsigned int		ring_size;
1870f21c58cSUlf Hansson 
1880f21c58cSUlf Hansson 	/* For edmac */
1890f21c58cSUlf Hansson 	struct dw_mci_dma_slave *dms;
1900f21c58cSUlf Hansson 	/* Registers's physical base address */
1910f21c58cSUlf Hansson 	resource_size_t		phy_regs;
1920f21c58cSUlf Hansson 
1930f21c58cSUlf Hansson 	u32			cmd_status;
1940f21c58cSUlf Hansson 	u32			data_status;
1950f21c58cSUlf Hansson 	u32			stop_cmdr;
1960f21c58cSUlf Hansson 	u32			dir_status;
1970f21c58cSUlf Hansson 	struct tasklet_struct	tasklet;
1980f21c58cSUlf Hansson 	unsigned long		pending_events;
1990f21c58cSUlf Hansson 	unsigned long		completed_events;
2000f21c58cSUlf Hansson 	enum dw_mci_state	state;
2010f21c58cSUlf Hansson 	struct list_head	queue;
2020f21c58cSUlf Hansson 
2030f21c58cSUlf Hansson 	u32			bus_hz;
2040f21c58cSUlf Hansson 	u32			current_speed;
205*c4313e75SPeter Geis 	u32			minimum_speed;
2060f21c58cSUlf Hansson 	u32			fifoth_val;
2070f21c58cSUlf Hansson 	u16			verid;
2080f21c58cSUlf Hansson 	struct device		*dev;
2090f21c58cSUlf Hansson 	struct dw_mci_board	*pdata;
2100f21c58cSUlf Hansson 	const struct dw_mci_drv_data	*drv_data;
2110f21c58cSUlf Hansson 	void			*priv;
2120f21c58cSUlf Hansson 	struct clk		*biu_clk;
2130f21c58cSUlf Hansson 	struct clk		*ciu_clk;
214b23475faSJaehoon Chung 	struct dw_mci_slot	*slot;
2150f21c58cSUlf Hansson 
2160f21c58cSUlf Hansson 	/* FIFO push and pull */
2170f21c58cSUlf Hansson 	int			fifo_depth;
2180f21c58cSUlf Hansson 	int			data_shift;
2190f21c58cSUlf Hansson 	u8			part_buf_start;
2200f21c58cSUlf Hansson 	u8			part_buf_count;
2210f21c58cSUlf Hansson 	union {
2220f21c58cSUlf Hansson 		u16		part_buf16;
2230f21c58cSUlf Hansson 		u32		part_buf32;
2240f21c58cSUlf Hansson 		u64		part_buf;
2250f21c58cSUlf Hansson 	};
2260f21c58cSUlf Hansson 	void (*push_data)(struct dw_mci *host, void *buf, int cnt);
2270f21c58cSUlf Hansson 	void (*pull_data)(struct dw_mci *host, void *buf, int cnt);
2280f21c58cSUlf Hansson 
2291a6fe7bbSMårten Lindahl 	u32			quirks;
2300f21c58cSUlf Hansson 	bool			vqmmc_enabled;
2310f21c58cSUlf Hansson 	unsigned long		irq_flags; /* IRQ flags */
2320f21c58cSUlf Hansson 	int			irq;
2330f21c58cSUlf Hansson 
2340f21c58cSUlf Hansson 	int			sdio_id0;
2350f21c58cSUlf Hansson 
2360f21c58cSUlf Hansson 	struct timer_list       cmd11_timer;
23703de1921SAddy Ke 	struct timer_list       cto_timer;
2380f21c58cSUlf Hansson 	struct timer_list       dto_timer;
2392b8ac062SVincent Whitchurch 
2402b8ac062SVincent Whitchurch #ifdef CONFIG_FAULT_INJECTION
2412b8ac062SVincent Whitchurch 	struct fault_attr	fail_data_crc;
2422b8ac062SVincent Whitchurch 	struct hrtimer		fault_timer;
2432b8ac062SVincent Whitchurch #endif
2440f21c58cSUlf Hansson };
2450f21c58cSUlf Hansson 
2460f21c58cSUlf Hansson /* DMA ops for Internal/External DMAC interface */
2470f21c58cSUlf Hansson struct dw_mci_dma_ops {
2480f21c58cSUlf Hansson 	/* DMA Ops */
2490f21c58cSUlf Hansson 	int (*init)(struct dw_mci *host);
2500f21c58cSUlf Hansson 	int (*start)(struct dw_mci *host, unsigned int sg_len);
2510f21c58cSUlf Hansson 	void (*complete)(void *host);
2520f21c58cSUlf Hansson 	void (*stop)(struct dw_mci *host);
2530f21c58cSUlf Hansson 	void (*cleanup)(struct dw_mci *host);
2540f21c58cSUlf Hansson 	void (*exit)(struct dw_mci *host);
2550f21c58cSUlf Hansson };
2560f21c58cSUlf Hansson 
2570f21c58cSUlf Hansson struct dma_pdata;
2580f21c58cSUlf Hansson 
2590f21c58cSUlf Hansson /* Board platform data */
2600f21c58cSUlf Hansson struct dw_mci_board {
2610f21c58cSUlf Hansson 	unsigned int bus_hz; /* Clock speed at the cclk_in pad */
2620f21c58cSUlf Hansson 
2630f21c58cSUlf Hansson 	u32 caps;	/* Capabilities */
2640f21c58cSUlf Hansson 	u32 caps2;	/* More capabilities */
2650f21c58cSUlf Hansson 	u32 pm_caps;	/* PM capabilities */
2660f21c58cSUlf Hansson 	/*
2670f21c58cSUlf Hansson 	 * Override fifo depth. If 0, autodetect it from the FIFOTH register,
2680f21c58cSUlf Hansson 	 * but note that this may not be reliable after a bootloader has used
2690f21c58cSUlf Hansson 	 * it.
2700f21c58cSUlf Hansson 	 */
2710f21c58cSUlf Hansson 	unsigned int fifo_depth;
2720f21c58cSUlf Hansson 
2730f21c58cSUlf Hansson 	/* delay in mS before detecting cards after interrupt */
2740f21c58cSUlf Hansson 	u32 detect_delay_ms;
2750f21c58cSUlf Hansson 
2760f21c58cSUlf Hansson 	struct reset_control *rstc;
2770f21c58cSUlf Hansson 	struct dw_mci_dma_ops *dma_ops;
2780f21c58cSUlf Hansson 	struct dma_pdata *data;
2790f21c58cSUlf Hansson };
2800f21c58cSUlf Hansson 
2811a6fe7bbSMårten Lindahl /* Support for longer data read timeout */
2821a6fe7bbSMårten Lindahl #define DW_MMC_QUIRK_EXTENDED_TMOUT            BIT(0)
2831a6fe7bbSMårten Lindahl 
2844e0a5adfSJaehoon Chung #define DW_MMC_240A		0x240a
2857e4bf1bcSJaehoon Chung #define DW_MMC_280A		0x280a
2864e0a5adfSJaehoon Chung 
287f95f3850SWill Newton #define SDMMC_CTRL		0x000
288f95f3850SWill Newton #define SDMMC_PWREN		0x004
289f95f3850SWill Newton #define SDMMC_CLKDIV		0x008
290f95f3850SWill Newton #define SDMMC_CLKSRC		0x00c
291f95f3850SWill Newton #define SDMMC_CLKENA		0x010
292f95f3850SWill Newton #define SDMMC_TMOUT		0x014
293f95f3850SWill Newton #define SDMMC_CTYPE		0x018
294f95f3850SWill Newton #define SDMMC_BLKSIZ		0x01c
295f95f3850SWill Newton #define SDMMC_BYTCNT		0x020
296f95f3850SWill Newton #define SDMMC_INTMASK		0x024
297f95f3850SWill Newton #define SDMMC_CMDARG		0x028
298f95f3850SWill Newton #define SDMMC_CMD		0x02c
299f95f3850SWill Newton #define SDMMC_RESP0		0x030
300f95f3850SWill Newton #define SDMMC_RESP1		0x034
301f95f3850SWill Newton #define SDMMC_RESP2		0x038
302f95f3850SWill Newton #define SDMMC_RESP3		0x03c
303f95f3850SWill Newton #define SDMMC_MINTSTS		0x040
304f95f3850SWill Newton #define SDMMC_RINTSTS		0x044
305f95f3850SWill Newton #define SDMMC_STATUS		0x048
306f95f3850SWill Newton #define SDMMC_FIFOTH		0x04c
307f95f3850SWill Newton #define SDMMC_CDETECT		0x050
308f95f3850SWill Newton #define SDMMC_WRTPRT		0x054
309f95f3850SWill Newton #define SDMMC_GPIO		0x058
310f95f3850SWill Newton #define SDMMC_TCBCNT		0x05c
311f95f3850SWill Newton #define SDMMC_TBBCNT		0x060
312f95f3850SWill Newton #define SDMMC_DEBNCE		0x064
313f95f3850SWill Newton #define SDMMC_USRID		0x068
314f95f3850SWill Newton #define SDMMC_VERID		0x06c
315f95f3850SWill Newton #define SDMMC_HCON		0x070
31641babf75SJaehoon Chung #define SDMMC_UHS_REG		0x074
317935a665eSShawn Lin #define SDMMC_RST_N		0x078
318f95f3850SWill Newton #define SDMMC_BMOD		0x080
319f95f3850SWill Newton #define SDMMC_PLDMND		0x084
320f95f3850SWill Newton #define SDMMC_DBADDR		0x088
321f95f3850SWill Newton #define SDMMC_IDSTS		0x08c
322f95f3850SWill Newton #define SDMMC_IDINTEN		0x090
323f95f3850SWill Newton #define SDMMC_DSCADDR		0x094
324f95f3850SWill Newton #define SDMMC_BUFADDR		0x098
325f1d2736cSSeungwon Jeon #define SDMMC_CDTHRCTL		0x100
326361c7fe9Sliwei #define SDMMC_UHS_REG_EXT	0x108
327e382ab74Stianshuliang #define SDMMC_DDR_REG		0x10c
328361c7fe9Sliwei #define SDMMC_ENABLE_SHIFT	0x110
3294e0a5adfSJaehoon Chung #define SDMMC_DATA(x)		(x)
33069d99fdcSPrabu Thangamuthu /*
33169d99fdcSPrabu Thangamuthu  * Registers to support idmac 64-bit address mode
33269d99fdcSPrabu Thangamuthu  */
33369d99fdcSPrabu Thangamuthu #define SDMMC_DBADDRL		0x088
33469d99fdcSPrabu Thangamuthu #define SDMMC_DBADDRU		0x08c
33569d99fdcSPrabu Thangamuthu #define SDMMC_IDSTS64		0x090
33669d99fdcSPrabu Thangamuthu #define SDMMC_IDINTEN64		0x094
33769d99fdcSPrabu Thangamuthu #define SDMMC_DSCADDRL		0x098
33869d99fdcSPrabu Thangamuthu #define SDMMC_DSCADDRU		0x09c
33969d99fdcSPrabu Thangamuthu #define SDMMC_BUFADDRL		0x0A0
34069d99fdcSPrabu Thangamuthu #define SDMMC_BUFADDRU		0x0A4
3414e0a5adfSJaehoon Chung 
3424e0a5adfSJaehoon Chung /*
3434e0a5adfSJaehoon Chung  * Data offset is difference according to Version
3444e0a5adfSJaehoon Chung  * Lower than 2.40a : data register offest is 0x100
3454e0a5adfSJaehoon Chung  */
3464e0a5adfSJaehoon Chung #define DATA_OFFSET		0x100
3474e0a5adfSJaehoon Chung #define DATA_240A_OFFSET	0x200
348f95f3850SWill Newton 
349f95f3850SWill Newton /* shift bit field */
350f95f3850SWill Newton #define _SBF(f, v)		((v) << (f))
351f95f3850SWill Newton 
352f95f3850SWill Newton /* Control register defines */
353f95f3850SWill Newton #define SDMMC_CTRL_USE_IDMAC		BIT(25)
354f95f3850SWill Newton #define SDMMC_CTRL_CEATA_INT_EN		BIT(11)
355f95f3850SWill Newton #define SDMMC_CTRL_SEND_AS_CCSD		BIT(10)
356f95f3850SWill Newton #define SDMMC_CTRL_SEND_CCSD		BIT(9)
357f95f3850SWill Newton #define SDMMC_CTRL_ABRT_READ_DATA	BIT(8)
358f95f3850SWill Newton #define SDMMC_CTRL_SEND_IRQ_RESP	BIT(7)
359f95f3850SWill Newton #define SDMMC_CTRL_READ_WAIT		BIT(6)
360f95f3850SWill Newton #define SDMMC_CTRL_DMA_ENABLE		BIT(5)
361f95f3850SWill Newton #define SDMMC_CTRL_INT_ENABLE		BIT(4)
362f95f3850SWill Newton #define SDMMC_CTRL_DMA_RESET		BIT(2)
363f95f3850SWill Newton #define SDMMC_CTRL_FIFO_RESET		BIT(1)
364f95f3850SWill Newton #define SDMMC_CTRL_RESET		BIT(0)
365f95f3850SWill Newton /* Clock Enable register defines */
366f95f3850SWill Newton #define SDMMC_CLKEN_LOW_PWR		BIT(16)
367f95f3850SWill Newton #define SDMMC_CLKEN_ENABLE		BIT(0)
368f95f3850SWill Newton /* time-out register defines */
369f95f3850SWill Newton #define SDMMC_TMOUT_DATA(n)		_SBF(8, (n))
370f95f3850SWill Newton #define SDMMC_TMOUT_DATA_MSK		0xFFFFFF00
371f95f3850SWill Newton #define SDMMC_TMOUT_RESP(n)		((n) & 0xFF)
372f95f3850SWill Newton #define SDMMC_TMOUT_RESP_MSK		0xFF
373f95f3850SWill Newton /* card-type register defines */
374f95f3850SWill Newton #define SDMMC_CTYPE_8BIT		BIT(16)
375f95f3850SWill Newton #define SDMMC_CTYPE_4BIT		BIT(0)
376f95f3850SWill Newton #define SDMMC_CTYPE_1BIT		0
377f95f3850SWill Newton /* Interrupt status & mask register defines */
3781a5c8e1fSShashidhar Hiremath #define SDMMC_INT_SDIO(n)		BIT(16 + (n))
379f95f3850SWill Newton #define SDMMC_INT_EBE			BIT(15)
380f95f3850SWill Newton #define SDMMC_INT_ACD			BIT(14)
381f95f3850SWill Newton #define SDMMC_INT_SBE			BIT(13)
382f95f3850SWill Newton #define SDMMC_INT_HLE			BIT(12)
383f95f3850SWill Newton #define SDMMC_INT_FRUN			BIT(11)
384f95f3850SWill Newton #define SDMMC_INT_HTO			BIT(10)
38501730558SDoug Anderson #define SDMMC_INT_VOLT_SWITCH		BIT(10) /* overloads bit 10! */
3863f7eec62SJaehoon Chung #define SDMMC_INT_DRTO			BIT(9)
387f95f3850SWill Newton #define SDMMC_INT_RTO			BIT(8)
388f95f3850SWill Newton #define SDMMC_INT_DCRC			BIT(7)
389f95f3850SWill Newton #define SDMMC_INT_RCRC			BIT(6)
390f95f3850SWill Newton #define SDMMC_INT_RXDR			BIT(5)
391f95f3850SWill Newton #define SDMMC_INT_TXDR			BIT(4)
392f95f3850SWill Newton #define SDMMC_INT_DATA_OVER		BIT(3)
393f95f3850SWill Newton #define SDMMC_INT_CMD_DONE		BIT(2)
394f95f3850SWill Newton #define SDMMC_INT_RESP_ERR		BIT(1)
395f95f3850SWill Newton #define SDMMC_INT_CD			BIT(0)
396f95f3850SWill Newton #define SDMMC_INT_ERROR			0xbfc2
397f95f3850SWill Newton /* Command register defines */
398f95f3850SWill Newton #define SDMMC_CMD_START			BIT(31)
399eede2111SDinh Nguyen #define SDMMC_CMD_USE_HOLD_REG	BIT(29)
40001730558SDoug Anderson #define SDMMC_CMD_VOLT_SWITCH		BIT(28)
401f95f3850SWill Newton #define SDMMC_CMD_CCS_EXP		BIT(23)
402f95f3850SWill Newton #define SDMMC_CMD_CEATA_RD		BIT(22)
403f95f3850SWill Newton #define SDMMC_CMD_UPD_CLK		BIT(21)
404f95f3850SWill Newton #define SDMMC_CMD_INIT			BIT(15)
405f95f3850SWill Newton #define SDMMC_CMD_STOP			BIT(14)
406f95f3850SWill Newton #define SDMMC_CMD_PRV_DAT_WAIT		BIT(13)
407f95f3850SWill Newton #define SDMMC_CMD_SEND_STOP		BIT(12)
408f95f3850SWill Newton #define SDMMC_CMD_STRM_MODE		BIT(11)
409f95f3850SWill Newton #define SDMMC_CMD_DAT_WR		BIT(10)
410f95f3850SWill Newton #define SDMMC_CMD_DAT_EXP		BIT(9)
411f95f3850SWill Newton #define SDMMC_CMD_RESP_CRC		BIT(8)
412f95f3850SWill Newton #define SDMMC_CMD_RESP_LONG		BIT(7)
413f95f3850SWill Newton #define SDMMC_CMD_RESP_EXP		BIT(6)
414f95f3850SWill Newton #define SDMMC_CMD_INDX(n)		((n) & 0x1F)
415f95f3850SWill Newton /* Status register defines */
416ee5d19b2SJaehoon Chung #define SDMMC_GET_FCNT(x)		(((x)>>17) & 0x1FFF)
4173a33a94cSSonny Rao #define SDMMC_STATUS_DMA_REQ		BIT(31)
41801730558SDoug Anderson #define SDMMC_STATUS_BUSY		BIT(9)
41952426899SSeungwon Jeon /* FIFOTH register defines */
42052426899SSeungwon Jeon #define SDMMC_SET_FIFOTH(m, r, t)	(((m) & 0x7) << 28 | \
42152426899SSeungwon Jeon 					 ((r) & 0xFFF) << 16 | \
42252426899SSeungwon Jeon 					 ((t) & 0xFFF))
4233fc7eaefSShawn Lin /* HCON register defines */
4243fc7eaefSShawn Lin #define DMA_INTERFACE_IDMA		(0x0)
4253fc7eaefSShawn Lin #define DMA_INTERFACE_DWDMA		(0x1)
4263fc7eaefSShawn Lin #define DMA_INTERFACE_GDMA		(0x2)
4273fc7eaefSShawn Lin #define DMA_INTERFACE_NODMA		(0x3)
4283fc7eaefSShawn Lin #define SDMMC_GET_TRANS_MODE(x)		(((x)>>16) & 0x3)
42970692752SShawn Lin #define SDMMC_GET_SLOT_NUM(x)		((((x)>>1) & 0x1F) + 1)
43070692752SShawn Lin #define SDMMC_GET_HDATA_WIDTH(x)	(((x)>>7) & 0x7)
43170692752SShawn Lin #define SDMMC_GET_ADDR_CONFIG(x)	(((x)>>27) & 0x1)
432f95f3850SWill Newton /* Internal DMAC interrupt defines */
433f95f3850SWill Newton #define SDMMC_IDMAC_INT_AI		BIT(9)
434f95f3850SWill Newton #define SDMMC_IDMAC_INT_NI		BIT(8)
435f95f3850SWill Newton #define SDMMC_IDMAC_INT_CES		BIT(5)
436f95f3850SWill Newton #define SDMMC_IDMAC_INT_DU		BIT(4)
437f95f3850SWill Newton #define SDMMC_IDMAC_INT_FBE		BIT(2)
438f95f3850SWill Newton #define SDMMC_IDMAC_INT_RI		BIT(1)
439f95f3850SWill Newton #define SDMMC_IDMAC_INT_TI		BIT(0)
440f95f3850SWill Newton /* Internal DMAC bus mode bits */
441f95f3850SWill Newton #define SDMMC_IDMAC_ENABLE		BIT(7)
442f95f3850SWill Newton #define SDMMC_IDMAC_FB			BIT(1)
443f95f3850SWill Newton #define SDMMC_IDMAC_SWRESET		BIT(0)
444935a665eSShawn Lin /* H/W reset */
445935a665eSShawn Lin #define SDMMC_RST_HWACTIVE		0x1
4464e0a5adfSJaehoon Chung /* Version ID register define */
4474e0a5adfSJaehoon Chung #define SDMMC_GET_VERID(x)		((x) & 0xFFFF)
448f1d2736cSSeungwon Jeon /* Card read threshold */
4497e4bf1bcSJaehoon Chung #define SDMMC_SET_THLD(v, x)		(((v) & 0xFFF) << 16 | (x))
4507e4bf1bcSJaehoon Chung #define SDMMC_CARD_WR_THR_EN		BIT(2)
4517e4bf1bcSJaehoon Chung #define SDMMC_CARD_RD_THR_EN		BIT(0)
4527e4bf1bcSJaehoon Chung /* UHS-1 register defines */
453e382ab74Stianshuliang #define SDMMC_UHS_DDR			BIT(16)
45401730558SDoug Anderson #define SDMMC_UHS_18V			BIT(0)
455e382ab74Stianshuliang /* DDR register defines */
456e382ab74Stianshuliang #define SDMMC_DDR_HS400			BIT(31)
457e382ab74Stianshuliang /* Enable shift register defines */
458e382ab74Stianshuliang #define SDMMC_ENABLE_PHASE		BIT(0)
4593a33a94cSSonny Rao /* All ctrl reset bits */
4603a33a94cSSonny Rao #define SDMMC_CTRL_ALL_RESET_FLAGS \
4613a33a94cSSonny Rao 	(SDMMC_CTRL_RESET | SDMMC_CTRL_FIFO_RESET | SDMMC_CTRL_DMA_RESET)
4623a33a94cSSonny Rao 
46376184ac1SBen Dooks /* FIFO register access macros. These should not change the data endian-ness
4644b514fa2SAlexey Roslyakov  * as they are written to memory to be dealt with by the upper layers
4654b514fa2SAlexey Roslyakov  */
46676184ac1SBen Dooks #define mci_fifo_readw(__reg)	__raw_readw(__reg)
46776184ac1SBen Dooks #define mci_fifo_readl(__reg)	__raw_readl(__reg)
46876184ac1SBen Dooks #define mci_fifo_readq(__reg)	__raw_readq(__reg)
46976184ac1SBen Dooks 
47076184ac1SBen Dooks #define mci_fifo_writew(__value, __reg)	__raw_writew(__reg, __value)
47176184ac1SBen Dooks #define mci_fifo_writel(__value, __reg)	__raw_writel(__reg, __value)
47276184ac1SBen Dooks #define mci_fifo_writeq(__value, __reg)	__raw_writeq(__reg, __value)
47376184ac1SBen Dooks 
474f95f3850SWill Newton /* Register access macros */
475f95f3850SWill Newton #define mci_readl(dev, reg)			\
476a2f17680SBen Dooks 	readl_relaxed((dev)->regs + SDMMC_##reg)
477f95f3850SWill Newton #define mci_writel(dev, reg, value)			\
478a2f17680SBen Dooks 	writel_relaxed((value), (dev)->regs + SDMMC_##reg)
479f95f3850SWill Newton 
480f95f3850SWill Newton /* 16-bit FIFO access macros */
481f95f3850SWill Newton #define mci_readw(dev, reg)			\
482a2f17680SBen Dooks 	readw_relaxed((dev)->regs + SDMMC_##reg)
483f95f3850SWill Newton #define mci_writew(dev, reg, value)			\
484a2f17680SBen Dooks 	writew_relaxed((value), (dev)->regs + SDMMC_##reg)
485f95f3850SWill Newton 
486f95f3850SWill Newton /* 64-bit FIFO access macros */
487f95f3850SWill Newton #ifdef readq
488f95f3850SWill Newton #define mci_readq(dev, reg)			\
489a2f17680SBen Dooks 	readq_relaxed((dev)->regs + SDMMC_##reg)
490f95f3850SWill Newton #define mci_writeq(dev, reg, value)			\
491a2f17680SBen Dooks 	writeq_relaxed((value), (dev)->regs + SDMMC_##reg)
492f95f3850SWill Newton #else
493f95f3850SWill Newton /*
494f95f3850SWill Newton  * Dummy readq implementation for architectures that don't define it.
495f95f3850SWill Newton  *
496f95f3850SWill Newton  * We would assume that none of these architectures would configure
497f95f3850SWill Newton  * the IP block with a 64bit FIFO width, so this code will never be
498f95f3850SWill Newton  * executed on those machines. Defining these macros here keeps the
499f95f3850SWill Newton  * rest of the code free from ifdefs.
500f95f3850SWill Newton  */
501f95f3850SWill Newton #define mci_readq(dev, reg)			\
502892b1e31SJames Hogan 	(*(volatile u64 __force *)((dev)->regs + SDMMC_##reg))
503f95f3850SWill Newton #define mci_writeq(dev, reg, value)			\
504892b1e31SJames Hogan 	(*(volatile u64 __force *)((dev)->regs + SDMMC_##reg) = (value))
50576184ac1SBen Dooks 
50676184ac1SBen Dooks #define __raw_writeq(__value, __reg) \
50776184ac1SBen Dooks 	(*(volatile u64 __force *)(__reg) = (__value))
50876184ac1SBen Dooks #define __raw_readq(__reg) (*(volatile u64 __force *)(__reg))
509f95f3850SWill Newton #endif
510f95f3850SWill Newton 
51162ca8034SShashidhar Hiremath extern int dw_mci_probe(struct dw_mci *host);
51262ca8034SShashidhar Hiremath extern void dw_mci_remove(struct dw_mci *host);
513e9ed8835SShawn Lin #ifdef CONFIG_PM
514e9ed8835SShawn Lin extern int dw_mci_runtime_suspend(struct device *device);
515e9ed8835SShawn Lin extern int dw_mci_runtime_resume(struct device *device);
51662ca8034SShashidhar Hiremath #endif
51762ca8034SShashidhar Hiremath 
518800d78bfSThomas Abraham /**
5190976f16dSSeungwon Jeon  * struct dw_mci_slot - MMC slot state
5200976f16dSSeungwon Jeon  * @mmc: The mmc_host representing this slot.
5210976f16dSSeungwon Jeon  * @host: The MMC controller this slot is using.
5220976f16dSSeungwon Jeon  * @ctype: Card type for this slot.
5230976f16dSSeungwon Jeon  * @mrq: mmc_request currently being processed or waiting to be
5240976f16dSSeungwon Jeon  *	processed, or NULL when the slot is idle.
5250976f16dSSeungwon Jeon  * @queue_node: List node for placing this node in the @queue list of
5260976f16dSSeungwon Jeon  *	&struct dw_mci.
5270976f16dSSeungwon Jeon  * @clock: Clock rate configured by set_ios(). Protected by host->lock.
528005d675aSJaehoon Chung  * @__clk_old: The last clock value that was requested from core.
529005d675aSJaehoon Chung  *	Keeping track of this helps us to avoid spamming the console.
5300976f16dSSeungwon Jeon  * @flags: Random state bits associated with the slot.
5310976f16dSSeungwon Jeon  * @id: Number of this slot.
53276756234SAddy Ke  * @sdio_id: Number of this slot in the SDIO interrupt registers.
5330976f16dSSeungwon Jeon  */
5340976f16dSSeungwon Jeon struct dw_mci_slot {
5350976f16dSSeungwon Jeon 	struct mmc_host		*mmc;
5360976f16dSSeungwon Jeon 	struct dw_mci		*host;
5370976f16dSSeungwon Jeon 
5380976f16dSSeungwon Jeon 	u32			ctype;
5390976f16dSSeungwon Jeon 
5400976f16dSSeungwon Jeon 	struct mmc_request	*mrq;
5410976f16dSSeungwon Jeon 	struct list_head	queue_node;
5420976f16dSSeungwon Jeon 
5430976f16dSSeungwon Jeon 	unsigned int		clock;
544005d675aSJaehoon Chung 	unsigned int		__clk_old;
5450976f16dSSeungwon Jeon 
5460976f16dSSeungwon Jeon 	unsigned long		flags;
5470976f16dSSeungwon Jeon #define DW_MMC_CARD_PRESENT	0
5480976f16dSSeungwon Jeon #define DW_MMC_CARD_NEED_INIT	1
549b24c8b26SDoug Anderson #define DW_MMC_CARD_NO_LOW_PWR	2
550aaaaeb7aSJaehoon Chung #define DW_MMC_CARD_NO_USE_HOLD 3
551e6cd7a8eSJaehoon Chung #define DW_MMC_CARD_NEEDS_POLL	4
5520976f16dSSeungwon Jeon 	int			id;
55376756234SAddy Ke 	int			sdio_id;
5540976f16dSSeungwon Jeon };
5550976f16dSSeungwon Jeon 
5560976f16dSSeungwon Jeon /**
557800d78bfSThomas Abraham  * dw_mci driver data - dw-mshc implementation specific driver data.
558800d78bfSThomas Abraham  * @caps: mmc subsystem specified capabilities of the controller(s).
5590d84b9e5SShawn Lin  * @num_caps: number of capabilities specified by @caps.
5600dc7a3ecSJohn Keeping  * @common_caps: mmc subsystem specified capabilities applicable to all of
5610dc7a3ecSJohn Keeping  *	the controllers
562800d78bfSThomas Abraham  * @init: early implementation specific initialization.
563800d78bfSThomas Abraham  * @set_ios: handle bus specific extensions.
564800d78bfSThomas Abraham  * @parse_dt: parse implementation specific device tree properties.
5655532ec51SSachin Kamat  * @execute_tuning: implementation specific tuning procedure.
56625d5417aSMårten Lindahl  * @set_data_timeout: implementation specific timeout.
56725d5417aSMårten Lindahl  * @get_drto_clks: implementation specific cycle count for data read timeout.
568800d78bfSThomas Abraham  *
569800d78bfSThomas Abraham  * Provide controller implementation specific extensions. The usage of this
570800d78bfSThomas Abraham  * data structure is fully optional and usage of each member in this structure
571800d78bfSThomas Abraham  * is optional as well.
572800d78bfSThomas Abraham  */
573800d78bfSThomas Abraham struct dw_mci_drv_data {
574800d78bfSThomas Abraham 	unsigned long	*caps;
5750d84b9e5SShawn Lin 	u32		num_caps;
5760dc7a3ecSJohn Keeping 	u32		common_caps;
577800d78bfSThomas Abraham 	int		(*init)(struct dw_mci *host);
578800d78bfSThomas Abraham 	void		(*set_ios)(struct dw_mci *host, struct mmc_ios *ios);
579800d78bfSThomas Abraham 	int		(*parse_dt)(struct dw_mci *host);
5809979dbe5SChaotian Jing 	int		(*execute_tuning)(struct dw_mci_slot *slot, u32 opcode);
58180113132SSeungwon Jeon 	int		(*prepare_hs400_tuning)(struct dw_mci *host,
58280113132SSeungwon Jeon 						struct mmc_ios *ios);
5838f7849c4SZhangfei Gao 	int		(*switch_voltage)(struct mmc_host *mmc,
5848f7849c4SZhangfei Gao 					  struct mmc_ios *ios);
58525d5417aSMårten Lindahl 	void		(*set_data_timeout)(struct dw_mci *host,
58625d5417aSMårten Lindahl 					  unsigned int timeout_ns);
58725d5417aSMårten Lindahl 	u32		(*get_drto_clks)(struct dw_mci *host);
588800d78bfSThomas Abraham };
589f95f3850SWill Newton #endif /* _DW_MMC_H_ */
590