iw_cm.h 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  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. #include <linux/in.h>
  36. #include <rdma/ib_cm.h>
  37. struct iw_cm_id;
  38. enum iw_cm_event_type {
  39. IW_CM_EVENT_CONNECT_REQUEST = 1, /* connect request received */
  40. IW_CM_EVENT_CONNECT_REPLY, /* reply from active connect request */
  41. IW_CM_EVENT_ESTABLISHED, /* passive side accept successful */
  42. IW_CM_EVENT_DISCONNECT, /* orderly shutdown */
  43. IW_CM_EVENT_CLOSE /* close complete */
  44. };
  45. enum iw_cm_event_status {
  46. IW_CM_EVENT_STATUS_OK = 0, /* request successful */
  47. IW_CM_EVENT_STATUS_ACCEPTED = 0, /* connect request accepted */
  48. IW_CM_EVENT_STATUS_REJECTED, /* connect request rejected */
  49. IW_CM_EVENT_STATUS_TIMEOUT, /* the operation timed out */
  50. IW_CM_EVENT_STATUS_RESET, /* reset from remote peer */
  51. IW_CM_EVENT_STATUS_EINVAL, /* asynchronous failure for bad parm */
  52. };
  53. struct iw_cm_event {
  54. enum iw_cm_event_type event;
  55. enum iw_cm_event_status status;
  56. struct sockaddr_in local_addr;
  57. struct sockaddr_in remote_addr;
  58. void *private_data;
  59. u8 private_data_len;
  60. void* provider_data;
  61. };
  62. /**
  63. * iw_cm_handler - Function to be called by the IW CM when delivering events
  64. * to the client.
  65. *
  66. * @cm_id: The IW CM identifier associated with the event.
  67. * @event: Pointer to the event structure.
  68. */
  69. typedef int (*iw_cm_handler)(struct iw_cm_id *cm_id,
  70. struct iw_cm_event *event);
  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. struct iw_cm_id {
  82. iw_cm_handler cm_handler; /* client callback function */
  83. void *context; /* client cb context */
  84. struct ib_device *device;
  85. struct sockaddr_in local_addr;
  86. struct sockaddr_in remote_addr;
  87. void *provider_data; /* provider private data */
  88. iw_event_handler event_handler; /* cb for provider
  89. events */
  90. /* Used by provider to add and remove refs on IW cm_id */
  91. void (*add_ref)(struct iw_cm_id *);
  92. void (*rem_ref)(struct iw_cm_id *);
  93. };
  94. struct iw_cm_conn_param {
  95. const void *private_data;
  96. u16 private_data_len;
  97. u32 ord;
  98. u32 ird;
  99. u32 qpn;
  100. };
  101. struct iw_cm_verbs {
  102. void (*add_ref)(struct ib_qp *qp);
  103. void (*rem_ref)(struct ib_qp *qp);
  104. struct ib_qp * (*get_qp)(struct ib_device *device,
  105. int qpn);
  106. int (*connect)(struct iw_cm_id *cm_id,
  107. struct iw_cm_conn_param *conn_param);
  108. int (*accept)(struct iw_cm_id *cm_id,
  109. struct iw_cm_conn_param *conn_param);
  110. int (*reject)(struct iw_cm_id *cm_id,
  111. const void *pdata, u8 pdata_len);
  112. int (*create_listen)(struct iw_cm_id *cm_id,
  113. int backlog);
  114. int (*destroy_listen)(struct iw_cm_id *cm_id);
  115. };
  116. /**
  117. * iw_create_cm_id - Create an IW CM identifier.
  118. *
  119. * @device: The IB device on which to create the IW CM identier.
  120. * @event_handler: User callback invoked to report events associated with the
  121. * returned IW CM identifier.
  122. * @context: User specified context associated with the id.
  123. */
  124. struct iw_cm_id *iw_create_cm_id(struct ib_device *device,
  125. iw_cm_handler cm_handler, void *context);
  126. /**
  127. * iw_destroy_cm_id - Destroy an IW CM identifier.
  128. *
  129. * @cm_id: The previously created IW CM identifier to destroy.
  130. *
  131. * The client can assume that no events will be delivered for the CM ID after
  132. * this function returns.
  133. */
  134. void iw_destroy_cm_id(struct iw_cm_id *cm_id);
  135. /**
  136. * iw_cm_bind_qp - Unbind the specified IW CM identifier and QP
  137. *
  138. * @cm_id: The IW CM idenfier to unbind from the QP.
  139. * @qp: The QP
  140. *
  141. * This is called by the provider when destroying the QP to ensure
  142. * that any references held by the IWCM are released. It may also
  143. * be called by the IWCM when destroying a CM_ID to that any
  144. * references held by the provider are released.
  145. */
  146. void iw_cm_unbind_qp(struct iw_cm_id *cm_id, struct ib_qp *qp);
  147. /**
  148. * iw_cm_get_qp - Return the ib_qp associated with a QPN
  149. *
  150. * @ib_device: The IB device
  151. * @qpn: The queue pair number
  152. */
  153. struct ib_qp *iw_cm_get_qp(struct ib_device *device, int qpn);
  154. /**
  155. * iw_cm_listen - Listen for incoming connection requests on the
  156. * specified IW CM id.
  157. *
  158. * @cm_id: The IW CM identifier.
  159. * @backlog: The maximum number of outstanding un-accepted inbound listen
  160. * requests to queue.
  161. *
  162. * The source address and port number are specified in the IW CM identifier
  163. * structure.
  164. */
  165. int iw_cm_listen(struct iw_cm_id *cm_id, int backlog);
  166. /**
  167. * iw_cm_accept - Called to accept an incoming connect request.
  168. *
  169. * @cm_id: The IW CM identifier associated with the connection request.
  170. * @iw_param: Pointer to a structure containing connection establishment
  171. * parameters.
  172. *
  173. * The specified cm_id will have been provided in the event data for a
  174. * CONNECT_REQUEST event. Subsequent events related to this connection will be
  175. * delivered to the specified IW CM identifier prior and may occur prior to
  176. * the return of this function. If this function returns a non-zero value, the
  177. * client can assume that no events will be delivered to the specified IW CM
  178. * identifier.
  179. */
  180. int iw_cm_accept(struct iw_cm_id *cm_id, struct iw_cm_conn_param *iw_param);
  181. /**
  182. * iw_cm_reject - Reject an incoming connection request.
  183. *
  184. * @cm_id: Connection identifier associated with the request.
  185. * @private_daa: Pointer to data to deliver to the remote peer as part of the
  186. * reject message.
  187. * @private_data_len: The number of bytes in the private_data parameter.
  188. *
  189. * The client can assume that no events will be delivered to the specified IW
  190. * CM identifier following the return of this function. The private_data
  191. * buffer is available for reuse when this function returns.
  192. */
  193. int iw_cm_reject(struct iw_cm_id *cm_id, const void *private_data,
  194. u8 private_data_len);
  195. /**
  196. * iw_cm_connect - Called to request a connection to a remote peer.
  197. *
  198. * @cm_id: The IW CM identifier for the connection.
  199. * @iw_param: Pointer to a structure containing connection establishment
  200. * parameters.
  201. *
  202. * Events may be delivered to the specified IW CM identifier prior to the
  203. * return of this function. If this function returns a non-zero value, the
  204. * client can assume that no events will be delivered to the specified IW CM
  205. * identifier.
  206. */
  207. int iw_cm_connect(struct iw_cm_id *cm_id, struct iw_cm_conn_param *iw_param);
  208. /**
  209. * iw_cm_disconnect - Close the specified connection.
  210. *
  211. * @cm_id: The IW CM identifier to close.
  212. * @abrupt: If 0, the connection will be closed gracefully, otherwise, the
  213. * connection will be reset.
  214. *
  215. * The IW CM identifier is still active until the IW_CM_EVENT_CLOSE event is
  216. * delivered.
  217. */
  218. int iw_cm_disconnect(struct iw_cm_id *cm_id, int abrupt);
  219. /**
  220. * iw_cm_init_qp_attr - Called to initialize the attributes of the QP
  221. * associated with a IW CM identifier.
  222. *
  223. * @cm_id: The IW CM identifier associated with the QP
  224. * @qp_attr: Pointer to the QP attributes structure.
  225. * @qp_attr_mask: Pointer to a bit vector specifying which QP attributes are
  226. * valid.
  227. */
  228. int iw_cm_init_qp_attr(struct iw_cm_id *cm_id, struct ib_qp_attr *qp_attr,
  229. int *qp_attr_mask);
  230. #endif /* IW_CM_H */