Angel Pons | 32859fc | 2020-04-02 23:48:27 +0200 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
Aaron Durbin | 9a7d7bc | 2013-09-07 00:41:48 -0500 | [diff] [blame] | 2 | |
Duncan Laurie | d8c4f2b | 2014-04-22 10:46:06 -0700 | [diff] [blame] | 3 | #ifndef _COMMON_MRC_CACHE_H_ |
| 4 | #define _COMMON_MRC_CACHE_H_ |
Aaron Durbin | 9a7d7bc | 2013-09-07 00:41:48 -0500 | [diff] [blame] | 5 | |
| 6 | #include <stddef.h> |
| 7 | #include <stdint.h> |
Marshall Dawson | 6344289 | 2017-12-17 14:16:42 -0700 | [diff] [blame] | 8 | #include <commonlib/region.h> |
Aaron Durbin | 9a7d7bc | 2013-09-07 00:41:48 -0500 | [diff] [blame] | 9 | |
Aaron Durbin | 31be2c9 | 2016-12-03 22:08:20 -0600 | [diff] [blame] | 10 | enum { |
| 11 | MRC_TRAINING_DATA, |
| 12 | MRC_VARIABLE_DATA, |
| 13 | }; |
Furquan Shaikh | cab1c01 | 2016-11-05 23:57:02 -0700 | [diff] [blame] | 14 | |
Aaron Durbin | 31be2c9 | 2016-12-03 22:08:20 -0600 | [diff] [blame] | 15 | /* |
| 16 | * It's up to the caller to decide when to retrieve and stash data. There is |
Martin Roth | f48acbd | 2020-07-24 12:24:27 -0600 | [diff] [blame] | 17 | * differentiation on recovery mode CONFIG(HAS_RECOVERY_MRC_CACHE), but that's |
Aaron Durbin | 31be2c9 | 2016-12-03 22:08:20 -0600 | [diff] [blame] | 18 | * only for locating where to retrieve and save the data. If a platform doesn't |
| 19 | * want to update the data then it shouldn't stash the data for saving. |
| 20 | * Similarly, if the platform doesn't need the data for booting because of a |
| 21 | * policy don't request the data. |
| 22 | */ |
Aaron Durbin | 9a7d7bc | 2013-09-07 00:41:48 -0500 | [diff] [blame] | 23 | |
Shelley Chen | ad9cd68 | 2020-07-23 16:10:52 -0700 | [diff] [blame] | 24 | /* Get and stash data for saving provided the type passed in. */ |
| 25 | |
| 26 | /** |
| 27 | * mrc_cache_load_current |
| 28 | * |
| 29 | * Fill in the buffer with the latest slot data. This will be a |
Shelley Chen | 93d483d | 2020-10-06 15:14:24 -0700 | [diff] [blame] | 30 | * common entry point for ARM platforms. Returns < 0 on error, size |
| 31 | * of the returned data on success. |
Shelley Chen | ad9cd68 | 2020-07-23 16:10:52 -0700 | [diff] [blame] | 32 | */ |
Shelley Chen | 93d483d | 2020-10-06 15:14:24 -0700 | [diff] [blame] | 33 | ssize_t mrc_cache_load_current(int type, uint32_t version, void *buffer, |
| 34 | size_t buffer_size); |
Shelley Chen | ad9cd68 | 2020-07-23 16:10:52 -0700 | [diff] [blame] | 35 | /** |
| 36 | * mrc_cache_mmap_leak |
| 37 | * |
| 38 | * Return a pointer to a buffer with the latest slot data. An mmap |
| 39 | * will be executed (without a matching unmap). This will be a common |
| 40 | * entry point for platforms where mmap is considered a noop, like x86 |
| 41 | */ |
| 42 | void *mrc_cache_current_mmap_leak(int type, uint32_t version, |
| 43 | size_t *data_size); |
| 44 | /** |
| 45 | * Returns < 0 on error, 0 on success. |
| 46 | */ |
Aaron Durbin | 31be2c9 | 2016-12-03 22:08:20 -0600 | [diff] [blame] | 47 | int mrc_cache_stash_data(int type, uint32_t version, const void *data, |
Shelley Chen | ad9cd68 | 2020-07-23 16:10:52 -0700 | [diff] [blame] | 48 | size_t size); |
Duncan Laurie | d8c4f2b | 2014-04-22 10:46:06 -0700 | [diff] [blame] | 49 | |
Subrata Banik | e48f24d | 2023-08-31 14:38:38 +0000 | [diff] [blame] | 50 | /** |
| 51 | * API to locate the FSP Non-Volatile Storage Data (aka memory training data) |
| 52 | * and store into the NVS. |
| 53 | */ |
| 54 | void save_memory_training_data(void); |
| 55 | |
Duncan Laurie | d8c4f2b | 2014-04-22 10:46:06 -0700 | [diff] [blame] | 56 | #endif /* _COMMON_MRC_CACHE_H_ */ |