diff options
author | Hans de Goede <hdegoede@redhat.com> | 2013-08-30 05:00:21 -0400 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2013-08-30 14:13:26 -0400 |
commit | 1f77fdf7866ae6228f583ba8e8376c2a6a032cc4 (patch) | |
tree | 766875d98079aff0ca67177bc5fb089883121ae6 /Documentation/ABI | |
parent | 9d8924297cd9c256c23c02abae40202563452453 (diff) |
Documentation sysfs-bus-usb: Move files with known users to stable
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/ABI')
-rw-r--r-- | Documentation/ABI/stable/sysfs-bus-usb | 126 | ||||
-rw-r--r-- | Documentation/ABI/testing/sysfs-bus-usb | 127 |
2 files changed, 126 insertions, 127 deletions
diff --git a/Documentation/ABI/stable/sysfs-bus-usb b/Documentation/ABI/stable/sysfs-bus-usb new file mode 100644 index 000000000000..6b59aeaee75e --- /dev/null +++ b/Documentation/ABI/stable/sysfs-bus-usb | |||
@@ -0,0 +1,126 @@ | |||
1 | What: /sys/bus/usb/devices/.../power/persist | ||
2 | Date: May 2007 | ||
3 | KernelVersion: 2.6.23 | ||
4 | Contact: Alan Stern <stern@rowland.harvard.edu> | ||
5 | Description: | ||
6 | If CONFIG_USB_PERSIST is set, then each USB device directory | ||
7 | will contain a file named power/persist. The file holds a | ||
8 | boolean value (0 or 1) indicating whether or not the | ||
9 | "USB-Persist" facility is enabled for the device. Since the | ||
10 | facility is inherently dangerous, it is disabled by default | ||
11 | for all devices except hubs. For more information, see | ||
12 | Documentation/usb/persist.txt. | ||
13 | |||
14 | What: /sys/bus/usb/devices/.../power/autosuspend | ||
15 | Date: March 2007 | ||
16 | KernelVersion: 2.6.21 | ||
17 | Contact: Alan Stern <stern@rowland.harvard.edu> | ||
18 | Description: | ||
19 | Each USB device directory will contain a file named | ||
20 | power/autosuspend. This file holds the time (in seconds) | ||
21 | the device must be idle before it will be autosuspended. | ||
22 | 0 means the device will be autosuspended as soon as | ||
23 | possible. Negative values will prevent the device from | ||
24 | being autosuspended at all, and writing a negative value | ||
25 | will resume the device if it is already suspended. | ||
26 | |||
27 | The autosuspend delay for newly-created devices is set to | ||
28 | the value of the usbcore.autosuspend module parameter. | ||
29 | |||
30 | What: /sys/bus/usb/device/.../power/connected_duration | ||
31 | Date: January 2008 | ||
32 | KernelVersion: 2.6.25 | ||
33 | Contact: Sarah Sharp <sarah.a.sharp@intel.com> | ||
34 | Description: | ||
35 | If CONFIG_PM_RUNTIME is enabled then this file | ||
36 | is present. When read, it returns the total time (in msec) | ||
37 | that the USB device has been connected to the machine. This | ||
38 | file is read-only. | ||
39 | Users: | ||
40 | PowerTOP <power@bughost.org> | ||
41 | http://www.lesswatts.org/projects/powertop/ | ||
42 | |||
43 | What: /sys/bus/usb/device/.../power/active_duration | ||
44 | Date: January 2008 | ||
45 | KernelVersion: 2.6.25 | ||
46 | Contact: Sarah Sharp <sarah.a.sharp@intel.com> | ||
47 | Description: | ||
48 | If CONFIG_PM_RUNTIME is enabled then this file | ||
49 | is present. When read, it returns the total time (in msec) | ||
50 | that the USB device has been active, i.e. not in a suspended | ||
51 | state. This file is read-only. | ||
52 | |||
53 | Tools can use this file and the connected_duration file to | ||
54 | compute the percentage of time that a device has been active. | ||
55 | For example, | ||
56 | echo $((100 * `cat active_duration` / `cat connected_duration`)) | ||
57 | will give an integer percentage. Note that this does not | ||
58 | account for counter wrap. | ||
59 | Users: | ||
60 | PowerTOP <power@bughost.org> | ||
61 | http://www.lesswatts.org/projects/powertop/ | ||
62 | |||
63 | What: /sys/bus/usb/devices/<busnum>-<port[.port]>...:<config num>-<interface num>/supports_autosuspend | ||
64 | Date: January 2008 | ||
65 | KernelVersion: 2.6.27 | ||
66 | Contact: Sarah Sharp <sarah.a.sharp@intel.com> | ||
67 | Description: | ||
68 | When read, this file returns 1 if the interface driver | ||
69 | for this interface supports autosuspend. It also | ||
70 | returns 1 if no driver has claimed this interface, as an | ||
71 | unclaimed interface will not stop the device from being | ||
72 | autosuspended if all other interface drivers are idle. | ||
73 | The file returns 0 if autosuspend support has not been | ||
74 | added to the driver. | ||
75 | Users: | ||
76 | USB PM tool | ||
77 | git://git.moblin.org/users/sarah/usb-pm-tool/ | ||
78 | |||
79 | What: /sys/bus/usb/device/.../avoid_reset_quirk | ||
80 | Date: December 2009 | ||
81 | Contact: Oliver Neukum <oliver@neukum.org> | ||
82 | Description: | ||
83 | Writing 1 to this file tells the kernel that this | ||
84 | device will morph into another mode when it is reset. | ||
85 | Drivers will not use reset for error handling for | ||
86 | such devices. | ||
87 | Users: | ||
88 | usb_modeswitch | ||
89 | |||
90 | What: /sys/bus/usb/devices/.../devnum | ||
91 | KernelVersion: since at least 2.6.18 | ||
92 | Description: | ||
93 | Device address on the USB bus. | ||
94 | |||
95 | What: /sys/bus/usb/devices/.../bConfigurationValue | ||
96 | KernelVersion: since at least 2.6.18 | ||
97 | Description: | ||
98 | bConfigurationValue of the *active* configuration for the | ||
99 | device. Writing 0 or -1 to bConfigurationValue will reset the | ||
100 | active configuration (unconfigure the device). Writing | ||
101 | another value will change the active configuration. | ||
102 | |||
103 | Note that some devices, in violation of the USB spec, have a | ||
104 | configuration with a value equal to 0. Writing 0 to | ||
105 | bConfigurationValue for these devices will install that | ||
106 | configuration, rather then unconfigure the device. | ||
107 | |||
108 | Writing -1 will always unconfigure the device. | ||
109 | |||
110 | What: /sys/bus/usb/devices/.../busnum | ||
111 | KernelVersion: 2.6.22 | ||
112 | Description: | ||
113 | Bus-number of the USB-bus the device is connected to. | ||
114 | |||
115 | What: /sys/bus/usb/devices/.../descriptors | ||
116 | KernelVersion: 2.6.26 | ||
117 | Description: | ||
118 | Binary file containing cached descriptors of the device. The | ||
119 | binary data consists of the device descriptor followed by the | ||
120 | descriptors for each configuration of the device. | ||
121 | Note that the wTotalLength of the config descriptors can not | ||
122 | be trusted, as the device may have a smaller config descriptor | ||
123 | than it advertises. The bLength field of each (sub) descriptor | ||
124 | can be trusted, and can be used to seek forward one (sub) | ||
125 | descriptor at a time until the next config descriptor is found. | ||
126 | All descriptors read from this file are in bus-endian format | ||
diff --git a/Documentation/ABI/testing/sysfs-bus-usb b/Documentation/ABI/testing/sysfs-bus-usb index 0053ae262a0a..1430f584b266 100644 --- a/Documentation/ABI/testing/sysfs-bus-usb +++ b/Documentation/ABI/testing/sysfs-bus-usb | |||
@@ -1,81 +1,3 @@ | |||
1 | What: /sys/bus/usb/devices/.../power/autosuspend | ||
2 | Date: March 2007 | ||
3 | KernelVersion: 2.6.21 | ||
4 | Contact: Alan Stern <stern@rowland.harvard.edu> | ||
5 | Description: | ||
6 | Each USB device directory will contain a file named | ||
7 | power/autosuspend. This file holds the time (in seconds) | ||
8 | the device must be idle before it will be autosuspended. | ||
9 | 0 means the device will be autosuspended as soon as | ||
10 | possible. Negative values will prevent the device from | ||
11 | being autosuspended at all, and writing a negative value | ||
12 | will resume the device if it is already suspended. | ||
13 | |||
14 | The autosuspend delay for newly-created devices is set to | ||
15 | the value of the usbcore.autosuspend module parameter. | ||
16 | |||
17 | What: /sys/bus/usb/devices/.../power/persist | ||
18 | Date: May 2007 | ||
19 | KernelVersion: 2.6.23 | ||
20 | Contact: Alan Stern <stern@rowland.harvard.edu> | ||
21 | Description: | ||
22 | If CONFIG_USB_PERSIST is set, then each USB device directory | ||
23 | will contain a file named power/persist. The file holds a | ||
24 | boolean value (0 or 1) indicating whether or not the | ||
25 | "USB-Persist" facility is enabled for the device. Since the | ||
26 | facility is inherently dangerous, it is disabled by default | ||
27 | for all devices except hubs. For more information, see | ||
28 | Documentation/usb/persist.txt. | ||
29 | |||
30 | What: /sys/bus/usb/device/.../power/connected_duration | ||
31 | Date: January 2008 | ||
32 | KernelVersion: 2.6.25 | ||
33 | Contact: Sarah Sharp <sarah.a.sharp@intel.com> | ||
34 | Description: | ||
35 | If CONFIG_PM_RUNTIME is enabled then this file | ||
36 | is present. When read, it returns the total time (in msec) | ||
37 | that the USB device has been connected to the machine. This | ||
38 | file is read-only. | ||
39 | Users: | ||
40 | PowerTOP <power@bughost.org> | ||
41 | http://www.lesswatts.org/projects/powertop/ | ||
42 | |||
43 | What: /sys/bus/usb/device/.../power/active_duration | ||
44 | Date: January 2008 | ||
45 | KernelVersion: 2.6.25 | ||
46 | Contact: Sarah Sharp <sarah.a.sharp@intel.com> | ||
47 | Description: | ||
48 | If CONFIG_PM_RUNTIME is enabled then this file | ||
49 | is present. When read, it returns the total time (in msec) | ||
50 | that the USB device has been active, i.e. not in a suspended | ||
51 | state. This file is read-only. | ||
52 | |||
53 | Tools can use this file and the connected_duration file to | ||
54 | compute the percentage of time that a device has been active. | ||
55 | For example, | ||
56 | echo $((100 * `cat active_duration` / `cat connected_duration`)) | ||
57 | will give an integer percentage. Note that this does not | ||
58 | account for counter wrap. | ||
59 | Users: | ||
60 | PowerTOP <power@bughost.org> | ||
61 | http://www.lesswatts.org/projects/powertop/ | ||
62 | |||
63 | What: /sys/bus/usb/devices/<busnum>-<port[.port]>...:<config num>-<interface num>/supports_autosuspend | ||
64 | Date: January 2008 | ||
65 | KernelVersion: 2.6.27 | ||
66 | Contact: Sarah Sharp <sarah.a.sharp@intel.com> | ||
67 | Description: | ||
68 | When read, this file returns 1 if the interface driver | ||
69 | for this interface supports autosuspend. It also | ||
70 | returns 1 if no driver has claimed this interface, as an | ||
71 | unclaimed interface will not stop the device from being | ||
72 | autosuspended if all other interface drivers are idle. | ||
73 | The file returns 0 if autosuspend support has not been | ||
74 | added to the driver. | ||
75 | Users: | ||
76 | USB PM tool | ||
77 | git://git.moblin.org/users/sarah/usb-pm-tool/ | ||
78 | |||
79 | What: /sys/bus/usb/device/.../authorized | 1 | What: /sys/bus/usb/device/.../authorized |
80 | Date: July 2008 | 2 | Date: July 2008 |
81 | KernelVersion: 2.6.26 | 3 | KernelVersion: 2.6.26 |
@@ -172,17 +94,6 @@ Description: | |||
172 | device IDs, exactly like reading from the entry | 94 | device IDs, exactly like reading from the entry |
173 | "/sys/bus/usb/drivers/.../new_id" | 95 | "/sys/bus/usb/drivers/.../new_id" |
174 | 96 | ||
175 | What: /sys/bus/usb/device/.../avoid_reset_quirk | ||
176 | Date: December 2009 | ||
177 | Contact: Oliver Neukum <oliver@neukum.org> | ||
178 | Description: | ||
179 | Writing 1 to this file tells the kernel that this | ||
180 | device will morph into another mode when it is reset. | ||
181 | Drivers will not use reset for error handling for | ||
182 | such devices. | ||
183 | Users: | ||
184 | usb_modeswitch | ||
185 | |||
186 | What: /sys/bus/usb/devices/.../power/usb2_hardware_lpm | 97 | What: /sys/bus/usb/devices/.../power/usb2_hardware_lpm |
187 | Date: September 2011 | 98 | Date: September 2011 |
188 | Contact: Andiry Xu <andiry.xu@amd.com> | 99 | Contact: Andiry Xu <andiry.xu@amd.com> |
@@ -263,41 +174,3 @@ Description: | |||
263 | Supported values are 0 - 15. | 174 | Supported values are 0 - 15. |
264 | More information on how besl values map to microseconds can be found in | 175 | More information on how besl values map to microseconds can be found in |
265 | USB 2.0 ECN Errata for Link Power Management, section 4.10) | 176 | USB 2.0 ECN Errata for Link Power Management, section 4.10) |
266 | |||
267 | What: /sys/bus/usb/devices/.../devnum | ||
268 | KernelVersion: since at least 2.6.18 | ||
269 | Description: | ||
270 | Device address on the USB bus. | ||
271 | |||
272 | What: /sys/bus/usb/devices/.../bConfigurationValue | ||
273 | KernelVersion: since at least 2.6.18 | ||
274 | Description: | ||
275 | bConfigurationValue of the *active* configuration for the | ||
276 | device. Writing 0 or -1 to bConfigurationValue will reset the | ||
277 | active configuration (unconfigure the device). Writing | ||
278 | another value will change the active configuration. | ||
279 | |||
280 | Note that some devices, in violation of the USB spec, have a | ||
281 | configuration with a value equal to 0. Writing 0 to | ||
282 | bConfigurationValue for these devices will install that | ||
283 | configuration, rather then unconfigure the device. | ||
284 | |||
285 | Writing -1 will always unconfigure the device. | ||
286 | |||
287 | What: /sys/bus/usb/devices/.../busnum | ||
288 | KernelVersion: 2.6.22 | ||
289 | Description: | ||
290 | Bus-number of the USB-bus the device is connected to. | ||
291 | |||
292 | What: /sys/bus/usb/devices/.../descriptors | ||
293 | KernelVersion: 2.6.26 | ||
294 | Description: | ||
295 | Binary file containing cached descriptors of the device. The | ||
296 | binary data consists of the device descriptor followed by the | ||
297 | descriptors for each configuration of the device. | ||
298 | Note that the wTotalLength of the config descriptors can not | ||
299 | be trusted, as the device may have a smaller config descriptor | ||
300 | than it advertises. The bLength field of each (sub) descriptor | ||
301 | can be trusted, and can be used to seek forward one (sub) | ||
302 | descriptor at a time until the next config descriptor is found. | ||
303 | All descriptors read from this file are in bus-endian format | ||