1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/*
* This file is part of the coreboot project.
*
* Copyright 2015 Google Inc.
* Copyright (C) 2014 Imagination Technologies
* Copyright (C) 2018 Eltan B.V.
*
* 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.
*/
#ifndef PROGRAM_LOADING_H
#define PROGRAM_LOADING_H
#include <bootmem.h>
#include <commonlib/region.h>
#include <stdint.h>
#include <stddef.h>
enum {
/* Last segment of program. Can be used to take different actions for
* cache maintenance of a program load. */
SEG_FINAL = 1 << 0,
};
enum prog_type {
PROG_UNKNOWN,
PROG_BOOTBLOCK,
PROG_VERSTAGE,
PROG_ROMSTAGE,
PROG_RAMSTAGE,
PROG_REFCODE,
PROG_PAYLOAD,
PROG_BL31,
PROG_BL32,
PROG_POSTCAR,
PROG_OPENSBI,
};
/*
* prog_segment_loaded() is called for each segment of a program loaded. The
* SEG_FINAL flag will be set on the last segment loaded. The following two
* functions, platform_segment_loaded() and arch_segment_loaded(), are called
* in that order within prog_segment_loaded(). In short, rely on
* prog_segment_loaded() to perform the proper dispatch sequence.
*/
void prog_segment_loaded(uintptr_t start, size_t size, int flags);
void platform_segment_loaded(uintptr_t start, size_t size, int flags);
void arch_segment_loaded(uintptr_t start, size_t size, int flags);
/* Representation of a program. */
struct prog {
/* The region_device 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. */
enum prog_type type;
uint32_t cbfs_type;
const char *name;
struct region_device rdev;
/* 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_) \
{ \
.type = (type_), \
.name = (name_), \
}
static inline const char *prog_name(const struct prog *prog)
{
return prog->name;
}
static inline enum prog_type prog_type(const struct prog *prog)
{
return prog->type;
}
static inline uint32_t prog_cbfs_type(const struct prog *prog)
{
return prog->cbfs_type;
}
static inline struct region_device *prog_rdev(struct prog *prog)
{
return &prog->rdev;
}
/* Only valid for loaded programs. */
static inline size_t prog_size(const struct prog *prog)
{
return region_device_sz(&prog->rdev);
}
/* Only valid for loaded programs. */
static inline void *prog_start(const struct prog *prog)
{
return rdev_mmap_full(&prog->rdev);
}
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->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;
}
static inline void prog_set_arg(struct prog *prog, void *arg)
{
prog->arg = arg;
}
/* Locate the identified program to run. Return 0 on success. < 0 on error. */
int prog_locate(struct prog *prog);
/* The prog_locate_hook() is called prior to CBFS traversal. The hook can be
* used to implement policy that allows or prohibits further progress through
* prog_locate(). The type and name field within struct prog are the only valid
* fields. A 0 return value allows further progress while a non-zero return
* value prohibits further progress */
int prog_locate_hook(struct prog *prog);
/* 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);
/* Runtime selector for CBFS_PREFIX of romstage. */
int legacy_romstage_selector(struct prog *romstage);
/************************
* RAMSTAGE LOADING *
************************/
/* Run ramstage from romstage. */
void run_ramstage(void);
/* Backup OS memory to CBMEM_ID_RESUME on ACPI S3 resume path,
* if ramstage overwrites low memory. */
void backup_ramstage_section(uintptr_t base, size_t size);
/***********************
* PAYLOAD LOADING *
***********************/
int payload_arch_usable_ram_quirk(uint64_t start, uint64_t size);
/* Load payload into memory in preparation to run. */
void payload_load(void);
/* Run the loaded payload. */
void payload_run(void);
/*
* selfload() and selfload_check() load payloads into memory.
* selfload() does not check the payload to see if it targets memory.
* Call selfload_check() to check that the payload targets usable memory.
* If it does not, the load will fail and this function
* will return false. On successful payload loading these functions return true.
*
* Defined in src/lib/selfboot.c
*/
bool selfload_check(struct prog *payload, enum bootmem_type dest_type);
bool selfload(struct prog *payload);
#endif /* PROGRAM_LOADING_H */
|
