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

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