xref: /linux/Documentation/ABI/testing/sysfs-bus-thunderbolt (revision 9aaa3b8b4c56d24210acef37b7c800ca218c3d40)
1*9aaa3b8bSMika WesterbergWhat: /sys/bus/thunderbolt/devices/.../domainX/boot_acl
2*9aaa3b8bSMika WesterbergDate:		Jun 2018
3*9aaa3b8bSMika WesterbergKernelVersion:	4.17
4*9aaa3b8bSMika WesterbergContact:	thunderbolt-software@lists.01.org
5*9aaa3b8bSMika WesterbergDescription:	Holds a comma separated list of device unique_ids that
6*9aaa3b8bSMika Westerberg		are allowed to be connected automatically during system
7*9aaa3b8bSMika Westerberg		startup (e.g boot devices). The list always contains
8*9aaa3b8bSMika Westerberg		maximum supported number of unique_ids where unused
9*9aaa3b8bSMika Westerberg		entries are empty. This allows the userspace software
10*9aaa3b8bSMika Westerberg		to determine how many entries the controller supports.
11*9aaa3b8bSMika Westerberg		If there are multiple controllers, each controller has
12*9aaa3b8bSMika Westerberg		its own ACL list and size may be different between the
13*9aaa3b8bSMika Westerberg		controllers.
14*9aaa3b8bSMika Westerberg
15*9aaa3b8bSMika Westerberg		System BIOS may have an option "Preboot ACL" or similar
16*9aaa3b8bSMika Westerberg		that needs to be selected before this list is taken into
17*9aaa3b8bSMika Westerberg		consideration.
18*9aaa3b8bSMika Westerberg
19*9aaa3b8bSMika Westerberg		Software always updates a full list in each write.
20*9aaa3b8bSMika Westerberg
21*9aaa3b8bSMika Westerberg		If a device is authorized automatically during boot its
22*9aaa3b8bSMika Westerberg		boot attribute is set to 1.
23*9aaa3b8bSMika Westerberg
24f67cf491SMika WesterbergWhat: /sys/bus/thunderbolt/devices/.../domainX/security
25f67cf491SMika WesterbergDate:		Sep 2017
26f67cf491SMika WesterbergKernelVersion:	4.13
27f67cf491SMika WesterbergContact:	thunderbolt-software@lists.01.org
28f67cf491SMika WesterbergDescription:	This attribute holds current Thunderbolt security level
29f67cf491SMika Westerberg		set by the system BIOS. Possible values are:
30f67cf491SMika Westerberg
31f67cf491SMika Westerberg		none: All devices are automatically authorized
32f67cf491SMika Westerberg		user: Devices are only authorized based on writing
33f67cf491SMika Westerberg		      appropriate value to the authorized attribute
34f67cf491SMika Westerberg		secure: Require devices that support secure connect at
35f67cf491SMika Westerberg			minimum. User needs to authorize each device.
36f67cf491SMika Westerberg		dponly: Automatically tunnel Display port (and USB). No
37f67cf491SMika Westerberg			PCIe tunnels are created.
38f67cf491SMika Westerberg
39f67cf491SMika WesterbergWhat: /sys/bus/thunderbolt/devices/.../authorized
40f67cf491SMika WesterbergDate:		Sep 2017
41f67cf491SMika WesterbergKernelVersion:	4.13
42f67cf491SMika WesterbergContact:	thunderbolt-software@lists.01.org
43f67cf491SMika WesterbergDescription:	This attribute is used to authorize Thunderbolt devices
44f67cf491SMika Westerberg		after they have been connected. If the device is not
45f67cf491SMika Westerberg		authorized, no devices such as PCIe and Display port are
46f67cf491SMika Westerberg		available to the system.
47f67cf491SMika Westerberg
48f67cf491SMika Westerberg		Contents of this attribute will be 0 when the device is not
49f67cf491SMika Westerberg		yet authorized.
50f67cf491SMika Westerberg
51f67cf491SMika Westerberg		Possible values are supported:
52f67cf491SMika Westerberg		1: The device will be authorized and connected
53f67cf491SMika Westerberg
54f67cf491SMika Westerberg		When key attribute contains 32 byte hex string the possible
55f67cf491SMika Westerberg		values are:
56f67cf491SMika Westerberg		1: The 32 byte hex string is added to the device NVM and
57f67cf491SMika Westerberg		   the device is authorized.
58f67cf491SMika Westerberg		2: Send a challenge based on the 32 byte hex string. If the
59f67cf491SMika Westerberg		   challenge response from device is valid, the device is
60f67cf491SMika Westerberg		   authorized. In case of failure errno will be ENOKEY if
61f67cf491SMika Westerberg		   the device did not contain a key at all, and
62f67cf491SMika Westerberg		   EKEYREJECTED if the challenge response did not match.
63f67cf491SMika Westerberg
6414862ee3SYehezkel BernatWhat: /sys/bus/thunderbolt/devices/.../boot
6514862ee3SYehezkel BernatDate:		Jun 2018
6614862ee3SYehezkel BernatKernelVersion:	4.17
6714862ee3SYehezkel BernatContact:	thunderbolt-software@lists.01.org
6814862ee3SYehezkel BernatDescription:	This attribute contains 1 if Thunderbolt device was already
6914862ee3SYehezkel Bernat		authorized on boot and 0 otherwise.
7014862ee3SYehezkel Bernat
71f67cf491SMika WesterbergWhat: /sys/bus/thunderbolt/devices/.../key
72f67cf491SMika WesterbergDate:		Sep 2017
73f67cf491SMika WesterbergKernelVersion:	4.13
74f67cf491SMika WesterbergContact:	thunderbolt-software@lists.01.org
75f67cf491SMika WesterbergDescription:	When a devices supports Thunderbolt secure connect it will
76f67cf491SMika Westerberg		have this attribute. Writing 32 byte hex string changes
77f67cf491SMika Westerberg		authorization to use the secure connection method instead.
78e545f0d8SBernat, Yehezkel		Writing an empty string clears the key and regular connection
79e545f0d8SBernat, Yehezkel		method can be used again.
80f67cf491SMika Westerberg
81bfe778acSMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../device
82bfe778acSMika WesterbergDate:		Sep 2017
83bfe778acSMika WesterbergKernelVersion:	4.13
84bfe778acSMika WesterbergContact:	thunderbolt-software@lists.01.org
85bfe778acSMika WesterbergDescription:	This attribute contains id of this device extracted from
86bfe778acSMika Westerberg		the device DROM.
87bfe778acSMika Westerberg
8872ee3390SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../device_name
8972ee3390SMika WesterbergDate:		Sep 2017
9072ee3390SMika WesterbergKernelVersion:	4.13
9172ee3390SMika WesterbergContact:	thunderbolt-software@lists.01.org
9272ee3390SMika WesterbergDescription:	This attribute contains name of this device extracted from
9372ee3390SMika Westerberg		the device DROM.
9472ee3390SMika Westerberg
95bfe778acSMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../vendor
96bfe778acSMika WesterbergDate:		Sep 2017
97bfe778acSMika WesterbergKernelVersion:	4.13
98bfe778acSMika WesterbergContact:	thunderbolt-software@lists.01.org
99bfe778acSMika WesterbergDescription:	This attribute contains vendor id of this device extracted
100bfe778acSMika Westerberg		from the device DROM.
101bfe778acSMika Westerberg
10272ee3390SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../vendor_name
10372ee3390SMika WesterbergDate:		Sep 2017
10472ee3390SMika WesterbergKernelVersion:	4.13
10572ee3390SMika WesterbergContact:	thunderbolt-software@lists.01.org
10672ee3390SMika WesterbergDescription:	This attribute contains vendor name of this device extracted
10772ee3390SMika Westerberg		from the device DROM.
10872ee3390SMika Westerberg
109bfe778acSMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../unique_id
110bfe778acSMika WesterbergDate:		Sep 2017
111bfe778acSMika WesterbergKernelVersion:	4.13
112bfe778acSMika WesterbergContact:	thunderbolt-software@lists.01.org
113bfe778acSMika WesterbergDescription:	This attribute contains unique_id string of this device.
114bfe778acSMika Westerberg		This is either read from hardware registers (UUID on
115bfe778acSMika Westerberg		newer hardware) or based on UID from the device DROM.
116bfe778acSMika Westerberg		Can be used to uniquely identify particular device.
117e6b245ccSMika Westerberg
118e6b245ccSMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../nvm_version
119e6b245ccSMika WesterbergDate:		Sep 2017
120e6b245ccSMika WesterbergKernelVersion:	4.13
121e6b245ccSMika WesterbergContact:	thunderbolt-software@lists.01.org
122e6b245ccSMika WesterbergDescription:	If the device has upgradeable firmware the version
123e6b245ccSMika Westerberg		number is available here. Format: %x.%x, major.minor.
124e6b245ccSMika Westerberg		If the device is in safe mode reading the file returns
125e6b245ccSMika Westerberg		-ENODATA instead as the NVM version is not available.
126e6b245ccSMika Westerberg
127e6b245ccSMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../nvm_authenticate
128e6b245ccSMika WesterbergDate:		Sep 2017
129e6b245ccSMika WesterbergKernelVersion:	4.13
130e6b245ccSMika WesterbergContact:	thunderbolt-software@lists.01.org
131e6b245ccSMika WesterbergDescription:	When new NVM image is written to the non-active NVM
132e6b245ccSMika Westerberg		area (through non_activeX NVMem device), the
133e6b245ccSMika Westerberg		authentication procedure is started by writing 1 to
134e6b245ccSMika Westerberg		this file. If everything goes well, the device is
135e6b245ccSMika Westerberg		restarted with the new NVM firmware. If the image
136e6b245ccSMika Westerberg		verification fails an error code is returned instead.
137e6b245ccSMika Westerberg
138e6b245ccSMika Westerberg		When read holds status of the last authentication
139e6b245ccSMika Westerberg		operation if an error occurred during the process. This
140e6b245ccSMika Westerberg		is directly the status value from the DMA configuration
141e6b245ccSMika Westerberg		based mailbox before the device is power cycled. Writing
142e6b245ccSMika Westerberg		0 here clears the status.
143d1ff7024SMika Westerberg
144d1ff7024SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/<xdomain>.<service>/key
145d1ff7024SMika WesterbergDate:		Jan 2018
146d1ff7024SMika WesterbergKernelVersion:	4.15
147d1ff7024SMika WesterbergContact:	thunderbolt-software@lists.01.org
148d1ff7024SMika WesterbergDescription:	This contains name of the property directory the XDomain
149d1ff7024SMika Westerberg		service exposes. This entry describes the protocol in
150d1ff7024SMika Westerberg		question. Following directories are already reserved by
151d1ff7024SMika Westerberg		the Apple XDomain specification:
152d1ff7024SMika Westerberg
153d1ff7024SMika Westerberg		network:  IP/ethernet over Thunderbolt
154d1ff7024SMika Westerberg		targetdm: Target disk mode protocol over Thunderbolt
155d1ff7024SMika Westerberg		extdisp:  External display mode protocol over Thunderbolt
156d1ff7024SMika Westerberg
157d1ff7024SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/<xdomain>.<service>/modalias
158d1ff7024SMika WesterbergDate:		Jan 2018
159d1ff7024SMika WesterbergKernelVersion:	4.15
160d1ff7024SMika WesterbergContact:	thunderbolt-software@lists.01.org
161d1ff7024SMika WesterbergDescription:	Stores the same MODALIAS value emitted by uevent for
162d1ff7024SMika Westerberg		the XDomain service. Format: tbtsvc:kSpNvNrN
163d1ff7024SMika Westerberg
164d1ff7024SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/<xdomain>.<service>/prtcid
165d1ff7024SMika WesterbergDate:		Jan 2018
166d1ff7024SMika WesterbergKernelVersion:	4.15
167d1ff7024SMika WesterbergContact:	thunderbolt-software@lists.01.org
168d1ff7024SMika WesterbergDescription:	This contains XDomain protocol identifier the XDomain
169d1ff7024SMika Westerberg		service supports.
170d1ff7024SMika Westerberg
171d1ff7024SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/<xdomain>.<service>/prtcvers
172d1ff7024SMika WesterbergDate:		Jan 2018
173d1ff7024SMika WesterbergKernelVersion:	4.15
174d1ff7024SMika WesterbergContact:	thunderbolt-software@lists.01.org
175d1ff7024SMika WesterbergDescription:	This contains XDomain protocol version the XDomain
176d1ff7024SMika Westerberg		service supports.
177d1ff7024SMika Westerberg
178d1ff7024SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/<xdomain>.<service>/prtcrevs
179d1ff7024SMika WesterbergDate:		Jan 2018
180d1ff7024SMika WesterbergKernelVersion:	4.15
181d1ff7024SMika WesterbergContact:	thunderbolt-software@lists.01.org
182d1ff7024SMika WesterbergDescription:	This contains XDomain software version the XDomain
183d1ff7024SMika Westerberg		service supports.
184d1ff7024SMika Westerberg
185d1ff7024SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/<xdomain>.<service>/prtcstns
186d1ff7024SMika WesterbergDate:		Jan 2018
187d1ff7024SMika WesterbergKernelVersion:	4.15
188d1ff7024SMika WesterbergContact:	thunderbolt-software@lists.01.org
189d1ff7024SMika WesterbergDescription:	This contains XDomain service specific settings as
190d1ff7024SMika Westerberg		bitmask. Format: %x
191