fixed ECC and Klocwork issues.

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciDeviceSupport.h

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDeviceSupport.h b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDeviceSupport.h
index 059077a89abf0b86b9fbbbe7ab43ff36a49f2c07..af162dc198c3423323545af182abb70c03a0b4ae 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDeviceSupport.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDeviceSupport.h
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r

 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r


@@ -11,11 +11,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
 \r
 **/\r
 \r

-#ifndef _EFI_PCI_DEVICE_SUPPORT_H\r
-#define _EFI_PCI_DEVICE_SUPPORT_H\r
+#ifndef _EFI_PCI_DEVICE_SUPPORT_H_\r
+#define _EFI_PCI_DEVICE_SUPPORT_H_\r

 \r
 /**\r
 \r
 /**\r

-  Initialize the gPciDevicePool\r
+  Initialize the gPciDevicePool.\r

 **/\r
 EFI_STATUS\r
 InitializePciDevicePool (\r
 **/\r
 EFI_STATUS\r
 InitializePciDevicePool (\r


@@ -183,29 +183,36 @@ CreateRootBridge (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Get root bridge device instance by specific handle\r
+  Get root bridge device instance by specific handle.\r

 \r
 \r

-  @param RootBridgeHandle    Given root bridge handle\r
+  @param RootBridgeHandle    Given root bridge handle.\r

 \r
 \r

-  @return root bridge device instance\r
+  @return root bridge device instance.\r

 **/\r
 PCI_IO_DEVICE *\r
 GetRootBridgeByHandle (\r
   EFI_HANDLE RootBridgeHandle\r
   );\r
 \r
 **/\r
 PCI_IO_DEVICE *\r
 GetRootBridgeByHandle (\r
   EFI_HANDLE RootBridgeHandle\r
   );\r
 \r

+/**\r
+  Check root bridge device is existed or not.\r
+\r
+  @param RootBridgeHandle    Given root bridge handle.\r
+\r
+  @return root bridge device is existed or not.\r
+**/\r

 BOOLEAN\r
 RootBridgeExisted (\r
   IN EFI_HANDLE RootBridgeHandle\r
   );\r
 \r
 /**\r
 BOOLEAN\r
 RootBridgeExisted (\r
   IN EFI_HANDLE RootBridgeHandle\r
   );\r
 \r
 /**\r

-  Judege whether Pci device existed\r
+  Judege whether Pci device existed.\r

   \r
   \r

-  @param Bridge       Parent bridege instance \r
-  @param PciIoDevice  Device instance\r
+  @param Bridge       Parent bridege instance. \r
+  @param PciIoDevice  Device instance.\r

   \r
   \r

-  @return whether Pci device existed\r
+  @return whether Pci device existed.\r

 **/\r
 BOOLEAN\r
 PciDeviceExisted (\r
 **/\r
 BOOLEAN\r
 PciDeviceExisted (\r


@@ -214,11 +221,11 @@ PciDeviceExisted (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Active VGA device\r
+  Active VGA device.\r

   \r
   \r

-  @param VgaDevice device instance for VGA\r
+  @param VgaDevice device instance for VGA.\r

   \r
   \r

-  @return device instance\r
+  @return device instance.\r

 **/\r
 PCI_IO_DEVICE *\r
 ActiveVGADeviceOnTheSameSegment (\r
 **/\r
 PCI_IO_DEVICE *\r
 ActiveVGADeviceOnTheSameSegment (\r


@@ -226,11 +233,11 @@ ActiveVGADeviceOnTheSameSegment (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Active VGA device on root bridge\r
+  Active VGA device on root bridge.\r

   \r
   \r

-  @param RootBridge  Root bridge device instance\r
+  @param RootBridge  Root bridge device instance.\r

   \r
   \r

-  @return VGA device instance\r
+  @return VGA device instance.\r

 **/\r
 PCI_IO_DEVICE *\r
 ActiveVGADeviceOnTheRootBridge (\r
 **/\r
 PCI_IO_DEVICE *\r
 ActiveVGADeviceOnTheRootBridge (\r


@@ -238,13 +245,13 @@ ActiveVGADeviceOnTheRootBridge (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Get HPC PCI address according to its device path\r
-  @param PciRootBridgeIo   Root bridege Io instance\r
-  @param HpcDevicePath     Given searching device path\r
-  @param PciAddress        Buffer holding searched result\r
+  Get HPC PCI address according to its device path.\r
+  @param PciRootBridgeIo   Root bridege Io instance.\r
+  @param HpcDevicePath     Given searching device path.\r
+  @param PciAddress        Buffer holding searched result.\r

   \r
   @retval EFI_NOT_FOUND Can not find the specific device path.\r
   \r
   @retval EFI_NOT_FOUND Can not find the specific device path.\r

-  @retval EFI_SUCCESS   Success to get the device path\r
+  @retval EFI_SUCCESS   Success to get the device path.\r

 **/\r
 EFI_STATUS\r
 GetHpcPciAddress (\r
 **/\r
 EFI_STATUS\r
 GetHpcPciAddress (\r


@@ -254,10 +261,10 @@ GetHpcPciAddress (
   );\r
 \r
 /**\r
   );\r
 \r
 /**\r

-  Get HPC PCI address according to its device path\r
-  @param RootBridge           Root bridege Io instance\r
-  @param RemainingDevicePath  Given searching device path\r
-  @param PciAddress           Buffer holding searched result\r
+  Get HPC PCI address according to its device path.\r
+  @param RootBridge           Root bridege Io instance.\r
+  @param RemainingDevicePath  Given searching device path.\r
+  @param PciAddress           Buffer holding searched result.\r

   \r
   @retval EFI_NOT_FOUND Can not find the specific device path.\r
 **/\r
   \r
   @retval EFI_NOT_FOUND Can not find the specific device path.\r
 **/\r