contrib/ofed/libibverbs/man/ibv_rate_to_mult.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH IBV_RATE_TO_MULT 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
   4 .SH "NAME"
   5 .nf
   6 ibv_rate_to_mult \- convert IB rate enumeration to multiplier of 2.5 Gbit/sec
   7 .sp
   8 mult_to_ibv_rate \- convert multiplier of 2.5 Gbit/sec to an IB rate enumeration
   9 .SH "SYNOPSIS"
  10 .nf
  11 .B #include <infiniband/verbs.h>
  12 .sp
  13 .BI "int ibv_rate_to_mult(enum ibv_rate " "rate" ");
  14 .sp
  15 .BI "enum ibv_rate mult_to_ibv_rate(int " "mult" ");
  16 .fi
  17 .SH "DESCRIPTION"
  18 .B ibv_rate_to_mult()
  19 converts the IB transmission rate enumeration
  20 .I rate
  21 to a multiple of 2.5 Gbit/sec (the base rate). For example, if
  22 .I rate
  23 is
  24 .BR IBV_RATE_5_GBPS\fR,
  25 the value 2 will be returned (5 Gbit/sec = 2 * 2.5 Gbit/sec).
  26 .PP
  27 .B mult_to_ibv_rate()
  28 converts the multiplier value (of 2.5 Gbit/sec)
  29 .I mult
  30 to an IB transmission rate enumeration. For example, if
  31 .I mult
  32 is 2, the rate enumeration
  33 .BR IBV_RATE_5_GBPS
  34 will be returned.
  35 .SH "RETURN VALUE"
  36 .B
  37 ibv_rate_to_mult()
  38 returns the multiplier of the base rate 2.5 Gbit/sec.
  39 .PP
  40 .B mult_to_ibv_rate()
  41 returns the enumeration representing the IB transmission rate.
  42 .SH "SEE ALSO"
  43 .BR ibv_query_port (3)
  44 .SH "AUTHORS"
  45 .TP
  46 Dotan Barak <dotanb@mellanox.co.il>