5 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
7 * Copyright(c) 2016 Intel Corporation.
9 * This file is provided under a dual BSD/GPLv2 license. When using or
10 * redistributing this file, you may do so under either license.
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of version 2 of the GNU General Public License as
16 * published by the Free Software Foundation.
18 * This program is distributed in the hope that it will be useful, but
19 * WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 * General Public License for more details.
25 * Redistribution and use in source and binary forms, with or without
26 * modification, are permitted provided that the following conditions
29 * - Redistributions of source code must retain the above copyright
30 * notice, this list of conditions and the following disclaimer.
31 * - Redistributions in binary form must reproduce the above copyright
32 * notice, this list of conditions and the following disclaimer in
33 * the documentation and/or other materials provided with the
35 * - Neither the name of Intel Corporation nor the names of its
36 * contributors may be used to endorse or promote products derived
37 * from this software without specific prior written permission.
39 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
40 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
41 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
42 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
43 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
45 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
46 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
47 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
48 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
49 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55 * Structure that low level drivers will populate in order to register with the
59 #include <linux/spinlock.h>
60 #include <linux/list.h>
61 #include <linux/hash.h>
62 #include <rdma/ib_verbs.h>
63 #include <rdma/rdmavt_mr.h>
64 #include <rdma/rdmavt_qp.h>
66 #define RVT_MAX_PKEY_VALUES 16
69 struct rvt_qp __rcu *qp[2];
70 struct ib_mad_agent *send_agent; /* agent for SMI (traps) */
71 struct rb_root mcast_tree;
72 spinlock_t lock; /* protect changes in this struct */
74 /* non-zero when timer is set */
75 unsigned long mkey_lease_timeout;
76 unsigned long trap_timeout;
77 __be64 gid_prefix; /* in network order */
82 u32 pma_sample_interval;
83 __be16 pma_counter_select[5];
85 u16 mkey_lease_period;
93 * Driver is expected to keep these up to date. These
94 * counters are informational only and not required to be
95 * completely accurate.
114 /* Hot-path per CPU counters to avoid cacheline trading to update */
117 u64 z_rc_delayed_comp;
118 u64 __percpu *rc_acks;
119 u64 __percpu *rc_qacks;
120 u64 __percpu *rc_delayed_comp;
122 void *priv; /* driver private data */
125 * The pkey table is allocated and maintained by the driver. Drivers
126 * need to have access to this before registering with rdmav. However
127 * rdmavt will need access to it so drivers need to proviee this during
128 * the attach port API call.
132 struct rvt_ah *sm_ah;
135 #define RVT_CQN_MAX 16 /* maximum length of cq name */
138 * Things that are driver specific, module parameters in hfi1 and qib
140 struct rvt_driver_params {
141 struct ib_device_attr props;
144 * Anything driver specific that is not covered by props
145 * For instance special module parameters. Goes here.
147 unsigned int lkey_table_size;
148 unsigned int qp_table_size;
155 char cq_name[RVT_CQN_MAX];
164 u8 reserved_operations;
167 /* Protection domain */
170 int user; /* non-zero if created from user space */
176 struct ib_ah_attr attr;
184 struct rvt_driver_provided {
186 * Which functions are required depends on which verbs rdmavt is
187 * providing and which verbs the driver is overriding. See
188 * check_support() for details.
191 /* Passed to ib core registration. Callback to create syfs files */
192 int (*port_callback)(struct ib_device *, u8, struct kobject *);
195 * Returns a string to represent the device for which is being
196 * registered. This is primarily used for error and debug messages on
199 const char * (*get_card_name)(struct rvt_dev_info *rdi);
202 * Returns a pointer to the undelying hardware's PCI device. This is
203 * used to display information as to what hardware is being referenced
204 * in an output message
206 struct pci_dev * (*get_pci_dev)(struct rvt_dev_info *rdi);
209 * Allocate a private queue pair data structure for driver specific
210 * information which is opaque to rdmavt. Errors are returned via
211 * ERR_PTR(err). The driver is free to return NULL or a valid
214 void * (*qp_priv_alloc)(struct rvt_dev_info *rdi, struct rvt_qp *qp,
218 * Free the driver's private qp structure.
220 void (*qp_priv_free)(struct rvt_dev_info *rdi, struct rvt_qp *qp);
223 * Inform the driver the particular qp in quesiton has been reset so
224 * that it can clean up anything it needs to.
226 void (*notify_qp_reset)(struct rvt_qp *qp);
229 * Give the driver a notice that there is send work to do. It is up to
230 * the driver to generally push the packets out, this just queues the
231 * work with the driver. There are two variants here. The no_lock
232 * version requires the s_lock not to be held. The other assumes the
235 void (*schedule_send)(struct rvt_qp *qp);
236 void (*schedule_send_no_lock)(struct rvt_qp *qp);
239 * Sometimes rdmavt needs to kick the driver's send progress. That is
240 * done by this call back.
242 void (*do_send)(struct rvt_qp *qp);
245 * Get a path mtu from the driver based on qp attributes.
247 int (*get_pmtu_from_attr)(struct rvt_dev_info *rdi, struct rvt_qp *qp,
248 struct ib_qp_attr *attr);
251 * Notify driver that it needs to flush any outstanding IO requests that
252 * are waiting on a qp.
254 void (*flush_qp_waiters)(struct rvt_qp *qp);
257 * Notify driver to stop its queue of sending packets. Nothing else
258 * should be posted to the queue pair after this has been called.
260 void (*stop_send_queue)(struct rvt_qp *qp);
263 * Have the drivr drain any in progress operations
265 void (*quiesce_qp)(struct rvt_qp *qp);
268 * Inform the driver a qp has went to error state.
270 void (*notify_error_qp)(struct rvt_qp *qp);
273 * Get an MTU for a qp.
275 u32 (*mtu_from_qp)(struct rvt_dev_info *rdi, struct rvt_qp *qp,
278 * Convert an mtu to a path mtu
280 int (*mtu_to_path_mtu)(u32 mtu);
283 * Get the guid of a port in big endian byte order
285 int (*get_guid_be)(struct rvt_dev_info *rdi, struct rvt_ibport *rvp,
286 int guid_index, __be64 *guid);
289 * Query driver for the state of the port.
291 int (*query_port_state)(struct rvt_dev_info *rdi, u8 port_num,
292 struct ib_port_attr *props);
295 * Tell driver to shutdown a port
297 int (*shut_down_port)(struct rvt_dev_info *rdi, u8 port_num);
299 /* Tell driver to send a trap for changed port capabilities */
300 void (*cap_mask_chg)(struct rvt_dev_info *rdi, u8 port_num);
303 * The following functions can be safely ignored completely. Any use of
304 * these is checked for NULL before blindly calling. Rdmavt should also
305 * be functional if drivers omit these.
308 /* Called to inform the driver that all qps should now be freed. */
309 unsigned (*free_all_qps)(struct rvt_dev_info *rdi);
311 /* Driver specific AH validation */
312 int (*check_ah)(struct ib_device *, struct ib_ah_attr *);
314 /* Inform the driver a new AH has been created */
315 void (*notify_new_ah)(struct ib_device *, struct ib_ah_attr *,
318 /* Let the driver pick the next queue pair number*/
319 int (*alloc_qpn)(struct rvt_dev_info *rdi, struct rvt_qpn_table *qpt,
320 enum ib_qp_type type, u8 port_num, gfp_t gfp);
322 /* Determine if its safe or allowed to modify the qp */
323 int (*check_modify_qp)(struct rvt_qp *qp, struct ib_qp_attr *attr,
324 int attr_mask, struct ib_udata *udata);
326 /* Driver specific QP modification/notification-of */
327 void (*modify_qp)(struct rvt_qp *qp, struct ib_qp_attr *attr,
328 int attr_mask, struct ib_udata *udata);
330 /* Driver specific work request checking */
331 int (*check_send_wqe)(struct rvt_qp *qp, struct rvt_swqe *wqe);
333 /* Notify driver a mad agent has been created */
334 void (*notify_create_mad_agent)(struct rvt_dev_info *rdi, int port_idx);
336 /* Notify driver a mad agent has been removed */
337 void (*notify_free_mad_agent)(struct rvt_dev_info *rdi, int port_idx);
341 struct rvt_dev_info {
342 struct ib_device ibdev; /* Keep this first. Nothing above here */
345 * Prior to calling for registration the driver will be responsible for
346 * allocating space for this structure.
348 * The driver will also be responsible for filling in certain members of
349 * dparms.props. The driver needs to fill in dparms exactly as it would
350 * want values reported to a ULP. This will be returned to the caller
351 * in rdmavt's device. The driver should also therefore refrain from
352 * modifying this directly after registration with rdmavt.
355 /* Driver specific properties */
356 struct rvt_driver_params dparms;
358 /* post send table */
359 const struct rvt_operation_params *post_parms;
361 struct rvt_mregion __rcu *dma_mr;
362 struct rvt_lkey_table lkey_table;
364 /* Driver specific helper functions */
365 struct rvt_driver_provided driver_f;
369 spinlock_t n_pds_lock; /* Protect pd allocated count */
372 spinlock_t n_ahs_lock; /* Protect ah allocated count */
374 u32 n_srqs_allocated;
375 spinlock_t n_srqs_lock; /* Protect srqs allocated count */
378 struct rvt_ibport **ports;
381 struct rvt_qp_ibdev *qp_dev;
382 u32 n_qps_allocated; /* number of QPs allocated for device */
383 u32 n_rc_qps; /* number of RC QPs allocated for device */
384 u32 busy_jiffies; /* timeout scaling based on RC QP count */
385 spinlock_t n_qps_lock; /* protect qps, rc qps and busy jiffy counts */
388 struct list_head pending_mmaps;
389 spinlock_t mmap_offset_lock; /* protect mmap_offset */
391 spinlock_t pending_lock; /* protect pending mmap list */
394 struct kthread_worker *worker; /* per device cq worker */
395 u32 n_cqs_allocated; /* number of CQs allocated for device */
396 spinlock_t n_cqs_lock; /* protect count of in use cqs */
399 u32 n_mcast_grps_allocated; /* number of mcast groups allocated */
400 spinlock_t n_mcast_grps_lock;
404 static inline struct rvt_pd *ibpd_to_rvtpd(struct ib_pd *ibpd)
406 return container_of(ibpd, struct rvt_pd, ibpd);
409 static inline struct rvt_ah *ibah_to_rvtah(struct ib_ah *ibah)
411 return container_of(ibah, struct rvt_ah, ibah);
414 static inline struct rvt_dev_info *ib_to_rvt(struct ib_device *ibdev)
416 return container_of(ibdev, struct rvt_dev_info, ibdev);
419 static inline struct rvt_srq *ibsrq_to_rvtsrq(struct ib_srq *ibsrq)
421 return container_of(ibsrq, struct rvt_srq, ibsrq);
424 static inline struct rvt_qp *ibqp_to_rvtqp(struct ib_qp *ibqp)
426 return container_of(ibqp, struct rvt_qp, ibqp);
429 static inline unsigned rvt_get_npkeys(struct rvt_dev_info *rdi)
432 * All ports have same number of pkeys.
434 return rdi->dparms.npkeys;
438 * Return the max atomic suitable for determining
439 * the size of the ack ring buffer in a QP.
441 static inline unsigned int rvt_max_atomic(struct rvt_dev_info *rdi)
443 return rdi->dparms.max_rdma_atomic + 1;
447 * Return the indexed PKEY from the port PKEY table.
449 static inline u16 rvt_get_pkey(struct rvt_dev_info *rdi,
453 if (index >= rvt_get_npkeys(rdi))
456 return rdi->ports[port_index]->pkey_table[index];
460 * rvt_lookup_qpn - return the QP with the given QPN
462 * @qpn: the QP number to look up
464 * The caller must hold the rcu_read_lock(), and keep the lock until
465 * the returned qp is no longer in use.
467 /* TODO: Remove this and put in rdmavt/qp.h when no longer needed by drivers */
468 static inline struct rvt_qp *rvt_lookup_qpn(struct rvt_dev_info *rdi,
469 struct rvt_ibport *rvp,
470 u32 qpn) __must_hold(RCU)
472 struct rvt_qp *qp = NULL;
474 if (unlikely(qpn <= 1)) {
475 qp = rcu_dereference(rvp->qp[qpn]);
477 u32 n = hash_32(qpn, rdi->qp_dev->qp_table_bits);
479 for (qp = rcu_dereference(rdi->qp_dev->qp_table[n]); qp;
480 qp = rcu_dereference(qp->next))
481 if (qp->ibqp.qp_num == qpn)
487 struct rvt_dev_info *rvt_alloc_device(size_t size, int nports);
488 void rvt_dealloc_device(struct rvt_dev_info *rdi);
489 int rvt_register_device(struct rvt_dev_info *rvd);
490 void rvt_unregister_device(struct rvt_dev_info *rvd);
491 int rvt_check_ah(struct ib_device *ibdev, struct ib_ah_attr *ah_attr);
492 int rvt_init_port(struct rvt_dev_info *rdi, struct rvt_ibport *port,
493 int port_index, u16 *pkey_table);
494 int rvt_fast_reg_mr(struct rvt_qp *qp, struct ib_mr *ibmr, u32 key,
496 int rvt_invalidate_rkey(struct rvt_qp *qp, u32 rkey);
497 int rvt_rkey_ok(struct rvt_qp *qp, struct rvt_sge *sge,
498 u32 len, u64 vaddr, u32 rkey, int acc);
499 int rvt_lkey_ok(struct rvt_lkey_table *rkt, struct rvt_pd *pd,
500 struct rvt_sge *isge, struct ib_sge *sge, int acc);
501 struct rvt_mcast *rvt_mcast_find(struct rvt_ibport *ibp, union ib_gid *mgid);
503 #endif /* DEF_RDMA_VT_H */