-
Notifications
You must be signed in to change notification settings - Fork 690
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added umad_opem_smi_port manpage, based on umad_open_port
Signed-off-by: Amir Nir <anir@nvidia.com>
- Loading branch information
1 parent
3af8b39
commit 2099ba8
Showing
1 changed file
with
37 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
.\" -*- nroff -*- | ||
.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md | ||
.\" | ||
.TH UMAD_OPEN_SMI_PORT 3 "June 18, 2024" "OpenIB" "OpenIB Programmer's Manual" | ||
.SH "NAME" | ||
umad_open_smi_port \- open InfiniBand device SMI port for umad access | ||
.SH "SYNOPSIS" | ||
.nf | ||
.B #include <infiniband/umad.h> | ||
.sp | ||
.BI "int umad_open_smi_port(char " "*ca_name" ", int " "portnum" ); | ||
.fi | ||
.SH "DESCRIPTION" | ||
.B umad_open_smi_port() | ||
opens the SMI port | ||
.I portnum | ||
of the IB device | ||
.I ca_name | ||
for umad access. The port is selected by the library if not all parameters | ||
are provided (see | ||
.B umad_get_port() | ||
for details). Only SMI ports will be selected. | ||
.fi | ||
.SH "RETURN VALUE" | ||
.B umad_open_smi_port() | ||
returns 0 or an unique positive value of umad device descriptor on success, and a negative value on error as follows: | ||
-EOPNOTSUPP ABI version doesn't match | ||
-ENODEV IB device with SMI port can't be resolved | ||
-EINVAL port is not valid (bad | ||
.I portnum\fR | ||
or no umad device) | ||
-EIO umad device for this port can't be opened | ||
.SH "SEE ALSO" | ||
.BR umad_open_port (3), | ||
.SH "AUTHOR" | ||
.TP | ||
Amir Nir <anir@nvidia.com> |