173 lines
4.7 KiB
C
173 lines
4.7 KiB
C
/*
|
|
* This file is part of the coreboot project.
|
|
*
|
|
* Copyright 2015 Google Inc.
|
|
* Copyright (C) 2014 Imagination Technologies
|
|
*
|
|
* 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 PROGRAM_LOADING_H
|
|
#define PROGRAM_LOADING_H
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
#include <assets.h>
|
|
|
|
enum {
|
|
/* Last segment of program. Can be used to take different actions for
|
|
* cache maintenance of a program load. */
|
|
SEG_FINAL = 1 << 0,
|
|
};
|
|
|
|
/* Called for each segment of a program loaded. The SEG_FINAL flag will be
|
|
* set on the last segment loaded. */
|
|
void arch_segment_loaded(uintptr_t start, size_t size, int flags);
|
|
|
|
/* Representation of a program. */
|
|
struct prog {
|
|
/* The region_device within the asset is the source of program content
|
|
* to load. After loading program it represents the memory region of
|
|
* the stages and payload. For architectures that use a bounce buffer
|
|
* then it would represent the bounce buffer. */
|
|
struct asset asset;
|
|
/* Entry to program with optional argument. It's up to the architecture
|
|
* to decide if argument is passed. */
|
|
void (*entry)(void *);
|
|
void *arg;
|
|
};
|
|
|
|
#define PROG_INIT(type_, name_) \
|
|
{ \
|
|
.asset = ASSET_INIT(type_, name_), \
|
|
}
|
|
|
|
static inline const char *prog_name(const struct prog *prog)
|
|
{
|
|
return asset_name(&prog->asset);
|
|
}
|
|
|
|
static inline enum asset_type prog_type(const struct prog *prog)
|
|
{
|
|
return asset_type(&prog->asset);
|
|
}
|
|
|
|
static inline struct region_device *prog_rdev(struct prog *prog)
|
|
{
|
|
return asset_rdev(&prog->asset);
|
|
}
|
|
|
|
/* Only valid for loaded programs. */
|
|
static inline size_t prog_size(const struct prog *prog)
|
|
{
|
|
return asset_size(&prog->asset);
|
|
}
|
|
|
|
/* Only valid for loaded programs. */
|
|
static inline void *prog_start(const struct prog *prog)
|
|
{
|
|
return asset_mmap(&prog->asset);
|
|
}
|
|
|
|
static inline void *prog_entry(const struct prog *prog)
|
|
{
|
|
return prog->entry;
|
|
}
|
|
|
|
static inline void *prog_entry_arg(const struct prog *prog)
|
|
{
|
|
return prog->arg;
|
|
}
|
|
|
|
/* region_device representing the 32-bit flat address space. */
|
|
extern const struct mem_region_device addrspace_32bit;
|
|
|
|
static inline void prog_memory_init(struct prog *prog, uintptr_t ptr,
|
|
size_t size)
|
|
{
|
|
rdev_chain(&prog->asset.rdev, &addrspace_32bit.rdev, ptr, size);
|
|
}
|
|
|
|
static inline void prog_set_area(struct prog *prog, void *start, size_t size)
|
|
{
|
|
prog_memory_init(prog, (uintptr_t)start, size);
|
|
}
|
|
|
|
static inline void prog_set_entry(struct prog *prog, void *e, void *arg)
|
|
{
|
|
prog->entry = e;
|
|
prog->arg = arg;
|
|
}
|
|
|
|
/* Locate the identified program to run. Return 0 on success. < 0 on error. */
|
|
static inline int prog_locate(struct prog *prog)
|
|
{
|
|
return asset_locate(&prog->asset);
|
|
}
|
|
|
|
/* 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);
|
|
|
|
struct prog_loader_ops {
|
|
const char *name;
|
|
/* Determine if the loader is the active one. If so returns 1 else 0
|
|
* or < 0 on error. */
|
|
int (*is_loader_active)(struct prog *prog);
|
|
/* Returns < 0 on error or 0 on success. This function locates
|
|
* the rdev representing the file data associated with the passed in
|
|
* prog. */
|
|
int (*locate)(struct prog *prog);
|
|
};
|
|
|
|
/************************
|
|
* ROMSTAGE LOADING *
|
|
************************/
|
|
|
|
/* Run romstage from bootblock. */
|
|
void run_romstage(void);
|
|
|
|
/************************
|
|
* RAMSTAGE LOADING *
|
|
************************/
|
|
|
|
/* Run ramstage from romstage. */
|
|
void run_ramstage(void);
|
|
|
|
/* Called when the stage cache couldn't load ramstage on resume. */
|
|
void ramstage_cache_invalid(void);
|
|
|
|
/***********************
|
|
* PAYLOAD LOADING *
|
|
***********************/
|
|
|
|
/* Load payload into memory in preparation to run. */
|
|
void payload_load(void);
|
|
|
|
/* Run the loaded payload. */
|
|
void payload_run(void);
|
|
|
|
/* Mirror the payload to be loaded. */
|
|
void mirror_payload(struct prog *payload);
|
|
|
|
/* Defined in src/lib/selfboot.c */
|
|
void *selfload(struct prog *payload);
|
|
|
|
#endif /* PROGRAM_LOADING_H */
|