mirrors/x1c6-hackintosh
1
0
Fork 0
mirror of https://github.com/tylernguyen/x1c6-hackintosh.git synced 2025-02-05 09:33:13 -06:00
Code Issues Releases Activity

Fixed issue #42 and formatted md docs

Browse source
This commit is contained in:
Tyler Nguyen 2020-04-05 19:00:52 -05:00
parent ee22c817fd
commit 24f0a7afb7
No known key found for this signature in database
GPG key ID: DB5B102B914991DA
12 changed files with 458 additions and 324 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
EFI-OpenCore/EFI/OC/ACPI/SSDT-Keyboard.aml
View file

Binary file not shown.

4
EFI-OpenCore/README.md
View file

@ -1,4 +1,5 @@
# Configurating OpenCore for your x1c6
<img align="right" src="https://i.imgur.com/u2Nukp7.png" alt="Critter" width="200">
## OpenCore is better than Clover in [many ways](https://khronokernel-2.gitbook.io/opencore-vanilla-desktop-guide/). But since it is still in its infancy, OpenCore still requires a lot of time and personal confgurations to work. So even though I have posted my EFI-OpenCore folder, there are still some work which you have to do before you are able to get it working on your machine.
@ -7,7 +8,6 @@
I do, however, understand if you are strapped for time. So here are the necessary changes to my uploaded configs that would get your machine working. In most cases, your machine should boot with OpenCore after these changes. However, if it does not. please refer to acidanthera's OpenCore documentation.
SystemUUID: Can be generated with MacSerial or use pervious from Clover's config.plist.
MLB: Can be generated with MacSerial or use pervious from Clover's config.plist.
ROM: ROM must either be Apple ROM (dumped from a real Mac), or your NIC MAC address, or any random MAC address (could be just 6 random bytes) - Vit9696
@ -16,12 +16,14 @@ SystemSerialNumber: Can be generated with MacSerial or use pervious from Clover'
CPUFriendDataProvider: Can be generated with [CPUFriendFriend](https://github.com/corpnewt/CPUFriendFriend_ or [one-key-cpufriend](https://github.com/stevezhengshiqi/one-key-cpufriend). Even if you have the same CPU as me, you may prefer a different Energy Performance Preference (EPP) so do generate your own CPUFriendDataProvider. This is furhtermore important if you have a different CPU than me.
> ## Important Note:
Unlike Clover, where SSDT patches are only being applied when booting macOS. OpenCore will apply SSDT patches regardless of the operating system. This is critical when multi-booting, since Windows and Linux do not need the additional patches that macOS does. In many cases, if Windows/Linux fails to boot under OpenCore, it is likely that your macOS intended SSDT patch(s) is being applied universally. To prevent OpenCore from doing this, it is important that your SSDT patches specify its intended OS, which in our case is "Darwin."
See highlighted example:
![OpenCore SSDT patching notice](https://raw.githubusercontent.com/tylernguyen/x1c6-hackintosh/master/docs/assets/img/OpenCore%20SSDT%20patching%20notice.png)
> ## Checking your OpenCore config.plist
It is important to keep your OpenCore config.plist properly up-to-spec, as OpenCore configurations tend to change accordingly with OpenCore versions. A good resource to check your config plist is https://opencore.slowgeek.com/.
> ## Updating:

1
EFI-install_USB/README.md
View file

@ -1,4 +1,5 @@
# OpenCore Configuration for the Install Drive
<img align="right" src="https://i.imgur.com/u2Nukp7.png" alt="Critter" width="200">
## This OpenCore configuration is purposely kept bareboned. Its sole purpose is for installing and booting macOS first time. Please refer to my `EFI-Opencore` folder the OpenCore configuration intended for daily use.

75
README.md
View file

@ -1,4 +1,5 @@
# macOS on Thinkpad X1 Carbon 6th Generation, Model 20KH*
# macOS on Thinkpad X1 Carbon 6th Generation, Model 20KH\*
[![macOS](https://img.shields.io/badge/macOS-Catalina-yellow.svg)](https://github.com/996icu/996.ICU/blob/master/LICENSE)
[![BIOS](https://img.shields.io/badge/BIOS-1.43-blue)](https://github.com/996icu/996.ICU/blob/master/LICENSE)
[![MODEL](https://img.shields.io/badge/Model-20KH*-blue)](https://github.com/996icu/996.ICU/blob/master/LICENSE)
@ -8,9 +9,13 @@
<img align="right" src="https://i.imgur.com/I3yUS4Q.png" alt="Critter" width="300">
### Check out my blog [tylerspaper.com](https://tylerspaper.com/)
#### READ THE ENTIRE README.MD BEFORE YOU START.
#### I AM NOT RESPONSIBLE FOR ANY DAMAGES YOU MAY CAUSE.
#### IF YOU IMRPOVE UPON ANYTHING HERE, PLEASE CONTRIBUTE BY OPENING AN ISSUE OR A PULL REQUEST.
`I AM A ONE MAN TEAM, AND A FULL TIME STUDENT. SO, I MIGHT NOT BE ABLE TO RESPOND OR HELP YOU IN A TIMELY MANNER. BUT, I PROMISE I WILL GET TO YOU EVENTUALLY. PLEASE UNDERSTAND.`
`Lastly, if my work here helped you. Please consider donating, it would mean a lot to me.`
@ -18,31 +23,39 @@
> ## Update
##### Recent | [Changelog Archive](https://github.com/tylernguyen/x1c6-hackintosh/docs/CHANGELOG.md)
> ### 2020-4-1
#### Added
* ALCPlugFix to automatically change output to headphones after being plugged in, and to change it back to speakers after being unplugged.
* ALCPlugFix to fix the rare condition that audio is messed up after waking from sleep.
- ALCPlugFix to automatically change output to headphones after being plugged in, and to change it back to speakers after being unplugged.
- ALCPlugFix to fix the rare condition that audio is messed up after waking from sleep.
#### Changed
* More documentation about recommended macOS settings.
- More documentation about recommended macOS settings.
> ## SUMMARY:
| Fully functional | Non-functional | Semi-functional. Additional pulls needed and welcomed. |
|-------------------------------------------------------------------|----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| WiFi, Bluetooth, Apple Continuity ✅ \*need card replacement| Fingerprint Reader (not needed, DISABLED at BIOS) ❌| HDMI, currently only outputs at 1080p.Though capable of 4K 4096x2150. ⚠️|
| USB A, USB C, Webcam, Audio Playback/Recording Sleep, Ethernet, Intel Graphics, TrackPoint and Trackpad ✅ | Wireless WAN (DISABLED at BIOS) *ENABLED if you have a 2nd drive connected❌ | Thunderbolt 3 Hotplug: partially working [More details](https://github.com/tylernguyen/x1c6-hackintosh/issues/24#issuecomment-603183002) ⚠️|
| iCloud suite: App Store, iMessage, FaceTime, iCloud Drive, etc... ✅ | Hibernation ❌ | Power management and optimizations. See [Issue #28](https://github.com/tylernguyen/x1c6-hackintosh/issues/28) ⚠️|
| Multimedia Fn keys ✅ *need [Karabiner Elements](https://ke-complex-modifications.pqrs.org/) and [BetterTouchTool](https://folivora.ai/) | | USB power property injection - unsure of real values. ⚠️|
| MicroSD card reader ✅| | |
| Fully functional | Non-functional | Semi-functional. Additional pulls needed and welcomed. |
| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| WiFi, Bluetooth, Apple Continuity ✅ \*need card replacement | Fingerprint Reader (not needed, DISABLED at BIOS) ❌ | HDMI, currently only outputs at 1080p.Though capable of 4K 4096x2150. ⚠️ |
| USB A, USB C, Webcam, Audio Playback/Recording Sleep, Ethernet, Intel Graphics, TrackPoint and Trackpad ✅ | Wireless WAN (DISABLED at BIOS) \*ENABLED if you have a 2nd drive connected❌ | Thunderbolt 3 Hotplug: partially working [More details](https://github.com/tylernguyen/x1c6-hackintosh/issues/24#issuecomment-603183002) ⚠️ |
| iCloud suite: App Store, iMessage, FaceTime, iCloud Drive, etc... ✅ | Hibernation ❌ | Power management and optimizations. See [Issue #28](https://github.com/tylernguyen/x1c6-hackintosh/issues/28) ⚠️ |
| Multimedia Fn keys ✅ \*need [Karabiner Elements](https://ke-complex-modifications.pqrs.org/) and [BetterTouchTool](https://folivora.ai/) | | USB power property injection - unsure of real values. ⚠️ |
| MicroSD card reader ✅ | | |
> ## NEEDED:
A macOS machine would be VERY useful: to create install drives, and for when your ThinkPad cannot boot. Though it is not completely necessary.
Flash drive, 16GB or more.
Xcode works fine, but I prefer [PlistEdit Pro](https://www.fatcatsoftware.com/plisteditpro/).
Xcode works fine, but I prefer [PlistEdit Pro](https://www.fatcatsoftware.com/plisteditpro/).
[MaciASL](https://github.com/acidanthera/MaciASL), for patching ACPI tables.
[IOJones](https://github.com/acidanthera/IOJones), for diagnosis.
[Hackintool](https://www.insanelymac.com/forum/topic/335018-hackintool-v286/), for diagnosis.
> ## WHERE TO START:
Explore links included this README, especially those in references and other x1c6-hackintosh repos.
Once you are ready, follow the series of README files included `docs/`.
@ -52,16 +65,18 @@ Once you are ready, follow the series of README files included `docs/`.
[**4_README-ACPIpatching**](https://github.com/tylernguyen/x1c6-hackintosh/blob/master/docs/4_README-ACPIpatching.md): The hardest and most time consuming part, patching the system ACPI table for battery status, brightness, sleep, thunderbolt, thunderbolt hotplugging, etc...
[**5_README-other.md**](https://github.com/tylernguyen/x1c6-hackintosh/blob/master/docs/5_README-other.md): for other notices
* While you can plug-and-play most of my hotpatches if you have an x1c6, I still suggest that you dump and disassemble your own DSDT. This is imprortant as your DSDT maybe different from mine. And furthermore, you get to learn more about what's actually going on.
- While you can plug-and-play most of my hotpatches if you have an x1c6, I still suggest that you dump and disassemble your own DSDT. This is imprortant as your DSDT maybe different from mine. And furthermore, you get to learn more about what's actually going on.
> ## MY SPECIFICATIONS:
Refer to [x1c6-Platform_Specifications](https://github.com/tylernguyen/x1c6-hackintosh/blob/master/docs/references/x1c6-Platform_Specifications.pdf) for possible stock ThinkPad X1 6th Gen configurations.
| Processor Number | # of Cores | # of Threads | Base Frequency | Max Turbo Frequency | Cache | Memory Types | Graphics |
|:--|:--|:--|:--|:--|:--|:--|:--|
| [i7-8650U](https://ark.intel.com/content/www/us/en/ark/products/124968/intel-core-i7-8650u-processor-8m-cache-up-to-4-20-ghz.html) | 4 | 8 | 1.9 GHz | 4.2 GHz | 8 MB | LPDDR3-2133 | Intel UHD 620 |
| Processor Number | # of Cores | # of Threads | Base Frequency | Max Turbo Frequency | Cache | Memory Types | Graphics |
| :--------------------------------------------------------------------------------------------------------------------------------- | :--------- | :----------- | :------------- | :------------------ | :---- | :----------- | :------------ |
| [i7-8650U](https://ark.intel.com/content/www/us/en/ark/products/124968/intel-core-i7-8650u-processor-8m-cache-up-to-4-20-ghz.html) | 4 | 8 | 1.9 GHz | 4.2 GHz | 8 MB | LPDDR3-2133 | Intel UHD 620 |
**Peripherals:**
```
Two USB 3.1 Gen 1 (Right USB Always On)
Two USB 3.1 Type-C Gen 2 / Thunderbolt 3 (Max 5120x2880 @60Hz)
@ -71,6 +86,7 @@ No WWAN
TrackPoint: PS/2
TrackPad: PS/2
```
**Display:**
`14.0" (355mm) HDR WQHD (2560x1440)`
**Audio:**
@ -78,33 +94,38 @@ TrackPad: PS/2
**Thunderbolt:**
`Intel JHL6540 (Alpine Ridge 4C) Thunderbolt 3 Bridge`
> ## REFERENCES:
* [The Vanilla Laptop Guide](https://fewtarius.gitbook.io/laptopguide/)
* Daliansky's [Hackintool tutorial](https://translate.google.com/translate?js=n&sl=auto&tl=en&u=https://blog.daliansky.net/Intel-FB-Patcher-tutorial-and-insertion-pose.html).
* [An iDiot's Guide To Lilu and its Plug-ins](https://www.tonymacx86.com/threads/an-idiots-guide-to-lilu-and-its-plug-ins.260063/)
* [General Framebuffer Patching Guide (HDMI Black Screen Problem)](https://www.tonymacx86.com/threads/guide-general-framebuffer-patching-guide-hdmi-black-screen-problem.269149/)
* [Intel Framebuffer patching using WhateverGreen](https://www.tonymacx86.com/threads/guide-intel-framebuffer-patching-using-whatevergreen.256490/)
- [The Vanilla Laptop Guide](https://fewtarius.gitbook.io/laptopguide/)
- Daliansky's [Hackintool tutorial](https://translate.google.com/translate?js=n&sl=auto&tl=en&u=https://blog.daliansky.net/Intel-FB-Patcher-tutorial-and-insertion-pose.html).
- [An iDiot's Guide To Lilu and its Plug-ins](https://www.tonymacx86.com/threads/an-idiots-guide-to-lilu-and-its-plug-ins.260063/)
- [General Framebuffer Patching Guide (HDMI Black Screen Problem)](https://www.tonymacx86.com/threads/guide-general-framebuffer-patching-guide-hdmi-black-screen-problem.269149/)
- [Intel Framebuffer patching using WhateverGreen](https://www.tonymacx86.com/threads/guide-intel-framebuffer-patching-using-whatevergreen.256490/)
> ## OTHER x1c6-hackintosh REPOSITORIES:
[zhtengw/EFI-for-X1C6-hackintosh](https://github.com/zhtengw/EFI-for-X1C6-hackintosh)
[Colton-Ko/macOS-ThinkPad-X1C6](https://github.com/Colton-Ko/macOS-ThinkPad-X1C6)
Create a pull request if you like to be added, final decision at my discreation.
> ## OPTIMIZATIONS:
* Repaste the machine with thermal [Grizzly Kryonaut](https://www.thermal-grizzly.com/en/products/16-kryonaut-en).
* Undervolt the machine with [Volta](https://volta.garymathews.com/).
* If you must dual boot with Windows or Linux, I advise against paritition. What I recommend, instead, is getting a second compatible hard drive that fits in the WWAN card slot (I have the WDC PC SN520 NVMe 2242), install Windows/Linux onto that drive. Finally, boot into it with Clover or OpenCore.
* If your laptop did not come with WWAN, you can purchase additional antennas to add to your laptop. This is useful when using Wifi/Bluetooth cards that have 3 antennas.
- Repaste the machine with thermal [Grizzly Kryonaut](https://www.thermal-grizzly.com/en/products/16-kryonaut-en).
- Undervolt the machine with [Volta](https://volta.garymathews.com/).
- If you must dual boot with Windows or Linux, I advise against paritition. What I recommend, instead, is getting a second compatible hard drive that fits in the WWAN card slot (I have the WDC PC SN520 NVMe 2242), install Windows/Linux onto that drive. Finally, boot into it with Clover or OpenCore.
- If your laptop did not come with WWAN, you can purchase additional antennas to add to your laptop. This is useful when using Wifi/Bluetooth cards that have 3 antennas.
> ## CONTACT:
https://tylerspaper.com/contact
Signal: (202)-644-9951 *This is a Signal ONLY number. You will not get a reply of you text me at this number.
Signal: (202)-644-9951 \*This is a Signal ONLY number. You will not get a reply of you text me at this number.
> ## DONATE AND SUPPORT:
https://tylerspaper.com/support/
> ## Credits and Thank You:
[@Colton-Ko](https://github.com/Colton-Ko/macOS-ThinkPad-X1C6) for the great features template.
[@stevezhengshiqi](https://github.com/stevezhengshiqi) for the one-key-cpufriend script.
[@corpnewt](https://github.com/corpnewt) for CPUFriendFriend.

51
docs/1_README-HARDWAREandBIOS.md
View file

@ -1,36 +1,41 @@
> ## Hardware:
### WiFi and Bluetooth:
Replace factory Intel wifi module with a macOS compatible one. Make sure that the card is of M.2 form factor. I replaced it with the BCM94360CS2 card. This works out of the box without additional kexts and has been stable for me thus far.
- The BCM94360CS2 module comes from the 2013 MacBook Air, supports BT 4.0 and 802.11a/g/n/ac. They run on eBay for <$15.
- For the BCM94360CS2 to work with the x1c6, you would also need a M.2 NGFF adapter. They run for <$10 on eBay under "BCM94360CS2 m2 adapter"
- The BCM94360CS2 module comes from the 2013 MacBook Air, supports BT 4.0 and 802.11a/g/n/ac. They run on eBay for <\$15.
- For the BCM94360CS2 to work with the x1c6, you would also need a M.2 NGFF adapter. They run for <\$10 on eBay under "BCM94360CS2 m2 adapter"
However, there exists other alternatives with better WiFi and Bluetooth standards, but require additional kexts to work:
* Dell DW1820a 802.11 AC Wireless Network & Bluetooth 4.1 LE NGFF Card! Includes Revisions:
- CV-OVW3T3
- CN-096JNT
- CN-0VW3T3
- CN-08PKF4, the "CN-08PKF4" model is reported to have the most successes, so make sure to look for that specifically.
* Lenovo 00JT493 802.11 AC Wireless Network & Bluetooth 4.1 LE NGFF Card.
* Foxcon T77H649 802.11 AC Wireless Network & Bluetooth 4.1 LE NGFF Card.
- Dell DW1820a 802.11 AC Wireless Network & Bluetooth 4.1 LE NGFF Card! Includes Revisions:
- CV-OVW3T3
- CN-096JNT
- CN-0VW3T3
- CN-08PKF4, the "CN-08PKF4" model is reported to have the most successes, so make sure to look for that specifically.
- Lenovo 00JT493 802.11 AC Wireless Network & Bluetooth 4.1 LE NGFF Card.
- Foxcon T77H649 802.11 AC Wireless Network & Bluetooth 4.1 LE NGFF Card.
### M.2 Hard Drive Replacements:
* macOS cannot be installed on the factory installed PM981 drive. Replace macOS-incompatible factory Samsung PM981 with preferably another M.2 drive.
* NVMeFix](https://github.com/acidanthera/NVMeFix) is still in its early stage. However, it has dramtically improved NVMe power management. In my personal experience, it is no longer far from SATA power consumption. I now recommend that you go with an NVMe SSD for the faster speed.
* An additional hard drive can be installed in the WAN slot. It can be used for a cleaner dual boot experience, or simply as a backup or storage drive.
- macOS cannot be installed on the factory installed PM981 drive. Replace macOS-incompatible factory Samsung PM981 with preferably another M.2 drive.
- NVMeFix](https://github.com/acidanthera/NVMeFix) is still in its early stage. However, it has dramtically improved NVMe power management. In my personal experience, it is no longer far from SATA power consumption. I now recommend that you go with an NVMe SSD for the faster speed.
- An additional hard drive can be installed in the WAN slot. It can be used for a cleaner dual boot experience, or simply as a backup or storage drive.
> ## BIOS:
| Main Menu | Sub 1 | Sub 2 | Sub 3 |
| --------- | ----- | ----- | ----- |
| Config | >> Security | >> Security Chip | Security Chip `DISABLED` |
| | | >> Fingerprint | Predesktop Authentication `DISABLED` |] |
| | | >> I/O Port Access | Wireless WAN `DISABLED` *ENABLED if you have a 2nd drive attached|
| | | | Fingerprint Reader `DISABLED` |
| | | >> Secure Boot Configuration | Secure Boot `DISABLED` |
| | | >> Intel SGX | Intel SGX Control `DISABLED` |
| | >> Startup | UEFI/Legacy Boot `UEFI Only` | |
| | | CSM Support `No` (per OpenCore Documentation) | |
>
> | Main Menu | Sub 1 | Sub 2 | Sub 3 |
> | --------- | ----------- | --------------------------------------------- | ------------------------------------------------------------------ |
> | Config | >> Security | >> Security Chip | Security Chip `DISABLED` |
> | | | >> Fingerprint | Predesktop Authentication `DISABLED` | ] |
> | | | >> I/O Port Access | Wireless WAN `DISABLED` \*ENABLED if you have a 2nd drive attached |
> | | | | Fingerprint Reader `DISABLED` |
> | | | >> Secure Boot Configuration | Secure Boot `DISABLED` |
> | | | >> Intel SGX | Intel SGX Control `DISABLED` |
> | | >> Startup | UEFI/Legacy Boot `UEFI Only` | |
> | | | CSM Support `No` (per OpenCore Documentation) | |
### My Current Settings, for Reference:

13
docs/2_README-installMEDIA.md
View file

@ -1,12 +1,13 @@
> ## Creating a macOS Installation Media:
1. Download macOS installer from the App Store.
2. Erase the installation media as GUID Partition Map, Mac OS Extended "Journaled". Name it "Install macOS (MacOS version)" - Example: "Install macOS Catalina".
3. Use 'createinstallermedia' command to copy installer to install media. [guide](https://support.apple.com/en-us/ht201372)
4. Install CLOVER bootloader onto the installation media. Use its latest daily build from GitHub. [Download](https://github.com/Dids/clover-builder/releases)
**Though we will not be using Clover, I've found that using the Clover installer is the most convinient way to create an EFI paritition on the installation drive.**
**Though we will not be using Clover, I've found that using the Clover installer is the most convinient way to create an EFI paritition on the installation drive.**
5. After Clover has been installed onto the macOS install drive, its EFI parition should be mounted. Proceed to delete the Clover EFI folder and replace with the EFI folder inside my `EFI-install_USB` folder.
7. Proceed to boot into the installation media.
8. Format the intended drive as APFS.
9. Complete the installation.
10. Boot into the newly installed Hackintosh partition using the installation media. That is to say, boot into the installtion media for OpenCore to boot into the installed Hackintosh partition.
11. Proceed with post installation configurations.
6. Proceed to boot into the installation media.
7. Format the intended drive as APFS.
8. Complete the installation.
9. Boot into the newly installed Hackintosh partition using the installation media. That is to say, boot into the installtion media for OpenCore to boot into the installed Hackintosh partition.
10. Proceed with post installation configurations.

74
docs/3_README-POSTinstallation.md
View file

@ -1,48 +1,50 @@
> ## Post Installtion:
1. Install OpenCore on the main boot EFI paritition to enable boot without the installation media. A good utility to mount your EFI folder is [corpnewt/MountEFI](https://github.com/corpnewt/MountEFI).
2. Please reference my uploaded EFI folder to determine my current bootloader configurations as well as which kexts I am currently using. Note that for CPUFriend, please generate your own DataProvider kexts per different machine specfiications and desired configurations. Use [one-key-cpufriend](https://github.com/stevezhengshiqi/one-key-cpufriend).
3. Copy the kexts you will be using to their respective directories, per bootloaders:
- OpenCore: `EFI/OC/Kexts/`
For the kexts you will be using, make sure to create matching entries within `OpenCore.plist`'s `Kernel/Add/` section.
*Refer to my uploaded EFI folder for my current kext list.
\*Refer to my uploaded EFI folder for my current kext list.
5. Refer to the table below for the other post installtion configurations for each particular issue. Some issues are easy to fix, simply requiring a kext installtion or running a script, while others are my involved and require SSDT patching.
6. For those other, more complicated issues, proceed to `4_README-ACPIpatching.md`
| Feature | Status | Dependency | Remarks |
| :----------------------------------- | ------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| macOS (10.14.x or 10.15.x) | ✅ | `VirtualSMC.kext`, `Lilu.kext`, Clover or OpenCore Bootloader | OpenCore is preferred. |
| iMessage/ FaceTime | ✅ | Whitelisted Apple ID, Valid SMBIOS | [Guide](https://www.tonymacx86.com/threads/an-idiots-guide-to-imessage.196827/) |
| Siri | ✅ | Apple ID, Working audio recorder | Needs `AppleALC` |
| iTunes Video Playback | ✅ | `WhateverGreen.kext`, Apple ID (*Optional*) | - |
| Sidecar | ✅ | iPad with iPadOS 13 | Tested with iPad Mini with iPadOS 13.1.2 |
| WiFi | ✅ | Native with BCM94360CS2. `AirportBrcmFixup` otherwise. | See `patches/OpenCore Patches/` for specific network card. |
| Bluetooth | ✅ | Native with BCM94360CS2. `BrcmFirmwareRepo.kext`, `BrcmPatchRAM3.kext`, and `BrcmBluetoothInjector.kext` otherwise. | See `patches/OpenCore Patches/` for specific network card. |
| Continuty | ✅ | Native with BCM94360CS2. `BT4LEContiunityFixup.kext` otherwise. Working Blutetooth and WiFi setup | See `patches/OpenCore Patches/` for specific network card. |
| AirDrop | ✅ | Native with BCM94360CS2. `BT4LEContiunityFixup.kext` otherwise. Working Blutetooth and WiFi setup | See `patches/OpenCore Patches/` for specific network card. |
| TrackPoint | ✅ | Patched `VoodooPS2Controller.kext` | - |
| TrackPad | ✅ | `VoodooPS2Controller.kext` | - |
| Built-in Keyboard | ✅ | `VoodooPS2Controller.kext` | - |
| Battery Percentage Indication | ✅ | `SSDT-OCBAT0-TP_tx80_x1c6th.aml` | Use [MaciASL](https://bitbucket.org/RehabMan/os-x-maciasl-patchmatic/downloads/) |
| CPU Power Management (SpeedShift) | ✅ | `XCPM` and `CPUFriend.kext`, generate your own CPUFriendDataProvider with [CPUFriendFriend](https://github.com/corpnewt/CPUFriendFriend_ or [one-key-cpufriend](https://github.com/stevezhengshiqi/one-key-cpufriend). |
| IGPU Power Management | ✅ | `XCPM` | - |
| PCIe Ethernet | ✅ | `IntelMausi.kext` | - | |
| Audio Recording | ✅ | `AppleALC.kext` with Layout ID = 21 | - |
| Audio Playback | ✅ | `AppleALC.kext` with Layout ID = 21 | - |
| Automatic Headphone Output Switching | ✅ | `ALCPlugFix` | - |
| Full Graphics Accleration (QE/CI) | ✅ | `WhateverGreen.kext` | - |
| Brightness Adjustments | ✅ | `WhateverGreen.kext` and `SSDT-PNLF-SKL_KBL.aml` | - |
| Micro SD Card Reader | ✅ | Custom `USBPorts.kext` See current OpenCore-EFI kext folder. You can create your own with Hackintool. | - |
| USB 3.1 | ✅ | Custom `USBPorts.kext` See current OpenCore-EFI kext folder. You can create your own with Hackintool. | - |
| DisplayPort on Thunderbolt 3 Dock | ⚠️ | `SSDT-TB3.aml`, `IOElectrify.kext` | [More details](https://github.com/tylernguyen/x1c6-hackintosh/issues/24#issuecomment-603183002)|
| Thunderbolt 3 Dock (Port Replicator) | ✅ | `SSDT-TB3.aml`, `IOElectrify.kext` | - |
| Thunderbolt 3 Hotplug | ⚠️ | `SSDT-TB3.aml`, `IOElectrify.kext` | [More details](https://github.com/tylernguyen/x1c6-hackintosh/issues/24#issuecomment-603183002)|
| ThinkPad TB3 Dock (40AC) Ethernet | ✅ | `AppleRTL815XComposite109.kext`, `AppleRTL815XEthernet109.kext` | [Item page](https://support.lenovo.com/au/en/solutions/acc100356) |
| CalDigit TS3 Plus Dock | ✅ | | [Item page](https://www.apple.com/shop/product/HMX12ZM/A/caldigit-ts3-plus-dock) |
| HiDPI *(Optional)* | ✅ | [xzhih/one-key-hidpi](https://github.com/xzhih/one-key-hidpi) | Scaling issues post-sleep fixed with AAPL, ig-platform `BAAnWQ==` |
| Battery life | ✅ | Non-NVME SSD, proper power management setup (CPU Power Management, GPU Power Management) | Drops 10% per hour for light programming tasks |
| NVMe Drive Battery Management | ✅ | `NVMeFix.kext`| |
| Hibernation | ❌ | [DISABLED](https://www.tonymacx86.com/threads/guide-native-power-management-for-laptops.175801/) | With the developement of acidanthera/HibernationFixup and OpenCore, hibernation may be fixed in the future. |
| Sierra Wireless EM7455 | ❌ | `Legacy_Sierra_QMI.kext` | No internet |
| Feature | Status | Dependency | Remarks |
| :----------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| macOS (10.14.x or 10.15.x) | ✅ | `VirtualSMC.kext`, `Lilu.kext`, Clover or OpenCore Bootloader | OpenCore is preferred. |
| iMessage/ FaceTime | ✅ | Whitelisted Apple ID, Valid SMBIOS | [Guide](https://www.tonymacx86.com/threads/an-idiots-guide-to-imessage.196827/) |
| Siri | ✅ | Apple ID, Working audio recorder | Needs `AppleALC` |
| iTunes Video Playback | ✅ | `WhateverGreen.kext`, Apple ID (_Optional_) | - |
| Sidecar | ✅ | iPad with iPadOS 13 | Tested with iPad Mini with iPadOS 13.1.2 |
| WiFi | ✅ | Native with BCM94360CS2. `AirportBrcmFixup` otherwise. | See `patches/OpenCore Patches/` for specific network card. |
| Bluetooth | ✅ | Native with BCM94360CS2. `BrcmFirmwareRepo.kext`, `BrcmPatchRAM3.kext`, and `BrcmBluetoothInjector.kext` otherwise. | See `patches/OpenCore Patches/` for specific network card. |
| Continuty | ✅ | Native with BCM94360CS2. `BT4LEContiunityFixup.kext` otherwise. Working Blutetooth and WiFi setup | See `patches/OpenCore Patches/` for specific network card. |
| AirDrop | ✅ | Native with BCM94360CS2. `BT4LEContiunityFixup.kext` otherwise. Working Blutetooth and WiFi setup | See `patches/OpenCore Patches/` for specific network card. |
| TrackPoint | ✅ | Patched `VoodooPS2Controller.kext` | - |
| TrackPad | ✅ | `VoodooPS2Controller.kext` | - |
| Built-in Keyboard | ✅ | `VoodooPS2Controller.kext` | - |
| Battery Percentage Indication | ✅ | `SSDT-OCBAT0-TP_tx80_x1c6th.aml` | Use [MaciASL](https://bitbucket.org/RehabMan/os-x-maciasl-patchmatic/downloads/) |
| CPU Power Management (SpeedShift) | ✅ | `XCPM` and `CPUFriend.kext`, generate your own CPUFriendDataProvider with [CPUFriendFriend](https://github.com/corpnewt/CPUFriendFriend_ or [one-key-cpufriend](https://github.com/stevezhengshiqi/one-key-cpufriend). |
| IGPU Power Management | ✅ | `XCPM` | - |
| PCIe Ethernet | ✅ | `IntelMausi.kext` | - | |
| Audio Recording | ✅ | `AppleALC.kext` with Layout ID = 21 | - |
| Audio Playback | ✅ | `AppleALC.kext` with Layout ID = 21 | - |
| Automatic Headphone Output Switching | ✅ | `ALCPlugFix` | - |
| Full Graphics Accleration (QE/CI) | ✅ | `WhateverGreen.kext` | - |
| Brightness Adjustments | ✅ | `WhateverGreen.kext` and `SSDT-PNLF-SKL_KBL.aml` | - |
| Micro SD Card Reader | ✅ | Custom `USBPorts.kext` See current OpenCore-EFI kext folder. You can create your own with Hackintool. | - |
| USB 3.1 | ✅ | Custom `USBPorts.kext` See current OpenCore-EFI kext folder. You can create your own with Hackintool. | - |
| DisplayPort on Thunderbolt 3 Dock | ⚠️ | `SSDT-TB3.aml`, `IOElectrify.kext` | [More details](https://github.com/tylernguyen/x1c6-hackintosh/issues/24#issuecomment-603183002) |
| Thunderbolt 3 Dock (Port Replicator) | ✅ | `SSDT-TB3.aml`, `IOElectrify.kext` | - |
| Thunderbolt 3 Hotplug | ⚠️ | `SSDT-TB3.aml`, `IOElectrify.kext` | [More details](https://github.com/tylernguyen/x1c6-hackintosh/issues/24#issuecomment-603183002) |
| ThinkPad TB3 Dock (40AC) Ethernet | ✅ | `AppleRTL815XComposite109.kext`, `AppleRTL815XEthernet109.kext` | [Item page](https://support.lenovo.com/au/en/solutions/acc100356) |
| CalDigit TS3 Plus Dock | ✅ | | [Item page](https://www.apple.com/shop/product/HMX12ZM/A/caldigit-ts3-plus-dock) |
| HiDPI _(Optional)_ | ✅ | [xzhih/one-key-hidpi](https://github.com/xzhih/one-key-hidpi) | Scaling issues post-sleep fixed with AAPL, ig-platform `BAAnWQ==` |
| Battery life | ✅ | Non-NVME SSD, proper power management setup (CPU Power Management, GPU Power Management) | Drops 10% per hour for light programming tasks |
| NVMe Drive Battery Management | ✅ | `NVMeFix.kext` | |
| Hibernation | ❌ | [DISABLED](https://www.tonymacx86.com/threads/guide-native-power-management-for-laptops.175801/) | With the developement of acidanthera/HibernationFixup and OpenCore, hibernation may be fixed in the future. |
| Sierra Wireless EM7455 | ❌ | `Legacy_Sierra_QMI.kext` | No internet |

63
docs/4_README-ACPIpatching.md
View file

@ -1,9 +1,12 @@
> ## ACPI Patching:
1. Download and install [MaciASL](https://github.com/acidanthera/MaciASL/releases) if you do not have it already.
2. Dump your original ACPI tables. There are a number of ways to do this, using Clover, Hackintool, Linux.
3. In Terminal, disassemble the copied ACPI tables with "iasl-stable -dl DSDT.aml". For our purpose, the only file that really matters is DSDT.dsl
- Your DSDT file will be used as a reference table in determining that needs to be patched and what patches need to be added.
4. Source SSDT*.dsl patch files are located in `patches` folder.
4. Source SSDT\*.dsl patch files are located in `patches` folder.
5. Refer to my `EFI-OpenCore` folder to see which patches are currently being used by me.
6. Refer to `PATCHES.md` for hotpatching documentation, most of my compiled hotpatches and can be copied straight to your setup. However, some patches may require certain directories or variables to be changed depending on your hardware (examine your own disasemebled DSDT). For these, edit the .dsl patch files. Also, note that some SSDT patches also require accompanying OpenCore/ Clover ACPI patches to work.
@ -13,28 +16,32 @@ A good way to see if you need to edit and compile your own SSDT patches is to co
# Hotpatching Notes
* Source ACPI patches are `.dsl` Edit these as needed.
* Compiled ACPI patches are `.aml` Once compiled, these belong to `EFI/OC/ACPI`.
* OpenCore Patches are patches for `config.plist` in their respective level.
- Source ACPI patches are `.dsl` Edit these as needed.
- Compiled ACPI patches are `.aml` Once compiled, these belong to `EFI/OC/ACPI`.
- OpenCore Patches are patches for `config.plist` in their respective level.
## Some patches here may be unused. Refer to the current OpenCore-EFI folder to see which one I am currently using. While other patches may be needed case-by-case, such as the WiFi/Bluetooth patches.
## Some Thinkpad machines are `LPC` and some are` LPCB`. Please examine your own DSDT and modify patches as needed.
## Some Thinkpad machines are `LPC` and some are`LPCB`. Please examine your own DSDT and modify patches as needed.
> ### Non-native WiFi and Bluetooth
`OpenCore Patches/ Config-DW1560.plist` for DW1560 model cards.
`OpenCore Patches/ Config-DW1820A.plist` for WD1820A model cards.
*Notice that these patches require additional kexts to be installed. See them in `Kernel/Add/`
\*Notice that these patches require additional kexts to be installed. See them in `Kernel/Add/`
> ### SSDT-OCBAT0-TP_tx80_x1c6th - Enabling Battery Status in macOS
**Need `OpenCore Patches/ TP Battery Basic Rename.plist`**
**Need `OpenCore Patches/ TP battery Mutex is set to 0 and renamed.plist`**
- Single battery system: only `BAT0` in ACPI, no` BAT1`.
  
> ### SSDT-PLUG-_PR.PR00 - Enablaing Native Intel Power Managements
- Single battery system: only `BAT0` in ACPI, no`BAT1`.
> ### SSDT-PLUG-\_PR.PR00 - Enablaing Native Intel Power Managements
Why?: `Processor` search in DSDT, rename `PR` to other variables as needed.
```
Scope (\_PR)
{
@ -58,19 +65,23 @@ Why?: `Processor` search in DSDT, rename `PR` to other variables as needed.
```
> ### SSDT-PNLF-SKL_KBL - Enabling Brightness Mangement in macOS
Why?: `Skylake/ KabyLake/ KabyLake-R` CPU.
Used in conjuction with `WhateverGreen.kext`
> ### SSDT-HPET_RTC_TIMR-fix
- This patch cannot be used with the following patches:
   - ***SSDT-RTC_Y-AWAC_N*** of the "Preset Variable Method"
   - OC official ***SSDT-AWAC***
   - "Counterfeit Device" or OC official ***SSDT-RTC0***
   - ***SSDT-RTC0-NoFlags for CMOS Reset Patch***
  
   - **_SSDT-RTC_Y-AWAC_N_** of the "Preset Variable Method"
   - OC official **_SSDT-AWAC_**
   - "Counterfeit Device" or OC official **_SSDT-RTC0_**
   - **_SSDT-RTC0-NoFlags for CMOS Reset Patch_**
> ### SSDT-Keyboard - Remapping Fn and PrtSc Keys
Keyboard path is `\ _SB.PCI0.LPCB.KBD`.  
For multimedia functions:
- Remap 1: F4 (Network) to F4
- Remap 2: F5 (Brightness Down)
- Remap 3: F6 (Brightness Up)
@ -83,42 +94,52 @@ For multimedia functions:
- Remap 10: PrtSc to F13
- Remap 11: Fn + K to Deadkey
- Remap 12: Fn + P to Deadkey
For Fn 1-12 functions, check the following option within `Preferences/Keyboard`:
![Fn keys](https://github.com/tylernguyen/x1c6-hackintosh/blob/master/docs/assets/img/macOS%20Settings/fnkeys.png)
For Fn 1-12 functions, check the following option within `Preferences/Keyboard`:
![Fn keys](https://github.com/tylernguyen/x1c6-hackintosh/blob/master/docs/assets/img/macOS%20Settings/fnkeys.png)
> ### SSDT-PTSWAK
### SSDT-EXT3-LedReset-TP
### SSDT-EXT4-WakeScreen
**Need `OpenCore Patches/ Comprehensive Patch Changed Its Name To.plist`**
Look up `_PTS` and `_WAK` and only apply the corresponding patches:
`_PTS` is `NotSerialized` in my DSDT
`_WAK` is `Serialized` in my DSDT
- ***SSDT-PTSWAK*** —— Comprehensive Patch。
- **_SSDT-PTSWAK_** —— Comprehensive Patch。
- ***SSDT-EXT3-LedReset-TP*** — `EXT3` extension patch. Solve the problem that the breathing light does not return to normal after the TP machine wakes up。
- **_SSDT-EXT3-LedReset-TP_** — `EXT3` extension patch. Solve the problem that the breathing light does not return to normal after the TP machine wakes up。
- ***SSDT-EXT4-WakeScreen*** — `EXT4` extension patch. Solve the problem that some machines need to press any key to light up the screen after waking up. When using, you should inquire whether the `PNP0C0D` device name and path already exist in the patch file, such as` _SB.PCI0.LPCB.LID0`. If not, add it yourself.
- **_SSDT-EXT4-WakeScreen_** — `EXT4` extension patch. Solve the problem that some machines need to press any key to light up the screen after waking up. When using, you should inquire whether the `PNP0C0D` device name and path already exist in the patch file, such as`_SB.PCI0.LPCB.LID0`. If not, add it yourself.
> ### SSDT-SBUS
Why?: `0x001F0004` under Device (SBUS).
> ### SSDT-DMAC
Why?: `PNP0200` is missing in DSDT.
> ### SSDT-MCHC
Why?: `MCHC` is missing in DSDT.
Why?: `MCHC` is missing in DSDT.
> ### SSDT-PMCR
Why?: `PMCR`,` APP9876` missing in DSDT.
Why?: `PMCR`,`APP9876` missing in DSDT.
> ### SSDT-PWRB
Why?: `PNP0C0C` missing in DSDT.
> ### SSDT-ALS0
Why?: `ACPI0008` missing in DSDT.
> ### SSDT-GPRW
Why?: Fix instant wake by hooking GPRW (0D/6D Patch)
```

37
docs/5_README-other.md
View file

@ -1,32 +1,37 @@
> ## Dual Booting:
* I recommend that you dual boot using another drive in the WAN slot.
* I've found that dual booting with OpenCore can be quite troulesome. Instead, what I recommend is to use rEFInd Boot Manager should you need to dual boot Windows or Linux.
- I recommend that you dual boot using another drive in the WAN slot.
- I've found that dual booting with OpenCore can be quite troulesome. Instead, what I recommend is to use rEFInd Boot Manager should you need to dual boot Windows or Linux.
## Modifier Key Patching:
By default, Windows, Left Alt, and Right Alt are mismapped. An easy fix for this is to install [Karabiner-Elements](https://karabiner-elements.pqrs.org/) and configure it as:
![karabiner_modifier](https://github.com/tylernguyen/x1c6-hackintosh/blob/master/docs/assets/img/macOS%20Settings/karabiner_modifier.png)
## Multimedia Fn Key Patching:
Since macOS doesn't not natively support some multimedia Fn key actions. BetterTouchTool is required to program these actions. Keyboard Mastero is also an alternative but I've found that BetterTouchTool is a simpler and easier option.
Simply import `patches/BetterTouchTool/x1c6-functions.bttpreset`. My settings are as followed:
* F7 = Screen Mirroring On/Off
* F9 = Open System Preferences
* F10 = Toggle Bluetooth On/Off
* F11 = Switch Keyboard Input Language (Set in System `Preferences/Keyboard`)
* F12 = Open Terminal
* PrtSc = Window Screen Capture
Of course, feel free to change this to your preference in BetterTouchTool.
- F7 = Screen Mirroring On/Off
- F9 = Open System Preferences
- F10 = Toggle Bluetooth On/Off
- F11 = Switch Keyboard Input Language (Set in System `Preferences/Keyboard`)
- F12 = Open Terminal
- PrtSc = Window Screen Capture
Of course, feel free to change this to your preference in BetterTouchTool.
## Touchpad Settings in macOS:
* Force Click is enabled by default, which turns any click on the trackpad into a force touch. I suggest you turn this off.
* In addition, I prefer to have tap to click on.
See my touchpad settings:
![touchpad](https://github.com/tylernguyen/x1c6-hackintosh/blob/master/docs/assets/img/macOS%20Settings/touchpad.png)
- Force Click is enabled by default, which turns any click on the trackpad into a force touch. I suggest you turn this off.
- In addition, I prefer to have tap to click on.
See my touchpad settings:
![touchpad](https://github.com/tylernguyen/x1c6-hackintosh/blob/master/docs/assets/img/macOS%20Settings/touchpad.png)
## Headphone Patch:
* Installing ALCPlugFix addresses the following:
* Change output to headphones after being plugged in, and to change it back to speakers after being unplugged.
* Fix the rare condition that audio is messed up after waking from sleep.
- Installing ALCPlugFix addresses the following:
- Change output to headphones after being plugged in, and to change it back to speakers after being unplugged.
- Fix the rare condition that audio is messed up after waking from sleep.
See `patches/ALCPlugFix/README.md` for more details.

109
docs/CHANGELOG.md
View file

@ -1,75 +1,114 @@
# CHANGELOG
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
> ### 2020-4-1
#### Added
* ALCPlugFix to automatically change output to headphones after being plugged in, and to change it back to speakers after being unplugged.
* ALCPlugFix to fix the rare condition that audio is messed up after waking from sleep.
- ALCPlugFix to automatically change output to headphones after being plugged in, and to change it back to speakers after being unplugged.
- ALCPlugFix to fix the rare condition that audio is messed up after waking from sleep.
#### Changed
* More documentation about recommended macOS settings.
- More documentation about recommended macOS settings.
> ### 2020-3-31
#### Added
* Further documentation regarding specific tweaks and recommmended macOS settings.
* ADB and PS2 code reference sheet.
- Further documentation regarding specific tweaks and recommmended macOS settings.
- ADB and PS2 code reference sheet.
#### Changed
* All Fn keys now have have an assigned key, remap as needed.
* Keyboard map is now in markdown.
- All Fn keys now have have an assigned key, remap as needed.
- Keyboard map is now in markdown.
> ### 2020-3-30
#### Added
* OpenCore configuration folder intended for install media usage.
* Configuration, patches and documentation for alternative network cards, specifically the DW1560 and DW1820A.
- OpenCore configuration folder intended for install media usage.
- Configuration, patches and documentation for alternative network cards, specifically the DW1560 and DW1820A.
#### Changed
* Moved `assets` folder into `docs/`.
- Moved `assets` folder into `docs/`.
#### Deprecated
* All things Clover. OpenCore is now my only friend.
- All things Clover. OpenCore is now my only friend.
#### Removed
* Removed EC related patches from `config.plist` as they are unnecessary.
- Removed EC related patches from `config.plist` as they are unnecessary.
> ### 2020-3-29
#### Added
* SSDT-ALS0 hotpatch for faking ambient light sensor ALS0 per Catalina's brightness preservation.
* SSDT-GPRW hotpatching for fixing instant wake (0D/6D patch).
- SSDT-ALS0 hotpatch for faking ambient light sensor ALS0 per Catalina's brightness preservation.
- SSDT-GPRW hotpatching for fixing instant wake (0D/6D patch).
#### Changed
* SSDT-Keyboard with the exception of F7 and F12, now maps all hotkeys to a Fn value that can be remapped within macOS. In addition, PrtSc is now remapped to F13.
* SSDT-PLNF to a cleaner version.
* Similarly, battery patch has been simplified.
- SSDT-Keyboard with the exception of F7 and F12, now maps all hotkeys to a Fn value that can be remapped within macOS. In addition, PrtSc is now remapped to F13.
- SSDT-PLNF to a cleaner version.
- Similarly, battery patch has been simplified.
#### Removed
* Some unused patches within OpenCore config.plist has now been removed.
- Some unused patches within OpenCore config.plist has now been removed.
> ### 2020-3-26
#### Changed
* Switched to AppleALC layout 21.
- Switched to AppleALC layout 21.
> ### 2020-3-23
#### Changed
* Upgraded OpenCore to 0.5.6
- Upgraded OpenCore to 0.5.6
> ### 2020-2-04
#### Changed
* Upgraded OpenCore to 0.5.5
* Upgraded kexts.
- Upgraded OpenCore to 0.5.5
- Upgraded kexts.
> ### 2020-1-18
#### Changed
* Upgraded OpenCore to 0.5.4
* Upgraded kexts.
- Upgraded OpenCore to 0.5.4
- Upgraded kexts.
> ### 2019-12-22
#### Added
* Project website: https://tylernguyen.github.io/x1c6-hackintosh/
* ACPI dump for `BIOS-v1.43`.
* CHANGELOG.md to keep track of the project's developments.
* OpenCore bootloader, version `0.5.3`.
* Better SSDT patching with hotpatches under `patches`. Making sure to read `patches/README`.
- Project website: https://tylernguyen.github.io/x1c6-hackintosh/
- ACPI dump for `BIOS-v1.43`.
- CHANGELOG.md to keep track of the project's developments.
- OpenCore bootloader, version `0.5.3`.
- Better SSDT patching with hotpatches under `patches`. Making sure to read `patches/README`.
#### Changed
* Switched completely to hotpatching through OpenCore. Credits to [daliansky](https://github.com/daliansky) and [jsassu20](https://github.com/jsassu20).
* Updated main README, made it look more visually appealing and organized.
- Switched completely to hotpatching through OpenCore. Credits to [daliansky](https://github.com/daliansky) and [jsassu20](https://github.com/jsassu20).
- Updated main README, made it look more visually appealing and organized.
#### Deprecated
* Clover bootloader. Clover r5100 is the last version I used on this machine. Moving forward, OpenCore is my preferred bootloader. See `EFI-Clover/README.md`.
* Reorganized folder/project structure. Setup instructions and references now under `docs`.
- Clover bootloader. Clover r5100 is the last version I used on this machine. Moving forward, OpenCore is my preferred bootloader. See `EFI-Clover/README.md`.
- Reorganized folder/project structure. Setup instructions and references now under `docs`.
#### Removed
* Old static patches.
* Old IORegistryExplorer dump.
- Old static patches.
- Old IORegistryExplorer dump.

210
docs/references/keyboard_map.md
View file

@ -1,105 +1,105 @@
| KEY | PS2 Scan Codes | EC Queries | ADB Injected | | | | | | |
|-------------------|----------------|------------|--------------|---|---------|----------------------------|---|---|------------|
| ESC | 1 | | 35 | | | | | | |
| (Fn) ESC | | EC _Q74 | | | | [acidanthera/VoodooPS2](https://github.com/acidanthera/VoodooPS2) *Use Debug version | | | |
| F1 | 3b | | 7a | | | [RehabMan/OS-X-ACPI-Debug](https://github.com/RehabMan/OS-X-ACPI-Debug) | | | |
| F2 | 3c | | 78 | | BIOS: | | | | |
| F3 | 3d | | 63 | | | TrackPoint | | | [Enabled] |
| F4 | 3e | | 76 | | | TrackPad | | | [Enabled] |
| F5 | 3f | | 60 | | | Fn and Ctrl Key Swap | | | [Enabled] |
| F6 | 40 | | 61 | | | Fn Sticky Key | | | [Disabled] |
| F7 | 41 | | 62 | | | F1-F12 as Primary Function | | | [Enabled] |
| F8 | 42 | | 64 | | | | | | |
| F9 | 43 | | 65 | | | | | | |
| F10 | 44 | | 6d | | | | | | |
| F11 | 57 | | 67 | | | | | | |
| F12 | 58 | | 6f | | | | | | |
| (Fn) F1 | e020 | | 4a | | | | | | |
| (Fn) F2 | e02e | | 49 | | | | | | |
| (Fn) F3 | e030 | | 48 | | | | | | |
| (Fn) F4 | | EC _Q6A | | | | | | | |
| (Fn) F5 | | EC _Q15 | | | | | | | |
| (Fn) F6 | | EC _Q14 | | | | | | | |
| (Fn) F7 | | EC _Q16 | | | | | | | |
| (Fn) F8 | | EC _Q64 | | | | | | | |
| (Fn) F9 | | EC _Q66 | | | | | | | |
| (Fn) F10 | | EC _Q60 | | | | | | | |
| (Fn) F11 | | EC _Q61 | | | | | | | |
| (Fn) F12 | | EC _Q62 | | | | | | | |
| Home | e047 | | 73 | | | | | | |
| End | e04f | | 77 | | | | | | |
| Insert | e052 | | 92 | | | | | | |
| Delete | e053 | | 75 | | | | | | |
| ` | 29 | | 32 | | | | | | |
| 1 | 2 | | 12 | | | | | | |
| 2 | 3 | | 13 | | | | | | |
| 3 | 4 | | 14 | | | | | | |
| 4 | 5 | | 15 | | | | | | |
| 5 | 6 | | 17 | | | | | | |
| 6 | 7 | | 16 | | | | | | |
| 7 | 8 | | 1a | | | | | | |
| 8 | 9 | | 1c | | | | | | |
| 9 | a | | 19 | | | | | | |
| 0 | b | | 1d | | | | | | |
| - | c | | 1b | | | | | | |
| Equal/ Plus | d | | 18 | | | | | | |
| Backspace | e | | 33 | | | | | | |
| Tab | f | | 30 | | | | | | |
| Q | 10 | | c | | | | | | |
| W | 11 | | d | | | | | | |
| E | 12 | | e | | | | | | |
| R | 13 | | f | | | | | | |
| T | 14 | | 11 | | | | | | |
| Y | 15 | | 10 | | | | | | |
| U | 16 | | 20 | | | | | | |
| I | 17 | | 22 | | | | | | |
| O | 18 | | 1f | | | | | | |
| P | 19 | | 23 | | | | | | |
| (Fn) P | e045 | | 71 | | | | | | |
| [ | 1a | | 21 | | | | | | |
| ] | 1b | | 1e | | | | | | |
| \ | 2b | | 2a | | | | | | |
| CapsLock | 3a | | 39 | | | | | | |
| A | 1e | | 0 | | | | | | |
| S | 1f | | 1 | | | | | | |
| (Fn) S | 54 | | 44 | | | | | | |
| D | 20 | | 2 | | | | | | |
| F | 21 | | 3 | | | | | | |
| G | 22 | | 5 | | | | | | |
| H | 23 | | 4 | | | | | | |
| J | 24 | | 26 | | | | | | |
| K | 25 | | 28 | | | | | | |
| (Fn) K | 46 | | 6b | | | | | | |
| L | 26 | | 25 | | | | | | |
| ; | 27 | | 29 | | | | | | |
| | 28 | | 27 | | | | | | |
| Enter | 1c | | 24 | | | | | | |
| Left Shift | 2a | | 38 | | | | | | |
| Z | 2c | | 6 | | | | | | |
| X | 2d | | 7 | | | | | | |
| C | 2e | | 8 | | | | | | |
| V | 2f | | 9 | | | | | | |
| B | 30 | | b | | | | | | |
| (Fn) B | 1d | | 3b | | | | | | |
| N | 31 | | 2d | | | | | | |
| M | 32 | | 2e | | | | | | |
| Comma/ < | 33 | | 3b | | | | | | |
| Period/ > | 34 | | 2f | | | | | | |
| / | 35 | | 2c | | | | | | |
| Right Shift | 36 | | 3c | | | | | | |
| Fn | 1d | | 3b | | | | | | |
| Left Control | e063 | | 80 | | | | | | |
| Windows | e05b | | 3a | | | | | | |
| Left Alt | 38 | | 37 | | | | | | |
| Spacebar | 39 | | 31 | | | | | | |
| (Fn) Spacebar | | EC _Q1F | | | | | | | |
| Right Alt | e038 | | 36 | | | | | | |
| Print Screen | e037 | | 0 | | | | | | |
| (Fn) Print Screen | | EC _Q65 | | | | | | | |
| Right Control | e01d | | 3e | | | | | | |
| Page Up: | e049 | | 74 | | | | | | |
| Page Down: | e051 | | 79 | | | | | | |
| Up Arrow: | e048 | | 7e | | | | | | |
| Down Arrow: | e050 | | 7d | | | | | | |
| Left Arrow: | e04b | | 7b | | | | | | |
| Right Arrow: | e04d | | 7c | | | | | | |
| KEY | PS2 Scan Codes | EC Queries | ADB Injected | | | | | | |
| ----------------- | -------------- | ---------- | ------------ | --- | ----- | ------------------------------------------------------------------------------------- | --- | --- | ---------- |
| ESC | 1 | | 35 | | | | | | |
| (Fn) ESC | | EC \_Q74 | | | | [acidanthera/VoodooPS2](https://github.com/acidanthera/VoodooPS2) \*Use Debug version | | | |
| F1 | 3b | | 7a | | | [RehabMan/OS-X-ACPI-Debug](https://github.com/RehabMan/OS-X-ACPI-Debug) | | | |
| F2 | 3c | | 78 | | BIOS: | | | | |
| F3 | 3d | | 63 | | | TrackPoint | | | [Enabled] |
| F4 | 3e | | 76 | | | TrackPad | | | [Enabled] |
| F5 | 3f | | 60 | | | Fn and Ctrl Key Swap | | | [Enabled] |
| F6 | 40 | | 61 | | | Fn Sticky Key | | | [Disabled] |
| F7 | 41 | | 62 | | | F1-F12 as Primary Function | | | [Enabled] |
| F8 | 42 | | 64 | | | | | | |
| F9 | 43 | | 65 | | | | | | |
| F10 | 44 | | 6d | | | | | | |
| F11 | 57 | | 67 | | | | | | |
| F12 | 58 | | 6f | | | | | | |
| (Fn) F1 | e020 | | 4a | | | | | | |
| (Fn) F2 | e02e | | 49 | | | | | | |
| (Fn) F3 | e030 | | 48 | | | | | | |
| (Fn) F4 | | EC \_Q6A | | | | | | | |
| (Fn) F5 | | EC \_Q15 | | | | | | | |
| (Fn) F6 | | EC \_Q14 | | | | | | | |
| (Fn) F7 | | EC \_Q16 | | | | | | | |
| (Fn) F8 | | EC \_Q64 | | | | | | | |
| (Fn) F9 | | EC \_Q66 | | | | | | | |
| (Fn) F10 | | EC \_Q60 | | | | | | | |
| (Fn) F11 | | EC \_Q61 | | | | | | | |
| (Fn) F12 | | EC \_Q62 | | | | | | | |
| Home | e047 | | 73 | | | | | | |
| End | e04f | | 77 | | | | | | |
| Insert | e052 | | 92 | | | | | | |
| Delete | e053 | | 75 | | | | | | |
| ` | 29 | | 32 |
| 1 | 2 | | 12 | | | | | | |
| 2 | 3 | | 13 | | | | | | |
| 3 | 4 | | 14 | | | | | | |
| 4 | 5 | | 15 | | | | | | |
| 5 | 6 | | 17 | | | | | | |
| 6 | 7 | | 16 | | | | | | |
| 7 | 8 | | 1a | | | | | | |
| 8 | 9 | | 1c | | | | | | |
| 9 | a | | 19 | | | | | | |
| 0 | b | | 1d | | | | | | |
| - | c | | 1b | | | | | | |
| Equal/ Plus | d | | 18 | | | | | | |
| Backspace | e | | 33 | | | | | | |
| Tab | f | | 30 | | | | | | |
| Q | 10 | | c | | | | | | |
| W | 11 | | d | | | | | | |
| E | 12 | | e | | | | | | |
| R | 13 | | f | | | | | | |
| T | 14 | | 11 | | | | | | |
| Y | 15 | | 10 | | | | | | |
| U | 16 | | 20 | | | | | | |
| I | 17 | | 22 | | | | | | |
| O | 18 | | 1f | | | | | | |
| P | 19 | | 23 | | | | | | |
| (Fn) P | e045 | | 71 | | | | | | |
| [ | 1a | | 21 | | | | | | |
| ] | 1b | | 1e | | | | | | |
| \ | 2b | | 2a | | | | | | |
| CapsLock | 3a | | 39 | | | | | | |
| A | 1e | | 0 | | | | | | |
| S | 1f | | 1 | | | | | | |
| (Fn) S | 54 | | 44 | | | | | | |
| D | 20 | | 2 | | | | | | |
| F | 21 | | 3 | | | | | | |
| G | 22 | | 5 | | | | | | |
| H | 23 | | 4 | | | | | | |
| J | 24 | | 26 | | | | | | |
| K | 25 | | 28 | | | | | | |
| (Fn) K | 46 | | 6b | | | | | | |
| L | 26 | | 25 | | | | | | |
| ; | 27 | | 29 | | | | | | |
| | 28 | | 27 | | | | | | |
| Enter | 1c | | 24 | | | | | | |
| Left Shift | 2a | | 38 | | | | | | |
| Z | 2c | | 6 | | | | | | |
| X | 2d | | 7 | | | | | | |
| C | 2e | | 8 | | | | | | |
| V | 2f | | 9 | | | | | | |
| B | 30 | | b | | | | | | |
| (Fn) B | 1d | | 3b | | | | | | |
| N | 31 | | 2d | | | | | | |
| M | 32 | | 2e | | | | | | |
| Comma/ < | 33 | | 3b | | | | | | |
| Period/ > | 34 | | 2f | | | | | | |
| / | 35 | | 2c | | | | | | |
| Right Shift | 36 | | 3c | | | | | | |
| Fn | 1d | | 3b | | | | | | |
| Left Control | e063 | | 80 | | | | | | |
| Windows | e05b | | 3a | | | | | | |
| Left Alt | 38 | | 37 | | | | | | |
| Spacebar | 39 | | 31 | | | | | | |
| (Fn) Spacebar | | EC \_Q1F | | | | | | | |
| Right Alt | e038 | | 36 | | | | | | |
| Print Screen | e037 | | 0 | | | | | | |
| (Fn) Print Screen | | EC \_Q65 | | | | | | | |
| Right Control | e01d | | 3e | | | | | | |
| Page Up: | e049 | | 74 | | | | | | |
| Page Down: | e051 | | 79 | | | | | | |
| Up Arrow: | e048 | | 7e | | | | | | |
| Down Arrow: | e050 | | 7d | | | | | | |
| Left Arrow: | e04b | | 7b | | | | | | |
| Right Arrow: | e04d | | 7c | | | | | | |

37
patches/SSDT-Keyboard.dsl
View file

@ -127,9 +127,46 @@ DefinitionBlock("", "SSDT", 2, "OCLT", "x1input", 0)
Scope (_SB.PCI0.LPCB.KBD)
{
Method(_DSM, 4)
{
If (!Arg2) { Return (Buffer() { 0x03 } ) }
Return (Package()
{
"RM,oem-id", "LENOVO",
"RM,oem-table-id", "Thinkpad_ClickPad",
})
}
// Overrides (the example data here is default in the Info.plist)
Name(RMCF, Package()
{
"Synaptics TouchPad", Package()
{
"BogusDeltaThreshX", 800,
"BogusDeltaThreshY", 800,
"Clicking", ">y",
"DragLockTempMask", 0x40004,
"DynamicEWMode", ">n",
"FakeMiddleButton", ">n",
"HWResetOnStart", ">y",
//"ForcePassThrough", ">y",
//"SkipPassThrough", ">y",
"PalmNoAction When Typing", ">y",
"ScrollResolution", 800,
"SmoothInput", ">y",
"UnsmoothInput", ">y",
"Thinkpad", ">y",
"EdgeBottom", 0,
"FingerZ", 30,
"MaxTapTime", 100000000,
"MouseMultiplierX", 2,
"MouseMultiplierY", 2,
"MouseScrollMultiplierX", 2,
"MouseScrollMultiplierY", 2,
//"TrackpointScrollYMultiplier", 1, //Change this value to 0xFFFF in order to inverse the vertical scroll direction of the Trackpoint when holding the middle mouse button.
//"TrackpointScrollXMultiplier", 1, //Change this value to 0xFFFF in order to inverse the horizontal scroll direction of the Trackpoint when holding the middle mouse button.
},
"Keyboard", Package()
{
"Custom PS2 Map", Package()