66 Commits
0.0.2 ... 0.0.6

Author SHA1 Message Date
Oleg
3d19599175 Bump dkms package_version 2024-08-08 03:02:52 +03:00
Makarenko Oleg
6d0ac791b1 Merge pull request #19 from JacKeTUs/fix-alignment
Fix alignment on hid-ids.h
2024-08-08 03:00:47 +03:00
Oleg
bc87313267 Fix alignment on hid-ids.h 2024-08-08 03:00:27 +03:00
Makarenko Oleg
8f42ca6774 Merge pull request #16 from Lawstorant/rework-checks
Rework envelope check
2024-08-08 02:59:20 +03:00
Makarenko Oleg
2ee89cb9a4 Merge pull request #17 from JacKeTUs/aur-link-fix
Fix AUR package URL
2024-08-02 04:08:24 +03:00
Lawstorant
f8e9545f39 Fix AUR package URL 2024-08-02 04:07:57 +03:00
Lawstorant
241a25cee9 Fix AUR package URL 2024-07-27 00:12:07 +02:00
Lawstorant
8220bbbfb0 Rework envelope checks to fix FFB for Moza
Only set envelopes when they are needed (any value is != 0). This fixes
Moza FFB in games that use Sine effect to emulate constant force.

Remove FIX_PERIODIC_ENVELOPE quirk as it's no longer needed
2024-07-27 00:10:39 +02:00
Makarenko Oleg
96e036acda Merge pull request #15 from JacKeTUs/signing
Added signing section to the README
2024-07-22 13:07:07 +03:00
Oleg
bfbdb9620e Update information about key path 2024-07-19 11:55:35 +03:00
Oleg
38c629829f Fix spelling 2024-07-18 06:11:49 +03:00
Oleg
b58aee4403 Only unsigned modules affected 2024-07-17 18:19:58 +03:00
Oleg
34d6d6b294 Fix typo 2024-07-17 18:19:22 +03:00
Oleg
3ff83db322 We need to *install* driver, not *use* it 2024-07-17 17:56:17 +03:00
Oleg
d2585bcf17 Small change to README.md 2024-07-17 17:55:47 +03:00
Oleg
c092780bf3 Added signing section to the README 2024-07-17 17:54:35 +03:00
Makarenko Oleg
dcdd8c1e6a Merge pull request #14 from JacKeTUs/docs-update
Some README changes
2024-07-16 18:13:10 +03:00
Oleg
67f3a0be6a Some README changes 2024-07-16 18:11:50 +03:00
Makarenko Oleg
860794b6bb Merge pull request #11 from JacKeTUs/cammus
Added Cammus C5
2024-07-16 16:44:59 +03:00
Oleg
2e5efb2243 Merge branch 'main' into cammus 2024-07-16 12:37:52 +03:00
Makarenko Oleg
5416f537bf Merge pull request #12 from JacKeTUs/quirks-init
Move quirks initialization to the hid_pidff_init function
2024-07-16 12:37:11 +03:00
Oleg
3db0eef19a Rename hid_pidff_init 2024-07-16 12:30:29 +03:00
Oleg
d132ca633f Move quirks initialization to the hid_pidff_init function 2024-07-15 18:17:17 +03:00
Oleg
02a07521ae Add Cammus C5 to README.md 2024-07-15 04:54:18 +03:00
Oleg
ab76f16c32 Merge branch 'main' into cammus 2024-07-15 04:52:26 +03:00
Makarenko Oleg
a0b20c7055 Merge pull request #10 from JacKeTUs/no_delay_quirk_fix
Fix NO_DELAY_EFFECT quirk implementation
2024-07-15 04:51:15 +03:00
Oleg
11ed3dd91e Fix NO_DELAY_EFFECT quirk implementation 2024-07-15 04:50:08 +03:00
Oleg
776dccf8f9 Added Cammus wheel to the list with NO_DELAY quirk 2024-07-15 04:48:39 +03:00
Oleg
96088a6c56 Added Cammus C5 wheelbase ID 2024-07-15 04:47:12 +03:00
Makarenko Oleg
eb3766ac30 Merge pull request #8 from JacKeTUs/docs
Fix module names in README.md
2024-07-15 04:38:01 +03:00
Oleg
70fa7742f7 Fix module names in README.md 2024-07-15 04:36:27 +03:00
Makarenko Oleg
e9a0c9ac6b Merge pull request #3 from JacKeTUs/universal-quirks
Move from MOZA only driver to Universal implementation.
This can enable more wheelbases with just one driver
2024-07-15 04:04:19 +03:00
Oleg
d9ac2dbbb1 Fix DEST_MODULE_NAME 2024-07-15 04:01:19 +03:00
Oleg
b3ab9e9989 More clarifications in README.md 2024-07-15 03:59:02 +03:00
Oleg
94547c9bfc Pretty comments 2024-07-15 03:38:33 +03:00
Oleg
d449f45904 Clarify pidff_clamp function usage 2024-07-15 03:34:10 +03:00
Oleg
79f47bd686 Universal README file 2024-07-15 03:27:01 +03:00
Oleg
03d7fe30c7 Rename main source file, fix KBuild 2024-07-15 03:26:50 +03:00
Oleg
b0867e2e6c Fix BUILD_MODULE_NAME in dkms.conf 2024-07-15 03:26:34 +03:00
Makarenko Oleg
55cc69064d Merge pull request #5 from Lawstorant/universal-quirks
Add envelope fix quirk and value clamping functions
2024-07-14 23:08:21 +03:00
Lawstorant
dea4e51be5 Fix dkms build 2024-07-13 16:00:07 +02:00
Lawstorant
83d1374b63 Mention Boxflat in the README 2024-07-12 15:47:24 +02:00
Lawstorant
1da641aee4 Explain WHEEL_DIRECTION_FIX value 2024-07-12 15:46:42 +02:00
Tomasz Pakuła
ffa4a05a1b Update attack/fade logging 2024-07-02 11:55:36 +02:00
Tomasz Pakuła
33a99c7458 Add field value clamping functionality 2024-07-02 11:54:10 +02:00
Tomasz Pakuła
9d9e4c47bd Update build configs 2024-07-02 10:47:29 +02:00
Tomasz Pakuła
a6ec74f90d Remove unneeded paramaters 2024-07-02 10:47:22 +02:00
Tomasz Pakuła
db0eb52449 Add Moza periodic envelope and direction fixup 2024-07-02 01:24:15 +02:00
Oleg
93a696d1c8 Added code for no_delay quirk 2024-05-30 12:06:14 +03:00
Oleg
4826a9d4ef Remove infinite length quirk 2024-05-30 11:42:36 +03:00
Oleg
fe6100696e Update dkms.conf 2024-05-29 23:53:08 +03:00
Oleg
50a4b4fcd5 Update README.md 2024-05-29 23:46:34 +03:00
Oleg
ceaf164adf Change naming 2024-05-29 23:45:05 +03:00
Oleg
e5c6f7079c Rename pidff function 2024-05-29 23:44:21 +03:00
Oleg
2a63e469ea Fix missing semicolon 2024-05-29 23:40:37 +03:00
Oleg
b5f6015304 Fix build 2024-05-29 23:38:46 +03:00
Oleg
23255595f7 Small changes to initialization of quirks 2024-05-29 23:38:38 +03:00
Oleg
377eb942bf Rename Moza to newpidff 2024-05-29 23:38:16 +03:00
Oleg
fb5c25ccf5 Move MOZA id's 2024-05-29 23:38:00 +03:00
Makarenko Oleg
1ac6938ed4 Merge pull request #2 from Lawstorant/main
fix: direction for friction/damper/spring/inertia
Added quirks for wheels
2024-05-29 23:00:23 +03:00
Tomasz Pakuła
d449d1c4e0 Mention AUR package in README.md
Add MOZA RS V2 to the supported rims list
as tested by myself
Update contributor info
2024-05-28 23:30:02 +02:00
Tomasz Pakuła
70c5d3fa88 Fix direction for friction/damper/spring/inertia
Add quirks

