[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / infiniband / core / uverbs.h

/*
 * Copyright (c) 2005 Topspin Communications.  All rights reserved.
 * Copyright (c) 2005, 2006 Cisco Systems.  All rights reserved.
 * Copyright (c) 2005 Mellanox Technologies. All rights reserved.
 * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
 * Copyright (c) 2005 PathScale, Inc. All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * $Id: uverbs.h 2559 2005-06-06 19:43:16Z roland $
 */

#ifndef UVERBS_H
#define UVERBS_H

#include <linux/kref.h>
#include <linux/idr.h>
#include <linux/mutex.h>

#include <rdma/ib_verbs.h>
#include <rdma/ib_user_verbs.h>

/*
 * Our lifetime rules for these structs are the following:
 *
 * struct ib_uverbs_device: One reference is held by the module and
 * released in ib_uverbs_remove_one().  Another reference is taken by
 * ib_uverbs_open() each time the character special file is opened,
 * and released in ib_uverbs_release_file() when the file is released.
 *
 * struct ib_uverbs_file: One reference is held by the VFS and
 * released when the file is closed.  Another reference is taken when
 * an asynchronous event queue file is created and released when the
 * event file is closed.
 *
 * struct ib_uverbs_event_file: One reference is held by the VFS and
 * released when the file is closed.  For asynchronous event files,
 * another reference is held by the corresponding main context file
 * and released when that file is closed.  For completion event files,
 * a reference is taken when a CQ is created that uses the file, and
 * released when the CQ is destroyed.
 */

struct ib_uverbs_device {
	struct kref				ref;
	int					devnum;
	struct cdev			       *dev;
	struct class_device		       *class_dev;
	struct ib_device		       *ib_dev;
	int					num_comp_vectors;
};

struct ib_uverbs_event_file {
	struct kref				ref;
	struct file			       *file;
	struct ib_uverbs_file		       *uverbs_file;
	spinlock_t				lock;
	int					is_async;
	wait_queue_head_t			poll_wait;
	struct fasync_struct		       *async_queue;
	struct list_head			event_list;
};

struct ib_uverbs_file {
	struct kref				ref;
	struct mutex				mutex;
	struct ib_uverbs_device		       *device;
	struct ib_ucontext		       *ucontext;
	struct ib_event_handler			event_handler;
	struct ib_uverbs_event_file	       *async_file;
};

struct ib_uverbs_event {
	union {
		struct ib_uverbs_async_event_desc	async;
		struct ib_uverbs_comp_event_desc	comp;
	}					desc;
	struct list_head			list;
	struct list_head			obj_list;
	u32				       *counter;
};

struct ib_uverbs_mcast_entry {
	struct list_head	list;
	union ib_gid 		gid;
	u16 			lid;
};

struct ib_uevent_object {
	struct ib_uobject	uobject;
	struct list_head	event_list;
	u32			events_reported;
};

struct ib_uqp_object {
	struct ib_uevent_object	uevent;
	struct list_head 	mcast_list;
};

struct ib_ucq_object {
	struct ib_uobject	uobject;
	struct ib_uverbs_file  *uverbs_file;
	struct list_head	comp_list;
	struct list_head	async_list;
	u32			comp_events_reported;
	u32			async_events_reported;
};

extern spinlock_t ib_uverbs_idr_lock;
extern struct idr ib_uverbs_pd_idr;
extern struct idr ib_uverbs_mr_idr;
extern struct idr ib_uverbs_mw_idr;
extern struct idr ib_uverbs_ah_idr;
extern struct idr ib_uverbs_cq_idr;
extern struct idr ib_uverbs_qp_idr;
extern struct idr ib_uverbs_srq_idr;

void idr_remove_uobj(struct idr *idp, struct ib_uobject *uobj);

struct file *ib_uverbs_alloc_event_file(struct ib_uverbs_file *uverbs_file,
					int is_async, int *fd);
void ib_uverbs_release_event_file(struct kref *ref);
struct ib_uverbs_event_file *ib_uverbs_lookup_comp_file(int fd);

void ib_uverbs_release_ucq(struct ib_uverbs_file *file,
			   struct ib_uverbs_event_file *ev_file,
			   struct ib_ucq_object *uobj);
void ib_uverbs_release_uevent(struct ib_uverbs_file *file,
			      struct ib_uevent_object *uobj);

void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context);
void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr);
void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr);
void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr);
void ib_uverbs_event_handler(struct ib_event_handler *handler,
			     struct ib_event *event);

