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.
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:
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
17 * - Redistributions of source code must retain the above
18 * copyright notice, this list of conditions and the following
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.
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
35 * $Id: ib_cm.h 4311 2005-12-05 18:42:01Z sean.hefty $
44 #include <contrib/rdma/ib_mad.h>
45 #include <contrib/rdma/ib_sa.h>
66 enum ib_cm_lap_state {
75 enum ib_cm_event_type {
81 IB_CM_USER_ESTABLISHED,
92 IB_CM_SIDR_REQ_RECEIVED,
93 IB_CM_SIDR_REP_RECEIVED
96 enum ib_cm_data_size {
97 IB_CM_REQ_PRIVATE_DATA_SIZE = 92,
98 IB_CM_MRA_PRIVATE_DATA_SIZE = 222,
99 IB_CM_REJ_PRIVATE_DATA_SIZE = 148,
100 IB_CM_REP_PRIVATE_DATA_SIZE = 196,
101 IB_CM_RTU_PRIVATE_DATA_SIZE = 224,
102 IB_CM_DREQ_PRIVATE_DATA_SIZE = 220,
103 IB_CM_DREP_PRIVATE_DATA_SIZE = 224,
104 IB_CM_REJ_ARI_LENGTH = 72,
105 IB_CM_LAP_PRIVATE_DATA_SIZE = 168,
106 IB_CM_APR_PRIVATE_DATA_SIZE = 148,
107 IB_CM_APR_INFO_LENGTH = 72,
108 IB_CM_SIDR_REQ_PRIVATE_DATA_SIZE = 216,
109 IB_CM_SIDR_REP_PRIVATE_DATA_SIZE = 136,
110 IB_CM_SIDR_REP_INFO_LENGTH = 72,
111 IB_CM_COMPARE_SIZE = 64
116 struct ib_cm_req_event_param {
117 struct ib_cm_id *listen_id;
120 struct ib_sa_path_rec *primary_path;
121 struct ib_sa_path_rec *alternate_path;
123 __be64 remote_ca_guid;
126 enum ib_qp_type qp_type;
129 u8 responder_resources;
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;
139 struct ib_cm_rep_event_param {
140 __be64 remote_ca_guid;
144 u8 responder_resources;
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;
153 enum ib_cm_rej_reason {
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
189 struct ib_cm_rej_event_param {
190 enum ib_cm_rej_reason reason;
195 struct ib_cm_mra_event_param {
199 struct ib_cm_lap_event_param {
200 struct ib_sa_path_rec *alternate_path;
203 enum ib_cm_apr_status {
205 IB_CM_APR_INVALID_COMM_ID,
206 IB_CM_APR_UNSUPPORTED,
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,
220 struct ib_cm_apr_event_param {
221 enum ib_cm_apr_status ap_status;
226 struct ib_cm_sidr_req_event_param {
227 struct ib_cm_id *listen_id;
232 enum ib_cm_sidr_status {
238 IB_SIDR_UNSUPPORTED_VERSION
241 struct ib_cm_sidr_rep_event_param {
242 enum ib_cm_sidr_status status;
250 enum ib_cm_event_type event;
252 struct ib_cm_req_event_param req_rcvd;
253 struct ib_cm_rep_event_param rep_rcvd;
254 /* No data for RTU received events. */
255 struct ib_cm_rej_event_param rej_rcvd;
256 struct ib_cm_mra_event_param mra_rcvd;
257 struct ib_cm_lap_event_param lap_rcvd;
258 struct ib_cm_apr_event_param apr_rcvd;
259 /* No data for DREQ/DREP received events. */
260 struct ib_cm_sidr_req_event_param sidr_req_rcvd;
261 struct ib_cm_sidr_rep_event_param sidr_rep_rcvd;
262 enum ib_wc_status send_status;
269 * ib_cm_handler - User-defined callback to process communication events.
270 * @cm_id: Communication identifier associated with the reported event.
271 * @event: Information about the communication event.
273 * IB_CM_REQ_RECEIVED and IB_CM_SIDR_REQ_RECEIVED communication events
274 * generated as a result of listen requests result in the allocation of a
275 * new @cm_id. The new @cm_id is returned to the user through this callback.
276 * Clients are responsible for destroying the new @cm_id. For peer-to-peer
277 * IB_CM_REQ_RECEIVED and all other events, the returned @cm_id corresponds
278 * to a user's existing communication identifier.
280 * Users may not call ib_destroy_cm_id while in the context of this callback;
281 * however, returning a non-zero value instructs the communication manager to
282 * destroy the @cm_id after the callback completes.
284 typedef int (*ib_cm_handler)(struct ib_cm_id *cm_id,
285 struct ib_cm_event *event);
288 ib_cm_handler cm_handler;
290 struct ib_device *device;
293 enum ib_cm_state state; /* internal CM/debug use */
294 enum ib_cm_lap_state lap_state; /* internal CM/debug use */
297 u32 remote_cm_qpn; /* 1 unless redirected */
301 * ib_create_cm_id - Allocate a communication identifier.
302 * @device: Device associated with the cm_id. All related communication will
303 * be associated with the specified device.
304 * @cm_handler: Callback invoked to notify the user of CM events.
305 * @context: User specified context associated with the communication
308 * Communication identifiers are used to track connection states, service
309 * ID resolution requests, and listen requests.
311 struct ib_cm_id *ib_create_cm_id(struct ib_device *device,
312 ib_cm_handler cm_handler,
316 * ib_destroy_cm_id - Destroy a connection identifier.
317 * @cm_id: Connection identifier to destroy.
319 * This call blocks until the connection identifier is destroyed.
321 void ib_destroy_cm_id(struct ib_cm_id *cm_id);
323 #define IB_SERVICE_ID_AGN_MASK __constant_cpu_to_be64(0xFF00000000000000ULL)
324 #define IB_CM_ASSIGN_SERVICE_ID __constant_cpu_to_be64(0x0200000000000000ULL)
325 #define IB_CMA_SERVICE_ID __constant_cpu_to_be64(0x0000000001000000ULL)
326 #define IB_CMA_SERVICE_ID_MASK __constant_cpu_to_be64(0xFFFFFFFFFF000000ULL)
327 #define IB_SDP_SERVICE_ID __constant_cpu_to_be64(0x0000000000010000ULL)
328 #define IB_SDP_SERVICE_ID_MASK __constant_cpu_to_be64(0xFFFFFFFFFFFF0000ULL)
330 struct ib_cm_compare_data {
331 u8 data[IB_CM_COMPARE_SIZE];
332 u8 mask[IB_CM_COMPARE_SIZE];
336 * ib_cm_listen - Initiates listening on the specified service ID for
337 * connection and service ID resolution requests.
338 * @cm_id: Connection identifier associated with the listen request.
339 * @service_id: Service identifier matched against incoming connection
340 * and service ID resolution requests. The service ID should be specified
341 * network-byte order. If set to IB_CM_ASSIGN_SERVICE_ID, the CM will
342 * assign a service ID to the caller.
343 * @service_mask: Mask applied to service ID used to listen across a
344 * range of service IDs. If set to 0, the service ID is matched
345 * exactly. This parameter is ignored if %service_id is set to
346 * IB_CM_ASSIGN_SERVICE_ID.
347 * @compare_data: This parameter is optional. It specifies data that must
348 * appear in the private data of a connection request for the specified
351 int ib_cm_listen(struct ib_cm_id *cm_id, __be64 service_id, __be64 service_mask,
352 struct ib_cm_compare_data *compare_data);
354 struct ib_cm_req_param {
355 struct ib_sa_path_rec *primary_path;
356 struct ib_sa_path_rec *alternate_path;
359 enum ib_qp_type qp_type;
361 const void *private_data;
364 u8 responder_resources;
366 u8 remote_cm_response_timeout;
368 u8 local_cm_response_timeout;
376 * ib_send_cm_req - Sends a connection request to the remote node.
377 * @cm_id: Connection identifier that will be associated with the
378 * connection request.
379 * @param: Connection request information needed to establish the
382 int ib_send_cm_req(struct ib_cm_id *cm_id,
383 struct ib_cm_req_param *param);
385 struct ib_cm_rep_param {
388 const void *private_data;
390 u8 responder_resources;
393 u8 failover_accepted;
400 * ib_send_cm_rep - Sends a connection reply in response to a connection
402 * @cm_id: Connection identifier that will be associated with the
403 * connection request.
404 * @param: Connection reply information needed to establish the
407 int ib_send_cm_rep(struct ib_cm_id *cm_id,
408 struct ib_cm_rep_param *param);
411 * ib_send_cm_rtu - Sends a connection ready to use message in response
412 * to a connection reply message.
413 * @cm_id: Connection identifier associated with the connection request.
414 * @private_data: Optional user-defined private data sent with the
415 * ready to use message.
416 * @private_data_len: Size of the private data buffer, in bytes.
418 int ib_send_cm_rtu(struct ib_cm_id *cm_id,
419 const void *private_data,
420 u8 private_data_len);
423 * ib_send_cm_dreq - Sends a disconnection request for an existing
425 * @cm_id: Connection identifier associated with the connection being
427 * @private_data: Optional user-defined private data sent with the
428 * disconnection request message.
429 * @private_data_len: Size of the private data buffer, in bytes.
431 int ib_send_cm_dreq(struct ib_cm_id *cm_id,
432 const void *private_data,
433 u8 private_data_len);
436 * ib_send_cm_drep - Sends a disconnection reply to a disconnection request.
437 * @cm_id: Connection identifier associated with the connection being
439 * @private_data: Optional user-defined private data sent with the
440 * disconnection reply message.
441 * @private_data_len: Size of the private data buffer, in bytes.
443 * If the cm_id is in the correct state, the CM will transition the connection
444 * to the timewait state, even if an error occurs sending the DREP message.
446 int ib_send_cm_drep(struct ib_cm_id *cm_id,
447 const void *private_data,
448 u8 private_data_len);
451 * ib_cm_notify - Notifies the CM of an event reported to the consumer.
452 * @cm_id: Connection identifier to transition to established.
453 * @event: Type of event.
455 * This routine should be invoked by users to notify the CM of relevant
456 * communication events. Events that should be reported to the CM and
457 * when to report them are:
459 * IB_EVENT_COMM_EST - Used when a message is received on a connected
460 * QP before an RTU has been received.
461 * IB_EVENT_PATH_MIG - Notifies the CM that the connection has failed over
462 * to the alternate path.
464 int ib_cm_notify(struct ib_cm_id *cm_id, enum ib_event_type event);
467 * ib_send_cm_rej - Sends a connection rejection message to the
469 * @cm_id: Connection identifier associated with the connection being
471 * @reason: Reason for the connection request rejection.
472 * @ari: Optional additional rejection information.
473 * @ari_length: Size of the additional rejection information, in bytes.
474 * @private_data: Optional user-defined private data sent with the
476 * @private_data_len: Size of the private data buffer, in bytes.
478 int ib_send_cm_rej(struct ib_cm_id *cm_id,
479 enum ib_cm_rej_reason reason,
482 const void *private_data,
483 u8 private_data_len);
486 * ib_send_cm_mra - Sends a message receipt acknowledgement to a connection
488 * @cm_id: Connection identifier associated with the connection message.
489 * @service_timeout: The maximum time required for the sender to reply to
490 * to the connection message.
491 * @private_data: Optional user-defined private data sent with the
492 * message receipt acknowledgement.
493 * @private_data_len: Size of the private data buffer, in bytes.
495 int ib_send_cm_mra(struct ib_cm_id *cm_id,
497 const void *private_data,
498 u8 private_data_len);
501 * ib_send_cm_lap - Sends a load alternate path request.
502 * @cm_id: Connection identifier associated with the load alternate path
504 * @alternate_path: A path record that identifies the alternate path to
506 * @private_data: Optional user-defined private data sent with the
507 * load alternate path message.
508 * @private_data_len: Size of the private data buffer, in bytes.
510 int ib_send_cm_lap(struct ib_cm_id *cm_id,
511 struct ib_sa_path_rec *alternate_path,
512 const void *private_data,
513 u8 private_data_len);
516 * ib_cm_init_qp_attr - Initializes the QP attributes for use in transitioning
517 * to a specified QP state.
518 * @cm_id: Communication identifier associated with the QP attributes to
520 * @qp_attr: On input, specifies the desired QP state. On output, the
521 * mandatory and desired optional attributes will be set in order to
522 * modify the QP to the specified state.
523 * @qp_attr_mask: The QP attribute mask that may be used to transition the
524 * QP to the specified state.
526 * Users must set the @qp_attr->qp_state to the desired QP state. This call
527 * will set all required attributes for the given transition, along with
528 * known optional attributes. Users may override the attributes returned from
529 * this call before calling ib_modify_qp.
531 int ib_cm_init_qp_attr(struct ib_cm_id *cm_id,
532 struct ib_qp_attr *qp_attr,
536 * ib_send_cm_apr - Sends an alternate path response message in response to
537 * a load alternate path request.
538 * @cm_id: Connection identifier associated with the alternate path response.
539 * @status: Reply status sent with the alternate path response.
540 * @info: Optional additional information sent with the alternate path
542 * @info_length: Size of the additional information, in bytes.
543 * @private_data: Optional user-defined private data sent with the
544 * alternate path response message.
545 * @private_data_len: Size of the private data buffer, in bytes.
547 int ib_send_cm_apr(struct ib_cm_id *cm_id,
548 enum ib_cm_apr_status status,
551 const void *private_data,
552 u8 private_data_len);
554 struct ib_cm_sidr_req_param {
555 struct ib_sa_path_rec *path;
558 const void *private_data;
564 * ib_send_cm_sidr_req - Sends a service ID resolution request to the
566 * @cm_id: Communication identifier that will be associated with the
567 * service ID resolution request.
568 * @param: Service ID resolution request information.
570 int ib_send_cm_sidr_req(struct ib_cm_id *cm_id,
571 struct ib_cm_sidr_req_param *param);
573 struct ib_cm_sidr_rep_param {
576 enum ib_cm_sidr_status status;
579 const void *private_data;
584 * ib_send_cm_sidr_rep - Sends a service ID resolution reply to the
586 * @cm_id: Communication identifier associated with the received service ID
587 * resolution request.
588 * @param: Service ID resolution reply information.
590 int ib_send_cm_sidr_rep(struct ib_cm_id *cm_id,
591 struct ib_cm_sidr_rep_param *param);