summary refs log tree commit diff stats
path: root/docs/system
diff options
context:
space:
mode:
authorRoque Arcudia Hernandez <roqueh@google.com>2024-02-22 17:50:16 +0000
committerKlaus Jensen <k.jensen@samsung.com>2024-03-12 15:48:56 +0100
commitbdc31646c59a7fa0e1bfdf899f65d1b6a2f9f357 (patch)
treeab45a914d3b252d20f631b8658325c3a79324002 /docs/system
parent00d7dffe877db258ac9a18c11fe9fb5d68127163 (diff)
downloadfocaccia-qemu-bdc31646c59a7fa0e1bfdf899f65d1b6a2f9f357.tar.gz
focaccia-qemu-bdc31646c59a7fa0e1bfdf899f65d1b6a2f9f357.zip
hw/nvme: Add NVMe NGUID property
This patch adds a way to specify an NGUID for a given NVMe Namespace using a
string of hexadecimal digits with an optional '-' separator to group bytes. For
instance:

-device nvme-ns,nguid="e9accd3b83904e13167cf0593437f57d"

If provided, the NGUID will be part of the Namespace Identification Descriptor
list and the Identify Namespace data.

Signed-off-by: Roque Arcudia Hernandez <roqueh@google.com>
Signed-off-by: Nabih Estefan <nabihestefan@google.com>
Reviewed-by: Klaus Jensen <k.jensen@samsung.com>
Signed-off-by: Klaus Jensen <k.jensen@samsung.com>
Diffstat (limited to 'docs/system')
-rw-r--r--docs/system/devices/nvme.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/system/devices/nvme.rst b/docs/system/devices/nvme.rst
index 4ea957baed..d2b1ca9645 100644
--- a/docs/system/devices/nvme.rst
+++ b/docs/system/devices/nvme.rst
@@ -81,6 +81,13 @@ There are a number of parameters available:
   Set the UUID of the namespace. This will be reported as a "Namespace UUID"
   descriptor in the Namespace Identification Descriptor List.
 
+``nguid``
+  Set the NGUID of the namespace. This will be reported as a "Namespace Globally
+  Unique Identifier" descriptor in the Namespace Identification Descriptor List.
+  It is specified as a string of hexadecimal digits containing exactly 16 bytes
+  or "auto" for a random value. An optional '-' separator could be used to group
+  bytes. If not specified the NGUID will remain all zeros.
+
 ``eui64``
   Set the EUI-64 of the namespace. This will be reported as a "IEEE Extended
   Unique Identifier" descriptor in the Namespace Identification Descriptor List.