[mirror_ubuntu-bionic-kernel.git] / include / uapi / rdma / nes-abi.h

/*
 * Copyright (c) 2006 - 2011 Intel Corporation.  All rights reserved.
 * Copyright (c) 2005 Topspin Communications.  All rights reserved.
 * Copyright (c) 2005 Cisco Systems.  All rights reserved.
 * Copyright (c) 2005 Open Grid Computing, 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.
 *
 */

#ifndef NES_ABI_USER_H
#define NES_ABI_USER_H

#include <linux/types.h>

#define NES_ABI_USERSPACE_VER 2
#define NES_ABI_KERNEL_VER    2

/*
 * Make sure that all structs defined in this file remain laid out so
 * that they pack the same way on 32-bit and 64-bit architectures (to
 * avoid incompatibility between 32-bit userspace and 64-bit kernels).
 * In particular do not use pointer types -- pass pointers in __u64
 * instead.
 */

struct nes_alloc_ucontext_req {
	__u32 reserved32;
	__u8  userspace_ver;
	__u8  reserved8[3];
};

struct nes_alloc_ucontext_resp {
	__u32 max_pds; /* maximum pds allowed for this user process */
	__u32 max_qps; /* maximum qps allowed for this user process */
	__u32 wq_size; /* size of the WQs (sq+rq) allocated to the mmaped area */
	__u8  virtwq;  /* flag to indicate if virtual WQ are to be used or not */
	__u8  kernel_ver;
	__u8  reserved[2];
};

struct nes_alloc_pd_resp {
	__u32 pd_id;
	__u32 mmap_db_index;
};

struct nes_create_cq_req {
	__u64 user_cq_buffer;
	__u32 mcrqf;
	__u8 reserved[4];
};

struct nes_create_qp_req {
	__u64 user_wqe_buffers;
	__u64 user_qp_buffer;
};

enum iwnes_memreg_type {
	IWNES_MEMREG_TYPE_MEM = 0x0000,
	IWNES_MEMREG_TYPE_QP = 0x0001,
	IWNES_MEMREG_TYPE_CQ = 0x0002,
	IWNES_MEMREG_TYPE_MW = 0x0003,
	IWNES_MEMREG_TYPE_FMR = 0x0004,
	IWNES_MEMREG_TYPE_FMEM = 0x0005,
};

struct nes_mem_reg_req {
	__u32 reg_type;	/* indicates if id is memory, QP or CQ */
	__u32 reserved;
};

struct nes_create_cq_resp {
	__u32 cq_id;
	__u32 cq_size;
	__u32 mmap_db_index;
	__u32 reserved;
};

struct nes_create_qp_resp {
	__u32 qp_id;
	__u32 actual_sq_size;
	__u32 actual_rq_size;
	__u32 mmap_sq_db_index;
	__u32 mmap_rq_db_index;
	__u32 nes_drv_opt;
};

#endif	/* NES_ABI_USER_H */
Commit	Line	Data
3c2d774c	1	/*
c5488c57	2	* Copyright (c) 2006 - 2011 Intel Corporation. All rights reserved.
3c2d774c GS	3	* Copyright (c) 2005 Topspin Communications. All rights reserved.
	4	* Copyright (c) 2005 Cisco Systems. All rights reserved.
	5	* Copyright (c) 2005 Open Grid Computing, 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	*/
	36
c546b2a3 LR	37	#ifndef NES_ABI_USER_H
c546b2a3 LR	38	#define NES_ABI_USER_H
3c2d774c GS	39
	40	#include <linux/types.h>
	41
43adff39 TN	42	#define NES_ABI_USERSPACE_VER 2
43adff39 TN	43	#define NES_ABI_KERNEL_VER 2
3c2d774c GS	44
	45	/*
	46	* Make sure that all structs defined in this file remain laid out so
	47	* that they pack the same way on 32-bit and 64-bit architectures (to
	48	* avoid incompatibility between 32-bit userspace and 64-bit kernels).
	49	* In particular do not use pointer types -- pass pointers in __u64
	50	* instead.
	51	*/
	52
	53	struct nes_alloc_ucontext_req {
	54	__u32 reserved32;
	55	__u8 userspace_ver;
	56	__u8 reserved8[3];
	57	};
	58
	59	struct nes_alloc_ucontext_resp {
	60	__u32 max_pds; /* maximum pds allowed for this user process */
	61	__u32 max_qps; /* maximum qps allowed for this user process */
	62	__u32 wq_size; /* size of the WQs (sq+rq) allocated to the mmaped area */
	63	__u8 virtwq; /* flag to indicate if virtual WQ are to be used or not */
	64	__u8 kernel_ver;
	65	__u8 reserved[2];
	66	};
	67
	68	struct nes_alloc_pd_resp {
	69	__u32 pd_id;
	70	__u32 mmap_db_index;
	71	};
	72
	73	struct nes_create_cq_req {
	74	__u64 user_cq_buffer;
	75	__u32 mcrqf;
	76	__u8 reserved[4];
	77	};
	78
	79	struct nes_create_qp_req {
	80	__u64 user_wqe_buffers;
43adff39	81	__u64 user_qp_buffer;
3c2d774c GS	82	};
	83
	84	enum iwnes_memreg_type {
	85	IWNES_MEMREG_TYPE_MEM = 0x0000,
	86	IWNES_MEMREG_TYPE_QP = 0x0001,
	87	IWNES_MEMREG_TYPE_CQ = 0x0002,
	88	IWNES_MEMREG_TYPE_MW = 0x0003,
	89	IWNES_MEMREG_TYPE_FMR = 0x0004,
e293a26f	90	IWNES_MEMREG_TYPE_FMEM = 0x0005,
3c2d774c GS	91	};
	92
	93	struct nes_mem_reg_req {
	94	__u32 reg_type; /* indicates if id is memory, QP or CQ */
	95	__u32 reserved;
	96	};
	97
	98	struct nes_create_cq_resp {
	99	__u32 cq_id;
	100	__u32 cq_size;
	101	__u32 mmap_db_index;
	102	__u32 reserved;
	103	};
	104
	105	struct nes_create_qp_resp {
	106	__u32 qp_id;
	107	__u32 actual_sq_size;
	108	__u32 actual_rq_size;
	109	__u32 mmap_sq_db_index;
	110	__u32 mmap_rq_db_index;
	111	__u32 nes_drv_opt;
	112	};
	113
c546b2a3	114	#endif /* NES_ABI_USER_H */