[virtio-comment] [PATCH] virtio-rpmb: fix the description for multi-block reads

["Alex Bennée" <alex.bennee@linaro.org>]

Previously the text said we fail if block count is set to 1 despite
language elsewhere in the text referring to:

  "For RPMB read request, one virtio buffer including request command
  and the subsequent [block_count] virtio buffers for response data
  are placed in the queue."

and the existence of both max_wr_cnt and max_rd_cnt configuration
variables certainly implying devices should be able to handle
multi-block reads just like writes.

Fix the description as well as format the steps as an enumerated list
to match the style of the previous section describing write handling.

Reported-by: Ruchika Gupta <ruchika.gupta@linaro.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
 virtio-rpmb.tex | 24 +++++++++++++-----------
 1 file changed, 13 insertions(+), 11 deletions(-)

diff --git a/virtio-rpmb.tex b/virtio-rpmb.tex
index dfecc3c..1dae3fd 100644
--- a/virtio-rpmb.tex
+++ b/virtio-rpmb.tex
@@ -239,22 +239,24 @@ \subsubsection{Device Operation: Request Queue}\label{sec:Device Types / RPMB De
 
 \devicenormative{\paragraph}{Device Operation: Data Read}{Device Types / RPMB Device / Device Operation / Device Operation: Data Read}
 
-If the authentication key is not yet programmed then VIRTIO_RPMB_RES_NO_AUTH_KEY
-SHOULD be returned in \field{result}.
+\begin{enumerate}
+\item If the authentication key is not yet programmed then
+  VIRTIO_RPMB_RES_NO_AUTH_KEY SHOULD be returned in \field{result}.
 
-If block count has not been set to 1 then VIRTIO_RPMB_RES_GENERAL_FAILURE SHOULD be
-responded as \field{result}.
+\item If block count is zero or greater than \field{max_rd_cnt} then
+  VIRTIO_RPMB_RES_GENERAL_FAILURE SHOULD be responded as \field{result}.
 
-If there is an error in the address (out of range) then the \field{result} SHOULD
-be set to VIRTIO_RPMB_RES_ADDR_FAILURE.
+\item If there is an error in the address (out of range) then the
+  \field{result} SHOULD be set to VIRTIO_RPMB_RES_ADDR_FAILURE.
 
-If data fetch from addressed location inside the device fails then the \field{result}
-SHOULD be VIRTIO_RPMB_RES_READ_FAILURE.
+\item If data fetch from addressed location inside the device fails
+  then the \field{result} SHOULD be VIRTIO_RPMB_RES_READ_FAILURE.
 
-If some other error occurs during the read procedure then the \field{result}
-SHOULD be VIRTIO_RPMB_RES_GENERAL_FAILURE.
+\item If some other error occurs during the read procedure then the
+  \field{result} SHOULD be VIRTIO_RPMB_RES_GENERAL_FAILURE.
 
-The \field{req_resp} value VIRTIO_RPMB_RESP_DATA_READ SHOULD be responded.
+\item The device SHOULD respond with \field{block_count} frames containing the data and \field{req_resp} value set to VIRTIO_RPMB_RESP_DATA_READ.
+\end{enumerate}
 
 \devicenormative{\paragraph}{Device Operation: Result Read}{Device Types / RPMB Device / Device Operation / Device Operation: Result Read}
 
-- 
2.20.1


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/