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