ShellPkg/Library/UefiShellDriver1CommandsLib/Disconnect.c

   1 /** @file
   2   Main file for Disconnect shell Driver1 function.
   3
   4   (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
   5   (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>
   6   Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
   7   SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #include "UefiShellDriver1CommandsLib.h"
  12
  13 STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
  14   {L"-r", TypeFlag},
  15   {L"-nc", TypeFlag},
  16   {NULL, TypeMax}
  17   };
  18
  19 /**
  20   Disconnect everything.
  21
  22   @retval EFI_SUCCESS     The operation was successful.
  23 **/
  24 EFI_STATUS
  25 DisconnectAll(
  26   VOID
  27   )
  28 {
  29   //
  30   // Stolen from UEFI 2.3 spec (May 2009 version)
  31   // Pages 171/172
  32   // Removed gBS local definition
  33   //
  34
  35   //
  36   // Disconnect All Handles Example
  37   // The following example recusively disconnects all drivers from all
  38   // controllers in a platform.
  39   //
  40   EFI_STATUS Status;
  41 //  EFI_BOOT_SERVICES *gBS;
  42   UINTN HandleCount;
  43   EFI_HANDLE *HandleBuffer;
  44   UINTN HandleIndex;
  45   //
  46   // Retrieve the list of all handles from the handle database
  47   //
  48   Status = gBS->LocateHandleBuffer (
  49     AllHandles,
  50     NULL,
  51     NULL,
  52     &HandleCount,
  53     &HandleBuffer
  54    );
  55   if (!EFI_ERROR (Status)) {
  56     for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {
  57       Status = gBS->DisconnectController (
  58         HandleBuffer[HandleIndex],
  59         NULL,
  60         NULL
  61        );
  62     }
  63     gBS->FreePool(HandleBuffer);
  64     //
  65     // end of stealing
  66     //
  67   }
  68   return (EFI_SUCCESS);
  69 }
  70
  71 /**
  72   Function for 'disconnect' command.
  73
  74   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  75   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  76 **/
  77 SHELL_STATUS
  78 EFIAPI
  79 ShellCommandRunDisconnect (
  80   IN EFI_HANDLE        ImageHandle,
  81   IN EFI_SYSTEM_TABLE  *SystemTable
  82   )
  83 {
  84   EFI_STATUS          Status;
  85   LIST_ENTRY          *Package;
  86   CHAR16              *ProblemParam;
  87   SHELL_STATUS        ShellStatus;
  88   CONST CHAR16        *Param1;
  89   CONST CHAR16        *Param2;
  90   CONST CHAR16        *Param3;
  91   EFI_HANDLE          Handle1;
  92   EFI_HANDLE          Handle2;
  93   EFI_HANDLE          Handle3;
  94   UINT64              Intermediate1;
  95   UINT64              Intermediate2;
  96   UINT64              Intermediate3;
  97
  98   ShellStatus         = SHELL_SUCCESS;
  99
 100   //
 101   // initialize the shell lib (we must be in non-auto-init...)
 102   //
 103   Status = ShellInitialize();
 104   ASSERT_EFI_ERROR(Status);
 105
 106   Status = CommandInit();
 107   ASSERT_EFI_ERROR(Status);
 108
 109   //
 110   // parse the command line
 111   //
 112   Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);
 113   if (EFI_ERROR(Status)) {
 114     if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {
 115       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, L"disconnect", ProblemParam);
 116       FreePool(ProblemParam);
 117       ShellStatus = SHELL_INVALID_PARAMETER;
 118     } else {
 119       ASSERT(FALSE);
 120     }
 121   } else {
 122     if (ShellCommandLineGetFlag(Package, L"-r")){
 123       if (ShellCommandLineGetCount(Package) > 1){
 124         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle, L"disconnect");
 125         ShellStatus = SHELL_INVALID_PARAMETER;
 126       } else if (ShellCommandLineGetCount(Package) < 1) {
 127         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDriver1HiiHandle, L"disconnect");
 128         ShellStatus = SHELL_INVALID_PARAMETER;
 129       } else {
 130          Status = DisconnectAll ();
 131          //
 132          // Reconnect all consoles if -nc is not provided
 133          //
 134          if (!ShellCommandLineGetFlag (Package, L"-nc")){
 135            ShellConnectFromDevPaths (L"ConInDev");
 136            ShellConnectFromDevPaths (L"ConOutDev");
 137            ShellConnectFromDevPaths (L"ErrOutDev");
 138            ShellConnectFromDevPaths (L"ErrOut");
 139            ShellConnectFromDevPaths (L"ConIn");
 140            ShellConnectFromDevPaths (L"ConOut");
 141          }
 142       }
 143     } else if (ShellCommandLineGetFlag (Package, L"-nc")) {
 144       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDriver1HiiHandle, L"disconnect");
 145       ShellStatus = SHELL_INVALID_PARAMETER;
 146     } else {
 147       if (ShellCommandLineGetCount(Package) > 4){
 148         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle, L"disconnect");
 149         ShellStatus = SHELL_INVALID_PARAMETER;
 150       } else if (ShellCommandLineGetCount(Package) < 2) {
 151         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDriver1HiiHandle, L"disconnect");
 152         ShellStatus = SHELL_INVALID_PARAMETER;
 153       } else {
 154         //
 155         // must have between 1 and 3 handles passed in ...
 156         //
 157         Param1  = ShellCommandLineGetRawValue(Package, 1);
 158         Param2  = ShellCommandLineGetRawValue(Package, 2);
 159         Param3  = ShellCommandLineGetRawValue(Package, 3);
 160         ShellConvertStringToUint64(Param1, &Intermediate1, TRUE, FALSE);
 161         Handle1 = Param1!=NULL?ConvertHandleIndexToHandle((UINTN)Intermediate1):NULL;
 162         ShellConvertStringToUint64(Param2, &Intermediate2, TRUE, FALSE);
 163         Handle2 = Param2!=NULL?ConvertHandleIndexToHandle((UINTN)Intermediate2):NULL;
 164         ShellConvertStringToUint64(Param3, &Intermediate3, TRUE, FALSE);
 165         Handle3 = Param3!=NULL?ConvertHandleIndexToHandle((UINTN)Intermediate3):NULL;
 166
 167         if (Param1 != NULL && Handle1 == NULL) {
 168           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"disconnect", Param1);
 169           ShellStatus = SHELL_INVALID_PARAMETER;
 170         } else if (Param2 != NULL && Handle2 == NULL) {
 171           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"disconnect", Param2);
 172           ShellStatus = SHELL_INVALID_PARAMETER;
 173         } else if (Param3 != NULL && Handle3 == NULL) {
 174           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"disconnect", Param3);
 175           ShellStatus = SHELL_INVALID_PARAMETER;
 176         } else if (Handle2 != NULL && EFI_ERROR(gBS->OpenProtocol(Handle2, &gEfiDriverBindingProtocolGuid, NULL, gImageHandle, NULL, EFI_OPEN_PROTOCOL_TEST_PROTOCOL))) {
 177           ASSERT(Param2 != NULL);
 178           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_HANDLE_NOT), gShellDriver1HiiHandle, L"disconnect", ShellStrToUintn(Param2), L"driver handle");
 179           ShellStatus = SHELL_INVALID_PARAMETER;
 180         } else {
 181           ASSERT(Param1 != NULL);
 182           Status = gBS->DisconnectController(Handle1, Handle2, Handle3);
 183           ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_3P_RESULT), gShellDriver1HiiHandle, L"Disconnect", (UINTN)Intermediate1, (UINTN)Intermediate2, (UINTN)Intermediate3, Status);
 184         }
 185       }
 186     }
 187   }
 188   if (ShellStatus == SHELL_SUCCESS) {
 189     if (Status == EFI_SECURITY_VIOLATION) {
 190       ShellStatus = SHELL_SECURITY_VIOLATION;
 191     } else if (Status == EFI_INVALID_PARAMETER) {
 192       ShellStatus = SHELL_INVALID_PARAMETER;
 193     } else if (EFI_ERROR(Status)) {
 194       ShellStatus = SHELL_NOT_FOUND;
 195     }
 196   }
 197   return (ShellStatus);
 198 }