OvmfPkg: PlatformDxe: get available resolutions from GOP

Generate the options for the drop-down list from the GOP resolutions.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Jordan Justen <jordan.l.justen@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15372 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/OvmfPkg/PlatformDxe/Platform.c b/OvmfPkg/PlatformDxe/Platform.c
index f0adb0ea935853d0fd5bc28e1c9bd1dc7ec79407..b69f2498b885f5720b50f40ebb0a54f4298594fc 100644 (file)
--- a/OvmfPkg/PlatformDxe/Platform.c
+++ b/OvmfPkg/PlatformDxe/Platform.c
@@ -18,9 +18,12 @@
 #include <Library/DebugLib.h>\r
 #include <Library/DevicePathLib.h>\r
 #include <Library/HiiLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+#include <Library/PrintLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/UefiHiiServicesLib.h>\r
 #include <Protocol/DevicePath.h>\r
+#include <Protocol/GraphicsOutput.h>\r
 #include <Protocol/HiiConfigAccess.h>\r
 #include <Guid/MdeModuleHii.h>\r
 #include <Guid/OvmfPlatformConfig.h>\r
@@ -98,6 +101,29 @@ STATIC EFI_HII_HANDLE mInstalledPackages;
 extern UINT8 PlatformDxeStrings[];\r
 extern UINT8 PlatformFormsBin[];\r
 \r
