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};
65 cmd.opcode = MMC_SEND_STATUS;
66 if (!mmc_host_is_spi(card->host))
67 cmd.arg = card->rca << 16;
68 cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
70 err = mmc_wait_for_cmd(card->host, &cmd, MMC_CMD_RETRIES);
74 /* NOTE: callers are required to understand the difference
75 * between "native" and SPI format status words!
78 *status = cmd.resp[0];
83 static int _mmc_select_card(struct mmc_host *host, struct mmc_card *card)
85 struct mmc_command cmd = {0};
89 cmd.opcode = MMC_SELECT_CARD;
92 cmd.arg = card->rca << 16;
93 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
96 cmd.flags = MMC_RSP_NONE | MMC_CMD_AC;
99 return mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
102 int mmc_select_card(struct mmc_card *card)
106 return _mmc_select_card(card->host, card);
109 int mmc_deselect_cards(struct mmc_host *host)
111 return _mmc_select_card(host, NULL);
115 * Write the value specified in the device tree or board code into the optional
116 * 16 bit Driver Stage Register. This can be used to tune raise/fall times and
117 * drive strength of the DAT and CMD outputs. The actual meaning of a given
118 * value is hardware dependant.
119 * The presence of the DSR register can be determined from the CSD register,
122 int mmc_set_dsr(struct mmc_host *host)
124 struct mmc_command cmd = {0};
126 cmd.opcode = MMC_SET_DSR;
128 cmd.arg = (host->dsr << 16) | 0xffff;
129 cmd.flags = MMC_RSP_NONE | MMC_CMD_AC;
131 return mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
134 int mmc_go_idle(struct mmc_host *host)
137 struct mmc_command cmd = {0};
140 * Non-SPI hosts need to prevent chipselect going active during
141 * GO_IDLE; that would put chips into SPI mode. Remind them of
142 * that in case of hardware that won't pull up DAT3/nCS otherwise.
144 * SPI hosts ignore ios.chip_select; it's managed according to
145 * rules that must accommodate non-MMC slaves which this layer
146 * won't even know about.
148 if (!mmc_host_is_spi(host)) {
149 mmc_set_chip_select(host, MMC_CS_HIGH);
153 cmd.opcode = MMC_GO_IDLE_STATE;
155 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_NONE | MMC_CMD_BC;
157 err = mmc_wait_for_cmd(host, &cmd, 0);
161 if (!mmc_host_is_spi(host)) {
162 mmc_set_chip_select(host, MMC_CS_DONTCARE);
166 host->use_spi_crc = 0;
171 int mmc_send_op_cond(struct mmc_host *host, u32 ocr, u32 *rocr)
173 struct mmc_command cmd = {0};
178 cmd.opcode = MMC_SEND_OP_COND;
179 cmd.arg = mmc_host_is_spi(host) ? 0 : ocr;
180 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R3 | MMC_CMD_BCR;
182 for (i = 100; i; i--) {
183 err = mmc_wait_for_cmd(host, &cmd, 0);
187 /* if we're just probing, do a single pass */
191 /* otherwise wait until reset completes */
192 if (mmc_host_is_spi(host)) {
193 if (!(cmd.resp[0] & R1_SPI_IDLE))
196 if (cmd.resp[0] & MMC_CARD_BUSY)
205 if (rocr && !mmc_host_is_spi(host))
211 int mmc_all_send_cid(struct mmc_host *host, u32 *cid)
214 struct mmc_command cmd = {0};
219 cmd.opcode = MMC_ALL_SEND_CID;
221 cmd.flags = MMC_RSP_R2 | MMC_CMD_BCR;
223 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
227 memcpy(cid, cmd.resp, sizeof(u32) * 4);
232 int mmc_set_relative_addr(struct mmc_card *card)
234 struct mmc_command cmd = {0};
239 cmd.opcode = MMC_SET_RELATIVE_ADDR;
240 cmd.arg = card->rca << 16;
241 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
243 return mmc_wait_for_cmd(card->host, &cmd, MMC_CMD_RETRIES);
247 mmc_send_cxd_native(struct mmc_host *host, u32 arg, u32 *cxd, int opcode)
250 struct mmc_command cmd = {0};
257 cmd.flags = MMC_RSP_R2 | MMC_CMD_AC;
259 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
263 memcpy(cxd, cmd.resp, sizeof(u32) * 4);
269 * NOTE: void *buf, caller for the buf is required to use DMA-capable
270 * buffer or on-stack buffer (with some overhead in callee).
273 mmc_send_cxd_data(struct mmc_card *card, struct mmc_host *host,
274 u32 opcode, void *buf, unsigned len)
276 struct mmc_request mrq = {NULL};
277 struct mmc_command cmd = {0};
278 struct mmc_data data = {0};
279 struct scatterlist sg;
287 /* NOTE HACK: the MMC_RSP_SPI_R1 is always correct here, but we
288 * rely on callers to never use this with "native" calls for reading
289 * CSD or CID. Native versions of those commands use the R2 type,
290 * not R1 plus a data block.
292 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
296 data.flags = MMC_DATA_READ;
300 sg_init_one(&sg, buf, len);
302 if (opcode == MMC_SEND_CSD || opcode == MMC_SEND_CID) {
304 * The spec states that CSR and CID accesses have a timeout
305 * of 64 clock cycles.
308 data.timeout_clks = 64;
310 mmc_set_data_timeout(&data, card);
312 mmc_wait_for_req(host, &mrq);
322 int mmc_send_csd(struct mmc_card *card, u32 *csd)
327 if (!mmc_host_is_spi(card->host))
328 return mmc_send_cxd_native(card->host, card->rca << 16,
331 csd_tmp = kzalloc(16, GFP_KERNEL);
335 ret = mmc_send_cxd_data(card, card->host, MMC_SEND_CSD, csd_tmp, 16);
339 for (i = 0;i < 4;i++)
340 csd[i] = be32_to_cpu(csd_tmp[i]);
347 int mmc_send_cid(struct mmc_host *host, u32 *cid)
352 if (!mmc_host_is_spi(host)) {
355 return mmc_send_cxd_native(host, host->card->rca << 16,
359 cid_tmp = kzalloc(16, GFP_KERNEL);
363 ret = mmc_send_cxd_data(NULL, host, MMC_SEND_CID, cid_tmp, 16);
367 for (i = 0;i < 4;i++)
368 cid[i] = be32_to_cpu(cid_tmp[i]);
375 int mmc_get_ext_csd(struct mmc_card *card, u8 **new_ext_csd)
380 if (!card || !new_ext_csd)
383 if (!mmc_can_ext_csd(card))
387 * As the ext_csd is so large and mostly unused, we don't store the
388 * raw block in mmc_card.
390 ext_csd = kzalloc(512, GFP_KERNEL);
394 err = mmc_send_cxd_data(card, card->host, MMC_SEND_EXT_CSD, ext_csd,
399 *new_ext_csd = ext_csd;
403 EXPORT_SYMBOL_GPL(mmc_get_ext_csd);
405 int mmc_spi_read_ocr(struct mmc_host *host, int highcap, u32 *ocrp)
407 struct mmc_command cmd = {0};
410 cmd.opcode = MMC_SPI_READ_OCR;
411 cmd.arg = highcap ? (1 << 30) : 0;
412 cmd.flags = MMC_RSP_SPI_R3;
414 err = mmc_wait_for_cmd(host, &cmd, 0);
420 int mmc_spi_set_crc(struct mmc_host *host, int use_crc)
422 struct mmc_command cmd = {0};
425 cmd.opcode = MMC_SPI_CRC_ON_OFF;
426 cmd.flags = MMC_RSP_SPI_R1;
429 err = mmc_wait_for_cmd(host, &cmd, 0);
431 host->use_spi_crc = use_crc;
435 static int mmc_switch_status_error(struct mmc_host *host, u32 status)
437 if (mmc_host_is_spi(host)) {
438 if (status & R1_SPI_ILLEGAL_COMMAND)
441 if (status & 0xFDFFA000)
442 pr_warn("%s: unexpected status %#x after switch\n",
443 mmc_hostname(host), status);
444 if (status & R1_SWITCH_ERROR)
450 /* Caller must hold re-tuning */
451 int mmc_switch_status(struct mmc_card *card)
456 err = mmc_send_status(card, &status);
460 return mmc_switch_status_error(card->host, status);
463 static int mmc_poll_for_busy(struct mmc_card *card, unsigned int timeout_ms,
464 bool send_status, bool retry_crc_err)
466 struct mmc_host *host = card->host;
468 unsigned long timeout;
470 bool expired = false;
473 /* We have an unspecified cmd timeout, use the fallback value. */
475 timeout_ms = MMC_OPS_TIMEOUT_MS;
478 * In cases when not allowed to poll by using CMD13 or because we aren't
479 * capable of polling by using ->card_busy(), then rely on waiting the
480 * stated timeout to be sufficient.
482 if (!send_status && !host->ops->card_busy) {
483 mmc_delay(timeout_ms);
487 timeout = jiffies + msecs_to_jiffies(timeout_ms) + 1;
490 * Due to the possibility of being preempted while polling,
491 * check the expiration time first.
493 expired = time_after(jiffies, timeout);
495 if (host->ops->card_busy) {
496 busy = host->ops->card_busy(host);
498 err = mmc_send_status(card, &status);
499 if (retry_crc_err && err == -EILSEQ)
504 busy = R1_CURRENT_STATE(status) == R1_STATE_PRG;
507 /* Timeout if the device still remains busy. */
508 if (expired && busy) {
509 pr_err("%s: Card stuck being busy! %s\n",
510 mmc_hostname(host), __func__);
515 if (host->ops->card_busy && send_status)
516 return mmc_switch_status(card);
518 return mmc_switch_status_error(host, status);
522 * __mmc_switch - modify EXT_CSD register
523 * @card: the MMC card associated with the data transfer
524 * @set: cmd set values
525 * @index: EXT_CSD register index
526 * @value: value to program into EXT_CSD register
527 * @timeout_ms: timeout (ms) for operation performed by register write,
528 * timeout of zero implies maximum possible timeout
529 * @use_busy_signal: use the busy signal as response type
530 * @send_status: send status cmd to poll for busy
531 * @retry_crc_err: retry when CRC errors when polling with CMD13 for busy
533 * Modifies the EXT_CSD register for selected card.
535 int __mmc_switch(struct mmc_card *card, u8 set, u8 index, u8 value,
536 unsigned int timeout_ms, bool use_busy_signal, bool send_status,
539 struct mmc_host *host = card->host;
541 struct mmc_command cmd = {0};
542 bool use_r1b_resp = use_busy_signal;
544 mmc_retune_hold(host);
547 * If the cmd timeout and the max_busy_timeout of the host are both
548 * specified, let's validate them. A failure means we need to prevent
549 * the host from doing hw busy detection, which is done by converting
550 * to a R1 response instead of a R1B.
552 if (timeout_ms && host->max_busy_timeout &&
553 (timeout_ms > host->max_busy_timeout))
554 use_r1b_resp = false;
556 cmd.opcode = MMC_SWITCH;
557 cmd.arg = (MMC_SWITCH_MODE_WRITE_BYTE << 24) |
561 cmd.flags = MMC_CMD_AC;
563 cmd.flags |= MMC_RSP_SPI_R1B | MMC_RSP_R1B;
565 * A busy_timeout of zero means the host can decide to use
566 * whatever value it finds suitable.
568 cmd.busy_timeout = timeout_ms;
570 cmd.flags |= MMC_RSP_SPI_R1 | MMC_RSP_R1;
573 if (index == EXT_CSD_SANITIZE_START)
574 cmd.sanitize_busy = true;
576 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
580 /* No need to check card status in case of unblocking command */
581 if (!use_busy_signal)
584 /*If SPI or used HW busy detection above, then we don't need to poll. */
585 if (((host->caps & MMC_CAP_WAIT_WHILE_BUSY) && use_r1b_resp) ||
586 mmc_host_is_spi(host)) {
588 err = mmc_switch_status(card);
592 /* Let's try to poll to find out when the command is completed. */
593 err = mmc_poll_for_busy(card, timeout_ms, send_status, retry_crc_err);
595 mmc_retune_release(host);
600 int mmc_switch(struct mmc_card *card, u8 set, u8 index, u8 value,
601 unsigned int timeout_ms)
603 return __mmc_switch(card, set, index, value, timeout_ms, true, true,
606 EXPORT_SYMBOL_GPL(mmc_switch);
608 int mmc_send_tuning(struct mmc_host *host, u32 opcode, int *cmd_error)
610 struct mmc_request mrq = {NULL};
611 struct mmc_command cmd = {0};
612 struct mmc_data data = {0};
613 struct scatterlist sg;
614 struct mmc_ios *ios = &host->ios;
615 const u8 *tuning_block_pattern;
619 if (ios->bus_width == MMC_BUS_WIDTH_8) {
620 tuning_block_pattern = tuning_blk_pattern_8bit;
621 size = sizeof(tuning_blk_pattern_8bit);
622 } else if (ios->bus_width == MMC_BUS_WIDTH_4) {
623 tuning_block_pattern = tuning_blk_pattern_4bit;
624 size = sizeof(tuning_blk_pattern_4bit);
628 data_buf = kzalloc(size, GFP_KERNEL);
636 cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC;
640 data.flags = MMC_DATA_READ;
643 * According to the tuning specs, Tuning process
644 * is normally shorter 40 executions of CMD19,
645 * and timeout value should be shorter than 150 ms
647 data.timeout_ns = 150 * NSEC_PER_MSEC;
651 sg_init_one(&sg, data_buf, size);
653 mmc_wait_for_req(host, &mrq);
656 *cmd_error = cmd.error;
668 if (memcmp(data_buf, tuning_block_pattern, size))
675 EXPORT_SYMBOL_GPL(mmc_send_tuning);
678 mmc_send_bus_test(struct mmc_card *card, struct mmc_host *host, u8 opcode,
681 struct mmc_request mrq = {NULL};
682 struct mmc_command cmd = {0};
683 struct mmc_data data = {0};
684 struct scatterlist sg;
688 static u8 testdata_8bit[8] = { 0x55, 0xaa, 0, 0, 0, 0, 0, 0 };
689 static u8 testdata_4bit[4] = { 0x5a, 0, 0, 0 };
691 /* dma onto stack is unsafe/nonportable, but callers to this
692 * routine normally provide temporary on-stack buffers ...
694 data_buf = kmalloc(len, GFP_KERNEL);
699 test_buf = testdata_8bit;
701 test_buf = testdata_4bit;
703 pr_err("%s: Invalid bus_width %d\n",
704 mmc_hostname(host), len);
709 if (opcode == MMC_BUS_TEST_W)
710 memcpy(data_buf, test_buf, len);
717 /* NOTE HACK: the MMC_RSP_SPI_R1 is always correct here, but we
718 * rely on callers to never use this with "native" calls for reading
719 * CSD or CID. Native versions of those commands use the R2 type,
720 * not R1 plus a data block.
722 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
726 if (opcode == MMC_BUS_TEST_R)
727 data.flags = MMC_DATA_READ;
729 data.flags = MMC_DATA_WRITE;
733 mmc_set_data_timeout(&data, card);
734 sg_init_one(&sg, data_buf, len);
735 mmc_wait_for_req(host, &mrq);
737 if (opcode == MMC_BUS_TEST_R) {
738 for (i = 0; i < len / 4; i++)
739 if ((test_buf[i] ^ data_buf[i]) != 0xff) {
754 int mmc_bus_test(struct mmc_card *card, u8 bus_width)
758 if (bus_width == MMC_BUS_WIDTH_8)
760 else if (bus_width == MMC_BUS_WIDTH_4)
762 else if (bus_width == MMC_BUS_WIDTH_1)
763 return 0; /* no need for test */
768 * Ignore errors from BUS_TEST_W. BUS_TEST_R will fail if there
769 * is a problem. This improves chances that the test will work.
771 mmc_send_bus_test(card, card->host, MMC_BUS_TEST_W, width);
772 return mmc_send_bus_test(card, card->host, MMC_BUS_TEST_R, width);
775 int mmc_send_hpi_cmd(struct mmc_card *card, u32 *status)
777 struct mmc_command cmd = {0};
781 if (!card->ext_csd.hpi) {
782 pr_warn("%s: Card didn't support HPI command\n",
783 mmc_hostname(card->host));
787 opcode = card->ext_csd.hpi_cmd;
788 if (opcode == MMC_STOP_TRANSMISSION)
789 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC;
790 else if (opcode == MMC_SEND_STATUS)
791 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
794 cmd.arg = card->rca << 16 | 1;
796 err = mmc_wait_for_cmd(card->host, &cmd, 0);
798 pr_warn("%s: error %d interrupting operation. "
799 "HPI command response %#x\n", mmc_hostname(card->host),
804 *status = cmd.resp[0];
809 int mmc_can_ext_csd(struct mmc_card *card)
811 return (card && card->csd.mmca_vsn > CSD_SPEC_VER_3);