blob: 00fe0b3d2039ab618a636ff4acd5f2c274f98189 [file] [log] [blame]
Thomas Gleixnerd2912cb2019-06-04 10:11:33 +02001/* SPDX-License-Identifier: GPL-2.0-only */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/include/linux/mmc/host.h
4 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Host driver specific definitions.
6 */
7#ifndef LINUX_MMC_HOST_H
8#define LINUX_MMC_HOST_H
9
Alexey Dobriyand43c36d2009-10-07 17:09:06 +040010#include <linux/sched.h>
Paul Gortmaker313162d2012-01-30 11:46:54 -050011#include <linux/device.h>
Per Forlin1b676f72011-08-19 14:52:37 +020012#include <linux/fault-inject.h>
Pierre Ossmanaf8350c2007-09-24 07:15:48 +020013
Pierre Ossmanaaac1b42007-02-28 15:33:10 +010014#include <linux/mmc/core.h>
Seungwon Jeoncdc99172014-04-23 17:07:35 +090015#include <linux/mmc/card.h>
Nicolas Pitreda68c4e2010-03-05 13:43:31 -080016#include <linux/mmc/pm.h>
Heiner Kallweit6335d682017-03-26 20:41:32 +020017#include <linux/dma-direction.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
19struct mmc_ios {
20 unsigned int clock; /* clock rate */
21 unsigned short vdd;
Shawn Lin6d796c62018-05-08 09:04:20 +080022 unsigned int power_delay_ms; /* waiting for stable power */
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Philip Langdale4be34c92007-03-11 17:15:15 -070024/* vdd stores the bit number of the selected voltage range from below. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26 unsigned char bus_mode; /* command output mode */
27
28#define MMC_BUSMODE_OPENDRAIN 1
29#define MMC_BUSMODE_PUSHPULL 2
30
Pierre Ossman865e9f12005-09-03 16:45:02 +010031 unsigned char chip_select; /* SPI chip select */
32
33#define MMC_CS_DONTCARE 0
34#define MMC_CS_HIGH 1
35#define MMC_CS_LOW 2
36
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 unsigned char power_mode; /* power supply mode */
38
39#define MMC_POWER_OFF 0
40#define MMC_POWER_UP 1
41#define MMC_POWER_ON 2
Roger Tseng8af465d2014-09-24 17:07:13 +080042#define MMC_POWER_UNDEFINED 3
Pierre Ossmanf2182782005-09-06 15:18:55 -070043
44 unsigned char bus_width; /* data bus width */
45
46#define MMC_BUS_WIDTH_1 0
47#define MMC_BUS_WIDTH_4 2
Jarkko Lavinenb30f8af2008-11-17 14:35:21 +020048#define MMC_BUS_WIDTH_8 3
Pierre Ossmancd9277c2007-02-18 12:07:47 +010049
50 unsigned char timing; /* timing specification used */
51
52#define MMC_TIMING_LEGACY 0
53#define MMC_TIMING_MMC_HS 1
54#define MMC_TIMING_SD_HS 2
Kevin Liued9dbb62012-10-17 19:04:46 +080055#define MMC_TIMING_UHS_SDR12 3
56#define MMC_TIMING_UHS_SDR25 4
57#define MMC_TIMING_UHS_SDR50 5
58#define MMC_TIMING_UHS_SDR104 6
59#define MMC_TIMING_UHS_DDR50 7
Seungwon Jeon79f7ae72014-03-14 21:11:56 +090060#define MMC_TIMING_MMC_DDR52 8
61#define MMC_TIMING_MMC_HS200 9
Seungwon Jeon0a5b6432014-04-23 17:14:58 +090062#define MMC_TIMING_MMC_HS400 10
Adrian Hunter0f8d8ea2010-08-24 13:20:26 +030063
Arindam Nathf2119df2011-05-05 12:18:57 +053064 unsigned char signal_voltage; /* signalling voltage (1.8V or 3.3V) */
65
66#define MMC_SIGNAL_VOLTAGE_330 0
67#define MMC_SIGNAL_VOLTAGE_180 1
Philip Rakity4c4cb172011-05-13 11:17:18 +053068#define MMC_SIGNAL_VOLTAGE_120 2
Arindam Nathd6d50a12011-05-05 12:18:59 +053069
70 unsigned char drv_type; /* driver type (A, B, C, D) */
71
72#define MMC_SET_DRIVER_TYPE_B 0
73#define MMC_SET_DRIVER_TYPE_A 1
74#define MMC_SET_DRIVER_TYPE_C 2
75#define MMC_SET_DRIVER_TYPE_D 3
Shawn Lin81ac2af2016-05-26 09:56:22 +080076
77 bool enhanced_strobe; /* hs400es selection */
Linus Torvalds1da177e2005-04-16 15:20:36 -070078};
79
Ulf Hansson8da00732017-01-13 14:14:06 +010080struct mmc_host;
81
Linus Torvalds1da177e2005-04-16 15:20:36 -070082struct mmc_host_ops {
Adrian Hunter8ea926b2009-09-22 16:44:29 -070083 /*
Per Forlinaa8b6832011-07-01 18:55:22 +020084 * It is optional for the host to implement pre_req and post_req in
85 * order to support double buffering of requests (prepare one
86 * request while another request is active).
Per Forlin7c8a2822011-08-29 15:35:58 +020087 * pre_req() must always be followed by a post_req().
88 * To undo a call made to pre_req(), call post_req() with
89 * a nonzero err condition.
Per Forlinaa8b6832011-07-01 18:55:22 +020090 */
91 void (*post_req)(struct mmc_host *host, struct mmc_request *req,
92 int err);
Linus Walleijd3c6aac2016-11-23 11:02:24 +010093 void (*pre_req)(struct mmc_host *host, struct mmc_request *req);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 void (*request)(struct mmc_host *host, struct mmc_request *req);
Wolfram Sang93b69112016-04-01 17:44:36 +020095
Anton Vorontsov28f52482008-06-17 18:17:15 +040096 /*
Wolfram Sang93b69112016-04-01 17:44:36 +020097 * Avoid calling the next three functions too often or in a "fast
98 * path", since underlaying controller might implement them in an
99 * expensive and/or slow way. Also note that these functions might
100 * sleep, so don't call them in the atomic contexts!
101 */
102
103 /*
104 * Notes to the set_ios callback:
105 * ios->clock might be 0. For some controllers, setting 0Hz
106 * as any other frequency works. However, some controllers
107 * explicitly need to disable the clock. Otherwise e.g. voltage
108 * switching might fail because the SDCLK is not really quiet.
109 */
110 void (*set_ios)(struct mmc_host *host, struct mmc_ios *ios);
111
112 /*
Anton Vorontsov08f80bb2008-06-17 18:17:39 +0400113 * Return values for the get_ro callback should be:
114 * 0 for a read/write card
115 * 1 for a read-only card
116 * -ENOSYS when not supported (equal to NULL callback)
117 * or a negative errno value when something bad happened
Wolfram Sang93b69112016-04-01 17:44:36 +0200118 */
119 int (*get_ro)(struct mmc_host *host);
120
121 /*
Thomas Petazzoniee63a7d22008-09-02 10:14:13 +0200122 * Return values for the get_cd callback should be:
Anton Vorontsov08f80bb2008-06-17 18:17:39 +0400123 * 0 for a absent card
124 * 1 for a present card
125 * -ENOSYS when not supported (equal to NULL callback)
126 * or a negative errno value when something bad happened
Anton Vorontsov28f52482008-06-17 18:17:15 +0400127 */
Anton Vorontsov28f52482008-06-17 18:17:15 +0400128 int (*get_cd)(struct mmc_host *host);
129
Nicolas Pitre17b759a2007-07-24 02:09:39 -0400130 void (*enable_sdio_irq)(struct mmc_host *host, int enable);
Ulf Hansson68269662017-04-13 16:48:11 +0200131 void (*ack_sdio_irq)(struct mmc_host *host);
Daniel Mack3fcb027d2010-04-01 10:03:25 +0200132
133 /* optional callback for HC quirks */
134 void (*init_card)(struct mmc_host *host, struct mmc_card *card);
Arindam Nathf2119df2011-05-05 12:18:57 +0530135
136 int (*start_signal_voltage_switch)(struct mmc_host *host, struct mmc_ios *ios);
Girish K Sa4924c72012-01-11 14:04:52 -0500137
Johan Rudholmd8878742013-01-28 15:08:26 +0100138 /* Check if the card is pulling dat[0:3] low */
139 int (*card_busy)(struct mmc_host *host);
140
Girish K Sa4924c72012-01-11 14:04:52 -0500141 /* The tuning command opcode value is different for SD and eMMC cards */
142 int (*execute_tuning)(struct mmc_host *host, u32 opcode);
Seungwon Jeon0a5b6432014-04-23 17:14:58 +0900143
144 /* Prepare HS400 target operating frequency depending host driver */
145 int (*prepare_hs400_tuning)(struct mmc_host *host, struct mmc_ios *ios);
Simon Hormanba6c7ac2018-06-18 14:57:49 +0200146
Yinbo Zhucc14eec2018-11-23 11:15:33 +0800147 /* Prepare switch to DDR during the HS400 init sequence */
148 int (*hs400_prepare_ddr)(struct mmc_host *host);
149
Simon Hormanba6c7ac2018-06-18 14:57:49 +0200150 /* Prepare for switching from HS400 to HS200 */
151 void (*hs400_downgrade)(struct mmc_host *host);
152
153 /* Complete selection of HS400 */
154 void (*hs400_complete)(struct mmc_host *host);
155
Shawn Lin81ac2af2016-05-26 09:56:22 +0800156 /* Prepare enhanced strobe depending host driver */
157 void (*hs400_enhanced_strobe)(struct mmc_host *host,
158 struct mmc_ios *ios);
Adrian Hunterf1683592015-02-06 14:12:54 +0200159 int (*select_drive_strength)(struct mmc_card *card,
160 unsigned int max_dtr, int host_drv,
Adrian Hunterb4f30a12015-02-06 14:12:52 +0200161 int card_drv, int *drv_type);
Adrian Hunterb2499512011-08-29 16:42:11 +0300162 void (*hw_reset)(struct mmc_host *host);
Guennadi Liakhovetski9f1fb602012-12-04 16:51:32 +0100163 void (*card_event)(struct mmc_host *host);
Kuninori Morimoto2e47e842014-09-02 19:08:53 -0700164
165 /*
166 * Optional callback to support controllers with HW issues for multiple
167 * I/O. Returns the number of supported blocks for the request.
168 */
169 int (*multi_io_quirk)(struct mmc_card *card,
170 unsigned int direction, int blk_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171};
172
Adrian Hunterd3bf68a2017-08-25 15:43:46 +0300173struct mmc_cqe_ops {
174 /* Allocate resources, and make the CQE operational */
175 int (*cqe_enable)(struct mmc_host *host, struct mmc_card *card);
176 /* Free resources, and make the CQE non-operational */
177 void (*cqe_disable)(struct mmc_host *host);
178 /*
179 * Issue a read, write or DCMD request to the CQE. Also deal with the
180 * effect of ->cqe_off().
181 */
182 int (*cqe_request)(struct mmc_host *host, struct mmc_request *mrq);
183 /* Free resources (e.g. DMA mapping) associated with the request */
184 void (*cqe_post_req)(struct mmc_host *host, struct mmc_request *mrq);
185 /*
186 * Prepare the CQE and host controller to accept non-CQ commands. There
187 * is no corresponding ->cqe_on(), instead ->cqe_request() is required
188 * to deal with that.
189 */
190 void (*cqe_off)(struct mmc_host *host);
191 /*
192 * Wait for all CQE tasks to complete. Return an error if recovery
193 * becomes necessary.
194 */
195 int (*cqe_wait_for_idle)(struct mmc_host *host);
196 /*
197 * Notify CQE that a request has timed out. Return false if the request
198 * completed or true if a timeout happened in which case indicate if
199 * recovery is needed.
200 */
201 bool (*cqe_timeout)(struct mmc_host *host, struct mmc_request *mrq,
202 bool *recovery_needed);
203 /*
204 * Stop all CQE activity and prepare the CQE and host controller to
205 * accept recovery commands.
206 */
207 void (*cqe_recovery_start)(struct mmc_host *host);
208 /*
209 * Clear the queue and call mmc_cqe_request_done() on all requests.
210 * Requests that errored will have the error set on the mmc_request
211 * (data->error or cmd->error for DCMD). Requests that did not error
212 * will have zero data bytes transferred.
213 */
214 void (*cqe_recovery_finish)(struct mmc_host *host);
215};
216
Per Forlinaa8b6832011-07-01 18:55:22 +0200217struct mmc_async_req {
218 /* active mmc request */
219 struct mmc_request *mrq;
220 /*
221 * Check error status of completed mmc request.
222 * Returns 0 if success otherwise non zero.
223 */
Linus Walleij8e8b3f52016-11-04 11:05:19 +0100224 enum mmc_blk_status (*err_check)(struct mmc_card *, struct mmc_async_req *);
Per Forlinaa8b6832011-07-01 18:55:22 +0200225};
226
Guennadi Liakhovetski27410ee2012-05-01 15:40:15 +0200227/**
228 * struct mmc_slot - MMC slot functions
229 *
230 * @cd_irq: MMC/SD-card slot hotplug detection IRQ or -EINVAL
231 * @handler_priv: MMC/SD-card slot context
232 *
233 * Some MMC/SD host controllers implement slot-functions like card and
234 * write-protect detection natively. However, a large number of controllers
235 * leave these functions to the CPU. This struct provides a hook to attach
236 * such slot-function drivers.
237 */
238struct mmc_slot {
239 int cd_irq;
Adrian Hunter03dbaa02017-06-13 15:07:51 +0300240 bool cd_wake_enabled;
Guennadi Liakhovetskib67e1982011-12-25 20:40:03 -0500241 void *handler_priv;
242};
243
Konstantin Dorfman2220eed2013-01-14 14:28:17 -0500244/**
245 * mmc_context_info - synchronization details for mmc context
246 * @is_done_rcv wake up reason was done request
247 * @is_new_req wake up reason was new request
248 * @is_waiting_last_req mmc context waiting for single running request
249 * @wait wait queue
Konstantin Dorfman2220eed2013-01-14 14:28:17 -0500250 */
251struct mmc_context_info {
252 bool is_done_rcv;
253 bool is_new_req;
254 bool is_waiting_last_req;
255 wait_queue_head_t wait;
Konstantin Dorfman2220eed2013-01-14 14:28:17 -0500256};
257
Guennadi Liakhovetskie1377882012-06-20 02:28:43 -0400258struct regulator;
Ulf Hansson3aa87932014-11-28 14:38:36 +0100259struct mmc_pwrseq;
Guennadi Liakhovetskie1377882012-06-20 02:28:43 -0400260
261struct mmc_supply {
262 struct regulator *vmmc; /* Card power supply */
263 struct regulator *vqmmc; /* Optional Vccq supply */
264};
265
Adrian Hunter6c0cedd2017-09-22 15:36:51 +0300266struct mmc_ctx {
267 struct task_struct *task;
268};
269
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270struct mmc_host {
Greg Kroah-Hartmanfcaf71f2006-09-12 17:00:10 +0200271 struct device *parent;
272 struct device class_dev;
Russell Kingdce77372005-08-19 09:42:52 +0100273 int index;
David Brownellf57b2252006-09-03 06:43:33 -0700274 const struct mmc_host_ops *ops;
Ulf Hansson3aa87932014-11-28 14:38:36 +0100275 struct mmc_pwrseq *pwrseq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 unsigned int f_min;
277 unsigned int f_max;
Hein Tibosch88ae8b82010-09-06 09:37:19 +0800278 unsigned int f_init;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 u32 ocr_avail;
Takashi Iwai8f230f42010-12-08 10:04:30 +0100280 u32 ocr_avail_sdio; /* SDIO-specific OCR */
281 u32 ocr_avail_sd; /* SD-specific OCR */
282 u32 ocr_avail_mmc; /* MMC-specific OCR */
Ulf Hansson8dede182015-11-05 16:11:12 +0100283#ifdef CONFIG_PM_SLEEP
Maxim Levitsky4c2ef252010-08-10 18:01:41 -0700284 struct notifier_block pm_notify;
Ulf Hansson8dede182015-11-05 16:11:12 +0100285#endif
Aaron Lu55c46652012-07-04 13:31:48 +0800286 u32 max_current_330;
287 u32 max_current_300;
288 u32 max_current_180;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
Philip Langdale55556da2007-03-16 19:39:00 -0700290#define MMC_VDD_165_195 0x00000080 /* VDD voltage 1.65 - 1.95 */
Pierre Ossmanf74d1322007-02-09 22:49:31 +0100291#define MMC_VDD_20_21 0x00000100 /* VDD voltage 2.0 ~ 2.1 */
292#define MMC_VDD_21_22 0x00000200 /* VDD voltage 2.1 ~ 2.2 */
293#define MMC_VDD_22_23 0x00000400 /* VDD voltage 2.2 ~ 2.3 */
294#define MMC_VDD_23_24 0x00000800 /* VDD voltage 2.3 ~ 2.4 */
295#define MMC_VDD_24_25 0x00001000 /* VDD voltage 2.4 ~ 2.5 */
296#define MMC_VDD_25_26 0x00002000 /* VDD voltage 2.5 ~ 2.6 */
297#define MMC_VDD_26_27 0x00004000 /* VDD voltage 2.6 ~ 2.7 */
298#define MMC_VDD_27_28 0x00008000 /* VDD voltage 2.7 ~ 2.8 */
299#define MMC_VDD_28_29 0x00010000 /* VDD voltage 2.8 ~ 2.9 */
300#define MMC_VDD_29_30 0x00020000 /* VDD voltage 2.9 ~ 3.0 */
301#define MMC_VDD_30_31 0x00040000 /* VDD voltage 3.0 ~ 3.1 */
302#define MMC_VDD_31_32 0x00080000 /* VDD voltage 3.1 ~ 3.2 */
303#define MMC_VDD_32_33 0x00100000 /* VDD voltage 3.2 ~ 3.3 */
304#define MMC_VDD_33_34 0x00200000 /* VDD voltage 3.3 ~ 3.4 */
305#define MMC_VDD_34_35 0x00400000 /* VDD voltage 3.4 ~ 3.5 */
306#define MMC_VDD_35_36 0x00800000 /* VDD voltage 3.5 ~ 3.6 */
307
Lee Jones5f1a4dd2012-11-14 12:35:51 +0000308 u32 caps; /* Host capabilities */
Pierre Ossmanf2182782005-09-06 15:18:55 -0700309
310#define MMC_CAP_4_BIT_DATA (1 << 0) /* Can the host do 4 bit transfers */
Pierre Ossman23af6032008-07-06 01:10:27 +0200311#define MMC_CAP_MMC_HIGHSPEED (1 << 1) /* Can do MMC high-speed timing */
312#define MMC_CAP_SD_HIGHSPEED (1 << 2) /* Can do SD high-speed timing */
313#define MMC_CAP_SDIO_IRQ (1 << 3) /* Can signal pending SDIO IRQs */
314#define MMC_CAP_SPI (1 << 4) /* Talks only SPI protocols */
315#define MMC_CAP_NEEDS_POLL (1 << 5) /* Needs polling for card-detection */
Jarkko Lavinenb30f8af2008-11-17 14:35:21 +0200316#define MMC_CAP_8_BIT_DATA (1 << 6) /* Can the host do 8 bit transfers */
Ulf Hanssonc4d770d2013-05-02 14:02:39 +0200317#define MMC_CAP_AGGRESSIVE_PM (1 << 7) /* Suspend (e)MMC/SD at idle */
Adrian Hunter9feae242009-09-22 16:44:32 -0700318#define MMC_CAP_NONREMOVABLE (1 << 8) /* Nonremovable e.g. eMMC */
Jarkko Lavinenb1ebe382009-09-22 16:44:34 -0700319#define MMC_CAP_WAIT_WHILE_BUSY (1 << 9) /* Waits while card is busy */
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700320#define MMC_CAP_ERASE (1 << 10) /* Allow erase/trim commands */
Ulf Hansson20f921b2017-01-25 12:04:17 +0100321#define MMC_CAP_3_3V_DDR (1 << 11) /* Host supports eMMC DDR 3.3V */
322#define MMC_CAP_1_8V_DDR (1 << 12) /* Host supports eMMC DDR 1.8V */
323#define MMC_CAP_1_2V_DDR (1 << 13) /* Host supports eMMC DDR 1.2V */
324#define MMC_CAP_POWER_OFF_CARD (1 << 14) /* Can power off after boot */
325#define MMC_CAP_BUS_WIDTH_TEST (1 << 15) /* CMD14/CMD19 bus width ok */
326#define MMC_CAP_UHS_SDR12 (1 << 16) /* Host supports UHS SDR12 mode */
327#define MMC_CAP_UHS_SDR25 (1 << 17) /* Host supports UHS SDR25 mode */
328#define MMC_CAP_UHS_SDR50 (1 << 18) /* Host supports UHS SDR50 mode */
329#define MMC_CAP_UHS_SDR104 (1 << 19) /* Host supports UHS SDR104 mode */
330#define MMC_CAP_UHS_DDR50 (1 << 20) /* Host supports UHS DDR50 mode */
Kishon Vijay Abraham Ic16bc9a2018-04-27 17:17:14 +0530331#define MMC_CAP_UHS (MMC_CAP_UHS_SDR12 | MMC_CAP_UHS_SDR25 | \
332 MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR104 | \
333 MMC_CAP_UHS_DDR50)
Ulf Hansson7d5ef512018-05-31 11:40:38 +0200334#define MMC_CAP_SYNC_RUNTIME_PM (1 << 21) /* Synced runtime PM suspends. */
Arindam Nathd6d50a12011-05-05 12:18:59 +0530335#define MMC_CAP_DRIVER_TYPE_A (1 << 23) /* Host supports Driver Type A */
336#define MMC_CAP_DRIVER_TYPE_C (1 << 24) /* Host supports Driver Type C */
337#define MMC_CAP_DRIVER_TYPE_D (1 << 25) /* Host supports Driver Type D */
Adrian Hunter10f21df42017-11-29 15:41:07 +0200338#define MMC_CAP_DONE_COMPLETE (1 << 27) /* RW reqs can be completed within mmc_request_done() */
Adrian Hunter03dbaa02017-06-13 15:07:51 +0300339#define MMC_CAP_CD_WAKE (1 << 28) /* Enable card detect wake */
Adrian Hunter5163af52016-08-16 13:44:11 +0300340#define MMC_CAP_CMD_DURING_TFR (1 << 29) /* Commands during data transfer */
Andrei Warkentind0c97cfb2011-05-23 15:06:36 -0500341#define MMC_CAP_CMD23 (1 << 30) /* CMD23 supported. */
Adrian Hunterb2499512011-08-29 16:42:11 +0300342#define MMC_CAP_HW_RESET (1 << 31) /* Hardware reset */
Pierre Ossmanf2182782005-09-06 15:18:55 -0700343
Lee Jones5f1a4dd2012-11-14 12:35:51 +0000344 u32 caps2; /* More host capabilities */
Adrian Hunterf7c56ef2011-09-23 12:48:21 +0300345
346#define MMC_CAP2_BOOTPART_NOACC (1 << 0) /* Boot partition no access */
Ulf Hansson53275c22013-06-10 17:03:46 +0200347#define MMC_CAP2_FULL_PWR_CYCLE (1 << 2) /* Can do full power cycle */
Girish K Sa4924c72012-01-11 14:04:52 -0500348#define MMC_CAP2_HS200_1_8V_SDR (1 << 5) /* can support */
349#define MMC_CAP2_HS200_1_2V_SDR (1 << 6) /* can support */
350#define MMC_CAP2_HS200 (MMC_CAP2_HS200_1_8V_SDR | \
351 MMC_CAP2_HS200_1_2V_SDR)
Guennadi Liakhovetski5c08d7f2012-05-01 15:49:52 +0200352#define MMC_CAP2_CD_ACTIVE_HIGH (1 << 10) /* Card-detect signal active high */
353#define MMC_CAP2_RO_ACTIVE_HIGH (1 << 11) /* Write-protect signal active high */
Adrian Hunter0d3e3352013-04-04 16:41:06 +0300354#define MMC_CAP2_NO_PRESCAN_POWERUP (1 << 14) /* Don't power up before scan */
Seungwon Jeon0a5b6432014-04-23 17:14:58 +0900355#define MMC_CAP2_HS400_1_8V (1 << 15) /* Can support HS400 1.8V */
356#define MMC_CAP2_HS400_1_2V (1 << 16) /* Can support HS400 1.2V */
357#define MMC_CAP2_HS400 (MMC_CAP2_HS400_1_8V | \
358 MMC_CAP2_HS400_1_2V)
Kishon Vijay Abraham Ic16bc9a2018-04-27 17:17:14 +0530359#define MMC_CAP2_HSX00_1_8V (MMC_CAP2_HS200_1_8V_SDR | MMC_CAP2_HS400_1_8V)
Adrian Hunter549c0b12014-11-06 15:19:05 +0200360#define MMC_CAP2_HSX00_1_2V (MMC_CAP2_HS200_1_2V_SDR | MMC_CAP2_HS400_1_2V)
Russell Kingbf3b5ec2014-04-25 12:55:30 +0100361#define MMC_CAP2_SDIO_IRQ_NOTHREAD (1 << 17)
Lars-Peter Clausen9f6e0bf2015-05-06 20:31:19 +0200362#define MMC_CAP2_NO_WRITE_PROTECT (1 << 18) /* No physical write protect pin, assume that card is always read-write */
Carlo Caione100a6062015-11-25 15:39:51 +0100363#define MMC_CAP2_NO_SDIO (1 << 19) /* Do not send SDIO commands during initialization */
Shawn Linef29c0e2016-05-26 09:56:12 +0800364#define MMC_CAP2_HS400_ES (1 << 20) /* Host supports enhanced strobe */
Ulf Hansson1b8d79c2016-06-21 15:12:46 +0200365#define MMC_CAP2_NO_SD (1 << 21) /* Do not send SD commands during initialization */
Shawn Lina0c3b682016-07-01 15:45:28 +0800366#define MMC_CAP2_NO_MMC (1 << 22) /* Do not send (e)MMC commands during initialization */
Adrian Hunterd3bf68a2017-08-25 15:43:46 +0300367#define MMC_CAP2_CQE (1 << 23) /* Has eMMC command queue engine */
368#define MMC_CAP2_CQE_DCMD (1 << 24) /* CQE can issue a direct command */
Kyle Roeschley247cfe52018-04-13 16:54:57 -0500369#define MMC_CAP2_AVOID_3_3V (1 << 25) /* Host must negotiate down from 3.3V */
Adrian Hunterf7c56ef2011-09-23 12:48:21 +0300370
Wolfram Sang6186d062017-10-15 14:46:14 +0200371 int fixed_drv_type; /* fixed driver type for non-removable media */
372
Nicolas Pitreda68c4e2010-03-05 13:43:31 -0800373 mmc_pm_flag_t pm_caps; /* supported pm features */
374
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 /* host specific block data */
376 unsigned int max_seg_size; /* see blk_queue_max_segment_size */
Martin K. Petersena36274e2010-09-10 01:33:59 -0400377 unsigned short max_segs; /* see blk_queue_max_segments */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 unsigned short unused;
Pierre Ossman55db8902006-11-21 17:55:45 +0100379 unsigned int max_req_size; /* maximum number of bytes in one req */
Pierre Ossmanfe4a3c72006-11-21 17:54:23 +0100380 unsigned int max_blk_size; /* maximum size of one mmc block */
Pierre Ossman55db8902006-11-21 17:55:45 +0100381 unsigned int max_blk_count; /* maximum number of blocks in one req */
Ulf Hansson68eb80e2013-12-18 09:57:38 +0100382 unsigned int max_busy_timeout; /* max busy timeout in ms */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
384 /* private data */
Pierre Ossman7ea239d2006-12-31 00:11:32 +0100385 spinlock_t lock; /* lock for claim and bus ops */
386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 struct mmc_ios ios; /* current io bus settings */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
David Brownell97018582007-08-08 09:09:01 -0700389 /* group bitfields together to minimize padding */
390 unsigned int use_spi_crc:1;
391 unsigned int claimed:1; /* host exclusively claimed */
392 unsigned int bus_dead:1; /* bus has been released */
Adrian Hunterdfa13eb2015-05-07 13:10:12 +0300393 unsigned int can_retune:1; /* re-tuning can be used */
394 unsigned int doing_retune:1; /* re-tuning in progress */
395 unsigned int retune_now:1; /* do re-tuning at next req */
Adrian Hunter7ff27602016-05-16 15:35:24 +0300396 unsigned int retune_paused:1; /* re-tuning is temporarily disabled */
Adrian Hunterc3d53d02017-11-29 15:41:02 +0200397 unsigned int use_blk_mq:1; /* use blk-mq */
David Brownell97018582007-08-08 09:09:01 -0700398
Maxim Levitsky4c2ef252010-08-10 18:01:41 -0700399 int rescan_disable; /* disable card detection */
Johan Rudholm3339d1e2012-08-23 13:40:55 +0200400 int rescan_entered; /* used with nonremovable devices */
Adrian Hunter8ea926b2009-09-22 16:44:29 -0700401
Adrian Hunterdfa13eb2015-05-07 13:10:12 +0300402 int need_retune; /* re-tuning is needed */
403 int hold_retune; /* hold off re-tuning */
404 unsigned int retune_period; /* re-tuning period in secs */
405 struct timer_list retune_timer; /* for periodic re-tuning */
406
Markus Mayerfa372a52014-04-08 15:19:43 -0700407 bool trigger_card_event; /* card_event necessary */
408
Pierre Ossmanb8558852007-01-03 19:47:29 +0100409 struct mmc_card *card; /* device attached to this host */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
411 wait_queue_head_t wq;
Adrian Hunter6c0cedd2017-09-22 15:36:51 +0300412 struct mmc_ctx *claimer; /* context that has host claimed */
Adrian Hunter319a3f12009-09-22 16:44:30 -0700413 int claim_cnt; /* "claim" nesting count */
Adrian Hunter6c0cedd2017-09-22 15:36:51 +0300414 struct mmc_ctx default_ctx; /* default context */
Pierre Ossmanf22ee4e2006-12-26 15:11:23 +0100415
David Howellsc4028952006-11-22 14:57:56 +0000416 struct delayed_work detect;
Adrian Hunterd3049502011-11-28 16:22:00 +0200417 int detect_change; /* card detect flag */
Guennadi Liakhovetski27410ee2012-05-01 15:40:15 +0200418 struct mmc_slot slot;
Russell King01357dc2005-09-08 22:46:00 +0100419
Pierre Ossman7ea239d2006-12-31 00:11:32 +0100420 const struct mmc_bus_ops *bus_ops; /* current bus driver */
421 unsigned int bus_refs; /* reference counter */
Pierre Ossman7ea239d2006-12-31 00:11:32 +0100422
Nicolas Pitred1496c32007-06-30 16:29:41 +0200423 unsigned int sdio_irqs;
424 struct task_struct *sdio_irq_thread;
Ulf Hansson68269662017-04-13 16:48:11 +0200425 struct delayed_work sdio_irq_work;
Nicolas Pitrebbbc4c42012-04-16 19:16:54 -0400426 bool sdio_irq_pending;
Nicolas Pitred1496c32007-06-30 16:29:41 +0200427 atomic_t sdio_irq_thread_abort;
428
Nicolas Pitreda68c4e2010-03-05 13:43:31 -0800429 mmc_pm_flag_t pm_flags; /* requested pm features */
430
Pierre Ossmanaf8350c2007-09-24 07:15:48 +0200431 struct led_trigger *led; /* activity led */
Pierre Ossmanaf8350c2007-09-24 07:15:48 +0200432
Linus Walleij99fc5132010-09-29 01:08:27 -0400433#ifdef CONFIG_REGULATOR
434 bool regulator_enabled; /* regulator state */
435#endif
Guennadi Liakhovetskie1377882012-06-20 02:28:43 -0400436 struct mmc_supply supply;
Linus Walleij99fc5132010-09-29 01:08:27 -0400437
Haavard Skinnemoen6edd8ee2008-07-24 14:18:57 +0200438 struct dentry *debugfs_root;
439
Adrian Hunter5163af52016-08-16 13:44:11 +0300440 /* Ongoing data transfer that allows commands during transfer */
441 struct mmc_request *ongoing_mrq;
442
Per Forlin1b676f72011-08-19 14:52:37 +0200443#ifdef CONFIG_FAIL_MMC_REQUEST
444 struct fault_attr fail_mmc_request;
445#endif
446
Giuseppe CAVALLAROdf162192011-11-04 13:53:19 +0100447 unsigned int actual_clock; /* Actual HC clock rate */
448
Aaron Lueed222a2013-03-05 11:24:52 +0800449 unsigned int slotno; /* used for sdio acpi binding */
450
Sascha Hauer3d705d12014-08-19 10:45:51 +0200451 int dsr_req; /* DSR value is valid */
452 u32 dsr; /* optional driver stage (DSR) value */
453
Adrian Hunterd3bf68a2017-08-25 15:43:46 +0300454 /* Command Queue Engine (CQE) support */
455 const struct mmc_cqe_ops *cqe_ops;
456 void *cqe_private;
457 int cqe_qdepth;
458 bool cqe_enabled;
459 bool cqe_on;
460
Russell King01357dc2005-09-08 22:46:00 +0100461 unsigned long private[0] ____cacheline_aligned;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462};
463
Ulf Hansson9e1bbc72017-01-13 14:14:09 +0100464struct device_node;
465
Guennadi Liakhovetski8c9beb12013-02-15 16:13:53 +0100466struct mmc_host *mmc_alloc_host(int extra, struct device *);
467int mmc_add_host(struct mmc_host *);
468void mmc_remove_host(struct mmc_host *);
469void mmc_free_host(struct mmc_host *);
Simon Baatzec0a7512013-06-09 22:14:11 +0200470int mmc_of_parse(struct mmc_host *host);
Ulf Hansson9e1bbc72017-01-13 14:14:09 +0100471int mmc_of_parse_voltage(struct device_node *np, u32 *mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
Russell King01357dc2005-09-08 22:46:00 +0100473static inline void *mmc_priv(struct mmc_host *host)
474{
475 return (void *)host->private;
476}
477
Lukas Wunnerc58ccf22019-02-03 09:27:00 +0100478static inline struct mmc_host *mmc_from_priv(void *priv)
479{
480 return container_of(priv, struct mmc_host, private);
481}
482
David Brownell97018582007-08-08 09:09:01 -0700483#define mmc_host_is_spi(host) ((host)->caps & MMC_CAP_SPI)
484
Greg Kroah-Hartmanfcaf71f2006-09-12 17:00:10 +0200485#define mmc_dev(x) ((x)->parent)
Pierre Ossman11354d02007-01-14 01:41:45 +0100486#define mmc_classdev(x) (&(x)->class_dev)
Kay Sieversd1b26862008-11-08 21:37:46 +0100487#define mmc_hostname(x) (dev_name(&(x)->class_dev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
Guennadi Liakhovetski8c9beb12013-02-15 16:13:53 +0100489void mmc_detect_change(struct mmc_host *, unsigned long delay);
490void mmc_request_done(struct mmc_host *, struct mmc_request *);
Adrian Hunter5163af52016-08-16 13:44:11 +0300491void mmc_command_done(struct mmc_host *host, struct mmc_request *mrq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492
Adrian Hunter72a5af52017-09-22 15:36:52 +0300493void mmc_cqe_request_done(struct mmc_host *host, struct mmc_request *mrq);
494
Nicolas Pitre17b759a2007-07-24 02:09:39 -0400495static inline void mmc_signal_sdio_irq(struct mmc_host *host)
496{
497 host->ops->enable_sdio_irq(host, 0);
Nicolas Pitrebbbc4c42012-04-16 19:16:54 -0400498 host->sdio_irq_pending = true;
Yangbo Luf13e5b92015-07-10 11:36:45 +0800499 if (host->sdio_irq_thread)
500 wake_up_process(host->sdio_irq_thread);
Nicolas Pitre17b759a2007-07-24 02:09:39 -0400501}
502
Russell Kingbf3b5ec2014-04-25 12:55:30 +0100503void sdio_run_irqs(struct mmc_host *host);
Ulf Hansson68269662017-04-13 16:48:11 +0200504void sdio_signal_irq(struct mmc_host *host);
Russell Kingbf3b5ec2014-04-25 12:55:30 +0100505
Linus Walleij99fc5132010-09-29 01:08:27 -0400506#ifdef CONFIG_REGULATOR
Linus Walleij99fc5132010-09-29 01:08:27 -0400507int mmc_regulator_set_ocr(struct mmc_host *mmc,
508 struct regulator *supply,
509 unsigned short vdd_bit);
Douglas Anderson2086f802015-10-12 14:48:25 +0200510int mmc_regulator_set_vqmmc(struct mmc_host *mmc, struct mmc_ios *ios);
Linus Walleij99fc5132010-09-29 01:08:27 -0400511#else
Linus Walleij99fc5132010-09-29 01:08:27 -0400512static inline int mmc_regulator_set_ocr(struct mmc_host *mmc,
513 struct regulator *supply,
514 unsigned short vdd_bit)
515{
516 return 0;
517}
Douglas Anderson2086f802015-10-12 14:48:25 +0200518
519static inline int mmc_regulator_set_vqmmc(struct mmc_host *mmc,
520 struct mmc_ios *ios)
521{
522 return -EINVAL;
523}
Linus Walleij99fc5132010-09-29 01:08:27 -0400524#endif
David Brownell5c139412009-03-11 03:30:43 -0800525
Tim Kryger4d1f52f2014-05-06 15:57:01 -0700526int mmc_regulator_get_supply(struct mmc_host *mmc);
527
Matt Fleming71d7d3d2010-09-27 09:42:19 +0100528static inline int mmc_card_is_removable(struct mmc_host *host)
529{
Ulf Hansson2501c912013-10-30 01:00:18 +0100530 return !(host->caps & MMC_CAP_NONREMOVABLE);
Matt Fleming71d7d3d2010-09-27 09:42:19 +0100531}
532
Ohad Ben-Cohena5e94252011-04-05 17:43:20 +0300533static inline int mmc_card_keep_power(struct mmc_host *host)
Ohad Ben-Cohen080bc972010-11-28 07:21:29 +0200534{
535 return host->pm_flags & MMC_PM_KEEP_POWER;
536}
537
Ohad Ben-Cohen6b93d01f2011-04-05 17:43:21 +0300538static inline int mmc_card_wake_sdio_irq(struct mmc_host *host)
539{
540 return host->pm_flags & MMC_PM_WAKE_SDIO_IRQ;
541}
Andrei Warkentind0c97cfb2011-05-23 15:06:36 -0500542
Ulf Hansson5857b292017-01-13 14:14:15 +0100543/* TODO: Move to private header */
Seungwon Jeoncdc99172014-04-23 17:07:35 +0900544static inline int mmc_card_hs(struct mmc_card *card)
545{
546 return card->host->ios.timing == MMC_TIMING_SD_HS ||
547 card->host->ios.timing == MMC_TIMING_MMC_HS;
548}
549
Ulf Hansson5857b292017-01-13 14:14:15 +0100550/* TODO: Move to private header */
Seungwon Jeoncdc99172014-04-23 17:07:35 +0900551static inline int mmc_card_uhs(struct mmc_card *card)
552{
553 return card->host->ios.timing >= MMC_TIMING_UHS_SDR12 &&
554 card->host->ios.timing <= MMC_TIMING_UHS_DDR50;
555}
556
Adrian Hunterdfa13eb2015-05-07 13:10:12 +0300557void mmc_retune_timer_stop(struct mmc_host *host);
558
559static inline void mmc_retune_needed(struct mmc_host *host)
560{
561 if (host->can_retune)
562 host->need_retune = 1;
563}
564
Simon Hormanc820af52016-11-03 15:15:59 +0100565static inline bool mmc_can_retune(struct mmc_host *host)
566{
567 return host->can_retune == 1;
568}
569
Niklas Söderlundcbf6d822018-08-30 01:32:05 +0200570static inline bool mmc_doing_retune(struct mmc_host *host)
571{
572 return host->doing_retune == 1;
573}
574
Heiner Kallweit6335d682017-03-26 20:41:32 +0200575static inline enum dma_data_direction mmc_get_dma_dir(struct mmc_data *data)
576{
577 return data->flags & MMC_DATA_WRITE ? DMA_TO_DEVICE : DMA_FROM_DEVICE;
578}
579
Ulf Hansson9e1bbc72017-01-13 14:14:09 +0100580int mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error);
581int mmc_abort_tuning(struct mmc_host *host, u32 opcode);
Adrian Hunter7ff27602016-05-16 15:35:24 +0300582
Robert P. J. Day100e9182011-05-27 16:04:03 -0400583#endif /* LINUX_MMC_HOST_H */