blob: e5cc7633d0131db82951d489b311195967db2db8 [file] [log] [blame]
David Vrabelc8cf2462008-09-17 16:34:41 +01001What: /sys/bus/usb/device/.../authorized
2Date: July 2008
3KernelVersion: 2.6.26
4Contact: David Vrabel <david.vrabel@csr.com>
5Description:
6 Authorized devices are available for use by device
7 drivers, non-authorized one are not. By default, wired
8 USB devices are authorized.
9
10 Certified Wireless USB devices are not authorized
11 initially and should be (by writing 1) after the
12 device has been authenticated.
13
14What: /sys/bus/usb/device/.../wusb_cdid
15Date: July 2008
16KernelVersion: 2.6.27
17Contact: David Vrabel <david.vrabel@csr.com>
18Description:
19 For Certified Wireless USB devices only.
20
21 A devices's CDID, as 16 space-separated hex octets.
22
23What: /sys/bus/usb/device/.../wusb_ck
24Date: July 2008
25KernelVersion: 2.6.27
26Contact: David Vrabel <david.vrabel@csr.com>
27Description:
28 For Certified Wireless USB devices only.
29
30 Write the device's connection key (CK) to start the
31 authentication of the device. The CK is 16
32 space-separated hex octets.
33
34What: /sys/bus/usb/device/.../wusb_disconnect
35Date: July 2008
36KernelVersion: 2.6.27
37Contact: David Vrabel <david.vrabel@csr.com>
38Description:
39 For Certified Wireless USB devices only.
40
41 Write a 1 to force the device to disconnect
42 (equivalent to unplugging a wired USB device).
CHENG Renquan0c7a2b72009-11-22 01:28:52 +080043
Josua Dietzeff231db2011-10-23 14:22:29 +020044What: /sys/bus/usb/drivers/.../new_id
45Date: October 2011
46Contact: linux-usb@vger.kernel.org
47Description:
48 Writing a device ID to this file will attempt to
49 dynamically add a new device ID to a USB device driver.
50 This may allow the driver to support more hardware than
51 was included in the driver's static device ID support
52 table at compile time. The format for the device ID is:
Wolfram Sang2fc82c22014-01-10 19:36:42 +010053 idVendor idProduct bInterfaceClass RefIdVendor RefIdProduct
Josua Dietzeff231db2011-10-23 14:22:29 +020054 The vendor ID and device ID fields are required, the
Wolfram Sang2fc82c22014-01-10 19:36:42 +010055 rest is optional. The Ref* tuple can be used to tell the
56 driver to use the same driver_data for the new device as
57 it is used for the reference device.
Josua Dietzeff231db2011-10-23 14:22:29 +020058 Upon successfully adding an ID, the driver will probe
59 for the device and attempt to bind to it. For example:
60 # echo "8086 10f5" > /sys/bus/usb/drivers/foo/new_id
61
Wolfram Sang2fc82c22014-01-10 19:36:42 +010062 Here add a new device (0458:7045) using driver_data from
63 an already supported device (0458:704c):
64 # echo "0458 7045 0 0458 704c" > /sys/bus/usb/drivers/foo/new_id
65
Bjørn Morke6bbcef2012-05-13 12:34:59 +020066 Reading from this file will list all dynamically added
67 device IDs in the same format, with one entry per
68 line. For example:
69 # cat /sys/bus/usb/drivers/foo/new_id
70 8086 10f5
71 dead beef 06
72 f00d cafe
73
74 The list will be truncated at PAGE_SIZE bytes due to
75 sysfs restrictions.
76
Josua Dietzeff231db2011-10-23 14:22:29 +020077What: /sys/bus/usb-serial/drivers/.../new_id
78Date: October 2011
79Contact: linux-usb@vger.kernel.org
80Description:
81 For serial USB drivers, this attribute appears under the
82 extra bus folder "usb-serial" in sysfs; apart from that
83 difference, all descriptions from the entry
84 "/sys/bus/usb/drivers/.../new_id" apply.
85
CHENG Renquan0c7a2b72009-11-22 01:28:52 +080086What: /sys/bus/usb/drivers/.../remove_id
87Date: November 2009
88Contact: CHENG Renquan <rqcheng@smu.edu.sg>
89Description:
90 Writing a device ID to this file will remove an ID
91 that was dynamically added via the new_id sysfs entry.
92 The format for the device ID is:
93 idVendor idProduct. After successfully
94 removing an ID, the driver will no longer support the
95 device. This is useful to ensure auto probing won't
96 match the driver to the device. For example:
97 # echo "046d c315" > /sys/bus/usb/drivers/foo/remove_id
Oliver Neukumef955342010-01-16 01:33:03 +010098
Bjørn Morke6bbcef2012-05-13 12:34:59 +020099 Reading from this file will list the dynamically added
100 device IDs, exactly like reading from the entry
101 "/sys/bus/usb/drivers/.../new_id"
102
Andiry Xuc1045e82011-09-23 14:19:53 -0700103What: /sys/bus/usb/devices/.../power/usb2_hardware_lpm
104Date: September 2011
105Contact: Andiry Xu <andiry.xu@amd.com>
106Description:
Rafael J. Wysockiceb6c9c2014-11-29 23:47:05 +0100107 If CONFIG_PM is set and a USB 2.0 lpm-capable device is plugged
108 in to a xHCI host which support link PM, it will perform a LPM
109 test; if the test is passed and host supports USB2 hardware LPM
110 (xHCI 1.0 feature), USB2 hardware LPM will be enabled for the
111 device and the USB device directory will contain a file named
112 power/usb2_hardware_lpm. The file holds a string value (enable
113 or disable) indicating whether or not USB2 hardware LPM is
114 enabled for the device. Developer can write y/Y/1 or n/N/0 to
115 the file to enable/disable the feature.
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500116
117What: /sys/bus/usb/devices/.../removable
118Date: February 2012
119Contact: Matthew Garrett <mjg@redhat.com>
120Description:
121 Some information about whether a given USB device is
122 physically fixed to the platform can be inferred from a
Masanari Iidac94bed8e2012-04-10 00:22:13 +0900123 combination of hub descriptor bits and platform-specific data
Matthew Garrett0846e7e2012-02-03 17:11:54 -0500124 such as ACPI. This file will read either "removable" or
125 "fixed" if the information is available, and "unknown"
Masanari Iidac94bed8e2012-04-10 00:22:13 +0900126 otherwise.
Sarah Sharp024f1172012-07-05 17:17:24 -0700127
128What: /sys/bus/usb/devices/.../ltm_capable
129Date: July 2012
130Contact: Sarah Sharp <sarah.a.sharp@linux.intel.com>
131Description:
132 USB 3.0 devices may optionally support Latency Tolerance
133 Messaging (LTM). They indicate their support by setting a bit
134 in the bmAttributes field of their SuperSpeed BOS descriptors.
135 If that bit is set for the device, ltm_capable will read "yes".
136 If the device doesn't support LTM, the file will read "no".
137 The file will be present for all speeds of USB devices, and will
138 always read "no" for USB 1.1 and USB 2.0 devices.
Lan Tianyufa2a9562012-09-05 13:44:31 +0800139
140What: /sys/bus/usb/devices/.../(hub interface)/portX
141Date: August 2012
142Contact: Lan Tianyu <tianyu.lan@intel.com>
143Description:
144 The /sys/bus/usb/devices/.../(hub interface)/portX
145 is usb port device's sysfs directory.
Lan Tianyucef74682013-01-20 01:53:32 +0800146
147What: /sys/bus/usb/devices/.../(hub interface)/portX/connect_type
148Date: January 2013
149Contact: Lan Tianyu <tianyu.lan@intel.com>
150Description:
151 Some platforms provide usb port connect types through ACPI.
152 This attribute is to expose these information to user space.
153 The file will read "hotplug", "wired" and "not used" if the
154 information is available, and "unknown" otherwise.
Mathias Nyman17f34862013-05-23 17:14:31 +0300155
156What: /sys/bus/usb/devices/.../power/usb2_lpm_l1_timeout
157Date: May 2013
158Contact: Mathias Nyman <mathias.nyman@linux.intel.com>
159Description:
160 USB 2.0 devices may support hardware link power management (LPM)
161 L1 sleep state. The usb2_lpm_l1_timeout attribute allows
162 tuning the timeout for L1 inactivity timer (LPM timer), e.g.
163 needed inactivity time before host requests the device to go to L1 sleep.
164 Useful for power management tuning.
165 Supported values are 0 - 65535 microseconds.
166
167What: /sys/bus/usb/devices/.../power/usb2_lpm_besl
168Date: May 2013
169Contact: Mathias Nyman <mathias.nyman@linux.intel.com>
170Description:
171 USB 2.0 devices that support hardware link power management (LPM)
172 L1 sleep state now use a best effort service latency value (BESL) to
173 indicate the best effort to resumption of service to the device after the
174 initiation of the resume event.
175 If the device does not have a preferred besl value then the host can select
176 one instead. This usb2_lpm_besl attribute allows to tune the host selected besl
177 value in order to tune power saving and service latency.
178
179 Supported values are 0 - 15.
180 More information on how besl values map to microseconds can be found in
181 USB 2.0 ECN Errata for Link Power Management, section 4.10)