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