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