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