If you want to support me or accelerate the development of a special feature, consider a small donation ❤️ Just leave a message if your donation is for a specific use (like a new hardware or a specific function).

Advanced Linux Driver for Xbox One Wireless Gamepad

Quote from @atar-axis (Florian Dollinger), creator of the initial driver:

This is the first driver for the Xbox One Wireless Gamepad (which is shipped with the Xbox One S). I wrote it for a student project at fortiss GmbH and it is fully functional but does only support the connection via Bluetooth as yet - more will follow.

Many thanks to Kai Krakow who sponsored me a Xbox One Wireless Controller 🎮 (including Wireless Adapter) and a pack of mouthwatering guarana cacao ☕

Other Projects

xow is a driver for the Xbox One S controllers, too, and supports the native dongles packaged with the controller. Kudos to @medusalix for working together on finding some work-arounds for controller firmware bugs.
xpad supports this and many other controllers in USB mode.
xone is a driver aiming for fully supporting all Microsoft GIP devices thus replacing the xpad driver in the kernel while adding support for additional types of hardware.
MissionControl aims to support the controller on Nintendo Switch via Bluetooth.

These other projects may not support some of the advanced features of xpadneo.

Breaking Changes

Kernel 4.18 or newer required

As of xpadneo v0.10, we require kernel 4.18 or later to utilize HID_QUIRK_INPUT_PER_APP which splits the gamepad into multiple sub-devices to fix problems and incompatibilities at several layers.

SDL2 2.28 Compatibility

Thanks to @slouken from SDL2, xpadneo mappings are now auto-detected in the upcoming SDL2 2.28 release. This will fix long-standing problems with Steam Input and SDL2 games. With this release, we will also have full paddle support.

If you still see problems, ensure that you didn't create custom controllerdb entries. See also:

Known issues:

The Share button will currently not be recognized by SDL2, scheduled to be fixed in xpadneo v0.11

Quirks by Design

With BLE firmware, all models switched to a unified HID report descriptor, only the XBE2 controller identifies with PID 0x0B22 while the other models identify with PID 0x0B13. This has some known consequences:

All non-XBE2 controllers will claim to have a Share button no matter if it physically exists. As HID doesn't report the internal model number, xpadneo cannot fix it currently. The button is currently mapped to F12, so this has no consequences.
All XBE2 controllers will claim to have a full keyboard and the Share button is actually the Profile button. Since Share is currently mapped to F12, this will have no consequences.

Advantages of this Driver

