[deliverable/linux.git] / drivers / infiniband / core / uverbs.h

/*
 * Copyright (c) 2005 Topspin Communications.  All rights reserved.
 * Copyright (c) 2005 Cisco Systems.  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 device.h and fs.h until cdev.h is self-sufficient */
#include <linux/fs.h>
#include <linux/device.h>
#include <linux/cdev.h>
#include <linux/kref.h>
#include <linux/idr.h>

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

struct ib_uverbs_device {
	int					devnum;
	struct cdev				dev;
	struct class_device			class_dev;
	struct ib_device		       *ib_dev;
	int					num_comp;
};

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

struct ib_uverbs_file {
	struct kref				ref;
	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_file	        comp_file[1];
};

struct ib_uverbs_async_event {
	struct ib_uverbs_async_event_desc	desc;
	struct list_head			list;
};

struct ib_uverbs_comp_event {
	struct ib_uverbs_comp_event_desc	desc;
	struct list_head			list;
};

struct ib_uobject_mr {
	struct ib_uobject			uobj;
	struct page			       *page_list;
	struct scatterlist		       *sg_list;
};

extern struct semaphore ib_uverbs_idr_mutex;
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;

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);

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(query_params);
IB_UVERBS_DECLARE_CMD(get_context);
IB_UVERBS_DECLARE_CMD(query_device);
IB_UVERBS_DECLARE_CMD(query_port);
IB_UVERBS_DECLARE_CMD(query_gid);
IB_UVERBS_DECLARE_CMD(query_pkey);
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_cq);
IB_UVERBS_DECLARE_CMD(destroy_cq);
IB_UVERBS_DECLARE_CMD(create_qp);
IB_UVERBS_DECLARE_CMD(modify_qp);
IB_UVERBS_DECLARE_CMD(destroy_qp);
IB_UVERBS_DECLARE_CMD(attach_mcast);
IB_UVERBS_DECLARE_CMD(detach_mcast);

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