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

rdma: Fix doxygen comments

Browse Source 
Change-Id: I6a9e9d173aad96c1d6c162396c1e3023b756498b
Signed-off-by: Alexey Marchuk <alexeymar@mellanox.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6288
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: <dongx.yi@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
This commit is contained in:
Alexey Marchuk 2020-12-08 15:33:19 +03:00 committed by Tomasz Zawadzki
parent 0e0805b551
commit 4f2a837238
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
include/spdk_internal/rdma.h
View File

@ -80,7 +80,8 @@ struct spdk_rdma_memory_translation {
/** /**
* Create RDMA provider specific qpair * Create RDMA provider specific qpair
* \param cm_id Pointer to RDMACM cm_id *
* \param cm_id Pointer to RDMA_CM cm_id
* \param qp_attr Pointer to qpair init attributes * \param qp_attr Pointer to qpair init attributes
* \return Pointer to a newly created qpair on success or NULL on failure * \return Pointer to a newly created qpair on success or NULL on failure
*/ */
@ -89,7 +90,8 @@ struct spdk_rdma_qp *spdk_rdma_qp_create(struct rdma_cm_id *cm_id,
/** /**
* Accept a connection request. Called by the passive side (NVMEoF target) * Accept a connection request. Called by the passive side (NVMEoF target)
* \param spdk_rdma_qp Pointer to a qpair *
* \param spdk_rdma_qp Pointer to SPDK RDMA qpair
* \param conn_param Optional information needed to establish the connection * \param conn_param Optional information needed to establish the connection
* \return 0 on success, errno on failure * \return 0 on success, errno on failure
*/ */
@ -98,21 +100,24 @@ int spdk_rdma_qp_accept(struct spdk_rdma_qp *spdk_rdma_qp, struct rdma_conn_para
/** /**
* Complete the connection process, must be called by the active * Complete the connection process, must be called by the active
* side (NVMEoF initiator) upon receipt RDMA_CM_EVENT_CONNECT_RESPONSE * side (NVMEoF initiator) upon receipt RDMA_CM_EVENT_CONNECT_RESPONSE
* \param spdk_rdma_qp Pointer to a qpair *
* \param spdk_rdma_qp Pointer to SPDK RDMA qpair
* \return 0 on success, errno on failure * \return 0 on success, errno on failure
*/ */
int spdk_rdma_qp_complete_connect(struct spdk_rdma_qp *spdk_rdma_qp); int spdk_rdma_qp_complete_connect(struct spdk_rdma_qp *spdk_rdma_qp);
/** /**
* Destroy RDMA provider specific qpair * Destroy RDMA provider specific qpair
* \param spdk_rdma_qp Pointer to qpair to be destroyed *
* \param spdk_rdma_qp Pointer to SPDK RDMA qpair to be destroyed
*/ */
void spdk_rdma_qp_destroy(struct spdk_rdma_qp *spdk_rdma_qp); void spdk_rdma_qp_destroy(struct spdk_rdma_qp *spdk_rdma_qp);
/** /**
* Disconnect a connection and transition assoiciated qpair to error state. * Disconnect a connection and transition associated qpair to error state.
* Generates RDMA_CM_EVENT_DISCONNECTED on both connection sides * Generates RDMA_CM_EVENT_DISCONNECTED on both connection sides
* \param spdk_rdma_qp Pointer to qpair to be destroyed *
* \param spdk_rdma_qp Pointer to qpair to be disconnected
*/ */
int spdk_rdma_qp_disconnect(struct spdk_rdma_qp *spdk_rdma_qp); int spdk_rdma_qp_disconnect(struct spdk_rdma_qp *spdk_rdma_qp);
@ -127,7 +132,8 @@ int spdk_rdma_qp_disconnect(struct spdk_rdma_qp *spdk_rdma_qp);
bool spdk_rdma_qp_queue_send_wrs(struct spdk_rdma_qp *spdk_rdma_qp, struct ibv_send_wr *first); bool spdk_rdma_qp_queue_send_wrs(struct spdk_rdma_qp *spdk_rdma_qp, struct ibv_send_wr *first);
/** /**
* Submit all queued Work Request * Submit all queued send Work Request
*
* \param spdk_rdma_qp Pointer to SPDK RDMA qpair * \param spdk_rdma_qp Pointer to SPDK RDMA qpair
* \param bad_wr Stores a pointer to the first failed WR if this function return nonzero value * \param bad_wr Stores a pointer to the first failed WR if this function return nonzero value
* \return 0 on succes, errno on failure * \return 0 on succes, errno on failure