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