]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ShellPkg/Library/UefiShellDriver1CommandsLib/Drivers.c
ShellPkg/drivers: Show Image Name in non-SFO mode
[mirror_edk2.git] / ShellPkg / Library / UefiShellDriver1CommandsLib / Drivers.c
index 18912e8f07c126a0470c2d3419ebe05551580473..f3c1476872c0132905e4048e17bc5ece9ae00669 100644 (file)
@@ -1,7 +1,8 @@
 /** @file\r
   Main file for Drivers shell Driver1 function.\r
 \r
-  Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
+  (C) Copyright 2012-2015 Hewlett-Packard Development Company, L.P.<BR>\r
+  Copyright (c) 2010 - 2017, 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
@@ -14,6 +15,8 @@
 \r
 #include "UefiShellDriver1CommandsLib.h"\r
 \r
+#define MAX_LEN_DRIVER_NAME 35\r
+\r
 STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
   {L"-sfo", TypeFlag},\r
   {L"-l", TypeValue},\r
@@ -30,7 +33,6 @@ STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
                   free this memory.\r
 **/\r
 CHAR16*\r
-EFIAPI\r
 GetDevicePathTextForHandle(\r
   IN EFI_HANDLE TheHandle\r
   )\r
@@ -80,7 +82,7 @@ GetDevicePathTextForHandle(
   }\r
   RetVal = gEfiShellProtocol->GetFilePathFromDevicePath(FinalPath);\r
   if (RetVal == NULL) {\r
-    RetVal = gDevPathToText->ConvertDevicePathToText(FinalPath, TRUE, TRUE);\r
+    RetVal = ConvertDevicePathToText(FinalPath, TRUE, TRUE);\r
   }\r
   FreePool(FinalPath);\r
   return (RetVal);\r
