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> |
Marc Jones | a8bda43 | 2015-06-04 23:36:01 -0600 | [diff] [blame] | 22 | |
Kyösti Mälkki | 2ca2afe | 2014-06-17 15:41:37 +0300 | [diff] [blame] | 23 | #if IS_ENABLED(CONFIG_HAVE_ACPI_RESUME) && \ |
| 24 | ! IS_ENABLED(CONFIG_RELOCATABLE_RAMSTAGE) |
zbao | f722373 | 2012-04-13 13:42:15 +0800 | [diff] [blame] | 25 | #define HIGH_MEMORY_SAVE (CONFIG_RAMTOP - CONFIG_RAMBASE) |
Kyösti Mälkki | 2ca2afe | 2014-06-17 15:41:37 +0300 | [diff] [blame] | 26 | #else |
| 27 | #define HIGH_MEMORY_SAVE 0 |
| 28 | #endif |
| 29 | |
Stefan Reinauer | 61f4a74 | 2012-04-03 16:21:04 -0700 | [diff] [blame] | 30 | /* Delegation of resume backup memory so we don't have to |
| 31 | * (slowly) handle backing up OS memory in romstage.c |
| 32 | */ |
| 33 | #define CBMEM_BOOT_MODE 0x610 |
| 34 | #define CBMEM_RESUME_BACKUP 0x614 |
Martin Roth | 582b2ae | 2015-01-11 14:29:29 -0700 | [diff] [blame] | 35 | #define CBMEM_FSP_HOB_PTR 0x614 |
Stefan Reinauer | 3b31402 | 2009-10-26 17:04:28 +0000 | [diff] [blame] | 36 | |
Stefan Reinauer | 61f4a74 | 2012-04-03 16:21:04 -0700 | [diff] [blame] | 37 | #ifndef __ASSEMBLER__ |
Aaron Durbin | 0f33307 | 2014-01-30 17:19:46 -0600 | [diff] [blame] | 38 | #include <stddef.h> |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 39 | #include <stdint.h> |
Aaron Durbin | 1ca2d86 | 2015-09-30 12:26:54 -0500 | [diff] [blame] | 40 | #include <boot/coreboot_tables.h> |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 41 | |
| 42 | struct cbmem_entry; |
| 43 | |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 44 | /* |
| 45 | * The dynamic cbmem infrastructure allows for growing cbmem dynamically as |
| 46 | * things are added. It requires an external function, cbmem_top(), to be |
| 47 | * implemented by the board or chipset to define the upper address where |
| 48 | * cbmem lives. This address is required to be a 32-bit address. Additionally, |
| 49 | * the address needs to be consistent in both romstage and ramstage. The |
Martin Roth | 0cb07e3 | 2013-07-09 21:46:01 -0600 | [diff] [blame] | 50 | * dynamic cbmem infrastructure allocates new regions below the last allocated |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 51 | * region. Regions are defined by a cbmem_entry struct that is opaque. Regions |
| 52 | * 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] | 53 | */ |
| 54 | |
| 55 | #define DYN_CBMEM_ALIGN_SIZE (4096) |
Lee Leahy | 522149c | 2015-05-08 11:33:55 -0700 | [diff] [blame] | 56 | #define CBMEM_ROOT_SIZE DYN_CBMEM_ALIGN_SIZE |
| 57 | |
| 58 | /* The root region is at least DYN_CBMEM_ALIGN_SIZE . */ |
| 59 | #define CBMEM_ROOT_MIN_SIZE DYN_CBMEM_ALIGN_SIZE |
| 60 | #define CBMEM_LG_ALIGN CBMEM_ROOT_MIN_SIZE |
| 61 | |
| 62 | /* Small allocation parameters. */ |
| 63 | #define CBMEM_SM_ROOT_SIZE 1024 |
| 64 | #define CBMEM_SM_ALIGN 32 |
| 65 | |
| 66 | /* Determine the size for CBMEM root and the small allocations */ |
| 67 | static inline size_t cbmem_overhead_size(void) |
| 68 | { |
| 69 | return 2 * CBMEM_ROOT_MIN_SIZE; |
| 70 | } |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 71 | |
Kyösti Mälkki | 2d8520b | 2014-01-06 17:20:31 +0200 | [diff] [blame] | 72 | /* By default cbmem is attempted to be recovered. Returns 0 if cbmem was |
| 73 | * recovered or 1 if cbmem had to be reinitialized. */ |
| 74 | int cbmem_initialize(void); |
Lee Leahy | 522149c | 2015-05-08 11:33:55 -0700 | [diff] [blame] | 75 | int cbmem_initialize_id_size(u32 id, u64 size); |
| 76 | |
Martin Roth | 0cb07e3 | 2013-07-09 21:46:01 -0600 | [diff] [blame] | 77 | /* Initialize cbmem to be empty. */ |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 78 | void cbmem_initialize_empty(void); |
Lee Leahy | 522149c | 2015-05-08 11:33:55 -0700 | [diff] [blame] | 79 | void cbmem_initialize_empty_id_size(u32 id, u64 size); |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 80 | |
| 81 | /* Return the top address for dynamic cbmem. The address returned needs to |
| 82 | * be consistent across romstage and ramstage, and it is required to be |
| 83 | * below 4GiB. */ |
| 84 | void *cbmem_top(void); |
| 85 | |
| 86 | /* Add a cbmem entry of a given size and id. These return NULL on failure. The |
| 87 | * add function performs a find first and do not check against the original |
| 88 | * size. */ |
| 89 | const struct cbmem_entry *cbmem_entry_add(u32 id, u64 size); |
| 90 | |
| 91 | /* Find a cbmem entry of a given id. These return NULL on failure. */ |
| 92 | const struct cbmem_entry *cbmem_entry_find(u32 id); |
| 93 | |
| 94 | /* Remove a region defined by a cbmem_entry. Returns 0 on success, < 0 on |
| 95 | * error. Note: A cbmem_entry cannot be removed unless it was the last one |
| 96 | * added. */ |
| 97 | int cbmem_entry_remove(const struct cbmem_entry *entry); |
| 98 | |
| 99 | /* cbmem_entry accessors to get pointer and size of a cbmem_entry. */ |
| 100 | void *cbmem_entry_start(const struct cbmem_entry *entry); |
| 101 | u64 cbmem_entry_size(const struct cbmem_entry *entry); |
| 102 | |
Kyösti Mälkki | 2d8520b | 2014-01-06 17:20:31 +0200 | [diff] [blame] | 103 | /* Returns 0 if old cbmem was recovered. Recovery is only attempted if |
| 104 | * s3resume is non-zero. */ |
| 105 | int cbmem_recovery(int s3resume); |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 106 | /* Add a cbmem entry of a given size and id. These return NULL on failure. The |
| 107 | * add function performs a find first and do not check against the original |
| 108 | * size. */ |
| 109 | void *cbmem_add(u32 id, u64 size); |
| 110 | /* Find a cbmem entry of a given id. These return NULL on failure. */ |
| 111 | void *cbmem_find(u32 id); |
| 112 | |
Aaron Durbin | 41607a4 | 2015-06-09 13:54:10 -0500 | [diff] [blame] | 113 | /* Indicate to each hook if cbmem is being recovered or not. */ |
| 114 | typedef void (* const cbmem_init_hook_t)(int is_recovery); |
| 115 | void cbmem_run_init_hooks(int is_recovery); |
Kyösti Mälkki | 823edda | 2014-12-18 18:30:29 +0200 | [diff] [blame] | 116 | void cbmem_fail_resume(void); |
| 117 | |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 118 | /* Ramstage only functions. */ |
Aaron Durbin | 4904802 | 2014-02-18 21:55:02 -0600 | [diff] [blame] | 119 | /* Add the cbmem memory used to the memory map at boot. */ |
| 120 | void cbmem_add_bootmem(void); |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 121 | void cbmem_list(void); |
Aaron Durbin | 1ca2d86 | 2015-09-30 12:26:54 -0500 | [diff] [blame] | 122 | void cbmem_add_records_to_cbtable(struct lb_header *header); |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 123 | |
Kyösti Mälkki | 4fbac46 | 2015-01-07 04:48:43 +0200 | [diff] [blame] | 124 | #if ENV_RAMSTAGE |
| 125 | #define ROMSTAGE_CBMEM_INIT_HOOK(init_fn_) static cbmem_init_hook_t \ |
| 126 | init_fn_ ## _unused_ __attribute__((unused)) = init_fn_; |
| 127 | #define RAMSTAGE_CBMEM_INIT_HOOK(init_fn_) \ |
| 128 | static cbmem_init_hook_t init_fn_ ## _ptr_ __attribute__((used, \ |
| 129 | section(".rodata.cbmem_init_hooks"))) = init_fn_; |
| 130 | #elif ENV_ROMSTAGE |
| 131 | #define ROMSTAGE_CBMEM_INIT_HOOK(init_fn_) \ |
| 132 | static cbmem_init_hook_t init_fn_ ## _ptr_ __attribute__((used, \ |
| 133 | section(".rodata.cbmem_init_hooks"))) = init_fn_; |
| 134 | #define RAMSTAGE_CBMEM_INIT_HOOK(init_fn_) static cbmem_init_hook_t \ |
| 135 | init_fn_ ## _unused_ __attribute__((unused)) = init_fn_; |
| 136 | #else |
| 137 | #define ROMSTAGE_CBMEM_INIT_HOOK(init_fn_) static cbmem_init_hook_t \ |
| 138 | init_fn_ ## _unused_ __attribute__((unused)) = init_fn_; |
| 139 | #define RAMSTAGE_CBMEM_INIT_HOOK(init_fn_) static cbmem_init_hook_t \ |
| 140 | init_fn_ ## _unused2_ __attribute__((unused)) = init_fn_; |
| 141 | #endif /* ENV_RAMSTAGE */ |
| 142 | |
| 143 | |
Kyösti Mälkki | 2fb6b40 | 2014-12-19 08:20:45 +0200 | [diff] [blame] | 144 | /* These are for compatibility with old boards only. Any new chipset and board |
| 145 | * must implement cbmem_top() for both romstage and ramstage to support |
| 146 | * early features like COLLECT_TIMESTAMPS and CBMEM_CONSOLE. |
| 147 | */ |
| 148 | #if IS_ENABLED(CONFIG_ARCH_X86) && IS_ENABLED(CONFIG_LATE_CBMEM_INIT) |
Aaron Durbin | 28d5ec9 | 2015-05-26 11:15:45 -0500 | [diff] [blame] | 149 | /* Note that many of the current providers of get_top_of_ram() conditionally |
| 150 | * return 0 when the sleep type is non S3. i.e. cold and warm boots would |
| 151 | * return 0 from get_top_of_ram(). */ |
Kyösti Mälkki | 2fb6b40 | 2014-12-19 08:20:45 +0200 | [diff] [blame] | 152 | unsigned long get_top_of_ram(void); |
| 153 | void set_top_of_ram(uint64_t ramtop); |
| 154 | void backup_top_of_ram(uint64_t ramtop); |
| 155 | #endif |
| 156 | |
Aaron Durbin | df3a109 | 2013-03-13 12:41:44 -0500 | [diff] [blame] | 157 | #endif /* __ASSEMBLER__ */ |
| 158 | |
| 159 | |
| 160 | #endif /* _CBMEM_H_ */ |