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