Merge tag 'trace-printf-v6.13' of git://git.kernel.org/pub/scm/linux/kernel/git/trace...
[drm/drm-misc.git] / Documentation / ABI / testing / debugfs-hisi-sec
blob82bf4a0dc7f78a0839875b0a828641990e6e8a20
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.
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.
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".
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.
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.
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.
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.
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.
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.
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.
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.
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                 Two states: work, stop.
85                 Available for both PF and VF, and take no other effect on SEC.
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.
94 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/qm_state
95 Date:           Jan 2024
96 Contact:        linux-crypto@vger.kernel.org
97 Description:    Dump the state of the device.
98                 0: busy, 1: idle.
99                 Only available for PF, and take no other effect on SEC.
101 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/dev_timeout
102 Date:           Feb 2024
103 Contact:        linux-crypto@vger.kernel.org
104 Description:    Set the wait time when stop queue fails. Available for both PF
105                 and VF, and take no other effect on SEC.
106                 0: not wait(default), others value: wait dev_timeout * 20 microsecond.
108 What:           /sys/kernel/debug/hisi_sec2/<bdf>/qm/dev_state
109 Date:           Feb 2024
110 Contact:        linux-crypto@vger.kernel.org
111 Description:    Dump the stop queue status of the QM. The default value is 0,
112                 if dev_timeout is set, when stop queue fails, the dev_state
113                 will return non-zero value. Available for both PF and VF,
114                 and take no other effect on SEC.
116 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/diff_regs
117 Date:           Mar 2022
118 Contact:        linux-crypto@vger.kernel.org
119 Description:    SEC debug registers(regs) read hardware register value. This
120                 node is used to show the change of the register values. This
121                 node can be help users to check the change of register values.
123 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/send_cnt
124 Date:           Apr 2020
125 Contact:        linux-crypto@vger.kernel.org
126 Description:    Dump the total number of sent requests.
127                 Available for both PF and VF, and take no other effect on SEC.
129 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/recv_cnt
130 Date:           Apr 2020
131 Contact:        linux-crypto@vger.kernel.org
132 Description:    Dump the total number of received requests.
133                 Available for both PF and VF, and take no other effect on SEC.
135 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/send_busy_cnt
136 Date:           Apr 2020
137 Contact:        linux-crypto@vger.kernel.org
138 Description:    Dump the total number of requests sent with returning busy.
139                 Available for both PF and VF, and take no other effect on SEC.
141 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/err_bd_cnt
142 Date:           Apr 2020
143 Contact:        linux-crypto@vger.kernel.org
144 Description:    Dump the total number of BD type error requests
145                 to be received.
146                 Available for both PF and VF, and take no other effect on SEC.
148 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/invalid_req_cnt
149 Date:           Apr 2020
150 Contact:        linux-crypto@vger.kernel.org
151 Description:    Dump the total number of invalid requests being received.
152                 Available for both PF and VF, and take no other effect on SEC.
154 What:           /sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/done_flag_cnt
155 Date:           Apr 2020
156 Contact:        linux-crypto@vger.kernel.org
157 Description:    Dump the total number of completed but marked error requests
158                 to be received.
159                 Available for both PF and VF, and take no other effect on SEC.
161 What:           /sys/kernel/debug/hisi_sec2/<bdf>/cap_regs
162 Date:           Oct 2024
163 Contact:        linux-crypto@vger.kernel.org
164 Description:    Dump the values of the qm and sec capability bit registers and
165                 support the query of device specifications to facilitate fault locating.
166                 Available for both PF and VF, and take no other effect on SEC.