boot: Improve comments related to global bootmeths

Add a few comments about global bootmeths and first_glob_method

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Reviewed-by: Mattijs Korpershoek <mkorpershoek@kernel.org>
Reviewed-by: Sam Protsenko <semen.protsenko@linaro.org>

diff --git a/boot/bootflow.c b/boot/bootflow.c
index d79f303..15df706 100644 (file)
--- a/boot/bootflow.c
+++ b/boot/bootflow.c
@@ -344,6 +344,7 @@ static int bootflow_check(struct bootflow_iter *iter, struct bootflow *bflow)
        struct udevice *dev;
        int ret;
 
+       /* handle global bootmeths if needed */
        if (IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) && iter->doing_global) {
                bootflow_iter_set_dev(iter, NULL, 0);
                ret = bootmeth_get_bootflow(iter->method, bflow);

diff --git a/boot/bootmeth-uclass.c b/boot/bootmeth-uclass.c
index 188f6ea..bb2dd84 100644 (file)
--- a/boot/bootmeth-uclass.c
+++ b/boot/bootmeth-uclass.c
@@ -204,6 +204,7 @@ int bootmeth_setup_iter_order(struct bootflow_iter *iter, bool include_global)
                goto err_order;
        }
 
+       /* start with the global bootmeths */
        if (IS_ENABLED(CONFIG_BOOTMETH_GLOBAL) && include_global &&
            iter->first_glob_method != -1 && iter->first_glob_method != count) {
                iter->cur_method = iter->first_glob_method;

diff --git a/include/bootflow.h b/include/bootflow.h
index 3242206..2ef6eb2 100644 (file)
--- a/include/bootflow.h
+++ b/include/bootflow.h
@@ -250,7 +250,8 @@ enum bootflow_meth_flags_t {
  * @cur_label: Current label being processed
  * @num_methods: Number of bootmeth devices in @method_order
  * @cur_method: Current method number, an index into @method_order
- * @first_glob_method: First global method, if any, else -1
+ * @first_glob_method: Index of first global method within @method_order[], if
+ * any, else -1
  * @cur_prio: Current priority being scanned
  * @method_order: List of bootmeth devices to use, in order. The normal methods
  *     appear first, then the global ones, if any

diff --git a/test/boot/bootflow.c b/test/boot/bootflow.c
index 8de5a31..7cd83dc 100644 (file)
--- a/test/boot/bootflow.c
+++ b/test/boot/bootflow.c
@@ -401,7 +401,7 @@ static int bootflow_system(struct unit_test_state *uts)
        ut_assertok(device_probe(dev));
        sandbox_set_fake_efi_mgr_dev(dev, true);
 
-       /* We should get a single 'bootmgr' method right at the end */
+       /* We should get a single 'bootmgr' method at the start */
        bootstd_clear_glob();
        ut_assertok(run_command("bootflow scan -lH", 0));
        ut_assert_skip_to_line(