tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Code Scrub for header files in MdePkg/Include/Ppi and Uefi directory. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5500 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4 2008-07-16 10:44:37 +00:00
parent b1f6a7c636
commit d713251286
20 changed files with 163 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
MdePkg/Include/Ppi/CpuIo.h
View File

@ -1,7 +1,8 @@
/** @file /** @file
This file declares CPU IO PPI that abstracts CPU IO access This PPI provides a set of memory- and I/O-based services.
The perspective of the services is that of the processor, not the bus or system.
Copyright (c) 2006, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -90,7 +91,7 @@ typedef struct {
@param This Pointer to local data for the interface. @param This Pointer to local data for the interface.
@param Address The physical address of the access. @param Address The physical address of the access.
@return UINT8 @return UINT8 An 8-bit value is returned from the I/O space.
**/ **/
typedef typedef
@ -108,7 +109,7 @@ UINT8
@param This Pointer to local data for the interface. @param This Pointer to local data for the interface.
@param Address The physical address of the access. @param Address The physical address of the access.
@return UINT16 @return UINT16 A 16-bit value is returned from the I/O space.
**/ **/
typedef typedef
@ -126,7 +127,7 @@ UINT16
@param This Pointer to local data for the interface. @param This Pointer to local data for the interface.
@param Address The physical address of the access. @param Address The physical address of the access.
@return UINT32 @return UINT32 A 32-bit value is returned from the I/O space.
**/ **/
typedef typedef
@ -144,7 +145,7 @@ UINT32
@param This Pointer to local data for the interface. @param This Pointer to local data for the interface.
@param Address The physical address of the access. @param Address The physical address of the access.
@return UINT64 @return UINT64 A 64-bit value is returned from the I/O space.
**/ **/
typedef typedef
@ -242,7 +243,7 @@ VOID
@param This Pointer to local data for the interface. @param This Pointer to local data for the interface.
@param Address The physical address of the access. @param Address The physical address of the access.
@return UINT8 @return UINT8 An 8-bit value is returned from the memory space.
**/ **/
typedef typedef
@ -260,7 +261,7 @@ UINT8
@param This Pointer to local data for the interface. @param This Pointer to local data for the interface.
@param Address The physical address of the access. @param Address The physical address of the access.
@return UINT16 @return UINT16 A 16-bit value is returned from the memory space.
**/ **/
typedef typedef
@ -278,7 +279,7 @@ UINT16
@param This Pointer to local data for the interface. @param This Pointer to local data for the interface.
@param Address The physical address of the access. @param Address The physical address of the access.
@return UINT32 @return UINT32 A 32-bit value is returned from the memory space.
**/ **/
typedef typedef
@ -296,7 +297,7 @@ UINT32
@param This Pointer to local data for the interface. @param This Pointer to local data for the interface.
@param Address The physical address of the access. @param Address The physical address of the access.
@return UINT64 @return UINT64 A 64-bit value is returned from the memory space.
**/ **/
typedef typedef

4
MdePkg/Include/Ppi/Decompress.h
View File

