1 What: /sys/bus/thunderbolt/devices/. !! 1 What: /sys/bus/thunderbolt/devices/.../domainX/boot_acl
2 Date: Jun 2018 2 Date: Jun 2018
3 KernelVersion: 4.17 3 KernelVersion: 4.17
4 Contact: Mika Westerberg <mika.westerber !! 4 Contact: thunderbolt-software@lists.01.org
5 Description: Holds a comma separated list o 5 Description: Holds a comma separated list of device unique_ids that
6 are allowed to be connected au 6 are allowed to be connected automatically during system
7 startup (e.g boot devices). Th 7 startup (e.g boot devices). The list always contains
8 maximum supported number of un 8 maximum supported number of unique_ids where unused
9 entries are empty. This allows 9 entries are empty. This allows the userspace software
10 to determine how many entries 10 to determine how many entries the controller supports.
11 If there are multiple controll 11 If there are multiple controllers, each controller has
12 its own ACL list and size may 12 its own ACL list and size may be different between the
13 controllers. 13 controllers.
14 14
15 System BIOS may have an option 15 System BIOS may have an option "Preboot ACL" or similar
16 that needs to be selected befo 16 that needs to be selected before this list is taken into
17 consideration. 17 consideration.
18 18
19 Software always updates a full 19 Software always updates a full list in each write.
20 20
21 If a device is authorized auto 21 If a device is authorized automatically during boot its
22 boot attribute is set to 1. 22 boot attribute is set to 1.
23 23
24 What: /sys/bus/thunderbolt/devices/. !! 24 What: /sys/bus/thunderbolt/devices/.../domainX/security
25 Date: May 2021 <<
26 KernelVersion: 5.12 <<
27 Contact: Mika Westerberg <mika.westerber <<
28 Description: This attribute tells whether t <<
29 de-authorization of devices. V <<
30 de-authorize PCIe tunnel by wr <<
31 attribute under each device. <<
32 <<
33 What: /sys/bus/thunderbolt/devices/. <<
34 Date: Mar 2019 <<
35 KernelVersion: 4.21 <<
36 Contact: Mika Westerberg <mika.westerber <<
37 Description: This attribute tells whether t <<
38 for DMA protection. Value of 1 <<
39 it is not (DMA protection is s <<
40 security levels). <<
41 <<
42 What: /sys/bus/thunderbolt/devices/. <<
43 Date: Sep 2017 25 Date: Sep 2017
44 KernelVersion: 4.13 26 KernelVersion: 4.13
45 Contact: Mika Westerberg <mika.westerber !! 27 Contact: thunderbolt-software@lists.01.org
46 Description: This attribute holds current T 28 Description: This attribute holds current Thunderbolt security level
47 set by the system BIOS. Possib 29 set by the system BIOS. Possible values are:
48 30
49 ======= ===================== !! 31 none: All devices are automatically authorized
50 none All devices are autom !! 32 user: Devices are only authorized based on writing
51 user Devices are only auth !! 33 appropriate value to the authorized attribute
52 appropriate value to !! 34 secure: Require devices that support secure connect at
53 secure Require devices that !! 35 minimum. User needs to authorize each device.
54 minimum. User needs t !! 36 dponly: Automatically tunnel Display port (and USB). No
55 dponly Automatically tunnel !! 37 PCIe tunnels are created.
56 PCIe tunnels are crea !! 38 usbonly: Automatically tunnel USB controller of the
57 usbonly Automatically tunnel <<
58 connected Thunderbolt 39 connected Thunderbolt dock (and Display Port). All
59 PCIe links downstream 40 PCIe links downstream of the dock are removed.
60 nopcie USB4 system where PCI <<
61 the BIOS. <<
62 ======= ===================== <<
63 41
64 What: /sys/bus/thunderbolt/devices/. !! 42 What: /sys/bus/thunderbolt/devices/.../authorized
65 Date: Sep 2017 43 Date: Sep 2017
66 KernelVersion: 4.13 44 KernelVersion: 4.13
67 Contact: Mika Westerberg <mika.westerber !! 45 Contact: thunderbolt-software@lists.01.org
68 Description: This attribute is used to auth 46 Description: This attribute is used to authorize Thunderbolt devices
69 after they have been connected 47 after they have been connected. If the device is not
70 authorized, no PCIe devices ar !! 48 authorized, no devices such as PCIe and Display port are
>> 49 available to the system.
71 50
72 Contents of this attribute wil 51 Contents of this attribute will be 0 when the device is not
73 yet authorized. 52 yet authorized.
74 53
75 Possible values are supported: 54 Possible values are supported:
76 !! 55 1: The device will be authorized and connected
77 == ========================== <<
78 0 The device will be de-auth <<
79 deauthorization attribute <<
80 1 The device will be authori <<
81 == ========================== <<
82 56
83 When key attribute contains 32 57 When key attribute contains 32 byte hex string the possible
84 values are: 58 values are:
>> 59 1: The 32 byte hex string is added to the device NVM and
>> 60 the device is authorized.
>> 61 2: Send a challenge based on the 32 byte hex string. If the
>> 62 challenge response from device is valid, the device is
>> 63 authorized. In case of failure errno will be ENOKEY if
>> 64 the device did not contain a key at all, and
>> 65 EKEYREJECTED if the challenge response did not match.
85 66
86 == ========================== !! 67 What: /sys/bus/thunderbolt/devices/.../boot
87 0 The device will be de-auth <<
88 deauthorization attribute <<
89 1 The 32 byte hex string is <<
90 the device is authorized. <<
91 2 Send a challenge based on <<
92 challenge response from de <<
93 authorized. In case of fai <<
94 the device did not contain <<
95 EKEYREJECTED if the challe <<
96 == ========================== <<
97 <<
98 What: /sys/bus/thunderbolt/devices/. <<
99 Date: Jun 2018 68 Date: Jun 2018
100 KernelVersion: 4.17 69 KernelVersion: 4.17
101 Contact: Mika Westerberg <mika.westerber !! 70 Contact: thunderbolt-software@lists.01.org
102 Description: This attribute contains 1 if T 71 Description: This attribute contains 1 if Thunderbolt device was already
103 authorized on boot and 0 other 72 authorized on boot and 0 otherwise.
104 73
105 What: /sys/bus/thunderbolt/devices/. !! 74 What: /sys/bus/thunderbolt/devices/.../key
106 Date: Jan 2020 <<
107 KernelVersion: 5.5 <<
108 Contact: Christian Kellner <christian@ke <<
109 Description: This attribute contains the ge <<
110 controller associated with the <<
111 for USB4. <<
112 <<
113 What: /sys/bus/thunderbolt/devices/. <<
114 Date: Sep 2017 75 Date: Sep 2017
115 KernelVersion: 4.13 76 KernelVersion: 4.13
116 Contact: Mika Westerberg <mika.westerber !! 77 Contact: thunderbolt-software@lists.01.org
117 Description: When a devices supports Thunde 78 Description: When a devices supports Thunderbolt secure connect it will
118 have this attribute. Writing 3 79 have this attribute. Writing 32 byte hex string changes
119 authorization to use the secur 80 authorization to use the secure connection method instead.
120 Writing an empty string clears 81 Writing an empty string clears the key and regular connection
121 method can be used again. 82 method can be used again.
122 83
123 What: /sys/bus/thunderbolt/devices/. 84 What: /sys/bus/thunderbolt/devices/.../device
124 Date: Sep 2017 85 Date: Sep 2017
125 KernelVersion: 4.13 86 KernelVersion: 4.13
126 Contact: Mika Westerberg <mika.westerber !! 87 Contact: thunderbolt-software@lists.01.org
127 Description: This attribute contains id of 88 Description: This attribute contains id of this device extracted from
128 the device DROM. 89 the device DROM.
129 90
130 What: /sys/bus/thunderbolt/devices/. 91 What: /sys/bus/thunderbolt/devices/.../device_name
131 Date: Sep 2017 92 Date: Sep 2017
132 KernelVersion: 4.13 93 KernelVersion: 4.13
133 Contact: Mika Westerberg <mika.westerber !! 94 Contact: thunderbolt-software@lists.01.org
134 Description: This attribute contains name o 95 Description: This attribute contains name of this device extracted from
135 the device DROM. 96 the device DROM.
136 97
137 What: /sys/bus/thunderbolt/devices/. <<
138 Date: Jul 2021 <<
139 KernelVersion: 5.13 <<
140 Contact: Mika Westerberg <mika.westerber <<
141 Description: Only set for XDomains. The max <<
142 supports as its input HopID. <<
143 <<
144 What: /sys/bus/thunderbolt/devices/. <<
145 Date: Jan 2020 <<
146 KernelVersion: 5.5 <<
147 Contact: Mika Westerberg <mika.westerber <<
148 Description: This attribute reports the dev <<
149 All RX lanes run at the same s <<
150 <<
151 What: /sys/bus/thunderbolt/devices/. <<
152 Date: Jan 2020 <<
153 KernelVersion: 5.5 <<
154 Contact: Mika Westerberg <mika.westerber <<
155 Description: This attribute reports number <<
156 using simultaneously through i <<
157 <<
158 What: /sys/bus/thunderbolt/devices/. <<
159 Date: Jan 2020 <<
160 KernelVersion: 5.5 <<
161 Contact: Mika Westerberg <mika.westerber <<
162 Description: This attribute reports the TX <<
163 All TX lanes run at the same s <<
164 <<
165 What: /sys/bus/thunderbolt/devices/. <<
166 Date: Jan 2020 <<
167 KernelVersion: 5.5 <<
168 Contact: Mika Westerberg <mika.westerber <<
169 Description: This attribute reports number <<
170 using simultaneously through i <<
171 <<
172 What: /sys/bus/thunderbolt/devices/. 98 What: /sys/bus/thunderbolt/devices/.../vendor
173 Date: Sep 2017 99 Date: Sep 2017
174 KernelVersion: 4.13 100 KernelVersion: 4.13
175 Contact: Mika Westerberg <mika.westerber !! 101 Contact: thunderbolt-software@lists.01.org
176 Description: This attribute contains vendor 102 Description: This attribute contains vendor id of this device extracted
177 from the device DROM. 103 from the device DROM.
178 104
179 What: /sys/bus/thunderbolt/devices/. 105 What: /sys/bus/thunderbolt/devices/.../vendor_name
180 Date: Sep 2017 106 Date: Sep 2017
181 KernelVersion: 4.13 107 KernelVersion: 4.13
182 Contact: Mika Westerberg <mika.westerber !! 108 Contact: thunderbolt-software@lists.01.org
183 Description: This attribute contains vendor 109 Description: This attribute contains vendor name of this device extracted
184 from the device DROM. 110 from the device DROM.
185 111
186 What: /sys/bus/thunderbolt/devices/. 112 What: /sys/bus/thunderbolt/devices/.../unique_id
187 Date: Sep 2017 113 Date: Sep 2017
188 KernelVersion: 4.13 114 KernelVersion: 4.13
189 Contact: Mika Westerberg <mika.westerber !! 115 Contact: thunderbolt-software@lists.01.org
190 Description: This attribute contains unique 116 Description: This attribute contains unique_id string of this device.
191 This is either read from hardw 117 This is either read from hardware registers (UUID on
192 newer hardware) or based on UI 118 newer hardware) or based on UID from the device DROM.
193 Can be used to uniquely identi 119 Can be used to uniquely identify particular device.
194 120
195 What: /sys/bus/thunderbolt/devices/. 121 What: /sys/bus/thunderbolt/devices/.../nvm_version
196 Date: Sep 2017 122 Date: Sep 2017
197 KernelVersion: 4.13 123 KernelVersion: 4.13
198 Contact: Mika Westerberg <mika.westerber !! 124 Contact: thunderbolt-software@lists.01.org
199 Description: If the device has upgradeable 125 Description: If the device has upgradeable firmware the version
200 number is available here. Form 126 number is available here. Format: %x.%x, major.minor.
201 If the device is in safe mode 127 If the device is in safe mode reading the file returns
202 -ENODATA instead as the NVM ve 128 -ENODATA instead as the NVM version is not available.
203 129
204 What: /sys/bus/thunderbolt/devices/. 130 What: /sys/bus/thunderbolt/devices/.../nvm_authenticate
205 Date: Sep 2017 131 Date: Sep 2017
206 KernelVersion: 4.13 132 KernelVersion: 4.13
207 Contact: Mika Westerberg <mika.westerber !! 133 Contact: thunderbolt-software@lists.01.org
208 Description: When new NVM image is written 134 Description: When new NVM image is written to the non-active NVM
209 area (through non_activeX NVMe 135 area (through non_activeX NVMem device), the
210 authentication procedure is st !! 136 authentication procedure is started by writing 1 to
211 this file. !! 137 this file. If everything goes well, the device is
212 If everything goes well, the d <<
213 restarted with the new NVM fir 138 restarted with the new NVM firmware. If the image
214 verification fails an error co 139 verification fails an error code is returned instead.
215 140
216 This file will accept writing <<
217 <<
218 - Writing "1" will flush the i <<
219 area and authenticate the im <<
220 - Writing "2" will run some ba <<
221 and flush it to the storage <<
222 - Writing "3" will authenticat <<
223 currently written in the sto <<
224 supported with USB4 devices <<
225 <<
226 When read holds status of the 141 When read holds status of the last authentication
227 operation if an error occurred 142 operation if an error occurred during the process. This
228 is directly the status value f 143 is directly the status value from the DMA configuration
229 based mailbox before the devic 144 based mailbox before the device is power cycled. Writing
230 0 here clears the status. 145 0 here clears the status.
231 146
232 What: /sys/bus/thunderbolt/devices/. <<
233 Date: Oct 2020 <<
234 KernelVersion: v5.9 <<
235 Contact: Mario Limonciello <mario.limonc <<
236 Description: For supported devices, automat <<
237 image when the device is disco <<
238 <<
239 This file will accept writing <<
240 <<
241 - Writing "1" will flush the i <<
242 area and prepare the device <<
243 - Writing "2" will run some ba <<
244 and flush it to the storage <<
245 <<
246 What: /sys/bus/thunderbolt/devices/< 147 What: /sys/bus/thunderbolt/devices/<xdomain>.<service>/key
247 Date: Jan 2018 148 Date: Jan 2018
248 KernelVersion: 4.15 149 KernelVersion: 4.15
249 Contact: Mika Westerberg <mika.westerber !! 150 Contact: thunderbolt-software@lists.01.org
250 Description: This contains name of the prop 151 Description: This contains name of the property directory the XDomain
251 service exposes. This entry de 152 service exposes. This entry describes the protocol in
252 question. Following directorie 153 question. Following directories are already reserved by
253 the Apple XDomain specificatio 154 the Apple XDomain specification:
254 155
255 ======== ==================== !! 156 network: IP/ethernet over Thunderbolt
256 network IP/ethernet over Thu !! 157 targetdm: Target disk mode protocol over Thunderbolt
257 targetdm Target disk mode pro !! 158 extdisp: External display mode protocol over Thunderbolt
258 extdisp External display mod <<
259 ======== ==================== <<
260 159
261 What: /sys/bus/thunderbolt/devices/< 160 What: /sys/bus/thunderbolt/devices/<xdomain>.<service>/modalias
262 Date: Jan 2018 161 Date: Jan 2018
263 KernelVersion: 4.15 162 KernelVersion: 4.15
264 Contact: Mika Westerberg <mika.westerber !! 163 Contact: thunderbolt-software@lists.01.org
265 Description: Stores the same MODALIAS value 164 Description: Stores the same MODALIAS value emitted by uevent for
266 the XDomain service. Format: t 165 the XDomain service. Format: tbtsvc:kSpNvNrN
267 166
268 What: /sys/bus/thunderbolt/devices/< 167 What: /sys/bus/thunderbolt/devices/<xdomain>.<service>/prtcid
269 Date: Jan 2018 168 Date: Jan 2018
270 KernelVersion: 4.15 169 KernelVersion: 4.15
271 Contact: Mika Westerberg <mika.westerber !! 170 Contact: thunderbolt-software@lists.01.org
272 Description: This contains XDomain protocol 171 Description: This contains XDomain protocol identifier the XDomain
273 service supports. 172 service supports.
274 173
275 What: /sys/bus/thunderbolt/devices/< 174 What: /sys/bus/thunderbolt/devices/<xdomain>.<service>/prtcvers
276 Date: Jan 2018 175 Date: Jan 2018
277 KernelVersion: 4.15 176 KernelVersion: 4.15
278 Contact: Mika Westerberg <mika.westerber !! 177 Contact: thunderbolt-software@lists.01.org
279 Description: This contains XDomain protocol 178 Description: This contains XDomain protocol version the XDomain
280 service supports. 179 service supports.
281 180
282 What: /sys/bus/thunderbolt/devices/< 181 What: /sys/bus/thunderbolt/devices/<xdomain>.<service>/prtcrevs
283 Date: Jan 2018 182 Date: Jan 2018
284 KernelVersion: 4.15 183 KernelVersion: 4.15
285 Contact: Mika Westerberg <mika.westerber !! 184 Contact: thunderbolt-software@lists.01.org
286 Description: This contains XDomain software 185 Description: This contains XDomain software version the XDomain
287 service supports. 186 service supports.
288 187
289 What: /sys/bus/thunderbolt/devices/< 188 What: /sys/bus/thunderbolt/devices/<xdomain>.<service>/prtcstns
290 Date: Jan 2018 189 Date: Jan 2018
291 KernelVersion: 4.15 190 KernelVersion: 4.15
292 Contact: Mika Westerberg <mika.westerber !! 191 Contact: thunderbolt-software@lists.01.org
293 Description: This contains XDomain service 192 Description: This contains XDomain service specific settings as
294 bitmask. Format: %x 193 bitmask. Format: %x
295 <<
296 What: /sys/bus/thunderbolt/devices/u <<
297 Date: April 2022 <<
298 Contact: Heikki Krogerus <heikki.krogeru <<
299 Description: <<
300 Symlink to the USB Type-C conn <<
301 created when USB Type-C Connec <<
302 and only if the system firmwar <<
303 describing the connection betw <<
304 connector. <<
305 <<
306 What: /sys/bus/thunderbolt/devices/u <<
307 Date: Sep 2021 <<
308 KernelVersion: v5.14 <<
309 Contact: Mika Westerberg <mika.westerber <<
310 Description: Returns the current link mode. <<
311 "usb4", "tbt" and "none". <<
312 <<
313 What: /sys/bus/thunderbolt/devices/u <<
314 Date: Sep 2021 <<
315 KernelVersion: v5.14 <<
316 Contact: Rajmohan Mani <rajmohan.mani@in <<
317 Description: Writing 1 to this attribute pu <<
318 offline mode. Only allowed whe <<
319 connected to the port (link at <<
320 Once the port is in offline mo <<
321 hotplug events. This is used t <<
322 on-board retimers. Writing 0 p <<
323 online mode. <<
324 <<
325 This attribute is only visible <<
326 powering on retimers when ther <<
327 <<
328 What: /sys/bus/thunderbolt/devices/u <<
329 Date: Sep 2021 <<
330 KernelVersion: v5.14 <<
331 Contact: Rajmohan Mani <rajmohan.mani@in <<
332 Description: When the USB4 port is in offli <<
333 attribute forces rescan of the <<
334 retimers. Each retimer appear <<
335 the USB4 link was up. These re <<
336 as if the cable was connected <<
337 firmware can be done the usual <<
338 <<
339 What: /sys/bus/thunderbolt/devices/< <<
340 Date: Oct 2020 <<
341 KernelVersion: v5.9 <<
342 Contact: Mika Westerberg <mika.westerber <<
343 Description: Retimer device identifier read <<
344 <<
345 What: /sys/bus/thunderbolt/devices/< <<
346 Date: Oct 2020 <<
347 KernelVersion: v5.9 <<
348 Contact: Mika Westerberg <mika.westerber <<
349 Description: When new NVM image is written <<
350 area (through non_activeX NVMe <<
351 authentication procedure is st <<
352 this file. If everything goes <<
353 restarted with the new NVM fir <<
354 verification fails an error co <<
355 <<
356 When read holds status of the <<
357 operation if an error occurred <<
358 Format: %x. <<
359 <<
360 What: /sys/bus/thunderbolt/devices/< <<
361 Date: Oct 2020 <<
362 KernelVersion: v5.9 <<
363 Contact: Mika Westerberg <mika.westerber <<
364 Description: Holds retimer NVM version numb <<
365 <<
366 What: /sys/bus/thunderbolt/devices/< <<
367 Date: Oct 2020 <<
368 KernelVersion: v5.9 <<
369 Contact: Mika Westerberg <mika.westerber <<
370 Description: Retimer vendor identifier read <<
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.