umad_get_ca(3) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| RETURN VALUE \| AUTHORS \| COLOPHON

UMAD_GET_CA(3)         OpenIB Programmer's Manual         UMAD_GET_CA(3)

NAME top

       umad_get_ca, umad_release_ca - get and release InfiniBand device
       port attributes

SYNOPSIS top

       #include <infiniband/umad.h>

       int umad_get_ca(char *ca_name, umad_ca_t *ca);

       int umad_release_ca(umad_ca_t *ca);

DESCRIPTION top

       umad_get_ca() gets the attributes of the InfiniBand device
       ca_name.  It fills the ca structure with the device attributes
       specified by the ca_name or with the default device attributes if
       ca_name is NULL.  umad_release_ca() should be called before the
       ca structure is deallocated.  The argument ca is an umad_ca_t
       struct, as specified in <infiniband/umad.h>.

       typedef struct umad_ca {
               char ca_name[UMAD_CA_NAME_LEN];                 /* Name of the device */
               uint node_type;                                 /* Type of the device */
               int numports;                                   /* Number of physical ports */
               char fw_ver[20];                                /* FW version */
               char ca_type[40];                               /* CA type (e.g. MT23108, etc.) */
               char hw_ver[20];                                /* Hardware version */
               uint64_t node_guid;                             /* Node GUID */
               uint64_t system_guid;                           /* System image GUID */
               umad_port_t *ports[UMAD_CA_MAX_PORTS];          /* Array of device port properties */
       } umad_ca_t;

       umad_release_ca() releases the resources that were allocated in
       the function umad_get_ca().

RETURN VALUE top

       umad_get_ca() and umad_release_ca() return 0 on success, and a
       negative value on error.

AUTHORS top

       Hal Rosenstock <[email protected]>

       Dotan Barak <[email protected]>

COLOPHON top

       This page is part of the rdma-core (RDMA Core Userspace Libraries
       and Daemons) project.  Information about the project can be found
       at ⟨https://github.com/linux-rdma/rdma-core⟩.  If you have a bug
       report for this manual page, send it to
       [email protected].  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/linux-rdma/rdma-core.git⟩ on 2024-06-14.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2024-06-10.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       [email protected]

OpenIB                        May 21, 2007                UMAD_GET_CA(3)