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