@@ -95,7 +97,6 @@ GetDevicePathTextForHandle(
   @retval FALSE             The driver does not have Driver Configuration.\r
 **/\r
 BOOLEAN\r
-EFIAPI\r
 ReturnDriverConfig(\r
   IN CONST EFI_HANDLE TheHandle\r
   )\r
@@ -117,7 +118,6 @@ ReturnDriverConfig(
   @retval FALSE             The driver does not have Driver Diagnostics.\r
 **/\r
 BOOLEAN\r
-EFIAPI\r
 ReturnDriverDiag(\r
   IN CONST EFI_HANDLE TheHandle\r
   )\r
@@ -142,7 +142,6 @@ ReturnDriverDiag(
   @retval 0xFFFFFFFF  An error ocurred.\r
 **/\r
 UINT32\r
-EFIAPI\r
 ReturnDriverVersion(\r
   IN CONST EFI_HANDLE TheHandle\r
   )\r
@@ -161,6 +160,92 @@ ReturnDriverVersion(
   return (RetVal);\r
 }\r
 \r
+/**\r
+  Get image name from Image Handle.\r
+\r
+  @param[in] Handle      Image Handle\r
+\r
+  @return         A pointer to the image name as a string.\r
+**/\r
+CHAR16 *\r
+GetImageNameFromHandle (\r
+  IN CONST EFI_HANDLE Handle\r
+  )\r
+{\r
+  EFI_STATUS                        Status;\r
+  EFI_DRIVER_BINDING_PROTOCOL       *DriverBinding;\r
+  EFI_LOADED_IMAGE_PROTOCOL         *LoadedImage;\r
+  EFI_DEVICE_PATH_PROTOCOL          *DevPathNode;\r
+  EFI_GUID                          *NameGuid;\r
+  CHAR16                            *ImageName;\r
+  UINTN                             BufferSize;\r
+  UINT32                            AuthenticationStatus;\r
+  EFI_FIRMWARE_VOLUME2_PROTOCOL     *Fv2;\r
+\r
+  LoadedImage   = NULL;\r
+  DriverBinding = NULL;\r
+  ImageName     = NULL;\r
+\r
+  Status = gBS->OpenProtocol (\r
+                  Handle,\r
+                  &gEfiDriverBindingProtocolGuid,\r
+                  (VOID **) &DriverBinding,\r
+                  NULL,\r
+                  NULL,\r
+                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
+                  );\r
+  if (EFI_ERROR (Status)) {\r
+      return NULL;\r
+  }\r
+  Status = gBS->OpenProtocol (\r
+                  DriverBinding->ImageHandle,\r
+                  &gEfiLoadedImageProtocolGuid,\r
+                  (VOID**)&LoadedImage,\r
+                  gImageHandle,\r
+                  NULL,\r
+                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
+                  );\r
+  if (!EFI_ERROR (Status)) {\r
+    DevPathNode = LoadedImage->FilePath;\r
+    if (DevPathNode == NULL) {\r
+      return NULL;\r
+    }\r
+    while (!IsDevicePathEnd (DevPathNode)) {\r
+      NameGuid = EfiGetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *)DevPathNode);\r
+      if (NameGuid != NULL) {\r
+        Status = gBS->HandleProtocol (\r
+                        LoadedImage->DeviceHandle,\r
+                        &gEfiFirmwareVolume2ProtocolGuid,\r
+                        &Fv2\r
+                        );\r
+        if (!EFI_ERROR (Status)) {\r
+          Status = Fv2->ReadSection (\r
+                          Fv2,\r
+                          NameGuid,\r
+                          EFI_SECTION_USER_INTERFACE,\r
+                          0,\r
+                          (VOID **)&ImageName,\r
+                          &BufferSize,\r
+                          &AuthenticationStatus\r
+                          );\r
+          if (!EFI_ERROR (Status)) {\r
+            break;\r
+          }\r
+          ImageName = NULL;\r
+        }\r
+      }\r
+      //\r
+      // Next device path node\r
+      //\r
+      DevPathNode = NextDevicePathNode (DevPathNode);\r
+    }\r
+    if (ImageName == NULL) {\r
+      ImageName = ConvertDevicePathToText (LoadedImage->FilePath, TRUE, TRUE);\r
+    }\r
+  }\r
+  return ImageName;\r
+}\r
+\r
 /**\r
   Function for 'drivers' command.\r
 \r
@@ -185,15 +270,20 @@ ShellCommandRunDrivers (
   UINTN               ChildCount;\r
   UINTN               DeviceCount;\r
   CHAR16              *Temp2;\r
+  CONST CHAR16        *FullDriverName;\r
+  CHAR16              *TruncatedDriverName;\r
+  CHAR16              *ImageName;\r
   CHAR16              *FormatString;\r
   UINT32              DriverVersion;\r
   BOOLEAN             DriverConfig;\r
   BOOLEAN             DriverDiag;\r
+  BOOLEAN             SfoFlag;\r
 \r
   ShellStatus         = SHELL_SUCCESS;\r
   Status              = EFI_SUCCESS;\r
   Language            = NULL;\r
   FormatString        = NULL;\r
+  SfoFlag             = FALSE;\r
 \r
   //\r
   // initialize the shell lib (we must be in non-auto-init...)\r
@@ -210,7 +300,7 @@ ShellCommandRunDrivers (
   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, ProblemParam);\r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, L"drivers", ProblemParam);  \r
       FreePool(ProblemParam);\r
       ShellStatus = SHELL_INVALID_PARAMETER;\r
     } else {\r
@@ -218,28 +308,37 @@ ShellCommandRunDrivers (
     }\r
   } else {\r
     if (ShellCommandLineGetCount(Package) > 1) {\r
-      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle);\r
+      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle, L"drivers");  \r
       ShellStatus = SHELL_INVALID_PARAMETER;\r
     } else {\r
-      Lang = ShellCommandLineGetValue(Package, L"-l");\r
-      if (Lang != NULL) {\r
-        Language = AllocateZeroPool(StrSize(Lang));\r
-        AsciiSPrint(Language, StrSize(Lang), "%S", Lang);\r
-      } else if (!ShellCommandLineGetFlag(Package, L"-l")){\r
-        ASSERT(Language == NULL);\r
-  //      Language = AllocateZeroPool(10);\r
-  //      AsciiSPrint(Language, 10, "en-us");\r
-      } else {\r
-        ASSERT(Language == NULL);\r
-        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellDriver1HiiHandle, L"-l");\r
-        ShellCommandLineFreeVarList (Package);\r
-        return (SHELL_INVALID_PARAMETER);\r
+      if (ShellCommandLineGetFlag(Package, L"-l")){\r
+        Lang = ShellCommandLineGetValue(Package, L"-l");\r
+        if (Lang != NULL) {\r
+          Language = AllocateZeroPool(StrSize(Lang));\r
+          AsciiSPrint(Language, StrSize(Lang), "%S", Lang);\r
+        } else {\r
+          ASSERT(Language == NULL);\r
+          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellDriver1HiiHandle, L"drivers", L"-l");  \r
+          ShellCommandLineFreeVarList (Package);\r
+          return (SHELL_INVALID_PARAMETER);\r
+        }\r
       }\r
 \r
-      if (ShellCommandLineGetFlag(Package, L"-sfo")) {\r
-        FormatString = HiiGetString(gShellDriver1HiiHandle, STRING_TOKEN(STR_DRIVERS_ITEM_LINE_SFO), Language);\r
+      if (ShellCommandLineGetFlag (Package, L"-sfo")) {\r
+        SfoFlag = TRUE;\r
+        FormatString = HiiGetString (gShellDriver1HiiHandle, STRING_TOKEN (STR_DRIVERS_ITEM_LINE_SFO), Language);\r
+        //\r
+        // print the SFO header\r
+        //\r
+        ShellPrintHiiEx (\r
+          -1,\r
+          -1,\r
+          Language,\r
+          STRING_TOKEN (STR_GEN_SFO_HEADER),\r
+          gShellDriver1HiiHandle,\r
+          L"drivers");\r
       } else {\r
-        FormatString = HiiGetString(gShellDriver1HiiHandle, STRING_TOKEN(STR_DRIVERS_ITEM_LINE), Language);\r
+        FormatString = HiiGetString (gShellDriver1HiiHandle, STRING_TOKEN (STR_DRIVERS_ITEM_LINE), Language);\r
         //\r
         // print the header row\r
         //\r
@@ -247,21 +346,28 @@ ShellCommandRunDrivers (
           -1,\r
           -1,\r
           Language,\r
-          STRING_TOKEN(STR_DRIVERS_HEADER_LINES),\r
+          STRING_TOKEN (STR_DRIVERS_HEADER_LINES),\r
           gShellDriver1HiiHandle);\r
       }\r
 \r
       HandleList = GetHandleListByProtocol(&gEfiDriverBindingProtocolGuid);\r
       for (HandleWalker = HandleList ; HandleWalker != NULL && *HandleWalker != NULL ; HandleWalker++){\r
-        ChildCount    = 0;\r
-        DeviceCount   = 0;\r
-        Status        = ParseHandleDatabaseForChildDevices (*HandleWalker, &ChildCount , NULL);\r
-        Status        = PARSE_HANDLE_DATABASE_DEVICES      (*HandleWalker, &DeviceCount, NULL);\r
-        Temp2         = GetDevicePathTextForHandle(*HandleWalker);\r
-        DriverVersion = ReturnDriverVersion(*HandleWalker);\r
-        DriverConfig  = ReturnDriverConfig(*HandleWalker);\r
-        DriverDiag    = ReturnDriverDiag  (*HandleWalker);\r
-        Lang          = GetStringNameFromHandle(*HandleWalker, Language==NULL?"en":Language);\r
+        ChildCount     = 0;\r
+        DeviceCount    = 0;\r
+        Status         = ParseHandleDatabaseForChildDevices (*HandleWalker, &ChildCount , NULL);\r
+        Status         = PARSE_HANDLE_DATABASE_DEVICES      (*HandleWalker, &DeviceCount, NULL);\r
+        Temp2          = GetDevicePathTextForHandle(*HandleWalker);\r
+        DriverVersion  = ReturnDriverVersion(*HandleWalker);\r
+        DriverConfig   = ReturnDriverConfig(*HandleWalker);\r
+        DriverDiag     = ReturnDriverDiag  (*HandleWalker);\r
+        FullDriverName = GetStringNameFromHandle(*HandleWalker, Language);\r
+        ImageName      = GetImageNameFromHandle (*HandleWalker);\r
+\r
+        TruncatedDriverName = NULL;\r
+        if (!SfoFlag && (FullDriverName != NULL)) {\r
+          TruncatedDriverName = AllocateZeroPool ((MAX_LEN_DRIVER_NAME + 1) * sizeof (CHAR16));\r
+          StrnCpyS (TruncatedDriverName, MAX_LEN_DRIVER_NAME + 1, FullDriverName, MAX_LEN_DRIVER_NAME);\r
+        }\r
 \r
         ShellPrintEx(\r
           -1,\r
@@ -274,12 +380,23 @@ ShellCommandRunDrivers (
           DriverDiag?L'Y':L'N',\r
           DeviceCount,\r
           ChildCount,\r
-          Lang,\r
-          Temp2==NULL?L"":Temp2\r
-         );\r
+          SfoFlag?FullDriverName:TruncatedDriverName,\r
+          SfoFlag ? (Temp2 == NULL ? L"" : Temp2) : (ImageName == NULL ? L"" : ImageName)\r
+          );\r
+        if (TruncatedDriverName != NULL) {\r
+          FreePool (TruncatedDriverName);\r
+        }\r
         if (Temp2 != NULL) {\r
           FreePool(Temp2);\r
         }\r
+        if (ImageName != NULL) {\r
+          FreePool (ImageName);\r
+        }\r
+\r
+        if (ShellGetExecutionBreakFlag ()) {\r
+          ShellStatus = SHELL_ABORTED;\r
+          break;\r
+        }\r
       }\r
     }\r
     SHELL_FREE_NON_NULL(Language);\r