Skip to content

Latest commit

 

History

History
879 lines (598 loc) · 38.2 KB

kaby-lake.md

File metadata and controls

879 lines (598 loc) · 38.2 KB
Raw

Laptop Kaby Lake & Amber Lake Y

Support Version
Initial macOS Support macOS 10.12, Sierra

Starting Point

So making a config.plist may seem hard, it's not. It just takes some time but this guide will tell you how to configure everything, you won't be left in the cold. This also means if you have issues, review your config settings to make sure they're correct. Main things to note with OpenCore:

  • All properties must be defined, there are no default OpenCore will fall back on so do not delete sections unless told explicitly so. If the guide doesn't mention the option, leave it at default.
  • The Sample.plist cannot be used As-Is, you must configure it to your system
  • DO NOT USE CONFIGURATORS, these rarely respect OpenCore's configuration and even some like Mackie's will add Clover properties and corrupt plists!

Now with all that, a quick reminder of the tools we need

::: warning

Read this guide more than once before setting up OpenCore and make sure you have it set up correctly. Do note that images will not always be the most up-to-date so please read the text below them, if nothing's mentioned then leave as default.

:::

ACPI

ACPI

Add

::: tip Info

This is where you'll add SSDTs for your system, these are very important to booting macOS and have many uses like USB maps, disabling unsupported GPUs and such. And with our system, it's even required to boot. Guide on making them found here: Getting started with ACPI

For us we'll need a couple of SSDTs to bring back functionality that Clover provided:

Required SSDTs Description
SSDT-PLUG Allows for native CPU power management on Haswell and newer, see Getting Started With ACPI Guide for more details.
SSDT-EC-USBX Fixes both the embedded controller and USB power, see Getting Started With ACPI Guide for more details.
SSDT-GPIO Creates a stub so VoodooI2C can connect, for those having troubles getting VoodooI2C working can try SSDT-XOSI instead. Note that Intel NUCs do not need this
SSDT-PNLF Fixes brightness control, see Getting Started With ACPI Guide for more details. Note that Intel NUCs do not need this

Note that you should not add your generated DSDT.aml here, it is already in your firmware. So if present, remove the entry for it in your config.plist and under EFI/OC/ACPI.

For those wanting a deeper dive into dumping your DSDT, how to make these SSDTs, and compiling them, please see the Getting started with ACPI page. Compiled SSDTs have a .aml extension(Assembled) and will go into the EFI/OC/ACPI folder and must be specified in your config under ACPI -> Add as well.

:::

Delete

This blocks certain ACPI tables from loading, for us we can ignore this.

Patch

::: tip Info

This section allows us to dynamically modify parts of the ACPI (DSDT, SSDT, etc.) via OpenCore. For us, we'll need the following:

  • OSI rename
    • This is required when using SSDT-XOSI as we redirect all OSI calls to this SSDT, this is not needed if you're using SSDT-GPIO
Comment String Change _OSI to XOSI
Enabled Boolean YES
Count Number 0
Limit Number 0
Find Data 5f4f5349
Replace Data 584f5349

:::

Quirks

Settings relating to ACPI, leave everything here as default as we have no use for these quirks.

Booter

Booter

This section is dedicated to quirks relating to boot.efi patching with OpenRuntime, the replacement for AptioMemoryFix.efi

MmioWhitelist

This section is allowing spaces to be pass-through to macOS that are generally ignored, useful when paired with DevirtualiseMmio

Quirks

::: tip Info

Settings relating to boot.efi patching and firmware fixes. For most users, leave it as default.

  • ProtectMemoryRegions: YES
    • Fixes shutdown/restart on some Chromebooks that would otherwise result in a AppleEFINVRAM kernel panic.

::: ::: details More in-depth Info

  • 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

:::

DeviceProperties

DeviceProperties

Add

Sets device properties from a map.

::: tip PciRoot(0x0)/Pci(0x2,0x0)

This section is set up via WhateverGreen's Framebuffer Patching Guide and is used for setting important iGPU properties.

The config.plist doesn't already have a section for this so you will have to create it manually.

When setting up your iGPU, the table below should help with finding the right values to set. Here is an explanation of some values:

  • AAPL,ig-platform-id
    • This is used internally for setting up the iGPU
  • Type
    • Whether the entry is recommended for laptops (ie. with built-in displays) or for Intel NUCs (ie. standalone boxes)

