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
21What:           /sys/kernel/debug/habanalabs/hl<n>/command_buffers
22Date:           Jan 2019
23KernelVersion:  5.1
24Contact:        oded.gabbay@gmail.com
25Description:    Displays a list with information about the currently allocated
26                command buffers
27
28What:           /sys/kernel/debug/habanalabs/hl<n>/command_submission
29Date:           Jan 2019
30KernelVersion:  5.1
31Contact:        oded.gabbay@gmail.com
32Description:    Displays a list with information about the currently active
33                command submissions
34
35What:           /sys/kernel/debug/habanalabs/hl<n>/command_submission_jobs
36Date:           Jan 2019
37KernelVersion:  5.1
38Contact:        oded.gabbay@gmail.com
39Description:    Displays a list with detailed information about each JOB (CB) of
40                each active command submission
41
42What:           /sys/kernel/debug/habanalabs/hl<n>/data32
43Date:           Jan 2019
44KernelVersion:  5.1
45Contact:        oded.gabbay@gmail.com
46Description:    Allows the root user to read or write directly through the
47                device's PCI bar. Writing to this file generates a write
48                transaction while reading from the file generates a read
49                transaction. This custom interface is needed (instead of using
50                the generic Linux user-space PCI mapping) because the DDR bar
51                is very small compared to the DDR memory and only the driver can
52                move the bar before and after the transaction.
53                If the IOMMU is disabled, it also allows the root user to read
54                or write from the host a device VA of a host mapped memory
55
56What:           /sys/kernel/debug/habanalabs/hl<n>/data64
57Date:           Jan 2020
58KernelVersion:  5.6
59Contact:        oded.gabbay@gmail.com
60Description:    Allows the root user to read or write 64 bit data directly
61                through the device's PCI bar. Writing to this file generates a
62                write transaction while reading from the file generates a read
63                transaction. This custom interface is needed (instead of using
64                the generic Linux user-space PCI mapping) because the DDR bar
65                is very small compared to the DDR memory and only the driver can
66                move the bar before and after the transaction.
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>/device
71Date:           Jan 2019
72KernelVersion:  5.1
73Contact:        oded.gabbay@gmail.com
74Description:    Enables the root user to set the device to specific state.
75                Valid values are "disable", "enable", "suspend", "resume".
76                User can read this property to see the valid values
77
78What:           /sys/kernel/debug/habanalabs/hl<n>/engines
79Date:           Jul 2019
80KernelVersion:  5.3
81Contact:        oded.gabbay@gmail.com
82Description:    Displays the status registers values of the device engines and
83                their derived idle status
84
85What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_addr
86Date:           Jan 2019
87KernelVersion:  5.1
88Contact:        oded.gabbay@gmail.com
89Description:    Sets I2C device address for I2C transaction that is generated
90                by the device's CPU
91
92What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_bus
93Date:           Jan 2019
94KernelVersion:  5.1
95Contact:        oded.gabbay@gmail.com
96Description:    Sets I2C bus address for I2C transaction that is generated by
97                the device's CPU
98
99What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_data
100Date:           Jan 2019
101KernelVersion:  5.1
102Contact:        oded.gabbay@gmail.com
103Description:    Triggers an I2C transaction that is generated by the device's
104                CPU. Writing to this file generates a write transaction while
105                reading from the file generates a read transcation
106
107What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_reg
108Date:           Jan 2019
109KernelVersion:  5.1
110Contact:        oded.gabbay@gmail.com
111Description:    Sets I2C register id for I2C transaction that is generated by
112                the device's CPU
113
114What:           /sys/kernel/debug/habanalabs/hl<n>/led0
115Date:           Jan 2019
116KernelVersion:  5.1
117Contact:        oded.gabbay@gmail.com
118Description:    Sets the state of the first S/W led on the device
119
120What:           /sys/kernel/debug/habanalabs/hl<n>/led1
121Date:           Jan 2019
122KernelVersion:  5.1
123Contact:        oded.gabbay@gmail.com
124Description:    Sets the state of the second S/W led on the device
125
126What:           /sys/kernel/debug/habanalabs/hl<n>/led2
127Date:           Jan 2019
128KernelVersion:  5.1
129Contact:        oded.gabbay@gmail.com
130Description:    Sets the state of the third S/W led on the device
131
132What:           /sys/kernel/debug/habanalabs/hl<n>/mmu
133Date:           Jan 2019
134KernelVersion:  5.1
135Contact:        oded.gabbay@gmail.com
136Description:    Displays the hop values and physical address for a given ASID
137                and virtual address. The user should write the ASID and VA into
138                the file and then read the file to get the result.
139                e.g. to display info about VA 0x1000 for ASID 1 you need to do:
140                echo "1 0x1000" > /sys/kernel/debug/habanalabs/hl0/mmu
141
142What:           /sys/kernel/debug/habanalabs/hl<n>/set_power_state
143Date:           Jan 2019
144KernelVersion:  5.1
145Contact:        oded.gabbay@gmail.com
146Description:    Sets the PCI power state. Valid values are "1" for D0 and "2"
147                for D3Hot
148
149What:           /sys/kernel/debug/habanalabs/hl<n>/userptr
150Date:           Jan 2019
151KernelVersion:  5.1
152Contact:        oded.gabbay@gmail.com
153Description:    Displays a list with information about the currently user
154                pointers (user virtual addresses) that are pinned and mapped
155                to DMA addresses
156
157What:           /sys/kernel/debug/habanalabs/hl<n>/vm
158Date:           Jan 2019
159KernelVersion:  5.1
160Contact:        oded.gabbay@gmail.com
161Description:    Displays a list with information about all the active virtual
162                address mappings per ASID
163
164What:           /sys/kernel/debug/habanalabs/hl<n>/stop_on_err
165Date:           Mar 2020
166KernelVersion:  5.6
167Contact:        oded.gabbay@gmail.com
168Description:    Sets the stop-on_error option for the device engines. Value of
169                "0" is for disable, otherwise enable.
170