xref: /linux/Documentation/ABI/testing/sysfs-bus-thunderbolt (revision d1ff70241a275133e1a0258b7c23588b122276c8)
1f67cf491SMika WesterbergWhat: /sys/bus/thunderbolt/devices/.../domainX/security
2f67cf491SMika WesterbergDate:		Sep 2017
3f67cf491SMika WesterbergKernelVersion:	4.13
4f67cf491SMika WesterbergContact:	thunderbolt-software@lists.01.org
5f67cf491SMika WesterbergDescription:	This attribute holds current Thunderbolt security level
6f67cf491SMika Westerberg		set by the system BIOS. Possible values are:
7f67cf491SMika Westerberg
8f67cf491SMika Westerberg		none: All devices are automatically authorized
9f67cf491SMika Westerberg		user: Devices are only authorized based on writing
10f67cf491SMika Westerberg		      appropriate value to the authorized attribute
11f67cf491SMika Westerberg		secure: Require devices that support secure connect at
12f67cf491SMika Westerberg			minimum. User needs to authorize each device.
13f67cf491SMika Westerberg		dponly: Automatically tunnel Display port (and USB). No
14f67cf491SMika Westerberg			PCIe tunnels are created.
15f67cf491SMika Westerberg
16f67cf491SMika WesterbergWhat: /sys/bus/thunderbolt/devices/.../authorized
17f67cf491SMika WesterbergDate:		Sep 2017
18f67cf491SMika WesterbergKernelVersion:	4.13
19f67cf491SMika WesterbergContact:	thunderbolt-software@lists.01.org
20f67cf491SMika WesterbergDescription:	This attribute is used to authorize Thunderbolt devices
21f67cf491SMika Westerberg		after they have been connected. If the device is not
22f67cf491SMika Westerberg		authorized, no devices such as PCIe and Display port are
23f67cf491SMika Westerberg		available to the system.
24f67cf491SMika Westerberg
25f67cf491SMika Westerberg		Contents of this attribute will be 0 when the device is not
26f67cf491SMika Westerberg		yet authorized.
27f67cf491SMika Westerberg
28f67cf491SMika Westerberg		Possible values are supported:
29f67cf491SMika Westerberg		1: The device will be authorized and connected
30f67cf491SMika Westerberg
31f67cf491SMika Westerberg		When key attribute contains 32 byte hex string the possible
32f67cf491SMika Westerberg		values are:
33f67cf491SMika Westerberg		1: The 32 byte hex string is added to the device NVM and
34f67cf491SMika Westerberg		   the device is authorized.
35f67cf491SMika Westerberg		2: Send a challenge based on the 32 byte hex string. If the
36f67cf491SMika Westerberg		   challenge response from device is valid, the device is
37f67cf491SMika Westerberg		   authorized. In case of failure errno will be ENOKEY if
38f67cf491SMika Westerberg		   the device did not contain a key at all, and
39f67cf491SMika Westerberg		   EKEYREJECTED if the challenge response did not match.
40f67cf491SMika Westerberg
41f67cf491SMika WesterbergWhat: /sys/bus/thunderbolt/devices/.../key
42f67cf491SMika WesterbergDate:		Sep 2017
43f67cf491SMika WesterbergKernelVersion:	4.13
44f67cf491SMika WesterbergContact:	thunderbolt-software@lists.01.org
45f67cf491SMika WesterbergDescription:	When a devices supports Thunderbolt secure connect it will
46f67cf491SMika Westerberg		have this attribute. Writing 32 byte hex string changes
47f67cf491SMika Westerberg		authorization to use the secure connection method instead.
48e545f0d8SBernat, Yehezkel		Writing an empty string clears the key and regular connection
49e545f0d8SBernat, Yehezkel		method can be used again.
50f67cf491SMika Westerberg
51bfe778acSMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../device
52bfe778acSMika WesterbergDate:		Sep 2017
53bfe778acSMika WesterbergKernelVersion:	4.13
54bfe778acSMika WesterbergContact:	thunderbolt-software@lists.01.org
55bfe778acSMika WesterbergDescription:	This attribute contains id of this device extracted from
56bfe778acSMika Westerberg		the device DROM.
57bfe778acSMika Westerberg
5872ee3390SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../device_name
5972ee3390SMika WesterbergDate:		Sep 2017
6072ee3390SMika WesterbergKernelVersion:	4.13
6172ee3390SMika WesterbergContact:	thunderbolt-software@lists.01.org
6272ee3390SMika WesterbergDescription:	This attribute contains name of this device extracted from
6372ee3390SMika Westerberg		the device DROM.
6472ee3390SMika Westerberg
65bfe778acSMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../vendor
66bfe778acSMika WesterbergDate:		Sep 2017
67bfe778acSMika WesterbergKernelVersion:	4.13
68bfe778acSMika WesterbergContact:	thunderbolt-software@lists.01.org
69bfe778acSMika WesterbergDescription:	This attribute contains vendor id of this device extracted
70bfe778acSMika Westerberg		from the device DROM.
71bfe778acSMika Westerberg
7272ee3390SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../vendor_name
7372ee3390SMika WesterbergDate:		Sep 2017
7472ee3390SMika WesterbergKernelVersion:	4.13
7572ee3390SMika WesterbergContact:	thunderbolt-software@lists.01.org
7672ee3390SMika WesterbergDescription:	This attribute contains vendor name of this device extracted
7772ee3390SMika Westerberg		from the device DROM.
7872ee3390SMika Westerberg
79bfe778acSMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../unique_id
80bfe778acSMika WesterbergDate:		Sep 2017
81bfe778acSMika WesterbergKernelVersion:	4.13
82bfe778acSMika WesterbergContact:	thunderbolt-software@lists.01.org
83bfe778acSMika WesterbergDescription:	This attribute contains unique_id string of this device.
84bfe778acSMika Westerberg		This is either read from hardware registers (UUID on
85bfe778acSMika Westerberg		newer hardware) or based on UID from the device DROM.
86bfe778acSMika Westerberg		Can be used to uniquely identify particular device.
87e6b245ccSMika Westerberg
88e6b245ccSMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../nvm_version
89e6b245ccSMika WesterbergDate:		Sep 2017
90e6b245ccSMika WesterbergKernelVersion:	4.13
91e6b245ccSMika WesterbergContact:	thunderbolt-software@lists.01.org
92e6b245ccSMika WesterbergDescription:	If the device has upgradeable firmware the version
93e6b245ccSMika Westerberg		number is available here. Format: %x.%x, major.minor.
94e6b245ccSMika Westerberg		If the device is in safe mode reading the file returns
95e6b245ccSMika Westerberg		-ENODATA instead as the NVM version is not available.
96e6b245ccSMika Westerberg
97e6b245ccSMika WesterbergWhat:		/sys/bus/thunderbolt/devices/.../nvm_authenticate
98e6b245ccSMika WesterbergDate:		Sep 2017
99e6b245ccSMika WesterbergKernelVersion:	4.13
100e6b245ccSMika WesterbergContact:	thunderbolt-software@lists.01.org
101e6b245ccSMika WesterbergDescription:	When new NVM image is written to the non-active NVM
102e6b245ccSMika Westerberg		area (through non_activeX NVMem device), the
103e6b245ccSMika Westerberg		authentication procedure is started by writing 1 to
104e6b245ccSMika Westerberg		this file. If everything goes well, the device is
105e6b245ccSMika Westerberg		restarted with the new NVM firmware. If the image
106e6b245ccSMika Westerberg		verification fails an error code is returned instead.
107e6b245ccSMika Westerberg
108e6b245ccSMika Westerberg		When read holds status of the last authentication
109e6b245ccSMika Westerberg		operation if an error occurred during the process. This
110e6b245ccSMika Westerberg		is directly the status value from the DMA configuration
111e6b245ccSMika Westerberg		based mailbox before the device is power cycled. Writing
112e6b245ccSMika Westerberg		0 here clears the status.
113*d1ff7024SMika Westerberg
114*d1ff7024SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/<xdomain>.<service>/key
115*d1ff7024SMika WesterbergDate:		Jan 2018
116*d1ff7024SMika WesterbergKernelVersion:	4.15
117*d1ff7024SMika WesterbergContact:	thunderbolt-software@lists.01.org
118*d1ff7024SMika WesterbergDescription:	This contains name of the property directory the XDomain
119*d1ff7024SMika Westerberg		service exposes. This entry describes the protocol in
120*d1ff7024SMika Westerberg		question. Following directories are already reserved by
121*d1ff7024SMika Westerberg		the Apple XDomain specification:
122*d1ff7024SMika Westerberg
123*d1ff7024SMika Westerberg		network:  IP/ethernet over Thunderbolt
124*d1ff7024SMika Westerberg		targetdm: Target disk mode protocol over Thunderbolt
125*d1ff7024SMika Westerberg		extdisp:  External display mode protocol over Thunderbolt
126*d1ff7024SMika Westerberg
127*d1ff7024SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/<xdomain>.<service>/modalias
128*d1ff7024SMika WesterbergDate:		Jan 2018
129*d1ff7024SMika WesterbergKernelVersion:	4.15
130*d1ff7024SMika WesterbergContact:	thunderbolt-software@lists.01.org
131*d1ff7024SMika WesterbergDescription:	Stores the same MODALIAS value emitted by uevent for
132*d1ff7024SMika Westerberg		the XDomain service. Format: tbtsvc:kSpNvNrN
133*d1ff7024SMika Westerberg
134*d1ff7024SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/<xdomain>.<service>/prtcid
135*d1ff7024SMika WesterbergDate:		Jan 2018
136*d1ff7024SMika WesterbergKernelVersion:	4.15
137*d1ff7024SMika WesterbergContact:	thunderbolt-software@lists.01.org
138*d1ff7024SMika WesterbergDescription:	This contains XDomain protocol identifier the XDomain
139*d1ff7024SMika Westerberg		service supports.
140*d1ff7024SMika Westerberg
141*d1ff7024SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/<xdomain>.<service>/prtcvers
142*d1ff7024SMika WesterbergDate:		Jan 2018
143*d1ff7024SMika WesterbergKernelVersion:	4.15
144*d1ff7024SMika WesterbergContact:	thunderbolt-software@lists.01.org
145*d1ff7024SMika WesterbergDescription:	This contains XDomain protocol version the XDomain
146*d1ff7024SMika Westerberg		service supports.
147*d1ff7024SMika Westerberg
148*d1ff7024SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/<xdomain>.<service>/prtcrevs
149*d1ff7024SMika WesterbergDate:		Jan 2018
150*d1ff7024SMika WesterbergKernelVersion:	4.15
151*d1ff7024SMika WesterbergContact:	thunderbolt-software@lists.01.org
152*d1ff7024SMika WesterbergDescription:	This contains XDomain software version the XDomain
153*d1ff7024SMika Westerberg		service supports.
154*d1ff7024SMika Westerberg
155*d1ff7024SMika WesterbergWhat:		/sys/bus/thunderbolt/devices/<xdomain>.<service>/prtcstns
156*d1ff7024SMika WesterbergDate:		Jan 2018
157*d1ff7024SMika WesterbergKernelVersion:	4.15
158*d1ff7024SMika WesterbergContact:	thunderbolt-software@lists.01.org
159*d1ff7024SMika WesterbergDescription:	This contains XDomain service specific settings as
160*d1ff7024SMika Westerberg		bitmask. Format: %x
161