Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.9 / f65e51d740688b8a0ad15cbde34974e6c4559972 / . / Documentation / ABI / testing / sysfs-driver-hid-roccat-koneplus
blob: 326e05452da72bcefba8b4f8f7cd903c12466ff3 [file] [log] [blame]
Stefan Achatz4ead3642010-12-10 19:43:34 +0100[diff] [blame]1What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/actual_profile
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]2Date: October 2010
3Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
4Description: When read, this file returns the number of the actual profile in
5 range 0-4.
6 This file is readonly.
Stefan Achatz759ae892011-02-03 17:10:30 +0100[diff] [blame]7Users: http://roccat.sourceforge.net
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]8
Stefan Achatz4ead3642010-12-10 19:43:34 +0100[diff] [blame]9What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/firmware_version
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]10Date: October 2010
11Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
12Description: When read, this file returns the raw integer version number of the
13 firmware reported by the mouse. Using the integer value eases
14 further usage in other programs. To receive the real version
15 number the decimal point has to be shifted 2 positions to the
16 left. E.g. a returned value of 121 means 1.21
17 This file is readonly.
Stefan Achatz759ae892011-02-03 17:10:30 +0100[diff] [blame]18Users: http://roccat.sourceforge.net
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]19
Stefan Achatz4ead3642010-12-10 19:43:34 +0100[diff] [blame]20What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/macro
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]21Date: October 2010
22Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
23Description: The mouse can store a macro with max 500 key/button strokes
24 internally.
25 When written, this file lets one set the sequence for a specific
26 button for a specific profile. Button and profile numbers are
27 included in written data. The data has to be 2082 bytes long.
28 This file is writeonly.
Stefan Achatz759ae892011-02-03 17:10:30 +0100[diff] [blame]29Users: http://roccat.sourceforge.net
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]30
Stefan Achatz4ead3642010-12-10 19:43:34 +0100[diff] [blame]31What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile_buttons
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]32Date: August 2010
33Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
34Description: The mouse can store 5 profiles which can be switched by the
35 press of a button. A profile is split in settings and buttons.
Sylvestre Ledruf65e51d2011-04-04 15:04:46 -0700[diff] [blame^]36 profile_buttons holds information about button layout.
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]37 When written, this file lets one write the respective profile
38 buttons back to the mouse. The data has to be 77 bytes long.
39 The mouse will reject invalid data.
40 Which profile to write is determined by the profile number
41 contained in the data.
42 This file is writeonly.
Stefan Achatz759ae892011-02-03 17:10:30 +0100[diff] [blame]43Users: http://roccat.sourceforge.net
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]44
Stefan Achatz4ead3642010-12-10 19:43:34 +0100[diff] [blame]45What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile[1-5]_buttons
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]46Date: August 2010
47Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
48Description: The mouse can store 5 profiles which can be switched by the
49 press of a button. A profile is split in settings and buttons.
Sylvestre Ledruf65e51d2011-04-04 15:04:46 -0700[diff] [blame^]50 profile_buttons holds information about button layout.
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]51 When read, these files return the respective profile buttons.
52 The returned data is 77 bytes in size.
53 This file is readonly.
Stefan Achatz759ae892011-02-03 17:10:30 +0100[diff] [blame]54Users: http://roccat.sourceforge.net
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]55
Stefan Achatz4ead3642010-12-10 19:43:34 +0100[diff] [blame]56What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile_settings
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]57Date: October 2010
58Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
59Description: The mouse can store 5 profiles which can be switched by the
60 press of a button. A profile is split in settings and buttons.
Sylvestre Ledruf65e51d2011-04-04 15:04:46 -0700[diff] [blame^]61 profile_settings holds information like resolution, sensitivity
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]62 and light effects.
63 When written, this file lets one write the respective profile
64 settings back to the mouse. The data has to be 43 bytes long.
65 The mouse will reject invalid data.
66 Which profile to write is determined by the profile number
67 contained in the data.
68 This file is writeonly.
Stefan Achatz759ae892011-02-03 17:10:30 +0100[diff] [blame]69Users: http://roccat.sourceforge.net
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]70
Stefan Achatz4ead3642010-12-10 19:43:34 +0100[diff] [blame]71What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/profile[1-5]_settings
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]72Date: August 2010
73Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
74Description: The mouse can store 5 profiles which can be switched by the
75 press of a button. A profile is split in settings and buttons.
Sylvestre Ledruf65e51d2011-04-04 15:04:46 -0700[diff] [blame^]76 profile_settings holds information like resolution, sensitivity
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]77 and light effects.
78 When read, these files return the respective profile settings.
79 The returned data is 43 bytes in size.
80 This file is readonly.
Stefan Achatz759ae892011-02-03 17:10:30 +0100[diff] [blame]81Users: http://roccat.sourceforge.net
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]82
Stefan Achatz4ead3642010-12-10 19:43:34 +0100[diff] [blame]83What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/sensor
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]84Date: October 2010
85Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
86Description: The mouse has a tracking- and a distance-control-unit. These
87 can be activated/deactivated and the lift-off distance can be
88 set. The data has to be 6 bytes long.
89 This file is writeonly.
Stefan Achatz759ae892011-02-03 17:10:30 +0100[diff] [blame]90Users: http://roccat.sourceforge.net
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]91
Stefan Achatz4ead3642010-12-10 19:43:34 +0100[diff] [blame]92What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/startup_profile
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]93Date: October 2010
94Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
95Description: The integer value of this attribute ranges from 0-4.
96 When read, this attribute returns the number of the profile
97 that's active when the mouse is powered on.
98 When written, this file sets the number of the startup profile
99 and the mouse activates this profile immediately.
Stefan Achatz759ae892011-02-03 17:10:30 +0100[diff] [blame]100Users: http://roccat.sourceforge.net
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]101
Stefan Achatz4ead3642010-12-10 19:43:34 +0100[diff] [blame]102What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/tcu
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]103Date: October 2010
104Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
105Description: When written a calibration process for the tracking control unit
106 can be initiated/cancelled.
107 The data has to be 3 bytes long.
108 This file is writeonly.
Stefan Achatz759ae892011-02-03 17:10:30 +0100[diff] [blame]109Users: http://roccat.sourceforge.net
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]110
Stefan Achatz4ead3642010-12-10 19:43:34 +0100[diff] [blame]111What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/koneplus/roccatkoneplus<minor>/tcu_image
Stefan Achatz47dbdbff2010-11-26 19:57:42 +0000[diff] [blame]112Date: October 2010
113Contact: Stefan Achatz <erazor_de@users.sourceforge.net>
114Description: When read the mouse returns a 30x30 pixel image of the
115 sampled underground. This works only in the course of a
116 calibration process initiated with tcu.
117 The returned data is 1028 bytes in size.
118 This file is readonly.
Stefan Achatz759ae892011-02-03 17:10:30 +0100[diff] [blame]119Users: http://roccat.sourceforge.net