]> CyberLeo.Net >> Repos - FreeBSD/releng/10.0.git/blob - sys/dev/mmc/mmcsd.c
- Copy stable/10 (r259064) to releng/10.0 as part of the
[FreeBSD/releng/10.0.git] / sys / dev / mmc / mmcsd.c
1 /*-
2  * Copyright (c) 2006 Bernd Walter.  All rights reserved.
3  * Copyright (c) 2006 M. Warner Losh.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * Portions of this software may have been developed with reference to
26  * the SD Simplified Specification.  The following disclaimer may apply:
27  *
28  * The following conditions apply to the release of the simplified
29  * specification ("Simplified Specification") by the SD Card Association and
30  * the SD Group. The Simplified Specification is a subset of the complete SD
31  * Specification which is owned by the SD Card Association and the SD
32  * Group. This Simplified Specification is provided on a non-confidential
33  * basis subject to the disclaimers below. Any implementation of the
34  * Simplified Specification may require a license from the SD Card
35  * Association, SD Group, SD-3C LLC or other third parties.
36  *
37  * Disclaimers:
38  *
39  * The information contained in the Simplified Specification is presented only
40  * as a standard specification for SD Cards and SD Host/Ancillary products and
41  * is provided "AS-IS" without any representations or warranties of any
42  * kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD
43  * Card Association for any damages, any infringements of patents or other
44  * right of the SD Group, SD-3C LLC, the SD Card Association or any third
45  * parties, which may result from its use. No license is granted by
46  * implication, estoppel or otherwise under any patent or other rights of the
47  * SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing
48  * herein shall be construed as an obligation by the SD Group, the SD-3C LLC
49  * or the SD Card Association to disclose or distribute any technical
50  * information, know-how or other confidential information to any third party.
51  */
52
53 #include <sys/cdefs.h>
54 __FBSDID("$FreeBSD$");
55
56 #include <sys/param.h>
57 #include <sys/systm.h>
58 #include <sys/bio.h>
59 #include <sys/bus.h>
60 #include <sys/conf.h>
61 #include <sys/kernel.h>
62 #include <sys/kthread.h>
63 #include <sys/lock.h>
64 #include <sys/malloc.h>
65 #include <sys/module.h>
66 #include <sys/mutex.h>
67 #include <geom/geom_disk.h>
68
69 #include <dev/mmc/mmcbrvar.h>
70 #include <dev/mmc/mmcreg.h>
71 #include <dev/mmc/mmcvar.h>
72
73 #include "mmcbus_if.h"
74
75 #if __FreeBSD_version < 800002
76 #define kproc_create    kthread_create
77 #define kproc_exit      kthread_exit
78 #endif
79
80 struct mmcsd_softc {
81         device_t dev;
82         struct mtx sc_mtx;
83         struct disk *disk;
84         struct proc *p;
85         struct bio_queue_head bio_queue;
86         daddr_t eblock, eend;   /* Range remaining after the last erase. */
87         int running;
88         int suspend;
89 };
90
91 static const char *errmsg[] =
92 {
93         "None",
94         "Timeout",
95         "Bad CRC",
96         "Fifo",
97         "Failed",
98         "Invalid",
99         "NO MEMORY"
100 };
101
102 /* bus entry points */
103 static int mmcsd_attach(device_t dev);
104 static int mmcsd_detach(device_t dev);
105 static int mmcsd_probe(device_t dev);
106
107 /* disk routines */
108 static int mmcsd_close(struct disk *dp);
109 static int mmcsd_dump(void *arg, void *virtual, vm_offset_t physical,
110         off_t offset, size_t length);
111 static int mmcsd_open(struct disk *dp);
112 static void mmcsd_strategy(struct bio *bp);
113 static void mmcsd_task(void *arg);
114
115 static int mmcsd_bus_bit_width(device_t dev);
116 static daddr_t mmcsd_delete(struct mmcsd_softc *sc, struct bio *bp);
117 static daddr_t mmcsd_rw(struct mmcsd_softc *sc, struct bio *bp);
118
119 #define MMCSD_LOCK(_sc)         mtx_lock(&(_sc)->sc_mtx)
120 #define MMCSD_UNLOCK(_sc)       mtx_unlock(&(_sc)->sc_mtx)
121 #define MMCSD_LOCK_INIT(_sc) \
122         mtx_init(&_sc->sc_mtx, device_get_nameunit(_sc->dev), \
123             "mmcsd", MTX_DEF)
124 #define MMCSD_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx);
125 #define MMCSD_ASSERT_LOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED);
126 #define MMCSD_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED);
127
128 static int
129 mmcsd_probe(device_t dev)
130 {
131
132         device_quiet(dev);
133         device_set_desc(dev, "MMC/SD Memory Card");
134         return (0);
135 }
136
137 static int
138 mmcsd_attach(device_t dev)
139 {
140         struct mmcsd_softc *sc;
141         struct disk *d;
142         intmax_t mb;
143         uint32_t speed;
144         uint32_t maxblocks;
145         char unit;
146
147         sc = device_get_softc(dev);
148         sc->dev = dev;
149         MMCSD_LOCK_INIT(sc);
150
151         d = sc->disk = disk_alloc();
152         d->d_open = mmcsd_open;
153         d->d_close = mmcsd_close;
154         d->d_strategy = mmcsd_strategy;
155         d->d_dump = mmcsd_dump;
156         d->d_name = "mmcsd";
157         d->d_drv1 = sc;
158         d->d_maxsize = 4*1024*1024;     /* Maximum defined SD card AU size. */
159         d->d_sectorsize = mmc_get_sector_size(dev);
160         d->d_mediasize = (off_t)mmc_get_media_size(dev) * d->d_sectorsize;
161         d->d_stripeoffset = 0;
162         d->d_stripesize = mmc_get_erase_sector(dev) * d->d_sectorsize;
163         d->d_unit = device_get_unit(dev);
164         d->d_flags = DISKFLAG_CANDELETE;
165         d->d_delmaxsize = mmc_get_erase_sector(dev) * d->d_sectorsize * 1; /* conservative */
166         /*
167          * Display in most natural units.  There's no cards < 1MB.  The SD
168          * standard goes to 2GiB due to its reliance on FAT, but the data
169          * format supports up to 4GiB and some card makers push it up to this
170          * limit.  The SDHC standard only goes to 32GiB due to FAT32, but the
171          * data format supports up to 2TiB however. 2048GB isn't too ugly, so
172          * we note it in passing here and don't add the code to print
173          * TB). Since these cards are sold in terms of MB and GB not MiB and
174          * GiB, report them like that. We also round to the nearest unit, since
175          * many cards are a few percent short, even of the power of 10 size.
176          */
177         mb = (d->d_mediasize + 1000000 / 2 - 1) / 1000000;
178         unit = 'M';
179         if (mb >= 1000) {
180                 unit = 'G';
181                 mb = (mb + 1000 / 2 - 1) / 1000;
182         }
183         /*
184          * Report the clock speed of the underlying hardware, which might be
185          * different than what the card reports due to hardware limitations.
186          * Report how many blocks the hardware transfers at once.
187          */
188         speed = mmcbr_get_clock(device_get_parent(dev));
189         maxblocks = mmc_get_max_data(dev);
190         device_printf(dev, "%ju%cB <%s>%s at %s %d.%01dMHz/%dbit/%d-block\n",
191             mb, unit, mmc_get_card_id_string(dev),
192             mmc_get_read_only(dev) ? " (read-only)" : "",
193             device_get_nameunit(device_get_parent(dev)),
194             speed / 1000000, (speed / 100000) % 10,
195             mmcsd_bus_bit_width(dev), maxblocks);
196         disk_create(d, DISK_VERSION);
197         bioq_init(&sc->bio_queue);
198
199         sc->running = 1;
200         sc->suspend = 0;
201         sc->eblock = sc->eend = 0;
202         kproc_create(&mmcsd_task, sc, &sc->p, 0, 0, "%s: mmc/sd card", 
203             device_get_nameunit(dev));
204
205         return (0);
206 }
207
208 static int
209 mmcsd_detach(device_t dev)
210 {
211         struct mmcsd_softc *sc = device_get_softc(dev);
212
213         MMCSD_LOCK(sc);
214         sc->suspend = 0;
215         if (sc->running > 0) {
216                 /* kill thread */
217                 sc->running = 0;
218                 wakeup(sc);
219                 /* wait for thread to finish. */
220                 while (sc->running != -1)
221                         msleep(sc, &sc->sc_mtx, 0, "detach", 0);
222         }
223         MMCSD_UNLOCK(sc);
224
225         /* Flush the request queue. */
226         bioq_flush(&sc->bio_queue, NULL, ENXIO);
227         /* kill disk */
228         disk_destroy(sc->disk);
229
230         MMCSD_LOCK_DESTROY(sc);
231
232         return (0);
233 }
234
235 static int
236 mmcsd_suspend(device_t dev)
237 {
238         struct mmcsd_softc *sc = device_get_softc(dev);
239
240         MMCSD_LOCK(sc);
241         sc->suspend = 1;
242         if (sc->running > 0) {
243                 /* kill thread */
244                 sc->running = 0;
245                 wakeup(sc);
246                 /* wait for thread to finish. */
247                 while (sc->running != -1)
248                         msleep(sc, &sc->sc_mtx, 0, "detach", 0);
249         }
250         MMCSD_UNLOCK(sc);
251         return (0);
252 }
253
254 static int
255 mmcsd_resume(device_t dev)
256 {
257         struct mmcsd_softc *sc = device_get_softc(dev);
258
259         MMCSD_LOCK(sc);
260         sc->suspend = 0;
261         if (sc->running <= 0) {
262                 sc->running = 1;
263                 MMCSD_UNLOCK(sc);
264                 kproc_create(&mmcsd_task, sc, &sc->p, 0, 0, "%s: mmc/sd card",
265                     device_get_nameunit(dev));
266         } else
267                 MMCSD_UNLOCK(sc);
268         return (0);
269 }
270
271 static int
272 mmcsd_open(struct disk *dp)
273 {
274
275         return (0);
276 }
277
278 static int
279 mmcsd_close(struct disk *dp)
280 {
281
282         return (0);
283 }
284
285 static void
286 mmcsd_strategy(struct bio *bp)
287 {
288         struct mmcsd_softc *sc;
289
290         sc = (struct mmcsd_softc *)bp->bio_disk->d_drv1;
291         MMCSD_LOCK(sc);
292         if (sc->running > 0 || sc->suspend > 0) {
293                 bioq_disksort(&sc->bio_queue, bp);
294                 MMCSD_UNLOCK(sc);
295                 wakeup(sc);
296         } else {
297                 MMCSD_UNLOCK(sc);
298                 biofinish(bp, NULL, ENXIO);
299         }
300 }
301
302 static const char *
303 mmcsd_errmsg(int e)
304 {
305         if (e < 0 || e > MMC_ERR_MAX)
306                 return "Bad error code";
307         return errmsg[e];
308 }
309
310 static daddr_t
311 mmcsd_rw(struct mmcsd_softc *sc, struct bio *bp)
312 {
313         daddr_t block, end;
314         struct mmc_command cmd;
315         struct mmc_command stop;
316         struct mmc_request req;
317         struct mmc_data data;
318         device_t dev = sc->dev;
319         int sz = sc->disk->d_sectorsize;
320         device_t mmcbr = device_get_parent(dev);
321
322         block = bp->bio_pblkno;
323         end = bp->bio_pblkno + (bp->bio_bcount / sz);
324         while (block < end) {
325                 char *vaddr = bp->bio_data +
326                     (block - bp->bio_pblkno) * sz;
327                 int numblocks = min(end - block, mmc_get_max_data(dev));
328                 memset(&req, 0, sizeof(req));
329                 memset(&cmd, 0, sizeof(cmd));
330                 memset(&stop, 0, sizeof(stop));
331                 memset(&data, 0, sizeof(data));
332                 cmd.mrq = &req;
333                 req.cmd = &cmd;
334                 cmd.data = &data;
335                 if (bp->bio_cmd == BIO_READ) {
336                         if (numblocks > 1)
337                                 cmd.opcode = MMC_READ_MULTIPLE_BLOCK;
338                         else
339                                 cmd.opcode = MMC_READ_SINGLE_BLOCK;
340                 } else {
341                         if (numblocks > 1)
342                                 cmd.opcode = MMC_WRITE_MULTIPLE_BLOCK;
343                         else
344                                 cmd.opcode = MMC_WRITE_BLOCK;
345                 }
346                 cmd.arg = block;
347                 if (!mmc_get_high_cap(dev))
348                         cmd.arg <<= 9;
349                 cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC;
350                 data.data = vaddr;
351                 data.mrq = &req;
352                 if (bp->bio_cmd == BIO_READ)
353                         data.flags = MMC_DATA_READ;
354                 else
355                         data.flags = MMC_DATA_WRITE;
356                 data.len = numblocks * sz;
357                 if (numblocks > 1) {
358                         data.flags |= MMC_DATA_MULTI;
359                         stop.opcode = MMC_STOP_TRANSMISSION;
360                         stop.arg = 0;
361                         stop.flags = MMC_RSP_R1B | MMC_CMD_AC;
362                         stop.mrq = &req;
363                         req.stop = &stop;
364                 }
365                 MMCBUS_WAIT_FOR_REQUEST(mmcbr, dev, &req);
366                 if (req.cmd->error != MMC_ERR_NONE) {
367                         device_printf(dev, "Error indicated: %d %s\n",
368                             req.cmd->error, mmcsd_errmsg(req.cmd->error));
369                         break;
370                 }
371                 block += numblocks;
372         }
373         return (block);
374 }
375
376 static daddr_t
377 mmcsd_delete(struct mmcsd_softc *sc, struct bio *bp)
378 {
379         daddr_t block, end, start, stop;
380         struct mmc_command cmd;
381         struct mmc_request req;
382         device_t dev = sc->dev;
383         int sz = sc->disk->d_sectorsize;
384         int erase_sector;
385         device_t mmcbr = device_get_parent(dev);
386
387         block = bp->bio_pblkno;
388         end = bp->bio_pblkno + (bp->bio_bcount / sz);
389         /* Coalesce with part remaining from previous request. */
390         if (block > sc->eblock && block <= sc->eend)
391                 block = sc->eblock;
392         if (end >= sc->eblock && end < sc->eend)
393                 end = sc->eend;
394         /* Safe round to the erase sector boundaries. */
395         erase_sector = mmc_get_erase_sector(dev);
396         start = block + erase_sector - 1;        /* Round up. */
397         start -= start % erase_sector;
398         stop = end;                             /* Round down. */
399         stop -= end % erase_sector;      
400         /* We can't erase area smaller then sector, store it for later. */
401         if (start >= stop) {
402                 sc->eblock = block;
403                 sc->eend = end;
404                 return (end);
405         }
406
407         /* Set erase start position. */
408         memset(&req, 0, sizeof(req));
409         memset(&cmd, 0, sizeof(cmd));
410         cmd.mrq = &req;
411         req.cmd = &cmd;
412         if (mmc_get_card_type(dev) == mode_sd)
413                 cmd.opcode = SD_ERASE_WR_BLK_START;
414         else
415                 cmd.opcode = MMC_ERASE_GROUP_START;
416         cmd.arg = start;
417         if (!mmc_get_high_cap(dev))
418                 cmd.arg <<= 9;
419         cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
420         MMCBUS_WAIT_FOR_REQUEST(mmcbr, dev, &req);
421         if (req.cmd->error != MMC_ERR_NONE) {
422             printf("erase err1: %d\n", req.cmd->error);
423             return (block);
424         }
425         /* Set erase stop position. */
426         memset(&req, 0, sizeof(req));
427         memset(&cmd, 0, sizeof(cmd));
428         req.cmd = &cmd;
429         if (mmc_get_card_type(dev) == mode_sd)
430                 cmd.opcode = SD_ERASE_WR_BLK_END;
431         else
432                 cmd.opcode = MMC_ERASE_GROUP_END;
433         cmd.arg = stop;
434         if (!mmc_get_high_cap(dev))
435                 cmd.arg <<= 9;
436         cmd.arg--;
437         cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
438         MMCBUS_WAIT_FOR_REQUEST(mmcbr, dev, &req);
439         if (req.cmd->error != MMC_ERR_NONE) {
440             printf("erase err2: %d\n", req.cmd->error);
441             return (block);
442         }
443         /* Erase range. */
444         memset(&req, 0, sizeof(req));
445         memset(&cmd, 0, sizeof(cmd));
446         req.cmd = &cmd;
447         cmd.opcode = MMC_ERASE;
448         cmd.arg = 0;
449         cmd.flags = MMC_RSP_R1B | MMC_CMD_AC;
450         MMCBUS_WAIT_FOR_REQUEST(mmcbr, dev, &req);
451         if (req.cmd->error != MMC_ERR_NONE) {
452             printf("erase err3 %d\n", req.cmd->error);
453             return (block);
454         }
455         /* Store one of remaining parts for the next call. */
456         if (bp->bio_pblkno >= sc->eblock || block == start) {
457                 sc->eblock = stop;      /* Predict next forward. */
458                 sc->eend = end;
459         } else {
460                 sc->eblock = block;     /* Predict next backward. */
461                 sc->eend = start;
462         }
463         return (end);
464 }
465
466 static int
467 mmcsd_dump(void *arg, void *virtual, vm_offset_t physical,
468         off_t offset, size_t length)
469 {
470         struct disk *disk = arg;
471         struct mmcsd_softc *sc = (struct mmcsd_softc *)disk->d_drv1;
472         device_t dev = sc->dev;
473         struct bio bp;
474         daddr_t block, end;
475         device_t mmcbr = device_get_parent(dev);
476
477         /* length zero is special and really means flush buffers to media */
478         if (!length)
479                 return (0);
480
481         bzero(&bp, sizeof(struct bio));
482         bp.bio_disk = disk;
483         bp.bio_pblkno = offset / disk->d_sectorsize;
484         bp.bio_bcount = length;
485         bp.bio_data = virtual;
486         bp.bio_cmd = BIO_WRITE;
487         end = bp.bio_pblkno + bp.bio_bcount / sc->disk->d_sectorsize;
488         MMCBUS_ACQUIRE_BUS(mmcbr, dev);
489         block = mmcsd_rw(sc, &bp);
490         MMCBUS_RELEASE_BUS(mmcbr, dev);
491         return ((end < block) ? EIO : 0);
492 }
493
494 static void
495 mmcsd_task(void *arg)
496 {
497         struct mmcsd_softc *sc = (struct mmcsd_softc*)arg;
498         struct bio *bp;
499         int sz;
500         daddr_t block, end;
501         device_t dev = sc->dev;
502         device_t mmcbr = device_get_parent(sc->dev);
503
504         while (1) {
505                 MMCSD_LOCK(sc);
506                 do {
507                         if (sc->running == 0)
508                                 goto out;
509                         bp = bioq_takefirst(&sc->bio_queue);
510                         if (bp == NULL)
511                                 msleep(sc, &sc->sc_mtx, PRIBIO, "jobqueue", 0);
512                 } while (bp == NULL);
513                 MMCSD_UNLOCK(sc);
514                 if (bp->bio_cmd != BIO_READ && mmc_get_read_only(dev)) {
515                         bp->bio_error = EROFS;
516                         bp->bio_resid = bp->bio_bcount;
517                         bp->bio_flags |= BIO_ERROR;
518                         biodone(bp);
519                         continue;
520                 }
521                 MMCBUS_ACQUIRE_BUS(mmcbr, dev);
522                 sz = sc->disk->d_sectorsize;
523                 block = bp->bio_pblkno;
524                 end = bp->bio_pblkno + (bp->bio_bcount / sz);
525                 if (bp->bio_cmd == BIO_READ || bp->bio_cmd == BIO_WRITE) {
526                         /* Access to the remaining erase block obsoletes it. */
527                         if (block < sc->eend && end > sc->eblock)
528                                 sc->eblock = sc->eend = 0;
529                         block = mmcsd_rw(sc, bp);
530                 } else if (bp->bio_cmd == BIO_DELETE) {
531                         block = mmcsd_delete(sc, bp);
532                 }
533                 MMCBUS_RELEASE_BUS(mmcbr, dev);
534                 if (block < end) {
535                         bp->bio_error = EIO;
536                         bp->bio_resid = (end - block) * sz;
537                         bp->bio_flags |= BIO_ERROR;
538                 }
539                 biodone(bp);
540         }
541 out:
542         /* tell parent we're done */
543         sc->running = -1;
544         MMCSD_UNLOCK(sc);
545         wakeup(sc);
546
547         kproc_exit(0);
548 }
549
550 static int
551 mmcsd_bus_bit_width(device_t dev)
552 {
553
554         if (mmc_get_bus_width(dev) == bus_width_1)
555                 return (1);
556         if (mmc_get_bus_width(dev) == bus_width_4)
557                 return (4);
558         return (8);
559 }
560
561 static device_method_t mmcsd_methods[] = {
562         DEVMETHOD(device_probe, mmcsd_probe),
563         DEVMETHOD(device_attach, mmcsd_attach),
564         DEVMETHOD(device_detach, mmcsd_detach),
565         DEVMETHOD(device_suspend, mmcsd_suspend),
566         DEVMETHOD(device_resume, mmcsd_resume),
567         DEVMETHOD_END
568 };
569
570 static driver_t mmcsd_driver = {
571         "mmcsd",
572         mmcsd_methods,
573         sizeof(struct mmcsd_softc),
574 };
575 static devclass_t mmcsd_devclass;
576
577 DRIVER_MODULE(mmcsd, mmc, mmcsd_driver, mmcsd_devclass, NULL, NULL);