futility: updater: Refactor function names

No real function changes.

For incoming changes, we want to rename the shared functions to make it more
clear (and more consistent) in hot it was used, including:

 - load_image: should be load_firmware_image(image, filename)
 - free_image: should be free_firmware_image
 - reload_image: should be reload_firmware_image
 - load_system_image: should be load_system_firmware
 - create_temp_file: should be updater_create_temp_file to make it more clear
   it is created for updater (and deleted when updater has finished)

BUG=chromium:875551
TEST=make futil; tests/futility/run_test_scripts.sh $(pwd)/build/futility
BRANCH=None

Change-Id: I120e30b5a4c40ccce03e5f361734f2583476703a
Signed-off-by: Hung-Te Lin <hungte@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/1270322
Reviewed-by: Randall Spangler <rspangler@chromium.org>

3 files changed, 37 insertions, 36 deletions

diff --git a/futility/updater.c b/futility/updater.c
index e52f27f7..afa4c017 100644
--- a/futility/updater.c
+++ b/futility/updater.c
@@ -66,10 +66,10 @@ enum flashrom_ops {
 
 /*
  * Helper function to create a new temporary file.
- * All files created will be removed by function remove_all_temp_files().
+ * All files created will be removed by updater_remove_all_temp_files().
  * Returns the path of new file, or NULL on failure.
  */
-const char *create_temp_file(struct updater_config *cfg)
+const char *updater_create_temp_file(struct updater_config *cfg)
 {
 	struct tempfile *new_temp;
 	char new_path[] = P_tmpdir "/fwupdater.XXXXXX";
@@ -100,7 +100,7 @@ const char *create_temp_file(struct updater_config *cfg)
  * Helper function to remove all files created by create_temp_file().
  * This is intended to be called only once at end of program execution.
  */
-static void remove_all_temp_files(struct updater_config *cfg)
+static void updater_remove_all_temp_files(struct updater_config *cfg)
 {
 	struct tempfile *tempfiles = cfg->tempfiles;
 	while (tempfiles != NULL) {
@@ -579,7 +579,7 @@ static int load_firmware_version(struct firmware_image *image,
  * Loads a firmware image from file.
  * Returns 0 on success, otherwise failure.
  */
-int load_image(const char *file_name, struct firmware_image *image)
+int load_firmware_image(struct firmware_image *image, const char *file_name)
 {
 	DEBUG("Load image file from %s...", file_name);
 
@@ -623,22 +623,22 @@ int load_image(const char *file_name, struct firmware_image *image)
  * Loads the active system firmware image (usually from SPI flash chip).
  * Returns 0 if success, non-zero if error.
  */
-int load_system_image(struct updater_config *cfg, struct firmware_image *image)
+int load_system_firmware(struct updater_config *cfg, struct firmware_image *image)
 {
-	const char *tmp_file = create_temp_file(cfg);
+	const char *tmp_file = updater_create_temp_file(cfg);
 
 	if (!tmp_file)
 		return -1;
 	RETURN_ON_FAILURE(host_flashrom(
 			FLASHROM_READ, tmp_file, image->programmer,
 			cfg->verbosity, NULL));
-	return load_image(tmp_file, image);
+	return load_firmware_image(image, tmp_file);
 }
 
 /*
  * Frees the allocated resource from a firmware image object.
  */
-void free_image(struct firmware_image *image)
+void free_firmware_image(struct firmware_image *image)
 {
 	free(image->data);
 	free(image->file_name);
@@ -734,7 +734,7 @@ static int emulate_write_firmware(const char *filename,
 	from.data = image->data;
 	from.size = image->size;
 
-	if (load_image(filename, &to_image)) {
+	if (load_firmware_image(&to_image, filename)) {
 		ERROR("Cannot load image from %s.", filename);
 		return -1;
 	}
@@ -776,7 +776,7 @@ static int emulate_write_firmware(const char *filename,
 		errorcnt++;
 	}
 
-	free_image(&to_image);
+	free_firmware_image(&to_image);
 	return errorcnt;
 }
 
@@ -789,7 +789,7 @@ static int write_firmware(struct updater_config *cfg,
 			  const struct firmware_image *image,
 			  const char *section_name)
 {
-	const char *tmp_file = create_temp_file(cfg);
+	const char *tmp_file = updater_create_temp_file(cfg);
 	const char *programmer = image->programmer;
 
 	if (!tmp_file)
@@ -1525,7 +1525,7 @@ enum updater_error_codes update_firmware(struct updater_config *cfg)
 		 * RO_VPD, RW_VPD, RW_NVRAM, RW_LEGACY.
 		 */
 		printf("Loading current system firmware...\n");
-		if (load_system_image(cfg, image_from) != 0)
+		if (load_system_firmware(cfg, image_from) != 0)
 			return UPDATE_ERR_SYSTEM_IMAGE;
 	}
 	printf(">> Current system: %s (RO:%s, RW/A:%s, RW/B:%s).\n",
@@ -1653,17 +1653,17 @@ int updater_setup_config(struct updater_config *cfg,
 
 	if (image && strcmp(image, "-") == 0) {
 		fprintf(stderr, "Reading image from stdin...\n");
-		image = create_temp_file(cfg);
+		image = updater_create_temp_file(cfg);
 		if (image)
 			errorcnt += !!save_from_stdin(image);
 	}
 	if (image) {
-		errorcnt += !!load_image(image, &cfg->image);
+		errorcnt += !!load_firmware_image(&cfg->image, image);
 	}
 	if (ec_image)
-		errorcnt += !!load_image(ec_image, &cfg->ec_image);
+		errorcnt += !!load_firmware_image(&cfg->ec_image, ec_image);
 	if (pd_image)
-		errorcnt += !!load_image(pd_image, &cfg->pd_image);
+		errorcnt += !!load_firmware_image(&cfg->pd_image, pd_image);
 
 	/*
 	 * Quirks must be loaded after images are loaded because we use image
@@ -1711,7 +1711,7 @@ int updater_setup_config(struct updater_config *cfg,
 		check_single_image = 1;
 		cfg->emulation = emulation;
 		DEBUG("Using file %s for emulation.", emulation);
-		errorcnt += load_image(emulation, &cfg->image_current);
+		errorcnt += load_firmware_image(&cfg->image_current, emulation);
 	}
 
 	/* Additional checks. */
@@ -1732,10 +1732,10 @@ int updater_setup_config(struct updater_config *cfg,
 void updater_delete_config(struct updater_config *cfg)
 {
 	assert(cfg);
-	free_image(&cfg->image);
-	free_image(&cfg->image_current);
-	free_image(&cfg->ec_image);
-	free_image(&cfg->pd_image);
-	remove_all_temp_files(cfg);
+	free_firmware_image(&cfg->image);
+	free_firmware_image(&cfg->image_current);
+	free_firmware_image(&cfg->ec_image);
+	free_firmware_image(&cfg->pd_image);
+	updater_remove_all_temp_files(cfg);
 	free(cfg);
 }
diff --git a/futility/updater.h b/futility/updater.h
index b315f2ed..2556c167 100644
--- a/futility/updater.h
+++ b/futility/updater.h
@@ -172,10 +172,10 @@ void updater_list_config_quirks(const struct updater_config *cfg);
 void updater_register_quirks(struct updater_config *cfg);
 
 /*
- * Helper function to create a new temporary file.
+ * Helper function to create a new temporary file within updater's life cycle.
  * Returns the path of new file, or NULL on failure.
  */
-const char *create_temp_file(struct updater_config *cfg);
+const char *updater_create_temp_file(struct updater_config *cfg);
 
 /*
  * Finds a firmware section by given name in the firmware image.
@@ -199,16 +199,17 @@ int preserve_firmware_section(const struct firmware_image *image_from,
 			      const char *section_name);
 
 /* Loads a firmware image from file. Returns 0 on success, otherwise failure. */
-int load_image(const char *file_name, struct firmware_image *image);
+int load_firmware_image(struct firmware_image *image, const char *file_name);
 
 /*
  * Loads the active system firmware image (usually from SPI flash chip).
  * Returns 0 if success, non-zero if error.
  */
-int load_system_image(struct updater_config *cfg, struct firmware_image *image);
+int load_system_firmware(struct updater_config *cfg,
+			 struct firmware_image *image);
 
 /* Frees the allocated resource from a firmware image object. */
-void free_image(struct firmware_image *image);
+void free_firmware_image(struct firmware_image *image);
 
 /* Gets the value (setting) of specified quirks from updater configuration. */
 int get_config_quirk(enum quirk_types quirk, const struct updater_config *cfg);
diff --git a/futility/updater_quirks.c b/futility/updater_quirks.c
index f625a74c..65d28202 100644
--- a/futility/updater_quirks.c
+++ b/futility/updater_quirks.c
@@ -53,12 +53,12 @@ static int write_image(const char *file_path, struct firmware_image *image)
 }
 
 /* Preserves meta data and reload image contents from given file path. */
-static int reload_image(const char *file_path, struct firmware_image *image)
+static int reload_firmware_image(const char *file_path, struct firmware_image *image)
 {
 	const char *programmer = image->programmer;
-	free_image(image);
+	free_firmware_image(image);
 	image->programmer = programmer;
-	return load_image(file_path, image);
+	return load_firmware_image(image, file_path);
 }
 
 /*
@@ -78,7 +78,7 @@ static int quirk_enlarge_image(struct updater_config *cfg)
 	if (image_from->size <= image_to->size)
 		return 0;
 
-	tmp_path = create_temp_file(cfg);
+	tmp_path = updater_create_temp_file(cfg);
 	if (!tmp_path)
 		return -1;
 
@@ -93,7 +93,7 @@ static int quirk_enlarge_image(struct updater_config *cfg)
 	while (to_write-- > 0)
 		fputc('\xff', fp);
 	fclose(fp);
-	return reload_image(tmp_path, image_to);
+	return reload_firmware_image(tmp_path, image_to);
 }
 
 /*
@@ -212,7 +212,7 @@ static int quirk_daisy_snow_dual_model(struct updater_config *cfg)
 		cfg->image.rw_version_a = strdup(cfg->image.rw_version_b);
 		/* Need to use RO from current system. */
 		if (!cfg->image_current.data &&
-		    load_system_image(cfg, &cfg->image_current) != 0) {
+		    load_system_firmware(cfg, &cfg->image_current) != 0) {
 			ERROR("Cannot get system RO contents");
 			return -1;
 		}
@@ -234,7 +234,7 @@ static const char *extract_cbfs_file(struct updater_config *cfg,
 				     const char *cbfs_region,
 				     const char *cbfs_name)
 {
-	const char *output = create_temp_file(cfg);
+	const char *output = updater_create_temp_file(cfg);
 	char *command, *result;
 
 	ASPRINTF(&command, "cbfstool \"%s\" extract -r %s -n \"%s\" "
@@ -263,7 +263,7 @@ static const char *extract_cbfs_file(struct updater_config *cfg,
 static int quirk_eve_smm_store(struct updater_config *cfg)
 {
 	const char *smm_store_name = "smm store";
-	const char *temp_image = create_temp_file(cfg);
+	const char *temp_image = updater_create_temp_file(cfg);
 	const char *old_store;
 	char *command;
 
@@ -292,7 +292,7 @@ static int quirk_eve_smm_store(struct updater_config *cfg)
 	host_shell(command);
 	free(command);
 
-	return reload_image(temp_image, &cfg->image);
+	return reload_firmware_image(temp_image, &cfg->image);
 }
 
 /*