habanalabs: Allow accessing host mapped addresses via debugfs
[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>/i2c_addr
55 Date:           Jan 2019
56 KernelVersion:  5.1
57 Contact:        oded.gabbay@gmail.com
58 Description:    Sets I2C device address for I2C transaction that is generated
59                 by the device's CPU
60
61 What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_bus
62 Date:           Jan 2019
63 KernelVersion:  5.1
64 Contact:        oded.gabbay@gmail.com
65 Description:    Sets I2C bus address for I2C transaction that is generated by
66                 the device's CPU
67
68 What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_data
69 Date:           Jan 2019
70 KernelVersion:  5.1
71 Contact:        oded.gabbay@gmail.com
72 Description:    Triggers an I2C transaction that is generated by the device's
73                 CPU. Writing to this file generates a write transaction while
74                 reading from the file generates a read transcation
75
76 What:           /sys/kernel/debug/habanalabs/hl<n>/i2c_reg
77 Date:           Jan 2019
78 KernelVersion:  5.1
79 Contact:        oded.gabbay@gmail.com
80 Description:    Sets I2C register id for I2C transaction that is generated by
81                 the device's CPU
82
83 What:           /sys/kernel/debug/habanalabs/hl<n>/led0
84 Date:           Jan 2019
85 KernelVersion:  5.1
86 Contact:        oded.gabbay@gmail.com
87 Description:    Sets the state of the first S/W led on the device
88
89 What:           /sys/kernel/debug/habanalabs/hl<n>/led1
90 Date:           Jan 2019
91 KernelVersion:  5.1
92 Contact:        oded.gabbay@gmail.com
93 Description:    Sets the state of the second S/W led on the device
94
95 What:           /sys/kernel/debug/habanalabs/hl<n>/led2
96 Date:           Jan 2019
97 KernelVersion:  5.1
98 Contact:        oded.gabbay@gmail.com
99 Description:    Sets the state of the third S/W led on the device
100
101 What:           /sys/kernel/debug/habanalabs/hl<n>/mmu
102 Date:           Jan 2019
103 KernelVersion:  5.1
104 Contact:        oded.gabbay@gmail.com
105 Description:    Displays the hop values and physical address for a given ASID
106                 and virtual address. The user should write the ASID and VA into
107                 the file and then read the file to get the result.
108                 e.g. to display info about VA 0x1000 for ASID 1 you need to do:
109                 echo "1 0x1000" > /sys/kernel/debug/habanalabs/hl0/mmu
110
111 What:           /sys/kernel/debug/habanalabs/hl<n>/set_power_state
112 Date:           Jan 2019
113 KernelVersion:  5.1
114 Contact:        oded.gabbay@gmail.com
115 Description:    Sets the PCI power state. Valid values are "1" for D0 and "2"
116                 for D3Hot
117
118 What:           /sys/kernel/debug/habanalabs/hl<n>/userptr
119 Date:           Jan 2019
120 KernelVersion:  5.1
121 Contact:        oded.gabbay@gmail.com
122 Description:    Displays a list with information about the currently user
123                 pointers (user virtual addresses) that are pinned and mapped
124                 to DMA addresses
125
126 What:           /sys/kernel/debug/habanalabs/hl<n>/vm
127 Date:           Jan 2019
128 KernelVersion:  5.1
129 Contact:        oded.gabbay@gmail.com
130 Description:    Displays a list with information about all the active virtual
131                 address mappings per ASID