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/pm_wakeup.h>
27 #include <linux/suspend.h>
28 #include <linux/fault-inject.h>
29 #include <linux/random.h>
30 #include <linux/slab.h>
33 #include <linux/mmc/card.h>
34 #include <linux/mmc/host.h>
35 #include <linux/mmc/mmc.h>
36 #include <linux/mmc/sd.h>
37 #include <linux/mmc/slot-gpio.h>
48 /* If the device is not responding */
49 #define MMC_CORE_TIMEOUT_MS (10 * 60 * 1000) /* 10 minute timeout */
52 * Background operations can take a long time, depending on the housekeeping
53 * operations the card has to perform.
55 #define MMC_BKOPS_MAX_TIMEOUT (4 * 60 * 1000) /* max time to wait in ms */
57 static struct workqueue_struct *workqueue;
58 static const unsigned freqs[] = { 400000, 300000, 200000, 100000 };
61 * Enabling software CRCs on the data blocks can be a significant (30%)
62 * performance cost, and for other reasons may not always be desired.
63 * So we allow it it to be disabled.
66 module_param(use_spi_crc, bool, 0);
69 * Internal function. Schedule delayed work in the MMC work queue.
71 static int mmc_schedule_delayed_work(struct delayed_work *work,
74 return queue_delayed_work(workqueue, work, delay);
78 * Internal function. Flush all scheduled work from the MMC work queue.
80 static void mmc_flush_scheduled_work(void)
82 flush_workqueue(workqueue);
85 #ifdef CONFIG_FAIL_MMC_REQUEST
88 * Internal function. Inject random data errors.
89 * If mmc_data is NULL no errors are injected.
91 static void mmc_should_fail_request(struct mmc_host *host,
92 struct mmc_request *mrq)
94 struct mmc_command *cmd = mrq->cmd;
95 struct mmc_data *data = mrq->data;
96 static const int data_errors[] = {
105 if (cmd->error || data->error ||
106 !should_fail(&host->fail_mmc_request, data->blksz * data->blocks))
109 data->error = data_errors[prandom_u32() % ARRAY_SIZE(data_errors)];
110 data->bytes_xfered = (prandom_u32() % (data->bytes_xfered >> 9)) << 9;
113 #else /* CONFIG_FAIL_MMC_REQUEST */
115 static inline void mmc_should_fail_request(struct mmc_host *host,
116 struct mmc_request *mrq)
120 #endif /* CONFIG_FAIL_MMC_REQUEST */
123 * mmc_request_done - finish processing an MMC request
124 * @host: MMC host which completed request
125 * @mrq: MMC request which request
127 * MMC drivers should call this function when they have completed
128 * their processing of a request.
130 void mmc_request_done(struct mmc_host *host, struct mmc_request *mrq)
132 struct mmc_command *cmd = mrq->cmd;
133 int err = cmd->error;
135 if (err && cmd->retries && mmc_host_is_spi(host)) {
136 if (cmd->resp[0] & R1_SPI_ILLEGAL_COMMAND)
140 if (err && cmd->retries && !mmc_card_removed(host->card)) {
142 * Request starter must handle retries - see
143 * mmc_wait_for_req_done().
148 mmc_should_fail_request(host, mrq);
150 led_trigger_event(host->led, LED_OFF);
153 pr_debug("%s: req done <CMD%u>: %d: %08x %08x %08x %08x\n",
154 mmc_hostname(host), mrq->sbc->opcode,
156 mrq->sbc->resp[0], mrq->sbc->resp[1],
157 mrq->sbc->resp[2], mrq->sbc->resp[3]);
160 pr_debug("%s: req done (CMD%u): %d: %08x %08x %08x %08x\n",
161 mmc_hostname(host), cmd->opcode, err,
162 cmd->resp[0], cmd->resp[1],
163 cmd->resp[2], cmd->resp[3]);
166 pr_debug("%s: %d bytes transferred: %d\n",
168 mrq->data->bytes_xfered, mrq->data->error);
172 pr_debug("%s: (CMD%u): %d: %08x %08x %08x %08x\n",
173 mmc_hostname(host), mrq->stop->opcode,
175 mrq->stop->resp[0], mrq->stop->resp[1],
176 mrq->stop->resp[2], mrq->stop->resp[3]);
182 mmc_host_clk_release(host);
186 EXPORT_SYMBOL(mmc_request_done);
189 mmc_start_request(struct mmc_host *host, struct mmc_request *mrq)
191 #ifdef CONFIG_MMC_DEBUG
193 struct scatterlist *sg;
197 pr_debug("<%s: starting CMD%u arg %08x flags %08x>\n",
198 mmc_hostname(host), mrq->sbc->opcode,
199 mrq->sbc->arg, mrq->sbc->flags);
202 pr_debug("%s: starting CMD%u arg %08x flags %08x\n",
203 mmc_hostname(host), mrq->cmd->opcode,
204 mrq->cmd->arg, mrq->cmd->flags);
207 pr_debug("%s: blksz %d blocks %d flags %08x "
208 "tsac %d ms nsac %d\n",
209 mmc_hostname(host), mrq->data->blksz,
210 mrq->data->blocks, mrq->data->flags,
211 mrq->data->timeout_ns / 1000000,
212 mrq->data->timeout_clks);
216 pr_debug("%s: CMD%u arg %08x flags %08x\n",
217 mmc_hostname(host), mrq->stop->opcode,
218 mrq->stop->arg, mrq->stop->flags);
221 WARN_ON(!host->claimed);
230 BUG_ON(mrq->data->blksz > host->max_blk_size);
231 BUG_ON(mrq->data->blocks > host->max_blk_count);
232 BUG_ON(mrq->data->blocks * mrq->data->blksz >
235 #ifdef CONFIG_MMC_DEBUG
237 for_each_sg(mrq->data->sg, sg, mrq->data->sg_len, i)
239 BUG_ON(sz != mrq->data->blocks * mrq->data->blksz);
242 mrq->cmd->data = mrq->data;
243 mrq->data->error = 0;
244 mrq->data->mrq = mrq;
246 mrq->data->stop = mrq->stop;
247 mrq->stop->error = 0;
248 mrq->stop->mrq = mrq;
251 mmc_host_clk_hold(host);
252 led_trigger_event(host->led, LED_FULL);
253 host->ops->request(host, mrq);
257 * mmc_start_bkops - start BKOPS for supported cards
258 * @card: MMC card to start BKOPS
259 * @form_exception: A flag to indicate if this function was
260 * called due to an exception raised by the card
262 * Start background operations whenever requested.
263 * When the urgent BKOPS bit is set in a R1 command response
264 * then background operations should be started immediately.
266 void mmc_start_bkops(struct mmc_card *card, bool from_exception)
270 bool use_busy_signal;
274 if (!card->ext_csd.bkops_en || mmc_card_doing_bkops(card))
277 err = mmc_read_bkops_status(card);
279 pr_err("%s: Failed to read bkops status: %d\n",
280 mmc_hostname(card->host), err);
284 if (!card->ext_csd.raw_bkops_status)
287 if (card->ext_csd.raw_bkops_status < EXT_CSD_BKOPS_LEVEL_2 &&
291 mmc_claim_host(card->host);
292 if (card->ext_csd.raw_bkops_status >= EXT_CSD_BKOPS_LEVEL_2) {
293 timeout = MMC_BKOPS_MAX_TIMEOUT;
294 use_busy_signal = true;
297 use_busy_signal = false;
300 err = __mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
301 EXT_CSD_BKOPS_START, 1, timeout,
302 use_busy_signal, true, false);
304 pr_warn("%s: Error %d starting bkops\n",
305 mmc_hostname(card->host), err);
310 * For urgent bkops status (LEVEL_2 and more)
311 * bkops executed synchronously, otherwise
312 * the operation is in progress
314 if (!use_busy_signal)
315 mmc_card_set_doing_bkops(card);
317 mmc_release_host(card->host);
319 EXPORT_SYMBOL(mmc_start_bkops);
322 * mmc_wait_data_done() - done callback for data request
323 * @mrq: done data request
325 * Wakes up mmc context, passed as a callback to host controller driver
327 static void mmc_wait_data_done(struct mmc_request *mrq)
329 mrq->host->context_info.is_done_rcv = true;
330 wake_up_interruptible(&mrq->host->context_info.wait);
333 static void mmc_wait_done(struct mmc_request *mrq)
335 complete(&mrq->completion);
339 *__mmc_start_data_req() - starts data request
340 * @host: MMC host to start the request
341 * @mrq: data request to start
343 * Sets the done callback to be called when request is completed by the card.
344 * Starts data mmc request execution
346 static int __mmc_start_data_req(struct mmc_host *host, struct mmc_request *mrq)
348 mrq->done = mmc_wait_data_done;
350 if (mmc_card_removed(host->card)) {
351 mrq->cmd->error = -ENOMEDIUM;
352 mmc_wait_data_done(mrq);
355 mmc_start_request(host, mrq);
360 static int __mmc_start_req(struct mmc_host *host, struct mmc_request *mrq)
362 init_completion(&mrq->completion);
363 mrq->done = mmc_wait_done;
364 if (mmc_card_removed(host->card)) {
365 mrq->cmd->error = -ENOMEDIUM;
366 complete(&mrq->completion);
369 mmc_start_request(host, mrq);
374 * mmc_wait_for_data_req_done() - wait for request completed
375 * @host: MMC host to prepare the command.
376 * @mrq: MMC request to wait for
378 * Blocks MMC context till host controller will ack end of data request
379 * execution or new request notification arrives from the block layer.
380 * Handles command retries.
382 * Returns enum mmc_blk_status after checking errors.
384 static int mmc_wait_for_data_req_done(struct mmc_host *host,
385 struct mmc_request *mrq,
386 struct mmc_async_req *next_req)
388 struct mmc_command *cmd;
389 struct mmc_context_info *context_info = &host->context_info;
394 wait_event_interruptible(context_info->wait,
395 (context_info->is_done_rcv ||
396 context_info->is_new_req));
397 spin_lock_irqsave(&context_info->lock, flags);
398 context_info->is_waiting_last_req = false;
399 spin_unlock_irqrestore(&context_info->lock, flags);
400 if (context_info->is_done_rcv) {
401 context_info->is_done_rcv = false;
402 context_info->is_new_req = false;
405 if (!cmd->error || !cmd->retries ||
406 mmc_card_removed(host->card)) {
407 err = host->areq->err_check(host->card,
409 break; /* return err */
411 pr_info("%s: req failed (CMD%u): %d, retrying...\n",
413 cmd->opcode, cmd->error);
416 host->ops->request(host, mrq);
417 continue; /* wait for done/new event again */
419 } else if (context_info->is_new_req) {
420 context_info->is_new_req = false;
422 err = MMC_BLK_NEW_REQUEST;
423 break; /* return err */
430 static void mmc_wait_for_req_done(struct mmc_host *host,
431 struct mmc_request *mrq)
433 struct mmc_command *cmd;
436 wait_for_completion(&mrq->completion);
441 * If host has timed out waiting for the sanitize
442 * to complete, card might be still in programming state
443 * so let's try to bring the card out of programming
446 if (cmd->sanitize_busy && cmd->error == -ETIMEDOUT) {
447 if (!mmc_interrupt_hpi(host->card)) {
448 pr_warn("%s: %s: Interrupted sanitize\n",
449 mmc_hostname(host), __func__);
453 pr_err("%s: %s: Failed to interrupt sanitize\n",
454 mmc_hostname(host), __func__);
457 if (!cmd->error || !cmd->retries ||
458 mmc_card_removed(host->card))
461 pr_debug("%s: req failed (CMD%u): %d, retrying...\n",
462 mmc_hostname(host), cmd->opcode, cmd->error);
465 host->ops->request(host, mrq);
470 * mmc_pre_req - Prepare for a new request
471 * @host: MMC host to prepare command
472 * @mrq: MMC request to prepare for
473 * @is_first_req: true if there is no previous started request
474 * that may run in parellel to this call, otherwise false
476 * mmc_pre_req() is called in prior to mmc_start_req() to let
477 * host prepare for the new request. Preparation of a request may be
478 * performed while another request is running on the host.
480 static void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq,
483 if (host->ops->pre_req) {
484 mmc_host_clk_hold(host);
485 host->ops->pre_req(host, mrq, is_first_req);
486 mmc_host_clk_release(host);
491 * mmc_post_req - Post process a completed request
492 * @host: MMC host to post process command
493 * @mrq: MMC request to post process for
494 * @err: Error, if non zero, clean up any resources made in pre_req
496 * Let the host post process a completed request. Post processing of
497 * a request may be performed while another reuqest is running.
499 static void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq,
502 if (host->ops->post_req) {
503 mmc_host_clk_hold(host);
504 host->ops->post_req(host, mrq, err);
505 mmc_host_clk_release(host);
510 * mmc_start_req - start a non-blocking request
511 * @host: MMC host to start command
512 * @areq: async request to start
513 * @error: out parameter returns 0 for success, otherwise non zero
515 * Start a new MMC custom command request for a host.
516 * If there is on ongoing async request wait for completion
517 * of that request and start the new one and return.
518 * Does not wait for the new request to complete.
520 * Returns the completed request, NULL in case of none completed.
521 * Wait for the an ongoing request (previoulsy started) to complete and
522 * return the completed request. If there is no ongoing request, NULL
523 * is returned without waiting. NULL is not an error condition.
525 struct mmc_async_req *mmc_start_req(struct mmc_host *host,
526 struct mmc_async_req *areq, int *error)
530 struct mmc_async_req *data = host->areq;
532 /* Prepare a new request */
534 mmc_pre_req(host, areq->mrq, !host->areq);
537 err = mmc_wait_for_data_req_done(host, host->areq->mrq, areq);
538 if (err == MMC_BLK_NEW_REQUEST) {
542 * The previous request was not completed,
548 * Check BKOPS urgency for each R1 response
550 if (host->card && mmc_card_mmc(host->card) &&
551 ((mmc_resp_type(host->areq->mrq->cmd) == MMC_RSP_R1) ||
552 (mmc_resp_type(host->areq->mrq->cmd) == MMC_RSP_R1B)) &&
553 (host->areq->mrq->cmd->resp[0] & R1_EXCEPTION_EVENT)) {
555 /* Cancel the prepared request */
557 mmc_post_req(host, areq->mrq, -EINVAL);
559 mmc_start_bkops(host->card, true);
561 /* prepare the request again */
563 mmc_pre_req(host, areq->mrq, !host->areq);
568 start_err = __mmc_start_data_req(host, areq->mrq);
571 mmc_post_req(host, host->areq->mrq, 0);
573 /* Cancel a prepared request if it was not started. */
574 if ((err || start_err) && areq)
575 mmc_post_req(host, areq->mrq, -EINVAL);
586 EXPORT_SYMBOL(mmc_start_req);
589 * mmc_wait_for_req - start a request and wait for completion
590 * @host: MMC host to start command
591 * @mrq: MMC request to start
593 * Start a new MMC custom command request for a host, and wait
594 * for the command to complete. Does not attempt to parse the
597 void mmc_wait_for_req(struct mmc_host *host, struct mmc_request *mrq)
599 __mmc_start_req(host, mrq);
600 mmc_wait_for_req_done(host, mrq);
602 EXPORT_SYMBOL(mmc_wait_for_req);
605 * mmc_interrupt_hpi - Issue for High priority Interrupt
606 * @card: the MMC card associated with the HPI transfer
608 * Issued High Priority Interrupt, and check for card status
609 * until out-of prg-state.
611 int mmc_interrupt_hpi(struct mmc_card *card)
615 unsigned long prg_wait;
619 if (!card->ext_csd.hpi_en) {
620 pr_info("%s: HPI enable bit unset\n", mmc_hostname(card->host));
624 mmc_claim_host(card->host);
625 err = mmc_send_status(card, &status);
627 pr_err("%s: Get card status fail\n", mmc_hostname(card->host));
631 switch (R1_CURRENT_STATE(status)) {
637 * In idle and transfer states, HPI is not needed and the caller
638 * can issue the next intended command immediately
644 /* In all other states, it's illegal to issue HPI */
645 pr_debug("%s: HPI cannot be sent. Card state=%d\n",
646 mmc_hostname(card->host), R1_CURRENT_STATE(status));
651 err = mmc_send_hpi_cmd(card, &status);
655 prg_wait = jiffies + msecs_to_jiffies(card->ext_csd.out_of_int_time);
657 err = mmc_send_status(card, &status);
659 if (!err && R1_CURRENT_STATE(status) == R1_STATE_TRAN)
661 if (time_after(jiffies, prg_wait))
666 mmc_release_host(card->host);
669 EXPORT_SYMBOL(mmc_interrupt_hpi);
672 * mmc_wait_for_cmd - start a command and wait for completion
673 * @host: MMC host to start command
674 * @cmd: MMC command to start
675 * @retries: maximum number of retries
677 * Start a new MMC command for a host, and wait for the command
678 * to complete. Return any error that occurred while the command
679 * was executing. Do not attempt to parse the response.
681 int mmc_wait_for_cmd(struct mmc_host *host, struct mmc_command *cmd, int retries)
683 struct mmc_request mrq = {NULL};
685 WARN_ON(!host->claimed);
687 memset(cmd->resp, 0, sizeof(cmd->resp));
688 cmd->retries = retries;
693 mmc_wait_for_req(host, &mrq);
698 EXPORT_SYMBOL(mmc_wait_for_cmd);
701 * mmc_stop_bkops - stop ongoing BKOPS
702 * @card: MMC card to check BKOPS
704 * Send HPI command to stop ongoing background operations to
705 * allow rapid servicing of foreground operations, e.g. read/
706 * writes. Wait until the card comes out of the programming state
707 * to avoid errors in servicing read/write requests.
709 int mmc_stop_bkops(struct mmc_card *card)
714 err = mmc_interrupt_hpi(card);
717 * If err is EINVAL, we can't issue an HPI.
718 * It should complete the BKOPS.
720 if (!err || (err == -EINVAL)) {
721 mmc_card_clr_doing_bkops(card);
727 EXPORT_SYMBOL(mmc_stop_bkops);
729 int mmc_read_bkops_status(struct mmc_card *card)
734 mmc_claim_host(card->host);
735 err = mmc_get_ext_csd(card, &ext_csd);
736 mmc_release_host(card->host);
740 card->ext_csd.raw_bkops_status = ext_csd[EXT_CSD_BKOPS_STATUS];
741 card->ext_csd.raw_exception_status = ext_csd[EXT_CSD_EXP_EVENTS_STATUS];
745 EXPORT_SYMBOL(mmc_read_bkops_status);
748 * mmc_set_data_timeout - set the timeout for a data command
749 * @data: data phase for command
750 * @card: the MMC card associated with the data transfer
752 * Computes the data timeout parameters according to the
753 * correct algorithm given the card type.
755 void mmc_set_data_timeout(struct mmc_data *data, const struct mmc_card *card)
760 * SDIO cards only define an upper 1 s limit on access.
762 if (mmc_card_sdio(card)) {
763 data->timeout_ns = 1000000000;
764 data->timeout_clks = 0;
769 * SD cards use a 100 multiplier rather than 10
771 mult = mmc_card_sd(card) ? 100 : 10;
774 * Scale up the multiplier (and therefore the timeout) by
775 * the r2w factor for writes.
777 if (data->flags & MMC_DATA_WRITE)
778 mult <<= card->csd.r2w_factor;
780 data->timeout_ns = card->csd.tacc_ns * mult;
781 data->timeout_clks = card->csd.tacc_clks * mult;
784 * SD cards also have an upper limit on the timeout.
786 if (mmc_card_sd(card)) {
787 unsigned int timeout_us, limit_us;
789 timeout_us = data->timeout_ns / 1000;
790 if (mmc_host_clk_rate(card->host))
791 timeout_us += data->timeout_clks * 1000 /
792 (mmc_host_clk_rate(card->host) / 1000);
794 if (data->flags & MMC_DATA_WRITE)
796 * The MMC spec "It is strongly recommended
797 * for hosts to implement more than 500ms
798 * timeout value even if the card indicates
799 * the 250ms maximum busy length." Even the
800 * previous value of 300ms is known to be
801 * insufficient for some cards.
808 * SDHC cards always use these fixed values.
810 if (timeout_us > limit_us || mmc_card_blockaddr(card)) {
811 data->timeout_ns = limit_us * 1000;
812 data->timeout_clks = 0;
815 /* assign limit value if invalid */
817 data->timeout_ns = limit_us * 1000;
821 * Some cards require longer data read timeout than indicated in CSD.
822 * Address this by setting the read timeout to a "reasonably high"
823 * value. For the cards tested, 300ms has proven enough. If necessary,
824 * this value can be increased if other problematic cards require this.
826 if (mmc_card_long_read_time(card) && data->flags & MMC_DATA_READ) {
827 data->timeout_ns = 300000000;
828 data->timeout_clks = 0;
832 * Some cards need very high timeouts if driven in SPI mode.
833 * The worst observed timeout was 900ms after writing a
834 * continuous stream of data until the internal logic
837 if (mmc_host_is_spi(card->host)) {
838 if (data->flags & MMC_DATA_WRITE) {
839 if (data->timeout_ns < 1000000000)
840 data->timeout_ns = 1000000000; /* 1s */
842 if (data->timeout_ns < 100000000)
843 data->timeout_ns = 100000000; /* 100ms */
847 EXPORT_SYMBOL(mmc_set_data_timeout);
850 * mmc_align_data_size - pads a transfer size to a more optimal value
851 * @card: the MMC card associated with the data transfer
852 * @sz: original transfer size
854 * Pads the original data size with a number of extra bytes in
855 * order to avoid controller bugs and/or performance hits
856 * (e.g. some controllers revert to PIO for certain sizes).
858 * Returns the improved size, which might be unmodified.
860 * Note that this function is only relevant when issuing a
861 * single scatter gather entry.
863 unsigned int mmc_align_data_size(struct mmc_card *card, unsigned int sz)
866 * FIXME: We don't have a system for the controller to tell
867 * the core about its problems yet, so for now we just 32-bit
870 sz = ((sz + 3) / 4) * 4;
874 EXPORT_SYMBOL(mmc_align_data_size);
877 * __mmc_claim_host - exclusively claim a host
878 * @host: mmc host to claim
879 * @abort: whether or not the operation should be aborted
881 * Claim a host for a set of operations. If @abort is non null and
882 * dereference a non-zero value then this will return prematurely with
883 * that non-zero value without acquiring the lock. Returns zero
884 * with the lock held otherwise.
886 int __mmc_claim_host(struct mmc_host *host, atomic_t *abort)
888 DECLARE_WAITQUEUE(wait, current);
894 add_wait_queue(&host->wq, &wait);
895 spin_lock_irqsave(&host->lock, flags);
897 set_current_state(TASK_UNINTERRUPTIBLE);
898 stop = abort ? atomic_read(abort) : 0;
899 if (stop || !host->claimed || host->claimer == current)
901 spin_unlock_irqrestore(&host->lock, flags);
903 spin_lock_irqsave(&host->lock, flags);
905 set_current_state(TASK_RUNNING);
908 host->claimer = current;
909 host->claim_cnt += 1;
912 spin_unlock_irqrestore(&host->lock, flags);
913 remove_wait_queue(&host->wq, &wait);
914 if (host->ops->enable && !stop && host->claim_cnt == 1)
915 host->ops->enable(host);
919 EXPORT_SYMBOL(__mmc_claim_host);
922 * mmc_release_host - release a host
923 * @host: mmc host to release
925 * Release a MMC host, allowing others to claim the host
926 * for their operations.
928 void mmc_release_host(struct mmc_host *host)
932 WARN_ON(!host->claimed);
934 if (host->ops->disable && host->claim_cnt == 1)
935 host->ops->disable(host);
937 spin_lock_irqsave(&host->lock, flags);
938 if (--host->claim_cnt) {
939 /* Release for nested claim */
940 spin_unlock_irqrestore(&host->lock, flags);
943 host->claimer = NULL;
944 spin_unlock_irqrestore(&host->lock, flags);
948 EXPORT_SYMBOL(mmc_release_host);
951 * This is a helper function, which fetches a runtime pm reference for the
952 * card device and also claims the host.
954 void mmc_get_card(struct mmc_card *card)
956 pm_runtime_get_sync(&card->dev);
957 mmc_claim_host(card->host);
959 EXPORT_SYMBOL(mmc_get_card);
962 * This is a helper function, which releases the host and drops the runtime
963 * pm reference for the card device.
965 void mmc_put_card(struct mmc_card *card)
967 mmc_release_host(card->host);
968 pm_runtime_mark_last_busy(&card->dev);
969 pm_runtime_put_autosuspend(&card->dev);
971 EXPORT_SYMBOL(mmc_put_card);
974 * Internal function that does the actual ios call to the host driver,
975 * optionally printing some debug output.
977 static inline void mmc_set_ios(struct mmc_host *host)
979 struct mmc_ios *ios = &host->ios;
981 pr_debug("%s: clock %uHz busmode %u powermode %u cs %u Vdd %u "
982 "width %u timing %u\n",
983 mmc_hostname(host), ios->clock, ios->bus_mode,
984 ios->power_mode, ios->chip_select, ios->vdd,
985 ios->bus_width, ios->timing);
988 mmc_set_ungated(host);
989 host->ops->set_ios(host, ios);
993 * Control chip select pin on a host.
995 void mmc_set_chip_select(struct mmc_host *host, int mode)
997 mmc_host_clk_hold(host);
998 host->ios.chip_select = mode;
1000 mmc_host_clk_release(host);
1004 * Sets the host clock to the highest possible frequency that
1007 static void __mmc_set_clock(struct mmc_host *host, unsigned int hz)
1009 WARN_ON(hz && hz < host->f_min);
1011 if (hz > host->f_max)
1014 host->ios.clock = hz;
1018 void mmc_set_clock(struct mmc_host *host, unsigned int hz)
1020 mmc_host_clk_hold(host);
1021 __mmc_set_clock(host, hz);
1022 mmc_host_clk_release(host);
1025 #ifdef CONFIG_MMC_CLKGATE
1027 * This gates the clock by setting it to 0 Hz.
1029 void mmc_gate_clock(struct mmc_host *host)
1031 unsigned long flags;
1033 spin_lock_irqsave(&host->clk_lock, flags);
1034 host->clk_old = host->ios.clock;
1035 host->ios.clock = 0;
1036 host->clk_gated = true;
1037 spin_unlock_irqrestore(&host->clk_lock, flags);
1042 * This restores the clock from gating by using the cached
1045 void mmc_ungate_clock(struct mmc_host *host)
1048 * We should previously have gated the clock, so the clock shall
1049 * be 0 here! The clock may however be 0 during initialization,
1050 * when some request operations are performed before setting
1051 * the frequency. When ungate is requested in that situation
1052 * we just ignore the call.
1054 if (host->clk_old) {
1055 BUG_ON(host->ios.clock);
1056 /* This call will also set host->clk_gated to false */
1057 __mmc_set_clock(host, host->clk_old);
1061 void mmc_set_ungated(struct mmc_host *host)
1063 unsigned long flags;
1066 * We've been given a new frequency while the clock is gated,
1067 * so make sure we regard this as ungating it.
1069 spin_lock_irqsave(&host->clk_lock, flags);
1070 host->clk_gated = false;
1071 spin_unlock_irqrestore(&host->clk_lock, flags);
1075 void mmc_set_ungated(struct mmc_host *host)
1081 * Change the bus mode (open drain/push-pull) of a host.
1083 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode)
1085 mmc_host_clk_hold(host);
1086 host->ios.bus_mode = mode;
1088 mmc_host_clk_release(host);
1092 * Change data bus width of a host.
1094 void mmc_set_bus_width(struct mmc_host *host, unsigned int width)
1096 mmc_host_clk_hold(host);
1097 host->ios.bus_width = width;
1099 mmc_host_clk_release(host);
1103 * Set initial state after a power cycle or a hw_reset.
1105 void mmc_set_initial_state(struct mmc_host *host)
1107 if (mmc_host_is_spi(host))
1108 host->ios.chip_select = MMC_CS_HIGH;
1110 host->ios.chip_select = MMC_CS_DONTCARE;
1111 host->ios.bus_mode = MMC_BUSMODE_PUSHPULL;
1112 host->ios.bus_width = MMC_BUS_WIDTH_1;
1113 host->ios.timing = MMC_TIMING_LEGACY;
1119 * mmc_vdd_to_ocrbitnum - Convert a voltage to the OCR bit number
1120 * @vdd: voltage (mV)
1121 * @low_bits: prefer low bits in boundary cases
1123 * This function returns the OCR bit number according to the provided @vdd
1124 * value. If conversion is not possible a negative errno value returned.
1126 * Depending on the @low_bits flag the function prefers low or high OCR bits
1127 * on boundary voltages. For example,
1128 * with @low_bits = true, 3300 mV translates to ilog2(MMC_VDD_32_33);
1129 * with @low_bits = false, 3300 mV translates to ilog2(MMC_VDD_33_34);
1131 * Any value in the [1951:1999] range translates to the ilog2(MMC_VDD_20_21).
1133 static int mmc_vdd_to_ocrbitnum(int vdd, bool low_bits)
1135 const int max_bit = ilog2(MMC_VDD_35_36);
1138 if (vdd < 1650 || vdd > 3600)
1141 if (vdd >= 1650 && vdd <= 1950)
1142 return ilog2(MMC_VDD_165_195);
1147 /* Base 2000 mV, step 100 mV, bit's base 8. */
1148 bit = (vdd - 2000) / 100 + 8;
1155 * mmc_vddrange_to_ocrmask - Convert a voltage range to the OCR mask
1156 * @vdd_min: minimum voltage value (mV)
1157 * @vdd_max: maximum voltage value (mV)
1159 * This function returns the OCR mask bits according to the provided @vdd_min
1160 * and @vdd_max values. If conversion is not possible the function returns 0.
1162 * Notes wrt boundary cases:
1163 * This function sets the OCR bits for all boundary voltages, for example
1164 * [3300:3400] range is translated to MMC_VDD_32_33 | MMC_VDD_33_34 |
1165 * MMC_VDD_34_35 mask.
1167 u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max)
1171 if (vdd_max < vdd_min)
1174 /* Prefer high bits for the boundary vdd_max values. */
1175 vdd_max = mmc_vdd_to_ocrbitnum(vdd_max, false);
1179 /* Prefer low bits for the boundary vdd_min values. */
1180 vdd_min = mmc_vdd_to_ocrbitnum(vdd_min, true);
1184 /* Fill the mask, from max bit to min bit. */
1185 while (vdd_max >= vdd_min)
1186 mask |= 1 << vdd_max--;
1190 EXPORT_SYMBOL(mmc_vddrange_to_ocrmask);
1195 * mmc_of_parse_voltage - return mask of supported voltages
1196 * @np: The device node need to be parsed.
1197 * @mask: mask of voltages available for MMC/SD/SDIO
1199 * 1. Return zero on success.
1200 * 2. Return negative errno: voltage-range is invalid.
1202 int mmc_of_parse_voltage(struct device_node *np, u32 *mask)
1204 const u32 *voltage_ranges;
1207 voltage_ranges = of_get_property(np, "voltage-ranges", &num_ranges);
1208 num_ranges = num_ranges / sizeof(*voltage_ranges) / 2;
1209 if (!voltage_ranges || !num_ranges) {
1210 pr_info("%s: voltage-ranges unspecified\n", np->full_name);
1214 for (i = 0; i < num_ranges; i++) {
1215 const int j = i * 2;
1218 ocr_mask = mmc_vddrange_to_ocrmask(
1219 be32_to_cpu(voltage_ranges[j]),
1220 be32_to_cpu(voltage_ranges[j + 1]));
1222 pr_err("%s: voltage-range #%d is invalid\n",
1231 EXPORT_SYMBOL(mmc_of_parse_voltage);
1233 #endif /* CONFIG_OF */
1235 #ifdef CONFIG_REGULATOR
1238 * mmc_regulator_get_ocrmask - return mask of supported voltages
1239 * @supply: regulator to use
1241 * This returns either a negative errno, or a mask of voltages that
1242 * can be provided to MMC/SD/SDIO devices using the specified voltage
1243 * regulator. This would normally be called before registering the
1246 int mmc_regulator_get_ocrmask(struct regulator *supply)
1254 count = regulator_count_voltages(supply);
1258 for (i = 0; i < count; i++) {
1259 vdd_uV = regulator_list_voltage(supply, i);
1263 vdd_mV = vdd_uV / 1000;
1264 result |= mmc_vddrange_to_ocrmask(vdd_mV, vdd_mV);
1268 vdd_uV = regulator_get_voltage(supply);
1272 vdd_mV = vdd_uV / 1000;
1273 result = mmc_vddrange_to_ocrmask(vdd_mV, vdd_mV);
1278 EXPORT_SYMBOL_GPL(mmc_regulator_get_ocrmask);
1281 * mmc_regulator_set_ocr - set regulator to match host->ios voltage
1282 * @mmc: the host to regulate
1283 * @supply: regulator to use
1284 * @vdd_bit: zero for power off, else a bit number (host->ios.vdd)
1286 * Returns zero on success, else negative errno.
1288 * MMC host drivers may use this to enable or disable a regulator using
1289 * a particular supply voltage. This would normally be called from the
1292 int mmc_regulator_set_ocr(struct mmc_host *mmc,
1293 struct regulator *supply,
1294 unsigned short vdd_bit)
1303 * REVISIT mmc_vddrange_to_ocrmask() may have set some
1304 * bits this regulator doesn't quite support ... don't
1305 * be too picky, most cards and regulators are OK with
1306 * a 0.1V range goof (it's a small error percentage).
1308 tmp = vdd_bit - ilog2(MMC_VDD_165_195);
1310 min_uV = 1650 * 1000;
1311 max_uV = 1950 * 1000;
1313 min_uV = 1900 * 1000 + tmp * 100 * 1000;
1314 max_uV = min_uV + 100 * 1000;
1317 result = regulator_set_voltage(supply, min_uV, max_uV);
1318 if (result == 0 && !mmc->regulator_enabled) {
1319 result = regulator_enable(supply);
1321 mmc->regulator_enabled = true;
1323 } else if (mmc->regulator_enabled) {
1324 result = regulator_disable(supply);
1326 mmc->regulator_enabled = false;
1330 dev_err(mmc_dev(mmc),
1331 "could not set regulator OCR (%d)\n", result);
1334 EXPORT_SYMBOL_GPL(mmc_regulator_set_ocr);
1336 #endif /* CONFIG_REGULATOR */
1338 int mmc_regulator_get_supply(struct mmc_host *mmc)
1340 struct device *dev = mmc_dev(mmc);
1343 mmc->supply.vmmc = devm_regulator_get_optional(dev, "vmmc");
1344 mmc->supply.vqmmc = devm_regulator_get_optional(dev, "vqmmc");
1346 if (IS_ERR(mmc->supply.vmmc)) {
1347 if (PTR_ERR(mmc->supply.vmmc) == -EPROBE_DEFER)
1348 return -EPROBE_DEFER;
1349 dev_info(dev, "No vmmc regulator found\n");
1351 ret = mmc_regulator_get_ocrmask(mmc->supply.vmmc);
1353 mmc->ocr_avail = ret;
1355 dev_warn(dev, "Failed getting OCR mask: %d\n", ret);
1358 if (IS_ERR(mmc->supply.vqmmc)) {
1359 if (PTR_ERR(mmc->supply.vqmmc) == -EPROBE_DEFER)
1360 return -EPROBE_DEFER;
1361 dev_info(dev, "No vqmmc regulator found\n");
1366 EXPORT_SYMBOL_GPL(mmc_regulator_get_supply);
1369 * Mask off any voltages we don't support and select
1370 * the lowest voltage
1372 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr)
1377 * Sanity check the voltages that the card claims to
1381 dev_warn(mmc_dev(host),
1382 "card claims to support voltages below defined range\n");
1386 ocr &= host->ocr_avail;
1388 dev_warn(mmc_dev(host), "no support for card's volts\n");
1392 if (host->caps2 & MMC_CAP2_FULL_PWR_CYCLE) {
1395 mmc_power_cycle(host, ocr);
1399 if (bit != host->ios.vdd)
1400 dev_warn(mmc_dev(host), "exceeding card's volts\n");
1406 int __mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage)
1409 int old_signal_voltage = host->ios.signal_voltage;
1411 host->ios.signal_voltage = signal_voltage;
1412 if (host->ops->start_signal_voltage_switch) {
1413 mmc_host_clk_hold(host);
1414 err = host->ops->start_signal_voltage_switch(host, &host->ios);
1415 mmc_host_clk_release(host);
1419 host->ios.signal_voltage = old_signal_voltage;
1425 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage, u32 ocr)
1427 struct mmc_command cmd = {0};
1434 * Send CMD11 only if the request is to switch the card to
1437 if (signal_voltage == MMC_SIGNAL_VOLTAGE_330)
1438 return __mmc_set_signal_voltage(host, signal_voltage);
1441 * If we cannot switch voltages, return failure so the caller
1442 * can continue without UHS mode
1444 if (!host->ops->start_signal_voltage_switch)
1446 if (!host->ops->card_busy)
1447 pr_warn("%s: cannot verify signal voltage switch\n",
1448 mmc_hostname(host));
1450 mmc_host_clk_hold(host);
1452 cmd.opcode = SD_SWITCH_VOLTAGE;
1454 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1456 err = mmc_wait_for_cmd(host, &cmd, 0);
1460 if (!mmc_host_is_spi(host) && (cmd.resp[0] & R1_ERROR)) {
1465 * The card should drive cmd and dat[0:3] low immediately
1466 * after the response of cmd11, but wait 1 ms to be sure
1469 if (host->ops->card_busy && !host->ops->card_busy(host)) {
1474 * During a signal voltage level switch, the clock must be gated
1475 * for 5 ms according to the SD spec
1477 clock = host->ios.clock;
1478 host->ios.clock = 0;
1481 if (__mmc_set_signal_voltage(host, signal_voltage)) {
1483 * Voltages may not have been switched, but we've already
1484 * sent CMD11, so a power cycle is required anyway
1490 /* Keep clock gated for at least 5 ms */
1492 host->ios.clock = clock;
1495 /* Wait for at least 1 ms according to spec */
1499 * Failure to switch is indicated by the card holding
1502 if (host->ops->card_busy && host->ops->card_busy(host))
1507 pr_debug("%s: Signal voltage switch failed, "
1508 "power cycling card\n", mmc_hostname(host));
1509 mmc_power_cycle(host, ocr);
1513 mmc_host_clk_release(host);
1519 * Select timing parameters for host.
1521 void mmc_set_timing(struct mmc_host *host, unsigned int timing)
1523 mmc_host_clk_hold(host);
1524 host->ios.timing = timing;
1526 mmc_host_clk_release(host);
1530 * Select appropriate driver type for host.
1532 void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type)
1534 mmc_host_clk_hold(host);
1535 host->ios.drv_type = drv_type;
1537 mmc_host_clk_release(host);
1541 * Apply power to the MMC stack. This is a two-stage process.
1542 * First, we enable power to the card without the clock running.
1543 * We then wait a bit for the power to stabilise. Finally,
1544 * enable the bus drivers and clock to the card.
1546 * We must _NOT_ enable the clock prior to power stablising.
1548 * If a host does all the power sequencing itself, ignore the
1549 * initial MMC_POWER_UP stage.
1551 void mmc_power_up(struct mmc_host *host, u32 ocr)
1553 if (host->ios.power_mode == MMC_POWER_ON)
1556 mmc_host_clk_hold(host);
1558 host->ios.vdd = fls(ocr) - 1;
1559 host->ios.power_mode = MMC_POWER_UP;
1560 /* Set initial state and call mmc_set_ios */
1561 mmc_set_initial_state(host);
1563 /* Try to set signal voltage to 3.3V but fall back to 1.8v or 1.2v */
1564 if (__mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_330) == 0)
1565 dev_dbg(mmc_dev(host), "Initial signal voltage of 3.3v\n");
1566 else if (__mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_180) == 0)
1567 dev_dbg(mmc_dev(host), "Initial signal voltage of 1.8v\n");
1568 else if (__mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_120) == 0)
1569 dev_dbg(mmc_dev(host), "Initial signal voltage of 1.2v\n");
1572 * This delay should be sufficient to allow the power supply
1573 * to reach the minimum voltage.
1577 host->ios.clock = host->f_init;
1579 host->ios.power_mode = MMC_POWER_ON;
1583 * This delay must be at least 74 clock sizes, or 1 ms, or the
1584 * time required to reach a stable voltage.
1588 mmc_host_clk_release(host);
1591 void mmc_power_off(struct mmc_host *host)
1593 if (host->ios.power_mode == MMC_POWER_OFF)
1596 mmc_host_clk_hold(host);
1598 host->ios.clock = 0;
1601 host->ios.power_mode = MMC_POWER_OFF;
1602 /* Set initial state and call mmc_set_ios */
1603 mmc_set_initial_state(host);
1606 * Some configurations, such as the 802.11 SDIO card in the OLPC
1607 * XO-1.5, require a short delay after poweroff before the card
1608 * can be successfully turned on again.
1612 mmc_host_clk_release(host);
1615 void mmc_power_cycle(struct mmc_host *host, u32 ocr)
1617 mmc_power_off(host);
1618 /* Wait at least 1 ms according to SD spec */
1620 mmc_power_up(host, ocr);
1624 * Cleanup when the last reference to the bus operator is dropped.
1626 static void __mmc_release_bus(struct mmc_host *host)
1629 BUG_ON(host->bus_refs);
1630 BUG_ON(!host->bus_dead);
1632 host->bus_ops = NULL;
1636 * Increase reference count of bus operator
1638 static inline void mmc_bus_get(struct mmc_host *host)
1640 unsigned long flags;
1642 spin_lock_irqsave(&host->lock, flags);
1644 spin_unlock_irqrestore(&host->lock, flags);
1648 * Decrease reference count of bus operator and free it if
1649 * it is the last reference.
1651 static inline void mmc_bus_put(struct mmc_host *host)
1653 unsigned long flags;
1655 spin_lock_irqsave(&host->lock, flags);
1657 if ((host->bus_refs == 0) && host->bus_ops)
1658 __mmc_release_bus(host);
1659 spin_unlock_irqrestore(&host->lock, flags);
1663 * Assign a mmc bus handler to a host. Only one bus handler may control a
1664 * host at any given time.
1666 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops)
1668 unsigned long flags;
1673 WARN_ON(!host->claimed);
1675 spin_lock_irqsave(&host->lock, flags);
1677 BUG_ON(host->bus_ops);
1678 BUG_ON(host->bus_refs);
1680 host->bus_ops = ops;
1684 spin_unlock_irqrestore(&host->lock, flags);
1688 * Remove the current bus handler from a host.
1690 void mmc_detach_bus(struct mmc_host *host)
1692 unsigned long flags;
1696 WARN_ON(!host->claimed);
1697 WARN_ON(!host->bus_ops);
1699 spin_lock_irqsave(&host->lock, flags);
1703 spin_unlock_irqrestore(&host->lock, flags);
1708 static void _mmc_detect_change(struct mmc_host *host, unsigned long delay,
1711 #ifdef CONFIG_MMC_DEBUG
1712 unsigned long flags;
1713 spin_lock_irqsave(&host->lock, flags);
1714 WARN_ON(host->removed);
1715 spin_unlock_irqrestore(&host->lock, flags);
1719 * If the device is configured as wakeup, we prevent a new sleep for
1720 * 5 s to give provision for user space to consume the event.
1722 if (cd_irq && !(host->caps & MMC_CAP_NEEDS_POLL) &&
1723 device_can_wakeup(mmc_dev(host)))
1724 pm_wakeup_event(mmc_dev(host), 5000);
1726 host->detect_change = 1;
1727 mmc_schedule_delayed_work(&host->detect, delay);
1731 * mmc_detect_change - process change of state on a MMC socket
1732 * @host: host which changed state.
1733 * @delay: optional delay to wait before detection (jiffies)
1735 * MMC drivers should call this when they detect a card has been
1736 * inserted or removed. The MMC layer will confirm that any
1737 * present card is still functional, and initialize any newly
1740 void mmc_detect_change(struct mmc_host *host, unsigned long delay)
1742 _mmc_detect_change(host, delay, true);
1744 EXPORT_SYMBOL(mmc_detect_change);
1746 void mmc_init_erase(struct mmc_card *card)
1750 if (is_power_of_2(card->erase_size))
1751 card->erase_shift = ffs(card->erase_size) - 1;
1753 card->erase_shift = 0;
1756 * It is possible to erase an arbitrarily large area of an SD or MMC
1757 * card. That is not desirable because it can take a long time
1758 * (minutes) potentially delaying more important I/O, and also the
1759 * timeout calculations become increasingly hugely over-estimated.
1760 * Consequently, 'pref_erase' is defined as a guide to limit erases
1761 * to that size and alignment.
1763 * For SD cards that define Allocation Unit size, limit erases to one
1764 * Allocation Unit at a time. For MMC cards that define High Capacity
1765 * Erase Size, whether it is switched on or not, limit to that size.
1766 * Otherwise just have a stab at a good value. For modern cards it
1767 * will end up being 4MiB. Note that if the value is too small, it
1768 * can end up taking longer to erase.
1770 if (mmc_card_sd(card) && card->ssr.au) {
1771 card->pref_erase = card->ssr.au;
1772 card->erase_shift = ffs(card->ssr.au) - 1;
1773 } else if (card->ext_csd.hc_erase_size) {
1774 card->pref_erase = card->ext_csd.hc_erase_size;
1775 } else if (card->erase_size) {
1776 sz = (card->csd.capacity << (card->csd.read_blkbits - 9)) >> 11;
1778 card->pref_erase = 512 * 1024 / 512;
1780 card->pref_erase = 1024 * 1024 / 512;
1782 card->pref_erase = 2 * 1024 * 1024 / 512;
1784 card->pref_erase = 4 * 1024 * 1024 / 512;
1785 if (card->pref_erase < card->erase_size)
1786 card->pref_erase = card->erase_size;
1788 sz = card->pref_erase % card->erase_size;
1790 card->pref_erase += card->erase_size - sz;
1793 card->pref_erase = 0;
1796 static unsigned int mmc_mmc_erase_timeout(struct mmc_card *card,
1797 unsigned int arg, unsigned int qty)
1799 unsigned int erase_timeout;
1801 if (arg == MMC_DISCARD_ARG ||
1802 (arg == MMC_TRIM_ARG && card->ext_csd.rev >= 6)) {
1803 erase_timeout = card->ext_csd.trim_timeout;
1804 } else if (card->ext_csd.erase_group_def & 1) {
1805 /* High Capacity Erase Group Size uses HC timeouts */
1806 if (arg == MMC_TRIM_ARG)
1807 erase_timeout = card->ext_csd.trim_timeout;
1809 erase_timeout = card->ext_csd.hc_erase_timeout;
1811 /* CSD Erase Group Size uses write timeout */
1812 unsigned int mult = (10 << card->csd.r2w_factor);
1813 unsigned int timeout_clks = card->csd.tacc_clks * mult;
1814 unsigned int timeout_us;
1816 /* Avoid overflow: e.g. tacc_ns=80000000 mult=1280 */
1817 if (card->csd.tacc_ns < 1000000)
1818 timeout_us = (card->csd.tacc_ns * mult) / 1000;
1820 timeout_us = (card->csd.tacc_ns / 1000) * mult;
1823 * ios.clock is only a target. The real clock rate might be
1824 * less but not that much less, so fudge it by multiplying by 2.
1827 timeout_us += (timeout_clks * 1000) /
1828 (mmc_host_clk_rate(card->host) / 1000);
1830 erase_timeout = timeout_us / 1000;
1833 * Theoretically, the calculation could underflow so round up
1834 * to 1ms in that case.
1840 /* Multiplier for secure operations */
1841 if (arg & MMC_SECURE_ARGS) {
1842 if (arg == MMC_SECURE_ERASE_ARG)
1843 erase_timeout *= card->ext_csd.sec_erase_mult;
1845 erase_timeout *= card->ext_csd.sec_trim_mult;
1848 erase_timeout *= qty;
1851 * Ensure at least a 1 second timeout for SPI as per
1852 * 'mmc_set_data_timeout()'
1854 if (mmc_host_is_spi(card->host) && erase_timeout < 1000)
1855 erase_timeout = 1000;
1857 return erase_timeout;
1860 static unsigned int mmc_sd_erase_timeout(struct mmc_card *card,
1864 unsigned int erase_timeout;
1866 if (card->ssr.erase_timeout) {
1867 /* Erase timeout specified in SD Status Register (SSR) */
1868 erase_timeout = card->ssr.erase_timeout * qty +
1869 card->ssr.erase_offset;
1872 * Erase timeout not specified in SD Status Register (SSR) so
1873 * use 250ms per write block.
1875 erase_timeout = 250 * qty;
1878 /* Must not be less than 1 second */
1879 if (erase_timeout < 1000)
1880 erase_timeout = 1000;
1882 return erase_timeout;
1885 static unsigned int mmc_erase_timeout(struct mmc_card *card,
1889 if (mmc_card_sd(card))
1890 return mmc_sd_erase_timeout(card, arg, qty);
1892 return mmc_mmc_erase_timeout(card, arg, qty);
1895 static int mmc_do_erase(struct mmc_card *card, unsigned int from,
1896 unsigned int to, unsigned int arg)
1898 struct mmc_command cmd = {0};
1899 unsigned int qty = 0;
1900 unsigned long timeout;
1904 * qty is used to calculate the erase timeout which depends on how many
1905 * erase groups (or allocation units in SD terminology) are affected.
1906 * We count erasing part of an erase group as one erase group.
1907 * For SD, the allocation units are always a power of 2. For MMC, the
1908 * erase group size is almost certainly also power of 2, but it does not
1909 * seem to insist on that in the JEDEC standard, so we fall back to
1910 * division in that case. SD may not specify an allocation unit size,
1911 * in which case the timeout is based on the number of write blocks.
1913 * Note that the timeout for secure trim 2 will only be correct if the
1914 * number of erase groups specified is the same as the total of all
1915 * preceding secure trim 1 commands. Since the power may have been
1916 * lost since the secure trim 1 commands occurred, it is generally
1917 * impossible to calculate the secure trim 2 timeout correctly.
1919 if (card->erase_shift)
1920 qty += ((to >> card->erase_shift) -
1921 (from >> card->erase_shift)) + 1;
1922 else if (mmc_card_sd(card))
1923 qty += to - from + 1;
1925 qty += ((to / card->erase_size) -
1926 (from / card->erase_size)) + 1;
1928 if (!mmc_card_blockaddr(card)) {
1933 if (mmc_card_sd(card))
1934 cmd.opcode = SD_ERASE_WR_BLK_START;
1936 cmd.opcode = MMC_ERASE_GROUP_START;
1938 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1939 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1941 pr_err("mmc_erase: group start error %d, "
1942 "status %#x\n", err, cmd.resp[0]);
1947 memset(&cmd, 0, sizeof(struct mmc_command));
1948 if (mmc_card_sd(card))
1949 cmd.opcode = SD_ERASE_WR_BLK_END;
1951 cmd.opcode = MMC_ERASE_GROUP_END;
1953 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1954 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1956 pr_err("mmc_erase: group end error %d, status %#x\n",
1962 memset(&cmd, 0, sizeof(struct mmc_command));
1963 cmd.opcode = MMC_ERASE;
1965 cmd.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
1966 cmd.busy_timeout = mmc_erase_timeout(card, arg, qty);
1967 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1969 pr_err("mmc_erase: erase error %d, status %#x\n",
1975 if (mmc_host_is_spi(card->host))
1978 timeout = jiffies + msecs_to_jiffies(MMC_CORE_TIMEOUT_MS);
1980 memset(&cmd, 0, sizeof(struct mmc_command));
1981 cmd.opcode = MMC_SEND_STATUS;
1982 cmd.arg = card->rca << 16;
1983 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1984 /* Do not retry else we can't see errors */
1985 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1986 if (err || (cmd.resp[0] & 0xFDF92000)) {
1987 pr_err("error %d requesting status %#x\n",
1993 /* Timeout if the device never becomes ready for data and
1994 * never leaves the program state.
1996 if (time_after(jiffies, timeout)) {
1997 pr_err("%s: Card stuck in programming state! %s\n",
1998 mmc_hostname(card->host), __func__);
2003 } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
2004 (R1_CURRENT_STATE(cmd.resp[0]) == R1_STATE_PRG));
2010 * mmc_erase - erase sectors.
2011 * @card: card to erase
2012 * @from: first sector to erase
2013 * @nr: number of sectors to erase
2014 * @arg: erase command argument (SD supports only %MMC_ERASE_ARG)
2016 * Caller must claim host before calling this function.
2018 int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
2021 unsigned int rem, to = from + nr;
2023 if (!(card->host->caps & MMC_CAP_ERASE) ||
2024 !(card->csd.cmdclass & CCC_ERASE))
2027 if (!card->erase_size)
2030 if (mmc_card_sd(card) && arg != MMC_ERASE_ARG)
2033 if ((arg & MMC_SECURE_ARGS) &&
2034 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN))
2037 if ((arg & MMC_TRIM_ARGS) &&
2038 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN))
2041 if (arg == MMC_SECURE_ERASE_ARG) {
2042 if (from % card->erase_size || nr % card->erase_size)
2046 if (arg == MMC_ERASE_ARG) {
2047 rem = from % card->erase_size;
2049 rem = card->erase_size - rem;
2056 rem = nr % card->erase_size;
2069 /* 'from' and 'to' are inclusive */
2072 return mmc_do_erase(card, from, to, arg);
2074 EXPORT_SYMBOL(mmc_erase);
2076 int mmc_can_erase(struct mmc_card *card)
2078 if ((card->host->caps & MMC_CAP_ERASE) &&
2079 (card->csd.cmdclass & CCC_ERASE) && card->erase_size)
2083 EXPORT_SYMBOL(mmc_can_erase);
2085 int mmc_can_trim(struct mmc_card *card)
2087 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN)
2091 EXPORT_SYMBOL(mmc_can_trim);
2093 int mmc_can_discard(struct mmc_card *card)
2096 * As there's no way to detect the discard support bit at v4.5
2097 * use the s/w feature support filed.
2099 if (card->ext_csd.feature_support & MMC_DISCARD_FEATURE)
2103 EXPORT_SYMBOL(mmc_can_discard);
2105 int mmc_can_sanitize(struct mmc_card *card)
2107 if (!mmc_can_trim(card) && !mmc_can_erase(card))
2109 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_SANITIZE)
2113 EXPORT_SYMBOL(mmc_can_sanitize);
2115 int mmc_can_secure_erase_trim(struct mmc_card *card)
2117 if ((card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN) &&
2118 !(card->quirks & MMC_QUIRK_SEC_ERASE_TRIM_BROKEN))
2122 EXPORT_SYMBOL(mmc_can_secure_erase_trim);
2124 int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
2127 if (!card->erase_size)
2129 if (from % card->erase_size || nr % card->erase_size)
2133 EXPORT_SYMBOL(mmc_erase_group_aligned);
2135 static unsigned int mmc_do_calc_max_discard(struct mmc_card *card,
2138 struct mmc_host *host = card->host;
2139 unsigned int max_discard, x, y, qty = 0, max_qty, timeout;
2140 unsigned int last_timeout = 0;
2142 if (card->erase_shift)
2143 max_qty = UINT_MAX >> card->erase_shift;
2144 else if (mmc_card_sd(card))
2147 max_qty = UINT_MAX / card->erase_size;
2149 /* Find the largest qty with an OK timeout */
2152 for (x = 1; x && x <= max_qty && max_qty - x >= qty; x <<= 1) {
2153 timeout = mmc_erase_timeout(card, arg, qty + x);
2154 if (timeout > host->max_busy_timeout)
2156 if (timeout < last_timeout)
2158 last_timeout = timeout;
2170 /* Convert qty to sectors */
2171 if (card->erase_shift)
2172 max_discard = --qty << card->erase_shift;
2173 else if (mmc_card_sd(card))
2176 max_discard = --qty * card->erase_size;
2181 unsigned int mmc_calc_max_discard(struct mmc_card *card)
2183 struct mmc_host *host = card->host;
2184 unsigned int max_discard, max_trim;
2186 if (!host->max_busy_timeout)
2190 * Without erase_group_def set, MMC erase timeout depends on clock
2191 * frequence which can change. In that case, the best choice is
2192 * just the preferred erase size.
2194 if (mmc_card_mmc(card) && !(card->ext_csd.erase_group_def & 1))
2195 return card->pref_erase;
2197 max_discard = mmc_do_calc_max_discard(card, MMC_ERASE_ARG);
2198 if (mmc_can_trim(card)) {
2199 max_trim = mmc_do_calc_max_discard(card, MMC_TRIM_ARG);
2200 if (max_trim < max_discard)
2201 max_discard = max_trim;
2202 } else if (max_discard < card->erase_size) {
2205 pr_debug("%s: calculated max. discard sectors %u for timeout %u ms\n",
2206 mmc_hostname(host), max_discard, host->max_busy_timeout);
2209 EXPORT_SYMBOL(mmc_calc_max_discard);
2211 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen)
2213 struct mmc_command cmd = {0};
2215 if (mmc_card_blockaddr(card) || mmc_card_ddr52(card))
2218 cmd.opcode = MMC_SET_BLOCKLEN;
2220 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2221 return mmc_wait_for_cmd(card->host, &cmd, 5);
2223 EXPORT_SYMBOL(mmc_set_blocklen);
2225 int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount,
2228 struct mmc_command cmd = {0};
2230 cmd.opcode = MMC_SET_BLOCK_COUNT;
2231 cmd.arg = blockcount & 0x0000FFFF;
2234 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2235 return mmc_wait_for_cmd(card->host, &cmd, 5);
2237 EXPORT_SYMBOL(mmc_set_blockcount);
2239 static void mmc_hw_reset_for_init(struct mmc_host *host)
2241 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->hw_reset)
2243 mmc_host_clk_hold(host);
2244 host->ops->hw_reset(host);
2245 mmc_host_clk_release(host);
2248 int mmc_can_reset(struct mmc_card *card)
2252 if (!mmc_card_mmc(card))
2254 rst_n_function = card->ext_csd.rst_n_function;
2255 if ((rst_n_function & EXT_CSD_RST_N_EN_MASK) != EXT_CSD_RST_N_ENABLED)
2259 EXPORT_SYMBOL(mmc_can_reset);
2261 static int mmc_do_hw_reset(struct mmc_host *host, int check)
2263 struct mmc_card *card = host->card;
2265 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->hw_reset)
2271 if (!mmc_can_reset(card))
2274 mmc_host_clk_hold(host);
2275 mmc_set_clock(host, host->f_init);
2277 host->ops->hw_reset(host);
2279 /* If the reset has happened, then a status command will fail */
2283 if (!mmc_send_status(card, &status)) {
2284 mmc_host_clk_release(host);
2289 /* Set initial state and call mmc_set_ios */
2290 mmc_set_initial_state(host);
2292 mmc_host_clk_release(host);
2294 return host->bus_ops->power_restore(host);
2297 int mmc_hw_reset(struct mmc_host *host)
2299 return mmc_do_hw_reset(host, 0);
2301 EXPORT_SYMBOL(mmc_hw_reset);
2303 int mmc_hw_reset_check(struct mmc_host *host)
2305 return mmc_do_hw_reset(host, 1);
2307 EXPORT_SYMBOL(mmc_hw_reset_check);
2309 static int mmc_rescan_try_freq(struct mmc_host *host, unsigned freq)
2311 host->f_init = freq;
2313 #ifdef CONFIG_MMC_DEBUG
2314 pr_info("%s: %s: trying to init card at %u Hz\n",
2315 mmc_hostname(host), __func__, host->f_init);
2317 mmc_power_up(host, host->ocr_avail);
2320 * Some eMMCs (with VCCQ always on) may not be reset after power up, so
2321 * do a hardware reset if possible.
2323 mmc_hw_reset_for_init(host);
2326 * sdio_reset sends CMD52 to reset card. Since we do not know
2327 * if the card is being re-initialized, just send it. CMD52
2328 * should be ignored by SD/eMMC cards.
2333 mmc_send_if_cond(host, host->ocr_avail);
2335 /* Order's important: probe SDIO, then SD, then MMC */
2336 if (!mmc_attach_sdio(host))
2338 if (!mmc_attach_sd(host))
2340 if (!mmc_attach_mmc(host))
2343 mmc_power_off(host);
2347 int _mmc_detect_card_removed(struct mmc_host *host)
2351 if (host->caps & MMC_CAP_NONREMOVABLE)
2354 if (!host->card || mmc_card_removed(host->card))
2357 ret = host->bus_ops->alive(host);
2360 * Card detect status and alive check may be out of sync if card is
2361 * removed slowly, when card detect switch changes while card/slot
2362 * pads are still contacted in hardware (refer to "SD Card Mechanical
2363 * Addendum, Appendix C: Card Detection Switch"). So reschedule a
2364 * detect work 200ms later for this case.
2366 if (!ret && host->ops->get_cd && !host->ops->get_cd(host)) {
2367 mmc_detect_change(host, msecs_to_jiffies(200));
2368 pr_debug("%s: card removed too slowly\n", mmc_hostname(host));
2372 mmc_card_set_removed(host->card);
2373 pr_debug("%s: card remove detected\n", mmc_hostname(host));
2379 int mmc_detect_card_removed(struct mmc_host *host)
2381 struct mmc_card *card = host->card;
2384 WARN_ON(!host->claimed);
2389 ret = mmc_card_removed(card);
2391 * The card will be considered unchanged unless we have been asked to
2392 * detect a change or host requires polling to provide card detection.
2394 if (!host->detect_change && !(host->caps & MMC_CAP_NEEDS_POLL))
2397 host->detect_change = 0;
2399 ret = _mmc_detect_card_removed(host);
2400 if (ret && (host->caps & MMC_CAP_NEEDS_POLL)) {
2402 * Schedule a detect work as soon as possible to let a
2403 * rescan handle the card removal.
2405 cancel_delayed_work(&host->detect);
2406 _mmc_detect_change(host, 0, false);
2412 EXPORT_SYMBOL(mmc_detect_card_removed);
2414 void mmc_rescan(struct work_struct *work)
2416 struct mmc_host *host =
2417 container_of(work, struct mmc_host, detect.work);
2420 if (host->trigger_card_event && host->ops->card_event) {
2421 host->ops->card_event(host);
2422 host->trigger_card_event = false;
2425 if (host->rescan_disable)
2428 /* If there is a non-removable card registered, only scan once */
2429 if ((host->caps & MMC_CAP_NONREMOVABLE) && host->rescan_entered)
2431 host->rescan_entered = 1;
2436 * if there is a _removable_ card registered, check whether it is
2439 if (host->bus_ops && !host->bus_dead
2440 && !(host->caps & MMC_CAP_NONREMOVABLE))
2441 host->bus_ops->detect(host);
2443 host->detect_change = 0;
2446 * Let mmc_bus_put() free the bus/bus_ops if we've found that
2447 * the card is no longer present.
2452 /* if there still is a card present, stop here */
2453 if (host->bus_ops != NULL) {
2459 * Only we can add a new handler, so it's safe to
2460 * release the lock here.
2464 if (!(host->caps & MMC_CAP_NONREMOVABLE) && host->ops->get_cd &&
2465 host->ops->get_cd(host) == 0) {
2466 mmc_claim_host(host);
2467 mmc_power_off(host);
2468 mmc_release_host(host);
2472 mmc_claim_host(host);
2473 for (i = 0; i < ARRAY_SIZE(freqs); i++) {
2474 if (!mmc_rescan_try_freq(host, max(freqs[i], host->f_min)))
2476 if (freqs[i] <= host->f_min)
2479 mmc_release_host(host);
2482 if (host->caps & MMC_CAP_NEEDS_POLL)
2483 mmc_schedule_delayed_work(&host->detect, HZ);
2486 void mmc_start_host(struct mmc_host *host)
2488 host->f_init = max(freqs[0], host->f_min);
2489 host->rescan_disable = 0;
2490 host->ios.power_mode = MMC_POWER_UNDEFINED;
2491 if (host->caps2 & MMC_CAP2_NO_PRESCAN_POWERUP)
2492 mmc_power_off(host);
2494 mmc_power_up(host, host->ocr_avail);
2495 mmc_gpiod_request_cd_irq(host);
2496 _mmc_detect_change(host, 0, false);
2499 void mmc_stop_host(struct mmc_host *host)
2501 #ifdef CONFIG_MMC_DEBUG
2502 unsigned long flags;
2503 spin_lock_irqsave(&host->lock, flags);
2505 spin_unlock_irqrestore(&host->lock, flags);
2507 if (host->slot.cd_irq >= 0)
2508 disable_irq(host->slot.cd_irq);
2510 host->rescan_disable = 1;
2511 cancel_delayed_work_sync(&host->detect);
2512 mmc_flush_scheduled_work();
2514 /* clear pm flags now and let card drivers set them as needed */
2518 if (host->bus_ops && !host->bus_dead) {
2519 /* Calling bus_ops->remove() with a claimed host can deadlock */
2520 host->bus_ops->remove(host);
2521 mmc_claim_host(host);
2522 mmc_detach_bus(host);
2523 mmc_power_off(host);
2524 mmc_release_host(host);
2532 mmc_power_off(host);
2535 int mmc_power_save_host(struct mmc_host *host)
2539 #ifdef CONFIG_MMC_DEBUG
2540 pr_info("%s: %s: powering down\n", mmc_hostname(host), __func__);
2545 if (!host->bus_ops || host->bus_dead) {
2550 if (host->bus_ops->power_save)
2551 ret = host->bus_ops->power_save(host);
2555 mmc_power_off(host);
2559 EXPORT_SYMBOL(mmc_power_save_host);
2561 int mmc_power_restore_host(struct mmc_host *host)
2565 #ifdef CONFIG_MMC_DEBUG
2566 pr_info("%s: %s: powering up\n", mmc_hostname(host), __func__);
2571 if (!host->bus_ops || host->bus_dead) {
2576 mmc_power_up(host, host->card->ocr);
2577 ret = host->bus_ops->power_restore(host);
2583 EXPORT_SYMBOL(mmc_power_restore_host);
2586 * Flush the cache to the non-volatile storage.
2588 int mmc_flush_cache(struct mmc_card *card)
2592 if (mmc_card_mmc(card) &&
2593 (card->ext_csd.cache_size > 0) &&
2594 (card->ext_csd.cache_ctrl & 1)) {
2595 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
2596 EXT_CSD_FLUSH_CACHE, 1, 0);
2598 pr_err("%s: cache flush error %d\n",
2599 mmc_hostname(card->host), err);
2604 EXPORT_SYMBOL(mmc_flush_cache);
2608 /* Do the card removal on suspend if card is assumed removeable
2609 * Do that in pm notifier while userspace isn't yet frozen, so we will be able
2612 int mmc_pm_notify(struct notifier_block *notify_block,
2613 unsigned long mode, void *unused)
2615 struct mmc_host *host = container_of(
2616 notify_block, struct mmc_host, pm_notify);
2617 unsigned long flags;
2621 case PM_HIBERNATION_PREPARE:
2622 case PM_SUSPEND_PREPARE:
2623 spin_lock_irqsave(&host->lock, flags);
2624 host->rescan_disable = 1;
2625 spin_unlock_irqrestore(&host->lock, flags);
2626 cancel_delayed_work_sync(&host->detect);
2631 /* Validate prerequisites for suspend */
2632 if (host->bus_ops->pre_suspend)
2633 err = host->bus_ops->pre_suspend(host);
2637 /* Calling bus_ops->remove() with a claimed host can deadlock */
2638 host->bus_ops->remove(host);
2639 mmc_claim_host(host);
2640 mmc_detach_bus(host);
2641 mmc_power_off(host);
2642 mmc_release_host(host);
2646 case PM_POST_SUSPEND:
2647 case PM_POST_HIBERNATION:
2648 case PM_POST_RESTORE:
2650 spin_lock_irqsave(&host->lock, flags);
2651 host->rescan_disable = 0;
2652 spin_unlock_irqrestore(&host->lock, flags);
2653 _mmc_detect_change(host, 0, false);
2662 * mmc_init_context_info() - init synchronization context
2665 * Init struct context_info needed to implement asynchronous
2666 * request mechanism, used by mmc core, host driver and mmc requests
2669 void mmc_init_context_info(struct mmc_host *host)
2671 spin_lock_init(&host->context_info.lock);
2672 host->context_info.is_new_req = false;
2673 host->context_info.is_done_rcv = false;
2674 host->context_info.is_waiting_last_req = false;
2675 init_waitqueue_head(&host->context_info.wait);
2678 static int __init mmc_init(void)
2682 workqueue = alloc_ordered_workqueue("kmmcd", 0);
2686 ret = mmc_register_bus();
2688 goto destroy_workqueue;
2690 ret = mmc_register_host_class();
2692 goto unregister_bus;
2694 ret = sdio_register_bus();
2696 goto unregister_host_class;
2700 unregister_host_class:
2701 mmc_unregister_host_class();
2703 mmc_unregister_bus();
2705 destroy_workqueue(workqueue);
2710 static void __exit mmc_exit(void)
2712 sdio_unregister_bus();
2713 mmc_unregister_host_class();
2714 mmc_unregister_bus();
2715 destroy_workqueue(workqueue);
2718 subsys_initcall(mmc_init);
2719 module_exit(mmc_exit);
2721 MODULE_LICENSE("GPL");