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

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH UMAD_GET_CA 3  "May 21, 2007" "OpenIB" "OpenIB Programmer\'s Manual"
   4 .SH "NAME"
   5 umad_get_ca, umad_release_ca \- get and release InfiniBand device port attributes
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/umad.h>
   9 .sp
  10 .BI "int umad_get_ca(char " "*ca_name" ", umad_ca_t " "*ca" );
  11 .nl
  12 .BI "int umad_release_ca(umad_ca_t " "*ca" );
  13 .fi
  14 .SH "DESCRIPTION"
  15 .B umad_get_ca()
  16 gets the attributes of the InfiniBand device
  17 .I ca_name\fR.
  18 It fills
  19 the
  20 .I ca
  21 structure with the device attributes specified by
  22 the
  23 .I ca_name
  24 or with the default device attributes if
  25 .I ca_name
  26 is NULL.
  27 .B umad_release_ca()
  28 should be called before the
  29 .I ca
  30 structure is deallocated.
  31 The argument
  32 .I ca
  33 is an
  34 .I umad_ca_t
  35 struct, as specified in <infiniband/umad.h>.
  36 .PP
  37 .nf
  38 typedef struct umad_ca {
  39 .in +8
  40 char ca_name[UMAD_CA_NAME_LEN];                 /* Name of the device */
  41 uint node_type;                                 /* Type of the device */
  42 int numports;                                   /* Number of physical ports */
  43 char fw_ver[20];                                /* FW version */
  44 char ca_type[40];                               /* CA type (e.g. MT23108, etc.) */
  45 char hw_ver[20];                                /* Hardware version */
  46 uint64_t node_guid;                             /* Node GUID */
  47 uint64_t system_guid;                           /* System image GUID */
  48 umad_port_t *ports[UMAD_CA_MAX_PORTS];          /* Array of device port properties */
  49 .in -8
  50 } umad_ca_t;
  51 .fi
  52 .PP
  53 .B umad_release_ca()
  54 releases the resources that were allocated in the function
  55 .B umad_get_ca()\fR.
  56 .SH "RETURN VALUE"
  57 .B umad_get_ca()
  58 and
  59 .B umad_release_ca()
  60 return 0 on success, and a negative value on error.
  61 .SH "AUTHORS"
  62 .TP
  63 Hal Rosenstock <halr@voltaire.com>
  64 .TP
  65 Dotan Barak <dotanb@mellanox.co.il>