Commit 8a96b3f9 authored by Roland Dreier's avatar Roland Dreier Committed by Linus Torvalds
Browse files

[PATCH] IB uverbs: add user verbs ABI header 



Add the ib_user_verbs.h header file, which defines the ABI used by InfiniBand
userspace verbs for kernel/user communication.

Signed-off-by: default avatarRoland Dreier <rolandd@cisco.com>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
parent 1cf296b6

drivers/infiniband/include/ib_user_verbs.h

0 → 100644
+389 −0
Original line number Diff line number Diff line 
/*

 * 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: ib_user_verbs.h 2708 2005-06-24 17:27:21Z roland $

 */



#ifndef IB_USER_VERBS_H

#define IB_USER_VERBS_H



#include <linux/types.h>



/*

 * Increment this value if any changes that break userspace ABI

 * compatibility are made.

 */

#define IB_USER_VERBS_ABI_VERSION	1



enum {

	IB_USER_VERBS_CMD_QUERY_PARAMS,

	IB_USER_VERBS_CMD_GET_CONTEXT,

	IB_USER_VERBS_CMD_QUERY_DEVICE,

	IB_USER_VERBS_CMD_QUERY_PORT,

	IB_USER_VERBS_CMD_QUERY_GID,

	IB_USER_VERBS_CMD_QUERY_PKEY,

	IB_USER_VERBS_CMD_ALLOC_PD,

	IB_USER_VERBS_CMD_DEALLOC_PD,

	IB_USER_VERBS_CMD_CREATE_AH,

	IB_USER_VERBS_CMD_MODIFY_AH,

	IB_USER_VERBS_CMD_QUERY_AH,

	IB_USER_VERBS_CMD_DESTROY_AH,

	IB_USER_VERBS_CMD_REG_MR,

	IB_USER_VERBS_CMD_REG_SMR,

	IB_USER_VERBS_CMD_REREG_MR,

	IB_USER_VERBS_CMD_QUERY_MR,

	IB_USER_VERBS_CMD_DEREG_MR,

	IB_USER_VERBS_CMD_ALLOC_MW,

	IB_USER_VERBS_CMD_BIND_MW,

	IB_USER_VERBS_CMD_DEALLOC_MW,

	IB_USER_VERBS_CMD_CREATE_CQ,

	IB_USER_VERBS_CMD_RESIZE_CQ,

	IB_USER_VERBS_CMD_DESTROY_CQ,

	IB_USER_VERBS_CMD_POLL_CQ,

	IB_USER_VERBS_CMD_PEEK_CQ,

	IB_USER_VERBS_CMD_REQ_NOTIFY_CQ,

	IB_USER_VERBS_CMD_CREATE_QP,

	IB_USER_VERBS_CMD_QUERY_QP,

	IB_USER_VERBS_CMD_MODIFY_QP,

	IB_USER_VERBS_CMD_DESTROY_QP,

	IB_USER_VERBS_CMD_POST_SEND,

	IB_USER_VERBS_CMD_POST_RECV,

	IB_USER_VERBS_CMD_ATTACH_MCAST,

	IB_USER_VERBS_CMD_DETACH_MCAST

};



/*

 * 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 ib_uverbs_async_event_desc {

	__u64 element;

	__u32 event_type;	/* enum ib_event_type */

	__u32 reserved;

};



struct ib_uverbs_comp_event_desc {

	__u64 cq_handle;

};



/*

 * All commands from userspace should start with a __u32 command field

 * followed by __u16 in_words and out_words fields (which give the

 * length of the command block and response buffer if any in 32-bit

 * words).  The kernel driver will read these fields first and read

 * the rest of the command struct based on these value.

 */



struct ib_uverbs_cmd_hdr {

	__u32 command;

	__u16 in_words;

	__u16 out_words;

};



/*

 * No driver_data for "query params" command, since this is intended

 * to be a core function with no possible device dependence.

 */

struct ib_uverbs_query_params {

	__u64 response;

};



struct ib_uverbs_query_params_resp {

	__u32 num_cq_events;

};



struct ib_uverbs_get_context {

	__u64 response;

	__u64 cq_fd_tab;

	__u64 driver_data[0];

};



struct ib_uverbs_get_context_resp {

	__u32 async_fd;

	__u32 reserved;

};



struct ib_uverbs_query_device {

	__u64 response;

	__u64 driver_data[0];

};



struct ib_uverbs_query_device_resp {

	__u64 fw_ver;

	__u64 node_guid;

	__u64 sys_image_guid;

	__u64 max_mr_size;

	__u64 page_size_cap;

	__u32 vendor_id;

	__u32 vendor_part_id;

	__u32 hw_ver;

	__u32 max_qp;

	__u32 max_qp_wr;

	__u32 device_cap_flags;

	__u32 max_sge;

	__u32 max_sge_rd;

	__u32 max_cq;

	__u32 max_cqe;

	__u32 max_mr;

	__u32 max_pd;

	__u32 max_qp_rd_atom;

	__u32 max_ee_rd_atom;

	__u32 max_res_rd_atom;

	__u32 max_qp_init_rd_atom;

	__u32 max_ee_init_rd_atom;

	__u32 atomic_cap;

	__u32 max_ee;

	__u32 max_rdd;

	__u32 max_mw;

	__u32 max_raw_ipv6_qp;

	__u32 max_raw_ethy_qp;

	__u32 max_mcast_grp;

	__u32 max_mcast_qp_attach;

	__u32 max_total_mcast_qp_attach;

