From nobody Sun Feb 8 01:33:26 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) client-ip=63.128.21.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail(p=none dis=none) header.from=linux.ibm.com ARC-Seal: i=1; a=rsa-sha256; t=1605099193; cv=none; d=zohomail.com; s=zohoarc; b=Y7pj/zjVOVPU11fxzqNlYCk0gIyru6ge0BdTkG4Jsh7O98d6RpxQiW5EpBX4iUVfz9PsA2AO2+XJgx0B0qz2rt2g1fo2E6OOdIkcAIDvoVkkk4BGZsfVmo8nWMijkr8s/34YoJKb0ceMeViLCRluOIhHkwNo9y0JPXmkcCioi0A= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1605099193; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=vVmZ7O5ugsbEAjYrhiBQBU2js00KZ+PwaWNrifgONXs=; b=jjK5DRhBdJQ7Hq9W7/us7cC+5tQ7oxf1j/g9OnrJEQIG722u0YlDCVp8bck195925zvsstBGpszC7PIlht7YMV7DlvUvqi69pL7jn3a7Y3KHeAj9n4WKk1eZxqfNT36mzv2dFw7oD6IqcSpfoNOwmgGtHteFoDnVQo3jAvzC/jY= ARC-Authentication-Results: i=1; mx.zohomail.com; spf=pass (zohomail.com: domain of redhat.com designates 63.128.21.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124]) by mx.zohomail.com with SMTPS id 1605099193358579.9513676239904; Wed, 11 Nov 2020 04:53:13 -0800 (PST) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-548-V_UN5wF3NyaCazn9D3Z_zQ-1; Wed, 11 Nov 2020 07:53:09 -0500 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id DCE51803F7B; Wed, 11 Nov 2020 12:52:59 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id B40DE55775; Wed, 11 Nov 2020 12:52:59 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 28216180954D; Wed, 11 Nov 2020 12:52:59 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 0ABCjlYF031031 for ; Wed, 11 Nov 2020 07:45:47 -0500 Received: by smtp.corp.redhat.com (Postfix) id 44D541004046; Wed, 11 Nov 2020 12:45:47 +0000 (UTC) Received: from mimecast-mx02.redhat.com (mimecast06.extmail.prod.ext.rdu2.redhat.com [10.11.55.22]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 401B010F1CDB for ; Wed, 11 Nov 2020 12:45:45 +0000 (UTC) Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 5B091185A7A2 for ; Wed, 11 Nov 2020 12:45:45 +0000 (UTC) Received: from mx0a-001b2d01.pphosted.com (mx0a-001b2d01.pphosted.com [148.163.156.1]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-128-n5G5VfnDMuuFhkL7ylAN9A-1; Wed, 11 Nov 2020 07:45:41 -0500 Received: from pps.filterd (m0098399.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.42/8.16.0.42) with SMTP id 0ABCXfT6039816; Wed, 11 Nov 2020 07:45:40 -0500 Received: from ppma04ams.nl.ibm.com (63.31.33a9.ip4.static.sl-reverse.com [169.51.49.99]) by mx0a-001b2d01.pphosted.com with ESMTP id 34r8a8cypv-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Wed, 11 Nov 2020 07:45:39 -0500 Received: from pps.filterd (ppma04ams.nl.ibm.com [127.0.0.1]) by ppma04ams.nl.ibm.com (8.16.0.42/8.16.0.42) with SMTP id 0ABCi43r017195; Wed, 11 Nov 2020 12:45:37 GMT Received: from b06cxnps4075.portsmouth.uk.ibm.com (d06relay12.portsmouth.uk.ibm.com [9.149.109.197]) by ppma04ams.nl.ibm.com with ESMTP id 34p26pkm7b-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Wed, 11 Nov 2020 12:45:37 +0000 Received: from d06av21.portsmouth.uk.ibm.com (d06av21.portsmouth.uk.ibm.com [9.149.105.232]) by b06cxnps4075.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id 0ABCjZtj16515362 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Wed, 11 Nov 2020 12:45:35 GMT Received: from d06av21.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 4AD7552073; Wed, 11 Nov 2020 12:45:35 +0000 (GMT) Received: from localhost.localdomain (unknown [9.145.46.190]) by d06av21.portsmouth.uk.ibm.com (Postfix) with ESMTP id 244745204E; Wed, 11 Nov 2020 12:45:35 +0000 (GMT) X-MC-Unique: V_UN5wF3NyaCazn9D3Z_zQ-1 X-MC-Unique: n5G5VfnDMuuFhkL7ylAN9A-1 From: Boris Fiuczynski To: libvir-list@redhat.com, eskultet@redhat.com Subject: [PATCH v3 1/3] docs: refactor mdev_types into new paragraph Date: Wed, 11 Nov 2020 13:45:20 +0100 Message-Id: <20201111124522.41263-2-fiuczy@linux.ibm.com> In-Reply-To: <20201111124522.41263-1-fiuczy@linux.ibm.com> References: <20201111124522.41263-1-fiuczy@linux.ibm.com> MIME-Version: 1.0 X-TM-AS-GCONF: 00 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.312, 18.0.737 definitions=2020-11-11_02:2020-11-10, 2020-11-11 signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 adultscore=0 impostorscore=0 bulkscore=0 mlxlogscore=999 priorityscore=1501 malwarescore=0 lowpriorityscore=0 suspectscore=9 spamscore=0 mlxscore=0 phishscore=0 clxscore=1015 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2009150000 definitions=main-2011110073 X-Mimecast-Impersonation-Protect: Policy=CLT - Impersonation Protection Definition; Similar Internal Domain=false; Similar Monitored External Domain=false; Custom External Domain=false; Mimecast External Domain=false; Newly Observed Domain=false; Internal User Name=false; Custom Display Name List=false; Reply-to Address Mismatch=false; Targeted Threat Dictionary=false; Mimecast Threat Dictionary=false; Custom Threat Dictionary=false X-Scanned-By: MIMEDefang 2.78 on 10.11.54.3 X-loop: libvir-list@redhat.com Cc: jtomko@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" To prevent copying the mdev_types description multiple times it is refactored into a new paragraph for easy reuse. Signed-off-by: Boris Fiuczynski Reviewed-by: Bjoern Walk Reviewed-by: Erik Skultety --- docs/drvnodedev.html.in | 2 +- docs/formatnode.html.in | 69 ++++++++++++++++++++++++----------------- 2 files changed, 41 insertions(+), 30 deletions(-) diff --git a/docs/drvnodedev.html.in b/docs/drvnodedev.html.in index 0823c1888d..639f58d8ce 100644 --- a/docs/drvnodedev.html.in +++ b/docs/drvnodedev.html.in @@ -144,7 +144,7 @@ types on the physical device, along with the type attributes availab= le through sysfs. A detailed description of the XML format for the mdev_types capability can be found - here. + here.

The following example shows how we might represent an NVIDIA GPU dev= ice diff --git a/docs/formatnode.html.in b/docs/formatnode.html.in index 6928bdd69c..3fad842c53 100644 --- a/docs/formatnode.html.in +++ b/docs/formatnode.html.in @@ -159,35 +159,10 @@

mdev_types
- This device is capable of creating mediated devices, a= nd - the capability will contain a list of type - elements, which list all mdev types supported on the - physical device. Since 3.4.0 - Each type element has a single id - attribute that holds an official vendor-supplied ident= ifier - for the type. It supports the following sub-elements: -
-
name
-
- The name element holds a vendor-sup= plied - code name for the given mediated device type. Th= is is - an optional element. -
-
deviceAPI
-
- The value of this element describes how an instanc= e of - the given type will be presented to the guest by t= he - VFIO framework. -
-
availableInstances
-
- This element reports the current state of resource - allocation. In other words, how many instances of = the - given type can still be successfully created on the - physical device. -
-
-
+ This device is capable of creating mediated devices. + The sub-elements are summarized in + mdev_types capability. + =20 @@ -445,6 +420,42 @@ =20 +

mdev_types capability

+ +

+ PCI devices can be capable of + creating mediated devices. If they indeed are capable, + then the parent capability element for + mdev_types type will contain a list of + type elements, which list all mdev types supported + on the physical device. Since 3.4.0 + Each type element has a single id + attribute that holds an official vendor-supplied identifier + for the type. It supports the following sub-elements: +

+
name
+
+ The name element holds a vendor-supplied + code name for the given mediated device type. This is + an optional element. +
+
deviceAPI
+
+ The value of this element describes how an instance of + the given type will be presented to the guest by the + VFIO framework. +
+
availableInstances
+
+ This element reports the current state of resource + allocation. In other words, how many instances of the + given type can still be successfully created on the + physical device. +
+
+

+ +

Examples

=20

The following are some example node device XML outputs:

--=20 2.26.2