summaryrefslogtreecommitdiff
path: root/IntelFrameworkPkg/Include/Ppi
diff options
context:
space:
mode:
authormyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>2010-03-16 01:53:11 +0000
committermyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>2010-03-16 01:53:11 +0000
commitf22f941ed273753a0426d1234869857f19c28664 (patch)
tree414dd4cc3fa518dca29739d001eac8378d880dd2 /IntelFrameworkPkg/Include/Ppi
parenta89fa50ccf7a29405e3d24c49625dbd70cdba9fa (diff)
downloadedk2-platforms-f22f941ed273753a0426d1234869857f19c28664.tar.xz
Grammatical and disclaimer changes (does not follow internal C coding stds.)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10249 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'IntelFrameworkPkg/Include/Ppi')
-rw-r--r--IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h33
-rw-r--r--IntelFrameworkPkg/Include/Ppi/FindFv.h22
-rw-r--r--IntelFrameworkPkg/Include/Ppi/FvLoadFile.h28
-rw-r--r--IntelFrameworkPkg/Include/Ppi/PciCfg.h18
-rw-r--r--IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h46
-rw-r--r--IntelFrameworkPkg/Include/Ppi/S3Resume.h24
-rw-r--r--IntelFrameworkPkg/Include/Ppi/SectionExtraction.h70
-rw-r--r--IntelFrameworkPkg/Include/Ppi/Security.h35
-rw-r--r--IntelFrameworkPkg/Include/Ppi/Smbus.h69
9 files changed, 184 insertions, 161 deletions
diff --git a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
index 9f5ca5054d..3abf739a75 100644
--- a/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
+++ b/IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
@@ -1,5 +1,5 @@
/** @file
- This file declares Boot Script Executer PPI.
+ 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
@@ -8,14 +8,14 @@
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 - 2009, Intel Corporation
- All rights reserved. This program and the accompanying materials
- 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
- 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.
+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.
@@ -39,16 +39,19 @@ typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PP
@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.
+ 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.
+ 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.
+ Or, an unsupported opcode occurred in the table.
+ Or there were opcode execution errors, such as an
+ insufficient dependency.
**/
typedef
@@ -62,11 +65,11 @@ EFI_STATUS
///
/// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and
-/// executes the Framework boot script table
+/// executes the Framework boot script table.
///
struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI {
///
- /// Executes a boot script table
+ /// Executes a boot script table.
///
EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;
};
diff --git a/IntelFrameworkPkg/Include/Ppi/FindFv.h b/IntelFrameworkPkg/Include/Ppi/FindFv.h
index 40c3177f9f..0ef248d8dd 100644
--- a/IntelFrameworkPkg/Include/Ppi/FindFv.h
+++ b/IntelFrameworkPkg/Include/Ppi/FindFv.h
@@ -1,18 +1,18 @@
/** @file
- This file declares FindFv PPI used to locate FVs that contain PEIMs in PEI
+ This file declares FindFv PPI, which is used to locate FVs that contain PEIMs in PEI.
- Copyright (c) 2007 - 2009, Intel Corporation
- All rights reserved. This program and the accompanying materials
- 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
- 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.
+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
+ Version 0.91.
**/
@@ -35,7 +35,7 @@ typedef struct _EFI_PEI_FIND_FV_PPI EFI_PEI_FIND_FV_PPI;
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 Pointer to the PEI Services Table.
+ @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.
diff --git a/IntelFrameworkPkg/Include/Ppi/FvLoadFile.h b/IntelFrameworkPkg/Include/Ppi/FvLoadFile.h
index 5f75a18a6a..b444246772 100644
--- a/IntelFrameworkPkg/Include/Ppi/FvLoadFile.h
+++ b/IntelFrameworkPkg/Include/Ppi/FvLoadFile.h
@@ -1,14 +1,14 @@
/** @file
Load image file from fv to memory.
- Copyright (c) 2007 - 2009, Intel Corporation
- All rights reserved. This program and the accompanying materials
- 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
- 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.
+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.
@@ -29,10 +29,10 @@ 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 Pointer to the FFS header of the file to load.
- @param ImageAddress Pointer to the address of the loaded Image
- @param ImageSize Pointer to the size of the loaded image.
- @param EntryPoint Pointer to the entry point of the image.
+ @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.
@@ -52,13 +52,13 @@ EFI_STATUS
/**
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
+ 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
+ /// Loads a PEIM into memory for subsequent execution.
///
EFI_PEI_FV_LOAD_FILE FvLoadFile;
};
diff --git a/IntelFrameworkPkg/Include/Ppi/PciCfg.h b/IntelFrameworkPkg/Include/Ppi/PciCfg.h
index 708e51280d..6e05b88dfa 100644
--- a/IntelFrameworkPkg/Include/Ppi/PciCfg.h
+++ b/IntelFrameworkPkg/Include/Ppi/PciCfg.h
@@ -1,14 +1,14 @@
/** @file
This file declares the PciCfg PPI used to access the PCI configuration space in PEI
- Copyright (c) 2006 - 2009, Intel Corporation
- All rights reserved. This program and the accompanying materials
- 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
- 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.
+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
@@ -64,7 +64,7 @@ EFI_STATUS
@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 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.
diff --git a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
index 87d2dc35e6..0cdd61266b 100644
--- a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
+++ b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
@@ -4,17 +4,17 @@
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,
- thus making the in situ PEIM execution not follow the required flow.
-
- Copyright (c) 2006 - 2009, Intel Corporation
- All rights reserved. This program and the accompanying materials
- 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
- 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.
+ 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
@@ -32,7 +32,7 @@
typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI EFI_PEI_READ_ONLY_VARIABLE_PPI;
///
-/// Variable attributes
+/// Variable attributes.
///@{
#define EFI_VARIABLE_NON_VOLATILE 0x00000001
#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
@@ -46,9 +46,10 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI EFI_PEI_READ_ONLY_VARIABLE_PPI;
///@}
/**
- Get Variable value by Name and GUID pair
+ 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] 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
@@ -83,20 +84,23 @@ EFI_STATUS
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] 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.
+ 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.
+ 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.
+ @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to
+ a hardware error.
**/
typedef
@@ -116,7 +120,7 @@ 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 inconsistance is for backward compatibility.
+ /// 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
diff --git a/IntelFrameworkPkg/Include/Ppi/S3Resume.h b/IntelFrameworkPkg/Include/Ppi/S3Resume.h
index 0995a2f1b9..7a12999690 100644
--- a/IntelFrameworkPkg/Include/Ppi/S3Resume.h
+++ b/IntelFrameworkPkg/Include/Ppi/S3Resume.h
@@ -8,7 +8,7 @@
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 has to ensure the necessary information for the S3 resume, such as
+ 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
@@ -17,14 +17,14 @@
- The reserved memory range to be used for the S3 resume.
Otherwise, the S3 resume boot path may fail.
- Copyright (c) 2007 - 2009, Intel Corporation
- All rights reserved. This program and the accompanying materials
- 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
- 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.
+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.
@@ -46,11 +46,11 @@ 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 Pointer to the PEI Services Table
+ @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 Some necessary information that is used for
- the S3 resume boot path could not be located.
+ @retval EFI_NOT_FOUND Could not be locate some necessary information that
+ is used for the S3 resume boot path d.
**/
typedef
diff --git a/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h b/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
index e2885b42e5..a61432eec3 100644
--- a/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
+++ b/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
@@ -1,17 +1,17 @@
/** @file
- This file declares Section Extraction PPI.
+ 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-2009, Intel Corporation
- All rights reserved. This program and the accompanying materials
- 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
- 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.
+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.
**/
@@ -38,38 +38,46 @@ typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI;
It will retrieve both encapsulation sections and leaf sections in their entirety,
exclusive of the section header.
- @param PeiServices Pointer to the PEI Services Table.
+ @param PeiServices The pointer to the PEI Services Table.
@param This Indicates the calling context
- @param SectionType Pointer to an EFI_SECTION_TYPE. If SectionType == NULL,
- the contents of the entire section are returned in Buffer. If SectionType
+ @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 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 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 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 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.
+ which any metadata from encapsulating GUID-defined
+ sections is returned.
- @retval EFI_SUCCESS The section was successfully processed and the section
+ @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.
+ 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.
+ contain the requested section. The input buffer
+ is filled and contents are section contents are
+ truncated.
**/
typedef
diff --git a/IntelFrameworkPkg/Include/Ppi/Security.h b/IntelFrameworkPkg/Include/Ppi/Security.h
index 6674cd6c79..e51de07998 100644
--- a/IntelFrameworkPkg/Include/Ppi/Security.h
+++ b/IntelFrameworkPkg/Include/Ppi/Security.h
@@ -1,18 +1,18 @@
/** @file
- This file declares Security Architectural PPI.
+ This file declares the Security Architectural PPI.
- This PPI is installed by some platform PEIM that abstracts the security policy to the PEI
+ 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, Intel Corporation
- All rights reserved. This program and the accompanying materials
- 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
- 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.
+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.
@@ -34,14 +34,17 @@ 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 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 Pointer to the file under review.
- @param DeferExecution Pointer to a variable that alerts the PEI Foundation to defer execution of a PEIM.
+ @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
+ @retval EFI_SECURITY_VIOLATION The object cannot be trusted.
**/
typedef
EFI_STATUS
diff --git a/IntelFrameworkPkg/Include/Ppi/Smbus.h b/IntelFrameworkPkg/Include/Ppi/Smbus.h
index 8834bd2a7d..1bc0ceafee 100644
--- a/IntelFrameworkPkg/Include/Ppi/Smbus.h
+++ b/IntelFrameworkPkg/Include/Ppi/Smbus.h
@@ -2,18 +2,18 @@
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 - 2009, Intel Corporation
- All rights reserved. This program and the accompanying materials
- 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
- 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.
+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
+ Version 0.9.
**/
@@ -37,14 +37,15 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
@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.
+ 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.
+ @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.
@@ -53,11 +54,12 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
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 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_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.
@@ -103,13 +105,16 @@ EFI_STATUS
@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 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] 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.
+ 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.
@@ -121,7 +126,7 @@ EFI_STATUS
@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 Framwork Specification.
+ This return value is not defined in the Framework Specification.
This return value was introduced in the PI Specification.
**/
@@ -141,13 +146,13 @@ EFI_STATUS
@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 Size of the buffer that contains the SMBus device map.
+ @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 Framwork Specification.
+ This return value was not defined in the Framework Specification.
This return value was introduced in the PI Specification.
**/
@@ -165,13 +170,13 @@ EFI_STATUS
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 happens.
+ 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 Address that the host controller detects as
+ @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.
@@ -180,7 +185,7 @@ EFI_STATUS
@retval EFI_SUCCESS NotifyFunction has been registered.
@retval EFI_UNSUPPORTED Notify() are not implemented by this PEIM.
- This return value is not defined in Framwork Specification.
+ This return value is not defined in the Framework Specification.
This return value was introduced in the PI Specification.
**/