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)
735 * In future work, we should consider storing the entire ext_csd.
737 ext_csd = kmalloc(512, GFP_KERNEL);
739 pr_err("%s: could not allocate buffer to receive the ext_csd.\n",
740 mmc_hostname(card->host));
744 mmc_claim_host(card->host);
745 err = mmc_send_ext_csd(card, ext_csd);
746 mmc_release_host(card->host);
750 card->ext_csd.raw_bkops_status = ext_csd[EXT_CSD_BKOPS_STATUS];
751 card->ext_csd.raw_exception_status = ext_csd[EXT_CSD_EXP_EVENTS_STATUS];
756 EXPORT_SYMBOL(mmc_read_bkops_status);
759 * mmc_set_data_timeout - set the timeout for a data command
760 * @data: data phase for command
761 * @card: the MMC card associated with the data transfer
763 * Computes the data timeout parameters according to the
764 * correct algorithm given the card type.
766 void mmc_set_data_timeout(struct mmc_data *data, const struct mmc_card *card)
771 * SDIO cards only define an upper 1 s limit on access.
773 if (mmc_card_sdio(card)) {
774 data->timeout_ns = 1000000000;
775 data->timeout_clks = 0;
780 * SD cards use a 100 multiplier rather than 10
782 mult = mmc_card_sd(card) ? 100 : 10;
785 * Scale up the multiplier (and therefore the timeout) by
786 * the r2w factor for writes.
788 if (data->flags & MMC_DATA_WRITE)
789 mult <<= card->csd.r2w_factor;
791 data->timeout_ns = card->csd.tacc_ns * mult;
792 data->timeout_clks = card->csd.tacc_clks * mult;
795 * SD cards also have an upper limit on the timeout.
797 if (mmc_card_sd(card)) {
798 unsigned int timeout_us, limit_us;
800 timeout_us = data->timeout_ns / 1000;
801 if (mmc_host_clk_rate(card->host))
802 timeout_us += data->timeout_clks * 1000 /
803 (mmc_host_clk_rate(card->host) / 1000);
805 if (data->flags & MMC_DATA_WRITE)
807 * The MMC spec "It is strongly recommended
808 * for hosts to implement more than 500ms
809 * timeout value even if the card indicates
810 * the 250ms maximum busy length." Even the
811 * previous value of 300ms is known to be
812 * insufficient for some cards.
819 * SDHC cards always use these fixed values.
821 if (timeout_us > limit_us || mmc_card_blockaddr(card)) {
822 data->timeout_ns = limit_us * 1000;
823 data->timeout_clks = 0;
826 /* assign limit value if invalid */
828 data->timeout_ns = limit_us * 1000;
832 * Some cards require longer data read timeout than indicated in CSD.
833 * Address this by setting the read timeout to a "reasonably high"
834 * value. For the cards tested, 300ms has proven enough. If necessary,
835 * this value can be increased if other problematic cards require this.
837 if (mmc_card_long_read_time(card) && data->flags & MMC_DATA_READ) {
838 data->timeout_ns = 300000000;
839 data->timeout_clks = 0;
843 * Some cards need very high timeouts if driven in SPI mode.
844 * The worst observed timeout was 900ms after writing a
845 * continuous stream of data until the internal logic
848 if (mmc_host_is_spi(card->host)) {
849 if (data->flags & MMC_DATA_WRITE) {
850 if (data->timeout_ns < 1000000000)
851 data->timeout_ns = 1000000000; /* 1s */
853 if (data->timeout_ns < 100000000)
854 data->timeout_ns = 100000000; /* 100ms */
858 EXPORT_SYMBOL(mmc_set_data_timeout);
861 * mmc_align_data_size - pads a transfer size to a more optimal value
862 * @card: the MMC card associated with the data transfer
863 * @sz: original transfer size
865 * Pads the original data size with a number of extra bytes in
866 * order to avoid controller bugs and/or performance hits
867 * (e.g. some controllers revert to PIO for certain sizes).
869 * Returns the improved size, which might be unmodified.
871 * Note that this function is only relevant when issuing a
872 * single scatter gather entry.
874 unsigned int mmc_align_data_size(struct mmc_card *card, unsigned int sz)
877 * FIXME: We don't have a system for the controller to tell
878 * the core about its problems yet, so for now we just 32-bit
881 sz = ((sz + 3) / 4) * 4;
885 EXPORT_SYMBOL(mmc_align_data_size);
888 * __mmc_claim_host - exclusively claim a host
889 * @host: mmc host to claim
890 * @abort: whether or not the operation should be aborted
892 * Claim a host for a set of operations. If @abort is non null and
893 * dereference a non-zero value then this will return prematurely with
894 * that non-zero value without acquiring the lock. Returns zero
895 * with the lock held otherwise.
897 int __mmc_claim_host(struct mmc_host *host, atomic_t *abort)
899 DECLARE_WAITQUEUE(wait, current);
905 add_wait_queue(&host->wq, &wait);
906 spin_lock_irqsave(&host->lock, flags);
908 set_current_state(TASK_UNINTERRUPTIBLE);
909 stop = abort ? atomic_read(abort) : 0;
910 if (stop || !host->claimed || host->claimer == current)
912 spin_unlock_irqrestore(&host->lock, flags);
914 spin_lock_irqsave(&host->lock, flags);
916 set_current_state(TASK_RUNNING);
919 host->claimer = current;
920 host->claim_cnt += 1;
923 spin_unlock_irqrestore(&host->lock, flags);
924 remove_wait_queue(&host->wq, &wait);
925 if (host->ops->enable && !stop && host->claim_cnt == 1)
926 host->ops->enable(host);
930 EXPORT_SYMBOL(__mmc_claim_host);
933 * mmc_release_host - release a host
934 * @host: mmc host to release
936 * Release a MMC host, allowing others to claim the host
937 * for their operations.
939 void mmc_release_host(struct mmc_host *host)
943 WARN_ON(!host->claimed);
945 if (host->ops->disable && host->claim_cnt == 1)
946 host->ops->disable(host);
948 spin_lock_irqsave(&host->lock, flags);
949 if (--host->claim_cnt) {
950 /* Release for nested claim */
951 spin_unlock_irqrestore(&host->lock, flags);
954 host->claimer = NULL;
955 spin_unlock_irqrestore(&host->lock, flags);
959 EXPORT_SYMBOL(mmc_release_host);
962 * This is a helper function, which fetches a runtime pm reference for the
963 * card device and also claims the host.
965 void mmc_get_card(struct mmc_card *card)
967 pm_runtime_get_sync(&card->dev);
968 mmc_claim_host(card->host);
970 EXPORT_SYMBOL(mmc_get_card);
973 * This is a helper function, which releases the host and drops the runtime
974 * pm reference for the card device.
976 void mmc_put_card(struct mmc_card *card)
978 mmc_release_host(card->host);
979 pm_runtime_mark_last_busy(&card->dev);
980 pm_runtime_put_autosuspend(&card->dev);
982 EXPORT_SYMBOL(mmc_put_card);
985 * Internal function that does the actual ios call to the host driver,
986 * optionally printing some debug output.
988 static inline void mmc_set_ios(struct mmc_host *host)
990 struct mmc_ios *ios = &host->ios;
992 pr_debug("%s: clock %uHz busmode %u powermode %u cs %u Vdd %u "
993 "width %u timing %u\n",
994 mmc_hostname(host), ios->clock, ios->bus_mode,
995 ios->power_mode, ios->chip_select, ios->vdd,
996 ios->bus_width, ios->timing);
999 mmc_set_ungated(host);
1000 host->ops->set_ios(host, ios);
1004 * Control chip select pin on a host.
1006 void mmc_set_chip_select(struct mmc_host *host, int mode)
1008 mmc_host_clk_hold(host);
1009 host->ios.chip_select = mode;
1011 mmc_host_clk_release(host);
1015 * Sets the host clock to the highest possible frequency that
1018 static void __mmc_set_clock(struct mmc_host *host, unsigned int hz)
1020 WARN_ON(hz && hz < host->f_min);
1022 if (hz > host->f_max)
1025 host->ios.clock = hz;
1029 void mmc_set_clock(struct mmc_host *host, unsigned int hz)
1031 mmc_host_clk_hold(host);
1032 __mmc_set_clock(host, hz);
1033 mmc_host_clk_release(host);
1036 #ifdef CONFIG_MMC_CLKGATE
1038 * This gates the clock by setting it to 0 Hz.
1040 void mmc_gate_clock(struct mmc_host *host)
1042 unsigned long flags;
1044 spin_lock_irqsave(&host->clk_lock, flags);
1045 host->clk_old = host->ios.clock;
1046 host->ios.clock = 0;
1047 host->clk_gated = true;
1048 spin_unlock_irqrestore(&host->clk_lock, flags);
1053 * This restores the clock from gating by using the cached
1056 void mmc_ungate_clock(struct mmc_host *host)
1059 * We should previously have gated the clock, so the clock shall
1060 * be 0 here! The clock may however be 0 during initialization,
1061 * when some request operations are performed before setting
1062 * the frequency. When ungate is requested in that situation
1063 * we just ignore the call.
1065 if (host->clk_old) {
1066 BUG_ON(host->ios.clock);
1067 /* This call will also set host->clk_gated to false */
1068 __mmc_set_clock(host, host->clk_old);
1072 void mmc_set_ungated(struct mmc_host *host)
1074 unsigned long flags;
1077 * We've been given a new frequency while the clock is gated,
1078 * so make sure we regard this as ungating it.
1080 spin_lock_irqsave(&host->clk_lock, flags);
1081 host->clk_gated = false;
1082 spin_unlock_irqrestore(&host->clk_lock, flags);
1086 void mmc_set_ungated(struct mmc_host *host)
1092 * Change the bus mode (open drain/push-pull) of a host.
1094 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode)
1096 mmc_host_clk_hold(host);
1097 host->ios.bus_mode = mode;
1099 mmc_host_clk_release(host);
1103 * Change data bus width of a host.
1105 void mmc_set_bus_width(struct mmc_host *host, unsigned int width)
1107 mmc_host_clk_hold(host);
1108 host->ios.bus_width = width;
1110 mmc_host_clk_release(host);
1114 * mmc_vdd_to_ocrbitnum - Convert a voltage to the OCR bit number
1115 * @vdd: voltage (mV)
1116 * @low_bits: prefer low bits in boundary cases
1118 * This function returns the OCR bit number according to the provided @vdd
1119 * value. If conversion is not possible a negative errno value returned.
1121 * Depending on the @low_bits flag the function prefers low or high OCR bits
1122 * on boundary voltages. For example,
1123 * with @low_bits = true, 3300 mV translates to ilog2(MMC_VDD_32_33);
1124 * with @low_bits = false, 3300 mV translates to ilog2(MMC_VDD_33_34);
1126 * Any value in the [1951:1999] range translates to the ilog2(MMC_VDD_20_21).
1128 static int mmc_vdd_to_ocrbitnum(int vdd, bool low_bits)
1130 const int max_bit = ilog2(MMC_VDD_35_36);
1133 if (vdd < 1650 || vdd > 3600)
1136 if (vdd >= 1650 && vdd <= 1950)
1137 return ilog2(MMC_VDD_165_195);
1142 /* Base 2000 mV, step 100 mV, bit's base 8. */
1143 bit = (vdd - 2000) / 100 + 8;
1150 * mmc_vddrange_to_ocrmask - Convert a voltage range to the OCR mask
1151 * @vdd_min: minimum voltage value (mV)
1152 * @vdd_max: maximum voltage value (mV)
1154 * This function returns the OCR mask bits according to the provided @vdd_min
1155 * and @vdd_max values. If conversion is not possible the function returns 0.
1157 * Notes wrt boundary cases:
1158 * This function sets the OCR bits for all boundary voltages, for example
1159 * [3300:3400] range is translated to MMC_VDD_32_33 | MMC_VDD_33_34 |
1160 * MMC_VDD_34_35 mask.
1162 u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max)
1166 if (vdd_max < vdd_min)
1169 /* Prefer high bits for the boundary vdd_max values. */
1170 vdd_max = mmc_vdd_to_ocrbitnum(vdd_max, false);
1174 /* Prefer low bits for the boundary vdd_min values. */
1175 vdd_min = mmc_vdd_to_ocrbitnum(vdd_min, true);
1179 /* Fill the mask, from max bit to min bit. */
1180 while (vdd_max >= vdd_min)
1181 mask |= 1 << vdd_max--;
1185 EXPORT_SYMBOL(mmc_vddrange_to_ocrmask);
1190 * mmc_of_parse_voltage - return mask of supported voltages
1191 * @np: The device node need to be parsed.
1192 * @mask: mask of voltages available for MMC/SD/SDIO
1194 * 1. Return zero on success.
1195 * 2. Return negative errno: voltage-range is invalid.
1197 int mmc_of_parse_voltage(struct device_node *np, u32 *mask)
1199 const u32 *voltage_ranges;
1202 voltage_ranges = of_get_property(np, "voltage-ranges", &num_ranges);
1203 num_ranges = num_ranges / sizeof(*voltage_ranges) / 2;
1204 if (!voltage_ranges || !num_ranges) {
1205 pr_info("%s: voltage-ranges unspecified\n", np->full_name);
1209 for (i = 0; i < num_ranges; i++) {
1210 const int j = i * 2;
1213 ocr_mask = mmc_vddrange_to_ocrmask(
1214 be32_to_cpu(voltage_ranges[j]),
1215 be32_to_cpu(voltage_ranges[j + 1]));
1217 pr_err("%s: voltage-range #%d is invalid\n",
1226 EXPORT_SYMBOL(mmc_of_parse_voltage);
1228 #endif /* CONFIG_OF */
1230 #ifdef CONFIG_REGULATOR
1233 * mmc_regulator_get_ocrmask - return mask of supported voltages
1234 * @supply: regulator to use
1236 * This returns either a negative errno, or a mask of voltages that
1237 * can be provided to MMC/SD/SDIO devices using the specified voltage
1238 * regulator. This would normally be called before registering the
1241 int mmc_regulator_get_ocrmask(struct regulator *supply)
1249 count = regulator_count_voltages(supply);
1253 for (i = 0; i < count; i++) {
1254 vdd_uV = regulator_list_voltage(supply, i);
1258 vdd_mV = vdd_uV / 1000;
1259 result |= mmc_vddrange_to_ocrmask(vdd_mV, vdd_mV);
1263 vdd_uV = regulator_get_voltage(supply);
1267 vdd_mV = vdd_uV / 1000;
1268 result = mmc_vddrange_to_ocrmask(vdd_mV, vdd_mV);
1273 EXPORT_SYMBOL_GPL(mmc_regulator_get_ocrmask);
1276 * mmc_regulator_set_ocr - set regulator to match host->ios voltage
1277 * @mmc: the host to regulate
1278 * @supply: regulator to use
1279 * @vdd_bit: zero for power off, else a bit number (host->ios.vdd)
1281 * Returns zero on success, else negative errno.
1283 * MMC host drivers may use this to enable or disable a regulator using
1284 * a particular supply voltage. This would normally be called from the
1287 int mmc_regulator_set_ocr(struct mmc_host *mmc,
1288 struct regulator *supply,
1289 unsigned short vdd_bit)
1298 * REVISIT mmc_vddrange_to_ocrmask() may have set some
1299 * bits this regulator doesn't quite support ... don't
1300 * be too picky, most cards and regulators are OK with
1301 * a 0.1V range goof (it's a small error percentage).
1303 tmp = vdd_bit - ilog2(MMC_VDD_165_195);
1305 min_uV = 1650 * 1000;
1306 max_uV = 1950 * 1000;
1308 min_uV = 1900 * 1000 + tmp * 100 * 1000;
1309 max_uV = min_uV + 100 * 1000;
1312 result = regulator_set_voltage(supply, min_uV, max_uV);
1313 if (result == 0 && !mmc->regulator_enabled) {
1314 result = regulator_enable(supply);
1316 mmc->regulator_enabled = true;
1318 } else if (mmc->regulator_enabled) {
1319 result = regulator_disable(supply);
1321 mmc->regulator_enabled = false;
1325 dev_err(mmc_dev(mmc),
1326 "could not set regulator OCR (%d)\n", result);
1329 EXPORT_SYMBOL_GPL(mmc_regulator_set_ocr);
1331 #endif /* CONFIG_REGULATOR */
1333 int mmc_regulator_get_supply(struct mmc_host *mmc)
1335 struct device *dev = mmc_dev(mmc);
1338 mmc->supply.vmmc = devm_regulator_get_optional(dev, "vmmc");
1339 mmc->supply.vqmmc = devm_regulator_get_optional(dev, "vqmmc");
1341 if (IS_ERR(mmc->supply.vmmc)) {
1342 if (PTR_ERR(mmc->supply.vmmc) == -EPROBE_DEFER)
1343 return -EPROBE_DEFER;
1344 dev_info(dev, "No vmmc regulator found\n");
1346 ret = mmc_regulator_get_ocrmask(mmc->supply.vmmc);
1348 mmc->ocr_avail = ret;
1350 dev_warn(dev, "Failed getting OCR mask: %d\n", ret);
1353 if (IS_ERR(mmc->supply.vqmmc)) {
1354 if (PTR_ERR(mmc->supply.vqmmc) == -EPROBE_DEFER)
1355 return -EPROBE_DEFER;
1356 dev_info(dev, "No vqmmc regulator found\n");
1361 EXPORT_SYMBOL_GPL(mmc_regulator_get_supply);
1364 * Mask off any voltages we don't support and select
1365 * the lowest voltage
1367 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr)
1372 * Sanity check the voltages that the card claims to
1376 dev_warn(mmc_dev(host),
1377 "card claims to support voltages below defined range\n");
1381 ocr &= host->ocr_avail;
1383 dev_warn(mmc_dev(host), "no support for card's volts\n");
1387 if (host->caps2 & MMC_CAP2_FULL_PWR_CYCLE) {
1390 mmc_power_cycle(host, ocr);
1394 if (bit != host->ios.vdd)
1395 dev_warn(mmc_dev(host), "exceeding card's volts\n");
1401 int __mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage)
1404 int old_signal_voltage = host->ios.signal_voltage;
1406 host->ios.signal_voltage = signal_voltage;
1407 if (host->ops->start_signal_voltage_switch) {
1408 mmc_host_clk_hold(host);
1409 err = host->ops->start_signal_voltage_switch(host, &host->ios);
1410 mmc_host_clk_release(host);
1414 host->ios.signal_voltage = old_signal_voltage;
1420 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage, u32 ocr)
1422 struct mmc_command cmd = {0};
1429 * Send CMD11 only if the request is to switch the card to
1432 if (signal_voltage == MMC_SIGNAL_VOLTAGE_330)
1433 return __mmc_set_signal_voltage(host, signal_voltage);
1436 * If we cannot switch voltages, return failure so the caller
1437 * can continue without UHS mode
1439 if (!host->ops->start_signal_voltage_switch)
1441 if (!host->ops->card_busy)
1442 pr_warn("%s: cannot verify signal voltage switch\n",
1443 mmc_hostname(host));
1445 cmd.opcode = SD_SWITCH_VOLTAGE;
1447 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1449 err = mmc_wait_for_cmd(host, &cmd, 0);
1453 if (!mmc_host_is_spi(host) && (cmd.resp[0] & R1_ERROR))
1456 mmc_host_clk_hold(host);
1458 * The card should drive cmd and dat[0:3] low immediately
1459 * after the response of cmd11, but wait 1 ms to be sure
1462 if (host->ops->card_busy && !host->ops->card_busy(host)) {
1467 * During a signal voltage level switch, the clock must be gated
1468 * for 5 ms according to the SD spec
1470 clock = host->ios.clock;
1471 host->ios.clock = 0;
1474 if (__mmc_set_signal_voltage(host, signal_voltage)) {
1476 * Voltages may not have been switched, but we've already
1477 * sent CMD11, so a power cycle is required anyway
1483 /* Keep clock gated for at least 5 ms */
1485 host->ios.clock = clock;
1488 /* Wait for at least 1 ms according to spec */
1492 * Failure to switch is indicated by the card holding
1495 if (host->ops->card_busy && host->ops->card_busy(host))
1500 pr_debug("%s: Signal voltage switch failed, "
1501 "power cycling card\n", mmc_hostname(host));
1502 mmc_power_cycle(host, ocr);
1505 mmc_host_clk_release(host);
1511 * Select timing parameters for host.
1513 void mmc_set_timing(struct mmc_host *host, unsigned int timing)
1515 mmc_host_clk_hold(host);
1516 host->ios.timing = timing;
1518 mmc_host_clk_release(host);
1522 * Select appropriate driver type for host.
1524 void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type)
1526 mmc_host_clk_hold(host);
1527 host->ios.drv_type = drv_type;
1529 mmc_host_clk_release(host);
1533 * Apply power to the MMC stack. This is a two-stage process.
1534 * First, we enable power to the card without the clock running.
1535 * We then wait a bit for the power to stabilise. Finally,
1536 * enable the bus drivers and clock to the card.
1538 * We must _NOT_ enable the clock prior to power stablising.
1540 * If a host does all the power sequencing itself, ignore the
1541 * initial MMC_POWER_UP stage.
1543 void mmc_power_up(struct mmc_host *host, u32 ocr)
1545 if (host->ios.power_mode == MMC_POWER_ON)
1548 mmc_host_clk_hold(host);
1550 host->ios.vdd = fls(ocr) - 1;
1551 if (mmc_host_is_spi(host))
1552 host->ios.chip_select = MMC_CS_HIGH;
1554 host->ios.chip_select = MMC_CS_DONTCARE;
1555 host->ios.bus_mode = MMC_BUSMODE_PUSHPULL;
1556 host->ios.power_mode = MMC_POWER_UP;
1557 host->ios.bus_width = MMC_BUS_WIDTH_1;
1558 host->ios.timing = MMC_TIMING_LEGACY;
1561 /* Try to set signal voltage to 3.3V but fall back to 1.8v or 1.2v */
1562 if (__mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_330) == 0)
1563 dev_dbg(mmc_dev(host), "Initial signal voltage of 3.3v\n");
1564 else if (__mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_180) == 0)
1565 dev_dbg(mmc_dev(host), "Initial signal voltage of 1.8v\n");
1566 else if (__mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_120) == 0)
1567 dev_dbg(mmc_dev(host), "Initial signal voltage of 1.2v\n");
1570 * This delay should be sufficient to allow the power supply
1571 * to reach the minimum voltage.
1575 host->ios.clock = host->f_init;
1577 host->ios.power_mode = MMC_POWER_ON;
1581 * This delay must be at least 74 clock sizes, or 1 ms, or the
1582 * time required to reach a stable voltage.
1586 mmc_host_clk_release(host);
1589 void mmc_power_off(struct mmc_host *host)
1591 if (host->ios.power_mode == MMC_POWER_OFF)
1594 mmc_host_clk_hold(host);
1596 host->ios.clock = 0;
1599 if (!mmc_host_is_spi(host)) {
1600 host->ios.bus_mode = MMC_BUSMODE_OPENDRAIN;
1601 host->ios.chip_select = MMC_CS_DONTCARE;
1603 host->ios.power_mode = MMC_POWER_OFF;
1604 host->ios.bus_width = MMC_BUS_WIDTH_1;
1605 host->ios.timing = MMC_TIMING_LEGACY;
1609 * Some configurations, such as the 802.11 SDIO card in the OLPC
1610 * XO-1.5, require a short delay after poweroff before the card
1611 * can be successfully turned on again.
1615 mmc_host_clk_release(host);
1618 void mmc_power_cycle(struct mmc_host *host, u32 ocr)
1620 mmc_power_off(host);
1621 /* Wait at least 1 ms according to SD spec */
1623 mmc_power_up(host, ocr);
1627 * Cleanup when the last reference to the bus operator is dropped.
1629 static void __mmc_release_bus(struct mmc_host *host)
1632 BUG_ON(host->bus_refs);
1633 BUG_ON(!host->bus_dead);
1635 host->bus_ops = NULL;
1639 * Increase reference count of bus operator
1641 static inline void mmc_bus_get(struct mmc_host *host)
1643 unsigned long flags;
1645 spin_lock_irqsave(&host->lock, flags);
1647 spin_unlock_irqrestore(&host->lock, flags);
1651 * Decrease reference count of bus operator and free it if
1652 * it is the last reference.
1654 static inline void mmc_bus_put(struct mmc_host *host)
1656 unsigned long flags;
1658 spin_lock_irqsave(&host->lock, flags);
1660 if ((host->bus_refs == 0) && host->bus_ops)
1661 __mmc_release_bus(host);
1662 spin_unlock_irqrestore(&host->lock, flags);
1666 * Assign a mmc bus handler to a host. Only one bus handler may control a
1667 * host at any given time.
1669 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops)
1671 unsigned long flags;
1676 WARN_ON(!host->claimed);
1678 spin_lock_irqsave(&host->lock, flags);
1680 BUG_ON(host->bus_ops);
1681 BUG_ON(host->bus_refs);
1683 host->bus_ops = ops;
1687 spin_unlock_irqrestore(&host->lock, flags);
1691 * Remove the current bus handler from a host.
1693 void mmc_detach_bus(struct mmc_host *host)
1695 unsigned long flags;
1699 WARN_ON(!host->claimed);
1700 WARN_ON(!host->bus_ops);
1702 spin_lock_irqsave(&host->lock, flags);
1706 spin_unlock_irqrestore(&host->lock, flags);
1711 static void _mmc_detect_change(struct mmc_host *host, unsigned long delay,
1714 #ifdef CONFIG_MMC_DEBUG
1715 unsigned long flags;
1716 spin_lock_irqsave(&host->lock, flags);
1717 WARN_ON(host->removed);
1718 spin_unlock_irqrestore(&host->lock, flags);
1722 * If the device is configured as wakeup, we prevent a new sleep for
1723 * 5 s to give provision for user space to consume the event.
1725 if (cd_irq && !(host->caps & MMC_CAP_NEEDS_POLL) &&
1726 device_can_wakeup(mmc_dev(host)))
1727 pm_wakeup_event(mmc_dev(host), 5000);
1729 host->detect_change = 1;
1730 mmc_schedule_delayed_work(&host->detect, delay);
1734 * mmc_detect_change - process change of state on a MMC socket
1735 * @host: host which changed state.
1736 * @delay: optional delay to wait before detection (jiffies)
1738 * MMC drivers should call this when they detect a card has been
1739 * inserted or removed. The MMC layer will confirm that any
1740 * present card is still functional, and initialize any newly
1743 void mmc_detect_change(struct mmc_host *host, unsigned long delay)
1745 _mmc_detect_change(host, delay, true);
1747 EXPORT_SYMBOL(mmc_detect_change);
1749 void mmc_init_erase(struct mmc_card *card)
1753 if (is_power_of_2(card->erase_size))
1754 card->erase_shift = ffs(card->erase_size) - 1;
1756 card->erase_shift = 0;
1759 * It is possible to erase an arbitrarily large area of an SD or MMC
1760 * card. That is not desirable because it can take a long time
1761 * (minutes) potentially delaying more important I/O, and also the
1762 * timeout calculations become increasingly hugely over-estimated.
1763 * Consequently, 'pref_erase' is defined as a guide to limit erases
1764 * to that size and alignment.
1766 * For SD cards that define Allocation Unit size, limit erases to one
1767 * Allocation Unit at a time. For MMC cards that define High Capacity
1768 * Erase Size, whether it is switched on or not, limit to that size.
1769 * Otherwise just have a stab at a good value. For modern cards it
1770 * will end up being 4MiB. Note that if the value is too small, it
1771 * can end up taking longer to erase.
1773 if (mmc_card_sd(card) && card->ssr.au) {
1774 card->pref_erase = card->ssr.au;
1775 card->erase_shift = ffs(card->ssr.au) - 1;
1776 } else if (card->ext_csd.hc_erase_size) {
1777 card->pref_erase = card->ext_csd.hc_erase_size;
1778 } else if (card->erase_size) {
1779 sz = (card->csd.capacity << (card->csd.read_blkbits - 9)) >> 11;
1781 card->pref_erase = 512 * 1024 / 512;
1783 card->pref_erase = 1024 * 1024 / 512;
1785 card->pref_erase = 2 * 1024 * 1024 / 512;
1787 card->pref_erase = 4 * 1024 * 1024 / 512;
1788 if (card->pref_erase < card->erase_size)
1789 card->pref_erase = card->erase_size;
1791 sz = card->pref_erase % card->erase_size;
1793 card->pref_erase += card->erase_size - sz;
1796 card->pref_erase = 0;
1799 static unsigned int mmc_mmc_erase_timeout(struct mmc_card *card,
1800 unsigned int arg, unsigned int qty)
1802 unsigned int erase_timeout;
1804 if (arg == MMC_DISCARD_ARG ||
1805 (arg == MMC_TRIM_ARG && card->ext_csd.rev >= 6)) {
1806 erase_timeout = card->ext_csd.trim_timeout;
1807 } else if (card->ext_csd.erase_group_def & 1) {
1808 /* High Capacity Erase Group Size uses HC timeouts */
1809 if (arg == MMC_TRIM_ARG)
1810 erase_timeout = card->ext_csd.trim_timeout;
1812 erase_timeout = card->ext_csd.hc_erase_timeout;
1814 /* CSD Erase Group Size uses write timeout */
1815 unsigned int mult = (10 << card->csd.r2w_factor);
1816 unsigned int timeout_clks = card->csd.tacc_clks * mult;
1817 unsigned int timeout_us;
1819 /* Avoid overflow: e.g. tacc_ns=80000000 mult=1280 */
1820 if (card->csd.tacc_ns < 1000000)
1821 timeout_us = (card->csd.tacc_ns * mult) / 1000;
1823 timeout_us = (card->csd.tacc_ns / 1000) * mult;
1826 * ios.clock is only a target. The real clock rate might be
1827 * less but not that much less, so fudge it by multiplying by 2.
1830 timeout_us += (timeout_clks * 1000) /
1831 (mmc_host_clk_rate(card->host) / 1000);
1833 erase_timeout = timeout_us / 1000;
1836 * Theoretically, the calculation could underflow so round up
1837 * to 1ms in that case.
1843 /* Multiplier for secure operations */
1844 if (arg & MMC_SECURE_ARGS) {
1845 if (arg == MMC_SECURE_ERASE_ARG)
1846 erase_timeout *= card->ext_csd.sec_erase_mult;
1848 erase_timeout *= card->ext_csd.sec_trim_mult;
1851 erase_timeout *= qty;
1854 * Ensure at least a 1 second timeout for SPI as per
1855 * 'mmc_set_data_timeout()'
1857 if (mmc_host_is_spi(card->host) && erase_timeout < 1000)
1858 erase_timeout = 1000;
1860 return erase_timeout;
1863 static unsigned int mmc_sd_erase_timeout(struct mmc_card *card,
1867 unsigned int erase_timeout;
1869 if (card->ssr.erase_timeout) {
1870 /* Erase timeout specified in SD Status Register (SSR) */
1871 erase_timeout = card->ssr.erase_timeout * qty +
1872 card->ssr.erase_offset;
1875 * Erase timeout not specified in SD Status Register (SSR) so
1876 * use 250ms per write block.
1878 erase_timeout = 250 * qty;
1881 /* Must not be less than 1 second */
1882 if (erase_timeout < 1000)
1883 erase_timeout = 1000;
1885 return erase_timeout;
1888 static unsigned int mmc_erase_timeout(struct mmc_card *card,
1892 if (mmc_card_sd(card))
1893 return mmc_sd_erase_timeout(card, arg, qty);
1895 return mmc_mmc_erase_timeout(card, arg, qty);
1898 static int mmc_do_erase(struct mmc_card *card, unsigned int from,
1899 unsigned int to, unsigned int arg)
1901 struct mmc_command cmd = {0};
1902 unsigned int qty = 0;
1903 unsigned long timeout;
1907 * qty is used to calculate the erase timeout which depends on how many
1908 * erase groups (or allocation units in SD terminology) are affected.
1909 * We count erasing part of an erase group as one erase group.
1910 * For SD, the allocation units are always a power of 2. For MMC, the
1911 * erase group size is almost certainly also power of 2, but it does not
1912 * seem to insist on that in the JEDEC standard, so we fall back to
1913 * division in that case. SD may not specify an allocation unit size,
1914 * in which case the timeout is based on the number of write blocks.
1916 * Note that the timeout for secure trim 2 will only be correct if the
1917 * number of erase groups specified is the same as the total of all
1918 * preceding secure trim 1 commands. Since the power may have been
1919 * lost since the secure trim 1 commands occurred, it is generally
1920 * impossible to calculate the secure trim 2 timeout correctly.
1922 if (card->erase_shift)
1923 qty += ((to >> card->erase_shift) -
1924 (from >> card->erase_shift)) + 1;
1925 else if (mmc_card_sd(card))
1926 qty += to - from + 1;
1928 qty += ((to / card->erase_size) -
1929 (from / card->erase_size)) + 1;
1931 if (!mmc_card_blockaddr(card)) {
1936 if (mmc_card_sd(card))
1937 cmd.opcode = SD_ERASE_WR_BLK_START;
1939 cmd.opcode = MMC_ERASE_GROUP_START;
1941 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1942 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1944 pr_err("mmc_erase: group start error %d, "
1945 "status %#x\n", err, cmd.resp[0]);
1950 memset(&cmd, 0, sizeof(struct mmc_command));
1951 if (mmc_card_sd(card))
1952 cmd.opcode = SD_ERASE_WR_BLK_END;
1954 cmd.opcode = MMC_ERASE_GROUP_END;
1956 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1957 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1959 pr_err("mmc_erase: group end error %d, status %#x\n",
1965 memset(&cmd, 0, sizeof(struct mmc_command));
1966 cmd.opcode = MMC_ERASE;
1968 cmd.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
1969 cmd.busy_timeout = mmc_erase_timeout(card, arg, qty);
1970 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1972 pr_err("mmc_erase: erase error %d, status %#x\n",
1978 if (mmc_host_is_spi(card->host))
1981 timeout = jiffies + msecs_to_jiffies(MMC_CORE_TIMEOUT_MS);
1983 memset(&cmd, 0, sizeof(struct mmc_command));
1984 cmd.opcode = MMC_SEND_STATUS;
1985 cmd.arg = card->rca << 16;
1986 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1987 /* Do not retry else we can't see errors */
1988 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1989 if (err || (cmd.resp[0] & 0xFDF92000)) {
1990 pr_err("error %d requesting status %#x\n",
1996 /* Timeout if the device never becomes ready for data and
1997 * never leaves the program state.
1999 if (time_after(jiffies, timeout)) {
2000 pr_err("%s: Card stuck in programming state! %s\n",
2001 mmc_hostname(card->host), __func__);
2006 } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
2007 (R1_CURRENT_STATE(cmd.resp[0]) == R1_STATE_PRG));
2013 * mmc_erase - erase sectors.
2014 * @card: card to erase
2015 * @from: first sector to erase
2016 * @nr: number of sectors to erase
2017 * @arg: erase command argument (SD supports only %MMC_ERASE_ARG)
2019 * Caller must claim host before calling this function.
2021 int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
2024 unsigned int rem, to = from + nr;
2026 if (!(card->host->caps & MMC_CAP_ERASE) ||
2027 !(card->csd.cmdclass & CCC_ERASE))
2030 if (!card->erase_size)
2033 if (mmc_card_sd(card) && arg != MMC_ERASE_ARG)
2036 if ((arg & MMC_SECURE_ARGS) &&
2037 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN))
2040 if ((arg & MMC_TRIM_ARGS) &&
2041 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN))
2044 if (arg == MMC_SECURE_ERASE_ARG) {
2045 if (from % card->erase_size || nr % card->erase_size)
2049 if (arg == MMC_ERASE_ARG) {
2050 rem = from % card->erase_size;
2052 rem = card->erase_size - rem;
2059 rem = nr % card->erase_size;
2072 /* 'from' and 'to' are inclusive */
2075 return mmc_do_erase(card, from, to, arg);
2077 EXPORT_SYMBOL(mmc_erase);
2079 int mmc_can_erase(struct mmc_card *card)
2081 if ((card->host->caps & MMC_CAP_ERASE) &&
2082 (card->csd.cmdclass & CCC_ERASE) && card->erase_size)
2086 EXPORT_SYMBOL(mmc_can_erase);
2088 int mmc_can_trim(struct mmc_card *card)
2090 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN)
2094 EXPORT_SYMBOL(mmc_can_trim);
2096 int mmc_can_discard(struct mmc_card *card)
2099 * As there's no way to detect the discard support bit at v4.5
2100 * use the s/w feature support filed.
2102 if (card->ext_csd.feature_support & MMC_DISCARD_FEATURE)
2106 EXPORT_SYMBOL(mmc_can_discard);
2108 int mmc_can_sanitize(struct mmc_card *card)
2110 if (!mmc_can_trim(card) && !mmc_can_erase(card))
2112 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_SANITIZE)
2116 EXPORT_SYMBOL(mmc_can_sanitize);
2118 int mmc_can_secure_erase_trim(struct mmc_card *card)
2120 if ((card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN) &&
2121 !(card->quirks & MMC_QUIRK_SEC_ERASE_TRIM_BROKEN))
2125 EXPORT_SYMBOL(mmc_can_secure_erase_trim);
2127 int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
2130 if (!card->erase_size)
2132 if (from % card->erase_size || nr % card->erase_size)
2136 EXPORT_SYMBOL(mmc_erase_group_aligned);
2138 static unsigned int mmc_do_calc_max_discard(struct mmc_card *card,
2141 struct mmc_host *host = card->host;
2142 unsigned int max_discard, x, y, qty = 0, max_qty, timeout;
2143 unsigned int last_timeout = 0;
2145 if (card->erase_shift)
2146 max_qty = UINT_MAX >> card->erase_shift;
2147 else if (mmc_card_sd(card))
2150 max_qty = UINT_MAX / card->erase_size;
2152 /* Find the largest qty with an OK timeout */
2155 for (x = 1; x && x <= max_qty && max_qty - x >= qty; x <<= 1) {
2156 timeout = mmc_erase_timeout(card, arg, qty + x);
2157 if (timeout > host->max_busy_timeout)
2159 if (timeout < last_timeout)
2161 last_timeout = timeout;
2173 /* Convert qty to sectors */
2174 if (card->erase_shift)
2175 max_discard = --qty << card->erase_shift;
2176 else if (mmc_card_sd(card))
2179 max_discard = --qty * card->erase_size;
2184 unsigned int mmc_calc_max_discard(struct mmc_card *card)
2186 struct mmc_host *host = card->host;
2187 unsigned int max_discard, max_trim;
2189 if (!host->max_busy_timeout)
2193 * Without erase_group_def set, MMC erase timeout depends on clock
2194 * frequence which can change. In that case, the best choice is
2195 * just the preferred erase size.
2197 if (mmc_card_mmc(card) && !(card->ext_csd.erase_group_def & 1))
2198 return card->pref_erase;
2200 max_discard = mmc_do_calc_max_discard(card, MMC_ERASE_ARG);
2201 if (mmc_can_trim(card)) {
2202 max_trim = mmc_do_calc_max_discard(card, MMC_TRIM_ARG);
2203 if (max_trim < max_discard)
2204 max_discard = max_trim;
2205 } else if (max_discard < card->erase_size) {
2208 pr_debug("%s: calculated max. discard sectors %u for timeout %u ms\n",
2209 mmc_hostname(host), max_discard, host->max_busy_timeout);
2212 EXPORT_SYMBOL(mmc_calc_max_discard);
2214 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen)
2216 struct mmc_command cmd = {0};
2218 if (mmc_card_blockaddr(card) || mmc_card_ddr52(card))
2221 cmd.opcode = MMC_SET_BLOCKLEN;
2223 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2224 return mmc_wait_for_cmd(card->host, &cmd, 5);
2226 EXPORT_SYMBOL(mmc_set_blocklen);
2228 int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount,
2231 struct mmc_command cmd = {0};
2233 cmd.opcode = MMC_SET_BLOCK_COUNT;
2234 cmd.arg = blockcount & 0x0000FFFF;
2237 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2238 return mmc_wait_for_cmd(card->host, &cmd, 5);
2240 EXPORT_SYMBOL(mmc_set_blockcount);
2242 static void mmc_hw_reset_for_init(struct mmc_host *host)
2244 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->hw_reset)
2246 mmc_host_clk_hold(host);
2247 host->ops->hw_reset(host);
2248 mmc_host_clk_release(host);
2251 int mmc_can_reset(struct mmc_card *card)
2255 if (!mmc_card_mmc(card))
2257 rst_n_function = card->ext_csd.rst_n_function;
2258 if ((rst_n_function & EXT_CSD_RST_N_EN_MASK) != EXT_CSD_RST_N_ENABLED)
2262 EXPORT_SYMBOL(mmc_can_reset);
2264 static int mmc_do_hw_reset(struct mmc_host *host, int check)
2266 struct mmc_card *card = host->card;
2268 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->hw_reset)
2274 if (!mmc_can_reset(card))
2277 mmc_host_clk_hold(host);
2278 mmc_set_clock(host, host->f_init);
2280 host->ops->hw_reset(host);
2282 /* If the reset has happened, then a status command will fail */
2284 struct mmc_command cmd = {0};
2287 cmd.opcode = MMC_SEND_STATUS;
2288 if (!mmc_host_is_spi(card->host))
2289 cmd.arg = card->rca << 16;
2290 cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
2291 err = mmc_wait_for_cmd(card->host, &cmd, 0);
2293 mmc_host_clk_release(host);
2298 if (mmc_host_is_spi(host)) {
2299 host->ios.chip_select = MMC_CS_HIGH;
2300 host->ios.bus_mode = MMC_BUSMODE_PUSHPULL;
2302 host->ios.chip_select = MMC_CS_DONTCARE;
2303 host->ios.bus_mode = MMC_BUSMODE_OPENDRAIN;
2305 host->ios.bus_width = MMC_BUS_WIDTH_1;
2306 host->ios.timing = MMC_TIMING_LEGACY;
2309 mmc_host_clk_release(host);
2311 return host->bus_ops->power_restore(host);
2314 int mmc_hw_reset(struct mmc_host *host)
2316 return mmc_do_hw_reset(host, 0);
2318 EXPORT_SYMBOL(mmc_hw_reset);
2320 int mmc_hw_reset_check(struct mmc_host *host)
2322 return mmc_do_hw_reset(host, 1);
2324 EXPORT_SYMBOL(mmc_hw_reset_check);
2326 static int mmc_rescan_try_freq(struct mmc_host *host, unsigned freq)
2328 host->f_init = freq;
2330 #ifdef CONFIG_MMC_DEBUG
2331 pr_info("%s: %s: trying to init card at %u Hz\n",
2332 mmc_hostname(host), __func__, host->f_init);
2334 mmc_power_up(host, host->ocr_avail);
2337 * Some eMMCs (with VCCQ always on) may not be reset after power up, so
2338 * do a hardware reset if possible.
2340 mmc_hw_reset_for_init(host);
2343 * sdio_reset sends CMD52 to reset card. Since we do not know
2344 * if the card is being re-initialized, just send it. CMD52
2345 * should be ignored by SD/eMMC cards.
2350 mmc_send_if_cond(host, host->ocr_avail);
2352 /* Order's important: probe SDIO, then SD, then MMC */
2353 if (!mmc_attach_sdio(host))
2355 if (!mmc_attach_sd(host))
2357 if (!mmc_attach_mmc(host))
2360 mmc_power_off(host);
2364 int _mmc_detect_card_removed(struct mmc_host *host)
2368 if (host->caps & MMC_CAP_NONREMOVABLE)
2371 if (!host->card || mmc_card_removed(host->card))
2374 ret = host->bus_ops->alive(host);
2377 * Card detect status and alive check may be out of sync if card is
2378 * removed slowly, when card detect switch changes while card/slot
2379 * pads are still contacted in hardware (refer to "SD Card Mechanical
2380 * Addendum, Appendix C: Card Detection Switch"). So reschedule a
2381 * detect work 200ms later for this case.
2383 if (!ret && host->ops->get_cd && !host->ops->get_cd(host)) {
2384 mmc_detect_change(host, msecs_to_jiffies(200));
2385 pr_debug("%s: card removed too slowly\n", mmc_hostname(host));
2389 mmc_card_set_removed(host->card);
2390 pr_debug("%s: card remove detected\n", mmc_hostname(host));
2396 int mmc_detect_card_removed(struct mmc_host *host)
2398 struct mmc_card *card = host->card;
2401 WARN_ON(!host->claimed);
2406 ret = mmc_card_removed(card);
2408 * The card will be considered unchanged unless we have been asked to
2409 * detect a change or host requires polling to provide card detection.
2411 if (!host->detect_change && !(host->caps & MMC_CAP_NEEDS_POLL))
2414 host->detect_change = 0;
2416 ret = _mmc_detect_card_removed(host);
2417 if (ret && (host->caps & MMC_CAP_NEEDS_POLL)) {
2419 * Schedule a detect work as soon as possible to let a
2420 * rescan handle the card removal.
2422 cancel_delayed_work(&host->detect);
2423 _mmc_detect_change(host, 0, false);
2429 EXPORT_SYMBOL(mmc_detect_card_removed);
2431 void mmc_rescan(struct work_struct *work)
2433 struct mmc_host *host =
2434 container_of(work, struct mmc_host, detect.work);
2437 if (host->trigger_card_event && host->ops->card_event) {
2438 host->ops->card_event(host);
2439 host->trigger_card_event = false;
2442 if (host->rescan_disable)
2445 /* If there is a non-removable card registered, only scan once */
2446 if ((host->caps & MMC_CAP_NONREMOVABLE) && host->rescan_entered)
2448 host->rescan_entered = 1;
2453 * if there is a _removable_ card registered, check whether it is
2456 if (host->bus_ops && !host->bus_dead
2457 && !(host->caps & MMC_CAP_NONREMOVABLE))
2458 host->bus_ops->detect(host);
2460 host->detect_change = 0;
2463 * Let mmc_bus_put() free the bus/bus_ops if we've found that
2464 * the card is no longer present.
2469 /* if there still is a card present, stop here */
2470 if (host->bus_ops != NULL) {
2476 * Only we can add a new handler, so it's safe to
2477 * release the lock here.
2481 if (!(host->caps & MMC_CAP_NONREMOVABLE) && host->ops->get_cd &&
2482 host->ops->get_cd(host) == 0) {
2483 mmc_claim_host(host);
2484 mmc_power_off(host);
2485 mmc_release_host(host);
2489 mmc_claim_host(host);
2490 for (i = 0; i < ARRAY_SIZE(freqs); i++) {
2491 if (!mmc_rescan_try_freq(host, max(freqs[i], host->f_min)))
2493 if (freqs[i] <= host->f_min)
2496 mmc_release_host(host);
2499 if (host->caps & MMC_CAP_NEEDS_POLL)
2500 mmc_schedule_delayed_work(&host->detect, HZ);
2503 void mmc_start_host(struct mmc_host *host)
2505 host->f_init = max(freqs[0], host->f_min);
2506 host->rescan_disable = 0;
2507 host->ios.power_mode = MMC_POWER_UNDEFINED;
2508 if (host->caps2 & MMC_CAP2_NO_PRESCAN_POWERUP)
2509 mmc_power_off(host);
2511 mmc_power_up(host, host->ocr_avail);
2512 mmc_gpiod_request_cd_irq(host);
2513 _mmc_detect_change(host, 0, false);
2516 void mmc_stop_host(struct mmc_host *host)
2518 #ifdef CONFIG_MMC_DEBUG
2519 unsigned long flags;
2520 spin_lock_irqsave(&host->lock, flags);
2522 spin_unlock_irqrestore(&host->lock, flags);
2524 if (host->slot.cd_irq >= 0)
2525 disable_irq(host->slot.cd_irq);
2527 host->rescan_disable = 1;
2528 cancel_delayed_work_sync(&host->detect);
2529 mmc_flush_scheduled_work();
2531 /* clear pm flags now and let card drivers set them as needed */
2535 if (host->bus_ops && !host->bus_dead) {
2536 /* Calling bus_ops->remove() with a claimed host can deadlock */
2537 host->bus_ops->remove(host);
2538 mmc_claim_host(host);
2539 mmc_detach_bus(host);
2540 mmc_power_off(host);
2541 mmc_release_host(host);
2549 mmc_power_off(host);
2552 int mmc_power_save_host(struct mmc_host *host)
2556 #ifdef CONFIG_MMC_DEBUG
2557 pr_info("%s: %s: powering down\n", mmc_hostname(host), __func__);
2562 if (!host->bus_ops || host->bus_dead) {
2567 if (host->bus_ops->power_save)
2568 ret = host->bus_ops->power_save(host);
2572 mmc_power_off(host);
2576 EXPORT_SYMBOL(mmc_power_save_host);
2578 int mmc_power_restore_host(struct mmc_host *host)
2582 #ifdef CONFIG_MMC_DEBUG
2583 pr_info("%s: %s: powering up\n", mmc_hostname(host), __func__);
2588 if (!host->bus_ops || host->bus_dead) {
2593 mmc_power_up(host, host->card->ocr);
2594 ret = host->bus_ops->power_restore(host);
2600 EXPORT_SYMBOL(mmc_power_restore_host);
2603 * Flush the cache to the non-volatile storage.
2605 int mmc_flush_cache(struct mmc_card *card)
2609 if (mmc_card_mmc(card) &&
2610 (card->ext_csd.cache_size > 0) &&
2611 (card->ext_csd.cache_ctrl & 1)) {
2612 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
2613 EXT_CSD_FLUSH_CACHE, 1, 0);
2615 pr_err("%s: cache flush error %d\n",
2616 mmc_hostname(card->host), err);
2621 EXPORT_SYMBOL(mmc_flush_cache);
2625 /* Do the card removal on suspend if card is assumed removeable
2626 * Do that in pm notifier while userspace isn't yet frozen, so we will be able
2629 int mmc_pm_notify(struct notifier_block *notify_block,
2630 unsigned long mode, void *unused)
2632 struct mmc_host *host = container_of(
2633 notify_block, struct mmc_host, pm_notify);
2634 unsigned long flags;
2638 case PM_HIBERNATION_PREPARE:
2639 case PM_SUSPEND_PREPARE:
2640 spin_lock_irqsave(&host->lock, flags);
2641 host->rescan_disable = 1;
2642 spin_unlock_irqrestore(&host->lock, flags);
2643 cancel_delayed_work_sync(&host->detect);
2648 /* Validate prerequisites for suspend */
2649 if (host->bus_ops->pre_suspend)
2650 err = host->bus_ops->pre_suspend(host);
2654 /* Calling bus_ops->remove() with a claimed host can deadlock */
2655 host->bus_ops->remove(host);
2656 mmc_claim_host(host);
2657 mmc_detach_bus(host);
2658 mmc_power_off(host);
2659 mmc_release_host(host);
2663 case PM_POST_SUSPEND:
2664 case PM_POST_HIBERNATION:
2665 case PM_POST_RESTORE:
2667 spin_lock_irqsave(&host->lock, flags);
2668 host->rescan_disable = 0;
2669 spin_unlock_irqrestore(&host->lock, flags);
2670 _mmc_detect_change(host, 0, false);
2679 * mmc_init_context_info() - init synchronization context
2682 * Init struct context_info needed to implement asynchronous
2683 * request mechanism, used by mmc core, host driver and mmc requests
2686 void mmc_init_context_info(struct mmc_host *host)
2688 spin_lock_init(&host->context_info.lock);
2689 host->context_info.is_new_req = false;
2690 host->context_info.is_done_rcv = false;
2691 host->context_info.is_waiting_last_req = false;
2692 init_waitqueue_head(&host->context_info.wait);
2695 static int __init mmc_init(void)
2699 workqueue = alloc_ordered_workqueue("kmmcd", 0);
2703 ret = mmc_register_bus();
2705 goto destroy_workqueue;
2707 ret = mmc_register_host_class();
2709 goto unregister_bus;
2711 ret = sdio_register_bus();
2713 goto unregister_host_class;
2717 unregister_host_class:
2718 mmc_unregister_host_class();
2720 mmc_unregister_bus();
2722 destroy_workqueue(workqueue);
2727 static void __exit mmc_exit(void)
2729 sdio_unregister_bus();
2730 mmc_unregister_host_class();
2731 mmc_unregister_bus();
2732 destroy_workqueue(workqueue);
2735 subsys_initcall(mmc_init);
2736 module_exit(mmc_exit);
2738 MODULE_LICENSE("GPL");