]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ShellPkg/Library/UefiHandleParsingLib/UefiHandleParsingLib.c
Update the comments for function 'ConvertPixelFormat' in UefiHandleParsingLib.c to...
[mirror_edk2.git] / ShellPkg / Library / UefiHandleParsingLib / UefiHandleParsingLib.c
index 0c78d0da20253d98d42802c5c8c5b6efd1aae9c9..e1fdab3215ac43289dc0b78b36395a8dd73cf2de 100644 (file)
@@ -1,7 +1,8 @@
 /** @file\r
   Provides interface to advanced shell functionality for parsing both handle and protocol database.\r
 \r
-  Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2013 - 2014, Hewlett-Packard Development Company, L.P.\r
+  Copyright (c) 2010 - 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
 EFI_HANDLE mHandleParsingHiiHandle;\r
 HANDLE_INDEX_LIST mHandleList = {{{NULL,NULL},0,0},0};\r
 \r
+/**\r
+  Function to translate the EFI_MEMORY_TYPE into a string.\r
+\r
+  @param[in] Memory     The memory type.\r
+\r
+  @retval               A string representation of the type allocated from BS Pool.\r
+**/\r
+CHAR16*\r
+EFIAPI\r
+ConvertMemoryType (\r
+  IN CONST EFI_MEMORY_TYPE Memory\r
+  )\r
+{\r
+  CHAR16 *RetVal;\r
+  RetVal = NULL;\r
+\r
+  switch (Memory) {\r
+  case EfiReservedMemoryType:       StrnCatGrow(&RetVal, NULL, L"EfiReservedMemoryType", 0);        break;\r
+  case EfiLoaderCode:               StrnCatGrow(&RetVal, NULL, L"EfiLoaderCode", 0);                break;\r
+  case EfiLoaderData:               StrnCatGrow(&RetVal, NULL, L"EfiLoaderData", 0);                break;\r
+  case EfiBootServicesCode:         StrnCatGrow(&RetVal, NULL, L"EfiBootServicesCode", 0);          break;\r
+  case EfiBootServicesData:         StrnCatGrow(&RetVal, NULL, L"EfiBootServicesData", 0);          break;\r
+  case EfiRuntimeServicesCode:      StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesCode", 0);       break;\r
+  case EfiRuntimeServicesData:      StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesData", 0);       break;\r
+  case EfiConventionalMemory:       StrnCatGrow(&RetVal, NULL, L"EfiConventionalMemory", 0);        break;\r
+  case EfiUnusableMemory:           StrnCatGrow(&RetVal, NULL, L"EfiUnusableMemory", 0);            break;\r
+  case EfiACPIReclaimMemory:        StrnCatGrow(&RetVal, NULL, L"EfiACPIReclaimMemory", 0);         break;\r
+  case EfiACPIMemoryNVS:            StrnCatGrow(&RetVal, NULL, L"EfiACPIMemoryNVS", 0);             break;\r
+  case EfiMemoryMappedIO:           StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIO", 0);            break;\r
+  case EfiMemoryMappedIOPortSpace:  StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIOPortSpace", 0);   break;\r
+  case EfiPalCode:                  StrnCatGrow(&RetVal, NULL, L"EfiPalCode", 0);                   break;\r
+  case EfiMaxMemoryType:            StrnCatGrow(&RetVal, NULL, L"EfiMaxMemoryType", 0);             break;\r
+  default: ASSERT(FALSE);\r
+  }\r
+  return (RetVal);\r
+}\r
+\r
+/**\r
+  Function to translate the EFI_GRAPHICS_PIXEL_FORMAT into a string.\r
+\r
+  @param[in] Fmt     The format type.\r
+\r
+  @retval               A string representation of the type allocated from BS Pool.\r
+**/\r
+CHAR16*\r
+EFIAPI\r
+ConvertPixelFormat (\r
+  IN CONST EFI_GRAPHICS_PIXEL_FORMAT Fmt\r
+  )\r
+{\r
+  CHAR16 *RetVal;\r
+  RetVal = NULL;\r
+\r
+  switch (Fmt) {\r
+  case PixelRedGreenBlueReserved8BitPerColor: StrnCatGrow(&RetVal, NULL, L"PixelRedGreenBlueReserved8BitPerColor", 0);  break;\r
+  case PixelBlueGreenRedReserved8BitPerColor: StrnCatGrow(&RetVal, NULL, L"PixelBlueGreenRedReserved8BitPerColor", 0);  break;\r
+  case PixelBitMask:                          StrnCatGrow(&RetVal, NULL, L"PixelBitMask", 0);                           break;\r
+  case PixelBltOnly:                          StrnCatGrow(&RetVal, NULL, L"PixelBltOnly", 0);                           break;\r
+  case PixelFormatMax:                        StrnCatGrow(&RetVal, NULL, L"PixelFormatMax", 0);                         break;\r
+  default: ASSERT(FALSE);\r
+  }\r
+  return (RetVal);\r
+}\r
+\r
 /**\r
   Constructor for the library.\r
 \r
@@ -62,7 +127,16 @@ HandleParsingLibDestructor (
   return (EFI_SUCCESS);\r
 }\r
 \r
-/*\r
+/**\r
+  Function to dump information about LoadedImage.\r
+\r
+  This will allocate the return buffer from boot services pool.\r
+\r
+  @param[in] TheHandle      The handle that has LoadedImage installed.\r
+  @param[in] Verbose        TRUE for additional information, FALSE otherwise.\r
+\r
+  @retval A poitner to a string containing the information.\r
+**/\r
 CHAR16*\r
 EFIAPI\r
 LoadedImageProtocolDumpInformation(\r
@@ -70,96 +144,140 @@ LoadedImageProtocolDumpInformation(
   IN CONST BOOLEAN    Verbose\r
   )\r
 {\r
-  EFI_LOADED_IMAGE_PROTOCOL         *Image;\r
+  EFI_LOADED_IMAGE_PROTOCOL         *LoadedImage;\r
   EFI_STATUS                        Status;\r
-  EFI_DEVICE_PATH_PROTOCOL          *DevPath;\r
-  EFI_DEVICE_PATH_PROTOCOL          *DevPathNode;\r
-  VOID                              *Buffer;\r
-  UINTN                             BufferSize;\r
-  UINT32                            AuthenticationStatus;\r
-  EFI_GUID                          *NameGuid;\r
-  EFI_FIRMWARE_VOLUME_PROTOCOL      *FV;\r
-  EFI_FIRMWARE_VOLUME2_PROTOCOL     *FV2;\r
-\r
-  FV          = NULL;\r
-  FV2         = NULL;\r
-  Buffer      = NULL;\r
-  BufferSize  = 0;\r
-\r
-  Status      = HandleProtocol (\r
-    TheHandle,\r
-    &gEfiLoadedImageProtocolGuid,\r
-    &Image);\r
-  ASSERT_EFI_ERROR(Status);\r
+  CHAR16                            *RetVal;\r
+  CHAR16                            *Temp;\r
+  CHAR16                            *CodeType;\r
+  CHAR16                            *DataType;\r
 \r
-  DevPath     = UnpackDevicePath (Image->FilePath);\r
+  if (!Verbose) {\r
+    return (CatSPrint(NULL, L"LoadedImage"));\r
+  }\r
 \r
-  if (DevPath == NULL) {\r
+  Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_LI_DUMP_MAIN), NULL);\r
+  RetVal = AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize));\r
+  if (Temp == NULL || RetVal == NULL) {\r
+    SHELL_FREE_NON_NULL(Temp);\r
+    SHELL_FREE_NON_NULL(RetVal);\r
     return NULL;\r
   }\r
 \r