Update info about contributors
2024-05-28 21:23:09 +02:00
Oleg
615c31a9f7 Clarify Moza PitHouse situation 2024-05-26 23:51:43 +03:00
Oleg
32a55b6f99 Added report fixup for Moza
Fixed header on PID Device Control
2024-05-26 04:37:41 +03:00
Oleg
0864cb67ef More debugging 2024-05-26 03:29:37 +03:00
Oleg
e365eba0dd Added debug Makefile option 2024-05-26 02:25:11 +03:00
11 changed files with 377 additions and 174 deletions

4
Kbuild
View File

@@ -1,3 +1,3 @@
obj-m := hid-moza-ff.o
hid-moza-ff-y := hid-moza.o hid-pidff.o
obj-m := hid-universal-pidff.o
hid-universal-pidff-y := hid-pidff-wrapper.o hid-pidff.o
ccflags-y := -Idrivers/hid

View File

@@ -4,6 +4,10 @@ KDIR := /lib/modules/${KVERSION}/build
default:
$(MAKE) -C $(KDIR) M=$$PWD
debug:
$(MAKE) -C $(KDIR) M=$$PWD EXTRA_CFLAGS="-g -DDEBUG"
install: default
$(MAKE) -C $(KDIR) M=$$PWD modules_install
depmod -A

View File

