Add hardware guide

EggToaster · Sep 12, 2020 · bcb3949 · bcb3949
1 parent 7741529
commit bcb3949
Show file tree

Hide file tree

Showing 42 changed files with 458 additions and 31 deletions.
diff --git a/.vuepress/config.js b/.vuepress/config.js
@@ -118,6 +118,7 @@ module.exports = {
                 ],
             },
                 '/installer-guide/opencore-efi',
+                'find-hardware',
                 'ktext',
             ['https://dortania.github.io/Getting-Started-With-ACPI/', 'Getting started with ACPI'],
                 '/config.plist/',

diff --git a/AMD/fx.md b/AMD/fx.md
@@ -108,8 +108,17 @@ Removes device properties from the map, for us we can ignore this
 
 ### Add
 
-Here's where you specify which kexts to load, order matters here so make sure Lilu.kext is always first! Other higher priority kexts come after Lilu such as VirtualSMC, AppleALC, WhateverGreen, etc. A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+Here's where we specific which kexts to load, in what specific order and what architectures this kext is meant for. The main thing you need to keep in mind is:
 
+* Load order
+  * Remember that any plugins should load *after* the master
+  * This means kexts like Lilu **must** come before VirtualSMC, AppleALC, WhateverGreen, etc
+
+A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+
+* **Arch**
+  * Architectures supported by this kext
+  * Currently supported values are `Any`, `i386`(32-bit), `x86_64`(64-bit)
 * **BundlePath**
   * Name of the kext
   * ex: `Lilu.kext`
