xref: /OK3568_Linux_fs/kernel/Documentation/ABI/obsolete/sysfs-driver-hid-roccat-pyra (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/actual_cpi
2*4882a593SmuzhiyunDate:		August 2010
3*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
4*4882a593SmuzhiyunDescription:	It is possible to switch the cpi setting of the mouse with the
5*4882a593Smuzhiyun		press of a button.
6*4882a593Smuzhiyun		When read, this file returns the raw number of the actual cpi
7*4882a593Smuzhiyun		setting reported by the mouse. This number has to be further
8*4882a593Smuzhiyun		processed to receive the real dpi value:
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun		===== ====
11*4882a593Smuzhiyun		VALUE DPI
12*4882a593Smuzhiyun		===== ====
13*4882a593Smuzhiyun		1     400
14*4882a593Smuzhiyun		2     800
15*4882a593Smuzhiyun		4     1600
16*4882a593Smuzhiyun		===== ====
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun		This file is readonly.
19*4882a593Smuzhiyun		Has never been used. If bookkeeping is done, it's done in userland tools.
20*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/actual_profile
23*4882a593SmuzhiyunDate:		August 2010
24*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
25*4882a593SmuzhiyunDescription:	When read, this file returns the number of the actual profile in
26*4882a593Smuzhiyun		range 0-4.
27*4882a593Smuzhiyun		This file is readonly.
28*4882a593Smuzhiyun		Please use binary attribute "settings" which provides this information.
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>/pyra/roccatpyra<minor>/firmware_version
32*4882a593SmuzhiyunDate:		August 2010
33*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
34*4882a593SmuzhiyunDescription:	When read, this file returns the raw integer version number of the
35*4882a593Smuzhiyun		firmware reported by the mouse. Using the integer value eases
36*4882a593Smuzhiyun		further usage in other programs. To receive the real version
37*4882a593Smuzhiyun		number the decimal point has to be shifted 2 positions to the
38*4882a593Smuzhiyun		left. E.g. a returned value of 138 means 1.38
39*4882a593Smuzhiyun		This file is readonly.
40*4882a593Smuzhiyun		Please use binary attribute "info" which provides this information.
41*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
42*4882a593Smuzhiyun
43*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/info
44*4882a593SmuzhiyunDate:		November 2012
45*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
46*4882a593SmuzhiyunDescription:	When read, this file returns general data like firmware version.
47*4882a593Smuzhiyun		When written, the device can be reset.
48*4882a593Smuzhiyun		The data is 6 bytes long.
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>/pyra/roccatpyra<minor>/profile_buttons
52*4882a593SmuzhiyunDate:		August 2010
53*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
54*4882a593SmuzhiyunDescription:	The mouse can store 5 profiles which can be switched by the
55*4882a593Smuzhiyun		press of a button. A profile is split in settings and buttons.
56*4882a593Smuzhiyun		profile_buttons holds information about button layout.
57*4882a593Smuzhiyun		When written, this file lets one write the respective profile
58*4882a593Smuzhiyun		buttons back to the mouse. The data has to be 19 bytes long.
59*4882a593Smuzhiyun		The mouse will reject invalid data.
60*4882a593Smuzhiyun		Which profile to write is determined by the profile number
61*4882a593Smuzhiyun		contained in the data.
62*4882a593Smuzhiyun		Before reading this file, control has to be written to select
63*4882a593Smuzhiyun		which profile to read.
64*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
65*4882a593Smuzhiyun
66*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile[1-5]_buttons
67*4882a593SmuzhiyunDate:		August 2010
68*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
69*4882a593SmuzhiyunDescription:	The mouse can store 5 profiles which can be switched by the
70*4882a593Smuzhiyun		press of a button. A profile is split in settings and buttons.
71*4882a593Smuzhiyun		profile_buttons holds information about button layout.
72*4882a593Smuzhiyun		When read, these files return the respective profile buttons.
73*4882a593Smuzhiyun		The returned data is 19 bytes in size.
74*4882a593Smuzhiyun		This file is readonly.
75*4882a593Smuzhiyun		Write control to select profile and read profile_buttons instead.
76*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
77*4882a593Smuzhiyun
78*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_settings
79*4882a593SmuzhiyunDate:		August 2010
80*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
81*4882a593SmuzhiyunDescription:	The mouse can store 5 profiles which can be switched by the
82*4882a593Smuzhiyun		press of a button. A profile is split in settings and buttons.
83*4882a593Smuzhiyun		profile_settings holds information like resolution, sensitivity
84*4882a593Smuzhiyun		and light effects.
85*4882a593Smuzhiyun		When written, this file lets one write the respective profile
86*4882a593Smuzhiyun		settings back to the mouse. The data has to be 13 bytes long.
87*4882a593Smuzhiyun		The mouse will reject invalid data.
88*4882a593Smuzhiyun		Which profile to write is determined by the profile number
89*4882a593Smuzhiyun		contained in the data.
90*4882a593Smuzhiyun		Before reading this file, control has to be written to select
91*4882a593Smuzhiyun		which profile to read.
92*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
93*4882a593Smuzhiyun
94*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile[1-5]_settings
95*4882a593SmuzhiyunDate:		August 2010
96*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
97*4882a593SmuzhiyunDescription:	The mouse can store 5 profiles which can be switched by the
98*4882a593Smuzhiyun		press of a button. A profile is split in settings and buttons.
99*4882a593Smuzhiyun		profile_settings holds information like resolution, sensitivity
100*4882a593Smuzhiyun		and light effects.
101*4882a593Smuzhiyun		When read, these files return the respective profile settings.
102*4882a593Smuzhiyun		The returned data is 13 bytes in size.
103*4882a593Smuzhiyun		This file is readonly.
104*4882a593Smuzhiyun		Write control to select profile and read profile_settings instead.
105*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
106*4882a593Smuzhiyun
107*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/settings
108*4882a593SmuzhiyunDate:		August 2010
109*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
110*4882a593SmuzhiyunDescription:	When read, this file returns the settings stored in the mouse.
111*4882a593Smuzhiyun		The size of the data is 3 bytes and holds information on the
112*4882a593Smuzhiyun		startup_profile.
113*4882a593Smuzhiyun		When written, this file lets write settings back to the mouse.
114*4882a593Smuzhiyun		The data has to be 3 bytes long. The mouse will reject invalid
115*4882a593Smuzhiyun		data.
116*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
117*4882a593Smuzhiyun
118*4882a593SmuzhiyunWhat:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/startup_profile
119*4882a593SmuzhiyunDate:		August 2010
120*4882a593SmuzhiyunContact:	Stefan Achatz <erazor_de@users.sourceforge.net>
121*4882a593SmuzhiyunDescription:	The integer value of this attribute ranges from 0-4.
122*4882a593Smuzhiyun                When read, this attribute returns the number of the profile
123*4882a593Smuzhiyun                that's active when the mouse is powered on.
124*4882a593Smuzhiyun		This file is readonly.
125*4882a593Smuzhiyun		Please use binary attribute "settings" which provides this information.
126*4882a593SmuzhiyunUsers:		http://roccat.sourceforge.net
127