loaders: add program_loading.h header file

Instead of two headers for payload and ramstage loading
combine the 2 files into one. This also allows for easier
refactoring by keeping header files consistent.

Change-Id: I4a6dffb78ad84c78e6e96c886d361413f9b4a17d
Signed-off-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-on: http://review.coreboot.org/8708
Tested-by: build bot (Jenkins)
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>

1 files changed, 87 insertions, 0 deletions

diff --git a/src/include/program_loading.h b/src/include/program_loading.h
new file mode 100644
index 0000000000..8ceebc12d4
--- /dev/null
+++ b/src/include/program_loading.h
@@ -0,0 +1,87 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright 2015 Google Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+#ifndef PROGRAM_LOADING_H
+#define PROGRAM_LOADING_H
+
+#include <stdint.h>
+#include <stddef.h>
+
+
+/************************
+ *   RAMSTAGE LOADING   *
+ ************************/
+
+struct cbmem_entry;
+
+/* Run ramstage from romstage. */
+void run_ramstage(void);
+
+struct ramstage_loader_ops {
+	const char *name;
+	void *(*load)(uint32_t cbmem_id, const char *name,
+			const struct cbmem_entry **cbmem_entry);
+};
+
+/***********************
+ *   PAYLOAD LOADING   *
+ ***********************/
+
+struct buffer_area {
+	void *data;
+	size_t size;
+};
+
+struct payload {
+	const char *name;
+	struct buffer_area backing_store;
+	/* Used when payload wants memory coreboot ramstage is running at. */
+	struct buffer_area bounce;
+	void *entry;
+};
+
+/*
+ * Load payload into memory and return pointer to payload structure. Returns
+ * NULL on error.
+ */
+struct payload *payload_load(void);
+
+/* Run the loaded payload. */
+void payload_run(const struct payload *payload);
+
+/* Mirror the payload to be loaded. */
+void mirror_payload(struct payload *payload);
+
+/* architecture specific function to run payload. */
+void arch_payload_run(const struct payload *payload);
+
+/* Payload loading operations. */
+struct payload_loader_ops {
+	const char *name;
+	/*
+	 * Fill in payload_backing_store structure.  Return 0 on success, < 0
+	 * on failure.
+	 */
+	int (*locate)(struct payload *payload);
+};
+
+/* Defined in src/lib/selfboot.c */
+void *selfload(struct payload *payload);
+
+
+#endif /* PROGRAM_LOADING_H */