Generally follow these steps when setting up your iGPU properties. Follow the configuration notes below the table if they say anything different:

  1. When initially setting up your config.plist, only set AAPL,ig-platform-id - this is normally enough
  2. If you boot and you get no graphics acceleration (7MB VRAM and solid background for dock), then you likely need to try different AAPL,ig-platform-id values, add stolenmem patches, or even add a device-id property.
AAPL,ig-platform-id Type Comment
00001B59 Laptop Recommended for HD 615, HD 620, HD 630, HD 640 and HD 650
00001659 Laptop Alternative value to 00001B59 if you have acceleration issues, and recommended for all HD and UHD 620 NUCs
0000C087 Laptop Recommended for Amber Lake's UHD 617 and Kaby Lake-R's UHD 620
00001E59 NUC Recommended for HD 615
00001B59 NUC Recommended for HD 630
02002659 NUC Recommended for HD 640/650

Configuration Notes

  • In some cases where you cannot set the DVMT-prealloc of these cards to 64MB or higher in your UEFI Setup, you may get a kernel panic. Usually they're configured for 32MB of DVMT-prealloc, in that case add these values to the iGPU properties:
Key Type Value
framebuffer-patch-enable Data 01000000
framebuffer-stolenmem Data 00003001
framebuffer-fbmem Data 00009000
  • For all UHD 620 users (Kaby Lake-R), you'll need a device-id spoof:
Key Type Value
device-id Data 16590000
  • HD 6xx users (UHD 6xx users are not concerned) may have some issues with output where plugging in a display out would cause a lock up (kernel panic); here are some patches to mitigate that (credit RehabMan). If you're having these lock ups, try the following sets of patches (try both, but only one set at a time):

    • con1 as 105, con2 as 204, both HDMI

      Key Type Value
      framebuffer-con1-enable Data 01000000
      framebuffer-con1-alldata Data 01050A00 00080000 87010000
      framebuffer-con2-enable Data 01000000
      framebuffer-con2-alldata Data 02040A00 00080000 87010000

    • con1 as 105, con2 as 306, HDMI and DP

      Key Type Value
      framebuffer-con1-enable Data 01000000
      framebuffer-con1-alldata Data 01050A00 00080000 87010000
      framebuffer-con2-enable Data 01000000
      framebuffer-con2-alldata Data 03060A00 00040000 87010000

::: details Explanation

