bootstd: Rename bootdev_setup_sibling_blk()

This name is a little confusing since it suggests that it sets up the
sibling block device. In fact it sets up a bootdev for it. Rename the
function to make this clearer.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
Reviewed-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>

diff --git a/boot/bootdev-uclass.c b/boot/bootdev-uclass.c
index 3f2c8d7153a4c1ea7c0bdc34a61464a7231a9a0a..1c16ca1b8d75462ed3ec37275f703b7c2a094726 100644 (file)
--- a/boot/bootdev-uclass.c
+++ b/boot/bootdev-uclass.c
@@ -262,7 +262,7 @@ static int bootdev_get_suffix_start(struct udevice *dev, const char *suffix)
        return len;
 }
 
-int bootdev_setup_sibling_blk(struct udevice *blk, const char *drv_name)
+int bootdev_setup_for_sibling_blk(struct udevice *blk, const char *drv_name)
 {
        struct udevice *parent, *dev;
        char dev_name[50];
@@ -305,7 +305,9 @@ int bootdev_get_sibling_blk(struct udevice *dev, struct udevice **blkp)
        if (device_get_uclass_id(dev) != UCLASS_BOOTDEV)
                return -EINVAL;
 
-       /* This should always work if bootdev_setup_sibling_blk() was used */
+       /*
+        * This should always work if bootdev_setup_for_sibling_blk() was used
+        */
        len = bootdev_get_suffix_start(dev, ".bootdev");
        ret = device_find_child_by_namelen(parent, dev->name, len, &blk);
        if (ret) {
@@ -335,7 +337,7 @@ static int bootdev_get_from_blk(struct udevice *blk, struct udevice **bootdevp)
        if (device_get_uclass_id(blk) != UCLASS_BLK)
                return -EINVAL;
 
-       /* This should always work if bootdev_setup_sibling_blk() was used */
+       /* This should always work if bootdev_setup_for_sibling_blk() was used */
        len = bootdev_get_suffix_start(blk, ".blk");
        snprintf(dev_name, sizeof(dev_name), "%.*s.%s", len, blk->name,
                 "bootdev");

diff --git a/common/usb_storage.c b/common/usb_storage.c
index ac64275773798a786e3e80cb82c92f94dc57f047..85774220ef2aa4699df7d9ba236b2c04630e7ec6 100644 (file)
--- a/common/usb_storage.c
+++ b/common/usb_storage.c
@@ -246,7 +246,7 @@ static int usb_stor_probe_device(struct usb_device *udev)
                if (ret)
                        return ret;
 
-               ret = bootdev_setup_sibling_blk(dev, "usb_bootdev");
+               ret = bootdev_setup_for_sibling_blk(dev, "usb_bootdev");
                if (ret) {
                        int ret2;
 

diff --git a/doc/develop/bootstd.rst b/doc/develop/bootstd.rst
index 7a2a69fdfcecc0a46c55fa7b718017f69d98f616..ec31365357830530357af4ad4a0bca3cc0f05213 100644 (file)
--- a/doc/develop/bootstd.rst
+++ b/doc/develop/bootstd.rst
@@ -306,7 +306,7 @@ media device::
 
 The bootdev device is typically created automatically in the media uclass'
 `post_bind()` method by calling `bootdev_setup_for_dev()` or
-`bootdev_setup_sibling_blk()`. The code typically something like this::
+`bootdev_setup_for_sibling_blk()`. The code typically something like this::
 
     /* dev is the Ethernet device */
     ret = bootdev_setup_for_dev(dev, "eth_bootdev");
@@ -316,7 +316,7 @@ The bootdev device is typically created automatically in the media uclass'
 or::
 
     /* blk is the block device (child of MMC device)
-    ret = bootdev_setup_sibling_blk(blk, "mmc_bootdev");
+    ret = bootdev_setup_for_sibling_blk(blk, "mmc_bootdev");
     if (ret)
         return log_msg_ret("bootdev", ret);
 

diff --git a/drivers/mmc/mmc-uclass.c b/drivers/mmc/mmc-uclass.c
index 01d9b0201f2cf90a26361c7c1f3aec4579662279..0e157672eae0b0707ea333145761435b4916ef74 100644 (file)
--- a/drivers/mmc/mmc-uclass.c
+++ b/drivers/mmc/mmc-uclass.c
@@ -421,7 +421,7 @@ int mmc_bind(struct udevice *dev, struct mmc *mmc, const struct mmc_config *cfg)
        mmc->cfg = cfg;
        mmc->priv = dev;
 
-       ret = bootdev_setup_sibling_blk(bdev, "mmc_bootdev");
+       ret = bootdev_setup_for_sibling_blk(bdev, "mmc_bootdev");
        if (ret)
                return log_msg_ret("bootdev", ret);
 

diff --git a/drivers/nvme/nvme.c b/drivers/nvme/nvme.c
index a7add66ab4d139640affb394b21c5493eba32811..20dc910d8a33abe435a543d5e51467aaad6f59ad 100644 (file)
--- a/drivers/nvme/nvme.c
+++ b/drivers/nvme/nvme.c
@@ -910,7 +910,7 @@ int nvme_init(struct udevice *udev)
                if (ret)
                        goto free_id;
 
-               ret = bootdev_setup_sibling_blk(ns_udev, "nvme_bootdev");
+               ret = bootdev_setup_for_sibling_blk(ns_udev, "nvme_bootdev");
                if (ret)
                        return log_msg_ret("bootdev", ret);
 

diff --git a/drivers/scsi/scsi.c b/drivers/scsi/scsi.c
index 6caeb3fcdd0db69d6a85b20694da21729db99fae..0a3420b7fbc2b4931344d6d78b085ac1375e1eeb 100644 (file)
--- a/drivers/scsi/scsi.c
+++ b/drivers/scsi/scsi.c
@@ -607,7 +607,7 @@ static int do_scsi_scan_one(struct udevice *dev, int id, int lun, bool verbose)
                /* TODO: undo create */
                return log_msg_ret("pro", ret);
 
-       ret = bootdev_setup_sibling_blk(bdev, "scsi_bootdev");
+       ret = bootdev_setup_for_sibling_blk(bdev, "scsi_bootdev");
        if (ret)
                return log_msg_ret("bd", ret);
 

diff --git a/drivers/virtio/virtio-uclass.c b/drivers/virtio/virtio-uclass.c
index f2b3ef1d8b92ea9c97fad37571b04f6b1eb8903f..c5420162735212afe8099c2c5d548650b9d85dcc 100644 (file)
--- a/drivers/virtio/virtio-uclass.c
+++ b/drivers/virtio/virtio-uclass.c
@@ -248,7 +248,7 @@ static int virtio_uclass_post_probe(struct udevice *udev)
        device_set_name_alloced(vdev);
 
        if (uc_priv->device == VIRTIO_ID_BLOCK && !IS_ENABLED(CONFIG_SANDBOX)) {
-               ret = bootdev_setup_sibling_blk(vdev, "virtio_bootdev");
+               ret = bootdev_setup_for_sibling_blk(vdev, "virtio_bootdev");
                if (ret)
                        return log_msg_ret("bootdev", ret);
        }

diff --git a/include/bootdev.h b/include/bootdev.h
index 1533adfe50650a73ca954e3cab462ac52828e9cd..848233187f87af7208811b54507f5e419e2b9fbf 100644 (file)
--- a/include/bootdev.h
+++ b/include/bootdev.h
@@ -371,7 +371,7 @@ int bootdev_next_prio(struct bootflow_iter *iter, struct udevice **devp);
 /**
  * bootdev_setup_for_dev() - Bind a new bootdev device (deprecated)
  *
- * Please use bootdev_setup_sibling_blk() instead since it supports multiple
+ * Please use bootdev_setup_for_sibling_blk() instead since it supports multiple
  * (child) block devices for each media device.
  *
  * Creates a bootdev device as a child of @parent. This should be called from
@@ -386,7 +386,7 @@ int bootdev_next_prio(struct bootflow_iter *iter, struct udevice **devp);
 int bootdev_setup_for_dev(struct udevice *parent, const char *drv_name);
 
 /**
- * bootdev_setup_for_blk() - Bind a new bootdev device for a blk device
+ * bootdev_setup_for_sibling_blk() - Bind a new bootdev device for a blk device
  *
  * Creates a bootdev device as a sibling of @blk. This should be called from
  * the driver's bind() method or its uclass' post_bind() method, at the same
@@ -398,7 +398,7 @@ int bootdev_setup_for_dev(struct udevice *parent, const char *drv_name);
  * @drv_name: Name of bootdev driver to bind
  * Return: 0 if OK, -ve on error
  */
-int bootdev_setup_sibling_blk(struct udevice *blk, const char *drv_name);
+int bootdev_setup_for_sibling_blk(struct udevice *blk, const char *drv_name);
 
 /**
  * bootdev_get_sibling_blk() - Locate the block device for a bootdev
@@ -428,8 +428,8 @@ static inline int bootdev_setup_for_dev(struct udevice *parent,
        return 0;
 }
 
-static inline int bootdev_setup_sibling_blk(struct udevice *blk,
-                                           const char *drv_name)
+static inline int bootdev_setup_for_sibling_blk(struct udevice *blk,
+                                               const char *drv_name)
 {
        return 0;
 }