xref: /linux/Documentation/ABI/testing/sysfs-driver-hid-roccat-kone (revision daa2be74b1b2302004945b2a5e32424e177cc7da)
1What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/actual_dpi
2Date:		March 2010
3Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
4Description:	It is possible to switch the dpi setting of the mouse with the
5		press of a button.
6
7		When read, this file returns the raw number of the actual dpi
8		setting reported by the mouse. This number has to be further
9		processed to receive the real dpi value:
10
11		===== =====
12		VALUE DPI
13		===== =====
14		1     800
15		2     1200
16		3     1600
17		4     2000
18		5     2400
19		6     3200
20		===== =====
21
22		This file is readonly.
23Users:		http://roccat.sourceforge.net
24
25What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/actual_profile
26Date:		March 2010
27Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
28Description:	When read, this file returns the number of the actual profile.
29
30		This file is readonly.
31Users:		http://roccat.sourceforge.net
32
33What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/firmware_version
34Date:		March 2010
35Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
36Description:	When read, this file returns the raw integer version number of the
37		firmware reported by the mouse. Using the integer value eases
38		further usage in other programs. To receive the real version
39		number the decimal point has to be shifted 2 positions to the
40		left. E.g. a returned value of 138 means 1.38
41
42		This file is readonly.
43Users:		http://roccat.sourceforge.net
44
45What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/profile[1-5]
46Date:		March 2010
47Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
48Description:	The mouse can store 5 profiles which can be switched by the
49                press of a button. A profile holds information like button
50                mappings, sensitivity, the colors of the 5 leds and light
51                effects.
52
53                When read, these files return the respective profile. The
54                returned data is 975 bytes in size.
55
56		When written, this file lets one write the respective profile
57		data back to the mouse. The data has to be 975 bytes long.
58
59		The mouse will reject invalid data, whereas the profile number
60		stored in the profile doesn't need to fit the number of the
61		store.
62Users:		http://roccat.sourceforge.net
63
64What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/settings
65Date:		March 2010
66Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
67Description:	When read, this file returns the settings stored in the mouse.
68		The size of the data is 36 bytes and holds information like the
69		startup_profile, tcu state and calibration_data.
70
71		When written, this file lets write settings back to the mouse.
72		The data has to be 36 bytes long. The mouse will reject invalid
73		data.
74Users:		http://roccat.sourceforge.net
75
76What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/startup_profile
77Date:		March 2010
78Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
79Description:	The integer value of this attribute ranges from 1 to 5.
80
81                When read, this attribute returns the number of the profile
82                that's active when the mouse is powered on.
83
84		When written, this file sets the number of the startup profile
85		and the mouse activates this profile immediately.
86Users:		http://roccat.sourceforge.net
87
88What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/tcu
89Date:		March 2010
90Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
91Description:	The mouse has a "Tracking Control Unit" which lets the user
92		calibrate the laser power to fit the mousepad surface.
93		When read, this file returns the current state of the TCU,
94		where 0 means off and 1 means on.
95
96		Writing 0 in this file will switch the TCU off.
97
98		Writing 1 in this file will start the calibration which takes
99		around 6 seconds to complete and activates the TCU.
100
101Users:		http://roccat.sourceforge.net
102
103What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/weight
104Date:		March 2010
105Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>
106Description:	The mouse can be equipped with one of four supplied weights
107		ranging from 5 to 20 grams which are recognized by the mouse
108		and its value can be read out. When read, this file returns the
109		raw value returned by the mouse which eases further processing
110		in other software.
111
112		The values map to the weights as follows:
113
114		===== ======
115		VALUE WEIGHT
116		===== ======
117		0     none
118		1     5g
119		2     10g
120		3     15g
121		4     20g
122		===== ======
123
124		This file is readonly.
125Users:		http://roccat.sourceforge.net
126