Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/penberg...
[pandora-kernel.git] / Documentation / ABI / testing / sysfs-driver-hid-roccat-pyra
1 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/actual_cpi
2 Date:           August 2010
3 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
4 Description:    It is possible to switch the cpi setting of the mouse with the
5                 press of a button.
6                 When read, this file returns the raw number of the actual cpi
7                 setting reported by the mouse. This number has to be further
8                 processed to receive the real dpi value.
9
10                 VALUE DPI
11                 1     400
12                 2     800
13                 4     1600
14
15                 This file is readonly.
16
17 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/actual_profile
18 Date:           August 2010
19 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
20 Description:    When read, this file returns the number of the actual profile in
21                 range 0-4.
22                 This file is readonly.
23
24 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/firmware_version
25 Date:           August 2010
26 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
27 Description:    When read, this file returns the raw integer version number of the
28                 firmware reported by the mouse. Using the integer value eases
29                 further usage in other programs. To receive the real version
30                 number the decimal point has to be shifted 2 positions to the
31                 left. E.g. a returned value of 138 means 1.38
32                 This file is readonly.
33
34 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_settings
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_settings holds informations like resolution, sensitivity
40                 and light effects.
41                 When written, this file lets one write the respective profile
42                 settings back to the mouse. The data has to be 13 bytes long.
43                 The mouse will reject invalid data.
44                 Which profile to write is determined by the profile number
45                 contained in the data.
46                 This file is writeonly.
47
48 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile[1-5]_settings
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_settings holds informations like resolution, sensitivity
54                 and light effects.
55                 When read, these files return the respective profile settings.
56                 The returned data is 13 bytes in size.
57                 This file is readonly.
58
59 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_buttons
60 Date:           August 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_buttons holds informations about button layout.
65                 When written, this file lets one write the respective profile
66                 buttons back to the mouse. The data has to be 19 bytes long.
67                 The mouse will reject invalid data.
68                 Which profile to write is determined by the profile number
69                 contained in the data.
70                 This file is writeonly.
71
72 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile[1-5]_buttons
73 Date:           August 2010
74 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
75 Description:    The mouse can store 5 profiles which can be switched by the
76                 press of a button. A profile is split in settings and buttons.
77                 profile_buttons holds informations about button layout.
78                 When read, these files return the respective profile buttons.
79                 The returned data is 19 bytes in size.
80                 This file is readonly.
81
82 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/startup_profile
83 Date:           August 2010
84 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
85 Description:    The integer value of this attribute ranges from 0-4.
86                 When read, this attribute returns the number of the profile
87                 that's active when the mouse is powered on.
88                 This file is readonly.
89
90 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/settings
91 Date:           August 2010
92 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
93 Description:    When read, this file returns the settings stored in the mouse.
94                 The size of the data is 3 bytes and holds information on the
95                 startup_profile.
96                 When written, this file lets write settings back to the mouse.
97                 The data has to be 3 bytes long. The mouse will reject invalid
98                 data.