Kaby Lake và Amber Lake

• AvoidRuntimeDefrag: YES

  • Fixes UEFI runtime services like date, time, NVRAM, power control, etc

• EnableSafeModeSlide: YES

  • Enables slide variables to be used in safe mode.

• EnableWriteUnprotector: YES

  • Needed to remove write protection from CR0 register.

• ProtectMemoryRegions: YES

  • Patches memory region types for incorrectly mapped CSM/MMIO regions. Necessary for all Chromebooks that utilize coreboot UEFI firmware.

• ProvideCustomSlide: YES

  • Used for Slide variable calculation. However the necessity of this quirk is determined by OCABC: Only N/256 slide values are usable! message in the debug log. If the message OCABC: All slides are usable! You can disable ProvideCustomSlide! is present in your log, you can disable ProvideCustomSlide.

• SetupVirtualMap: YES

  • Fixes SetVirtualAddresses calls to virtual addresses, required for Gigabyte boards to resolve early kernel panics

Let's take in consideration these 2 usual framebuffers:

• 00001B59 which has the following BusID information:

  Copy

  [0] busId: 0x00, pipe: 8, type: 0x00000002, flags: 0x00000098 - ConnectorLVDS
  [2] busId: 0x04, pipe: 10, type: 0x00000800, flags: 0x00000187 - ConnectorHDMI
  [3] busId: 0x06, pipe: 10, type: 0x00000400, flags: 0x00000187 - ConnectorDP
  00000800 02000000 98000000
  02040A00 00080000 87010000
  03060A00 00040000 87010000

• and 00001659 which has the following BusID information:

  Copy

  [0] busId: 0x00, pipe: 8, type: 0x00000002, flags: 0x00000098 - ConnectorLVDS
  [1] busId: 0x05, pipe: 9, type: 0x00000400, flags: 0x00000187 - ConnectorDP
  [2] busId: 0x04, pipe: 10, type: 0x00000800, flags: 0x00000187 - ConnectorHDMI
  00000800 02000000 98000000
  01050900 00040000 87010000
  02040A00 00080000 87010000

Which look similar at first glance, until you see the small details like the Port ID (the first 2 digits of each hex line). Both of the framebuffers are valid, but not all OEMs ship the same port configuration on all laptops (some have eDP for internal display, some have HDMI instead of DP ports, some have VGA and so on...).

For either framebuffer, the first port (port 00) is ConnectorLVDS (meaning the internal display), which is the same on both configurations, that's how you get a display out for macOS. The differences come to the 2 other ports:

• 00001B59

02040A00 00080000 87010000 -->
[2] busId: 0x04, pipe: 10, type: 0x00000800, flags: 0x00000187 - ConnectorHDMI

03060A00 00040000 87010000 -->
[3] busId: 0x06, pipe: 10, type: 0x00000400, flags: 0x00000187 - ConnectorDP

• 00001659

01050900 00040000 87010000 -->
[1] busId: 0x05, pipe: 9, type: 0x00000400, flags: 0x00000187 - ConnectorDP

02040A00 00080000 87010000 -->
[2] busId: 0x04, pipe: 10, type: 0x00000800, flags: 0x00000187 - ConnectorHDMI

The patches above have these effects:

• Patchset 1:

  • Convert second connector of the ports to 0105 with HDMI connector type

  • Convert third connector of the ports to 0204 with HDMI connector type

• Patchset 2:

  • Convert second connector of the ports to 0105 with HDMI connector type

  • Convert third connector of the ports to 0306 with DP connector type

Depending on your real hardware setup, you might want to switch things up, but usually for most laptops, one of the two patches might be required, in case your outputs work out-of-the-box with no issues or crashes, you do not need these patches then.

The main thing you need to keep in mind is:

• Load order

  • Remember that any plugins should load after its dependencies

  • This means kexts like Lilu must come before VirtualSMC, AppleALC, WhateverGreen, etc

A reminder that ProperTree (opens new window)users can run Cmd/Ctrl + Shift + R to add all their kexts in the correct order without manually typing each kext out.

• Arch

  • Architectures supported by this kext

  • Currently supported values are Any, i386 (32-bit), and x86_64 (64-bit)

• BundlePath

  • Name of the kext

  • ex: Lilu.kext

• Enabled

  • Self-explanatory, either enables or disables the kext

• ExecutablePath

  • Path to the actual executable is hidden within the kext, you can see what path your kext has by right-clicking and selecting Show Package Contents. Generally, they'll be Contents/MacOS/Kext but some have kexts hidden within under Plugin folder. Do note that plist only kexts do not need this filled in.

  • ex: Contents/MacOS/Lilu