int ib_umem_get(struct ib_device *dev, struct ib_umem *mem,
		void *addr, size_t size, int write);
void ib_umem_release(struct ib_device *dev, struct ib_umem *umem);
void ib_umem_release_on_close(struct ib_device *dev, struct ib_umem *umem);

#define IB_UVERBS_DECLARE_CMD(name)					\
	ssize_t ib_uverbs_##name(struct ib_uverbs_file *file,		\
				 const char __user *buf, int in_len,	\
				 int out_len)

IB_UVERBS_DECLARE_CMD(get_context);
IB_UVERBS_DECLARE_CMD(query_device);
IB_UVERBS_DECLARE_CMD(query_port);
IB_UVERBS_DECLARE_CMD(alloc_pd);
IB_UVERBS_DECLARE_CMD(dealloc_pd);
IB_UVERBS_DECLARE_CMD(reg_mr);
IB_UVERBS_DECLARE_CMD(dereg_mr);
IB_UVERBS_DECLARE_CMD(create_comp_channel);
IB_UVERBS_DECLARE_CMD(create_cq);
IB_UVERBS_DECLARE_CMD(resize_cq);
IB_UVERBS_DECLARE_CMD(poll_cq);
IB_UVERBS_DECLARE_CMD(req_notify_cq);
IB_UVERBS_DECLARE_CMD(destroy_cq);
IB_UVERBS_DECLARE_CMD(create_qp);
IB_UVERBS_DECLARE_CMD(query_qp);
IB_UVERBS_DECLARE_CMD(modify_qp);
IB_UVERBS_DECLARE_CMD(destroy_qp);
IB_UVERBS_DECLARE_CMD(post_send);
IB_UVERBS_DECLARE_CMD(post_recv);
IB_UVERBS_DECLARE_CMD(post_srq_recv);
IB_UVERBS_DECLARE_CMD(create_ah);
IB_UVERBS_DECLARE_CMD(destroy_ah);
IB_UVERBS_DECLARE_CMD(attach_mcast);
IB_UVERBS_DECLARE_CMD(detach_mcast);
IB_UVERBS_DECLARE_CMD(create_srq);
IB_UVERBS_DECLARE_CMD(modify_srq);
IB_UVERBS_DECLARE_CMD(query_srq);
IB_UVERBS_DECLARE_CMD(destroy_srq);

#endif /* UVERBS_H */
Commit	Line	Data
bc38a6ab RD	1	/*
bc38a6ab RD	2	* Copyright (c) 2005 Topspin Communications. All rights reserved.
33b9b3ee	3	* Copyright (c) 2005, 2006 Cisco Systems. All rights reserved.
2a1d9b7f RD	4	* Copyright (c) 2005 Mellanox Technologies. All rights reserved.
2a1d9b7f RD	5	* Copyright (c) 2005 Voltaire, Inc. All rights reserved.
67cdb40c	6	* Copyright (c) 2005 PathScale, Inc. All rights reserved.
bc38a6ab RD	7	*
	8	* This software is available to you under a choice of one of two
	9	* licenses. You may choose to be licensed under the terms of the GNU
	10	* General Public License (GPL) Version 2, available from the file
	11	* COPYING in the main directory of this source tree, or the
	12	* OpenIB.org BSD license below:
	13	*
	14	* Redistribution and use in source and binary forms, with or
	15	* without modification, are permitted provided that the following
	16	* conditions are met:
	17	*
	18	* - Redistributions of source code must retain the above
	19	* copyright notice, this list of conditions and the following
	20	* disclaimer.
	21	*
	22	* - Redistributions in binary form must reproduce the above
	23	* copyright notice, this list of conditions and the following
	24	* disclaimer in the documentation and/or other materials
	25	* provided with the distribution.
	26	*
	27	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	28	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	29	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	30	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	31	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	32	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	33	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	34	* SOFTWARE.
	35	*
	36	* $Id: uverbs.h 2559 2005-06-06 19:43:16Z roland $
	37	*/
	38
	39	#ifndef UVERBS_H
	40	#define UVERBS_H
	41
