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>
24 #define MMC_OPS_TIMEOUT_MS (10 * 60 * 1000) /* 10 minute timeout */
26 static inline int __mmc_send_status(struct mmc_card *card, u32 *status,
30 struct mmc_command cmd = {0};
35 cmd.opcode = MMC_SEND_STATUS;
36 if (!mmc_host_is_spi(card->host))
37 cmd.arg = card->rca << 16;
38 cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
40 cmd.flags &= ~MMC_RSP_CRC;
42 err = mmc_wait_for_cmd(card->host, &cmd, MMC_CMD_RETRIES);
46 /* NOTE: callers are required to understand the difference
47 * between "native" and SPI format status words!
50 *status = cmd.resp[0];
55 int mmc_send_status(struct mmc_card *card, u32 *status)
57 return __mmc_send_status(card, status, false);
60 static int _mmc_select_card(struct mmc_host *host, struct mmc_card *card)
63 struct mmc_command cmd = {0};
67 cmd.opcode = MMC_SELECT_CARD;
70 cmd.arg = card->rca << 16;
71 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
74 cmd.flags = MMC_RSP_NONE | MMC_CMD_AC;
77 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
84 int mmc_select_card(struct mmc_card *card)
88 return _mmc_select_card(card->host, card);
91 int mmc_deselect_cards(struct mmc_host *host)
93 return _mmc_select_card(host, NULL);
96 int mmc_go_idle(struct mmc_host *host)
99 struct mmc_command cmd = {0};
102 * Non-SPI hosts need to prevent chipselect going active during
103 * GO_IDLE; that would put chips into SPI mode. Remind them of
104 * that in case of hardware that won't pull up DAT3/nCS otherwise.
106 * SPI hosts ignore ios.chip_select; it's managed according to
107 * rules that must accommodate non-MMC slaves which this layer
108 * won't even know about.
110 if (!mmc_host_is_spi(host)) {
111 mmc_set_chip_select(host, MMC_CS_HIGH);
115 cmd.opcode = MMC_GO_IDLE_STATE;
117 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_NONE | MMC_CMD_BC;
119 err = mmc_wait_for_cmd(host, &cmd, 0);
123 if (!mmc_host_is_spi(host)) {
124 mmc_set_chip_select(host, MMC_CS_DONTCARE);
128 host->use_spi_crc = 0;
133 int mmc_send_op_cond(struct mmc_host *host, u32 ocr, u32 *rocr)
135 struct mmc_command cmd = {0};
140 cmd.opcode = MMC_SEND_OP_COND;
141 cmd.arg = mmc_host_is_spi(host) ? 0 : ocr;
142 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R3 | MMC_CMD_BCR;
144 for (i = 100; i; i--) {
145 err = mmc_wait_for_cmd(host, &cmd, 0);
149 /* if we're just probing, do a single pass */
153 /* otherwise wait until reset completes */
154 if (mmc_host_is_spi(host)) {
155 if (!(cmd.resp[0] & R1_SPI_IDLE))
158 if (cmd.resp[0] & MMC_CARD_BUSY)
167 if (rocr && !mmc_host_is_spi(host))
173 int mmc_all_send_cid(struct mmc_host *host, u32 *cid)
176 struct mmc_command cmd = {0};
181 cmd.opcode = MMC_ALL_SEND_CID;
183 cmd.flags = MMC_RSP_R2 | MMC_CMD_BCR;
185 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
189 memcpy(cid, cmd.resp, sizeof(u32) * 4);
194 int mmc_set_relative_addr(struct mmc_card *card)
197 struct mmc_command cmd = {0};
202 cmd.opcode = MMC_SET_RELATIVE_ADDR;
203 cmd.arg = card->rca << 16;
204 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
206 err = mmc_wait_for_cmd(card->host, &cmd, MMC_CMD_RETRIES);
214 mmc_send_cxd_native(struct mmc_host *host, u32 arg, u32 *cxd, int opcode)
217 struct mmc_command cmd = {0};
224 cmd.flags = MMC_RSP_R2 | MMC_CMD_AC;
226 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
230 memcpy(cxd, cmd.resp, sizeof(u32) * 4);
236 * NOTE: void *buf, caller for the buf is required to use DMA-capable
237 * buffer or on-stack buffer (with some overhead in callee).
240 mmc_send_cxd_data(struct mmc_card *card, struct mmc_host *host,
241 u32 opcode, void *buf, unsigned len)
243 struct mmc_request mrq = {NULL};
244 struct mmc_command cmd = {0};
245 struct mmc_data data = {0};
246 struct scatterlist sg;
250 is_on_stack = object_is_on_stack(buf);
253 * dma onto stack is unsafe/nonportable, but callers to this
254 * routine normally provide temporary on-stack buffers ...
256 data_buf = kmalloc(len, GFP_KERNEL);
268 /* NOTE HACK: the MMC_RSP_SPI_R1 is always correct here, but we
269 * rely on callers to never use this with "native" calls for reading
270 * CSD or CID. Native versions of those commands use the R2 type,
271 * not R1 plus a data block.
273 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
277 data.flags = MMC_DATA_READ;
281 sg_init_one(&sg, data_buf, len);
283 if (opcode == MMC_SEND_CSD || opcode == MMC_SEND_CID) {
285 * The spec states that CSR and CID accesses have a timeout
286 * of 64 clock cycles.
289 data.timeout_clks = 64;
291 mmc_set_data_timeout(&data, card);
293 mmc_wait_for_req(host, &mrq);
296 memcpy(buf, data_buf, len);
308 int mmc_send_csd(struct mmc_card *card, u32 *csd)
313 if (!mmc_host_is_spi(card->host))
314 return mmc_send_cxd_native(card->host, card->rca << 16,
317 csd_tmp = kmalloc(16, GFP_KERNEL);
321 ret = mmc_send_cxd_data(card, card->host, MMC_SEND_CSD, csd_tmp, 16);
325 for (i = 0;i < 4;i++)
326 csd[i] = be32_to_cpu(csd_tmp[i]);
333 int mmc_send_cid(struct mmc_host *host, u32 *cid)
338 if (!mmc_host_is_spi(host)) {
341 return mmc_send_cxd_native(host, host->card->rca << 16,
345 cid_tmp = kmalloc(16, GFP_KERNEL);
349 ret = mmc_send_cxd_data(NULL, host, MMC_SEND_CID, cid_tmp, 16);
353 for (i = 0;i < 4;i++)
354 cid[i] = be32_to_cpu(cid_tmp[i]);
361 int mmc_send_ext_csd(struct mmc_card *card, u8 *ext_csd)
363 return mmc_send_cxd_data(card, card->host, MMC_SEND_EXT_CSD,
366 EXPORT_SYMBOL_GPL(mmc_send_ext_csd);
368 int mmc_spi_read_ocr(struct mmc_host *host, int highcap, u32 *ocrp)
370 struct mmc_command cmd = {0};
373 cmd.opcode = MMC_SPI_READ_OCR;
374 cmd.arg = highcap ? (1 << 30) : 0;
375 cmd.flags = MMC_RSP_SPI_R3;
377 err = mmc_wait_for_cmd(host, &cmd, 0);
383 int mmc_spi_set_crc(struct mmc_host *host, int use_crc)
385 struct mmc_command cmd = {0};
388 cmd.opcode = MMC_SPI_CRC_ON_OFF;
389 cmd.flags = MMC_RSP_SPI_R1;
392 err = mmc_wait_for_cmd(host, &cmd, 0);
394 host->use_spi_crc = use_crc;
399 * __mmc_switch - modify EXT_CSD register
400 * @card: the MMC card associated with the data transfer
401 * @set: cmd set values
402 * @index: EXT_CSD register index
403 * @value: value to program into EXT_CSD register
404 * @timeout_ms: timeout (ms) for operation performed by register write,
405 * timeout of zero implies maximum possible timeout
406 * @use_busy_signal: use the busy signal as response type
407 * @send_status: send status cmd to poll for busy
408 * @ignore_crc: ignore CRC errors when sending status cmd to poll for busy
410 * Modifies the EXT_CSD register for selected card.
412 int __mmc_switch(struct mmc_card *card, u8 set, u8 index, u8 value,
413 unsigned int timeout_ms, bool use_busy_signal, bool send_status,
416 struct mmc_host *host = card->host;
418 struct mmc_command cmd = {0};
419 unsigned long timeout;
421 bool use_r1b_resp = use_busy_signal;
424 * If the cmd timeout and the max_busy_timeout of the host are both
425 * specified, let's validate them. A failure means we need to prevent
426 * the host from doing hw busy detection, which is done by converting
427 * to a R1 response instead of a R1B.
429 if (timeout_ms && host->max_busy_timeout &&
430 (timeout_ms > host->max_busy_timeout))
431 use_r1b_resp = false;
433 cmd.opcode = MMC_SWITCH;
434 cmd.arg = (MMC_SWITCH_MODE_WRITE_BYTE << 24) |
438 cmd.flags = MMC_CMD_AC;
440 cmd.flags |= MMC_RSP_SPI_R1B | MMC_RSP_R1B;
442 * A busy_timeout of zero means the host can decide to use
443 * whatever value it finds suitable.
445 cmd.busy_timeout = timeout_ms;
447 cmd.flags |= MMC_RSP_SPI_R1 | MMC_RSP_R1;
450 if (index == EXT_CSD_SANITIZE_START)
451 cmd.sanitize_busy = true;
453 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
457 /* No need to check card status in case of unblocking command */
458 if (!use_busy_signal)
462 * CRC errors shall only be ignored in cases were CMD13 is used to poll
463 * to detect busy completion.
465 if ((host->caps & MMC_CAP_WAIT_WHILE_BUSY) && use_r1b_resp)
468 /* We have an unspecified cmd timeout, use the fallback value. */
470 timeout_ms = MMC_OPS_TIMEOUT_MS;
472 /* Must check status to be sure of no errors. */
473 timeout = jiffies + msecs_to_jiffies(timeout_ms);
476 err = __mmc_send_status(card, &status, ignore_crc);
480 if ((host->caps & MMC_CAP_WAIT_WHILE_BUSY) && use_r1b_resp)
482 if (mmc_host_is_spi(host))
486 * We are not allowed to issue a status command and the host
487 * does'nt support MMC_CAP_WAIT_WHILE_BUSY, then we can only
488 * rely on waiting for the stated timeout to be sufficient.
491 mmc_delay(timeout_ms);
495 /* Timeout if the device never leaves the program state. */
496 if (time_after(jiffies, timeout)) {
497 pr_err("%s: Card stuck in programming state! %s\n",
498 mmc_hostname(host), __func__);
501 } while (R1_CURRENT_STATE(status) == R1_STATE_PRG);
503 if (mmc_host_is_spi(host)) {
504 if (status & R1_SPI_ILLEGAL_COMMAND)
507 if (status & 0xFDFFA000)
508 pr_warn("%s: unexpected status %#x after switch\n",
509 mmc_hostname(host), status);
510 if (status & R1_SWITCH_ERROR)
516 EXPORT_SYMBOL_GPL(__mmc_switch);
518 int mmc_switch(struct mmc_card *card, u8 set, u8 index, u8 value,
519 unsigned int timeout_ms)
521 return __mmc_switch(card, set, index, value, timeout_ms, true, true,
524 EXPORT_SYMBOL_GPL(mmc_switch);
527 mmc_send_bus_test(struct mmc_card *card, struct mmc_host *host, u8 opcode,
530 struct mmc_request mrq = {NULL};
531 struct mmc_command cmd = {0};
532 struct mmc_data data = {0};
533 struct scatterlist sg;
537 static u8 testdata_8bit[8] = { 0x55, 0xaa, 0, 0, 0, 0, 0, 0 };
538 static u8 testdata_4bit[4] = { 0x5a, 0, 0, 0 };
540 /* dma onto stack is unsafe/nonportable, but callers to this
541 * routine normally provide temporary on-stack buffers ...
543 data_buf = kmalloc(len, GFP_KERNEL);
548 test_buf = testdata_8bit;
550 test_buf = testdata_4bit;
552 pr_err("%s: Invalid bus_width %d\n",
553 mmc_hostname(host), len);
558 if (opcode == MMC_BUS_TEST_W)
559 memcpy(data_buf, test_buf, len);
566 /* NOTE HACK: the MMC_RSP_SPI_R1 is always correct here, but we
567 * rely on callers to never use this with "native" calls for reading
568 * CSD or CID. Native versions of those commands use the R2 type,
569 * not R1 plus a data block.
571 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
575 if (opcode == MMC_BUS_TEST_R)
576 data.flags = MMC_DATA_READ;
578 data.flags = MMC_DATA_WRITE;
582 mmc_set_data_timeout(&data, card);
583 sg_init_one(&sg, data_buf, len);
584 mmc_wait_for_req(host, &mrq);
586 if (opcode == MMC_BUS_TEST_R) {
587 for (i = 0; i < len / 4; i++)
588 if ((test_buf[i] ^ data_buf[i]) != 0xff) {
603 int mmc_bus_test(struct mmc_card *card, u8 bus_width)
607 if (bus_width == MMC_BUS_WIDTH_8)
609 else if (bus_width == MMC_BUS_WIDTH_4)
611 else if (bus_width == MMC_BUS_WIDTH_1)
612 return 0; /* no need for test */
617 * Ignore errors from BUS_TEST_W. BUS_TEST_R will fail if there
618 * is a problem. This improves chances that the test will work.
620 mmc_send_bus_test(card, card->host, MMC_BUS_TEST_W, width);
621 err = mmc_send_bus_test(card, card->host, MMC_BUS_TEST_R, width);
625 int mmc_send_hpi_cmd(struct mmc_card *card, u32 *status)
627 struct mmc_command cmd = {0};
631 if (!card->ext_csd.hpi) {
632 pr_warning("%s: Card didn't support HPI command\n",
633 mmc_hostname(card->host));
637 opcode = card->ext_csd.hpi_cmd;
638 if (opcode == MMC_STOP_TRANSMISSION)
639 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC;
640 else if (opcode == MMC_SEND_STATUS)
641 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
644 cmd.arg = card->rca << 16 | 1;
646 err = mmc_wait_for_cmd(card->host, &cmd, 0);
648 pr_warn("%s: error %d interrupting operation. "
649 "HPI command response %#x\n", mmc_hostname(card->host),
654 *status = cmd.resp[0];