2 * Copyright (c) 2006 Bernd Walter. All rights reserved.
3 * Copyright (c) 2006 M. Warner Losh. All rights reserved.
4 * Copyright (c) 2017 Marius Strobl <marius@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 * Portions of this software may have been developed with reference to
27 * the SD Simplified Specification. The following disclaimer may apply:
29 * The following conditions apply to the release of the simplified
30 * specification ("Simplified Specification") by the SD Card Association and
31 * the SD Group. The Simplified Specification is a subset of the complete SD
32 * Specification which is owned by the SD Card Association and the SD
33 * Group. This Simplified Specification is provided on a non-confidential
34 * basis subject to the disclaimers below. Any implementation of the
35 * Simplified Specification may require a license from the SD Card
36 * Association, SD Group, SD-3C LLC or other third parties.
40 * The information contained in the Simplified Specification is presented only
41 * as a standard specification for SD Cards and SD Host/Ancillary products and
42 * is provided "AS-IS" without any representations or warranties of any
43 * kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD
44 * Card Association for any damages, any infringements of patents or other
45 * right of the SD Group, SD-3C LLC, the SD Card Association or any third
46 * parties, which may result from its use. No license is granted by
47 * implication, estoppel or otherwise under any patent or other rights of the
48 * SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing
49 * herein shall be construed as an obligation by the SD Group, the SD-3C LLC
50 * or the SD Card Association to disclose or distribute any technical
51 * information, know-how or other confidential information to any third party.
54 #include <sys/cdefs.h>
55 __FBSDID("$FreeBSD$");
57 #include <sys/param.h>
58 #include <sys/systm.h>
62 #include <sys/fcntl.h>
63 #include <sys/ioccom.h>
64 #include <sys/kernel.h>
65 #include <sys/kthread.h>
67 #include <sys/malloc.h>
68 #include <sys/module.h>
69 #include <sys/mutex.h>
70 #include <sys/slicer.h>
73 #include <geom/geom.h>
74 #include <geom/geom_disk.h>
76 #include <dev/mmc/bridge.h>
77 #include <dev/mmc/mmc_ioctl.h>
78 #include <dev/mmc/mmc_subr.h>
79 #include <dev/mmc/mmcbrvar.h>
80 #include <dev/mmc/mmcreg.h>
81 #include <dev/mmc/mmcvar.h>
83 #include "mmcbus_if.h"
85 #if __FreeBSD_version < 800002
86 #define kproc_create kthread_create
87 #define kproc_exit kthread_exit
90 #define MMCSD_CMD_RETRIES 5
92 #define MMCSD_FMT_BOOT "mmcsd%dboot"
93 #define MMCSD_FMT_GP "mmcsd%dgp"
94 #define MMCSD_FMT_RPMB "mmcsd%drpmb"
95 #define MMCSD_LABEL_ENH "enh"
97 #define MMCSD_PART_NAMELEN (16 + 1)
103 struct mtx ioctl_mtx;
104 struct mmcsd_softc *sc;
107 struct bio_queue_head bio_queue;
108 daddr_t eblock, eend; /* Range remaining after the last erase. */
115 char name[MMCSD_PART_NAMELEN];
121 struct mmcsd_part *part[MMC_PART_MAX];
122 enum mmc_card_mode mode;
123 u_int max_data; /* Maximum data size [blocks] */
124 u_int erase_sector; /* Device native erase sector size [blocks] */
125 uint8_t high_cap; /* High Capacity device (block addressed) */
126 uint8_t part_curr; /* Partition currently switched to */
127 uint8_t ext_csd[MMC_EXTCSD_SIZE];
130 #define MMCSD_INAND_CMD38 0x0001
131 #define MMCSD_USE_TRIM 0x0002
132 uint32_t cmd6_time; /* Generic switch timeout [us] */
133 uint32_t part_time; /* Partition switch timeout [us] */
134 off_t enh_base; /* Enhanced user data area slice base ... */
135 off_t enh_size; /* ... and size [bytes] */
137 struct timeval log_time;
138 struct cdev *rpmb_dev;
141 static const char *errmsg[] =
152 #define LOG_PPS 5 /* Log no more than 5 errors per second. */
154 /* bus entry points */
155 static int mmcsd_attach(device_t dev);
156 static int mmcsd_detach(device_t dev);
157 static int mmcsd_probe(device_t dev);
160 static int mmcsd_close(struct disk *dp);
161 static int mmcsd_dump(void *arg, void *virtual, vm_offset_t physical,
162 off_t offset, size_t length);
163 static int mmcsd_getattr(struct bio *);
164 static int mmcsd_ioctl_disk(struct disk *disk, u_long cmd, void *data,
165 int fflag, struct thread *td);
166 static int mmcsd_open(struct disk *dp);
167 static void mmcsd_strategy(struct bio *bp);
168 static void mmcsd_task(void *arg);
170 /* RMPB cdev interface */
171 static int mmcsd_ioctl_rpmb(struct cdev *dev, u_long cmd, caddr_t data,
172 int fflag, struct thread *td);
174 static void mmcsd_add_part(struct mmcsd_softc *sc, u_int type,
175 const char *name, u_int cnt, off_t media_size, bool ro);
176 static int mmcsd_bus_bit_width(device_t dev);
177 static daddr_t mmcsd_delete(struct mmcsd_part *part, struct bio *bp);
178 static const char *mmcsd_errmsg(int e);
179 static int mmcsd_ioctl(struct mmcsd_part *part, u_long cmd, void *data,
181 static int mmcsd_ioctl_cmd(struct mmcsd_part *part, struct mmc_ioc_cmd *mic,
183 static uintmax_t mmcsd_pretty_size(off_t size, char *unit);
184 static daddr_t mmcsd_rw(struct mmcsd_part *part, struct bio *bp);
185 static int mmcsd_set_blockcount(struct mmcsd_softc *sc, u_int count, bool rel);
186 static int mmcsd_slicer(device_t dev, const char *provider,
187 struct flash_slice *slices, int *nslices);
188 static int mmcsd_switch_part(device_t bus, device_t dev, uint16_t rca,
191 #define MMCSD_DISK_LOCK(_part) mtx_lock(&(_part)->disk_mtx)
192 #define MMCSD_DISK_UNLOCK(_part) mtx_unlock(&(_part)->disk_mtx)
193 #define MMCSD_DISK_LOCK_INIT(_part) \
194 mtx_init(&(_part)->disk_mtx, (_part)->name, "mmcsd disk", MTX_DEF)
195 #define MMCSD_DISK_LOCK_DESTROY(_part) mtx_destroy(&(_part)->disk_mtx);
196 #define MMCSD_DISK_ASSERT_LOCKED(_part) \
197 mtx_assert(&(_part)->disk_mtx, MA_OWNED);
198 #define MMCSD_DISK_ASSERT_UNLOCKED(_part) \
199 mtx_assert(&(_part)->disk_mtx, MA_NOTOWNED);
201 #define MMCSD_IOCTL_LOCK(_part) mtx_lock(&(_part)->ioctl_mtx)
202 #define MMCSD_IOCTL_UNLOCK(_part) mtx_unlock(&(_part)->ioctl_mtx)
203 #define MMCSD_IOCTL_LOCK_INIT(_part) \
204 mtx_init(&(_part)->ioctl_mtx, (_part)->name, "mmcsd IOCTL", MTX_DEF)
205 #define MMCSD_IOCTL_LOCK_DESTROY(_part) mtx_destroy(&(_part)->ioctl_mtx);
206 #define MMCSD_IOCTL_ASSERT_LOCKED(_part) \
207 mtx_assert(&(_part)->ioctl_mtx, MA_OWNED);
208 #define MMCSD_IOCLT_ASSERT_UNLOCKED(_part) \
209 mtx_assert(&(_part)->ioctl_mtx, MA_NOTOWNED);
212 mmcsd_probe(device_t dev)
216 device_set_desc(dev, "MMC/SD Memory Card");
221 mmcsd_attach(device_t dev)
224 struct mmcsd_softc *sc;
225 const uint8_t *ext_csd;
226 off_t erase_size, sector_size, size, wp_size;
234 sc = device_get_softc(dev);
236 sc->mmcbus = mmcbus = device_get_parent(dev);
237 sc->mode = mmcbr_get_mode(mmcbus);
239 * Note that in principle with an SDHCI-like re-tuning implementation,
240 * the maximum data size can change at runtime due to a device removal/
241 * insertion that results in switches to/from a transfer mode involving
242 * re-tuning, iff there are multiple devices on a given bus. Until now
243 * mmc(4) lacks support for rescanning already attached buses, however,
244 * and sdhci(4) to date has no support for shared buses in the first
247 sc->max_data = mmc_get_max_data(dev);
248 sc->high_cap = mmc_get_high_cap(dev);
249 sc->rca = mmc_get_rca(dev);
250 sc->cmd6_time = mmc_get_cmd6_timeout(dev);
251 quirks = mmc_get_quirks(dev);
253 /* Only MMC >= 4.x devices support EXT_CSD. */
254 if (mmc_get_spec_vers(dev) >= 4) {
255 MMCBUS_ACQUIRE_BUS(mmcbus, dev);
256 err = mmc_send_ext_csd(mmcbus, dev, sc->ext_csd);
257 MMCBUS_RELEASE_BUS(mmcbus, dev);
258 if (err != MMC_ERR_NONE) {
259 device_printf(dev, "Error reading EXT_CSD %s\n",
264 ext_csd = sc->ext_csd;
266 if ((quirks & MMC_QUIRK_INAND_CMD38) != 0) {
267 if (mmc_get_spec_vers(dev) < 4) {
269 "MMC_QUIRK_INAND_CMD38 set but no EXT_CSD\n");
272 sc->flags |= MMCSD_INAND_CMD38;
276 * EXT_CSD_SEC_FEATURE_SUPPORT_GB_CL_EN denotes support for both
277 * insecure and secure TRIM.
279 if ((ext_csd[EXT_CSD_SEC_FEATURE_SUPPORT] &
280 EXT_CSD_SEC_FEATURE_SUPPORT_GB_CL_EN) != 0 &&
281 (quirks & MMC_QUIRK_BROKEN_TRIM) == 0) {
283 device_printf(dev, "taking advantage of TRIM\n");
284 sc->flags |= MMCSD_USE_TRIM;
285 sc->erase_sector = 1;
287 sc->erase_sector = mmc_get_erase_sector(dev);
290 * Enhanced user data area and general purpose partitions are only
291 * supported in revision 1.4 (EXT_CSD_REV == 4) and later, the RPMB
292 * partition in revision 1.5 (MMC v4.41, EXT_CSD_REV == 5) and later.
294 rev = ext_csd[EXT_CSD_REV];
297 * Ignore user-creatable enhanced user data area and general purpose
298 * partitions partitions as long as partitioning hasn't been finished.
300 comp = (ext_csd[EXT_CSD_PART_SET] & EXT_CSD_PART_SET_COMPLETED) != 0;
303 * Add enhanced user data area slice, unless it spans the entirety of
304 * the user data area. The enhanced area is of a multiple of high
305 * capacity write protect groups ((ERASE_GRP_SIZE + HC_WP_GRP_SIZE) *
306 * 512 KB) and its offset given in either sectors or bytes, depending
307 * on whether it's a high capacity device or not.
308 * NB: The slicer and its slices need to be registered before adding
309 * the disk for the corresponding user data area as re-tasting is
312 sector_size = mmc_get_sector_size(dev);
313 size = ext_csd[EXT_CSD_ENH_SIZE_MULT] +
314 (ext_csd[EXT_CSD_ENH_SIZE_MULT + 1] << 8) +
315 (ext_csd[EXT_CSD_ENH_SIZE_MULT + 2] << 16);
316 if (rev >= 4 && comp == TRUE && size > 0 &&
317 (ext_csd[EXT_CSD_PART_SUPPORT] &
318 EXT_CSD_PART_SUPPORT_ENH_ATTR_EN) != 0 &&
319 (ext_csd[EXT_CSD_PART_ATTR] & (EXT_CSD_PART_ATTR_ENH_USR)) != 0) {
320 erase_size = ext_csd[EXT_CSD_ERASE_GRP_SIZE] * 1024 *
322 wp_size = ext_csd[EXT_CSD_HC_WP_GRP_SIZE];
323 size *= erase_size * wp_size;
324 if (size != mmc_get_media_size(dev) * sector_size) {
326 sc->enh_base = (ext_csd[EXT_CSD_ENH_START_ADDR] +
327 (ext_csd[EXT_CSD_ENH_START_ADDR + 1] << 8) +
328 (ext_csd[EXT_CSD_ENH_START_ADDR + 2] << 16) +
329 (ext_csd[EXT_CSD_ENH_START_ADDR + 3] << 24)) *
330 (sc->high_cap == 0 ? MMC_SECTOR_SIZE : 1);
331 } else if (bootverbose)
333 "enhanced user data area spans entire device\n");
337 * Add default partition. This may be the only one or the user
338 * data area in case partitions are supported.
340 ro = mmc_get_read_only(dev);
341 mmcsd_add_part(sc, EXT_CSD_PART_CONFIG_ACC_DEFAULT, "mmcsd",
342 device_get_unit(dev), mmc_get_media_size(dev) * sector_size, ro);
344 if (mmc_get_spec_vers(dev) < 3)
347 /* Belatedly announce enhanced user data slice. */
348 if (sc->enh_size != 0) {
349 bytes = mmcsd_pretty_size(size, unit);
350 printf(FLASH_SLICES_FMT ": %ju%sB enhanced user data area "
351 "slice offset 0x%jx at %s\n", device_get_nameunit(dev),
352 MMCSD_LABEL_ENH, bytes, unit, (uintmax_t)sc->enh_base,
353 device_get_nameunit(dev));
357 * Determine partition switch timeout (provided in units of 10 ms)
358 * and ensure it's at least 300 ms as some eMMC chips lie.
360 sc->part_time = max(ext_csd[EXT_CSD_PART_SWITCH_TO] * 10 * 1000,
363 /* Add boot partitions, which are of a fixed multiple of 128 KB. */
364 size = ext_csd[EXT_CSD_BOOT_SIZE_MULT] * MMC_BOOT_RPMB_BLOCK_SIZE;
365 if (size > 0 && (mmcbr_get_caps(mmcbus) & MMC_CAP_BOOT_NOACC) == 0) {
366 mmcsd_add_part(sc, EXT_CSD_PART_CONFIG_ACC_BOOT0,
367 MMCSD_FMT_BOOT, 0, size,
368 ro | ((ext_csd[EXT_CSD_BOOT_WP_STATUS] &
369 EXT_CSD_BOOT_WP_STATUS_BOOT0_MASK) != 0));
370 mmcsd_add_part(sc, EXT_CSD_PART_CONFIG_ACC_BOOT1,
371 MMCSD_FMT_BOOT, 1, size,
372 ro | ((ext_csd[EXT_CSD_BOOT_WP_STATUS] &
373 EXT_CSD_BOOT_WP_STATUS_BOOT1_MASK) != 0));
376 /* Add RPMB partition, which also is of a fixed multiple of 128 KB. */
377 size = ext_csd[EXT_CSD_RPMB_MULT] * MMC_BOOT_RPMB_BLOCK_SIZE;
378 if (rev >= 5 && size > 0)
379 mmcsd_add_part(sc, EXT_CSD_PART_CONFIG_ACC_RPMB,
380 MMCSD_FMT_RPMB, 0, size, ro);
382 if (rev <= 3 || comp == FALSE)
386 * Add general purpose partitions, which are of a multiple of high
387 * capacity write protect groups, too.
389 if ((ext_csd[EXT_CSD_PART_SUPPORT] & EXT_CSD_PART_SUPPORT_EN) != 0) {
390 erase_size = ext_csd[EXT_CSD_ERASE_GRP_SIZE] * 1024 *
392 wp_size = ext_csd[EXT_CSD_HC_WP_GRP_SIZE];
393 for (i = 0; i < MMC_PART_GP_MAX; i++) {
394 size = ext_csd[EXT_CSD_GP_SIZE_MULT + i * 3] +
395 (ext_csd[EXT_CSD_GP_SIZE_MULT + i * 3 + 1] << 8) +
396 (ext_csd[EXT_CSD_GP_SIZE_MULT + i * 3 + 2] << 16);
399 mmcsd_add_part(sc, EXT_CSD_PART_CONFIG_ACC_GP0 + i,
400 MMCSD_FMT_GP, i, size * erase_size * wp_size, ro);
407 mmcsd_pretty_size(off_t size, char *unit)
413 * Display in most natural units. There's no card < 1MB. However,
414 * RPMB partitions occasionally are smaller than that, though. The
415 * SD standard goes to 2 GiB due to its reliance on FAT, but the data
416 * format supports up to 4 GiB and some card makers push it up to this
417 * limit. The SDHC standard only goes to 32 GiB due to FAT32, but the
418 * data format supports up to 2 TiB however. 2048 GB isn't too ugly,
419 * so we note it in passing here and don't add the code to print TB).
420 * Since these cards are sold in terms of MB and GB not MiB and GiB,
421 * report them like that. We also round to the nearest unit, since
422 * many cards are a few percent short, even of the power of 10 size.
425 unit[0] = unit[1] = '\0';
426 for (i = 0; i <= 2 && bytes >= 1000; i++) {
427 bytes = (bytes + 1000 / 2 - 1) / 1000;
445 static struct cdevsw mmcsd_rpmb_cdevsw = {
446 .d_version = D_VERSION,
447 .d_name = "mmcsdrpmb",
448 .d_ioctl = mmcsd_ioctl_rpmb
452 mmcsd_add_part(struct mmcsd_softc *sc, u_int type, const char *name, u_int cnt,
453 off_t media_size, bool ro)
455 struct make_dev_args args;
456 device_t dev, mmcbus;
458 const uint8_t *ext_csd;
459 struct mmcsd_part *part;
470 part = sc->part[type] = malloc(sizeof(*part), M_DEVBUF,
476 snprintf(part->name, sizeof(part->name), name, device_get_unit(dev));
478 MMCSD_IOCTL_LOCK_INIT(part);
481 * For the RPMB partition, allow IOCTL access only.
482 * NB: If ever attaching RPMB partitions to disk(9), the re-tuning
483 * implementation and especially its pausing need to be revisited,
484 * because then re-tuning requests may be issued by the IOCTL half
485 * of this driver while re-tuning is already paused by the disk(9)
486 * one and vice versa.
488 if (type == EXT_CSD_PART_CONFIG_ACC_RPMB) {
489 make_dev_args_init(&args);
490 args.mda_flags = MAKEDEV_CHECKNAME | MAKEDEV_WAITOK;
491 args.mda_devsw = &mmcsd_rpmb_cdevsw;
492 args.mda_uid = UID_ROOT;
493 args.mda_gid = GID_OPERATOR;
494 args.mda_mode = 0640;
495 args.mda_si_drv1 = part;
496 if (make_dev_s(&args, &sc->rpmb_dev, "%s", part->name) != 0) {
497 device_printf(dev, "Failed to make RPMB device\n");
498 free(part, M_DEVBUF);
502 MMCSD_DISK_LOCK_INIT(part);
504 d = part->disk = disk_alloc();
505 d->d_open = mmcsd_open;
506 d->d_close = mmcsd_close;
507 d->d_strategy = mmcsd_strategy;
508 d->d_ioctl = mmcsd_ioctl_disk;
509 d->d_dump = mmcsd_dump;
510 d->d_getattr = mmcsd_getattr;
511 d->d_name = part->name;
513 d->d_sectorsize = mmc_get_sector_size(dev);
514 d->d_maxsize = sc->max_data * d->d_sectorsize;
515 d->d_mediasize = media_size;
516 d->d_stripesize = sc->erase_sector * d->d_sectorsize;
518 d->d_flags = DISKFLAG_CANDELETE;
519 d->d_delmaxsize = mmc_get_erase_sector(dev) * d->d_sectorsize;
520 strlcpy(d->d_ident, mmc_get_card_sn_string(dev),
522 strlcpy(d->d_descr, mmc_get_card_id_string(dev),
524 d->d_rotation_rate = DISK_RR_NON_ROTATING;
526 disk_create(d, DISK_VERSION);
527 bioq_init(&part->bio_queue);
530 kproc_create(&mmcsd_task, part, &part->p, 0, 0,
531 "%s%d: mmc/sd card", part->name, cnt);
534 bytes = mmcsd_pretty_size(media_size, unit);
535 if (type == EXT_CSD_PART_CONFIG_ACC_DEFAULT) {
536 speed = mmcbr_get_clock(mmcbus);
537 printf("%s%d: %ju%sB <%s>%s at %s %d.%01dMHz/%dbit/%d-block\n",
538 part->name, cnt, bytes, unit, mmc_get_card_id_string(dev),
539 ro ? " (read-only)" : "", device_get_nameunit(mmcbus),
540 speed / 1000000, (speed / 100000) % 10,
541 mmcsd_bus_bit_width(dev), sc->max_data);
542 } else if (type == EXT_CSD_PART_CONFIG_ACC_RPMB) {
543 printf("%s: %ju%sB partion %d%s at %s\n", part->name, bytes,
544 unit, type, ro ? " (read-only)" : "",
545 device_get_nameunit(dev));
550 if (type >= EXT_CSD_PART_CONFIG_ACC_GP0 &&
551 type <= EXT_CSD_PART_CONFIG_ACC_GP3) {
552 ext_csd = sc->ext_csd;
553 gp = type - EXT_CSD_PART_CONFIG_ACC_GP0;
554 if ((ext_csd[EXT_CSD_PART_SUPPORT] &
555 EXT_CSD_PART_SUPPORT_ENH_ATTR_EN) != 0 &&
556 (ext_csd[EXT_CSD_PART_ATTR] &
557 (EXT_CSD_PART_ATTR_ENH_GP0 << gp)) != 0)
559 else if ((ext_csd[EXT_CSD_PART_SUPPORT] &
560 EXT_CSD_PART_SUPPORT_EXT_ATTR_EN) != 0) {
561 extattr = (ext_csd[EXT_CSD_EXT_PART_ATTR +
562 (gp / 2)] >> (4 * (gp % 2))) & 0xF;
564 case EXT_CSD_EXT_PART_ATTR_DEFAULT:
566 case EXT_CSD_EXT_PART_ATTR_SYSTEMCODE:
569 case EXT_CSD_EXT_PART_ATTR_NPERSISTENT:
570 ext = "non-persistent";
579 printf("%s%d: %ju%sB partion %d%s%s at %s\n",
580 part->name, cnt, bytes, unit, type, enh ?
581 " enhanced" : "", ro ? " (read-only)" : "",
582 device_get_nameunit(dev));
584 printf("%s%d: %ju%sB partion %d extended 0x%x "
585 "(%s)%s at %s\n", part->name, cnt, bytes, unit,
586 type, extattr, ext, ro ? " (read-only)" : "",
587 device_get_nameunit(dev));
592 mmcsd_slicer(device_t dev, const char *provider,
593 struct flash_slice *slices, int *nslices)
595 char name[MMCSD_PART_NAMELEN];
596 struct mmcsd_softc *sc;
597 struct mmcsd_part *part;
603 sc = device_get_softc(dev);
604 if (sc->enh_size == 0)
607 part = sc->part[EXT_CSD_PART_CONFIG_ACC_DEFAULT];
608 snprintf(name, sizeof(name), "%s%d", part->disk->d_name,
610 if (strcmp(name, provider) != 0)
614 slices[0].base = sc->enh_base;
615 slices[0].size = sc->enh_size;
616 slices[0].label = MMCSD_LABEL_ENH;
621 mmcsd_detach(device_t dev)
623 struct mmcsd_softc *sc = device_get_softc(dev);
624 struct mmcsd_part *part;
627 for (i = 0; i < MMC_PART_MAX; i++) {
630 if (part->disk != NULL) {
631 MMCSD_DISK_LOCK(part);
633 if (part->running > 0) {
637 /* wait for thread to finish. */
638 while (part->running != -1)
639 msleep(part, &part->disk_mtx, 0,
640 "mmcsd disk detach", 0);
642 MMCSD_DISK_UNLOCK(part);
644 MMCSD_IOCTL_LOCK(part);
645 while (part->ioctl > 0)
646 msleep(part, &part->ioctl_mtx, 0,
647 "mmcsd IOCTL detach", 0);
649 MMCSD_IOCTL_UNLOCK(part);
653 if (sc->rpmb_dev != NULL)
654 destroy_dev(sc->rpmb_dev);
656 for (i = 0; i < MMC_PART_MAX; i++) {
659 if (part->disk != NULL) {
660 /* Flush the request queue. */
661 bioq_flush(&part->bio_queue, NULL, ENXIO);
663 disk_destroy(part->disk);
665 MMCSD_DISK_LOCK_DESTROY(part);
667 MMCSD_IOCTL_LOCK_DESTROY(part);
668 free(part, M_DEVBUF);
675 mmcsd_suspend(device_t dev)
677 struct mmcsd_softc *sc = device_get_softc(dev);
678 struct mmcsd_part *part;
681 for (i = 0; i < MMC_PART_MAX; i++) {
684 if (part->disk != NULL) {
685 MMCSD_DISK_LOCK(part);
687 if (part->running > 0) {
691 /* wait for thread to finish. */
692 while (part->running != -1)
693 msleep(part, &part->disk_mtx, 0,
694 "mmcsd disk suspension", 0);
696 MMCSD_DISK_UNLOCK(part);
698 MMCSD_IOCTL_LOCK(part);
699 while (part->ioctl > 0)
700 msleep(part, &part->ioctl_mtx, 0,
701 "mmcsd IOCTL suspension", 0);
703 MMCSD_IOCTL_UNLOCK(part);
710 mmcsd_resume(device_t dev)
712 struct mmcsd_softc *sc = device_get_softc(dev);
713 struct mmcsd_part *part;
716 for (i = 0; i < MMC_PART_MAX; i++) {
719 if (part->disk != NULL) {
720 MMCSD_DISK_LOCK(part);
722 if (part->running <= 0) {
724 MMCSD_DISK_UNLOCK(part);
725 kproc_create(&mmcsd_task, part,
726 &part->p, 0, 0, "%s%d: mmc/sd card",
727 part->name, part->cnt);
729 MMCSD_DISK_UNLOCK(part);
731 MMCSD_IOCTL_LOCK(part);
733 MMCSD_IOCTL_UNLOCK(part);
740 mmcsd_open(struct disk *dp __unused)
747 mmcsd_close(struct disk *dp __unused)
754 mmcsd_strategy(struct bio *bp)
756 struct mmcsd_softc *sc;
757 struct mmcsd_part *part;
759 part = bp->bio_disk->d_drv1;
761 MMCSD_DISK_LOCK(part);
762 if (part->running > 0 || part->suspend > 0) {
763 bioq_disksort(&part->bio_queue, bp);
764 MMCSD_DISK_UNLOCK(part);
767 MMCSD_DISK_UNLOCK(part);
768 biofinish(bp, NULL, ENXIO);
773 mmcsd_ioctl_rpmb(struct cdev *dev, u_long cmd, caddr_t data,
774 int fflag, struct thread *td __unused)
777 return (mmcsd_ioctl(dev->si_drv1, cmd, data, fflag));
781 mmcsd_ioctl_disk(struct disk *disk, u_long cmd, void *data, int fflag,
782 struct thread *td __unused)
785 return (mmcsd_ioctl(disk->d_drv1, cmd, data, fflag));
789 mmcsd_ioctl(struct mmcsd_part *part, u_long cmd, void *data, int fflag)
791 struct mmc_ioc_cmd *mic;
792 struct mmc_ioc_multi_cmd *mimc;
796 if ((fflag & FREAD) == 0)
803 err = mmcsd_ioctl_cmd(part, mic, fflag);
805 case MMC_IOC_MULTI_CMD:
807 if (mimc->num_of_cmds == 0)
809 if (mimc->num_of_cmds > MMC_IOC_MAX_CMDS)
811 cnt = mimc->num_of_cmds;
812 size = sizeof(*mic) * cnt;
813 mic = malloc(size, M_TEMP, M_WAITOK);
814 err = copyin((const void *)mimc->cmds, mic, size);
816 for (i = 0; i < cnt; i++) {
817 err = mmcsd_ioctl_cmd(part, &mic[i], fflag);
831 mmcsd_ioctl_cmd(struct mmcsd_part *part, struct mmc_ioc_cmd *mic, int fflag)
833 struct mmc_command cmd;
834 struct mmc_data data;
835 struct mmcsd_softc *sc;
836 device_t dev, mmcbus;
843 if ((fflag & FWRITE) == 0 && mic->write_flag != 0)
846 if (part->ro == TRUE && mic->write_flag != 0)
850 * We don't need to explicitly lock against the disk(9) half of this
851 * driver as MMCBUS_ACQUIRE_BUS() will serialize us. However, it's
852 * necessary to protect against races with detachment and suspension,
853 * especially since it's required to switch away from RPMB partitions
854 * again after an access (see mmcsd_switch_part()).
856 MMCSD_IOCTL_LOCK(part);
857 while (part->ioctl != 0) {
858 if (part->ioctl < 0) {
859 MMCSD_IOCTL_UNLOCK(part);
862 msleep(part, &part->ioctl_mtx, 0, "mmcsd IOCTL", 0);
865 MMCSD_IOCTL_UNLOCK(part);
869 len = mic->blksz * mic->blocks;
870 if (len > MMC_IOC_MAX_BYTES) {
875 dp = malloc(len, M_TEMP, M_WAITOK);
876 err = copyin((void *)(uintptr_t)mic->data_ptr, dp, len);
880 memset(&cmd, 0, sizeof(cmd));
881 memset(&data, 0, sizeof(data));
882 cmd.opcode = mic->opcode;
884 cmd.flags = mic->flags;
888 data.flags = mic->write_flag != 0 ? MMC_DATA_WRITE :
894 if (mic->is_acmd == 0) {
895 /* Enforce/patch/restrict RCA-based commands */
896 switch (cmd.opcode) {
897 case MMC_SET_RELATIVE_ADDR:
898 case MMC_SELECT_CARD:
901 case MMC_STOP_TRANSMISSION:
902 if ((cmd.arg & 0x1) == 0)
905 case MMC_SLEEP_AWAKE:
908 case MMC_SEND_STATUS:
909 case MMC_GO_INACTIVE_STATE:
912 cmd.arg = (cmd.arg & 0x0000FFFF) | (rca << 16);
920 MMCBUS_ACQUIRE_BUS(mmcbus, dev);
921 err = mmcsd_switch_part(mmcbus, dev, rca, part->type);
922 if (err != MMC_ERR_NONE)
924 if (part->type == EXT_CSD_PART_CONFIG_ACC_RPMB) {
925 err = mmcsd_set_blockcount(sc, mic->blocks,
926 mic->write_flag & (1 << 31));
927 if (err != MMC_ERR_NONE)
930 if (mic->is_acmd != 0)
931 (void)mmc_wait_for_app_cmd(mmcbus, dev, rca, &cmd, 0);
933 (void)mmc_wait_for_cmd(mmcbus, dev, &cmd, 0);
934 if (part->type == EXT_CSD_PART_CONFIG_ACC_RPMB) {
936 * If the request went to the RPMB partition, try to ensure
937 * that the command actually has completed ...
939 retries = MMCSD_CMD_RETRIES;
941 err = mmc_send_status(mmcbus, dev, rca, &status);
942 if (err != MMC_ERR_NONE)
944 if (R1_STATUS(status) == 0 &&
945 R1_CURRENT_STATE(status) != R1_STATE_PRG)
948 } while (retries-- > 0);
951 /* ... and always switch back to the default partition. */
952 err = mmcsd_switch_part(mmcbus, dev, rca,
953 EXT_CSD_PART_CONFIG_ACC_DEFAULT);
954 if (err != MMC_ERR_NONE)
958 * If EXT_CSD was changed, our copy is outdated now. Specifically,
959 * the upper bits of EXT_CSD_PART_CONFIG used in mmcsd_switch_part(),
960 * so retrieve EXT_CSD again.
962 if (cmd.opcode == MMC_SWITCH_FUNC) {
963 err = mmc_send_ext_csd(mmcbus, dev, sc->ext_csd);
964 if (err != MMC_ERR_NONE)
967 MMCBUS_RELEASE_BUS(mmcbus, dev);
968 if (cmd.error != MMC_ERR_NONE) {
970 case MMC_ERR_TIMEOUT:
976 case MMC_ERR_INVALID:
979 case MMC_ERR_NO_MEMORY:
988 memcpy(mic->response, cmd.resp, 4 * sizeof(uint32_t));
989 if (mic->write_flag == 0 && len != 0) {
990 err = copyout(dp, (void *)(uintptr_t)mic->data_ptr, len);
997 MMCBUS_RELEASE_BUS(mmcbus, dev);
1001 MMCSD_IOCTL_LOCK(part);
1003 MMCSD_IOCTL_UNLOCK(part);
1011 mmcsd_getattr(struct bio *bp)
1013 struct mmcsd_part *part;
1016 if (strcmp(bp->bio_attribute, "MMC::device") == 0) {
1017 if (bp->bio_length != sizeof(dev))
1019 part = bp->bio_disk->d_drv1;
1020 dev = part->sc->dev;
1021 bcopy(&dev, bp->bio_data, sizeof(dev));
1022 bp->bio_completed = bp->bio_length;
1029 mmcsd_set_blockcount(struct mmcsd_softc *sc, u_int count, bool reliable)
1031 struct mmc_command cmd;
1032 struct mmc_request req;
1034 memset(&req, 0, sizeof(req));
1035 memset(&cmd, 0, sizeof(cmd));
1038 cmd.opcode = MMC_SET_BLOCK_COUNT;
1039 cmd.arg = count & 0x0000FFFF;
1042 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1043 MMCBUS_WAIT_FOR_REQUEST(sc->mmcbus, sc->dev, &req);
1048 mmcsd_switch_part(device_t bus, device_t dev, uint16_t rca, u_int part)
1050 struct mmcsd_softc *sc;
1054 sc = device_get_softc(dev);
1056 if (sc->mode == mode_sd)
1057 return (MMC_ERR_NONE);
1060 * According to section "6.2.2 Command restrictions" of the eMMC
1061 * specification v5.1, CMD19/CMD21 aren't allowed to be used with
1062 * RPMB partitions. So we pause re-tuning along with triggering
1063 * it up-front to decrease the likelihood of re-tuning becoming
1064 * necessary while accessing an RPMB partition. Consequently, an
1065 * RPMB partition should immediately be switched away from again
1066 * after an access in order to allow for re-tuning to take place
1069 if (part == EXT_CSD_PART_CONFIG_ACC_RPMB)
1070 MMCBUS_RETUNE_PAUSE(sc->mmcbus, sc->dev, true);
1072 if (sc->part_curr == part)
1073 return (MMC_ERR_NONE);
1075 value = (sc->ext_csd[EXT_CSD_PART_CONFIG] &
1076 ~EXT_CSD_PART_CONFIG_ACC_MASK) | part;
1078 err = mmc_switch(bus, dev, rca, EXT_CSD_CMD_SET_NORMAL,
1079 EXT_CSD_PART_CONFIG, value, sc->part_time, true);
1080 if (err != MMC_ERR_NONE) {
1081 if (part == EXT_CSD_PART_CONFIG_ACC_RPMB)
1082 MMCBUS_RETUNE_UNPAUSE(sc->mmcbus, sc->dev);
1086 sc->ext_csd[EXT_CSD_PART_CONFIG] = value;
1087 if (sc->part_curr == EXT_CSD_PART_CONFIG_ACC_RPMB)
1088 MMCBUS_RETUNE_UNPAUSE(sc->mmcbus, sc->dev);
1089 sc->part_curr = part;
1090 return (MMC_ERR_NONE);
1097 if (e < 0 || e > MMC_ERR_MAX)
1098 return "Bad error code";
1103 mmcsd_rw(struct mmcsd_part *part, struct bio *bp)
1106 struct mmc_command cmd;
1107 struct mmc_command stop;
1108 struct mmc_request req;
1109 struct mmc_data data;
1110 struct mmcsd_softc *sc;
1111 device_t dev, mmcbus;
1112 u_int numblocks, sz;
1117 mmcbus = sc->mmcbus;
1119 block = bp->bio_pblkno;
1120 sz = part->disk->d_sectorsize;
1121 end = bp->bio_pblkno + (bp->bio_bcount / sz);
1122 while (block < end) {
1123 vaddr = bp->bio_data + (block - bp->bio_pblkno) * sz;
1124 numblocks = min(end - block, sc->max_data);
1125 memset(&req, 0, sizeof(req));
1126 memset(&cmd, 0, sizeof(cmd));
1127 memset(&stop, 0, sizeof(stop));
1128 memset(&data, 0, sizeof(data));
1132 if (bp->bio_cmd == BIO_READ) {
1134 cmd.opcode = MMC_READ_MULTIPLE_BLOCK;
1136 cmd.opcode = MMC_READ_SINGLE_BLOCK;
1139 cmd.opcode = MMC_WRITE_MULTIPLE_BLOCK;
1141 cmd.opcode = MMC_WRITE_BLOCK;
1144 if (sc->high_cap == 0)
1146 cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC;
1149 if (bp->bio_cmd == BIO_READ)
1150 data.flags = MMC_DATA_READ;
1152 data.flags = MMC_DATA_WRITE;
1153 data.len = numblocks * sz;
1154 if (numblocks > 1) {
1155 data.flags |= MMC_DATA_MULTI;
1156 stop.opcode = MMC_STOP_TRANSMISSION;
1158 stop.flags = MMC_RSP_R1B | MMC_CMD_AC;
1162 MMCBUS_WAIT_FOR_REQUEST(mmcbus, dev, &req);
1163 if (req.cmd->error != MMC_ERR_NONE) {
1164 if (ppsratecheck(&sc->log_time, &sc->log_count,
1166 device_printf(dev, "Error indicated: %d %s\n",
1168 mmcsd_errmsg(req.cmd->error));
1177 mmcsd_delete(struct mmcsd_part *part, struct bio *bp)
1179 daddr_t block, end, start, stop;
1180 struct mmc_command cmd;
1181 struct mmc_request req;
1182 struct mmcsd_softc *sc;
1183 device_t dev, mmcbus;
1184 u_int erase_sector, sz;
1190 mmcbus = sc->mmcbus;
1192 block = bp->bio_pblkno;
1193 sz = part->disk->d_sectorsize;
1194 end = bp->bio_pblkno + (bp->bio_bcount / sz);
1195 use_trim = sc->flags & MMCSD_USE_TRIM;
1196 if (use_trim == true) {
1200 /* Coalesce with the remainder of the previous request. */
1201 if (block > part->eblock && block <= part->eend)
1202 block = part->eblock;
1203 if (end >= part->eblock && end < part->eend)
1205 /* Safely round to the erase sector boundaries. */
1206 erase_sector = sc->erase_sector;
1207 start = block + erase_sector - 1; /* Round up. */
1208 start -= start % erase_sector;
1209 stop = end; /* Round down. */
1210 stop -= end % erase_sector;
1212 * We can't erase an area smaller than an erase sector, so
1213 * store it for later.
1215 if (start >= stop) {
1216 part->eblock = block;
1222 if ((sc->flags & MMCSD_INAND_CMD38) != 0) {
1223 err = mmc_switch(mmcbus, dev, sc->rca, EXT_CSD_CMD_SET_NORMAL,
1224 EXT_CSD_INAND_CMD38, use_trim == true ?
1225 EXT_CSD_INAND_CMD38_TRIM : EXT_CSD_INAND_CMD38_ERASE,
1226 sc->cmd6_time, true);
1227 if (err != MMC_ERR_NONE) {
1229 "Setting iNAND erase command failed %s\n",
1236 * Pause re-tuning so it won't interfere with the order of erase
1237 * commands. Note that these latter don't use the data lines, so
1238 * re-tuning shouldn't actually become necessary during erase.
1240 MMCBUS_RETUNE_PAUSE(mmcbus, dev, false);
1241 /* Set erase start position. */
1242 memset(&req, 0, sizeof(req));
1243 memset(&cmd, 0, sizeof(cmd));
1246 if (mmc_get_card_type(dev) == mode_sd)
1247 cmd.opcode = SD_ERASE_WR_BLK_START;
1249 cmd.opcode = MMC_ERASE_GROUP_START;
1251 if (sc->high_cap == 0)
1253 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1254 MMCBUS_WAIT_FOR_REQUEST(mmcbus, dev, &req);
1255 if (req.cmd->error != MMC_ERR_NONE) {
1256 device_printf(dev, "Setting erase start position failed %s\n",
1257 mmcsd_errmsg(req.cmd->error));
1258 block = bp->bio_pblkno;
1261 /* Set erase stop position. */
1262 memset(&req, 0, sizeof(req));
1263 memset(&cmd, 0, sizeof(cmd));
1265 if (mmc_get_card_type(dev) == mode_sd)
1266 cmd.opcode = SD_ERASE_WR_BLK_END;
1268 cmd.opcode = MMC_ERASE_GROUP_END;
1270 if (sc->high_cap == 0)
1273 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1274 MMCBUS_WAIT_FOR_REQUEST(mmcbus, dev, &req);
1275 if (req.cmd->error != MMC_ERR_NONE) {
1276 device_printf(dev, "Setting erase stop position failed %s\n",
1277 mmcsd_errmsg(req.cmd->error));
1278 block = bp->bio_pblkno;
1282 memset(&req, 0, sizeof(req));
1283 memset(&cmd, 0, sizeof(cmd));
1285 cmd.opcode = MMC_ERASE;
1286 cmd.arg = use_trim == true ? MMC_ERASE_TRIM : MMC_ERASE_ERASE;
1287 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC;
1288 MMCBUS_WAIT_FOR_REQUEST(mmcbus, dev, &req);
1289 if (req.cmd->error != MMC_ERR_NONE) {
1290 device_printf(dev, "Issuing erase command failed %s\n",
1291 mmcsd_errmsg(req.cmd->error));
1292 block = bp->bio_pblkno;
1295 if (use_trim == false) {
1296 /* Store one of the remaining parts for the next call. */
1297 if (bp->bio_pblkno >= part->eblock || block == start) {
1298 part->eblock = stop; /* Predict next forward. */
1301 part->eblock = block; /* Predict next backward. */
1307 MMCBUS_RETUNE_UNPAUSE(mmcbus, dev);
1312 mmcsd_dump(void *arg, void *virtual, vm_offset_t physical, off_t offset,
1318 struct mmcsd_softc *sc;
1319 struct mmcsd_part *part;
1320 device_t dev, mmcbus;
1323 /* length zero is special and really means flush buffers to media */
1328 part = disk->d_drv1;
1331 mmcbus = sc->mmcbus;
1335 bp.bio_pblkno = offset / disk->d_sectorsize;
1336 bp.bio_bcount = length;
1337 bp.bio_data = virtual;
1338 bp.bio_cmd = BIO_WRITE;
1339 end = bp.bio_pblkno + bp.bio_bcount / disk->d_sectorsize;
1340 MMCBUS_ACQUIRE_BUS(mmcbus, dev);
1341 err = mmcsd_switch_part(mmcbus, dev, sc->rca, part->type);
1342 if (err != MMC_ERR_NONE) {
1343 if (ppsratecheck(&sc->log_time, &sc->log_count, LOG_PPS))
1344 device_printf(dev, "Partition switch error\n");
1345 MMCBUS_RELEASE_BUS(mmcbus, dev);
1348 block = mmcsd_rw(part, &bp);
1349 MMCBUS_RELEASE_BUS(mmcbus, dev);
1350 return ((end < block) ? EIO : 0);
1354 mmcsd_task(void *arg)
1357 struct mmcsd_part *part;
1358 struct mmcsd_softc *sc;
1360 device_t dev, mmcbus;
1366 mmcbus = sc->mmcbus;
1369 MMCSD_DISK_LOCK(part);
1371 if (part->running == 0)
1373 bp = bioq_takefirst(&part->bio_queue);
1375 msleep(part, &part->disk_mtx, PRIBIO,
1376 "mmcsd disk jobqueue", 0);
1377 } while (bp == NULL);
1378 MMCSD_DISK_UNLOCK(part);
1379 if (bp->bio_cmd != BIO_READ && part->ro) {
1380 bp->bio_error = EROFS;
1381 bp->bio_resid = bp->bio_bcount;
1382 bp->bio_flags |= BIO_ERROR;
1386 MMCBUS_ACQUIRE_BUS(mmcbus, dev);
1387 sz = part->disk->d_sectorsize;
1388 block = bp->bio_pblkno;
1389 end = bp->bio_pblkno + (bp->bio_bcount / sz);
1390 err = mmcsd_switch_part(mmcbus, dev, sc->rca, part->type);
1391 if (err != MMC_ERR_NONE) {
1392 if (ppsratecheck(&sc->log_time, &sc->log_count,
1394 device_printf(dev, "Partition switch error\n");
1397 if (bp->bio_cmd == BIO_READ || bp->bio_cmd == BIO_WRITE) {
1398 /* Access to the remaining erase block obsoletes it. */
1399 if (block < part->eend && end > part->eblock)
1400 part->eblock = part->eend = 0;
1401 block = mmcsd_rw(part, bp);
1402 } else if (bp->bio_cmd == BIO_DELETE) {
1403 block = mmcsd_delete(part, bp);
1406 MMCBUS_RELEASE_BUS(mmcbus, dev);
1408 bp->bio_error = EIO;
1409 bp->bio_resid = (end - block) * sz;
1410 bp->bio_flags |= BIO_ERROR;
1417 /* tell parent we're done */
1419 MMCSD_DISK_UNLOCK(part);
1426 mmcsd_bus_bit_width(device_t dev)
1429 if (mmc_get_bus_width(dev) == bus_width_1)
1431 if (mmc_get_bus_width(dev) == bus_width_4)
1436 static device_method_t mmcsd_methods[] = {
1437 DEVMETHOD(device_probe, mmcsd_probe),
1438 DEVMETHOD(device_attach, mmcsd_attach),
1439 DEVMETHOD(device_detach, mmcsd_detach),
1440 DEVMETHOD(device_suspend, mmcsd_suspend),
1441 DEVMETHOD(device_resume, mmcsd_resume),
1445 static driver_t mmcsd_driver = {
1448 sizeof(struct mmcsd_softc),
1450 static devclass_t mmcsd_devclass;
1453 mmcsd_handler(module_t mod __unused, int what, void *arg __unused)
1458 flash_register_slicer(mmcsd_slicer, FLASH_SLICES_TYPE_MMC,
1462 flash_register_slicer(NULL, FLASH_SLICES_TYPE_MMC, TRUE);
1468 DRIVER_MODULE(mmcsd, mmc, mmcsd_driver, mmcsd_devclass, mmcsd_handler, NULL);
1469 MODULE_DEPEND(mmcsd, g_flashmap, 0, 0, 0);