Supports Bluetooth
Supports all Force Feedback/Rumble effects through Linux ff-memless effect emulation
Supports Trigger Force Feedback in every game by applying a pressure-dependent effect intensity to the current rumble effect (not even supported in Windows)
Supports disabling FF
Supports multiple Gamepads at the same time (not even supported in Windows)
Offers a consistent mapping, even if the Gamepad was paired to Windows/Xbox before, and independent of software layers (SDL2, Stadia via Chrome Gamepad API, etc)
Working Select, Start, Mode buttons
Working paddles (buttons on the backside of the controller)
Correct Axis Range (signed, important for e.g. RPCS3)
Supports Battery Level Indication (including the Play 'n Charge Kit)
Easy Installation
Agile Support and Development
Supports customization through profiles (work in progress)
Optional high-precision mode for Wine/Proton users (disables dead zones so games don't apply an additional one)
Share button support on supported controllers

Unavailable Features

Across all models, xpadneo won't support audio features of the controllers because the firmware doesn't support audio in Bluetooth mode. In the future, xpadneo may support audio when USB and dongle support will be added.

Xbox One S Wireless Controller

This is the initial controller supported from the first version of xpadneo. All features are fully supported. This controller uses emulated profile switching support (see below).

Xbox Elite Series 2 Wireless Controller

Basic support for the Xbox Elite Series 2 Wireless controller is present, covering all the features of the driver. The following features are missing:

Upload of profile mappings and sensitivity curves is currently not supported.

This controller uses native profile switching support (see below).

Xbox Series X|S Wireless Controller

Full support for the Xbox Series X|S controller is present including the share button. This is currently statically mapped to keyboard event KEY_F12 to take screenshots with Steam. It will be configurable in the future. This controller uses emulated profile switching support (see below).

This controller uses BLE (Bluetooth low energy) and can only be supported if your Bluetooth dongle also supports BLE.

Known problems: The controller may not properly set its connection parameters, resulting in laggy and choppy input experience. See also: Troubleshooting.

8BitDo Controllers

This driver supports the Nintendo layout of those controllers to exposes them correctly as button A, B, X, and Y as labelled on the device. This is swapped compared to the original Xbox controller layout. However, this feature is not enabled by default. If you want to use this feature, you have to add a quirk flag to the module options:

# /etc/modprobe.conf
options hid_xpadneo quirks=E4:17:D8:xx:xx:xx+32

where you replace xx:xx:xx with the values from your controller MAC (as shown in dmesg). The value 32 enables Nintendo layout. If you'll want to add other quirk flags, simply add the values, e.g. 32 + 7 (default quirks for 8BitDo) = 39. After changing this, reload the driver or reboot.

This controller uses emulated profile switching support (see below).

Breaking change: Users of previous versions of the driver may want to remove their custom SDL mappings. Full support has been added for these controllers and broken mapping of previously versions no longer needs to be applied. See also: SDL.

GuliKit KingKong Controller Family

This driver supports the GuliKit King Kong controller family, the driver was tested with model NS09 (using firmware v2.0) but should work just fine for the older models, too. If in doubt, follow the firmware upgrade guides on the GuliKit home page to receive the latest firmware. Both the Android mode and the X-Input mode are supported but it may depend on your Bluetooth stack which mode works better for you (Android mode didn't pair for me).

# /etc/modprobe.conf
options hid_xpadneo quirks=98:B6:EA:xx:xx:xx+32

where you replace xx:xx:xx with the values from your controller MAC (as shown in dmesg). The value 32 enables Nintendo layout. If you'll want to add other quirk flags, simply add the values, e.g. 32 + 131 (default quirks for GuliKit) = 163. After changing this, reload the driver or reboot.

However, alternatively the controller supports swapping the buttons on the fly, too: Just press and hold the settings button, the click the plus button. Thus, the quirks flag is just a matter of setting the defaults.

This controller uses emulated profile switching support (see below).

Profile Switching

The driver supports switching between different profiles, either through emulation or by using the hardware switch that comes with some models. This switching can be done at any time even while in a game. The API for customizing each profile does not exist yet.

Native Profile Switching Support

The driver support native profile switching for the Xbox Elite Series 2 controller. However, the feature is not finalized yet:

The default profile (no LED) exposes the paddles as extra buttons.
The other three profiles behave the same way by default. While there is no support for modifying them currently, configurations set in the Xbox Accessories app (Windows only) will carry over and operate as intended.

Emulated Profile Switching Support

The driver emulates profile switching for controllers without a hardware profile switch by pressing buttons A, B, X, or Y while holding down the Xbox logo button. However, the following caveats apply:

Profiles currently behave all the same, and there is no support for configuring them.
Full support will be available once the Xbox Elite Series 2 controller is fully supported.
If you hold the button for too long, the controller will turn off - we cannot prevent that.

Getting Started

Distribution Packages

If your distribution has a maintained package, you can just use that and do not need to follow the manual install instructions below:

Prerequisites

Make sure you have installed dkms, linux headers and a bluetooth implementation (e.g. bluez) and their dependencies.

Kernel maintainers should also include the uhid module (CONFIG_UHID) because otherwise Bluetooth LE devices (all models with firmware 5.x or higher) cannot create the HID input device which is handled in user-space by the bluez daemon.

On Arch and Arch-based distros (like EndeavourOS), try sudo pacman -S dkms linux-headers bluez bluez-utils
On Debian based systems (like Ubuntu) you can install those packages by running sudo apt-get install dkms linux-headers-`uname -r`
On Fedora, it is sudo dnf install dkms make bluez bluez-tools kernel-devel-`uname -r` kernel-headers
On Manjaro try sudo pacman -S dkms linux-latest-headers bluez bluez-utils
On openSUSE (tested on Tumbleweed, should work for Leap), it is sudo zypper install dkms make bluez bluez-tools kernel-devel kernel-source
On OSMC you will have to run the following commands sudo apt-get install dkms rbp2-headers-`uname -r` sudo ln -s "/usr/src/rbp2-headers-`uname -r`" "/lib/modules/`uname -r`/build" (as a workaround)
On Raspbian, it is sudo apt-get install dkms raspberrypi-kernel-headers If you recently updated your firmware using rpi-update the above package may not yet include the header files for your kernel. Please follow the steps described here in this case.
On generic distributions, it doesn't need DKMS but requires a configured kernel source tree, then: cd hid-xpadneo && make modules && sudo make modules_install

Please feel free to add other distributions as well!

Installation

Download the Repository to your local machine git clone https://github.com/atar-axis/xpadneo.git
cd xpadneo
If using DKMS, run sudo ./install.sh
If not using DKMS, follow steps above (generic distribution)
Done!

Connection

sudo bluetoothctl
[bluetooth]# scan on
wait until all available devices are listed (otherwise it may be hard to identify which one is the gamepad)
push the connect button on upper side of the gamepad, and hold it down until the light starts flashing fast
wait for the gamepad to show up in bluetoothctl, remember the address (e.g. C8:3F:26:XX:XX:XX)
[bluetooth]# scan off to stop scanning as it may interfere with properly pairing the controller
[bluetooth]# pair <MAC>
[bluetooth]# trust <MAC>
[bluetooth]# connect <MAC> (should usually not be needed but there are open bugs)
The <MAC> parameter is optional if the command line already shows the controller name

You know that everything works fine when you feel the gamepad rumble ;)

Configuration

If using DKMS: Use sudo ./configure.sh to configure the driver as you wish. The script will guide you through the available options.

Update

In order to update xpadneo, do the following

Update your cloned repo: git pull
If using DKMS: Run sudo ./update.sh
otherwise follow the steps above (generic distribution)

Uninstallation

If using DKMS: Run sudo ./uninstall.sh to remove all installed versions of hid-xpadneo
otherwise follow the steps above (generic distribution)

Further Information

For further information please visit the GitHub Page https://atar-axis.github.io/xpadneo/ which is generated automatically from the content of the /docs folder.

You will find there e.g. the following sections

dszakallas/xpadneo