Silicon function for disabling temporary memory.
- Parameters
-
| [in] | TempRamExitParamPtr | - Pointer to the TempRamExit parameters structure. This structure is normally defined in the Integration Guide. If it is not defined in the Integration Guide, pass NULL. |
- Return values
-
| EFI_SUCCESS | - FSP execution environment was initialized successfully. |
| EFI_INVALID_PARAMETER | - Input parameters are invalid. |
| EFI_UNSUPPORTED | - The FSP calling conditions were not met. |
| EFI_DEVICE_ERROR | - Temporary memory exit. |
This FSP API is called soon after coming out of reset and before memory and stack is available. This FSP API will load the microcode update, enable code caching for the region specified by the boot loader and also setup a temporary stack to be used until main memory is initialized.
A hardcoded stack can be set up with the following values, and the "esp" register initialized to point to this hardcoded stack.
- The return address where the FSP will return control after setting up a temporary stack.
- A pointer to the input parameter structure
However, since the stack is in ROM and not writeable, this FSP API cannot be called using the "call" instruction, but needs to be jumped to.
- Parameters
-
| [in] | FsptUpdDataPtr | Pointer to the FSPT_UPD data structure. |
- Return values
-
| EFI_SUCCESS | Temporary RAM was initialized successfully. |
| EFI_INVALID_PARAMETER | Input parameters are invalid. |
| EFI_UNSUPPORTED | The FSP calling conditions were not met. |
| EFI_DEVICE_ERROR | Temp RAM initialization failed. |
If this function is successful, the FSP initializes the ECX and EDX registers to point to a temporary but writeable memory range available to the boot loader and returns with FSP_SUCCESS in register EAX. Register ECX points to the start of this temporary memory range and EDX points to the end of the range. Boot loader is free to use the whole range described. Typically the boot loader can reload the ESP register to point to the end of this returned range so that it can be used as a standard stack.
This FSP API is used to notify the FSP about the different phases in the boot process. This allows the FSP to take appropriate actions as needed during different initialization phases. The phases will be platform dependent and will be documented with the FSP release. The current FSP supports two notify phases: Post PCI enumeration Ready To Boot
- Parameters
-
| [in] | NotifyPhaseParamPtr | Address pointer to the NOTIFY_PHASE_PRAMS |
- Return values
-
| EFI_SUCCESS | The notification was handled successfully. |
| EFI_UNSUPPORTED | The notification was not called in the proper order. |
| EFI_INVALID_PARAMETER | The notification code is invalid. |
This FSP API is called after TempRamInit and initializes the memory. This FSP API accepts a pointer to a data structure that will be platform dependent and defined for each FSP binary. This will be documented in Integration guide with each FSP release. After FspMemInit completes its execution, it passes the pointer to the HobList and returns to the boot loader from where it was called. BootLoader is responsible to migrate its stack and data to Memory. FspMemoryInit, TempRamExit and FspSiliconInit APIs provide an alternate method to complete the silicon initialization and provides bootloader an opportunity to get control after system memory is available and before the temporary RAM is torn down.
- Parameters
-
| [in] | FspmUpdDataPtr | Pointer to the FSPM_UPD data structure. |
| [out] | HobListPtr | Pointer to receive the address of the HOB list. |
- Return values
-
| EFI_SUCCESS | FSP execution environment was initialized successfully. |
| EFI_INVALID_PARAMETER | Input parameters are invalid. |
| EFI_UNSUPPORTED | The FSP calling conditions were not met. |
| EFI_DEVICE_ERROR | FSP initialization failed. |
| EFI_OUT_OF_RESOURCES | Stack range requested by FSP is not met. |
| FSP_STATUS_RESET_REQUIREDx | A reset is reuired. These status codes will not be returned during S3. |
This FSP API is called after FspMemoryInit API. This FSP API tears down the temporary memory setup by TempRamInit API. This FSP API accepts a pointer to a data structure that will be platform dependent and defined for each FSP binary. This will be documented in Integration Guide. FspMemoryInit, TempRamExit and FspSiliconInit APIs provide an alternate method to complete the silicon initialization and provides bootloader an opportunity to get control after system memory is available and before the temporary RAM is torn down.
- Parameters
-
| [in] | TempRamExitParamPtr | Pointer to the Temp Ram Exit parameters structure. This structure is normally defined in the Integration Guide. And if it is not defined in the Integration Guide, pass NULL. |
- Return values
-
| EFI_SUCCESS | FSP execution environment was initialized successfully. |
| EFI_INVALID_PARAMETER | Input parameters are invalid. |
| EFI_UNSUPPORTED | The FSP calling conditions were not met. |
| EFI_DEVICE_ERROR | FSP initialization failed. |
This FSP API is called after TempRamExit API. FspMemoryInit, TempRamExit and FspSiliconInit APIs provide an alternate method to complete the silicon initialization.
- Parameters
-
| [in] | FspsUpdDataPtr | Pointer to the FSPS_UPD data structure. If NULL, FSP will use the default parameters. |
- Return values
-
| EFI_SUCCESS | FSP execution environment was initialized successfully. |
| EFI_INVALID_PARAMETER | Input parameters are invalid. |
| EFI_UNSUPPORTED | The FSP calling conditions were not met. |
| EFI_DEVICE_ERROR | FSP initialization failed. |
| FSP_STATUS_RESET_REQUIREDx | A reset is required. These status codes will not be returned during S3. |
This FSP API is expected to be called after FspSiliconInit but before FspNotifyPhase. This FSP API provides multi-phase silicon initialization; which brings greater modularity beyond the existing FspSiliconInit() API. Increased modularity is achieved by adding an extra API to FSP-S. This allows the bootloader to add board specific initialization steps throughout the SiliconInit flow as needed.
- Parameters
-
| [in,out] | FSP_MULTI_PHASE_PARAMS | For action - EnumMultiPhaseGetNumberOfPhases: FSP_MULTI_PHASE_PARAMS->MultiPhaseParamPtr will contain how many phases supported by FSP. For action - EnumMultiPhaseExecutePhase: FSP_MULTI_PHASE_PARAMS->MultiPhaseParamPtr shall be NULL. |
- Return values
-
| EFI_SUCCESS | FSP execution environment was initialized successfully. |
| EFI_INVALID_PARAMETER | Input parameters are invalid. |
| EFI_UNSUPPORTED | The FSP calling conditions were not met. |
| EFI_DEVICE_ERROR | FSP initialization failed. |
| FSP_STATUS_RESET_REQUIREDx | A reset is required. These status codes will not be returned during S3. |
1.8.6 
