xref: /linux/Documentation/ABI/stable/sysfs-driver-dma-idxd (revision 07f0148aafe8c95a3a76cd59e9e75b4d78d1d31d)
1What:		/sys/bus/dsa/devices/dsa<m>/version
2Date:		Apr 15, 2020
3KernelVersion:	5.8.0
4Contact:	dmaengine@vger.kernel.org
5Description:	The hardware version number.
6
7What:           /sys/bus/dsa/devices/dsa<m>/cdev_major
8Date:           Oct 25, 2019
9KernelVersion:  5.6.0
10Contact:        dmaengine@vger.kernel.org
11Description:	The major number that the character device driver assigned to
12		this device.
13
14What:           /sys/bus/dsa/devices/dsa<m>/errors
15Date:           Oct 25, 2019
16KernelVersion:  5.6.0
17Contact:        dmaengine@vger.kernel.org
18Description:    The error information for this device.
19
20What:           /sys/bus/dsa/devices/dsa<m>/max_batch_size
21Date:           Oct 25, 2019
22KernelVersion:  5.6.0
23Contact:        dmaengine@vger.kernel.org
24Description:    The largest number of work descriptors in a batch.
25                It's not visible when the device does not support batch.
26
27What:           /sys/bus/dsa/devices/dsa<m>/max_work_queues_size
28Date:           Oct 25, 2019
29KernelVersion:  5.6.0
30Contact:        dmaengine@vger.kernel.org
31Description:    The maximum work queue size supported by this device.
32
33What:           /sys/bus/dsa/devices/dsa<m>/max_engines
34Date:           Oct 25, 2019
35KernelVersion:  5.6.0
36Contact:        dmaengine@vger.kernel.org
37Description:    The maximum number of engines supported by this device.
38
39What:           /sys/bus/dsa/devices/dsa<m>/max_groups
40Date:           Oct 25, 2019
41KernelVersion:  5.6.0
42Contact:        dmaengine@vger.kernel.org
43Description:    The maximum number of groups can be created under this device.
44
45What:           /sys/bus/dsa/devices/dsa<m>/max_read_buffers
46Date:           Dec 10, 2021
47KernelVersion:  5.17.0
48Contact:        dmaengine@vger.kernel.org
49Description:    The total number of read buffers supported by this device.
50		The read buffers represent resources within the DSA
51		implementation, and these resources are allocated by engines to
52		support operations. See DSA spec v1.2 9.2.4 Total Read Buffers.
53		It's not visible when the device does not support Read Buffer
54		allocation control.
55
56What:           /sys/bus/dsa/devices/dsa<m>/max_transfer_size
57Date:           Oct 25, 2019
58KernelVersion:  5.6.0
59Contact:        dmaengine@vger.kernel.org
60Description:    The number of bytes to be read from the source address to
61		perform the operation. The maximum transfer size is dependent on
62		the workqueue the descriptor was submitted to.
63
64What:           /sys/bus/dsa/devices/dsa<m>/max_work_queues
65Date:           Oct 25, 2019
66KernelVersion:  5.6.0
67Contact:        dmaengine@vger.kernel.org
68Description:    The maximum work queue number that this device supports.
69
70What:           /sys/bus/dsa/devices/dsa<m>/numa_node
71Date:           Oct 25, 2019
72KernelVersion:  5.6.0
73Contact:        dmaengine@vger.kernel.org
74Description:    The numa node number for this device.
75
76What:           /sys/bus/dsa/devices/dsa<m>/op_cap
77Date:           Oct 25, 2019
78KernelVersion:  5.6.0
79Contact:        dmaengine@vger.kernel.org
80Description:    The operation capability bit mask specify the operation types
81		supported by the this device.
82
83What:		/sys/bus/dsa/devices/dsa<m>/pasid_enabled
84Date:		Oct 27, 2020
85KernelVersion:	5.11.0
86Contact:	dmaengine@vger.kernel.org
87Description:	To indicate if PASID (process address space identifier) is
88		enabled or not for this device.
89
90What:           /sys/bus/dsa/devices/dsa<m>/state
91Date:           Oct 25, 2019
92KernelVersion:  5.6.0
93Contact:        dmaengine@vger.kernel.org
94Description:    The state information of this device. It can be either enabled
95		or disabled.
96
97What:           /sys/bus/dsa/devices/dsa<m>/group<m>.<n>
98Date:           Oct 25, 2019
99KernelVersion:  5.6.0
100Contact:        dmaengine@vger.kernel.org
101Description:    The assigned group under this device.
102
103What:           /sys/bus/dsa/devices/dsa<m>/engine<m>.<n>
104Date:           Oct 25, 2019
105KernelVersion:  5.6.0
106Contact:        dmaengine@vger.kernel.org
107Description:    The assigned engine under this device.
108
109What:           /sys/bus/dsa/devices/dsa<m>/wq<m>.<n>
110Date:           Oct 25, 2019
111KernelVersion:  5.6.0
112Contact:        dmaengine@vger.kernel.org
113Description:    The assigned work queue under this device.
114
115What:           /sys/bus/dsa/devices/dsa<m>/configurable
116Date:           Oct 25, 2019
117KernelVersion:  5.6.0
118Contact:        dmaengine@vger.kernel.org
119Description:    To indicate if this device is configurable or not.
120
121What:           /sys/bus/dsa/devices/dsa<m>/read_buffer_limit
122Date:           Dec 10, 2021
123KernelVersion:  5.17.0
124Contact:        dmaengine@vger.kernel.org
125Description:    The maximum number of read buffers that may be in use at
126		one time by operations that access low bandwidth memory in the
127		device. See DSA spec v1.2 9.2.8 GENCFG on Global Read Buffer Limit.
128		It's not visible when the device does not support Read Buffer
129		allocation control.
130
131What:		/sys/bus/dsa/devices/dsa<m>/cmd_status
132Date:		Aug 28, 2020
133KernelVersion:	5.10.0
134Contact:	dmaengine@vger.kernel.org
135Description:	The last executed device administrative command's status/error.
136		Also last configuration error overloaded.
137		Writing to it will clear the status.
138
139What:		/sys/bus/dsa/devices/wq<m>.<n>/block_on_fault
140Date:		Oct 27, 2020
141KernelVersion:	5.11.0
142Contact:	dmaengine@vger.kernel.org
143Description:	To indicate block on fault is allowed or not for the work queue
144		to support on demand paging.
145
146What:           /sys/bus/dsa/devices/wq<m>.<n>/group_id
147Date:           Oct 25, 2019
148KernelVersion:  5.6.0
149Contact:        dmaengine@vger.kernel.org
150Description:    The group id that this work queue belongs to.
151
152What:           /sys/bus/dsa/devices/wq<m>.<n>/size
153Date:           Oct 25, 2019
154KernelVersion:  5.6.0
155Contact:        dmaengine@vger.kernel.org
156Description:    The work queue size for this work queue.
157
158What:           /sys/bus/dsa/devices/wq<m>.<n>/type
159Date:           Oct 25, 2019
160KernelVersion:  5.6.0
161Contact:        dmaengine@vger.kernel.org
162Description:    The type of this work queue, it can be "kernel" type for work
163		queue usages in the kernel space or "user" type for work queue
164		usages by applications in user space.
165
166What:           /sys/bus/dsa/devices/wq<m>.<n>/cdev_minor
167Date:           Oct 25, 2019
168KernelVersion:  5.6.0
169Contact:        dmaengine@vger.kernel.org
170Description:    The minor number assigned to this work queue by the character
171		device driver.
172
173What:           /sys/bus/dsa/devices/wq<m>.<n>/mode
174Date:           Oct 25, 2019
175KernelVersion:  5.6.0
176Contact:        dmaengine@vger.kernel.org
177Description:    The work queue mode type for this work queue.
178
179What:           /sys/bus/dsa/devices/wq<m>.<n>/priority
180Date:           Oct 25, 2019
181KernelVersion:  5.6.0
182Contact:        dmaengine@vger.kernel.org
183Description:    The priority value of this work queue, it is a value relative to
184		other work queue in the same group to control quality of service
185		for dispatching work from multiple workqueues in the same group.
186
187What:           /sys/bus/dsa/devices/wq<m>.<n>/state
188Date:           Oct 25, 2019
189KernelVersion:  5.6.0
190Contact:        dmaengine@vger.kernel.org
191Description:    The current state of the work queue.
192
193What:           /sys/bus/dsa/devices/wq<m>.<n>/threshold
194Date:           Oct 25, 2019
195KernelVersion:  5.6.0
196Contact:        dmaengine@vger.kernel.org
197Description:    The number of entries in this work queue that may be filled
198		via a limited portal.
199
200What:		/sys/bus/dsa/devices/wq<m>.<n>/max_transfer_size
201Date:		Aug 28, 2020
202KernelVersion:	5.10.0
203Contact:	dmaengine@vger.kernel.org
204Description:	The max transfer sized for this workqueue. Cannot exceed device
205		max transfer size. Configurable parameter.
206
207What:		/sys/bus/dsa/devices/wq<m>.<n>/max_batch_size
208Date:		Aug 28, 2020
209KernelVersion:	5.10.0
210Contact:	dmaengine@vger.kernel.org
211Description:	The max batch size for this workqueue. Cannot exceed device
212		max batch size. Configurable parameter.
213		It's not visible when the device does not support batch.
214
215What:		/sys/bus/dsa/devices/wq<m>.<n>/ats_disable
216Date:		Nov 13, 2020
217KernelVersion:	5.11.0
218Contact:	dmaengine@vger.kernel.org
219Description:	Indicate whether ATS disable is turned on for the workqueue.
220		0 indicates ATS is on, and 1 indicates ATS is off for the workqueue.
221
222What:		/sys/bus/dsa/devices/wq<m>.<n>/occupancy
223Date		May 25, 2021
224KernelVersion:	5.14.0
225Contact:	dmaengine@vger.kernel.org
226Description:	Show the current number of entries in this WQ if WQ Occupancy
227		Support bit WQ capabilities is 1.
228
229What:		/sys/bus/dsa/devices/wq<m>.<n>/enqcmds_retries
230Date		Oct 29, 2021
231KernelVersion:	5.17.0
232Contact:	dmaengine@vger.kernel.org
233Description:	Indicate the number of retires for an enqcmds submission on a sharedwq.
234		A max value to set attribute is capped at 64.
235
236What:		/sys/bus/dsa/devices/wq<m>.<n>/op_config
237Date:		Sept 14, 2022
238KernelVersion:	6.0.0
239Contact:	dmaengine@vger.kernel.org
240Description:	Shows the operation capability bits displayed in bitmap format
241		presented by %*pb printk() output format specifier.
242		The attribute can be configured when the WQ is disabled in
243		order to configure the WQ to accept specific bits that
244		correlates to the operations allowed. It's visible only
245		on platforms that support the capability.
246
247What:           /sys/bus/dsa/devices/engine<m>.<n>/group_id
248Date:           Oct 25, 2019
249KernelVersion:  5.6.0
250Contact:        dmaengine@vger.kernel.org
251Description:    The group that this engine belongs to.
252
253What:		/sys/bus/dsa/devices/group<m>.<n>/use_read_buffer_limit
254Date:		Dec 10, 2021
255KernelVersion:	5.17.0
256Contact:	dmaengine@vger.kernel.org
257Description:	Enable the use of global read buffer limit for the group. See DSA
258		spec v1.2 9.2.18 GRPCFG Use Global Read Buffer Limit.
259		It's not visible when the device does not support Read Buffer
260		allocation control.
261
262What:		/sys/bus/dsa/devices/group<m>.<n>/read_buffers_allowed
263Date:		Dec 10, 2021
264KernelVersion:	5.17.0
265Contact:	dmaengine@vger.kernel.org
266Description:	Indicates max number of read buffers that may be in use at one time
267		by all engines in the group. See DSA spec v1.2 9.2.18 GRPCFG Read
268		Buffers Allowed.
269		It's not visible when the device does not support Read Buffer
270		allocation control.
271
272What:		/sys/bus/dsa/devices/group<m>.<n>/read_buffers_reserved
273Date:		Dec 10, 2021
274KernelVersion:	5.17.0
275Contact:	dmaengine@vger.kernel.org
276Description:	Indicates the number of Read Buffers reserved for the use of
277		engines in the group. See DSA spec v1.2 9.2.18 GRPCFG Read Buffers
278		Reserved.
279		It's not visible when the device does not support Read Buffer
280		allocation control.
281
282What:		/sys/bus/dsa/devices/group<m>.<n>/desc_progress_limit
283Date:		Sept 14, 2022
284KernelVersion:	6.0.0
285Contact:	dmaengine@vger.kernel.org
286Description:	Allows control of the number of work descriptors that can be
287		concurrently processed by an engine in the group as a fraction
288		of the Maximum Work Descriptors in Progress value specified in
289		the ENGCAP register. The acceptable values are 0 (default),
290		1 (1/2 of max value), 2 (1/4 of the max value), and 3 (1/8 of
291		the max value). It's visible only on platforms that support
292		the capability.
293
294What:		/sys/bus/dsa/devices/group<m>.<n>/batch_progress_limit
295Date:		Sept 14, 2022
296KernelVersion:	6.0.0
297Contact:	dmaengine@vger.kernel.org
298Description:	Allows control of the number of batch descriptors that can be
299		concurrently processed by an engine in the group as a fraction
300		of the Maximum Batch Descriptors in Progress value specified in
301		the ENGCAP register. The acceptable values are 0 (default),
302		1 (1/2 of max value), 2 (1/4 of the max value), and 3 (1/8 of
303		the max value). It's visible only on platforms that support
304		the capability.
305