Adding upstream version 18.2.2.upstream/18.2.2

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 87 insertions, 0 deletions

diff --git a/src/spdk/scripts/rpc/nvme.py b/src/spdk/scripts/rpc/nvme.py
new file mode 100644
index 000000000..e9a0ba6bb
--- /dev/null
+++ b/src/spdk/scripts/rpc/nvme.py
@@ -0,0 +1,87 @@
+from .helpers import deprecated_alias
+
+
+@deprecated_alias('send_nvme_cmd')
+def bdev_nvme_send_cmd(client, name, cmd_type, data_direction, cmdbuf,
+                       data=None, metadata=None,
+                       data_len=None, metadata_len=None,
+                       timeout_ms=None):
+    """Send one NVMe command
+
+    Args:
+        name: Name of the operating NVMe controller
+        cmd_type: Type of nvme cmd. Valid values are: admin, io
+        data_direction: Direction of data transfer. Valid values are: c2h, h2c
+        cmdbuf: NVMe command encoded by base64 urlsafe
+        data: Data transferring to controller from host, encoded by base64 urlsafe
+        metadata: metadata transferring to controller from host, encoded by base64 urlsafe
+        data_length: Data length required to transfer from controller to host
+        metadata_length: Metadata length required to transfer from controller to host
+        timeout-ms: Command execution timeout value, in milliseconds, if 0, don't track timeout
+
+    Returns:
+        NVMe completion queue entry, requested data and metadata, all are encoded by base64 urlsafe.
+    """
+    params = {'name': name,
+              'cmd_type': cmd_type,
+              'data_direction': data_direction,
+              'cmdbuf': cmdbuf}
+
+    if data:
+        params['data'] = data
+    if metadata:
+        params['metadata'] = metadata
+    if data_len:
+        params['data_len'] = data_len
+    if metadata_len:
+        params['metadata_len'] = metadata_len
+    if timeout_ms:
+        params['timeout_ms'] = timeout_ms
+
+    return client.call('bdev_nvme_send_cmd', params)
+
+
+@deprecated_alias('get_nvme_controllers')
+def bdev_nvme_get_controllers(client, name=None):
+    """Get information about NVMe controllers.
+
+    Args:
+        name: NVMe controller name to query (optional; if omitted, query all NVMe controllers)
+
+    Returns:
+        List of NVMe controller information objects.
+    """
+    params = {}
+    if name:
+        params['name'] = name
+    return client.call('bdev_nvme_get_controllers', params)
+
+
+def bdev_nvme_opal_init(client, nvme_ctrlr_name, password):
+    """Init nvme opal. Take ownership and activate
+
+    Args:
+        nvme_ctrlr_name: name of nvme ctrlr
+        password: password to init opal
+    """
+    params = {
+        'nvme_ctrlr_name': nvme_ctrlr_name,
+        'password': password,
+    }
+
+    return client.call('bdev_nvme_opal_init', params)
+
+
+def bdev_nvme_opal_revert(client, nvme_ctrlr_name, password):
+    """Revert opal to default factory settings. Erase all data.
+
+    Args:
+        nvme_ctrlr_name: name of nvme ctrlr
+        password: password
+    """
+    params = {
+        'nvme_ctrlr_name': nvme_ctrlr_name,
+        'password': password,
+    }
+
+    return client.call('bdev_nvme_opal_revert', params)