Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
ankit-sam authored and birkelund committed Aug 8, 2023
1 parent dbdb13f commit ec5a138
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/system/devices/nvme.rst
Expand Up @@ -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)
-------------------------------------------------------------
Expand Down

0 comments on commit ec5a138

Please sign in to comment.