contrib/ofed/management/libibumad/man/umad_open_port.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH UMAD_OPEN_PORT 3  "May 21, 2007" "OpenIB" "OpenIB Programmer\'s Manual"
   4 .SH "NAME"
   5 umad_open_port \- open InfiniBand device port for umad access
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/umad.h>
   9 .sp
  10 .BI "int umad_open_port(char " "*ca_name" ", int " "portnum" );
  11 .fi
  12 .SH "DESCRIPTION"
  13 .B umad_open_port()
  14 opens the port
  15 .I portnum
  16 of the IB device
  17 .I ca_name
  18 for umad access. The port is selected by the library if not all parameters
  19 are provided (see
  20 .B umad_get_port()
  21 for details).
  22 .fi
  23 .SH "RETURN VALUE"
  24 .B umad_open_port()
  25 returns 0 or an unique positive value of umad device descriptor on success, and a negative value on error as follows:
  26  -ENODEV IB device can\'t be resolved
  27  -EINVAL port is not valid (bad
  28 .I portnum\fR
  29 or no umad device)
  30  -EIO    umad device for this port can\'t be opened
  31 .SH "SEE ALSO"
  32 .BR umad_close_port (3),
  33 .BR umad_get_cas_names (3),
  34 .BR umad_get_port (3)
  35 .SH "AUTHOR"
  36 .TP
  37 Hal Rosenstock <halr@voltaire.com>