From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-10.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4D2C0C3815B for ; Mon, 20 Apr 2020 14:07:03 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 2E34A214AF for ; Mon, 20 Apr 2020 14:07:03 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1587391623; bh=Ns5XKxz50mFwpH//h2pit2mauyzRYmJemzBtB6dYdvI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=W7Uribo4Z58iidgkYTauGJ0nOqp0zVJkZXMeQNInao8PXZWb7HxejQ5GMp5kNFp2D AoQjHlaq+bQ3C2+ssbAlvDsEgV05jSXS4icvrg+Q5jqYZ21xrGZXJ+3jPKsxek3pI8 8WjBOZVdPhDlDB61AHn7dda7fnO6e2x79195dA3o= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727009AbgDTOHC (ORCPT ); Mon, 20 Apr 2020 10:07:02 -0400 Received: from mail.kernel.org ([198.145.29.99]:60886 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728155AbgDTOHC (ORCPT ); Mon, 20 Apr 2020 10:07:02 -0400 Received: from localhost (unknown [213.57.247.131]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id BDE5220722; Mon, 20 Apr 2020 14:07:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1587391621; bh=Ns5XKxz50mFwpH//h2pit2mauyzRYmJemzBtB6dYdvI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=DbpXNqU8mGsJhCpkp1XVxH9lvBcYGXMwo9NriuAwok/q9+QZdN1rjhpXID/PC27dY U8T2iwTkZxasUiwyWN0tlMCg2jfbUwi/i/rEfrIHuCeWpvRqozwOdigoFnd3Vl06GG A9VsIJpxHeskso/g2uFpEV2Y568uaVNJ5KkvN3Kc= From: Leon Romanovsky To: Doug Ledford , Jason Gunthorpe Cc: Leon Romanovsky , linux-rdma@vger.kernel.org Subject: [PATCH rdma-core 03/12] libibverbs: Document ECE API Date: Mon, 20 Apr 2020 17:06:39 +0300 Message-Id: <20200420140648.275554-4-leon@kernel.org> X-Mailer: git-send-email 2.25.2 In-Reply-To: <20200420140648.275554-1-leon@kernel.org> References: <20200420140648.275554-1-leon@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-rdma-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org From: Leon Romanovsky Add manual pages for libibverbs part of ECE. Signed-off-by: Leon Romanovsky --- 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 + +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 + 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 + +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 + -- 2.25.2