@@ -1,85 +1,77 @@
# Force feedback support for MOZA steering wheels
# Universal Force Feedback driver for Linux
Linux module driver for MOZA driving wheels.
Linux PIDFF driver with useful patches for initialization of FFB devices. Primarily targeting Direct Drive wheelbases.
MOZA wheels are basically DirectInput wheels.
In that repository - copy of pidff driver from 6.6 kernel with some changes around infinite length effects (like that https://github.com/berarma/ffbtools/issues/26)
## What's different between this and native pidff driver?
That driver allows most DirectDrive wheelbases to initialize and work.
Most of the DirectDrive wheelbases are basically DirectInput wheels, but with some caveats, which Windows allows, but pidff doesn't.
In that repository - pidff driver with some changes, which allows most of the DirectDrive wheelbases to work.
1. Added quirks for better initialization rules for different wheelbases (MOZA, VRS, Cammus)
2. Fixes for infinite-length effects
3. Fixes for out-of-bounds values (no more spam in kernel logs)
And that's basically it
## What devices are supported?
### Bases:
1. MOZA R3
1. MOZA R5
1. MOZA R9
1. MOZA R12
1. MOZA R16
1. MOZA R21
### Wheel rims:
Not tested
1. MOZA R3, R5, R9, R12, R16, R21
2. Cammus C5
3. ...
## What works?
1. FFB (all effects from device descriptor)
2. All inputs (wheel axis, buttons)
3. Setup through MOZA PitHouse with [some tweaking](#how-to-set-up-a-base-parameters))
## What does not work?
1. Telemetry functions (Shift lights, etc), mostly because telemetry works only with proprietary soft, which can't get access to shared memory chunks from games.
1. Telemetry functions (Shift lights, displays, SimHub, etc), mostly because telemetry works only with proprietary soft, which can't get access to shared memory chunks from games.
2. `Firmware Update` function. Use Windows PC or Windows VM at the moment.
3. Setup through proprietary software. May require [some tweaking](#how-to-set-up-a-base-parameters))
## How to install this driver?
You can install it through AUR package, through DKMS or manually.
On SecureBoot enabled systems you will need additional steps for load this driver into the system. See [Signing](docs/SIGNING.md#signing) section.
### AUR package
There's an [AUR package](https://aur.archlinux.org/packages/universal-pidff-dkms-git) for Arch Linux maintained by [@Lawstorant](https://github.com/Lawstorant).
## How to use that driver?
You can install it through DKMS or manually.
### DKMS
1. Install `dkms`
2. Clone repository to `/usr/src/moza-ff`
DKMS will install module into system, and will update it every time you update your kernel. Module will persist after reboots. It's the preferrable way to install it on the most distros.
1. Install `dkms` package from your distro package manager
2. Clone repository to `/usr/src/universal-pidff`
3. Install the module:
`sudo dkms install /usr/src/moza-ff`
`sudo dkms install /usr/src/universal-pidff`
4. Update initramfs:
`sudo update-initramfs -u`
5. Reboot
To remove module:
`sudo dkms remove moza-ff/<version> --all`
### Manually
`sudo dkms remove universal-pidff/<version> --all`
1. Install `linux-headers-$(uname -r)`
2. Clone repository
3. `make`
4. `sudo insmod hid-moza-ff.ko`
### Manually
Best for debugging purposes, where you need frequently change codebase/branches
1. Install `linux-headers-$(uname -r)` and `build-essential` packages from your distro package manager
2. Clone repository anywhere you want and `cd` into that directory
3. `make`. Alternatively, you can enable debug logs from the driver with `make debug`
4. Load module into system with `sudo insmod hid-universal-pidff.ko`
To unload module:
`sudo rmmod hid_moza_ff`
`sudo rmmod hid_universal_pidff`
## How to set up a base parameters?
### MOZA
**[Boxflat](https://github.com/Lawstorant/boxflat)** is a Linux Pit House alternative made by [@Lawstorant](https://github.com/Lawstorant)
You can do it through MOZA PitHouse with Wine. You need to tweak Wine prefix for them.
**[Android App](https://play.google.com/store/apps/details?id=com.gudsen.mozapithouse)**
That soft uses hidraw to set up a base. You need to create `udev` rule for allow access to hidraw device:
```
echo 'KERNEL=="hidraw*", ATTRS{idVendor}=="346e", MODE="0660", TAG+="uaccess"' | sudo tee /etc/udev/rules.d/11-moza.rules
udevadm control --reload-rules && udevadm trigger
```
Then you need to force MOZA soft to use hidraw, not SDL, to find devices:
1. Create new Wine prefix for them:
`mkdir ~/moza-wine`
2. Launch regedit in prefix:
`WINEPREFIX=$HOME/moza-wine wine regedit`
3. Create two keys in
`HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\winebus`:
* `DisableInput` (DWORD) - set to `1`;
* `Enable SDL` (DWORD) - set to `0`; (yes, variable name contains space)
4. Now you can launch soft through that WINEPREFIX:
`WINEPREFIX=$HOME/moza-wine wine MOZA\ Pit\ House.exe` - launch your PitHouse from installation directory.
### Cammus
**[Android App](https://play.google.com/store/apps/details?id=com.cammus.simulator)**
## Known issues with the driver
1. Firmware update does not work. Please use Windows machine or Windows VM for any firmware updates
- Buttons above 80 simply don't show up. This is a Linux limitation and we're trying to fix that in the upstream
## Known issues with the firmware
You tell me please

View File

@@ -1,8 +1,8 @@
PACKAGE_NAME="moza-ff"
PACKAGE_VERSION="0.0.1"
PACKAGE_NAME="universal-pidff"
PACKAGE_VERSION="0.0.6"
MAKE[0]="make KVERSION=$kernelver"
CLEAN="make clean"
BUILT_MODULE_NAME[0]="hid-moza-ff"
DEST_MODULE_NAME[0]="hid-moza-ff"
BUILT_MODULE_NAME[0]="hid-universal-pidff"
DEST_MODULE_NAME[0]="hid-universal-pidff"
DEST_MODULE_LOCATION[0]="/kernel/drivers/hid"
AUTOINSTALL="yes"

59
docs/SIGNING.md Normal file
View File

@@ -0,0 +1,59 @@
# Signing
## Signing module for SecureBoot
Latest kernels forbid loading unsigned custom kernel modules into the system with SecureBoot enabled.
For SecureBoot enabled system you have a choice:
1. Disable SecureBoot in your UEFI/BIOS
2. Use generated Machine Owner Key from DKMS (supports automatic signing)
3. Create Machine Owner Key and load it into your UEFI/BIOS, and sign kernel module with it.
### Using DKMS MOK key
MOK private key and certificates are generated the first time DKMS is run. You just need to import it to your system.
The location as well can be changed by setting the appropriate variables in /etc/dkms/framework.conf. For example, to allow usage of the system default Ubuntu update-secureboot-policy set the configuration file as follows:
```
mok_signing_key="/var/lib/shim-signed/mok/MOK.priv"
mok_certificate="/var/lib/shim-signed/mok/MOK.der"
```
```
# Find where keys are on your distro
ls -al /var/lib/dkms/mok*
# OR (on Ubuntu)
ls -al /var/lib/shim-signed/mok/MOK*
# Enroll keys into system
sudo mokutil --import /var/lib/dkms/mok.pub
# OR (on Ubuntu)
sudo mokutil --import /var/lib/shim-signed/mok/MOK.der
```
You need to reboot your PC after that, you will be greeted with blue screen dialog.
Choose "Enroll MOK", then "Continue" and "Yes". After that choose "Reboot system".
Now DKMS should sign updated modules automatically as they updated.
[Reference](https://github.com/dell/dkms/blob/master/README.md#module-signing)
### Manually create MOK key and manually sign kernel module
```
# This creates Machine Owner Key
openssl req -new -x509 -newkey rsa:2048 -keyout mok.key -outform DER -out mok.pub -nodes -days 36500 -subj "/CN=$hostname kernel module signing key/"
# This loads it into UEFI
sudo mokutil --import mok.pub
```
You need to reboot your PC after that, you will be greeted with blue screen dialog
Choose "Enroll MOK", enter your MOK password if exists, then "Continue", "Yes", and then reboot your system.
After that you can manually sign your built kernel module like so (feel free to adjust paths to keys/certificate/modules):
```
sudo /usr/src/linux-headers-$(uname -r)/scripts/sign-file sha256 mok.key mok.pub hid-universal-pidff.ko
```
Then you should be able to load driver like so:
```
sudo insmod hid-universal-pidff.ko
```

15
hid-ids.h Normal file
View File

@@ -0,0 +1,15 @@
/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __HID_IDS_H
#define __HID_IDS_H
#define USB_VENDOR_ID_MOZA 0x346e
#define USB_DEVICE_ID_MOZA_R3 0x0005
#define USB_DEVICE_ID_MOZA_R5 0x0004
#define USB_DEVICE_ID_MOZA_R9 0x0002
#define USB_DEVICE_ID_MOZA_R12 0x0006
#define USB_DEVICE_ID_MOZA_R16_R21 0x0000
#define USB_VENDOR_ID_CAMMUS 0x3416
#define USB_DEVICE_ID_CAMMUS_C5 0x0301
#endif

View File

@@ -1,71 +0,0 @@
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* HID driver for Moza Steering Wheels
*
* Copyright (c) 2024 Makarenko Oleg
*/
#include <linux/device.h>
#include <linux/hid.h>
#include <linux/module.h>
#include "hid-moza.h"
static const struct hid_device_id moza_devices[] = {
{ HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R3) },
{ HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R5) },
{ HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R9) },
{ HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R12) },
{ HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R16) },
{ HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R21) },
{ }
};
MODULE_DEVICE_TABLE(hid, moza_devices);
static int moza_probe(struct hid_device *hdev,
const struct hid_device_id *id)
{
int ret;
ret = hid_parse(hdev);
if (ret) {
hid_err(hdev, "parse failed\n");
goto err;
}
ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
if (ret) {
hid_err(hdev, "hw start failed\n");
goto err;
}
ret = hid_pidff_init_moza(hdev);
if (ret) {
hid_warn(hdev, "Force feedback not supported\n");
goto err;
}
return 0;
err:
return ret;
}
static int moza_input_configured(struct hid_device *hdev,
struct hid_input *hidinput)
{
struct input_dev *input = hidinput->input;
input_set_abs_params(input, ABS_X,
input->absinfo[ABS_X].minimum, input->absinfo[ABS_X].maximum, 0, 0);
return 0;
}
static struct hid_driver moza_ff = {
.name = "moza-ff",
.id_table = moza_devices,
.probe = moza_probe,
.input_configured = moza_input_configured,
};
module_hid_driver(moza_ff);
MODULE_AUTHOR("Oleg Makarenko <oleg@makarenk.ooo>");
MODULE_DESCRIPTION("MOZA HID FF Driver");
MODULE_LICENSE("GPL");

View File

@@ -1,15 +0,0 @@
/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __HID_MOZA_H
#define __HID_MOZA_H
#define USB_VENDOR_ID_MOZA 0x346e
#define USB_DEVICE_ID_MOZA_R3 0x0005
#define USB_DEVICE_ID_MOZA_R5 0x0004
#define USB_DEVICE_ID_MOZA_R9 0x0002
#define USB_DEVICE_ID_MOZA_R12 0x0006
#define USB_DEVICE_ID_MOZA_R16 0x0000
#define USB_DEVICE_ID_MOZA_R21 0x0000
int hid_pidff_init_moza(struct hid_device *hdev);
#endif

107
hid-pidff-wrapper.c Normal file
View File

@@ -0,0 +1,107 @@
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* HID PIDFF wrapper
* First of all targeting steering wheels and wheelbases
*
* Copyright (c) 2024 Makarenko Oleg
*/
#include <linux/device.h>
#include <linux/hid.h>
#include <linux/module.h>
#include "hid-ids.h"
#include "hid-pidff.h"
static const struct hid_device_id pidff_wheel_devices[] = {
{ HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R3),
.driver_data = PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
{ HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R5),
.driver_data = PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
{ HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R9),
.driver_data = PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
{ HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R12),
.driver_data = PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
{ HID_USB_DEVICE(USB_VENDOR_ID_MOZA, USB_DEVICE_ID_MOZA_R16_R21),
.driver_data = PIDFF_QUIRK_FIX_WHEEL_DIRECTION },
{ HID_USB_DEVICE(USB_VENDOR_ID_CAMMUS, USB_DEVICE_ID_CAMMUS_C5),
.driver_data = PIDFF_QUIRK_NO_DELAY_EFFECT },
{ }
};
MODULE_DEVICE_TABLE(hid, pidff_wheel_devices);
static u8 *moza_report_fixup(struct hid_device *hdev, __u8 *rdesc,
unsigned int *rsize)
{
// Fix data type on PID Device Control
if (rdesc[1002] == 0x91 && rdesc[1003] == 0x02) {
rdesc[1003] = 0x00; // Fix header, it needs to be Array.
}
return rdesc;
}
static u8 *universal_pidff_report_fixup(struct hid_device *hdev, __u8 *rdesc,
unsigned int *rsize)
{
if (hdev->vendor == USB_VENDOR_ID_MOZA) {
return moza_report_fixup(hdev, rdesc, rsize);
}
return rdesc;
}
/*
* Check if the device is PID and initialize it
* Add quirks after initialisation
*/
static int universal_pidff_probe(struct hid_device *hdev,
const struct hid_device_id *id)
{
int ret;
ret = hid_parse(hdev);
if (ret) {
hid_err(hdev, "parse failed\n");
goto err;
}
ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT & ~HID_CONNECT_FF);
if (ret) {
hid_err(hdev, "hw start failed\n");
goto err;
}
ret = hid_pidff_init_quirks(hdev, id);
if (ret) {
hid_warn(hdev, "Force feedback is not supported\n");
goto err;
}
return 0;
err:
return ret;
}
static int universal_pidff_input_configured(struct hid_device *hdev,
struct hid_input *hidinput)
{
// Remove fuzz and deadzone
struct input_dev *input = hidinput->input;
input_set_abs_params(input, ABS_X,
input->absinfo[ABS_X].minimum, input->absinfo[ABS_X].maximum, 0, 0);
return 0;
}
static struct hid_driver universal_pidff = {
.name = "hid-universal-pidff",
.id_table = pidff_wheel_devices,
.probe = universal_pidff_probe,
.input_configured = universal_pidff_input_configured,
.report_fixup = universal_pidff_report_fixup
};
module_hid_driver(universal_pidff);
MODULE_AUTHOR("Oleg Makarenko <oleg@makarenk.ooo>");
MODULE_DESCRIPTION("Universal HID PIDFF Driver");
MODULE_LICENSE("GPL");

View File

@@ -3,6 +3,8 @@
* Force feedback driver for USB HID PID compliant devices
*
* Copyright (c) 2005, 2006 Anssi Hannula <anssi.hannula@gmail.com>
* Copyright (c) 2024 Makarenko Oleg <oleg@makarenk.ooo>
* Copyright (c) 2024 Tomasz Pakuła <tomasz@pakula.org>
*/
/*
@@ -19,9 +21,18 @@
#include <linux/hid.h>
//#include "usbhid.h"
#include "hid-pidff.h"
#define PID_EFFECTS_MAX 64
/*
* This is 16384 or 90 degrees in polar coordinates (up)
* Racing games exclusively use polar coordinates but sometimes
* SDL/Proton mess with this value as they try to do
* some conversions to fix FFB for flight sticks
*/
#define PIDFF_FIXED_DIRECTION 0x4000
/* Report usage table used to put reports into an array */
#define PID_SET_EFFECT 0
@@ -62,6 +73,10 @@ static const u8 pidff_set_effect[] = {
0x22, 0x50, 0x52, 0x53, 0x54, 0x56, 0xa7
};
static const u8 pidff_set_effect_without_delay[] = {
0x22, 0x50, 0x52, 0x53, 0x54, 0x56
};
#define PID_ATTACK_LEVEL 1
#define PID_ATTACK_TIME 2
#define PID_FADE_LEVEL 3
@@ -184,6 +199,7 @@ struct pidff_device {
int operation_id[sizeof(pidff_effect_operation_status)];
int pid_id[PID_EFFECTS_MAX];
unsigned quirks;
};
/*
@@ -205,6 +221,36 @@ static int pidff_rescale_signed(int i, struct hid_field *field)
field->logical_minimum / -0x8000;
}
/*
* Clamp minimum value for the given field
*/
static int pidff_clamp_min(int i, struct hid_field *field)
{
int ret = i < field->logical_minimum ? field->logical_minimum : i;
pr_debug("clamped min value from %d to %d\n", i, ret);
return ret;
}
/*
* Clamp maximum value for the given field
*/
static int pidff_clamp_max(int i, struct hid_field *field)
{
int ret = i > field->logical_maximum ? field->logical_maximum : i;
pr_debug("clamped max value from %d to %d\n", i, ret);
return ret;
}
/*
* Clamp value for the given field
*/
static int pidff_clamp(int i, struct hid_field *field)
{
i = pidff_clamp_min(i, field);
i = pidff_clamp_max(i, field);
return i;
}
static void pidff_set(struct pidff_usage *usage, u16 value)
{
usage->value[0] = pidff_rescale(value, 0xffff, usage->field);
@@ -247,7 +293,11 @@ static void pidff_set_envelope_report(struct pidff_device *pidff,
pidff->set_envelope[PID_ATTACK_TIME].value[0] = envelope->attack_length;
pidff->set_envelope[PID_FADE_TIME].value[0] = envelope->fade_length;
hid_dbg(pidff->hid, "attack %u => %d\n",
hid_dbg(pidff->hid, "attack level %u => %d\n",
envelope->attack_level,
pidff->set_envelope[PID_ATTACK_LEVEL].value[0]);
hid_dbg(pidff->hid, "fade level %u => %d\n",
envelope->attack_level,
pidff->set_envelope[PID_ATTACK_LEVEL].value[0]);
@@ -261,6 +311,14 @@ static void pidff_set_envelope_report(struct pidff_device *pidff,
static int pidff_needs_set_envelope(struct ff_envelope *envelope,
struct ff_envelope *old)
{
if (!old) {
return envelope->attack_level != 0 ||
envelope->fade_level != 0 ||
envelope->attack_length != 0 ||
envelope->fade_length != 0;
}
return envelope->attack_level != old->attack_level ||
envelope->fade_level != old->fade_level ||
envelope->attack_length != old->attack_length ||
@@ -297,22 +355,31 @@ static int pidff_needs_set_constant(struct ff_effect *effect,
static void pidff_set_effect_report(struct pidff_device *pidff,
struct ff_effect *effect)
{
/* check for device quirks */
unsigned short direction = effect->direction;
if (pidff->quirks & PIDFF_QUIRK_FIX_WHEEL_DIRECTION)
direction = PIDFF_FIXED_DIRECTION;
pidff->set_effect[PID_EFFECT_BLOCK_INDEX].value[0] =
pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0];
pidff->set_effect_type->value[0] =
pidff->create_new_effect_type->value[0];
pidff->set_effect[PID_DURATION].value[0] =
effect->replay.length == 0 ? 0xffff : effect->replay.length;
pidff->set_effect[PID_TRIGGER_BUTTON].value[0] = effect->trigger.button;
pidff->set_effect[PID_TRIGGER_BUTTON].value[0] =
effect->trigger.button;
pidff->set_effect[PID_TRIGGER_REPEAT_INT].value[0] =
effect->trigger.interval;
pidff->set_effect[PID_GAIN].value[0] =
pidff->set_effect[PID_GAIN].field->logical_maximum;
pidff->set_effect[PID_DIRECTION_ENABLE].value[0] = 1;
pidff->effect_direction->value[0] =
pidff_rescale(effect->direction, 0xffff,
pidff->effect_direction);
pidff_rescale(direction, 0xffff, pidff->effect_direction);
if (!(pidff->quirks & PIDFF_QUIRK_NO_DELAY_EFFECT)) {
pidff->set_effect[PID_START_DELAY].value[0] = effect->replay.delay;
}
hid_hw_request(pidff->hid, pidff->reports[PID_SET_EFFECT],
HID_REQ_SET_REPORT);
@@ -344,7 +411,12 @@ static void pidff_set_periodic_report(struct pidff_device *pidff,
pidff_set_signed(&pidff->set_periodic[PID_OFFSET],
effect->u.periodic.offset);
pidff_set(&pidff->set_periodic[PID_PHASE], effect->u.periodic.phase);
pidff->set_periodic[PID_PERIOD].value[0] = effect->u.periodic.period;
// Actually we just can use clamp macro
// from include/linux/kernel.h#L59
// But for the debug purposes we're leaving it as is
pidff->set_periodic[PID_PERIOD].value[0] =
pidff_clamp(effect->u.periodic.period,
pidff->set_periodic[PID_PERIOD].field);
hid_hw_request(pidff->hid, pidff->reports[PID_SET_PERIODIC],
HID_REQ_SET_REPORT);
@@ -505,6 +577,7 @@ static void pidff_playback_pid(struct pidff_device *pidff, int pid_id, int n)
pidff->effect_operation[PID_LOOP_COUNT].value[0] = n;
}
hid_dbg(pidff->hid, "Playing effect %d %d times\n", pid_id, n);
hid_hw_request(pidff->hid, pidff->reports[PID_EFFECT_OPERATION],
HID_REQ_SET_REPORT);
}
@@ -565,7 +638,7 @@ static int pidff_upload_effect(struct input_dev *dev, struct ff_effect *effect,
pidff->block_load[PID_EFFECT_BLOCK_INDEX].value[0] =
pidff->pid_id[effect->id];
}
hid_dbg(pidff->hid, "Upload effect 0x%02x,", effect->type);
switch (effect->type) {
case FF_CONSTANT:
if (!old) {
@@ -578,9 +651,8 @@ static int pidff_upload_effect(struct input_dev *dev, struct ff_effect *effect,
pidff_set_effect_report(pidff, effect);
if (!old || pidff_needs_set_constant(effect, old))
pidff_set_constant_force_report(pidff, effect);
if (!old ||
pidff_needs_set_envelope(&effect->u.constant.envelope,
&old->u.constant.envelope))
if (pidff_needs_set_envelope(&effect->u.constant.envelope,
old ? &old->u.periodic.envelope : NULL))
pidff_set_envelope_report(pidff,
&effect->u.constant.envelope);
break;
@@ -617,9 +689,9 @@ static int pidff_upload_effect(struct input_dev *dev, struct ff_effect *effect,
pidff_set_effect_report(pidff, effect);
if (!old || pidff_needs_set_periodic(effect, old))
pidff_set_periodic_report(pidff, effect);
if (!old ||
pidff_needs_set_envelope(&effect->u.periodic.envelope,
&old->u.periodic.envelope))
if (pidff_needs_set_envelope(&effect->u.periodic.envelope,
old ? &old->u.periodic.envelope : NULL))
pidff_set_envelope_report(pidff,
&effect->u.periodic.envelope);
break;
@@ -635,9 +707,9 @@ static int pidff_upload_effect(struct input_dev *dev, struct ff_effect *effect,
pidff_set_effect_report(pidff, effect);
if (!old || pidff_needs_set_ramp(effect, old))
pidff_set_ramp_force_report(pidff, effect);
if (!old ||
pidff_needs_set_envelope(&effect->u.ramp.envelope,
&old->u.ramp.envelope))
if (pidff_needs_set_envelope(&effect->u.ramp.envelope,
old ? &old->u.periodic.envelope : NULL))
pidff_set_envelope_report(pidff,
&effect->u.ramp.envelope);
break;
@@ -740,7 +812,9 @@ static void pidff_autocenter(struct pidff_device *pidff, u16 magnitude)
pidff->set_effect[PID_TRIGGER_REPEAT_INT].value[0] = 0;
pidff_set(&pidff->set_effect[PID_GAIN], magnitude);
pidff->set_effect[PID_DIRECTION_ENABLE].value[0] = 1;
if (!(pidff->quirks & PIDFF_QUIRK_NO_DELAY_EFFECT)) {
pidff->set_effect[PID_START_DELAY].value[0] = 0;
}
hid_hw_request(pidff->hid, pidff->reports[PID_SET_EFFECT],
HID_REQ_SET_REPORT);
@@ -1068,10 +1142,23 @@ static int pidff_init_fields(struct pidff_device *pidff, struct input_dev *dev)
{
int envelope_ok = 0;
if (pidff->quirks & PIDFF_QUIRK_NO_DELAY_EFFECT) {
hid_dbg(pidff->hid, "Find fields for set_effect without delay\n");
if (pidff_find_fields(pidff->set_effect,
pidff_set_effect_without_delay,
pidff->reports[PID_SET_EFFECT], \
sizeof(pidff_set_effect_without_delay), 1)) {
hid_err(pidff->hid, "unknown set_effect report layout\n");
return -ENODEV;
}
}
else {
if (PIDFF_FIND_FIELDS(set_effect, PID_SET_EFFECT, 1)) {
hid_err(pidff->hid, "unknown set_effect report layout\n");
return -ENODEV;
}
}
PIDFF_FIND_FIELDS(block_load, PID_BLOCK_LOAD, 0);
if (!pidff->block_load[PID_EFFECT_BLOCK_INDEX].value) {
@@ -1154,7 +1241,9 @@ static void pidff_reset(struct pidff_device *pidff)
struct hid_device *hid = pidff->hid;
int i = 0;
hid_dbg(hid, "%s: Resetting the device...", __func__);
pidff->device_control->value[0] = pidff->control_id[PID_RESET];
hid_dbg(hid, "%s: PID_RESET control_id: %02x", __func__, pidff->device_control->value[0]);
/* We reset twice as sometimes hid_wait_io isn't waiting long enough */
hid_hw_request(hid, pidff->reports[PID_DEVICE_CONTROL], HID_REQ_SET_REPORT);
hid_hw_wait(hid);
@@ -1163,6 +1252,7 @@ static void pidff_reset(struct pidff_device *pidff)
pidff->device_control->value[0] =
pidff->control_id[PID_ENABLE_ACTUATORS];
hid_dbg(hid, "%s: PID_ENABLE_ACTUATORS control_id: %02x", __func__, pidff->device_control->value[0]);
hid_hw_request(hid, pidff->reports[PID_DEVICE_CONTROL], HID_REQ_SET_REPORT);
hid_hw_wait(hid);
@@ -1184,6 +1274,7 @@ static void pidff_reset(struct pidff_device *pidff)
hid_hw_wait(hid);
}
}
hid_dbg(hid, "%s: Resetting device complete", __func__);
}
/*
@@ -1225,9 +1316,9 @@ static int pidff_check_autocenter(struct pidff_device *pidff,
}
/*
* Check if the device is PID and initialize it
* Check if the device is PID and initialize it, with quirks
*/
int hid_pidff_init_moza(struct hid_device *hid)
int hid_pidff_init_quirks(struct hid_device *hid, const struct hid_device_id *id)
{
struct pidff_device *pidff;
struct hid_input *hidinput = list_entry(hid->inputs.next,
@@ -1249,6 +1340,8 @@ int hid_pidff_init_moza(struct hid_device *hid)
return -ENOMEM;
pidff->hid = hid;
pidff->quirks |= id->driver_data;
hid_dbg(dev, "Device quirks: %d\n", pidff->quirks);
hid_device_io_start(hid);
@@ -1314,7 +1407,7 @@ int hid_pidff_init_moza(struct hid_device *hid)
ff->set_autocenter = pidff_set_autocenter;
ff->playback = pidff_playback;
hid_info(dev, "Force feedback for Moza wheel\n");
hid_info(dev, "Force feedback for USB HID PID devices\n");
hid_device_io_stop(hid);

19
hid-pidff.h Normal file
View File

@@ -0,0 +1,19 @@
/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __HID_PIDFF_H
#define __HID_PIDFF_H
/* PIDFF Quirks to solve issues with certain devices */
/*
* Ignore direction and always set 16384 (0x4000)
*/
#define PIDFF_QUIRK_FIX_WHEEL_DIRECTION BIT(0)
/*
* Skip initialization of 0xA7 descriptor (Delay effect)
*/
#define PIDFF_QUIRK_NO_DELAY_EFFECT BIT(1)
int hid_pidff_init_quirks(struct hid_device *hid, const struct hid_device_id *id);
#endif