blob: beb626b9dcb58fcb3e36a6ab644bd6a6f2987fab [file] [log] [blame]
Stefan Reinauer3b314022009-10-26 17:04:28 +00001/*
2 * This file is part of the coreboot project.
3 *
4 * Copyright (C) 2009 coresystems GmbH
Aaron Durbindf3a1092013-03-13 12:41:44 -05005 * Copyright (C) 2013 Google, Inc.
Stefan Reinauer3b314022009-10-26 17:04:28 +00006 *
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
Stefan Reinauer3b314022009-10-26 17:04:28 +000024#if CONFIG_HAVE_ACPI_RESUME
Aaron Durbin8e4a3552013-02-08 17:28:04 -060025#if CONFIG_RELOCATABLE_RAMSTAGE
26#define HIGH_MEMORY_SAVE 0
27#else
zbaof7223732012-04-13 13:42:15 +080028#define HIGH_MEMORY_SAVE (CONFIG_RAMTOP - CONFIG_RAMBASE)
Aaron Durbin8e4a3552013-02-08 17:28:04 -060029#endif
30
Stefan Reinauer61f4a742012-04-03 16:21:04 -070031/* Delegation of resume backup memory so we don't have to
32 * (slowly) handle backing up OS memory in romstage.c
33 */
34#define CBMEM_BOOT_MODE 0x610
35#define CBMEM_RESUME_BACKUP 0x614
zbaof7223732012-04-13 13:42:15 +080036#endif /* CONFIG_HAVE_ACPI_RESUME */
Stefan Reinauer3b314022009-10-26 17:04:28 +000037
38#define CBMEM_ID_FREESPACE 0x46524545
39#define CBMEM_ID_GDT 0x4c474454
40#define CBMEM_ID_ACPI 0x41435049
Duncan Laurie11290c42012-10-03 19:07:05 -070041#define CBMEM_ID_ACPI_GNVS 0x474e5653
Duncan Laurie9c07c8f2013-03-22 11:08:39 -070042#define CBMEM_ID_ACPI_GNVS_PTR 0x474e5650
Stefan Reinauer3b314022009-10-26 17:04:28 +000043#define CBMEM_ID_CBTABLE 0x43425442
44#define CBMEM_ID_PIRQ 0x49525154
45#define CBMEM_ID_MPTABLE 0x534d5054
46#define CBMEM_ID_RESUME 0x5245534d
zbaof7223732012-04-13 13:42:15 +080047#define CBMEM_ID_RESUME_SCRATCH 0x52455343
Sven Schnelle164bcfd2011-08-14 20:56:34 +020048#define CBMEM_ID_SMBIOS 0x534d4254
Vadim Bendebury6f72d692011-09-21 16:12:39 -070049#define CBMEM_ID_TIMESTAMP 0x54494d45
Stefan Reinauer61f4a742012-04-03 16:21:04 -070050#define CBMEM_ID_MRCDATA 0x4d524344
Vadim Bendeburybe25a4d2011-09-30 11:13:06 -070051#define CBMEM_ID_CONSOLE 0x434f4e53
Duncan Laurie215f27852012-10-10 14:34:49 -070052#define CBMEM_ID_ELOG 0x454c4f47
Stefan Reinauerd37ab452012-12-18 16:23:28 -080053#define CBMEM_ID_COVERAGE 0x47434f56
Aaron Durbina1db81b42013-02-08 17:11:28 -060054#define CBMEM_ID_ROMSTAGE_INFO 0x47545352
Aaron Durbindf3a1092013-03-13 12:41:44 -050055#define CBMEM_ID_ROMSTAGE_RAM_STACK 0x90357ac4
56#define CBMEM_ID_RAMSTAGE 0x9a357a9e
57#define CBMEM_ID_RAMSTAGE_CACHE 0x9a3ca54e
58#define CBMEM_ID_ROOT 0xff4007ff
Aaron Durbin0c6946d2013-03-13 12:48:33 -050059#define CBMEM_ID_VBOOT_HANDOFF 0x780074f0
Aaron Durbin716738a2013-05-10 00:33:32 -050060#define CBMEM_ID_CAR_GLOBALS 0xcac4e6a3
Kyösti Mälkki690bf2f2013-07-06 11:41:21 +030061#define CBMEM_ID_EHCI_DEBUG 0xe4c1deb9
Aaron Durbinbf18b172013-10-24 10:11:08 -050062#define CBMEM_ID_REFCODE 0x04efc0de
63#define CBMEM_ID_REFCODE_CACHE 0x4efc0de5
Aaron Durbin00bf3db2014-01-09 10:33:23 -060064#define CBMEM_ID_POWER_STATE 0x50535454
Aaron Durbinb4b9eb32014-02-13 10:26:18 -060065#define CBMEM_ID_SMM_SAVE_SPACE 0x07e9acee
Aaron Durbin06ece7d2014-02-14 00:30:04 -060066#define CBMEM_ID_RAM_OOPS 0x05430095
Stefan Reinauer3b314022009-10-26 17:04:28 +000067#define CBMEM_ID_NONE 0x00000000
Rudolf Marek5ce05062013-05-27 16:09:44 +020068#define CBMEM_ID_AGESA_RUNTIME 0x41474553
Marc Jones54b8e7a2013-10-29 17:57:30 -060069#define CBMEM_ID_HOB_POINTER 0x484f4221
Stefan Reinauer3b314022009-10-26 17:04:28 +000070
Stefan Reinauer61f4a742012-04-03 16:21:04 -070071#ifndef __ASSEMBLER__
Aaron Durbin0f333072014-01-30 17:19:46 -060072#include <stddef.h>
Aaron Durbindf3a1092013-03-13 12:41:44 -050073#include <stdint.h>
74
75struct cbmem_entry;
76
77#if CONFIG_DYNAMIC_CBMEM
78
79/*
80 * The dynamic cbmem infrastructure allows for growing cbmem dynamically as
81 * things are added. It requires an external function, cbmem_top(), to be
82 * implemented by the board or chipset to define the upper address where
83 * cbmem lives. This address is required to be a 32-bit address. Additionally,
84 * the address needs to be consistent in both romstage and ramstage. The
Martin Roth0cb07e32013-07-09 21:46:01 -060085 * dynamic cbmem infrastructure allocates new regions below the last allocated
Aaron Durbindf3a1092013-03-13 12:41:44 -050086 * region. Regions are defined by a cbmem_entry struct that is opaque. Regions
87 * may be removed, but the last one added is the only that can be removed.
88 *
89 * Dynamic cbmem has two allocators within it. All allocators use a top down
90 * allocation scheme. However, there are 2 modes for each allocation depending
91 * on the requested size. There are large allocations and small allocations.
92 * An allocation is considered to be small when it is less than or equal to
93 * DYN_CBMEM_ALIGN_SIZE / 2. The smaller allocations are fit into a larger
94 * allocation region.
95 */
96
97#define DYN_CBMEM_ALIGN_SIZE (4096)
98
Kyösti Mälkki2d8520b2014-01-06 17:20:31 +020099/* By default cbmem is attempted to be recovered. Returns 0 if cbmem was
100 * recovered or 1 if cbmem had to be reinitialized. */
101int cbmem_initialize(void);
Martin Roth0cb07e32013-07-09 21:46:01 -0600102/* Initialize cbmem to be empty. */
Aaron Durbindf3a1092013-03-13 12:41:44 -0500103void cbmem_initialize_empty(void);
104
105/* Return the top address for dynamic cbmem. The address returned needs to
106 * be consistent across romstage and ramstage, and it is required to be
107 * below 4GiB. */
108void *cbmem_top(void);
109
110/* Add a cbmem entry of a given size and id. These return NULL on failure. The
111 * add function performs a find first and do not check against the original
112 * size. */
113const struct cbmem_entry *cbmem_entry_add(u32 id, u64 size);
114
115/* Find a cbmem entry of a given id. These return NULL on failure. */
116const struct cbmem_entry *cbmem_entry_find(u32 id);
117
118/* Remove a region defined by a cbmem_entry. Returns 0 on success, < 0 on
119 * error. Note: A cbmem_entry cannot be removed unless it was the last one
120 * added. */
121int cbmem_entry_remove(const struct cbmem_entry *entry);
122
123/* cbmem_entry accessors to get pointer and size of a cbmem_entry. */
124void *cbmem_entry_start(const struct cbmem_entry *entry);
125u64 cbmem_entry_size(const struct cbmem_entry *entry);
126
Aaron Durbindf3a1092013-03-13 12:41:44 -0500127
128#else /* !CONFIG_DYNAMIC_CBMEM */
129
Kyösti Mälkki4dba06a2014-01-04 09:42:02 +0200130/* Allocation with static CBMEM is resolved at build time. We start
131 * with 128kB and conditionally add some of the most greedy CBMEM
132 * table entries.
133 */
134#define _CBMEM_SZ_MINIMAL ( 128 * 1024 )
135
136#if CONFIG_HAVE_ACPI_RESUME
137#define _CBMEM_SZ_RESUME (HIGH_MEMORY_SAVE + CONFIG_HIGH_SCRATCH_MEMORY_SIZE)
138#else
139#define _CBMEM_SZ_RESUME 0
140#endif
141
142#define _CBMEM_SZ_TOTAL \
143 (_CBMEM_SZ_MINIMAL + _CBMEM_SZ_RESUME + CONFIG_CONSOLE_CBMEM_BUFFER_SIZE)
144
145#define HIGH_MEMORY_SIZE ALIGN_UP(_CBMEM_SZ_TOTAL, 0x10000)
146
147
Stefan Reinauer61f4a742012-04-03 16:21:04 -0700148#ifndef __PRE_RAM__
Kyösti Mälkki2b790f62013-09-03 05:25:57 +0300149void set_top_of_ram(uint64_t ramtop);
Kyösti Mälkkibc90e152013-09-04 13:26:11 +0300150void backup_top_of_ram(uint64_t ramtop);
Kyösti Mälkki1ae305e2013-09-04 13:05:01 +0300151void cbmem_late_set_table(uint64_t base, uint64_t size);
Stefan Reinauer61f4a742012-04-03 16:21:04 -0700152#endif
153
Kyösti Mälkkic04afd62013-09-04 13:31:39 +0300154void get_cbmem_table(uint64_t *base, uint64_t *size);
Kyösti Mälkkif9f74af2013-09-06 10:46:22 +0300155struct cbmem_entry *get_cbmem_toc(void);
Rudolf Marek475916d2010-12-13 20:02:23 +0000156
Aaron Durbin0f333072014-01-30 17:19:46 -0600157static inline const struct cbmem_entry *cbmem_entry_find(uint32_t id)
158{
159 return NULL;
160}
Aaron Durbindf3a1092013-03-13 12:41:44 -0500161#endif /* CONFIG_DYNAMIC_CBMEM */
162
163/* Common API between cbmem and dynamic cbmem. */
164
Kyösti Mälkkidcb688e2013-09-04 01:11:16 +0300165unsigned long get_top_of_ram(void);
166
Kyösti Mälkki2d8520b2014-01-06 17:20:31 +0200167/* Returns 0 if old cbmem was recovered. Recovery is only attempted if
168 * s3resume is non-zero. */
169int cbmem_recovery(int s3resume);
Aaron Durbindf3a1092013-03-13 12:41:44 -0500170/* Add a cbmem entry of a given size and id. These return NULL on failure. The
171 * add function performs a find first and do not check against the original
172 * size. */
173void *cbmem_add(u32 id, u64 size);
174/* Find a cbmem entry of a given id. These return NULL on failure. */
175void *cbmem_find(u32 id);
176
Rudolf Marek33109342010-12-11 22:26:10 +0000177#ifndef __PRE_RAM__
Aaron Durbindf3a1092013-03-13 12:41:44 -0500178/* Ramstage only functions. */
Aaron Durbin49048022014-02-18 21:55:02 -0600179/* Add the cbmem memory used to the memory map at boot. */
180void cbmem_add_bootmem(void);
Aaron Durbindf3a1092013-03-13 12:41:44 -0500181void cbmem_list(void);
182void cbmem_arch_init(void);
Aaron Durbindf3a1092013-03-13 12:41:44 -0500183void cbmem_print_entry(int n, u32 id, u64 start, u64 size);
Kyösti Mälkkicb28f3f2014-01-03 15:15:22 +0200184void cbmem_fail_resume(void);
Aaron Durbindf3a1092013-03-13 12:41:44 -0500185#else
186static inline void cbmem_arch_init(void) {}
Kyösti Mälkkicb28f3f2014-01-03 15:15:22 +0200187static inline void cbmem_fail_resume(void) {}
Aaron Durbindf3a1092013-03-13 12:41:44 -0500188#endif /* __PRE_RAM__ */
189
190#endif /* __ASSEMBLER__ */
191
192
193#endif /* _CBMEM_H_ */