From nobody Sun Feb 8 22:57:50 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=1595510551; cv=none; d=zohomail.com; s=zohoarc; b=lCoVJy5/wj7CBtUhUQy7nWhusFvPuN6pKOcXAsa0F0c0escAzYAe8LcuZxgRUx2gHmDgPfD5+QSdefV5eJjF41LNDQ2+4oF5uhCOcdgaWHppXqmKzpd0Trdkb8jmJw3AeUwyUMc+Ixv0dtep9TBFlw5FsAlSG64Oc2eE+iNql1U= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1595510551; 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=YZGg103vs+B275K1pndRfPFiPvhY3YJoXr+3R6yNqr8=; b=LZVZJbqynG37CivsBw+GuO7zqrKnuVYQKt3WKjFtxQoJNI/yWu0RMXF2KQ/T6qEgvrftZb2rRMiEpUY24hVBI8t90uf4gqytzFVHkvaoB7BAbyNo6U1bUEPNLM4OW9IxrFXcYPU4norRcrbAYnzQ3eBaWd1hjYaDmJu2wlXiyRs= 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 1595510551412957.7920036405405; Thu, 23 Jul 2020 06:22:31 -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-369-Mxyn6Ia-PiGVquKS43wdhg-1; Thu, 23 Jul 2020 09:22:28 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 87E9B100CD17; Thu, 23 Jul 2020 13:22:17 +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 6451F5DA69; Thu, 23 Jul 2020 13:22:17 +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 34E1CA3586; Thu, 23 Jul 2020 13:22:17 +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 06NDMGlk028572 for ; Thu, 23 Jul 2020 09:22:16 -0400 Received: by smtp.corp.redhat.com (Postfix) id 168201A922; Thu, 23 Jul 2020 13:22:16 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.40.208.37]) by smtp.corp.redhat.com (Postfix) with ESMTP id 56C1619D7C for ; Thu, 23 Jul 2020 13:22:15 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1595510550; 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=YZGg103vs+B275K1pndRfPFiPvhY3YJoXr+3R6yNqr8=; b=F7LBtRq73wtBSh+RQX9mUkeeyMA21smwsCiyea16CCR/bp52oqPuvA4jBfAvXUXnywLHLt 1/KL0QIBXwkG4RC1Ki7EJ32VLorZHs0KQaZtqt/yo1cNayvKz+UaTznxYgfzAlYspoxTfh LHqfBZNjnYBLz5BRpJRrQp6rH2cY/0I= X-MC-Unique: Mxyn6Ia-PiGVquKS43wdhg-1 From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 14/32] docs: formatdomain-devices: Split out Date: Thu, 23 Jul 2020 15:21:19 +0200 Message-Id: <30e401dc8036e4a2390a3ae347f738527aecdcb3.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.14 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-redirdev.rst | 50 +++++++++++++++++++++++++ docs/formatdomain-devices.rst | 52 +------------------------- docs/meson.build | 1 + 3 files changed, 52 insertions(+), 51 deletions(-) create mode 100644 docs/formatdomain-devices-redirdev.rst diff --git a/docs/formatdomain-devices-redirdev.rst b/docs/formatdomain-dev= ices-redirdev.rst new file mode 100644 index 0000000000..d2a4de8595 --- /dev/null +++ b/docs/formatdomain-devices-redirdev.rst @@ -0,0 +1,50 @@ +:anchor:`` + +Redirected devices +~~~~~~~~~~~~~~~~~~ + +USB device redirection through a character device is supported :since:`sin= ce +after 0.9.5 (KVM only)` : + +:: + + ... + + + + + + + + + + + ... + +``redirdev`` + The ``redirdev`` element is the main container for describing redirected + devices. ``bus`` must be "usb" for a USB device. An additional attribute + ``type`` is required, matching one of the supported `serial + device <#elementsConsole>`__ types, to describe the host side of the tu= nnel; + ``type=3D'tcp'`` or ``type=3D'spicevmc'`` (which uses the usbredir chan= nel of a + `SPICE graphics device <#elementsGraphics>`__) are typical. The redirdev + element has an optional sub-element ``
`` which can tie the dev= ice to + a particular controller. Further sub-elements, such as ````, ma= y be + required according to the given type, although a ```` sub-eleme= nt is + not required (since the consumer of the character device is the hypervi= sor + itself, rather than a device visible in the guest). +``boot`` + Specifies that the device is bootable. The ``order`` attribute determin= es the + order in which devices will be tried during boot sequence. The per-devi= ce + ``boot`` elements cannot be used together with general boot elements in= `BIOS + bootloader <#elementsOSBIOS>`__ section. ( :since:`Since 1.0.1` ) +``redirfilter`` + The\ ``redirfilter``\ element is used for creating the filter rule to f= ilter + out certain devices from redirection. It uses sub-element ```` = to + define each filter rule. ``class`` attribute is the USB Class code, for + example, 0x08 represents mass storage devices. The USB device can be + addressed by vendor / product id using the ``vendor`` and ``product`` + attributes. ``version`` is the device revision from the bcdDevice field= (not + the version of the USB protocol). These four attributes are optional and + ``-1`` can be used to allow any value for them. ``allow`` attribute is + mandatory, 'yes' means allow, 'no' for deny. diff --git a/docs/formatdomain-devices.rst b/docs/formatdomain-devices.rst index 3a678a387d..052d325a56 100644 --- a/docs/formatdomain-devices.rst +++ b/docs/formatdomain-devices.rst @@ -46,57 +46,7 @@ following characters: ``[a-zA-Z0-9_-]``. :since:`Since 3= .9.0` .. include:: formatdomain-devices-controller.rst .. include:: formatdomain-devices-lease.rst .. include:: formatdomain-devices-hostdev.rst - -:anchor:`` - -Redirected devices -~~~~~~~~~~~~~~~~~~ - -USB device redirection through a character device is supported :since:`sin= ce -after 0.9.5 (KVM only)` : - -:: - - ... - - - - - - - - - - - ... - -``redirdev`` - The ``redirdev`` element is the main container for describing redirected - devices. ``bus`` must be "usb" for a USB device. An additional attribute - ``type`` is required, matching one of the supported `serial - device <#elementsConsole>`__ types, to describe the host side of the tu= nnel; - ``type=3D'tcp'`` or ``type=3D'spicevmc'`` (which uses the usbredir chan= nel of a - `SPICE graphics device <#elementsGraphics>`__) are typical. The redirdev - element has an optional sub-element ``
`` which can tie the dev= ice to - a particular controller. Further sub-elements, such as ````, ma= y be - required according to the given type, although a ```` sub-eleme= nt is - not required (since the consumer of the character device is the hypervi= sor - itself, rather than a device visible in the guest). -``boot`` - Specifies that the device is bootable. The ``order`` attribute determin= es the - order in which devices will be tried during boot sequence. The per-devi= ce - ``boot`` elements cannot be used together with general boot elements in= `BIOS - bootloader <#elementsOSBIOS>`__ section. ( :since:`Since 1.0.1` ) -``redirfilter`` - The\ ``redirfilter``\ element is used for creating the filter rule to f= ilter - out certain devices from redirection. It uses sub-element ```` = to - define each filter rule. ``class`` attribute is the USB Class code, for - example, 0x08 represents mass storage devices. The USB device can be - addressed by vendor / product id using the ``vendor`` and ``product`` - attributes. ``version`` is the device revision from the bcdDevice field= (not - the version of the USB protocol). These four attributes are optional and - ``-1`` can be used to allow any value for them. ``allow`` attribute is - mandatory, 'yes' means allow, 'no' for deny. +.. include:: formatdomain-devices-redirdev.rst :anchor:`` diff --git a/docs/meson.build b/docs/meson.build index 9b65954a51..4ed30cc737 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -131,6 +131,7 @@ docs_rst_files =3D [ 'formatdomain-devices-controller.rst', 'formatdomain-devices-lease.rst', 'formatdomain-devices-hostdev.rst', + 'formatdomain-devices-redirdev.rst', ] }, { 'name': 'hacking' }, --=20 2.26.2