Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs
[linux/fpc-iii.git] / Documentation / ABI / testing / sysfs-driver-hid-roccat-koneplus
blob7bd776f9c3c70cc2f92290cbae254a9858c41daf
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>/info
13 Date:           November 2012
14 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
15 Description:    When read, this file returns general data like firmware version.
16                 When written, the device can be reset.
17                 The data is 8 bytes long.
18 Users:          http://roccat.sourceforge.net
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
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 information 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                 Before reading this file, control has to be written to select
43                 which profile to read.
44 Users:          http://roccat.sourceforge.net
46 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile_settings
47 Date:           October 2010
48 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
49 Description:    The mouse can store 5 profiles which can be switched by the
50                 press of a button. A profile is split in settings and buttons.
51                 profile_settings holds information like resolution, sensitivity
52                 and light effects.
53                 When written, this file lets one write the respective profile
54                 settings back to the mouse. The data has to be 43 bytes long.
55                 The mouse will reject invalid data.
56                 Which profile to write is determined by the profile number
57                 contained in the data.
58                 Before reading this file, control has to be written to select
59                 which profile to read.
60 Users:          http://roccat.sourceforge.net
62 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/sensor
63 Date:           October 2010
64 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
65 Description:    The mouse has a tracking- and a distance-control-unit. These
66                 can be activated/deactivated and the lift-off distance can be
67                 set. The data has to be 6 bytes long.
68                 This file is writeonly.
69 Users:          http://roccat.sourceforge.net
71 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/talk
72 Date:           May 2011
73 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
74 Description:    Used to active some easy* functions of the mouse from outside.
75                 The data has to be 16 bytes long.
76                 This file is writeonly.
77 Users:          http://roccat.sourceforge.net
79 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/tcu
80 Date:           October 2010
81 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
82 Description:    When written a calibration process for the tracking control unit
83                 can be initiated/cancelled. Also lets one read/write sensor
84                 registers.
85                 The data has to be 4 bytes long.
86 Users:          http://roccat.sourceforge.net
88 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/tcu_image
89 Date:           October 2010
90 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
91 Description:    When read the mouse returns a 30x30 pixel image of the
92                 sampled underground. This works only in the course of a
93                 calibration process initiated with tcu.
94                 The returned data is 1028 bytes in size.
95                 This file is readonly.
96 Users:          http://roccat.sourceforge.net