ShellPkg/Library/UefiShellDriver1CommandsLib/Drivers.c

   1 /** @file
   2   Main file for Drivers shell Driver1 function.
   3
   4   Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "UefiShellDriver1CommandsLib.h"
  16
  17 STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
  18   {L"-sfo", TypeFlag},
  19   {L"-l", TypeValue},
  20   {NULL, TypeMax}
  21   };
  22
  23 CHAR16*
  24 EFIAPI
  25 GetDevicePathTextForHandle(
  26   IN EFI_HANDLE TheHandle
  27   )
  28 {
  29   EFI_STATUS                Status;
  30   EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
  31   EFI_DEVICE_PATH_PROTOCOL  *ImageDevicePath;
  32   EFI_DEVICE_PATH_PROTOCOL  *FinalPath;
  33   CHAR16                    *RetVal;
  34
  35   FinalPath = NULL;
  36
  37   Status = gBS->OpenProtocol (
  38                 TheHandle,
  39                 &gEfiLoadedImageProtocolGuid,
  40                 (VOID**)&LoadedImage,
  41                 gImageHandle,
  42                 NULL,
  43                 EFI_OPEN_PROTOCOL_GET_PROTOCOL
  44                );
  45   if (!EFI_ERROR (Status)) {
  46     Status = gBS->OpenProtocol (
  47                   LoadedImage->DeviceHandle,
  48                   &gEfiDevicePathProtocolGuid,
  49                   (VOID**)&ImageDevicePath,
  50                   gImageHandle,
  51                   NULL,
  52                   EFI_OPEN_PROTOCOL_GET_PROTOCOL
  53                  );
  54     if (!EFI_ERROR (Status)) {
  55       FinalPath = AppendDevicePath (ImageDevicePath, LoadedImage->FilePath);
  56       gBS->CloseProtocol(
  57         LoadedImage->DeviceHandle,
  58         &gEfiDevicePathProtocolGuid,
  59         gImageHandle,
  60         NULL);
  61     }
  62     gBS->CloseProtocol(
  63                 TheHandle,
  64                 &gEfiLoadedImageProtocolGuid,
  65                 gImageHandle,
  66                 NULL);
  67   }
  68
  69   if (FinalPath == NULL) {
  70     return (NULL);
  71   }
  72   RetVal = gEfiShellProtocol->GetFilePathFromDevicePath(FinalPath);
  73   if (RetVal == NULL) {
  74     RetVal = gDevPathToText->ConvertDevicePathToText(FinalPath, TRUE, TRUE);
  75   }
  76   FreePool(FinalPath);
  77   return (RetVal);
  78 }
  79
  80 BOOLEAN
  81 EFIAPI
  82 ReturnDriverConfig(
  83   IN CONST EFI_HANDLE TheHandle
  84   )
  85 {
  86   EFI_STATUS                  Status;
  87   Status = gBS->OpenProtocol((EFI_HANDLE)TheHandle, &gEfiDriverConfigurationProtocolGuid, NULL, gImageHandle, NULL, EFI_OPEN_PROTOCOL_TEST_PROTOCOL);
  88   if (EFI_ERROR(Status)) {
  89     return (FALSE);
  90   }
  91   return (TRUE);
  92 }
  93
  94 BOOLEAN
  95 EFIAPI
  96 ReturnDriverDiag(
  97   IN CONST EFI_HANDLE TheHandle
  98   )
  99 {
 100   EFI_STATUS                  Status;
 101   Status = gBS->OpenProtocol((EFI_HANDLE)TheHandle, &gEfiDriverDiagnostics2ProtocolGuid, NULL, gImageHandle, NULL, EFI_OPEN_PROTOCOL_TEST_PROTOCOL);
 102   if (EFI_ERROR(Status)) {
 103     Status = gBS->OpenProtocol((EFI_HANDLE)TheHandle, &gEfiDriverDiagnosticsProtocolGuid, NULL, gImageHandle, NULL, EFI_OPEN_PROTOCOL_TEST_PROTOCOL);
 104     if (EFI_ERROR(Status)) {
 105       return (FALSE);
 106     }
 107   }
 108   return (TRUE);
 109 }
 110
 111 UINT32
 112 EFIAPI
 113 ReturnDriverVersion(
 114   IN CONST EFI_HANDLE TheHandle
 115   )
 116 {
 117   EFI_DRIVER_BINDING_PROTOCOL *DriverBinding;
 118   EFI_STATUS                  Status;
 119   UINT32                      RetVal;
 120
 121   RetVal = (UINT32)-1;
 122
 123   Status = gBS->OpenProtocol((EFI_HANDLE)TheHandle, &gEfiDriverBindingProtocolGuid, (VOID**)&DriverBinding, gImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);
 124   if (!EFI_ERROR(Status)) {
 125     RetVal = DriverBinding->Version;
 126     gBS->CloseProtocol(TheHandle, &gEfiDriverBindingProtocolGuid, gImageHandle, NULL);
 127   }
 128   return (RetVal);
 129 }
 130
 131 SHELL_STATUS
 132 EFIAPI
 133 ShellCommandRunDrivers (
 134   IN EFI_HANDLE        ImageHandle,
 135   IN EFI_SYSTEM_TABLE  *SystemTable
 136   )
 137 {
 138   EFI_STATUS          Status;
 139   LIST_ENTRY          *Package;
 140   CHAR16              *ProblemParam;
 141   SHELL_STATUS        ShellStatus;
 142   CHAR8               *Language;
 143   CONST CHAR16        *Lang;
 144   EFI_HANDLE          *HandleList;
 145   EFI_HANDLE          *HandleWalker;
 146   UINTN               ChildCount;
 147   UINTN               DeviceCount;
 148   CHAR16              *Temp2;
 149   CHAR16              *FormatString;
 150   UINT32              DriverVersion;
 151   BOOLEAN             DriverConfig;
 152   BOOLEAN             DriverDiag;
 153
 154   ShellStatus         = SHELL_SUCCESS;
 155   Status              = EFI_SUCCESS;
 156   Language            = NULL;
 157   FormatString        = NULL;
 158
 159   //
 160   // initialize the shell lib (we must be in non-auto-init...)
 161   //
 162   Status = ShellInitialize();
 163   ASSERT_EFI_ERROR(Status);
 164
 165   Status = CommandInit();
 166   ASSERT_EFI_ERROR(Status);
 167
 168   //
 169   // parse the command line
 170   //
 171   Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);
 172   if (EFI_ERROR(Status)) {
 173     if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {
 174       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, ProblemParam);
 175       FreePool(ProblemParam);
 176       ShellStatus = SHELL_INVALID_PARAMETER;
 177     } else {
 178       ASSERT(FALSE);
 179     }
 180   } else {
 181     if (ShellCommandLineGetCount(Package) > 1) {
 182       ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle);
 183       ShellStatus = SHELL_INVALID_PARAMETER;
 184     } else {
 185       Lang = ShellCommandLineGetValue(Package, L"-l");
 186       if (Lang != NULL) {
 187         Language = AllocateZeroPool(StrSize(Lang));
 188         AsciiSPrint(Language, StrSize(Lang), "%S", Lang);
 189       } else if (!ShellCommandLineGetFlag(Package, L"-l")){
 190         ASSERT(Language == NULL);
 191   //      Language = AllocateZeroPool(10);
 192   //      AsciiSPrint(Language, 10, "en-us");
 193       } else {
 194         ASSERT(Language == NULL);
 195         ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellDriver1HiiHandle, L"-l");
 196         ShellCommandLineFreeVarList (Package);
 197         return (SHELL_INVALID_PARAMETER);
 198       }
 199
 200       if (ShellCommandLineGetFlag(Package, L"-sfo")) {
 201         FormatString = HiiGetString(gShellDriver1HiiHandle, STRING_TOKEN(STR_DRIVERS_ITEM_LINE_SFO), Language);
 202       } else {
 203         FormatString = HiiGetString(gShellDriver1HiiHandle, STRING_TOKEN(STR_DRIVERS_ITEM_LINE), Language);
 204         //
 205         // print the header row
 206         //
 207         ShellPrintHiiEx(
 208           -1,
 209           -1,
 210           Language,
 211           STRING_TOKEN(STR_DRIVERS_HEADER_LINES),
 212           gShellDriver1HiiHandle);
 213       }
 214
 215       HandleList = GetHandleListByProtocol(&gEfiDriverBindingProtocolGuid);
 216       for (HandleWalker = HandleList ; HandleWalker != NULL && *HandleWalker != NULL ; HandleWalker++){
 217         ChildCount    = 0;
 218         DeviceCount   = 0;
 219         Status        = ParseHandleDatabaseForChildDevices (*HandleWalker, &ChildCount , NULL);
 220         Status        = PARSE_HANDLE_DATABASE_DEVICES      (*HandleWalker, &DeviceCount, NULL);
 221         Temp2         = GetDevicePathTextForHandle(*HandleWalker);
 222         DriverVersion = ReturnDriverVersion(*HandleWalker);
 223         DriverConfig  = ReturnDriverConfig(*HandleWalker);
 224         DriverDiag    = ReturnDriverDiag  (*HandleWalker);
 225         Lang          = GetStringNameFromHandle(*HandleWalker, Language==NULL?"en":Language);
 226
 227         ShellPrintEx(
 228           -1,
 229           -1,
 230           FormatString,
 231           ConvertHandleToHandleIndex(*HandleWalker),
 232           DriverVersion,
 233           ChildCount > 0?L'B':(DeviceCount > 0?L'D':L'?'),
 234           DriverConfig?L'Y':L'N',
 235           DriverDiag?L'Y':L'N',
 236           DeviceCount,
 237           ChildCount,
 238           Lang,
 239           Temp2==NULL?L"":Temp2
 240          );
 241         if (Temp2 != NULL) {
 242           FreePool(Temp2);
 243         }
 244       }
 245     }
 246     SHELL_FREE_NON_NULL(Language);
 247     ShellCommandLineFreeVarList (Package);
 248     SHELL_FREE_NON_NULL(FormatString);
 249   }
 250
 251   return (ShellStatus);
 252 }