program loading: introduce struct prog

The struct prog serves as way to consolidate program
loading. This abstraction can be used to perform more
complicated execution paths such as running a program
on a separate CPU after it has been loaded. Currently
t124 and t132 need to do that in the boot path. Follow
on patches will allow the platform to decide how to
execute a particular program.

Note: the vboot path is largely untouched because it's
already broken in the coreboot.org tree. After getting
all the necessary patches pushed then vboot will be
fixed.

Change-Id: Ic6e6fe28c5660fb41edee5fd8661eaf58222f883
Signed-off-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-on: http://review.coreboot.org/8839
Tested-by: build bot (Jenkins)
Tested-by: Raptor Engineering Automated Test Stand <noreply@raptorengineeringinc.com>
Reviewed-by: Marc Jones <marc.jones@se-eng.com>

5 files changed, 48 insertions, 63 deletions

diff --git a/src/lib/loaders/cbfs_payload_loader.c b/src/lib/loaders/cbfs_payload_loader.c
index 22f4c2fcd6..609d1232e1 100644
--- a/src/lib/loaders/cbfs_payload_loader.c
+++ b/src/lib/loaders/cbfs_payload_loader.c
@@ -26,14 +26,13 @@ static int cbfs_locate_payload(struct payload *payload)
 	size_t size;
 	const int type = CBFS_TYPE_PAYLOAD;
 
-	buffer = cbfs_get_file_content(CBFS_DEFAULT_MEDIA, payload->name,
+	buffer = cbfs_get_file_content(CBFS_DEFAULT_MEDIA, payload->prog.name,
 					type, &size);
 
 	if (buffer == NULL)
 		return -1;
 
-	payload->backing_store.data = buffer;
-	payload->backing_store.size = size;
+	prog_set_area(&payload->prog, buffer, size);
 
 	return 0;
 }
diff --git a/src/lib/loaders/cbfs_ramstage_loader.c b/src/lib/loaders/cbfs_ramstage_loader.c
index 5155aea511..27be88ef7a 100644
--- a/src/lib/loaders/cbfs_ramstage_loader.c
+++ b/src/lib/loaders/cbfs_ramstage_loader.c
@@ -19,44 +19,37 @@
  */
 #include <console/console.h>
 #include <cbfs.h>
-#include <arch/stages.h>
 #include <program_loading.h>
-#include <timestamp.h>
 
 #if CONFIG_RELOCATABLE_RAMSTAGE
 #include <rmodule.h>
+#include <cbmem.h>
 
-static void *cbfs_load_ramstage(uint32_t cbmem_id, const char *name,
-				const struct cbmem_entry **cbmem_entry)
+static int cbfs_load_ramstage(struct prog *ramstage)
 {
 	struct rmod_stage_load rmod_ram = {
-		.cbmem_id = cbmem_id,
-		.name = name,
+		.cbmem_id = CBMEM_ID_RAMSTAGE,
+		.name = ramstage->name,
 	};
 
 	if (rmodule_stage_load_from_cbfs(&rmod_ram)) {
 		printk(BIOS_DEBUG, "Could not load ramstage.\n");
-		return NULL;
+		return -1;
 	}
 
-	*cbmem_entry = rmod_ram.cbmem_entry;
+	prog_set_area(ramstage, cbmem_entry_start(rmod_ram.cbmem_entry),
+			cbmem_entry_size(rmod_ram.cbmem_entry));
+	prog_set_entry(ramstage, rmod_ram.entry, NULL);
 
-	return rmod_ram.entry;
+	return 0;
 }
 
 #else /* CONFIG_RELOCATABLE_RAMSTAGE */
 
-static void *cbfs_load_ramstage(uint32_t cbmem_id, const char *name,
-				const struct cbmem_entry **cbmem_entry)
+static int cbfs_load_ramstage(struct prog *ramstage)
 {
-	void *entry;
+	return cbfs_load_prog_stage(CBFS_DEFAULT_MEDIA, ramstage);
 
-	entry = cbfs_load_stage(CBFS_DEFAULT_MEDIA, name);
-
-	if ((void *)entry == (void *) -1)
-		entry = NULL;
-
-	return entry;
 }
 
 #endif /* CONFIG_RELOCATABLE_RAMSTAGE */