• MinKernel

  • Lowest kernel version your kext will be injected into, see below table for possible values

  • ex. 12.00.00 for OS X 10.8

• MaxKernel

  • Highest kernel version your kext will be injected into, see below table for possible values

  • ex. 11.99.99 for OS X 10.7

• PlistPath

  • Path to the info.plist hidden within the kext

  • ex: Contents/Info.plist

• AppleCpuPmCfgLock: NO

  • Only needed when CFG-Lock can't be disabled in BIOS

  • Only applicable for Ivy Bridge and older

    • Note: Broadwell and older require this when running 10.10 or older

• AppleXcpmCfgLock: YES

  • Only needed when CFG-Lock can't be disabled in BIOS

  • Only applicable for Haswell and newer

    • Note: Ivy Bridge-E is also included as it's XCPM capable

• CustomSMBIOSGuid: NO

  • Performs GUID patching for UpdateSMBIOSMode set to Custom. Usually relevant for Dell laptops

  • Enabling this quirk with UpdateSMBIOSMode Custom mode can also disable SMBIOS injection into "non-Apple" OSes however we do not endorse this method as it breaks Bootcamp compatibility. Use at your own risk

• DisableIoMapper: YES

  • Needed to get around VT-D if either unable to disable in BIOS or needed for other operating systems, much better alternative to dart=0 as SIP can stay on in Catalina

• DisableLinkeditJettison: YES

  • Allows Lilu and others to have more reliable performance without keepsyms=1

• DisableRtcChecksum: NO

  • Prevents AppleRTC from writing to primary checksum (0x58-0x59), required for users who either receive BIOS reset or are sent into Safe mode after reboot/shutdown

• ExtendBTFeatureFlags NO

  • Helpful for those having continuity issues with non-Apple/non-Fenvi cards

• LapicKernelPanic: NO

  • Disables kernel panic on AP core lapic interrupt, generally needed for HP systems. Clover equivalent is Kernel LAPIC

• LegacyCommpage: NO

  • Resolves SSSE3 requirement for 64 Bit CPUs in macOS, mainly relevant for 64-Bit Pentium 4 CPUs(ie. Prescott)

• PanicNoKextDump: YES

  • Allows for reading kernel panics logs when kernel panics occur

• PowerTimeoutKernelPanic: YES

  • Helps fix kernel panics relating to power changes with Apple drivers in macOS Catalina, most notably with digital audio.

• SetApfsTrimTimeout: -1

  • Sets trim timeout in microseconds for APFS filesystems on SSDs, only applicable for macOS 10.14 and newer with problematic SSDs.

• XhciPortLimit: YES

  • This is actually the 15 port limit patch, don't rely on it as it's not a guaranteed solution for fixing USB. Please create a USB map (opens new window)when possible.

  • With macOS 11.3+, XhciPortLimit may not function as intended. (opens new window)We recommend users either disable this quirk and map before upgrading or map from Windows (opens new window). You may also install macOS 11.2.3 or older.

The reason being is that UsbInjectAll reimplements builtin macOS functionality without proper current tuning. It is much cleaner to just describe your ports in a single plist-only kext, which will not waste runtime memory and such

• FuzzyMatch: True

  • Used for ignoring checksums with kernelcache, instead opting for the latest cache available. Can help improve boot performance on many machines in 10.6

• KernelArch: x86_64

  • Set the kernel's arch type, you can choose between Auto, i386 (32-bit), and x86_64 (64-bit).

  • If you're booting older OSes which require a 32-bit kernel(ie. 10.4 and 10.5) we recommend to set this to Auto and let macOS decide based on your SMBIOS. See below table for supported values:

    • 10.4-10.5 — x86_64, i386 or i386-user32

      • i386-user32 refers 32-bit userspace, so 32-bit CPUs must use this(or CPUs missing SSSE3)

      • x86_64 will still have a 32-bit kernelspace however will ensure 64-bit userspace in 10.4/5

    • 10.6 — i386, i386-user32, or x86_64

    • 10.7 — i386 or x86_64

    • 10.8 or newer — x86_64

• KernelCache: Auto

  • Set kernel cache type, mainly useful for debugging and so we recommend Auto for best support

• HideAuxiliary: YES

  • This option will hide supplementary entries, such as macOS recovery and tools, in the picker. Hiding auxiliary entries may increase boot performance on multi-disk systems. You can press space at the picker to show these entries

