Coding style modification.

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciIo.c

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciIo.c b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciIo.c
index 765cf4c87afe097212e6735266ae9e3b9ffa7ce0..79ebe5fabd2e06cd0f6a1909e820f965ec84519b 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciIo.c
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciIo.c
@@ -66,7 +66,7 @@ ReportErrorStatusCode (
   IN PCI_IO_DEVICE               *PciIoDevice,\r
   IN EFI_STATUS_CODE_VALUE       Code\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -78,7 +78,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    PciIoDevice - add argument and description to function comment\r
 // TODO:    Code - add argument and description to function comment\r
 {\r
@@ -93,7 +93,7 @@ EFI_STATUS
 InitializePciIoInstance (\r
   PCI_IO_DEVICE  *PciIoDevice\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -105,7 +105,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    PciIoDevice - add argument and description to function comment\r
 // TODO:    EFI_SUCCESS - add return value to function comment\r
 {\r
@@ -122,7 +122,7 @@ PciIoVerifyBarAccess (
   IN UINTN                        Count,\r
   UINT64                          *Offset\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -134,7 +134,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    PciIoDevice - add argument and description to function comment\r
 // TODO:    BarIndex - add argument and description to function comment\r
 // TODO:    Type - add argument and description to function comment\r
@@ -193,7 +193,7 @@ PciIoVerifyConfigAccess (
   IN UINTN                      Count,\r
   IN UINT64                     *Offset\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -205,7 +205,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    PciIoDevice - add argument and description to function comment\r
 // TODO:    Width - add argument and description to function comment\r
 // TODO:    Count - add argument and description to function comment\r
@@ -258,7 +258,7 @@ PciIoPollMem (
   IN  UINT64                     Delay,\r
   OUT UINT64                     *Result\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -270,7 +270,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Width - add argument and description to function comment\r
 // TODO:    BarIndex - add argument and description to function comment\r
@@ -330,7 +330,7 @@ PciIoPollIo (
   IN  UINT64                     Delay,\r
   OUT UINT64                     *Result\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -342,7 +342,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Width - add argument and description to function comment\r
 // TODO:    BarIndex - add argument and description to function comment\r
@@ -396,7 +396,7 @@ PciIoMemRead (
   IN     UINTN                      Count,\r
   IN OUT VOID                       *Buffer\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -408,7 +408,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Width - add argument and description to function comment\r
 // TODO:    BarIndex - add argument and description to function comment\r
@@ -457,7 +457,7 @@ PciIoMemWrite (
   IN     UINTN                      Count,\r
   IN OUT VOID                       *Buffer\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -469,7 +469,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Width - add argument and description to function comment\r
 // TODO:    BarIndex - add argument and description to function comment\r
@@ -518,7 +518,7 @@ PciIoIoRead (
   IN     UINTN                      Count,\r
   IN OUT VOID                       *Buffer\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -530,7 +530,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Width - add argument and description to function comment\r
 // TODO:    BarIndex - add argument and description to function comment\r
@@ -579,7 +579,7 @@ PciIoIoWrite (
   IN     UINTN                      Count,\r
   IN OUT VOID                       *Buffer\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -591,7 +591,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Width - add argument and description to function comment\r
 // TODO:    BarIndex - add argument and description to function comment\r
@@ -639,7 +639,7 @@ PciIoConfigRead (
   IN     UINTN                      Count,\r
   IN OUT VOID                       *Buffer\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -651,7 +651,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Width - add argument and description to function comment\r
 // TODO:    Offset - add argument and description to function comment\r
@@ -694,7 +694,7 @@ PciIoConfigWrite (
   IN     UINTN                      Count,\r
   IN OUT VOID                       *Buffer\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -706,7 +706,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Width - add argument and description to function comment\r
 // TODO:    Offset - add argument and description to function comment\r
@@ -751,7 +751,7 @@ PciIoCopyMem (
   IN     UINT64                       SrcOffset,\r
   IN     UINTN                        Count\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -763,7 +763,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Width - add argument and description to function comment\r
 // TODO:    DestBarIndex - add argument and description to function comment\r
@@ -831,7 +831,7 @@ PciIoMap (
   OUT    EFI_PHYSICAL_ADDRESS           *DeviceAddress,\r
   OUT    VOID                           **Mapping\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -843,7 +843,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Operation - add argument and description to function comment\r
 // TODO:    HostAddress - add argument and description to function comment\r
@@ -892,7 +892,7 @@ PciIoUnmap (
   IN  EFI_PCI_IO_PROTOCOL  *This,\r
   IN  VOID                 *Mapping\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -904,7 +904,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Mapping - add argument and description to function comment\r
 {\r
@@ -935,7 +935,7 @@ PciIoAllocateBuffer (
   OUT VOID                  **HostAddress,\r
   IN  UINT64                Attributes\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -947,7 +947,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Type - add argument and description to function comment\r
 // TODO:    MemoryType - add argument and description to function comment\r
@@ -993,7 +993,7 @@ PciIoFreeBuffer (
   IN  UINTN                 Pages,\r
   IN  VOID                  *HostAddress\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -1005,7 +1005,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Pages - add argument and description to function comment\r
 // TODO:    HostAddress - add argument and description to function comment\r
@@ -1033,7 +1033,7 @@ EFIAPI
 PciIoFlush (\r
   IN  EFI_PCI_IO_PROTOCOL  *This\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -1045,7 +1045,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 {\r
   EFI_STATUS    Status;\r
@@ -1072,7 +1072,7 @@ PciIoGetLocation (
   OUT UINTN                *Device,\r
   OUT UINTN                *Function\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -1084,7 +1084,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Segment - add argument and description to function comment\r
 // TODO:    Bus - add argument and description to function comment\r
@@ -1115,7 +1115,7 @@ CheckBarType (
   UINT8                  BarIndex,\r
   PCI_BAR_TYPE           BarType\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -1127,7 +1127,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    PciIoDevice - add argument and description to function comment\r
 // TODO:    BarIndex - add argument and description to function comment\r
 // TODO:    BarType - add argument and description to function comment\r
@@ -1166,7 +1166,7 @@ ModifyRootBridgeAttributes (
   IN  UINT64                                   Attributes,\r
   IN  EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION  Operation\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -1178,7 +1178,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    PciIoDevice - add argument and description to function comment\r
 // TODO:    Attributes - add argument and description to function comment\r
 // TODO:    Operation - add argument and description to function comment\r
@@ -1244,7 +1244,7 @@ SupportPaletteSnoopAttributes (
   IN  PCI_IO_DEVICE                            *PciIoDevice,\r
   IN  EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION  Operation\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -1256,7 +1256,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    PciIoDevice - add argument and description to function comment\r
 // TODO:    Operation - add argument and description to function comment\r
 // TODO:    EFI_UNSUPPORTED - add return value to function comment\r
@@ -1372,7 +1372,7 @@ PciIoAttributes (
   IN  UINT64                                   Attributes,\r
   OUT UINT64                                   *Result OPTIONAL\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -1383,7 +1383,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Operation - add argument and description to function comment\r
 // TODO:    Attributes - add argument and description to function comment\r
@@ -1666,7 +1666,7 @@ PciIoGetBarAttributes (
   OUT UINT64                         *Supports, OPTIONAL\r
   OUT VOID                           **Resources OPTIONAL\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -1677,7 +1677,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    BarIndex - add argument and description to function comment\r
 // TODO:    Supports - add argument and description to function comment\r
@@ -1830,7 +1830,7 @@ PciIoSetBarAttributes (
   IN OUT UINT64                       *Offset,\r
   IN OUT UINT64                       *Length\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -1841,7 +1841,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    This - add argument and description to function comment\r
 // TODO:    Attributes - add argument and description to function comment\r
 // TODO:    BarIndex - add argument and description to function comment\r
@@ -1905,7 +1905,7 @@ UpStreamBridgesAttributes (
   IN  EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION  Operation,\r
   IN  UINT64                                   Attributes\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -1915,7 +1915,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    PciIoDevice - add argument and description to function comment\r
 // TODO:    Operation - add argument and description to function comment\r
 // TODO:    Attributes - add argument and description to function comment\r
@@ -1946,7 +1946,7 @@ PciDevicesOnTheSamePath (
   IN PCI_IO_DEVICE        *PciDevice1,\r
   IN PCI_IO_DEVICE        *PciDevice2\r
   )\r
-/*++\r
+/**\r
 \r
 Routine Description:\r
 \r
@@ -1956,7 +1956,7 @@ Returns:
 \r
   None\r
 \r
---*/\r
+**/\r
 // TODO:    PciDevice1 - add argument and description to function comment\r
 // TODO:    PciDevice2 - add argument and description to function comment\r
 {\r