xref: /OK3568_Linux_fs/kernel/Documentation/ABI/obsolete/sysfs-driver-hid-roccat-koneplus (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/actual_profile
2*4882a593SmuzhiyunDate:		October 2010
3*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
4*4882a593SmuzhiyunDescription:	The integer value of this attribute ranges from 0-4.
5*4882a593Smuzhiyun                When read, this attribute returns the number of the actual
6*4882a593Smuzhiyun                profile. This value is persistent, so its equivalent to the
7*4882a593Smuzhiyun                profile that's active when the mouse is powered on next time.
8*4882a593Smuzhiyun		When written, this file sets the number of the startup profile
9*4882a593Smuzhiyun		and the mouse activates this profile immediately.
10*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/startup_profile
13*4882a593SmuzhiyunDate:		October 2010
14*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
15*4882a593SmuzhiyunDescription:	The integer value of this attribute ranges from 0-4.
16*4882a593Smuzhiyun                When read, this attribute returns the number of the actual
17*4882a593Smuzhiyun                profile. This value is persistent, so its equivalent to the
18*4882a593Smuzhiyun                profile that's active when the mouse is powered on next time.
19*4882a593Smuzhiyun		When written, this file sets the number of the startup profile
20*4882a593Smuzhiyun		and the mouse activates this profile immediately.
21*4882a593Smuzhiyun		Please use actual_profile, it does the same thing.
22*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
23*4882a593Smuzhiyun
24*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/firmware_version
25*4882a593SmuzhiyunDate:		October 2010
26*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
27*4882a593SmuzhiyunDescription:	When read, this file returns the raw integer version number of the
28*4882a593Smuzhiyun		firmware reported by the mouse. Using the integer value eases
29*4882a593Smuzhiyun		further usage in other programs. To receive the real version
30*4882a593Smuzhiyun		number the decimal point has to be shifted 2 positions to the
31*4882a593Smuzhiyun		left. E.g. a returned value of 121 means 1.21
32*4882a593Smuzhiyun		This file is readonly.
33*4882a593Smuzhiyun		Please read binary attribute info which contains firmware version.
34*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
35*4882a593Smuzhiyun
36*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/info
37*4882a593SmuzhiyunDate:		November 2012
38*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
39*4882a593SmuzhiyunDescription:	When read, this file returns general data like firmware version.
40*4882a593Smuzhiyun		When written, the device can be reset.
41*4882a593Smuzhiyun		The data is 8 bytes long.
42*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
43*4882a593Smuzhiyun
44*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/macro
45*4882a593SmuzhiyunDate:		October 2010
46*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
47*4882a593SmuzhiyunDescription:	The mouse can store a macro with max 500 key/button strokes
48*4882a593Smuzhiyun		internally.
49*4882a593Smuzhiyun		When written, this file lets one set the sequence for a specific
50*4882a593Smuzhiyun		button for a specific profile. Button and profile numbers are
51*4882a593Smuzhiyun		included in written data. The data has to be 2082 bytes long.
52*4882a593Smuzhiyun		This file is writeonly.
53*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
54*4882a593Smuzhiyun
55*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile_buttons
56*4882a593SmuzhiyunDate:		August 2010
57*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
58*4882a593SmuzhiyunDescription:	The mouse can store 5 profiles which can be switched by the
59*4882a593Smuzhiyun		press of a button. A profile is split in settings and buttons.
60*4882a593Smuzhiyun		profile_buttons holds information about button layout.
61*4882a593Smuzhiyun		When written, this file lets one write the respective profile
62*4882a593Smuzhiyun		buttons back to the mouse. The data has to be 77 bytes long.
63*4882a593Smuzhiyun		The mouse will reject invalid data.
64*4882a593Smuzhiyun		Which profile to write is determined by the profile number
65*4882a593Smuzhiyun		contained in the data.
66*4882a593Smuzhiyun		Before reading this file, control has to be written to select
67*4882a593Smuzhiyun		which profile to read.
68*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
69*4882a593Smuzhiyun
70*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile[1-5]_buttons
71*4882a593SmuzhiyunDate:		August 2010
72*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
73*4882a593SmuzhiyunDescription:	The mouse can store 5 profiles which can be switched by the
74*4882a593Smuzhiyun		press of a button. A profile is split in settings and buttons.
75*4882a593Smuzhiyun		profile_buttons holds information about button layout.
76*4882a593Smuzhiyun		When read, these files return the respective profile buttons.
77*4882a593Smuzhiyun		The returned data is 77 bytes in size.
78*4882a593Smuzhiyun		This file is readonly.
79*4882a593Smuzhiyun		Write control to select profile and read profile_buttons instead.
80*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
81*4882a593Smuzhiyun
82*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile_settings
83*4882a593SmuzhiyunDate:		October 2010
84*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
85*4882a593SmuzhiyunDescription:	The mouse can store 5 profiles which can be switched by the
86*4882a593Smuzhiyun		press of a button. A profile is split in settings and buttons.
87*4882a593Smuzhiyun		profile_settings holds information like resolution, sensitivity
88*4882a593Smuzhiyun		and light effects.
89*4882a593Smuzhiyun		When written, this file lets one write the respective profile
90*4882a593Smuzhiyun		settings back to the mouse. The data has to be 43 bytes long.
91*4882a593Smuzhiyun		The mouse will reject invalid data.
92*4882a593Smuzhiyun		Which profile to write is determined by the profile number
93*4882a593Smuzhiyun		contained in the data.
94*4882a593Smuzhiyun		Before reading this file, control has to be written to select
95*4882a593Smuzhiyun		which profile to read.
96*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
97*4882a593Smuzhiyun
98*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile[1-5]_settings
99*4882a593SmuzhiyunDate:		August 2010
100*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
101*4882a593SmuzhiyunDescription:	The mouse can store 5 profiles which can be switched by the
102*4882a593Smuzhiyun		press of a button. A profile is split in settings and buttons.
103*4882a593Smuzhiyun		profile_settings holds information like resolution, sensitivity
104*4882a593Smuzhiyun		and light effects.
105*4882a593Smuzhiyun		When read, these files return the respective profile settings.
106*4882a593Smuzhiyun		The returned data is 43 bytes in size.
107*4882a593Smuzhiyun		This file is readonly.
108*4882a593Smuzhiyun		Write control to select profile and read profile_settings instead.
109*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
110*4882a593Smuzhiyun
111*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/sensor
112*4882a593SmuzhiyunDate:		October 2010
113*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
114*4882a593SmuzhiyunDescription:	The mouse has a tracking- and a distance-control-unit. These
115*4882a593Smuzhiyun		can be activated/deactivated and the lift-off distance can be
116*4882a593Smuzhiyun		set. The data has to be 6 bytes long.
117*4882a593Smuzhiyun		This file is writeonly.
118*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
119*4882a593Smuzhiyun
120*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/talk
121*4882a593SmuzhiyunDate:		May 2011
122*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
123*4882a593SmuzhiyunDescription:	Used to active some easy* functions of the mouse from outside.
124*4882a593Smuzhiyun		The data has to be 16 bytes long.
125*4882a593Smuzhiyun		This file is writeonly.
126*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
127*4882a593Smuzhiyun
128*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/tcu
129*4882a593SmuzhiyunDate:		October 2010
130*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
131*4882a593SmuzhiyunDescription:	When written a calibration process for the tracking control unit
132*4882a593Smuzhiyun		can be initiated/cancelled. Also lets one read/write sensor
133*4882a593Smuzhiyun		registers.
134*4882a593Smuzhiyun		The data has to be 4 bytes long.
135*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
136*4882a593Smuzhiyun
137*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/tcu_image
138*4882a593SmuzhiyunDate:		October 2010
139*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
140*4882a593SmuzhiyunDescription:	When read the mouse returns a 30x30 pixel image of the
141*4882a593Smuzhiyun		sampled underground. This works only in the course of a
142*4882a593Smuzhiyun		calibration process initiated with tcu.
143*4882a593Smuzhiyun		The returned data is 1028 bytes in size.
144*4882a593Smuzhiyun		This file is readonly.
145*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
146