1 /* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */ 2 /* 3 * Copyright (c) 2005 Network Appliance, Inc. All rights reserved. 4 * Copyright (c) 2005 Open Grid Computing, Inc. All rights reserved. 5 */ 6 7 #ifndef IW_CM_H 8 #define IW_CM_H 9 10 #include <linux/in.h> 11 #include <rdma/ib_cm.h> 12 13 struct iw_cm_id; 14 15 enum iw_cm_event_type { 16 IW_CM_EVENT_CONNECT_REQUEST = 1, /* connect request received */ 17 IW_CM_EVENT_CONNECT_REPLY, /* reply from active connect request */ 18 IW_CM_EVENT_ESTABLISHED, /* passive side accept successful */ 19 IW_CM_EVENT_DISCONNECT, /* orderly shutdown */ 20 IW_CM_EVENT_CLOSE /* close complete */ 21 }; 22 23 struct iw_cm_event { 24 enum iw_cm_event_type event; 25 int status; 26 struct sockaddr_storage local_addr; 27 struct sockaddr_storage remote_addr; 28 void *private_data; 29 void *provider_data; 30 u8 private_data_len; 31 u8 ord; 32 u8 ird; 33 }; 34 35 /** 36 * iw_cm_handler - Function to be called by the IW CM when delivering events 37 * to the client. 38 * 39 * @cm_id: The IW CM identifier associated with the event. 40 * @event: Pointer to the event structure. 41 */ 42 typedef int (*iw_cm_handler)(struct iw_cm_id *cm_id, 43 struct iw_cm_event *event); 44 45 /** 46 * iw_event_handler - Function called by the provider when delivering provider 47 * events to the IW CM. Returns either 0 indicating the event was processed 48 * or -errno if the event could not be processed. 49 * 50 * @cm_id: The IW CM identifier associated with the event. 51 * @event: Pointer to the event structure. 52 */ 53 typedef int (*iw_event_handler)(struct iw_cm_id *cm_id, 54 struct iw_cm_event *event); 55 56 struct iw_cm_id { 57 iw_cm_handler cm_handler; /* client callback function */ 58 void *context; /* client cb context */ 59 struct ib_device *device; 60 struct sockaddr_storage local_addr; /* local addr */ 61 struct sockaddr_storage remote_addr; 62 struct sockaddr_storage m_local_addr; /* nmapped local addr */ 63 struct sockaddr_storage m_remote_addr; /* nmapped rem addr */ 64 void *provider_data; /* provider private data */ 65 iw_event_handler event_handler; /* cb for provider 66 events */ 67 /* Used by provider to add and remove refs on IW cm_id */ 68 void (*add_ref)(struct iw_cm_id *); 69 void (*rem_ref)(struct iw_cm_id *); 70 u8 tos; 71 bool tos_set:1; 72 bool mapped:1; 73 }; 74 75 struct iw_cm_conn_param { 76 const void *private_data; 77 u16 private_data_len; 78 u32 ord; 79 u32 ird; 80 u32 qpn; 81 }; 82 83 enum iw_flags { 84 85 /* 86 * This flag allows the iwcm and iwpmd to still advertise 87 * mappings but the real and mapped port numbers are the 88 * same. Further, iwpmd will not bind any user socket to 89 * reserve the port. This is required for soft iwarp 90 * to play in the port mapped iwarp space. 91 */ 92 IW_F_NO_PORT_MAP = (1 << 0), 93 }; 94 95 /** 96 * iw_create_cm_id - Create an IW CM identifier. 97 * 98 * @device: The IB device on which to create the IW CM identier. 99 * @event_handler: User callback invoked to report events associated with the 100 * returned IW CM identifier. 101 * @context: User specified context associated with the id. 102 */ 103 struct iw_cm_id *iw_create_cm_id(struct ib_device *device, 104 iw_cm_handler cm_handler, void *context); 105 106 /** 107 * iw_destroy_cm_id - Destroy an IW CM identifier. 108 * 109 * @cm_id: The previously created IW CM identifier to destroy. 110 * 111 * The client can assume that no events will be delivered for the CM ID after 112 * this function returns. 113 */ 114 void iw_destroy_cm_id(struct iw_cm_id *cm_id); 115 116 /** 117 * iw_cm_bind_qp - Unbind the specified IW CM identifier and QP 118 * 119 * @cm_id: The IW CM idenfier to unbind from the QP. 120 * @qp: The QP 121 * 122 * This is called by the provider when destroying the QP to ensure 123 * that any references held by the IWCM are released. It may also 124 * be called by the IWCM when destroying a CM_ID to that any 125 * references held by the provider are released. 126 */ 127 void iw_cm_unbind_qp(struct iw_cm_id *cm_id, struct ib_qp *qp); 128 129 /** 130 * iw_cm_get_qp - Return the ib_qp associated with a QPN 131 * 132 * @ib_device: The IB device 133 * @qpn: The queue pair number 134 */ 135 struct ib_qp *iw_cm_get_qp(struct ib_device *device, int qpn); 136 137 /** 138 * iw_cm_listen - Listen for incoming connection requests on the 139 * specified IW CM id. 140 * 141 * @cm_id: The IW CM identifier. 142 * @backlog: The maximum number of outstanding un-accepted inbound listen 143 * requests to queue. 144 * 145 * The source address and port number are specified in the IW CM identifier 146 * structure. 147 */ 148 int iw_cm_listen(struct iw_cm_id *cm_id, int backlog); 149 150 /** 151 * iw_cm_accept - Called to accept an incoming connect request. 152 * 153 * @cm_id: The IW CM identifier associated with the connection request. 154 * @iw_param: Pointer to a structure containing connection establishment 155 * parameters. 156 * 157 * The specified cm_id will have been provided in the event data for a 158 * CONNECT_REQUEST event. Subsequent events related to this connection will be 159 * delivered to the specified IW CM identifier prior and may occur prior to 160 * the return of this function. If this function returns a non-zero value, the 161 * client can assume that no events will be delivered to the specified IW CM 162 * identifier. 163 */ 164 int iw_cm_accept(struct iw_cm_id *cm_id, struct iw_cm_conn_param *iw_param); 165 166 /** 167 * iw_cm_reject - Reject an incoming connection request. 168 * 169 * @cm_id: Connection identifier associated with the request. 170 * @private_daa: Pointer to data to deliver to the remote peer as part of the 171 * reject message. 172 * @private_data_len: The number of bytes in the private_data parameter. 173 * 174 * The client can assume that no events will be delivered to the specified IW 175 * CM identifier following the return of this function. The private_data 176 * buffer is available for reuse when this function returns. 177 */ 178 int iw_cm_reject(struct iw_cm_id *cm_id, const void *private_data, 179 u8 private_data_len); 180 181 /** 182 * iw_cm_connect - Called to request a connection to a remote peer. 183 * 184 * @cm_id: The IW CM identifier for the connection. 185 * @iw_param: Pointer to a structure containing connection establishment 186 * parameters. 187 * 188 * Events may be delivered to the specified IW CM identifier prior to the 189 * return of this function. If this function returns a non-zero value, the 190 * client can assume that no events will be delivered to the specified IW CM 191 * identifier. 192 */ 193 int iw_cm_connect(struct iw_cm_id *cm_id, struct iw_cm_conn_param *iw_param); 194 195 /** 196 * iw_cm_disconnect - Close the specified connection. 197 * 198 * @cm_id: The IW CM identifier to close. 199 * @abrupt: If 0, the connection will be closed gracefully, otherwise, the 200 * connection will be reset. 201 * 202 * The IW CM identifier is still active until the IW_CM_EVENT_CLOSE event is 203 * delivered. 204 */ 205 int iw_cm_disconnect(struct iw_cm_id *cm_id, int abrupt); 206 207 /** 208 * iw_cm_init_qp_attr - Called to initialize the attributes of the QP 209 * associated with a IW CM identifier. 210 * 211 * @cm_id: The IW CM identifier associated with the QP 212 * @qp_attr: Pointer to the QP attributes structure. 213 * @qp_attr_mask: Pointer to a bit vector specifying which QP attributes are 214 * valid. 215 */ 216 int iw_cm_init_qp_attr(struct iw_cm_id *cm_id, struct ib_qp_attr *qp_attr, 217 int *qp_attr_mask); 218 219 /** 220 * iwcm_reject_msg - return a pointer to a reject message string. 221 * @reason: Value returned in the REJECT event status field. 222 */ 223 const char *__attribute_const__ iwcm_reject_msg(int reason); 224 225 #endif /* IW_CM_H */ 226