rmodule: allow rmodule header structure to be used by userland

In order for userland to create rmodules the common code should be
shareable.  Therefore, convert the short u<width> name types to the
posix uint<width>_t types. Additionally, move the definition of the
header structure to a new rmodule-defs.h header file so that userland
can include that without pulling in the coreboot state.

Change-Id: I54acd3bfd8c207b9efd50a3b6d89efd5fcbfc1d9
Signed-off-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-on: http://review.coreboot.org/5363
Tested-by: build bot (Jenkins)
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>

1 files changed, 87 insertions, 0 deletions

diff --git a/src/include/rmodule-defs.h b/src/include/rmodule-defs.h
new file mode 100644
index 0000000000..ee2d3f7bdd
--- /dev/null
+++ b/src/include/rmodule-defs.h
@@ -0,0 +1,87 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (C) 2014 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 RMODULE_DEFS_H
+#define RMODULE_DEFS_H
+
+#include <stdint.h>
+#include <stddef.h>
+
+#define RMODULE_MAGIC 0xf8fe
+#define RMODULE_VERSION_1 1
+
+#define FIELD_ENTRY(x_) ((uint32_t)&x_)
+#define RMODULE_HEADER(entry_, type_)					\
+{									\
+	.magic = RMODULE_MAGIC,						\
+	.version = RMODULE_VERSION_1,					\
+	.type = type_,							\
+	.payload_begin_offset = FIELD_ENTRY(_payload_begin_offset),	\
+	.payload_end_offset = FIELD_ENTRY(_payload_end_offset),		\
+	.relocations_begin_offset  =					\
+		FIELD_ENTRY(_relocations_begin_offset),			\
+	.relocations_end_offset =					\
+		FIELD_ENTRY(_relocations_end_offset),			\
+	.module_link_start_address =					\
+		FIELD_ENTRY(_module_link_start_addr),			\
+	.module_program_size = FIELD_ENTRY(_module_program_size),	\
+	.module_entry_point = FIELD_ENTRY(entry_),			\
+	.parameters_begin = FIELD_ENTRY(_module_params_begin),		\
+	.parameters_end = FIELD_ENTRY(_module_params_end),		\
+	.bss_begin = FIELD_ENTRY(_bss),					\
+	.bss_end = FIELD_ENTRY(_ebss),					\
+}
+
+/* Private data structures below should not be used directly. */
+
+/* All fields with '_offset' in the name are byte offsets into the flat blob.
+ * The linker and the linker script takes are of assigning the values.  */
+struct rmodule_header {
+	uint16_t magic;
+	uint8_t  version;
+	uint8_t  type;
+	/* The payload represents the program's loadable code and data. */
+	uint32_t payload_begin_offset;
+	uint32_t payload_end_offset;
+	/* Begin and of relocation information about the program module. */
+	uint32_t relocations_begin_offset;
+	uint32_t relocations_end_offset;
+	/* The starting address of the linked program. This address is vital
+	 * for determining relocation offsets as the relocation info and other
+	 * symbols (bss, entry point) need this value as a basis to calculate
+	 * the offsets.
+	 */
+	uint32_t module_link_start_address;
+	/* The module_program_size is the size of memory used while running
+	 * the program. The program is assumed to consume a contiguous amount
+	 * of memory. */
+	uint32_t module_program_size;
+	/* This is program's execution entry point. */
+	uint32_t module_entry_point;
+	/* Optional parameter structure that can be used to pass data into
+	 * the module. */
+	uint32_t parameters_begin;
+	uint32_t parameters_end;
+	/* BSS section information so the loader can clear the bss. */
+	uint32_t bss_begin;
+	uint32_t bss_end;
+	/* Add some room for growth. */
+	uint32_t padding[4];
+} __attribute__ ((packed));
+
+#endif /* RMODULE_DEFS_H */