Very simple, work in progress input driver for the SPI keyboard / trackpad found on 12" MacBooks (2015 and later) and newer MacBook Pros (late 2016 and later), as well a simple touchbar and ambient-light-sensor driver for 2016 MacBook Pro's.
The touchbar driver was recently refactored; if you're upgrading from the
appletb driver, please see the Upgrading section; if you're running a kernel before 4.16 then please check out the legacy branch instead.
If you're on any MacBook or MacBook Pro other than MacBook8,1 (2015), and you're running a kernel before 4.11, then you'll need to boot the kernel with
intremap=nosid. In all cases make sure you don't have
noapic in your kernel options.
On the 2015 MacBook you need to (re)compile your kernel with
CONFIG_X86_INTEL_LPSS=n if running a kernel before 4.14. And on all kernels you need ensure the
spi_pxa2xx_pci modules are loaded too (if you don't have those module, rebuild your kernel with
On all other MacBook's and MacBook Pros you need to instead make sure both the
intel_lpss_pci modules are loaded (if these don't exist, you need to (re)compile your kernel with
For best results everywhere, make sure all three modules (this
applespi driver plus the two core ones mentioned above) are present in your initramfs/initrd so that the keyboard is functional by the time the prompt for the disk password appears. Also, having them loaded early also appears to remove the need for the
irqpoll kernel parameter on MacBook8,1's.
DKMS module (Debian & co):
As root, do the following (all MacBook's and MacBook Pro's except MacBook8,1 (2015)):
echo -e "\n# applespi\napplespi\nspi_pxa2xx_platform\nintel_lpss_pci" >> /etc/initramfs-tools/modules apt install dkms git clone https://github.com/roadrunner2/macbook12-spi-driver.git /usr/src/applespi-0.1 dkms install -m applespi -v 0.1
If you're on a MacBook8,1 (2015):
echo -e "\n# applespi\napplespi\nspi_pxa2xx_platform\nspi_pxa2xx_pci" >> /etc/initramfs-tools/modules apt install dkms git clone https://github.com/cb22/macbook12-spi-driver.git /usr/src/applespi-0.1 dkms install -m applespi -v 0.1
- Basic Typing
- FN keys
- Driver unloading (no more hanging)
- Basic touchpad functionality (even right click, handled by libinput)
- MT touchpad functionality (two finger scroll, probably others)
- Suspend / resume
What doesn't work:
- Key rollover (properly)
- Wakeup on keypress / touchpad
- Occasionally, the SPI device can get itself into a state where it causes an interrupt storm. There should be a way of resetting it, or better yet avoiding this state altogether.
Interrupts are now working! This means that the driver is no longer polled, and should no longer be a massive battery drain. For more information on how the driver receives interrupts, see the discussion here
The touchpad protocol is the same as the bcm5974 driver. Perhaps there is a nice way of utilizing it? For now, bits of code have just been copy and pasted.
debug module parameter can be used to turn debugging output on (and off) dynamically, and can be set in all the usual ways (e.g. via kernel command-line (
applespi.debug=0x1), via sysfs (
echo 0x10000 | sudo tee /sys/module/applespi/parameters/debug), etc.).
Some useful values are (since the value is a bitmask, these can be combined):
- 0x10000 - determine touchpad values range
- 0x1 - turn on logging of touchpad initialization packets
- 0x6 - turn on logging of backlight and caps-lock-led packets
The touchbar and ambient-light-sensor (ALS) are part of the iBridge chip, and hence there are 3 modules corresponding to these (
apple_ib_als). Generally loading any one of these will load the others, unless you are loading them via
insmod. If loading manually (i.e. via
insmod), you need to first load the
The touchbar driver provides basic touchbar functionality (enabling the touchbar and switching between modes based on the FN key). The touchbar is automatically dimmed and later switched off if no (internal) keyboard, touchpad, or touchbar input is received for a period of time; any (internal) keyboard, touchpad, or touchbar input switches it back on. The timeouts till the touchbar is dimmed and turned off can be changed via the
dim_timeout module params or sysfs attributes (
/sys/class/input/input9/device/...); they default to 5 min and 4.5 min, respectively. See also
The ALS driver exposes the ambient light sensor; if you have the
iio-sensor-proxy installed then it should be recognized and handled automatically.
The touchbar and ALS drivers used to be in a single module,
appletb. This has now been split up into 3 modules,
apple_ib_als. Generally whereever you were using
appletb (e.g. in the initrd/dracut/whatever configs) you want to use
apple_ib_tb now. Also, make sure to remove the old
appletb module, either by first doing a
sudo dkms remove applespi/0.1 --all before upgrading, or by manually removing the driver (e.g.
sudo find /lib/modules/ -name appletb.ko | xargs rm).