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