ib_cm.h 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607
  1. /*
  2. * Copyright (c) 2004, 2005 Intel Corporation. All rights reserved.
  3. * Copyright (c) 2004 Topspin Corporation. All rights reserved.
  4. * Copyright (c) 2004 Voltaire Corporation. All rights reserved.
  5. * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
  6. *
  7. * This software is available to you under a choice of one of two
  8. * licenses. You may choose to be licensed under the terms of the GNU
  9. * General Public License (GPL) Version 2, available from the file
  10. * COPYING in the main directory of this source tree, or the
  11. * OpenIB.org BSD license below:
  12. *
  13. * Redistribution and use in source and binary forms, with or
  14. * without modification, are permitted provided that the following
  15. * conditions are met:
  16. *
  17. * - Redistributions of source code must retain the above
  18. * copyright notice, this list of conditions and the following
  19. * disclaimer.
  20. *
  21. * - Redistributions in binary form must reproduce the above
  22. * copyright notice, this list of conditions and the following
  23. * disclaimer in the documentation and/or other materials
  24. * provided with the distribution.
  25. *
  26. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  27. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  28. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  29. * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  30. * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  31. * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  32. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  33. * SOFTWARE.
  34. */
  35. #if !defined(IB_CM_H)
  36. #define IB_CM_H
  37. #include <rdma/ib_mad.h>
  38. #include <rdma/ib_sa.h>
  39. /* ib_cm and ib_user_cm modules share /sys/class/infiniband_cm */
  40. extern struct class cm_class;
  41. enum ib_cm_state {
  42. IB_CM_IDLE,
  43. IB_CM_LISTEN,
  44. IB_CM_REQ_SENT,
  45. IB_CM_REQ_RCVD,
  46. IB_CM_MRA_REQ_SENT,
  47. IB_CM_MRA_REQ_RCVD,
  48. IB_CM_REP_SENT,
  49. IB_CM_REP_RCVD,
  50. IB_CM_MRA_REP_SENT,
  51. IB_CM_MRA_REP_RCVD,
  52. IB_CM_ESTABLISHED,
  53. IB_CM_DREQ_SENT,
  54. IB_CM_DREQ_RCVD,
  55. IB_CM_TIMEWAIT,
  56. IB_CM_SIDR_REQ_SENT,
  57. IB_CM_SIDR_REQ_RCVD
  58. };
  59. enum ib_cm_lap_state {
  60. IB_CM_LAP_UNINIT,
  61. IB_CM_LAP_IDLE,
  62. IB_CM_LAP_SENT,
  63. IB_CM_LAP_RCVD,
  64. IB_CM_MRA_LAP_SENT,
  65. IB_CM_MRA_LAP_RCVD,
  66. };
  67. enum ib_cm_event_type {
  68. IB_CM_REQ_ERROR,
  69. IB_CM_REQ_RECEIVED,
  70. IB_CM_REP_ERROR,
  71. IB_CM_REP_RECEIVED,
  72. IB_CM_RTU_RECEIVED,
  73. IB_CM_USER_ESTABLISHED,
  74. IB_CM_DREQ_ERROR,
  75. IB_CM_DREQ_RECEIVED,
  76. IB_CM_DREP_RECEIVED,
  77. IB_CM_TIMEWAIT_EXIT,
  78. IB_CM_MRA_RECEIVED,
  79. IB_CM_REJ_RECEIVED,
  80. IB_CM_LAP_ERROR,
  81. IB_CM_LAP_RECEIVED,
  82. IB_CM_APR_RECEIVED,
  83. IB_CM_SIDR_REQ_ERROR,
  84. IB_CM_SIDR_REQ_RECEIVED,
  85. IB_CM_SIDR_REP_RECEIVED
  86. };
  87. enum ib_cm_data_size {
  88. IB_CM_REQ_PRIVATE_DATA_SIZE = 92,
  89. IB_CM_MRA_PRIVATE_DATA_SIZE = 222,
  90. IB_CM_REJ_PRIVATE_DATA_SIZE = 148,
  91. IB_CM_REP_PRIVATE_DATA_SIZE = 196,
  92. IB_CM_RTU_PRIVATE_DATA_SIZE = 224,
  93. IB_CM_DREQ_PRIVATE_DATA_SIZE = 220,
  94. IB_CM_DREP_PRIVATE_DATA_SIZE = 224,
  95. IB_CM_REJ_ARI_LENGTH = 72,
  96. IB_CM_LAP_PRIVATE_DATA_SIZE = 168,
  97. IB_CM_APR_PRIVATE_DATA_SIZE = 148,
  98. IB_CM_APR_INFO_LENGTH = 72,
  99. IB_CM_SIDR_REQ_PRIVATE_DATA_SIZE = 216,
  100. IB_CM_SIDR_REP_PRIVATE_DATA_SIZE = 136,
  101. IB_CM_SIDR_REP_INFO_LENGTH = 72,
  102. };
  103. struct ib_cm_id;
  104. struct ib_cm_req_event_param {
  105. struct ib_cm_id *listen_id;
  106. /* P_Key that was used by the GMP's BTH header */
  107. u16 bth_pkey;
  108. u8 port;
  109. struct ib_sa_path_rec *primary_path;
  110. struct ib_sa_path_rec *alternate_path;
  111. __be64 remote_ca_guid;
  112. u32 remote_qkey;
  113. u32 remote_qpn;
  114. enum ib_qp_type qp_type;
  115. u32 starting_psn;
  116. u8 responder_resources;
  117. u8 initiator_depth;
  118. unsigned int local_cm_response_timeout:5;
  119. unsigned int flow_control:1;
  120. unsigned int remote_cm_response_timeout:5;
  121. unsigned int retry_count:3;
  122. unsigned int rnr_retry_count:3;
  123. unsigned int srq:1;
  124. };
  125. struct ib_cm_rep_event_param {
  126. __be64 remote_ca_guid;
  127. u32 remote_qkey;
  128. u32 remote_qpn;
  129. u32 starting_psn;
  130. u8 responder_resources;
  131. u8 initiator_depth;
  132. unsigned int target_ack_delay:5;
  133. unsigned int failover_accepted:2;
  134. unsigned int flow_control:1;
  135. unsigned int rnr_retry_count:3;
  136. unsigned int srq:1;
  137. };
  138. enum ib_cm_rej_reason {
  139. IB_CM_REJ_NO_QP = 1,
  140. IB_CM_REJ_NO_EEC = 2,
  141. IB_CM_REJ_NO_RESOURCES = 3,
  142. IB_CM_REJ_TIMEOUT = 4,
  143. IB_CM_REJ_UNSUPPORTED = 5,
  144. IB_CM_REJ_INVALID_COMM_ID = 6,
  145. IB_CM_REJ_INVALID_COMM_INSTANCE = 7,
  146. IB_CM_REJ_INVALID_SERVICE_ID = 8,
  147. IB_CM_REJ_INVALID_TRANSPORT_TYPE = 9,
  148. IB_CM_REJ_STALE_CONN = 10,
  149. IB_CM_REJ_RDC_NOT_EXIST = 11,
  150. IB_CM_REJ_INVALID_GID = 12,
  151. IB_CM_REJ_INVALID_LID = 13,
  152. IB_CM_REJ_INVALID_SL = 14,
  153. IB_CM_REJ_INVALID_TRAFFIC_CLASS = 15,
  154. IB_CM_REJ_INVALID_HOP_LIMIT = 16,
  155. IB_CM_REJ_INVALID_PACKET_RATE = 17,
  156. IB_CM_REJ_INVALID_ALT_GID = 18,
  157. IB_CM_REJ_INVALID_ALT_LID = 19,
  158. IB_CM_REJ_INVALID_ALT_SL = 20,
  159. IB_CM_REJ_INVALID_ALT_TRAFFIC_CLASS = 21,
  160. IB_CM_REJ_INVALID_ALT_HOP_LIMIT = 22,
  161. IB_CM_REJ_INVALID_ALT_PACKET_RATE = 23,
  162. IB_CM_REJ_PORT_CM_REDIRECT = 24,
  163. IB_CM_REJ_PORT_REDIRECT = 25,
  164. IB_CM_REJ_INVALID_MTU = 26,
  165. IB_CM_REJ_INSUFFICIENT_RESP_RESOURCES = 27,
  166. IB_CM_REJ_CONSUMER_DEFINED = 28,
  167. IB_CM_REJ_INVALID_RNR_RETRY = 29,
  168. IB_CM_REJ_DUPLICATE_LOCAL_COMM_ID = 30,
  169. IB_CM_REJ_INVALID_CLASS_VERSION = 31,
  170. IB_CM_REJ_INVALID_FLOW_LABEL = 32,
  171. IB_CM_REJ_INVALID_ALT_FLOW_LABEL = 33
  172. };
  173. struct ib_cm_rej_event_param {
  174. enum ib_cm_rej_reason reason;
  175. void *ari;
  176. u8 ari_length;
  177. };
  178. struct ib_cm_mra_event_param {
  179. u8 service_timeout;
  180. };
  181. struct ib_cm_lap_event_param {
  182. struct ib_sa_path_rec *alternate_path;
  183. };
  184. enum ib_cm_apr_status {
  185. IB_CM_APR_SUCCESS,
  186. IB_CM_APR_INVALID_COMM_ID,
  187. IB_CM_APR_UNSUPPORTED,
  188. IB_CM_APR_REJECT,
  189. IB_CM_APR_REDIRECT,
  190. IB_CM_APR_IS_CURRENT,
  191. IB_CM_APR_INVALID_QPN_EECN,
  192. IB_CM_APR_INVALID_LID,
  193. IB_CM_APR_INVALID_GID,
  194. IB_CM_APR_INVALID_FLOW_LABEL,
  195. IB_CM_APR_INVALID_TCLASS,
  196. IB_CM_APR_INVALID_HOP_LIMIT,
  197. IB_CM_APR_INVALID_PACKET_RATE,
  198. IB_CM_APR_INVALID_SL
  199. };
  200. struct ib_cm_apr_event_param {
  201. enum ib_cm_apr_status ap_status;
  202. void *apr_info;
  203. u8 info_len;
  204. };
  205. struct ib_cm_sidr_req_event_param {
  206. struct ib_cm_id *listen_id;
  207. __be64 service_id;
  208. /* P_Key that was used by the GMP's BTH header */
  209. u16 bth_pkey;
  210. u8 port;
  211. u16 pkey;
  212. };
  213. enum ib_cm_sidr_status {
  214. IB_SIDR_SUCCESS,
  215. IB_SIDR_UNSUPPORTED,
  216. IB_SIDR_REJECT,
  217. IB_SIDR_NO_QP,
  218. IB_SIDR_REDIRECT,
  219. IB_SIDR_UNSUPPORTED_VERSION
  220. };
  221. struct ib_cm_sidr_rep_event_param {
  222. enum ib_cm_sidr_status status;
  223. u32 qkey;
  224. u32 qpn;
  225. void *info;
  226. u8 info_len;
  227. };
  228. struct ib_cm_event {
  229. enum ib_cm_event_type event;
  230. union {
  231. struct ib_cm_req_event_param req_rcvd;
  232. struct ib_cm_rep_event_param rep_rcvd;
  233. /* No data for RTU received events. */
  234. struct ib_cm_rej_event_param rej_rcvd;
  235. struct ib_cm_mra_event_param mra_rcvd;
  236. struct ib_cm_lap_event_param lap_rcvd;
  237. struct ib_cm_apr_event_param apr_rcvd;
  238. /* No data for DREQ/DREP received events. */
  239. struct ib_cm_sidr_req_event_param sidr_req_rcvd;
  240. struct ib_cm_sidr_rep_event_param sidr_rep_rcvd;
  241. enum ib_wc_status send_status;
  242. } param;
  243. void *private_data;
  244. };
  245. #define CM_REQ_ATTR_ID cpu_to_be16(0x0010)
  246. #define CM_MRA_ATTR_ID cpu_to_be16(0x0011)
  247. #define CM_REJ_ATTR_ID cpu_to_be16(0x0012)
  248. #define CM_REP_ATTR_ID cpu_to_be16(0x0013)
  249. #define CM_RTU_ATTR_ID cpu_to_be16(0x0014)
  250. #define CM_DREQ_ATTR_ID cpu_to_be16(0x0015)
  251. #define CM_DREP_ATTR_ID cpu_to_be16(0x0016)
  252. #define CM_SIDR_REQ_ATTR_ID cpu_to_be16(0x0017)
  253. #define CM_SIDR_REP_ATTR_ID cpu_to_be16(0x0018)
  254. #define CM_LAP_ATTR_ID cpu_to_be16(0x0019)
  255. #define CM_APR_ATTR_ID cpu_to_be16(0x001A)
  256. /**
  257. * ib_cm_handler - User-defined callback to process communication events.
  258. * @cm_id: Communication identifier associated with the reported event.
  259. * @event: Information about the communication event.
  260. *
  261. * IB_CM_REQ_RECEIVED and IB_CM_SIDR_REQ_RECEIVED communication events
  262. * generated as a result of listen requests result in the allocation of a
  263. * new @cm_id. The new @cm_id is returned to the user through this callback.
  264. * Clients are responsible for destroying the new @cm_id. For peer-to-peer
  265. * IB_CM_REQ_RECEIVED and all other events, the returned @cm_id corresponds
  266. * to a user's existing communication identifier.
  267. *
  268. * Users may not call ib_destroy_cm_id while in the context of this callback;
  269. * however, returning a non-zero value instructs the communication manager to
  270. * destroy the @cm_id after the callback completes.
  271. */
  272. typedef int (*ib_cm_handler)(struct ib_cm_id *cm_id,
  273. struct ib_cm_event *event);
  274. struct ib_cm_id {
  275. ib_cm_handler cm_handler;
  276. void *context;
  277. struct ib_device *device;
  278. __be64 service_id;
  279. __be64 service_mask;
  280. enum ib_cm_state state; /* internal CM/debug use */
  281. enum ib_cm_lap_state lap_state; /* internal CM/debug use */
  282. __be32 local_id;
  283. __be32 remote_id;
  284. u32 remote_cm_qpn; /* 1 unless redirected */
  285. };
  286. /**
  287. * ib_create_cm_id - Allocate a communication identifier.
  288. * @device: Device associated with the cm_id. All related communication will
  289. * be associated with the specified device.
  290. * @cm_handler: Callback invoked to notify the user of CM events.
  291. * @context: User specified context associated with the communication
  292. * identifier.
  293. *
  294. * Communication identifiers are used to track connection states, service
  295. * ID resolution requests, and listen requests.
  296. */
  297. struct ib_cm_id *ib_create_cm_id(struct ib_device *device,
  298. ib_cm_handler cm_handler,
  299. void *context);
  300. /**
  301. * ib_destroy_cm_id - Destroy a connection identifier.
  302. * @cm_id: Connection identifier to destroy.
  303. *
  304. * This call blocks until the connection identifier is destroyed.
  305. */
  306. void ib_destroy_cm_id(struct ib_cm_id *cm_id);
  307. #define IB_SERVICE_ID_AGN_MASK cpu_to_be64(0xFF00000000000000ULL)
  308. #define IB_CM_ASSIGN_SERVICE_ID cpu_to_be64(0x0200000000000000ULL)
  309. #define IB_CMA_SERVICE_ID cpu_to_be64(0x0000000001000000ULL)
  310. #define IB_CMA_SERVICE_ID_MASK cpu_to_be64(0xFFFFFFFFFF000000ULL)
  311. #define IB_SDP_SERVICE_ID cpu_to_be64(0x0000000000010000ULL)
  312. #define IB_SDP_SERVICE_ID_MASK cpu_to_be64(0xFFFFFFFFFFFF0000ULL)
  313. /**
  314. * ib_cm_listen - Initiates listening on the specified service ID for
  315. * connection and service ID resolution requests.
  316. * @cm_id: Connection identifier associated with the listen request.
  317. * @service_id: Service identifier matched against incoming connection
  318. * and service ID resolution requests. The service ID should be specified
  319. * network-byte order. If set to IB_CM_ASSIGN_SERVICE_ID, the CM will
  320. * assign a service ID to the caller.
  321. * @service_mask: Mask applied to service ID used to listen across a
  322. * range of service IDs. If set to 0, the service ID is matched
  323. * exactly. This parameter is ignored if %service_id is set to
  324. * IB_CM_ASSIGN_SERVICE_ID.
  325. */
  326. int ib_cm_listen(struct ib_cm_id *cm_id, __be64 service_id,
  327. __be64 service_mask);
  328. struct ib_cm_id *ib_cm_insert_listen(struct ib_device *device,
  329. ib_cm_handler cm_handler,
  330. __be64 service_id);
  331. struct ib_cm_req_param {
  332. struct ib_sa_path_rec *primary_path;
  333. struct ib_sa_path_rec *alternate_path;
  334. __be64 service_id;
  335. u32 qp_num;
  336. enum ib_qp_type qp_type;
  337. u32 starting_psn;
  338. const void *private_data;
  339. u8 private_data_len;
  340. u8 peer_to_peer;
  341. u8 responder_resources;
  342. u8 initiator_depth;
  343. u8 remote_cm_response_timeout;
  344. u8 flow_control;
  345. u8 local_cm_response_timeout;
  346. u8 retry_count;
  347. u8 rnr_retry_count;
  348. u8 max_cm_retries;
  349. u8 srq;
  350. };
  351. /**
  352. * ib_send_cm_req - Sends a connection request to the remote node.
  353. * @cm_id: Connection identifier that will be associated with the
  354. * connection request.
  355. * @param: Connection request information needed to establish the
  356. * connection.
  357. */
  358. int ib_send_cm_req(struct ib_cm_id *cm_id,
  359. struct ib_cm_req_param *param);
  360. struct ib_cm_rep_param {
  361. u32 qp_num;
  362. u32 starting_psn;
  363. const void *private_data;
  364. u8 private_data_len;
  365. u8 responder_resources;
  366. u8 initiator_depth;
  367. u8 failover_accepted;
  368. u8 flow_control;
  369. u8 rnr_retry_count;
  370. u8 srq;
  371. };
  372. /**
  373. * ib_send_cm_rep - Sends a connection reply in response to a connection
  374. * request.
  375. * @cm_id: Connection identifier that will be associated with the
  376. * connection request.
  377. * @param: Connection reply information needed to establish the
  378. * connection.
  379. */
  380. int ib_send_cm_rep(struct ib_cm_id *cm_id,
  381. struct ib_cm_rep_param *param);
  382. /**
  383. * ib_send_cm_rtu - Sends a connection ready to use message in response
  384. * to a connection reply message.
  385. * @cm_id: Connection identifier associated with the connection request.
  386. * @private_data: Optional user-defined private data sent with the
  387. * ready to use message.
  388. * @private_data_len: Size of the private data buffer, in bytes.
  389. */
  390. int ib_send_cm_rtu(struct ib_cm_id *cm_id,
  391. const void *private_data,
  392. u8 private_data_len);
  393. /**
  394. * ib_send_cm_dreq - Sends a disconnection request for an existing
  395. * connection.
  396. * @cm_id: Connection identifier associated with the connection being
  397. * released.
  398. * @private_data: Optional user-defined private data sent with the
  399. * disconnection request message.
  400. * @private_data_len: Size of the private data buffer, in bytes.
  401. */
  402. int ib_send_cm_dreq(struct ib_cm_id *cm_id,
  403. const void *private_data,
  404. u8 private_data_len);
  405. /**
  406. * ib_send_cm_drep - Sends a disconnection reply to a disconnection request.
  407. * @cm_id: Connection identifier associated with the connection being
  408. * released.
  409. * @private_data: Optional user-defined private data sent with the
  410. * disconnection reply message.
  411. * @private_data_len: Size of the private data buffer, in bytes.
  412. *
  413. * If the cm_id is in the correct state, the CM will transition the connection
  414. * to the timewait state, even if an error occurs sending the DREP message.
  415. */
  416. int ib_send_cm_drep(struct ib_cm_id *cm_id,
  417. const void *private_data,
  418. u8 private_data_len);
  419. /**
  420. * ib_cm_notify - Notifies the CM of an event reported to the consumer.
  421. * @cm_id: Connection identifier to transition to established.
  422. * @event: Type of event.
  423. *
  424. * This routine should be invoked by users to notify the CM of relevant
  425. * communication events. Events that should be reported to the CM and
  426. * when to report them are:
  427. *
  428. * IB_EVENT_COMM_EST - Used when a message is received on a connected
  429. * QP before an RTU has been received.
  430. * IB_EVENT_PATH_MIG - Notifies the CM that the connection has failed over
  431. * to the alternate path.
  432. */
  433. int ib_cm_notify(struct ib_cm_id *cm_id, enum ib_event_type event);
  434. /**
  435. * ib_send_cm_rej - Sends a connection rejection message to the
  436. * remote node.
  437. * @cm_id: Connection identifier associated with the connection being
  438. * rejected.
  439. * @reason: Reason for the connection request rejection.
  440. * @ari: Optional additional rejection information.
  441. * @ari_length: Size of the additional rejection information, in bytes.
  442. * @private_data: Optional user-defined private data sent with the
  443. * rejection message.
  444. * @private_data_len: Size of the private data buffer, in bytes.
  445. */
  446. int ib_send_cm_rej(struct ib_cm_id *cm_id,
  447. enum ib_cm_rej_reason reason,
  448. void *ari,
  449. u8 ari_length,
  450. const void *private_data,
  451. u8 private_data_len);
  452. #define IB_CM_MRA_FLAG_DELAY 0x80 /* Send MRA only after a duplicate msg */
  453. /**
  454. * ib_send_cm_mra - Sends a message receipt acknowledgement to a connection
  455. * message.
  456. * @cm_id: Connection identifier associated with the connection message.
  457. * @service_timeout: The lower 5-bits specify the maximum time required for
  458. * the sender to reply to the connection message. The upper 3-bits
  459. * specify additional control flags.
  460. * @private_data: Optional user-defined private data sent with the
  461. * message receipt acknowledgement.
  462. * @private_data_len: Size of the private data buffer, in bytes.
  463. */
  464. int ib_send_cm_mra(struct ib_cm_id *cm_id,
  465. u8 service_timeout,
  466. const void *private_data,
  467. u8 private_data_len);
  468. /**
  469. * ib_send_cm_lap - Sends a load alternate path request.
  470. * @cm_id: Connection identifier associated with the load alternate path
  471. * message.
  472. * @alternate_path: A path record that identifies the alternate path to
  473. * load.
  474. * @private_data: Optional user-defined private data sent with the
  475. * load alternate path message.
  476. * @private_data_len: Size of the private data buffer, in bytes.
  477. */
  478. int ib_send_cm_lap(struct ib_cm_id *cm_id,
  479. struct ib_sa_path_rec *alternate_path,
  480. const void *private_data,
  481. u8 private_data_len);
  482. /**
  483. * ib_cm_init_qp_attr - Initializes the QP attributes for use in transitioning
  484. * to a specified QP state.
  485. * @cm_id: Communication identifier associated with the QP attributes to
  486. * initialize.
  487. * @qp_attr: On input, specifies the desired QP state. On output, the
  488. * mandatory and desired optional attributes will be set in order to
  489. * modify the QP to the specified state.
  490. * @qp_attr_mask: The QP attribute mask that may be used to transition the
  491. * QP to the specified state.
  492. *
  493. * Users must set the @qp_attr->qp_state to the desired QP state. This call
  494. * will set all required attributes for the given transition, along with
  495. * known optional attributes. Users may override the attributes returned from
  496. * this call before calling ib_modify_qp.
  497. */
  498. int ib_cm_init_qp_attr(struct ib_cm_id *cm_id,
  499. struct ib_qp_attr *qp_attr,
  500. int *qp_attr_mask);
  501. /**
  502. * ib_send_cm_apr - Sends an alternate path response message in response to
  503. * a load alternate path request.
  504. * @cm_id: Connection identifier associated with the alternate path response.
  505. * @status: Reply status sent with the alternate path response.
  506. * @info: Optional additional information sent with the alternate path
  507. * response.
  508. * @info_length: Size of the additional information, in bytes.
  509. * @private_data: Optional user-defined private data sent with the
  510. * alternate path response message.
  511. * @private_data_len: Size of the private data buffer, in bytes.
  512. */
  513. int ib_send_cm_apr(struct ib_cm_id *cm_id,
  514. enum ib_cm_apr_status status,
  515. void *info,
  516. u8 info_length,
  517. const void *private_data,
  518. u8 private_data_len);
  519. struct ib_cm_sidr_req_param {
  520. struct ib_sa_path_rec *path;
  521. __be64 service_id;
  522. int timeout_ms;
  523. const void *private_data;
  524. u8 private_data_len;
  525. u8 max_cm_retries;
  526. };
  527. /**
  528. * ib_send_cm_sidr_req - Sends a service ID resolution request to the
  529. * remote node.
  530. * @cm_id: Communication identifier that will be associated with the
  531. * service ID resolution request.
  532. * @param: Service ID resolution request information.
  533. */
  534. int ib_send_cm_sidr_req(struct ib_cm_id *cm_id,
  535. struct ib_cm_sidr_req_param *param);
  536. struct ib_cm_sidr_rep_param {
  537. u32 qp_num;
  538. u32 qkey;
  539. enum ib_cm_sidr_status status;
  540. const void *info;
  541. u8 info_length;
  542. const void *private_data;
  543. u8 private_data_len;
  544. };
  545. /**
  546. * ib_send_cm_sidr_rep - Sends a service ID resolution reply to the
  547. * remote node.
  548. * @cm_id: Communication identifier associated with the received service ID
  549. * resolution request.
  550. * @param: Service ID resolution reply information.
  551. */
  552. int ib_send_cm_sidr_rep(struct ib_cm_id *cm_id,
  553. struct ib_cm_sidr_rep_param *param);
  554. #endif /* IB_CM_H */