2 * linux/drivers/mmc/core/core.c
4 * Copyright (C) 2003-2004 Russell King, All Rights Reserved.
5 * SD support Copyright (C) 2004 Ian Molton, All Rights Reserved.
6 * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
7 * MMCv4 support Copyright (C) 2006 Philip Langdale, All Rights Reserved.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/interrupt.h>
16 #include <linux/completion.h>
17 #include <linux/device.h>
18 #include <linux/delay.h>
19 #include <linux/pagemap.h>
20 #include <linux/err.h>
21 #include <linux/leds.h>
22 #include <linux/scatterlist.h>
23 #include <linux/log2.h>
24 #include <linux/regulator/consumer.h>
25 #include <linux/pm_runtime.h>
26 #include <linux/suspend.h>
27 #include <linux/fault-inject.h>
28 #include <linux/random.h>
29 #include <linux/slab.h>
32 #include <linux/mmc/card.h>
33 #include <linux/mmc/host.h>
34 #include <linux/mmc/mmc.h>
35 #include <linux/mmc/sd.h>
46 /* If the device is not responding */
47 #define MMC_CORE_TIMEOUT_MS (10 * 60 * 1000) /* 10 minute timeout */
50 * Background operations can take a long time, depending on the housekeeping
51 * operations the card has to perform.
53 #define MMC_BKOPS_MAX_TIMEOUT (4 * 60 * 1000) /* max time to wait in ms */
55 static struct workqueue_struct *workqueue;
56 static const unsigned freqs[] = { 400000, 300000, 200000, 100000 };
59 * Enabling software CRCs on the data blocks can be a significant (30%)
60 * performance cost, and for other reasons may not always be desired.
61 * So we allow it it to be disabled.
64 module_param(use_spi_crc, bool, 0);
67 * We normally treat cards as removed during suspend if they are not
68 * known to be on a non-removable bus, to avoid the risk of writing
69 * back data to a different card after resume. Allow this to be
70 * overridden if necessary.
72 #ifdef CONFIG_MMC_UNSAFE_RESUME
73 bool mmc_assume_removable;
75 bool mmc_assume_removable = 1;
77 EXPORT_SYMBOL(mmc_assume_removable);
78 module_param_named(removable, mmc_assume_removable, bool, 0644);
81 "MMC/SD cards are removable and may be removed during suspend");
84 * Internal function. Schedule delayed work in the MMC work queue.
86 static int mmc_schedule_delayed_work(struct delayed_work *work,
89 return queue_delayed_work(workqueue, work, delay);
93 * Internal function. Flush all scheduled work from the MMC work queue.
95 static void mmc_flush_scheduled_work(void)
97 flush_workqueue(workqueue);
100 #ifdef CONFIG_FAIL_MMC_REQUEST
103 * Internal function. Inject random data errors.
104 * If mmc_data is NULL no errors are injected.
106 static void mmc_should_fail_request(struct mmc_host *host,
107 struct mmc_request *mrq)
109 struct mmc_command *cmd = mrq->cmd;
110 struct mmc_data *data = mrq->data;
111 static const int data_errors[] = {
120 if (cmd->error || data->error ||
121 !should_fail(&host->fail_mmc_request, data->blksz * data->blocks))
124 data->error = data_errors[prandom_u32() % ARRAY_SIZE(data_errors)];
125 data->bytes_xfered = (prandom_u32() % (data->bytes_xfered >> 9)) << 9;
128 #else /* CONFIG_FAIL_MMC_REQUEST */
130 static inline void mmc_should_fail_request(struct mmc_host *host,
131 struct mmc_request *mrq)
135 #endif /* CONFIG_FAIL_MMC_REQUEST */
138 * mmc_request_done - finish processing an MMC request
139 * @host: MMC host which completed request
140 * @mrq: MMC request which request
142 * MMC drivers should call this function when they have completed
143 * their processing of a request.
145 void mmc_request_done(struct mmc_host *host, struct mmc_request *mrq)
147 struct mmc_command *cmd = mrq->cmd;
148 int err = cmd->error;
150 if (err && cmd->retries && mmc_host_is_spi(host)) {
151 if (cmd->resp[0] & R1_SPI_ILLEGAL_COMMAND)
155 if (err && cmd->retries && !mmc_card_removed(host->card)) {
157 * Request starter must handle retries - see
158 * mmc_wait_for_req_done().
163 mmc_should_fail_request(host, mrq);
165 led_trigger_event(host->led, LED_OFF);
167 pr_debug("%s: req done (CMD%u): %d: %08x %08x %08x %08x\n",
168 mmc_hostname(host), cmd->opcode, err,
169 cmd->resp[0], cmd->resp[1],
170 cmd->resp[2], cmd->resp[3]);
173 pr_debug("%s: %d bytes transferred: %d\n",
175 mrq->data->bytes_xfered, mrq->data->error);
179 pr_debug("%s: (CMD%u): %d: %08x %08x %08x %08x\n",
180 mmc_hostname(host), mrq->stop->opcode,
182 mrq->stop->resp[0], mrq->stop->resp[1],
183 mrq->stop->resp[2], mrq->stop->resp[3]);
189 mmc_host_clk_release(host);
193 EXPORT_SYMBOL(mmc_request_done);
196 mmc_start_request(struct mmc_host *host, struct mmc_request *mrq)
198 #ifdef CONFIG_MMC_DEBUG
200 struct scatterlist *sg;
204 pr_debug("<%s: starting CMD%u arg %08x flags %08x>\n",
205 mmc_hostname(host), mrq->sbc->opcode,
206 mrq->sbc->arg, mrq->sbc->flags);
209 pr_debug("%s: starting CMD%u arg %08x flags %08x\n",
210 mmc_hostname(host), mrq->cmd->opcode,
211 mrq->cmd->arg, mrq->cmd->flags);
214 pr_debug("%s: blksz %d blocks %d flags %08x "
215 "tsac %d ms nsac %d\n",
216 mmc_hostname(host), mrq->data->blksz,
217 mrq->data->blocks, mrq->data->flags,
218 mrq->data->timeout_ns / 1000000,
219 mrq->data->timeout_clks);
223 pr_debug("%s: CMD%u arg %08x flags %08x\n",
224 mmc_hostname(host), mrq->stop->opcode,
225 mrq->stop->arg, mrq->stop->flags);
228 WARN_ON(!host->claimed);
233 BUG_ON(mrq->data->blksz > host->max_blk_size);
234 BUG_ON(mrq->data->blocks > host->max_blk_count);
235 BUG_ON(mrq->data->blocks * mrq->data->blksz >
238 #ifdef CONFIG_MMC_DEBUG
240 for_each_sg(mrq->data->sg, sg, mrq->data->sg_len, i)
242 BUG_ON(sz != mrq->data->blocks * mrq->data->blksz);
245 mrq->cmd->data = mrq->data;
246 mrq->data->error = 0;
247 mrq->data->mrq = mrq;
249 mrq->data->stop = mrq->stop;
250 mrq->stop->error = 0;
251 mrq->stop->mrq = mrq;
254 mmc_host_clk_hold(host);
255 led_trigger_event(host->led, LED_FULL);
256 host->ops->request(host, mrq);
260 * mmc_start_bkops - start BKOPS for supported cards
261 * @card: MMC card to start BKOPS
262 * @form_exception: A flag to indicate if this function was
263 * called due to an exception raised by the card
265 * Start background operations whenever requested.
266 * When the urgent BKOPS bit is set in a R1 command response
267 * then background operations should be started immediately.
269 void mmc_start_bkops(struct mmc_card *card, bool from_exception)
273 bool use_busy_signal;
277 if (!card->ext_csd.bkops_en || mmc_card_doing_bkops(card))
280 err = mmc_read_bkops_status(card);
282 pr_err("%s: Failed to read bkops status: %d\n",
283 mmc_hostname(card->host), err);
287 if (!card->ext_csd.raw_bkops_status)
290 if (card->ext_csd.raw_bkops_status < EXT_CSD_BKOPS_LEVEL_2 &&
294 mmc_claim_host(card->host);
295 if (card->ext_csd.raw_bkops_status >= EXT_CSD_BKOPS_LEVEL_2) {
296 timeout = MMC_BKOPS_MAX_TIMEOUT;
297 use_busy_signal = true;
300 use_busy_signal = false;
303 err = __mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
304 EXT_CSD_BKOPS_START, 1, timeout, use_busy_signal, true);
306 pr_warn("%s: Error %d starting bkops\n",
307 mmc_hostname(card->host), err);
312 * For urgent bkops status (LEVEL_2 and more)
313 * bkops executed synchronously, otherwise
314 * the operation is in progress
316 if (!use_busy_signal)
317 mmc_card_set_doing_bkops(card);
319 mmc_release_host(card->host);
321 EXPORT_SYMBOL(mmc_start_bkops);
324 * mmc_wait_data_done() - done callback for data request
325 * @mrq: done data request
327 * Wakes up mmc context, passed as a callback to host controller driver
329 static void mmc_wait_data_done(struct mmc_request *mrq)
331 mrq->host->context_info.is_done_rcv = true;
332 wake_up_interruptible(&mrq->host->context_info.wait);
335 static void mmc_wait_done(struct mmc_request *mrq)
337 complete(&mrq->completion);
341 *__mmc_start_data_req() - starts data request
342 * @host: MMC host to start the request
343 * @mrq: data request to start
345 * Sets the done callback to be called when request is completed by the card.
346 * Starts data mmc request execution
348 static int __mmc_start_data_req(struct mmc_host *host, struct mmc_request *mrq)
350 mrq->done = mmc_wait_data_done;
352 if (mmc_card_removed(host->card)) {
353 mrq->cmd->error = -ENOMEDIUM;
354 mmc_wait_data_done(mrq);
357 mmc_start_request(host, mrq);
362 static int __mmc_start_req(struct mmc_host *host, struct mmc_request *mrq)
364 init_completion(&mrq->completion);
365 mrq->done = mmc_wait_done;
366 if (mmc_card_removed(host->card)) {
367 mrq->cmd->error = -ENOMEDIUM;
368 complete(&mrq->completion);
371 mmc_start_request(host, mrq);
376 * mmc_wait_for_data_req_done() - wait for request completed
377 * @host: MMC host to prepare the command.
378 * @mrq: MMC request to wait for
380 * Blocks MMC context till host controller will ack end of data request
381 * execution or new request notification arrives from the block layer.
382 * Handles command retries.
384 * Returns enum mmc_blk_status after checking errors.
386 static int mmc_wait_for_data_req_done(struct mmc_host *host,
387 struct mmc_request *mrq,
388 struct mmc_async_req *next_req)
390 struct mmc_command *cmd;
391 struct mmc_context_info *context_info = &host->context_info;
396 wait_event_interruptible(context_info->wait,
397 (context_info->is_done_rcv ||
398 context_info->is_new_req));
399 spin_lock_irqsave(&context_info->lock, flags);
400 context_info->is_waiting_last_req = false;
401 spin_unlock_irqrestore(&context_info->lock, flags);
402 if (context_info->is_done_rcv) {
403 context_info->is_done_rcv = false;
404 context_info->is_new_req = false;
407 if (!cmd->error || !cmd->retries ||
408 mmc_card_removed(host->card)) {
409 err = host->areq->err_check(host->card,
411 break; /* return err */
413 pr_info("%s: req failed (CMD%u): %d, retrying...\n",
415 cmd->opcode, cmd->error);
418 host->ops->request(host, mrq);
419 continue; /* wait for done/new event again */
421 } else if (context_info->is_new_req) {
422 context_info->is_new_req = false;
424 err = MMC_BLK_NEW_REQUEST;
425 break; /* return err */
432 static void mmc_wait_for_req_done(struct mmc_host *host,
433 struct mmc_request *mrq)
435 struct mmc_command *cmd;
438 wait_for_completion(&mrq->completion);
443 * If host has timed out waiting for the sanitize
444 * to complete, card might be still in programming state
445 * so let's try to bring the card out of programming
448 if (cmd->sanitize_busy && cmd->error == -ETIMEDOUT) {
449 if (!mmc_interrupt_hpi(host->card)) {
450 pr_warning("%s: %s: Interrupted sanitize\n",
451 mmc_hostname(host), __func__);
455 pr_err("%s: %s: Failed to interrupt sanitize\n",
456 mmc_hostname(host), __func__);
459 if (!cmd->error || !cmd->retries ||
460 mmc_card_removed(host->card))
463 pr_debug("%s: req failed (CMD%u): %d, retrying...\n",
464 mmc_hostname(host), cmd->opcode, cmd->error);
467 host->ops->request(host, mrq);
472 * mmc_pre_req - Prepare for a new request
473 * @host: MMC host to prepare command
474 * @mrq: MMC request to prepare for
475 * @is_first_req: true if there is no previous started request
476 * that may run in parellel to this call, otherwise false
478 * mmc_pre_req() is called in prior to mmc_start_req() to let
479 * host prepare for the new request. Preparation of a request may be
480 * performed while another request is running on the host.
482 static void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq,
485 if (host->ops->pre_req) {
486 mmc_host_clk_hold(host);
487 host->ops->pre_req(host, mrq, is_first_req);
488 mmc_host_clk_release(host);
493 * mmc_post_req - Post process a completed request
494 * @host: MMC host to post process command
495 * @mrq: MMC request to post process for
496 * @err: Error, if non zero, clean up any resources made in pre_req
498 * Let the host post process a completed request. Post processing of
499 * a request may be performed while another reuqest is running.
501 static void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq,
504 if (host->ops->post_req) {
505 mmc_host_clk_hold(host);
506 host->ops->post_req(host, mrq, err);
507 mmc_host_clk_release(host);
512 * mmc_start_req - start a non-blocking request
513 * @host: MMC host to start command
514 * @areq: async request to start
515 * @error: out parameter returns 0 for success, otherwise non zero
517 * Start a new MMC custom command request for a host.
518 * If there is on ongoing async request wait for completion
519 * of that request and start the new one and return.
520 * Does not wait for the new request to complete.
522 * Returns the completed request, NULL in case of none completed.
523 * Wait for the an ongoing request (previoulsy started) to complete and
524 * return the completed request. If there is no ongoing request, NULL
525 * is returned without waiting. NULL is not an error condition.
527 struct mmc_async_req *mmc_start_req(struct mmc_host *host,
528 struct mmc_async_req *areq, int *error)
532 struct mmc_async_req *data = host->areq;
534 /* Prepare a new request */
536 mmc_pre_req(host, areq->mrq, !host->areq);
539 err = mmc_wait_for_data_req_done(host, host->areq->mrq, areq);
540 if (err == MMC_BLK_NEW_REQUEST) {
544 * The previous request was not completed,
550 * Check BKOPS urgency for each R1 response
552 if (host->card && mmc_card_mmc(host->card) &&
553 ((mmc_resp_type(host->areq->mrq->cmd) == MMC_RSP_R1) ||
554 (mmc_resp_type(host->areq->mrq->cmd) == MMC_RSP_R1B)) &&
555 (host->areq->mrq->cmd->resp[0] & R1_EXCEPTION_EVENT))
556 mmc_start_bkops(host->card, true);
560 start_err = __mmc_start_data_req(host, areq->mrq);
563 mmc_post_req(host, host->areq->mrq, 0);
565 /* Cancel a prepared request if it was not started. */
566 if ((err || start_err) && areq)
567 mmc_post_req(host, areq->mrq, -EINVAL);
578 EXPORT_SYMBOL(mmc_start_req);
581 * mmc_wait_for_req - start a request and wait for completion
582 * @host: MMC host to start command
583 * @mrq: MMC request to start
585 * Start a new MMC custom command request for a host, and wait
586 * for the command to complete. Does not attempt to parse the
589 void mmc_wait_for_req(struct mmc_host *host, struct mmc_request *mrq)
591 __mmc_start_req(host, mrq);
592 mmc_wait_for_req_done(host, mrq);
594 EXPORT_SYMBOL(mmc_wait_for_req);
597 * mmc_interrupt_hpi - Issue for High priority Interrupt
598 * @card: the MMC card associated with the HPI transfer
600 * Issued High Priority Interrupt, and check for card status
601 * until out-of prg-state.
603 int mmc_interrupt_hpi(struct mmc_card *card)
607 unsigned long prg_wait;
611 if (!card->ext_csd.hpi_en) {
612 pr_info("%s: HPI enable bit unset\n", mmc_hostname(card->host));
616 mmc_claim_host(card->host);
617 err = mmc_send_status(card, &status);
619 pr_err("%s: Get card status fail\n", mmc_hostname(card->host));
623 switch (R1_CURRENT_STATE(status)) {
629 * In idle and transfer states, HPI is not needed and the caller
630 * can issue the next intended command immediately
636 /* In all other states, it's illegal to issue HPI */
637 pr_debug("%s: HPI cannot be sent. Card state=%d\n",
638 mmc_hostname(card->host), R1_CURRENT_STATE(status));
643 err = mmc_send_hpi_cmd(card, &status);
647 prg_wait = jiffies + msecs_to_jiffies(card->ext_csd.out_of_int_time);
649 err = mmc_send_status(card, &status);
651 if (!err && R1_CURRENT_STATE(status) == R1_STATE_TRAN)
653 if (time_after(jiffies, prg_wait))
658 mmc_release_host(card->host);
661 EXPORT_SYMBOL(mmc_interrupt_hpi);
664 * mmc_wait_for_cmd - start a command and wait for completion
665 * @host: MMC host to start command
666 * @cmd: MMC command to start
667 * @retries: maximum number of retries
669 * Start a new MMC command for a host, and wait for the command
670 * to complete. Return any error that occurred while the command
671 * was executing. Do not attempt to parse the response.
673 int mmc_wait_for_cmd(struct mmc_host *host, struct mmc_command *cmd, int retries)
675 struct mmc_request mrq = {NULL};
677 WARN_ON(!host->claimed);
679 memset(cmd->resp, 0, sizeof(cmd->resp));
680 cmd->retries = retries;
685 mmc_wait_for_req(host, &mrq);
690 EXPORT_SYMBOL(mmc_wait_for_cmd);
693 * mmc_stop_bkops - stop ongoing BKOPS
694 * @card: MMC card to check BKOPS
696 * Send HPI command to stop ongoing background operations to
697 * allow rapid servicing of foreground operations, e.g. read/
698 * writes. Wait until the card comes out of the programming state
699 * to avoid errors in servicing read/write requests.
701 int mmc_stop_bkops(struct mmc_card *card)
706 err = mmc_interrupt_hpi(card);
709 * If err is EINVAL, we can't issue an HPI.
710 * It should complete the BKOPS.
712 if (!err || (err == -EINVAL)) {
713 mmc_card_clr_doing_bkops(card);
719 EXPORT_SYMBOL(mmc_stop_bkops);
721 int mmc_read_bkops_status(struct mmc_card *card)
727 * In future work, we should consider storing the entire ext_csd.
729 ext_csd = kmalloc(512, GFP_KERNEL);
731 pr_err("%s: could not allocate buffer to receive the ext_csd.\n",
732 mmc_hostname(card->host));
736 mmc_claim_host(card->host);
737 err = mmc_send_ext_csd(card, ext_csd);
738 mmc_release_host(card->host);
742 card->ext_csd.raw_bkops_status = ext_csd[EXT_CSD_BKOPS_STATUS];
743 card->ext_csd.raw_exception_status = ext_csd[EXT_CSD_EXP_EVENTS_STATUS];
748 EXPORT_SYMBOL(mmc_read_bkops_status);
751 * mmc_set_data_timeout - set the timeout for a data command
752 * @data: data phase for command
753 * @card: the MMC card associated with the data transfer
755 * Computes the data timeout parameters according to the
756 * correct algorithm given the card type.
758 void mmc_set_data_timeout(struct mmc_data *data, const struct mmc_card *card)
763 * SDIO cards only define an upper 1 s limit on access.
765 if (mmc_card_sdio(card)) {
766 data->timeout_ns = 1000000000;
767 data->timeout_clks = 0;
772 * SD cards use a 100 multiplier rather than 10
774 mult = mmc_card_sd(card) ? 100 : 10;
777 * Scale up the multiplier (and therefore the timeout) by
778 * the r2w factor for writes.
780 if (data->flags & MMC_DATA_WRITE)
781 mult <<= card->csd.r2w_factor;
783 data->timeout_ns = card->csd.tacc_ns * mult;
784 data->timeout_clks = card->csd.tacc_clks * mult;
787 * SD cards also have an upper limit on the timeout.
789 if (mmc_card_sd(card)) {
790 unsigned int timeout_us, limit_us;
792 timeout_us = data->timeout_ns / 1000;
793 if (mmc_host_clk_rate(card->host))
794 timeout_us += data->timeout_clks * 1000 /
795 (mmc_host_clk_rate(card->host) / 1000);
797 if (data->flags & MMC_DATA_WRITE)
799 * The MMC spec "It is strongly recommended
800 * for hosts to implement more than 500ms
801 * timeout value even if the card indicates
802 * the 250ms maximum busy length." Even the
803 * previous value of 300ms is known to be
804 * insufficient for some cards.
811 * SDHC cards always use these fixed values.
813 if (timeout_us > limit_us || mmc_card_blockaddr(card)) {
814 data->timeout_ns = limit_us * 1000;
815 data->timeout_clks = 0;
820 * Some cards require longer data read timeout than indicated in CSD.
821 * Address this by setting the read timeout to a "reasonably high"
822 * value. For the cards tested, 300ms has proven enough. If necessary,
823 * this value can be increased if other problematic cards require this.
825 if (mmc_card_long_read_time(card) && data->flags & MMC_DATA_READ) {
826 data->timeout_ns = 300000000;
827 data->timeout_clks = 0;
831 * Some cards need very high timeouts if driven in SPI mode.
832 * The worst observed timeout was 900ms after writing a
833 * continuous stream of data until the internal logic
836 if (mmc_host_is_spi(card->host)) {
837 if (data->flags & MMC_DATA_WRITE) {
838 if (data->timeout_ns < 1000000000)
839 data->timeout_ns = 1000000000; /* 1s */
841 if (data->timeout_ns < 100000000)
842 data->timeout_ns = 100000000; /* 100ms */
846 EXPORT_SYMBOL(mmc_set_data_timeout);
849 * mmc_align_data_size - pads a transfer size to a more optimal value
850 * @card: the MMC card associated with the data transfer
851 * @sz: original transfer size
853 * Pads the original data size with a number of extra bytes in
854 * order to avoid controller bugs and/or performance hits
855 * (e.g. some controllers revert to PIO for certain sizes).
857 * Returns the improved size, which might be unmodified.
859 * Note that this function is only relevant when issuing a
860 * single scatter gather entry.
862 unsigned int mmc_align_data_size(struct mmc_card *card, unsigned int sz)
865 * FIXME: We don't have a system for the controller to tell
866 * the core about its problems yet, so for now we just 32-bit
869 sz = ((sz + 3) / 4) * 4;
873 EXPORT_SYMBOL(mmc_align_data_size);
876 * __mmc_claim_host - exclusively claim a host
877 * @host: mmc host to claim
878 * @abort: whether or not the operation should be aborted
880 * Claim a host for a set of operations. If @abort is non null and
881 * dereference a non-zero value then this will return prematurely with
882 * that non-zero value without acquiring the lock. Returns zero
883 * with the lock held otherwise.
885 int __mmc_claim_host(struct mmc_host *host, atomic_t *abort)
887 DECLARE_WAITQUEUE(wait, current);
893 add_wait_queue(&host->wq, &wait);
894 spin_lock_irqsave(&host->lock, flags);
896 set_current_state(TASK_UNINTERRUPTIBLE);
897 stop = abort ? atomic_read(abort) : 0;
898 if (stop || !host->claimed || host->claimer == current)
900 spin_unlock_irqrestore(&host->lock, flags);
902 spin_lock_irqsave(&host->lock, flags);
904 set_current_state(TASK_RUNNING);
907 host->claimer = current;
908 host->claim_cnt += 1;
911 spin_unlock_irqrestore(&host->lock, flags);
912 remove_wait_queue(&host->wq, &wait);
913 if (host->ops->enable && !stop && host->claim_cnt == 1)
914 host->ops->enable(host);
918 EXPORT_SYMBOL(__mmc_claim_host);
921 * mmc_release_host - release a host
922 * @host: mmc host to release
924 * Release a MMC host, allowing others to claim the host
925 * for their operations.
927 void mmc_release_host(struct mmc_host *host)
931 WARN_ON(!host->claimed);
933 if (host->ops->disable && host->claim_cnt == 1)
934 host->ops->disable(host);
936 spin_lock_irqsave(&host->lock, flags);
937 if (--host->claim_cnt) {
938 /* Release for nested claim */
939 spin_unlock_irqrestore(&host->lock, flags);
942 host->claimer = NULL;
943 spin_unlock_irqrestore(&host->lock, flags);
947 EXPORT_SYMBOL(mmc_release_host);
950 * This is a helper function, which fetches a runtime pm reference for the
951 * card device and also claims the host.
953 void mmc_get_card(struct mmc_card *card)
955 pm_runtime_get_sync(&card->dev);
956 mmc_claim_host(card->host);
958 EXPORT_SYMBOL(mmc_get_card);
961 * This is a helper function, which releases the host and drops the runtime
962 * pm reference for the card device.
964 void mmc_put_card(struct mmc_card *card)
966 mmc_release_host(card->host);
967 pm_runtime_mark_last_busy(&card->dev);
968 pm_runtime_put_autosuspend(&card->dev);
970 EXPORT_SYMBOL(mmc_put_card);
973 * Internal function that does the actual ios call to the host driver,
974 * optionally printing some debug output.
976 static inline void mmc_set_ios(struct mmc_host *host)
978 struct mmc_ios *ios = &host->ios;
980 pr_debug("%s: clock %uHz busmode %u powermode %u cs %u Vdd %u "
981 "width %u timing %u\n",
982 mmc_hostname(host), ios->clock, ios->bus_mode,
983 ios->power_mode, ios->chip_select, ios->vdd,
984 ios->bus_width, ios->timing);
987 mmc_set_ungated(host);
988 host->ops->set_ios(host, ios);
992 * Control chip select pin on a host.
994 void mmc_set_chip_select(struct mmc_host *host, int mode)
996 mmc_host_clk_hold(host);
997 host->ios.chip_select = mode;
999 mmc_host_clk_release(host);
1003 * Sets the host clock to the highest possible frequency that
1006 static void __mmc_set_clock(struct mmc_host *host, unsigned int hz)
1008 WARN_ON(hz < host->f_min);
1010 if (hz > host->f_max)
1013 host->ios.clock = hz;
1017 void mmc_set_clock(struct mmc_host *host, unsigned int hz)
1019 mmc_host_clk_hold(host);
1020 __mmc_set_clock(host, hz);
1021 mmc_host_clk_release(host);
1024 #ifdef CONFIG_MMC_CLKGATE
1026 * This gates the clock by setting it to 0 Hz.
1028 void mmc_gate_clock(struct mmc_host *host)
1030 unsigned long flags;
1032 spin_lock_irqsave(&host->clk_lock, flags);
1033 host->clk_old = host->ios.clock;
1034 host->ios.clock = 0;
1035 host->clk_gated = true;
1036 spin_unlock_irqrestore(&host->clk_lock, flags);
1041 * This restores the clock from gating by using the cached
1044 void mmc_ungate_clock(struct mmc_host *host)
1047 * We should previously have gated the clock, so the clock shall
1048 * be 0 here! The clock may however be 0 during initialization,
1049 * when some request operations are performed before setting
1050 * the frequency. When ungate is requested in that situation
1051 * we just ignore the call.
1053 if (host->clk_old) {
1054 BUG_ON(host->ios.clock);
1055 /* This call will also set host->clk_gated to false */
1056 __mmc_set_clock(host, host->clk_old);
1060 void mmc_set_ungated(struct mmc_host *host)
1062 unsigned long flags;
1065 * We've been given a new frequency while the clock is gated,
1066 * so make sure we regard this as ungating it.
1068 spin_lock_irqsave(&host->clk_lock, flags);
1069 host->clk_gated = false;
1070 spin_unlock_irqrestore(&host->clk_lock, flags);
1074 void mmc_set_ungated(struct mmc_host *host)
1080 * Change the bus mode (open drain/push-pull) of a host.
1082 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode)
1084 mmc_host_clk_hold(host);
1085 host->ios.bus_mode = mode;
1087 mmc_host_clk_release(host);
1091 * Change data bus width of a host.
1093 void mmc_set_bus_width(struct mmc_host *host, unsigned int width)
1095 mmc_host_clk_hold(host);
1096 host->ios.bus_width = width;
1098 mmc_host_clk_release(host);
1102 * mmc_vdd_to_ocrbitnum - Convert a voltage to the OCR bit number
1103 * @vdd: voltage (mV)
1104 * @low_bits: prefer low bits in boundary cases
1106 * This function returns the OCR bit number according to the provided @vdd
1107 * value. If conversion is not possible a negative errno value returned.
1109 * Depending on the @low_bits flag the function prefers low or high OCR bits
1110 * on boundary voltages. For example,
1111 * with @low_bits = true, 3300 mV translates to ilog2(MMC_VDD_32_33);
1112 * with @low_bits = false, 3300 mV translates to ilog2(MMC_VDD_33_34);
1114 * Any value in the [1951:1999] range translates to the ilog2(MMC_VDD_20_21).
1116 static int mmc_vdd_to_ocrbitnum(int vdd, bool low_bits)
1118 const int max_bit = ilog2(MMC_VDD_35_36);
1121 if (vdd < 1650 || vdd > 3600)
1124 if (vdd >= 1650 && vdd <= 1950)
1125 return ilog2(MMC_VDD_165_195);
1130 /* Base 2000 mV, step 100 mV, bit's base 8. */
1131 bit = (vdd - 2000) / 100 + 8;
1138 * mmc_vddrange_to_ocrmask - Convert a voltage range to the OCR mask
1139 * @vdd_min: minimum voltage value (mV)
1140 * @vdd_max: maximum voltage value (mV)
1142 * This function returns the OCR mask bits according to the provided @vdd_min
1143 * and @vdd_max values. If conversion is not possible the function returns 0.
1145 * Notes wrt boundary cases:
1146 * This function sets the OCR bits for all boundary voltages, for example
1147 * [3300:3400] range is translated to MMC_VDD_32_33 | MMC_VDD_33_34 |
1148 * MMC_VDD_34_35 mask.
1150 u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max)
1154 if (vdd_max < vdd_min)
1157 /* Prefer high bits for the boundary vdd_max values. */
1158 vdd_max = mmc_vdd_to_ocrbitnum(vdd_max, false);
1162 /* Prefer low bits for the boundary vdd_min values. */
1163 vdd_min = mmc_vdd_to_ocrbitnum(vdd_min, true);
1167 /* Fill the mask, from max bit to min bit. */
1168 while (vdd_max >= vdd_min)
1169 mask |= 1 << vdd_max--;
1173 EXPORT_SYMBOL(mmc_vddrange_to_ocrmask);
1178 * mmc_of_parse_voltage - return mask of supported voltages
1179 * @np: The device node need to be parsed.
1180 * @mask: mask of voltages available for MMC/SD/SDIO
1182 * 1. Return zero on success.
1183 * 2. Return negative errno: voltage-range is invalid.
1185 int mmc_of_parse_voltage(struct device_node *np, u32 *mask)
1187 const u32 *voltage_ranges;
1190 voltage_ranges = of_get_property(np, "voltage-ranges", &num_ranges);
1191 num_ranges = num_ranges / sizeof(*voltage_ranges) / 2;
1192 if (!voltage_ranges || !num_ranges) {
1193 pr_info("%s: voltage-ranges unspecified\n", np->full_name);
1197 for (i = 0; i < num_ranges; i++) {
1198 const int j = i * 2;
1201 ocr_mask = mmc_vddrange_to_ocrmask(
1202 be32_to_cpu(voltage_ranges[j]),
1203 be32_to_cpu(voltage_ranges[j + 1]));
1205 pr_err("%s: voltage-range #%d is invalid\n",
1214 EXPORT_SYMBOL(mmc_of_parse_voltage);
1216 #endif /* CONFIG_OF */
1218 #ifdef CONFIG_REGULATOR
1221 * mmc_regulator_get_ocrmask - return mask of supported voltages
1222 * @supply: regulator to use
1224 * This returns either a negative errno, or a mask of voltages that
1225 * can be provided to MMC/SD/SDIO devices using the specified voltage
1226 * regulator. This would normally be called before registering the
1229 int mmc_regulator_get_ocrmask(struct regulator *supply)
1235 count = regulator_count_voltages(supply);
1239 for (i = 0; i < count; i++) {
1243 vdd_uV = regulator_list_voltage(supply, i);
1247 vdd_mV = vdd_uV / 1000;
1248 result |= mmc_vddrange_to_ocrmask(vdd_mV, vdd_mV);
1253 EXPORT_SYMBOL_GPL(mmc_regulator_get_ocrmask);
1256 * mmc_regulator_set_ocr - set regulator to match host->ios voltage
1257 * @mmc: the host to regulate
1258 * @supply: regulator to use
1259 * @vdd_bit: zero for power off, else a bit number (host->ios.vdd)
1261 * Returns zero on success, else negative errno.
1263 * MMC host drivers may use this to enable or disable a regulator using
1264 * a particular supply voltage. This would normally be called from the
1267 int mmc_regulator_set_ocr(struct mmc_host *mmc,
1268 struct regulator *supply,
1269 unsigned short vdd_bit)
1279 * REVISIT mmc_vddrange_to_ocrmask() may have set some
1280 * bits this regulator doesn't quite support ... don't
1281 * be too picky, most cards and regulators are OK with
1282 * a 0.1V range goof (it's a small error percentage).
1284 tmp = vdd_bit - ilog2(MMC_VDD_165_195);
1286 min_uV = 1650 * 1000;
1287 max_uV = 1950 * 1000;
1289 min_uV = 1900 * 1000 + tmp * 100 * 1000;
1290 max_uV = min_uV + 100 * 1000;
1294 * If we're using a fixed/static regulator, don't call
1295 * regulator_set_voltage; it would fail.
1297 voltage = regulator_get_voltage(supply);
1299 if (!regulator_can_change_voltage(supply))
1300 min_uV = max_uV = voltage;
1304 else if (voltage < min_uV || voltage > max_uV)
1305 result = regulator_set_voltage(supply, min_uV, max_uV);
1309 if (result == 0 && !mmc->regulator_enabled) {
1310 result = regulator_enable(supply);
1312 mmc->regulator_enabled = true;
1314 } else if (mmc->regulator_enabled) {
1315 result = regulator_disable(supply);
1317 mmc->regulator_enabled = false;
1321 dev_err(mmc_dev(mmc),
1322 "could not set regulator OCR (%d)\n", result);
1325 EXPORT_SYMBOL_GPL(mmc_regulator_set_ocr);
1327 int mmc_regulator_get_supply(struct mmc_host *mmc)
1329 struct device *dev = mmc_dev(mmc);
1330 struct regulator *supply;
1333 supply = devm_regulator_get(dev, "vmmc");
1334 mmc->supply.vmmc = supply;
1335 mmc->supply.vqmmc = devm_regulator_get_optional(dev, "vqmmc");
1338 return PTR_ERR(supply);
1340 ret = mmc_regulator_get_ocrmask(supply);
1342 mmc->ocr_avail = ret;
1344 dev_warn(mmc_dev(mmc), "Failed getting OCR mask: %d\n", ret);
1348 EXPORT_SYMBOL_GPL(mmc_regulator_get_supply);
1350 #endif /* CONFIG_REGULATOR */
1353 * Mask off any voltages we don't support and select
1354 * the lowest voltage
1356 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr)
1360 ocr &= host->ocr_avail;
1368 mmc_host_clk_hold(host);
1369 host->ios.vdd = bit;
1371 mmc_host_clk_release(host);
1373 pr_warning("%s: host doesn't support card's voltages\n",
1374 mmc_hostname(host));
1381 int __mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage)
1384 int old_signal_voltage = host->ios.signal_voltage;
1386 host->ios.signal_voltage = signal_voltage;
1387 if (host->ops->start_signal_voltage_switch) {
1388 mmc_host_clk_hold(host);
1389 err = host->ops->start_signal_voltage_switch(host, &host->ios);
1390 mmc_host_clk_release(host);
1394 host->ios.signal_voltage = old_signal_voltage;
1400 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage, u32 ocr)
1402 struct mmc_command cmd = {0};
1409 * Send CMD11 only if the request is to switch the card to
1412 if (signal_voltage == MMC_SIGNAL_VOLTAGE_330)
1413 return __mmc_set_signal_voltage(host, signal_voltage);
1416 * If we cannot switch voltages, return failure so the caller
1417 * can continue without UHS mode
1419 if (!host->ops->start_signal_voltage_switch)
1421 if (!host->ops->card_busy)
1422 pr_warning("%s: cannot verify signal voltage switch\n",
1423 mmc_hostname(host));
1425 cmd.opcode = SD_SWITCH_VOLTAGE;
1427 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1429 err = mmc_wait_for_cmd(host, &cmd, 0);
1433 if (!mmc_host_is_spi(host) && (cmd.resp[0] & R1_ERROR))
1436 mmc_host_clk_hold(host);
1438 * The card should drive cmd and dat[0:3] low immediately
1439 * after the response of cmd11, but wait 1 ms to be sure
1442 if (host->ops->card_busy && !host->ops->card_busy(host)) {
1447 * During a signal voltage level switch, the clock must be gated
1448 * for 5 ms according to the SD spec
1450 clock = host->ios.clock;
1451 host->ios.clock = 0;
1454 if (__mmc_set_signal_voltage(host, signal_voltage)) {
1456 * Voltages may not have been switched, but we've already
1457 * sent CMD11, so a power cycle is required anyway
1463 /* Keep clock gated for at least 5 ms */
1465 host->ios.clock = clock;
1468 /* Wait for at least 1 ms according to spec */
1472 * Failure to switch is indicated by the card holding
1475 if (host->ops->card_busy && host->ops->card_busy(host))
1480 pr_debug("%s: Signal voltage switch failed, "
1481 "power cycling card\n", mmc_hostname(host));
1482 mmc_power_cycle(host, ocr);
1485 mmc_host_clk_release(host);
1491 * Select timing parameters for host.
1493 void mmc_set_timing(struct mmc_host *host, unsigned int timing)
1495 mmc_host_clk_hold(host);
1496 host->ios.timing = timing;
1498 mmc_host_clk_release(host);
1502 * Select appropriate driver type for host.
1504 void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type)
1506 mmc_host_clk_hold(host);
1507 host->ios.drv_type = drv_type;
1509 mmc_host_clk_release(host);
1513 * Apply power to the MMC stack. This is a two-stage process.
1514 * First, we enable power to the card without the clock running.
1515 * We then wait a bit for the power to stabilise. Finally,
1516 * enable the bus drivers and clock to the card.
1518 * We must _NOT_ enable the clock prior to power stablising.
1520 * If a host does all the power sequencing itself, ignore the
1521 * initial MMC_POWER_UP stage.
1523 void mmc_power_up(struct mmc_host *host, u32 ocr)
1525 if (host->ios.power_mode == MMC_POWER_ON)
1528 mmc_host_clk_hold(host);
1530 host->ios.vdd = fls(ocr) - 1;
1531 if (mmc_host_is_spi(host))
1532 host->ios.chip_select = MMC_CS_HIGH;
1534 host->ios.chip_select = MMC_CS_DONTCARE;
1535 host->ios.bus_mode = MMC_BUSMODE_PUSHPULL;
1536 host->ios.power_mode = MMC_POWER_UP;
1537 host->ios.bus_width = MMC_BUS_WIDTH_1;
1538 host->ios.timing = MMC_TIMING_LEGACY;
1541 /* Set signal voltage to 3.3V */
1542 __mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_330);
1545 * This delay should be sufficient to allow the power supply
1546 * to reach the minimum voltage.
1550 host->ios.clock = host->f_init;
1552 host->ios.power_mode = MMC_POWER_ON;
1556 * This delay must be at least 74 clock sizes, or 1 ms, or the
1557 * time required to reach a stable voltage.
1561 mmc_host_clk_release(host);
1564 void mmc_power_off(struct mmc_host *host)
1566 if (host->ios.power_mode == MMC_POWER_OFF)
1569 mmc_host_clk_hold(host);
1571 host->ios.clock = 0;
1576 * Reset ocr mask to be the highest possible voltage supported for
1577 * this card. This value will be used at next power up.
1580 host->card->ocr = 1 << (fls(host->ocr_avail) - 1);
1582 if (!mmc_host_is_spi(host)) {
1583 host->ios.bus_mode = MMC_BUSMODE_OPENDRAIN;
1584 host->ios.chip_select = MMC_CS_DONTCARE;
1586 host->ios.power_mode = MMC_POWER_OFF;
1587 host->ios.bus_width = MMC_BUS_WIDTH_1;
1588 host->ios.timing = MMC_TIMING_LEGACY;
1592 * Some configurations, such as the 802.11 SDIO card in the OLPC
1593 * XO-1.5, require a short delay after poweroff before the card
1594 * can be successfully turned on again.
1598 mmc_host_clk_release(host);
1601 void mmc_power_cycle(struct mmc_host *host, u32 ocr)
1603 mmc_power_off(host);
1604 /* Wait at least 1 ms according to SD spec */
1606 mmc_power_up(host, ocr);
1610 * Cleanup when the last reference to the bus operator is dropped.
1612 static void __mmc_release_bus(struct mmc_host *host)
1615 BUG_ON(host->bus_refs);
1616 BUG_ON(!host->bus_dead);
1618 host->bus_ops = NULL;
1622 * Increase reference count of bus operator
1624 static inline void mmc_bus_get(struct mmc_host *host)
1626 unsigned long flags;
1628 spin_lock_irqsave(&host->lock, flags);
1630 spin_unlock_irqrestore(&host->lock, flags);
1634 * Decrease reference count of bus operator and free it if
1635 * it is the last reference.
1637 static inline void mmc_bus_put(struct mmc_host *host)
1639 unsigned long flags;
1641 spin_lock_irqsave(&host->lock, flags);
1643 if ((host->bus_refs == 0) && host->bus_ops)
1644 __mmc_release_bus(host);
1645 spin_unlock_irqrestore(&host->lock, flags);
1649 * Assign a mmc bus handler to a host. Only one bus handler may control a
1650 * host at any given time.
1652 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops)
1654 unsigned long flags;
1659 WARN_ON(!host->claimed);
1661 spin_lock_irqsave(&host->lock, flags);
1663 BUG_ON(host->bus_ops);
1664 BUG_ON(host->bus_refs);
1666 host->bus_ops = ops;
1670 spin_unlock_irqrestore(&host->lock, flags);
1674 * Remove the current bus handler from a host.
1676 void mmc_detach_bus(struct mmc_host *host)
1678 unsigned long flags;
1682 WARN_ON(!host->claimed);
1683 WARN_ON(!host->bus_ops);
1685 spin_lock_irqsave(&host->lock, flags);
1689 spin_unlock_irqrestore(&host->lock, flags);
1695 * mmc_detect_change - process change of state on a MMC socket
1696 * @host: host which changed state.
1697 * @delay: optional delay to wait before detection (jiffies)
1699 * MMC drivers should call this when they detect a card has been
1700 * inserted or removed. The MMC layer will confirm that any
1701 * present card is still functional, and initialize any newly
1704 void mmc_detect_change(struct mmc_host *host, unsigned long delay)
1706 #ifdef CONFIG_MMC_DEBUG
1707 unsigned long flags;
1708 spin_lock_irqsave(&host->lock, flags);
1709 WARN_ON(host->removed);
1710 spin_unlock_irqrestore(&host->lock, flags);
1712 host->detect_change = 1;
1713 mmc_schedule_delayed_work(&host->detect, delay);
1716 EXPORT_SYMBOL(mmc_detect_change);
1718 void mmc_init_erase(struct mmc_card *card)
1722 if (is_power_of_2(card->erase_size))
1723 card->erase_shift = ffs(card->erase_size) - 1;
1725 card->erase_shift = 0;
1728 * It is possible to erase an arbitrarily large area of an SD or MMC
1729 * card. That is not desirable because it can take a long time
1730 * (minutes) potentially delaying more important I/O, and also the
1731 * timeout calculations become increasingly hugely over-estimated.
1732 * Consequently, 'pref_erase' is defined as a guide to limit erases
1733 * to that size and alignment.
1735 * For SD cards that define Allocation Unit size, limit erases to one
1736 * Allocation Unit at a time. For MMC cards that define High Capacity
1737 * Erase Size, whether it is switched on or not, limit to that size.
1738 * Otherwise just have a stab at a good value. For modern cards it
1739 * will end up being 4MiB. Note that if the value is too small, it
1740 * can end up taking longer to erase.
1742 if (mmc_card_sd(card) && card->ssr.au) {
1743 card->pref_erase = card->ssr.au;
1744 card->erase_shift = ffs(card->ssr.au) - 1;
1745 } else if (card->ext_csd.hc_erase_size) {
1746 card->pref_erase = card->ext_csd.hc_erase_size;
1748 sz = (card->csd.capacity << (card->csd.read_blkbits - 9)) >> 11;
1750 card->pref_erase = 512 * 1024 / 512;
1752 card->pref_erase = 1024 * 1024 / 512;
1754 card->pref_erase = 2 * 1024 * 1024 / 512;
1756 card->pref_erase = 4 * 1024 * 1024 / 512;
1757 if (card->pref_erase < card->erase_size)
1758 card->pref_erase = card->erase_size;
1760 sz = card->pref_erase % card->erase_size;
1762 card->pref_erase += card->erase_size - sz;
1767 static unsigned int mmc_mmc_erase_timeout(struct mmc_card *card,
1768 unsigned int arg, unsigned int qty)
1770 unsigned int erase_timeout;
1772 if (arg == MMC_DISCARD_ARG ||
1773 (arg == MMC_TRIM_ARG && card->ext_csd.rev >= 6)) {
1774 erase_timeout = card->ext_csd.trim_timeout;
1775 } else if (card->ext_csd.erase_group_def & 1) {
1776 /* High Capacity Erase Group Size uses HC timeouts */
1777 if (arg == MMC_TRIM_ARG)
1778 erase_timeout = card->ext_csd.trim_timeout;
1780 erase_timeout = card->ext_csd.hc_erase_timeout;
1782 /* CSD Erase Group Size uses write timeout */
1783 unsigned int mult = (10 << card->csd.r2w_factor);
1784 unsigned int timeout_clks = card->csd.tacc_clks * mult;
1785 unsigned int timeout_us;
1787 /* Avoid overflow: e.g. tacc_ns=80000000 mult=1280 */
1788 if (card->csd.tacc_ns < 1000000)
1789 timeout_us = (card->csd.tacc_ns * mult) / 1000;
1791 timeout_us = (card->csd.tacc_ns / 1000) * mult;
1794 * ios.clock is only a target. The real clock rate might be
1795 * less but not that much less, so fudge it by multiplying by 2.
1798 timeout_us += (timeout_clks * 1000) /
1799 (mmc_host_clk_rate(card->host) / 1000);
1801 erase_timeout = timeout_us / 1000;
1804 * Theoretically, the calculation could underflow so round up
1805 * to 1ms in that case.
1811 /* Multiplier for secure operations */
1812 if (arg & MMC_SECURE_ARGS) {
1813 if (arg == MMC_SECURE_ERASE_ARG)
1814 erase_timeout *= card->ext_csd.sec_erase_mult;
1816 erase_timeout *= card->ext_csd.sec_trim_mult;
1819 erase_timeout *= qty;
1822 * Ensure at least a 1 second timeout for SPI as per
1823 * 'mmc_set_data_timeout()'
1825 if (mmc_host_is_spi(card->host) && erase_timeout < 1000)
1826 erase_timeout = 1000;
1828 return erase_timeout;
1831 static unsigned int mmc_sd_erase_timeout(struct mmc_card *card,
1835 unsigned int erase_timeout;
1837 if (card->ssr.erase_timeout) {
1838 /* Erase timeout specified in SD Status Register (SSR) */
1839 erase_timeout = card->ssr.erase_timeout * qty +
1840 card->ssr.erase_offset;
1843 * Erase timeout not specified in SD Status Register (SSR) so
1844 * use 250ms per write block.
1846 erase_timeout = 250 * qty;
1849 /* Must not be less than 1 second */
1850 if (erase_timeout < 1000)
1851 erase_timeout = 1000;
1853 return erase_timeout;
1856 static unsigned int mmc_erase_timeout(struct mmc_card *card,
1860 if (mmc_card_sd(card))
1861 return mmc_sd_erase_timeout(card, arg, qty);
1863 return mmc_mmc_erase_timeout(card, arg, qty);
1866 static int mmc_do_erase(struct mmc_card *card, unsigned int from,
1867 unsigned int to, unsigned int arg)
1869 struct mmc_command cmd = {0};
1870 unsigned int qty = 0;
1871 unsigned long timeout;
1875 * qty is used to calculate the erase timeout which depends on how many
1876 * erase groups (or allocation units in SD terminology) are affected.
1877 * We count erasing part of an erase group as one erase group.
1878 * For SD, the allocation units are always a power of 2. For MMC, the
1879 * erase group size is almost certainly also power of 2, but it does not
1880 * seem to insist on that in the JEDEC standard, so we fall back to
1881 * division in that case. SD may not specify an allocation unit size,
1882 * in which case the timeout is based on the number of write blocks.
1884 * Note that the timeout for secure trim 2 will only be correct if the
1885 * number of erase groups specified is the same as the total of all
1886 * preceding secure trim 1 commands. Since the power may have been
1887 * lost since the secure trim 1 commands occurred, it is generally
1888 * impossible to calculate the secure trim 2 timeout correctly.
1890 if (card->erase_shift)
1891 qty += ((to >> card->erase_shift) -
1892 (from >> card->erase_shift)) + 1;
1893 else if (mmc_card_sd(card))
1894 qty += to - from + 1;
1896 qty += ((to / card->erase_size) -
1897 (from / card->erase_size)) + 1;
1899 if (!mmc_card_blockaddr(card)) {
1904 if (mmc_card_sd(card))
1905 cmd.opcode = SD_ERASE_WR_BLK_START;
1907 cmd.opcode = MMC_ERASE_GROUP_START;
1909 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1910 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1912 pr_err("mmc_erase: group start error %d, "
1913 "status %#x\n", err, cmd.resp[0]);
1918 memset(&cmd, 0, sizeof(struct mmc_command));
1919 if (mmc_card_sd(card))
1920 cmd.opcode = SD_ERASE_WR_BLK_END;
1922 cmd.opcode = MMC_ERASE_GROUP_END;
1924 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1925 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1927 pr_err("mmc_erase: group end error %d, status %#x\n",
1933 memset(&cmd, 0, sizeof(struct mmc_command));
1934 cmd.opcode = MMC_ERASE;
1936 cmd.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
1937 cmd.cmd_timeout_ms = mmc_erase_timeout(card, arg, qty);
1938 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1940 pr_err("mmc_erase: erase error %d, status %#x\n",
1946 if (mmc_host_is_spi(card->host))
1949 timeout = jiffies + msecs_to_jiffies(MMC_CORE_TIMEOUT_MS);
1951 memset(&cmd, 0, sizeof(struct mmc_command));
1952 cmd.opcode = MMC_SEND_STATUS;
1953 cmd.arg = card->rca << 16;
1954 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1955 /* Do not retry else we can't see errors */
1956 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1957 if (err || (cmd.resp[0] & 0xFDF92000)) {
1958 pr_err("error %d requesting status %#x\n",
1964 /* Timeout if the device never becomes ready for data and
1965 * never leaves the program state.
1967 if (time_after(jiffies, timeout)) {
1968 pr_err("%s: Card stuck in programming state! %s\n",
1969 mmc_hostname(card->host), __func__);
1974 } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
1975 (R1_CURRENT_STATE(cmd.resp[0]) == R1_STATE_PRG));
1981 * mmc_erase - erase sectors.
1982 * @card: card to erase
1983 * @from: first sector to erase
1984 * @nr: number of sectors to erase
1985 * @arg: erase command argument (SD supports only %MMC_ERASE_ARG)
1987 * Caller must claim host before calling this function.
1989 int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
1992 unsigned int rem, to = from + nr;
1994 if (!(card->host->caps & MMC_CAP_ERASE) ||
1995 !(card->csd.cmdclass & CCC_ERASE))
1998 if (!card->erase_size)
2001 if (mmc_card_sd(card) && arg != MMC_ERASE_ARG)
2004 if ((arg & MMC_SECURE_ARGS) &&
2005 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN))
2008 if ((arg & MMC_TRIM_ARGS) &&
2009 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN))
2012 if (arg == MMC_SECURE_ERASE_ARG) {
2013 if (from % card->erase_size || nr % card->erase_size)
2017 if (arg == MMC_ERASE_ARG) {
2018 rem = from % card->erase_size;
2020 rem = card->erase_size - rem;
2027 rem = nr % card->erase_size;
2040 /* 'from' and 'to' are inclusive */
2043 return mmc_do_erase(card, from, to, arg);
2045 EXPORT_SYMBOL(mmc_erase);
2047 int mmc_can_erase(struct mmc_card *card)
2049 if ((card->host->caps & MMC_CAP_ERASE) &&
2050 (card->csd.cmdclass & CCC_ERASE) && card->erase_size)
2054 EXPORT_SYMBOL(mmc_can_erase);
2056 int mmc_can_trim(struct mmc_card *card)
2058 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN)
2062 EXPORT_SYMBOL(mmc_can_trim);
2064 int mmc_can_discard(struct mmc_card *card)
2067 * As there's no way to detect the discard support bit at v4.5
2068 * use the s/w feature support filed.
2070 if (card->ext_csd.feature_support & MMC_DISCARD_FEATURE)
2074 EXPORT_SYMBOL(mmc_can_discard);
2076 int mmc_can_sanitize(struct mmc_card *card)
2078 if (!mmc_can_trim(card) && !mmc_can_erase(card))
2080 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_SANITIZE)
2084 EXPORT_SYMBOL(mmc_can_sanitize);
2086 int mmc_can_secure_erase_trim(struct mmc_card *card)
2088 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN)
2092 EXPORT_SYMBOL(mmc_can_secure_erase_trim);
2094 int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
2097 if (!card->erase_size)
2099 if (from % card->erase_size || nr % card->erase_size)
2103 EXPORT_SYMBOL(mmc_erase_group_aligned);
2105 static unsigned int mmc_do_calc_max_discard(struct mmc_card *card,
2108 struct mmc_host *host = card->host;
2109 unsigned int max_discard, x, y, qty = 0, max_qty, timeout;
2110 unsigned int last_timeout = 0;
2112 if (card->erase_shift)
2113 max_qty = UINT_MAX >> card->erase_shift;
2114 else if (mmc_card_sd(card))
2117 max_qty = UINT_MAX / card->erase_size;
2119 /* Find the largest qty with an OK timeout */
2122 for (x = 1; x && x <= max_qty && max_qty - x >= qty; x <<= 1) {
2123 timeout = mmc_erase_timeout(card, arg, qty + x);
2124 if (timeout > host->max_discard_to)
2126 if (timeout < last_timeout)
2128 last_timeout = timeout;
2140 /* Convert qty to sectors */
2141 if (card->erase_shift)
2142 max_discard = --qty << card->erase_shift;
2143 else if (mmc_card_sd(card))
2146 max_discard = --qty * card->erase_size;
2151 unsigned int mmc_calc_max_discard(struct mmc_card *card)
2153 struct mmc_host *host = card->host;
2154 unsigned int max_discard, max_trim;
2156 if (!host->max_discard_to)
2160 * Without erase_group_def set, MMC erase timeout depends on clock
2161 * frequence which can change. In that case, the best choice is
2162 * just the preferred erase size.
2164 if (mmc_card_mmc(card) && !(card->ext_csd.erase_group_def & 1))
2165 return card->pref_erase;
2167 max_discard = mmc_do_calc_max_discard(card, MMC_ERASE_ARG);
2168 if (mmc_can_trim(card)) {
2169 max_trim = mmc_do_calc_max_discard(card, MMC_TRIM_ARG);
2170 if (max_trim < max_discard)
2171 max_discard = max_trim;
2172 } else if (max_discard < card->erase_size) {
2175 pr_debug("%s: calculated max. discard sectors %u for timeout %u ms\n",
2176 mmc_hostname(host), max_discard, host->max_discard_to);
2179 EXPORT_SYMBOL(mmc_calc_max_discard);
2181 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen)
2183 struct mmc_command cmd = {0};
2185 if (mmc_card_blockaddr(card) || mmc_card_ddr_mode(card))
2188 cmd.opcode = MMC_SET_BLOCKLEN;
2190 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2191 return mmc_wait_for_cmd(card->host, &cmd, 5);
2193 EXPORT_SYMBOL(mmc_set_blocklen);
2195 int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount,
2198 struct mmc_command cmd = {0};
2200 cmd.opcode = MMC_SET_BLOCK_COUNT;
2201 cmd.arg = blockcount & 0x0000FFFF;
2204 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2205 return mmc_wait_for_cmd(card->host, &cmd, 5);
2207 EXPORT_SYMBOL(mmc_set_blockcount);
2209 static void mmc_hw_reset_for_init(struct mmc_host *host)
2211 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->hw_reset)
2213 mmc_host_clk_hold(host);
2214 host->ops->hw_reset(host);
2215 mmc_host_clk_release(host);
2218 int mmc_can_reset(struct mmc_card *card)
2222 if (!mmc_card_mmc(card))
2224 rst_n_function = card->ext_csd.rst_n_function;
2225 if ((rst_n_function & EXT_CSD_RST_N_EN_MASK) != EXT_CSD_RST_N_ENABLED)
2229 EXPORT_SYMBOL(mmc_can_reset);
2231 static int mmc_do_hw_reset(struct mmc_host *host, int check)
2233 struct mmc_card *card = host->card;
2235 if (!host->bus_ops->power_restore)
2238 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->hw_reset)
2244 if (!mmc_can_reset(card))
2247 mmc_host_clk_hold(host);
2248 mmc_set_clock(host, host->f_init);
2250 host->ops->hw_reset(host);
2252 /* If the reset has happened, then a status command will fail */
2254 struct mmc_command cmd = {0};
2257 cmd.opcode = MMC_SEND_STATUS;
2258 if (!mmc_host_is_spi(card->host))
2259 cmd.arg = card->rca << 16;
2260 cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
2261 err = mmc_wait_for_cmd(card->host, &cmd, 0);
2263 mmc_host_clk_release(host);
2268 host->card->state &= ~(MMC_STATE_HIGHSPEED | MMC_STATE_HIGHSPEED_DDR);
2269 if (mmc_host_is_spi(host)) {
2270 host->ios.chip_select = MMC_CS_HIGH;
2271 host->ios.bus_mode = MMC_BUSMODE_PUSHPULL;
2273 host->ios.chip_select = MMC_CS_DONTCARE;
2274 host->ios.bus_mode = MMC_BUSMODE_OPENDRAIN;
2276 host->ios.bus_width = MMC_BUS_WIDTH_1;
2277 host->ios.timing = MMC_TIMING_LEGACY;
2280 mmc_host_clk_release(host);
2282 return host->bus_ops->power_restore(host);
2285 int mmc_hw_reset(struct mmc_host *host)
2287 return mmc_do_hw_reset(host, 0);
2289 EXPORT_SYMBOL(mmc_hw_reset);
2291 int mmc_hw_reset_check(struct mmc_host *host)
2293 return mmc_do_hw_reset(host, 1);
2295 EXPORT_SYMBOL(mmc_hw_reset_check);
2297 static int mmc_rescan_try_freq(struct mmc_host *host, unsigned freq)
2299 host->f_init = freq;
2301 #ifdef CONFIG_MMC_DEBUG
2302 pr_info("%s: %s: trying to init card at %u Hz\n",
2303 mmc_hostname(host), __func__, host->f_init);
2305 mmc_power_up(host, host->ocr_avail);
2308 * Some eMMCs (with VCCQ always on) may not be reset after power up, so
2309 * do a hardware reset if possible.
2311 mmc_hw_reset_for_init(host);
2314 * sdio_reset sends CMD52 to reset card. Since we do not know
2315 * if the card is being re-initialized, just send it. CMD52
2316 * should be ignored by SD/eMMC cards.
2321 mmc_send_if_cond(host, host->ocr_avail);
2323 /* Order's important: probe SDIO, then SD, then MMC */
2324 if (!mmc_attach_sdio(host))
2326 if (!mmc_attach_sd(host))
2328 if (!mmc_attach_mmc(host))
2331 mmc_power_off(host);
2335 int _mmc_detect_card_removed(struct mmc_host *host)
2339 if ((host->caps & MMC_CAP_NONREMOVABLE) || !host->bus_ops->alive)
2342 if (!host->card || mmc_card_removed(host->card))
2345 ret = host->bus_ops->alive(host);
2348 * Card detect status and alive check may be out of sync if card is
2349 * removed slowly, when card detect switch changes while card/slot
2350 * pads are still contacted in hardware (refer to "SD Card Mechanical
2351 * Addendum, Appendix C: Card Detection Switch"). So reschedule a
2352 * detect work 200ms later for this case.
2354 if (!ret && host->ops->get_cd && !host->ops->get_cd(host)) {
2355 mmc_detect_change(host, msecs_to_jiffies(200));
2356 pr_debug("%s: card removed too slowly\n", mmc_hostname(host));
2360 mmc_card_set_removed(host->card);
2361 pr_debug("%s: card remove detected\n", mmc_hostname(host));
2367 int mmc_detect_card_removed(struct mmc_host *host)
2369 struct mmc_card *card = host->card;
2372 WARN_ON(!host->claimed);
2377 ret = mmc_card_removed(card);
2379 * The card will be considered unchanged unless we have been asked to
2380 * detect a change or host requires polling to provide card detection.
2382 if (!host->detect_change && !(host->caps & MMC_CAP_NEEDS_POLL))
2385 host->detect_change = 0;
2387 ret = _mmc_detect_card_removed(host);
2388 if (ret && (host->caps & MMC_CAP_NEEDS_POLL)) {
2390 * Schedule a detect work as soon as possible to let a
2391 * rescan handle the card removal.
2393 cancel_delayed_work(&host->detect);
2394 mmc_detect_change(host, 0);
2400 EXPORT_SYMBOL(mmc_detect_card_removed);
2402 void mmc_rescan(struct work_struct *work)
2404 struct mmc_host *host =
2405 container_of(work, struct mmc_host, detect.work);
2408 if (host->rescan_disable)
2411 /* If there is a non-removable card registered, only scan once */
2412 if ((host->caps & MMC_CAP_NONREMOVABLE) && host->rescan_entered)
2414 host->rescan_entered = 1;
2419 * if there is a _removable_ card registered, check whether it is
2422 if (host->bus_ops && host->bus_ops->detect && !host->bus_dead
2423 && !(host->caps & MMC_CAP_NONREMOVABLE))
2424 host->bus_ops->detect(host);
2426 host->detect_change = 0;
2429 * Let mmc_bus_put() free the bus/bus_ops if we've found that
2430 * the card is no longer present.
2435 /* if there still is a card present, stop here */
2436 if (host->bus_ops != NULL) {
2442 * Only we can add a new handler, so it's safe to
2443 * release the lock here.
2447 if (host->ops->get_cd && host->ops->get_cd(host) == 0) {
2448 mmc_claim_host(host);
2449 mmc_power_off(host);
2450 mmc_release_host(host);
2454 mmc_claim_host(host);
2455 for (i = 0; i < ARRAY_SIZE(freqs); i++) {
2456 if (!mmc_rescan_try_freq(host, max(freqs[i], host->f_min)))
2458 if (freqs[i] <= host->f_min)
2461 mmc_release_host(host);
2464 if (host->caps & MMC_CAP_NEEDS_POLL)
2465 mmc_schedule_delayed_work(&host->detect, HZ);
2468 void mmc_start_host(struct mmc_host *host)
2470 host->f_init = max(freqs[0], host->f_min);
2471 host->rescan_disable = 0;
2472 if (host->caps2 & MMC_CAP2_NO_PRESCAN_POWERUP)
2473 mmc_power_off(host);
2475 mmc_power_up(host, host->ocr_avail);
2476 mmc_detect_change(host, 0);
2479 void mmc_stop_host(struct mmc_host *host)
2481 #ifdef CONFIG_MMC_DEBUG
2482 unsigned long flags;
2483 spin_lock_irqsave(&host->lock, flags);
2485 spin_unlock_irqrestore(&host->lock, flags);
2488 host->rescan_disable = 1;
2489 cancel_delayed_work_sync(&host->detect);
2490 mmc_flush_scheduled_work();
2492 /* clear pm flags now and let card drivers set them as needed */
2496 if (host->bus_ops && !host->bus_dead) {
2497 /* Calling bus_ops->remove() with a claimed host can deadlock */
2498 host->bus_ops->remove(host);
2499 mmc_claim_host(host);
2500 mmc_detach_bus(host);
2501 mmc_power_off(host);
2502 mmc_release_host(host);
2510 mmc_power_off(host);
2513 int mmc_power_save_host(struct mmc_host *host)
2517 #ifdef CONFIG_MMC_DEBUG
2518 pr_info("%s: %s: powering down\n", mmc_hostname(host), __func__);
2523 if (!host->bus_ops || host->bus_dead || !host->bus_ops->power_restore) {
2528 if (host->bus_ops->power_save)
2529 ret = host->bus_ops->power_save(host);
2533 mmc_power_off(host);
2537 EXPORT_SYMBOL(mmc_power_save_host);
2539 int mmc_power_restore_host(struct mmc_host *host)
2543 #ifdef CONFIG_MMC_DEBUG
2544 pr_info("%s: %s: powering up\n", mmc_hostname(host), __func__);
2549 if (!host->bus_ops || host->bus_dead || !host->bus_ops->power_restore) {
2554 mmc_power_up(host, host->card->ocr);
2555 ret = host->bus_ops->power_restore(host);
2561 EXPORT_SYMBOL(mmc_power_restore_host);
2564 * Flush the cache to the non-volatile storage.
2566 int mmc_flush_cache(struct mmc_card *card)
2568 struct mmc_host *host = card->host;
2571 if (!(host->caps2 & MMC_CAP2_CACHE_CTRL))
2574 if (mmc_card_mmc(card) &&
2575 (card->ext_csd.cache_size > 0) &&
2576 (card->ext_csd.cache_ctrl & 1)) {
2577 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
2578 EXT_CSD_FLUSH_CACHE, 1, 0);
2580 pr_err("%s: cache flush error %d\n",
2581 mmc_hostname(card->host), err);
2586 EXPORT_SYMBOL(mmc_flush_cache);
2589 * Turn the cache ON/OFF.
2590 * Turning the cache OFF shall trigger flushing of the data
2591 * to the non-volatile storage.
2592 * This function should be called with host claimed
2594 int mmc_cache_ctrl(struct mmc_host *host, u8 enable)
2596 struct mmc_card *card = host->card;
2597 unsigned int timeout;
2600 if (!(host->caps2 & MMC_CAP2_CACHE_CTRL) ||
2601 mmc_card_is_removable(host))
2604 if (card && mmc_card_mmc(card) &&
2605 (card->ext_csd.cache_size > 0)) {
2608 if (card->ext_csd.cache_ctrl ^ enable) {
2609 timeout = enable ? card->ext_csd.generic_cmd6_time : 0;
2610 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
2611 EXT_CSD_CACHE_CTRL, enable, timeout);
2613 pr_err("%s: cache %s error %d\n",
2614 mmc_hostname(card->host),
2615 enable ? "on" : "off",
2618 card->ext_csd.cache_ctrl = enable;
2624 EXPORT_SYMBOL(mmc_cache_ctrl);
2629 * mmc_suspend_host - suspend a host
2632 int mmc_suspend_host(struct mmc_host *host)
2634 /* This function is deprecated */
2637 EXPORT_SYMBOL(mmc_suspend_host);
2640 * mmc_resume_host - resume a previously suspended host
2643 int mmc_resume_host(struct mmc_host *host)
2645 /* This function is deprecated */
2648 EXPORT_SYMBOL(mmc_resume_host);
2650 /* Do the card removal on suspend if card is assumed removeable
2651 * Do that in pm notifier while userspace isn't yet frozen, so we will be able
2654 int mmc_pm_notify(struct notifier_block *notify_block,
2655 unsigned long mode, void *unused)
2657 struct mmc_host *host = container_of(
2658 notify_block, struct mmc_host, pm_notify);
2659 unsigned long flags;
2663 case PM_HIBERNATION_PREPARE:
2664 case PM_SUSPEND_PREPARE:
2665 spin_lock_irqsave(&host->lock, flags);
2666 host->rescan_disable = 1;
2667 spin_unlock_irqrestore(&host->lock, flags);
2668 cancel_delayed_work_sync(&host->detect);
2673 /* Validate prerequisites for suspend */
2674 if (host->bus_ops->pre_suspend)
2675 err = host->bus_ops->pre_suspend(host);
2676 if (!err && host->bus_ops->suspend)
2679 /* Calling bus_ops->remove() with a claimed host can deadlock */
2680 host->bus_ops->remove(host);
2681 mmc_claim_host(host);
2682 mmc_detach_bus(host);
2683 mmc_power_off(host);
2684 mmc_release_host(host);
2688 case PM_POST_SUSPEND:
2689 case PM_POST_HIBERNATION:
2690 case PM_POST_RESTORE:
2692 spin_lock_irqsave(&host->lock, flags);
2693 host->rescan_disable = 0;
2694 spin_unlock_irqrestore(&host->lock, flags);
2695 mmc_detect_change(host, 0);
2704 * mmc_init_context_info() - init synchronization context
2707 * Init struct context_info needed to implement asynchronous
2708 * request mechanism, used by mmc core, host driver and mmc requests
2711 void mmc_init_context_info(struct mmc_host *host)
2713 spin_lock_init(&host->context_info.lock);
2714 host->context_info.is_new_req = false;
2715 host->context_info.is_done_rcv = false;
2716 host->context_info.is_waiting_last_req = false;
2717 init_waitqueue_head(&host->context_info.wait);
2720 static int __init mmc_init(void)
2724 workqueue = alloc_ordered_workqueue("kmmcd", 0);
2728 ret = mmc_register_bus();
2730 goto destroy_workqueue;
2732 ret = mmc_register_host_class();
2734 goto unregister_bus;
2736 ret = sdio_register_bus();
2738 goto unregister_host_class;
2742 unregister_host_class:
2743 mmc_unregister_host_class();
2745 mmc_unregister_bus();
2747 destroy_workqueue(workqueue);
2752 static void __exit mmc_exit(void)
2754 sdio_unregister_bus();
2755 mmc_unregister_host_class();
2756 mmc_unregister_bus();
2757 destroy_workqueue(workqueue);
2760 subsys_initcall(mmc_init);
2761 module_exit(mmc_exit);
2763 MODULE_LICENSE("GPL");