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 enum iw_flags { 109 110 /* 111 * This flag allows the iwcm and iwpmd to still advertise 112 * mappings but the real and mapped port numbers are the 113 * same. Further, iwpmd will not bind any user socket to 114 * reserve the port. This is required for soft iwarp 115 * to play in the port mapped iwarp space. 116 */ 117 IW_F_NO_PORT_MAP = (1 << 0), 118 }; 119 120 struct iw_cm_verbs { 121 void (*add_ref)(struct ib_qp *qp); 122 123 void (*rem_ref)(struct ib_qp *qp); 124 125 struct ib_qp * (*get_qp)(struct ib_device *device, 126 int qpn); 127 128 int (*connect)(struct iw_cm_id *cm_id, 129 struct iw_cm_conn_param *conn_param); 130 131 int (*accept)(struct iw_cm_id *cm_id, 132 struct iw_cm_conn_param *conn_param); 133 134 int (*reject)(struct iw_cm_id *cm_id, 135 const void *pdata, u8 pdata_len); 136 137 int (*create_listen)(struct iw_cm_id *cm_id, 138 int backlog); 139 140 int (*destroy_listen)(struct iw_cm_id *cm_id); 141 char ifname[IFNAMSIZ]; 142 enum iw_flags driver_flags; 143 }; 144 145 /** 146 * iw_create_cm_id - Create an IW CM identifier. 147 * 148 * @device: The IB device on which to create the IW CM identier. 149 * @event_handler: User callback invoked to report events associated with the 150 * returned IW CM identifier. 151 * @context: User specified context associated with the id. 152 */ 153 struct iw_cm_id *iw_create_cm_id(struct ib_device *device, 154 iw_cm_handler cm_handler, void *context); 155 156 /** 157 * iw_destroy_cm_id - Destroy an IW CM identifier. 158 * 159 * @cm_id: The previously created IW CM identifier to destroy. 160 * 161 * The client can assume that no events will be delivered for the CM ID after 162 * this function returns. 163 */ 164 void iw_destroy_cm_id(struct iw_cm_id *cm_id); 165 166 /** 167 * iw_cm_bind_qp - Unbind the specified IW CM identifier and QP 168 * 169 * @cm_id: The IW CM idenfier to unbind from the QP. 170 * @qp: The QP 171 * 172 * This is called by the provider when destroying the QP to ensure 173 * that any references held by the IWCM are released. It may also 174 * be called by the IWCM when destroying a CM_ID to that any 175 * references held by the provider are released. 176 */ 177 void iw_cm_unbind_qp(struct iw_cm_id *cm_id, struct ib_qp *qp); 178 179 /** 180 * iw_cm_get_qp - Return the ib_qp associated with a QPN 181 * 182 * @ib_device: The IB device 183 * @qpn: The queue pair number 184 */ 185 struct ib_qp *iw_cm_get_qp(struct ib_device *device, int qpn); 186 187 /** 188 * iw_cm_listen - Listen for incoming connection requests on the 189 * specified IW CM id. 190 * 191 * @cm_id: The IW CM identifier. 192 * @backlog: The maximum number of outstanding un-accepted inbound listen 193 * requests to queue. 194 * 195 * The source address and port number are specified in the IW CM identifier 196 * structure. 197 */ 198 int iw_cm_listen(struct iw_cm_id *cm_id, int backlog); 199 200 /** 201 * iw_cm_accept - Called to accept an incoming connect request. 202 * 203 * @cm_id: The IW CM identifier associated with the connection request. 204 * @iw_param: Pointer to a structure containing connection establishment 205 * parameters. 206 * 207 * The specified cm_id will have been provided in the event data for a 208 * CONNECT_REQUEST event. Subsequent events related to this connection will be 209 * delivered to the specified IW CM identifier prior and may occur prior to 210 * the return of this function. If this function returns a non-zero value, the 211 * client can assume that no events will be delivered to the specified IW CM 212 * identifier. 213 */ 214 int iw_cm_accept(struct iw_cm_id *cm_id, struct iw_cm_conn_param *iw_param); 215 216 /** 217 * iw_cm_reject - Reject an incoming connection request. 218 * 219 * @cm_id: Connection identifier associated with the request. 220 * @private_daa: Pointer to data to deliver to the remote peer as part of the 221 * reject message. 222 * @private_data_len: The number of bytes in the private_data parameter. 223 * 224 * The client can assume that no events will be delivered to the specified IW 225 * CM identifier following the return of this function. The private_data 226 * buffer is available for reuse when this function returns. 227 */ 228 int iw_cm_reject(struct iw_cm_id *cm_id, const void *private_data, 229 u8 private_data_len); 230 231 /** 232 * iw_cm_connect - Called to request a connection to a remote peer. 233 * 234 * @cm_id: The IW CM identifier for the connection. 235 * @iw_param: Pointer to a structure containing connection establishment 236 * parameters. 237 * 238 * Events may be delivered to the specified IW CM identifier prior to the 239 * return of this function. If this function returns a non-zero value, the 240 * client can assume that no events will be delivered to the specified IW CM 241 * identifier. 242 */ 243 int iw_cm_connect(struct iw_cm_id *cm_id, struct iw_cm_conn_param *iw_param); 244 245 /** 246 * iw_cm_disconnect - Close the specified connection. 247 * 248 * @cm_id: The IW CM identifier to close. 249 * @abrupt: If 0, the connection will be closed gracefully, otherwise, the 250 * connection will be reset. 251 * 252 * The IW CM identifier is still active until the IW_CM_EVENT_CLOSE event is 253 * delivered. 254 */ 255 int iw_cm_disconnect(struct iw_cm_id *cm_id, int abrupt); 256 257 /** 258 * iw_cm_init_qp_attr - Called to initialize the attributes of the QP 259 * associated with a IW CM identifier. 260 * 261 * @cm_id: The IW CM identifier associated with the QP 262 * @qp_attr: Pointer to the QP attributes structure. 263 * @qp_attr_mask: Pointer to a bit vector specifying which QP attributes are 264 * valid. 265 */ 266 int iw_cm_init_qp_attr(struct iw_cm_id *cm_id, struct ib_qp_attr *qp_attr, 267 int *qp_attr_mask); 268 269 /** 270 * iwcm_reject_msg - return a pointer to a reject message string. 271 * @reason: Value returned in the REJECT event status field. 272 */ 273 const char *__attribute_const__ iwcm_reject_msg(int reason); 274 275 #endif /* IW_CM_H */ 276