xref: /linux/include/linux/mmc/host.h (revision 4359a011e259a4608afc7fb3635370c9d4ba5943)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  *  linux/include/linux/mmc/host.h
4  *
5  *  Host driver specific definitions.
6  */
7 #ifndef LINUX_MMC_HOST_H
8 #define LINUX_MMC_HOST_H
9 
10 #include <linux/sched.h>
11 #include <linux/device.h>
12 #include <linux/fault-inject.h>
13 
14 #include <linux/mmc/core.h>
15 #include <linux/mmc/card.h>
16 #include <linux/mmc/pm.h>
17 #include <linux/dma-direction.h>
18 #include <linux/blk-crypto-profile.h>
19 
20 struct mmc_ios {
21 	unsigned int	clock;			/* clock rate */
22 	unsigned short	vdd;
23 	unsigned int	power_delay_ms;		/* waiting for stable power */
24 
25 /* vdd stores the bit number of the selected voltage range from below. */
26 
27 	unsigned char	bus_mode;		/* command output mode */
28 
29 #define MMC_BUSMODE_OPENDRAIN	1
30 #define MMC_BUSMODE_PUSHPULL	2
31 
32 	unsigned char	chip_select;		/* SPI chip select */
33 
34 #define MMC_CS_DONTCARE		0
35 #define MMC_CS_HIGH		1
36 #define MMC_CS_LOW		2
37 
38 	unsigned char	power_mode;		/* power supply mode */
39 
40 #define MMC_POWER_OFF		0
41 #define MMC_POWER_UP		1
42 #define MMC_POWER_ON		2
43 #define MMC_POWER_UNDEFINED	3
44 
45 	unsigned char	bus_width;		/* data bus width */
46 
47 #define MMC_BUS_WIDTH_1		0
48 #define MMC_BUS_WIDTH_4		2
49 #define MMC_BUS_WIDTH_8		3
50 
51 	unsigned char	timing;			/* timing specification used */
52 
53 #define MMC_TIMING_LEGACY	0
54 #define MMC_TIMING_MMC_HS	1
55 #define MMC_TIMING_SD_HS	2
56 #define MMC_TIMING_UHS_SDR12	3
57 #define MMC_TIMING_UHS_SDR25	4
58 #define MMC_TIMING_UHS_SDR50	5
59 #define MMC_TIMING_UHS_SDR104	6
60 #define MMC_TIMING_UHS_DDR50	7
61 #define MMC_TIMING_MMC_DDR52	8
62 #define MMC_TIMING_MMC_HS200	9
63 #define MMC_TIMING_MMC_HS400	10
64 #define MMC_TIMING_SD_EXP	11
65 #define MMC_TIMING_SD_EXP_1_2V	12
66 
67 	unsigned char	signal_voltage;		/* signalling voltage (1.8V or 3.3V) */
68 
69 #define MMC_SIGNAL_VOLTAGE_330	0
70 #define MMC_SIGNAL_VOLTAGE_180	1
71 #define MMC_SIGNAL_VOLTAGE_120	2
72 
73 	unsigned char	drv_type;		/* driver type (A, B, C, D) */
74 
75 #define MMC_SET_DRIVER_TYPE_B	0
76 #define MMC_SET_DRIVER_TYPE_A	1
77 #define MMC_SET_DRIVER_TYPE_C	2
78 #define MMC_SET_DRIVER_TYPE_D	3
79 
80 	bool enhanced_strobe;			/* hs400es selection */
81 };
82 
83 struct mmc_clk_phase {
84 	bool valid;
85 	u16 in_deg;
86 	u16 out_deg;
87 };
88 
89 #define MMC_NUM_CLK_PHASES (MMC_TIMING_MMC_HS400 + 1)
90 struct mmc_clk_phase_map {
91 	struct mmc_clk_phase phase[MMC_NUM_CLK_PHASES];
92 };
93 
94 struct mmc_host;
95 
96 enum mmc_err_stat {
97 	MMC_ERR_CMD_TIMEOUT,
98 	MMC_ERR_CMD_CRC,
99 	MMC_ERR_DAT_TIMEOUT,
100 	MMC_ERR_DAT_CRC,
101 	MMC_ERR_AUTO_CMD,
102 	MMC_ERR_ADMA,
103 	MMC_ERR_TUNING,
104 	MMC_ERR_CMDQ_RED,
105 	MMC_ERR_CMDQ_GCE,
106 	MMC_ERR_CMDQ_ICCE,
107 	MMC_ERR_REQ_TIMEOUT,
108 	MMC_ERR_CMDQ_REQ_TIMEOUT,
109 	MMC_ERR_ICE_CFG,
110 	MMC_ERR_CTRL_TIMEOUT,
111 	MMC_ERR_UNEXPECTED_IRQ,
112 	MMC_ERR_MAX,
113 };
114 
115 struct mmc_host_ops {
116 	/*
117 	 * It is optional for the host to implement pre_req and post_req in
118 	 * order to support double buffering of requests (prepare one
119 	 * request while another request is active).
120 	 * pre_req() must always be followed by a post_req().
121 	 * To undo a call made to pre_req(), call post_req() with
122 	 * a nonzero err condition.
123 	 */
124 	void	(*post_req)(struct mmc_host *host, struct mmc_request *req,
125 			    int err);
126 	void	(*pre_req)(struct mmc_host *host, struct mmc_request *req);
127 	void	(*request)(struct mmc_host *host, struct mmc_request *req);
128 	/* Submit one request to host in atomic context. */
129 	int	(*request_atomic)(struct mmc_host *host,
130 				  struct mmc_request *req);
131 
132 	/*
133 	 * Avoid calling the next three functions too often or in a "fast
134 	 * path", since underlaying controller might implement them in an
135 	 * expensive and/or slow way. Also note that these functions might
136 	 * sleep, so don't call them in the atomic contexts!
137 	 */
138 
139 	/*
140 	 * Notes to the set_ios callback:
141 	 * ios->clock might be 0. For some controllers, setting 0Hz
142 	 * as any other frequency works. However, some controllers
143 	 * explicitly need to disable the clock. Otherwise e.g. voltage
144 	 * switching might fail because the SDCLK is not really quiet.
145 	 */
146 	void	(*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
147 
148 	/*
149 	 * Return values for the get_ro callback should be:
150 	 *   0 for a read/write card
151 	 *   1 for a read-only card
152 	 *   -ENOSYS when not supported (equal to NULL callback)
153 	 *   or a negative errno value when something bad happened
154 	 */
155 	int	(*get_ro)(struct mmc_host *host);
156 
157 	/*
158 	 * Return values for the get_cd callback should be:
159 	 *   0 for a absent card
160 	 *   1 for a present card
161 	 *   -ENOSYS when not supported (equal to NULL callback)
162 	 *   or a negative errno value when something bad happened
163 	 */
164 	int	(*get_cd)(struct mmc_host *host);
165 
166 	void	(*enable_sdio_irq)(struct mmc_host *host, int enable);
167 	/* Mandatory callback when using MMC_CAP2_SDIO_IRQ_NOTHREAD. */
168 	void	(*ack_sdio_irq)(struct mmc_host *host);
169 
170 	/* optional callback for HC quirks */
171 	void	(*init_card)(struct mmc_host *host, struct mmc_card *card);
172 
173 	int	(*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios);
174 
175 	/* Check if the card is pulling dat[0] low */
176 	int	(*card_busy)(struct mmc_host *host);
177 
178 	/* The tuning command opcode value is different for SD and eMMC cards */
179 	int	(*execute_tuning)(struct mmc_host *host, u32 opcode);
180 
181 	/* Prepare HS400 target operating frequency depending host driver */
182 	int	(*prepare_hs400_tuning)(struct mmc_host *host, struct mmc_ios *ios);
183 
184 	/* Execute HS400 tuning depending host driver */
185 	int	(*execute_hs400_tuning)(struct mmc_host *host, struct mmc_card *card);
186 
187 	/* Prepare switch to DDR during the HS400 init sequence */
188 	int	(*hs400_prepare_ddr)(struct mmc_host *host);
189 
190 	/* Prepare for switching from HS400 to HS200 */
191 	void	(*hs400_downgrade)(struct mmc_host *host);
192 
193 	/* Complete selection of HS400 */
194 	void	(*hs400_complete)(struct mmc_host *host);
195 
196 	/* Prepare enhanced strobe depending host driver */
197 	void	(*hs400_enhanced_strobe)(struct mmc_host *host,
198 					 struct mmc_ios *ios);
199 	int	(*select_drive_strength)(struct mmc_card *card,
200 					 unsigned int max_dtr, int host_drv,
201 					 int card_drv, int *drv_type);
202 	/* Reset the eMMC card via RST_n */
203 	void	(*card_hw_reset)(struct mmc_host *host);
204 	void	(*card_event)(struct mmc_host *host);
205 
206 	/*
207 	 * Optional callback to support controllers with HW issues for multiple
208 	 * I/O. Returns the number of supported blocks for the request.
209 	 */
210 	int	(*multi_io_quirk)(struct mmc_card *card,
211 				  unsigned int direction, int blk_size);
212 
213 	/* Initialize an SD express card, mandatory for MMC_CAP2_SD_EXP. */
214 	int	(*init_sd_express)(struct mmc_host *host, struct mmc_ios *ios);
215 };
216 
217 struct mmc_cqe_ops {
218 	/* Allocate resources, and make the CQE operational */
219 	int	(*cqe_enable)(struct mmc_host *host, struct mmc_card *card);
220 	/* Free resources, and make the CQE non-operational */
221 	void	(*cqe_disable)(struct mmc_host *host);
222 	/*
223 	 * Issue a read, write or DCMD request to the CQE. Also deal with the
224 	 * effect of ->cqe_off().
225 	 */
226 	int	(*cqe_request)(struct mmc_host *host, struct mmc_request *mrq);
227 	/* Free resources (e.g. DMA mapping) associated with the request */
228 	void	(*cqe_post_req)(struct mmc_host *host, struct mmc_request *mrq);
229 	/*
230 	 * Prepare the CQE and host controller to accept non-CQ commands. There
231 	 * is no corresponding ->cqe_on(), instead ->cqe_request() is required
232 	 * to deal with that.
233 	 */
234 	void	(*cqe_off)(struct mmc_host *host);
235 	/*
236 	 * Wait for all CQE tasks to complete. Return an error if recovery
237 	 * becomes necessary.
238 	 */
239 	int	(*cqe_wait_for_idle)(struct mmc_host *host);
240 	/*
241 	 * Notify CQE that a request has timed out. Return false if the request
242 	 * completed or true if a timeout happened in which case indicate if
243 	 * recovery is needed.
244 	 */
245 	bool	(*cqe_timeout)(struct mmc_host *host, struct mmc_request *mrq,
246 			       bool *recovery_needed);
247 	/*
248 	 * Stop all CQE activity and prepare the CQE and host controller to
249 	 * accept recovery commands.
250 	 */
251 	void	(*cqe_recovery_start)(struct mmc_host *host);
252 	/*
253 	 * Clear the queue and call mmc_cqe_request_done() on all requests.
254 	 * Requests that errored will have the error set on the mmc_request
255 	 * (data->error or cmd->error for DCMD).  Requests that did not error
256 	 * will have zero data bytes transferred.
257 	 */
258 	void	(*cqe_recovery_finish)(struct mmc_host *host);
259 };
260 
261 struct mmc_async_req {
262 	/* active mmc request */
263 	struct mmc_request	*mrq;
264 	/*
265 	 * Check error status of completed mmc request.
266 	 * Returns 0 if success otherwise non zero.
267 	 */
268 	enum mmc_blk_status (*err_check)(struct mmc_card *, struct mmc_async_req *);
269 };
270 
271 /**
272  * struct mmc_slot - MMC slot functions
273  *
274  * @cd_irq:		MMC/SD-card slot hotplug detection IRQ or -EINVAL
275  * @handler_priv:	MMC/SD-card slot context
276  *
277  * Some MMC/SD host controllers implement slot-functions like card and
278  * write-protect detection natively. However, a large number of controllers
279  * leave these functions to the CPU. This struct provides a hook to attach
280  * such slot-function drivers.
281  */
282 struct mmc_slot {
283 	int cd_irq;
284 	bool cd_wake_enabled;
285 	void *handler_priv;
286 };
287 
288 /**
289  * mmc_context_info - synchronization details for mmc context
290  * @is_done_rcv		wake up reason was done request
291  * @is_new_req		wake up reason was new request
292  * @is_waiting_last_req	mmc context waiting for single running request
293  * @wait		wait queue
294  */
295 struct mmc_context_info {
296 	bool			is_done_rcv;
297 	bool			is_new_req;
298 	bool			is_waiting_last_req;
299 	wait_queue_head_t	wait;
300 };
301 
302 struct regulator;
303 struct mmc_pwrseq;
304 
305 struct mmc_supply {
306 	struct regulator *vmmc;		/* Card power supply */
307 	struct regulator *vqmmc;	/* Optional Vccq supply */
308 };
309 
310 struct mmc_ctx {
311 	struct task_struct *task;
312 };
313 
314 struct mmc_host {
315 	struct device		*parent;
316 	struct device		class_dev;
317 	int			index;
318 	const struct mmc_host_ops *ops;
319 	struct mmc_pwrseq	*pwrseq;
320 	unsigned int		f_min;
321 	unsigned int		f_max;
322 	unsigned int		f_init;
323 	u32			ocr_avail;
324 	u32			ocr_avail_sdio;	/* SDIO-specific OCR */
325 	u32			ocr_avail_sd;	/* SD-specific OCR */
326 	u32			ocr_avail_mmc;	/* MMC-specific OCR */
327 	struct wakeup_source	*ws;		/* Enable consume of uevents */
328 	u32			max_current_330;
329 	u32			max_current_300;
330 	u32			max_current_180;
331 
332 #define MMC_VDD_165_195		0x00000080	/* VDD voltage 1.65 - 1.95 */
333 #define MMC_VDD_20_21		0x00000100	/* VDD voltage 2.0 ~ 2.1 */
334 #define MMC_VDD_21_22		0x00000200	/* VDD voltage 2.1 ~ 2.2 */
335 #define MMC_VDD_22_23		0x00000400	/* VDD voltage 2.2 ~ 2.3 */
336 #define MMC_VDD_23_24		0x00000800	/* VDD voltage 2.3 ~ 2.4 */
337 #define MMC_VDD_24_25		0x00001000	/* VDD voltage 2.4 ~ 2.5 */
338 #define MMC_VDD_25_26		0x00002000	/* VDD voltage 2.5 ~ 2.6 */
339 #define MMC_VDD_26_27		0x00004000	/* VDD voltage 2.6 ~ 2.7 */
340 #define MMC_VDD_27_28		0x00008000	/* VDD voltage 2.7 ~ 2.8 */
341 #define MMC_VDD_28_29		0x00010000	/* VDD voltage 2.8 ~ 2.9 */
342 #define MMC_VDD_29_30		0x00020000	/* VDD voltage 2.9 ~ 3.0 */
343 #define MMC_VDD_30_31		0x00040000	/* VDD voltage 3.0 ~ 3.1 */
344 #define MMC_VDD_31_32		0x00080000	/* VDD voltage 3.1 ~ 3.2 */
345 #define MMC_VDD_32_33		0x00100000	/* VDD voltage 3.2 ~ 3.3 */
346 #define MMC_VDD_33_34		0x00200000	/* VDD voltage 3.3 ~ 3.4 */
347 #define MMC_VDD_34_35		0x00400000	/* VDD voltage 3.4 ~ 3.5 */
348 #define MMC_VDD_35_36		0x00800000	/* VDD voltage 3.5 ~ 3.6 */
349 
350 	u32			caps;		/* Host capabilities */
351 
352 #define MMC_CAP_4_BIT_DATA	(1 << 0)	/* Can the host do 4 bit transfers */
353 #define MMC_CAP_MMC_HIGHSPEED	(1 << 1)	/* Can do MMC high-speed timing */
354 #define MMC_CAP_SD_HIGHSPEED	(1 << 2)	/* Can do SD high-speed timing */
355 #define MMC_CAP_SDIO_IRQ	(1 << 3)	/* Can signal pending SDIO IRQs */
356 #define MMC_CAP_SPI		(1 << 4)	/* Talks only SPI protocols */
357 #define MMC_CAP_NEEDS_POLL	(1 << 5)	/* Needs polling for card-detection */
358 #define MMC_CAP_8_BIT_DATA	(1 << 6)	/* Can the host do 8 bit transfers */
359 #define MMC_CAP_AGGRESSIVE_PM	(1 << 7)	/* Suspend (e)MMC/SD at idle  */
360 #define MMC_CAP_NONREMOVABLE	(1 << 8)	/* Nonremovable e.g. eMMC */
361 #define MMC_CAP_WAIT_WHILE_BUSY	(1 << 9)	/* Waits while card is busy */
362 #define MMC_CAP_3_3V_DDR	(1 << 11)	/* Host supports eMMC DDR 3.3V */
363 #define MMC_CAP_1_8V_DDR	(1 << 12)	/* Host supports eMMC DDR 1.8V */
364 #define MMC_CAP_1_2V_DDR	(1 << 13)	/* Host supports eMMC DDR 1.2V */
365 #define MMC_CAP_DDR		(MMC_CAP_3_3V_DDR | MMC_CAP_1_8V_DDR | \
366 				 MMC_CAP_1_2V_DDR)
367 #define MMC_CAP_POWER_OFF_CARD	(1 << 14)	/* Can power off after boot */
368 #define MMC_CAP_BUS_WIDTH_TEST	(1 << 15)	/* CMD14/CMD19 bus width ok */
369 #define MMC_CAP_UHS_SDR12	(1 << 16)	/* Host supports UHS SDR12 mode */
370 #define MMC_CAP_UHS_SDR25	(1 << 17)	/* Host supports UHS SDR25 mode */
371 #define MMC_CAP_UHS_SDR50	(1 << 18)	/* Host supports UHS SDR50 mode */
372 #define MMC_CAP_UHS_SDR104	(1 << 19)	/* Host supports UHS SDR104 mode */
373 #define MMC_CAP_UHS_DDR50	(1 << 20)	/* Host supports UHS DDR50 mode */
374 #define MMC_CAP_UHS		(MMC_CAP_UHS_SDR12 | MMC_CAP_UHS_SDR25 | \
375 				 MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR104 | \
376 				 MMC_CAP_UHS_DDR50)
377 #define MMC_CAP_SYNC_RUNTIME_PM	(1 << 21)	/* Synced runtime PM suspends. */
378 #define MMC_CAP_NEED_RSP_BUSY	(1 << 22)	/* Commands with R1B can't use R1. */
379 #define MMC_CAP_DRIVER_TYPE_A	(1 << 23)	/* Host supports Driver Type A */
380 #define MMC_CAP_DRIVER_TYPE_C	(1 << 24)	/* Host supports Driver Type C */
381 #define MMC_CAP_DRIVER_TYPE_D	(1 << 25)	/* Host supports Driver Type D */
382 #define MMC_CAP_DONE_COMPLETE	(1 << 27)	/* RW reqs can be completed within mmc_request_done() */
383 #define MMC_CAP_CD_WAKE		(1 << 28)	/* Enable card detect wake */
384 #define MMC_CAP_CMD_DURING_TFR	(1 << 29)	/* Commands during data transfer */
385 #define MMC_CAP_CMD23		(1 << 30)	/* CMD23 supported. */
386 #define MMC_CAP_HW_RESET	(1 << 31)	/* Reset the eMMC card via RST_n */
387 
388 	u32			caps2;		/* More host capabilities */
389 
390 #define MMC_CAP2_BOOTPART_NOACC	(1 << 0)	/* Boot partition no access */
391 #define MMC_CAP2_FULL_PWR_CYCLE	(1 << 2)	/* Can do full power cycle */
392 #define MMC_CAP2_FULL_PWR_CYCLE_IN_SUSPEND (1 << 3) /* Can do full power cycle in suspend */
393 #define MMC_CAP2_HS200_1_8V_SDR	(1 << 5)        /* can support */
394 #define MMC_CAP2_HS200_1_2V_SDR	(1 << 6)        /* can support */
395 #define MMC_CAP2_HS200		(MMC_CAP2_HS200_1_8V_SDR | \
396 				 MMC_CAP2_HS200_1_2V_SDR)
397 #define MMC_CAP2_SD_EXP		(1 << 7)	/* SD express via PCIe */
398 #define MMC_CAP2_SD_EXP_1_2V	(1 << 8)	/* SD express 1.2V */
399 #define MMC_CAP2_CD_ACTIVE_HIGH	(1 << 10)	/* Card-detect signal active high */
400 #define MMC_CAP2_RO_ACTIVE_HIGH	(1 << 11)	/* Write-protect signal active high */
401 #define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14)	/* Don't power up before scan */
402 #define MMC_CAP2_HS400_1_8V	(1 << 15)	/* Can support HS400 1.8V */
403 #define MMC_CAP2_HS400_1_2V	(1 << 16)	/* Can support HS400 1.2V */
404 #define MMC_CAP2_HS400		(MMC_CAP2_HS400_1_8V | \
405 				 MMC_CAP2_HS400_1_2V)
406 #define MMC_CAP2_HSX00_1_8V	(MMC_CAP2_HS200_1_8V_SDR | MMC_CAP2_HS400_1_8V)
407 #define MMC_CAP2_HSX00_1_2V	(MMC_CAP2_HS200_1_2V_SDR | MMC_CAP2_HS400_1_2V)
408 #define MMC_CAP2_SDIO_IRQ_NOTHREAD (1 << 17)
409 #define MMC_CAP2_NO_WRITE_PROTECT (1 << 18)	/* No physical write protect pin, assume that card is always read-write */
410 #define MMC_CAP2_NO_SDIO	(1 << 19)	/* Do not send SDIO commands during initialization */
411 #define MMC_CAP2_HS400_ES	(1 << 20)	/* Host supports enhanced strobe */
412 #define MMC_CAP2_NO_SD		(1 << 21)	/* Do not send SD commands during initialization */
413 #define MMC_CAP2_NO_MMC		(1 << 22)	/* Do not send (e)MMC commands during initialization */
414 #define MMC_CAP2_CQE		(1 << 23)	/* Has eMMC command queue engine */
415 #define MMC_CAP2_CQE_DCMD	(1 << 24)	/* CQE can issue a direct command */
416 #define MMC_CAP2_AVOID_3_3V	(1 << 25)	/* Host must negotiate down from 3.3V */
417 #define MMC_CAP2_MERGE_CAPABLE	(1 << 26)	/* Host can merge a segment over the segment size */
418 #ifdef CONFIG_MMC_CRYPTO
419 #define MMC_CAP2_CRYPTO		(1 << 27)	/* Host supports inline encryption */
420 #else
421 #define MMC_CAP2_CRYPTO		0
422 #endif
423 #define MMC_CAP2_ALT_GPT_TEGRA	(1 << 28)	/* Host with eMMC that has GPT entry at a non-standard location */
424 
425 	int			fixed_drv_type;	/* fixed driver type for non-removable media */
426 
427 	mmc_pm_flag_t		pm_caps;	/* supported pm features */
428 
429 	/* host specific block data */
430 	unsigned int		max_seg_size;	/* see blk_queue_max_segment_size */
431 	unsigned short		max_segs;	/* see blk_queue_max_segments */
432 	unsigned short		unused;
433 	unsigned int		max_req_size;	/* maximum number of bytes in one req */
434 	unsigned int		max_blk_size;	/* maximum size of one mmc block */
435 	unsigned int		max_blk_count;	/* maximum number of blocks in one req */
436 	unsigned int		max_busy_timeout; /* max busy timeout in ms */
437 
438 	/* private data */
439 	spinlock_t		lock;		/* lock for claim and bus ops */
440 
441 	struct mmc_ios		ios;		/* current io bus settings */
442 
443 	/* group bitfields together to minimize padding */
444 	unsigned int		use_spi_crc:1;
445 	unsigned int		claimed:1;	/* host exclusively claimed */
446 	unsigned int		doing_init_tune:1; /* initial tuning in progress */
447 	unsigned int		can_retune:1;	/* re-tuning can be used */
448 	unsigned int		doing_retune:1;	/* re-tuning in progress */
449 	unsigned int		retune_now:1;	/* do re-tuning at next req */
450 	unsigned int		retune_paused:1; /* re-tuning is temporarily disabled */
451 	unsigned int		retune_crc_disable:1; /* don't trigger retune upon crc */
452 	unsigned int		can_dma_map_merge:1; /* merging can be used */
453 
454 	int			rescan_disable;	/* disable card detection */
455 	int			rescan_entered;	/* used with nonremovable devices */
456 
457 	int			need_retune;	/* re-tuning is needed */
458 	int			hold_retune;	/* hold off re-tuning */
459 	unsigned int		retune_period;	/* re-tuning period in secs */
460 	struct timer_list	retune_timer;	/* for periodic re-tuning */
461 
462 	bool			trigger_card_event; /* card_event necessary */
463 
464 	struct mmc_card		*card;		/* device attached to this host */
465 
466 	wait_queue_head_t	wq;
467 	struct mmc_ctx		*claimer;	/* context that has host claimed */
468 	int			claim_cnt;	/* "claim" nesting count */
469 	struct mmc_ctx		default_ctx;	/* default context */
470 
471 	struct delayed_work	detect;
472 	int			detect_change;	/* card detect flag */
473 	struct mmc_slot		slot;
474 
475 	const struct mmc_bus_ops *bus_ops;	/* current bus driver */
476 
477 	unsigned int		sdio_irqs;
478 	struct task_struct	*sdio_irq_thread;
479 	struct delayed_work	sdio_irq_work;
480 	bool			sdio_irq_pending;
481 	atomic_t		sdio_irq_thread_abort;
482 
483 	mmc_pm_flag_t		pm_flags;	/* requested pm features */
484 
485 	struct led_trigger	*led;		/* activity led */
486 
487 #ifdef CONFIG_REGULATOR
488 	bool			regulator_enabled; /* regulator state */
489 #endif
490 	struct mmc_supply	supply;
491 
492 	struct dentry		*debugfs_root;
493 
494 	/* Ongoing data transfer that allows commands during transfer */
495 	struct mmc_request	*ongoing_mrq;
496 
497 #ifdef CONFIG_FAIL_MMC_REQUEST
498 	struct fault_attr	fail_mmc_request;
499 #endif
500 
501 	unsigned int		actual_clock;	/* Actual HC clock rate */
502 
503 	unsigned int		slotno;	/* used for sdio acpi binding */
504 
505 	int			dsr_req;	/* DSR value is valid */
506 	u32			dsr;	/* optional driver stage (DSR) value */
507 
508 	/* Command Queue Engine (CQE) support */
509 	const struct mmc_cqe_ops *cqe_ops;
510 	void			*cqe_private;
511 	int			cqe_qdepth;
512 	bool			cqe_enabled;
513 	bool			cqe_on;
514 
515 	/* Inline encryption support */
516 #ifdef CONFIG_MMC_CRYPTO
517 	struct blk_crypto_profile crypto_profile;
518 #endif
519 
520 	/* Host Software Queue support */
521 	bool			hsq_enabled;
522 
523 	u32			err_stats[MMC_ERR_MAX];
524 	unsigned long		private[] ____cacheline_aligned;
525 };
526 
527 struct device_node;
528 
529 struct mmc_host *mmc_alloc_host(int extra, struct device *);
530 int mmc_add_host(struct mmc_host *);
531 void mmc_remove_host(struct mmc_host *);
532 void mmc_free_host(struct mmc_host *);
533 void mmc_of_parse_clk_phase(struct mmc_host *host,
534 			    struct mmc_clk_phase_map *map);
535 int mmc_of_parse(struct mmc_host *host);
536 int mmc_of_parse_voltage(struct mmc_host *host, u32 *mask);
537 
538 static inline void *mmc_priv(struct mmc_host *host)
539 {
540 	return (void *)host->private;
541 }
542 
543 static inline struct mmc_host *mmc_from_priv(void *priv)
544 {
545 	return container_of(priv, struct mmc_host, private);
546 }
547 
548 #define mmc_host_is_spi(host)	((host)->caps & MMC_CAP_SPI)
549 
550 #define mmc_dev(x)	((x)->parent)
551 #define mmc_classdev(x)	(&(x)->class_dev)
552 #define mmc_hostname(x)	(dev_name(&(x)->class_dev))
553 
554 void mmc_detect_change(struct mmc_host *, unsigned long delay);
555 void mmc_request_done(struct mmc_host *, struct mmc_request *);
556 void mmc_command_done(struct mmc_host *host, struct mmc_request *mrq);
557 
558 void mmc_cqe_request_done(struct mmc_host *host, struct mmc_request *mrq);
559 
560 /*
561  * May be called from host driver's system/runtime suspend/resume callbacks,
562  * to know if SDIO IRQs has been claimed.
563  */
564 static inline bool sdio_irq_claimed(struct mmc_host *host)
565 {
566 	return host->sdio_irqs > 0;
567 }
568 
569 static inline void mmc_signal_sdio_irq(struct mmc_host *host)
570 {
571 	host->ops->enable_sdio_irq(host, 0);
572 	host->sdio_irq_pending = true;
573 	if (host->sdio_irq_thread)
574 		wake_up_process(host->sdio_irq_thread);
575 }
576 
577 void sdio_signal_irq(struct mmc_host *host);
578 
579 #ifdef CONFIG_REGULATOR
580 int mmc_regulator_set_ocr(struct mmc_host *mmc,
581 			struct regulator *supply,
582 			unsigned short vdd_bit);
583 int mmc_regulator_set_vqmmc(struct mmc_host *mmc, struct mmc_ios *ios);
584 #else
585 static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
586 				 struct regulator *supply,
587 				 unsigned short vdd_bit)
588 {
589 	return 0;
590 }
591 
592 static inline int mmc_regulator_set_vqmmc(struct mmc_host *mmc,
593 					  struct mmc_ios *ios)
594 {
595 	return -EINVAL;
596 }
597 #endif
598 
599 int mmc_regulator_get_supply(struct mmc_host *mmc);
600 
601 static inline int mmc_card_is_removable(struct mmc_host *host)
602 {
603 	return !(host->caps & MMC_CAP_NONREMOVABLE);
604 }
605 
606 static inline int mmc_card_keep_power(struct mmc_host *host)
607 {
608 	return host->pm_flags & MMC_PM_KEEP_POWER;
609 }
610 
611 static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
612 {
613 	return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
614 }
615 
616 /* TODO: Move to private header */
617 static inline int mmc_card_hs(struct mmc_card *card)
618 {
619 	return card->host->ios.timing == MMC_TIMING_SD_HS ||
620 		card->host->ios.timing == MMC_TIMING_MMC_HS;
621 }
622 
623 /* TODO: Move to private header */
624 static inline int mmc_card_uhs(struct mmc_card *card)
625 {
626 	return card->host->ios.timing >= MMC_TIMING_UHS_SDR12 &&
627 		card->host->ios.timing <= MMC_TIMING_UHS_DDR50;
628 }
629 
630 void mmc_retune_timer_stop(struct mmc_host *host);
631 
632 static inline void mmc_retune_needed(struct mmc_host *host)
633 {
634 	if (host->can_retune)
635 		host->need_retune = 1;
636 }
637 
638 static inline bool mmc_can_retune(struct mmc_host *host)
639 {
640 	return host->can_retune == 1;
641 }
642 
643 static inline bool mmc_doing_retune(struct mmc_host *host)
644 {
645 	return host->doing_retune == 1;
646 }
647 
648 static inline bool mmc_doing_tune(struct mmc_host *host)
649 {
650 	return host->doing_retune == 1 || host->doing_init_tune == 1;
651 }
652 
653 static inline enum dma_data_direction mmc_get_dma_dir(struct mmc_data *data)
654 {
655 	return data->flags & MMC_DATA_WRITE ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
656 }
657 
658 static inline void mmc_debugfs_err_stats_inc(struct mmc_host *host,
659 					     enum mmc_err_stat stat)
660 {
661 	host->err_stats[stat] += 1;
662 }
663 
664 int mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error);
665 int mmc_send_abort_tuning(struct mmc_host *host, u32 opcode);
666 int mmc_get_ext_csd(struct mmc_card *card, u8 **new_ext_csd);
667 
668 #endif /* LINUX_MMC_HOST_H */
669