Jump to content
Welcome to InsanelyMac.com - No more ads! And some exciting news... Read more... ×
Mieze

LucyRTL8125Ethernet.kext for Realtek RTL8125

88 posts in this topic

Recommended Posts

Posted (edited)

This project is dedicated to Lucy, my lovely little Tyrannofelis Rex. :lol:

 

IMG_0581.jpeg.5d6e2d081b5c38b197428b62667ee4ae.jpeg

 

LucyRTL8125Ethernet is an open source driver for the Realtek RTL8125 family of 2.5GBit Ethernet controllers.

 

Key Features of the Driver

  • Supports all versions of Realtek's RTL8125 2.5GBit Ethernet Controllers found on recent boards.
  • Support for multisegment packets relieving the network stack of unnecessary copy operations when assembling packets for transmission.
  • No-copy receive and transmit. Only small packets are copied on reception because creating a copy is more efficient than allocating a new buffer. TCP, UDP and IPv4 checksum offload (receive and transmit).
  • TCP segmentation offload over IPv4 and IPv6.
  • Support for TCP/IPv4, UDP/IPv4, TCP/IPv6 and UDP/IPv6 checksum offload.
  • Supports jumbo frames up to 9000 bytes (strongly recommended for 2.5GBit operation).
  • Fully optimized for Mojave and above. Note that older versions of macOS might not support 2.5GB Ethernet.
  • Supports Wake on LAN (untested).
  • Supports VLAN (untested).
  • Support for Energy Efficient Ethernet (EEE) which can be disabled by setting enableEEE to NO in the drivers Info.plist without rebuild. The default is YES.
  • The driver is published under GPLv2.

 

Current Status

  • The driver has been tested successfully under Catalina (10.15.4 and above) and, according to first tests, is working stable. I haven't experienced any Kernel Panics during my tests and is working stable on my primary work machine.
  • The driver has been designed to work with Catalina but might also work with Mojave, provided you build from source with Xcode 10..
  • Please keep in mind that support for 2.5GBit Ethernet was introduced in Mojave (or maybe High Sierra?) so that there is no way to make it work with Sierra or below.

 

Known Issues

  • Using autoselect medium it seems to prefer negotiating a connection speed of 1Gbit with my switch so that I had to select 2.5GBit/s manually in order to achieve this speed but it might be different with other switches.
  •  

Installation

  • You might want to install the driver to /L/E as usual but it's also ok to use Clover's injection function (installation in the EFI folder).
  • Use your favorite kext installation tool for installation or perform the installation manually (for Clover injection). It's your call!

 

Help - I'm getting kernel panics!

Well, before you start complaining about bugs after you upgraded macOS and ask me to publish a driver update, you should first try to resolve the issue on your own by cleaning the system caches.

As the driver uses macOS's private network driver interface, which is supposed to be used by Apple provided drivers only, you might run into problems after an OS update because the linker may fail to recognize that IONetworking.kext has been updated and that the driver needs to be linked against the new version (Apple provided drivers avoid this problem because they are always updated together with IONetworking.kext). As a result, the linking process produces garbage and the driver may call arbitrary code when trying to call functions from IONetworking.kext. This usually results in unpredicted behavior or a kernel panic. In order to recover from such a situation, you should clean the System Caches forcing the linker to recreate it's caches:

  1. Delete all the files in /System/Library/Caches and it's subdirectories but leave the directories and the symbolic links intact. This is very important!
  2. Reboot.
  3. Recreate the kernel cache.
  4. Reboot again.

 

