x1c6-hackintosh/docs/CHANGELOG.md

CHANGELOG

All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog.

2022-4-20

Added

Changed

• OC to 0.8.0
• macOS to Monterey 12.3.1
• Upgraded various Acidanthera kexts

2022-2-21

Added

Changed

• OC to 0.7.8
• macOS to Monterey 12.2.1
• Upgraded various Acidanthera kexts

Deleted

• RTCMemoryFixup.kext

2021-11-5

Added

• BluetToolFixup.kext to fix Bluetooth stack in macOS Monterey. (It should on load on macOS Monterey).

Changed

• OC to 0.7.5
• macOS to Monterey 12.0.1
• Upgraded various Acidanthera kexts.
• Upgraded HFSPlus.efi
• install EFI is now deprecated. Use the main EFI to install macOS (You may also wish to enable ShowPicker, as well as -v in boot-args)

2021-8-3

Notice

• AX200 is now my wireless card. However, I'll continue to manintain a vanilla repo.

Changed

• OC to 0.7.2
• Upgraded various Acidanthera kexts.
• docs/Hardware.md no longer requires a wireless card change. The recommendaiton/preferred card is now AX200.

2021-6-21

Changed

• Fixed Resources folder structuring and added new support files.
• Revert ECEnabler.kext in favor of SSDT-Battery (ECEnabler had some trouble updating charge level for me).
• Fix brightness adjustment patch.

Notice

• This will likely be the last repo update until macOS Monterey is stable. At which I plan:
  • Implement AX200 is the network card with the OpenIntelWireless kexts.

2021-6-8

Changed

• OC to 0.7.0 and upgraded various Acidanthera kexts.
• Big Sur to 11.
• Deprecate SSDT-Battery in favor of ECEnabler.kext
• Fixed Brightness Adjustment issue (forgot to add patch entry when removing AppleBacklightSmoother.kext two commits back)

Notice

• This will likely be the last repo update until macOS Monterey is stable. At which I plan:
  • Implement AX200 is the network card with the OpenIntelWireless kexts.

2021-5-15

Changed

• OC to 0.6.9 and upgraded various Acidanthera kexts.

Removed

• ACTUALLY AppleBacklightSmoother.kext per Issue #122, will readd to the repo once the issue is resolved.

2021-4-7

Changed

• OC to 0.6.8 and upgraded various Acidanthera kexts.
• OC Resources per master repo update.

Removed

• AppleBacklightSmoother.kext per Issue #122, will readd to the repo once the issue is resolved.

2021-3-6

Changed

• OC to 0.6.7 and upgraded various Acidanthera kexts.
• YogaSMC to 1.4.3
• Depricate some SSDT-Keyboard patches now that YogaSMC partially handles keyboard locale.
• Added note on flashing Macronix BIOS chip.

2021-2-4

Changed

