boot: Convert IMAGE_FORMAT into an enum
authorSimon Glass <sjg@chromium.org>
Thu, 6 Mar 2025 00:25:08 +0000 (17:25 -0700)
committerTom Rini <trini@konsulko.com>
Tue, 18 Mar 2025 19:12:15 +0000 (13:12 -0600)
Use an enum so it is clearer that these options are related. Update
genimg_get_format(), tidy up the function comment and move it to the
header file, since it is exported.

Signed-off-by: Simon Glass <sjg@chromium.org>
boot/image-board.c
include/image.h

index 514f8e6..addccf8 100644 (file)
@@ -234,21 +234,7 @@ ulong genimg_get_kernel_addr(char * const img_addr)
                                          &fit_uname_kernel);
 }
 
-/**
- * genimg_get_format - get image format type
- * @img_addr: image start address
- *
- * genimg_get_format() checks whether provided address points to a valid
- * legacy or FIT image.
- *
- * New uImage format and FDT blob are based on a libfdt. FDT blob
- * may be passed directly or embedded in a FIT image. In both situations
- * genimg_get_format() must be able to dectect libfdt header.
- *
- * returns:
- *     image format type or IMAGE_FORMAT_INVALID if no image is present
- */
-int genimg_get_format(const void *img_addr)
+enum image_fmt_t genimg_get_format(const void *img_addr)
 {
        if (CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)) {
                const struct legacy_img_hdr *hdr;
@@ -434,6 +420,8 @@ static int select_ramdisk(struct bootm_headers *images, const char *select, u8 a
                        done = true;
                }
                break;
+       case IMAGE_FORMAT_INVALID:
+               break;
        }
 
        if (!done) {
index c1db838..dc1a7c3 100644 (file)
@@ -598,10 +598,12 @@ int boot_get_setup(struct bootm_headers *images, uint8_t arch, ulong *setup_star
                   ulong *setup_len);
 
 /* Image format types, returned by _get_format() routine */
-#define IMAGE_FORMAT_INVALID   0x00
-#define IMAGE_FORMAT_LEGACY    0x01    /* legacy image_header based format */
-#define IMAGE_FORMAT_FIT       0x02    /* new, libfdt based format */
-#define IMAGE_FORMAT_ANDROID   0x03    /* Android boot image */
+enum image_fmt_t {
+       IMAGE_FORMAT_INVALID,
+       IMAGE_FORMAT_LEGACY,            /* legacy image_header based format */
+       IMAGE_FORMAT_FIT,               /* new, libfdt based format */
+       IMAGE_FORMAT_ANDROID,           /* Android boot image */
+};
 
 /**
  * genimg_get_kernel_addr_fit() - Parse FIT specifier
@@ -630,7 +632,21 @@ ulong genimg_get_kernel_addr_fit(const char *const img_addr,
                                 const char **fit_uname_kernel);
 
 ulong genimg_get_kernel_addr(char * const img_addr);
-int genimg_get_format(const void *img_addr);
+
+/**
+ * genimg_get_format - get image format type
+ * @img_addr: image start address
+ * Return: image format type or IMAGE_FORMAT_INVALID if no image is present
+ *
+ * genimg_get_format() checks whether provided address points to a valid
+ * legacy or FIT image.
+ *
+ * New uImage format and FDT blob are based on a libfdt. FDT blob
+ * may be passed directly or embedded in a FIT image. In both situations
+ * genimg_get_format() must be able to dectect libfdt header.
+ */
+enum image_fmt_t genimg_get_format(const void *img_addr);
+
 int genimg_has_config(struct bootm_headers *images);
 
 /**