melxman / WhateverGreen

Various patches necessary for certain ATI/AMD/Intel/Nvidia GPUs

WhateverGreen

Lilu plugin providing patches to select GPUs on macOS. Requires Lilu 1.5.6 or newer.

Features

• Fixes boot to black screen on AMD and NVIDIA
• Fixes sleep wake to black screen on AMD
• Fixes boot screen distortion in certain cases
• Fixes transmitter/encoder in autodetected connectors for multimonitor support (-raddvi)
• Fixes HD 7730/7750/7770/R7 250/R7 250X initialisation (radpg=15)
• Allows tuning of aty_config, aty_properties, cail_properties via ACPI
• Allows enforcing 24-bit mode on unsupported displays (-rad24)
• Allows booting without video acceleration (-radvesa)
• Allows automatically setting GPU model name or providing it manually for RadeonFramebuffer
• Allows specifying custom connectors via device properties for RadeonFramebuffer
• Allows tuning autodetected connector priority via device properties (HD 7xxx or newer)
• Fixes an issue in AppleGraphicsDevicePolicy.kext so that we could use a MacPro6,1 board-id/model combination, without the usual hang with a black screen. Patching AppleGraphicsDevicePolicy.kext
• Modifies macOS to recognize NVIDIA's web drivers as platform binaries. This resolves the issue with transparent windows without content, which appear for applications that use Metal and have Library Validation enabled. Common affected applications are iBooks and Little Snitch Network Monitor, though this patch is universal and fixes them all. NVWebDriverLibValFix
• Injects IOVARendererID into GPU properties (required for Shiki-based solution for non-freezing Intel and/or any discrete GPU)
• For Intel HD digital audio HDMI, DP, Digital DVI (Patches connector-type DP -> HDMI)
• Fixes NVIDIA GPU interface stuttering on 10.13 (official and web drivers)
• Fixes the kernel panic caused by an invalid link rate reported by DPCD on some laptops with Intel IGPU.
• Fixes the infinite loop on establishing Intel HDMI connections with a higher pixel clock rate on Skylake, Kaby Lake and Coffee Lake platforms.
• Implements the driver support for onboard LSPCON chips to enable DisplayPort to HDMI 2.0 output on some platforms with Intel IGPU.
• Enforces complete modeset on non-built-in displays on Kaby Lake and newer to fix booting to black screen.
• Allows non-supported cards to use HW video encoder (-radcodec)
• Fixes choppy video playback on Intel Kaby Lake and newer.
• Fixes black screen on Intel HD since 10.15.5.
• Adds workaround for rare force wake timeout panics on Intel KBL and CFL.
• Supports all valid Core Display Clock (CDCLK) freqencies on Intel ICL platforms.
• Fixes the kernel panic caused by an incorrectly calculated amount of DVMT pre-allocated memory on Intel ICL platforms.
• Makes brightness transitions smoother on Intel IVB+ platforms.
• Fixes the short period garbled screen issue after the system boots on Intel ICL platforms.
• Fixes the PWM backlight control of the built-in display that is directly wired to AMD Radeon RX 5000 series graphic cards

Documentation

Read FAQs and avoid asking any questions. No support is provided for the time being.

Boot arguments

