[deliverable/linux.git] / include / rdma / ib_user_cm.h

/*
 * Copyright (c) 2005 Topspin Communications.  All rights reserved.
 * Copyright (c) 2005 Intel Corporation.  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_cm.h 4019 2005-11-11 00:33:09Z sean.hefty $
 */

#ifndef IB_USER_CM_H
#define IB_USER_CM_H

#include <rdma/ib_user_sa.h>

#define IB_USER_CM_ABI_VERSION 5

enum {
	IB_USER_CM_CMD_CREATE_ID,
	IB_USER_CM_CMD_DESTROY_ID,
	IB_USER_CM_CMD_ATTR_ID,

	IB_USER_CM_CMD_LISTEN,
	IB_USER_CM_CMD_NOTIFY,

	IB_USER_CM_CMD_SEND_REQ,
	IB_USER_CM_CMD_SEND_REP,
	IB_USER_CM_CMD_SEND_RTU,
	IB_USER_CM_CMD_SEND_DREQ,
	IB_USER_CM_CMD_SEND_DREP,
	IB_USER_CM_CMD_SEND_REJ,
	IB_USER_CM_CMD_SEND_MRA,
	IB_USER_CM_CMD_SEND_LAP,
	IB_USER_CM_CMD_SEND_APR,
	IB_USER_CM_CMD_SEND_SIDR_REQ,
	IB_USER_CM_CMD_SEND_SIDR_REP,

	IB_USER_CM_CMD_EVENT,
	IB_USER_CM_CMD_INIT_QP_ATTR,
};
/*
 * command ABI structures.
 */
struct ib_ucm_cmd_hdr {
	__u32 cmd;
	__u16 in;
	__u16 out;
};

struct ib_ucm_create_id {
	__u64 uid;
	__u64 response;
};

struct ib_ucm_create_id_resp {
	__u32 id;
};

struct ib_ucm_destroy_id {
	__u64 response;
	__u32 id;
	__u32 reserved;
};

struct ib_ucm_destroy_id_resp {
	__u32 events_reported;
};

struct ib_ucm_attr_id {
	__u64 response;
	__u32 id;
	__u32 reserved;
};

struct ib_ucm_attr_id_resp {
	__be64 service_id;
	__be64 service_mask;
	__be32 local_id;
	__be32 remote_id;
};

struct ib_ucm_init_qp_attr {
	__u64 response;
	__u32 id;
	__u32 qp_state;
};

struct ib_ucm_listen {
	__be64 service_id;
	__be64 service_mask;
	__u32 id;
	__u32 reserved;
};

struct ib_ucm_notify {
	__u32 id;
	__u32 event;
};

struct ib_ucm_private_data {
	__u64 data;
	__u32 id;
	__u8  len;
	__u8  reserved[3];
};

struct ib_ucm_req {
	__u32 id;
	__u32 qpn;
	__u32 qp_type;
	__u32 psn;
	__be64 sid;
	__u64 data;
	__u64 primary_path;
	__u64 alternate_path;
	__u8  len;
	__u8  peer_to_peer;
	__u8  responder_resources;
	__u8  initiator_depth;
	__u8  remote_cm_response_timeout;
	__u8  flow_control;
	__u8  local_cm_response_timeout;
	__u8  retry_count;
	__u8  rnr_retry_count;
	__u8  max_cm_retries;
	__u8  srq;
	__u8  reserved[5];
};

struct ib_ucm_rep {
	__u64 uid;
	__u64 data;
	__u32 id;
	__u32 qpn;
	__u32 psn;
	__u8  len;
	__u8  responder_resources;
	__u8  initiator_depth;
	__u8  target_ack_delay;
	__u8  failover_accepted;
	__u8  flow_control;
	__u8  rnr_retry_count;
	__u8  srq;
	__u8  reserved[4];
};

struct ib_ucm_info {
	__u32 id;
	__u32 status;
	__u64 info;
	__u64 data;
	__u8  info_len;
	__u8  data_len;
	__u8  reserved[6];
};

struct ib_ucm_mra {
	__u64 data;
	__u32 id;
	__u8  len;
	__u8  timeout;
	__u8  reserved[2];
};

struct ib_ucm_lap {
	__u64 path;
	__u64 data;
	__u32 id;
	__u8  len;
	__u8  reserved[3];
};

struct ib_ucm_sidr_req {
	__u32 id;
	__u32 timeout;
	__be64 sid;
	__u64 data;
	__u64 path;
	__u16 reserved_pkey;
	__u8  len;
	__u8  max_cm_retries;
	__u8  reserved[4];
};

struct ib_ucm_sidr_rep {
	__u32 id;
	__u32 qpn;
	__u32 qkey;
	__u32 status;
	__u64 info;
	__u64 data;
	__u8  info_len;
	__u8  data_len;
	__u8  reserved[6];
};
/*
 * event notification ABI structures.
 */
