From: Mattijs Korpershoek <mkorpershoek@baylibre.com>
To: Simon Glass <sjg@chromium.org>,
U-Boot Mailing List <u-boot@lists.denx.de>
Cc: Bin Meng <bmeng.cn@gmail.com>, Simon Glass <sjg@chromium.org>,
Jaehoon Chung <jh80.chung@samsung.com>,
Marek Vasut <marex@denx.de>, Peng Fan <peng.fan@nxp.com>
Subject: Re: [PATCH 3/8] bootstd: Rename bootdev_setup_sibling_blk()
Date: Fri, 28 Jul 2023 10:00:16 +0200 [thread overview]
Message-ID: <875y644ga7.fsf@baylibre.com> (raw)
In-Reply-To: <20230728023755.680278-4-sjg@chromium.org>
On jeu., juil. 27, 2023 at 20:37, Simon Glass <sjg@chromium.org> wrote:
> 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>
> ---
>
> boot/bootdev-uclass.c | 8 +++++---
> common/usb_storage.c | 2 +-
> doc/develop/bootstd.rst | 4 ++--
> drivers/mmc/mmc-uclass.c | 2 +-
> drivers/nvme/nvme.c | 2 +-
> drivers/scsi/scsi.c | 2 +-
> drivers/virtio/virtio-uclass.c | 2 +-
> include/bootdev.h | 8 ++++----
> 8 files changed, 16 insertions(+), 14 deletions(-)
>
> diff --git a/boot/bootdev-uclass.c b/boot/bootdev-uclass.c
> index 9660ff75676d..114853ffb72a 100644
> --- 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 ac6427577379..85774220ef2a 100644
> --- 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 7a2a69fdfcec..ec3136535783 100644
> --- 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 01d9b0201f2c..0e157672eae0 100644
> --- 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 a7add66ab4d1..20dc910d8a33 100644
> --- 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 6caeb3fcdd0d..0a3420b7fbc2 100644
> --- 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 31bb21c534e5..87323ab6d193 100644
> --- 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 1533adfe5065..0abc56cab9c8 100644
> --- 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
> @@ -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);
Can we also fix the documentation string?
Right now, on master (c98c401dfb48), the documentation strings states:
* bootdev_setup_for_blk() - Bind a new bootdev device for a blk device
This should be renamed to:
* bootdev_setup_for_sibling_blk() - Bind a new bootdev device for a blk device
>
> /**
> * 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;
> }
> --
> 2.41.0.487.g6d72f3e995-goog
next prev parent reply other threads:[~2023-07-28 8:00 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-28 2:37 [PATCH 0/8] x86: Improve bootstd support Simon Glass
2023-07-28 2:37 ` [PATCH 1/8] usb: Return -ENOENT when no devices are found Simon Glass
2023-07-28 2:37 ` [PATCH 2/8] lib: Suppress E when writing error-string output Simon Glass
2023-07-28 2:37 ` [PATCH 3/8] bootstd: Rename bootdev_setup_sibling_blk() Simon Glass
2023-07-28 8:00 ` Mattijs Korpershoek [this message]
2023-07-31 17:08 ` Simon Glass
2023-07-28 2:37 ` [PATCH 4/8] bootstd: Correct creating of bootdev sibling Simon Glass
2023-07-28 7:56 ` Mattijs Korpershoek
2023-07-28 2:37 ` [PATCH 5/8] bootstd: Add some more debugging in the bootdev uclass Simon Glass
2023-07-28 2:37 ` [PATCH 6/8] x86: coreboot: Add IDE and SATA Simon Glass
2023-07-28 2:37 ` [PATCH 7/8] x86: coreboot: Enable standard boot Simon Glass
2023-07-28 2:37 ` [PATCH 8/8] x86: coreboot: Enable support for CBFS Simon Glass
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=875y644ga7.fsf@baylibre.com \
--to=mkorpershoek@baylibre.com \
--cc=bmeng.cn@gmail.com \
--cc=jh80.chung@samsung.com \
--cc=marex@denx.de \
--cc=peng.fan@nxp.com \
--cc=sjg@chromium.org \
--cc=u-boot@lists.denx.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.