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 user 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/dsa<m>/iaa_cap
 140 Date:           Sept 14, 2022
 141 KernelVersion: 6.0.0
 142 Contact:        dmaengine@vger.kernel.org
 143 Description:    IAA (IAX) capability mask. Exported to user space for application
 144                 consumption. This attribute should only be visible on IAA devices
 145                 that are version 2 or later.
 146
 147 What:           /sys/bus/dsa/devices/dsa<m>/event_log_size
 148 Date:           Sept 14, 2022
 149 KernelVersion: 6.4.0
 150 Contact:        dmaengine@vger.kernel.org
 151 Description:    The event log size to be configured. Default is 64 entries and
 152                 occupies 4k size if the evl entry is 64 bytes. It's visible
 153                 only on platforms that support the capability.
 154
 155 What:           /sys/bus/dsa/devices/wq<m>.<n>/block_on_fault
 156 Date:           Oct 27, 2020
 157 KernelVersion:  5.11.0
 158 Contact:        dmaengine@vger.kernel.org
 159 Description:    To indicate block on fault is allowed or not for the work queue
 160                 to support on demand paging.
 161
 162 What:           /sys/bus/dsa/devices/wq<m>.<n>/group_id
 163 Date:           Oct 25, 2019
 164 KernelVersion:  5.6.0
 165 Contact:        dmaengine@vger.kernel.org
 166 Description:    The group id that this work queue belongs to.
 167
 168 What:           /sys/bus/dsa/devices/wq<m>.<n>/size
 169 Date:           Oct 25, 2019
 170 KernelVersion:  5.6.0
 171 Contact:        dmaengine@vger.kernel.org
 172 Description:    The work queue size for this work queue.
 173
 174 What:           /sys/bus/dsa/devices/wq<m>.<n>/type
 175 Date:           Oct 25, 2019
 176 KernelVersion:  5.6.0
 177 Contact:        dmaengine@vger.kernel.org
 178 Description:    The type of this work queue, it can be "kernel" type for work
 179                 queue usages in the kernel space or "user" type for work queue
 180                 usages by applications in user space.
 181
 182 What:           /sys/bus/dsa/devices/wq<m>.<n>/cdev_minor
 183 Date:           Oct 25, 2019
 184 KernelVersion:  5.6.0
 185 Contact:        dmaengine@vger.kernel.org
 186 Description:    The minor number assigned to this work queue by the character
 187                 device driver.
 188
 189 What:           /sys/bus/dsa/devices/wq<m>.<n>/mode
 190 Date:           Oct 25, 2019
 191 KernelVersion:  5.6.0
 192 Contact:        dmaengine@vger.kernel.org
 193 Description:    The work queue mode type for this work queue.
 194
 195 What:           /sys/bus/dsa/devices/wq<m>.<n>/priority
 196 Date:           Oct 25, 2019
 197 KernelVersion:  5.6.0
 198 Contact:        dmaengine@vger.kernel.org
 199 Description:    The priority value of this work queue, it is a value relative to
 200                 other work queue in the same group to control quality of service
 201                 for dispatching work from multiple workqueues in the same group.
 202
 203 What:           /sys/bus/dsa/devices/wq<m>.<n>/state
 204 Date:           Oct 25, 2019
 205 KernelVersion:  5.6.0
 206 Contact:        dmaengine@vger.kernel.org
 207 Description:    The current state of the work queue.
 208
 209 What:           /sys/bus/dsa/devices/wq<m>.<n>/threshold
 210 Date:           Oct 25, 2019
 211 KernelVersion:  5.6.0
 212 Contact:        dmaengine@vger.kernel.org
 213 Description:    The number of entries in this work queue that may be filled
 214                 via a limited portal.
 215
 216 What:           /sys/bus/dsa/devices/wq<m>.<n>/max_transfer_size
 217 Date:           Aug 28, 2020
 218 KernelVersion:  5.10.0
 219 Contact:        dmaengine@vger.kernel.org
 220 Description:    The max transfer sized for this workqueue. Cannot exceed device
 221                 max transfer size. Configurable parameter.
 222
 223 What:           /sys/bus/dsa/devices/wq<m>.<n>/max_batch_size
 224 Date:           Aug 28, 2020
 225 KernelVersion:  5.10.0
 226 Contact:        dmaengine@vger.kernel.org
 227 Description:    The max batch size for this workqueue. Cannot exceed device
 228                 max batch size. Configurable parameter.
 229                 It's not visible when the device does not support batch.
 230
 231 What:           /sys/bus/dsa/devices/wq<m>.<n>/ats_disable
 232 Date:           Nov 13, 2020
 233 KernelVersion:  5.11.0
 234 Contact:        dmaengine@vger.kernel.org
 235 Description:    Indicate whether ATS disable is turned on for the workqueue.
 236                 0 indicates ATS is on, and 1 indicates ATS is off for the workqueue.
 237
 238 What:           /sys/bus/dsa/devices/wq<m>.<n>/prs_disable
 239 Date:           Sept 14, 2022
 240 KernelVersion: 6.4.0
 241 Contact:        dmaengine@vger.kernel.org
 242 Description:    Controls whether PRS disable is turned on for the workqueue.
 243                 0 indicates PRS is on, and 1 indicates PRS is off for the
 244                 workqueue. This option overrides block_on_fault attribute
 245                 if set. It's visible only on platforms that support the
 246                 capability.
 247
 248 What:           /sys/bus/dsa/devices/wq<m>.<n>/occupancy
 249 Date            May 25, 2021
 250 KernelVersion:  5.14.0
 251 Contact:        dmaengine@vger.kernel.org
 252 Description:    Show the current number of entries in this WQ if WQ Occupancy
 253                 Support bit WQ capabilities is 1.
 254
 255 What:           /sys/bus/dsa/devices/wq<m>.<n>/enqcmds_retries
 256 Date            Oct 29, 2021
 257 KernelVersion:  5.17.0
 258 Contact:        dmaengine@vger.kernel.org
 259 Description:    Indicate the number of retires for an enqcmds submission on a sharedwq.
 260                 A max value to set attribute is capped at 64.
 261
 262 What:           /sys/bus/dsa/devices/wq<m>.<n>/op_config
 263 Date:           Sept 14, 2022
 264 KernelVersion:  6.0.0
 265 Contact:        dmaengine@vger.kernel.org
 266 Description:    Shows the operation capability bits displayed in bitmap format
 267                 presented by %*pb printk() output format specifier.
 268                 The attribute can be configured when the WQ is disabled in
 269                 order to configure the WQ to accept specific bits that
 270                 correlates to the operations allowed. It's visible only
 271                 on platforms that support the capability.
 272
 273 What:           /sys/bus/dsa/devices/wq<m>.<n>/driver_name
 274 Date:           Sept 8, 2023
 275 KernelVersion:  6.7.0
 276 Contact:        dmaengine@vger.kernel.org
 277 Description:    Name of driver to be bounded to the wq.
 278
 279 What:           /sys/bus/dsa/devices/engine<m>.<n>/group_id
 280 Date:           Oct 25, 2019
 281 KernelVersion:  5.6.0
 282 Contact:        dmaengine@vger.kernel.org
 283 Description:    The group that this engine belongs to.
 284
 285 What:           /sys/bus/dsa/devices/group<m>.<n>/use_read_buffer_limit
 286 Date:           Dec 10, 2021
 287 KernelVersion:  5.17.0
 288 Contact:        dmaengine@vger.kernel.org
 289 Description:    Enable the use of global read buffer limit for the group. See DSA
 290                 spec v1.2 9.2.18 GRPCFG Use Global Read Buffer Limit.
 291                 It's not visible when the device does not support Read Buffer
 292                 allocation control.
 293
 294 What:           /sys/bus/dsa/devices/group<m>.<n>/read_buffers_allowed
 295 Date:           Dec 10, 2021
 296 KernelVersion:  5.17.0
 297 Contact:        dmaengine@vger.kernel.org
 298 Description:    Indicates max number of read buffers that may be in use at one time
 299                 by all engines in the group. See DSA spec v1.2 9.2.18 GRPCFG Read
 300                 Buffers Allowed.
 301                 It's not visible when the device does not support Read Buffer
 302                 allocation control.
 303
 304 What:           /sys/bus/dsa/devices/group<m>.<n>/read_buffers_reserved
 305 Date:           Dec 10, 2021
 306 KernelVersion:  5.17.0
 307 Contact:        dmaengine@vger.kernel.org
 308 Description:    Indicates the number of Read Buffers reserved for the use of
 309                 engines in the group. See DSA spec v1.2 9.2.18 GRPCFG Read Buffers
 310                 Reserved.
 311                 It's not visible when the device does not support Read Buffer
 312                 allocation control.
 313
 314 What:           /sys/bus/dsa/devices/group<m>.<n>/desc_progress_limit
 315 Date:           Sept 14, 2022
 316 KernelVersion:  6.0.0
 317 Contact:        dmaengine@vger.kernel.org
 318 Description:    Allows control of the number of work descriptors that can be
 319                 concurrently processed by an engine in the group as a fraction
 320                 of the Maximum Work Descriptors in Progress value specified in
 321                 the ENGCAP register. The acceptable values are 0 (default),
 322                 1 (1/2 of max value), 2 (1/4 of the max value), and 3 (1/8 of
 323                 the max value). It's visible only on platforms that support
 324                 the capability.
 325
 326 What:           /sys/bus/dsa/devices/group<m>.<n>/batch_progress_limit
 327 Date:           Sept 14, 2022
 328 KernelVersion:  6.0.0
 329 Contact:        dmaengine@vger.kernel.org
 330 Description:    Allows control of the number of batch descriptors that can be
 331                 concurrently processed by an engine in the group as a fraction
 332                 of the Maximum Batch Descriptors in Progress value specified in
 333                 the ENGCAP register. The acceptable values are 0 (default),
 334                 1 (1/2 of max value), 2 (1/4 of the max value), and 3 (1/8 of
 335                 the max value). It's visible only on platforms that support
 336                 the capability.
 337
 338 What:           /sys/bus/dsa/devices/wq<m>.<n>/dsa<x>\!wq<m>.<n>/file<y>/cr_faults
 339 Date:           Sept 14, 2022
 340 KernelVersion:  6.4.0
 341 Contact:        dmaengine@vger.kernel.org
 342 Description:    Show the number of Completion Record (CR) faults this application
 343                 has caused.
 344
 345 What:           /sys/bus/dsa/devices/wq<m>.<n>/dsa<x>\!wq<m>.<n>/file<y>/cr_fault_failures
 346 Date:           Sept 14, 2022
 347 KernelVersion:  6.4.0
 348 Contact:        dmaengine@vger.kernel.org
 349 Description:    Show the number of Completion Record (CR) faults failures that this
 350                 application has caused. The failure counter is incremented when the
 351                 driver cannot fault in the address for the CR. Typically this is caused
 352                 by a bad address programmed in the submitted descriptor or a malicious
 353                 submitter is using bad CR address on purpose.
 354
 355 What:           /sys/bus/dsa/devices/wq<m>.<n>/dsa<x>\!wq<m>.<n>/file<y>/pid
 356 Date:           Sept 14, 2022
 357 KernelVersion:  6.4.0
 358 Contact:        dmaengine@vger.kernel.org
 359 Description:    Show the process id of the application that opened the file. This is
 360                 helpful information for a monitor daemon that wants to kill the
 361                 application that opened the file.