blob: 3a4abfc44f5e0d8a9e358626c1ca8251d756003d [file] [log] [blame]
Stefan Koch7f59c152015-08-25 21:10:10 +02001What: /sys/bus/usb/devices/INTERFACE/authorized
2Date: August 2015
3Description:
4 This allows to authorize (1) or deauthorize (0)
5 individual interfaces instead a whole device
6 in contrast to the device authorization.
7 If a deauthorized interface will be authorized
8 so the driver probing must be triggered manually
9 by writing INTERFACE to /sys/bus/usb/drivers_probe
10 This allows to avoid side-effects with drivers
11 that need multiple interfaces.
12 A deauthorized interface cannot be probed or claimed.
13
14What: /sys/bus/usb/devices/usbX/interface_authorized_default
15Date: August 2015
16Description:
17 This is used as value that determines if interfaces
18 would be authorized by default.
19 The value can be 1 or 0. It's by default 1.
20
David Vrabelc8cf2462008-09-17 16:34:41 +010021What: /sys/bus/usb/device/.../authorized
22Date: July 2008
23KernelVersion: 2.6.26
24Contact: David Vrabel <david.vrabel@csr.com>
25Description:
26 Authorized devices are available for use by device
27 drivers, non-authorized one are not. By default, wired
28 USB devices are authorized.
29
30 Certified Wireless USB devices are not authorized
31 initially and should be (by writing 1) after the
32 device has been authenticated.
33
34What: /sys/bus/usb/device/.../wusb_cdid
35Date: July 2008
36KernelVersion: 2.6.27
37Contact: David Vrabel <david.vrabel@csr.com>
38Description:
39 For Certified Wireless USB devices only.
40
41 A devices's CDID, as 16 space-separated hex octets.
42
43What: /sys/bus/usb/device/.../wusb_ck
44Date: July 2008
45KernelVersion: 2.6.27
46Contact: David Vrabel <david.vrabel@csr.com>
47Description:
48 For Certified Wireless USB devices only.
49
50 Write the device's connection key (CK) to start the
51 authentication of the device. The CK is 16
52 space-separated hex octets.
53
54What: /sys/bus/usb/device/.../wusb_disconnect
55Date: July 2008
56KernelVersion: 2.6.27
57Contact: David Vrabel <david.vrabel@csr.com>
58Description:
59 For Certified Wireless USB devices only.
60
61 Write a 1 to force the device to disconnect
62 (equivalent to unplugging a wired USB device).
CHENG Renquan0c7a2b72009-11-22 01:28:52 +080063
Josua Dietzeff231db2011-10-23 14:22:29 +020064What: /sys/bus/usb/drivers/.../new_id
65Date: October 2011
66Contact: linux-usb@vger.kernel.org
67Description:
68 Writing a device ID to this file will attempt to
69 dynamically add a new device ID to a USB device driver.
70 This may allow the driver to support more hardware than
71 was included in the driver's static device ID support
72 table at compile time. The format for the device ID is:
Wolfram Sang2fc82c22014-01-10 19:36:42 +010073 idVendor idProduct bInterfaceClass RefIdVendor RefIdProduct
Josua Dietzeff231db2011-10-23 14:22:29 +020074 The vendor ID and device ID fields are required, the
Wolfram Sang2fc82c22014-01-10 19:36:42 +010075 rest is optional. The Ref* tuple can be used to tell the
76 driver to use the same driver_data for the new device as
77 it is used for the reference device.
Josua Dietzeff231db2011-10-23 14:22:29 +020078 Upon successfully adding an ID, the driver will probe
79 for the device and attempt to bind to it. For example:
80 # echo "8086 10f5" > /sys/bus/usb/drivers/foo/new_id
81
Wolfram Sang2fc82c22014-01-10 19:36:42 +010082 Here add a new device (0458:7045) using driver_data from
83 an already supported device (0458:704c):
84 # echo "0458 7045 0 0458 704c" > /sys/bus/usb/drivers/foo/new_id
85
Bjørn Morke6bbcef2012-05-13 12:34:59 +020086 Reading from this file will list all dynamically added
87 device IDs in the same format, with one entry per
88 line. For example:
89 # cat /sys/bus/usb/drivers/foo/new_id
90 8086 10f5
91 dead beef 06
92 f00d cafe
93
94 The list will be truncated at PAGE_SIZE bytes due to
95 sysfs restrictions.
96
Josua Dietzeff231db2011-10-23 14:22:29 +020097What: /sys/bus/usb-serial/drivers/.../new_id
98Date: October 2011
99Contact: linux-usb@vger.kernel.org
100Description:
101 For serial USB drivers, this attribute appears under the
102 extra bus folder "usb-serial" in sysfs; apart from that
103 difference, all descriptions from the entry
104 "/sys/bus/usb/drivers/.../new_id" apply.
105
CHENG Renquan0c7a2b72009-11-22 01:28:52 +0800106What: /sys/bus/usb/drivers/.../remove_id
107Date: November 2009
108Contact: CHENG Renquan <rqcheng@smu.edu.sg>
109Description:
110 Writing a device ID to this file will remove an ID
111 that was dynamically added via the new_id sysfs entry.
112 The format for the device ID is:
113 idVendor idProduct. After successfully
114 removing an ID, the driver will no longer support the
115 device. This is useful to ensure auto probing won't
116 match the driver to the device. For example:
117 # echo "046d c315" > /sys/bus/usb/drivers/foo/remove_id
Oliver Neukumef955342010-01-16 01:33:03 +0100118
Bjørn Morke6bbcef2012-05-13 12:34:59 +0200119 Reading from this file will list the dynamically added
120 device IDs, exactly like reading from the entry
121 "/sys/bus/usb/drivers/.../new_id"
122
Andiry Xuc1045e82011-09-23 14:19:53 -0700123What: /sys/bus/usb/devices/.../power/usb2_hardware_lpm
124Date: September 2011
125Contact: Andiry Xu <andiry.xu@amd.com>
126Description:
Rafael J. Wysockiceb6c9c2014-11-29 23:47:05 +0100127 If CONFIG_PM is set and a USB 2.0 lpm-capable device is plugged
128 in to a xHCI host which support link PM, it will perform a LPM
129 test; if the test is passed and host supports USB2 hardware LPM
130 (xHCI 1.0 feature), USB2 hardware LPM will be enabled for the
131 device and the USB device directory will contain a file named
132 power/usb2_hardware_lpm. The file holds a string value (enable
133 or disable) indicating whether or not USB2 hardware LPM is
134 enabled for the device. Developer can write y/Y/1 or n/N/0 to
135 the file to enable/disable the feature.
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500136
Kevin Strasser655fe4e2015-06-16 10:35:30 -0700137What: /sys/bus/usb/devices/.../power/usb3_hardware_lpm
138Date: June 2015
139Contact: Kevin Strasser <kevin.strasser@linux.intel.com>
140Description:
Valentin Rothberga2e66ad2015-07-29 09:08:53 +0200141 If CONFIG_PM is set and a USB 3.0 lpm-capable device is plugged
142 in to a xHCI host which supports link PM, it will check if U1
143 and U2 exit latencies have been set in the BOS descriptor; if
144 the check is is passed and the host supports USB3 hardware LPM,
145 USB3 hardware LPM will be enabled for the device and the USB
146 device directory will contain a file named
Kevin Strasser655fe4e2015-06-16 10:35:30 -0700147 power/usb3_hardware_lpm. The file holds a string value (enable
148 or disable) indicating whether or not USB3 hardware LPM is
149 enabled for the device.
150
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500151What: /sys/bus/usb/devices/.../removable
152Date: February 2012
153Contact: Matthew Garrett <mjg@redhat.com>
154Description:
155 Some information about whether a given USB device is
156 physically fixed to the platform can be inferred from a
Masanari Iidac94bed8e2012-04-10 00:22:13 +0900157 combination of hub descriptor bits and platform-specific data
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500158 such as ACPI. This file will read either "removable" or
159 "fixed" if the information is available, and "unknown"
Masanari Iidac94bed8e2012-04-10 00:22:13 +0900160 otherwise.
Sarah Sharp024f1172012-07-05 17:17:24 -0700161
162What: /sys/bus/usb/devices/.../ltm_capable
163Date: July 2012
164Contact: Sarah Sharp <sarah.a.sharp@linux.intel.com>
165Description:
166 USB 3.0 devices may optionally support Latency Tolerance
167 Messaging (LTM). They indicate their support by setting a bit
168 in the bmAttributes field of their SuperSpeed BOS descriptors.
169 If that bit is set for the device, ltm_capable will read "yes".
170 If the device doesn't support LTM, the file will read "no".
171 The file will be present for all speeds of USB devices, and will
172 always read "no" for USB 1.1 and USB 2.0 devices.
Lan Tianyufa2a9562012-09-05 13:44:31 +0800173
174What: /sys/bus/usb/devices/.../(hub interface)/portX
175Date: August 2012
176Contact: Lan Tianyu <tianyu.lan@intel.com>
177Description:
178 The /sys/bus/usb/devices/.../(hub interface)/portX
179 is usb port device's sysfs directory.
Lan Tianyucef74682013-01-20 01:53:32 +0800180
181What: /sys/bus/usb/devices/.../(hub interface)/portX/connect_type
182Date: January 2013
183Contact: Lan Tianyu <tianyu.lan@intel.com>
184Description:
185 Some platforms provide usb port connect types through ACPI.
186 This attribute is to expose these information to user space.
187 The file will read "hotplug", "wired" and "not used" if the
188 information is available, and "unknown" otherwise.
Mathias Nyman17f34862013-05-23 17:14:31 +0300189
190What: /sys/bus/usb/devices/.../power/usb2_lpm_l1_timeout
191Date: May 2013
192Contact: Mathias Nyman <mathias.nyman@linux.intel.com>
193Description:
194 USB 2.0 devices may support hardware link power management (LPM)
195 L1 sleep state. The usb2_lpm_l1_timeout attribute allows
196 tuning the timeout for L1 inactivity timer (LPM timer), e.g.
197 needed inactivity time before host requests the device to go to L1 sleep.
198 Useful for power management tuning.
199 Supported values are 0 - 65535 microseconds.
200
201What: /sys/bus/usb/devices/.../power/usb2_lpm_besl
202Date: May 2013
203Contact: Mathias Nyman <mathias.nyman@linux.intel.com>
204Description:
205 USB 2.0 devices that support hardware link power management (LPM)
206 L1 sleep state now use a best effort service latency value (BESL) to
207 indicate the best effort to resumption of service to the device after the
208 initiation of the resume event.
209 If the device does not have a preferred besl value then the host can select
210 one instead. This usb2_lpm_besl attribute allows to tune the host selected besl
211 value in order to tune power saving and service latency.
212
213 Supported values are 0 - 15.
214 More information on how besl values map to microseconds can be found in
215 USB 2.0 ECN Errata for Link Power Management, section 4.10)