Code scrub for DevicePathDxe driver.

[mirror_edk2.git] / MdeModulePkg / Universal / DevicePathDxe / DevicePath.c

diff --git a/MdeModulePkg/Universal/DevicePathDxe/DevicePath.c b/MdeModulePkg/Universal/DevicePathDxe/DevicePath.c
index 3149184a34584abb1555b7856bc75a16fe9e9807..660b595de5e4207ac5781a2605964161e87d953a 100644 (file)
--- a/MdeModulePkg/Universal/DevicePathDxe/DevicePath.c
+++ b/MdeModulePkg/Universal/DevicePathDxe/DevicePath.c
@@ -17,7 +17,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 EFI_HANDLE  mDevicePathHandle = NULL;\r
 \r
-GLOBAL_REMOVE_IF_UNREFERENCED const EFI_DEVICE_PATH_UTILITIES_PROTOCOL mDevicePathUtilities = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_DEVICE_PATH_UTILITIES_PROTOCOL mDevicePathUtilities = {\r
   GetDevicePathSizeProtocolInterface,\r
   DuplicateDevicePathProtocolInterface,\r
   AppendDevicePathProtocolInterface,\r
@@ -28,42 +28,43 @@ GLOBAL_REMOVE_IF_UNREFERENCED const EFI_DEVICE_PATH_UTILITIES_PROTOCOL mDevicePa
   CreateDeviceNodeProtocolInterface\r
 };\r
 \r
-GLOBAL_REMOVE_IF_UNREFERENCED const EFI_DEVICE_PATH_TO_TEXT_PROTOCOL   mDevicePathToText = {\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_DEVICE_PATH_TO_TEXT_PROTOCOL   mDevicePathToText = {\r
   ConvertDeviceNodeToText,\r
   ConvertDevicePathToText\r
 };\r
 \r
-GLOBAL_REMOVE_IF_UNREFERENCED const EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL mDevicePathFromText = {\r
-  ConvertTextToDeviceNode,  \r
-  ConvertTextToDevicePath  \r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL mDevicePathFromText = {\r
+  ConvertTextToDeviceNode,\r
+  ConvertTextToDevicePath\r
 };\r
 \r
-GLOBAL_REMOVE_IF_UNREFERENCED const EFI_GUID mEfiDevicePathMessagingUartFlowControlGuid = DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL;\r
-GLOBAL_REMOVE_IF_UNREFERENCED const EFI_GUID mEfiDevicePathMessagingSASGuid             = DEVICE_PATH_MESSAGING_SAS;\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_GUID mEfiDevicePathMessagingUartFlowControlGuid = DEVICE_PATH_MESSAGING_UART_FLOW_CONTROL;\r
+GLOBAL_REMOVE_IF_UNREFERENCED CONST EFI_GUID mEfiDevicePathMessagingSASGuid             = DEVICE_PATH_MESSAGING_SAS;\r
 \r
+\r
+\r
+/**\r
+  The user Entry Point for DevicePath module.\r
+\r
+  This is the entrhy point for DevicePath module. It installs the UEFI Device Path Utility Protocol and\r
+  optionall the Device Path to Text and Device Path from Text protocols based on feature flags.\r
+\r
+  @param[in] ImageHandle    The firmware allocated handle for the EFI image.\r
+  @param[in] SystemTable    A pointer to the EFI System Table.\r
+\r
+  @retval EFI_SUCCESS       The entry point is executed successfully.\r
+  @retval Others            Some error occurs when executing this entry point.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 DevicePathEntryPoint (\r
   IN EFI_HANDLE           ImageHandle,\r
   IN EFI_SYSTEM_TABLE     *SystemTable\r
   )\r
-/*++\r
-\r
-  Routine Description:\r
-    Entry point for EFI drivers.\r
-\r
-  Arguments:\r
-   ImageHandle - EFI_HANDLE\r
-   SystemTable - EFI_SYSTEM_TABLE\r
-\r
-  Returns:\r
-    EFI_SUCCESS\r
-    others\r
-\r
---*/\r
 {\r
   EFI_STATUS  Status;\r
- \r
+\r
   Status = EFI_UNSUPPORTED;\r
   if (FeaturePcdGet (PcdDevicePathSupportDevicePathToText)) {\r
     if (FeaturePcdGet (PcdDevicePathSupportDevicePathFromText)) {\r