Ivy Bridge

Last edited: January 16, 2020

Starting Point

You'll want to start with the sample.plist that OpenCorePkg provides you in the DOCS folder and rename it to config.plist. Next, open up your favourite XML editor like ProperTree and we can get to work.

Users of ProperTree will also get the benefit of running the Snapshot function which will add all the Firmware drivers, kexts and SSDTs into your config.plist(Cmd/Crtl + R and point to your OC folder).

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.

And read this guide more than once before setting up OpenCore and make sure you have it set up correctly

ACPI

ACPI

Add:

This is where you'll add SSDT patches for your system, these are most useful for laptops and OEM desktops but also common for USB maps, disabling unsupported GPUs and such.

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

  • SSDT-EC

    • Corrects your EC devices, needed for all Catalina users. To setup you'll need to find out the name of your PNP0C09 device in your DSDT, this being either EC0, H_EC, PGEC and ECDV. You can read more about Embedded Controller issues in Catalina here: What's new in macOS Catalina

  • SSDT-EHCx_OFF

    • Prefered alternative over renaming EHCI for setting up USB correctly on pre-skylake systems. This can be avoided if your BIOS supports EHCI-Handoff

  • CPU-PM

    • Needed for proper CPU power management, you will need to run Pike's ssdtPRGen.sh script to generate this file.

For those having troubles understanding the SSDTs regarding EC can use CorpNewt's SSDTTime to properly set up your SSDT. All other SSDTs can be compiled with MaciASL, don't forget that compiled SSDTs have a .aml extension(Assembled) and will go into the EFI/OC/ACPI folder. You can compile with MaciASL by running File -> Save As -> ACPI Machine Language. And no need to add your DSDT to Opencore as its already inside your firmware.

For a much deeper rundown on ACPI including compiling in Windows and Linux, see the Getting started with ACPI page.

Block

This drops certain ACPI tabes from loading, for use we need to block both CpuPm and Cpu0Ist:

CpuPm:

  • OemTableId: 437075506d000000

  • TableLength: 0

  • TableSignature: 53534454

  • Enabled: YES

Cpu0Ist:

  • OemTableId: 4370753049737400

  • TableLength: 0

  • TableSignature: 53534454

  • Enabled: YES

Patch:

This section allows us to dynamically modify parts of the ACPI (DSDT, SSDT, etc.) via OpenCore. Most PCs do not ACPI patches, so in the majority of the cases, you need to do nothing here. For those who need DSDT patches for things like XHC controllers, use SSDTs or similar Device Property patching like what's seen with Framebuffer patching.

  • Comment

    • Name of patch

  • Count

    • How many time the patch is applied, 0 will apply to all instances

  • Enabled

    • Self-explanatory, enables or disables the patch

  • Find

    • The original name in ACPI

  • Replace

    • The new name in ACPI, the length must match original

Quirk: Settings for ACPI.

  • FadtEnableReset: NO

    • Enable reboot and shutdown on legacy hardware, not recommended unless needed

  • NormalizeHeaders: NO

    • Cleanup ACPI header fields, only relevant for macOS High Sierra 10.13

  • RebaseRegions: NO

    • Attempt to heuristically relocate ACPI memory regions, not needed unless custom DSDT is used.

  • ResetHwSig: NO

    • Needed for hardware that fails to maintain hardware signature across the reboots and cause issues with waking from hibernation

  • ResetLogoStatus: NO

    • Workaround for OEM Windows logo not drawing on systems with BGRT tables.

Booter

Booter

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

MmioWhitelist:

This section is allowing devices to be passthrough to macOS that are generally ignored, most users can ignore this section.

Quirks:

  • AvoidRuntimeDefrag: YES

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

  • DevirtualiseMmio: NO

    • Reduces Stolen Memory Footprint, expands options for slide=N values

  • DisableSingleUser: NO

    • Disables the use of Cmd+S and -s, this is closer to the behaviour of T2 based machines

  • DisableVariableWrite: NO

    • Needed for systems with non-functioning NVRAM like Z390 and such

  • DiscardHibernateMap: NO

    • Reuse original hibernate memory map, only needed for certain legacy hardware

  • EnableSafeModeSlide: YES

    • Allows for slide values to be used in Safemode

  • EnableWriteUnprotector: YES

    • Removes write protection from CR0 register during their execution

  • ForceExitBootServices: NO

    • Ensures ExitBootServices calls succeeds even when MemoryMap has changed, don't use unless necessary

  • ProtectCsmRegion: NO

    • Needed for fixing artefacts and sleep-wake issues, AvoidRuntimeDefrag resolves this already so avoid this quirk unless necessary

  • ProvideCustomSlide: YES

    • If there's a conflicting slide value, this option forces macOS to use a pseudo-random value. Needed for those receiving Only N/256 slide values are usable! debug message

  • SetupVirtualMap: YES

    • Fixes SetVirtualAddresses calls to virtual addresses

  • ShrinkMemoryMap: NO

    • Needed for systems with large memory maps that don't fit, don't use unless necessary

