ShellPkg: Clean up source files

[mirror_edk2.git] / ShellPkg / Library / UefiShellDriver1CommandsLib / Connect.c

/** @file\r
  Main file for connect shell Driver1 function.\r
\r
  (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
  Copyright (c) 2010 - 2018, 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
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "UefiShellDriver1CommandsLib.h"\r
\r
/**\r
  Create all handles associate with every device path node.\r
\r
  @param  DevicePathToConnect           The device path which will be connected.\r
\r
  @retval EFI_SUCCESS                   All handles associate with every device path node\r
                                        have been created.\r
  @retval EFI_INVALID_PARAMETER         DevicePathToConnect is NULL.\r
  @retval EFI_NOT_FOUND                 Create the handle associate with one device path\r
                                        node failed\r
\r
**/\r
EFI_STATUS\r
ShellConnectDevicePath (\r
  IN EFI_DEVICE_PATH_PROTOCOL   *DevicePathToConnect\r
  )\r
{\r
  EFI_DEVICE_PATH_PROTOCOL  *RemainingDevicePath;\r
  EFI_STATUS                Status;\r
  EFI_HANDLE                Handle;\r
  EFI_HANDLE                PreviousHandle;\r
\r
  if (DevicePathToConnect == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  PreviousHandle = NULL;\r
  do{\r
    RemainingDevicePath = DevicePathToConnect;\r
    Status = gBS->LocateDevicePath (&gEfiDevicePathProtocolGuid, &RemainingDevicePath, &Handle);\r
\r
    if (!EFI_ERROR (Status) && (Handle != NULL)) {\r
      if (PreviousHandle == Handle) {\r
        Status = EFI_NOT_FOUND;\r
      } else {\r
        PreviousHandle = Handle;\r
        Status = gBS->ConnectController (Handle, NULL, RemainingDevicePath, FALSE);\r
      }\r
    }\r
\r
  } while (!EFI_ERROR (Status) && !IsDevicePathEnd (RemainingDevicePath) );\r
\r
  return Status;\r
\r
}\r
\r
/**\r
  Connect drivers for PCI root bridge.\r
\r
  @retval EFI_SUCCESS                     Connect drivers successfully.\r
  @retval EFI_NOT_FOUND                   Cannot find PCI root bridge device.\r
\r
**/\r
EFI_STATUS\r
ShellConnectPciRootBridge (\r
  VOID\r
  )\r
{\r
  UINTN               RootBridgeHandleCount;\r
  EFI_HANDLE          *RootBridgeHandleBuffer;\r
  UINTN               RootBridgeIndex;\r
  EFI_STATUS          Status;\r
\r
  RootBridgeHandleCount = 0;\r
\r
  Status = gBS->LocateHandleBuffer (\r
              ByProtocol,\r
              &gEfiPciRootBridgeIoProtocolGuid,\r
              NULL,\r
              &RootBridgeHandleCount,\r
              &RootBridgeHandleBuffer\r
              );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  for (RootBridgeIndex = 0; RootBridgeIndex < RootBridgeHandleCount; RootBridgeIndex++) {\r
    gBS->ConnectController (RootBridgeHandleBuffer[RootBridgeIndex], NULL, NULL, FALSE);\r
  }\r
\r
  FreePool (RootBridgeHandleBuffer);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Connect controller(s) and driver(s).\r
\r
  @param[in] ControllerHandle     The handle to the controller. Should have driver binding on it.\r
  @param[in] DriverHandle         The handle to the driver. Should have driver binding.\r
  @param[in] Recursive            TRUE to connect recursively, FALSE otherwise.\r
  @param[in] Output               TRUE to have info on the screen, FALSE otherwise.\r
  @param[in] AlwaysOutput         Override Output for errors.\r
\r
  @retval EFI_SUCCESS             The operation was successful.\r
**/\r
EFI_STATUS\r
ConnectControllers (\r
  IN CONST EFI_HANDLE ControllerHandle OPTIONAL,\r
  IN CONST EFI_HANDLE DriverHandle OPTIONAL,\r
  IN CONST BOOLEAN    Recursive,\r
  IN CONST BOOLEAN    Output,\r
  IN CONST BOOLEAN    AlwaysOutput\r
  )\r
{\r
  EFI_STATUS Status;\r
  EFI_STATUS Status2;\r
  EFI_HANDLE *ControllerHandleList;\r
  EFI_HANDLE *DriverHandleList;\r
  EFI_HANDLE *HandleWalker;\r
\r
  ControllerHandleList  = NULL;\r
  Status                = EFI_NOT_FOUND;\r
  Status2               = EFI_NOT_FOUND;\r
\r
  //\r
  // If we have a single handle to connect make that a 'list'\r
  //\r
  if (DriverHandle == NULL) {\r
    DriverHandleList = NULL;\r
  } else {\r
    DriverHandleList = AllocateZeroPool(2*sizeof(EFI_HANDLE));\r
    if (DriverHandleList == NULL) {\r
      return (EFI_OUT_OF_RESOURCES);\r
    }\r
    DriverHandleList[0] = DriverHandle;\r
    DriverHandleList[1] = NULL;\r
  }\r
\r
  //\r
  // do we connect all controllers (with a loop) or a single one...\r
  // This is where we call the gBS->ConnectController function.\r
  //\r
  if (ControllerHandle == NULL) {\r
    ControllerHandleList = GetHandleListByProtocol(&gEfiDevicePathProtocolGuid);\r
    for (HandleWalker = ControllerHandleList\r
      ;  HandleWalker != NULL && *HandleWalker != NULL\r
      ;  HandleWalker++\r
     ){\r
      Status = gBS->ConnectController(*HandleWalker, DriverHandleList, NULL, Recursive);\r
      if (!EFI_ERROR(Status)) {\r
        Status2 = EFI_SUCCESS;\r
      }\r
      if ((Output && !EFI_ERROR(Status)) || AlwaysOutput) {\r
        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_HANDLE_RESULT), gShellDriver1HiiHandle, L"Connect", ConvertHandleToHandleIndex(*HandleWalker), Status);\r
      }\r
    }\r
  } else {\r
    Status = gBS->ConnectController(ControllerHandle, DriverHandleList, NULL, Recursive);\r
    if (!EFI_ERROR(Status)) {\r
      Status2 = EFI_SUCCESS;\r
    }\r
    if ((Output && !EFI_ERROR(Status)) || AlwaysOutput) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_HANDLE_RESULT), gShellDriver1HiiHandle, L"Connect", ConvertHandleToHandleIndex(ControllerHandle), Status);\r
    }\r
  }\r
