Documentation/ABI/testing/debugfs-hisi-zip

   1 What:           /sys/kernel/debug/hisi_zip/<bdf>/comp_core[01]/regs
   2 Date:           Nov 2018
   3 Contact:        linux-crypto@vger.kernel.org
   4 Description:    Dump of compression cores related debug registers.
   5                 Only available for PF.
   6
   7 What:           /sys/kernel/debug/hisi_zip/<bdf>/decomp_core[0-5]/regs
   8 Date:           Nov 2018
   9 Contact:        linux-crypto@vger.kernel.org
  10 Description:    Dump of decompression cores related debug registers.
  11                 Only available for PF.
  12
  13 What:           /sys/kernel/debug/hisi_zip/<bdf>/clear_enable
  14 Date:           Nov 2018
  15 Contact:        linux-crypto@vger.kernel.org
  16 Description:    Compression/decompression core debug registers read clear
  17                 control. 1 means enable register read clear, otherwise 0.
  18                 Writing to this file has no functional effect, only enable or
  19                 disable counters clear after reading of these registers.
  20                 Only available for PF.
  21
  22 What:           /sys/kernel/debug/hisi_zip/<bdf>/current_qm
  23 Date:           Nov 2018
  24 Contact:        linux-crypto@vger.kernel.org
  25 Description:    One ZIP controller has one PF and multiple VFs, each function
  26                 has a QM. Select the QM which below qm refers to.
  27                 Only available for PF.
  28
  29 What:           /sys/kernel/debug/hisi_zip/<bdf>/alg_qos
  30 Date:           Jun 2021
  31 Contact:        linux-crypto@vger.kernel.org
  32 Description:    The <bdf> is related the function for PF and VF.
  33                 ZIP driver supports to configure each function's QoS, the driver
  34                 supports to write <bdf> value to alg_qos in the host. Such as
  35                 "echo <bdf> value > alg_qos". The qos value is 1~1000, means
  36                 1/1000~1000/1000 of total QoS. The driver reading alg_qos to
  37                 get related QoS in the host and VM, Such as "cat alg_qos".
  38
  39 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/regs
  40 Date:           Nov 2018
  41 Contact:        linux-crypto@vger.kernel.org
  42 Description:    Dump of QM related debug registers.
  43                 Available for PF and VF in host. VF in guest currently only
  44                 has one debug register.
  45
  46 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/current_q
  47 Date:           Nov 2018
  48 Contact:        linux-crypto@vger.kernel.org
  49 Description:    One QM may contain multiple queues. Select specific queue to
  50                 show its debug registers in above regs.
  51                 Only available for PF.
  52
  53 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/clear_enable
  54 Date:           Nov 2018
  55 Contact:        linux-crypto@vger.kernel.org
  56 Description:    QM debug registers(regs) read clear control. 1 means enable
  57                 register read clear, otherwise 0.
  58                 Writing to this file has no functional effect, only enable or
  59                 disable counters clear after reading of these registers.
  60                 Only available for PF.
  61
  62 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/err_irq
  63 Date:           Apr 2020
  64 Contact:        linux-crypto@vger.kernel.org
  65 Description:    Dump the number of invalid interrupts for
  66                 QM task completion.
  67                 Available for both PF and VF, and take no other effect on ZIP.
  68
  69 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/aeq_irq
  70 Date:           Apr 2020
  71 Contact:        linux-crypto@vger.kernel.org
  72 Description:    Dump the number of QM async event queue interrupts.
  73                 Available for both PF and VF, and take no other effect on ZIP.
  74
  75 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/abnormal_irq
  76 Date:           Apr 2020
  77 Contact:        linux-crypto@vger.kernel.org
  78 Description:    Dump the number of interrupts for QM abnormal event.
  79                 Available for both PF and VF, and take no other effect on ZIP.
  80
  81 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/create_qp_err
  82 Date:           Apr 2020
  83 Contact:        linux-crypto@vger.kernel.org
  84 Description:    Dump the number of queue allocation errors.
  85                 Available for both PF and VF, and take no other effect on ZIP.
  86
  87 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/mb_err
  88 Date:           Apr 2020
  89 Contact:        linux-crypto@vger.kernel.org
  90 Description:    Dump the number of failed QM mailbox commands.
  91                 Available for both PF and VF, and take no other effect on ZIP.
  92
  93 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/status
  94 Date:           Apr 2020
  95 Contact:        linux-crypto@vger.kernel.org
  96 Description:    Dump the status of the QM.
  97                 Two states: work, stop.
  98                 Available for both PF and VF, and take no other effect on ZIP.
  99
 100 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/diff_regs
 101 Date:           Mar 2022
 102 Contact:        linux-crypto@vger.kernel.org
 103 Description:    QM debug registers(regs) read hardware register value. This
 104                 node is used to show the change of the qm registers value. This
 105                 node can be help users to check the change of register values.
 106
 107 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/qm_state
 108 Date:           Jan 2024
 109 Contact:        linux-crypto@vger.kernel.org
 110 Description:    Dump the state of the device.
 111                 0: busy, 1: idle.
 112                 Only available for PF, and take no other effect on ZIP.
 113
 114 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/dev_timeout
 115 Date:           Feb 2024
 116 Contact:        linux-crypto@vger.kernel.org
 117 Description:    Set the wait time when stop queue fails. Available for both PF
 118                 and VF, and take no other effect on ZIP.
 119                 0: not wait(default), others value: wait dev_timeout * 20 microsecond.
 120
 121 What:           /sys/kernel/debug/hisi_zip/<bdf>/qm/dev_state
 122 Date:           Feb 2024
 123 Contact:        linux-crypto@vger.kernel.org
 124 Description:    Dump the stop queue status of the QM. The default value is 0,
 125                 if dev_timeout is set, when stop queue fails, the dev_state
 126                 will return non-zero value. Available for both PF and VF,
 127                 and take no other effect on ZIP.
 128
 129 What:           /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/diff_regs
 130 Date:           Mar 2022
 131 Contact:        linux-crypto@vger.kernel.org
 132 Description:    ZIP debug registers(regs) read hardware register value. This
 133                 node is used to show the change of the registers value. this
 134                 node can be help users to check the change of register values.
 135
 136 What:           /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/send_cnt
 137 Date:           Apr 2020
 138 Contact:        linux-crypto@vger.kernel.org
 139 Description:    Dump the total number of sent requests.
 140                 Available for both PF and VF, and take no other effect on ZIP.
 141
 142 What:           /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/recv_cnt
 143 Date:           Apr 2020
 144 Contact:        linux-crypto@vger.kernel.org
 145 Description:    Dump the total number of received requests.
 146                 Available for both PF and VF, and take no other effect on ZIP.
 147
 148 What:           /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/send_busy_cnt
 149 Date:           Apr 2020
 150 Contact:        linux-crypto@vger.kernel.org
 151 Description:    Dump the total number of requests received
 152                 with returning busy.
 153                 Available for both PF and VF, and take no other effect on ZIP.
 154
 155 What:           /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/err_bd_cnt
 156 Date:           Apr 2020
 157 Contact:        linux-crypto@vger.kernel.org
 158 Description:    Dump the total number of BD type error requests
 159                 to be received.
 160                 Available for both PF and VF, and take no other effect on ZIP.