Code Scrub for Pcd, PlatformDriOverride and PlatOverMngr driver.

[mirror_edk2.git] / MdeModulePkg / Universal / PlatformDriverOverride / PlatformDriOverrideDxe / PlatformDriOverride.h

diff --git a/MdeModulePkg/Universal/PlatformDriverOverride/PlatformDriOverrideDxe/PlatformDriOverride.h b/MdeModulePkg/Universal/PlatformDriverOverride/PlatformDriOverrideDxe/PlatformDriOverride.h
index 2fa2ae89299ed84dc8a7b705d1e6ae2c8ef2c6f4..31f2077be9b09272d4eb00a4f3c859b291ae7868 100644 (file)
--- a/MdeModulePkg/Universal/PlatformDriverOverride/PlatformDriOverrideDxe/PlatformDriOverride.h
+++ b/MdeModulePkg/Universal/PlatformDriverOverride/PlatformDriOverrideDxe/PlatformDriOverride.h
@@ -18,8 +18,8 @@ Abstract:
 \r
 **/\r
 \r
-#ifndef PLATFORM_DRI_OVERRIDE_H_\r
-#define PLATFORM_DRI_OVERRIDE_H_\r
+#ifndef _PLATFORM_DRI_OVERRIDE_H_\r
+#define _PLATFORM_DRI_OVERRIDE_H_\r
 \r
 #include <Uefi.h>\r
 \r
@@ -28,6 +28,29 @@ Abstract:
 #include <Library/BaseLib.h>\r
 #include <Library/PlatDriOverLib.h>\r
 \r
+/**\r
+  Retrieves the image handle of the platform override driver for a controller in the system.\r
+\r
+  @param  This                   A pointer to the\r
+                                 EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.\r
+  @param  ControllerHandle       The device handle of the controller to check if a\r
+                                 driver override exists.\r
+  @param  DriverImageHandle      On input, a pointer to the previous driver image\r
+                                 handle returned by GetDriver().  On output, a\r
+                                 pointer to the next driver image handle. Passing\r
+                                 in a NULL,  will return the first driver image\r
+                                 handle for ControllerHandle.\r
+\r
+  @retval EFI_SUCCESS            The driver override for ControllerHandle was\r
+                                 returned in DriverImageHandle.\r
+  @retval EFI_NOT_FOUND          A driver override for ControllerHandle was not\r
+                                 found.\r
+  @retval EFI_INVALID_PARAMETER  The handle specified by ControllerHandle is not a\r
+                                 valid handle. DriverImageHandle is not a handle\r
+                                 that was returned on a previous  call to\r
+                                 GetDriver().\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 GetDriver (\r
@@ -36,6 +59,18 @@ GetDriver (
   IN OUT EFI_HANDLE                                     * DriverImageHandle\r
   );\r
 \r
+/**\r
+  For the use of the ControllerHandle parameter in the GetDriverPath()\r
+  But this API is very difficult to use, so not support.\r
+\r
+  @param  This                   A pointer to the\r
+                                 EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.\r
+  @param  ControllerHandle       The device handle of the controller to check if a\r
+                                 driver override exists.\r
+  @param  DriverImagePath        The device path for this Image.\r
+  \r
+  @retval EFI_UNSUPPORTED\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 GetDriverPath (\r
@@ -44,6 +79,23 @@ GetDriverPath (
   IN OUT EFI_DEVICE_PATH_PROTOCOL                       **DriverImagePath\r
   );\r
 \r
+/**\r
+  For the use of the ControllerHandle parameter in the DriverLoaded()\r
+  But this API is very difficult to use, so not support.\r
+\r
+  @param  This                   A pointer to the\r
+                                 EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL instance.\r
+  @param  ControllerHandle       The device handle of the controller to check if a\r
+                                 driver override exists.\r
+  @param  DriverImagePath        The device path for this Image.\r
+  @param  DriverImageHandle      On input, a pointer to the previous driver image\r
+                                 handle returned by GetDriver().  On output, a\r
+                                 pointer to the next driver image handle. Passing\r
+                                 in a NULL,  will return the first driver image\r
+                                 handle for ControllerHandle.\r
+  \r
+  @retval EFI_UNSUPPORTED\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 DriverLoaded (\r