2 * linux/drivers/mmc/core/core.c
4 * Copyright (C) 2003-2004 Russell King, All Rights Reserved.
5 * SD support Copyright (C) 2004 Ian Molton, All Rights Reserved.
6 * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
7 * MMCv4 support Copyright (C) 2006 Philip Langdale, All Rights Reserved.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/interrupt.h>
16 #include <linux/completion.h>
17 #include <linux/device.h>
18 #include <linux/delay.h>
19 #include <linux/pagemap.h>
20 #include <linux/err.h>
21 #include <linux/leds.h>
22 #include <linux/scatterlist.h>
23 #include <linux/log2.h>
24 #include <linux/regulator/consumer.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/suspend.h>
27 #include <linux/fault-inject.h>
28 #include <linux/random.h>
30 #include <linux/mmc/card.h>
31 #include <linux/mmc/host.h>
32 #include <linux/mmc/mmc.h>
33 #include <linux/mmc/sd.h>
44 static struct workqueue_struct *workqueue;
47 * Enabling software CRCs on the data blocks can be a significant (30%)
48 * performance cost, and for other reasons may not always be desired.
49 * So we allow it it to be disabled.
52 module_param(use_spi_crc, bool, 0);
55 * We normally treat cards as removed during suspend if they are not
56 * known to be on a non-removable bus, to avoid the risk of writing
57 * back data to a different card after resume. Allow this to be
58 * overridden if necessary.
60 #ifdef CONFIG_MMC_UNSAFE_RESUME
61 bool mmc_assume_removable;
63 bool mmc_assume_removable = 1;
65 EXPORT_SYMBOL(mmc_assume_removable);
66 module_param_named(removable, mmc_assume_removable, bool, 0644);
69 "MMC/SD cards are removable and may be removed during suspend");
72 * Internal function. Schedule delayed work in the MMC work queue.
74 static int mmc_schedule_delayed_work(struct delayed_work *work,
77 return queue_delayed_work(workqueue, work, delay);
81 * Internal function. Flush all scheduled work from the MMC work queue.
83 static void mmc_flush_scheduled_work(void)
85 flush_workqueue(workqueue);
88 #ifdef CONFIG_FAIL_MMC_REQUEST
91 * Internal function. Inject random data errors.
92 * If mmc_data is NULL no errors are injected.
94 static void mmc_should_fail_request(struct mmc_host *host,
95 struct mmc_request *mrq)
97 struct mmc_command *cmd = mrq->cmd;
98 struct mmc_data *data = mrq->data;
99 static const int data_errors[] = {
108 if (cmd->error || data->error ||
109 !should_fail(&host->fail_mmc_request, data->blksz * data->blocks))
112 data->error = data_errors[random32() % ARRAY_SIZE(data_errors)];
113 data->bytes_xfered = (random32() % (data->bytes_xfered >> 9)) << 9;
116 #else /* CONFIG_FAIL_MMC_REQUEST */
118 static inline void mmc_should_fail_request(struct mmc_host *host,
119 struct mmc_request *mrq)
123 #endif /* CONFIG_FAIL_MMC_REQUEST */
126 * mmc_request_done - finish processing an MMC request
127 * @host: MMC host which completed request
128 * @mrq: MMC request which request
130 * MMC drivers should call this function when they have completed
131 * their processing of a request.
133 void mmc_request_done(struct mmc_host *host, struct mmc_request *mrq)
135 struct mmc_command *cmd = mrq->cmd;
136 int err = cmd->error;
138 if (err && cmd->retries && mmc_host_is_spi(host)) {
139 if (cmd->resp[0] & R1_SPI_ILLEGAL_COMMAND)
143 if (err && cmd->retries && !mmc_card_removed(host->card)) {
145 * Request starter must handle retries - see
146 * mmc_wait_for_req_done().
151 mmc_should_fail_request(host, mrq);
153 led_trigger_event(host->led, LED_OFF);
155 pr_debug("%s: req done (CMD%u): %d: %08x %08x %08x %08x\n",
156 mmc_hostname(host), cmd->opcode, err,
157 cmd->resp[0], cmd->resp[1],
158 cmd->resp[2], cmd->resp[3]);
161 pr_debug("%s: %d bytes transferred: %d\n",
163 mrq->data->bytes_xfered, mrq->data->error);
167 pr_debug("%s: (CMD%u): %d: %08x %08x %08x %08x\n",
168 mmc_hostname(host), mrq->stop->opcode,
170 mrq->stop->resp[0], mrq->stop->resp[1],
171 mrq->stop->resp[2], mrq->stop->resp[3]);
177 mmc_host_clk_release(host);
181 EXPORT_SYMBOL(mmc_request_done);
184 mmc_start_request(struct mmc_host *host, struct mmc_request *mrq)
186 #ifdef CONFIG_MMC_DEBUG
188 struct scatterlist *sg;
192 pr_debug("<%s: starting CMD%u arg %08x flags %08x>\n",
193 mmc_hostname(host), mrq->sbc->opcode,
194 mrq->sbc->arg, mrq->sbc->flags);
197 pr_debug("%s: starting CMD%u arg %08x flags %08x\n",
198 mmc_hostname(host), mrq->cmd->opcode,
199 mrq->cmd->arg, mrq->cmd->flags);
202 pr_debug("%s: blksz %d blocks %d flags %08x "
203 "tsac %d ms nsac %d\n",
204 mmc_hostname(host), mrq->data->blksz,
205 mrq->data->blocks, mrq->data->flags,
206 mrq->data->timeout_ns / 1000000,
207 mrq->data->timeout_clks);
211 pr_debug("%s: CMD%u arg %08x flags %08x\n",
212 mmc_hostname(host), mrq->stop->opcode,
213 mrq->stop->arg, mrq->stop->flags);
216 WARN_ON(!host->claimed);
221 BUG_ON(mrq->data->blksz > host->max_blk_size);
222 BUG_ON(mrq->data->blocks > host->max_blk_count);
223 BUG_ON(mrq->data->blocks * mrq->data->blksz >
226 #ifdef CONFIG_MMC_DEBUG
228 for_each_sg(mrq->data->sg, sg, mrq->data->sg_len, i)
230 BUG_ON(sz != mrq->data->blocks * mrq->data->blksz);
233 mrq->cmd->data = mrq->data;
234 mrq->data->error = 0;
235 mrq->data->mrq = mrq;
237 mrq->data->stop = mrq->stop;
238 mrq->stop->error = 0;
239 mrq->stop->mrq = mrq;
242 mmc_host_clk_hold(host);
243 led_trigger_event(host->led, LED_FULL);
244 host->ops->request(host, mrq);
247 static void mmc_wait_done(struct mmc_request *mrq)
249 complete(&mrq->completion);
252 static void __mmc_start_req(struct mmc_host *host, struct mmc_request *mrq)
254 init_completion(&mrq->completion);
255 mrq->done = mmc_wait_done;
256 if (mmc_card_removed(host->card)) {
257 mrq->cmd->error = -ENOMEDIUM;
258 complete(&mrq->completion);
261 mmc_start_request(host, mrq);
264 static void mmc_wait_for_req_done(struct mmc_host *host,
265 struct mmc_request *mrq)
267 struct mmc_command *cmd;
270 wait_for_completion(&mrq->completion);
273 if (!cmd->error || !cmd->retries ||
274 mmc_card_removed(host->card))
277 pr_debug("%s: req failed (CMD%u): %d, retrying...\n",
278 mmc_hostname(host), cmd->opcode, cmd->error);
281 host->ops->request(host, mrq);
286 * mmc_pre_req - Prepare for a new request
287 * @host: MMC host to prepare command
288 * @mrq: MMC request to prepare for
289 * @is_first_req: true if there is no previous started request
290 * that may run in parellel to this call, otherwise false
292 * mmc_pre_req() is called in prior to mmc_start_req() to let
293 * host prepare for the new request. Preparation of a request may be
294 * performed while another request is running on the host.
296 static void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq,
299 if (host->ops->pre_req) {
300 mmc_host_clk_hold(host);
301 host->ops->pre_req(host, mrq, is_first_req);
302 mmc_host_clk_release(host);
307 * mmc_post_req - Post process a completed request
308 * @host: MMC host to post process command
309 * @mrq: MMC request to post process for
310 * @err: Error, if non zero, clean up any resources made in pre_req
312 * Let the host post process a completed request. Post processing of
313 * a request may be performed while another reuqest is running.
315 static void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq,
318 if (host->ops->post_req) {
319 mmc_host_clk_hold(host);
320 host->ops->post_req(host, mrq, err);
321 mmc_host_clk_release(host);
326 * mmc_start_req - start a non-blocking request
327 * @host: MMC host to start command
328 * @areq: async request to start
329 * @error: out parameter returns 0 for success, otherwise non zero
331 * Start a new MMC custom command request for a host.
332 * If there is on ongoing async request wait for completion
333 * of that request and start the new one and return.
334 * Does not wait for the new request to complete.
336 * Returns the completed request, NULL in case of none completed.
337 * Wait for the an ongoing request (previoulsy started) to complete and
338 * return the completed request. If there is no ongoing request, NULL
339 * is returned without waiting. NULL is not an error condition.
341 struct mmc_async_req *mmc_start_req(struct mmc_host *host,
342 struct mmc_async_req *areq, int *error)
345 struct mmc_async_req *data = host->areq;
347 /* Prepare a new request */
349 mmc_pre_req(host, areq->mrq, !host->areq);
352 mmc_wait_for_req_done(host, host->areq->mrq);
353 err = host->areq->err_check(host->card, host->areq);
355 /* post process the completed failed request */
356 mmc_post_req(host, host->areq->mrq, 0);
359 * Cancel the new prepared request, because
360 * it can't run until the failed
361 * request has been properly handled.
363 mmc_post_req(host, areq->mrq, -EINVAL);
371 __mmc_start_req(host, areq->mrq);
374 mmc_post_req(host, host->areq->mrq, 0);
382 EXPORT_SYMBOL(mmc_start_req);
385 * mmc_wait_for_req - start a request and wait for completion
386 * @host: MMC host to start command
387 * @mrq: MMC request to start
389 * Start a new MMC custom command request for a host, and wait
390 * for the command to complete. Does not attempt to parse the
393 void mmc_wait_for_req(struct mmc_host *host, struct mmc_request *mrq)
395 __mmc_start_req(host, mrq);
396 mmc_wait_for_req_done(host, mrq);
398 EXPORT_SYMBOL(mmc_wait_for_req);
401 * mmc_interrupt_hpi - Issue for High priority Interrupt
402 * @card: the MMC card associated with the HPI transfer
404 * Issued High Priority Interrupt, and check for card status
405 * util out-of prg-state.
407 int mmc_interrupt_hpi(struct mmc_card *card)
414 if (!card->ext_csd.hpi_en) {
415 pr_info("%s: HPI enable bit unset\n", mmc_hostname(card->host));
419 mmc_claim_host(card->host);
420 err = mmc_send_status(card, &status);
422 pr_err("%s: Get card status fail\n", mmc_hostname(card->host));
427 * If the card status is in PRG-state, we can send the HPI command.
429 if (R1_CURRENT_STATE(status) == R1_STATE_PRG) {
432 * We don't know when the HPI command will finish
433 * processing, so we need to resend HPI until out
434 * of prg-state, and keep checking the card status
435 * with SEND_STATUS. If a timeout error occurs when
436 * sending the HPI command, we are already out of
439 err = mmc_send_hpi_cmd(card, &status);
441 pr_debug("%s: abort HPI (%d error)\n",
442 mmc_hostname(card->host), err);
444 err = mmc_send_status(card, &status);
447 } while (R1_CURRENT_STATE(status) == R1_STATE_PRG);
449 pr_debug("%s: Left prg-state\n", mmc_hostname(card->host));
452 mmc_release_host(card->host);
455 EXPORT_SYMBOL(mmc_interrupt_hpi);
458 * mmc_wait_for_cmd - start a command and wait for completion
459 * @host: MMC host to start command
460 * @cmd: MMC command to start
461 * @retries: maximum number of retries
463 * Start a new MMC command for a host, and wait for the command
464 * to complete. Return any error that occurred while the command
465 * was executing. Do not attempt to parse the response.
467 int mmc_wait_for_cmd(struct mmc_host *host, struct mmc_command *cmd, int retries)
469 struct mmc_request mrq = {NULL};
471 WARN_ON(!host->claimed);
473 memset(cmd->resp, 0, sizeof(cmd->resp));
474 cmd->retries = retries;
479 mmc_wait_for_req(host, &mrq);
484 EXPORT_SYMBOL(mmc_wait_for_cmd);
487 * mmc_set_data_timeout - set the timeout for a data command
488 * @data: data phase for command
489 * @card: the MMC card associated with the data transfer
491 * Computes the data timeout parameters according to the
492 * correct algorithm given the card type.
494 void mmc_set_data_timeout(struct mmc_data *data, const struct mmc_card *card)
499 * SDIO cards only define an upper 1 s limit on access.
501 if (mmc_card_sdio(card)) {
502 data->timeout_ns = 1000000000;
503 data->timeout_clks = 0;
508 * SD cards use a 100 multiplier rather than 10
510 mult = mmc_card_sd(card) ? 100 : 10;
513 * Scale up the multiplier (and therefore the timeout) by
514 * the r2w factor for writes.
516 if (data->flags & MMC_DATA_WRITE)
517 mult <<= card->csd.r2w_factor;
519 data->timeout_ns = card->csd.tacc_ns * mult;
520 data->timeout_clks = card->csd.tacc_clks * mult;
523 * SD cards also have an upper limit on the timeout.
525 if (mmc_card_sd(card)) {
526 unsigned int timeout_us, limit_us;
528 timeout_us = data->timeout_ns / 1000;
529 if (mmc_host_clk_rate(card->host))
530 timeout_us += data->timeout_clks * 1000 /
531 (mmc_host_clk_rate(card->host) / 1000);
533 if (data->flags & MMC_DATA_WRITE)
535 * The limit is really 250 ms, but that is
536 * insufficient for some crappy cards.
543 * SDHC cards always use these fixed values.
545 if (timeout_us > limit_us || mmc_card_blockaddr(card)) {
546 data->timeout_ns = limit_us * 1000;
547 data->timeout_clks = 0;
552 * Some cards require longer data read timeout than indicated in CSD.
553 * Address this by setting the read timeout to a "reasonably high"
554 * value. For the cards tested, 300ms has proven enough. If necessary,
555 * this value can be increased if other problematic cards require this.
557 if (mmc_card_long_read_time(card) && data->flags & MMC_DATA_READ) {
558 data->timeout_ns = 300000000;
559 data->timeout_clks = 0;
563 * Some cards need very high timeouts if driven in SPI mode.
564 * The worst observed timeout was 900ms after writing a
565 * continuous stream of data until the internal logic
568 if (mmc_host_is_spi(card->host)) {
569 if (data->flags & MMC_DATA_WRITE) {
570 if (data->timeout_ns < 1000000000)
571 data->timeout_ns = 1000000000; /* 1s */
573 if (data->timeout_ns < 100000000)
574 data->timeout_ns = 100000000; /* 100ms */
578 EXPORT_SYMBOL(mmc_set_data_timeout);
581 * mmc_align_data_size - pads a transfer size to a more optimal value
582 * @card: the MMC card associated with the data transfer
583 * @sz: original transfer size
585 * Pads the original data size with a number of extra bytes in
586 * order to avoid controller bugs and/or performance hits
587 * (e.g. some controllers revert to PIO for certain sizes).
589 * Returns the improved size, which might be unmodified.
591 * Note that this function is only relevant when issuing a
592 * single scatter gather entry.
594 unsigned int mmc_align_data_size(struct mmc_card *card, unsigned int sz)
597 * FIXME: We don't have a system for the controller to tell
598 * the core about its problems yet, so for now we just 32-bit
601 sz = ((sz + 3) / 4) * 4;
605 EXPORT_SYMBOL(mmc_align_data_size);
608 * mmc_host_enable - enable a host.
609 * @host: mmc host to enable
611 * Hosts that support power saving can use the 'enable' and 'disable'
612 * methods to exit and enter power saving states. For more information
613 * see comments for struct mmc_host_ops.
615 int mmc_host_enable(struct mmc_host *host)
617 if (!(host->caps & MMC_CAP_DISABLE))
620 if (host->en_dis_recurs)
623 if (host->nesting_cnt++)
626 cancel_delayed_work_sync(&host->disable);
631 if (host->ops->enable) {
634 host->en_dis_recurs = 1;
635 mmc_host_clk_hold(host);
636 err = host->ops->enable(host);
637 mmc_host_clk_release(host);
638 host->en_dis_recurs = 0;
641 pr_debug("%s: enable error %d\n",
642 mmc_hostname(host), err);
649 EXPORT_SYMBOL(mmc_host_enable);
651 static int mmc_host_do_disable(struct mmc_host *host, int lazy)
653 if (host->ops->disable) {
656 host->en_dis_recurs = 1;
657 mmc_host_clk_hold(host);
658 err = host->ops->disable(host, lazy);
659 mmc_host_clk_release(host);
660 host->en_dis_recurs = 0;
663 pr_debug("%s: disable error %d\n",
664 mmc_hostname(host), err);
668 unsigned long delay = msecs_to_jiffies(err);
670 mmc_schedule_delayed_work(&host->disable, delay);
678 * mmc_host_disable - disable a host.
679 * @host: mmc host to disable
681 * Hosts that support power saving can use the 'enable' and 'disable'
682 * methods to exit and enter power saving states. For more information
683 * see comments for struct mmc_host_ops.
685 int mmc_host_disable(struct mmc_host *host)
689 if (!(host->caps & MMC_CAP_DISABLE))
692 if (host->en_dis_recurs)
695 if (--host->nesting_cnt)
701 err = mmc_host_do_disable(host, 0);
704 EXPORT_SYMBOL(mmc_host_disable);
707 * __mmc_claim_host - exclusively claim a host
708 * @host: mmc host to claim
709 * @abort: whether or not the operation should be aborted
711 * Claim a host for a set of operations. If @abort is non null and
712 * dereference a non-zero value then this will return prematurely with
713 * that non-zero value without acquiring the lock. Returns zero
714 * with the lock held otherwise.
716 int __mmc_claim_host(struct mmc_host *host, atomic_t *abort)
718 DECLARE_WAITQUEUE(wait, current);
724 add_wait_queue(&host->wq, &wait);
725 spin_lock_irqsave(&host->lock, flags);
727 set_current_state(TASK_UNINTERRUPTIBLE);
728 stop = abort ? atomic_read(abort) : 0;
729 if (stop || !host->claimed || host->claimer == current)
731 spin_unlock_irqrestore(&host->lock, flags);
733 spin_lock_irqsave(&host->lock, flags);
735 set_current_state(TASK_RUNNING);
738 host->claimer = current;
739 host->claim_cnt += 1;
742 spin_unlock_irqrestore(&host->lock, flags);
743 remove_wait_queue(&host->wq, &wait);
745 mmc_host_enable(host);
749 EXPORT_SYMBOL(__mmc_claim_host);
752 * mmc_try_claim_host - try exclusively to claim a host
753 * @host: mmc host to claim
755 * Returns %1 if the host is claimed, %0 otherwise.
757 int mmc_try_claim_host(struct mmc_host *host)
759 int claimed_host = 0;
762 spin_lock_irqsave(&host->lock, flags);
763 if (!host->claimed || host->claimer == current) {
765 host->claimer = current;
766 host->claim_cnt += 1;
769 spin_unlock_irqrestore(&host->lock, flags);
772 EXPORT_SYMBOL(mmc_try_claim_host);
775 * mmc_do_release_host - release a claimed host
776 * @host: mmc host to release
778 * If you successfully claimed a host, this function will
781 void mmc_do_release_host(struct mmc_host *host)
785 spin_lock_irqsave(&host->lock, flags);
786 if (--host->claim_cnt) {
787 /* Release for nested claim */
788 spin_unlock_irqrestore(&host->lock, flags);
791 host->claimer = NULL;
792 spin_unlock_irqrestore(&host->lock, flags);
796 EXPORT_SYMBOL(mmc_do_release_host);
798 void mmc_host_deeper_disable(struct work_struct *work)
800 struct mmc_host *host =
801 container_of(work, struct mmc_host, disable.work);
803 /* If the host is claimed then we do not want to disable it anymore */
804 if (!mmc_try_claim_host(host))
806 mmc_host_do_disable(host, 1);
807 mmc_do_release_host(host);
811 * mmc_host_lazy_disable - lazily disable a host.
812 * @host: mmc host to disable
814 * Hosts that support power saving can use the 'enable' and 'disable'
815 * methods to exit and enter power saving states. For more information
816 * see comments for struct mmc_host_ops.
818 int mmc_host_lazy_disable(struct mmc_host *host)
820 if (!(host->caps & MMC_CAP_DISABLE))
823 if (host->en_dis_recurs)
826 if (--host->nesting_cnt)
832 if (host->disable_delay) {
833 mmc_schedule_delayed_work(&host->disable,
834 msecs_to_jiffies(host->disable_delay));
837 return mmc_host_do_disable(host, 1);
839 EXPORT_SYMBOL(mmc_host_lazy_disable);
842 * mmc_release_host - release a host
843 * @host: mmc host to release
845 * Release a MMC host, allowing others to claim the host
846 * for their operations.
848 void mmc_release_host(struct mmc_host *host)
850 WARN_ON(!host->claimed);
852 mmc_host_lazy_disable(host);
854 mmc_do_release_host(host);
857 EXPORT_SYMBOL(mmc_release_host);
860 * Internal function that does the actual ios call to the host driver,
861 * optionally printing some debug output.
863 static inline void mmc_set_ios(struct mmc_host *host)
865 struct mmc_ios *ios = &host->ios;
867 pr_debug("%s: clock %uHz busmode %u powermode %u cs %u Vdd %u "
868 "width %u timing %u\n",
869 mmc_hostname(host), ios->clock, ios->bus_mode,
870 ios->power_mode, ios->chip_select, ios->vdd,
871 ios->bus_width, ios->timing);
874 mmc_set_ungated(host);
875 host->ops->set_ios(host, ios);
879 * Control chip select pin on a host.
881 void mmc_set_chip_select(struct mmc_host *host, int mode)
883 mmc_host_clk_hold(host);
884 host->ios.chip_select = mode;
886 mmc_host_clk_release(host);
890 * Sets the host clock to the highest possible frequency that
893 static void __mmc_set_clock(struct mmc_host *host, unsigned int hz)
895 WARN_ON(hz < host->f_min);
897 if (hz > host->f_max)
900 host->ios.clock = hz;
904 void mmc_set_clock(struct mmc_host *host, unsigned int hz)
906 mmc_host_clk_hold(host);
907 __mmc_set_clock(host, hz);
908 mmc_host_clk_release(host);
911 #ifdef CONFIG_MMC_CLKGATE
913 * This gates the clock by setting it to 0 Hz.
915 void mmc_gate_clock(struct mmc_host *host)
919 spin_lock_irqsave(&host->clk_lock, flags);
920 host->clk_old = host->ios.clock;
922 host->clk_gated = true;
923 spin_unlock_irqrestore(&host->clk_lock, flags);
928 * This restores the clock from gating by using the cached
931 void mmc_ungate_clock(struct mmc_host *host)
934 * We should previously have gated the clock, so the clock shall
935 * be 0 here! The clock may however be 0 during initialization,
936 * when some request operations are performed before setting
937 * the frequency. When ungate is requested in that situation
938 * we just ignore the call.
941 BUG_ON(host->ios.clock);
942 /* This call will also set host->clk_gated to false */
943 __mmc_set_clock(host, host->clk_old);
947 void mmc_set_ungated(struct mmc_host *host)
952 * We've been given a new frequency while the clock is gated,
953 * so make sure we regard this as ungating it.
955 spin_lock_irqsave(&host->clk_lock, flags);
956 host->clk_gated = false;
957 spin_unlock_irqrestore(&host->clk_lock, flags);
961 void mmc_set_ungated(struct mmc_host *host)
967 * Change the bus mode (open drain/push-pull) of a host.
969 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode)
971 mmc_host_clk_hold(host);
972 host->ios.bus_mode = mode;
974 mmc_host_clk_release(host);
978 * Change data bus width of a host.
980 void mmc_set_bus_width(struct mmc_host *host, unsigned int width)
982 mmc_host_clk_hold(host);
983 host->ios.bus_width = width;
985 mmc_host_clk_release(host);
989 * mmc_vdd_to_ocrbitnum - Convert a voltage to the OCR bit number
991 * @low_bits: prefer low bits in boundary cases
993 * This function returns the OCR bit number according to the provided @vdd
994 * value. If conversion is not possible a negative errno value returned.
996 * Depending on the @low_bits flag the function prefers low or high OCR bits
997 * on boundary voltages. For example,
998 * with @low_bits = true, 3300 mV translates to ilog2(MMC_VDD_32_33);
999 * with @low_bits = false, 3300 mV translates to ilog2(MMC_VDD_33_34);
1001 * Any value in the [1951:1999] range translates to the ilog2(MMC_VDD_20_21).
1003 static int mmc_vdd_to_ocrbitnum(int vdd, bool low_bits)
1005 const int max_bit = ilog2(MMC_VDD_35_36);
1008 if (vdd < 1650 || vdd > 3600)
1011 if (vdd >= 1650 && vdd <= 1950)
1012 return ilog2(MMC_VDD_165_195);
1017 /* Base 2000 mV, step 100 mV, bit's base 8. */
1018 bit = (vdd - 2000) / 100 + 8;
1025 * mmc_vddrange_to_ocrmask - Convert a voltage range to the OCR mask
1026 * @vdd_min: minimum voltage value (mV)
1027 * @vdd_max: maximum voltage value (mV)
1029 * This function returns the OCR mask bits according to the provided @vdd_min
1030 * and @vdd_max values. If conversion is not possible the function returns 0.
1032 * Notes wrt boundary cases:
1033 * This function sets the OCR bits for all boundary voltages, for example
1034 * [3300:3400] range is translated to MMC_VDD_32_33 | MMC_VDD_33_34 |
1035 * MMC_VDD_34_35 mask.
1037 u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max)
1041 if (vdd_max < vdd_min)
1044 /* Prefer high bits for the boundary vdd_max values. */
1045 vdd_max = mmc_vdd_to_ocrbitnum(vdd_max, false);
1049 /* Prefer low bits for the boundary vdd_min values. */
1050 vdd_min = mmc_vdd_to_ocrbitnum(vdd_min, true);
1054 /* Fill the mask, from max bit to min bit. */
1055 while (vdd_max >= vdd_min)
1056 mask |= 1 << vdd_max--;
1060 EXPORT_SYMBOL(mmc_vddrange_to_ocrmask);
1062 #ifdef CONFIG_REGULATOR
1065 * mmc_regulator_get_ocrmask - return mask of supported voltages
1066 * @supply: regulator to use
1068 * This returns either a negative errno, or a mask of voltages that
1069 * can be provided to MMC/SD/SDIO devices using the specified voltage
1070 * regulator. This would normally be called before registering the
1073 int mmc_regulator_get_ocrmask(struct regulator *supply)
1079 count = regulator_count_voltages(supply);
1083 for (i = 0; i < count; i++) {
1087 vdd_uV = regulator_list_voltage(supply, i);
1091 vdd_mV = vdd_uV / 1000;
1092 result |= mmc_vddrange_to_ocrmask(vdd_mV, vdd_mV);
1097 EXPORT_SYMBOL(mmc_regulator_get_ocrmask);
1100 * mmc_regulator_set_ocr - set regulator to match host->ios voltage
1101 * @mmc: the host to regulate
1102 * @supply: regulator to use
1103 * @vdd_bit: zero for power off, else a bit number (host->ios.vdd)
1105 * Returns zero on success, else negative errno.
1107 * MMC host drivers may use this to enable or disable a regulator using
1108 * a particular supply voltage. This would normally be called from the
1111 int mmc_regulator_set_ocr(struct mmc_host *mmc,
1112 struct regulator *supply,
1113 unsigned short vdd_bit)
1122 /* REVISIT mmc_vddrange_to_ocrmask() may have set some
1123 * bits this regulator doesn't quite support ... don't
1124 * be too picky, most cards and regulators are OK with
1125 * a 0.1V range goof (it's a small error percentage).
1127 tmp = vdd_bit - ilog2(MMC_VDD_165_195);
1129 min_uV = 1650 * 1000;
1130 max_uV = 1950 * 1000;
1132 min_uV = 1900 * 1000 + tmp * 100 * 1000;
1133 max_uV = min_uV + 100 * 1000;
1136 /* avoid needless changes to this voltage; the regulator
1137 * might not allow this operation
1139 voltage = regulator_get_voltage(supply);
1141 if (mmc->caps2 & MMC_CAP2_BROKEN_VOLTAGE)
1142 min_uV = max_uV = voltage;
1146 else if (voltage < min_uV || voltage > max_uV)
1147 result = regulator_set_voltage(supply, min_uV, max_uV);
1151 if (result == 0 && !mmc->regulator_enabled) {
1152 result = regulator_enable(supply);
1154 mmc->regulator_enabled = true;
1156 } else if (mmc->regulator_enabled) {
1157 result = regulator_disable(supply);
1159 mmc->regulator_enabled = false;
1163 dev_err(mmc_dev(mmc),
1164 "could not set regulator OCR (%d)\n", result);
1167 EXPORT_SYMBOL(mmc_regulator_set_ocr);
1169 #endif /* CONFIG_REGULATOR */
1172 * Mask off any voltages we don't support and select
1173 * the lowest voltage
1175 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr)
1179 ocr &= host->ocr_avail;
1187 mmc_host_clk_hold(host);
1188 host->ios.vdd = bit;
1190 mmc_host_clk_release(host);
1192 pr_warning("%s: host doesn't support card's voltages\n",
1193 mmc_hostname(host));
1200 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage, bool cmd11)
1202 struct mmc_command cmd = {0};
1208 * Send CMD11 only if the request is to switch the card to
1211 if ((signal_voltage != MMC_SIGNAL_VOLTAGE_330) && cmd11) {
1212 cmd.opcode = SD_SWITCH_VOLTAGE;
1214 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1216 err = mmc_wait_for_cmd(host, &cmd, 0);
1220 if (!mmc_host_is_spi(host) && (cmd.resp[0] & R1_ERROR))
1224 host->ios.signal_voltage = signal_voltage;
1226 if (host->ops->start_signal_voltage_switch) {
1227 mmc_host_clk_hold(host);
1228 err = host->ops->start_signal_voltage_switch(host, &host->ios);
1229 mmc_host_clk_release(host);
1236 * Select timing parameters for host.
1238 void mmc_set_timing(struct mmc_host *host, unsigned int timing)
1240 mmc_host_clk_hold(host);
1241 host->ios.timing = timing;
1243 mmc_host_clk_release(host);
1247 * Select appropriate driver type for host.
1249 void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type)
1251 mmc_host_clk_hold(host);
1252 host->ios.drv_type = drv_type;
1254 mmc_host_clk_release(host);
1257 static void mmc_poweroff_notify(struct mmc_host *host)
1259 struct mmc_card *card;
1260 unsigned int timeout;
1261 unsigned int notify_type = EXT_CSD_NO_POWER_NOTIFICATION;
1265 mmc_claim_host(host);
1268 * Send power notify command only if card
1269 * is mmc and notify state is powered ON
1271 if (card && mmc_card_mmc(card) &&
1272 (card->poweroff_notify_state == MMC_POWERED_ON)) {
1274 if (host->power_notify_type == MMC_HOST_PW_NOTIFY_SHORT) {
1275 notify_type = EXT_CSD_POWER_OFF_SHORT;
1276 timeout = card->ext_csd.generic_cmd6_time;
1277 card->poweroff_notify_state = MMC_POWEROFF_SHORT;
1279 notify_type = EXT_CSD_POWER_OFF_LONG;
1280 timeout = card->ext_csd.power_off_longtime;
1281 card->poweroff_notify_state = MMC_POWEROFF_LONG;
1284 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
1285 EXT_CSD_POWER_OFF_NOTIFICATION,
1286 notify_type, timeout);
1288 if (err && err != -EBADMSG)
1289 pr_err("Device failed to respond within %d poweroff "
1290 "time. Forcefully powering down the device\n",
1293 /* Set the card state to no notification after the poweroff */
1294 card->poweroff_notify_state = MMC_NO_POWER_NOTIFICATION;
1296 mmc_release_host(host);
1300 * Apply power to the MMC stack. This is a two-stage process.
1301 * First, we enable power to the card without the clock running.
1302 * We then wait a bit for the power to stabilise. Finally,
1303 * enable the bus drivers and clock to the card.
1305 * We must _NOT_ enable the clock prior to power stablising.
1307 * If a host does all the power sequencing itself, ignore the
1308 * initial MMC_POWER_UP stage.
1310 static void mmc_power_up(struct mmc_host *host)
1314 mmc_host_clk_hold(host);
1316 /* If ocr is set, we use it */
1318 bit = ffs(host->ocr) - 1;
1320 bit = fls(host->ocr_avail) - 1;
1322 host->ios.vdd = bit;
1323 if (mmc_host_is_spi(host))
1324 host->ios.chip_select = MMC_CS_HIGH;
1326 host->ios.chip_select = MMC_CS_DONTCARE;
1327 host->ios.bus_mode = MMC_BUSMODE_PUSHPULL;
1328 host->ios.power_mode = MMC_POWER_UP;
1329 host->ios.bus_width = MMC_BUS_WIDTH_1;
1330 host->ios.timing = MMC_TIMING_LEGACY;
1334 * This delay should be sufficient to allow the power supply
1335 * to reach the minimum voltage.
1339 host->ios.clock = host->f_init;
1341 host->ios.power_mode = MMC_POWER_ON;
1345 * This delay must be at least 74 clock sizes, or 1 ms, or the
1346 * time required to reach a stable voltage.
1350 mmc_host_clk_release(host);
1353 void mmc_power_off(struct mmc_host *host)
1356 mmc_host_clk_hold(host);
1358 host->ios.clock = 0;
1362 * For eMMC 4.5 device send AWAKE command before
1363 * POWER_OFF_NOTIFY command, because in sleep state
1364 * eMMC 4.5 devices respond to only RESET and AWAKE cmd
1366 if (host->card && mmc_card_is_sleep(host->card) &&
1367 host->bus_ops->resume) {
1368 err = host->bus_ops->resume(host);
1371 mmc_poweroff_notify(host);
1373 pr_warning("%s: error %d during resume "
1374 "(continue with poweroff sequence)\n",
1375 mmc_hostname(host), err);
1379 * Reset ocr mask to be the highest possible voltage supported for
1380 * this mmc host. This value will be used at next power up.
1382 host->ocr = 1 << (fls(host->ocr_avail) - 1);
1384 if (!mmc_host_is_spi(host)) {
1385 host->ios.bus_mode = MMC_BUSMODE_OPENDRAIN;
1386 host->ios.chip_select = MMC_CS_DONTCARE;
1388 host->ios.power_mode = MMC_POWER_OFF;
1389 host->ios.bus_width = MMC_BUS_WIDTH_1;
1390 host->ios.timing = MMC_TIMING_LEGACY;
1394 * Some configurations, such as the 802.11 SDIO card in the OLPC
1395 * XO-1.5, require a short delay after poweroff before the card
1396 * can be successfully turned on again.
1400 mmc_host_clk_release(host);
1404 * Cleanup when the last reference to the bus operator is dropped.
1406 static void __mmc_release_bus(struct mmc_host *host)
1409 BUG_ON(host->bus_refs);
1410 BUG_ON(!host->bus_dead);
1412 host->bus_ops = NULL;
1416 * Increase reference count of bus operator
1418 static inline void mmc_bus_get(struct mmc_host *host)
1420 unsigned long flags;
1422 spin_lock_irqsave(&host->lock, flags);
1424 spin_unlock_irqrestore(&host->lock, flags);
1428 * Decrease reference count of bus operator and free it if
1429 * it is the last reference.
1431 static inline void mmc_bus_put(struct mmc_host *host)
1433 unsigned long flags;
1435 spin_lock_irqsave(&host->lock, flags);
1437 if ((host->bus_refs == 0) && host->bus_ops)
1438 __mmc_release_bus(host);
1439 spin_unlock_irqrestore(&host->lock, flags);
1443 * Assign a mmc bus handler to a host. Only one bus handler may control a
1444 * host at any given time.
1446 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops)
1448 unsigned long flags;
1453 WARN_ON(!host->claimed);
1455 spin_lock_irqsave(&host->lock, flags);
1457 BUG_ON(host->bus_ops);
1458 BUG_ON(host->bus_refs);
1460 host->bus_ops = ops;
1464 spin_unlock_irqrestore(&host->lock, flags);
1468 * Remove the current bus handler from a host.
1470 void mmc_detach_bus(struct mmc_host *host)
1472 unsigned long flags;
1476 WARN_ON(!host->claimed);
1477 WARN_ON(!host->bus_ops);
1479 spin_lock_irqsave(&host->lock, flags);
1483 spin_unlock_irqrestore(&host->lock, flags);
1489 * mmc_detect_change - process change of state on a MMC socket
1490 * @host: host which changed state.
1491 * @delay: optional delay to wait before detection (jiffies)
1493 * MMC drivers should call this when they detect a card has been
1494 * inserted or removed. The MMC layer will confirm that any
1495 * present card is still functional, and initialize any newly
1498 void mmc_detect_change(struct mmc_host *host, unsigned long delay)
1500 #ifdef CONFIG_MMC_DEBUG
1501 unsigned long flags;
1502 spin_lock_irqsave(&host->lock, flags);
1503 WARN_ON(host->removed);
1504 spin_unlock_irqrestore(&host->lock, flags);
1506 host->detect_change = 1;
1507 mmc_schedule_delayed_work(&host->detect, delay);
1510 EXPORT_SYMBOL(mmc_detect_change);
1512 void mmc_init_erase(struct mmc_card *card)
1516 if (is_power_of_2(card->erase_size))
1517 card->erase_shift = ffs(card->erase_size) - 1;
1519 card->erase_shift = 0;
1522 * It is possible to erase an arbitrarily large area of an SD or MMC
1523 * card. That is not desirable because it can take a long time
1524 * (minutes) potentially delaying more important I/O, and also the
1525 * timeout calculations become increasingly hugely over-estimated.
1526 * Consequently, 'pref_erase' is defined as a guide to limit erases
1527 * to that size and alignment.
1529 * For SD cards that define Allocation Unit size, limit erases to one
1530 * Allocation Unit at a time. For MMC cards that define High Capacity
1531 * Erase Size, whether it is switched on or not, limit to that size.
1532 * Otherwise just have a stab at a good value. For modern cards it
1533 * will end up being 4MiB. Note that if the value is too small, it
1534 * can end up taking longer to erase.
1536 if (mmc_card_sd(card) && card->ssr.au) {
1537 card->pref_erase = card->ssr.au;
1538 card->erase_shift = ffs(card->ssr.au) - 1;
1539 } else if (card->ext_csd.hc_erase_size) {
1540 card->pref_erase = card->ext_csd.hc_erase_size;
1542 sz = (card->csd.capacity << (card->csd.read_blkbits - 9)) >> 11;
1544 card->pref_erase = 512 * 1024 / 512;
1546 card->pref_erase = 1024 * 1024 / 512;
1548 card->pref_erase = 2 * 1024 * 1024 / 512;
1550 card->pref_erase = 4 * 1024 * 1024 / 512;
1551 if (card->pref_erase < card->erase_size)
1552 card->pref_erase = card->erase_size;
1554 sz = card->pref_erase % card->erase_size;
1556 card->pref_erase += card->erase_size - sz;
1561 static unsigned int mmc_mmc_erase_timeout(struct mmc_card *card,
1562 unsigned int arg, unsigned int qty)
1564 unsigned int erase_timeout;
1566 if (card->ext_csd.erase_group_def & 1) {
1567 /* High Capacity Erase Group Size uses HC timeouts */
1568 if (arg == MMC_TRIM_ARG)
1569 erase_timeout = card->ext_csd.trim_timeout;
1571 erase_timeout = card->ext_csd.hc_erase_timeout;
1573 /* CSD Erase Group Size uses write timeout */
1574 unsigned int mult = (10 << card->csd.r2w_factor);
1575 unsigned int timeout_clks = card->csd.tacc_clks * mult;
1576 unsigned int timeout_us;
1578 /* Avoid overflow: e.g. tacc_ns=80000000 mult=1280 */
1579 if (card->csd.tacc_ns < 1000000)
1580 timeout_us = (card->csd.tacc_ns * mult) / 1000;
1582 timeout_us = (card->csd.tacc_ns / 1000) * mult;
1585 * ios.clock is only a target. The real clock rate might be
1586 * less but not that much less, so fudge it by multiplying by 2.
1589 timeout_us += (timeout_clks * 1000) /
1590 (mmc_host_clk_rate(card->host) / 1000);
1592 erase_timeout = timeout_us / 1000;
1595 * Theoretically, the calculation could underflow so round up
1596 * to 1ms in that case.
1602 /* Multiplier for secure operations */
1603 if (arg & MMC_SECURE_ARGS) {
1604 if (arg == MMC_SECURE_ERASE_ARG)
1605 erase_timeout *= card->ext_csd.sec_erase_mult;
1607 erase_timeout *= card->ext_csd.sec_trim_mult;
1610 erase_timeout *= qty;
1613 * Ensure at least a 1 second timeout for SPI as per
1614 * 'mmc_set_data_timeout()'
1616 if (mmc_host_is_spi(card->host) && erase_timeout < 1000)
1617 erase_timeout = 1000;
1619 return erase_timeout;
1622 static unsigned int mmc_sd_erase_timeout(struct mmc_card *card,
1626 unsigned int erase_timeout;
1628 if (card->ssr.erase_timeout) {
1629 /* Erase timeout specified in SD Status Register (SSR) */
1630 erase_timeout = card->ssr.erase_timeout * qty +
1631 card->ssr.erase_offset;
1634 * Erase timeout not specified in SD Status Register (SSR) so
1635 * use 250ms per write block.
1637 erase_timeout = 250 * qty;
1640 /* Must not be less than 1 second */
1641 if (erase_timeout < 1000)
1642 erase_timeout = 1000;
1644 return erase_timeout;
1647 static unsigned int mmc_erase_timeout(struct mmc_card *card,
1651 if (mmc_card_sd(card))
1652 return mmc_sd_erase_timeout(card, arg, qty);
1654 return mmc_mmc_erase_timeout(card, arg, qty);
1657 static int mmc_do_erase(struct mmc_card *card, unsigned int from,
1658 unsigned int to, unsigned int arg)
1660 struct mmc_command cmd = {0};
1661 unsigned int qty = 0;
1665 * qty is used to calculate the erase timeout which depends on how many
1666 * erase groups (or allocation units in SD terminology) are affected.
1667 * We count erasing part of an erase group as one erase group.
1668 * For SD, the allocation units are always a power of 2. For MMC, the
1669 * erase group size is almost certainly also power of 2, but it does not
1670 * seem to insist on that in the JEDEC standard, so we fall back to
1671 * division in that case. SD may not specify an allocation unit size,
1672 * in which case the timeout is based on the number of write blocks.
1674 * Note that the timeout for secure trim 2 will only be correct if the
1675 * number of erase groups specified is the same as the total of all
1676 * preceding secure trim 1 commands. Since the power may have been
1677 * lost since the secure trim 1 commands occurred, it is generally
1678 * impossible to calculate the secure trim 2 timeout correctly.
1680 if (card->erase_shift)
1681 qty += ((to >> card->erase_shift) -
1682 (from >> card->erase_shift)) + 1;
1683 else if (mmc_card_sd(card))
1684 qty += to - from + 1;
1686 qty += ((to / card->erase_size) -
1687 (from / card->erase_size)) + 1;
1689 if (!mmc_card_blockaddr(card)) {
1694 if (mmc_card_sd(card))
1695 cmd.opcode = SD_ERASE_WR_BLK_START;
1697 cmd.opcode = MMC_ERASE_GROUP_START;
1699 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1700 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1702 pr_err("mmc_erase: group start error %d, "
1703 "status %#x\n", err, cmd.resp[0]);
1708 memset(&cmd, 0, sizeof(struct mmc_command));
1709 if (mmc_card_sd(card))
1710 cmd.opcode = SD_ERASE_WR_BLK_END;
1712 cmd.opcode = MMC_ERASE_GROUP_END;
1714 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1715 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1717 pr_err("mmc_erase: group end error %d, status %#x\n",
1723 memset(&cmd, 0, sizeof(struct mmc_command));
1724 cmd.opcode = MMC_ERASE;
1726 cmd.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
1727 cmd.cmd_timeout_ms = mmc_erase_timeout(card, arg, qty);
1728 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1730 pr_err("mmc_erase: erase error %d, status %#x\n",
1736 if (mmc_host_is_spi(card->host))
1740 memset(&cmd, 0, sizeof(struct mmc_command));
1741 cmd.opcode = MMC_SEND_STATUS;
1742 cmd.arg = card->rca << 16;
1743 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1744 /* Do not retry else we can't see errors */
1745 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1746 if (err || (cmd.resp[0] & 0xFDF92000)) {
1747 pr_err("error %d requesting status %#x\n",
1752 } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
1753 R1_CURRENT_STATE(cmd.resp[0]) == R1_STATE_PRG);
1759 * mmc_erase - erase sectors.
1760 * @card: card to erase
1761 * @from: first sector to erase
1762 * @nr: number of sectors to erase
1763 * @arg: erase command argument (SD supports only %MMC_ERASE_ARG)
1765 * Caller must claim host before calling this function.
1767 int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
1770 unsigned int rem, to = from + nr;
1772 if (!(card->host->caps & MMC_CAP_ERASE) ||
1773 !(card->csd.cmdclass & CCC_ERASE))
1776 if (!card->erase_size)
1779 if (mmc_card_sd(card) && arg != MMC_ERASE_ARG)
1782 if ((arg & MMC_SECURE_ARGS) &&
1783 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN))
1786 if ((arg & MMC_TRIM_ARGS) &&
1787 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN))
1790 if (arg == MMC_SECURE_ERASE_ARG) {
1791 if (from % card->erase_size || nr % card->erase_size)
1795 if (arg == MMC_ERASE_ARG) {
1796 rem = from % card->erase_size;
1798 rem = card->erase_size - rem;
1805 rem = nr % card->erase_size;
1818 /* 'from' and 'to' are inclusive */
1821 return mmc_do_erase(card, from, to, arg);
1823 EXPORT_SYMBOL(mmc_erase);
1825 int mmc_can_erase(struct mmc_card *card)
1827 if ((card->host->caps & MMC_CAP_ERASE) &&
1828 (card->csd.cmdclass & CCC_ERASE) && card->erase_size)
1832 EXPORT_SYMBOL(mmc_can_erase);
1834 int mmc_can_trim(struct mmc_card *card)
1836 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN)
1838 if (mmc_can_discard(card))
1842 EXPORT_SYMBOL(mmc_can_trim);
1844 int mmc_can_discard(struct mmc_card *card)
1847 * As there's no way to detect the discard support bit at v4.5
1848 * use the s/w feature support filed.
1850 if (card->ext_csd.feature_support & MMC_DISCARD_FEATURE)
1854 EXPORT_SYMBOL(mmc_can_discard);
1856 int mmc_can_sanitize(struct mmc_card *card)
1858 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_SANITIZE)
1862 EXPORT_SYMBOL(mmc_can_sanitize);
1864 int mmc_can_secure_erase_trim(struct mmc_card *card)
1866 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN)
1870 EXPORT_SYMBOL(mmc_can_secure_erase_trim);
1872 int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
1875 if (!card->erase_size)
1877 if (from % card->erase_size || nr % card->erase_size)
1881 EXPORT_SYMBOL(mmc_erase_group_aligned);
1883 static unsigned int mmc_do_calc_max_discard(struct mmc_card *card,
1886 struct mmc_host *host = card->host;
1887 unsigned int max_discard, x, y, qty = 0, max_qty, timeout;
1888 unsigned int last_timeout = 0;
1890 if (card->erase_shift)
1891 max_qty = UINT_MAX >> card->erase_shift;
1892 else if (mmc_card_sd(card))
1895 max_qty = UINT_MAX / card->erase_size;
1897 /* Find the largest qty with an OK timeout */
1900 for (x = 1; x && x <= max_qty && max_qty - x >= qty; x <<= 1) {
1901 timeout = mmc_erase_timeout(card, arg, qty + x);
1902 if (timeout > host->max_discard_to)
1904 if (timeout < last_timeout)
1906 last_timeout = timeout;
1918 /* Convert qty to sectors */
1919 if (card->erase_shift)
1920 max_discard = --qty << card->erase_shift;
1921 else if (mmc_card_sd(card))
1924 max_discard = --qty * card->erase_size;
1929 unsigned int mmc_calc_max_discard(struct mmc_card *card)
1931 struct mmc_host *host = card->host;
1932 unsigned int max_discard, max_trim;
1934 if (!host->max_discard_to)
1938 * Without erase_group_def set, MMC erase timeout depends on clock
1939 * frequence which can change. In that case, the best choice is
1940 * just the preferred erase size.
1942 if (mmc_card_mmc(card) && !(card->ext_csd.erase_group_def & 1))
1943 return card->pref_erase;
1945 max_discard = mmc_do_calc_max_discard(card, MMC_ERASE_ARG);
1946 if (mmc_can_trim(card)) {
1947 max_trim = mmc_do_calc_max_discard(card, MMC_TRIM_ARG);
1948 if (max_trim < max_discard)
1949 max_discard = max_trim;
1950 } else if (max_discard < card->erase_size) {
1953 pr_debug("%s: calculated max. discard sectors %u for timeout %u ms\n",
1954 mmc_hostname(host), max_discard, host->max_discard_to);
1957 EXPORT_SYMBOL(mmc_calc_max_discard);
1959 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen)
1961 struct mmc_command cmd = {0};
1963 if (mmc_card_blockaddr(card) || mmc_card_ddr_mode(card))
1966 cmd.opcode = MMC_SET_BLOCKLEN;
1968 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1969 return mmc_wait_for_cmd(card->host, &cmd, 5);
1971 EXPORT_SYMBOL(mmc_set_blocklen);
1973 static void mmc_hw_reset_for_init(struct mmc_host *host)
1975 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->hw_reset)
1977 mmc_host_clk_hold(host);
1978 host->ops->hw_reset(host);
1979 mmc_host_clk_release(host);
1982 int mmc_can_reset(struct mmc_card *card)
1986 if (!mmc_card_mmc(card))
1988 rst_n_function = card->ext_csd.rst_n_function;
1989 if ((rst_n_function & EXT_CSD_RST_N_EN_MASK) != EXT_CSD_RST_N_ENABLED)
1993 EXPORT_SYMBOL(mmc_can_reset);
1995 static int mmc_do_hw_reset(struct mmc_host *host, int check)
1997 struct mmc_card *card = host->card;
1999 if (!host->bus_ops->power_restore)
2002 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->hw_reset)
2008 if (!mmc_can_reset(card))
2011 mmc_host_clk_hold(host);
2012 mmc_set_clock(host, host->f_init);
2014 host->ops->hw_reset(host);
2016 /* If the reset has happened, then a status command will fail */
2018 struct mmc_command cmd = {0};
2021 cmd.opcode = MMC_SEND_STATUS;
2022 if (!mmc_host_is_spi(card->host))
2023 cmd.arg = card->rca << 16;
2024 cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
2025 err = mmc_wait_for_cmd(card->host, &cmd, 0);
2027 mmc_host_clk_release(host);
2032 host->card->state &= ~(MMC_STATE_HIGHSPEED | MMC_STATE_HIGHSPEED_DDR);
2033 if (mmc_host_is_spi(host)) {
2034 host->ios.chip_select = MMC_CS_HIGH;
2035 host->ios.bus_mode = MMC_BUSMODE_PUSHPULL;
2037 host->ios.chip_select = MMC_CS_DONTCARE;
2038 host->ios.bus_mode = MMC_BUSMODE_OPENDRAIN;
2040 host->ios.bus_width = MMC_BUS_WIDTH_1;
2041 host->ios.timing = MMC_TIMING_LEGACY;
2044 mmc_host_clk_release(host);
2046 return host->bus_ops->power_restore(host);
2049 int mmc_hw_reset(struct mmc_host *host)
2051 return mmc_do_hw_reset(host, 0);
2053 EXPORT_SYMBOL(mmc_hw_reset);
2055 int mmc_hw_reset_check(struct mmc_host *host)
2057 return mmc_do_hw_reset(host, 1);
2059 EXPORT_SYMBOL(mmc_hw_reset_check);
2061 static int mmc_rescan_try_freq(struct mmc_host *host, unsigned freq)
2063 host->f_init = freq;
2065 #ifdef CONFIG_MMC_DEBUG
2066 pr_info("%s: %s: trying to init card at %u Hz\n",
2067 mmc_hostname(host), __func__, host->f_init);
2072 * Some eMMCs (with VCCQ always on) may not be reset after power up, so
2073 * do a hardware reset if possible.
2075 mmc_hw_reset_for_init(host);
2077 /* Initialization should be done at 3.3 V I/O voltage. */
2078 mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_330, 0);
2081 * sdio_reset sends CMD52 to reset card. Since we do not know
2082 * if the card is being re-initialized, just send it. CMD52
2083 * should be ignored by SD/eMMC cards.
2088 mmc_send_if_cond(host, host->ocr_avail);
2090 /* Order's important: probe SDIO, then SD, then MMC */
2091 if (!mmc_attach_sdio(host))
2093 if (!mmc_attach_sd(host))
2095 if (!mmc_attach_mmc(host))
2098 mmc_power_off(host);
2102 int _mmc_detect_card_removed(struct mmc_host *host)
2106 if ((host->caps & MMC_CAP_NONREMOVABLE) || !host->bus_ops->alive)
2109 if (!host->card || mmc_card_removed(host->card))
2112 ret = host->bus_ops->alive(host);
2114 mmc_card_set_removed(host->card);
2115 pr_debug("%s: card remove detected\n", mmc_hostname(host));
2121 int mmc_detect_card_removed(struct mmc_host *host)
2123 struct mmc_card *card = host->card;
2125 WARN_ON(!host->claimed);
2127 * The card will be considered unchanged unless we have been asked to
2128 * detect a change or host requires polling to provide card detection.
2130 if (card && !host->detect_change && !(host->caps & MMC_CAP_NEEDS_POLL))
2131 return mmc_card_removed(card);
2133 host->detect_change = 0;
2135 return _mmc_detect_card_removed(host);
2137 EXPORT_SYMBOL(mmc_detect_card_removed);
2139 void mmc_rescan(struct work_struct *work)
2141 static const unsigned freqs[] = { 400000, 300000, 200000, 100000 };
2142 struct mmc_host *host =
2143 container_of(work, struct mmc_host, detect.work);
2146 if (host->rescan_disable)
2152 * if there is a _removable_ card registered, check whether it is
2155 if (host->bus_ops && host->bus_ops->detect && !host->bus_dead
2156 && !(host->caps & MMC_CAP_NONREMOVABLE))
2157 host->bus_ops->detect(host);
2159 host->detect_change = 0;
2162 * Let mmc_bus_put() free the bus/bus_ops if we've found that
2163 * the card is no longer present.
2168 /* if there still is a card present, stop here */
2169 if (host->bus_ops != NULL) {
2175 * Only we can add a new handler, so it's safe to
2176 * release the lock here.
2180 if (host->ops->get_cd && host->ops->get_cd(host) == 0)
2183 mmc_claim_host(host);
2184 for (i = 0; i < ARRAY_SIZE(freqs); i++) {
2185 if (!mmc_rescan_try_freq(host, max(freqs[i], host->f_min)))
2187 if (freqs[i] <= host->f_min)
2190 mmc_release_host(host);
2193 if (host->caps & MMC_CAP_NEEDS_POLL)
2194 mmc_schedule_delayed_work(&host->detect, HZ);
2197 void mmc_start_host(struct mmc_host *host)
2199 mmc_power_off(host);
2200 mmc_detect_change(host, 0);
2203 void mmc_stop_host(struct mmc_host *host)
2205 #ifdef CONFIG_MMC_DEBUG
2206 unsigned long flags;
2207 spin_lock_irqsave(&host->lock, flags);
2209 spin_unlock_irqrestore(&host->lock, flags);
2212 if (host->caps & MMC_CAP_DISABLE)
2213 cancel_delayed_work(&host->disable);
2214 cancel_delayed_work_sync(&host->detect);
2215 mmc_flush_scheduled_work();
2217 /* clear pm flags now and let card drivers set them as needed */
2221 if (host->bus_ops && !host->bus_dead) {
2222 /* Calling bus_ops->remove() with a claimed host can deadlock */
2223 if (host->bus_ops->remove)
2224 host->bus_ops->remove(host);
2226 mmc_claim_host(host);
2227 mmc_detach_bus(host);
2228 mmc_power_off(host);
2229 mmc_release_host(host);
2237 mmc_power_off(host);
2240 int mmc_power_save_host(struct mmc_host *host)
2244 #ifdef CONFIG_MMC_DEBUG
2245 pr_info("%s: %s: powering down\n", mmc_hostname(host), __func__);
2250 if (!host->bus_ops || host->bus_dead || !host->bus_ops->power_restore) {
2255 if (host->bus_ops->power_save)
2256 ret = host->bus_ops->power_save(host);
2260 mmc_power_off(host);
2264 EXPORT_SYMBOL(mmc_power_save_host);
2266 int mmc_power_restore_host(struct mmc_host *host)
2270 #ifdef CONFIG_MMC_DEBUG
2271 pr_info("%s: %s: powering up\n", mmc_hostname(host), __func__);
2276 if (!host->bus_ops || host->bus_dead || !host->bus_ops->power_restore) {
2282 ret = host->bus_ops->power_restore(host);
2288 EXPORT_SYMBOL(mmc_power_restore_host);
2290 int mmc_card_awake(struct mmc_host *host)
2294 if (host->caps2 & MMC_CAP2_NO_SLEEP_CMD)
2299 if (host->bus_ops && !host->bus_dead && host->bus_ops->awake)
2300 err = host->bus_ops->awake(host);
2306 EXPORT_SYMBOL(mmc_card_awake);
2308 int mmc_card_sleep(struct mmc_host *host)
2312 if (host->caps2 & MMC_CAP2_NO_SLEEP_CMD)
2317 if (host->bus_ops && !host->bus_dead && host->bus_ops->sleep)
2318 err = host->bus_ops->sleep(host);
2324 EXPORT_SYMBOL(mmc_card_sleep);
2326 int mmc_card_can_sleep(struct mmc_host *host)
2328 struct mmc_card *card = host->card;
2330 if (card && mmc_card_mmc(card) && card->ext_csd.rev >= 3)
2334 EXPORT_SYMBOL(mmc_card_can_sleep);
2337 * Flush the cache to the non-volatile storage.
2339 int mmc_flush_cache(struct mmc_card *card)
2341 struct mmc_host *host = card->host;
2344 if (!(host->caps2 & MMC_CAP2_CACHE_CTRL))
2347 if (mmc_card_mmc(card) &&
2348 (card->ext_csd.cache_size > 0) &&
2349 (card->ext_csd.cache_ctrl & 1)) {
2350 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
2351 EXT_CSD_FLUSH_CACHE, 1, 0);
2353 pr_err("%s: cache flush error %d\n",
2354 mmc_hostname(card->host), err);
2359 EXPORT_SYMBOL(mmc_flush_cache);
2362 * Turn the cache ON/OFF.
2363 * Turning the cache OFF shall trigger flushing of the data
2364 * to the non-volatile storage.
2366 int mmc_cache_ctrl(struct mmc_host *host, u8 enable)
2368 struct mmc_card *card = host->card;
2369 unsigned int timeout;
2372 if (!(host->caps2 & MMC_CAP2_CACHE_CTRL) ||
2373 mmc_card_is_removable(host))
2376 if (card && mmc_card_mmc(card) &&
2377 (card->ext_csd.cache_size > 0)) {
2380 if (card->ext_csd.cache_ctrl ^ enable) {
2381 timeout = enable ? card->ext_csd.generic_cmd6_time : 0;
2382 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
2383 EXT_CSD_CACHE_CTRL, enable, timeout);
2385 pr_err("%s: cache %s error %d\n",
2386 mmc_hostname(card->host),
2387 enable ? "on" : "off",
2390 card->ext_csd.cache_ctrl = enable;
2396 EXPORT_SYMBOL(mmc_cache_ctrl);
2401 * mmc_suspend_host - suspend a host
2404 int mmc_suspend_host(struct mmc_host *host)
2408 if (host->caps & MMC_CAP_DISABLE)
2409 cancel_delayed_work(&host->disable);
2410 cancel_delayed_work(&host->detect);
2411 mmc_flush_scheduled_work();
2412 if (mmc_try_claim_host(host)) {
2413 err = mmc_cache_ctrl(host, 0);
2414 mmc_do_release_host(host);
2423 if (host->bus_ops && !host->bus_dead) {
2426 * A long response time is not acceptable for device drivers
2427 * when doing suspend. Prevent mmc_claim_host in the suspend
2428 * sequence, to potentially wait "forever" by trying to
2429 * pre-claim the host.
2431 if (mmc_try_claim_host(host)) {
2432 if (host->bus_ops->suspend) {
2433 err = host->bus_ops->suspend(host);
2435 mmc_do_release_host(host);
2437 if (err == -ENOSYS || !host->bus_ops->resume) {
2439 * We simply "remove" the card in this case.
2440 * It will be redetected on resume. (Calling
2441 * bus_ops->remove() with a claimed host can
2444 if (host->bus_ops->remove)
2445 host->bus_ops->remove(host);
2446 mmc_claim_host(host);
2447 mmc_detach_bus(host);
2448 mmc_power_off(host);
2449 mmc_release_host(host);
2459 if (!err && !mmc_card_keep_power(host))
2460 mmc_power_off(host);
2466 EXPORT_SYMBOL(mmc_suspend_host);
2469 * mmc_resume_host - resume a previously suspended host
2472 int mmc_resume_host(struct mmc_host *host)
2477 if (host->bus_ops && !host->bus_dead) {
2478 if (!mmc_card_keep_power(host)) {
2480 mmc_select_voltage(host, host->ocr);
2482 * Tell runtime PM core we just powered up the card,
2483 * since it still believes the card is powered off.
2484 * Note that currently runtime PM is only enabled
2485 * for SDIO cards that are MMC_CAP_POWER_OFF_CARD
2487 if (mmc_card_sdio(host->card) &&
2488 (host->caps & MMC_CAP_POWER_OFF_CARD)) {
2489 pm_runtime_disable(&host->card->dev);
2490 pm_runtime_set_active(&host->card->dev);
2491 pm_runtime_enable(&host->card->dev);
2494 BUG_ON(!host->bus_ops->resume);
2495 err = host->bus_ops->resume(host);
2497 pr_warning("%s: error %d during resume "
2498 "(card was removed?)\n",
2499 mmc_hostname(host), err);
2503 host->pm_flags &= ~MMC_PM_KEEP_POWER;
2508 EXPORT_SYMBOL(mmc_resume_host);
2510 /* Do the card removal on suspend if card is assumed removeable
2511 * Do that in pm notifier while userspace isn't yet frozen, so we will be able
2514 int mmc_pm_notify(struct notifier_block *notify_block,
2515 unsigned long mode, void *unused)
2517 struct mmc_host *host = container_of(
2518 notify_block, struct mmc_host, pm_notify);
2519 unsigned long flags;
2523 case PM_HIBERNATION_PREPARE:
2524 case PM_SUSPEND_PREPARE:
2526 spin_lock_irqsave(&host->lock, flags);
2527 host->rescan_disable = 1;
2528 host->power_notify_type = MMC_HOST_PW_NOTIFY_SHORT;
2529 spin_unlock_irqrestore(&host->lock, flags);
2530 cancel_delayed_work_sync(&host->detect);
2532 if (!host->bus_ops || host->bus_ops->suspend)
2535 /* Calling bus_ops->remove() with a claimed host can deadlock */
2536 if (host->bus_ops->remove)
2537 host->bus_ops->remove(host);
2539 mmc_claim_host(host);
2540 mmc_detach_bus(host);
2541 mmc_power_off(host);
2542 mmc_release_host(host);
2546 case PM_POST_SUSPEND:
2547 case PM_POST_HIBERNATION:
2548 case PM_POST_RESTORE:
2550 spin_lock_irqsave(&host->lock, flags);
2551 host->rescan_disable = 0;
2552 host->power_notify_type = MMC_HOST_PW_NOTIFY_LONG;
2553 spin_unlock_irqrestore(&host->lock, flags);
2554 mmc_detect_change(host, 0);
2562 static int __init mmc_init(void)
2566 workqueue = alloc_ordered_workqueue("kmmcd", 0);
2570 ret = mmc_register_bus();
2572 goto destroy_workqueue;
2574 ret = mmc_register_host_class();
2576 goto unregister_bus;
2578 ret = sdio_register_bus();
2580 goto unregister_host_class;
2584 unregister_host_class:
2585 mmc_unregister_host_class();
2587 mmc_unregister_bus();
2589 destroy_workqueue(workqueue);
2594 static void __exit mmc_exit(void)
2596 sdio_unregister_bus();
2597 mmc_unregister_host_class();
2598 mmc_unregister_bus();
2599 destroy_workqueue(workqueue);
2602 subsys_initcall(mmc_init);
2603 module_exit(mmc_exit);
2605 MODULE_LICENSE("GPL");