bc38a6ab RD	42	#include <linux/kref.h>
bc38a6ab RD	43	#include <linux/idr.h>
95ed644f	44	#include <linux/mutex.h>
bc38a6ab	45
a4d61e84 RD	46	#include <rdma/ib_verbs.h>
a4d61e84 RD	47	#include <rdma/ib_user_verbs.h>
bc38a6ab	48
70a30e16 RD	49	/*
	50	* Our lifetime rules for these structs are the following:
	51	*
	52	* struct ib_uverbs_device: One reference is held by the module and
	53	* released in ib_uverbs_remove_one(). Another reference is taken by
	54	* ib_uverbs_open() each time the character special file is opened,
	55	* and released in ib_uverbs_release_file() when the file is released.
	56	*
	57	* struct ib_uverbs_file: One reference is held by the VFS and
	58	* released when the file is closed. Another reference is taken when
	59	* an asynchronous event queue file is created and released when the
	60	* event file is closed.
	61	*
	62	* struct ib_uverbs_event_file: One reference is held by the VFS and
	63	* released when the file is closed. For asynchronous event files,
	64	* another reference is held by the corresponding main context file
	65	* and released when that file is closed. For completion event files,
	66	* a reference is taken when a CQ is created that uses the file, and
	67	* released when the CQ is destroyed.
	68	*/
	69
bc38a6ab	70	struct ib_uverbs_device {
70a30e16	71	struct kref ref;
bc38a6ab	72	int devnum;
70a30e16 RD	73	struct cdev *dev;
70a30e16 RD	74	struct class_device *class_dev;
bc38a6ab	75	struct ib_device *ib_dev;
6b73597e	76	int num_comp_vectors;
bc38a6ab RD	77	};
	78
	79	struct ib_uverbs_event_file {
	80	struct kref ref;
6b73597e	81	struct file *file;
bc38a6ab RD	82	struct ib_uverbs_file *uverbs_file;
bc38a6ab RD	83	spinlock_t lock;
bc38a6ab RD	84	int is_async;
bc38a6ab RD	85	wait_queue_head_t poll_wait;
abdf119b	86	struct fasync_struct *async_queue;
bc38a6ab RD	87	struct list_head event_list;
	88	};
	89
	90	struct ib_uverbs_file {
	91	struct kref ref;
95ed644f	92	struct mutex mutex;
bc38a6ab RD	93	struct ib_uverbs_device *device;
	94	struct ib_ucontext *ucontext;
	95	struct ib_event_handler event_handler;
6b73597e	96	struct ib_uverbs_event_file *async_file;
bc38a6ab RD	97	};
bc38a6ab RD	98
63aaf647 RD	99	struct ib_uverbs_event {
	100	union {
	101	struct ib_uverbs_async_event_desc async;
	102	struct ib_uverbs_comp_event_desc comp;
	103	} desc;
bc38a6ab	104	struct list_head list;
63aaf647 RD	105	struct list_head obj_list;
63aaf647 RD	106	u32 *counter;
bc38a6ab RD	107	};
bc38a6ab RD	108
f4e40156 JM	109	struct ib_uverbs_mcast_entry {
	110	struct list_head list;
	111	union ib_gid gid;
	112	u16 lid;
	113	};
	114
63aaf647 RD	115	struct ib_uevent_object {
	116	struct ib_uobject uobject;
	117	struct list_head event_list;
	118	u32 events_reported;
bc38a6ab RD	119	};
bc38a6ab RD	120
f4e40156 JM	121	struct ib_uqp_object {
	122	struct ib_uevent_object uevent;
	123	struct list_head mcast_list;
	124	};
	125
63aaf647 RD	126	struct ib_ucq_object {
63aaf647 RD	127	struct ib_uobject uobject;
7162a3e0	128	struct ib_uverbs_file *uverbs_file;
63aaf647 RD	129	struct list_head comp_list;
	130	struct list_head async_list;
	131	u32 comp_events_reported;
	132	u32 async_events_reported;
bc38a6ab RD	133	};
bc38a6ab RD	134
9ead190b	135	extern spinlock_t ib_uverbs_idr_lock;
bc38a6ab RD	136	extern struct idr ib_uverbs_pd_idr;
	137	extern struct idr ib_uverbs_mr_idr;
	138	extern struct idr ib_uverbs_mw_idr;
	139	extern struct idr ib_uverbs_ah_idr;
	140	extern struct idr ib_uverbs_cq_idr;
	141	extern struct idr ib_uverbs_qp_idr;