• AppleDebug: YES

  • Enables boot.efi logging, useful for debugging. Note this is only supported on 10.15.4 and newer

• ApplePanic: YES

  • Attempts to log kernel panics to disk

• DisableWatchDog: YES

  • Disables the UEFI watchdog, can help with early boot issues

• DisplayLevel: 2147483650

  • Shows even more debug information, requires debug version of OpenCore

• SysReport: NO

  • Helpful for debugging such as dumping ACPI tables

  • Note that this is limited to DEBUG versions of OpenCore

• Target: 67

  • Shows more debug information, requires debug version of OpenCore

These values are based of those calculated in OpenCore debugging

• AllowSetDefault: YES

  • Allow CTRL+Enter and CTRL+Index to set default boot device in the picker

• ApECID: 0

  • Used for netting personalized secure-boot identifiers, currently this quirk is unreliable due to a bug in the macOS installer so we highly encourage you to leave this as default.

• AuthRestart: NO

  • Enables Authenticated restart for FileVault 2 so password is not required on reboot. Can be considered a security risk so optional

• BlacklistAppleUpdate: YES

  • Used for blocking firmware updates, used as extra level of protection as macOS Big Sur no longer uses run-efi-updater variable

• DmgLoading: Signed

  • Ensures only signed DMGs load

• ExposeSensitiveData: 6

  • Shows more debug information, requires debug version of OpenCore

• Vault: Optional

  • We won't be dealing vaulting so we can ignore, you won't boot with this set to Secure

  • This is a word, it is not optional to omit this setting. You will regret it if you don't set it to Optional, note that it is case-sensitive

• ScanPolicy: 0

  • 0 allows you to see all drives available, please refer to Security (opens new window)section for further details. Will not boot USB devices with this set to default

• SecureBootModel: Default

  • Controls Apple's secure boot functionality in macOS, please refer to Security (opens new window)section for further details.

  • Note: Users may find upgrading OpenCore on an already installed system can result in early boot failures. To resolve this, see here: Stuck on OCB: LoadImage failed - Security Violation

Booter Path, mainly used for UI modification

• DefaultBackgroundColor: Background color used by boot.efi

  • 00000000: Syrah Black

  • BFBFBF00: Light Gray

• rtc-blacklist: <>

  • To be used in conjunction with RTCMemoryFixup, see here for more info: Fixing RTC write issues(opens new window)

  • Most users can ignore this section

• AdviseFeatures: NO

  • Used for when the EFI partition isn't first on the Windows drive

• MaxBIOSVersion: NO

  • Sets BIOS version to Max to avoid firmware updates in Big Sur+, mainly applicable for genuine Macs.

• ProcessorType: 0

  • Set to 0 for automatic type detection, however this value can be overridden if desired. See AppleSmBios.h (opens new window)for possible values

• SpoofVendor: YES

  • Swaps vendor field for Acidanthera, generally not safe to use Apple as a vendor in most case

• SystemMemoryStatus: Auto

  • Sets whether memory is soldered or not in SMBIOS info, purely cosmetic and so we recommend Auto

• UpdateDataHub: YES

  • Update Data Hub fields

• UpdateNVRAM: YES

  • Update NVRAM fields

• UpdateSMBIOS: YES

  • Updates SMBIOS fields

• UpdateSMBIOSMode: Create

  • Replace the tables with newly allocated EfiReservedMemoryType, use Custom on Dell laptops requiring CustomSMBIOSGuid quirk

  • Setting to Custom with CustomSMBIOSGuid quirk enabled can also disable SMBIOS injection into "non-Apple" OSes however we do not endorse this method as it breaks Bootcamp compatibility. Use at your own risk

• ReleaseUsbOwnership: YES

  • Releases USB controller from firmware driver, needed for when your firmware doesn't support EHCI/XHCI Handoff. Most laptops have garbage firmwares so we'll need this as well

• DisableSecurityPolicy: NO

  • Disables platform security policy in firmware, recommended for buggy firmwares where disabling Secure Boot does not allow 3rd party firmware drivers to load.

  • If running a Microsoft Surface device, recommended to enable this option

• RequestBootVarRouting: YES

  • Redirects AptioMemoryFix from EFI_GLOBAL_VARIABLE_GUID to OC_VENDOR_VARIABLE_GUID. Needed for when firmware tries to delete boot entries and is recommended to be enabled on all systems for correct update installation, Startup Disk control panel functioning, etc.

• UnblockFsConnect: NO

  • Some firmware block partition handles by opening them in By Driver mode, which results in File System protocols being unable to install. Mainly relevant for HP systems when no drives are listed