OpenCore Post-Install

https://dortania.github.io/OpenCore-Post-Install/
Admin
OpenCore Post-Install is a comprehensive guide providing solutions and configurations for various...
Tokens:40,805
Snippets:455
Trust Score:8.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example GPU Path

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/nvidia-patching

This is an example of the output from gfxutil, showing the PCI root path for a GPU.

```text
67:00.0 10DE:0A20 /PC02@0/BR2A@0/GFX0@0/ = PciRoot(0x2)/Pci(0x0,0x0)/Pci(0x0,0x0)

```

--------------------------------

### Install NVRAM Emulation Script

Source: https://dortania.github.io/OpenCore-Post-Install/misc/nvram.html

After configuring OpenCore and placing the LogoutHook folder, run these commands in the terminal to install the necessary scripts for NVRAM emulation.

```bash
cd /Users/$(whoami)/LogoutHook/
./Launchd.command install
```

--------------------------------

### Extracting Setup Information with ifrextract

Source: https://dortania.github.io/OpenCore-Post-Install/misc/msr-lock.html

Use ifrextract to convert firmware setup data into a human-readable text file. This is a prerequisite for finding CFG Lock offsets.

```bash
path/to/ifrextract path/to/Setup.bin path/to/Setup.txt
```

--------------------------------

### Example gfxutil Output for Audio Device

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

An example of gfxutil output, highlighting how to locate the PciRoot path for a specific audio device based on its PCI ID.

```text
66:00.0 1102:0010 /PC02@0/BR2A@0/SL05@0 = PciRoot(0x32)/Pci(0x0,0x0)/Pci(0x0,0x0)

```

--------------------------------

### Install AMDRyzenCPUPowerManagement.kext for AMD

Source: https://dortania.github.io/OpenCore-Post-Install/universal/sleep.html

Install AMDRyzenCPUPowerManagement.kext to add power management capabilities to Ryzen-based CPUs. Refer to the repository's README for installation and usage instructions.

```bash
AMDRyzenCPUPowerManagement.kext
```

--------------------------------

### Run BootCamp MSI Installer on Windows

Source: https://dortania.github.io/OpenCore-Post-Install/multiboot/bootcamp.html

Alternatively, run the BootCamp.msi installer as Administrator to bypass the SMBIOS model check.

```text
bootcamp-{filename}\BootCamp\Drivers\Apple\BootCamp.msi
```

--------------------------------

### Example Supported Layout IDs for ALC1220

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

This example shows the output for an ALC1220 codec, listing its hardware revision and supported layout IDs.

```text
0x100003, layout 1, 2, 3, 5, 7, 11, 13, 15, 16, 21, 27, 28, 29, 34

```

--------------------------------

### Run BootCamp Setup on Windows

Source: https://dortania.github.io/OpenCore-Post-Install/multiboot/bootcamp.html

Execute the Setup.exe from the BootCamp folder on Windows. This requires correct SMBIOS spoofing.

```text
bootcamp-{filename}\BootCamp\Setup.exe
```

--------------------------------

### IOProviderClass Example

Source: https://dortania.github.io/OpenCore-Post-Install/usb/manual/manual.html

An example of the IOProviderClass value, derived from a CFBundleIdentifier. This property determines the USB driver macOS will use.

```text
AppleUSBXHCIPCI
```

--------------------------------

### Map Display Outputs with BusID Examples

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching/busid.html

Examples of mapping display outputs by iterating through BusID values for different ports and connector types.

```text
[1] busId: 0x05, pipe: 9, type: 0x00000400, flags: 0x000003C7 - DP
[2] busId: 0x04, pipe: 10, type: 0x00000400, flags: 0x000003C7 - DP
[3] busId: 0x06, pipe: 8, type: 0x00000400, flags: 0x000003C7 - DP
01050900 00040000 C7030000
02040A00 00040000 C7030000
03060800 00040000 C7030000
```

```text
01xx0900 **00080000** C7030000
```

```text
02**00**0A00 00040000 C7030000
03**00**0800 00040000 C7030000
```

```text
01**01**0900 00080000 C7030000
01**02**0900 00080000 C7030000
01**03**0900 00080000 C7030000
```

```text
port 1 = `01000900 00040000 C7030000`
port 2 = `02**xx**0A00 00080000 C7030000`
port 3 = `03000800 00040000 C7030000`
```

--------------------------------

### CPUFriend Power Management Data Example

Source: https://dortania.github.io/OpenCore-Post-Install/universal/pm.html

This example shows how to inject modified power management data using CPUFriend. Ensure X86PlatformPlugin is loaded and that Sandy Bridge and AMD CPUs are not used.

```text
plugin-type | Number | 0x1
```

--------------------------------

### macserial example output

Source: https://dortania.github.io/OpenCore-Post-Install/universal/iservices.html

This is an example of the output generated by the macserial command, showing a serial number and a board serial (MLB).

```bash
$ ./macserial \
        --model "iMacPro1,1" 
Warning: arc4random is not available!
C02V7UYGHX87 | C02733401J9JG36A8
```

--------------------------------

### Install NVMeFix.kext for Power Management

Source: https://dortania.github.io/OpenCore-Post-Install/universal/sleep.html

Install NVMeFix.kext to enable proper NVMe power management, as macOS drivers are limited to Apple branded drives.

```bash
NVMeFix.kext
```

--------------------------------

### Setting boot-args for DarkWake

Source: https://dortania.github.io/OpenCore-Post-Install/usb/misc/keyboard.html

Example of combining darkwake flags (HID Tickle Late and Graphics Power State 1) and applying the resulting value to the boot-args in NVRAM.

```text
NVRAM
|---Add
  |---7C436110-AB2A-4BBB-A880-FE41995C9F82
    |---boot-args | Sting | darkwake=514

```

--------------------------------

### Set VRAM Totalsize Property

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/nvidia-patching

Example of how to set the VRAM,totalsize property with the calculated hexadecimal value.

```text
VRAM,totalsize = 0000004000000000

```