-  DevPathNode = DevPath;\r
+  Status = gBS->OpenProtocol (\r
+                TheHandle,\r
+                &gEfiLoadedImageProtocolGuid,\r
+                (VOID**)&LoadedImage,\r
+                gImageHandle,\r
+                NULL,\r
+                EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
+               );\r
 \r
-  while (!IsDevicePathEnd (DevPathNode)) {\r
-    //\r
-    // Find the Fv File path\r
-    //\r
-    NameGuid = GetNameGuidFromFwVolDevicePathNode ((MEDIA_FW_VOL_FILEPATH_DEVICE_PATH *)DevPathNode);\r
-    if (NameGuid != NULL) {\r
-      Status = BS->HandleProtocol (\r
-                    Image->DeviceHandle,\r
-                    &gEfiFirmwareVolumeProtocolGuid,\r
-                    &FV\r
-                   );\r
-      if (!EFI_ERROR (Status)) {\r
-        Status = FV->ReadSection (\r
-                      FV,\r
-                      NameGuid,\r
-                      EFI_SECTION_USER_INTERFACE,\r
-                      0,\r
-                      &Buffer,\r
-                      &BufferSize,\r
-                      &AuthenticationStatus\r
-                     );\r
-        if (!EFI_ERROR (Status)) {\r
-          break;\r
-        }\r
+  if (EFI_ERROR (Status)) {\r
+    SHELL_FREE_NON_NULL (Temp);\r
+    SHELL_FREE_NON_NULL (RetVal);\r
+    return NULL;\r
+  }\r
 \r
-        Buffer = NULL;\r
-      } else {\r
-        Status = BS->HandleProtocol (\r
-                      Image->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
-                          &Buffer,\r
-                          &BufferSize,\r
-                          &AuthenticationStatus\r
-                         );\r
-          if (!EFI_ERROR (Status)) {\r
-            break;\r
-          }\r
+  DataType = ConvertMemoryType(LoadedImage->ImageDataType);\r
+  CodeType = ConvertMemoryType(LoadedImage->ImageCodeType);\r
+\r
+  RetVal = CatSPrint(RetVal,\r
+                      Temp,\r
+                      LoadedImage->Revision,\r
+                      LoadedImage->ParentHandle,\r
+                      LoadedImage->SystemTable,\r
+                      LoadedImage->DeviceHandle,\r
+                      LoadedImage->FilePath,\r
+                      LoadedImage->LoadOptionsSize,\r
+                      LoadedImage->LoadOptions,\r
+                      LoadedImage->ImageBase,\r
+                      LoadedImage->ImageSize,\r
+                      CodeType,\r
+                      DataType,\r
+                      LoadedImage->Unload);\r
 \r
-          Buffer = NULL;\r
-        }\r
-      }\r
-    }\r
-    //\r
-    // Next device path node\r
-    //\r
-    DevPathNode = NextDevicePathNode (DevPathNode);\r
+  \r
+  SHELL_FREE_NON_NULL(Temp);\r
+  SHELL_FREE_NON_NULL(CodeType);\r
+  SHELL_FREE_NON_NULL(DataType);\r
+\r
+  return RetVal;\r
+}\r
+\r
+/**\r
+  Function to dump information about GOP.\r
+\r
+  This will allocate the return buffer from boot services pool.\r
+\r
+  @param[in] TheHandle      The handle that has LoadedImage installed.\r
+  @param[in] Verbose        TRUE for additional information, FALSE otherwise.\r
+\r
+  @retval A poitner to a string containing the information.\r
+**/\r
+CHAR16*\r
+EFIAPI\r
+GraphicsOutputProtocolDumpInformation(\r
+  IN CONST EFI_HANDLE TheHandle,\r
+  IN CONST BOOLEAN    Verbose\r
+  )\r
+{\r
+  EFI_GRAPHICS_OUTPUT_PROTOCOL      *GraphicsOutput;\r
+  EFI_STATUS                        Status;\r
+  CHAR16                            *RetVal;\r
+  CHAR16                            *Temp;\r
+  CHAR16                            *Fmt;\r
+\r
+  if (!Verbose) {\r
+    return (CatSPrint(NULL, L"GraphicsOutput"));\r
   }\r
 \r
-  FreePool (DevPath);\r
-  return Buffer;\r
+  Temp = HiiGetString(mHandleParsingHiiHandle, STRING_TOKEN(STR_GOP_DUMP_MAIN), NULL);\r
+  RetVal = AllocateZeroPool (PcdGet16 (PcdShellPrintBufferSize));\r
+  if (Temp == NULL || RetVal == NULL) {\r
+    SHELL_FREE_NON_NULL(Temp);\r
+    SHELL_FREE_NON_NULL(RetVal);\r
+    return NULL;\r
+  }\r
+\r
+  Status = gBS->OpenProtocol (\r
+                TheHandle,\r
+                &gEfiGraphicsOutputProtocolGuid,\r
+                (VOID**)&GraphicsOutput,\r
+                gImageHandle,\r
+                NULL,\r
+                EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
+               );\r
+\r
+  if (EFI_ERROR (Status)) {\r
+    SHELL_FREE_NON_NULL (Temp);\r
+    SHELL_FREE_NON_NULL (RetVal);\r
+    return NULL;\r
+  }\r
+\r
+  Fmt = ConvertPixelFormat(GraphicsOutput->Mode->Info->PixelFormat);\r
+\r
+  RetVal = CatSPrint(RetVal,\r
+                      Temp,\r
+                      GraphicsOutput->Mode->MaxMode,\r
+                      GraphicsOutput->Mode->Mode,\r
+                      GraphicsOutput->Mode->FrameBufferBase,\r
+                      (UINT64)GraphicsOutput->Mode->FrameBufferSize,\r
+                      (UINT64)GraphicsOutput->Mode->SizeOfInfo,\r
+                      GraphicsOutput->Mode->Info->Version,\r
+                      GraphicsOutput->Mode->Info->HorizontalResolution,\r
+                      GraphicsOutput->Mode->Info->VerticalResolution,\r
+                      Fmt,\r
+                      GraphicsOutput->Mode->Info->PixelsPerScanLine,\r
+                      GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.RedMask,\r
+                      GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.GreenMask,\r
+                      GraphicsOutput->Mode->Info->PixelFormat!=PixelBitMask?0:GraphicsOutput->Mode->Info->PixelInformation.BlueMask\r
+                      );\r
+  \r
+  SHELL_FREE_NON_NULL(Temp);\r
+  SHELL_FREE_NON_NULL(Fmt);\r
+\r
+  return RetVal;\r
 }\r
