vbe: Move OS implementation into a separate file
authorSimon Glass <sjg@chromium.org>
Fri, 21 Oct 2022 00:23:11 +0000 (18:23 -0600)
committerTom Rini <trini@konsulko.com>
Mon, 31 Oct 2022 15:03:36 +0000 (11:03 -0400)
Move this into its own file so it can be built only by U-Boot proper.

Signed-off-by: Simon Glass <sjg@chromium.org>
boot/Makefile
boot/vbe_simple.c
boot/vbe_simple.h
boot/vbe_simple_os.c [new file with mode: 0644]
test/py/tests/test_event_dump.py

index e5c2790..f0c3154 100644 (file)
@@ -50,3 +50,4 @@ endif
 obj-$(CONFIG_$(SPL_TPL_)BOOTMETH_VBE) += vbe.o vbe_request.o
 obj-$(CONFIG_$(SPL_TPL_)BOOTMETH_VBE_SIMPLE) += vbe_simple.o
 obj-$(CONFIG_$(SPL_TPL_)BOOTMETH_VBE_SIMPLE_FW) += vbe_simple_fw.o
+obj-$(CONFIG_$(SPL_TPL_)BOOTMETH_VBE_SIMPLE_OS) += vbe_simple_os.o
index 1ccd416..59676d8 100644 (file)
 #include <memalign.h>
 #include <mmc.h>
 #include <vbe.h>
-#include <version_string.h>
 #include <dm/device-internal.h>
 #include <dm/ofnode.h>
 #include <u-boot/crc.h>
 #include "vbe_simple.h"
 
