image: Add the concept of a phase to FIT

We want to be able to mark an image as related to a phase, so we can
easily load all the images for SPL or for U-Boot proper.

Add this to the FIT specification, along with some access functions.

Signed-off-by: Simon Glass <sjg@chromium.org>

diff --git a/boot/image.c b/boot/image.c
index 9f95b3260a8071865e772adc0c47b749b6e57d00..b33d1dfc6b3627e532573e55648381c019ea6c33 100644 (file)
--- a/boot/image.c
+++ b/boot/image.c
@@ -194,6 +194,13 @@ static const table_entry_t uimage_comp[] = {
        {       -1,             "",             "",                     },
 };
 
+static const table_entry_t uimage_phase[] = {
+       {       IH_PHASE_NONE,  "none",         "any",          },
+       {       IH_PHASE_U_BOOT, "u-boot",      "U-Boot phase", },
+       {       IH_PHASE_SPL,   "spl",          "SPL Phase",    },
+       {       -1,             "",             "",             },
+};
+
 struct table_info {
        const char *desc;
        int count;
@@ -215,6 +222,7 @@ static const struct table_info table_info[IH_COUNT] = {
        { "compression", IH_COMP_COUNT, uimage_comp },
        { "operating system", IH_OS_COUNT, uimage_os },
        { "image type", IH_TYPE_COUNT, uimage_type },
+       { "phase", IH_PHASE_COUNT, uimage_phase },
 };
 
 /*****************************************************************************/
@@ -656,6 +664,11 @@ const char *genimg_get_comp_name(uint8_t comp)
                                        comp));
 }
 
