xref: /linux/Documentation/ABI/testing/debugfs-driver-habanalabs (revision 3e98a021cc85e7d52acdd1eae8a988e975ec5bf9)
1What:           /sys/kernel/debug/habanalabs/hl<n>/addr
2Date:           Jan 2019
3KernelVersion:  5.1
4Contact:        oded.gabbay@gmail.com
5Description:    Sets the device address to be used for read or write through
6                PCI bar, or the device VA of a host mapped memory to be read or
7                written directly from the host. The latter option is allowed
8                only when the IOMMU is disabled.
9                The acceptable value is a string that starts with "0x"
10
11What:           /sys/kernel/debug/habanalabs/hl<n>/clk_gate
12Date:           May 2020
13KernelVersion:  5.8
14Contact:        oded.gabbay@gmail.com
15Description:    Allow the root user to disable/enable in runtime the clock
16                gating mechanism in Gaudi. Due to how Gaudi is built, the
17                clock gating needs to be disabled in order to access the
18                registers of the TPC and MME engines. This is sometimes needed
19                during debug by the user and hence the user needs this option.
20                The user can supply a bitmask value, each bit represents
21                a different engine to disable/enable its clock gating feature.
22                The bitmask is composed of 20 bits:
23
24		=======   ============
25                0  -  7   DMA channels
26                8  - 11   MME engines
27                12 - 19   TPC engines
28		=======   ============
29
30                The bit's location of a specific engine can be determined
31                using (1 << GAUDI_ENGINE_ID_*). GAUDI_ENGINE_ID_* values
32                are defined in uapi habanalabs.h file in enum gaudi_engine_id
33
34What:           /sys/kernel/debug/habanalabs/hl<n>/command_buffers
35Date:           Jan 2019
36KernelVersion:  5.1
37Contact:        oded.gabbay@gmail.com
38Description:    Displays a list with information about the currently allocated
39                command buffers
40
41What:           /sys/kernel/debug/habanalabs/hl<n>/command_submission
42Date:           Jan 2019
43KernelVersion:  5.1
44Contact:        oded.gabbay@gmail.com
45Description:    Displays a list with information about the currently active
46                command submissions
47
48What:           /sys/kernel/debug/habanalabs/hl<n>/command_submission_jobs
49Date:           Jan 2019
50KernelVersion:  5.1
51Contact:        oded.gabbay@gmail.com
52Description:    Displays a list with detailed information about each JOB (CB) of
53                each active command submission
54
55What:           /sys/kernel/debug/habanalabs/hl<n>/data32
56Date:           Jan 2019
57KernelVersion:  5.1
58Contact:        oded.gabbay@gmail.com
59Description:    Allows the root user to read or write directly through the
60                device's PCI bar. Writing to this file generates a write
61                transaction while reading from the file generates a read
62                transaction. This custom interface is needed (instead of using
63                the generic Linux user-space PCI mapping) because the DDR bar
64                is very small compared to the DDR memory and only the driver can
65                move the bar before and after the transaction.
66
67                If the IOMMU is disabled, it also allows the root user to read
68                or write from the host a device VA of a host mapped memory
69
70What:           /sys/kernel/debug/habanalabs/hl<n>/data64
71Date:           Jan 2020
72KernelVersion:  5.6
73Contact:        oded.gabbay@gmail.com
74Description:    Allows the root user to read or write 64 bit data directly
75                through the device's PCI bar. Writing to this file generates a
76                write transaction while reading from the file generates a read
77                transaction. This custom interface is needed (instead of using
78                the generic Linux user-space PCI mapping) because the DDR bar
79                is very small compared to the DDR memory and only the driver can
80                move the bar before and after the transaction.
81
82                If the IOMMU is disabled, it also allows the root user to read
83                or write from the host a device VA of a host mapped memory
84
85What:           /sys/kernel/debug/habanalabs/hl<n>/device
86Date:           Jan 2019
87KernelVersion:  5.1
88Contact:        oded.gabbay@gmail.com
89Description:    Enables the root user to set the device to specific state.
90                Valid values are "disable", "enable", "suspend", "resume".
91                User can read this property to see the valid values
92
93What:           /sys/kernel/debug/habanalabs/hl<n>/engines
94Date:           Jul 2019
95KernelVersion:  5.3
96Contact:        oded.gabbay@gmail.com
97Description:    Displays the status registers values of the device engines and
98                their derived idle status
99
100What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_addr
101Date:           Jan 2019
102KernelVersion:  5.1
103Contact:        oded.gabbay@gmail.com
104Description:    Sets I2C device address for I2C transaction that is generated
105                by the device's CPU
106
107What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_bus
108Date:           Jan 2019
109KernelVersion:  5.1
110Contact:        oded.gabbay@gmail.com
111Description:    Sets I2C bus address for I2C transaction that is generated by
112                the device's CPU
113
114What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_data
115Date:           Jan 2019
116KernelVersion:  5.1
117Contact:        oded.gabbay@gmail.com
118Description:    Triggers an I2C transaction that is generated by the device's
119                CPU. Writing to this file generates a write transaction while
120                reading from the file generates a read transcation
121
122What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_reg
123Date:           Jan 2019
124KernelVersion:  5.1
125Contact:        oded.gabbay@gmail.com
126Description:    Sets I2C register id for I2C transaction that is generated by
127                the device's CPU
128
129What:           /sys/kernel/debug/habanalabs/hl<n>/led0
130Date:           Jan 2019
131KernelVersion:  5.1
132Contact:        oded.gabbay@gmail.com
133Description:    Sets the state of the first S/W led on the device
134
135What:           /sys/kernel/debug/habanalabs/hl<n>/led1
136Date:           Jan 2019
137KernelVersion:  5.1
138Contact:        oded.gabbay@gmail.com
139Description:    Sets the state of the second S/W led on the device
140
141What:           /sys/kernel/debug/habanalabs/hl<n>/led2
142Date:           Jan 2019
143KernelVersion:  5.1
144Contact:        oded.gabbay@gmail.com
145Description:    Sets the state of the third S/W led on the device
146
147What:           /sys/kernel/debug/habanalabs/hl<n>/mmu
148Date:           Jan 2019
149KernelVersion:  5.1
150Contact:        oded.gabbay@gmail.com
151Description:    Displays the hop values and physical address for a given ASID
152                and virtual address. The user should write the ASID and VA into
153                the file and then read the file to get the result.
154                e.g. to display info about VA 0x1000 for ASID 1 you need to do:
155                echo "1 0x1000" > /sys/kernel/debug/habanalabs/hl0/mmu
156
157What:           /sys/kernel/debug/habanalabs/hl<n>/set_power_state
158Date:           Jan 2019
159KernelVersion:  5.1
160Contact:        oded.gabbay@gmail.com
161Description:    Sets the PCI power state. Valid values are "1" for D0 and "2"
162                for D3Hot
163
164What:           /sys/kernel/debug/habanalabs/hl<n>/userptr
165Date:           Jan 2019
166KernelVersion:  5.1
167Contact:        oded.gabbay@gmail.com
168Description:    Displays a list with information about the currently user
169                pointers (user virtual addresses) that are pinned and mapped
170                to DMA addresses
171
172What:           /sys/kernel/debug/habanalabs/hl<n>/vm
173Date:           Jan 2019
174KernelVersion:  5.1
175Contact:        oded.gabbay@gmail.com
176Description:    Displays a list with information about all the active virtual
177                address mappings per ASID
178
179What:           /sys/kernel/debug/habanalabs/hl<n>/stop_on_err
180Date:           Mar 2020
181KernelVersion:  5.6
182Contact:        oded.gabbay@gmail.com
183Description:    Sets the stop-on_error option for the device engines. Value of
184                "0" is for disable, otherwise enable.
185