pxamci: add regulator support.
[linux-2.6] / drivers / mmc / host / mmc_spi.c
1 /*
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  */
27 #include <linux/sched.h>
28 #include <linux/delay.h>
29 #include <linux/bio.h>
30 #include <linux/dma-mapping.h>
31 #include <linux/crc7.h>
32 #include <linux/crc-itu-t.h>
33 #include <linux/scatterlist.h>
34
35 #include <linux/mmc/host.h>
36 #include <linux/mmc/mmc.h>              /* for R1_SPI_* bit values */
37
38 #include <linux/spi/spi.h>
39 #include <linux/spi/mmc_spi.h>
40
41 #include <asm/unaligned.h>
42
43
44 /* NOTES:
45  *
46  * - For now, we won't try to interoperate with a real mmc/sd/sdio
47  *   controller, although some of them do have hardware support for
48  *   SPI protocol.  The main reason for such configs would be mmc-ish
49  *   cards like DataFlash, which don't support that "native" protocol.
50  *
51  *   We don't have a "DataFlash/MMC/SD/SDIO card slot" abstraction to
52  *   switch between driver stacks, and in any case if "native" mode
53  *   is available, it will be faster and hence preferable.
54  *
55  * - MMC depends on a different chipselect management policy than the
56  *   SPI interface currently supports for shared bus segments:  it needs
57  *   to issue multiple spi_message requests with the chipselect active,
58  *   using the results of one message to decide the next one to issue.
59  *
60  *   Pending updates to the programming interface, this driver expects
61  *   that it not share the bus with other drivers (precluding conflicts).
62  *
63  * - We tell the controller to keep the chipselect active from the
64  *   beginning of an mmc_host_ops.request until the end.  So beware
65  *   of SPI controller drivers that mis-handle the cs_change flag!
66  *
67  *   However, many cards seem OK with chipselect flapping up/down
68  *   during that time ... at least on unshared bus segments.
69  */
70
71
72 /*
73  * Local protocol constants, internal to data block protocols.
74  */
75
76 /* Response tokens used to ack each block written: */
77 #define SPI_MMC_RESPONSE_CODE(x)        ((x) & 0x1f)
78 #define SPI_RESPONSE_ACCEPTED           ((2 << 1)|1)
79 #define SPI_RESPONSE_CRC_ERR            ((5 << 1)|1)
80 #define SPI_RESPONSE_WRITE_ERR          ((6 << 1)|1)
81
82 /* Read and write blocks start with these tokens and end with crc;
83  * on error, read tokens act like a subset of R2_SPI_* values.
84  */
85 #define SPI_TOKEN_SINGLE        0xfe    /* single block r/w, multiblock read */
86 #define SPI_TOKEN_MULTI_WRITE   0xfc    /* multiblock write */
87 #define SPI_TOKEN_STOP_TRAN     0xfd    /* terminate multiblock write */
88
89 #define MMC_SPI_BLOCKSIZE       512
90
91
92 /* These fixed timeouts come from the latest SD specs, which say to ignore
93  * the CSD values.  The R1B value is for card erase (e.g. the "I forgot the
94  * card's password" scenario); it's mostly applied to STOP_TRANSMISSION after
95  * reads which takes nowhere near that long.  Older cards may be able to use
96  * shorter timeouts ... but why bother?
97  */
98 #define r1b_timeout             (HZ * 3)
99
100 /* One of the critical speed parameters is the amount of data which may
101  * be transfered in one command. If this value is too low, the SD card
102  * controller has to do multiple partial block writes (argggh!). With
103  * today (2008) SD cards there is little speed gain if we transfer more
104  * than 64 KBytes at a time. So use this value until there is any indication
105  * that we should do more here.
106  */
107 #define MMC_SPI_BLOCKSATONCE    128
108
109 /****************************************************************************/
110
111 /*
112  * Local Data Structures
113  */
114
115 /* "scratch" is per-{command,block} data exchanged with the card */
116 struct scratch {
117         u8                      status[29];
118         u8                      data_token;
119         __be16                  crc_val;
120 };
121
122 struct mmc_spi_host {
123         struct mmc_host         *mmc;
124         struct spi_device       *spi;
125
126         unsigned char           power_mode;
127         u16                     powerup_msecs;
128
129         struct mmc_spi_platform_data    *pdata;
130
131         /* for bulk data transfers */
132         struct spi_transfer     token, t, crc, early_status;
133         struct spi_message      m;
134
135         /* for status readback */
136         struct spi_transfer     status;
137         struct spi_message      readback;
138
139         /* underlying DMA-aware controller, or null */
140         struct device           *dma_dev;
141
142         /* buffer used for commands and for message "overhead" */
143         struct scratch          *data;
144         dma_addr_t              data_dma;
145
146         /* Specs say to write ones most of the time, even when the card
147          * has no need to read its input data; and many cards won't care.
148          * This is our source of those ones.
149          */
150         void                    *ones;
151         dma_addr_t              ones_dma;
152 };
153
154
155 /****************************************************************************/
156
157 /*
158  * MMC-over-SPI protocol glue, used by the MMC stack interface
159  */
160
161 static inline int mmc_cs_off(struct mmc_spi_host *host)
162 {
163         /* chipselect will always be inactive after setup() */
164         return spi_setup(host->spi);
165 }
166
167 static int
168 mmc_spi_readbytes(struct mmc_spi_host *host, unsigned len)
169 {
170         int status;
171
172         if (len > sizeof(*host->data)) {
173                 WARN_ON(1);
174                 return -EIO;
175         }
176
177         host->status.len = len;
178
179         if (host->dma_dev)
180                 dma_sync_single_for_device(host->dma_dev,
181                                 host->data_dma, sizeof(*host->data),
182                                 DMA_FROM_DEVICE);
183
184         status = spi_sync(host->spi, &host->readback);
185
186         if (host->dma_dev)
187                 dma_sync_single_for_cpu(host->dma_dev,
188                                 host->data_dma, sizeof(*host->data),
189                                 DMA_FROM_DEVICE);
190
191         return status;
192 }
193
194 static int mmc_spi_skip(struct mmc_spi_host *host, unsigned long timeout,
195                         unsigned n, u8 byte)
196 {
197         u8              *cp = host->data->status;
198         unsigned long start = jiffies;
199
200         while (1) {
201                 int             status;
202                 unsigned        i;
203
204                 status = mmc_spi_readbytes(host, n);
205                 if (status < 0)
206                         return status;
207
208                 for (i = 0; i < n; i++) {
209                         if (cp[i] != byte)
210                                 return cp[i];
211                 }
212
213                 if (time_is_before_jiffies(start + timeout))
214                         break;
215
216                 /* If we need long timeouts, we may release the CPU.
217                  * We use jiffies here because we want to have a relation
218                  * between elapsed time and the blocking of the scheduler.
219                  */
220                 if (time_is_before_jiffies(start+1))
221                         schedule();
222         }
223         return -ETIMEDOUT;
224 }
225
226 static inline int
227 mmc_spi_wait_unbusy(struct mmc_spi_host *host, unsigned long timeout)
228 {
229         return mmc_spi_skip(host, timeout, sizeof(host->data->status), 0);
230 }
231
232 static int mmc_spi_readtoken(struct mmc_spi_host *host, unsigned long timeout)
233 {
234         return mmc_spi_skip(host, timeout, 1, 0xff);
235 }
236
237
238 /*
239  * Note that for SPI, cmd->resp[0] is not the same data as "native" protocol
240  * hosts return!  The low byte holds R1_SPI bits.  The next byte may hold
241  * R2_SPI bits ... for SEND_STATUS, or after data read errors.
242  *
243  * cmd->resp[1] holds any four-byte response, for R3 (READ_OCR) and on
244  * newer cards R7 (IF_COND).
245  */
246
247 static char *maptype(struct mmc_command *cmd)
248 {
249         switch (mmc_spi_resp_type(cmd)) {
250         case MMC_RSP_SPI_R1:    return "R1";
251         case MMC_RSP_SPI_R1B:   return "R1B";
252         case MMC_RSP_SPI_R2:    return "R2/R5";
253         case MMC_RSP_SPI_R3:    return "R3/R4/R7";
254         default:                return "?";
255         }
256 }
257
258 /* return zero, else negative errno after setting cmd->error */
259 static int mmc_spi_response_get(struct mmc_spi_host *host,
260                 struct mmc_command *cmd, int cs_on)
261 {
262         u8      *cp = host->data->status;
263         u8      *end = cp + host->t.len;
264         int     value = 0;
265         int     bitshift;
266         u8      leftover = 0;
267         unsigned short rotator;
268         int     i;
269         char    tag[32];
270
271         snprintf(tag, sizeof(tag), "  ... CMD%d response SPI_%s",
272                 cmd->opcode, maptype(cmd));
273
274         /* Except for data block reads, the whole response will already
275          * be stored in the scratch buffer.  It's somewhere after the
276          * command and the first byte we read after it.  We ignore that
277          * first byte.  After STOP_TRANSMISSION command it may include
278          * two data bits, but otherwise it's all ones.
279          */
280         cp += 8;
281         while (cp < end && *cp == 0xff)
282                 cp++;
283
284         /* Data block reads (R1 response types) may need more data... */
285         if (cp == end) {
286                 cp = host->data->status;
287                 end = cp+1;
288
289                 /* Card sends N(CR) (== 1..8) bytes of all-ones then one
290                  * status byte ... and we already scanned 2 bytes.
291                  *
292                  * REVISIT block read paths use nasty byte-at-a-time I/O
293                  * so it can always DMA directly into the target buffer.
294                  * It'd probably be better to memcpy() the first chunk and
295                  * avoid extra i/o calls...
296                  *
297                  * Note we check for more than 8 bytes, because in practice,
298                  * some SD cards are slow...
299                  */
300                 for (i = 2; i < 16; i++) {
301                         value = mmc_spi_readbytes(host, 1);
302                         if (value < 0)
303                                 goto done;
304                         if (*cp != 0xff)
305                                 goto checkstatus;
306                 }
307                 value = -ETIMEDOUT;
308                 goto done;
309         }
310
311 checkstatus:
312         bitshift = 0;
313         if (*cp & 0x80) {
314                 /* Houston, we have an ugly card with a bit-shifted response */
315                 rotator = *cp++ << 8;
316                 /* read the next byte */
317                 if (cp == end) {
318                         value = mmc_spi_readbytes(host, 1);
319                         if (value < 0)
320                                 goto done;
321                         cp = host->data->status;
322                         end = cp+1;
323                 }
324                 rotator |= *cp++;
325                 while (rotator & 0x8000) {
326                         bitshift++;
327                         rotator <<= 1;
328                 }
329                 cmd->resp[0] = rotator >> 8;
330                 leftover = rotator;
331         } else {
332                 cmd->resp[0] = *cp++;
333         }
334         cmd->error = 0;
335
336         /* Status byte: the entire seven-bit R1 response.  */
337         if (cmd->resp[0] != 0) {
338                 if ((R1_SPI_PARAMETER | R1_SPI_ADDRESS
339                                       | R1_SPI_ILLEGAL_COMMAND)
340                                 & cmd->resp[0])
341                         value = -EINVAL;
342                 else if (R1_SPI_COM_CRC & cmd->resp[0])
343                         value = -EILSEQ;
344                 else if ((R1_SPI_ERASE_SEQ | R1_SPI_ERASE_RESET)
345                                 & cmd->resp[0])
346                         value = -EIO;
347                 /* else R1_SPI_IDLE, "it's resetting" */
348         }
349
350         switch (mmc_spi_resp_type(cmd)) {
351
352         /* SPI R1B == R1 + busy; STOP_TRANSMISSION (for multiblock reads)
353          * and less-common stuff like various erase operations.
354          */
355         case MMC_RSP_SPI_R1B:
356                 /* maybe we read all the busy tokens already */
357                 while (cp < end && *cp == 0)
358                         cp++;
359                 if (cp == end)
360                         mmc_spi_wait_unbusy(host, r1b_timeout);
361                 break;
362
363         /* SPI R2 == R1 + second status byte; SEND_STATUS
364          * SPI R5 == R1 + data byte; IO_RW_DIRECT
365          */
366         case MMC_RSP_SPI_R2:
367                 /* read the next byte */
368                 if (cp == end) {
369                         value = mmc_spi_readbytes(host, 1);
370                         if (value < 0)
371                                 goto done;
372                         cp = host->data->status;
373                         end = cp+1;
374                 }
375                 if (bitshift) {
376                         rotator = leftover << 8;
377                         rotator |= *cp << bitshift;
378                         cmd->resp[0] |= (rotator & 0xFF00);
379                 } else {
380                         cmd->resp[0] |= *cp << 8;
381                 }
382                 break;
383
384         /* SPI R3, R4, or R7 == R1 + 4 bytes */
385         case MMC_RSP_SPI_R3:
386                 rotator = leftover << 8;
387                 cmd->resp[1] = 0;
388                 for (i = 0; i < 4; i++) {
389                         cmd->resp[1] <<= 8;
390                         /* read the next byte */
391                         if (cp == end) {
392                                 value = mmc_spi_readbytes(host, 1);
393                                 if (value < 0)
394                                         goto done;
395                                 cp = host->data->status;
396                                 end = cp+1;
397                         }
398                         if (bitshift) {
399                                 rotator |= *cp++ << bitshift;
400                                 cmd->resp[1] |= (rotator >> 8);
401                                 rotator <<= 8;
402                         } else {
403                                 cmd->resp[1] |= *cp++;
404                         }
405                 }
406                 break;
407
408         /* SPI R1 == just one status byte */
409         case MMC_RSP_SPI_R1:
410                 break;
411
412         default:
413                 dev_dbg(&host->spi->dev, "bad response type %04x\n",
414                                 mmc_spi_resp_type(cmd));
415                 if (value >= 0)
416                         value = -EINVAL;
417                 goto done;
418         }
419
420         if (value < 0)
421                 dev_dbg(&host->spi->dev, "%s: resp %04x %08x\n",
422                         tag, cmd->resp[0], cmd->resp[1]);
423
424         /* disable chipselect on errors and some success cases */
425         if (value >= 0 && cs_on)
426                 return value;
427 done:
428         if (value < 0)
429                 cmd->error = value;
430         mmc_cs_off(host);
431         return value;
432 }
433
434 /* Issue command and read its response.
435  * Returns zero on success, negative for error.
436  *
437  * On error, caller must cope with mmc core retry mechanism.  That
438  * means immediate low-level resubmit, which affects the bus lock...
439  */
440 static int
441 mmc_spi_command_send(struct mmc_spi_host *host,
442                 struct mmc_request *mrq,
443                 struct mmc_command *cmd, int cs_on)
444 {
445         struct scratch          *data = host->data;
446         u8                      *cp = data->status;
447         u32                     arg = cmd->arg;
448         int                     status;
449         struct spi_transfer     *t;
450
451         /* We can handle most commands (except block reads) in one full
452          * duplex I/O operation before either starting the next transfer
453          * (data block or command) or else deselecting the card.
454          *
455          * First, write 7 bytes:
456          *  - an all-ones byte to ensure the card is ready
457          *  - opcode byte (plus start and transmission bits)
458          *  - four bytes of big-endian argument
459          *  - crc7 (plus end bit) ... always computed, it's cheap
460          *
461          * We init the whole buffer to all-ones, which is what we need
462          * to write while we're reading (later) response data.
463          */
464         memset(cp++, 0xff, sizeof(data->status));
465
466         *cp++ = 0x40 | cmd->opcode;
467         *cp++ = (u8)(arg >> 24);
468         *cp++ = (u8)(arg >> 16);
469         *cp++ = (u8)(arg >> 8);
470         *cp++ = (u8)arg;
471         *cp++ = (crc7(0, &data->status[1], 5) << 1) | 0x01;
472
473         /* Then, read up to 13 bytes (while writing all-ones):
474          *  - N(CR) (== 1..8) bytes of all-ones
475          *  - status byte (for all response types)
476          *  - the rest of the response, either:
477          *      + nothing, for R1 or R1B responses
478          *      + second status byte, for R2 responses
479          *      + four data bytes, for R3 and R7 responses
480          *
481          * Finally, read some more bytes ... in the nice cases we know in
482          * advance how many, and reading 1 more is always OK:
483          *  - N(EC) (== 0..N) bytes of all-ones, before deselect/finish
484          *  - N(RC) (== 1..N) bytes of all-ones, before next command
485          *  - N(WR) (== 1..N) bytes of all-ones, before data write
486          *
487          * So in those cases one full duplex I/O of at most 21 bytes will
488          * handle the whole command, leaving the card ready to receive a
489          * data block or new command.  We do that whenever we can, shaving
490          * CPU and IRQ costs (especially when using DMA or FIFOs).
491          *
492          * There are two other cases, where it's not generally practical
493          * to rely on a single I/O:
494          *
495          *  - R1B responses need at least N(EC) bytes of all-zeroes.
496          *
497          *    In this case we can *try* to fit it into one I/O, then
498          *    maybe read more data later.
499          *
500          *  - Data block reads are more troublesome, since a variable
501          *    number of padding bytes precede the token and data.
502          *      + N(CX) (== 0..8) bytes of all-ones, before CSD or CID
503          *      + N(AC) (== 1..many) bytes of all-ones
504          *
505          *    In this case we currently only have minimal speedups here:
506          *    when N(CR) == 1 we can avoid I/O in response_get().
507          */
508         if (cs_on && (mrq->data->flags & MMC_DATA_READ)) {
509                 cp += 2;        /* min(N(CR)) + status */
510                 /* R1 */
511         } else {
512                 cp += 10;       /* max(N(CR)) + status + min(N(RC),N(WR)) */
513                 if (cmd->flags & MMC_RSP_SPI_S2)        /* R2/R5 */
514                         cp++;
515                 else if (cmd->flags & MMC_RSP_SPI_B4)   /* R3/R4/R7 */
516                         cp += 4;
517                 else if (cmd->flags & MMC_RSP_BUSY)     /* R1B */
518                         cp = data->status + sizeof(data->status);
519                 /* else:  R1 (most commands) */
520         }
521
522         dev_dbg(&host->spi->dev, "  mmc_spi: CMD%d, resp %s\n",
523                 cmd->opcode, maptype(cmd));
524
525         /* send command, leaving chipselect active */
526         spi_message_init(&host->m);
527
528         t = &host->t;
529         memset(t, 0, sizeof(*t));
530         t->tx_buf = t->rx_buf = data->status;
531         t->tx_dma = t->rx_dma = host->data_dma;
532         t->len = cp - data->status;
533         t->cs_change = 1;
534         spi_message_add_tail(t, &host->m);
535
536         if (host->dma_dev) {
537                 host->m.is_dma_mapped = 1;
538                 dma_sync_single_for_device(host->dma_dev,
539                                 host->data_dma, sizeof(*host->data),
540                                 DMA_BIDIRECTIONAL);
541         }
542         status = spi_sync(host->spi, &host->m);
543
544         if (host->dma_dev)
545                 dma_sync_single_for_cpu(host->dma_dev,
546                                 host->data_dma, sizeof(*host->data),
547                                 DMA_BIDIRECTIONAL);
548         if (status < 0) {
549                 dev_dbg(&host->spi->dev, "  ... write returned %d\n", status);
550                 cmd->error = status;
551                 return status;
552         }
553
554         /* after no-data commands and STOP_TRANSMISSION, chipselect off */
555         return mmc_spi_response_get(host, cmd, cs_on);
556 }
557
558 /* Build data message with up to four separate transfers.  For TX, we
559  * start by writing the data token.  And in most cases, we finish with
560  * a status transfer.
561  *
562  * We always provide TX data for data and CRC.  The MMC/SD protocol
563  * requires us to write ones; but Linux defaults to writing zeroes;
564  * so we explicitly initialize it to all ones on RX paths.
565  *
566  * We also handle DMA mapping, so the underlying SPI controller does
567  * not need to (re)do it for each message.
568  */
569 static void
570 mmc_spi_setup_data_message(
571         struct mmc_spi_host     *host,
572         int                     multiple,
573         enum dma_data_direction direction)
574 {
575         struct spi_transfer     *t;
576         struct scratch          *scratch = host->data;
577         dma_addr_t              dma = host->data_dma;
578
579         spi_message_init(&host->m);
580         if (dma)
581                 host->m.is_dma_mapped = 1;
582
583         /* for reads, readblock() skips 0xff bytes before finding
584          * the token; for writes, this transfer issues that token.
585          */
586         if (direction == DMA_TO_DEVICE) {
587                 t = &host->token;
588                 memset(t, 0, sizeof(*t));
589                 t->len = 1;
590                 if (multiple)
591                         scratch->data_token = SPI_TOKEN_MULTI_WRITE;
592                 else
593                         scratch->data_token = SPI_TOKEN_SINGLE;
594                 t->tx_buf = &scratch->data_token;
595                 if (dma)
596                         t->tx_dma = dma + offsetof(struct scratch, data_token);
597                 spi_message_add_tail(t, &host->m);
598         }
599
600         /* Body of transfer is buffer, then CRC ...
601          * either TX-only, or RX with TX-ones.
602          */
603         t = &host->t;
604         memset(t, 0, sizeof(*t));
605         t->tx_buf = host->ones;
606         t->tx_dma = host->ones_dma;
607         /* length and actual buffer info are written later */
608         spi_message_add_tail(t, &host->m);
609
610         t = &host->crc;
611         memset(t, 0, sizeof(*t));
612         t->len = 2;
613         if (direction == DMA_TO_DEVICE) {
614                 /* the actual CRC may get written later */
615                 t->tx_buf = &scratch->crc_val;
616                 if (dma)
617                         t->tx_dma = dma + offsetof(struct scratch, crc_val);
618         } else {
619                 t->tx_buf = host->ones;
620                 t->tx_dma = host->ones_dma;
621                 t->rx_buf = &scratch->crc_val;
622                 if (dma)
623                         t->rx_dma = dma + offsetof(struct scratch, crc_val);
624         }
625         spi_message_add_tail(t, &host->m);
626
627         /*
628          * A single block read is followed by N(EC) [0+] all-ones bytes
629          * before deselect ... don't bother.
630          *
631          * Multiblock reads are followed by N(AC) [1+] all-ones bytes before
632          * the next block is read, or a STOP_TRANSMISSION is issued.  We'll
633          * collect that single byte, so readblock() doesn't need to.
634          *
635          * For a write, the one-byte data response follows immediately, then
636          * come zero or more busy bytes, then N(WR) [1+] all-ones bytes.
637          * Then single block reads may deselect, and multiblock ones issue
638          * the next token (next data block, or STOP_TRAN).  We can try to
639          * minimize I/O ops by using a single read to collect end-of-busy.
640          */
641         if (multiple || direction == DMA_TO_DEVICE) {
642                 t = &host->early_status;
643                 memset(t, 0, sizeof(*t));
644                 t->len = (direction == DMA_TO_DEVICE)
645                                 ? sizeof(scratch->status)
646                                 : 1;
647                 t->tx_buf = host->ones;
648                 t->tx_dma = host->ones_dma;
649                 t->rx_buf = scratch->status;
650                 if (dma)
651                         t->rx_dma = dma + offsetof(struct scratch, status);
652                 t->cs_change = 1;
653                 spi_message_add_tail(t, &host->m);
654         }
655 }
656
657 /*
658  * Write one block:
659  *  - caller handled preceding N(WR) [1+] all-ones bytes
660  *  - data block
661  *      + token
662  *      + data bytes
663  *      + crc16
664  *  - an all-ones byte ... card writes a data-response byte
665  *  - followed by N(EC) [0+] all-ones bytes, card writes zero/'busy'
666  *
667  * Return negative errno, else success.
668  */
669 static int
670 mmc_spi_writeblock(struct mmc_spi_host *host, struct spi_transfer *t,
671         unsigned long timeout)
672 {
673         struct spi_device       *spi = host->spi;
674         int                     status, i;
675         struct scratch          *scratch = host->data;
676         u32                     pattern;
677
678         if (host->mmc->use_spi_crc)
679                 scratch->crc_val = cpu_to_be16(
680                                 crc_itu_t(0, t->tx_buf, t->len));
681         if (host->dma_dev)
682                 dma_sync_single_for_device(host->dma_dev,
683                                 host->data_dma, sizeof(*scratch),
684                                 DMA_BIDIRECTIONAL);
685
686         status = spi_sync(spi, &host->m);
687
688         if (status != 0) {
689                 dev_dbg(&spi->dev, "write error (%d)\n", status);
690                 return status;
691         }
692
693         if (host->dma_dev)
694                 dma_sync_single_for_cpu(host->dma_dev,
695                                 host->data_dma, sizeof(*scratch),
696                                 DMA_BIDIRECTIONAL);
697
698         /*
699          * Get the transmission data-response reply.  It must follow
700          * immediately after the data block we transferred.  This reply
701          * doesn't necessarily tell whether the write operation succeeded;
702          * it just says if the transmission was ok and whether *earlier*
703          * writes succeeded; see the standard.
704          *
705          * In practice, there are (even modern SDHC-)cards which are late
706          * in sending the response, and miss the time frame by a few bits,
707          * so we have to cope with this situation and check the response
708          * bit-by-bit. Arggh!!!
709          */
710         pattern  = scratch->status[0] << 24;
711         pattern |= scratch->status[1] << 16;
712         pattern |= scratch->status[2] << 8;
713         pattern |= scratch->status[3];
714
715         /* First 3 bit of pattern are undefined */
716         pattern |= 0xE0000000;
717
718         /* left-adjust to leading 0 bit */
719         while (pattern & 0x80000000)
720                 pattern <<= 1;
721         /* right-adjust for pattern matching. Code is in bit 4..0 now. */
722         pattern >>= 27;
723
724         switch (pattern) {
725         case SPI_RESPONSE_ACCEPTED:
726                 status = 0;
727                 break;
728         case SPI_RESPONSE_CRC_ERR:
729                 /* host shall then issue MMC_STOP_TRANSMISSION */
730                 status = -EILSEQ;
731                 break;
732         case SPI_RESPONSE_WRITE_ERR:
733                 /* host shall then issue MMC_STOP_TRANSMISSION,
734                  * and should MMC_SEND_STATUS to sort it out
735                  */
736                 status = -EIO;
737                 break;
738         default:
739                 status = -EPROTO;
740                 break;
741         }
742         if (status != 0) {
743                 dev_dbg(&spi->dev, "write error %02x (%d)\n",
744                         scratch->status[0], status);
745                 return status;
746         }
747
748         t->tx_buf += t->len;
749         if (host->dma_dev)
750                 t->tx_dma += t->len;
751
752         /* Return when not busy.  If we didn't collect that status yet,
753          * we'll need some more I/O.
754          */
755         for (i = 4; i < sizeof(scratch->status); i++) {
756                 /* card is non-busy if the most recent bit is 1 */
757                 if (scratch->status[i] & 0x01)
758                         return 0;
759         }
760         return mmc_spi_wait_unbusy(host, timeout);
761 }
762
763 /*
764  * Read one block:
765  *  - skip leading all-ones bytes ... either
766  *      + N(AC) [1..f(clock,CSD)] usually, else
767  *      + N(CX) [0..8] when reading CSD or CID
768  *  - data block
769  *      + token ... if error token, no data or crc
770  *      + data bytes
771  *      + crc16
772  *
773  * After single block reads, we're done; N(EC) [0+] all-ones bytes follow
774  * before dropping chipselect.
775  *
776  * For multiblock reads, caller either reads the next block or issues a
777  * STOP_TRANSMISSION command.
778  */
779 static int
780 mmc_spi_readblock(struct mmc_spi_host *host, struct spi_transfer *t,
781         unsigned long timeout)
782 {
783         struct spi_device       *spi = host->spi;
784         int                     status;
785         struct scratch          *scratch = host->data;
786         unsigned int            bitshift;
787         u8                      leftover;
788
789         /* At least one SD card sends an all-zeroes byte when N(CX)
790          * applies, before the all-ones bytes ... just cope with that.
791          */
792         status = mmc_spi_readbytes(host, 1);
793         if (status < 0)
794                 return status;
795         status = scratch->status[0];
796         if (status == 0xff || status == 0)
797                 status = mmc_spi_readtoken(host, timeout);
798
799         if (status < 0) {
800                 dev_dbg(&spi->dev, "read error %02x (%d)\n", status, status);
801                 return status;
802         }
803
804         /* The token may be bit-shifted...
805          * the first 0-bit precedes the data stream.
806          */
807         bitshift = 7;
808         while (status & 0x80) {
809                 status <<= 1;
810                 bitshift--;
811         }
812         leftover = status << 1;
813
814         if (host->dma_dev) {
815                 dma_sync_single_for_device(host->dma_dev,
816                                 host->data_dma, sizeof(*scratch),
817                                 DMA_BIDIRECTIONAL);
818                 dma_sync_single_for_device(host->dma_dev,
819                                 t->rx_dma, t->len,
820                                 DMA_FROM_DEVICE);
821         }
822
823         status = spi_sync(spi, &host->m);
824
825         if (host->dma_dev) {
826                 dma_sync_single_for_cpu(host->dma_dev,
827                                 host->data_dma, sizeof(*scratch),
828                                 DMA_BIDIRECTIONAL);
829                 dma_sync_single_for_cpu(host->dma_dev,
830                                 t->rx_dma, t->len,
831                                 DMA_FROM_DEVICE);
832         }
833
834         if (bitshift) {
835                 /* Walk through the data and the crc and do
836                  * all the magic to get byte-aligned data.
837                  */
838                 u8 *cp = t->rx_buf;
839                 unsigned int len;
840                 unsigned int bitright = 8 - bitshift;
841                 u8 temp;
842                 for (len = t->len; len; len--) {
843                         temp = *cp;
844                         *cp++ = leftover | (temp >> bitshift);
845                         leftover = temp << bitright;
846                 }
847                 cp = (u8 *) &scratch->crc_val;
848                 temp = *cp;
849                 *cp++ = leftover | (temp >> bitshift);
850                 leftover = temp << bitright;
851                 temp = *cp;
852                 *cp = leftover | (temp >> bitshift);
853         }
854
855         if (host->mmc->use_spi_crc) {
856                 u16 crc = crc_itu_t(0, t->rx_buf, t->len);
857
858                 be16_to_cpus(&scratch->crc_val);
859                 if (scratch->crc_val != crc) {
860                         dev_dbg(&spi->dev, "read - crc error: crc_val=0x%04x, "
861                                         "computed=0x%04x len=%d\n",
862                                         scratch->crc_val, crc, t->len);
863                         return -EILSEQ;
864                 }
865         }
866
867         t->rx_buf += t->len;
868         if (host->dma_dev)
869                 t->rx_dma += t->len;
870
871         return 0;
872 }
873
874 /*
875  * An MMC/SD data stage includes one or more blocks, optional CRCs,
876  * and inline handshaking.  That handhaking makes it unlike most
877  * other SPI protocol stacks.
878  */
879 static void
880 mmc_spi_data_do(struct mmc_spi_host *host, struct mmc_command *cmd,
881                 struct mmc_data *data, u32 blk_size)
882 {
883         struct spi_device       *spi = host->spi;
884         struct device           *dma_dev = host->dma_dev;
885         struct spi_transfer     *t;
886         enum dma_data_direction direction;
887         struct scatterlist      *sg;
888         unsigned                n_sg;
889         int                     multiple = (data->blocks > 1);
890         u32                     clock_rate;
891         unsigned long           timeout;
892
893         if (data->flags & MMC_DATA_READ)
894                 direction = DMA_FROM_DEVICE;
895         else
896                 direction = DMA_TO_DEVICE;
897         mmc_spi_setup_data_message(host, multiple, direction);
898         t = &host->t;
899
900         if (t->speed_hz)
901                 clock_rate = t->speed_hz;
902         else
903                 clock_rate = spi->max_speed_hz;
904
905         timeout = data->timeout_ns +
906                   data->timeout_clks * 1000000 / clock_rate;
907         timeout = usecs_to_jiffies((unsigned int)(timeout / 1000)) + 1;
908
909         /* Handle scatterlist segments one at a time, with synch for
910          * each 512-byte block
911          */
912         for (sg = data->sg, n_sg = data->sg_len; n_sg; n_sg--, sg++) {
913                 int                     status = 0;
914                 dma_addr_t              dma_addr = 0;
915                 void                    *kmap_addr;
916                 unsigned                length = sg->length;
917                 enum dma_data_direction dir = direction;
918
919                 /* set up dma mapping for controller drivers that might
920                  * use DMA ... though they may fall back to PIO
921                  */
922                 if (dma_dev) {
923                         /* never invalidate whole *shared* pages ... */
924                         if ((sg->offset != 0 || length != PAGE_SIZE)
925                                         && dir == DMA_FROM_DEVICE)
926                                 dir = DMA_BIDIRECTIONAL;
927
928                         dma_addr = dma_map_page(dma_dev, sg_page(sg), 0,
929                                                 PAGE_SIZE, dir);
930                         if (direction == DMA_TO_DEVICE)
931                                 t->tx_dma = dma_addr + sg->offset;
932                         else
933                                 t->rx_dma = dma_addr + sg->offset;
934                 }
935
936                 /* allow pio too; we don't allow highmem */
937                 kmap_addr = kmap(sg_page(sg));
938                 if (direction == DMA_TO_DEVICE)
939                         t->tx_buf = kmap_addr + sg->offset;
940                 else
941                         t->rx_buf = kmap_addr + sg->offset;
942
943                 /* transfer each block, and update request status */
944                 while (length) {
945                         t->len = min(length, blk_size);
946
947                         dev_dbg(&host->spi->dev,
948                                 "    mmc_spi: %s block, %d bytes\n",
949                                 (direction == DMA_TO_DEVICE)
950                                 ? "write"
951                                 : "read",
952                                 t->len);
953
954                         if (direction == DMA_TO_DEVICE)
955                                 status = mmc_spi_writeblock(host, t, timeout);
956                         else
957                                 status = mmc_spi_readblock(host, t, timeout);
958                         if (status < 0)
959                                 break;
960
961                         data->bytes_xfered += t->len;
962                         length -= t->len;
963
964                         if (!multiple)
965                                 break;
966                 }
967
968                 /* discard mappings */
969                 if (direction == DMA_FROM_DEVICE)
970                         flush_kernel_dcache_page(sg_page(sg));
971                 kunmap(sg_page(sg));
972                 if (dma_dev)
973                         dma_unmap_page(dma_dev, dma_addr, PAGE_SIZE, dir);
974
975                 if (status < 0) {
976                         data->error = status;
977                         dev_dbg(&spi->dev, "%s status %d\n",
978                                 (direction == DMA_TO_DEVICE)
979                                         ? "write" : "read",
980                                 status);
981                         break;
982                 }
983         }
984
985         /* NOTE some docs describe an MMC-only SET_BLOCK_COUNT (CMD23) that
986          * can be issued before multiblock writes.  Unlike its more widely
987          * documented analogue for SD cards (SET_WR_BLK_ERASE_COUNT, ACMD23),
988          * that can affect the STOP_TRAN logic.   Complete (and current)
989          * MMC specs should sort that out before Linux starts using CMD23.
990          */
991         if (direction == DMA_TO_DEVICE && multiple) {
992                 struct scratch  *scratch = host->data;
993                 int             tmp;
994                 const unsigned  statlen = sizeof(scratch->status);
995
996                 dev_dbg(&spi->dev, "    mmc_spi: STOP_TRAN\n");
997
998                 /* Tweak the per-block message we set up earlier by morphing
999                  * it to hold single buffer with the token followed by some
1000                  * all-ones bytes ... skip N(BR) (0..1), scan the rest for
1001                  * "not busy any longer" status, and leave chip selected.
1002                  */
1003                 INIT_LIST_HEAD(&host->m.transfers);
1004                 list_add(&host->early_status.transfer_list,
1005                                 &host->m.transfers);
1006
1007                 memset(scratch->status, 0xff, statlen);
1008                 scratch->status[0] = SPI_TOKEN_STOP_TRAN;
1009
1010                 host->early_status.tx_buf = host->early_status.rx_buf;
1011                 host->early_status.tx_dma = host->early_status.rx_dma;
1012                 host->early_status.len = statlen;
1013
1014                 if (host->dma_dev)
1015                         dma_sync_single_for_device(host->dma_dev,
1016                                         host->data_dma, sizeof(*scratch),
1017                                         DMA_BIDIRECTIONAL);
1018
1019                 tmp = spi_sync(spi, &host->m);
1020
1021                 if (host->dma_dev)
1022                         dma_sync_single_for_cpu(host->dma_dev,
1023                                         host->data_dma, sizeof(*scratch),
1024                                         DMA_BIDIRECTIONAL);
1025
1026                 if (tmp < 0) {
1027                         if (!data->error)
1028                                 data->error = tmp;
1029                         return;
1030                 }
1031
1032                 /* Ideally we collected "not busy" status with one I/O,
1033                  * avoiding wasteful byte-at-a-time scanning... but more
1034                  * I/O is often needed.
1035                  */
1036                 for (tmp = 2; tmp < statlen; tmp++) {
1037                         if (scratch->status[tmp] != 0)
1038                                 return;
1039                 }
1040                 tmp = mmc_spi_wait_unbusy(host, timeout);
1041                 if (tmp < 0 && !data->error)
1042                         data->error = tmp;
1043         }
1044 }
1045
1046 /****************************************************************************/
1047
1048 /*
1049  * MMC driver implementation -- the interface to the MMC stack
1050  */
1051
1052 static void mmc_spi_request(struct mmc_host *mmc, struct mmc_request *mrq)
1053 {
1054         struct mmc_spi_host     *host = mmc_priv(mmc);
1055         int                     status = -EINVAL;
1056
1057 #ifdef DEBUG
1058         /* MMC core and layered drivers *MUST* issue SPI-aware commands */
1059         {
1060                 struct mmc_command      *cmd;
1061                 int                     invalid = 0;
1062
1063                 cmd = mrq->cmd;
1064                 if (!mmc_spi_resp_type(cmd)) {
1065                         dev_dbg(&host->spi->dev, "bogus command\n");
1066                         cmd->error = -EINVAL;
1067                         invalid = 1;
1068                 }
1069
1070                 cmd = mrq->stop;
1071                 if (cmd && !mmc_spi_resp_type(cmd)) {
1072                         dev_dbg(&host->spi->dev, "bogus STOP command\n");
1073                         cmd->error = -EINVAL;
1074                         invalid = 1;
1075                 }
1076
1077                 if (invalid) {
1078                         dump_stack();
1079                         mmc_request_done(host->mmc, mrq);
1080                         return;
1081                 }
1082         }
1083 #endif
1084
1085         /* issue command; then optionally data and stop */
1086         status = mmc_spi_command_send(host, mrq, mrq->cmd, mrq->data != NULL);
1087         if (status == 0 && mrq->data) {
1088                 mmc_spi_data_do(host, mrq->cmd, mrq->data, mrq->data->blksz);
1089                 if (mrq->stop)
1090                         status = mmc_spi_command_send(host, mrq, mrq->stop, 0);
1091                 else
1092                         mmc_cs_off(host);
1093         }
1094
1095         mmc_request_done(host->mmc, mrq);
1096 }
1097
1098 /* See Section 6.4.1, in SD "Simplified Physical Layer Specification 2.0"
1099  *
1100  * NOTE that here we can't know that the card has just been powered up;
1101  * not all MMC/SD sockets support power switching.
1102  *
1103  * FIXME when the card is still in SPI mode, e.g. from a previous kernel,
1104  * this doesn't seem to do the right thing at all...
1105  */
1106 static void mmc_spi_initsequence(struct mmc_spi_host *host)
1107 {
1108         /* Try to be very sure any previous command has completed;
1109          * wait till not-busy, skip debris from any old commands.
1110          */
1111         mmc_spi_wait_unbusy(host, r1b_timeout);
1112         mmc_spi_readbytes(host, 10);
1113
1114         /*
1115          * Do a burst with chipselect active-high.  We need to do this to
1116          * meet the requirement of 74 clock cycles with both chipselect
1117          * and CMD (MOSI) high before CMD0 ... after the card has been
1118          * powered up to Vdd(min), and so is ready to take commands.
1119          *
1120          * Some cards are particularly needy of this (e.g. Viking "SD256")
1121          * while most others don't seem to care.
1122          *
1123          * Note that this is one of the places MMC/SD plays games with the
1124          * SPI protocol.  Another is that when chipselect is released while
1125          * the card returns BUSY status, the clock must issue several cycles
1126          * with chipselect high before the card will stop driving its output.
1127          */
1128         host->spi->mode |= SPI_CS_HIGH;
1129         if (spi_setup(host->spi) != 0) {
1130                 /* Just warn; most cards work without it. */
1131                 dev_warn(&host->spi->dev,
1132                                 "can't change chip-select polarity\n");
1133                 host->spi->mode &= ~SPI_CS_HIGH;
1134         } else {
1135                 mmc_spi_readbytes(host, 18);
1136
1137                 host->spi->mode &= ~SPI_CS_HIGH;
1138                 if (spi_setup(host->spi) != 0) {
1139                         /* Wot, we can't get the same setup we had before? */
1140                         dev_err(&host->spi->dev,
1141                                         "can't restore chip-select polarity\n");
1142                 }
1143         }
1144 }
1145
1146 static char *mmc_powerstring(u8 power_mode)
1147 {
1148         switch (power_mode) {
1149         case MMC_POWER_OFF: return "off";
1150         case MMC_POWER_UP:  return "up";
1151         case MMC_POWER_ON:  return "on";
1152         }
1153         return "?";
1154 }
1155
1156 static void mmc_spi_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
1157 {
1158         struct mmc_spi_host *host = mmc_priv(mmc);
1159
1160         if (host->power_mode != ios->power_mode) {
1161                 int             canpower;
1162
1163                 canpower = host->pdata && host->pdata->setpower;
1164
1165                 dev_dbg(&host->spi->dev, "mmc_spi: power %s (%d)%s\n",
1166                                 mmc_powerstring(ios->power_mode),
1167                                 ios->vdd,
1168                                 canpower ? ", can switch" : "");
1169
1170                 /* switch power on/off if possible, accounting for
1171                  * max 250msec powerup time if needed.
1172                  */
1173                 if (canpower) {
1174                         switch (ios->power_mode) {
1175                         case MMC_POWER_OFF:
1176                         case MMC_POWER_UP:
1177                                 host->pdata->setpower(&host->spi->dev,
1178                                                 ios->vdd);
1179                                 if (ios->power_mode == MMC_POWER_UP)
1180                                         msleep(host->powerup_msecs);
1181                         }
1182                 }
1183
1184                 /* See 6.4.1 in the simplified SD card physical spec 2.0 */
1185                 if (ios->power_mode == MMC_POWER_ON)
1186                         mmc_spi_initsequence(host);
1187
1188                 /* If powering down, ground all card inputs to avoid power
1189                  * delivery from data lines!  On a shared SPI bus, this
1190                  * will probably be temporary; 6.4.2 of the simplified SD
1191                  * spec says this must last at least 1msec.
1192                  *
1193                  *   - Clock low means CPOL 0, e.g. mode 0
1194                  *   - MOSI low comes from writing zero
1195                  *   - Chipselect is usually active low...
1196                  */
1197                 if (canpower && ios->power_mode == MMC_POWER_OFF) {
1198                         int mres;
1199                         u8 nullbyte = 0;
1200
1201                         host->spi->mode &= ~(SPI_CPOL|SPI_CPHA);
1202                         mres = spi_setup(host->spi);
1203                         if (mres < 0)
1204                                 dev_dbg(&host->spi->dev,
1205                                         "switch to SPI mode 0 failed\n");
1206
1207                         if (spi_write(host->spi, &nullbyte, 1) < 0)
1208                                 dev_dbg(&host->spi->dev,
1209                                         "put spi signals to low failed\n");
1210
1211                         /*
1212                          * Now clock should be low due to spi mode 0;
1213                          * MOSI should be low because of written 0x00;
1214                          * chipselect should be low (it is active low)
1215                          * power supply is off, so now MMC is off too!
1216                          *
1217                          * FIXME no, chipselect can be high since the
1218                          * device is inactive and SPI_CS_HIGH is clear...
1219                          */
1220                         msleep(10);
1221                         if (mres == 0) {
1222                                 host->spi->mode |= (SPI_CPOL|SPI_CPHA);
1223                                 mres = spi_setup(host->spi);
1224                                 if (mres < 0)
1225                                         dev_dbg(&host->spi->dev,
1226                                                 "switch back to SPI mode 3"
1227                                                 " failed\n");
1228                         }
1229                 }
1230
1231                 host->power_mode = ios->power_mode;
1232         }
1233
1234         if (host->spi->max_speed_hz != ios->clock && ios->clock != 0) {
1235                 int             status;
1236
1237                 host->spi->max_speed_hz = ios->clock;
1238                 status = spi_setup(host->spi);
1239                 dev_dbg(&host->spi->dev,
1240                         "mmc_spi:  clock to %d Hz, %d\n",
1241                         host->spi->max_speed_hz, status);
1242         }
1243 }
1244
1245 static int mmc_spi_get_ro(struct mmc_host *mmc)
1246 {
1247         struct mmc_spi_host *host = mmc_priv(mmc);
1248
1249         if (host->pdata && host->pdata->get_ro)
1250                 return !!host->pdata->get_ro(mmc->parent);
1251         /*
1252          * Board doesn't support read only detection; let the mmc core
1253          * decide what to do.
1254          */
1255         return -ENOSYS;
1256 }
1257
1258 static int mmc_spi_get_cd(struct mmc_host *mmc)
1259 {
1260         struct mmc_spi_host *host = mmc_priv(mmc);
1261
1262         if (host->pdata && host->pdata->get_cd)
1263                 return !!host->pdata->get_cd(mmc->parent);
1264         return -ENOSYS;
1265 }
1266
1267 static const struct mmc_host_ops mmc_spi_ops = {
1268         .request        = mmc_spi_request,
1269         .set_ios        = mmc_spi_set_ios,
1270         .get_ro         = mmc_spi_get_ro,
1271         .get_cd         = mmc_spi_get_cd,
1272 };
1273
1274
1275 /****************************************************************************/
1276
1277 /*
1278  * SPI driver implementation
1279  */
1280
1281 static irqreturn_t
1282 mmc_spi_detect_irq(int irq, void *mmc)
1283 {
1284         struct mmc_spi_host *host = mmc_priv(mmc);
1285         u16 delay_msec = max(host->pdata->detect_delay, (u16)100);
1286
1287         mmc_detect_change(mmc, msecs_to_jiffies(delay_msec));
1288         return IRQ_HANDLED;
1289 }
1290
1291 struct count_children {
1292         unsigned        n;
1293         struct bus_type *bus;
1294 };
1295
1296 static int maybe_count_child(struct device *dev, void *c)
1297 {
1298         struct count_children *ccp = c;
1299
1300         if (dev->bus == ccp->bus) {
1301                 if (ccp->n)
1302                         return -EBUSY;
1303                 ccp->n++;
1304         }
1305         return 0;
1306 }
1307
1308 static int mmc_spi_probe(struct spi_device *spi)
1309 {
1310         void                    *ones;
1311         struct mmc_host         *mmc;
1312         struct mmc_spi_host     *host;
1313         int                     status;
1314
1315         /* MMC and SD specs only seem to care that sampling is on the
1316          * rising edge ... meaning SPI modes 0 or 3.  So either SPI mode
1317          * should be legit.  We'll use mode 0 since the steady state is 0,
1318          * which is appropriate for hotplugging, unless the platform data
1319          * specify mode 3 (if hardware is not compatible to mode 0).
1320          */
1321         if (spi->mode != SPI_MODE_3)
1322                 spi->mode = SPI_MODE_0;
1323         spi->bits_per_word = 8;
1324
1325         status = spi_setup(spi);
1326         if (status < 0) {
1327                 dev_dbg(&spi->dev, "needs SPI mode %02x, %d KHz; %d\n",
1328                                 spi->mode, spi->max_speed_hz / 1000,
1329                                 status);
1330                 return status;
1331         }
1332
1333         /* We can use the bus safely iff nobody else will interfere with us.
1334          * Most commands consist of one SPI message to issue a command, then
1335          * several more to collect its response, then possibly more for data
1336          * transfer.  Clocking access to other devices during that period will
1337          * corrupt the command execution.
1338          *
1339          * Until we have software primitives which guarantee non-interference,
1340          * we'll aim for a hardware-level guarantee.
1341          *
1342          * REVISIT we can't guarantee another device won't be added later...
1343          */
1344         if (spi->master->num_chipselect > 1) {
1345                 struct count_children cc;
1346
1347                 cc.n = 0;
1348                 cc.bus = spi->dev.bus;
1349                 status = device_for_each_child(spi->dev.parent, &cc,
1350                                 maybe_count_child);
1351                 if (status < 0) {
1352                         dev_err(&spi->dev, "can't share SPI bus\n");
1353                         return status;
1354                 }
1355
1356                 dev_warn(&spi->dev, "ASSUMING SPI bus stays unshared!\n");
1357         }
1358
1359         /* We need a supply of ones to transmit.  This is the only time
1360          * the CPU touches these, so cache coherency isn't a concern.
1361          *
1362          * NOTE if many systems use more than one MMC-over-SPI connector
1363          * it'd save some memory to share this.  That's evidently rare.
1364          */
1365         status = -ENOMEM;
1366         ones = kmalloc(MMC_SPI_BLOCKSIZE, GFP_KERNEL);
1367         if (!ones)
1368                 goto nomem;
1369         memset(ones, 0xff, MMC_SPI_BLOCKSIZE);
1370
1371         mmc = mmc_alloc_host(sizeof(*host), &spi->dev);
1372         if (!mmc)
1373                 goto nomem;
1374
1375         mmc->ops = &mmc_spi_ops;
1376         mmc->max_blk_size = MMC_SPI_BLOCKSIZE;
1377         mmc->max_hw_segs = MMC_SPI_BLOCKSATONCE;
1378         mmc->max_phys_segs = MMC_SPI_BLOCKSATONCE;
1379         mmc->max_req_size = MMC_SPI_BLOCKSATONCE * MMC_SPI_BLOCKSIZE;
1380         mmc->max_blk_count = MMC_SPI_BLOCKSATONCE;
1381
1382         mmc->caps = MMC_CAP_SPI;
1383
1384         /* SPI doesn't need the lowspeed device identification thing for
1385          * MMC or SD cards, since it never comes up in open drain mode.
1386          * That's good; some SPI masters can't handle very low speeds!
1387          *
1388          * However, low speed SDIO cards need not handle over 400 KHz;
1389          * that's the only reason not to use a few MHz for f_min (until
1390          * the upper layer reads the target frequency from the CSD).
1391          */
1392         mmc->f_min = 400000;
1393         mmc->f_max = spi->max_speed_hz;
1394
1395         host = mmc_priv(mmc);
1396         host->mmc = mmc;
1397         host->spi = spi;
1398
1399         host->ones = ones;
1400
1401         /* Platform data is used to hook up things like card sensing
1402          * and power switching gpios.
1403          */
1404         host->pdata = mmc_spi_get_pdata(spi);
1405         if (host->pdata)
1406                 mmc->ocr_avail = host->pdata->ocr_mask;
1407         if (!mmc->ocr_avail) {
1408                 dev_warn(&spi->dev, "ASSUMING 3.2-3.4 V slot power\n");
1409                 mmc->ocr_avail = MMC_VDD_32_33|MMC_VDD_33_34;
1410         }
1411         if (host->pdata && host->pdata->setpower) {
1412                 host->powerup_msecs = host->pdata->powerup_msecs;
1413                 if (!host->powerup_msecs || host->powerup_msecs > 250)
1414                         host->powerup_msecs = 250;
1415         }
1416
1417         dev_set_drvdata(&spi->dev, mmc);
1418
1419         /* preallocate dma buffers */
1420         host->data = kmalloc(sizeof(*host->data), GFP_KERNEL);
1421         if (!host->data)
1422                 goto fail_nobuf1;
1423
1424         if (spi->master->dev.parent->dma_mask) {
1425                 struct device   *dev = spi->master->dev.parent;
1426
1427                 host->dma_dev = dev;
1428                 host->ones_dma = dma_map_single(dev, ones,
1429                                 MMC_SPI_BLOCKSIZE, DMA_TO_DEVICE);
1430                 host->data_dma = dma_map_single(dev, host->data,
1431                                 sizeof(*host->data), DMA_BIDIRECTIONAL);
1432
1433                 /* REVISIT in theory those map operations can fail... */
1434
1435                 dma_sync_single_for_cpu(host->dma_dev,
1436                                 host->data_dma, sizeof(*host->data),
1437                                 DMA_BIDIRECTIONAL);
1438         }
1439
1440         /* setup message for status/busy readback */
1441         spi_message_init(&host->readback);
1442         host->readback.is_dma_mapped = (host->dma_dev != NULL);
1443
1444         spi_message_add_tail(&host->status, &host->readback);
1445         host->status.tx_buf = host->ones;
1446         host->status.tx_dma = host->ones_dma;
1447         host->status.rx_buf = &host->data->status;
1448         host->status.rx_dma = host->data_dma + offsetof(struct scratch, status);
1449         host->status.cs_change = 1;
1450
1451         /* register card detect irq */
1452         if (host->pdata && host->pdata->init) {
1453                 status = host->pdata->init(&spi->dev, mmc_spi_detect_irq, mmc);
1454                 if (status != 0)
1455                         goto fail_glue_init;
1456         }
1457
1458         /* pass platform capabilities, if any */
1459         if (host->pdata)
1460                 mmc->caps |= host->pdata->caps;
1461
1462         status = mmc_add_host(mmc);
1463         if (status != 0)
1464                 goto fail_add_host;
1465
1466         dev_info(&spi->dev, "SD/MMC host %s%s%s%s%s\n",
1467                         dev_name(&mmc->class_dev),
1468                         host->dma_dev ? "" : ", no DMA",
1469                         (host->pdata && host->pdata->get_ro)
1470                                 ? "" : ", no WP",
1471                         (host->pdata && host->pdata->setpower)
1472                                 ? "" : ", no poweroff",
1473                         (mmc->caps & MMC_CAP_NEEDS_POLL)
1474                                 ? ", cd polling" : "");
1475         return 0;
1476
1477 fail_add_host:
1478         mmc_remove_host (mmc);
1479 fail_glue_init:
1480         if (host->dma_dev)
1481                 dma_unmap_single(host->dma_dev, host->data_dma,
1482                                 sizeof(*host->data), DMA_BIDIRECTIONAL);
1483         kfree(host->data);
1484
1485 fail_nobuf1:
1486         mmc_free_host(mmc);
1487         mmc_spi_put_pdata(spi);
1488         dev_set_drvdata(&spi->dev, NULL);
1489
1490 nomem:
1491         kfree(ones);
1492         return status;
1493 }
1494
1495
1496 static int __devexit mmc_spi_remove(struct spi_device *spi)
1497 {
1498         struct mmc_host         *mmc = dev_get_drvdata(&spi->dev);
1499         struct mmc_spi_host     *host;
1500
1501         if (mmc) {
1502                 host = mmc_priv(mmc);
1503
1504                 /* prevent new mmc_detect_change() calls */
1505                 if (host->pdata && host->pdata->exit)
1506                         host->pdata->exit(&spi->dev, mmc);
1507
1508                 mmc_remove_host(mmc);
1509
1510                 if (host->dma_dev) {
1511                         dma_unmap_single(host->dma_dev, host->ones_dma,
1512                                 MMC_SPI_BLOCKSIZE, DMA_TO_DEVICE);
1513                         dma_unmap_single(host->dma_dev, host->data_dma,
1514                                 sizeof(*host->data), DMA_BIDIRECTIONAL);
1515                 }
1516
1517                 kfree(host->data);
1518                 kfree(host->ones);
1519
1520                 spi->max_speed_hz = mmc->f_max;
1521                 mmc_free_host(mmc);
1522                 mmc_spi_put_pdata(spi);
1523                 dev_set_drvdata(&spi->dev, NULL);
1524         }
1525         return 0;
1526 }
1527
1528
1529 static struct spi_driver mmc_spi_driver = {
1530         .driver = {
1531                 .name =         "mmc_spi",
1532                 .bus =          &spi_bus_type,
1533                 .owner =        THIS_MODULE,
1534         },
1535         .probe =        mmc_spi_probe,
1536         .remove =       __devexit_p(mmc_spi_remove),
1537 };
1538
1539
1540 static int __init mmc_spi_init(void)
1541 {
1542         return spi_register_driver(&mmc_spi_driver);
1543 }
1544 module_init(mmc_spi_init);
1545
1546
1547 static void __exit mmc_spi_exit(void)
1548 {
1549         spi_unregister_driver(&mmc_spi_driver);
1550 }
1551 module_exit(mmc_spi_exit);
1552
1553
1554 MODULE_AUTHOR("Mike Lavender, David Brownell, "
1555                 "Hans-Peter Nilsson, Jan Nikitenko");
1556 MODULE_DESCRIPTION("SPI SD/MMC host driver");
1557 MODULE_LICENSE("GPL");