Grammatical and disclaimer changes (does not follow internal C coding stds.)

[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / Include / Ppi / EcpPciCfg.h

diff --git a/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h b/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
index a58c9dc7643327f0af26fc268d8270f8ffaec993..524aa12902ed1ffacda4952a07ac16e7b6fdbc32 100644 (file)
--- a/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
+++ b/EdkCompatibilityPkg/Compatibility/Include/Ppi/EcpPciCfg.h
@@ -1,13 +1,15 @@
 /** @file\r
-This PPI which is same with PciCfg PPI. But Modify API is removed.\r
+This PPI is the same as the PPI in the framework PciCfg, with one exception. \r
+Specifically, this PPI does not include a modify API, while the PPI in the framework PciCfg does. \r
 \r
-Copyright (c) 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
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+Copyright (c) 2008 - 2010, Intel Corporation.  All rights reserved<BR>\r
+Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>\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
+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
 **/\r
@@ -23,25 +25,25 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 typedef struct _ECP_PEI_PCI_CFG_PPI ECP_PEI_PCI_CFG_PPI;\r
 \r
 /**\r
-  PCI read and write operation.\r
+  A PCI read and write operation.\r
   \r
-  Write to/read from a given location in the PCI configuration space.\r
-\r
-  @param  PeiServices                   An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  This                              Pointer to local data for the interface.\r
-  @param  Width                            The width of the access. Enumerated in bytes.\r
-                                                    See EFI_PEI_PCI_CFG_PPI_WIDTH above.\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
-  @param  Buffer                            A pointer to the buffer of data..\r
-  @retval EFI_SUCCESS                   The function completed successfully.\r
-  @retval EFI_DEVICE_ERROR          There was a problem with the transaction.\r
-  @retval EFI_DEVICE_NOT_READY  The device is not capable of supporting the operation at this\r
-                                                 time.\r
+  Writes to, or reads from, a given location in the PCI configuration space.\r
+\r
+  @param  PeiServices              An indirect pointer to the PEI Services Table \r
+                                   published by the PEI Foundation.\r
+  @param  This                     The pointer to local data for the interface.\r
+  @param  Width                    The width of the access. Enumerated in bytes.\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
+  @param  Buffer                   A pointer to the buffer of data.\r
+  @retval EFI_SUCCESS              The function completed successfully.\r
+  @retval EFI_DEVICE_ERROR         There was a problem with the transaction.\r
+  @retval EFI_DEVICE_NOT_READY     The device is not capable of supporting the \r
+                                   operation at this time.\r
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *ECP_PEI_PCI_CFG_PPI_IO) (\r
+(EFIAPI *ECP_PEI_PCI_CFG_PPI_IO)(\r
   IN EFI_PEI_SERVICES         **PeiServices,\r
   IN EFI_PEI_PCI_CFG_PPI      * This,\r
   IN EFI_PEI_PCI_CFG_PPI_WIDTH Width,\r
@@ -49,16 +51,6 @@ EFI_STATUS
   IN OUT VOID                 *Buffer\r
   );\r
 \r
-/**\r
-  The ECP_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI \r
-  controllers behind a PCI root bridge controller.\r
-  @param Read\r
-  PCI read services.  See the Read() function description.\r
-  @param Write\r
-  PCI write services.  See the Write() function description.\r
-\r
-**/\r
-\r
 struct _ECP_PEI_PCI_CFG_PPI {\r
   ECP_PEI_PCI_CFG_PPI_IO  Read;\r
   ECP_PEI_PCI_CFG_PPI_IO  Write;\r