umad_send(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | AUTHOR | COLOPHON

UMAD_SEND(3)             OpenIB Programmer´s Manual             UMAD_SEND(3)

NAME top

       umad_send - send umad

SYNOPSIS top

       #include <infiniband/umad.h>

       int umad_send(int portid, int agentid, void *umad, int length, int timeout_ms, int retries);

DESCRIPTION top

       umad_send() sends length bytes from the specified umad buffer from
       the port specified by portid, and using the agent specified by
       agentid.

       The buffer can contain a RMPP transmission which is larger than a
       single MAD packet when the agentid specifies a class which utilizes
       RMPP and the header flags indicate RMPP is active.  NOTE currently
       only RMPPFlags.Active is meaningful in the header in user space.  All
       other RMPP fields are ignored.  The data section of the buffer will
       be sent in multiple RMPP MAD packets with headers built for the user.

       timeout_ms controls the solicited MADs behavior as follows: zero
       value means not solicited. Positive value makes kernel indicate
       timeout in milliseconds. If reply is not received within the
       specified value, the original buffer is returned in the read channel
       with the status field set (to non zero). Negative timeout_ms makes
       kernel wait forever for the reply.  retries indicates the number of
       times the MAD will be retried before giving up.

RETURN VALUE top

       umad_send() returns 0 on success; on error, errno is set and a
       negative value is returned as follows:
        -EINVAL invalid port handle or agentid
        -EIO    send operation failed

AUTHOR top

       Hal Rosenstock <halr@voltaire.com>

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 linux-rdma@vger.kernel.org.  This
       page was obtained from the project's upstream Git repository
       ⟨https://github.com/linux-rdma/rdma-core.git⟩ on 2020-08-13.  (At
       that time, the date of the most recent commit that was found in the
       repository was 2020-08-05.)  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 man-pages@man7.org

OpenIB                          May 11, 2007                    UMAD_SEND(3)