IntelFrameworkPkg: Clean up source files
1. Do not use tab characters 2. No trailing white space in one line 3. All files must end with CRLF Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
@@ -8,13 +8,13 @@
|
||||
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.
|
||||
Copyright (c) 2007 - 2018, 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,
|
||||
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:
|
||||
@@ -39,10 +39,10 @@ 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
|
||||
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
|
||||
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.
|
||||
@@ -50,7 +50,7 @@ typedef struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI EFI_PEI_BOOT_SCRIPT_EXECUTER_PP
|
||||
@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
|
||||
Or there were opcode execution errors, such as an
|
||||
insufficient dependency.
|
||||
|
||||
**/
|
||||
@@ -64,14 +64,14 @@ EFI_STATUS
|
||||
);
|
||||
|
||||
///
|
||||
/// EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI produces the function which interprets and
|
||||
/// 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;
|
||||
///
|
||||
/// Executes a boot script table.
|
||||
///
|
||||
EFI_PEI_BOOT_SCRIPT_EXECUTE Execute;
|
||||
};
|
||||
|
||||
extern EFI_GUID gEfiPeiBootScriptExecuterPpiGuid;
|
||||
|
@@ -1,13 +1,13 @@
|
||||
/** @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.
|
||||
Copyright (c) 2007 - 2018, 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,
|
||||
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:
|
||||
@@ -20,7 +20,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
#define _FIND_FV_H_
|
||||
|
||||
///
|
||||
/// Inconsistent with specification here:
|
||||
/// Inconsistent with specification here:
|
||||
/// GUID value format has been changed to the standard GUID format.
|
||||
///
|
||||
#define EFI_PEI_FIND_FV_PPI_GUID \
|
||||
|
@@ -1,13 +1,13 @@
|
||||
/** @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.
|
||||
Copyright (c) 2007 - 2018, 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,
|
||||
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:
|
||||
|
@@ -1,14 +1,14 @@
|
||||
/** @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.
|
||||
Copyright (c) 2006 - 2018, 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.
|
||||
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
|
||||
@@ -85,7 +85,7 @@ EFI_STATUS
|
||||
);
|
||||
|
||||
/**
|
||||
The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI
|
||||
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 {
|
||||
@@ -93,12 +93,12 @@ 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.
|
||||
///
|
||||
|
@@ -7,13 +7,13 @@
|
||||
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.
|
||||
Copyright (c) 2006 - 2018, 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,
|
||||
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:
|
||||
@@ -38,17 +38,17 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI EFI_PEI_READ_ONLY_VARIABLE_PPI;
|
||||
#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
|
||||
#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
|
||||
///
|
||||
/// Inconsistent with specification here:
|
||||
/// 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
|
||||
@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.
|
||||
@@ -84,22 +84,22 @@ 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
|
||||
@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
|
||||
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,
|
||||
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
|
||||
@retval EFI_DEVICE_ERROR The variable name could not be retrieved due to
|
||||
a hardware error.
|
||||
|
||||
**/
|
||||
@@ -114,19 +114,19 @@ EFI_STATUS
|
||||
|
||||
///
|
||||
/// This PPI provides a lightweight, read-only variant of the full EFI
|
||||
/// variable services.
|
||||
/// variable services.
|
||||
///
|
||||
struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {
|
||||
///
|
||||
/// Inconsistent with specification here:
|
||||
///
|
||||
/// 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__ */
|
||||
#endif /* __PEI_READ_ONLY_VARIABLE_PPI_H__ */
|
||||
|
||||
|
@@ -1,7 +1,7 @@
|
||||
/** @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
|
||||
@@ -16,14 +16,14 @@
|
||||
- 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.
|
||||
|
||||
Copyright (c) 2007 - 2018, 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,
|
||||
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:
|
||||
@@ -49,7 +49,7 @@ typedef struct _EFI_PEI_S3_RESUME_PPI EFI_PEI_S3_RESUME_PPI;
|
||||
@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
|
||||
@retval EFI_NOT_FOUND Could not be locate some necessary information that
|
||||
is used for the S3 resume boot path d.
|
||||
|
||||
**/
|
||||
|
@@ -4,13 +4,13 @@
|
||||
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.
|
||||
Copyright (c) 2006 - 2018, 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,
|
||||
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.
|
||||
|
||||
**/
|
||||
@@ -40,43 +40,43 @@ typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI;
|
||||
|
||||
@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
|
||||
@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,
|
||||
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
|
||||
@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
|
||||
@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
|
||||
*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
|
||||
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.
|
||||
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
|
||||
@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
|
||||
@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
|
||||
contain the requested section. The input buffer
|
||||
is filled and contents are section contents are
|
||||
truncated.
|
||||
|
||||
**/
|
||||
|
@@ -1,17 +1,17 @@
|
||||
/** @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.
|
||||
|
||||
Copyright (c) 2006 - 2018, 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,
|
||||
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:
|
||||
@@ -35,12 +35,12 @@ typedef struct _EFI_PEI_SECURITY_PPI EFI_PEI_SECURITY_PPI;
|
||||
to varying file authentication states.
|
||||
|
||||
@param PeiServices The pointer to the PEI Services Table.
|
||||
@param This Interface pointer that implements the particular
|
||||
@param This Interface pointer that implements the particular
|
||||
EFI_PEI_SECURITY_PPI instance.
|
||||
@param AuthenticationStatus Status returned by the verification service as
|
||||
@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
|
||||
@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.
|
||||
|
@@ -1,14 +1,14 @@
|
||||
/** @file
|
||||
This file declares the 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 - 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.
|
||||
Copyright (c) 2007 - 2018, 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,
|
||||
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:
|
||||
@@ -37,14 +37,14 @@ 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
|
||||
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
|
||||
@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
|
||||
@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
|
||||
@@ -57,8 +57,8 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI;
|
||||
@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
|
||||
@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.
|
||||
@@ -105,15 +105,15 @@ 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 to
|
||||
@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
|
||||
by SmbusUdid. If ArpAll is TRUE, SmbusUdid and
|
||||
SlaveAddress are optional and ignored if entered.
|
||||
If ArpAll is FALSE, ArpDevice will enumerate
|
||||
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
|
||||
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.
|
||||
@@ -125,7 +125,7 @@ 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() is not implemented by this PEIM.
|
||||
@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.
|
||||
|
||||
@@ -151,7 +151,7 @@ EFI_STATUS
|
||||
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.
|
||||
@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.
|
||||
|
||||
@@ -166,7 +166,7 @@ EFI_STATUS
|
||||
);
|
||||
|
||||
/**
|
||||
Allows a device driver to register for a callback when the bus driver detects a state that it needs to
|
||||
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
|
||||
@@ -184,7 +184,7 @@ EFI_STATUS
|
||||
detects the SlaveAddress and Data pair.
|
||||
|
||||
@retval EFI_SUCCESS NotifyFunction has been registered.
|
||||
@retval EFI_UNSUPPORTED Notify() are not implemented by this PEIM.
|
||||
@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.
|
||||
|
||||
@@ -208,21 +208,21 @@ 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.
|
||||
/// 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.
|
||||
/// controller driver when the bus issues a notification to the bus controller PEIM.
|
||||
///
|
||||
EFI_PEI_SMBUS_PPI_NOTIFY Notify;
|
||||
};
|
||||
|
Reference in New Issue
Block a user