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