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