2 * Copyright(c) 2016 Intel Corporation.
4 * This file is provided under a dual BSD/GPLv2 license. When using or
5 * redistributing this file, you may do so under either license.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
20 * Redistribution and use in source and binary forms, with or without
21 * modification, are permitted provided that the following conditions
24 * - Redistributions of source code must retain the above copyright
25 * notice, this list of conditions and the following disclaimer.
26 * - Redistributions in binary form must reproduce the above copyright
27 * notice, this list of conditions and the following disclaimer in
28 * the documentation and/or other materials provided with the
30 * - Neither the name of Intel Corporation nor the names of its
31 * contributors may be used to endorse or promote products derived
32 * from this software without specific prior written permission.
34 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
35 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
36 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
37 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
38 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
40 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
41 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
42 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
43 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
44 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48 #include <linux/module.h>
49 #include <linux/kernel.h>
53 #define RVT_UVERBS_ABI_VERSION 2
55 MODULE_LICENSE("Dual BSD/GPL");
56 MODULE_DESCRIPTION("RDMA Verbs Transport Library");
58 static int rvt_init(void)
61 * rdmavt does not need to do anything special when it starts up. All it
62 * needs to do is sit and wait until a driver attempts registration.
66 module_init(rvt_init);
68 static void rvt_cleanup(void)
71 * Nothing to do at exit time either. The module won't be able to be
72 * removed until all drivers are gone which means all the dev structs
73 * are gone so there is really nothing to do.
76 module_exit(rvt_cleanup);
79 * rvt_alloc_device - allocate rdi
80 * @size: how big of a structure to allocate
81 * @nports: number of ports to allocate array slots for
83 * Use IB core device alloc to allocate space for the rdi which is assumed to be
84 * inside of the ib_device. Any extra space that drivers require should be
87 * We also allocate a port array based on the number of ports.
89 * Return: pointer to allocated rdi
91 struct rvt_dev_info *rvt_alloc_device(size_t size, int nports)
93 struct rvt_dev_info *rdi = ERR_PTR(-ENOMEM);
95 rdi = (struct rvt_dev_info *)ib_alloc_device(size);
99 rdi->ports = kcalloc(nports, sizeof(*rdi->ports), GFP_KERNEL);
101 ib_dealloc_device(&rdi->ibdev);
105 EXPORT_SYMBOL(rvt_alloc_device);
108 * rvt_dealloc_device - deallocate rdi
109 * @rdi: structure to free
111 * Free a structure allocated with rvt_alloc_device()
113 void rvt_dealloc_device(struct rvt_dev_info *rdi)
116 ib_dealloc_device(&rdi->ibdev);
118 EXPORT_SYMBOL(rvt_dealloc_device);
120 static int rvt_query_device(struct ib_device *ibdev,
121 struct ib_device_attr *props,
122 struct ib_udata *uhw)
124 struct rvt_dev_info *rdi = ib_to_rvt(ibdev);
126 if (uhw->inlen || uhw->outlen)
129 * Return rvt_dev_info.dparms.props contents
131 *props = rdi->dparms.props;
135 static int rvt_modify_device(struct ib_device *device,
136 int device_modify_mask,
137 struct ib_device_modify *device_modify)
140 * There is currently no need to supply this based on qib and hfi1.
141 * Future drivers may need to implement this though.
148 * rvt_query_port: Passes the query port call to the driver
149 * @ibdev: Verbs IB dev
150 * @port_num: port number, 1 based from ib core
151 * @props: structure to hold returned properties
153 * Return: 0 on success
155 static int rvt_query_port(struct ib_device *ibdev, u8 port_num,
156 struct ib_port_attr *props)
158 struct rvt_dev_info *rdi = ib_to_rvt(ibdev);
159 struct rvt_ibport *rvp;
160 int port_index = ibport_num_to_idx(ibdev, port_num);
165 rvp = rdi->ports[port_index];
166 memset(props, 0, sizeof(*props));
167 props->sm_lid = rvp->sm_lid;
168 props->sm_sl = rvp->sm_sl;
169 props->port_cap_flags = rvp->port_cap_flags;
170 props->max_msg_sz = 0x80000000;
171 props->pkey_tbl_len = rvt_get_npkeys(rdi);
172 props->bad_pkey_cntr = rvp->pkey_violations;
173 props->qkey_viol_cntr = rvp->qkey_violations;
174 props->subnet_timeout = rvp->subnet_timeout;
175 props->init_type_reply = 0;
177 /* Populate the remaining ib_port_attr elements */
178 return rdi->driver_f.query_port_state(rdi, port_num, props);
183 * @ibdev: Verbs IB dev
184 * @port_num: Port number, 1 based from ib core
185 * @port_modify_mask: How to change the port
186 * @props: Structure to fill in
188 * Return: 0 on success
190 static int rvt_modify_port(struct ib_device *ibdev, u8 port_num,
191 int port_modify_mask, struct ib_port_modify *props)
193 struct rvt_dev_info *rdi = ib_to_rvt(ibdev);
194 struct rvt_ibport *rvp;
196 int port_index = ibport_num_to_idx(ibdev, port_num);
201 rvp = rdi->ports[port_index];
202 rvp->port_cap_flags |= props->set_port_cap_mask;
203 rvp->port_cap_flags &= ~props->clr_port_cap_mask;
205 if (props->set_port_cap_mask || props->clr_port_cap_mask)
206 rdi->driver_f.cap_mask_chg(rdi, port_num);
207 if (port_modify_mask & IB_PORT_SHUTDOWN)
208 ret = rdi->driver_f.shut_down_port(rdi, port_num);
209 if (port_modify_mask & IB_PORT_RESET_QKEY_CNTR)
210 rvp->qkey_violations = 0;
216 * rvt_query_pkey - Return a pkey from the table at a given index
217 * @ibdev: Verbs IB dev
218 * @port_num: Port number, 1 based from ib core
219 * @intex: Index into pkey table
221 * Return: 0 on failure pkey otherwise
223 static int rvt_query_pkey(struct ib_device *ibdev, u8 port_num, u16 index,
227 * Driver will be responsible for keeping rvt_dev_info.pkey_table up to
228 * date. This function will just return that value. There is no need to
229 * lock, if a stale value is read and sent to the user so be it there is
230 * no way to protect against that anyway.
232 struct rvt_dev_info *rdi = ib_to_rvt(ibdev);
235 port_index = ibport_num_to_idx(ibdev, port_num);
239 if (index >= rvt_get_npkeys(rdi))
242 *pkey = rvt_get_pkey(rdi, port_index, index);
247 * rvt_query_gid - Return a gid from the table
248 * @ibdev: Verbs IB dev
249 * @port_num: Port number, 1 based from ib core
250 * @index: = Index in table
251 * @gid: Gid to return
253 * Return: 0 on success
255 static int rvt_query_gid(struct ib_device *ibdev, u8 port_num,
256 int guid_index, union ib_gid *gid)
258 struct rvt_dev_info *rdi;
259 struct rvt_ibport *rvp;
263 * Driver is responsible for updating the guid table. Which will be used
264 * to craft the return value. This will work similar to how query_pkey()
267 port_index = ibport_num_to_idx(ibdev, port_num);
271 rdi = ib_to_rvt(ibdev);
272 rvp = rdi->ports[port_index];
274 gid->global.subnet_prefix = rvp->gid_prefix;
276 return rdi->driver_f.get_guid_be(rdi, rvp, guid_index,
277 &gid->global.interface_id);
280 struct rvt_ucontext {
281 struct ib_ucontext ibucontext;
284 static inline struct rvt_ucontext *to_iucontext(struct ib_ucontext
287 return container_of(ibucontext, struct rvt_ucontext, ibucontext);
291 * rvt_alloc_ucontext - Allocate a user context
292 * @ibdev: Vers IB dev
293 * @data: User data allocated
295 static struct ib_ucontext *rvt_alloc_ucontext(struct ib_device *ibdev,
296 struct ib_udata *udata)
298 struct rvt_ucontext *context;
300 context = kmalloc(sizeof(*context), GFP_KERNEL);
302 return ERR_PTR(-ENOMEM);
303 return &context->ibucontext;
307 *rvt_dealloc_ucontext - Free a user context
308 *@context - Free this
310 static int rvt_dealloc_ucontext(struct ib_ucontext *context)
312 kfree(to_iucontext(context));
316 static int rvt_get_port_immutable(struct ib_device *ibdev, u8 port_num,
317 struct ib_port_immutable *immutable)
319 struct rvt_dev_info *rdi = ib_to_rvt(ibdev);
320 struct ib_port_attr attr;
323 port_index = ibport_num_to_idx(ibdev, port_num);
327 err = rvt_query_port(ibdev, port_num, &attr);
331 immutable->pkey_tbl_len = attr.pkey_tbl_len;
332 immutable->gid_tbl_len = attr.gid_tbl_len;
333 immutable->core_cap_flags = rdi->dparms.core_cap_flags;
334 immutable->max_mad_size = rdi->dparms.max_mad_size;
384 _VERB_IDX_MAX /* Must always be last! */
387 static inline int check_driver_override(struct rvt_dev_info *rdi,
388 size_t offset, void *func)
390 if (!*(void **)((void *)&rdi->ibdev + offset)) {
391 *(void **)((void *)&rdi->ibdev + offset) = func;
398 static noinline int check_support(struct rvt_dev_info *rdi, int verb)
403 * These functions are not part of verbs specifically but are
404 * required for rdmavt to function.
406 if ((!rdi->driver_f.port_callback) ||
407 (!rdi->driver_f.get_card_name) ||
408 (!rdi->driver_f.get_pci_dev))
413 check_driver_override(rdi, offsetof(struct ib_device,
420 * rdmavt does not support modify device currently drivers must
423 if (!check_driver_override(rdi, offsetof(struct ib_device,
430 if (!check_driver_override(rdi, offsetof(struct ib_device,
433 if (!rdi->driver_f.query_port_state)
438 if (!check_driver_override(rdi, offsetof(struct ib_device,
441 if (!rdi->driver_f.cap_mask_chg ||
442 !rdi->driver_f.shut_down_port)
447 check_driver_override(rdi, offsetof(struct ib_device,
453 if (!check_driver_override(rdi, offsetof(struct ib_device,
456 if (!rdi->driver_f.get_guid_be)
461 check_driver_override(rdi, offsetof(struct ib_device,
466 case DEALLOC_UCONTEXT:
467 check_driver_override(rdi, offsetof(struct ib_device,
469 rvt_dealloc_ucontext);
472 case GET_PORT_IMMUTABLE:
473 check_driver_override(rdi, offsetof(struct ib_device,
475 rvt_get_port_immutable);
479 if (!check_driver_override(rdi, offsetof(struct ib_device,
482 if (!rdi->driver_f.qp_priv_alloc ||
483 !rdi->driver_f.qp_priv_free ||
484 !rdi->driver_f.notify_qp_reset ||
485 !rdi->driver_f.flush_qp_waiters ||
486 !rdi->driver_f.stop_send_queue ||
487 !rdi->driver_f.quiesce_qp)
492 if (!check_driver_override(rdi, offsetof(struct ib_device,
495 if (!rdi->driver_f.notify_qp_reset ||
496 !rdi->driver_f.schedule_send ||
497 !rdi->driver_f.get_pmtu_from_attr ||
498 !rdi->driver_f.flush_qp_waiters ||
499 !rdi->driver_f.stop_send_queue ||
500 !rdi->driver_f.quiesce_qp ||
501 !rdi->driver_f.notify_error_qp ||
502 !rdi->driver_f.mtu_from_qp ||
503 !rdi->driver_f.mtu_to_path_mtu)
508 if (!check_driver_override(rdi, offsetof(struct ib_device,
511 if (!rdi->driver_f.qp_priv_free ||
512 !rdi->driver_f.notify_qp_reset ||
513 !rdi->driver_f.flush_qp_waiters ||
514 !rdi->driver_f.stop_send_queue ||
515 !rdi->driver_f.quiesce_qp)
520 check_driver_override(rdi, offsetof(struct ib_device,
526 if (!check_driver_override(rdi, offsetof(struct ib_device,
529 if (!rdi->driver_f.schedule_send ||
530 !rdi->driver_f.do_send ||
536 check_driver_override(rdi, offsetof(struct ib_device,
541 check_driver_override(rdi, offsetof(struct ib_device,
547 check_driver_override(rdi, offsetof(struct ib_device,
553 check_driver_override(rdi, offsetof(struct ib_device,
559 check_driver_override(rdi, offsetof(struct ib_device,
565 check_driver_override(rdi, offsetof(struct ib_device,
571 check_driver_override(rdi, offsetof(struct ib_device,
577 check_driver_override(rdi, offsetof(struct ib_device,
583 check_driver_override(rdi, offsetof(struct ib_device,
589 check_driver_override(rdi, offsetof(struct ib_device,
595 check_driver_override(rdi, offsetof(struct ib_device,
601 check_driver_override(rdi, offsetof(struct ib_device,
607 check_driver_override(rdi, offsetof(struct ib_device,
613 check_driver_override(rdi, offsetof(struct ib_device,
619 check_driver_override(rdi, offsetof(struct ib_device,
625 check_driver_override(rdi, offsetof(struct ib_device,
631 check_driver_override(rdi, offsetof(struct ib_device,
637 check_driver_override(rdi, offsetof(struct ib_device,
643 check_driver_override(rdi, offsetof(struct ib_device,
649 check_driver_override(rdi, offsetof(struct ib_device,
655 check_driver_override(rdi, offsetof(struct ib_device,
661 check_driver_override(rdi, offsetof(struct ib_device,
667 check_driver_override(rdi, offsetof(struct ib_device,
673 check_driver_override(rdi, offsetof(struct ib_device,
679 check_driver_override(rdi, offsetof(struct ib_device,
685 check_driver_override(rdi, offsetof(struct ib_device,
691 check_driver_override(rdi, offsetof(struct ib_device,
697 check_driver_override(rdi, offsetof(struct ib_device,
703 check_driver_override(rdi, offsetof(struct ib_device,
716 * rvt_register_device - register a driver
717 * @rdi: main dev structure for all of rdmavt operations
719 * It is up to drivers to allocate the rdi and fill in the appropriate
722 * Return: 0 on success otherwise an errno.
724 int rvt_register_device(struct rvt_dev_info *rdi)
732 * Check to ensure drivers have setup the required helpers for the verbs
733 * they want rdmavt to handle
735 for (i = 0; i < _VERB_IDX_MAX; i++)
736 if (check_support(rdi, i)) {
737 pr_err("Driver support req not met at %d\n", i);
742 /* Once we get past here we can use rvt_pr macros and tracepoints */
743 trace_rvt_dbg(rdi, "Driver attempting registration");
747 ret = rvt_driver_qp_init(rdi);
749 pr_err("Error in driver QP init.\n");
754 spin_lock_init(&rdi->n_ahs_lock);
755 rdi->n_ahs_allocated = 0;
757 /* Shared Receive Queue */
758 rvt_driver_srq_init(rdi);
761 rvt_driver_mcast_init(rdi);
764 ret = rvt_driver_mr_init(rdi);
766 pr_err("Error in driver MR init.\n");
770 /* Completion queues */
771 ret = rvt_driver_cq_init(rdi);
773 pr_err("Error in driver CQ init.\n");
779 rdi->ibdev.dma_ops ? : &rvt_default_dma_mapping_ops;
781 /* Protection Domain */
782 spin_lock_init(&rdi->n_pds_lock);
783 rdi->n_pds_allocated = 0;
786 * There are some things which could be set by underlying drivers but
787 * really should be up to rdmavt to set. For instance drivers can't know
788 * exactly which functions rdmavt supports, nor do they know the ABI
789 * version, so we do all of this sort of stuff here.
791 rdi->ibdev.uverbs_abi_ver = RVT_UVERBS_ABI_VERSION;
792 rdi->ibdev.uverbs_cmd_mask =
793 (1ull << IB_USER_VERBS_CMD_GET_CONTEXT) |
794 (1ull << IB_USER_VERBS_CMD_QUERY_DEVICE) |
795 (1ull << IB_USER_VERBS_CMD_QUERY_PORT) |
796 (1ull << IB_USER_VERBS_CMD_ALLOC_PD) |
797 (1ull << IB_USER_VERBS_CMD_DEALLOC_PD) |
798 (1ull << IB_USER_VERBS_CMD_CREATE_AH) |
799 (1ull << IB_USER_VERBS_CMD_MODIFY_AH) |
800 (1ull << IB_USER_VERBS_CMD_QUERY_AH) |
801 (1ull << IB_USER_VERBS_CMD_DESTROY_AH) |
802 (1ull << IB_USER_VERBS_CMD_REG_MR) |
803 (1ull << IB_USER_VERBS_CMD_DEREG_MR) |
804 (1ull << IB_USER_VERBS_CMD_CREATE_COMP_CHANNEL) |
805 (1ull << IB_USER_VERBS_CMD_CREATE_CQ) |
806 (1ull << IB_USER_VERBS_CMD_RESIZE_CQ) |
807 (1ull << IB_USER_VERBS_CMD_DESTROY_CQ) |
808 (1ull << IB_USER_VERBS_CMD_POLL_CQ) |
809 (1ull << IB_USER_VERBS_CMD_REQ_NOTIFY_CQ) |
810 (1ull << IB_USER_VERBS_CMD_CREATE_QP) |
811 (1ull << IB_USER_VERBS_CMD_QUERY_QP) |
812 (1ull << IB_USER_VERBS_CMD_MODIFY_QP) |
813 (1ull << IB_USER_VERBS_CMD_DESTROY_QP) |
814 (1ull << IB_USER_VERBS_CMD_POST_SEND) |
815 (1ull << IB_USER_VERBS_CMD_POST_RECV) |
816 (1ull << IB_USER_VERBS_CMD_ATTACH_MCAST) |
817 (1ull << IB_USER_VERBS_CMD_DETACH_MCAST) |
818 (1ull << IB_USER_VERBS_CMD_CREATE_SRQ) |
819 (1ull << IB_USER_VERBS_CMD_MODIFY_SRQ) |
820 (1ull << IB_USER_VERBS_CMD_QUERY_SRQ) |
821 (1ull << IB_USER_VERBS_CMD_DESTROY_SRQ) |
822 (1ull << IB_USER_VERBS_CMD_POST_SRQ_RECV);
823 rdi->ibdev.node_type = RDMA_NODE_IB_CA;
824 rdi->ibdev.num_comp_vectors = 1;
826 /* We are now good to announce we exist */
827 ret = ib_register_device(&rdi->ibdev, rdi->driver_f.port_callback);
829 rvt_pr_err(rdi, "Failed to register driver with ib core.\n");
833 rvt_create_mad_agents(rdi);
835 rvt_pr_info(rdi, "Registration with rdmavt done.\n");
849 EXPORT_SYMBOL(rvt_register_device);
852 * rvt_unregister_device - remove a driver
853 * @rdi: rvt dev struct
855 void rvt_unregister_device(struct rvt_dev_info *rdi)
857 trace_rvt_dbg(rdi, "Driver is unregistering.");
861 rvt_free_mad_agents(rdi);
863 ib_unregister_device(&rdi->ibdev);
868 EXPORT_SYMBOL(rvt_unregister_device);
871 * rvt_init_port - init internal data for driver port
872 * @rdi: rvt dev strut
874 * @port_index: 0 based index of ports, different from IB core port num
876 * Keep track of a list of ports. No need to have a detach port.
877 * They persist until the driver goes away.
881 int rvt_init_port(struct rvt_dev_info *rdi, struct rvt_ibport *port,
882 int port_index, u16 *pkey_table)
885 rdi->ports[port_index] = port;
886 rdi->ports[port_index]->pkey_table = pkey_table;
890 EXPORT_SYMBOL(rvt_init_port);