struct ib_ucm_event_get {
	__u64 response;
	__u64 data;
	__u64 info;
	__u8  data_len;
	__u8  info_len;
	__u8  reserved[6];
};

struct ib_ucm_req_event_resp {
	struct ib_user_path_rec primary_path;
	struct ib_user_path_rec alternate_path;
	__be64                 remote_ca_guid;
	__u32                  remote_qkey;
	__u32                  remote_qpn;
	__u32                  qp_type;
	__u32                  starting_psn;
	__u8  responder_resources;
	__u8  initiator_depth;
	__u8  local_cm_response_timeout;
	__u8  flow_control;
	__u8  remote_cm_response_timeout;
	__u8  retry_count;
	__u8  rnr_retry_count;
	__u8  srq;
	__u8  port;
	__u8  reserved[7];
};

struct ib_ucm_rep_event_resp {
	__be64 remote_ca_guid;
	__u32 remote_qkey;
	__u32 remote_qpn;
	__u32 starting_psn;
	__u8  responder_resources;
	__u8  initiator_depth;
	__u8  target_ack_delay;
	__u8  failover_accepted;
	__u8  flow_control;
	__u8  rnr_retry_count;
	__u8  srq;
	__u8  reserved[5];
};

struct ib_ucm_rej_event_resp {
	__u32 reason;
	/* ari in ib_ucm_event_get info field. */
};

struct ib_ucm_mra_event_resp {
	__u8  timeout;
	__u8  reserved[3];
};

struct ib_ucm_lap_event_resp {
	struct ib_user_path_rec path;
};

struct ib_ucm_apr_event_resp {
	__u32 status;
	/* apr info in ib_ucm_event_get info field. */
};

struct ib_ucm_sidr_req_event_resp {
	__u16 pkey;
	__u8  port;
	__u8  reserved;
};

struct ib_ucm_sidr_rep_event_resp {
	__u32 status;
	__u32 qkey;
	__u32 qpn;
	/* info in ib_ucm_event_get info field. */
};

#define IB_UCM_PRES_DATA      0x01
#define IB_UCM_PRES_INFO      0x02
#define IB_UCM_PRES_PRIMARY   0x04
#define IB_UCM_PRES_ALTERNATE 0x08

struct ib_ucm_event_resp {
	__u64 uid;
	__u32 id;
	__u32 event;
	__u32 present;
	__u32 reserved;
	union {
		struct ib_ucm_req_event_resp req_resp;
		struct ib_ucm_rep_event_resp rep_resp;
		struct ib_ucm_rej_event_resp rej_resp;
		struct ib_ucm_mra_event_resp mra_resp;
		struct ib_ucm_lap_event_resp lap_resp;
		struct ib_ucm_apr_event_resp apr_resp;

		struct ib_ucm_sidr_req_event_resp sidr_req_resp;
		struct ib_ucm_sidr_rep_event_resp sidr_rep_resp;

		__u32                             send_status;
	} u;
};

#endif /* IB_USER_CM_H */
Commit	Line	Data
8aa00919 HR	1	/*
8aa00919 HR	2	* Copyright (c) 2005 Topspin Communications. All rights reserved.
0b2b35f6	3	* Copyright (c) 2005 Intel Corporation. All rights reserved.
8aa00919 HR	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	*
6a9af2e1	33	* $Id: ib_user_cm.h 4019 2005-11-11 00:33:09Z sean.hefty $
8aa00919 HR	34	*/
	35
	36	#ifndef IB_USER_CM_H
	37	#define IB_USER_CM_H
	38
