diff options
Diffstat (limited to 'Documentation/ABI')
-rw-r--r-- | Documentation/ABI/testing/sysfs-ata | 99 | ||||
-rw-r--r-- | Documentation/ABI/testing/sysfs-devices-power | 88 | ||||
-rw-r--r-- | Documentation/ABI/testing/sysfs-driver-hid-roccat-pyra | 98 | ||||
-rw-r--r-- | Documentation/ABI/testing/sysfs-module | 12 | ||||
-rw-r--r-- | Documentation/ABI/testing/sysfs-power | 29 |
5 files changed, 326 insertions, 0 deletions
diff --git a/Documentation/ABI/testing/sysfs-ata b/Documentation/ABI/testing/sysfs-ata new file mode 100644 index 000000000000..0a932155cbba --- /dev/null +++ b/Documentation/ABI/testing/sysfs-ata | |||
@@ -0,0 +1,99 @@ | |||
1 | What: /sys/class/ata_... | ||
2 | Date: August 2008 | ||
3 | Contact: Gwendal Grignou<gwendal@google.com> | ||
4 | Description: | ||
5 | |||
6 | Provide a place in sysfs for storing the ATA topology of the system. This allows | ||
7 | retrieving various information about ATA objects. | ||
8 | |||
9 | Files under /sys/class/ata_port | ||
10 | ------------------------------- | ||
11 | |||
12 | For each port, a directory ataX is created where X is the ata_port_id of | ||
13 | the port. The device parent is the ata host device. | ||
14 | |||
15 | idle_irq (read) | ||
16 | |||
17 | Number of IRQ received by the port while idle [some ata HBA only]. | ||
18 | |||
19 | nr_pmp_links (read) | ||
20 | |||
21 | If a SATA Port Multiplier (PM) is connected, number of link behind it. | ||
22 | |||
23 | Files under /sys/class/ata_link | ||
24 | ------------------------------- | ||
25 | |||
26 | Behind each port, there is a ata_link. If there is a SATA PM in the | ||
27 | topology, 15 ata_link objects are created. | ||
28 | |||
29 | If a link is behind a port, the directory name is linkX, where X is | ||
30 | ata_port_id of the port. | ||
31 | If a link is behind a PM, its name is linkX.Y where X is ata_port_id | ||
32 | of the parent port and Y the PM port. | ||
33 | |||
34 | hw_sata_spd_limit | ||
35 | |||
36 | Maximum speed supported by the connected SATA device. | ||
37 | |||
38 | sata_spd_limit | ||
39 | |||
40 | Maximum speed imposed by libata. | ||
41 | |||
42 | sata_spd | ||
43 | |||
44 | Current speed of the link [1.5, 3Gps,...]. | ||
45 | |||
46 | Files under /sys/class/ata_device | ||
47 | --------------------------------- | ||
48 | |||
49 | Behind each link, up to two ata device are created. | ||
50 | The name of the directory is devX[.Y].Z where: | ||
51 | - X is ata_port_id of the port where the device is connected, | ||
52 | - Y the port of the PM if any, and | ||
53 | - Z the device id: for PATA, there is usually 2 devices [0,1], | ||
54 | only 1 for SATA. | ||
55 | |||
56 | class | ||
57 | Device class. Can be "ata" for disk, "atapi" for packet device, | ||
58 | "pmp" for PM, or "none" if no device was found behind the link. | ||
59 | |||
60 | dma_mode | ||
61 | |||
62 | Transfer modes supported by the device when in DMA mode. | ||
63 | Mostly used by PATA device. | ||
64 | |||
65 | pio_mode | ||
66 | |||
67 | Transfer modes supported by the device when in PIO mode. | ||
68 | Mostly used by PATA device. | ||
69 | |||
70 | xfer_mode | ||
71 | |||
72 | Current transfer mode. | ||
73 | |||
74 | id | ||
75 | |||
76 | Cached result of IDENTIFY command, as described in ATA8 7.16 and 7.17. | ||
77 | Only valid if the device is not a PM. | ||
78 | |||
79 | gscr | ||
80 | |||
81 | Cached result of the dump of PM GSCR register. | ||
82 | Valid registers are: | ||
83 | 0: SATA_PMP_GSCR_PROD_ID, | ||
84 | 1: SATA_PMP_GSCR_REV, | ||
85 | 2: SATA_PMP_GSCR_PORT_INFO, | ||
86 | 32: SATA_PMP_GSCR_ERROR, | ||
87 | 33: SATA_PMP_GSCR_ERROR_EN, | ||
88 | 64: SATA_PMP_GSCR_FEAT, | ||
89 | 96: SATA_PMP_GSCR_FEAT_EN, | ||
90 | 130: SATA_PMP_GSCR_SII_GPIO | ||
91 | Only valid if the device is a PM. | ||
92 | |||
93 | spdn_cnt | ||
94 | |||
95 | Number of time libata decided to lower the speed of link due to errors. | ||
96 | |||
97 | ering | ||
98 | |||
99 | Formatted output of the error ring of the device. | ||
diff --git a/Documentation/ABI/testing/sysfs-devices-power b/Documentation/ABI/testing/sysfs-devices-power index 6123c523bfd7..7628cd1bc36a 100644 --- a/Documentation/ABI/testing/sysfs-devices-power +++ b/Documentation/ABI/testing/sysfs-devices-power | |||
@@ -77,3 +77,91 @@ Description: | |||
77 | devices this attribute is set to "enabled" by bus type code or | 77 | devices this attribute is set to "enabled" by bus type code or |
78 | device drivers and in that cases it should be safe to leave the | 78 | device drivers and in that cases it should be safe to leave the |
79 | default value. | 79 | default value. |
80 | |||
81 | What: /sys/devices/.../power/wakeup_count | ||
82 | Date: September 2010 | ||
83 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | ||
84 | Description: | ||
85 | The /sys/devices/.../wakeup_count attribute contains the number | ||
86 | of signaled wakeup events associated with the device. This | ||
87 | attribute is read-only. If the device is not enabled to wake up | ||
88 | the system from sleep states, this attribute is empty. | ||
89 | |||
90 | What: /sys/devices/.../power/wakeup_active_count | ||
91 | Date: September 2010 | ||
92 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | ||
93 | Description: | ||
94 | The /sys/devices/.../wakeup_active_count attribute contains the | ||
95 | number of times the processing of wakeup events associated with | ||
96 | the device was completed (at the kernel level). This attribute | ||
97 | is read-only. If the device is not enabled to wake up the | ||
98 | system from sleep states, this attribute is empty. | ||
99 | |||
100 | What: /sys/devices/.../power/wakeup_hit_count | ||
101 | Date: September 2010 | ||
102 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | ||
103 | Description: | ||
104 | The /sys/devices/.../wakeup_hit_count attribute contains the | ||
105 | number of times the processing of a wakeup event associated with | ||
106 | the device might prevent the system from entering a sleep state. | ||
107 | This attribute is read-only. If the device is not enabled to | ||
108 | wake up the system from sleep states, this attribute is empty. | ||
109 | |||
110 | What: /sys/devices/.../power/wakeup_active | ||
111 | Date: September 2010 | ||
112 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | ||
113 | Description: | ||
114 | The /sys/devices/.../wakeup_active attribute contains either 1, | ||
115 | or 0, depending on whether or not a wakeup event associated with | ||
116 | the device is being processed (1). This attribute is read-only. | ||
117 | If the device is not enabled to wake up the system from sleep | ||
118 | states, this attribute is empty. | ||
119 | |||
120 | What: /sys/devices/.../power/wakeup_total_time_ms | ||
121 | Date: September 2010 | ||
122 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | ||
123 | Description: | ||
124 | The /sys/devices/.../wakeup_total_time_ms attribute contains | ||
125 | the total time of processing wakeup events associated with the | ||
126 | device, in milliseconds. This attribute is read-only. If the | ||
127 | device is not enabled to wake up the system from sleep states, | ||
128 | this attribute is empty. | ||
129 | |||
130 | What: /sys/devices/.../power/wakeup_max_time_ms | ||
131 | Date: September 2010 | ||
132 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | ||
133 | Description: | ||
134 | The /sys/devices/.../wakeup_max_time_ms attribute contains | ||
135 | the maximum time of processing a single wakeup event associated | ||
136 | with the device, in milliseconds. This attribute is read-only. | ||
137 | If the device is not enabled to wake up the system from sleep | ||
138 | states, this attribute is empty. | ||
139 | |||
140 | What: /sys/devices/.../power/wakeup_last_time_ms | ||
141 | Date: September 2010 | ||
142 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | ||
143 | Description: | ||
144 | The /sys/devices/.../wakeup_last_time_ms attribute contains | ||
145 | the value of the monotonic clock corresponding to the time of | ||
146 | signaling the last wakeup event associated with the device, in | ||
147 | milliseconds. This attribute is read-only. If the device is | ||
148 | not enabled to wake up the system from sleep states, this | ||
149 | attribute is empty. | ||
150 | |||
151 | What: /sys/devices/.../power/autosuspend_delay_ms | ||
152 | Date: September 2010 | ||
153 | Contact: Alan Stern <stern@rowland.harvard.edu> | ||
154 | Description: | ||
155 | The /sys/devices/.../power/autosuspend_delay_ms attribute | ||
156 | contains the autosuspend delay value (in milliseconds). Some | ||
157 | drivers do not want their device to suspend as soon as it | ||
158 | becomes idle at run time; they want the device to remain | ||
159 | inactive for a certain minimum period of time first. That | ||
160 | period is called the autosuspend delay. Negative values will | ||
161 | prevent the device from being suspended at run time (similar | ||
162 | to writing "on" to the power/control attribute). Values >= | ||
163 | 1000 will cause the autosuspend timer expiration to be rounded | ||
164 | up to the nearest second. | ||
165 | |||
166 | Not all drivers support this attribute. If it isn't supported, | ||
167 | attempts to read or write it will yield I/O errors. | ||
diff --git a/Documentation/ABI/testing/sysfs-driver-hid-roccat-pyra b/Documentation/ABI/testing/sysfs-driver-hid-roccat-pyra new file mode 100644 index 000000000000..ad1125b02ff4 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-driver-hid-roccat-pyra | |||
@@ -0,0 +1,98 @@ | |||
1 | What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/actual_cpi | ||
2 | Date: August 2010 | ||
3 | Contact: Stefan Achatz <erazor_de@users.sourceforge.net> | ||
4 | Description: It is possible to switch the cpi setting of the mouse with the | ||
5 | press of a button. | ||
6 | When read, this file returns the raw number of the actual cpi | ||
7 | setting reported by the mouse. This number has to be further | ||
8 | processed to receive the real dpi value. | ||
9 | |||
10 | VALUE DPI | ||
11 | 1 400 | ||
12 | 2 800 | ||
13 | 4 1600 | ||
14 | |||
15 | This file is readonly. | ||
16 | |||
17 | What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/actual_profile | ||
18 | Date: August 2010 | ||
19 | Contact: Stefan Achatz <erazor_de@users.sourceforge.net> | ||
20 | Description: When read, this file returns the number of the actual profile in | ||
21 | range 0-4. | ||
22 | This file is readonly. | ||
23 | |||
24 | What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/firmware_version | ||
25 | Date: August 2010 | ||
26 | Contact: Stefan Achatz <erazor_de@users.sourceforge.net> | ||
27 | Description: When read, this file returns the raw integer version number of the | ||
28 | firmware reported by the mouse. Using the integer value eases | ||
29 | further usage in other programs. To receive the real version | ||
30 | number the decimal point has to be shifted 2 positions to the | ||
31 | left. E.g. a returned value of 138 means 1.38 | ||
32 | This file is readonly. | ||
33 | |||
34 | What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/profile_settings | ||
35 | Date: August 2010 | ||
36 | Contact: Stefan Achatz <erazor_de@users.sourceforge.net> | ||
37 | Description: The mouse can store 5 profiles which can be switched by the | ||
38 | press of a button. A profile is split in settings and buttons. | ||
39 | profile_settings holds informations like resolution, sensitivity | ||
40 | and light effects. | ||
41 | When written, this file lets one write the respective profile | ||
42 | settings back to the mouse. The data has to be 13 bytes long. | ||
43 | The mouse will reject invalid data. | ||
44 | Which profile to write is determined by the profile number | ||
45 | contained in the data. | ||
46 | This file is writeonly. | ||
47 | |||
48 | What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/profile[1-5]_settings | ||
49 | Date: August 2010 | ||
50 | Contact: Stefan Achatz <erazor_de@users.sourceforge.net> | ||
51 | Description: The mouse can store 5 profiles which can be switched by the | ||
52 | press of a button. A profile is split in settings and buttons. | ||
53 | profile_settings holds informations like resolution, sensitivity | ||
54 | and light effects. | ||
55 | When read, these files return the respective profile settings. | ||
56 | The returned data is 13 bytes in size. | ||
57 | This file is readonly. | ||
58 | |||
59 | What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/profile_buttons | ||
60 | Date: August 2010 | ||
61 | Contact: Stefan Achatz <erazor_de@users.sourceforge.net> | ||
62 | Description: The mouse can store 5 profiles which can be switched by the | ||
63 | press of a button. A profile is split in settings and buttons. | ||
64 | profile_buttons holds informations about button layout. | ||
65 | When written, this file lets one write the respective profile | ||
66 | buttons back to the mouse. The data has to be 19 bytes long. | ||
67 | The mouse will reject invalid data. | ||
68 | Which profile to write is determined by the profile number | ||
69 | contained in the data. | ||
70 | This file is writeonly. | ||
71 | |||
72 | What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/profile[1-5]_buttons | ||
73 | Date: August 2010 | ||
74 | Contact: Stefan Achatz <erazor_de@users.sourceforge.net> | ||
75 | Description: The mouse can store 5 profiles which can be switched by the | ||
76 | press of a button. A profile is split in settings and buttons. | ||
77 | profile_buttons holds informations about button layout. | ||
78 | When read, these files return the respective profile buttons. | ||
79 | The returned data is 19 bytes in size. | ||
80 | This file is readonly. | ||
81 | |||
82 | What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/startup_profile | ||
83 | Date: August 2010 | ||
84 | Contact: Stefan Achatz <erazor_de@users.sourceforge.net> | ||
85 | Description: The integer value of this attribute ranges from 0-4. | ||
86 | When read, this attribute returns the number of the profile | ||
87 | that's active when the mouse is powered on. | ||
88 | This file is readonly. | ||
89 | |||
90 | What: /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/settings | ||
91 | Date: August 2010 | ||
92 | Contact: Stefan Achatz <erazor_de@users.sourceforge.net> | ||
93 | Description: When read, this file returns the settings stored in the mouse. | ||
94 | The size of the data is 3 bytes and holds information on the | ||
95 | startup_profile. | ||
96 | When written, this file lets write settings back to the mouse. | ||
97 | The data has to be 3 bytes long. The mouse will reject invalid | ||
98 | data. | ||
diff --git a/Documentation/ABI/testing/sysfs-module b/Documentation/ABI/testing/sysfs-module new file mode 100644 index 000000000000..cfcec3bffc0a --- /dev/null +++ b/Documentation/ABI/testing/sysfs-module | |||
@@ -0,0 +1,12 @@ | |||
1 | What: /sys/module/pch_phub/drivers/.../pch_mac | ||
2 | Date: August 2010 | ||
3 | KernelVersion: 2.6.35 | ||
4 | Contact: masa-korg@dsn.okisemi.com | ||
5 | Description: Write/read GbE MAC address. | ||
6 | |||
7 | What: /sys/module/pch_phub/drivers/.../pch_firmware | ||
8 | Date: August 2010 | ||
9 | KernelVersion: 2.6.35 | ||
10 | Contact: masa-korg@dsn.okisemi.com | ||
11 | Description: Write/read Option ROM data. | ||
12 | |||
diff --git a/Documentation/ABI/testing/sysfs-power b/Documentation/ABI/testing/sysfs-power index 2875f1f74a07..194ca446ac28 100644 --- a/Documentation/ABI/testing/sysfs-power +++ b/Documentation/ABI/testing/sysfs-power | |||
@@ -99,9 +99,38 @@ Description: | |||
99 | 99 | ||
100 | dmesg -s 1000000 | grep 'hash matches' | 100 | dmesg -s 1000000 | grep 'hash matches' |
101 | 101 | ||
102 | If you do not get any matches (or they appear to be false | ||
103 | positives), it is possible that the last PM event point | ||
104 | referred to a device created by a loadable kernel module. In | ||
105 | this case cat /sys/power/pm_trace_dev_match (see below) after | ||
106 | your system is started up and the kernel modules are loaded. | ||
107 | |||
102 | CAUTION: Using it will cause your machine's real-time (CMOS) | 108 | CAUTION: Using it will cause your machine's real-time (CMOS) |
103 | clock to be set to a random invalid time after a resume. | 109 | clock to be set to a random invalid time after a resume. |
104 | 110 | ||
111 | What; /sys/power/pm_trace_dev_match | ||
112 | Date: October 2010 | ||
113 | Contact: James Hogan <james@albanarts.com> | ||
114 | Description: | ||
115 | The /sys/power/pm_trace_dev_match file contains the name of the | ||
116 | device associated with the last PM event point saved in the RTC | ||
117 | across reboots when pm_trace has been used. More precisely it | ||
118 | contains the list of current devices (including those | ||
119 | registered by loadable kernel modules since boot) which match | ||
120 | the device hash in the RTC at boot, with a newline after each | ||
121 | one. | ||
122 | |||
123 | The advantage of this file over the hash matches printed to the | ||
124 | kernel log (see /sys/power/pm_trace), is that it includes | ||
125 | devices created after boot by loadable kernel modules. | ||
126 | |||
127 | Due to the small hash size necessary to fit in the RTC, it is | ||
128 | possible that more than one device matches the hash, in which | ||
129 | case further investigation is required to determine which | ||
130 | device is causing the problem. Note that genuine RTC clock | ||
131 | values (such as when pm_trace has not been used), can still | ||
132 | match a device and output it's name here. | ||
133 | |||
105 | What: /sys/power/pm_async | 134 | What: /sys/power/pm_async |
106 | Date: January 2009 | 135 | Date: January 2009 |
107 | Contact: Rafael J. Wysocki <rjw@sisk.pl> | 136 | Contact: Rafael J. Wysocki <rjw@sisk.pl> |