Docs: Clarify Failsafe Values (#192)

This commit is contained in:
dakanji 2021-02-05 03:03:31 +03:00 committed by GitHub
parent 5d92bcbf71
commit 95e4e9a29d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -881,7 +881,7 @@ of the suggested solutions will vary from case to case.
\item
\texttt{Comment}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Arbitrary ASCII string used to provide human readable
reference for the entry. It is implementation defined whether this value is
used.
@ -896,7 +896,7 @@ of the suggested solutions will vary from case to case.
\item
\texttt{Path}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: File paths meant to be loaded as ACPI tables.
Example values include \texttt{DSDT.aml}, \texttt{SubDir/SSDT-8.aml},
\texttt{SSDT-USBX.aml}, etc.
@ -923,7 +923,7 @@ of the suggested solutions will vary from case to case.
\item
\texttt{Comment}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Arbitrary ASCII string used to provide human readable
reference for the entry. It is implementation defined whether this value is
used.
@ -969,7 +969,7 @@ of the suggested solutions will vary from case to case.
\item
\texttt{Comment}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Arbitrary ASCII string used to provide human readable
reference for the entry. It is implementation defined whether this value is
used.
@ -1298,7 +1298,7 @@ To view their current state use \texttt{pmset -g} command in Terminal.
\item
\texttt{Comment}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Arbitrary ASCII string used to provide human readable
reference for the entry. It is implementation defined whether this value is
used.
@ -1323,7 +1323,7 @@ To view their current state use \texttt{pmset -g} command in Terminal.
\item
\texttt{Comment}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Arbitrary ASCII string used to provide human readable
reference for the entry. It is implementation defined whether this value is
used.
@ -1351,7 +1351,7 @@ To view their current state use \texttt{pmset -g} command in Terminal.
\item
\texttt{Identifier}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: \texttt{Apple} for macOS booter (generally \texttt{boot.efi});
or a name with suffix (e.g. \texttt{bootmgfw.efi}) for a specific booter;
or \texttt{Any} / empty string (failsafe) to match any booter.
@ -1928,14 +1928,14 @@ blocking.
\item
\texttt{BundlePath}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Kext bundle path (e.g. \texttt{Lilu.kext}
or \texttt{MyKext.kext/Contents/PlugIns/MySubKext.kext}).
\item
\texttt{Comment}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Arbitrary ASCII string used to provide human readable
reference for the entry. It is implementation defined whether this value is
used.
@ -1950,14 +1950,14 @@ blocking.
\item
\texttt{ExecutablePath}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Kext executable path relative to bundle
(e.g. \texttt{Contents/MacOS/Lilu}).
\item
\texttt{MaxKernel}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Adds kernel driver on specified macOS version or older.
\hypertarget{kernmatch}Kernel version can be obtained with \texttt{uname -r} command,
@ -2000,7 +2000,7 @@ blocking.
\item
\texttt{MinKernel}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Adds kernel driver on specified macOS version or newer.
\emph{Note}: Refer to \hyperlink{kernmatch}{\texttt{Add} \texttt{MaxKernel} description} for matching logic.
@ -2008,7 +2008,7 @@ blocking.
\item
\texttt{PlistPath}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Kext \texttt{Info.plist} path relative to bundle
(e.g. \texttt{Contents/Info.plist}).
@ -2026,7 +2026,7 @@ blocking.
\item
\texttt{Comment}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Arbitrary ASCII string used to provide human readable
reference for the entry. It is implementation defined whether this value is
used.
@ -2041,14 +2041,14 @@ blocking.
\item
\texttt{Identifier}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Kext bundle identifier
(e.g. \texttt{com.apple.driver.AppleTyMCEDriver}).
\item
\texttt{MaxKernel}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Blocks kernel driver on specified macOS version or older.
\emph{Note}: Refer to \hyperlink{kernmatch}{\texttt{Add} \texttt{MaxKernel} description} for matching logic.
@ -2056,7 +2056,7 @@ blocking.
\item
\texttt{MinKernel}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Blocks kernel driver on specified macOS version or newer.
\emph{Note}: Refer to \hyperlink{kernmatch}{\texttt{Add} \texttt{MaxKernel} description} for matching logic.
@ -2142,7 +2142,7 @@ blocking.
\item
\texttt{MaxKernel}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Emulates CPUID and applies \texttt{DummyPowerManagement} on specified macOS version or older.
\emph{Note}: Refer to \hyperlink{kernmatch}{\texttt{Add} \texttt{MaxKernel} description} for matching logic.
@ -2150,7 +2150,7 @@ blocking.
\item
\texttt{MinKernel}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Emulates CPUID and applies \texttt{DummyPowerManagement} on specified macOS version or newer.
\emph{Note}: Refer to \hyperlink{kernmatch}{\texttt{Add} \texttt{MaxKernel} description} for matching logic.
@ -2169,14 +2169,14 @@ blocking.
\item
\texttt{BundlePath}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Kext bundle path (e.g.
\texttt{System\textbackslash Library \textbackslash Extensions \textbackslash IONetworkingFamily.kext}).
\item
\texttt{Comment}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Arbitrary ASCII string used to provide human readable
reference for the entry. It is implementation defined whether this value is
used.
@ -2191,14 +2191,14 @@ blocking.
\item
\texttt{ExecutablePath}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Kext executable path relative to bundle
(e.g. \texttt{Contents/MacOS/IONetworkingFamily}).
\item
\texttt{Identifier}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Kext identifier to perform presence checking
before adding (e.g. \texttt{com.apple.iokit.IONetworkingFamily}).
Only drivers which identifiers are not be found in the cache will be added.
@ -2206,7 +2206,7 @@ blocking.
\item
\texttt{MaxKernel}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Adds kernel driver on specified macOS version or older.
\emph{Note}: Refer to \hyperlink{kernmatch}{\texttt{Add} \texttt{Add MaxKernel} description} for matching logic.
@ -2214,7 +2214,7 @@ blocking.
\item
\texttt{MinKernel}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Adds kernel driver on specified macOS version or newer.
\emph{Note}: Refer to \hyperlink{kernmatch}{\texttt{Add} \texttt{Add MaxKernel} description} for matching logic.
@ -2222,7 +2222,7 @@ blocking.
\item
\texttt{PlistPath}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Kext \texttt{Info.plist} path relative to bundle
(e.g. \texttt{Contents/Info.plist}).
@ -2241,15 +2241,15 @@ blocking.
\item
\texttt{Base}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Selects symbol-matched base for patch lookup (or immediate
replacement) by obtaining the address of provided symbol name. Can be set to
empty string to be ignored.
replacement) by obtaining the address of provided symbol name. Set to an empty string
to ignore.
\item
\texttt{Comment}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Arbitrary ASCII string used to provide human readable
reference for the entry. It is implementation defined whether this value is
used.
@ -2279,7 +2279,7 @@ blocking.
\item
\texttt{Identifier}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Kext bundle identifier (e.g. \texttt{com.apple.driver.AppleHDA})
or \texttt{kernel} for kernel patch.
@ -2302,7 +2302,7 @@ blocking.
\item
\texttt{MaxKernel}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Patches data on specified macOS version or older.
\emph{Note}: Refer to \hyperlink{kernmatch}{\texttt{Add} \texttt{MaxKernel} description} for matching logic.
@ -2310,7 +2310,7 @@ blocking.
\item
\texttt{MinKernel}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Patches data on specified macOS version or newer.
\emph{Note}: Refer to \hyperlink{kernmatch}{\texttt{Add} \texttt{MaxKernel} description} for matching logic.
@ -3968,7 +3968,7 @@ rm vault.pub
\item
\texttt{Arguments}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Arbitrary ASCII string used as boot arguments (load options)
of the specified entry.
@ -3982,7 +3982,7 @@ rm vault.pub
\item
\texttt{Comment}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Arbitrary ASCII string used to provide human readable
reference for the entry. It is implementation defined whether this value is
used.
@ -3997,13 +3997,13 @@ rm vault.pub
\item
\texttt{Name}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Human readable entry name displayed in boot picker.
\item
\texttt{Path}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Entry location depending on entry type.
\begin{itemize}
@ -4777,27 +4777,27 @@ be used. Version with macOS specific enhancements can be downloaded from
\item
\texttt{SystemProductName}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified or not installed\\
\textbf{Failsafe}: Empty (OEM specified or not installed)\\
\textbf{Description}: Refer to SMBIOS \texttt{SystemProductName}.
\item
\texttt{SystemSerialNumber}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified or not installed\\
\textbf{Failsafe}: Empty (OEM specified or not installed)\\
\textbf{Description}: Refer to SMBIOS \texttt{SystemSerialNumber}.
\item
\texttt{SystemUUID}\\
\textbf{Type}: \texttt{plist\ string}, GUID\\
\textbf{Failsafe}: OEM specified or not installed\\
\textbf{Failsafe}: Empty (OEM specified or not installed)\\
\textbf{Description}: Refer to SMBIOS \texttt{SystemUUID}.
\item
\texttt{MLB}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified or not installed\\
\textbf{Failsafe}: Empty (OEM specified or not installed)\\
\textbf{Description}: Refer to SMBIOS \texttt{BoardSerialNumber}.
\item
\texttt{ROM}\\
\textbf{Type}: \texttt{plist\ data}, 6 bytes\\
\textbf{Failsafe}: OEM specified or not installed\\
\textbf{Failsafe}: Empty (OEM specified or not installed)\\
\textbf{Description}: Refer to
\texttt{4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:ROM}.
@ -4809,35 +4809,35 @@ be used. Version with macOS specific enhancements can be downloaded from
\item
\texttt{PlatformName}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: Sets \texttt{name} in
\texttt{gEfiMiscSubClassGuid}. Value found on Macs is
\texttt{platform} in ASCII.
\item
\texttt{SystemProductName}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: Sets \texttt{Model} in
\texttt{gEfiMiscSubClassGuid}. Value found on Macs is equal to SMBIOS
\texttt{SystemProductName} in Unicode.
\item
\texttt{SystemSerialNumber}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: Sets \texttt{SystemSerialNumber} in
\texttt{gEfiMiscSubClassGuid}. Value found on Macs is equal to SMBIOS
\texttt{SystemSerialNumber} in Unicode.
\item
\texttt{SystemUUID}\\
\textbf{Type}: \texttt{plist\ string}, GUID\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: Sets \texttt{system-id} in
\texttt{gEfiMiscSubClassGuid}. Value found on Macs is equal to SMBIOS
\texttt{SystemUUID} (with swapped byte order).
\item
\texttt{BoardProduct}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: Sets \texttt{board-id} in
\texttt{gEfiMiscSubClassGuid}. Value found on Macs is equal to SMBIOS
\texttt{BoardProduct} in ASCII.
@ -4941,7 +4941,7 @@ be used. Version with macOS specific enhancements can be downloaded from
\item
\texttt{DevicePathsSupported}\\
\textbf{Type}: \texttt{plist\ integer}, 32-bit\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: 0 (Not installed)\\
\textbf{Description}: Sets \texttt{DevicePathsSupported} in
\texttt{gEfiMiscSubClassGuid}. Must be set to \texttt{1} for
AppleACPIPlatform.kext to append SATA device paths to
@ -4950,7 +4950,7 @@ be used. Version with macOS specific enhancements can be downloaded from
\item
\texttt{SmcRevision}\\
\textbf{Type}: \texttt{plist\ data}, 6 bytes\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: Sets \texttt{REV} in
\texttt{gEfiMiscSubClassGuid}. Custom property read by
\texttt{VirtualSMC} or \texttt{FakeSMC} to generate SMC \texttt{REV}
@ -4958,7 +4958,7 @@ be used. Version with macOS specific enhancements can be downloaded from
\item
\texttt{SmcBranch}\\
\textbf{Type}: \texttt{plist\ data}, 8 bytes\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: Sets \texttt{RBr} in
\texttt{gEfiMiscSubClassGuid}. Custom property read by
\texttt{VirtualSMC} or \texttt{FakeSMC} to generate SMC \texttt{RBr}
@ -4966,7 +4966,7 @@ be used. Version with macOS specific enhancements can be downloaded from
\item
\texttt{SmcPlatform}\\
\textbf{Type}: \texttt{plist\ data}, 8 bytes\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: Sets \texttt{RPlt} in
\texttt{gEfiMiscSubClassGuid}. Custom property read by
\texttt{VirtualSMC} or \texttt{FakeSMC} to generate SMC \texttt{RPlt}
@ -5196,14 +5196,14 @@ be used. Version with macOS specific enhancements can be downloaded from
\item
\texttt{BID}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: Specifies the value of NVRAM variable
\texttt{4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:HW\_BID}.
\item
\texttt{ROM}\\
\textbf{Type}: \texttt{plist\ data}, 6 bytes\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: Specifies the values of NVRAM variables
\texttt{4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:HW\_ROM} and
\texttt{4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:ROM}.
@ -5211,7 +5211,7 @@ be used. Version with macOS specific enhancements can be downloaded from
\item
\texttt{MLB}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: Specifies the values of NVRAM variables
\texttt{4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:HW\_MLB} and
\texttt{4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:MLB}.
@ -5219,7 +5219,7 @@ be used. Version with macOS specific enhancements can be downloaded from
\item
\texttt{FirmwareFeatures}\\
\textbf{Type}: \texttt{plist\ data}, 8 bytes\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: This variable comes in pair with \texttt{FirmwareFeaturesMask}.
Specifies the values of NVRAM variables:
\begin{itemize}
@ -5231,7 +5231,7 @@ be used. Version with macOS specific enhancements can be downloaded from
\item
\texttt{FirmwareFeaturesMask}\\
\textbf{Type}: \texttt{plist\ data}, 8 bytes\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: This variable comes in pair with \texttt{FirmwareFeatures}.
Specifies the values of NVRAM variables:
\begin{itemize}
@ -5243,7 +5243,7 @@ be used. Version with macOS specific enhancements can be downloaded from
\item
\texttt{SystemUUID}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Not installed\\
\textbf{Failsafe}: Empty (Not installed)\\
\textbf{Description}: Specifies the value of NVRAM variable
\texttt{4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14:system-id}
for boot services only. Value found on Macs is equal to SMBIOS
@ -5257,14 +5257,14 @@ be used. Version with macOS specific enhancements can be downloaded from
\item
\texttt{BIOSVendor}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: BIOS Information (Type 0) --- Vendor\\
\textbf{Description}: BIOS Vendor. All rules of
\texttt{SystemManufacturer} do apply.
\item
\texttt{BIOSVersion}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: BIOS Information (Type 0) --- BIOS Version\\
\textbf{Description}: Firmware version. This value gets updated and
takes part in update delivery configuration and macOS version
@ -5294,14 +5294,14 @@ Apple ROM Version
\item
\texttt{BIOSReleaseDate}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: BIOS Information (Type 0) --- BIOS Release Date\\
\textbf{Description}: Firmware release date. Similar to
\texttt{BIOSVersion}. May look like \texttt{12/08/2017}.
\item
\texttt{SystemManufacturer}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: System Information (Type 1) --- Manufacturer\\
\textbf{Description}: OEM manufacturer of the particular board. Shall
not be specified unless strictly required. Should \emph{not} contain
@ -5313,7 +5313,7 @@ Apple ROM Version
\item
\texttt{SystemProductName}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: System Information (Type 1), Product Name\\
\textbf{Description}: Preferred Mac model used to mark the device as
supported by the operating system. This value must be specified by any
@ -5330,14 +5330,14 @@ Apple ROM Version
\item
\texttt{SystemVersion}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: System Information (Type 1) --- Version\\
\textbf{Description}: Product iteration version number. May look like
\texttt{1.1}.
\item
\texttt{SystemSerialNumber}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: System Information (Type 1) --- Serial Number\\
\textbf{Description}: Product serial number in defined format. Known
formats are described in
@ -5345,7 +5345,7 @@ Apple ROM Version
\item
\texttt{SystemUUID}\\
\textbf{Type}: \texttt{plist\ string}, GUID\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: System Information (Type 1) --- UUID\\
\textbf{Description}: A UUID is an identifier that is designed to be
unique across both time and space. It requires no central registration
@ -5353,7 +5353,7 @@ Apple ROM Version
\item
\texttt{SystemSKUNumber}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: System Information (Type 1) --- SKU Number\\
\textbf{Description}: Mac Board ID (\texttt{board-id}). May look like
\texttt{Mac-7BA5B2D9E42DDD94} or \texttt{Mac-F221BEC8} in older
@ -5361,13 +5361,13 @@ Apple ROM Version
\item
\texttt{SystemFamily}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: System Information (Type 1) --- Family\\
\textbf{Description}: Family name. May look like \texttt{iMac\ Pro}.
\item
\texttt{BoardManufacturer}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: Baseboard (or Module) Information (Type 2) -
Manufacturer\\
\textbf{Description}: Board manufacturer. All rules of
@ -5375,7 +5375,7 @@ Apple ROM Version
\item
\texttt{BoardProduct}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: Baseboard (or Module) Information (Type 2) -
Product\\
\textbf{Description}: Mac Board ID (\texttt{board-id}). May look like
@ -5384,7 +5384,7 @@ Apple ROM Version
\item
\texttt{BoardVersion}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: Baseboard (or Module) Information (Type 2) -
Version\\
\textbf{Description}: Board version number. Varies, may match
@ -5392,7 +5392,7 @@ Apple ROM Version
\item
\texttt{BoardSerialNumber}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: Baseboard (or Module) Information (Type 2) --- Serial
Number\\
\textbf{Description}: Board serial number in defined format. Known
@ -5401,7 +5401,7 @@ Apple ROM Version
\item
\texttt{BoardAssetTag}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: Baseboard (or Module) Information (Type 2) --- Asset
Tag\\
\textbf{Description}: Asset tag number. Varies, may be empty or
@ -5409,7 +5409,7 @@ Apple ROM Version
\item
\texttt{BoardType}\\
\textbf{Type}: \texttt{plist\ integer}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: 0 (OEM specified)\\
\textbf{SMBIOS}: Baseboard (or Module) Information (Type 2) --- Board
Type\\
\textbf{Description}: Either \texttt{0xA} (Motherboard (includes
@ -5418,7 +5418,7 @@ Apple ROM Version
\item
\texttt{BoardLocationInChassis}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: Baseboard (or Module) Information (Type 2) --- Location
in Chassis\\
\textbf{Description}: Varies, may be empty or
@ -5426,33 +5426,33 @@ Apple ROM Version
\item
\texttt{ChassisManufacturer}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: System Enclosure or Chassis (Type 3) --- Manufacturer\\
\textbf{Description}: Board manufacturer. All rules of
\texttt{SystemManufacturer} do apply.
\item
\texttt{ChassisType}\\
\textbf{Type}: \texttt{plist\ integer}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: 0 (OEM specified)\\
\textbf{SMBIOS}: System Enclosure or Chassis (Type 3) --- Type\\
\textbf{Description}: Chassis type, refer to Table 17 --- System
Enclosure or Chassis Types for more details.
\item
\texttt{ChassisVersion}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: System Enclosure or Chassis (Type 3) --- Version\\
\textbf{Description}: Should match \texttt{BoardProduct}.
\item
\texttt{ChassisSerialNumber}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: System Enclosure or Chassis (Type 3) --- Version\\
\textbf{Description}: Should match \texttt{SystemSerialNumber}.
\item
\texttt{ChassisAssetTag}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: OEM specified\\
\textbf{Failsafe}: Empty (OEM specified)\\
\textbf{SMBIOS}: System Enclosure or Chassis (Type 3) --- Asset Tag
Number\\
\textbf{Description}: Chassis type name. Varies, could be empty or
@ -5998,7 +5998,7 @@ functioning. Feature highlights:
\item
\texttt{AudioDevice}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Device path of the specified audio controller for audio support.
Normally this contains builtin analog audio controller (\texttt{HDEF}) device path,
@ -6208,7 +6208,7 @@ functioning. Feature highlights:
\item
\texttt{PointerSupportMode}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Set OEM protocol used for internal pointer driver.
Currently the only supported variant is \texttt{ASUS}, using specialised protocol available
@ -6298,21 +6298,20 @@ functioning. Feature highlights:
\item
\texttt{ConsoleMode}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Sets console output mode as specified
with the \texttt{WxH} (e.g. \texttt{80x24}) formatted string.
Set to empty string not to change console mode. Set to \texttt{Max}
to try to use largest available console mode. Currently
\texttt{Builtin} text renderer supports only one console mode, so
this option is ignored.
Set to an empty string to maintain current console mode. Set to \texttt{Max}
to attempt using the largest available console mode. This option is currently
ignored as the \texttt{Builtin} text renderer only supports one console mode.
\emph{Note}: This field is best left empty on most types of firmware.
\item
\texttt{Resolution}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Sets console output screen resolution.
\begin{itemize}
@ -6320,8 +6319,8 @@ functioning. Feature highlights:
\item Set to \texttt{WxH@Bpp} (e.g. \texttt{1920x1080@32}) or \texttt{WxH}
(e.g. \texttt{1920x1080}) formatted string to request custom resolution
from GOP if available.
\item Set to empty string not to change screen resolution.
\item Set to \texttt{Max} to try to use largest available screen resolution.
\item Set to an empty string to maintain the current screen resolution.
\item Set to \texttt{Max} to attempt using the largest available screen resolution.
\end{itemize}
On HiDPI screens \texttt{APPLE\_VENDOR\_VARIABLE\_GUID} \texttt{UIScale}
@ -6430,7 +6429,7 @@ functioning. Feature highlights:
\emph{Note}: This option only applies to \texttt{System} renderer.
On all known affected systems \texttt{ConsoleMode} had to be set to
empty string for this to work.
an empty string for this to work.
\item
\texttt{UgaPassThrough}\\
@ -6754,7 +6753,7 @@ functioning. Feature highlights:
\item
\texttt{Comment}\\
\textbf{Type}: \texttt{plist\ string}\\
\textbf{Failsafe}: Empty string\\
\textbf{Failsafe}: Empty\\
\textbf{Description}: Arbitrary ASCII string used to provide human readable
reference for the entry. It is implementation defined whether this value is
used.