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>
25 #include <linux/mmc/host.h>
26 #include <linux/mmc/card.h>
27 #include <linux/mmc/slot-gpio.h>
31 #include "slot-gpio.h"
35 #define cls_dev_to_mmc_host(d) container_of(d, struct mmc_host, class_dev)
37 static DEFINE_IDA(mmc_host_ida
);
39 static void mmc_host_classdev_release(struct device
*dev
)
41 struct mmc_host
*host
= cls_dev_to_mmc_host(dev
);
42 ida_simple_remove(&mmc_host_ida
, host
->index
);
46 static struct class mmc_host_class
= {
48 .dev_release
= mmc_host_classdev_release
,
51 int mmc_register_host_class(void)
53 return class_register(&mmc_host_class
);
56 void mmc_unregister_host_class(void)
58 class_unregister(&mmc_host_class
);
61 void mmc_retune_enable(struct mmc_host
*host
)
64 if (host
->retune_period
)
65 mod_timer(&host
->retune_timer
,
66 jiffies
+ host
->retune_period
* HZ
);
70 * Pause re-tuning for a small set of operations. The pause begins after the
71 * next command and after first doing re-tuning.
73 void mmc_retune_pause(struct mmc_host
*host
)
75 if (!host
->retune_paused
) {
76 host
->retune_paused
= 1;
77 mmc_retune_needed(host
);
78 mmc_retune_hold(host
);
81 EXPORT_SYMBOL(mmc_retune_pause
);
83 void mmc_retune_unpause(struct mmc_host
*host
)
85 if (host
->retune_paused
) {
86 host
->retune_paused
= 0;
87 mmc_retune_release(host
);
90 EXPORT_SYMBOL(mmc_retune_unpause
);
92 void mmc_retune_disable(struct mmc_host
*host
)
94 mmc_retune_unpause(host
);
96 del_timer_sync(&host
->retune_timer
);
98 host
->need_retune
= 0;
101 void mmc_retune_timer_stop(struct mmc_host
*host
)
103 del_timer_sync(&host
->retune_timer
);
105 EXPORT_SYMBOL(mmc_retune_timer_stop
);
107 void mmc_retune_hold(struct mmc_host
*host
)
109 if (!host
->hold_retune
)
110 host
->retune_now
= 1;
111 host
->hold_retune
+= 1;
114 void mmc_retune_release(struct mmc_host
*host
)
116 if (host
->hold_retune
)
117 host
->hold_retune
-= 1;
121 EXPORT_SYMBOL(mmc_retune_release
);
123 int mmc_retune(struct mmc_host
*host
)
125 bool return_to_hs400
= false;
128 if (host
->retune_now
)
129 host
->retune_now
= 0;
133 if (!host
->need_retune
|| host
->doing_retune
|| !host
->card
)
136 host
->need_retune
= 0;
138 host
->doing_retune
= 1;
140 if (host
->ios
.timing
== MMC_TIMING_MMC_HS400
) {
141 err
= mmc_hs400_to_hs200(host
->card
);
145 return_to_hs400
= true;
148 err
= mmc_execute_tuning(host
->card
);
153 err
= mmc_hs200_to_hs400(host
->card
);
155 host
->doing_retune
= 0;
160 static void mmc_retune_timer(struct timer_list
*t
)
162 struct mmc_host
*host
= from_timer(host
, t
, retune_timer
);
164 mmc_retune_needed(host
);
168 * mmc_of_parse() - parse host's device-tree node
169 * @host: host whose node should be parsed.
171 * To keep the rest of the MMC subsystem unaware of whether DT has been
172 * used to to instantiate and configure this host instance or not, we
173 * parse the properties and set respective generic mmc-host flags and
176 int mmc_of_parse(struct mmc_host
*host
)
178 struct device
*dev
= host
->parent
;
179 u32 bus_width
, drv_type
, cd_debounce_delay_ms
;
181 bool cd_cap_invert
, cd_gpio_invert
= false;
182 bool ro_cap_invert
, ro_gpio_invert
= false;
184 if (!dev
|| !dev_fwnode(dev
))
187 /* "bus-width" is translated to MMC_CAP_*_BIT_DATA flags */
188 if (device_property_read_u32(dev
, "bus-width", &bus_width
) < 0) {
189 dev_dbg(host
->parent
,
190 "\"bus-width\" property is missing, assuming 1 bit.\n");
196 host
->caps
|= MMC_CAP_8_BIT_DATA
;
197 /* fall through - Hosts capable of 8-bit can also do 4 bits */
199 host
->caps
|= MMC_CAP_4_BIT_DATA
;
204 dev_err(host
->parent
,
205 "Invalid \"bus-width\" value %u!\n", bus_width
);
209 /* f_max is obtained from the optional "max-frequency" property */
210 device_property_read_u32(dev
, "max-frequency", &host
->f_max
);
213 * Configure CD and WP pins. They are both by default active low to
214 * match the SDHCI spec. If GPIOs are provided for CD and / or WP, the
215 * mmc-gpio helpers are used to attach, configure and use them. If
216 * polarity inversion is specified in DT, one of MMC_CAP2_CD_ACTIVE_HIGH
217 * and MMC_CAP2_RO_ACTIVE_HIGH capability-2 flags is set. If the
218 * "broken-cd" property is provided, the MMC_CAP_NEEDS_POLL capability
219 * is set. If the "non-removable" property is found, the
220 * MMC_CAP_NONREMOVABLE capability is set and no card-detection
221 * configuration is performed.
224 /* Parse Card Detection */
225 if (device_property_read_bool(dev
, "non-removable")) {
226 host
->caps
|= MMC_CAP_NONREMOVABLE
;
228 cd_cap_invert
= device_property_read_bool(dev
, "cd-inverted");
230 if (device_property_read_u32(dev
, "cd-debounce-delay-ms",
231 &cd_debounce_delay_ms
))
232 cd_debounce_delay_ms
= 200;
234 if (device_property_read_bool(dev
, "broken-cd"))
235 host
->caps
|= MMC_CAP_NEEDS_POLL
;
237 ret
= mmc_gpiod_request_cd(host
, "cd", 0, false,
238 cd_debounce_delay_ms
* 1000,
241 dev_info(host
->parent
, "Got CD GPIO\n");
242 else if (ret
!= -ENOENT
&& ret
!= -ENOSYS
)
246 * There are two ways to flag that the CD line is inverted:
247 * through the cd-inverted flag and by the GPIO line itself
248 * being inverted from the GPIO subsystem. This is a leftover
249 * from the times when the GPIO subsystem did not make it
250 * possible to flag a line as inverted.
252 * If the capability on the host AND the GPIO line are
253 * both inverted, the end result is that the CD line is
256 if (cd_cap_invert
^ cd_gpio_invert
)
257 host
->caps2
|= MMC_CAP2_CD_ACTIVE_HIGH
;
260 /* Parse Write Protection */
261 ro_cap_invert
= device_property_read_bool(dev
, "wp-inverted");
263 ret
= mmc_gpiod_request_ro(host
, "wp", 0, 0, &ro_gpio_invert
);
265 dev_info(host
->parent
, "Got WP GPIO\n");
266 else if (ret
!= -ENOENT
&& ret
!= -ENOSYS
)
269 if (device_property_read_bool(dev
, "disable-wp"))
270 host
->caps2
|= MMC_CAP2_NO_WRITE_PROTECT
;
272 /* See the comment on CD inversion above */
273 if (ro_cap_invert
^ ro_gpio_invert
)
274 host
->caps2
|= MMC_CAP2_RO_ACTIVE_HIGH
;
276 if (device_property_read_bool(dev
, "cap-sd-highspeed"))
277 host
->caps
|= MMC_CAP_SD_HIGHSPEED
;
278 if (device_property_read_bool(dev
, "cap-mmc-highspeed"))
279 host
->caps
|= MMC_CAP_MMC_HIGHSPEED
;
280 if (device_property_read_bool(dev
, "sd-uhs-sdr12"))
281 host
->caps
|= MMC_CAP_UHS_SDR12
;
282 if (device_property_read_bool(dev
, "sd-uhs-sdr25"))
283 host
->caps
|= MMC_CAP_UHS_SDR25
;
284 if (device_property_read_bool(dev
, "sd-uhs-sdr50"))
285 host
->caps
|= MMC_CAP_UHS_SDR50
;
286 if (device_property_read_bool(dev
, "sd-uhs-sdr104"))
287 host
->caps
|= MMC_CAP_UHS_SDR104
;
288 if (device_property_read_bool(dev
, "sd-uhs-ddr50"))
289 host
->caps
|= MMC_CAP_UHS_DDR50
;
290 if (device_property_read_bool(dev
, "cap-power-off-card"))
291 host
->caps
|= MMC_CAP_POWER_OFF_CARD
;
292 if (device_property_read_bool(dev
, "cap-mmc-hw-reset"))
293 host
->caps
|= MMC_CAP_HW_RESET
;
294 if (device_property_read_bool(dev
, "cap-sdio-irq"))
295 host
->caps
|= MMC_CAP_SDIO_IRQ
;
296 if (device_property_read_bool(dev
, "full-pwr-cycle"))
297 host
->caps2
|= MMC_CAP2_FULL_PWR_CYCLE
;
298 if (device_property_read_bool(dev
, "keep-power-in-suspend"))
299 host
->pm_caps
|= MMC_PM_KEEP_POWER
;
300 if (device_property_read_bool(dev
, "wakeup-source") ||
301 device_property_read_bool(dev
, "enable-sdio-wakeup")) /* legacy */
302 host
->pm_caps
|= MMC_PM_WAKE_SDIO_IRQ
;
303 if (device_property_read_bool(dev
, "mmc-ddr-3_3v"))
304 host
->caps
|= MMC_CAP_3_3V_DDR
;
305 if (device_property_read_bool(dev
, "mmc-ddr-1_8v"))
306 host
->caps
|= MMC_CAP_1_8V_DDR
;
307 if (device_property_read_bool(dev
, "mmc-ddr-1_2v"))
308 host
->caps
|= MMC_CAP_1_2V_DDR
;
309 if (device_property_read_bool(dev
, "mmc-hs200-1_8v"))
310 host
->caps2
|= MMC_CAP2_HS200_1_8V_SDR
;
311 if (device_property_read_bool(dev
, "mmc-hs200-1_2v"))
312 host
->caps2
|= MMC_CAP2_HS200_1_2V_SDR
;
313 if (device_property_read_bool(dev
, "mmc-hs400-1_8v"))
314 host
->caps2
|= MMC_CAP2_HS400_1_8V
| MMC_CAP2_HS200_1_8V_SDR
;
315 if (device_property_read_bool(dev
, "mmc-hs400-1_2v"))
316 host
->caps2
|= MMC_CAP2_HS400_1_2V
| MMC_CAP2_HS200_1_2V_SDR
;
317 if (device_property_read_bool(dev
, "mmc-hs400-enhanced-strobe"))
318 host
->caps2
|= MMC_CAP2_HS400_ES
;
319 if (device_property_read_bool(dev
, "no-sdio"))
320 host
->caps2
|= MMC_CAP2_NO_SDIO
;
321 if (device_property_read_bool(dev
, "no-sd"))
322 host
->caps2
|= MMC_CAP2_NO_SD
;
323 if (device_property_read_bool(dev
, "no-mmc"))
324 host
->caps2
|= MMC_CAP2_NO_MMC
;
326 /* Must be after "non-removable" check */
327 if (device_property_read_u32(dev
, "fixed-emmc-driver-type", &drv_type
) == 0) {
328 if (host
->caps
& MMC_CAP_NONREMOVABLE
)
329 host
->fixed_drv_type
= drv_type
;
331 dev_err(host
->parent
,
332 "can't use fixed driver type, media is removable\n");
335 host
->dsr_req
= !device_property_read_u32(dev
, "dsr", &host
->dsr
);
336 if (host
->dsr_req
&& (host
->dsr
& ~0xffff)) {
337 dev_err(host
->parent
,
338 "device tree specified broken value for DSR: 0x%x, ignoring\n",
343 device_property_read_u32(dev
, "post-power-on-delay-ms",
344 &host
->ios
.power_delay_ms
);
346 return mmc_pwrseq_alloc(host
);
349 EXPORT_SYMBOL(mmc_of_parse
);
352 * mmc_of_parse_voltage - return mask of supported voltages
353 * @np: The device node need to be parsed.
354 * @mask: mask of voltages available for MMC/SD/SDIO
356 * Parse the "voltage-ranges" DT property, returning zero if it is not
357 * found, negative errno if the voltage-range specification is invalid,
358 * or one if the voltage-range is specified and successfully parsed.
360 int mmc_of_parse_voltage(struct device_node
*np
, u32
*mask
)
362 const u32
*voltage_ranges
;
365 voltage_ranges
= of_get_property(np
, "voltage-ranges", &num_ranges
);
366 if (!voltage_ranges
) {
367 pr_debug("%pOF: voltage-ranges unspecified\n", np
);
370 num_ranges
= num_ranges
/ sizeof(*voltage_ranges
) / 2;
372 pr_err("%pOF: voltage-ranges empty\n", np
);
376 for (i
= 0; i
< num_ranges
; i
++) {
380 ocr_mask
= mmc_vddrange_to_ocrmask(
381 be32_to_cpu(voltage_ranges
[j
]),
382 be32_to_cpu(voltage_ranges
[j
+ 1]));
384 pr_err("%pOF: voltage-range #%d is invalid\n",
393 EXPORT_SYMBOL(mmc_of_parse_voltage
);
396 * mmc_alloc_host - initialise the per-host structure.
397 * @extra: sizeof private data structure
398 * @dev: pointer to host device model structure
400 * Initialise the per-host structure.
402 struct mmc_host
*mmc_alloc_host(int extra
, struct device
*dev
)
405 struct mmc_host
*host
;
407 host
= kzalloc(sizeof(struct mmc_host
) + extra
, GFP_KERNEL
);
411 /* scanning will be enabled when we're ready */
412 host
->rescan_disable
= 1;
414 err
= ida_simple_get(&mmc_host_ida
, 0, 0, GFP_KERNEL
);
422 dev_set_name(&host
->class_dev
, "mmc%d", host
->index
);
425 host
->class_dev
.parent
= dev
;
426 host
->class_dev
.class = &mmc_host_class
;
427 device_initialize(&host
->class_dev
);
428 device_enable_async_suspend(&host
->class_dev
);
430 if (mmc_gpio_alloc(host
)) {
431 put_device(&host
->class_dev
);
435 spin_lock_init(&host
->lock
);
436 init_waitqueue_head(&host
->wq
);
437 INIT_DELAYED_WORK(&host
->detect
, mmc_rescan
);
438 INIT_DELAYED_WORK(&host
->sdio_irq_work
, sdio_irq_work
);
439 timer_setup(&host
->retune_timer
, mmc_retune_timer
, 0);
442 * By default, hosts do not support SGIO or large requests.
443 * They have to set these according to their abilities.
446 host
->max_seg_size
= PAGE_SIZE
;
448 host
->max_req_size
= PAGE_SIZE
;
449 host
->max_blk_size
= 512;
450 host
->max_blk_count
= PAGE_SIZE
/ 512;
452 host
->fixed_drv_type
= -EINVAL
;
453 host
->ios
.power_delay_ms
= 10;
458 EXPORT_SYMBOL(mmc_alloc_host
);
461 * mmc_add_host - initialise host hardware
464 * Register the host with the driver model. The host must be
465 * prepared to start servicing requests before this function
468 int mmc_add_host(struct mmc_host
*host
)
472 WARN_ON((host
->caps
& MMC_CAP_SDIO_IRQ
) &&
473 !host
->ops
->enable_sdio_irq
);
475 err
= device_add(&host
->class_dev
);
479 led_trigger_register_simple(dev_name(&host
->class_dev
), &host
->led
);
481 #ifdef CONFIG_DEBUG_FS
482 mmc_add_host_debugfs(host
);
485 mmc_start_host(host
);
486 mmc_register_pm_notifier(host
);
491 EXPORT_SYMBOL(mmc_add_host
);
494 * mmc_remove_host - remove host hardware
497 * Unregister and remove all cards associated with this host,
498 * and power down the MMC bus. No new requests will be issued
499 * after this function has returned.
501 void mmc_remove_host(struct mmc_host
*host
)
503 mmc_unregister_pm_notifier(host
);
506 #ifdef CONFIG_DEBUG_FS
507 mmc_remove_host_debugfs(host
);
510 device_del(&host
->class_dev
);
512 led_trigger_unregister_simple(host
->led
);
515 EXPORT_SYMBOL(mmc_remove_host
);
518 * mmc_free_host - free the host structure
521 * Free the host once all references to it have been dropped.
523 void mmc_free_host(struct mmc_host
*host
)
525 mmc_pwrseq_free(host
);
526 put_device(&host
->class_dev
);
529 EXPORT_SYMBOL(mmc_free_host
);