Skip to content

Commit 8d2f847

Browse files
Stefan AchatzJiri Kosina
authored andcommitted
HID: roccat: Fixed resubmit: Deprecating most Roccat sysfs attributes
Deprecates all Roccat sysfs attributes except the ones for the old Kone by moving abi descriptions from testing to obsolete. For most devices everything can be done using the hidraw ioctls HIDIOCGFEATURE and HIDIOCSFEATURE, so I would suggest future removal of device specific drivers. The userspace tools don't use these attributes for a year now. The first Kone is not fully HID-compliant and will still need a module. Signed-off-by: Stefan Achatz <[email protected]> Signed-off-by: Jiri Kosina <[email protected]>
1 parent 851328f commit 8d2f847

12 files changed

+198
-195
lines changed

Documentation/ABI/obsolete/sysfs-driver-hid-roccat-koneplus

Lines changed: 98 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/actual_profile
2+
Date: October 2010
3+
Contact: Stefan Achatz <[email protected]>
4+
Description: The integer value of this attribute ranges from 0-4.
5+
When read, this attribute returns the number of the actual
6+
profile. This value is persistent, so its equivalent to the
7+
profile that's active when the mouse is powered on next time.
8+
When written, this file sets the number of the startup profile
9+
and the mouse activates this profile immediately.
10+
Users: http://roccat.sourceforge.net
11+
112
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/startup_profile
213
Date: October 2010
314
Contact: Stefan Achatz <[email protected]>
@@ -22,6 +33,40 @@ Description: When read, this file returns the raw integer version number of the
2233
Please read binary attribute info which contains firmware version.
2334
Users: http://roccat.sourceforge.net
2435

36+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/info
37+
Date: November 2012
38+
Contact: Stefan Achatz <[email protected]>
39+
Description: When read, this file returns general data like firmware version.
40+
When written, the device can be reset.
41+
The data is 8 bytes long.
42+
Users: http://roccat.sourceforge.net
43+
44+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/macro
45+
Date: October 2010
46+
Contact: Stefan Achatz <[email protected]>
47+
Description: The mouse can store a macro with max 500 key/button strokes
48+
internally.
49+
When written, this file lets one set the sequence for a specific
50+
button for a specific profile. Button and profile numbers are
51+
included in written data. The data has to be 2082 bytes long.
52+
This file is writeonly.
53+
Users: http://roccat.sourceforge.net
54+
55+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile_buttons
56+
Date: August 2010
57+
Contact: Stefan Achatz <[email protected]>
58+
Description: The mouse can store 5 profiles which can be switched by the
59+
press of a button. A profile is split in settings and buttons.
60+
profile_buttons holds information about button layout.
61+
When written, this file lets one write the respective profile
62+
buttons back to the mouse. The data has to be 77 bytes long.
63+
The mouse will reject invalid data.
64+
Which profile to write is determined by the profile number
65+
contained in the data.
66+
Before reading this file, control has to be written to select
67+
which profile to read.
68+
Users: http://roccat.sourceforge.net
69+
2570
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile[1-5]_buttons
2671
Date: August 2010
2772
Contact: Stefan Achatz <[email protected]>
@@ -34,6 +79,22 @@ Description: The mouse can store 5 profiles which can be switched by the
3479
Write control to select profile and read profile_buttons instead.
3580
Users: http://roccat.sourceforge.net
3681

