xref: /linux/drivers/infiniband/core/uverbs.h (revision 54a8a2220c936a47840c9a3d74910c5a56fae2ed)
1 /*
2  * Copyright (c) 2005 Topspin Communications.  All rights reserved.
3  * Copyright (c) 2005 Cisco Systems.  All rights reserved.
4  * Copyright (c) 2005 Mellanox Technologies. All rights reserved.
5  * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
6  *
7  * This software is available to you under a choice of one of two
8  * licenses.  You may choose to be licensed under the terms of the GNU
9  * General Public License (GPL) Version 2, available from the file
10  * COPYING in the main directory of this source tree, or the
11  * OpenIB.org BSD license below:
12  *
13  *     Redistribution and use in source and binary forms, with or
14  *     without modification, are permitted provided that the following
15  *     conditions are met:
16  *
17  *      - Redistributions of source code must retain the above
18  *        copyright notice, this list of conditions and the following
19  *        disclaimer.
20  *
21  *      - Redistributions in binary form must reproduce the above
22  *        copyright notice, this list of conditions and the following
23  *        disclaimer in the documentation and/or other materials
24  *        provided with the distribution.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
29  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
30  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
31  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
32  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33  * SOFTWARE.
34  *
35  * $Id: uverbs.h 2559 2005-06-06 19:43:16Z roland $
36  */
37 
38 #ifndef UVERBS_H
39 #define UVERBS_H
40 
41 /* Include device.h and fs.h until cdev.h is self-sufficient */
42 #include <linux/fs.h>
43 #include <linux/device.h>
44 #include <linux/cdev.h>
45 #include <linux/kref.h>
46 #include <linux/idr.h>
47 
48 #include <rdma/ib_verbs.h>
49 #include <rdma/ib_user_verbs.h>
50 
51 struct ib_uverbs_device {
52 	int					devnum;
53 	struct cdev				dev;
54 	struct class_device			class_dev;
55 	struct ib_device		       *ib_dev;
56 	int					num_comp;
57 };
58 
59 struct ib_uverbs_event_file {
60 	struct kref				ref;
61 	struct ib_uverbs_file		       *uverbs_file;
62 	spinlock_t				lock;
63 	int					fd;
64 	int					is_async;
65 	wait_queue_head_t			poll_wait;
66 	struct fasync_struct		       *async_queue;
67 	struct list_head			event_list;
68 };
69 
70 struct ib_uverbs_file {
71 	struct kref				ref;
72 	struct semaphore			mutex;
73 	struct ib_uverbs_device		       *device;
74 	struct ib_ucontext		       *ucontext;
75 	struct ib_event_handler			event_handler;
76 	struct ib_uverbs_event_file	        async_file;
77 	struct ib_uverbs_event_file	        comp_file[1];
78 };
79 
80 struct ib_uverbs_event {
81 	union {
82 		struct ib_uverbs_async_event_desc	async;
83 		struct ib_uverbs_comp_event_desc	comp;
84 	}					desc;
85 	struct list_head			list;
86 	struct list_head			obj_list;
87 	u32				       *counter;
88 };
89 
90 struct ib_uevent_object {
91 	struct ib_uobject	uobject;
92 	struct list_head	event_list;
93 	u32			events_reported;
94 };
95 
96 struct ib_ucq_object {
97 	struct ib_uobject	uobject;
98 	struct list_head	comp_list;
99 	struct list_head	async_list;
100 	u32			comp_events_reported;
101 	u32			async_events_reported;
102 };
103 
104 extern struct semaphore ib_uverbs_idr_mutex;
105 extern struct idr ib_uverbs_pd_idr;
106 extern struct idr ib_uverbs_mr_idr;
107 extern struct idr ib_uverbs_mw_idr;
108 extern struct idr ib_uverbs_ah_idr;
109 extern struct idr ib_uverbs_cq_idr;
110 extern struct idr ib_uverbs_qp_idr;
111 extern struct idr ib_uverbs_srq_idr;
112 
113 void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context);
114 void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr);
115 void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr);
116 void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr);
117 
118 int ib_umem_get(struct ib_device *dev, struct ib_umem *mem,
119 		void *addr, size_t size, int write);
120 void ib_umem_release(struct ib_device *dev, struct ib_umem *umem);
121 void ib_umem_release_on_close(struct ib_device *dev, struct ib_umem *umem);
122 
123 #define IB_UVERBS_DECLARE_CMD(name)					\
124 	ssize_t ib_uverbs_##name(struct ib_uverbs_file *file,		\
125 				 const char __user *buf, int in_len,	\
126 				 int out_len)
127 
128 IB_UVERBS_DECLARE_CMD(query_params);
129 IB_UVERBS_DECLARE_CMD(get_context);
130 IB_UVERBS_DECLARE_CMD(query_device);
131 IB_UVERBS_DECLARE_CMD(query_port);
132 IB_UVERBS_DECLARE_CMD(query_gid);
133 IB_UVERBS_DECLARE_CMD(query_pkey);
134 IB_UVERBS_DECLARE_CMD(alloc_pd);
135 IB_UVERBS_DECLARE_CMD(dealloc_pd);
136 IB_UVERBS_DECLARE_CMD(reg_mr);
137 IB_UVERBS_DECLARE_CMD(dereg_mr);
138 IB_UVERBS_DECLARE_CMD(create_cq);
139 IB_UVERBS_DECLARE_CMD(destroy_cq);
140 IB_UVERBS_DECLARE_CMD(create_qp);
141 IB_UVERBS_DECLARE_CMD(modify_qp);
142 IB_UVERBS_DECLARE_CMD(destroy_qp);
143 IB_UVERBS_DECLARE_CMD(attach_mcast);
144 IB_UVERBS_DECLARE_CMD(detach_mcast);
145 IB_UVERBS_DECLARE_CMD(create_srq);
146 IB_UVERBS_DECLARE_CMD(modify_srq);
147 IB_UVERBS_DECLARE_CMD(destroy_srq);
148 
149 #endif /* UVERBS_H */
150