[virtio-comment] [PATCH] vsock: add documentation about len header field

[Laura Loghin <lauralg@amazon.com>]

Signed-off-by: Laura Loghin <lauralg@amazon.com>
---
 virtio-vsock.tex | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/virtio-vsock.tex b/virtio-vsock.tex
index d79984d..e32cad8 100644
--- a/virtio-vsock.tex
+++ b/virtio-vsock.tex
@@ -107,6 +107,11 @@ \subsection{Device Operation}\label{sec:Device Types / Socket Device / Device Op
 #define VIRTIO_VSOCK_OP_CREDIT_REQUEST 7
 \end{lstlisting}
 
+\field{len} is the size of the payload, in bytes. However, the driver may
+provide buffer(s) for the payload that have a total size longer than
+\field{len}. If that is the case, only the first \field{len} bytes MUST be
+used for the actual data.
+
 \subsubsection{Virtqueue Flow Control}\label{sec:Device Types / Socket Device / Device Operation / Virtqueue Flow Control}
 
 The tx virtqueue carries packets initiated by applications and replies to
-- 
2.17.1




Amazon Development Center (Romania) S.R.L. registered office: 27A Sf. Lazar Street, UBC5, floor 2, Iasi, Iasi County, 700045, Romania. Registered in Romania. Registration number J22/2621/2005.


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/