82+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile_settings
83+
Date: October 2010
84+
Contact: Stefan Achatz <[email protected]>
85+
Description: The mouse can store 5 profiles which can be switched by the
86+
press of a button. A profile is split in settings and buttons.
87+
profile_settings holds information like resolution, sensitivity
88+
and light effects.
89+
When written, this file lets one write the respective profile
90+
settings back to the mouse. The data has to be 43 bytes long.
91+
The mouse will reject invalid data.
92+
Which profile to write is determined by the profile number
93+
contained in the data.
94+
Before reading this file, control has to be written to select
95+
which profile to read.
96+
Users: http://roccat.sourceforge.net
97+
3798
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile[1-5]_settings
3899
Date: August 2010
39100
Contact: Stefan Achatz <[email protected]>
@@ -45,4 +106,40 @@ Description: The mouse can store 5 profiles which can be switched by the
45106
The returned data is 43 bytes in size.
46107
This file is readonly.
47108
Write control to select profile and read profile_settings instead.
48-
Users: http://roccat.sourceforge.net
109+
Users: http://roccat.sourceforge.net
110+
111+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/sensor
112+
Date: October 2010
113+
Contact: Stefan Achatz <[email protected]>
114+
Description: The mouse has a tracking- and a distance-control-unit. These
115+
can be activated/deactivated and the lift-off distance can be
116+
set. The data has to be 6 bytes long.
117+
This file is writeonly.
118+
Users: http://roccat.sourceforge.net
119+
120+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/talk
121+
Date: May 2011
122+
Contact: Stefan Achatz <[email protected]>
123+
Description: Used to active some easy* functions of the mouse from outside.
124+
The data has to be 16 bytes long.
125+
This file is writeonly.
126+
Users: http://roccat.sourceforge.net
127+
128+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/tcu
129+
Date: October 2010
130+
Contact: Stefan Achatz <[email protected]>
131+
Description: When written a calibration process for the tracking control unit
132+
can be initiated/cancelled. Also lets one read/write sensor
133+
registers.
134+
The data has to be 4 bytes long.
135+
Users: http://roccat.sourceforge.net
136+
137+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/tcu_image
138+
Date: October 2010
139+
Contact: Stefan Achatz <[email protected]>
140+
Description: When read the mouse returns a 30x30 pixel image of the
141+
sampled underground. This works only in the course of a
142+
calibration process initiated with tcu.
143+
The returned data is 1028 bytes in size.
144+
This file is readonly.
145+
Users: http://roccat.sourceforge.net

Documentation/ABI/obsolete/sysfs-driver-hid-roccat-kovaplus

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ Description: The integer value of this attribute ranges from 1-4.
88
Has never been used. If bookkeeping is done, it's done in userland tools.
99
Users: http://roccat.sourceforge.net
1010

11+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/actual_profile
12+
Date: January 2011
13+
Contact: Stefan Achatz <[email protected]>
14+
Description: The integer value of this attribute ranges from 0-4.
15+
When read, this attribute returns the number of the active
16+
profile.
17+
When written, the mouse activates this profile immediately.
18+
The profile that's active when powered down is the same that's
19+
active when the mouse is powered on.
20+
Users: http://roccat.sourceforge.net
21+
1122
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/actual_sensitivity_x
1223
Date: January 2011
1324
Contact: Stefan Achatz <[email protected]>
@@ -40,6 +51,29 @@ Description: When read, this file returns the raw integer version number of the
4051
Obsoleted by binary sysfs attribute "info".
4152
Users: http://roccat.sourceforge.net
4253

54+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/info
55+
Date: November 2012
56+
Contact: Stefan Achatz <[email protected]>
57+
Description: When read, this file returns general data like firmware version.
58+
When written, the device can be reset.
59+
The data is 6 bytes long.
60+
Users: http://roccat.sourceforge.net
61+
62+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/profile_buttons
63+
Date: January 2011
64+
Contact: Stefan Achatz <[email protected]>
65+
Description: The mouse can store 5 profiles which can be switched by the
66+
press of a button. A profile is split in settings and buttons.
67+
profile_buttons holds information about button layout.
68+
When written, this file lets one write the respective profile
69+
buttons back to the mouse. The data has to be 23 bytes long.
70+
The mouse will reject invalid data.
71+
Which profile to write is determined by the profile number
72+
contained in the data.
73+
Before reading this file, control has to be written to select
74+
which profile to read.
75+
Users: http://roccat.sourceforge.net
76+
4377
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/profile[1-5]_buttons
4478
Date: January 2011
4579
Contact: Stefan Achatz <[email protected]>
@@ -52,6 +86,22 @@ Description: The mouse can store 5 profiles which can be switched by the
5286
Write control to select profile and read profile_buttons instead.
5387
Users: http://roccat.sourceforge.net
5488

