2 * Copyright (c) 2006 Bernd Walter. All rights reserved.
3 * Copyright (c) 2006 M. Warner Losh. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
25 * Portions of this software may have been developed with reference to
26 * the SD Simplified Specification. The following disclaimer may apply:
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.
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.
52 * $FreeBSD: src/sys/dev/mmc/mmcsd.c,v 1.20 2009/02/17 19:17:25 mav Exp $
55 #include <sys/param.h>
56 #include <sys/systm.h>
61 #include <sys/device.h>
62 #include <sys/devicestat.h>
63 #include <sys/kernel.h>
64 #include <sys/kthread.h>
66 #include <sys/malloc.h>
67 #include <sys/module.h>
68 #include <sys/spinlock.h>
72 #include <bus/mmc/mmcvar.h>
73 #include <bus/mmc/mmcreg.h>
75 #include "mmcbus_if.h"
82 struct devstat device_stats;
84 struct bio_queue_head bio_queue;
85 daddr_t eblock, eend; /* Range remaining after the last erase. */
90 /* bus entry points */
91 static int mmcsd_probe(device_t dev);
92 static int mmcsd_attach(device_t dev);
93 static int mmcsd_detach(device_t dev);
96 static d_open_t mmcsd_open;
97 static d_close_t mmcsd_close;
98 static d_strategy_t mmcsd_strategy;
99 static d_dump_t mmcsd_dump;
101 static void mmcsd_task(void *arg);
103 static const char *mmcsd_card_name(device_t dev);
104 static int mmcsd_bus_bit_width(device_t dev);
106 #define MMCSD_LOCK(_sc) lockmgr(&(_sc)->sc_lock, LK_EXCLUSIVE)
107 #define MMCSD_UNLOCK(_sc) lockmgr(&(_sc)->sc_lock, LK_RELEASE)
108 #define MMCSD_LOCK_INIT(_sc) lockinit(&(_sc)->sc_lock, "mmcsd", 0, LK_CANRECURSE)
109 #define MMCSD_LOCK_DESTROY(_sc) lockuninit(&(_sc)->sc_lock);
110 #define MMCSD_ASSERT_LOCKED(_sc) KKASSERT(lockstatus(&(_sc)->sc_lock, curthread) != 0);
111 #define MMCSD_ASSERT_UNLOCKED(_sc) KKASSERT(lockstatus(&(_sc)->sc_lock, curthread) == 0);
113 static struct dev_ops mmcsd_ops = {
114 { "mmcsd", 0, D_DISK | D_MPSAFE },
115 .d_open = mmcsd_open,
116 .d_close = mmcsd_close,
117 .d_strategy = mmcsd_strategy,
118 .d_dump = mmcsd_dump,
122 mmcsd_probe(device_t dev)
126 device_set_desc(dev, "MMC/SD Memory Card");
131 mmcsd_attach(device_t dev)
133 struct mmcsd_softc *sc;
134 struct disk_info info;
140 sc = device_get_softc(dev);
144 sector_size = mmc_get_sector_size(dev);
145 devstat_add_entry(&sc->device_stats, "mmcsd", device_get_unit(dev),
146 sector_size, DEVSTAT_NO_ORDERED_TAGS,
147 DEVSTAT_TYPE_DIRECT | DEVSTAT_TYPE_IF_OTHER,
148 DEVSTAT_PRIORITY_DISK);
150 bioq_init(&sc->bio_queue);
154 sc->eblock = sc->eend = 0;
155 kthread_create(mmcsd_task, sc, &sc->td, "mmc/sd card task");
160 bzero(&info, sizeof(info));
161 info.d_media_blksize = sector_size;
162 info.d_media_blocks = mmc_get_media_size(dev);
163 info.d_secpertrack = 1024;
165 info.d_secpercyl = info.d_secpertrack * info.d_nheads;
166 info.d_ncylinders = (u_int)(info.d_media_blocks / info.d_secpercyl);
169 * Display in most natural units. There's no cards < 1MB.
170 * The SD standard goes to 2GiB, but the data format supports
171 * up to 4GiB and some card makers push it up to this limit.
172 * The SDHC standard only goes to 32GiB (the data format in
173 * SDHC is good to 2TiB however, which isn't too ugly at
174 * 2048GiBm, so we note it in passing here and don't add the
175 * code to print TiB).
179 mb = (info.d_media_blksize * info.d_media_blocks) >> 20;
181 if (mb >= 10240) { /* 1GiB = 1024 MiB */
186 device_printf(dev, "%ju%cB <%s Memory Card>%s at %s %dMHz/%dbit\n",
187 mb, unit, mmcsd_card_name(dev),
188 mmc_get_read_only(dev) ? " (read-only)" : "",
189 device_get_nameunit(device_get_parent(dev)),
190 mmc_get_tran_speed(dev) / 1000000, mmcsd_bus_bit_width(dev));
193 * SC is fully initialized, we can attach the drive now. The
194 * instant we do the kernel will start probing it.
196 dsk = disk_create(device_get_unit(dev), &sc->disk, &mmcsd_ops);
200 /* Maximum defined SD card AU size. */
201 dsk->si_iosize_max = 4*1024*1024;
203 disk_setdiskinfo(&sc->disk, &info);
209 mmcsd_detach(device_t dev)
211 struct mmcsd_softc *sc = device_get_softc(dev);
217 if (sc->running > 0) {
221 /* wait for thread to finish. */
222 while (sc->running != -1)
223 lksleep(sc, &sc->sc_lock, 0, "detach", 0);
228 * Flush the request queue.
230 * XXX: Return all queued I/O with ENXIO. Is this correct?
232 while ((q_bio = bioq_takefirst(&sc->bio_queue)) != NULL) {
233 q_bp = q_bio->bio_buf;
234 q_bp->b_resid = q_bp->b_bcount;
235 q_bp->b_error = ENXIO;
236 q_bp->b_flags |= B_ERROR;
241 disk_destroy(&sc->disk);
242 devstat_remove_entry(&sc->device_stats);
244 MMCSD_LOCK_DESTROY(sc);
250 mmcsd_suspend(device_t dev)
252 struct mmcsd_softc *sc = device_get_softc(dev);
256 if (sc->running > 0) {
260 /* wait for thread to finish. */
261 while (sc->running != -1)
262 lksleep(sc, &sc->sc_lock, 0, "detach", 0);
269 mmcsd_resume(device_t dev)
271 struct mmcsd_softc *sc = device_get_softc(dev);
275 if (sc->running <= 0) {
278 kthread_create(mmcsd_task, sc, &sc->td, "mmc/sd card task");
285 mmcsd_open(struct dev_open_args *ap)
291 mmcsd_close(struct dev_close_args *ap)
297 mmcsd_strategy(struct dev_strategy_args *ap)
299 struct mmcsd_softc *sc;
300 struct bio *bio = ap->a_bio;
301 struct buf *bp = bio->bio_buf;
303 sc = (struct mmcsd_softc *)ap->a_head.a_dev->si_drv1;
305 if (sc->running > 0 || sc->suspend > 0) {
306 bioqdisksort(&sc->bio_queue, bio);
312 bp->b_flags |= B_ERROR;
313 bp->b_resid = bp->b_bcount;
320 mmcsd_rw(struct mmcsd_softc *sc, struct bio *bio)
323 struct mmc_command cmd;
324 struct mmc_command stop;
325 struct mmc_request req;
326 struct mmc_data data;
327 device_t dev = sc->dev;
328 int sz = sc->disk.d_info.d_media_blksize;
329 struct buf *bp = bio->bio_buf;
331 block = bio->bio_offset / sz;
332 end = block + (bp->b_bcount / sz);
333 while (block < end) {
334 char *vaddr = bp->b_data +
335 (block - (bio->bio_offset / sz)) * sz;
336 int numblocks = min(end - block, mmc_get_max_data(dev));
337 memset(&req, 0, sizeof(req));
338 memset(&cmd, 0, sizeof(cmd));
339 memset(&stop, 0, sizeof(stop));
342 if (bp->b_cmd == BUF_CMD_READ) {
344 cmd.opcode = MMC_READ_MULTIPLE_BLOCK;
346 cmd.opcode = MMC_READ_SINGLE_BLOCK;
349 cmd.opcode = MMC_WRITE_MULTIPLE_BLOCK;
351 cmd.opcode = MMC_WRITE_BLOCK;
354 if (!mmc_get_high_cap(dev))
356 cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC;
359 if (bp->b_cmd == BUF_CMD_READ)
360 data.flags = MMC_DATA_READ;
362 data.flags = MMC_DATA_WRITE;
363 data.len = numblocks * sz;
365 data.flags |= MMC_DATA_MULTI;
366 stop.opcode = MMC_STOP_TRANSMISSION;
368 stop.flags = MMC_RSP_R1B | MMC_CMD_AC;
371 // kprintf("Len %d %lld-%lld flags %#x sz %d\n",
372 // (int)data.len, (long long)block, (long long)end, data.flags, sz);
373 MMCBUS_WAIT_FOR_REQUEST(device_get_parent(dev), dev, &req);
374 if (req.cmd->error != MMC_ERR_NONE)
382 mmcsd_delete(struct mmcsd_softc *sc, struct bio *bio)
384 daddr_t block, end, start, stop;
385 struct mmc_command cmd;
386 struct mmc_request req;
387 device_t dev = sc->dev;
388 int sz = sc->disk.d_info.d_media_blksize;
390 struct buf *bp = bio->bio_buf;
392 block = bio->bio_offset / sz;
393 end = block + (bp->b_bcount / sz);
394 /* Coalesce with part remaining from previous request. */
395 if (block > sc->eblock && block <= sc->eend)
397 if (end >= sc->eblock && end < sc->eend)
399 /* Safe round to the erase sector boundaries. */
400 erase_sector = mmc_get_erase_sector(dev);
401 start = block + erase_sector - 1; /* Round up. */
402 start -= start % erase_sector;
403 stop = end; /* Round down. */
404 stop -= end % erase_sector;
405 /* We can't erase area smaller then sector, store it for later. */
412 /* Set erase start position. */
413 memset(&req, 0, sizeof(req));
414 memset(&cmd, 0, sizeof(cmd));
416 if (mmc_get_card_type(dev) == mode_sd)
417 cmd.opcode = SD_ERASE_WR_BLK_START;
419 cmd.opcode = MMC_ERASE_GROUP_START;
421 if (!mmc_get_high_cap(dev))
423 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
424 MMCBUS_WAIT_FOR_REQUEST(device_get_parent(dev), dev, &req);
425 if (req.cmd->error != MMC_ERR_NONE) {
426 kprintf("erase err1: %d\n", req.cmd->error);
429 /* Set erase stop position. */
430 memset(&req, 0, sizeof(req));
431 memset(&cmd, 0, sizeof(cmd));
433 if (mmc_get_card_type(dev) == mode_sd)
434 cmd.opcode = SD_ERASE_WR_BLK_END;
436 cmd.opcode = MMC_ERASE_GROUP_END;
438 if (!mmc_get_high_cap(dev))
441 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
442 MMCBUS_WAIT_FOR_REQUEST(device_get_parent(dev), dev, &req);
443 if (req.cmd->error != MMC_ERR_NONE) {
444 kprintf("erase err2: %d\n", req.cmd->error);
448 memset(&req, 0, sizeof(req));
449 memset(&cmd, 0, sizeof(cmd));
451 cmd.opcode = MMC_ERASE;
453 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC;
454 MMCBUS_WAIT_FOR_REQUEST(device_get_parent(dev), dev, &req);
455 if (req.cmd->error != MMC_ERR_NONE) {
456 kprintf("erase err3 %d\n", req.cmd->error);
459 /* Store one of remaining parts for the next call. */
460 if ((bio->bio_offset / sz) >= sc->eblock || block == start) {
461 sc->eblock = stop; /* Predict next forward. */
464 sc->eblock = block; /* Predict next backward. */
471 mmcsd_dump(struct dev_dump_args *ap)
474 cdev_t cdev = ap->a_head.a_dev;
475 struct mmcsd_softc *sc = (struct mmcsd_softc *)cdev->si_drv1;
476 device_t dev = sc->dev;
479 int length = ap->a_length;
481 /* length zero is special and really means flush buffers to media */
485 bzero(&bp, sizeof(struct bio));
486 bp.bio_driver_info = cdev;
487 bp.bio_pblkno = offset / sc->disk->d_sectorsize;
488 bp.bio_bcount = length;
489 bp.bio_data = virtual;
490 bp.bio_cmd = BIO_WRITE;
491 end = bp.bio_pblkno + bp.bio_bcount / sc->disk.d_info.d_media_blksize;
492 MMCBUS_ACQUIRE_BUS(device_get_parent(dev), dev);
493 block = mmcsd_rw(sc, &bp);
494 MMCBUS_RELEASE_BUS(device_get_parent(dev), dev);
495 return ((end < block) ? EIO : 0);
501 mmcsd_task(void *arg)
503 struct mmcsd_softc *sc = (struct mmcsd_softc*)arg;
515 if (sc->running == 0)
517 bio = bioq_takefirst(&sc->bio_queue);
519 lksleep(sc, &sc->sc_lock, 0, "jobqueue", 0);
520 } while (bio == NULL);
523 devstat_start_transaction(&sc->device_stats);
524 if (bp->b_cmd != BUF_CMD_READ && mmc_get_read_only(dev)) {
526 bp->b_resid = bp->b_bcount;
527 bp->b_flags |= B_ERROR;
528 devstat_end_transaction_buf(&sc->device_stats, bp);
532 MMCBUS_ACQUIRE_BUS(device_get_parent(dev), dev);
533 sz = sc->disk.d_info.d_media_blksize;
534 block = bio->bio_offset / sz;
535 end = block + (bp->b_bcount / sz);
536 if (bp->b_cmd == BUF_CMD_READ ||
537 bp->b_cmd == BUF_CMD_WRITE) {
538 /* Access to the remaining erase block obsoletes it. */
539 if (block < sc->eend && end > sc->eblock)
540 sc->eblock = sc->eend = 0;
541 block = mmcsd_rw(sc, bio);
542 } else if (bp->b_cmd == BUF_CMD_FREEBLKS) {
543 block = mmcsd_delete(sc, bio);
545 MMCBUS_RELEASE_BUS(device_get_parent(dev), dev);
548 bp->b_resid = (end - block) * sz;
549 bp->b_flags |= B_ERROR;
553 devstat_end_transaction_buf(&sc->device_stats, bp);
557 /* tell parent we're done */
564 mmcsd_card_name(device_t dev)
566 if (mmc_get_card_type(dev) == mode_mmc)
568 if (mmc_get_high_cap(dev))
574 mmcsd_bus_bit_width(device_t dev)
576 if (mmc_get_bus_width(dev) == bus_width_1)
578 if (mmc_get_bus_width(dev) == bus_width_4)
583 static device_method_t mmcsd_methods[] = {
584 DEVMETHOD(device_probe, mmcsd_probe),
585 DEVMETHOD(device_attach, mmcsd_attach),
586 DEVMETHOD(device_detach, mmcsd_detach),
587 DEVMETHOD(device_suspend, mmcsd_suspend),
588 DEVMETHOD(device_resume, mmcsd_resume),
592 static driver_t mmcsd_driver = {
595 sizeof(struct mmcsd_softc),
597 static devclass_t mmcsd_devclass;
599 DRIVER_MODULE(mmcsd, mmc, mmcsd_driver, mmcsd_devclass, NULL, NULL);