--------------------------------

### SSDT-RHUB-MAP Creation Example

Source: https://dortania.github.io/OpenCore-Post-Install/usb/manual/manual.html

Demonstrates the process of creating a custom SSDT-RHUB-MAP by modifying an SSDT file with maciASL and extracting ACPI path information from IOReg.

```markdown
# before modifying
IOService:/AppleACPIPlatformExpert/PC00@0/AppleACPIPCI/RP05@1C,4/IOPP/PXSX@0
```

```markdown
* `IOService:/AppleACPIPlatformExpert/`
  * `@##`
  * `IOPP`
```

```markdown
Once cleaned up, yours should look similar:
```

--------------------------------

### Example IOPathMatch for USB Controller

Source: https://dortania.github.io/OpenCore-Post-Install/usb/manual/manual.html

An example of an IOPathMatch value used in a USB map kext's info.plist. This property tells macOS which device to attach the USB map to.

```text
IOService:/AppleACPIPlatformExpert/PC00@0/AppleACPIPCI/RP05@1C,4/IOPP/PXSX@0/PXSX@01000000
```

--------------------------------

### Set rom-revision Property

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/nvidia-patching

Example of setting the rom-revision property. The value can be arbitrary but the property must exist.

```text
rom-revision = Dortania

```

--------------------------------

### NVCAP Calculation Example

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/nvidia-patching

Example of a calculated NVCAP value. This value is crucial for enabling NVIDIA GPU features and compatibility.

```text
NVCAP: 
05000000 00000300 0c000000 0000000f 00000000
```

--------------------------------

### Get GPU PCI Root with gfxutil

Source: https://dortania.github.io/OpenCore-Post-Install/universal/sleep.html

Use the gfxutil tool to find the PciRoot of your GPU, which is needed for certain DeviceProperties configurations.

```bash
/path/to/gfxutil -f GFX0
```

--------------------------------

### Verify Lilu and AppleALC Installation

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

Run this command in the terminal to check if Lilu, AppleALC, and AppleHDA are loaded. Ensure VoodooHDA is not present as it conflicts with AppleALC.

```bash
kextstat | grep -E "AppleHDA|AppleALC|Lilu"

```

--------------------------------

### USB-A Port Mapping Example

Source: https://dortania.github.io/OpenCore-Post-Install/usb/manual/manual.html

Illustrates the mapping of USB 3.0 and USB 2.0 personalities for a USB-A port. This helps in understanding how macOS identifies different USB port types.

```markdown
3.0 Personality | 2.0 Personality  
---|---  
|   
```

--------------------------------

### Hexadecimal Byte Swapping Example

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

Illustrates how to handle hexadecimal layout IDs greater than 255, where bytes are swapped. For example, layout ID 256 becomes '00 01 00 00'.

```text
00 01 00 00

```

--------------------------------

### Enable AdviseFeatures Quirk

Source: https://dortania.github.io/OpenCore-Post-Install/multiboot/bootcamp.html

Enable the AdviseFeatures quirk in OpenCore's PlatformInfo -> Generic settings to resolve 'You can't change the startup disk to the selected disk' errors, often caused by partition setup issues.

```text
PlatformInfo -> Generic -> AdviseFeatures -> True
```

--------------------------------

### Examples of iServices Entries in Keychain

Source: https://dortania.github.io/OpenCore-Post-Install/universal/iservices.html

This list provides examples of entries to remove from your Keychain related to iServices. Removing these can help resolve issues with Apple ID authentication.

```text
ids: identity-rsa-key-pair-signature-v1
ids: identity-rsa-private-key
ids: identity-rsa-public-key
ids: message-protection-key
ids: message-protection-public-data-registered
ids: personal-public-key-cache
iMessage Encryption Key
iMessage Signing Key
com.apple.facetime: registrationV1
etc ...
```

--------------------------------

### Verify System Information with macserial

Source: https://dortania.github.io/OpenCore-Post-Install/universal/iservices.html

Run the macserial command to get a detailed rundown of your system's serial number and related information. Ensure this matches your intended configuration.

```bash
path/to/macserial -s
```

--------------------------------

### Finding a Compatible Intel iGPU Device ID

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching

Demonstrates finding a similar iGPU's Device ID when the native one is not supported, using the i3-4330's HD 4600 as an example.

```text
Device ID = 0x412
```

--------------------------------

### ACPI Error Example

Source: https://dortania.github.io/OpenCore-Post-Install/universal/pm.html

This error indicates a conflict where a device or method is already declared in your OEM's SSDT.

```text
ACPI Error: Method parse/execution failed [\_SB._INI] , AE_ALREADY_EXIST
```

--------------------------------

### Get Manufacturer from Memory Devices

Source: https://dortania.github.io/OpenCore-Post-Install/universal/memory.html

Use dmidecode to retrieve the Manufacturer for each memory slot.

```bash
path/to/dmidecode -t memory | grep "Manufacturer:"
```

--------------------------------

### Get Memory Size from Devices

Source: https://dortania.github.io/OpenCore-Post-Install/universal/memory.html

Use dmidecode to retrieve the Size of each memory stick in GB and convert to MB. Use 1 for empty slots.

```bash
path/to/dmidecode -t memory | grep "Size:"
#Example Output
 Size: 8 GB
 Size: No Module Installed
 Size: 8 GB
 Size: No Module Installed
 Size: 8 GB
 Size: No Module Installed
 Size: 8 GB
 Size: No Module Installed
# Final Value
Entry 1:  8192
Entry 2:  1
Entry 3:  8192
Entry 4:  1
Entry 5:  8192
Entry 6:  1
Entry 7:  8192
Entry 8:  1
Entry 9:  1
Entry 10: 1
Entry 11: 1
Entry 12: 1
```

--------------------------------

### Calculating New ScanPolicy Value

Source: https://dortania.github.io/OpenCore-Post-Install/universal/security/scanpolicy.html

Example of adding OC_SCAN_ALLOW_DEVICE_USB to the default ScanPolicy. This involves hexadecimal addition and conversion to decimal.

```text
0x00200000 + 0x10F0103 = 0x12F0103
Converting this to decimal gives us 19,857,667
```

--------------------------------

### Get Audio Codec Information on Linux

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

Use the 'cat' command on Linux to retrieve information about your audio codec, which can help in finding compatible layout IDs.

```bash
cat /proc/asound/card0/codec#0 | less

