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>
This commit is contained in:
parent
62a3f6f665
commit
4e6ad1bcaf
|
@ -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 */
|
|
@ -21,9 +21,7 @@
|
||||||
|
|
||||||
#include <stdint.h>
|
#include <stdint.h>
|
||||||
#include <stddef.h>
|
#include <stddef.h>
|
||||||
|
#include <rmodule-defs.h>
|
||||||
#define RMODULE_MAGIC 0xf8fe
|
|
||||||
#define RMODULE_VERSION_1 1
|
|
||||||
|
|
||||||
enum {
|
enum {
|
||||||
RMODULE_TYPE_SMM,
|
RMODULE_TYPE_SMM,
|
||||||
|
@ -52,28 +50,6 @@ int rmodule_load_alignment(const struct rmodule *m);
|
||||||
int rmodule_calc_region(unsigned int region_alignment, size_t rmodule_size,
|
int rmodule_calc_region(unsigned int region_alignment, size_t rmodule_size,
|
||||||
size_t *region_size, int *load_offset);
|
size_t *region_size, int *load_offset);
|
||||||
|
|
||||||
#define FIELD_ENTRY(x_) ((u32)&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), \
|
|
||||||
}
|
|
||||||
|
|
||||||
#define DEFINE_RMODULE_HEADER(name_, entry_, type_) \
|
#define DEFINE_RMODULE_HEADER(name_, entry_, type_) \
|
||||||
struct rmodule_header name_ \
|
struct rmodule_header name_ \
|
||||||
__attribute__ ((section (".module_header"))) = \
|
__attribute__ ((section (".module_header"))) = \
|
||||||
|
@ -100,43 +76,6 @@ int rmodule_stage_load(struct rmod_stage_load *rsl, struct cbfs_stage *stage);
|
||||||
int rmodule_stage_load_from_cbfs(struct rmod_stage_load *rsl);
|
int rmodule_stage_load_from_cbfs(struct rmod_stage_load *rsl);
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/* 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 {
|
|
||||||
u16 magic;
|
|
||||||
u8 version;
|
|
||||||
u8 type;
|
|
||||||
/* The payload represents the program's loadable code and data. */
|
|
||||||
u32 payload_begin_offset;
|
|
||||||
u32 payload_end_offset;
|
|
||||||
/* Begin and of relocation information about the program module. */
|
|
||||||
u32 relocations_begin_offset;
|
|
||||||
u32 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.
|
|
||||||
*/
|
|
||||||
u32 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. */
|
|
||||||
u32 module_program_size;
|
|
||||||
/* This is program's execution entry point. */
|
|
||||||
u32 module_entry_point;
|
|
||||||
/* Optional parameter structure that can be used to pass data into
|
|
||||||
* the module. */
|
|
||||||
u32 parameters_begin;
|
|
||||||
u32 parameters_end;
|
|
||||||
/* BSS section information so the loader can clear the bss. */
|
|
||||||
u32 bss_begin;
|
|
||||||
u32 bss_end;
|
|
||||||
/* Add some room for growth. */
|
|
||||||
u32 padding[4];
|
|
||||||
} __attribute__ ((packed));
|
|
||||||
|
|
||||||
struct rmodule {
|
struct rmodule {
|
||||||
void *location;
|
void *location;
|
||||||
struct rmodule_header *header;
|
struct rmodule_header *header;
|
||||||
|
|
|
@ -34,8 +34,8 @@
|
||||||
* locations.
|
* locations.
|
||||||
*/
|
*/
|
||||||
typedef struct {
|
typedef struct {
|
||||||
u32 r_offset;
|
uint32_t r_offset;
|
||||||
u32 r_info;
|
uint32_t r_info;
|
||||||
} Elf32_Rel;
|
} Elf32_Rel;
|
||||||
|
|
||||||
#define R_386_RELATIVE 8
|
#define R_386_RELATIVE 8
|
||||||
|
@ -71,7 +71,7 @@ static inline int rmodule_is_loaded(const struct rmodule *module)
|
||||||
|
|
||||||
/* Calculate a loaded program address based on the blob address. */
|
/* Calculate a loaded program address based on the blob address. */
|
||||||
static inline void *rmodule_load_addr(const struct rmodule *module,
|
static inline void *rmodule_load_addr(const struct rmodule *module,
|
||||||
u32 blob_addr)
|
uint32_t blob_addr)
|
||||||
{
|
{
|
||||||
char *loc = module->location;
|
char *loc = module->location;
|
||||||
return &loc[blob_addr - module->header->module_link_start_address];
|
return &loc[blob_addr - module->header->module_link_start_address];
|
||||||
|
@ -176,7 +176,7 @@ static void rmodule_copy_payload(const struct rmodule *module)
|
||||||
memcpy(module->location, module->payload, module->payload_size);
|
memcpy(module->location, module->payload, module->payload_size);
|
||||||
}
|
}
|
||||||
|
|
||||||
static inline u32 *rmodule_adjustment_location(const struct rmodule *module,
|
static inline uint32_t *rmodule_adjustment_location(const struct rmodule *module,
|
||||||
const void *reloc)
|
const void *reloc)
|
||||||
{
|
{
|
||||||
int reloc_offset;
|
int reloc_offset;
|
||||||
|
@ -193,11 +193,11 @@ static int rmodule_relocate(const struct rmodule *module)
|
||||||
{
|
{
|
||||||
int num_relocations;
|
int num_relocations;
|
||||||
const void *reloc;
|
const void *reloc;
|
||||||
u32 adjustment;
|
uint32_t adjustment;
|
||||||
|
|
||||||
/* Each relocation needs to be adjusted relative to the beginning of
|
/* Each relocation needs to be adjusted relative to the beginning of
|
||||||
* the loaded program. */
|
* the loaded program. */
|
||||||
adjustment = (u32)rmodule_load_addr(module, 0);
|
adjustment = (uint32_t)rmodule_load_addr(module, 0);
|
||||||
|
|
||||||
reloc = module->relocations;
|
reloc = module->relocations;
|
||||||
num_relocations = rmodule_number_relocations(module);
|
num_relocations = rmodule_number_relocations(module);
|
||||||
|
@ -206,7 +206,7 @@ static int rmodule_relocate(const struct rmodule *module)
|
||||||
num_relocations, adjustment);
|
num_relocations, adjustment);
|
||||||
|
|
||||||
while (num_relocations > 0) {
|
while (num_relocations > 0) {
|
||||||
u32 *adjust_loc;
|
uint32_t *adjust_loc;
|
||||||
|
|
||||||
if (!rmodule_reloc_valid(reloc))
|
if (!rmodule_reloc_valid(reloc))
|
||||||
return -1;
|
return -1;
|
||||||
|
|
Loading…
Reference in New Issue