'\" t
.\" Title: accel-config-config-wq
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot
.\" Date: 02/24/2023
.\" Manual: accfg Manual
.\" Source: accfg 3.5.3+
.\" Language: English
.\"
.TH "ACCEL\-CONFIG\-CONFI" "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-config-wq \- configure individual attributes of a work queue
.SH "SYNOPSIS"
.sp
.nf
\fIaccel\-config config\-wq / []\fR
.fi
.SH "EXAMPLE"
.sp
accel\-config config\-wq dsa0/wq0\&.0 \-\-wq\-size=16
.SH "OPTIONS"
.PP
\-g, \-\-group\-id=
.RS 4
specify the group id used by work queue, group id should be between 0 and the maximum number of groups per device\&. A group id of \-1 disassociates the work queue from a group\&.
.RE
.PP
\-s, \-\-wq\-size=
.RS 4
specify work queue size used by a work queue\&. The wq\-size should be between 0 and the maximum workqueue size exposed by the device in the max_work_queue_size attribute under device\&.
.RE
.PP
\-p, \-\-priority
.RS 4
specify the priority of this work queue relative to other work queues in the same group\&. This field ranges from 1 to 15 where the larger value means higher priority\&. For example, if wq1 has a priority of 6 and wq2 has priority of 2, wq1 will issue 3 times as many descriptors to the engine compare to wq2\&.
.RE
.PP
\-b, \-\-block\-on\-fault
.RS 4
toggle block on fault enable for the work queue\&. block\-on\-fault should be either 0 or 1\&. If block on fault is disabled, if a page fault occurs on a source or destination memory access, the operation stops and the page fault is reported to the software\&.
.RE
.PP
\-t, \-\-threshold
.RS 4
configure the threshold for the wq\&. The set up threshold value should be larger than 0 and only for "shared" wq, and note that the configured threshold value should be at least 1 less than the configured wq\-size value\&. The reason is threshold is set for unprivileged users, and need to reserve at least 1 space for the privileged user for commands\&.
.RE
.PP
\-y, \-\-type
.RS 4
configure the type for the wq\&. The wq type can be "kernel" for kernel user case to request wq or "user" for regular character device driver use case to wq\&.
.RE
.PP
\-n, \-\-name
.RS 4
configure the name for the wq\&. This can be any string defined by the user\&. Typically it is used for identifying the wq in some unique way\&. A possible suggestion would be using a uuid string\&.
.RE
.PP
\-d, \-\-driver\-name
.RS 4
specify the name of the driver to bind\&. This should be one of the valid wq drivers found in /sys/bus/dsa/drivers
.RE
.PP
\-m, \-\-mode
.RS 4
configure the mode for the wq\&. The wq mode can be set as "dedicated" or "shared"\&.
.RE
.PP
\-c, \-\-max\-batch\-size
.RS 4
specify the max batch size used by a work queue\&. The value should be between 1 and the device maximum batch size found in the max_batch_size attribute under device\&. If the value is not a power of 2, it will be rounded up to the next power of 2\&.
.RE
.PP
\-x, \-\-max\-transfer\-size
.RS 4
specify the max transfer size used by a work queue\&. The value should be between 1 and the device maximum transfer size found in the max_transfer_size attribute under device\&. If the value is not a power of 2, it will be rounded up to the next power of 2\&.
.RE
.PP
\-a, \-\-ats\-disable
.RS 4
toggle whether ATS disable is turned on for the work queue\&. The value should be either 0 or 1\&. 0 indicates ATS is on, and 1 indicates ATS is off for the work queue\&.
.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\&.