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