+//\r
+// We want to be notified about GOP installations until we find one GOP\r
+// interface that lets us populate the form.\r
+//\r
+STATIC EFI_EVENT mGopEvent;\r
+\r
+//\r
+// The registration record underneath this pointer allows us to iterate through\r
+// the GOP instances one by one.\r
+//\r
+STATIC VOID *mGopTracker;\r
+\r
+//\r
+// Cache the resolutions we get from the GOP.\r
+//\r
+typedef struct {\r
+  UINT32 X;\r
+  UINT32 Y;\r
+} GOP_MODE;\r
+\r
+STATIC UINTN    mNumGopModes;\r
+STATIC GOP_MODE *mGopModes;\r
+\r
 \r
 /**\r
   This function is called by the HII machinery when it fetches the form state.\r
@@ -179,6 +205,68 @@ Callback (
 }\r
 \r
 \r
+/**\r
+  Query and save all resolutions supported by the GOP.\r
+\r
+  @param[in]  Gop          The Graphics Output Protocol instance to query.\r
+\r
+  @param[out] NumGopModes  The number of modes supported by the GOP. On output,\r
+                           this parameter will be positive.\r
+\r
+  @param[out] GopModes     On output, a dynamically allocated array containing\r
+                           the resolutions returned by the GOP. The caller is\r
+                           responsible for freeing the array after use.\r
+\r
+  @retval EFI_UNSUPPORTED       No modes found.\r
+  @retval EFI_OUT_OF_RESOURCES  Failed to allocate GopModes.\r
+  @return                       Error codes from Gop->QueryMode().\r
+\r
+**/\r
+STATIC\r
+EFI_STATUS\r
+EFIAPI\r
+QueryGopModes (\r
+  IN  EFI_GRAPHICS_OUTPUT_PROTOCOL *Gop,\r
+  OUT UINTN                        *NumGopModes,\r
+  OUT GOP_MODE                     **GopModes\r
+  )\r
+{\r
+  EFI_STATUS Status;\r
+  UINT32     ModeNumber;\r
+\r
+  if (Gop->Mode->MaxMode == 0) {\r
+    return EFI_UNSUPPORTED;\r
+  }\r
+  *NumGopModes = Gop->Mode->MaxMode;\r
+\r
+  *GopModes = AllocatePool (Gop->Mode->MaxMode * sizeof **GopModes);\r
+  if (*GopModes == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  for (ModeNumber = 0; ModeNumber < Gop->Mode->MaxMode; ++ModeNumber) {\r
+    EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;\r
+    UINTN                                SizeOfInfo;\r
+\r
+    Status = Gop->QueryMode (Gop, ModeNumber, &SizeOfInfo, &Info);\r
+    if (EFI_ERROR (Status)) {\r
+      goto FreeGopModes;\r
+    }\r
+\r
+    (*GopModes)[ModeNumber].X = Info->HorizontalResolution;\r
+    (*GopModes)[ModeNumber].Y = Info->VerticalResolution;\r
+    FreePool (Info);\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+\r
+FreeGopModes:\r
+  FreePool (*GopModes);\r
+\r
+  return Status;\r
+}\r
+\r
+\r
 /**\r
   Create a set of "one-of-many" (ie. "drop down list") option IFR opcodes,\r
   based on available GOP resolutions, to be placed under a "one-of-many" (ie.\r
@@ -193,6 +281,10 @@ Callback (
                             resolutions. The caller is responsible for freeing\r
                             OpCodeBuffer with HiiFreeOpCodeHandle() after use.\r
 \r
+  @param[in]  NumGopModes   Number of entries in GopModes.\r
+\r
+  @param[in]  GopModes      Array of resolutions retrieved from the GOP.\r
+\r
   @retval EFI_SUCESS  Opcodes have been successfully produced.\r
 \r
   @return             Status codes from underlying functions. PackageList may\r
@@ -204,30 +296,39 @@ EFI_STATUS
 EFIAPI\r
 CreateResolutionOptions (\r
   IN  EFI_HII_HANDLE  *PackageList,\r
-  OUT VOID            **OpCodeBuffer\r
+  OUT VOID            **OpCodeBuffer,\r
+  IN  UINTN           NumGopModes,\r
+  IN  GOP_MODE        *GopModes\r
   )\r
 {\r
-  EFI_STATUS                   Status;\r
-  VOID                         *OutputBuffer;\r
-  EFI_STRING_ID                NewString;\r
-  VOID                         *OpCode;\r
+  EFI_STATUS Status;\r
+  VOID       *OutputBuffer;\r
+  UINTN      ModeNumber;\r
 \r
   OutputBuffer = HiiAllocateOpCodeHandle ();\r
   if (OutputBuffer == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
-  NewString = HiiSetString (PackageList, 0 /* new string */, L"800x600",\r
-                NULL /* for all languages */);\r
-  if (NewString == 0) {\r
-    Status = EFI_OUT_OF_RESOURCES;\r
-    goto FreeOutputBuffer;\r
-  }\r
-  OpCode = HiiCreateOneOfOptionOpCode (OutputBuffer, NewString,\r
-             0 /* Flags */, EFI_IFR_NUMERIC_SIZE_4, 0 /* Value */);\r
-  if (OpCode == NULL) {\r
-    Status = EFI_OUT_OF_RESOURCES;\r
-    goto FreeOutputBuffer;\r
+  for (ModeNumber = 0; ModeNumber < NumGopModes; ++ModeNumber) {\r
+    CHAR16        Desc[MAXSIZE_RES_CUR];\r
+    EFI_STRING_ID NewString;\r
+    VOID          *OpCode;\r
+\r
+    UnicodeSPrintAsciiFormat (Desc, sizeof Desc, "%Ldx%Ld",\r
+      (INT64) GopModes[ModeNumber].X, (INT64) GopModes[ModeNumber].Y);\r
+    NewString = HiiSetString (PackageList, 0 /* new string */, Desc,\r
+                  NULL /* for all languages */);\r
+    if (NewString == 0) {\r
+      Status = EFI_OUT_OF_RESOURCES;\r
+      goto FreeOutputBuffer;\r
+    }\r
+    OpCode = HiiCreateOneOfOptionOpCode (OutputBuffer, NewString,\r
+               0 /* Flags */, EFI_IFR_NUMERIC_SIZE_4, ModeNumber);\r
+    if (OpCode == NULL) {\r
+      Status = EFI_OUT_OF_RESOURCES;\r
+      goto FreeOutputBuffer;\r
+    }\r
   }\r
 \r
   *OpCodeBuffer = OutputBuffer;\r
@@ -244,6 +345,9 @@ FreeOutputBuffer:
   Populate the form identified by the (PackageList, FormSetGuid, FormId)\r
   triplet.\r
 \r
+  The drop down list of video resolutions is generated from (NumGopModes,\r
+  GopModes).\r
+\r
   @retval EFI_SUCESS  Form successfully updated.\r
   @return             Status codes from underlying functions.\r
 \r
@@ -254,7 +358,9 @@ EFIAPI
 PopulateForm (\r
   IN  EFI_HII_HANDLE  *PackageList,\r
   IN  EFI_GUID        *FormSetGuid,\r
-  IN  EFI_FORM_ID     FormId\r
+  IN  EFI_FORM_ID     FormId,\r
+  IN  UINTN           NumGopModes,\r
+  IN  GOP_MODE        *GopModes\r
   )\r
 {\r
   EFI_STATUS         Status;\r
@@ -293,7 +399,8 @@ PopulateForm (
   //\r
   // 3.1. Get a list of resolutions.\r
   //\r
-  Status = CreateResolutionOptions (PackageList, &OpCodeBuffer2);\r
+  Status = CreateResolutionOptions (PackageList, &OpCodeBuffer2,\r
+             NumGopModes, GopModes);\r
   if (EFI_ERROR (Status)) {\r
     goto FreeOpCodeBuffer;\r
   }\r
@@ -381,6 +488,66 @@ ExecutePlatformConfig (
 }\r
 \r
 \r
+/**\r
+  Notification callback for GOP interface installation.\r
+\r
+  @param[in] Event    Event whose notification function is being invoked.\r
+\r
+  @param[in] Context  The pointer to the notification function's context, which\r
+                      is implementation-dependent.\r
+**/\r
+STATIC\r
+VOID\r
+EFIAPI\r
+GopInstalled (\r
+  IN EFI_EVENT Event,\r
+  IN VOID      *Context\r
+  )\r
+{\r
+  EFI_STATUS                   Status;\r
+  EFI_GRAPHICS_OUTPUT_PROTOCOL *Gop;\r
+\r
+  ASSERT (Event == mGopEvent);\r
+\r
+  //\r
+  // Check further GOPs.\r
+  //\r
+  for (;;) {\r
+    mNumGopModes = 0;\r
+    mGopModes = NULL;\r
+\r
+    Status = gBS->LocateProtocol (&gEfiGraphicsOutputProtocolGuid, mGopTracker,\r
+                    (VOID **) &Gop);\r
+    if (EFI_ERROR (Status)) {\r
+      return;\r
+    }\r
+\r
+    Status = QueryGopModes (Gop, &mNumGopModes, &mGopModes);\r
+    if (EFI_ERROR (Status)) {\r
+      continue;\r
+    }\r
+\r
+    Status = PopulateForm (mInstalledPackages, &gOvmfPlatformConfigGuid,\r
+               FORMID_MAIN_FORM, mNumGopModes, mGopModes);\r
+    if (EFI_ERROR (Status)) {\r
+      FreePool (mGopModes);\r
+      continue;\r
+    }\r
+\r
+    break;\r
+  }\r
+\r
+  //\r
+  // Success -- so uninstall this callback. Closing the event removes all\r
+  // pending notifications and all protocol registrations.\r
+  //\r
+  Status = gBS->CloseEvent (mGopEvent);\r
+  ASSERT_EFI_ERROR (Status);\r
+  mGopEvent = NULL;\r
+  mGopTracker = NULL;\r
+}\r
+\r
+\r
 /**\r
   Entry point for this driver.\r
 \r
@@ -433,14 +600,29 @@ PlatformInit (
     goto UninstallProtocols;\r
   }\r
 \r
-  Status = PopulateForm (mInstalledPackages, &gOvmfPlatformConfigGuid,\r
-             FORMID_MAIN_FORM);\r
+  Status = gBS->CreateEvent (EVT_NOTIFY_SIGNAL, TPL_CALLBACK, &GopInstalled,\r
+                  NULL /* Context */, &mGopEvent);\r
   if (EFI_ERROR (Status)) {\r
     goto RemovePackages;\r
   }\r
 \r
+  Status = gBS->RegisterProtocolNotify (&gEfiGraphicsOutputProtocolGuid,\r
+                  mGopEvent, &mGopTracker);\r
+  if (EFI_ERROR (Status)) {\r
+    goto CloseGopEvent;\r
+  }\r
+\r
+  //\r
+  // Check already installed GOPs.\r
+  //\r
+  Status = gBS->SignalEvent (mGopEvent);\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
   return EFI_SUCCESS;\r
 \r
+CloseGopEvent:\r
+  gBS->CloseEvent (mGopEvent);\r
+\r
 RemovePackages:\r
   HiiRemovePackages (mInstalledPackages);\r
 \r
@@ -465,6 +647,24 @@ PlatformUnload (
   IN  EFI_HANDLE  ImageHandle\r
   )\r
 {\r
+  if (mGopEvent == NULL) {\r
+    //\r
+    // The GOP callback ran successfully and unregistered itself. Release the\r
+    // resources allocated there.\r
+    //\r
+    ASSERT (mGopModes != NULL);\r
+    FreePool (mGopModes);\r
+  } else {\r
+    //\r
+    // Otherwise we need to unregister the callback.\r
+    //\r
+    ASSERT (mGopModes == NULL);\r
+    gBS->CloseEvent (mGopEvent);\r
+  }\r
+\r
+  //\r
+  // Release resources allocated by the entry point.\r
+  //\r
   HiiRemovePackages (mInstalledPackages);\r
   gBS->UninstallMultipleProtocolInterfaces (ImageHandle,\r
          &gEfiDevicePathProtocolGuid,      &mPkgDevicePath,\r

diff --git a/OvmfPkg/PlatformDxe/Platform.inf b/OvmfPkg/PlatformDxe/Platform.inf
index 5997e343e49ca0902d4977ad0d9246c49fdc2b52..16cd9ab753a8a87efebd0ee2e1f7f7cb9e713630 100644 (file)
--- a/OvmfPkg/PlatformDxe/Platform.inf
+++ b/OvmfPkg/PlatformDxe/Platform.inf
@@ -42,6 +42,7 @@
   DevicePathLib\r
   HiiLib\r
   MemoryAllocationLib\r
+  PrintLib\r
   UefiBootServicesTableLib\r
   UefiHiiServicesLib\r
   UefiLib\r
@@ -54,6 +55,7 @@
 \r
 [Protocols]\r
   gEfiDevicePathProtocolGuid      ## PRODUCES\r
+  gEfiGraphicsOutputProtocolGuid  ## CONSUMES\r
   gEfiHiiConfigAccessProtocolGuid ## PRODUCES\r
 \r
 [Guids]\r