From patchwork Wed Nov 1 15:04:47 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Oleksandr Grytsov X-Patchwork-Id: 10036467 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id AB0A9604D7 for ; Wed, 1 Nov 2017 15:07:34 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 674E02843B for ; Wed, 1 Nov 2017 15:07:34 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 5C16928C52; Wed, 1 Nov 2017 15:07:34 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-3.6 required=2.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED, FREEMAIL_FROM, RCVD_IN_DNSWL_MED, RCVD_IN_SORBS_SPAM, T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id AF22228C4D for ; Wed, 1 Nov 2017 15:07:33 +0000 (UTC) Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1e9uZj-00057m-Aq; Wed, 01 Nov 2017 15:05:03 +0000 Received: from mail6.bemta3.messagelabs.com ([195.245.230.39]) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1e9uZh-00055l-U9 for xen-devel@lists.xenproject.org; Wed, 01 Nov 2017 15:05:02 +0000 Received: from [85.158.137.68] by server-7.bemta-3.messagelabs.com id 32/94-08856-D92E9F95; Wed, 01 Nov 2017 15:05:01 +0000 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFjrJIsWRWlGSWpSXmKPExsVyMfS6o+6cRz8 jDbbeVLL4vmUykwOjx+EPV1gCGKNYM/OS8isSWDNWrWplLJigXnFw7j22Bsb9Cl2MXBxCAjMY Ja5/vsAC4rAIvGSRWPxxD5gjIdDPKjHh7zXWLkYOICdL4um3xC5GTiAzTeLU+3OMEHa5xPwJh 1lBbCEBeYmDLZfZIaZOYZLYtGgLC0iCTUBL4v7tFWwgtoiAksS9VZOZQGxmgRSJvevawAYJC1 hIbPx9AayGRUBVovvcb2YQm1fAXmLJjTmsEMvkJG6e6wSLcwo4SNx+MZcF5DYhoJrdVyonMAo uYGRYxahRnFpUllqka2Spl1SUmZ5RkpuYmaNraGCsl5taXJyYnpqTmFSsl5yfu4kRGHD1DAyM Oxib9vodYpTkYFIS5dW8/zNSiC8pP6UyI7E4I76oNCe1+BCjBgeHwM+nf1sYpVjy8vNSlSR4A x8C1QkWpaanVqRl5gBjAqZUgoNHSYT36AOgNG9xQWJucWY6ROoUoz3HhTuX/jBxHNhzC0h23L wLJJ/NfN3ALAQ2VUqclwEYhUICIG0ZpXlwQ2ExfIlRVkqYl5GBgUGIpyC1KDezBFX+FaM4B6O SMO9pkNt4MvNK4Ha/AjqLCegsL4kfIGeVJCKkpBoY10xNce+PeCL1sfZt3GKDDDPmBnamB1Vn 0o51TxCqSunMV/jMverwQa81t7IkV1yorAufYKv6+bu/tfDlqU/22Vyy3ikoca7xUGJJifOEv xtjTC0OdsxT4Vi/6nmXd6PrGTVt4+B72x0uqSv/YufP+iiWObPYNuHtZtcsodY5mZ/the5oqm cosRRnJBpqMRcVJwIAM01BTdwCAAA= X-Env-Sender: al1img@gmail.com X-Msg-Ref: server-5.tower-31.messagelabs.com!1509548700!109729278!1 X-Originating-IP: [209.85.215.65] X-SpamReason: No, hits=0.0 required=7.0 tests= X-StarScan-Received: X-StarScan-Version: 9.4.45; banners=-,-,- X-VirusChecked: Checked Received: (qmail 43826 invoked from network); 1 Nov 2017 15:05:00 -0000 Received: from mail-lf0-f65.google.com (HELO mail-lf0-f65.google.com) (209.85.215.65) by server-5.tower-31.messagelabs.com with AES128-GCM-SHA256 encrypted SMTP; 1 Nov 2017 15:05:00 -0000 Received: by mail-lf0-f65.google.com with SMTP id r129so2870281lff.8 for ; Wed, 01 Nov 2017 08:05:00 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=G4kzyqz9GCPLKbzLsRrNXQm2PfWo3z3kBI7PaQYGITk=; b=t23SXFE32dXqoJ6ft94LpUsth+pUQD7k1tQraXQT1Zz9fUdN0lXCl1qwx7HzYSIECa JcAi0bt8DKK6fbKcmUfALjB9QJU16tJ1TWvdJu5CRxodiJAuGK0sgkTcRbETX2DkacSP llPQTVcS7bjNUUi1s1kSp/bJDgS3+au6cnk/rvBYdCbHA/MMb613dP2uSWycaXUGpz61 JqyBoDjbSc4/7aAQuoqFsF+ZRw9MqqwDo0i3TsCczeOQO3Zg8i+VwcWcs4+52Z2M7jAu xUDXoi/G7dXe4J1lOT3y/bx3waeKXuy5IOlcIIxNDpPbRSDOJdBV73UfM4fH093veMNH 2zAg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=G4kzyqz9GCPLKbzLsRrNXQm2PfWo3z3kBI7PaQYGITk=; b=JPltg2SYbasRhD9bxexEzR1DUCGDaqYGlkEgnABDTWBFVDqRvrPTORdm+Vj/SZWg4F TmZq6z2PT6Wb5+dVCSjfolqCXeg09ue24GVZSeysTzp1VXpWDgaAmH/adDkoaiScPIvT GC0WY14BllDlL1c5WDI+HJOr19tyzyMoIXIvZ+c1wc6vWoHMO9ggq2Jl1NuIKTeXuQNu fl1lt//zI6DsuLlo3pxy2stH9LavDbT+mxEx09+2Fac45lBK9PA+wBz7AL69xrD4mohH EEiSwzRtD1iOvovKRKDT6D3TMq4R7qaiHqWJg6CHM3FlhV2JsxwR/LRxCeWGbPWgAGBY t+uQ== X-Gm-Message-State: AJaThX49fZxxYEfqBpntmvDnX94704YcmACyfFsCW6UM666uRcqiZE73 nQqsuFr1lzONyGcp8aZb66kb7Q== X-Google-Smtp-Source: ABhQp+QLFFtzipL9DloZh/exFKGjHRTzmFf9hy5zgOKw3FLp/10Zdc3mz36gVU8vPx2j+F5tN6muEA== X-Received: by 10.25.225.144 with SMTP id l16mr48741lfk.53.1509548699610; Wed, 01 Nov 2017 08:04:59 -0700 (PDT) Received: from al1-pc.kyiv.epam.com (ll-59.209.223.85.sovam.net.ua. [85.223.209.59]) by smtp.gmail.com with ESMTPSA id 77sm173505ljj.12.2017.11.01.08.04.58 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 01 Nov 2017 08:04:59 -0700 (PDT) From: Oleksandr Grytsov To: xen-devel@lists.xenproject.org Date: Wed, 1 Nov 2017 17:04:47 +0200 Message-Id: <1509548687-6071-6-git-send-email-al1img@gmail.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1509548687-6071-1-git-send-email-al1img@gmail.com> References: <1509548687-6071-1-git-send-email-al1img@gmail.com> Cc: ian.jackson@eu.citrix.com, wei.liu2@citrix.com, Oleksandr Grytsov Subject: [Xen-devel] [PATCH v1 5/5] docs: add PV sound device config X-BeenThere: xen-devel@lists.xen.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: xen-devel-bounces@lists.xen.org Sender: "Xen-devel" X-Virus-Scanned: ClamAV using ClamSMTP From: Oleksandr Grytsov Update documentation with virtual sound device Signed-off-by: Oleksandr Grytsov --- docs/man/xl.cfg.pod.5.in | 150 +++++++++++++++++++++++++++++++++++++++++++++++ docs/man/xl.pod.1.in | 30 ++++++++++ 2 files changed, 180 insertions(+) diff --git a/docs/man/xl.cfg.pod.5.in b/docs/man/xl.cfg.pod.5.in index 247ae99..da78be6 100644 --- a/docs/man/xl.cfg.pod.5.in +++ b/docs/man/xl.cfg.pod.5.in @@ -1165,6 +1165,156 @@ connectors=id0:1920x1080;id1:800x600;id2:640x480 =back +=item B + +Specifies the virtual sound cards to be provided to the guest. +Each B is a list, which has a form of +"[VSND_ITEM_SPEC, VSND_ITEM_SPEC, ... ]" (without the quotes). +The virtual sound card has hierarchical structure. +Every card has a set of PCM devices and streams, each could be individually +configured. + +B describes individual item parameters. +B is a string of comma separated item parameters +headed by item identifier. Each item parameter is C pair: + +=over 4 + +"identifier, param = value, ...". + +=back + +Identifier shall be one of following values: "CARD", "PCM", "STREAM". +The child item treated as belonging to the previously defined parent +item. + +All parameters are optional. + +There are group of parameters which are common for all items. +This group can be defined at higher level of the hierarchy and be fully or +partially re-used by the underlying layers. These parameters are: + +=over 4 + +* number of channels (min/max) + +* supported sample rates + +* supported sample formats + +=back + +E.g. one can define these values for the whole card, device or stream. +Every underlying layer in turn can re-define some or all of them to better +fit its needs. For example, card may define number of channels to be +in [1; 8] range, and some particular stream may be limited to [1; 2] only. +The rule is that the underlying layer must be a subset of the upper layer +range. + +I + +=over 4 + +=over 4 + +=item B + +List of integer values separated by semicolon: sample-rates=8000;22050;44100 + +=item B + +List of string values separated by semicolon: sample-formats=s16_le;s8;u32_be + +Supported formats: s8, u8, s16_le, s16_be, u16_le, u16_be, s24_le, s24_be, +u24_le, u24_be, s32_le, s32_be, u32_le, u32_be, float_le, float_be, +float64_le, float64_be, iec958_subframe_le, iec958_subframe_be, +mu_law, a_law, ima_adpcm, mpeg, gsm + +=item B + +The minimum amount of channels. + +=item B + +The maximum amount of channels. + +=item B + +The maximum size in octets of the buffer to allocate per stream. + +=back + +=back + +I + +=over 4 + +=over 4 + +=item B + +Specify the backend domain name or id, defaults to dom0. + +=item B + +Short name of the virtual sound card. + +=item B + +Long name of the virtual sound card. + +=back + +=back + +I + +=over 4 + +=over 4 + +=item B + +Name of the PCM sound device within the virtual sound card. + +=back + +=back + +I + +=over 4 + +=over 4 + +=item B + +Unique stream identifier. + +=item B + +Stream type: "p" - playback stream, "c" - capture stream. + +=back + +=back + +I + + vsnd = [ + ['CARD, short-name=Main, sample-formats=s16_le;s8;u32_be', + 'PCM, name=Main', + 'STREAM, id=0, type=p', + 'STREAM, id=1, type=c, channels-max=2' + ], + ['CARD, short-name=Second', + 'PCM, name=Second, buffer-size=1024', + 'STREAM, id=2, type=p', + 'STREAM, id=3, type=c' + ] + ] + =back =head2 Paravirtualised (PV) Guest Specific Options diff --git a/docs/man/xl.pod.1.in b/docs/man/xl.pod.1.in index cd8bb1c..0a88fd5 100644 --- a/docs/man/xl.pod.1.in +++ b/docs/man/xl.pod.1.in @@ -1476,6 +1476,36 @@ List virtual displays for a domain. =back +=head2 VSND DEVICES + +=over 4 + +=item B I I I ... + +Creates a new vsnd device in the domain specified by I. +I's describe the vsnd device to attach, using the same format as the +B string in the domain config file. See L for +more information. + +B + +=over 4 + +xl vsnd-attach DomU 'CARD, short-name=Main, sample-formats=s16_le;s8;u32_be' +'PCM, name=Main' 'STREAM, id=0, type=p' 'STREAM, id=1, type=c, channels-max=2' + +=back + +=item B I I + +Removes the vsnd device specified by I from the domain specified by I. + +=item B I + +List vsnd devices for a domain. + +=back + =head1 PCI PASS-THROUGH =over 4