Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add manual pages for librdmacm part of ECE. Signed-off-by: Leon Romanovsky <leonro@mellanox.com>
- Loading branch information
Leon Romanovsky
committed
Jun 15, 2020
1 parent
1fc4cb4
commit 97f8668
Showing
4 changed files
with
138 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
--- | ||
date: 2020-02-02 | ||
footer: librdmacm | ||
header: "Librdmacm Programmer's Manual" | ||
layout: page | ||
license: 'Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md' | ||
section: 3 | ||
title: RDMA_GET_REMOTE_ECE | ||
--- | ||
|
||
# NAME | ||
|
||
rdma_get_remote_ece - Get remote ECE paraemters as received from the peer. | ||
|
||
# SYNOPSIS | ||
|
||
```c | ||
#include <rdma/rdma_cma.h> | ||
|
||
int rdma_get_remote_ece(struct rdma_cm_id *id, struct ibv_ece *ece); | ||
``` | ||
# DESCRIPTION | ||
**rdma_get_remote_ece()** get ECE parameters as were received from the communication peer. | ||
This function is suppose to be used by the users of external QPs. The call needs | ||
to be performed before replying to the peer and needed to allow for the passive | ||
side to know ECE options of other side. | ||
Being used by external QP and RDMA_CM doesn't manage that QP, the peer needs | ||
to call to libibverbs API by itself. | ||
Usual flow for the passive side will be: | ||
* ibv_create_qp() <- create data QP. | ||
* ece = rdma_get_remote_ece() <- get ECE options from remote peer | ||
* ibv_set_ece(ece) <- set local ECE options with data received from the peer. | ||
* ibv_modify_qp() <- enable data QP. | ||
* rdma_set_local_ece(ece) <- set desired ECE options after respective | ||
libibverbs provider masked unsupported options. | ||
* rdma_accept()/rdma_establish()/rdma_reject_ece() | ||
# ARGUMENTS | ||
*id | ||
: RDMA communication identifier. | ||
*ece | ||
: ECE struct to be filled. | ||
# RETURN VALUE | ||
**rdma_get_remote_ece()** returns 0 on success, or -1 on error. If an error occurs, errno will be set to indicate the failure reason. | ||
# SEE ALSO | ||
**rdma_cm**(7), rdma_set_local_ece(3) | ||
# AUTHOR | ||
Leon Romanovsky <leonro@mellanox.com> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
--- | ||
date: 2020-02-02 | ||
footer: librdmacm | ||
header: "Librdmacm Programmer's Manual" | ||
layout: page | ||
license: 'Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md' | ||
section: 3 | ||
title: RDMA_SET_LOCAL_ECE | ||
--- | ||
|
||
# NAME | ||
|
||
rdma_set_local_ece - Set local ECE paraemters to be used for REQ/REP communication. | ||
|
||
# SYNOPSIS | ||
|
||
```c | ||
#include <rdma/rdma_cma.h> | ||
|
||
int rdma_set_local_ece(struct rdma_cm_id *id, struct ibv_ece *ece); | ||
``` | ||
# DESCRIPTION | ||
**rdma_set_local_ece()** set local ECE parameters. | ||
This function is suppose to be used by the users of external QPs. The call needs | ||
to be performed before replying to the peer and needed to configure RDMA_CM with | ||
desired ECE options. | ||
Being used by external QP and RDMA_CM doesn't manage that QP, the peer needs | ||
to call to libibverbs API by itself. | ||
Usual flow for the passive side will be: | ||
* ibv_create_qp() <- create data QP. | ||
* ece = ibv_get_ece() <- get ECE from libibvers provider. | ||
* rdma_set_local_ece(ece) <- set desired ECE options. | ||
* rdma_connect() <- send connection request | ||
* ece = rdma_get_remote_ece() <- get ECE options from remote peer | ||
* ibv_set_ece(ece) <- set local ECE options with data received from the peer. | ||
* ibv_modify_qp() <- enable data QP. | ||
* rdma_accept()/rdma_establish()/rdma_reject_ece() | ||
# ARGUMENTS | ||
*id* | ||
: RDMA communication identifier. | ||
*ece | ||
: ECE parameters. | ||
# RETURN VALUE | ||
**rdma_set_local_ece()** returns 0 on success, or -1 on error. If an error occurs, errno will be set to indicate the failure reason. | ||
# SEE ALSO | ||
**rdma_cm**(7), rdma_get_remote_ece(3) | ||
# AUTHOR | ||
Leon Romanovsky <leonro@mellanox.com> |