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
38 #include <rdma/ib_mad.h>
39 #include <rdma/ib_sa.h>
41 /* ib_cm and ib_user_cm modules share /sys/class/infiniband_cm */
42 extern struct class cm_class;
63 enum ib_cm_lap_state {
72 enum ib_cm_event_type {
78 IB_CM_USER_ESTABLISHED,
89 IB_CM_SIDR_REQ_RECEIVED,
90 IB_CM_SIDR_REP_RECEIVED
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,
112 struct ib_cm_req_event_param {
113 struct ib_cm_id *listen_id;
115 /* P_Key that was used by the GMP's BTH header */
120 struct sa_path_rec *primary_path;
121 struct 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 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;
229 /* P_Key that was used by the GMP's BTH header */
235 enum ib_cm_sidr_status {
241 IB_SIDR_UNSUPPORTED_VERSION
244 struct ib_cm_sidr_rep_event_param {
245 enum ib_cm_sidr_status status;
253 enum ib_cm_event_type event;
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;
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)
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.
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.
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.
299 typedef int (*ib_cm_handler)(struct ib_cm_id *cm_id,
300 struct ib_cm_event *event);
303 ib_cm_handler cm_handler;
305 struct ib_device *device;
308 enum ib_cm_state state; /* internal CM/debug use */
309 enum ib_cm_lap_state lap_state; /* internal CM/debug use */
312 u32 remote_cm_qpn; /* 1 unless redirected */
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
323 * Communication identifiers are used to track connection states, service
324 * ID resolution requests, and listen requests.
326 struct ib_cm_id *ib_create_cm_id(struct ib_device *device,
327 ib_cm_handler cm_handler,
331 * ib_destroy_cm_id - Destroy a connection identifier.
332 * @cm_id: Connection identifier to destroy.
334 * This call blocks until the connection identifier is destroyed.
336 void ib_destroy_cm_id(struct ib_cm_id *cm_id);
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)
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.
358 int ib_cm_listen(struct ib_cm_id *cm_id, __be64 service_id,
359 __be64 service_mask);
361 struct ib_cm_id *ib_cm_insert_listen(struct ib_device *device,
362 ib_cm_handler cm_handler,
365 struct ib_cm_req_param {
366 struct sa_path_rec *primary_path;
367 struct sa_path_rec *alternate_path;
370 enum ib_qp_type qp_type;
372 const void *private_data;
375 u8 responder_resources;
377 u8 remote_cm_response_timeout;
379 u8 local_cm_response_timeout;
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
393 int ib_send_cm_req(struct ib_cm_id *cm_id,
394 struct ib_cm_req_param *param);
396 struct ib_cm_rep_param {
399 const void *private_data;
401 u8 responder_resources;
403 u8 failover_accepted;
410 * ib_send_cm_rep - Sends a connection reply in response to a connection
412 * @cm_id: Connection identifier that will be associated with the
413 * connection request.
414 * @param: Connection reply information needed to establish the
417 int ib_send_cm_rep(struct ib_cm_id *cm_id,
418 struct ib_cm_rep_param *param);
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.
428 int ib_send_cm_rtu(struct ib_cm_id *cm_id,
429 const void *private_data,
430 u8 private_data_len);
433 * ib_send_cm_dreq - Sends a disconnection request for an existing
435 * @cm_id: Connection identifier associated with the connection being
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.
441 int ib_send_cm_dreq(struct ib_cm_id *cm_id,
442 const void *private_data,
443 u8 private_data_len);
446 * ib_send_cm_drep - Sends a disconnection reply to a disconnection request.
447 * @cm_id: Connection identifier associated with the connection being
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.
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.
456 int ib_send_cm_drep(struct ib_cm_id *cm_id,
457 const void *private_data,
458 u8 private_data_len);
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.
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:
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.
474 int ib_cm_notify(struct ib_cm_id *cm_id, enum ib_event_type event);
477 * ib_send_cm_rej - Sends a connection rejection message to the
479 * @cm_id: Connection identifier associated with the connection being
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
486 * @private_data_len: Size of the private data buffer, in bytes.
488 int ib_send_cm_rej(struct ib_cm_id *cm_id,
489 enum ib_cm_rej_reason reason,
492 const void *private_data,
493 u8 private_data_len);
495 #define IB_CM_MRA_FLAG_DELAY 0x80 /* Send MRA only after a duplicate msg */
498 * ib_send_cm_mra - Sends a message receipt acknowledgement to a connection
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.
508 int ib_send_cm_mra(struct ib_cm_id *cm_id,
510 const void *private_data,
511 u8 private_data_len);
514 * ib_send_cm_lap - Sends a load alternate path request.
515 * @cm_id: Connection identifier associated with the load alternate path
517 * @alternate_path: A path record that identifies the alternate path to
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.
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);
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
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.
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.
544 int ib_cm_init_qp_attr(struct ib_cm_id *cm_id,
545 struct ib_qp_attr *qp_attr,
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
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.
560 int ib_send_cm_apr(struct ib_cm_id *cm_id,
561 enum ib_cm_apr_status status,
564 const void *private_data,
565 u8 private_data_len);
567 struct ib_cm_sidr_req_param {
568 struct sa_path_rec *path;
571 const void *private_data;
577 * ib_send_cm_sidr_req - Sends a service ID resolution request to the
579 * @cm_id: Communication identifier that will be associated with the
580 * service ID resolution request.
581 * @param: Service ID resolution request information.
583 int ib_send_cm_sidr_req(struct ib_cm_id *cm_id,
584 struct ib_cm_sidr_req_param *param);
586 struct ib_cm_sidr_rep_param {
589 enum ib_cm_sidr_status status;
592 const void *private_data;
597 * ib_send_cm_sidr_rep - Sends a service ID resolution reply to the
599 * @cm_id: Communication identifier associated with the received service ID
600 * resolution request.
601 * @param: Service ID resolution reply information.
603 int ib_send_cm_sidr_rep(struct ib_cm_id *cm_id,
604 struct ib_cm_sidr_rep_param *param);
607 * ibcm_reject_msg - return a pointer to a reject message string.
608 * @reason: Value returned in the REJECT event status field.
610 const char *__attribute_const__ ibcm_reject_msg(int reason);