freebsd-skq/contrib/ofed/librdmacm/man/rdma_get_devices.3
Hans Petter Selasky d6b92ffa99 OFED user-space import and update for use with Linux-4.9 compatible RDMA
kernel APIs.

List of sources used:

1) rdma-core was cloned from "https://github.com/linux-rdma/rdma-core.git"
Top commit d65138ef93af30b3ea249f3a84aa6a24ba7f8a75

2) OpenSM was cloned from git://git.openfabrics.org/~halr/opensm.git
Top commit 85f841cf209f791c89a075048a907020e924528d

3) libibmad was cloned from "git://git.openfabrics.org/~iraweiny/libibmad.git"
Tag 1.3.13 with some additional patches from Mellanox.

4) infiniband-diags was cloned from "git://git.openfabrics.org/~iraweiny/infiniband-diags.git"
Tag 1.6.7 with some additional patches from Mellanox.

Added the required Makefiles for building and installing.

Sponsored by:	Mellanox Technologies
2017-08-02 16:00:30 +00:00

25 lines
983 B
Groff

.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
.TH "RDMA_GET_DEVICES" 3 "2007-05-15" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
.SH NAME
rdma_get_devices \- Get a list of RDMA devices currently available.
.SH SYNOPSIS
.B "#include <rdma/rdma_cma.h>"
.P
.B "struct ibv_context **" rdma_get_devices
.BI "(int *" num_devices ");"
.SH ARGUMENTS
.IP "num_devices" 12
If non-NULL, set to the number of devices returned.
.SH "DESCRIPTION"
Return a NULL-terminated array of opened RDMA devices. Callers can use
this routine to allocate resources on specific RDMA devices that will be
shared across multiple rdma_cm_id's.
.SH "RETURN VALUE"
Returns an array of available RDMA devices, or NULL if the request
fails. On failure, errno will be set to indicate the failure reason.
.SH "NOTES"
The returned array must be released by calling rdma_free_devices. Devices
remain opened while the librdmacm is loaded.
.SH "SEE ALSO"
rdma_free_devices(3)