Skip to content

Commit f789ebf

Browse files
systemofapwnesystemofapwne
committed
Improved initial installation and removal of the driver - So reduced complexity: Automatic bind/unbind.
1 parent 67e0f9c commit f789ebf

14 files changed

+310
-64
lines changed

‎Makefile

+12-2
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,23 @@ udev_install:
6666
@echo "====================================================="
6767
install -m 644 -v -D install_files/udev/99-leetmouse.rules $(DESTDIR)/usr/lib/udev/rules.d/99-leetmouse.rules
6868
install -m 755 -v -D install_files/udev/leetmouse_bind $(DESTDIR)/usr/lib/udev/leetmouse_bind
69+
install -m 755 -v -D install_files/udev/leetmouse_manage $(DESTDIR)/usr/lib/udev/leetmouse_manage
70+
71+
udev_trigger:
72+
@echo -e "\n::\033[34m Triggering new udev rules\033[0m"
73+
@echo "====================================================="
74+
udevadm control --reload-rules
75+
udevadm trigger --subsystem-match=usb --subsystem-match=input --subsystem-match=hid --attr-match=bInterfaceClass=03 --attr-match=bInterfaceSubClass=01 --attr-match=bInterfaceProtocol=02
6976

7077
udev_uninstall:
7178
@echo -e "\n::\033[34m Uninstalling leetmouse udev rules\033[0m"
7279
@echo "====================================================="
73-
rm -f $(DESTDIR)/usr/lib/udev/rules.d/99-leetmouse.rules $(DESTDIR)/usr/lib/udev/leetmouse_bind
80+
rm -f $(DESTDIR)/usr/lib/udev/rules.d/99-leetmouse.rules $(DESTDIR)/usr/lib/udev/leetmouse_bind $(DESTDIR)/usr/lib/udev/leetmouse_manage
81+
udevadm control --reload-rules
82+
. $(DESTDIR)/usr/lib/udev/leetmouse_manage unbind_all
83+
rm -f $(DESTDIR)/usr/lib/udev/leetmouse_manage
7484

75-
install_i_know_what_i_am_doing: all driver_install udev_install
85+
install_i_know_what_i_am_doing: all driver_install udev_install udev_trigger
7686
install: manual_install_msg ;
7787

7888
manual_install_msg:

‎README.org

+30-21
Original file line numberDiff line numberDiff line change
@@ -6,63 +6,72 @@
66
* Installation & Uninstallation
77
** Preparation & Configuration
88
+ Clone this repository, copy =driver/config.sample.h= to =/driver/config.h= and edit it in your favorite text editor. Change the defines at the top of config.h to match your desired acceleration settings.
9-
+ Make sure, you have the required toolchains (e.g. =base-devel= on Arch or =build-essentials= on Debian) installed as well as the =linux-headers= for your installed kernel.
9+
+ Make sure, you have the required toolchains (e.g. =base-devel= on Arch or =build-essentials= on Debian) installed as well as the =linux-headers= for your installed kernel.
1010
** Arch/Manjaro
1111
Since the maintainer of =LEETMOUSE= is an Arch and Manjaro user, a =PKGBUILD= has been written for seamless integration into pacman.
12+
1213
*Installation*
1314
#+begin_src sh
15+
# Create the PKGBUILD, copy associated files and run makepkg
1416
./scripts/build_arch.sh
15-
cd pkg/build
16-
makepkg -f
17-
sudo pacman -U leetmouse*.zst
17+
# Run pacman on the created package
18+
sudo pacman -U pkg/build/leetmouse*.zst
1819
#+end_src
20+
All your mice should now be bound to this driver. They will also automatically bind to it after a reboot. If this did not work, run =sudo /usr/lib/udev/leetmouse_manage bind_all=
1921

2022
*Uninstallation*
2123
#+begin_src sh
2224
sudo pacman -R leetmouse-driver-dkms
2325
#+end_src
26+
All your mice should now be bound to the generic usbhid driver again.
27+
2428
** Other distros
25-
Other distributions' package-managers are not yet supported and thus need a manual installation.
26-
The installation is not yet very polished but eventually will become soon.
29+
Other distributions' package-managers are not yet supported and thus need a manual installation. However Debian based systems are planned.
30+
The installation is not yet very polished but eventually will become so.
2731

2832
*Installation*
2933

