xref: /linux/include/rdma/ib_cm.h (revision 74ce1896c6c65b2f8cccbf59162d542988835835)
1 /*
2  * Copyright (c) 2004, 2005 Intel Corporation.  All rights reserved.
3  * Copyright (c) 2004 Topspin Corporation.  All rights reserved.
4  * Copyright (c) 2004 Voltaire Corporation.  All rights reserved.
5  * Copyright (c) 2005 Sun Microsystems, 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 #if !defined(IB_CM_H)
36 #define IB_CM_H
37 
38 #include <rdma/ib_mad.h>
39 #include <rdma/ib_sa.h>
40 
41 /* ib_cm and ib_user_cm modules share /sys/class/infiniband_cm */
42 extern struct class cm_class;
43 
44 enum ib_cm_state {
45 	IB_CM_IDLE,
46 	IB_CM_LISTEN,
47 	IB_CM_REQ_SENT,
48 	IB_CM_REQ_RCVD,
49 	IB_CM_MRA_REQ_SENT,
50 	IB_CM_MRA_REQ_RCVD,
51 	IB_CM_REP_SENT,
52 	IB_CM_REP_RCVD,
53 	IB_CM_MRA_REP_SENT,
54 	IB_CM_MRA_REP_RCVD,
55 	IB_CM_ESTABLISHED,
56 	IB_CM_DREQ_SENT,
57 	IB_CM_DREQ_RCVD,
58 	IB_CM_TIMEWAIT,
59 	IB_CM_SIDR_REQ_SENT,
60 	IB_CM_SIDR_REQ_RCVD
61 };
62 
63 enum ib_cm_lap_state {
64 	IB_CM_LAP_UNINIT,
65 	IB_CM_LAP_IDLE,
66 	IB_CM_LAP_SENT,
67 	IB_CM_LAP_RCVD,
68 	IB_CM_MRA_LAP_SENT,
69 	IB_CM_MRA_LAP_RCVD,
70 };
71 
72 enum ib_cm_event_type {
73 	IB_CM_REQ_ERROR,
74 	IB_CM_REQ_RECEIVED,
75 	IB_CM_REP_ERROR,
76 	IB_CM_REP_RECEIVED,
77 	IB_CM_RTU_RECEIVED,
78 	IB_CM_USER_ESTABLISHED,
79 	IB_CM_DREQ_ERROR,
80 	IB_CM_DREQ_RECEIVED,
81 	IB_CM_DREP_RECEIVED,
82 	IB_CM_TIMEWAIT_EXIT,
83 	IB_CM_MRA_RECEIVED,
84 	IB_CM_REJ_RECEIVED,
85 	IB_CM_LAP_ERROR,
86 	IB_CM_LAP_RECEIVED,
87 	IB_CM_APR_RECEIVED,
88 	IB_CM_SIDR_REQ_ERROR,
89 	IB_CM_SIDR_REQ_RECEIVED,
90 	IB_CM_SIDR_REP_RECEIVED
91 };
92 
93 enum ib_cm_data_size {
94 	IB_CM_REQ_PRIVATE_DATA_SIZE	 = 92,
95 	IB_CM_MRA_PRIVATE_DATA_SIZE	 = 222,
96 	IB_CM_REJ_PRIVATE_DATA_SIZE	 = 148,
97 	IB_CM_REP_PRIVATE_DATA_SIZE	 = 196,
98 	IB_CM_RTU_PRIVATE_DATA_SIZE	 = 224,
99 	IB_CM_DREQ_PRIVATE_DATA_SIZE	 = 220,
100 	IB_CM_DREP_PRIVATE_DATA_SIZE	 = 224,
101 	IB_CM_REJ_ARI_LENGTH		 = 72,
102 	IB_CM_LAP_PRIVATE_DATA_SIZE	 = 168,
103 	IB_CM_APR_PRIVATE_DATA_SIZE	 = 148,
104 	IB_CM_APR_INFO_LENGTH		 = 72,
105 	IB_CM_SIDR_REQ_PRIVATE_DATA_SIZE = 216,
106 	IB_CM_SIDR_REP_PRIVATE_DATA_SIZE = 136,
107 	IB_CM_SIDR_REP_INFO_LENGTH	 = 72,
108 };
109 
110 struct ib_cm_id;
111 
112 struct ib_cm_req_event_param {
113 	struct ib_cm_id		*listen_id;
114 
115 	/* P_Key that was used by the GMP's BTH header */
116 	u16			bth_pkey;
117 
118 	u8			port;
119 
120 	struct sa_path_rec	*primary_path;
121 	struct sa_path_rec	*alternate_path;
122 
123 	__be64			remote_ca_guid;
124 	u32			remote_qkey;
125 	u32			remote_qpn;
126 	enum ib_qp_type		qp_type;
127 
128 	u32			starting_psn;
129 	u8			responder_resources;
130 	u8			initiator_depth;
131 	unsigned int		local_cm_response_timeout:5;
132 	unsigned int		flow_control:1;
133 	unsigned int		remote_cm_response_timeout:5;
134 	unsigned int		retry_count:3;
135 	unsigned int		rnr_retry_count:3;
136 	unsigned int		srq:1;
137 };
138 
139 struct ib_cm_rep_event_param {
140 	__be64			remote_ca_guid;
141 	u32			remote_qkey;
142 	u32			remote_qpn;
143 	u32			starting_psn;
144 	u8			responder_resources;
145 	u8			initiator_depth;
146 	unsigned int		target_ack_delay:5;
147 	unsigned int		failover_accepted:2;
148 	unsigned int		flow_control:1;
149 	unsigned int		rnr_retry_count:3;
150 	unsigned int		srq:1;
151 };
152 
153 enum ib_cm_rej_reason {
154 	IB_CM_REJ_NO_QP				= 1,
155 	IB_CM_REJ_NO_EEC			= 2,
156 	IB_CM_REJ_NO_RESOURCES			= 3,
157 	IB_CM_REJ_TIMEOUT			= 4,
158 	IB_CM_REJ_UNSUPPORTED			= 5,
159 	IB_CM_REJ_INVALID_COMM_ID		= 6,
160 	IB_CM_REJ_INVALID_COMM_INSTANCE		= 7,
161 	IB_CM_REJ_INVALID_SERVICE_ID		= 8,
162 	IB_CM_REJ_INVALID_TRANSPORT_TYPE	= 9,
163 	IB_CM_REJ_STALE_CONN			= 10,
164 	IB_CM_REJ_RDC_NOT_EXIST			= 11,
165 	IB_CM_REJ_INVALID_GID			= 12,
166 	IB_CM_REJ_INVALID_LID			= 13,
167 	IB_CM_REJ_INVALID_SL			= 14,
168 	IB_CM_REJ_INVALID_TRAFFIC_CLASS		= 15,
169 	IB_CM_REJ_INVALID_HOP_LIMIT		= 16,
170 	IB_CM_REJ_INVALID_PACKET_RATE		= 17,
171 	IB_CM_REJ_INVALID_ALT_GID		= 18,
172 	IB_CM_REJ_INVALID_ALT_LID		= 19,
173 	IB_CM_REJ_INVALID_ALT_SL		= 20,
174 	IB_CM_REJ_INVALID_ALT_TRAFFIC_CLASS	= 21,
175 	IB_CM_REJ_INVALID_ALT_HOP_LIMIT		= 22,
176 	IB_CM_REJ_INVALID_ALT_PACKET_RATE	= 23,
177 	IB_CM_REJ_PORT_CM_REDIRECT		= 24,
178 	IB_CM_REJ_PORT_REDIRECT			= 25,
179 	IB_CM_REJ_INVALID_MTU			= 26,
180 	IB_CM_REJ_INSUFFICIENT_RESP_RESOURCES	= 27,
181 	IB_CM_REJ_CONSUMER_DEFINED		= 28,
182 	IB_CM_REJ_INVALID_RNR_RETRY		= 29,
183 	IB_CM_REJ_DUPLICATE_LOCAL_COMM_ID	= 30,
184 	IB_CM_REJ_INVALID_CLASS_VERSION		= 31,
185 	IB_CM_REJ_INVALID_FLOW_LABEL		= 32,
186 	IB_CM_REJ_INVALID_ALT_FLOW_LABEL	= 33
187 };
188 
189 struct ib_cm_rej_event_param {
190 	enum ib_cm_rej_reason	reason;
191 	void			*ari;
192 	u8			ari_length;
193 };
194 
195 struct ib_cm_mra_event_param {
196 	u8	service_timeout;
197 };
198 
199 struct ib_cm_lap_event_param {
200 	struct sa_path_rec	*alternate_path;
201 };
202 
203 enum ib_cm_apr_status {
204 	IB_CM_APR_SUCCESS,
205 	IB_CM_APR_INVALID_COMM_ID,
206 	IB_CM_APR_UNSUPPORTED,
207 	IB_CM_APR_REJECT,
208 	IB_CM_APR_REDIRECT,
209 	IB_CM_APR_IS_CURRENT,
210 	IB_CM_APR_INVALID_QPN_EECN,
211 	IB_CM_APR_INVALID_LID,
212 	IB_CM_APR_INVALID_GID,
213 	IB_CM_APR_INVALID_FLOW_LABEL,
214 	IB_CM_APR_INVALID_TCLASS,
215 	IB_CM_APR_INVALID_HOP_LIMIT,
216 	IB_CM_APR_INVALID_PACKET_RATE,
217 	IB_CM_APR_INVALID_SL
218 };
219 
220 struct ib_cm_apr_event_param {
221 	enum ib_cm_apr_status	ap_status;
222 	void			*apr_info;
223 	u8			info_len;
224 };
225 
226 struct ib_cm_sidr_req_event_param {
227 	struct ib_cm_id		*listen_id;
228 	__be64			service_id;
229 	/* P_Key that was used by the GMP's BTH header */
230 	u16			bth_pkey;
231 	u8			port;
232 	u16			pkey;
233 };
234 
235 enum ib_cm_sidr_status {
236 	IB_SIDR_SUCCESS,
237 	IB_SIDR_UNSUPPORTED,
238 	IB_SIDR_REJECT,
239 	IB_SIDR_NO_QP,
240 	IB_SIDR_REDIRECT,
241 	IB_SIDR_UNSUPPORTED_VERSION
242 };
243 
244 struct ib_cm_sidr_rep_event_param {
245 	enum ib_cm_sidr_status	status;
246 	u32			qkey;
247 	u32			qpn;
248 	void			*info;
249 	u8			info_len;
250 };
251 
252 struct ib_cm_event {
253 	enum ib_cm_event_type	event;
254 	union {
255 		struct ib_cm_req_event_param	req_rcvd;
256 		struct ib_cm_rep_event_param	rep_rcvd;
257 		/* No data for RTU received events. */
258 		struct ib_cm_rej_event_param	rej_rcvd;
259 		struct ib_cm_mra_event_param	mra_rcvd;
260 		struct ib_cm_lap_event_param	lap_rcvd;
261 		struct ib_cm_apr_event_param	apr_rcvd;
262 		/* No data for DREQ/DREP received events. */
263 		struct ib_cm_sidr_req_event_param sidr_req_rcvd;
264 		struct ib_cm_sidr_rep_event_param sidr_rep_rcvd;
265 		enum ib_wc_status		send_status;
266 	} param;
267 
268 	void			*private_data;
269 };
270 
271 #define CM_REQ_ATTR_ID		cpu_to_be16(0x0010)
272 #define CM_MRA_ATTR_ID		cpu_to_be16(0x0011)
273 #define CM_REJ_ATTR_ID		cpu_to_be16(0x0012)
274 #define CM_REP_ATTR_ID		cpu_to_be16(0x0013)
275 #define CM_RTU_ATTR_ID		cpu_to_be16(0x0014)
276 #define CM_DREQ_ATTR_ID		cpu_to_be16(0x0015)
277 #define CM_DREP_ATTR_ID		cpu_to_be16(0x0016)
278 #define CM_SIDR_REQ_ATTR_ID	cpu_to_be16(0x0017)
279 #define CM_SIDR_REP_ATTR_ID	cpu_to_be16(0x0018)
280 #define CM_LAP_ATTR_ID		cpu_to_be16(0x0019)
281 #define CM_APR_ATTR_ID		cpu_to_be16(0x001A)
282 
283 /**
284  * ib_cm_handler - User-defined callback to process communication events.
285  * @cm_id: Communication identifier associated with the reported event.
286  * @event: Information about the communication event.
287  *
288  * IB_CM_REQ_RECEIVED and IB_CM_SIDR_REQ_RECEIVED communication events
289  * generated as a result of listen requests result in the allocation of a
290  * new @cm_id.  The new @cm_id is returned to the user through this callback.
291  * Clients are responsible for destroying the new @cm_id.  For peer-to-peer
292  * IB_CM_REQ_RECEIVED and all other events, the returned @cm_id corresponds
293  * to a user's existing communication identifier.
294  *
295  * Users may not call ib_destroy_cm_id while in the context of this callback;
296  * however, returning a non-zero value instructs the communication manager to
297  * destroy the @cm_id after the callback completes.
298  */
299 typedef int (*ib_cm_handler)(struct ib_cm_id *cm_id,
300 			     struct ib_cm_event *event);
301 
302 struct ib_cm_id {
303 	ib_cm_handler		cm_handler;
304 	void			*context;
305 	struct ib_device	*device;
306 	__be64			service_id;
307 	__be64			service_mask;
308 	enum ib_cm_state	state;		/* internal CM/debug use */
309 	enum ib_cm_lap_state	lap_state;	/* internal CM/debug use */
310 	__be32			local_id;
311 	__be32			remote_id;
312 	u32			remote_cm_qpn;  /* 1 unless redirected */
313 };
314 
315 /**
316  * ib_create_cm_id - Allocate a communication identifier.
317  * @device: Device associated with the cm_id.  All related communication will
318  * be associated with the specified device.
319  * @cm_handler: Callback invoked to notify the user of CM events.
320  * @context: User specified context associated with the communication
321  *   identifier.
322  *
323  * Communication identifiers are used to track connection states, service
324  * ID resolution requests, and listen requests.
325  */
326 struct ib_cm_id *ib_create_cm_id(struct ib_device *device,
327 				 ib_cm_handler cm_handler,
328 				 void *context);
329 
330 /**
331  * ib_destroy_cm_id - Destroy a connection identifier.
332  * @cm_id: Connection identifier to destroy.
333  *
334  * This call blocks until the connection identifier is destroyed.
335  */
336 void ib_destroy_cm_id(struct ib_cm_id *cm_id);
337 
338 #define IB_SERVICE_ID_AGN_MASK	cpu_to_be64(0xFF00000000000000ULL)
339 #define IB_CM_ASSIGN_SERVICE_ID	cpu_to_be64(0x0200000000000000ULL)
340 #define IB_CMA_SERVICE_ID	cpu_to_be64(0x0000000001000000ULL)
341 #define IB_CMA_SERVICE_ID_MASK	cpu_to_be64(0xFFFFFFFFFF000000ULL)
342 #define IB_SDP_SERVICE_ID	cpu_to_be64(0x0000000000010000ULL)
343 #define IB_SDP_SERVICE_ID_MASK	cpu_to_be64(0xFFFFFFFFFFFF0000ULL)
344 
345 /**
346  * ib_cm_listen - Initiates listening on the specified service ID for
347  *   connection and service ID resolution requests.
348  * @cm_id: Connection identifier associated with the listen request.
349  * @service_id: Service identifier matched against incoming connection
350  *   and service ID resolution requests.  The service ID should be specified
351  *   network-byte order.  If set to IB_CM_ASSIGN_SERVICE_ID, the CM will
352  *   assign a service ID to the caller.
353  * @service_mask: Mask applied to service ID used to listen across a
354  *   range of service IDs.  If set to 0, the service ID is matched
355  *   exactly.  This parameter is ignored if %service_id is set to
356  *   IB_CM_ASSIGN_SERVICE_ID.
357  */
358 int ib_cm_listen(struct ib_cm_id *cm_id, __be64 service_id,
359 		 __be64 service_mask);
360 
361 struct ib_cm_id *ib_cm_insert_listen(struct ib_device *device,
362 				     ib_cm_handler cm_handler,
363 				     __be64 service_id);
364 
365 struct ib_cm_req_param {
366 	struct sa_path_rec	*primary_path;
367 	struct sa_path_rec	*alternate_path;
368 	__be64			service_id;
369 	u32			qp_num;
370 	enum ib_qp_type		qp_type;
371 	u32			starting_psn;
372 	const void		*private_data;
373 	u8			private_data_len;
374 	u8			peer_to_peer;
375 	u8			responder_resources;
376 	u8			initiator_depth;
377 	u8			remote_cm_response_timeout;
378 	u8			flow_control;
379 	u8			local_cm_response_timeout;
380 	u8			retry_count;
381 	u8			rnr_retry_count;
382 	u8			max_cm_retries;
383 	u8			srq;
384 };
385 
386 /**
387  * ib_send_cm_req - Sends a connection request to the remote node.
388  * @cm_id: Connection identifier that will be associated with the
389  *   connection request.
390  * @param: Connection request information needed to establish the
391  *   connection.
392  */
393 int ib_send_cm_req(struct ib_cm_id *cm_id,
394 		   struct ib_cm_req_param *param);
395 
396 struct ib_cm_rep_param {
397 	u32		qp_num;
398 	u32		starting_psn;
399 	const void	*private_data;
400 	u8		private_data_len;
401 	u8		responder_resources;
402 	u8		initiator_depth;
403 	u8		failover_accepted;
404 	u8		flow_control;
405 	u8		rnr_retry_count;
406 	u8		srq;
407 };
408 
409 /**
410  * ib_send_cm_rep - Sends a connection reply in response to a connection
411  *   request.
412  * @cm_id: Connection identifier that will be associated with the
413  *   connection request.
414  * @param: Connection reply information needed to establish the
415  *   connection.
416  */
417 int ib_send_cm_rep(struct ib_cm_id *cm_id,
418 		   struct ib_cm_rep_param *param);
419 
420 /**
421  * ib_send_cm_rtu - Sends a connection ready to use message in response
422  *   to a connection reply message.
423  * @cm_id: Connection identifier associated with the connection request.
424  * @private_data: Optional user-defined private data sent with the
425  *   ready to use message.
426  * @private_data_len: Size of the private data buffer, in bytes.
427  */
428 int ib_send_cm_rtu(struct ib_cm_id *cm_id,
429 		   const void *private_data,
430 		   u8 private_data_len);
431 
432 /**
433  * ib_send_cm_dreq - Sends a disconnection request for an existing
434  *   connection.
435  * @cm_id: Connection identifier associated with the connection being
436  *   released.
437  * @private_data: Optional user-defined private data sent with the
438  *   disconnection request message.
439  * @private_data_len: Size of the private data buffer, in bytes.
440  */
441 int ib_send_cm_dreq(struct ib_cm_id *cm_id,
442 		    const void *private_data,
443 		    u8 private_data_len);
444 
445 /**
446  * ib_send_cm_drep - Sends a disconnection reply to a disconnection request.
447  * @cm_id: Connection identifier associated with the connection being
448  *   released.
449  * @private_data: Optional user-defined private data sent with the
450  *   disconnection reply message.
451  * @private_data_len: Size of the private data buffer, in bytes.
452  *
453  * If the cm_id is in the correct state, the CM will transition the connection
454  * to the timewait state, even if an error occurs sending the DREP message.
455  */
456 int ib_send_cm_drep(struct ib_cm_id *cm_id,
457 		    const void *private_data,
458 		    u8 private_data_len);
459 
460 /**
461  * ib_cm_notify - Notifies the CM of an event reported to the consumer.
462  * @cm_id: Connection identifier to transition to established.
463  * @event: Type of event.
464  *
465  * This routine should be invoked by users to notify the CM of relevant
466  * communication events.  Events that should be reported to the CM and
467  * when to report them are:
468  *
469  * IB_EVENT_COMM_EST - Used when a message is received on a connected
470  *    QP before an RTU has been received.
471  * IB_EVENT_PATH_MIG - Notifies the CM that the connection has failed over
472  *   to the alternate path.
473  */
474 int ib_cm_notify(struct ib_cm_id *cm_id, enum ib_event_type event);
475 
476 /**
477  * ib_send_cm_rej - Sends a connection rejection message to the
478  *   remote node.
479  * @cm_id: Connection identifier associated with the connection being
480  *   rejected.
481  * @reason: Reason for the connection request rejection.
482  * @ari: Optional additional rejection information.
483  * @ari_length: Size of the additional rejection information, in bytes.
484  * @private_data: Optional user-defined private data sent with the
485  *   rejection message.
486  * @private_data_len: Size of the private data buffer, in bytes.
487  */
488 int ib_send_cm_rej(struct ib_cm_id *cm_id,
489 		   enum ib_cm_rej_reason reason,
490 		   void *ari,
491 		   u8 ari_length,
492 		   const void *private_data,
493 		   u8 private_data_len);
494 
495 #define IB_CM_MRA_FLAG_DELAY 0x80  /* Send MRA only after a duplicate msg */
496 
497 /**
498  * ib_send_cm_mra - Sends a message receipt acknowledgement to a connection
499  *   message.
500  * @cm_id: Connection identifier associated with the connection message.
501  * @service_timeout: The lower 5-bits specify the maximum time required for
502  *   the sender to reply to the connection message.  The upper 3-bits
503  *   specify additional control flags.
504  * @private_data: Optional user-defined private data sent with the
505  *   message receipt acknowledgement.
506  * @private_data_len: Size of the private data buffer, in bytes.
507  */
508 int ib_send_cm_mra(struct ib_cm_id *cm_id,
509 		   u8 service_timeout,
510 		   const void *private_data,
511 		   u8 private_data_len);
512 
513 /**
514  * ib_send_cm_lap - Sends a load alternate path request.
515  * @cm_id: Connection identifier associated with the load alternate path
516  *   message.
517  * @alternate_path: A path record that identifies the alternate path to
518  *   load.
519  * @private_data: Optional user-defined private data sent with the
520  *   load alternate path message.
521  * @private_data_len: Size of the private data buffer, in bytes.
522  */
523 int ib_send_cm_lap(struct ib_cm_id *cm_id,
524 		   struct sa_path_rec *alternate_path,
525 		   const void *private_data,
526 		   u8 private_data_len);
527 
528 /**
529  * ib_cm_init_qp_attr - Initializes the QP attributes for use in transitioning
530  *   to a specified QP state.
531  * @cm_id: Communication identifier associated with the QP attributes to
532  *   initialize.
533  * @qp_attr: On input, specifies the desired QP state.  On output, the
534  *   mandatory and desired optional attributes will be set in order to
535  *   modify the QP to the specified state.
536  * @qp_attr_mask: The QP attribute mask that may be used to transition the
537  *   QP to the specified state.
538  *
539  * Users must set the @qp_attr->qp_state to the desired QP state.  This call
540  * will set all required attributes for the given transition, along with
541  * known optional attributes.  Users may override the attributes returned from
542  * this call before calling ib_modify_qp.
543  */
544 int ib_cm_init_qp_attr(struct ib_cm_id *cm_id,
545 		       struct ib_qp_attr *qp_attr,
546 		       int *qp_attr_mask);
547 
548 /**
549  * ib_send_cm_apr - Sends an alternate path response message in response to
550  *   a load alternate path request.
551  * @cm_id: Connection identifier associated with the alternate path response.
552  * @status: Reply status sent with the alternate path response.
553  * @info: Optional additional information sent with the alternate path
554  *   response.
555  * @info_length: Size of the additional information, in bytes.
556  * @private_data: Optional user-defined private data sent with the
557  *   alternate path response message.
558  * @private_data_len: Size of the private data buffer, in bytes.
559  */
560 int ib_send_cm_apr(struct ib_cm_id *cm_id,
561 		   enum ib_cm_apr_status status,
562 		   void *info,
563 		   u8 info_length,
564 		   const void *private_data,
565 		   u8 private_data_len);
566 
567 struct ib_cm_sidr_req_param {
568 	struct sa_path_rec	*path;
569 	__be64			service_id;
570 	int			timeout_ms;
571 	const void		*private_data;
572 	u8			private_data_len;
573 	u8			max_cm_retries;
574 };
575 
576 /**
577  * ib_send_cm_sidr_req - Sends a service ID resolution request to the
578  *   remote node.
579  * @cm_id: Communication identifier that will be associated with the
580  *   service ID resolution request.
581  * @param: Service ID resolution request information.
582  */
583 int ib_send_cm_sidr_req(struct ib_cm_id *cm_id,
584 			struct ib_cm_sidr_req_param *param);
585 
586 struct ib_cm_sidr_rep_param {
587 	u32			qp_num;
588 	u32			qkey;
589 	enum ib_cm_sidr_status	status;
590 	const void		*info;
591 	u8			info_length;
592 	const void		*private_data;
593 	u8			private_data_len;
594 };
595 
596 /**
597  * ib_send_cm_sidr_rep - Sends a service ID resolution reply to the
598  *   remote node.
599  * @cm_id: Communication identifier associated with the received service ID
600  *   resolution request.
601  * @param: Service ID resolution reply information.
602  */
603 int ib_send_cm_sidr_rep(struct ib_cm_id *cm_id,
604 			struct ib_cm_sidr_rep_param *param);
605 
606 /**
607  * ibcm_reject_msg - return a pointer to a reject message string.
608  * @reason: Value returned in the REJECT event status field.
609  */
610 const char *__attribute_const__ ibcm_reject_msg(int reason);
611 
612 #endif /* IB_CM_H */
613