Merge tag 'for-5.8-rc6-tag' of git://git.kernel.org/pub/scm/linux/kernel/git/kdave...
[linux-2.6-microblaze.git] / Documentation / ABI / stable / sysfs-driver-dma-idxd
1 What:           sys/bus/dsa/devices/dsa<m>/version
2 Date:           Apr 15, 2020
3 KernelVersion:  5.8.0
4 Contact:        dmaengine@vger.kernel.org
5 Description:    The hardware version number.
6
7 What:           sys/bus/dsa/devices/dsa<m>/cdev_major
8 Date:           Oct 25, 2019
9 KernelVersion:  5.6.0
10 Contact:        dmaengine@vger.kernel.org
11 Description:    The major number that the character device driver assigned to
12                 this device.
13
14 What:           sys/bus/dsa/devices/dsa<m>/errors
15 Date:           Oct 25, 2019
16 KernelVersion:  5.6.0
17 Contact:        dmaengine@vger.kernel.org
18 Description:    The error information for this device.
19
20 What:           sys/bus/dsa/devices/dsa<m>/max_batch_size
21 Date:           Oct 25, 2019
22 KernelVersion:  5.6.0
23 Contact:        dmaengine@vger.kernel.org
24 Description:    The largest number of work descriptors in a batch.
25
26 What:           sys/bus/dsa/devices/dsa<m>/max_work_queues_size
27 Date:           Oct 25, 2019
28 KernelVersion:  5.6.0
29 Contact:        dmaengine@vger.kernel.org
30 Description:    The maximum work queue size supported by this device.
31
32 What:           sys/bus/dsa/devices/dsa<m>/max_engines
33 Date:           Oct 25, 2019
34 KernelVersion:  5.6.0
35 Contact:        dmaengine@vger.kernel.org
36 Description:    The maximum number of engines supported by this device.
37
38 What:           sys/bus/dsa/devices/dsa<m>/max_groups
39 Date:           Oct 25, 2019
40 KernelVersion:  5.6.0
41 Contact:        dmaengine@vger.kernel.org
42 Description:    The maximum number of groups can be created under this device.
43
44 What:           sys/bus/dsa/devices/dsa<m>/max_tokens
45 Date:           Oct 25, 2019
46 KernelVersion:  5.6.0
47 Contact:        dmaengine@vger.kernel.org
48 Description:    The total number of bandwidth tokens supported by this device.
49                 The bandwidth tokens represent resources within the DSA
50                 implementation, and these resources are allocated by engines to
51                 support operations.
52
53 What:           sys/bus/dsa/devices/dsa<m>/max_transfer_size
54 Date:           Oct 25, 2019
55 KernelVersion:  5.6.0
56 Contact:        dmaengine@vger.kernel.org
57 Description:    The number of bytes to be read from the source address to
58                 perform the operation. The maximum transfer size is dependent on
59                 the workqueue the descriptor was submitted to.
60
61 What:           sys/bus/dsa/devices/dsa<m>/max_work_queues
62 Date:           Oct 25, 2019
63 KernelVersion:  5.6.0
64 Contact:        dmaengine@vger.kernel.org
65 Description:    The maximum work queue number that this device supports.
66
67 What:           sys/bus/dsa/devices/dsa<m>/numa_node
68 Date:           Oct 25, 2019
69 KernelVersion:  5.6.0
70 Contact:        dmaengine@vger.kernel.org
71 Description:    The numa node number for this device.
72
73 What:           sys/bus/dsa/devices/dsa<m>/op_cap
74 Date:           Oct 25, 2019
75 KernelVersion:  5.6.0
76 Contact:        dmaengine@vger.kernel.org
77 Description:    The operation capability bit mask specify the operation types
78                 supported by the this device.
79
80 What:           sys/bus/dsa/devices/dsa<m>/state
81 Date:           Oct 25, 2019
82 KernelVersion:  5.6.0
83 Contact:        dmaengine@vger.kernel.org
84 Description:    The state information of this device. It can be either enabled
85                 or disabled.
86
87 What:           sys/bus/dsa/devices/dsa<m>/group<m>.<n>
88 Date:           Oct 25, 2019
89 KernelVersion:  5.6.0
90 Contact:        dmaengine@vger.kernel.org
91 Description:    The assigned group under this device.
92
93 What:           sys/bus/dsa/devices/dsa<m>/engine<m>.<n>
94 Date:           Oct 25, 2019
95 KernelVersion:  5.6.0
96 Contact:        dmaengine@vger.kernel.org
97 Description:    The assigned engine under this device.
98
99 What:           sys/bus/dsa/devices/dsa<m>/wq<m>.<n>
100 Date:           Oct 25, 2019
101 KernelVersion:  5.6.0
102 Contact:        dmaengine@vger.kernel.org
103 Description:    The assigned work queue under this device.
104
105 What:           sys/bus/dsa/devices/dsa<m>/configurable
106 Date:           Oct 25, 2019
107 KernelVersion:  5.6.0
108 Contact:        dmaengine@vger.kernel.org
109 Description:    To indicate if this device is configurable or not.
110
111 What:           sys/bus/dsa/devices/dsa<m>/token_limit
112 Date:           Oct 25, 2019
113 KernelVersion:  5.6.0
114 Contact:        dmaengine@vger.kernel.org
115 Description:    The maximum number of bandwidth tokens that may be in use at
116                 one time by operations that access low bandwidth memory in the
117                 device.
118
119 What:           sys/bus/dsa/devices/wq<m>.<n>/group_id
120 Date:           Oct 25, 2019
121 KernelVersion:  5.6.0
122 Contact:        dmaengine@vger.kernel.org
123 Description:    The group id that this work queue belongs to.
124
125 What:           sys/bus/dsa/devices/wq<m>.<n>/size
126 Date:           Oct 25, 2019
127 KernelVersion:  5.6.0
128 Contact:        dmaengine@vger.kernel.org
129 Description:    The work queue size for this work queue.
130
131 What:           sys/bus/dsa/devices/wq<m>.<n>/type
132 Date:           Oct 25, 2019
133 KernelVersion:  5.6.0
134 Contact:        dmaengine@vger.kernel.org
135 Description:    The type of this work queue, it can be "kernel" type for work
136                 queue usages in the kernel space or "user" type for work queue
137                 usages by applications in user space.
138
139 What:           sys/bus/dsa/devices/wq<m>.<n>/cdev_minor
140 Date:           Oct 25, 2019
141 KernelVersion:  5.6.0
142 Contact:        dmaengine@vger.kernel.org
143 Description:    The minor number assigned to this work queue by the character
144                 device driver.
145
146 What:           sys/bus/dsa/devices/wq<m>.<n>/mode
147 Date:           Oct 25, 2019
148 KernelVersion:  5.6.0
149 Contact:        dmaengine@vger.kernel.org
150 Description:    The work queue mode type for this work queue.
151
152 What:           sys/bus/dsa/devices/wq<m>.<n>/priority
153 Date:           Oct 25, 2019
154 KernelVersion:  5.6.0
155 Contact:        dmaengine@vger.kernel.org
156 Description:    The priority value of this work queue, it is a vlue relative to
157                 other work queue in the same group to control quality of service
158                 for dispatching work from multiple workqueues in the same group.
159
160 What:           sys/bus/dsa/devices/wq<m>.<n>/state
161 Date:           Oct 25, 2019
162 KernelVersion:  5.6.0
163 Contact:        dmaengine@vger.kernel.org
164 Description:    The current state of the work queue.
165
166 What:           sys/bus/dsa/devices/wq<m>.<n>/threshold
167 Date:           Oct 25, 2019
168 KernelVersion:  5.6.0
169 Contact:        dmaengine@vger.kernel.org
170 Description:    The number of entries in this work queue that may be filled
171                 via a limited portal.
172
173 What:           sys/bus/dsa/devices/engine<m>.<n>/group_id
174 Date:           Oct 25, 2019
175 KernelVersion:  5.6.0
176 Contact:        dmaengine@vger.kernel.org
177 Description:    The group that this engine belongs to.