Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

HID: roccat: Add 'Users:' tag to sysfs documentation

Added 'Users:' tag to sysfs documentation of roccat device drivers
pointing to project website at sourceforge.

Signed-off-by: Stefan Achatz <erazor_de@users.sourceforge.net>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

authored by

Stefan Achatz and committed by
Jiri Kosina
759ae89a 5dc0c983

+42
+5
Documentation/ABI/testing/sysfs-driver-hid-roccat-arvo
··· 6 6 profile which is also the profile that's active on device startup. 7 7 When written this attribute activates the selected profile 8 8 immediately. 9 + Users: http://roccat.sourceforge.net 9 10 10 11 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/arvo/roccatarvo<minor>/button 11 12 Date: Januar 2011 ··· 17 16 button for a specific profile. Button and profile numbers are 18 17 included in written data. The data has to be 24 bytes long. 19 18 This file is writeonly. 19 + Users: http://roccat.sourceforge.net 20 20 21 21 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/arvo/roccatarvo<minor>/info 22 22 Date: Januar 2011 ··· 26 24 installed firmware version. 27 25 The size of the data is 8 bytes in size. 28 26 This file is readonly. 27 + Users: http://roccat.sourceforge.net 29 28 30 29 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/arvo/roccatarvo<minor>/key_mask 31 30 Date: Januar 2011 ··· 39 36 When read, this file returns the current state of the buttons. 40 37 When written, the given buttons are activated/deactivated 41 38 immediately. 39 + Users: http://roccat.sourceforge.net 42 40 43 41 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/arvo/roccatarvo<minor>/mode_key 44 42 Date: Januar 2011 ··· 50 46 The integer value of this attribute ranges from 0 (OFF) to 1 (ON). 51 47 When read, this file returns the actual state of the key. 52 48 When written, the key is activated/deactivated immediately. 49 + Users: http://roccat.sourceforge.net
+8
Documentation/ABI/testing/sysfs-driver-hid-roccat-kone
··· 16 16 6 3200 17 17 18 18 This file is readonly. 19 + Users: http://roccat.sourceforge.net 19 20 20 21 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/actual_profile 21 22 Date: March 2010 22 23 Contact: Stefan Achatz <erazor_de@users.sourceforge.net> 23 24 Description: When read, this file returns the number of the actual profile. 24 25 This file is readonly. 26 + Users: http://roccat.sourceforge.net 25 27 26 28 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/firmware_version 27 29 Date: March 2010 ··· 34 32 number the decimal point has to be shifted 2 positions to the 35 33 left. E.g. a returned value of 138 means 1.38 36 34 This file is readonly. 35 + Users: http://roccat.sourceforge.net 37 36 38 37 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/profile[1-5] 39 38 Date: March 2010 ··· 50 47 The mouse will reject invalid data, whereas the profile number 51 48 stored in the profile doesn't need to fit the number of the 52 49 store. 50 + Users: http://roccat.sourceforge.net 53 51 54 52 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/settings 55 53 Date: March 2010 ··· 61 57 When written, this file lets write settings back to the mouse. 62 58 The data has to be 36 bytes long. The mouse will reject invalid 63 59 data. 60 + Users: http://roccat.sourceforge.net 64 61 65 62 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/startup_profile 66 63 Date: March 2010 ··· 71 66 that's active when the mouse is powered on. 72 67 When written, this file sets the number of the startup profile 73 68 and the mouse activates this profile immediately. 69 + Users: http://roccat.sourceforge.net 74 70 75 71 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/tcu 76 72 Date: March 2010 ··· 83 77 Writing 0 in this file will switch the TCU off. 84 78 Writing 1 in this file will start the calibration which takes 85 79 around 6 seconds to complete and activates the TCU. 80 + Users: http://roccat.sourceforge.net 86 81 87 82 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kone/roccatkone<minor>/weight 88 83 Date: March 2010 ··· 103 96 4 20g 104 97 105 98 This file is readonly. 99 + Users: http://roccat.sourceforge.net
+11
Documentation/ABI/testing/sysfs-driver-hid-roccat-koneplus
··· 4 4 Description: When read, this file returns the number of the actual profile in 5 5 range 0-4. 6 6 This file is readonly. 7 + Users: http://roccat.sourceforge.net 7 8 8 9 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/firmware_version 9 10 Date: October 2010 ··· 15 14 number the decimal point has to be shifted 2 positions to the 16 15 left. E.g. a returned value of 121 means 1.21 17 16 This file is readonly. 17 + Users: http://roccat.sourceforge.net 18 18 19 19 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/macro 20 20 Date: October 2010 ··· 26 24 button for a specific profile. Button and profile numbers are 27 25 included in written data. The data has to be 2082 bytes long. 28 26 This file is writeonly. 27 + Users: http://roccat.sourceforge.net 29 28 30 29 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile_buttons 31 30 Date: August 2010 ··· 40 37 Which profile to write is determined by the profile number 41 38 contained in the data. 42 39 This file is writeonly. 40 + Users: http://roccat.sourceforge.net 43 41 44 42 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile[1-5]_buttons 45 43 Date: August 2010 ··· 51 47 When read, these files return the respective profile buttons. 52 48 The returned data is 77 bytes in size. 53 49 This file is readonly. 50 + Users: http://roccat.sourceforge.net 54 51 55 52 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile_settings 56 53 Date: October 2010 ··· 66 61 Which profile to write is determined by the profile number 67 62 contained in the data. 68 63 This file is writeonly. 64 + Users: http://roccat.sourceforge.net 69 65 70 66 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile[1-5]_settings 71 67 Date: August 2010 ··· 78 72 When read, these files return the respective profile settings. 79 73 The returned data is 43 bytes in size. 80 74 This file is readonly. 75 + Users: http://roccat.sourceforge.net 81 76 82 77 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/sensor 83 78 Date: October 2010 ··· 87 80 can be activated/deactivated and the lift-off distance can be 88 81 set. The data has to be 6 bytes long. 89 82 This file is writeonly. 83 + Users: http://roccat.sourceforge.net 90 84 91 85 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/startup_profile 92 86 Date: October 2010 ··· 97 89 that's active when the mouse is powered on. 98 90 When written, this file sets the number of the startup profile 99 91 and the mouse activates this profile immediately. 92 + Users: http://roccat.sourceforge.net 100 93 101 94 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/tcu 102 95 Date: October 2010 ··· 106 97 can be initiated/cancelled. 107 98 The data has to be 3 bytes long. 108 99 This file is writeonly. 100 + Users: http://roccat.sourceforge.net 109 101 110 102 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/tcu_image 111 103 Date: October 2010 ··· 116 106 calibration process initiated with tcu. 117 107 The returned data is 1028 bytes in size. 118 108 This file is readonly. 109 + Users: http://roccat.sourceforge.net
+9
Documentation/ABI/testing/sysfs-driver-hid-roccat-kovaplus
··· 5 5 When read, this attribute returns the number of the active 6 6 cpi level. 7 7 This file is readonly. 8 + Users: http://roccat.sourceforge.net 8 9 9 10 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/actual_profile 10 11 Date: January 2011 ··· 16 15 When written, the mouse activates this profile immediately. 17 16 The profile that's active when powered down is the same that's 18 17 active when the mouse is powered on. 18 + Users: http://roccat.sourceforge.net 19 19 20 20 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/actual_sensitivity_x 21 21 Date: January 2011 ··· 25 23 When read, this attribute returns the number of the actual 26 24 sensitivity in x direction. 27 25 This file is readonly. 26 + Users: http://roccat.sourceforge.net 28 27 29 28 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/actual_sensitivity_y 30 29 Date: January 2011 ··· 34 31 When read, this attribute returns the number of the actual 35 32 sensitivity in y direction. 36 33 This file is readonly. 34 + Users: http://roccat.sourceforge.net 37 35 38 36 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/firmware_version 39 37 Date: January 2011 ··· 45 41 number the decimal point has to be shifted 2 positions to the 46 42 left. E.g. a returned value of 121 means 1.21 47 43 This file is readonly. 44 + Users: http://roccat.sourceforge.net 48 45 49 46 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/profile_buttons 50 47 Date: January 2011 ··· 59 54 Which profile to write is determined by the profile number 60 55 contained in the data. 61 56 This file is writeonly. 57 + Users: http://roccat.sourceforge.net 62 58 63 59 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/profile[1-5]_buttons 64 60 Date: January 2011 ··· 70 64 When read, these files return the respective profile buttons. 71 65 The returned data is 23 bytes in size. 72 66 This file is readonly. 67 + Users: http://roccat.sourceforge.net 73 68 74 69 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/profile_settings 75 70 Date: January 2011 ··· 85 78 Which profile to write is determined by the profile number 86 79 contained in the data. 87 80 This file is writeonly. 81 + Users: http://roccat.sourceforge.net 88 82 89 83 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/kovaplus/roccatkovaplus<minor>/profile[1-5]_settings 90 84 Date: January 2011 ··· 97 89 When read, these files return the respective profile settings. 98 90 The returned data is 16 bytes in size. 99 91 This file is readonly. 92 + Users: http://roccat.sourceforge.net
+9
Documentation/ABI/testing/sysfs-driver-hid-roccat-pyra
··· 13 13 4 1600 14 14 15 15 This file is readonly. 16 + Users: http://roccat.sourceforge.net 16 17 17 18 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/actual_profile 18 19 Date: August 2010 ··· 21 20 Description: When read, this file returns the number of the actual profile in 22 21 range 0-4. 23 22 This file is readonly. 23 + Users: http://roccat.sourceforge.net 24 24 25 25 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/firmware_version 26 26 Date: August 2010 ··· 32 30 number the decimal point has to be shifted 2 positions to the 33 31 left. E.g. a returned value of 138 means 1.38 34 32 This file is readonly. 33 + Users: http://roccat.sourceforge.net 35 34 36 35 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_settings 37 36 Date: August 2010 ··· 47 44 Which profile to write is determined by the profile number 48 45 contained in the data. 49 46 This file is writeonly. 47 + Users: http://roccat.sourceforge.net 50 48 51 49 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile[1-5]_settings 52 50 Date: August 2010 ··· 59 55 When read, these files return the respective profile settings. 60 56 The returned data is 13 bytes in size. 61 57 This file is readonly. 58 + Users: http://roccat.sourceforge.net 62 59 63 60 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile_buttons 64 61 Date: August 2010 ··· 73 68 Which profile to write is determined by the profile number 74 69 contained in the data. 75 70 This file is writeonly. 71 + Users: http://roccat.sourceforge.net 76 72 77 73 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/profile[1-5]_buttons 78 74 Date: August 2010 ··· 84 78 When read, these files return the respective profile buttons. 85 79 The returned data is 19 bytes in size. 86 80 This file is readonly. 81 + Users: http://roccat.sourceforge.net 87 82 88 83 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/startup_profile 89 84 Date: August 2010 ··· 93 86 When read, this attribute returns the number of the profile 94 87 that's active when the mouse is powered on. 95 88 This file is readonly. 89 + Users: http://roccat.sourceforge.net 96 90 97 91 What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/pyra/roccatpyra<minor>/settings 98 92 Date: August 2010 ··· 104 96 When written, this file lets write settings back to the mouse. 105 97 The data has to be 3 bytes long. The mouse will reject invalid 106 98 data. 99 + Users: http://roccat.sourceforge.net