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 strlcpy(d->d_ident, mmc_get_card_sn_string(dev), sizeof(d->d_ident)); 167 strlcpy(d->d_descr, mmc_get_card_id_string(dev), sizeof(d->d_descr)); 168 169 /* 170 * Display in most natural units. There's no cards < 1MB. The SD 171 * standard goes to 2GiB due to its reliance on FAT, but the data 172 * format supports up to 4GiB and some card makers push it up to this 173 * limit. The SDHC standard only goes to 32GiB due to FAT32, but the 174 * data format supports up to 2TiB however. 2048GB isn't too ugly, so 175 * we note it in passing here and don't add the code to print 176 * TB). Since these cards are sold in terms of MB and GB not MiB and 177 * GiB, report them like that. We also round to the nearest unit, since 178 * many cards are a few percent short, even of the power of 10 size. 179 */ 180 mb = (d->d_mediasize + 1000000 / 2 - 1) / 1000000; 181 unit = 'M'; 182 if (mb >= 1000) { 183 unit = 'G'; 184 mb = (mb + 1000 / 2 - 1) / 1000; 185 } 186 /* 187 * Report the clock speed of the underlying hardware, which might be 188 * different than what the card reports due to hardware limitations. 189 * Report how many blocks the hardware transfers at once. 190 */ 191 speed = mmcbr_get_clock(device_get_parent(dev)); 192 maxblocks = mmc_get_max_data(dev); 193 device_printf(dev, "%ju%cB <%s>%s at %s %d.%01dMHz/%dbit/%d-block\n", 194 mb, unit, d->d_descr, 195 mmc_get_read_only(dev) ? " (read-only)" : "", 196 device_get_nameunit(device_get_parent(dev)), 197 speed / 1000000, (speed / 100000) % 10, 198 mmcsd_bus_bit_width(dev), maxblocks); 199 disk_create(d, DISK_VERSION); 200 bioq_init(&sc->bio_queue); 201 202 sc->running = 1; 203 sc->suspend = 0; 204 sc->eblock = sc->eend = 0; 205 kproc_create(&mmcsd_task, sc, &sc->p, 0, 0, "%s: mmc/sd card", 206 device_get_nameunit(dev)); 207 208 return (0); 209 } 210 211 static int 212 mmcsd_detach(device_t dev) 213 { 214 struct mmcsd_softc *sc = device_get_softc(dev); 215 216 MMCSD_LOCK(sc); 217 sc->suspend = 0; 218 if (sc->running > 0) { 219 /* kill thread */ 220 sc->running = 0; 221 wakeup(sc); 222 /* wait for thread to finish. */ 223 while (sc->running != -1) 224 msleep(sc, &sc->sc_mtx, 0, "detach", 0); 225 } 226 MMCSD_UNLOCK(sc); 227 228 /* Flush the request queue. */ 229 bioq_flush(&sc->bio_queue, NULL, ENXIO); 230 /* kill disk */ 231 disk_destroy(sc->disk); 232 233 MMCSD_LOCK_DESTROY(sc); 234 235 return (0); 236 } 237 238 static int 239 mmcsd_suspend(device_t dev) 240 { 241 struct mmcsd_softc *sc = device_get_softc(dev); 242 243 MMCSD_LOCK(sc); 244 sc->suspend = 1; 245 if (sc->running > 0) { 246 /* kill thread */ 247 sc->running = 0; 248 wakeup(sc); 249 /* wait for thread to finish. */ 250 while (sc->running != -1) 251 msleep(sc, &sc->sc_mtx, 0, "detach", 0); 252 } 253 MMCSD_UNLOCK(sc); 254 return (0); 255 } 256 257 static int 258 mmcsd_resume(device_t dev) 259 { 260 struct mmcsd_softc *sc = device_get_softc(dev); 261 262 MMCSD_LOCK(sc); 263 sc->suspend = 0; 264 if (sc->running <= 0) { 265 sc->running = 1; 266 MMCSD_UNLOCK(sc); 267 kproc_create(&mmcsd_task, sc, &sc->p, 0, 0, "%s: mmc/sd card", 268 device_get_nameunit(dev)); 269 } else 270 MMCSD_UNLOCK(sc); 271 return (0); 272 } 273 274 static int 275 mmcsd_open(struct disk *dp) 276 { 277 278 return (0); 279 } 280 281 static int 282 mmcsd_close(struct disk *dp) 283 { 284 285 return (0); 286 } 287 288 static void 289 mmcsd_strategy(struct bio *bp) 290 { 291 struct mmcsd_softc *sc; 292 293 sc = (struct mmcsd_softc *)bp->bio_disk->d_drv1; 294 MMCSD_LOCK(sc); 295 if (sc->running > 0 || sc->suspend > 0) { 296 bioq_disksort(&sc->bio_queue, bp); 297 MMCSD_UNLOCK(sc); 298 wakeup(sc); 299 } else { 300 MMCSD_UNLOCK(sc); 301 biofinish(bp, NULL, ENXIO); 302 } 303 } 304 305 static const char * 306 mmcsd_errmsg(int e) 307 { 308 if (e < 0 || e > MMC_ERR_MAX) 309 return "Bad error code"; 310 return errmsg[e]; 311 } 312 313 static daddr_t 314 mmcsd_rw(struct mmcsd_softc *sc, struct bio *bp) 315 { 316 daddr_t block, end; 317 struct mmc_command cmd; 318 struct mmc_command stop; 319 struct mmc_request req; 320 struct mmc_data data; 321 device_t dev = sc->dev; 322 int sz = sc->disk->d_sectorsize; 323 device_t mmcbr = device_get_parent(dev); 324 325 block = bp->bio_pblkno; 326 end = bp->bio_pblkno + (bp->bio_bcount / sz); 327 while (block < end) { 328 char *vaddr = bp->bio_data + 329 (block - bp->bio_pblkno) * sz; 330 int numblocks = min(end - block, mmc_get_max_data(dev)); 331 memset(&req, 0, sizeof(req)); 332 memset(&cmd, 0, sizeof(cmd)); 333 memset(&stop, 0, sizeof(stop)); 334 memset(&data, 0, sizeof(data)); 335 cmd.mrq = &req; 336 req.cmd = &cmd; 337 cmd.data = &data; 338 if (bp->bio_cmd == BIO_READ) { 339 if (numblocks > 1) 340 cmd.opcode = MMC_READ_MULTIPLE_BLOCK; 341 else 342 cmd.opcode = MMC_READ_SINGLE_BLOCK; 343 } else { 344 if (numblocks > 1) 345 cmd.opcode = MMC_WRITE_MULTIPLE_BLOCK; 346 else 347 cmd.opcode = MMC_WRITE_BLOCK; 348 } 349 cmd.arg = block; 350 if (!mmc_get_high_cap(dev)) 351 cmd.arg <<= 9; 352 cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC; 353 data.data = vaddr; 354 data.mrq = &req; 355 if (bp->bio_cmd == BIO_READ) 356 data.flags = MMC_DATA_READ; 357 else 358 data.flags = MMC_DATA_WRITE; 359 data.len = numblocks * sz; 360 if (numblocks > 1) { 361 data.flags |= MMC_DATA_MULTI; 362 stop.opcode = MMC_STOP_TRANSMISSION; 363 stop.arg = 0; 364 stop.flags = MMC_RSP_R1B | MMC_CMD_AC; 365 stop.mrq = &req; 366 req.stop = &stop; 367 } 368 MMCBUS_WAIT_FOR_REQUEST(mmcbr, dev, &req); 369 if (req.cmd->error != MMC_ERR_NONE) { 370 device_printf(dev, "Error indicated: %d %s\n", 371 req.cmd->error, mmcsd_errmsg(req.cmd->error)); 372 break; 373 } 374 block += numblocks; 375 } 376 return (block); 377 } 378 379 static daddr_t 380 mmcsd_delete(struct mmcsd_softc *sc, struct bio *bp) 381 { 382 daddr_t block, end, start, stop; 383 struct mmc_command cmd; 384 struct mmc_request req; 385 device_t dev = sc->dev; 386 int sz = sc->disk->d_sectorsize; 387 int erase_sector; 388 device_t mmcbr = device_get_parent(dev); 389 390 block = bp->bio_pblkno; 391 end = bp->bio_pblkno + (bp->bio_bcount / sz); 392 /* Coalesce with part remaining from previous request. */ 393 if (block > sc->eblock && block <= sc->eend) 394 block = sc->eblock; 395 if (end >= sc->eblock && end < sc->eend) 396 end = sc->eend; 397 /* Safe round to the erase sector boundaries. */ 398 erase_sector = mmc_get_erase_sector(dev); 399 start = block + erase_sector - 1; /* Round up. */ 400 start -= start % erase_sector; 401 stop = end; /* Round down. */ 402 stop -= end % erase_sector; 403 /* We can't erase area smaller then sector, store it for later. */ 404 if (start >= stop) { 405 sc->eblock = block; 406 sc->eend = end; 407 return (end); 408 } 409 410 /* Set erase start position. */ 411 memset(&req, 0, sizeof(req)); 412 memset(&cmd, 0, sizeof(cmd)); 413 cmd.mrq = &req; 414 req.cmd = &cmd; 415 if (mmc_get_card_type(dev) == mode_sd) 416 cmd.opcode = SD_ERASE_WR_BLK_START; 417 else 418 cmd.opcode = MMC_ERASE_GROUP_START; 419 cmd.arg = start; 420 if (!mmc_get_high_cap(dev)) 421 cmd.arg <<= 9; 422 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC; 423 MMCBUS_WAIT_FOR_REQUEST(mmcbr, dev, &req); 424 if (req.cmd->error != MMC_ERR_NONE) { 425 printf("erase err1: %d\n", req.cmd->error); 426 return (block); 427 } 428 /* Set erase stop position. */ 429 memset(&req, 0, sizeof(req)); 430 memset(&cmd, 0, sizeof(cmd)); 431 req.cmd = &cmd; 432 if (mmc_get_card_type(dev) == mode_sd) 433 cmd.opcode = SD_ERASE_WR_BLK_END; 434 else 435 cmd.opcode = MMC_ERASE_GROUP_END; 436 cmd.arg = stop; 437 if (!mmc_get_high_cap(dev)) 438 cmd.arg <<= 9; 439 cmd.arg--; 440 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC; 441 MMCBUS_WAIT_FOR_REQUEST(mmcbr, dev, &req); 442 if (req.cmd->error != MMC_ERR_NONE) { 443 printf("erase err2: %d\n", req.cmd->error); 444 return (block); 445 } 446 /* Erase range. */ 447 memset(&req, 0, sizeof(req)); 448 memset(&cmd, 0, sizeof(cmd)); 449 req.cmd = &cmd; 450 cmd.opcode = MMC_ERASE; 451 cmd.arg = 0; 452 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC; 453 MMCBUS_WAIT_FOR_REQUEST(mmcbr, dev, &req); 454 if (req.cmd->error != MMC_ERR_NONE) { 455 printf("erase err3 %d\n", req.cmd->error); 456 return (block); 457 } 458 /* Store one of remaining parts for the next call. */ 459 if (bp->bio_pblkno >= sc->eblock || block == start) { 460 sc->eblock = stop; /* Predict next forward. */ 461 sc->eend = end; 462 } else { 463 sc->eblock = block; /* Predict next backward. */ 464 sc->eend = start; 465 } 466 return (end); 467 } 468 469 static int 470 mmcsd_dump(void *arg, void *virtual, vm_offset_t physical, 471 off_t offset, size_t length) 472 { 473 struct disk *disk = arg; 474 struct mmcsd_softc *sc = (struct mmcsd_softc *)disk->d_drv1; 475 device_t dev = sc->dev; 476 struct bio bp; 477 daddr_t block, end; 478 device_t mmcbr = device_get_parent(dev); 479 480 /* length zero is special and really means flush buffers to media */ 481 if (!length) 482 return (0); 483 484 bzero(&bp, sizeof(struct bio)); 485 bp.bio_disk = disk; 486 bp.bio_pblkno = offset / disk->d_sectorsize; 487 bp.bio_bcount = length; 488 bp.bio_data = virtual; 489 bp.bio_cmd = BIO_WRITE; 490 end = bp.bio_pblkno + bp.bio_bcount / sc->disk->d_sectorsize; 491 MMCBUS_ACQUIRE_BUS(mmcbr, dev); 492 block = mmcsd_rw(sc, &bp); 493 MMCBUS_RELEASE_BUS(mmcbr, dev); 494 return ((end < block) ? EIO : 0); 495 } 496 497 static void 498 mmcsd_task(void *arg) 499 { 500 struct mmcsd_softc *sc = (struct mmcsd_softc*)arg; 501 struct bio *bp; 502 int sz; 503 daddr_t block, end; 504 device_t dev = sc->dev; 505 device_t mmcbr = device_get_parent(sc->dev); 506 507 while (1) { 508 MMCSD_LOCK(sc); 509 do { 510 if (sc->running == 0) 511 goto out; 512 bp = bioq_takefirst(&sc->bio_queue); 513 if (bp == NULL) 514 msleep(sc, &sc->sc_mtx, PRIBIO, "jobqueue", 0); 515 } while (bp == NULL); 516 MMCSD_UNLOCK(sc); 517 if (bp->bio_cmd != BIO_READ && mmc_get_read_only(dev)) { 518 bp->bio_error = EROFS; 519 bp->bio_resid = bp->bio_bcount; 520 bp->bio_flags |= BIO_ERROR; 521 biodone(bp); 522 continue; 523 } 524 MMCBUS_ACQUIRE_BUS(mmcbr, dev); 525 sz = sc->disk->d_sectorsize; 526 block = bp->bio_pblkno; 527 end = bp->bio_pblkno + (bp->bio_bcount / sz); 528 if (bp->bio_cmd == BIO_READ || bp->bio_cmd == BIO_WRITE) { 529 /* Access to the remaining erase block obsoletes it. */ 530 if (block < sc->eend && end > sc->eblock) 531 sc->eblock = sc->eend = 0; 532 block = mmcsd_rw(sc, bp); 533 } else if (bp->bio_cmd == BIO_DELETE) { 534 block = mmcsd_delete(sc, bp); 535 } 536 MMCBUS_RELEASE_BUS(mmcbr, dev); 537 if (block < end) { 538 bp->bio_error = EIO; 539 bp->bio_resid = (end - block) * sz; 540 bp->bio_flags |= BIO_ERROR; 541 } 542 biodone(bp); 543 } 544 out: 545 /* tell parent we're done */ 546 sc->running = -1; 547 MMCSD_UNLOCK(sc); 548 wakeup(sc); 549 550 kproc_exit(0); 551 } 552 553 static int 554 mmcsd_bus_bit_width(device_t dev) 555 { 556 557 if (mmc_get_bus_width(dev) == bus_width_1) 558 return (1); 559 if (mmc_get_bus_width(dev) == bus_width_4) 560 return (4); 561 return (8); 562 } 563 564 static device_method_t mmcsd_methods[] = { 565 DEVMETHOD(device_probe, mmcsd_probe), 566 DEVMETHOD(device_attach, mmcsd_attach), 567 DEVMETHOD(device_detach, mmcsd_detach), 568 DEVMETHOD(device_suspend, mmcsd_suspend), 569 DEVMETHOD(device_resume, mmcsd_resume), 570 DEVMETHOD_END 571 }; 572 573 static driver_t mmcsd_driver = { 574 "mmcsd", 575 mmcsd_methods, 576 sizeof(struct mmcsd_softc), 577 }; 578 static devclass_t mmcsd_devclass; 579 580 DRIVER_MODULE(mmcsd, mmc, mmcsd_driver, mmcsd_devclass, NULL, NULL); 581