File: umad_open_port.3

package info (click to toggle)
rdma-core 56.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 17,196 kB
  • sloc: ansic: 171,361; python: 13,724; sh: 2,774; perl: 1,465; makefile: 73
file content (39 lines) | stat: -rw-r--r-- 1,099 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
.\" -*- nroff -*-
.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
.\"
.TH UMAD_OPEN_PORT 3  "May 21, 2007" "OpenIB" "OpenIB Programmer's Manual"
.SH "NAME"
umad_open_port \- open InfiniBand device port for umad access
.SH "SYNOPSIS"
.nf
.B #include <infiniband/umad.h>
.sp
.BI "int umad_open_port(char " "*ca_name" ", int " "portnum" );
.fi
.SH "DESCRIPTION"
.B umad_open_port()
opens the 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).
.fi
.SH "RETURN VALUE"
.B umad_open_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 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_close_port (3),
.BR umad_get_cas_names (3),
.BR umad_get_port (3)
.SH "AUTHOR"
.TP
Hal Rosenstock <halr@voltaire.com>