-enum {
-       MAX_VERSION_LEN         = 256,
-
-       NVD_HDR_VER_SHIFT       = 0,
-       NVD_HDR_VER_MASK        = 0xf,
-       NVD_HDR_SIZE_SHIFT      = 4,
-       NVD_HDR_SIZE_MASK       = 0xf << NVD_HDR_SIZE_SHIFT,
-
-       /* Firmware key-version is in the top 16 bits of fw_ver */
-       FWVER_KEY_SHIFT         = 16,
-       FWVER_FW_MASK           = 0xffff,
-
-       NVD_HDR_VER_CUR         = 1,    /* current version */
-};
-
-/** struct simple_state - state information read from media
- *
- * @fw_version: Firmware version string
- * @fw_vernum: Firmware version number
- */
-struct simple_state {
-       char fw_version[MAX_VERSION_LEN];
-       u32 fw_vernum;
-};
-
 /** struct simple_nvdata - storage format for non-volatile data */
 struct simple_nvdata {
        u8 crc8;
@@ -116,7 +90,7 @@ static int simple_read_nvdata(struct udevice *dev, struct blk_desc *desc,
        return 0;
 }
 
-static int simple_read_state(struct udevice *dev, struct simple_state *state)
+int vbe_simple_read_state(struct udevice *dev, struct simple_state *state)
 {
        ALLOC_CACHE_ALIGN_BUFFER(u8, buf, MMC_MAX_BLOCK_LEN);
        struct simple_priv *priv = dev_get_priv(dev);
@@ -157,7 +131,7 @@ static int vbe_simple_get_state_desc(struct udevice *dev, char *buf,
        struct simple_state state;
        int ret;
 
-       ret = simple_read_state(dev, &state);
+       ret = vbe_simple_read_state(dev, &state);
        if (ret)
                return log_msg_ret("read", ret);
 
@@ -206,78 +180,6 @@ static struct bootmeth_ops bootmeth_vbe_simple_ops = {
        .read_file      = vbe_simple_read_file,
 };
 
-int vbe_simple_fixup_node(ofnode node, struct simple_state *state)
-{
-       char *version;
-       int ret;
-
-       version = strdup(state->fw_version);
-       if (!version)
-               return log_msg_ret("dup", -ENOMEM);
-
-       ret = ofnode_write_string(node, "cur-version", version);
-       if (ret)
-               return log_msg_ret("ver", ret);
-       ret = ofnode_write_u32(node, "cur-vernum", state->fw_vernum);
-       if (ret)
-               return log_msg_ret("num", ret);
-       ret = ofnode_write_string(node, "bootloader-version", version_string);
-       if (ret)
-               return log_msg_ret("bl", ret);
-
-       return 0;
-}
-
-/**
- * bootmeth_vbe_simple_ft_fixup() - Write out all VBE simple data to the DT
- *
- * @ctx: Context for event
- * @event: Event to process
- * @return 0 if OK, -ve on error
- */
-static int bootmeth_vbe_simple_ft_fixup(void *ctx, struct event *event)
-{
-       oftree tree = event->data.ft_fixup.tree;
-       struct udevice *dev;
-
-       /*
-        * Ideally we would have driver model support for fixups, but that does
-        * not exist yet. It is a step too far to try to do this before VBE is
-        * in place.
-        */
-       for (vbe_find_first_device(&dev); dev; vbe_find_next_device(&dev)) {
-               struct simple_state state;
-               ofnode node, subnode;
-               int ret;
-
-               if (strcmp("vbe_simple", dev->driver->name))
-                       continue;
-
-               /* Check if there is a node to fix up */
-               node = oftree_path(tree, "/chosen/fwupd");
-               if (!ofnode_valid(node))
-                       continue;
-               subnode = ofnode_find_subnode(node, dev->name);
-               if (!ofnode_valid(subnode))
-                       continue;
-
-               log_debug("Fixing up: %s\n", dev->name);
-               ret = device_probe(dev);
-               if (ret)
-                       return log_msg_ret("probe", ret);
-               ret = simple_read_state(dev, &state);
-               if (ret)
-                       return log_msg_ret("read", ret);
-
-               ret = vbe_simple_fixup_node(subnode, &state);
-               if (ret)
-                       return log_msg_ret("fix", ret);
-       }
-
-       return 0;
-}
-EVENT_SPY(EVT_FT_FIXUP, bootmeth_vbe_simple_ft_fixup);
-
 static int bootmeth_vbe_simple_probe(struct udevice *dev)
 {
        struct simple_priv *priv = dev_get_priv(dev);
index e37a9fa..56d3192 100644 (file)
@@ -9,6 +9,21 @@
 #ifndef __VBE_SIMPLE_H
 #define __VBE_SIMPLE_H
 
+enum {
+       MAX_VERSION_LEN         = 256,
+
+       NVD_HDR_VER_SHIFT       = 0,
+       NVD_HDR_VER_MASK        = 0xf,
+       NVD_HDR_SIZE_SHIFT      = 4,
+       NVD_HDR_SIZE_MASK       = 0xf << NVD_HDR_SIZE_SHIFT,
+
+       /* Firmware key-version is in the top 16 bits of fw_ver */
+       FWVER_KEY_SHIFT         = 16,
+       FWVER_FW_MASK           = 0xffff,
+
+       NVD_HDR_VER_CUR         = 1,    /* current version */
+};
+
 /** struct simple_priv - information read from the device tree */
 struct simple_priv {
        u32 area_start;
@@ -21,6 +36,16 @@ struct simple_priv {
        const char *storage;
 };
 
+/** struct simple_state - state information read from media
+ *
+ * @fw_version: Firmware version string
+ * @fw_vernum: Firmware version number
+ */
+struct simple_state {
+       char fw_version[MAX_VERSION_LEN];
+       u32 fw_vernum;
+};
+
 /**
  * vbe_simple_read_fw_bootflow() - Read a bootflow for firmware
  *
@@ -34,4 +59,13 @@ struct simple_priv {
  */
 int vbe_simple_read_bootflow_fw(struct udevice *dev, struct bootflow *bflow);
 
+/**
+ * vbe_simple_read_state() - Read the VBE simple state information
+ *
+ * @dev: VBE bootmeth
+ * @state: Place to put the state
+ * @return 0 if OK, -ve on error
+ */
+int vbe_simple_read_state(struct udevice *dev, struct simple_state *state);
+
 #endif /* __VBE_SIMPLE_H */
diff --git a/boot/vbe_simple_os.c b/boot/vbe_simple_os.c
new file mode 100644 (file)
index 0000000..7761b9e
--- /dev/null
@@ -0,0 +1,89 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Verified Boot for Embedded (VBE) loading firmware phases
+ *
+ * Copyright 2022 Google LLC
+ * Written by Simon Glass <sjg@chromium.org>
+ */
+
+#define LOG_CATEGORY LOGC_BOOT
+
+#include <common.h>
+#include <dm.h>
+#include <bootflow.h>
+#include <vbe.h>
+#include <version_string.h>
+#include <dm/device-internal.h>
+#include "vbe_simple.h"
+
+int vbe_simple_fixup_node(ofnode node, struct simple_state *state)
+{
+       char *version;
+       int ret;
+
+       version = strdup(state->fw_version);
+       if (!version)
+               return log_msg_ret("dup", -ENOMEM);
+
+       ret = ofnode_write_string(node, "cur-version", version);
+       if (ret)
+               return log_msg_ret("ver", ret);
+       ret = ofnode_write_u32(node, "cur-vernum", state->fw_vernum);
+       if (ret)
+               return log_msg_ret("num", ret);
+       ret = ofnode_write_string(node, "bootloader-version", version_string);
+       if (ret)
+               return log_msg_ret("bl", ret);
+
+       return 0;
+}
+
+/**
+ * bootmeth_vbe_simple_ft_fixup() - Write out all VBE simple data to the DT
+ *
+ * @ctx: Context for event
+ * @event: Event to process
+ * @return 0 if OK, -ve on error
+ */
+static int bootmeth_vbe_simple_ft_fixup(void *ctx, struct event *event)
+{
+       oftree tree = event->data.ft_fixup.tree;
+       struct udevice *dev;
+
+       /*
+        * Ideally we would have driver model support for fixups, but that does
+        * not exist yet. It is a step too far to try to do this before VBE is
+        * in place.
+        */
+       for (vbe_find_first_device(&dev); dev; vbe_find_next_device(&dev)) {
+               struct simple_state state;
+               ofnode node, subnode;
+               int ret;
+
+               if (strcmp("vbe_simple", dev->driver->name))
+                       continue;
+
+               /* Check if there is a node to fix up */
+               node = oftree_path(tree, "/chosen/fwupd");
+               if (!ofnode_valid(node))
+                       continue;
+               subnode = ofnode_find_subnode(node, dev->name);
+               if (!ofnode_valid(subnode))
+                       continue;
+
+               log_debug("Fixing up: %s\n", dev->name);
+               ret = device_probe(dev);
+               if (ret)
+                       return log_msg_ret("probe", ret);
+               ret = simple_read_state(dev, &state);
+               if (ret)
+                       return log_msg_ret("read", ret);
+
+               ret = vbe_simple_fixup_node(subnode, &state);
+               if (ret)
+                       return log_msg_ret("fix", ret);
+       }
+
+       return 0;
+}
+EVENT_SPY(EVT_FT_FIXUP, bootmeth_vbe_simple_ft_fixup);
index 0984efa..972c383 100644 (file)
@@ -17,6 +17,5 @@ def test_event_dump(u_boot_console):
     expect = '''.*Event type            Id                              Source location
 --------------------  ------------------------------  ------------------------------
 EVT_FT_FIXUP          bootmeth_vbe_ft_fixup           .*vbe_request.c:.*
-EVT_FT_FIXUP          bootmeth_vbe_simple_ft_fixup    .*vbe_simple.c:.*
 EVT_MISC_INIT_F       sandbox_misc_init_f             .*start.c:'''
     assert re.match(expect, out, re.MULTILINE) is not None