Use argument structure for nvme_security_send() and nvme_security_receive()

Use an argument structure instead of passing all arguments one by one.
This allows for a future expansion of the argument list without having
to change the library ABI.

Signed-off-by: Hannes Reinecke <[email protected]>

Author: hreinecke

src/nvme/ioctl.c

@@ -1242,50 +1242,50 @@ int nvme_fw_commit(struct nvme_fw_commit_args *args)
 	return nvme_submit_admin_passthru(args->fd, &cmd, args->result);
 }
 
-int nvme_security_send(int fd, __u32 nsid, __u8 nssf, __u8 spsp0, __u8 spsp1,
-		       __u8 secp, __u32 tl, __u32 data_len, void *data,
-		       __u32 timeout, __u32 *result)
+int nvme_security_send(struct nvme_security_send_args *args)
 {
-	__u32 cdw10 = NVME_SET(secp, SECURITY_SECP) |
-			NVME_SET(spsp0, SECURITY_SPSP0)  |
-			NVME_SET(spsp1, SECURITY_SPSP1) |
-			NVME_SET(nssf, SECURITY_NSSF);
-	__u32 cdw11 = tl;
+	__u32 cdw10 = NVME_SET(args->secp, SECURITY_SECP) |
+			NVME_SET(args->spsp0, SECURITY_SPSP0)  |
+			NVME_SET(args->spsp1, SECURITY_SPSP1) |
+			NVME_SET(args->nssf, SECURITY_NSSF);
+	__u32 cdw11 = args->tl;
 
 	struct nvme_passthru_cmd cmd = {
 		.opcode		= nvme_admin_security_send,
-		.nsid		= nsid,
+		.nsid		= args->nsid,
 		.cdw10		= cdw10,
 		.cdw11		= cdw11,
-		.data_len	= data_len,
-		.addr		= (__u64)(uintptr_t)data,
-		.timeout_ms	= timeout,
+		.data_len	= args->data_len,
+		.addr		= (__u64)(uintptr_t)args->data,
+		.timeout_ms	= args->timeout,
 	};
 
-	return nvme_submit_admin_passthru(fd, &cmd, result);
+	if (args->args_size < sizeof(*args))
+		return -EINVAL;
+	return nvme_submit_admin_passthru(args->fd, &cmd, args->result);
 }
 
-int nvme_security_receive(int fd, __u32 nsid, __u8 nssf, __u8 spsp0,
-			  __u8 spsp1, __u8 secp, __u32 al, __u32 data_len,
-			  void *data, __u32 timeout, __u32 *result)
+int nvme_security_receive(struct nvme_security_receive_args *args)
 {
-	__u32 cdw10 = NVME_SET(secp, SECURITY_SECP) |
-			NVME_SET(spsp0, SECURITY_SPSP0)  |
-			NVME_SET(spsp1, SECURITY_SPSP1) |
-			NVME_SET(nssf, SECURITY_NSSF);
-	__u32 cdw11 = al;
+	__u32 cdw10 = NVME_SET(args->secp, SECURITY_SECP) |
+			NVME_SET(args->spsp0, SECURITY_SPSP0)  |
+			NVME_SET(args->spsp1, SECURITY_SPSP1) |
+			NVME_SET(args->nssf, SECURITY_NSSF);
+	__u32 cdw11 = args->al;
 
 	struct nvme_passthru_cmd cmd = {
 		.opcode		= nvme_admin_security_recv,
-		.nsid		= nsid,
+		.nsid		= args->nsid,
 		.cdw10		= cdw10,
 		.cdw11		= cdw11,
-		.data_len	= data_len,
-		.addr		= (__u64)(uintptr_t)data,
-		.timeout_ms	= timeout,
+		.data_len	= args->data_len,
+		.addr		= (__u64)(uintptr_t)args->data,
+		.timeout_ms	= args->timeout,
 	};
 
-	return nvme_submit_admin_passthru(fd, &cmd, result);
+	if (args->args_size < sizeof(*args))
+		return -EINVAL;
+	return nvme_submit_admin_passthru(args->fd, &cmd, args->result);
 }
 
 int nvme_get_lba_status(int fd, __u32 nsid, __u64 slba, __u32 mndw, __u16 rl,

src/nvme/ioctl.h

@@ -2933,7 +2933,7 @@ struct nvme_fw_commit_args {
 int nvme_fw_commit(struct nvme_fw_commit_args *args);
 
 /**
- * nvme_security_send() -
+ * nvme_security_send_args - Arguments for the NVMe Security Send command
  * @fd:		File descriptor of nvme device
  * @nsid:	Namespace ID to issue security command on
  * @nssf:	NVMe Security Specific field
@@ -2945,6 +2945,25 @@ int nvme_fw_commit(struct nvme_fw_commit_args *args);
  * @data:	Security data payload to send
  * @timeout:	Timeout in ms
  * @result:	The command completion result from CQE dword0
+ */
+struct nvme_security_send_args {
+	int args_size;
+	int fd;
+	__u32 nsid;
+	__u8 nssf;
+	__u8 spsp0;
+	__u8 spsp1;
+	__u8 secp;
+	__u32 tl;
+	__u32 data_len;
+	void *data;
+	__u32 timeout;
+	__u32 *result;
+};
+
+/**
+ * nvme_security_send() -
+ * @args:	&struct nvme_security_send argument structure
  *
  * The Security Send command transfers security protocol data to the
  * controller. The data structure transferred to the controller as part of this
@@ -2958,12 +2977,10 @@ int nvme_fw_commit(struct nvme_fw_commit_args *args);
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
-int nvme_security_send(int fd, __u32 nsid, __u8 nssf, __u8 spsp0, __u8 spsp1,
-		       __u8 secp, __u32 tl, __u32 data_len, void *data,
-		       __u32 timeout, __u32 *result);
+int nvme_security_send(struct nvme_security_send_args *args);
 
 /**
- * nvme_security_receive() -
+ * nvme_security_receive_args - Arguments for the NVMe Security Receive command
  * @fd:		File descriptor of nvme device
  * @nsid:	Namespace ID to issue security command on
  * @nssf:	NVMe Security Specific field
@@ -2975,13 +2992,30 @@ int nvme_security_send(int fd, __u32 nsid, __u8 nssf, __u8 spsp0, __u8 spsp1,
  * @data:	Security data payload to send
  * @timeout:	Timeout in ms
  * @result:	The command completion result from CQE dword0
+ */
+struct nvme_security_receive_args {
+	int args_size;
+	int fd;
+	__u32 nsid;
+	__u8 nssf;
+	__u8 spsp0;
+	__u8 spsp1;
+	__u8 secp;
+	__u32 al;
+	__u32 data_len;
+	void *data;
+	__u32 timeout;
+	__u32 *result;
+};
+
+/**
+ * nvme_security_receive() -
+ * @args:	&struct nvme_security_recevice argument structure
  *
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
-int nvme_security_receive(int fd, __u32 nsid, __u8 nssf, __u8 spsp0,
-			  __u8 spsp1, __u8 secp, __u32 al, __u32 data_len,
-			  void *data, __u32 timeout, __u32 *result);
+int nvme_security_receive(struct nvme_security_receive_args *args);
 
 /**
  * nvme_get_lba_status() - Retrieve information on possibly unrecoverable LBAs