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