OpenCoreUefi: Drop Scale and make NVRAM apply earlier

Changelog.md

@@ -9,7 +9,6 @@ OpenCore Changelog
 - Moved `ConsoleMode`, `Resolution` options to `Output` section
 - Moved console-related UEFI quirks to `Output` section
 - Replaced `ConsoleControl` and `BuiltinTextRenderer` with `TextRenderer`
-- Added `Scale` option to set builtin text renderer scaling
 - Removed `ConsoleBehaviourOs` and `ConsoleBehaviourUi`
 - Fixed providing ConsoleOutHandle GOP when running from Shell
 - Added `PickerAttributes` option to colour picker
@@ -18,6 +17,8 @@ OpenCore Changelog
 - Added `BootKicker` tool to support launching Apple BootPicker
 - Added BootPicker support as an external UI in OC through `PickerMode`
 - Added `DirectGopRendering` option to use direct GOP output
+- Multiple memory corruption and performance fixes for PNG support
+- Fixed `DefaultBackgroundColor` variable handling
 
 #### v0.5.5
 - Fixed CPU bus ratio calculation for Nehalem and Westmere

Docs/Configuration.tex

@@ -1344,7 +1344,9 @@ To view their current state use \texttt{pmset -g} command in Terminal.
   performing early boot identity mapping of assigned virtual addresses to physical
   memory.
 