```

--------------------------------

### NVIDIA GPU Device Properties Configuration

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/nvidia-patching

Example configuration for NVIDIA GPU device properties within OpenCore's config.plist. This section is vital for proper GPU recognition and functionality.

```plist
PciRoot(0x2)/Pci(0x0,0x0)/Pci(0x0,0x0)

model          | String | GeForce GT 220
device_type    | String | NVDA,Parent
VRAM,totalsize |  Data  | 0000004000000000
rom-revision   | String | Dortania
NVCAP          |  Data  | 05000000 00000300 0c000000 0000000f 00000000
@0,compatible  | String | NVDA,NVMac
@0,device_type | String | display
@0,name        | String | NVDA,Display-A
@1,compatible  | String | NVDA,NVMac
@1,device_type | String | display
@1,name        | String | NVDA,Display-B
```

--------------------------------

### Get Memory Speed from Devices

Source: https://dortania.github.io/OpenCore-Post-Install/universal/memory.html

Use dmidecode to retrieve the Speed of each memory stick in MHz. Use 1 for empty slots.

```bash
path/to/dmidecode -t memory | grep "Speed:"
#Example Output
 Speed: 2666 MT/s
 Speed: Unknown
 Speed: 2666 MT/s
 Speed: Unknown
 Speed: 2666 MT/s
 Speed: Unknown
 Speed: 2666 MT/s
 Speed: Unknown
# Final Value
Entry 1:  2666
Entry 2:  1
Entry 3:  2666
Entry 4:  1
Entry 5:  2666
Entry 6:  1
Entry 7:  2666
Entry 8:  1
Entry 9:  1
Entry 10: 1
Entry 11: 1
Entry 12: 1
```

--------------------------------

### Get Part Number from Memory Devices

Source: https://dortania.github.io/OpenCore-Post-Install/universal/memory.html

Use dmidecode to retrieve the Part Number for each memory slot. Use 'EmptyDIMM' for empty slots.

```bash
path/to/dmidecode -t memory | grep "Part Number:"
#Example Output
 Part Number: KHX2666C16/8G
 Part Number: NO DIMM
 Part Number: KHX2666C16/8G
 Part Number: NO DIMM
 Part Number: KHX2666C16/8G
 Part Number: NO DIMM
 Part Number: KHX2666C15D4/8G
 Part Number: NO DIMM
# Final Value
Entry 1:  KHX2666C16/8G
Entry 2:  EmptyDIMM
Entry 3:  KHX2666C16/8G
Entry 4:  EmptyDIMM
Entry 5:  KHX2666C16/8G
Entry 6:  EmptyDIMM
Entry 7:  KHX2666C15D4/8G
Entry 8:  EmptyDIMM
Entry 9:  EmptyDIMM
Entry 10: EmptyDIMM
Entry 11: EmptyDIMM
Entry 12: EmptyDIMM
```

--------------------------------

### Get Bank Locator from Memory Devices

Source: https://dortania.github.io/OpenCore-Post-Install/universal/memory.html

Use dmidecode to retrieve the Bank Locator for each memory slot. If 'Not Specified' is returned, leave the entry blank.

```bash
path/to/dmidecode -t memory | grep "Bank Locator:"
```

--------------------------------

### Get Asset Tag from Memory Devices

Source: https://dortania.github.io/OpenCore-Post-Install/universal/memory.html

Use dmidecode to retrieve the Asset Tag for each memory slot. If 'Not Specified' is returned, leave the entry blank.

```bash
path/to/dmidecode -t memory | grep "Asset Tag:"
```

--------------------------------

### Adding Fake Device ID for GMA 950

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/legacy-intel

Example of how to add a fake device ID for GMA 950 (Calistoga) in `config.plist` to enable compatibility.

```yaml
# GMA 950(Calistoga) Fake ID
config.plist:
|-DeviceProperties
 |- Add
  |- PciRoot(0x0)/Pci(0x2,0x0)
   |- device-id | Data | A2270000
```

--------------------------------

### Renaming PCI0.XHC1.RHUB to PC00.RP05.PXSX.RHUB

Source: https://dortania.github.io/OpenCore-Post-Install/usb/manual/manual.html

Before and after examples of renaming a PCI device path in an SSDT file. This is crucial for correctly identifying your USB controller.

```text
External (_SB_.PCI0.XHC1.RHUB, DeviceObj) <- Rename this

Scope (_SB.PCI0.XHC1.RHUB) <- Rename this
```

```text
External (_SB.PC00.RP05.PXSX.RHUB, DeviceObj) <- Renamed

Scope (_SB.PC00.RP05.PXSX.RHUB) <- Renamed
```

--------------------------------

### Get Serial Number from Memory Devices

Source: https://dortania.github.io/OpenCore-Post-Install/universal/memory.html

Use dmidecode to retrieve the Serial Number for each memory slot. Use 'EmptyDIMM' for empty slots.

```bash
path/to/dmidecode -t memory | grep "Serial Number:"
#Example Output
 Serial Number: 0F095257
 Serial Number: NO DIMM
 Serial Number: 0C099A57
 Serial Number: NO DIMM
 Serial Number: 752EDED8
 Serial Number: NO DIMM
 Serial Number: A2032E84
 Serial Number: NO DIMM
