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                 Two states: work, stop.
 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>/qm/qm_state
 115 Date:           Jan 2024
 116 Contact:        linux-crypto@vger.kernel.org
 117 Description:    Dump the state of the device.
 118                 0: busy, 1: idle.
 119                 Only available for PF, and take no other effect on HPRE.
 120
 121 What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/dev_timeout
 122 Date:           Feb 2024
 123 Contact:        linux-crypto@vger.kernel.org
 124 Description:    Set the wait time when stop queue fails. Available for both PF
 125                 and VF, and take no other effect on HPRE.
 126                 0: not wait(default), others value: wait dev_timeout * 20 microsecond.
 127
 128 What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/dev_state
 129 Date:           Feb 2024
 130 Contact:        linux-crypto@vger.kernel.org
 131 Description:    Dump the stop queue status of the QM. The default value is 0,
 132                 if dev_timeout is set, when stop queue fails, the dev_state
 133                 will return non-zero value. Available for both PF and VF,
 134                 and take no other effect on HPRE.
 135
 136 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/diff_regs
 137 Date:           Mar 2022
 138 Contact:        linux-crypto@vger.kernel.org
 139 Description:    HPRE debug registers(regs) read hardware register value. This
 140                 node is used to show the change of the register values. This
 141                 node can be help users to check the change of register values.
 142
 143 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_cnt
 144 Date:           Apr 2020
 145 Contact:        linux-crypto@vger.kernel.org
 146 Description:    Dump the total number of sent requests.
 147                 Available for both PF and VF, and take no other effect on HPRE.
 148
 149 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/recv_cnt
 150 Date:           Apr 2020
 151 Contact:        linux-crypto@vger.kernel.org
 152 Description:    Dump the total number of received requests.
 153                 Available for both PF and VF, and take no other effect on HPRE.
 154
 155 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_busy_cnt
 156 Date:           Apr 2020
 157 Contact:        linux-crypto@vger.kernel.org
 158 Description:    Dump the total number of requests sent
 159                 with returning busy.
 160                 Available for both PF and VF, and take no other effect on HPRE.
 161
 162 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_fail_cnt
 163 Date:           Apr 2020
 164 Contact:        linux-crypto@vger.kernel.org
 165 Description:    Dump the total number of completed but error requests.
 166                 Available for both PF and VF, and take no other effect on HPRE.
 167
 168 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/invalid_req_cnt
 169 Date:           Apr 2020
 170 Contact:        linux-crypto@vger.kernel.org
 171 Description:    Dump the total number of invalid requests being received.
 172                 Available for both PF and VF, and take no other effect on HPRE.
 173
 174 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/overtime_thrhld
 175 Date:           Apr 2020
 176 Contact:        linux-crypto@vger.kernel.org
 177 Description:    Set the threshold time for counting the request which is
 178                 processed longer than the threshold.
 179                 0: disable(default), 1: 1 microsecond.
 180                 Available for both PF and VF, and take no other effect on HPRE.
 181
 182 What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/over_thrhld_cnt
 183 Date:           Apr 2020
 184 Contact:        linux-crypto@vger.kernel.org
 185 Description:    Dump the total number of time out requests.
 186                 Available for both PF and VF, and take no other effect on HPRE.
 187
 188 What:           /sys/kernel/debug/hisi_hpre/<bdf>/cap_regs
 189 Date:           Oct 2024
 190 Contact:        linux-crypto@vger.kernel.org
 191 Description:    Dump the values of the qm and hpre capability bit registers and
 192                 support the query of device specifications to facilitate fault locating.
 193                 Available for both PF and VF, and take no other effect on HPRE.