Troubleshooting

  • Make sure you have followed the installation instructions especially when you have issues with certain domains while the others are working fine.
  • Use the debug version to collect log data when trying to track down problems. The kernel log messages can be retrieved with "log show --predicate "processID == 0" --debug" in order to retrieve kernel logs. Include the log data when asking for support or giving feedback. I'm an engineer, not a clairvoyant.
  • Don't copy and paste large amounts of log data to your post. Create an archive with the log data and attach it to your post. In case you don't want to make your log data publicly accessible, contact me via PM and I will provide you a mail address to send it directly to me. 
  • Delete the following files:
  • /Library/Preferences/SystemConfiguration/NetworkInterfaces.plist
  • /Library/Preferences/SystemConfiguration/preferences.plist
  • In Terminal run netstat -s in order to display network statistics. Carefully examine the data for any unusual activity like a high number of packets with bad IP header checksums, etc.
  • In case auto-configuration of the link layer connection doesn't work it might be necessary to select the medium manually in System Preferences under Network for the interface.
  • Use Wireshark to create a packet dump in order to collect diagnostic information.
  • Keep in mind that there are many manufacturers of network equipment. Although Ethernet is an IEEE standard, different implementations may show different behavior causing incompatibilities. In case you are having trouble try a different switch or a different cable.

 

Changelog

  • Version 1.0.0 (2020-08-14)
    • Changed version number to make this the first official release.
  • Version 1.0.0d6 (2020-06-14)
    • Fixed chip recognition.
  • Version 1.0.0d3 (2020-04-20)
    • First working development release.

 

Getting the driver

 

 

Edited by Mieze
Added information how to resolve kernel panics

Share this post


Link to post
Share on other sites

my ryzentosh

MSI UNIFY

976223990_Schermata2020-04-23alle12_31_4

1056288087_Schermata2020-04-23alle12_33_

 

816721204_Schermata2020-04-23alle18_07_04.png.bb37e5198a08f33df203a6cfa7aa5358.png

 

 

with catalina it is present in the list, but it does not activate. With high sierra and mojave it is not made available on the net

msi unify.txt.zip

Share this post


Link to post
Share on other sites

In case there is a problem, please send me kernel logs. By the way, if the NIC doesn't get a link, try to select the medium manually as this seems to help.

Share this post


Link to post
Share on other sites
Posted (edited)

Thank you...

Also on MSI Unify x570


Having trouble using the kext in OpenCore. Have loaded it to EFI/OC/Kexts and have it in config.plist, but when i load up the installer, the computer still doesn't connect to the internet and I’m unable to install the MacOS. Network Utility shows the RTL8125

 

how do I show you the kernel log?

9343D331-0F94-4BAD-BBFF-F21DB4552C14.jpeg

Edited by luckyducky8676

Share this post


Link to post
Share on other sites
Posted (edited)

Sorry, what does that mean? How can I access Network Settings and select a medium if I don't have MacOS installed?  I can't get the installer disk to install because I need an internet connection on the hackintosh.

Edited by luckyducky8676

Share this post


Link to post
Share on other sites

@luckyducky8676 Goto System Preferences and choose the "Network" control panel. Please see the screenshots below and follow the instructions:

617537288_Bildschirmfoto2020-04-26um23_05_06.thumb.png.25bd2e6946c469e65b188dc1fd34ccb6.png

1774650180_Bildschirmfoto2020-04-26um23_05_20.thumb.png.64401d5dce6167c0d0b3dc9bab42d824.png

After clicking "OK" you also have to click "Apply" on the main screen of the "Network" control panel in order to activate the changes you made.

 

Mieze :cat:

Share this post


Link to post
Share on other sites
Posted (edited)

Ok I just used a usb-c hub that I had for Ethernet to install, and I got the rtl8125 to work afterwards following your instructions :) 

 

thank you!

Edited by luckyducky8676

Share this post


Link to post
Share on other sites

I checked the code for auto-negotiation of the medium and found a stupid mistake which is now fixed in version 1.0.0d4. On my test machine, auto-negotiation works fine now. Attached to this post you'll find a prebuilt binary. Good luck testing!

 

Mieze :cat:

LucyRTL8125Ethernet-V1.0.0d4zip.zip

Share this post


Link to post
Share on other sites

I have a killer E3000 and I was able to use your kext to get my ethernet device to find under system preferences, but It say that there is no device even when its plugged in.

 

I tried to include everything you stated above. Thank you so much for making this kext, I hope we can figure out how to make it work!

 

Let me know if there is anything more that I need to add

 

Killer E3000.zip

Share this post


