2 * linux/drivers/mmc/core/mmc_ops.h
4 * Copyright 2006-2007 Pierre Ossman
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or (at
9 * your option) any later version.
12 #include <linux/slab.h>
13 #include <linux/export.h>
14 #include <linux/types.h>
15 #include <linux/scatterlist.h>
17 #include <linux/mmc/host.h>
18 #include <linux/mmc/card.h>
19 #include <linux/mmc/mmc.h>
25 #define MMC_OPS_TIMEOUT_MS (10 * 60 * 1000) /* 10 minute timeout */
27 static const u8 tuning_blk_pattern_4bit[] = {
28 0xff, 0x0f, 0xff, 0x00, 0xff, 0xcc, 0xc3, 0xcc,
29 0xc3, 0x3c, 0xcc, 0xff, 0xfe, 0xff, 0xfe, 0xef,
30 0xff, 0xdf, 0xff, 0xdd, 0xff, 0xfb, 0xff, 0xfb,
31 0xbf, 0xff, 0x7f, 0xff, 0x77, 0xf7, 0xbd, 0xef,
32 0xff, 0xf0, 0xff, 0xf0, 0x0f, 0xfc, 0xcc, 0x3c,
33 0xcc, 0x33, 0xcc, 0xcf, 0xff, 0xef, 0xff, 0xee,
34 0xff, 0xfd, 0xff, 0xfd, 0xdf, 0xff, 0xbf, 0xff,
35 0xbb, 0xff, 0xf7, 0xff, 0xf7, 0x7f, 0x7b, 0xde,
38 static const u8 tuning_blk_pattern_8bit[] = {
39 0xff, 0xff, 0x00, 0xff, 0xff, 0xff, 0x00, 0x00,
40 0xff, 0xff, 0xcc, 0xcc, 0xcc, 0x33, 0xcc, 0xcc,
41 0xcc, 0x33, 0x33, 0xcc, 0xcc, 0xcc, 0xff, 0xff,
42 0xff, 0xee, 0xff, 0xff, 0xff, 0xee, 0xee, 0xff,
43 0xff, 0xff, 0xdd, 0xff, 0xff, 0xff, 0xdd, 0xdd,
44 0xff, 0xff, 0xff, 0xbb, 0xff, 0xff, 0xff, 0xbb,
45 0xbb, 0xff, 0xff, 0xff, 0x77, 0xff, 0xff, 0xff,
46 0x77, 0x77, 0xff, 0x77, 0xbb, 0xdd, 0xee, 0xff,
47 0xff, 0xff, 0xff, 0x00, 0xff, 0xff, 0xff, 0x00,
48 0x00, 0xff, 0xff, 0xcc, 0xcc, 0xcc, 0x33, 0xcc,
49 0xcc, 0xcc, 0x33, 0x33, 0xcc, 0xcc, 0xcc, 0xff,
50 0xff, 0xff, 0xee, 0xff, 0xff, 0xff, 0xee, 0xee,
51 0xff, 0xff, 0xff, 0xdd, 0xff, 0xff, 0xff, 0xdd,
52 0xdd, 0xff, 0xff, 0xff, 0xbb, 0xff, 0xff, 0xff,
53 0xbb, 0xbb, 0xff, 0xff, 0xff, 0x77, 0xff, 0xff,
54 0xff, 0x77, 0x77, 0xff, 0x77, 0xbb, 0xdd, 0xee,
57 int mmc_send_status(struct mmc_card *card, u32 *status)
60 struct mmc_command cmd = {0};
62 cmd.opcode = MMC_SEND_STATUS;
63 if (!mmc_host_is_spi(card->host))
64 cmd.arg = card->rca << 16;
65 cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
67 err = mmc_wait_for_cmd(card->host, &cmd, MMC_CMD_RETRIES);
71 /* NOTE: callers are required to understand the difference
72 * between "native" and SPI format status words!
75 *status = cmd.resp[0];
80 static int _mmc_select_card(struct mmc_host *host, struct mmc_card *card)
82 struct mmc_command cmd = {0};
84 cmd.opcode = MMC_SELECT_CARD;
87 cmd.arg = card->rca << 16;
88 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
91 cmd.flags = MMC_RSP_NONE | MMC_CMD_AC;
94 return mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
97 int mmc_select_card(struct mmc_card *card)
100 return _mmc_select_card(card->host, card);
103 int mmc_deselect_cards(struct mmc_host *host)
105 return _mmc_select_card(host, NULL);
109 * Write the value specified in the device tree or board code into the optional
110 * 16 bit Driver Stage Register. This can be used to tune raise/fall times and
111 * drive strength of the DAT and CMD outputs. The actual meaning of a given
112 * value is hardware dependant.
113 * The presence of the DSR register can be determined from the CSD register,
116 int mmc_set_dsr(struct mmc_host *host)
118 struct mmc_command cmd = {0};
120 cmd.opcode = MMC_SET_DSR;
122 cmd.arg = (host->dsr << 16) | 0xffff;
123 cmd.flags = MMC_RSP_NONE | MMC_CMD_AC;
125 return mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
128 int mmc_go_idle(struct mmc_host *host)
131 struct mmc_command cmd = {0};
134 * Non-SPI hosts need to prevent chipselect going active during
135 * GO_IDLE; that would put chips into SPI mode. Remind them of
136 * that in case of hardware that won't pull up DAT3/nCS otherwise.
138 * SPI hosts ignore ios.chip_select; it's managed according to
139 * rules that must accommodate non-MMC slaves which this layer
140 * won't even know about.
142 if (!mmc_host_is_spi(host)) {
143 mmc_set_chip_select(host, MMC_CS_HIGH);
147 cmd.opcode = MMC_GO_IDLE_STATE;
149 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_NONE | MMC_CMD_BC;
151 err = mmc_wait_for_cmd(host, &cmd, 0);
155 if (!mmc_host_is_spi(host)) {
156 mmc_set_chip_select(host, MMC_CS_DONTCARE);
160 host->use_spi_crc = 0;
165 int mmc_send_op_cond(struct mmc_host *host, u32 ocr, u32 *rocr)
167 struct mmc_command cmd = {0};
170 cmd.opcode = MMC_SEND_OP_COND;
171 cmd.arg = mmc_host_is_spi(host) ? 0 : ocr;
172 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R3 | MMC_CMD_BCR;
174 for (i = 100; i; i--) {
175 err = mmc_wait_for_cmd(host, &cmd, 0);
179 /* if we're just probing, do a single pass */
183 /* otherwise wait until reset completes */
184 if (mmc_host_is_spi(host)) {
185 if (!(cmd.resp[0] & R1_SPI_IDLE))
188 if (cmd.resp[0] & MMC_CARD_BUSY)
197 if (rocr && !mmc_host_is_spi(host))
203 int mmc_all_send_cid(struct mmc_host *host, u32 *cid)
206 struct mmc_command cmd = {0};
208 cmd.opcode = MMC_ALL_SEND_CID;
210 cmd.flags = MMC_RSP_R2 | MMC_CMD_BCR;
212 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
216 memcpy(cid, cmd.resp, sizeof(u32) * 4);
221 int mmc_set_relative_addr(struct mmc_card *card)
223 struct mmc_command cmd = {0};
225 cmd.opcode = MMC_SET_RELATIVE_ADDR;
226 cmd.arg = card->rca << 16;
227 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
229 return mmc_wait_for_cmd(card->host, &cmd, MMC_CMD_RETRIES);
233 mmc_send_cxd_native(struct mmc_host *host, u32 arg, u32 *cxd, int opcode)
236 struct mmc_command cmd = {0};
240 cmd.flags = MMC_RSP_R2 | MMC_CMD_AC;
242 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
246 memcpy(cxd, cmd.resp, sizeof(u32) * 4);
252 * NOTE: void *buf, caller for the buf is required to use DMA-capable
253 * buffer or on-stack buffer (with some overhead in callee).
256 mmc_send_cxd_data(struct mmc_card *card, struct mmc_host *host,
257 u32 opcode, void *buf, unsigned len)
259 struct mmc_request mrq = {NULL};
260 struct mmc_command cmd = {0};
261 struct mmc_data data = {0};
262 struct scatterlist sg;
270 /* NOTE HACK: the MMC_RSP_SPI_R1 is always correct here, but we
271 * rely on callers to never use this with "native" calls for reading
272 * CSD or CID. Native versions of those commands use the R2 type,
273 * not R1 plus a data block.
275 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
279 data.flags = MMC_DATA_READ;
283 sg_init_one(&sg, buf, len);
285 if (opcode == MMC_SEND_CSD || opcode == MMC_SEND_CID) {
287 * The spec states that CSR and CID accesses have a timeout
288 * of 64 clock cycles.
291 data.timeout_clks = 64;
293 mmc_set_data_timeout(&data, card);
295 mmc_wait_for_req(host, &mrq);
305 int mmc_send_csd(struct mmc_card *card, u32 *csd)
310 if (!mmc_host_is_spi(card->host))
311 return mmc_send_cxd_native(card->host, card->rca << 16,
314 csd_tmp = kzalloc(16, GFP_KERNEL);
318 ret = mmc_send_cxd_data(card, card->host, MMC_SEND_CSD, csd_tmp, 16);
322 for (i = 0;i < 4;i++)
323 csd[i] = be32_to_cpu(csd_tmp[i]);
330 int mmc_send_cid(struct mmc_host *host, u32 *cid)
335 if (!mmc_host_is_spi(host)) {
338 return mmc_send_cxd_native(host, host->card->rca << 16,
342 cid_tmp = kzalloc(16, GFP_KERNEL);
346 ret = mmc_send_cxd_data(NULL, host, MMC_SEND_CID, cid_tmp, 16);
350 for (i = 0;i < 4;i++)
351 cid[i] = be32_to_cpu(cid_tmp[i]);
358 int mmc_get_ext_csd(struct mmc_card *card, u8 **new_ext_csd)
363 if (!card || !new_ext_csd)
366 if (!mmc_can_ext_csd(card))
370 * As the ext_csd is so large and mostly unused, we don't store the
371 * raw block in mmc_card.
373 ext_csd = kzalloc(512, GFP_KERNEL);
377 err = mmc_send_cxd_data(card, card->host, MMC_SEND_EXT_CSD, ext_csd,
382 *new_ext_csd = ext_csd;
386 EXPORT_SYMBOL_GPL(mmc_get_ext_csd);
388 int mmc_spi_read_ocr(struct mmc_host *host, int highcap, u32 *ocrp)
390 struct mmc_command cmd = {0};
393 cmd.opcode = MMC_SPI_READ_OCR;
394 cmd.arg = highcap ? (1 << 30) : 0;
395 cmd.flags = MMC_RSP_SPI_R3;
397 err = mmc_wait_for_cmd(host, &cmd, 0);
403 int mmc_spi_set_crc(struct mmc_host *host, int use_crc)
405 struct mmc_command cmd = {0};
408 cmd.opcode = MMC_SPI_CRC_ON_OFF;
409 cmd.flags = MMC_RSP_SPI_R1;
412 err = mmc_wait_for_cmd(host, &cmd, 0);
414 host->use_spi_crc = use_crc;
418 static int mmc_switch_status_error(struct mmc_host *host, u32 status)
420 if (mmc_host_is_spi(host)) {
421 if (status & R1_SPI_ILLEGAL_COMMAND)
424 if (status & 0xFDFFA000)
425 pr_warn("%s: unexpected status %#x after switch\n",
426 mmc_hostname(host), status);
427 if (status & R1_SWITCH_ERROR)
433 /* Caller must hold re-tuning */
434 int __mmc_switch_status(struct mmc_card *card, bool crc_err_fatal)
439 err = mmc_send_status(card, &status);
440 if (!crc_err_fatal && err == -EILSEQ)
445 return mmc_switch_status_error(card->host, status);
448 int mmc_switch_status(struct mmc_card *card)
450 return __mmc_switch_status(card, true);
453 static int mmc_poll_for_busy(struct mmc_card *card, unsigned int timeout_ms,
454 bool send_status, bool retry_crc_err)
456 struct mmc_host *host = card->host;
458 unsigned long timeout;
460 bool expired = false;
463 /* We have an unspecified cmd timeout, use the fallback value. */
465 timeout_ms = MMC_OPS_TIMEOUT_MS;
468 * In cases when not allowed to poll by using CMD13 or because we aren't
469 * capable of polling by using ->card_busy(), then rely on waiting the
470 * stated timeout to be sufficient.
472 if (!send_status && !host->ops->card_busy) {
473 mmc_delay(timeout_ms);
477 timeout = jiffies + msecs_to_jiffies(timeout_ms) + 1;
480 * Due to the possibility of being preempted while polling,
481 * check the expiration time first.
483 expired = time_after(jiffies, timeout);
485 if (host->ops->card_busy) {
486 busy = host->ops->card_busy(host);
488 err = mmc_send_status(card, &status);
489 if (retry_crc_err && err == -EILSEQ) {
494 err = mmc_switch_status_error(host, status);
497 busy = R1_CURRENT_STATE(status) == R1_STATE_PRG;
501 /* Timeout if the device still remains busy. */
502 if (expired && busy) {
503 pr_err("%s: Card stuck being busy! %s\n",
504 mmc_hostname(host), __func__);
513 * __mmc_switch - modify EXT_CSD register
514 * @card: the MMC card associated with the data transfer
515 * @set: cmd set values
516 * @index: EXT_CSD register index
517 * @value: value to program into EXT_CSD register
518 * @timeout_ms: timeout (ms) for operation performed by register write,
519 * timeout of zero implies maximum possible timeout
520 * @timing: new timing to change to
521 * @use_busy_signal: use the busy signal as response type
522 * @send_status: send status cmd to poll for busy
523 * @retry_crc_err: retry when CRC errors when polling with CMD13 for busy
525 * Modifies the EXT_CSD register for selected card.
527 int __mmc_switch(struct mmc_card *card, u8 set, u8 index, u8 value,
528 unsigned int timeout_ms, unsigned char timing,
529 bool use_busy_signal, bool send_status, bool retry_crc_err)
531 struct mmc_host *host = card->host;
533 struct mmc_command cmd = {0};
534 bool use_r1b_resp = use_busy_signal;
535 unsigned char old_timing = host->ios.timing;
537 mmc_retune_hold(host);
540 * If the cmd timeout and the max_busy_timeout of the host are both
541 * specified, let's validate them. A failure means we need to prevent
542 * the host from doing hw busy detection, which is done by converting
543 * to a R1 response instead of a R1B.
545 if (timeout_ms && host->max_busy_timeout &&
546 (timeout_ms > host->max_busy_timeout))
547 use_r1b_resp = false;
549 cmd.opcode = MMC_SWITCH;
550 cmd.arg = (MMC_SWITCH_MODE_WRITE_BYTE << 24) |
554 cmd.flags = MMC_CMD_AC;
556 cmd.flags |= MMC_RSP_SPI_R1B | MMC_RSP_R1B;
558 * A busy_timeout of zero means the host can decide to use
559 * whatever value it finds suitable.
561 cmd.busy_timeout = timeout_ms;
563 cmd.flags |= MMC_RSP_SPI_R1 | MMC_RSP_R1;
566 if (index == EXT_CSD_SANITIZE_START)
567 cmd.sanitize_busy = true;
569 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
573 /* No need to check card status in case of unblocking command */
574 if (!use_busy_signal)
577 /*If SPI or used HW busy detection above, then we don't need to poll. */
578 if (((host->caps & MMC_CAP_WAIT_WHILE_BUSY) && use_r1b_resp) ||
579 mmc_host_is_spi(host))
582 /* Let's try to poll to find out when the command is completed. */
583 err = mmc_poll_for_busy(card, timeout_ms, send_status, retry_crc_err);
588 /* Switch to new timing before check switch status. */
590 mmc_set_timing(host, timing);
593 err = mmc_switch_status(card);
595 mmc_set_timing(host, old_timing);
598 mmc_retune_release(host);
603 int mmc_switch(struct mmc_card *card, u8 set, u8 index, u8 value,
604 unsigned int timeout_ms)
606 return __mmc_switch(card, set, index, value, timeout_ms, 0,
609 EXPORT_SYMBOL_GPL(mmc_switch);
611 int mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error)
613 struct mmc_request mrq = {NULL};
614 struct mmc_command cmd = {0};
615 struct mmc_data data = {0};
616 struct scatterlist sg;
617 struct mmc_ios *ios = &host->ios;
618 const u8 *tuning_block_pattern;
622 if (ios->bus_width == MMC_BUS_WIDTH_8) {
623 tuning_block_pattern = tuning_blk_pattern_8bit;
624 size = sizeof(tuning_blk_pattern_8bit);
625 } else if (ios->bus_width == MMC_BUS_WIDTH_4) {
626 tuning_block_pattern = tuning_blk_pattern_4bit;
627 size = sizeof(tuning_blk_pattern_4bit);
631 data_buf = kzalloc(size, GFP_KERNEL);
639 cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC;
643 data.flags = MMC_DATA_READ;
646 * According to the tuning specs, Tuning process
647 * is normally shorter 40 executions of CMD19,
648 * and timeout value should be shorter than 150 ms
650 data.timeout_ns = 150 * NSEC_PER_MSEC;
654 sg_init_one(&sg, data_buf, size);
656 mmc_wait_for_req(host, &mrq);
659 *cmd_error = cmd.error;
671 if (memcmp(data_buf, tuning_block_pattern, size))
678 EXPORT_SYMBOL_GPL(mmc_send_tuning);
680 int mmc_abort_tuning(struct mmc_host *host, u32 opcode)
682 struct mmc_command cmd = {0};
685 * eMMC specification specifies that CMD12 can be used to stop a tuning
686 * command, but SD specification does not, so do nothing unless it is
689 if (opcode != MMC_SEND_TUNING_BLOCK_HS200)
692 cmd.opcode = MMC_STOP_TRANSMISSION;
693 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
696 * For drivers that override R1 to R1b, set an arbitrary timeout based
697 * on the tuning timeout i.e. 150ms.
699 cmd.busy_timeout = 150;
701 return mmc_wait_for_cmd(host, &cmd, 0);
703 EXPORT_SYMBOL_GPL(mmc_abort_tuning);
706 mmc_send_bus_test(struct mmc_card *card, struct mmc_host *host, u8 opcode,
709 struct mmc_request mrq = {NULL};
710 struct mmc_command cmd = {0};
711 struct mmc_data data = {0};
712 struct scatterlist sg;
716 static u8 testdata_8bit[8] = { 0x55, 0xaa, 0, 0, 0, 0, 0, 0 };
717 static u8 testdata_4bit[4] = { 0x5a, 0, 0, 0 };
719 /* dma onto stack is unsafe/nonportable, but callers to this
720 * routine normally provide temporary on-stack buffers ...
722 data_buf = kmalloc(len, GFP_KERNEL);
727 test_buf = testdata_8bit;
729 test_buf = testdata_4bit;
731 pr_err("%s: Invalid bus_width %d\n",
732 mmc_hostname(host), len);
737 if (opcode == MMC_BUS_TEST_W)
738 memcpy(data_buf, test_buf, len);
745 /* NOTE HACK: the MMC_RSP_SPI_R1 is always correct here, but we
746 * rely on callers to never use this with "native" calls for reading
747 * CSD or CID. Native versions of those commands use the R2 type,
748 * not R1 plus a data block.
750 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
754 if (opcode == MMC_BUS_TEST_R)
755 data.flags = MMC_DATA_READ;
757 data.flags = MMC_DATA_WRITE;
761 mmc_set_data_timeout(&data, card);
762 sg_init_one(&sg, data_buf, len);
763 mmc_wait_for_req(host, &mrq);
765 if (opcode == MMC_BUS_TEST_R) {
766 for (i = 0; i < len / 4; i++)
767 if ((test_buf[i] ^ data_buf[i]) != 0xff) {
782 int mmc_bus_test(struct mmc_card *card, u8 bus_width)
786 if (bus_width == MMC_BUS_WIDTH_8)
788 else if (bus_width == MMC_BUS_WIDTH_4)
790 else if (bus_width == MMC_BUS_WIDTH_1)
791 return 0; /* no need for test */
796 * Ignore errors from BUS_TEST_W. BUS_TEST_R will fail if there
797 * is a problem. This improves chances that the test will work.
799 mmc_send_bus_test(card, card->host, MMC_BUS_TEST_W, width);
800 return mmc_send_bus_test(card, card->host, MMC_BUS_TEST_R, width);
803 int mmc_send_hpi_cmd(struct mmc_card *card, u32 *status)
805 struct mmc_command cmd = {0};
809 if (!card->ext_csd.hpi) {
810 pr_warn("%s: Card didn't support HPI command\n",
811 mmc_hostname(card->host));
815 opcode = card->ext_csd.hpi_cmd;
816 if (opcode == MMC_STOP_TRANSMISSION)
817 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC;
818 else if (opcode == MMC_SEND_STATUS)
819 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
822 cmd.arg = card->rca << 16 | 1;
824 err = mmc_wait_for_cmd(card->host, &cmd, 0);
826 pr_warn("%s: error %d interrupting operation. "
827 "HPI command response %#x\n", mmc_hostname(card->host),
832 *status = cmd.resp[0];
837 int mmc_can_ext_csd(struct mmc_card *card)
839 return (card && card->csd.mmca_vsn > CSD_SPEC_VER_3);