Aaron Durbin | cddcc80 | 2013-02-08 17:15:53 -0600 | [diff] [blame] | 1 | /* |
| 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. |
Aaron Durbin | cddcc80 | 2013-02-08 17:15:53 -0600 | [diff] [blame] | 14 | */ |
| 15 | #ifndef ROMSTAGE_HANDOFF_H |
| 16 | #define ROMSTAGE_HANDOFF_H |
| 17 | |
| 18 | #include <stdint.h> |
Aaron Durbin | f2b20d8 | 2013-02-11 21:07:18 -0600 | [diff] [blame] | 19 | #include <string.h> |
| 20 | #include <cbmem.h> |
Aaron Durbin | cddcc80 | 2013-02-08 17:15:53 -0600 | [diff] [blame] | 21 | |
Martin Roth | 0cb07e3 | 2013-07-09 21:46:01 -0600 | [diff] [blame] | 22 | /* It is the chipset's responsibility for maintaining the integrity of this |
Aaron Durbin | cddcc80 | 2013-02-08 17:15:53 -0600 | [diff] [blame] | 23 | * structure in CBMEM. For instance, if chipset code adds this structure |
| 24 | * using the CBMEM_ID_ROMSTAGE_INFO id it needs to ensure it doesn't clobber |
| 25 | * fields it doesn't own. */ |
| 26 | struct romstage_handoff { |
Martin Roth | 0cb07e3 | 2013-07-09 21:46:01 -0600 | [diff] [blame] | 27 | /* Indicate if the current boot is an S3 resume. If |
Aaron Durbin | 159f2ef | 2013-02-12 00:50:47 -0600 | [diff] [blame] | 28 | * CONFIG_RELOCTABLE_RAMSTAGE is enabled the chipset code is |
| 29 | * responsible for initializing this variable. Otherwise, ramstage |
| 30 | * will be re-loaded from cbfs (which can be slower since it lives |
| 31 | * in flash). */ |
Duncan Laurie | 24f9476 | 2015-02-25 11:37:32 -0800 | [diff] [blame] | 32 | uint8_t s3_resume; |
| 33 | uint8_t reboot_required; |
| 34 | uint8_t reserved[2]; |
Aaron Durbin | cddcc80 | 2013-02-08 17:15:53 -0600 | [diff] [blame] | 35 | }; |
| 36 | |
Aaron Durbin | f2b20d8 | 2013-02-11 21:07:18 -0600 | [diff] [blame] | 37 | /* The romstage_handoff_find_or_add() function provides the necessary logic |
Martin Roth | 0cb07e3 | 2013-07-09 21:46:01 -0600 | [diff] [blame] | 38 | * for initializing the romstage_handoff structure in cbmem. Different components |
Aaron Durbin | f2b20d8 | 2013-02-11 21:07:18 -0600 | [diff] [blame] | 39 | * of the romstage may be responsible for setting up different fields. Therefore |
| 40 | * that same logic flow should be used for allocating and initializing the |
| 41 | * structure. A newly allocated structure will be memset to 0. */ |
| 42 | static inline struct romstage_handoff *romstage_handoff_find_or_add(void) |
| 43 | { |
| 44 | struct romstage_handoff *handoff; |
| 45 | |
| 46 | /* cbmem_add() first does a find and uses the old location before the |
| 47 | * real add. However, it is important to know when the structure is not |
| 48 | * found so it can be initialized to 0. */ |
| 49 | handoff = cbmem_find(CBMEM_ID_ROMSTAGE_INFO); |
| 50 | |
| 51 | if (handoff == NULL) { |
| 52 | handoff = cbmem_add(CBMEM_ID_ROMSTAGE_INFO, sizeof(*handoff)); |
| 53 | if (handoff != NULL) |
| 54 | memset(handoff, 0, sizeof(*handoff)); |
| 55 | } |
| 56 | |
| 57 | return handoff; |
| 58 | } |
Aaron Durbin | f2b20d8 | 2013-02-11 21:07:18 -0600 | [diff] [blame] | 59 | |
Aaron Durbin | cddcc80 | 2013-02-08 17:15:53 -0600 | [diff] [blame] | 60 | #endif /* ROMSTAGE_HANDOFF_H */ |