Stefan Reinauer | 3b31402 | 2009-10-26 17:04:28 +0000 | [diff] [blame] | 1 | /* |
| 2 | * This file is part of the coreboot project. |
| 3 | * |
| 4 | * Copyright (C) 2009 coresystems GmbH |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 5 | * Copyright (C) 2013 Google, Inc. |
Stefan Reinauer | 3b31402 | 2009-10-26 17:04:28 +0000 | [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 |
| 18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA |
| 19 | */ |
| 20 | |
| 21 | #ifndef _CBMEM_H_ |
| 22 | #define _CBMEM_H_ |
| 23 | |
Kyösti Mälkki | 2ca2afe | 2014-06-17 15:41:37 +0300 | [diff] [blame] | 24 | #if IS_ENABLED(CONFIG_HAVE_ACPI_RESUME) && \ |
| 25 | ! IS_ENABLED(CONFIG_RELOCATABLE_RAMSTAGE) |
zbao | f722373 | 2012-04-13 13:42:15 +0800 | [diff] [blame] | 26 | #define HIGH_MEMORY_SAVE (CONFIG_RAMTOP - CONFIG_RAMBASE) |
Kyösti Mälkki | 2ca2afe | 2014-06-17 15:41:37 +0300 | [diff] [blame] | 27 | #else |
| 28 | #define HIGH_MEMORY_SAVE 0 |
| 29 | #endif |
| 30 | |
| 31 | #if IS_ENABLED(CONFIG_HAVE_ACPI_RESUME) && \ |
Kyösti Mälkki | b393fa0 | 2014-06-21 23:50:53 +0300 | [diff] [blame] | 32 | defined(CONFIG_HIGH_SCRATCH_MEMORY_SIZE) |
Kyösti Mälkki | 2ca2afe | 2014-06-17 15:41:37 +0300 | [diff] [blame] | 33 | #define HIGH_MEMORY_SCRATCH CONFIG_HIGH_SCRATCH_MEMORY_SIZE |
| 34 | #else |
| 35 | #define HIGH_MEMORY_SCRATCH 0 |
Aaron Durbin | 8e4a355 | 2013-02-08 17:28:04 -0600 | [diff] [blame] | 36 | #endif |
| 37 | |
Stefan Reinauer | 61f4a74 | 2012-04-03 16:21:04 -0700 | [diff] [blame] | 38 | /* Delegation of resume backup memory so we don't have to |
| 39 | * (slowly) handle backing up OS memory in romstage.c |
| 40 | */ |
| 41 | #define CBMEM_BOOT_MODE 0x610 |
| 42 | #define CBMEM_RESUME_BACKUP 0x614 |
Stefan Reinauer | 3b31402 | 2009-10-26 17:04:28 +0000 | [diff] [blame] | 43 | |
| 44 | #define CBMEM_ID_FREESPACE 0x46524545 |
| 45 | #define CBMEM_ID_GDT 0x4c474454 |
| 46 | #define CBMEM_ID_ACPI 0x41435049 |
Duncan Laurie | 11290c4 | 2012-10-03 19:07:05 -0700 | [diff] [blame] | 47 | #define CBMEM_ID_ACPI_GNVS 0x474e5653 |
Duncan Laurie | 9c07c8f | 2013-03-22 11:08:39 -0700 | [diff] [blame] | 48 | #define CBMEM_ID_ACPI_GNVS_PTR 0x474e5650 |
Vladimir Serbinenko | 35c0f43 | 2014-09-02 22:25:36 +0200 | [diff] [blame] | 49 | #define CBMEM_ID_IGD_OPREGION 0x4f444749 |
Stefan Reinauer | 3b31402 | 2009-10-26 17:04:28 +0000 | [diff] [blame] | 50 | #define CBMEM_ID_CBTABLE 0x43425442 |
| 51 | #define CBMEM_ID_PIRQ 0x49525154 |
| 52 | #define CBMEM_ID_MPTABLE 0x534d5054 |
| 53 | #define CBMEM_ID_RESUME 0x5245534d |
zbao | f722373 | 2012-04-13 13:42:15 +0800 | [diff] [blame] | 54 | #define CBMEM_ID_RESUME_SCRATCH 0x52455343 |
Sven Schnelle | 164bcfd | 2011-08-14 20:56:34 +0200 | [diff] [blame] | 55 | #define CBMEM_ID_SMBIOS 0x534d4254 |
Vadim Bendebury | 6f72d69 | 2011-09-21 16:12:39 -0700 | [diff] [blame] | 56 | #define CBMEM_ID_TIMESTAMP 0x54494d45 |
Stefan Reinauer | 61f4a74 | 2012-04-03 16:21:04 -0700 | [diff] [blame] | 57 | #define CBMEM_ID_MRCDATA 0x4d524344 |
Vadim Bendebury | be25a4d | 2011-09-30 11:13:06 -0700 | [diff] [blame] | 58 | #define CBMEM_ID_CONSOLE 0x434f4e53 |
Duncan Laurie | 215f2785 | 2012-10-10 14:34:49 -0700 | [diff] [blame] | 59 | #define CBMEM_ID_ELOG 0x454c4f47 |
Stefan Reinauer | d37ab45 | 2012-12-18 16:23:28 -0800 | [diff] [blame] | 60 | #define CBMEM_ID_COVERAGE 0x47434f56 |
Aaron Durbin | a1db81b4 | 2013-02-08 17:11:28 -0600 | [diff] [blame] | 61 | #define CBMEM_ID_ROMSTAGE_INFO 0x47545352 |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 62 | #define CBMEM_ID_ROMSTAGE_RAM_STACK 0x90357ac4 |
| 63 | #define CBMEM_ID_RAMSTAGE 0x9a357a9e |
| 64 | #define CBMEM_ID_RAMSTAGE_CACHE 0x9a3ca54e |
| 65 | #define CBMEM_ID_ROOT 0xff4007ff |
Aaron Durbin | 0c6946d | 2013-03-13 12:48:33 -0500 | [diff] [blame] | 66 | #define CBMEM_ID_VBOOT_HANDOFF 0x780074f0 |
Aaron Durbin | 716738a | 2013-05-10 00:33:32 -0500 | [diff] [blame] | 67 | #define CBMEM_ID_CAR_GLOBALS 0xcac4e6a3 |
Kyösti Mälkki | 690bf2f | 2013-07-06 11:41:21 +0300 | [diff] [blame] | 68 | #define CBMEM_ID_EHCI_DEBUG 0xe4c1deb9 |
Aaron Durbin | bf18b17 | 2013-10-24 10:11:08 -0500 | [diff] [blame] | 69 | #define CBMEM_ID_REFCODE 0x04efc0de |
| 70 | #define CBMEM_ID_REFCODE_CACHE 0x4efc0de5 |
Aaron Durbin | 00bf3db | 2014-01-09 10:33:23 -0600 | [diff] [blame] | 71 | #define CBMEM_ID_POWER_STATE 0x50535454 |
Aaron Durbin | b4b9eb3 | 2014-02-13 10:26:18 -0600 | [diff] [blame] | 72 | #define CBMEM_ID_SMM_SAVE_SPACE 0x07e9acee |
Aaron Durbin | 06ece7d | 2014-02-14 00:30:04 -0600 | [diff] [blame] | 73 | #define CBMEM_ID_RAM_OOPS 0x05430095 |
Stefan Reinauer | 3b31402 | 2009-10-26 17:04:28 +0000 | [diff] [blame] | 74 | #define CBMEM_ID_NONE 0x00000000 |
Rudolf Marek | 5ce0506 | 2013-05-27 16:09:44 +0200 | [diff] [blame] | 75 | #define CBMEM_ID_AGESA_RUNTIME 0x41474553 |
Vadim Bendebury | 8b143c5 | 2014-05-14 10:12:55 -0700 | [diff] [blame] | 76 | #define CBMEM_ID_HOB_POINTER 0x484f4221 |
Stefan Reinauer | 3b31402 | 2009-10-26 17:04:28 +0000 | [diff] [blame] | 77 | |
Stefan Reinauer | 61f4a74 | 2012-04-03 16:21:04 -0700 | [diff] [blame] | 78 | #ifndef __ASSEMBLER__ |
Aaron Durbin | 0f33307 | 2014-01-30 17:19:46 -0600 | [diff] [blame] | 79 | #include <stddef.h> |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 80 | #include <stdint.h> |
| 81 | |
Vadim Bendebury | 8b143c5 | 2014-05-14 10:12:55 -0700 | [diff] [blame] | 82 | struct cbmem_id_to_name { |
| 83 | u32 id; |
| 84 | const char *name; |
| 85 | }; |
| 86 | |
| 87 | #define CBMEM_ID_TO_NAME_TABLE \ |
| 88 | { CBMEM_ID_FREESPACE, "FREE SPACE " }, \ |
| 89 | { CBMEM_ID_GDT, "GDT " }, \ |
| 90 | { CBMEM_ID_ACPI, "ACPI " }, \ |
| 91 | { CBMEM_ID_CBTABLE, "COREBOOT " }, \ |
| 92 | { CBMEM_ID_PIRQ, "IRQ TABLE " }, \ |
| 93 | { CBMEM_ID_MPTABLE, "SMP TABLE " }, \ |
| 94 | { CBMEM_ID_RESUME, "ACPI RESUME" }, \ |
| 95 | { CBMEM_ID_RESUME_SCRATCH, "ACPISCRATCH" }, \ |
| 96 | { CBMEM_ID_ACPI_GNVS, "ACPI GNVS " }, \ |
| 97 | { CBMEM_ID_ACPI_GNVS_PTR, "GNVS PTR " }, \ |
| 98 | { CBMEM_ID_SMBIOS, "SMBIOS " }, \ |
| 99 | { CBMEM_ID_TIMESTAMP, "TIME STAMP " }, \ |
| 100 | { CBMEM_ID_MRCDATA, "MRC DATA " }, \ |
| 101 | { CBMEM_ID_CONSOLE, "CONSOLE " }, \ |
| 102 | { CBMEM_ID_ELOG, "ELOG " }, \ |
| 103 | { CBMEM_ID_COVERAGE, "COVERAGE " }, \ |
| 104 | { CBMEM_ID_ROMSTAGE_INFO, "ROMSTAGE " }, \ |
| 105 | { CBMEM_ID_ROMSTAGE_RAM_STACK, "ROMSTG STCK" }, \ |
| 106 | { CBMEM_ID_RAMSTAGE, "RAMSTAGE " }, \ |
| 107 | { CBMEM_ID_RAMSTAGE_CACHE, "RAMSTAGE $ " }, \ |
| 108 | { CBMEM_ID_ROOT, "CBMEM ROOT " }, \ |
| 109 | { CBMEM_ID_VBOOT_HANDOFF, "VBOOT " }, \ |
| 110 | { CBMEM_ID_CAR_GLOBALS, "CAR GLOBALS" }, \ |
| 111 | { CBMEM_ID_AGESA_RUNTIME, "AGESA RSVD " }, \ |
| 112 | { CBMEM_ID_EHCI_DEBUG, "USBDEBUG " }, \ |
| 113 | { CBMEM_ID_REFCODE, "REFCODE " }, \ |
| 114 | { CBMEM_ID_SMM_SAVE_SPACE, "SMM BACKUP " }, \ |
| 115 | { CBMEM_ID_REFCODE_CACHE, "REFCODE $ " }, \ |
| 116 | { CBMEM_ID_POWER_STATE, "POWER STATE" }, \ |
| 117 | { CBMEM_ID_RAM_OOPS, "RAMOOPS " }, |
| 118 | |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 119 | struct cbmem_entry; |
| 120 | |
| 121 | #if CONFIG_DYNAMIC_CBMEM |
| 122 | |
| 123 | /* |
| 124 | * The dynamic cbmem infrastructure allows for growing cbmem dynamically as |
| 125 | * things are added. It requires an external function, cbmem_top(), to be |
| 126 | * implemented by the board or chipset to define the upper address where |
| 127 | * cbmem lives. This address is required to be a 32-bit address. Additionally, |
| 128 | * the address needs to be consistent in both romstage and ramstage. The |
Martin Roth | 0cb07e3 | 2013-07-09 21:46:01 -0600 | [diff] [blame] | 129 | * dynamic cbmem infrastructure allocates new regions below the last allocated |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 130 | * region. Regions are defined by a cbmem_entry struct that is opaque. Regions |
| 131 | * may be removed, but the last one added is the only that can be removed. |
| 132 | * |
| 133 | * Dynamic cbmem has two allocators within it. All allocators use a top down |
| 134 | * allocation scheme. However, there are 2 modes for each allocation depending |
| 135 | * on the requested size. There are large allocations and small allocations. |
| 136 | * An allocation is considered to be small when it is less than or equal to |
| 137 | * DYN_CBMEM_ALIGN_SIZE / 2. The smaller allocations are fit into a larger |
| 138 | * allocation region. |
| 139 | */ |
| 140 | |
| 141 | #define DYN_CBMEM_ALIGN_SIZE (4096) |
| 142 | |
Kyösti Mälkki | 2d8520b | 2014-01-06 17:20:31 +0200 | [diff] [blame] | 143 | /* By default cbmem is attempted to be recovered. Returns 0 if cbmem was |
| 144 | * recovered or 1 if cbmem had to be reinitialized. */ |
| 145 | int cbmem_initialize(void); |
Martin Roth | 0cb07e3 | 2013-07-09 21:46:01 -0600 | [diff] [blame] | 146 | /* Initialize cbmem to be empty. */ |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 147 | void cbmem_initialize_empty(void); |
| 148 | |
| 149 | /* Return the top address for dynamic cbmem. The address returned needs to |
| 150 | * be consistent across romstage and ramstage, and it is required to be |
| 151 | * below 4GiB. */ |
| 152 | void *cbmem_top(void); |
| 153 | |
| 154 | /* Add a cbmem entry of a given size and id. These return NULL on failure. The |
| 155 | * add function performs a find first and do not check against the original |
| 156 | * size. */ |
| 157 | const struct cbmem_entry *cbmem_entry_add(u32 id, u64 size); |
| 158 | |
| 159 | /* Find a cbmem entry of a given id. These return NULL on failure. */ |
| 160 | const struct cbmem_entry *cbmem_entry_find(u32 id); |
| 161 | |
| 162 | /* Remove a region defined by a cbmem_entry. Returns 0 on success, < 0 on |
| 163 | * error. Note: A cbmem_entry cannot be removed unless it was the last one |
| 164 | * added. */ |
| 165 | int cbmem_entry_remove(const struct cbmem_entry *entry); |
| 166 | |
| 167 | /* cbmem_entry accessors to get pointer and size of a cbmem_entry. */ |
| 168 | void *cbmem_entry_start(const struct cbmem_entry *entry); |
| 169 | u64 cbmem_entry_size(const struct cbmem_entry *entry); |
| 170 | |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 171 | |
| 172 | #else /* !CONFIG_DYNAMIC_CBMEM */ |
| 173 | |
Kyösti Mälkki | 4dba06a | 2014-01-04 09:42:02 +0200 | [diff] [blame] | 174 | /* Allocation with static CBMEM is resolved at build time. We start |
| 175 | * with 128kB and conditionally add some of the most greedy CBMEM |
| 176 | * table entries. |
| 177 | */ |
| 178 | #define _CBMEM_SZ_MINIMAL ( 128 * 1024 ) |
| 179 | |
Kyösti Mälkki | 4dba06a | 2014-01-04 09:42:02 +0200 | [diff] [blame] | 180 | #define _CBMEM_SZ_TOTAL \ |
Kyösti Mälkki | 2ca2afe | 2014-06-17 15:41:37 +0300 | [diff] [blame] | 181 | (_CBMEM_SZ_MINIMAL + CONFIG_CONSOLE_CBMEM_BUFFER_SIZE + \ |
| 182 | HIGH_MEMORY_SAVE + HIGH_MEMORY_SCRATCH) |
Kyösti Mälkki | 4dba06a | 2014-01-04 09:42:02 +0200 | [diff] [blame] | 183 | |
| 184 | #define HIGH_MEMORY_SIZE ALIGN_UP(_CBMEM_SZ_TOTAL, 0x10000) |
| 185 | |
| 186 | |
Stefan Reinauer | 61f4a74 | 2012-04-03 16:21:04 -0700 | [diff] [blame] | 187 | #ifndef __PRE_RAM__ |
Kyösti Mälkki | 2b790f6 | 2013-09-03 05:25:57 +0300 | [diff] [blame] | 188 | void set_top_of_ram(uint64_t ramtop); |
Kyösti Mälkki | bc90e15 | 2013-09-04 13:26:11 +0300 | [diff] [blame] | 189 | void backup_top_of_ram(uint64_t ramtop); |
Kyösti Mälkki | 1ae305e | 2013-09-04 13:05:01 +0300 | [diff] [blame] | 190 | void cbmem_late_set_table(uint64_t base, uint64_t size); |
Stefan Reinauer | 61f4a74 | 2012-04-03 16:21:04 -0700 | [diff] [blame] | 191 | #endif |
| 192 | |
Kyösti Mälkki | f1e3c76 | 2014-12-22 12:28:07 +0200 | [diff] [blame] | 193 | unsigned long get_top_of_ram(void); |
| 194 | |
Kyösti Mälkki | c04afd6 | 2013-09-04 13:31:39 +0300 | [diff] [blame] | 195 | void get_cbmem_table(uint64_t *base, uint64_t *size); |
Kyösti Mälkki | f9f74af | 2013-09-06 10:46:22 +0300 | [diff] [blame] | 196 | struct cbmem_entry *get_cbmem_toc(void); |
Rudolf Marek | 475916d | 2010-12-13 20:02:23 +0000 | [diff] [blame] | 197 | |
Aaron Durbin | 0f33307 | 2014-01-30 17:19:46 -0600 | [diff] [blame] | 198 | static inline const struct cbmem_entry *cbmem_entry_find(uint32_t id) |
| 199 | { |
| 200 | return NULL; |
| 201 | } |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 202 | #endif /* CONFIG_DYNAMIC_CBMEM */ |
| 203 | |
| 204 | /* Common API between cbmem and dynamic cbmem. */ |
| 205 | |
Kyösti Mälkki | 2d8520b | 2014-01-06 17:20:31 +0200 | [diff] [blame] | 206 | /* Returns 0 if old cbmem was recovered. Recovery is only attempted if |
| 207 | * s3resume is non-zero. */ |
| 208 | int cbmem_recovery(int s3resume); |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 209 | /* Add a cbmem entry of a given size and id. These return NULL on failure. The |
| 210 | * add function performs a find first and do not check against the original |
| 211 | * size. */ |
| 212 | void *cbmem_add(u32 id, u64 size); |
| 213 | /* Find a cbmem entry of a given id. These return NULL on failure. */ |
| 214 | void *cbmem_find(u32 id); |
| 215 | |
Kyösti Mälkki | 823edda | 2014-12-18 18:30:29 +0200 | [diff] [blame] | 216 | void cbmem_run_init_hooks(void); |
| 217 | void cbmem_fail_resume(void); |
| 218 | |
Rudolf Marek | 3310934 | 2010-12-11 22:26:10 +0000 | [diff] [blame] | 219 | #ifndef __PRE_RAM__ |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 220 | /* Ramstage only functions. */ |
Aaron Durbin | 4904802 | 2014-02-18 21:55:02 -0600 | [diff] [blame] | 221 | /* Add the cbmem memory used to the memory map at boot. */ |
| 222 | void cbmem_add_bootmem(void); |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 223 | void cbmem_list(void); |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 224 | void cbmem_print_entry(int n, u32 id, u64 start, u64 size); |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 225 | #endif /* __PRE_RAM__ */ |
| 226 | |
| 227 | #endif /* __ASSEMBLER__ */ |
| 228 | |
| 229 | |
| 230 | #endif /* _CBMEM_H_ */ |