]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/PciSegmentLib.h
Synchronization of MDE Library Spec., Mde.dec, and corresponding head files in MdePkg...
[mirror_edk2.git] / MdePkg / Include / Library / PciSegmentLib.h
index 570ae0db1a5be03c534b58010357a7173c3ca1a1..75c2e0cf7ea8f8212647d987b1b00fe42b8ad43a 100644 (file)
@@ -1,16 +1,14 @@
 /** @file\r
-  Functions accessing PCI configuration registers on any supported PCI segment\r
+  Provides services to access PCI Configuration Space on a platform with multiple PCI segments.\r
 \r
-  Copyright (c) 2006, 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
+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
-  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
-  Module Name:  PciSegmentLib.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
 **/\r
 \r
@@ -59,8 +57,7 @@ UINT8
 EFIAPI\r
 PciSegmentRead8 (\r
   IN UINT64                    Address\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Writes an 8-bit PCI configuration register.\r
@@ -80,8 +77,7 @@ EFIAPI
 PciSegmentWrite8 (\r
   IN UINT64                    Address,\r
   IN UINT8                     Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Performs a bitwise inclusive OR of an 8-bit PCI configuration register with an 8-bit value.\r
@@ -104,8 +100,7 @@ EFIAPI
 PciSegmentOr8 (\r
   IN UINT64                    Address,\r
   IN UINT8                     OrData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit value.\r
@@ -118,7 +113,7 @@ PciSegmentOr8 (
   If any reserved bits in Address are set, then ASSERT().\r
 \r
   @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
-  @param  Andata    The value to AND with the PCI configuration register.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
@@ -128,8 +123,7 @@ EFIAPI
 PciSegmentAnd8 (\r
   IN UINT64                    Address,\r
   IN UINT8                     AndData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit value,\r
@@ -144,7 +138,7 @@ PciSegmentAnd8 (
   If any reserved bits in Address are set, then ASSERT().\r
 \r
   @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
-  @param  Andata    The value to AND with the PCI configuration register.\r
+  @param  AndData    The value to AND with the PCI configuration register.\r
   @param  OrData    The value to OR with the PCI configuration register.\r
 \r
   @return The value written to the PCI configuration register.\r
@@ -156,8 +150,7 @@ PciSegmentAndThenOr8 (
   IN UINT64                    Address,\r
   IN UINT8                     AndData,\r
   IN UINT8                     OrData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads a bit field of a PCI configuration register.\r
@@ -185,8 +178,7 @@ PciSegmentBitFieldRead8 (
   IN UINT64                    Address,\r
   IN UINTN                     StartBit,\r
   IN UINTN                     EndBit\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Writes a bit field to a PCI configuration register.\r
@@ -217,8 +209,7 @@ PciSegmentBitFieldWrite8 (
   IN UINTN                     StartBit,\r
   IN UINTN                     EndBit,\r
   IN UINT8                     Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads the 8-bit PCI configuration register specified by Address,\r
@@ -242,8 +233,7 @@ PciSegmentBitFieldOr8 (
   IN UINTN                     StartBit,\r
   IN UINTN                     EndBit,\r
   IN UINT8                     OrData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads a bit field in an 8-bit PCI configuration, performs a bitwise OR,\r
@@ -277,8 +267,7 @@ PciSegmentBitFieldAnd8 (
   IN UINTN                     StartBit,\r
   IN UINTN                     EndBit,\r
   IN UINT8                     AndData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads a bit field in an 8-bit PCI configuration register, performs a bitwise AND,\r
@@ -314,8 +303,7 @@ PciSegmentBitFieldAndThenOr8 (
   IN UINTN                     EndBit,\r
   IN UINT8                     AndData,\r
   IN UINT8                     OrData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads a 16-bit PCI configuration register.\r
@@ -333,8 +321,7 @@ UINT16
 EFIAPI\r
 PciSegmentRead16 (\r
   IN UINT64                    Address\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Writes a 16-bit PCI configuration register.\r
@@ -354,8 +341,7 @@ EFIAPI
 PciSegmentWrite16 (\r
   IN UINT64                    Address,\r
   IN UINT16                    Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Performs a bitwise inclusive OR of a 16-bit PCI configuration register with a 16-bit value.\r
@@ -378,8 +364,7 @@ EFIAPI
 PciSegmentOr16 (\r
   IN UINT64                    Address,\r
   IN UINT16                    OrData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit value.\r
@@ -392,7 +377,7 @@ PciSegmentOr16 (
   If any reserved bits in Address are set, then ASSERT().\r
 \r
   @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
-  @param  Andata    The value to AND with the PCI configuration register.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
@@ -402,8 +387,7 @@ EFIAPI
 PciSegmentAnd16 (\r
   IN UINT64                    Address,\r
   IN UINT16                    AndData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit value,\r
@@ -418,7 +402,7 @@ PciSegmentAnd16 (
   If any reserved bits in Address are set, then ASSERT().\r
 \r
   @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
-  @param  Andata    The value to AND with the PCI configuration register.\r
+  @param  AndData    The value to AND with the PCI configuration register.\r
   @param  OrData    The value to OR with the PCI configuration register.\r
 \r
   @return The value written to the PCI configuration register.\r
@@ -430,8 +414,7 @@ PciSegmentAndThenOr16 (
   IN UINT64                    Address,\r
   IN UINT16                    AndData,\r
   IN UINT16                    OrData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads a bit field of a PCI configuration register.\r
@@ -459,8 +442,7 @@ PciSegmentBitFieldRead16 (
   IN UINT64                    Address,\r
   IN UINTN                     StartBit,\r
   IN UINTN                     EndBit\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Writes a bit field to a PCI configuration register.\r
@@ -491,8 +473,7 @@ PciSegmentBitFieldWrite16 (
   IN UINTN                     StartBit,\r
   IN UINTN                     EndBit,\r
   IN UINT16                    Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads the 16-bit PCI configuration register specified by Address,\r
@@ -516,8 +497,7 @@ PciSegmentBitFieldOr16 (
   IN UINTN                     StartBit,\r
   IN UINTN                     EndBit,\r
   IN UINT16                    OrData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads a bit field in a 16-bit PCI configuration, performs a bitwise OR,\r
@@ -551,8 +531,7 @@ PciSegmentBitFieldAnd16 (
   IN UINTN                     StartBit,\r
   IN UINTN                     EndBit,\r
   IN UINT16                    AndData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads a bit field in a 16-bit PCI configuration register, performs a bitwise AND,\r
@@ -588,8 +567,7 @@ PciSegmentBitFieldAndThenOr16 (
   IN UINTN                     EndBit,\r
   IN UINT16                    AndData,\r
   IN UINT16                    OrData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads a 32-bit PCI configuration register.\r
@@ -607,8 +585,7 @@ UINT32
 EFIAPI\r
 PciSegmentRead32 (\r
   IN UINT64                    Address\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Writes a 32-bit PCI configuration register.\r
@@ -628,8 +605,7 @@ EFIAPI
 PciSegmentWrite32 (\r
   IN UINT64                    Address,\r
   IN UINT32                    Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Performs a bitwise inclusive OR of a 32-bit PCI configuration register with a 32-bit value.\r
@@ -652,8 +628,7 @@ EFIAPI
 PciSegmentOr32 (\r
   IN UINT64                    Address,\r
   IN UINT32                    OrData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit value.\r
@@ -666,7 +641,7 @@ PciSegmentOr32 (
   If any reserved bits in Address are set, then ASSERT().\r
 \r
   @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
-  @param  Andata    The value to AND with the PCI configuration register.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
 \r
   @return The value written to the PCI configuration register.\r
 \r
@@ -676,8 +651,7 @@ EFIAPI
 PciSegmentAnd32 (\r
   IN UINT64                    Address,\r
   IN UINT32                    AndData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit value,\r
@@ -692,7 +666,7 @@ PciSegmentAnd32 (
   If any reserved bits in Address are set, then ASSERT().\r
 \r
   @param  Address   Address that encodes the PCI Segment, Bus, Device, Function, and Register.\r
-  @param  Andata    The value to AND with the PCI configuration register.\r
+  @param  AndData   The value to AND with the PCI configuration register.\r
   @param  OrData    The value to OR with the PCI configuration register.\r
 \r
   @return The value written to the PCI configuration register.\r
@@ -704,8 +678,7 @@ PciSegmentAndThenOr32 (
   IN UINT64                    Address,\r
   IN UINT32                    AndData,\r
   IN UINT32                    OrData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads a bit field of a PCI configuration register.\r
@@ -733,8 +706,7 @@ PciSegmentBitFieldRead32 (
   IN UINT64                    Address,\r
   IN UINTN                     StartBit,\r
   IN UINTN                     EndBit\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Writes a bit field to a PCI configuration register.\r
@@ -765,8 +737,7 @@ PciSegmentBitFieldWrite32 (
   IN UINTN                     StartBit,\r
   IN UINTN                     EndBit,\r
   IN UINT32                    Value\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads the 32-bit PCI configuration register specified by Address,\r
@@ -790,8 +761,7 @@ PciSegmentBitFieldOr32 (
   IN UINTN                     StartBit,\r
   IN UINTN                     EndBit,\r
   IN UINT32                    OrData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads a bit field in a 32-bit PCI configuration, performs a bitwise OR,\r
@@ -825,8 +795,7 @@ PciSegmentBitFieldAnd32 (
   IN UINTN                     StartBit,\r
   IN UINTN                     EndBit,\r
   IN UINT32                    AndData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads a bit field in a 32-bit PCI configuration register, performs a bitwise AND,\r
@@ -862,8 +831,7 @@ PciSegmentBitFieldAndThenOr32 (
   IN UINTN                     EndBit,\r
   IN UINT32                    AndData,\r
   IN UINT32                    OrData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Reads a range of PCI configuration registers into a caller supplied buffer.\r
@@ -890,8 +858,7 @@ PciSegmentReadBuffer (
   IN  UINT64                   StartAddress,\r
   IN  UINTN                    Size,\r
   OUT VOID                     *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Copies the data in a caller supplied buffer to a specified range of PCI configuration space.\r
@@ -918,7 +885,6 @@ PciSegmentWriteBuffer (
   IN UINT64                    StartAddress,\r
   IN UINTN                     Size,\r
   IN VOID                      *Buffer\r
-  )\r
-;\r
+  );\r
 \r
 #endif\r