include/rdma/iw_cm.h

   1 /*
   2  * Copyright (c) 2005 Network Appliance, Inc. All rights reserved.
   3  * Copyright (c) 2005 Open Grid Computing, Inc. All rights reserved.
   4  *
   5  * This software is available to you under a choice of one of two
   6  * licenses.  You may choose to be licensed under the terms of the GNU
   7  * General Public License (GPL) Version 2, available from the file
   8  * COPYING in the main directory of this source tree, or the
   9  * OpenIB.org BSD license below:
  10  *
  11  *     Redistribution and use in source and binary forms, with or
  12  *     without modification, are permitted provided that the following
  13  *     conditions are met:
  14  *
  15  *      - Redistributions of source code must retain the above
  16  *        copyright notice, this list of conditions and the following
  17  *        disclaimer.
  18  *
  19  *      - Redistributions in binary form must reproduce the above
  20  *        copyright notice, this list of conditions and the following
  21  *        disclaimer in the documentation and/or other materials
  22  *        provided with the distribution.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  31  * SOFTWARE.
  32  */
  33 #ifndef IW_CM_H
  34 #define IW_CM_H
  35
  36 #include <linux/in.h>
  37 #include <rdma/ib_cm.h>
  38
  39 struct iw_cm_id;
  40
  41 enum iw_cm_event_type {
  42         IW_CM_EVENT_CONNECT_REQUEST = 1, /* connect request received */
  43         IW_CM_EVENT_CONNECT_REPLY,       /* reply from active connect request */
  44         IW_CM_EVENT_ESTABLISHED,         /* passive side accept successful */
  45         IW_CM_EVENT_DISCONNECT,          /* orderly shutdown */
  46         IW_CM_EVENT_CLOSE                /* close complete */
  47 };
  48
  49 struct iw_cm_event {
  50         enum iw_cm_event_type event;
  51         int                      status;
  52         struct sockaddr_storage local_addr;
  53         struct sockaddr_storage remote_addr;
  54         void *private_data;
  55         void *provider_data;
  56         u8 private_data_len;
  57         u8 ord;
  58         u8 ird;
  59 };
  60
  61 /**
  62  * iw_cm_handler - Function to be called by the IW CM when delivering events
  63  * to the client.
  64  *
  65  * @cm_id: The IW CM identifier associated with the event.
  66  * @event: Pointer to the event structure.
  67  */
  68 typedef int (*iw_cm_handler)(struct iw_cm_id *cm_id,
  69                              struct iw_cm_event *event);
  70
  71 /**
  72  * iw_event_handler - Function called by the provider when delivering provider
  73  * events to the IW CM.  Returns either 0 indicating the event was processed
  74  * or -errno if the event could not be processed.
  75  *
  76  * @cm_id: The IW CM identifier associated with the event.
  77  * @event: Pointer to the event structure.
  78  */
  79 typedef int (*iw_event_handler)(struct iw_cm_id *cm_id,
  80                                  struct iw_cm_event *event);
  81
  82 struct iw_cm_id {
  83         iw_cm_handler           cm_handler;      /* client callback function */
  84         void                    *context;        /* client cb context */
  85         struct ib_device        *device;
  86         struct sockaddr_storage local_addr;      /* local addr */
  87         struct sockaddr_storage remote_addr;
  88         struct sockaddr_storage m_local_addr;    /* nmapped local addr */
  89         struct sockaddr_storage m_remote_addr;   /* nmapped rem addr */
  90         void                    *provider_data;  /* provider private data */
  91         iw_event_handler        event_handler;   /* cb for provider
  92                                                     events */
  93         /* Used by provider to add and remove refs on IW cm_id */
  94         void (*add_ref)(struct iw_cm_id *);
  95         void (*rem_ref)(struct iw_cm_id *);
  96         u8  tos;
  97         bool mapped;
  98 };
  99
 100 struct iw_cm_conn_param {
 101         const void *private_data;
 102         u16 private_data_len;
 103         u32 ord;
 104         u32 ird;
 105         u32 qpn;
 106 };
 107
 108 struct iw_cm_verbs {
 109         void            (*add_ref)(struct ib_qp *qp);
 110
 111         void            (*rem_ref)(struct ib_qp *qp);
 112
 113         struct ib_qp *  (*get_qp)(struct ib_device *device,
 114                                   int qpn);
 115
 116         int             (*connect)(struct iw_cm_id *cm_id,
 117                                    struct iw_cm_conn_param *conn_param);
 118
 119         int             (*accept)(struct iw_cm_id *cm_id,
 120                                   struct iw_cm_conn_param *conn_param);
 121
 122         int             (*reject)(struct iw_cm_id *cm_id,
 123                                   const void *pdata, u8 pdata_len);
 124
 125         int             (*create_listen)(struct iw_cm_id *cm_id,
 126                                          int backlog);
 127
 128         int             (*destroy_listen)(struct iw_cm_id *cm_id);
 129         char            ifname[IFNAMSIZ];
 130 };
 131
 132 /**
 133  * iw_create_cm_id - Create an IW CM identifier.
 134  *
 135  * @device: The IB device on which to create the IW CM identier.
 136  * @event_handler: User callback invoked to report events associated with the
 137  *   returned IW CM identifier.
 138  * @context: User specified context associated with the id.
 139  */
 140 struct iw_cm_id *iw_create_cm_id(struct ib_device *device,
 141                                  iw_cm_handler cm_handler, void *context);
 142
 143 /**
 144  * iw_destroy_cm_id - Destroy an IW CM identifier.
 145  *
 146  * @cm_id: The previously created IW CM identifier to destroy.
 147  *
 148  * The client can assume that no events will be delivered for the CM ID after
 149  * this function returns.
 150  */
 151 void iw_destroy_cm_id(struct iw_cm_id *cm_id);
 152
 153 /**
 154  * iw_cm_bind_qp - Unbind the specified IW CM identifier and QP
 155  *
 156  * @cm_id: The IW CM idenfier to unbind from the QP.
 157  * @qp: The QP
 158  *
 159  * This is called by the provider when destroying the QP to ensure
 160  * that any references held by the IWCM are released. It may also
 161  * be called by the IWCM when destroying a CM_ID to that any
 162  * references held by the provider are released.
 163  */
 164 void iw_cm_unbind_qp(struct iw_cm_id *cm_id, struct ib_qp *qp);
 165
 166 /**
 167  * iw_cm_get_qp - Return the ib_qp associated with a QPN
 168  *
 169  * @ib_device: The IB device
 170  * @qpn: The queue pair number
 171  */
 172 struct ib_qp *iw_cm_get_qp(struct ib_device *device, int qpn);
 173
 174 /**
 175  * iw_cm_listen - Listen for incoming connection requests on the
 176  * specified IW CM id.
 177  *
 178  * @cm_id: The IW CM identifier.
 179  * @backlog: The maximum number of outstanding un-accepted inbound listen
 180  *   requests to queue.
 181  *
 182  * The source address and port number are specified in the IW CM identifier
 183  * structure.
 184  */
 185 int iw_cm_listen(struct iw_cm_id *cm_id, int backlog);
 186
 187 /**
 188  * iw_cm_accept - Called to accept an incoming connect request.
 189  *
 190  * @cm_id: The IW CM identifier associated with the connection request.
 191  * @iw_param: Pointer to a structure containing connection establishment
 192  *   parameters.
 193  *
 194  * The specified cm_id will have been provided in the event data for a
 195  * CONNECT_REQUEST event. Subsequent events related to this connection will be
 196  * delivered to the specified IW CM identifier prior and may occur prior to
 197  * the return of this function. If this function returns a non-zero value, the
 198  * client can assume that no events will be delivered to the specified IW CM
 199  * identifier.
 200  */
 201 int iw_cm_accept(struct iw_cm_id *cm_id, struct iw_cm_conn_param *iw_param);
 202
 203 /**
 204  * iw_cm_reject - Reject an incoming connection request.
 205  *
 206  * @cm_id: Connection identifier associated with the request.
 207  * @private_daa: Pointer to data to deliver to the remote peer as part of the
 208  *   reject message.
 209  * @private_data_len: The number of bytes in the private_data parameter.
 210  *
 211  * The client can assume that no events will be delivered to the specified IW
 212  * CM identifier following the return of this function. The private_data
 213  * buffer is available for reuse when this function returns.
 214  */
 215 int iw_cm_reject(struct iw_cm_id *cm_id, const void *private_data,
 216                  u8 private_data_len);
 217
 218 /**
 219  * iw_cm_connect - Called to request a connection to a remote peer.
 220  *
 221  * @cm_id: The IW CM identifier for the connection.
 222  * @iw_param: Pointer to a structure containing connection  establishment
 223  *   parameters.
 224  *
 225  * Events may be delivered to the specified IW CM identifier prior to the
 226  * return of this function. If this function returns a non-zero value, the
 227  * client can assume that no events will be delivered to the specified IW CM
 228  * identifier.
 229  */
 230 int iw_cm_connect(struct iw_cm_id *cm_id, struct iw_cm_conn_param *iw_param);
 231
 232 /**
 233  * iw_cm_disconnect - Close the specified connection.
 234  *
 235  * @cm_id: The IW CM identifier to close.
 236  * @abrupt: If 0, the connection will be closed gracefully, otherwise, the
 237  *   connection will be reset.
 238  *
 239  * The IW CM identifier is still active until the IW_CM_EVENT_CLOSE event is
 240  * delivered.
 241  */
 242 int iw_cm_disconnect(struct iw_cm_id *cm_id, int abrupt);
 243
 244 /**
 245  * iw_cm_init_qp_attr - Called to initialize the attributes of the QP
 246  * associated with a IW CM identifier.
 247  *
 248  * @cm_id: The IW CM identifier associated with the QP
 249  * @qp_attr: Pointer to the QP attributes structure.
 250  * @qp_attr_mask: Pointer to a bit vector specifying which QP attributes are
 251  *   valid.
 252  */
 253 int iw_cm_init_qp_attr(struct iw_cm_id *cm_id, struct ib_qp_attr *qp_attr,
 254                        int *qp_attr_mask);
 255
 256 /**
 257  * iwcm_reject_msg - return a pointer to a reject message string.
 258  * @reason: Value returned in the REJECT event status field.
 259  */
 260 const char *__attribute_const__ iwcm_reject_msg(int reason);
 261
 262 #endif /* IW_CM_H */