Link to post
Share on other sites

@Alectardy98 There is a simple solution: the driver isn't installed properly! By the way, there are a lot of ACPI errors in your logs which might result in hardware not working as expected.

Share this post


Link to post
Share on other sites

Ive tried putting the kext in both EFI/CLOVER/kext/other and installing it to L/E with kext beast

 

No luck. If I'm installing it wrong then how would you install it correctly?

 

It is running when I check kext stat?

 

kextstat

Share this post


Link to post
Share on other sites

As your kernel logs show lots of ACPI errors, it's most likely an ACPI related error preventing the driver from being matched with the hardware. You should fix that first!

 

Mieze

Share this post


Link to post
Share on other sites

The kext is being recognized with the hardware, I think the current version is just not compatible with my Killer E3000. I will just keep waiting for an updated version.

 

Thank your for what you are doing for the community!

Screen Shot 2020-05-11 at 10.54.34 PM.png

Share this post


Link to post
Share on other sites
Posted (edited)

I am not sure how to send debug information, kernel seems to install and is present but disabled, I have tried to set to Manual with no progress. I would like to know how to compile from your download?

Screenshot 2020-05-16 at 23.56.12.png

Screenshot 2020-05-16 at 22.40.37.png

Screenshot 2020-05-17 at 01.01.44.png

 

Did you compile your version from the linux  

2.5G Ethernet LINUX driver r8125 for kernel up to 4.15 9.003.04 2020/03/11

 

and was this in linux os?

Edited by osxone

Share this post


Link to post
Share on other sites

Hello Mieze,

 

big thanks for this Kext... it´s flawless working here with MSI X299 Pro (https://de.msi.com/Motherboard/X299-PRO). 

But only with Catalina... is it possible to get it work under Mojave? In 10.14.6 the RTL8125 Port under "Ethernet Cards" or "Network" is non-existent, with Cat it´s there (like the other Mieze-driven Intel I219V ;-)). 

 

Thank you very much,

Zig

Share this post


Link to post
Share on other sites

Hello Mieze,

 

here are some screenshots... Mojave vs Catalina. 

Please can you validate this (if you find a bit time). 

 

Thanks a ton! 

Catalina_PCI.png

Catalina_Ethernet Cards.png

Mojave_PCI.png

Mojave_Ethernet Cards.png

Share this post


Link to post
Share on other sites

Please stop flooding me with useless screenshots. In case the driver doesn't work under Mojave, try to load it manually in Terminal with the command:

sudo kextutil -v 5 LucyRTL8125Ethernet.kext

and take a look at the messages. I assume that's a link error because I built the driver for Catalina.

 

Mieze :cat:

Share this post


