Merge tag 'x86_seves_for_v5.10_rc3' of git://git.kernel.org/pub/scm/linux/kernel...

[linux-2.6-microblaze.git] / Documentation / ABI / testing / sysfs-driver-hid-roccat-kone

diff --git a/Documentation/ABI/testing/sysfs-driver-hid-roccat-kone b/Documentation/ABI/testing/sysfs-driver-hid-roccat-kone
index 8f7982c..11cd9bf 100644 (file)
--- a/Documentation/ABI/testing/sysfs-driver-hid-roccat-kone
+++ b/Documentation/ABI/testing/sysfs-driver-hid-roccat-kone
@@ -3,17 +3,21 @@ Date:         March 2010
 Contact:       Stefan Achatz <erazor_de@users.sourceforge.net>
 Description:   It is possible to switch the dpi setting of the mouse with the
                press of a button.
+
                When read, this file returns the raw number of the actual dpi
                setting reported by the mouse. This number has to be further
                processed to receive the real dpi value:
 
+               ===== =====
                VALUE DPI
+               ===== =====
                1     800
                2     1200
                3     1600
                4     2000
                5     2400
                6     3200
+               ===== =====
 
                This file is readonly.
 Users:         http://roccat.sourceforge.net
@@ -22,6 +26,7 @@ What:         /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-
 Date:          March 2010
 Contact:       Stefan Achatz <erazor_de@users.sourceforge.net>
 Description:   When read, this file returns the number of the actual profile.
+
                This file is readonly.
 Users:         http://roccat.sourceforge.net
 
@@ -33,6 +38,7 @@ Description:  When read, this file returns the raw integer version number of the
                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.
 Users:         http://roccat.sourceforge.net
 
@@ -43,10 +49,13 @@ Description:        The mouse can store 5 profiles which can be switched by the
                 press of a button. A profile holds information like button
                 mappings, sensitivity, the colors of the 5 leds and light
                 effects.
+
                 When read, these files return the respective profile. The
                 returned data is 975 bytes in size.
+
                When written, this file lets one write the respective profile
                data back to the mouse. The data has to be 975 bytes long.
+
                The mouse will reject invalid data, whereas the profile number
                stored in the profile doesn't need to fit the number of the
                store.
@@ -58,6 +67,7 @@ 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 36 bytes and holds information like the
                startup_profile, tcu state and calibration_data.
+
                When written, this file lets write settings back to the mouse.
                The data has to be 36 bytes long. The mouse will reject invalid
                data.
@@ -67,8 +77,10 @@ What:                /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-
 Date:          March 2010
 Contact:       Stefan Achatz <erazor_de@users.sourceforge.net>
 Description:   The integer value of this attribute ranges from 1 to 5.
+
                 When read, this attribute returns the number of the profile
                 that's active when the mouse is powered on.
+
                When written, this file sets the number of the startup profile
                and the mouse activates this profile immediately.
 Users:         http://roccat.sourceforge.net
@@ -80,9 +92,12 @@ Description: The mouse has a "Tracking Control Unit" which lets the user
                calibrate the laser power to fit the mousepad surface.
                When read, this file returns the current state of the TCU,
                where 0 means off and 1 means on.
+
                Writing 0 in this file will switch the TCU off.
+
                Writing 1 in this file will start the calibration which takes
                around 6 seconds to complete and activates the TCU.
+
 Users:         http://roccat.sourceforge.net
 
 What:          /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/weight
@@ -93,14 +108,18 @@ Description:       The mouse can be equipped with one of four supplied weights
                and its value can be read out. When read, this file returns the
                raw value returned by the mouse which eases further processing
                in other software.
+
                The values map to the weights as follows:
 
+               ===== ======
                VALUE WEIGHT
+               ===== ======
                0     none
                1     5g
                2     10g
                3     15g
                4     20g
+               ===== ======
 
                This file is readonly.
 Users:         http://roccat.sourceforge.net