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

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH UMAD_SET_GRH 3  "May 24, 2007" "OpenIB" "OpenIB Programmer\'s Manual"
   4 .SH "NAME"
   5 umad_set_grh \- set GRH fields within umad buffer using host ordering
   6 .SH "SYNOPSIS"
   7 .nf
   8 .B #include <infiniband/umad.h>
   9 .sp
  10 .BI "int umad_set_grh(void " "*umad" ", void " "*mad_addr");
  11 .fi
  12 .SH "DESCRIPTION"
  13 .B umad_set_grh()
  14 sets the GRH fields (grh_present, gid, hop_limit, traffic_class, flow_label)
  15 within the specified
  16 .I umad\fR
  17 buffer based on the
  18 .I mad_addr\fR
  19 supplied. The provided
  20 .I mad_addr\fR
  21 fields are expected to be in host order.
  22 If the
  23 .I mad_addr\fR
  24 pointer supplied is NULL, no GRH is set.
  25 The argument
  26 .I mad_addr
  27 is a pointer to an
  28 .I ib_mad_addr_t
  29 struct, as specified in
  30 .I <infiniband/umad.h>.
  31 The argument
  32 .I umad
  33 is a pointer to an
  34 .I ib_user_mad_t
  35 struct, as specified in
  36 .I <infiniband/umad.h>.
  37 .PP
  38 .nf
  39 typedef struct ib_mad_addr {
  40 .in +8
  41 uint32_t qpn;
  42 uint32_t qkey;
  43 uint16_t lid;
  44 uint8_t  sl;
  45 uint8_t  path_bits;
  46 uint8_t  grh_present;
  47 uint8_t  gid_index;
  48 uint8_t  hop_limit;
  49 uint8_t  traffic_class;
  50 uint8_t  gid[16];
  51 uint32_t flow_label;
  52 .in -8
  53 } ib_mad_addr_t;
  54 .PP
  55 typedef struct ib_user_mad {
  56 .in +8
  57 uint32_t agent_id;
  58 uint32_t status;
  59 uint32_t timeout_ms;
  60 uint32_t retries;
  61 uint32_t length;
  62 ib_mad_addr_t addr;
  63 uint8_t  data[0];
  64 .in -8
  65 } ib_user_mad_t;
  66 .fi
  67 .SH "RETURN VALUE"
  68 .B umad_set_grh()
  69 returns 0 on success, and a negative value on errors. Currently, there
  70 are no errors indicated.
  71 .SH "SEE ALSO"
  72 .BR umad_set_grh_net (3)
  73 .SH "AUTHOR"
  74 .TP
  75 Hal Rosenstock <halr@voltaire.com>