diff options
Diffstat (limited to 'Include/PPI/CspLibPPI.h')
| -rw-r--r-- | Include/PPI/CspLibPPI.h | 223 |
1 files changed, 223 insertions, 0 deletions
diff --git a/Include/PPI/CspLibPPI.h b/Include/PPI/CspLibPPI.h new file mode 100644 index 0000000..cd5cf80 --- /dev/null +++ b/Include/PPI/CspLibPPI.h @@ -0,0 +1,223 @@ +//************************************************************************* +//************************************************************************* +//** ** +//** (C)Copyright 1985-2008, American Megatrends, Inc. ** +//** ** +//** All Rights Reserved. ** +//** ** +//** 5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093 ** +//** ** +//** Phone: (770)-246-8600 ** +//** ** +//************************************************************************* +//************************************************************************* + +//********************************************************************** +// $Header: /Alaska/BIN/Chipset/Template/CSPLibrary/CspLibPPI.h 7 7/14/11 2:45p Artems $ +// +// $Revision: 7 $ +// +// $Date: 7/14/11 2:45p $ +//***************************************************************************** +// Revision History +// ---------------- +// $Log: /Alaska/BIN/Chipset/Template/CSPLibrary/CspLibPPI.h $ +// +// 7 7/14/11 2:45p Artems +// EIP 64106: Updated source to be UEFI 2.3.1 and PI 1.2 compliant +// +// 6 2/22/11 4:41p Artems +// EIP 51548 - Added AMI copyright headers, replaced TABs with spaces +// +// 5 6/12/09 10:55a Robert +// updated headers +// +// 4 6/12/09 10:51a Robert +// CHM and comment updates +// +// 3 10/13/07 11:53p Michaela +// Added ProgramPciTable to AMI_PEI_PCI_TABLE_INIT_PPI to +// support multiple access widths +// +// 2 3/13/06 3:42p Felixp +// +// 1 1/21/05 12:46p Sivagarn +// Initial Checkin - Version 0.05 +// +// +//***************************************************************************** + +//<AMI_FHDR_START> +//---------------------------------------------------------------------------- +// +// Name: CspLibPPI.h +// +// Description: +// This file contains PPI definitions that are defined in the CSP Library +// +//---------------------------------------------------------------------------- +//<AMI_FHDR_END> +#ifndef __CSP_LIB_PPI_H__ +#define __CSP_LIB_PPI_H__ +#ifdef __cplusplus +extern "C" { +#endif +#include <PEI.h> + +//<AMI_GHDR_START> +//============================================================================ +// +// Name: AMI_PEI_PCI_TABLE_INIT_PPI_GUID +// +// Description: +// This is the GUID to use to locate the the instance of the +// AMI_PEI_PCI_TABLE_INIT_PPI +// +// Notes: +// #define AMI_PEI_PCI_TABLE_INIT_PPI_GUID \ +// { 0x97f91e78, 0xea12, 0x4ea6, 0xb7, 0xb3, 0x7b, 0x6, 0x78, 0xc2, 0x86, 0x73 } +// +//============================================================================ +//<AMI_GHDR_END> +#define AMI_PEI_PCI_TABLE_INIT_PPI_GUID \ +{ 0x97f91e78, 0xea12, 0x4ea6, 0xb7, 0xb3, 0x7b, 0x6, 0x78, 0xc2, 0x86, 0x73 } + +GUID_VARIABLE_DECLARATION(gPeiPciTableInitPpiGuid,AMI_PEI_PCI_TABLE_INIT_PPI_GUID); + +#ifndef GUID_VARIABLE_DEFINITION +#include <PPI/PciCfg2.h> + +typedef struct _AMI_PEI_PCI_TABLE_INIT_PPI AMI_PEI_PCI_TABLE_INIT_PPI; + +//<AMI_GHDR_START> +//------------------------------------------------------------------ +// +// Name: AMI_PEI_PCI_INIT_TABLE_STRUCT +// +// Fields: Type ParameterName Description +//------------------------------------------------------------------ +// UINT8 bRegIndex - PCI Register to program +// UINT8 bANDMask - AND mask to apply to data in PCI register +// UINT8 bORMask - OR mask to apply to data in PCI register after AND mask +// +// Description: +// This data structure contains the information that is used to +// modify PCI register of a PCI specific device +// +// +// Notes: +// Only can modify a one byte register at a time. +// See AMI_PEI_PCI_INIT_TABLE_STRUCT2 to modify lager register +// at once +// +//------------------------------------------------------------------ +//<AMI_GHDR_END> +typedef struct _AMI_PEI_PCI_INIT_TABLE_STRUCT +{ + UINT8 bRegIndex; + UINT8 bANDMask; + UINT8 bORMask; +} AMI_PEI_PCI_INIT_TABLE_STRUCT; + +//<AMI_GHDR_START> +//------------------------------------------------------------------ +// +// Name: AMI_PEI_PCI_INIT_TABLE_STRUCT2 +// +// Fields: Type ParameterName Description +//------------------------------------------------------------------ +// UINT8 bRegIndex - PCI Register to program +// UINTN bANDMask - AND mask to apply to data in PCI register +// UINTN bORMask - OR mask to apply to data in PCI register after AND mask +// +// Description: +// This data structure contains the information that is used to +// modify PCI register of a PCI specific device +// +// +// Notes: +// This Structure is almost the same as AMI_PEI_PCI_INIT_TABLE_STRUCT +// The difference is in the size of the AND and OR masks. to allow +// modification of PCI registers larger than one byte +// +//------------------------------------------------------------------ +//<AMI_GHDR_END> +typedef struct +{ + UINT8 bRegIndex; // register offset to modify + UINTN bANDMask; // specified bits will be cleared + UINTN bORMask; // specified bits will be set +} AMI_PEI_PCI_INIT_TABLE_STRUCT2; + +typedef +EFI_STATUS +(EFIAPI * AMI_PEI_PCI_TABLE_INIT_FUNCTION) ( + IN EFI_PEI_SERVICES **PeiServices, + IN AMI_PEI_PCI_TABLE_INIT_PPI *This, + IN EFI_PEI_PCI_CFG2_PPI *PciCfg, // OPTIONAL + IN UINT64 Address, + IN AMI_PEI_PCI_INIT_TABLE_STRUCT PCIInitTable[], + IN UINT16 wSize + ); + +// This version allows a table of specified access width up to UINTN +typedef +EFI_STATUS +(EFIAPI * AMI_PEI_PCI_TABLE_INIT_FUNCTION_VARACCESS) ( + IN EFI_PEI_SERVICES **PeiServices, + IN AMI_PEI_PCI_TABLE_INIT_PPI *This, + IN EFI_PEI_PCI_CFG2_PPI *PciCfg, // OPTIONAL + IN UINT64 CfgAddress, + IN AMI_PEI_PCI_INIT_TABLE_STRUCT2 *PciInitTable, + IN UINT16 TableEntries, + IN EFI_PEI_PCI_CFG_PPI_WIDTH AccessWidth +); + +//<AMI_GHDR_START> +//------------------------------------------------------------------ +// +// Name: AMI_PEI_PCI_TABLE_INIT_PPI +// +// Description: +// This data structure is the AMI_PEI_PCI_TABLE_INIT_PPI definition +// This provides this PPI to any module that includes the chipset +// library. This provides a mechanism to program a table full of +// PCI information in one function call +// +// Fields: Type ParameterName Description +//------------------------------------------------------------------ +// AMI_PEI_PCI_TABLE_INIT_FUNCTION AMIPEIProgramPCITable - PciTableInit +// AMI_PEI_PCI_TABLE_INIT_FUNCTION_VARACCESS ProgramPciTable - PciTableInit2 +// +// Notes: +// See the function headers for descriptions +// +//------------------------------------------------------------------ +//<AMI_GHDR_END> +typedef struct _AMI_PEI_PCI_TABLE_INIT_PPI +{ + AMI_PEI_PCI_TABLE_INIT_FUNCTION AMIPEIProgramPCITable; + AMI_PEI_PCI_TABLE_INIT_FUNCTION_VARACCESS ProgramPciTable; +} AMI_PEI_PCI_TABLE_INIT_PPI; + + +/****** DO NOT WRITE BELOW THIS LINE *******/ +#endif // #ifndef GUID_VARIABLE_DEFINITION +#ifdef __cplusplus +} +#endif + +#endif +//************************************************************************* +//************************************************************************* +//** ** +//** (C)Copyright 1985-2008, American Megatrends, Inc. ** +//** ** +//** All Rights Reserved. ** +//** ** +//** 5555 Oakbrook Parkway, Suite 200, Norcross, GA 30093 ** +//** ** +//** Phone: (770)-246-8600 ** +//** ** +//************************************************************************* +//*************************************************************************
\ No newline at end of file |