Linux 6.7-rc7
[linux-modified.git] / Documentation / ABI / testing / sysfs-driver-habanalabs
1 What:           /sys/class/accel/accel<n>/device/armcp_kernel_ver
2 Date:           Jan 2019
3 KernelVersion:  5.1
4 Contact:        ogabbay@kernel.org
5 Description:    Version of the Linux kernel running on the device's CPU.
6                 Will be DEPRECATED in Linux kernel version 5.10, and be
7                 replaced with cpucp_kernel_ver
8
9 What:           /sys/class/accel/accel<n>/device/armcp_ver
10 Date:           Jan 2019
11 KernelVersion:  5.1
12 Contact:        ogabbay@kernel.org
13 Description:    Version of the application running on the device's CPU
14                 Will be DEPRECATED in Linux kernel version 5.10, and be
15                 replaced with cpucp_ver
16
17 What:           /sys/class/accel/accel<n>/device/clk_max_freq_mhz
18 Date:           Jun 2019
19 KernelVersion:  5.7
20 Contact:        ogabbay@kernel.org
21 Description:    Allows the user to set the maximum clock frequency, in MHz.
22                 The device clock might be set to lower value than the maximum.
23                 The user should read the clk_cur_freq_mhz to see the actual
24                 frequency value of the device clock. This property is valid
25                 only for the Gaudi ASIC family
26
27 What:           /sys/class/accel/accel<n>/device/clk_cur_freq_mhz
28 Date:           Jun 2019
29 KernelVersion:  5.7
30 Contact:        ogabbay@kernel.org
31 Description:    Displays the current frequency, in MHz, of the device clock.
32                 This property is valid only for the Gaudi ASIC family
33
34 What:           /sys/class/accel/accel<n>/device/cpld_ver
35 Date:           Jan 2019
36 KernelVersion:  5.1
37 Contact:        ogabbay@kernel.org
38 Description:    Version of the Device's CPLD F/W
39
40 What:           /sys/class/accel/accel<n>/device/cpucp_kernel_ver
41 Date:           Oct 2020
42 KernelVersion:  5.10
43 Contact:        ogabbay@kernel.org
44 Description:    Version of the Linux kernel running on the device's CPU
45
46 What:           /sys/class/accel/accel<n>/device/cpucp_ver
47 Date:           Oct 2020
48 KernelVersion:  5.10
49 Contact:        ogabbay@kernel.org
50 Description:    Version of the application running on the device's CPU
51
52 What:           /sys/class/accel/accel<n>/device/device_type
53 Date:           Jan 2019
54 KernelVersion:  5.1
55 Contact:        ogabbay@kernel.org
56 Description:    Displays the code name of the device according to its type.
57                 The supported values are: "GOYA"
58
59 What:           /sys/class/accel/accel<n>/device/eeprom
60 Date:           Jan 2019
61 KernelVersion:  5.1
62 Contact:        ogabbay@kernel.org
63 Description:    A binary file attribute that contains the contents of the
64                 on-board EEPROM
65
66 What:           /sys/class/accel/accel<n>/device/fuse_ver
67 Date:           Jan 2019
68 KernelVersion:  5.1
69 Contact:        ogabbay@kernel.org
70 Description:    Displays the device's version from the eFuse
71
72 What:           /sys/class/accel/accel<n>/device/fw_os_ver
73 Date:           Dec 2021
74 KernelVersion:  5.18
75 Contact:        ogabbay@kernel.org
76 Description:    Version of the firmware OS running on the device's CPU
77
78 What:           /sys/class/accel/accel<n>/device/hard_reset
79 Date:           Jan 2019
80 KernelVersion:  5.1
81 Contact:        ogabbay@kernel.org
82 Description:    Interface to trigger a hard-reset operation for the device.
83                 Hard-reset will reset ALL internal components of the device
84                 except for the PCI interface and the internal PLLs
85
86 What:           /sys/class/accel/accel<n>/device/hard_reset_cnt
87 Date:           Jan 2019
88 KernelVersion:  5.1
89 Contact:        ogabbay@kernel.org
90 Description:    Displays how many times the device have undergone a hard-reset
91                 operation since the driver was loaded
92
93 What:           /sys/class/accel/accel<n>/device/high_pll
94 Date:           Jan 2019
95 KernelVersion:  5.1
96 Contact:        ogabbay@kernel.org
97 Description:    Allows the user to set the maximum clock frequency for MME, TPC
98                 and IC when the power management profile is set to "automatic".
99                 This property is valid only for the Goya ASIC family
100
101 What:           /sys/class/accel/accel<n>/device/ic_clk
102 Date:           Jan 2019
103 KernelVersion:  5.1
104 Contact:        ogabbay@kernel.org
105 Description:    Allows the user to set the maximum clock frequency, in Hz, of
106                 the Interconnect fabric. Writes to this parameter affect the
107                 device only when the power management profile is set to "manual"
108                 mode. The device IC clock might be set to lower value than the
109                 maximum. The user should read the ic_clk_curr to see the actual
110                 frequency value of the IC. This property is valid only for the
111                 Goya ASIC family
112
113 What:           /sys/class/accel/accel<n>/device/ic_clk_curr
114 Date:           Jan 2019
115 KernelVersion:  5.1
116 Contact:        ogabbay@kernel.org
117 Description:    Displays the current clock frequency, in Hz, of the Interconnect
118                 fabric. This property is valid only for the Goya ASIC family
119
120 What:           /sys/class/accel/accel<n>/device/infineon_ver
121 Date:           Jan 2019
122 KernelVersion:  5.1
123 Contact:        ogabbay@kernel.org
124 Description:    Version of the Device's power supply F/W code. Relevant only to GOYA and GAUDI
125
126 What:           /sys/class/accel/accel<n>/device/max_power
127 Date:           Jan 2019
128 KernelVersion:  5.1
129 Contact:        ogabbay@kernel.org
130 Description:    Allows the user to set the maximum power consumption of the
131                 device in milliwatts.
132
133 What:           /sys/class/accel/accel<n>/device/mme_clk
134 Date:           Jan 2019
135 KernelVersion:  5.1
136 Contact:        ogabbay@kernel.org
137 Description:    Allows the user to set the maximum clock frequency, in Hz, of
138                 the MME compute engine. Writes to this parameter affect the
139                 device only when the power management profile is set to "manual"
140                 mode. The device MME clock might be set to lower value than the
141                 maximum. The user should read the mme_clk_curr to see the actual
142                 frequency value of the MME. This property is valid only for the
143                 Goya ASIC family
144
145 What:           /sys/class/accel/accel<n>/device/mme_clk_curr
146 Date:           Jan 2019
147 KernelVersion:  5.1
148 Contact:        ogabbay@kernel.org
149 Description:    Displays the current clock frequency, in Hz, of the MME compute
150                 engine. This property is valid only for the Goya ASIC family
151
152 What:           /sys/class/accel/accel<n>/device/pci_addr
153 Date:           Jan 2019
154 KernelVersion:  5.1
155 Contact:        ogabbay@kernel.org
156 Description:    Displays the PCI address of the device. This is needed so the
157                 user would be able to open a device based on its PCI address
158
159 What:           /sys/class/accel/accel<n>/device/pm_mng_profile
160 Date:           Jan 2019
161 KernelVersion:  5.1
162 Contact:        ogabbay@kernel.org
163 Description:    Power management profile. Values are "auto", "manual". In "auto"
164                 mode, the driver will set the maximum clock frequency to a high
165                 value when a user-space process opens the device's file (unless
166                 it was already opened by another process). The driver will set
167                 the max clock frequency to a low value when there are no user
168                 processes that are opened on the device's file. In "manual"
169                 mode, the user sets the maximum clock frequency by writing to
170                 ic_clk, mme_clk and tpc_clk. This property is valid only for
171                 the Goya ASIC family
172
173 What:           /sys/class/accel/accel<n>/device/preboot_btl_ver
174 Date:           Jan 2019
175 KernelVersion:  5.1
176 Contact:        ogabbay@kernel.org
177 Description:    Version of the device's preboot F/W code
178
179 What:           /sys/class/accel/accel<n>/device/security_enabled
180 Date:           Oct 2022
181 KernelVersion:  6.1
182 Contact:        obitton@habana.ai
183 Description:    Displays the device's security status
184
185 What:           /sys/class/accel/accel<n>/device/soft_reset
186 Date:           Jan 2019
187 KernelVersion:  5.1
188 Contact:        ogabbay@kernel.org
189 Description:    Interface to trigger a soft-reset operation for the device.
190                 Soft-reset will reset only the compute and DMA engines of the
191                 device
192
193 What:           /sys/class/accel/accel<n>/device/soft_reset_cnt
194 Date:           Jan 2019
195 KernelVersion:  5.1
196 Contact:        ogabbay@kernel.org
197 Description:    Displays how many times the device have undergone a soft-reset
198                 operation since the driver was loaded
199
200 What:           /sys/class/accel/accel<n>/device/status
201 Date:           Jan 2019
202 KernelVersion:  5.1
203 Contact:        ogabbay@kernel.org
204 Description:    Status of the card:
205
206                   * "operational" - Device is available for work.
207                   * "in reset" - Device is going through reset, will be
208                     available shortly.
209                   * "disabled" - Device is not usable.
210                   * "needs reset" - Device is not usable until a hard reset
211                     is initiated.
212                   * "in device creation" - Device is not available yet, as it
213                     is still initializing.
214                   * "in reset after device release" - Device is going through
215                     a compute-reset which is executed after a device release
216                     (relevant for Gaudi2 only).
217
218 What:           /sys/class/accel/accel<n>/device/thermal_ver
219 Date:           Jan 2019
220 KernelVersion:  5.1
221 Contact:        ogabbay@kernel.org
222 Description:    Version of the Device's thermal daemon
223
224 What:           /sys/class/accel/accel<n>/device/tpc_clk
225 Date:           Jan 2019
226 KernelVersion:  5.1
227 Contact:        ogabbay@kernel.org
228 Description:    Allows the user to set the maximum clock frequency, in Hz, of
229                 the TPC compute engines. Writes to this parameter affect the
230                 device only when the power management profile is set to "manual"
231                 mode. The device TPC clock might be set to lower value than the
232                 maximum. The user should read the tpc_clk_curr to see the actual
233                 frequency value of the TPC. This property is valid only for
234                 Goya ASIC family
235
236 What:           /sys/class/accel/accel<n>/device/tpc_clk_curr
237 Date:           Jan 2019
238 KernelVersion:  5.1
239 Contact:        ogabbay@kernel.org
240 Description:    Displays the current clock frequency, in Hz, of the TPC compute
241                 engines. This property is valid only for the Goya ASIC family
242
243 What:           /sys/class/accel/accel<n>/device/uboot_ver
244 Date:           Jan 2019
245 KernelVersion:  5.1
246 Contact:        ogabbay@kernel.org
247 Description:    Version of the u-boot running on the device's CPU
248
249 What:           /sys/class/accel/accel<n>/device/vrm_ver
250 Date:           Jan 2022
251 KernelVersion:  5.17
252 Contact:        ogabbay@kernel.org
253 Description:    Version of the Device's Voltage Regulator Monitor F/W code. N/A to GOYA and GAUDI