DeviceProperties

DeviceProperties

Add: Sets device properties from a map.

This section is set up via Headkaze's Intel Framebuffer Patching Guide and applies only one actual property to begin, which is the ig-platform-id. The way we get the proper value for this is to look at the ig-platform-id we intend to use, then swap the pairs of hex bytes.

If we think of our ig-plat as 0xAABBCCDD, our swapped version would look like DDCCBBAA

The two ig-platform-id's we use are as follows:

  • 0x0166000A - this is the standard hex for the ig-plat

    • 0A006601 when hex-swapped

We also add 2 more properties, framebuffer-patch-enable and framebuffer-stolenmem. The first enables patching via WhateverGreen.kext, and the second sets the min stolen memory to 19MB. This is usually unnecessary, as this can be configured in BIOS.

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.

Keep in mind that some motherboards have different device locations, you can find yours by either examining the device tree in IOReg or using gfxutil You can find your audio path with the following(Do note, not all audio controllers are called HDEF, sometimes being known as HDAS, AZAL, HDAU and such):

path/to/gfxutil -f HDEF

Do note that layout-id is a Data value meaning you will need to convert from Number to HEX so Layout=5 would be interpreted as <05000000> and Layout=11 would be <0B000000>. Audio can be left for post-install.

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

Fun Fact: The reason the byte order is swapped is due to Endianness, specifically Little Endians that modern CPUs use for ordering bytes. The more you know!

Kernel

Kernel

Add: Here's where you specify which kexts to load, order matters here so make sure Lilu.kext is always first! Other higher priority kexts come after Lilu such as VirtualSMC, AppleALC, WhateverGreen, etc. A reminder that ProperTree users can run Cmd/Ctrl+R to add all their kexts in the correct order without manually typing each kext out.

  • BundlePath

    • Name of the kext

    • ex: Lilu.kext

  • Enabled

    • Self-explanatory, either enables or disables the kext

  • ExecutablePath

    • Path to the actual executable hidden within the kext, you can see what path you 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

  • PlistPath

    • Path to the info.plist hidden within the kext

    • ex: Contents/Info.plist

Emulate: Needed for spoofing unsupported CPUs like Pentiums and Celerons

  • CpuidMask: When set to Zero, original CPU bit will be used

    • <Clover_FCPUID_Extended_to_4_bytes_Swapped_Bytes> | 00 00 00 00 | 00 00 00 00 | 00 00 00 00

    • ex: CPUID 0x0306A9 would be A9 06 03 00 | 00 00 00 00 | 00 00 00 00 | 00 00 00 00

  • CpuidData: The value for the CPU spoofing

    • FF FF FF FF | 00 00 00 00 | 00 00 00 00 | 00 00 00 00

    • Swap 00 for FF if needing to swap with a longer value

Block: Blocks kexts from loading. Sometimes needed for disabling Apple's trackpad driver for some laptops.

Patch: Patches both the kernel and kexts (this is where you would add AMD CPU patches).

Quirks:

  • AppleCpuPmCfgLock: NO

    • Only needed when CFG-Lock can't be disabled in BIOS, Clover counterpart would be AppleIntelCPUPM. Please verify you can disable CFG-Lock, most systems won't boot with it on so requiring use of this quirk

  • AppleXcpmCfgLock: NO

    • Only needed when CFG-Lock can't be disabled in BIOS, Clover counterpart would be KernelPM. Please verify you can disable CFG-Lock, most systems won't boot with it on so requiring use of this quirk

  • AppleXcpmExtraMsrs: NO

    • Disables multiple MSR access needed for unsupported CPUs like Pentiums and certain Xeons

  • AppleXcpmForceBoost: NO

    • Forces maximum multiplier, only recommended to enable on scientific or media calculation machines that are constantly under load. Main Xeons benifit from this

  • CustomSMBIOSGuid: NO

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

  • 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

  • ExternalDiskIcons: YES

    • External Icons Patch, for when internal drives are treated as external drives but can also make USB drives internal. For NVMe on Z87 and below you just add built-in property via DeviceProperties.

  • IncreasePciBarSize: NO

    • Increases 32-bit PCI bar size in IOPCIFamily from 1 to 4 GB, enabling Above4GDecoding in the BIOS is a much cleaner and safer approach. Some X99 boards may require this, you'll generally expereince a kernel panic on IOPCIFamily if you need this

  • LapicKernelPanic: NO

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

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

  • ThirdPartyDrives: NO

    • Enables TRIM, not needed for NVMe but AHCI based drives may require this. Please check under system report to see if your drive supports TRIM

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

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.

Misc

Misc

