Merge branch 'fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/evalenti/linux...
[linux/fpc-iii.git] / Documentation / ABI / obsolete / sysfs-driver-hid-roccat-pyra
blob16020b31ae640eddda12cae66d54f48a7c4cb65b
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                 Has never been used. If bookkeeping is done, it's done in userland tools.
17 Users:          http://roccat.sourceforge.net
19 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/actual_profile
20 Date:           August 2010
21 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
22 Description:    When read, this file returns the number of the actual profile in
23                 range 0-4.
24                 This file is readonly.
25                 Please use binary attribute "settings" which provides this information.
26 Users:          http://roccat.sourceforge.net
28 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/firmware_version
29 Date:           August 2010
30 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
31 Description:    When read, this file returns the raw integer version number of the
32                 firmware reported by the mouse. Using the integer value eases
33                 further usage in other programs. To receive the real version
34                 number the decimal point has to be shifted 2 positions to the
35                 left. E.g. a returned value of 138 means 1.38
36                 This file is readonly.
37                 Please use binary attribute "info" which provides this information.
38 Users:          http://roccat.sourceforge.net
40 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/info
41 Date:           November 2012
42 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
43 Description:    When read, this file returns general data like firmware version.
44                 When written, the device can be reset.
45                 The data is 6 bytes long.
46 Users:          http://roccat.sourceforge.net
48 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_buttons
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_buttons holds information about button layout.
54                 When written, this file lets one write the respective profile
55                 buttons back to the mouse. The data has to be 19 bytes long.
56                 The mouse will reject invalid data.
57                 Which profile to write is determined by the profile number
58                 contained in the data.
59                 Before reading this file, control has to be written to select
60                 which profile to read.
61 Users:          http://roccat.sourceforge.net
63 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
64 Date:           August 2010
65 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
66 Description:    The mouse can store 5 profiles which can be switched by the
67                 press of a button. A profile is split in settings and buttons.
68                 profile_buttons holds information about button layout.
69                 When read, these files return the respective profile buttons.
70                 The returned data is 19 bytes in size.
71                 This file is readonly.
72                 Write control to select profile and read profile_buttons instead.
73 Users:          http://roccat.sourceforge.net
75 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_settings
76 Date:           August 2010
77 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
78 Description:    The mouse can store 5 profiles which can be switched by the
79                 press of a button. A profile is split in settings and buttons.
80                 profile_settings holds information like resolution, sensitivity
81                 and light effects.
82                 When written, this file lets one write the respective profile
83                 settings back to the mouse. The data has to be 13 bytes long.
84                 The mouse will reject invalid data.
85                 Which profile to write is determined by the profile number
86                 contained in the data.
87                 Before reading this file, control has to be written to select
88                 which profile to read.
89 Users:          http://roccat.sourceforge.net
91 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
92 Date:           August 2010
93 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
94 Description:    The mouse can store 5 profiles which can be switched by the
95                 press of a button. A profile is split in settings and buttons.
96                 profile_settings holds information like resolution, sensitivity
97                 and light effects.
98                 When read, these files return the respective profile settings.
99                 The returned data is 13 bytes in size.
100                 This file is readonly.
101                 Write control to select profile and read profile_settings instead.
102 Users:          http://roccat.sourceforge.net
104 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/settings
105 Date:           August 2010
106 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
107 Description:    When read, this file returns the settings stored in the mouse.
108                 The size of the data is 3 bytes and holds information on the
109                 startup_profile.
110                 When written, this file lets write settings back to the mouse.
111                 The data has to be 3 bytes long. The mouse will reject invalid
112                 data.
113 Users:          http://roccat.sourceforge.net
115 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/startup_profile
116 Date:           August 2010
117 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
118 Description:    The integer value of this attribute ranges from 0-4.
119                 When read, this attribute returns the number of the profile
120                 that's active when the mouse is powered on.
121                 This file is readonly.
122                 Please use binary attribute "settings" which provides this information.
123 Users:          http://roccat.sourceforge.net