• -wegdbg to enable debug printing (available in DEBUG binaries).
• -wegoff to disable WhateverGreen.
• -wegbeta to enable WhateverGreen on unsupported OS versions (12 and below are enabled by default).
• -wegnoegpu to disable all external GPUs (or add disable-gpu property to each GFX0).
• -wegnoigpu to disable internal GPU (or add disable-gpu property to IGPU)
• -wegswitchgpu to disable internal GPU when external GPU is installed (or add switch-to-external-gpu property to IGPU)
• -radvesa to disable ATI/AMD video acceleration completely.
• -rad24 to enforce 24-bit display mode.
• -raddvi to enable DVI transmitter correction (required for 290X, 370, etc.).
• -radcodec to force the spoofed PID to be used in AMDRadeonVADriver
• radpg=15 to disable several power-gating modes (see FAQ, required for Cape Verde GPUs).
• agdpmod=vit9696 disables check for board-id (or add agdpmod property to external GPU).
• agdpmod=pikera replaces board-id with board-ix
• agdpmod=ignore disables AGDP patches (vit9696,pikera value is implicit default for external GPUs)
• ngfxgl=1 boot argument (and disable-metal property) to disable Metal support on NVIDIA
• ngfxcompat=1 boot argument (and force-compat property) to ignore compatibility check in NVDAStartupWeb
• ngfxsubmit=0 boot argument (and disable-gfx-submit property) to disable interface stuttering fix on 10.13
• -ngfxdbg boot argument to enable NVIDIA driver error logging
• gfxrst=1 to prefer drawing Apple logo at 2nd boot stage instead of framebuffer copying.
• gfxrst=4 to disable framebuffer init interaction during 2nd boot stage.
• igfxframe=frame to inject a dedicated framebuffer identifier into IGPU (only for TESTING purposes).
• igfxsnb=0 to disable IntelAccelerator name fix for Sandy Bridge CPUs.
• igfxgl=1 boot argument (and disable-metal property) to disable Metal support on Intel.
• igfxmetal=1 boot argument (and enable-metal property) to force enable Metal support on Intel for offline rendering.
• igfxpavp=1 boot argument (and igfxpavp property) to force enable PAVP output
• igfxfw=2 boot argument (and igfxfw property) to force loading of Apple GuC firmware
• -igfxvesa to disable Intel Graphics acceleration.
• -igfxnohdmi boot argument (and disable-hdmi-patches) to disable DP to HDMI conversion patches for digital sound.
• -igfxtypec to force DP connectivity for Type-C platforms.
• -cdfon (and enable-hdmi20 property) to enable HDMI 2.0 patches.
• -igfxdump to dump IGPU framebuffer kext to /var/log/AppleIntelFramebuffer_X_Y (available in DEBUG binaries).
• -igfxfbdump to dump native and patched framebuffer table to ioreg at IOService:/IOResources/WhateverGreen
• applbkl=0 boot argument (and applbkl property) to disable AppleBacklight.kext patches for IGPU. In case of custom AppleBacklight profile- read here.
• -igfxmlr boot argument (and enable-dpcd-max-link-rate-fix property) to apply the maximum link rate fix.
• -igfxhdmidivs boot argument (and enable-hdmi-dividers-fix property) to fix the infinite loop on establishing Intel HDMI connections with a higher pixel clock rate on SKL, KBL and CFL platforms.
• -igfxlspcon boot argument (and enable-lspcon-support property) to enable the driver support for onboard LSPCON chips. Read the manual
• -igfxi2cdbg boot argument to enable verbose output in I2C-over-AUX transactions (only for debugging purposes).
• igfxagdc=0 boot argument (disable-agdc device property) to disable AGDC.
• igfxfcms=1 boot argument (complete-modeset device property) to force complete modeset on Skylake or Apple firmwares.
• igfxfcmsfbs= boot argument (complete-modeset-framebuffers device property) to specify indices of connectors for which complete modeset must be enforced. Each index is a byte in a 64-bit word; for example, value 0x010203 specifies connectors 1, 2, 3. If a connector is not in the list, the driver's logic is used to determine whether complete modeset is needed. Pass -1 to disable.
• igfxonln=1 boot argument (force-online device property) to force online status on all displays.
• igfxonlnfbs=MASK boot argument (force-online-framebuffers device property) to specify indices of connectors for which online status is enforced. Format is similar to igfxfcmsfbs.
• wegtree=1 boot argument (rebuild-device-tree property) to force device renaming on Apple FW.
• igfxrpsc=1 boot argument (rps-control property) to enable RPS control patch (improves IGPU performance).
• -igfxcdc boot argument (enable-cdclk-frequency-fix property) to support all valid Core Display Clock (CDCLK) frequencies on ICL platforms. Read the manual
• -igfxdvmt boot argument (enable-dvmt-calc-fix property) to fix the kernel panic caused by an incorrectly calculated amount of DVMT pre-allocated memory on Intel ICL platforms.
• -igfxblr boot argument (and enable-backlight-registers-fix property) to fix backlight registers on KBL, CFL and ICL platforms.
• -igfxmpc boot argument (enable-max-pixel-clock-override and max-pixel-clock-frequency properties) to increase max pixel clock (as an alternative to patching CoreDisplay.framework).
• -igfxbls boot argument (and enable-backlight-smoother property) to make brightness transitions smoother on IVB+ platforms. Read the manual
• -igfxdbeo boot argument (and enable-dbuf-early-optimizer property) to fix the Display Data Buffer (DBUF) issues on ICL+ platforms. Read the manual
• applbkl=3 boot argument (and applbkl property) to enable PWM backlight control of AMD Radeon RX 5000 series graphic cards read here.

Credits

• Apple for macOS
• AMD for ATOM VBIOS parsing code
• The PCI ID Repository for multiple GPU model names
• Andrey1970AppleLife for FAQs
• FireWolf for the DPCD maximum link rate fix, infinite loop fix for Intel HDMI connections, LSPCON driver support, Core Display Clock frequency fix for ICL platforms, DVMT pre-allocated memory calculation fix for ICL platforms, Backlight Smoother for IVB+ platforms, and Display Data Buffer fix for ICL platforms.
• Floris497 for the CoreDisplay patches
• Fraxul for original CFL backlight patch
• headkaze for Intel framebuffer patching code and CFL backlight patch improvements
• hieplpvip for initial AppleBacklight patching plugin
• igork for power-gating patch discovery and various FP research
• lvs1974 for continuous implementation of Intel and NVIDIA fixing code
• mologie for creating NVWebDriverLibValFix.kext which forces macOS to recognize NVIDIA's web drivers as platform binaries
• PMheart for CoreDisplay patching code and Intel fix backporting
• RehabMan for various enhancements
• RemB for continuing sleep-wake research and finding the right register for AMD issues
• Vandroiy for maintaining the GPU model detection database
• YungRaj and syscl for Intel fix backporting
• vit9696 for writing the software and maintaining it