Let's take in consideration these 2 usual framebuffers:

  • 00001B59 which has the following BusID information:

    [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:

    [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.

::: details How to read the BusID

The bits in the hex string are read as following:

(taking 01050900 00040000 87010000 as example)

Bit Name Value
Bit 1 Port 01
Bit 2 Bus ID 05
Bit 3-4 Pipe Number 0900
Bit 5-8 Connector Type 00040000
Bit 9-12 Flags 87010000

:::

::: tip PciRoot(0x0)/Pci(0x1b,0x0)

layout-id

  • Applies AppleALC audio injection, you'll need to do your own research on which codec your motherboard has and match it with AppleALC's layout. AppleALC Supported Codecs.
  • You can delete this property outright as it's unused for us at this time

For us, we'll be using the boot argument alcid=xxx instead to accomplish this. alcid will override all other layout-IDs present. More info on this is covered in the Post-Install Page

:::

Delete

Removes device properties from the map, for us we can ignore this

Kernel

Kernel

Add

Here's where we specify which kexts to load, in what specific order to load, and what architectures each kext is meant for. By default we recommend leaving what ProperTree has done, however for 32-bit CPUs please see below:

::: details More in-depth Info

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 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

::: details Kernel Support Table

OS X Version MinKernel MaxKernel
10.4 8.0.0 8.99.99
10.5 9.0.0 9.99.99
10.6 10.0.0 10.99.99
10.7 11.0.0 11.99.99
10.8 12.0.0 12.99.99
10.9 13.0.0 13.99.99
10.10 14.0.0 14.99.99
10.11 15.0.0 15.99.99
10.12 16.0.0 16.99.99
10.13 17.0.0 17.99.99
10.14 18.0.0 18.99.99
10.15 19.0.0 19.99.99
11 20.0.0 20.99.99
12 21.0.0 21.99.99
13 22.0.0 22.99.99

:::

Emulate

Needed for spoofing unsupported CPUs like Pentiums and Celerons

  • Cpuid1Mask: Leave this blank
  • Cpuid1Data: Leave this blank

Force

Used for loading kexts off system volume, only relevant for older operating systems where certain kexts are not present in the cache(ie. IONetworkingFamily in 10.6).

For us, we can ignore.

Block

Blocks certain kexts from loading. Not relevant for us.

Patch

Patches both the kernel and kexts.

Quirks

::: tip Info

Settings relating to the kernel, for us we'll be enabling the following:

Quirk Enabled Comment
AppleXcpmCfgLock YES Not needed if CFG-Lock is disabled in the BIOS
DisableIoMapper YES Not needed if VT-D is disabled in the BIOS
LapicKernelPanic NO HP Machines will require this quirk
PanicNoKextDump YES
PowerTimeoutKernelPanic YES
XhciPortLimit YES Disable if running macOS 11.3+

:::

::: details More in-depth Info

  • 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 when possible.
    • With macOS 11.3+, XhciPortLimit may not function as intended. We recommend users either disable this quirk and map before upgrading or map from Windows. 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

:::

Scheme

Settings related to legacy booting(ie. 10.4-10.6), for majority you can skip however for those planning to boot legacy OSes you can see below:

::: details More in-depth Info

  • 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

:::

Misc

Misc

Boot

::: tip Info

Quirk Enabled Comment
HideAuxiliary YES Press space to show macOS recovery and other auxiliary entries

:::

::: details More in-depth Info

  • 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

:::

Debug

::: tip Info

Helpful for debugging OpenCore boot issues(We'll be changing everything but DisplayDelay):

Quirk Enabled
AppleDebug YES
ApplePanic YES
DisableWatchDog YES
Target 67

:::

::: details More in-depth Info

  • 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

:::

Security

::: tip Info

Security is pretty self-explanatory, do not skip. We'll be changing the following:

Quirk Enabled Comment
AllowSetDefault YES
BlacklistAppleUpdate YES
ScanPolicy 0
SecureBootModel Default Leave this as Default for OpenCore to automatically set the correct value corresponding to your SMBIOS. The next page goes into more detail about this setting.
Vault Optional 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

:::

::: details More in-depth Info

  • 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 section for further details. Will not boot USB devices with this set to default

  • SecureBootModel: Default

:::

Serial

Used for serial debugging (Leave everything as default).

Tools

Used for running OC debugging tools like the shell, ProperTree's snapshot function will add these for you.

Entries

Used for specifying irregular boot paths that can't be found naturally with OpenCore.

Won't be covered here, see 8.6 of Configuration.pdf for more info

NVRAM

NVRAM

Add

::: tip 4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14

Used for OpenCore's UI scaling, default will work for us. See in-depth section for more info

:::

::: details More in-depth Info

Booter Path, mainly used for UI modification

  • DefaultBackgroundColor: Background color used by boot.efi
    • 00000000: Syrah Black
    • BFBFBF00: Light Gray

:::

::: tip 4D1FDA02-38C7-4A6A-9CC6-4BCCA8B30102

OpenCore's NVRAM GUID, mainly relevant for RTCMemoryFixup users

:::

::: details More in-depth Info

  • rtc-blacklist: <>
    • To be used in conjunction with RTCMemoryFixup, see here for more info: Fixing RTC write issues
    • Most users can ignore this section

:::

::: tip 7C436110-AB2A-4BBB-A880-FE41995C9F82

System Integrity Protection bitmask

  • General Purpose boot-args:
boot-args Description
-v This enables verbose mode, which shows all the behind-the-scenes text that scrolls by as you're booting instead of the Apple logo and progress bar. It's invaluable to any Hackintosher, as it gives you an inside look at the boot process, and can help you identify issues, problem kexts, etc.
debug=0x100 This disables macOS's watchdog which helps prevents a reboot on a kernel panic. That way you can hopefully glean some useful info and follow the breadcrumbs to get past the issues.
keepsyms=1 This is a companion setting to debug=0x100 that tells the OS to also print the symbols on a kernel panic. That can give some more helpful insight as to what's causing the panic itself.
alcid=1 Used for setting layout-id for AppleALC, see supported codecs to figure out which layout to use for your specific system. More info on this is covered in the Post-Install Page
  • GPU-Specific boot-args:
boot-args Description
-wegnoegpu Used for disabling all other GPUs than the integrated Intel iGPU, useful for those wanting to run newer versions of macOS where their dGPU isn't supported
-igfxnotelemetryload Prevents iGPU telemetry from loading. iGPU telemetry may cause a freeze during startup on certain laptops such as Chromebooks on macOS 10.15 and higher, see here for more information.

  • csr-active-config: 00000000

    • Settings for 'System Integrity Protection' (SIP). It is generally recommended to change this with csrutil via the recovery partition.
    • csr-active-config by default is set to 00000000 which enables System Integrity Protection. You can choose a number of different values but overall we recommend keeping this enabled for best security practices. More info can be found in our troubleshooting page: Disabling SIP

  • run-efi-updater: No

    • This is used to prevent Apple's firmware update packages from installing and breaking boot order; this is important as these firmware updates (meant for Macs) will not work.

  • prev-lang:kbd: <>

    • Needed for non-latin keyboards in the format of lang-COUNTRY:keyboard, recommended to keep blank though you can specify it(Default in Sample config is Russian):
    • American: en-US:0(656e2d55533a30 in HEX)
    • Full list can be found in AppleKeyboardLayouts.txt
    • Hint: prev-lang:kbd can be changed into a String so you can input en-US:0 directly instead of converting to HEX
    • Hint 2: prev-lang:kbd can be set to a blank variable (eg. <>) which will force the Language Picker to appear instead at first boot up.
Key Type Value
prev-lang:kbd String en-US:0

:::

Delete

Forcibly rewrites NVRAM variables, do note that Add will not overwrite values already present in NVRAM so values like boot-args should be left alone.

  • LegacySchema

    • Used for assigning NVRAM variables, used with OpenVariableRuntimeDxe.efi. Only needed for systems without native NVRAM

  • WriteFlash: YES

    • Enables writing to flash memory for all added variables.

PlatformInfo

PlatformInfo

::: tip Info

For setting up the SMBIOS info, we'll use CorpNewt's GenSMBIOS application.

For this Kaby Lake example, we'll chose the MacBookPro14,1 SMBIOS - this is done intentionally for compatibility's sake. The typical breakdown is as follows:

SMBIOS CPU Type GPU Type Display Size Touch ID
MacBookPro14,1 Dual Core 15W(Low End) iGPU: Iris Plus 640 13" No
MacBookPro14,2 Dual Core 15W(High End) iGPU: Iris Plus 650 13" Yes
MacBookPro14,3 Quad Core 45W iGPU: HD 630 + dGPU: Radeon Pro 555X/560X 15" Yes
iMac18,1 NUC Systems iGPU: Iris Plus 640 N/A No

Run GenSMBIOS, pick option 1 for downloading MacSerial and Option 3 for selecting out SMBIOS. This will give us an output similar to the following:

  #######################################################
 #               MacBookPro14,1 SMBIOS Info            #
#######################################################

Type:         MacBookPro14,1
Serial:       C02Z2CZ5H7JY
Board Serial: C02928701GUH69FFB
SmUUID:       AA043F8D-33B6-4A1A-94F7-46972AAD0607

The Type part gets copied to Generic -> SystemProductName.

The Serial part gets copied to Generic -> SystemSerialNumber.

The Board Serial part gets copied to Generic -> MLB.

The SmUUID part gets copied to Generic -> SystemUUID.

We set Generic -> ROM to either an Apple ROM (dumped from a real Mac), your NIC MAC address, or any random MAC address (could be just 6 random bytes, for this guide we'll use 11223300 0000. After install follow the Fixing iServices page on how to find your real MAC Address)

Reminder that you need an invalid serial! When inputting your serial number in Apple's Check Coverage Page, you should get a message such as "Unable to check coverage for this serial number."

Automatic: YES

  • Generates PlatformInfo based on Generic section instead of DataHub, NVRAM, and SMBIOS sections

:::

Generic

::: details More in-depth Info

  • 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 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

:::

UEFI

UEFI

ConnectDrivers: YES

  • Forces .efi drivers, change to NO will automatically connect added UEFI drivers. This can make booting slightly faster, but not all drivers connect themselves. E.g. certain file system drivers may not load.

Drivers

Add your .efi drivers here.

Only drivers present here should be:

  • HfsPlus.efi
  • OpenRuntime.efi

::: details More in-depth Info

Key Type Description
Path String Path of the file from OC/Drivers directory
LoadEarly Boolean Load the driver early before NVRAM setup, should only be enabled for OpenRuntime.efi and OpenVariableRuntimeDxe.efi if using legacy NVRAM
Arguments String Some drivers accept additional arguments which are specified here.

:::

APFS

By default, OpenCore only loads APFS drivers from macOS Big Sur and newer. If you are booting macOS Catalina or earlier, you may need to set a new minimum version/date. Not setting this can result in OpenCore not finding your macOS partition!

macOS Sierra and earlier use HFS instead of APFS. You can skip this section if booting older versions of macOS.

::: tip APFS Versions

Both MinVersion and MinDate need to be set if changing the minimum version.

macOS Version Min Version Min Date
High Sierra (10.13.6) 748077008000000 20180621
Mojave (10.14.6) 945275007000000 20190820
Catalina (10.15.4) 1412101001000000 20200306
No restriction -1 -1

:::

Audio

Related to AudioDxe settings, for us we'll be ignoring(leave as default). This is unrelated to audio support in macOS.

Input

Related to boot.efi keyboard passthrough used for FileVault and Hotkey support, leave everything here as default as we have no use for these quirks. See here for more details: Security and FileVault

Output

Relating to OpenCore's visual output, leave everything here as default as we have no use for these quirks.

::: details More in-depth Info

Output Value Comment
UIScale 0 0 will automatically set based on resolution
-1 will leave it unchanged
1 for 1x scaling, for normal displays
2 for 2x scaling, for HiDPI displays

:::

ProtocolOverrides

Mainly relevant for Virtual machines, legacy macs and FileVault users. See here for more details: Security and FileVault

Quirks

::: tip Info Relating to quirks with the UEFI environment, for us we'll be changing the following:

Quirk Enabled Comment
ReleaseUsbOwnership YES
UnblockFsConnect NO Needed mainly by HP motherboards

:::

::: details More in-depth Info

  • 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

:::

ReservedMemory

Used for exempting certain memory regions from OSes to use, mainly relevant for Sandy Bridge iGPUs or systems with faulty memory. Use of this quirk is not covered in this guide

Cleaning up

And now you're ready to save and place it into your EFI under EFI/OC.

For those having booting issues, please make sure to read the Troubleshooting section first and if your questions are still unanswered we have plenty of resources at your disposal:

Config reminders

HP Users:

  • Kernel -> Quirks -> LapicKernelPanic -> True
    • You will get a kernel panic on LAPIC otherwise
  • UEFI -> Quirks -> UnblockFsConnect -> True

Dell Users:

For Skylake and newer:

  • Kernel -> Quirk -> CustomSMBIOSGuid -> True
  • PlatformInfo -> UpdateSMBIOSMode -> Custom

Intel BIOS settings

  • Note: Most of these options may not be present in your firmware, we recommend matching up as closely as possible but don't be too concerned if many of these options are not available in your BIOS

Disable

  • Fast Boot
  • Secure Boot
  • Serial/COM Port
  • Parallel Port
  • VT-d (can be enabled if you set DisableIoMapper to YES)
  • Compatibility Support Module (CSM) (Must be off in most cases, GPU errors/stalls like gIO are common when this option is enabled)
  • Thunderbolt(For initial install, as Thunderbolt can cause issues if not setup correctly)
  • Intel SGX
  • Intel Platform Trust
  • CFG Lock (MSR 0xE2 write protection)(This must be off, if you can't find the option then enable AppleXcpmCfgLock under Kernel -> Quirks. Your hack will not boot with CFG-Lock enabled)

Enable

  • VT-x
  • Above 4G Decoding
  • Hyper-Threading
  • Execute Disable Bit
  • EHCI/XHCI Hand-off
  • OS type: Windows 8.1/10 UEFI Mode (some motherboards may require "Other OS" instead)
  • DVMT Pre-Allocated(iGPU Memory): 64MB or higher
  • SATA Mode: AHCI

Once done here, we need to edit a couple extra values. Head to the Apple Secure Boot Page