Merge git://git.kernel.org/pub/scm/linux/kernel/git/brodo/cpupowerutils
[pandora-kernel.git] / Documentation / ABI / testing / sysfs-driver-hid-roccat-koneplus
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
11
12 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/firmware_version
13 Date:           October 2010
14 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
15 Description:    When read, this file returns the raw integer version number of the
16                 firmware reported by the mouse. Using the integer value eases
17                 further usage in other programs. To receive the real version
18                 number the decimal point has to be shifted 2 positions to the
19                 left. E.g. a returned value of 121 means 1.21
20                 This file is readonly.
21 Users:          http://roccat.sourceforge.net
22
23 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/macro
24 Date:           October 2010
25 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
26 Description:    The mouse can store a macro with max 500 key/button strokes
27                 internally.
28                 When written, this file lets one set the sequence for a specific
29                 button for a specific profile. Button and profile numbers are
30                 included in written data. The data has to be 2082 bytes long.
31                 This file is writeonly.
32 Users:          http://roccat.sourceforge.net
33
34 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile_buttons
35 Date:           August 2010
36 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
37 Description:    The mouse can store 5 profiles which can be switched by the
38                 press of a button. A profile is split in settings and buttons.
39                 profile_buttons holds information about button layout.
40                 When written, this file lets one write the respective profile
41                 buttons back to the mouse. The data has to be 77 bytes long.
42                 The mouse will reject invalid data.
43                 Which profile to write is determined by the profile number
44                 contained in the data.
45                 This file is writeonly.
46 Users:          http://roccat.sourceforge.net
47
48 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
49 Date:           August 2010
50 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
51 Description:    The mouse can store 5 profiles which can be switched by the
52                 press of a button. A profile is split in settings and buttons.
53                 profile_buttons holds information about button layout.
54                 When read, these files return the respective profile buttons.
55                 The returned data is 77 bytes in size.
56                 This file is readonly.
57 Users:          http://roccat.sourceforge.net
58
59 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile_settings
60 Date:           October 2010
61 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
62 Description:    The mouse can store 5 profiles which can be switched by the
63                 press of a button. A profile is split in settings and buttons.
64                 profile_settings holds information like resolution, sensitivity
65                 and light effects.
66                 When written, this file lets one write the respective profile
67                 settings back to the mouse. The data has to be 43 bytes long.
68                 The mouse will reject invalid data.
69                 Which profile to write is determined by the profile number
70                 contained in the data.
71                 This file is writeonly.
72 Users:          http://roccat.sourceforge.net
73
74 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
75 Date:           August 2010
76 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
77 Description:    The mouse can store 5 profiles which can be switched by the
78                 press of a button. A profile is split in settings and buttons.
79                 profile_settings holds information like resolution, sensitivity
80                 and light effects.
81                 When read, these files return the respective profile settings.
82                 The returned data is 43 bytes in size.
83                 This file is readonly.
84 Users:          http://roccat.sourceforge.net
85
86 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/sensor
87 Date:           October 2010
88 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
89 Description:    The mouse has a tracking- and a distance-control-unit. These
90                 can be activated/deactivated and the lift-off distance can be
91                 set. The data has to be 6 bytes long.
92                 This file is writeonly.
93 Users:          http://roccat.sourceforge.net
94
95 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/talk
96 Date:           May 2011
97 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
98 Description:    Used to active some easy* functions of the mouse from outside.
99                 The data has to be 16 bytes long.
100                 This file is writeonly.
101 Users:          http://roccat.sourceforge.net
102
103 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/tcu
104 Date:           October 2010
105 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
106 Description:    When written a calibration process for the tracking control unit
107                 can be initiated/cancelled.
108                 The data has to be 3 bytes long.
109                 This file is writeonly.
110 Users:          http://roccat.sourceforge.net
111
112 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/tcu_image
113 Date:           October 2010
114 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
115 Description:    When read the mouse returns a 30x30 pixel image of the
116                 sampled underground. This works only in the course of a
117                 calibration process initiated with tcu.
118                 The returned data is 1028 bytes in size.
119                 This file is readonly.
120 Users:          http://roccat.sourceforge.net