899d13d0df
A new CBFS API is introduced to allow making CBFS access easier for providing multiple CBFS sources. That is achieved by decoupling the cbfs source from a CBFS file. A CBFS source is described by a descriptor. It contains the necessary properties for walking a CBFS to locate a file. The CBFS file is then decoupled from the CBFS descriptor in that it's no longer needed to access the contents of the file. All of this is accomplished using the regions infrastructure by repsenting CBFS sources and files as region_devices. Because region_devices can be chained together forming subregions this allows one to decouple a CBFS source from a file. This also allows one to provide CBFS files that came from other sources for payload and/or stage loading. The program loading takes advantage of those very properties by allowing multiple sources for locating a program. Because of this we can reduce the overhead of loading programs because it's all done in the common code paths. Only locating the program is per source. Change-Id: I339b84fce95f03d1dbb63a0f54a26be5eb07f7c8 Signed-off-by: Aaron Durbin <adurbin@chromium.org> Reviewed-on: http://review.coreboot.org/9134 Tested-by: build bot (Jenkins) Tested-by: Raptor Engineering Automated Test Stand <noreply@raptorengineeringinc.com> Reviewed-by: Patrick Georgi <pgeorgi@google.com>
83 lines
2.7 KiB
C
83 lines
2.7 KiB
C
/*
|
|
* This file is part of the coreboot project.
|
|
*
|
|
* Copyright (C) 2012 ChromeOS Authors
|
|
*
|
|
* 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.
|
|
*/
|
|
#ifndef RMODULE_H
|
|
#define RMODULE_H
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
#include <string.h>
|
|
#include <rmodule-defs.h>
|
|
|
|
enum {
|
|
RMODULE_TYPE_SMM,
|
|
RMODULE_TYPE_SIPI_VECTOR,
|
|
RMODULE_TYPE_STAGE,
|
|
RMODULE_TYPE_VBOOT,
|
|
};
|
|
|
|
struct rmodule;
|
|
|
|
/* Public API for loading rmdoules. */
|
|
int rmodule_parse(void *ptr, struct rmodule *m);
|
|
void *rmodule_parameters(const struct rmodule *m);
|
|
void *rmodule_entry(const struct rmodule *m);
|
|
int rmodule_entry_offset(const struct rmodule *m);
|
|
int rmodule_memory_size(const struct rmodule *m);
|
|
int rmodule_load(void *loc, struct rmodule *m);
|
|
int rmodule_load_alignment(const struct rmodule *m);
|
|
/* rmodule_calc_region() calculates the region size, offset to place an
|
|
* rmodule in memory, and load address offset based off of a region allocator
|
|
* with an alignment of region_alignment. This function helps place an rmodule
|
|
* in the same location in ram it will run from. The offset to place the
|
|
* rmodule into the region allocated of size region_size is returned. The
|
|
* load_offset is the address to load and relocate the rmodule.
|
|
* region_alignment must be a power of 2. */
|
|
int rmodule_calc_region(unsigned int region_alignment, size_t rmodule_size,
|
|
size_t *region_size, int *load_offset);
|
|
|
|
/* Support for loading rmodule stages. This API is only available when
|
|
* using dynamic cbmem because it uses the dynamic cbmem API to obtain
|
|
* the backing store region for the stage. */
|
|
struct prog;
|
|
|
|
struct rmod_stage_load {
|
|
uint32_t cbmem_id;
|
|
struct prog *prog;
|
|
};
|
|
|
|
/* Both of the following functions return 0 on success, -1 on error. */
|
|
int rmodule_stage_load(struct rmod_stage_load *rsl);
|
|
|
|
struct rmodule {
|
|
void *location;
|
|
struct rmodule_header *header;
|
|
const void *payload;
|
|
int payload_size;
|
|
void *relocations;
|
|
};
|
|
|
|
#if IS_ENABLED(CONFIG_RELOCATABLE_MODULES)
|
|
/* Rmodules have an entry point of named __rmodule_entry. */
|
|
#define RMODULE_ENTRY(entry_) \
|
|
void __rmodule_entry(void *) __attribute__((alias (STRINGIFY(entry_))))
|
|
#else
|
|
#define RMODULE_ENTRY(entry_)
|
|
#endif
|
|
|
|
#endif /* RMODULE_H */
|