요약·해설과 원문, 전문 번역을 서로 분리했습니다. API 이름, symbol, source path는 원문 표기를 사용합니다.
1. 요약·해설
원문의 핵심 논리와 kernel programming 관점의 보충 설명입니다. 아래의 전문 번역과는 별도로 작성했습니다.
QM interrupts, errors, status
debugfs-hisi-zip:62-98PF와 VF에서 task completion invalid IRQ, async·abnormal events, queue allocation·mailbox errors와 QM work·stop status를 보고합니다.
QM register changes와 stop timeout
debugfs-hisi-zip:100-127QM register 변화와 busy·idle state를 표시하고 stop queue failure의 wait time과 resulting state를 제공합니다.
ZIP request DFX counters
debugfs-hisi-zip:129-160ZIP register 변화와 sent·received·busy 및 BD type error requests를 계수합니다.
QM·ZIP capability registers
debugfs-hisi-zip:162-167PF와 VF에서 QM·ZIP capability bit registers를 dump해 device specification 조회와 fault locating을 지원합니다.
2. 영어 원문 전체
번역 기준이 된 Linux v6.18.37 원문입니다. 줄 번호는 이 버전의 파일 좌표입니다.
원문 전체 펼치기
1
What: /sys/kernel/debug/hisi_zip/<bdf>/comp_core[01]/regs
2
Date: Nov 2018
3
Contact: [email protected]
4
Description: Dump of compression cores related debug registers.
5
Only available for PF.
7
What: /sys/kernel/debug/hisi_zip/<bdf>/decomp_core[0-5]/regs
8
Date: Nov 2018
9
Contact: [email protected]
10
Description: Dump of decompression cores related debug registers.
11
Only available for PF.
13
What: /sys/kernel/debug/hisi_zip/<bdf>/clear_enable
14
Date: Nov 2018
15
Contact: [email protected]
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.
22
What: /sys/kernel/debug/hisi_zip/<bdf>/current_qm
23
Date: Nov 2018
24
Contact: [email protected]
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.
29
What: /sys/kernel/debug/hisi_zip/<bdf>/alg_qos
30
Date: Jun 2021
31
Contact: [email protected]
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".
39
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/regs
40
Date: Nov 2018
41
Contact: [email protected]
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.
46
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/current_q
47
Date: Nov 2018
48
Contact: [email protected]
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.
53
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/clear_enable
54
Date: Nov 2018
55
Contact: [email protected]
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.
62
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/err_irq
63
Date: Apr 2020
64
Contact: [email protected]
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.
69
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/aeq_irq
70
Date: Apr 2020
71
Contact: [email protected]
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.
75
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/abnormal_irq
76
Date: Apr 2020
77
Contact: [email protected]
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.
81
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/create_qp_err
82
Date: Apr 2020
83
Contact: [email protected]
84
Description: Dump the number of queue allocation errors.
85
Available for both PF and VF, and take no other effect on ZIP.
87
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/mb_err
88
Date: Apr 2020
89
Contact: [email protected]
90
Description: Dump the number of failed QM mailbox commands.
91
Available for both PF and VF, and take no other effect on ZIP.
93
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/status
94
Date: Apr 2020
95
Contact: [email protected]
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.
100
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/diff_regs
101
Date: Mar 2022
102
Contact: [email protected]
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.
107
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/qm_state
108
Date: Jan 2024
109
Contact: [email protected]
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.
114
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/dev_timeout
115
Date: Feb 2024
116
Contact: [email protected]
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.
121
What: /sys/kernel/debug/hisi_zip/<bdf>/qm/dev_state
122
Date: Feb 2024
123
Contact: [email protected]
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.
129
What: /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/diff_regs
130
Date: Mar 2022
131
Contact: [email protected]
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.
136
What: /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/send_cnt
137
Date: Apr 2020
138
Contact: [email protected]
139
Description: Dump the total number of sent requests.
140
Available for both PF and VF, and take no other effect on ZIP.
142
What: /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/recv_cnt
143
Date: Apr 2020
144
Contact: [email protected]
145
Description: Dump the total number of received requests.
146
Available for both PF and VF, and take no other effect on ZIP.
148
What: /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/send_busy_cnt
149
Date: Apr 2020
150
Contact: [email protected]
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.
155
What: /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/err_bd_cnt
156
Date: Apr 2020
157
Contact: [email protected]
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.
162
What: /sys/kernel/debug/hisi_zip/<bdf>/cap_regs
163
Date: Oct 2024
164
Contact: [email protected]
165
Description: Dump the values of the qm and zip capability bit registers and
166
support the query of device specifications to facilitate fault locating.
167
Available for both PF and VF, and take no other effect on ZIP.
3. 한국어 전문 번역
영어 원문의 문단 순서와 의미를 유지한 전체 번역입니다. 코드, 함수명, symbol과 URL은 원문 표기를 유지합니다.
Compression·decompression cores와 function QM
1-44이 문서의 모든 항목 담당자는 [email protected]입니다.
| What | Date | 설명 | 범위 |
|---|---|---|---|
| /sys/kernel/debug/hisi_zip/<bdf>/comp_core[01]/regs | 2018년 11월 | Compression cores 관련 debug registers를 dump합니다. | PF only |
| /sys/kernel/debug/hisi_zip/<bdf>/decomp_core[0-5]/regs | 2018년 11월 | Decompression cores 관련 debug registers를 dump합니다. | PF only |
| /sys/kernel/debug/hisi_zip/<bdf>/clear_enable | 2018년 11월 | Compression·decompression core debug register read-clear control입니다. 1이면 enable, 0이면 disable입니다. 기능 동작에는 영향을 주지 않고 registers를 읽은 뒤 counters를 지울지만 제어합니다. | PF only |
| /sys/kernel/debug/hisi_zip/<bdf>/current_qm | 2018년 11월 | ZIP controller 하나에는 PF 하나와 여러 VFs가 있고 각 function은 QM을 가집니다. 아래 qm nodes가 참조할 QM을 선택합니다. | PF only |
| /sys/kernel/debug/hisi_zip/<bdf>/alg_qos | 2021년 6월 | PF 또는 VF function을 나타내는 <bdf>의 QoS를 구성합니다. 값 1..1000은 total QoS의 1/1000..1000/1000을 뜻합니다. Host와 VM에서 읽어 관련 QoS를 확인합니다. | PF and VF function |
| /sys/kernel/debug/hisi_zip/<bdf>/qm/regs | 2018년 11월 | QM 관련 debug registers를 dump합니다. | Host의 PF와 VF. Guest VF는 현재 debug register 하나만 제공 |
echo <bdf> value > alg_qos
cat alg_qosQM queue selector와 read-clear
46-60| What | Date | 설명 | 범위 |
|---|---|---|---|
| /sys/kernel/debug/hisi_zip/<bdf>/qm/current_q | 2018년 11월 | QM에 여러 queues가 있을 때 위 regs에 표시할 특정 queue를 선택합니다. | PF only |
| /sys/kernel/debug/hisi_zip/<bdf>/qm/clear_enable | 2018년 11월 | QM debug register read-clear control입니다. 1이면 enable, 0이면 disable입니다. 기능 동작에는 영향을 주지 않고 registers를 읽은 뒤 counters를 지울지만 제어합니다. | PF only |
comp_core[01]→Compression core regs
decomp_core[0-5]→Decompression core regs
current_qm→Selected PF or VF QM→qm/current_q→Selected queue→qm/regs
Core register dump는 core index로 직접 나뉘고, QM subtree는 current_qm과 current_q 두 selector가 function과 queue를 차례로 고른다.
QM IRQ·error counters와 status
62-98아래 항목은 PF와 VF 모두에서 사용할 수 있고 ZIP 동작에 다른 영향을 주지 않습니다.
| What | Date | 설명 |
|---|---|---|
| /sys/kernel/debug/hisi_zip/<bdf>/qm/err_irq | 2020년 4월 | QM task completion의 invalid interrupt 수를 dump합니다. |
| /sys/kernel/debug/hisi_zip/<bdf>/qm/aeq_irq | 2020년 4월 | QM async event queue interrupt 수를 dump합니다. |
| /sys/kernel/debug/hisi_zip/<bdf>/qm/abnormal_irq | 2020년 4월 | QM abnormal event interrupt 수를 dump합니다. |
| /sys/kernel/debug/hisi_zip/<bdf>/qm/create_qp_err | 2020년 4월 | Queue allocation error 수를 dump합니다. |
| /sys/kernel/debug/hisi_zip/<bdf>/qm/mb_err | 2020년 4월 | 실패한 QM mailbox command 수를 dump합니다. |
| /sys/kernel/debug/hisi_zip/<bdf>/qm/status | 2020년 4월 | QM status를 dump합니다. 가능한 state는 work와 stop입니다. |
QM register changes와 stop-queue state
100-127| What | Date | 설명 | 범위 |
|---|---|---|---|
| /sys/kernel/debug/hisi_zip/<bdf>/qm/diff_regs | 2022년 3월 | QM debug registers의 hardware register values를 읽어 QM register 값의 변화를 표시하고 확인하도록 돕습니다. | 문서에 PF/VF 제한 미기재 |
| /sys/kernel/debug/hisi_zip/<bdf>/qm/qm_state | 2024년 1월 | Device state를 dump합니다. 0은 busy, 1은 idle이며 ZIP 동작에 다른 영향을 주지 않습니다. | PF only |
| /sys/kernel/debug/hisi_zip/<bdf>/qm/dev_timeout | 2024년 2월 | Stop queue가 실패했을 때 기다릴 시간을 설정합니다. 0은 기다리지 않는 기본값이고 그 밖의 값은 dev_timeout × 20 microseconds만큼 기다립니다. ZIP 동작에 다른 영향을 주지 않습니다. | PF and VF |
| /sys/kernel/debug/hisi_zip/<bdf>/qm/dev_state | 2024년 2월 | QM stop-queue status를 dump합니다. 기본값은 0입니다. dev_timeout이 설정된 상태에서 stop queue가 실패하면 non-zero를 반환하며 ZIP 동작에 다른 영향을 주지 않습니다. | PF and VF |
Stop queue request→Success→dev_state = 0
Stop queue failure→dev_timeout = 0→No wait
Stop queue failure→dev_timeout > 0→Wait dev_timeout × 20 µs→Still failed→dev_state ≠ 0
Stop queue 실패 시 dev_timeout이 지정되면 20 µs 단위로 기다리고 최종 실패를 dev_state의 non-zero 값으로 보고한다.
ZIP DFX registers와 request counters
129-160| What | Date | 설명 | 범위 |
|---|---|---|---|
| /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/diff_regs | 2022년 3월 | ZIP debug registers의 hardware register values를 읽어 register 값의 변화를 표시하고 확인하도록 돕습니다. | 문서에 PF/VF 제한 미기재 |
| /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/send_cnt | 2020년 4월 | 보낸 request 총수를 dump합니다. | PF and VF |
| /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/recv_cnt | 2020년 4월 | 받은 request 총수를 dump합니다. | PF and VF |
| /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/send_busy_cnt | 2020년 4월 | 수신되었지만 busy를 반환한 request 총수를 dump합니다. 원문의 received 표현을 보존합니다. | PF and VF |
| /sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/err_bd_cnt | 2020년 4월 | 수신한 BD type error request 총수를 dump합니다. | PF and VF |
PF·VF 공통 counters는 ZIP 동작에 다른 영향을 주지 않습니다.
Request sent→send_cnt→Response received→recv_cnt
Request returns busy→send_busy_cnt
BD type error received→err_bd_cnt
기본 send·receive 흐름에서 busy와 BD type error 결과를 별도 counters로 분리한다.
QM·ZIP capability bit registers
162-167| 항목 | 내용 |
|---|---|
| What | /sys/kernel/debug/hisi_zip/<bdf>/cap_regs |
| Date | 2024년 10월 |
| Contact | [email protected] |
| Description | QM과 ZIP capability bit register 값을 dump하고 device specification 조회를 지원해 fault locating을 쉽게 합니다. |
| 범위 | PF와 VF 모두에서 사용 가능하며 ZIP 동작에 다른 영향을 주지 않음 |
Compression cores와 QM selectors
debugfs-hisi-zip:1-60PF에서 compression·decompression core registers와 read-clear를 제어하고 function QM·queue를 선택하며 PF·VF QoS와 QM register dump를 제공합니다.