ib_mad.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621
  1. /*
  2. * Copyright (c) 2004 Mellanox Technologies Ltd. All rights reserved.
  3. * Copyright (c) 2004 Infinicon Corporation. All rights reserved.
  4. * Copyright (c) 2004 Intel Corporation. All rights reserved.
  5. * Copyright (c) 2004 Topspin Corporation. All rights reserved.
  6. * Copyright (c) 2004 Voltaire Corporation. All rights reserved.
  7. *
  8. * This software is available to you under a choice of one of two
  9. * licenses. You may choose to be licensed under the terms of the GNU
  10. * General Public License (GPL) Version 2, available from the file
  11. * COPYING in the main directory of this source tree, or the
  12. * OpenIB.org BSD license below:
  13. *
  14. * Redistribution and use in source and binary forms, with or
  15. * without modification, are permitted provided that the following
  16. * conditions are met:
  17. *
  18. * - Redistributions of source code must retain the above
  19. * copyright notice, this list of conditions and the following
  20. * disclaimer.
  21. *
  22. * - Redistributions in binary form must reproduce the above
  23. * copyright notice, this list of conditions and the following
  24. * disclaimer in the documentation and/or other materials
  25. * provided with the distribution.
  26. *
  27. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  28. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  29. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  30. * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  31. * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  32. * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  33. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  34. * SOFTWARE.
  35. *
  36. * $Id: ib_mad.h 5596 2006-03-03 01:00:07Z sean.hefty $
  37. */
  38. #if !defined( IB_MAD_H )
  39. #define IB_MAD_H
  40. #include <linux/pci.h>
  41. #include <rdma/ib_verbs.h>
  42. /* Management base version */
  43. #define IB_MGMT_BASE_VERSION 1
  44. /* Management classes */
  45. #define IB_MGMT_CLASS_SUBN_LID_ROUTED 0x01
  46. #define IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE 0x81
  47. #define IB_MGMT_CLASS_SUBN_ADM 0x03
  48. #define IB_MGMT_CLASS_PERF_MGMT 0x04
  49. #define IB_MGMT_CLASS_BM 0x05
  50. #define IB_MGMT_CLASS_DEVICE_MGMT 0x06
  51. #define IB_MGMT_CLASS_CM 0x07
  52. #define IB_MGMT_CLASS_SNMP 0x08
  53. #define IB_MGMT_CLASS_VENDOR_RANGE2_START 0x30
  54. #define IB_MGMT_CLASS_VENDOR_RANGE2_END 0x4F
  55. #define IB_OPENIB_OUI (0x001405)
  56. /* Management methods */
  57. #define IB_MGMT_METHOD_GET 0x01
  58. #define IB_MGMT_METHOD_SET 0x02
  59. #define IB_MGMT_METHOD_GET_RESP 0x81
  60. #define IB_MGMT_METHOD_SEND 0x03
  61. #define IB_MGMT_METHOD_TRAP 0x05
  62. #define IB_MGMT_METHOD_REPORT 0x06
  63. #define IB_MGMT_METHOD_REPORT_RESP 0x86
  64. #define IB_MGMT_METHOD_TRAP_REPRESS 0x07
  65. #define IB_MGMT_METHOD_RESP 0x80
  66. #define IB_MGMT_MAX_METHODS 128
  67. /* RMPP information */
  68. #define IB_MGMT_RMPP_VERSION 1
  69. #define IB_MGMT_RMPP_TYPE_DATA 1
  70. #define IB_MGMT_RMPP_TYPE_ACK 2
  71. #define IB_MGMT_RMPP_TYPE_STOP 3
  72. #define IB_MGMT_RMPP_TYPE_ABORT 4
  73. #define IB_MGMT_RMPP_FLAG_ACTIVE 1
  74. #define IB_MGMT_RMPP_FLAG_FIRST (1<<1)
  75. #define IB_MGMT_RMPP_FLAG_LAST (1<<2)
  76. #define IB_MGMT_RMPP_NO_RESPTIME 0x1F
  77. #define IB_MGMT_RMPP_STATUS_SUCCESS 0
  78. #define IB_MGMT_RMPP_STATUS_RESX 1
  79. #define IB_MGMT_RMPP_STATUS_ABORT_MIN 118
  80. #define IB_MGMT_RMPP_STATUS_T2L 118
  81. #define IB_MGMT_RMPP_STATUS_BAD_LEN 119
  82. #define IB_MGMT_RMPP_STATUS_BAD_SEG 120
  83. #define IB_MGMT_RMPP_STATUS_BADT 121
  84. #define IB_MGMT_RMPP_STATUS_W2S 122
  85. #define IB_MGMT_RMPP_STATUS_S2B 123
  86. #define IB_MGMT_RMPP_STATUS_BAD_STATUS 124
  87. #define IB_MGMT_RMPP_STATUS_UNV 125
  88. #define IB_MGMT_RMPP_STATUS_TMR 126
  89. #define IB_MGMT_RMPP_STATUS_UNSPEC 127
  90. #define IB_MGMT_RMPP_STATUS_ABORT_MAX 127
  91. #define IB_QP0 0
  92. #define IB_QP1 __constant_htonl(1)
  93. #define IB_QP1_QKEY 0x80010000
  94. #define IB_QP_SET_QKEY 0x80000000
  95. enum {
  96. IB_MGMT_MAD_HDR = 24,
  97. IB_MGMT_MAD_DATA = 232,
  98. IB_MGMT_RMPP_HDR = 36,
  99. IB_MGMT_RMPP_DATA = 220,
  100. IB_MGMT_VENDOR_HDR = 40,
  101. IB_MGMT_VENDOR_DATA = 216,
  102. IB_MGMT_SA_HDR = 56,
  103. IB_MGMT_SA_DATA = 200,
  104. };
  105. struct ib_mad_hdr {
  106. u8 base_version;
  107. u8 mgmt_class;
  108. u8 class_version;
  109. u8 method;
  110. __be16 status;
  111. __be16 class_specific;
  112. __be64 tid;
  113. __be16 attr_id;
  114. __be16 resv;
  115. __be32 attr_mod;
  116. };
  117. struct ib_rmpp_hdr {
  118. u8 rmpp_version;
  119. u8 rmpp_type;
  120. u8 rmpp_rtime_flags;
  121. u8 rmpp_status;
  122. __be32 seg_num;
  123. __be32 paylen_newwin;
  124. };
  125. typedef u64 __bitwise ib_sa_comp_mask;
  126. #define IB_SA_COMP_MASK(n) ((__force ib_sa_comp_mask) cpu_to_be64(1ull << n))
  127. /*
  128. * ib_sa_hdr and ib_sa_mad structures must be packed because they have
  129. * 64-bit fields that are only 32-bit aligned. 64-bit architectures will
  130. * lay them out wrong otherwise. (And unfortunately they are sent on
  131. * the wire so we can't change the layout)
  132. */
  133. struct ib_sa_hdr {
  134. __be64 sm_key;
  135. __be16 attr_offset;
  136. __be16 reserved;
  137. ib_sa_comp_mask comp_mask;
  138. } __attribute__ ((packed));
  139. struct ib_mad {
  140. struct ib_mad_hdr mad_hdr;
  141. u8 data[IB_MGMT_MAD_DATA];
  142. };
  143. struct ib_rmpp_mad {
  144. struct ib_mad_hdr mad_hdr;
  145. struct ib_rmpp_hdr rmpp_hdr;
  146. u8 data[IB_MGMT_RMPP_DATA];
  147. };
  148. struct ib_sa_mad {
  149. struct ib_mad_hdr mad_hdr;
  150. struct ib_rmpp_hdr rmpp_hdr;
  151. struct ib_sa_hdr sa_hdr;
  152. u8 data[IB_MGMT_SA_DATA];
  153. } __attribute__ ((packed));
  154. struct ib_vendor_mad {
  155. struct ib_mad_hdr mad_hdr;
  156. struct ib_rmpp_hdr rmpp_hdr;
  157. u8 reserved;
  158. u8 oui[3];
  159. u8 data[IB_MGMT_VENDOR_DATA];
  160. };
  161. struct ib_class_port_info
  162. {
  163. u8 base_version;
  164. u8 class_version;
  165. __be16 capability_mask;
  166. u8 reserved[3];
  167. u8 resp_time_value;
  168. u8 redirect_gid[16];
  169. __be32 redirect_tcslfl;
  170. __be16 redirect_lid;
  171. __be16 redirect_pkey;
  172. __be32 redirect_qp;
  173. __be32 redirect_qkey;
  174. u8 trap_gid[16];
  175. __be32 trap_tcslfl;
  176. __be16 trap_lid;
  177. __be16 trap_pkey;
  178. __be32 trap_hlqp;
  179. __be32 trap_qkey;
  180. };
  181. /**
  182. * ib_mad_send_buf - MAD data buffer and work request for sends.
  183. * @next: A pointer used to chain together MADs for posting.
  184. * @mad: References an allocated MAD data buffer for MADs that do not have
  185. * RMPP active. For MADs using RMPP, references the common and management
  186. * class specific headers.
  187. * @mad_agent: MAD agent that allocated the buffer.
  188. * @ah: The address handle to use when sending the MAD.
  189. * @context: User-controlled context fields.
  190. * @hdr_len: Indicates the size of the data header of the MAD. This length
  191. * includes the common MAD, RMPP, and class specific headers.
  192. * @data_len: Indicates the total size of user-transferred data.
  193. * @seg_count: The number of RMPP segments allocated for this send.
  194. * @seg_size: Size of each RMPP segment.
  195. * @timeout_ms: Time to wait for a response.
  196. * @retries: Number of times to retry a request for a response.
  197. *
  198. * Users are responsible for initializing the MAD buffer itself, with the
  199. * exception of any RMPP header. Additional segment buffer space allocated
  200. * beyond data_len is padding.
  201. */
  202. struct ib_mad_send_buf {
  203. struct ib_mad_send_buf *next;
  204. void *mad;
  205. struct ib_mad_agent *mad_agent;
  206. struct ib_ah *ah;
  207. void *context[2];
  208. int hdr_len;
  209. int data_len;
  210. int seg_count;
  211. int seg_size;
  212. int timeout_ms;
  213. int retries;
  214. };
  215. /**
  216. * ib_get_rmpp_resptime - Returns the RMPP response time.
  217. * @rmpp_hdr: An RMPP header.
  218. */
  219. static inline u8 ib_get_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr)
  220. {
  221. return rmpp_hdr->rmpp_rtime_flags >> 3;
  222. }
  223. /**
  224. * ib_get_rmpp_flags - Returns the RMPP flags.
  225. * @rmpp_hdr: An RMPP header.
  226. */
  227. static inline u8 ib_get_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr)
  228. {
  229. return rmpp_hdr->rmpp_rtime_flags & 0x7;
  230. }
  231. /**
  232. * ib_set_rmpp_resptime - Sets the response time in an RMPP header.
  233. * @rmpp_hdr: An RMPP header.
  234. * @rtime: The response time to set.
  235. */
  236. static inline void ib_set_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr, u8 rtime)
  237. {
  238. rmpp_hdr->rmpp_rtime_flags = ib_get_rmpp_flags(rmpp_hdr) | (rtime << 3);
  239. }
  240. /**
  241. * ib_set_rmpp_flags - Sets the flags in an RMPP header.
  242. * @rmpp_hdr: An RMPP header.
  243. * @flags: The flags to set.
  244. */
  245. static inline void ib_set_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr, u8 flags)
  246. {
  247. rmpp_hdr->rmpp_rtime_flags = (rmpp_hdr->rmpp_rtime_flags & 0xF1) |
  248. (flags & 0x7);
  249. }
  250. struct ib_mad_agent;
  251. struct ib_mad_send_wc;
  252. struct ib_mad_recv_wc;
  253. /**
  254. * ib_mad_send_handler - callback handler for a sent MAD.
  255. * @mad_agent: MAD agent that sent the MAD.
  256. * @mad_send_wc: Send work completion information on the sent MAD.
  257. */
  258. typedef void (*ib_mad_send_handler)(struct ib_mad_agent *mad_agent,
  259. struct ib_mad_send_wc *mad_send_wc);
  260. /**
  261. * ib_mad_snoop_handler - Callback handler for snooping sent MADs.
  262. * @mad_agent: MAD agent that snooped the MAD.
  263. * @send_wr: Work request information on the sent MAD.
  264. * @mad_send_wc: Work completion information on the sent MAD. Valid
  265. * only for snooping that occurs on a send completion.
  266. *
  267. * Clients snooping MADs should not modify data referenced by the @send_wr
  268. * or @mad_send_wc.
  269. */
  270. typedef void (*ib_mad_snoop_handler)(struct ib_mad_agent *mad_agent,
  271. struct ib_mad_send_buf *send_buf,
  272. struct ib_mad_send_wc *mad_send_wc);
  273. /**
  274. * ib_mad_recv_handler - callback handler for a received MAD.
  275. * @mad_agent: MAD agent requesting the received MAD.
  276. * @mad_recv_wc: Received work completion information on the received MAD.
  277. *
  278. * MADs received in response to a send request operation will be handed to
  279. * the user before the send operation completes. All data buffers given
  280. * to registered agents through this routine are owned by the receiving
  281. * client, except for snooping agents. Clients snooping MADs should not
  282. * modify the data referenced by @mad_recv_wc.
  283. */
  284. typedef void (*ib_mad_recv_handler)(struct ib_mad_agent *mad_agent,
  285. struct ib_mad_recv_wc *mad_recv_wc);
  286. /**
  287. * ib_mad_agent - Used to track MAD registration with the access layer.
  288. * @device: Reference to device registration is on.
  289. * @qp: Reference to QP used for sending and receiving MADs.
  290. * @mr: Memory region for system memory usable for DMA.
  291. * @recv_handler: Callback handler for a received MAD.
  292. * @send_handler: Callback handler for a sent MAD.
  293. * @snoop_handler: Callback handler for snooped sent MADs.
  294. * @context: User-specified context associated with this registration.
  295. * @hi_tid: Access layer assigned transaction ID for this client.
  296. * Unsolicited MADs sent by this client will have the upper 32-bits
  297. * of their TID set to this value.
  298. * @port_num: Port number on which QP is registered
  299. * @rmpp_version: If set, indicates the RMPP version used by this agent.
  300. */
  301. struct ib_mad_agent {
  302. struct ib_device *device;
  303. struct ib_qp *qp;
  304. struct ib_mr *mr;
  305. ib_mad_recv_handler recv_handler;
  306. ib_mad_send_handler send_handler;
  307. ib_mad_snoop_handler snoop_handler;
  308. void *context;
  309. u32 hi_tid;
  310. u8 port_num;
  311. u8 rmpp_version;
  312. };
  313. /**
  314. * ib_mad_send_wc - MAD send completion information.
  315. * @send_buf: Send MAD data buffer associated with the send MAD request.
  316. * @status: Completion status.
  317. * @vendor_err: Optional vendor error information returned with a failed
  318. * request.
  319. */
  320. struct ib_mad_send_wc {
  321. struct ib_mad_send_buf *send_buf;
  322. enum ib_wc_status status;
  323. u32 vendor_err;
  324. };
  325. /**
  326. * ib_mad_recv_buf - received MAD buffer information.
  327. * @list: Reference to next data buffer for a received RMPP MAD.
  328. * @grh: References a data buffer containing the global route header.
  329. * The data refereced by this buffer is only valid if the GRH is
  330. * valid.
  331. * @mad: References the start of the received MAD.
  332. */
  333. struct ib_mad_recv_buf {
  334. struct list_head list;
  335. struct ib_grh *grh;
  336. struct ib_mad *mad;
  337. };
  338. /**
  339. * ib_mad_recv_wc - received MAD information.
  340. * @wc: Completion information for the received data.
  341. * @recv_buf: Specifies the location of the received data buffer(s).
  342. * @rmpp_list: Specifies a list of RMPP reassembled received MAD buffers.
  343. * @mad_len: The length of the received MAD, without duplicated headers.
  344. *
  345. * For received response, the wr_id contains a pointer to the ib_mad_send_buf
  346. * for the corresponding send request.
  347. */
  348. struct ib_mad_recv_wc {
  349. struct ib_wc *wc;
  350. struct ib_mad_recv_buf recv_buf;
  351. struct list_head rmpp_list;
  352. int mad_len;
  353. };
  354. /**
  355. * ib_mad_reg_req - MAD registration request
  356. * @mgmt_class: Indicates which management class of MADs should be receive
  357. * by the caller. This field is only required if the user wishes to
  358. * receive unsolicited MADs, otherwise it should be 0.
  359. * @mgmt_class_version: Indicates which version of MADs for the given
  360. * management class to receive.
  361. * @oui: Indicates IEEE OUI when mgmt_class is a vendor class
  362. * in the range from 0x30 to 0x4f. Otherwise not used.
  363. * @method_mask: The caller will receive unsolicited MADs for any method
  364. * where @method_mask = 1.
  365. */
  366. struct ib_mad_reg_req {
  367. u8 mgmt_class;
  368. u8 mgmt_class_version;
  369. u8 oui[3];
  370. DECLARE_BITMAP(method_mask, IB_MGMT_MAX_METHODS);
  371. };
  372. /**
  373. * ib_register_mad_agent - Register to send/receive MADs.
  374. * @device: The device to register with.
  375. * @port_num: The port on the specified device to use.
  376. * @qp_type: Specifies which QP to access. Must be either
  377. * IB_QPT_SMI or IB_QPT_GSI.
  378. * @mad_reg_req: Specifies which unsolicited MADs should be received
  379. * by the caller. This parameter may be NULL if the caller only
  380. * wishes to receive solicited responses.
  381. * @rmpp_version: If set, indicates that the client will send
  382. * and receive MADs that contain the RMPP header for the given version.
  383. * If set to 0, indicates that RMPP is not used by this client.
  384. * @send_handler: The completion callback routine invoked after a send
  385. * request has completed.
  386. * @recv_handler: The completion callback routine invoked for a received
  387. * MAD.
  388. * @context: User specified context associated with the registration.
  389. */
  390. struct ib_mad_agent *ib_register_mad_agent(struct ib_device *device,
  391. u8 port_num,
  392. enum ib_qp_type qp_type,
  393. struct ib_mad_reg_req *mad_reg_req,
  394. u8 rmpp_version,
  395. ib_mad_send_handler send_handler,
  396. ib_mad_recv_handler recv_handler,
  397. void *context);
  398. enum ib_mad_snoop_flags {
  399. /*IB_MAD_SNOOP_POSTED_SENDS = 1,*/
  400. /*IB_MAD_SNOOP_RMPP_SENDS = (1<<1),*/
  401. IB_MAD_SNOOP_SEND_COMPLETIONS = (1<<2),
  402. /*IB_MAD_SNOOP_RMPP_SEND_COMPLETIONS = (1<<3),*/
  403. IB_MAD_SNOOP_RECVS = (1<<4)
  404. /*IB_MAD_SNOOP_RMPP_RECVS = (1<<5),*/
  405. /*IB_MAD_SNOOP_REDIRECTED_QPS = (1<<6)*/
  406. };
  407. /**
  408. * ib_register_mad_snoop - Register to snoop sent and received MADs.
  409. * @device: The device to register with.
  410. * @port_num: The port on the specified device to use.
  411. * @qp_type: Specifies which QP traffic to snoop. Must be either
  412. * IB_QPT_SMI or IB_QPT_GSI.
  413. * @mad_snoop_flags: Specifies information where snooping occurs.
  414. * @send_handler: The callback routine invoked for a snooped send.
  415. * @recv_handler: The callback routine invoked for a snooped receive.
  416. * @context: User specified context associated with the registration.
  417. */
  418. struct ib_mad_agent *ib_register_mad_snoop(struct ib_device *device,
  419. u8 port_num,
  420. enum ib_qp_type qp_type,
  421. int mad_snoop_flags,
  422. ib_mad_snoop_handler snoop_handler,
  423. ib_mad_recv_handler recv_handler,
  424. void *context);
  425. /**
  426. * ib_unregister_mad_agent - Unregisters a client from using MAD services.
  427. * @mad_agent: Corresponding MAD registration request to deregister.
  428. *
  429. * After invoking this routine, MAD services are no longer usable by the
  430. * client on the associated QP.
  431. */
  432. int ib_unregister_mad_agent(struct ib_mad_agent *mad_agent);
  433. /**
  434. * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated
  435. * with the registered client.
  436. * @send_buf: Specifies the information needed to send the MAD(s).
  437. * @bad_send_buf: Specifies the MAD on which an error was encountered. This
  438. * parameter is optional if only a single MAD is posted.
  439. *
  440. * Sent MADs are not guaranteed to complete in the order that they were posted.
  441. *
  442. * If the MAD requires RMPP, the data buffer should contain a single copy
  443. * of the common MAD, RMPP, and class specific headers, followed by the class
  444. * defined data. If the class defined data would not divide evenly into
  445. * RMPP segments, then space must be allocated at the end of the referenced
  446. * buffer for any required padding. To indicate the amount of class defined
  447. * data being transferred, the paylen_newwin field in the RMPP header should
  448. * be set to the size of the class specific header plus the amount of class
  449. * defined data being transferred. The paylen_newwin field should be
  450. * specified in network-byte order.
  451. */
  452. int ib_post_send_mad(struct ib_mad_send_buf *send_buf,
  453. struct ib_mad_send_buf **bad_send_buf);
  454. /**
  455. * ib_free_recv_mad - Returns data buffers used to receive a MAD.
  456. * @mad_recv_wc: Work completion information for a received MAD.
  457. *
  458. * Clients receiving MADs through their ib_mad_recv_handler must call this
  459. * routine to return the work completion buffers to the access layer.
  460. */
  461. void ib_free_recv_mad(struct ib_mad_recv_wc *mad_recv_wc);
  462. /**
  463. * ib_cancel_mad - Cancels an outstanding send MAD operation.
  464. * @mad_agent: Specifies the registration associated with sent MAD.
  465. * @send_buf: Indicates the MAD to cancel.
  466. *
  467. * MADs will be returned to the user through the corresponding
  468. * ib_mad_send_handler.
  469. */
  470. void ib_cancel_mad(struct ib_mad_agent *mad_agent,
  471. struct ib_mad_send_buf *send_buf);
  472. /**
  473. * ib_modify_mad - Modifies an outstanding send MAD operation.
  474. * @mad_agent: Specifies the registration associated with sent MAD.
  475. * @send_buf: Indicates the MAD to modify.
  476. * @timeout_ms: New timeout value for sent MAD.
  477. *
  478. * This call will reset the timeout value for a sent MAD to the specified
  479. * value.
  480. */
  481. int ib_modify_mad(struct ib_mad_agent *mad_agent,
  482. struct ib_mad_send_buf *send_buf, u32 timeout_ms);
  483. /**
  484. * ib_redirect_mad_qp - Registers a QP for MAD services.
  485. * @qp: Reference to a QP that requires MAD services.
  486. * @rmpp_version: If set, indicates that the client will send
  487. * and receive MADs that contain the RMPP header for the given version.
  488. * If set to 0, indicates that RMPP is not used by this client.
  489. * @send_handler: The completion callback routine invoked after a send
  490. * request has completed.
  491. * @recv_handler: The completion callback routine invoked for a received
  492. * MAD.
  493. * @context: User specified context associated with the registration.
  494. *
  495. * Use of this call allows clients to use MAD services, such as RMPP,
  496. * on user-owned QPs. After calling this routine, users may send
  497. * MADs on the specified QP by calling ib_mad_post_send.
  498. */
  499. struct ib_mad_agent *ib_redirect_mad_qp(struct ib_qp *qp,
  500. u8 rmpp_version,
  501. ib_mad_send_handler send_handler,
  502. ib_mad_recv_handler recv_handler,
  503. void *context);
  504. /**
  505. * ib_process_mad_wc - Processes a work completion associated with a
  506. * MAD sent or received on a redirected QP.
  507. * @mad_agent: Specifies the registered MAD service using the redirected QP.
  508. * @wc: References a work completion associated with a sent or received
  509. * MAD segment.
  510. *
  511. * This routine is used to complete or continue processing on a MAD request.
  512. * If the work completion is associated with a send operation, calling
  513. * this routine is required to continue an RMPP transfer or to wait for a
  514. * corresponding response, if it is a request. If the work completion is
  515. * associated with a receive operation, calling this routine is required to
  516. * process an inbound or outbound RMPP transfer, or to match a response MAD
  517. * with its corresponding request.
  518. */
  519. int ib_process_mad_wc(struct ib_mad_agent *mad_agent,
  520. struct ib_wc *wc);
  521. /**
  522. * ib_create_send_mad - Allocate and initialize a data buffer and work request
  523. * for sending a MAD.
  524. * @mad_agent: Specifies the registered MAD service to associate with the MAD.
  525. * @remote_qpn: Specifies the QPN of the receiving node.
  526. * @pkey_index: Specifies which PKey the MAD will be sent using. This field
  527. * is valid only if the remote_qpn is QP 1.
  528. * @rmpp_active: Indicates if the send will enable RMPP.
  529. * @hdr_len: Indicates the size of the data header of the MAD. This length
  530. * should include the common MAD header, RMPP header, plus any class
  531. * specific header.
  532. * @data_len: Indicates the size of any user-transferred data. The call will
  533. * automatically adjust the allocated buffer size to account for any
  534. * additional padding that may be necessary.
  535. * @gfp_mask: GFP mask used for the memory allocation.
  536. *
  537. * This routine allocates a MAD for sending. The returned MAD send buffer
  538. * will reference a data buffer usable for sending a MAD, along
  539. * with an initialized work request structure. Users may modify the returned
  540. * MAD data buffer before posting the send.
  541. *
  542. * The returned MAD header, class specific headers, and any padding will be
  543. * cleared. Users are responsible for initializing the common MAD header,
  544. * any class specific header, and MAD data area.
  545. * If @rmpp_active is set, the RMPP header will be initialized for sending.
  546. */
  547. struct ib_mad_send_buf * ib_create_send_mad(struct ib_mad_agent *mad_agent,
  548. u32 remote_qpn, u16 pkey_index,
  549. int rmpp_active,
  550. int hdr_len, int data_len,
  551. gfp_t gfp_mask);
  552. /**
  553. * ib_get_rmpp_segment - returns the data buffer for a given RMPP segment.
  554. * @send_buf: Previously allocated send data buffer.
  555. * @seg_num: number of segment to return
  556. *
  557. * This routine returns a pointer to the data buffer of an RMPP MAD.
  558. * Users must provide synchronization to @send_buf around this call.
  559. */
  560. void *ib_get_rmpp_segment(struct ib_mad_send_buf *send_buf, int seg_num);
  561. /**
  562. * ib_free_send_mad - Returns data buffers used to send a MAD.
  563. * @send_buf: Previously allocated send data buffer.
  564. */
  565. void ib_free_send_mad(struct ib_mad_send_buf *send_buf);
  566. #endif /* IB_MAD_H */