f520ba5a	142	extern struct idr ib_uverbs_srq_idr;
bc38a6ab	143
9ead190b RD	144	void idr_remove_uobj(struct idr idp, struct ib_uobject uobj);
9ead190b RD	145
6b73597e RD	146	struct file ib_uverbs_alloc_event_file(struct ib_uverbs_file uverbs_file,
	147	int is_async, int *fd);
	148	void ib_uverbs_release_event_file(struct kref *ref);
	149	struct ib_uverbs_event_file *ib_uverbs_lookup_comp_file(int fd);
	150
70a30e16 RD	151	void ib_uverbs_release_ucq(struct ib_uverbs_file *file,
	152	struct ib_uverbs_event_file *ev_file,
	153	struct ib_ucq_object *uobj);
	154	void ib_uverbs_release_uevent(struct ib_uverbs_file *file,
	155	struct ib_uevent_object *uobj);
	156
bc38a6ab RD	157	void ib_uverbs_comp_handler(struct ib_cq cq, void cq_context);
	158	void ib_uverbs_cq_event_handler(struct ib_event event, void context_ptr);
	159	void ib_uverbs_qp_event_handler(struct ib_event event, void context_ptr);
f520ba5a	160	void ib_uverbs_srq_event_handler(struct ib_event event, void context_ptr);
6b73597e RD	161	void ib_uverbs_event_handler(struct ib_event_handler *handler,
6b73597e RD	162	struct ib_event *event);
bc38a6ab RD	163
	164	int ib_umem_get(struct ib_device dev, struct ib_umem mem,
	165	void *addr, size_t size, int write);
	166	void ib_umem_release(struct ib_device dev, struct ib_umem umem);
	167	void ib_umem_release_on_close(struct ib_device dev, struct ib_umem umem);
	168
	169	#define IB_UVERBS_DECLARE_CMD(name) \
	170	ssize_t ib_uverbs_##name(struct ib_uverbs_file *file, \
	171	const char __user *buf, int in_len, \
	172	int out_len)
	173
bc38a6ab RD	174	IB_UVERBS_DECLARE_CMD(get_context);
	175	IB_UVERBS_DECLARE_CMD(query_device);
	176	IB_UVERBS_DECLARE_CMD(query_port);
bc38a6ab RD	177	IB_UVERBS_DECLARE_CMD(alloc_pd);
	178	IB_UVERBS_DECLARE_CMD(dealloc_pd);
	179	IB_UVERBS_DECLARE_CMD(reg_mr);
	180	IB_UVERBS_DECLARE_CMD(dereg_mr);
6b73597e	181	IB_UVERBS_DECLARE_CMD(create_comp_channel);
bc38a6ab	182	IB_UVERBS_DECLARE_CMD(create_cq);
33b9b3ee	183	IB_UVERBS_DECLARE_CMD(resize_cq);
67cdb40c RD	184	IB_UVERBS_DECLARE_CMD(poll_cq);
67cdb40c RD	185	IB_UVERBS_DECLARE_CMD(req_notify_cq);
bc38a6ab RD	186	IB_UVERBS_DECLARE_CMD(destroy_cq);
bc38a6ab RD	187	IB_UVERBS_DECLARE_CMD(create_qp);
7ccc9a24	188	IB_UVERBS_DECLARE_CMD(query_qp);
bc38a6ab RD	189	IB_UVERBS_DECLARE_CMD(modify_qp);
bc38a6ab RD	190	IB_UVERBS_DECLARE_CMD(destroy_qp);
67cdb40c RD	191	IB_UVERBS_DECLARE_CMD(post_send);
	192	IB_UVERBS_DECLARE_CMD(post_recv);
	193	IB_UVERBS_DECLARE_CMD(post_srq_recv);
	194	IB_UVERBS_DECLARE_CMD(create_ah);
	195	IB_UVERBS_DECLARE_CMD(destroy_ah);
bc38a6ab RD	196	IB_UVERBS_DECLARE_CMD(attach_mcast);
bc38a6ab RD	197	IB_UVERBS_DECLARE_CMD(detach_mcast);
f520ba5a RD	198	IB_UVERBS_DECLARE_CMD(create_srq);
f520ba5a RD	199	IB_UVERBS_DECLARE_CMD(modify_srq);
8bdb0e86	200	IB_UVERBS_DECLARE_CMD(query_srq);
f520ba5a	201	IB_UVERBS_DECLARE_CMD(destroy_srq);
bc38a6ab RD	202
bc38a6ab RD	203	#endif /* UVERBS_H */