Code Scrub for Pcd, PlatformDriOverride and PlatOverMngr driver.

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

diff --git a/MdeModulePkg/Universal/PlatformDriverOverride/PlatformDriOverrideDxe/PlatformDriOverride.c b/MdeModulePkg/Universal/PlatformDriverOverride/PlatformDriOverrideDxe/PlatformDriOverride.c
index 75032720fd0709dedcdd7a8ba2d1044b99600010..fd3aee9ad03819fb38c4f62c5b9f152e9dd89d59 100644 (file)
--- a/MdeModulePkg/Universal/PlatformDriverOverride/PlatformDriOverrideDxe/PlatformDriOverride.c
+++ b/MdeModulePkg/Universal/PlatformDriverOverride/PlatformDriOverrideDxe/PlatformDriOverride.c
@@ -31,25 +31,23 @@ LIST_ENTRY      mMappingDataBase = INITIALIZE_LIST_HEAD_VARIABLE (mMappingDataBa
 BOOLEAN         mEnvironmentVariableRead = FALSE;\r
 EFI_HANDLE      mCallerImageHandle;\r
 \r
+/**\r
+  Platform Driver Override driver entry point, install the Platform Driver Override Protocol\r
+\r
+  @param  ImageHandle  ImageHandle of the loaded driver.\r
+  @param  SystemTable  Pointer to the EFI System Table.\r
 \r
+  @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
+                                     or UEFI Driver exited normally.\r
+  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.\r
+  @retval  Other                     Return value from ProcessModuleEntryPointList().\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PlatformDriverOverrideEntry (\r
   IN EFI_HANDLE        ImageHandle,\r
   IN EFI_SYSTEM_TABLE  *SystemTable\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-   Platform Driver Override driver entry point, install the Platform Driver Override Protocol\r
-\r
-Arguments:\r
-  (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
-\r
-Returns:\r
-  EFI_STATUS\r
-\r
---*/\r
 {\r
   mEnvironmentVariableRead = FALSE;\r
   mCallerImageHandle = ImageHandle;\r
@@ -145,11 +143,16 @@ GetDriver (
 \r
 \r
 /**\r
-  For the use of the ControllerHandle parameter in the GetDriverPath() and DriverLoaded() APIs\r
-  makes those APIs very difficult to use, so not support.\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
@@ -164,11 +167,21 @@ GetDriverPath (
 \r
 \r
 /**\r
-  For the use of the ControllerHandle parameter in the GetDriverPath() and DriverLoaded() APIs\r
-  makes those APIs very difficult to use, so not support.\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