6a9af2e1	39	#include <rdma/ib_user_sa.h>
8aa00919	40
e1444b5a	41	#define IB_USER_CM_ABI_VERSION 5
8aa00919 HR	42
	43	enum {
	44	IB_USER_CM_CMD_CREATE_ID,
	45	IB_USER_CM_CMD_DESTROY_ID,
	46	IB_USER_CM_CMD_ATTR_ID,
	47
	48	IB_USER_CM_CMD_LISTEN,
e1444b5a	49	IB_USER_CM_CMD_NOTIFY,
8aa00919 HR	50
	51	IB_USER_CM_CMD_SEND_REQ,
	52	IB_USER_CM_CMD_SEND_REP,
	53	IB_USER_CM_CMD_SEND_RTU,
	54	IB_USER_CM_CMD_SEND_DREQ,
	55	IB_USER_CM_CMD_SEND_DREP,
	56	IB_USER_CM_CMD_SEND_REJ,
	57	IB_USER_CM_CMD_SEND_MRA,
	58	IB_USER_CM_CMD_SEND_LAP,
	59	IB_USER_CM_CMD_SEND_APR,
	60	IB_USER_CM_CMD_SEND_SIDR_REQ,
	61	IB_USER_CM_CMD_SEND_SIDR_REP,
	62
	63	IB_USER_CM_CMD_EVENT,
0b2b35f6	64	IB_USER_CM_CMD_INIT_QP_ATTR,
8aa00919 HR	65	};
	66	/*
	67	* command ABI structures.
	68	*/
	69	struct ib_ucm_cmd_hdr {
	70	__u32 cmd;
	71	__u16 in;
	72	__u16 out;
	73	};
	74
	75	struct ib_ucm_create_id {
0b2b35f6	76	__u64 uid;
8aa00919 HR	77	__u64 response;
	78	};
	79
	80	struct ib_ucm_create_id_resp {
	81	__u32 id;
	82	};
	83
	84	struct ib_ucm_destroy_id {
0b2b35f6	85	__u64 response;
8aa00919	86	__u32 id;
7b28b0d0	87	__u32 reserved;
8aa00919 HR	88	};
8aa00919 HR	89
0b2b35f6 SH	90	struct ib_ucm_destroy_id_resp {
	91	__u32 events_reported;
	92	};
	93
8aa00919 HR	94	struct ib_ucm_attr_id {
	95	__u64 response;
	96	__u32 id;
7b28b0d0	97	__u32 reserved;
8aa00919 HR	98	};
	99
	100	struct ib_ucm_attr_id_resp {
97f52eb4 SH	101	__be64 service_id;
	102	__be64 service_mask;
	103	__be32 local_id;
	104	__be32 remote_id;
8aa00919 HR	105	};
8aa00919 HR	106
0b2b35f6 SH	107	struct ib_ucm_init_qp_attr {
	108	__u64 response;
	109	__u32 id;
	110	__u32 qp_state;
	111	};
	112
8aa00919	113	struct ib_ucm_listen {
97f52eb4 SH	114	__be64 service_id;
97f52eb4 SH	115	__be64 service_mask;
8aa00919	116	__u32 id;
7b28b0d0	117	__u32 reserved;
8aa00919 HR	118	};
8aa00919 HR	119
e1444b5a	120	struct ib_ucm_notify {
8aa00919	121	__u32 id;
e1444b5a	122	__u32 event;
8aa00919 HR	123	};
	124
	125	struct ib_ucm_private_data {
	126	__u64 data;
	127	__u32 id;
	128	__u8 len;
	129	__u8 reserved[3];
	130	};
	131
