1 What: /sys/kernel/debug/qat_<device>
2 Date: March 2024
3 KernelVersion: 6.8
4 Contact: qat-linux@intel.com
5 Description: (RW) Enables/disables the repo
6
7 Allowed values to write:
8 ========================
9 * 0: disable telemetry
10 * 1: enable telemetry
11 * 2, 3, 4: enable telemetry an
12 and average for each counter
13
14 Returned values:
15 ================
16 * 1-4: telemetry is enabled an
17 * 0: telemetry is disabled
18
19 Example.
20
21 Writing '3' to this file start
22 telemetry metrics. Samples are
23 stored in a circular buffer of
24 used to calculate the minimum,
25 counter. After enabling, count
26 the ``device_data`` file::
27
28 echo 3 > /sys/kernel/debug/q
29
30 Writing '0' to this file stops
31 metrics::
32
33 echo 0 > /sys/kernel/debug/q
34
35 This attribute is only availab
36
37 What: /sys/kernel/debug/qat_<device>
38 Date: March 2024
39 KernelVersion: 6.8
40 Contact: qat-linux@intel.com
41 Description: (RO) Reports device telemetry
42 Reads report metrics about per
43 a QAT device:
44
45 ======================= ======
46 Field Descri
47 ======================= ======
48 sample_cnt number
49 from t
50 every
51 pci_trans_cnt number
52 max_rd_lat maximu
53 be any
54 rd_lat_acc_avg averag
55 max_gp_lat max ge
56 sample
57 gp_lat_acc_avg averag
58 bw_in PCIe,
59 bw_out PCIe,
60 at_page_req_lat_avg Addres
61 reques
62 at_trans_lat_avg AT, av
63 at_max_tlb_used AT, ma
64 util_cpr<N> utiliz
65 exec_cpr<N> execut
66 util_xlt<N> utiliz
67 exec_xlt<N> execut
68 util_dcpr<N> utiliz
69 exec_dcpr<N> execut
70 util_pke<N> utiliz
71 exec_pke<N> execut
72 util_ucs<N> utiliz
73 exec_ucs<N> execut
74 util_wat<N> utiliz
75 slice
76 exec_wat<N> execut
77 slice
78 util_wcp<N> utiliz
79 exec_wcp<N> execut
80 util_cph<N> utiliz
81 exec_cph<N> execut
82 util_ath<N> utiliz
83 exec_ath<N> execut
84 ======================= ======
85
86 The telemetry report file can
87
88 cat /sys/kernel/debug/qat_4x
89
90 If ``control`` is set to 1, on
91 counters are displayed::
92
93 <counter_name> <current>
94
95 If ``control`` is 2, 3 or 4, c
96 following format::
97
98 <counter_name> <current> <mi
99
100 If a device lacks of a specifi
101 attribute is not reported.
102
103 This attribute is only availab
104
105 What: /sys/kernel/debug/qat_<device>
106 Date: March 2024
107 KernelVersion: 6.8
108 Contact: qat-linux@intel.com
109 Description: (RW) Selects up to 4 Ring Pair
110 and report telemetry counters
111
112 Allowed values to write:
113 ========================
114 * 0 to ``<num_rps - 1>``:
115 Ring pair to be monitored. T
116 retrieved through ``/sys/bus
117 See Documentation/ABI/testin
118
119 Reads report metrics about per
120 the selected RP:
121
122 ======================= ======
123 Field Descri
124 ======================= ======
125 sample_cnt number
126 from t
127 every
128 rp_num RP num
129 service_type servic
130 pci_trans_cnt number
131 gp_lat_acc_avg averag
132 bw_in PCIe,
133 bw_out PCIe,
134 at_glob_devtlb_hit Messag
135 at_glob_devtlb_miss Messag
136 tl_at_payld_devtlb_hit Payloa
137 tl_at_payld_devtlb_miss Payloa
138 ======================= ======
139
140 Example.
141
142 Writing the value '32' to the
143 collection of telemetry metric
144
145 echo 32 > /sys/kernel/debug/
146
147 Once a ring pair is selected,
148 the file::
149
150 cat /sys/kernel/debug/qat_4x
151
152 If ``control`` is set to 1, on
153 counters are displayed::
154
155 <counter_name> <current>
156
157 If ``control`` is 2, 3 or 4, c
158 following format::
159
160 <counter_name> <current> <mi
161
162
163 On QAT GEN4 devices there are
164 values are 0..63. This number
165 If Virtual Functions (VF) are
166 be derived from the Bus, Devic
167
168 ============ ====== ====== ===
169 PCI BDF/VF RP0 RP1 RP2
170 ============ ====== ====== ===
171 0000:6b:0.1 RP 0 RP 1 RP
172 0000:6b:0.2 RP 4 RP 5 RP
173 0000:6b:0.3 RP 8 RP 9 RP
174 0000:6b:0.4 RP 12 RP 13 RP
175 0000:6b:0.5 RP 16 RP 17 RP
176 0000:6b:0.6 RP 20 RP 21 RP
177 0000:6b:0.7 RP 24 RP 25 RP
178 0000:6b:1.0 RP 28 RP 29 RP
179 0000:6b:1.1 RP 32 RP 33 RP
180 0000:6b:1.2 RP 36 RP 37 RP
181 0000:6b:1.3 RP 40 RP 41 RP
182 0000:6b:1.4 RP 44 RP 45 RP
183 0000:6b:1.5 RP 48 RP 49 RP
184 0000:6b:1.6 RP 52 RP 53 RP
185 0000:6b:1.7 RP 56 RP 57 RP
186 0000:6b:2.0 RP 60 RP 61 RP
187 ============ ====== ====== ===
188
189 The mapping is only valid for
190
191
192 The service provided on a ring
193 configuration. The configurati
194 queried and set using ``cfg_se
195 See Documentation/ABI/testing/
196
197 The following table reports ho
198 on the PF 0000:6b:0.0 configur
199
200 =========== ============ =====
201 PCI BDF/VF RP0/service RP1/s
202 =========== ============ =====
203 0000:6b:0.1 RP 0 asym RP 1
204 0000:6b:0.2 RP 4 asym RP 5
205 0000:6b:0.3 RP 8 asym RP 9
206 ... ... ...
207 =========== ============ =====
208
209 All VFs follow the same patter
210
211
212 The following table reports ho
213 the PF 0000:6b:0.0 configured
214
215 =========== ============ =====
216 PCI BDF/VF RP0/service RP1/s
217 =========== ============ =====
218 0000:6b:0.1 RP 0 dc RP 1
219 0000:6b:0.2 RP 4 dc RP 5
220 0000:6b:0.3 RP 8 dc RP 9
221 ... ... ...
222 =========== ============ =====
223
224 The mapping of a RP to a servi
225 ``rp2srv`` from sysfs.
226 See Documentation/ABI/testing/
227
228 This attribute is only availab
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.