From: Leon Romanovsky <leonro@xxxxxxxxxxxx> Add manual pages for libibverbs part of ECE. Signed-off-by: Leon Romanovsky <leonro@xxxxxxxxxxxx> --- libibverbs/man/CMakeLists.txt | 2 + libibverbs/man/ibv_query_ece.3.md | 56 ++++++++++++++++++++++++++++ libibverbs/man/ibv_set_ece.3.md | 61 +++++++++++++++++++++++++++++++ 3 files changed, 119 insertions(+) create mode 100644 libibverbs/man/ibv_query_ece.3.md create mode 100644 libibverbs/man/ibv_set_ece.3.md diff --git a/libibverbs/man/CMakeLists.txt b/libibverbs/man/CMakeLists.txt index e1d5edf8..c0ff7a25 100644 --- a/libibverbs/man/CMakeLists.txt +++ b/libibverbs/man/CMakeLists.txt @@ -51,6 +51,7 @@ rdma_man_pages( ibv_post_srq_recv.3 ibv_query_device.3 ibv_query_device_ex.3 + ibv_query_ece.3.md ibv_query_gid.3.md ibv_query_pkey.3.md ibv_query_port.3 @@ -65,6 +66,7 @@ rdma_man_pages( ibv_req_notify_cq.3.md ibv_rereg_mr.3.md ibv_resize_cq.3.md + ibv_set_ece.3.md ibv_srq_pingpong.1 ibv_uc_pingpong.1 ibv_ud_pingpong.1 diff --git a/libibverbs/man/ibv_query_ece.3.md b/libibverbs/man/ibv_query_ece.3.md new file mode 100644 index 00000000..b9eee699 --- /dev/null +++ b/libibverbs/man/ibv_query_ece.3.md @@ -0,0 +1,56 @@ +--- +date: 2020-01-22 +footer: libibverbs +header: "Libibverbs Programmer's Manual" +layout: page +license: 'Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md' +section: 3 +title: IBV_QUERY_ECE +--- + +# NAME + +ibv_query_ece - query ECE options. + +# SYNOPSIS + +```c +#include <infiniband/verbs.h> + +int ibv_query_ece(struct ibv_qp *qp, struct ibv_ece *ece); +``` + +# DESCRIPTION + +**ibv_query_ece()** query ECE options. + +Return to the user current ECE state for the QP. + +# ARGUMENTS +*qp* +: The queue pair (QP) associated with the ECE options. + +*ece* +: The ECE values. + +# RETURN VALUE + +**ibv_query_ece()** returns 0 when the call was successful, or the negative + value with errno which indicates the failure reason. + +*EOPNOTSUPP* +: libibverbs or provider driver doesn't support the ibv_set_ece() verb. + +*EINVAL* +: In one of the following: + o The QP is invalid. + o The ECE options are invalid. + +# SEE ALSO + +**ibv_set_ece**(3), + +# AUTHOR + +Leon Romanovsky <leonro@xxxxxxxxxxxx> + diff --git a/libibverbs/man/ibv_set_ece.3.md b/libibverbs/man/ibv_set_ece.3.md new file mode 100644 index 00000000..52d5f8f8 --- /dev/null +++ b/libibverbs/man/ibv_set_ece.3.md @@ -0,0 +1,61 @@ +--- +date: 2020-01-22 +footer: libibverbs +header: "Libibverbs Programmer's Manual" +layout: page +license: 'Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md' +section: 3 +title: IBV_COMMIT_ECE +--- + +# NAME + +ibv_set_ece - set ECE options and use them for QP configuration stage. + +# SYNOPSIS + +```c +#include <infiniband/verbs.h> + +int ibv_set_ece(struct ibv_qp *qp, struct ibv_ece *ece); +``` + +# DESCRIPTION + +**ibv_set_ece()** set ECE options and use them for QP configuration stage. + +The desired ECE options will be used during various modify QP stages +based on supported options in relevant QP state. + +# ARGUMENTS +*qp* +: The queue pair (QP) associated with the ECE options. + +*ece* +: The requested ECE values. This is IN/OUT field, the accepted options + will be returned in this field. + +# RETURN VALUE + +**ibv_set_ece()** returns 0 when the call was successful, or the negative + value with errno which indicates the failure reason. + +*EOPNOTSUPP* +: libibverbs or provider driver doesn't support the ibv_set_ece() verb. + +*ECONNREFUSED* +: Connection refused, provider doesn't want those options. + +*EINVAL* +: In one of the following: + o The QP is invalid. + o The ECE options are invalid. + +# SEE ALSO + +**ibv_query_ece**(3), + +# AUTHOR + +Leon Romanovsky <leonro@xxxxxxxxxxxx> + -- 2.24.1
