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 int _mmc_select_card(struct mmc_host *host, struct mmc_card *card)
29 struct mmc_command cmd = {0};
33 cmd.opcode = MMC_SELECT_CARD;
36 cmd.arg = card->rca << 16;
37 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
40 cmd.flags = MMC_RSP_NONE | MMC_CMD_AC;
43 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
50 int mmc_select_card(struct mmc_card *card)
54 return _mmc_select_card(card->host, card);
57 int mmc_deselect_cards(struct mmc_host *host)
59 return _mmc_select_card(host, NULL);
62 int mmc_go_idle(struct mmc_host *host)
65 struct mmc_command cmd = {0};
68 * Non-SPI hosts need to prevent chipselect going active during
69 * GO_IDLE; that would put chips into SPI mode. Remind them of
70 * that in case of hardware that won't pull up DAT3/nCS otherwise.
72 * SPI hosts ignore ios.chip_select; it's managed according to
73 * rules that must accommodate non-MMC slaves which this layer
74 * won't even know about.
76 if (!mmc_host_is_spi(host)) {
77 mmc_set_chip_select(host, MMC_CS_HIGH);
81 cmd.opcode = MMC_GO_IDLE_STATE;
83 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_NONE | MMC_CMD_BC;
85 err = mmc_wait_for_cmd(host, &cmd, 0);
89 if (!mmc_host_is_spi(host)) {
90 mmc_set_chip_select(host, MMC_CS_DONTCARE);
94 host->use_spi_crc = 0;
99 int mmc_send_op_cond(struct mmc_host *host, u32 ocr, u32 *rocr)
101 struct mmc_command cmd = {0};
106 cmd.opcode = MMC_SEND_OP_COND;
107 cmd.arg = mmc_host_is_spi(host) ? 0 : ocr;
108 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R3 | MMC_CMD_BCR;
110 for (i = 100; i; i--) {
111 err = mmc_wait_for_cmd(host, &cmd, 0);
115 /* if we're just probing, do a single pass */
119 /* otherwise wait until reset completes */
120 if (mmc_host_is_spi(host)) {
121 if (!(cmd.resp[0] & R1_SPI_IDLE))
124 if (cmd.resp[0] & MMC_CARD_BUSY)
133 if (rocr && !mmc_host_is_spi(host))
139 int mmc_all_send_cid(struct mmc_host *host, u32 *cid)
142 struct mmc_command cmd = {0};
147 cmd.opcode = MMC_ALL_SEND_CID;
149 cmd.flags = MMC_RSP_R2 | MMC_CMD_BCR;
151 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
155 memcpy(cid, cmd.resp, sizeof(u32) * 4);
160 int mmc_set_relative_addr(struct mmc_card *card)
163 struct mmc_command cmd = {0};
168 cmd.opcode = MMC_SET_RELATIVE_ADDR;
169 cmd.arg = card->rca << 16;
170 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
172 err = mmc_wait_for_cmd(card->host, &cmd, MMC_CMD_RETRIES);
180 mmc_send_cxd_native(struct mmc_host *host, u32 arg, u32 *cxd, int opcode)
183 struct mmc_command cmd = {0};
190 cmd.flags = MMC_RSP_R2 | MMC_CMD_AC;
192 err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
196 memcpy(cxd, cmd.resp, sizeof(u32) * 4);
202 * NOTE: void *buf, caller for the buf is required to use DMA-capable
203 * buffer or on-stack buffer (with some overhead in callee).
206 mmc_send_cxd_data(struct mmc_card *card, struct mmc_host *host,
207 u32 opcode, void *buf, unsigned len)
209 struct mmc_request mrq = {NULL};
210 struct mmc_command cmd = {0};
211 struct mmc_data data = {0};
212 struct scatterlist sg;
216 is_on_stack = object_is_on_stack(buf);
219 * dma onto stack is unsafe/nonportable, but callers to this
220 * routine normally provide temporary on-stack buffers ...
222 data_buf = kmalloc(len, GFP_KERNEL);
234 /* NOTE HACK: the MMC_RSP_SPI_R1 is always correct here, but we
235 * rely on callers to never use this with "native" calls for reading
236 * CSD or CID. Native versions of those commands use the R2 type,
237 * not R1 plus a data block.
239 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
243 data.flags = MMC_DATA_READ;
247 sg_init_one(&sg, data_buf, len);
249 if (opcode == MMC_SEND_CSD || opcode == MMC_SEND_CID) {
251 * The spec states that CSR and CID accesses have a timeout
252 * of 64 clock cycles.
255 data.timeout_clks = 64;
257 mmc_set_data_timeout(&data, card);
259 mmc_wait_for_req(host, &mrq);
262 memcpy(buf, data_buf, len);
274 int mmc_send_csd(struct mmc_card *card, u32 *csd)
279 if (!mmc_host_is_spi(card->host))
280 return mmc_send_cxd_native(card->host, card->rca << 16,
283 csd_tmp = kmalloc(16, GFP_KERNEL);
287 ret = mmc_send_cxd_data(card, card->host, MMC_SEND_CSD, csd_tmp, 16);
291 for (i = 0;i < 4;i++)
292 csd[i] = be32_to_cpu(csd_tmp[i]);
299 int mmc_send_cid(struct mmc_host *host, u32 *cid)
304 if (!mmc_host_is_spi(host)) {
307 return mmc_send_cxd_native(host, host->card->rca << 16,
311 cid_tmp = kmalloc(16, GFP_KERNEL);
315 ret = mmc_send_cxd_data(NULL, host, MMC_SEND_CID, cid_tmp, 16);
319 for (i = 0;i < 4;i++)
320 cid[i] = be32_to_cpu(cid_tmp[i]);
327 int mmc_send_ext_csd(struct mmc_card *card, u8 *ext_csd)
329 return mmc_send_cxd_data(card, card->host, MMC_SEND_EXT_CSD,
332 EXPORT_SYMBOL_GPL(mmc_send_ext_csd);
334 int mmc_spi_read_ocr(struct mmc_host *host, int highcap, u32 *ocrp)
336 struct mmc_command cmd = {0};
339 cmd.opcode = MMC_SPI_READ_OCR;
340 cmd.arg = highcap ? (1 << 30) : 0;
341 cmd.flags = MMC_RSP_SPI_R3;
343 err = mmc_wait_for_cmd(host, &cmd, 0);
349 int mmc_spi_set_crc(struct mmc_host *host, int use_crc)
351 struct mmc_command cmd = {0};
354 cmd.opcode = MMC_SPI_CRC_ON_OFF;
355 cmd.flags = MMC_RSP_SPI_R1;
358 err = mmc_wait_for_cmd(host, &cmd, 0);
360 host->use_spi_crc = use_crc;
365 * __mmc_switch - modify EXT_CSD register
366 * @card: the MMC card associated with the data transfer
367 * @set: cmd set values
368 * @index: EXT_CSD register index
369 * @value: value to program into EXT_CSD register
370 * @timeout_ms: timeout (ms) for operation performed by register write,
371 * timeout of zero implies maximum possible timeout
372 * @use_busy_signal: use the busy signal as response type
374 * Modifies the EXT_CSD register for selected card.
376 int __mmc_switch(struct mmc_card *card, u8 set, u8 index, u8 value,
377 unsigned int timeout_ms, bool use_busy_signal)
380 struct mmc_command cmd = {0};
381 unsigned long timeout;
387 cmd.opcode = MMC_SWITCH;
388 cmd.arg = (MMC_SWITCH_MODE_WRITE_BYTE << 24) |
392 cmd.flags = MMC_CMD_AC;
394 cmd.flags |= MMC_RSP_SPI_R1B | MMC_RSP_R1B;
396 cmd.flags |= MMC_RSP_SPI_R1 | MMC_RSP_R1;
399 cmd.cmd_timeout_ms = timeout_ms;
400 if (index == EXT_CSD_SANITIZE_START)
401 cmd.sanitize_busy = true;
403 err = mmc_wait_for_cmd(card->host, &cmd, MMC_CMD_RETRIES);
407 /* No need to check card status in case of unblocking command */
408 if (!use_busy_signal)
411 /* Must check status to be sure of no errors */
412 timeout = jiffies + msecs_to_jiffies(MMC_OPS_TIMEOUT_MS);
414 err = mmc_send_status(card, &status);
417 if (card->host->caps & MMC_CAP_WAIT_WHILE_BUSY)
419 if (mmc_host_is_spi(card->host))
422 /* Timeout if the device never leaves the program state. */
423 if (time_after(jiffies, timeout)) {
424 pr_err("%s: Card stuck in programming state! %s\n",
425 mmc_hostname(card->host), __func__);
428 } while (R1_CURRENT_STATE(status) == R1_STATE_PRG);
430 if (mmc_host_is_spi(card->host)) {
431 if (status & R1_SPI_ILLEGAL_COMMAND)
434 if (status & 0xFDFFA000)
435 pr_warning("%s: unexpected status %#x after "
436 "switch", mmc_hostname(card->host), status);
437 if (status & R1_SWITCH_ERROR)
443 EXPORT_SYMBOL_GPL(__mmc_switch);
445 int mmc_switch(struct mmc_card *card, u8 set, u8 index, u8 value,
446 unsigned int timeout_ms)
448 return __mmc_switch(card, set, index, value, timeout_ms, true);
450 EXPORT_SYMBOL_GPL(mmc_switch);
452 int mmc_send_status(struct mmc_card *card, u32 *status)
455 struct mmc_command cmd = {0};
460 cmd.opcode = MMC_SEND_STATUS;
461 if (!mmc_host_is_spi(card->host))
462 cmd.arg = card->rca << 16;
463 cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_AC;
465 err = mmc_wait_for_cmd(card->host, &cmd, MMC_CMD_RETRIES);
469 /* NOTE: callers are required to understand the difference
470 * between "native" and SPI format status words!
473 *status = cmd.resp[0];
479 mmc_send_bus_test(struct mmc_card *card, struct mmc_host *host, u8 opcode,
482 struct mmc_request mrq = {NULL};
483 struct mmc_command cmd = {0};
484 struct mmc_data data = {0};
485 struct scatterlist sg;
489 static u8 testdata_8bit[8] = { 0x55, 0xaa, 0, 0, 0, 0, 0, 0 };
490 static u8 testdata_4bit[4] = { 0x5a, 0, 0, 0 };
492 /* dma onto stack is unsafe/nonportable, but callers to this
493 * routine normally provide temporary on-stack buffers ...
495 data_buf = kmalloc(len, GFP_KERNEL);
500 test_buf = testdata_8bit;
502 test_buf = testdata_4bit;
504 pr_err("%s: Invalid bus_width %d\n",
505 mmc_hostname(host), len);
510 if (opcode == MMC_BUS_TEST_W)
511 memcpy(data_buf, test_buf, len);
518 /* NOTE HACK: the MMC_RSP_SPI_R1 is always correct here, but we
519 * rely on callers to never use this with "native" calls for reading
520 * CSD or CID. Native versions of those commands use the R2 type,
521 * not R1 plus a data block.
523 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
527 if (opcode == MMC_BUS_TEST_R)
528 data.flags = MMC_DATA_READ;
530 data.flags = MMC_DATA_WRITE;
534 mmc_set_data_timeout(&data, card);
535 sg_init_one(&sg, data_buf, len);
536 mmc_wait_for_req(host, &mrq);
538 if (opcode == MMC_BUS_TEST_R) {
539 for (i = 0; i < len / 4; i++)
540 if ((test_buf[i] ^ data_buf[i]) != 0xff) {
555 int mmc_bus_test(struct mmc_card *card, u8 bus_width)
559 if (bus_width == MMC_BUS_WIDTH_8)
561 else if (bus_width == MMC_BUS_WIDTH_4)
563 else if (bus_width == MMC_BUS_WIDTH_1)
564 return 0; /* no need for test */
569 * Ignore errors from BUS_TEST_W. BUS_TEST_R will fail if there
570 * is a problem. This improves chances that the test will work.
572 mmc_send_bus_test(card, card->host, MMC_BUS_TEST_W, width);
573 err = mmc_send_bus_test(card, card->host, MMC_BUS_TEST_R, width);
577 int mmc_send_hpi_cmd(struct mmc_card *card, u32 *status)
579 struct mmc_command cmd = {0};
583 if (!card->ext_csd.hpi) {
584 pr_warning("%s: Card didn't support HPI command\n",
585 mmc_hostname(card->host));
589 opcode = card->ext_csd.hpi_cmd;
590 if (opcode == MMC_STOP_TRANSMISSION)
591 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC;
592 else if (opcode == MMC_SEND_STATUS)
593 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
596 cmd.arg = card->rca << 16 | 1;
598 err = mmc_wait_for_cmd(card->host, &cmd, 0);
600 pr_warn("%s: error %d interrupting operation. "
601 "HPI command response %#x\n", mmc_hostname(card->host),
606 *status = cmd.resp[0];