3034
Determine the current version of this module by examining the variable =DKMS_VER= in the =Makefile=. It can be e.g. 0.9.0
3135
Run the following commands to build and install the kernel module
3236
#+begin_src sh
37+
# Install the driver and activate the dkms module
3338
sudo make setup_dkms && sudo make udev_install
3439
sudo dkms install -m leetmouse-driver -v 0.9.0 # Enter the version you determined from the Makefile earlier in here
35-
udevadm control --reload-rules
3640
#+end_src
37-
Unplug and replug your mouse - Or reboot. From now on, your mouse will automatically bind to this driver.
38-
41+
All your mice should now be bound to this driver. They will also automatically bind to it after a reboot. If this did not work, run =sudo /usr/lib/udev/leetmouse_manage bind_all=
42+
If this still does not work, there is a major problem
43+
3944
*Uninstallation*
4045

41-
Your again need to know then =version= as described above for the installation
46+
You again need to know then =version= as described above for the installation
4247
#+begin_src sh
48+
# Unbind all mice from the driver
49+
sudo /usr/lib/udev/leetmouse_manage unbind_all
50+
# Uninstall the driver
4351
sudo dkms remove -m leetmouse-driver -v 0.9.0
4452
sudo make remove_dkms && sudo make udev_uninstall
4553
#+end_src
54+
Unplug and replug your mouse or reboot to have your mice bound back to the generic usbhid.
4655
* Manual compile, insmod, bind
47-
If you want to compile this module only for testing purposes or development, you do not need to install the whole package to your system
56+
If you want to compile this module only for testing purposes or development, you do not need to install the whole package to your system
4857

49-
Compile the module, remove previously loaded modules and insert it.
50-
#+begin_src sh
51-
make clean && make
52-
sudo rmmod leetmouse
53-
sudo insmod ./driver/leetmouse.ko
54-
#+end_src
55-
If you did not install the udev rules before via =make udev_install= you need to manually bind your mouse to this driver.
56-
You can take a look at =/scripts/bind.sh= for an example on how to determine your mouse's USB address for that
58+
Compile the module, remove previously loaded modules and insert it.
59+
#+begin_src sh
60+
make clean && make
61+
sudo rmmod leetmouse
62+
sudo insmod ./driver/leetmouse.ko
63+
#+end_src
64+
If you did not install the udev rules before via =sudo make udev_install= you need to manually bind your mouse to this driver.
65+
You can take a look at =/scripts/bind.sh= for an example on how to determine your mouse's USB address for that. However using the udev rules for development is advised.
5766

