2 * linux/drivers/mmc/core/host.c
4 * Copyright (C) 2003 Russell King, All Rights Reserved.
5 * Copyright (C) 2007-2008 Pierre Ossman
6 * Copyright (C) 2010 Linus Walleij
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
12 * MMC host class device management
15 #include <linux/device.h>
16 #include <linux/err.h>
17 #include <linux/idr.h>
19 #include <linux/of_gpio.h>
20 #include <linux/pagemap.h>
21 #include <linux/export.h>
22 #include <linux/leds.h>
23 #include <linux/slab.h>
24 #include <linux/suspend.h>
26 #include <linux/mmc/host.h>
27 #include <linux/mmc/card.h>
28 #include <linux/mmc/slot-gpio.h>
32 #include "slot-gpio.h"
35 static DEFINE_IDR(mmc_host_idr);
36 static DEFINE_SPINLOCK(mmc_host_lock);
38 static void mmc_host_classdev_release(struct device *dev)
40 struct mmc_host *host = cls_dev_to_mmc_host(dev);
41 spin_lock(&mmc_host_lock);
42 idr_remove(&mmc_host_idr, host->index);
43 spin_unlock(&mmc_host_lock);
47 static struct class mmc_host_class = {
49 .dev_release = mmc_host_classdev_release,
52 int mmc_register_host_class(void)
54 return class_register(&mmc_host_class);
57 void mmc_unregister_host_class(void)
59 class_unregister(&mmc_host_class);
62 void mmc_retune_enable(struct mmc_host *host)
65 if (host->retune_period)
66 mod_timer(&host->retune_timer,
67 jiffies + host->retune_period * HZ);
70 void mmc_retune_disable(struct mmc_host *host)
73 del_timer_sync(&host->retune_timer);
75 host->need_retune = 0;
78 void mmc_retune_timer_stop(struct mmc_host *host)
80 del_timer_sync(&host->retune_timer);
82 EXPORT_SYMBOL(mmc_retune_timer_stop);
84 void mmc_retune_hold(struct mmc_host *host)
86 if (!host->hold_retune)
88 host->hold_retune += 1;
91 void mmc_retune_release(struct mmc_host *host)
93 if (host->hold_retune)
94 host->hold_retune -= 1;
99 int mmc_retune(struct mmc_host *host)
101 bool return_to_hs400 = false;
104 if (host->retune_now)
105 host->retune_now = 0;
109 if (!host->need_retune || host->doing_retune || !host->card)
112 host->need_retune = 0;
114 host->doing_retune = 1;
116 if (host->ios.timing == MMC_TIMING_MMC_HS400) {
117 err = mmc_hs400_to_hs200(host->card);
121 return_to_hs400 = true;
123 if (host->ops->prepare_hs400_tuning)
124 host->ops->prepare_hs400_tuning(host, &host->ios);
127 err = mmc_execute_tuning(host->card);
132 err = mmc_hs200_to_hs400(host->card);
134 host->doing_retune = 0;
139 static void mmc_retune_timer(unsigned long data)
141 struct mmc_host *host = (struct mmc_host *)data;
143 mmc_retune_needed(host);
147 * mmc_of_parse() - parse host's device-tree node
148 * @host: host whose node should be parsed.
150 * To keep the rest of the MMC subsystem unaware of whether DT has been
151 * used to to instantiate and configure this host instance or not, we
152 * parse the properties and set respective generic mmc-host flags and
155 int mmc_of_parse(struct mmc_host *host)
157 struct device_node *np;
160 bool cd_cap_invert, cd_gpio_invert = false;
161 bool ro_cap_invert, ro_gpio_invert = false;
163 if (!host->parent || !host->parent->of_node)
166 np = host->parent->of_node;
168 /* "bus-width" is translated to MMC_CAP_*_BIT_DATA flags */
169 if (of_property_read_u32(np, "bus-width", &bus_width) < 0) {
170 dev_dbg(host->parent,
171 "\"bus-width\" property is missing, assuming 1 bit.\n");
177 host->caps |= MMC_CAP_8_BIT_DATA;
178 /* Hosts capable of 8-bit transfers can also do 4 bits */
180 host->caps |= MMC_CAP_4_BIT_DATA;
185 dev_err(host->parent,
186 "Invalid \"bus-width\" value %u!\n", bus_width);
190 /* f_max is obtained from the optional "max-frequency" property */
191 of_property_read_u32(np, "max-frequency", &host->f_max);
194 * Configure CD and WP pins. They are both by default active low to
195 * match the SDHCI spec. If GPIOs are provided for CD and / or WP, the
196 * mmc-gpio helpers are used to attach, configure and use them. If
197 * polarity inversion is specified in DT, one of MMC_CAP2_CD_ACTIVE_HIGH
198 * and MMC_CAP2_RO_ACTIVE_HIGH capability-2 flags is set. If the
199 * "broken-cd" property is provided, the MMC_CAP_NEEDS_POLL capability
200 * is set. If the "non-removable" property is found, the
201 * MMC_CAP_NONREMOVABLE capability is set and no card-detection
202 * configuration is performed.
205 /* Parse Card Detection */
206 if (of_property_read_bool(np, "non-removable")) {
207 host->caps |= MMC_CAP_NONREMOVABLE;
209 cd_cap_invert = of_property_read_bool(np, "cd-inverted");
211 if (of_property_read_bool(np, "broken-cd"))
212 host->caps |= MMC_CAP_NEEDS_POLL;
214 ret = mmc_gpiod_request_cd(host, "cd", 0, true,
217 dev_info(host->parent, "Got CD GPIO\n");
218 else if (ret != -ENOENT && ret != -ENOSYS)
222 * There are two ways to flag that the CD line is inverted:
223 * through the cd-inverted flag and by the GPIO line itself
224 * being inverted from the GPIO subsystem. This is a leftover
225 * from the times when the GPIO subsystem did not make it
226 * possible to flag a line as inverted.
228 * If the capability on the host AND the GPIO line are
229 * both inverted, the end result is that the CD line is
232 if (cd_cap_invert ^ cd_gpio_invert)
233 host->caps2 |= MMC_CAP2_CD_ACTIVE_HIGH;
236 /* Parse Write Protection */
237 ro_cap_invert = of_property_read_bool(np, "wp-inverted");
239 ret = mmc_gpiod_request_ro(host, "wp", 0, false, 0, &ro_gpio_invert);
241 dev_info(host->parent, "Got WP GPIO\n");
242 else if (ret != -ENOENT && ret != -ENOSYS)
245 if (of_property_read_bool(np, "disable-wp"))
246 host->caps2 |= MMC_CAP2_NO_WRITE_PROTECT;
248 /* See the comment on CD inversion above */
249 if (ro_cap_invert ^ ro_gpio_invert)
250 host->caps2 |= MMC_CAP2_RO_ACTIVE_HIGH;
252 if (of_property_read_bool(np, "cap-sd-highspeed"))
253 host->caps |= MMC_CAP_SD_HIGHSPEED;
254 if (of_property_read_bool(np, "cap-mmc-highspeed"))
255 host->caps |= MMC_CAP_MMC_HIGHSPEED;
256 if (of_property_read_bool(np, "sd-uhs-sdr12"))
257 host->caps |= MMC_CAP_UHS_SDR12;
258 if (of_property_read_bool(np, "sd-uhs-sdr25"))
259 host->caps |= MMC_CAP_UHS_SDR25;
260 if (of_property_read_bool(np, "sd-uhs-sdr50"))
261 host->caps |= MMC_CAP_UHS_SDR50;
262 if (of_property_read_bool(np, "sd-uhs-sdr104"))
263 host->caps |= MMC_CAP_UHS_SDR104;
264 if (of_property_read_bool(np, "sd-uhs-ddr50"))
265 host->caps |= MMC_CAP_UHS_DDR50;
266 if (of_property_read_bool(np, "cap-power-off-card"))
267 host->caps |= MMC_CAP_POWER_OFF_CARD;
268 if (of_property_read_bool(np, "cap-mmc-hw-reset"))
269 host->caps |= MMC_CAP_HW_RESET;
270 if (of_property_read_bool(np, "cap-sdio-irq"))
271 host->caps |= MMC_CAP_SDIO_IRQ;
272 if (of_property_read_bool(np, "full-pwr-cycle"))
273 host->caps2 |= MMC_CAP2_FULL_PWR_CYCLE;
274 if (of_property_read_bool(np, "keep-power-in-suspend"))
275 host->pm_caps |= MMC_PM_KEEP_POWER;
276 if (of_property_read_bool(np, "enable-sdio-wakeup"))
277 host->pm_caps |= MMC_PM_WAKE_SDIO_IRQ;
278 if (of_property_read_bool(np, "mmc-ddr-1_8v"))
279 host->caps |= MMC_CAP_1_8V_DDR;
280 if (of_property_read_bool(np, "mmc-ddr-1_2v"))
281 host->caps |= MMC_CAP_1_2V_DDR;
282 if (of_property_read_bool(np, "mmc-hs200-1_8v"))
283 host->caps2 |= MMC_CAP2_HS200_1_8V_SDR;
284 if (of_property_read_bool(np, "mmc-hs200-1_2v"))
285 host->caps2 |= MMC_CAP2_HS200_1_2V_SDR;
286 if (of_property_read_bool(np, "mmc-hs400-1_8v"))
287 host->caps2 |= MMC_CAP2_HS400_1_8V | MMC_CAP2_HS200_1_8V_SDR;
288 if (of_property_read_bool(np, "mmc-hs400-1_2v"))
289 host->caps2 |= MMC_CAP2_HS400_1_2V | MMC_CAP2_HS200_1_2V_SDR;
290 if (of_property_read_bool(np, "mmc-hs400-enhanced-strobe"))
291 host->caps2 |= MMC_CAP2_HS400_ES;
293 if (of_property_read_bool(np, "supports-sd"))
294 host->restrict_caps |= RESTRICT_CARD_TYPE_SD;
295 if (of_property_read_bool(np, "supports-sdio"))
296 host->restrict_caps |= RESTRICT_CARD_TYPE_SDIO;
297 if (of_property_read_bool(np, "supports-emmc"))
298 host->restrict_caps |= RESTRICT_CARD_TYPE_EMMC;
300 host->dsr_req = !of_property_read_u32(np, "dsr", &host->dsr);
301 if (host->dsr_req && (host->dsr & ~0xffff)) {
302 dev_err(host->parent,
303 "device tree specified broken value for DSR: 0x%x, ignoring\n",
308 return mmc_pwrseq_alloc(host);
311 EXPORT_SYMBOL(mmc_of_parse);
314 * mmc_alloc_host - initialise the per-host structure.
315 * @extra: sizeof private data structure
316 * @dev: pointer to host device model structure
318 * Initialise the per-host structure.
320 struct mmc_host *mmc_alloc_host(int extra, struct device *dev)
323 struct mmc_host *host;
325 host = kzalloc(sizeof(struct mmc_host) + extra, GFP_KERNEL);
329 /* scanning will be enabled when we're ready */
330 host->rescan_disable = 1;
331 idr_preload(GFP_KERNEL);
332 spin_lock(&mmc_host_lock);
333 err = idr_alloc(&mmc_host_idr, host, 0, 0, GFP_NOWAIT);
336 spin_unlock(&mmc_host_lock);
343 dev_set_name(&host->class_dev, "mmc%d", host->index);
346 host->class_dev.parent = dev;
347 host->class_dev.class = &mmc_host_class;
348 device_initialize(&host->class_dev);
350 if (mmc_gpio_alloc(host)) {
351 put_device(&host->class_dev);
355 spin_lock_init(&host->lock);
356 init_waitqueue_head(&host->wq);
357 INIT_DELAYED_WORK(&host->detect, mmc_rescan);
359 host->pm_notify.notifier_call = mmc_pm_notify;
361 setup_timer(&host->retune_timer, mmc_retune_timer, (unsigned long)host);
364 * By default, hosts do not support SGIO or large requests.
365 * They have to set these according to their abilities.
368 host->max_seg_size = PAGE_CACHE_SIZE;
370 host->max_req_size = PAGE_CACHE_SIZE;
371 host->max_blk_size = 512;
372 host->max_blk_count = PAGE_CACHE_SIZE / 512;
377 EXPORT_SYMBOL(mmc_alloc_host);
380 * mmc_add_host - initialise host hardware
383 * Register the host with the driver model. The host must be
384 * prepared to start servicing requests before this function
387 struct mmc_host *primary_sdio_host;
388 int mmc_add_host(struct mmc_host *host)
392 WARN_ON((host->caps & MMC_CAP_SDIO_IRQ) &&
393 !host->ops->enable_sdio_irq);
395 err = device_add(&host->class_dev);
399 led_trigger_register_simple(dev_name(&host->class_dev), &host->led);
401 #ifdef CONFIG_DEBUG_FS
402 mmc_add_host_debugfs(host);
406 mmc_latency_hist_sysfs_init(host);
409 mmc_start_host(host);
410 if (!(host->pm_flags & MMC_PM_IGNORE_PM_NOTIFY))
411 register_pm_notifier(&host->pm_notify);
413 if (host->restrict_caps & RESTRICT_CARD_TYPE_SDIO)
414 primary_sdio_host = host;
419 EXPORT_SYMBOL(mmc_add_host);
422 * mmc_remove_host - remove host hardware
425 * Unregister and remove all cards associated with this host,
426 * and power down the MMC bus. No new requests will be issued
427 * after this function has returned.
429 void mmc_remove_host(struct mmc_host *host)
431 if (!(host->pm_flags & MMC_PM_IGNORE_PM_NOTIFY))
432 unregister_pm_notifier(&host->pm_notify);
436 #ifdef CONFIG_DEBUG_FS
437 mmc_remove_host_debugfs(host);
441 mmc_latency_hist_sysfs_exit(host);
444 device_del(&host->class_dev);
446 led_trigger_unregister_simple(host->led);
449 EXPORT_SYMBOL(mmc_remove_host);
452 * mmc_free_host - free the host structure
455 * Free the host once all references to it have been dropped.
457 void mmc_free_host(struct mmc_host *host)
459 mmc_pwrseq_free(host);
460 put_device(&host->class_dev);
463 EXPORT_SYMBOL(mmc_free_host);
466 * mmc_host_rescan - triger software rescan flow
469 * rescan slot attach in the assigned host.
470 * If @host is NULL, default rescan primary_sdio_host
471 * saved by mmc_add_host().
472 * OR, rescan host from argument.
475 int mmc_host_rescan(struct mmc_host *host, int val, int is_cap_sdio_irq)
477 if (NULL != primary_sdio_host) {
479 host = primary_sdio_host;
481 pr_info("%s: mmc_host_rescan pass in host from argument!\n",
484 pr_err("sdio: host isn't initialization successfully.\n");
488 pr_info("%s:mmc host rescan start!\n", mmc_hostname(host));
490 /* 0: oob 1:cap-sdio-irq */
491 if (is_cap_sdio_irq == 1) {
492 host->caps |= MMC_CAP_SDIO_IRQ;
493 } else if (is_cap_sdio_irq == 0) {
494 host->caps &= ~MMC_CAP_SDIO_IRQ;
496 dev_err(&host->class_dev, "sdio: host doesn't identify oob or sdio_irq mode!\n");
500 if (!(host->caps & MMC_CAP_NONREMOVABLE) && host->ops->set_sdio_status)
501 host->ops->set_sdio_status(host, val);
505 EXPORT_SYMBOL(mmc_host_rescan);