Fwd: [PATCH] Provide detailed specification of virtio-blk lifetime metrics

[Enrico Granata <egranata@google.com>]

Sending as a forward because my mailer has issues with virtio-dev@

---------- Forwarded message ---------
From: Enrico Granata <egranata@google.com>
Date: Tue, Apr 20, 2021 at 10:25 AM
Subject: [PATCH] Provide detailed specification of virtio-blk lifetime metrics
To: <virtio-dev@lists.oasis-open.org>
Cc: <egranata@google.com>, <hch@infradead.org>, <mst@redhat.com>,
<linux-block@vger.kernel.org>,
<virtualization@lists.linux-foundation.org>


In the course of review, some concerns were surfaced about the
original virtio-blk lifetime proposal, as it depends on the eMMC
spec which is not open

Add a more detailed description of the meaning of the fields
added by that proposal to the virtio-blk specification, as to
make it feasible to understand and implement the new lifetime
metrics feature without needing to refer to JEDEC's specification

This patch does not change the meaning of those fields nor add
any new fields, but it is intended to provide an open and more
clear description of the meaning associated with those fields.

Signed-off-by: Enrico Granata <egranata@google.com>
---
 content.tex | 34 +++++++++++++++++++++++++++-------
 1 file changed, 27 insertions(+), 7 deletions(-)

diff --git a/content.tex b/content.tex
index 9232d5c..7e14ccc 100644
--- a/content.tex
+++ b/content.tex
@@ -4669,13 +4669,32 @@ \subsection{Device Operation}\label{sec:Device
Types / Block Device / Device Ope
 \end{lstlisting}

 The device lifetime metrics \field{pre_eol_info}, \field{device_lifetime_est_a}
-and \field{device_lifetime_est_b} have the semantics described by the
JESD84-B50
-specification for the extended CSD register fields \field{PRE_EOL_INFO}
-\field{DEVICE_LIFETIME_EST_TYP_A} and \field{DEVICE_LIFETIME_EST_TYP_B}
-respectively.
+and \field{device_lifetime_est_b} are discussed in the JESD84-B50
specification.

-JESD84-B50 is available at the JEDEC website (https://www.jedec.org)
-pursuant to JEDEC's licensing terms and conditions.
+The complete JESD84-B50 is available at the JEDEC website
(https://www.jedec.org)
+pursuant to JEDEC's licensing terms and conditions. For the purposes of this
+specification, these fields are defined as follows.
+
+The \field{pre_eol_info} will have one of these values:
+
+\begin{lstlisting}
+// Value not available
+#define PRE_EOL_INFO_UNDEFINED    0
+// < 80% of blocks are consumed
+#define PRE_EOL_INFO_NORMAL       1
+// 80% of blocks are consumed
+#define PRE_EOL_INFO_WARNING      2
+// 90% of blocks are consumed
+#define PRE_EOL_INFO_URGENT       3
+// All others values are reserved
+\end{lstlisting}
+
+The \field{device_lifetime_est_typ_a} refers to wear of SLC cells and
is provided in
+increments of 10%, with 0 meaning undefined, 1 meaning up-to 10% of
lifetime used, and so on,
+thru to 11 meaning estimated lifetime exceeded. All values above 11
are reserved.
+
+The \field{device_lifetime_est_typ_b} refers to wear of MLC cells and
is provided with
+the same semantics as \field{device_lifetime_est_typ_a}.

 The final \field{status} byte is written by the device: either
 VIRTIO_BLK_S_OK for success, VIRTIO_BLK_S_IOERR for device or driver
@@ -4812,7 +4831,8 @@ \subsection{Device Operation}\label{sec:Device
Types / Block Device / Device Ope
 or UFS persistent storage), the device SHOULD offer the VIRTIO_BLK_F_LIFETIME
 flag. The flag MUST NOT be offered if the device is backed by storage for which
 the lifetime metrics described in this document cannot be obtained or for which
-such metrics have no useful meaning.
+such metrics have no useful meaning. If the metrics are offered, the
device MUST NOT
+send any reserved values, as defined in this specification.

 \subsubsection{Legacy Interface: Device Operation}\label{sec:Device
Types / Block Device / Device Operation / Legacy Interface: Device
Operation}
 When using the legacy interface, transitional devices and drivers
--
2.31.1.368.gbe11c130af-goog