Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[linux-2.6-microblaze.git] / Documentation / ABI / testing / sysfs-driver-habanalabs
1 What:           /sys/class/habanalabs/hl<n>/armcp_kernel_ver
2 Date:           Jan 2019
3 KernelVersion:  5.1
4 Contact:        oded.gabbay@gmail.com
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/habanalabs/hl<n>/armcp_ver
10 Date:           Jan 2019
11 KernelVersion:  5.1
12 Contact:        oded.gabbay@gmail.com
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/habanalabs/hl<n>/clk_max_freq_mhz
18 Date:           Jun 2019
19 KernelVersion:  not yet upstreamed
20 Contact:        oded.gabbay@gmail.com
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/habanalabs/hl<n>/clk_cur_freq_mhz
28 Date:           Jun 2019
29 KernelVersion:  not yet upstreamed
30 Contact:        oded.gabbay@gmail.com
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/habanalabs/hl<n>/cpld_ver
35 Date:           Jan 2019
36 KernelVersion:  5.1
37 Contact:        oded.gabbay@gmail.com
38 Description:    Version of the Device's CPLD F/W
39
40 What:           /sys/class/habanalabs/hl<n>/cpucp_kernel_ver
41 Date:           Oct 2020
42 KernelVersion:  5.10
43 Contact:        oded.gabbay@gmail.com
44 Description:    Version of the Linux kernel running on the device's CPU
45
46 What:           /sys/class/habanalabs/hl<n>/cpucp_ver
47 Date:           Oct 2020
48 KernelVersion:  5.10
49 Contact:        oded.gabbay@gmail.com
50 Description:    Version of the application running on the device's CPU
51
52 What:           /sys/class/habanalabs/hl<n>/device_type
53 Date:           Jan 2019
54 KernelVersion:  5.1
55 Contact:        oded.gabbay@gmail.com
56 Description:    Displays the code name of the device according to its type.
57                 The supported values are: "GOYA"
58
59 What:           /sys/class/habanalabs/hl<n>/eeprom
60 Date:           Jan 2019
61 KernelVersion:  5.1
62 Contact:        oded.gabbay@gmail.com
63 Description:    A binary file attribute that contains the contents of the
64                 on-board EEPROM
65
66 What:           /sys/class/habanalabs/hl<n>/fuse_ver
67 Date:           Jan 2019
68 KernelVersion:  5.1
69 Contact:        oded.gabbay@gmail.com
70 Description:    Displays the device's version from the eFuse
71
72 What:           /sys/class/habanalabs/hl<n>/hard_reset
73 Date:           Jan 2019
74 KernelVersion:  5.1
75 Contact:        oded.gabbay@gmail.com
76 Description:    Interface to trigger a hard-reset operation for the device.
77                 Hard-reset will reset ALL internal components of the device
78                 except for the PCI interface and the internal PLLs
79
80 What:           /sys/class/habanalabs/hl<n>/hard_reset_cnt
81 Date:           Jan 2019
82 KernelVersion:  5.1
83 Contact:        oded.gabbay@gmail.com
84 Description:    Displays how many times the device have undergone a hard-reset
85                 operation since the driver was loaded
86
87 What:           /sys/class/habanalabs/hl<n>/high_pll
88 Date:           Jan 2019
89 KernelVersion:  5.1
90 Contact:        oded.gabbay@gmail.com
91 Description:    Allows the user to set the maximum clock frequency for MME, TPC
92                 and IC when the power management profile is set to "automatic".
93                 This property is valid only for the Goya ASIC family
94
95 What:           /sys/class/habanalabs/hl<n>/ic_clk
96 Date:           Jan 2019
97 KernelVersion:  5.1
98 Contact:        oded.gabbay@gmail.com
99 Description:    Allows the user to set the maximum clock frequency, in Hz, of
100                 the Interconnect fabric. Writes to this parameter affect the
101                 device only when the power management profile is set to "manual"
102                 mode. The device IC clock might be set to lower value than the
103                 maximum. The user should read the ic_clk_curr to see the actual
104                 frequency value of the IC. This property is valid only for the
105                 Goya ASIC family
106
107 What:           /sys/class/habanalabs/hl<n>/ic_clk_curr
108 Date:           Jan 2019
109 KernelVersion:  5.1
110 Contact:        oded.gabbay@gmail.com
111 Description:    Displays the current clock frequency, in Hz, of the Interconnect
112                 fabric. This property is valid only for the Goya ASIC family
113
114 What:           /sys/class/habanalabs/hl<n>/infineon_ver
115 Date:           Jan 2019
116 KernelVersion:  5.1
117 Contact:        oded.gabbay@gmail.com
118 Description:    Version of the Device's power supply F/W code
119
120 What:           /sys/class/habanalabs/hl<n>/max_power
121 Date:           Jan 2019
122 KernelVersion:  5.1
123 Contact:        oded.gabbay@gmail.com
124 Description:    Allows the user to set the maximum power consumption of the
125                 device in milliwatts.
126
127 What:           /sys/class/habanalabs/hl<n>/mme_clk
128 Date:           Jan 2019
129 KernelVersion:  5.1
130 Contact:        oded.gabbay@gmail.com
131 Description:    Allows the user to set the maximum clock frequency, in Hz, of
132                 the MME compute engine. Writes to this parameter affect the
133                 device only when the power management profile is set to "manual"
134                 mode. The device MME clock might be set to lower value than the
135                 maximum. The user should read the mme_clk_curr to see the actual
136                 frequency value of the MME. This property is valid only for the
137                 Goya ASIC family
138
139 What:           /sys/class/habanalabs/hl<n>/mme_clk_curr
140 Date:           Jan 2019
141 KernelVersion:  5.1
142 Contact:        oded.gabbay@gmail.com
143 Description:    Displays the current clock frequency, in Hz, of the MME compute
144                 engine. This property is valid only for the Goya ASIC family
145
146 What:           /sys/class/habanalabs/hl<n>/pci_addr
147 Date:           Jan 2019
148 KernelVersion:  5.1
149 Contact:        oded.gabbay@gmail.com
150 Description:    Displays the PCI address of the device. This is needed so the
151                 user would be able to open a device based on its PCI address
152
153 What:           /sys/class/habanalabs/hl<n>/pm_mng_profile
154 Date:           Jan 2019
155 KernelVersion:  5.1
156 Contact:        oded.gabbay@gmail.com
157 Description:    Power management profile. Values are "auto", "manual". In "auto"
158                 mode, the driver will set the maximum clock frequency to a high
159                 value when a user-space process opens the device's file (unless
160                 it was already opened by another process). The driver will set
161                 the max clock frequency to a low value when there are no user
162                 processes that are opened on the device's file. In "manual"
163                 mode, the user sets the maximum clock frequency by writing to
164                 ic_clk, mme_clk and tpc_clk. This property is valid only for
165                 the Goya ASIC family
166
167 What:           /sys/class/habanalabs/hl<n>/preboot_btl_ver
168 Date:           Jan 2019
169 KernelVersion:  5.1
170 Contact:        oded.gabbay@gmail.com
171 Description:    Version of the device's preboot F/W code
172
173 What:           /sys/class/habanalabs/hl<n>/soft_reset
174 Date:           Jan 2019
175 KernelVersion:  5.1
176 Contact:        oded.gabbay@gmail.com
177 Description:    Interface to trigger a soft-reset operation for the device.
178                 Soft-reset will reset only the compute and DMA engines of the
179                 device
180
181 What:           /sys/class/habanalabs/hl<n>/soft_reset_cnt
182 Date:           Jan 2019
183 KernelVersion:  5.1
184 Contact:        oded.gabbay@gmail.com
185 Description:    Displays how many times the device have undergone a soft-reset
186                 operation since the driver was loaded
187
188 What:           /sys/class/habanalabs/hl<n>/status
189 Date:           Jan 2019
190 KernelVersion:  5.1
191 Contact:        oded.gabbay@gmail.com
192 Description:    Status of the card: "Operational", "Malfunction", "In reset".
193
194 What:           /sys/class/habanalabs/hl<n>/thermal_ver
195 Date:           Jan 2019
196 KernelVersion:  5.1
197 Contact:        oded.gabbay@gmail.com
198 Description:    Version of the Device's thermal daemon
199
200 What:           /sys/class/habanalabs/hl<n>/tpc_clk
201 Date:           Jan 2019
202 KernelVersion:  5.1
203 Contact:        oded.gabbay@gmail.com
204 Description:    Allows the user to set the maximum clock frequency, in Hz, of
205                 the TPC compute engines. Writes to this parameter affect the
206                 device only when the power management profile is set to "manual"
207                 mode. The device TPC clock might be set to lower value than the
208                 maximum. The user should read the tpc_clk_curr to see the actual
209                 frequency value of the TPC. This property is valid only for
210                 Goya ASIC family
211
212 What:           /sys/class/habanalabs/hl<n>/tpc_clk_curr
213 Date:           Jan 2019
214 KernelVersion:  5.1
215 Contact:        oded.gabbay@gmail.com
216 Description:    Displays the current clock frequency, in Hz, of the TPC compute
217                 engines. This property is valid only for the Goya ASIC family
218
219 What:           /sys/class/habanalabs/hl<n>/uboot_ver
220 Date:           Jan 2019
221 KernelVersion:  5.1
222 Contact:        oded.gabbay@gmail.com
223 Description:    Version of the u-boot running on the device's CPU