Commit 19feb4e1 authored by Chunyang Hui's avatar Chunyang Hui Committed by Changpeng Liu
Browse files

nvme: add security receive and security send wrapper 



Change-Id: Id25040d62f89d4e8f2268bb3383c5665c0508f5a
Signed-off-by: default avatarChunyang Hui <chunyang.hui@intel.com>
Reviewed-on: https://review.gerrithub.io/c/438776


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
parent 1ac217df

CHANGELOG.md

+3 −0
Original line number Diff line number Diff line
@@ -12,6 +12,9 @@ multiple separate buffers. 


### nvme



Wrapper functions spdk_nvme_ctrlr_security_send() and spdk_nvme_ctrlr_security_receive() are

introduced to support further security protocol development.



admin_timeout_ms was added to NVMe controller initialization options, users

can change the default value when probing a controller.

include/spdk/nvme.h

+8 −12
Original line number Diff line number Diff line
@@ -1206,16 +1206,14 @@ int spdk_nvme_ctrlr_cmd_set_feature_ns(struct spdk_nvme_ctrlr *ctrlr, uint8_t fe 
 * \param nssf NVMe Security Specific field. Indicate RPMB target when using Security

 * Protocol EAh.

 * \param payload The pointer to the payload buffer.

 * \param payload_size The size of payload buffer.

 * \param cb_fn Callback function to invoke when the security receive has completed.

 * \param cb_arg Argument to pass to the callback function.

 * \param size The size of payload buffer.

 *

 * \return 0 if successfully submitted, negated errno if resources could not be allocated

 * for this request.

 */

int spdk_nvme_ctrlr_cmd_security_receive(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp, uint16_t spsp,

		uint8_t nssf, void *payload, uint32_t payload_size,

		spdk_nvme_cmd_cb cb_fn, void *cb_arg);

int

spdk_nvme_ctrlr_security_receive(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp,

				 uint16_t spsp, uint8_t nssf, void *payload, size_t size);



/**

 * Send security protocol data to controller.
@@ -1231,16 +1229,14 @@ int spdk_nvme_ctrlr_cmd_security_receive(struct spdk_nvme_ctrlr *ctrlr, uint8_t 
 * \param nssf NVMe Security Specific field. Indicate RPMB target when using Security

 * Protocol EAh.

 * \param payload The pointer to the payload buffer.

 * \param payload_size The size of payload buffer.

 * \param cb_fn Callback function to invoke when the security send has completed.

 * \param cb_arg Argument to pass to the callback function.

 * \param size The size of payload buffer.

 *

 * \return 0 if successfully submitted, negated errno if resources could not be allocated

 * for this request.

 */

int spdk_nvme_ctrlr_cmd_security_send(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp, uint16_t spsp,

				      uint8_t nssf, void *payload, uint32_t payload_size,

				      spdk_nvme_cmd_cb cb_fn, void *cb_arg);

int

spdk_nvme_ctrlr_security_send(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp,

			      uint16_t spsp, uint8_t nssf, void *payload, size_t size);



/**

 * Attach the specified namespace to controllers.

lib/nvme/nvme_ctrlr.c

+40 −0
Original line number Diff line number Diff line
@@ -2742,3 +2742,43 @@ spdk_nvme_ctrlr_is_discovery(struct spdk_nvme_ctrlr *ctrlr) 
	return !strncmp(ctrlr->trid.subnqn, SPDK_NVMF_DISCOVERY_NQN,

			strlen(SPDK_NVMF_DISCOVERY_NQN));

}



int

spdk_nvme_ctrlr_security_receive(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp,

				 uint16_t spsp, uint8_t nssf, void *payload, size_t size)

{

	struct nvme_completion_poll_status	status;

	int					res;



	res = nvme_ctrlr_cmd_security_receive(ctrlr, secp, spsp, nssf, payload, size,

					      nvme_completion_poll_cb, &status);

	if (res) {

		return res;

	}

	if (spdk_nvme_wait_for_completion_robust_lock(ctrlr->adminq, &status, &ctrlr->ctrlr_lock)) {

		SPDK_ERRLOG("spdk_nvme_ctrlr_security_receive failed!\n");

		return -ENXIO;

	}



	return 0;

}



int

spdk_nvme_ctrlr_security_send(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp,

			      uint16_t spsp, uint8_t nssf, void *payload, size_t size)

{

	struct nvme_completion_poll_status	status;

	int					res;



	res = nvme_ctrlr_cmd_security_send(ctrlr, secp, spsp, nssf, payload, size, nvme_completion_poll_cb,

					   &status);

	if (res) {

		return res;

	}

	if (spdk_nvme_wait_for_completion_robust_lock(ctrlr->adminq, &status, &ctrlr->ctrlr_lock)) {

		SPDK_ERRLOG("spdk_nvme_ctrlr_security_send failed!\n");

		return -ENXIO;

	}



	return 0;

}

lib/nvme/nvme_ctrlr_cmd.c

+6 −6
Original line number Diff line number Diff line
@@ -638,7 +638,7 @@ nvme_ctrlr_cmd_fw_image_download(struct spdk_nvme_ctrlr *ctrlr, 
}



int

spdk_nvme_ctrlr_cmd_security_receive(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp,

nvme_ctrlr_cmd_security_receive(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp,

				uint16_t spsp, uint8_t nssf, void *payload,

				uint32_t payload_size, spdk_nvme_cmd_cb cb_fn, void *cb_arg)

{
@@ -666,7 +666,7 @@ spdk_nvme_ctrlr_cmd_security_receive(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp 
}



int

spdk_nvme_ctrlr_cmd_security_send(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp,

nvme_ctrlr_cmd_security_send(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp,

			     uint16_t spsp, uint8_t nssf, void *payload,

			     uint32_t payload_size, spdk_nvme_cmd_cb cb_fn, void *cb_arg)

{

lib/nvme/nvme_internal.h

+6 −0
Original line number Diff line number Diff line
@@ -777,6 +777,12 @@ int nvme_ctrlr_cmd_fw_commit(struct spdk_nvme_ctrlr *ctrlr, 
int	nvme_ctrlr_cmd_fw_image_download(struct spdk_nvme_ctrlr *ctrlr,

		uint32_t size, uint32_t offset, void *payload,

		spdk_nvme_cmd_cb cb_fn, void *cb_arg);

int	nvme_ctrlr_cmd_security_receive(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp, uint16_t spsp,

					uint8_t nssf, void *payload, uint32_t payload_size,

					spdk_nvme_cmd_cb cb_fn, void *cb_arg);

int	nvme_ctrlr_cmd_security_send(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp,

				     uint16_t spsp, uint8_t nssf, void *payload,

				     uint32_t payload_size, spdk_nvme_cmd_cb cb_fn, void *cb_arg);

void	nvme_completion_poll_cb(void *arg, const struct spdk_nvme_cpl *cpl);

int	spdk_nvme_wait_for_completion(struct spdk_nvme_qpair *qpair,

				      struct nvme_completion_poll_status *status);