From nobody Mon Feb 9 03:00:08 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) client-ip=205.139.110.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 205.139.110.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=1595510554; cv=none; d=zohomail.com; s=zohoarc; b=dl3z/3fu2iCx5cZCgL0auyTQWY9CeGrf3kErmyz+IWCVmqCt2nXN4HXJU2hunhtk8E28JGu2e4WIbFa+r0FwG+2W6NDmm9B2jrPW2wW9/yPJwLYVDzsy8RzQU4o9vCzONe/vBpsh+QHct7QZESOxZn6Omc5B4fwz4VKqeDT3dZ4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1595510554; 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=ja/NZ3iYPFMYRXC8x3S9dE1bKyQ4vu+1oK+jsqZg3+E=; b=YunhUyJQLESOR+ph+CaR84cLyqrPBq45rxxahtZuy0SZmS990SXfcl76AvxAD00zZybhg4/YrjymhhUHDD7cVlUEr3Llr7UUtZsuHBrpOmsYiWrq+iO3HllMV7zzpXInkdL/PO5nwB2IVLUtRbDm5i7kpEdrt5wV7cc4CJGeuzQ= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.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 [205.139.110.120]) by mx.zohomail.com with SMTPS id 1595510554897691.966338752151; Thu, 23 Jul 2020 06:22:34 -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-18-Y4RUkPULOfuwECLaLWgKbw-1; Thu, 23 Jul 2020 09:22:31 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id F2F34E91A; Thu, 23 Jul 2020 13:22:25 +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 D2B568BEE2; Thu, 23 Jul 2020 13:22:25 +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 A6BABA358D; Thu, 23 Jul 2020 13:22:25 +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 06NDMKdT028607 for ; Thu, 23 Jul 2020 09:22:20 -0400 Received: by smtp.corp.redhat.com (Postfix) id 3793C19D7C; Thu, 23 Jul 2020 13:22:20 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.40.208.37]) by smtp.corp.redhat.com (Postfix) with ESMTP id 71D341A921 for ; Thu, 23 Jul 2020 13:22:19 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1595510553; 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=ja/NZ3iYPFMYRXC8x3S9dE1bKyQ4vu+1oK+jsqZg3+E=; b=NFZ+TJN4Y/wTPoMVe4gI8dlbzziEVbD+B8GZ+UtGMdrxviZVYGaU2UIeXsWy/AvENLp3Jv ZPuvy1SmbxY+glH21cmPo/PP4vyxttir0TAEiY6dqkTf34NP2cEQAOyWBL4uFlfaw1y1XT VSF9ylEuehyWWyjn6CXextqc0Qh8afQ= X-MC-Unique: Y4RUkPULOfuwECLaLWgKbw-1 From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 17/32] docs: formatdomain-devices: Split out Date: Thu, 23 Jul 2020 15:21:22 +0200 Message-Id: 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.13 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 X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Signed-off-by: Peter Krempa --- docs/formatdomain-devices-input.rst | 46 +++++++++++++++++++++++++++ docs/formatdomain-devices.rst | 48 +---------------------------- docs/meson.build | 1 + 3 files changed, 48 insertions(+), 47 deletions(-) create mode 100644 docs/formatdomain-devices-input.rst diff --git a/docs/formatdomain-devices-input.rst b/docs/formatdomain-device= s-input.rst new file mode 100644 index 0000000000..7430a118fe --- /dev/null +++ b/docs/formatdomain-devices-input.rst @@ -0,0 +1,46 @@ +:anchor:`` + +Input devices +~~~~~~~~~~~~~ + +Input devices allow interaction with the graphical framebuffer in the guest +virtual machine. When enabling the framebuffer, an input device is automat= ically +provided. It may be possible to add additional devices explicitly, for exa= mple, +to provide a graphics tablet for absolute cursor movement. + +:: + + ... + + + + + + + + + + + ... + +``input`` + The ``input`` element has one mandatory attribute, the ``type`` whose v= alue + can be 'mouse', 'tablet', ( :since:`since 1.2.2` ) 'keyboard' or ( + :since:`since 1.3.0` ) 'passthrough'. The tablet provides absolute curs= or + movement, while the mouse uses relative movement. The optional ``bus`` + attribute can be used to refine the exact device type. It takes values = "xen" + (paravirtualized), "ps2" and "usb" or ( :since:`since 1.3.0` ) "virtio". + +The ``input`` element has an optional sub-element ``
`` which can = tie +the device to a particular PCI slot, `documented above <#elementsAddress>`= __. On +S390, ``address`` can be used to provide a CCW address for an input device= ( +:since:`since 4.2.0` ). For type ``passthrough``, the mandatory sub-element +``source`` must have an ``evdev`` attribute containing the absolute path t= o the +event device passed through to guests. (KVM only) :since:`Since 5.2.0` , t= he +``input`` element accepts a ``model`` attribute which has the values 'virt= io', +'virtio-transitional' and 'virtio-non-transitional'. See `Virtio transitio= nal +devices <#elementsVirtioTransitional>`__ for more details. + +The subelement ``driver`` can be used to tune the virtio options of the de= vice: +`Virtio-specific options <#elementsVirtio>`__ can also be set. ( :since:`S= ince +3.5.0` ) diff --git a/docs/formatdomain-devices.rst b/docs/formatdomain-devices.rst index 4334feb428..5c210ffe09 100644 --- a/docs/formatdomain-devices.rst +++ b/docs/formatdomain-devices.rst @@ -49,53 +49,7 @@ following characters: ``[a-zA-Z0-9_-]``. :since:`Since 3= .9.0` .. include:: formatdomain-devices-redirdev.rst .. include:: formatdomain-devices-smartcard.rst .. include:: formatdomain-devices-interface.rst - -:anchor:`` - -Input devices -~~~~~~~~~~~~~ - -Input devices allow interaction with the graphical framebuffer in the guest -virtual machine. When enabling the framebuffer, an input device is automat= ically -provided. It may be possible to add additional devices explicitly, for exa= mple, -to provide a graphics tablet for absolute cursor movement. - -:: - - ... - - - - - - - - - - - ... - -``input`` - The ``input`` element has one mandatory attribute, the ``type`` whose v= alue - can be 'mouse', 'tablet', ( :since:`since 1.2.2` ) 'keyboard' or ( - :since:`since 1.3.0` ) 'passthrough'. The tablet provides absolute curs= or - movement, while the mouse uses relative movement. The optional ``bus`` - attribute can be used to refine the exact device type. It takes values = "xen" - (paravirtualized), "ps2" and "usb" or ( :since:`since 1.3.0` ) "virtio". - -The ``input`` element has an optional sub-element ``
`` which can = tie -the device to a particular PCI slot, `documented above <#elementsAddress>`= __. On -S390, ``address`` can be used to provide a CCW address for an input device= ( -:since:`since 4.2.0` ). For type ``passthrough``, the mandatory sub-element -``source`` must have an ``evdev`` attribute containing the absolute path t= o the -event device passed through to guests. (KVM only) :since:`Since 5.2.0` , t= he -``input`` element accepts a ``model`` attribute which has the values 'virt= io', -'virtio-transitional' and 'virtio-non-transitional'. See `Virtio transitio= nal -devices <#elementsVirtioTransitional>`__ for more details. - -The subelement ``driver`` can be used to tune the virtio options of the de= vice: -`Virtio-specific options <#elementsVirtio>`__ can also be set. ( :since:`S= ince -3.5.0` ) +.. include:: formatdomain-devices-input.rst :anchor:`` diff --git a/docs/meson.build b/docs/meson.build index 9846b3e7df..1484be45df 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -134,6 +134,7 @@ docs_rst_files =3D [ 'formatdomain-devices-redirdev.rst', 'formatdomain-devices-smartcard.rst', 'formatdomain-devices-interface.rst', + 'formatdomain-devices-input.rst', ] }, { 'name': 'hacking' }, --=20 2.26.2