sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Committing changes to the comments, after review with engineers.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9018 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
pkandel
2009-07-28 13:25:37 +00:00
parent d3a12d776c
commit 5259c97d7a
36 changed files with 248 additions and 324 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
IntelFrameworkPkg/Include/Ppi/BootScriptExecuter.h
View File

@@ -3,7 +3,7 @@
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 and other information. The ability to interpret the boot script depends on the
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.

4
IntelFrameworkPkg/Include/Ppi/FindFv.h
View File

@@ -21,7 +21,7 @@
///
/// Inconsistent with specification here:
/// GUID value format has been changed to the standard guid format.
/// GUID value format has been changed to the standard GUID format.
///
#define EFI_PEI_FIND_FV_PPI_GUID \
{ \
@@ -32,7 +32,7 @@ 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
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.

2
IntelFrameworkPkg/Include/Ppi/PciCfg.h
View File

@@ -1,5 +1,5 @@
/** @file
This file declares PciCfg PPI used to access PCI configuration space in PEI
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

4
IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
View File

@@ -1,5 +1,5 @@
/** @file
This file declares Read-only Variable Service PPI, which is required PPI by framework spec.
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,
@@ -79,7 +79,7 @@ EFI_STATUS
/**
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,
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.

6
IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
View File

@@ -52,8 +52,8 @@ typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI;
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,
@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.
@@ -63,7 +63,7 @@ typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI;
@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.
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.

32
IntelFrameworkPkg/Include/Ppi/Smbus.h
View File

@@ -1,5 +1,5 @@
/** @file
This file declares Smbus PPI which provides the basic I/O interfaces that a PEIM
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
@@ -40,10 +40,10 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
controller to the SMBus slave device and the interpretation is
SMBus slave device specific.
@param[in] Operation Signifies which particular SMBus hardware protocol
instance that it will use to execute the SMBus transactions.
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 Signifies the number of bytes that this operation will do.
@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
@@ -54,7 +54,7 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
@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 reflected in the Host Status Register bit.
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.
@@ -76,15 +76,13 @@ EFI_STATUS
);
/**
CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.
This function is user-defined and will called when the SlaveAddress/Data pair happens.
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 that
@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.
@@ -100,14 +98,14 @@ EFI_STATUS
);
/**
The ArpDevice() function enumerates the entire bus or enumerates a specific
device that is identified by SmbusUdid.
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 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 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).
@@ -122,9 +120,9 @@ EFI_STATUS
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() are not implemented by this PEIM.
@retval EFI_UNSUPPORTED ArpDevice() is not implemented by this PEIM.
This return value is not defined in Framwork Specification.
This return value had been intruduced in PI Specification.
This return value was introduced in the PI Specification.
**/
typedef
@@ -150,7 +148,7 @@ EFI_STATUS
@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 had been intruduced in PI Specification.
This return value was introduced in the PI Specification.
**/
typedef
@@ -174,16 +172,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] SlaveAddress Address that the host controller detects as
sending a message and calls all the registered functions.
sending a message and triggers all the registered functions.
@param[in] Data Data that the host controller detects as sending a message
and calls all the registered functions.
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 Framwork Specification.
This return value had been intruduced in PI Specification.
This return value was introduced in the PI Specification.
**/
typedef