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