Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * linux/drivers/mmc/core/core.c
4 *
5 * Copyright (C) 2003-2004 Russell King, All Rights Reserved.
6 * SD support Copyright (C) 2004 Ian Molton, All Rights Reserved.
7 * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
8 * MMCv4 support Copyright (C) 2006 Philip Langdale, All Rights Reserved.
9 */
10#include <linux/module.h>
11#include <linux/init.h>
12#include <linux/interrupt.h>
13#include <linux/completion.h>
14#include <linux/device.h>
15#include <linux/delay.h>
16#include <linux/pagemap.h>
17#include <linux/err.h>
18#include <linux/leds.h>
19#include <linux/scatterlist.h>
20#include <linux/log2.h>
21#include <linux/pm_runtime.h>
22#include <linux/pm_wakeup.h>
23#include <linux/suspend.h>
24#include <linux/fault-inject.h>
25#include <linux/random.h>
26#include <linux/slab.h>
27#include <linux/of.h>
28
29#include <linux/mmc/card.h>
30#include <linux/mmc/host.h>
31#include <linux/mmc/mmc.h>
32#include <linux/mmc/sd.h>
33#include <linux/mmc/slot-gpio.h>
34
35#define CREATE_TRACE_POINTS
36#include <trace/events/mmc.h>
37
38#include "core.h"
39#include "card.h"
40#include "crypto.h"
41#include "bus.h"
42#include "host.h"
43#include "sdio_bus.h"
44#include "pwrseq.h"
45
46#include "mmc_ops.h"
47#include "sd_ops.h"
48#include "sdio_ops.h"
49
50/* The max erase timeout, used when host->max_busy_timeout isn't specified */
51#define MMC_ERASE_TIMEOUT_MS (60 * 1000) /* 60 s */
52#define SD_DISCARD_TIMEOUT_MS (250)
53
54static const unsigned freqs[] = { 400000, 300000, 200000, 100000 };
55
56/*
57 * Enabling software CRCs on the data blocks can be a significant (30%)
58 * performance cost, and for other reasons may not always be desired.
59 * So we allow it to be disabled.
60 */
61bool use_spi_crc = 1;
62module_param(use_spi_crc, bool, 0);
63
64static int mmc_schedule_delayed_work(struct delayed_work *work,
65 unsigned long delay)
66{
67 /*
68 * We use the system_freezable_wq, because of two reasons.
69 * First, it allows several works (not the same work item) to be
70 * executed simultaneously. Second, the queue becomes frozen when
71 * userspace becomes frozen during system PM.
72 */
73 return queue_delayed_work(system_freezable_wq, work, delay);
74}
75
76#ifdef CONFIG_FAIL_MMC_REQUEST
77
78/*
79 * Internal function. Inject random data errors.
80 * If mmc_data is NULL no errors are injected.
81 */
82static void mmc_should_fail_request(struct mmc_host *host,
83 struct mmc_request *mrq)
84{
85 struct mmc_command *cmd = mrq->cmd;
86 struct mmc_data *data = mrq->data;
87 static const int data_errors[] = {
88 -ETIMEDOUT,
89 -EILSEQ,
90 -EIO,
91 };
92
93 if (!data)
94 return;
95
96 if ((cmd && cmd->error) || data->error ||
97 !should_fail(&host->fail_mmc_request, data->blksz * data->blocks))
98 return;
99
100 data->error = data_errors[get_random_u32_below(ARRAY_SIZE(data_errors))];
101 data->bytes_xfered = get_random_u32_below(data->bytes_xfered >> 9) << 9;
102}
103
104#else /* CONFIG_FAIL_MMC_REQUEST */
105
106static inline void mmc_should_fail_request(struct mmc_host *host,
107 struct mmc_request *mrq)
108{
109}
110
111#endif /* CONFIG_FAIL_MMC_REQUEST */
112
113static inline void mmc_complete_cmd(struct mmc_request *mrq)
114{
115 if (mrq->cap_cmd_during_tfr && !completion_done(&mrq->cmd_completion))
116 complete_all(&mrq->cmd_completion);
117}
118
119void mmc_command_done(struct mmc_host *host, struct mmc_request *mrq)
120{
121 if (!mrq->cap_cmd_during_tfr)
122 return;
123
124 mmc_complete_cmd(mrq);
125
126 pr_debug("%s: cmd done, tfr ongoing (CMD%u)\n",
127 mmc_hostname(host), mrq->cmd->opcode);
128}
129EXPORT_SYMBOL(mmc_command_done);
130
131/**
132 * mmc_request_done - finish processing an MMC request
133 * @host: MMC host which completed request
134 * @mrq: MMC request which request
135 *
136 * MMC drivers should call this function when they have completed
137 * their processing of a request.
138 */
139void mmc_request_done(struct mmc_host *host, struct mmc_request *mrq)
140{
141 struct mmc_command *cmd = mrq->cmd;
142 int err = cmd->error;
143
144 /* Flag re-tuning needed on CRC errors */
145 if (!mmc_op_tuning(cmd->opcode) &&
146 !host->retune_crc_disable &&
147 (err == -EILSEQ || (mrq->sbc && mrq->sbc->error == -EILSEQ) ||
148 (mrq->data && mrq->data->error == -EILSEQ) ||
149 (mrq->stop && mrq->stop->error == -EILSEQ)))
150 mmc_retune_needed(host);
151
152 if (err && cmd->retries && mmc_host_is_spi(host)) {
153 if (cmd->resp[0] & R1_SPI_ILLEGAL_COMMAND)
154 cmd->retries = 0;
155 }
156
157 if (host->ongoing_mrq == mrq)
158 host->ongoing_mrq = NULL;
159
160 mmc_complete_cmd(mrq);
161
162 trace_mmc_request_done(host, mrq);
163
164 /*
165 * We list various conditions for the command to be considered
166 * properly done:
167 *
168 * - There was no error, OK fine then
169 * - We are not doing some kind of retry
170 * - The card was removed (...so just complete everything no matter
171 * if there are errors or retries)
172 */
173 if (!err || !cmd->retries || mmc_card_removed(host->card)) {
174 mmc_should_fail_request(host, mrq);
175
176 if (!host->ongoing_mrq)
177 led_trigger_event(host->led, LED_OFF);
178
179 if (mrq->sbc) {
180 pr_debug("%s: req done <CMD%u>: %d: %08x %08x %08x %08x\n",
181 mmc_hostname(host), mrq->sbc->opcode,
182 mrq->sbc->error,
183 mrq->sbc->resp[0], mrq->sbc->resp[1],
184 mrq->sbc->resp[2], mrq->sbc->resp[3]);
185 }
186
187 pr_debug("%s: req done (CMD%u): %d: %08x %08x %08x %08x\n",
188 mmc_hostname(host), cmd->opcode, err,
189 cmd->resp[0], cmd->resp[1],
190 cmd->resp[2], cmd->resp[3]);
191
192 if (mrq->data) {
193 pr_debug("%s: %d bytes transferred: %d\n",
194 mmc_hostname(host),
195 mrq->data->bytes_xfered, mrq->data->error);
196 }
197
198 if (mrq->stop) {
199 pr_debug("%s: (CMD%u): %d: %08x %08x %08x %08x\n",
200 mmc_hostname(host), mrq->stop->opcode,
201 mrq->stop->error,
202 mrq->stop->resp[0], mrq->stop->resp[1],
203 mrq->stop->resp[2], mrq->stop->resp[3]);
204 }
205 }
206 /*
207 * Request starter must handle retries - see
208 * mmc_wait_for_req_done().
209 */
210 if (mrq->done)
211 mrq->done(mrq);
212}
213
214EXPORT_SYMBOL(mmc_request_done);
215
216static void __mmc_start_request(struct mmc_host *host, struct mmc_request *mrq)
217{
218 int err;
219
220 /* Assumes host controller has been runtime resumed by mmc_claim_host */
221 err = mmc_retune(host);
222 if (err) {
223 mrq->cmd->error = err;
224 mmc_request_done(host, mrq);
225 return;
226 }
227
228 /*
229 * For sdio rw commands we must wait for card busy otherwise some
230 * sdio devices won't work properly.
231 * And bypass I/O abort, reset and bus suspend operations.
232 */
233 if (sdio_is_io_busy(mrq->cmd->opcode, mrq->cmd->arg) &&
234 host->ops->card_busy) {
235 int tries = 500; /* Wait aprox 500ms at maximum */
236
237 while (host->ops->card_busy(host) && --tries)
238 mmc_delay(1);
239
240 if (tries == 0) {
241 mrq->cmd->error = -EBUSY;
242 mmc_request_done(host, mrq);
243 return;
244 }
245 }
246
247 if (mrq->cap_cmd_during_tfr) {
248 host->ongoing_mrq = mrq;
249 /*
250 * Retry path could come through here without having waiting on
251 * cmd_completion, so ensure it is reinitialised.
252 */
253 reinit_completion(&mrq->cmd_completion);
254 }
255
256 trace_mmc_request_start(host, mrq);
257
258 if (host->cqe_on)
259 host->cqe_ops->cqe_off(host);
260
261 host->ops->request(host, mrq);
262}
263
264static void mmc_mrq_pr_debug(struct mmc_host *host, struct mmc_request *mrq,
265 bool cqe)
266{
267 if (mrq->sbc) {
268 pr_debug("<%s: starting CMD%u arg %08x flags %08x>\n",
269 mmc_hostname(host), mrq->sbc->opcode,
270 mrq->sbc->arg, mrq->sbc->flags);
271 }
272
273 if (mrq->cmd) {
274 pr_debug("%s: starting %sCMD%u arg %08x flags %08x\n",
275 mmc_hostname(host), cqe ? "CQE direct " : "",
276 mrq->cmd->opcode, mrq->cmd->arg, mrq->cmd->flags);
277 } else if (cqe) {
278 pr_debug("%s: starting CQE transfer for tag %d blkaddr %u\n",
279 mmc_hostname(host), mrq->tag, mrq->data->blk_addr);
280 }
281
282 if (mrq->data) {
283 pr_debug("%s: blksz %d blocks %d flags %08x "
284 "tsac %d ms nsac %d\n",
285 mmc_hostname(host), mrq->data->blksz,
286 mrq->data->blocks, mrq->data->flags,
287 mrq->data->timeout_ns / 1000000,
288 mrq->data->timeout_clks);
289 }
290
291 if (mrq->stop) {
292 pr_debug("%s: CMD%u arg %08x flags %08x\n",
293 mmc_hostname(host), mrq->stop->opcode,
294 mrq->stop->arg, mrq->stop->flags);
295 }
296}
297
298static int mmc_mrq_prep(struct mmc_host *host, struct mmc_request *mrq)
299{
300 unsigned int i, sz = 0;
301 struct scatterlist *sg;
302
303 if (mrq->cmd) {
304 mrq->cmd->error = 0;
305 mrq->cmd->mrq = mrq;
306 mrq->cmd->data = mrq->data;
307 }
308 if (mrq->sbc) {
309 mrq->sbc->error = 0;
310 mrq->sbc->mrq = mrq;
311 }
312 if (mrq->data) {
313 if (mrq->data->blksz > host->max_blk_size ||
314 mrq->data->blocks > host->max_blk_count ||
315 mrq->data->blocks * mrq->data->blksz > host->max_req_size)
316 return -EINVAL;
317
318 for_each_sg(mrq->data->sg, sg, mrq->data->sg_len, i)
319 sz += sg->length;
320 if (sz != mrq->data->blocks * mrq->data->blksz)
321 return -EINVAL;
322
323 mrq->data->error = 0;
324 mrq->data->mrq = mrq;
325 if (mrq->stop) {
326 mrq->data->stop = mrq->stop;
327 mrq->stop->error = 0;
328 mrq->stop->mrq = mrq;
329 }
330 }
331
332 return 0;
333}
334
335int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq)
336{
337 int err;
338
339 init_completion(&mrq->cmd_completion);
340
341 mmc_retune_hold(host);
342
343 if (mmc_card_removed(host->card))
344 return -ENOMEDIUM;
345
346 mmc_mrq_pr_debug(host, mrq, false);
347
348 WARN_ON(!host->claimed);
349
350 err = mmc_mrq_prep(host, mrq);
351 if (err)
352 return err;
353
354 led_trigger_event(host->led, LED_FULL);
355 __mmc_start_request(host, mrq);
356
357 return 0;
358}
359EXPORT_SYMBOL(mmc_start_request);
360
361static void mmc_wait_done(struct mmc_request *mrq)
362{
363 complete(&mrq->completion);
364}
365
366static inline void mmc_wait_ongoing_tfr_cmd(struct mmc_host *host)
367{
368 struct mmc_request *ongoing_mrq = READ_ONCE(host->ongoing_mrq);
369
370 /*
371 * If there is an ongoing transfer, wait for the command line to become
372 * available.
373 */
374 if (ongoing_mrq && !completion_done(&ongoing_mrq->cmd_completion))
375 wait_for_completion(&ongoing_mrq->cmd_completion);
376}
377
378static int __mmc_start_req(struct mmc_host *host, struct mmc_request *mrq)
379{
380 int err;
381
382 mmc_wait_ongoing_tfr_cmd(host);
383
384 init_completion(&mrq->completion);
385 mrq->done = mmc_wait_done;
386
387 err = mmc_start_request(host, mrq);
388 if (err) {
389 mrq->cmd->error = err;
390 mmc_complete_cmd(mrq);
391 complete(&mrq->completion);
392 }
393
394 return err;
395}
396
397void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq)
398{
399 struct mmc_command *cmd;
400
401 while (1) {
402 wait_for_completion(&mrq->completion);
403
404 cmd = mrq->cmd;
405
406 if (!cmd->error || !cmd->retries ||
407 mmc_card_removed(host->card))
408 break;
409
410 mmc_retune_recheck(host);
411
412 pr_debug("%s: req failed (CMD%u): %d, retrying...\n",
413 mmc_hostname(host), cmd->opcode, cmd->error);
414 cmd->retries--;
415 cmd->error = 0;
416 __mmc_start_request(host, mrq);
417 }
418
419 mmc_retune_release(host);
420}
421EXPORT_SYMBOL(mmc_wait_for_req_done);
422
423/*
424 * mmc_cqe_start_req - Start a CQE request.
425 * @host: MMC host to start the request
426 * @mrq: request to start
427 *
428 * Start the request, re-tuning if needed and it is possible. Returns an error
429 * code if the request fails to start or -EBUSY if CQE is busy.
430 */
431int mmc_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq)
432{
433 int err;
434
435 /*
436 * CQE cannot process re-tuning commands. Caller must hold retuning
437 * while CQE is in use. Re-tuning can happen here only when CQE has no
438 * active requests i.e. this is the first. Note, re-tuning will call
439 * ->cqe_off().
440 */
441 err = mmc_retune(host);
442 if (err)
443 goto out_err;
444
445 mrq->host = host;
446
447 mmc_mrq_pr_debug(host, mrq, true);
448
449 err = mmc_mrq_prep(host, mrq);
450 if (err)
451 goto out_err;
452
453 err = host->cqe_ops->cqe_request(host, mrq);
454 if (err)
455 goto out_err;
456
457 trace_mmc_request_start(host, mrq);
458
459 return 0;
460
461out_err:
462 if (mrq->cmd) {
463 pr_debug("%s: failed to start CQE direct CMD%u, error %d\n",
464 mmc_hostname(host), mrq->cmd->opcode, err);
465 } else {
466 pr_debug("%s: failed to start CQE transfer for tag %d, error %d\n",
467 mmc_hostname(host), mrq->tag, err);
468 }
469 return err;
470}
471EXPORT_SYMBOL(mmc_cqe_start_req);
472
473/**
474 * mmc_cqe_request_done - CQE has finished processing an MMC request
475 * @host: MMC host which completed request
476 * @mrq: MMC request which completed
477 *
478 * CQE drivers should call this function when they have completed
479 * their processing of a request.
480 */
481void mmc_cqe_request_done(struct mmc_host *host, struct mmc_request *mrq)
482{
483 mmc_should_fail_request(host, mrq);
484
485 /* Flag re-tuning needed on CRC errors */
486 if ((mrq->cmd && mrq->cmd->error == -EILSEQ) ||
487 (mrq->data && mrq->data->error == -EILSEQ))
488 mmc_retune_needed(host);
489
490 trace_mmc_request_done(host, mrq);
491
492 if (mrq->cmd) {
493 pr_debug("%s: CQE req done (direct CMD%u): %d\n",
494 mmc_hostname(host), mrq->cmd->opcode, mrq->cmd->error);
495 } else {
496 pr_debug("%s: CQE transfer done tag %d\n",
497 mmc_hostname(host), mrq->tag);
498 }
499
500 if (mrq->data) {
501 pr_debug("%s: %d bytes transferred: %d\n",
502 mmc_hostname(host),
503 mrq->data->bytes_xfered, mrq->data->error);
504 }
505
506 mrq->done(mrq);
507}
508EXPORT_SYMBOL(mmc_cqe_request_done);
509
510/**
511 * mmc_cqe_post_req - CQE post process of a completed MMC request
512 * @host: MMC host
513 * @mrq: MMC request to be processed
514 */
515void mmc_cqe_post_req(struct mmc_host *host, struct mmc_request *mrq)
516{
517 if (host->cqe_ops->cqe_post_req)
518 host->cqe_ops->cqe_post_req(host, mrq);
519}
520EXPORT_SYMBOL(mmc_cqe_post_req);
521
522/* Arbitrary 1 second timeout */
523#define MMC_CQE_RECOVERY_TIMEOUT 1000
524
525/*
526 * mmc_cqe_recovery - Recover from CQE errors.
527 * @host: MMC host to recover
528 *
529 * Recovery consists of stopping CQE, stopping eMMC, discarding the queue
530 * in eMMC, and discarding the queue in CQE. CQE must call
531 * mmc_cqe_request_done() on all requests. An error is returned if the eMMC
532 * fails to discard its queue.
533 */
534int mmc_cqe_recovery(struct mmc_host *host)
535{
536 struct mmc_command cmd;
537 int err;
538
539 mmc_retune_hold_now(host);
540
541 /*
542 * Recovery is expected seldom, if at all, but it reduces performance,
543 * so make sure it is not completely silent.
544 */
545 pr_warn("%s: running CQE recovery\n", mmc_hostname(host));
546
547 host->cqe_ops->cqe_recovery_start(host);
548
549 memset(&cmd, 0, sizeof(cmd));
550 cmd.opcode = MMC_STOP_TRANSMISSION;
551 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC;
552 cmd.flags &= ~MMC_RSP_CRC; /* Ignore CRC */
553 cmd.busy_timeout = MMC_CQE_RECOVERY_TIMEOUT;
554 mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
555
556 mmc_poll_for_busy(host->card, MMC_CQE_RECOVERY_TIMEOUT, true, MMC_BUSY_IO);
557
558 memset(&cmd, 0, sizeof(cmd));
559 cmd.opcode = MMC_CMDQ_TASK_MGMT;
560 cmd.arg = 1; /* Discard entire queue */
561 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC;
562 cmd.flags &= ~MMC_RSP_CRC; /* Ignore CRC */
563 cmd.busy_timeout = MMC_CQE_RECOVERY_TIMEOUT;
564 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
565
566 host->cqe_ops->cqe_recovery_finish(host);
567
568 if (err)
569 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
570
571 mmc_retune_release(host);
572
573 return err;
574}
575EXPORT_SYMBOL(mmc_cqe_recovery);
576
577/**
578 * mmc_is_req_done - Determine if a 'cap_cmd_during_tfr' request is done
579 * @host: MMC host
580 * @mrq: MMC request
581 *
582 * mmc_is_req_done() is used with requests that have
583 * mrq->cap_cmd_during_tfr = true. mmc_is_req_done() must be called after
584 * starting a request and before waiting for it to complete. That is,
585 * either in between calls to mmc_start_req(), or after mmc_wait_for_req()
586 * and before mmc_wait_for_req_done(). If it is called at other times the
587 * result is not meaningful.
588 */
589bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq)
590{
591 return completion_done(&mrq->completion);
592}
593EXPORT_SYMBOL(mmc_is_req_done);
594
595/**
596 * mmc_wait_for_req - start a request and wait for completion
597 * @host: MMC host to start command
598 * @mrq: MMC request to start
599 *
600 * Start a new MMC custom command request for a host, and wait
601 * for the command to complete. In the case of 'cap_cmd_during_tfr'
602 * requests, the transfer is ongoing and the caller can issue further
603 * commands that do not use the data lines, and then wait by calling
604 * mmc_wait_for_req_done().
605 * Does not attempt to parse the response.
606 */
607void mmc_wait_for_req(struct mmc_host *host, struct mmc_request *mrq)
608{
609 __mmc_start_req(host, mrq);
610
611 if (!mrq->cap_cmd_during_tfr)
612 mmc_wait_for_req_done(host, mrq);
613}
614EXPORT_SYMBOL(mmc_wait_for_req);
615
616/**
617 * mmc_wait_for_cmd - start a command and wait for completion
618 * @host: MMC host to start command
619 * @cmd: MMC command to start
620 * @retries: maximum number of retries
621 *
622 * Start a new MMC command for a host, and wait for the command
623 * to complete. Return any error that occurred while the command
624 * was executing. Do not attempt to parse the response.
625 */
626int mmc_wait_for_cmd(struct mmc_host *host, struct mmc_command *cmd, int retries)
627{
628 struct mmc_request mrq = {};
629
630 WARN_ON(!host->claimed);
631
632 memset(cmd->resp, 0, sizeof(cmd->resp));
633 cmd->retries = retries;
634
635 mrq.cmd = cmd;
636 cmd->data = NULL;
637
638 mmc_wait_for_req(host, &mrq);
639
640 return cmd->error;
641}
642
643EXPORT_SYMBOL(mmc_wait_for_cmd);
644
645/**
646 * mmc_set_data_timeout - set the timeout for a data command
647 * @data: data phase for command
648 * @card: the MMC card associated with the data transfer
649 *
650 * Computes the data timeout parameters according to the
651 * correct algorithm given the card type.
652 */
653void mmc_set_data_timeout(struct mmc_data *data, const struct mmc_card *card)
654{
655 unsigned int mult;
656
657 /*
658 * SDIO cards only define an upper 1 s limit on access.
659 */
660 if (mmc_card_sdio(card)) {
661 data->timeout_ns = 1000000000;
662 data->timeout_clks = 0;
663 return;
664 }
665
666 /*
667 * SD cards use a 100 multiplier rather than 10
668 */
669 mult = mmc_card_sd(card) ? 100 : 10;
670
671 /*
672 * Scale up the multiplier (and therefore the timeout) by
673 * the r2w factor for writes.
674 */
675 if (data->flags & MMC_DATA_WRITE)
676 mult <<= card->csd.r2w_factor;
677
678 data->timeout_ns = card->csd.taac_ns * mult;
679 data->timeout_clks = card->csd.taac_clks * mult;
680
681 /*
682 * SD cards also have an upper limit on the timeout.
683 */
684 if (mmc_card_sd(card)) {
685 unsigned int timeout_us, limit_us;
686
687 timeout_us = data->timeout_ns / 1000;
688 if (card->host->ios.clock)
689 timeout_us += data->timeout_clks * 1000 /
690 (card->host->ios.clock / 1000);
691
692 if (data->flags & MMC_DATA_WRITE)
693 /*
694 * The MMC spec "It is strongly recommended
695 * for hosts to implement more than 500ms
696 * timeout value even if the card indicates
697 * the 250ms maximum busy length." Even the
698 * previous value of 300ms is known to be
699 * insufficient for some cards.
700 */
701 limit_us = 3000000;
702 else
703 limit_us = 100000;
704
705 /*
706 * SDHC cards always use these fixed values.
707 */
708 if (timeout_us > limit_us) {
709 data->timeout_ns = limit_us * 1000;
710 data->timeout_clks = 0;
711 }
712
713 /* assign limit value if invalid */
714 if (timeout_us == 0)
715 data->timeout_ns = limit_us * 1000;
716 }
717
718 /*
719 * Some cards require longer data read timeout than indicated in CSD.
720 * Address this by setting the read timeout to a "reasonably high"
721 * value. For the cards tested, 600ms has proven enough. If necessary,
722 * this value can be increased if other problematic cards require this.
723 */
724 if (mmc_card_long_read_time(card) && data->flags & MMC_DATA_READ) {
725 data->timeout_ns = 600000000;
726 data->timeout_clks = 0;
727 }
728
729 /*
730 * Some cards need very high timeouts if driven in SPI mode.
731 * The worst observed timeout was 900ms after writing a
732 * continuous stream of data until the internal logic
733 * overflowed.
734 */
735 if (mmc_host_is_spi(card->host)) {
736 if (data->flags & MMC_DATA_WRITE) {
737 if (data->timeout_ns < 1000000000)
738 data->timeout_ns = 1000000000; /* 1s */
739 } else {
740 if (data->timeout_ns < 100000000)
741 data->timeout_ns = 100000000; /* 100ms */
742 }
743 }
744}
745EXPORT_SYMBOL(mmc_set_data_timeout);
746
747/*
748 * Allow claiming an already claimed host if the context is the same or there is
749 * no context but the task is the same.
750 */
751static inline bool mmc_ctx_matches(struct mmc_host *host, struct mmc_ctx *ctx,
752 struct task_struct *task)
753{
754 return host->claimer == ctx ||
755 (!ctx && task && host->claimer->task == task);
756}
757
758static inline void mmc_ctx_set_claimer(struct mmc_host *host,
759 struct mmc_ctx *ctx,
760 struct task_struct *task)
761{
762 if (!host->claimer) {
763 if (ctx)
764 host->claimer = ctx;
765 else
766 host->claimer = &host->default_ctx;
767 }
768 if (task)
769 host->claimer->task = task;
770}
771
772/**
773 * __mmc_claim_host - exclusively claim a host
774 * @host: mmc host to claim
775 * @ctx: context that claims the host or NULL in which case the default
776 * context will be used
777 * @abort: whether or not the operation should be aborted
778 *
779 * Claim a host for a set of operations. If @abort is non null and
780 * dereference a non-zero value then this will return prematurely with
781 * that non-zero value without acquiring the lock. Returns zero
782 * with the lock held otherwise.
783 */
784int __mmc_claim_host(struct mmc_host *host, struct mmc_ctx *ctx,
785 atomic_t *abort)
786{
787 struct task_struct *task = ctx ? NULL : current;
788 DECLARE_WAITQUEUE(wait, current);
789 unsigned long flags;
790 int stop;
791 bool pm = false;
792
793 might_sleep();
794
795 add_wait_queue(&host->wq, &wait);
796 spin_lock_irqsave(&host->lock, flags);
797 while (1) {
798 set_current_state(TASK_UNINTERRUPTIBLE);
799 stop = abort ? atomic_read(abort) : 0;
800 if (stop || !host->claimed || mmc_ctx_matches(host, ctx, task))
801 break;
802 spin_unlock_irqrestore(&host->lock, flags);
803 schedule();
804 spin_lock_irqsave(&host->lock, flags);
805 }
806 set_current_state(TASK_RUNNING);
807 if (!stop) {
808 host->claimed = 1;
809 mmc_ctx_set_claimer(host, ctx, task);
810 host->claim_cnt += 1;
811 if (host->claim_cnt == 1)
812 pm = true;
813 } else
814 wake_up(&host->wq);
815 spin_unlock_irqrestore(&host->lock, flags);
816 remove_wait_queue(&host->wq, &wait);
817
818 if (pm)
819 pm_runtime_get_sync(mmc_dev(host));
820
821 return stop;
822}
823EXPORT_SYMBOL(__mmc_claim_host);
824
825/**
826 * mmc_release_host - release a host
827 * @host: mmc host to release
828 *
829 * Release a MMC host, allowing others to claim the host
830 * for their operations.
831 */
832void mmc_release_host(struct mmc_host *host)
833{
834 unsigned long flags;
835
836 WARN_ON(!host->claimed);
837
838 spin_lock_irqsave(&host->lock, flags);
839 if (--host->claim_cnt) {
840 /* Release for nested claim */
841 spin_unlock_irqrestore(&host->lock, flags);
842 } else {
843 host->claimed = 0;
844 host->claimer->task = NULL;
845 host->claimer = NULL;
846 spin_unlock_irqrestore(&host->lock, flags);
847 wake_up(&host->wq);
848 pm_runtime_mark_last_busy(mmc_dev(host));
849 if (host->caps & MMC_CAP_SYNC_RUNTIME_PM)
850 pm_runtime_put_sync_suspend(mmc_dev(host));
851 else
852 pm_runtime_put_autosuspend(mmc_dev(host));
853 }
854}
855EXPORT_SYMBOL(mmc_release_host);
856
857/*
858 * This is a helper function, which fetches a runtime pm reference for the
859 * card device and also claims the host.
860 */
861void mmc_get_card(struct mmc_card *card, struct mmc_ctx *ctx)
862{
863 pm_runtime_get_sync(&card->dev);
864 __mmc_claim_host(card->host, ctx, NULL);
865}
866EXPORT_SYMBOL(mmc_get_card);
867
868/*
869 * This is a helper function, which releases the host and drops the runtime
870 * pm reference for the card device.
871 */
872void mmc_put_card(struct mmc_card *card, struct mmc_ctx *ctx)
873{
874 struct mmc_host *host = card->host;
875
876 WARN_ON(ctx && host->claimer != ctx);
877
878 mmc_release_host(host);
879 pm_runtime_mark_last_busy(&card->dev);
880 pm_runtime_put_autosuspend(&card->dev);
881}
882EXPORT_SYMBOL(mmc_put_card);
883
884/*
885 * Internal function that does the actual ios call to the host driver,
886 * optionally printing some debug output.
887 */
888static inline void mmc_set_ios(struct mmc_host *host)
889{
890 struct mmc_ios *ios = &host->ios;
891
892 pr_debug("%s: clock %uHz busmode %u powermode %u cs %u Vdd %u "
893 "width %u timing %u\n",
894 mmc_hostname(host), ios->clock, ios->bus_mode,
895 ios->power_mode, ios->chip_select, ios->vdd,
896 1 << ios->bus_width, ios->timing);
897
898 host->ops->set_ios(host, ios);
899}
900
901/*
902 * Control chip select pin on a host.
903 */
904void mmc_set_chip_select(struct mmc_host *host, int mode)
905{
906 host->ios.chip_select = mode;
907 mmc_set_ios(host);
908}
909
910/*
911 * Sets the host clock to the highest possible frequency that
912 * is below "hz".
913 */
914void mmc_set_clock(struct mmc_host *host, unsigned int hz)
915{
916 WARN_ON(hz && hz < host->f_min);
917
918 if (hz > host->f_max)
919 hz = host->f_max;
920
921 host->ios.clock = hz;
922 mmc_set_ios(host);
923}
924
925int mmc_execute_tuning(struct mmc_card *card)
926{
927 struct mmc_host *host = card->host;
928 u32 opcode;
929 int err;
930
931 if (!host->ops->execute_tuning)
932 return 0;
933
934 if (host->cqe_on)
935 host->cqe_ops->cqe_off(host);
936
937 if (mmc_card_mmc(card))
938 opcode = MMC_SEND_TUNING_BLOCK_HS200;
939 else
940 opcode = MMC_SEND_TUNING_BLOCK;
941
942 err = host->ops->execute_tuning(host, opcode);
943 if (!err) {
944 mmc_retune_clear(host);
945 mmc_retune_enable(host);
946 return 0;
947 }
948
949 /* Only print error when we don't check for card removal */
950 if (!host->detect_change) {
951 pr_err("%s: tuning execution failed: %d\n",
952 mmc_hostname(host), err);
953 mmc_debugfs_err_stats_inc(host, MMC_ERR_TUNING);
954 }
955
956 return err;
957}
958
959/*
960 * Change the bus mode (open drain/push-pull) of a host.
961 */
962void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode)
963{
964 host->ios.bus_mode = mode;
965 mmc_set_ios(host);
966}
967
968/*
969 * Change data bus width of a host.
970 */
971void mmc_set_bus_width(struct mmc_host *host, unsigned int width)
972{
973 host->ios.bus_width = width;
974 mmc_set_ios(host);
975}
976
977/*
978 * Set initial state after a power cycle or a hw_reset.
979 */
980void mmc_set_initial_state(struct mmc_host *host)
981{
982 if (host->cqe_on)
983 host->cqe_ops->cqe_off(host);
984
985 mmc_retune_disable(host);
986
987 if (mmc_host_is_spi(host))
988 host->ios.chip_select = MMC_CS_HIGH;
989 else
990 host->ios.chip_select = MMC_CS_DONTCARE;
991 host->ios.bus_mode = MMC_BUSMODE_PUSHPULL;
992 host->ios.bus_width = MMC_BUS_WIDTH_1;
993 host->ios.timing = MMC_TIMING_LEGACY;
994 host->ios.drv_type = 0;
995 host->ios.enhanced_strobe = false;
996
997 /*
998 * Make sure we are in non-enhanced strobe mode before we
999 * actually enable it in ext_csd.
1000 */
1001 if ((host->caps2 & MMC_CAP2_HS400_ES) &&
1002 host->ops->hs400_enhanced_strobe)
1003 host->ops->hs400_enhanced_strobe(host, &host->ios);
1004
1005 mmc_set_ios(host);
1006
1007 mmc_crypto_set_initial_state(host);
1008}
1009
1010/**
1011 * mmc_vdd_to_ocrbitnum - Convert a voltage to the OCR bit number
1012 * @vdd: voltage (mV)
1013 * @low_bits: prefer low bits in boundary cases
1014 *
1015 * This function returns the OCR bit number according to the provided @vdd
1016 * value. If conversion is not possible a negative errno value returned.
1017 *
1018 * Depending on the @low_bits flag the function prefers low or high OCR bits
1019 * on boundary voltages. For example,
1020 * with @low_bits = true, 3300 mV translates to ilog2(MMC_VDD_32_33);
1021 * with @low_bits = false, 3300 mV translates to ilog2(MMC_VDD_33_34);
1022 *
1023 * Any value in the [1951:1999] range translates to the ilog2(MMC_VDD_20_21).
1024 */
1025static int mmc_vdd_to_ocrbitnum(int vdd, bool low_bits)
1026{
1027 const int max_bit = ilog2(MMC_VDD_35_36);
1028 int bit;
1029
1030 if (vdd < 1650 || vdd > 3600)
1031 return -EINVAL;
1032
1033 if (vdd >= 1650 && vdd <= 1950)
1034 return ilog2(MMC_VDD_165_195);
1035
1036 if (low_bits)
1037 vdd -= 1;
1038
1039 /* Base 2000 mV, step 100 mV, bit's base 8. */
1040 bit = (vdd - 2000) / 100 + 8;
1041 if (bit > max_bit)
1042 return max_bit;
1043 return bit;
1044}
1045
1046/**
1047 * mmc_vddrange_to_ocrmask - Convert a voltage range to the OCR mask
1048 * @vdd_min: minimum voltage value (mV)
1049 * @vdd_max: maximum voltage value (mV)
1050 *
1051 * This function returns the OCR mask bits according to the provided @vdd_min
1052 * and @vdd_max values. If conversion is not possible the function returns 0.
1053 *
1054 * Notes wrt boundary cases:
1055 * This function sets the OCR bits for all boundary voltages, for example
1056 * [3300:3400] range is translated to MMC_VDD_32_33 | MMC_VDD_33_34 |
1057 * MMC_VDD_34_35 mask.
1058 */
1059u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max)
1060{
1061 u32 mask = 0;
1062
1063 if (vdd_max < vdd_min)
1064 return 0;
1065
1066 /* Prefer high bits for the boundary vdd_max values. */
1067 vdd_max = mmc_vdd_to_ocrbitnum(vdd_max, false);
1068 if (vdd_max < 0)
1069 return 0;
1070
1071 /* Prefer low bits for the boundary vdd_min values. */
1072 vdd_min = mmc_vdd_to_ocrbitnum(vdd_min, true);
1073 if (vdd_min < 0)
1074 return 0;
1075
1076 /* Fill the mask, from max bit to min bit. */
1077 while (vdd_max >= vdd_min)
1078 mask |= 1 << vdd_max--;
1079
1080 return mask;
1081}
1082
1083static int mmc_of_get_func_num(struct device_node *node)
1084{
1085 u32 reg;
1086 int ret;
1087
1088 ret = of_property_read_u32(node, "reg", ®);
1089 if (ret < 0)
1090 return ret;
1091
1092 return reg;
1093}
1094
1095struct device_node *mmc_of_find_child_device(struct mmc_host *host,
1096 unsigned func_num)
1097{
1098 struct device_node *node;
1099
1100 if (!host->parent || !host->parent->of_node)
1101 return NULL;
1102
1103 for_each_child_of_node(host->parent->of_node, node) {
1104 if (mmc_of_get_func_num(node) == func_num)
1105 return node;
1106 }
1107
1108 return NULL;
1109}
1110
1111/*
1112 * Mask off any voltages we don't support and select
1113 * the lowest voltage
1114 */
1115u32 mmc_select_voltage(struct mmc_host *host, u32 ocr)
1116{
1117 int bit;
1118
1119 /*
1120 * Sanity check the voltages that the card claims to
1121 * support.
1122 */
1123 if (ocr & 0x7F) {
1124 dev_warn(mmc_dev(host),
1125 "card claims to support voltages below defined range\n");
1126 ocr &= ~0x7F;
1127 }
1128
1129 ocr &= host->ocr_avail;
1130 if (!ocr) {
1131 dev_warn(mmc_dev(host), "no support for card's volts\n");
1132 return 0;
1133 }
1134
1135 if (host->caps2 & MMC_CAP2_FULL_PWR_CYCLE) {
1136 bit = ffs(ocr) - 1;
1137 ocr &= 3 << bit;
1138 mmc_power_cycle(host, ocr);
1139 } else {
1140 bit = fls(ocr) - 1;
1141 /*
1142 * The bit variable represents the highest voltage bit set in
1143 * the OCR register.
1144 * To keep a range of 2 values (e.g. 3.2V/3.3V and 3.3V/3.4V),
1145 * we must shift the mask '3' with (bit - 1).
1146 */
1147 ocr &= 3 << (bit - 1);
1148 if (bit != host->ios.vdd)
1149 dev_warn(mmc_dev(host), "exceeding card's volts\n");
1150 }
1151
1152 return ocr;
1153}
1154
1155int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage)
1156{
1157 int err = 0;
1158 int old_signal_voltage = host->ios.signal_voltage;
1159
1160 host->ios.signal_voltage = signal_voltage;
1161 if (host->ops->start_signal_voltage_switch)
1162 err = host->ops->start_signal_voltage_switch(host, &host->ios);
1163
1164 if (err)
1165 host->ios.signal_voltage = old_signal_voltage;
1166
1167 return err;
1168
1169}
1170
1171void mmc_set_initial_signal_voltage(struct mmc_host *host)
1172{
1173 /* Try to set signal voltage to 3.3V but fall back to 1.8v or 1.2v */
1174 if (!mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_330))
1175 dev_dbg(mmc_dev(host), "Initial signal voltage of 3.3v\n");
1176 else if (!mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_180))
1177 dev_dbg(mmc_dev(host), "Initial signal voltage of 1.8v\n");
1178 else if (!mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_120))
1179 dev_dbg(mmc_dev(host), "Initial signal voltage of 1.2v\n");
1180}
1181
1182int mmc_host_set_uhs_voltage(struct mmc_host *host)
1183{
1184 u32 clock;
1185
1186 /*
1187 * During a signal voltage level switch, the clock must be gated
1188 * for 5 ms according to the SD spec
1189 */
1190 clock = host->ios.clock;
1191 host->ios.clock = 0;
1192 mmc_set_ios(host);
1193
1194 if (mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_180))
1195 return -EAGAIN;
1196
1197 /* Keep clock gated for at least 10 ms, though spec only says 5 ms */
1198 mmc_delay(10);
1199 host->ios.clock = clock;
1200 mmc_set_ios(host);
1201
1202 return 0;
1203}
1204
1205int mmc_set_uhs_voltage(struct mmc_host *host, u32 ocr)
1206{
1207 struct mmc_command cmd = {};
1208 int err = 0;
1209
1210 /*
1211 * If we cannot switch voltages, return failure so the caller
1212 * can continue without UHS mode
1213 */
1214 if (!host->ops->start_signal_voltage_switch)
1215 return -EPERM;
1216 if (!host->ops->card_busy)
1217 pr_warn("%s: cannot verify signal voltage switch\n",
1218 mmc_hostname(host));
1219
1220 cmd.opcode = SD_SWITCH_VOLTAGE;
1221 cmd.arg = 0;
1222 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1223
1224 err = mmc_wait_for_cmd(host, &cmd, 0);
1225 if (err)
1226 goto power_cycle;
1227
1228 if (!mmc_host_is_spi(host) && (cmd.resp[0] & R1_ERROR))
1229 return -EIO;
1230
1231 /*
1232 * The card should drive cmd and dat[0:3] low immediately
1233 * after the response of cmd11, but wait 1 ms to be sure
1234 */
1235 mmc_delay(1);
1236 if (host->ops->card_busy && !host->ops->card_busy(host)) {
1237 err = -EAGAIN;
1238 goto power_cycle;
1239 }
1240
1241 if (mmc_host_set_uhs_voltage(host)) {
1242 /*
1243 * Voltages may not have been switched, but we've already
1244 * sent CMD11, so a power cycle is required anyway
1245 */
1246 err = -EAGAIN;
1247 goto power_cycle;
1248 }
1249
1250 /* Wait for at least 1 ms according to spec */
1251 mmc_delay(1);
1252
1253 /*
1254 * Failure to switch is indicated by the card holding
1255 * dat[0:3] low
1256 */
1257 if (host->ops->card_busy && host->ops->card_busy(host))
1258 err = -EAGAIN;
1259
1260power_cycle:
1261 if (err) {
1262 pr_debug("%s: Signal voltage switch failed, "
1263 "power cycling card\n", mmc_hostname(host));
1264 mmc_power_cycle(host, ocr);
1265 }
1266
1267 return err;
1268}
1269
1270/*
1271 * Select timing parameters for host.
1272 */
1273void mmc_set_timing(struct mmc_host *host, unsigned int timing)
1274{
1275 host->ios.timing = timing;
1276 mmc_set_ios(host);
1277}
1278
1279/*
1280 * Select appropriate driver type for host.
1281 */
1282void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type)
1283{
1284 host->ios.drv_type = drv_type;
1285 mmc_set_ios(host);
1286}
1287
1288int mmc_select_drive_strength(struct mmc_card *card, unsigned int max_dtr,
1289 int card_drv_type, int *drv_type)
1290{
1291 struct mmc_host *host = card->host;
1292 int host_drv_type = SD_DRIVER_TYPE_B;
1293
1294 *drv_type = 0;
1295
1296 if (!host->ops->select_drive_strength)
1297 return 0;
1298
1299 /* Use SD definition of driver strength for hosts */
1300 if (host->caps & MMC_CAP_DRIVER_TYPE_A)
1301 host_drv_type |= SD_DRIVER_TYPE_A;
1302
1303 if (host->caps & MMC_CAP_DRIVER_TYPE_C)
1304 host_drv_type |= SD_DRIVER_TYPE_C;
1305
1306 if (host->caps & MMC_CAP_DRIVER_TYPE_D)
1307 host_drv_type |= SD_DRIVER_TYPE_D;
1308
1309 /*
1310 * The drive strength that the hardware can support
1311 * depends on the board design. Pass the appropriate
1312 * information and let the hardware specific code
1313 * return what is possible given the options
1314 */
1315 return host->ops->select_drive_strength(card, max_dtr,
1316 host_drv_type,
1317 card_drv_type,
1318 drv_type);
1319}
1320
1321/*
1322 * Apply power to the MMC stack. This is a two-stage process.
1323 * First, we enable power to the card without the clock running.
1324 * We then wait a bit for the power to stabilise. Finally,
1325 * enable the bus drivers and clock to the card.
1326 *
1327 * We must _NOT_ enable the clock prior to power stablising.
1328 *
1329 * If a host does all the power sequencing itself, ignore the
1330 * initial MMC_POWER_UP stage.
1331 */
1332void mmc_power_up(struct mmc_host *host, u32 ocr)
1333{
1334 if (host->ios.power_mode == MMC_POWER_ON)
1335 return;
1336
1337 mmc_pwrseq_pre_power_on(host);
1338
1339 host->ios.vdd = fls(ocr) - 1;
1340 host->ios.power_mode = MMC_POWER_UP;
1341 /* Set initial state and call mmc_set_ios */
1342 mmc_set_initial_state(host);
1343
1344 mmc_set_initial_signal_voltage(host);
1345
1346 /*
1347 * This delay should be sufficient to allow the power supply
1348 * to reach the minimum voltage.
1349 */
1350 mmc_delay(host->ios.power_delay_ms);
1351
1352 mmc_pwrseq_post_power_on(host);
1353
1354 host->ios.clock = host->f_init;
1355
1356 host->ios.power_mode = MMC_POWER_ON;
1357 mmc_set_ios(host);
1358
1359 /*
1360 * This delay must be at least 74 clock sizes, or 1 ms, or the
1361 * time required to reach a stable voltage.
1362 */
1363 mmc_delay(host->ios.power_delay_ms);
1364}
1365
1366void mmc_power_off(struct mmc_host *host)
1367{
1368 if (host->ios.power_mode == MMC_POWER_OFF)
1369 return;
1370
1371 mmc_pwrseq_power_off(host);
1372
1373 host->ios.clock = 0;
1374 host->ios.vdd = 0;
1375
1376 host->ios.power_mode = MMC_POWER_OFF;
1377 /* Set initial state and call mmc_set_ios */
1378 mmc_set_initial_state(host);
1379
1380 /*
1381 * Some configurations, such as the 802.11 SDIO card in the OLPC
1382 * XO-1.5, require a short delay after poweroff before the card
1383 * can be successfully turned on again.
1384 */
1385 mmc_delay(1);
1386}
1387
1388void mmc_power_cycle(struct mmc_host *host, u32 ocr)
1389{
1390 mmc_power_off(host);
1391 /* Wait at least 1 ms according to SD spec */
1392 mmc_delay(1);
1393 mmc_power_up(host, ocr);
1394}
1395
1396/*
1397 * Assign a mmc bus handler to a host. Only one bus handler may control a
1398 * host at any given time.
1399 */
1400void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops)
1401{
1402 host->bus_ops = ops;
1403}
1404
1405/*
1406 * Remove the current bus handler from a host.
1407 */
1408void mmc_detach_bus(struct mmc_host *host)
1409{
1410 host->bus_ops = NULL;
1411}
1412
1413void _mmc_detect_change(struct mmc_host *host, unsigned long delay, bool cd_irq)
1414{
1415 /*
1416 * Prevent system sleep for 5s to allow user space to consume the
1417 * corresponding uevent. This is especially useful, when CD irq is used
1418 * as a system wakeup, but doesn't hurt in other cases.
1419 */
1420 if (cd_irq && !(host->caps & MMC_CAP_NEEDS_POLL))
1421 __pm_wakeup_event(host->ws, 5000);
1422
1423 host->detect_change = 1;
1424 mmc_schedule_delayed_work(&host->detect, delay);
1425}
1426
1427/**
1428 * mmc_detect_change - process change of state on a MMC socket
1429 * @host: host which changed state.
1430 * @delay: optional delay to wait before detection (jiffies)
1431 *
1432 * MMC drivers should call this when they detect a card has been
1433 * inserted or removed. The MMC layer will confirm that any
1434 * present card is still functional, and initialize any newly
1435 * inserted.
1436 */
1437void mmc_detect_change(struct mmc_host *host, unsigned long delay)
1438{
1439 _mmc_detect_change(host, delay, true);
1440}
1441EXPORT_SYMBOL(mmc_detect_change);
1442
1443void mmc_init_erase(struct mmc_card *card)
1444{
1445 unsigned int sz;
1446
1447 if (is_power_of_2(card->erase_size))
1448 card->erase_shift = ffs(card->erase_size) - 1;
1449 else
1450 card->erase_shift = 0;
1451
1452 /*
1453 * It is possible to erase an arbitrarily large area of an SD or MMC
1454 * card. That is not desirable because it can take a long time
1455 * (minutes) potentially delaying more important I/O, and also the
1456 * timeout calculations become increasingly hugely over-estimated.
1457 * Consequently, 'pref_erase' is defined as a guide to limit erases
1458 * to that size and alignment.
1459 *
1460 * For SD cards that define Allocation Unit size, limit erases to one
1461 * Allocation Unit at a time.
1462 * For MMC, have a stab at ai good value and for modern cards it will
1463 * end up being 4MiB. Note that if the value is too small, it can end
1464 * up taking longer to erase. Also note, erase_size is already set to
1465 * High Capacity Erase Size if available when this function is called.
1466 */
1467 if (mmc_card_sd(card) && card->ssr.au) {
1468 card->pref_erase = card->ssr.au;
1469 card->erase_shift = ffs(card->ssr.au) - 1;
1470 } else if (card->erase_size) {
1471 sz = (card->csd.capacity << (card->csd.read_blkbits - 9)) >> 11;
1472 if (sz < 128)
1473 card->pref_erase = 512 * 1024 / 512;
1474 else if (sz < 512)
1475 card->pref_erase = 1024 * 1024 / 512;
1476 else if (sz < 1024)
1477 card->pref_erase = 2 * 1024 * 1024 / 512;
1478 else
1479 card->pref_erase = 4 * 1024 * 1024 / 512;
1480 if (card->pref_erase < card->erase_size)
1481 card->pref_erase = card->erase_size;
1482 else {
1483 sz = card->pref_erase % card->erase_size;
1484 if (sz)
1485 card->pref_erase += card->erase_size - sz;
1486 }
1487 } else
1488 card->pref_erase = 0;
1489}
1490
1491static bool is_trim_arg(unsigned int arg)
1492{
1493 return (arg & MMC_TRIM_OR_DISCARD_ARGS) && arg != MMC_DISCARD_ARG;
1494}
1495
1496static unsigned int mmc_mmc_erase_timeout(struct mmc_card *card,
1497 unsigned int arg, unsigned int qty)
1498{
1499 unsigned int erase_timeout;
1500
1501 if (arg == MMC_DISCARD_ARG ||
1502 (arg == MMC_TRIM_ARG && card->ext_csd.rev >= 6)) {
1503 erase_timeout = card->ext_csd.trim_timeout;
1504 } else if (card->ext_csd.erase_group_def & 1) {
1505 /* High Capacity Erase Group Size uses HC timeouts */
1506 if (arg == MMC_TRIM_ARG)
1507 erase_timeout = card->ext_csd.trim_timeout;
1508 else
1509 erase_timeout = card->ext_csd.hc_erase_timeout;
1510 } else {
1511 /* CSD Erase Group Size uses write timeout */
1512 unsigned int mult = (10 << card->csd.r2w_factor);
1513 unsigned int timeout_clks = card->csd.taac_clks * mult;
1514 unsigned int timeout_us;
1515
1516 /* Avoid overflow: e.g. taac_ns=80000000 mult=1280 */
1517 if (card->csd.taac_ns < 1000000)
1518 timeout_us = (card->csd.taac_ns * mult) / 1000;
1519 else
1520 timeout_us = (card->csd.taac_ns / 1000) * mult;
1521
1522 /*
1523 * ios.clock is only a target. The real clock rate might be
1524 * less but not that much less, so fudge it by multiplying by 2.
1525 */
1526 timeout_clks <<= 1;
1527 timeout_us += (timeout_clks * 1000) /
1528 (card->host->ios.clock / 1000);
1529
1530 erase_timeout = timeout_us / 1000;
1531
1532 /*
1533 * Theoretically, the calculation could underflow so round up
1534 * to 1ms in that case.
1535 */
1536 if (!erase_timeout)
1537 erase_timeout = 1;
1538 }
1539
1540 /* Multiplier for secure operations */
1541 if (arg & MMC_SECURE_ARGS) {
1542 if (arg == MMC_SECURE_ERASE_ARG)
1543 erase_timeout *= card->ext_csd.sec_erase_mult;
1544 else
1545 erase_timeout *= card->ext_csd.sec_trim_mult;
1546 }
1547
1548 erase_timeout *= qty;
1549
1550 /*
1551 * Ensure at least a 1 second timeout for SPI as per
1552 * 'mmc_set_data_timeout()'
1553 */
1554 if (mmc_host_is_spi(card->host) && erase_timeout < 1000)
1555 erase_timeout = 1000;
1556
1557 return erase_timeout;
1558}
1559
1560static unsigned int mmc_sd_erase_timeout(struct mmc_card *card,
1561 unsigned int arg,
1562 unsigned int qty)
1563{
1564 unsigned int erase_timeout;
1565
1566 /* for DISCARD none of the below calculation applies.
1567 * the busy timeout is 250msec per discard command.
1568 */
1569 if (arg == SD_DISCARD_ARG)
1570 return SD_DISCARD_TIMEOUT_MS;
1571
1572 if (card->ssr.erase_timeout) {
1573 /* Erase timeout specified in SD Status Register (SSR) */
1574 erase_timeout = card->ssr.erase_timeout * qty +
1575 card->ssr.erase_offset;
1576 } else {
1577 /*
1578 * Erase timeout not specified in SD Status Register (SSR) so
1579 * use 250ms per write block.
1580 */
1581 erase_timeout = 250 * qty;
1582 }
1583
1584 /* Must not be less than 1 second */
1585 if (erase_timeout < 1000)
1586 erase_timeout = 1000;
1587
1588 return erase_timeout;
1589}
1590
1591static unsigned int mmc_erase_timeout(struct mmc_card *card,
1592 unsigned int arg,
1593 unsigned int qty)
1594{
1595 if (mmc_card_sd(card))
1596 return mmc_sd_erase_timeout(card, arg, qty);
1597 else
1598 return mmc_mmc_erase_timeout(card, arg, qty);
1599}
1600
1601static int mmc_do_erase(struct mmc_card *card, unsigned int from,
1602 unsigned int to, unsigned int arg)
1603{
1604 struct mmc_command cmd = {};
1605 unsigned int qty = 0, busy_timeout = 0;
1606 bool use_r1b_resp;
1607 int err;
1608
1609 mmc_retune_hold(card->host);
1610
1611 /*
1612 * qty is used to calculate the erase timeout which depends on how many
1613 * erase groups (or allocation units in SD terminology) are affected.
1614 * We count erasing part of an erase group as one erase group.
1615 * For SD, the allocation units are always a power of 2. For MMC, the
1616 * erase group size is almost certainly also power of 2, but it does not
1617 * seem to insist on that in the JEDEC standard, so we fall back to
1618 * division in that case. SD may not specify an allocation unit size,
1619 * in which case the timeout is based on the number of write blocks.
1620 *
1621 * Note that the timeout for secure trim 2 will only be correct if the
1622 * number of erase groups specified is the same as the total of all
1623 * preceding secure trim 1 commands. Since the power may have been
1624 * lost since the secure trim 1 commands occurred, it is generally
1625 * impossible to calculate the secure trim 2 timeout correctly.
1626 */
1627 if (card->erase_shift)
1628 qty += ((to >> card->erase_shift) -
1629 (from >> card->erase_shift)) + 1;
1630 else if (mmc_card_sd(card))
1631 qty += to - from + 1;
1632 else
1633 qty += ((to / card->erase_size) -
1634 (from / card->erase_size)) + 1;
1635
1636 if (!mmc_card_blockaddr(card)) {
1637 from <<= 9;
1638 to <<= 9;
1639 }
1640
1641 if (mmc_card_sd(card))
1642 cmd.opcode = SD_ERASE_WR_BLK_START;
1643 else
1644 cmd.opcode = MMC_ERASE_GROUP_START;
1645 cmd.arg = from;
1646 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1647 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1648 if (err) {
1649 pr_err("mmc_erase: group start error %d, "
1650 "status %#x\n", err, cmd.resp[0]);
1651 err = -EIO;
1652 goto out;
1653 }
1654
1655 memset(&cmd, 0, sizeof(struct mmc_command));
1656 if (mmc_card_sd(card))
1657 cmd.opcode = SD_ERASE_WR_BLK_END;
1658 else
1659 cmd.opcode = MMC_ERASE_GROUP_END;
1660 cmd.arg = to;
1661 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1662 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1663 if (err) {
1664 pr_err("mmc_erase: group end error %d, status %#x\n",
1665 err, cmd.resp[0]);
1666 err = -EIO;
1667 goto out;
1668 }
1669
1670 memset(&cmd, 0, sizeof(struct mmc_command));
1671 cmd.opcode = MMC_ERASE;
1672 cmd.arg = arg;
1673 busy_timeout = mmc_erase_timeout(card, arg, qty);
1674 use_r1b_resp = mmc_prepare_busy_cmd(card->host, &cmd, busy_timeout);
1675
1676 err = mmc_wait_for_cmd(card->host, &cmd, 0);
1677 if (err) {
1678 pr_err("mmc_erase: erase error %d, status %#x\n",
1679 err, cmd.resp[0]);
1680 err = -EIO;
1681 goto out;
1682 }
1683
1684 if (mmc_host_is_spi(card->host))
1685 goto out;
1686
1687 /*
1688 * In case of when R1B + MMC_CAP_WAIT_WHILE_BUSY is used, the polling
1689 * shall be avoided.
1690 */
1691 if ((card->host->caps & MMC_CAP_WAIT_WHILE_BUSY) && use_r1b_resp)
1692 goto out;
1693
1694 /* Let's poll to find out when the erase operation completes. */
1695 err = mmc_poll_for_busy(card, busy_timeout, false, MMC_BUSY_ERASE);
1696
1697out:
1698 mmc_retune_release(card->host);
1699 return err;
1700}
1701
1702static unsigned int mmc_align_erase_size(struct mmc_card *card,
1703 unsigned int *from,
1704 unsigned int *to,
1705 unsigned int nr)
1706{
1707 unsigned int from_new = *from, nr_new = nr, rem;
1708
1709 /*
1710 * When the 'card->erase_size' is power of 2, we can use round_up/down()
1711 * to align the erase size efficiently.
1712 */
1713 if (is_power_of_2(card->erase_size)) {
1714 unsigned int temp = from_new;
1715
1716 from_new = round_up(temp, card->erase_size);
1717 rem = from_new - temp;
1718
1719 if (nr_new > rem)
1720 nr_new -= rem;
1721 else
1722 return 0;
1723
1724 nr_new = round_down(nr_new, card->erase_size);
1725 } else {
1726 rem = from_new % card->erase_size;
1727 if (rem) {
1728 rem = card->erase_size - rem;
1729 from_new += rem;
1730 if (nr_new > rem)
1731 nr_new -= rem;
1732 else
1733 return 0;
1734 }
1735
1736 rem = nr_new % card->erase_size;
1737 if (rem)
1738 nr_new -= rem;
1739 }
1740
1741 if (nr_new == 0)
1742 return 0;
1743
1744 *to = from_new + nr_new;
1745 *from = from_new;
1746
1747 return nr_new;
1748}
1749
1750/**
1751 * mmc_erase - erase sectors.
1752 * @card: card to erase
1753 * @from: first sector to erase
1754 * @nr: number of sectors to erase
1755 * @arg: erase command argument
1756 *
1757 * Caller must claim host before calling this function.
1758 */
1759int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
1760 unsigned int arg)
1761{
1762 unsigned int rem, to = from + nr;
1763 int err;
1764
1765 if (!(card->csd.cmdclass & CCC_ERASE))
1766 return -EOPNOTSUPP;
1767
1768 if (!card->erase_size)
1769 return -EOPNOTSUPP;
1770
1771 if (mmc_card_sd(card) && arg != SD_ERASE_ARG && arg != SD_DISCARD_ARG)
1772 return -EOPNOTSUPP;
1773
1774 if (mmc_card_mmc(card) && (arg & MMC_SECURE_ARGS) &&
1775 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN))
1776 return -EOPNOTSUPP;
1777
1778 if (mmc_card_mmc(card) && is_trim_arg(arg) &&
1779 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN))
1780 return -EOPNOTSUPP;
1781
1782 if (arg == MMC_SECURE_ERASE_ARG) {
1783 if (from % card->erase_size || nr % card->erase_size)
1784 return -EINVAL;
1785 }
1786
1787 if (arg == MMC_ERASE_ARG)
1788 nr = mmc_align_erase_size(card, &from, &to, nr);
1789
1790 if (nr == 0)
1791 return 0;
1792
1793 if (to <= from)
1794 return -EINVAL;
1795
1796 /* 'from' and 'to' are inclusive */
1797 to -= 1;
1798
1799 /*
1800 * Special case where only one erase-group fits in the timeout budget:
1801 * If the region crosses an erase-group boundary on this particular
1802 * case, we will be trimming more than one erase-group which, does not
1803 * fit in the timeout budget of the controller, so we need to split it
1804 * and call mmc_do_erase() twice if necessary. This special case is
1805 * identified by the card->eg_boundary flag.
1806 */
1807 rem = card->erase_size - (from % card->erase_size);
1808 if ((arg & MMC_TRIM_OR_DISCARD_ARGS) && card->eg_boundary && nr > rem) {
1809 err = mmc_do_erase(card, from, from + rem - 1, arg);
1810 from += rem;
1811 if ((err) || (to <= from))
1812 return err;
1813 }
1814
1815 return mmc_do_erase(card, from, to, arg);
1816}
1817EXPORT_SYMBOL(mmc_erase);
1818
1819int mmc_can_erase(struct mmc_card *card)
1820{
1821 if (card->csd.cmdclass & CCC_ERASE && card->erase_size)
1822 return 1;
1823 return 0;
1824}
1825EXPORT_SYMBOL(mmc_can_erase);
1826
1827int mmc_can_trim(struct mmc_card *card)
1828{
1829 if ((card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN) &&
1830 (!(card->quirks & MMC_QUIRK_TRIM_BROKEN)))
1831 return 1;
1832 return 0;
1833}
1834EXPORT_SYMBOL(mmc_can_trim);
1835
1836int mmc_can_discard(struct mmc_card *card)
1837{
1838 /*
1839 * As there's no way to detect the discard support bit at v4.5
1840 * use the s/w feature support filed.
1841 */
1842 if (card->ext_csd.feature_support & MMC_DISCARD_FEATURE)
1843 return 1;
1844 return 0;
1845}
1846EXPORT_SYMBOL(mmc_can_discard);
1847
1848int mmc_can_sanitize(struct mmc_card *card)
1849{
1850 if (!mmc_can_trim(card) && !mmc_can_erase(card))
1851 return 0;
1852 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_SANITIZE)
1853 return 1;
1854 return 0;
1855}
1856
1857int mmc_can_secure_erase_trim(struct mmc_card *card)
1858{
1859 if ((card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN) &&
1860 !(card->quirks & MMC_QUIRK_SEC_ERASE_TRIM_BROKEN))
1861 return 1;
1862 return 0;
1863}
1864EXPORT_SYMBOL(mmc_can_secure_erase_trim);
1865
1866int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
1867 unsigned int nr)
1868{
1869 if (!card->erase_size)
1870 return 0;
1871 if (from % card->erase_size || nr % card->erase_size)
1872 return 0;
1873 return 1;
1874}
1875EXPORT_SYMBOL(mmc_erase_group_aligned);
1876
1877static unsigned int mmc_do_calc_max_discard(struct mmc_card *card,
1878 unsigned int arg)
1879{
1880 struct mmc_host *host = card->host;
1881 unsigned int max_discard, x, y, qty = 0, max_qty, min_qty, timeout;
1882 unsigned int last_timeout = 0;
1883 unsigned int max_busy_timeout = host->max_busy_timeout ?
1884 host->max_busy_timeout : MMC_ERASE_TIMEOUT_MS;
1885
1886 if (card->erase_shift) {
1887 max_qty = UINT_MAX >> card->erase_shift;
1888 min_qty = card->pref_erase >> card->erase_shift;
1889 } else if (mmc_card_sd(card)) {
1890 max_qty = UINT_MAX;
1891 min_qty = card->pref_erase;
1892 } else {
1893 max_qty = UINT_MAX / card->erase_size;
1894 min_qty = card->pref_erase / card->erase_size;
1895 }
1896
1897 /*
1898 * We should not only use 'host->max_busy_timeout' as the limitation
1899 * when deciding the max discard sectors. We should set a balance value
1900 * to improve the erase speed, and it can not get too long timeout at
1901 * the same time.
1902 *
1903 * Here we set 'card->pref_erase' as the minimal discard sectors no
1904 * matter what size of 'host->max_busy_timeout', but if the
1905 * 'host->max_busy_timeout' is large enough for more discard sectors,
1906 * then we can continue to increase the max discard sectors until we
1907 * get a balance value. In cases when the 'host->max_busy_timeout'
1908 * isn't specified, use the default max erase timeout.
1909 */
1910 do {
1911 y = 0;
1912 for (x = 1; x && x <= max_qty && max_qty - x >= qty; x <<= 1) {
1913 timeout = mmc_erase_timeout(card, arg, qty + x);
1914
1915 if (qty + x > min_qty && timeout > max_busy_timeout)
1916 break;
1917
1918 if (timeout < last_timeout)
1919 break;
1920 last_timeout = timeout;
1921 y = x;
1922 }
1923 qty += y;
1924 } while (y);
1925
1926 if (!qty)
1927 return 0;
1928
1929 /*
1930 * When specifying a sector range to trim, chances are we might cross
1931 * an erase-group boundary even if the amount of sectors is less than
1932 * one erase-group.
1933 * If we can only fit one erase-group in the controller timeout budget,
1934 * we have to care that erase-group boundaries are not crossed by a
1935 * single trim operation. We flag that special case with "eg_boundary".
1936 * In all other cases we can just decrement qty and pretend that we
1937 * always touch (qty + 1) erase-groups as a simple optimization.
1938 */
1939 if (qty == 1)
1940 card->eg_boundary = 1;
1941 else
1942 qty--;
1943
1944 /* Convert qty to sectors */
1945 if (card->erase_shift)
1946 max_discard = qty << card->erase_shift;
1947 else if (mmc_card_sd(card))
1948 max_discard = qty + 1;
1949 else
1950 max_discard = qty * card->erase_size;
1951
1952 return max_discard;
1953}
1954
1955unsigned int mmc_calc_max_discard(struct mmc_card *card)
1956{
1957 struct mmc_host *host = card->host;
1958 unsigned int max_discard, max_trim;
1959
1960 /*
1961 * Without erase_group_def set, MMC erase timeout depends on clock
1962 * frequence which can change. In that case, the best choice is
1963 * just the preferred erase size.
1964 */
1965 if (mmc_card_mmc(card) && !(card->ext_csd.erase_group_def & 1))
1966 return card->pref_erase;
1967
1968 max_discard = mmc_do_calc_max_discard(card, MMC_ERASE_ARG);
1969 if (mmc_can_trim(card)) {
1970 max_trim = mmc_do_calc_max_discard(card, MMC_TRIM_ARG);
1971 if (max_trim < max_discard || max_discard == 0)
1972 max_discard = max_trim;
1973 } else if (max_discard < card->erase_size) {
1974 max_discard = 0;
1975 }
1976 pr_debug("%s: calculated max. discard sectors %u for timeout %u ms\n",
1977 mmc_hostname(host), max_discard, host->max_busy_timeout ?
1978 host->max_busy_timeout : MMC_ERASE_TIMEOUT_MS);
1979 return max_discard;
1980}
1981EXPORT_SYMBOL(mmc_calc_max_discard);
1982
1983bool mmc_card_is_blockaddr(struct mmc_card *card)
1984{
1985 return card ? mmc_card_blockaddr(card) : false;
1986}
1987EXPORT_SYMBOL(mmc_card_is_blockaddr);
1988
1989int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen)
1990{
1991 struct mmc_command cmd = {};
1992
1993 if (mmc_card_blockaddr(card) || mmc_card_ddr52(card) ||
1994 mmc_card_hs400(card) || mmc_card_hs400es(card))
1995 return 0;
1996
1997 cmd.opcode = MMC_SET_BLOCKLEN;
1998 cmd.arg = blocklen;
1999 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2000 return mmc_wait_for_cmd(card->host, &cmd, 5);
2001}
2002EXPORT_SYMBOL(mmc_set_blocklen);
2003
2004static void mmc_hw_reset_for_init(struct mmc_host *host)
2005{
2006 mmc_pwrseq_reset(host);
2007
2008 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->card_hw_reset)
2009 return;
2010 host->ops->card_hw_reset(host);
2011}
2012
2013/**
2014 * mmc_hw_reset - reset the card in hardware
2015 * @card: card to be reset
2016 *
2017 * Hard reset the card. This function is only for upper layers, like the
2018 * block layer or card drivers. You cannot use it in host drivers (struct
2019 * mmc_card might be gone then).
2020 *
2021 * Return: 0 on success, -errno on failure
2022 */
2023int mmc_hw_reset(struct mmc_card *card)
2024{
2025 struct mmc_host *host = card->host;
2026 int ret;
2027
2028 ret = host->bus_ops->hw_reset(host);
2029 if (ret < 0)
2030 pr_warn("%s: tried to HW reset card, got error %d\n",
2031 mmc_hostname(host), ret);
2032
2033 return ret;
2034}
2035EXPORT_SYMBOL(mmc_hw_reset);
2036
2037int mmc_sw_reset(struct mmc_card *card)
2038{
2039 struct mmc_host *host = card->host;
2040 int ret;
2041
2042 if (!host->bus_ops->sw_reset)
2043 return -EOPNOTSUPP;
2044
2045 ret = host->bus_ops->sw_reset(host);
2046 if (ret)
2047 pr_warn("%s: tried to SW reset card, got error %d\n",
2048 mmc_hostname(host), ret);
2049
2050 return ret;
2051}
2052EXPORT_SYMBOL(mmc_sw_reset);
2053
2054static int mmc_rescan_try_freq(struct mmc_host *host, unsigned freq)
2055{
2056 host->f_init = freq;
2057
2058 pr_debug("%s: %s: trying to init card at %u Hz\n",
2059 mmc_hostname(host), __func__, host->f_init);
2060
2061 mmc_power_up(host, host->ocr_avail);
2062
2063 /*
2064 * Some eMMCs (with VCCQ always on) may not be reset after power up, so
2065 * do a hardware reset if possible.
2066 */
2067 mmc_hw_reset_for_init(host);
2068
2069 /*
2070 * sdio_reset sends CMD52 to reset card. Since we do not know
2071 * if the card is being re-initialized, just send it. CMD52
2072 * should be ignored by SD/eMMC cards.
2073 * Skip it if we already know that we do not support SDIO commands
2074 */
2075 if (!(host->caps2 & MMC_CAP2_NO_SDIO))
2076 sdio_reset(host);
2077
2078 mmc_go_idle(host);
2079
2080 if (!(host->caps2 & MMC_CAP2_NO_SD)) {
2081 if (mmc_send_if_cond_pcie(host, host->ocr_avail))
2082 goto out;
2083 if (mmc_card_sd_express(host))
2084 return 0;
2085 }
2086
2087 /* Order's important: probe SDIO, then SD, then MMC */
2088 if (!(host->caps2 & MMC_CAP2_NO_SDIO))
2089 if (!mmc_attach_sdio(host))
2090 return 0;
2091
2092 if (!(host->caps2 & MMC_CAP2_NO_SD))
2093 if (!mmc_attach_sd(host))
2094 return 0;
2095
2096 if (!(host->caps2 & MMC_CAP2_NO_MMC))
2097 if (!mmc_attach_mmc(host))
2098 return 0;
2099
2100out:
2101 mmc_power_off(host);
2102 return -EIO;
2103}
2104
2105int _mmc_detect_card_removed(struct mmc_host *host)
2106{
2107 int ret;
2108
2109 if (!host->card || mmc_card_removed(host->card))
2110 return 1;
2111
2112 ret = host->bus_ops->alive(host);
2113
2114 /*
2115 * Card detect status and alive check may be out of sync if card is
2116 * removed slowly, when card detect switch changes while card/slot
2117 * pads are still contacted in hardware (refer to "SD Card Mechanical
2118 * Addendum, Appendix C: Card Detection Switch"). So reschedule a
2119 * detect work 200ms later for this case.
2120 */
2121 if (!ret && host->ops->get_cd && !host->ops->get_cd(host)) {
2122 mmc_detect_change(host, msecs_to_jiffies(200));
2123 pr_debug("%s: card removed too slowly\n", mmc_hostname(host));
2124 }
2125
2126 if (ret) {
2127 mmc_card_set_removed(host->card);
2128 pr_debug("%s: card remove detected\n", mmc_hostname(host));
2129 }
2130
2131 return ret;
2132}
2133
2134int mmc_detect_card_removed(struct mmc_host *host)
2135{
2136 struct mmc_card *card = host->card;
2137 int ret;
2138
2139 WARN_ON(!host->claimed);
2140
2141 if (!card)
2142 return 1;
2143
2144 if (!mmc_card_is_removable(host))
2145 return 0;
2146
2147 ret = mmc_card_removed(card);
2148 /*
2149 * The card will be considered unchanged unless we have been asked to
2150 * detect a change or host requires polling to provide card detection.
2151 */
2152 if (!host->detect_change && !(host->caps & MMC_CAP_NEEDS_POLL))
2153 return ret;
2154
2155 host->detect_change = 0;
2156 if (!ret) {
2157 ret = _mmc_detect_card_removed(host);
2158 if (ret && (host->caps & MMC_CAP_NEEDS_POLL)) {
2159 /*
2160 * Schedule a detect work as soon as possible to let a
2161 * rescan handle the card removal.
2162 */
2163 cancel_delayed_work(&host->detect);
2164 _mmc_detect_change(host, 0, false);
2165 }
2166 }
2167
2168 return ret;
2169}
2170EXPORT_SYMBOL(mmc_detect_card_removed);
2171
2172int mmc_card_alternative_gpt_sector(struct mmc_card *card, sector_t *gpt_sector)
2173{
2174 unsigned int boot_sectors_num;
2175
2176 if ((!(card->host->caps2 & MMC_CAP2_ALT_GPT_TEGRA)))
2177 return -EOPNOTSUPP;
2178
2179 /* filter out unrelated cards */
2180 if (card->ext_csd.rev < 3 ||
2181 !mmc_card_mmc(card) ||
2182 !mmc_card_is_blockaddr(card) ||
2183 mmc_card_is_removable(card->host))
2184 return -ENOENT;
2185
2186 /*
2187 * eMMC storage has two special boot partitions in addition to the
2188 * main one. NVIDIA's bootloader linearizes eMMC boot0->boot1->main
2189 * accesses, this means that the partition table addresses are shifted
2190 * by the size of boot partitions. In accordance with the eMMC
2191 * specification, the boot partition size is calculated as follows:
2192 *
2193 * boot partition size = 128K byte x BOOT_SIZE_MULT
2194 *
2195 * Calculate number of sectors occupied by the both boot partitions.
2196 */
2197 boot_sectors_num = card->ext_csd.raw_boot_mult * SZ_128K /
2198 SZ_512 * MMC_NUM_BOOT_PARTITION;
2199
2200 /* Defined by NVIDIA and used by Android devices. */
2201 *gpt_sector = card->ext_csd.sectors - boot_sectors_num - 1;
2202
2203 return 0;
2204}
2205EXPORT_SYMBOL(mmc_card_alternative_gpt_sector);
2206
2207void mmc_rescan(struct work_struct *work)
2208{
2209 struct mmc_host *host =
2210 container_of(work, struct mmc_host, detect.work);
2211 int i;
2212
2213 if (host->rescan_disable)
2214 return;
2215
2216 /* If there is a non-removable card registered, only scan once */
2217 if (!mmc_card_is_removable(host) && host->rescan_entered)
2218 return;
2219 host->rescan_entered = 1;
2220
2221 if (host->trigger_card_event && host->ops->card_event) {
2222 mmc_claim_host(host);
2223 host->ops->card_event(host);
2224 mmc_release_host(host);
2225 host->trigger_card_event = false;
2226 }
2227
2228 /* Verify a registered card to be functional, else remove it. */
2229 if (host->bus_ops)
2230 host->bus_ops->detect(host);
2231
2232 host->detect_change = 0;
2233
2234 /* if there still is a card present, stop here */
2235 if (host->bus_ops != NULL)
2236 goto out;
2237
2238 mmc_claim_host(host);
2239 if (mmc_card_is_removable(host) && host->ops->get_cd &&
2240 host->ops->get_cd(host) == 0) {
2241 mmc_power_off(host);
2242 mmc_release_host(host);
2243 goto out;
2244 }
2245
2246 /* If an SD express card is present, then leave it as is. */
2247 if (mmc_card_sd_express(host)) {
2248 mmc_release_host(host);
2249 goto out;
2250 }
2251
2252 for (i = 0; i < ARRAY_SIZE(freqs); i++) {
2253 unsigned int freq = freqs[i];
2254 if (freq > host->f_max) {
2255 if (i + 1 < ARRAY_SIZE(freqs))
2256 continue;
2257 freq = host->f_max;
2258 }
2259 if (!mmc_rescan_try_freq(host, max(freq, host->f_min)))
2260 break;
2261 if (freqs[i] <= host->f_min)
2262 break;
2263 }
2264
2265 /* A non-removable card should have been detected by now. */
2266 if (!mmc_card_is_removable(host) && !host->bus_ops)
2267 pr_info("%s: Failed to initialize a non-removable card",
2268 mmc_hostname(host));
2269
2270 /*
2271 * Ignore the command timeout errors observed during
2272 * the card init as those are excepted.
2273 */
2274 host->err_stats[MMC_ERR_CMD_TIMEOUT] = 0;
2275 mmc_release_host(host);
2276
2277 out:
2278 if (host->caps & MMC_CAP_NEEDS_POLL)
2279 mmc_schedule_delayed_work(&host->detect, HZ);
2280}
2281
2282void mmc_start_host(struct mmc_host *host)
2283{
2284 host->f_init = max(min(freqs[0], host->f_max), host->f_min);
2285 host->rescan_disable = 0;
2286
2287 if (!(host->caps2 & MMC_CAP2_NO_PRESCAN_POWERUP)) {
2288 mmc_claim_host(host);
2289 mmc_power_up(host, host->ocr_avail);
2290 mmc_release_host(host);
2291 }
2292
2293 mmc_gpiod_request_cd_irq(host);
2294 _mmc_detect_change(host, 0, false);
2295}
2296
2297void __mmc_stop_host(struct mmc_host *host)
2298{
2299 if (host->slot.cd_irq >= 0) {
2300 mmc_gpio_set_cd_wake(host, false);
2301 disable_irq(host->slot.cd_irq);
2302 }
2303
2304 host->rescan_disable = 1;
2305 cancel_delayed_work_sync(&host->detect);
2306}
2307
2308void mmc_stop_host(struct mmc_host *host)
2309{
2310 __mmc_stop_host(host);
2311
2312 /* clear pm flags now and let card drivers set them as needed */
2313 host->pm_flags = 0;
2314
2315 if (host->bus_ops) {
2316 /* Calling bus_ops->remove() with a claimed host can deadlock */
2317 host->bus_ops->remove(host);
2318 mmc_claim_host(host);
2319 mmc_detach_bus(host);
2320 mmc_power_off(host);
2321 mmc_release_host(host);
2322 return;
2323 }
2324
2325 mmc_claim_host(host);
2326 mmc_power_off(host);
2327 mmc_release_host(host);
2328}
2329
2330static int __init mmc_init(void)
2331{
2332 int ret;
2333
2334 ret = mmc_register_bus();
2335 if (ret)
2336 return ret;
2337
2338 ret = mmc_register_host_class();
2339 if (ret)
2340 goto unregister_bus;
2341
2342 ret = sdio_register_bus();
2343 if (ret)
2344 goto unregister_host_class;
2345
2346 return 0;
2347
2348unregister_host_class:
2349 mmc_unregister_host_class();
2350unregister_bus:
2351 mmc_unregister_bus();
2352 return ret;
2353}
2354
2355static void __exit mmc_exit(void)
2356{
2357 sdio_unregister_bus();
2358 mmc_unregister_host_class();
2359 mmc_unregister_bus();
2360}
2361
2362subsys_initcall(mmc_init);
2363module_exit(mmc_exit);
2364
2365MODULE_LICENSE("GPL");
1/*
2 * linux/drivers/mmc/core/core.c
3 *
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.
8 *
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.
12 */
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>
31#include <linux/of.h>
32
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>
38
39#define CREATE_TRACE_POINTS
40#include <trace/events/mmc.h>
41
42#include "core.h"
43#include "bus.h"
44#include "host.h"
45#include "sdio_bus.h"
46#include "pwrseq.h"
47
48#include "mmc_ops.h"
49#include "sd_ops.h"
50#include "sdio_ops.h"
51
52/* If the device is not responding */
53#define MMC_CORE_TIMEOUT_MS (10 * 60 * 1000) /* 10 minute timeout */
54
55/*
56 * Background operations can take a long time, depending on the housekeeping
57 * operations the card has to perform.
58 */
59#define MMC_BKOPS_MAX_TIMEOUT (4 * 60 * 1000) /* max time to wait in ms */
60
61/* The max erase timeout, used when host->max_busy_timeout isn't specified */
62#define MMC_ERASE_TIMEOUT_MS (60 * 1000) /* 60 s */
63
64static const unsigned freqs[] = { 400000, 300000, 200000, 100000 };
65
66/*
67 * Enabling software CRCs on the data blocks can be a significant (30%)
68 * performance cost, and for other reasons may not always be desired.
69 * So we allow it it to be disabled.
70 */
71bool use_spi_crc = 1;
72module_param(use_spi_crc, bool, 0);
73
74static int mmc_schedule_delayed_work(struct delayed_work *work,
75 unsigned long delay)
76{
77 /*
78 * We use the system_freezable_wq, because of two reasons.
79 * First, it allows several works (not the same work item) to be
80 * executed simultaneously. Second, the queue becomes frozen when
81 * userspace becomes frozen during system PM.
82 */
83 return queue_delayed_work(system_freezable_wq, work, delay);
84}
85
86#ifdef CONFIG_FAIL_MMC_REQUEST
87
88/*
89 * Internal function. Inject random data errors.
90 * If mmc_data is NULL no errors are injected.
91 */
92static void mmc_should_fail_request(struct mmc_host *host,
93 struct mmc_request *mrq)
94{
95 struct mmc_command *cmd = mrq->cmd;
96 struct mmc_data *data = mrq->data;
97 static const int data_errors[] = {
98 -ETIMEDOUT,
99 -EILSEQ,
100 -EIO,
101 };
102
103 if (!data)
104 return;
105
106 if (cmd->error || data->error ||
107 !should_fail(&host->fail_mmc_request, data->blksz * data->blocks))
108 return;
109
110 data->error = data_errors[prandom_u32() % ARRAY_SIZE(data_errors)];
111 data->bytes_xfered = (prandom_u32() % (data->bytes_xfered >> 9)) << 9;
112}
113
114#else /* CONFIG_FAIL_MMC_REQUEST */
115
116static inline void mmc_should_fail_request(struct mmc_host *host,
117 struct mmc_request *mrq)
118{
119}
120
121#endif /* CONFIG_FAIL_MMC_REQUEST */
122
123static inline void mmc_complete_cmd(struct mmc_request *mrq)
124{
125 if (mrq->cap_cmd_during_tfr && !completion_done(&mrq->cmd_completion))
126 complete_all(&mrq->cmd_completion);
127}
128
129void mmc_command_done(struct mmc_host *host, struct mmc_request *mrq)
130{
131 if (!mrq->cap_cmd_during_tfr)
132 return;
133
134 mmc_complete_cmd(mrq);
135
136 pr_debug("%s: cmd done, tfr ongoing (CMD%u)\n",
137 mmc_hostname(host), mrq->cmd->opcode);
138}
139EXPORT_SYMBOL(mmc_command_done);
140
141/**
142 * mmc_request_done - finish processing an MMC request
143 * @host: MMC host which completed request
144 * @mrq: MMC request which request
145 *
146 * MMC drivers should call this function when they have completed
147 * their processing of a request.
148 */
149void mmc_request_done(struct mmc_host *host, struct mmc_request *mrq)
150{
151 struct mmc_command *cmd = mrq->cmd;
152 int err = cmd->error;
153
154 /* Flag re-tuning needed on CRC errors */
155 if ((cmd->opcode != MMC_SEND_TUNING_BLOCK &&
156 cmd->opcode != MMC_SEND_TUNING_BLOCK_HS200) &&
157 (err == -EILSEQ || (mrq->sbc && mrq->sbc->error == -EILSEQ) ||
158 (mrq->data && mrq->data->error == -EILSEQ) ||
159 (mrq->stop && mrq->stop->error == -EILSEQ)))
160 mmc_retune_needed(host);
161
162 if (err && cmd->retries && mmc_host_is_spi(host)) {
163 if (cmd->resp[0] & R1_SPI_ILLEGAL_COMMAND)
164 cmd->retries = 0;
165 }
166
167 if (host->ongoing_mrq == mrq)
168 host->ongoing_mrq = NULL;
169
170 mmc_complete_cmd(mrq);
171
172 trace_mmc_request_done(host, mrq);
173
174 if (err && cmd->retries && !mmc_card_removed(host->card)) {
175 /*
176 * Request starter must handle retries - see
177 * mmc_wait_for_req_done().
178 */
179 if (mrq->done)
180 mrq->done(mrq);
181 } else {
182 mmc_should_fail_request(host, mrq);
183
184 if (!host->ongoing_mrq)
185 led_trigger_event(host->led, LED_OFF);
186
187 if (mrq->sbc) {
188 pr_debug("%s: req done <CMD%u>: %d: %08x %08x %08x %08x\n",
189 mmc_hostname(host), mrq->sbc->opcode,
190 mrq->sbc->error,
191 mrq->sbc->resp[0], mrq->sbc->resp[1],
192 mrq->sbc->resp[2], mrq->sbc->resp[3]);
193 }
194
195 pr_debug("%s: req done (CMD%u): %d: %08x %08x %08x %08x\n",
196 mmc_hostname(host), cmd->opcode, err,
197 cmd->resp[0], cmd->resp[1],
198 cmd->resp[2], cmd->resp[3]);
199
200 if (mrq->data) {
201 pr_debug("%s: %d bytes transferred: %d\n",
202 mmc_hostname(host),
203 mrq->data->bytes_xfered, mrq->data->error);
204 }
205
206 if (mrq->stop) {
207 pr_debug("%s: (CMD%u): %d: %08x %08x %08x %08x\n",
208 mmc_hostname(host), mrq->stop->opcode,
209 mrq->stop->error,
210 mrq->stop->resp[0], mrq->stop->resp[1],
211 mrq->stop->resp[2], mrq->stop->resp[3]);
212 }
213
214 if (mrq->done)
215 mrq->done(mrq);
216 }
217}
218
219EXPORT_SYMBOL(mmc_request_done);
220
221static void __mmc_start_request(struct mmc_host *host, struct mmc_request *mrq)
222{
223 int err;
224
225 /* Assumes host controller has been runtime resumed by mmc_claim_host */
226 err = mmc_retune(host);
227 if (err) {
228 mrq->cmd->error = err;
229 mmc_request_done(host, mrq);
230 return;
231 }
232
233 /*
234 * For sdio rw commands we must wait for card busy otherwise some
235 * sdio devices won't work properly.
236 */
237 if (mmc_is_io_op(mrq->cmd->opcode) && host->ops->card_busy) {
238 int tries = 500; /* Wait aprox 500ms at maximum */
239
240 while (host->ops->card_busy(host) && --tries)
241 mmc_delay(1);
242
243 if (tries == 0) {
244 mrq->cmd->error = -EBUSY;
245 mmc_request_done(host, mrq);
246 return;
247 }
248 }
249
250 if (mrq->cap_cmd_during_tfr) {
251 host->ongoing_mrq = mrq;
252 /*
253 * Retry path could come through here without having waiting on
254 * cmd_completion, so ensure it is reinitialised.
255 */
256 reinit_completion(&mrq->cmd_completion);
257 }
258
259 trace_mmc_request_start(host, mrq);
260
261 host->ops->request(host, mrq);
262}
263
264static int mmc_start_request(struct mmc_host *host, struct mmc_request *mrq)
265{
266#ifdef CONFIG_MMC_DEBUG
267 unsigned int i, sz;
268 struct scatterlist *sg;
269#endif
270 mmc_retune_hold(host);
271
272 if (mmc_card_removed(host->card))
273 return -ENOMEDIUM;
274
275 if (mrq->sbc) {
276 pr_debug("<%s: starting CMD%u arg %08x flags %08x>\n",
277 mmc_hostname(host), mrq->sbc->opcode,
278 mrq->sbc->arg, mrq->sbc->flags);
279 }
280
281 pr_debug("%s: starting CMD%u arg %08x flags %08x\n",
282 mmc_hostname(host), mrq->cmd->opcode,
283 mrq->cmd->arg, mrq->cmd->flags);
284
285 if (mrq->data) {
286 pr_debug("%s: blksz %d blocks %d flags %08x "
287 "tsac %d ms nsac %d\n",
288 mmc_hostname(host), mrq->data->blksz,
289 mrq->data->blocks, mrq->data->flags,
290 mrq->data->timeout_ns / 1000000,
291 mrq->data->timeout_clks);
292 }
293
294 if (mrq->stop) {
295 pr_debug("%s: CMD%u arg %08x flags %08x\n",
296 mmc_hostname(host), mrq->stop->opcode,
297 mrq->stop->arg, mrq->stop->flags);
298 }
299
300 WARN_ON(!host->claimed);
301
302 mrq->cmd->error = 0;
303 mrq->cmd->mrq = mrq;
304 if (mrq->sbc) {
305 mrq->sbc->error = 0;
306 mrq->sbc->mrq = mrq;
307 }
308 if (mrq->data) {
309 if (mrq->data->blksz > host->max_blk_size ||
310 mrq->data->blocks > host->max_blk_count ||
311 mrq->data->blocks * mrq->data->blksz > host->max_req_size)
312 return -EINVAL;
313#ifdef CONFIG_MMC_DEBUG
314 sz = 0;
315 for_each_sg(mrq->data->sg, sg, mrq->data->sg_len, i)
316 sz += sg->length;
317 if (sz != mrq->data->blocks * mrq->data->blksz)
318 return -EINVAL;
319#endif
320
321 mrq->cmd->data = mrq->data;
322 mrq->data->error = 0;
323 mrq->data->mrq = mrq;
324 if (mrq->stop) {
325 mrq->data->stop = mrq->stop;
326 mrq->stop->error = 0;
327 mrq->stop->mrq = mrq;
328 }
329 }
330 led_trigger_event(host->led, LED_FULL);
331 __mmc_start_request(host, mrq);
332
333 return 0;
334}
335
336/**
337 * mmc_start_bkops - start BKOPS for supported cards
338 * @card: MMC card to start BKOPS
339 * @form_exception: A flag to indicate if this function was
340 * called due to an exception raised by the card
341 *
342 * Start background operations whenever requested.
343 * When the urgent BKOPS bit is set in a R1 command response
344 * then background operations should be started immediately.
345*/
346void mmc_start_bkops(struct mmc_card *card, bool from_exception)
347{
348 int err;
349 int timeout;
350 bool use_busy_signal;
351
352 if (!card->ext_csd.man_bkops_en || mmc_card_doing_bkops(card))
353 return;
354
355 err = mmc_read_bkops_status(card);
356 if (err) {
357 pr_err("%s: Failed to read bkops status: %d\n",
358 mmc_hostname(card->host), err);
359 return;
360 }
361
362 if (!card->ext_csd.raw_bkops_status)
363 return;
364
365 if (card->ext_csd.raw_bkops_status < EXT_CSD_BKOPS_LEVEL_2 &&
366 from_exception)
367 return;
368
369 mmc_claim_host(card->host);
370 if (card->ext_csd.raw_bkops_status >= EXT_CSD_BKOPS_LEVEL_2) {
371 timeout = MMC_BKOPS_MAX_TIMEOUT;
372 use_busy_signal = true;
373 } else {
374 timeout = 0;
375 use_busy_signal = false;
376 }
377
378 mmc_retune_hold(card->host);
379
380 err = __mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
381 EXT_CSD_BKOPS_START, 1, timeout, 0,
382 use_busy_signal, true, false);
383 if (err) {
384 pr_warn("%s: Error %d starting bkops\n",
385 mmc_hostname(card->host), err);
386 mmc_retune_release(card->host);
387 goto out;
388 }
389
390 /*
391 * For urgent bkops status (LEVEL_2 and more)
392 * bkops executed synchronously, otherwise
393 * the operation is in progress
394 */
395 if (!use_busy_signal)
396 mmc_card_set_doing_bkops(card);
397 else
398 mmc_retune_release(card->host);
399out:
400 mmc_release_host(card->host);
401}
402EXPORT_SYMBOL(mmc_start_bkops);
403
404/*
405 * mmc_wait_data_done() - done callback for data request
406 * @mrq: done data request
407 *
408 * Wakes up mmc context, passed as a callback to host controller driver
409 */
410static void mmc_wait_data_done(struct mmc_request *mrq)
411{
412 struct mmc_context_info *context_info = &mrq->host->context_info;
413
414 context_info->is_done_rcv = true;
415 wake_up_interruptible(&context_info->wait);
416}
417
418static void mmc_wait_done(struct mmc_request *mrq)
419{
420 complete(&mrq->completion);
421}
422
423static inline void mmc_wait_ongoing_tfr_cmd(struct mmc_host *host)
424{
425 struct mmc_request *ongoing_mrq = READ_ONCE(host->ongoing_mrq);
426
427 /*
428 * If there is an ongoing transfer, wait for the command line to become
429 * available.
430 */
431 if (ongoing_mrq && !completion_done(&ongoing_mrq->cmd_completion))
432 wait_for_completion(&ongoing_mrq->cmd_completion);
433}
434
435/*
436 *__mmc_start_data_req() - starts data request
437 * @host: MMC host to start the request
438 * @mrq: data request to start
439 *
440 * Sets the done callback to be called when request is completed by the card.
441 * Starts data mmc request execution
442 * If an ongoing transfer is already in progress, wait for the command line
443 * to become available before sending another command.
444 */
445static int __mmc_start_data_req(struct mmc_host *host, struct mmc_request *mrq)
446{
447 int err;
448
449 mmc_wait_ongoing_tfr_cmd(host);
450
451 mrq->done = mmc_wait_data_done;
452 mrq->host = host;
453
454 init_completion(&mrq->cmd_completion);
455
456 err = mmc_start_request(host, mrq);
457 if (err) {
458 mrq->cmd->error = err;
459 mmc_complete_cmd(mrq);
460 mmc_wait_data_done(mrq);
461 }
462
463 return err;
464}
465
466static int __mmc_start_req(struct mmc_host *host, struct mmc_request *mrq)
467{
468 int err;
469
470 mmc_wait_ongoing_tfr_cmd(host);
471
472 init_completion(&mrq->completion);
473 mrq->done = mmc_wait_done;
474
475 init_completion(&mrq->cmd_completion);
476
477 err = mmc_start_request(host, mrq);
478 if (err) {
479 mrq->cmd->error = err;
480 mmc_complete_cmd(mrq);
481 complete(&mrq->completion);
482 }
483
484 return err;
485}
486
487/*
488 * mmc_wait_for_data_req_done() - wait for request completed
489 * @host: MMC host to prepare the command.
490 * @mrq: MMC request to wait for
491 *
492 * Blocks MMC context till host controller will ack end of data request
493 * execution or new request notification arrives from the block layer.
494 * Handles command retries.
495 *
496 * Returns enum mmc_blk_status after checking errors.
497 */
498static enum mmc_blk_status mmc_wait_for_data_req_done(struct mmc_host *host,
499 struct mmc_request *mrq)
500{
501 struct mmc_command *cmd;
502 struct mmc_context_info *context_info = &host->context_info;
503 enum mmc_blk_status status;
504
505 while (1) {
506 wait_event_interruptible(context_info->wait,
507 (context_info->is_done_rcv ||
508 context_info->is_new_req));
509
510 if (context_info->is_done_rcv) {
511 context_info->is_done_rcv = false;
512 cmd = mrq->cmd;
513
514 if (!cmd->error || !cmd->retries ||
515 mmc_card_removed(host->card)) {
516 status = host->areq->err_check(host->card,
517 host->areq);
518 break; /* return status */
519 } else {
520 mmc_retune_recheck(host);
521 pr_info("%s: req failed (CMD%u): %d, retrying...\n",
522 mmc_hostname(host),
523 cmd->opcode, cmd->error);
524 cmd->retries--;
525 cmd->error = 0;
526 __mmc_start_request(host, mrq);
527 continue; /* wait for done/new event again */
528 }
529 }
530
531 return MMC_BLK_NEW_REQUEST;
532 }
533 mmc_retune_release(host);
534 return status;
535}
536
537void mmc_wait_for_req_done(struct mmc_host *host, struct mmc_request *mrq)
538{
539 struct mmc_command *cmd;
540
541 while (1) {
542 wait_for_completion(&mrq->completion);
543
544 cmd = mrq->cmd;
545
546 /*
547 * If host has timed out waiting for the sanitize
548 * to complete, card might be still in programming state
549 * so let's try to bring the card out of programming
550 * state.
551 */
552 if (cmd->sanitize_busy && cmd->error == -ETIMEDOUT) {
553 if (!mmc_interrupt_hpi(host->card)) {
554 pr_warn("%s: %s: Interrupted sanitize\n",
555 mmc_hostname(host), __func__);
556 cmd->error = 0;
557 break;
558 } else {
559 pr_err("%s: %s: Failed to interrupt sanitize\n",
560 mmc_hostname(host), __func__);
561 }
562 }
563 if (!cmd->error || !cmd->retries ||
564 mmc_card_removed(host->card))
565 break;
566
567 mmc_retune_recheck(host);
568
569 pr_debug("%s: req failed (CMD%u): %d, retrying...\n",
570 mmc_hostname(host), cmd->opcode, cmd->error);
571 cmd->retries--;
572 cmd->error = 0;
573 __mmc_start_request(host, mrq);
574 }
575
576 mmc_retune_release(host);
577}
578EXPORT_SYMBOL(mmc_wait_for_req_done);
579
580/**
581 * mmc_is_req_done - Determine if a 'cap_cmd_during_tfr' request is done
582 * @host: MMC host
583 * @mrq: MMC request
584 *
585 * mmc_is_req_done() is used with requests that have
586 * mrq->cap_cmd_during_tfr = true. mmc_is_req_done() must be called after
587 * starting a request and before waiting for it to complete. That is,
588 * either in between calls to mmc_start_req(), or after mmc_wait_for_req()
589 * and before mmc_wait_for_req_done(). If it is called at other times the
590 * result is not meaningful.
591 */
592bool mmc_is_req_done(struct mmc_host *host, struct mmc_request *mrq)
593{
594 if (host->areq)
595 return host->context_info.is_done_rcv;
596 else
597 return completion_done(&mrq->completion);
598}
599EXPORT_SYMBOL(mmc_is_req_done);
600
601/**
602 * mmc_pre_req - Prepare for a new request
603 * @host: MMC host to prepare command
604 * @mrq: MMC request to prepare for
605 *
606 * mmc_pre_req() is called in prior to mmc_start_req() to let
607 * host prepare for the new request. Preparation of a request may be
608 * performed while another request is running on the host.
609 */
610static void mmc_pre_req(struct mmc_host *host, struct mmc_request *mrq)
611{
612 if (host->ops->pre_req)
613 host->ops->pre_req(host, mrq);
614}
615
616/**
617 * mmc_post_req - Post process a completed request
618 * @host: MMC host to post process command
619 * @mrq: MMC request to post process for
620 * @err: Error, if non zero, clean up any resources made in pre_req
621 *
622 * Let the host post process a completed request. Post processing of
623 * a request may be performed while another reuqest is running.
624 */
625static void mmc_post_req(struct mmc_host *host, struct mmc_request *mrq,
626 int err)
627{
628 if (host->ops->post_req)
629 host->ops->post_req(host, mrq, err);
630}
631
632/**
633 * mmc_start_req - start a non-blocking request
634 * @host: MMC host to start command
635 * @areq: async request to start
636 * @error: out parameter returns 0 for success, otherwise non zero
637 *
638 * Start a new MMC custom command request for a host.
639 * If there is on ongoing async request wait for completion
640 * of that request and start the new one and return.
641 * Does not wait for the new request to complete.
642 *
643 * Returns the completed request, NULL in case of none completed.
644 * Wait for the an ongoing request (previoulsy started) to complete and
645 * return the completed request. If there is no ongoing request, NULL
646 * is returned without waiting. NULL is not an error condition.
647 */
648struct mmc_async_req *mmc_start_req(struct mmc_host *host,
649 struct mmc_async_req *areq,
650 enum mmc_blk_status *ret_stat)
651{
652 enum mmc_blk_status status = MMC_BLK_SUCCESS;
653 int start_err = 0;
654 struct mmc_async_req *data = host->areq;
655
656 /* Prepare a new request */
657 if (areq)
658 mmc_pre_req(host, areq->mrq);
659
660 if (host->areq) {
661 status = mmc_wait_for_data_req_done(host, host->areq->mrq);
662 if (status == MMC_BLK_NEW_REQUEST) {
663 if (ret_stat)
664 *ret_stat = status;
665 /*
666 * The previous request was not completed,
667 * nothing to return
668 */
669 return NULL;
670 }
671 /*
672 * Check BKOPS urgency for each R1 response
673 */
674 if (host->card && mmc_card_mmc(host->card) &&
675 ((mmc_resp_type(host->areq->mrq->cmd) == MMC_RSP_R1) ||
676 (mmc_resp_type(host->areq->mrq->cmd) == MMC_RSP_R1B)) &&
677 (host->areq->mrq->cmd->resp[0] & R1_EXCEPTION_EVENT)) {
678
679 /* Cancel the prepared request */
680 if (areq)
681 mmc_post_req(host, areq->mrq, -EINVAL);
682
683 mmc_start_bkops(host->card, true);
684
685 /* prepare the request again */
686 if (areq)
687 mmc_pre_req(host, areq->mrq);
688 }
689 }
690
691 if (status == MMC_BLK_SUCCESS && areq)
692 start_err = __mmc_start_data_req(host, areq->mrq);
693
694 if (host->areq)
695 mmc_post_req(host, host->areq->mrq, 0);
696
697 /* Cancel a prepared request if it was not started. */
698 if ((status != MMC_BLK_SUCCESS || start_err) && areq)
699 mmc_post_req(host, areq->mrq, -EINVAL);
700
701 if (status != MMC_BLK_SUCCESS)
702 host->areq = NULL;
703 else
704 host->areq = areq;
705
706 if (ret_stat)
707 *ret_stat = status;
708 return data;
709}
710EXPORT_SYMBOL(mmc_start_req);
711
712/**
713 * mmc_wait_for_req - start a request and wait for completion
714 * @host: MMC host to start command
715 * @mrq: MMC request to start
716 *
717 * Start a new MMC custom command request for a host, and wait
718 * for the command to complete. In the case of 'cap_cmd_during_tfr'
719 * requests, the transfer is ongoing and the caller can issue further
720 * commands that do not use the data lines, and then wait by calling
721 * mmc_wait_for_req_done().
722 * Does not attempt to parse the response.
723 */
724void mmc_wait_for_req(struct mmc_host *host, struct mmc_request *mrq)
725{
726 __mmc_start_req(host, mrq);
727
728 if (!mrq->cap_cmd_during_tfr)
729 mmc_wait_for_req_done(host, mrq);
730}
731EXPORT_SYMBOL(mmc_wait_for_req);
732
733/**
734 * mmc_interrupt_hpi - Issue for High priority Interrupt
735 * @card: the MMC card associated with the HPI transfer
736 *
737 * Issued High Priority Interrupt, and check for card status
738 * until out-of prg-state.
739 */
740int mmc_interrupt_hpi(struct mmc_card *card)
741{
742 int err;
743 u32 status;
744 unsigned long prg_wait;
745
746 if (!card->ext_csd.hpi_en) {
747 pr_info("%s: HPI enable bit unset\n", mmc_hostname(card->host));
748 return 1;
749 }
750
751 mmc_claim_host(card->host);
752 err = mmc_send_status(card, &status);
753 if (err) {
754 pr_err("%s: Get card status fail\n", mmc_hostname(card->host));
755 goto out;
756 }
757
758 switch (R1_CURRENT_STATE(status)) {
759 case R1_STATE_IDLE:
760 case R1_STATE_READY:
761 case R1_STATE_STBY:
762 case R1_STATE_TRAN:
763 /*
764 * In idle and transfer states, HPI is not needed and the caller
765 * can issue the next intended command immediately
766 */
767 goto out;
768 case R1_STATE_PRG:
769 break;
770 default:
771 /* In all other states, it's illegal to issue HPI */
772 pr_debug("%s: HPI cannot be sent. Card state=%d\n",
773 mmc_hostname(card->host), R1_CURRENT_STATE(status));
774 err = -EINVAL;
775 goto out;
776 }
777
778 err = mmc_send_hpi_cmd(card, &status);
779 if (err)
780 goto out;
781
782 prg_wait = jiffies + msecs_to_jiffies(card->ext_csd.out_of_int_time);
783 do {
784 err = mmc_send_status(card, &status);
785
786 if (!err && R1_CURRENT_STATE(status) == R1_STATE_TRAN)
787 break;
788 if (time_after(jiffies, prg_wait))
789 err = -ETIMEDOUT;
790 } while (!err);
791
792out:
793 mmc_release_host(card->host);
794 return err;
795}
796EXPORT_SYMBOL(mmc_interrupt_hpi);
797
798/**
799 * mmc_wait_for_cmd - start a command and wait for completion
800 * @host: MMC host to start command
801 * @cmd: MMC command to start
802 * @retries: maximum number of retries
803 *
804 * Start a new MMC command for a host, and wait for the command
805 * to complete. Return any error that occurred while the command
806 * was executing. Do not attempt to parse the response.
807 */
808int mmc_wait_for_cmd(struct mmc_host *host, struct mmc_command *cmd, int retries)
809{
810 struct mmc_request mrq = {NULL};
811
812 WARN_ON(!host->claimed);
813
814 memset(cmd->resp, 0, sizeof(cmd->resp));
815 cmd->retries = retries;
816
817 mrq.cmd = cmd;
818 cmd->data = NULL;
819
820 mmc_wait_for_req(host, &mrq);
821
822 return cmd->error;
823}
824
825EXPORT_SYMBOL(mmc_wait_for_cmd);
826
827/**
828 * mmc_stop_bkops - stop ongoing BKOPS
829 * @card: MMC card to check BKOPS
830 *
831 * Send HPI command to stop ongoing background operations to
832 * allow rapid servicing of foreground operations, e.g. read/
833 * writes. Wait until the card comes out of the programming state
834 * to avoid errors in servicing read/write requests.
835 */
836int mmc_stop_bkops(struct mmc_card *card)
837{
838 int err = 0;
839
840 err = mmc_interrupt_hpi(card);
841
842 /*
843 * If err is EINVAL, we can't issue an HPI.
844 * It should complete the BKOPS.
845 */
846 if (!err || (err == -EINVAL)) {
847 mmc_card_clr_doing_bkops(card);
848 mmc_retune_release(card->host);
849 err = 0;
850 }
851
852 return err;
853}
854EXPORT_SYMBOL(mmc_stop_bkops);
855
856int mmc_read_bkops_status(struct mmc_card *card)
857{
858 int err;
859 u8 *ext_csd;
860
861 mmc_claim_host(card->host);
862 err = mmc_get_ext_csd(card, &ext_csd);
863 mmc_release_host(card->host);
864 if (err)
865 return err;
866
867 card->ext_csd.raw_bkops_status = ext_csd[EXT_CSD_BKOPS_STATUS];
868 card->ext_csd.raw_exception_status = ext_csd[EXT_CSD_EXP_EVENTS_STATUS];
869 kfree(ext_csd);
870 return 0;
871}
872EXPORT_SYMBOL(mmc_read_bkops_status);
873
874/**
875 * mmc_set_data_timeout - set the timeout for a data command
876 * @data: data phase for command
877 * @card: the MMC card associated with the data transfer
878 *
879 * Computes the data timeout parameters according to the
880 * correct algorithm given the card type.
881 */
882void mmc_set_data_timeout(struct mmc_data *data, const struct mmc_card *card)
883{
884 unsigned int mult;
885
886 /*
887 * SDIO cards only define an upper 1 s limit on access.
888 */
889 if (mmc_card_sdio(card)) {
890 data->timeout_ns = 1000000000;
891 data->timeout_clks = 0;
892 return;
893 }
894
895 /*
896 * SD cards use a 100 multiplier rather than 10
897 */
898 mult = mmc_card_sd(card) ? 100 : 10;
899
900 /*
901 * Scale up the multiplier (and therefore the timeout) by
902 * the r2w factor for writes.
903 */
904 if (data->flags & MMC_DATA_WRITE)
905 mult <<= card->csd.r2w_factor;
906
907 data->timeout_ns = card->csd.tacc_ns * mult;
908 data->timeout_clks = card->csd.tacc_clks * mult;
909
910 /*
911 * SD cards also have an upper limit on the timeout.
912 */
913 if (mmc_card_sd(card)) {
914 unsigned int timeout_us, limit_us;
915
916 timeout_us = data->timeout_ns / 1000;
917 if (card->host->ios.clock)
918 timeout_us += data->timeout_clks * 1000 /
919 (card->host->ios.clock / 1000);
920
921 if (data->flags & MMC_DATA_WRITE)
922 /*
923 * The MMC spec "It is strongly recommended
924 * for hosts to implement more than 500ms
925 * timeout value even if the card indicates
926 * the 250ms maximum busy length." Even the
927 * previous value of 300ms is known to be
928 * insufficient for some cards.
929 */
930 limit_us = 3000000;
931 else
932 limit_us = 100000;
933
934 /*
935 * SDHC cards always use these fixed values.
936 */
937 if (timeout_us > limit_us || mmc_card_blockaddr(card)) {
938 data->timeout_ns = limit_us * 1000;
939 data->timeout_clks = 0;
940 }
941
942 /* assign limit value if invalid */
943 if (timeout_us == 0)
944 data->timeout_ns = limit_us * 1000;
945 }
946
947 /*
948 * Some cards require longer data read timeout than indicated in CSD.
949 * Address this by setting the read timeout to a "reasonably high"
950 * value. For the cards tested, 600ms has proven enough. If necessary,
951 * this value can be increased if other problematic cards require this.
952 */
953 if (mmc_card_long_read_time(card) && data->flags & MMC_DATA_READ) {
954 data->timeout_ns = 600000000;
955 data->timeout_clks = 0;
956 }
957
958 /*
959 * Some cards need very high timeouts if driven in SPI mode.
960 * The worst observed timeout was 900ms after writing a
961 * continuous stream of data until the internal logic
962 * overflowed.
963 */
964 if (mmc_host_is_spi(card->host)) {
965 if (data->flags & MMC_DATA_WRITE) {
966 if (data->timeout_ns < 1000000000)
967 data->timeout_ns = 1000000000; /* 1s */
968 } else {
969 if (data->timeout_ns < 100000000)
970 data->timeout_ns = 100000000; /* 100ms */
971 }
972 }
973}
974EXPORT_SYMBOL(mmc_set_data_timeout);
975
976/**
977 * mmc_align_data_size - pads a transfer size to a more optimal value
978 * @card: the MMC card associated with the data transfer
979 * @sz: original transfer size
980 *
981 * Pads the original data size with a number of extra bytes in
982 * order to avoid controller bugs and/or performance hits
983 * (e.g. some controllers revert to PIO for certain sizes).
984 *
985 * Returns the improved size, which might be unmodified.
986 *
987 * Note that this function is only relevant when issuing a
988 * single scatter gather entry.
989 */
990unsigned int mmc_align_data_size(struct mmc_card *card, unsigned int sz)
991{
992 /*
993 * FIXME: We don't have a system for the controller to tell
994 * the core about its problems yet, so for now we just 32-bit
995 * align the size.
996 */
997 sz = ((sz + 3) / 4) * 4;
998
999 return sz;
1000}
1001EXPORT_SYMBOL(mmc_align_data_size);
1002
1003/**
1004 * __mmc_claim_host - exclusively claim a host
1005 * @host: mmc host to claim
1006 * @abort: whether or not the operation should be aborted
1007 *
1008 * Claim a host for a set of operations. If @abort is non null and
1009 * dereference a non-zero value then this will return prematurely with
1010 * that non-zero value without acquiring the lock. Returns zero
1011 * with the lock held otherwise.
1012 */
1013int __mmc_claim_host(struct mmc_host *host, atomic_t *abort)
1014{
1015 DECLARE_WAITQUEUE(wait, current);
1016 unsigned long flags;
1017 int stop;
1018 bool pm = false;
1019
1020 might_sleep();
1021
1022 add_wait_queue(&host->wq, &wait);
1023 spin_lock_irqsave(&host->lock, flags);
1024 while (1) {
1025 set_current_state(TASK_UNINTERRUPTIBLE);
1026 stop = abort ? atomic_read(abort) : 0;
1027 if (stop || !host->claimed || host->claimer == current)
1028 break;
1029 spin_unlock_irqrestore(&host->lock, flags);
1030 schedule();
1031 spin_lock_irqsave(&host->lock, flags);
1032 }
1033 set_current_state(TASK_RUNNING);
1034 if (!stop) {
1035 host->claimed = 1;
1036 host->claimer = current;
1037 host->claim_cnt += 1;
1038 if (host->claim_cnt == 1)
1039 pm = true;
1040 } else
1041 wake_up(&host->wq);
1042 spin_unlock_irqrestore(&host->lock, flags);
1043 remove_wait_queue(&host->wq, &wait);
1044
1045 if (pm)
1046 pm_runtime_get_sync(mmc_dev(host));
1047
1048 return stop;
1049}
1050EXPORT_SYMBOL(__mmc_claim_host);
1051
1052/**
1053 * mmc_release_host - release a host
1054 * @host: mmc host to release
1055 *
1056 * Release a MMC host, allowing others to claim the host
1057 * for their operations.
1058 */
1059void mmc_release_host(struct mmc_host *host)
1060{
1061 unsigned long flags;
1062
1063 WARN_ON(!host->claimed);
1064
1065 spin_lock_irqsave(&host->lock, flags);
1066 if (--host->claim_cnt) {
1067 /* Release for nested claim */
1068 spin_unlock_irqrestore(&host->lock, flags);
1069 } else {
1070 host->claimed = 0;
1071 host->claimer = NULL;
1072 spin_unlock_irqrestore(&host->lock, flags);
1073 wake_up(&host->wq);
1074 pm_runtime_mark_last_busy(mmc_dev(host));
1075 pm_runtime_put_autosuspend(mmc_dev(host));
1076 }
1077}
1078EXPORT_SYMBOL(mmc_release_host);
1079
1080/*
1081 * This is a helper function, which fetches a runtime pm reference for the
1082 * card device and also claims the host.
1083 */
1084void mmc_get_card(struct mmc_card *card)
1085{
1086 pm_runtime_get_sync(&card->dev);
1087 mmc_claim_host(card->host);
1088}
1089EXPORT_SYMBOL(mmc_get_card);
1090
1091/*
1092 * This is a helper function, which releases the host and drops the runtime
1093 * pm reference for the card device.
1094 */
1095void mmc_put_card(struct mmc_card *card)
1096{
1097 mmc_release_host(card->host);
1098 pm_runtime_mark_last_busy(&card->dev);
1099 pm_runtime_put_autosuspend(&card->dev);
1100}
1101EXPORT_SYMBOL(mmc_put_card);
1102
1103/*
1104 * Internal function that does the actual ios call to the host driver,
1105 * optionally printing some debug output.
1106 */
1107static inline void mmc_set_ios(struct mmc_host *host)
1108{
1109 struct mmc_ios *ios = &host->ios;
1110
1111 pr_debug("%s: clock %uHz busmode %u powermode %u cs %u Vdd %u "
1112 "width %u timing %u\n",
1113 mmc_hostname(host), ios->clock, ios->bus_mode,
1114 ios->power_mode, ios->chip_select, ios->vdd,
1115 1 << ios->bus_width, ios->timing);
1116
1117 host->ops->set_ios(host, ios);
1118}
1119
1120/*
1121 * Control chip select pin on a host.
1122 */
1123void mmc_set_chip_select(struct mmc_host *host, int mode)
1124{
1125 host->ios.chip_select = mode;
1126 mmc_set_ios(host);
1127}
1128
1129/*
1130 * Sets the host clock to the highest possible frequency that
1131 * is below "hz".
1132 */
1133void mmc_set_clock(struct mmc_host *host, unsigned int hz)
1134{
1135 WARN_ON(hz && hz < host->f_min);
1136
1137 if (hz > host->f_max)
1138 hz = host->f_max;
1139
1140 host->ios.clock = hz;
1141 mmc_set_ios(host);
1142}
1143
1144int mmc_execute_tuning(struct mmc_card *card)
1145{
1146 struct mmc_host *host = card->host;
1147 u32 opcode;
1148 int err;
1149
1150 if (!host->ops->execute_tuning)
1151 return 0;
1152
1153 if (mmc_card_mmc(card))
1154 opcode = MMC_SEND_TUNING_BLOCK_HS200;
1155 else
1156 opcode = MMC_SEND_TUNING_BLOCK;
1157
1158 err = host->ops->execute_tuning(host, opcode);
1159
1160 if (err)
1161 pr_err("%s: tuning execution failed: %d\n",
1162 mmc_hostname(host), err);
1163 else
1164 mmc_retune_enable(host);
1165
1166 return err;
1167}
1168
1169/*
1170 * Change the bus mode (open drain/push-pull) of a host.
1171 */
1172void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode)
1173{
1174 host->ios.bus_mode = mode;
1175 mmc_set_ios(host);
1176}
1177
1178/*
1179 * Change data bus width of a host.
1180 */
1181void mmc_set_bus_width(struct mmc_host *host, unsigned int width)
1182{
1183 host->ios.bus_width = width;
1184 mmc_set_ios(host);
1185}
1186
1187/*
1188 * Set initial state after a power cycle or a hw_reset.
1189 */
1190void mmc_set_initial_state(struct mmc_host *host)
1191{
1192 mmc_retune_disable(host);
1193
1194 if (mmc_host_is_spi(host))
1195 host->ios.chip_select = MMC_CS_HIGH;
1196 else
1197 host->ios.chip_select = MMC_CS_DONTCARE;
1198 host->ios.bus_mode = MMC_BUSMODE_PUSHPULL;
1199 host->ios.bus_width = MMC_BUS_WIDTH_1;
1200 host->ios.timing = MMC_TIMING_LEGACY;
1201 host->ios.drv_type = 0;
1202 host->ios.enhanced_strobe = false;
1203
1204 /*
1205 * Make sure we are in non-enhanced strobe mode before we
1206 * actually enable it in ext_csd.
1207 */
1208 if ((host->caps2 & MMC_CAP2_HS400_ES) &&
1209 host->ops->hs400_enhanced_strobe)
1210 host->ops->hs400_enhanced_strobe(host, &host->ios);
1211
1212 mmc_set_ios(host);
1213}
1214
1215/**
1216 * mmc_vdd_to_ocrbitnum - Convert a voltage to the OCR bit number
1217 * @vdd: voltage (mV)
1218 * @low_bits: prefer low bits in boundary cases
1219 *
1220 * This function returns the OCR bit number according to the provided @vdd
1221 * value. If conversion is not possible a negative errno value returned.
1222 *
1223 * Depending on the @low_bits flag the function prefers low or high OCR bits
1224 * on boundary voltages. For example,
1225 * with @low_bits = true, 3300 mV translates to ilog2(MMC_VDD_32_33);
1226 * with @low_bits = false, 3300 mV translates to ilog2(MMC_VDD_33_34);
1227 *
1228 * Any value in the [1951:1999] range translates to the ilog2(MMC_VDD_20_21).
1229 */
1230static int mmc_vdd_to_ocrbitnum(int vdd, bool low_bits)
1231{
1232 const int max_bit = ilog2(MMC_VDD_35_36);
1233 int bit;
1234
1235 if (vdd < 1650 || vdd > 3600)
1236 return -EINVAL;
1237
1238 if (vdd >= 1650 && vdd <= 1950)
1239 return ilog2(MMC_VDD_165_195);
1240
1241 if (low_bits)
1242 vdd -= 1;
1243
1244 /* Base 2000 mV, step 100 mV, bit's base 8. */
1245 bit = (vdd - 2000) / 100 + 8;
1246 if (bit > max_bit)
1247 return max_bit;
1248 return bit;
1249}
1250
1251/**
1252 * mmc_vddrange_to_ocrmask - Convert a voltage range to the OCR mask
1253 * @vdd_min: minimum voltage value (mV)
1254 * @vdd_max: maximum voltage value (mV)
1255 *
1256 * This function returns the OCR mask bits according to the provided @vdd_min
1257 * and @vdd_max values. If conversion is not possible the function returns 0.
1258 *
1259 * Notes wrt boundary cases:
1260 * This function sets the OCR bits for all boundary voltages, for example
1261 * [3300:3400] range is translated to MMC_VDD_32_33 | MMC_VDD_33_34 |
1262 * MMC_VDD_34_35 mask.
1263 */
1264u32 mmc_vddrange_to_ocrmask(int vdd_min, int vdd_max)
1265{
1266 u32 mask = 0;
1267
1268 if (vdd_max < vdd_min)
1269 return 0;
1270
1271 /* Prefer high bits for the boundary vdd_max values. */
1272 vdd_max = mmc_vdd_to_ocrbitnum(vdd_max, false);
1273 if (vdd_max < 0)
1274 return 0;
1275
1276 /* Prefer low bits for the boundary vdd_min values. */
1277 vdd_min = mmc_vdd_to_ocrbitnum(vdd_min, true);
1278 if (vdd_min < 0)
1279 return 0;
1280
1281 /* Fill the mask, from max bit to min bit. */
1282 while (vdd_max >= vdd_min)
1283 mask |= 1 << vdd_max--;
1284
1285 return mask;
1286}
1287EXPORT_SYMBOL(mmc_vddrange_to_ocrmask);
1288
1289#ifdef CONFIG_OF
1290
1291/**
1292 * mmc_of_parse_voltage - return mask of supported voltages
1293 * @np: The device node need to be parsed.
1294 * @mask: mask of voltages available for MMC/SD/SDIO
1295 *
1296 * Parse the "voltage-ranges" DT property, returning zero if it is not
1297 * found, negative errno if the voltage-range specification is invalid,
1298 * or one if the voltage-range is specified and successfully parsed.
1299 */
1300int mmc_of_parse_voltage(struct device_node *np, u32 *mask)
1301{
1302 const u32 *voltage_ranges;
1303 int num_ranges, i;
1304
1305 voltage_ranges = of_get_property(np, "voltage-ranges", &num_ranges);
1306 num_ranges = num_ranges / sizeof(*voltage_ranges) / 2;
1307 if (!voltage_ranges) {
1308 pr_debug("%s: voltage-ranges unspecified\n", np->full_name);
1309 return 0;
1310 }
1311 if (!num_ranges) {
1312 pr_err("%s: voltage-ranges empty\n", np->full_name);
1313 return -EINVAL;
1314 }
1315
1316 for (i = 0; i < num_ranges; i++) {
1317 const int j = i * 2;
1318 u32 ocr_mask;
1319
1320 ocr_mask = mmc_vddrange_to_ocrmask(
1321 be32_to_cpu(voltage_ranges[j]),
1322 be32_to_cpu(voltage_ranges[j + 1]));
1323 if (!ocr_mask) {
1324 pr_err("%s: voltage-range #%d is invalid\n",
1325 np->full_name, i);
1326 return -EINVAL;
1327 }
1328 *mask |= ocr_mask;
1329 }
1330
1331 return 1;
1332}
1333EXPORT_SYMBOL(mmc_of_parse_voltage);
1334
1335#endif /* CONFIG_OF */
1336
1337static int mmc_of_get_func_num(struct device_node *node)
1338{
1339 u32 reg;
1340 int ret;
1341
1342 ret = of_property_read_u32(node, "reg", ®);
1343 if (ret < 0)
1344 return ret;
1345
1346 return reg;
1347}
1348
1349struct device_node *mmc_of_find_child_device(struct mmc_host *host,
1350 unsigned func_num)
1351{
1352 struct device_node *node;
1353
1354 if (!host->parent || !host->parent->of_node)
1355 return NULL;
1356
1357 for_each_child_of_node(host->parent->of_node, node) {
1358 if (mmc_of_get_func_num(node) == func_num)
1359 return node;
1360 }
1361
1362 return NULL;
1363}
1364
1365#ifdef CONFIG_REGULATOR
1366
1367/**
1368 * mmc_ocrbitnum_to_vdd - Convert a OCR bit number to its voltage
1369 * @vdd_bit: OCR bit number
1370 * @min_uV: minimum voltage value (mV)
1371 * @max_uV: maximum voltage value (mV)
1372 *
1373 * This function returns the voltage range according to the provided OCR
1374 * bit number. If conversion is not possible a negative errno value returned.
1375 */
1376static int mmc_ocrbitnum_to_vdd(int vdd_bit, int *min_uV, int *max_uV)
1377{
1378 int tmp;
1379
1380 if (!vdd_bit)
1381 return -EINVAL;
1382
1383 /*
1384 * REVISIT mmc_vddrange_to_ocrmask() may have set some
1385 * bits this regulator doesn't quite support ... don't
1386 * be too picky, most cards and regulators are OK with
1387 * a 0.1V range goof (it's a small error percentage).
1388 */
1389 tmp = vdd_bit - ilog2(MMC_VDD_165_195);
1390 if (tmp == 0) {
1391 *min_uV = 1650 * 1000;
1392 *max_uV = 1950 * 1000;
1393 } else {
1394 *min_uV = 1900 * 1000 + tmp * 100 * 1000;
1395 *max_uV = *min_uV + 100 * 1000;
1396 }
1397
1398 return 0;
1399}
1400
1401/**
1402 * mmc_regulator_get_ocrmask - return mask of supported voltages
1403 * @supply: regulator to use
1404 *
1405 * This returns either a negative errno, or a mask of voltages that
1406 * can be provided to MMC/SD/SDIO devices using the specified voltage
1407 * regulator. This would normally be called before registering the
1408 * MMC host adapter.
1409 */
1410int mmc_regulator_get_ocrmask(struct regulator *supply)
1411{
1412 int result = 0;
1413 int count;
1414 int i;
1415 int vdd_uV;
1416 int vdd_mV;
1417
1418 count = regulator_count_voltages(supply);
1419 if (count < 0)
1420 return count;
1421
1422 for (i = 0; i < count; i++) {
1423 vdd_uV = regulator_list_voltage(supply, i);
1424 if (vdd_uV <= 0)
1425 continue;
1426
1427 vdd_mV = vdd_uV / 1000;
1428 result |= mmc_vddrange_to_ocrmask(vdd_mV, vdd_mV);
1429 }
1430
1431 if (!result) {
1432 vdd_uV = regulator_get_voltage(supply);
1433 if (vdd_uV <= 0)
1434 return vdd_uV;
1435
1436 vdd_mV = vdd_uV / 1000;
1437 result = mmc_vddrange_to_ocrmask(vdd_mV, vdd_mV);
1438 }
1439
1440 return result;
1441}
1442EXPORT_SYMBOL_GPL(mmc_regulator_get_ocrmask);
1443
1444/**
1445 * mmc_regulator_set_ocr - set regulator to match host->ios voltage
1446 * @mmc: the host to regulate
1447 * @supply: regulator to use
1448 * @vdd_bit: zero for power off, else a bit number (host->ios.vdd)
1449 *
1450 * Returns zero on success, else negative errno.
1451 *
1452 * MMC host drivers may use this to enable or disable a regulator using
1453 * a particular supply voltage. This would normally be called from the
1454 * set_ios() method.
1455 */
1456int mmc_regulator_set_ocr(struct mmc_host *mmc,
1457 struct regulator *supply,
1458 unsigned short vdd_bit)
1459{
1460 int result = 0;
1461 int min_uV, max_uV;
1462
1463 if (vdd_bit) {
1464 mmc_ocrbitnum_to_vdd(vdd_bit, &min_uV, &max_uV);
1465
1466 result = regulator_set_voltage(supply, min_uV, max_uV);
1467 if (result == 0 && !mmc->regulator_enabled) {
1468 result = regulator_enable(supply);
1469 if (!result)
1470 mmc->regulator_enabled = true;
1471 }
1472 } else if (mmc->regulator_enabled) {
1473 result = regulator_disable(supply);
1474 if (result == 0)
1475 mmc->regulator_enabled = false;
1476 }
1477
1478 if (result)
1479 dev_err(mmc_dev(mmc),
1480 "could not set regulator OCR (%d)\n", result);
1481 return result;
1482}
1483EXPORT_SYMBOL_GPL(mmc_regulator_set_ocr);
1484
1485static int mmc_regulator_set_voltage_if_supported(struct regulator *regulator,
1486 int min_uV, int target_uV,
1487 int max_uV)
1488{
1489 /*
1490 * Check if supported first to avoid errors since we may try several
1491 * signal levels during power up and don't want to show errors.
1492 */
1493 if (!regulator_is_supported_voltage(regulator, min_uV, max_uV))
1494 return -EINVAL;
1495
1496 return regulator_set_voltage_triplet(regulator, min_uV, target_uV,
1497 max_uV);
1498}
1499
1500/**
1501 * mmc_regulator_set_vqmmc - Set VQMMC as per the ios
1502 *
1503 * For 3.3V signaling, we try to match VQMMC to VMMC as closely as possible.
1504 * That will match the behavior of old boards where VQMMC and VMMC were supplied
1505 * by the same supply. The Bus Operating conditions for 3.3V signaling in the
1506 * SD card spec also define VQMMC in terms of VMMC.
1507 * If this is not possible we'll try the full 2.7-3.6V of the spec.
1508 *
1509 * For 1.2V and 1.8V signaling we'll try to get as close as possible to the
1510 * requested voltage. This is definitely a good idea for UHS where there's a
1511 * separate regulator on the card that's trying to make 1.8V and it's best if
1512 * we match.
1513 *
1514 * This function is expected to be used by a controller's
1515 * start_signal_voltage_switch() function.
1516 */
1517int mmc_regulator_set_vqmmc(struct mmc_host *mmc, struct mmc_ios *ios)
1518{
1519 struct device *dev = mmc_dev(mmc);
1520 int ret, volt, min_uV, max_uV;
1521
1522 /* If no vqmmc supply then we can't change the voltage */
1523 if (IS_ERR(mmc->supply.vqmmc))
1524 return -EINVAL;
1525
1526 switch (ios->signal_voltage) {
1527 case MMC_SIGNAL_VOLTAGE_120:
1528 return mmc_regulator_set_voltage_if_supported(mmc->supply.vqmmc,
1529 1100000, 1200000, 1300000);
1530 case MMC_SIGNAL_VOLTAGE_180:
1531 return mmc_regulator_set_voltage_if_supported(mmc->supply.vqmmc,
1532 1700000, 1800000, 1950000);
1533 case MMC_SIGNAL_VOLTAGE_330:
1534 ret = mmc_ocrbitnum_to_vdd(mmc->ios.vdd, &volt, &max_uV);
1535 if (ret < 0)
1536 return ret;
1537
1538 dev_dbg(dev, "%s: found vmmc voltage range of %d-%duV\n",
1539 __func__, volt, max_uV);
1540
1541 min_uV = max(volt - 300000, 2700000);
1542 max_uV = min(max_uV + 200000, 3600000);
1543
1544 /*
1545 * Due to a limitation in the current implementation of
1546 * regulator_set_voltage_triplet() which is taking the lowest
1547 * voltage possible if below the target, search for a suitable
1548 * voltage in two steps and try to stay close to vmmc
1549 * with a 0.3V tolerance at first.
1550 */
1551 if (!mmc_regulator_set_voltage_if_supported(mmc->supply.vqmmc,
1552 min_uV, volt, max_uV))
1553 return 0;
1554
1555 return mmc_regulator_set_voltage_if_supported(mmc->supply.vqmmc,
1556 2700000, volt, 3600000);
1557 default:
1558 return -EINVAL;
1559 }
1560}
1561EXPORT_SYMBOL_GPL(mmc_regulator_set_vqmmc);
1562
1563#endif /* CONFIG_REGULATOR */
1564
1565int mmc_regulator_get_supply(struct mmc_host *mmc)
1566{
1567 struct device *dev = mmc_dev(mmc);
1568 int ret;
1569
1570 mmc->supply.vmmc = devm_regulator_get_optional(dev, "vmmc");
1571 mmc->supply.vqmmc = devm_regulator_get_optional(dev, "vqmmc");
1572
1573 if (IS_ERR(mmc->supply.vmmc)) {
1574 if (PTR_ERR(mmc->supply.vmmc) == -EPROBE_DEFER)
1575 return -EPROBE_DEFER;
1576 dev_dbg(dev, "No vmmc regulator found\n");
1577 } else {
1578 ret = mmc_regulator_get_ocrmask(mmc->supply.vmmc);
1579 if (ret > 0)
1580 mmc->ocr_avail = ret;
1581 else
1582 dev_warn(dev, "Failed getting OCR mask: %d\n", ret);
1583 }
1584
1585 if (IS_ERR(mmc->supply.vqmmc)) {
1586 if (PTR_ERR(mmc->supply.vqmmc) == -EPROBE_DEFER)
1587 return -EPROBE_DEFER;
1588 dev_dbg(dev, "No vqmmc regulator found\n");
1589 }
1590
1591 return 0;
1592}
1593EXPORT_SYMBOL_GPL(mmc_regulator_get_supply);
1594
1595/*
1596 * Mask off any voltages we don't support and select
1597 * the lowest voltage
1598 */
1599u32 mmc_select_voltage(struct mmc_host *host, u32 ocr)
1600{
1601 int bit;
1602
1603 /*
1604 * Sanity check the voltages that the card claims to
1605 * support.
1606 */
1607 if (ocr & 0x7F) {
1608 dev_warn(mmc_dev(host),
1609 "card claims to support voltages below defined range\n");
1610 ocr &= ~0x7F;
1611 }
1612
1613 ocr &= host->ocr_avail;
1614 if (!ocr) {
1615 dev_warn(mmc_dev(host), "no support for card's volts\n");
1616 return 0;
1617 }
1618
1619 if (host->caps2 & MMC_CAP2_FULL_PWR_CYCLE) {
1620 bit = ffs(ocr) - 1;
1621 ocr &= 3 << bit;
1622 mmc_power_cycle(host, ocr);
1623 } else {
1624 bit = fls(ocr) - 1;
1625 ocr &= 3 << bit;
1626 if (bit != host->ios.vdd)
1627 dev_warn(mmc_dev(host), "exceeding card's volts\n");
1628 }
1629
1630 return ocr;
1631}
1632
1633int __mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage)
1634{
1635 int err = 0;
1636 int old_signal_voltage = host->ios.signal_voltage;
1637
1638 host->ios.signal_voltage = signal_voltage;
1639 if (host->ops->start_signal_voltage_switch)
1640 err = host->ops->start_signal_voltage_switch(host, &host->ios);
1641
1642 if (err)
1643 host->ios.signal_voltage = old_signal_voltage;
1644
1645 return err;
1646
1647}
1648
1649int mmc_set_signal_voltage(struct mmc_host *host, int signal_voltage, u32 ocr)
1650{
1651 struct mmc_command cmd = {0};
1652 int err = 0;
1653 u32 clock;
1654
1655 /*
1656 * Send CMD11 only if the request is to switch the card to
1657 * 1.8V signalling.
1658 */
1659 if (signal_voltage == MMC_SIGNAL_VOLTAGE_330)
1660 return __mmc_set_signal_voltage(host, signal_voltage);
1661
1662 /*
1663 * If we cannot switch voltages, return failure so the caller
1664 * can continue without UHS mode
1665 */
1666 if (!host->ops->start_signal_voltage_switch)
1667 return -EPERM;
1668 if (!host->ops->card_busy)
1669 pr_warn("%s: cannot verify signal voltage switch\n",
1670 mmc_hostname(host));
1671
1672 cmd.opcode = SD_SWITCH_VOLTAGE;
1673 cmd.arg = 0;
1674 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1675
1676 err = mmc_wait_for_cmd(host, &cmd, 0);
1677 if (err)
1678 return err;
1679
1680 if (!mmc_host_is_spi(host) && (cmd.resp[0] & R1_ERROR))
1681 return -EIO;
1682
1683 /*
1684 * The card should drive cmd and dat[0:3] low immediately
1685 * after the response of cmd11, but wait 1 ms to be sure
1686 */
1687 mmc_delay(1);
1688 if (host->ops->card_busy && !host->ops->card_busy(host)) {
1689 err = -EAGAIN;
1690 goto power_cycle;
1691 }
1692 /*
1693 * During a signal voltage level switch, the clock must be gated
1694 * for 5 ms according to the SD spec
1695 */
1696 clock = host->ios.clock;
1697 host->ios.clock = 0;
1698 mmc_set_ios(host);
1699
1700 if (__mmc_set_signal_voltage(host, signal_voltage)) {
1701 /*
1702 * Voltages may not have been switched, but we've already
1703 * sent CMD11, so a power cycle is required anyway
1704 */
1705 err = -EAGAIN;
1706 goto power_cycle;
1707 }
1708
1709 /* Keep clock gated for at least 10 ms, though spec only says 5 ms */
1710 mmc_delay(10);
1711 host->ios.clock = clock;
1712 mmc_set_ios(host);
1713
1714 /* Wait for at least 1 ms according to spec */
1715 mmc_delay(1);
1716
1717 /*
1718 * Failure to switch is indicated by the card holding
1719 * dat[0:3] low
1720 */
1721 if (host->ops->card_busy && host->ops->card_busy(host))
1722 err = -EAGAIN;
1723
1724power_cycle:
1725 if (err) {
1726 pr_debug("%s: Signal voltage switch failed, "
1727 "power cycling card\n", mmc_hostname(host));
1728 mmc_power_cycle(host, ocr);
1729 }
1730
1731 return err;
1732}
1733
1734/*
1735 * Select timing parameters for host.
1736 */
1737void mmc_set_timing(struct mmc_host *host, unsigned int timing)
1738{
1739 host->ios.timing = timing;
1740 mmc_set_ios(host);
1741}
1742
1743/*
1744 * Select appropriate driver type for host.
1745 */
1746void mmc_set_driver_type(struct mmc_host *host, unsigned int drv_type)
1747{
1748 host->ios.drv_type = drv_type;
1749 mmc_set_ios(host);
1750}
1751
1752int mmc_select_drive_strength(struct mmc_card *card, unsigned int max_dtr,
1753 int card_drv_type, int *drv_type)
1754{
1755 struct mmc_host *host = card->host;
1756 int host_drv_type = SD_DRIVER_TYPE_B;
1757
1758 *drv_type = 0;
1759
1760 if (!host->ops->select_drive_strength)
1761 return 0;
1762
1763 /* Use SD definition of driver strength for hosts */
1764 if (host->caps & MMC_CAP_DRIVER_TYPE_A)
1765 host_drv_type |= SD_DRIVER_TYPE_A;
1766
1767 if (host->caps & MMC_CAP_DRIVER_TYPE_C)
1768 host_drv_type |= SD_DRIVER_TYPE_C;
1769
1770 if (host->caps & MMC_CAP_DRIVER_TYPE_D)
1771 host_drv_type |= SD_DRIVER_TYPE_D;
1772
1773 /*
1774 * The drive strength that the hardware can support
1775 * depends on the board design. Pass the appropriate
1776 * information and let the hardware specific code
1777 * return what is possible given the options
1778 */
1779 return host->ops->select_drive_strength(card, max_dtr,
1780 host_drv_type,
1781 card_drv_type,
1782 drv_type);
1783}
1784
1785/*
1786 * Apply power to the MMC stack. This is a two-stage process.
1787 * First, we enable power to the card without the clock running.
1788 * We then wait a bit for the power to stabilise. Finally,
1789 * enable the bus drivers and clock to the card.
1790 *
1791 * We must _NOT_ enable the clock prior to power stablising.
1792 *
1793 * If a host does all the power sequencing itself, ignore the
1794 * initial MMC_POWER_UP stage.
1795 */
1796void mmc_power_up(struct mmc_host *host, u32 ocr)
1797{
1798 if (host->ios.power_mode == MMC_POWER_ON)
1799 return;
1800
1801 mmc_pwrseq_pre_power_on(host);
1802
1803 host->ios.vdd = fls(ocr) - 1;
1804 host->ios.power_mode = MMC_POWER_UP;
1805 /* Set initial state and call mmc_set_ios */
1806 mmc_set_initial_state(host);
1807
1808 /* Try to set signal voltage to 3.3V but fall back to 1.8v or 1.2v */
1809 if (__mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_330) == 0)
1810 dev_dbg(mmc_dev(host), "Initial signal voltage of 3.3v\n");
1811 else if (__mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_180) == 0)
1812 dev_dbg(mmc_dev(host), "Initial signal voltage of 1.8v\n");
1813 else if (__mmc_set_signal_voltage(host, MMC_SIGNAL_VOLTAGE_120) == 0)
1814 dev_dbg(mmc_dev(host), "Initial signal voltage of 1.2v\n");
1815
1816 /*
1817 * This delay should be sufficient to allow the power supply
1818 * to reach the minimum voltage.
1819 */
1820 mmc_delay(10);
1821
1822 mmc_pwrseq_post_power_on(host);
1823
1824 host->ios.clock = host->f_init;
1825
1826 host->ios.power_mode = MMC_POWER_ON;
1827 mmc_set_ios(host);
1828
1829 /*
1830 * This delay must be at least 74 clock sizes, or 1 ms, or the
1831 * time required to reach a stable voltage.
1832 */
1833 mmc_delay(10);
1834}
1835
1836void mmc_power_off(struct mmc_host *host)
1837{
1838 if (host->ios.power_mode == MMC_POWER_OFF)
1839 return;
1840
1841 mmc_pwrseq_power_off(host);
1842
1843 host->ios.clock = 0;
1844 host->ios.vdd = 0;
1845
1846 host->ios.power_mode = MMC_POWER_OFF;
1847 /* Set initial state and call mmc_set_ios */
1848 mmc_set_initial_state(host);
1849
1850 /*
1851 * Some configurations, such as the 802.11 SDIO card in the OLPC
1852 * XO-1.5, require a short delay after poweroff before the card
1853 * can be successfully turned on again.
1854 */
1855 mmc_delay(1);
1856}
1857
1858void mmc_power_cycle(struct mmc_host *host, u32 ocr)
1859{
1860 mmc_power_off(host);
1861 /* Wait at least 1 ms according to SD spec */
1862 mmc_delay(1);
1863 mmc_power_up(host, ocr);
1864}
1865
1866/*
1867 * Cleanup when the last reference to the bus operator is dropped.
1868 */
1869static void __mmc_release_bus(struct mmc_host *host)
1870{
1871 WARN_ON(!host->bus_dead);
1872
1873 host->bus_ops = NULL;
1874}
1875
1876/*
1877 * Increase reference count of bus operator
1878 */
1879static inline void mmc_bus_get(struct mmc_host *host)
1880{
1881 unsigned long flags;
1882
1883 spin_lock_irqsave(&host->lock, flags);
1884 host->bus_refs++;
1885 spin_unlock_irqrestore(&host->lock, flags);
1886}
1887
1888/*
1889 * Decrease reference count of bus operator and free it if
1890 * it is the last reference.
1891 */
1892static inline void mmc_bus_put(struct mmc_host *host)
1893{
1894 unsigned long flags;
1895
1896 spin_lock_irqsave(&host->lock, flags);
1897 host->bus_refs--;
1898 if ((host->bus_refs == 0) && host->bus_ops)
1899 __mmc_release_bus(host);
1900 spin_unlock_irqrestore(&host->lock, flags);
1901}
1902
1903/*
1904 * Assign a mmc bus handler to a host. Only one bus handler may control a
1905 * host at any given time.
1906 */
1907void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops)
1908{
1909 unsigned long flags;
1910
1911 WARN_ON(!host->claimed);
1912
1913 spin_lock_irqsave(&host->lock, flags);
1914
1915 WARN_ON(host->bus_ops);
1916 WARN_ON(host->bus_refs);
1917
1918 host->bus_ops = ops;
1919 host->bus_refs = 1;
1920 host->bus_dead = 0;
1921
1922 spin_unlock_irqrestore(&host->lock, flags);
1923}
1924
1925/*
1926 * Remove the current bus handler from a host.
1927 */
1928void mmc_detach_bus(struct mmc_host *host)
1929{
1930 unsigned long flags;
1931
1932 WARN_ON(!host->claimed);
1933 WARN_ON(!host->bus_ops);
1934
1935 spin_lock_irqsave(&host->lock, flags);
1936
1937 host->bus_dead = 1;
1938
1939 spin_unlock_irqrestore(&host->lock, flags);
1940
1941 mmc_bus_put(host);
1942}
1943
1944static void _mmc_detect_change(struct mmc_host *host, unsigned long delay,
1945 bool cd_irq)
1946{
1947#ifdef CONFIG_MMC_DEBUG
1948 unsigned long flags;
1949 spin_lock_irqsave(&host->lock, flags);
1950 WARN_ON(host->removed);
1951 spin_unlock_irqrestore(&host->lock, flags);
1952#endif
1953
1954 /*
1955 * If the device is configured as wakeup, we prevent a new sleep for
1956 * 5 s to give provision for user space to consume the event.
1957 */
1958 if (cd_irq && !(host->caps & MMC_CAP_NEEDS_POLL) &&
1959 device_can_wakeup(mmc_dev(host)))
1960 pm_wakeup_event(mmc_dev(host), 5000);
1961
1962 host->detect_change = 1;
1963 mmc_schedule_delayed_work(&host->detect, delay);
1964}
1965
1966/**
1967 * mmc_detect_change - process change of state on a MMC socket
1968 * @host: host which changed state.
1969 * @delay: optional delay to wait before detection (jiffies)
1970 *
1971 * MMC drivers should call this when they detect a card has been
1972 * inserted or removed. The MMC layer will confirm that any
1973 * present card is still functional, and initialize any newly
1974 * inserted.
1975 */
1976void mmc_detect_change(struct mmc_host *host, unsigned long delay)
1977{
1978 _mmc_detect_change(host, delay, true);
1979}
1980EXPORT_SYMBOL(mmc_detect_change);
1981
1982void mmc_init_erase(struct mmc_card *card)
1983{
1984 unsigned int sz;
1985
1986 if (is_power_of_2(card->erase_size))
1987 card->erase_shift = ffs(card->erase_size) - 1;
1988 else
1989 card->erase_shift = 0;
1990
1991 /*
1992 * It is possible to erase an arbitrarily large area of an SD or MMC
1993 * card. That is not desirable because it can take a long time
1994 * (minutes) potentially delaying more important I/O, and also the
1995 * timeout calculations become increasingly hugely over-estimated.
1996 * Consequently, 'pref_erase' is defined as a guide to limit erases
1997 * to that size and alignment.
1998 *
1999 * For SD cards that define Allocation Unit size, limit erases to one
2000 * Allocation Unit at a time.
2001 * For MMC, have a stab at ai good value and for modern cards it will
2002 * end up being 4MiB. Note that if the value is too small, it can end
2003 * up taking longer to erase. Also note, erase_size is already set to
2004 * High Capacity Erase Size if available when this function is called.
2005 */
2006 if (mmc_card_sd(card) && card->ssr.au) {
2007 card->pref_erase = card->ssr.au;
2008 card->erase_shift = ffs(card->ssr.au) - 1;
2009 } else if (card->erase_size) {
2010 sz = (card->csd.capacity << (card->csd.read_blkbits - 9)) >> 11;
2011 if (sz < 128)
2012 card->pref_erase = 512 * 1024 / 512;
2013 else if (sz < 512)
2014 card->pref_erase = 1024 * 1024 / 512;
2015 else if (sz < 1024)
2016 card->pref_erase = 2 * 1024 * 1024 / 512;
2017 else
2018 card->pref_erase = 4 * 1024 * 1024 / 512;
2019 if (card->pref_erase < card->erase_size)
2020 card->pref_erase = card->erase_size;
2021 else {
2022 sz = card->pref_erase % card->erase_size;
2023 if (sz)
2024 card->pref_erase += card->erase_size - sz;
2025 }
2026 } else
2027 card->pref_erase = 0;
2028}
2029
2030static unsigned int mmc_mmc_erase_timeout(struct mmc_card *card,
2031 unsigned int arg, unsigned int qty)
2032{
2033 unsigned int erase_timeout;
2034
2035 if (arg == MMC_DISCARD_ARG ||
2036 (arg == MMC_TRIM_ARG && card->ext_csd.rev >= 6)) {
2037 erase_timeout = card->ext_csd.trim_timeout;
2038 } else if (card->ext_csd.erase_group_def & 1) {
2039 /* High Capacity Erase Group Size uses HC timeouts */
2040 if (arg == MMC_TRIM_ARG)
2041 erase_timeout = card->ext_csd.trim_timeout;
2042 else
2043 erase_timeout = card->ext_csd.hc_erase_timeout;
2044 } else {
2045 /* CSD Erase Group Size uses write timeout */
2046 unsigned int mult = (10 << card->csd.r2w_factor);
2047 unsigned int timeout_clks = card->csd.tacc_clks * mult;
2048 unsigned int timeout_us;
2049
2050 /* Avoid overflow: e.g. tacc_ns=80000000 mult=1280 */
2051 if (card->csd.tacc_ns < 1000000)
2052 timeout_us = (card->csd.tacc_ns * mult) / 1000;
2053 else
2054 timeout_us = (card->csd.tacc_ns / 1000) * mult;
2055
2056 /*
2057 * ios.clock is only a target. The real clock rate might be
2058 * less but not that much less, so fudge it by multiplying by 2.
2059 */
2060 timeout_clks <<= 1;
2061 timeout_us += (timeout_clks * 1000) /
2062 (card->host->ios.clock / 1000);
2063
2064 erase_timeout = timeout_us / 1000;
2065
2066 /*
2067 * Theoretically, the calculation could underflow so round up
2068 * to 1ms in that case.
2069 */
2070 if (!erase_timeout)
2071 erase_timeout = 1;
2072 }
2073
2074 /* Multiplier for secure operations */
2075 if (arg & MMC_SECURE_ARGS) {
2076 if (arg == MMC_SECURE_ERASE_ARG)
2077 erase_timeout *= card->ext_csd.sec_erase_mult;
2078 else
2079 erase_timeout *= card->ext_csd.sec_trim_mult;
2080 }
2081
2082 erase_timeout *= qty;
2083
2084 /*
2085 * Ensure at least a 1 second timeout for SPI as per
2086 * 'mmc_set_data_timeout()'
2087 */
2088 if (mmc_host_is_spi(card->host) && erase_timeout < 1000)
2089 erase_timeout = 1000;
2090
2091 return erase_timeout;
2092}
2093
2094static unsigned int mmc_sd_erase_timeout(struct mmc_card *card,
2095 unsigned int arg,
2096 unsigned int qty)
2097{
2098 unsigned int erase_timeout;
2099
2100 if (card->ssr.erase_timeout) {
2101 /* Erase timeout specified in SD Status Register (SSR) */
2102 erase_timeout = card->ssr.erase_timeout * qty +
2103 card->ssr.erase_offset;
2104 } else {
2105 /*
2106 * Erase timeout not specified in SD Status Register (SSR) so
2107 * use 250ms per write block.
2108 */
2109 erase_timeout = 250 * qty;
2110 }
2111
2112 /* Must not be less than 1 second */
2113 if (erase_timeout < 1000)
2114 erase_timeout = 1000;
2115
2116 return erase_timeout;
2117}
2118
2119static unsigned int mmc_erase_timeout(struct mmc_card *card,
2120 unsigned int arg,
2121 unsigned int qty)
2122{
2123 if (mmc_card_sd(card))
2124 return mmc_sd_erase_timeout(card, arg, qty);
2125 else
2126 return mmc_mmc_erase_timeout(card, arg, qty);
2127}
2128
2129static int mmc_do_erase(struct mmc_card *card, unsigned int from,
2130 unsigned int to, unsigned int arg)
2131{
2132 struct mmc_command cmd = {0};
2133 unsigned int qty = 0, busy_timeout = 0;
2134 bool use_r1b_resp = false;
2135 unsigned long timeout;
2136 int err;
2137
2138 mmc_retune_hold(card->host);
2139
2140 /*
2141 * qty is used to calculate the erase timeout which depends on how many
2142 * erase groups (or allocation units in SD terminology) are affected.
2143 * We count erasing part of an erase group as one erase group.
2144 * For SD, the allocation units are always a power of 2. For MMC, the
2145 * erase group size is almost certainly also power of 2, but it does not
2146 * seem to insist on that in the JEDEC standard, so we fall back to
2147 * division in that case. SD may not specify an allocation unit size,
2148 * in which case the timeout is based on the number of write blocks.
2149 *
2150 * Note that the timeout for secure trim 2 will only be correct if the
2151 * number of erase groups specified is the same as the total of all
2152 * preceding secure trim 1 commands. Since the power may have been
2153 * lost since the secure trim 1 commands occurred, it is generally
2154 * impossible to calculate the secure trim 2 timeout correctly.
2155 */
2156 if (card->erase_shift)
2157 qty += ((to >> card->erase_shift) -
2158 (from >> card->erase_shift)) + 1;
2159 else if (mmc_card_sd(card))
2160 qty += to - from + 1;
2161 else
2162 qty += ((to / card->erase_size) -
2163 (from / card->erase_size)) + 1;
2164
2165 if (!mmc_card_blockaddr(card)) {
2166 from <<= 9;
2167 to <<= 9;
2168 }
2169
2170 if (mmc_card_sd(card))
2171 cmd.opcode = SD_ERASE_WR_BLK_START;
2172 else
2173 cmd.opcode = MMC_ERASE_GROUP_START;
2174 cmd.arg = from;
2175 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2176 err = mmc_wait_for_cmd(card->host, &cmd, 0);
2177 if (err) {
2178 pr_err("mmc_erase: group start error %d, "
2179 "status %#x\n", err, cmd.resp[0]);
2180 err = -EIO;
2181 goto out;
2182 }
2183
2184 memset(&cmd, 0, sizeof(struct mmc_command));
2185 if (mmc_card_sd(card))
2186 cmd.opcode = SD_ERASE_WR_BLK_END;
2187 else
2188 cmd.opcode = MMC_ERASE_GROUP_END;
2189 cmd.arg = to;
2190 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2191 err = mmc_wait_for_cmd(card->host, &cmd, 0);
2192 if (err) {
2193 pr_err("mmc_erase: group end error %d, status %#x\n",
2194 err, cmd.resp[0]);
2195 err = -EIO;
2196 goto out;
2197 }
2198
2199 memset(&cmd, 0, sizeof(struct mmc_command));
2200 cmd.opcode = MMC_ERASE;
2201 cmd.arg = arg;
2202 busy_timeout = mmc_erase_timeout(card, arg, qty);
2203 /*
2204 * If the host controller supports busy signalling and the timeout for
2205 * the erase operation does not exceed the max_busy_timeout, we should
2206 * use R1B response. Or we need to prevent the host from doing hw busy
2207 * detection, which is done by converting to a R1 response instead.
2208 */
2209 if (card->host->max_busy_timeout &&
2210 busy_timeout > card->host->max_busy_timeout) {
2211 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2212 } else {
2213 cmd.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
2214 cmd.busy_timeout = busy_timeout;
2215 use_r1b_resp = true;
2216 }
2217
2218 err = mmc_wait_for_cmd(card->host, &cmd, 0);
2219 if (err) {
2220 pr_err("mmc_erase: erase error %d, status %#x\n",
2221 err, cmd.resp[0]);
2222 err = -EIO;
2223 goto out;
2224 }
2225
2226 if (mmc_host_is_spi(card->host))
2227 goto out;
2228
2229 /*
2230 * In case of when R1B + MMC_CAP_WAIT_WHILE_BUSY is used, the polling
2231 * shall be avoided.
2232 */
2233 if ((card->host->caps & MMC_CAP_WAIT_WHILE_BUSY) && use_r1b_resp)
2234 goto out;
2235
2236 timeout = jiffies + msecs_to_jiffies(busy_timeout);
2237 do {
2238 memset(&cmd, 0, sizeof(struct mmc_command));
2239 cmd.opcode = MMC_SEND_STATUS;
2240 cmd.arg = card->rca << 16;
2241 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
2242 /* Do not retry else we can't see errors */
2243 err = mmc_wait_for_cmd(card->host, &cmd, 0);
2244 if (err || (cmd.resp[0] & 0xFDF92000)) {
2245 pr_err("error %d requesting status %#x\n",
2246 err, cmd.resp[0]);
2247 err = -EIO;
2248 goto out;
2249 }
2250
2251 /* Timeout if the device never becomes ready for data and
2252 * never leaves the program state.
2253 */
2254 if (time_after(jiffies, timeout)) {
2255 pr_err("%s: Card stuck in programming state! %s\n",
2256 mmc_hostname(card->host), __func__);
2257 err = -EIO;
2258 goto out;
2259 }
2260
2261 } while (!(cmd.resp[0] & R1_READY_FOR_DATA) ||
2262 (R1_CURRENT_STATE(cmd.resp[0]) == R1_STATE_PRG));
2263out:
2264 mmc_retune_release(card->host);
2265 return err;
2266}
2267
2268static unsigned int mmc_align_erase_size(struct mmc_card *card,
2269 unsigned int *from,
2270 unsigned int *to,
2271 unsigned int nr)
2272{
2273 unsigned int from_new = *from, nr_new = nr, rem;
2274
2275 /*
2276 * When the 'card->erase_size' is power of 2, we can use round_up/down()
2277 * to align the erase size efficiently.
2278 */
2279 if (is_power_of_2(card->erase_size)) {
2280 unsigned int temp = from_new;
2281
2282 from_new = round_up(temp, card->erase_size);
2283 rem = from_new - temp;
2284
2285 if (nr_new > rem)
2286 nr_new -= rem;
2287 else
2288 return 0;
2289
2290 nr_new = round_down(nr_new, card->erase_size);
2291 } else {
2292 rem = from_new % card->erase_size;
2293 if (rem) {
2294 rem = card->erase_size - rem;
2295 from_new += rem;
2296 if (nr_new > rem)
2297 nr_new -= rem;
2298 else
2299 return 0;
2300 }
2301
2302 rem = nr_new % card->erase_size;
2303 if (rem)
2304 nr_new -= rem;
2305 }
2306
2307 if (nr_new == 0)
2308 return 0;
2309
2310 *to = from_new + nr_new;
2311 *from = from_new;
2312
2313 return nr_new;
2314}
2315
2316/**
2317 * mmc_erase - erase sectors.
2318 * @card: card to erase
2319 * @from: first sector to erase
2320 * @nr: number of sectors to erase
2321 * @arg: erase command argument (SD supports only %MMC_ERASE_ARG)
2322 *
2323 * Caller must claim host before calling this function.
2324 */
2325int mmc_erase(struct mmc_card *card, unsigned int from, unsigned int nr,
2326 unsigned int arg)
2327{
2328 unsigned int rem, to = from + nr;
2329 int err;
2330
2331 if (!(card->host->caps & MMC_CAP_ERASE) ||
2332 !(card->csd.cmdclass & CCC_ERASE))
2333 return -EOPNOTSUPP;
2334
2335 if (!card->erase_size)
2336 return -EOPNOTSUPP;
2337
2338 if (mmc_card_sd(card) && arg != MMC_ERASE_ARG)
2339 return -EOPNOTSUPP;
2340
2341 if ((arg & MMC_SECURE_ARGS) &&
2342 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN))
2343 return -EOPNOTSUPP;
2344
2345 if ((arg & MMC_TRIM_ARGS) &&
2346 !(card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN))
2347 return -EOPNOTSUPP;
2348
2349 if (arg == MMC_SECURE_ERASE_ARG) {
2350 if (from % card->erase_size || nr % card->erase_size)
2351 return -EINVAL;
2352 }
2353
2354 if (arg == MMC_ERASE_ARG)
2355 nr = mmc_align_erase_size(card, &from, &to, nr);
2356
2357 if (nr == 0)
2358 return 0;
2359
2360 if (to <= from)
2361 return -EINVAL;
2362
2363 /* 'from' and 'to' are inclusive */
2364 to -= 1;
2365
2366 /*
2367 * Special case where only one erase-group fits in the timeout budget:
2368 * If the region crosses an erase-group boundary on this particular
2369 * case, we will be trimming more than one erase-group which, does not
2370 * fit in the timeout budget of the controller, so we need to split it
2371 * and call mmc_do_erase() twice if necessary. This special case is
2372 * identified by the card->eg_boundary flag.
2373 */
2374 rem = card->erase_size - (from % card->erase_size);
2375 if ((arg & MMC_TRIM_ARGS) && (card->eg_boundary) && (nr > rem)) {
2376 err = mmc_do_erase(card, from, from + rem - 1, arg);
2377 from += rem;
2378 if ((err) || (to <= from))
2379 return err;
2380 }
2381
2382 return mmc_do_erase(card, from, to, arg);
2383}
2384EXPORT_SYMBOL(mmc_erase);
2385
2386int mmc_can_erase(struct mmc_card *card)
2387{
2388 if ((card->host->caps & MMC_CAP_ERASE) &&
2389 (card->csd.cmdclass & CCC_ERASE) && card->erase_size)
2390 return 1;
2391 return 0;
2392}
2393EXPORT_SYMBOL(mmc_can_erase);
2394
2395int mmc_can_trim(struct mmc_card *card)
2396{
2397 if ((card->ext_csd.sec_feature_support & EXT_CSD_SEC_GB_CL_EN) &&
2398 (!(card->quirks & MMC_QUIRK_TRIM_BROKEN)))
2399 return 1;
2400 return 0;
2401}
2402EXPORT_SYMBOL(mmc_can_trim);
2403
2404int mmc_can_discard(struct mmc_card *card)
2405{
2406 /*
2407 * As there's no way to detect the discard support bit at v4.5
2408 * use the s/w feature support filed.
2409 */
2410 if (card->ext_csd.feature_support & MMC_DISCARD_FEATURE)
2411 return 1;
2412 return 0;
2413}
2414EXPORT_SYMBOL(mmc_can_discard);
2415
2416int mmc_can_sanitize(struct mmc_card *card)
2417{
2418 if (!mmc_can_trim(card) && !mmc_can_erase(card))
2419 return 0;
2420 if (card->ext_csd.sec_feature_support & EXT_CSD_SEC_SANITIZE)
2421 return 1;
2422 return 0;
2423}
2424EXPORT_SYMBOL(mmc_can_sanitize);
2425
2426int mmc_can_secure_erase_trim(struct mmc_card *card)
2427{
2428 if ((card->ext_csd.sec_feature_support & EXT_CSD_SEC_ER_EN) &&
2429 !(card->quirks & MMC_QUIRK_SEC_ERASE_TRIM_BROKEN))
2430 return 1;
2431 return 0;
2432}
2433EXPORT_SYMBOL(mmc_can_secure_erase_trim);
2434
2435int mmc_erase_group_aligned(struct mmc_card *card, unsigned int from,
2436 unsigned int nr)
2437{
2438 if (!card->erase_size)
2439 return 0;
2440 if (from % card->erase_size || nr % card->erase_size)
2441 return 0;
2442 return 1;
2443}
2444EXPORT_SYMBOL(mmc_erase_group_aligned);
2445
2446static unsigned int mmc_do_calc_max_discard(struct mmc_card *card,
2447 unsigned int arg)
2448{
2449 struct mmc_host *host = card->host;
2450 unsigned int max_discard, x, y, qty = 0, max_qty, min_qty, timeout;
2451 unsigned int last_timeout = 0;
2452 unsigned int max_busy_timeout = host->max_busy_timeout ?
2453 host->max_busy_timeout : MMC_ERASE_TIMEOUT_MS;
2454
2455 if (card->erase_shift) {
2456 max_qty = UINT_MAX >> card->erase_shift;
2457 min_qty = card->pref_erase >> card->erase_shift;
2458 } else if (mmc_card_sd(card)) {
2459 max_qty = UINT_MAX;
2460 min_qty = card->pref_erase;
2461 } else {
2462 max_qty = UINT_MAX / card->erase_size;
2463 min_qty = card->pref_erase / card->erase_size;
2464 }
2465
2466 /*
2467 * We should not only use 'host->max_busy_timeout' as the limitation
2468 * when deciding the max discard sectors. We should set a balance value
2469 * to improve the erase speed, and it can not get too long timeout at
2470 * the same time.
2471 *
2472 * Here we set 'card->pref_erase' as the minimal discard sectors no
2473 * matter what size of 'host->max_busy_timeout', but if the
2474 * 'host->max_busy_timeout' is large enough for more discard sectors,
2475 * then we can continue to increase the max discard sectors until we
2476 * get a balance value. In cases when the 'host->max_busy_timeout'
2477 * isn't specified, use the default max erase timeout.
2478 */
2479 do {
2480 y = 0;
2481 for (x = 1; x && x <= max_qty && max_qty - x >= qty; x <<= 1) {
2482 timeout = mmc_erase_timeout(card, arg, qty + x);
2483
2484 if (qty + x > min_qty && timeout > max_busy_timeout)
2485 break;
2486
2487 if (timeout < last_timeout)
2488 break;
2489 last_timeout = timeout;
2490 y = x;
2491 }
2492 qty += y;
2493 } while (y);
2494
2495 if (!qty)
2496 return 0;
2497
2498 /*
2499 * When specifying a sector range to trim, chances are we might cross
2500 * an erase-group boundary even if the amount of sectors is less than
2501 * one erase-group.
2502 * If we can only fit one erase-group in the controller timeout budget,
2503 * we have to care that erase-group boundaries are not crossed by a
2504 * single trim operation. We flag that special case with "eg_boundary".
2505 * In all other cases we can just decrement qty and pretend that we
2506 * always touch (qty + 1) erase-groups as a simple optimization.
2507 */
2508 if (qty == 1)
2509 card->eg_boundary = 1;
2510 else
2511 qty--;
2512
2513 /* Convert qty to sectors */
2514 if (card->erase_shift)
2515 max_discard = qty << card->erase_shift;
2516 else if (mmc_card_sd(card))
2517 max_discard = qty + 1;
2518 else
2519 max_discard = qty * card->erase_size;
2520
2521 return max_discard;
2522}
2523
2524unsigned int mmc_calc_max_discard(struct mmc_card *card)
2525{
2526 struct mmc_host *host = card->host;
2527 unsigned int max_discard, max_trim;
2528
2529 /*
2530 * Without erase_group_def set, MMC erase timeout depends on clock
2531 * frequence which can change. In that case, the best choice is
2532 * just the preferred erase size.
2533 */
2534 if (mmc_card_mmc(card) && !(card->ext_csd.erase_group_def & 1))
2535 return card->pref_erase;
2536
2537 max_discard = mmc_do_calc_max_discard(card, MMC_ERASE_ARG);
2538 if (mmc_can_trim(card)) {
2539 max_trim = mmc_do_calc_max_discard(card, MMC_TRIM_ARG);
2540 if (max_trim < max_discard)
2541 max_discard = max_trim;
2542 } else if (max_discard < card->erase_size) {
2543 max_discard = 0;
2544 }
2545 pr_debug("%s: calculated max. discard sectors %u for timeout %u ms\n",
2546 mmc_hostname(host), max_discard, host->max_busy_timeout ?
2547 host->max_busy_timeout : MMC_ERASE_TIMEOUT_MS);
2548 return max_discard;
2549}
2550EXPORT_SYMBOL(mmc_calc_max_discard);
2551
2552int mmc_set_blocklen(struct mmc_card *card, unsigned int blocklen)
2553{
2554 struct mmc_command cmd = {0};
2555
2556 if (mmc_card_blockaddr(card) || mmc_card_ddr52(card) ||
2557 mmc_card_hs400(card) || mmc_card_hs400es(card))
2558 return 0;
2559
2560 cmd.opcode = MMC_SET_BLOCKLEN;
2561 cmd.arg = blocklen;
2562 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2563 return mmc_wait_for_cmd(card->host, &cmd, 5);
2564}
2565EXPORT_SYMBOL(mmc_set_blocklen);
2566
2567int mmc_set_blockcount(struct mmc_card *card, unsigned int blockcount,
2568 bool is_rel_write)
2569{
2570 struct mmc_command cmd = {0};
2571
2572 cmd.opcode = MMC_SET_BLOCK_COUNT;
2573 cmd.arg = blockcount & 0x0000FFFF;
2574 if (is_rel_write)
2575 cmd.arg |= 1 << 31;
2576 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
2577 return mmc_wait_for_cmd(card->host, &cmd, 5);
2578}
2579EXPORT_SYMBOL(mmc_set_blockcount);
2580
2581static void mmc_hw_reset_for_init(struct mmc_host *host)
2582{
2583 if (!(host->caps & MMC_CAP_HW_RESET) || !host->ops->hw_reset)
2584 return;
2585 host->ops->hw_reset(host);
2586}
2587
2588int mmc_hw_reset(struct mmc_host *host)
2589{
2590 int ret;
2591
2592 if (!host->card)
2593 return -EINVAL;
2594
2595 mmc_bus_get(host);
2596 if (!host->bus_ops || host->bus_dead || !host->bus_ops->reset) {
2597 mmc_bus_put(host);
2598 return -EOPNOTSUPP;
2599 }
2600
2601 ret = host->bus_ops->reset(host);
2602 mmc_bus_put(host);
2603
2604 if (ret)
2605 pr_warn("%s: tried to reset card, got error %d\n",
2606 mmc_hostname(host), ret);
2607
2608 return ret;
2609}
2610EXPORT_SYMBOL(mmc_hw_reset);
2611
2612static int mmc_rescan_try_freq(struct mmc_host *host, unsigned freq)
2613{
2614 host->f_init = freq;
2615
2616#ifdef CONFIG_MMC_DEBUG
2617 pr_info("%s: %s: trying to init card at %u Hz\n",
2618 mmc_hostname(host), __func__, host->f_init);
2619#endif
2620 mmc_power_up(host, host->ocr_avail);
2621
2622 /*
2623 * Some eMMCs (with VCCQ always on) may not be reset after power up, so
2624 * do a hardware reset if possible.
2625 */
2626 mmc_hw_reset_for_init(host);
2627
2628 /*
2629 * sdio_reset sends CMD52 to reset card. Since we do not know
2630 * if the card is being re-initialized, just send it. CMD52
2631 * should be ignored by SD/eMMC cards.
2632 * Skip it if we already know that we do not support SDIO commands
2633 */
2634 if (!(host->caps2 & MMC_CAP2_NO_SDIO))
2635 sdio_reset(host);
2636
2637 mmc_go_idle(host);
2638
2639 if (!(host->caps2 & MMC_CAP2_NO_SD))
2640 mmc_send_if_cond(host, host->ocr_avail);
2641
2642 /* Order's important: probe SDIO, then SD, then MMC */
2643 if (!(host->caps2 & MMC_CAP2_NO_SDIO))
2644 if (!mmc_attach_sdio(host))
2645 return 0;
2646
2647 if (!(host->caps2 & MMC_CAP2_NO_SD))
2648 if (!mmc_attach_sd(host))
2649 return 0;
2650
2651 if (!(host->caps2 & MMC_CAP2_NO_MMC))
2652 if (!mmc_attach_mmc(host))
2653 return 0;
2654
2655 mmc_power_off(host);
2656 return -EIO;
2657}
2658
2659int _mmc_detect_card_removed(struct mmc_host *host)
2660{
2661 int ret;
2662
2663 if (!host->card || mmc_card_removed(host->card))
2664 return 1;
2665
2666 ret = host->bus_ops->alive(host);
2667
2668 /*
2669 * Card detect status and alive check may be out of sync if card is
2670 * removed slowly, when card detect switch changes while card/slot
2671 * pads are still contacted in hardware (refer to "SD Card Mechanical
2672 * Addendum, Appendix C: Card Detection Switch"). So reschedule a
2673 * detect work 200ms later for this case.
2674 */
2675 if (!ret && host->ops->get_cd && !host->ops->get_cd(host)) {
2676 mmc_detect_change(host, msecs_to_jiffies(200));
2677 pr_debug("%s: card removed too slowly\n", mmc_hostname(host));
2678 }
2679
2680 if (ret) {
2681 mmc_card_set_removed(host->card);
2682 pr_debug("%s: card remove detected\n", mmc_hostname(host));
2683 }
2684
2685 return ret;
2686}
2687
2688int mmc_detect_card_removed(struct mmc_host *host)
2689{
2690 struct mmc_card *card = host->card;
2691 int ret;
2692
2693 WARN_ON(!host->claimed);
2694
2695 if (!card)
2696 return 1;
2697
2698 if (!mmc_card_is_removable(host))
2699 return 0;
2700
2701 ret = mmc_card_removed(card);
2702 /*
2703 * The card will be considered unchanged unless we have been asked to
2704 * detect a change or host requires polling to provide card detection.
2705 */
2706 if (!host->detect_change && !(host->caps & MMC_CAP_NEEDS_POLL))
2707 return ret;
2708
2709 host->detect_change = 0;
2710 if (!ret) {
2711 ret = _mmc_detect_card_removed(host);
2712 if (ret && (host->caps & MMC_CAP_NEEDS_POLL)) {
2713 /*
2714 * Schedule a detect work as soon as possible to let a
2715 * rescan handle the card removal.
2716 */
2717 cancel_delayed_work(&host->detect);
2718 _mmc_detect_change(host, 0, false);
2719 }
2720 }
2721
2722 return ret;
2723}
2724EXPORT_SYMBOL(mmc_detect_card_removed);
2725
2726void mmc_rescan(struct work_struct *work)
2727{
2728 struct mmc_host *host =
2729 container_of(work, struct mmc_host, detect.work);
2730 int i;
2731
2732 if (host->rescan_disable)
2733 return;
2734
2735 /* If there is a non-removable card registered, only scan once */
2736 if (!mmc_card_is_removable(host) && host->rescan_entered)
2737 return;
2738 host->rescan_entered = 1;
2739
2740 if (host->trigger_card_event && host->ops->card_event) {
2741 mmc_claim_host(host);
2742 host->ops->card_event(host);
2743 mmc_release_host(host);
2744 host->trigger_card_event = false;
2745 }
2746
2747 mmc_bus_get(host);
2748
2749 /*
2750 * if there is a _removable_ card registered, check whether it is
2751 * still present
2752 */
2753 if (host->bus_ops && !host->bus_dead && mmc_card_is_removable(host))
2754 host->bus_ops->detect(host);
2755
2756 host->detect_change = 0;
2757
2758 /*
2759 * Let mmc_bus_put() free the bus/bus_ops if we've found that
2760 * the card is no longer present.
2761 */
2762 mmc_bus_put(host);
2763 mmc_bus_get(host);
2764
2765 /* if there still is a card present, stop here */
2766 if (host->bus_ops != NULL) {
2767 mmc_bus_put(host);
2768 goto out;
2769 }
2770
2771 /*
2772 * Only we can add a new handler, so it's safe to
2773 * release the lock here.
2774 */
2775 mmc_bus_put(host);
2776
2777 mmc_claim_host(host);
2778 if (mmc_card_is_removable(host) && host->ops->get_cd &&
2779 host->ops->get_cd(host) == 0) {
2780 mmc_power_off(host);
2781 mmc_release_host(host);
2782 goto out;
2783 }
2784
2785 for (i = 0; i < ARRAY_SIZE(freqs); i++) {
2786 if (!mmc_rescan_try_freq(host, max(freqs[i], host->f_min)))
2787 break;
2788 if (freqs[i] <= host->f_min)
2789 break;
2790 }
2791 mmc_release_host(host);
2792
2793 out:
2794 if (host->caps & MMC_CAP_NEEDS_POLL)
2795 mmc_schedule_delayed_work(&host->detect, HZ);
2796}
2797
2798void mmc_start_host(struct mmc_host *host)
2799{
2800 host->f_init = max(freqs[0], host->f_min);
2801 host->rescan_disable = 0;
2802 host->ios.power_mode = MMC_POWER_UNDEFINED;
2803
2804 if (!(host->caps2 & MMC_CAP2_NO_PRESCAN_POWERUP)) {
2805 mmc_claim_host(host);
2806 mmc_power_up(host, host->ocr_avail);
2807 mmc_release_host(host);
2808 }
2809
2810 mmc_gpiod_request_cd_irq(host);
2811 _mmc_detect_change(host, 0, false);
2812}
2813
2814void mmc_stop_host(struct mmc_host *host)
2815{
2816#ifdef CONFIG_MMC_DEBUG
2817 unsigned long flags;
2818 spin_lock_irqsave(&host->lock, flags);
2819 host->removed = 1;
2820 spin_unlock_irqrestore(&host->lock, flags);
2821#endif
2822 if (host->slot.cd_irq >= 0)
2823 disable_irq(host->slot.cd_irq);
2824
2825 host->rescan_disable = 1;
2826 cancel_delayed_work_sync(&host->detect);
2827
2828 /* clear pm flags now and let card drivers set them as needed */
2829 host->pm_flags = 0;
2830
2831 mmc_bus_get(host);
2832 if (host->bus_ops && !host->bus_dead) {
2833 /* Calling bus_ops->remove() with a claimed host can deadlock */
2834 host->bus_ops->remove(host);
2835 mmc_claim_host(host);
2836 mmc_detach_bus(host);
2837 mmc_power_off(host);
2838 mmc_release_host(host);
2839 mmc_bus_put(host);
2840 return;
2841 }
2842 mmc_bus_put(host);
2843
2844 mmc_claim_host(host);
2845 mmc_power_off(host);
2846 mmc_release_host(host);
2847}
2848
2849int mmc_power_save_host(struct mmc_host *host)
2850{
2851 int ret = 0;
2852
2853#ifdef CONFIG_MMC_DEBUG
2854 pr_info("%s: %s: powering down\n", mmc_hostname(host), __func__);
2855#endif
2856
2857 mmc_bus_get(host);
2858
2859 if (!host->bus_ops || host->bus_dead) {
2860 mmc_bus_put(host);
2861 return -EINVAL;
2862 }
2863
2864 if (host->bus_ops->power_save)
2865 ret = host->bus_ops->power_save(host);
2866
2867 mmc_bus_put(host);
2868
2869 mmc_power_off(host);
2870
2871 return ret;
2872}
2873EXPORT_SYMBOL(mmc_power_save_host);
2874
2875int mmc_power_restore_host(struct mmc_host *host)
2876{
2877 int ret;
2878
2879#ifdef CONFIG_MMC_DEBUG
2880 pr_info("%s: %s: powering up\n", mmc_hostname(host), __func__);
2881#endif
2882
2883 mmc_bus_get(host);
2884
2885 if (!host->bus_ops || host->bus_dead) {
2886 mmc_bus_put(host);
2887 return -EINVAL;
2888 }
2889
2890 mmc_power_up(host, host->card->ocr);
2891 ret = host->bus_ops->power_restore(host);
2892
2893 mmc_bus_put(host);
2894
2895 return ret;
2896}
2897EXPORT_SYMBOL(mmc_power_restore_host);
2898
2899/*
2900 * Flush the cache to the non-volatile storage.
2901 */
2902int mmc_flush_cache(struct mmc_card *card)
2903{
2904 int err = 0;
2905
2906 if (mmc_card_mmc(card) &&
2907 (card->ext_csd.cache_size > 0) &&
2908 (card->ext_csd.cache_ctrl & 1)) {
2909 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
2910 EXT_CSD_FLUSH_CACHE, 1, 0);
2911 if (err)
2912 pr_err("%s: cache flush error %d\n",
2913 mmc_hostname(card->host), err);
2914 }
2915
2916 return err;
2917}
2918EXPORT_SYMBOL(mmc_flush_cache);
2919
2920#ifdef CONFIG_PM_SLEEP
2921/* Do the card removal on suspend if card is assumed removeable
2922 * Do that in pm notifier while userspace isn't yet frozen, so we will be able
2923 to sync the card.
2924*/
2925static int mmc_pm_notify(struct notifier_block *notify_block,
2926 unsigned long mode, void *unused)
2927{
2928 struct mmc_host *host = container_of(
2929 notify_block, struct mmc_host, pm_notify);
2930 unsigned long flags;
2931 int err = 0;
2932
2933 switch (mode) {
2934 case PM_HIBERNATION_PREPARE:
2935 case PM_SUSPEND_PREPARE:
2936 case PM_RESTORE_PREPARE:
2937 spin_lock_irqsave(&host->lock, flags);
2938 host->rescan_disable = 1;
2939 spin_unlock_irqrestore(&host->lock, flags);
2940 cancel_delayed_work_sync(&host->detect);
2941
2942 if (!host->bus_ops)
2943 break;
2944
2945 /* Validate prerequisites for suspend */
2946 if (host->bus_ops->pre_suspend)
2947 err = host->bus_ops->pre_suspend(host);
2948 if (!err)
2949 break;
2950
2951 /* Calling bus_ops->remove() with a claimed host can deadlock */
2952 host->bus_ops->remove(host);
2953 mmc_claim_host(host);
2954 mmc_detach_bus(host);
2955 mmc_power_off(host);
2956 mmc_release_host(host);
2957 host->pm_flags = 0;
2958 break;
2959
2960 case PM_POST_SUSPEND:
2961 case PM_POST_HIBERNATION:
2962 case PM_POST_RESTORE:
2963
2964 spin_lock_irqsave(&host->lock, flags);
2965 host->rescan_disable = 0;
2966 spin_unlock_irqrestore(&host->lock, flags);
2967 _mmc_detect_change(host, 0, false);
2968
2969 }
2970
2971 return 0;
2972}
2973
2974void mmc_register_pm_notifier(struct mmc_host *host)
2975{
2976 host->pm_notify.notifier_call = mmc_pm_notify;
2977 register_pm_notifier(&host->pm_notify);
2978}
2979
2980void mmc_unregister_pm_notifier(struct mmc_host *host)
2981{
2982 unregister_pm_notifier(&host->pm_notify);
2983}
2984#endif
2985
2986/**
2987 * mmc_init_context_info() - init synchronization context
2988 * @host: mmc host
2989 *
2990 * Init struct context_info needed to implement asynchronous
2991 * request mechanism, used by mmc core, host driver and mmc requests
2992 * supplier.
2993 */
2994void mmc_init_context_info(struct mmc_host *host)
2995{
2996 host->context_info.is_new_req = false;
2997 host->context_info.is_done_rcv = false;
2998 host->context_info.is_waiting_last_req = false;
2999 init_waitqueue_head(&host->context_info.wait);
3000}
3001
3002static int __init mmc_init(void)
3003{
3004 int ret;
3005
3006 ret = mmc_register_bus();
3007 if (ret)
3008 return ret;
3009
3010 ret = mmc_register_host_class();
3011 if (ret)
3012 goto unregister_bus;
3013
3014 ret = sdio_register_bus();
3015 if (ret)
3016 goto unregister_host_class;
3017
3018 return 0;
3019
3020unregister_host_class:
3021 mmc_unregister_host_class();
3022unregister_bus:
3023 mmc_unregister_bus();
3024 return ret;
3025}
3026
3027static void __exit mmc_exit(void)
3028{
3029 sdio_unregister_bus();
3030 mmc_unregister_host_class();
3031 mmc_unregister_bus();
3032}
3033
3034subsys_initcall(mmc_init);
3035module_exit(mmc_exit);
3036
3037MODULE_LICENSE("GPL");