Code Scrub for Protocol and Ppi Definition

[mirror_edk2.git] / MdePkg / Include / Protocol / PciRootBridgeIo.h

diff --git a/MdePkg/Include/Protocol/PciRootBridgeIo.h b/MdePkg/Include/Protocol/PciRootBridgeIo.h
index b3dbfa9cab641d83dcc50a2d236f2ece2fa76dd9..bf96106a32b76f061cdcbd40292d99436bc4e58b 100644 (file)
--- a/MdePkg/Include/Protocol/PciRootBridgeIo.h
+++ b/MdePkg/Include/Protocol/PciRootBridgeIo.h
@@ -5,7 +5,7 @@
   and PCI Configuration cycles on a PCI Root Bridge. It also provides services to perform \r
   defferent types of bus mastering DMA\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \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
@@ -360,6 +360,72 @@ EFI_STATUS
   OUT VOID                                     **Resources\r
   );\r
 \r
+/**  \r
+  @par Protocol Description:\r
+  Provides the basic Memory, I/O, PCI configuration, and DMA interfaces that are \r
+  used to abstract accesses to PCI controllers behind a PCI Root Bridge Controller. \r
+  \r
+  @param ParentHandle\r
+  The EFI_HANDLE of the PCI Host Bridge of which this PCI Root Bridge is a member.\r
+\r
+  @param PollMem\r
+  Polls an address in memory mapped I/O space until an exit condition is met, \r
+  or a timeout occurs. \r
+\r
+  @param PollIo\r
+  Polls an address in I/O space until an exit condition is met, or a timeout occurs. \r
+\r
+  @param Mem.Read\r
+  Allows reads from memory mapped I/O space. \r
+\r
+  @param Mem.Write\r
+  Allows writes to memory mapped I/O space. \r
+\r
+  @param Io.Read\r
+  Allows reads from I/O space. \r
+\r
+  @param Io.Write\r
+  Allows writes to I/O space. \r
+\r
+  @param Pci.Read\r
+  Allows reads from PCI configuration space. \r
+\r
+  @param Pci.Write\r
+  Allows writes to PCI configuration space. \r
+\r
+  @param CopyMem\r
+  Allows one region of PCI root bridge memory space to be copied to another \r
+  region of PCI root bridge memory space. \r
+\r
+  @param Map\r
+  Provides the PCI controller's specific addresses needed to access system memory for DMA. \r
+\r
+  @param Unmap\r
+  Releases any resources allocated by Map(). \r
+\r
+  @param AllocateBuffer\r
+  Allocates pages that are suitable for a common buffer mapping. \r
+\r
+  @param FreeBuffer\r
+  Free pages that were allocated with AllocateBuffer(). \r
+\r
+  @param Flush\r
+  Flushes all PCI posted write transactions to system memory. \r
+\r
+  @param GetAttributes\r
+  Gets the attributes that a PCI root bridge supports setting with SetAttributes(), \r
+  and the attributes that a PCI root bridge is currently using. \r
+\r
+  @param SetAttributes\r
+  Sets attributes for a resource range on a PCI root bridge. \r
+\r
+  @param Configuration\r
+  Gets the current resource settings for this PCI root bridge. \r
+\r
+  @param SegmentNumber\r
+  The segment number that this PCI root bridge resides.\r
+\r
+**/\r
 struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL {\r
   EFI_HANDLE                                      ParentHandle;\r
   EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM     PollMem;\r