-*/\r
 \r
 /**\r
   Function to dump information about PciRootBridgeIo.\r
@@ -462,7 +580,7 @@ STATIC CONST GUID_INFO_BLOCK mGuidStringListNT[] = {
 };\r
 \r
 STATIC CONST GUID_INFO_BLOCK mGuidStringList[] = {\r
-  {STRING_TOKEN(STR_LOADED_IMAGE),          &gEfiLoadedImageProtocolGuid,                     NULL},\r
+  {STRING_TOKEN(STR_LOADED_IMAGE),          &gEfiLoadedImageProtocolGuid,                     LoadedImageProtocolDumpInformation},\r
   {STRING_TOKEN(STR_DEVICE_PATH),           &gEfiDevicePathProtocolGuid,                      DevicePathProtocolDumpInformation},\r
   {STRING_TOKEN(STR_IMAGE_PATH),            &gEfiLoadedImageDevicePathProtocolGuid,           DevicePathProtocolDumpInformation},\r
   {STRING_TOKEN(STR_DEVICE_PATH_UTIL),      &gEfiDevicePathUtilitiesProtocolGuid,             NULL},\r
@@ -487,7 +605,7 @@ STATIC CONST GUID_INFO_BLOCK mGuidStringList[] = {
   {STRING_TOKEN(STR_SIM_POINTER),           &gEfiSimplePointerProtocolGuid,                   NULL},\r
   {STRING_TOKEN(STR_ABS_POINTER),           &gEfiAbsolutePointerProtocolGuid,                 NULL},\r
   {STRING_TOKEN(STR_SERIAL_IO),             &gEfiSerialIoProtocolGuid,                        NULL},\r
-  {STRING_TOKEN(STR_GRAPHICS_OUTPUT),       &gEfiGraphicsOutputProtocolGuid,                  NULL},\r
+  {STRING_TOKEN(STR_GRAPHICS_OUTPUT),       &gEfiGraphicsOutputProtocolGuid,                  GraphicsOutputProtocolDumpInformation},\r
   {STRING_TOKEN(STR_EDID_DISCOVERED),       &gEfiEdidDiscoveredProtocolGuid,                  NULL},\r
   {STRING_TOKEN(STR_EDID_ACTIVE),           &gEfiEdidActiveProtocolGuid,                      NULL},\r
   {STRING_TOKEN(STR_EDID_OVERRIDE),         &gEfiEdidOverrideProtocolGuid,                    NULL},\r
@@ -618,7 +736,18 @@ STATIC CONST GUID_INFO_BLOCK mGuidStringList[] = {
   {STRING_TOKEN(STR_KMS),                   &gEfiKmsProtocolGuid,                             NULL},\r
   {STRING_TOKEN(STR_BLK_IO2),               &gEfiBlockIo2ProtocolGuid,                        NULL},\r
   {STRING_TOKEN(STR_SSC),                   &gEfiStorageSecurityCommandProtocolGuid,          NULL},\r
-  {STRING_TOKEN(STR_UC2),                   &gEfiUserCredential2ProtocolGuid,                 NULL},\r
+  {STRING_TOKEN(STR_UCRED2),                &gEfiUserCredential2ProtocolGuid,                 NULL},\r
+\r
+//\r
+// UEFI 2.4\r
+//\r
+  {STRING_TOKEN(STR_DISK_IO2),              &gEfiDiskIo2ProtocolGuid,                         NULL},\r
+  {STRING_TOKEN(STR_ADAPTER_INFO),          &gEfiAdapterInformationProtocolGuid,              NULL},\r
+\r
+//\r
+// PI Spec ones\r
+//\r
+  {STRING_TOKEN(STR_IDE_CONT_INIT),         &gEfiIdeControllerInitProtocolGuid,               NULL},\r
 \r
 //\r
 // terminator\r
@@ -753,7 +882,7 @@ GetGuidFromStringName(
   if (PcdGetBool(PcdShellIncludeNtGuids)) {\r
     for (ListWalker = mGuidStringListNT ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
       String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
-      if (Name != NULL && String != NULL && StrCmp(Name, String)==0) {\r
+      if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
         *Guid = ListWalker->GuidId;\r
       }\r
       SHELL_FREE_NON_NULL(String);\r
@@ -764,7 +893,7 @@ GetGuidFromStringName(
   }\r
   for (ListWalker = mGuidStringList ; ListWalker != NULL && ListWalker->GuidId != NULL ; ListWalker++) {\r
     String = HiiGetString(mHandleParsingHiiHandle, ListWalker->StringId, Lang);\r
-    if (Name != NULL && String != NULL && StrCmp(Name, String)==0) {\r
+    if (Name != NULL && String != NULL && StringNoCaseCompare (&Name, &String) == 0) {\r
       *Guid = ListWalker->GuidId;\r
     }\r
     SHELL_FREE_NON_NULL(String);\r
@@ -778,18 +907,21 @@ GetGuidFromStringName(
 /**\r
   Get best support language for this driver.\r
   \r
-  First base on the current platform used language to search,Second base on the \r
-  default language to search. The caller need to free the buffer of the best \r
-  language.\r
+  First base on the user input language  to search, second base on the current \r
+  platform used language to search, third get the first language from the \r
+  support language list. The caller need to free the buffer of the best language.\r
 \r
   @param[in] SupportedLanguages      The support languages for this driver.\r
+  @param[in] InputLanguage           The user input language.\r
   @param[in] Iso639Language          Whether get language for ISO639.\r
 \r
   @return                            The best support language for this driver.\r
 **/\r
 CHAR8 *\r
