blob: c20b2614bd38555208234ef25e25a6305b231fd7 [file] [log] [blame]
Aaron Durbincddcc802013-02-08 17:15:53 -06001/*
2 * This file is part of the coreboot project.
3 *
4 * Copyright (C) 2013 ChromeOS Authors
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19#ifndef ROMSTAGE_HANDOFF_H
20#define ROMSTAGE_HANDOFF_H
21
22#include <stdint.h>
Aaron Durbinf2b20d82013-02-11 21:07:18 -060023#include <string.h>
24#include <cbmem.h>
Aaron Durbincddcc802013-02-08 17:15:53 -060025
26/* It is the chipset's responsbility for maintaining the integrity of this
27 * structure in CBMEM. For instance, if chipset code adds this structure
28 * using the CBMEM_ID_ROMSTAGE_INFO id it needs to ensure it doesn't clobber
29 * fields it doesn't own. */
30struct romstage_handoff {
31 /* This indicates to the ramstage to reserve a chunk of memory. */
32 uint32_t reserve_base;
33 uint32_t reserve_size;
Aaron Durbinc00457d2013-02-11 21:15:12 -060034 /* Inidicate if the current boot is an S3 resume. */
35 uint32_t s3_resume;
Aaron Durbincddcc802013-02-08 17:15:53 -060036};
37
Aaron Durbinf2b20d82013-02-11 21:07:18 -060038#if defined(__PRE_RAM__)
39/* The romstage_handoff_find_or_add() function provides the necessary logic
40 * for initializng the romstage_handoff structure in cbmem. Different components
41 * of the romstage may be responsible for setting up different fields. Therefore
42 * that same logic flow should be used for allocating and initializing the
43 * structure. A newly allocated structure will be memset to 0. */
44static inline struct romstage_handoff *romstage_handoff_find_or_add(void)
45{
46 struct romstage_handoff *handoff;
47
48 /* cbmem_add() first does a find and uses the old location before the
49 * real add. However, it is important to know when the structure is not
50 * found so it can be initialized to 0. */
51 handoff = cbmem_find(CBMEM_ID_ROMSTAGE_INFO);
52
53 if (handoff == NULL) {
54 handoff = cbmem_add(CBMEM_ID_ROMSTAGE_INFO, sizeof(*handoff));
55 if (handoff != NULL)
56 memset(handoff, 0, sizeof(*handoff));
57 }
58
59 return handoff;
60}
61#endif
62
Aaron Durbincddcc802013-02-08 17:15:53 -060063#endif /* ROMSTAGE_HANDOFF_H */
64