-  \emph{Note}: The necessity of this quirk is determined by early boot failures.
+  \emph{Note}: The necessity of this quirk is determined by early boot failures. Currently
+  new firmwares with memory protection support (like OVMF) do not support this quirk due to
+  \href{https://github.com/acidanthera/bugtracker/issues/719}{acidanthera/bugtracker\#719}.
 
 \item
   \texttt{ShrinkMemoryMap}\\
@@ -2102,7 +2104,8 @@ behaviour that does not go to any other sections
   \end{itemize}
 
   \emph{Note}: This option may not work well with \texttt{System} text renderer.
-  Setting a background different from black could help testing proper GOP functioning.
+  Setting a background different from black could help testing proper GOP functioning
+  but may slightly reduce performance.
 
 \item
   \texttt{PollAppleHotKeys}\\
@@ -2843,6 +2846,12 @@ improvements:
   \break
   One-byte data defining boot.efi user interface scaling. Should be \textbf{01} for normal
   screens and \textbf{02} for HiDPI screens.
+ \item
+  \texttt{4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:DefaultBackgroundColor}
+  \break
+  Four-byte \texttt{RGBA} data defining boot.efi user interface background colour.
+  Standard colours include \textbf{BF BF BF 00} (Light Gray) and \textbf{00 00 00 00}
+  (Syrah Black). Other colours may be set at user's preference.
 \end{itemize}
 
 \subsection{Other Variables}\label{nvramvarsother}
@@ -3886,8 +3895,7 @@ build -a X64 -b RELEASE -t XCODE5 -p MdeModulePkg/MdeModulePkg.dsc
 
   The use of \texttt{BuiltinGraphics} is generally straightforward.
   For most platforms it is necessary to enable \texttt{ProvideConsoleGop},
-  set \texttt{Resolution} to \texttt{Max}, and optionally configure
-  \texttt{Scale}.
+  set \texttt{Resolution} to \texttt{Max}.
 
   The use of \texttt{System} protocols is more complicated. In general
   the preferred setting is \texttt{SystemGraphics} or \texttt{SystemText}.
@@ -3932,8 +3940,9 @@ build -a X64 -b RELEASE -t XCODE5 -p MdeModulePkg/MdeModulePkg.dsc
 
   On HiDPI screens \texttt{APPLE\_VENDOR\_VARIABLE\_GUID} \texttt{UIScale}
   NVRAM variable may need to be set to \texttt{02} to enable HiDPI scaling
-  in FileVault 2 UEFI password interface and boot screen logo. Refer to
-  \hyperref[nvramvarsrec]{Recommended Variables} section for more details.
+  in \texttt{Builtin} text renderer, FileVault 2 UEFI password interface,
+  and boot screen logo. Refer to \hyperref[nvramvarsrec]{Recommended Variables}
+  section for more details.
 
   \emph{Note}: This will fail when console handle has no GOP protocol. When
   the firmware does not provide it, it can be added with \texttt{ProvideConsoleGop}
@@ -4022,16 +4031,6 @@ build -a X64 -b RELEASE -t XCODE5 -p MdeModulePkg/MdeModulePkg.dsc
    On all known affected systems \texttt{ConsoleMode} had to be set to
    empty string for this to work.
 
-\item
-  \texttt{Scale}\\
-  \textbf{Type}: \texttt{plist\ integer}\\
-  \textbf{Failsafe}: \texttt{100}\\
-  \textbf{Description}: Sets text renderer HiDPI scaling in percents.
-
-  Currently only \texttt{100} and \texttt{200} values are supported.
-
-  \emph{Note}: This option only applies to \texttt{Builtin} renderer.
-
 \end{enumerate}
 
 
@@ -4112,6 +4111,9 @@ build -a X64 -b RELEASE -t XCODE5 -p MdeModulePkg/MdeModulePkg.dsc
   to support custom cursor images for File Vault 2. Should be set to \texttt{true}
   to ensure File Vault 2 compatibility on everything but VMs and legacy Macs.
 
+  \emph{Note}: Several virtual machines including VMware may have corrupted
+  cursor image in HiDPI mode and thus may also require this setting to be enabled.
+
 \item
   \texttt{HashServices}\\
   \textbf{Type}: \texttt{plist\ boolean}\\

Docs/Differences/Differences.tex

 \documentclass[]{article}
 %DIF LATEXDIFF DIFFERENCE FILE
-%DIF DEL PreviousConfiguration.tex   Thu Feb  6 00:43:28 2020
-%DIF ADD ../Configuration.tex        Thu Feb 13 03:27:29 2020
+%DIF DEL PreviousConfiguration.tex   Sat Feb 15 19:18:47 2020
+%DIF ADD ../Configuration.tex        Sun Feb 16 02:28:53 2020
 
 \usepackage{lmodern}
 \usepackage{amssymb,amsmath}
@@ -1407,7 +1407,10 @@ To view their current state use \texttt{pmset -g} command in Terminal.
   performing early boot identity mapping of assigned virtual addresses to physical
   memory.
 
-  \emph{Note}: The necessity of this quirk is determined by early boot failures.
+  \emph{Note}: The necessity of this quirk is determined by early boot failures. \DIFaddbegin \DIFadd{Currently
+  new firmwares with memory protection support (like OVMF) do not support this quirk due to
+  }\href{https://github.com/acidanthera/bugtracker/issues/719}{acidanthera/bugtracker\#719}\DIFadd{.
+}\DIFaddend 
 
 \item
   \texttt{ShrinkMemoryMap}\\
@@ -2385,7 +2388,8 @@ behaviour that does not go to any other sections
   \end{itemize}
 
   \emph{\DIFadd{Note}}\DIFadd{: This option may not work well with }\texttt{\DIFadd{System}} \DIFadd{text renderer.
-  Setting a background different from black could help testing proper GOP functioning.
+  Setting a background different from black could help testing proper GOP functioning
+  but may slightly reduce performance.
 }
 
 \item
@@ -3258,7 +3262,13 @@ improvements:
   \break
   One-byte data defining boot.efi user interface scaling. Should be \textbf{01} for normal
   screens and \textbf{02} for HiDPI screens.
-\end{itemize}
+ \DIFaddbegin \item
+  \texttt{\DIFadd{4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:DefaultBackgroundColor}}
+  \break
+  \DIFadd{Four-byte }\texttt{\DIFadd{RGBA}} \DIFadd{data defining boot.efi user interface background colour.
+  Standard colours include }\textbf{\DIFadd{BF BF BF 00}} \DIFadd{(Light Gray) and }\textbf{\DIFadd{00 00 00 00}}
+  \DIFadd{(Syrah Black). Other colours may be set at user's preference.
+}\DIFaddend \end{itemize}
 
 \subsection{Other Variables}\label{nvramvarsother}
 
@@ -4307,8 +4317,7 @@ build -a X64 -b RELEASE -t XCODE5 -p MdeModulePkg/MdeModulePkg.dsc
 
   \DIFadd{The use of }\texttt{\DIFadd{BuiltinGraphics}} \DIFadd{is generally straightforward.
   For most platforms it is necessary to enable }\texttt{\DIFadd{ProvideConsoleGop}}\DIFadd{,
-  set }\texttt{\DIFadd{Resolution}} \DIFadd{to }\texttt{\DIFadd{Max}}\DIFadd{, and optionally configure
-  }\texttt{\DIFadd{Scale}}\DIFadd{.
+  set }\texttt{\DIFadd{Resolution}} \DIFadd{to }\texttt{\DIFadd{Max}}\DIFadd{.
 }
 
   \DIFadd{The use of }\texttt{\DIFadd{System}} \DIFadd{protocols is more complicated. In general
@@ -4360,8 +4369,9 @@ build -a X64 -b RELEASE -t XCODE5 -p MdeModulePkg/MdeModulePkg.dsc
 
   \DIFadd{On HiDPI screens }\texttt{\DIFadd{APPLE\_VENDOR\_VARIABLE\_GUID}} \texttt{\DIFadd{UIScale}}
   \DIFadd{NVRAM variable may need to be set to }\texttt{\DIFadd{02}} \DIFadd{to enable HiDPI scaling
-  in FileVault 2 UEFI password interface and boot screen logo. Refer to
-  }\hyperref[nvramvarsrec]{Recommended Variables} \DIFadd{section for more details.
+  in }\texttt{\DIFadd{Builtin}} \DIFadd{text renderer, FileVault 2 UEFI password interface,
+  and boot screen logo. Refer to }\hyperref[nvramvarsrec]{Recommended Variables}
+  \DIFadd{section for more details.
 }
 
   \emph{\DIFadd{Note}}\DIFadd{: This will fail when console handle has no GOP protocol. When
@@ -4468,19 +4478,6 @@ build -a X64 -b RELEASE -t XCODE5 -p MdeModulePkg/MdeModulePkg.dsc
    empty string for this to work.
 }
 
-\item
-  \texttt{\DIFadd{Scale}}\\
-  \textbf{\DIFadd{Type}}\DIFadd{: }\texttt{\DIFadd{plist\ integer}}\\
-  \textbf{\DIFadd{Failsafe}}\DIFadd{: }\texttt{\DIFadd{100}}\\
-  \textbf{\DIFadd{Description}}\DIFadd{: Sets text renderer HiDPI scaling in percents.
-}
-
-  \DIFadd{Currently only }\texttt{\DIFadd{100}} \DIFadd{and }\texttt{\DIFadd{200}} \DIFadd{values are supported.
-}
-
-  \emph{\DIFadd{Note}}\DIFadd{: This option only applies to }\texttt{\DIFadd{Builtin}} \DIFadd{renderer.
-}
-
 \end{enumerate}
 
 
@@ -4591,7 +4588,11 @@ build -a X64 -b RELEASE -t XCODE5 -p MdeModulePkg/MdeModulePkg.dsc
   to support custom cursor images for File Vault 2. Should be set to \texttt{true}
   to ensure File Vault 2 compatibility on everything but VMs and legacy Macs.
 
-\item
+  \DIFaddbegin \emph{\DIFadd{Note}}\DIFadd{: Several virtual machines including VMware may have corrupted
+  cursor image in HiDPI mode and thus may also require this setting to be enabled.
+}
+
+\DIFaddend \item
   \texttt{HashServices}\\
   \textbf{Type}: \texttt{plist\ boolean}\\
   \textbf{Failsafe}: \texttt{false}\\

Docs/Sample.plist

@@ -677,6 +677,8 @@
 			<dict>
 				<key>UIScale</key>
 				<data>AQ==</data>
+				<key>DefaultBackgroundColor</key>
+				<data>AAAAAA==</data>
 			</dict>
 			<key>7C436110-AB2A-4BBB-A880-FE41995C9F82</key>
 			<dict>
@@ -695,6 +697,7 @@
 			<key>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14</key>
 			<array>
 				<string>UIScale</string>
+				<string>DefaultBackgroundColor</string>
 			</array>
 			<key>7C436110-AB2A-4BBB-A880-FE41995C9F82</key>
 			<array>
@@ -814,8 +817,6 @@
 			<false/>
 			<key>SanitiseClearScreen</key>
 			<false/>
-			<key>Scale</key>
-			<integer>100</integer>
 		</dict>
 		<key>Protocols</key>
 		<dict>

Docs/SampleFull.plist

@@ -677,6 +677,8 @@
 			<dict>
 				<key>UIScale</key>
 				<data>AQ==</data>
+				<key>DefaultBackgroundColor</key>
+				<data>AAAAAA==</data>
 			</dict>
 			<key>7C436110-AB2A-4BBB-A880-FE41995C9F82</key>
 			<dict>
@@ -695,6 +697,7 @@
 			<key>4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14</key>
 			<array>
 				<string>UIScale</string>
+				<string>DefaultBackgroundColor</string>
 			</array>
 			<key>7C436110-AB2A-4BBB-A880-FE41995C9F82</key>
 			<array>
@@ -917,8 +920,6 @@
 			<false/>
 			<key>SanitiseClearScreen</key>
 			<false/>
-			<key>Scale</key>
-			<integer>100</integer>
 		</dict>
 		<key>Protocols</key>
 		<dict>

Platform/OpenCore/OpenCore.c

@@ -113,6 +113,8 @@ OcMain (
 
   OcCpuScanProcessor (&mOpenCoreCpuInfo);
 
+  DEBUG ((DEBUG_INFO, "OC: OcLoadNvramSupport...\n"));
+  OcLoadNvramSupport (Storage, &mOpenCoreConfiguration);
   DEBUG ((DEBUG_INFO, "OC: OcLoadUefiSupport...\n"));
   OcLoadUefiSupport (Storage, &mOpenCoreConfiguration, &mOpenCoreCpuInfo);
   DEBUG ((DEBUG_INFO, "OC: OcLoadAcpiSupport...\n"));
@@ -121,8 +123,6 @@ OcMain (
   OcLoadPlatformSupport (&mOpenCoreConfiguration, &mOpenCoreCpuInfo);
   DEBUG ((DEBUG_INFO, "OC: OcLoadDevPropsSupport...\n"));
   OcLoadDevPropsSupport (&mOpenCoreConfiguration);
-  DEBUG ((DEBUG_INFO, "OC: OcLoadNvramSupport...\n"));
-  OcLoadNvramSupport (Storage, &mOpenCoreConfiguration);
   DEBUG ((DEBUG_INFO, "OC: OcMiscLateInit...\n"));
   OcMiscLateInit (&mOpenCoreConfiguration, LoadPath, &LoadHandle);
   DEBUG ((DEBUG_INFO, "OC: OcLoadKernelSupport...\n"));

Platform/OpenCore/OpenCoreUefi.c

@@ -469,7 +469,6 @@ OcLoadUefiOutputSupport (
 
   OcSetupConsole (
     Renderer,
-    Config->Uefi.Output.Scale,
     Config->Uefi.Output.IgnoreTextInGraphics,
     Config->Uefi.Output.SanitiseClearScreen,
     Config->Uefi.Output.ClearScreenOnModeSwitch,