# Final Value
Entry 1:  0F095257
Entry 2:  EmptyDIMM
Entry 3:  0C099A57
Entry 4:  EmptyDIMM
Entry 5:  752EDED8
Entry 6:  EmptyDIMM
Entry 7:  A2032E84
Entry 8:  EmptyDIMM
Entry 9:  EmptyDIMM
Entry 10: EmptyDIMM
Entry 11: EmptyDIMM
Entry 12: EmptyDIMM
```

--------------------------------

### Generate ApECID using Python

Source: https://dortania.github.io/OpenCore-Post-Install/universal/security/applesecureboot.html

Use this command to generate a cryptographically secure 64-bit random integer for your ApECID value. Ensure Python 3 is installed.

```bash
python3 -c 'import secrets; print(secrets.randbits(64))'
```

--------------------------------

### Example Framebuffer Information

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching/vram.html

This output shows the memory details for a Haswell Lake Framebuffer, including stolen memory, framebuffer memory, and total VRAM. It is used to identify the current memory allocation and requirements.

```text
ID: 0D220003, STOLEN: 32 MB, FBMEM: 19 MB, VRAM: 1536 MB, Flags: 0x00000402
TOTAL STOLEN: 52 MB, TOTAL CURSOR: 1 MB (1572864 bytes), MAX STOLEN: 116 MB, MAX OVERALL: 117 MB (123219968 bytes)
Camellia: CamelliaDisabled (0), Freq: 5273 Hz, FreqMax: 5273 Hz
Mobile: 0, PipeCount: 3, PortCount: 3, FBMemoryCount: 3
[1] busId: 0x05, pipe: 9, type: 0x00000400, flags: 0x00000087 - ConnectorDP
[2] busId: 0x04, pipe: 10, type: 0x00000400, flags: 0x00000087 - ConnectorDP
[3] busId: 0x06, pipe: 8, type: 0x00000400, flags: 0x00000011 - ConnectorDP
01050900 00040000 87000000
02040A00 00040000 87000000
03060800 00040000 11000000
```

--------------------------------

### Example ACPI Rename Patch: EHC2 to EH02

Source: https://dortania.github.io/OpenCore-Post-Install/usb/system-preparation.html

This patch renames EHC2 to EH02, often necessary for Broadwell and older SMBIOS versions. Apply this to your config.plist under ACPI -> Patch if required.

```plist
<dict>
  <key>Comment</key>
  <string>EHC2 to EH02</string>
  <key>Enabled</key>
  <true/>
  <key>Find</key>
  <data>RUhDMg==</data>
  <key>Replace</key>
  <data>RUhEMDI=</data>
</dict>
```

--------------------------------

### Get Device Locator from Memory Devices

Source: https://dortania.github.io/OpenCore-Post-Install/universal/memory.html

Use dmidecode to retrieve the Device Locator for each memory slot. This is used to identify specific slots like DIMM_A1.

```bash
path/to/dmidecode -t memory | grep "Locator:"
#Example Output
 Locator: DIMM_A1
 Locator: DIMM_A2
 Locator: DIMM_B1
 Locator: DIMM_B2
 Locator: DIMM_C1
 Locator: DIMM_C2
 Locator: DIMM_D1
 Locator: DIMM_D2
# Final Value
Entry 1:  DIMM_A1
Entry 2:  DIMM_A2
Entry 3:  DIMM_B1
Entry 4:  DIMM_B2
Entry 5:  DIMM_C1
Entry 6:  DIMM_C2
Entry 7:  DIMM_D1
Entry 8:  DIMM_D2
Entry 9:  DIMM_EMPTY
Entry 10: DIMM_EMPTY
Entry 11: DIMM_EMPTY
Entry 12: DIMM_EMPTY
```

--------------------------------

### Verify LauncherOption Entry Applied

Source: https://dortania.github.io/OpenCore-Post-Install/multiboot/bootstrap.html

Check OpenCore logs for messages indicating a new boot option was created or the boot order was updated. This confirms LauncherOption is functioning.

```text
OCB: Have existing option 1, valid 1
OCB: Boot order has first option as the default option
```

--------------------------------

### Config.plist DeviceProperties Entry for iGPU

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching

Example of adding the AAPL,ig-platform-id property within the DeviceProperties section of an OpenCore config.plist. This entry specifies the iGPU's PCI path and the byte-swapped framebuffer ID.

```text
Key | Type | Value  
---|---|---  
AAPL,ig-platform-id | Data | 0300220D
```

--------------------------------

### Example ACPI Rename Patch: XHC1 to SHCI

Source: https://dortania.github.io/OpenCore-Post-Install/usb/system-preparation.html

This patch renames XHC1 to SHCI, typically needed for Skylake and older SMBIOS versions. It's configured within the config.plist under ACPI -> Patch.

```plist
<dict>
  <key>Comment</key>
  <string>XHC1 to SHCI</string>
  <key>Enabled</key>
  <true/>
  <key>Find</key>
  <data>WEdIQzE=</data>
  <key>Replace</key>
  <data>U0hDSQ==</data>
</dict>
```

--------------------------------

### Configure layout-id in DeviceProperties (Decimal)

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

Alternatively, you can use the decimal (Number) format for the 'layout-id' property in your config.plist's DeviceProperties. This example uses layout ID 11.

```text
layout-id | Number | <11>

```

--------------------------------

### Intel HD Graphics Framebuffer Profiles

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching

Example framebuffer profiles for Intel HD Graphics 4200-5200 series, including desktop, laptop, and empty framebuffer options. These are used to determine iGPU behavior and display configurations.

```text
Desktop :
 0x0D220003 (default)
Laptop :
 0x0A160000 (default)
 0x0A260005 (recommended)
 0x0A260006 (recommended)
Empty Framebuffer :
 0x04120004 (default)
