Commit 85eb3ed8 authored by Tomasz Bielecki's avatar Tomasz Bielecki Committed by Tomasz Zawadzki
Browse files

nvme: Don't mention polling requirement on blocking functions. 



The current documentation is misleading. All those functions are
blocking and handle admin queue polling internally.

Signed-off-by: default avatarTomasz Bielecki <tomasz.bielecki@wdc.com>
Change-Id: I1062ef255e4cf10b1532771efe90837eaf1171d6
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9222


Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
parent 5293d380

include/spdk/nvme.h

+0 −15
Original line number Diff line number Diff line
@@ -2109,9 +2109,6 @@ int spdk_nvme_ctrlr_cmd_security_send(struct spdk_nvme_ctrlr *ctrlr, uint8_t sec 
 *

 * This function is thread safe and can be called at any point after spdk_nvme_probe().

 *

 * Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of

 * commands submitted through this function.

 *

 * \param ctrlr NVMe controller to use for security receive command submission.

 * \param secp Security Protocol that is used.

 * \param spsp Security Protocol Specific field.
@@ -2131,9 +2128,6 @@ int spdk_nvme_ctrlr_security_receive(struct spdk_nvme_ctrlr *ctrlr, uint8_t secp 
 *

 * This function is thread safe and can be called at any point after spdk_nvme_probe().

 *

 * Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of

 * commands submitted through this function.

 *

 * \param ctrlr NVMe controller to use for security send command submission.

 * \param secp Security Protocol that is used.

 * \param spsp Security Protocol Specific field.
@@ -2218,9 +2212,6 @@ uint64_t spdk_nvme_ctrlr_get_flags(struct spdk_nvme_ctrlr *ctrlr); 
 *

 * This function is thread safe and can be called at any point after spdk_nvme_probe().

 *

 * Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of

 * commands submitted through this function.

 *

 * \param ctrlr NVMe controller to use for command submission.

 * \param nsid Namespace identifier for namespace to attach.

 * \param payload The pointer to the controller list.
@@ -2236,9 +2227,6 @@ int spdk_nvme_ctrlr_attach_ns(struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid, 
 *

 * This function is thread safe and can be called at any point after spdk_nvme_probe().

 *

 * Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of

 * commands submitted through this function.

 *

 * \param ctrlr NVMe controller to use for command submission.

 * \param nsid Namespace ID to detach.

 * \param payload The pointer to the controller list.
@@ -2267,9 +2255,6 @@ uint32_t spdk_nvme_ctrlr_create_ns(struct spdk_nvme_ctrlr *ctrlr, 
 *

 * This function is thread safe and can be called at any point after spdk_nvme_probe().

 *

 * Call spdk_nvme_ctrlr_process_admin_completions() to poll for completion of

 * commands submitted through this function.

 *

 * \param ctrlr NVMe controller to delete namespace from.

 * \param nsid The namespace identifier.

 *