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