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