search

LeeBinder / Asus-Vivobook-S510UA-Hackintosh

This repo enables you to run macOS on your VivoBook S15 as long as it matches below System specifications as close as possible, verified with macOS up to Sonoma.
40 stars 15 forks source link

readme

Asus VivoBook S15 S510UA/ F510UA series

This build enables you to run macOS on your VivoBook as long as it matches below System specifications as close as possible - verified with macOS Monterey 12.6.6 - Sonoma 14.1.1

🏳🚩For macOS Monterey compatibility, see macOS Monterey 12.x upgrade instructions for existing EFIs running pre-Monterey macOS ✅

Alt text

Table of contents

Repo Details

Version:        14.1.1 Beta 1
Repo Date:      Nov. 12, 2023
ReadMe Date:    Nov. 12, 2023
Repo-Status:    Beta
Release Status: Stable
BIOS-Support:   301-310
Technology: OpenCore and Clover with ACPI hotpatch by RehabMan
OpenCore:       v.0.9.6
Clover:     r5166

(Changelog: outdated - see Changelog.md

System specification & Introduction

• Model Name:       Asus VivoBook S510UA BQ514T
• CPU:          Intel Core i5-8250U Kaby Lake R 8th Gen. i5
• Video Graphics:   Intel UHD 620
• Wi-Fi & Bluetooth:    Intel Dual Band Wireless-AC 8265  // possible replacements see below
• Card Reader:      Realtek (RTL8411B_RTS5226_RTS5227)
• Camera:       ASUS UVC HD
• Audio:        Conexant Audio CX8050
• Touchpad:     ELAN 1300 I2C (ELAN 1200 supported, too)
• Keyboard Backlight:   Yes
• BIOS:         x510UAR 310 (X510UARAS310.zip)

     This repo is based on now two archived repos:

  1. Initially tctien342's VivoBook S510UA-BQ414T repo which has been discontinued because he upgraded to a different hackbook and gave his VivoBook away.

  2. Consecutively whatnameisit's brilliant and cutting-edge VivoBook X510UA-BQ490 repo based on OpenCore ("OC"). The two main differences are:

    • re-added keyboard backlight support
    • re-added a Clover EFI as secondary bootloader alternative by backporting OC's ACPI into Clover config.

Users with VivoBooks without keyboard backlight are advised to rather use whatnameisit's OC-based repo. He also has been tending it very actively until his VivoBook failed in Oct. 2021. Even if you can still download his old archived Clover EFI, note that he stopped updating it on 2020-11-22 and merely keeps it for historical purposes.

In any case please do read through his ReadME because it contains a wealth of important info and links which also apply to this repo!

Of the two bootloaders offered in this repo, OpenCore and Clover, OC can be considered the preferred one despite of still being beta by version number. As per whatnameisit and others, in contrast to OC, Clover at this point does not support OEMTableID, masking and many other sophisticated features. For a more detailed comparison, you could read Why OpenCore over Clover and others.

 

Unsupported Hardware & Features

• dGPU like NVIDIA GeForce 940MX, MX150 etc.
• Fingerprint reader
• FN + media controller key combo
• Apple Safe Sleep ("Hibernate") - see additional note below
• By now well supported: Intel Wi-Fi - full Mac-alike replacement options see below

The support for DRM contents is limited due to incompatible firmware. Please see the DRM Compatibility Chart

VivoBooks with an additional dGPU (NVIDIA GeForce 940MX, MX150 etc.)

OpenCore via OpenCore Configurator:

Clover: via Clover Configurator,

If there is more than one boot-arg, make sure you separate them from each other with a space!

Known Issues, weaknesses and oddities

  1. The Touchpad is not perfect - you might encounter occasional hangs and possibly erratic movements because a) it's a weak piece of hardware to begin with (even under Windows), and b) the VoodooI2C driver for macOS is still work in progress. Some older info is archived at TOUCHPAD » consolidated links to related issues.
  2. Apple Safe Sleep ("Hibernate", "Deep Sleep") has been disabled due to lack of compatibility. A similar functionality is planned to be integrated from whatnameisit's repo as soon as I find time to do so. For now, apply "post macOS Installations/set hibernatemode to 0" for the most reliable sleep experience.
  3. Battery life isn't great to begin with, not even in Windows. On some VivoBooks it seems to be even worse in macOS. A S510UQ user (Quhuy0410) claims longer battery life with model MacBookAir8,2 chosen in the SMBIOS section (of Clover config.plist). Feel free to experiment. Mind that CPUFriendDataProvider.kext must match your chosen model. For that sake, navigate to post macOS Installations/[Optional]/change CPU Performance
  4. Sleep: macOS tends to need up to 40 secs. to power down the VivoBook completely, and the fan spins up again before the system finally settles (power LED on the left blinking white, indicating sleep mode).
  5. Swapped < and ^ keys: If you have a keyboard with a < key next to the left ⇧ and a ^ key below the ESC key (image), these keys are reversed, and you neither want to use a tool like Karabiner-Elements nor know how to fix that via SSDT, simply stick to either VoodooPS2Controller.kext v.2.2.7 or the older VoodooPS2Controller.kext v.2.1.9 which are the only versions I know to map these keys correctly for such VivoBook S15 models like mine.

