Merge tag 'riscv/for-v5.3-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/riscv...
[sfrench/cifs-2.6.git] / Documentation / ABI / testing / debugfs-driver-habanalabs
1 What:           /sys/kernel/debug/habanalabs/hl<n>/addr
2 Date:           Jan 2019
3 KernelVersion:  5.1
4 Contact:        oded.gabbay@gmail.com
5 Description:    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
11 What:           /sys/kernel/debug/habanalabs/hl<n>/command_buffers
12 Date:           Jan 2019
13 KernelVersion:  5.1
14 Contact:        oded.gabbay@gmail.com
15 Description:    Displays a list with information about the currently allocated
16                 command buffers
17
18 What:           /sys/kernel/debug/habanalabs/hl<n>/command_submission
19 Date:           Jan 2019
20 KernelVersion:  5.1
21 Contact:        oded.gabbay@gmail.com
22 Description:    Displays a list with information about the currently active
23                 command submissions
24
25 What:           /sys/kernel/debug/habanalabs/hl<n>/command_submission_jobs
26 Date:           Jan 2019
27 KernelVersion:  5.1
28 Contact:        oded.gabbay@gmail.com
29 Description:    Displays a list with detailed information about each JOB (CB) of
30                 each active command submission
31
32 What:           /sys/kernel/debug/habanalabs/hl<n>/data32
33 Date:           Jan 2019
34 KernelVersion:  5.1
35 Contact:        oded.gabbay@gmail.com
36 Description:    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
46 What:           /sys/kernel/debug/habanalabs/hl<n>/device
47 Date:           Jan 2019
48 KernelVersion:  5.1
49 Contact:        oded.gabbay@gmail.com
50 Description:    Enables the root user to set the device to specific state.
51                 Valid values are "disable", "enable", "suspend", "resume".
52                 User can read this property to see the valid values
53
54 What:           /sys/kernel/debug/habanalabs/hl<n>/engines
55 Date:           Jul 2019
56 KernelVersion:  5.3
57 Contact:        oded.gabbay@gmail.com
58 Description:    Displays the status registers values of the device engines and
59                 their derived idle status
60
61 What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_addr
62 Date:           Jan 2019
63 KernelVersion:  5.1
64 Contact:        oded.gabbay@gmail.com
65 Description:    Sets I2C device address for I2C transaction that is generated
66                 by the device's CPU
67
68 What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_bus
69 Date:           Jan 2019
70 KernelVersion:  5.1
71 Contact:        oded.gabbay@gmail.com
72 Description:    Sets I2C bus address for I2C transaction that is generated by
73                 the device's CPU
74
75 What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_data
76 Date:           Jan 2019
77 KernelVersion:  5.1
78 Contact:        oded.gabbay@gmail.com
79 Description:    Triggers an I2C transaction that is generated by the device's
80                 CPU. Writing to this file generates a write transaction while
81                 reading from the file generates a read transcation
82
83 What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_reg
84 Date:           Jan 2019
85 KernelVersion:  5.1
86 Contact:        oded.gabbay@gmail.com
87 Description:    Sets I2C register id for I2C transaction that is generated by
88                 the device's CPU
89
90 What:           /sys/kernel/debug/habanalabs/hl<n>/led0
91 Date:           Jan 2019
92 KernelVersion:  5.1
93 Contact:        oded.gabbay@gmail.com
94 Description:    Sets the state of the first S/W led on the device
95
96 What:           /sys/kernel/debug/habanalabs/hl<n>/led1
97 Date:           Jan 2019
98 KernelVersion:  5.1
99 Contact:        oded.gabbay@gmail.com
100 Description:    Sets the state of the second S/W led on the device
101
102 What:           /sys/kernel/debug/habanalabs/hl<n>/led2
103 Date:           Jan 2019
104 KernelVersion:  5.1
105 Contact:        oded.gabbay@gmail.com
106 Description:    Sets the state of the third S/W led on the device
107
108 What:           /sys/kernel/debug/habanalabs/hl<n>/mmu
109 Date:           Jan 2019
110 KernelVersion:  5.1
111 Contact:        oded.gabbay@gmail.com
112 Description:    Displays the hop values and physical address for a given ASID
113                 and virtual address. The user should write the ASID and VA into
114                 the file and then read the file to get the result.
115                 e.g. to display info about VA 0x1000 for ASID 1 you need to do:
116                 echo "1 0x1000" > /sys/kernel/debug/habanalabs/hl0/mmu
117
118 What:           /sys/kernel/debug/habanalabs/hl<n>/set_power_state
119 Date:           Jan 2019
120 KernelVersion:  5.1
121 Contact:        oded.gabbay@gmail.com
122 Description:    Sets the PCI power state. Valid values are "1" for D0 and "2"
123                 for D3Hot
124
125 What:           /sys/kernel/debug/habanalabs/hl<n>/userptr
126 Date:           Jan 2019
127 KernelVersion:  5.1
128 Contact:        oded.gabbay@gmail.com
129 Description:    Displays a list with information about the currently user
130                 pointers (user virtual addresses) that are pinned and mapped
131                 to DMA addresses
132
133 What:           /sys/kernel/debug/habanalabs/hl<n>/vm
134 Date:           Jan 2019
135 KernelVersion:  5.1
136 Contact:        oded.gabbay@gmail.com
137 Description:    Displays a list with information about all the active virtual
138                 address mappings per ASID