]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Ppi/PciCfg2.h
Code Scrub for header files in MdePkg/Include/Ppi and Uefi directory.
[mirror_edk2.git] / MdePkg / Include / Ppi / PciCfg2.h
index c778e69a49c6e0963796a791ae60793e5f73dc37..d44ee09ef00031f9f7f98a2abe9d08c706dfb528 100644 (file)
@@ -1,16 +1,17 @@
 /** @file\r
-  This file declares PciCfg PPI used to access PCI configuration space in PEI\r
+  This file declares PciCfg2 PPI.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  This ppi Provides platform or chipset-specific access to \r
+  the PCI configuration space for a specific PCI segment.\r
 \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  Copyright (c) 2006 - 2008, Intel Corporation\r
+  All rights reserved. This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-  Module Name:  PciCfg.h\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
   @par Revision Reference:\r
   This PPI is defined in PI\r
@@ -21,6 +22,8 @@
 #ifndef __PEI_PCI_CFG2_H__\r
 #define __PEI_PCI_CFG2_H__\r
 \r
+#include <ProcessorBind.h>\r
+#include <Pi/PiPeiCis.h>\r
 \r
 #define EFI_PEI_PCI_CFG2_PPI_GUID \\r
   { 0x57a449a, 0x1fdc, 0x4c06, { 0xbf, 0xc9, 0xf5, 0x3f, 0x6a, 0x99, 0xbb, 0x92 } }\r
@@ -32,7 +35,7 @@ typedef struct _EFI_PEI_PCI_CFG2_PPI   EFI_PEI_PCI_CFG2_PPI;
   (((bus) << 24) | \\r
   ((dev) << 16) | \\r
   ((func) << 8) | \\r
-  ((reg) < 256 ? (reg) : ((UINT64) (reg) << 32)));\r
+  ((reg) < 256 ? (reg) : ((UINT64)(reg) << 32)));\r
 \r
 //\r
 // EFI_PEI_PCI_CFG_PPI_WIDTH\r
@@ -63,10 +66,10 @@ typedef struct {
 \r
   @param  This            Pointer to local data for the interface.\r
 \r
-  @param  Width           The width of the access. Enumerated in bytes. \r
+  @param  Width           The width of the access. Enumerated in bytes.\r
                           See EFI_PEI_PCI_CFG_PPI_WIDTH above.\r
 \r
-  @param  Address         The physical address of the access. The format of \r
+  @param  Address         The physical address of the access. The format of\r
                           the address is described by EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS.\r
 \r
   @param  Buffer          A pointer to the buffer of data..\r
@@ -82,19 +85,20 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_PCI_CFG_PPI_IO) (\r
-  IN CONST     EFI_PEI_SERVICES          **PeiServices,\r
-  IN CONST     EFI_PEI_PCI_CFG2_PPI      *This,\r
-  IN CONST     EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
-  IN CONST     UINT64                    Address,\r
+(EFIAPI *EFI_PEI_PCI_CFG2_PPI_IO)(\r
+  IN CONST  EFI_PEI_SERVICES          **PeiServices,\r
+  IN CONST  EFI_PEI_PCI_CFG2_PPI      *This,\r
+  IN        EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
+  IN        UINT64                    Address,\r
   IN OUT    VOID                      *Buffer\r
 );\r
 \r
 \r
 /**\r
-  PCI read-modify-write operation.\r
+  Performs a read-modify-write operation on the contents \r
+  from a given location in the PCI configuration space.\r
 \r
-  @param  PeiServices     An indirect pointer to the PEI Services Table \r
+  @param  PeiServices     An indirect pointer to the PEI Services Table\r
                           published by the PEI Foundation.\r
 \r
   @param  This            Pointer to local data for the interface.\r
@@ -104,11 +108,11 @@ EFI_STATUS
 \r
   @param  Address         The physical address of the access.\r
 \r
-  @param  SetBits         Points to value to bitwise-OR with the read configuration value. \r
+  @param  SetBits         Points to value to bitwise-OR with the read configuration value.\r
 \r
                           The size of the value is determined by Width.\r
 \r
-  @param  ClearBits       Points to the value to negate and bitwise-AND with the read configuration value. \r
+  @param  ClearBits       Points to the value to negate and bitwise-AND with the read configuration value.\r
                           The size of the value is determined by Width.\r
 \r
 \r
@@ -116,24 +120,24 @@ EFI_STATUS
 \r
   @retval EFI_DEVICE_ERROR      There was a problem with the transaction.\r
 \r
-  @retval EFI_DEVICE_NOT_READY  The device is not capable of supporting \r
+  @retval EFI_DEVICE_NOT_READY  The device is not capable of supporting\r
                                 the operation at this time.\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_PCI_CFG_PPI_RW) (\r
+(EFIAPI *EFI_PEI_PCI_CFG2_PPI_RW)(\r
   IN CONST  EFI_PEI_SERVICES          **PeiServices,\r
   IN CONST  EFI_PEI_PCI_CFG2_PPI      *This,\r
-  IN CONST  EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
-  IN CONST  UINT64                    Address,\r
+  IN        EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
+  IN        UINT64                    Address,\r
   IN CONST  VOID                      *SetBits,\r
   IN CONST  VOID                      *ClearBits\r
 );\r
 \r
 /**\r
   @par Ppi Description:\r
-  The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI \r
+  The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI\r
   controllers behind a PCI root bridge controller.\r
 \r
   @param Read     PCI read services.  See the Read() function description.\r
@@ -146,9 +150,9 @@ EFI_STATUS
 \r
 **/\r
 struct _EFI_PEI_PCI_CFG2_PPI {\r
-  EFI_PEI_PCI_CFG_PPI_IO  Read;\r
-  EFI_PEI_PCI_CFG_PPI_IO  Write;\r
-  EFI_PEI_PCI_CFG_PPI_RW  Modify;\r
+  EFI_PEI_PCI_CFG2_PPI_IO  Read;\r
+  EFI_PEI_PCI_CFG2_PPI_IO  Write;\r
+  EFI_PEI_PCI_CFG2_PPI_RW  Modify;\r
   UINT16                  Segment;\r
 };\r
 \r