diff options
Diffstat (limited to 'IntelFrameworkPkg/Include/Ppi')
-rw-r--r-- | IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h | 79 | ||||
-rw-r--r-- | IntelFrameworkPkg/Include/Ppi/FindFv.h | 68 | ||||
-rw-r--r-- | IntelFrameworkPkg/Include/Ppi/FvLoadFile.h | 68 | ||||
-rw-r--r-- | IntelFrameworkPkg/Include/Ppi/PciCfg.h | 110 | ||||
-rw-r--r-- | IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h | 132 | ||||
-rw-r--r-- | IntelFrameworkPkg/Include/Ppi/S3Resume.h | 76 | ||||
-rw-r--r-- | IntelFrameworkPkg/Include/Ppi/SectionExtraction.h | 107 | ||||
-rw-r--r-- | IntelFrameworkPkg/Include/Ppi/Security.h | 68 | ||||
-rw-r--r-- | IntelFrameworkPkg/Include/Ppi/Smbus.h | 232 |
9 files changed, 0 insertions, 940 deletions
diff --git a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h deleted file mode 100644 index db0f422da8..0000000000 --- a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h +++ /dev/null @@ -1,79 +0,0 @@ -/** @file
- This file declares the Boot Script Executer PPI.
-
- This PPI is published by a PEIM upon dispatch and provides an execution engine for the
- Framework boot script. This PEIM should be platform neutral and have no specific knowledge of
- platform instructions or other information. The ability to interpret the boot script depends on the
- abundance of other PPIs that are available. For example, if the script requests an SMBus command
- execution, the PEIM looks for a relevant PPI that is available to execute it, rather than executing it
- by issuing the native IA-32 instruction.
-
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials are licensed and made available under
-the terms and conditions of the BSD License that accompanies this distribution.
-The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php.
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
- @par Revision Reference:
- This PPI is defined in Framework of EFI BootScript spec.
- Version 0.91.
-
-**/
-
-#ifndef _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_
-#define _PEI_BOOT_SCRIPT_EXECUTER_PPI_H_
-
-#define EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI_GUID \
- { \
- 0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0x0b, 0xfb, 0xff } \
- }
-
-typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI;
-
-/**
- Executes the Framework boot script table.
-
- @param PeiServices A pointer to the system PEI Services Table.
- @param This A pointer to the EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI instance.
- @param Address The physical memory address where the table is stored.
- It must be zero if the table to be executed is stored in
- a firmware volume file.
- @param FvFile The firmware volume file name that contains the table to
- be executed. It must be NULL if the table to be executed
- is stored in physical memory.
-
- @retval EFI_SUCCESS The boot script table was executed successfully.
- @retval EFI_INVALID_PARAMETER Address is zero and FvFile is NULL.
- @retval EFI_NOT_FOUND The file name specified in FvFile cannot be found.
- @retval EFI_UNSUPPORTED The format of the boot script table is invalid.
- Or, an unsupported opcode occurred in the table.
- Or there were opcode execution errors, such as an
- insufficient dependency.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE)(
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI *This,
- IN EFI_PHYSICAL_ADDRESS Address,
- IN EFI_GUID *FvFile OPTIONAL
- );
-
-///
-/// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and
-/// executes the Framework boot script table.
-///
-struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {
- ///
- /// Executes a boot script table.
- ///
- EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;
-};
-
-extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;
-
-#endif
diff --git a/IntelFrameworkPkg/Include/Ppi/FindFv.h b/IntelFrameworkPkg/Include/Ppi/FindFv.h deleted file mode 100644 index 14a9f82dab..0000000000 --- a/IntelFrameworkPkg/Include/Ppi/FindFv.h +++ /dev/null @@ -1,68 +0,0 @@ -/** @file
- This file declares FindFv PPI, which is used to locate FVs that contain PEIMs in PEI.
-
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials are licensed and made available under
-the terms and conditions of the BSD License that accompanies this distribution.
-The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php.
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
- @par Revision Reference:
- This PPI is defined in PEI CIS
- Version 0.91.
-
-**/
-
-#ifndef _FIND_FV_H_
-#define _FIND_FV_H_
-
-///
-/// Inconsistent with specification here:
-/// GUID value format has been changed to the standard GUID format.
-///
-#define EFI_PEI_FIND_FV_PPI_GUID \
- { \
- 0x36164812, 0xa023, 0x44e5, {0xbd, 0x85, 0x5, 0xbf, 0x3c, 0x77, 0x0, 0xaa } \
- }
-
-typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI;
-
-/**
- This interface returns the base address of the firmware volume whose index
- was passed in FvNumber. Once this function reports a firmware volume
- index/base address pair, that index/address pairing must continue throughout PEI.
-
- @param PeiServices The pointer to the PEI Services Table.
- @param This Interface pointer that implements the Find FV service.
- @param FvNumber The index of the firmware volume to locate.
- @param FvAddress The address of the volume to discover.
-
- @retval EFI_SUCCESS An additional firmware volume was found.
- @retval EFI_OUT_OF_RESOURCES There are no firmware volumes for the given FvNumber.
- @retval EFI_INVALID_PARAMETER *FvAddress is NULL.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_FIND_FV_FINDFV)(
- IN EFI_PEI_FIND_FV_PPI *This,
- IN EFI_PEI_SERVICES **PeiServices,
- IN UINT8 *FvNumber,
- IN OUT EFI_FIRMWARE_VOLUME_HEADER **FVAddress
- );
-
-/**
- Hardware mechanisms for locating FVs in a platform vary widely.
- EFI_PEI_FIND_FV_PPI serves to abstract this variation so that the
- PEI Foundation can remain standard across a wide variety of platforms.
-**/
-struct _EFI_PEI_FIND_FV_PPI {
- EFI_PEI_FIND_FV_FINDFV FindFv; ///< Service that abstracts the location of additional firmware volumes.
-};
-
-extern EFI_GUID gEfiFindFvPpiGuid;
-
-#endif
diff --git a/IntelFrameworkPkg/Include/Ppi/FvLoadFile.h b/IntelFrameworkPkg/Include/Ppi/FvLoadFile.h deleted file mode 100644 index b19be053ae..0000000000 --- a/IntelFrameworkPkg/Include/Ppi/FvLoadFile.h +++ /dev/null @@ -1,68 +0,0 @@ -/** @file
- Load image file from fv to memory.
-
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials are licensed and made available under
-the terms and conditions of the BSD License that accompanies this distribution.
-The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php.
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
- @par Revision Reference:
- This PPI is defined in PEI CIS spec Version 0.91.
-
-**/
-
-#ifndef _FV_FILE_LOADER_PPI_H_
-#define _FV_FILE_LOADER_PPI_H_
-
-#define EFI_PEI_FV_FILE_LOADER_GUID \
- { \
- 0x7e1f0d85, 0x4ff, 0x4bb2, {0x86, 0x6a, 0x31, 0xa2, 0x99, 0x6a, 0x48, 0xa8 } \
- }
-
-typedef struct _EFI_PEI_FV_FILE_LOADER_PPI EFI_PEI_FV_FILE_LOADER_PPI;
-
-/**
- Loads a PEIM into memory for subsequent execution.
-
- @param This Interface pointer that implements the Load File PPI instance.
- @param FfsHeader The pointer to the FFS header of the file to load.
- @param ImageAddress The pointer to the address of the loaded Image
- @param ImageSize The pointer to the size of the loaded image.
- @param EntryPoint The pointer to the entry point of the image.
-
- @retval EFI_SUCCESS The image was loaded successfully.
- @retval EFI_OUT_OF_RESOURCES There was not enough memory.
- @retval EFI_INVALID_PARAMETER The contents of the FFS file did not
- contain a valid PE/COFF image that could be loaded.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_FV_LOAD_FILE)(
- IN EFI_PEI_FV_FILE_LOADER_PPI *This,
- IN EFI_FFS_FILE_HEADER *FfsHeader,
- OUT EFI_PHYSICAL_ADDRESS *ImageAddress,
- OUT UINT64 *ImageSize,
- OUT EFI_PHYSICAL_ADDRESS *EntryPoint
- );
-
-/**
- This PPI is a pointer to the Load File service. This service will be
- published by a PEIM. The PEI Foundation will use this service to
- launch the known non-XIP PE/COFF PEIM images. This service may
- depend upon the presence of the EFI_PEI_PERMANENT_MEMORY_INSTALLED_PPI.
-**/
-struct _EFI_PEI_FV_FILE_LOADER_PPI {
- ///
- /// Loads a PEIM into memory for subsequent execution.
- ///
- EFI_PEI_FV_LOAD_FILE FvLoadFile;
-};
-
-extern EFI_GUID gEfiPeiFvFileLoaderPpiGuid;
-
-#endif
diff --git a/IntelFrameworkPkg/Include/Ppi/PciCfg.h b/IntelFrameworkPkg/Include/Ppi/PciCfg.h deleted file mode 100644 index ded452a16c..0000000000 --- a/IntelFrameworkPkg/Include/Ppi/PciCfg.h +++ /dev/null @@ -1,110 +0,0 @@ -/** @file
- This file declares the PciCfg PPI used to access the PCI configuration space in PEI
-
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials are licensed and made available under
-the terms and conditions of the BSD License that accompanies this distribution.
-The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php.
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
- @par Revision Reference:
- This PPI is defined in PEI CIS
- Version 0.91.
-
-**/
-
-#ifndef __PEI_PCI_CFG_H__
-#define __PEI_PCI_CFG_H__
-
-#include <Ppi/PciCfg2.h>
-//
-// Get the common definitions for EFI_PEI_PCI_CFG_PPI_WIDTH.
-//
-
-#define EFI_PEI_PCI_CFG_PPI_INSTALLED_GUID \
- { \
- 0xe1f2eba0, 0xf7b9, 0x4a26, {0x86, 0x20, 0x13, 0x12, 0x21, 0x64, 0x2a, 0x90 } \
- }
-
-typedef struct _EFI_PEI_PCI_CFG_PPI EFI_PEI_PCI_CFG_PPI;
-
-#define PEI_PCI_CFG_ADDRESS(bus, dev, func, reg) ( \
- (UINT64) ((((UINTN) bus) << 24) + (((UINTN) dev) << 16) + (((UINTN) func) << 8) + ((UINTN) reg)) \
- ) & 0x00000000ffffffff
-
-/**
- PCI read and write operation.
-
- @param PeiServices An indirect pointer to the PEI Services Table
- published by the PEI Foundation.
- @param This Pointer to local data for the interface.
- @param Width The width of the access. Enumerated in bytes.
- @param Address The physical address of the access.
- @param Buffer A pointer to the buffer of data.
-
- @retval EFI_SUCCESS The function completed successfully.
- @retval EFI_NOT_YET_AVAILABLE The service has not been installed.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_PCI_CFG_PPI_IO)(
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_PCI_CFG_PPI *This,
- IN EFI_PEI_PCI_CFG_PPI_WIDTH Width,
- IN UINT64 Address,
- IN OUT VOID *Buffer
- );
-
-/**
- PCI read-modify-write operation.
-
- @param PeiServices An indirect pointer to the PEI Services Table
- published by the PEI Foundation.
- @param This The pointer to local data for the interface.
- @param Width The width of the access. Enumerated in bytes.
- @param Address The physical address of the access.
- @param SetBits Value of the bits to set.
- @param ClearBits Value of the bits to clear.
-
- @retval EFI_SUCCESS The function completed successfully.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_PCI_CFG_PPI_RW)(
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_PCI_CFG_PPI *This,
- IN EFI_PEI_PCI_CFG_PPI_WIDTH Width,
- IN UINT64 Address,
- IN UINTN SetBits,
- IN UINTN ClearBits
- );
-
-/**
- The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI
- controllers behind a PCI root bridge controller.
-**/
-struct _EFI_PEI_PCI_CFG_PPI {
- ///
- /// PCI read services. See the Read() function description.
- ///
- EFI_PEI_PCI_CFG_PPI_IO Read;
-
- ///
- /// PCI write services. See the Write() function description.
- ///
- EFI_PEI_PCI_CFG_PPI_IO Write;
-
- ///
- /// PCI read-modify-write services. See the Modify() function description.
- ///
- EFI_PEI_PCI_CFG_PPI_RW Modify;
-};
-
-extern EFI_GUID gEfiPciCfgPpiInServiceTableGuid;
-
-#endif
diff --git a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h deleted file mode 100644 index 167e3a8892..0000000000 --- a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h +++ /dev/null @@ -1,132 +0,0 @@ -/** @file
- This file declares the Read-only Variable Service PPI, which is required by the framework spec.
-
- These services provide a lightweight, read-only variant of the full EFI variable services. The
- reason that these services are read-only is to reduce the complexity of flash management. Also,
- some implementation of the PEI may use the same physical flash part for variable and PEIM
- storage. As such, a write command to certain technologies would alter the contents of the entire part,
- making the PEIM execution in the original position not follow the required flow.
-
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials are licensed and made available under
-the terms and conditions of the BSD License that accompanies this distribution.
-The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php.
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
- @par Revision Reference:
- This PPI is defined in PEI CIS
- Version 0.91.
-**/
-
-#ifndef __PEI_READ_ONLY_VARIABLE_PPI_H__
-#define __PEI_READ_ONLY_VARIABLE_PPI_H__
-
-#define EFI_PEI_READ_ONLY_VARIABLE_ACCESS_PPI_GUID \
- { \
- 0x3cdc90c6, 0x13fb, 0x4a75, {0x9e, 0x79, 0x59, 0xe9, 0xdd, 0x78, 0xb9, 0xfa } \
- }
-
-typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI EFI_PEI_READ_ONLY_VARIABLE_PPI;
-
-///
-/// Variable attributes.
-///@{
-#define EFI_VARIABLE_NON_VOLATILE 0x00000001
-#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
-#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
-///
-/// Inconsistent with specification here:
-/// In Framework Spec, PeiCis0.91, neither the macro or its value is defined.
-/// Keeping this inconsistancy for backward compatibility.
-///
-#define EFI_VARIABLE_READ_ONLY 0x00000008
-///@}
-
-/**
- Get Variable value by Name and GUID pair.
-
- @param[in] PeiServices An indirect pointer to the PEI Services Table published
- by the PEI Foundation.
- @param[in] VariableName A NULL-terminated Unicode string that is the name of the vendor's variable.
- @param[in] VendorGuid A unique identifier for the vendor.
- @param[out] Attributes This OPTIONAL parameter may be either NULL or
- a pointer to the location in which to return
- the attributes bitmask for the variable.
- @param[in,out] DataSize On input, the size in bytes of the return Data buffer.
- On output, the size of data returned in Data.
- @param[out] Data The buffer to return the contents of the variable.
-
- @retval EFI_SUCCESS The function completed successfully.
- @retval EFI_NOT_FOUND The variable was not found.
- @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.
- @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
- @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_GET_VARIABLE)(
- IN EFI_PEI_SERVICES **PeiServices,
- IN CHAR16 *VariableName,
- IN EFI_GUID *VendorGuid,
- OUT UINT32 *Attributes OPTIONAL,
- IN OUT UINTN *DataSize,
- OUT VOID *Data
- );
-
-/**
- This function can be called multiple times to retrieve the VariableName
- and VendorGuid of all variables currently available in the system. On each call
- to GetNextVariableName(), the previous results are passed into the interface,
- and on output the interface returns the next variable name data. When the
- entire variable list has been returned, the error EFI_NOT_FOUND is returned.
-
- @param[in] PeiServices An indirect pointer to the PEI Services Table
- published by the PEI Foundation.
- @param[in] VariableNameSize The size of the VariableName buffer.
- @param[in] VariableName On input, supplies the last VariableName that was
- returned by GetNextVariableName(). On output,
- returns the Null-terminated Unicode string of the
- current variable.
- @param[in] VendorGuid On input, supplies the last VendorGuid that was
- returned by GetNextVariableName(). On output,
- returns the VendorGuid of the current variable.
-
- @retval EFI_SUCCESS The function completed successfully.
- @retval EFI_NOT_FOUND The next variable was not found.
- @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.
- @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
- @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to
- a hardware error.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_GET_NEXT_VARIABLE_NAME)(
- IN EFI_PEI_SERVICES **PeiServices,
- IN OUT UINTN *VariableNameSize,
- IN OUT CHAR16 *VariableName,
- IN OUT EFI_GUID *VendorGuid
- );
-
-///
-/// This PPI provides a lightweight, read-only variant of the full EFI
-/// variable services.
-///
-struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {
- ///
- /// Inconsistent with specification here:
- /// In Framework Spec, PeiCis0.91, the field is named as GetVariable and GetNextVariableName.
- /// Keeping this inconsistancy for backward compatibility.
- ///
- EFI_PEI_GET_VARIABLE PeiGetVariable; ///< A service to ascertain a given variable name.
- EFI_PEI_GET_NEXT_VARIABLE_NAME PeiGetNextVariableName; ///< A service to ascertain a variable based upon a given, known variable
-};
-
-extern EFI_GUID gEfiPeiReadOnlyVariablePpiGuid;
-
-#endif /* __PEI_READ_ONLY_VARIABLE_PPI_H__ */
-
diff --git a/IntelFrameworkPkg/Include/Ppi/S3Resume.h b/IntelFrameworkPkg/Include/Ppi/S3Resume.h deleted file mode 100644 index f786056235..0000000000 --- a/IntelFrameworkPkg/Include/Ppi/S3Resume.h +++ /dev/null @@ -1,76 +0,0 @@ -/** @file
- This file declares S3 Resume PPI which accomplishes the firmware S3 resume boot path
- and transfers control to OS.
-
- This PPI is published by the S3 resume PEIM and can be used on the S3 resume boot path to
- restore the platform to its preboot configuration and transfer control to OS. The information that is
- required for an S3 resume can be saved during the normal boot path using
- EFI_ACPI_S3_SAVE_PROTOCOL. This presaved information can then be restored in the S3
- resume boot path using EFI_PEI_S3_RESUME_PPI. Architecturally, the S3 resume PEIM is the
- last PEIM to be dispatched in the S3 resume boot path.
- Before using this PPI, the caller must ensure the necessary information for the S3 resume, such as
- the following, is available for the S3 resume boot path:
- - EFI_ACPI_S3_RESUME_SCRIPT_TABLE script table. Type
- EFI_ACPI_S3_RESUME_SCRIPT_TABLE is defined in the Intel Platform Innovation
- Framework for EFI Boot Script Specification.
- - OS waking vector.
- - The reserved memory range to be used for the S3 resume.
- Otherwise, the S3 resume boot path may fail.
-
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials are licensed and made available under
-the terms and conditions of the BSD License that accompanies this distribution.
-The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php.
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
- @par Revision Reference:
- This PPI is defined in Framework for EFI S3 Resume Boot Path spec.
- Version 0.9.
-
-**/
-
-#ifndef __PEI_S3_RESUME_PPI_H__
-#define __PEI_S3_RESUME_PPI_H__
-
-#define EFI_PEI_S3_RESUME_PPI_GUID \
- { \
- 0x4426CCB2, 0xE684, 0x4a8a, {0xAE, 0x40, 0x20, 0xD4, 0xB0, 0x25, 0xB7, 0x10 } \
- }
-
-typedef struct _EFI_PEI_S3_RESUME_PPI EFI_PEI_S3_RESUME_PPI;
-
-/**
- Restores the platform to its preboot configuration for an S3 resume and
- jumps to the OS waking vector.
-
- @param PeiServices The pointer to the PEI Services Table
-
- @retval EFI_ABORTED Execution of the S3 resume boot script table failed.
- @retval EFI_NOT_FOUND Could not be locate some necessary information that
- is used for the S3 resume boot path d.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG)(
- IN EFI_PEI_SERVICES **PeiServices
- );
-
-/**
- EFI_PEI_S3_RESUME_PPI accomplishes the firmware S3 resume boot
- path and transfers control to OS.
-**/
-struct _EFI_PEI_S3_RESUME_PPI {
- ///
- /// Restores the platform to its preboot configuration for an S3 resume and
- /// jumps to the OS waking vector.
- ///
- EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG S3RestoreConfig;
-};
-
-extern EFI_GUID gEfiPeiS3ResumePpiGuid;
-
-#endif
diff --git a/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h b/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h deleted file mode 100644 index e1b5a06321..0000000000 --- a/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h +++ /dev/null @@ -1,107 +0,0 @@ -/** @file
- This file declares the Section Extraction PPI.
-
- This PPI is defined in PEI CIS version 0.91. It supports encapsulating sections,
- such as GUIDed sections used to authenticate the file encapsulation of other domain-specific wrapping.
-
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials are licensed and made available under
-the terms and conditions of the BSD License that accompanies this distribution.
-The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php.
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-**/
-
-#ifndef __SECTION_EXTRACTION_H__
-#define __SECTION_EXTRACTION_H__
-
-#define EFI_PEI_SECTION_EXTRACTION_PPI_GUID \
- { \
- 0x4F89E208, 0xE144, 0x4804, {0x9E, 0xC8, 0x0F, 0x89, 0x4F, 0x7E, 0x36, 0xD7 } \
- }
-
-typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI;
-
-//
-// Bit values for AuthenticationStatus
-//
-#define EFI_AUTH_STATUS_PLATFORM_OVERRIDE 0x01
-#define EFI_AUTH_STATUS_IMAGE_SIGNED 0x02
-#define EFI_AUTH_STATUS_NOT_TESTED 0x04
-#define EFI_AUTH_STATUS_TEST_FAILED 0x08
-
-/**
- The function is used to retrieve a section from within a section file.
- It will retrieve both encapsulation sections and leaf sections in their entirety,
- exclusive of the section header.
-
- @param PeiServices The pointer to the PEI Services Table.
- @param This Indicates the calling context
- @param SectionType The pointer to an EFI_SECTION_TYPE. If
- SectionType == NULL, the contents of the entire
- section are returned in Buffer. If SectionType
- is not NULL, only the requested section is returned.
- @param SectionDefinitionGuid The pointer to an EFI_GUID.
- If SectionType == EFI_SECTION_GUID_DEFINED,
- SectionDefinitionGuid indicates for which section
- GUID to search. If SectionType != EFI_SECTION_GUID_DEFINED,
- SectionDefinitionGuid is unused and is ignored.
- @param SectionInstance If SectionType is not NULL, indicates which
- instance of the requested section type to return.
- @param Buffer The pointer to a pointer to a buffer in which the
- section contents are returned.
- @param BufferSize A pointer to a caller-allocated UINT32. On input,
- *BufferSize indicates the size in bytes of the
- memory region pointed to by Buffer. On output,
- *BufferSize contains the number of bytes required
- to read the section.
- @param AuthenticationStatus A pointer to a caller-allocated UINT32 in
- which any metadata from encapsulating GUID-defined
- sections is returned.
-
- @retval EFI_SUCCESS The section was successfully processed, and the section
- contents were returned in Buffer.
- @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in
- the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED
- bit set, but there was no corresponding GUIDed
- Section Extraction Protocol in the handle database.
- *Buffer is unmodified.
- @retval EFI_NOT_FOUND The requested section does not exist.*Buffer is
- unmodified.
- @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process
- the request.
- @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
- @retval EFI_WARN_TOO_SMALL The size of the input buffer is insufficient to
- contain the requested section. The input buffer
- is filled and contents are section contents are
- truncated.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_GET_SECTION)(
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_SECTION_EXTRACTION_PPI *This,
- IN EFI_SECTION_TYPE *SectionType,
- IN EFI_GUID *SectionDefinitionGuid, OPTIONAL
- IN UINTN SectionInstance,
- IN VOID **Buffer,
- IN OUT UINT32 *BufferSize,
- OUT UINT32 *AuthenticationStatus
- );
-
-/**
- This PPI supports encapsulating sections, such as GUIDed sections used to
- authenticate the file encapsulation of other domain-specific wrapping.
-**/
-struct _EFI_PEI_SECTION_EXTRACTION_PPI {
- EFI_PEI_GET_SECTION GetSection; ///< Retrieves a section from within a section file.
-};
-
-extern EFI_GUID gEfiPeiSectionExtractionPpiGuid;
-
-#endif
-
diff --git a/IntelFrameworkPkg/Include/Ppi/Security.h b/IntelFrameworkPkg/Include/Ppi/Security.h deleted file mode 100644 index 200bc3ca49..0000000000 --- a/IntelFrameworkPkg/Include/Ppi/Security.h +++ /dev/null @@ -1,68 +0,0 @@ -/** @file
- This file declares the Security Architectural PPI.
-
- This PPI is installed by a platform PEIM that abstracts the security policy to the PEI
- Foundation, namely the case of a PEIM's authentication state being returned during the PEI section
- extraction process.
-
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials are licensed and made available under
-the terms and conditions of the BSD License that accompanies this distribution.
-The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php.
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
- @par Revision Reference:
- This PPI is defined in PEI CIS.
- Version 0.91.
-
-**/
-
-#ifndef __SECURITY_PPI_H__
-#define __SECURITY_PPI_H__
-
-#define EFI_PEI_SECURITY_PPI_GUID \
- { \
- 0x1388066e, 0x3a57, 0x4efa, {0x98, 0xf3, 0xc1, 0x2f, 0x3a, 0x95, 0x8a, 0x29 } \
- }
-
-typedef struct _EFI_PEI_SECURITY_PPI EFI_PEI_SECURITY_PPI;
-
-/**
- Allows the platform builder to implement a security policy in response
- to varying file authentication states.
-
- @param PeiServices The pointer to the PEI Services Table.
- @param This Interface pointer that implements the particular
- EFI_PEI_SECURITY_PPI instance.
- @param AuthenticationStatus Status returned by the verification service as
- part of section extraction.
- @param FfsFileHeader The pointer to the file under review.
- @param DeferExecution The pointer to a variable that alerts the PEI
- Foundation to defer execution of a PEIM.
-
- @retval EFI_SUCCESS The service performed its action successfully.
- @retval EFI_SECURITY_VIOLATION The object cannot be trusted.
-**/
-typedef
-EFI_STATUS
-(EFIAPI *FRAMEWORK_EFI_PEI_SECURITY_AUTHENTICATION_STATE)(
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_SECURITY_PPI *This,
- IN UINT32 AuthenticationStatus,
- IN EFI_FFS_FILE_HEADER *FfsFileHeader,
- IN OUT BOOLEAN *DeferExecution
- );
-
-//
-// PPI interface structure of Security PPI
-//
-struct _EFI_PEI_SECURITY_PPI {
- FRAMEWORK_EFI_PEI_SECURITY_AUTHENTICATION_STATE AuthenticationState;
-};
-
-extern EFI_GUID gEfiPeiSecurityPpiGuid;
-
-#endif
diff --git a/IntelFrameworkPkg/Include/Ppi/Smbus.h b/IntelFrameworkPkg/Include/Ppi/Smbus.h deleted file mode 100644 index 2a95fef5ea..0000000000 --- a/IntelFrameworkPkg/Include/Ppi/Smbus.h +++ /dev/null @@ -1,232 +0,0 @@ -/** @file
- This file declares the Smbus PPI, which provides the basic I/O interfaces that a PEIM
- uses to access its SMBus controller and the slave devices attached to it.
-
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials are licensed and made available under
-the terms and conditions of the BSD License that accompanies this distribution.
-The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php.
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
- @par Revision Reference:
- This PPI is defined in Framework of EFI SmBus PPI spec.
- Version 0.9.
-
-**/
-
-#ifndef _PEI_SMBUS_PPI_H_
-#define _PEI_SMBUS_PPI_H_
-
-#include <Ppi/Smbus2.h>
-
-#define EFI_PEI_SMBUS_PPI_GUID \
- { \
- 0xabd42895, 0x78cf, 0x4872, {0x84, 0x44, 0x1b, 0x5c, 0x18, 0xb, 0xfb, 0xda } \
- }
-
-typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
-
-/**
- Executes an SMBus operation to an SMBus controller.
-
- @param[in] PeiServices A pointer to the system PEI Services Table.
- @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.
- @param[in] SlaveAddress The SMBUS hardware address to which the SMBUS
- device is preassigned or allocated.
- @param[in] Command This command is transmitted by the SMBus host
- controller to the SMBus slave device, and the
- interpretation is SMBus slave device specific.
- @param[in] Operation Signifies which particular SMBus hardware protocol
- instance to use to execute the SMBus transactions.
- @param[in] PecCheck Defines if Packet Error Code (PEC) checking is
- required for this operation.
- @param[in, out] Length The number of bytes for this operation.
- @param[in, out] Buffer Contains the value of data to execute to the SMBus
- slave device.
-
- @retval EFI_SUCCESS The last data that was returned from the access
- matched the poll exit criteria.
- @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect).
- @retval EFI_TIMEOUT Timeout expired before the operation was completed.
- Timeout is determined by the SMBus host controller device.
- @retval EFI_OUT_OF_RESOURCES The request could not be completed
- due to a lack of resources.
- @retval EFI_DEVICE_ERROR The request was not completed because a failure
- was recorded in the Host Status Register bit.
- @retval EFI_INVALID_PARAMETER The operation is not defined in EFI_SMBUS_OPERATION.
- @retval EFI_INVALID_PARAMETER Length/Buffer is NULL for operations except for
- EfiSmbusQuickRead and EfiSmbusQuickWrite. Length
- is outside the range of valid values.
- @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
- @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION)(
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_SMBUS_PPI *This,
- IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
- IN EFI_SMBUS_DEVICE_COMMAND Command,
- IN EFI_SMBUS_OPERATION Operation,
- IN BOOLEAN PecCheck,
- IN OUT UINTN *Length,
- IN OUT VOID *Buffer
- );
-
-/**
- This function is user-defined, and is called when the SlaveAddress/Data pair happens.
-
- @param[in] PeiServices A pointer to the system PEI Services Table.
- @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.
- @param[in] SlaveAddress The SMBUS hardware address to which the SMBUS
- device is preassigned or allocated.
- @param[in] Data Data of the SMBus host notify command, which denotes that
- the caller wants to be called.
-
- @return Status Code returned by callback function.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_SMBUS_NOTIFY_FUNCTION)(
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_SMBUS_PPI *SmbusPpi,
- IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
- IN UINTN Data
- );
-
-/**
- The ArpDevice() function enumerates either the entire bus or a specific
- device identified by SmbusUdid.
-
- @param[in] PeiServices A pointer to the system PEI Services Table.
- @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.
- @param[in] ArpAll A Boolean expression that indicates if the host
- drivers need to enumerate all the devices or to
- enumerate only the device that is identified
- by SmbusUdid. If ArpAll is TRUE, SmbusUdid and
- SlaveAddress are optional and ignored if entered.
- If ArpAll is FALSE, ArpDevice will enumerate
- SmbusUdid, and the address will be at SlaveAddress.
- @param[in] SmbusUdid The targeted SMBus Unique Device Identifier (UDID).
- The UDID may not exist for SMBus devices with fixed
- addresses.
- @param[in, out] SlaveAddress The new SMBus address for the slave device for
- which the operation is targeted.
- This address may be NULL.
-
- @retval EFI_SUCCESS The SMBus slave device address was set.
- @retval EFI_INVALID_PARAMETER SlaveAddress is NULL.
- @retval EFI_OUT_OF_RESOURCES The request could not be completed
- due to a lack of resources.
- @retval EFI_TIMEOUT The SMBus slave device did not respond.
- @retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.
- @retval EFI_UNSUPPORTED ArpDevice() is not implemented by this PEIM.
- This return value is not defined in the Framework Specification.
- This return value was introduced in the PI Specification.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_SMBUS_PPI_ARP_DEVICE)(
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_SMBUS_PPI *This,
- IN BOOLEAN ArpAll,
- IN EFI_SMBUS_UDID *SmbusUdid, OPTIONAL
- IN OUT EFI_SMBUS_DEVICE_ADDRESS *SlaveAddress OPTIONAL
- );
-
-/**
- The GetArpMap() function returns the mapping of all the SMBus devices
- that are enumerated by the SMBus host driver.
-
- @param[in] PeiServices A pointer to the system PEI Services Table.
- @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.
- @param[in, out] Length The size of the buffer that contains the SMBus device map.
- @param[in, out] SmbusDeviceMap The pointer to the device map as enumerated
- by the SMBus controller driver.
-
- @retval EFI_SUCCESS The device map was returned correctly in the buffer.
- @retval EFI_UNSUPPORTED GetArpMap() are not implemented by this PEIM.
- This return value was not defined in the Framework Specification.
- This return value was introduced in the PI Specification.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_SMBUS_PPI_GET_ARP_MAP)(
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_SMBUS_PPI *This,
- IN OUT UINTN *Length,
- IN OUT EFI_SMBUS_DEVICE_MAP **SmbusDeviceMap
- );
-
-/**
- Allows a device driver to register for a callback when the bus driver detects a state that it needs to
- propagate to other PEIMs that are registered for a callback.
-
- The Notify() function registers all the callback functions to allow the
- bus driver to call these functions when the SlaveAddress/Data pair occur.
- All functions to be registered with EFI_PEI_SMBUS_PPI_NOTIFY must be of type
- EFI_PEI_SMBUS_NOTIFY_FUNCTION.
-
- @param[in] PeiServices A pointer to the system PEI Services Table.
- @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.
- @param[in] SlaveAddress The address that the host controller detects as
- sending a message and triggers all the registered functions.
- @param[in] Data Data that the host controller detects as sending a message
- and triggers all the registered functions.
- @param[in] NotifyFunction The function to call when the bus driver
- detects the SlaveAddress and Data pair.
-
- @retval EFI_SUCCESS NotifyFunction has been registered.
- @retval EFI_UNSUPPORTED Notify() are not implemented by this PEIM.
- This return value is not defined in the Framework Specification.
- This return value was introduced in the PI Specification.
-
-**/
-typedef
-EFI_STATUS
-(EFIAPI *EFI_PEI_SMBUS_PPI_NOTIFY)(
- IN EFI_PEI_SERVICES **PeiServices,
- IN EFI_PEI_SMBUS_PPI *This,
- IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
- IN UINTN Data,
- IN EFI_PEI_SMBUS_NOTIFY_FUNCTION NotifyFunction
- );
-
-///
-/// Provides the basic I/O interfaces that a PEIM uses to access
-/// its SMBus controller and the slave devices attached to it.
-///
-struct _EFI_PEI_SMBUS_PPI {
- ///
- /// Executes the SMBus operation to an SMBus slave device.
- ///
- EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION Execute;
-
- ///
- /// Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)
- ///
- EFI_PEI_SMBUS_PPI_ARP_DEVICE ArpDevice;
-
- ///
- /// Allows a PEIM to retrieve the address that was allocated by the SMBus
- /// host controller during enumeration/ARP.
- ///
- EFI_PEI_SMBUS_PPI_GET_ARP_MAP GetArpMap;
-
- ///
- /// Allows a driver to register for a callback to the SMBus host
- /// controller driver when the bus issues a notification to the bus controller PEIM.
- ///
- EFI_PEI_SMBUS_PPI_NOTIFY Notify;
-};
-
-extern EFI_GUID gEfiPeiSmbusPpiGuid;
-
-#endif
|