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