Framebuffer patching in Mojave
Binary patching framebuffers using KextsToPatch in
Clover is no longer a viable method in
Mojave for Skylake and above. Now you need to use
Lilu +
WhateverGreen.
Not just for Mojave
This method of framebuffer patching is not only required for Mojave we recommend it for all previous and future releases of macOS.
Coffee Lake Users
Please note that the new WhateverGreen will not work with fake Kaby Lake platform-id's. You will need to have either macOS 10.14 Beta 4 (
18A336e) or macOS High Sierra 10.13.6 (
17G2112). The latter is a special build only available to MacBookPro15,1 or MacBookPro15,2 board id's. You can create a macOS High Sierra 10.13.6 (
17G2112) installer by running
installinstallmacos.py. (Update: vit9696 added back ability to fake Kaby Lake platform-id's)
Lilu + WhateverGreen
WhateverGreen is going to replace all the other video patching plugins for Lilu (it currently has merged WhateverGreen, IntelGraphicsFixup, NvidiaGraphicsFixup, Shiki and CoreDisplayFixup). Others will likely follow (such as AppleALC, HibernationFixup and IntelGraphicsDVMTFixup). This is aiming to be the all-in-one solution for video.
Preliminary
1. Remove:
- FakePCIID_Intel_HD_Graphics
- IntelGraphicsFixup
- NvidiaGraphicsFixup
- CoreDisplayFixup
- Shiki
2. Turn off all graphics injections in Clover:
- config.plist/Graphics/Inject/ATI=NO
- config.plist/Graphics/Inject/Intel=NO
- config.plist/Graphics/Inject/NVidia=NO
- config.plist/Graphics/ig-platform-id=
- config.plist/Devices/FakeID/IntelGFX=
3. Disable DSDT Clover fixes:
- AddHDMI
- FixDisplay
- FixIntelGfx
- AddIMEI
4. Disable UseIntelHDMI
5. Remove boot argument: -disablegfxfirmware
6. Remove any IGPU and HDMI entries from:
- config.plist/Devices/Arbitrary
- config.plist/Devices/Properties
- config.plist/Devices/AddProperties
7. Remove any IGPU and HDMI related SSDT and DSDT from:
- CLOVER/ACPI/patched
8. Renaming GFX0 -> IGPU
- WhateverGreen will do this automatically (see caveat below)
- Be aware that WhateverGreen does not rename all instances of GFX0 -> IGPU but should be okay in most cases
- You may need to include Clover GFX0 -> IGPU rename for other kexts or ACPI patching that require it
Compile Lilu + WhateverGreen
Download
WhateverGreen. Make sure you place the debug version of
Lilu into the root of WhateverGreen before you compile. Install Lilu and WhateverGreen kext's into the usual place. Compile WhateverGreen as debug if you want to view debug output.
Having trouble compiling?
If you're having trouble compiling you can download the official release binaries or download my (unsupported)
build_lilu.sh shell script and run it in a folder to download and build Lilu + WhateverGreen using Xcode automatically. I recommend you try the debug versions first (place them into Clover's EFI/Clover/kexts/Other folder).
Get the device path of your IGPU:
Download and use the
gfxutil tool like so:
Code:
$ ./gfxutil -f IGPU
DevicePath = PciRoot(0x0)/Pci(0x2,0x0)
ig-platform-id
For the
AAPL,ig-platform-id (AAPL,snb-platform-id for Sandy Bridge) entry Clover requires this value to be in Data format so you need to reverse the bytes. So if you want your platform-id to be 0x3EA50009 first reverse the bytes (0900A53E) then use Xcode's plist editor to add the values to Clover's config.plist.
What ig-platform-id should I use for my system?
You should choose one that is the closest match to your system. I recommend you do some research on this before choosing one. See post #2 for available options.
You can determine the generation of your CPU by the first digit after the hyphen.
Examples:
- Intel(R) Core(TM) i5-
2760QM (Gen 2)
- Intel(R) Core(TM) i7-
5257U CPU @ 2.70GHz (Gen 5)
- Intel(R) Core(TM) m3-
6Y30 (Gen 6)
- Intel(R) Core(TM) i5-
8350U (Gen 8)
Spoofing Intel CPU Gen
If you need to spoof a different Intel CPU generation you can use the
lilucpu=N boot flag. The N refers to the following Intel generations:
Code:
4 Sandy Bridge
5 Ivy Bridge
6 Haswell
7 Broadwell
8 Skylake
9 Kaby Lake
10 Coffee Lake
To spoof a CPU you will need to set a valid device-id in your GPU entry in Devices/Properties for the appropriate Intel generation.
Eg. Spoofing Skylake (lilucpu=8 boot flag with device-id=0x16190000), Kaby Lake (lilucpu=9 boot flag with device-id=0x12590000).
Here are some recommended frames:
Gen 2: Sandy Bridge (Intel HD Graphics 2000/3000)
- S/L/E/AppleIntelSNBGraphicsFB.kext
- Support started with OS X 10.7.x and ended with macOS 10.13.6
- Metal support is not available
- device-id: 0x0102 0x0106 0x010A 0x0112 0x0116 0x0122 0x0126
- AAPL,snb-platform-id (desktop): 0x00030010 (default)
- AAPL,snb-platform-id (laptop): 0x00010000 (default)
Gen 3: Ivy Bridge (Intel HD Graphics 2500/4000)
- S/L/E/AppleIntelFramebufferCapri.kext
- Support started with OS X 10.8.x
- device-id: 0x0152 0x0156 0x0162 0x0166
- AAPL,ig-platform-id (desktop): 0x0166000A (default), 0x01620005
- AAPL,ig-platform-id (laptop): 0x01660003 (default), 0x01660009, 0x01660004
Gen 4: Haswell (Intel HD Graphics 4200-5200)
- S/L/E/AppleIntelFramebufferAzul.kext
- Support started with OS X 10.9.x
- device-id: 0x0D26 0x0A26 0x0A2E 0x0D22 0x0412
- AAPL,ig-platform-id (desktop): 0x0D220003 (default)
- AAPL,ig-platform-id (laptop): 0x0A160000 (default), 0x0A260005 (recommended)
Gen 5: Broadwell (Intel HD Graphics 5300-6300)
- S/L/E/AppleIntelBDWGraphicsFramebuffer.kext
- Support started with OS X 10.10.2
- device-id: 0x0BD1 0x0BD2 0x0BD3 0x1606 0x160E 0x1616 0x161E 0x1626 0x1622 0x1612 0x162B
- AAPL,ig-platform-id (desktop): 0x16220007 (default)
- AAPL,ig-platform-id (laptop): 0x16260006 (default)
Gen 6: Skylake (Intel HD Graphics 510-580)
- S/L/E/AppleIntelSKLGraphicsFramebuffer.kext
- Support started with OS X 10.11.4
- device-id: 0x1916 0x191E 0x1926 0x1927 0x1912 0x1932 0x1902 0x1917 0x193B 0x191B
- AAPL,ig-platform-id (desktop): 0x19120000 (default)
- AAPL,ig-platform-id (laptop): 0x19160000 (default)
Gen 7: Kaby Lake (Intel HD Graphics 610-650)
- S/L/E/AppleIntelKBLGraphicsFramebuffer.kext
- Support started with macOS 10.12.6
- device-id: 0x5912 0x5916 0x591B 0x591C 0x591E 0x5926 0x5927 0x5923 0x87C0
- AAPL,ig-platform-id (desktop): 0x59160000 (default)
- AAPL,ig-platform-id (laptop): 0x591B0000 (default)
Gen 8: Coffee Lake (Intel UHD Graphics 630)
- S/L/E/AppleIntelCFLGraphicsFramebuffer.kext
- Support started with macOS 10.13.6 (17G2112) / 10.14 beta 4 (18A336e)
- device-id: 0x3E9B 0x3EA5 0x3E92 0x3E91
- AAPL,ig-platform-id (desktop): 0x3EA50000 (default), 0x3E9B0007 (recommended)
- AAPL,ig-platform-id (laptop): 0x3EA50009 (default)
Framebuffer Patching
WhateverGreen does most of the work automatically for you and in most cases you do not need any extra Framebuffer Patching. At the minimum though you should choose an
ig-platform-id suitable for your system and place it in
config.plist/Devices/Properties like this:
Here are some reasons why you might need extra Framebuffer Patching:
- Setting DVMT for those who can't set it above 32 MB in BIOS (framebuffer-stolenmem / framebuffer-fbmem)
- Setting higher VRAM for 4K users who experience graphical glitches (framebuffer-unifiedmem)
- Disabling eGPU (disable-external-gpu)
- Enable pixel clock patch for 4K support (enable-hdmi20)
- Disabling connectors to enable sleep (framebuffer-pipecount / framebuffer-portcount / framebuffer-conX-type=-1)
- Removing CNConnectorAlwaysConnected flag for eDP laptop screens on < 10.13.6 (framebuffer-con0-flags=0x00000090)
- Changing connector types to match your systems ports (framebuffer-conX-type)
Framebuffer Patching Types
We have three different types of patches:
1. Arbitrary (Recommended)
Code:
framebuffer-patch-enable (required to enable below)
framebuffer-framebufferid (optional; defaults to current platform-id)
(all below are optional)
framebuffer-mobile
framebuffer-pipecount
framebuffer-portcount
framebuffer-memorycount
framebuffer-stolenmem
framebuffer-fbmem
framebuffer-unifiedmem
framebuffer-cursormem (Haswell only)
framebuffer-camellia
framebuffer-flags
framebuffer-conX-enable (required to enable below)
framebuffer-conX-index
framebuffer-conX-busid
framebuffer-conX-pipe
framebuffer-conX-type
framebuffer-conX-flags
2. All Data
Code:
framebuffer-conX-enable (required to enable below)
framebuffer-conX-alldata
3. Find / Replace
Code:
framebuffer-patchX-enable (required to enable below)
framebuffer-patchX-framebufferid (optional; defaults to current platform-id)
framebuffer-patchX-find
framebuffer-patchX-replace
framebuffer-patchX-count (optional; defaults to 1)
You should place your patches in
config.plist/Devices/Properties in Clover config.plist.
Here are some example patches:
- 32MB BIOS, 19MB stolen (framebuffer) 9MB fbmem (cursor) 2048MB unifiedmem (vram)
- Pipe / Port Count 3 to 2
- Connector 1 DP to HDMI
- Connector 2 Disable
Here is an example of the All Data method:
Here is an example of the Find / Replace method:
Framebuffer Dumps
There are two ways to dump your framebuffer data (both require WhateverGreen + Lilu debug versions):
1. Using
-igfxdump boot flag to dump IGPU framebuffer kext to /AppleIntelFramebuffer_X_Y (root of your boot drive)
There are several ways of reading this dump:
- Using
010 Editor along with the
IntelFramebuffer.bt template
- Using
Hackintool File->Open menu
2. Using
-igfxfbdump boot flag to dump native and patched framebuffer table to ioreg at IOService:/IOResources/WhateverGreen
There are several ways of reading this dump:
- Using
dump_platformlist.sh shell script
- Using
Hackintool File->Import->IOReg Dump menu
3. Using
Hackintool Framebuffer->macOS 10.14 menu
Debug Output
To get debug output from Lilu use the
-liludbgall liludump=60 boot flags. You will need to compile Lilu and WhateverGreen as debug for both of these flags to work. Log files should be located at
/var/log/Lilu_*.
To view debug paste the following into Terminal (weglog.txt will output to your home directory):
Code:
log show --predicate 'process == "kernel" AND (eventMessage CONTAINS "WhateverGreen" OR eventMessage CONTAINS "Lilu")' --style syslog --source --last boot >weglog.txt
Getting Help
To help the users of this forum diagnose issues with your configuration please generate a Lilu debug log and then run
gen_debug.sh to generate a folder of debug files you can attach to a forum post requesting help.
Credits
-
vit9696 and
lvs1974 for WhateverGreen (
Full Credits) and Lilu (
Full Credits)
-
Andrey1970 for his guide
-
RehabMan for all data patching method, ioreg framebuffer dump and other contributions
