cbfstool: Rename cbfs_walk() to cbfs_legacy_walk()

This function name clashes with cbfs_walk() in the new commonlib CBFS
stack, so rename it to cbfs_legacy_walk(). While we could replace it
with the new commonlib implementation, it still has support for certain
features in the deprecated pre-FMAP CBFSes (such as non-standard header
alignment), which are needed to handle old files but probably not
something we'd want to burden the commonlib implementation with. So
until we decide to deprecate support for those files from cbfstool as
well, it seems easier to just keep the existing implementation here.

Signed-off-by: Julius Werner <jwerner@chromium.org>
Change-Id: I37c7e7aa9a206372817d8d0b8f66d72bafb4f346
Reviewed-on: https://review.coreboot.org/c/coreboot/+/41118
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Aaron Durbin <adurbin@chromium.org>

2 files changed, 13 insertions, 11 deletions

diff --git a/util/cbfstool/cbfs_image.c b/util/cbfstool/cbfs_image.c
index 793713f33670..5d9581499f5b 100644
--- a/util/cbfstool/cbfs_image.c
+++ b/util/cbfstool/cbfs_image.c
@@ -454,7 +454,7 @@ int cbfs_expand_to_region(struct buffer *region)
 		cbfs_create_empty_entry(entry, CBFS_TYPE_NULL,
 			last_entry_size, "");
 		/* If the last entry was an empty file, merge them. */
-		cbfs_walk(&image, cbfs_merge_empty_entry, NULL);
+		cbfs_legacy_walk(&image, cbfs_merge_empty_entry, NULL);
 	}
 
 	return 0;
@@ -606,7 +606,7 @@ int cbfs_compact_instance(struct cbfs_image *image)
 					prev_size, "");
 
 		/* Merge any potential empty entries together. */
-		cbfs_walk(image, cbfs_merge_empty_entry, NULL);
+		cbfs_legacy_walk(image, cbfs_merge_empty_entry, NULL);
 
 		/*
 		 * Since current switched to an empty file keep track of it.
@@ -745,7 +745,7 @@ int cbfs_add_entry(struct cbfs_image *image, struct buffer *buffer,
 
 	// Merge empty entries.
 	DEBUG("(trying to merge empty entries...)\n");
-	cbfs_walk(image, cbfs_merge_empty_entry, NULL);
+	cbfs_legacy_walk(image, cbfs_merge_empty_entry, NULL);
 
 	for (entry = cbfs_find_first_entry(image);
 	     entry && cbfs_is_valid_entry(image, entry);
@@ -1365,7 +1365,7 @@ int cbfs_remove_entry(struct cbfs_image *image, const char *name)
 	DEBUG("cbfs_remove_entry: Removed %s @ 0x%x\n",
 	      entry->filename, cbfs_get_entry_addr(image, entry));
 	entry->type = htonl(CBFS_TYPE_DELETED);
-	cbfs_walk(image, cbfs_merge_empty_entry, NULL);
+	cbfs_legacy_walk(image, cbfs_merge_empty_entry, NULL);
 	return 0;
 }
 
@@ -1582,7 +1582,7 @@ int cbfs_print_directory(struct cbfs_image *image)
 	if (cbfs_is_legacy_cbfs(image))
 		cbfs_print_header_info(image);
 	printf("%-30s %-10s %-12s   Size   Comp\n", "Name", "Offset", "Type");
-	cbfs_walk(image, cbfs_print_entry_info, NULL);
+	cbfs_legacy_walk(image, cbfs_print_entry_info, NULL);
 	return 0;
 }
 
@@ -1602,7 +1602,7 @@ int cbfs_print_parseable_directory(struct cbfs_image *image)
 	for (i = 0; i < ARRAY_SIZE(header) - 1; i++)
 		fprintf(stdout, "%s%s", header[i], sep);
 	fprintf(stdout, "%s\n", header[i]);
-	cbfs_walk(image, cbfs_print_parseable_entry_info, stdout);
+	cbfs_legacy_walk(image, cbfs_print_parseable_entry_info, stdout);
 	return 0;
 }
 
@@ -1645,7 +1645,7 @@ int cbfs_merge_empty_entry(struct cbfs_image *image, struct cbfs_file *entry,
 	return 0;
 }
 
-int cbfs_walk(struct cbfs_image *image, cbfs_entry_callback callback,
+int cbfs_legacy_walk(struct cbfs_image *image, cbfs_entry_callback callback,
 	      void *arg)
 {
 	int count = 0;
@@ -1955,7 +1955,7 @@ int32_t cbfs_locate_entry(struct cbfs_image *image, size_t size,
 	need_len = metadata_size + size;
 
 	// Merge empty entries to build get max available space.
-	cbfs_walk(image, cbfs_merge_empty_entry, NULL);
+	cbfs_legacy_walk(image, cbfs_merge_empty_entry, NULL);
 
 	/* Three cases of content location on memory page:
 	 * case 1.
diff --git a/util/cbfstool/cbfs_image.h b/util/cbfstool/cbfs_image.h
index cd44438db218..74c35c94438a 100644
--- a/util/cbfstool/cbfs_image.h
+++ b/util/cbfstool/cbfs_image.h
@@ -117,16 +117,18 @@ int cbfs_create_empty_entry(struct cbfs_file *entry, int type,
 int32_t cbfs_locate_entry(struct cbfs_image *image, size_t size,
 			  size_t page_size, size_t align, size_t metadata_size);
 
-/* Callback function used by cbfs_walk.
+/* Callback function used by cbfs_legacy_walk.
  * Returns 0 on success, or non-zero to stop further iteration. */
 typedef int (*cbfs_entry_callback)(struct cbfs_image *image,
 				   struct cbfs_file *file,
 				   void *arg);
 
 /* Iterates through all entries in CBFS image, and invoke with callback.
- * Stops if callback returns non-zero values.
+ * Stops if callback returns non-zero values. Unlike the commonlib cbfs_walk(),
+ * this can deal with different alignments in legacy CBFS (with master header).
  * Returns number of entries invoked. */
-int cbfs_walk(struct cbfs_image *image, cbfs_entry_callback callback, void *arg);
+int cbfs_legacy_walk(struct cbfs_image *image, cbfs_entry_callback callback,
+		     void *arg);
 
 /* Primitive CBFS utilities */