x86/topology: Fix function name in documentation
[cris-mirror.git] / drivers / infiniband / core / core_priv.h
blobc4560d84dfaebd550f504f2ed6b5f30bfb7ad520
1 /*
2 * Copyright (c) 2004 Topspin Communications. All rights reserved.
4 * This software is available to you under a choice of one of two
5 * licenses. You may choose to be licensed under the terms of the GNU
6 * General Public License (GPL) Version 2, available from the file
7 * COPYING in the main directory of this source tree, or the
8 * OpenIB.org BSD license below:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
12 * conditions are met:
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
16 * disclaimer.
18 * - Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials
21 * provided with the distribution.
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 * SOFTWARE.
33 #ifndef _CORE_PRIV_H
34 #define _CORE_PRIV_H
36 #include <linux/list.h>
37 #include <linux/spinlock.h>
38 #include <linux/cgroup_rdma.h>
40 #include <rdma/ib_verbs.h>
41 #include <rdma/opa_addr.h>
42 #include <rdma/ib_mad.h>
43 #include <rdma/restrack.h>
44 #include "mad_priv.h"
46 /* Total number of ports combined across all struct ib_devices's */
47 #define RDMA_MAX_PORTS 1024
49 struct pkey_index_qp_list {
50 struct list_head pkey_index_list;
51 u16 pkey_index;
52 /* Lock to hold while iterating the qp_list. */
53 spinlock_t qp_list_lock;
54 struct list_head qp_list;
57 #if IS_ENABLED(CONFIG_INFINIBAND_ADDR_TRANS_CONFIGFS)
58 int cma_configfs_init(void);
59 void cma_configfs_exit(void);
60 #else
61 static inline int cma_configfs_init(void)
63 return 0;
66 static inline void cma_configfs_exit(void)
69 #endif
70 struct cma_device;
71 void cma_ref_dev(struct cma_device *cma_dev);
72 void cma_deref_dev(struct cma_device *cma_dev);
73 typedef bool (*cma_device_filter)(struct ib_device *, void *);
74 struct cma_device *cma_enum_devices_by_ibdev(cma_device_filter filter,
75 void *cookie);
76 int cma_get_default_gid_type(struct cma_device *cma_dev,
77 unsigned int port);
78 int cma_set_default_gid_type(struct cma_device *cma_dev,
79 unsigned int port,
80 enum ib_gid_type default_gid_type);
81 int cma_get_default_roce_tos(struct cma_device *cma_dev, unsigned int port);
82 int cma_set_default_roce_tos(struct cma_device *a_dev, unsigned int port,
83 u8 default_roce_tos);
84 struct ib_device *cma_get_ib_dev(struct cma_device *cma_dev);
86 int ib_device_register_sysfs(struct ib_device *device,
87 int (*port_callback)(struct ib_device *,
88 u8, struct kobject *));
89 void ib_device_unregister_sysfs(struct ib_device *device);
91 void ib_cache_setup(void);
92 void ib_cache_cleanup(void);
94 typedef void (*roce_netdev_callback)(struct ib_device *device, u8 port,
95 struct net_device *idev, void *cookie);
97 typedef int (*roce_netdev_filter)(struct ib_device *device, u8 port,
98 struct net_device *idev, void *cookie);
100 void ib_enum_roce_netdev(struct ib_device *ib_dev,
101 roce_netdev_filter filter,
102 void *filter_cookie,
103 roce_netdev_callback cb,
104 void *cookie);
105 void ib_enum_all_roce_netdevs(roce_netdev_filter filter,
106 void *filter_cookie,
107 roce_netdev_callback cb,
108 void *cookie);
110 typedef int (*nldev_callback)(struct ib_device *device,
111 struct sk_buff *skb,
112 struct netlink_callback *cb,
113 unsigned int idx);
115 int ib_enum_all_devs(nldev_callback nldev_cb, struct sk_buff *skb,
116 struct netlink_callback *cb);
118 enum ib_cache_gid_default_mode {
119 IB_CACHE_GID_DEFAULT_MODE_SET,
120 IB_CACHE_GID_DEFAULT_MODE_DELETE
123 int ib_cache_gid_parse_type_str(const char *buf);
125 const char *ib_cache_gid_type_str(enum ib_gid_type gid_type);
127 void ib_cache_gid_set_default_gid(struct ib_device *ib_dev, u8 port,
128 struct net_device *ndev,
129 unsigned long gid_type_mask,
130 enum ib_cache_gid_default_mode mode);
132 int ib_cache_gid_add(struct ib_device *ib_dev, u8 port,
133 union ib_gid *gid, struct ib_gid_attr *attr);
135 int ib_cache_gid_del(struct ib_device *ib_dev, u8 port,
136 union ib_gid *gid, struct ib_gid_attr *attr);
138 int ib_cache_gid_del_all_netdev_gids(struct ib_device *ib_dev, u8 port,
139 struct net_device *ndev);
141 int roce_gid_mgmt_init(void);
142 void roce_gid_mgmt_cleanup(void);
144 unsigned long roce_gid_type_mask_support(struct ib_device *ib_dev, u8 port);
146 int ib_cache_setup_one(struct ib_device *device);
147 void ib_cache_cleanup_one(struct ib_device *device);
148 void ib_cache_release_one(struct ib_device *device);
150 #ifdef CONFIG_CGROUP_RDMA
151 int ib_device_register_rdmacg(struct ib_device *device);
152 void ib_device_unregister_rdmacg(struct ib_device *device);
154 int ib_rdmacg_try_charge(struct ib_rdmacg_object *cg_obj,
155 struct ib_device *device,
156 enum rdmacg_resource_type resource_index);
158 void ib_rdmacg_uncharge(struct ib_rdmacg_object *cg_obj,
159 struct ib_device *device,
160 enum rdmacg_resource_type resource_index);
161 #else
162 static inline int ib_device_register_rdmacg(struct ib_device *device)
163 { return 0; }
165 static inline void ib_device_unregister_rdmacg(struct ib_device *device)
168 static inline int ib_rdmacg_try_charge(struct ib_rdmacg_object *cg_obj,
169 struct ib_device *device,
170 enum rdmacg_resource_type resource_index)
171 { return 0; }
173 static inline void ib_rdmacg_uncharge(struct ib_rdmacg_object *cg_obj,
174 struct ib_device *device,
175 enum rdmacg_resource_type resource_index)
177 #endif
179 static inline bool rdma_is_upper_dev_rcu(struct net_device *dev,
180 struct net_device *upper)
182 return netdev_has_upper_dev_all_rcu(dev, upper);
185 int addr_init(void);
186 void addr_cleanup(void);
188 int ib_mad_init(void);
189 void ib_mad_cleanup(void);
191 int ib_sa_init(void);
192 void ib_sa_cleanup(void);
194 int rdma_nl_init(void);
195 void rdma_nl_exit(void);
197 int ib_nl_handle_resolve_resp(struct sk_buff *skb,
198 struct nlmsghdr *nlh,
199 struct netlink_ext_ack *extack);
200 int ib_nl_handle_set_timeout(struct sk_buff *skb,
201 struct nlmsghdr *nlh,
202 struct netlink_ext_ack *extack);
203 int ib_nl_handle_ip_res_resp(struct sk_buff *skb,
204 struct nlmsghdr *nlh,
205 struct netlink_ext_ack *extack);
207 int ib_get_cached_subnet_prefix(struct ib_device *device,
208 u8 port_num,
209 u64 *sn_pfx);
211 #ifdef CONFIG_SECURITY_INFINIBAND
212 void ib_security_destroy_port_pkey_list(struct ib_device *device);
214 void ib_security_cache_change(struct ib_device *device,
215 u8 port_num,
216 u64 subnet_prefix);
218 int ib_security_modify_qp(struct ib_qp *qp,
219 struct ib_qp_attr *qp_attr,
220 int qp_attr_mask,
221 struct ib_udata *udata);
223 int ib_create_qp_security(struct ib_qp *qp, struct ib_device *dev);
224 void ib_destroy_qp_security_begin(struct ib_qp_security *sec);
225 void ib_destroy_qp_security_abort(struct ib_qp_security *sec);
226 void ib_destroy_qp_security_end(struct ib_qp_security *sec);
227 int ib_open_shared_qp_security(struct ib_qp *qp, struct ib_device *dev);
228 void ib_close_shared_qp_security(struct ib_qp_security *sec);
229 int ib_mad_agent_security_setup(struct ib_mad_agent *agent,
230 enum ib_qp_type qp_type);
231 void ib_mad_agent_security_cleanup(struct ib_mad_agent *agent);
232 int ib_mad_enforce_security(struct ib_mad_agent_private *map, u16 pkey_index);
233 #else
234 static inline void ib_security_destroy_port_pkey_list(struct ib_device *device)
238 static inline void ib_security_cache_change(struct ib_device *device,
239 u8 port_num,
240 u64 subnet_prefix)
244 static inline int ib_security_modify_qp(struct ib_qp *qp,
245 struct ib_qp_attr *qp_attr,
246 int qp_attr_mask,
247 struct ib_udata *udata)
249 return qp->device->modify_qp(qp->real_qp,
250 qp_attr,
251 qp_attr_mask,
252 udata);
255 static inline int ib_create_qp_security(struct ib_qp *qp,
256 struct ib_device *dev)
258 return 0;
261 static inline void ib_destroy_qp_security_begin(struct ib_qp_security *sec)
265 static inline void ib_destroy_qp_security_abort(struct ib_qp_security *sec)
269 static inline void ib_destroy_qp_security_end(struct ib_qp_security *sec)
273 static inline int ib_open_shared_qp_security(struct ib_qp *qp,
274 struct ib_device *dev)
276 return 0;
279 static inline void ib_close_shared_qp_security(struct ib_qp_security *sec)
283 static inline int ib_mad_agent_security_setup(struct ib_mad_agent *agent,
284 enum ib_qp_type qp_type)
286 return 0;
289 static inline void ib_mad_agent_security_cleanup(struct ib_mad_agent *agent)
293 static inline int ib_mad_enforce_security(struct ib_mad_agent_private *map,
294 u16 pkey_index)
296 return 0;
298 #endif
300 struct ib_device *ib_device_get_by_index(u32 ifindex);
301 /* RDMA device netlink */
302 void nldev_init(void);
303 void nldev_exit(void);
305 static inline struct ib_qp *_ib_create_qp(struct ib_device *dev,
306 struct ib_pd *pd,
307 struct ib_qp_init_attr *attr,
308 struct ib_udata *udata)
310 struct ib_qp *qp;
312 qp = dev->create_qp(pd, attr, udata);
313 if (IS_ERR(qp))
314 return qp;
316 qp->device = dev;
317 qp->pd = pd;
319 * We don't track XRC QPs for now, because they don't have PD
320 * and more importantly they are created internaly by driver,
321 * see mlx5 create_dev_resources() as an example.
323 if (attr->qp_type < IB_QPT_XRC_INI) {
324 qp->res.type = RDMA_RESTRACK_QP;
325 rdma_restrack_add(&qp->res);
326 } else
327 qp->res.valid = false;
329 return qp;
331 #endif /* _CORE_PRIV_H */