Linux Documentation
 help / color / mirror / Atom feed
From: Arnaud POULIQUEN <arnaud.pouliquen@foss.st.com>
To: Tanmay Shah <tanmay.shah@amd.com>, <andersson@kernel.org>,
	<mathieu.poirier@linaro.org>, <corbet@lwn.net>,
	<skhan@linuxfoundation.org>
Cc: <linux-remoteproc@vger.kernel.org>, <linux-doc@vger.kernel.org>,
	<linux-kernel@vger.kernel.org>
Subject: Re: [PATCH v8 4/5] docs: rpmsg: add virtio config space details
Date: Tue, 1 Sep 2026 14:56:21 +0200	[thread overview]
Message-ID: <720d36e8-df57-41fc-9764-ce66addc066e@foss.st.com> (raw)
In-Reply-To: <20260828145853.2843486-5-tanmay.shah@amd.com>



On 8/28/26 16:58, Tanmay Shah wrote:
> The virtio config space can provide single rpmsg buffer size in each
> direction. Document details of the configurable buffer size via virtio
> config space.
> 
> Signed-off-by: Tanmay Shah <tanmay.shah@amd.com>
> ---
> 
> Changes in v8:
>    - "%s/or differnt RX and TX sizes)/or different RX and TX queue sizes)/"
> 
> Changes in v6:
>    - rpmsg.rst: modify alignment related documentation
> 
> Changes in v5:
>    - fix documentation of buffer alignment
> 
>   Documentation/staging/rpmsg.rst | 17 +++++++++++++++++
>   1 file changed, 17 insertions(+)
> 
> diff --git a/Documentation/staging/rpmsg.rst b/Documentation/staging/rpmsg.rst
> index 63612b7ee120..d711d1643bab 100644
> --- a/Documentation/staging/rpmsg.rst
> +++ b/Documentation/staging/rpmsg.rst
> @@ -299,3 +299,20 @@ by the bus, and can then start sending messages to the remote service.
>   
>   The plan is also to add static creation of rpmsg channels via the virtio
>   config space, but it's not implemented yet.
> +
> +Configurable buffer sizes
> +=========================
> +
> +By default each rpmsg buffer is 512 bytes, and the same size is used for both
> +the receive and transmit directions. Remote processors that need a different
> +size (for example a larger MTU, or different RX and TX queue sizes) can
> +advertise it through the virtio device config space by setting the
> +VIRTIO_RPMSG_F_BUFSZ feature bit.
> +
> +When this feature is negotiated, the driver reads struct virtio_rpmsg_config
> +from the config space. This structure provides the size of a single buffer for
> +each direction (TX and RX). The device should advertise TX/RX buffer sizes
> +that already satisfy its own alignment constraints.

Nitpicking: following sentence seems to me more explicit as the alignment
concerns the buffer address. It is only a suggestion

The device should advertise TX/RX buffer sizes that already satisfy the
alignment constraints of its buffers.

Thanks,
Arnaud

> +
> +If the feature is not negotiated, the default 512-byte buffers are used for
> +both directions.


  reply	other threads:[~2026-09-01 12:56 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-28 14:58 [PATCH v8 0/5] Enhance RPMsg buffer management Tanmay Shah
2026-08-28 14:58 ` [PATCH v8 1/5] rpmsg: virtio_rpmsg_bus: rename rbufs and sbufs Tanmay Shah
2026-08-28 14:58 ` [PATCH v8 2/5] rpmsg: virtio_rpmsg_bus: allow different size of tx and rx bufs Tanmay Shah
2026-08-28 14:58 ` [PATCH v8 3/5] rpmsg: virtio_rpmsg_bus: get buffer size from config space Tanmay Shah
2026-08-28 14:58 ` [PATCH v8 4/5] docs: rpmsg: add virtio config space details Tanmay Shah
2026-09-01 12:56   ` Arnaud POULIQUEN [this message]
2026-08-28 14:58 ` [PATCH v8 5/5] samples: rpmsg: add MTU size info Tanmay Shah
2026-09-01 13:03 ` [PATCH v8 0/5] Enhance RPMsg buffer management Arnaud POULIQUEN
2026-09-03 15:28   ` Shah, Tanmay

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=720d36e8-df57-41fc-9764-ce66addc066e@foss.st.com \
    --to=arnaud.pouliquen@foss.st.com \
    --cc=andersson@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-remoteproc@vger.kernel.org \
    --cc=mathieu.poirier@linaro.org \
    --cc=skhan@linuxfoundation.org \
    --cc=tanmay.shah@amd.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox