blob: 06f682cc56ee4e03b3e8429b89b9b383a07b10b8 [file]
.\" -*- nroff -*-
.\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
.\"
.TH UMAD_REGISTER_OUI 3 "May 17, 2007" "OpenIB" "OpenIB Programmer's Manual"
.SH "NAME"
umad_register_oui \- register the specified class in vendor range 2 for port
.SH "SYNOPSIS"
.nf
.B #include <infiniband/umad.h>
.sp
.BI "int umad_register_oui(int " "portid" ", int " "mgmt_class" ", uint8_t " "rmpp_version" ", uint8_t " "oui[3]" ", uint32_t " "method_mask[4]");
.fi
.SH "DESCRIPTION"
.B umad_register_oui()
registers the specified class in vendor range 2, the specified
.I oui\fR,
and whether RMPP is being used for the port specified by the
.I portid\fR
handle. If
.I method_mask\fR
array is provided, the caller is registered as a replier (server) for the
methods having their corresponding bit on in the
.I method_mask\fR.
If
.I method_mask\fR
is NULL, the caller is registered as a MAD client, meaning that it can
only receive replies on MADs that it sent (solicited MADs).
.SH "RETURN VALUE"
.B umad_register()
returns non-negative agent id number on success, and a negative value on error as follows:
-EINVAL invalid port handle or class is not in the vendor class 2 range
-EPERM registration failed
.SH "SEE ALSO"
.BR umad_register (3),
.BR umad_unregister (3)
.SH "AUTHOR"
.TP
Hal Rosenstock <halr@voltaire.com>