8aa00919 HR	132	struct ib_ucm_req {
	133	__u32 id;
	134	__u32 qpn;
	135	__u32 qp_type;
	136	__u32 psn;
97f52eb4	137	__be64 sid;
8aa00919 HR	138	__u64 data;
	139	__u64 primary_path;
	140	__u64 alternate_path;
	141	__u8 len;
	142	__u8 peer_to_peer;
	143	__u8 responder_resources;
	144	__u8 initiator_depth;
	145	__u8 remote_cm_response_timeout;
	146	__u8 flow_control;
	147	__u8 local_cm_response_timeout;
	148	__u8 retry_count;
	149	__u8 rnr_retry_count;
	150	__u8 max_cm_retries;
	151	__u8 srq;
7b28b0d0	152	__u8 reserved[5];
8aa00919 HR	153	};
	154
	155	struct ib_ucm_rep {
0b2b35f6	156	__u64 uid;
8aa00919 HR	157	__u64 data;
	158	__u32 id;
	159	__u32 qpn;
	160	__u32 psn;
	161	__u8 len;
	162	__u8 responder_resources;
	163	__u8 initiator_depth;
	164	__u8 target_ack_delay;
	165	__u8 failover_accepted;
	166	__u8 flow_control;
	167	__u8 rnr_retry_count;
	168	__u8 srq;
7b28b0d0	169	__u8 reserved[4];
8aa00919 HR	170	};
	171
	172	struct ib_ucm_info {
	173	__u32 id;
	174	__u32 status;
	175	__u64 info;
	176	__u64 data;
	177	__u8 info_len;
	178	__u8 data_len;
7b28b0d0	179	__u8 reserved[6];
8aa00919 HR	180	};
	181
	182	struct ib_ucm_mra {
	183	__u64 data;
	184	__u32 id;
	185	__u8 len;
	186	__u8 timeout;
	187	__u8 reserved[2];
	188	};
	189
	190	struct ib_ucm_lap {
	191	__u64 path;
	192	__u64 data;
	193	__u32 id;
	194	__u8 len;
	195	__u8 reserved[3];
	196	};
	197
	198	struct ib_ucm_sidr_req {
	199	__u32 id;
	200	__u32 timeout;
97f52eb4	201	__be64 sid;
8aa00919 HR	202	__u64 data;
8aa00919 HR	203	__u64 path;
75af9088	204	__u16 reserved_pkey;
8aa00919 HR	205	__u8 len;
8aa00919 HR	206	__u8 max_cm_retries;
7b28b0d0	207	__u8 reserved[4];
8aa00919 HR	208	};
	209
	210	struct ib_ucm_sidr_rep {
	211	__u32 id;
	212	__u32 qpn;
	213	__u32 qkey;
	214	__u32 status;
	215	__u64 info;
	216	__u64 data;
	217	__u8 info_len;
	218	__u8 data_len;
7b28b0d0	219	__u8 reserved[6];
8aa00919 HR	220	};
	221	/*
	222	* event notification ABI structures.
	223	*/
	224	struct ib_ucm_event_get {
	225	__u64 response;
	226	__u64 data;
	227	__u64 info;
	228	__u8 data_len;
	229	__u8 info_len;
7b28b0d0	230	__u8 reserved[6];
8aa00919 HR	231	};
	232
	233	struct ib_ucm_req_event_resp {
6a9af2e1 SH	234	struct ib_user_path_rec primary_path;
6a9af2e1 SH	235	struct ib_user_path_rec alternate_path;
97f52eb4	236	__be64 remote_ca_guid;
8aa00919 HR	237	__u32 remote_qkey;
	238	__u32 remote_qpn;
	239	__u32 qp_type;
	240	__u32 starting_psn;
	241	__u8 responder_resources;
	242	__u8 initiator_depth;
	243	__u8 local_cm_response_timeout;
	244	__u8 flow_control;
	245	__u8 remote_cm_response_timeout;
	246	__u8 retry_count;
	247	__u8 rnr_retry_count;
	248	__u8 srq;
07d357d0	249	__u8 port;
7b28b0d0	250	__u8 reserved[7];
8aa00919 HR	251	};
	252
	253	struct ib_ucm_rep_event_resp {
97f52eb4	254	__be64 remote_ca_guid;
8aa00919 HR	255	__u32 remote_qkey;
	256	__u32 remote_qpn;
	257	__u32 starting_psn;
	258	__u8 responder_resources;
	259	__u8 initiator_depth;
	260	__u8 target_ack_delay;
	261	__u8 failover_accepted;
	262	__u8 flow_control;
	263	__u8 rnr_retry_count;
	264	__u8 srq;
7b28b0d0	265	__u8 reserved[5];
8aa00919 HR	266	};
	267
	268	struct ib_ucm_rej_event_resp {
	269	__u32 reason;
	270	/* ari in ib_ucm_event_get info field. */
	271	};
	272
	273	struct ib_ucm_mra_event_resp {
	274	__u8 timeout;
	275	__u8 reserved[3];
	276	};
	277
	278	struct ib_ucm_lap_event_resp {
6a9af2e1	279	struct ib_user_path_rec path;
8aa00919 HR	280	};
	281
	282	struct ib_ucm_apr_event_resp {
	283	__u32 status;
	284	/* apr info in ib_ucm_event_get info field. */
	285	};
	286
	287	struct ib_ucm_sidr_req_event_resp {
8aa00919	288	__u16 pkey;
07d357d0 SH	289	__u8 port;
07d357d0 SH	290	__u8 reserved;
8aa00919 HR	291	};
	292
	293	struct ib_ucm_sidr_rep_event_resp {
	294	__u32 status;
	295	__u32 qkey;
	296	__u32 qpn;
	297	/* info in ib_ucm_event_get info field. */
	298	};
	299
	300	#define IB_UCM_PRES_DATA 0x01
	301	#define IB_UCM_PRES_INFO 0x02
	302	#define IB_UCM_PRES_PRIMARY 0x04
	303	#define IB_UCM_PRES_ALTERNATE 0x08
	304
	305	struct ib_ucm_event_resp {
0b2b35f6	306	__u64 uid;
8aa00919 HR	307	__u32 id;
	308	__u32 event;
	309	__u32 present;
7b28b0d0	310	__u32 reserved;
8aa00919 HR	311	union {
	312	struct ib_ucm_req_event_resp req_resp;
	313	struct ib_ucm_rep_event_resp rep_resp;
	314	struct ib_ucm_rej_event_resp rej_resp;
	315	struct ib_ucm_mra_event_resp mra_resp;
	316	struct ib_ucm_lap_event_resp lap_resp;
	317	struct ib_ucm_apr_event_resp apr_resp;
	318
	319	struct ib_ucm_sidr_req_event_resp sidr_req_resp;
	320	struct ib_ucm_sidr_rep_event_resp sidr_rep_resp;
	321
	322	__u32 send_status;
	323	} u;
	324	};
	325
	326	#endif /* IB_USER_CM_H */