Skip to content

Latest commit

 

History

History
204 lines (137 loc) · 10.8 KB

OpenCore-Guide.md

File metadata and controls

204 lines (137 loc) · 10.8 KB

Open Core Guide for Intel Pc

Check your config.plist File https://opencore.slowgeek.com/

Firmware Drivers

Firmware drivers are drivers used by OpenCore in the UEFI environment. They're mainly required to boot a machine, either by extending OpenCore's patching ability or showing you different types of drives in the OpenCore picker(ie. HFS drives).

  • Location Note: These files must be placed under EFI/OC/Drivers/

Universal

For the majority of systems, you'll only need 2 .efi drivers to get up and running:

- - Needed for seeing HFS volumes(ie. macOS Installers and Recovery partitions/images). Do not mix other HFS drivers

  • OpenRuntime.efi - Replacement for AptioMemoryFix.efi used as an extension for OpenCore to help with patching boot.efi for NVRAM fixes and better memory management.

Kexts

A kext is a kernel extension, you can think of this as a driver for macOS, these files will go into the Kexts folder in your EFI.

  • Windows and Linux note: Kexts will look like normal folders in your OS, double check that the folder you are installing has a .kext extension visible(and do not add one manually if it's missing).
    • If any kext also includes a .dSYM file, you can simply delete it. They're only for debugging purposes.
  • Location Note: These files must be placed under EFI/OC/Kexts/.

All kext listed below can be found pre-compiled in the Kext Repo

. Kexts here are compiled each time there's a new commit

Must haves required for all efi

Without the below 2, no system is bootable:

- Emulates the SMC chip found on real macs, without this macOS will not boot - Alternative is FakeSMC which can have better or worse support, most commonly used on legacy hardware.

  • Lilu - A kext to patch many processes, required for AppleALC, WhateverGreen, VirtualSMC and many other kexts. Without Lilu, they will not work

VirtualSMC Plugins

The below plugins are not required to boot, and merely add extra functionality to the system like hardware monitoring:

  • SMCProcessor.kext
    • Used for monitoring CPU temperature, doesn't work on AMD CPU based systems
  • SMCSuperIO.kext
    • Used for monitoring fan speed, doesn't work on AMD CPU based systems
  • SMCLightSensor.kext
    • Used for the ambient light sensor on laptops, desktops can ignore
    • Do not use if you don't have an ambient light sensor, can cause issues otherwise
  • SMCBatteryManager.kext
    • Used for measuring battery readouts on laptops, desktops can ignore
    • Do not use until battery has been properly patched, can cause issues otherwise

Graphics

  • WhateverGreen -Used for graphics patching DRM, boardID, framebuffer fixes, etc, all GPUs benefit from this kext. -Note the SSDT-PNLF.dsl file included is only required for laptops.

Audio

  • AppleALC
    • Used for AppleHDA patching, used for giving you onboard audio. AMD 15h/16h may have issues with this and Ryzen/Threadripper systems rarely have mic support

Ethernet

Here we're going to assume you know what ethernet card your system has, reminder that product spec pages will most likely list the type of network card.

  • IntelMausi

  • Required for the majority of Intel NICs, chipsets that are based off of I211 will need the SmallTreeIntel82576 kext

  • Intel's 82578, 82579, i217, i218 and i219 NICs are officially supported

  • AtherosE2200Ethernet- Required for Atheros and Killer NICs

  • RealtekRTL8111 - For Realtek's Gigabit Ethernet

  • LucyRTL8125Ethernet - For Realtek's 2.5Gb Ethernet

  • For Intel's i225-V NICs, patches are mentioned in the desktop Comet Lake DeviceProperty section. No kext is required.

USB

USBInjectAll- - Used for injecting Intel USB controllers on systems without defined USB ports in ACPI - Not needed on Skylake (6th gen) and newer(AsRock is dumb and does need this) - Does not work on AMD CPUs at all

  • XHCI-unsupported
    • Needed for non-native USB controllers
    • AMD CPU based systems don't need this
    • Common chipsets needing this:
      • H370
      • B360
      • H310
      • Z390(Not needed on Mojave and newer)
      • X79
      • X99
      • AsRock boards(On Intel motherboards specifically, Z490 boards do not need it however)

WiFi and Bluetooth

AirportBrcmFixup- - Used for patching non-Apple Broadcom cards, will not work on Intel, Killer, Realtek, etc

  • BrcmPatchRAM
    • Used for uploading firmware on Broadcom Bluetooth chipset, required for all non-Apple/Fenvi Airport cards.
    • To be paired with BrcmFirmwareData.kext
      • BrcmPatchRAM3 for 10.14+ (must be paired with BrcmBluetoothInjector)
      • BrcmPatchRAM2 for 10.11-10.14
      • BrcmPatchRAM for 10.10 or older

The order in Kernel -> Add should be:

  1. BrcmBluetoothInjector
  2. BrcmFirmwareData
  3. BrcmPatchRAM3

Extras

AppleMCEReporterDisabler- - Useful starting with Catalina to disable the AppleMCEReporter kext which will cause kernel panics on AMD CPUs and dual-socket systems - Affected SMBIOS: - MacPro6,1 - MacPro7,1 - iMacPro1,1

  • CpuTscSync - - Needed for syncing TSC on some of Intel's HEDT and server motherboards, without this macOS may be extremely slow or even unbootable. Skylake-X should use TSCAdjustReset instead

  • TSCAdjustReset - On Skylake-X, many firmwares including Asus and EVGA won't write the TSC to all cores. So we'll need to reset the TSC on cold boot and wake. Compiled version can be found here: TSCAdjustReset.kext - - . Note that you must open up the kext(ShowPackageContents in finder, Contents -> Info.plist) and change the Info.plist -> IOKitPersonalities -> IOPropertyMatch -> IOCPUNumber to the number of CPU threads you have starting from 0(i9 7980xe 18 core would be 35 as it has 36 threads total)

  • NVMeFix -- Used for fixing power management and initialization on non-Apple NVMe, requires macOS 10.14 or newer

Laptop Specifics

To figure out what kind of keyboard and trackpad you have, check Device Manager in Windows or dmesg |grep input in Linux

Input drivers

- Required for systems with PS2 keyboards and trackpads

  • Trackpad users should also pair this with VoodooInput - - (This must come before VoodooPS2 in your config.plist)

  • VoodooI2C

    • Used for fixing I2C devices, found with some fancier touchpads and touchscreen machines
    • To be paired with a plugin:
      • VoodooI2CHID - Implements the Microsoft HID device specification.
      • VoodooI2CElan - Implements support for Elan proprietary devices. (does not work on ELAN1200+, use the HID instead)
      • VoodooI2CSynaptics - Implements support for Synaptic's proprietary devices.
      • VoodooI2CFTE - Implements support for the FTE1001 touchpad.
      • VoodooI2CUPDDEngine - Implements Touchbase driver support.

Misc

  • NoTouchID -- - Recommended for MacBook SMBIOS that include a TouchID sensor to fix auth issues, generally 2016 and newer SMBIOS will require this

SSDTs - ACPI

So you see all those SSDTs in the AcpiSamples folder and wonder whether you need any of them. For us, we will be going over what SSDTs you need in your specific ACPI section of the config.plist, as the SSDTs you need are platform specific. With some even system specific where they need to be configured and you can easily get lost if I give you a list of SSDTs to choose from now.

https://dortania.github.io/Getting-Started-With-ACPI/

I2C Trackpad -- SSDT-XOSI.aml Backlight

  • [SSDT-PNLF.aml] - For most users
  • [SSDT-PNLF-CFL.aml] - For Coffee Lake and newer

Embedded Controllers

Desktop:

SSDT-EC-USBX-DESKTOP
For Skylake desktops and newer and AMD CPU based systems

SSDT-EC-DESKTOP
For Broadwell desktops and older

Laptops:

SSDT-EC-USBX-LAPTOP.aml
For Skylake laptops and newer

SSDT-EC-LAPTOP.aml
For Broadwell laptops and older

Power Management (SSDT-PLUG)