@ -1,7 +1,7 @@
/** @file /** @file
Provides decompression services to the PEI Foundatoin. Provides decompression services to the PEI Foundatoin.
Copyright (c) 2006, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -24,6 +24,8 @@
typedef struct _EFI_PEI_DECOMPRESS_PPI EFI_PEI_DECOMPRESS_PPI; typedef struct _EFI_PEI_DECOMPRESS_PPI EFI_PEI_DECOMPRESS_PPI;
/** /**
Decompress a single compression section in a firmware file.
Decompresses the data in a compressed section and returns it Decompresses the data in a compressed section and returns it
as a series of standard PI Firmware File Sections. The as a series of standard PI Firmware File Sections. The
required memory is allocated from permanent memory. required memory is allocated from permanent memory.

9
MdePkg/Include/Ppi/DxeIpl.h
View File

@ -1,8 +1,8 @@
/** @file /** @file
This file declares DXE Initial Program Load PPI. This file declares DXE Initial Program Load PPI.
When the PEI core is done it calls the DXE IPL via this PPI. When the PEI core is done it calls the DXE IPL PPI to load the DXE Foundation.
Copyright (c) 2006, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -35,8 +35,9 @@ typedef struct _EFI_DXE_IPL_PPI EFI_DXE_IPL_PPI;
@param PeiServices Pointer to the PEI Services Table. @param PeiServices Pointer to the PEI Services Table.
@param HobList Pointer to the list of Hand-Off Block (HOB) entries. @param HobList Pointer to the list of Hand-Off Block (HOB) entries.
@retval EFI_SUCCESS Upon this return code, the PEI Foundation should enter @retval EFI_SUCCESS Upon this return code, the PEI Foundation should enter
some exception handling.Under normal circumstances, the DXE IPL PPI should not return. some exception handling.Under normal circumstances,
the DXE IPL PPI should not return.
**/ **/
typedef typedef

8
MdePkg/Include/Ppi/EndOfPeiPhase.h
View File

