| /* SPDX-License-Identifier: GPL-2.0-or-later */ |
| |
| #ifndef _FSP2_0_API_H_ |
| #define _FSP2_0_API_H_ |
| |
| #include <stddef.h> |
| #include <stdint.h> |
| #include <fsp/soc_binding.h> |
| #include <soc/intel/common/mma.h> |
| |
| #define FSP_SUCCESS EFI_SUCCESS |
| #define FSP_INVALID_PARAMETER EFI_INVALID_PARAMETER |
| #define FSP_DEVICE_ERROR EFI_DEVICE_ERROR |
| #define FSP_NOT_FOUND EFI_NOT_FOUND |
| #define FSP_NOT_STARTED EFI_NOT_STARTED |
| #define FSP_UNSUPPORTED EFI_UNSUPPORTED |
| |
| enum fsp_boot_mode { |
| FSP_BOOT_WITH_FULL_CONFIGURATION = 0x00, |
| FSP_BOOT_WITH_MINIMAL_CONFIGURATION = 0x01, |
| FSP_BOOT_ASSUMING_NO_CONFIGURATION_CHANGES = 0x02, |
| FSP_BOOT_ON_S4_RESUME = 0x05, |
| FSP_BOOT_ON_S3_RESUME = 0x11, |
| FSP_BOOT_ON_FLASH_UPDATE = 0x12, |
| FSP_BOOT_IN_RECOVERY_MODE = 0x20 |
| }; |
| |
| enum fsp_notify_phase { |
| AFTER_PCI_ENUM = 0x20, |
| READY_TO_BOOT = 0x40, |
| END_OF_FIRMWARE = 0xF0 |
| }; |
| |
| /* Main FSP stages */ |
| void fsp_memory_init(bool s3wake); |
| void fsp_silicon_init(void); |
| |
| /* |
| * Load FSP-S from stage cache or CBFS. This allows SoCs to load FSPS-S |
| * separately from calling silicon init. It might be required in cases where |
| * stage cache is no longer available by the point SoC calls into silicon init. |
| */ |
| void fsps_load(void); |
| |
| /* Callbacks for updating stage-specific parameters */ |
| void platform_fsp_memory_init_params_cb(FSPM_UPD *mupd, uint32_t version); |
| void platform_fsp_silicon_init_params_cb(FSPS_UPD *supd); |
| /* Callbacks for SoC/Mainboard specific overrides */ |
| void platform_fsp_multi_phase_init_cb(uint32_t phase_index); |
| /* Check if MultiPhase Si Init is enabled */ |
| bool fsp_is_multi_phase_init_enabled(void); |
| /* |
| * The following functions are used when FSP_PLATFORM_MEMORY_SETTINGS_VERSION |
| * is employed allowing the mainboard and SoC to supply their own version |
| * for memory settings respectively. The valid values are 0-15 for each |
| * function. |
| */ |
| uint8_t fsp_memory_mainboard_version(void); |
| uint8_t fsp_memory_soc_version(void); |
| |
| /* Callback after processing FSP notify */ |
| void platform_fsp_notify_status(enum fsp_notify_phase phase); |
| |
| /* Initialize memory margin analysis settings. */ |
| void setup_mma(FSP_M_CONFIG *memory_cfg); |
| /* Update the SOC specific logo param and load the logo. */ |
| void soc_load_logo(FSPS_UPD *supd); |
| /* Update the SOC specific memory config param for mma. */ |
| void soc_update_memory_params_for_mma(FSP_M_CONFIG *memory_cfg, |
| struct mma_config_param *mma_cfg); |
| |
| /* |
| * As per FSP integration guide: |
| * If bootloader needs to take control of APs back, a full AP re-initialization is |
| * required after FSP-S is completed and control has been transferred back to bootloader |
| */ |
| void do_mpinit_after_fsp(void); |
| |
| /* |
| * # DOCUMENTATION: |
| * |
| * This file defines the interface between coreboot and the FSP 2.0 wrapper |
| * fsp_memory_init(), fsp_silicon_init(), and fsp_notify() are the main entry |
| * points and map 1:1 to the FSP entry points of the same name. |
| * |
| * ### fsp_memory_init(): |
| * - s3wake: boolean indicating if the system is waking from resume |
| * |
| * This function is responsible for loading and executing the memory |
| * initialization code from the FSP-M binary. It expects this binary to reside |
| * in cbfs as FSP_M_FILE. |
| * |
| * The function takes one parameter, which is described above, but does not |
| * take in memory parameters as an argument. The memory parameters can be filled |
| * in with platform_fsp_memory_init_params_cb(). This is a callback symbol |
| * that fsp_memory_init() will call. The platform must provide this symbol. |
| * |
| * |
| * ### fsp_silicon_init(): |
| * |
| * This function is responsible for loading and executing the silicon |
| * initialization code from the FSP-S binary. It expects this binary to reside |
| * in cbfs as FSP_S_FILE. |
| * |
| * Like fsp_memory_init(), it provides a callback to fill in FSP-specific |
| * parameters, via platform_fsp_silicon_init_params_cb(). The platform must |
| * also provide this symbol. |
| * |
| * |
| * ### fsp_notify(): |
| * - phase: Which FSP notification phase |
| * |
| * This function is responsible for loading and executing the notify code from |
| * the FSP-S binary. It expects that fsp_silicon_init() has already been called |
| * successfully, and that the FSP-S binary is still loaded into memory. |
| */ |
| |
| #endif /* _FSP2_0_API_H_ */ |