Tools & Guides to use

Steps to install macOS

  1. Enter the BIOS and set the following options:

    • Display memory: 64MB
    • Disable Fast Boot
    • Disable Secure Boot
    • recommended: set the EFI partition with OC as the first boot loader

  2. Prepare a macOS installer on a USB flash drive or external hard disk

  3. Download this repo, preferably as .dmg package from the Releases section because a) each release was tested thoroughly and can be considered a stable mile stone for most users, and b) macOS native icons and labels are maintained.

    

Alternatively you can download the repo at it's current "0-day" state if you see that a) it's significantly more recent than the latest release date, and b) contains one or more updates you are looking for. Download via the green "Clone or Download" button on the top right of the repo's main page, "Download ZIP".

    Consider the non-release state as BETA, and note that GitHub does not (yet?) sustain macOS native icons and labels in its open repo!

    To be able to boot from your macOS install USB, it needs either one of this repo's EFI folders (recommended: OC EFI) on its FAT (16 or 32) partition.

  4. Recommended: connect a mouse via USB in case Trackpad does not work right away

  5. Boot your USB macOS installer device into the hackintosh bootloader.
    RECOMMENDED: already fix CFG lock before install by unlocking the MSR E2 register, reboot.

  6. Again boot into your USB installer and this time select the macOS installer entry

  7. Follow macOS' installation instructions (you can find them in your favorite hackintosh forum) to set up and boot into macOS.

Steps after installing macOS

  1. If you haven't done already before macOS install, fix CFG lock by unlocking the MSR E2 register, reboot.

  2. Open the folder "post macOS Installations" and install all from within its subfolders for Hibernate prevention, additional function keys, etc. Also (strongly recommended!) study and consider the content of the folder [Optional]!

  3. Fill your internal hard disk's EFI partition with the OC or Clover EFI folder. You can use the matching Configurator to mount your system ESP (EFI System Partition). Next back up the existing System EFI folder and copy one of this release's EFI folders to your system's ESP.

  4. OpenCore Configurator:

    • click onto PlatformInfo in the side bar on the left
    • on the right top, click onto the 1st tab 'DataHub - Generic - PlatformNVRAM'. You will see four text fields with update this field
    • If you are a new user w/o a previous Clover config.plist: while leaving the current instance open in the background, open a new empty instance of OC, navigate to the same tab, click onto the up/down arrow box next to Check Coverage and choose MacBookPro15,4
    • in the provided OC config.plist in the 1st window, fill ONLY the text fields reading update this field with the corresponding values from the 2nd window instance
    • existing user: if you have already been booting via Clover config.plist: copy the matching values over according to these conversion translations
    • save

    Clover Configurator:

    • new user: click onto SMBIOS in the side bar on the left. Under 'System', next to 'Serial Number', click onto the Generate New button. That will change both, system and board serial number.
    • existing user: use the plist editor of your choice to first remove the dummy SMBIOS section and replace it with your existing one
    • Save.

    Above steps are necessary to - amongst other things - hopefully enable the use of iCloud.

  5. Reboot and ENJOY :)

