Jump to content

fluid | fixed

Mieze

Mieze

Member Since 27 Mar 2012
Offline Last Active Today, 04:16 AM
*****

New Driver for Realtek RTL8111

17 March 2013 - 08:48 PM

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 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.
  • Fully optimized for Mountain Lion (64bit architecture) but should work with Lion and Snow Leopard too.
  • 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 currently unsupported and will probably never be.
  • No support for 32bit kernels.
Installation
Before you install the driver you have to remove any installed driver for RTL8111/8168.
  • Goto /S/L/E and delete the old driver (Lnx2mac, AppleRealtekRTL8169, etc.).

  • Recreate the kernel cache.

  • Open System Preferences and delete the corresponding network interface, e. g. en0. If you forget this step you might experience strange problems with certain Apple domains, iTunes and iCloud later.

  • Shutdown, wait for 30 seconds and reboot.

  • Install the new driver and recreate the kernel cache.

  • 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.
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 log messages can be found in /var/log/system.log. 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 might interfere with the driver.
  • 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.
Current status
  • The driver has been successfully tested under 10.8.x with the D (chipset 9), E (chipset 16) and F (chipset 17) versions of the RTL8111 and is known to work stable on these devices but you'll have to consider that there are 25 different revisions of the RTL8111.
Changelog
  • 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.
  • Version 1.0.2 (2013-04-22):
    • Added support for rx checksum offload of TCP and UDP over IPv6.
  • Version 1.0.3 (2013-04-25):
    • The issue after a reboot from Windows has been eliminated.
  • Version 1.0.4 (2013-05-04)
    • Moved setLinkStatus(kIONetworkLinkValid) from start() to enable(). Cleaned up getDescCommand().
Known Issues
  • Eventually you might find a "Ethernet [RealtekRTL8111]: replaceOrCopyPacket() failed." message in the log file. This is nothing to worry about and means that a single packet has been dropped because the driver failed to allocate a new packet buffer. Packet buffers are allocated from a buffer pool which is dynamically sized by the network stack. When the pool is exhausted the OS increases it's size making the error a self-healing issue.
Getting the driver Building from Source
I'm using XCode 4.6.2 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.

© 2013 InsanelyMac  |   News  |   Forum  |   Downloads  |   OSx86 Wiki  |   Mac Netbook  |   Web hosting by CatN  |   Designed by Ed Gain  |   Logo by irfan  |   Privacy Policy