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