Loading...
1/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
2/*
3 * Copyright (c) 2004 Topspin Communications. All rights reserved.
4 * Copyright (c) 2005 Intel Corporation. All rights reserved.
5 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
6 */
7
8#ifndef _IB_CACHE_H
9#define _IB_CACHE_H
10
11#include <rdma/ib_verbs.h>
12
13int rdma_query_gid(struct ib_device *device, u32 port_num, int index,
14 union ib_gid *gid);
15void *rdma_read_gid_hw_context(const struct ib_gid_attr *attr);
16const struct ib_gid_attr *rdma_find_gid(struct ib_device *device,
17 const union ib_gid *gid,
18 enum ib_gid_type gid_type,
19 struct net_device *ndev);
20const struct ib_gid_attr *rdma_find_gid_by_port(struct ib_device *ib_dev,
21 const union ib_gid *gid,
22 enum ib_gid_type gid_type,
23 u32 port,
24 struct net_device *ndev);
25const struct ib_gid_attr *rdma_find_gid_by_filter(
26 struct ib_device *device, const union ib_gid *gid, u32 port_num,
27 bool (*filter)(const union ib_gid *gid, const struct ib_gid_attr *,
28 void *),
29 void *context);
30
31int rdma_read_gid_l2_fields(const struct ib_gid_attr *attr,
32 u16 *vlan_id, u8 *smac);
33struct net_device *rdma_read_gid_attr_ndev_rcu(const struct ib_gid_attr *attr);
34
35/**
36 * ib_get_cached_pkey - Returns a cached PKey table entry
37 * @device: The device to query.
38 * @port_num: The port number of the device to query.
39 * @index: The index into the cached PKey table to query.
40 * @pkey: The PKey value found at the specified index.
41 *
42 * ib_get_cached_pkey() fetches the specified PKey table entry stored in
43 * the local software cache.
44 */
45int ib_get_cached_pkey(struct ib_device *device_handle,
46 u32 port_num,
47 int index,
48 u16 *pkey);
49
50/**
51 * ib_find_cached_pkey - Returns the PKey table index where a specified
52 * PKey value occurs.
53 * @device: The device to query.
54 * @port_num: The port number of the device to search for the PKey.
55 * @pkey: The PKey value to search for.
56 * @index: The index into the cached PKey table where the PKey was found.
57 *
58 * ib_find_cached_pkey() searches the specified PKey table in
59 * the local software cache.
60 */
61int ib_find_cached_pkey(struct ib_device *device,
62 u32 port_num,
63 u16 pkey,
64 u16 *index);
65
66/**
67 * ib_find_exact_cached_pkey - Returns the PKey table index where a specified
68 * PKey value occurs. Comparison uses the FULL 16 bits (incl membership bit)
69 * @device: The device to query.
70 * @port_num: The port number of the device to search for the PKey.
71 * @pkey: The PKey value to search for.
72 * @index: The index into the cached PKey table where the PKey was found.
73 *
74 * ib_find_exact_cached_pkey() searches the specified PKey table in
75 * the local software cache.
76 */
77int ib_find_exact_cached_pkey(struct ib_device *device,
78 u32 port_num,
79 u16 pkey,
80 u16 *index);
81
82/**
83 * ib_get_cached_lmc - Returns a cached lmc table entry
84 * @device: The device to query.
85 * @port_num: The port number of the device to query.
86 * @lmc: The lmc value for the specified port for that device.
87 *
88 * ib_get_cached_lmc() fetches the specified lmc table entry stored in
89 * the local software cache.
90 */
91int ib_get_cached_lmc(struct ib_device *device,
92 u32 port_num,
93 u8 *lmc);
94
95/**
96 * ib_get_cached_port_state - Returns a cached port state table entry
97 * @device: The device to query.
98 * @port_num: The port number of the device to query.
99 * @port_state: port_state for the specified port for that device.
100 *
101 * ib_get_cached_port_state() fetches the specified port_state table entry stored in
102 * the local software cache.
103 */
104int ib_get_cached_port_state(struct ib_device *device,
105 u32 port_num,
106 enum ib_port_state *port_active);
107
108bool rdma_is_zero_gid(const union ib_gid *gid);
109const struct ib_gid_attr *rdma_get_gid_attr(struct ib_device *device,
110 u32 port_num, int index);
111void rdma_put_gid_attr(const struct ib_gid_attr *attr);
112void rdma_hold_gid_attr(const struct ib_gid_attr *attr);
113ssize_t rdma_query_gid_table(struct ib_device *device,
114 struct ib_uverbs_gid_entry *entries,
115 size_t max_entries);
116
117#endif /* _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 */
52int 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/**
59 * ib_find_cached_gid - Returns the port number and GID table index where
60 * a specified GID value occurs.
61 * @device: The device to query.
62 * @gid: The GID value to search for.
63 * @gid_type: The GID type to search for.
64 * @ndev: In RoCE, the net device of the device. NULL means ignore.
65 * @port_num: The port number of the device where the GID value was found.
66 * @index: The index into the cached GID table where the GID was found. This
67 * parameter may be NULL.
68 *
69 * ib_find_cached_gid() searches for the specified GID value in
70 * the local software cache.
71 */
72int ib_find_cached_gid(struct ib_device *device,
73 const union ib_gid *gid,
74 enum ib_gid_type gid_type,
75 struct net_device *ndev,
76 u8 *port_num,
77 u16 *index);
78
79/**
80 * ib_find_cached_gid_by_port - Returns the GID table index where a specified
81 * GID value occurs
82 * @device: The device to query.
83 * @gid: The GID value to search for.
84 * @gid_type: The GID type to search for.
85 * @port_num: The port number of the device where the GID value sould be
86 * searched.
87 * @ndev: In RoCE, the net device of the device. Null means ignore.
88 * @index: The index into the cached GID table where the GID was found. This
89 * parameter may be NULL.
90 *
91 * ib_find_cached_gid() searches for the specified GID value in
92 * the local software cache.
93 */
94int ib_find_cached_gid_by_port(struct ib_device *device,
95 const union ib_gid *gid,
96 enum ib_gid_type gid_type,
97 u8 port_num,
98 struct net_device *ndev,
99 u16 *index);
100
101int ib_find_gid_by_filter(struct ib_device *device,
102 const union ib_gid *gid,
103 u8 port_num,
104 bool (*filter)(const union ib_gid *gid,
105 const struct ib_gid_attr *,
106 void *),
107 void *context, u16 *index);
108/**
109 * ib_get_cached_pkey - Returns a cached PKey table entry
110 * @device: The device to query.
111 * @port_num: The port number of the device to query.
112 * @index: The index into the cached PKey table to query.
113 * @pkey: The PKey value found at the specified index.
114 *
115 * ib_get_cached_pkey() fetches the specified PKey table entry stored in
116 * the local software cache.
117 */
118int ib_get_cached_pkey(struct ib_device *device_handle,
119 u8 port_num,
120 int index,
121 u16 *pkey);
122
123/**
124 * ib_find_cached_pkey - Returns the PKey table index where a specified
125 * PKey value occurs.
126 * @device: The device to query.
127 * @port_num: The port number of the device to search for the PKey.
128 * @pkey: The PKey value to search for.
129 * @index: The index into the cached PKey table where the PKey was found.
130 *
131 * ib_find_cached_pkey() searches the specified PKey table in
132 * the local software cache.
133 */
134int ib_find_cached_pkey(struct ib_device *device,
135 u8 port_num,
136 u16 pkey,
137 u16 *index);
138
139/**
140 * ib_find_exact_cached_pkey - Returns the PKey table index where a specified
141 * PKey value occurs. Comparison uses the FULL 16 bits (incl membership bit)
142 * @device: The device to query.
143 * @port_num: The port number of the device to search for the PKey.
144 * @pkey: The PKey value to search for.
145 * @index: The index into the cached PKey table where the PKey was found.
146 *
147 * ib_find_exact_cached_pkey() searches the specified PKey table in
148 * the local software cache.
149 */
150int ib_find_exact_cached_pkey(struct ib_device *device,
151 u8 port_num,
152 u16 pkey,
153 u16 *index);
154
155/**
156 * ib_get_cached_lmc - Returns a cached lmc table entry
157 * @device: The device to query.
158 * @port_num: The port number of the device to query.
159 * @lmc: The lmc value for the specified port for that device.
160 *
161 * ib_get_cached_lmc() fetches the specified lmc table entry stored in
162 * the local software cache.
163 */
164int ib_get_cached_lmc(struct ib_device *device,
165 u8 port_num,
166 u8 *lmc);
167
168#endif /* _IB_CACHE_H */