program loading: add prog_run() function

The prog_run() function abstracts away what is required
for running a given program. Within it, there are 2
calls: 1. platform_prog_run() and 2. arch_prog_run().
The platform_prog_run() allows for a chipset to intercept
a program that will be run. This allows for CPU switching
as currently needed in t124 and t132.

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

15 files changed, 95 insertions, 22 deletions

diff --git a/src/arch/arm/Makefile.inc b/src/arch/arm/Makefile.inc
index e739d0b8d5..ffbc8413a7 100644
--- a/src/arch/arm/Makefile.inc
+++ b/src/arch/arm/Makefile.inc
@@ -54,6 +54,7 @@ ifeq ($(CONFIG_ARCH_BOOTBLOCK_ARM),y)
 bootblock-y += id.S
 $(obj)/arch/arm/id.bootblock.o: $(obj)/build.h
 
+bootblock-y += boot.c
 bootblock-y += stages.c
 bootblock-y += eabi_compat.c
 bootblock-y += memset.S
@@ -89,6 +90,7 @@ verstage-y += stages.c
 
 ifeq ($(CONFIG_ARCH_ROMSTAGE_ARM),y)
 
+romstage-y += boot.c
 romstage-y += stages.c
 romstage-y += div0.c
 romstage-y += eabi_compat.c
diff --git a/src/arch/arm/boot.c b/src/arch/arm/boot.c
index 9dc6dbd3cf..6a2934b86e 100644
--- a/src/arch/arm/boot.c
+++ b/src/arch/arm/boot.c
@@ -20,12 +20,17 @@
 #include <arch/cache.h>
 #include <program_loading.h>
 
-void arch_payload_run(const struct payload *payload)
+void arch_prog_run(struct prog *prog)
 {
 	void (*doit)(void *);
 
 	cache_sync_instructions();
 
-	doit = prog_entry(&payload->prog);
-	doit(prog_entry_arg(&payload->prog));
+	doit = prog_entry(prog);
+	doit(prog_entry_arg(prog));
+}
+
+void arch_payload_run(struct payload *payload)
+{
+	arch_prog_run(&payload->prog);
 }
diff --git a/src/arch/arm64/Makefile.inc b/src/arch/arm64/Makefile.inc
index 6d23dab561..c1f1112280 100644
--- a/src/arch/arm64/Makefile.inc
+++ b/src/arch/arm64/Makefile.inc
@@ -57,6 +57,7 @@ bootblock-y += div0.c
 bootblock-y += id.S
 $(obj)/arch/arm64/id.bootblock.o: $(obj)/build.h
 
+bootblock-y += boot.c
 bootblock-y += c_entry.c
 bootblock-y += stage_entry.S
 bootblock-y += stages.c
@@ -81,6 +82,7 @@ endif # CONFIG_ARCH_BOOTBLOCK_ARM64
 
 ifeq ($(CONFIG_ARCH_ROMSTAGE_ARM64),y)
 
+romstage-y += boot.c
 romstage-y += c_entry.c
 romstage-y += stage_entry.S
 romstage-y += stages.c
diff --git a/src/arch/arm64/boot.c b/src/arch/arm64/boot.c
index 74282a9cde..b5e375193e 100644
--- a/src/arch/arm64/boot.c
+++ b/src/arch/arm64/boot.c
@@ -25,15 +25,16 @@
 #include <arch/transition.h>
 #include <console/console.h>
 #include <program_loading.h>
+#include <rules.h>
 #include <string.h>
 
-void arch_payload_run(const struct payload *payload)
+static void run_payload(struct prog *prog)
 {
 	void (*doit)(void *);
 	void *arg;
 
-	doit = prog_entry(&payload->prog);
-	arg = prog_entry_arg(&payload->prog);
+	doit = prog_entry(prog);
+	arg = prog_entry_arg(prog);
 
 	uint8_t current_el = get_current_el();
 
@@ -61,3 +62,23 @@ void arch_payload_run(const struct payload *payload)
 	cache_sync_instructions();
 	transition_with_entry(doit, arg, &exc_state);
 }
+
+void arch_prog_run(struct prog *prog)
+{
+	void (*doit)(void *);
+	void *arg;
+
+	if (ENV_RAMSTAGE && prog->type == PROG_PAYLOAD)
+		run_payload(prog);
+		return;
+
+	doit = prog_entry(prog);
+	arg = prog_entry_arg(prog);
+
+	doit(prog_entry_arg(prog));
+}
+
+void arch_payload_run(struct payload *payload)
+{
+	arch_prog_run(&payload->prog);
+}
diff --git a/src/arch/mips/boot.c b/src/arch/mips/boot.c
index 6e12d10c71..ebc45bb682 100644
--- a/src/arch/mips/boot.c
+++ b/src/arch/mips/boot.c
@@ -20,7 +20,12 @@
 #include <arch/stages.h>
 #include <program_loading.h>
 
