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                 It's not visible when the device does not support batch.
  26
  27 What:           /sys/bus/dsa/devices/dsa<m>/max_work_queues_size
  28 Date:           Oct 25, 2019
  29 KernelVersion:  5.6.0
  30 Contact:        dmaengine@vger.kernel.org
  31 Description:    The maximum work queue size supported by this device.
  32
  33 What:           /sys/bus/dsa/devices/dsa<m>/max_engines
  34 Date:           Oct 25, 2019
  35 KernelVersion:  5.6.0
  36 Contact:        dmaengine@vger.kernel.org
  37 Description:    The maximum number of engines supported by this device.
  38
  39 What:           /sys/bus/dsa/devices/dsa<m>/max_groups
  40 Date:           Oct 25, 2019
  41 KernelVersion:  5.6.0
  42 Contact:        dmaengine@vger.kernel.org
  43 Description:    The maximum number of groups can be created under this device.
  44
  45 What:           /sys/bus/dsa/devices/dsa<m>/max_read_buffers
  46 Date:           Dec 10, 2021
  47 KernelVersion:  5.17.0
  48 Contact:        dmaengine@vger.kernel.org
  49 Description:    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
  56 What:           /sys/bus/dsa/devices/dsa<m>/max_transfer_size
  57 Date:           Oct 25, 2019
  58 KernelVersion:  5.6.0
  59 Contact:        dmaengine@vger.kernel.org
  60 Description:    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
  64 What:           /sys/bus/dsa/devices/dsa<m>/max_work_queues
  65 Date:           Oct 25, 2019
  66 KernelVersion:  5.6.0
  67 Contact:        dmaengine@vger.kernel.org
  68 Description:    The maximum work queue number that this device supports.
  69
  70 What:           /sys/bus/dsa/devices/dsa<m>/numa_node
  71 Date:           Oct 25, 2019
  72 KernelVersion:  5.6.0
  73 Contact:        dmaengine@vger.kernel.org
  74 Description:    The numa node number for this device.
  75
  76 What:           /sys/bus/dsa/devices/dsa<m>/op_cap
  77 Date:           Oct 25, 2019
  78 KernelVersion:  5.6.0
  79 Contact:        dmaengine@vger.kernel.org
  80 Description:    The operation capability bit mask specify the operation types
  81                 supported by the this device.
  82
  83 What:           /sys/bus/dsa/devices/dsa<m>/pasid_enabled
  84 Date:           Oct 27, 2020
  85 KernelVersion:  5.11.0
  86 Contact:        dmaengine@vger.kernel.org
  87 Description:    To indicate if PASID (process address space identifier) is
  88                 enabled or not for this device.
  89
  90 What:           /sys/bus/dsa/devices/dsa<m>/state
  91 Date:           Oct 25, 2019
  92 KernelVersion:  5.6.0
  93 Contact:        dmaengine@vger.kernel.org
  94 Description:    The state information of this device. It can be either enabled
  95                 or disabled.
  96
  97 What:           /sys/bus/dsa/devices/dsa<m>/group<m>.<n>
  98 Date:           Oct 25, 2019
  99 KernelVersion:  5.6.0
 100 Contact:        dmaengine@vger.kernel.org
 101 Description:    The assigned group under this device.
 102
 103 What:           /sys/bus/dsa/devices/dsa<m>/engine<m>.<n>
 104 Date:           Oct 25, 2019
 105 KernelVersion:  5.6.0
 106 Contact:        dmaengine@vger.kernel.org
 107 Description:    The assigned engine under this device.
 108
 109 What:           /sys/bus/dsa/devices/dsa<m>/wq<m>.<n>
 110 Date:           Oct 25, 2019
 111 KernelVersion:  5.6.0
 112 Contact:        dmaengine@vger.kernel.org
 113 Description:    The assigned work queue under this device.
 114
 115 What:           /sys/bus/dsa/devices/dsa<m>/configurable
 116 Date:           Oct 25, 2019
 117 KernelVersion:  5.6.0
 118 Contact:        dmaengine@vger.kernel.org
 119 Description:    To indicate if this device is configurable or not.
 120
 121 What:           /sys/bus/dsa/devices/dsa<m>/read_buffer_limit
 122 Date:           Dec 10, 2021
 123 KernelVersion:  5.17.0
 124 Contact:        dmaengine@vger.kernel.org
 125 Description:    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
 131 What:           /sys/bus/dsa/devices/dsa<m>/cmd_status
 132 Date:           Aug 28, 2020
 133 KernelVersion:  5.10.0
 134 Contact:        dmaengine@vger.kernel.org
 135 Description:    The last executed device administrative command's status/error.
 136                 Also last configuration error overloaded.
 137                 Writing to it will clear the status.
 138
 139 What:           /sys/bus/dsa/devices/wq<m>.<n>/block_on_fault
 140 Date:           Oct 27, 2020
 141 KernelVersion:  5.11.0
 142 Contact:        dmaengine@vger.kernel.org
 143 Description:    To indicate block on fault is allowed or not for the work queue
 144                 to support on demand paging.
 145
 146 What:           /sys/bus/dsa/devices/wq<m>.<n>/group_id
 147 Date:           Oct 25, 2019
 148 KernelVersion:  5.6.0
 149 Contact:        dmaengine@vger.kernel.org
 150 Description:    The group id that this work queue belongs to.
 151
 152 What:           /sys/bus/dsa/devices/wq<m>.<n>/size
 153 Date:           Oct 25, 2019
 154 KernelVersion:  5.6.0
 155 Contact:        dmaengine@vger.kernel.org
 156 Description:    The work queue size for this work queue.
 157
 158 What:           /sys/bus/dsa/devices/wq<m>.<n>/type
 159 Date:           Oct 25, 2019
 160 KernelVersion:  5.6.0
 161 Contact:        dmaengine@vger.kernel.org
 162 Description:    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
 166 What:           /sys/bus/dsa/devices/wq<m>.<n>/cdev_minor
 167 Date:           Oct 25, 2019
 168 KernelVersion:  5.6.0
 169 Contact:        dmaengine@vger.kernel.org
 170 Description:    The minor number assigned to this work queue by the character
 171                 device driver.
 172
 173 What:           /sys/bus/dsa/devices/wq<m>.<n>/mode
 174 Date:           Oct 25, 2019
 175 KernelVersion:  5.6.0
 176 Contact:        dmaengine@vger.kernel.org
 177 Description:    The work queue mode type for this work queue.
 178
 179 What:           /sys/bus/dsa/devices/wq<m>.<n>/priority
 180 Date:           Oct 25, 2019
 181 KernelVersion:  5.6.0
 182 Contact:        dmaengine@vger.kernel.org
 183 Description:    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
 187 What:           /sys/bus/dsa/devices/wq<m>.<n>/state
 188 Date:           Oct 25, 2019
 189 KernelVersion:  5.6.0
 190 Contact:        dmaengine@vger.kernel.org
 191 Description:    The current state of the work queue.
 192
 193 What:           /sys/bus/dsa/devices/wq<m>.<n>/threshold
 194 Date:           Oct 25, 2019
 195 KernelVersion:  5.6.0
 196 Contact:        dmaengine@vger.kernel.org
 197 Description:    The number of entries in this work queue that may be filled
 198                 via a limited portal.
 199
 200 What:           /sys/bus/dsa/devices/wq<m>.<n>/max_transfer_size
 201 Date:           Aug 28, 2020
 202 KernelVersion:  5.10.0
 203 Contact:        dmaengine@vger.kernel.org
 204 Description:    The max transfer sized for this workqueue. Cannot exceed device
 205                 max transfer size. Configurable parameter.
 206
 207 What:           /sys/bus/dsa/devices/wq<m>.<n>/max_batch_size
 208 Date:           Aug 28, 2020
 209 KernelVersion:  5.10.0
 210 Contact:        dmaengine@vger.kernel.org
 211 Description:    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
 215 What:           /sys/bus/dsa/devices/wq<m>.<n>/ats_disable
 216 Date:           Nov 13, 2020
 217 KernelVersion:  5.11.0
 218 Contact:        dmaengine@vger.kernel.org
 219 Description:    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
 222 What:           /sys/bus/dsa/devices/wq<m>.<n>/occupancy
 223 Date            May 25, 2021
 224 KernelVersion:  5.14.0
 225 Contact:        dmaengine@vger.kernel.org
 226 Description:    Show the current number of entries in this WQ if WQ Occupancy
 227                 Support bit WQ capabilities is 1.
 228
 229 What:           /sys/bus/dsa/devices/wq<m>.<n>/enqcmds_retries
 230 Date            Oct 29, 2021
 231 KernelVersion:  5.17.0
 232 Contact:        dmaengine@vger.kernel.org
 233 Description:    Indicate the number of retires for an enqcmds submission on a sharedwq.
 234                 A max value to set attribute is capped at 64.
 235
 236 What:           /sys/bus/dsa/devices/wq<m>.<n>/op_config
 237 Date:           Sept 14, 2022
 238 KernelVersion:  6.0.0
 239 Contact:        dmaengine@vger.kernel.org
 240 Description:    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
 247 What:           /sys/bus/dsa/devices/engine<m>.<n>/group_id
 248 Date:           Oct 25, 2019
 249 KernelVersion:  5.6.0
 250 Contact:        dmaengine@vger.kernel.org
 251 Description:    The group that this engine belongs to.
 252
 253 What:           /sys/bus/dsa/devices/group<m>.<n>/use_read_buffer_limit
 254 Date:           Dec 10, 2021
 255 KernelVersion:  5.17.0
 256 Contact:        dmaengine@vger.kernel.org
 257 Description:    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
 262 What:           /sys/bus/dsa/devices/group<m>.<n>/read_buffers_allowed
 263 Date:           Dec 10, 2021
 264 KernelVersion:  5.17.0
 265 Contact:        dmaengine@vger.kernel.org
 266 Description:    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
 272 What:           /sys/bus/dsa/devices/group<m>.<n>/read_buffers_reserved
 273 Date:           Dec 10, 2021
 274 KernelVersion:  5.17.0
 275 Contact:        dmaengine@vger.kernel.org
 276 Description:    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
 282 What:           /sys/bus/dsa/devices/group<m>.<n>/desc_progress_limit
 283 Date:           Sept 14, 2022
 284 KernelVersion:  6.0.0
 285 Contact:        dmaengine@vger.kernel.org
 286 Description:    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
 294 What:           /sys/bus/dsa/devices/group<m>.<n>/batch_progress_limit
 295 Date:           Sept 14, 2022
 296 KernelVersion:  6.0.0
 297 Contact:        dmaengine@vger.kernel.org
 298 Description:    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.