summary refs log tree commit diff stats
path: root/docs/system
diff options
context:
space:
mode:
authorAnkit Kumar <ankit.kumar@samsung.com>2023-08-08 02:57:45 +0530
committerKlaus Jensen <k.jensen@samsung.com>2023-08-08 15:28:05 +0200
commitec5a138ce63ce460575a44cf9ec3172c33eb0fd6 (patch)
tree5d326e1f6e1cbf4af0f3bd53e4e171d139a173ff /docs/system
parentdbdb13f931d7cf2d3c3ca662e751bb1551e9eab6 (diff)
downloadfocaccia-qemu-ec5a138ce63ce460575a44cf9ec3172c33eb0fd6.tar.gz
focaccia-qemu-ec5a138ce63ce460575a44cf9ec3172c33eb0fd6.zip
docs: update hw/nvme documentation for protection information
Add missing entry for pif ("protection information format").
Protection information size can be 8 or 16 bytes, Update the pil entry
as per the NVM command set specification.

Signed-off-by: Ankit Kumar <ankit.kumar@samsung.com>
Signed-off-by: Klaus Jensen <k.jensen@samsung.com>
Diffstat (limited to 'docs/system')
-rw-r--r--docs/system/devices/nvme.rst12
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/system/devices/nvme.rst b/docs/system/devices/nvme.rst
index 2a3af268f7..4ea957baed 100644
--- a/docs/system/devices/nvme.rst
+++ b/docs/system/devices/nvme.rst
@@ -271,9 +271,15 @@ The virtual namespace device supports DIF- and DIX-based protection information
 
 ``pil=UINT8`` (default: ``0``)
   Controls the location of the protection information within the metadata. Set
-  to ``1`` to transfer protection information as the first eight bytes of
-  metadata. Otherwise, the protection information is transferred as the last
-  eight bytes.
+  to ``1`` to transfer protection information as the first bytes of metadata.
+  Otherwise, the protection information is transferred as the last bytes of
+  metadata.
+
+``pif=UINT8`` (default: ``0``)
+  By default, the namespace device uses 16 bit guard protection information
+  format (``pif=0``). Set to ``2`` to enable 64 bit guard protection
+  information format. This requires at least 16 bytes of metadata. Note that
+  ``pif=1`` (32 bit guards) is currently not supported.
 
 Virtualization Enhancements and SR-IOV (Experimental Support)
 -------------------------------------------------------------