+EFIAPI\r
 GetBestLanguageForDriver (\r
-  IN CONST CHAR8  *SupportedLanguages, \r
+  IN CONST CHAR8  *SupportedLanguages,\r
+  IN CONST CHAR8  *InputLanguage,\r
   IN BOOLEAN      Iso639Language\r
   )\r
 {\r
@@ -801,8 +933,9 @@ GetBestLanguageForDriver (
   BestLanguage = GetBestLanguage(\r
                    SupportedLanguages,\r
                    Iso639Language,\r
+                   (InputLanguage != NULL) ? InputLanguage : "",\r
                    (LanguageVariable != NULL) ? LanguageVariable : "",\r
-                   Iso639Language ? "en" : "en-US",\r
+                   SupportedLanguages,\r
                    NULL\r
                    );\r
 \r
@@ -845,12 +978,8 @@ GetStringNameFromHandle(
     NULL,\r
     EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
   if (!EFI_ERROR(Status)) {\r
-    if (Language == NULL) {\r
-      BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, FALSE);\r
-      Language = BestLang;\r
-    }\r
-    Status = CompNameStruct->GetDriverName(CompNameStruct, (CHAR8*)Language, &RetVal);\r
-\r
+    BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);\r
+    Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);\r
     if (BestLang != NULL) {\r
       FreePool (BestLang);\r
       BestLang = NULL;\r
@@ -867,12 +996,8 @@ GetStringNameFromHandle(
     NULL,\r
     EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
   if (!EFI_ERROR(Status)) {\r
-    if (Language == NULL) {\r
-      BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, FALSE);\r
-      Language = BestLang;\r
-    }\r
-    Status = CompNameStruct->GetDriverName(CompNameStruct, (CHAR8*)Language, &RetVal);\r
-    \r
+    BestLang = GetBestLanguageForDriver (CompNameStruct->SupportedLanguages, Language, FALSE);\r
+    Status = CompNameStruct->GetDriverName(CompNameStruct, BestLang, &RetVal);\r
     if (BestLang != NULL) {\r
       FreePool (BestLang);\r
     }\r