@ -1,8 +1,10 @@
/** @file /** @file
PPI to be used to signal when the PEI ownership of the memory map This PPI will be installed at the end of PEI for all boot paths, including
officially ends and DXE will take over normal, recovery, and S3. It allows for PEIMs to possibly quiesce hardware,
build handoff information for the next phase of execution,
or provide some terminal processing behavior.
Copyright (c) 2006, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at

39
MdePkg/Include/Ppi/FirmwareVolume.h
View File

@ -29,6 +29,8 @@ typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI EFI_PEI_FIRMWARE_VOLUME_PPI;
/** /**
Process a firmware volume and create a volume handle.
Create a volume handle from the information in the buffer. For Create a volume handle from the information in the buffer. For
memory-mapped firmware volumes, Buffer and BufferSize refer to memory-mapped firmware volumes, Buffer and BufferSize refer to
the start of the firmware volume and the firmware volume size. the start of the firmware volume and the firmware volume size.
@ -60,34 +62,11 @@ EFI_STATUS
OUT EFI_PEI_FV_HANDLE *FvHandle OUT EFI_PEI_FV_HANDLE *FvHandle
); );
/** /**
Create a volume handle from the information in the buffer. For Finds the next file of the specified type.
memory-mapped firmware volumes, Buffer and BufferSize refer to
the start of the firmware volume and the firmware volume size.
For non memory-mapped firmware volumes, this points to a
buffer which contains the necessary information for creating
the firmware volume handle. Normally, these values are derived
from the EFI_FIRMWARE_VOLUME_INFO_PPI.
This service enables PEI modules to discover additional firmware files.
@param This Points to this instance of the The FileHandle must be unique within the system.
EFI_PEI_FIRMWARE_VOLUME_PPI
@param Buffer Points to the start of the buffer.
@param BufferSize Size of the buffer.
@param FvHandle Points to the returned firmware volume
handle. The firmware volume handle must
be unique within the system.
@retval EFI_SUCCESS Firmware volume handle.
@retval EFI_VOLUME_CORRUPTED Volume was corrupt.
**/
/**
This service enables PEI modules to discover additional firmware files. The FileHandle must be
unique within the system.
@param This Points to this instance of the @param This Points to this instance of the
EFI_PEI_FIRMWARE_VOLUME_PPI. SearchType A filter EFI_PEI_FIRMWARE_VOLUME_PPI. SearchType A filter
@ -104,8 +83,7 @@ EFI_STATUS
@retval EFI_SUCCESS The file was found. @retval EFI_SUCCESS The file was found.
@retval EFI_NOT_FOUND The file was not found. FileHandle @retval EFI_NOT_FOUND The file was not found. FileHandle contains NULL.
contains NULL.
**/ **/
typedef EFI_STATUS typedef EFI_STATUS
(EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE)( (EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE)(
@ -117,6 +95,7 @@ typedef EFI_STATUS
/** /**
Find a file within a volume by its name.
This service searches for files with a specific name, within This service searches for files with a specific name, within
either the specified firmware volume or all firmware volumes. either the specified firmware volume or all firmware volumes.
@ -156,6 +135,8 @@ EFI_STATUS
/** /**
Returns information about a specific file.
This function returns information about a specific This function returns information about a specific
file, including its file name, type, attributes, starting file, including its file name, type, attributes, starting
address and size. address and size.
@ -211,6 +192,8 @@ EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_INFO)(
); );
/** /**
Find the next matching section in the firmware file.
This service enables PEI modules to discover sections of a given type within a valid file. This service enables PEI modules to discover sections of a given type within a valid file.
@param This Points to this instance of the @param This Points to this instance of the

9
MdePkg/Include/Ppi/GuidedSectionExtraction.h
View File

@ -2,9 +2,9 @@
If a GUID-defined section is encountered when doing section extraction, If a GUID-defined section is encountered when doing section extraction,
the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance
calls the appropriate instance of the GUIDed Section Extraction PPI calls the appropriate instance of the GUIDed Section Extraction PPI
to extract the section stream contained therein.. to extract the section stream contained therein.
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -39,6 +39,9 @@ typedef struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI EFI_PEI_GUIDED_SECTION_E
/** /**
Processes the input section and returns the data contained therein
along with the authentication status.
The ExtractSection() function processes the input section and The ExtractSection() function processes the input section and
returns a pointer to the section contents. If the section being returns a pointer to the section contents. If the section being
extracted does not require processing (if the section extracted does not require processing (if the section
@ -85,7 +88,7 @@ typedef struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI EFI_PEI_GUIDED_SECTION_E
@retval EFI_OUT_OF_RESOURCES The system has insufficient @retval EFI_OUT_OF_RESOURCES The system has insufficient
resources to process the request. resources to process the request.
@reteval EFI_INVALID_PARAMETER The GUID in InputSection does @retval EFI_INVALID_PARAMETER The GUID in InputSection does
not match this instance of the not match this instance of the
GUIDed Section Extraction PPI. GUIDed Section Extraction PPI.
**/ **/

8
MdePkg/Include/Ppi/LoadFile.h
View File

@ -25,6 +25,8 @@
typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI; typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;
/** /**
Loads a PEIM into memory for subsequent execution.
This service is the single member function of EFI_LOAD_FILE_PPI. This service separates This service is the single member function of EFI_LOAD_FILE_PPI. This service separates
image loading and relocating from the PEI Foundation. image loading and relocating from the PEI Foundation.
@ -57,11 +59,9 @@ typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;
@retval EFI_OUT_OF_RESOURCES There was not enough memory. @retval EFI_OUT_OF_RESOURCES There was not enough memory.
@retval EFI_LOAD_ERROR There was no supported image in @retval EFI_LOAD_ERROR There was no supported image in
the file EFI_INVALID_PARAMETER the file.
FileHandle was not a valid
firmware file handle.
@retval EFI_INVALID_PARAMETER EntryPoint was NULL. @retval EFI_INVALID_PARAMETER EntryPoint was NULL.
Or FileHandle was not a valid firmware file handle.
@retval EFI_NOT_SUPPORTED An image requires relocations or @retval EFI_NOT_SUPPORTED An image requires relocations or
is not memory mapped. is not memory mapped.

5
MdePkg/Include/Ppi/MasterBootMode.h
View File

@ -1,10 +1,11 @@
/** @file /** @file
This file declares Boot Mode PPI This file declares Boot Mode PPI.
The Master Boot Mode PPI is installed by a PEIM to signal that a final The Master Boot Mode PPI is installed by a PEIM to signal that a final
boot has been determined and set. This signal is useful in that PEIMs boot has been determined and set. This signal is useful in that PEIMs
with boot-mode-specific behavior can put this PPI in their dependency expression. with boot-mode-specific behavior can put this PPI in their dependency expression.
Copyright (c) 2006, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at

13
MdePkg/Include/Ppi/MemoryDiscovered.h
View File

@ -1,10 +1,11 @@
/** @file /** @file
This file declares Memory Discovered PPI. This file declares Memory Discovered PPI.
This PPI is installed by the PEI Foundation at the point of system
evolution when the permanent memory size has been registered and
waiting PEIMs can use the main memory store.
Copyright (c) 2006, Intel Corporation This PPI is published by the PEI Foundation when the main memory is installed.
It is essentially a PPI with no associated interface. Its purpose is to be used
as a signal for other PEIMs who can register for a notification on its installation.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -14,8 +15,8 @@
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@par Revision Reference: @par Revision Reference:
This PPI is defined in PEI CIS This PPI is defined in PI
Version 0.91. Version 1.0.
**/ **/

10
MdePkg/Include/Ppi/PciCfg2.h
View File

@ -1,7 +1,10 @@
/** @file /** @file
This file declares PciCfg PPI used to access PCI configuration space in PEI This file declares PciCfg2 PPI.
Copyright (c) 2006 - 2007, Intel Corporation This ppi Provides platform or chipset-specific access to
the PCI configuration space for a specific PCI segment.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -92,7 +95,8 @@ EFI_STATUS
/** /**
PCI read-modify-write operation. Performs a read-modify-write operation on the contents
from a given location in the PCI configuration space.
@param PeiServices An indirect pointer to the PEI Services Table @param PeiServices An indirect pointer to the PEI Services Table
published by the PEI Foundation. published by the PEI Foundation.

9
MdePkg/Include/Ppi/ReadOnlyVariable2.h
View File

@ -1,7 +1,8 @@
/** @file /** @file
This file declares Read-only Variable Service PPI This file declares Read-only Variable Service2 PPI.
This ppi permits read-only access to the UEFI variable store during the PEI phase.
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -26,6 +27,8 @@
typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI EFI_PEI_READ_ONLY_VARIABLE2_PPI; typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI EFI_PEI_READ_ONLY_VARIABLE2_PPI;
/** /**
This service retrieves a variable's value using its name and GUID.
Read the specified variable from the UEFI variable store. If the Data Read the specified variable from the UEFI variable store. If the Data
buffer is too small to hold the contents of the variable, buffer is too small to hold the contents of the variable,
the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the
@ -73,6 +76,8 @@ EFI_STATUS
/** /**
Return the next variable name and GUID.
This function is called multiple times to retrieve the VariableName This function is called multiple times to retrieve the VariableName
and VariableGuid of all variables currently available in the system. and VariableGuid of all variables currently available in the system.
On each call, the previous results are passed into the interface, On each call, the previous results are passed into the interface,

16
MdePkg/Include/Ppi/Reset.h
View File

@ -1,7 +1,10 @@
/** @file /** @file
This file declares Reset PPI used to reset the platform This file declares Reset PPI used to reset the platform.
Copyright (c) 2006, Intel Corporation This PPI is installed by some platform- or chipset-specific PEIM that
abstracts the Reset Service to other agents.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -19,11 +22,20 @@
#ifndef __RESET_PPI_H__ #ifndef __RESET_PPI_H__
#define __RESET_PPI_H__ #define __RESET_PPI_H__
#include <Pi/PiPeiCis.h>
#define EFI_PEI_RESET_PPI_GUID \ #define EFI_PEI_RESET_PPI_GUID \
{ \ { \
0xef398d58, 0x9dfd, 0x4103, {0xbf, 0x94, 0x78, 0xc6, 0xf4, 0xfe, 0x71, 0x2f } \ 0xef398d58, 0x9dfd, 0x4103, {0xbf, 0x94, 0x78, 0xc6, 0xf4, 0xfe, 0x71, 0x2f } \
} }
/**
This PPI provides provide a simple reset service.
@param ResetSystem
A service to reset the entire platform.
**/
typedef struct { typedef struct {
EFI_PEI_RESET_SYSTEM ResetSystem; EFI_PEI_RESET_SYSTEM ResetSystem;
} EFI_PEI_RESET_PPI; } EFI_PEI_RESET_PPI;

37
MdePkg/Include/Ppi/SecPlatformInformation.h
View File

@ -1,7 +1,12 @@
/** @file /** @file
This file declares Sec Platform Information PPI. This file declares Sec Platform Information PPI.
Copyright (c) 2006 - 2007, Intel Corporation This service is the primary handoff state into the PEI Foundation.
The Security (SEC) component creates the early, transitory memory
environment and also encapsulates knowledge of at least the
location of the Boot Firmware Volume (BFV).
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -29,6 +34,8 @@ typedef struct _EFI_SEC_PLATFORM_INFORMATION_PPI EFI_SEC_PLATFORM_INFORMATION_PP
// //
// EFI_HEALTH_FLAGS // EFI_HEALTH_FLAGS
// Contains information generated by microcode, hardware, and/or the Itanium
// processor PAL code about the state of the processor upon reset.
// //
typedef union { typedef union {
struct { struct {
@ -44,27 +51,6 @@ typedef union {
UINT32 Uint32; UINT32 Uint32;
} EFI_HEALTH_FLAGS; } EFI_HEALTH_FLAGS;
/**
@param BootPhase entry r20 value.
@param UniqueId PAL arbitration ID.
@param HealthStat Health Status
@param PALRetAddress Return address to PAL
**/
/*
typedef struct {
UINTN BootPhase;
UINTN UniqueId;
UINTN HealthStat;
UINTN PALRetAddress;
} IPF_HANDOFF_STATUS;
*/
#define NORMAL_BOOT_CALL 0x0 #define NORMAL_BOOT_CALL 0x0
#define RECOVERY_CHECK_CALL 0x3 #define RECOVERY_CHECK_CALL 0x3
@ -116,9 +102,12 @@ EFI_STATUS
/** /**
Ppi Description: This service abstracts platform-specific information. It is necessary
to convey this information to the PEI Foundation so that it can
discover where to begin dispatching PEIMs.
@param Name @param PlatformInformation
Conveys state information out of the SEC phase into PEI.
**/ **/
struct _EFI_SEC_PLATFORM_INFORMATION_PPI { struct _EFI_SEC_PLATFORM_INFORMATION_PPI {

12
MdePkg/Include/Ppi/Security2.h
View File

@ -1,7 +1,11 @@
/** @file /** @file
This file declares Security2 Architectural PPI. This file declares Pei Security2 PPI.
Copyright (c) 2006 - 2007, Intel Corporation This PPI is installed by some 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 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -26,6 +30,8 @@
typedef struct _EFI_PEI_SECURITY2_PPI EFI_PEI_SECURITY2_PPI; typedef struct _EFI_PEI_SECURITY2_PPI EFI_PEI_SECURITY2_PPI;
/** /**
Allows the platform builder to implement a security policy
in response to varying file authentication states.
This service is published by some platform PEIM. The purpose of This service is published by some platform PEIM. The purpose of
this service is to expose a given platform's policy-based this service is to expose a given platform's policy-based
@ -58,6 +64,8 @@ typedef struct _EFI_PEI_SECURITY2_PPI EFI_PEI_SECURITY2_PPI;
PEIM being discovered. These latter behaviors are platform- PEIM being discovered. These latter behaviors are platform-
and market-specific and thus outside the scope of the PEI CIS. and market-specific and thus outside the scope of the PEI CIS.
@param PeiServices An indirect pointer to the PEI Services Table published by the PEI Foundation.
@param This Interface pointer that implements the particular @param This Interface pointer that implements the particular
EFI_PEI_SECURITY2_PPI instance. EFI_PEI_SECURITY2_PPI instance.

63
MdePkg/Include/Ppi/Smbus2.h
View File

@ -1,7 +1,9 @@
/** @file /** @file
This file declares Smbus2 PPI. This file declares Smbus2 PPI.
This PPI provides the basic I/O interfaces that a PEIM uses to access its
SMBus controller and the slave devices attached to it.
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -16,8 +18,8 @@
**/ **/
#ifndef _PEI_SMBUS2_PPI_H #ifndef __PEI_SMBUS2_PPI_H__
#define _PEI_SMBUS2_PPI_H #define __PEI_SMBUS2_PPI_H__
#include <PiPei.h> #include <PiPei.h>
#include <IndustryStandard/SmBus.h> #include <IndustryStandard/SmBus.h>
@ -34,7 +36,8 @@ typedef UINTN EFI_SMBUS_DEVICE_COMMAND;
/* /*
Executes an SMBus operation to an SMBus controller. Executes an SMBus operation to an SMBus controller. Returns when either
the command has been executed or an error is encountered in doing the operation.
@param This A pointer to the EFI_PEI_SMBUS2_PPI instance. @param This A pointer to the EFI_PEI_SMBUS2_PPI instance.
@param SlaveAddress The SMBUS hardware address to which the SMBUS device is preassigned or @param SlaveAddress The SMBUS hardware address to which the SMBUS device is preassigned or
@ -73,7 +76,7 @@ typedef UINTN EFI_SMBUS_DEVICE_COMMAND;
a failure reflected in the Host Status Register bit. a failure reflected in the Host Status Register bit.
@retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION. @retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.
Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and
EfiSmbusQuickWrite. Length is outside the range of valid values. EfiSmbusQuickWrite. Or Length is outside the range of valid values.
@retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported. @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
@retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation. @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.
@ -90,30 +93,11 @@ EFI_STATUS
IN OUT VOID *Buffer IN OUT VOID *Buffer
); );
/**
CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.
@param This A pointer to the EFI_PEI_SMBUS_PPI instance.
@param SlaveAddress The SMBUS hardware address to which the SMBUS
device is preassigned or allocated.
@param Data Data of the SMBus host notify command that
the caller wants to be called.
@return Status Code
**/
typedef
EFI_STATUS
(EFIAPI *EFI_PEI_SMBUS_NOTIFY2_FUNCTION)(
IN CONST EFI_PEI_SMBUS2_PPI *SmbusPpi,
IN CONST EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
IN CONST UINTN Data
);
/** /**
The ArpDevice() function enumerates the entire bus or enumerates a specific The ArpDevice() function enumerates the entire bus or enumerates a specific
device that is identified by SmbusUdid. device that is identified by SmbusUdid.
@param This A pointer to the EFI_PEI_SMBUS_PPI instance. @param This A pointer to the EFI_PEI_SMBUS2_PPI instance.
@param ArpAll A Boolean expression that indicates if the host drivers need @param ArpAll A Boolean expression that indicates if the host drivers need
to enumerate all the devices or enumerate only the device that is identified to enumerate all the devices or enumerate only the device that is identified
by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional. by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.
@ -130,6 +114,7 @@ EFI_STATUS
due to a lack of resources. due to a lack of resources.
@retval EFI_TIMEOUT The SMBus slave device did not respond. @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_DEVICE_ERROR The request was not completed because the transaction failed.
@retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are not implemented by this PEIM.
**/ **/
typedef typedef
@ -151,12 +136,13 @@ typedef struct {
The GetArpMap() function returns the mapping of all the SMBus devices The GetArpMap() function returns the mapping of all the SMBus devices
that are enumerated by the SMBus host driver. that are enumerated by the SMBus host driver.
@param This A pointer to the EFI_PEI_SMBUS_PPI instance. @param This A pointer to the EFI_PEI_SMBUS2_PPI instance.
@param Length Size of the buffer that contains the SMBus device map. @param Length Size of the buffer that contains the SMBus device map.
@param SmbusDeviceMap The pointer to the device map as enumerated @param SmbusDeviceMap The pointer to the device map as enumerated
by the SMBus controller driver. by the SMBus controller driver.
@retval EFI_SUCCESS The device map was returned correctly in the buffer. @retval EFI_SUCCESS The device map was returned correctly in the buffer.
@retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are not implemented by this PEIM.
**/ **/
typedef typedef
@ -167,12 +153,30 @@ EFI_STATUS
IN OUT EFI_SMBUS_DEVICE_MAP **SmbusDeviceMap IN OUT EFI_SMBUS_DEVICE_MAP **SmbusDeviceMap
); );
/**
CallBack function can be registered in EFI_PEI_SMBUS2_PPI_NOTIFY.
@param This A pointer to the EFI_PEI_SMBUS2_PPI instance.
@param SlaveAddress The SMBUS hardware address to which the SMBUS
device is preassigned or allocated.
@param Data Data of the SMBus host notify command that
the caller wants to be called.
@return Status
**/
typedef
EFI_STATUS
(EFIAPI *EFI_PEI_SMBUS_NOTIFY2_FUNCTION)(
IN CONST EFI_PEI_SMBUS2_PPI *SmbusPpi,
IN CONST EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
IN CONST UINTN Data
);
/** /**
The Notify() function registers all the callback functions to allow the The Notify() function registers all the callback functions to allow the
bus driver to call these functions when the SlaveAddress/Data pair happens. bus driver to call these functions when the SlaveAddress/Data pair happens.
@param This A pointer to the EFI_PEI_SMBUS_PPI instance. @param This A pointer to the EFI_PEI_SMBUS2_PPI instance.
@param SlaveAddress Address that the host controller detects as @param SlaveAddress Address that the host controller detects as
sending a message and calls all the registered functions. sending a message and calls all the registered functions.
@param Data Data that the host controller detects as sending a message @param Data Data that the host controller detects as sending a message
@ -180,8 +184,9 @@ EFI_STATUS
@param NotifyFunction The function to call when the bus driver @param NotifyFunction The function to call when the bus driver
detects the SlaveAddress and Data pair. detects the SlaveAddress and Data pair.
@retval EFI_SUCCESS NotifyFunction has been registered. @retval EFI_SUCCESS NotifyFunction has been registered.
@retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are not
implemented by this PEIM.
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS

6
MdePkg/Include/Ppi/Stall.h
View File

@ -1,9 +1,9 @@
/** @file /** @file
This file declares Stall PPI. This file declares Stall PPI.
This code abstracts the PEI core to provide Stall services. This ppi abstracts the blocking stall service to other agents.
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -35,7 +35,7 @@ typedef struct _EFI_PEI_STALL_PPI EFI_PEI_STALL_PPI;
@param This Pointer to the local data for the interface. @param This Pointer to the local data for the interface.
@param Microseconds Number of microseconds for which to stall. @param Microseconds Number of microseconds for which to stall.
@retval EFI_SUCCESS The service provided at least the required delay. @retval EFI_SUCCESS The service provided at least the required delay.
**/ **/
typedef typedef

7
MdePkg/Include/Ppi/StatusCode.h
View File

@ -1,7 +1,8 @@
/** @file /** @file
This file declares Status Code PPI. This file declares Status Code PPI.
This ppi provides service that allows PEIMs to report status codes.
Copyright (c) 2006, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -19,6 +20,8 @@
#ifndef __STATUS_CODE_PPI_H__ #ifndef __STATUS_CODE_PPI_H__
#define __STATUS_CODE_PPI_H__ #define __STATUS_CODE_PPI_H__
#include <Pi/PiPeiCis.h>
#define EFI_PEI_REPORT_PROGRESS_CODE_PPI_GUID \ #define EFI_PEI_REPORT_PROGRESS_CODE_PPI_GUID \
{ 0x229832d3, 0x7a30, 0x4b36, {0xb8, 0x27, 0xf4, 0xc, 0xb7, 0xd4, 0x54, 0x36 } } { 0x229832d3, 0x7a30, 0x4b36, {0xb8, 0x27, 0xf4, 0xc, 0xb7, 0xd4, 0x54, 0x36 } }
@ -28,7 +31,7 @@
of this service in the system. of this service in the system.
@param ReportStatusCode @param ReportStatusCode
Service that allows PEIMs to report status codes. This function is defined in Peicis.h Service that allows PEIMs to report status codes. This function is defined in PiPeicis.h
**/ **/
typedef struct { typedef struct {

10
MdePkg/Include/Ppi/TemporaryRamSupport.h
View File

@ -1,7 +1,8 @@
/** @file /** @file
This file declares Temporary RAM Support PPI. This file declares Temporary RAM Support PPI.
This Ppi provides the service that migrates temporary RAM into permanent memory.
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -55,7 +56,14 @@ EFI_STATUS
IN UINTN CopySize IN UINTN CopySize
); );
/**
This service abstracts the ability to migrate contents of the platform early memory store.
@param ResetSystem
Perform the migration of contents of Temporary RAM to Permanent RAM.
Terminate the Temporary RAM if it cannot coexist with the Permanent RAM.
**/
typedef struct { typedef struct {
TEMPORARY_RAM_MIGRATION TemporaryRamMigration; TEMPORARY_RAM_MIGRATION TemporaryRamMigration;
} TEMPORARY_RAM_SUPPORT_PPI; } TEMPORARY_RAM_SUPPORT_PPI;

4
MdePkg/Include/Uefi/UefiInternalFormRepresentation.h
View File

@ -1,4 +1,3 @@
/** @file /** @file
This file defines the encoding for the VFR (Visual Form Representation) language. This file defines the encoding for the VFR (Visual Form Representation) language.
IFR is primarily consumed by the EFI presentation engine, and produced by EFI IFR is primarily consumed by the EFI presentation engine, and produced by EFI
@ -581,6 +580,9 @@ typedef union {
EFI_STRING_ID string; EFI_STRING_ID string;
} EFI_IFR_TYPE_VALUE; } EFI_IFR_TYPE_VALUE;
//
// IFR Opcodes
//
#define EFI_IFR_FORM_OP 0x01 #define EFI_IFR_FORM_OP 0x01
#define EFI_IFR_SUBTITLE_OP 0x02 #define EFI_IFR_SUBTITLE_OP 0x02
#define EFI_IFR_TEXT_OP 0x03 #define EFI_IFR_TEXT_OP 0x03

10
MdePkg/Include/Uefi/UefiMultiPhase.h
View File

@ -135,16 +135,6 @@ typedef struct _EFI_CERT_BLOCK_RSA_2048_SHA256 {
this case the value is this case the value is
EFI_CERT_BLOCK_RSA_2048_SHA256. EFI_CERT_BLOCK_RSA_2048_SHA256.
@param Information The WIN_CERTIFICATE_UEFI_GUID certificate
type allows new types of certificates to
be developed for driver authentication
without requiring a new certificate type.
The CertType defines the format of the
CertData, which length is defined by the
size of the certificate less the fixed
size of the WIN_CERTIFICATE_UEFI_GUID
structure.
**/ **/
typedef struct _WIN_CERTIFICATE_UEFI_GUID { typedef struct _WIN_CERTIFICATE_UEFI_GUID {
WIN_CERTIFICATE Hdr; WIN_CERTIFICATE Hdr;