diff --git a/src/lib/loaders/load_and_run_payload.c b/src/lib/loaders/load_and_run_payload.c
index 89b6da61f3..8e745c9b3b 100644
--- a/src/lib/loaders/load_and_run_payload.c
+++ b/src/lib/loaders/load_and_run_payload.c
@@ -19,6 +19,7 @@
 
 #include <stdint.h>
 #include <stdlib.h>
+#include <cbmem.h>
 #include <console/console.h>
 #include <fallback.h>
 #include <lib.h>
@@ -36,7 +37,10 @@ static const struct payload_loader_ops *payload_ops[] = {
 };
 
 static struct payload global_payload = {
-	.name = CONFIG_CBFS_PREFIX "/payload",
+	.prog = {
+		.name = CONFIG_CBFS_PREFIX "/payload",
+		.type = PROG_PAYLOAD,
+	},
 };
 
 void __attribute__((weak)) mirror_payload(struct payload *payload)
@@ -47,9 +51,9 @@ void __attribute__((weak)) mirror_payload(struct payload *payload)
 void payload_load(void)
 {
 	int i;
-	void *entry;
 	const struct payload_loader_ops *ops;
 	struct payload *payload = &global_payload;
+	struct prog * prog = &payload->prog;
 
 	for (i = 0; i < ARRAY_SIZE(payload_ops); i++) {
 		ops = payload_ops[i];
@@ -59,8 +63,7 @@ void payload_load(void)
 			continue;
 		}
 		printk(BIOS_DEBUG, "%s: located payload @ %p, %zu bytes.\n",
-			ops->name, payload->backing_store.data,
-			payload->backing_store.size);
+			ops->name, prog_start(prog), prog_size(prog));
 		break;
 	}
 
@@ -69,12 +72,12 @@ void payload_load(void)
 
 	mirror_payload(payload);
 
-	entry = selfload(payload);
-
-	payload->entry = entry;
+	/* Pass cbtables to payload if architecture desires it. */
+	prog_set_entry(&payload->prog, selfload(payload),
+			cbmem_find(CBMEM_ID_CBTABLE));
 
 out:
-	if (payload->entry == NULL)
+	if (prog_entry(&payload->prog) == NULL)
 		die("Payload not loaded.\n");
 }
 
@@ -85,7 +88,8 @@ void payload_run(void)
 	/* Reset to booting from this image as late as possible */
 	boot_successful();
 
-	printk(BIOS_DEBUG, "Jumping to boot code at %p\n", payload->entry);
+	printk(BIOS_DEBUG, "Jumping to boot code at %p(%p)\n",
+		prog_entry(&payload->prog), prog_entry_arg(&payload->prog));
 	post_code(POST_ENTER_ELF_BOOT);
 
 	timestamp_add_now(TS_SELFBOOT_JUMP);
diff --git a/src/lib/loaders/load_and_run_ramstage.c b/src/lib/loaders/load_and_run_ramstage.c
index b24e29fc2d..82bc1e08fd 100644
--- a/src/lib/loaders/load_and_run_ramstage.c
+++ b/src/lib/loaders/load_and_run_ramstage.c
@@ -21,7 +21,6 @@
 #include <console/console.h>
 #include <arch/stages.h>
 #include <cbfs.h>
-#include <cbmem.h>
 #include <program_loading.h>
 #include <romstage_handoff.h>
 #include <timestamp.h>
@@ -36,46 +35,32 @@ static const struct ramstage_loader_ops *loaders[] = {
 	&cbfs_ramstage_loader,
 };
 
-static const char *ramstage_name = CONFIG_CBFS_PREFIX "/ramstage";
-static const uint32_t ramstage_id = CBMEM_ID_RAMSTAGE;
-
 static void
