Content-Type: multipart/mixed; boundary="===============0185713984287715194==" MIME-Version: 1.0 From: ramesh.thomas at intel.com Subject: [Accel-config] [PATCH v1 10/11] accel-config: Add documentation for mdev commands Date: Wed, 02 Dec 2020 14:30:56 -0500 Message-ID: <20201202193057.299615-11-ramesh.thomas@intel.com> In-Reply-To: 20201202193057.299615-1-ramesh.thomas@intel.com To: accel-config@lists.01.org List-ID: --===============0185713984287715194== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Ramesh Thomas Add manual pages for create-mdev and remove-mdev commands Also added missing pages for some config-wq options Signed-off-by: Ramesh Thomas --- .../accfg/accel-config-config-wq.txt | 15 +++++++++ .../accfg/accel-config-create-mdev.txt | 32 +++++++++++++------ .../accfg/accel-config-remove-mdev.txt | 26 +++++++++++---- 3 files changed, 57 insertions(+), 16 deletions(-) diff --git a/Documentation/accfg/accel-config-config-wq.txt b/Documentation= /accfg/accel-config-config-wq.txt index 58be829..3ede09c 100644 --- a/Documentation/accfg/accel-config-config-wq.txt +++ b/Documentation/accfg/accel-config-config-wq.txt @@ -64,4 +64,19 @@ OPTIONS configure the mode for the wq. The wq mode can be set as "dedicated" or "shared". = +-c:: +--max-batch-size:: + 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. + +-x:: +--max-transfer-size:: + 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. + + include::../copyright.txt[] diff --git a/Documentation/accfg/accel-config-create-mdev.txt b/Documentati= on/accfg/accel-config-create-mdev.txt index 1994657..09aa06b 100644 --- a/Documentation/accfg/accel-config-create-mdev.txt +++ b/Documentation/accfg/accel-config-create-mdev.txt @@ -5,21 +5,35 @@ accel-config-create-mdev(1) = NAME ---- -accel-config-create-mdev - create mdev to a specified workqueue by generat= ing a -random uuid and writing to workqueue sysfs. The workqueue has to be enabled -before running this command and it has to be configured as "mdev" type. If= the -workqueue type is shared, this command can be issued multiple times. If the -workqueue is dedicated, only one uuid is allowed to be created. If this co= mmand -is issued to a dedicated wq with uuid already existing, it will trigger -operation not permitted error. +accel-config-create-mdev - create mdev to enabled workqueues of devices. +A uuid is generated which is associated with the mdev and will be stored in +/sys/class/mdev_bus under the device pcie bdf id. Creation of mdevs require +enabled workqueues. For mdevs of the shared type, at least one shared +mode workqueue needs to be enabled. Each dedicated type mdev require one +dedicated mode workqueue to be enabled. Creation of dedicated type mdevs +would set the state of workqueue used as "locked". Creation of shared +type mdevs do not alter the state of workqueues. = SYNOPSIS -------- [verse] -'accel-config create-mdev' / +'accel-config create-mdev [|]' = EXAMPLE ------- -accel-config create-mdev dsa0/wq0.0 +accel-config create-mdev dsa0 1dwq + +accel-config create-mdev dsa0 -l +---- +Available mdev types: + 1dwq + 1swq +---- + +OPTIONS +-------- +-l:: +--list-mdev-types:: + list the available mdev types = include::../copyright.txt[] diff --git a/Documentation/accfg/accel-config-remove-mdev.txt b/Documentati= on/accfg/accel-config-remove-mdev.txt index f327a98..90cab5a 100644 --- a/Documentation/accfg/accel-config-remove-mdev.txt +++ b/Documentation/accfg/accel-config-remove-mdev.txt @@ -5,22 +5,34 @@ accel-config-remove-mdev(1) = NAME ---- -accel-config-remove-mdev - clear the uuid from a workqueue uuid list. If n= ot uuid is -specified, then entire uuid list in this workqueue will be removed. +accel-config-remove-mdev - remove mdev of a device associated with +the passed uuid. Passing a null uuid will remove all mdevs of the +device. = SYNOPSIS -------- [verse] -'accel-config remove-mdev' / [] +'accel-config remove-mdev [|]' = EXAMPLE ------- -accel-config remove-mdev dsa0/wq0.0 --uuid=3D0f34f0ed-6f67-4086-a4b7-8e1ec= f077dce +accel-config remove-mdev dsa0 0f34f0ed-6f67-4086-a4b7-8e1ecf077dce = +accel-config remove-mdev dsa0 00000000-0000-0000-0000-000000000000 + +accel-config remove-mdev dsa0 -l +---- +Available mdevs: + uuid:edc13abf-cbf4-4de8-bf01-0dc864c54290, type:1dwq + uuid:7e776dce-a80b-4da8-9b13-d0483bff678f, type:1swq + uuid:45174189-1b18-4270-9f02-30cadbd4b1a4, type:1swq + uuid:3c53af36-be6f-405f-9ebf-d556e0735943, type:1swq + uuid:131a1337-4c32-48a0-97a7-0aac053f383c, type:1swq +---- OPTIONS ------- --u:: ---uuid=3D:: - remove this specific uuid from uuid list in the specified workqueue. +-l:: +--list-mdevs:: + list available mdevs of device = include::../copyright.txt[] -- = 2.26.2 --===============0185713984287715194==--