@@ -347,6 +356,9 @@ System Integrity Protection bitmask
 
 csr-active-config by default is set to `00000000` which enables System Integrity Protection. You can choose a number of different values but overall we recommend keeping this enabled for best security practices. More info can be found in our troubleshooting page: [Disabling SIP](../troubleshooting/troubleshooting.md#disabling-sip)
 
+* **run-efi-updater**: `No`
+  * this is used to prevent Apple's firmware update packages from installing, this is very important especially with PC hardware as these firmware updates will crash on updates.
+
 * **prev-lang:kbd**: <>
   * Needed for non-latin keyboards in the format of `lang-COUNTRY:keyboard`, recommended to keep blank though you can specify it(**Default in Sample config is Russian**):
   * American: `en-US:0`(`656e2d55533a30` in HEX)

diff --git a/AMD/zen.md b/AMD/zen.md
@@ -122,8 +122,17 @@ Removes device properties from the map, for us we can ignore this
 
 ### Add
 
-Here's where you specify which kexts to load, order matters here so make sure Lilu.kext is always first! Other higher priority kexts come after Lilu such as VirtualSMC, AppleALC, WhateverGreen, etc. A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+Here's where we specific which kexts to load, in what specific order and what architectures this kext is meant for. The main thing you need to keep in mind is:
 
+* Load order
+  * Remember that any plugins should load *after* the master
+  * This means kexts like Lilu **must** come before VirtualSMC, AppleALC, WhateverGreen, etc
+
+A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+
+* **Arch**
+  * Architectures supported by this kext
+  * Currently supported values are `Any`, `i386`(32-bit), `x86_64`(64-bit)
 * **BundlePath**
   * Name of the kext
   * ex: `Lilu.kext`
@@ -362,6 +371,9 @@ System Integrity Protection bitmask
 
 csr-active-config by default is set to `00000000` which enables System Integrity Protection. You can choose a number of different values but overall we recommend keeping this enabled for best security practices. More info can be found in our troubleshooting page: [Disabling SIP](../troubleshooting/troubleshooting.md#disabling-sip)
 
+* **run-efi-updater**: `No`
+  * this is used to prevent Apple's firmware update packages from installing, this is very important especially with PC hardware as these firmware updates will crash on updates.
+
 * **prev-lang:kbd**: <>
   * Needed for non-latin keyboards in the format of `lang-COUNTRY:keyboard`, recommended to keep blank though you can specify it(**Default in Sample config is Russian**):
   * American: `en-US:0`(`656e2d55533a30` in HEX)

diff --git a/clover-conversion/Clover-boot-arg.md b/clover-conversion/Clover-boot-arg.md
@@ -41,3 +41,8 @@ For some reason people kept using these flags into Clover which had no effect, a
 **IGPEnabler=Yes/No**
 
 * Same idea as GraphicsEnabler, Clover equivalent is InjectIntel so feature parity would be [WhateverGreen's Framebuffer patching](https://github.com/acidanthera/WhateverGreen/blob/master/Manual/FAQ.IntelHD.en.md)
+
+**-f**
+
+* Enables cacheless booting on Chameleon and Clover, OpenCore has a slightly different option under `Kernel -> Scheme -> KernelCache` and set the entry to `Cacheless`
+  * Currently cacheless booting is only supported on 64-bit kernels from OS X 10.6 to 10.9
diff --git a/clover-conversion/Clover-config.md b/clover-conversion/Clover-config.md
@@ -307,6 +307,8 @@ DUMMY                   <01 00 00 00>
 
 * `DeviceProperties -> Add -> PciRoot... -> device-id`
 * `DeviceProperties -> Add -> PciRoot... -> Family`
+* `DeviceProperties -> Add -> PciRoot... -> NVCAP`
+  * For more info on calculations, see here: [NVCAP.bt](https://github.com/acidanthera/WhateverGreen/blob/master/Manual/NVCAP.bt)
 
 **FakeIntel**:
 
@@ -341,7 +343,8 @@ For others like InjectAti, see the [Sample.dsl](https://github.com/acidanthera/W
 **NVCAP**
 
 * `DeviceProperties -> Add -> PciRoot... -> NVCAP`
-* See [NVCAP-settings](https://github.com/dortania/OpenCore-Install-Guide/blob/master/extra-files/NVCAP-settings.png) for more details, image courtesy of Clover manual
+  * See [NVCAP-settings](https://github.com/dortania/OpenCore-Install-Guide/blob/master/extra-files/NVCAP-settings.png) for more details, image courtesy of Clover manual
+  * For more info on calculations, see here: [NVCAP.bt](https://github.com/acidanthera/WhateverGreen/blob/master/Manual/NVCAP.bt)
 
 **display-cfg**:
 
@@ -376,7 +379,7 @@ For others like InjectAti, see the [Sample.dsl](https://github.com/acidanthera/W
 **RadeonDeInit**:
 
 * [Radeon-Denit-SSDT](https://github.com/dortania/OpenCore-Install-Guide/blob/master/extra-files/Radeon-Deinit-SSDT.dsl)
-* Do note that this is meant for GFX0, adjust for your system
+  * Do note that this is meant for GFX0, adjust for your system
 
 # Kernel and Kext Patches
 
@@ -408,8 +411,7 @@ An odd quirk for Dell systems running APTIO V(or just Skylake, Slice doesn't rea
 
 **ForceKextsToLoad**:
 
-* Not a great solution but injecting the kext "works"
-* See here for more info: [Add ForceKextsToLoad feature to OpenCore #681](https://github.com/acidanthera/bugtracker/issues/681)
+* `Kernel -> Force`
 
 **Kernel LAPIC**:
 

diff --git a/config-HEDT/broadwell-e.md b/config-HEDT/broadwell-e.md
@@ -107,8 +107,17 @@ Removes device properties from the map, for us we can ignore this
 
 ### Add
 
-Here's where you specify which kexts to load, order matters here so make sure Lilu.kext is always first! Other higher priority kexts come after Lilu such as VirtualSMC, AppleALC, WhateverGreen, etc. A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+Here's where we specific which kexts to load, in what specific order and what architectures this kext is meant for. The main thing you need to keep in mind is:
 
+* Load order
+  * Remember that any plugins should load *after* the master
+  * This means kexts like Lilu **must** come before VirtualSMC, AppleALC, WhateverGreen, etc
+
+A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+
+* **Arch**
+  * Architectures supported by this kext
+  * Currently supported values are `Any`, `i386`(32-bit), `x86_64`(64-bit)
 * **BundlePath**
   * Name of the kext
   * ex: `Lilu.kext`
@@ -347,6 +356,9 @@ System Integrity Protection bitmask
 
 csr-active-config by default is set to `00000000` which enables System Integrity Protection. You can choose a number of different values but overall we recommend keeping this enabled for best security practices. More info can be found in our troubleshooting page: [Disabling SIP](../troubleshooting/troubleshooting.md#disabling-sip)
 
+* **run-efi-updater**: `No`
+  * this is used to prevent Apple's firmware update packages from installing, this is very important especially with PC hardware as these firmware updates will crash on updates.
+
 * **prev-lang:kbd**: <>
   * Needed for non-latin keyboards in the format of `lang-COUNTRY:keyboard`, recommended to keep blank though you can specify it(**Default in Sample config is Russian**):
   * American: `en-US:0`(`656e2d55533a30` in HEX)

diff --git a/config-HEDT/haswell-e.md b/config-HEDT/haswell-e.md
@@ -107,8 +107,17 @@ Removes device properties from the map, for us we can ignore this
 
 ### Add
 
-Here's where you specify which kexts to load, order matters here so make sure Lilu.kext is always first! Other higher priority kexts come after Lilu such as VirtualSMC, AppleALC, WhateverGreen, etc. A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+Here's where we specific which kexts to load, in what specific order and what architectures this kext is meant for. The main thing you need to keep in mind is:
 
+* Load order
+  * Remember that any plugins should load *after* the master
+  * This means kexts like Lilu **must** come before VirtualSMC, AppleALC, WhateverGreen, etc
+
+A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+
+* **Arch**
+  * Architectures supported by this kext
+  * Currently supported values are `Any`, `i386`(32-bit), `x86_64`(64-bit)
 * **BundlePath**
   * Name of the kext
   * ex: `Lilu.kext`
@@ -347,6 +356,9 @@ System Integrity Protection bitmask
 
 csr-active-config by default is set to `00000000` which enables System Integrity Protection. You can choose a number of different values but overall we recommend keeping this enabled for best security practices. More info can be found in our troubleshooting page: [Disabling SIP](../troubleshooting/troubleshooting.md#disabling-sip)
 
+* **run-efi-updater**: `No`
+  * this is used to prevent Apple's firmware update packages from installing, this is very important especially with PC hardware as these firmware updates will crash on updates.
+
 * **prev-lang:kbd**: <>
   * Needed for non-latin keyboards in the format of `lang-COUNTRY:keyboard`, recommended to keep blank though you can specify it(**Default in Sample config is Russian**):
   * American: `en-US:0`(`656e2d55533a30` in HEX)

diff --git a/config-HEDT/ivy-bridge-e.md b/config-HEDT/ivy-bridge-e.md
@@ -108,8 +108,17 @@ Removes device properties from the map, for us we can ignore this
 
 ### Add
 
-Here's where you specify which kexts to load, order matters here so make sure Lilu.kext is always first! Other higher priority kexts come after Lilu such as VirtualSMC, AppleALC, WhateverGreen, etc. A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+Here's where we specific which kexts to load, in what specific order and what architectures this kext is meant for. The main thing you need to keep in mind is:
 
+* Load order
+  * Remember that any plugins should load *after* the master
+  * This means kexts like Lilu **must** come before VirtualSMC, AppleALC, WhateverGreen, etc
+
+A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+
+* **Arch**
+  * Architectures supported by this kext
+  * Currently supported values are `Any`, `i386`(32-bit), `x86_64`(64-bit)
 * **BundlePath**
   * Name of the kext
   * ex: `Lilu.kext`
@@ -338,6 +347,9 @@ System Integrity Protection bitmask
 
 csr-active-config by default is set to `00000000` which enables System Integrity Protection. You can choose a number of different values but overall we recommend keeping this enabled for best security practices. More info can be found in our troubleshooting page: [Disabling SIP](../troubleshooting/troubleshooting.md#disabling-sip)
 
+* **run-efi-updater**: `No`
+  * this is used to prevent Apple's firmware update packages from installing, this is very important especially with PC hardware as these firmware updates will crash on updates.
+
 * **prev-lang:kbd**: <>
   * Needed for non-latin keyboards in the format of `lang-COUNTRY:keyboard`, recommended to keep blank though you can specify it(**Default in Sample config is Russian**):
   * American: `en-US:0`(`656e2d55533a30` in HEX)

diff --git a/config-HEDT/skylake-x.md b/config-HEDT/skylake-x.md
@@ -124,8 +124,17 @@ Removes device properties from the map, for us we can ignore this
 
 ### Add
 
-Here's where you specify which kexts to load, order matters here so make sure Lilu.kext is always first! Other higher priority kexts come after Lilu such as VirtualSMC, AppleALC, WhateverGreen, etc. A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+Here's where we specific which kexts to load, in what specific order and what architectures this kext is meant for. The main thing you need to keep in mind is:
 
+* Load order
+  * Remember that any plugins should load *after* the master
+  * This means kexts like Lilu **must** come before VirtualSMC, AppleALC, WhateverGreen, etc
+
+A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+
+* **Arch**
+  * Architectures supported by this kext
+  * Currently supported values are `Any`, `i386`(32-bit), `x86_64`(64-bit)
 * **BundlePath**
   * Name of the kext
   * ex: `Lilu.kext`
@@ -349,6 +358,9 @@ System Integrity Protection bitmask
 
 csr-active-config by default is set to `00000000` which enables System Integrity Protection. You can choose a number of different values but overall we recommend keeping this enabled for best security practices. More info can be found in our troubleshooting page: [Disabling SIP](../troubleshooting/troubleshooting.md#disabling-sip)
 
+* **run-efi-updater**: `No`
+  * this is used to prevent Apple's firmware update packages from installing, this is very important especially with PC hardware as these firmware updates will crash on updates.
+
 * **prev-lang:kbd**: <>
   * Needed for non-latin keyboards in the format of `lang-COUNTRY:keyboard`, recommended to keep blank though you can specify it(**Default in Sample config is Russian**):
   * American: `en-US:0`(`656e2d55533a30` in HEX)

diff --git a/config-laptop.plist/broadwell.md b/config-laptop.plist/broadwell.md
@@ -169,8 +169,17 @@ Removes device properties from the map, for us we can ignore this
 
 ### Add
 
-Here's where you specify which kexts to load, order matters here so make sure Lilu.kext is always first! Other higher priority kexts come after Lilu such as VirtualSMC, AppleALC, WhateverGreen, etc. A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+Here's where we specific which kexts to load, in what specific order and what architectures this kext is meant for. The main thing you need to keep in mind is:
 
+* Load order
+  * Remember that any plugins should load *after* the master
+  * This means kexts like Lilu **must** come before VirtualSMC, AppleALC, WhateverGreen, etc
+
+A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+
+* **Arch**
+  * Architectures supported by this kext
+  * Currently supported values are `Any`, `i386`(32-bit), `x86_64`(64-bit)
 * **BundlePath**
   * Name of the kext
   * ex: `Lilu.kext`
@@ -398,6 +407,9 @@ csr-active-config by default is set to `00000000` which enables System Integrity
 
 * **nvda\_drv**: <>
   * For enabling Nvidia Web Drivers, set to 31 if running a [Maxwell or Pascal GPU](https://github.com/khronokernel/Catalina-GPU-Buyers-Guide/blob/master/README.md#Unsupported-nVidia-GPUs). This is the same as setting nvda\_drv=1 but instead we translate it from [text to hex](https://www.browserling.com/tools/hex-to-text), Clover equivalent is `NvidiaWeb`. **AMD, Intel and Kepler GPU users should delete this section.**
+* **run-efi-updater**: `No`
+  * this is used to prevent Apple's firmware update packages from installing, this is very important especially with PC hardware as these firmware updates will crash on updates.
+
 * **prev-lang:kbd**: <>
   * Needed for non-latin keyboards in the format of `lang-COUNTRY:keyboard`, recommended to keep blank though you can specify it(**Default in Sample config is Russian**):
   * American: `en-US:0`(`656e2d55533a30` in HEX)

diff --git a/config-laptop.plist/coffee-lake-plus.md b/config-laptop.plist/coffee-lake-plus.md
@@ -190,8 +190,17 @@ Removes device properties from the map, for us we can ignore this
 
 ### Add
 
-Here's where you specify which kexts to load, order matters here so make sure Lilu.kext is always first! Other higher priority kexts come after Lilu such as VirtualSMC, AppleALC, WhateverGreen, etc. A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+Here's where we specific which kexts to load, in what specific order and what architectures this kext is meant for. The main thing you need to keep in mind is:
 
+* Load order
+  * Remember that any plugins should load *after* the master
+  * This means kexts like Lilu **must** come before VirtualSMC, AppleALC, WhateverGreen, etc
+
+A reminder that [ProperTree](https://github.com/corpnewt/ProperTree) users can run **Cmd/Ctrl + Shift + R** to add all their kexts in the correct order without manually typing each kext out.
+
+* **Arch**
+  * Architectures supported by this kext
+  * Currently supported values are `Any`, `i386`(32-bit), `x86_64`(64-bit)
 * **BundlePath**
   * Name of the kext
   * ex: `Lilu.kext`
@@ -419,6 +428,9 @@ csr-active-config by default is set to `00000000` which enables System Integrity
 
 * **nvda\_drv**: <>
   * For enabling Nvidia Web Drivers, set to 31 if running a [Maxwell or Pascal GPU](https://github.com/khronokernel/Catalina-GPU-Buyers-Guide/blob/master/README.md#Unsupported-nVidia-GPUs). This is the same as setting nvda\_drv=1 but instead we translate it from [text to hex](https://www.browserling.com/tools/hex-to-text), Clover equivalent is `NvidiaWeb`. **AMD, Intel and Kepler GPU users should delete this section.**
+* **run-efi-updater**: `No`
+  * this is used to prevent Apple's firmware update packages from installing, this is very important especially with PC hardware as these firmware updates will crash on updates.
+
 * **prev-lang:kbd**: <>
   * Needed for non-latin keyboards in the format of `lang-COUNTRY:keyboard`, recommended to keep blank though you can specify it(**Default in Sample config is Russian**):
   * American: `en-US:0`(`656e2d55533a30` in HEX)