xref: /linux/Documentation/ABI/testing/sysfs-driver-qat_kpt (revision 9611c0ce215a66770ccbe5c126bf57ba8c31bcad)
1*fb98254aSJunyuan WangWhat:		/sys/bus/pci/devices/<BDF>/qat_kpt/
2*fb98254aSJunyuan WangDate:		August 2026
3*fb98254aSJunyuan WangKernelVersion:	7.2
4*fb98254aSJunyuan WangContact:	qat-linux@intel.com
5*fb98254aSJunyuan WangDescription:
6*fb98254aSJunyuan Wang		Directory containing attributes related to the QAT Key Protection
7*fb98254aSJunyuan Wang		Technology (KPT) feature. KPT allows cryptographic keys to be used
8*fb98254aSJunyuan Wang		by the accelerator without being exposed in plaintext to the host.
9*fb98254aSJunyuan Wang
10*fb98254aSJunyuan WangWhat:		/sys/bus/pci/devices/<BDF>/qat_kpt/enable
11*fb98254aSJunyuan WangDate:		August 2026
12*fb98254aSJunyuan WangKernelVersion:	7.2
13*fb98254aSJunyuan WangContact:	qat-linux@intel.com
14*fb98254aSJunyuan WangDescription:
15*fb98254aSJunyuan Wang		(RW) Enables or disables Key Protection Technology (KPT).
16*fb98254aSJunyuan Wang
17*fb98254aSJunyuan Wang		Write 1 to enable KPT, or 0 to disable it.
18*fb98254aSJunyuan Wang
19*fb98254aSJunyuan Wang		Example usage::
20*fb98254aSJunyuan Wang
21*fb98254aSJunyuan Wang			# cat /sys/bus/pci/devices/<BDF>/qat_kpt/enable
22*fb98254aSJunyuan Wang			0
23*fb98254aSJunyuan Wang			# echo 1 > /sys/bus/pci/devices/<BDF>/qat_kpt/enable
24*fb98254aSJunyuan Wang
25*fb98254aSJunyuan Wang		This attribute is only available on devices that support KPT.
26*fb98254aSJunyuan Wang
27*fb98254aSJunyuan WangWhat:		/sys/bus/pci/devices/<BDF>/qat_kpt/swk_cnt_per_fn
28*fb98254aSJunyuan WangDate:		August 2026
29*fb98254aSJunyuan WangKernelVersion:	7.2
30*fb98254aSJunyuan WangContact:	qat-linux@intel.com
31*fb98254aSJunyuan WangDescription:
32*fb98254aSJunyuan Wang		(RW) Configures the maximum number of KPT symmetric wrapping keys
33*fb98254aSJunyuan Wang		(SWKs) that a Virtual Function (VF) may be associated with.
34*fb98254aSJunyuan Wang
35*fb98254aSJunyuan Wang		Valid values range from 0 to 128. A value of 0 indicates no limit.
36*fb98254aSJunyuan Wang
37*fb98254aSJunyuan Wang		Example usage::
38*fb98254aSJunyuan Wang
39*fb98254aSJunyuan Wang			# cat /sys/bus/pci/devices/<BDF>/qat_kpt/swk_cnt_per_fn
40*fb98254aSJunyuan Wang			128
41*fb98254aSJunyuan Wang			# echo 128 > /sys/bus/pci/devices/<BDF>/qat_kpt/swk_cnt_per_fn
42*fb98254aSJunyuan Wang
43*fb98254aSJunyuan Wang		This attribute is only available on devices that support KPT.
44*fb98254aSJunyuan Wang
45*fb98254aSJunyuan WangWhat:		/sys/bus/pci/devices/<BDF>/qat_kpt/swk_cnt_per_pasid
46*fb98254aSJunyuan WangDate:		August 2026
47*fb98254aSJunyuan WangKernelVersion:	7.2
48*fb98254aSJunyuan WangContact:	qat-linux@intel.com
49*fb98254aSJunyuan WangDescription:
50*fb98254aSJunyuan Wang		(RW) Configures the maximum number of KPT symmetric wrapping keys
51*fb98254aSJunyuan Wang		(SWKs) per Process Address Space ID (PASID).
52*fb98254aSJunyuan Wang
53*fb98254aSJunyuan Wang		Valid values range from 0 to 128. A value of 0 indicates no limit.
54*fb98254aSJunyuan Wang
55*fb98254aSJunyuan Wang		Example usage::
56*fb98254aSJunyuan Wang
57*fb98254aSJunyuan Wang			# cat /sys/bus/pci/devices/<BDF>/qat_kpt/swk_cnt_per_pasid
58*fb98254aSJunyuan Wang			128
59*fb98254aSJunyuan Wang			# echo 128 > /sys/bus/pci/devices/<BDF>/qat_kpt/swk_cnt_per_pasid
60*fb98254aSJunyuan Wang
61*fb98254aSJunyuan Wang		This attribute is only available on devices that support KPT.
62*fb98254aSJunyuan Wang
63*fb98254aSJunyuan WangWhat:		/sys/bus/pci/devices/<BDF>/qat_kpt/swk_max_ttl
64*fb98254aSJunyuan WangDate:		August 2026
65*fb98254aSJunyuan WangKernelVersion:	7.2
66*fb98254aSJunyuan WangContact:	qat-linux@intel.com
67*fb98254aSJunyuan WangDescription:
68*fb98254aSJunyuan Wang		(RW) Configures the maximum Time To Live (TTL) for KPT symmetric
69*fb98254aSJunyuan Wang		wrapping keys (SWK).
70*fb98254aSJunyuan Wang
71*fb98254aSJunyuan Wang		Valid values range from 0 to 31536000 seconds. A value of 0
72*fb98254aSJunyuan Wang		indicates that the SWK TTL is unlimited.
73*fb98254aSJunyuan Wang
74*fb98254aSJunyuan Wang		Example usage::
75*fb98254aSJunyuan Wang
76*fb98254aSJunyuan Wang			# cat /sys/bus/pci/devices/<BDF>/qat_kpt/swk_max_ttl
77*fb98254aSJunyuan Wang			1000
78*fb98254aSJunyuan Wang			# echo 1000 > /sys/bus/pci/devices/<BDF>/qat_kpt/swk_max_ttl
79*fb98254aSJunyuan Wang
80*fb98254aSJunyuan Wang		This attribute is only available on devices that support KPT.
81*fb98254aSJunyuan Wang
82*fb98254aSJunyuan WangWhat:		/sys/bus/pci/devices/<BDF>/qat_kpt/swk_shared
83*fb98254aSJunyuan WangDate:		August 2026
84*fb98254aSJunyuan WangKernelVersion:	7.2
85*fb98254aSJunyuan WangContact:	qat-linux@intel.com
86*fb98254aSJunyuan WangDescription:
87*fb98254aSJunyuan Wang		(RW) Controls shared mode for KPT symmetric wrapping keys (SWK).
88*fb98254aSJunyuan Wang
89*fb98254aSJunyuan Wang		Write 1 to enable shared mode, or 0 to disable it (non-shared mode).
90*fb98254aSJunyuan Wang
91*fb98254aSJunyuan Wang		Example usage::
92*fb98254aSJunyuan Wang
93*fb98254aSJunyuan Wang			# cat /sys/bus/pci/devices/<BDF>/qat_kpt/swk_shared
94*fb98254aSJunyuan Wang			0
95*fb98254aSJunyuan Wang			# echo 1 > /sys/bus/pci/devices/<BDF>/qat_kpt/swk_shared
96*fb98254aSJunyuan Wang
97*fb98254aSJunyuan Wang		This attribute is only available on devices that support KPT.
98