]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/DebugPortDxe/DebugPort.c
Fix a bug in DebugPort driver's Unload() that leaves the DriverBinding/ComponentName...
[mirror_edk2.git] / MdeModulePkg / Universal / DebugPortDxe / DebugPort.c
index ffe3fb72ecf0fc8fa567d6ecc61b224a4f7b18f0..984288e30267a6e0c12761db8098cad01895e657 100644 (file)
@@ -4,8 +4,8 @@
   ALL CODE IN THE SERIALIO STACK MUST BE RE-ENTRANT AND CALLABLE FROM\r
   INTERRUPT CONTEXT\r
 \r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
 http://opensource.org/licenses/bsd-license.php\r
@@ -33,13 +33,12 @@ DEBUGPORT_DEVICE mDebugPortDevice = {
   DEBUGPORT_DEVICE_SIGNATURE,\r
   (EFI_HANDLE) 0,\r
   (EFI_HANDLE) 0,\r
-  (VOID *) NULL,\r
   (EFI_DEVICE_PATH_PROTOCOL *) NULL,\r
   {\r
     DebugPortReset,\r
-    DebugPortRead, \r
-    DebugPortWrite, \r
-    DebugPortPoll \r
+    DebugPortWrite,\r
+    DebugPortRead,\r
+    DebugPortPoll\r
   },\r
   (EFI_HANDLE) 0,\r
   (EFI_SERIAL_IO_PROTOCOL *) NULL,\r
@@ -57,85 +56,65 @@ DEBUGPORT_DEVICE mDebugPortDevice = {
   Records requested settings in DebugPort device structure.\r
 \r
 **/\r
-VOID\r
+EFI_DEVICE_PATH_PROTOCOL *\r
 GetDebugPortVariable (\r
   VOID\r
   )\r
 {\r
   UINTN                     DataSize;\r
+  EFI_DEVICE_PATH_PROTOCOL  *DebugPortVariable;\r
   EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
-  EFI_STATUS                Status;\r
-\r
-  DataSize = 0;\r
-\r
-  Status = gRT->GetVariable (\r
-                  (CHAR16 *) EFI_DEBUGPORT_VARIABLE_NAME,\r
-                  &gEfiDebugPortVariableGuid,\r
-                  NULL,\r
-                  &DataSize,\r
-                  mDebugPortDevice.DebugPortVariable\r
-                  );\r
 \r
-  if (Status == EFI_BUFFER_TOO_SMALL) {\r
-    if (mDebugPortDevice.DebugPortVariable != NULL) {\r
-      FreePool (mDebugPortDevice.DebugPortVariable);\r
-    }\r
+  GetVariable2 (EFI_DEBUGPORT_VARIABLE_NAME, &gEfiDebugPortVariableGuid, &DebugPortVariable, &DataSize);\r
+  if (DebugPortVariable == NULL) {\r
+    return NULL;\r
+  }\r
 \r
-    mDebugPortDevice.DebugPortVariable = AllocatePool (DataSize);\r
-    if (mDebugPortDevice.DebugPortVariable != NULL) {\r
-      gRT->GetVariable (\r
-            (CHAR16 *) EFI_DEBUGPORT_VARIABLE_NAME,\r
-            &gEfiDebugPortVariableGuid,\r
-            NULL,\r
-            &DataSize,\r
-            mDebugPortDevice.DebugPortVariable\r
-            );\r
-      DevicePath = (EFI_DEVICE_PATH_PROTOCOL *) mDebugPortDevice.DebugPortVariable;\r
-      while (!IsDevicePathEnd (DevicePath) && !IS_UART_DEVICEPATH (DevicePath)) {\r
-        DevicePath = NextDevicePathNode (DevicePath);\r
-      }\r
+  DevicePath = DebugPortVariable;\r
+  while (!IsDevicePathEnd (DevicePath) && !IS_UART_DEVICEPATH (DevicePath)) {\r
+    DevicePath = NextDevicePathNode (DevicePath);\r
+  }\r
 \r
-      if (IsDevicePathEnd (DevicePath)) {\r
-        FreePool (mDebugPortDevice.DebugPortVariable);\r
-        mDebugPortDevice.DebugPortVariable = NULL;\r
-      } else {\r
-        CopyMem (\r
-          &mDebugPortDevice.BaudRate,\r
-          &((UART_DEVICE_PATH *) DevicePath)->BaudRate,\r
-          sizeof (((UART_DEVICE_PATH *) DevicePath)->BaudRate)\r
-          );\r
-        mDebugPortDevice.ReceiveFifoDepth = DEBUGPORT_UART_DEFAULT_FIFO_DEPTH;\r
-        mDebugPortDevice.Timeout          = DEBUGPORT_UART_DEFAULT_TIMEOUT;\r
-        CopyMem (\r
-          &mDebugPortDevice.Parity,\r
-          &((UART_DEVICE_PATH *) DevicePath)->Parity,\r
-          sizeof (((UART_DEVICE_PATH *) DevicePath)->Parity)\r
-          );\r
-        CopyMem (\r
-          &mDebugPortDevice.DataBits,\r
-          &((UART_DEVICE_PATH *) DevicePath)->DataBits,\r
-          sizeof (((UART_DEVICE_PATH *) DevicePath)->DataBits)\r
-          );\r
-        CopyMem (\r
-          &mDebugPortDevice.StopBits,\r
-          &((UART_DEVICE_PATH *) DevicePath)->StopBits,\r
-          sizeof (((UART_DEVICE_PATH *) DevicePath)->StopBits)\r
-          );\r
-      }\r
-    }\r
+  if (IsDevicePathEnd (DevicePath)) {\r
+    FreePool (DebugPortVariable);\r
+    return NULL;\r
+  } else {\r
+    CopyMem (\r
+      &mDebugPortDevice.BaudRate,\r
+      &((UART_DEVICE_PATH *) DevicePath)->BaudRate,\r
+      sizeof (((UART_DEVICE_PATH *) DevicePath)->BaudRate)\r
+      );\r
+    mDebugPortDevice.ReceiveFifoDepth = DEBUGPORT_UART_DEFAULT_FIFO_DEPTH;\r
+    mDebugPortDevice.Timeout          = DEBUGPORT_UART_DEFAULT_TIMEOUT;\r
+    CopyMem (\r
+      &mDebugPortDevice.Parity,\r
+      &((UART_DEVICE_PATH *) DevicePath)->Parity,\r
+      sizeof (((UART_DEVICE_PATH *) DevicePath)->Parity)\r
+      );\r
+    CopyMem (\r
+      &mDebugPortDevice.DataBits,\r
+      &((UART_DEVICE_PATH *) DevicePath)->DataBits,\r
+      sizeof (((UART_DEVICE_PATH *) DevicePath)->DataBits)\r
+      );\r
+    CopyMem (\r
+      &mDebugPortDevice.StopBits,\r
+      &((UART_DEVICE_PATH *) DevicePath)->StopBits,\r
+      sizeof (((UART_DEVICE_PATH *) DevicePath)->StopBits)\r
+      );\r
+    return DebugPortVariable;\r
   }\r
 }\r
 \r
 /**\r
-  Debug Port Driver entry point. \r
+  Debug Port Driver entry point.\r
 \r
   Reads DebugPort variable to determine what device and settings to use as the\r
   debug port.  Binds exclusively to SerialIo. Reverts to defaults if no variable\r
   is found.\r
 \r
-  @param[in] ImageHandle       The firmware allocated handle for the EFI image.  \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
+\r
   @retval EFI_SUCCESS          The entry point is executed successfully.\r
   @retval EFI_OUT_OF_RESOURCES Fails to allocate memory for device.\r
   @retval other                Some error occurs when executing this entry point.\r
@@ -167,7 +146,7 @@ InitializeDebugPortDriver (
 }\r
 \r
 /**\r
-  Checks to see if there's not already a DebugPort interface somewhere. \r
+  Checks to see if there's not already a DebugPort interface somewhere.\r
 \r
   If there's a DEBUGPORT variable, the device path must match exactly.  If there's\r
   no DEBUGPORT variable, then device path is not checked and does not matter.\r
@@ -196,15 +175,15 @@ DebugPortSupported (
   )\r
 {\r
   EFI_STATUS                Status;\r
-  EFI_DEVICE_PATH_PROTOCOL  *Dp1;\r
-  EFI_DEVICE_PATH_PROTOCOL  *Dp2;\r
+  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
+  EFI_DEVICE_PATH_PROTOCOL  *DebugPortVariable;\r
   EFI_SERIAL_IO_PROTOCOL    *SerialIo;\r
   EFI_DEBUGPORT_PROTOCOL    *DebugPortInterface;\r
   EFI_HANDLE                TempHandle;\r
 \r
   //\r
-  // Check to see that there's not a debugport protocol already published\r
-  // Question: Why do we prevent debugport protocol published on more one device?\r
+  // Check to see that there's not a debugport protocol already published,\r
+  // since only one standard UART serial port could be supported by this driver.\r
   //\r
   if (gBS->LocateProtocol (&gEfiDebugPortProtocolGuid, NULL, (VOID **) &DebugPortInterface) != EFI_NOT_FOUND) {\r
     return EFI_UNSUPPORTED;\r
@@ -212,25 +191,19 @@ DebugPortSupported (
   //\r
   // Read DebugPort variable to determine debug port selection and parameters\r
   //\r
-  GetDebugPortVariable ();\r
+  DebugPortVariable = GetDebugPortVariable ();\r
 \r
-  if (mDebugPortDevice.DebugPortVariable != NULL) {\r
+  if (DebugPortVariable != NULL) {\r
     //\r
     // There's a DEBUGPORT variable, so do LocateDevicePath and check to see if\r
     // the closest matching handle matches the controller handle, and if it does,\r
     // check to see that the remaining device path has the DebugPort GUIDed messaging\r
     // device path only.  Otherwise, it's a mismatch and EFI_UNSUPPORTED is returned.\r
     //\r
-    Dp1 = DuplicateDevicePath ((EFI_DEVICE_PATH_PROTOCOL *) mDebugPortDevice.DebugPortVariable);\r
-    if (Dp1 == NULL) {\r
-      return EFI_OUT_OF_RESOURCES;\r
-    }\r
-\r
-    Dp2 = Dp1;\r
-\r
+    DevicePath = DebugPortVariable;\r
     Status = gBS->LocateDevicePath (\r
                     &gEfiSerialIoProtocolGuid,\r
-                    &Dp2,\r
+                    &DevicePath,\r
                     &TempHandle\r
                     );\r
 \r
@@ -238,19 +211,19 @@ DebugPortSupported (
       Status = EFI_UNSUPPORTED;\r
     }\r
 \r
-    if (Status == EFI_SUCCESS && \r
-        (Dp2->Type != MESSAGING_DEVICE_PATH ||\r
-         Dp2->SubType != MSG_VENDOR_DP || \r
-         *((UINT16 *) Dp2->Length) != sizeof (DEBUGPORT_DEVICE_PATH))) {\r
+    if (Status == EFI_SUCCESS &&\r
+        (DevicePath->Type != MESSAGING_DEVICE_PATH ||\r
+         DevicePath->SubType != MSG_VENDOR_DP ||\r
+         *((UINT16 *) DevicePath->Length) != sizeof (DEBUGPORT_DEVICE_PATH))) {\r
 \r
       Status = EFI_UNSUPPORTED;\r
     }\r
 \r
-    if (Status == EFI_SUCCESS && CompareMem (&gEfiDebugPortDevicePathGuid, Dp2 + 1, sizeof (EFI_GUID))) {\r
+    if (Status == EFI_SUCCESS && !CompareGuid (&gEfiDebugPortDevicePathGuid, (GUID *) (DevicePath + 1))) {\r
       Status = EFI_UNSUPPORTED;\r
     }\r
 \r
-    FreePool (Dp1);\r
+    FreePool (DebugPortVariable);\r
     if (EFI_ERROR (Status)) {\r
       return Status;\r
     }\r
@@ -289,7 +262,7 @@ DebugPortSupported (
 \r
   @retval EFI_SUCCESS          This driver is added to ControllerHandle.\r
   @retval EFI_OUT_OF_RESOURCES Fails to allocate memory for device.\r
-  @retval others               Some error occurs.                \r
+  @retval others               Some error occurs.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -365,7 +338,7 @@ DebugPortStart (
   DebugPortDP.Header.Type     = MESSAGING_DEVICE_PATH;\r
   DebugPortDP.Header.SubType  = MSG_VENDOR_DP;\r
   SetDevicePathNodeLength (&(DebugPortDP.Header), sizeof (DebugPortDP));\r
-  CopyMem (&DebugPortDP.Guid, &gEfiDebugPortDevicePathGuid, sizeof (EFI_GUID));\r
+  CopyGuid (&DebugPortDP.Guid, &gEfiDebugPortDevicePathGuid);\r
 \r
   Dp1 = DevicePathFromHandle (ControllerHandle);\r
   if (Dp1 == NULL) {\r
@@ -411,18 +384,6 @@ DebugPortStart (
                   );\r
 \r
   if (EFI_ERROR (Status)) {\r
-    DEBUG_CODE_BEGIN ();\r
-      UINTN  BufferSize;\r
-\r
-      BufferSize = 48;\r
-      DebugPortWrite (\r
-        &mDebugPortDevice.DebugPortInterface,\r
-        0,\r
-        &BufferSize,\r
-        "DebugPort driver failed to open child controller\n\n"\r
-        );\r
-    DEBUG_CODE_END ();\r
-\r
     gBS->CloseProtocol (\r
           ControllerHandle,\r
           &gEfiSerialIoProtocolGuid,\r
@@ -432,19 +393,6 @@ DebugPortStart (
     return Status;\r
   }\r
 \r
-  DEBUG_CODE_BEGIN ();\r
-    UINTN                     BufferSize;\r
-\r
-    BufferSize = 38;\r
-    DebugPortWrite (\r
-      &mDebugPortDevice.DebugPortInterface,\r
-      0,\r
-      &BufferSize,\r
-      "Hello World from the DebugPort driver\n\n"\r
-      );\r
-\r
-  DEBUG_CODE_END ();\r
-\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -547,11 +495,11 @@ DebugPortStop (
 \r
   The port itself should be fine since it was set up during initialization.\r
 \r
-  @param  This              Protocol instance pointer.   \r
+  @param  This              Protocol instance pointer.\r
 \r
   @return EFI_SUCCESS       Always.\r
 \r
-**/  \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 DebugPortReset (\r
@@ -579,8 +527,8 @@ DebugPortReset (
                               On output, the amount of data actually written.\r
   @param  Buffer              Pointer to buffer to read.\r
 \r
-  @retval EFI_SUCCESS         \r
-  @retval others              \r
+  @retval EFI_SUCCESS\r
+  @retval others\r
 \r
 **/\r
 EFI_STATUS\r
@@ -692,7 +640,7 @@ DebugPortWrite (
                               DebugPort interface\r
   @retval EFI_DEVICE_ERROR    A hardware failure occured... (from SerialIo)\r
 \r
-**/   \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 DebugPortPoll (\r
@@ -738,16 +686,60 @@ ImageUnloadHandler (
   EFI_HANDLE ImageHandle\r
   )\r
 {\r
+  EFI_STATUS  Status;\r
+  VOID        *ComponentName;\r
+  VOID        *ComponentName2;\r
+\r
   if (mDebugPortDevice.SerialIoBinding != NULL) {\r
     return EFI_ABORTED;\r
   }\r
 \r
   //\r
-  // Clean up allocations\r
+  // Driver is stopped already.\r
   //\r
-  if (mDebugPortDevice.DebugPortVariable != NULL) {\r
-    FreePool (mDebugPortDevice.DebugPortVariable);\r
+  Status = gBS->HandleProtocol (ImageHandle, &gEfiComponentNameProtocolGuid, &ComponentName);\r
+  if (EFI_ERROR (Status)) {\r
+    ComponentName = NULL;\r
   }\r
 \r
-  return EFI_SUCCESS;\r
+  Status = gBS->HandleProtocol (ImageHandle, &gEfiComponentName2ProtocolGuid, &ComponentName2);\r
+  if (EFI_ERROR (Status)) {\r
+    ComponentName2 = NULL;\r
+  }\r
+\r
+  if (ComponentName == NULL) {\r
+    if (ComponentName2 == NULL) {\r
+      Status = gBS->UninstallMultipleProtocolInterfaces (\r
+                      ImageHandle,\r
+                      &gEfiDriverBindingProtocolGuid,  &gDebugPortDriverBinding,\r
+                      NULL\r
+                      );\r
+    } else {\r
+      Status = gBS->UninstallMultipleProtocolInterfaces (\r
+                      ImageHandle,\r
+                      &gEfiDriverBindingProtocolGuid,  &gDebugPortDriverBinding,\r
+                      &gEfiComponentName2ProtocolGuid, ComponentName2,\r
+                      NULL\r
+                      );\r
+    }\r
+  } else {\r
+    if (ComponentName2 == NULL) {\r
+      Status = gBS->UninstallMultipleProtocolInterfaces (\r
+                      ImageHandle,\r
+                      &gEfiDriverBindingProtocolGuid,  &gDebugPortDriverBinding,\r
+                      &gEfiComponentNameProtocolGuid,  ComponentName,\r
+                      NULL\r
+                      );\r
+    } else {\r
+      Status = gBS->UninstallMultipleProtocolInterfaces (\r
+                      ImageHandle,\r
+                      &gEfiDriverBindingProtocolGuid,  &gDebugPortDriverBinding,\r
+                      &gEfiComponentNameProtocolGuid,  ComponentName,\r
+                      &gEfiComponentName2ProtocolGuid, ComponentName2,\r
+                      NULL\r
+                      );\r
+    }\r
+  }\r
+\r
+  return Status;\r
 }\r