blob: 279d5da6e54b0f7642c7543935e635b73a81aa90 [file] [log] [blame]
David Brownell15a05802007-08-08 09:12:54 -07001/*
2 * mmc_spi.c - Access SD/MMC cards through SPI master controllers
3 *
4 * (C) Copyright 2005, Intec Automation,
5 * Mike Lavender (mike@steroidmicros)
6 * (C) Copyright 2006-2007, David Brownell
7 * (C) Copyright 2007, Axis Communications,
8 * Hans-Peter Nilsson (hp@axis.com)
9 * (C) Copyright 2007, ATRON electronic GmbH,
10 * Jan Nikitenko <jan.nikitenko@gmail.com>
11 *
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, write to the Free Software
25 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 */
Wolfgang Muees56e303e2009-04-07 15:26:30 +010027#include <linux/sched.h>
David Brownell15a05802007-08-08 09:12:54 -070028#include <linux/delay.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090029#include <linux/slab.h>
Paul Gortmaker88b47672011-07-03 15:15:51 -040030#include <linux/module.h>
David Brownell23fd5042007-10-14 14:50:25 -070031#include <linux/bio.h>
David Brownell15a05802007-08-08 09:12:54 -070032#include <linux/dma-mapping.h>
33#include <linux/crc7.h>
34#include <linux/crc-itu-t.h>
Al Viroe5712a62007-10-17 01:09:07 +010035#include <linux/scatterlist.h>
David Brownell15a05802007-08-08 09:12:54 -070036
37#include <linux/mmc/host.h>
38#include <linux/mmc/mmc.h> /* for R1_SPI_* bit values */
Laurent Pinchartbf287a92013-08-08 12:38:32 +020039#include <linux/mmc/slot-gpio.h>
David Brownell15a05802007-08-08 09:12:54 -070040
41#include <linux/spi/spi.h>
42#include <linux/spi/mmc_spi.h>
43
44#include <asm/unaligned.h>
45
46
47/* NOTES:
48 *
49 * - For now, we won't try to interoperate with a real mmc/sd/sdio
50 * controller, although some of them do have hardware support for
51 * SPI protocol. The main reason for such configs would be mmc-ish
52 * cards like DataFlash, which don't support that "native" protocol.
53 *
54 * We don't have a "DataFlash/MMC/SD/SDIO card slot" abstraction to
55 * switch between driver stacks, and in any case if "native" mode
56 * is available, it will be faster and hence preferable.
57 *
58 * - MMC depends on a different chipselect management policy than the
59 * SPI interface currently supports for shared bus segments: it needs
60 * to issue multiple spi_message requests with the chipselect active,
61 * using the results of one message to decide the next one to issue.
62 *
63 * Pending updates to the programming interface, this driver expects
64 * that it not share the bus with other drivers (precluding conflicts).
65 *
66 * - We tell the controller to keep the chipselect active from the
67 * beginning of an mmc_host_ops.request until the end. So beware
68 * of SPI controller drivers that mis-handle the cs_change flag!
69 *
70 * However, many cards seem OK with chipselect flapping up/down
71 * during that time ... at least on unshared bus segments.
72 */
73
74
75/*
76 * Local protocol constants, internal to data block protocols.
77 */
78
79/* Response tokens used to ack each block written: */
80#define SPI_MMC_RESPONSE_CODE(x) ((x) & 0x1f)
81#define SPI_RESPONSE_ACCEPTED ((2 << 1)|1)
82#define SPI_RESPONSE_CRC_ERR ((5 << 1)|1)
83#define SPI_RESPONSE_WRITE_ERR ((6 << 1)|1)
84
85/* Read and write blocks start with these tokens and end with crc;
86 * on error, read tokens act like a subset of R2_SPI_* values.
87 */
88#define SPI_TOKEN_SINGLE 0xfe /* single block r/w, multiblock read */
89#define SPI_TOKEN_MULTI_WRITE 0xfc /* multiblock write */
90#define SPI_TOKEN_STOP_TRAN 0xfd /* terminate multiblock write */
91
92#define MMC_SPI_BLOCKSIZE 512
93
94
95/* These fixed timeouts come from the latest SD specs, which say to ignore
96 * the CSD values. The R1B value is for card erase (e.g. the "I forgot the
97 * card's password" scenario); it's mostly applied to STOP_TRANSMISSION after
98 * reads which takes nowhere near that long. Older cards may be able to use
99 * shorter timeouts ... but why bother?
100 */
Wolfgang Muees56e303e2009-04-07 15:26:30 +0100101#define r1b_timeout (HZ * 3)
David Brownell15a05802007-08-08 09:12:54 -0700102
Wolfgang Muees5cf20aa2009-04-08 10:14:07 +0100103/* One of the critical speed parameters is the amount of data which may
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300104 * be transferred in one command. If this value is too low, the SD card
Wolfgang Muees5cf20aa2009-04-08 10:14:07 +0100105 * controller has to do multiple partial block writes (argggh!). With
106 * today (2008) SD cards there is little speed gain if we transfer more
107 * than 64 KBytes at a time. So use this value until there is any indication
108 * that we should do more here.
109 */
110#define MMC_SPI_BLOCKSATONCE 128
David Brownell15a05802007-08-08 09:12:54 -0700111
112/****************************************************************************/
113
114/*
115 * Local Data Structures
116 */
117
118/* "scratch" is per-{command,block} data exchanged with the card */
119struct scratch {
120 u8 status[29];
121 u8 data_token;
122 __be16 crc_val;
123};
124
125struct mmc_spi_host {
126 struct mmc_host *mmc;
127 struct spi_device *spi;
128
129 unsigned char power_mode;
130 u16 powerup_msecs;
131
132 struct mmc_spi_platform_data *pdata;
133
134 /* for bulk data transfers */
135 struct spi_transfer token, t, crc, early_status;
136 struct spi_message m;
137
138 /* for status readback */
139 struct spi_transfer status;
140 struct spi_message readback;
141
142 /* underlying DMA-aware controller, or null */
143 struct device *dma_dev;
144
145 /* buffer used for commands and for message "overhead" */
146 struct scratch *data;
147 dma_addr_t data_dma;
148
149 /* Specs say to write ones most of the time, even when the card
150 * has no need to read its input data; and many cards won't care.
151 * This is our source of those ones.
152 */
153 void *ones;
154 dma_addr_t ones_dma;
155};
156
157
158/****************************************************************************/
159
160/*
161 * MMC-over-SPI protocol glue, used by the MMC stack interface
162 */
163
164static inline int mmc_cs_off(struct mmc_spi_host *host)
165{
166 /* chipselect will always be inactive after setup() */
167 return spi_setup(host->spi);
168}
169
170static int
171mmc_spi_readbytes(struct mmc_spi_host *host, unsigned len)
172{
173 int status;
174
175 if (len > sizeof(*host->data)) {
176 WARN_ON(1);
177 return -EIO;
178 }
179
180 host->status.len = len;
181
182 if (host->dma_dev)
183 dma_sync_single_for_device(host->dma_dev,
184 host->data_dma, sizeof(*host->data),
185 DMA_FROM_DEVICE);
186
Ernst Schwab4751c1c2010-02-18 12:47:46 +0100187 status = spi_sync_locked(host->spi, &host->readback);
David Brownell15a05802007-08-08 09:12:54 -0700188
189 if (host->dma_dev)
190 dma_sync_single_for_cpu(host->dma_dev,
191 host->data_dma, sizeof(*host->data),
192 DMA_FROM_DEVICE);
193
194 return status;
195}
196
Wolfgang Muees56e303e2009-04-07 15:26:30 +0100197static int mmc_spi_skip(struct mmc_spi_host *host, unsigned long timeout,
198 unsigned n, u8 byte)
David Brownell15a05802007-08-08 09:12:54 -0700199{
200 u8 *cp = host->data->status;
Wolfgang Muees56e303e2009-04-07 15:26:30 +0100201 unsigned long start = jiffies;
David Brownell15a05802007-08-08 09:12:54 -0700202
203 while (1) {
204 int status;
205 unsigned i;
206
207 status = mmc_spi_readbytes(host, n);
208 if (status < 0)
209 return status;
210
211 for (i = 0; i < n; i++) {
212 if (cp[i] != byte)
213 return cp[i];
214 }
215
Wolfgang Muees56e303e2009-04-07 15:26:30 +0100216 if (time_is_before_jiffies(start + timeout))
David Brownell15a05802007-08-08 09:12:54 -0700217 break;
Wolfgang Muees56e303e2009-04-07 15:26:30 +0100218
219 /* If we need long timeouts, we may release the CPU.
220 * We use jiffies here because we want to have a relation
221 * between elapsed time and the blocking of the scheduler.
222 */
223 if (time_is_before_jiffies(start+1))
224 schedule();
David Brownell15a05802007-08-08 09:12:54 -0700225 }
226 return -ETIMEDOUT;
227}
228
229static inline int
Wolfgang Muees56e303e2009-04-07 15:26:30 +0100230mmc_spi_wait_unbusy(struct mmc_spi_host *host, unsigned long timeout)
David Brownell15a05802007-08-08 09:12:54 -0700231{
232 return mmc_spi_skip(host, timeout, sizeof(host->data->status), 0);
233}
234
Wolfgang Muees56e303e2009-04-07 15:26:30 +0100235static int mmc_spi_readtoken(struct mmc_spi_host *host, unsigned long timeout)
David Brownell15a05802007-08-08 09:12:54 -0700236{
Matthew Fleming162350e2008-10-02 12:21:42 +0100237 return mmc_spi_skip(host, timeout, 1, 0xff);
David Brownell15a05802007-08-08 09:12:54 -0700238}
239
240
241/*
242 * Note that for SPI, cmd->resp[0] is not the same data as "native" protocol
243 * hosts return! The low byte holds R1_SPI bits. The next byte may hold
244 * R2_SPI bits ... for SEND_STATUS, or after data read errors.
245 *
246 * cmd->resp[1] holds any four-byte response, for R3 (READ_OCR) and on
247 * newer cards R7 (IF_COND).
248 */
249
250static char *maptype(struct mmc_command *cmd)
251{
252 switch (mmc_spi_resp_type(cmd)) {
253 case MMC_RSP_SPI_R1: return "R1";
254 case MMC_RSP_SPI_R1B: return "R1B";
255 case MMC_RSP_SPI_R2: return "R2/R5";
256 case MMC_RSP_SPI_R3: return "R3/R4/R7";
257 default: return "?";
258 }
259}
260
261/* return zero, else negative errno after setting cmd->error */
262static int mmc_spi_response_get(struct mmc_spi_host *host,
263 struct mmc_command *cmd, int cs_on)
264{
265 u8 *cp = host->data->status;
266 u8 *end = cp + host->t.len;
267 int value = 0;
Wolfgang Mueesab5a6432009-04-08 09:48:58 +0100268 int bitshift;
269 u8 leftover = 0;
270 unsigned short rotator;
271 int i;
David Brownell15a05802007-08-08 09:12:54 -0700272 char tag[32];
273
274 snprintf(tag, sizeof(tag), " ... CMD%d response SPI_%s",
275 cmd->opcode, maptype(cmd));
276
277 /* Except for data block reads, the whole response will already
278 * be stored in the scratch buffer. It's somewhere after the
279 * command and the first byte we read after it. We ignore that
280 * first byte. After STOP_TRANSMISSION command it may include
281 * two data bits, but otherwise it's all ones.
282 */
283 cp += 8;
284 while (cp < end && *cp == 0xff)
285 cp++;
286
287 /* Data block reads (R1 response types) may need more data... */
288 if (cp == end) {
David Brownell15a05802007-08-08 09:12:54 -0700289 cp = host->data->status;
Wolfgang Mueesab5a6432009-04-08 09:48:58 +0100290 end = cp+1;
David Brownell15a05802007-08-08 09:12:54 -0700291
292 /* Card sends N(CR) (== 1..8) bytes of all-ones then one
293 * status byte ... and we already scanned 2 bytes.
294 *
295 * REVISIT block read paths use nasty byte-at-a-time I/O
296 * so it can always DMA directly into the target buffer.
297 * It'd probably be better to memcpy() the first chunk and
298 * avoid extra i/o calls...
Wolfgang Mueesea15ba52009-03-11 14:17:43 +0100299 *
300 * Note we check for more than 8 bytes, because in practice,
301 * some SD cards are slow...
David Brownell15a05802007-08-08 09:12:54 -0700302 */
Wolfgang Mueesea15ba52009-03-11 14:17:43 +0100303 for (i = 2; i < 16; i++) {
David Brownell15a05802007-08-08 09:12:54 -0700304 value = mmc_spi_readbytes(host, 1);
305 if (value < 0)
306 goto done;
307 if (*cp != 0xff)
308 goto checkstatus;
309 }
310 value = -ETIMEDOUT;
311 goto done;
312 }
313
314checkstatus:
Wolfgang Mueesab5a6432009-04-08 09:48:58 +0100315 bitshift = 0;
316 if (*cp & 0x80) {
317 /* Houston, we have an ugly card with a bit-shifted response */
318 rotator = *cp++ << 8;
319 /* read the next byte */
320 if (cp == end) {
321 value = mmc_spi_readbytes(host, 1);
322 if (value < 0)
323 goto done;
324 cp = host->data->status;
325 end = cp+1;
326 }
327 rotator |= *cp++;
328 while (rotator & 0x8000) {
329 bitshift++;
330 rotator <<= 1;
331 }
332 cmd->resp[0] = rotator >> 8;
333 leftover = rotator;
334 } else {
335 cmd->resp[0] = *cp++;
David Brownell15a05802007-08-08 09:12:54 -0700336 }
David Brownell15a05802007-08-08 09:12:54 -0700337 cmd->error = 0;
338
339 /* Status byte: the entire seven-bit R1 response. */
340 if (cmd->resp[0] != 0) {
Wolfgang Mueesfdd858d2009-05-26 08:56:19 +0100341 if ((R1_SPI_PARAMETER | R1_SPI_ADDRESS)
David Brownell15a05802007-08-08 09:12:54 -0700342 & cmd->resp[0])
Wolfgang Mueesfdd858d2009-05-26 08:56:19 +0100343 value = -EFAULT; /* Bad address */
344 else if (R1_SPI_ILLEGAL_COMMAND & cmd->resp[0])
345 value = -ENOSYS; /* Function not implemented */
David Brownell15a05802007-08-08 09:12:54 -0700346 else if (R1_SPI_COM_CRC & cmd->resp[0])
Wolfgang Mueesfdd858d2009-05-26 08:56:19 +0100347 value = -EILSEQ; /* Illegal byte sequence */
David Brownell15a05802007-08-08 09:12:54 -0700348 else if ((R1_SPI_ERASE_SEQ | R1_SPI_ERASE_RESET)
349 & cmd->resp[0])
Wolfgang Mueesfdd858d2009-05-26 08:56:19 +0100350 value = -EIO; /* I/O error */
David Brownell15a05802007-08-08 09:12:54 -0700351 /* else R1_SPI_IDLE, "it's resetting" */
352 }
353
354 switch (mmc_spi_resp_type(cmd)) {
355
356 /* SPI R1B == R1 + busy; STOP_TRANSMISSION (for multiblock reads)
357 * and less-common stuff like various erase operations.
358 */
359 case MMC_RSP_SPI_R1B:
360 /* maybe we read all the busy tokens already */
361 while (cp < end && *cp == 0)
362 cp++;
363 if (cp == end)
364 mmc_spi_wait_unbusy(host, r1b_timeout);
365 break;
366
367 /* SPI R2 == R1 + second status byte; SEND_STATUS
368 * SPI R5 == R1 + data byte; IO_RW_DIRECT
369 */
370 case MMC_RSP_SPI_R2:
Wolfgang Mueesab5a6432009-04-08 09:48:58 +0100371 /* read the next byte */
372 if (cp == end) {
373 value = mmc_spi_readbytes(host, 1);
374 if (value < 0)
375 goto done;
376 cp = host->data->status;
377 end = cp+1;
378 }
379 if (bitshift) {
380 rotator = leftover << 8;
381 rotator |= *cp << bitshift;
382 cmd->resp[0] |= (rotator & 0xFF00);
383 } else {
384 cmd->resp[0] |= *cp << 8;
385 }
David Brownell15a05802007-08-08 09:12:54 -0700386 break;
387
388 /* SPI R3, R4, or R7 == R1 + 4 bytes */
389 case MMC_RSP_SPI_R3:
Wolfgang Mueesab5a6432009-04-08 09:48:58 +0100390 rotator = leftover << 8;
391 cmd->resp[1] = 0;
392 for (i = 0; i < 4; i++) {
393 cmd->resp[1] <<= 8;
394 /* read the next byte */
395 if (cp == end) {
396 value = mmc_spi_readbytes(host, 1);
397 if (value < 0)
398 goto done;
399 cp = host->data->status;
400 end = cp+1;
401 }
402 if (bitshift) {
403 rotator |= *cp++ << bitshift;
404 cmd->resp[1] |= (rotator >> 8);
405 rotator <<= 8;
406 } else {
407 cmd->resp[1] |= *cp++;
408 }
409 }
David Brownell15a05802007-08-08 09:12:54 -0700410 break;
411
412 /* SPI R1 == just one status byte */
413 case MMC_RSP_SPI_R1:
414 break;
415
416 default:
417 dev_dbg(&host->spi->dev, "bad response type %04x\n",
418 mmc_spi_resp_type(cmd));
419 if (value >= 0)
420 value = -EINVAL;
421 goto done;
422 }
423
424 if (value < 0)
425 dev_dbg(&host->spi->dev, "%s: resp %04x %08x\n",
426 tag, cmd->resp[0], cmd->resp[1]);
427
428 /* disable chipselect on errors and some success cases */
429 if (value >= 0 && cs_on)
430 return value;
431done:
432 if (value < 0)
433 cmd->error = value;
434 mmc_cs_off(host);
435 return value;
436}
437
438/* Issue command and read its response.
439 * Returns zero on success, negative for error.
440 *
441 * On error, caller must cope with mmc core retry mechanism. That
442 * means immediate low-level resubmit, which affects the bus lock...
443 */
444static int
445mmc_spi_command_send(struct mmc_spi_host *host,
446 struct mmc_request *mrq,
447 struct mmc_command *cmd, int cs_on)
448{
449 struct scratch *data = host->data;
450 u8 *cp = data->status;
David Brownell15a05802007-08-08 09:12:54 -0700451 int status;
452 struct spi_transfer *t;
453
454 /* We can handle most commands (except block reads) in one full
455 * duplex I/O operation before either starting the next transfer
456 * (data block or command) or else deselecting the card.
457 *
458 * First, write 7 bytes:
459 * - an all-ones byte to ensure the card is ready
460 * - opcode byte (plus start and transmission bits)
461 * - four bytes of big-endian argument
462 * - crc7 (plus end bit) ... always computed, it's cheap
463 *
464 * We init the whole buffer to all-ones, which is what we need
465 * to write while we're reading (later) response data.
466 */
George Spelvin9b60fa42014-05-11 06:05:02 -0400467 memset(cp, 0xff, sizeof(data->status));
David Brownell15a05802007-08-08 09:12:54 -0700468
George Spelvin9b60fa42014-05-11 06:05:02 -0400469 cp[1] = 0x40 | cmd->opcode;
470 put_unaligned_be32(cmd->arg, cp+2);
471 cp[6] = crc7_be(0, cp+1, 5) | 0x01;
472 cp += 7;
David Brownell15a05802007-08-08 09:12:54 -0700473
474 /* Then, read up to 13 bytes (while writing all-ones):
475 * - N(CR) (== 1..8) bytes of all-ones
476 * - status byte (for all response types)
477 * - the rest of the response, either:
478 * + nothing, for R1 or R1B responses
479 * + second status byte, for R2 responses
480 * + four data bytes, for R3 and R7 responses
481 *
482 * Finally, read some more bytes ... in the nice cases we know in
483 * advance how many, and reading 1 more is always OK:
484 * - N(EC) (== 0..N) bytes of all-ones, before deselect/finish
485 * - N(RC) (== 1..N) bytes of all-ones, before next command
486 * - N(WR) (== 1..N) bytes of all-ones, before data write
487 *
488 * So in those cases one full duplex I/O of at most 21 bytes will
489 * handle the whole command, leaving the card ready to receive a
490 * data block or new command. We do that whenever we can, shaving
491 * CPU and IRQ costs (especially when using DMA or FIFOs).
492 *
493 * There are two other cases, where it's not generally practical
494 * to rely on a single I/O:
495 *
496 * - R1B responses need at least N(EC) bytes of all-zeroes.
497 *
498 * In this case we can *try* to fit it into one I/O, then
499 * maybe read more data later.
500 *
501 * - Data block reads are more troublesome, since a variable
502 * number of padding bytes precede the token and data.
503 * + N(CX) (== 0..8) bytes of all-ones, before CSD or CID
504 * + N(AC) (== 1..many) bytes of all-ones
505 *
506 * In this case we currently only have minimal speedups here:
507 * when N(CR) == 1 we can avoid I/O in response_get().
508 */
509 if (cs_on && (mrq->data->flags & MMC_DATA_READ)) {
510 cp += 2; /* min(N(CR)) + status */
511 /* R1 */
512 } else {
513 cp += 10; /* max(N(CR)) + status + min(N(RC),N(WR)) */
514 if (cmd->flags & MMC_RSP_SPI_S2) /* R2/R5 */
515 cp++;
516 else if (cmd->flags & MMC_RSP_SPI_B4) /* R3/R4/R7 */
517 cp += 4;
518 else if (cmd->flags & MMC_RSP_BUSY) /* R1B */
519 cp = data->status + sizeof(data->status);
520 /* else: R1 (most commands) */
521 }
522
523 dev_dbg(&host->spi->dev, " mmc_spi: CMD%d, resp %s\n",
524 cmd->opcode, maptype(cmd));
525
526 /* send command, leaving chipselect active */
527 spi_message_init(&host->m);
528
529 t = &host->t;
530 memset(t, 0, sizeof(*t));
531 t->tx_buf = t->rx_buf = data->status;
532 t->tx_dma = t->rx_dma = host->data_dma;
533 t->len = cp - data->status;
534 t->cs_change = 1;
535 spi_message_add_tail(t, &host->m);
536
537 if (host->dma_dev) {
538 host->m.is_dma_mapped = 1;
539 dma_sync_single_for_device(host->dma_dev,
540 host->data_dma, sizeof(*host->data),
541 DMA_BIDIRECTIONAL);
542 }
Ernst Schwab4751c1c2010-02-18 12:47:46 +0100543 status = spi_sync_locked(host->spi, &host->m);
David Brownell15a05802007-08-08 09:12:54 -0700544
545 if (host->dma_dev)
546 dma_sync_single_for_cpu(host->dma_dev,
547 host->data_dma, sizeof(*host->data),
548 DMA_BIDIRECTIONAL);
549 if (status < 0) {
550 dev_dbg(&host->spi->dev, " ... write returned %d\n", status);
551 cmd->error = status;
552 return status;
553 }
554
555 /* after no-data commands and STOP_TRANSMISSION, chipselect off */
556 return mmc_spi_response_get(host, cmd, cs_on);
557}
558
559/* Build data message with up to four separate transfers. For TX, we
560 * start by writing the data token. And in most cases, we finish with
561 * a status transfer.
562 *
563 * We always provide TX data for data and CRC. The MMC/SD protocol
564 * requires us to write ones; but Linux defaults to writing zeroes;
565 * so we explicitly initialize it to all ones on RX paths.
566 *
567 * We also handle DMA mapping, so the underlying SPI controller does
568 * not need to (re)do it for each message.
569 */
570static void
571mmc_spi_setup_data_message(
572 struct mmc_spi_host *host,
573 int multiple,
574 enum dma_data_direction direction)
575{
576 struct spi_transfer *t;
577 struct scratch *scratch = host->data;
578 dma_addr_t dma = host->data_dma;
579
580 spi_message_init(&host->m);
581 if (dma)
582 host->m.is_dma_mapped = 1;
583
584 /* for reads, readblock() skips 0xff bytes before finding
585 * the token; for writes, this transfer issues that token.
586 */
587 if (direction == DMA_TO_DEVICE) {
588 t = &host->token;
589 memset(t, 0, sizeof(*t));
590 t->len = 1;
591 if (multiple)
592 scratch->data_token = SPI_TOKEN_MULTI_WRITE;
593 else
594 scratch->data_token = SPI_TOKEN_SINGLE;
595 t->tx_buf = &scratch->data_token;
596 if (dma)
597 t->tx_dma = dma + offsetof(struct scratch, data_token);
598 spi_message_add_tail(t, &host->m);
599 }
600
601 /* Body of transfer is buffer, then CRC ...
602 * either TX-only, or RX with TX-ones.
603 */
604 t = &host->t;
605 memset(t, 0, sizeof(*t));
606 t->tx_buf = host->ones;
607 t->tx_dma = host->ones_dma;
608 /* length and actual buffer info are written later */
609 spi_message_add_tail(t, &host->m);
610
611 t = &host->crc;
612 memset(t, 0, sizeof(*t));
613 t->len = 2;
614 if (direction == DMA_TO_DEVICE) {
615 /* the actual CRC may get written later */
616 t->tx_buf = &scratch->crc_val;
617 if (dma)
618 t->tx_dma = dma + offsetof(struct scratch, crc_val);
619 } else {
620 t->tx_buf = host->ones;
621 t->tx_dma = host->ones_dma;
622 t->rx_buf = &scratch->crc_val;
623 if (dma)
624 t->rx_dma = dma + offsetof(struct scratch, crc_val);
625 }
626 spi_message_add_tail(t, &host->m);
627
628 /*
629 * A single block read is followed by N(EC) [0+] all-ones bytes
630 * before deselect ... don't bother.
631 *
632 * Multiblock reads are followed by N(AC) [1+] all-ones bytes before
633 * the next block is read, or a STOP_TRANSMISSION is issued. We'll
634 * collect that single byte, so readblock() doesn't need to.
635 *
636 * For a write, the one-byte data response follows immediately, then
637 * come zero or more busy bytes, then N(WR) [1+] all-ones bytes.
638 * Then single block reads may deselect, and multiblock ones issue
639 * the next token (next data block, or STOP_TRAN). We can try to
640 * minimize I/O ops by using a single read to collect end-of-busy.
641 */
642 if (multiple || direction == DMA_TO_DEVICE) {
643 t = &host->early_status;
644 memset(t, 0, sizeof(*t));
645 t->len = (direction == DMA_TO_DEVICE)
646 ? sizeof(scratch->status)
647 : 1;
648 t->tx_buf = host->ones;
649 t->tx_dma = host->ones_dma;
650 t->rx_buf = scratch->status;
651 if (dma)
652 t->rx_dma = dma + offsetof(struct scratch, status);
653 t->cs_change = 1;
654 spi_message_add_tail(t, &host->m);
655 }
656}
657
658/*
659 * Write one block:
660 * - caller handled preceding N(WR) [1+] all-ones bytes
661 * - data block
662 * + token
663 * + data bytes
664 * + crc16
665 * - an all-ones byte ... card writes a data-response byte
666 * - followed by N(EC) [0+] all-ones bytes, card writes zero/'busy'
667 *
668 * Return negative errno, else success.
669 */
670static int
Matthew Fleming162350e2008-10-02 12:21:42 +0100671mmc_spi_writeblock(struct mmc_spi_host *host, struct spi_transfer *t,
Wolfgang Muees56e303e2009-04-07 15:26:30 +0100672 unsigned long timeout)
David Brownell15a05802007-08-08 09:12:54 -0700673{
674 struct spi_device *spi = host->spi;
675 int status, i;
676 struct scratch *scratch = host->data;
Wolfgang Mueesf079a8f2009-03-16 12:23:03 +0100677 u32 pattern;
David Brownell15a05802007-08-08 09:12:54 -0700678
679 if (host->mmc->use_spi_crc)
680 scratch->crc_val = cpu_to_be16(
681 crc_itu_t(0, t->tx_buf, t->len));
682 if (host->dma_dev)
683 dma_sync_single_for_device(host->dma_dev,
684 host->data_dma, sizeof(*scratch),
685 DMA_BIDIRECTIONAL);
686
Ernst Schwab4751c1c2010-02-18 12:47:46 +0100687 status = spi_sync_locked(spi, &host->m);
David Brownell15a05802007-08-08 09:12:54 -0700688
689 if (status != 0) {
690 dev_dbg(&spi->dev, "write error (%d)\n", status);
691 return status;
692 }
693
694 if (host->dma_dev)
695 dma_sync_single_for_cpu(host->dma_dev,
696 host->data_dma, sizeof(*scratch),
697 DMA_BIDIRECTIONAL);
698
699 /*
700 * Get the transmission data-response reply. It must follow
701 * immediately after the data block we transferred. This reply
702 * doesn't necessarily tell whether the write operation succeeded;
703 * it just says if the transmission was ok and whether *earlier*
704 * writes succeeded; see the standard.
Wolfgang Mueesf079a8f2009-03-16 12:23:03 +0100705 *
706 * In practice, there are (even modern SDHC-)cards which are late
707 * in sending the response, and miss the time frame by a few bits,
708 * so we have to cope with this situation and check the response
709 * bit-by-bit. Arggh!!!
David Brownell15a05802007-08-08 09:12:54 -0700710 */
George Spelvin9b60fa42014-05-11 06:05:02 -0400711 pattern = get_unaligned_be32(scratch->status);
Wolfgang Mueesf079a8f2009-03-16 12:23:03 +0100712
713 /* First 3 bit of pattern are undefined */
714 pattern |= 0xE0000000;
715
716 /* left-adjust to leading 0 bit */
717 while (pattern & 0x80000000)
718 pattern <<= 1;
719 /* right-adjust for pattern matching. Code is in bit 4..0 now. */
720 pattern >>= 27;
721
722 switch (pattern) {
David Brownell15a05802007-08-08 09:12:54 -0700723 case SPI_RESPONSE_ACCEPTED:
724 status = 0;
725 break;
726 case SPI_RESPONSE_CRC_ERR:
727 /* host shall then issue MMC_STOP_TRANSMISSION */
728 status = -EILSEQ;
729 break;
730 case SPI_RESPONSE_WRITE_ERR:
731 /* host shall then issue MMC_STOP_TRANSMISSION,
732 * and should MMC_SEND_STATUS to sort it out
733 */
734 status = -EIO;
735 break;
736 default:
737 status = -EPROTO;
738 break;
739 }
740 if (status != 0) {
741 dev_dbg(&spi->dev, "write error %02x (%d)\n",
742 scratch->status[0], status);
743 return status;
744 }
745
746 t->tx_buf += t->len;
747 if (host->dma_dev)
748 t->tx_dma += t->len;
749
750 /* Return when not busy. If we didn't collect that status yet,
751 * we'll need some more I/O.
752 */
Wolfgang Mueesf079a8f2009-03-16 12:23:03 +0100753 for (i = 4; i < sizeof(scratch->status); i++) {
754 /* card is non-busy if the most recent bit is 1 */
755 if (scratch->status[i] & 0x01)
David Brownell15a05802007-08-08 09:12:54 -0700756 return 0;
757 }
Matthew Fleming162350e2008-10-02 12:21:42 +0100758 return mmc_spi_wait_unbusy(host, timeout);
David Brownell15a05802007-08-08 09:12:54 -0700759}
760
761/*
762 * Read one block:
763 * - skip leading all-ones bytes ... either
764 * + N(AC) [1..f(clock,CSD)] usually, else
765 * + N(CX) [0..8] when reading CSD or CID
766 * - data block
767 * + token ... if error token, no data or crc
768 * + data bytes
769 * + crc16
770 *
771 * After single block reads, we're done; N(EC) [0+] all-ones bytes follow
772 * before dropping chipselect.
773 *
774 * For multiblock reads, caller either reads the next block or issues a
775 * STOP_TRANSMISSION command.
776 */
777static int
Matthew Fleming162350e2008-10-02 12:21:42 +0100778mmc_spi_readblock(struct mmc_spi_host *host, struct spi_transfer *t,
Wolfgang Muees56e303e2009-04-07 15:26:30 +0100779 unsigned long timeout)
David Brownell15a05802007-08-08 09:12:54 -0700780{
781 struct spi_device *spi = host->spi;
782 int status;
783 struct scratch *scratch = host->data;
Wolfgang Mueesab5a6432009-04-08 09:48:58 +0100784 unsigned int bitshift;
785 u8 leftover;
David Brownell15a05802007-08-08 09:12:54 -0700786
787 /* At least one SD card sends an all-zeroes byte when N(CX)
788 * applies, before the all-ones bytes ... just cope with that.
789 */
790 status = mmc_spi_readbytes(host, 1);
791 if (status < 0)
792 return status;
793 status = scratch->status[0];
794 if (status == 0xff || status == 0)
Matthew Fleming162350e2008-10-02 12:21:42 +0100795 status = mmc_spi_readtoken(host, timeout);
David Brownell15a05802007-08-08 09:12:54 -0700796
Wolfgang Mueesab5a6432009-04-08 09:48:58 +0100797 if (status < 0) {
David Brownell15a05802007-08-08 09:12:54 -0700798 dev_dbg(&spi->dev, "read error %02x (%d)\n", status, status);
Wolfgang Mueesab5a6432009-04-08 09:48:58 +0100799 return status;
800 }
David Brownell15a05802007-08-08 09:12:54 -0700801
Wolfgang Mueesab5a6432009-04-08 09:48:58 +0100802 /* The token may be bit-shifted...
803 * the first 0-bit precedes the data stream.
804 */
805 bitshift = 7;
806 while (status & 0x80) {
807 status <<= 1;
808 bitshift--;
809 }
810 leftover = status << 1;
David Brownell15a05802007-08-08 09:12:54 -0700811
Wolfgang Mueesab5a6432009-04-08 09:48:58 +0100812 if (host->dma_dev) {
813 dma_sync_single_for_device(host->dma_dev,
814 host->data_dma, sizeof(*scratch),
815 DMA_BIDIRECTIONAL);
816 dma_sync_single_for_device(host->dma_dev,
817 t->rx_dma, t->len,
818 DMA_FROM_DEVICE);
819 }
820
Ernst Schwab4751c1c2010-02-18 12:47:46 +0100821 status = spi_sync_locked(spi, &host->m);
Kangjie Lucb1962f2019-03-11 00:53:33 -0500822 if (status < 0) {
823 dev_dbg(&spi->dev, "read error %d\n", status);
824 return status;
825 }
Wolfgang Mueesab5a6432009-04-08 09:48:58 +0100826
827 if (host->dma_dev) {
828 dma_sync_single_for_cpu(host->dma_dev,
829 host->data_dma, sizeof(*scratch),
830 DMA_BIDIRECTIONAL);
831 dma_sync_single_for_cpu(host->dma_dev,
832 t->rx_dma, t->len,
833 DMA_FROM_DEVICE);
834 }
835
836 if (bitshift) {
837 /* Walk through the data and the crc and do
838 * all the magic to get byte-aligned data.
David Brownell15a05802007-08-08 09:12:54 -0700839 */
Wolfgang Mueesab5a6432009-04-08 09:48:58 +0100840 u8 *cp = t->rx_buf;
841 unsigned int len;
842 unsigned int bitright = 8 - bitshift;
843 u8 temp;
844 for (len = t->len; len; len--) {
845 temp = *cp;
846 *cp++ = leftover | (temp >> bitshift);
847 leftover = temp << bitright;
848 }
849 cp = (u8 *) &scratch->crc_val;
850 temp = *cp;
851 *cp++ = leftover | (temp >> bitshift);
852 leftover = temp << bitright;
853 temp = *cp;
854 *cp = leftover | (temp >> bitshift);
David Brownell15a05802007-08-08 09:12:54 -0700855 }
856
857 if (host->mmc->use_spi_crc) {
858 u16 crc = crc_itu_t(0, t->rx_buf, t->len);
859
860 be16_to_cpus(&scratch->crc_val);
861 if (scratch->crc_val != crc) {
862 dev_dbg(&spi->dev, "read - crc error: crc_val=0x%04x, "
863 "computed=0x%04x len=%d\n",
864 scratch->crc_val, crc, t->len);
865 return -EILSEQ;
866 }
867 }
868
869 t->rx_buf += t->len;
870 if (host->dma_dev)
871 t->rx_dma += t->len;
872
873 return 0;
874}
875
876/*
877 * An MMC/SD data stage includes one or more blocks, optional CRCs,
878 * and inline handshaking. That handhaking makes it unlike most
879 * other SPI protocol stacks.
880 */
881static void
882mmc_spi_data_do(struct mmc_spi_host *host, struct mmc_command *cmd,
883 struct mmc_data *data, u32 blk_size)
884{
885 struct spi_device *spi = host->spi;
886 struct device *dma_dev = host->dma_dev;
887 struct spi_transfer *t;
888 enum dma_data_direction direction;
889 struct scatterlist *sg;
890 unsigned n_sg;
891 int multiple = (data->blocks > 1);
Matthew Fleming162350e2008-10-02 12:21:42 +0100892 u32 clock_rate;
Wolfgang Muees56e303e2009-04-07 15:26:30 +0100893 unsigned long timeout;
David Brownell15a05802007-08-08 09:12:54 -0700894
895 if (data->flags & MMC_DATA_READ)
896 direction = DMA_FROM_DEVICE;
897 else
898 direction = DMA_TO_DEVICE;
899 mmc_spi_setup_data_message(host, multiple, direction);
900 t = &host->t;
901
Matthew Fleming162350e2008-10-02 12:21:42 +0100902 if (t->speed_hz)
903 clock_rate = t->speed_hz;
904 else
905 clock_rate = spi->max_speed_hz;
906
Wolfgang Muees56e303e2009-04-07 15:26:30 +0100907 timeout = data->timeout_ns +
908 data->timeout_clks * 1000000 / clock_rate;
909 timeout = usecs_to_jiffies((unsigned int)(timeout / 1000)) + 1;
Matthew Fleming162350e2008-10-02 12:21:42 +0100910
David Brownell15a05802007-08-08 09:12:54 -0700911 /* Handle scatterlist segments one at a time, with synch for
912 * each 512-byte block
913 */
914 for (sg = data->sg, n_sg = data->sg_len; n_sg; n_sg--, sg++) {
915 int status = 0;
916 dma_addr_t dma_addr = 0;
917 void *kmap_addr;
918 unsigned length = sg->length;
919 enum dma_data_direction dir = direction;
920
921 /* set up dma mapping for controller drivers that might
922 * use DMA ... though they may fall back to PIO
923 */
924 if (dma_dev) {
925 /* never invalidate whole *shared* pages ... */
926 if ((sg->offset != 0 || length != PAGE_SIZE)
927 && dir == DMA_FROM_DEVICE)
928 dir = DMA_BIDIRECTIONAL;
929
Jens Axboe45711f12007-10-22 21:19:53 +0200930 dma_addr = dma_map_page(dma_dev, sg_page(sg), 0,
David Brownell15a05802007-08-08 09:12:54 -0700931 PAGE_SIZE, dir);
Alexey Khoroshilovb0066312016-02-06 02:36:35 +0300932 if (dma_mapping_error(dma_dev, dma_addr)) {
933 data->error = -EFAULT;
934 break;
935 }
David Brownell15a05802007-08-08 09:12:54 -0700936 if (direction == DMA_TO_DEVICE)
937 t->tx_dma = dma_addr + sg->offset;
938 else
939 t->rx_dma = dma_addr + sg->offset;
940 }
941
942 /* allow pio too; we don't allow highmem */
Jens Axboe45711f12007-10-22 21:19:53 +0200943 kmap_addr = kmap(sg_page(sg));
David Brownell15a05802007-08-08 09:12:54 -0700944 if (direction == DMA_TO_DEVICE)
945 t->tx_buf = kmap_addr + sg->offset;
946 else
947 t->rx_buf = kmap_addr + sg->offset;
948
949 /* transfer each block, and update request status */
950 while (length) {
951 t->len = min(length, blk_size);
952
953 dev_dbg(&host->spi->dev,
954 " mmc_spi: %s block, %d bytes\n",
955 (direction == DMA_TO_DEVICE)
956 ? "write"
957 : "read",
958 t->len);
959
960 if (direction == DMA_TO_DEVICE)
Matthew Fleming162350e2008-10-02 12:21:42 +0100961 status = mmc_spi_writeblock(host, t, timeout);
David Brownell15a05802007-08-08 09:12:54 -0700962 else
Matthew Fleming162350e2008-10-02 12:21:42 +0100963 status = mmc_spi_readblock(host, t, timeout);
David Brownell15a05802007-08-08 09:12:54 -0700964 if (status < 0)
965 break;
966
967 data->bytes_xfered += t->len;
968 length -= t->len;
969
970 if (!multiple)
971 break;
972 }
973
974 /* discard mappings */
975 if (direction == DMA_FROM_DEVICE)
Jens Axboe45711f12007-10-22 21:19:53 +0200976 flush_kernel_dcache_page(sg_page(sg));
977 kunmap(sg_page(sg));
David Brownell15a05802007-08-08 09:12:54 -0700978 if (dma_dev)
979 dma_unmap_page(dma_dev, dma_addr, PAGE_SIZE, dir);
980
981 if (status < 0) {
982 data->error = status;
983 dev_dbg(&spi->dev, "%s status %d\n",
984 (direction == DMA_TO_DEVICE)
985 ? "write" : "read",
986 status);
987 break;
988 }
989 }
990
991 /* NOTE some docs describe an MMC-only SET_BLOCK_COUNT (CMD23) that
992 * can be issued before multiblock writes. Unlike its more widely
993 * documented analogue for SD cards (SET_WR_BLK_ERASE_COUNT, ACMD23),
994 * that can affect the STOP_TRAN logic. Complete (and current)
995 * MMC specs should sort that out before Linux starts using CMD23.
996 */
997 if (direction == DMA_TO_DEVICE && multiple) {
998 struct scratch *scratch = host->data;
999 int tmp;
1000 const unsigned statlen = sizeof(scratch->status);
1001
1002 dev_dbg(&spi->dev, " mmc_spi: STOP_TRAN\n");
1003
1004 /* Tweak the per-block message we set up earlier by morphing
1005 * it to hold single buffer with the token followed by some
1006 * all-ones bytes ... skip N(BR) (0..1), scan the rest for
1007 * "not busy any longer" status, and leave chip selected.
1008 */
1009 INIT_LIST_HEAD(&host->m.transfers);
1010 list_add(&host->early_status.transfer_list,
1011 &host->m.transfers);
1012
1013 memset(scratch->status, 0xff, statlen);
1014 scratch->status[0] = SPI_TOKEN_STOP_TRAN;
1015
1016 host->early_status.tx_buf = host->early_status.rx_buf;
1017 host->early_status.tx_dma = host->early_status.rx_dma;
1018 host->early_status.len = statlen;
1019
1020 if (host->dma_dev)
1021 dma_sync_single_for_device(host->dma_dev,
1022 host->data_dma, sizeof(*scratch),
1023 DMA_BIDIRECTIONAL);
1024
Ernst Schwab4751c1c2010-02-18 12:47:46 +01001025 tmp = spi_sync_locked(spi, &host->m);
David Brownell15a05802007-08-08 09:12:54 -07001026
1027 if (host->dma_dev)
1028 dma_sync_single_for_cpu(host->dma_dev,
1029 host->data_dma, sizeof(*scratch),
1030 DMA_BIDIRECTIONAL);
1031
1032 if (tmp < 0) {
1033 if (!data->error)
1034 data->error = tmp;
1035 return;
1036 }
1037
1038 /* Ideally we collected "not busy" status with one I/O,
1039 * avoiding wasteful byte-at-a-time scanning... but more
1040 * I/O is often needed.
1041 */
1042 for (tmp = 2; tmp < statlen; tmp++) {
1043 if (scratch->status[tmp] != 0)
1044 return;
1045 }
Matthew Fleming162350e2008-10-02 12:21:42 +01001046 tmp = mmc_spi_wait_unbusy(host, timeout);
David Brownell15a05802007-08-08 09:12:54 -07001047 if (tmp < 0 && !data->error)
1048 data->error = tmp;
1049 }
1050}
1051
1052/****************************************************************************/
1053
1054/*
1055 * MMC driver implementation -- the interface to the MMC stack
1056 */
1057
1058static void mmc_spi_request(struct mmc_host *mmc, struct mmc_request *mrq)
1059{
1060 struct mmc_spi_host *host = mmc_priv(mmc);
1061 int status = -EINVAL;
Sonic Zhang061c6c82010-07-12 15:50:56 +08001062 int crc_retry = 5;
1063 struct mmc_command stop;
David Brownell15a05802007-08-08 09:12:54 -07001064
1065#ifdef DEBUG
1066 /* MMC core and layered drivers *MUST* issue SPI-aware commands */
1067 {
1068 struct mmc_command *cmd;
1069 int invalid = 0;
1070
1071 cmd = mrq->cmd;
1072 if (!mmc_spi_resp_type(cmd)) {
1073 dev_dbg(&host->spi->dev, "bogus command\n");
1074 cmd->error = -EINVAL;
1075 invalid = 1;
1076 }
1077
1078 cmd = mrq->stop;
1079 if (cmd && !mmc_spi_resp_type(cmd)) {
1080 dev_dbg(&host->spi->dev, "bogus STOP command\n");
1081 cmd->error = -EINVAL;
1082 invalid = 1;
1083 }
1084
1085 if (invalid) {
1086 dump_stack();
1087 mmc_request_done(host->mmc, mrq);
1088 return;
1089 }
1090 }
1091#endif
1092
Ernst Schwab4751c1c2010-02-18 12:47:46 +01001093 /* request exclusive bus access */
1094 spi_bus_lock(host->spi->master);
1095
Sonic Zhang061c6c82010-07-12 15:50:56 +08001096crc_recover:
David Brownell15a05802007-08-08 09:12:54 -07001097 /* issue command; then optionally data and stop */
1098 status = mmc_spi_command_send(host, mrq, mrq->cmd, mrq->data != NULL);
1099 if (status == 0 && mrq->data) {
1100 mmc_spi_data_do(host, mrq->cmd, mrq->data, mrq->data->blksz);
Sonic Zhang061c6c82010-07-12 15:50:56 +08001101
1102 /*
1103 * The SPI bus is not always reliable for large data transfers.
1104 * If an occasional crc error is reported by the SD device with
1105 * data read/write over SPI, it may be recovered by repeating
1106 * the last SD command again. The retry count is set to 5 to
1107 * ensure the driver passes stress tests.
1108 */
1109 if (mrq->data->error == -EILSEQ && crc_retry) {
1110 stop.opcode = MMC_STOP_TRANSMISSION;
1111 stop.arg = 0;
1112 stop.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
1113 status = mmc_spi_command_send(host, mrq, &stop, 0);
1114 crc_retry--;
1115 mrq->data->error = 0;
1116 goto crc_recover;
1117 }
1118
David Brownell15a05802007-08-08 09:12:54 -07001119 if (mrq->stop)
1120 status = mmc_spi_command_send(host, mrq, mrq->stop, 0);
1121 else
1122 mmc_cs_off(host);
1123 }
1124
Ernst Schwab4751c1c2010-02-18 12:47:46 +01001125 /* release the bus */
1126 spi_bus_unlock(host->spi->master);
1127
David Brownell15a05802007-08-08 09:12:54 -07001128 mmc_request_done(host->mmc, mrq);
1129}
1130
1131/* See Section 6.4.1, in SD "Simplified Physical Layer Specification 2.0"
1132 *
1133 * NOTE that here we can't know that the card has just been powered up;
1134 * not all MMC/SD sockets support power switching.
1135 *
1136 * FIXME when the card is still in SPI mode, e.g. from a previous kernel,
1137 * this doesn't seem to do the right thing at all...
1138 */
1139static void mmc_spi_initsequence(struct mmc_spi_host *host)
1140{
1141 /* Try to be very sure any previous command has completed;
1142 * wait till not-busy, skip debris from any old commands.
1143 */
1144 mmc_spi_wait_unbusy(host, r1b_timeout);
1145 mmc_spi_readbytes(host, 10);
1146
1147 /*
1148 * Do a burst with chipselect active-high. We need to do this to
1149 * meet the requirement of 74 clock cycles with both chipselect
1150 * and CMD (MOSI) high before CMD0 ... after the card has been
1151 * powered up to Vdd(min), and so is ready to take commands.
1152 *
1153 * Some cards are particularly needy of this (e.g. Viking "SD256")
1154 * while most others don't seem to care.
1155 *
1156 * Note that this is one of the places MMC/SD plays games with the
1157 * SPI protocol. Another is that when chipselect is released while
1158 * the card returns BUSY status, the clock must issue several cycles
1159 * with chipselect high before the card will stop driving its output.
Linus Walleij0e2837c2019-12-04 16:27:49 +01001160 *
1161 * SPI_CS_HIGH means "asserted" here. In some cases like when using
1162 * GPIOs for chip select, SPI_CS_HIGH is set but this will be logically
1163 * inverted by gpiolib, so if we want to ascertain to drive it high
1164 * we should toggle the default with an XOR as we do here.
David Brownell15a05802007-08-08 09:12:54 -07001165 */
Linus Walleij0e2837c2019-12-04 16:27:49 +01001166 host->spi->mode ^= SPI_CS_HIGH;
David Brownell15a05802007-08-08 09:12:54 -07001167 if (spi_setup(host->spi) != 0) {
1168 /* Just warn; most cards work without it. */
1169 dev_warn(&host->spi->dev,
1170 "can't change chip-select polarity\n");
Linus Walleij0e2837c2019-12-04 16:27:49 +01001171 host->spi->mode ^= SPI_CS_HIGH;
David Brownell15a05802007-08-08 09:12:54 -07001172 } else {
1173 mmc_spi_readbytes(host, 18);
1174
Linus Walleij0e2837c2019-12-04 16:27:49 +01001175 host->spi->mode ^= SPI_CS_HIGH;
David Brownell15a05802007-08-08 09:12:54 -07001176 if (spi_setup(host->spi) != 0) {
1177 /* Wot, we can't get the same setup we had before? */
1178 dev_err(&host->spi->dev,
1179 "can't restore chip-select polarity\n");
1180 }
1181 }
1182}
1183
1184static char *mmc_powerstring(u8 power_mode)
1185{
1186 switch (power_mode) {
1187 case MMC_POWER_OFF: return "off";
1188 case MMC_POWER_UP: return "up";
1189 case MMC_POWER_ON: return "on";
1190 }
1191 return "?";
1192}
1193
1194static void mmc_spi_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
1195{
1196 struct mmc_spi_host *host = mmc_priv(mmc);
1197
1198 if (host->power_mode != ios->power_mode) {
1199 int canpower;
1200
1201 canpower = host->pdata && host->pdata->setpower;
1202
1203 dev_dbg(&host->spi->dev, "mmc_spi: power %s (%d)%s\n",
1204 mmc_powerstring(ios->power_mode),
1205 ios->vdd,
1206 canpower ? ", can switch" : "");
1207
1208 /* switch power on/off if possible, accounting for
1209 * max 250msec powerup time if needed.
1210 */
1211 if (canpower) {
1212 switch (ios->power_mode) {
1213 case MMC_POWER_OFF:
1214 case MMC_POWER_UP:
1215 host->pdata->setpower(&host->spi->dev,
1216 ios->vdd);
1217 if (ios->power_mode == MMC_POWER_UP)
1218 msleep(host->powerup_msecs);
1219 }
1220 }
1221
1222 /* See 6.4.1 in the simplified SD card physical spec 2.0 */
1223 if (ios->power_mode == MMC_POWER_ON)
1224 mmc_spi_initsequence(host);
1225
1226 /* If powering down, ground all card inputs to avoid power
1227 * delivery from data lines! On a shared SPI bus, this
1228 * will probably be temporary; 6.4.2 of the simplified SD
1229 * spec says this must last at least 1msec.
1230 *
1231 * - Clock low means CPOL 0, e.g. mode 0
1232 * - MOSI low comes from writing zero
1233 * - Chipselect is usually active low...
1234 */
1235 if (canpower && ios->power_mode == MMC_POWER_OFF) {
1236 int mres;
Jan Nikitenko1685a032008-07-24 01:27:07 +02001237 u8 nullbyte = 0;
David Brownell15a05802007-08-08 09:12:54 -07001238
1239 host->spi->mode &= ~(SPI_CPOL|SPI_CPHA);
1240 mres = spi_setup(host->spi);
1241 if (mres < 0)
1242 dev_dbg(&host->spi->dev,
1243 "switch to SPI mode 0 failed\n");
1244
Jan Nikitenko1685a032008-07-24 01:27:07 +02001245 if (spi_write(host->spi, &nullbyte, 1) < 0)
David Brownell15a05802007-08-08 09:12:54 -07001246 dev_dbg(&host->spi->dev,
1247 "put spi signals to low failed\n");
1248
1249 /*
1250 * Now clock should be low due to spi mode 0;
1251 * MOSI should be low because of written 0x00;
1252 * chipselect should be low (it is active low)
1253 * power supply is off, so now MMC is off too!
1254 *
1255 * FIXME no, chipselect can be high since the
1256 * device is inactive and SPI_CS_HIGH is clear...
1257 */
1258 msleep(10);
1259 if (mres == 0) {
1260 host->spi->mode |= (SPI_CPOL|SPI_CPHA);
1261 mres = spi_setup(host->spi);
1262 if (mres < 0)
1263 dev_dbg(&host->spi->dev,
1264 "switch back to SPI mode 3"
1265 " failed\n");
1266 }
1267 }
1268
1269 host->power_mode = ios->power_mode;
1270 }
1271
1272 if (host->spi->max_speed_hz != ios->clock && ios->clock != 0) {
1273 int status;
1274
1275 host->spi->max_speed_hz = ios->clock;
1276 status = spi_setup(host->spi);
1277 dev_dbg(&host->spi->dev,
1278 "mmc_spi: clock to %d Hz, %d\n",
1279 host->spi->max_speed_hz, status);
1280 }
1281}
1282
David Brownell15a05802007-08-08 09:12:54 -07001283static const struct mmc_host_ops mmc_spi_ops = {
1284 .request = mmc_spi_request,
1285 .set_ios = mmc_spi_set_ios,
Laurent Pinchart62b6af52013-08-08 12:38:38 +02001286 .get_ro = mmc_gpio_get_ro,
1287 .get_cd = mmc_gpio_get_cd,
David Brownell15a05802007-08-08 09:12:54 -07001288};
1289
1290
1291/****************************************************************************/
1292
1293/*
1294 * SPI driver implementation
1295 */
1296
1297static irqreturn_t
1298mmc_spi_detect_irq(int irq, void *mmc)
1299{
1300 struct mmc_spi_host *host = mmc_priv(mmc);
1301 u16 delay_msec = max(host->pdata->detect_delay, (u16)100);
1302
1303 mmc_detect_change(mmc, msecs_to_jiffies(delay_msec));
1304 return IRQ_HANDLED;
1305}
1306
1307static int mmc_spi_probe(struct spi_device *spi)
1308{
1309 void *ones;
1310 struct mmc_host *mmc;
1311 struct mmc_spi_host *host;
1312 int status;
Laurent Pinchartbf287a92013-08-08 12:38:32 +02001313 bool has_ro = false;
David Brownell15a05802007-08-08 09:12:54 -07001314
David Brownell70d60272009-06-30 11:41:27 -07001315 /* We rely on full duplex transfers, mostly to reduce
1316 * per-transfer overheads (by making fewer transfers).
1317 */
1318 if (spi->master->flags & SPI_MASTER_HALF_DUPLEX)
1319 return -EINVAL;
1320
David Brownell15a05802007-08-08 09:12:54 -07001321 /* MMC and SD specs only seem to care that sampling is on the
1322 * rising edge ... meaning SPI modes 0 or 3. So either SPI mode
Wolfgang Muees48881ca2009-03-11 14:13:15 +01001323 * should be legit. We'll use mode 0 since the steady state is 0,
1324 * which is appropriate for hotplugging, unless the platform data
1325 * specify mode 3 (if hardware is not compatible to mode 0).
David Brownell15a05802007-08-08 09:12:54 -07001326 */
Wolfgang Muees48881ca2009-03-11 14:13:15 +01001327 if (spi->mode != SPI_MODE_3)
1328 spi->mode = SPI_MODE_0;
David Brownell15a05802007-08-08 09:12:54 -07001329 spi->bits_per_word = 8;
1330
1331 status = spi_setup(spi);
1332 if (status < 0) {
1333 dev_dbg(&spi->dev, "needs SPI mode %02x, %d KHz; %d\n",
1334 spi->mode, spi->max_speed_hz / 1000,
1335 status);
1336 return status;
1337 }
1338
David Brownell15a05802007-08-08 09:12:54 -07001339 /* We need a supply of ones to transmit. This is the only time
1340 * the CPU touches these, so cache coherency isn't a concern.
1341 *
1342 * NOTE if many systems use more than one MMC-over-SPI connector
1343 * it'd save some memory to share this. That's evidently rare.
1344 */
1345 status = -ENOMEM;
1346 ones = kmalloc(MMC_SPI_BLOCKSIZE, GFP_KERNEL);
1347 if (!ones)
1348 goto nomem;
1349 memset(ones, 0xff, MMC_SPI_BLOCKSIZE);
1350
1351 mmc = mmc_alloc_host(sizeof(*host), &spi->dev);
1352 if (!mmc)
1353 goto nomem;
1354
1355 mmc->ops = &mmc_spi_ops;
1356 mmc->max_blk_size = MMC_SPI_BLOCKSIZE;
Martin K. Petersena36274e2010-09-10 01:33:59 -04001357 mmc->max_segs = MMC_SPI_BLOCKSATONCE;
Wolfgang Muees5cf20aa2009-04-08 10:14:07 +01001358 mmc->max_req_size = MMC_SPI_BLOCKSATONCE * MMC_SPI_BLOCKSIZE;
1359 mmc->max_blk_count = MMC_SPI_BLOCKSATONCE;
David Brownell15a05802007-08-08 09:12:54 -07001360
Pierre Ossman23af6032008-07-06 01:10:27 +02001361 mmc->caps = MMC_CAP_SPI;
David Brownell15a05802007-08-08 09:12:54 -07001362
1363 /* SPI doesn't need the lowspeed device identification thing for
1364 * MMC or SD cards, since it never comes up in open drain mode.
1365 * That's good; some SPI masters can't handle very low speeds!
1366 *
1367 * However, low speed SDIO cards need not handle over 400 KHz;
1368 * that's the only reason not to use a few MHz for f_min (until
1369 * the upper layer reads the target frequency from the CSD).
1370 */
1371 mmc->f_min = 400000;
1372 mmc->f_max = spi->max_speed_hz;
1373
1374 host = mmc_priv(mmc);
1375 host->mmc = mmc;
1376 host->spi = spi;
1377
1378 host->ones = ones;
1379
1380 /* Platform data is used to hook up things like card sensing
1381 * and power switching gpios.
1382 */
Anton Vorontsov9c43df52008-12-30 18:15:28 +03001383 host->pdata = mmc_spi_get_pdata(spi);
David Brownell15a05802007-08-08 09:12:54 -07001384 if (host->pdata)
1385 mmc->ocr_avail = host->pdata->ocr_mask;
1386 if (!mmc->ocr_avail) {
1387 dev_warn(&spi->dev, "ASSUMING 3.2-3.4 V slot power\n");
1388 mmc->ocr_avail = MMC_VDD_32_33|MMC_VDD_33_34;
1389 }
1390 if (host->pdata && host->pdata->setpower) {
1391 host->powerup_msecs = host->pdata->powerup_msecs;
1392 if (!host->powerup_msecs || host->powerup_msecs > 250)
1393 host->powerup_msecs = 250;
1394 }
1395
1396 dev_set_drvdata(&spi->dev, mmc);
1397
1398 /* preallocate dma buffers */
1399 host->data = kmalloc(sizeof(*host->data), GFP_KERNEL);
1400 if (!host->data)
1401 goto fail_nobuf1;
1402
Tony Jones49dce682007-10-16 01:27:48 -07001403 if (spi->master->dev.parent->dma_mask) {
1404 struct device *dev = spi->master->dev.parent;
David Brownell15a05802007-08-08 09:12:54 -07001405
1406 host->dma_dev = dev;
1407 host->ones_dma = dma_map_single(dev, ones,
1408 MMC_SPI_BLOCKSIZE, DMA_TO_DEVICE);
Alexey Khoroshilovb0066312016-02-06 02:36:35 +03001409 if (dma_mapping_error(dev, host->ones_dma))
1410 goto fail_ones_dma;
David Brownell15a05802007-08-08 09:12:54 -07001411 host->data_dma = dma_map_single(dev, host->data,
1412 sizeof(*host->data), DMA_BIDIRECTIONAL);
Alexey Khoroshilovb0066312016-02-06 02:36:35 +03001413 if (dma_mapping_error(dev, host->data_dma))
1414 goto fail_data_dma;
David Brownell15a05802007-08-08 09:12:54 -07001415
1416 dma_sync_single_for_cpu(host->dma_dev,
1417 host->data_dma, sizeof(*host->data),
1418 DMA_BIDIRECTIONAL);
1419 }
1420
1421 /* setup message for status/busy readback */
1422 spi_message_init(&host->readback);
1423 host->readback.is_dma_mapped = (host->dma_dev != NULL);
1424
1425 spi_message_add_tail(&host->status, &host->readback);
1426 host->status.tx_buf = host->ones;
1427 host->status.tx_dma = host->ones_dma;
1428 host->status.rx_buf = &host->data->status;
1429 host->status.rx_dma = host->data_dma + offsetof(struct scratch, status);
1430 host->status.cs_change = 1;
1431
1432 /* register card detect irq */
1433 if (host->pdata && host->pdata->init) {
1434 status = host->pdata->init(&spi->dev, mmc_spi_detect_irq, mmc);
1435 if (status != 0)
1436 goto fail_glue_init;
1437 }
1438
Anton Vorontsov619ef4b2008-06-17 18:17:21 +04001439 /* pass platform capabilities, if any */
Laurent Pinchartbf287a92013-08-08 12:38:32 +02001440 if (host->pdata) {
Anton Vorontsov619ef4b2008-06-17 18:17:21 +04001441 mmc->caps |= host->pdata->caps;
Laurent Pinchartbf287a92013-08-08 12:38:32 +02001442 mmc->caps2 |= host->pdata->caps2;
1443 }
Anton Vorontsov619ef4b2008-06-17 18:17:21 +04001444
David Brownell15a05802007-08-08 09:12:54 -07001445 status = mmc_add_host(mmc);
1446 if (status != 0)
1447 goto fail_add_host;
1448
Laurent Pinchartbf287a92013-08-08 12:38:32 +02001449 if (host->pdata && host->pdata->flags & MMC_SPI_USE_CD_GPIO) {
1450 status = mmc_gpio_request_cd(mmc, host->pdata->cd_gpio,
1451 host->pdata->cd_debounce);
1452 if (status != 0)
1453 goto fail_add_host;
Magnus Dammbcdc9f22016-02-16 13:06:41 +09001454
1455 /* The platform has a CD GPIO signal that may support
1456 * interrupts, so let mmc_gpiod_request_cd_irq() decide
1457 * if polling is needed or not.
1458 */
1459 mmc->caps &= ~MMC_CAP_NEEDS_POLL;
Stephen Warrend4d11442014-09-22 09:57:42 -06001460 mmc_gpiod_request_cd_irq(mmc);
Laurent Pinchartbf287a92013-08-08 12:38:32 +02001461 }
Jonathan Neuschäferb97476e2019-02-10 18:31:07 +01001462 mmc_detect_change(mmc, 0);
Laurent Pinchartbf287a92013-08-08 12:38:32 +02001463
1464 if (host->pdata && host->pdata->flags & MMC_SPI_USE_RO_GPIO) {
1465 has_ro = true;
1466 status = mmc_gpio_request_ro(mmc, host->pdata->ro_gpio);
1467 if (status != 0)
1468 goto fail_add_host;
1469 }
1470
Anton Vorontsov619ef4b2008-06-17 18:17:21 +04001471 dev_info(&spi->dev, "SD/MMC host %s%s%s%s%s\n",
Kay Sieversd1b26862008-11-08 21:37:46 +01001472 dev_name(&mmc->class_dev),
David Brownell15a05802007-08-08 09:12:54 -07001473 host->dma_dev ? "" : ", no DMA",
Laurent Pinchartbf287a92013-08-08 12:38:32 +02001474 has_ro ? "" : ", no WP",
David Brownell15a05802007-08-08 09:12:54 -07001475 (host->pdata && host->pdata->setpower)
Anton Vorontsov619ef4b2008-06-17 18:17:21 +04001476 ? "" : ", no poweroff",
1477 (mmc->caps & MMC_CAP_NEEDS_POLL)
1478 ? ", cd polling" : "");
David Brownell15a05802007-08-08 09:12:54 -07001479 return 0;
1480
1481fail_add_host:
1482 mmc_remove_host (mmc);
1483fail_glue_init:
1484 if (host->dma_dev)
1485 dma_unmap_single(host->dma_dev, host->data_dma,
1486 sizeof(*host->data), DMA_BIDIRECTIONAL);
Alexey Khoroshilovb0066312016-02-06 02:36:35 +03001487fail_data_dma:
1488 if (host->dma_dev)
1489 dma_unmap_single(host->dma_dev, host->ones_dma,
1490 MMC_SPI_BLOCKSIZE, DMA_TO_DEVICE);
1491fail_ones_dma:
David Brownell15a05802007-08-08 09:12:54 -07001492 kfree(host->data);
1493
1494fail_nobuf1:
1495 mmc_free_host(mmc);
Anton Vorontsov9c43df52008-12-30 18:15:28 +03001496 mmc_spi_put_pdata(spi);
David Brownell15a05802007-08-08 09:12:54 -07001497 dev_set_drvdata(&spi->dev, NULL);
1498
1499nomem:
1500 kfree(ones);
1501 return status;
1502}
1503
1504
Bill Pemberton6e0ee712012-11-19 13:26:03 -05001505static int mmc_spi_remove(struct spi_device *spi)
David Brownell15a05802007-08-08 09:12:54 -07001506{
1507 struct mmc_host *mmc = dev_get_drvdata(&spi->dev);
1508 struct mmc_spi_host *host;
1509
1510 if (mmc) {
1511 host = mmc_priv(mmc);
1512
1513 /* prevent new mmc_detect_change() calls */
1514 if (host->pdata && host->pdata->exit)
1515 host->pdata->exit(&spi->dev, mmc);
1516
1517 mmc_remove_host(mmc);
1518
1519 if (host->dma_dev) {
1520 dma_unmap_single(host->dma_dev, host->ones_dma,
1521 MMC_SPI_BLOCKSIZE, DMA_TO_DEVICE);
1522 dma_unmap_single(host->dma_dev, host->data_dma,
1523 sizeof(*host->data), DMA_BIDIRECTIONAL);
1524 }
1525
1526 kfree(host->data);
1527 kfree(host->ones);
1528
1529 spi->max_speed_hz = mmc->f_max;
1530 mmc_free_host(mmc);
Anton Vorontsov9c43df52008-12-30 18:15:28 +03001531 mmc_spi_put_pdata(spi);
David Brownell15a05802007-08-08 09:12:54 -07001532 dev_set_drvdata(&spi->dev, NULL);
1533 }
1534 return 0;
1535}
1536
Fabian Frederick2530fd72015-03-16 20:59:07 +01001537static const struct of_device_id mmc_spi_of_match_table[] = {
Grant Likely2ffe8c52010-06-08 07:48:19 -06001538 { .compatible = "mmc-spi-slot", },
Anton Vorontsovfbe0f832010-08-08 18:14:22 +04001539 {},
Grant Likely2ffe8c52010-06-08 07:48:19 -06001540};
Javier Martinez Canillasbf7241d2015-09-16 11:12:07 +02001541MODULE_DEVICE_TABLE(of, mmc_spi_of_match_table);
David Brownell15a05802007-08-08 09:12:54 -07001542
1543static struct spi_driver mmc_spi_driver = {
1544 .driver = {
1545 .name = "mmc_spi",
Grant Likely2ffe8c52010-06-08 07:48:19 -06001546 .of_match_table = mmc_spi_of_match_table,
David Brownell15a05802007-08-08 09:12:54 -07001547 },
1548 .probe = mmc_spi_probe,
Bill Pemberton0433c142012-11-19 13:20:26 -05001549 .remove = mmc_spi_remove,
David Brownell15a05802007-08-08 09:12:54 -07001550};
1551
Sachin Kamat6f478822012-08-27 11:53:42 +05301552module_spi_driver(mmc_spi_driver);
David Brownell15a05802007-08-08 09:12:54 -07001553
1554MODULE_AUTHOR("Mike Lavender, David Brownell, "
1555 "Hans-Peter Nilsson, Jan Nikitenko");
1556MODULE_DESCRIPTION("SPI SD/MMC host driver");
1557MODULE_LICENSE("GPL");
Anton Vorontsove0626e32009-09-22 16:46:08 -07001558MODULE_ALIAS("spi:mmc_spi");