From 2099ba84b990f318fe9b5917b836d087f4fc5db0 Mon Sep 17 00:00:00 2001 From: Amir Nir Date: Tue, 18 Jun 2024 14:33:54 +0300 Subject: [PATCH] Added umad_opem_smi_port manpage, based on umad_open_port Signed-off-by: Amir Nir --- libibumad/man/umad_open_smi_port.3 | 37 ++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 libibumad/man/umad_open_smi_port.3 diff --git a/libibumad/man/umad_open_smi_port.3 b/libibumad/man/umad_open_smi_port.3 new file mode 100644 index 000000000..973581c44 --- /dev/null +++ b/libibumad/man/umad_open_smi_port.3 @@ -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 +.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