-void arch_payload_run(const struct payload *payload)
+void arch_prog_run(struct prog *prog)
 {
-	stage_exit(prog_entry(&payload->prog));
+	stage_exit(prog_entry(prog));
+}
+
+void arch_payload_run(struct payload *payload)
+{
+	arch_prog_run(&payload->prog);
 }
diff --git a/src/arch/riscv/Makefile.inc b/src/arch/riscv/Makefile.inc
index 242fd404e6..30c84a93e2 100644
--- a/src/arch/riscv/Makefile.inc
+++ b/src/arch/riscv/Makefile.inc
@@ -31,6 +31,7 @@ ifeq ($(CONFIG_ARCH_BOOTBLOCK_RISCV),y)
 bootblock_lds = $(src)/arch/riscv/bootblock.ld
 
 bootblock-y = bootblock.S stages.c
+bootblock-y += boot.c
 bootblock-y += rom_media.c
 bootblock-y += \
 	$(top)/src/lib/memchr.c \
@@ -52,6 +53,7 @@ endif
 ################################################################################
 ifeq ($(CONFIG_ARCH_ROMSTAGE_RISCV),y)
 
+romstage-y += boot.c
 romstage-y += stages.c
 romstage-y += rom_media.c
 romstage-y += \
diff --git a/src/arch/riscv/boot.c b/src/arch/riscv/boot.c
index 4c2be031c2..f66c02ff2e 100644
--- a/src/arch/riscv/boot.c
+++ b/src/arch/riscv/boot.c
@@ -17,11 +17,17 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-#include <arch/stages.h>
 #include <program_loading.h>
 
-void arch_payload_run(const struct payload *payload)
+void arch_prog_run(struct prog *prog)
 {
-//	uart_rx_byte(0);
-	stage_exit(prog_entry(&payload->prog));
+	void (*doit)(void *);
+
+	doit = prog_entry(prog);
+	doit(prog_entry_arg(prog));
+}
+
+void arch_payload_run(struct payload *payload)
+{
+	arch_prog_run(&payload->prog);
 }
diff --git a/src/arch/x86/boot/Makefile.inc b/src/arch/x86/boot/Makefile.inc
index 9f06b4f4eb..7810ba8368 100644
--- a/src/arch/x86/boot/Makefile.inc
+++ b/src/arch/x86/boot/Makefile.inc
@@ -2,6 +2,7 @@
 ifeq ($(CONFIG_ARCH_ROMSTAGE_X86_32),y)
 
 romstage-y += cbmem.c
+romstage-y += boot.c
 
 endif # CONFIG_ARCH_ROMSTAGE_X86_32
 
diff --git a/src/arch/x86/boot/boot.c b/src/arch/x86/boot/boot.c
index 1fb36e2827..d5365842d2 100644
--- a/src/arch/x86/boot/boot.c
+++ b/src/arch/x86/boot/boot.c
@@ -123,7 +123,7 @@ static void jmp_payload(void *entry, unsigned long buffer, unsigned long size)
 		);
 }
 
-void arch_payload_run(const struct payload *payload)
+void arch_payload_run(struct payload *payload)
 {
 	if (IS_ENABLED(CONFIG_RELOCATABLE_RAMSTAGE))
 		jmp_payload_no_bounce_buffer(prog_entry(&payload->prog));
@@ -132,3 +132,11 @@ void arch_payload_run(const struct payload *payload)
 				(uintptr_t)payload->bounce.data,
 				payload->bounce.size);
 }
+
+void arch_prog_run(struct prog *prog)
+{
+	__asm__ volatile (
+		"jmp  *%%edi\n"
+		:: "D"(prog_entry(prog))
+	);
+}
diff --git a/src/include/program_loading.h b/src/include/program_loading.h
index 38047c74dd..1df1825869 100644
--- a/src/include/program_loading.h
+++ b/src/include/program_loading.h
@@ -90,6 +90,16 @@ static inline void prog_set_entry(struct prog *prog, void *e, void *arg)
 	prog->arg = arg;
 }
 
+/* Run the program described by prog. */
+void prog_run(struct prog *prog);
+/* Per architecture implementation running a program. */
+void arch_prog_run(struct prog *prog);
+/* Platform (SoC/chipset) specific overrides for running a program. This is
+ * called prior to calling the arch_prog_run. Thus, if there is anything
+ * special that needs to be done by the platform similar to the architecture
+ * code it needs to that as well. */
+void platform_prog_run(struct prog *prog);
+
 /************************
  *   ROMSTAGE LOADING   *
  ************************/
@@ -143,7 +153,7 @@ void payload_run(void);
 void mirror_payload(struct payload *payload);
 
 /* architecture specific function to run payload. */
