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