Link to post
Share on other sites

  • Similar Content

    • By Enckyridion
      Hello. Is any Qualcomm Atheros AR8152 PCI-E Fast Ethernet Controller (NDIS 6.30) kext working on this new version of Big Sur? If so, could you help me? I've been looking for days and everyone I test doesn't work. Thank you.
    • By Wesley4444
      Hey Everyone!

      I have Gigabyte Aorus B550 elite REV.1 motherboard and have onboard Realtek 2,5 Gb's Ethernet Controller. I installed Catalina 10.15.7 with opencore. All works fine except internet. I see this device in system report and in Networks, I have "Cable not connected" status there. I tried different solutions and nothing. I even found original driver for UEFI from supplier, added it to drivers folder in opencore. Also, I tried to use a different cable. Nothing helped me and I would be happy to any help.

      Thanks everyone! 
    • By Mieze
      A New Driver for Realtek RTL8111
       
      Due to the lack of an OS X driver that makes use of the advanced features of the Realtek RTL81111/8168 series I started a new project with the aim to create a state of the art driver that gets the most out of those NICs which can be found on virtually any cheap board on the market today. Based on Realtek's Linux driver (version 8.035.0) I have written a driver that is optimized for performance while making efficient use of system resources and keeping the CPU usage down under heavy load.

      Key Features of the Driver
      Supports Realtek RTL8111/8168 B/C/D/E/F/G/H found on recent boards. Support for multisegment packets relieving the network stack of unnecessary copy operations when assembling packets for transmission. No-copy receive and transmit. Only small packets are copied on reception because creating a copy is more efficient than allocating a new buffer. TCP, UDP and IPv4 checksum offload (receive and transmit). TCP segmentation offload under IPv4. Support for TCP/IPv6 and UDP/IPv6 checksum offload. Fully optimized for Mountain Lion (64bit architecture) but should work with Lion too. As of now there is no support for Snow Leopard but it can be added if someone will create the necessary patches. Supports Wake on LAN. Support for Energy Efficient Ethernet (EEE) which can be disabled by setting enableEEE to NO in the drivers Info.plist without rebuild. The default is YES. The driver is published under GPLv2.  
      Limitations
      As checksum offload doesn't work with jumbo frames they are unsupported up to version 2.3.x. Version 2.4.0 might come with experimental jumbo frame support depending on test results of the development versions. No support for 32bit kernels.  
      Installation
      You might want to install the driver to /L/E as usual but it's also ok to use Clover's injection function (installation in the EFI folder). Use your favorite kext installation tool for installation or perform the installation manually (for Clover or OC injection). It's your call! Reboot Open System Preferences again, select Network and check if the new network interface has been created automatically or create it manually now. Configure the interface.  
      Help - I'm getting kernel panics!
      Well, before you start complaining about bugs after you upgraded macOS and ask me to publish a driver update, you should first try to resolve the issue on your own by cleaning the system caches.
      As the driver uses macOS's private network driver interface, which is supposed to be used by Apple provided drivers only, you might run into problems after an OS update because the linker may fail to recognize that IONetworking.kext has been updated and that the driver needs to be linked against the new version (Apple provided drivers avoid this problem because they are always updated together with IONetworking.kext). As a result, the linking process produces garbage and the driver may call arbitrary code when trying to call functions from IONetworking.kext. This usually results in unpredicted behavior or a kernel panic. In order to recover from such a situation, you should clean the System Caches forcing the linker to recreate it's caches:
      Delete all the files in /System/Library/Caches and it's subdirectories but leave the directories and the symbolic links intact. This is very important! Reboot. Recreate the kernel cache. Reboot again.  
      The same procedure should be applied when you are experiencing erratic behavior after an update! Please keep in mind that you have to disable SIP temporarily when you are using OC.
       
      Troubleshooting
      Make sure you have followed the installation instructions especially when you have issues with certain domains while the others are working fine. Use the debug version to collect log data when trying to track down problems. The kernel log messages can be found in /var/log/system.log. For Sierra and above use "log show --predicate "processID == 0" --debug" in order to retrieve kernel logs. Include the log data when asking for support or giving feedback. I'm an engineer, not a clairvoyant. Check your BIOS settings. You might want to disable Network Boot and the UEFI Network Stack as these can interfere with the driver. Double check that you have removed any other Realtek kext from your system because they could prevent the driver from working properly. Verify your bootloader configuration, in particular the kernel flags. Avoid using npci=0x2000 or npci=0x3000.  In Terminal run netstat -s in order to display network statistics. Carefully examine the data for any unusual activity like a high number of packets with bad IP header checksums, etc. In case auto-configuration of the link layer connection doesn't work it might be necessary to select the medium manually in System Preferences under Network for the interface. Use Wireshark to create a packet dump in order to collect diagnostic information. Keep in mind that there are many manufacturers of network equipment. Although Ethernet is an IEEE standard different implementations may show different behavior causing incompatibilities. In case you are having trouble try a different switch or a different cable.  
      FAQ
      I want to disable Energy Efficient Ethernet (EEE) but I don't know how? Select a medium without EEE manually. WoL from S5 doesn't work with this driver but under Windows it's working. Is this a driver bug? No it isn't, the driver is working as it should because OS X doesn't support WoL from S5.  
      Current status
      The driver has been successfully tested under 10.8.x and 10.9 with the B, C, D, E, F, G and H versions of the RTL8111/8168 and is known to work stable on these devices.  
      Changelog
      Version 2.4.0d4 (2020-10-10) Experimental jumbo frame support up to 9k for chipset 16 and above Requires 10.14 or newer. Version 2.3.0 (2020-08-14) Reworked medium section and EEE support to resolve problems with connection establishment and stability. Added option to supply a fallback MAC. Updated Linux sources to 8.047.04 and added support for new family members Requires 10.14 or newer.
      Version 2.2.2 (2018-01-21) Force ASPM state to disabled/enabled according to the config parameter setting. Requires 10.12 or newer. Version 2.2.1 (2016-03-12): Updated underlying linux sources from Realtek to 8.041.00. Added support for RTL8111H. Implemented Apple’s polled receive driver model (RXPOLL). Requires 10.11 or newer. Support for older versions of OS X has been dropped. Version 2.0.0 (2015-06-21): Uses Apple's private driver interface introduced with 10.8. Supports packet scheduling with QFQ. Please note that 2.0.0 is identical to 2.0.0d2. Only the version number has changed. Version 1.2.3 (2014-08-23): Reworked TSO4 and added support for TSO6. Version 1.2.2 (2014-08-44): Added an option to disable Active State Power Management (ASPM, default disabled) as ASPM seems to result in unstable operation of some chipsets. Resolved a problem with Link Aggregation after reboot. Added a workaround for the multicast filter bug of chipset 17 (RTL8111F) which prevented Bonjour from working properly Version 1.2.0 (2014-04-24): Updated underlying linux sources from Realtek to 8.037.00. Improved interrupt mitigate to use a less aggressive value for 10/100 MBit connections. Version 1.1.3 (2013-11-29): Improved transmit queue handling made it possible to reduce CPU load during packet transmission. Improved deadlock detection logic in order to avoid false positives due to lost interrupts. Version 1.1.2 (2013-08-03): Improved SMB performance in certain configurations. Faster browsing of large shares. Version 1.1.0 (2013-06-08): Support for TCP/IPv6 and UDP/IPv6 checksum offload added (can be disabled in Info.plist). Maximum size of the scatter-gather-list has been increased from 24 to 40 segments to resolve performance issues with TSO4 when offloading large packets which are highly fragmented. TSO4 can be disabled in Info.plist without rebuild. Statistics gathering has been improved to deliver more detailed information (resource shortages, transmitter resets, transmitter interrupt count). The interrupt mitigate settings has been changed to improve performance with SMB and to reduce CPU load. Configuration option added to allow for user defined interrupt mitigate settings without rebuild. Version 1.0.4 (2013-05-04): Moved setLinkStatus(kIONetworkLinkValid) from start() to enable(). Cleaned up getDescCommand(). Version 1.0.3 (2013-04-25): The issue after a reboot from Windows has been eliminated. Version 1.0.2 (2013-04-22): Added support for rx checksum offload of TCP and UDP over IPv6. Version 1.0.1 (2013-03-31): Improved behavior when rx checksum offload isn't working properly. Adds the chipset's model name to IORegistry so that it will show up in System Profiler.  
      Known Issues
      There are still performance problems with regard to SMB in certain configurations. My tests indicate that Apple's Broadcom driver shows the same behavior with those configurations. Obviously it's a more general problem that is not limited to my driver. WoL does not work in certain configurations. Old systems with 3 and 4 series chipsets exhibit performance issues in recent versions of macOS because there is no optimized power management for these systems in macOS anymore as Apple dropped support for the underlying hardware a long time ago. In case you are affected, please upgrade your hardware or find an alternative solution because I have no plans for a workaround. Sorry, but I don't think that it's worth the effort.  
      Getting the driver
      The source code can be found here: https://github.com/M...driver_for_OS_X There is also a pre-build binary for Mavericks and above: https://www.insanelymac.com/forum/files/file/88-realtekrtl8111-binary/  
      Building from Source
      I'm always using the latest version of XCode for development. You can get a free copy of XCode after becoming a member of the Apple developer program. The free membership is sufficient in order to get access to development tools and documentation.
×