[ofw] [PATCH] update IPoIB hardware address comments

[Smith, Stan]

Alex Naslednikov wrote:
> Great comments !
> Please, commit

done in svn commit 3055.

>
> -----Original Message-----
> From: Smith, Stan [mailto:stan.smith at intel.com]
> Sent: Tuesday, December 28, 2010 8:13 PM
> To: Alex Naslednikov
> Cc: ofw at lists.openfabrics.org
> Subject: [PATCH] update IPoIB hardware address comments
>
>
> signed-off-by: stan smith <stan.smith at intel.com>
>
> --- A/ulp/ipoib_NDIS6_CM/kernel/ipoib_xfr_mgr.h Tue Dec 28 10:09:06
> 2010 +++ B/ulp/ipoib_NDIS6_CM/kernel/ipoib_xfr_mgr.h Tue Dec 28
> 10:10:25 2010 @@ -53,7 +53,8 @@
>  *
>  * DESCRIPTION
>  *   The ipoib_hw_addr_t structure defines an IPoIB compatible
> hardware -*   address.  Values in this structure are stored in
> network order. +*   address, otherwise known as the IPoIB CM Link
> Layer Address [RFC 4755]. +*      Values in this structure are stored
>  in network order. *
>  * SYNOPSIS
>  */
> @@ -69,6 +70,42 @@
>  *              Flags and queue pair number.  Use
> ipoib_addr_get_flags,
>  *              ipoib_addr_set_flags, ipoib_addr_set_qpn, and
> ipoib_addr_get_qpn
>  *              to manipulate the contents.
> +*
> +*      Flags:
> +*     This is a single-octet field.  The bits indicate the connected
> +*     modes supported by the interface.
> +*
> +*     Bit 0 specifies the support for the "reliable connected" (RC)
> +*     mode.  Bit 1 indicates the support for the "unreliable
> connected" +*     (UC) mode.  All other bits in the octet are
> reserved and MUST be +*     set to 0 on transmits and ignored on
> receives.  The format of the +*     flags is as follows:
> +*
> +*               +--+--+--+--+--+--+--+--+
> +*               |RC|UC| 0| 0| 0| 0| 0| 0|
> +*               +--+--+--+--+--+--+--+--+
> +*
> +*     Both the RC and UC MAY be set at the same time if the interface
> +*     supports both the modes.  Since the IPoIB-UD mode is always
> +*     supported, there are no flags to indicate IPoIB-UD support.
> +*
> +*     If IPoIB-CM is not supported, i.e., if the implementation only
> +*     supports IPoIB-UD, then the implementation MUST ignore the
> <Flags> +*     on reception.  It MUST set the <Flags> octet to all
> zeros on +*     transmission as specified in [RFC 4391].
> +*
> +*  QPN:
> +*     The queue-pair number (QPN) on which the unicast address
> +*     resolution replies will be received [RFC 4391].  An IPoIB
> interface +*     has only one UD QP associated with it whether or not
> it supports +*     this extension.
> +*
> +*     The QPN also serves another purpose.  It is used to form the
> +*     Service-ID that is used to set up the IB connection.
> +*
> +*  On receiving the multicast/broadcast address resolution request,
> the +*  receiver replies with its own link address, including the
> associated +*  UD QPN and the appropriate flags.
>  *
>  *      gid
>  *              IB GID value.