89+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/profile_settings
90+
Date: January 2011
91+
Contact: Stefan Achatz <[email protected]>
92+
Description: The mouse can store 5 profiles which can be switched by the
93+
press of a button. A profile is split in settings and buttons.
94+
profile_settings holds information like resolution, sensitivity
95+
and light effects.
96+
When written, this file lets one write the respective profile
97+
settings back to the mouse. The data has to be 16 bytes long.
98+
The mouse will reject invalid data.
99+
Which profile to write is determined by the profile number
100+
contained in the data.
101+
Before reading this file, control has to be written to select
102+
which profile to read.
103+
Users: http://roccat.sourceforge.net
104+
55105
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/profile[1-5]_settings
56106
Date: January 2011
57107
Contact: Stefan Achatz <[email protected]>

Documentation/ABI/obsolete/sysfs-driver-hid-roccat-pyra

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,29 @@ Description: When read, this file returns the raw integer version number of the
3737
Please use binary attribute "info" which provides this information.
3838
Users: http://roccat.sourceforge.net
3939

40+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/info
41+
Date: November 2012
42+
Contact: Stefan Achatz <[email protected]>
43+
Description: When read, this file returns general data like firmware version.
44+
When written, the device can be reset.
45+
The data is 6 bytes long.
46+
Users: http://roccat.sourceforge.net
47+
48+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_buttons
49+
Date: August 2010
50+
Contact: Stefan Achatz <[email protected]>
51+
Description: The mouse can store 5 profiles which can be switched by the
52+
press of a button. A profile is split in settings and buttons.
53+
profile_buttons holds information about button layout.
54+
When written, this file lets one write the respective profile
55+
buttons back to the mouse. The data has to be 19 bytes long.
56+
The mouse will reject invalid data.
57+
Which profile to write is determined by the profile number
58+
contained in the data.
59+
Before reading this file, control has to be written to select
60+
which profile to read.
61+
Users: http://roccat.sourceforge.net
62+
4063
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile[1-5]_buttons
4164
Date: August 2010
4265
Contact: Stefan Achatz <[email protected]>
@@ -49,6 +72,22 @@ Description: The mouse can store 5 profiles which can be switched by the
4972
Write control to select profile and read profile_buttons instead.
5073
Users: http://roccat.sourceforge.net
5174

75+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_settings
76+
Date: August 2010
77+
Contact: Stefan Achatz <[email protected]>
78+
Description: The mouse can store 5 profiles which can be switched by the
79+
press of a button. A profile is split in settings and buttons.
80+
profile_settings holds information like resolution, sensitivity
81+
and light effects.
82+
When written, this file lets one write the respective profile
83+
settings back to the mouse. The data has to be 13 bytes long.
84+
The mouse will reject invalid data.
85+
Which profile to write is determined by the profile number
86+
contained in the data.
87+
Before reading this file, control has to be written to select
88+
which profile to read.
89+
Users: http://roccat.sourceforge.net
90+
5291
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile[1-5]_settings
5392
Date: August 2010
5493
Contact: Stefan Achatz <[email protected]>
@@ -62,6 +101,17 @@ Description: The mouse can store 5 profiles which can be switched by the
62101
Write control to select profile and read profile_settings instead.
63102
Users: http://roccat.sourceforge.net
64103

104+
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/settings
105+
Date: August 2010
106+
Contact: Stefan Achatz <[email protected]>
107+
Description: When read, this file returns the settings stored in the mouse.
108+
The size of the data is 3 bytes and holds information on the
109+
startup_profile.
110+
When written, this file lets write settings back to the mouse.
111+
The data has to be 3 bytes long. The mouse will reject invalid
112+
data.
113+
Users: http://roccat.sourceforge.net
114+
65115
What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/startup_profile
66116
Date: August 2010
67117
Contact: Stefan Achatz <[email protected]>

Documentation/ABI/testing/sysfs-driver-hid-roccat-koneplus

Lines changed: 0 additions & 96 deletions
This file was deleted.

0 commit comments

Comments
 (0)