\r
  //\r
  // Free any memory we allocated.\r
  //\r
  if (ControllerHandleList != NULL) {\r
    FreePool(ControllerHandleList);\r
  }\r
  if (DriverHandleList     != NULL) {\r
    FreePool(DriverHandleList);\r
  }\r
  return (Status2);\r
}\r
\r
/**\r
  Do a connect from an EFI variable via it's key name.\r
\r
  @param[in] Key      The name of the EFI Variable.\r
\r
  @retval EFI_SUCCESS   The operation was successful.\r
**/\r
EFI_STATUS\r
ShellConnectFromDevPaths (\r
  IN CONST CHAR16 *Key\r
  )\r
{\r
  EFI_DEVICE_PATH_PROTOCOL  *DevPath;\r
  EFI_DEVICE_PATH_PROTOCOL  *CopyOfDevPath;\r
  EFI_DEVICE_PATH_PROTOCOL  *Instance;\r
  EFI_DEVICE_PATH_PROTOCOL  *Next;\r
  UINTN                     Length;\r
  UINTN                     Index;\r
  UINTN                     HandleArrayCount;\r
  UINTN                     Size;\r
  EFI_HANDLE                *HandleArray;\r
  EFI_STATUS                Status;\r
  BOOLEAN                   AtLeastOneConnected;\r
  EFI_PCI_IO_PROTOCOL       *PciIo;\r
  UINT8                     Class[3];\r
\r
  DevPath = NULL;\r
  Length  = 0;\r
  AtLeastOneConnected = FALSE;\r
\r
  //\r
  // Get the DevicePath buffer from the variable...\r
  //\r
  Status = gRT->GetVariable((CHAR16*)Key, (EFI_GUID*)&gEfiGlobalVariableGuid, NULL, &Length, DevPath);\r
  if (Status == EFI_BUFFER_TOO_SMALL) {\r
    DevPath = AllocateZeroPool(Length);\r
    if (DevPath == NULL) {\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    Status = gRT->GetVariable((CHAR16*)Key, (EFI_GUID*)&gEfiGlobalVariableGuid, NULL, &Length, DevPath);\r
    if (EFI_ERROR (Status)) {\r
      if (DevPath != NULL) {\r
        FreePool (DevPath);\r
      }\r
      return Status;\r
    }\r
  } else if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = EFI_NOT_FOUND;\r
\r
  CopyOfDevPath = DevPath;\r
  //\r
  // walk the list of devices and connect them\r
  //\r
  do {\r
    //\r
    // Check every instance of the console variable\r
    //\r
    Instance = GetNextDevicePathInstance (&CopyOfDevPath, &Size);\r
    if (Instance == NULL) {\r
      if (DevPath != NULL) {\r
        FreePool (DevPath);\r
      }\r
      return EFI_UNSUPPORTED;\r
    }\r
\r
    Next = Instance;\r
    while (!IsDevicePathEndType (Next)) {\r
      Next = NextDevicePathNode (Next);\r
    }\r
\r
    SetDevicePathEndNode (Next);\r
    //\r
    // connect short form device path\r
    //\r
    if ((DevicePathType (Instance) == MESSAGING_DEVICE_PATH) &&\r
      ((DevicePathSubType (Instance) == MSG_USB_CLASS_DP)\r
      || (DevicePathSubType (Instance) == MSG_USB_WWID_DP)\r
      )) {\r
\r
      Status = ShellConnectPciRootBridge ();\r
      if (EFI_ERROR(Status)) {\r
        FreePool(Instance);\r
        FreePool(DevPath);\r
        return Status;\r
      }\r
\r
      Status = gBS->LocateHandleBuffer (\r
                  ByProtocol,\r
                  &gEfiPciIoProtocolGuid,\r
                  NULL,\r
                  &HandleArrayCount,\r
                  &HandleArray\r
                  );\r
\r
      if (!EFI_ERROR (Status)) {\r
        for (Index = 0; Index < HandleArrayCount; Index++) {\r
          Status = gBS->HandleProtocol (\r
                      HandleArray[Index],\r
                      &gEfiPciIoProtocolGuid,\r
                      (VOID **)&PciIo\r
                      );\r
\r
          if (!EFI_ERROR (Status)) {\r
            Status = PciIo->Pci.Read (PciIo, EfiPciIoWidthUint8, 0x09, 3, &Class);\r
            if (!EFI_ERROR (Status)) {\r
              if ((PCI_CLASS_SERIAL == Class[2]) &&\r
                  (PCI_CLASS_SERIAL_USB == Class[1])) {\r
                Status = gBS->ConnectController (\r
                              HandleArray[Index],\r
                              NULL,\r
                              Instance,\r
                              FALSE\r
                              );\r
                if (!EFI_ERROR(Status)) {\r
                  AtLeastOneConnected = TRUE;\r
                }\r
              }\r
            }\r
          }\r
        }\r
      }\r
\r
      if (HandleArray != NULL) {\r
        FreePool (HandleArray);\r
      }\r
    } else {\r
      //\r
      // connect the entire device path\r
      //\r
      Status = ShellConnectDevicePath (Instance);\r
      if (!EFI_ERROR (Status)) {\r
        AtLeastOneConnected = TRUE;\r
      }\r
    }\r
    FreePool (Instance);\r
\r
  } while (CopyOfDevPath != NULL);\r
\r
  if (DevPath != NULL) {\r
    FreePool(DevPath);\r
  }\r
\r
  if (AtLeastOneConnected) {\r
    return EFI_SUCCESS;\r
  } else {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
}\r
\r
/**\r
  Convert the handle identifiers from strings and then connect them.\r
\r
  One of them should have driver binding and either can be NULL.\r
\r
  @param[in] Handle1            The first handle.\r
  @param[in] Handle2            The second handle.\r
  @param[in] Recursive          TRUE to do connect recursively. FALSE otherwise.\r
  @param[in] Output             TRUE to have output to screen. FALSE otherwise.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
**/\r
EFI_STATUS\r
ConvertAndConnectControllers (\r
  IN EFI_HANDLE     *Handle1 OPTIONAL,\r
  IN EFI_HANDLE     *Handle2 OPTIONAL,\r
  IN CONST BOOLEAN  Recursive,\r
  IN CONST BOOLEAN  Output\r
  )\r
{\r
  //\r
  // if only one is NULL verify it's the proper one...\r
  //\r
  if ( (Handle1 == NULL && Handle2 != NULL)\r
    || (Handle1 != NULL && Handle2 == NULL)\r
   ){\r
    //\r
    // Figure out which one should be NULL and move the handle to the right place.\r
    // If Handle1 is NULL then test Handle2 and vise versa.\r
    // The one that DOES has driver binding must be Handle2\r
    //\r
    if (Handle1 == NULL) {\r
      if (EFI_ERROR(gBS->OpenProtocol(Handle2, &gEfiDriverBindingProtocolGuid, NULL, NULL, gImageHandle, EFI_OPEN_PROTOCOL_TEST_PROTOCOL))) {\r
        // swap\r
        Handle1 = Handle2;\r
        Handle2 = NULL;\r
      } else {\r
        // We're all good...\r
      }\r
    } else {\r
      if (EFI_ERROR(gBS->OpenProtocol(Handle1, &gEfiDriverBindingProtocolGuid, NULL, NULL, gImageHandle, EFI_OPEN_PROTOCOL_TEST_PROTOCOL))) {\r
        // We're all good...\r
      } else {\r
        // swap\r
        Handle2 = Handle1;\r
        Handle1 = NULL;\r
      }\r
    }\r
  }\r
\r
  return (ConnectControllers(Handle1, Handle2, Recursive, Output, (BOOLEAN)(Handle2 != NULL && Handle1 != NULL)));\r
}\r
\r
STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
  {L"-c", TypeFlag},\r
  {L"-r", TypeFlag},\r
  {NULL, TypeMax}\r
  };\r
\r
/**\r
  Function for 'connect' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunConnect (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS          Status;\r
  LIST_ENTRY          *Package;\r
  CHAR16              *ProblemParam;\r
  SHELL_STATUS        ShellStatus;\r
  CONST CHAR16        *Param1;\r
  CONST CHAR16        *Param2;\r
  UINTN               Count;\r
  EFI_HANDLE          Handle1;\r
  EFI_HANDLE          Handle2;\r
  UINT64              Intermediate;\r
\r
  ShellStatus         = SHELL_SUCCESS;\r
  //\r
  // initialize the shell lib (we must be in non-auto-init...)\r
  //\r
  Status = ShellInitialize();\r
  ASSERT_EFI_ERROR(Status);\r
\r
  Status = CommandInit();\r
  ASSERT_EFI_ERROR(Status);\r
\r
  //\r
  // parse the command line\r
  //\r
  Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
  if (EFI_ERROR(Status)) {\r
    if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, L"connect", ProblemParam);\r
      FreePool(ProblemParam);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      ASSERT(FALSE);\r
    }\r
  } else {\r
    //\r
    // if more than 2 'value' parameters (plus the name one) or either -r or -c with any value parameters we have too many parameters\r
    //\r
    Count = (gInReconnect?0x4:0x3);\r
    if ((ShellCommandLineGetCount(Package) > Count)\r
      ||(ShellCommandLineGetFlag(Package, L"-c") && ShellCommandLineGetCount(Package)>1)\r
      ||(ShellCommandLineGetFlag(Package, L"-r") && ShellCommandLineGetCount(Package)>2)\r
      ||(ShellCommandLineGetFlag(Package, L"-r") && ShellCommandLineGetFlag(Package, L"-c") )\r
    ){\r
      //\r
      // error for too many parameters\r
      //\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle, L"connect");\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else if (ShellCommandLineGetFlag(Package, L"-c")) {\r
      //\r
      // do the conin and conout from EFI variables\r
      // if the first fails dont 'loose' the error\r
      //\r
      Status = ShellConnectFromDevPaths(L"ConInDev");\r
      if (EFI_ERROR(Status)) {\r
        ShellConnectFromDevPaths(L"ConOutDev");\r
      } else {\r
        Status = ShellConnectFromDevPaths(L"ConOutDev");\r
      }\r
      if (EFI_ERROR(Status)) {\r
        ShellConnectFromDevPaths(L"ErrOutDev");\r
      } else {\r
        Status = ShellConnectFromDevPaths(L"ErrOutDev");\r
      }\r
      if (EFI_ERROR(Status)) {\r
        ShellConnectFromDevPaths(L"ErrOut");\r
      } else {\r
        Status = ShellConnectFromDevPaths(L"ErrOut");\r
      }\r
      if (EFI_ERROR(Status)) {\r
        ShellConnectFromDevPaths(L"ConIn");\r
      } else {\r
        Status = ShellConnectFromDevPaths(L"ConIn");\r
      }\r
      if (EFI_ERROR(Status)) {\r
        ShellConnectFromDevPaths(L"ConOut");\r
      } else {\r
        Status = ShellConnectFromDevPaths(L"ConOut");\r
      }\r
      if (EFI_ERROR(Status)) {\r
        ShellStatus = SHELL_DEVICE_ERROR;\r
      }\r
    } else {\r
      //\r
      // 0, 1, or 2 specific handles and possibly recursive\r
      //\r
      Param1  = ShellCommandLineGetRawValue(Package, 1);\r
      Param2  = ShellCommandLineGetRawValue(Package, 2);\r
      Count   = ShellCommandLineGetCount(Package);\r
\r
      if (Param1 != NULL) {\r
        Status  = ShellConvertStringToUint64(Param1, &Intermediate, TRUE, FALSE);\r
        Handle1 = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
        if (EFI_ERROR(Status)) {\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"connect", Param1);\r
          ShellStatus = SHELL_INVALID_PARAMETER;\r
        }\r
      } else {\r
        Handle1 = NULL;\r
      }\r
\r
      if (Param2 != NULL) {\r
        Status  = ShellConvertStringToUint64(Param2, &Intermediate, TRUE, FALSE);\r
        Handle2 = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
        if (EFI_ERROR(Status)) {\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"connect", Param2);\r
          ShellStatus = SHELL_INVALID_PARAMETER;\r
        }\r
      } else {\r
        Handle2 = NULL;\r
      }\r
\r
      if (ShellStatus == SHELL_SUCCESS) {\r
        if (Param1 != NULL && Handle1 == NULL){\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"connect", Param1);\r
          ShellStatus = SHELL_INVALID_PARAMETER;\r
        } else if (Param2 != NULL && Handle2 == NULL) {\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"connect", Param2);\r
          ShellStatus = SHELL_INVALID_PARAMETER;\r
        } else if (Handle2 != NULL && Handle1 != NULL && EFI_ERROR(gBS->OpenProtocol(Handle2, &gEfiDriverBindingProtocolGuid, NULL, gImageHandle, NULL, EFI_OPEN_PROTOCOL_TEST_PROTOCOL))) {\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"connect", Param2);\r
          ShellStatus = SHELL_INVALID_PARAMETER;\r
        } else {\r
          Status = ConvertAndConnectControllers(Handle1, Handle2, ShellCommandLineGetFlag(Package, L"-r"), (BOOLEAN)(Count!=0));\r
          if (EFI_ERROR(Status)) {\r
            ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_CONNECT_NONE), gShellDriver1HiiHandle);\r
            ShellStatus = SHELL_DEVICE_ERROR;\r
          }\r
        }\r
      }\r
    }\r
\r
    ShellCommandLineFreeVarList (Package);\r
  }\r
  return (ShellStatus);\r
}\r
\r