	__u32 max_ah;

	__u32 max_fmr;

	__u32 max_map_per_fmr;

	__u32 max_srq;

	__u32 max_srq_wr;

	__u32 max_srq_sge;

	__u16 max_pkeys;

	__u8  local_ca_ack_delay;

	__u8  phys_port_cnt;

	__u8  reserved[4];

};



struct ib_uverbs_query_port {

	__u64 response;

	__u8  port_num;

	__u8  reserved[7];

	__u64 driver_data[0];

};



struct ib_uverbs_query_port_resp {

	__u32 port_cap_flags;

	__u32 max_msg_sz;

	__u32 bad_pkey_cntr;

	__u32 qkey_viol_cntr;

	__u32 gid_tbl_len;

	__u16 pkey_tbl_len;

	__u16 lid;

	__u16 sm_lid;

	__u8  state;

	__u8  max_mtu;

	__u8  active_mtu;

	__u8  lmc;

	__u8  max_vl_num;

	__u8  sm_sl;

	__u8  subnet_timeout;

	__u8  init_type_reply;

	__u8  active_width;

	__u8  active_speed;

	__u8  phys_state;

	__u8  reserved[3];

};



struct ib_uverbs_query_gid {

	__u64 response;

	__u8  port_num;

	__u8  index;

	__u8  reserved[6];

	__u64 driver_data[0];

};



struct ib_uverbs_query_gid_resp {

	__u8  gid[16];

};



struct ib_uverbs_query_pkey {

	__u64 response;

	__u8  port_num;

	__u8  index;

	__u8  reserved[6];

	__u64 driver_data[0];

};



struct ib_uverbs_query_pkey_resp {

	__u16 pkey;

	__u16 reserved;

};



struct ib_uverbs_alloc_pd {

	__u64 response;

	__u64 driver_data[0];

};



struct ib_uverbs_alloc_pd_resp {

	__u32 pd_handle;

};



struct ib_uverbs_dealloc_pd {

	__u32 pd_handle;

};



struct ib_uverbs_reg_mr {

	__u64 response;

	__u64 start;

	__u64 length;

	__u64 hca_va;

	__u32 pd_handle;

	__u32 access_flags;

	__u64 driver_data[0];

};



struct ib_uverbs_reg_mr_resp {

	__u32 mr_handle;

	__u32 lkey;

	__u32 rkey;

};



struct ib_uverbs_dereg_mr {

	__u32 mr_handle;

};



struct ib_uverbs_create_cq {

	__u64 response;

	__u64 user_handle;

	__u32 cqe;

	__u32 event_handler;

	__u64 driver_data[0];

};



struct ib_uverbs_create_cq_resp {

	__u32 cq_handle;

	__u32 cqe;

};



struct ib_uverbs_destroy_cq {

	__u32 cq_handle;

};



struct ib_uverbs_create_qp {

	__u64 response;

	__u64 user_handle;

	__u32 pd_handle;

	__u32 send_cq_handle;

	__u32 recv_cq_handle;

	__u32 srq_handle;

	__u32 max_send_wr;

	__u32 max_recv_wr;

	__u32 max_send_sge;

	__u32 max_recv_sge;

	__u32 max_inline_data;

	__u8  sq_sig_all;

	__u8  qp_type;

	__u8  is_srq;

	__u8  reserved;

	__u64 driver_data[0];

};



struct ib_uverbs_create_qp_resp {

	__u32 qp_handle;

	__u32 qpn;

};



/*

 * This struct needs to remain a multiple of 8 bytes to keep the

 * alignment of the modify QP parameters.

 */

struct ib_uverbs_qp_dest {

	__u8  dgid[16];

	__u32 flow_label;

	__u16 dlid;

	__u16 reserved;

	__u8  sgid_index;

	__u8  hop_limit;

	__u8  traffic_class;

	__u8  sl;

	__u8  src_path_bits;

	__u8  static_rate;

	__u8  is_global;

	__u8  port_num;

};



struct ib_uverbs_modify_qp {

	struct ib_uverbs_qp_dest dest;

	struct ib_uverbs_qp_dest alt_dest;

	__u32 qp_handle;

	__u32 attr_mask;

	__u32 qkey;

	__u32 rq_psn;

	__u32 sq_psn;

	__u32 dest_qp_num;

	__u32 qp_access_flags;

	__u16 pkey_index;

	__u16 alt_pkey_index;

	__u8  qp_state;

	__u8  cur_qp_state;

	__u8  path_mtu;

	__u8  path_mig_state;

	__u8  en_sqd_async_notify;

	__u8  max_rd_atomic;

	__u8  max_dest_rd_atomic;

	__u8  min_rnr_timer;

	__u8  port_num;

	__u8  timeout;

	__u8  retry_cnt;

	__u8  rnr_retry;

	__u8  alt_port_num;

	__u8  alt_timeout;

	__u8  reserved[2];

	__u64 driver_data[0];

};



struct ib_uverbs_modify_qp_resp {

};



struct ib_uverbs_destroy_qp {

	__u32 qp_handle;

};



struct ib_uverbs_attach_mcast {

	__u8  gid[16];

	__u32 qp_handle;

	__u16 mlid;

	__u16 reserved;

	__u64 driver_data[0];

};



struct ib_uverbs_detach_mcast {

	__u8  gid[16];

	__u32 qp_handle;

	__u16 mlid;

	__u16 reserved;

	__u64 driver_data[0];

};



#endif /* IB_USER_VERBS_H */