1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/drivers/mmc/core/core.c
5 * Copyright (C) 2003-2004 Russell King, All Rights Reserved.
6 * SD support Copyright (C) 2004 Ian Molton, All Rights Reserved.
7 * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
8 * MMCv4 support Copyright (C) 2006 Philip Langdale, All Rights Reserved.
10 #include <linux/module.h>
11 #include <linux/init.h>
12 #include <linux/interrupt.h>
13 #include <linux/completion.h>
14 #include <linux/device.h>
15 #include <linux/delay.h>
16 #include <linux/pagemap.h>
17 #include <linux/err.h>
18 #include <linux/leds.h>
19 #include <linux/scatterlist.h>
20 #include <linux/log2.h>
21 #include <linux/pm_runtime.h>
22 #include <linux/pm_wakeup.h>
23 #include <linux/suspend.h>
24 #include <linux/fault-inject.h>
25 #include <linux/random.h>
26 #include <linux/slab.h>
29 #include <linux/mmc/card.h>
30 #include <linux/mmc/host.h>
31 #include <linux/mmc/mmc.h>
32 #include <linux/mmc/sd.h>
33 #include <linux/mmc/slot-gpio.h>
35 #define CREATE_TRACE_POINTS
36 #include <trace/events/mmc.h>
49 /* The max erase timeout, used when host->max_busy_timeout isn't specified */
50 #define MMC_ERASE_TIMEOUT_MS (60 * 1000) /* 60 s */
51 #define SD_DISCARD_TIMEOUT_MS (250)
53 static const unsigned freqs[] = { 400000, 300000, 200000, 100000 };
56 * Enabling software CRCs on the data blocks can be a significant (30%)
57 * performance cost, and for other reasons may not always be desired.
58 * So we allow it it to be disabled.
61 module_param(use_spi_crc, bool, 0);
63 static int mmc_schedule_delayed_work(struct delayed_work *work,
67 * We use the system_freezable_wq, because of two reasons.
68 * First, it allows several works (not the same work item) to be
69 * executed simultaneously. Second, the queue becomes frozen when
70 * userspace becomes frozen during system PM.
72 return queue_delayed_work(system_freezable_wq, work, delay);
75 #ifdef CONFIG_FAIL_MMC_REQUEST
78 * Internal function. Inject random data errors.
79 * If mmc_data is NULL no errors are injected.
81 static void mmc_should_fail_request(struct mmc_host *host,
82 struct mmc_request *mrq)
84 struct mmc_command *cmd = mrq->cmd;
85 struct mmc_data *data = mrq->data;
86 static const int data_errors[] = {
95 if ((cmd && cmd->error) || data->error ||
96 !should_fail(&host->fail_mmc_request, data->blksz * data->blocks))
99 data->error = data_errors[prandom_u32() % ARRAY_SIZE(data_errors)];
100 data->bytes_xfered = (prandom_u32() % (data->bytes_xfered >> 9)) << 9;
103 #else /* CONFIG_FAIL_MMC_REQUEST */
105 static inline void mmc_should_fail_request(struct mmc_host *host,
106 struct mmc_request *mrq)
110 #endif /* CONFIG_FAIL_MMC_REQUEST */
112 static inline void mmc_complete_cmd(struct mmc_request *mrq)
114 if (mrq->cap_cmd_during_tfr && !completion_done(&mrq->cmd_completion))
115 complete_all(&mrq->cmd_completion);
118 void mmc_command_done(struct mmc_host *host, struct mmc_request *mrq)
120 if (!mrq->cap_cmd_during_tfr)
123 mmc_complete_cmd(mrq);
125 pr_debug("%s: cmd done, tfr ongoing (CMD%u)\n",
126 mmc_hostname(host), mrq->cmd->opcode);
128 EXPORT_SYMBOL(mmc_command_done);
131 * mmc_request_done - finish processing an MMC request
132 * @host: MMC host which completed request
133 * @mrq: MMC request which request
135 * MMC drivers should call this function when they have completed
136 * their processing of a request.
138 void mmc_request_done(struct mmc_host *host, struct mmc_request *mrq)
140 struct mmc_command *cmd = mrq->cmd;
141 int err = cmd->error;
143 /* Flag re-tuning needed on CRC errors */
144 if (cmd->opcode != MMC_SEND_TUNING_BLOCK &&
145 cmd->opcode != MMC_SEND_TUNING_BLOCK_HS200 &&
146 !host->retune_crc_disable &&
147 (err == -EILSEQ || (mrq->sbc && mrq->sbc->error == -EILSEQ) ||
148 (mrq->data && mrq->data->error == -EILSEQ) ||
149 (mrq->stop && mrq->stop->error == -EILSEQ)))
150 mmc_retune_needed(host);
152 if (err && cmd->retries && mmc_host_is_spi(host)) {
153 if (cmd->resp[0] & R1_SPI_ILLEGAL_COMMAND)
157 if (host->ongoing_mrq == mrq)
158 host->ongoing_mrq = NULL;
160 mmc_complete_cmd(mrq);
162 trace_mmc_request_done(host, mrq);
165 * We list various conditions for the command to be considered
168 * - There was no error, OK fine then
169 * - We are not doing some kind of retry
170 * - The card was removed (...so just complete everything no matter
171 * if there are errors or retries)
173 if (!err || !cmd->retries || mmc_card_removed(host->card)) {
174 mmc_should_fail_request(host, mrq);
176 if (!host->ongoing_mrq)
177 led_trigger_event(host->led, LED_OFF);
180 pr_debug("%s: req done <CMD%u>: %d: %08x %08x %08x %08x\n",
181 mmc_hostname(host), mrq->sbc->opcode,
183 mrq->sbc->resp[0], mrq->sbc->resp[1],
184 mrq->sbc->resp[2], mrq->sbc->resp[3]);
187 pr_debug("%s: req done (CMD%u): %d: %08x %08x %08x %08x\n",
188 mmc_hostname(host), cmd->opcode, err,
189 cmd->resp[0], cmd->resp[1],
190 cmd->resp[2], cmd->resp[3]);
193 pr_debug("%s: %d bytes transferred: %d\n",
195 mrq->data->bytes_xfered, mrq->data->error);
199 pr_debug("%s: (CMD%u): %d: %08x %08x %08x %08x\n",
200 mmc_hostname(host), mrq->stop->opcode,
202 mrq->stop->resp[0], mrq->stop->resp[1],
203 mrq->stop->resp[2], mrq->stop->resp[3]);
207 * Request starter must handle retries - see
208 * mmc_wait_for_req_done().
214 EXPORT_SYMBOL(mmc_request_done);
216 static void __mmc_start_request(struct mmc_host *host, struct mmc_request *mrq)
220 /* Assumes host controller has been runtime resumed by mmc_claim_host */
221 err = mmc_retune(host);
223 mrq->cmd->error = err;
224 mmc_request_done(host, mrq);
229 * For sdio rw commands we must wait for card busy otherwise some
230 * sdio devices won't work properly.
231 * And bypass I/O abort, reset and bus suspend operations.
233 if (sdio_is_io_busy(mrq->cmd->opcode, mrq->cmd->arg) &&
234 host->ops->card_busy) {
235 int tries = 500; /* Wait aprox 500ms at maximum */
237 while (host->ops->card_busy(host) && --tries)
241 mrq->cmd->error = -EBUSY;
242 mmc_request_done(host, mrq);
247 if (mrq->cap_cmd_during_tfr) {
248 host->ongoing_mrq = mrq;
250 * Retry path could come through here without having waiting on
251 * cmd_completion, so ensure it is reinitialised.
253 reinit_completion(&mrq->cmd_completion);
256 trace_mmc_request_start(host, mrq);
259 host->cqe_ops->cqe_off(host);
261 host->ops->request(host, mrq);
264 static void mmc_mrq_pr_debug(struct mmc_host *host, struct mmc_request *mrq,
268 pr_debug("<%s: starting CMD%u arg %08x flags %08x>\n",
269 mmc_hostname(host), mrq->sbc->opcode,
270 mrq->sbc->arg, mrq->sbc->flags);
274 pr_debug("%s: starting %sCMD%u arg %08x flags %08x\n",
275 mmc_hostname(host), cqe ? "CQE direct " : "",
276 mrq->cmd->opcode, mrq->cmd->arg, mrq->cmd->flags);
278 pr_debug("%s: starting CQE transfer for tag %d blkaddr %u\n",
279 mmc_hostname(host), mrq->tag, mrq->data->blk_addr);
283 pr_debug("%s: blksz %d blocks %d flags %08x "
284 "tsac %d ms nsac %d\n",
285 mmc_hostname(host), mrq->data->blksz,
286 mrq->data->blocks, mrq->data->flags,
287 mrq->data->timeout_ns / 1000000,
288 mrq->data->timeout_clks);
292 pr_debug("%s: CMD%u arg %08x flags %08x\n",
293 mmc_hostname(host), mrq->stop->opcode,
294 mrq->stop->arg, mrq->stop->flags);
298 static int mmc_mrq_prep(struct mmc_host *host, struct mmc_request *mrq)
300 unsigned int i, sz = 0;
301 struct scatterlist *sg;
306 mrq->cmd->data = mrq->data;
313 if (mrq->data->blksz > host->max_blk_size ||
314 mrq->data->blocks > host->max_blk_count ||
315 mrq->data->blocks * mrq->data->blksz > host->max_req_size)
318 for_each_sg(mrq->data->sg, sg, mrq->data->sg_len, i)
320 if (sz != mrq->data->blocks * mrq->data->blksz)
323 mrq->data->error = 0;
324 mrq->data->mrq = mrq;
326 mrq->data->stop = mrq->stop;
327 mrq->stop->error = 0;
328 mrq->stop->mrq = mrq;
335 int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq)
339 init_completion(&mrq->cmd_completion);
341 mmc_retune_hold(host);
343 if (mmc_card_removed(host->card))
346 mmc_mrq_pr_debug(host, mrq, false);
348 WARN_ON(!host->claimed);
350 err = mmc_mrq_prep(host, mrq);
354 led_trigger_event(host->led, LED_FULL);
355 __mmc_start_request(host, mrq);
359 EXPORT_SYMBOL(mmc_start_request);
361 static void mmc_wait_done(struct mmc_request *mrq)
363 complete(&mrq->completion);
366 static inline void mmc_wait_ongoing_tfr_cmd(struct mmc_host *host)
368 struct mmc_request *ongoing_mrq = READ_ONCE(host->ongoing_mrq);
371 * If there is an ongoing transfer, wait for the command line to become
374 if (ongoing_mrq && !completion_done(&ongoing_mrq->cmd_completion))
375 wait_for_completion(&ongoing_mrq->cmd_completion);
378 static int __mmc_start_req(struct mmc_host *host, struct mmc_request *mrq)
382 mmc_wait_ongoing_tfr_cmd(host);
384 init_completion(&mrq->completion);
385 mrq->done = mmc_wait_done;
387 err = mmc_start_request(host, mrq);
389 mrq->cmd->error = err;
390 mmc_complete_cmd(mrq);
391 complete(&mrq->completion);
397 void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq)
399 struct mmc_command *cmd;
402 wait_for_completion(&mrq->completion);
407 * If host has timed out waiting for the sanitize
408 * to complete, card might be still in programming state
409 * so let's try to bring the card out of programming
412 if (cmd->sanitize_busy && cmd->error == -ETIMEDOUT) {
413 if (!mmc_interrupt_hpi(host->card)) {
414 pr_warn("%s: %s: Interrupted sanitize\n",
415 mmc_hostname(host), __func__);
419 pr_err("%s: %s: Failed to interrupt sanitize\n",
420 mmc_hostname(host), __func__);
423 if (!cmd->error || !cmd->retries ||
424 mmc_card_removed(host->card))
427 mmc_retune_recheck(host);
429 pr_debug("%s: req failed (CMD%u): %d, retrying...\n",
430 mmc_hostname(host), cmd->opcode, cmd->error);
433 __mmc_start_request(host, mrq);
436 mmc_retune_release(host);
438 EXPORT_SYMBOL(mmc_wait_for_req_done);
441 * mmc_cqe_start_req - Start a CQE request.
442 * @host: MMC host to start the request
443 * @mrq: request to start
445 * Start the request, re-tuning if needed and it is possible. Returns an error
446 * code if the request fails to start or -EBUSY if CQE is busy.
448 int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq)
453 * CQE cannot process re-tuning commands. Caller must hold retuning
454 * while CQE is in use. Re-tuning can happen here only when CQE has no
455 * active requests i.e. this is the first. Note, re-tuning will call
458 err = mmc_retune(host);
464 mmc_mrq_pr_debug(host, mrq, true);
466 err = mmc_mrq_prep(host, mrq);
470 err = host->cqe_ops->cqe_request(host, mrq);
474 trace_mmc_request_start(host, mrq);
480 pr_debug("%s: failed to start CQE direct CMD%u, error %d\n",
481 mmc_hostname(host), mrq->cmd->opcode, err);
483 pr_debug("%s: failed to start CQE transfer for tag %d, error %d\n",
484 mmc_hostname(host), mrq->tag, err);
488 EXPORT_SYMBOL(mmc_cqe_start_req);
491 * mmc_cqe_request_done - CQE has finished processing an MMC request
492 * @host: MMC host which completed request
493 * @mrq: MMC request which completed
495 * CQE drivers should call this function when they have completed
496 * their processing of a request.
498 void mmc_cqe_request_done(struct mmc_host *host, struct mmc_request *mrq)
500 mmc_should_fail_request(host, mrq);
502 /* Flag re-tuning needed on CRC errors */
503 if ((mrq->cmd && mrq->cmd->error == -EILSEQ) ||
504 (mrq->data && mrq->data->error == -EILSEQ))
505 mmc_retune_needed(host);
507 trace_mmc_request_done(host, mrq);
510 pr_debug("%s: CQE req done (direct CMD%u): %d\n",
511 mmc_hostname(host), mrq->cmd->opcode, mrq->cmd->error);
513 pr_debug("%s: CQE transfer done tag %d\n",
514 mmc_hostname(host), mrq->tag);
518 pr_debug("%s: %d bytes transferred: %d\n",
520 mrq->data->bytes_xfered, mrq->data->error);
525 EXPORT_SYMBOL(mmc_cqe_request_done);
528 * mmc_cqe_post_req - CQE post process of a completed MMC request
530 * @mrq: MMC request to be processed
532 void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq)
534 if (host->cqe_ops->cqe_post_req)
535 host->cqe_ops->cqe_post_req(host, mrq);
537 EXPORT_SYMBOL(mmc_cqe_post_req);
539 /* Arbitrary 1 second timeout */
540 #define MMC_CQE_RECOVERY_TIMEOUT 1000
543 * mmc_cqe_recovery - Recover from CQE errors.
544 * @host: MMC host to recover
546 * Recovery consists of stopping CQE, stopping eMMC, discarding the queue in
547 * in eMMC, and discarding the queue in CQE. CQE must call
548 * mmc_cqe_request_done() on all requests. An error is returned if the eMMC
549 * fails to discard its queue.
551 int mmc_cqe_recovery(struct mmc_host *host)
553 struct mmc_command cmd;
556 mmc_retune_hold_now(host);
559 * Recovery is expected seldom, if at all, but it reduces performance,
560 * so make sure it is not completely silent.
562 pr_warn("%s: running CQE recovery\n", mmc_hostname(host));
564 host->cqe_ops->cqe_recovery_start(host);
566 memset(&cmd, 0, sizeof(cmd));
567 cmd.opcode = MMC_STOP_TRANSMISSION,
568 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC,
569 cmd.flags &= ~MMC_RSP_CRC; /* Ignore CRC */
570 cmd.busy_timeout = MMC_CQE_RECOVERY_TIMEOUT,
571 mmc_wait_for_cmd(host, &cmd, 0);
573 memset(&cmd, 0, sizeof(cmd));
574 cmd.opcode = MMC_CMDQ_TASK_MGMT;
575 cmd.arg = 1; /* Discard entire queue */
576 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC;
577 cmd.flags &= ~MMC_RSP_CRC; /* Ignore CRC */
578 cmd.busy_timeout = MMC_CQE_RECOVERY_TIMEOUT,
579 err = mmc_wait_for_cmd(host, &cmd, 0);
581 host->cqe_ops->cqe_recovery_finish(host);
583 mmc_retune_release(host);
587 EXPORT_SYMBOL(mmc_cqe_recovery);
590 * mmc_is_req_done - Determine if a 'cap_cmd_during_tfr' request is done
594 * mmc_is_req_done() is used with requests that have
595 * mrq->cap_cmd_during_tfr = true. mmc_is_req_done() must be called after
596 * starting a request and before waiting for it to complete. That is,
597 * either in between calls to mmc_start_req(), or after mmc_wait_for_req()
598 * and before mmc_wait_for_req_done(). If it is called at other times the
599 * result is not meaningful.
601 bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq)
603 return completion_done(&mrq->completion);
605 EXPORT_SYMBOL(mmc_is_req_done);
608 * mmc_wait_for_req - start a request and wait for completion
609 * @host: MMC host to start command
610 * @mrq: MMC request to start
612 * Start a new MMC custom command request for a host, and wait
613 * for the command to complete. In the case of 'cap_cmd_during_tfr'
614 * requests, the transfer is ongoing and the caller can issue further
615 * commands that do not use the data lines, and then wait by calling
616 * mmc_wait_for_req_done().
617 * Does not attempt to parse the response.
619 void mmc_wait_for_req(struct mmc_host *host, struct mmc_request *mrq)
621 __mmc_start_req(host, mrq);
623 if (!mrq->cap_cmd_during_tfr)
624 mmc_wait_for_req_done(host, mrq);
626 EXPORT_SYMBOL(mmc_wait_for_req);
629 * mmc_wait_for_cmd - start a command and wait for completion
630 * @host: MMC host to start command
631 * @cmd: MMC command to start
632 * @retries: maximum number of retries
634 * Start a new MMC command for a host, and wait for the command
635 * to complete. Return any error that occurred while the command
636 * was executing. Do not attempt to parse the response.
638 int mmc_wait_for_cmd(struct mmc_host *host, struct mmc_command *cmd, int retries)
640 struct mmc_request mrq = {};
642 WARN_ON(!host->claimed);
644 memset(cmd->resp, 0, sizeof(cmd->resp));
645 cmd->retries = retries;
650 mmc_wait_for_req(host, &mrq);
655 EXPORT_SYMBOL(mmc_wait_for_cmd);
658 * mmc_set_data_timeout - set the timeout for a data command
659 * @data: data phase for command
660 * @card: the MMC card associated with the data transfer
662 * Computes the data timeout parameters according to the
663 * correct algorithm given the card type.
665 void mmc_set_data_timeout(struct mmc_data *data, const struct mmc_card *card)
670 * SDIO cards only define an upper 1 s limit on access.
672 if (mmc_card_sdio(card)) {
673 data->timeout_ns = 1000000000;
674 data->timeout_clks = 0;
679 * SD cards use a 100 multiplier rather than 10
681 mult = mmc_card_sd(card) ? 100 : 10;
684 * Scale up the multiplier (and therefore the timeout) by
685 * the r2w factor for writes.
687 if (data->flags & MMC_DATA_WRITE)
688 mult <<= card->csd.r2w_factor;
690 data->timeout_ns = card->csd.taac_ns * mult;
691 data->timeout_clks = card->csd.taac_clks * mult;
694 * SD cards also have an upper limit on the timeout.
696 if (mmc_card_sd(card)) {
697 unsigned int timeout_us, limit_us;
699 timeout_us = data->timeout_ns / 1000;
700 if (card->host->ios.clock)
701 timeout_us += data->timeout_clks * 1000 /
702 (card->host->ios.clock / 1000);
704 if (data->flags & MMC_DATA_WRITE)
706 * The MMC spec "It is strongly recommended
707 * for hosts to implement more than 500ms
708 * timeout value even if the card indicates
709 * the 250ms maximum busy length." Even the
710 * previous value of 300ms is known to be
711 * insufficient for some cards.
718 * SDHC cards always use these fixed values.
720 if (timeout_us > limit_us) {
721 data->timeout_ns = limit_us * 1000;
722 data->timeout_clks = 0;
725 /* assign limit value if invalid */
727 data->timeout_ns = limit_us * 1000;
731 * Some cards require longer data read timeout than indicated in CSD.
732 * Address this by setting the read timeout to a "reasonably high"
733 * value. For the cards tested, 600ms has proven enough. If necessary,
734 * this value can be increased if other problematic cards require this.
736 if (mmc_card_long_read_time(card) && data->flags & MMC_DATA_READ) {
737 data->timeout_ns = 600000000;
738 data->timeout_clks = 0;
742 * Some cards need very high timeouts if driven in SPI mode.
743 * The worst observed timeout was 900ms after writing a
744 * continuous stream of data until the internal logic
747 if (mmc_host_is_spi(card->host)) {
748 if (data->flags & MMC_DATA_WRITE) {
749 if (data->timeout_ns < 1000000000)
750 data->timeout_ns = 1000000000; /* 1s */
752 if (data->timeout_ns < 100000000)
753 data->timeout_ns = 100000000; /* 100ms */
757 EXPORT_SYMBOL(mmc_set_data_timeout);
760 * Allow claiming an already claimed host if the context is the same or there is
761 * no context but the task is the same.
763 static inline bool mmc_ctx_matches(struct mmc_host *host, struct mmc_ctx *ctx,
764 struct task_struct *task)
766 return host->claimer == ctx ||
767 (!ctx && task && host->claimer->task == task);
770 static inline void mmc_ctx_set_claimer(struct mmc_host *host,
772 struct task_struct *task)
774 if (!host->claimer) {
778 host->claimer = &host->default_ctx;
781 host->claimer->task = task;
785 * __mmc_claim_host - exclusively claim a host
786 * @host: mmc host to claim
787 * @ctx: context that claims the host or NULL in which case the default
788 * context will be used
789 * @abort: whether or not the operation should be aborted
791 * Claim a host for a set of operations. If @abort is non null and
792 * dereference a non-zero value then this will return prematurely with
793 * that non-zero value without acquiring the lock. Returns zero
794 * with the lock held otherwise.
796 int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx,
799 struct task_struct *task = ctx ? NULL : current;
800 DECLARE_WAITQUEUE(wait, current);
807 add_wait_queue(&host->wq, &wait);
808 spin_lock_irqsave(&host->lock, flags);
810 set_current_state(TASK_UNINTERRUPTIBLE);
811 stop = abort ? atomic_read(abort) : 0;
812 if (stop || !host->claimed || mmc_ctx_matches(host, ctx, task))
814 spin_unlock_irqrestore(&host->lock, flags);
816 spin_lock_irqsave(&host->lock, flags);
818 set_current_state(TASK_RUNNING);
821 mmc_ctx_set_claimer(host, ctx, task);
822 host->claim_cnt += 1;
823 if (host->claim_cnt == 1)
827 spin_unlock_irqrestore(&host->lock, flags);
828 remove_wait_queue(&host->wq, &wait);
831 pm_runtime_get_sync(mmc_dev(host));
835 EXPORT_SYMBOL(__mmc_claim_host);
838 * mmc_release_host - release a host
839 * @host: mmc host to release
841 * Release a MMC host, allowing others to claim the host
842 * for their operations.
844 void mmc_release_host(struct mmc_host *host)
848 WARN_ON(!host->claimed);
850 spin_lock_irqsave(&host->lock, flags);
851 if (--host->claim_cnt) {
852 /* Release for nested claim */
853 spin_unlock_irqrestore(&host->lock, flags);
856 host->claimer->task = NULL;
857 host->claimer = NULL;
858 spin_unlock_irqrestore(&host->lock, flags);
860 pm_runtime_mark_last_busy(mmc_dev(host));
861 if (host->caps & MMC_CAP_SYNC_RUNTIME_PM)
862 pm_runtime_put_sync_suspend(mmc_dev(host));
864 pm_runtime_put_autosuspend(mmc_dev(host));
867 EXPORT_SYMBOL(mmc_release_host);
870 * This is a helper function, which fetches a runtime pm reference for the
871 * card device and also claims the host.
873 void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx)
875 pm_runtime_get_sync(&card->dev);
876 __mmc_claim_host(card->host, ctx, NULL);
878 EXPORT_SYMBOL(mmc_get_card);
881 * This is a helper function, which releases the host and drops the runtime
882 * pm reference for the card device.
884 void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx)
886 struct mmc_host *host = card->host;
888 WARN_ON(ctx && host->claimer != ctx);
890 mmc_release_host(host);
891 pm_runtime_mark_last_busy(&card->dev);
892 pm_runtime_put_autosuspend(&card->dev);
894 EXPORT_SYMBOL(mmc_put_card);
897 * Internal function that does the actual ios call to the host driver,
898 * optionally printing some debug output.
900 static inline void mmc_set_ios(struct mmc_host *host)
902 struct mmc_ios *ios = &host->ios;
904 pr_debug("%s: clock %uHz busmode %u powermode %u cs %u Vdd %u "
905 "width %u timing %u\n",
906 mmc_hostname(host), ios->clock, ios->bus_mode,
907 ios->power_mode, ios->chip_select, ios->vdd,
908 1 << ios->bus_width, ios->timing);
910 host->ops->set_ios(host, ios);
914 * Control chip select pin on a host.
916 void mmc_set_chip_select(struct mmc_host *host, int mode)
918 host->ios.chip_select = mode;
923 * Sets the host clock to the highest possible frequency that
926 void mmc_set_clock(struct mmc_host *host, unsigned int hz)
928 WARN_ON(hz && hz < host->f_min);
930 if (hz > host->f_max)
933 host->ios.clock = hz;
937 int mmc_execute_tuning(struct mmc_card *card)
939 struct mmc_host *host = card->host;
943 if (!host->ops->execute_tuning)
947 host->cqe_ops->cqe_off(host);
949 if (mmc_card_mmc(card))
950 opcode = MMC_SEND_TUNING_BLOCK_HS200;
952 opcode = MMC_SEND_TUNING_BLOCK;
954 err = host->ops->execute_tuning(host, opcode);
957 pr_err("%s: tuning execution failed: %d\n",
958 mmc_hostname(host), err);
960 host->retune_now = 0;
961 host->need_retune = 0;
962 mmc_retune_enable(host);
969 * Change the bus mode (open drain/push-pull) of a host.
971 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode)
973 host->ios.bus_mode = mode;
978 * Change data bus width of a host.
980 void mmc_set_bus_width(struct mmc_host *host, unsigned int width)
982 host->ios.bus_width = width;
987 * Set initial state after a power cycle or a hw_reset.
989 void mmc_set_initial_state(struct mmc_host *host)
992 host->cqe_ops->cqe_off(host);
994 mmc_retune_disable(host);
996 if (mmc_host_is_spi(host))
997 host->ios.chip_select = MMC_CS_HIGH;
999 host->ios.chip_select = MMC_CS_DONTCARE;
1000 host->ios.bus_mode = MMC_BUSMODE_PUSHPULL;
1001 host->ios.bus_width = MMC_BUS_WIDTH_1;
1002 host->ios.timing = MMC_TIMING_LEGACY;
1003 host->ios.drv_type = 0;
1004 host->ios.enhanced_strobe = false;
1007 * Make sure we are in non-enhanced strobe mode before we
1008 * actually enable it in ext_csd.
1010 if ((host->caps2 & MMC_CAP2_HS400_ES) &&
1011 host->ops->hs400_enhanced_strobe)
1012 host->ops->hs400_enhanced_strobe(host, &host->ios);
1018 * mmc_vdd_to_ocrbitnum - Convert a voltage to the OCR bit number
1019 * @vdd: voltage (mV)
1020 * @low_bits: prefer low bits in boundary cases
1022 * This function returns the OCR bit number according to the provided @vdd
1023 * value. If conversion is not possible a negative errno value returned.
1025 * Depending on the @low_bits flag the function prefers low or high OCR bits
1026 * on boundary voltages. For example,
1027 * with @low_bits = true, 3300 mV translates to ilog2(MMC_VDD_32_33);
1028 * with @low_bits = false, 3300 mV translates to ilog2(MMC_VDD_33_34);
1030 * Any value in the [1951:1999] range translates to the ilog2(MMC_VDD_20_21).
1032 static int mmc_vdd_to_ocrbitnum(int vdd, bool low_bits)
1034 const int max_bit = ilog2(MMC_VDD_35_36);
1037 if (vdd < 1650 || vdd > 3600)
1040 if (vdd >= 1650 && vdd <= 1950)
1041 return ilog2(MMC_VDD_165_195);
1046 /* Base 2000 mV, step 100 mV, bit's base 8. */
1047 bit = (vdd - 2000) / 100 + 8;
1054 * mmc_vddrange_to_ocrmask - Convert a voltage range to the OCR mask
1055 * @vdd_min: minimum voltage value (mV)
1056 * @vdd_max: maximum voltage value (mV)
1058 * This function returns the OCR mask bits according to the provided @vdd_min
1059 * and @vdd_max values. If conversion is not possible the function returns 0.
1061 * Notes wrt boundary cases:
1062 * This function sets the OCR bits for all boundary voltages, for example
1063 * [3300:3400] range is translated to MMC_VDD_32_33 | MMC_VDD_33_34 |
1064 * MMC_VDD_34_35 mask.
1066 u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max)
1070 if (vdd_max < vdd_min)
1073 /* Prefer high bits for the boundary vdd_max values. */
1074 vdd_max = mmc_vdd_to_ocrbitnum(vdd_max, false);
1078 /* Prefer low bits for the boundary vdd_min values. */
1079 vdd_min = mmc_vdd_to_ocrbitnum(vdd_min, true);
1083 /* Fill the mask, from max bit to min bit. */
1084 while (vdd_max >= vdd_min)
1085 mask |= 1 << vdd_max--;
1090 static int mmc_of_get_func_num(struct device_node *node)
1095 ret = of_property_read_u32(node, "reg", ®);
1102 struct device_node *mmc_of_find_child_device(struct mmc_host *host,
1105 struct device_node *node;
1107 if (!host->parent || !host->parent->of_node)
1110 for_each_child_of_node(host->parent->of_node, node) {
1111 if (mmc_of_get_func_num(node) == func_num)
1119 * Mask off any voltages we don't support and select
1120 * the lowest voltage
1122 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr)
1127 * Sanity check the voltages that the card claims to
1131 dev_warn(mmc_dev(host),
1132 "card claims to support voltages below defined range\n");
1136 ocr &= host->ocr_avail;
1138 dev_warn(mmc_dev(host), "no support for card's volts\n");
1142 if (host->caps2 & MMC_CAP2_FULL_PWR_CYCLE) {
1145 mmc_power_cycle(host, ocr);
1149 if (bit != host->ios.vdd)
1150 dev_warn(mmc_dev(host), "exceeding card's volts\n");
1156 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage)
1159 int old_signal_voltage = host->ios.signal_voltage;
1161 host->ios.signal_voltage = signal_voltage;
1162 if (host->ops->start_signal_voltage_switch)
1163 err = host->ops->start_signal_voltage_switch(host, &host->ios);
1166 host->ios.signal_voltage = old_signal_voltage;
1172 void mmc_set_initial_signal_voltage(struct mmc_host *host)
1174 /* Try to set signal voltage to 3.3V but fall back to 1.8v or 1.2v */
1175 if (!mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_330))
1176 dev_dbg(mmc_dev(host), "Initial signal voltage of 3.3v\n");
1177 else if (!mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_180))
1178 dev_dbg(mmc_dev(host), "Initial signal voltage of 1.8v\n");
1179 else if (!mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_120))
1180 dev_dbg(mmc_dev(host), "Initial signal voltage of 1.2v\n");
1183 int mmc_host_set_uhs_voltage(struct mmc_host *host)
1188 * During a signal voltage level switch, the clock must be gated
1189 * for 5 ms according to the SD spec
1191 clock = host->ios.clock;
1192 host->ios.clock = 0;
1195 if (mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_180))
1198 /* Keep clock gated for at least 10 ms, though spec only says 5 ms */
1200 host->ios.clock = clock;
1206 int mmc_set_uhs_voltage(struct mmc_host *host, u32 ocr)
1208 struct mmc_command cmd = {};
1212 * If we cannot switch voltages, return failure so the caller
1213 * can continue without UHS mode
1215 if (!host->ops->start_signal_voltage_switch)
1217 if (!host->ops->card_busy)
1218 pr_warn("%s: cannot verify signal voltage switch\n",
1219 mmc_hostname(host));
1221 cmd.opcode = SD_SWITCH_VOLTAGE;
1223 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1225 err = mmc_wait_for_cmd(host, &cmd, 0);
1229 if (!mmc_host_is_spi(host) && (cmd.resp[0] & R1_ERROR))
1233 * The card should drive cmd and dat[0:3] low immediately
1234 * after the response of cmd11, but wait 1 ms to be sure
1237 if (host->ops->card_busy && !host->ops->card_busy(host)) {
1242 if (mmc_host_set_uhs_voltage(host)) {
1244 * Voltages may not have been switched, but we've already
1245 * sent CMD11, so a power cycle is required anyway
1251 /* Wait for at least 1 ms according to spec */
1255 * Failure to switch is indicated by the card holding
1258 if (host->ops->card_busy && host->ops->card_busy(host))
1263 pr_debug("%s: Signal voltage switch failed, "
1264 "power cycling card\n", mmc_hostname(host));
1265 mmc_power_cycle(host, ocr);
1272 * Select timing parameters for host.
1274 void mmc_set_timing(struct mmc_host *host, unsigned int timing)
1276 host->ios.timing = timing;
1281 * Select appropriate driver type for host.
1283 void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type)
1285 host->ios.drv_type = drv_type;
1289 int mmc_select_drive_strength(struct mmc_card *card, unsigned int max_dtr,
1290 int card_drv_type, int *drv_type)
1292 struct mmc_host *host = card->host;
1293 int host_drv_type = SD_DRIVER_TYPE_B;
1297 if (!host->ops->select_drive_strength)
1300 /* Use SD definition of driver strength for hosts */
1301 if (host->caps & MMC_CAP_DRIVER_TYPE_A)
1302 host_drv_type |= SD_DRIVER_TYPE_A;
1304 if (host->caps & MMC_CAP_DRIVER_TYPE_C)
1305 host_drv_type |= SD_DRIVER_TYPE_C;
1307 if (host->caps & MMC_CAP_DRIVER_TYPE_D)
1308 host_drv_type |= SD_DRIVER_TYPE_D;
1311 * The drive strength that the hardware can support
1312 * depends on the board design. Pass the appropriate
1313 * information and let the hardware specific code
1314 * return what is possible given the options
1316 return host->ops->select_drive_strength(card, max_dtr,
1323 * Apply power to the MMC stack. This is a two-stage process.
1324 * First, we enable power to the card without the clock running.
1325 * We then wait a bit for the power to stabilise. Finally,
1326 * enable the bus drivers and clock to the card.
1328 * We must _NOT_ enable the clock prior to power stablising.
1330 * If a host does all the power sequencing itself, ignore the
1331 * initial MMC_POWER_UP stage.
1333 void mmc_power_up(struct mmc_host *host, u32 ocr)
1335 if (host->ios.power_mode == MMC_POWER_ON)
1338 mmc_pwrseq_pre_power_on(host);
1340 host->ios.vdd = fls(ocr) - 1;
1341 host->ios.power_mode = MMC_POWER_UP;
1342 /* Set initial state and call mmc_set_ios */
1343 mmc_set_initial_state(host);
1345 mmc_set_initial_signal_voltage(host);
1348 * This delay should be sufficient to allow the power supply
1349 * to reach the minimum voltage.
1351 mmc_delay(host->ios.power_delay_ms);
1353 mmc_pwrseq_post_power_on(host);
1355 host->ios.clock = host->f_init;
1357 host->ios.power_mode = MMC_POWER_ON;
1361 * This delay must be at least 74 clock sizes, or 1 ms, or the
1362 * time required to reach a stable voltage.
1364 mmc_delay(host->ios.power_delay_ms);
1367 void mmc_power_off(struct mmc_host *host)
1369 if (host->ios.power_mode == MMC_POWER_OFF)
1372 mmc_pwrseq_power_off(host);
1374 host->ios.clock = 0;
1377 host->ios.power_mode = MMC_POWER_OFF;
1378 /* Set initial state and call mmc_set_ios */
1379 mmc_set_initial_state(host);
1382 * Some configurations, such as the 802.11 SDIO card in the OLPC
1383 * XO-1.5, require a short delay after poweroff before the card
1384 * can be successfully turned on again.
1389 void mmc_power_cycle(struct mmc_host *host, u32 ocr)
1391 mmc_power_off(host);
1392 /* Wait at least 1 ms according to SD spec */
1394 mmc_power_up(host, ocr);
1398 * Cleanup when the last reference to the bus operator is dropped.
1400 static void __mmc_release_bus(struct mmc_host *host)
1402 WARN_ON(!host->bus_dead);
1404 host->bus_ops = NULL;
1408 * Increase reference count of bus operator
1410 static inline void mmc_bus_get(struct mmc_host *host)
1412 unsigned long flags;
1414 spin_lock_irqsave(&host->lock, flags);
1416 spin_unlock_irqrestore(&host->lock, flags);
1420 * Decrease reference count of bus operator and free it if
1421 * it is the last reference.
1423 static inline void mmc_bus_put(struct mmc_host *host)
1425 unsigned long flags;
1427 spin_lock_irqsave(&host->lock, flags);
1429 if ((host->bus_refs == 0) && host->bus_ops)
1430 __mmc_release_bus(host);
1431 spin_unlock_irqrestore(&host->lock, flags);
1435 * Assign a mmc bus handler to a host. Only one bus handler may control a
1436 * host at any given time.
1438 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops)
1440 unsigned long flags;
1442 WARN_ON(!host->claimed);
1444 spin_lock_irqsave(&host->lock, flags);
1446 WARN_ON(host->bus_ops);
1447 WARN_ON(host->bus_refs);
1449 host->bus_ops = ops;
1453 spin_unlock_irqrestore(&host->lock, flags);
1457 * Remove the current bus handler from a host.
1459 void mmc_detach_bus(struct mmc_host *host)
1461 unsigned long flags;
1463 WARN_ON(!host->claimed);
1464 WARN_ON(!host->bus_ops);
1466 spin_lock_irqsave(&host->lock, flags);
1470 spin_unlock_irqrestore(&host->lock, flags);
1475 void _mmc_detect_change(struct mmc_host *host, unsigned long delay, bool cd_irq)
1478 * If the device is configured as wakeup, we prevent a new sleep for
1479 * 5 s to give provision for user space to consume the event.
1481 if (cd_irq && !(host->caps & MMC_CAP_NEEDS_POLL) &&
1482 device_can_wakeup(mmc_dev(host)))
1483 pm_wakeup_event(mmc_dev(host), 5000);
1485 host->detect_change = 1;
1486 mmc_schedule_delayed_work(&host->detect, delay);
1490 * mmc_detect_change - process change of state on a MMC socket
1491 * @host: host which changed state.
1492 * @delay: optional delay to wait before detection (jiffies)
1494 * MMC drivers should call this when they detect a card has been
1495 * inserted or removed. The MMC layer will confirm that any
1496 * present card is still functional, and initialize any newly
1499 void mmc_detect_change(struct mmc_host *host, unsigned long delay)
1501 _mmc_detect_change(host, delay, true);
1503 EXPORT_SYMBOL(mmc_detect_change);
1505 void mmc_init_erase(struct mmc_card *card)
1509 if (is_power_of_2(card->erase_size))
1510 card->erase_shift = ffs(card->erase_size) - 1;
1512 card->erase_shift = 0;
1515 * It is possible to erase an arbitrarily large area of an SD or MMC
1516 * card. That is not desirable because it can take a long time
1517 * (minutes) potentially delaying more important I/O, and also the
1518 * timeout calculations become increasingly hugely over-estimated.
1519 * Consequently, 'pref_erase' is defined as a guide to limit erases
1520 * to that size and alignment.
1522 * For SD cards that define Allocation Unit size, limit erases to one
1523 * Allocation Unit at a time.
1524 * For MMC, have a stab at ai good value and for modern cards it will
1525 * end up being 4MiB. Note that if the value is too small, it can end
1526 * up taking longer to erase. Also note, erase_size is already set to
1527 * High Capacity Erase Size if available when this function is called.
1529 if (mmc_card_sd(card) && card->ssr.au) {
1530 card->pref_erase = card->ssr.au;
1531 card->erase_shift = ffs(card->ssr.au) - 1;
1532 } else if (card->erase_size) {
1533 sz = (card->csd.capacity << (card->csd.read_blkbits - 9)) >> 11;
1535 card->pref_erase = 512 * 1024 / 512;
1537 card->pref_erase = 1024 * 1024 / 512;
1539 card->pref_erase = 2 * 1024 * 1024 / 512;
1541 card->pref_erase = 4 * 1024 * 1024 / 512;
1542 if (card->pref_erase < card->erase_size)
1543 card->pref_erase = card->erase_size;
1545 sz = card->pref_erase % card->erase_size;
1547 card->pref_erase += card->erase_size - sz;
1550 card->pref_erase = 0;
1553 static unsigned int mmc_mmc_erase_timeout(struct mmc_card *card,
1554 unsigned int arg, unsigned int qty)
1556 unsigned int erase_timeout;
1558 if (arg == MMC_DISCARD_ARG ||
1559 (arg == MMC_TRIM_ARG && card->ext_csd.rev >= 6)) {
1560 erase_timeout = card->ext_csd.trim_timeout;
1561 } else if (card->ext_csd.erase_group_def & 1) {
1562 /* High Capacity Erase Group Size uses HC timeouts */
1563 if (arg == MMC_TRIM_ARG)
1564 erase_timeout = card->ext_csd.trim_timeout;
1566 erase_timeout = card->ext_csd.hc_erase_timeout;
1568 /* CSD Erase Group Size uses write timeout */
1569 unsigned int mult = (10 << card->csd.r2w_factor);
1570 unsigned int timeout_clks = card->csd.taac_clks * mult;
1571 unsigned int timeout_us;
1573 /* Avoid overflow: e.g. taac_ns=80000000 mult=1280 */
1574 if (card->csd.taac_ns < 1000000)
1575 timeout_us = (card->csd.taac_ns * mult) / 1000;
1577 timeout_us = (card->csd.taac_ns / 1000) * mult;
1580 * ios.clock is only a target. The real clock rate might be
1581 * less but not that much less, so fudge it by multiplying by 2.
1584 timeout_us += (timeout_clks * 1000) /
1585 (card->host->ios.clock / 1000);
1587 erase_timeout = timeout_us / 1000;
1590 * Theoretically, the calculation could underflow so round up
1591 * to 1ms in that case.
1597 /* Multiplier for secure operations */
1598 if (arg & MMC_SECURE_ARGS) {
1599 if (arg == MMC_SECURE_ERASE_ARG)
1600 erase_timeout *= card->ext_csd.sec_erase_mult;
1602 erase_timeout *= card->ext_csd.sec_trim_mult;
1605 erase_timeout *= qty;
1608 * Ensure at least a 1 second timeout for SPI as per
1609 * 'mmc_set_data_timeout()'
1611 if (mmc_host_is_spi(card->host) && erase_timeout < 1000)
1612 erase_timeout = 1000;
1614 return erase_timeout;
1617 static unsigned int mmc_sd_erase_timeout(struct mmc_card *card,
1621 unsigned int erase_timeout;
1623 /* for DISCARD none of the below calculation applies.
1624 * the busy timeout is 250msec per discard command.
1626 if (arg == SD_DISCARD_ARG)
1627 return SD_DISCARD_TIMEOUT_MS;
1629 if (card->ssr.erase_timeout) {
1630 /* Erase timeout specified in SD Status Register (SSR) */
1631 erase_timeout = card->ssr.erase_timeout * qty +
1632 card->ssr.erase_offset;
1635 * Erase timeout not specified in SD Status Register (SSR) so
1636 * use 250ms per write block.
1638 erase_timeout = 250 * qty;
1641 /* Must not be less than 1 second */
1642 if (erase_timeout < 1000)
1643 erase_timeout = 1000;
1645 return erase_timeout;
1648 static unsigned int mmc_erase_timeout(struct mmc_card *card,
1652 if (mmc_card_sd(card))
1653 return mmc_sd_erase_timeout(card, arg, qty);
1655 return mmc_mmc_erase_timeout(card, arg, qty);
1658 static int mmc_do_erase(struct mmc_card *card, unsigned int from,
1659 unsigned int to, unsigned int arg)
1661 struct mmc_command cmd = {};
1662 unsigned int qty = 0, busy_timeout = 0;
1663 bool use_r1b_resp = false;
1664 unsigned long timeout;
1665 int loop_udelay=64, udelay_max=32768;
1668 mmc_retune_hold(card->host);
1671 * qty is used to calculate the erase timeout which depends on how many
1672 * erase groups (or allocation units in SD terminology) are affected.
1673 * We count erasing part of an erase group as one erase group.
1674 * For SD, the allocation units are always a power of 2. For MMC, the
1675 * erase group size is almost certainly also power of 2, but it does not
1676 * seem to insist on that in the JEDEC standard, so we fall back to
1677 * division in that case. SD may not specify an allocation unit size,
1678 * in which case the timeout is based on the number of write blocks.
1680 * Note that the timeout for secure trim 2 will only be correct if the
1681 * number of erase groups specified is the same as the total of all
1682 * preceding secure trim 1 commands. Since the power may have been
1683 * lost since the secure trim 1 commands occurred, it is generally
1684 * impossible to calculate the secure trim 2 timeout correctly.
1686 if (card->erase_shift)
1687 qty += ((to >> card->erase_shift) -
1688 (from >> card->erase_shift)) + 1;
1689 else if (mmc_card_sd(card))
1690 qty += to - from + 1;
1692 qty += ((to / card->erase_size) -
1693 (from / card->erase_size)) + 1;
1695 if (!mmc_card_blockaddr(card)) {
1700 if (mmc_card_sd(card))
1701 cmd.opcode = SD_ERASE_WR_BLK_START;
1703 cmd.opcode = MMC_ERASE_GROUP_START;
1705 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1706 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1708 pr_err("mmc_erase: group start error %d, "
1709 "status %#x\n", err, cmd.resp[0]);
1714 memset(&cmd, 0, sizeof(struct mmc_command));
1715 if (mmc_card_sd(card))
1716 cmd.opcode = SD_ERASE_WR_BLK_END;
1718 cmd.opcode = MMC_ERASE_GROUP_END;
1720 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1721 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1723 pr_err("mmc_erase: group end error %d, status %#x\n",
1729 memset(&cmd, 0, sizeof(struct mmc_command));
1730 cmd.opcode = MMC_ERASE;
1732 busy_timeout = mmc_erase_timeout(card, arg, qty);
1734 * If the host controller supports busy signalling and the timeout for
1735 * the erase operation does not exceed the max_busy_timeout, we should
1736 * use R1B response. Or we need to prevent the host from doing hw busy
1737 * detection, which is done by converting to a R1 response instead.
1738 * Note, some hosts requires R1B, which also means they are on their own
1739 * when it comes to deal with the busy timeout.
1741 if (!(card->host->caps & MMC_CAP_NEED_RSP_BUSY) &&
1742 card->host->max_busy_timeout &&
1743 busy_timeout > card->host->max_busy_timeout) {
1744 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1746 cmd.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
1747 cmd.busy_timeout = busy_timeout;
1748 use_r1b_resp = true;
1751 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1753 pr_err("mmc_erase: erase error %d, status %#x\n",
1759 if (mmc_host_is_spi(card->host))
1763 * In case of when R1B + MMC_CAP_WAIT_WHILE_BUSY is used, the polling
1766 if ((card->host->caps & MMC_CAP_WAIT_WHILE_BUSY) && use_r1b_resp)
1769 timeout = jiffies + msecs_to_jiffies(busy_timeout);
1771 memset(&cmd, 0, sizeof(struct mmc_command));
1772 cmd.opcode = MMC_SEND_STATUS;
1773 cmd.arg = card->rca << 16;
1774 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1775 /* Do not retry else we can't see errors */
1776 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1777 if (err || R1_STATUS(cmd.resp[0])) {
1778 pr_err("error %d requesting status %#x\n",
1784 /* Timeout if the device never becomes ready for data and
1785 * never leaves the program state.
1787 if (time_after(jiffies, timeout)) {
1788 pr_err("%s: Card stuck in programming state! %s\n",
1789 mmc_hostname(card->host), __func__);
1793 if ((cmd.resp[0] & R1_READY_FOR_DATA) &&
1794 R1_CURRENT_STATE(cmd.resp[0]) != R1_STATE_PRG)
1797 usleep_range(loop_udelay, loop_udelay*2);
1798 if (loop_udelay < udelay_max)
1803 mmc_retune_release(card->host);
1807 static unsigned int mmc_align_erase_size(struct mmc_card *card,
1812 unsigned int from_new = *from, nr_new = nr, rem;
1815 * When the 'card->erase_size' is power of 2, we can use round_up/down()
1816 * to align the erase size efficiently.
1818 if (is_power_of_2(card->erase_size)) {
1819 unsigned int temp = from_new;
1821 from_new = round_up(temp, card->erase_size);
1822 rem = from_new - temp;
1829 nr_new = round_down(nr_new, card->erase_size);
1831 rem = from_new % card->erase_size;
1833 rem = card->erase_size - rem;
1841 rem = nr_new % card->erase_size;
1849 *to = from_new + nr_new;
1856 * mmc_erase - erase sectors.
1857 * @card: card to erase
1858 * @from: first sector to erase
1859 * @nr: number of sectors to erase
1860 * @arg: erase command argument
1862 * Caller must claim host before calling this function.
1864 int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
1867 unsigned int rem, to = from + nr;
1870 if (!(card->host->caps & MMC_CAP_ERASE) ||
1871 !(card->csd.cmdclass & CCC_ERASE))
1874 if (!card->erase_size)
1877 if (mmc_card_sd(card) && arg != SD_ERASE_ARG && arg != SD_DISCARD_ARG)
1880 if (mmc_card_mmc(card) && (arg & MMC_SECURE_ARGS) &&
1881 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN))
1884 if (mmc_card_mmc(card) && (arg & MMC_TRIM_ARGS) &&
1885 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN))
1888 if (arg == MMC_SECURE_ERASE_ARG) {
1889 if (from % card->erase_size || nr % card->erase_size)
1893 if (arg == MMC_ERASE_ARG)
1894 nr = mmc_align_erase_size(card, &from, &to, nr);
1902 /* 'from' and 'to' are inclusive */
1906 * Special case where only one erase-group fits in the timeout budget:
1907 * If the region crosses an erase-group boundary on this particular
1908 * case, we will be trimming more than one erase-group which, does not
1909 * fit in the timeout budget of the controller, so we need to split it
1910 * and call mmc_do_erase() twice if necessary. This special case is
1911 * identified by the card->eg_boundary flag.
1913 rem = card->erase_size - (from % card->erase_size);
1914 if ((arg & MMC_TRIM_ARGS) && (card->eg_boundary) && (nr > rem)) {
1915 err = mmc_do_erase(card, from, from + rem - 1, arg);
1917 if ((err) || (to <= from))
1921 return mmc_do_erase(card, from, to, arg);
1923 EXPORT_SYMBOL(mmc_erase);
1925 int mmc_can_erase(struct mmc_card *card)
1927 if ((card->host->caps & MMC_CAP_ERASE) &&
1928 (card->csd.cmdclass & CCC_ERASE) && card->erase_size)
1932 EXPORT_SYMBOL(mmc_can_erase);
1934 int mmc_can_trim(struct mmc_card *card)
1936 if ((card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN) &&
1937 (!(card->quirks & MMC_QUIRK_TRIM_BROKEN)))
1941 EXPORT_SYMBOL(mmc_can_trim);
1943 int mmc_can_discard(struct mmc_card *card)
1946 * As there's no way to detect the discard support bit at v4.5
1947 * use the s/w feature support filed.
1949 if (card->ext_csd.feature_support & MMC_DISCARD_FEATURE)
1953 EXPORT_SYMBOL(mmc_can_discard);
1955 int mmc_can_sanitize(struct mmc_card *card)
1957 if (!mmc_can_trim(card) && !mmc_can_erase(card))
1959 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_SANITIZE)
1963 EXPORT_SYMBOL(mmc_can_sanitize);
1965 int mmc_can_secure_erase_trim(struct mmc_card *card)
1967 if ((card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN) &&
1968 !(card->quirks & MMC_QUIRK_SEC_ERASE_TRIM_BROKEN))
1972 EXPORT_SYMBOL(mmc_can_secure_erase_trim);
1974 int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
1977 if (!card->erase_size)
1979 if (from % card->erase_size || nr % card->erase_size)
1983 EXPORT_SYMBOL(mmc_erase_group_aligned);
1985 static unsigned int mmc_do_calc_max_discard(struct mmc_card *card,
1988 struct mmc_host *host = card->host;
1989 unsigned int max_discard, x, y, qty = 0, max_qty, min_qty, timeout;
1990 unsigned int last_timeout = 0;
1991 unsigned int max_busy_timeout = host->max_busy_timeout ?
1992 host->max_busy_timeout : MMC_ERASE_TIMEOUT_MS;
1994 if (card->erase_shift) {
1995 max_qty = UINT_MAX >> card->erase_shift;
1996 min_qty = card->pref_erase >> card->erase_shift;
1997 } else if (mmc_card_sd(card)) {
1999 min_qty = card->pref_erase;
2001 max_qty = UINT_MAX / card->erase_size;
2002 min_qty = card->pref_erase / card->erase_size;
2006 * We should not only use 'host->max_busy_timeout' as the limitation
2007 * when deciding the max discard sectors. We should set a balance value
2008 * to improve the erase speed, and it can not get too long timeout at
2011 * Here we set 'card->pref_erase' as the minimal discard sectors no
2012 * matter what size of 'host->max_busy_timeout', but if the
2013 * 'host->max_busy_timeout' is large enough for more discard sectors,
2014 * then we can continue to increase the max discard sectors until we
2015 * get a balance value. In cases when the 'host->max_busy_timeout'
2016 * isn't specified, use the default max erase timeout.
2020 for (x = 1; x && x <= max_qty && max_qty - x >= qty; x <<= 1) {
2021 timeout = mmc_erase_timeout(card, arg, qty + x);
2023 if (qty + x > min_qty && timeout > max_busy_timeout)
2026 if (timeout < last_timeout)
2028 last_timeout = timeout;
2038 * When specifying a sector range to trim, chances are we might cross
2039 * an erase-group boundary even if the amount of sectors is less than
2041 * If we can only fit one erase-group in the controller timeout budget,
2042 * we have to care that erase-group boundaries are not crossed by a
2043 * single trim operation. We flag that special case with "eg_boundary".
2044 * In all other cases we can just decrement qty and pretend that we
2045 * always touch (qty + 1) erase-groups as a simple optimization.
2048 card->eg_boundary = 1;
2052 /* Convert qty to sectors */
2053 if (card->erase_shift)
2054 max_discard = qty << card->erase_shift;
2055 else if (mmc_card_sd(card))
2056 max_discard = qty + 1;
2058 max_discard = qty * card->erase_size;
2063 unsigned int mmc_calc_max_discard(struct mmc_card *card)
2065 struct mmc_host *host = card->host;
2066 unsigned int max_discard, max_trim;
2069 * Without erase_group_def set, MMC erase timeout depends on clock
2070 * frequence which can change. In that case, the best choice is
2071 * just the preferred erase size.
2073 if (mmc_card_mmc(card) && !(card->ext_csd.erase_group_def & 1))
2074 return card->pref_erase;
2076 max_discard = mmc_do_calc_max_discard(card, MMC_ERASE_ARG);
2077 if (mmc_can_trim(card)) {
2078 max_trim = mmc_do_calc_max_discard(card, MMC_TRIM_ARG);
2079 if (max_trim < max_discard || max_discard == 0)
2080 max_discard = max_trim;
2081 } else if (max_discard < card->erase_size) {
2084 pr_debug("%s: calculated max. discard sectors %u for timeout %u ms\n",
2085 mmc_hostname(host), max_discard, host->max_busy_timeout ?
2086 host->max_busy_timeout : MMC_ERASE_TIMEOUT_MS);
2089 EXPORT_SYMBOL(mmc_calc_max_discard);
2091 bool mmc_card_is_blockaddr(struct mmc_card *card)
2093 return card ? mmc_card_blockaddr(card) : false;
2095 EXPORT_SYMBOL(mmc_card_is_blockaddr);
2097 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen)
2099 struct mmc_command cmd = {};
2101 if (mmc_card_blockaddr(card) || mmc_card_ddr52(card) ||
2102 mmc_card_hs400(card) || mmc_card_hs400es(card))
2105 cmd.opcode = MMC_SET_BLOCKLEN;
2107 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2108 return mmc_wait_for_cmd(card->host, &cmd, 5);
2110 EXPORT_SYMBOL(mmc_set_blocklen);
2112 static void mmc_hw_reset_for_init(struct mmc_host *host)
2114 mmc_pwrseq_reset(host);
2116 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->hw_reset)
2118 host->ops->hw_reset(host);
2121 int mmc_hw_reset(struct mmc_host *host)
2129 if (!host->bus_ops || host->bus_dead || !host->bus_ops->hw_reset) {
2134 ret = host->bus_ops->hw_reset(host);
2138 pr_warn("%s: tried to HW reset card, got error %d\n",
2139 mmc_hostname(host), ret);
2143 EXPORT_SYMBOL(mmc_hw_reset);
2145 int mmc_sw_reset(struct mmc_host *host)
2153 if (!host->bus_ops || host->bus_dead || !host->bus_ops->sw_reset) {
2158 ret = host->bus_ops->sw_reset(host);
2162 pr_warn("%s: tried to SW reset card, got error %d\n",
2163 mmc_hostname(host), ret);
2167 EXPORT_SYMBOL(mmc_sw_reset);
2169 static int mmc_rescan_try_freq(struct mmc_host *host, unsigned freq)
2171 host->f_init = freq;
2173 pr_debug("%s: %s: trying to init card at %u Hz\n",
2174 mmc_hostname(host), __func__, host->f_init);
2176 mmc_power_up(host, host->ocr_avail);
2179 * Some eMMCs (with VCCQ always on) may not be reset after power up, so
2180 * do a hardware reset if possible.
2182 mmc_hw_reset_for_init(host);
2185 * sdio_reset sends CMD52 to reset card. Since we do not know
2186 * if the card is being re-initialized, just send it. CMD52
2187 * should be ignored by SD/eMMC cards.
2188 * Skip it if we already know that we do not support SDIO commands
2190 if (!(host->caps2 & MMC_CAP2_NO_SDIO))
2195 if (!(host->caps2 & MMC_CAP2_NO_SD))
2196 mmc_send_if_cond(host, host->ocr_avail);
2198 /* Order's important: probe SDIO, then SD, then MMC */
2199 if (!(host->caps2 & MMC_CAP2_NO_SDIO))
2200 if (!mmc_attach_sdio(host))
2203 if (!(host->caps2 & MMC_CAP2_NO_SD))
2204 if (!mmc_attach_sd(host))
2207 if (!(host->caps2 & MMC_CAP2_NO_MMC))
2208 if (!mmc_attach_mmc(host))
2211 mmc_power_off(host);
2215 int _mmc_detect_card_removed(struct mmc_host *host)
2219 if (!host->card || mmc_card_removed(host->card))
2222 ret = host->bus_ops->alive(host);
2225 * Card detect status and alive check may be out of sync if card is
2226 * removed slowly, when card detect switch changes while card/slot
2227 * pads are still contacted in hardware (refer to "SD Card Mechanical
2228 * Addendum, Appendix C: Card Detection Switch"). So reschedule a
2229 * detect work 200ms later for this case.
2231 if (!ret && host->ops->get_cd && !host->ops->get_cd(host)) {
2232 mmc_detect_change(host, msecs_to_jiffies(200));
2233 pr_debug("%s: card removed too slowly\n", mmc_hostname(host));
2237 mmc_card_set_removed(host->card);
2238 pr_debug("%s: card remove detected\n", mmc_hostname(host));
2244 int mmc_detect_card_removed(struct mmc_host *host)
2246 struct mmc_card *card = host->card;
2249 WARN_ON(!host->claimed);
2254 if (!mmc_card_is_removable(host))
2257 ret = mmc_card_removed(card);
2259 * The card will be considered unchanged unless we have been asked to
2260 * detect a change or host requires polling to provide card detection.
2262 if (!host->detect_change && !(host->caps & MMC_CAP_NEEDS_POLL))
2265 host->detect_change = 0;
2267 ret = _mmc_detect_card_removed(host);
2268 if (ret && (host->caps & MMC_CAP_NEEDS_POLL)) {
2270 * Schedule a detect work as soon as possible to let a
2271 * rescan handle the card removal.
2273 cancel_delayed_work(&host->detect);
2274 _mmc_detect_change(host, 0, false);
2280 EXPORT_SYMBOL(mmc_detect_card_removed);
2282 void mmc_rescan(struct work_struct *work)
2284 struct mmc_host *host =
2285 container_of(work, struct mmc_host, detect.work);
2288 if (host->rescan_disable)
2291 /* If there is a non-removable card registered, only scan once */
2292 if (!mmc_card_is_removable(host) && host->rescan_entered)
2294 host->rescan_entered = 1;
2296 if (host->trigger_card_event && host->ops->card_event) {
2297 mmc_claim_host(host);
2298 host->ops->card_event(host);
2299 mmc_release_host(host);
2300 host->trigger_card_event = false;
2305 /* Verify a registered card to be functional, else remove it. */
2306 if (host->bus_ops && !host->bus_dead)
2307 host->bus_ops->detect(host);
2309 host->detect_change = 0;
2312 * Let mmc_bus_put() free the bus/bus_ops if we've found that
2313 * the card is no longer present.
2318 /* if there still is a card present, stop here */
2319 if (host->bus_ops != NULL) {
2325 * Only we can add a new handler, so it's safe to
2326 * release the lock here.
2330 mmc_claim_host(host);
2331 if (mmc_card_is_removable(host) && host->ops->get_cd &&
2332 host->ops->get_cd(host) == 0) {
2333 mmc_power_off(host);
2334 mmc_release_host(host);
2338 for (i = 0; i < ARRAY_SIZE(freqs); i++) {
2339 if (!mmc_rescan_try_freq(host, max(freqs[i], host->f_min)))
2341 if (freqs[i] <= host->f_min)
2344 mmc_release_host(host);
2347 if (host->caps & MMC_CAP_NEEDS_POLL)
2348 mmc_schedule_delayed_work(&host->detect, HZ);
2351 void mmc_start_host(struct mmc_host *host)
2353 host->f_init = max(freqs[0], host->f_min);
2354 host->rescan_disable = 0;
2355 host->ios.power_mode = MMC_POWER_UNDEFINED;
2357 if (!(host->caps2 & MMC_CAP2_NO_PRESCAN_POWERUP)) {
2358 mmc_claim_host(host);
2359 mmc_power_up(host, host->ocr_avail);
2360 mmc_release_host(host);
2363 mmc_gpiod_request_cd_irq(host);
2364 _mmc_detect_change(host, 0, false);
2367 void __mmc_stop_host(struct mmc_host *host)
2369 if (host->slot.cd_irq >= 0) {
2370 mmc_gpio_set_cd_wake(host, false);
2371 disable_irq(host->slot.cd_irq);
2374 host->rescan_disable = 1;
2375 cancel_delayed_work_sync(&host->detect);
2378 void mmc_stop_host(struct mmc_host *host)
2380 __mmc_stop_host(host);
2382 /* clear pm flags now and let card drivers set them as needed */
2386 if (host->bus_ops && !host->bus_dead) {
2387 /* Calling bus_ops->remove() with a claimed host can deadlock */
2388 host->bus_ops->remove(host);
2389 mmc_claim_host(host);
2390 mmc_detach_bus(host);
2391 mmc_power_off(host);
2392 mmc_release_host(host);
2398 mmc_claim_host(host);
2399 mmc_power_off(host);
2400 mmc_release_host(host);
2403 static int __init mmc_init(void)
2407 ret = mmc_register_bus();
2411 ret = mmc_register_host_class();
2413 goto unregister_bus;
2415 ret = sdio_register_bus();
2417 goto unregister_host_class;
2421 unregister_host_class:
2422 mmc_unregister_host_class();
2424 mmc_unregister_bus();
2428 static void __exit mmc_exit(void)
2430 sdio_unregister_bus();
2431 mmc_unregister_host_class();
2432 mmc_unregister_bus();
2435 subsys_initcall(mmc_init);
2436 module_exit(mmc_exit);
2438 MODULE_LICENSE("GPL");