From nobody Sun Feb 8 23:05:38 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 207.211.31.120 as permitted sender) client-ip=207.211.31.120; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1595510628; cv=none; d=zohomail.com; s=zohoarc; b=nKlPu0JoiT5m7ZHA4PUYEvJcekzfuG/Vmw1lJbs7UjpXyCfGMlb/+U6kywGRkg+wUurcS3pRXs3CXOcozsZ2F6F/0ISXyx7LLPh70ZpSkq+nB7vz7da4XP9HCtC9h0jPbRrji1fPs77+Ci3KLAlrPmBXMU194RmMLR/y+6KQ+DU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1595510628; h=Content-Type:Content-Transfer-Encoding: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=gNO05VjGVCScpeM4VqVPDCvg3B5h+bw29HlXiZKeFec=; b=ALzcHKjZ5TlE+otDzodCvp+yeYPbD1WmA9oLeHGdgsEcEz94R0PSj4SrWvV4Jtv0l47AmhpIs3mWwhcOlIdpkcAhDRlL7YfIHnPW8MArnHCAe9BIbFZ8XvUHqzrfWKgnoBTk46UKnNejABtqf6GLlLhVcCVo1JGxlhutANxoIT0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [207.211.31.120]) by mx.zohomail.com with SMTPS id 1595510628513783.7723416957405; Thu, 23 Jul 2020 06:23:48 -0700 (PDT) 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-149-bz2geIn7MWabzkweWM2Odg-1; Thu, 23 Jul 2020 09:22:55 -0400 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 016308005B0; Thu, 23 Jul 2020 13:22:49 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id D91EB72683; Thu, 23 Jul 2020 13:22:48 +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 AA7F4A35A0; Thu, 23 Jul 2020 13:22:48 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 06NDMjnj028831 for ; Thu, 23 Jul 2020 09:22:45 -0400 Received: by smtp.corp.redhat.com (Postfix) id 4FB1F1A922; Thu, 23 Jul 2020 13:22:45 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.40.208.37]) by smtp.corp.redhat.com (Postfix) with ESMTP id A3ED01A90F for ; Thu, 23 Jul 2020 13:22:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1595510627; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=gNO05VjGVCScpeM4VqVPDCvg3B5h+bw29HlXiZKeFec=; b=Tr9rlRyfNtHo7lFD0N3Myy7zLmTTx9zflKISWG/jrIHPoAQFcPCOVotYIZ/6WCydDE3RqQ wL7yGBNg+Tgz2ObB4Mh6VkqiuE5+Hm4rZQMC721W5RZTD9f5qt6/9J5ZgD8tJQX5gqUkqc ZaA5dBijBIriVuxeeDNN28wAEgL7NJw= X-MC-Unique: bz2geIn7MWabzkweWM2Odg-1 From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 31/32] docs: formatdomain-devices: Split out Date: Thu, 23 Jul 2020 15:21:36 +0200 Message-Id: <1ed7828a7036b83e77cd3023b51b14d5319c49fe.1595510131.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-loop: libvir-list@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 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Signed-off-by: Peter Krempa --- docs/formatdomain-devices-iommu.rst | 54 ++++++++++++++++++++++++++++ docs/formatdomain-devices.rst | 56 +---------------------------- docs/meson.build | 1 + 3 files changed, 56 insertions(+), 55 deletions(-) create mode 100644 docs/formatdomain-devices-iommu.rst diff --git a/docs/formatdomain-devices-iommu.rst b/docs/formatdomain-device= s-iommu.rst new file mode 100644 index 0000000000..50f83c8f31 --- /dev/null +++ b/docs/formatdomain-devices-iommu.rst @@ -0,0 +1,54 @@ +:anchor:`` + +IOMMU devices +~~~~~~~~~~~~~ + +The ``iommu`` element can be used to add an IOMMU device. :since:`Since 2.= 1.0` + +Example: + +:: + + ... + + + + + + ... + +``model`` + Supported values are ``intel`` (for Q35 guests) and, :since:`since 5.5.= 0` , + ``smmuv3`` (for ARM virt guests). + +``driver`` + The ``driver`` subelement can be used to configure additional options, = some + of which might only be available for certain IOMMU models: + + ``intremap`` + The ``intremap`` attribute with possible values ``on`` and ``off`` c= an be + used to turn on interrupt remapping, a part of the VT-d functionalit= y. + Currently this requires split I/O APIC (```= `). + :since:`Since 3.4.0` (QEMU/KVM only) + + ``caching_mode`` + The ``caching_mode`` attribute with possible values ``on`` and ``off= `` can + be used to turn on the VT-d caching mode (useful for assigned device= s). + :since:`Since 3.4.0` (QEMU/KVM only) + + ``eim`` + The ``eim`` attribute (with possible values ``on`` and ``off``) can = be + used to configure Extended Interrupt Mode. A q35 domain with split I= /O + APIC (as described in `hypervisor features <#elementsFeatures>`__), = and + both interrupt remapping and EIM turned on for the IOMMU, will be ab= le to + use more than 255 vCPUs. :since:`Since 3.4.0` (QEMU/KVM only) + + ``iotlb`` + The ``iotlb`` attribute with possible values ``on`` and ``off`` can = be + used to turn on the IOTLB used to cache address translation requests= from + devices. :since:`Since 3.5.0` (QEMU/KVM only) + + ``aw_bits`` + The ``aw_bits`` attribute can be used to set the address width to al= low + mapping larger iova addresses in the guest. :since:`Since 6.5.0` (QE= MU/KVM + only) diff --git a/docs/formatdomain-devices.rst b/docs/formatdomain-devices.rst index 827233af64..39887bc1bf 100644 --- a/docs/formatdomain-devices.rst +++ b/docs/formatdomain-devices.rst @@ -63,61 +63,7 @@ following characters: ``[a-zA-Z0-9_-]``. :since:`Since 3= .9.0` .. include:: formatdomain-devices-panic.rst .. include:: formatdomain-devices-shmem.rst .. include:: formatdomain-devices-memory.rst - -:anchor:`` - -IOMMU devices -~~~~~~~~~~~~~ - -The ``iommu`` element can be used to add an IOMMU device. :since:`Since 2.= 1.0` - -Example: - -:: - - ... - - - - - - ... - -``model`` - Supported values are ``intel`` (for Q35 guests) and, :since:`since 5.5.= 0` , - ``smmuv3`` (for ARM virt guests). - -``driver`` - The ``driver`` subelement can be used to configure additional options, = some - of which might only be available for certain IOMMU models: - - ``intremap`` - The ``intremap`` attribute with possible values ``on`` and ``off`` c= an be - used to turn on interrupt remapping, a part of the VT-d functionalit= y. - Currently this requires split I/O APIC (```= `). - :since:`Since 3.4.0` (QEMU/KVM only) - - ``caching_mode`` - The ``caching_mode`` attribute with possible values ``on`` and ``off= `` can - be used to turn on the VT-d caching mode (useful for assigned device= s). - :since:`Since 3.4.0` (QEMU/KVM only) - - ``eim`` - The ``eim`` attribute (with possible values ``on`` and ``off``) can = be - used to configure Extended Interrupt Mode. A q35 domain with split I= /O - APIC (as described in `hypervisor features <#elementsFeatures>`__), = and - both interrupt remapping and EIM turned on for the IOMMU, will be ab= le to - use more than 255 vCPUs. :since:`Since 3.4.0` (QEMU/KVM only) - - ``iotlb`` - The ``iotlb`` attribute with possible values ``on`` and ``off`` can = be - used to turn on the IOTLB used to cache address translation requests= from - devices. :since:`Since 3.5.0` (QEMU/KVM only) - - ``aw_bits`` - The ``aw_bits`` attribute can be used to set the address width to al= low - mapping larger iova addresses in the guest. :since:`Since 6.5.0` (QE= MU/KVM - only) +.. include:: formatdomain-devices-iommu.rst :anchor:`` diff --git a/docs/meson.build b/docs/meson.build index f0f7690d54..86d98a1558 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -148,6 +148,7 @@ docs_rst_files =3D [ 'formatdomain-devices-panic.rst', 'formatdomain-devices-shmem.rst', 'formatdomain-devices-memory.rst', + 'formatdomain-devices-iommu.rst', ] }, { 'name': 'hacking' }, --=20 2.26.2