include/rdma/opa_addr.h

   1 /*
   2  * Copyright(c) 2017 Intel Corporation.
   3  *
   4  * This file is provided under a dual BSD/GPLv2 license.  When using or
   5  * redistributing this file, you may do so under either license.
   6  *
   7  * GPL LICENSE SUMMARY
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of version 2 of the GNU General Public License as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * BSD LICENSE
  19  *
  20  * Redistribution and use in source and binary forms, with or without
  21  * modification, are permitted provided that the following conditions
  22  * are met:
  23  *
  24  *  - Redistributions of source code must retain the above copyright
  25  *    notice, this list of conditions and the following disclaimer.
  26  *  - Redistributions in binary form must reproduce the above copyright
  27  *    notice, this list of conditions and the following disclaimer in
  28  *    the documentation and/or other materials provided with the
  29  *    distribution.
  30  *  - Neither the name of Intel Corporation nor the names of its
  31  *    contributors may be used to endorse or promote products derived
  32  *    from this software without specific prior written permission.
  33  *
  34  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  35  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  36  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  37  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  38  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  39  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  40  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  41  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  42  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  43  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  44  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  45  *
  46  */
  47
  48 #ifndef OPA_ADDR_H
  49 #define OPA_ADDR_H
  50
  51 #include <rdma/opa_smi.h>
  52
  53 #define OPA_SPECIAL_OUI         (0x00066AULL)
  54 #define OPA_MAKE_ID(x)          (cpu_to_be64(OPA_SPECIAL_OUI << 40 | (x)))
  55 #define OPA_TO_IB_UCAST_LID(x) (((x) >= be16_to_cpu(IB_MULTICAST_LID_BASE)) \
  56                                 ? 0 : x)
  57 #define OPA_GID_INDEX           0x1
  58 /**
  59  * 0xF8 - 4 bits of multicast range and 1 bit for collective range
  60  * Example: For 24 bit LID space,
  61  * Multicast range: 0xF00000 to 0xF7FFFF
  62  * Collective range: 0xF80000 to 0xFFFFFE
  63  */
  64 #define OPA_MCAST_NR 0x4 /* Number of top bits set */
  65 #define OPA_COLLECTIVE_NR 0x1 /* Number of bits after MCAST_NR */
  66
  67 /**
  68  * ib_is_opa_gid: Returns true if the top 24 bits of the gid
  69  * contains the OPA_STL_OUI identifier. This identifies that
  70  * the provided gid is a special purpose GID meant to carry
  71  * extended LID information.
  72  *
  73  * @gid: The Global identifier
  74  */
  75 static inline bool ib_is_opa_gid(const union ib_gid *gid)
  76 {
  77         return ((be64_to_cpu(gid->global.interface_id) >> 40) ==
  78                 OPA_SPECIAL_OUI);
  79 }
  80
  81 /**
  82  * opa_get_lid_from_gid: Returns the last 32 bits of the gid.
  83  * OPA devices use one of the gids in the gid table to also
  84  * store the lid.
  85  *
  86  * @gid: The Global identifier
  87  */
  88 static inline u32 opa_get_lid_from_gid(const union ib_gid *gid)
  89 {
  90         return be64_to_cpu(gid->global.interface_id) & 0xFFFFFFFF;
  91 }
  92
  93 /**
  94  * opa_is_extended_lid: Returns true if dlid or slid are
  95  * extended.
  96  *
  97  * @dlid: The DLID
  98  * @slid: The SLID
  99  */
 100 static inline bool opa_is_extended_lid(__be32 dlid, __be32 slid)
 101 {
 102         if ((be32_to_cpu(dlid) >=
 103              be16_to_cpu(IB_MULTICAST_LID_BASE)) ||
 104             (be32_to_cpu(slid) >=
 105              be16_to_cpu(IB_MULTICAST_LID_BASE)))
 106                 return true;
 107
 108         return false;
 109 }
 110
 111 /* Get multicast lid base */
 112 static inline u32 opa_get_mcast_base(u32 nr_top_bits)
 113 {
 114         return (be32_to_cpu(OPA_LID_PERMISSIVE) << (32 - nr_top_bits));
 115 }
 116
 117 /* Check for a valid unicast LID for non-SM traffic types */
 118 static inline bool rdma_is_valid_unicast_lid(struct rdma_ah_attr *attr)
 119 {
 120         if (attr->type == RDMA_AH_ATTR_TYPE_IB) {
 121                 if (!rdma_ah_get_dlid(attr) ||
 122                     rdma_ah_get_dlid(attr) >=
 123                     be32_to_cpu(IB_MULTICAST_LID_BASE))
 124                         return false;
 125         } else if (attr->type == RDMA_AH_ATTR_TYPE_OPA) {
 126                 if (!rdma_ah_get_dlid(attr) ||
 127                     rdma_ah_get_dlid(attr) >=
 128                     opa_get_mcast_base(OPA_MCAST_NR))
 129                         return false;
 130         }
 131         return true;
 132 }
 133 #endif /* OPA_ADDR_H */