ib_mad.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710
  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-2006 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. #if !defined(IB_MAD_H)
  37. #define IB_MAD_H
  38. #include <linux/list.h>
  39. #include <rdma/ib_verbs.h>
  40. #include <uapi/rdma/ib_user_mad.h>
  41. /* Management base versions */
  42. #define IB_MGMT_BASE_VERSION 1
  43. #define OPA_MGMT_BASE_VERSION 0x80
  44. #define OPA_SMP_CLASS_VERSION 0x80
  45. /* Management classes */
  46. #define IB_MGMT_CLASS_SUBN_LID_ROUTED 0x01
  47. #define IB_MGMT_CLASS_SUBN_DIRECTED_ROUTE 0x81
  48. #define IB_MGMT_CLASS_SUBN_ADM 0x03
  49. #define IB_MGMT_CLASS_PERF_MGMT 0x04
  50. #define IB_MGMT_CLASS_BM 0x05
  51. #define IB_MGMT_CLASS_DEVICE_MGMT 0x06
  52. #define IB_MGMT_CLASS_CM 0x07
  53. #define IB_MGMT_CLASS_SNMP 0x08
  54. #define IB_MGMT_CLASS_DEVICE_ADM 0x10
  55. #define IB_MGMT_CLASS_BOOT_MGMT 0x11
  56. #define IB_MGMT_CLASS_BIS 0x12
  57. #define IB_MGMT_CLASS_CONG_MGMT 0x21
  58. #define IB_MGMT_CLASS_VENDOR_RANGE2_START 0x30
  59. #define IB_MGMT_CLASS_VENDOR_RANGE2_END 0x4F
  60. #define IB_OPENIB_OUI (0x001405)
  61. /* Management methods */
  62. #define IB_MGMT_METHOD_GET 0x01
  63. #define IB_MGMT_METHOD_SET 0x02
  64. #define IB_MGMT_METHOD_GET_RESP 0x81
  65. #define IB_MGMT_METHOD_SEND 0x03
  66. #define IB_MGMT_METHOD_TRAP 0x05
  67. #define IB_MGMT_METHOD_REPORT 0x06
  68. #define IB_MGMT_METHOD_REPORT_RESP 0x86
  69. #define IB_MGMT_METHOD_TRAP_REPRESS 0x07
  70. #define IB_MGMT_METHOD_RESP 0x80
  71. #define IB_BM_ATTR_MOD_RESP cpu_to_be32(1)
  72. #define IB_MGMT_MAX_METHODS 128
  73. /* MAD Status field bit masks */
  74. #define IB_MGMT_MAD_STATUS_SUCCESS 0x0000
  75. #define IB_MGMT_MAD_STATUS_BUSY 0x0001
  76. #define IB_MGMT_MAD_STATUS_REDIRECT_REQD 0x0002
  77. #define IB_MGMT_MAD_STATUS_BAD_VERSION 0x0004
  78. #define IB_MGMT_MAD_STATUS_UNSUPPORTED_METHOD 0x0008
  79. #define IB_MGMT_MAD_STATUS_UNSUPPORTED_METHOD_ATTRIB 0x000c
  80. #define IB_MGMT_MAD_STATUS_INVALID_ATTRIB_VALUE 0x001c
  81. /* RMPP information */
  82. #define IB_MGMT_RMPP_VERSION 1
  83. #define IB_MGMT_RMPP_TYPE_DATA 1
  84. #define IB_MGMT_RMPP_TYPE_ACK 2
  85. #define IB_MGMT_RMPP_TYPE_STOP 3
  86. #define IB_MGMT_RMPP_TYPE_ABORT 4
  87. #define IB_MGMT_RMPP_FLAG_ACTIVE 1
  88. #define IB_MGMT_RMPP_FLAG_FIRST (1<<1)
  89. #define IB_MGMT_RMPP_FLAG_LAST (1<<2)
  90. #define IB_MGMT_RMPP_NO_RESPTIME 0x1F
  91. #define IB_MGMT_RMPP_STATUS_SUCCESS 0
  92. #define IB_MGMT_RMPP_STATUS_RESX 1
  93. #define IB_MGMT_RMPP_STATUS_ABORT_MIN 118
  94. #define IB_MGMT_RMPP_STATUS_T2L 118
  95. #define IB_MGMT_RMPP_STATUS_BAD_LEN 119
  96. #define IB_MGMT_RMPP_STATUS_BAD_SEG 120
  97. #define IB_MGMT_RMPP_STATUS_BADT 121
  98. #define IB_MGMT_RMPP_STATUS_W2S 122
  99. #define IB_MGMT_RMPP_STATUS_S2B 123
  100. #define IB_MGMT_RMPP_STATUS_BAD_STATUS 124
  101. #define IB_MGMT_RMPP_STATUS_UNV 125
  102. #define IB_MGMT_RMPP_STATUS_TMR 126
  103. #define IB_MGMT_RMPP_STATUS_UNSPEC 127
  104. #define IB_MGMT_RMPP_STATUS_ABORT_MAX 127
  105. #define IB_QP0 0
  106. #define IB_QP1 cpu_to_be32(1)
  107. #define IB_QP1_QKEY 0x80010000
  108. #define IB_QP_SET_QKEY 0x80000000
  109. #define IB_DEFAULT_PKEY_PARTIAL 0x7FFF
  110. #define IB_DEFAULT_PKEY_FULL 0xFFFF
  111. enum {
  112. IB_MGMT_MAD_HDR = 24,
  113. IB_MGMT_MAD_DATA = 232,
  114. IB_MGMT_RMPP_HDR = 36,
  115. IB_MGMT_RMPP_DATA = 220,
  116. IB_MGMT_VENDOR_HDR = 40,
  117. IB_MGMT_VENDOR_DATA = 216,
  118. IB_MGMT_SA_HDR = 56,
  119. IB_MGMT_SA_DATA = 200,
  120. IB_MGMT_DEVICE_HDR = 64,
  121. IB_MGMT_DEVICE_DATA = 192,
  122. IB_MGMT_MAD_SIZE = IB_MGMT_MAD_HDR + IB_MGMT_MAD_DATA,
  123. OPA_MGMT_MAD_DATA = 2024,
  124. OPA_MGMT_RMPP_DATA = 2012,
  125. OPA_MGMT_MAD_SIZE = IB_MGMT_MAD_HDR + OPA_MGMT_MAD_DATA,
  126. };
  127. struct ib_mad_hdr {
  128. u8 base_version;
  129. u8 mgmt_class;
  130. u8 class_version;
  131. u8 method;
  132. __be16 status;
  133. __be16 class_specific;
  134. __be64 tid;
  135. __be16 attr_id;
  136. __be16 resv;
  137. __be32 attr_mod;
  138. };
  139. struct ib_rmpp_hdr {
  140. u8 rmpp_version;
  141. u8 rmpp_type;
  142. u8 rmpp_rtime_flags;
  143. u8 rmpp_status;
  144. __be32 seg_num;
  145. __be32 paylen_newwin;
  146. };
  147. typedef u64 __bitwise ib_sa_comp_mask;
  148. #define IB_SA_COMP_MASK(n) ((__force ib_sa_comp_mask) cpu_to_be64(1ull << (n)))
  149. /*
  150. * ib_sa_hdr and ib_sa_mad structures must be packed because they have
  151. * 64-bit fields that are only 32-bit aligned. 64-bit architectures will
  152. * lay them out wrong otherwise. (And unfortunately they are sent on
  153. * the wire so we can't change the layout)
  154. */
  155. struct ib_sa_hdr {
  156. __be64 sm_key;
  157. __be16 attr_offset;
  158. __be16 reserved;
  159. ib_sa_comp_mask comp_mask;
  160. } __attribute__ ((packed));
  161. struct ib_mad {
  162. struct ib_mad_hdr mad_hdr;
  163. u8 data[IB_MGMT_MAD_DATA];
  164. };
  165. struct opa_mad {
  166. struct ib_mad_hdr mad_hdr;
  167. u8 data[OPA_MGMT_MAD_DATA];
  168. };
  169. struct ib_rmpp_mad {
  170. struct ib_mad_hdr mad_hdr;
  171. struct ib_rmpp_hdr rmpp_hdr;
  172. u8 data[IB_MGMT_RMPP_DATA];
  173. };
  174. struct opa_rmpp_mad {
  175. struct ib_mad_hdr mad_hdr;
  176. struct ib_rmpp_hdr rmpp_hdr;
  177. u8 data[OPA_MGMT_RMPP_DATA];
  178. };
  179. struct ib_sa_mad {
  180. struct ib_mad_hdr mad_hdr;
  181. struct ib_rmpp_hdr rmpp_hdr;
  182. struct ib_sa_hdr sa_hdr;
  183. u8 data[IB_MGMT_SA_DATA];
  184. } __attribute__ ((packed));
  185. struct ib_vendor_mad {
  186. struct ib_mad_hdr mad_hdr;
  187. struct ib_rmpp_hdr rmpp_hdr;
  188. u8 reserved;
  189. u8 oui[3];
  190. u8 data[IB_MGMT_VENDOR_DATA];
  191. };
  192. struct ib_class_port_info {
  193. u8 base_version;
  194. u8 class_version;
  195. __be16 capability_mask;
  196. u8 reserved[3];
  197. u8 resp_time_value;
  198. u8 redirect_gid[16];
  199. __be32 redirect_tcslfl;
  200. __be16 redirect_lid;
  201. __be16 redirect_pkey;
  202. __be32 redirect_qp;
  203. __be32 redirect_qkey;
  204. u8 trap_gid[16];
  205. __be32 trap_tcslfl;
  206. __be16 trap_lid;
  207. __be16 trap_pkey;
  208. __be32 trap_hlqp;
  209. __be32 trap_qkey;
  210. };
  211. /**
  212. * ib_mad_send_buf - MAD data buffer and work request for sends.
  213. * @next: A pointer used to chain together MADs for posting.
  214. * @mad: References an allocated MAD data buffer for MADs that do not have
  215. * RMPP active. For MADs using RMPP, references the common and management
  216. * class specific headers.
  217. * @mad_agent: MAD agent that allocated the buffer.
  218. * @ah: The address handle to use when sending the MAD.
  219. * @context: User-controlled context fields.
  220. * @hdr_len: Indicates the size of the data header of the MAD. This length
  221. * includes the common MAD, RMPP, and class specific headers.
  222. * @data_len: Indicates the total size of user-transferred data.
  223. * @seg_count: The number of RMPP segments allocated for this send.
  224. * @seg_size: Size of the data in each RMPP segment. This does not include
  225. * class specific headers.
  226. * @seg_rmpp_size: Size of each RMPP segment including the class specific
  227. * headers.
  228. * @timeout_ms: Time to wait for a response.
  229. * @retries: Number of times to retry a request for a response. For MADs
  230. * using RMPP, this applies per window. On completion, returns the number
  231. * of retries needed to complete the transfer.
  232. *
  233. * Users are responsible for initializing the MAD buffer itself, with the
  234. * exception of any RMPP header. Additional segment buffer space allocated
  235. * beyond data_len is padding.
  236. */
  237. struct ib_mad_send_buf {
  238. struct ib_mad_send_buf *next;
  239. void *mad;
  240. struct ib_mad_agent *mad_agent;
  241. struct ib_ah *ah;
  242. void *context[2];
  243. int hdr_len;
  244. int data_len;
  245. int seg_count;
  246. int seg_size;
  247. int seg_rmpp_size;
  248. int timeout_ms;
  249. int retries;
  250. };
  251. /**
  252. * ib_response_mad - Returns if the specified MAD has been generated in
  253. * response to a sent request or trap.
  254. */
  255. int ib_response_mad(const struct ib_mad_hdr *hdr);
  256. /**
  257. * ib_get_rmpp_resptime - Returns the RMPP response time.
  258. * @rmpp_hdr: An RMPP header.
  259. */
  260. static inline u8 ib_get_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr)
  261. {
  262. return rmpp_hdr->rmpp_rtime_flags >> 3;
  263. }
  264. /**
  265. * ib_get_rmpp_flags - Returns the RMPP flags.
  266. * @rmpp_hdr: An RMPP header.
  267. */
  268. static inline u8 ib_get_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr)
  269. {
  270. return rmpp_hdr->rmpp_rtime_flags & 0x7;
  271. }
  272. /**
  273. * ib_set_rmpp_resptime - Sets the response time in an RMPP header.
  274. * @rmpp_hdr: An RMPP header.
  275. * @rtime: The response time to set.
  276. */
  277. static inline void ib_set_rmpp_resptime(struct ib_rmpp_hdr *rmpp_hdr, u8 rtime)
  278. {
  279. rmpp_hdr->rmpp_rtime_flags = ib_get_rmpp_flags(rmpp_hdr) | (rtime << 3);
  280. }
  281. /**
  282. * ib_set_rmpp_flags - Sets the flags in an RMPP header.
  283. * @rmpp_hdr: An RMPP header.
  284. * @flags: The flags to set.
  285. */
  286. static inline void ib_set_rmpp_flags(struct ib_rmpp_hdr *rmpp_hdr, u8 flags)
  287. {
  288. rmpp_hdr->rmpp_rtime_flags = (rmpp_hdr->rmpp_rtime_flags & 0xF8) |
  289. (flags & 0x7);
  290. }
  291. struct ib_mad_agent;
  292. struct ib_mad_send_wc;
  293. struct ib_mad_recv_wc;
  294. /**
  295. * ib_mad_send_handler - callback handler for a sent MAD.
  296. * @mad_agent: MAD agent that sent the MAD.
  297. * @mad_send_wc: Send work completion information on the sent MAD.
  298. */
  299. typedef void (*ib_mad_send_handler)(struct ib_mad_agent *mad_agent,
  300. struct ib_mad_send_wc *mad_send_wc);
  301. /**
  302. * ib_mad_snoop_handler - Callback handler for snooping sent MADs.
  303. * @mad_agent: MAD agent that snooped the MAD.
  304. * @send_wr: Work request information on the sent MAD.
  305. * @mad_send_wc: Work completion information on the sent MAD. Valid
  306. * only for snooping that occurs on a send completion.
  307. *
  308. * Clients snooping MADs should not modify data referenced by the @send_wr
  309. * or @mad_send_wc.
  310. */
  311. typedef void (*ib_mad_snoop_handler)(struct ib_mad_agent *mad_agent,
  312. struct ib_mad_send_buf *send_buf,
  313. struct ib_mad_send_wc *mad_send_wc);
  314. /**
  315. * ib_mad_recv_handler - callback handler for a received MAD.
  316. * @mad_agent: MAD agent requesting the received MAD.
  317. * @mad_recv_wc: Received work completion information on the received MAD.
  318. *
  319. * MADs received in response to a send request operation will be handed to
  320. * the user before the send operation completes. All data buffers given
  321. * to registered agents through this routine are owned by the receiving
  322. * client, except for snooping agents. Clients snooping MADs should not
  323. * modify the data referenced by @mad_recv_wc.
  324. */
  325. typedef void (*ib_mad_recv_handler)(struct ib_mad_agent *mad_agent,
  326. struct ib_mad_recv_wc *mad_recv_wc);
  327. /**
  328. * ib_mad_agent - Used to track MAD registration with the access layer.
  329. * @device: Reference to device registration is on.
  330. * @qp: Reference to QP used for sending and receiving MADs.
  331. * @mr: Memory region for system memory usable for DMA.
  332. * @recv_handler: Callback handler for a received MAD.
  333. * @send_handler: Callback handler for a sent MAD.
  334. * @snoop_handler: Callback handler for snooped sent MADs.
  335. * @context: User-specified context associated with this registration.
  336. * @hi_tid: Access layer assigned transaction ID for this client.
  337. * Unsolicited MADs sent by this client will have the upper 32-bits
  338. * of their TID set to this value.
  339. * @flags: registration flags
  340. * @port_num: Port number on which QP is registered
  341. * @rmpp_version: If set, indicates the RMPP version used by this agent.
  342. */
  343. enum {
  344. IB_MAD_USER_RMPP = IB_USER_MAD_USER_RMPP,
  345. };
  346. struct ib_mad_agent {
  347. struct ib_device *device;
  348. struct ib_qp *qp;
  349. struct ib_mr *mr;
  350. ib_mad_recv_handler recv_handler;
  351. ib_mad_send_handler send_handler;
  352. ib_mad_snoop_handler snoop_handler;
  353. void *context;
  354. u32 hi_tid;
  355. u32 flags;
  356. u8 port_num;
  357. u8 rmpp_version;
  358. };
  359. /**
  360. * ib_mad_send_wc - MAD send completion information.
  361. * @send_buf: Send MAD data buffer associated with the send MAD request.
  362. * @status: Completion status.
  363. * @vendor_err: Optional vendor error information returned with a failed
  364. * request.
  365. */
  366. struct ib_mad_send_wc {
  367. struct ib_mad_send_buf *send_buf;
  368. enum ib_wc_status status;
  369. u32 vendor_err;
  370. };
  371. /**
  372. * ib_mad_recv_buf - received MAD buffer information.
  373. * @list: Reference to next data buffer for a received RMPP MAD.
  374. * @grh: References a data buffer containing the global route header.
  375. * The data refereced by this buffer is only valid if the GRH is
  376. * valid.
  377. * @mad: References the start of the received MAD.
  378. */
  379. struct ib_mad_recv_buf {
  380. struct list_head list;
  381. struct ib_grh *grh;
  382. union {
  383. struct ib_mad *mad;
  384. struct opa_mad *opa_mad;
  385. };
  386. };
  387. /**
  388. * ib_mad_recv_wc - received MAD information.
  389. * @wc: Completion information for the received data.
  390. * @recv_buf: Specifies the location of the received data buffer(s).
  391. * @rmpp_list: Specifies a list of RMPP reassembled received MAD buffers.
  392. * @mad_len: The length of the received MAD, without duplicated headers.
  393. * @mad_seg_size: The size of individual MAD segments
  394. *
  395. * For received response, the wr_id contains a pointer to the ib_mad_send_buf
  396. * for the corresponding send request.
  397. */
  398. struct ib_mad_recv_wc {
  399. struct ib_wc *wc;
  400. struct ib_mad_recv_buf recv_buf;
  401. struct list_head rmpp_list;
  402. int mad_len;
  403. size_t mad_seg_size;
  404. };
  405. /**
  406. * ib_mad_reg_req - MAD registration request
  407. * @mgmt_class: Indicates which management class of MADs should be receive
  408. * by the caller. This field is only required if the user wishes to
  409. * receive unsolicited MADs, otherwise it should be 0.
  410. * @mgmt_class_version: Indicates which version of MADs for the given
  411. * management class to receive.
  412. * @oui: Indicates IEEE OUI when mgmt_class is a vendor class
  413. * in the range from 0x30 to 0x4f. Otherwise not used.
  414. * @method_mask: The caller will receive unsolicited MADs for any method
  415. * where @method_mask = 1.
  416. *
  417. */
  418. struct ib_mad_reg_req {
  419. u8 mgmt_class;
  420. u8 mgmt_class_version;
  421. u8 oui[3];
  422. DECLARE_BITMAP(method_mask, IB_MGMT_MAX_METHODS);
  423. };
  424. /**
  425. * ib_register_mad_agent - Register to send/receive MADs.
  426. * @device: The device to register with.
  427. * @port_num: The port on the specified device to use.
  428. * @qp_type: Specifies which QP to access. Must be either
  429. * IB_QPT_SMI or IB_QPT_GSI.
  430. * @mad_reg_req: Specifies which unsolicited MADs should be received
  431. * by the caller. This parameter may be NULL if the caller only
  432. * wishes to receive solicited responses.
  433. * @rmpp_version: If set, indicates that the client will send
  434. * and receive MADs that contain the RMPP header for the given version.
  435. * If set to 0, indicates that RMPP is not used by this client.
  436. * @send_handler: The completion callback routine invoked after a send
  437. * request has completed.
  438. * @recv_handler: The completion callback routine invoked for a received
  439. * MAD.
  440. * @context: User specified context associated with the registration.
  441. * @registration_flags: Registration flags to set for this agent
  442. */
  443. struct ib_mad_agent *ib_register_mad_agent(struct ib_device *device,
  444. u8 port_num,
  445. enum ib_qp_type qp_type,
  446. struct ib_mad_reg_req *mad_reg_req,
  447. u8 rmpp_version,
  448. ib_mad_send_handler send_handler,
  449. ib_mad_recv_handler recv_handler,
  450. void *context,
  451. u32 registration_flags);
  452. enum ib_mad_snoop_flags {
  453. /*IB_MAD_SNOOP_POSTED_SENDS = 1,*/
  454. /*IB_MAD_SNOOP_RMPP_SENDS = (1<<1),*/
  455. IB_MAD_SNOOP_SEND_COMPLETIONS = (1<<2),
  456. /*IB_MAD_SNOOP_RMPP_SEND_COMPLETIONS = (1<<3),*/
  457. IB_MAD_SNOOP_RECVS = (1<<4)
  458. /*IB_MAD_SNOOP_RMPP_RECVS = (1<<5),*/
  459. /*IB_MAD_SNOOP_REDIRECTED_QPS = (1<<6)*/
  460. };
  461. /**
  462. * ib_register_mad_snoop - Register to snoop sent and received MADs.
  463. * @device: The device to register with.
  464. * @port_num: The port on the specified device to use.
  465. * @qp_type: Specifies which QP traffic to snoop. Must be either
  466. * IB_QPT_SMI or IB_QPT_GSI.
  467. * @mad_snoop_flags: Specifies information where snooping occurs.
  468. * @send_handler: The callback routine invoked for a snooped send.
  469. * @recv_handler: The callback routine invoked for a snooped receive.
  470. * @context: User specified context associated with the registration.
  471. */
  472. struct ib_mad_agent *ib_register_mad_snoop(struct ib_device *device,
  473. u8 port_num,
  474. enum ib_qp_type qp_type,
  475. int mad_snoop_flags,
  476. ib_mad_snoop_handler snoop_handler,
  477. ib_mad_recv_handler recv_handler,
  478. void *context);
  479. /**
  480. * ib_unregister_mad_agent - Unregisters a client from using MAD services.
  481. * @mad_agent: Corresponding MAD registration request to deregister.
  482. *
  483. * After invoking this routine, MAD services are no longer usable by the
  484. * client on the associated QP.
  485. */
  486. int ib_unregister_mad_agent(struct ib_mad_agent *mad_agent);
  487. /**
  488. * ib_post_send_mad - Posts MAD(s) to the send queue of the QP associated
  489. * with the registered client.
  490. * @send_buf: Specifies the information needed to send the MAD(s).
  491. * @bad_send_buf: Specifies the MAD on which an error was encountered. This
  492. * parameter is optional if only a single MAD is posted.
  493. *
  494. * Sent MADs are not guaranteed to complete in the order that they were posted.
  495. *
  496. * If the MAD requires RMPP, the data buffer should contain a single copy
  497. * of the common MAD, RMPP, and class specific headers, followed by the class
  498. * defined data. If the class defined data would not divide evenly into
  499. * RMPP segments, then space must be allocated at the end of the referenced
  500. * buffer for any required padding. To indicate the amount of class defined
  501. * data being transferred, the paylen_newwin field in the RMPP header should
  502. * be set to the size of the class specific header plus the amount of class
  503. * defined data being transferred. The paylen_newwin field should be
  504. * specified in network-byte order.
  505. */
  506. int ib_post_send_mad(struct ib_mad_send_buf *send_buf,
  507. struct ib_mad_send_buf **bad_send_buf);
  508. /**
  509. * ib_free_recv_mad - Returns data buffers used to receive a MAD.
  510. * @mad_recv_wc: Work completion information for a received MAD.
  511. *
  512. * Clients receiving MADs through their ib_mad_recv_handler must call this
  513. * routine to return the work completion buffers to the access layer.
  514. */
  515. void ib_free_recv_mad(struct ib_mad_recv_wc *mad_recv_wc);
  516. /**
  517. * ib_cancel_mad - Cancels an outstanding send MAD operation.
  518. * @mad_agent: Specifies the registration associated with sent MAD.
  519. * @send_buf: Indicates the MAD to cancel.
  520. *
  521. * MADs will be returned to the user through the corresponding
  522. * ib_mad_send_handler.
  523. */
  524. void ib_cancel_mad(struct ib_mad_agent *mad_agent,
  525. struct ib_mad_send_buf *send_buf);
  526. /**
  527. * ib_modify_mad - Modifies an outstanding send MAD operation.
  528. * @mad_agent: Specifies the registration associated with sent MAD.
  529. * @send_buf: Indicates the MAD to modify.
  530. * @timeout_ms: New timeout value for sent MAD.
  531. *
  532. * This call will reset the timeout value for a sent MAD to the specified
  533. * value.
  534. */
  535. int ib_modify_mad(struct ib_mad_agent *mad_agent,
  536. struct ib_mad_send_buf *send_buf, u32 timeout_ms);
  537. /**
  538. * ib_redirect_mad_qp - Registers a QP for MAD services.
  539. * @qp: Reference to a QP that requires MAD services.
  540. * @rmpp_version: If set, indicates that the client will send
  541. * and receive MADs that contain the RMPP header for the given version.
  542. * If set to 0, indicates that RMPP is not used by this client.
  543. * @send_handler: The completion callback routine invoked after a send
  544. * request has completed.
  545. * @recv_handler: The completion callback routine invoked for a received
  546. * MAD.
  547. * @context: User specified context associated with the registration.
  548. *
  549. * Use of this call allows clients to use MAD services, such as RMPP,
  550. * on user-owned QPs. After calling this routine, users may send
  551. * MADs on the specified QP by calling ib_mad_post_send.
  552. */
  553. struct ib_mad_agent *ib_redirect_mad_qp(struct ib_qp *qp,
  554. u8 rmpp_version,
  555. ib_mad_send_handler send_handler,
  556. ib_mad_recv_handler recv_handler,
  557. void *context);
  558. /**
  559. * ib_process_mad_wc - Processes a work completion associated with a
  560. * MAD sent or received on a redirected QP.
  561. * @mad_agent: Specifies the registered MAD service using the redirected QP.
  562. * @wc: References a work completion associated with a sent or received
  563. * MAD segment.
  564. *
  565. * This routine is used to complete or continue processing on a MAD request.
  566. * If the work completion is associated with a send operation, calling
  567. * this routine is required to continue an RMPP transfer or to wait for a
  568. * corresponding response, if it is a request. If the work completion is
  569. * associated with a receive operation, calling this routine is required to
  570. * process an inbound or outbound RMPP transfer, or to match a response MAD
  571. * with its corresponding request.
  572. */
  573. int ib_process_mad_wc(struct ib_mad_agent *mad_agent,
  574. struct ib_wc *wc);
  575. /**
  576. * ib_create_send_mad - Allocate and initialize a data buffer and work request
  577. * for sending a MAD.
  578. * @mad_agent: Specifies the registered MAD service to associate with the MAD.
  579. * @remote_qpn: Specifies the QPN of the receiving node.
  580. * @pkey_index: Specifies which PKey the MAD will be sent using. This field
  581. * is valid only if the remote_qpn is QP 1.
  582. * @rmpp_active: Indicates if the send will enable RMPP.
  583. * @hdr_len: Indicates the size of the data header of the MAD. This length
  584. * should include the common MAD header, RMPP header, plus any class
  585. * specific header.
  586. * @data_len: Indicates the size of any user-transferred data. The call will
  587. * automatically adjust the allocated buffer size to account for any
  588. * additional padding that may be necessary.
  589. * @gfp_mask: GFP mask used for the memory allocation.
  590. * @base_version: Base Version of this MAD
  591. *
  592. * This routine allocates a MAD for sending. The returned MAD send buffer
  593. * will reference a data buffer usable for sending a MAD, along
  594. * with an initialized work request structure. Users may modify the returned
  595. * MAD data buffer before posting the send.
  596. *
  597. * The returned MAD header, class specific headers, and any padding will be
  598. * cleared. Users are responsible for initializing the common MAD header,
  599. * any class specific header, and MAD data area.
  600. * If @rmpp_active is set, the RMPP header will be initialized for sending.
  601. */
  602. struct ib_mad_send_buf *ib_create_send_mad(struct ib_mad_agent *mad_agent,
  603. u32 remote_qpn, u16 pkey_index,
  604. int rmpp_active,
  605. int hdr_len, int data_len,
  606. gfp_t gfp_mask,
  607. u8 base_version);
  608. /**
  609. * ib_is_mad_class_rmpp - returns whether given management class
  610. * supports RMPP.
  611. * @mgmt_class: management class
  612. *
  613. * This routine returns whether the management class supports RMPP.
  614. */
  615. int ib_is_mad_class_rmpp(u8 mgmt_class);
  616. /**
  617. * ib_get_mad_data_offset - returns the data offset for a given
  618. * management class.
  619. * @mgmt_class: management class
  620. *
  621. * This routine returns the data offset in the MAD for the management
  622. * class requested.
  623. */
  624. int ib_get_mad_data_offset(u8 mgmt_class);
  625. /**
  626. * ib_get_rmpp_segment - returns the data buffer for a given RMPP segment.
  627. * @send_buf: Previously allocated send data buffer.
  628. * @seg_num: number of segment to return
  629. *
  630. * This routine returns a pointer to the data buffer of an RMPP MAD.
  631. * Users must provide synchronization to @send_buf around this call.
  632. */
  633. void *ib_get_rmpp_segment(struct ib_mad_send_buf *send_buf, int seg_num);
  634. /**
  635. * ib_free_send_mad - Returns data buffers used to send a MAD.
  636. * @send_buf: Previously allocated send data buffer.
  637. */
  638. void ib_free_send_mad(struct ib_mad_send_buf *send_buf);
  639. /**
  640. * ib_mad_kernel_rmpp_agent - Returns if the agent is performing RMPP.
  641. * @agent: the agent in question
  642. * @return: true if agent is performing rmpp, false otherwise.
  643. */
  644. int ib_mad_kernel_rmpp_agent(const struct ib_mad_agent *agent);
  645. #endif /* IB_MAD_H */