WIP FPC-III support
[linux/fpc-iii.git] / Documentation / ABI / obsolete / sysfs-driver-hid-roccat-ryos
blob1d6a8cf9dc0a18a59a67be2628ca36b35c767e4f
1 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/control
2 Date:           October 2013
3 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
4 Description:    When written, this file lets one select which data from which
5                 profile will be read next. The data has to be 3 bytes long.
6                 This file is writeonly.
7 Users:          http://roccat.sourceforge.net
9 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/profile
10 Date:           October 2013
11 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
12 Description:    The mouse can store 5 profiles which can be switched by the
13                 press of a button. profile holds index of actual profile.
14                 This value is persistent, so its value determines the profile
15                 that's active when the device is powered on next time.
16                 When written, the device activates the set profile immediately.
17                 The data has to be 3 bytes long.
18                 The device will reject invalid data.
19 Users:          http://roccat.sourceforge.net
21 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/keys_primary
22 Date:           October 2013
23 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
24 Description:    When written, this file lets one set the default of all keys for
25                 a specific profile. Profile index is included in written data.
26                 The data has to be 125 bytes long.
27                 Before reading this file, control has to be written to select
28                 which profile to read.
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>/ryos/roccatryos<minor>/keys_function
32 Date:           October 2013
33 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
34 Description:    When written, this file lets one set the function of the
35                 function keys for a specific profile. Profile index is included
36                 in written data. The data has to be 95 bytes long.
37                 Before reading this file, control has to be written to select
38                 which profile to read.
39 Users:          http://roccat.sourceforge.net
41 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/keys_macro
42 Date:           October 2013
43 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
44 Description:    When written, this file lets one set the function of the macro
45                 keys for a specific profile. Profile index is included in
46                 written data. The data has to be 35 bytes long.
47                 Before reading this file, control has to be written to select
48                 which profile to read.
49 Users:          http://roccat.sourceforge.net
51 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/keys_thumbster
52 Date:           October 2013
53 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
54 Description:    When written, this file lets one set the function of the
55                 thumbster keys for a specific profile. Profile index is included
56                 in written data. The data has to be 23 bytes long.
57                 Before reading this file, control has to be written to select
58                 which profile to read.
59 Users:          http://roccat.sourceforge.net
61 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/keys_extra
62 Date:           October 2013
63 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
64 Description:    When written, this file lets one set the function of the
65                 capslock and function keys for a specific profile. Profile index
66                 is included in written data. The data has to be 8 bytes long.
67                 Before reading this file, control has to be written to select
68                 which profile to read.
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>/ryos/roccatryos<minor>/keys_easyzone
72 Date:           October 2013
73 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
74 Description:    When written, this file lets one set the function of the
75                 easyzone keys for a specific profile. Profile index is included
76                 in written data. The data has to be 294 bytes long.
77                 Before reading this file, control has to be written to select
78                 which profile to read.
79 Users:          http://roccat.sourceforge.net
81 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/key_mask
82 Date:           October 2013
83 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
84 Description:    When written, this file lets one deactivate certain keys like
85                 windows and application keys, to prevent accidental presses.
86                 Profile index for which this settings occur is included in
87                 written data. The data has to be 6 bytes long.
88                 Before reading this file, control has to be written to select
89                 which profile to read.
90 Users:          http://roccat.sourceforge.net
92 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/light
93 Date:           October 2013
94 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
95 Description:    When written, this file lets one set the backlight intensity for
96                 a specific profile. Profile index is included in written data.
97                 This attribute is only valid for the glow and pro variant.
98                 The data has to be 16 bytes long.
99                 Before reading this file, control has to be written to select
100                 which profile to read.
101 Users:          http://roccat.sourceforge.net
103 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/macro
104 Date:           October 2013
105 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
106 Description:    When written, this file lets one store macros with max 480
107                 keystrokes for a specific button for a specific profile.
108                 Button and profile indexes are included in written data.
109                 The data has to be 2002 bytes long.
110                 Before reading this file, control has to be written to select
111                 which profile and key to read.
112 Users:          http://roccat.sourceforge.net
114 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/info
115 Date:           October 2013
116 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
117 Description:    When read, this file returns general data like firmware version.
118                 The data is 8 bytes long.
119                 This file is readonly.
120 Users:          http://roccat.sourceforge.net
122 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/reset
123 Date:           October 2013
124 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
125 Description:    When written, this file lets one reset the device.
126                 The data has to be 3 bytes long.
127                 This file is writeonly.
128 Users:          http://roccat.sourceforge.net
130 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/talk
131 Date:           October 2013
132 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
133 Description:    When written, this file lets one trigger easyshift functionality
134                 from the host.
135                 The data has to be 16 bytes long.
136                 This file is writeonly.
137 Users:          http://roccat.sourceforge.net
139 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/light_control
140 Date:           October 2013
141 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
142 Description:    When written, this file lets one switch between stored and custom
143                 light settings.
144                 This attribute is only valid for the pro variant.
145                 The data has to be 8 bytes long.
146                 This file is writeonly.
147 Users:          http://roccat.sourceforge.net
149 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/stored_lights
150 Date:           October 2013
151 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
152 Description:    When written, this file lets one set per-key lighting for different
153                 layers.
154                 This attribute is only valid for the pro variant.
155                 The data has to be 1382 bytes long.
156                 Before reading this file, control has to be written to select
157                 which profile to read.
158 Users:          http://roccat.sourceforge.net
160 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/custom_lights
161 Date:           October 2013
162 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
163 Description:    When written, this file lets one set the actual per-key lighting.
164                 This attribute is only valid for the pro variant.
165                 The data has to be 20 bytes long.
166                 This file is writeonly.
167 Users:          http://roccat.sourceforge.net
169 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/ryos/roccatryos<minor>/light_macro
170 Date:           October 2013
171 Contact:        Stefan Achatz <erazor_de@users.sourceforge.net>
172 Description:    When written, this file lets one set a light macro that is looped
173                 whenever the device gets in dimness mode.
174                 This attribute is only valid for the pro variant.
175                 The data has to be 2002 bytes long.
176                 Before reading this file, control has to be written to select
177                 which profile to read.
178 Users:          http://roccat.sourceforge.net