• OC to 0.6.6 and upgraded various Acidanthera kexts
• Upgraded Resources with latest `OCBinaryData

2021-1-5

Changed

• OC to 0.6.5 and upgraded various Acidanthera kexts
• Added ocvalidate (0.6.5) in OC to easily check and validate config.plist changes.

2020-12-26

Changed

• OC to 0.6.4 and upgraded various Acidanthera kexts
• YogaSMC to 1.4.1 (Remember to upgrade your YogaSMC App and PrefPane)
  • YogaSMC implementation on this machine is now considered stable.

2020-11-17

Changed

• Updated various TB3 patches and instructions.
• Added misc. DeviceProperties to config.plist

2020-11-14

Added

• SSDT-PWRB to patch power button.

Changed

• Parition TB3 patch into smaller, more readable chunks.
  • SSDT-XHC2 is also now apart of this.
• Removed experimental stuff from SSDT-Sleep
• Updated to SSDT-Battery to rev8, thanks @benbender
• Updated some documenation, with more detailed documentation coming.

2020-11-13

Changed

• Upgraded to Big Sur
• Upgraded to BIOS-v1.50 and added corresponding ACPI dump.
• Upgraded YogaSMC to stable build 1.3.0
• Compatibiltity and improvements on SSDT-Battery. Thanks @benbender
• Experimental TB3 patch by @benbender:
  • Complete hotplug and power management without modded TB3 controller firmware
  • NOTE: Brokenb USB 3.1 Gen2 hotplug still, but everything else is amazing!
  • Everyone thanks @benbender again! This would not have been possible without his hard work and research.

Removed

• Deprecated legacy keyboard patches. YogaSMC is now recommended and preferred.
• TbtForcePower.efi as it is no longer needed.
• ThunderboltReset.kext has it is no longer needed.

2020-11-3

Changed

• OC to 0.6.3 and upgrade various Acidanthera kexts
• Restructured docs: depricated legacy things and combined duplicates.
• YogaSMC is now the preferred method to handle Fn keys instead of ThinkpadAssisstant.
  • Note that YogaSMC is still in its infancy, so you still prefer ThinkpadAssistant, use SSDT-Keyboard-Legacy.dsl and /patches/OpenCore Patches/ Keyboard-Legacy.plist
  • Thank you @zhen-zen for the great kext and app.
• Updated config.plsit:
  • Removed depricated ACPI renames in accordance with new ACPI patches.
  • Added Arch value to each kext entry in accordance with new OpenCore doc.
  • Added Thunderbolt 3 Device Properties.
  • Added ExtendBTFeatureFlags value to replace BT4LEContinuityFixup
• Reorganized subdirectories within /patches/ to make things easier to find and understand.
• Renamed 3_README-POSTinstallation.md to SUMMARY.md since it's not really a step but more of an overview of what patches what.
• More readble and better writing of SSDT-Keyboard
• New SSDT-PNLF to accomodate AppleBacklightSmoother.kext
• New battery patch SSDT-Battery that fixes accesses to 16byte-EC-field HWAC (Issue #82).
• SSDT-Sleep is an all-in-one sleep patch over SSDT-PTSWAK, SSDT-GPRW, SSDT-EXT*
  • It is no longer necessary to set sleep mode to Linux in BIOS as it is now indepently set by SSDT-Sleep
• If (_OSI ("Darwin")) and SSDT-DTPG are now replaced in favor of SSDT-Darwin and OSDW, just like in genuine Macs.
• Removed USBPorts.kext in favor of patching/mapping via ACPI with SSDT-XHC1, SSDT-XHC2, and SSDT-USBX
• README.md:
  • Turned different sections into menus for better readability.
  • Merged 3_README-POSTinstallation.md into the SUMMARY section.
• Set HibernateMode to NVRAM instead of Auto

Added

• update.sh script to automatically build and replace all ACPI patches
• SSDT-HWAC to patch access to 16byte-EC-field HWAC
• SSDT-EC to patch embedded controller for use with YogaSMC
• SSDT-Debug, SSDT-HOOKS, and Debug.plist for debugging if needed
• SSDT-INIT to configure system values: HPET, DYTC, and DPTF
• YogaSMC.kext to interface with the device's EC. Make sure to also install the app and pref pane.
• AppleBacklightSmoother.kext is just as its name implies.
• BrightnessKeys.kext to handle Fn keys with ACPI renames.
• Documentation of modding the Thunderbolt 3 controller.

Removed

• SSDT-HPET, similar to genuine Macs, HPET is now disabled within SSDT-INIT

2020-10-6

Notice

• Just getting back to my rountine and maintaining this project. There has been many developments lately, especially with Thunderbolt 3 ACPI patches and YogaSMC. It will take some time for me to review all these developments and understand them. Meanwhile, it seems @benbender has taken matters to his own hand while I was away :)
• His experimental fork: https://github.com/benbender/x1c6-hackintosh
• I will create an issue to specfically to discuss YogaSMC usage and config on this machine.
• Looking forward, Big Sur is almost here so I want to get this project back onto the latest stable build before it comes out.

Changed

• Support for Hibernation Mode 25. As with normal macOS machines, mode 3 is default, but if you want, mode 25 is now also an option.
• There seems to be a bug with the GitHub release version of ThunderboltReset.kext so I replaced it one built by @benbender. You can monitor the issue here osy86/ThunderboltReset/issues/7. Thank you @benbender for noticing this.
• OC to 0.6.2
• Upgraded various Acidanthera kexts as well as VoodooRMI

Added

• Added RTCMemoryFixUp for support of Hibernation Mode 25.
• OpenCore config patch for FHD Touchscreen.
• OpenCore config patch for Intel wireless.

Removed

• ALCPlugFix is now deprecated and is replaced by new AppleALC (per issue #75). Please run uninstall.sh from the previous commit to remove ALCPlugFix.
• Delete legacy DiskImage voice from OC Resources
• GPRW ACPI patch to fix Bluetooth wake. Make sure that your Wake-on-LAN is disabled in BIOS to prevent sleep problems.
• Removed advice to disable DPTF in modded BIOS as it can break methods in ACPI. Thanks @benbender
• SMCSuperIO as it was unnecessary.

2020-8-3

Added

• Added macOS Boot chime support. Disabled by default, PlayChime to Yes if you want it.
  • Boot chime was upsampled by me using Audacity, will use this upsampled file until AudioDxe.efi can upsample audio on the fly.

Changed

• OC to 0.6 and upgraded various acidanthera kexts.
• docs/1_README-HARDWAREandBIOS.md:
  • BIOS modding instructions, confirmed working on BIOS-v1.45. Thanks @benbender for bringing this to my attention.
  • CPU Performance/Battery configuration guidelines. A year and a half after Issue #28 is opened. Thank you to everyone in that issue.
• Upgraded VoodooRMI, this kext is now stable.
• Offloaded universally applicable parts of this guide to dortania as referring to their often updated content should be better.
• config.plist is now defaulted to users with a BIOS mod, those without a BIOS mod will need to add config_unmoddedBIOS.plist to config.plist
• Enforces modeset to fix Issue #69

2020-7-18

Added

• EDID Override patch for FHD screen. Thanks @Paolo97Gll

Changed

• By default, OpenCore-EFI now has the 4K output patch disabled for easier system upgrades. Install OpenCore patches/4K-Output if you need it.
• Upgraded VoodooRMI
• Documentation changes for readability.

2020-6-29

Added

• X1 6th Gen Hardware Maintenance Guide pdf.
• Display Patches in patches/Internal Displays/ for the WQHD HDR Screen:
• Color profile as calibrated by notebookcheck
• EDID override to patch HDMI hotplug and overclock refresh rate. Thank you @veelar
• Please follow instructions on Issue #60 to create an EDID override for your own display. Make sure to create a pull request!
• Repo issue template to deter low effort issues and better diagnosing and support.
• More documentation in EFI-OpenCore/README.md about decisions on config.plist

Changed

• Reverted to previous, simpler iGPU framebuffer patches.

2020-6-26

Added

• VoodooRMI as alternative trackpad option. Enabled by default, feel free to revert back to VoodooPS2Mouse and VoodooPS2Trackpad if you prefer. *Note, there's currently a bug with RMI where the touchpad would not load once in a while. The RMI kext uploaded in this repo has a temp fix by me (See VoodooSMBUS/PR). However, the issue is still ongoing and the dev team is aware of it. I'm switching this repo to VoodooRMI because I believe it's the future and I want to possible bugs to be reported to be fixed for the kext's first stable release.
• Kernel patches to enable 4K external graphics, thank you so much @benbender
• XQ74 patch in SSDT-Keyboard to support FnLock HUD per ThinkpadAssistant 1.8.0
• In EFI-OpenCore/README.md, I've added a short section explaining why certain variables are the way they are in my config.plist. I will continue to update this section with more details as time goes on.

Changed

• iGPU Framebuffer patching for HDMI issue in Catalina.
  • In Catalina/WhateverGreen version, for some reasons my previous framebuffer patches for HDMI no longer worked. So I re-did the patch in mode details but eventually the property that fixed it was disable-external-gpu or -wegnoegpu. For some strange reasons, that variable activated on-board HDMI. See similar reports here. I'm going to create an issue on acidanthera/bugtracker soon to report to the dev team. In the mean time, keep this property if you rely on HDMI and do not have an eGPU. Delete this property if you have an eGPU (You're likely using the HDMI on the eGPU anyway).
• Fixed VoodooPS2 kexts loading order.
• Various reference docs to dortania.
• HibernateMode to Auto

Removed

• Unnecessary Mutex OpenCore patches, all Mutex are already 0 in stock DSDT.
• SSDT-MCHC and SSDT-SBUS for VoodooRMI compatibility.

2020-6-1

Changed

• OpenCore to 0.5.9
• Upgraded various Acidanthera kexts.
• Recompiled various SSDT with new iasl libraries.
• Replaced SSDT-EXT3 with SSDT-LED
• Change SSDT OEM ID to tyler to somewhat track distributions and usage across various projects

2020-5-27

Changed

• Keyboard backlight is now supported by ThinkpadAssistant 1.7, thank so much @MSzturc
• SSDT-keyboard to support ThinkpadAssistant 1.7.0
• Honestly, what's even left to improve on the keyboard? Open an issue.

2020-5-24

Added

• Setting instructions better sleep in 5_README-other.md

Changed

• Bluetooth Toggle is now supported by ThinkpadAssistant 1.6, thank so much @MSzturc
• SSDT-keyboard to support ThinkpadAssistant 1.6.0

Removed

• BetterTouchTool is no longer needed for Fn key functions and has been removed.
• SMCLightSensor.kext has been removed as the x1c6 has no ambient light sensor.

2020-5-22

• Further SSDT-Keyboard tweaks:
  • Windows (mismapped to Left Alt by default) is now properly mapped to Left GUI
  • Left Alt (mismapped to Left GUI by default) is now properly mapped to Left Alt
  • Right Alt (mismapped to Right GUI by default) is now properly mapped to Right Alt
• This means that Karabiner-Elements is no longer a necessary for this project. Once less program! unless you need it for other purposes (like a hyper key).
• *Similarly, once Bluetooth toggle is implemented in ThinkpadAssistant, BetterTouchTool can also go away.

2020-5-21

Changed

Keyboard Perfection is almost here!

• Modified SSDT-Keyboard patch to be compatible with ThinkpadAssistant.
  • Mute/unMute Microphone with F4, with LED!
  • Disable WiFi with F8
  • Mirror with F7
  • Bluetooth, F10 still has to be handled by BetterTouchTool, but hopefully supported will be added soon. See my request

2020-5-9

Changed

• Upgraded OpenCore to 0.5.8
• Upgraded various acidanthera kexts.
• Fixed various dortania broken guide links.
• Removed TbtForcePower.efi from LiveUSB OpenCore config.plist
• Added PM981 install suggestions per Issue #43
• Changed ScanPolicy of install_USB to 0.

2020-4-6 (#2)

Added

• Added OpenCanopy to EFI for Picker GUI support.
• NVMeFix kext to EFI-installUSB for PM981 support.

Changed

• Upgraded OpenCore to 0.5.7
• Upgraded various kexts.

2020-4-6 (#1)

Added

• SSDT-EXT1-FixShutdown to fix the rare issue that sometimes a shutdown would result in a restart instead.
• SSDT-HPET to patch out legacy IRQ conflicts.

Changed

• Better notes and documentation with config.plist
• Modularized each needed OpenCore config patches.

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.

Changed

• 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.

Changed

• 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.

Changed

• Moved assets folder into docs/.

Deprecated

• All things Clover. OpenCore is now my only friend.

Removed

• 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).

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.

Removed

• Some unused patches within OpenCore config.plist has now been removed.

2020-3-26

Changed

• Switched to AppleALC layout 21.

2020-3-23

Changed

• Upgraded OpenCore to 0.5.6

2020-2-04

Changed

• Upgraded OpenCore to 0.5.5
• Upgraded kexts.

2020-1-18

Changed

• 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.

Changed

• Switched completely to hotpatching through OpenCore. Credits to daliansky and 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.

Removed

• Old static patches.
• Old IORegistryExplorer dump.