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; 87 struct sockaddr_storage remote_addr; 88 void *provider_data; /* provider private data */ 89 iw_event_handler event_handler; /* cb for provider 90 events */ 91 /* Used by provider to add and remove refs on IW cm_id */ 92 void (*add_ref)(struct iw_cm_id *); 93 void (*rem_ref)(struct iw_cm_id *); 94 }; 95 96 struct iw_cm_conn_param { 97 const void *private_data; 98 u16 private_data_len; 99 u32 ord; 100 u32 ird; 101 u32 qpn; 102 }; 103 104 struct iw_cm_verbs { 105 void (*add_ref)(struct ib_qp *qp); 106 107 void (*rem_ref)(struct ib_qp *qp); 108 109 struct ib_qp * (*get_qp)(struct ib_device *device, 110 int qpn); 111 112 int (*connect)(struct iw_cm_id *cm_id, 113 struct iw_cm_conn_param *conn_param); 114 115 int (*accept)(struct iw_cm_id *cm_id, 116 struct iw_cm_conn_param *conn_param); 117 118 int (*reject)(struct iw_cm_id *cm_id, 119 const void *pdata, u8 pdata_len); 120 121 int (*create_listen)(struct iw_cm_id *cm_id, 122 int backlog); 123 124 int (*destroy_listen)(struct iw_cm_id *cm_id); 125 }; 126 127 /** 128 * iw_create_cm_id - Create an IW CM identifier. 129 * 130 * @device: The IB device on which to create the IW CM identier. 131 * @event_handler: User callback invoked to report events associated with the 132 * returned IW CM identifier. 133 * @context: User specified context associated with the id. 134 */ 135 struct iw_cm_id *iw_create_cm_id(struct ib_device *device, 136 iw_cm_handler cm_handler, void *context); 137 138 /** 139 * iw_destroy_cm_id - Destroy an IW CM identifier. 140 * 141 * @cm_id: The previously created IW CM identifier to destroy. 142 * 143 * The client can assume that no events will be delivered for the CM ID after 144 * this function returns. 145 */ 146 void iw_destroy_cm_id(struct iw_cm_id *cm_id); 147 148 /** 149 * iw_cm_bind_qp - Unbind the specified IW CM identifier and QP 150 * 151 * @cm_id: The IW CM idenfier to unbind from the QP. 152 * @qp: The QP 153 * 154 * This is called by the provider when destroying the QP to ensure 155 * that any references held by the IWCM are released. It may also 156 * be called by the IWCM when destroying a CM_ID to that any 157 * references held by the provider are released. 158 */ 159 void iw_cm_unbind_qp(struct iw_cm_id *cm_id, struct ib_qp *qp); 160 161 /** 162 * iw_cm_get_qp - Return the ib_qp associated with a QPN 163 * 164 * @ib_device: The IB device 165 * @qpn: The queue pair number 166 */ 167 struct ib_qp *iw_cm_get_qp(struct ib_device *device, int qpn); 168 169 /** 170 * iw_cm_listen - Listen for incoming connection requests on the 171 * specified IW CM id. 172 * 173 * @cm_id: The IW CM identifier. 174 * @backlog: The maximum number of outstanding un-accepted inbound listen 175 * requests to queue. 176 * 177 * The source address and port number are specified in the IW CM identifier 178 * structure. 179 */ 180 int iw_cm_listen(struct iw_cm_id *cm_id, int backlog); 181 182 /** 183 * iw_cm_accept - Called to accept an incoming connect request. 184 * 185 * @cm_id: The IW CM identifier associated with the connection request. 186 * @iw_param: Pointer to a structure containing connection establishment 187 * parameters. 188 * 189 * The specified cm_id will have been provided in the event data for a 190 * CONNECT_REQUEST event. Subsequent events related to this connection will be 191 * delivered to the specified IW CM identifier prior and may occur prior to 192 * the return of this function. If this function returns a non-zero value, the 193 * client can assume that no events will be delivered to the specified IW CM 194 * identifier. 195 */ 196 int iw_cm_accept(struct iw_cm_id *cm_id, struct iw_cm_conn_param *iw_param); 197 198 /** 199 * iw_cm_reject - Reject an incoming connection request. 200 * 201 * @cm_id: Connection identifier associated with the request. 202 * @private_daa: Pointer to data to deliver to the remote peer as part of the 203 * reject message. 204 * @private_data_len: The number of bytes in the private_data parameter. 205 * 206 * The client can assume that no events will be delivered to the specified IW 207 * CM identifier following the return of this function. The private_data 208 * buffer is available for reuse when this function returns. 209 */ 210 int iw_cm_reject(struct iw_cm_id *cm_id, const void *private_data, 211 u8 private_data_len); 212 213 /** 214 * iw_cm_connect - Called to request a connection to a remote peer. 215 * 216 * @cm_id: The IW CM identifier for the connection. 217 * @iw_param: Pointer to a structure containing connection establishment 218 * parameters. 219 * 220 * Events may be delivered to the specified IW CM identifier prior to the 221 * return of this function. If this function returns a non-zero value, the 222 * client can assume that no events will be delivered to the specified IW CM 223 * identifier. 224 */ 225 int iw_cm_connect(struct iw_cm_id *cm_id, struct iw_cm_conn_param *iw_param); 226 227 /** 228 * iw_cm_disconnect - Close the specified connection. 229 * 230 * @cm_id: The IW CM identifier to close. 231 * @abrupt: If 0, the connection will be closed gracefully, otherwise, the 232 * connection will be reset. 233 * 234 * The IW CM identifier is still active until the IW_CM_EVENT_CLOSE event is 235 * delivered. 236 */ 237 int iw_cm_disconnect(struct iw_cm_id *cm_id, int abrupt); 238 239 /** 240 * iw_cm_init_qp_attr - Called to initialize the attributes of the QP 241 * associated with a IW CM identifier. 242 * 243 * @cm_id: The IW CM identifier associated with the QP 244 * @qp_attr: Pointer to the QP attributes structure. 245 * @qp_attr_mask: Pointer to a bit vector specifying which QP attributes are 246 * valid. 247 */ 248 int iw_cm_init_qp_attr(struct iw_cm_id *cm_id, struct ib_qp_attr *qp_attr, 249 int *qp_attr_mask); 250 251 #endif /* IW_CM_H */ 252