polipo-dev / ocquirks

A work-in-progress attempt to port OpenCore's boot quirks to Clover in order to replace AptioMemoryFix.

OcQuirks

OcQuirks is a drop in replacement EFI driver for Clover that replaces AptioMemoryFix and all OsxAptioFix variants. It is built against the OpenCore source tree, and supports OpenCore's quirks model.

Prerequisites

The OcQuirks EFI driver has a dependency on FwRuntimeServices.efi, and they must be installed together in the CLOVER EFI drivers directory. FwRuntimeServices.efi can be found in AppleSupportPkg.

Download AppleSupportPkg from the project's releases page.

Installation

To install OcQuirks, download the latest release or build it using the instructions below and then install it into your EFI replacing any existing memory fix driver.

• Mount your EFI volume.
• Back your EFI volume up to a bootable USB drive and verify that it works.
• Remove AptioMemoryFix, and any OsxAptioFix variants from the Clover drivers folder on your EFI volume.
• Add OcQuirks.efi and FwRuntimeServices.efi to the Clover drivers folder on your EFI volume.
• Reboot.

If your system has trouble booting, use your USB stick to boot back into macOS and revert by reversing the process. Inspect the parameters below and build OcQuirks with parameters that better match your system.

Default Parameters

Quirk	Default Value	Description
AvoidRuntimeDefrag	True	Fix UEFI runtime services support on many firmwares.
DevirtualiseMmio	False	Reduce stolen memory footprint from memory map, incompatible with some systems
DisableSingleUser	False	A security option to ignore single user mode arguments.
DisableVariableWrite	False	A security option to protect macOS NVRAM write access.
DiscardHibernateMap	False	A legacy parameter to work around buggy memory maps. Preserves runtime memory size and location after wake from S4 sleep.
EnableSafeModeSlide	True	Patch the bootloader to enable KASLR in safe mode.
EnableWriteUnprotector	True	Permits write access to UEFI runtime services code.
ForceExitBootServices	True	Ensures that calls to ExitBootServices succeed even with an outdated MemoryMap key.
ProtectCsmRegion	False	Prevents CSM memory regions from relocation or use.
ProvideCustomSlide	True	Force macOS to use a pseudorandom value among available slide values.
SetupVirtualMap	True	Workaround issues in some firmwares that access memory after SetVirtualAddress calls often resulting in boot crashes.
ShrinkMemoryMap	False	Rarely needed on Haswell or newer, attempts to unify contiguous slots of similar types to prevent boot failures.
QuirksProvideConsoleGopEnable	True	Install Graphics Output Protocol if missing from the console handle.

For a more indepth description of quirks, review the OpenCore Configuration Manual.

Building

Building OcQuirks is simple, you just need macOS and time. Review the table above to determine if you need to make any modifications to OcQuirks before building, and then follow the process below.

Clone the Repository

$ git clone https://github.com/ReddestDream/OcQuirks.git
$ cd OcQuirks

Configure OcQuirks

Run the ConfigureQuirks utility and use the menu system to make any necessary changes to the source.

$ ./ConfigureQuirks.command

Build OcQuirks

Now build OcQuirks using the macbuild tool. You may be prompted to install additional tools before compilation begins.

$ ./macbuild.tool

Installation

Follow the installation procedures found earlier in the documentation, using the newly compiled version of OcQuirks which can be found in the OcQuirks/Binaries/RELEASE folder.

Credits

• Apple for macOS
• vit9696 for OpenCore and AptioMemoryFix
• Download-Fritz and al3x for ideas and code contributions
• CorpNewt for the configuration scripts