include/rdma/ib_cache.h

   1 /*
   2  * Copyright (c) 2004 Topspin Communications.  All rights reserved.
   3  * Copyright (c) 2005 Intel Corporation. All rights reserved.
   4  * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
   5  *
   6  * This software is available to you under a choice of one of two
   7  * licenses.  You may choose to be licensed under the terms of the GNU
   8  * General Public License (GPL) Version 2, available from the file
   9  * COPYING in the main directory of this source tree, or the
  10  * OpenIB.org BSD license below:
  11  *
  12  *     Redistribution and use in source and binary forms, with or
  13  *     without modification, are permitted provided that the following
  14  *     conditions are met:
  15  *
  16  *      - Redistributions of source code must retain the above
  17  *        copyright notice, this list of conditions and the following
  18  *        disclaimer.
  19  *
  20  *      - Redistributions in binary form must reproduce the above
  21  *        copyright notice, this list of conditions and the following
  22  *        disclaimer in the documentation and/or other materials
  23  *        provided with the distribution.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  32  * SOFTWARE.
  33  */
  34
  35 #ifndef _IB_CACHE_H
  36 #define _IB_CACHE_H
  37
  38 #include <rdma/ib_verbs.h>
  39
  40 /**
  41  * ib_get_cached_gid - Returns a cached GID table entry
  42  * @device: The device to query.
  43  * @port_num: The port number of the device to query.
  44  * @index: The index into the cached GID table to query.
  45  * @gid: The GID value found at the specified index.
  46  * @attr: The GID attribute found at the specified index (only in RoCE).
  47  *   NULL means ignore (output parameter).
  48  *
  49  * ib_get_cached_gid() fetches the specified GID table entry stored in
  50  * the local software cache.
  51  */
  52 int ib_get_cached_gid(struct ib_device    *device,
  53                       u8                   port_num,
  54                       int                  index,
  55                       union ib_gid        *gid,
  56                       struct ib_gid_attr  *attr);
  57
  58 int ib_find_cached_gid(struct ib_device *device,
  59                        const union ib_gid *gid,
  60                        enum ib_gid_type gid_type,
  61                        struct net_device *ndev,
  62                        u8               *port_num,
  63                        u16              *index);
  64
  65 int ib_find_cached_gid_by_port(struct ib_device *device,
  66                                const union ib_gid *gid,
  67                                enum ib_gid_type gid_type,
  68                                u8               port_num,
  69                                struct net_device *ndev,
  70                                u16              *index);
  71
  72 int ib_find_gid_by_filter(struct ib_device *device,
  73                           const union ib_gid *gid,
  74                           u8 port_num,
  75                           bool (*filter)(const union ib_gid *gid,
  76                                          const struct ib_gid_attr *,
  77                                          void *),
  78                           void *context, u16 *index);
  79 /**
  80  * ib_get_cached_pkey - Returns a cached PKey table entry
  81  * @device: The device to query.
  82  * @port_num: The port number of the device to query.
  83  * @index: The index into the cached PKey table to query.
  84  * @pkey: The PKey value found at the specified index.
  85  *
  86  * ib_get_cached_pkey() fetches the specified PKey table entry stored in
  87  * the local software cache.
  88  */
  89 int ib_get_cached_pkey(struct ib_device    *device_handle,
  90                        u8                   port_num,
  91                        int                  index,
  92                        u16                 *pkey);
  93
  94 /**
  95  * ib_find_cached_pkey - Returns the PKey table index where a specified
  96  *   PKey value occurs.
  97  * @device: The device to query.
  98  * @port_num: The port number of the device to search for the PKey.
  99  * @pkey: The PKey value to search for.
 100  * @index: The index into the cached PKey table where the PKey was found.
 101  *
 102  * ib_find_cached_pkey() searches the specified PKey table in
 103  * the local software cache.
 104  */
 105 int ib_find_cached_pkey(struct ib_device    *device,
 106                         u8                   port_num,
 107                         u16                  pkey,
 108                         u16                 *index);
 109
 110 /**
 111  * ib_find_exact_cached_pkey - Returns the PKey table index where a specified
 112  *   PKey value occurs. Comparison uses the FULL 16 bits (incl membership bit)
 113  * @device: The device to query.
 114  * @port_num: The port number of the device to search for the PKey.
 115  * @pkey: The PKey value to search for.
 116  * @index: The index into the cached PKey table where the PKey was found.
 117  *
 118  * ib_find_exact_cached_pkey() searches the specified PKey table in
 119  * the local software cache.
 120  */
 121 int ib_find_exact_cached_pkey(struct ib_device    *device,
 122                               u8                   port_num,
 123                               u16                  pkey,
 124                               u16                 *index);
 125
 126 /**
 127  * ib_get_cached_lmc - Returns a cached lmc table entry
 128  * @device: The device to query.
 129  * @port_num: The port number of the device to query.
 130  * @lmc: The lmc value for the specified port for that device.
 131  *
 132  * ib_get_cached_lmc() fetches the specified lmc table entry stored in
 133  * the local software cache.
 134  */
 135 int ib_get_cached_lmc(struct ib_device *device,
 136                       u8                port_num,
 137                       u8                *lmc);
 138
 139 /**
 140  * ib_get_cached_port_state - Returns a cached port state table entry
 141  * @device: The device to query.
 142  * @port_num: The port number of the device to query.
 143  * @port_state: port_state for the specified port for that device.
 144  *
 145  * ib_get_cached_port_state() fetches the specified port_state table entry stored in
 146  * the local software cache.
 147  */
 148 int ib_get_cached_port_state(struct ib_device *device,
 149                               u8                port_num,
 150                               enum ib_port_state *port_active);
 151
 152 bool rdma_is_zero_gid(const union ib_gid *gid);
 153 #endif /* _IB_CACHE_H */