+const char *genimg_get_phase_name(enum image_phase_t phase)
+{
+       return get_table_entry_name(uimage_phase, "Unknown Phase", phase);
+}
+
 static const char *genimg_get_short_name(const table_entry_t *table, int val)
 {
        table = get_table_entry(table, val);
@@ -731,3 +744,8 @@ int genimg_get_comp_id(const char *name)
 {
        return (get_table_entry_id(uimage_comp, "Compression", name));
 }
+
+int genimg_get_phase_id(const char *name)
+{
+       return get_table_entry_id(uimage_phase, "Phase", name);
+}

diff --git a/doc/uImage.FIT/source_file_format.txt b/doc/uImage.FIT/source_file_format.txt
index 0a03c942bda71a3b6178392679f7685713f0aafa..4640e38e3cc0eee9171df7aecd8e30fdd11cd004 100644 (file)
--- a/doc/uImage.FIT/source_file_format.txt
+++ b/doc/uImage.FIT/source_file_format.txt
@@ -190,6 +190,9 @@ the '/images' node should have the following layout:
     Xilinx Zynq UltraScale+ (ZymqMP) device.
     "u-boot,zynqmp-fpga-enc" - encrypted FPGA bitstream for Xilinx Zynq
     UltraScale+ (ZynqMP) device.
+  - phase : U-Boot phase for which the image is intended.
+    "spl" - image is an SPL image
+    "u-boot" - image is a U-Boot image
 
   Optional nodes:
   - hash-1 : Each hash sub-node represents separate hash or checksum

diff --git a/include/image.h b/include/image.h
index 92efec0f04b7c518d2d277e664803005ba8cd861..7c3dcc407c0f3fce9d29ab2ed296495468151065 100644 (file)
--- a/include/image.h
+++ b/include/image.h
@@ -58,6 +58,7 @@ enum ih_category {
        IH_COMP,
        IH_OS,
        IH_TYPE,
+       IH_PHASE,
 
        IH_COUNT,
 };
@@ -184,8 +185,7 @@ enum {
  * New IDs *MUST* be appended at the end of the list and *NEVER*
  * inserted for backward compatibility.
  */
-
-enum {
+enum image_type_t {
        IH_TYPE_INVALID         = 0,    /* Invalid Image                */
        IH_TYPE_STANDALONE,             /* Standalone Program           */
        IH_TYPE_KERNEL,                 /* OS Kernel Image              */
@@ -252,6 +252,59 @@ enum {
        IH_COMP_COUNT,
 };
 
+/**
+ * Phases - images intended for particular U-Boot phases (SPL, etc.)
+ *
+ * @IH_PHASE_NONE: No phase information, can be loaded by any phase
+ * @IH_PHASE_U_BOOT: Only for U-Boot proper
+ * @IH_PHASE_SPL: Only for SPL
+ */
+enum image_phase_t {
+       IH_PHASE_NONE           = 0,
+       IH_PHASE_U_BOOT,
+       IH_PHASE_SPL,
+
+       IH_PHASE_COUNT,
+};
+
+#define IMAGE_PHASE_SHIFT      8
+#define IMAGE_PHASE_MASK       (0xff << IMAGE_PHASE_SHIFT)
+#define IMAGE_TYPE_MASK                0xff
+
+/**
+ * image_ph() - build a composite value combining and type
+ *
+ * @phase: Image phase value
+ * @type: Image type value
+ * Returns: Composite value containing both
+ */
+static inline int image_ph(enum image_phase_t phase, enum image_type_t type)
+{
+       return type | (phase << IMAGE_PHASE_SHIFT);
+}
+
+/**
+ * image_ph_phase() - obtain the phase from a composite phase/type value
+ *
+ * @image_ph_type: Composite value to convert
+ * Returns: Phase value taken from the composite value
+ */
+static inline int image_ph_phase(int image_ph_type)
+{
+       return (image_ph_type & IMAGE_PHASE_MASK) >> IMAGE_PHASE_SHIFT;
+}
+
+/**
+ * image_ph_type() - obtain the type from a composite phase/type value
+ *
+ * @image_ph_type: Composite value to convert
+ * Returns: Type value taken from the composite value
+ */
+static inline int image_ph_type(int image_ph_type)
+{
+       return image_ph_type & IMAGE_TYPE_MASK;
+}
+
 #define LZ4F_MAGIC     0x184D2204      /* LZ4 Magic Number             */
 #define IH_MAGIC       0x27051956      /* Image Magic Number           */
 #define IH_NMLEN               32      /* Image Name Length            */
@@ -437,6 +490,22 @@ const char *genimg_get_os_short_name(uint8_t comp);
 
 const char *genimg_get_arch_name(uint8_t arch);
 
+/**
+ * genimg_get_phase_name() - Get the friendly name for a phase
+ *
+ * @phase: Phase value to look up
+ * Returns: Friendly name for the phase (e.g. "U-Boot phase")
+ */
+const char *genimg_get_phase_name(enum image_phase_t phase);
+
+/**
+ * genimg_get_phase_id() - Convert a phase name to an ID
+ *
+ * @name: Name to convert (e.g. "u-boot")
+ * Returns: ID for that phase (e.g. IH_PHASE_U_BOOT)
+ */
+int genimg_get_phase_id(const char *name);
+
 /**
  * genimg_get_arch_short_name() - get the short name for an architecture
  *
@@ -955,6 +1024,7 @@ int booti_setup(ulong image, ulong *relocated_addr, ulong *size,
 #define FIT_FPGA_PROP          "fpga"
 #define FIT_FIRMWARE_PROP      "firmware"
 #define FIT_STANDALONE_PROP    "standalone"
+#define FIT_PHASE_PROP         "phase"
 
 #define FIT_MAX_HASH_LEN       HASH_MAX_DIGEST_SIZE
 

diff --git a/test/boot/Makefile b/test/boot/Makefile
index 5bb3f889759989987f7c5bf59f62d1f9f1be98fe..d724629d3b0f5c8421617ccb731468b7689132ff 100644 (file)
--- a/test/boot/Makefile
+++ b/test/boot/Makefile
@@ -3,6 +3,7 @@
 # Copyright 2021 Google LLC
 
 obj-$(CONFIG_BOOTSTD) += bootdev.o bootstd_common.o bootflow.o bootmeth.o
+obj-$(CONFIG_FIT) += image.o
 
 ifdef CONFIG_OF_LIVE
 obj-$(CONFIG_BOOTMETH_VBE_SIMPLE) += vbe_simple.o

diff --git a/test/boot/image.c b/test/boot/image.c
new file mode 100644 (file)
index 0000000..2844b05
--- /dev/null
+++ b/test/boot/image.c
@@ -0,0 +1,36 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Test for vbe-simple bootmeth. All start with 'vbe_simple'
+ *
+ * Copyright 2023 Google LLC
+ * Written by Simon Glass <sjg@chromium.org>
+ */
+
+#include <common.h>
+#include <image.h>
+#include <test/suites.h>
+#include <test/ut.h>
+#include "bootstd_common.h"
+
+/* Test of image phase */
+static int test_image_phase(struct unit_test_state *uts)
+{
+       int val;
+
+       ut_asserteq_str("U-Boot phase", genimg_get_phase_name(IH_PHASE_U_BOOT));
+       ut_asserteq_str("SPL Phase", genimg_get_phase_name(IH_PHASE_SPL));
+       ut_asserteq_str("any", genimg_get_phase_name(IH_PHASE_NONE));
+       ut_asserteq_str("Unknown Phase", genimg_get_phase_name(-1));
+
+       ut_asserteq(IH_PHASE_U_BOOT, genimg_get_phase_id("u-boot"));
+       ut_asserteq(IH_PHASE_SPL, genimg_get_phase_id("spl"));
+       ut_asserteq(IH_PHASE_NONE, genimg_get_phase_id("none"));
+       ut_asserteq(-1, genimg_get_phase_id("fred"));
+
+       val = image_ph(IH_PHASE_SPL, IH_TYPE_FIRMWARE);
+       ut_asserteq(IH_PHASE_SPL, image_ph_phase(val));
+       ut_asserteq(IH_TYPE_FIRMWARE, image_ph_type(val));
+
+       return 0;
+}
+BOOTSTD_TEST(test_image_phase, 0);