Merge tag 'block-5.11-2021-01-10' of git://git.kernel.dk/linux-block
[linux/fpc-iii.git] / drivers / mmc / core / host.c
blob96b2ca1f1b06d7a104f5d60fa6154b4eae8783de
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * linux/drivers/mmc/core/host.c
5 * Copyright (C) 2003 Russell King, All Rights Reserved.
6 * Copyright (C) 2007-2008 Pierre Ossman
7 * Copyright (C) 2010 Linus Walleij
9 * MMC host class device management
12 #include <linux/device.h>
13 #include <linux/err.h>
14 #include <linux/idr.h>
15 #include <linux/of.h>
16 #include <linux/of_gpio.h>
17 #include <linux/pagemap.h>
18 #include <linux/pm_wakeup.h>
19 #include <linux/export.h>
20 #include <linux/leds.h>
21 #include <linux/slab.h>
23 #include <linux/mmc/host.h>
24 #include <linux/mmc/card.h>
25 #include <linux/mmc/slot-gpio.h>
27 #include "core.h"
28 #include "host.h"
29 #include "slot-gpio.h"
30 #include "pwrseq.h"
31 #include "sdio_ops.h"
33 #define cls_dev_to_mmc_host(d) container_of(d, struct mmc_host, class_dev)
35 static DEFINE_IDA(mmc_host_ida);
37 static void mmc_host_classdev_release(struct device *dev)
39 struct mmc_host *host = cls_dev_to_mmc_host(dev);
40 wakeup_source_unregister(host->ws);
41 ida_simple_remove(&mmc_host_ida, host->index);
42 kfree(host);
45 static struct class mmc_host_class = {
46 .name = "mmc_host",
47 .dev_release = mmc_host_classdev_release,
50 int mmc_register_host_class(void)
52 return class_register(&mmc_host_class);
55 void mmc_unregister_host_class(void)
57 class_unregister(&mmc_host_class);
60 void mmc_retune_enable(struct mmc_host *host)
62 host->can_retune = 1;
63 if (host->retune_period)
64 mod_timer(&host->retune_timer,
65 jiffies + host->retune_period * HZ);
69 * Pause re-tuning for a small set of operations. The pause begins after the
70 * next command and after first doing re-tuning.
72 void mmc_retune_pause(struct mmc_host *host)
74 if (!host->retune_paused) {
75 host->retune_paused = 1;
76 mmc_retune_needed(host);
77 mmc_retune_hold(host);
80 EXPORT_SYMBOL(mmc_retune_pause);
82 void mmc_retune_unpause(struct mmc_host *host)
84 if (host->retune_paused) {
85 host->retune_paused = 0;
86 mmc_retune_release(host);
89 EXPORT_SYMBOL(mmc_retune_unpause);
91 void mmc_retune_disable(struct mmc_host *host)
93 mmc_retune_unpause(host);
94 host->can_retune = 0;
95 del_timer_sync(&host->retune_timer);
96 host->retune_now = 0;
97 host->need_retune = 0;
100 void mmc_retune_timer_stop(struct mmc_host *host)
102 del_timer_sync(&host->retune_timer);
104 EXPORT_SYMBOL(mmc_retune_timer_stop);
106 void mmc_retune_hold(struct mmc_host *host)
108 if (!host->hold_retune)
109 host->retune_now = 1;
110 host->hold_retune += 1;
113 void mmc_retune_release(struct mmc_host *host)
115 if (host->hold_retune)
116 host->hold_retune -= 1;
117 else
118 WARN_ON(1);
120 EXPORT_SYMBOL(mmc_retune_release);
122 int mmc_retune(struct mmc_host *host)
124 bool return_to_hs400 = false;
125 int err;
127 if (host->retune_now)
128 host->retune_now = 0;
129 else
130 return 0;
132 if (!host->need_retune || host->doing_retune || !host->card)
133 return 0;
135 host->need_retune = 0;
137 host->doing_retune = 1;
139 if (host->ios.timing == MMC_TIMING_MMC_HS400) {
140 err = mmc_hs400_to_hs200(host->card);
141 if (err)
142 goto out;
144 return_to_hs400 = true;
147 err = mmc_execute_tuning(host->card);
148 if (err)
149 goto out;
151 if (return_to_hs400)
152 err = mmc_hs200_to_hs400(host->card);
153 out:
154 host->doing_retune = 0;
156 return err;
159 static void mmc_retune_timer(struct timer_list *t)
161 struct mmc_host *host = from_timer(host, t, retune_timer);
163 mmc_retune_needed(host);
167 * mmc_of_parse() - parse host's device-tree node
168 * @host: host whose node should be parsed.
170 * To keep the rest of the MMC subsystem unaware of whether DT has been
171 * used to to instantiate and configure this host instance or not, we
172 * parse the properties and set respective generic mmc-host flags and
173 * parameters.
175 int mmc_of_parse(struct mmc_host *host)
177 struct device *dev = host->parent;
178 u32 bus_width, drv_type, cd_debounce_delay_ms;
179 int ret;
181 if (!dev || !dev_fwnode(dev))
182 return 0;
184 /* "bus-width" is translated to MMC_CAP_*_BIT_DATA flags */
185 if (device_property_read_u32(dev, "bus-width", &bus_width) < 0) {
186 dev_dbg(host->parent,
187 "\"bus-width\" property is missing, assuming 1 bit.\n");
188 bus_width = 1;
191 switch (bus_width) {
192 case 8:
193 host->caps |= MMC_CAP_8_BIT_DATA;
194 fallthrough; /* Hosts capable of 8-bit can also do 4 bits */
195 case 4:
196 host->caps |= MMC_CAP_4_BIT_DATA;
197 break;
198 case 1:
199 break;
200 default:
201 dev_err(host->parent,
202 "Invalid \"bus-width\" value %u!\n", bus_width);
203 return -EINVAL;
206 /* f_max is obtained from the optional "max-frequency" property */
207 device_property_read_u32(dev, "max-frequency", &host->f_max);
210 * Configure CD and WP pins. They are both by default active low to
211 * match the SDHCI spec. If GPIOs are provided for CD and / or WP, the
212 * mmc-gpio helpers are used to attach, configure and use them. If
213 * polarity inversion is specified in DT, one of MMC_CAP2_CD_ACTIVE_HIGH
214 * and MMC_CAP2_RO_ACTIVE_HIGH capability-2 flags is set. If the
215 * "broken-cd" property is provided, the MMC_CAP_NEEDS_POLL capability
216 * is set. If the "non-removable" property is found, the
217 * MMC_CAP_NONREMOVABLE capability is set and no card-detection
218 * configuration is performed.
221 /* Parse Card Detection */
223 if (device_property_read_bool(dev, "non-removable")) {
224 host->caps |= MMC_CAP_NONREMOVABLE;
225 } else {
226 if (device_property_read_bool(dev, "cd-inverted"))
227 host->caps2 |= MMC_CAP2_CD_ACTIVE_HIGH;
229 if (device_property_read_u32(dev, "cd-debounce-delay-ms",
230 &cd_debounce_delay_ms))
231 cd_debounce_delay_ms = 200;
233 if (device_property_read_bool(dev, "broken-cd"))
234 host->caps |= MMC_CAP_NEEDS_POLL;
236 ret = mmc_gpiod_request_cd(host, "cd", 0, false,
237 cd_debounce_delay_ms * 1000);
238 if (!ret)
239 dev_info(host->parent, "Got CD GPIO\n");
240 else if (ret != -ENOENT && ret != -ENOSYS)
241 return ret;
244 /* Parse Write Protection */
246 if (device_property_read_bool(dev, "wp-inverted"))
247 host->caps2 |= MMC_CAP2_RO_ACTIVE_HIGH;
249 ret = mmc_gpiod_request_ro(host, "wp", 0, 0);
250 if (!ret)
251 dev_info(host->parent, "Got WP GPIO\n");
252 else if (ret != -ENOENT && ret != -ENOSYS)
253 return ret;
255 if (device_property_read_bool(dev, "disable-wp"))
256 host->caps2 |= MMC_CAP2_NO_WRITE_PROTECT;
258 if (device_property_read_bool(dev, "cap-sd-highspeed"))
259 host->caps |= MMC_CAP_SD_HIGHSPEED;
260 if (device_property_read_bool(dev, "cap-mmc-highspeed"))
261 host->caps |= MMC_CAP_MMC_HIGHSPEED;
262 if (device_property_read_bool(dev, "sd-uhs-sdr12"))
263 host->caps |= MMC_CAP_UHS_SDR12;
264 if (device_property_read_bool(dev, "sd-uhs-sdr25"))
265 host->caps |= MMC_CAP_UHS_SDR25;
266 if (device_property_read_bool(dev, "sd-uhs-sdr50"))
267 host->caps |= MMC_CAP_UHS_SDR50;
268 if (device_property_read_bool(dev, "sd-uhs-sdr104"))
269 host->caps |= MMC_CAP_UHS_SDR104;
270 if (device_property_read_bool(dev, "sd-uhs-ddr50"))
271 host->caps |= MMC_CAP_UHS_DDR50;
272 if (device_property_read_bool(dev, "cap-power-off-card"))
273 host->caps |= MMC_CAP_POWER_OFF_CARD;
274 if (device_property_read_bool(dev, "cap-mmc-hw-reset"))
275 host->caps |= MMC_CAP_HW_RESET;
276 if (device_property_read_bool(dev, "cap-sdio-irq"))
277 host->caps |= MMC_CAP_SDIO_IRQ;
278 if (device_property_read_bool(dev, "full-pwr-cycle"))
279 host->caps2 |= MMC_CAP2_FULL_PWR_CYCLE;
280 if (device_property_read_bool(dev, "full-pwr-cycle-in-suspend"))
281 host->caps2 |= MMC_CAP2_FULL_PWR_CYCLE_IN_SUSPEND;
282 if (device_property_read_bool(dev, "keep-power-in-suspend"))
283 host->pm_caps |= MMC_PM_KEEP_POWER;
284 if (device_property_read_bool(dev, "wakeup-source") ||
285 device_property_read_bool(dev, "enable-sdio-wakeup")) /* legacy */
286 host->pm_caps |= MMC_PM_WAKE_SDIO_IRQ;
287 if (device_property_read_bool(dev, "mmc-ddr-3_3v"))
288 host->caps |= MMC_CAP_3_3V_DDR;
289 if (device_property_read_bool(dev, "mmc-ddr-1_8v"))
290 host->caps |= MMC_CAP_1_8V_DDR;
291 if (device_property_read_bool(dev, "mmc-ddr-1_2v"))
292 host->caps |= MMC_CAP_1_2V_DDR;
293 if (device_property_read_bool(dev, "mmc-hs200-1_8v"))
294 host->caps2 |= MMC_CAP2_HS200_1_8V_SDR;
295 if (device_property_read_bool(dev, "mmc-hs200-1_2v"))
296 host->caps2 |= MMC_CAP2_HS200_1_2V_SDR;
297 if (device_property_read_bool(dev, "mmc-hs400-1_8v"))
298 host->caps2 |= MMC_CAP2_HS400_1_8V | MMC_CAP2_HS200_1_8V_SDR;
299 if (device_property_read_bool(dev, "mmc-hs400-1_2v"))
300 host->caps2 |= MMC_CAP2_HS400_1_2V | MMC_CAP2_HS200_1_2V_SDR;
301 if (device_property_read_bool(dev, "mmc-hs400-enhanced-strobe"))
302 host->caps2 |= MMC_CAP2_HS400_ES;
303 if (device_property_read_bool(dev, "no-sdio"))
304 host->caps2 |= MMC_CAP2_NO_SDIO;
305 if (device_property_read_bool(dev, "no-sd"))
306 host->caps2 |= MMC_CAP2_NO_SD;
307 if (device_property_read_bool(dev, "no-mmc"))
308 host->caps2 |= MMC_CAP2_NO_MMC;
310 /* Must be after "non-removable" check */
311 if (device_property_read_u32(dev, "fixed-emmc-driver-type", &drv_type) == 0) {
312 if (host->caps & MMC_CAP_NONREMOVABLE)
313 host->fixed_drv_type = drv_type;
314 else
315 dev_err(host->parent,
316 "can't use fixed driver type, media is removable\n");
319 host->dsr_req = !device_property_read_u32(dev, "dsr", &host->dsr);
320 if (host->dsr_req && (host->dsr & ~0xffff)) {
321 dev_err(host->parent,
322 "device tree specified broken value for DSR: 0x%x, ignoring\n",
323 host->dsr);
324 host->dsr_req = 0;
327 device_property_read_u32(dev, "post-power-on-delay-ms",
328 &host->ios.power_delay_ms);
330 return mmc_pwrseq_alloc(host);
333 EXPORT_SYMBOL(mmc_of_parse);
336 * mmc_of_parse_voltage - return mask of supported voltages
337 * @np: The device node need to be parsed.
338 * @mask: mask of voltages available for MMC/SD/SDIO
340 * Parse the "voltage-ranges" DT property, returning zero if it is not
341 * found, negative errno if the voltage-range specification is invalid,
342 * or one if the voltage-range is specified and successfully parsed.
344 int mmc_of_parse_voltage(struct device_node *np, u32 *mask)
346 const u32 *voltage_ranges;
347 int num_ranges, i;
349 voltage_ranges = of_get_property(np, "voltage-ranges", &num_ranges);
350 if (!voltage_ranges) {
351 pr_debug("%pOF: voltage-ranges unspecified\n", np);
352 return 0;
354 num_ranges = num_ranges / sizeof(*voltage_ranges) / 2;
355 if (!num_ranges) {
356 pr_err("%pOF: voltage-ranges empty\n", np);
357 return -EINVAL;
360 for (i = 0; i < num_ranges; i++) {
361 const int j = i * 2;
362 u32 ocr_mask;
364 ocr_mask = mmc_vddrange_to_ocrmask(
365 be32_to_cpu(voltage_ranges[j]),
366 be32_to_cpu(voltage_ranges[j + 1]));
367 if (!ocr_mask) {
368 pr_err("%pOF: voltage-range #%d is invalid\n",
369 np, i);
370 return -EINVAL;
372 *mask |= ocr_mask;
375 return 1;
377 EXPORT_SYMBOL(mmc_of_parse_voltage);
380 * mmc_first_nonreserved_index() - get the first index that is not reserved
382 static int mmc_first_nonreserved_index(void)
384 int max;
386 max = of_alias_get_highest_id("mmc");
387 if (max < 0)
388 return 0;
390 return max + 1;
394 * mmc_alloc_host - initialise the per-host structure.
395 * @extra: sizeof private data structure
396 * @dev: pointer to host device model structure
398 * Initialise the per-host structure.
400 struct mmc_host *mmc_alloc_host(int extra, struct device *dev)
402 int err;
403 struct mmc_host *host;
404 int alias_id, min_idx, max_idx;
406 host = kzalloc(sizeof(struct mmc_host) + extra, GFP_KERNEL);
407 if (!host)
408 return NULL;
410 /* scanning will be enabled when we're ready */
411 host->rescan_disable = 1;
413 alias_id = of_alias_get_id(dev->of_node, "mmc");
414 if (alias_id >= 0) {
415 min_idx = alias_id;
416 max_idx = alias_id + 1;
417 } else {
418 min_idx = mmc_first_nonreserved_index();
419 max_idx = 0;
422 err = ida_simple_get(&mmc_host_ida, min_idx, max_idx, GFP_KERNEL);
423 if (err < 0) {
424 kfree(host);
425 return NULL;
428 host->index = err;
430 dev_set_name(&host->class_dev, "mmc%d", host->index);
431 host->ws = wakeup_source_register(NULL, dev_name(&host->class_dev));
433 host->parent = dev;
434 host->class_dev.parent = dev;
435 host->class_dev.class = &mmc_host_class;
436 device_initialize(&host->class_dev);
437 device_enable_async_suspend(&host->class_dev);
439 if (mmc_gpio_alloc(host)) {
440 put_device(&host->class_dev);
441 return NULL;
444 spin_lock_init(&host->lock);
445 init_waitqueue_head(&host->wq);
446 INIT_DELAYED_WORK(&host->detect, mmc_rescan);
447 INIT_DELAYED_WORK(&host->sdio_irq_work, sdio_irq_work);
448 timer_setup(&host->retune_timer, mmc_retune_timer, 0);
451 * By default, hosts do not support SGIO or large requests.
452 * They have to set these according to their abilities.
454 host->max_segs = 1;
455 host->max_seg_size = PAGE_SIZE;
457 host->max_req_size = PAGE_SIZE;
458 host->max_blk_size = 512;
459 host->max_blk_count = PAGE_SIZE / 512;
461 host->fixed_drv_type = -EINVAL;
462 host->ios.power_delay_ms = 10;
463 host->ios.power_mode = MMC_POWER_UNDEFINED;
465 return host;
468 EXPORT_SYMBOL(mmc_alloc_host);
471 * mmc_add_host - initialise host hardware
472 * @host: mmc host
474 * Register the host with the driver model. The host must be
475 * prepared to start servicing requests before this function
476 * completes.
478 int mmc_add_host(struct mmc_host *host)
480 int err;
482 WARN_ON((host->caps & MMC_CAP_SDIO_IRQ) &&
483 !host->ops->enable_sdio_irq);
485 err = device_add(&host->class_dev);
486 if (err)
487 return err;
489 led_trigger_register_simple(dev_name(&host->class_dev), &host->led);
491 #ifdef CONFIG_DEBUG_FS
492 mmc_add_host_debugfs(host);
493 #endif
495 mmc_start_host(host);
496 mmc_register_pm_notifier(host);
498 return 0;
501 EXPORT_SYMBOL(mmc_add_host);
504 * mmc_remove_host - remove host hardware
505 * @host: mmc host
507 * Unregister and remove all cards associated with this host,
508 * and power down the MMC bus. No new requests will be issued
509 * after this function has returned.
511 void mmc_remove_host(struct mmc_host *host)
513 mmc_unregister_pm_notifier(host);
514 mmc_stop_host(host);
516 #ifdef CONFIG_DEBUG_FS
517 mmc_remove_host_debugfs(host);
518 #endif
520 device_del(&host->class_dev);
522 led_trigger_unregister_simple(host->led);
525 EXPORT_SYMBOL(mmc_remove_host);
528 * mmc_free_host - free the host structure
529 * @host: mmc host
531 * Free the host once all references to it have been dropped.
533 void mmc_free_host(struct mmc_host *host)
535 mmc_pwrseq_free(host);
536 put_device(&host->class_dev);
539 EXPORT_SYMBOL(mmc_free_host);