xref: /openbmc/linux/include/rdma/ib_cache.h (revision 04b3c795)
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 int rdma_query_gid(struct ib_device *device, u8 port_num, int index,
41 		   union ib_gid *gid);
42 void *rdma_read_gid_hw_context(const struct ib_gid_attr *attr);
43 const struct ib_gid_attr *rdma_find_gid(struct ib_device *device,
44 					const union ib_gid *gid,
45 					enum ib_gid_type gid_type,
46 					struct net_device *ndev);
47 const struct ib_gid_attr *rdma_find_gid_by_port(struct ib_device *ib_dev,
48 						const union ib_gid *gid,
49 						enum ib_gid_type gid_type,
50 						u8 port,
51 						struct net_device *ndev);
52 const struct ib_gid_attr *rdma_find_gid_by_filter(
53 	struct ib_device *device, const union ib_gid *gid, u8 port_num,
54 	bool (*filter)(const union ib_gid *gid, const struct ib_gid_attr *,
55 		       void *),
56 	void *context);
57 
58 int rdma_read_gid_l2_fields(const struct ib_gid_attr *attr,
59 			    u16 *vlan_id, u8 *smac);
60 struct net_device *rdma_read_gid_attr_ndev_rcu(const struct ib_gid_attr *attr);
61 
62 /**
63  * ib_get_cached_pkey - Returns a cached PKey table entry
64  * @device: The device to query.
65  * @port_num: The port number of the device to query.
66  * @index: The index into the cached PKey table to query.
67  * @pkey: The PKey value found at the specified index.
68  *
69  * ib_get_cached_pkey() fetches the specified PKey table entry stored in
70  * the local software cache.
71  */
72 int ib_get_cached_pkey(struct ib_device    *device_handle,
73 		       u8                   port_num,
74 		       int                  index,
75 		       u16                 *pkey);
76 
77 /**
78  * ib_find_cached_pkey - Returns the PKey table index where a specified
79  *   PKey value occurs.
80  * @device: The device to query.
81  * @port_num: The port number of the device to search for the PKey.
82  * @pkey: The PKey value to search for.
83  * @index: The index into the cached PKey table where the PKey was found.
84  *
85  * ib_find_cached_pkey() searches the specified PKey table in
86  * the local software cache.
87  */
88 int ib_find_cached_pkey(struct ib_device    *device,
89 			u8                   port_num,
90 			u16                  pkey,
91 			u16                 *index);
92 
93 /**
94  * ib_find_exact_cached_pkey - Returns the PKey table index where a specified
95  *   PKey value occurs. Comparison uses the FULL 16 bits (incl membership bit)
96  * @device: The device to query.
97  * @port_num: The port number of the device to search for the PKey.
98  * @pkey: The PKey value to search for.
99  * @index: The index into the cached PKey table where the PKey was found.
100  *
101  * ib_find_exact_cached_pkey() searches the specified PKey table in
102  * the local software cache.
103  */
104 int ib_find_exact_cached_pkey(struct ib_device    *device,
105 			      u8                   port_num,
106 			      u16                  pkey,
107 			      u16                 *index);
108 
109 /**
110  * ib_get_cached_lmc - Returns a cached lmc table entry
111  * @device: The device to query.
112  * @port_num: The port number of the device to query.
113  * @lmc: The lmc value for the specified port for that device.
114  *
115  * ib_get_cached_lmc() fetches the specified lmc table entry stored in
116  * the local software cache.
117  */
118 int ib_get_cached_lmc(struct ib_device *device,
119 		      u8                port_num,
120 		      u8                *lmc);
121 
122 /**
123  * ib_get_cached_port_state - Returns a cached port state table entry
124  * @device: The device to query.
125  * @port_num: The port number of the device to query.
126  * @port_state: port_state for the specified port for that device.
127  *
128  * ib_get_cached_port_state() fetches the specified port_state table entry stored in
129  * the local software cache.
130  */
131 int ib_get_cached_port_state(struct ib_device *device,
132 			      u8                port_num,
133 			      enum ib_port_state *port_active);
134 
135 bool rdma_is_zero_gid(const union ib_gid *gid);
136 const struct ib_gid_attr *rdma_get_gid_attr(struct ib_device *device,
137 					    u8 port_num, int index);
138 void rdma_put_gid_attr(const struct ib_gid_attr *attr);
139 void rdma_hold_gid_attr(const struct ib_gid_attr *attr);
140 
141 #endif /* _IB_CACHE_H */
142