```

--------------------------------

### Allocate RAM Disk for macOS Personalization (Older Versions)

Source: https://dortania.github.io/OpenCore-Post-Install/universal/security/applesecureboot.html

These commands are used in macOS recovery terminal to allocate a dedicated RAM disk for macOS personalization when installing older versions (10.15 or older) to avoid 'Unable to verify macOS' errors.

```bash
disk=$(hdiutil attach -nomount ram://4096)
diskutil erasevolume HFS+ SecureBoot $disk
diskutil unmount $disk
mkdir /var/tmp/OSPersonalizationTemp
diskutil mount -mountpoint /var/tmp/OSPersonalizationTemp $disk
```

--------------------------------

### Compile and run macserial on Linux

Source: https://dortania.github.io/OpenCore-Post-Install/universal/iservices.html

This snippet shows how to clone the OpenCorePkg repository, navigate to the macserial utility, compile it, and make it executable on a Linux system.

```bash
git clone --depth 1 https://github.com/acidanthera/OpenCorePkg.git
cd ./OpenCorePkg/Utilities/macserial/
make
chmod +x ./macserial
```

--------------------------------

### SSDT Patch for Dell Laptop Black Screen

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/legacy-intel

Example SSDT to patch the DVI device in ACPI for Dell laptops experiencing black screens during boot on macOS. This ensures compatibility by modifying the device's status.

```dsl
DefinitionBlock ("", "SSDT", 2, "DRTNIA", "SsdtDvi", 0x00001000)
{
    External (_SB_.PCI0.SBRG.GFX0.DVI_, DeviceObj)

    Scope (_SB.PCI0.SBRG.GFX0.DVI)
    {
        Method (_STA, 0, NotSerialized)  // _STA: Status
        {
            If (_OSI ("Darwin"))
            {
                Return (0)
            }
            Else
            {
                Return (0x0F)
            }
        }
    }

}
```

--------------------------------

### Kaby Lake HDMI Hotplug Framebuffer Parsing

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching/busid.html

This snippet displays the parsed framebuffer for a Kaby Lake system, highlighting the HDMI port's Bus ID and connector type. It serves as a starting point for diagnosing and fixing HDMI hotplug issues.

```text
ID: 591B0000, STOLEN: 38 MB, FBMEM: 21 MB, VRAM: 1536 MB, Flags: 0x0000130B
TOTAL STOLEN: 39 MB, TOTAL CURSOR: 1 MB (1572864 bytes), MAX STOLEN: 136 MB, MAX OVERALL: 137 MB (144191488 bytes)
Model name: Intel HD Graphics KBL CRB
Camellia: CamelliaDisabled (0), Freq: 1388 Hz, FreqMax: 1388 Hz
Mobile: 1, PipeCount: 3, PortCount: 3, FBMemoryCount: 3
[0] busId: 0x00, pipe: 8, type: 0x00000002, flags: 0x00000098 - ConnectorLVDS
[2] busId: 0x04, pipe: 10, type: 0x00000800, flags: 0x00000187 - ConnectorHDMI
[3] busId: 0x06, pipe: 10, type: 0x00000400, flags: 0x00000187 - ConnectorDP
00000800 02000000 98000000
02040A00 00080000 87010000
03060A00 00040000 87010000
```

--------------------------------

### Patching PciRoot _UID for Kernel Panic Prevention

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/legacy-intel

Example of a bad PciRoot _UID entry that can cause kernel panics on macOS 10.6 and older. The _UID value must be set to Zero to prevent this issue.

```dsl
Device (PCI0)  {
 Name (_HID, EisaId ("PNP0A08")) // Use PNP0A08 to find your PciRoot
 Name (_CID, EisaId ("PNP0A03"))
 Name (_ADR, One)
 Name (_UID, Zero)               // Needs to be patched to Zero

}
```

--------------------------------

### Verifying Lilu and WhateverGreen Kexts

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching

Command to verify if Lilu and WhateverGreen kexts are loaded correctly in macOS.

```bash
kextstat | grep -E "Lilu|WhateverGreen"
```

--------------------------------

### Example ACPI Rename Patch: EHC1 to EH01

Source: https://dortania.github.io/OpenCore-Post-Install/usb/system-preparation.html

This patch renames EHC1 to EH01, commonly required for Broadwell and older SMBIOS versions. Ensure it's correctly added to your config.plist's ACPI -> Patch section.

```plist
<dict>
  <key>Comment</key>
  <string>EHC1 to EH01</string>
  <key>Enabled</key>
  <true/>
  <key>Find</key>
  <data>RUhDMQ==</data>
  <key>Replace</key>
  <data>RUhEMDE=</data>
</dict>
```

--------------------------------

### Verify Lilu and WhateverGreen Injection Success

Source: https://dortania.github.io/OpenCore-Post-Install/universal/drm.html

Examine OpenCore logs to confirm successful pre-link injection of Lilu.kext and WhateverGreen.kext. Failures may indicate configuration issues.

```text
14:354 00:020 OC: Prelink injection Lilu.kext () - Success
14:367 00:012 OC: Prelink injection WhateverGreen.kext () - Success

```

--------------------------------

### Using Boot Argument for DRM

Source: https://dortania.github.io/OpenCore-Post-Install/universal/drm.html

Alternatively, you can use a boot argument to configure DRM decoding. This is often specified in the Shiki mode column of the WhateverGreen DRM chart.

```bash
-shikigva=80
```

--------------------------------

### Compare config.plist with Sample.plist using diff

Source: https://dortania.github.io/OpenCore-Post-Install/universal/update.html

Use the terminal 'diff' command to compare your current config.plist with the new Sample.plist. This helps identify necessary changes for compatibility with the new OpenCore release.

```bash
diff (file input 1) (file input 2)
```

--------------------------------

### Workaround for DC9/DC6 Transition Issues on Ice Lake

Source: https://dortania.github.io/OpenCore-Post-Install/universal/sleep.html

For certain Ice Lake laptops kernel panicking on DC9 transitions, use these boot-args to work around the issue.

```bash
-noDC9
```

```bash
-nodisplaysleepDC6
```

--------------------------------

### OpenCore Injection Logs

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

Examine OpenCore logs to confirm successful or failed injection of Lilu.kext and AppleALC.kext. Look for 'Success' or 'Invalid Parameter' messages.

```text
14:354 00:020 OC: Prelink injection Lilu.kext () - Success
14:367 00:012 OC: Prelink injection AppleALC.kext () - Success
```

```text
15:448 00:007 OC: Prelink injection AppleALC.kext () - Invalid Parameter
```

--------------------------------

### Check Loaded Kexts

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

Verify if Lilu, AppleALC, and AppleHDA are loaded correctly in the system. Ensure VoodooHDA and other conflicting kexts are not present.

```bash
kextstat | grep -E "AppleHDA|AppleALC|Lilu"
```

--------------------------------

### Delay AppleHDAController Initialization

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

Use boot-args or DeviceProperties to delay AppleHDAController initialization by up to 3000ms if hardware is not initialized in time for sound output.

```text
alcdelay=1000
```

```text
alc-delay | Number | 1000
```

--------------------------------

### Download BootCamp Drivers with Brigadier

Source: https://dortania.github.io/OpenCore-Post-Install/multiboot/bootcamp.html

Use Brigadier to download BootCamp drivers. You can specify a particular SMBIOS model if needed.

```bash
path/to/Brigadier --model MacPro7,1
```

--------------------------------

### USBInjectAll for Older Systems

Source: https://dortania.github.io/OpenCore-Post-Install/usb/manual/manual.html

Instructions for using USBInjectAll on Coffee Lake and older systems to address missing USB ports. This involves adding the kext to EFI/OC/Kexts and config.plist.

```markdown
* Coffee Lake and older should use USBInjectAll(opens new window)
    * Don't forget to add this to both EFI/OC/Kexts and you config.plist's kernel -> Add
```

--------------------------------

### Configure layout-id in DeviceProperties (Hexadecimal)

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

Add the 'layout-id' property to your config.plist under DeviceProperties. This example shows the hexadecimal (Data) format for layout ID 11.

```text
layout-id | Data | <0B000000>

```

--------------------------------

### Alternative AAPL,ig-platform-id for Some iGPUs

Source: https://dortania.github.io/OpenCore-Post-Install/universal/sleep.html

This AAPL,ig-platform-id is known to work on some iGPU systems.

```bash
AAPL,ig-platform-id
0300923E
```

--------------------------------

### Test Layout ID using boot-arg

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

Configure your config.plist to test a specific layout ID by setting the 'boot-args' NVRAM variable. Remember to test one ID at a time.

```text
config.plist
├── NVRAM
  ├── Add
    ├── 7C436110-AB2A-4BBB-A880-FE41995C9F82
          ├── boot-args | String | alcid=11

```

--------------------------------

### Configure TSCAdjustReset Kext

Source: https://dortania.github.io/OpenCore-Post-Install/universal/sleep.html

Customizes the TSCAdjustReset kext for HEDT/Server hardware. Modify `IOPropertyMatch -> IOCPUNumber` to the total number of CPU threads starting from 0.

```xml
<key>IOPropertyMatch</key>
<dict>
    <key>IOCPUNumber</key>
    <integer>35</integer>
</dict>
```

--------------------------------

### Finding GPU Device Path with gfxutil

Source: https://dortania.github.io/OpenCore-Post-Install/universal/drm.html

Use the `gfxutil` tool to determine the correct device path for your iGPU or dGPU, which is necessary for injecting properties.

```bash
path/to/gfxutil -f GFX0
```

```bash
path/to/gfxutil -f IGPU
```

--------------------------------

### Calculating and Converting Memory Values

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching/vram.html

This section demonstrates how to convert a desired memory size (e.g., 9MB) into bytes and then into a hexadecimal value, which is necessary for patching. It also shows the hex-swapping process required for injection.

```bash
# Convert 9MB Megabytes to Bytes
echo '9 * 1024 * 1024' | bc
 9437184

# Convert from decimal to hexadecimal
echo 'obase=16; ibase=10; 9437184' | bc
 900000

# Hexswap so it can be injected correctly
# ie. swap in pairs
900000 -> 90 00 00 -> 00 00 90

# Pad the value to 4 bytes with 00 at the end
00 00 90 00
```

--------------------------------

### WhateverGreen Patch Properties

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching/vram.html

These are the key-value pairs used in the config.plist to enable and configure WhateverGreen's VRAM patching. 'framebuffer-patch-enable' activates the patching, while 'framebuffer-stolenmem' and 'framebuffer-fbmem' set the desired memory values.

```text
framebuffer-patch-enable | Data | 01000000
framebuffer-stolenmem | Data | 00003001
framebuffer-fbmem | Data | 00009000
```

--------------------------------

### Find Audio Controller PCI Path

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

Use the gfxutil tool in the macOS terminal to find the PCI path of your audio controller, which is needed for DeviceProperties configuration.

```bash
path/to/gfxutil -f HDEF

```

--------------------------------

### Configure OpenCore config.plist for Password Security

Source: https://dortania.github.io/OpenCore-Post-Install/universal/security/password.html

Add the generated PasswordHash and PasswordSalt to the Misc -> Security section of your `config.plist`. Remember to enable `EnablePassword` to activate the password prompt.

```xml
<key>Misc</key>
<dict>
    <key>Security</key>
    <dict>
        <key>EnablePassword</key>
        <true/>
        <key>PasswordHash</key>
        <string>YOUR_PASSWORD_HASH</string>
        <key>PasswordSalt</key>
        <string>YOUR_PASSWORD_SALT</string>
    </dict>
</dict>
```

--------------------------------

### Identify Audio Device PCI IDs with gfxutil

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

Use gfxutil to find the PCI IDs and PciRoot paths of your audio controllers. This is crucial for advanced AppleALC configurations.

```bash
/path/to/gfxutil

```

--------------------------------

### Force iGPU Displays Online

Source: https://dortania.github.io/OpenCore-Post-Install/universal/sleep.html

For iGPU users on macOS 10.15.4 and newer, this boot-arg forces all displays online to work around broken iGPU wake issues.

```bash
igfxonln=1
```

--------------------------------

### Diagnose WhateverGreen Injection Failure

Source: https://dortania.github.io/OpenCore-Post-Install/universal/drm.html

This log entry indicates a failure during WhateverGreen.kext pre-link injection, often due to an 'Invalid Parameter'. Review kext order and versions.

```text
15:448 00:007 OC: Prelink injection WhateverGreen.kext () - Invalid Parameter

```

--------------------------------

### Calculate LFM Value in Hexadecimal

Source: https://dortania.github.io/OpenCore-Post-Install/universal/pm.html

This command calculates the Low Frequency Mode (LFM) value in hexadecimal, which represents the CPU's multiplier. For example, to find the hex for 1.3GHz (1300Mhz), use '13'.

```bash
echo "obase=16; 13" | bc
```

--------------------------------

### Identify Audio Output Channels in OpenCore Logs

Source: https://dortania.github.io/OpenCore-Post-Install/cosmetic/gui.html

Examine OpenCore debug logs to find the available audio output channels for your codec. This helps in setting the AudioOutMask correctly to direct audio to the desired outputs.

```text
06:065 00:004 OCAU: Matching PciRoot(0x0)/Pci(0x1F,0x3)/VenMsg(A9003FEB-D806-41DB-A491-5405FEEF46C3,00000000)...
06:070 00:005 OCAU: 1/2 PciRoot(0x0)/Pci(0x1F,0x3)/VenMsg(A9003FEB-D806-41DB-A491-5405FEEF46C3,00000000) (5 outputs) - Success
```

--------------------------------

### Find Audio Controller Path with gfxutil

Source: https://dortania.github.io/OpenCore-Post-Install/cosmetic/gui.html

Use gfxutil to locate the PCI device path for your audio controller. This path is required for the AudioDevice setting in OpenCore's UEFI configuration.

```bash
gfxutil -f HDEF
```

--------------------------------

### Uninstalling BootCamp Drivers with msiexec

Source: https://dortania.github.io/OpenCore-Post-Install/multiboot/bootcamp.html

Use this command to uninstall existing BootCamp drivers, which can sometimes resolve issues with Windows startup disk visibility.

```bash
msiexec.exe /x "c:\filename.msi"
```

--------------------------------

### Check for EHC1 and EHC2 Devices using ioreg

Source: https://dortania.github.io/OpenCore-Post-Install/usb/system-preparation.html

These commands query the I/O Registry for EHC1 and EHC2 devices. If any output is displayed, the corresponding ACPI renames are likely required for your system.

```bash
ioreg -l -p IOService -w0 | grep -i EHC1
ioreg -l -p IOService -w0 | grep -i EHC2
```

--------------------------------

### Verify NVRAM Functionality

Source: https://dortania.github.io/OpenCore-Post-Install/misc/nvram.html

Use these terminal commands to test if your system's NVRAM is working correctly. The first command sets a variable, and the second retrieves it.

```bash
sudo nvram myvar="$(date)"
```

```bash
nvram myvar
```

--------------------------------

### Formatting Device ID for Injection

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching

Explains the process of padding and hex-swapping a Device ID to prepare it for injection into the config.plist.

```text
# First, remove 0x and pad it to 8 bits by using 0's in front of it
0x412 -> 00 00 04 12

# Next reverse it, but keep the pairs in tact
00 00 04 12 -> 12 04 00 00

# And voila, you have your device-id
12040000 = device-id

```

--------------------------------

### Configure OpenCore ScanPolicy

Source: https://dortania.github.io/OpenCore-Post-Install/multiboot/bootcamp.html

Set the ScanPolicy to 0 in OpenCore's Misc -> Security settings to ensure all drives are shown in the picker.

```text
Misc -> Security -> ScanPolicy
```

--------------------------------

### WhateverGreen Native Supported DevIDs

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching

Lists the Device IDs natively supported by WhateverGreen for Intel iGPUs.

```text
Native supported DevIDs:

 0x0d26
 0x0a26
 0x0a2e
 0x0d22
 0x0412

```

--------------------------------

### OpenCore config.plist iServices keys

Source: https://dortania.github.io/OpenCore-Post-Install/universal/iservices.html

This XML snippet shows how to configure the necessary keys in your OpenCore config.plist file for iServices functionality, including MLB, ROM, SystemProductName, SystemSerialNumber, and SystemUUID.

```xml
    <key>MLB</key>
    <string>C02733401J9JG36A8</string>
    <key>ROM</key>
    <data>0016cb001122</data>
    <key>SpoofVendor</key>
    <true/>
    <key>SystemProductName</key>
    <string>iMacPro1,1</string>
    <key>SystemSerialNumber</key>
    <string>C02V7UYGHX87</string>
    <key>SystemUUID</key>
    <string>976AA603-75FC-456B-BC6D-9011BFB4968E</string>
```

--------------------------------

### Personalize Volume for Secure Boot

Source: https://dortania.github.io/OpenCore-Post-Install/universal/security/applesecureboot.html

Run this command in macOS recovery after setting your ApECID to personalize the volume. An active network connection is required.

```bash
# Run this command after setting your ApECID value
# You'll also need an active network connection in recovery to run this command
bless --folder "/Volumes/Macintosh HD/System/Library/CoreServices" --bootefi --personalize
```

--------------------------------

### Configure OpenCore BlessOverride

Source: https://dortania.github.io/OpenCore-Post-Install/multiboot/bootcamp.html

Add a BlessOverride entry for Microsoft's bootloader if Windows and OpenCore are on the same drive. Note: This may not be necessary in OpenCore 0.5.9 and later.

```text
Misc -> BlessOverride -> \EFI\Microsoft\Boot\bootmgfw.efi
```

--------------------------------

### Generate serial and board serial with macserial

Source: https://dortania.github.io/OpenCore-Post-Install/universal/iservices.html

Use the compiled macserial utility to generate a specified number of serial and board serial (MLB) pairs for a given SystemProductName.

```bash
./macserial --num 1 --model "iMacPro1,1"
```

--------------------------------

### Convert VRAM to Hexadecimal and Swap

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/nvidia-patching

Convert VRAM size from megabytes to bytes, then to hexadecimal, and finally perform a hex swap for correct injection.

```bash
# Convert 1024MB Megabytes to Bytes
echo '1024 * 1024 * 1024' | bc
 1073741824

# Convert from decimal to hexadecimal
echo 'obase=16; ibase=10; 1073741824' | bc
 40000000

# Hexswap so it can be injected correctly
# ie. swap in pairs
40000000 -> 40 00 00 00 -> 00 00 00 40

# Pad the value to 8 bytes with 00 at the end
00 00 00 40 00 00 00 00

```

--------------------------------

### Patching Intel GPU Connector Properties

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching/connector.html

Apply these properties under `DeviceProperties -> Add -> PciRoot(0x0)/Pci(0x2,0x0)` to enable WhateverGreen's patching mechanism and set a specific connector type, such as HDMI.

```plist
<01000000>        // framebuffer-patch-enable
<01000000>        // framebuffer-con1-enable
<00080000>        // framebuffer-con1-type (HDMI)
```

--------------------------------

### Alternative AAPL,ig-platform-id for Desktop Coffee Lake

Source: https://dortania.github.io/OpenCore-Post-Install/universal/sleep.html

Desktop Coffee Lake (UHD 630) users may need to try an alternative AAPL,ig-platform-id if the default fails.

```bash
AAPL,ig-platform-id
00009B3E
```

--------------------------------

### Windows BootCamp Driver Path

Source: https://dortania.github.io/OpenCore-Post-Install/multiboot/bootcamp.html

Locate the extracted BootCamp drivers on Windows after using Brigadier.

```text
\Users\{Username}\bootcamp-{filename}\BootCamp
```

--------------------------------

### Generate OpenCore Menu Password

Source: https://dortania.github.io/OpenCore-Post-Install/universal/security/password.html

Use the `ocpasswordgen` tool to generate the necessary PasswordHash and PasswordSalt for your OpenCore menu password. Ensure you are using OpenCore 0.6.7 or newer.

```bash
cd /path/to/OpenCore/Utilities/ocpasswordgen/
./ocpasswordgen
```

--------------------------------

### Create Fake ACPI Device for USB Wake

Source: https://dortania.github.io/OpenCore-Post-Install/usb/misc/keyboard.html

This snippet demonstrates how to define a fake ACPI device for USB wake functionality. It requires the ACPI path of your USB controller and the USBWakeFixup.kext.

```dsl
DefinitionBlock ("SSDT-USBW.aml", "DSDT", 0x01, "~ACEL", "USBW", 0x00000000)
{
    External (_SB_.PC00.XHCI, DeviceObj)

    Scope (_SB.PC00.XHCI)
    {
        Method (_DSM, 4, NotSerialized)
        {
            If (_OSI ("Darwin"))
            {
                Return (Package (0x01)
                {
                    0x03
                })
            }
            Else
            {
                Return (Package (0x01)
                {
                    0x00
                })
            }
        }
    }
}
```

--------------------------------

### Extract PciRoot Path for Audio Device

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

The extracted PciRoot path from gfxutil output, used for configuring audio devices in config.plist.

```text
PciRoot(0x32)/Pci(0x0,0x0)/Pci(0x0,0x0)

```

--------------------------------

### UPRW to XPRW ACPI Patch

Source: https://dortania.github.io/OpenCore-Post-Install/usb/misc/instant-wake.html

Use this patch when your ACPI methods include 'Method (UPRW, 2'. It addresses instant wake issues stemming from USB power state changes.

```text
UPRW to XPRW Patch
```

--------------------------------

### Apply Framebuffer Patches

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching/busid.html

Apply these patches to enable and configure framebuffer settings, including index and BusID.

```plist
framebuffer-patch-enable | Data | `01000000`
framebuffer-con2-enable  | Data | `01000000`
framebuffer-con2-index   | Data | `01`
framebuffer-con2-busid   | Data | `05`
```

--------------------------------

### Configure External Audio Device in config.plist

Source: https://dortania.github.io/OpenCore-Post-Install/universal/audio.html

Add a DeviceProperties entry to ignore or patch a specific external audio controller, preventing conflicts with onboard audio.

```text
DeviceProperties
| --- > Add
 | --- > PciRoot(0x32)/Pci(0x0,0x0)/Pci(0x0,0x0)
  | ----> external-audio | Data | 01

```

--------------------------------

### macOS BootCamp Driver Path

Source: https://dortania.github.io/OpenCore-Post-Install/multiboot/bootcamp.html

Locate the extracted BootCamp drivers on macOS after using Brigadier.

```text
/Users/{Username}/BootCamp-{filename}/WindowsSupport.dmg
```

--------------------------------

### Adding Device ID to config.plist

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching

Shows how to add the formatted device-id to your config.plist under the PciRoot(0x0)/Pci(0x2,0x0) path.

```text
Key | Type | Value  
---|---|--  
device-id | Data | 12040000  
```

--------------------------------

### Extracting Intel iGPU Device ID

Source: https://dortania.github.io/OpenCore-Post-Install/gpu-patching/intel-patching

Shows how to find the raw Device ID for an Intel iGPU using Intel's ARK page.

```text
Device ID = 0x41E
```

--------------------------------

### Determine Memory Size in MB

Source: https://dortania.github.io/OpenCore-Post-Install/universal/memory.html

Provides a reference for converting memory sizes (GB) to megabytes (MB) for configuration. Use 1 for empty slots.

```text
1GB  - 1024
2GB  - 2048
4GB  - 4096
8GB  - 8192
16GB - 16384
32GB - 32768
64GB - 65536
12GB - 131072
```

--------------------------------

### SSDT-RHUB for Newer Systems and AMD

Source: https://dortania.github.io/OpenCore-Post-Install/usb/manual/manual.html

Guidance on using SSDT-RHUB for Comet Lake and newer systems, as well as AMD systems, to reset USB controllers and force macOS to reenumerate them.

```markdown
* Comet Lake and newer should use SSDT-RHUB
  * AMD systems should also use SSDT-RHUB
```
Tokens:
Raw