xref: /linux/Documentation/ABI/obsolete/sysfs-driver-hid-roccat-konepure (revision 71e2f4dd5a65bd8dbca0b77661e75eea471168f8)
1What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/konepure/roccatkonepure<minor>/actual_profile
2Date:		December 2012
3Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
4Description:	The mouse can store 5 profiles which can be switched by the
5		press of a button. actual_profile holds number of actual profile.
6		This value is persistent, so its value determines the profile
7		that's active when the mouse is powered on next time.
8		When written, the mouse activates the set profile immediately.
9		The data has to be 3 bytes long.
10		The mouse will reject invalid data.
11Users:		http://roccat.sourceforge.net
12
13What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/konepure/roccatkonepure<minor>/control
14Date:		December 2012
15Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
16Description:	When written, this file lets one select which data from which
17		profile will be	read next. The data has to be 3 bytes long.
18		This file is writeonly.
19Users:		http://roccat.sourceforge.net
20
21What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/konepure/roccatkonepure<minor>/info
22Date:		December 2012
23Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
24Description:	When read, this file returns general data like firmware version.
25		When written, the device can be reset.
26		The data is 6 bytes long.
27Users:		http://roccat.sourceforge.net
28
29What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/konepure/roccatkonepure<minor>/macro
30Date:		December 2012
31Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
32Description:	The mouse can store a macro with max 500 key/button strokes
33		internally.
34		When written, this file lets one set the sequence for a specific
35		button for a specific profile. Button and profile numbers are
36		included in written data. The data has to be 2082 bytes long.
37		This file is writeonly.
38Users:		http://roccat.sourceforge.net
39
40What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/konepure/roccatkonepure<minor>/profile_buttons
41Date:		December 2012
42Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
43Description:	The mouse can store 5 profiles which can be switched by the
44		press of a button. A profile is split in settings and buttons.
45		profile_buttons holds information about button layout.
46		When written, this file lets one write the respective profile
47		buttons back to the mouse. The data has to be 59 bytes long.
48		The mouse will reject invalid data.
49		Which profile to write is determined by the profile number
50		contained in the data.
51		Before reading this file, control has to be written to select
52		which profile to read.
53Users:		http://roccat.sourceforge.net
54
55What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/konepure/roccatkonepure<minor>/profile_settings
56Date:		December 2012
57Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
58Description:	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_settings holds information like resolution, sensitivity
61		and light effects.
62		When written, this file lets one write the respective profile
63		settings back to the mouse. The data has to be 31 bytes long.
64		The mouse will reject invalid data.
65		Which profile to write is determined by the profile number
66		contained in the data.
67		Before reading this file, control has to be written to select
68		which profile to read.
69Users:		http://roccat.sourceforge.net
70
71What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/konepure/roccatkonepure<minor>/sensor
72Date:		December 2012
73Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
74Description:	The mouse has a tracking- and a distance-control-unit. These
75		can be activated/deactivated and the lift-off distance can be
76		set. The data has to be 6 bytes long.
77		This file is writeonly.
78Users:		http://roccat.sourceforge.net
79
80What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/konepure/roccatkonepure<minor>/talk
81Date:		December 2012
82Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
83Description:	Used to active some easy* functions of the mouse from outside.
84		The data has to be 16 bytes long.
85		This file is writeonly.
86Users:		http://roccat.sourceforge.net
87
88What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/konepure/roccatkonepure<minor>/tcu
89Date:		December 2012
90Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
91Description:	When written a calibration process for the tracking control unit
92		can be initiated/cancelled. Also lets one read/write sensor
93		registers.
94		The data has to be 4 bytes long.
95Users:		http://roccat.sourceforge.net
96
97What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/konepure/roccatkonepure<minor>/tcu_image
98Date:		December 2012
99Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
100Description:	When read the mouse returns a 30x30 pixel image of the
101		sampled underground. This works only in the course of a
102		calibration process initiated with tcu.
103		The returned data is 1028 bytes in size.
104		This file is readonly.
105Users:		http://roccat.sourceforge.net
106