'\" t
.\"     Title: accel-config-list
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 02/24/2023
.\"    Manual: accfg Manual
.\"    Source: accfg 3.5.3+
.\"  Language: English
.\"
.TH "ACCEL\-CONFIG\-LIST" "1" "02/24/2023" "accfg 3\&.5\&.3+" "accfg Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
accel-config-list \- display the platform accfg device(s) topology and attributes in json format
.SH "SYNOPSIS"
.sp
.nf
\fIaccel\-config list\fR [<options>]
.fi
.sp
List all the active DSA devices discovered by the driver and the driver exported attributes\&.
.sp
Options can be specified to limit the output to devices of a certain grouping where the grouping are devices, groups, work queues and engines\&. By default, \fIaccel\-config list\fR with no options is equivalent to:
.sp
.nf
accel\-config list \-\-devices \-\-engines \-\-groups \-\-workqueues
.fi
.SH "EXAMPLE"
.sp
.if n \{\
.RS 4
.\}
.nf

\&.ft C
# accel\-config list
[
  {
    "dev":"dsa0",
    "read_buffer_limit":0,
    "max_groups":4,
    "max_work_queues":8,
    "max_engines":4,
    "work_queue_size":64,
    "numa_node":\-1,
    "op_cap":"0x1003f03ff",
    "state":"enabled",
    "max_read_buffers":64,
    "max_batch_size":512,
    "ims_size":256,
    "max_transfer_size":2147483648,
    "configurable":1,
    "pasid_enabled":1,
    "cdev_major":247,
    "clients":2,
    "groups":[
      {
        "dev":"group0\&.0",
        "read_buffers_reserved":0,
        "use_read_buffer_limit":0,
        "read_buffers_allowed":0,
        "traffic_class_a":\-1,
        "traffic_class_b":\-1,
        "grouped_workqueues":[
          {
            "dev":"wq0\&.0",
            "mode":"shared",
            "size":16,
            "group_id":0,
            "priority":10,
            "block_on_fault":1,
            "cdev_minor":0,
            "type":"user",
            "name":"app1",
            "threshold":15,
            "state":"enabled",
            "clients":1
          }
        ],
        "grouped_engines":[
          {
            "dev":"engine0\&.0",
            "group_id":0
          },
          {
            "dev":"engine0\&.1",
            "group_id":0
          }
        ]
      },
      {
        "dev":"group0\&.1",
        "read_buffers_reserved":0,
        "use_read_buffer_limit":0,
        "read_buffers_allowed":0,
        "traffic_class_a":\-1,
        "traffic_class_b":\-1,
        "grouped_workqueues":[
          {
            "dev":"wq0\&.1",
            "mode":"dedicated",
            "size":16,
            "group_id":1,
            "priority":10,
            "block_on_fault":1,
            "cdev_minor":1,
            "type":"user",
            "name":"app2",
            "threshold":0,
            "state":"enabled",
            "clients":1
          }
        ],
        "grouped_engines":[
          {
            "dev":"engine0\&.2",
            "group_id":1
          },
          {
            "dev":"engine0\&.3",
            "group_id":1
          }
        ]
      },
      {
        "dev":"group0\&.2",
        "read_buffers_reserved":0,
        "use_read_buffer_limit":0,
        "read_buffers_allowed":0,
        "traffic_class_a":\-1,
        "traffic_class_b":\-1
      },
      {
        "dev":"group0\&.3",
        "read_buffers_reserved":0,
        "use_read_buffer_limit":0,
        "read_buffers_allowed":0,
        "traffic_class_a":\-1,
        "traffic_class_b":\-1
      }
    ]
  }
]
\&.ft

.fi
.if n \{\
.RE
.\}
.SH "OPTIONS"
.PP
\-d, \-\-device=
.RS 4
listing by devices that reference the given device\&.
.RE
.PP
\-g, \-\-group=
.RS 4
An
\fIgroupX\&.Y\fR
group name, or device id plus group id tuple
\fIX\&.Y\fR\&. Limit the group list to the single identified device if present\&.
.RE
.PP
\-q, \-\-workqueue=
.RS 4
An
\fIwqX\&.Y\fR
workqueue name, or device id plus workqueue id tuple
\fIX\&.Y\fR\&. Limit the workqueue list to the single identified device if present\&.
.RE
.PP
\-e, \-\-engine=
.RS 4
An
\fIengineX\&.Y\fR
engine name, or device id plus engine id tuple
\fIX\&.Y\fR\&. Limit the engine list to the single identified device if present\&.
.RE
.PP
\-D, \-\-devices
.RS 4
Include device info in the listing
.RE
.PP
\-G, \-\-regions
.RS 4
Include group info in the listing
.RE
.PP
\-Q, \-\-workqueues
.RS 4
Include active workqueue info in the listing
.RE
.PP
\-E, \-\-engines
.RS 4
Include active engine info in the listing
.RE
.PP
\-i, \-\-idle
.RS 4
Include both idle (not enabled) and active devices in the listing
.RE
.SH "COPYRIGHT"
.sp
Copyright (c) 2016 \- 2019, Intel Corporation\&. License GPLv2: GNU GPL version 2 \m[blue]\fBhttp://gnu\&.org/licenses/gpl\&.html\fR\m[]\&. This is free software: you are free to change and redistribute it\&. There is NO WARRANTY, to the extent permitted by law\&.