xref: /linux/Documentation/ABI/testing/sysfs-driver-qat_svn (revision 0fc8f6200d2313278fbf4539bbab74677c685531)
1What:		/sys/bus/pci/devices/<BDF>/qat_svn/
2Date:		June 2026
3KernelVersion:	7.1
4Contact:	qat-linux@intel.com
5Description:	Directory containing Security Version Number (SVN) attributes for
6		the Anti-Rollback (ARB) feature. The ARB feature prevents downloading
7		older firmware versions to the acceleration device.
8
9What:		/sys/bus/pci/devices/<BDF>/qat_svn/enforced_min
10Date:		June 2026
11KernelVersion:	7.1
12Contact:	qat-linux@intel.com
13Description:
14		(RO) Reports the minimum allowed firmware SVN.
15
16		Returns an integer greater than zero. Firmware with SVN lower than
17		this value is rejected.
18
19		A write to qat_svn/commit will update this value. The update is not
20		persistent across reboot; on reboot, this value is reset from
21		qat_svn/permanent_min.
22
23		Example usage::
24
25			# cat /sys/bus/pci/devices/<BDF>/qat_svn/enforced_min
26			2
27
28		This attribute is available only on devices that support
29		Anti-Rollback.
30
31What:		/sys/bus/pci/devices/<BDF>/qat_svn/permanent_min
32Date:		June 2026
33KernelVersion:	7.1
34Contact:	qat-linux@intel.com
35Description:
36		(RO) Reports the persistent minimum SVN used to initialize
37		qat_svn/enforced_min on each reboot.
38
39		Returns an integer greater than zero. A write to qat_svn/commit
40		may update this value, depending on platform/BIOS settings.
41
42		Example usage::
43
44			# cat /sys/bus/pci/devices/<BDF>/qat_svn/permanent_min
45			3
46
47		This attribute is available only on devices that support
48		Anti-Rollback.
49
50What:		/sys/bus/pci/devices/<BDF>/qat_svn/active
51Date:		June 2026
52KernelVersion:	7.1
53Contact:	qat-linux@intel.com
54Description:
55		(RO) Reports the SVN of the currently active firmware image.
56
57		Returns an integer greater than zero.
58
59		Example usage::
60
61			# cat /sys/bus/pci/devices/<BDF>/qat_svn/active
62			2
63
64		This attribute is available only on devices that support
65		Anti-Rollback.
66
67What:		/sys/bus/pci/devices/<BDF>/qat_svn/commit
68Date:		June 2026
69KernelVersion:	7.1
70Contact:	qat-linux@intel.com
71Description:
72		(WO) Commits the currently active SVN as the minimum allowed SVN.
73
74		Writing 1 sets qat_svn/enforced_min to the value of qat_svn/active,
75		preventing future firmware loads with lower SVN.
76
77		Depending on platform/BIOS settings, a commit may also update
78		qat_svn/permanent_min.
79
80		Note that on reboot, qat_svn/enforced_min reverts to
81		qat_svn/permanent_min.
82
83		It is advisable to use this attribute with caution, only when
84		it is necessary to set a new minimum SVN for the firmware.
85
86		Before committing the SVN update, it is crucial to check the
87		current values of qat_svn/active, qat_svn/enforced_min and
88		qat_svn/permanent_min. This verification helps ensure that the
89		commit operation aligns with the intended outcome.
90
91		While writing to the file, any value other than '1' will result
92		in an error and have no effect.
93
94		Example usage::
95
96			## Read current values
97			# cat /sys/bus/pci/devices/<BDF>/qat_svn/enforced_min
98			2
99			# cat /sys/bus/pci/devices/<BDF>/qat_svn/permanent_min
100			2
101			# cat /sys/bus/pci/devices/<BDF>/qat_svn/active
102			3
103
104			## Commit active SVN
105			# echo 1 > /sys/bus/pci/devices/<BDF>/qat_svn/commit
106
107			## Read updated values
108			# cat /sys/bus/pci/devices/<BDF>/qat_svn/enforced_min
109			3
110			# cat /sys/bus/pci/devices/<BDF>/qat_svn/permanent_min
111			3
112
113		This attribute is available only on devices that support
114		Anti-Rollback.
115