1 // SPDX-License-Identifier: GPL-2.0
3 * Block driver for media (i.e., flash cards)
5 * Copyright 2002 Hewlett-Packard Company
6 * Copyright 2005-2008 Pierre Ossman
8 * Use consistent with the GNU GPL is permitted,
9 * provided that this copyright notice is
10 * preserved in its entirety in all copies and derived works.
12 * HEWLETT-PACKARD COMPANY MAKES NO WARRANTIES, EXPRESSED OR IMPLIED,
13 * AS TO THE USEFULNESS OR CORRECTNESS OF THIS CODE OR ITS
14 * FITNESS FOR ANY PARTICULAR PURPOSE.
16 * Many thanks to Alessandro Rubini and Jonathan Corbet!
18 * Author: Andrew Christian
21 #include <linux/moduleparam.h>
22 #include <linux/module.h>
23 #include <linux/init.h>
25 #include <linux/kernel.h>
27 #include <linux/slab.h>
28 #include <linux/errno.h>
29 #include <linux/hdreg.h>
30 #include <linux/kdev_t.h>
31 #include <linux/kref.h>
32 #include <linux/blkdev.h>
33 #include <linux/cdev.h>
34 #include <linux/mutex.h>
35 #include <linux/scatterlist.h>
36 #include <linux/string_helpers.h>
37 #include <linux/delay.h>
38 #include <linux/capability.h>
39 #include <linux/compat.h>
40 #include <linux/pm_runtime.h>
41 #include <linux/idr.h>
42 #include <linux/debugfs.h>
44 #include <linux/mmc/ioctl.h>
45 #include <linux/mmc/card.h>
46 #include <linux/mmc/host.h>
47 #include <linux/mmc/mmc.h>
48 #include <linux/mmc/sd.h>
50 #include <linux/uaccess.h>
63 MODULE_ALIAS("mmc:block");
64 #ifdef MODULE_PARAM_PREFIX
65 #undef MODULE_PARAM_PREFIX
67 #define MODULE_PARAM_PREFIX "mmcblk."
70 * Set a 10 second timeout for polling write request busy state. Note, mmc core
71 * is setting a 3 second timeout for SD cards, and SDHCI has long had a 10
72 * second software timer to timeout the whole request, so 10 seconds should be
75 #define MMC_BLK_TIMEOUT_MS (10 * 1000)
76 #define MMC_EXTRACT_INDEX_FROM_ARG(x) ((x & 0x00FF0000) >> 16)
77 #define MMC_EXTRACT_VALUE_FROM_ARG(x) ((x & 0x0000FF00) >> 8)
79 static DEFINE_MUTEX(block_mutex);
82 * The defaults come from config options but can be overriden by module
85 static int perdev_minors = CONFIG_MMC_BLOCK_MINORS;
88 * We've only got one major, so number of mmcblk devices is
89 * limited to (1 << 20) / number of minors per device. It is also
90 * limited by the MAX_DEVICES below.
92 static int max_devices;
94 #define MAX_DEVICES 256
96 static DEFINE_IDA(mmc_blk_ida);
97 static DEFINE_IDA(mmc_rpmb_ida);
99 struct mmc_blk_busy_data {
100 struct mmc_card *card;
105 * There is one mmc_blk_data per slot.
107 struct mmc_blk_data {
108 struct device *parent;
109 struct gendisk *disk;
110 struct mmc_queue queue;
111 struct list_head part;
112 struct list_head rpmbs;
115 #define MMC_BLK_CMD23 (1 << 0) /* Can do SET_BLOCK_COUNT for multiblock */
116 #define MMC_BLK_REL_WR (1 << 1) /* MMC Reliable write support */
119 unsigned int read_only;
120 unsigned int part_type;
121 unsigned int reset_done;
122 #define MMC_BLK_READ BIT(0)
123 #define MMC_BLK_WRITE BIT(1)
124 #define MMC_BLK_DISCARD BIT(2)
125 #define MMC_BLK_SECDISCARD BIT(3)
126 #define MMC_BLK_CQE_RECOVERY BIT(4)
127 #define MMC_BLK_TRIM BIT(5)
130 * Only set in main mmc_blk_data associated
131 * with mmc_card with dev_set_drvdata, and keeps
132 * track of the current selected device partition.
134 unsigned int part_curr;
135 #define MMC_BLK_PART_INVALID UINT_MAX /* Unknown partition active */
138 /* debugfs files (only in main mmc_blk_data) */
139 struct dentry *status_dentry;
140 struct dentry *ext_csd_dentry;
143 /* Device type for RPMB character devices */
144 static dev_t mmc_rpmb_devt;
146 /* Bus type for RPMB character devices */
147 static struct bus_type mmc_rpmb_bus_type = {
152 * struct mmc_rpmb_data - special RPMB device type for these areas
153 * @dev: the device for the RPMB area
154 * @chrdev: character device for the RPMB area
155 * @id: unique device ID number
156 * @part_index: partition index (0 on first)
157 * @md: parent MMC block device
158 * @node: list item, so we can put this device on a list
160 struct mmc_rpmb_data {
164 unsigned int part_index;
165 struct mmc_blk_data *md;
166 struct list_head node;
169 static DEFINE_MUTEX(open_lock);
171 module_param(perdev_minors, int, 0444);
172 MODULE_PARM_DESC(perdev_minors, "Minors numbers to allocate per device");
174 static inline int mmc_blk_part_switch(struct mmc_card *card,
175 unsigned int part_type);
176 static void mmc_blk_rw_rq_prep(struct mmc_queue_req *mqrq,
177 struct mmc_card *card,
179 struct mmc_queue *mq);
180 static void mmc_blk_hsq_req_done(struct mmc_request *mrq);
181 static int mmc_spi_err_check(struct mmc_card *card);
183 static struct mmc_blk_data *mmc_blk_get(struct gendisk *disk)
185 struct mmc_blk_data *md;
187 mutex_lock(&open_lock);
188 md = disk->private_data;
189 if (md && !kref_get_unless_zero(&md->kref))
191 mutex_unlock(&open_lock);
196 static inline int mmc_get_devidx(struct gendisk *disk)
198 int devidx = disk->first_minor / perdev_minors;
202 static void mmc_blk_kref_release(struct kref *ref)
204 struct mmc_blk_data *md = container_of(ref, struct mmc_blk_data, kref);
207 devidx = mmc_get_devidx(md->disk);
208 ida_simple_remove(&mmc_blk_ida, devidx);
210 mutex_lock(&open_lock);
211 md->disk->private_data = NULL;
212 mutex_unlock(&open_lock);
218 static void mmc_blk_put(struct mmc_blk_data *md)
220 kref_put(&md->kref, mmc_blk_kref_release);
223 static ssize_t power_ro_lock_show(struct device *dev,
224 struct device_attribute *attr, char *buf)
227 struct mmc_blk_data *md = mmc_blk_get(dev_to_disk(dev));
228 struct mmc_card *card = md->queue.card;
231 if (card->ext_csd.boot_ro_lock & EXT_CSD_BOOT_WP_B_PERM_WP_EN)
233 else if (card->ext_csd.boot_ro_lock & EXT_CSD_BOOT_WP_B_PWR_WP_EN)
236 ret = snprintf(buf, PAGE_SIZE, "%d\n", locked);
243 static ssize_t power_ro_lock_store(struct device *dev,
244 struct device_attribute *attr, const char *buf, size_t count)
247 struct mmc_blk_data *md, *part_md;
248 struct mmc_queue *mq;
252 if (kstrtoul(buf, 0, &set))
258 md = mmc_blk_get(dev_to_disk(dev));
261 /* Dispatch locking to the block layer */
262 req = blk_mq_alloc_request(mq->queue, REQ_OP_DRV_OUT, 0);
264 count = PTR_ERR(req);
267 req_to_mmc_queue_req(req)->drv_op = MMC_DRV_OP_BOOT_WP;
268 req_to_mmc_queue_req(req)->drv_op_result = -EIO;
269 blk_execute_rq(req, false);
270 ret = req_to_mmc_queue_req(req)->drv_op_result;
271 blk_mq_free_request(req);
274 pr_info("%s: Locking boot partition ro until next power on\n",
275 md->disk->disk_name);
276 set_disk_ro(md->disk, 1);
278 list_for_each_entry(part_md, &md->part, part)
279 if (part_md->area_type == MMC_BLK_DATA_AREA_BOOT) {
280 pr_info("%s: Locking boot partition ro until next power on\n", part_md->disk->disk_name);
281 set_disk_ro(part_md->disk, 1);
289 static DEVICE_ATTR(ro_lock_until_next_power_on, 0,
290 power_ro_lock_show, power_ro_lock_store);
292 static ssize_t force_ro_show(struct device *dev, struct device_attribute *attr,
296 struct mmc_blk_data *md = mmc_blk_get(dev_to_disk(dev));
298 ret = snprintf(buf, PAGE_SIZE, "%d\n",
299 get_disk_ro(dev_to_disk(dev)) ^
305 static ssize_t force_ro_store(struct device *dev, struct device_attribute *attr,
306 const char *buf, size_t count)
310 struct mmc_blk_data *md = mmc_blk_get(dev_to_disk(dev));
311 unsigned long set = simple_strtoul(buf, &end, 0);
317 set_disk_ro(dev_to_disk(dev), set || md->read_only);
324 static DEVICE_ATTR(force_ro, 0644, force_ro_show, force_ro_store);
326 static struct attribute *mmc_disk_attrs[] = {
327 &dev_attr_force_ro.attr,
328 &dev_attr_ro_lock_until_next_power_on.attr,
332 static umode_t mmc_disk_attrs_is_visible(struct kobject *kobj,
333 struct attribute *a, int n)
335 struct device *dev = kobj_to_dev(kobj);
336 struct mmc_blk_data *md = mmc_blk_get(dev_to_disk(dev));
337 umode_t mode = a->mode;
339 if (a == &dev_attr_ro_lock_until_next_power_on.attr &&
340 (md->area_type & MMC_BLK_DATA_AREA_BOOT) &&
341 md->queue.card->ext_csd.boot_ro_lockable) {
343 if (!(md->queue.card->ext_csd.boot_ro_lock &
344 EXT_CSD_BOOT_WP_B_PWR_WP_DIS))
352 static const struct attribute_group mmc_disk_attr_group = {
353 .is_visible = mmc_disk_attrs_is_visible,
354 .attrs = mmc_disk_attrs,
357 static const struct attribute_group *mmc_disk_attr_groups[] = {
358 &mmc_disk_attr_group,
362 static int mmc_blk_open(struct gendisk *disk, blk_mode_t mode)
364 struct mmc_blk_data *md = mmc_blk_get(disk);
367 mutex_lock(&block_mutex);
370 if ((mode & BLK_OPEN_WRITE) && md->read_only) {
375 mutex_unlock(&block_mutex);
380 static void mmc_blk_release(struct gendisk *disk)
382 struct mmc_blk_data *md = disk->private_data;
384 mutex_lock(&block_mutex);
386 mutex_unlock(&block_mutex);
390 mmc_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
392 geo->cylinders = get_capacity(bdev->bd_disk) / (4 * 16);
398 struct mmc_blk_ioc_data {
399 struct mmc_ioc_cmd ic;
402 struct mmc_rpmb_data *rpmb;
405 static struct mmc_blk_ioc_data *mmc_blk_ioctl_copy_from_user(
406 struct mmc_ioc_cmd __user *user)
408 struct mmc_blk_ioc_data *idata;
411 idata = kmalloc(sizeof(*idata), GFP_KERNEL);
417 if (copy_from_user(&idata->ic, user, sizeof(idata->ic))) {
422 idata->buf_bytes = (u64) idata->ic.blksz * idata->ic.blocks;
423 if (idata->buf_bytes > MMC_IOC_MAX_BYTES) {
428 if (!idata->buf_bytes) {
433 idata->buf = memdup_user((void __user *)(unsigned long)
434 idata->ic.data_ptr, idata->buf_bytes);
435 if (IS_ERR(idata->buf)) {
436 err = PTR_ERR(idata->buf);
448 static int mmc_blk_ioctl_copy_to_user(struct mmc_ioc_cmd __user *ic_ptr,
449 struct mmc_blk_ioc_data *idata)
451 struct mmc_ioc_cmd *ic = &idata->ic;
453 if (copy_to_user(&(ic_ptr->response), ic->response,
454 sizeof(ic->response)))
457 if (!idata->ic.write_flag) {
458 if (copy_to_user((void __user *)(unsigned long)ic->data_ptr,
459 idata->buf, idata->buf_bytes))
466 static int __mmc_blk_ioctl_cmd(struct mmc_card *card, struct mmc_blk_data *md,
467 struct mmc_blk_ioc_data *idata)
469 struct mmc_command cmd = {}, sbc = {};
470 struct mmc_data data = {};
471 struct mmc_request mrq = {};
472 struct scatterlist sg;
473 bool r1b_resp, use_r1b_resp = false;
474 unsigned int busy_timeout_ms;
476 unsigned int target_part;
478 if (!card || !md || !idata)
482 * The RPMB accesses comes in from the character device, so we
483 * need to target these explicitly. Else we just target the
484 * partition type for the block device the ioctl() was issued
488 /* Support multiple RPMB partitions */
489 target_part = idata->rpmb->part_index;
490 target_part |= EXT_CSD_PART_CONFIG_ACC_RPMB;
492 target_part = md->part_type;
495 cmd.opcode = idata->ic.opcode;
496 cmd.arg = idata->ic.arg;
497 cmd.flags = idata->ic.flags;
499 if (idata->buf_bytes) {
502 data.blksz = idata->ic.blksz;
503 data.blocks = idata->ic.blocks;
505 sg_init_one(data.sg, idata->buf, idata->buf_bytes);
507 if (idata->ic.write_flag)
508 data.flags = MMC_DATA_WRITE;
510 data.flags = MMC_DATA_READ;
512 /* data.flags must already be set before doing this. */
513 mmc_set_data_timeout(&data, card);
515 /* Allow overriding the timeout_ns for empirical tuning. */
516 if (idata->ic.data_timeout_ns)
517 data.timeout_ns = idata->ic.data_timeout_ns;
524 err = mmc_blk_part_switch(card, target_part);
528 if (idata->ic.is_acmd) {
529 err = mmc_app_cmd(card->host, card);
535 sbc.opcode = MMC_SET_BLOCK_COUNT;
537 * We don't do any blockcount validation because the max size
538 * may be increased by a future standard. We just copy the
539 * 'Reliable Write' bit here.
541 sbc.arg = data.blocks | (idata->ic.write_flag & BIT(31));
542 sbc.flags = MMC_RSP_R1 | MMC_CMD_AC;
546 if ((MMC_EXTRACT_INDEX_FROM_ARG(cmd.arg) == EXT_CSD_SANITIZE_START) &&
547 (cmd.opcode == MMC_SWITCH))
548 return mmc_sanitize(card, idata->ic.cmd_timeout_ms);
550 /* If it's an R1B response we need some more preparations. */
551 busy_timeout_ms = idata->ic.cmd_timeout_ms ? : MMC_BLK_TIMEOUT_MS;
552 r1b_resp = (cmd.flags & MMC_RSP_R1B) == MMC_RSP_R1B;
554 use_r1b_resp = mmc_prepare_busy_cmd(card->host, &cmd,
557 mmc_wait_for_req(card->host, &mrq);
558 memcpy(&idata->ic.response, cmd.resp, sizeof(cmd.resp));
561 dev_err(mmc_dev(card->host), "%s: cmd error %d\n",
562 __func__, cmd.error);
566 dev_err(mmc_dev(card->host), "%s: data error %d\n",
567 __func__, data.error);
572 * Make sure the cache of the PARTITION_CONFIG register and
573 * PARTITION_ACCESS bits is updated in case the ioctl ext_csd write
574 * changed it successfully.
576 if ((MMC_EXTRACT_INDEX_FROM_ARG(cmd.arg) == EXT_CSD_PART_CONFIG) &&
577 (cmd.opcode == MMC_SWITCH)) {
578 struct mmc_blk_data *main_md = dev_get_drvdata(&card->dev);
579 u8 value = MMC_EXTRACT_VALUE_FROM_ARG(cmd.arg);
582 * Update cache so the next mmc_blk_part_switch call operates
583 * on up-to-date data.
585 card->ext_csd.part_config = value;
586 main_md->part_curr = value & EXT_CSD_PART_CONFIG_ACC_MASK;
590 * Make sure to update CACHE_CTRL in case it was changed. The cache
591 * will get turned back on if the card is re-initialized, e.g.
592 * suspend/resume or hw reset in recovery.
594 if ((MMC_EXTRACT_INDEX_FROM_ARG(cmd.arg) == EXT_CSD_CACHE_CTRL) &&
595 (cmd.opcode == MMC_SWITCH)) {
596 u8 value = MMC_EXTRACT_VALUE_FROM_ARG(cmd.arg) & 1;
598 card->ext_csd.cache_ctrl = value;
602 * According to the SD specs, some commands require a delay after
603 * issuing the command.
605 if (idata->ic.postsleep_min_us)
606 usleep_range(idata->ic.postsleep_min_us, idata->ic.postsleep_max_us);
608 /* No need to poll when using HW busy detection. */
609 if ((card->host->caps & MMC_CAP_WAIT_WHILE_BUSY) && use_r1b_resp)
612 if (mmc_host_is_spi(card->host)) {
613 if (idata->ic.write_flag || r1b_resp || cmd.flags & MMC_RSP_SPI_BUSY)
614 return mmc_spi_err_check(card);
617 /* Ensure RPMB/R1B command has completed by polling with CMD13. */
618 if (idata->rpmb || r1b_resp)
619 err = mmc_poll_for_busy(card, busy_timeout_ms, false,
625 static int mmc_blk_ioctl_cmd(struct mmc_blk_data *md,
626 struct mmc_ioc_cmd __user *ic_ptr,
627 struct mmc_rpmb_data *rpmb)
629 struct mmc_blk_ioc_data *idata;
630 struct mmc_blk_ioc_data *idatas[1];
631 struct mmc_queue *mq;
632 struct mmc_card *card;
633 int err = 0, ioc_err = 0;
636 idata = mmc_blk_ioctl_copy_from_user(ic_ptr);
638 return PTR_ERR(idata);
639 /* This will be NULL on non-RPMB ioctl():s */
642 card = md->queue.card;
649 * Dispatch the ioctl() into the block request queue.
652 req = blk_mq_alloc_request(mq->queue,
653 idata->ic.write_flag ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN, 0);
659 req_to_mmc_queue_req(req)->drv_op =
660 rpmb ? MMC_DRV_OP_IOCTL_RPMB : MMC_DRV_OP_IOCTL;
661 req_to_mmc_queue_req(req)->drv_op_result = -EIO;
662 req_to_mmc_queue_req(req)->drv_op_data = idatas;
663 req_to_mmc_queue_req(req)->ioc_count = 1;
664 blk_execute_rq(req, false);
665 ioc_err = req_to_mmc_queue_req(req)->drv_op_result;
666 err = mmc_blk_ioctl_copy_to_user(ic_ptr, idata);
667 blk_mq_free_request(req);
672 return ioc_err ? ioc_err : err;
675 static int mmc_blk_ioctl_multi_cmd(struct mmc_blk_data *md,
676 struct mmc_ioc_multi_cmd __user *user,
677 struct mmc_rpmb_data *rpmb)
679 struct mmc_blk_ioc_data **idata = NULL;
680 struct mmc_ioc_cmd __user *cmds = user->cmds;
681 struct mmc_card *card;
682 struct mmc_queue *mq;
683 int err = 0, ioc_err = 0;
688 if (copy_from_user(&num_of_cmds, &user->num_of_cmds,
689 sizeof(num_of_cmds)))
695 if (num_of_cmds > MMC_IOC_MAX_CMDS)
699 idata = kcalloc(n, sizeof(*idata), GFP_KERNEL);
703 for (i = 0; i < n; i++) {
704 idata[i] = mmc_blk_ioctl_copy_from_user(&cmds[i]);
705 if (IS_ERR(idata[i])) {
706 err = PTR_ERR(idata[i]);
710 /* This will be NULL on non-RPMB ioctl():s */
711 idata[i]->rpmb = rpmb;
714 card = md->queue.card;
722 * Dispatch the ioctl()s into the block request queue.
725 req = blk_mq_alloc_request(mq->queue,
726 idata[0]->ic.write_flag ? REQ_OP_DRV_OUT : REQ_OP_DRV_IN, 0);
731 req_to_mmc_queue_req(req)->drv_op =
732 rpmb ? MMC_DRV_OP_IOCTL_RPMB : MMC_DRV_OP_IOCTL;
733 req_to_mmc_queue_req(req)->drv_op_result = -EIO;
734 req_to_mmc_queue_req(req)->drv_op_data = idata;
735 req_to_mmc_queue_req(req)->ioc_count = n;
736 blk_execute_rq(req, false);
737 ioc_err = req_to_mmc_queue_req(req)->drv_op_result;
739 /* copy to user if data and response */
740 for (i = 0; i < n && !err; i++)
741 err = mmc_blk_ioctl_copy_to_user(&cmds[i], idata[i]);
743 blk_mq_free_request(req);
746 for (i = 0; i < n; i++) {
747 kfree(idata[i]->buf);
751 return ioc_err ? ioc_err : err;
754 static int mmc_blk_check_blkdev(struct block_device *bdev)
757 * The caller must have CAP_SYS_RAWIO, and must be calling this on the
758 * whole block device, not on a partition. This prevents overspray
759 * between sibling partitions.
761 if (!capable(CAP_SYS_RAWIO) || bdev_is_partition(bdev))
766 static int mmc_blk_ioctl(struct block_device *bdev, blk_mode_t mode,
767 unsigned int cmd, unsigned long arg)
769 struct mmc_blk_data *md;
774 ret = mmc_blk_check_blkdev(bdev);
777 md = mmc_blk_get(bdev->bd_disk);
780 ret = mmc_blk_ioctl_cmd(md,
781 (struct mmc_ioc_cmd __user *)arg,
785 case MMC_IOC_MULTI_CMD:
786 ret = mmc_blk_check_blkdev(bdev);
789 md = mmc_blk_get(bdev->bd_disk);
792 ret = mmc_blk_ioctl_multi_cmd(md,
793 (struct mmc_ioc_multi_cmd __user *)arg,
803 static int mmc_blk_compat_ioctl(struct block_device *bdev, blk_mode_t mode,
804 unsigned int cmd, unsigned long arg)
806 return mmc_blk_ioctl(bdev, mode, cmd, (unsigned long) compat_ptr(arg));
810 static int mmc_blk_alternative_gpt_sector(struct gendisk *disk,
813 struct mmc_blk_data *md;
816 md = mmc_blk_get(disk);
821 ret = mmc_card_alternative_gpt_sector(md->queue.card, sector);
830 static const struct block_device_operations mmc_bdops = {
831 .open = mmc_blk_open,
832 .release = mmc_blk_release,
833 .getgeo = mmc_blk_getgeo,
834 .owner = THIS_MODULE,
835 .ioctl = mmc_blk_ioctl,
837 .compat_ioctl = mmc_blk_compat_ioctl,
839 .alternative_gpt_sector = mmc_blk_alternative_gpt_sector,
842 static int mmc_blk_part_switch_pre(struct mmc_card *card,
843 unsigned int part_type)
847 if (part_type == EXT_CSD_PART_CONFIG_ACC_RPMB) {
848 if (card->ext_csd.cmdq_en) {
849 ret = mmc_cmdq_disable(card);
853 mmc_retune_pause(card->host);
859 static int mmc_blk_part_switch_post(struct mmc_card *card,
860 unsigned int part_type)
864 if (part_type == EXT_CSD_PART_CONFIG_ACC_RPMB) {
865 mmc_retune_unpause(card->host);
866 if (card->reenable_cmdq && !card->ext_csd.cmdq_en)
867 ret = mmc_cmdq_enable(card);
873 static inline int mmc_blk_part_switch(struct mmc_card *card,
874 unsigned int part_type)
877 struct mmc_blk_data *main_md = dev_get_drvdata(&card->dev);
879 if (main_md->part_curr == part_type)
882 if (mmc_card_mmc(card)) {
883 u8 part_config = card->ext_csd.part_config;
885 ret = mmc_blk_part_switch_pre(card, part_type);
889 part_config &= ~EXT_CSD_PART_CONFIG_ACC_MASK;
890 part_config |= part_type;
892 ret = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
893 EXT_CSD_PART_CONFIG, part_config,
894 card->ext_csd.part_time);
896 mmc_blk_part_switch_post(card, part_type);
900 card->ext_csd.part_config = part_config;
902 ret = mmc_blk_part_switch_post(card, main_md->part_curr);
905 main_md->part_curr = part_type;
909 static int mmc_sd_num_wr_blocks(struct mmc_card *card, u32 *written_blocks)
915 struct mmc_request mrq = {};
916 struct mmc_command cmd = {};
917 struct mmc_data data = {};
919 struct scatterlist sg;
921 cmd.opcode = MMC_APP_CMD;
922 cmd.arg = card->rca << 16;
923 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
925 err = mmc_wait_for_cmd(card->host, &cmd, 0);
928 if (!mmc_host_is_spi(card->host) && !(cmd.resp[0] & R1_APP_CMD))
931 memset(&cmd, 0, sizeof(struct mmc_command));
933 cmd.opcode = SD_APP_SEND_NUM_WR_BLKS;
935 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
939 data.flags = MMC_DATA_READ;
942 mmc_set_data_timeout(&data, card);
947 blocks = kmalloc(4, GFP_KERNEL);
951 sg_init_one(&sg, blocks, 4);
953 mmc_wait_for_req(card->host, &mrq);
955 result = ntohl(*blocks);
958 if (cmd.error || data.error)
961 *written_blocks = result;
966 static unsigned int mmc_blk_clock_khz(struct mmc_host *host)
968 if (host->actual_clock)
969 return host->actual_clock / 1000;
971 /* Clock may be subject to a divisor, fudge it by a factor of 2. */
973 return host->ios.clock / 2000;
975 /* How can there be no clock */
977 return 100; /* 100 kHz is minimum possible value */
980 static unsigned int mmc_blk_data_timeout_ms(struct mmc_host *host,
981 struct mmc_data *data)
983 unsigned int ms = DIV_ROUND_UP(data->timeout_ns, 1000000);
986 if (data->timeout_clks) {
987 khz = mmc_blk_clock_khz(host);
988 ms += DIV_ROUND_UP(data->timeout_clks, khz);
995 * Attempts to reset the card and get back to the requested partition.
996 * Therefore any error here must result in cancelling the block layer
997 * request, it must not be reattempted without going through the mmc_blk
998 * partition sanity checks.
1000 static int mmc_blk_reset(struct mmc_blk_data *md, struct mmc_host *host,
1004 struct mmc_blk_data *main_md = dev_get_drvdata(&host->card->dev);
1006 if (md->reset_done & type)
1009 md->reset_done |= type;
1010 err = mmc_hw_reset(host->card);
1012 * A successful reset will leave the card in the main partition, but
1013 * upon failure it might not be, so set it to MMC_BLK_PART_INVALID
1016 main_md->part_curr = err ? MMC_BLK_PART_INVALID : main_md->part_type;
1019 /* Ensure we switch back to the correct partition */
1020 if (mmc_blk_part_switch(host->card, md->part_type))
1022 * We have failed to get back into the correct
1023 * partition, so we need to abort the whole request.
1029 static inline void mmc_blk_reset_success(struct mmc_blk_data *md, int type)
1031 md->reset_done &= ~type;
1035 * The non-block commands come back from the block layer after it queued it and
1036 * processed it with all other requests and then they get issued in this
1039 static void mmc_blk_issue_drv_op(struct mmc_queue *mq, struct request *req)
1041 struct mmc_queue_req *mq_rq;
1042 struct mmc_card *card = mq->card;
1043 struct mmc_blk_data *md = mq->blkdata;
1044 struct mmc_blk_ioc_data **idata;
1051 mq_rq = req_to_mmc_queue_req(req);
1052 rpmb_ioctl = (mq_rq->drv_op == MMC_DRV_OP_IOCTL_RPMB);
1054 switch (mq_rq->drv_op) {
1055 case MMC_DRV_OP_IOCTL:
1056 if (card->ext_csd.cmdq_en) {
1057 ret = mmc_cmdq_disable(card);
1062 case MMC_DRV_OP_IOCTL_RPMB:
1063 idata = mq_rq->drv_op_data;
1064 for (i = 0, ret = 0; i < mq_rq->ioc_count; i++) {
1065 ret = __mmc_blk_ioctl_cmd(card, md, idata[i]);
1069 /* Always switch back to main area after RPMB access */
1071 mmc_blk_part_switch(card, 0);
1072 else if (card->reenable_cmdq && !card->ext_csd.cmdq_en)
1073 mmc_cmdq_enable(card);
1075 case MMC_DRV_OP_BOOT_WP:
1076 ret = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL, EXT_CSD_BOOT_WP,
1077 card->ext_csd.boot_ro_lock |
1078 EXT_CSD_BOOT_WP_B_PWR_WP_EN,
1079 card->ext_csd.part_time);
1081 pr_err("%s: Locking boot partition ro until next power on failed: %d\n",
1082 md->disk->disk_name, ret);
1084 card->ext_csd.boot_ro_lock |=
1085 EXT_CSD_BOOT_WP_B_PWR_WP_EN;
1087 case MMC_DRV_OP_GET_CARD_STATUS:
1088 ret = mmc_send_status(card, &status);
1092 case MMC_DRV_OP_GET_EXT_CSD:
1093 ext_csd = mq_rq->drv_op_data;
1094 ret = mmc_get_ext_csd(card, ext_csd);
1097 pr_err("%s: unknown driver specific operation\n",
1098 md->disk->disk_name);
1102 mq_rq->drv_op_result = ret;
1103 blk_mq_end_request(req, ret ? BLK_STS_IOERR : BLK_STS_OK);
1106 static void mmc_blk_issue_erase_rq(struct mmc_queue *mq, struct request *req,
1107 int type, unsigned int erase_arg)
1109 struct mmc_blk_data *md = mq->blkdata;
1110 struct mmc_card *card = md->queue.card;
1111 unsigned int from, nr;
1113 blk_status_t status = BLK_STS_OK;
1115 if (!mmc_can_erase(card)) {
1116 status = BLK_STS_NOTSUPP;
1120 from = blk_rq_pos(req);
1121 nr = blk_rq_sectors(req);
1125 if (card->quirks & MMC_QUIRK_INAND_CMD38) {
1126 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
1127 INAND_CMD38_ARG_EXT_CSD,
1128 erase_arg == MMC_TRIM_ARG ?
1129 INAND_CMD38_ARG_TRIM :
1130 INAND_CMD38_ARG_ERASE,
1131 card->ext_csd.generic_cmd6_time);
1134 err = mmc_erase(card, from, nr, erase_arg);
1135 } while (err == -EIO && !mmc_blk_reset(md, card->host, type));
1137 status = BLK_STS_IOERR;
1139 mmc_blk_reset_success(md, type);
1141 blk_mq_end_request(req, status);
1144 static void mmc_blk_issue_trim_rq(struct mmc_queue *mq, struct request *req)
1146 mmc_blk_issue_erase_rq(mq, req, MMC_BLK_TRIM, MMC_TRIM_ARG);
1149 static void mmc_blk_issue_discard_rq(struct mmc_queue *mq, struct request *req)
1151 struct mmc_blk_data *md = mq->blkdata;
1152 struct mmc_card *card = md->queue.card;
1153 unsigned int arg = card->erase_arg;
1155 if (mmc_card_broken_sd_discard(card))
1158 mmc_blk_issue_erase_rq(mq, req, MMC_BLK_DISCARD, arg);
1161 static void mmc_blk_issue_secdiscard_rq(struct mmc_queue *mq,
1162 struct request *req)
1164 struct mmc_blk_data *md = mq->blkdata;
1165 struct mmc_card *card = md->queue.card;
1166 unsigned int from, nr, arg;
1167 int err = 0, type = MMC_BLK_SECDISCARD;
1168 blk_status_t status = BLK_STS_OK;
1170 if (!(mmc_can_secure_erase_trim(card))) {
1171 status = BLK_STS_NOTSUPP;
1175 from = blk_rq_pos(req);
1176 nr = blk_rq_sectors(req);
1178 if (mmc_can_trim(card) && !mmc_erase_group_aligned(card, from, nr))
1179 arg = MMC_SECURE_TRIM1_ARG;
1181 arg = MMC_SECURE_ERASE_ARG;
1184 if (card->quirks & MMC_QUIRK_INAND_CMD38) {
1185 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
1186 INAND_CMD38_ARG_EXT_CSD,
1187 arg == MMC_SECURE_TRIM1_ARG ?
1188 INAND_CMD38_ARG_SECTRIM1 :
1189 INAND_CMD38_ARG_SECERASE,
1190 card->ext_csd.generic_cmd6_time);
1195 err = mmc_erase(card, from, nr, arg);
1199 status = BLK_STS_IOERR;
1203 if (arg == MMC_SECURE_TRIM1_ARG) {
1204 if (card->quirks & MMC_QUIRK_INAND_CMD38) {
1205 err = mmc_switch(card, EXT_CSD_CMD_SET_NORMAL,
1206 INAND_CMD38_ARG_EXT_CSD,
1207 INAND_CMD38_ARG_SECTRIM2,
1208 card->ext_csd.generic_cmd6_time);
1213 err = mmc_erase(card, from, nr, MMC_SECURE_TRIM2_ARG);
1217 status = BLK_STS_IOERR;
1223 if (err && !mmc_blk_reset(md, card->host, type))
1226 mmc_blk_reset_success(md, type);
1228 blk_mq_end_request(req, status);
1231 static void mmc_blk_issue_flush(struct mmc_queue *mq, struct request *req)
1233 struct mmc_blk_data *md = mq->blkdata;
1234 struct mmc_card *card = md->queue.card;
1237 ret = mmc_flush_cache(card->host);
1238 blk_mq_end_request(req, ret ? BLK_STS_IOERR : BLK_STS_OK);
1242 * Reformat current write as a reliable write, supporting
1243 * both legacy and the enhanced reliable write MMC cards.
1244 * In each transfer we'll handle only as much as a single
1245 * reliable write can handle, thus finish the request in
1246 * partial completions.
1248 static inline void mmc_apply_rel_rw(struct mmc_blk_request *brq,
1249 struct mmc_card *card,
1250 struct request *req)
1252 if (!(card->ext_csd.rel_param & EXT_CSD_WR_REL_PARAM_EN)) {
1253 /* Legacy mode imposes restrictions on transfers. */
1254 if (!IS_ALIGNED(blk_rq_pos(req), card->ext_csd.rel_sectors))
1255 brq->data.blocks = 1;
1257 if (brq->data.blocks > card->ext_csd.rel_sectors)
1258 brq->data.blocks = card->ext_csd.rel_sectors;
1259 else if (brq->data.blocks < card->ext_csd.rel_sectors)
1260 brq->data.blocks = 1;
1264 #define CMD_ERRORS_EXCL_OOR \
1265 (R1_ADDRESS_ERROR | /* Misaligned address */ \
1266 R1_BLOCK_LEN_ERROR | /* Transferred block length incorrect */\
1267 R1_WP_VIOLATION | /* Tried to write to protected block */ \
1268 R1_CARD_ECC_FAILED | /* Card ECC failed */ \
1269 R1_CC_ERROR | /* Card controller error */ \
1270 R1_ERROR) /* General/unknown error */
1272 #define CMD_ERRORS \
1273 (CMD_ERRORS_EXCL_OOR | \
1274 R1_OUT_OF_RANGE) /* Command argument out of range */ \
1276 static void mmc_blk_eval_resp_error(struct mmc_blk_request *brq)
1281 * Per the SD specification(physical layer version 4.10)[1],
1282 * section 4.3.3, it explicitly states that "When the last
1283 * block of user area is read using CMD18, the host should
1284 * ignore OUT_OF_RANGE error that may occur even the sequence
1285 * is correct". And JESD84-B51 for eMMC also has a similar
1286 * statement on section 6.8.3.
1288 * Multiple block read/write could be done by either predefined
1289 * method, namely CMD23, or open-ending mode. For open-ending mode,
1290 * we should ignore the OUT_OF_RANGE error as it's normal behaviour.
1292 * However the spec[1] doesn't tell us whether we should also
1293 * ignore that for predefined method. But per the spec[1], section
1294 * 4.15 Set Block Count Command, it says"If illegal block count
1295 * is set, out of range error will be indicated during read/write
1296 * operation (For example, data transfer is stopped at user area
1297 * boundary)." In another word, we could expect a out of range error
1298 * in the response for the following CMD18/25. And if argument of
1299 * CMD23 + the argument of CMD18/25 exceed the max number of blocks,
1300 * we could also expect to get a -ETIMEDOUT or any error number from
1301 * the host drivers due to missing data response(for write)/data(for
1302 * read), as the cards will stop the data transfer by itself per the
1303 * spec. So we only need to check R1_OUT_OF_RANGE for open-ending mode.
1306 if (!brq->stop.error) {
1307 bool oor_with_open_end;
1308 /* If there is no error yet, check R1 response */
1310 val = brq->stop.resp[0] & CMD_ERRORS;
1311 oor_with_open_end = val & R1_OUT_OF_RANGE && !brq->mrq.sbc;
1313 if (val && !oor_with_open_end)
1314 brq->stop.error = -EIO;
1318 static void mmc_blk_data_prep(struct mmc_queue *mq, struct mmc_queue_req *mqrq,
1319 int recovery_mode, bool *do_rel_wr_p,
1320 bool *do_data_tag_p)
1322 struct mmc_blk_data *md = mq->blkdata;
1323 struct mmc_card *card = md->queue.card;
1324 struct mmc_blk_request *brq = &mqrq->brq;
1325 struct request *req = mmc_queue_req_to_req(mqrq);
1326 bool do_rel_wr, do_data_tag;
1329 * Reliable writes are used to implement Forced Unit Access and
1330 * are supported only on MMCs.
1332 do_rel_wr = (req->cmd_flags & REQ_FUA) &&
1333 rq_data_dir(req) == WRITE &&
1334 (md->flags & MMC_BLK_REL_WR);
1336 memset(brq, 0, sizeof(struct mmc_blk_request));
1338 mmc_crypto_prepare_req(mqrq);
1340 brq->mrq.data = &brq->data;
1341 brq->mrq.tag = req->tag;
1343 brq->stop.opcode = MMC_STOP_TRANSMISSION;
1346 if (rq_data_dir(req) == READ) {
1347 brq->data.flags = MMC_DATA_READ;
1348 brq->stop.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
1350 brq->data.flags = MMC_DATA_WRITE;
1351 brq->stop.flags = MMC_RSP_SPI_R1B | MMC_RSP_R1B | MMC_CMD_AC;
1354 brq->data.blksz = 512;
1355 brq->data.blocks = blk_rq_sectors(req);
1356 brq->data.blk_addr = blk_rq_pos(req);
1359 * The command queue supports 2 priorities: "high" (1) and "simple" (0).
1360 * The eMMC will give "high" priority tasks priority over "simple"
1361 * priority tasks. Here we always set "simple" priority by not setting
1366 * The block layer doesn't support all sector count
1367 * restrictions, so we need to be prepared for too big
1370 if (brq->data.blocks > card->host->max_blk_count)
1371 brq->data.blocks = card->host->max_blk_count;
1373 if (brq->data.blocks > 1) {
1375 * Some SD cards in SPI mode return a CRC error or even lock up
1376 * completely when trying to read the last block using a
1377 * multiblock read command.
1379 if (mmc_host_is_spi(card->host) && (rq_data_dir(req) == READ) &&
1380 (blk_rq_pos(req) + blk_rq_sectors(req) ==
1381 get_capacity(md->disk)))
1385 * After a read error, we redo the request one (native) sector
1386 * at a time in order to accurately determine which
1387 * sectors can be read successfully.
1390 brq->data.blocks = queue_physical_block_size(mq->queue) >> 9;
1393 * Some controllers have HW issues while operating
1394 * in multiple I/O mode
1396 if (card->host->ops->multi_io_quirk)
1397 brq->data.blocks = card->host->ops->multi_io_quirk(card,
1398 (rq_data_dir(req) == READ) ?
1399 MMC_DATA_READ : MMC_DATA_WRITE,
1404 mmc_apply_rel_rw(brq, card, req);
1405 brq->data.flags |= MMC_DATA_REL_WR;
1409 * Data tag is used only during writing meta data to speed
1410 * up write and any subsequent read of this meta data
1412 do_data_tag = card->ext_csd.data_tag_unit_size &&
1413 (req->cmd_flags & REQ_META) &&
1414 (rq_data_dir(req) == WRITE) &&
1415 ((brq->data.blocks * brq->data.blksz) >=
1416 card->ext_csd.data_tag_unit_size);
1419 brq->data.flags |= MMC_DATA_DAT_TAG;
1421 mmc_set_data_timeout(&brq->data, card);
1423 brq->data.sg = mqrq->sg;
1424 brq->data.sg_len = mmc_queue_map_sg(mq, mqrq);
1427 * Adjust the sg list so it is the same size as the
1430 if (brq->data.blocks != blk_rq_sectors(req)) {
1431 int i, data_size = brq->data.blocks << 9;
1432 struct scatterlist *sg;
1434 for_each_sg(brq->data.sg, sg, brq->data.sg_len, i) {
1435 data_size -= sg->length;
1436 if (data_size <= 0) {
1437 sg->length += data_size;
1442 brq->data.sg_len = i;
1446 *do_rel_wr_p = do_rel_wr;
1449 *do_data_tag_p = do_data_tag;
1452 #define MMC_CQE_RETRIES 2
1454 static void mmc_blk_cqe_complete_rq(struct mmc_queue *mq, struct request *req)
1456 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
1457 struct mmc_request *mrq = &mqrq->brq.mrq;
1458 struct request_queue *q = req->q;
1459 struct mmc_host *host = mq->card->host;
1460 enum mmc_issue_type issue_type = mmc_issue_type(mq, req);
1461 unsigned long flags;
1465 mmc_cqe_post_req(host, mrq);
1467 if (mrq->cmd && mrq->cmd->error)
1468 err = mrq->cmd->error;
1469 else if (mrq->data && mrq->data->error)
1470 err = mrq->data->error;
1475 if (mqrq->retries++ < MMC_CQE_RETRIES)
1476 blk_mq_requeue_request(req, true);
1478 blk_mq_end_request(req, BLK_STS_IOERR);
1479 } else if (mrq->data) {
1480 if (blk_update_request(req, BLK_STS_OK, mrq->data->bytes_xfered))
1481 blk_mq_requeue_request(req, true);
1483 __blk_mq_end_request(req, BLK_STS_OK);
1485 blk_mq_end_request(req, BLK_STS_OK);
1488 spin_lock_irqsave(&mq->lock, flags);
1490 mq->in_flight[issue_type] -= 1;
1492 put_card = (mmc_tot_in_flight(mq) == 0);
1494 mmc_cqe_check_busy(mq);
1496 spin_unlock_irqrestore(&mq->lock, flags);
1499 blk_mq_run_hw_queues(q, true);
1502 mmc_put_card(mq->card, &mq->ctx);
1505 void mmc_blk_cqe_recovery(struct mmc_queue *mq)
1507 struct mmc_card *card = mq->card;
1508 struct mmc_host *host = card->host;
1511 pr_debug("%s: CQE recovery start\n", mmc_hostname(host));
1513 err = mmc_cqe_recovery(host);
1515 mmc_blk_reset(mq->blkdata, host, MMC_BLK_CQE_RECOVERY);
1516 mmc_blk_reset_success(mq->blkdata, MMC_BLK_CQE_RECOVERY);
1518 pr_debug("%s: CQE recovery done\n", mmc_hostname(host));
1521 static void mmc_blk_cqe_req_done(struct mmc_request *mrq)
1523 struct mmc_queue_req *mqrq = container_of(mrq, struct mmc_queue_req,
1525 struct request *req = mmc_queue_req_to_req(mqrq);
1526 struct request_queue *q = req->q;
1527 struct mmc_queue *mq = q->queuedata;
1530 * Block layer timeouts race with completions which means the normal
1531 * completion path cannot be used during recovery.
1533 if (mq->in_recovery)
1534 mmc_blk_cqe_complete_rq(mq, req);
1535 else if (likely(!blk_should_fake_timeout(req->q)))
1536 blk_mq_complete_request(req);
1539 static int mmc_blk_cqe_start_req(struct mmc_host *host, struct mmc_request *mrq)
1541 mrq->done = mmc_blk_cqe_req_done;
1542 mrq->recovery_notifier = mmc_cqe_recovery_notifier;
1544 return mmc_cqe_start_req(host, mrq);
1547 static struct mmc_request *mmc_blk_cqe_prep_dcmd(struct mmc_queue_req *mqrq,
1548 struct request *req)
1550 struct mmc_blk_request *brq = &mqrq->brq;
1552 memset(brq, 0, sizeof(*brq));
1554 brq->mrq.cmd = &brq->cmd;
1555 brq->mrq.tag = req->tag;
1560 static int mmc_blk_cqe_issue_flush(struct mmc_queue *mq, struct request *req)
1562 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
1563 struct mmc_request *mrq = mmc_blk_cqe_prep_dcmd(mqrq, req);
1565 mrq->cmd->opcode = MMC_SWITCH;
1566 mrq->cmd->arg = (MMC_SWITCH_MODE_WRITE_BYTE << 24) |
1567 (EXT_CSD_FLUSH_CACHE << 16) |
1569 EXT_CSD_CMD_SET_NORMAL;
1570 mrq->cmd->flags = MMC_CMD_AC | MMC_RSP_R1B;
1572 return mmc_blk_cqe_start_req(mq->card->host, mrq);
1575 static int mmc_blk_hsq_issue_rw_rq(struct mmc_queue *mq, struct request *req)
1577 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
1578 struct mmc_host *host = mq->card->host;
1581 mmc_blk_rw_rq_prep(mqrq, mq->card, 0, mq);
1582 mqrq->brq.mrq.done = mmc_blk_hsq_req_done;
1583 mmc_pre_req(host, &mqrq->brq.mrq);
1585 err = mmc_cqe_start_req(host, &mqrq->brq.mrq);
1587 mmc_post_req(host, &mqrq->brq.mrq, err);
1592 static int mmc_blk_cqe_issue_rw_rq(struct mmc_queue *mq, struct request *req)
1594 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
1595 struct mmc_host *host = mq->card->host;
1597 if (host->hsq_enabled)
1598 return mmc_blk_hsq_issue_rw_rq(mq, req);
1600 mmc_blk_data_prep(mq, mqrq, 0, NULL, NULL);
1602 return mmc_blk_cqe_start_req(mq->card->host, &mqrq->brq.mrq);
1605 static void mmc_blk_rw_rq_prep(struct mmc_queue_req *mqrq,
1606 struct mmc_card *card,
1608 struct mmc_queue *mq)
1610 u32 readcmd, writecmd;
1611 struct mmc_blk_request *brq = &mqrq->brq;
1612 struct request *req = mmc_queue_req_to_req(mqrq);
1613 struct mmc_blk_data *md = mq->blkdata;
1614 bool do_rel_wr, do_data_tag;
1616 mmc_blk_data_prep(mq, mqrq, recovery_mode, &do_rel_wr, &do_data_tag);
1618 brq->mrq.cmd = &brq->cmd;
1620 brq->cmd.arg = blk_rq_pos(req);
1621 if (!mmc_card_blockaddr(card))
1623 brq->cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
1625 if (brq->data.blocks > 1 || do_rel_wr) {
1626 /* SPI multiblock writes terminate using a special
1627 * token, not a STOP_TRANSMISSION request.
1629 if (!mmc_host_is_spi(card->host) ||
1630 rq_data_dir(req) == READ)
1631 brq->mrq.stop = &brq->stop;
1632 readcmd = MMC_READ_MULTIPLE_BLOCK;
1633 writecmd = MMC_WRITE_MULTIPLE_BLOCK;
1635 brq->mrq.stop = NULL;
1636 readcmd = MMC_READ_SINGLE_BLOCK;
1637 writecmd = MMC_WRITE_BLOCK;
1639 brq->cmd.opcode = rq_data_dir(req) == READ ? readcmd : writecmd;
1642 * Pre-defined multi-block transfers are preferable to
1643 * open ended-ones (and necessary for reliable writes).
1644 * However, it is not sufficient to just send CMD23,
1645 * and avoid the final CMD12, as on an error condition
1646 * CMD12 (stop) needs to be sent anyway. This, coupled
1647 * with Auto-CMD23 enhancements provided by some
1648 * hosts, means that the complexity of dealing
1649 * with this is best left to the host. If CMD23 is
1650 * supported by card and host, we'll fill sbc in and let
1651 * the host deal with handling it correctly. This means
1652 * that for hosts that don't expose MMC_CAP_CMD23, no
1653 * change of behavior will be observed.
1655 * N.B: Some MMC cards experience perf degradation.
1656 * We'll avoid using CMD23-bounded multiblock writes for
1657 * these, while retaining features like reliable writes.
1659 if ((md->flags & MMC_BLK_CMD23) && mmc_op_multi(brq->cmd.opcode) &&
1660 (do_rel_wr || !(card->quirks & MMC_QUIRK_BLK_NO_CMD23) ||
1662 brq->sbc.opcode = MMC_SET_BLOCK_COUNT;
1663 brq->sbc.arg = brq->data.blocks |
1664 (do_rel_wr ? (1 << 31) : 0) |
1665 (do_data_tag ? (1 << 29) : 0);
1666 brq->sbc.flags = MMC_RSP_R1 | MMC_CMD_AC;
1667 brq->mrq.sbc = &brq->sbc;
1671 #define MMC_MAX_RETRIES 5
1672 #define MMC_DATA_RETRIES 2
1673 #define MMC_NO_RETRIES (MMC_MAX_RETRIES + 1)
1675 static int mmc_blk_send_stop(struct mmc_card *card, unsigned int timeout)
1677 struct mmc_command cmd = {
1678 .opcode = MMC_STOP_TRANSMISSION,
1679 .flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC,
1680 /* Some hosts wait for busy anyway, so provide a busy timeout */
1681 .busy_timeout = timeout,
1684 return mmc_wait_for_cmd(card->host, &cmd, 5);
1687 static int mmc_blk_fix_state(struct mmc_card *card, struct request *req)
1689 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
1690 struct mmc_blk_request *brq = &mqrq->brq;
1691 unsigned int timeout = mmc_blk_data_timeout_ms(card->host, &brq->data);
1694 mmc_retune_hold_now(card->host);
1696 mmc_blk_send_stop(card, timeout);
1698 err = mmc_poll_for_busy(card, timeout, false, MMC_BUSY_IO);
1700 mmc_retune_release(card->host);
1705 #define MMC_READ_SINGLE_RETRIES 2
1707 /* Single (native) sector read during recovery */
1708 static void mmc_blk_read_single(struct mmc_queue *mq, struct request *req)
1710 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
1711 struct mmc_request *mrq = &mqrq->brq.mrq;
1712 struct mmc_card *card = mq->card;
1713 struct mmc_host *host = card->host;
1714 blk_status_t error = BLK_STS_OK;
1715 size_t bytes_per_read = queue_physical_block_size(mq->queue);
1722 while (retries++ <= MMC_READ_SINGLE_RETRIES) {
1723 mmc_blk_rw_rq_prep(mqrq, card, 1, mq);
1725 mmc_wait_for_req(host, mrq);
1727 err = mmc_send_status(card, &status);
1731 if (!mmc_host_is_spi(host) &&
1732 !mmc_ready_for_data(status)) {
1733 err = mmc_blk_fix_state(card, req);
1738 if (!mrq->cmd->error)
1742 if (mrq->cmd->error ||
1744 (!mmc_host_is_spi(host) &&
1745 (mrq->cmd->resp[0] & CMD_ERRORS || status & CMD_ERRORS)))
1746 error = BLK_STS_IOERR;
1750 } while (blk_update_request(req, error, bytes_per_read));
1755 mrq->data->bytes_xfered = 0;
1756 blk_update_request(req, BLK_STS_IOERR, bytes_per_read);
1757 /* Let it try the remaining request again */
1758 if (mqrq->retries > MMC_MAX_RETRIES - 1)
1759 mqrq->retries = MMC_MAX_RETRIES - 1;
1762 static inline bool mmc_blk_oor_valid(struct mmc_blk_request *brq)
1764 return !!brq->mrq.sbc;
1767 static inline u32 mmc_blk_stop_err_bits(struct mmc_blk_request *brq)
1769 return mmc_blk_oor_valid(brq) ? CMD_ERRORS : CMD_ERRORS_EXCL_OOR;
1773 * Check for errors the host controller driver might not have seen such as
1774 * response mode errors or invalid card state.
1776 static bool mmc_blk_status_error(struct request *req, u32 status)
1778 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
1779 struct mmc_blk_request *brq = &mqrq->brq;
1780 struct mmc_queue *mq = req->q->queuedata;
1783 if (mmc_host_is_spi(mq->card->host))
1786 stop_err_bits = mmc_blk_stop_err_bits(brq);
1788 return brq->cmd.resp[0] & CMD_ERRORS ||
1789 brq->stop.resp[0] & stop_err_bits ||
1790 status & stop_err_bits ||
1791 (rq_data_dir(req) == WRITE && !mmc_ready_for_data(status));
1794 static inline bool mmc_blk_cmd_started(struct mmc_blk_request *brq)
1796 return !brq->sbc.error && !brq->cmd.error &&
1797 !(brq->cmd.resp[0] & CMD_ERRORS);
1801 * Requests are completed by mmc_blk_mq_complete_rq() which sets simple
1803 * 1. A request that has transferred at least some data is considered
1804 * successful and will be requeued if there is remaining data to
1806 * 2. Otherwise the number of retries is incremented and the request
1807 * will be requeued if there are remaining retries.
1808 * 3. Otherwise the request will be errored out.
1809 * That means mmc_blk_mq_complete_rq() is controlled by bytes_xfered and
1810 * mqrq->retries. So there are only 4 possible actions here:
1811 * 1. do not accept the bytes_xfered value i.e. set it to zero
1812 * 2. change mqrq->retries to determine the number of retries
1813 * 3. try to reset the card
1814 * 4. read one sector at a time
1816 static void mmc_blk_mq_rw_recovery(struct mmc_queue *mq, struct request *req)
1818 int type = rq_data_dir(req) == READ ? MMC_BLK_READ : MMC_BLK_WRITE;
1819 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
1820 struct mmc_blk_request *brq = &mqrq->brq;
1821 struct mmc_blk_data *md = mq->blkdata;
1822 struct mmc_card *card = mq->card;
1828 * Some errors the host driver might not have seen. Set the number of
1829 * bytes transferred to zero in that case.
1831 err = __mmc_send_status(card, &status, 0);
1832 if (err || mmc_blk_status_error(req, status))
1833 brq->data.bytes_xfered = 0;
1835 mmc_retune_release(card->host);
1838 * Try again to get the status. This also provides an opportunity for
1842 err = __mmc_send_status(card, &status, 0);
1845 * Nothing more to do after the number of bytes transferred has been
1846 * updated and there is no card.
1848 if (err && mmc_detect_card_removed(card->host))
1851 /* Try to get back to "tran" state */
1852 if (!mmc_host_is_spi(mq->card->host) &&
1853 (err || !mmc_ready_for_data(status)))
1854 err = mmc_blk_fix_state(mq->card, req);
1857 * Special case for SD cards where the card might record the number of
1860 if (!err && mmc_blk_cmd_started(brq) && mmc_card_sd(card) &&
1861 rq_data_dir(req) == WRITE) {
1862 if (mmc_sd_num_wr_blocks(card, &blocks))
1863 brq->data.bytes_xfered = 0;
1865 brq->data.bytes_xfered = blocks << 9;
1868 /* Reset if the card is in a bad state */
1869 if (!mmc_host_is_spi(mq->card->host) &&
1870 err && mmc_blk_reset(md, card->host, type)) {
1871 pr_err("%s: recovery failed!\n", req->q->disk->disk_name);
1872 mqrq->retries = MMC_NO_RETRIES;
1877 * If anything was done, just return and if there is anything remaining
1878 * on the request it will get requeued.
1880 if (brq->data.bytes_xfered)
1883 /* Reset before last retry */
1884 if (mqrq->retries + 1 == MMC_MAX_RETRIES &&
1885 mmc_blk_reset(md, card->host, type))
1888 /* Command errors fail fast, so use all MMC_MAX_RETRIES */
1889 if (brq->sbc.error || brq->cmd.error)
1892 /* Reduce the remaining retries for data errors */
1893 if (mqrq->retries < MMC_MAX_RETRIES - MMC_DATA_RETRIES) {
1894 mqrq->retries = MMC_MAX_RETRIES - MMC_DATA_RETRIES;
1898 if (rq_data_dir(req) == READ && brq->data.blocks >
1899 queue_physical_block_size(mq->queue) >> 9) {
1900 /* Read one (native) sector at a time */
1901 mmc_blk_read_single(mq, req);
1906 static inline bool mmc_blk_rq_error(struct mmc_blk_request *brq)
1908 mmc_blk_eval_resp_error(brq);
1910 return brq->sbc.error || brq->cmd.error || brq->stop.error ||
1911 brq->data.error || brq->cmd.resp[0] & CMD_ERRORS;
1914 static int mmc_spi_err_check(struct mmc_card *card)
1920 * SPI does not have a TRAN state we have to wait on, instead the
1921 * card is ready again when it no longer holds the line LOW.
1922 * We still have to ensure two things here before we know the write
1924 * 1. The card has not disconnected during busy and we actually read our
1925 * own pull-up, thinking it was still connected, so ensure it
1927 * 2. Check for any error bits, in particular R1_SPI_IDLE to catch a
1928 * just reconnected card after being disconnected during busy.
1930 err = __mmc_send_status(card, &status, 0);
1933 /* All R1 and R2 bits of SPI are errors in our case */
1939 static int mmc_blk_busy_cb(void *cb_data, bool *busy)
1941 struct mmc_blk_busy_data *data = cb_data;
1945 err = mmc_send_status(data->card, &status);
1949 /* Accumulate response error bits. */
1950 data->status |= status;
1952 *busy = !mmc_ready_for_data(status);
1956 static int mmc_blk_card_busy(struct mmc_card *card, struct request *req)
1958 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
1959 struct mmc_blk_busy_data cb_data;
1962 if (rq_data_dir(req) == READ)
1965 if (mmc_host_is_spi(card->host)) {
1966 err = mmc_spi_err_check(card);
1968 mqrq->brq.data.bytes_xfered = 0;
1972 cb_data.card = card;
1974 err = __mmc_poll_for_busy(card->host, 0, MMC_BLK_TIMEOUT_MS,
1975 &mmc_blk_busy_cb, &cb_data);
1978 * Do not assume data transferred correctly if there are any error bits
1981 if (cb_data.status & mmc_blk_stop_err_bits(&mqrq->brq)) {
1982 mqrq->brq.data.bytes_xfered = 0;
1983 err = err ? err : -EIO;
1986 /* Copy the exception bit so it will be seen later on */
1987 if (mmc_card_mmc(card) && cb_data.status & R1_EXCEPTION_EVENT)
1988 mqrq->brq.cmd.resp[0] |= R1_EXCEPTION_EVENT;
1993 static inline void mmc_blk_rw_reset_success(struct mmc_queue *mq,
1994 struct request *req)
1996 int type = rq_data_dir(req) == READ ? MMC_BLK_READ : MMC_BLK_WRITE;
1998 mmc_blk_reset_success(mq->blkdata, type);
2001 static void mmc_blk_mq_complete_rq(struct mmc_queue *mq, struct request *req)
2003 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
2004 unsigned int nr_bytes = mqrq->brq.data.bytes_xfered;
2007 if (blk_update_request(req, BLK_STS_OK, nr_bytes))
2008 blk_mq_requeue_request(req, true);
2010 __blk_mq_end_request(req, BLK_STS_OK);
2011 } else if (!blk_rq_bytes(req)) {
2012 __blk_mq_end_request(req, BLK_STS_IOERR);
2013 } else if (mqrq->retries++ < MMC_MAX_RETRIES) {
2014 blk_mq_requeue_request(req, true);
2016 if (mmc_card_removed(mq->card))
2017 req->rq_flags |= RQF_QUIET;
2018 blk_mq_end_request(req, BLK_STS_IOERR);
2022 static bool mmc_blk_urgent_bkops_needed(struct mmc_queue *mq,
2023 struct mmc_queue_req *mqrq)
2025 return mmc_card_mmc(mq->card) && !mmc_host_is_spi(mq->card->host) &&
2026 (mqrq->brq.cmd.resp[0] & R1_EXCEPTION_EVENT ||
2027 mqrq->brq.stop.resp[0] & R1_EXCEPTION_EVENT);
2030 static void mmc_blk_urgent_bkops(struct mmc_queue *mq,
2031 struct mmc_queue_req *mqrq)
2033 if (mmc_blk_urgent_bkops_needed(mq, mqrq))
2034 mmc_run_bkops(mq->card);
2037 static void mmc_blk_hsq_req_done(struct mmc_request *mrq)
2039 struct mmc_queue_req *mqrq =
2040 container_of(mrq, struct mmc_queue_req, brq.mrq);
2041 struct request *req = mmc_queue_req_to_req(mqrq);
2042 struct request_queue *q = req->q;
2043 struct mmc_queue *mq = q->queuedata;
2044 struct mmc_host *host = mq->card->host;
2045 unsigned long flags;
2047 if (mmc_blk_rq_error(&mqrq->brq) ||
2048 mmc_blk_urgent_bkops_needed(mq, mqrq)) {
2049 spin_lock_irqsave(&mq->lock, flags);
2050 mq->recovery_needed = true;
2051 mq->recovery_req = req;
2052 spin_unlock_irqrestore(&mq->lock, flags);
2054 host->cqe_ops->cqe_recovery_start(host);
2056 schedule_work(&mq->recovery_work);
2060 mmc_blk_rw_reset_success(mq, req);
2063 * Block layer timeouts race with completions which means the normal
2064 * completion path cannot be used during recovery.
2066 if (mq->in_recovery)
2067 mmc_blk_cqe_complete_rq(mq, req);
2068 else if (likely(!blk_should_fake_timeout(req->q)))
2069 blk_mq_complete_request(req);
2072 void mmc_blk_mq_complete(struct request *req)
2074 struct mmc_queue *mq = req->q->queuedata;
2075 struct mmc_host *host = mq->card->host;
2077 if (host->cqe_enabled)
2078 mmc_blk_cqe_complete_rq(mq, req);
2079 else if (likely(!blk_should_fake_timeout(req->q)))
2080 mmc_blk_mq_complete_rq(mq, req);
2083 static void mmc_blk_mq_poll_completion(struct mmc_queue *mq,
2084 struct request *req)
2086 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
2087 struct mmc_host *host = mq->card->host;
2089 if (mmc_blk_rq_error(&mqrq->brq) ||
2090 mmc_blk_card_busy(mq->card, req)) {
2091 mmc_blk_mq_rw_recovery(mq, req);
2093 mmc_blk_rw_reset_success(mq, req);
2094 mmc_retune_release(host);
2097 mmc_blk_urgent_bkops(mq, mqrq);
2100 static void mmc_blk_mq_dec_in_flight(struct mmc_queue *mq, struct request *req)
2102 unsigned long flags;
2105 spin_lock_irqsave(&mq->lock, flags);
2107 mq->in_flight[mmc_issue_type(mq, req)] -= 1;
2109 put_card = (mmc_tot_in_flight(mq) == 0);
2111 spin_unlock_irqrestore(&mq->lock, flags);
2114 mmc_put_card(mq->card, &mq->ctx);
2117 static void mmc_blk_mq_post_req(struct mmc_queue *mq, struct request *req,
2120 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
2121 struct mmc_request *mrq = &mqrq->brq.mrq;
2122 struct mmc_host *host = mq->card->host;
2124 mmc_post_req(host, mrq, 0);
2127 * Block layer timeouts race with completions which means the normal
2128 * completion path cannot be used during recovery.
2130 if (mq->in_recovery) {
2131 mmc_blk_mq_complete_rq(mq, req);
2132 } else if (likely(!blk_should_fake_timeout(req->q))) {
2134 blk_mq_complete_request_direct(req, mmc_blk_mq_complete);
2136 blk_mq_complete_request(req);
2139 mmc_blk_mq_dec_in_flight(mq, req);
2142 void mmc_blk_mq_recovery(struct mmc_queue *mq)
2144 struct request *req = mq->recovery_req;
2145 struct mmc_host *host = mq->card->host;
2146 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
2148 mq->recovery_req = NULL;
2149 mq->rw_wait = false;
2151 if (mmc_blk_rq_error(&mqrq->brq)) {
2152 mmc_retune_hold_now(host);
2153 mmc_blk_mq_rw_recovery(mq, req);
2156 mmc_blk_urgent_bkops(mq, mqrq);
2158 mmc_blk_mq_post_req(mq, req, true);
2161 static void mmc_blk_mq_complete_prev_req(struct mmc_queue *mq,
2162 struct request **prev_req)
2164 if (mmc_host_done_complete(mq->card->host))
2167 mutex_lock(&mq->complete_lock);
2169 if (!mq->complete_req)
2172 mmc_blk_mq_poll_completion(mq, mq->complete_req);
2175 *prev_req = mq->complete_req;
2177 mmc_blk_mq_post_req(mq, mq->complete_req, true);
2179 mq->complete_req = NULL;
2182 mutex_unlock(&mq->complete_lock);
2185 void mmc_blk_mq_complete_work(struct work_struct *work)
2187 struct mmc_queue *mq = container_of(work, struct mmc_queue,
2190 mmc_blk_mq_complete_prev_req(mq, NULL);
2193 static void mmc_blk_mq_req_done(struct mmc_request *mrq)
2195 struct mmc_queue_req *mqrq = container_of(mrq, struct mmc_queue_req,
2197 struct request *req = mmc_queue_req_to_req(mqrq);
2198 struct request_queue *q = req->q;
2199 struct mmc_queue *mq = q->queuedata;
2200 struct mmc_host *host = mq->card->host;
2201 unsigned long flags;
2203 if (!mmc_host_done_complete(host)) {
2207 * We cannot complete the request in this context, so record
2208 * that there is a request to complete, and that a following
2209 * request does not need to wait (although it does need to
2210 * complete complete_req first).
2212 spin_lock_irqsave(&mq->lock, flags);
2213 mq->complete_req = req;
2214 mq->rw_wait = false;
2215 waiting = mq->waiting;
2216 spin_unlock_irqrestore(&mq->lock, flags);
2219 * If 'waiting' then the waiting task will complete this
2220 * request, otherwise queue a work to do it. Note that
2221 * complete_work may still race with the dispatch of a following
2227 queue_work(mq->card->complete_wq, &mq->complete_work);
2232 /* Take the recovery path for errors or urgent background operations */
2233 if (mmc_blk_rq_error(&mqrq->brq) ||
2234 mmc_blk_urgent_bkops_needed(mq, mqrq)) {
2235 spin_lock_irqsave(&mq->lock, flags);
2236 mq->recovery_needed = true;
2237 mq->recovery_req = req;
2238 spin_unlock_irqrestore(&mq->lock, flags);
2240 schedule_work(&mq->recovery_work);
2244 mmc_blk_rw_reset_success(mq, req);
2246 mq->rw_wait = false;
2249 /* context unknown */
2250 mmc_blk_mq_post_req(mq, req, false);
2253 static bool mmc_blk_rw_wait_cond(struct mmc_queue *mq, int *err)
2255 unsigned long flags;
2259 * Wait while there is another request in progress, but not if recovery
2260 * is needed. Also indicate whether there is a request waiting to start.
2262 spin_lock_irqsave(&mq->lock, flags);
2263 if (mq->recovery_needed) {
2267 done = !mq->rw_wait;
2269 mq->waiting = !done;
2270 spin_unlock_irqrestore(&mq->lock, flags);
2275 static int mmc_blk_rw_wait(struct mmc_queue *mq, struct request **prev_req)
2279 wait_event(mq->wait, mmc_blk_rw_wait_cond(mq, &err));
2281 /* Always complete the previous request if there is one */
2282 mmc_blk_mq_complete_prev_req(mq, prev_req);
2287 static int mmc_blk_mq_issue_rw_rq(struct mmc_queue *mq,
2288 struct request *req)
2290 struct mmc_queue_req *mqrq = req_to_mmc_queue_req(req);
2291 struct mmc_host *host = mq->card->host;
2292 struct request *prev_req = NULL;
2295 mmc_blk_rw_rq_prep(mqrq, mq->card, 0, mq);
2297 mqrq->brq.mrq.done = mmc_blk_mq_req_done;
2299 mmc_pre_req(host, &mqrq->brq.mrq);
2301 err = mmc_blk_rw_wait(mq, &prev_req);
2307 err = mmc_start_request(host, &mqrq->brq.mrq);
2310 mmc_blk_mq_post_req(mq, prev_req, true);
2313 mq->rw_wait = false;
2315 /* Release re-tuning here where there is no synchronization required */
2316 if (err || mmc_host_done_complete(host))
2317 mmc_retune_release(host);
2321 mmc_post_req(host, &mqrq->brq.mrq, err);
2326 static int mmc_blk_wait_for_idle(struct mmc_queue *mq, struct mmc_host *host)
2328 if (host->cqe_enabled)
2329 return host->cqe_ops->cqe_wait_for_idle(host);
2331 return mmc_blk_rw_wait(mq, NULL);
2334 enum mmc_issued mmc_blk_mq_issue_rq(struct mmc_queue *mq, struct request *req)
2336 struct mmc_blk_data *md = mq->blkdata;
2337 struct mmc_card *card = md->queue.card;
2338 struct mmc_host *host = card->host;
2341 ret = mmc_blk_part_switch(card, md->part_type);
2343 return MMC_REQ_FAILED_TO_START;
2345 switch (mmc_issue_type(mq, req)) {
2346 case MMC_ISSUE_SYNC:
2347 ret = mmc_blk_wait_for_idle(mq, host);
2349 return MMC_REQ_BUSY;
2350 switch (req_op(req)) {
2352 case REQ_OP_DRV_OUT:
2353 mmc_blk_issue_drv_op(mq, req);
2355 case REQ_OP_DISCARD:
2356 mmc_blk_issue_discard_rq(mq, req);
2358 case REQ_OP_SECURE_ERASE:
2359 mmc_blk_issue_secdiscard_rq(mq, req);
2361 case REQ_OP_WRITE_ZEROES:
2362 mmc_blk_issue_trim_rq(mq, req);
2365 mmc_blk_issue_flush(mq, req);
2369 return MMC_REQ_FAILED_TO_START;
2371 return MMC_REQ_FINISHED;
2372 case MMC_ISSUE_DCMD:
2373 case MMC_ISSUE_ASYNC:
2374 switch (req_op(req)) {
2376 if (!mmc_cache_enabled(host)) {
2377 blk_mq_end_request(req, BLK_STS_OK);
2378 return MMC_REQ_FINISHED;
2380 ret = mmc_blk_cqe_issue_flush(mq, req);
2384 if (host->cqe_enabled)
2385 ret = mmc_blk_cqe_issue_rw_rq(mq, req);
2387 ret = mmc_blk_mq_issue_rw_rq(mq, req);
2394 return MMC_REQ_STARTED;
2395 return ret == -EBUSY ? MMC_REQ_BUSY : MMC_REQ_FAILED_TO_START;
2398 return MMC_REQ_FAILED_TO_START;
2402 static inline int mmc_blk_readonly(struct mmc_card *card)
2404 return mmc_card_readonly(card) ||
2405 !(card->csd.cmdclass & CCC_BLOCK_WRITE);
2408 static struct mmc_blk_data *mmc_blk_alloc_req(struct mmc_card *card,
2409 struct device *parent,
2412 const char *subname,
2414 unsigned int part_type)
2416 struct mmc_blk_data *md;
2419 bool cache_enabled = false;
2420 bool fua_enabled = false;
2422 devidx = ida_simple_get(&mmc_blk_ida, 0, max_devices, GFP_KERNEL);
2425 * We get -ENOSPC because there are no more any available
2426 * devidx. The reason may be that, either userspace haven't yet
2427 * unmounted the partitions, which postpones mmc_blk_release()
2428 * from being called, or the device has more partitions than
2431 if (devidx == -ENOSPC)
2432 dev_err(mmc_dev(card->host),
2433 "no more device IDs available\n");
2435 return ERR_PTR(devidx);
2438 md = kzalloc(sizeof(struct mmc_blk_data), GFP_KERNEL);
2444 md->area_type = area_type;
2447 * Set the read-only status based on the supported commands
2448 * and the write protect switch.
2450 md->read_only = mmc_blk_readonly(card);
2452 md->disk = mmc_init_queue(&md->queue, card);
2453 if (IS_ERR(md->disk)) {
2454 ret = PTR_ERR(md->disk);
2458 INIT_LIST_HEAD(&md->part);
2459 INIT_LIST_HEAD(&md->rpmbs);
2460 kref_init(&md->kref);
2462 md->queue.blkdata = md;
2463 md->part_type = part_type;
2465 md->disk->major = MMC_BLOCK_MAJOR;
2466 md->disk->minors = perdev_minors;
2467 md->disk->first_minor = devidx * perdev_minors;
2468 md->disk->fops = &mmc_bdops;
2469 md->disk->private_data = md;
2470 md->parent = parent;
2471 set_disk_ro(md->disk, md->read_only || default_ro);
2472 if (area_type & (MMC_BLK_DATA_AREA_RPMB | MMC_BLK_DATA_AREA_BOOT))
2473 md->disk->flags |= GENHD_FL_NO_PART;
2476 * As discussed on lkml, GENHD_FL_REMOVABLE should:
2478 * - be set for removable media with permanent block devices
2479 * - be unset for removable block devices with permanent media
2481 * Since MMC block devices clearly fall under the second
2482 * case, we do not set GENHD_FL_REMOVABLE. Userspace
2483 * should use the block device creation/destruction hotplug
2484 * messages to tell when the card is present.
2487 snprintf(md->disk->disk_name, sizeof(md->disk->disk_name),
2488 "mmcblk%u%s", card->host->index, subname ? subname : "");
2490 set_capacity(md->disk, size);
2492 if (mmc_host_cmd23(card->host)) {
2493 if ((mmc_card_mmc(card) &&
2494 card->csd.mmca_vsn >= CSD_SPEC_VER_3) ||
2495 (mmc_card_sd(card) &&
2496 card->scr.cmds & SD_SCR_CMD23_SUPPORT))
2497 md->flags |= MMC_BLK_CMD23;
2500 if (md->flags & MMC_BLK_CMD23 &&
2501 ((card->ext_csd.rel_param & EXT_CSD_WR_REL_PARAM_EN) ||
2502 card->ext_csd.rel_sectors)) {
2503 md->flags |= MMC_BLK_REL_WR;
2505 cache_enabled = true;
2507 if (mmc_cache_enabled(card->host))
2508 cache_enabled = true;
2510 blk_queue_write_cache(md->queue.queue, cache_enabled, fua_enabled);
2512 string_get_size((u64)size, 512, STRING_UNITS_2,
2513 cap_str, sizeof(cap_str));
2514 pr_info("%s: %s %s %s%s\n",
2515 md->disk->disk_name, mmc_card_id(card), mmc_card_name(card),
2516 cap_str, md->read_only ? " (ro)" : "");
2518 /* used in ->open, must be set before add_disk: */
2519 if (area_type == MMC_BLK_DATA_AREA_MAIN)
2520 dev_set_drvdata(&card->dev, md);
2521 ret = device_add_disk(md->parent, md->disk, mmc_disk_attr_groups);
2528 blk_mq_free_tag_set(&md->queue.tag_set);
2532 ida_simple_remove(&mmc_blk_ida, devidx);
2533 return ERR_PTR(ret);
2536 static struct mmc_blk_data *mmc_blk_alloc(struct mmc_card *card)
2540 if (!mmc_card_sd(card) && mmc_card_blockaddr(card)) {
2542 * The EXT_CSD sector count is in number or 512 byte
2545 size = card->ext_csd.sectors;
2548 * The CSD capacity field is in units of read_blkbits.
2549 * set_capacity takes units of 512 bytes.
2551 size = (typeof(sector_t))card->csd.capacity
2552 << (card->csd.read_blkbits - 9);
2555 return mmc_blk_alloc_req(card, &card->dev, size, false, NULL,
2556 MMC_BLK_DATA_AREA_MAIN, 0);
2559 static int mmc_blk_alloc_part(struct mmc_card *card,
2560 struct mmc_blk_data *md,
2561 unsigned int part_type,
2564 const char *subname,
2567 struct mmc_blk_data *part_md;
2569 part_md = mmc_blk_alloc_req(card, disk_to_dev(md->disk), size, default_ro,
2570 subname, area_type, part_type);
2571 if (IS_ERR(part_md))
2572 return PTR_ERR(part_md);
2573 list_add(&part_md->part, &md->part);
2579 * mmc_rpmb_ioctl() - ioctl handler for the RPMB chardev
2580 * @filp: the character device file
2581 * @cmd: the ioctl() command
2582 * @arg: the argument from userspace
2584 * This will essentially just redirect the ioctl()s coming in over to
2585 * the main block device spawning the RPMB character device.
2587 static long mmc_rpmb_ioctl(struct file *filp, unsigned int cmd,
2590 struct mmc_rpmb_data *rpmb = filp->private_data;
2595 ret = mmc_blk_ioctl_cmd(rpmb->md,
2596 (struct mmc_ioc_cmd __user *)arg,
2599 case MMC_IOC_MULTI_CMD:
2600 ret = mmc_blk_ioctl_multi_cmd(rpmb->md,
2601 (struct mmc_ioc_multi_cmd __user *)arg,
2612 #ifdef CONFIG_COMPAT
2613 static long mmc_rpmb_ioctl_compat(struct file *filp, unsigned int cmd,
2616 return mmc_rpmb_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));
2620 static int mmc_rpmb_chrdev_open(struct inode *inode, struct file *filp)
2622 struct mmc_rpmb_data *rpmb = container_of(inode->i_cdev,
2623 struct mmc_rpmb_data, chrdev);
2625 get_device(&rpmb->dev);
2626 filp->private_data = rpmb;
2627 mmc_blk_get(rpmb->md->disk);
2629 return nonseekable_open(inode, filp);
2632 static int mmc_rpmb_chrdev_release(struct inode *inode, struct file *filp)
2634 struct mmc_rpmb_data *rpmb = container_of(inode->i_cdev,
2635 struct mmc_rpmb_data, chrdev);
2637 mmc_blk_put(rpmb->md);
2638 put_device(&rpmb->dev);
2643 static const struct file_operations mmc_rpmb_fileops = {
2644 .release = mmc_rpmb_chrdev_release,
2645 .open = mmc_rpmb_chrdev_open,
2646 .owner = THIS_MODULE,
2647 .llseek = no_llseek,
2648 .unlocked_ioctl = mmc_rpmb_ioctl,
2649 #ifdef CONFIG_COMPAT
2650 .compat_ioctl = mmc_rpmb_ioctl_compat,
2654 static void mmc_blk_rpmb_device_release(struct device *dev)
2656 struct mmc_rpmb_data *rpmb = dev_get_drvdata(dev);
2658 ida_simple_remove(&mmc_rpmb_ida, rpmb->id);
2662 static int mmc_blk_alloc_rpmb_part(struct mmc_card *card,
2663 struct mmc_blk_data *md,
2664 unsigned int part_index,
2666 const char *subname)
2669 char rpmb_name[DISK_NAME_LEN];
2671 struct mmc_rpmb_data *rpmb;
2673 /* This creates the minor number for the RPMB char device */
2674 devidx = ida_simple_get(&mmc_rpmb_ida, 0, max_devices, GFP_KERNEL);
2678 rpmb = kzalloc(sizeof(*rpmb), GFP_KERNEL);
2680 ida_simple_remove(&mmc_rpmb_ida, devidx);
2684 snprintf(rpmb_name, sizeof(rpmb_name),
2685 "mmcblk%u%s", card->host->index, subname ? subname : "");
2688 rpmb->part_index = part_index;
2689 rpmb->dev.init_name = rpmb_name;
2690 rpmb->dev.bus = &mmc_rpmb_bus_type;
2691 rpmb->dev.devt = MKDEV(MAJOR(mmc_rpmb_devt), rpmb->id);
2692 rpmb->dev.parent = &card->dev;
2693 rpmb->dev.release = mmc_blk_rpmb_device_release;
2694 device_initialize(&rpmb->dev);
2695 dev_set_drvdata(&rpmb->dev, rpmb);
2698 cdev_init(&rpmb->chrdev, &mmc_rpmb_fileops);
2699 rpmb->chrdev.owner = THIS_MODULE;
2700 ret = cdev_device_add(&rpmb->chrdev, &rpmb->dev);
2702 pr_err("%s: could not add character device\n", rpmb_name);
2703 goto out_put_device;
2706 list_add(&rpmb->node, &md->rpmbs);
2708 string_get_size((u64)size, 512, STRING_UNITS_2,
2709 cap_str, sizeof(cap_str));
2711 pr_info("%s: %s %s %s, chardev (%d:%d)\n",
2712 rpmb_name, mmc_card_id(card), mmc_card_name(card), cap_str,
2713 MAJOR(mmc_rpmb_devt), rpmb->id);
2718 put_device(&rpmb->dev);
2722 static void mmc_blk_remove_rpmb_part(struct mmc_rpmb_data *rpmb)
2725 cdev_device_del(&rpmb->chrdev, &rpmb->dev);
2726 put_device(&rpmb->dev);
2729 /* MMC Physical partitions consist of two boot partitions and
2730 * up to four general purpose partitions.
2731 * For each partition enabled in EXT_CSD a block device will be allocatedi
2732 * to provide access to the partition.
2735 static int mmc_blk_alloc_parts(struct mmc_card *card, struct mmc_blk_data *md)
2739 if (!mmc_card_mmc(card))
2742 for (idx = 0; idx < card->nr_parts; idx++) {
2743 if (card->part[idx].area_type & MMC_BLK_DATA_AREA_RPMB) {
2745 * RPMB partitions does not provide block access, they
2746 * are only accessed using ioctl():s. Thus create
2747 * special RPMB block devices that do not have a
2748 * backing block queue for these.
2750 ret = mmc_blk_alloc_rpmb_part(card, md,
2751 card->part[idx].part_cfg,
2752 card->part[idx].size >> 9,
2753 card->part[idx].name);
2756 } else if (card->part[idx].size) {
2757 ret = mmc_blk_alloc_part(card, md,
2758 card->part[idx].part_cfg,
2759 card->part[idx].size >> 9,
2760 card->part[idx].force_ro,
2761 card->part[idx].name,
2762 card->part[idx].area_type);
2771 static void mmc_blk_remove_req(struct mmc_blk_data *md)
2774 * Flush remaining requests and free queues. It is freeing the queue
2775 * that stops new requests from being accepted.
2777 del_gendisk(md->disk);
2778 mmc_cleanup_queue(&md->queue);
2782 static void mmc_blk_remove_parts(struct mmc_card *card,
2783 struct mmc_blk_data *md)
2785 struct list_head *pos, *q;
2786 struct mmc_blk_data *part_md;
2787 struct mmc_rpmb_data *rpmb;
2789 /* Remove RPMB partitions */
2790 list_for_each_safe(pos, q, &md->rpmbs) {
2791 rpmb = list_entry(pos, struct mmc_rpmb_data, node);
2793 mmc_blk_remove_rpmb_part(rpmb);
2795 /* Remove block partitions */
2796 list_for_each_safe(pos, q, &md->part) {
2797 part_md = list_entry(pos, struct mmc_blk_data, part);
2799 mmc_blk_remove_req(part_md);
2803 #ifdef CONFIG_DEBUG_FS
2805 static int mmc_dbg_card_status_get(void *data, u64 *val)
2807 struct mmc_card *card = data;
2808 struct mmc_blk_data *md = dev_get_drvdata(&card->dev);
2809 struct mmc_queue *mq = &md->queue;
2810 struct request *req;
2813 /* Ask the block layer about the card status */
2814 req = blk_mq_alloc_request(mq->queue, REQ_OP_DRV_IN, 0);
2816 return PTR_ERR(req);
2817 req_to_mmc_queue_req(req)->drv_op = MMC_DRV_OP_GET_CARD_STATUS;
2818 req_to_mmc_queue_req(req)->drv_op_result = -EIO;
2819 blk_execute_rq(req, false);
2820 ret = req_to_mmc_queue_req(req)->drv_op_result;
2825 blk_mq_free_request(req);
2829 DEFINE_DEBUGFS_ATTRIBUTE(mmc_dbg_card_status_fops, mmc_dbg_card_status_get,
2832 /* That is two digits * 512 + 1 for newline */
2833 #define EXT_CSD_STR_LEN 1025
2835 static int mmc_ext_csd_open(struct inode *inode, struct file *filp)
2837 struct mmc_card *card = inode->i_private;
2838 struct mmc_blk_data *md = dev_get_drvdata(&card->dev);
2839 struct mmc_queue *mq = &md->queue;
2840 struct request *req;
2846 buf = kmalloc(EXT_CSD_STR_LEN + 1, GFP_KERNEL);
2850 /* Ask the block layer for the EXT CSD */
2851 req = blk_mq_alloc_request(mq->queue, REQ_OP_DRV_IN, 0);
2856 req_to_mmc_queue_req(req)->drv_op = MMC_DRV_OP_GET_EXT_CSD;
2857 req_to_mmc_queue_req(req)->drv_op_result = -EIO;
2858 req_to_mmc_queue_req(req)->drv_op_data = &ext_csd;
2859 blk_execute_rq(req, false);
2860 err = req_to_mmc_queue_req(req)->drv_op_result;
2861 blk_mq_free_request(req);
2863 pr_err("FAILED %d\n", err);
2867 for (i = 0; i < 512; i++)
2868 n += sprintf(buf + n, "%02x", ext_csd[i]);
2869 n += sprintf(buf + n, "\n");
2871 if (n != EXT_CSD_STR_LEN) {
2877 filp->private_data = buf;
2886 static ssize_t mmc_ext_csd_read(struct file *filp, char __user *ubuf,
2887 size_t cnt, loff_t *ppos)
2889 char *buf = filp->private_data;
2891 return simple_read_from_buffer(ubuf, cnt, ppos,
2892 buf, EXT_CSD_STR_LEN);
2895 static int mmc_ext_csd_release(struct inode *inode, struct file *file)
2897 kfree(file->private_data);
2901 static const struct file_operations mmc_dbg_ext_csd_fops = {
2902 .open = mmc_ext_csd_open,
2903 .read = mmc_ext_csd_read,
2904 .release = mmc_ext_csd_release,
2905 .llseek = default_llseek,
2908 static void mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
2910 struct dentry *root;
2912 if (!card->debugfs_root)
2915 root = card->debugfs_root;
2917 if (mmc_card_mmc(card) || mmc_card_sd(card)) {
2919 debugfs_create_file_unsafe("status", 0400, root,
2921 &mmc_dbg_card_status_fops);
2924 if (mmc_card_mmc(card)) {
2925 md->ext_csd_dentry =
2926 debugfs_create_file("ext_csd", S_IRUSR, root, card,
2927 &mmc_dbg_ext_csd_fops);
2931 static void mmc_blk_remove_debugfs(struct mmc_card *card,
2932 struct mmc_blk_data *md)
2934 if (!card->debugfs_root)
2937 debugfs_remove(md->status_dentry);
2938 md->status_dentry = NULL;
2940 debugfs_remove(md->ext_csd_dentry);
2941 md->ext_csd_dentry = NULL;
2946 static void mmc_blk_add_debugfs(struct mmc_card *card, struct mmc_blk_data *md)
2950 static void mmc_blk_remove_debugfs(struct mmc_card *card,
2951 struct mmc_blk_data *md)
2955 #endif /* CONFIG_DEBUG_FS */
2957 static int mmc_blk_probe(struct mmc_card *card)
2959 struct mmc_blk_data *md;
2963 * Check that the card supports the command class(es) we need.
2965 if (!(card->csd.cmdclass & CCC_BLOCK_READ))
2968 mmc_fixup_device(card, mmc_blk_fixups);
2970 card->complete_wq = alloc_workqueue("mmc_complete",
2971 WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
2972 if (!card->complete_wq) {
2973 pr_err("Failed to create mmc completion workqueue");
2977 md = mmc_blk_alloc(card);
2983 ret = mmc_blk_alloc_parts(card, md);
2987 /* Add two debugfs entries */
2988 mmc_blk_add_debugfs(card, md);
2990 pm_runtime_set_autosuspend_delay(&card->dev, 3000);
2991 pm_runtime_use_autosuspend(&card->dev);
2994 * Don't enable runtime PM for SD-combo cards here. Leave that
2995 * decision to be taken during the SDIO init sequence instead.
2997 if (!mmc_card_sd_combo(card)) {
2998 pm_runtime_set_active(&card->dev);
2999 pm_runtime_enable(&card->dev);
3005 mmc_blk_remove_parts(card, md);
3006 mmc_blk_remove_req(md);
3008 destroy_workqueue(card->complete_wq);
3012 static void mmc_blk_remove(struct mmc_card *card)
3014 struct mmc_blk_data *md = dev_get_drvdata(&card->dev);
3016 mmc_blk_remove_debugfs(card, md);
3017 mmc_blk_remove_parts(card, md);
3018 pm_runtime_get_sync(&card->dev);
3019 if (md->part_curr != md->part_type) {
3020 mmc_claim_host(card->host);
3021 mmc_blk_part_switch(card, md->part_type);
3022 mmc_release_host(card->host);
3024 if (!mmc_card_sd_combo(card))
3025 pm_runtime_disable(&card->dev);
3026 pm_runtime_put_noidle(&card->dev);
3027 mmc_blk_remove_req(md);
3028 dev_set_drvdata(&card->dev, NULL);
3029 destroy_workqueue(card->complete_wq);
3032 static int _mmc_blk_suspend(struct mmc_card *card)
3034 struct mmc_blk_data *part_md;
3035 struct mmc_blk_data *md = dev_get_drvdata(&card->dev);
3038 mmc_queue_suspend(&md->queue);
3039 list_for_each_entry(part_md, &md->part, part) {
3040 mmc_queue_suspend(&part_md->queue);
3046 static void mmc_blk_shutdown(struct mmc_card *card)
3048 _mmc_blk_suspend(card);
3051 #ifdef CONFIG_PM_SLEEP
3052 static int mmc_blk_suspend(struct device *dev)
3054 struct mmc_card *card = mmc_dev_to_card(dev);
3056 return _mmc_blk_suspend(card);
3059 static int mmc_blk_resume(struct device *dev)
3061 struct mmc_blk_data *part_md;
3062 struct mmc_blk_data *md = dev_get_drvdata(dev);
3066 * Resume involves the card going into idle state,
3067 * so current partition is always the main one.
3069 md->part_curr = md->part_type;
3070 mmc_queue_resume(&md->queue);
3071 list_for_each_entry(part_md, &md->part, part) {
3072 mmc_queue_resume(&part_md->queue);
3079 static SIMPLE_DEV_PM_OPS(mmc_blk_pm_ops, mmc_blk_suspend, mmc_blk_resume);
3081 static struct mmc_driver mmc_driver = {
3084 .pm = &mmc_blk_pm_ops,
3086 .probe = mmc_blk_probe,
3087 .remove = mmc_blk_remove,
3088 .shutdown = mmc_blk_shutdown,
3091 static int __init mmc_blk_init(void)
3095 res = bus_register(&mmc_rpmb_bus_type);
3097 pr_err("mmcblk: could not register RPMB bus type\n");
3100 res = alloc_chrdev_region(&mmc_rpmb_devt, 0, MAX_DEVICES, "rpmb");
3102 pr_err("mmcblk: failed to allocate rpmb chrdev region\n");
3106 if (perdev_minors != CONFIG_MMC_BLOCK_MINORS)
3107 pr_info("mmcblk: using %d minors per device\n", perdev_minors);
3109 max_devices = min(MAX_DEVICES, (1 << MINORBITS) / perdev_minors);
3111 res = register_blkdev(MMC_BLOCK_MAJOR, "mmc");
3113 goto out_chrdev_unreg;
3115 res = mmc_register_driver(&mmc_driver);
3117 goto out_blkdev_unreg;
3122 unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
3124 unregister_chrdev_region(mmc_rpmb_devt, MAX_DEVICES);
3126 bus_unregister(&mmc_rpmb_bus_type);
3130 static void __exit mmc_blk_exit(void)
3132 mmc_unregister_driver(&mmc_driver);
3133 unregister_blkdev(MMC_BLOCK_MAJOR, "mmc");
3134 unregister_chrdev_region(mmc_rpmb_devt, MAX_DEVICES);
3135 bus_unregister(&mmc_rpmb_bus_type);
3138 module_init(mmc_blk_init);
3139 module_exit(mmc_blk_exit);
3141 MODULE_LICENSE("GPL");
3142 MODULE_DESCRIPTION("Multimedia Card (MMC) block device driver");