ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

nvme: cleanup Doxygen comments

Browse Source 
Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: Ib41e71d4288c03b67db37878a073ea143d369dd3
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7129
Reviewed-by: Michal Berger <michalx.berger@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
Community-CI: Broadcom CI
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
This commit is contained in:
Jim Harris 2021-03-29 15:48:28 +00:00 committed by Tomasz Zawadzki
parent 3f858eeb38
commit df3299113c
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/spdk/nvme.h
View File

@ -1168,21 +1168,21 @@ bool spdk_nvme_ctrlr_is_feature_supported(struct spdk_nvme_ctrlr *ctrlr, uint8_t
/** /**
* Signature for callback function invoked when a command is completed. * Signature for callback function invoked when a command is completed.
* *
* \param spdk_nvme_cpl Completion queue entry that coontains the completion status. * \param ctx Callback context provided when the command was submitted.
* \param cpl Completion queue entry that contains the completion status.
*/ */
typedef void (*spdk_nvme_cmd_cb)(void *, const struct spdk_nvme_cpl *); typedef void (*spdk_nvme_cmd_cb)(void *ctx, const struct spdk_nvme_cpl *cpl);
/** /**
* Signature for callback function invoked when an asynchronous error request * Signature for callback function invoked when an asynchronous error request
* command is completed. * command is completed.
* *
* \param ctrlr Opaque handle to NVMe controller.
* \param aer_cb_arg Context specified by spdk_nvme_register_aer_callback(). * \param aer_cb_arg Context specified by spdk_nvme_register_aer_callback().
* \param spdk_nvme_cpl Completion queue entry that contains the completion status * \param cpl Completion queue entry that contains the completion status
* of the asynchronous event request that was completed. * of the asynchronous event request that was completed.
*/ */
typedef void (*spdk_nvme_aer_cb)(void *aer_cb_arg, typedef void (*spdk_nvme_aer_cb)(void *aer_cb_arg,
const struct spdk_nvme_cpl *); const struct spdk_nvme_cpl *cpl);
/** /**
* Register callback function invoked when an AER command is completed for the * Register callback function invoked when an AER command is completed for the