Home

Awesome

VoodooRMI

Gitter

A port for macOS of Synaptic's RMI Trackpad driver from Linux. This works for both I2C HID trackpads from Synaptic as well as Synaptic's SMBus trackpads. When following the instructions below, make sure you only select I2C or SMBus depending on your trackpad's capabilities.

Supported Features

Compatibility

Synaptic trackpads generally work over SMBus or I2C, though not both. Pay close attention to which bus it works over.

SMBus

macOS (Requires Acidanthera's VoodooPS2 version 2.3.6 or above):

Windows:

Linux:

I2C

macOS:

Windows:

Linux:

Requirements

SMBus

I2C

NameMain function
SYN1B7FF12
SYNA0000F11
SYNA1202F12
SYNA2393unknown
SYNA2B2CF12
SYNA2B31F12
SYNA2B33F11
SYNA2B5AF12
SYNA2B61F11
SYNA2B34unknown
SYN3054F11
SYNA3083F12
SYNA3105unknown
SYNA328BF12
SYNA328EF12
SYNA3602unknown
SYNA7500unknown
SYNA7501unknown
SYNA7DABF12
SYNA7DB5F12

Installation

  1. Add the required kexts to your bootloader
  2. Make sure VoodooPS2 is configured as below:
    • Enabled:
      • VoodooPS2Controller.kext
      • VoodooPS2Controller.kext/Contents/PlugIns/VoodooPS2Mouse.kext
      • VoodooPS2Controller.kext/Contents/PlugIns/VoodooPS2Keyboard.kext
      • VoodooPS2Controller.kext/Contents/PlugIns/VoodooPS2Trackpad.kext
    • Disabled:
      • VoodooPS2Controller.kext/Contents/PlugIns/VoodooInput.kext
  3. For OpenCore users, make sure to add the below kexts in the order they're listed into your config.plist.
    • VoodooRMI.kext
    • VoodooRMI.kext/Contents/PlugIns/VoodooInput.kext
    • SMBus trackpads:
      • VoodooSMBus.kext
      • VoodooRMI.kext/Contents/PlugIns/RMISMBus.kext
    • I2C trackpads:
      • VoodooI2C.kext
      • VoodooRMI.kext/Contents/PlugIns/RMII2C.kext

There is no support for this kext being loaded into Library/Extensions or System/Library/Extensions. This likely won't break loading it, but test with injection first before sending in a bug report.

Configuration

The values below can be configured through either ioio or ACPI. An example SSDT can be found under the ACPI examples folder. Note that using non-integer value causes undefined behaviour which may prevent the kext from loading

ValueDefaultDescription
ForceTouchType1Controls how force touch emulation behaves. 0 = Disabled, 1 = Clickpad press with size threshold, 2 = size threshold only
ForceTouchMinPressure90Minimum z value to trigger Force touch when clickpad is clicked
DisableWhileTypingTimeout250Milliseconds after typing in which to reject trackpad packets
DisableWhileTrackpointTimeout250Milliseconds after using the trackpoint in which to reject trackpad packets
TrackpointMultiplier20Multiplier used on trackpoint inputs (other than scrolling). This is divided by 20, so the default value of 20 will not change the output value at all
TrackpointScrollMultiplierX20Multiplier used on the x axis when middle button is held down for scrolling. This is divided by 20.
TrackpointScrollMultiplierY20Same as the above, except applied to the Y axis
TrackpointDeadzone1Minimum value at which trackpoint reports will be accepted. This is subtracted from the input of the trackpoint, so setting this extremely high will reduce trackpoint resolution
MinYDiffThumbDetection200Minimum distance between the second lowest and lowest finger in which Minimum Y logic is used to detect the thumb rather than using the z value from the trackpad. Setting this higher means that the thumb must be farther from the other fingers before the y coordinate is used to detect the thumb, rather than using finger area. Keeping this smaller is preferable as finger area logic seems to only be useful when all 4 fingers are grouped together closely, where the thumb is more likely to be pressing down more
PalmRejectionMaxObjWidth255Max contact width before contact is considered accidental. This value can be acquired by experimentation using Rehabman's ioio.
PalmRejectionMaxObjHeight255Max contact height before contact is considered accidental. This value can be acquired by experimentation using Rehabman's ioio.
PalmRejectionWidth10Percent (out of 100) width of trackpad which is used as a low confidence zone on the left and right side of the trackpad
PalmRejectionWidth60Percent (out of 100) height of trackpad which is used as a low confidence zone on the left and right side of the trackpad (starting from the top)
PalmRejectionTrackpointHeight20Percent (out of 100) height of trackpad which is used as a low confidence zone across the top of the trackpad

Note that you can use Rehabman's ioio to set properties temporarily (until the next reboot).
ioio -s RMIBus ForceTouchType 0
ioio -s RMIBus PalmRejectionMaxObjWidth 5
ioio -s RMIBus PalmRejectionMaxObjHeight 6

Building

  1. git submodule update --init --recursive
  2. git clone --depth 1 https://github.com/acidanthera/MacKernelSDK
  3. Build within XCode using the play button in the top left
    • RMISMBus/RMII2C will automatically build when building VoodooRMI

Loading/Unloading

For loading, you may need to put RMII2C/RMISMBus's dependencies into the kextload command. Note that RMISMBus/RMII2C depend on VoodooRMI.

The below examples assume VoodooSMBus/VoodooI2C are in the same folder as VoodooRMI. If they are not, you will need to give the path to those kexts. When manually loading from within macOS, keep in mind that csrutil needs to be partially disabled to allow unsigned kexts, and the kexts need to be owned by Root.

Changing owner of kext

// Note that this changes the owner of every kext in the directory your in
sudo chown -R root:wheel *.kext

Manually loading kext

Example for SMBus:

cd path/to/unziped-VoodooRMI_Debug
sudo kextutil -vvvv -d VoodooRMI.kext -d VoodooSMBus.kext VoodooRMI.kext/Contents/PlugIns/RMISMBus.kext

Example for I2C:

sudo kextutil -vvvv -d VoodooRMI.kext -d VoodooI2C.kext VoodooRMI.kext/Contents/PlugIns/RMII2C.kext

For unloading, you can use the bundle ids. This should unload cleanly, though you may need to unload twice in a row to get it to cooperate.

sudo kextunload -vvvv -b com.1Revenger1.RMISMBus -b com.1Revenger1.VoodooRMI

Troubleshooting

Before creating an issue, please check the below:

  1. Make sure VoodooSMBus/VoodooI2C is loading and attaching
  2. Make sure VoodooInput and VoodooPS2Trackpad is loading
    • kextstat | grep Voodoo
  3. You may need to do IRQ patching on Haswell and older devices for SMBus trackpads
    • Required if the SBUS device does not have any IOInterruptControllers in IORegistryExplorer
    • CorpNewt's SSDTTime can do this automatically for you

If the above are loading, next place to check is within the IORegistry and within VoodooRMI logs:

  1. Use IORegistryExplorer to check what is attaching and loading.
    • The various functions in VoodooRMI will publish debug information which can be useful
    • IORegs can be be saved using File -> Save As in the top left
  2. Get logs from within macOS
    • If loading VoodooRMI using kextload or kextutil within macOS, you can use sudo log show --last boot | grep VRMI
    • If injecting through OpenCore/Clover, you will want to either use DebugEnhancer.kext or add the boot arg msgbuf=1048576. Once in macOS, use sudo dmesg | grep VRMI immediately after booting to get the logs.

When creating an issue, you will need to provide log files (IORegs not required but helpful)!