-load_ramstage(const struct ramstage_loader_ops *ops, struct romstage_handoff *handoff)
+load_ramstage(const struct ramstage_loader_ops *ops,
+		struct romstage_handoff *handoff, struct prog *ramstage)
 {
-	const struct cbmem_entry *cbmem_entry;
-	void *entry_point;
-
 	timestamp_add_now(TS_START_COPYRAM);
-	entry_point = ops->load(ramstage_id, ramstage_name, &cbmem_entry);
 
-	if (entry_point == NULL)
+	if (ops->load(ramstage))
 		return;
 
-	cache_loaded_ramstage(handoff, cbmem_entry, entry_point);
+	cache_loaded_ramstage(handoff, ramstage);
 
 	timestamp_add_now(TS_END_COPYRAM);
 
-	stage_exit(entry_point);
+	stage_exit(prog_entry(ramstage));
 }
 
-static void run_ramstage_from_resume(struct romstage_handoff *handoff)
+static void run_ramstage_from_resume(struct romstage_handoff *handoff,
+					struct prog *ramstage)
 {
-	void *entry;
-	const struct cbmem_entry *cbmem_entry;
-
 	if (handoff != NULL && handoff->s3_resume) {
-		cbmem_entry = cbmem_entry_find(ramstage_id);
-
-		/* No place to load ramstage. */
-		if (cbmem_entry == NULL)
-			return;
-
 		/* Load the cached ramstage to runtime location. */
-		entry = load_cached_ramstage(handoff, cbmem_entry);
+		load_cached_ramstage(handoff, ramstage);
 
-		if (entry != NULL) {
+		if (prog_entry(ramstage) != NULL) {
 			printk(BIOS_DEBUG, "Jumping to image.\n");
-			stage_exit(entry);
+			stage_exit(prog_entry(ramstage));
 		}
 	}
 }
@@ -85,15 +70,19 @@ void run_ramstage(void)
 	struct romstage_handoff *handoff;
 	const struct ramstage_loader_ops *ops;
 	int i;
+	struct prog ramstage = {
+		.name = CONFIG_CBFS_PREFIX "/ramstage",
+		.type = PROG_RAMSTAGE,
+	};
 
 	handoff = romstage_handoff_find_or_add();
 
-	run_ramstage_from_resume(handoff);
+	run_ramstage_from_resume(handoff, &ramstage);
 
 	for (i = 0; i < ARRAY_SIZE(loaders); i++) {
 		ops = loaders[i];
 		printk(BIOS_DEBUG, "Trying %s ramstage loader.\n", ops->name);
-		load_ramstage(ops, handoff);
+		load_ramstage(ops, handoff, &ramstage);
 	}
 
 	die("Ramstage was not loaded!\n");
diff --git a/src/lib/loaders/load_and_run_romstage.c b/src/lib/loaders/load_and_run_romstage.c
index ebc1243594..3ad9176877 100644
--- a/src/lib/loaders/load_and_run_romstage.c
+++ b/src/lib/loaders/load_and_run_romstage.c
@@ -27,16 +27,16 @@
 
 void run_romstage(void)
 {
-	void *entry;
+	struct prog romstage = {
+		.name = CONFIG_CBFS_PREFIX "/romstage",
+		.type = PROG_ROMSTAGE,
+	};
 
-	entry = cbfs_load_stage(CBFS_DEFAULT_MEDIA,
-				CONFIG_CBFS_PREFIX "/romstage");
-
-	if (entry == (void *)-1) {
+	if (cbfs_load_prog_stage(CBFS_DEFAULT_MEDIA, &romstage) < 0) {
 		if (IS_ENABLED(CONFIG_BOOTBLOCK_CONSOLE))
 			die("Couldn't load romstage.\n");
 		halt();
 	}
 
-	stage_exit(entry);
+	stage_exit(prog_entry(&romstage));
 }