/** @file\r
Provides library functions for all PEI Services.\r
\r
-Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
PeiServicesLocatePpi (\r
IN CONST EFI_GUID *Guid,\r
IN UINTN Instance,\r
- IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor,\r
+ IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor, OPTIONAL\r
IN OUT VOID **Ppi\r
);\r
\r
\r
@param SectionType The value of the section type to find.\r
@param SectionInstance Section instance to find.\r
- @param FileHandle A pointer to the file header that contains the set \r
+ @param FileHandle A pointer to the file header that contains the set\r
of sections to be searched.\r
@param SectionData A pointer to the discovered section, if successful.\r
@param AuthenticationStatus A pointer to the authentication status for this section.\r
\r
\r
/**\r
- This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services \r
- Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface \r
- Specification for details. \r
+ This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services\r
+ Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface\r
+ Specification for details.\r
\r
@param FileName A pointer to the name of the file to\r
find within the firmware volume.\r
@param VolumeHandle The firmware volume to search FileHandle\r
Upon exit, points to the found file's\r
handle or NULL if it could not be found.\r
- @param FileHandle Pointer to found file handle \r
+ @param FileHandle Pointer to found file handle\r
\r
@retval EFI_SUCCESS File was found.\r
\r
\r
\r
/**\r
- This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services \r
- Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface \r
- Specification for details. \r
+ This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services\r
+ Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface\r
+ Specification for details.\r
\r
@param FileHandle Handle of the file.\r
\r
information.\r
\r
@retval EFI_SUCCESS File information returned.\r
- \r
+\r
@retval EFI_INVALID_PARAMETER If FileHandle does not\r
represent a valid file.\r
- \r
+\r
@retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r
- \r
+\r
**/\r
EFI_STATUS\r
-EFIAPI \r
+EFIAPI\r
PeiServicesFfsGetFileInfo (\r
IN CONST EFI_PEI_FILE_HANDLE FileHandle,\r
OUT EFI_FV_FILE_INFO *FileInfo\r
information.\r
\r
@retval EFI_SUCCESS File information returned.\r
- \r
+\r
@retval EFI_INVALID_PARAMETER If FileHandle does not\r
represent a valid file.\r
- \r
+\r
@retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r
- \r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
);\r
\r
/**\r
- This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services \r
- Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface \r
- Specification for details. \r
+ This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services\r
+ Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface\r
+ Specification for details.\r
\r
@param VolumeHandle Handle of the volume.\r
\r
information.\r
\r
@retval EFI_SUCCESS File information returned.\r
- \r
+\r
@retval EFI_INVALID_PARAMETER If FileHandle does not\r
represent a valid file.\r
- \r
+\r
@retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r
\r
**/\r
\r
\r
/**\r
- This service is a wrapper for the PEI Service RegisterForShadow(), except the pointer to the PEI Services \r
- Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface \r
- Specification for details. \r
+ This service is a wrapper for the PEI Service RegisterForShadow(), except the pointer to the PEI Services\r
+ Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface\r
+ Specification for details.\r
\r
@param FileHandle PEIM's file handle. Must be the currently\r
executing PEIM.\r
- \r
+\r
@retval EFI_SUCCESS The PEIM was successfully registered for\r
shadowing.\r
\r
\r
/**\r
Install a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance so the PEI Core will be notified about a new firmware volume.\r
- \r
- This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using \r
+\r
+ This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using\r
the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance.\r
If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT().\r
If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT().\r
\r
- \r
+\r
@param FvFormat Unique identifier of the format of the memory-mapped firmware volume.\r
- This parameter is optional and may be NULL. \r
+ This parameter is optional and may be NULL.\r
If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.\r
- @param FvInfo Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. \r
- The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes, \r
+ @param FvInfo Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume.\r
+ The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes,\r
this typically points to the first byte of the firmware volume.\r
- @param FvInfoSize The size, in bytes, of FvInfo. For memory-mapped firmware volumes, \r
+ @param FvInfoSize The size, in bytes, of FvInfo. For memory-mapped firmware volumes,\r
this is typically the size of the firmware volume.\r
- @param ParentFvName If the new firmware volume originated from a file in a different firmware volume, \r
+ @param ParentFvName If the new firmware volume originated from a file in a different firmware volume,\r
then this parameter specifies the GUID name of the originating firmware volume.\r
Otherwise, this parameter must be NULL.\r
- @param ParentFileName If the new firmware volume originated from a file in a different firmware volume, \r
+ @param ParentFileName If the new firmware volume originated from a file in a different firmware volume,\r
then this parameter specifies the GUID file name of the originating firmware file.\r
Otherwise, this parameter must be NULL.\r
**/\r
projects / mirror_edk2.git / blobdiff