Unlock the MSR E2 register

from OpenCore Post-Install/Fixing CFG Lock (English slightly corrected):

CFG-Lock is a setting in your BIOS that allows for a specific register (in this case the MSR 0xE2) to be written to. By default, most motherboards lock this variable with many even hiding the option outright in the GUI. And why we care about it is that macOS actually wants to write to this variable, and not just one part of macOS. Instead both the Kernel(XNU) and AppleIntelPowerManagement want this register.

So to fix it we have 2 options:

  1. depreciated: patch macOS to work with our hardware

    This creates instability and unnecessary patching for many The 2 patches we use for this:

    • AppleCpuPmCfgLock for AppleIntelPowerManagement.kext (not necessary for our VivoBooks)
    • AppleXcpmCfgLock for the Kernel(XNU)

  2. recommended: patch our firmware to support MSR E2 write

    Very much preferred, as avoiding patching allows for greater flexibility regarding stability and OS upgrades.

OpenCore:

  1. In OC's Boot GUI, launch the 2nd-to-last entry labeled ControlMsrE2.efi:

    You should see:
  2. Confirm with y or the equivalent key on your keyboard if it's non-English (should be the key underneath the 6 and 7 keys).

  3. reboot

  4. OpenCore Configurator > Kernel: disable AppleXcpmCfgLock, save
    (note: optionally, before saving, you can also deactivate Boot > Tools: ControlMsrE2.efi)

  5. reboot

Clover:

  1. Right after turning on or rebooting your VivoBook, press the ESC key to intercept booting and to enter the built-in Boot Menu. THIS STEP IS MANDATORY so CFGLock.efi can find the CFG variable if run as a tool from within Clover - DON'T SKIP IT!

  2. Choose your partition with Clover and boot it.

  3. In Clover's Boot GUI, navigate into the Tools section below the icons and launch ControlMsrE2:
    CFGLock
    You should see:
    

  4. Confirm with y or the equivalent key on your keyboard if it's non-English (should be the key underneath the 6 and 7 keys).

    (Note: only if you get an error like "Couldn't find any Variable with cfg in name"), choose the next tool entry CleanNvram, reboot, and start again)
  5. reboot

Compliments, you're DONE! Now you should have correct CPU power management :)

Links: OC Debug (contains ControlMsrE2.efi - by utopia team) | CFGLock.efi (legacy 2020-06 - by Brummbär) | RU - CFG LOCK/Unlocking - Alternative method

Optional Wi-Fi Replacement

As of 2021-11-25, according to the OpenIntelWireless team, their macOS community drivers appear to be "working well and stable", which hopefully also applies to our VivoBooks' Intel AC 8265 M.2. The Wi-FI kernel extension does, however, require its own Wi-Fi Client to connect. Educate yourself about the current state at OpenIntelWireless ("OIW") and decide for yourself or simply test first, if you are happy with how your VivoBook's stock Wi-Fi and Bluetooth perform with OIW in macOS.

If you're not happy with OIW, neither want to use a USB Wi-Fi dongle but opt for a replacement of the internal Intel AC 8265 M.2, there are several options:

  1. If you do NOT run Windows, best replace it with a Fenvi BCM94360NG M.2 because it has:      a) the same dimensions as the Intel module and is consequently a simple replacement      b) generic but macOS native Wi-Fi and Bluetooth chipset and IDs. Even though they are old, they have proven to deliver a reliable Continuity experience. Disadvantage: an incompatibility between the Fenvi BCM94360NG and any/ all available drivers for Windows (same for 10 and 11) leads to a BSOD for most as soon as (or shortly after) Wi-Fi is connected to a network! Proven work-around has been to always have a USB device plugged in while connected via Wi-Fi. Decide if that's an option for you if you also run Windows and will use Wi-Fi. All details see here, and here ff.

  2. If you also run Windows, need stable Wi-Fi in both, macOS and Windows, don't mind an older (2013) yet original Apple Wi-Fi/ BT combo card, and are capable of doing a bit of grinding on an adapter with a rotary tool, your best option might still be the following card + adapter combo:
    • Apple BCM94360CS2 AirPort Extreme (NGFF): eBay | AliExpress | Amazon
    • Dual Band NGFF M.2 A/E Key Adapter For 12+6 Pin Wireless Module:

🛑 ⚠ IMPORTANT: if you opt for the BCM94360CS2, it is crucial you DO follow my installation instructions step-by-step 100%, otherwise you WILL brick your VivoBook's motherboard! ⚠ 🛑

Links to facilitate your decision making process:

Windows: first completely remove any existing Wi-Fi and Bluetooth drivers via Programs -> Uninstall, plus any corresponding entries in Device Manager incl. their drivers, THEN power down to install the card and on reboot the latest available drivers (same for both cards):

Other alternative Wi-Fi/ BT combo cards like the DW1560, DW1830 (both Dell) or the FRU 04X6020 (Lenovo) are not recommended due to compromised/ inferior Continuity.

If however you're using any of these, follow these steps in macOS, because this repo is now tailored for Apple native chipsets and does not come with extra Broadcom kexts and settings anymore:

ATTENTION: be careful with Updates!

  1. Clover only: after updating AirportBrcmFixup.kext and/or VoodooPS2Controller.kext and (esp.) if you're running Big Sur, you have to (!!) run /EFI/CLOVER/kexts/Other/remove problematic kexts after update or Big Sur won't boot. See here for the sad and stubborn details...
  2. VirtualSMC: The VirtualSMC version should match those of accompanying plugin kexts (SMCProcessor, SMCBatteryManager) to avoid touchpad and battery issues! Please make sure you download the most recent stable release of the complete SMC package from its repo and replace each existing file with the matching new one.

Recommendations

  1. OC (1st) + Clover (2nd): On your SSD's ESP, have OC's EFI folder so OC is your main bootloader; additionally create a separate FAT partition with at least 50+ MB, label it Clover and copy the Clover EFI folder onto it and onfigure it accdg. to above instructions. Make sure you use the same SMBIOS Platform Info in both config.plists so you don't experience oddities!
  2. Downscale monitor resolution to 1600 x 900 for two reasons: a) you will need to squint much less or ideally not at all because human eyes are simply not made for a 1920 x 1080 resolution on a 15,6" screen, period; and b) your monitor will use less energy = longer battery life!
  3. Sound quality isn't great because the speakers are mediocre in general, and to make things even worse, Asus placed them into the bottom of the case, mostly facing down. For tips to improve the sound, please look at "docs/BetterSound.html"

Fine-tuning

Instructions to update from a previous version of this repo

Recommended procedure:

Alternative procedure: integrate new repo release changes into your EFI folder

Troubleshooting

Many issues can be solved by performing a NVRAM Reset, then reboot. If you have boot entries with custom names in your UEFI BIOS boot menu, you might want to use Clover's NVRAM reset, because it doesn't touch them but nicely keeps them intact: boot into its Boot menu, then press F11. Disadvantage: Clover's NVRAM reset isn't as thorough as OC's, so if you still encounter any issue which might be NVRAM related, your next bet is OC's NVRAM reset. And if you don't have custom entries in your UEFI BIOS boot picker to begin with, you should run OC's NVRAM reset right away. You execute it either via the last entry in the boot menu picker, or via keyboard key combo Windows + Alt + P + R

Further topics:

If your issue is not listed or persists, either post to the VivoBook S15 X510UAR thread @tonymacx86, or open an issue here.

Knowledge Base

Special Credits for this repo to these fellow hackintoshers:

whatnameisit: main contributor; host of the VivoBook X510UA-BQ490 repo | tctien342: originator of this VivoBook S15 repo (archived) | hieplpvip: originator of the underlying/ upstream ZenBook repo and AsusSMC; contributor | fewtarius: facilitator | To many MANY others .........