-void arch_payload_run(const struct payload *payload);
+void arch_payload_run(struct payload *payload);
 
 /* Payload loading operations. */
 struct payload_loader_ops {
diff --git a/src/lib/Makefile.inc b/src/lib/Makefile.inc
index 67cf577a52..5f149c9cfa 100644
--- a/src/lib/Makefile.inc
+++ b/src/lib/Makefile.inc
@@ -18,7 +18,7 @@
 #
 subdirs-y += loaders
 
-bootblock-y += arch_ops.c
+bootblock-y += prog_ops.c
 bootblock-y += cbfs.c cbfs_core.c
 bootblock-$(CONFIG_COMMON_CBFS_SPI_WRAPPER) += cbfs_spi.c
 
@@ -26,7 +26,7 @@ bootblock-$(CONFIG_CONSOLE_CBMEM) += cbmem_console.c
 bootblock-y += memchr.c
 bootblock-y += memcmp.c
 
-verstage-y += arch_ops.c
+verstage-y += prog_ops.c
 verstage-y += delay.c
 verstage-y += cbfs.c
 verstage-y += memcmp.c
@@ -35,7 +35,7 @@ verstage-$(CONFIG_COMMON_CBFS_SPI_WRAPPER) += cbfs_spi.c
 verstage-y += tlcl.c
 verstage-$(CONFIG_GENERIC_UDELAY) += timer.c
 
-romstage-y += arch_ops.c
+romstage-y += prog_ops.c
 romstage-y += memchr.c
 romstage-y += memcmp.c
 $(foreach arch,$(ARCH_SUPPORTED),\
@@ -60,7 +60,7 @@ romstage-$(CONFIG_ARCH_ROMSTAGE_X86_32) += gcc.c
 ramstage-$(CONFIG_ARCH_RAMSTAGE_X86_32) += gcc.c
 endif
 
-ramstage-y += arch_ops.c
+ramstage-y += prog_ops.c
 ramstage-y += hardwaremain.c
 ramstage-y += selfboot.c
 ramstage-y += coreboot_table.c
diff --git a/src/lib/loaders/load_and_run_payload.c b/src/lib/loaders/load_and_run_payload.c
index 8e745c9b3b..e3208a9feb 100644
--- a/src/lib/loaders/load_and_run_payload.c
+++ b/src/lib/loaders/load_and_run_payload.c
@@ -83,7 +83,7 @@ out:
 
 void payload_run(void)
 {
-	const struct payload *payload = &global_payload;
+	struct payload *payload = &global_payload;
 
 	/* Reset to booting from this image as late as possible */
 	boot_successful();
diff --git a/src/lib/loaders/load_and_run_ramstage.c b/src/lib/loaders/load_and_run_ramstage.c
index 82bc1e08fd..9067a28dc6 100644
--- a/src/lib/loaders/load_and_run_ramstage.c
+++ b/src/lib/loaders/load_and_run_ramstage.c
@@ -48,7 +48,7 @@ load_ramstage(const struct ramstage_loader_ops *ops,
 
 	timestamp_add_now(TS_END_COPYRAM);
 
-	stage_exit(prog_entry(ramstage));
+	prog_run(ramstage);
 }
 
 static void run_ramstage_from_resume(struct romstage_handoff *handoff,
@@ -60,7 +60,7 @@ static void run_ramstage_from_resume(struct romstage_handoff *handoff,
 
 		if (prog_entry(ramstage) != NULL) {
 			printk(BIOS_DEBUG, "Jumping to image.\n");
-			stage_exit(prog_entry(ramstage));
+			prog_run(ramstage);
 		}
 	}
 }
diff --git a/src/lib/loaders/load_and_run_romstage.c b/src/lib/loaders/load_and_run_romstage.c
index 3ad9176877..8467e90129 100644
--- a/src/lib/loaders/load_and_run_romstage.c
+++ b/src/lib/loaders/load_and_run_romstage.c
@@ -38,5 +38,5 @@ void run_romstage(void)
 		halt();
 	}
 
-	stage_exit(prog_entry(&romstage));
+	prog_run(&romstage);
 }
diff --git a/src/lib/arch_ops.c b/src/lib/prog_ops.c
index ac1be77c9e..755b135615 100644
--- a/src/lib/arch_ops.c
+++ b/src/lib/prog_ops.c
@@ -26,3 +26,14 @@ void __attribute__ ((weak)) arch_segment_loaded(uintptr_t start, size_t size,
 {
 	/* do nothing */
 }
+
+void prog_run(struct prog *prog)
+{
+	platform_prog_run(prog);
+	arch_prog_run(prog);
+}
+
+void __attribute__ ((weak)) platform_prog_run(struct prog *prog)
+{
+	/* do nothing */
+}