HID: roccat: Add support for Kova[+] mouse
[linux-2.6.git] / Documentation / ABI / testing / sysfs-driver-hid-roccat-kovaplus
1 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/actual_cpi
2 Date:           January 2011
3 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
4 Description:    The integer value of this attribute ranges from 1-4.
5                 When read, this attribute returns the number of the active
6                 cpi level.
7                 This file is readonly.
8
9 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/actual_profile
10 Date:           January 2011
11 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
12 Description:    The integer value of this attribute ranges from 0-4.
13                 When read, this attribute returns the number of the active
14                 profile.
15                 When written, the mouse activates this profile immediately.
16                 The profile that's active when powered down is the same that's
17                 active when the mouse is powered on.
18
19 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/actual_sensitivity_x
20 Date:           January 2011
21 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
22 Description:    The integer value of this attribute ranges from 1-10.
23                 When read, this attribute returns the number of the actual
24                 sensitivity in x direction.
25                 This file is readonly.
26
27 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/actual_sensitivity_y
28 Date:           January 2011
29 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
30 Description:    The integer value of this attribute ranges from 1-10.
31                 When read, this attribute returns the number of the actual
32                 sensitivity in y direction.
33                 This file is readonly.
34
35 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/firmware_version
36 Date:           January 2011
37 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
38 Description:    When read, this file returns the raw integer version number of the
39                 firmware reported by the mouse. Using the integer value eases
40                 further usage in other programs. To receive the real version
41                 number the decimal point has to be shifted 2 positions to the
42                 left. E.g. a returned value of 121 means 1.21
43                 This file is readonly.
44
45 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/profile_buttons
46 Date:           January 2011
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 written, this file lets one write the respective profile
52                 buttons back to the mouse. The data has to be 23 bytes long.
53                 The mouse will reject invalid data.
54                 Which profile to write is determined by the profile number
55                 contained in the data.
56                 This file is writeonly.
57
58 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/profile[1-5]_buttons
59 Date:           January 2011
60 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
61 Description:    The mouse can store 5 profiles which can be switched by the
62                 press of a button. A profile is split in settings and buttons.
63                 profile_buttons holds informations about button layout.
64                 When read, these files return the respective profile buttons.
65                 The returned data is 23 bytes in size.
66                 This file is readonly.
67
68 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/profile_settings
69 Date:           January 2011
70 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
71 Description:    The mouse can store 5 profiles which can be switched by the
72                 press of a button. A profile is split in settings and buttons.
73                 profile_settings holds informations like resolution, sensitivity
74                 and light effects.
75                 When written, this file lets one write the respective profile
76                 settings back to the mouse. The data has to be 16 bytes long.
77                 The mouse will reject invalid data.
78                 Which profile to write is determined by the profile number
79                 contained in the data.
80                 This file is writeonly.
81
82 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/profile[1-5]_settings
83 Date:           January 2011
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 informations like resolution, sensitivity
88                 and light effects.
89                 When read, these files return the respective profile settings.
90                 The returned data is 16 bytes in size.
91                 This file is readonly.