Linux 6.7-rc7
[linux-modified.git] / Documentation / ABI / testing / debugfs-hisi-sec
1 What:           /sys/kernel/debug/hisi_sec2/<bdf>/clear_enable
2 Date:           Oct 2019
3 Contact:        linux-crypto@vger.kernel.org
4 Description:    Enabling/disabling of clear action after reading
5                 the SEC debug registers.
6                 0: disable, 1: enable.
7                 Only available for PF, and take no other effect on SEC.
8
9 What:           /sys/kernel/debug/hisi_sec2/<bdf>/current_qm
10 Date:           Oct 2019
11 Contact:        linux-crypto@vger.kernel.org
12 Description:    One SEC controller has one PF and multiple VFs, each function
13                 has a QM. This file can be used to select the QM which below
14                 qm refers to.
15                 Only available for PF.
16
17 What:           /sys/kernel/debug/hisi_sec2/<bdf>/alg_qos
18 Date:           Jun 2021
19 Contact:        linux-crypto@vger.kernel.org
20 Description:    The <bdf> is related the function for PF and VF.
21                 SEC driver supports to configure each function's QoS, the driver
22                 supports to write <bdf> value to alg_qos in the host. Such as
23                 "echo <bdf> value > alg_qos". The qos value is 1~1000, means
24                 1/1000~1000/1000 of total QoS. The driver reading alg_qos to
25                 get related QoS in the host and VM, Such as "cat alg_qos".
26
27 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/qm_regs
28 Date:           Oct 2019
29 Contact:        linux-crypto@vger.kernel.org
30 Description:    Dump of QM related debug registers.
31                 Available for PF and VF in host. VF in guest currently only
32                 has one debug register.
33
34 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/current_q
35 Date:           Oct 2019
36 Contact:        linux-crypto@vger.kernel.org
37 Description:    One QM of SEC may contain multiple queues. Select specific
38                 queue to show its debug registers in above 'regs'.
39                 Only available for PF.
40
41 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/clear_enable
42 Date:           Oct 2019
43 Contact:        linux-crypto@vger.kernel.org
44 Description:    Enabling/disabling of clear action after reading
45                 the SEC's QM debug registers.
46                 0: disable, 1: enable.
47                 Only available for PF, and take no other effect on SEC.
48
49 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/err_irq
50 Date:           Apr 2020
51 Contact:        linux-crypto@vger.kernel.org
52 Description:    Dump the number of invalid interrupts for
53                 QM task completion.
54                 Available for both PF and VF, and take no other effect on SEC.
55
56 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/aeq_irq
57 Date:           Apr 2020
58 Contact:        linux-crypto@vger.kernel.org
59 Description:    Dump the number of QM async event queue interrupts.
60                 Available for both PF and VF, and take no other effect on SEC.
61
62 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/abnormal_irq
63 Date:           Apr 2020
64 Contact:        linux-crypto@vger.kernel.org
65 Description:    Dump the number of interrupts for QM abnormal event.
66                 Available for both PF and VF, and take no other effect on SEC.
67
68 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/create_qp_err
69 Date:           Apr 2020
70 Contact:        linux-crypto@vger.kernel.org
71 Description:    Dump the number of queue allocation errors.
72                 Available for both PF and VF, and take no other effect on SEC.
73
74 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/mb_err
75 Date:           Apr 2020
76 Contact:        linux-crypto@vger.kernel.org
77 Description:    Dump the number of failed QM mailbox commands.
78                 Available for both PF and VF, and take no other effect on SEC.
79
80 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/status
81 Date:           Apr 2020
82 Contact:        linux-crypto@vger.kernel.org
83 Description:    Dump the status of the QM.
84                 Four states: initiated, started, stopped and closed.
85                 Available for both PF and VF, and take no other effect on SEC.
86
87 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/diff_regs
88 Date:           Mar 2022
89 Contact:        linux-crypto@vger.kernel.org
90 Description:    QM debug registers(regs) read hardware register value. This
91                 node is used to show the change of the qm register values. This
92                 node can be help users to check the change of register values.
93
94 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/diff_regs
95 Date:           Mar 2022
96 Contact:        linux-crypto@vger.kernel.org
97 Description:    SEC debug registers(regs) read hardware register value. This
98                 node is used to show the change of the register values. This
99                 node can be help users to check the change of register values.
100
101 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/send_cnt
102 Date:           Apr 2020
103 Contact:        linux-crypto@vger.kernel.org
104 Description:    Dump the total number of sent requests.
105                 Available for both PF and VF, and take no other effect on SEC.
106
107 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/recv_cnt
108 Date:           Apr 2020
109 Contact:        linux-crypto@vger.kernel.org
110 Description:    Dump the total number of received requests.
111                 Available for both PF and VF, and take no other effect on SEC.
112
113 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/send_busy_cnt
114 Date:           Apr 2020
115 Contact:        linux-crypto@vger.kernel.org
116 Description:    Dump the total number of requests sent with returning busy.
117                 Available for both PF and VF, and take no other effect on SEC.
118
119 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/err_bd_cnt
120 Date:           Apr 2020
121 Contact:        linux-crypto@vger.kernel.org
122 Description:    Dump the total number of BD type error requests
123                 to be received.
124                 Available for both PF and VF, and take no other effect on SEC.
125
126 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/invalid_req_cnt
127 Date:           Apr 2020
128 Contact:        linux-crypto@vger.kernel.org
129 Description:    Dump the total number of invalid requests being received.
130                 Available for both PF and VF, and take no other effect on SEC.
131
132 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/done_flag_cnt
133 Date:           Apr 2020
134 Contact:        linux-crypto@vger.kernel.org
135 Description:    Dump the total number of completed but marked error requests
136                 to be received.
137                 Available for both PF and VF, and take no other effect on SEC.