Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ib_cm.h
Go to the documentation of this file.
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  IB_CM_COMPARE_SIZE = 64
109 };
110 
111 struct ib_cm_id;
112 
113 struct ib_cm_req_event_param {
114  struct ib_cm_id *listen_id;
115  u8 port;
116 
117  struct ib_sa_path_rec *primary_path;
118  struct ib_sa_path_rec *alternate_path;
119 
120  __be64 remote_ca_guid;
121  u32 remote_qkey;
122  u32 remote_qpn;
123  enum ib_qp_type qp_type;
124 
125  u32 starting_psn;
126  u8 responder_resources;
127  u8 initiator_depth;
128  unsigned int local_cm_response_timeout:5;
129  unsigned int flow_control:1;
130  unsigned int remote_cm_response_timeout:5;
131  unsigned int retry_count:3;
132  unsigned int rnr_retry_count:3;
133  unsigned int srq:1;
134 };
135 
136 struct ib_cm_rep_event_param {
137  __be64 remote_ca_guid;
138  u32 remote_qkey;
139  u32 remote_qpn;
140  u32 starting_psn;
141  u8 responder_resources;
142  u8 initiator_depth;
143  unsigned int target_ack_delay:5;
144  unsigned int failover_accepted:2;
145  unsigned int flow_control:1;
146  unsigned int rnr_retry_count:3;
147  unsigned int srq:1;
148 };
149 
150 enum ib_cm_rej_reason {
151  IB_CM_REJ_NO_QP = 1,
152  IB_CM_REJ_NO_EEC = 2,
153  IB_CM_REJ_NO_RESOURCES = 3,
154  IB_CM_REJ_TIMEOUT = 4,
155  IB_CM_REJ_UNSUPPORTED = 5,
156  IB_CM_REJ_INVALID_COMM_ID = 6,
157  IB_CM_REJ_INVALID_COMM_INSTANCE = 7,
158  IB_CM_REJ_INVALID_SERVICE_ID = 8,
159  IB_CM_REJ_INVALID_TRANSPORT_TYPE = 9,
160  IB_CM_REJ_STALE_CONN = 10,
161  IB_CM_REJ_RDC_NOT_EXIST = 11,
162  IB_CM_REJ_INVALID_GID = 12,
163  IB_CM_REJ_INVALID_LID = 13,
164  IB_CM_REJ_INVALID_SL = 14,
165  IB_CM_REJ_INVALID_TRAFFIC_CLASS = 15,
166  IB_CM_REJ_INVALID_HOP_LIMIT = 16,
167  IB_CM_REJ_INVALID_PACKET_RATE = 17,
168  IB_CM_REJ_INVALID_ALT_GID = 18,
169  IB_CM_REJ_INVALID_ALT_LID = 19,
170  IB_CM_REJ_INVALID_ALT_SL = 20,
171  IB_CM_REJ_INVALID_ALT_TRAFFIC_CLASS = 21,
172  IB_CM_REJ_INVALID_ALT_HOP_LIMIT = 22,
173  IB_CM_REJ_INVALID_ALT_PACKET_RATE = 23,
174  IB_CM_REJ_PORT_CM_REDIRECT = 24,
175  IB_CM_REJ_PORT_REDIRECT = 25,
176  IB_CM_REJ_INVALID_MTU = 26,
177  IB_CM_REJ_INSUFFICIENT_RESP_RESOURCES = 27,
178  IB_CM_REJ_CONSUMER_DEFINED = 28,
179  IB_CM_REJ_INVALID_RNR_RETRY = 29,
180  IB_CM_REJ_DUPLICATE_LOCAL_COMM_ID = 30,
181  IB_CM_REJ_INVALID_CLASS_VERSION = 31,
182  IB_CM_REJ_INVALID_FLOW_LABEL = 32,
183  IB_CM_REJ_INVALID_ALT_FLOW_LABEL = 33
184 };
185 
186 struct ib_cm_rej_event_param {
187  enum ib_cm_rej_reason reason;
188  void *ari;
189  u8 ari_length;
190 };
191 
192 struct ib_cm_mra_event_param {
193  u8 service_timeout;
194 };
195 
196 struct ib_cm_lap_event_param {
197  struct ib_sa_path_rec *alternate_path;
198 };
199 
200 enum ib_cm_apr_status {
201  IB_CM_APR_SUCCESS,
202  IB_CM_APR_INVALID_COMM_ID,
203  IB_CM_APR_UNSUPPORTED,
204  IB_CM_APR_REJECT,
205  IB_CM_APR_REDIRECT,
206  IB_CM_APR_IS_CURRENT,
207  IB_CM_APR_INVALID_QPN_EECN,
208  IB_CM_APR_INVALID_LID,
209  IB_CM_APR_INVALID_GID,
210  IB_CM_APR_INVALID_FLOW_LABEL,
211  IB_CM_APR_INVALID_TCLASS,
212  IB_CM_APR_INVALID_HOP_LIMIT,
213  IB_CM_APR_INVALID_PACKET_RATE,
214  IB_CM_APR_INVALID_SL
215 };
216 
217 struct ib_cm_apr_event_param {
218  enum ib_cm_apr_status ap_status;
219  void *apr_info;
220  u8 info_len;
221 };
222 
223 struct ib_cm_sidr_req_event_param {
224  struct ib_cm_id *listen_id;
225  u8 port;
226  u16 pkey;
227 };
228 
229 enum ib_cm_sidr_status {
230  IB_SIDR_SUCCESS,
231  IB_SIDR_UNSUPPORTED,
232  IB_SIDR_REJECT,
233  IB_SIDR_NO_QP,
234  IB_SIDR_REDIRECT,
235  IB_SIDR_UNSUPPORTED_VERSION
236 };
237 
238 struct ib_cm_sidr_rep_event_param {
239  enum ib_cm_sidr_status status;
240  u32 qkey;
241  u32 qpn;
242  void *info;
243  u8 info_len;
244 };
245 
246 struct ib_cm_event {
247  enum ib_cm_event_type event;
248  union {
249  struct ib_cm_req_event_param req_rcvd;
250  struct ib_cm_rep_event_param rep_rcvd;
251  /* No data for RTU received events. */
252  struct ib_cm_rej_event_param rej_rcvd;
253  struct ib_cm_mra_event_param mra_rcvd;
254  struct ib_cm_lap_event_param lap_rcvd;
255  struct ib_cm_apr_event_param apr_rcvd;
256  /* No data for DREQ/DREP received events. */
257  struct ib_cm_sidr_req_event_param sidr_req_rcvd;
258  struct ib_cm_sidr_rep_event_param sidr_rep_rcvd;
259  enum ib_wc_status send_status;
260  } param;
261 
262  void *private_data;
263 };
264 
265 #define CM_REQ_ATTR_ID cpu_to_be16(0x0010)
266 #define CM_MRA_ATTR_ID cpu_to_be16(0x0011)
267 #define CM_REJ_ATTR_ID cpu_to_be16(0x0012)
268 #define CM_REP_ATTR_ID cpu_to_be16(0x0013)
269 #define CM_RTU_ATTR_ID cpu_to_be16(0x0014)
270 #define CM_DREQ_ATTR_ID cpu_to_be16(0x0015)
271 #define CM_DREP_ATTR_ID cpu_to_be16(0x0016)
272 #define CM_SIDR_REQ_ATTR_ID cpu_to_be16(0x0017)
273 #define CM_SIDR_REP_ATTR_ID cpu_to_be16(0x0018)
274 #define CM_LAP_ATTR_ID cpu_to_be16(0x0019)
275 #define CM_APR_ATTR_ID cpu_to_be16(0x001A)
276 
293 typedef int (*ib_cm_handler)(struct ib_cm_id *cm_id,
294  struct ib_cm_event *event);
295 
296 struct ib_cm_id {
297  ib_cm_handler cm_handler;
298  void *context;
299  struct ib_device *device;
300  __be64 service_id;
301  __be64 service_mask;
302  enum ib_cm_state state; /* internal CM/debug use */
303  enum ib_cm_lap_state lap_state; /* internal CM/debug use */
304  __be32 local_id;
305  __be32 remote_id;
306  u32 remote_cm_qpn; /* 1 unless redirected */
307 };
308 
320 struct ib_cm_id *ib_create_cm_id(struct ib_device *device,
321  ib_cm_handler cm_handler,
322  void *context);
323 
330 void ib_destroy_cm_id(struct ib_cm_id *cm_id);
331 
332 #define IB_SERVICE_ID_AGN_MASK cpu_to_be64(0xFF00000000000000ULL)
333 #define IB_CM_ASSIGN_SERVICE_ID cpu_to_be64(0x0200000000000000ULL)
334 #define IB_CMA_SERVICE_ID cpu_to_be64(0x0000000001000000ULL)
335 #define IB_CMA_SERVICE_ID_MASK cpu_to_be64(0xFFFFFFFFFF000000ULL)
336 #define IB_SDP_SERVICE_ID cpu_to_be64(0x0000000000010000ULL)
337 #define IB_SDP_SERVICE_ID_MASK cpu_to_be64(0xFFFFFFFFFFFF0000ULL)
338 
339 struct ib_cm_compare_data {
340  u8 data[IB_CM_COMPARE_SIZE];
341  u8 mask[IB_CM_COMPARE_SIZE];
342 };
343 
360 int ib_cm_listen(struct ib_cm_id *cm_id, __be64 service_id, __be64 service_mask,
361  struct ib_cm_compare_data *compare_data);
362 
363 struct ib_cm_req_param {
364  struct ib_sa_path_rec *primary_path;
365  struct ib_sa_path_rec *alternate_path;
366  __be64 service_id;
367  u32 qp_num;
368  enum ib_qp_type qp_type;
369  u32 starting_psn;
370  const void *private_data;
371  u8 private_data_len;
372  u8 peer_to_peer;
373  u8 responder_resources;
374  u8 initiator_depth;
375  u8 remote_cm_response_timeout;
376  u8 flow_control;
377  u8 local_cm_response_timeout;
378  u8 retry_count;
379  u8 rnr_retry_count;
380  u8 max_cm_retries;
381  u8 srq;
382 };
383 
391 int ib_send_cm_req(struct ib_cm_id *cm_id,
392  struct ib_cm_req_param *param);
393 
394 struct ib_cm_rep_param {
395  u32 qp_num;
396  u32 starting_psn;
397  const void *private_data;
398  u8 private_data_len;
399  u8 responder_resources;
400  u8 initiator_depth;
401  u8 failover_accepted;
402  u8 flow_control;
403  u8 rnr_retry_count;
404  u8 srq;
405 };
406 
415 int ib_send_cm_rep(struct ib_cm_id *cm_id,
416  struct ib_cm_rep_param *param);
417 
426 int ib_send_cm_rtu(struct ib_cm_id *cm_id,
427  const void *private_data,
428  u8 private_data_len);
429 
439 int ib_send_cm_dreq(struct ib_cm_id *cm_id,
440  const void *private_data,
441  u8 private_data_len);
442 
454 int ib_send_cm_drep(struct ib_cm_id *cm_id,
455  const void *private_data,
456  u8 private_data_len);
457 
472 int ib_cm_notify(struct ib_cm_id *cm_id, enum ib_event_type event);
473 
486 int ib_send_cm_rej(struct ib_cm_id *cm_id,
487  enum ib_cm_rej_reason reason,
488  void *ari,
489  u8 ari_length,
490  const void *private_data,
491  u8 private_data_len);
492 
493 #define IB_CM_MRA_FLAG_DELAY 0x80 /* Send MRA only after a duplicate msg */
494 
506 int ib_send_cm_mra(struct ib_cm_id *cm_id,
507  u8 service_timeout,
508  const void *private_data,
509  u8 private_data_len);
510 
521 int ib_send_cm_lap(struct ib_cm_id *cm_id,
522  struct ib_sa_path_rec *alternate_path,
523  const void *private_data,
524  u8 private_data_len);
525 
542 int ib_cm_init_qp_attr(struct ib_cm_id *cm_id,
543  struct ib_qp_attr *qp_attr,
544  int *qp_attr_mask);
545 
558 int ib_send_cm_apr(struct ib_cm_id *cm_id,
559  enum ib_cm_apr_status status,
560  void *info,
561  u8 info_length,
562  const void *private_data,
563  u8 private_data_len);
564 
565 struct ib_cm_sidr_req_param {
566  struct ib_sa_path_rec *path;
567  __be64 service_id;
568  int timeout_ms;
569  const void *private_data;
570  u8 private_data_len;
571  u8 max_cm_retries;
572 };
573 
581 int ib_send_cm_sidr_req(struct ib_cm_id *cm_id,
582  struct ib_cm_sidr_req_param *param);
583 
584 struct ib_cm_sidr_rep_param {
585  u32 qp_num;
586  u32 qkey;
587  enum ib_cm_sidr_status status;
588  const void *info;
589  u8 info_length;
590  const void *private_data;
591  u8 private_data_len;
592 };
593 
601 int ib_send_cm_sidr_rep(struct ib_cm_id *cm_id,
602  struct ib_cm_sidr_rep_param *param);
603 
604 #endif /* IB_CM_H */
Generated on Thu Jan 10 2013 14:53:20 for Linux Kernel by   doxygen 1.8.2