5867
* TODOS
59-
| External interface for dynamically pushing acceleration parameters | Next priority |
6068
| Fixing the only [[https://github.com/systemofapwne/mousedriver/issues/2][vertical srolling bug]] | Next priority |
69+
| External interface for dynamically pushing acceleration parameters | Next priority |
6170
| GUI to configure the parameters | Next next priority |
6271
| Feature parity with Povohats driver and later even RawAccel | Next next next priority |
6372
| Easier installation & binding | Done |
6473
| DKMS support | Done |
6574
| PKGBUILD for Arch based systems | Done |
6675
| AUR package release | TBD |
67-
| Debian (based systems) package | TBD |
76+
| dpkg package for Debian based systems | TBD |
6877

‎debug/devices/steelseries_kana.txt

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
Bus 001 Device 011: ID 1038:1364 SteelSeries ApS Kana Gaming Mouse
2+
Device Descriptor:
3+
bLength 18
4+
bDescriptorType 1
5+
bcdUSB 1.10
6+
bDeviceClass 0
7+
bDeviceSubClass 0
8+
bDeviceProtocol 0
9+
bMaxPacketSize0 64
10+
idVendor 0x1038 SteelSeries ApS
11+
idProduct 0x1364
12+
bcdDevice 1.07
13+
iManufacturer 1 SteelSeries
14+
iProduct 2 Kana Gaming Mouse
15+
iSerial 0
16+
bNumConfigurations 1
17+
Configuration Descriptor:
18+
bLength 9
19+
bDescriptorType 2
20+
wTotalLength 0x003b
21+
bNumInterfaces 2
22+
bConfigurationValue 1
23+
iConfiguration 0
24+
bmAttributes 0xa0
25+
(Bus Powered)
26+
Remote Wakeup
27+
MaxPower 100mA
28+
Interface Descriptor:
29+
bLength 9
30+
bDescriptorType 4
31+
bInterfaceNumber 0
32+
bAlternateSetting 0
33+
bNumEndpoints 1
34+
bInterfaceClass 3 Human Interface Device
35+
bInterfaceSubClass 0
36+
bInterfaceProtocol 0
37+
iInterface 0
38+
HID Device Descriptor:
39+
bLength 9
40+
bDescriptorType 33
41+
bcdHID 1.11
42+
bCountryCode 0 Not supported
43+
bNumDescriptors 1
44+
bDescriptorType 34 Report
45+
wDescriptorLength 37
46+
Report Descriptors:
47+
** UNAVAILABLE **
48+
Endpoint Descriptor:
49+
bLength 7
50+
bDescriptorType 5
51+
bEndpointAddress 0x81 EP 1 IN
52+
bmAttributes 3
53+
Transfer Type Interrupt
54+
Synch Type None
55+
Usage Type Data
56+
wMaxPacketSize 0x0020 1x 32 bytes
57+
bInterval 1
58+
Interface Descriptor:
59+
bLength 9
60+
bDescriptorType 4
61+
bInterfaceNumber 1
62+
bAlternateSetting 0
63+
bNumEndpoints 1
64+
bInterfaceClass 3 Human Interface Device
65+
bInterfaceSubClass 1 Boot Interface Subclass
66+
bInterfaceProtocol 2 Mouse
67+
iInterface 0
68+
HID Device Descriptor:
69+
bLength 9
70+
bDescriptorType 33
71+
bcdHID 1.11
72+
bCountryCode 0 Not supported
73+
bNumDescriptors 1
74+
bDescriptorType 34 Report
75+
wDescriptorLength 64
76+
Report Descriptors:
77+
** UNAVAILABLE **
78+
Endpoint Descriptor:
79+
bLength 7
80+
bDescriptorType 5
81+
bEndpointAddress 0x82 EP 2 IN
82+
bmAttributes 3
83+
Transfer Type Interrupt
84+
Synch Type None
85+
Usage Type Data
86+
wMaxPacketSize 0x0006 1x 6 bytes
87+
bInterval 1
88+
can't get debug descriptor: Resource temporarily unavailable
89+
Device Status: 0x0000
90+
(Bus Powered)

‎debug/devices/steelseries_kana_descriptor.txt

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
0x05, 0x01, // Usage Page (Generic Desktop Ctrls)
2+
0x09, 0x02, // Usage (Mouse)
3+
0xA1, 0x01, // Collection (Application)
4+
0x09, 0x01, // Usage (Pointer)
5+
0xA1, 0x00, // Collection (Physical)
6+
7+
0x05, 0x09, // Usage Page (Button)
8+
0x19, 0x01, // Usage Minimum (0x01)
9+
0x29, 0x05, // Usage Maximum (0x05)
10+
0x15, 0x00, // Logical Minimum (0)
11+
0x25, 0x01, // Logical Maximum (1)
12+
0x95, 0x05, // Report Count (5)
13+
0x75, 0x01, // Report Size (1)
14+
0x81, 0x02, // Input (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position)
15+
16+
0x95, 0x03, // Report Count (3)
17+
0x75, 0x01, // Report Size (1)
18+
0x81, 0x01, // Input (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)
19+
20+
0x05, 0x01, // Usage Page (Generic Desktop Ctrls)
21+
0x09, 0x30, // Usage (X)
22+
0x09, 0x31, // Usage (Y)
23+
0x16, 0x01, 0x80, // Logical Minimum (-32767)
24+
0x26, 0xFF, 0x7F, // Logical Maximum (32767)
25+
0x75, 0x10, // Report Size (16)
26+
0x95, 0x02, // Report Count (2)
27+
0x81, 0x06, // Input (Data,Var,Rel,No Wrap,Linear,Preferred State,No Null Position)
28+
29+
0x09, 0x38, // Usage (Wheel)
30+
0x15, 0x81, // Logical Minimum (-127)
31+
0x25, 0x7F, // Logical Maximum (127)
32+
0x75, 0x08, // Report Size (8)
33+
0x95, 0x01, // Report Count (1)
34+
0x81, 0x06, // Input (Data,Var,Rel,No Wrap,Linear,Preferred State,No Null Position)
35+
t
36+
0xC0, // End Collection
37+
0xC0, // End Collection
38+
39+
// 64 bytes

‎debug/devices/steelseries_kana_descriptor_raw.txt

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
001:011:001:DESCRIPTOR 1618007075.250715
2+
05 01 09 02 A1 01 09 01 A1 00 05 09 19 01 29 05
3+
15 00 25 01 95 05 75 01 81 02 95 03 75 01 81 01
4+
05 01 09 30 09 31 16 01 80 26 FF 7F 75 10 95 02
5+
81 06 09 38 15 81 25 7F 75 08 95 01 81 06 C0 C0
6+
7+
001:011:000:DESCRIPTOR 1618007075.251269
8+
06 C0 FF 09 01 A1 01 06 C1 FF 15 00 26 FF 00 75
9+
08 09 F0 95 20 81 02 09 F1 95 20 91 02 09 F2 96
10+
02 02 B1 02 C0

‎driver/accel.c

+18-21
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,29 @@
1616
#include <asm/fpu/api.h>
1717
#endif
1818

19-
/*
20-
//Converts a preprocessor define's value in "config.h" to a string - Suspect to change in future version without a "config.h"
19+
20+
//Converts a preprocessor define's value in "config.h" to a string - Suspect this to change in future version without a "config.h"
2121
#define _s(x) #x
2222
#define s(x) _s(x)
2323

2424
#define PARAM(param, default, desc) \
25-
float g_#param = default; \
26-
static char* g_param_#param
27-
module_param_named(#param, g_param_#param, charp, 0644); \
25+
float g_##param = default; \
26+
static char* g_param_##param = s(default); \
27+
module_param_named(param, g_param_##param, charp, 0644); \
28+
MODULE_PARM_DESC(param, desc);
2829

2930
// ########## Kernel module parameters
31+
PARAM(no_bind, 0, "This will disable binding to this driver via 'leetmouse_bind' by udev.")
3032

31-
static float g_sensitivity = SENSITIVITY;
32-
static char* g_param_sensitivity = s(SENSITIVITY);
33-
module_param_named(sensitivity, g_param_sensitivity, charp, 0644);
34-
MODULE_PARM_DESC(sensitivity, "Mouse base sensitivity");
33+
PARAM(sensitivity, SENSITIVITY, "Mouse base sensitivity")
3534

36-
PARAM(sensitivity, s(SENSITIVITY), "HEllo")
37-
*/
35+
// Updates the acceleration parameters. This is purposely done with a delay!
36+
// First, to not hammer too much the logic in "accelerate()", which is called VERY OFTEN!
37+
// Second, to fight possible cheating. However, this can be OFC changed, since we are OSS...
38+
static void updata_params(void)
39+
{
40+
return;
41+
}
3842

3943
// ########## Acceleration code
4044

@@ -90,6 +94,9 @@ kernel_fpu_begin();
9094
delta_y += (float) buffer_y; buffer_y = 0;
9195
delta_whl += (float) buffer_whl; buffer_whl = 0;
9296

97+
//Update acceleration parameters periodically
98+
updata_params();
99+
93100
//Prescale
94101
delta_x *= PRE_SCALE_X;
95102
delta_y *= PRE_SCALE_Y;
@@ -154,13 +161,3 @@ kernel_fpu_end();
154161

155162
return status;
156163
}
157-
158-
// Updates the acceleration parameters. This is purposely done with a delay!
159-
// First, to not hammer too much the logic in "accelerate()", which is called VERY OFTEN!
160-
// Second, to fight possible cheating. However, this can be OFC changed, since we are OSS...
161-
/*
162-
static void updata_params()
163-
{
164-
return;
165-
}
166-
*/

‎driver/usbmouse.c

+3-1
Original file line numberDiff line numberDiff line change
@@ -234,8 +234,10 @@ static int usb_mouse_probe(struct usb_interface *intf, const struct usb_device_i
234234
}
235235

236236
rpos = kmalloc(sizeof(struct report_positions), GFP_KERNEL);
237-
if (!rpos)
237+
if (!rpos){
238+
kfree(rdesc);
238239
goto fail1;
240+
}
239241
mouse->data_pos = rpos;
240242

241243
//Parse the descriptor and delete it

‎install_files/dkms/dkms.conf

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PACKAGE_NAME="leetmouse"
22
PACKAGE_VERSION="0.9.0"
33
AUTOINSTALL="yes"
4-
MAKE="KERNELDIR=/lib/modules/${kernelver}/build make driver"
4+
MAKE="KERNELDIR=/lib/modules/${kernelver}/build make driver udev_trigger"
55

66
BUILT_MODULE_NAME="leetmouse"
77

‎install_files/udev/99-leetmouse.rules

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
ACTION!="add", GOTO="leetmouse_end"
1+
ACTION=="remove", GOTO="leetmouse_end"
22
SUBSYSTEMS=="usb|input|hid", ATTRS{bInterfaceClass}=="03", ATTRS{bInterfaceSubClass}=="01", ATTRS{bInterfaceProtocol}=="02", RUN+="leetmouse_bind leetmouse $kernel"
33

44
LABEL="leetmouse_end"

0 commit comments

Comments
 (0)