linux-imx/Documentation/ABI/obsolete/sysfs-driver-hid-roccat-koneplus
Stefan Achatz 8d2f8479da HID: roccat: Fixed resubmit: Deprecating most Roccat sysfs attributes
Deprecates all Roccat sysfs attributes except the ones for the old Kone by
moving abi descriptions from testing to obsolete.  For most devices everything
can be done using the hidraw ioctls HIDIOCGFEATURE and HIDIOCSFEATURE, so I
would suggest future removal of device specific drivers.  The userspace tools
don't use these attributes for a year now.  The first Kone is not fully
HID-compliant and will still need a module.

Signed-off-by: Stefan Achatz <erazor_de@users.sourceforge.net>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>
2015-10-21 11:54:42 +02:00

7.8 KiB

What: /sys/bus/usb/devices/-:./::./koneplus/roccatkoneplus/actual_profile Date: October 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 actual profile. This value is persistent, so its equivalent to the profile that's active when the mouse is powered on next time. When written, this file sets the number of the startup profile and the mouse activates this profile immediately. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./koneplus/roccatkoneplus/startup_profile Date: October 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 actual profile. This value is persistent, so its equivalent to the profile that's active when the mouse is powered on next time. When written, this file sets the number of the startup profile and the mouse activates this profile immediately. Please use actual_profile, it does the same thing. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./koneplus/roccatkoneplus/firmware_version Date: October 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 121 means 1.21 This file is readonly. Please read binary attribute info which contains firmware version. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./koneplus/roccatkoneplus/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 8 bytes long. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./koneplus/roccatkoneplus/macro Date: October 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: The mouse can store a macro with max 500 key/button strokes internally. When written, this file lets one set the sequence for a specific button for a specific profile. Button and profile numbers are included in written data. The data has to be 2082 bytes long. This file is writeonly. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./koneplus/roccatkoneplus/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 77 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/-:./::./koneplus/roccatkoneplus/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 77 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/-:./::./koneplus/roccatkoneplus/profile_settings Date: October 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 43 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/-:./::./koneplus/roccatkoneplus/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 43 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/-:./::./koneplus/roccatkoneplus/sensor Date: October 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: The mouse has a tracking- and a distance-control-unit. These can be activated/deactivated and the lift-off distance can be set. The data has to be 6 bytes long. This file is writeonly. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./koneplus/roccatkoneplus/talk Date: May 2011 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: Used to active some easy* functions of the mouse from outside. The data has to be 16 bytes long. This file is writeonly. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./koneplus/roccatkoneplus/tcu Date: October 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: When written a calibration process for the tracking control unit can be initiated/cancelled. Also lets one read/write sensor registers. The data has to be 4 bytes long. Users: http://roccat.sourceforge.net

What: /sys/bus/usb/devices/-:./::./koneplus/roccatkoneplus/tcu_image Date: October 2010 Contact: Stefan Achatz erazor_de@users.sourceforge.net Description: When read the mouse returns a 30x30 pixel image of the sampled underground. This works only in the course of a calibration process initiated with tcu. The returned data is 1028 bytes in size. This file is readonly. Users: http://roccat.sourceforge.net