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);
152 pr_debug("%s: req done (CMD%u): %d: %08x %08x %08x %08x\n",
153 mmc_hostname(host), cmd->opcode, err,
154 cmd->resp[0], cmd->resp[1],
155 cmd->resp[2], cmd->resp[3]);
158 pr_debug("%s: %d bytes transferred: %d\n",
160 mrq->data->bytes_xfered, mrq->data->error);
164 pr_debug("%s: (CMD%u): %d: %08x %08x %08x %08x\n",
165 mmc_hostname(host), mrq->stop->opcode,
167 mrq->stop->resp[0], mrq->stop->resp[1],
168 mrq->stop->resp[2], mrq->stop->resp[3]);
174 mmc_host_clk_release(host);
178 EXPORT_SYMBOL(mmc_request_done);
181 mmc_start_request(struct mmc_host *host, struct mmc_request *mrq)
183 #ifdef CONFIG_MMC_DEBUG
185 struct scatterlist *sg;
189 pr_debug("<%s: starting CMD%u arg %08x flags %08x>\n",
190 mmc_hostname(host), mrq->sbc->opcode,
191 mrq->sbc->arg, mrq->sbc->flags);
194 pr_debug("%s: starting CMD%u arg %08x flags %08x\n",
195 mmc_hostname(host), mrq->cmd->opcode,
196 mrq->cmd->arg, mrq->cmd->flags);
199 pr_debug("%s: blksz %d blocks %d flags %08x "
200 "tsac %d ms nsac %d\n",
201 mmc_hostname(host), mrq->data->blksz,
202 mrq->data->blocks, mrq->data->flags,
203 mrq->data->timeout_ns / 1000000,
204 mrq->data->timeout_clks);
208 pr_debug("%s: CMD%u arg %08x flags %08x\n",
209 mmc_hostname(host), mrq->stop->opcode,
210 mrq->stop->arg, mrq->stop->flags);
213 WARN_ON(!host->claimed);
218 BUG_ON(mrq->data->blksz > host->max_blk_size);
219 BUG_ON(mrq->data->blocks > host->max_blk_count);
220 BUG_ON(mrq->data->blocks * mrq->data->blksz >
223 #ifdef CONFIG_MMC_DEBUG
225 for_each_sg(mrq->data->sg, sg, mrq->data->sg_len, i)
227 BUG_ON(sz != mrq->data->blocks * mrq->data->blksz);
230 mrq->cmd->data = mrq->data;
231 mrq->data->error = 0;
232 mrq->data->mrq = mrq;
234 mrq->data->stop = mrq->stop;
235 mrq->stop->error = 0;
236 mrq->stop->mrq = mrq;
239 mmc_host_clk_hold(host);
240 led_trigger_event(host->led, LED_FULL);
241 host->ops->request(host, mrq);
245 * mmc_start_bkops - start BKOPS for supported cards
246 * @card: MMC card to start BKOPS
247 * @form_exception: A flag to indicate if this function was
248 * called due to an exception raised by the card
250 * Start background operations whenever requested.
251 * When the urgent BKOPS bit is set in a R1 command response
252 * then background operations should be started immediately.
254 void mmc_start_bkops(struct mmc_card *card, bool from_exception)
258 bool use_busy_signal;
262 if (!card->ext_csd.bkops_en || mmc_card_doing_bkops(card))
265 err = mmc_read_bkops_status(card);
267 pr_err("%s: Failed to read bkops status: %d\n",
268 mmc_hostname(card->host), err);
272 if (!card->ext_csd.raw_bkops_status)
275 if (card->ext_csd.raw_bkops_status < EXT_CSD_BKOPS_LEVEL_2 &&
279 mmc_claim_host(card->host);
280 if (card->ext_csd.raw_bkops_status >= EXT_CSD_BKOPS_LEVEL_2) {
281 timeout = MMC_BKOPS_MAX_TIMEOUT;
282 use_busy_signal = true;
285 use_busy_signal = false;
288 err = __mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
289 EXT_CSD_BKOPS_START, 1, timeout,
290 use_busy_signal, true, false);
292 pr_warn("%s: Error %d starting bkops\n",
293 mmc_hostname(card->host), err);
298 * For urgent bkops status (LEVEL_2 and more)
299 * bkops executed synchronously, otherwise
300 * the operation is in progress
302 if (!use_busy_signal)
303 mmc_card_set_doing_bkops(card);
305 mmc_release_host(card->host);
307 EXPORT_SYMBOL(mmc_start_bkops);
310 * mmc_wait_data_done() - done callback for data request
311 * @mrq: done data request
313 * Wakes up mmc context, passed as a callback to host controller driver
315 static void mmc_wait_data_done(struct mmc_request *mrq)
317 mrq->host->context_info.is_done_rcv = true;
318 wake_up_interruptible(&mrq->host->context_info.wait);
321 static void mmc_wait_done(struct mmc_request *mrq)
323 complete(&mrq->completion);
327 *__mmc_start_data_req() - starts data request
328 * @host: MMC host to start the request
329 * @mrq: data request to start
331 * Sets the done callback to be called when request is completed by the card.
332 * Starts data mmc request execution
334 static int __mmc_start_data_req(struct mmc_host *host, struct mmc_request *mrq)
336 mrq->done = mmc_wait_data_done;
338 if (mmc_card_removed(host->card)) {
339 mrq->cmd->error = -ENOMEDIUM;
340 mmc_wait_data_done(mrq);
343 mmc_start_request(host, mrq);
348 static int __mmc_start_req(struct mmc_host *host, struct mmc_request *mrq)
350 init_completion(&mrq->completion);
351 mrq->done = mmc_wait_done;
352 if (mmc_card_removed(host->card)) {
353 mrq->cmd->error = -ENOMEDIUM;
354 complete(&mrq->completion);
357 mmc_start_request(host, mrq);
362 * mmc_wait_for_data_req_done() - wait for request completed
363 * @host: MMC host to prepare the command.
364 * @mrq: MMC request to wait for
366 * Blocks MMC context till host controller will ack end of data request
367 * execution or new request notification arrives from the block layer.
368 * Handles command retries.
370 * Returns enum mmc_blk_status after checking errors.
372 static int mmc_wait_for_data_req_done(struct mmc_host *host,
373 struct mmc_request *mrq,
374 struct mmc_async_req *next_req)
376 struct mmc_command *cmd;
377 struct mmc_context_info *context_info = &host->context_info;
382 wait_event_interruptible(context_info->wait,
383 (context_info->is_done_rcv ||
384 context_info->is_new_req));
385 spin_lock_irqsave(&context_info->lock, flags);
386 context_info->is_waiting_last_req = false;
387 spin_unlock_irqrestore(&context_info->lock, flags);
388 if (context_info->is_done_rcv) {
389 context_info->is_done_rcv = false;
390 context_info->is_new_req = false;
393 if (!cmd->error || !cmd->retries ||
394 mmc_card_removed(host->card)) {
395 err = host->areq->err_check(host->card,
397 break; /* return err */
399 pr_info("%s: req failed (CMD%u): %d, retrying...\n",
401 cmd->opcode, cmd->error);
404 host->ops->request(host, mrq);
405 continue; /* wait for done/new event again */
407 } else if (context_info->is_new_req) {
408 context_info->is_new_req = false;
410 err = MMC_BLK_NEW_REQUEST;
411 break; /* return err */
418 static void mmc_wait_for_req_done(struct mmc_host *host,
419 struct mmc_request *mrq)
421 struct mmc_command *cmd;
424 wait_for_completion(&mrq->completion);
429 * If host has timed out waiting for the sanitize
430 * to complete, card might be still in programming state
431 * so let's try to bring the card out of programming
434 if (cmd->sanitize_busy && cmd->error == -ETIMEDOUT) {
435 if (!mmc_interrupt_hpi(host->card)) {
436 pr_warn("%s: %s: Interrupted sanitize\n",
437 mmc_hostname(host), __func__);
441 pr_err("%s: %s: Failed to interrupt sanitize\n",
442 mmc_hostname(host), __func__);
445 if (!cmd->error || !cmd->retries ||
446 mmc_card_removed(host->card))
449 pr_debug("%s: req failed (CMD%u): %d, retrying...\n",
450 mmc_hostname(host), cmd->opcode, cmd->error);
453 host->ops->request(host, mrq);
458 * mmc_pre_req - Prepare for a new request
459 * @host: MMC host to prepare command
460 * @mrq: MMC request to prepare for
461 * @is_first_req: true if there is no previous started request
462 * that may run in parellel to this call, otherwise false
464 * mmc_pre_req() is called in prior to mmc_start_req() to let
465 * host prepare for the new request. Preparation of a request may be
466 * performed while another request is running on the host.
468 static void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq,
471 if (host->ops->pre_req) {
472 mmc_host_clk_hold(host);
473 host->ops->pre_req(host, mrq, is_first_req);
474 mmc_host_clk_release(host);
479 * mmc_post_req - Post process a completed request
480 * @host: MMC host to post process command
481 * @mrq: MMC request to post process for
482 * @err: Error, if non zero, clean up any resources made in pre_req
484 * Let the host post process a completed request. Post processing of
485 * a request may be performed while another reuqest is running.
487 static void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq,
490 if (host->ops->post_req) {
491 mmc_host_clk_hold(host);
492 host->ops->post_req(host, mrq, err);
493 mmc_host_clk_release(host);
498 * mmc_start_req - start a non-blocking request
499 * @host: MMC host to start command
500 * @areq: async request to start
501 * @error: out parameter returns 0 for success, otherwise non zero
503 * Start a new MMC custom command request for a host.
504 * If there is on ongoing async request wait for completion
505 * of that request and start the new one and return.
506 * Does not wait for the new request to complete.
508 * Returns the completed request, NULL in case of none completed.
509 * Wait for the an ongoing request (previoulsy started) to complete and
510 * return the completed request. If there is no ongoing request, NULL
511 * is returned without waiting. NULL is not an error condition.
513 struct mmc_async_req *mmc_start_req(struct mmc_host *host,
514 struct mmc_async_req *areq, int *error)
518 struct mmc_async_req *data = host->areq;
520 /* Prepare a new request */
522 mmc_pre_req(host, areq->mrq, !host->areq);
525 err = mmc_wait_for_data_req_done(host, host->areq->mrq, areq);
526 if (err == MMC_BLK_NEW_REQUEST) {
530 * The previous request was not completed,
536 * Check BKOPS urgency for each R1 response
538 if (host->card && mmc_card_mmc(host->card) &&
539 ((mmc_resp_type(host->areq->mrq->cmd) == MMC_RSP_R1) ||
540 (mmc_resp_type(host->areq->mrq->cmd) == MMC_RSP_R1B)) &&
541 (host->areq->mrq->cmd->resp[0] & R1_EXCEPTION_EVENT))
542 mmc_start_bkops(host->card, true);
546 start_err = __mmc_start_data_req(host, areq->mrq);
549 mmc_post_req(host, host->areq->mrq, 0);
551 /* Cancel a prepared request if it was not started. */
552 if ((err || start_err) && areq)
553 mmc_post_req(host, areq->mrq, -EINVAL);
564 EXPORT_SYMBOL(mmc_start_req);
567 * mmc_wait_for_req - start a request and wait for completion
568 * @host: MMC host to start command
569 * @mrq: MMC request to start
571 * Start a new MMC custom command request for a host, and wait
572 * for the command to complete. Does not attempt to parse the
575 void mmc_wait_for_req(struct mmc_host *host, struct mmc_request *mrq)
577 __mmc_start_req(host, mrq);
578 mmc_wait_for_req_done(host, mrq);
580 EXPORT_SYMBOL(mmc_wait_for_req);
583 * mmc_interrupt_hpi - Issue for High priority Interrupt
584 * @card: the MMC card associated with the HPI transfer
586 * Issued High Priority Interrupt, and check for card status
587 * until out-of prg-state.
589 int mmc_interrupt_hpi(struct mmc_card *card)
593 unsigned long prg_wait;
597 if (!card->ext_csd.hpi_en) {
598 pr_info("%s: HPI enable bit unset\n", mmc_hostname(card->host));
602 mmc_claim_host(card->host);
603 err = mmc_send_status(card, &status);
605 pr_err("%s: Get card status fail\n", mmc_hostname(card->host));
609 switch (R1_CURRENT_STATE(status)) {
615 * In idle and transfer states, HPI is not needed and the caller
616 * can issue the next intended command immediately
622 /* In all other states, it's illegal to issue HPI */
623 pr_debug("%s: HPI cannot be sent. Card state=%d\n",
624 mmc_hostname(card->host), R1_CURRENT_STATE(status));
629 err = mmc_send_hpi_cmd(card, &status);
633 prg_wait = jiffies + msecs_to_jiffies(card->ext_csd.out_of_int_time);
635 err = mmc_send_status(card, &status);
637 if (!err && R1_CURRENT_STATE(status) == R1_STATE_TRAN)
639 if (time_after(jiffies, prg_wait))
644 mmc_release_host(card->host);
647 EXPORT_SYMBOL(mmc_interrupt_hpi);
650 * mmc_wait_for_cmd - start a command and wait for completion
651 * @host: MMC host to start command
652 * @cmd: MMC command to start
653 * @retries: maximum number of retries
655 * Start a new MMC command for a host, and wait for the command
656 * to complete. Return any error that occurred while the command
657 * was executing. Do not attempt to parse the response.
659 int mmc_wait_for_cmd(struct mmc_host *host, struct mmc_command *cmd, int retries)
661 struct mmc_request mrq = {NULL};
663 WARN_ON(!host->claimed);
665 memset(cmd->resp, 0, sizeof(cmd->resp));
666 cmd->retries = retries;
671 mmc_wait_for_req(host, &mrq);
676 EXPORT_SYMBOL(mmc_wait_for_cmd);
679 * mmc_stop_bkops - stop ongoing BKOPS
680 * @card: MMC card to check BKOPS
682 * Send HPI command to stop ongoing background operations to
683 * allow rapid servicing of foreground operations, e.g. read/
684 * writes. Wait until the card comes out of the programming state
685 * to avoid errors in servicing read/write requests.
687 int mmc_stop_bkops(struct mmc_card *card)
692 err = mmc_interrupt_hpi(card);
695 * If err is EINVAL, we can't issue an HPI.
696 * It should complete the BKOPS.
698 if (!err || (err == -EINVAL)) {
699 mmc_card_clr_doing_bkops(card);
705 EXPORT_SYMBOL(mmc_stop_bkops);
707 int mmc_read_bkops_status(struct mmc_card *card)
713 * In future work, we should consider storing the entire ext_csd.
715 ext_csd = kmalloc(512, GFP_KERNEL);
717 pr_err("%s: could not allocate buffer to receive the ext_csd.\n",
718 mmc_hostname(card->host));
722 mmc_claim_host(card->host);
723 err = mmc_send_ext_csd(card, ext_csd);
724 mmc_release_host(card->host);
728 card->ext_csd.raw_bkops_status = ext_csd[EXT_CSD_BKOPS_STATUS];
729 card->ext_csd.raw_exception_status = ext_csd[EXT_CSD_EXP_EVENTS_STATUS];
734 EXPORT_SYMBOL(mmc_read_bkops_status);
737 * mmc_set_data_timeout - set the timeout for a data command
738 * @data: data phase for command
739 * @card: the MMC card associated with the data transfer
741 * Computes the data timeout parameters according to the
742 * correct algorithm given the card type.
744 void mmc_set_data_timeout(struct mmc_data *data, const struct mmc_card *card)
749 * SDIO cards only define an upper 1 s limit on access.
751 if (mmc_card_sdio(card)) {
752 data->timeout_ns = 1000000000;
753 data->timeout_clks = 0;
758 * SD cards use a 100 multiplier rather than 10
760 mult = mmc_card_sd(card) ? 100 : 10;
763 * Scale up the multiplier (and therefore the timeout) by
764 * the r2w factor for writes.
766 if (data->flags & MMC_DATA_WRITE)
767 mult <<= card->csd.r2w_factor;
769 data->timeout_ns = card->csd.tacc_ns * mult;
770 data->timeout_clks = card->csd.tacc_clks * mult;
773 * SD cards also have an upper limit on the timeout.
775 if (mmc_card_sd(card)) {
776 unsigned int timeout_us, limit_us;
778 timeout_us = data->timeout_ns / 1000;
779 if (mmc_host_clk_rate(card->host))
780 timeout_us += data->timeout_clks * 1000 /
781 (mmc_host_clk_rate(card->host) / 1000);
783 if (data->flags & MMC_DATA_WRITE)
785 * The MMC spec "It is strongly recommended
786 * for hosts to implement more than 500ms
787 * timeout value even if the card indicates
788 * the 250ms maximum busy length." Even the
789 * previous value of 300ms is known to be
790 * insufficient for some cards.
797 * SDHC cards always use these fixed values.
799 if (timeout_us > limit_us || mmc_card_blockaddr(card)) {
800 data->timeout_ns = limit_us * 1000;
801 data->timeout_clks = 0;
804 /* assign limit value if invalid */
806 data->timeout_ns = limit_us * 1000;
810 * Some cards require longer data read timeout than indicated in CSD.
811 * Address this by setting the read timeout to a "reasonably high"
812 * value. For the cards tested, 300ms has proven enough. If necessary,
813 * this value can be increased if other problematic cards require this.
815 if (mmc_card_long_read_time(card) && data->flags & MMC_DATA_READ) {
816 data->timeout_ns = 300000000;
817 data->timeout_clks = 0;
821 * Some cards need very high timeouts if driven in SPI mode.
822 * The worst observed timeout was 900ms after writing a
823 * continuous stream of data until the internal logic
826 if (mmc_host_is_spi(card->host)) {
827 if (data->flags & MMC_DATA_WRITE) {
828 if (data->timeout_ns < 1000000000)
829 data->timeout_ns = 1000000000; /* 1s */
831 if (data->timeout_ns < 100000000)
832 data->timeout_ns = 100000000; /* 100ms */
836 EXPORT_SYMBOL(mmc_set_data_timeout);
839 * mmc_align_data_size - pads a transfer size to a more optimal value
840 * @card: the MMC card associated with the data transfer
841 * @sz: original transfer size
843 * Pads the original data size with a number of extra bytes in
844 * order to avoid controller bugs and/or performance hits
845 * (e.g. some controllers revert to PIO for certain sizes).
847 * Returns the improved size, which might be unmodified.
849 * Note that this function is only relevant when issuing a
850 * single scatter gather entry.
852 unsigned int mmc_align_data_size(struct mmc_card *card, unsigned int sz)
855 * FIXME: We don't have a system for the controller to tell
856 * the core about its problems yet, so for now we just 32-bit
859 sz = ((sz + 3) / 4) * 4;
863 EXPORT_SYMBOL(mmc_align_data_size);
866 * __mmc_claim_host - exclusively claim a host
867 * @host: mmc host to claim
868 * @abort: whether or not the operation should be aborted
870 * Claim a host for a set of operations. If @abort is non null and
871 * dereference a non-zero value then this will return prematurely with
872 * that non-zero value without acquiring the lock. Returns zero
873 * with the lock held otherwise.
875 int __mmc_claim_host(struct mmc_host *host, atomic_t *abort)
877 DECLARE_WAITQUEUE(wait, current);
883 add_wait_queue(&host->wq, &wait);
884 spin_lock_irqsave(&host->lock, flags);
886 set_current_state(TASK_UNINTERRUPTIBLE);
887 stop = abort ? atomic_read(abort) : 0;
888 if (stop || !host->claimed || host->claimer == current)
890 spin_unlock_irqrestore(&host->lock, flags);
892 spin_lock_irqsave(&host->lock, flags);
894 set_current_state(TASK_RUNNING);
897 host->claimer = current;
898 host->claim_cnt += 1;
901 spin_unlock_irqrestore(&host->lock, flags);
902 remove_wait_queue(&host->wq, &wait);
903 if (host->ops->enable && !stop && host->claim_cnt == 1)
904 host->ops->enable(host);
908 EXPORT_SYMBOL(__mmc_claim_host);
911 * mmc_release_host - release a host
912 * @host: mmc host to release
914 * Release a MMC host, allowing others to claim the host
915 * for their operations.
917 void mmc_release_host(struct mmc_host *host)
921 WARN_ON(!host->claimed);
923 if (host->ops->disable && host->claim_cnt == 1)
924 host->ops->disable(host);
926 spin_lock_irqsave(&host->lock, flags);
927 if (--host->claim_cnt) {
928 /* Release for nested claim */
929 spin_unlock_irqrestore(&host->lock, flags);
932 host->claimer = NULL;
933 spin_unlock_irqrestore(&host->lock, flags);
937 EXPORT_SYMBOL(mmc_release_host);
940 * This is a helper function, which fetches a runtime pm reference for the
941 * card device and also claims the host.
943 void mmc_get_card(struct mmc_card *card)
945 pm_runtime_get_sync(&card->dev);
946 mmc_claim_host(card->host);
948 EXPORT_SYMBOL(mmc_get_card);
951 * This is a helper function, which releases the host and drops the runtime
952 * pm reference for the card device.
954 void mmc_put_card(struct mmc_card *card)
956 mmc_release_host(card->host);
957 pm_runtime_mark_last_busy(&card->dev);
958 pm_runtime_put_autosuspend(&card->dev);
960 EXPORT_SYMBOL(mmc_put_card);
963 * Internal function that does the actual ios call to the host driver,
964 * optionally printing some debug output.
966 static inline void mmc_set_ios(struct mmc_host *host)
968 struct mmc_ios *ios = &host->ios;
970 pr_debug("%s: clock %uHz busmode %u powermode %u cs %u Vdd %u "
971 "width %u timing %u\n",
972 mmc_hostname(host), ios->clock, ios->bus_mode,
973 ios->power_mode, ios->chip_select, ios->vdd,
974 ios->bus_width, ios->timing);
977 mmc_set_ungated(host);
978 host->ops->set_ios(host, ios);
982 * Control chip select pin on a host.
984 void mmc_set_chip_select(struct mmc_host *host, int mode)
986 mmc_host_clk_hold(host);
987 host->ios.chip_select = mode;
989 mmc_host_clk_release(host);
993 * Sets the host clock to the highest possible frequency that
996 static void __mmc_set_clock(struct mmc_host *host, unsigned int hz)
998 WARN_ON(hz && hz < host->f_min);
1000 if (hz > host->f_max)
1003 host->ios.clock = hz;
1007 void mmc_set_clock(struct mmc_host *host, unsigned int hz)
1009 mmc_host_clk_hold(host);
1010 __mmc_set_clock(host, hz);
1011 mmc_host_clk_release(host);
1014 #ifdef CONFIG_MMC_CLKGATE
1016 * This gates the clock by setting it to 0 Hz.
1018 void mmc_gate_clock(struct mmc_host *host)
1020 unsigned long flags;
1022 spin_lock_irqsave(&host->clk_lock, flags);
1023 host->clk_old = host->ios.clock;
1024 host->ios.clock = 0;
1025 host->clk_gated = true;
1026 spin_unlock_irqrestore(&host->clk_lock, flags);
1031 * This restores the clock from gating by using the cached
1034 void mmc_ungate_clock(struct mmc_host *host)
1037 * We should previously have gated the clock, so the clock shall
1038 * be 0 here! The clock may however be 0 during initialization,
1039 * when some request operations are performed before setting
1040 * the frequency. When ungate is requested in that situation
1041 * we just ignore the call.
1043 if (host->clk_old) {
1044 BUG_ON(host->ios.clock);
1045 /* This call will also set host->clk_gated to false */
1046 __mmc_set_clock(host, host->clk_old);
1050 void mmc_set_ungated(struct mmc_host *host)
1052 unsigned long flags;
1055 * We've been given a new frequency while the clock is gated,
1056 * so make sure we regard this as ungating it.
1058 spin_lock_irqsave(&host->clk_lock, flags);
1059 host->clk_gated = false;
1060 spin_unlock_irqrestore(&host->clk_lock, flags);
1064 void mmc_set_ungated(struct mmc_host *host)
1070 * Change the bus mode (open drain/push-pull) of a host.
1072 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode)
1074 mmc_host_clk_hold(host);
1075 host->ios.bus_mode = mode;
1077 mmc_host_clk_release(host);
1081 * Change data bus width of a host.
1083 void mmc_set_bus_width(struct mmc_host *host, unsigned int width)
1085 mmc_host_clk_hold(host);
1086 host->ios.bus_width = width;
1088 mmc_host_clk_release(host);
1092 * mmc_vdd_to_ocrbitnum - Convert a voltage to the OCR bit number
1093 * @vdd: voltage (mV)
1094 * @low_bits: prefer low bits in boundary cases
1096 * This function returns the OCR bit number according to the provided @vdd
1097 * value. If conversion is not possible a negative errno value returned.
1099 * Depending on the @low_bits flag the function prefers low or high OCR bits
1100 * on boundary voltages. For example,
1101 * with @low_bits = true, 3300 mV translates to ilog2(MMC_VDD_32_33);
1102 * with @low_bits = false, 3300 mV translates to ilog2(MMC_VDD_33_34);
1104 * Any value in the [1951:1999] range translates to the ilog2(MMC_VDD_20_21).
1106 static int mmc_vdd_to_ocrbitnum(int vdd, bool low_bits)
1108 const int max_bit = ilog2(MMC_VDD_35_36);
1111 if (vdd < 1650 || vdd > 3600)
1114 if (vdd >= 1650 && vdd <= 1950)
1115 return ilog2(MMC_VDD_165_195);
1120 /* Base 2000 mV, step 100 mV, bit's base 8. */
1121 bit = (vdd - 2000) / 100 + 8;
1128 * mmc_vddrange_to_ocrmask - Convert a voltage range to the OCR mask
1129 * @vdd_min: minimum voltage value (mV)
1130 * @vdd_max: maximum voltage value (mV)
1132 * This function returns the OCR mask bits according to the provided @vdd_min
1133 * and @vdd_max values. If conversion is not possible the function returns 0.
1135 * Notes wrt boundary cases:
1136 * This function sets the OCR bits for all boundary voltages, for example
1137 * [3300:3400] range is translated to MMC_VDD_32_33 | MMC_VDD_33_34 |
1138 * MMC_VDD_34_35 mask.
1140 u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max)
1144 if (vdd_max < vdd_min)
1147 /* Prefer high bits for the boundary vdd_max values. */
1148 vdd_max = mmc_vdd_to_ocrbitnum(vdd_max, false);
1152 /* Prefer low bits for the boundary vdd_min values. */
1153 vdd_min = mmc_vdd_to_ocrbitnum(vdd_min, true);
1157 /* Fill the mask, from max bit to min bit. */
1158 while (vdd_max >= vdd_min)
1159 mask |= 1 << vdd_max--;
1163 EXPORT_SYMBOL(mmc_vddrange_to_ocrmask);
1168 * mmc_of_parse_voltage - return mask of supported voltages
1169 * @np: The device node need to be parsed.
1170 * @mask: mask of voltages available for MMC/SD/SDIO
1172 * 1. Return zero on success.
1173 * 2. Return negative errno: voltage-range is invalid.
1175 int mmc_of_parse_voltage(struct device_node *np, u32 *mask)
1177 const u32 *voltage_ranges;
1180 voltage_ranges = of_get_property(np, "voltage-ranges", &num_ranges);
1181 num_ranges = num_ranges / sizeof(*voltage_ranges) / 2;
1182 if (!voltage_ranges || !num_ranges) {
1183 pr_info("%s: voltage-ranges unspecified\n", np->full_name);
1187 for (i = 0; i < num_ranges; i++) {
1188 const int j = i * 2;
1191 ocr_mask = mmc_vddrange_to_ocrmask(
1192 be32_to_cpu(voltage_ranges[j]),
1193 be32_to_cpu(voltage_ranges[j + 1]));
1195 pr_err("%s: voltage-range #%d is invalid\n",
1204 EXPORT_SYMBOL(mmc_of_parse_voltage);
1206 #endif /* CONFIG_OF */
1208 #ifdef CONFIG_REGULATOR
1211 * mmc_regulator_get_ocrmask - return mask of supported voltages
1212 * @supply: regulator to use
1214 * This returns either a negative errno, or a mask of voltages that
1215 * can be provided to MMC/SD/SDIO devices using the specified voltage
1216 * regulator. This would normally be called before registering the
1219 int mmc_regulator_get_ocrmask(struct regulator *supply)
1227 count = regulator_count_voltages(supply);
1231 for (i = 0; i < count; i++) {
1232 vdd_uV = regulator_list_voltage(supply, i);
1236 vdd_mV = vdd_uV / 1000;
1237 result |= mmc_vddrange_to_ocrmask(vdd_mV, vdd_mV);
1241 vdd_uV = regulator_get_voltage(supply);
1245 vdd_mV = vdd_uV / 1000;
1246 result = mmc_vddrange_to_ocrmask(vdd_mV, vdd_mV);
1251 EXPORT_SYMBOL_GPL(mmc_regulator_get_ocrmask);
1254 * mmc_regulator_set_ocr - set regulator to match host->ios voltage
1255 * @mmc: the host to regulate
1256 * @supply: regulator to use
1257 * @vdd_bit: zero for power off, else a bit number (host->ios.vdd)
1259 * Returns zero on success, else negative errno.
1261 * MMC host drivers may use this to enable or disable a regulator using
1262 * a particular supply voltage. This would normally be called from the
1265 int mmc_regulator_set_ocr(struct mmc_host *mmc,
1266 struct regulator *supply,
1267 unsigned short vdd_bit)
1276 * REVISIT mmc_vddrange_to_ocrmask() may have set some
1277 * bits this regulator doesn't quite support ... don't
1278 * be too picky, most cards and regulators are OK with
1279 * a 0.1V range goof (it's a small error percentage).
1281 tmp = vdd_bit - ilog2(MMC_VDD_165_195);
1283 min_uV = 1650 * 1000;
1284 max_uV = 1950 * 1000;
1286 min_uV = 1900 * 1000 + tmp * 100 * 1000;
1287 max_uV = min_uV + 100 * 1000;
1290 result = regulator_set_voltage(supply, min_uV, max_uV);
1291 if (result == 0 && !mmc->regulator_enabled) {
1292 result = regulator_enable(supply);
1294 mmc->regulator_enabled = true;
1296 } else if (mmc->regulator_enabled) {
1297 result = regulator_disable(supply);
1299 mmc->regulator_enabled = false;
1303 dev_err(mmc_dev(mmc),
1304 "could not set regulator OCR (%d)\n", result);
1307 EXPORT_SYMBOL_GPL(mmc_regulator_set_ocr);
1309 #endif /* CONFIG_REGULATOR */
1311 int mmc_regulator_get_supply(struct mmc_host *mmc)
1313 struct device *dev = mmc_dev(mmc);
1316 mmc->supply.vmmc = devm_regulator_get_optional(dev, "vmmc");
1317 mmc->supply.vqmmc = devm_regulator_get_optional(dev, "vqmmc");
1319 if (IS_ERR(mmc->supply.vmmc)) {
1320 if (PTR_ERR(mmc->supply.vmmc) == -EPROBE_DEFER)
1321 return -EPROBE_DEFER;
1322 dev_info(dev, "No vmmc regulator found\n");
1324 ret = mmc_regulator_get_ocrmask(mmc->supply.vmmc);
1326 mmc->ocr_avail = ret;
1328 dev_warn(dev, "Failed getting OCR mask: %d\n", ret);
1331 if (IS_ERR(mmc->supply.vqmmc)) {
1332 if (PTR_ERR(mmc->supply.vqmmc) == -EPROBE_DEFER)
1333 return -EPROBE_DEFER;
1334 dev_info(dev, "No vqmmc regulator found\n");
1339 EXPORT_SYMBOL_GPL(mmc_regulator_get_supply);
1342 * Mask off any voltages we don't support and select
1343 * the lowest voltage
1345 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr)
1350 * Sanity check the voltages that the card claims to
1354 dev_warn(mmc_dev(host),
1355 "card claims to support voltages below defined range\n");
1359 ocr &= host->ocr_avail;
1361 dev_warn(mmc_dev(host), "no support for card's volts\n");
1365 if (host->caps2 & MMC_CAP2_FULL_PWR_CYCLE) {
1368 mmc_power_cycle(host, ocr);
1372 if (bit != host->ios.vdd)
1373 dev_warn(mmc_dev(host), "exceeding card's volts\n");
1379 int __mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage)
1382 int old_signal_voltage = host->ios.signal_voltage;
1384 host->ios.signal_voltage = signal_voltage;
1385 if (host->ops->start_signal_voltage_switch) {
1386 mmc_host_clk_hold(host);
1387 err = host->ops->start_signal_voltage_switch(host, &host->ios);
1388 mmc_host_clk_release(host);
1392 host->ios.signal_voltage = old_signal_voltage;
1398 int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage, u32 ocr)
1400 struct mmc_command cmd = {0};
1407 * Send CMD11 only if the request is to switch the card to
1410 if (signal_voltage == MMC_SIGNAL_VOLTAGE_330)
1411 return __mmc_set_signal_voltage(host, signal_voltage);
1414 * If we cannot switch voltages, return failure so the caller
1415 * can continue without UHS mode
1417 if (!host->ops->start_signal_voltage_switch)
1419 if (!host->ops->card_busy)
1420 pr_warn("%s: cannot verify signal voltage switch\n",
1421 mmc_hostname(host));
1423 cmd.opcode = SD_SWITCH_VOLTAGE;
1425 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1427 err = mmc_wait_for_cmd(host, &cmd, 0);
1431 if (!mmc_host_is_spi(host) && (cmd.resp[0] & R1_ERROR))
1434 mmc_host_clk_hold(host);
1436 * The card should drive cmd and dat[0:3] low immediately
1437 * after the response of cmd11, but wait 1 ms to be sure
1440 if (host->ops->card_busy && !host->ops->card_busy(host)) {
1445 * During a signal voltage level switch, the clock must be gated
1446 * for 5 ms according to the SD spec
1448 clock = host->ios.clock;
1449 host->ios.clock = 0;
1452 if (__mmc_set_signal_voltage(host, signal_voltage)) {
1454 * Voltages may not have been switched, but we've already
1455 * sent CMD11, so a power cycle is required anyway
1461 /* Keep clock gated for at least 5 ms */
1463 host->ios.clock = clock;
1466 /* Wait for at least 1 ms according to spec */
1470 * Failure to switch is indicated by the card holding
1473 if (host->ops->card_busy && host->ops->card_busy(host))
1478 pr_debug("%s: Signal voltage switch failed, "
1479 "power cycling card\n", mmc_hostname(host));
1480 mmc_power_cycle(host, ocr);
1483 mmc_host_clk_release(host);
1489 * Select timing parameters for host.
1491 void mmc_set_timing(struct mmc_host *host, unsigned int timing)
1493 mmc_host_clk_hold(host);
1494 host->ios.timing = timing;
1496 mmc_host_clk_release(host);
1500 * Select appropriate driver type for host.
1502 void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type)
1504 mmc_host_clk_hold(host);
1505 host->ios.drv_type = drv_type;
1507 mmc_host_clk_release(host);
1511 * Apply power to the MMC stack. This is a two-stage process.
1512 * First, we enable power to the card without the clock running.
1513 * We then wait a bit for the power to stabilise. Finally,
1514 * enable the bus drivers and clock to the card.
1516 * We must _NOT_ enable the clock prior to power stablising.
1518 * If a host does all the power sequencing itself, ignore the
1519 * initial MMC_POWER_UP stage.
1521 void mmc_power_up(struct mmc_host *host, u32 ocr)
1523 if (host->ios.power_mode == MMC_POWER_ON)
1526 mmc_host_clk_hold(host);
1528 host->ios.vdd = fls(ocr) - 1;
1529 if (mmc_host_is_spi(host))
1530 host->ios.chip_select = MMC_CS_HIGH;
1532 host->ios.chip_select = MMC_CS_DONTCARE;
1533 host->ios.bus_mode = MMC_BUSMODE_PUSHPULL;
1534 host->ios.power_mode = MMC_POWER_UP;
1535 host->ios.bus_width = MMC_BUS_WIDTH_1;
1536 host->ios.timing = MMC_TIMING_LEGACY;
1539 /* Try to set signal voltage to 3.3V but fall back to 1.8v or 1.2v */
1540 if (__mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_330) == 0)
1541 dev_dbg(mmc_dev(host), "Initial signal voltage of 3.3v\n");
1542 else if (__mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_180) == 0)
1543 dev_dbg(mmc_dev(host), "Initial signal voltage of 1.8v\n");
1544 else if (__mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_120) == 0)
1545 dev_dbg(mmc_dev(host), "Initial signal voltage of 1.2v\n");
1548 * This delay should be sufficient to allow the power supply
1549 * to reach the minimum voltage.
1553 host->ios.clock = host->f_init;
1555 host->ios.power_mode = MMC_POWER_ON;
1559 * This delay must be at least 74 clock sizes, or 1 ms, or the
1560 * time required to reach a stable voltage.
1564 mmc_host_clk_release(host);
1567 void mmc_power_off(struct mmc_host *host)
1569 if (host->ios.power_mode == MMC_POWER_OFF)
1572 mmc_host_clk_hold(host);
1574 host->ios.clock = 0;
1577 if (!mmc_host_is_spi(host)) {
1578 host->ios.bus_mode = MMC_BUSMODE_OPENDRAIN;
1579 host->ios.chip_select = MMC_CS_DONTCARE;
1581 host->ios.power_mode = MMC_POWER_OFF;
1582 host->ios.bus_width = MMC_BUS_WIDTH_1;
1583 host->ios.timing = MMC_TIMING_LEGACY;
1587 * Some configurations, such as the 802.11 SDIO card in the OLPC
1588 * XO-1.5, require a short delay after poweroff before the card
1589 * can be successfully turned on again.
1593 mmc_host_clk_release(host);
1596 void mmc_power_cycle(struct mmc_host *host, u32 ocr)
1598 mmc_power_off(host);
1599 /* Wait at least 1 ms according to SD spec */
1601 mmc_power_up(host, ocr);
1605 * Cleanup when the last reference to the bus operator is dropped.
1607 static void __mmc_release_bus(struct mmc_host *host)
1610 BUG_ON(host->bus_refs);
1611 BUG_ON(!host->bus_dead);
1613 host->bus_ops = NULL;
1617 * Increase reference count of bus operator
1619 static inline void mmc_bus_get(struct mmc_host *host)
1621 unsigned long flags;
1623 spin_lock_irqsave(&host->lock, flags);
1625 spin_unlock_irqrestore(&host->lock, flags);
1629 * Decrease reference count of bus operator and free it if
1630 * it is the last reference.
1632 static inline void mmc_bus_put(struct mmc_host *host)
1634 unsigned long flags;
1636 spin_lock_irqsave(&host->lock, flags);
1638 if ((host->bus_refs == 0) && host->bus_ops)
1639 __mmc_release_bus(host);
1640 spin_unlock_irqrestore(&host->lock, flags);
1644 * Assign a mmc bus handler to a host. Only one bus handler may control a
1645 * host at any given time.
1647 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops)
1649 unsigned long flags;
1654 WARN_ON(!host->claimed);
1656 spin_lock_irqsave(&host->lock, flags);
1658 BUG_ON(host->bus_ops);
1659 BUG_ON(host->bus_refs);
1661 host->bus_ops = ops;
1665 spin_unlock_irqrestore(&host->lock, flags);
1669 * Remove the current bus handler from a host.
1671 void mmc_detach_bus(struct mmc_host *host)
1673 unsigned long flags;
1677 WARN_ON(!host->claimed);
1678 WARN_ON(!host->bus_ops);
1680 spin_lock_irqsave(&host->lock, flags);
1684 spin_unlock_irqrestore(&host->lock, flags);
1689 static void _mmc_detect_change(struct mmc_host *host, unsigned long delay,
1692 #ifdef CONFIG_MMC_DEBUG
1693 unsigned long flags;
1694 spin_lock_irqsave(&host->lock, flags);
1695 WARN_ON(host->removed);
1696 spin_unlock_irqrestore(&host->lock, flags);
1700 * If the device is configured as wakeup, we prevent a new sleep for
1701 * 5 s to give provision for user space to consume the event.
1703 if (cd_irq && !(host->caps & MMC_CAP_NEEDS_POLL) &&
1704 device_can_wakeup(mmc_dev(host)))
1705 pm_wakeup_event(mmc_dev(host), 5000);
1707 host->detect_change = 1;
1708 mmc_schedule_delayed_work(&host->detect, delay);
1712 * mmc_detect_change - process change of state on a MMC socket
1713 * @host: host which changed state.
1714 * @delay: optional delay to wait before detection (jiffies)
1716 * MMC drivers should call this when they detect a card has been
1717 * inserted or removed. The MMC layer will confirm that any
1718 * present card is still functional, and initialize any newly
1721 void mmc_detect_change(struct mmc_host *host, unsigned long delay)
1723 _mmc_detect_change(host, delay, true);
1725 EXPORT_SYMBOL(mmc_detect_change);
1727 void mmc_init_erase(struct mmc_card *card)
1731 if (is_power_of_2(card->erase_size))
1732 card->erase_shift = ffs(card->erase_size) - 1;
1734 card->erase_shift = 0;
1737 * It is possible to erase an arbitrarily large area of an SD or MMC
1738 * card. That is not desirable because it can take a long time
1739 * (minutes) potentially delaying more important I/O, and also the
1740 * timeout calculations become increasingly hugely over-estimated.
1741 * Consequently, 'pref_erase' is defined as a guide to limit erases
1742 * to that size and alignment.
1744 * For SD cards that define Allocation Unit size, limit erases to one
1745 * Allocation Unit at a time. For MMC cards that define High Capacity
1746 * Erase Size, whether it is switched on or not, limit to that size.
1747 * Otherwise just have a stab at a good value. For modern cards it
1748 * will end up being 4MiB. Note that if the value is too small, it
1749 * can end up taking longer to erase.
1751 if (mmc_card_sd(card) && card->ssr.au) {
1752 card->pref_erase = card->ssr.au;
1753 card->erase_shift = ffs(card->ssr.au) - 1;
1754 } else if (card->ext_csd.hc_erase_size) {
1755 card->pref_erase = card->ext_csd.hc_erase_size;
1756 } else if (card->erase_size) {
1757 sz = (card->csd.capacity << (card->csd.read_blkbits - 9)) >> 11;
1759 card->pref_erase = 512 * 1024 / 512;
1761 card->pref_erase = 1024 * 1024 / 512;
1763 card->pref_erase = 2 * 1024 * 1024 / 512;
1765 card->pref_erase = 4 * 1024 * 1024 / 512;
1766 if (card->pref_erase < card->erase_size)
1767 card->pref_erase = card->erase_size;
1769 sz = card->pref_erase % card->erase_size;
1771 card->pref_erase += card->erase_size - sz;
1774 card->pref_erase = 0;
1777 static unsigned int mmc_mmc_erase_timeout(struct mmc_card *card,
1778 unsigned int arg, unsigned int qty)
1780 unsigned int erase_timeout;
1782 if (arg == MMC_DISCARD_ARG ||
1783 (arg == MMC_TRIM_ARG && card->ext_csd.rev >= 6)) {
1784 erase_timeout = card->ext_csd.trim_timeout;
1785 } else if (card->ext_csd.erase_group_def & 1) {
1786 /* High Capacity Erase Group Size uses HC timeouts */
1787 if (arg == MMC_TRIM_ARG)
1788 erase_timeout = card->ext_csd.trim_timeout;
1790 erase_timeout = card->ext_csd.hc_erase_timeout;
1792 /* CSD Erase Group Size uses write timeout */
1793 unsigned int mult = (10 << card->csd.r2w_factor);
1794 unsigned int timeout_clks = card->csd.tacc_clks * mult;
1795 unsigned int timeout_us;
1797 /* Avoid overflow: e.g. tacc_ns=80000000 mult=1280 */
1798 if (card->csd.tacc_ns < 1000000)
1799 timeout_us = (card->csd.tacc_ns * mult) / 1000;
1801 timeout_us = (card->csd.tacc_ns / 1000) * mult;
1804 * ios.clock is only a target. The real clock rate might be
1805 * less but not that much less, so fudge it by multiplying by 2.
1808 timeout_us += (timeout_clks * 1000) /
1809 (mmc_host_clk_rate(card->host) / 1000);
1811 erase_timeout = timeout_us / 1000;
1814 * Theoretically, the calculation could underflow so round up
1815 * to 1ms in that case.
1821 /* Multiplier for secure operations */
1822 if (arg & MMC_SECURE_ARGS) {
1823 if (arg == MMC_SECURE_ERASE_ARG)
1824 erase_timeout *= card->ext_csd.sec_erase_mult;
1826 erase_timeout *= card->ext_csd.sec_trim_mult;
1829 erase_timeout *= qty;
1832 * Ensure at least a 1 second timeout for SPI as per
1833 * 'mmc_set_data_timeout()'
1835 if (mmc_host_is_spi(card->host) && erase_timeout < 1000)
1836 erase_timeout = 1000;
1838 return erase_timeout;
1841 static unsigned int mmc_sd_erase_timeout(struct mmc_card *card,
1845 unsigned int erase_timeout;
1847 if (card->ssr.erase_timeout) {
1848 /* Erase timeout specified in SD Status Register (SSR) */
1849 erase_timeout = card->ssr.erase_timeout * qty +
1850 card->ssr.erase_offset;
1853 * Erase timeout not specified in SD Status Register (SSR) so
1854 * use 250ms per write block.
1856 erase_timeout = 250 * qty;
1859 /* Must not be less than 1 second */
1860 if (erase_timeout < 1000)
1861 erase_timeout = 1000;
1863 return erase_timeout;
1866 static unsigned int mmc_erase_timeout(struct mmc_card *card,
1870 if (mmc_card_sd(card))
1871 return mmc_sd_erase_timeout(card, arg, qty);
1873 return mmc_mmc_erase_timeout(card, arg, qty);
1876 static int mmc_do_erase(struct mmc_card *card, unsigned int from,
1877 unsigned int to, unsigned int arg)
1879 struct mmc_command cmd = {0};
1880 unsigned int qty = 0;
1881 unsigned long timeout;
1885 * qty is used to calculate the erase timeout which depends on how many
1886 * erase groups (or allocation units in SD terminology) are affected.
1887 * We count erasing part of an erase group as one erase group.
1888 * For SD, the allocation units are always a power of 2. For MMC, the
1889 * erase group size is almost certainly also power of 2, but it does not
1890 * seem to insist on that in the JEDEC standard, so we fall back to
1891 * division in that case. SD may not specify an allocation unit size,
1892 * in which case the timeout is based on the number of write blocks.
1894 * Note that the timeout for secure trim 2 will only be correct if the
1895 * number of erase groups specified is the same as the total of all
1896 * preceding secure trim 1 commands. Since the power may have been
1897 * lost since the secure trim 1 commands occurred, it is generally
1898 * impossible to calculate the secure trim 2 timeout correctly.
1900 if (card->erase_shift)
1901 qty += ((to >> card->erase_shift) -
1902 (from >> card->erase_shift)) + 1;
1903 else if (mmc_card_sd(card))
1904 qty += to - from + 1;
1906 qty += ((to / card->erase_size) -
1907 (from / card->erase_size)) + 1;
1909 if (!mmc_card_blockaddr(card)) {
1914 if (mmc_card_sd(card))
1915 cmd.opcode = SD_ERASE_WR_BLK_START;
1917 cmd.opcode = MMC_ERASE_GROUP_START;
1919 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1920 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1922 pr_err("mmc_erase: group start error %d, "
1923 "status %#x\n", err, cmd.resp[0]);
1928 memset(&cmd, 0, sizeof(struct mmc_command));
1929 if (mmc_card_sd(card))
1930 cmd.opcode = SD_ERASE_WR_BLK_END;
1932 cmd.opcode = MMC_ERASE_GROUP_END;
1934 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1935 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1937 pr_err("mmc_erase: group end error %d, status %#x\n",
1943 memset(&cmd, 0, sizeof(struct mmc_command));
1944 cmd.opcode = MMC_ERASE;
1946 cmd.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
1947 cmd.busy_timeout = mmc_erase_timeout(card, arg, qty);
1948 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1950 pr_err("mmc_erase: erase error %d, status %#x\n",
1956 if (mmc_host_is_spi(card->host))
1959 timeout = jiffies + msecs_to_jiffies(MMC_CORE_TIMEOUT_MS);
1961 memset(&cmd, 0, sizeof(struct mmc_command));
1962 cmd.opcode = MMC_SEND_STATUS;
1963 cmd.arg = card->rca << 16;
1964 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1965 /* Do not retry else we can't see errors */
1966 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1967 if (err || (cmd.resp[0] & 0xFDF92000)) {
1968 pr_err("error %d requesting status %#x\n",
1974 /* Timeout if the device never becomes ready for data and
1975 * never leaves the program state.
1977 if (time_after(jiffies, timeout)) {
1978 pr_err("%s: Card stuck in programming state! %s\n",
1979 mmc_hostname(card->host), __func__);
1984 } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
1985 (R1_CURRENT_STATE(cmd.resp[0]) == R1_STATE_PRG));
1991 * mmc_erase - erase sectors.
1992 * @card: card to erase
1993 * @from: first sector to erase
1994 * @nr: number of sectors to erase
1995 * @arg: erase command argument (SD supports only %MMC_ERASE_ARG)
1997 * Caller must claim host before calling this function.
1999 int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
2002 unsigned int rem, to = from + nr;
2004 if (!(card->host->caps & MMC_CAP_ERASE) ||
2005 !(card->csd.cmdclass & CCC_ERASE))
2008 if (!card->erase_size)
2011 if (mmc_card_sd(card) && arg != MMC_ERASE_ARG)
2014 if ((arg & MMC_SECURE_ARGS) &&
2015 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN))
2018 if ((arg & MMC_TRIM_ARGS) &&
2019 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN))
2022 if (arg == MMC_SECURE_ERASE_ARG) {
2023 if (from % card->erase_size || nr % card->erase_size)
2027 if (arg == MMC_ERASE_ARG) {
2028 rem = from % card->erase_size;
2030 rem = card->erase_size - rem;
2037 rem = nr % card->erase_size;
2050 /* 'from' and 'to' are inclusive */
2053 return mmc_do_erase(card, from, to, arg);
2055 EXPORT_SYMBOL(mmc_erase);
2057 int mmc_can_erase(struct mmc_card *card)
2059 if ((card->host->caps & MMC_CAP_ERASE) &&
2060 (card->csd.cmdclass & CCC_ERASE) && card->erase_size)
2064 EXPORT_SYMBOL(mmc_can_erase);
2066 int mmc_can_trim(struct mmc_card *card)
2068 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN)
2072 EXPORT_SYMBOL(mmc_can_trim);
2074 int mmc_can_discard(struct mmc_card *card)
2077 * As there's no way to detect the discard support bit at v4.5
2078 * use the s/w feature support filed.
2080 if (card->ext_csd.feature_support & MMC_DISCARD_FEATURE)
2084 EXPORT_SYMBOL(mmc_can_discard);
2086 int mmc_can_sanitize(struct mmc_card *card)
2088 if (!mmc_can_trim(card) && !mmc_can_erase(card))
2090 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_SANITIZE)
2094 EXPORT_SYMBOL(mmc_can_sanitize);
2096 int mmc_can_secure_erase_trim(struct mmc_card *card)
2098 if ((card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN) &&
2099 !(card->quirks & MMC_QUIRK_SEC_ERASE_TRIM_BROKEN))
2103 EXPORT_SYMBOL(mmc_can_secure_erase_trim);
2105 int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
2108 if (!card->erase_size)
2110 if (from % card->erase_size || nr % card->erase_size)
2114 EXPORT_SYMBOL(mmc_erase_group_aligned);
2116 static unsigned int mmc_do_calc_max_discard(struct mmc_card *card,
2119 struct mmc_host *host = card->host;
2120 unsigned int max_discard, x, y, qty = 0, max_qty, timeout;
2121 unsigned int last_timeout = 0;
2123 if (card->erase_shift)
2124 max_qty = UINT_MAX >> card->erase_shift;
2125 else if (mmc_card_sd(card))
2128 max_qty = UINT_MAX / card->erase_size;
2130 /* Find the largest qty with an OK timeout */
2133 for (x = 1; x && x <= max_qty && max_qty - x >= qty; x <<= 1) {
2134 timeout = mmc_erase_timeout(card, arg, qty + x);
2135 if (timeout > host->max_busy_timeout)
2137 if (timeout < last_timeout)
2139 last_timeout = timeout;
2151 /* Convert qty to sectors */
2152 if (card->erase_shift)
2153 max_discard = --qty << card->erase_shift;
2154 else if (mmc_card_sd(card))
2157 max_discard = --qty * card->erase_size;
2162 unsigned int mmc_calc_max_discard(struct mmc_card *card)
2164 struct mmc_host *host = card->host;
2165 unsigned int max_discard, max_trim;
2167 if (!host->max_busy_timeout)
2171 * Without erase_group_def set, MMC erase timeout depends on clock
2172 * frequence which can change. In that case, the best choice is
2173 * just the preferred erase size.
2175 if (mmc_card_mmc(card) && !(card->ext_csd.erase_group_def & 1))
2176 return card->pref_erase;
2178 max_discard = mmc_do_calc_max_discard(card, MMC_ERASE_ARG);
2179 if (mmc_can_trim(card)) {
2180 max_trim = mmc_do_calc_max_discard(card, MMC_TRIM_ARG);
2181 if (max_trim < max_discard)
2182 max_discard = max_trim;
2183 } else if (max_discard < card->erase_size) {
2186 pr_debug("%s: calculated max. discard sectors %u for timeout %u ms\n",
2187 mmc_hostname(host), max_discard, host->max_busy_timeout);
2190 EXPORT_SYMBOL(mmc_calc_max_discard);
2192 int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen)
2194 struct mmc_command cmd = {0};
2196 if (mmc_card_blockaddr(card) || mmc_card_ddr52(card))
2199 cmd.opcode = MMC_SET_BLOCKLEN;
2201 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2202 return mmc_wait_for_cmd(card->host, &cmd, 5);
2204 EXPORT_SYMBOL(mmc_set_blocklen);
2206 int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount,
2209 struct mmc_command cmd = {0};
2211 cmd.opcode = MMC_SET_BLOCK_COUNT;
2212 cmd.arg = blockcount & 0x0000FFFF;
2215 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2216 return mmc_wait_for_cmd(card->host, &cmd, 5);
2218 EXPORT_SYMBOL(mmc_set_blockcount);
2220 static void mmc_hw_reset_for_init(struct mmc_host *host)
2222 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->hw_reset)
2224 mmc_host_clk_hold(host);
2225 host->ops->hw_reset(host);
2226 mmc_host_clk_release(host);
2229 int mmc_can_reset(struct mmc_card *card)
2233 if (!mmc_card_mmc(card))
2235 rst_n_function = card->ext_csd.rst_n_function;
2236 if ((rst_n_function & EXT_CSD_RST_N_EN_MASK) != EXT_CSD_RST_N_ENABLED)
2240 EXPORT_SYMBOL(mmc_can_reset);
2242 static int mmc_do_hw_reset(struct mmc_host *host, int check)
2244 struct mmc_card *card = host->card;
2246 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->hw_reset)
2252 if (!mmc_can_reset(card))
2255 mmc_host_clk_hold(host);
2256 mmc_set_clock(host, host->f_init);
2258 host->ops->hw_reset(host);
2260 /* If the reset has happened, then a status command will fail */
2262 struct mmc_command cmd = {0};
2265 cmd.opcode = MMC_SEND_STATUS;
2266 if (!mmc_host_is_spi(card->host))
2267 cmd.arg = card->rca << 16;
2268 cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
2269 err = mmc_wait_for_cmd(card->host, &cmd, 0);
2271 mmc_host_clk_release(host);
2276 if (mmc_host_is_spi(host)) {
2277 host->ios.chip_select = MMC_CS_HIGH;
2278 host->ios.bus_mode = MMC_BUSMODE_PUSHPULL;
2280 host->ios.chip_select = MMC_CS_DONTCARE;
2281 host->ios.bus_mode = MMC_BUSMODE_OPENDRAIN;
2283 host->ios.bus_width = MMC_BUS_WIDTH_1;
2284 host->ios.timing = MMC_TIMING_LEGACY;
2287 mmc_host_clk_release(host);
2289 return host->bus_ops->power_restore(host);
2292 int mmc_hw_reset(struct mmc_host *host)
2294 return mmc_do_hw_reset(host, 0);
2296 EXPORT_SYMBOL(mmc_hw_reset);
2298 int mmc_hw_reset_check(struct mmc_host *host)
2300 return mmc_do_hw_reset(host, 1);
2302 EXPORT_SYMBOL(mmc_hw_reset_check);
2304 static int mmc_rescan_try_freq(struct mmc_host *host, unsigned freq)
2306 host->f_init = freq;
2308 #ifdef CONFIG_MMC_DEBUG
2309 pr_info("%s: %s: trying to init card at %u Hz\n",
2310 mmc_hostname(host), __func__, host->f_init);
2312 mmc_power_up(host, host->ocr_avail);
2315 * Some eMMCs (with VCCQ always on) may not be reset after power up, so
2316 * do a hardware reset if possible.
2318 mmc_hw_reset_for_init(host);
2321 * sdio_reset sends CMD52 to reset card. Since we do not know
2322 * if the card is being re-initialized, just send it. CMD52
2323 * should be ignored by SD/eMMC cards.
2328 mmc_send_if_cond(host, host->ocr_avail);
2330 /* Order's important: probe SDIO, then SD, then MMC */
2331 if (!mmc_attach_sdio(host))
2333 if (!mmc_attach_sd(host))
2335 if (!mmc_attach_mmc(host))
2338 mmc_power_off(host);
2342 int _mmc_detect_card_removed(struct mmc_host *host)
2346 if (host->caps & MMC_CAP_NONREMOVABLE)
2349 if (!host->card || mmc_card_removed(host->card))
2352 ret = host->bus_ops->alive(host);
2355 * Card detect status and alive check may be out of sync if card is
2356 * removed slowly, when card detect switch changes while card/slot
2357 * pads are still contacted in hardware (refer to "SD Card Mechanical
2358 * Addendum, Appendix C: Card Detection Switch"). So reschedule a
2359 * detect work 200ms later for this case.
2361 if (!ret && host->ops->get_cd && !host->ops->get_cd(host)) {
2362 mmc_detect_change(host, msecs_to_jiffies(200));
2363 pr_debug("%s: card removed too slowly\n", mmc_hostname(host));
2367 mmc_card_set_removed(host->card);
2368 pr_debug("%s: card remove detected\n", mmc_hostname(host));
2374 int mmc_detect_card_removed(struct mmc_host *host)
2376 struct mmc_card *card = host->card;
2379 WARN_ON(!host->claimed);
2384 ret = mmc_card_removed(card);
2386 * The card will be considered unchanged unless we have been asked to
2387 * detect a change or host requires polling to provide card detection.
2389 if (!host->detect_change && !(host->caps & MMC_CAP_NEEDS_POLL))
2392 host->detect_change = 0;
2394 ret = _mmc_detect_card_removed(host);
2395 if (ret && (host->caps & MMC_CAP_NEEDS_POLL)) {
2397 * Schedule a detect work as soon as possible to let a
2398 * rescan handle the card removal.
2400 cancel_delayed_work(&host->detect);
2401 _mmc_detect_change(host, 0, false);
2407 EXPORT_SYMBOL(mmc_detect_card_removed);
2409 void mmc_rescan(struct work_struct *work)
2411 struct mmc_host *host =
2412 container_of(work, struct mmc_host, detect.work);
2415 if (host->trigger_card_event && host->ops->card_event) {
2416 host->ops->card_event(host);
2417 host->trigger_card_event = false;
2420 if (host->rescan_disable)
2423 /* If there is a non-removable card registered, only scan once */
2424 if ((host->caps & MMC_CAP_NONREMOVABLE) && host->rescan_entered)
2426 host->rescan_entered = 1;
2431 * if there is a _removable_ card registered, check whether it is
2434 if (host->bus_ops && !host->bus_dead
2435 && !(host->caps & MMC_CAP_NONREMOVABLE))
2436 host->bus_ops->detect(host);
2438 host->detect_change = 0;
2441 * Let mmc_bus_put() free the bus/bus_ops if we've found that
2442 * the card is no longer present.
2447 /* if there still is a card present, stop here */
2448 if (host->bus_ops != NULL) {
2454 * Only we can add a new handler, so it's safe to
2455 * release the lock here.
2459 if (!(host->caps & MMC_CAP_NONREMOVABLE) && host->ops->get_cd &&
2460 host->ops->get_cd(host) == 0) {
2461 mmc_claim_host(host);
2462 mmc_power_off(host);
2463 mmc_release_host(host);
2467 mmc_claim_host(host);
2468 for (i = 0; i < ARRAY_SIZE(freqs); i++) {
2469 if (!mmc_rescan_try_freq(host, max(freqs[i], host->f_min)))
2471 if (freqs[i] <= host->f_min)
2474 mmc_release_host(host);
2477 if (host->caps & MMC_CAP_NEEDS_POLL)
2478 mmc_schedule_delayed_work(&host->detect, HZ);
2481 void mmc_start_host(struct mmc_host *host)
2483 host->f_init = max(freqs[0], host->f_min);
2484 host->rescan_disable = 0;
2485 host->ios.power_mode = MMC_POWER_UNDEFINED;
2486 if (host->caps2 & MMC_CAP2_NO_PRESCAN_POWERUP)
2487 mmc_power_off(host);
2489 mmc_power_up(host, host->ocr_avail);
2490 mmc_gpiod_request_cd_irq(host);
2491 _mmc_detect_change(host, 0, false);
2494 void mmc_stop_host(struct mmc_host *host)
2496 #ifdef CONFIG_MMC_DEBUG
2497 unsigned long flags;
2498 spin_lock_irqsave(&host->lock, flags);
2500 spin_unlock_irqrestore(&host->lock, flags);
2502 if (host->slot.cd_irq >= 0)
2503 disable_irq(host->slot.cd_irq);
2505 host->rescan_disable = 1;
2506 cancel_delayed_work_sync(&host->detect);
2507 mmc_flush_scheduled_work();
2509 /* clear pm flags now and let card drivers set them as needed */
2513 if (host->bus_ops && !host->bus_dead) {
2514 /* Calling bus_ops->remove() with a claimed host can deadlock */
2515 host->bus_ops->remove(host);
2516 mmc_claim_host(host);
2517 mmc_detach_bus(host);
2518 mmc_power_off(host);
2519 mmc_release_host(host);
2527 mmc_power_off(host);
2530 int mmc_power_save_host(struct mmc_host *host)
2534 #ifdef CONFIG_MMC_DEBUG
2535 pr_info("%s: %s: powering down\n", mmc_hostname(host), __func__);
2540 if (!host->bus_ops || host->bus_dead) {
2545 if (host->bus_ops->power_save)
2546 ret = host->bus_ops->power_save(host);
2550 mmc_power_off(host);
2554 EXPORT_SYMBOL(mmc_power_save_host);
2556 int mmc_power_restore_host(struct mmc_host *host)
2560 #ifdef CONFIG_MMC_DEBUG
2561 pr_info("%s: %s: powering up\n", mmc_hostname(host), __func__);
2566 if (!host->bus_ops || host->bus_dead) {
2571 mmc_power_up(host, host->card->ocr);
2572 ret = host->bus_ops->power_restore(host);
2578 EXPORT_SYMBOL(mmc_power_restore_host);
2581 * Flush the cache to the non-volatile storage.
2583 int mmc_flush_cache(struct mmc_card *card)
2587 if (mmc_card_mmc(card) &&
2588 (card->ext_csd.cache_size > 0) &&
2589 (card->ext_csd.cache_ctrl & 1)) {
2590 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
2591 EXT_CSD_FLUSH_CACHE, 1, 0);
2593 pr_err("%s: cache flush error %d\n",
2594 mmc_hostname(card->host), err);
2599 EXPORT_SYMBOL(mmc_flush_cache);
2603 /* Do the card removal on suspend if card is assumed removeable
2604 * Do that in pm notifier while userspace isn't yet frozen, so we will be able
2607 int mmc_pm_notify(struct notifier_block *notify_block,
2608 unsigned long mode, void *unused)
2610 struct mmc_host *host = container_of(
2611 notify_block, struct mmc_host, pm_notify);
2612 unsigned long flags;
2616 case PM_HIBERNATION_PREPARE:
2617 case PM_SUSPEND_PREPARE:
2618 spin_lock_irqsave(&host->lock, flags);
2619 host->rescan_disable = 1;
2620 spin_unlock_irqrestore(&host->lock, flags);
2621 cancel_delayed_work_sync(&host->detect);
2626 /* Validate prerequisites for suspend */
2627 if (host->bus_ops->pre_suspend)
2628 err = host->bus_ops->pre_suspend(host);
2632 /* Calling bus_ops->remove() with a claimed host can deadlock */
2633 host->bus_ops->remove(host);
2634 mmc_claim_host(host);
2635 mmc_detach_bus(host);
2636 mmc_power_off(host);
2637 mmc_release_host(host);
2641 case PM_POST_SUSPEND:
2642 case PM_POST_HIBERNATION:
2643 case PM_POST_RESTORE:
2645 spin_lock_irqsave(&host->lock, flags);
2646 host->rescan_disable = 0;
2647 spin_unlock_irqrestore(&host->lock, flags);
2648 _mmc_detect_change(host, 0, false);
2657 * mmc_init_context_info() - init synchronization context
2660 * Init struct context_info needed to implement asynchronous
2661 * request mechanism, used by mmc core, host driver and mmc requests
2664 void mmc_init_context_info(struct mmc_host *host)
2666 spin_lock_init(&host->context_info.lock);
2667 host->context_info.is_new_req = false;
2668 host->context_info.is_done_rcv = false;
2669 host->context_info.is_waiting_last_req = false;
2670 init_waitqueue_head(&host->context_info.wait);
2673 static int __init mmc_init(void)
2677 workqueue = alloc_ordered_workqueue("kmmcd", 0);
2681 ret = mmc_register_bus();
2683 goto destroy_workqueue;
2685 ret = mmc_register_host_class();
2687 goto unregister_bus;
2689 ret = sdio_register_bus();
2691 goto unregister_host_class;
2695 unregister_host_class:
2696 mmc_unregister_host_class();
2698 mmc_unregister_bus();
2700 destroy_workqueue(workqueue);
2705 static void __exit mmc_exit(void)
2707 sdio_unregister_bus();
2708 mmc_unregister_host_class();
2709 mmc_unregister_bus();
2710 destroy_workqueue(workqueue);
2713 subsys_initcall(mmc_init);
2714 module_exit(mmc_exit);
2716 MODULE_LICENSE("GPL");