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