From e562585129cc90ef76b8eeac8001a28deba681f6 Mon Sep 17 00:00:00 2001 From: Tomasz Bielecki Date: Wed, 18 Aug 2021 10:17:10 -0700 Subject: [PATCH] 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: Tomasz Bielecki Change-Id: I1062ef255e4cf10b1532771efe90837eaf1171d6 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9222 Community-CI: Broadcom CI Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: Tomasz Zawadzki --- include/spdk/nvme.h | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/include/spdk/nvme.h b/include/spdk/nvme.h index 2ff8dfc84..07fcd0745 100644 --- a/include/spdk/nvme.h +++ b/include/spdk/nvme.h @@ -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. *