xref: /freebsd/contrib/ofed/libibverbs/man/ibv_rate_to_mult.3 (revision 9f44a47fd07924afc035991af15d84e6585dea4f)
-*- nroff -*-
Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md

IBV_RATE_TO_MULT 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
"NAME"
ibv_rate_to_mult - convert IB rate enumeration to multiplier of 2.5 Gbit/sec
mult_to_ibv_rate - convert multiplier of 2.5 Gbit/sec to an IB rate enumeration
"SYNOPSIS"
 #include <infiniband/verbs.h>  "int ibv_rate_to_mult(enum ibv_rate " "rate" ");  "enum ibv_rate mult_to_ibv_rate(int " "mult" "); 
"DESCRIPTION"
ibv_rate_to_mult() converts the IB transmission rate enumeration rate to a multiple of 2.5 Gbit/sec (the base rate). For example, if rate is IBV_RATE_5_GBPS, the value 2 will be returned (5 Gbit/sec = 2 * 2.5 Gbit/sec).

mult_to_ibv_rate() converts the multiplier value (of 2.5 Gbit/sec) mult to an IB transmission rate enumeration. For example, if mult is 2, the rate enumeration IBV_RATE_5_GBPS will be returned.

"RETURN VALUE"
ibv_rate_to_mult() returns the multiplier of the base rate 2.5 Gbit/sec.

mult_to_ibv_rate() returns the enumeration representing the IB transmission rate.

"SEE ALSO"
ibv_query_port (3)
"AUTHORS"

Dotan Barak <dotanba@gmail.com>