Linux 6.7-rc7
[linux-modified.git] / Documentation / ABI / testing / debugfs-hisi-hpre
1 What:           /sys/kernel/debug/hisi_hpre/<bdf>/cluster[0-3]/regs
2 Date:           Sep 2019
3 Contact:        linux-crypto@vger.kernel.org
4 Description:    Dump debug registers from the HPRE cluster.
5                 Only available for PF.
6
7 What:           /sys/kernel/debug/hisi_hpre/<bdf>/cluster[0-3]/cluster_ctrl
8 Date:           Sep 2019
9 Contact:        linux-crypto@vger.kernel.org
10 Description:    Write the HPRE core selection in the cluster into this file,
11                 and then we can read the debug information of the core.
12                 Only available for PF.
13
14 What:           /sys/kernel/debug/hisi_hpre/<bdf>/rdclr_en
15 Date:           Sep 2019
16 Contact:        linux-crypto@vger.kernel.org
17 Description:    HPRE cores debug registers read clear control. 1 means enable
18                 register read clear, otherwise 0. Writing to this file has no
19                 functional effect, only enable or disable counters clear after
20                 reading of these registers.
21                 Only available for PF.
22
23 What:           /sys/kernel/debug/hisi_hpre/<bdf>/current_qm
24 Date:           Sep 2019
25 Contact:        linux-crypto@vger.kernel.org
26 Description:    One HPRE controller has one PF and multiple VFs, each function
27                 has a QM. Select the QM which below qm refers to.
28                 Only available for PF.
29
30 What:           /sys/kernel/debug/hisi_hpre/<bdf>/alg_qos
31 Date:           Jun 2021
32 Contact:        linux-crypto@vger.kernel.org
33 Description:    The <bdf> is related the function for PF and VF.
34                 HPRE driver supports to configure each function's QoS, the driver
35                 supports to write <bdf> value to alg_qos in the host. Such as
36                 "echo <bdf> value > alg_qos". The qos value is 1~1000, means
37                 1/1000~1000/1000 of total QoS. The driver reading alg_qos to
38                 get related QoS in the host and VM, Such as "cat alg_qos".
39
40 What:           /sys/kernel/debug/hisi_hpre/<bdf>/regs
41 Date:           Sep 2019
42 Contact:        linux-crypto@vger.kernel.org
43 Description:    Dump debug registers from the HPRE.
44                 Only available for PF.
45
46 What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/regs
47 Date:           Sep 2019
48 Contact:        linux-crypto@vger.kernel.org
49 Description:    Dump debug registers from the QM.
50                 Available for PF and VF in host. VF in guest currently only
51                 has one debug register.
52
53 What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/current_q
54 Date:           Sep 2019
55 Contact:        linux-crypto@vger.kernel.org
56 Description:    One QM may contain multiple queues. Select specific queue to
57                 show its debug registers in above regs.
58                 Only available for PF.
59
60 What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/clear_enable
61 Date:           Sep 2019
62 Contact:        linux-crypto@vger.kernel.org
63 Description:    QM debug registers(regs) read clear control. 1 means enable
64                 register read clear, otherwise 0.
65                 Writing to this file has no functional effect, only enable or
66                 disable counters clear after reading of these registers.
67                 Only available for PF.
68
69 What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/err_irq
70 Date:           Apr 2020
71 Contact:        linux-crypto@vger.kernel.org
72 Description:    Dump the number of invalid interrupts for
73                 QM task completion.
74                 Available for both PF and VF, and take no other effect on HPRE.
75
76 What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/aeq_irq
77 Date:           Apr 2020
78 Contact:        linux-crypto@vger.kernel.org
79 Description:    Dump the number of QM async event queue interrupts.
80                 Available for both PF and VF, and take no other effect on HPRE.
81
82 What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/abnormal_irq
83 Date:           Apr 2020
84 Contact:        linux-crypto@vger.kernel.org
85 Description:    Dump the number of interrupts for QM abnormal event.
86                 Available for both PF and VF, and take no other effect on HPRE.
87
88 What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/create_qp_err
89 Date:           Apr 2020
90 Contact:        linux-crypto@vger.kernel.org
91 Description:    Dump the number of queue allocation errors.
92                 Available for both PF and VF, and take no other effect on HPRE.
93
94 What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/mb_err
95 Date:           Apr 2020
96 Contact:        linux-crypto@vger.kernel.org
97 Description:    Dump the number of failed QM mailbox commands.
98                 Available for both PF and VF, and take no other effect on HPRE.
99
100 What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/status
101 Date:           Apr 2020
102 Contact:        linux-crypto@vger.kernel.org
103 Description:    Dump the status of the QM.
104                 Four states: initiated, started, stopped and closed.
105                 Available for both PF and VF, and take no other effect on HPRE.
106
107 What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/diff_regs
108 Date:           Mar 2022
109 Contact:        linux-crypto@vger.kernel.org
110 Description:    QM debug registers(regs) read hardware register value. This
111                 node is used to show the change of the qm register values. This
112                 node can be help users to check the change of register values.
113
114 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/diff_regs
115 Date:           Mar 2022
116 Contact:        linux-crypto@vger.kernel.org
117 Description:    HPRE debug registers(regs) read hardware register value. This
118                 node is used to show the change of the register values. This
119                 node can be help users to check the change of register values.
120
121 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_cnt
122 Date:           Apr 2020
123 Contact:        linux-crypto@vger.kernel.org
124 Description:    Dump the total number of sent requests.
125                 Available for both PF and VF, and take no other effect on HPRE.
126
127 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/recv_cnt
128 Date:           Apr 2020
129 Contact:        linux-crypto@vger.kernel.org
130 Description:    Dump the total number of received requests.
131                 Available for both PF and VF, and take no other effect on HPRE.
132
133 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_busy_cnt
134 Date:           Apr 2020
135 Contact:        linux-crypto@vger.kernel.org
136 Description:    Dump the total number of requests sent
137                 with returning busy.
138                 Available for both PF and VF, and take no other effect on HPRE.
139
140 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_fail_cnt
141 Date:           Apr 2020
142 Contact:        linux-crypto@vger.kernel.org
143 Description:    Dump the total number of completed but error requests.
144                 Available for both PF and VF, and take no other effect on HPRE.
145
146 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/invalid_req_cnt
147 Date:           Apr 2020
148 Contact:        linux-crypto@vger.kernel.org
149 Description:    Dump the total number of invalid requests being received.
150                 Available for both PF and VF, and take no other effect on HPRE.
151
152 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/overtime_thrhld
153 Date:           Apr 2020
154 Contact:        linux-crypto@vger.kernel.org
155 Description:    Set the threshold time for counting the request which is
156                 processed longer than the threshold.
157                 0: disable(default), 1: 1 microsecond.
158                 Available for both PF and VF, and take no other effect on HPRE.
159
160 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/over_thrhld_cnt
161 Date:           Apr 2020
162 Contact:        linux-crypto@vger.kernel.org
163 Description:    Dump the total number of time out requests.
164                 Available for both PF and VF, and take no other effect on HPRE.