summaryrefslogtreecommitdiff
path: root/Documentation/ABI/testing/sysfs-driver-qat_svn
blob: 3832b523dcb08fec934e57417312da6d6a1d1b8f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
What:		/sys/bus/pci/devices/<BDF>/qat_svn/
Date:		June 2026
KernelVersion:	7.1
Contact:	qat-linux@intel.com
Description:	Directory containing Security Version Number (SVN) attributes for
		the Anti-Rollback (ARB) feature. The ARB feature prevents downloading
		older firmware versions to the acceleration device.

What:		/sys/bus/pci/devices/<BDF>/qat_svn/enforced_min
Date:		June 2026
KernelVersion:	7.1
Contact:	qat-linux@intel.com
Description:
		(RO) Reports the minimum allowed firmware SVN.

		Returns an integer greater than zero. Firmware with SVN lower than
		this value is rejected.

		A write to qat_svn/commit will update this value. The update is not
		persistent across reboot; on reboot, this value is reset from
		qat_svn/permanent_min.

		Example usage::

			# cat /sys/bus/pci/devices/<BDF>/qat_svn/enforced_min
			2

		This attribute is available only on devices that support
		Anti-Rollback.

What:		/sys/bus/pci/devices/<BDF>/qat_svn/permanent_min
Date:		June 2026
KernelVersion:	7.1
Contact:	qat-linux@intel.com
Description:
		(RO) Reports the persistent minimum SVN used to initialize
		qat_svn/enforced_min on each reboot.

		Returns an integer greater than zero. A write to qat_svn/commit
		may update this value, depending on platform/BIOS settings.

		Example usage::

			# cat /sys/bus/pci/devices/<BDF>/qat_svn/permanent_min
			3

		This attribute is available only on devices that support
		Anti-Rollback.

What:		/sys/bus/pci/devices/<BDF>/qat_svn/active
Date:		June 2026
KernelVersion:	7.1
Contact:	qat-linux@intel.com
Description:
		(RO) Reports the SVN of the currently active firmware image.

		Returns an integer greater than zero.

		Example usage::

			# cat /sys/bus/pci/devices/<BDF>/qat_svn/active
			2

		This attribute is available only on devices that support
		Anti-Rollback.

What:		/sys/bus/pci/devices/<BDF>/qat_svn/commit
Date:		June 2026
KernelVersion:	7.1
Contact:	qat-linux@intel.com
Description:
		(WO) Commits the currently active SVN as the minimum allowed SVN.

		Writing 1 sets qat_svn/enforced_min to the value of qat_svn/active,
		preventing future firmware loads with lower SVN.

		Depending on platform/BIOS settings, a commit may also update
		qat_svn/permanent_min.

		Note that on reboot, qat_svn/enforced_min reverts to
		qat_svn/permanent_min.

		It is advisable to use this attribute with caution, only when
		it is necessary to set a new minimum SVN for the firmware.

		Before committing the SVN update, it is crucial to check the
		current values of qat_svn/active, qat_svn/enforced_min and
		qat_svn/permanent_min. This verification helps ensure that the
		commit operation aligns with the intended outcome.

		While writing to the file, any value other than '1' will result
		in an error and have no effect.

		Example usage::

			## Read current values
			# cat /sys/bus/pci/devices/<BDF>/qat_svn/enforced_min
			2
			# cat /sys/bus/pci/devices/<BDF>/qat_svn/permanent_min
			2
			# cat /sys/bus/pci/devices/<BDF>/qat_svn/active
			3

			## Commit active SVN
			# echo 1 > /sys/bus/pci/devices/<BDF>/qat_svn/commit

			## Read updated values
			# cat /sys/bus/pci/devices/<BDF>/qat_svn/enforced_min
			3
			# cat /sys/bus/pci/devices/<BDF>/qat_svn/permanent_min
			3

		This attribute is available only on devices that support
		Anti-Rollback.