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 static inline int __mmc_send_status(struct mmc_card
*card
, u32
*status
,
61 struct mmc_command cmd
= {0};
66 cmd
.opcode
= MMC_SEND_STATUS
;
67 if (!mmc_host_is_spi(card
->host
))
68 cmd
.arg
= card
->rca
<< 16;
69 cmd
.flags
= MMC_RSP_SPI_R2
| MMC_RSP_R1
| MMC_CMD_AC
;
71 cmd
.flags
&= ~MMC_RSP_CRC
;
73 err
= mmc_wait_for_cmd(card
->host
, &cmd
, MMC_CMD_RETRIES
);
77 /* NOTE: callers are required to understand the difference
78 * between "native" and SPI format status words!
81 *status
= cmd
.resp
[0];
86 int mmc_send_status(struct mmc_card
*card
, u32
*status
)
88 return __mmc_send_status(card
, status
, false);
91 static int _mmc_select_card(struct mmc_host
*host
, struct mmc_card
*card
)
93 struct mmc_command cmd
= {0};
97 cmd
.opcode
= MMC_SELECT_CARD
;
100 cmd
.arg
= card
->rca
<< 16;
101 cmd
.flags
= MMC_RSP_R1
| MMC_CMD_AC
;
104 cmd
.flags
= MMC_RSP_NONE
| MMC_CMD_AC
;
107 return mmc_wait_for_cmd(host
, &cmd
, MMC_CMD_RETRIES
);
110 int mmc_select_card(struct mmc_card
*card
)
114 return _mmc_select_card(card
->host
, card
);
117 int mmc_deselect_cards(struct mmc_host
*host
)
119 return _mmc_select_card(host
, NULL
);
123 * Write the value specified in the device tree or board code into the optional
124 * 16 bit Driver Stage Register. This can be used to tune raise/fall times and
125 * drive strength of the DAT and CMD outputs. The actual meaning of a given
126 * value is hardware dependant.
127 * The presence of the DSR register can be determined from the CSD register,
130 int mmc_set_dsr(struct mmc_host
*host
)
132 struct mmc_command cmd
= {0};
134 cmd
.opcode
= MMC_SET_DSR
;
136 cmd
.arg
= (host
->dsr
<< 16) | 0xffff;
137 cmd
.flags
= MMC_RSP_NONE
| MMC_CMD_AC
;
139 return mmc_wait_for_cmd(host
, &cmd
, MMC_CMD_RETRIES
);
142 int mmc_go_idle(struct mmc_host
*host
)
145 struct mmc_command cmd
= {0};
148 * Non-SPI hosts need to prevent chipselect going active during
149 * GO_IDLE; that would put chips into SPI mode. Remind them of
150 * that in case of hardware that won't pull up DAT3/nCS otherwise.
152 * SPI hosts ignore ios.chip_select; it's managed according to
153 * rules that must accommodate non-MMC slaves which this layer
154 * won't even know about.
156 if (!mmc_host_is_spi(host
)) {
157 mmc_set_chip_select(host
, MMC_CS_HIGH
);
161 cmd
.opcode
= MMC_GO_IDLE_STATE
;
163 cmd
.flags
= MMC_RSP_SPI_R1
| MMC_RSP_NONE
| MMC_CMD_BC
;
165 err
= mmc_wait_for_cmd(host
, &cmd
, 0);
169 if (!mmc_host_is_spi(host
)) {
170 mmc_set_chip_select(host
, MMC_CS_DONTCARE
);
174 host
->use_spi_crc
= 0;
179 int mmc_send_op_cond(struct mmc_host
*host
, u32 ocr
, u32
*rocr
)
181 struct mmc_command cmd
= {0};
186 cmd
.opcode
= MMC_SEND_OP_COND
;
187 cmd
.arg
= mmc_host_is_spi(host
) ? 0 : ocr
;
188 cmd
.flags
= MMC_RSP_SPI_R1
| MMC_RSP_R3
| MMC_CMD_BCR
;
190 for (i
= 100; i
; i
--) {
191 err
= mmc_wait_for_cmd(host
, &cmd
, 0);
195 /* if we're just probing, do a single pass */
199 /* otherwise wait until reset completes */
200 if (mmc_host_is_spi(host
)) {
201 if (!(cmd
.resp
[0] & R1_SPI_IDLE
))
204 if (cmd
.resp
[0] & MMC_CARD_BUSY
)
213 if (rocr
&& !mmc_host_is_spi(host
))
219 int mmc_all_send_cid(struct mmc_host
*host
, u32
*cid
)
222 struct mmc_command cmd
= {0};
227 cmd
.opcode
= MMC_ALL_SEND_CID
;
229 cmd
.flags
= MMC_RSP_R2
| MMC_CMD_BCR
;
231 err
= mmc_wait_for_cmd(host
, &cmd
, MMC_CMD_RETRIES
);
235 memcpy(cid
, cmd
.resp
, sizeof(u32
) * 4);
240 int mmc_set_relative_addr(struct mmc_card
*card
)
242 struct mmc_command cmd
= {0};
247 cmd
.opcode
= MMC_SET_RELATIVE_ADDR
;
248 cmd
.arg
= card
->rca
<< 16;
249 cmd
.flags
= MMC_RSP_R1
| MMC_CMD_AC
;
251 return mmc_wait_for_cmd(card
->host
, &cmd
, MMC_CMD_RETRIES
);
255 mmc_send_cxd_native(struct mmc_host
*host
, u32 arg
, u32
*cxd
, int opcode
)
258 struct mmc_command cmd
= {0};
265 cmd
.flags
= MMC_RSP_R2
| MMC_CMD_AC
;
267 err
= mmc_wait_for_cmd(host
, &cmd
, MMC_CMD_RETRIES
);
271 memcpy(cxd
, cmd
.resp
, sizeof(u32
) * 4);
277 * NOTE: void *buf, caller for the buf is required to use DMA-capable
278 * buffer or on-stack buffer (with some overhead in callee).
281 mmc_send_cxd_data(struct mmc_card
*card
, struct mmc_host
*host
,
282 u32 opcode
, void *buf
, unsigned len
)
284 struct mmc_request mrq
= {NULL
};
285 struct mmc_command cmd
= {0};
286 struct mmc_data data
= {0};
287 struct scatterlist sg
;
295 /* NOTE HACK: the MMC_RSP_SPI_R1 is always correct here, but we
296 * rely on callers to never use this with "native" calls for reading
297 * CSD or CID. Native versions of those commands use the R2 type,
298 * not R1 plus a data block.
300 cmd
.flags
= MMC_RSP_SPI_R1
| MMC_RSP_R1
| MMC_CMD_ADTC
;
304 data
.flags
= MMC_DATA_READ
;
308 sg_init_one(&sg
, buf
, len
);
310 if (opcode
== MMC_SEND_CSD
|| opcode
== MMC_SEND_CID
) {
312 * The spec states that CSR and CID accesses have a timeout
313 * of 64 clock cycles.
316 data
.timeout_clks
= 64;
318 mmc_set_data_timeout(&data
, card
);
320 mmc_wait_for_req(host
, &mrq
);
330 int mmc_send_csd(struct mmc_card
*card
, u32
*csd
)
335 if (!mmc_host_is_spi(card
->host
))
336 return mmc_send_cxd_native(card
->host
, card
->rca
<< 16,
339 csd_tmp
= kzalloc(16, GFP_KERNEL
);
343 ret
= mmc_send_cxd_data(card
, card
->host
, MMC_SEND_CSD
, csd_tmp
, 16);
347 for (i
= 0;i
< 4;i
++)
348 csd
[i
] = be32_to_cpu(csd_tmp
[i
]);
355 int mmc_send_cid(struct mmc_host
*host
, u32
*cid
)
360 if (!mmc_host_is_spi(host
)) {
363 return mmc_send_cxd_native(host
, host
->card
->rca
<< 16,
367 cid_tmp
= kzalloc(16, GFP_KERNEL
);
371 ret
= mmc_send_cxd_data(NULL
, host
, MMC_SEND_CID
, cid_tmp
, 16);
375 for (i
= 0;i
< 4;i
++)
376 cid
[i
] = be32_to_cpu(cid_tmp
[i
]);
383 int mmc_get_ext_csd(struct mmc_card
*card
, u8
**new_ext_csd
)
388 if (!card
|| !new_ext_csd
)
391 if (!mmc_can_ext_csd(card
))
395 * As the ext_csd is so large and mostly unused, we don't store the
396 * raw block in mmc_card.
398 ext_csd
= kzalloc(512, GFP_KERNEL
);
402 err
= mmc_send_cxd_data(card
, card
->host
, MMC_SEND_EXT_CSD
, ext_csd
,
407 *new_ext_csd
= ext_csd
;
411 EXPORT_SYMBOL_GPL(mmc_get_ext_csd
);
413 int mmc_spi_read_ocr(struct mmc_host
*host
, int highcap
, u32
*ocrp
)
415 struct mmc_command cmd
= {0};
418 cmd
.opcode
= MMC_SPI_READ_OCR
;
419 cmd
.arg
= highcap
? (1 << 30) : 0;
420 cmd
.flags
= MMC_RSP_SPI_R3
;
422 err
= mmc_wait_for_cmd(host
, &cmd
, 0);
428 int mmc_spi_set_crc(struct mmc_host
*host
, int use_crc
)
430 struct mmc_command cmd
= {0};
433 cmd
.opcode
= MMC_SPI_CRC_ON_OFF
;
434 cmd
.flags
= MMC_RSP_SPI_R1
;
437 err
= mmc_wait_for_cmd(host
, &cmd
, 0);
439 host
->use_spi_crc
= use_crc
;
443 int mmc_switch_status_error(struct mmc_host
*host
, u32 status
)
445 if (mmc_host_is_spi(host
)) {
446 if (status
& R1_SPI_ILLEGAL_COMMAND
)
449 if (status
& 0xFDFFA000)
450 pr_warn("%s: unexpected status %#x after switch\n",
451 mmc_hostname(host
), status
);
452 if (status
& R1_SWITCH_ERROR
)
459 * __mmc_switch - modify EXT_CSD register
460 * @card: the MMC card associated with the data transfer
461 * @set: cmd set values
462 * @index: EXT_CSD register index
463 * @value: value to program into EXT_CSD register
464 * @timeout_ms: timeout (ms) for operation performed by register write,
465 * timeout of zero implies maximum possible timeout
466 * @use_busy_signal: use the busy signal as response type
467 * @send_status: send status cmd to poll for busy
468 * @ignore_crc: ignore CRC errors when sending status cmd to poll for busy
470 * Modifies the EXT_CSD register for selected card.
472 int __mmc_switch(struct mmc_card
*card
, u8 set
, u8 index
, u8 value
,
473 unsigned int timeout_ms
, bool use_busy_signal
, bool send_status
,
476 struct mmc_host
*host
= card
->host
;
478 struct mmc_command cmd
= {0};
479 unsigned long timeout
;
481 bool use_r1b_resp
= use_busy_signal
;
482 bool expired
= false;
485 mmc_retune_hold(host
);
488 * If the cmd timeout and the max_busy_timeout of the host are both
489 * specified, let's validate them. A failure means we need to prevent
490 * the host from doing hw busy detection, which is done by converting
491 * to a R1 response instead of a R1B.
493 if (timeout_ms
&& host
->max_busy_timeout
&&
494 (timeout_ms
> host
->max_busy_timeout
))
495 use_r1b_resp
= false;
497 cmd
.opcode
= MMC_SWITCH
;
498 cmd
.arg
= (MMC_SWITCH_MODE_WRITE_BYTE
<< 24) |
502 cmd
.flags
= MMC_CMD_AC
;
504 cmd
.flags
|= MMC_RSP_SPI_R1B
| MMC_RSP_R1B
;
506 * A busy_timeout of zero means the host can decide to use
507 * whatever value it finds suitable.
509 cmd
.busy_timeout
= timeout_ms
;
511 cmd
.flags
|= MMC_RSP_SPI_R1
| MMC_RSP_R1
;
514 if (index
== EXT_CSD_SANITIZE_START
)
515 cmd
.sanitize_busy
= true;
517 err
= mmc_wait_for_cmd(host
, &cmd
, MMC_CMD_RETRIES
);
521 /* No need to check card status in case of unblocking command */
522 if (!use_busy_signal
)
526 * CRC errors shall only be ignored in cases were CMD13 is used to poll
527 * to detect busy completion.
529 if ((host
->caps
& MMC_CAP_WAIT_WHILE_BUSY
) && use_r1b_resp
)
532 /* We have an unspecified cmd timeout, use the fallback value. */
534 timeout_ms
= MMC_OPS_TIMEOUT_MS
;
536 /* Must check status to be sure of no errors. */
537 timeout
= jiffies
+ msecs_to_jiffies(timeout_ms
) + 1;
540 * Due to the possibility of being preempted after
541 * sending the status command, check the expiration
544 expired
= time_after(jiffies
, timeout
);
546 err
= __mmc_send_status(card
, &status
, ignore_crc
);
550 if ((host
->caps
& MMC_CAP_WAIT_WHILE_BUSY
) && use_r1b_resp
)
552 if (host
->ops
->card_busy
) {
553 if (!host
->ops
->card_busy(host
))
557 if (mmc_host_is_spi(host
))
561 * We are not allowed to issue a status command and the host
562 * does'nt support MMC_CAP_WAIT_WHILE_BUSY, then we can only
563 * rely on waiting for the stated timeout to be sufficient.
565 if (!send_status
&& !host
->ops
->card_busy
) {
566 mmc_delay(timeout_ms
);
570 /* Timeout if the device never leaves the program state. */
572 (R1_CURRENT_STATE(status
) == R1_STATE_PRG
|| busy
)) {
573 pr_err("%s: Card stuck in programming state! %s\n",
574 mmc_hostname(host
), __func__
);
578 } while (R1_CURRENT_STATE(status
) == R1_STATE_PRG
|| busy
);
580 err
= mmc_switch_status_error(host
, status
);
582 mmc_retune_release(host
);
587 int mmc_switch(struct mmc_card
*card
, u8 set
, u8 index
, u8 value
,
588 unsigned int timeout_ms
)
590 return __mmc_switch(card
, set
, index
, value
, timeout_ms
, true, true,
593 EXPORT_SYMBOL_GPL(mmc_switch
);
595 int mmc_send_tuning(struct mmc_host
*host
, u32 opcode
, int *cmd_error
)
597 struct mmc_request mrq
= {NULL
};
598 struct mmc_command cmd
= {0};
599 struct mmc_data data
= {0};
600 struct scatterlist sg
;
601 struct mmc_ios
*ios
= &host
->ios
;
602 const u8
*tuning_block_pattern
;
606 if (ios
->bus_width
== MMC_BUS_WIDTH_8
) {
607 tuning_block_pattern
= tuning_blk_pattern_8bit
;
608 size
= sizeof(tuning_blk_pattern_8bit
);
609 } else if (ios
->bus_width
== MMC_BUS_WIDTH_4
) {
610 tuning_block_pattern
= tuning_blk_pattern_4bit
;
611 size
= sizeof(tuning_blk_pattern_4bit
);
615 data_buf
= kzalloc(size
, GFP_KERNEL
);
623 cmd
.flags
= MMC_RSP_R1
| MMC_CMD_ADTC
;
627 data
.flags
= MMC_DATA_READ
;
630 * According to the tuning specs, Tuning process
631 * is normally shorter 40 executions of CMD19,
632 * and timeout value should be shorter than 150 ms
634 data
.timeout_ns
= 150 * NSEC_PER_MSEC
;
638 sg_init_one(&sg
, data_buf
, size
);
640 mmc_wait_for_req(host
, &mrq
);
643 *cmd_error
= cmd
.error
;
655 if (memcmp(data_buf
, tuning_block_pattern
, size
))
662 EXPORT_SYMBOL_GPL(mmc_send_tuning
);
665 mmc_send_bus_test(struct mmc_card
*card
, struct mmc_host
*host
, u8 opcode
,
668 struct mmc_request mrq
= {NULL
};
669 struct mmc_command cmd
= {0};
670 struct mmc_data data
= {0};
671 struct scatterlist sg
;
675 static u8 testdata_8bit
[8] = { 0x55, 0xaa, 0, 0, 0, 0, 0, 0 };
676 static u8 testdata_4bit
[4] = { 0x5a, 0, 0, 0 };
678 /* dma onto stack is unsafe/nonportable, but callers to this
679 * routine normally provide temporary on-stack buffers ...
681 data_buf
= kmalloc(len
, GFP_KERNEL
);
686 test_buf
= testdata_8bit
;
688 test_buf
= testdata_4bit
;
690 pr_err("%s: Invalid bus_width %d\n",
691 mmc_hostname(host
), len
);
696 if (opcode
== MMC_BUS_TEST_W
)
697 memcpy(data_buf
, test_buf
, len
);
704 /* NOTE HACK: the MMC_RSP_SPI_R1 is always correct here, but we
705 * rely on callers to never use this with "native" calls for reading
706 * CSD or CID. Native versions of those commands use the R2 type,
707 * not R1 plus a data block.
709 cmd
.flags
= MMC_RSP_SPI_R1
| MMC_RSP_R1
| MMC_CMD_ADTC
;
713 if (opcode
== MMC_BUS_TEST_R
)
714 data
.flags
= MMC_DATA_READ
;
716 data
.flags
= MMC_DATA_WRITE
;
720 mmc_set_data_timeout(&data
, card
);
721 sg_init_one(&sg
, data_buf
, len
);
722 mmc_wait_for_req(host
, &mrq
);
724 if (opcode
== MMC_BUS_TEST_R
) {
725 for (i
= 0; i
< len
/ 4; i
++)
726 if ((test_buf
[i
] ^ data_buf
[i
]) != 0xff) {
741 int mmc_bus_test(struct mmc_card
*card
, u8 bus_width
)
745 if (bus_width
== MMC_BUS_WIDTH_8
)
747 else if (bus_width
== MMC_BUS_WIDTH_4
)
749 else if (bus_width
== MMC_BUS_WIDTH_1
)
750 return 0; /* no need for test */
755 * Ignore errors from BUS_TEST_W. BUS_TEST_R will fail if there
756 * is a problem. This improves chances that the test will work.
758 mmc_send_bus_test(card
, card
->host
, MMC_BUS_TEST_W
, width
);
759 return mmc_send_bus_test(card
, card
->host
, MMC_BUS_TEST_R
, width
);
762 int mmc_send_hpi_cmd(struct mmc_card
*card
, u32
*status
)
764 struct mmc_command cmd
= {0};
768 if (!card
->ext_csd
.hpi
) {
769 pr_warn("%s: Card didn't support HPI command\n",
770 mmc_hostname(card
->host
));
774 opcode
= card
->ext_csd
.hpi_cmd
;
775 if (opcode
== MMC_STOP_TRANSMISSION
)
776 cmd
.flags
= MMC_RSP_R1B
| MMC_CMD_AC
;
777 else if (opcode
== MMC_SEND_STATUS
)
778 cmd
.flags
= MMC_RSP_R1
| MMC_CMD_AC
;
781 cmd
.arg
= card
->rca
<< 16 | 1;
783 err
= mmc_wait_for_cmd(card
->host
, &cmd
, 0);
785 pr_warn("%s: error %d interrupting operation. "
786 "HPI command response %#x\n", mmc_hostname(card
->host
),
791 *status
= cmd
.resp
[0];
796 int mmc_can_ext_csd(struct mmc_card
*card
)
798 return (card
&& card
->csd
.mmca_vsn
> CSD_SPEC_VER_3
);