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. |
Stefan Reinauer | 3b31402 | 2009-10-26 17:04:28 +0000 | [diff] [blame] | 15 | */ |
| 16 | |
| 17 | #ifndef _CBMEM_H_ |
| 18 | #define _CBMEM_H_ |
| 19 | |
Aaron Durbin | dc9f5cd | 2015-09-08 13:34:43 -0500 | [diff] [blame] | 20 | #include <commonlib/cbmem_id.h> |
Kyösti Mälkki | 4fbac46 | 2015-01-07 04:48:43 +0200 | [diff] [blame] | 21 | #include <rules.h> |
Aaron Durbin | 0f33307 | 2014-01-30 17:19:46 -0600 | [diff] [blame] | 22 | #include <stddef.h> |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 23 | #include <stdint.h> |
Aaron Durbin | 1ca2d86 | 2015-09-30 12:26:54 -0500 | [diff] [blame] | 24 | #include <boot/coreboot_tables.h> |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 25 | |
Kyösti Mälkki | d72cc41 | 2016-06-15 06:15:46 +0300 | [diff] [blame] | 26 | #define CBMEM_FSP_HOB_PTR 0x614 |
| 27 | |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 28 | struct cbmem_entry; |
| 29 | |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 30 | /* |
| 31 | * The dynamic cbmem infrastructure allows for growing cbmem dynamically as |
| 32 | * things are added. It requires an external function, cbmem_top(), to be |
| 33 | * implemented by the board or chipset to define the upper address where |
| 34 | * cbmem lives. This address is required to be a 32-bit address. Additionally, |
| 35 | * the address needs to be consistent in both romstage and ramstage. The |
Martin Roth | 0cb07e3 | 2013-07-09 21:46:01 -0600 | [diff] [blame] | 36 | * dynamic cbmem infrastructure allocates new regions below the last allocated |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 37 | * region. Regions are defined by a cbmem_entry struct that is opaque. Regions |
| 38 | * may be removed, but the last one added is the only that can be removed. |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 39 | */ |
| 40 | |
| 41 | #define DYN_CBMEM_ALIGN_SIZE (4096) |
Lee Leahy | 522149c | 2015-05-08 11:33:55 -0700 | [diff] [blame] | 42 | #define CBMEM_ROOT_SIZE DYN_CBMEM_ALIGN_SIZE |
| 43 | |
| 44 | /* The root region is at least DYN_CBMEM_ALIGN_SIZE . */ |
| 45 | #define CBMEM_ROOT_MIN_SIZE DYN_CBMEM_ALIGN_SIZE |
| 46 | #define CBMEM_LG_ALIGN CBMEM_ROOT_MIN_SIZE |
| 47 | |
| 48 | /* Small allocation parameters. */ |
| 49 | #define CBMEM_SM_ROOT_SIZE 1024 |
| 50 | #define CBMEM_SM_ALIGN 32 |
| 51 | |
| 52 | /* Determine the size for CBMEM root and the small allocations */ |
| 53 | static inline size_t cbmem_overhead_size(void) |
| 54 | { |
Lee Leahy | 708fc27 | 2017-03-07 12:18:53 -0800 | [diff] [blame] | 55 | return 2 * CBMEM_ROOT_MIN_SIZE; |
Lee Leahy | 522149c | 2015-05-08 11:33:55 -0700 | [diff] [blame] | 56 | } |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 57 | |
Kyösti Mälkki | 2d8520b | 2014-01-06 17:20:31 +0200 | [diff] [blame] | 58 | /* By default cbmem is attempted to be recovered. Returns 0 if cbmem was |
| 59 | * recovered or 1 if cbmem had to be reinitialized. */ |
| 60 | int cbmem_initialize(void); |
Lee Leahy | 522149c | 2015-05-08 11:33:55 -0700 | [diff] [blame] | 61 | int cbmem_initialize_id_size(u32 id, u64 size); |
| 62 | |
Martin Roth | 0cb07e3 | 2013-07-09 21:46:01 -0600 | [diff] [blame] | 63 | /* Initialize cbmem to be empty. */ |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 64 | void cbmem_initialize_empty(void); |
Lee Leahy | 522149c | 2015-05-08 11:33:55 -0700 | [diff] [blame] | 65 | void cbmem_initialize_empty_id_size(u32 id, u64 size); |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 66 | |
Aaron Durbin | dfdea2a | 2017-08-01 10:27:10 -0600 | [diff] [blame] | 67 | /* Optional hook for platforms to initialize cbmem_top() value. When employed |
| 68 | * it's called a single time during boot at cbmem initialization/recovery |
| 69 | * time. */ |
| 70 | void cbmem_top_init(void); |
| 71 | |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 72 | /* Return the top address for dynamic cbmem. The address returned needs to |
| 73 | * be consistent across romstage and ramstage, and it is required to be |
Furquan Shaikh | 6f009dc | 2016-03-28 13:23:13 -0700 | [diff] [blame] | 74 | * below 4GiB. |
Julius Werner | 3c814b2 | 2016-08-19 16:20:40 -0700 | [diff] [blame] | 75 | * x86 boards or chipsets must return NULL before the cbmem backing store has |
| 76 | * been initialized. */ |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 77 | void *cbmem_top(void); |
| 78 | |
| 79 | /* Add a cbmem entry of a given size and id. These return NULL on failure. The |
| 80 | * add function performs a find first and do not check against the original |
| 81 | * size. */ |
| 82 | const struct cbmem_entry *cbmem_entry_add(u32 id, u64 size); |
| 83 | |
| 84 | /* Find a cbmem entry of a given id. These return NULL on failure. */ |
| 85 | const struct cbmem_entry *cbmem_entry_find(u32 id); |
| 86 | |
| 87 | /* Remove a region defined by a cbmem_entry. Returns 0 on success, < 0 on |
| 88 | * error. Note: A cbmem_entry cannot be removed unless it was the last one |
| 89 | * added. */ |
| 90 | int cbmem_entry_remove(const struct cbmem_entry *entry); |
| 91 | |
| 92 | /* cbmem_entry accessors to get pointer and size of a cbmem_entry. */ |
| 93 | void *cbmem_entry_start(const struct cbmem_entry *entry); |
| 94 | u64 cbmem_entry_size(const struct cbmem_entry *entry); |
| 95 | |
Kyösti Mälkki | 2d8520b | 2014-01-06 17:20:31 +0200 | [diff] [blame] | 96 | /* Returns 0 if old cbmem was recovered. Recovery is only attempted if |
| 97 | * s3resume is non-zero. */ |
| 98 | int cbmem_recovery(int s3resume); |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 99 | /* Add a cbmem entry of a given size and id. These return NULL on failure. The |
| 100 | * add function performs a find first and do not check against the original |
| 101 | * size. */ |
| 102 | void *cbmem_add(u32 id, u64 size); |
| 103 | /* Find a cbmem entry of a given id. These return NULL on failure. */ |
| 104 | void *cbmem_find(u32 id); |
| 105 | |
Aaron Durbin | 41607a4 | 2015-06-09 13:54:10 -0500 | [diff] [blame] | 106 | /* Indicate to each hook if cbmem is being recovered or not. */ |
| 107 | typedef void (* const cbmem_init_hook_t)(int is_recovery); |
| 108 | void cbmem_run_init_hooks(int is_recovery); |
Kyösti Mälkki | 823edda | 2014-12-18 18:30:29 +0200 | [diff] [blame] | 109 | void cbmem_fail_resume(void); |
| 110 | |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 111 | /* Ramstage only functions. */ |
Aaron Durbin | 4904802 | 2014-02-18 21:55:02 -0600 | [diff] [blame] | 112 | /* Add the cbmem memory used to the memory map at boot. */ |
| 113 | void cbmem_add_bootmem(void); |
Philipp Deppenwiese | 84258db | 2018-08-16 00:31:26 +0200 | [diff] [blame^] | 114 | /* Return the cbmem memory used */ |
| 115 | void cbmem_get_region(void **baseptr, size_t *size); |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 116 | void cbmem_list(void); |
Aaron Durbin | 1ca2d86 | 2015-09-30 12:26:54 -0500 | [diff] [blame] | 117 | void cbmem_add_records_to_cbtable(struct lb_header *header); |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 118 | |
Kyösti Mälkki | 4fbac46 | 2015-01-07 04:48:43 +0200 | [diff] [blame] | 119 | #if ENV_RAMSTAGE |
Lee Leahy | 22c28e0 | 2017-03-07 15:47:44 -0800 | [diff] [blame] | 120 | #define ROMSTAGE_CBMEM_INIT_HOOK(init_fn_) __attribute__((unused)) \ |
| 121 | static cbmem_init_hook_t init_fn_ ## _unused_ = init_fn_; |
Kyösti Mälkki | 4fbac46 | 2015-01-07 04:48:43 +0200 | [diff] [blame] | 122 | #define RAMSTAGE_CBMEM_INIT_HOOK(init_fn_) \ |
| 123 | static cbmem_init_hook_t init_fn_ ## _ptr_ __attribute__((used, \ |
| 124 | section(".rodata.cbmem_init_hooks"))) = init_fn_; |
Lee Leahy | 22c28e0 | 2017-03-07 15:47:44 -0800 | [diff] [blame] | 125 | #define POSTCAR_CBMEM_INIT_HOOK(init_fn_) __attribute__((unused)) \ |
| 126 | static cbmem_init_hook_t init_fn_ ## _unused2_ = init_fn_; |
Kyösti Mälkki | 4fbac46 | 2015-01-07 04:48:43 +0200 | [diff] [blame] | 127 | #elif ENV_ROMSTAGE |
| 128 | #define ROMSTAGE_CBMEM_INIT_HOOK(init_fn_) \ |
| 129 | static cbmem_init_hook_t init_fn_ ## _ptr_ __attribute__((used, \ |
| 130 | section(".rodata.cbmem_init_hooks"))) = init_fn_; |
Lee Leahy | 22c28e0 | 2017-03-07 15:47:44 -0800 | [diff] [blame] | 131 | #define RAMSTAGE_CBMEM_INIT_HOOK(init_fn_) __attribute__((unused)) \ |
| 132 | static cbmem_init_hook_t init_fn_ ## _unused_ = init_fn_; |
| 133 | #define POSTCAR_CBMEM_INIT_HOOK(init_fn_) __attribute__((unused)) \ |
| 134 | static cbmem_init_hook_t init_fn_ ## _unused2_ = init_fn_; |
Aaron Durbin | 1e9a914 | 2016-09-16 16:23:21 -0500 | [diff] [blame] | 135 | #elif ENV_POSTCAR |
Lee Leahy | 22c28e0 | 2017-03-07 15:47:44 -0800 | [diff] [blame] | 136 | #define ROMSTAGE_CBMEM_INIT_HOOK(init_fn_) __attribute__((unused)) \ |
| 137 | static cbmem_init_hook_t init_fn_ ## _unused2_ = init_fn_; |
| 138 | #define RAMSTAGE_CBMEM_INIT_HOOK(init_fn_) __attribute__((unused)) \ |
| 139 | static cbmem_init_hook_t init_fn_ ## _unused_ = init_fn_; |
Aaron Durbin | 1e9a914 | 2016-09-16 16:23:21 -0500 | [diff] [blame] | 140 | #define POSTCAR_CBMEM_INIT_HOOK(init_fn_) \ |
| 141 | static cbmem_init_hook_t init_fn_ ## _ptr_ __attribute__((used, \ |
| 142 | section(".rodata.cbmem_init_hooks"))) = init_fn_; |
Kyösti Mälkki | 4fbac46 | 2015-01-07 04:48:43 +0200 | [diff] [blame] | 143 | #else |
Lee Leahy | 22c28e0 | 2017-03-07 15:47:44 -0800 | [diff] [blame] | 144 | #define ROMSTAGE_CBMEM_INIT_HOOK(init_fn_) __attribute__((unused)) \ |
| 145 | static cbmem_init_hook_t init_fn_ ## _unused_ = init_fn_; |
| 146 | #define RAMSTAGE_CBMEM_INIT_HOOK(init_fn_) __attribute__((unused)) \ |
| 147 | static cbmem_init_hook_t init_fn_ ## _unused2_ = init_fn_; |
| 148 | #define POSTCAR_CBMEM_INIT_HOOK(init_fn_) __attribute__((unused)) \ |
| 149 | static cbmem_init_hook_t init_fn_ ## _unused3_ = init_fn_; |
Kyösti Mälkki | 4fbac46 | 2015-01-07 04:48:43 +0200 | [diff] [blame] | 150 | #endif /* ENV_RAMSTAGE */ |
| 151 | |
| 152 | |
Kyösti Mälkki | a7dd645 | 2017-04-19 07:37:38 +0300 | [diff] [blame] | 153 | /* Any new chipset and board must implement cbmem_top() for both |
| 154 | * romstage and ramstage to support early features like COLLECT_TIMESTAMPS |
| 155 | * and CBMEM_CONSOLE. Sometimes it is necessary to have cbmem_top() |
| 156 | * value stored in nvram to enable early recovery on S3 path. |
Kyösti Mälkki | 2fb6b40 | 2014-12-19 08:20:45 +0200 | [diff] [blame] | 157 | */ |
Kyösti Mälkki | a7dd645 | 2017-04-19 07:37:38 +0300 | [diff] [blame] | 158 | #if IS_ENABLED(CONFIG_ARCH_X86) |
Kyösti Mälkki | 70d92b9 | 2017-04-19 19:57:01 +0300 | [diff] [blame] | 159 | /* Note that with LATE_CBMEM_INIT, restore_top_of_low_cacheable() |
| 160 | * may conditionally return 0 when the sleep type is non S3, |
| 161 | * i.e. cold and warm boots would return NULL also for cbmem_top. */ |
| 162 | void backup_top_of_low_cacheable(uintptr_t ramtop); |
| 163 | uintptr_t restore_top_of_low_cacheable(void); |
| 164 | uintptr_t restore_cbmem_top(void); |
| 165 | |
| 166 | /* Deprecated, only use with LATE_CBMEM_INIT. */ |
| 167 | void set_late_cbmem_top(uintptr_t ramtop); |
Kyösti Mälkki | 2fb6b40 | 2014-12-19 08:20:45 +0200 | [diff] [blame] | 168 | #endif |
| 169 | |
Aaron Durbin | b2a5f48 | 2016-12-14 14:40:43 -0600 | [diff] [blame] | 170 | /* |
| 171 | * Returns 0 for the stages where we know that cbmem does not come online. |
| 172 | * Even if this function returns 1 for romstage, depending upon the point in |
| 173 | * bootup, cbmem might not actually be online. |
| 174 | */ |
| 175 | static inline int cbmem_possibly_online(void) |
| 176 | { |
| 177 | if (ENV_BOOTBLOCK) |
| 178 | return 0; |
| 179 | |
| 180 | if (ENV_VERSTAGE && IS_ENABLED(CONFIG_VBOOT_STARTS_IN_BOOTBLOCK)) |
| 181 | return 0; |
| 182 | |
| 183 | return 1; |
| 184 | } |
| 185 | |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 186 | #endif /* _CBMEM_H_ */ |