2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2006 Bernd Walter. All rights reserved.
5 * Copyright (c) 2006 M. Warner Losh. All rights reserved.
6 * Copyright (c) 2017 Marius Strobl <marius@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Portions of this software may have been developed with reference to
29 * the SD Simplified Specification. The following disclaimer may apply:
31 * The following conditions apply to the release of the simplified
32 * specification ("Simplified Specification") by the SD Card Association and
33 * the SD Group. The Simplified Specification is a subset of the complete SD
34 * Specification which is owned by the SD Card Association and the SD
35 * Group. This Simplified Specification is provided on a non-confidential
36 * basis subject to the disclaimers below. Any implementation of the
37 * Simplified Specification may require a license from the SD Card
38 * Association, SD Group, SD-3C LLC or other third parties.
42 * The information contained in the Simplified Specification is presented only
43 * as a standard specification for SD Cards and SD Host/Ancillary products and
44 * is provided "AS-IS" without any representations or warranties of any
45 * kind. No responsibility is assumed by the SD Group, SD-3C LLC or the SD
46 * Card Association for any damages, any infringements of patents or other
47 * right of the SD Group, SD-3C LLC, the SD Card Association or any third
48 * parties, which may result from its use. No license is granted by
49 * implication, estoppel or otherwise under any patent or other rights of the
50 * SD Group, SD-3C LLC, the SD Card Association or any third party. Nothing
51 * herein shall be construed as an obligation by the SD Group, the SD-3C LLC
52 * or the SD Card Association to disclose or distribute any technical
53 * information, know-how or other confidential information to any third party.
56 #include <sys/cdefs.h>
57 __FBSDID("$FreeBSD$");
59 #include <sys/param.h>
60 #include <sys/systm.h>
64 #include <sys/fcntl.h>
65 #include <sys/ioccom.h>
66 #include <sys/kernel.h>
67 #include <sys/kthread.h>
69 #include <sys/malloc.h>
70 #include <sys/module.h>
71 #include <sys/mutex.h>
72 #include <sys/slicer.h>
75 #include <geom/geom.h>
76 #include <geom/geom_disk.h>
78 #include <dev/mmc/bridge.h>
79 #include <dev/mmc/mmc_ioctl.h>
80 #include <dev/mmc/mmc_subr.h>
81 #include <dev/mmc/mmcbrvar.h>
82 #include <dev/mmc/mmcreg.h>
83 #include <dev/mmc/mmcvar.h>
85 #include "mmcbus_if.h"
87 #if __FreeBSD_version < 800002
88 #define kproc_create kthread_create
89 #define kproc_exit kthread_exit
92 #define MMCSD_CMD_RETRIES 5
94 #define MMCSD_FMT_BOOT "mmcsd%dboot"
95 #define MMCSD_FMT_GP "mmcsd%dgp"
96 #define MMCSD_FMT_RPMB "mmcsd%drpmb"
97 #define MMCSD_LABEL_ENH "enh"
99 #define MMCSD_PART_NAMELEN (16 + 1)
105 struct mtx ioctl_mtx;
106 struct mmcsd_softc *sc;
109 struct bio_queue_head bio_queue;
110 daddr_t eblock, eend; /* Range remaining after the last erase. */
117 char name[MMCSD_PART_NAMELEN];
123 struct mmcsd_part *part[MMC_PART_MAX];
124 enum mmc_card_mode mode;
125 u_int max_data; /* Maximum data size [blocks] */
126 u_int erase_sector; /* Device native erase sector size [blocks] */
127 uint8_t high_cap; /* High Capacity device (block addressed) */
128 uint8_t part_curr; /* Partition currently switched to */
129 uint8_t ext_csd[MMC_EXTCSD_SIZE];
132 #define MMCSD_INAND_CMD38 0x0001
133 #define MMCSD_USE_TRIM 0x0002
134 uint32_t cmd6_time; /* Generic switch timeout [us] */
135 uint32_t part_time; /* Partition switch timeout [us] */
136 off_t enh_base; /* Enhanced user data area slice base ... */
137 off_t enh_size; /* ... and size [bytes] */
139 struct timeval log_time;
140 struct cdev *rpmb_dev;
143 static const char *errmsg[] =
154 #define LOG_PPS 5 /* Log no more than 5 errors per second. */
156 /* bus entry points */
157 static int mmcsd_attach(device_t dev);
158 static int mmcsd_detach(device_t dev);
159 static int mmcsd_probe(device_t dev);
162 static int mmcsd_close(struct disk *dp);
163 static int mmcsd_dump(void *arg, void *virtual, vm_offset_t physical,
164 off_t offset, size_t length);
165 static int mmcsd_getattr(struct bio *);
166 static int mmcsd_ioctl_disk(struct disk *disk, u_long cmd, void *data,
167 int fflag, struct thread *td);
168 static int mmcsd_open(struct disk *dp);
169 static void mmcsd_strategy(struct bio *bp);
170 static void mmcsd_task(void *arg);
172 /* RMPB cdev interface */
173 static int mmcsd_ioctl_rpmb(struct cdev *dev, u_long cmd, caddr_t data,
174 int fflag, struct thread *td);
176 static void mmcsd_add_part(struct mmcsd_softc *sc, u_int type,
177 const char *name, u_int cnt, off_t media_size, bool ro);
178 static int mmcsd_bus_bit_width(device_t dev);
179 static daddr_t mmcsd_delete(struct mmcsd_part *part, struct bio *bp);
180 static const char *mmcsd_errmsg(int e);
181 static int mmcsd_ioctl(struct mmcsd_part *part, u_long cmd, void *data,
183 static int mmcsd_ioctl_cmd(struct mmcsd_part *part, struct mmc_ioc_cmd *mic,
185 static uintmax_t mmcsd_pretty_size(off_t size, char *unit);
186 static daddr_t mmcsd_rw(struct mmcsd_part *part, struct bio *bp);
187 static int mmcsd_set_blockcount(struct mmcsd_softc *sc, u_int count, bool rel);
188 static int mmcsd_slicer(device_t dev, const char *provider,
189 struct flash_slice *slices, int *nslices);
190 static int mmcsd_switch_part(device_t bus, device_t dev, uint16_t rca,
193 #define MMCSD_DISK_LOCK(_part) mtx_lock(&(_part)->disk_mtx)
194 #define MMCSD_DISK_UNLOCK(_part) mtx_unlock(&(_part)->disk_mtx)
195 #define MMCSD_DISK_LOCK_INIT(_part) \
196 mtx_init(&(_part)->disk_mtx, (_part)->name, "mmcsd disk", MTX_DEF)
197 #define MMCSD_DISK_LOCK_DESTROY(_part) mtx_destroy(&(_part)->disk_mtx);
198 #define MMCSD_DISK_ASSERT_LOCKED(_part) \
199 mtx_assert(&(_part)->disk_mtx, MA_OWNED);
200 #define MMCSD_DISK_ASSERT_UNLOCKED(_part) \
201 mtx_assert(&(_part)->disk_mtx, MA_NOTOWNED);
203 #define MMCSD_IOCTL_LOCK(_part) mtx_lock(&(_part)->ioctl_mtx)
204 #define MMCSD_IOCTL_UNLOCK(_part) mtx_unlock(&(_part)->ioctl_mtx)
205 #define MMCSD_IOCTL_LOCK_INIT(_part) \
206 mtx_init(&(_part)->ioctl_mtx, (_part)->name, "mmcsd IOCTL", MTX_DEF)
207 #define MMCSD_IOCTL_LOCK_DESTROY(_part) mtx_destroy(&(_part)->ioctl_mtx);
208 #define MMCSD_IOCTL_ASSERT_LOCKED(_part) \
209 mtx_assert(&(_part)->ioctl_mtx, MA_OWNED);
210 #define MMCSD_IOCLT_ASSERT_UNLOCKED(_part) \
211 mtx_assert(&(_part)->ioctl_mtx, MA_NOTOWNED);
214 mmcsd_probe(device_t dev)
218 device_set_desc(dev, "MMC/SD Memory Card");
223 mmcsd_attach(device_t dev)
226 struct mmcsd_softc *sc;
227 const uint8_t *ext_csd;
228 off_t erase_size, sector_size, size, wp_size;
236 sc = device_get_softc(dev);
238 sc->mmcbus = mmcbus = device_get_parent(dev);
239 sc->mode = mmcbr_get_mode(mmcbus);
241 * Note that in principle with an SDHCI-like re-tuning implementation,
242 * the maximum data size can change at runtime due to a device removal/
243 * insertion that results in switches to/from a transfer mode involving
244 * re-tuning, iff there are multiple devices on a given bus. Until now
245 * mmc(4) lacks support for rescanning already attached buses, however,
246 * and sdhci(4) to date has no support for shared buses in the first
249 sc->max_data = mmc_get_max_data(dev);
250 sc->high_cap = mmc_get_high_cap(dev);
251 sc->rca = mmc_get_rca(dev);
252 sc->cmd6_time = mmc_get_cmd6_timeout(dev);
253 quirks = mmc_get_quirks(dev);
255 /* Only MMC >= 4.x devices support EXT_CSD. */
256 if (mmc_get_spec_vers(dev) >= 4) {
257 MMCBUS_ACQUIRE_BUS(mmcbus, dev);
258 err = mmc_send_ext_csd(mmcbus, dev, sc->ext_csd);
259 MMCBUS_RELEASE_BUS(mmcbus, dev);
260 if (err != MMC_ERR_NONE) {
261 device_printf(dev, "Error reading EXT_CSD %s\n",
266 ext_csd = sc->ext_csd;
268 if ((quirks & MMC_QUIRK_INAND_CMD38) != 0) {
269 if (mmc_get_spec_vers(dev) < 4) {
271 "MMC_QUIRK_INAND_CMD38 set but no EXT_CSD\n");
274 sc->flags |= MMCSD_INAND_CMD38;
278 * EXT_CSD_SEC_FEATURE_SUPPORT_GB_CL_EN denotes support for both
279 * insecure and secure TRIM.
281 if ((ext_csd[EXT_CSD_SEC_FEATURE_SUPPORT] &
282 EXT_CSD_SEC_FEATURE_SUPPORT_GB_CL_EN) != 0 &&
283 (quirks & MMC_QUIRK_BROKEN_TRIM) == 0) {
285 device_printf(dev, "taking advantage of TRIM\n");
286 sc->flags |= MMCSD_USE_TRIM;
287 sc->erase_sector = 1;
289 sc->erase_sector = mmc_get_erase_sector(dev);
292 * Enhanced user data area and general purpose partitions are only
293 * supported in revision 1.4 (EXT_CSD_REV == 4) and later, the RPMB
294 * partition in revision 1.5 (MMC v4.41, EXT_CSD_REV == 5) and later.
296 rev = ext_csd[EXT_CSD_REV];
299 * Ignore user-creatable enhanced user data area and general purpose
300 * partitions partitions as long as partitioning hasn't been finished.
302 comp = (ext_csd[EXT_CSD_PART_SET] & EXT_CSD_PART_SET_COMPLETED) != 0;
305 * Add enhanced user data area slice, unless it spans the entirety of
306 * the user data area. The enhanced area is of a multiple of high
307 * capacity write protect groups ((ERASE_GRP_SIZE + HC_WP_GRP_SIZE) *
308 * 512 KB) and its offset given in either sectors or bytes, depending
309 * on whether it's a high capacity device or not.
310 * NB: The slicer and its slices need to be registered before adding
311 * the disk for the corresponding user data area as re-tasting is
314 sector_size = mmc_get_sector_size(dev);
315 size = ext_csd[EXT_CSD_ENH_SIZE_MULT] +
316 (ext_csd[EXT_CSD_ENH_SIZE_MULT + 1] << 8) +
317 (ext_csd[EXT_CSD_ENH_SIZE_MULT + 2] << 16);
318 if (rev >= 4 && comp == TRUE && size > 0 &&
319 (ext_csd[EXT_CSD_PART_SUPPORT] &
320 EXT_CSD_PART_SUPPORT_ENH_ATTR_EN) != 0 &&
321 (ext_csd[EXT_CSD_PART_ATTR] & (EXT_CSD_PART_ATTR_ENH_USR)) != 0) {
322 erase_size = ext_csd[EXT_CSD_ERASE_GRP_SIZE] * 1024 *
324 wp_size = ext_csd[EXT_CSD_HC_WP_GRP_SIZE];
325 size *= erase_size * wp_size;
326 if (size != mmc_get_media_size(dev) * sector_size) {
328 sc->enh_base = (ext_csd[EXT_CSD_ENH_START_ADDR] +
329 (ext_csd[EXT_CSD_ENH_START_ADDR + 1] << 8) +
330 (ext_csd[EXT_CSD_ENH_START_ADDR + 2] << 16) +
331 (ext_csd[EXT_CSD_ENH_START_ADDR + 3] << 24)) *
332 (sc->high_cap == 0 ? MMC_SECTOR_SIZE : 1);
333 } else if (bootverbose)
335 "enhanced user data area spans entire device\n");
339 * Add default partition. This may be the only one or the user
340 * data area in case partitions are supported.
342 ro = mmc_get_read_only(dev);
343 mmcsd_add_part(sc, EXT_CSD_PART_CONFIG_ACC_DEFAULT, "mmcsd",
344 device_get_unit(dev), mmc_get_media_size(dev) * sector_size, ro);
346 if (mmc_get_spec_vers(dev) < 3)
349 /* Belatedly announce enhanced user data slice. */
350 if (sc->enh_size != 0) {
351 bytes = mmcsd_pretty_size(size, unit);
352 printf(FLASH_SLICES_FMT ": %ju%sB enhanced user data area "
353 "slice offset 0x%jx at %s\n", device_get_nameunit(dev),
354 MMCSD_LABEL_ENH, bytes, unit, (uintmax_t)sc->enh_base,
355 device_get_nameunit(dev));
359 * Determine partition switch timeout (provided in units of 10 ms)
360 * and ensure it's at least 300 ms as some eMMC chips lie.
362 sc->part_time = max(ext_csd[EXT_CSD_PART_SWITCH_TO] * 10 * 1000,
365 /* Add boot partitions, which are of a fixed multiple of 128 KB. */
366 size = ext_csd[EXT_CSD_BOOT_SIZE_MULT] * MMC_BOOT_RPMB_BLOCK_SIZE;
367 if (size > 0 && (mmcbr_get_caps(mmcbus) & MMC_CAP_BOOT_NOACC) == 0) {
368 mmcsd_add_part(sc, EXT_CSD_PART_CONFIG_ACC_BOOT0,
369 MMCSD_FMT_BOOT, 0, size,
370 ro | ((ext_csd[EXT_CSD_BOOT_WP_STATUS] &
371 EXT_CSD_BOOT_WP_STATUS_BOOT0_MASK) != 0));
372 mmcsd_add_part(sc, EXT_CSD_PART_CONFIG_ACC_BOOT1,
373 MMCSD_FMT_BOOT, 1, size,
374 ro | ((ext_csd[EXT_CSD_BOOT_WP_STATUS] &
375 EXT_CSD_BOOT_WP_STATUS_BOOT1_MASK) != 0));
378 /* Add RPMB partition, which also is of a fixed multiple of 128 KB. */
379 size = ext_csd[EXT_CSD_RPMB_MULT] * MMC_BOOT_RPMB_BLOCK_SIZE;
380 if (rev >= 5 && size > 0)
381 mmcsd_add_part(sc, EXT_CSD_PART_CONFIG_ACC_RPMB,
382 MMCSD_FMT_RPMB, 0, size, ro);
384 if (rev <= 3 || comp == FALSE)
388 * Add general purpose partitions, which are of a multiple of high
389 * capacity write protect groups, too.
391 if ((ext_csd[EXT_CSD_PART_SUPPORT] & EXT_CSD_PART_SUPPORT_EN) != 0) {
392 erase_size = ext_csd[EXT_CSD_ERASE_GRP_SIZE] * 1024 *
394 wp_size = ext_csd[EXT_CSD_HC_WP_GRP_SIZE];
395 for (i = 0; i < MMC_PART_GP_MAX; i++) {
396 size = ext_csd[EXT_CSD_GP_SIZE_MULT + i * 3] +
397 (ext_csd[EXT_CSD_GP_SIZE_MULT + i * 3 + 1] << 8) +
398 (ext_csd[EXT_CSD_GP_SIZE_MULT + i * 3 + 2] << 16);
401 mmcsd_add_part(sc, EXT_CSD_PART_CONFIG_ACC_GP0 + i,
402 MMCSD_FMT_GP, i, size * erase_size * wp_size, ro);
409 mmcsd_pretty_size(off_t size, char *unit)
415 * Display in most natural units. There's no card < 1MB. However,
416 * RPMB partitions occasionally are smaller than that, though. The
417 * SD standard goes to 2 GiB due to its reliance on FAT, but the data
418 * format supports up to 4 GiB and some card makers push it up to this
419 * limit. The SDHC standard only goes to 32 GiB due to FAT32, but the
420 * data format supports up to 2 TiB however. 2048 GB isn't too ugly,
421 * so we note it in passing here and don't add the code to print TB).
422 * Since these cards are sold in terms of MB and GB not MiB and GiB,
423 * report them like that. We also round to the nearest unit, since
424 * many cards are a few percent short, even of the power of 10 size.
427 unit[0] = unit[1] = '\0';
428 for (i = 0; i <= 2 && bytes >= 1000; i++) {
429 bytes = (bytes + 1000 / 2 - 1) / 1000;
447 static struct cdevsw mmcsd_rpmb_cdevsw = {
448 .d_version = D_VERSION,
449 .d_name = "mmcsdrpmb",
450 .d_ioctl = mmcsd_ioctl_rpmb
454 mmcsd_add_part(struct mmcsd_softc *sc, u_int type, const char *name, u_int cnt,
455 off_t media_size, bool ro)
457 struct make_dev_args args;
458 device_t dev, mmcbus;
460 const uint8_t *ext_csd;
461 struct mmcsd_part *part;
472 part = sc->part[type] = malloc(sizeof(*part), M_DEVBUF,
478 snprintf(part->name, sizeof(part->name), name, device_get_unit(dev));
480 MMCSD_IOCTL_LOCK_INIT(part);
483 * For the RPMB partition, allow IOCTL access only.
484 * NB: If ever attaching RPMB partitions to disk(9), the re-tuning
485 * implementation and especially its pausing need to be revisited,
486 * because then re-tuning requests may be issued by the IOCTL half
487 * of this driver while re-tuning is already paused by the disk(9)
488 * one and vice versa.
490 if (type == EXT_CSD_PART_CONFIG_ACC_RPMB) {
491 make_dev_args_init(&args);
492 args.mda_flags = MAKEDEV_CHECKNAME | MAKEDEV_WAITOK;
493 args.mda_devsw = &mmcsd_rpmb_cdevsw;
494 args.mda_uid = UID_ROOT;
495 args.mda_gid = GID_OPERATOR;
496 args.mda_mode = 0640;
497 args.mda_si_drv1 = part;
498 if (make_dev_s(&args, &sc->rpmb_dev, "%s", part->name) != 0) {
499 device_printf(dev, "Failed to make RPMB device\n");
500 free(part, M_DEVBUF);
504 MMCSD_DISK_LOCK_INIT(part);
506 d = part->disk = disk_alloc();
507 d->d_open = mmcsd_open;
508 d->d_close = mmcsd_close;
509 d->d_strategy = mmcsd_strategy;
510 d->d_ioctl = mmcsd_ioctl_disk;
511 d->d_dump = mmcsd_dump;
512 d->d_getattr = mmcsd_getattr;
513 d->d_name = part->name;
515 d->d_sectorsize = mmc_get_sector_size(dev);
516 d->d_maxsize = sc->max_data * d->d_sectorsize;
517 d->d_mediasize = media_size;
518 d->d_stripesize = sc->erase_sector * d->d_sectorsize;
520 d->d_flags = DISKFLAG_CANDELETE;
521 d->d_delmaxsize = mmc_get_erase_sector(dev) * d->d_sectorsize;
522 strlcpy(d->d_ident, mmc_get_card_sn_string(dev),
524 strlcpy(d->d_descr, mmc_get_card_id_string(dev),
526 d->d_rotation_rate = DISK_RR_NON_ROTATING;
528 disk_create(d, DISK_VERSION);
529 bioq_init(&part->bio_queue);
532 kproc_create(&mmcsd_task, part, &part->p, 0, 0,
533 "%s%d: mmc/sd card", part->name, cnt);
536 bytes = mmcsd_pretty_size(media_size, unit);
537 if (type == EXT_CSD_PART_CONFIG_ACC_DEFAULT) {
538 speed = mmcbr_get_clock(mmcbus);
539 printf("%s%d: %ju%sB <%s>%s at %s %d.%01dMHz/%dbit/%d-block\n",
540 part->name, cnt, bytes, unit, mmc_get_card_id_string(dev),
541 ro ? " (read-only)" : "", device_get_nameunit(mmcbus),
542 speed / 1000000, (speed / 100000) % 10,
543 mmcsd_bus_bit_width(dev), sc->max_data);
544 } else if (type == EXT_CSD_PART_CONFIG_ACC_RPMB) {
545 printf("%s: %ju%sB partion %d%s at %s\n", part->name, bytes,
546 unit, type, ro ? " (read-only)" : "",
547 device_get_nameunit(dev));
552 if (type >= EXT_CSD_PART_CONFIG_ACC_GP0 &&
553 type <= EXT_CSD_PART_CONFIG_ACC_GP3) {
554 ext_csd = sc->ext_csd;
555 gp = type - EXT_CSD_PART_CONFIG_ACC_GP0;
556 if ((ext_csd[EXT_CSD_PART_SUPPORT] &
557 EXT_CSD_PART_SUPPORT_ENH_ATTR_EN) != 0 &&
558 (ext_csd[EXT_CSD_PART_ATTR] &
559 (EXT_CSD_PART_ATTR_ENH_GP0 << gp)) != 0)
561 else if ((ext_csd[EXT_CSD_PART_SUPPORT] &
562 EXT_CSD_PART_SUPPORT_EXT_ATTR_EN) != 0) {
563 extattr = (ext_csd[EXT_CSD_EXT_PART_ATTR +
564 (gp / 2)] >> (4 * (gp % 2))) & 0xF;
566 case EXT_CSD_EXT_PART_ATTR_DEFAULT:
568 case EXT_CSD_EXT_PART_ATTR_SYSTEMCODE:
571 case EXT_CSD_EXT_PART_ATTR_NPERSISTENT:
572 ext = "non-persistent";
581 printf("%s%d: %ju%sB partion %d%s%s at %s\n",
582 part->name, cnt, bytes, unit, type, enh ?
583 " enhanced" : "", ro ? " (read-only)" : "",
584 device_get_nameunit(dev));
586 printf("%s%d: %ju%sB partion %d extended 0x%x "
587 "(%s)%s at %s\n", part->name, cnt, bytes, unit,
588 type, extattr, ext, ro ? " (read-only)" : "",
589 device_get_nameunit(dev));
594 mmcsd_slicer(device_t dev, const char *provider,
595 struct flash_slice *slices, int *nslices)
597 char name[MMCSD_PART_NAMELEN];
598 struct mmcsd_softc *sc;
599 struct mmcsd_part *part;
605 sc = device_get_softc(dev);
606 if (sc->enh_size == 0)
609 part = sc->part[EXT_CSD_PART_CONFIG_ACC_DEFAULT];
610 snprintf(name, sizeof(name), "%s%d", part->disk->d_name,
612 if (strcmp(name, provider) != 0)
616 slices[0].base = sc->enh_base;
617 slices[0].size = sc->enh_size;
618 slices[0].label = MMCSD_LABEL_ENH;
623 mmcsd_detach(device_t dev)
625 struct mmcsd_softc *sc = device_get_softc(dev);
626 struct mmcsd_part *part;
629 for (i = 0; i < MMC_PART_MAX; i++) {
632 if (part->disk != NULL) {
633 MMCSD_DISK_LOCK(part);
635 if (part->running > 0) {
639 /* wait for thread to finish. */
640 while (part->running != -1)
641 msleep(part, &part->disk_mtx, 0,
642 "mmcsd disk detach", 0);
644 MMCSD_DISK_UNLOCK(part);
646 MMCSD_IOCTL_LOCK(part);
647 while (part->ioctl > 0)
648 msleep(part, &part->ioctl_mtx, 0,
649 "mmcsd IOCTL detach", 0);
651 MMCSD_IOCTL_UNLOCK(part);
655 if (sc->rpmb_dev != NULL)
656 destroy_dev(sc->rpmb_dev);
658 for (i = 0; i < MMC_PART_MAX; i++) {
661 if (part->disk != NULL) {
662 /* Flush the request queue. */
663 bioq_flush(&part->bio_queue, NULL, ENXIO);
665 disk_destroy(part->disk);
667 MMCSD_DISK_LOCK_DESTROY(part);
669 MMCSD_IOCTL_LOCK_DESTROY(part);
670 free(part, M_DEVBUF);
677 mmcsd_suspend(device_t dev)
679 struct mmcsd_softc *sc = device_get_softc(dev);
680 struct mmcsd_part *part;
683 for (i = 0; i < MMC_PART_MAX; i++) {
686 if (part->disk != NULL) {
687 MMCSD_DISK_LOCK(part);
689 if (part->running > 0) {
693 /* wait for thread to finish. */
694 while (part->running != -1)
695 msleep(part, &part->disk_mtx, 0,
696 "mmcsd disk suspension", 0);
698 MMCSD_DISK_UNLOCK(part);
700 MMCSD_IOCTL_LOCK(part);
701 while (part->ioctl > 0)
702 msleep(part, &part->ioctl_mtx, 0,
703 "mmcsd IOCTL suspension", 0);
705 MMCSD_IOCTL_UNLOCK(part);
712 mmcsd_resume(device_t dev)
714 struct mmcsd_softc *sc = device_get_softc(dev);
715 struct mmcsd_part *part;
718 for (i = 0; i < MMC_PART_MAX; i++) {
721 if (part->disk != NULL) {
722 MMCSD_DISK_LOCK(part);
724 if (part->running <= 0) {
726 MMCSD_DISK_UNLOCK(part);
727 kproc_create(&mmcsd_task, part,
728 &part->p, 0, 0, "%s%d: mmc/sd card",
729 part->name, part->cnt);
731 MMCSD_DISK_UNLOCK(part);
733 MMCSD_IOCTL_LOCK(part);
735 MMCSD_IOCTL_UNLOCK(part);
742 mmcsd_open(struct disk *dp __unused)
749 mmcsd_close(struct disk *dp __unused)
756 mmcsd_strategy(struct bio *bp)
758 struct mmcsd_part *part;
760 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);
918 * No partition switching in userland; it's almost impossible
919 * to recover from that, especially if things go wrong.
921 if (cmd.opcode == MMC_SWITCH_FUNC && dp != NULL &&
922 (((uint8_t *)dp)[EXT_CSD_PART_CONFIG] &
923 EXT_CSD_PART_CONFIG_ACC_MASK) != sc->part_curr) {
930 MMCBUS_ACQUIRE_BUS(mmcbus, dev);
931 err = mmcsd_switch_part(mmcbus, dev, rca, part->type);
932 if (err != MMC_ERR_NONE)
934 if (part->type == EXT_CSD_PART_CONFIG_ACC_RPMB) {
935 err = mmcsd_set_blockcount(sc, mic->blocks,
936 mic->write_flag & (1 << 31));
937 if (err != MMC_ERR_NONE)
940 if (mic->is_acmd != 0)
941 (void)mmc_wait_for_app_cmd(mmcbus, dev, rca, &cmd, 0);
943 (void)mmc_wait_for_cmd(mmcbus, dev, &cmd, 0);
944 if (part->type == EXT_CSD_PART_CONFIG_ACC_RPMB) {
946 * If the request went to the RPMB partition, try to ensure
947 * that the command actually has completed.
949 retries = MMCSD_CMD_RETRIES;
951 err = mmc_send_status(mmcbus, dev, rca, &status);
952 if (err != MMC_ERR_NONE)
954 if (R1_STATUS(status) == 0 &&
955 R1_CURRENT_STATE(status) != R1_STATE_PRG)
958 } while (retries-- > 0);
961 * If EXT_CSD was changed, our copy is outdated now. Specifically,
962 * the upper bits of EXT_CSD_PART_CONFIG used in mmcsd_switch_part(),
963 * so retrieve EXT_CSD again.
965 if (cmd.opcode == MMC_SWITCH_FUNC) {
966 err = mmc_send_ext_csd(mmcbus, dev, sc->ext_csd);
967 if (err != MMC_ERR_NONE)
971 if (part->type == EXT_CSD_PART_CONFIG_ACC_RPMB) {
973 * If the request went to the RPMB partition, always switch
974 * back to the default partition (see mmcsd_switch_part()).
976 err = mmcsd_switch_part(mmcbus, dev, rca,
977 EXT_CSD_PART_CONFIG_ACC_DEFAULT);
978 if (err != MMC_ERR_NONE)
981 MMCBUS_RELEASE_BUS(mmcbus, dev);
982 if (cmd.error != MMC_ERR_NONE) {
984 case MMC_ERR_TIMEOUT:
990 case MMC_ERR_INVALID:
993 case MMC_ERR_NO_MEMORY:
1002 memcpy(mic->response, cmd.resp, 4 * sizeof(uint32_t));
1003 if (mic->write_flag == 0 && len != 0) {
1004 err = copyout(dp, (void *)(uintptr_t)mic->data_ptr, len);
1011 MMCBUS_RELEASE_BUS(mmcbus, dev);
1015 MMCSD_IOCTL_LOCK(part);
1017 MMCSD_IOCTL_UNLOCK(part);
1025 mmcsd_getattr(struct bio *bp)
1027 struct mmcsd_part *part;
1030 if (strcmp(bp->bio_attribute, "MMC::device") == 0) {
1031 if (bp->bio_length != sizeof(dev))
1033 part = bp->bio_disk->d_drv1;
1034 dev = part->sc->dev;
1035 bcopy(&dev, bp->bio_data, sizeof(dev));
1036 bp->bio_completed = bp->bio_length;
1043 mmcsd_set_blockcount(struct mmcsd_softc *sc, u_int count, bool reliable)
1045 struct mmc_command cmd;
1046 struct mmc_request req;
1048 memset(&req, 0, sizeof(req));
1049 memset(&cmd, 0, sizeof(cmd));
1052 cmd.opcode = MMC_SET_BLOCK_COUNT;
1053 cmd.arg = count & 0x0000FFFF;
1056 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1057 MMCBUS_WAIT_FOR_REQUEST(sc->mmcbus, sc->dev, &req);
1062 mmcsd_switch_part(device_t bus, device_t dev, uint16_t rca, u_int part)
1064 struct mmcsd_softc *sc;
1068 sc = device_get_softc(dev);
1070 if (sc->mode == mode_sd)
1071 return (MMC_ERR_NONE);
1074 * According to section "6.2.2 Command restrictions" of the eMMC
1075 * specification v5.1, CMD19/CMD21 aren't allowed to be used with
1076 * RPMB partitions. So we pause re-tuning along with triggering
1077 * it up-front to decrease the likelihood of re-tuning becoming
1078 * necessary while accessing an RPMB partition. Consequently, an
1079 * RPMB partition should immediately be switched away from again
1080 * after an access in order to allow for re-tuning to take place
1083 if (part == EXT_CSD_PART_CONFIG_ACC_RPMB)
1084 MMCBUS_RETUNE_PAUSE(sc->mmcbus, sc->dev, true);
1086 if (sc->part_curr == part)
1087 return (MMC_ERR_NONE);
1089 value = (sc->ext_csd[EXT_CSD_PART_CONFIG] &
1090 ~EXT_CSD_PART_CONFIG_ACC_MASK) | part;
1092 err = mmc_switch(bus, dev, rca, EXT_CSD_CMD_SET_NORMAL,
1093 EXT_CSD_PART_CONFIG, value, sc->part_time, true);
1094 if (err != MMC_ERR_NONE) {
1095 if (part == EXT_CSD_PART_CONFIG_ACC_RPMB)
1096 MMCBUS_RETUNE_UNPAUSE(sc->mmcbus, sc->dev);
1100 sc->ext_csd[EXT_CSD_PART_CONFIG] = value;
1101 if (sc->part_curr == EXT_CSD_PART_CONFIG_ACC_RPMB)
1102 MMCBUS_RETUNE_UNPAUSE(sc->mmcbus, sc->dev);
1103 sc->part_curr = part;
1104 return (MMC_ERR_NONE);
1111 if (e < 0 || e > MMC_ERR_MAX)
1112 return "Bad error code";
1117 mmcsd_rw(struct mmcsd_part *part, struct bio *bp)
1120 struct mmc_command cmd;
1121 struct mmc_command stop;
1122 struct mmc_request req;
1123 struct mmc_data data;
1124 struct mmcsd_softc *sc;
1125 device_t dev, mmcbus;
1126 u_int numblocks, sz;
1131 mmcbus = sc->mmcbus;
1133 block = bp->bio_pblkno;
1134 sz = part->disk->d_sectorsize;
1135 end = bp->bio_pblkno + (bp->bio_bcount / sz);
1136 while (block < end) {
1137 vaddr = bp->bio_data + (block - bp->bio_pblkno) * sz;
1138 numblocks = min(end - block, sc->max_data);
1139 memset(&req, 0, sizeof(req));
1140 memset(&cmd, 0, sizeof(cmd));
1141 memset(&stop, 0, sizeof(stop));
1142 memset(&data, 0, sizeof(data));
1146 if (bp->bio_cmd == BIO_READ) {
1148 cmd.opcode = MMC_READ_MULTIPLE_BLOCK;
1150 cmd.opcode = MMC_READ_SINGLE_BLOCK;
1153 cmd.opcode = MMC_WRITE_MULTIPLE_BLOCK;
1155 cmd.opcode = MMC_WRITE_BLOCK;
1158 if (sc->high_cap == 0)
1160 cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC;
1163 if (bp->bio_cmd == BIO_READ)
1164 data.flags = MMC_DATA_READ;
1166 data.flags = MMC_DATA_WRITE;
1167 data.len = numblocks * sz;
1168 if (numblocks > 1) {
1169 data.flags |= MMC_DATA_MULTI;
1170 stop.opcode = MMC_STOP_TRANSMISSION;
1172 stop.flags = MMC_RSP_R1B | MMC_CMD_AC;
1176 MMCBUS_WAIT_FOR_REQUEST(mmcbus, dev, &req);
1177 if (req.cmd->error != MMC_ERR_NONE) {
1178 if (ppsratecheck(&sc->log_time, &sc->log_count,
1180 device_printf(dev, "Error indicated: %d %s\n",
1182 mmcsd_errmsg(req.cmd->error));
1191 mmcsd_delete(struct mmcsd_part *part, struct bio *bp)
1193 daddr_t block, end, start, stop;
1194 struct mmc_command cmd;
1195 struct mmc_request req;
1196 struct mmcsd_softc *sc;
1197 device_t dev, mmcbus;
1198 u_int erase_sector, sz;
1204 mmcbus = sc->mmcbus;
1206 block = bp->bio_pblkno;
1207 sz = part->disk->d_sectorsize;
1208 end = bp->bio_pblkno + (bp->bio_bcount / sz);
1209 use_trim = sc->flags & MMCSD_USE_TRIM;
1210 if (use_trim == true) {
1214 /* Coalesce with the remainder of the previous request. */
1215 if (block > part->eblock && block <= part->eend)
1216 block = part->eblock;
1217 if (end >= part->eblock && end < part->eend)
1219 /* Safely round to the erase sector boundaries. */
1220 erase_sector = sc->erase_sector;
1221 start = block + erase_sector - 1; /* Round up. */
1222 start -= start % erase_sector;
1223 stop = end; /* Round down. */
1224 stop -= end % erase_sector;
1226 * We can't erase an area smaller than an erase sector, so
1227 * store it for later.
1229 if (start >= stop) {
1230 part->eblock = block;
1236 if ((sc->flags & MMCSD_INAND_CMD38) != 0) {
1237 err = mmc_switch(mmcbus, dev, sc->rca, EXT_CSD_CMD_SET_NORMAL,
1238 EXT_CSD_INAND_CMD38, use_trim == true ?
1239 EXT_CSD_INAND_CMD38_TRIM : EXT_CSD_INAND_CMD38_ERASE,
1240 sc->cmd6_time, true);
1241 if (err != MMC_ERR_NONE) {
1243 "Setting iNAND erase command failed %s\n",
1250 * Pause re-tuning so it won't interfere with the order of erase
1251 * commands. Note that these latter don't use the data lines, so
1252 * re-tuning shouldn't actually become necessary during erase.
1254 MMCBUS_RETUNE_PAUSE(mmcbus, dev, false);
1255 /* Set erase start position. */
1256 memset(&req, 0, sizeof(req));
1257 memset(&cmd, 0, sizeof(cmd));
1260 if (mmc_get_card_type(dev) == mode_sd)
1261 cmd.opcode = SD_ERASE_WR_BLK_START;
1263 cmd.opcode = MMC_ERASE_GROUP_START;
1265 if (sc->high_cap == 0)
1267 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1268 MMCBUS_WAIT_FOR_REQUEST(mmcbus, dev, &req);
1269 if (req.cmd->error != MMC_ERR_NONE) {
1270 device_printf(dev, "Setting erase start position failed %s\n",
1271 mmcsd_errmsg(req.cmd->error));
1272 block = bp->bio_pblkno;
1275 /* Set erase stop position. */
1276 memset(&req, 0, sizeof(req));
1277 memset(&cmd, 0, sizeof(cmd));
1279 if (mmc_get_card_type(dev) == mode_sd)
1280 cmd.opcode = SD_ERASE_WR_BLK_END;
1282 cmd.opcode = MMC_ERASE_GROUP_END;
1284 if (sc->high_cap == 0)
1287 cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
1288 MMCBUS_WAIT_FOR_REQUEST(mmcbus, dev, &req);
1289 if (req.cmd->error != MMC_ERR_NONE) {
1290 device_printf(dev, "Setting erase stop position failed %s\n",
1291 mmcsd_errmsg(req.cmd->error));
1292 block = bp->bio_pblkno;
1296 memset(&req, 0, sizeof(req));
1297 memset(&cmd, 0, sizeof(cmd));
1299 cmd.opcode = MMC_ERASE;
1300 cmd.arg = use_trim == true ? MMC_ERASE_TRIM : MMC_ERASE_ERASE;
1301 cmd.flags = MMC_RSP_R1B | MMC_CMD_AC;
1302 MMCBUS_WAIT_FOR_REQUEST(mmcbus, dev, &req);
1303 if (req.cmd->error != MMC_ERR_NONE) {
1304 device_printf(dev, "Issuing erase command failed %s\n",
1305 mmcsd_errmsg(req.cmd->error));
1306 block = bp->bio_pblkno;
1309 if (use_trim == false) {
1310 /* Store one of the remaining parts for the next call. */
1311 if (bp->bio_pblkno >= part->eblock || block == start) {
1312 part->eblock = stop; /* Predict next forward. */
1315 part->eblock = block; /* Predict next backward. */
1321 MMCBUS_RETUNE_UNPAUSE(mmcbus, dev);
1326 mmcsd_dump(void *arg, void *virtual, vm_offset_t physical, off_t offset,
1332 struct mmcsd_softc *sc;
1333 struct mmcsd_part *part;
1334 device_t dev, mmcbus;
1337 /* length zero is special and really means flush buffers to media */
1342 part = disk->d_drv1;
1345 mmcbus = sc->mmcbus;
1349 bp.bio_pblkno = offset / disk->d_sectorsize;
1350 bp.bio_bcount = length;
1351 bp.bio_data = virtual;
1352 bp.bio_cmd = BIO_WRITE;
1353 end = bp.bio_pblkno + bp.bio_bcount / disk->d_sectorsize;
1354 MMCBUS_ACQUIRE_BUS(mmcbus, dev);
1355 err = mmcsd_switch_part(mmcbus, dev, sc->rca, part->type);
1356 if (err != MMC_ERR_NONE) {
1357 if (ppsratecheck(&sc->log_time, &sc->log_count, LOG_PPS))
1358 device_printf(dev, "Partition switch error\n");
1359 MMCBUS_RELEASE_BUS(mmcbus, dev);
1362 block = mmcsd_rw(part, &bp);
1363 MMCBUS_RELEASE_BUS(mmcbus, dev);
1364 return ((end < block) ? EIO : 0);
1368 mmcsd_task(void *arg)
1371 struct mmcsd_part *part;
1372 struct mmcsd_softc *sc;
1374 device_t dev, mmcbus;
1380 mmcbus = sc->mmcbus;
1383 MMCSD_DISK_LOCK(part);
1385 if (part->running == 0)
1387 bp = bioq_takefirst(&part->bio_queue);
1389 msleep(part, &part->disk_mtx, PRIBIO,
1390 "mmcsd disk jobqueue", 0);
1391 } while (bp == NULL);
1392 MMCSD_DISK_UNLOCK(part);
1393 if (bp->bio_cmd != BIO_READ && part->ro) {
1394 bp->bio_error = EROFS;
1395 bp->bio_resid = bp->bio_bcount;
1396 bp->bio_flags |= BIO_ERROR;
1400 MMCBUS_ACQUIRE_BUS(mmcbus, dev);
1401 sz = part->disk->d_sectorsize;
1402 block = bp->bio_pblkno;
1403 end = bp->bio_pblkno + (bp->bio_bcount / sz);
1404 err = mmcsd_switch_part(mmcbus, dev, sc->rca, part->type);
1405 if (err != MMC_ERR_NONE) {
1406 if (ppsratecheck(&sc->log_time, &sc->log_count,
1408 device_printf(dev, "Partition switch error\n");
1411 if (bp->bio_cmd == BIO_READ || bp->bio_cmd == BIO_WRITE) {
1412 /* Access to the remaining erase block obsoletes it. */
1413 if (block < part->eend && end > part->eblock)
1414 part->eblock = part->eend = 0;
1415 block = mmcsd_rw(part, bp);
1416 } else if (bp->bio_cmd == BIO_DELETE) {
1417 block = mmcsd_delete(part, bp);
1420 MMCBUS_RELEASE_BUS(mmcbus, dev);
1422 bp->bio_error = EIO;
1423 bp->bio_resid = (end - block) * sz;
1424 bp->bio_flags |= BIO_ERROR;
1431 /* tell parent we're done */
1433 MMCSD_DISK_UNLOCK(part);
1440 mmcsd_bus_bit_width(device_t dev)
1443 if (mmc_get_bus_width(dev) == bus_width_1)
1445 if (mmc_get_bus_width(dev) == bus_width_4)
1450 static device_method_t mmcsd_methods[] = {
1451 DEVMETHOD(device_probe, mmcsd_probe),
1452 DEVMETHOD(device_attach, mmcsd_attach),
1453 DEVMETHOD(device_detach, mmcsd_detach),
1454 DEVMETHOD(device_suspend, mmcsd_suspend),
1455 DEVMETHOD(device_resume, mmcsd_resume),
1459 static driver_t mmcsd_driver = {
1462 sizeof(struct mmcsd_softc),
1464 static devclass_t mmcsd_devclass;
1467 mmcsd_handler(module_t mod __unused, int what, void *arg __unused)
1472 flash_register_slicer(mmcsd_slicer, FLASH_SLICES_TYPE_MMC,
1476 flash_register_slicer(NULL, FLASH_SLICES_TYPE_MMC, TRUE);
1482 DRIVER_MODULE(mmcsd, mmc, mmcsd_driver, mmcsd_devclass, mmcsd_handler, NULL);
1483 MODULE_DEPEND(mmcsd, g_flashmap, 0, 0, 0);