From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from ws5-mx01.kavi.com (ws5-mx01.kavi.com [34.193.7.191]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 91BBBC5478C for ; Tue, 27 Feb 2024 10:47:16 +0000 (UTC) Received: from lists.oasis-open.org (oasis.ws5.connectedcommunity.org [10.110.1.242]) by ws5-mx01.kavi.com (Postfix) with ESMTP id C9F1C2AC49 for ; Tue, 27 Feb 2024 10:47:15 +0000 (UTC) Received: from lists.oasis-open.org (oasis-open.org [10.110.1.242]) by lists.oasis-open.org (Postfix) with ESMTP id B0F3A986512 for ; Tue, 27 Feb 2024 10:47:15 +0000 (UTC) Received: from host09.ws5.connectedcommunity.org (host09.ws5.connectedcommunity.org [10.110.1.97]) by lists.oasis-open.org (Postfix) with QMQP id 9B3CD983D68; Tue, 27 Feb 2024 10:47:15 +0000 (UTC) Mailing-List: contact virtio-comment-help@lists.oasis-open.org; run by ezmlm List-ID: Sender: Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: Received: from lists.oasis-open.org (oasis-open.org [10.110.1.242]) by lists.oasis-open.org (Postfix) with ESMTP id 8C0369863DE for ; Tue, 27 Feb 2024 10:47:15 +0000 (UTC) X-Virus-Scanned: amavisd-new at kavi.com X-MC-Unique: k-rifAVROvS4P9vQ-35RBQ-1 From: Cornelia Huck To: Matias Ezequiel Vara Larsen , virtio-comment@lists.oasis-open.org Cc: anton.yakovlev@opensynergy.com In-Reply-To: Organization: "Red Hat GmbH, Sitz: Werner-von-Siemens-Ring 12, D-85630 Grasbrunn, Handelsregister: Amtsgericht =?utf-8?Q?M=C3=BCnchen=2C?= HRB 153243, =?utf-8?Q?Gesch=C3=A4ftsf=C3=BChrer=3A?= Ryan Barnhart, Charles Cachera, Michael O'Neill, Amy Ross" References: User-Agent: Notmuch/0.37 (https://notmuchmail.org) Date: Tue, 27 Feb 2024 11:47:09 +0100 Message-ID: <87y1b6b2vm.fsf@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.4 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain Subject: Re: [virtio-comment] Re: [PATCH] virtio-sound: use 'data buffer' instead of 'buffer' On Tue, Feb 27 2024, Matias Ezequiel Vara Larsen wrote: > On Thu, Nov 30, 2023 at 11:58:37AM +0100, Matias Ezequiel Vara Larsen wrote: >> This commit replaces the wording 'buffer' with 'data buffer' when >> referring to the payload of PCM messages. The virtio specification >> defines the word buffer as a set of zero or more device-readable >> physically-contiguous elements followed by zero or more >> physically-contiguous device-writable elements. In the virtio-sound >> section, the word is used only for the data or payload in a request. In >> this case, the data buffer is sent together with a header, i.e., >> device-readable, and the status, i.e., device-writable. To not get >> confused with the main definition, this commit replaces those usages >> with the wording 'data buffer'. >> >> Reviewed-by: Anton Yakovlev >> Signed-off-by: Matias Ezequiel Vara Larsen >> --- >> device-types/sound/description.tex | 26 +++++++++++++------------- >> 1 file changed, 13 insertions(+), 13 deletions(-) >> >> diff --git a/device-types/sound/description.tex b/device-types/sound/description.tex >> index 54c9c8e..97151fa 100644 >> --- a/device-types/sound/description.tex >> +++ b/device-types/sound/description.tex >> @@ -667,8 +667,8 @@ \subsubsection{PCM Notifications} >> >> \subsubsection{PCM I/O Messages}\label{sec:Device Types / Sound Device / Device Operation / PCM IO Messages} >> >> -An I/O message consists of the header part, followed by the buffer, and then >> -the status part. >> +An I/O message consists of a buffer that contains a header part, followed by >> +the data buffer, and then the status part. >> >> \begin{lstlisting} >> /* an I/O header */ >> @@ -697,20 +697,20 @@ \subsubsection{PCM I/O Messages}\label{sec:Device Types / Sound Device / Device >> \item[\field{latency_bytes}] indicates the current device latency. >> \end{description} >> >> -Since all buffers in the queue (with one exception) should be of the size >> +Since all data buffers in the queue (with one exception) should be of the size >> \field{period_bytes}, the completion of such an I/O request can be considered an >> elapsed period notification. >> >> \paragraph{Output Stream} >> >> -In case of an output stream, the header is followed by a device-readable buffer >> -containing PCM frames for writing to the device. All messages are placed into >> -the tx queue. >> +In case of an output stream, the header is followed by a device-readable data >> +buffer containing PCM frames for writing to the device. All messages are placed >> +into the tx queue. >> >> \devicenormative{\subparagraph}{Output Stream}{Device Types / Sound Device / Device Operation / PCM Output Stream} >> >> \begin{itemize} >> -\item The device MUST NOT complete the I/O request until the buffer is totally >> +\item The device MUST NOT complete the I/O request until the data buffer is totally >> consumed. >> \end{itemize} >> >> @@ -718,13 +718,13 @@ \subsubsection{PCM I/O Messages}\label{sec:Device Types / Sound Device / Device >> >> \begin{itemize} >> \item The driver SHOULD populate the tx queue with \field{period_bytes} sized >> -buffers. The only exception is the end of the stream. >> -\item The driver MUST NOT place device-writable buffers into the tx queue. >> +data buffers. The only exception is the end of the stream. >> +\item The driver MUST NOT place device-writable data buffers into the tx queue. >> \end{itemize} >> >> \paragraph{Input Stream} >> >> -In case of an input stream, the header is followed by a device-writable buffer >> +In case of an input stream, the header is followed by a device-writable data buffer >> being populated with PCM frames from the device. All messages are placed into >> the rx queue. >> >> @@ -735,7 +735,7 @@ \subsubsection{PCM I/O Messages}\label{sec:Device Types / Sound Device / Device >> \devicenormative{\subparagraph}{Input Stream}{Device Types / Sound Device / Device Operation / PCM Input Stream} >> >> \begin{itemize} >> -\item The device MUST NOT complete the I/O request until the buffer is full. >> +\item The device MUST NOT complete the I/O request until the data buffer is full. >> The only exception is the end of the stream. >> \end{itemize} >> >> @@ -743,8 +743,8 @@ \subsubsection{PCM I/O Messages}\label{sec:Device Types / Sound Device / Device >> >> \begin{itemize} >> \item The driver SHOULD populate the rx queue with \field{period_bytes} sized >> -empty buffers before starting the stream. >> -\item The driver MUST NOT place device-readable buffers into the rx queue. >> +empty data buffers before starting the stream. >> +\item The driver MUST NOT place device-readable data buffers into the rx queue. >> \end{itemize} >> >> \subsubsection{Channel Map Control Messages}\label{sec:Device Types / Sound Device / Device Operation / Channel Map Control Messages} >> -- >> 2.41.0 >> > > Dear TC, > > I'd like to request a vote on solving issue 190. > > Fixes: https://github.com/oasis-tcs/virtio-spec/issues/190 Hi Matias, unfortunately, this will have to wait until after the OASIS infrastructure migration has finished (and we have dealt with any fallout.) This publicly archived list offers a means to provide input to the OASIS Virtual I/O Device (VIRTIO) TC. In order to verify user consent to the Feedback License terms and to minimize spam in the list archive, subscription is required before posting. Subscribe: virtio-comment-subscribe@lists.oasis-open.org Unsubscribe: virtio-comment-unsubscribe@lists.oasis-open.org List help: virtio-comment-help@lists.oasis-open.org List archive: https://lists.oasis-open.org/archives/virtio-comment/ Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists Committee: https://www.oasis-open.org/committees/virtio/ Join OASIS: https://www.oasis-open.org/join/