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

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH UMAD_REGISTER 3  "May 11, 2007" "OpenIB" "OpenIB Programmer\'s Manual"
   4 .SH "NAME"
   5 umad_register \- register the specified management class and version for port
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/umad.h>
   9 .sp
  10 .BI "int umad_register(int " "portid" ", int " "mgmt_class" ", int " "mgmt_version" " , uint8_t " "rmpp_version" ", uint32_t " "method_mask[4]");
  11 .fi
  12 .SH "DESCRIPTION"
  13 .B umad_register()
  14 registers the specified management class, management version,
  15 and whether RMPP is being used for the port specified by the
  16 .I portid\fR
  17 parameter. If
  18 .I method_mask\fR
  19 array is provided, the caller is registered as a replier (server) for the
  20 methods having their corresponding bit on in the
  21 .I method_mask\fR.
  22 If
  23 .I method_mask\fR
  24 is NULL, the caller is registered as a MAD client, meaning that it can
  25 only receive replies on MADs that it sent (solicited MADs).
  26 .SH "RETURN VALUE"
  27 .B umad_register()
  28 returns non-negative agent id number on success, and a negative value on error as follows:
  29  -EINVAL invalid port handle
  30  -EPERM  registration failed
  31 .SH "SEE ALSO"
  32 .BR umad_register_oui(3),
  33 .BR umad_unregister (3)
  34 .SH "AUTHOR"
  35 .TP
  36 Hal Rosenstock <halr@voltaire.com>