linux-imx/Documentation/ABI/obsolete/sysfs-driver-hid-roccat-pyra
Mauro Carvalho Chehab 54a19b4d3f docs: ABI: cleanup several ABI documents
There are some ABI documents that, while they don't generate
any warnings, they have issues when parsed by get_abi.pl script
on its output result.

Address them, in order to provide a clean output.

Reviewed-by: Tom Rix <trix@redhat.com> # for fpga-manager
Reviewed-By: Kajol Jain<kjain@linux.ibm.com> # for sysfs-bus-event_source-devices-hv_gpci and sysfs-bus-event_source-devices-hv_24x7
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> #for IIO
Acked-by: Oded Gabbay <oded.gabbay@gmail.com> # for Habanalabs
Acked-by: Vaibhav Jain <vaibhav@linux.ibm.com> # for sysfs-bus-papr-pmem
Acked-by: Cezary Rojewski <cezary.rojewski@intel.com> # for catpt
Acked-by: Suzuki K Poulose <suzuki.poulose@arm.com>
Acked-by: Ilya Dryomov <idryomov@gmail.com> # for rbd
Acked-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2020-10-30 13:14:29 +01:00

6.3 KiB

What: /sys/bus/usb/devices/-:./::./pyra/roccatpyra/actual_cpi Date: August 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: It is possible to switch the cpi setting of the mouse with the press of a button. When read, this file returns the raw number of the actual cpi setting reported by the mouse. This number has to be further processed to receive the real dpi value:

	===== ====
	VALUE DPI
	===== ====
	1     400
	2     800
	4     1600
	===== ====

	This file is readonly.
	Has never been used. If bookkeeping is done, it's done in userland tools.

Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./pyra/roccatpyra/actual_profile Date: August 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: When read, this file returns the number of the actual profile in range 0-4. This file is readonly. Please use binary attribute "settings" which provides this information. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./pyra/roccatpyra/firmware_version Date: August 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: When read, this file returns the raw integer version number of the firmware reported by the mouse. Using the integer value eases further usage in other programs. To receive the real version number the decimal point has to be shifted 2 positions to the left. E.g. a returned value of 138 means 1.38 This file is readonly. Please use binary attribute "info" which provides this information. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./pyra/roccatpyra/info Date: November 2012 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: When read, this file returns general data like firmware version. When written, the device can be reset. The data is 6 bytes long. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./pyra/roccatpyra/profile_buttons Date: August 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: The mouse can store 5 profiles which can be switched by the press of a button. A profile is split in settings and buttons. profile_buttons holds information about button layout. When written, this file lets one write the respective profile buttons back to the mouse. The data has to be 19 bytes long. The mouse will reject invalid data. Which profile to write is determined by the profile number contained in the data. Before reading this file, control has to be written to select which profile to read. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./pyra/roccatpyra/profile[1-5]_buttons Date: August 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: The mouse can store 5 profiles which can be switched by the press of a button. A profile is split in settings and buttons. profile_buttons holds information about button layout. When read, these files return the respective profile buttons. The returned data is 19 bytes in size. This file is readonly. Write control to select profile and read profile_buttons instead. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./pyra/roccatpyra/profile_settings Date: August 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: The mouse can store 5 profiles which can be switched by the press of a button. A profile is split in settings and buttons. profile_settings holds information like resolution, sensitivity and light effects. When written, this file lets one write the respective profile settings back to the mouse. The data has to be 13 bytes long. The mouse will reject invalid data. Which profile to write is determined by the profile number contained in the data. Before reading this file, control has to be written to select which profile to read. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./pyra/roccatpyra/profile[1-5]_settings Date: August 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: The mouse can store 5 profiles which can be switched by the press of a button. A profile is split in settings and buttons. profile_settings holds information like resolution, sensitivity and light effects. When read, these files return the respective profile settings. The returned data is 13 bytes in size. This file is readonly. Write control to select profile and read profile_settings instead. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./pyra/roccatpyra/settings Date: August 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: When read, this file returns the settings stored in the mouse. The size of the data is 3 bytes and holds information on the startup_profile. When written, this file lets write settings back to the mouse. The data has to be 3 bytes long. The mouse will reject invalid data. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./pyra/roccatpyra/startup_profile Date: August 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: The integer value of this attribute ranges from 0-4. When read, this attribute returns the number of the profile that's active when the mouse is powered on. This file is readonly. Please use binary attribute "settings" which provides this information. Users: http://roccat.sourceforge.net