]> www.infradead.org Git - qemu-nvme.git/commitdiff
docs: update hw/nvme documentation for protection information
authorAnkit Kumar <ankit.kumar@samsung.com>
Mon, 7 Aug 2023 21:27:45 +0000 (02:57 +0530)
committerKlaus Jensen <k.jensen@samsung.com>
Tue, 8 Aug 2023 13:28:05 +0000 (15:28 +0200)
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>
docs/system/devices/nvme.rst

index 2a3af268f7a520ff622cef0a4818a34a4e60b48f..4ea957baed1053ea065192e1869939f25b2dd0d9 100644 (file)
@@ -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)
 -------------------------------------------------------------