Boot: Settings for boot screen (leave as-is unless you know what you're doing)

  • HibernateMode: None

    • Best to avoid hibernation with Hackintoshes all together

  • HideSelf: YES

    • Hides the EFI partition as a boot option in OC's boot picker

  • PollAppleHotKeys: NO

    • Allows you to use Apple's hotkeys during boot, depending on the firmware you may need to use AppleUsbKbDxe.efi instead of OpenCore's builtin support. Do note that if you can select anything in OC's picker, disabling this option can help. Popular commands:

      • Cmd+V: Enables verbose

      • Cmd+Opt+P+R: Cleans NVRAM

      • Cmd+R: Boots Recovery partition

      • Cmd+S: Boot in Single-user mode

      • Option/Alt: Shows boot picker when ShowPicker set to NO, an alternative is ESC key

  • Timeout: 5

    • This sets how long OpenCore will wait until it automatically boots from the default selection

  • ShowPicker: YES

    • Shows OpenCore's UI, needed for seeing your available drives or set to NO to follow default option

  • UsePicker: YES

    • Uses OpenCore's default GUI, set to NO if you wish to use a different GUI

Debug: Debug has special use cases, leave as-is unless you know what you're doing.

  • DisableWatchDog: YES (Useful for when OpenCore is stalling on something while booting, can also help for early macOS boot issues)

  • Target: 67

    • Shows more debug information, requires debug version of OpenCore

  • DisplayLevel: 2147483714

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

These values are based of those calculated in OpenCore debugging

Security: Security is pretty self-explanatory.

  • AllowNvramReset: YES

    • Allows for NVRAM reset both in the boot picker and when pressing Cmd+Opt+P+R

  • AllowSetDefault: YES

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

  • AuthRestart: NO:

    • Enables Authenticated restart for FileVault2 so password is not required on reboot. Can be concidered a secuirty risk so optional

  • ExposeSensitiveData: 6

    • Shows more debug information, requires debug version of OpenCore

  • RequireSignature: NO

    • We won't be dealing vaulting so we can ignore

  • RequireVault: NO

    • We won't be dealing vaulting so we can ignore as well

  • ScanPolicy: 0

    • 0 allows you to see all drives available, please refer to Security section for furthur details

Tools Used for running OC debugging tools like clearing NVRAM

  • Name

    • Name shown in OpenCore

  • Enabled

  • Self-explanatory, enables or disables

  • Path

    • Path to file after the Tools folder

      ex: Shell.efi

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

  • Name

    • Name shown in boot picker

  • Enabled

    • Self-explanatory, enables or disables

  • Path

    • PCI route of boot drive, can be found with the OpenCoreShell and the map command

    • ex: PciRoot(0x0)/Pci(0x1D,0x4)/Pci(0x0,0x0)/NVMe(0x1,09-63-E3-44-8B-44-1B-00)/HD(1,GPT,11F42760-7AB1-4DB5-924B-D12C52895FA9,0x28,0x64000)/\EFI\Microsoft\Boot\bootmgfw.efi

NVRAM

NVRAM

Add: 4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14 (Booter Path, majogrity can ignore but )

  • UIScale:

    • 01: Standard resolution(Clover equivalent is 0x28)

    • 02: HiDPI (generally required for FileVault to function correctly on smaller displays, Clover equivalent is 0x2A)

7C436110-AB2A-4BBB-A880-FE41995C9F82 (System Integrity Protection bitmask)

  • boot-args:

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

    • shikigva=40 - this flag is specific for Nvidia users. It enables a few Shiki settings that do the following (found here):

      • 8 - AddExecutableWhitelist - ensures that processes in the whitelist are patched.

      • 32 - ReplaceBoardID - replaces board-id used by AppleGVA with a different board-id(iMac14,2). Do note that this generally needed for systems running Nvidia GPUs

  • csr-active-config: Settings for SIP, generally recommended to manually change this within Recovery partition with csrutil via the recovery partition

csr-active-config is set to E7030000 which effectively disables SIP. You can choose a number of other options to enable/disable sections of SIP. Some common ones are as follows:

  • 00000000 - SIP completely enabled

  • 30000000 - Allow unsigned kexts and writing to protected fs locations

  • E7030000 - SIP completely disabled

  • nvda_drv: <>

    • For enabling Nvidia WebDrivers, set to 31 if running a Maxwell or Pascal GPU. This is the same as setting nvda_drv=1 but instead we translate it from text to hex. AMD and Intel GPU users should leave this area blank.

  • prev-lang:kbd: <>

    • Needed for non-Latin keyboards in the format of lang-COUNTRY:keyboard, recommeneded to keep blank though you can specify it(Default in Sample config is Russian):

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

LegacyEnable: NO

  • Allows for NVRAM to be stored on nvram.plist, needed for systems without native NVRAM

LegacyOverwrite: NO

  • Permits overwriting firmware variables from nvram.plist, only needed for systems without native NVRAM

LegacySchema

  • Used for assigning NVRAM variables, used with LegacyEnable set to YES

WriteFlash: YES

  • Enables writing to flash memory for all added variables.

Platforminfo

PlatformInfo

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

For this Ivy Bridge example, we'll choose the iMac13,2 SMBIOS.

GenSMBIOS would give us output similar to the following:

#######################################################
# iMac13,2 SMBIOS Info #
#######################################################
Type: iMac13,2
Serial: C02KCYZLDNCW
Board Serial: C02309301QXF2FRJC
SmUUID: A154B586-874B-4E57-A1FF-9D6E503E4580

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

Reminder that you want valid serial numbers but those not in use, you want to get a message back like: "Purchase Date not Validated"

Apple Check Coverage page

Automatic: YES

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

  • SpoofVendor: YES

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

  • SupportsCsm: NO

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

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

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

Input: Related to boot.efi keyboard passthrough used for FileVault and Hotkey support

  • KeyForgetThreshold: 5

    • The delay between each key input when holding a key down, for best results use 5 milliseconds

  • KeyMergeThreshold: 2

    • The length of time that a key will be registered before resetting, for best results use 2 milliseconds

  • KeySupport: YES

    • Enables OpenCore's built in key support and required for boot picker selection, do not use with AppleUsbKbDxe.efi

  • KeySupportMode: Auto

    • Keyboard translation for OpenCore

  • KeySwap: NO

    • Swaps Option and Cmd key

  • PointerSupport: NO

    • Used for fixing broken pointer support, commonly used for Z87 Asus boards

  • PointerSupportMode:

    • Specifies OEM protocol, currently only supports Z87 and Z97 ASUS boards so leave blank

  • TimerResolution: 50000

    • Set architecture timer resolution, Asus Z87 boards use 60000 for the interface. Settings to 0 can also work for some

Protocols: (Most values can be ignored here as they're meant for real Macs/VMs)

  • AppleSmcIo: NO

    • Reinstalls Apple SMC I/O, this is the equivlant of VirtualSMC.efi which is only needed for users using FileVault

  • ConsoleControl: YES

    • Replaces Console Control protocol with a builtin version, set to YES otherwise you may see text output during booting instead of nice Apple logo. Required for most APTIO firmware

  • FirmwareVolume: NO

    • Fixes UI regarding Filevault, set to YES for better FileVault compatibility

  • HashServices: NO

    • Fixes incorrect cursor size when running FileVault, set to YES for better FileVault compatibility

  • UnicodeCollation: NO

    • Some older firmware have broken Unicode collation, fixes UEFI shell compatibility on these systems(generally IvyBridge and older)

Quirks:

  • AvoidHighAlloc: NO

    • Workaround for when te motherboard can't properly access higher memory in UEFI Boot Services. Avoid unless necessary(affected models: GA-Z77P-D3 (rev. 1.1))

  • ExitBootServicesDelay: 0

    • Only required for very specific use cases like setting to 5 for ASUS Z87-Pro running FileVault2

  • IgnoreInvalidFlexRatio: YES

    • Fix for when MSR_FLEX_RATIO (0x194) can't be disabled in the BIOS, required for all pre-skylake based systems

  • IgnoreTextInGraphics: NO

    • Fix for UI corruption when both text and graphics outputs happen, set to YES with SanitiseClearScreen also set to YES for pure Apple Logo(no verbose screen)

  • ProvideConsoleGop: YES

    • Enables GOP(Graphics output Protcol) which the macOS bootloader requires for console handle, required for seeing once the kernel takes over

  • ReleaseUsbOwnership: NO

    • Releases USB controller from firmware driver, needed for when your firmware doesn't support EHCI/XHCI Handoff. Clover equivalent is FixOwnership

  • RequestBootVarFallback: YES

    • Request fallback of some Boot prefixed variables from OC_VENDOR_VARIABLE_GUID to EFI_GLOBAL_VARIABLE_GUID. Used for fixing boot options.

  • RequestBootVarRouting: YES

    • Redirects AptioMemeoryFix 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.

  • ReplaceTabWithSpace: NO

    • Depending on the firmware, some system may need this to properly edit files in the UEFI shell when unable to handle Tabs. This swaps it for spaces instead-but majority can ignore it but do note that ConsoleControl set to True may be needed

  • SanitiseClearScreen: YES

    • Fixes High resolutions displays that display OpenCore in 1024x768, recommended for users with 1080P+ displays

  • ClearScreenOnModeSwitch: NO

    • Needed for when half of the previously drawn image remains, will force black screen before switching to TextMode. Do note that ConsoleControl set to True may be needed

  • 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

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:

Post-install

So what in the world needs to be done once everything is installed? Well here are some things: