Aaron Durbin | bdf913a | 2014-02-24 14:56:34 -0600 | [diff] [blame] | 1 | /* |
| 2 | * This file is part of the coreboot project. |
| 3 | * |
Aaron Durbin | 04654a2 | 2015-03-17 11:43:44 -0500 | [diff] [blame] | 4 | * Copyright 2015 Google Inc. |
Ionela Voinescu | 00903e5 | 2015-01-09 13:14:20 +0000 | [diff] [blame] | 5 | * Copyright (C) 2014 Imagination Technologies |
Aaron Durbin | bdf913a | 2014-02-24 14:56:34 -0600 | [diff] [blame] | 6 | * |
| 7 | * This program is free software; you can redistribute it and/or modify |
| 8 | * it under the terms of the GNU General Public License as published by |
| 9 | * the Free Software Foundation; version 2 of the License. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this program; if not, write to the Free Software |
Patrick Georgi | b890a12 | 2015-03-26 15:17:45 +0100 | [diff] [blame] | 18 | * Foundation, Inc. |
Aaron Durbin | bdf913a | 2014-02-24 14:56:34 -0600 | [diff] [blame] | 19 | */ |
Aaron Durbin | 04654a2 | 2015-03-17 11:43:44 -0500 | [diff] [blame] | 20 | #ifndef PROGRAM_LOADING_H |
| 21 | #define PROGRAM_LOADING_H |
Aaron Durbin | bdf913a | 2014-02-24 14:56:34 -0600 | [diff] [blame] | 22 | |
| 23 | #include <stdint.h> |
| 24 | #include <stddef.h> |
Aaron Durbin | ac12c66c | 2015-05-20 12:08:55 -0500 | [diff] [blame^] | 25 | #include <assets.h> |
Aaron Durbin | bdf913a | 2014-02-24 14:56:34 -0600 | [diff] [blame] | 26 | |
Aaron Durbin | 6e76fff | 2015-03-20 09:42:05 -0500 | [diff] [blame] | 27 | enum { |
| 28 | /* Last segment of program. Can be used to take different actions for |
| 29 | * cache maintenance of a program load. */ |
| 30 | SEG_FINAL = 1 << 0, |
| 31 | }; |
Ionela Voinescu | 00903e5 | 2015-01-09 13:14:20 +0000 | [diff] [blame] | 32 | |
Aaron Durbin | 3948e53 | 2015-03-20 13:00:20 -0500 | [diff] [blame] | 33 | /* Called for each segment of a program loaded. The SEG_FINAL flag will be |
Aaron Durbin | 6e76fff | 2015-03-20 09:42:05 -0500 | [diff] [blame] | 34 | * set on the last segment loaded. */ |
| 35 | void arch_segment_loaded(uintptr_t start, size_t size, int flags); |
Ionela Voinescu | 00903e5 | 2015-01-09 13:14:20 +0000 | [diff] [blame] | 36 | |
Aaron Durbin | 3948e53 | 2015-03-20 13:00:20 -0500 | [diff] [blame] | 37 | /* Representation of a program. */ |
| 38 | struct prog { |
Aaron Durbin | ac12c66c | 2015-05-20 12:08:55 -0500 | [diff] [blame^] | 39 | /* The region_device within the asset is the source of program content |
| 40 | * to load. After loading program it represents the memory region of |
| 41 | * the stages and payload. For architectures that use a bounce buffer |
| 42 | * then it would represent the bounce buffer. */ |
| 43 | struct asset asset; |
Aaron Durbin | 3948e53 | 2015-03-20 13:00:20 -0500 | [diff] [blame] | 44 | /* Entry to program with optional argument. It's up to the architecture |
| 45 | * to decide if argument is passed. */ |
| 46 | void (*entry)(void *); |
| 47 | void *arg; |
| 48 | }; |
| 49 | |
Aaron Durbin | ac12c66c | 2015-05-20 12:08:55 -0500 | [diff] [blame^] | 50 | #define PROG_INIT(type_, name_) \ |
| 51 | { \ |
| 52 | .asset = ASSET_INIT(type_, name_), \ |
| 53 | } |
| 54 | |
| 55 | static inline const char *prog_name(const struct prog *prog) |
| 56 | { |
| 57 | return asset_name(&prog->asset); |
| 58 | } |
| 59 | |
| 60 | static inline enum asset_type prog_type(const struct prog *prog) |
| 61 | { |
| 62 | return asset_type(&prog->asset); |
| 63 | } |
| 64 | |
| 65 | static inline struct region_device *prog_rdev(struct prog *prog) |
| 66 | { |
| 67 | return asset_rdev(&prog->asset); |
| 68 | } |
| 69 | |
Aaron Durbin | 6a452ef | 2015-05-19 16:25:20 -0500 | [diff] [blame] | 70 | /* Only valid for loaded programs. */ |
Aaron Durbin | 3948e53 | 2015-03-20 13:00:20 -0500 | [diff] [blame] | 71 | static inline size_t prog_size(const struct prog *prog) |
| 72 | { |
Aaron Durbin | ac12c66c | 2015-05-20 12:08:55 -0500 | [diff] [blame^] | 73 | return asset_size(&prog->asset); |
Aaron Durbin | 3948e53 | 2015-03-20 13:00:20 -0500 | [diff] [blame] | 74 | } |
| 75 | |
Aaron Durbin | 6a452ef | 2015-05-19 16:25:20 -0500 | [diff] [blame] | 76 | /* Only valid for loaded programs. */ |
Aaron Durbin | 3948e53 | 2015-03-20 13:00:20 -0500 | [diff] [blame] | 77 | static inline void *prog_start(const struct prog *prog) |
| 78 | { |
Aaron Durbin | ac12c66c | 2015-05-20 12:08:55 -0500 | [diff] [blame^] | 79 | return asset_mmap(&prog->asset); |
Aaron Durbin | 3948e53 | 2015-03-20 13:00:20 -0500 | [diff] [blame] | 80 | } |
| 81 | |
| 82 | static inline void *prog_entry(const struct prog *prog) |
| 83 | { |
| 84 | return prog->entry; |
| 85 | } |
| 86 | |
| 87 | static inline void *prog_entry_arg(const struct prog *prog) |
| 88 | { |
| 89 | return prog->arg; |
| 90 | } |
| 91 | |
Aaron Durbin | 6a452ef | 2015-05-19 16:25:20 -0500 | [diff] [blame] | 92 | /* region_device representing the 32-bit flat address space. */ |
| 93 | extern const struct mem_region_device addrspace_32bit; |
| 94 | |
| 95 | static inline void prog_memory_init(struct prog *prog, uintptr_t ptr, |
| 96 | size_t size) |
| 97 | { |
Aaron Durbin | ac12c66c | 2015-05-20 12:08:55 -0500 | [diff] [blame^] | 98 | rdev_chain(&prog->asset.rdev, &addrspace_32bit.rdev, ptr, size); |
Aaron Durbin | 6a452ef | 2015-05-19 16:25:20 -0500 | [diff] [blame] | 99 | } |
| 100 | |
Aaron Durbin | 3948e53 | 2015-03-20 13:00:20 -0500 | [diff] [blame] | 101 | static inline void prog_set_area(struct prog *prog, void *start, size_t size) |
| 102 | { |
Aaron Durbin | 6a452ef | 2015-05-19 16:25:20 -0500 | [diff] [blame] | 103 | prog_memory_init(prog, (uintptr_t)start, size); |
Aaron Durbin | 3948e53 | 2015-03-20 13:00:20 -0500 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | static inline void prog_set_entry(struct prog *prog, void *e, void *arg) |
| 107 | { |
| 108 | prog->entry = e; |
| 109 | prog->arg = arg; |
| 110 | } |
| 111 | |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 112 | /* Locate the identified program to run. Return 0 on success. < 0 on error. */ |
Aaron Durbin | ac12c66c | 2015-05-20 12:08:55 -0500 | [diff] [blame^] | 113 | static inline int prog_locate(struct prog *prog) |
| 114 | { |
| 115 | return asset_locate(&prog->asset); |
| 116 | } |
| 117 | |
Aaron Durbin | b3847e6 | 2015-03-20 15:55:08 -0500 | [diff] [blame] | 118 | /* Run the program described by prog. */ |
| 119 | void prog_run(struct prog *prog); |
| 120 | /* Per architecture implementation running a program. */ |
| 121 | void arch_prog_run(struct prog *prog); |
| 122 | /* Platform (SoC/chipset) specific overrides for running a program. This is |
| 123 | * called prior to calling the arch_prog_run. Thus, if there is anything |
| 124 | * special that needs to be done by the platform similar to the architecture |
| 125 | * code it needs to that as well. */ |
| 126 | void platform_prog_run(struct prog *prog); |
| 127 | |
Aaron Durbin | ce9efe0 | 2015-03-20 16:37:12 -0500 | [diff] [blame] | 128 | struct prog_loader_ops { |
| 129 | const char *name; |
Aaron Durbin | 5e8286b | 2015-04-28 15:59:12 -0500 | [diff] [blame] | 130 | /* Determine if the loader is the active one. If so returns 1 else 0 |
| 131 | * or < 0 on error. */ |
| 132 | int (*is_loader_active)(struct prog *prog); |
Aaron Durbin | 899d13d | 2015-05-15 23:39:23 -0500 | [diff] [blame] | 133 | /* Returns < 0 on error or 0 on success. This function locates |
| 134 | * the rdev representing the file data associated with the passed in |
| 135 | * prog. */ |
| 136 | int (*locate)(struct prog *prog); |
Aaron Durbin | ce9efe0 | 2015-03-20 16:37:12 -0500 | [diff] [blame] | 137 | }; |
| 138 | |
Aaron Durbin | d1b0e87 | 2015-03-17 13:17:06 -0500 | [diff] [blame] | 139 | /************************ |
| 140 | * ROMSTAGE LOADING * |
| 141 | ************************/ |
| 142 | |
| 143 | /* Run romstage from bootblock. */ |
| 144 | void run_romstage(void); |
Aaron Durbin | 04654a2 | 2015-03-17 11:43:44 -0500 | [diff] [blame] | 145 | |
| 146 | /************************ |
| 147 | * RAMSTAGE LOADING * |
| 148 | ************************/ |
| 149 | |
Aaron Durbin | ce9efe0 | 2015-03-20 16:37:12 -0500 | [diff] [blame] | 150 | /* Run ramstage from romstage. */ |
| 151 | void run_ramstage(void); |
| 152 | |
Aaron Durbin | bd74a4b | 2015-03-06 23:17:33 -0600 | [diff] [blame] | 153 | /* Called when the stage cache couldn't load ramstage on resume. */ |
| 154 | void ramstage_cache_invalid(void); |
Aaron Durbin | fcfdff8 | 2015-03-20 10:58:41 -0500 | [diff] [blame] | 155 | |
Aaron Durbin | 04654a2 | 2015-03-17 11:43:44 -0500 | [diff] [blame] | 156 | /*********************** |
| 157 | * PAYLOAD LOADING * |
| 158 | ***********************/ |
| 159 | |
Aaron Durbin | ebf2ed4 | 2015-03-20 10:20:15 -0500 | [diff] [blame] | 160 | /* Load payload into memory in preparation to run. */ |
| 161 | void payload_load(void); |
Aaron Durbin | bdf913a | 2014-02-24 14:56:34 -0600 | [diff] [blame] | 162 | |
| 163 | /* Run the loaded payload. */ |
Aaron Durbin | ebf2ed4 | 2015-03-20 10:20:15 -0500 | [diff] [blame] | 164 | void payload_run(void); |
Aaron Durbin | bdf913a | 2014-02-24 14:56:34 -0600 | [diff] [blame] | 165 | |
Aaron Durbin | c34713d | 2014-02-25 20:36:56 -0600 | [diff] [blame] | 166 | /* Mirror the payload to be loaded. */ |
Aaron Durbin | ce9efe0 | 2015-03-20 16:37:12 -0500 | [diff] [blame] | 167 | void mirror_payload(struct prog *payload); |
Aaron Durbin | bdf913a | 2014-02-24 14:56:34 -0600 | [diff] [blame] | 168 | |
| 169 | /* Defined in src/lib/selfboot.c */ |
Aaron Durbin | ce9efe0 | 2015-03-20 16:37:12 -0500 | [diff] [blame] | 170 | void *selfload(struct prog *payload); |
Aaron Durbin | 04654a2 | 2015-03-17 11:43:44 -0500 | [diff] [blame] | 171 | |
| 172 | #endif /* PROGRAM_LOADING_H */ |