ib_verbs.h 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461
  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. * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
  8. * Copyright (c) 2005 Cisco Systems. All rights reserved.
  9. *
  10. * This software is available to you under a choice of one of two
  11. * licenses. You may choose to be licensed under the terms of the GNU
  12. * General Public License (GPL) Version 2, available from the file
  13. * COPYING in the main directory of this source tree, or the
  14. * OpenIB.org BSD license below:
  15. *
  16. * Redistribution and use in source and binary forms, with or
  17. * without modification, are permitted provided that the following
  18. * conditions are met:
  19. *
  20. * - Redistributions of source code must retain the above
  21. * copyright notice, this list of conditions and the following
  22. * disclaimer.
  23. *
  24. * - Redistributions in binary form must reproduce the above
  25. * copyright notice, this list of conditions and the following
  26. * disclaimer in the documentation and/or other materials
  27. * provided with the distribution.
  28. *
  29. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  30. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  31. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  32. * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  33. * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  34. * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  35. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  36. * SOFTWARE.
  37. *
  38. * $Id: ib_verbs.h 1349 2004-12-16 21:09:43Z roland $
  39. */
  40. #if !defined(IB_VERBS_H)
  41. #define IB_VERBS_H
  42. #include <linux/types.h>
  43. #include <linux/device.h>
  44. #include <asm/atomic.h>
  45. #include <asm/scatterlist.h>
  46. #include <asm/uaccess.h>
  47. union ib_gid {
  48. u8 raw[16];
  49. struct {
  50. __be64 subnet_prefix;
  51. __be64 interface_id;
  52. } global;
  53. };
  54. enum ib_node_type {
  55. IB_NODE_CA = 1,
  56. IB_NODE_SWITCH,
  57. IB_NODE_ROUTER
  58. };
  59. enum ib_device_cap_flags {
  60. IB_DEVICE_RESIZE_MAX_WR = 1,
  61. IB_DEVICE_BAD_PKEY_CNTR = (1<<1),
  62. IB_DEVICE_BAD_QKEY_CNTR = (1<<2),
  63. IB_DEVICE_RAW_MULTI = (1<<3),
  64. IB_DEVICE_AUTO_PATH_MIG = (1<<4),
  65. IB_DEVICE_CHANGE_PHY_PORT = (1<<5),
  66. IB_DEVICE_UD_AV_PORT_ENFORCE = (1<<6),
  67. IB_DEVICE_CURR_QP_STATE_MOD = (1<<7),
  68. IB_DEVICE_SHUTDOWN_PORT = (1<<8),
  69. IB_DEVICE_INIT_TYPE = (1<<9),
  70. IB_DEVICE_PORT_ACTIVE_EVENT = (1<<10),
  71. IB_DEVICE_SYS_IMAGE_GUID = (1<<11),
  72. IB_DEVICE_RC_RNR_NAK_GEN = (1<<12),
  73. IB_DEVICE_SRQ_RESIZE = (1<<13),
  74. IB_DEVICE_N_NOTIFY_CQ = (1<<14),
  75. };
  76. enum ib_atomic_cap {
  77. IB_ATOMIC_NONE,
  78. IB_ATOMIC_HCA,
  79. IB_ATOMIC_GLOB
  80. };
  81. struct ib_device_attr {
  82. u64 fw_ver;
  83. __be64 node_guid;
  84. __be64 sys_image_guid;
  85. u64 max_mr_size;
  86. u64 page_size_cap;
  87. u32 vendor_id;
  88. u32 vendor_part_id;
  89. u32 hw_ver;
  90. int max_qp;
  91. int max_qp_wr;
  92. int device_cap_flags;
  93. int max_sge;
  94. int max_sge_rd;
  95. int max_cq;
  96. int max_cqe;
  97. int max_mr;
  98. int max_pd;
  99. int max_qp_rd_atom;
  100. int max_ee_rd_atom;
  101. int max_res_rd_atom;
  102. int max_qp_init_rd_atom;
  103. int max_ee_init_rd_atom;
  104. enum ib_atomic_cap atomic_cap;
  105. int max_ee;
  106. int max_rdd;
  107. int max_mw;
  108. int max_raw_ipv6_qp;
  109. int max_raw_ethy_qp;
  110. int max_mcast_grp;
  111. int max_mcast_qp_attach;
  112. int max_total_mcast_qp_attach;
  113. int max_ah;
  114. int max_fmr;
  115. int max_map_per_fmr;
  116. int max_srq;
  117. int max_srq_wr;
  118. int max_srq_sge;
  119. u16 max_pkeys;
  120. u8 local_ca_ack_delay;
  121. };
  122. enum ib_mtu {
  123. IB_MTU_256 = 1,
  124. IB_MTU_512 = 2,
  125. IB_MTU_1024 = 3,
  126. IB_MTU_2048 = 4,
  127. IB_MTU_4096 = 5
  128. };
  129. static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
  130. {
  131. switch (mtu) {
  132. case IB_MTU_256: return 256;
  133. case IB_MTU_512: return 512;
  134. case IB_MTU_1024: return 1024;
  135. case IB_MTU_2048: return 2048;
  136. case IB_MTU_4096: return 4096;
  137. default: return -1;
  138. }
  139. }
  140. enum ib_port_state {
  141. IB_PORT_NOP = 0,
  142. IB_PORT_DOWN = 1,
  143. IB_PORT_INIT = 2,
  144. IB_PORT_ARMED = 3,
  145. IB_PORT_ACTIVE = 4,
  146. IB_PORT_ACTIVE_DEFER = 5
  147. };
  148. enum ib_port_cap_flags {
  149. IB_PORT_SM = 1 << 1,
  150. IB_PORT_NOTICE_SUP = 1 << 2,
  151. IB_PORT_TRAP_SUP = 1 << 3,
  152. IB_PORT_OPT_IPD_SUP = 1 << 4,
  153. IB_PORT_AUTO_MIGR_SUP = 1 << 5,
  154. IB_PORT_SL_MAP_SUP = 1 << 6,
  155. IB_PORT_MKEY_NVRAM = 1 << 7,
  156. IB_PORT_PKEY_NVRAM = 1 << 8,
  157. IB_PORT_LED_INFO_SUP = 1 << 9,
  158. IB_PORT_SM_DISABLED = 1 << 10,
  159. IB_PORT_SYS_IMAGE_GUID_SUP = 1 << 11,
  160. IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP = 1 << 12,
  161. IB_PORT_CM_SUP = 1 << 16,
  162. IB_PORT_SNMP_TUNNEL_SUP = 1 << 17,
  163. IB_PORT_REINIT_SUP = 1 << 18,
  164. IB_PORT_DEVICE_MGMT_SUP = 1 << 19,
  165. IB_PORT_VENDOR_CLASS_SUP = 1 << 20,
  166. IB_PORT_DR_NOTICE_SUP = 1 << 21,
  167. IB_PORT_CAP_MASK_NOTICE_SUP = 1 << 22,
  168. IB_PORT_BOOT_MGMT_SUP = 1 << 23,
  169. IB_PORT_LINK_LATENCY_SUP = 1 << 24,
  170. IB_PORT_CLIENT_REG_SUP = 1 << 25
  171. };
  172. enum ib_port_width {
  173. IB_WIDTH_1X = 1,
  174. IB_WIDTH_4X = 2,
  175. IB_WIDTH_8X = 4,
  176. IB_WIDTH_12X = 8
  177. };
  178. static inline int ib_width_enum_to_int(enum ib_port_width width)
  179. {
  180. switch (width) {
  181. case IB_WIDTH_1X: return 1;
  182. case IB_WIDTH_4X: return 4;
  183. case IB_WIDTH_8X: return 8;
  184. case IB_WIDTH_12X: return 12;
  185. default: return -1;
  186. }
  187. }
  188. struct ib_port_attr {
  189. enum ib_port_state state;
  190. enum ib_mtu max_mtu;
  191. enum ib_mtu active_mtu;
  192. int gid_tbl_len;
  193. u32 port_cap_flags;
  194. u32 max_msg_sz;
  195. u32 bad_pkey_cntr;
  196. u32 qkey_viol_cntr;
  197. u16 pkey_tbl_len;
  198. u16 lid;
  199. u16 sm_lid;
  200. u8 lmc;
  201. u8 max_vl_num;
  202. u8 sm_sl;
  203. u8 subnet_timeout;
  204. u8 init_type_reply;
  205. u8 active_width;
  206. u8 active_speed;
  207. u8 phys_state;
  208. };
  209. enum ib_device_modify_flags {
  210. IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1
  211. };
  212. struct ib_device_modify {
  213. u64 sys_image_guid;
  214. };
  215. enum ib_port_modify_flags {
  216. IB_PORT_SHUTDOWN = 1,
  217. IB_PORT_INIT_TYPE = (1<<2),
  218. IB_PORT_RESET_QKEY_CNTR = (1<<3)
  219. };
  220. struct ib_port_modify {
  221. u32 set_port_cap_mask;
  222. u32 clr_port_cap_mask;
  223. u8 init_type;
  224. };
  225. enum ib_event_type {
  226. IB_EVENT_CQ_ERR,
  227. IB_EVENT_QP_FATAL,
  228. IB_EVENT_QP_REQ_ERR,
  229. IB_EVENT_QP_ACCESS_ERR,
  230. IB_EVENT_COMM_EST,
  231. IB_EVENT_SQ_DRAINED,
  232. IB_EVENT_PATH_MIG,
  233. IB_EVENT_PATH_MIG_ERR,
  234. IB_EVENT_DEVICE_FATAL,
  235. IB_EVENT_PORT_ACTIVE,
  236. IB_EVENT_PORT_ERR,
  237. IB_EVENT_LID_CHANGE,
  238. IB_EVENT_PKEY_CHANGE,
  239. IB_EVENT_SM_CHANGE,
  240. IB_EVENT_SRQ_ERR,
  241. IB_EVENT_SRQ_LIMIT_REACHED,
  242. IB_EVENT_QP_LAST_WQE_REACHED
  243. };
  244. struct ib_event {
  245. struct ib_device *device;
  246. union {
  247. struct ib_cq *cq;
  248. struct ib_qp *qp;
  249. struct ib_srq *srq;
  250. u8 port_num;
  251. } element;
  252. enum ib_event_type event;
  253. };
  254. struct ib_event_handler {
  255. struct ib_device *device;
  256. void (*handler)(struct ib_event_handler *, struct ib_event *);
  257. struct list_head list;
  258. };
  259. #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler) \
  260. do { \
  261. (_ptr)->device = _device; \
  262. (_ptr)->handler = _handler; \
  263. INIT_LIST_HEAD(&(_ptr)->list); \
  264. } while (0)
  265. struct ib_global_route {
  266. union ib_gid dgid;
  267. u32 flow_label;
  268. u8 sgid_index;
  269. u8 hop_limit;
  270. u8 traffic_class;
  271. };
  272. struct ib_grh {
  273. __be32 version_tclass_flow;
  274. __be16 paylen;
  275. u8 next_hdr;
  276. u8 hop_limit;
  277. union ib_gid sgid;
  278. union ib_gid dgid;
  279. };
  280. enum {
  281. IB_MULTICAST_QPN = 0xffffff
  282. };
  283. #define IB_LID_PERMISSIVE __constant_htons(0xFFFF)
  284. enum ib_ah_flags {
  285. IB_AH_GRH = 1
  286. };
  287. struct ib_ah_attr {
  288. struct ib_global_route grh;
  289. u16 dlid;
  290. u8 sl;
  291. u8 src_path_bits;
  292. u8 static_rate;
  293. u8 ah_flags;
  294. u8 port_num;
  295. };
  296. enum ib_wc_status {
  297. IB_WC_SUCCESS,
  298. IB_WC_LOC_LEN_ERR,
  299. IB_WC_LOC_QP_OP_ERR,
  300. IB_WC_LOC_EEC_OP_ERR,
  301. IB_WC_LOC_PROT_ERR,
  302. IB_WC_WR_FLUSH_ERR,
  303. IB_WC_MW_BIND_ERR,
  304. IB_WC_BAD_RESP_ERR,
  305. IB_WC_LOC_ACCESS_ERR,
  306. IB_WC_REM_INV_REQ_ERR,
  307. IB_WC_REM_ACCESS_ERR,
  308. IB_WC_REM_OP_ERR,
  309. IB_WC_RETRY_EXC_ERR,
  310. IB_WC_RNR_RETRY_EXC_ERR,
  311. IB_WC_LOC_RDD_VIOL_ERR,
  312. IB_WC_REM_INV_RD_REQ_ERR,
  313. IB_WC_REM_ABORT_ERR,
  314. IB_WC_INV_EECN_ERR,
  315. IB_WC_INV_EEC_STATE_ERR,
  316. IB_WC_FATAL_ERR,
  317. IB_WC_RESP_TIMEOUT_ERR,
  318. IB_WC_GENERAL_ERR
  319. };
  320. enum ib_wc_opcode {
  321. IB_WC_SEND,
  322. IB_WC_RDMA_WRITE,
  323. IB_WC_RDMA_READ,
  324. IB_WC_COMP_SWAP,
  325. IB_WC_FETCH_ADD,
  326. IB_WC_BIND_MW,
  327. /*
  328. * Set value of IB_WC_RECV so consumers can test if a completion is a
  329. * receive by testing (opcode & IB_WC_RECV).
  330. */
  331. IB_WC_RECV = 1 << 7,
  332. IB_WC_RECV_RDMA_WITH_IMM
  333. };
  334. enum ib_wc_flags {
  335. IB_WC_GRH = 1,
  336. IB_WC_WITH_IMM = (1<<1)
  337. };
  338. struct ib_wc {
  339. u64 wr_id;
  340. enum ib_wc_status status;
  341. enum ib_wc_opcode opcode;
  342. u32 vendor_err;
  343. u32 byte_len;
  344. __be32 imm_data;
  345. u32 qp_num;
  346. u32 src_qp;
  347. int wc_flags;
  348. u16 pkey_index;
  349. u16 slid;
  350. u8 sl;
  351. u8 dlid_path_bits;
  352. u8 port_num; /* valid only for DR SMPs on switches */
  353. };
  354. enum ib_cq_notify {
  355. IB_CQ_SOLICITED,
  356. IB_CQ_NEXT_COMP
  357. };
  358. enum ib_srq_attr_mask {
  359. IB_SRQ_MAX_WR = 1 << 0,
  360. IB_SRQ_LIMIT = 1 << 1,
  361. };
  362. struct ib_srq_attr {
  363. u32 max_wr;
  364. u32 max_sge;
  365. u32 srq_limit;
  366. };
  367. struct ib_srq_init_attr {
  368. void (*event_handler)(struct ib_event *, void *);
  369. void *srq_context;
  370. struct ib_srq_attr attr;
  371. };
  372. struct ib_qp_cap {
  373. u32 max_send_wr;
  374. u32 max_recv_wr;
  375. u32 max_send_sge;
  376. u32 max_recv_sge;
  377. u32 max_inline_data;
  378. };
  379. enum ib_sig_type {
  380. IB_SIGNAL_ALL_WR,
  381. IB_SIGNAL_REQ_WR
  382. };
  383. enum ib_qp_type {
  384. /*
  385. * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
  386. * here (and in that order) since the MAD layer uses them as
  387. * indices into a 2-entry table.
  388. */
  389. IB_QPT_SMI,
  390. IB_QPT_GSI,
  391. IB_QPT_RC,
  392. IB_QPT_UC,
  393. IB_QPT_UD,
  394. IB_QPT_RAW_IPV6,
  395. IB_QPT_RAW_ETY
  396. };
  397. struct ib_qp_init_attr {
  398. void (*event_handler)(struct ib_event *, void *);
  399. void *qp_context;
  400. struct ib_cq *send_cq;
  401. struct ib_cq *recv_cq;
  402. struct ib_srq *srq;
  403. struct ib_qp_cap cap;
  404. enum ib_sig_type sq_sig_type;
  405. enum ib_qp_type qp_type;
  406. u8 port_num; /* special QP types only */
  407. };
  408. enum ib_rnr_timeout {
  409. IB_RNR_TIMER_655_36 = 0,
  410. IB_RNR_TIMER_000_01 = 1,
  411. IB_RNR_TIMER_000_02 = 2,
  412. IB_RNR_TIMER_000_03 = 3,
  413. IB_RNR_TIMER_000_04 = 4,
  414. IB_RNR_TIMER_000_06 = 5,
  415. IB_RNR_TIMER_000_08 = 6,
  416. IB_RNR_TIMER_000_12 = 7,
  417. IB_RNR_TIMER_000_16 = 8,
  418. IB_RNR_TIMER_000_24 = 9,
  419. IB_RNR_TIMER_000_32 = 10,
  420. IB_RNR_TIMER_000_48 = 11,
  421. IB_RNR_TIMER_000_64 = 12,
  422. IB_RNR_TIMER_000_96 = 13,
  423. IB_RNR_TIMER_001_28 = 14,
  424. IB_RNR_TIMER_001_92 = 15,
  425. IB_RNR_TIMER_002_56 = 16,
  426. IB_RNR_TIMER_003_84 = 17,
  427. IB_RNR_TIMER_005_12 = 18,
  428. IB_RNR_TIMER_007_68 = 19,
  429. IB_RNR_TIMER_010_24 = 20,
  430. IB_RNR_TIMER_015_36 = 21,
  431. IB_RNR_TIMER_020_48 = 22,
  432. IB_RNR_TIMER_030_72 = 23,
  433. IB_RNR_TIMER_040_96 = 24,
  434. IB_RNR_TIMER_061_44 = 25,
  435. IB_RNR_TIMER_081_92 = 26,
  436. IB_RNR_TIMER_122_88 = 27,
  437. IB_RNR_TIMER_163_84 = 28,
  438. IB_RNR_TIMER_245_76 = 29,
  439. IB_RNR_TIMER_327_68 = 30,
  440. IB_RNR_TIMER_491_52 = 31
  441. };
  442. enum ib_qp_attr_mask {
  443. IB_QP_STATE = 1,
  444. IB_QP_CUR_STATE = (1<<1),
  445. IB_QP_EN_SQD_ASYNC_NOTIFY = (1<<2),
  446. IB_QP_ACCESS_FLAGS = (1<<3),
  447. IB_QP_PKEY_INDEX = (1<<4),
  448. IB_QP_PORT = (1<<5),
  449. IB_QP_QKEY = (1<<6),
  450. IB_QP_AV = (1<<7),
  451. IB_QP_PATH_MTU = (1<<8),
  452. IB_QP_TIMEOUT = (1<<9),
  453. IB_QP_RETRY_CNT = (1<<10),
  454. IB_QP_RNR_RETRY = (1<<11),
  455. IB_QP_RQ_PSN = (1<<12),
  456. IB_QP_MAX_QP_RD_ATOMIC = (1<<13),
  457. IB_QP_ALT_PATH = (1<<14),
  458. IB_QP_MIN_RNR_TIMER = (1<<15),
  459. IB_QP_SQ_PSN = (1<<16),
  460. IB_QP_MAX_DEST_RD_ATOMIC = (1<<17),
  461. IB_QP_PATH_MIG_STATE = (1<<18),
  462. IB_QP_CAP = (1<<19),
  463. IB_QP_DEST_QPN = (1<<20)
  464. };
  465. enum ib_qp_state {
  466. IB_QPS_RESET,
  467. IB_QPS_INIT,
  468. IB_QPS_RTR,
  469. IB_QPS_RTS,
  470. IB_QPS_SQD,
  471. IB_QPS_SQE,
  472. IB_QPS_ERR
  473. };
  474. enum ib_mig_state {
  475. IB_MIG_MIGRATED,
  476. IB_MIG_REARM,
  477. IB_MIG_ARMED
  478. };
  479. struct ib_qp_attr {
  480. enum ib_qp_state qp_state;
  481. enum ib_qp_state cur_qp_state;
  482. enum ib_mtu path_mtu;
  483. enum ib_mig_state path_mig_state;
  484. u32 qkey;
  485. u32 rq_psn;
  486. u32 sq_psn;
  487. u32 dest_qp_num;
  488. int qp_access_flags;
  489. struct ib_qp_cap cap;
  490. struct ib_ah_attr ah_attr;
  491. struct ib_ah_attr alt_ah_attr;
  492. u16 pkey_index;
  493. u16 alt_pkey_index;
  494. u8 en_sqd_async_notify;
  495. u8 sq_draining;
  496. u8 max_rd_atomic;
  497. u8 max_dest_rd_atomic;
  498. u8 min_rnr_timer;
  499. u8 port_num;
  500. u8 timeout;
  501. u8 retry_cnt;
  502. u8 rnr_retry;
  503. u8 alt_port_num;
  504. u8 alt_timeout;
  505. };
  506. enum ib_wr_opcode {
  507. IB_WR_RDMA_WRITE,
  508. IB_WR_RDMA_WRITE_WITH_IMM,
  509. IB_WR_SEND,
  510. IB_WR_SEND_WITH_IMM,
  511. IB_WR_RDMA_READ,
  512. IB_WR_ATOMIC_CMP_AND_SWP,
  513. IB_WR_ATOMIC_FETCH_AND_ADD
  514. };
  515. enum ib_send_flags {
  516. IB_SEND_FENCE = 1,
  517. IB_SEND_SIGNALED = (1<<1),
  518. IB_SEND_SOLICITED = (1<<2),
  519. IB_SEND_INLINE = (1<<3)
  520. };
  521. struct ib_sge {
  522. u64 addr;
  523. u32 length;
  524. u32 lkey;
  525. };
  526. struct ib_send_wr {
  527. struct ib_send_wr *next;
  528. u64 wr_id;
  529. struct ib_sge *sg_list;
  530. int num_sge;
  531. enum ib_wr_opcode opcode;
  532. int send_flags;
  533. __be32 imm_data;
  534. union {
  535. struct {
  536. u64 remote_addr;
  537. u32 rkey;
  538. } rdma;
  539. struct {
  540. u64 remote_addr;
  541. u64 compare_add;
  542. u64 swap;
  543. u32 rkey;
  544. } atomic;
  545. struct {
  546. struct ib_ah *ah;
  547. struct ib_mad_hdr *mad_hdr;
  548. u32 remote_qpn;
  549. u32 remote_qkey;
  550. int timeout_ms; /* valid for MADs only */
  551. int retries; /* valid for MADs only */
  552. u16 pkey_index; /* valid for GSI only */
  553. u8 port_num; /* valid for DR SMPs on switch only */
  554. } ud;
  555. } wr;
  556. };
  557. struct ib_recv_wr {
  558. struct ib_recv_wr *next;
  559. u64 wr_id;
  560. struct ib_sge *sg_list;
  561. int num_sge;
  562. };
  563. enum ib_access_flags {
  564. IB_ACCESS_LOCAL_WRITE = 1,
  565. IB_ACCESS_REMOTE_WRITE = (1<<1),
  566. IB_ACCESS_REMOTE_READ = (1<<2),
  567. IB_ACCESS_REMOTE_ATOMIC = (1<<3),
  568. IB_ACCESS_MW_BIND = (1<<4)
  569. };
  570. struct ib_phys_buf {
  571. u64 addr;
  572. u64 size;
  573. };
  574. struct ib_mr_attr {
  575. struct ib_pd *pd;
  576. u64 device_virt_addr;
  577. u64 size;
  578. int mr_access_flags;
  579. u32 lkey;
  580. u32 rkey;
  581. };
  582. enum ib_mr_rereg_flags {
  583. IB_MR_REREG_TRANS = 1,
  584. IB_MR_REREG_PD = (1<<1),
  585. IB_MR_REREG_ACCESS = (1<<2)
  586. };
  587. struct ib_mw_bind {
  588. struct ib_mr *mr;
  589. u64 wr_id;
  590. u64 addr;
  591. u32 length;
  592. int send_flags;
  593. int mw_access_flags;
  594. };
  595. struct ib_fmr_attr {
  596. int max_pages;
  597. int max_maps;
  598. u8 page_size;
  599. };
  600. struct ib_ucontext {
  601. struct ib_device *device;
  602. struct list_head pd_list;
  603. struct list_head mr_list;
  604. struct list_head mw_list;
  605. struct list_head cq_list;
  606. struct list_head qp_list;
  607. struct list_head srq_list;
  608. struct list_head ah_list;
  609. spinlock_t lock;
  610. };
  611. struct ib_uobject {
  612. u64 user_handle; /* handle given to us by userspace */
  613. struct ib_ucontext *context; /* associated user context */
  614. struct list_head list; /* link to context's list */
  615. u32 id; /* index into kernel idr */
  616. };
  617. struct ib_umem {
  618. unsigned long user_base;
  619. unsigned long virt_base;
  620. size_t length;
  621. int offset;
  622. int page_size;
  623. int writable;
  624. struct list_head chunk_list;
  625. };
  626. struct ib_umem_chunk {
  627. struct list_head list;
  628. int nents;
  629. int nmap;
  630. struct scatterlist page_list[0];
  631. };
  632. struct ib_udata {
  633. void __user *inbuf;
  634. void __user *outbuf;
  635. size_t inlen;
  636. size_t outlen;
  637. };
  638. #define IB_UMEM_MAX_PAGE_CHUNK \
  639. ((PAGE_SIZE - offsetof(struct ib_umem_chunk, page_list)) / \
  640. ((void *) &((struct ib_umem_chunk *) 0)->page_list[1] - \
  641. (void *) &((struct ib_umem_chunk *) 0)->page_list[0]))
  642. struct ib_umem_object {
  643. struct ib_uobject uobject;
  644. struct ib_umem umem;
  645. };
  646. struct ib_pd {
  647. struct ib_device *device;
  648. struct ib_uobject *uobject;
  649. atomic_t usecnt; /* count all resources */
  650. };
  651. struct ib_ah {
  652. struct ib_device *device;
  653. struct ib_pd *pd;
  654. struct ib_uobject *uobject;
  655. };
  656. typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
  657. struct ib_cq {
  658. struct ib_device *device;
  659. struct ib_uobject *uobject;
  660. ib_comp_handler comp_handler;
  661. void (*event_handler)(struct ib_event *, void *);
  662. void * cq_context;
  663. int cqe;
  664. atomic_t usecnt; /* count number of work queues */
  665. };
  666. struct ib_srq {
  667. struct ib_device *device;
  668. struct ib_pd *pd;
  669. struct ib_uobject *uobject;
  670. void (*event_handler)(struct ib_event *, void *);
  671. void *srq_context;
  672. atomic_t usecnt;
  673. };
  674. struct ib_qp {
  675. struct ib_device *device;
  676. struct ib_pd *pd;
  677. struct ib_cq *send_cq;
  678. struct ib_cq *recv_cq;
  679. struct ib_srq *srq;
  680. struct ib_uobject *uobject;
  681. void (*event_handler)(struct ib_event *, void *);
  682. void *qp_context;
  683. u32 qp_num;
  684. enum ib_qp_type qp_type;
  685. };
  686. struct ib_mr {
  687. struct ib_device *device;
  688. struct ib_pd *pd;
  689. struct ib_uobject *uobject;
  690. u32 lkey;
  691. u32 rkey;
  692. atomic_t usecnt; /* count number of MWs */
  693. };
  694. struct ib_mw {
  695. struct ib_device *device;
  696. struct ib_pd *pd;
  697. struct ib_uobject *uobject;
  698. u32 rkey;
  699. };
  700. struct ib_fmr {
  701. struct ib_device *device;
  702. struct ib_pd *pd;
  703. struct list_head list;
  704. u32 lkey;
  705. u32 rkey;
  706. };
  707. struct ib_mad;
  708. struct ib_grh;
  709. enum ib_process_mad_flags {
  710. IB_MAD_IGNORE_MKEY = 1,
  711. IB_MAD_IGNORE_BKEY = 2,
  712. IB_MAD_IGNORE_ALL = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
  713. };
  714. enum ib_mad_result {
  715. IB_MAD_RESULT_FAILURE = 0, /* (!SUCCESS is the important flag) */
  716. IB_MAD_RESULT_SUCCESS = 1 << 0, /* MAD was successfully processed */
  717. IB_MAD_RESULT_REPLY = 1 << 1, /* Reply packet needs to be sent */
  718. IB_MAD_RESULT_CONSUMED = 1 << 2 /* Packet consumed: stop processing */
  719. };
  720. #define IB_DEVICE_NAME_MAX 64
  721. struct ib_cache {
  722. rwlock_t lock;
  723. struct ib_event_handler event_handler;
  724. struct ib_pkey_cache **pkey_cache;
  725. struct ib_gid_cache **gid_cache;
  726. };
  727. struct ib_device {
  728. struct device *dma_device;
  729. char name[IB_DEVICE_NAME_MAX];
  730. struct list_head event_handler_list;
  731. spinlock_t event_handler_lock;
  732. struct list_head core_list;
  733. struct list_head client_data_list;
  734. spinlock_t client_data_lock;
  735. struct ib_cache cache;
  736. u32 flags;
  737. int (*query_device)(struct ib_device *device,
  738. struct ib_device_attr *device_attr);
  739. int (*query_port)(struct ib_device *device,
  740. u8 port_num,
  741. struct ib_port_attr *port_attr);
  742. int (*query_gid)(struct ib_device *device,
  743. u8 port_num, int index,
  744. union ib_gid *gid);
  745. int (*query_pkey)(struct ib_device *device,
  746. u8 port_num, u16 index, u16 *pkey);
  747. int (*modify_device)(struct ib_device *device,
  748. int device_modify_mask,
  749. struct ib_device_modify *device_modify);
  750. int (*modify_port)(struct ib_device *device,
  751. u8 port_num, int port_modify_mask,
  752. struct ib_port_modify *port_modify);
  753. struct ib_ucontext * (*alloc_ucontext)(struct ib_device *device,
  754. struct ib_udata *udata);
  755. int (*dealloc_ucontext)(struct ib_ucontext *context);
  756. int (*mmap)(struct ib_ucontext *context,
  757. struct vm_area_struct *vma);
  758. struct ib_pd * (*alloc_pd)(struct ib_device *device,
  759. struct ib_ucontext *context,
  760. struct ib_udata *udata);
  761. int (*dealloc_pd)(struct ib_pd *pd);
  762. struct ib_ah * (*create_ah)(struct ib_pd *pd,
  763. struct ib_ah_attr *ah_attr);
  764. int (*modify_ah)(struct ib_ah *ah,
  765. struct ib_ah_attr *ah_attr);
  766. int (*query_ah)(struct ib_ah *ah,
  767. struct ib_ah_attr *ah_attr);
  768. int (*destroy_ah)(struct ib_ah *ah);
  769. struct ib_srq * (*create_srq)(struct ib_pd *pd,
  770. struct ib_srq_init_attr *srq_init_attr,
  771. struct ib_udata *udata);
  772. int (*modify_srq)(struct ib_srq *srq,
  773. struct ib_srq_attr *srq_attr,
  774. enum ib_srq_attr_mask srq_attr_mask);
  775. int (*query_srq)(struct ib_srq *srq,
  776. struct ib_srq_attr *srq_attr);
  777. int (*destroy_srq)(struct ib_srq *srq);
  778. int (*post_srq_recv)(struct ib_srq *srq,
  779. struct ib_recv_wr *recv_wr,
  780. struct ib_recv_wr **bad_recv_wr);
  781. struct ib_qp * (*create_qp)(struct ib_pd *pd,
  782. struct ib_qp_init_attr *qp_init_attr,
  783. struct ib_udata *udata);
  784. int (*modify_qp)(struct ib_qp *qp,
  785. struct ib_qp_attr *qp_attr,
  786. int qp_attr_mask);
  787. int (*query_qp)(struct ib_qp *qp,
  788. struct ib_qp_attr *qp_attr,
  789. int qp_attr_mask,
  790. struct ib_qp_init_attr *qp_init_attr);
  791. int (*destroy_qp)(struct ib_qp *qp);
  792. int (*post_send)(struct ib_qp *qp,
  793. struct ib_send_wr *send_wr,
  794. struct ib_send_wr **bad_send_wr);
  795. int (*post_recv)(struct ib_qp *qp,
  796. struct ib_recv_wr *recv_wr,
  797. struct ib_recv_wr **bad_recv_wr);
  798. struct ib_cq * (*create_cq)(struct ib_device *device, int cqe,
  799. struct ib_ucontext *context,
  800. struct ib_udata *udata);
  801. int (*destroy_cq)(struct ib_cq *cq);
  802. int (*resize_cq)(struct ib_cq *cq, int *cqe);
  803. int (*poll_cq)(struct ib_cq *cq, int num_entries,
  804. struct ib_wc *wc);
  805. int (*peek_cq)(struct ib_cq *cq, int wc_cnt);
  806. int (*req_notify_cq)(struct ib_cq *cq,
  807. enum ib_cq_notify cq_notify);
  808. int (*req_ncomp_notif)(struct ib_cq *cq,
  809. int wc_cnt);
  810. struct ib_mr * (*get_dma_mr)(struct ib_pd *pd,
  811. int mr_access_flags);
  812. struct ib_mr * (*reg_phys_mr)(struct ib_pd *pd,
  813. struct ib_phys_buf *phys_buf_array,
  814. int num_phys_buf,
  815. int mr_access_flags,
  816. u64 *iova_start);
  817. struct ib_mr * (*reg_user_mr)(struct ib_pd *pd,
  818. struct ib_umem *region,
  819. int mr_access_flags,
  820. struct ib_udata *udata);
  821. int (*query_mr)(struct ib_mr *mr,
  822. struct ib_mr_attr *mr_attr);
  823. int (*dereg_mr)(struct ib_mr *mr);
  824. int (*rereg_phys_mr)(struct ib_mr *mr,
  825. int mr_rereg_mask,
  826. struct ib_pd *pd,
  827. struct ib_phys_buf *phys_buf_array,
  828. int num_phys_buf,
  829. int mr_access_flags,
  830. u64 *iova_start);
  831. struct ib_mw * (*alloc_mw)(struct ib_pd *pd);
  832. int (*bind_mw)(struct ib_qp *qp,
  833. struct ib_mw *mw,
  834. struct ib_mw_bind *mw_bind);
  835. int (*dealloc_mw)(struct ib_mw *mw);
  836. struct ib_fmr * (*alloc_fmr)(struct ib_pd *pd,
  837. int mr_access_flags,
  838. struct ib_fmr_attr *fmr_attr);
  839. int (*map_phys_fmr)(struct ib_fmr *fmr,
  840. u64 *page_list, int list_len,
  841. u64 iova);
  842. int (*unmap_fmr)(struct list_head *fmr_list);
  843. int (*dealloc_fmr)(struct ib_fmr *fmr);
  844. int (*attach_mcast)(struct ib_qp *qp,
  845. union ib_gid *gid,
  846. u16 lid);
  847. int (*detach_mcast)(struct ib_qp *qp,
  848. union ib_gid *gid,
  849. u16 lid);
  850. int (*process_mad)(struct ib_device *device,
  851. int process_mad_flags,
  852. u8 port_num,
  853. struct ib_wc *in_wc,
  854. struct ib_grh *in_grh,
  855. struct ib_mad *in_mad,
  856. struct ib_mad *out_mad);
  857. struct module *owner;
  858. struct class_device class_dev;
  859. struct kobject ports_parent;
  860. struct list_head port_list;
  861. enum {
  862. IB_DEV_UNINITIALIZED,
  863. IB_DEV_REGISTERED,
  864. IB_DEV_UNREGISTERED
  865. } reg_state;
  866. u8 node_type;
  867. u8 phys_port_cnt;
  868. };
  869. struct ib_client {
  870. char *name;
  871. void (*add) (struct ib_device *);
  872. void (*remove)(struct ib_device *);
  873. struct list_head list;
  874. };
  875. struct ib_device *ib_alloc_device(size_t size);
  876. void ib_dealloc_device(struct ib_device *device);
  877. int ib_register_device (struct ib_device *device);
  878. void ib_unregister_device(struct ib_device *device);
  879. int ib_register_client (struct ib_client *client);
  880. void ib_unregister_client(struct ib_client *client);
  881. void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
  882. void ib_set_client_data(struct ib_device *device, struct ib_client *client,
  883. void *data);
  884. static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
  885. {
  886. return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
  887. }
  888. static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
  889. {
  890. return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
  891. }
  892. int ib_register_event_handler (struct ib_event_handler *event_handler);
  893. int ib_unregister_event_handler(struct ib_event_handler *event_handler);
  894. void ib_dispatch_event(struct ib_event *event);
  895. int ib_query_device(struct ib_device *device,
  896. struct ib_device_attr *device_attr);
  897. int ib_query_port(struct ib_device *device,
  898. u8 port_num, struct ib_port_attr *port_attr);
  899. int ib_query_gid(struct ib_device *device,
  900. u8 port_num, int index, union ib_gid *gid);
  901. int ib_query_pkey(struct ib_device *device,
  902. u8 port_num, u16 index, u16 *pkey);
  903. int ib_modify_device(struct ib_device *device,
  904. int device_modify_mask,
  905. struct ib_device_modify *device_modify);
  906. int ib_modify_port(struct ib_device *device,
  907. u8 port_num, int port_modify_mask,
  908. struct ib_port_modify *port_modify);
  909. /**
  910. * ib_alloc_pd - Allocates an unused protection domain.
  911. * @device: The device on which to allocate the protection domain.
  912. *
  913. * A protection domain object provides an association between QPs, shared
  914. * receive queues, address handles, memory regions, and memory windows.
  915. */
  916. struct ib_pd *ib_alloc_pd(struct ib_device *device);
  917. /**
  918. * ib_dealloc_pd - Deallocates a protection domain.
  919. * @pd: The protection domain to deallocate.
  920. */
  921. int ib_dealloc_pd(struct ib_pd *pd);
  922. /**
  923. * ib_create_ah - Creates an address handle for the given address vector.
  924. * @pd: The protection domain associated with the address handle.
  925. * @ah_attr: The attributes of the address vector.
  926. *
  927. * The address handle is used to reference a local or global destination
  928. * in all UD QP post sends.
  929. */
  930. struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
  931. /**
  932. * ib_create_ah_from_wc - Creates an address handle associated with the
  933. * sender of the specified work completion.
  934. * @pd: The protection domain associated with the address handle.
  935. * @wc: Work completion information associated with a received message.
  936. * @grh: References the received global route header. This parameter is
  937. * ignored unless the work completion indicates that the GRH is valid.
  938. * @port_num: The outbound port number to associate with the address.
  939. *
  940. * The address handle is used to reference a local or global destination
  941. * in all UD QP post sends.
  942. */
  943. struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
  944. struct ib_grh *grh, u8 port_num);
  945. /**
  946. * ib_modify_ah - Modifies the address vector associated with an address
  947. * handle.
  948. * @ah: The address handle to modify.
  949. * @ah_attr: The new address vector attributes to associate with the
  950. * address handle.
  951. */
  952. int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
  953. /**
  954. * ib_query_ah - Queries the address vector associated with an address
  955. * handle.
  956. * @ah: The address handle to query.
  957. * @ah_attr: The address vector attributes associated with the address
  958. * handle.
  959. */
  960. int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
  961. /**
  962. * ib_destroy_ah - Destroys an address handle.
  963. * @ah: The address handle to destroy.
  964. */
  965. int ib_destroy_ah(struct ib_ah *ah);
  966. /**
  967. * ib_create_srq - Creates a SRQ associated with the specified protection
  968. * domain.
  969. * @pd: The protection domain associated with the SRQ.
  970. * @srq_init_attr: A list of initial attributes required to create the SRQ.
  971. *
  972. * srq_attr->max_wr and srq_attr->max_sge are read the determine the
  973. * requested size of the SRQ, and set to the actual values allocated
  974. * on return. If ib_create_srq() succeeds, then max_wr and max_sge
  975. * will always be at least as large as the requested values.
  976. */
  977. struct ib_srq *ib_create_srq(struct ib_pd *pd,
  978. struct ib_srq_init_attr *srq_init_attr);
  979. /**
  980. * ib_modify_srq - Modifies the attributes for the specified SRQ.
  981. * @srq: The SRQ to modify.
  982. * @srq_attr: On input, specifies the SRQ attributes to modify. On output,
  983. * the current values of selected SRQ attributes are returned.
  984. * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
  985. * are being modified.
  986. *
  987. * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
  988. * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
  989. * the number of receives queued drops below the limit.
  990. */
  991. int ib_modify_srq(struct ib_srq *srq,
  992. struct ib_srq_attr *srq_attr,
  993. enum ib_srq_attr_mask srq_attr_mask);
  994. /**
  995. * ib_query_srq - Returns the attribute list and current values for the
  996. * specified SRQ.
  997. * @srq: The SRQ to query.
  998. * @srq_attr: The attributes of the specified SRQ.
  999. */
  1000. int ib_query_srq(struct ib_srq *srq,
  1001. struct ib_srq_attr *srq_attr);
  1002. /**
  1003. * ib_destroy_srq - Destroys the specified SRQ.
  1004. * @srq: The SRQ to destroy.
  1005. */
  1006. int ib_destroy_srq(struct ib_srq *srq);
  1007. /**
  1008. * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
  1009. * @srq: The SRQ to post the work request on.
  1010. * @recv_wr: A list of work requests to post on the receive queue.
  1011. * @bad_recv_wr: On an immediate failure, this parameter will reference
  1012. * the work request that failed to be posted on the QP.
  1013. */
  1014. static inline int ib_post_srq_recv(struct ib_srq *srq,
  1015. struct ib_recv_wr *recv_wr,
  1016. struct ib_recv_wr **bad_recv_wr)
  1017. {
  1018. return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
  1019. }
  1020. /**
  1021. * ib_create_qp - Creates a QP associated with the specified protection
  1022. * domain.
  1023. * @pd: The protection domain associated with the QP.
  1024. * @qp_init_attr: A list of initial attributes required to create the QP.
  1025. */
  1026. struct ib_qp *ib_create_qp(struct ib_pd *pd,
  1027. struct ib_qp_init_attr *qp_init_attr);
  1028. /**
  1029. * ib_modify_qp - Modifies the attributes for the specified QP and then
  1030. * transitions the QP to the given state.
  1031. * @qp: The QP to modify.
  1032. * @qp_attr: On input, specifies the QP attributes to modify. On output,
  1033. * the current values of selected QP attributes are returned.
  1034. * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
  1035. * are being modified.
  1036. */
  1037. int ib_modify_qp(struct ib_qp *qp,
  1038. struct ib_qp_attr *qp_attr,
  1039. int qp_attr_mask);
  1040. /**
  1041. * ib_query_qp - Returns the attribute list and current values for the
  1042. * specified QP.
  1043. * @qp: The QP to query.
  1044. * @qp_attr: The attributes of the specified QP.
  1045. * @qp_attr_mask: A bit-mask used to select specific attributes to query.
  1046. * @qp_init_attr: Additional attributes of the selected QP.
  1047. *
  1048. * The qp_attr_mask may be used to limit the query to gathering only the
  1049. * selected attributes.
  1050. */
  1051. int ib_query_qp(struct ib_qp *qp,
  1052. struct ib_qp_attr *qp_attr,
  1053. int qp_attr_mask,
  1054. struct ib_qp_init_attr *qp_init_attr);
  1055. /**
  1056. * ib_destroy_qp - Destroys the specified QP.
  1057. * @qp: The QP to destroy.
  1058. */
  1059. int ib_destroy_qp(struct ib_qp *qp);
  1060. /**
  1061. * ib_post_send - Posts a list of work requests to the send queue of
  1062. * the specified QP.
  1063. * @qp: The QP to post the work request on.
  1064. * @send_wr: A list of work requests to post on the send queue.
  1065. * @bad_send_wr: On an immediate failure, this parameter will reference
  1066. * the work request that failed to be posted on the QP.
  1067. */
  1068. static inline int ib_post_send(struct ib_qp *qp,
  1069. struct ib_send_wr *send_wr,
  1070. struct ib_send_wr **bad_send_wr)
  1071. {
  1072. return qp->device->post_send(qp, send_wr, bad_send_wr);
  1073. }
  1074. /**
  1075. * ib_post_recv - Posts a list of work requests to the receive queue of
  1076. * the specified QP.
  1077. * @qp: The QP to post the work request on.
  1078. * @recv_wr: A list of work requests to post on the receive queue.
  1079. * @bad_recv_wr: On an immediate failure, this parameter will reference
  1080. * the work request that failed to be posted on the QP.
  1081. */
  1082. static inline int ib_post_recv(struct ib_qp *qp,
  1083. struct ib_recv_wr *recv_wr,
  1084. struct ib_recv_wr **bad_recv_wr)
  1085. {
  1086. return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
  1087. }
  1088. /**
  1089. * ib_create_cq - Creates a CQ on the specified device.
  1090. * @device: The device on which to create the CQ.
  1091. * @comp_handler: A user-specified callback that is invoked when a
  1092. * completion event occurs on the CQ.
  1093. * @event_handler: A user-specified callback that is invoked when an
  1094. * asynchronous event not associated with a completion occurs on the CQ.
  1095. * @cq_context: Context associated with the CQ returned to the user via
  1096. * the associated completion and event handlers.
  1097. * @cqe: The minimum size of the CQ.
  1098. *
  1099. * Users can examine the cq structure to determine the actual CQ size.
  1100. */
  1101. struct ib_cq *ib_create_cq(struct ib_device *device,
  1102. ib_comp_handler comp_handler,
  1103. void (*event_handler)(struct ib_event *, void *),
  1104. void *cq_context, int cqe);
  1105. /**
  1106. * ib_resize_cq - Modifies the capacity of the CQ.
  1107. * @cq: The CQ to resize.
  1108. * @cqe: The minimum size of the CQ.
  1109. *
  1110. * Users can examine the cq structure to determine the actual CQ size.
  1111. */
  1112. int ib_resize_cq(struct ib_cq *cq, int cqe);
  1113. /**
  1114. * ib_destroy_cq - Destroys the specified CQ.
  1115. * @cq: The CQ to destroy.
  1116. */
  1117. int ib_destroy_cq(struct ib_cq *cq);
  1118. /**
  1119. * ib_poll_cq - poll a CQ for completion(s)
  1120. * @cq:the CQ being polled
  1121. * @num_entries:maximum number of completions to return
  1122. * @wc:array of at least @num_entries &struct ib_wc where completions
  1123. * will be returned
  1124. *
  1125. * Poll a CQ for (possibly multiple) completions. If the return value
  1126. * is < 0, an error occurred. If the return value is >= 0, it is the
  1127. * number of completions returned. If the return value is
  1128. * non-negative and < num_entries, then the CQ was emptied.
  1129. */
  1130. static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
  1131. struct ib_wc *wc)
  1132. {
  1133. return cq->device->poll_cq(cq, num_entries, wc);
  1134. }
  1135. /**
  1136. * ib_peek_cq - Returns the number of unreaped completions currently
  1137. * on the specified CQ.
  1138. * @cq: The CQ to peek.
  1139. * @wc_cnt: A minimum number of unreaped completions to check for.
  1140. *
  1141. * If the number of unreaped completions is greater than or equal to wc_cnt,
  1142. * this function returns wc_cnt, otherwise, it returns the actual number of
  1143. * unreaped completions.
  1144. */
  1145. int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
  1146. /**
  1147. * ib_req_notify_cq - Request completion notification on a CQ.
  1148. * @cq: The CQ to generate an event for.
  1149. * @cq_notify: If set to %IB_CQ_SOLICITED, completion notification will
  1150. * occur on the next solicited event. If set to %IB_CQ_NEXT_COMP,
  1151. * notification will occur on the next completion.
  1152. */
  1153. static inline int ib_req_notify_cq(struct ib_cq *cq,
  1154. enum ib_cq_notify cq_notify)
  1155. {
  1156. return cq->device->req_notify_cq(cq, cq_notify);
  1157. }
  1158. /**
  1159. * ib_req_ncomp_notif - Request completion notification when there are
  1160. * at least the specified number of unreaped completions on the CQ.
  1161. * @cq: The CQ to generate an event for.
  1162. * @wc_cnt: The number of unreaped completions that should be on the
  1163. * CQ before an event is generated.
  1164. */
  1165. static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
  1166. {
  1167. return cq->device->req_ncomp_notif ?
  1168. cq->device->req_ncomp_notif(cq, wc_cnt) :
  1169. -ENOSYS;
  1170. }
  1171. /**
  1172. * ib_get_dma_mr - Returns a memory region for system memory that is
  1173. * usable for DMA.
  1174. * @pd: The protection domain associated with the memory region.
  1175. * @mr_access_flags: Specifies the memory access rights.
  1176. */
  1177. struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
  1178. /**
  1179. * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
  1180. * by an HCA.
  1181. * @pd: The protection domain associated assigned to the registered region.
  1182. * @phys_buf_array: Specifies a list of physical buffers to use in the
  1183. * memory region.
  1184. * @num_phys_buf: Specifies the size of the phys_buf_array.
  1185. * @mr_access_flags: Specifies the memory access rights.
  1186. * @iova_start: The offset of the region's starting I/O virtual address.
  1187. */
  1188. struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
  1189. struct ib_phys_buf *phys_buf_array,
  1190. int num_phys_buf,
  1191. int mr_access_flags,
  1192. u64 *iova_start);
  1193. /**
  1194. * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
  1195. * Conceptually, this call performs the functions deregister memory region
  1196. * followed by register physical memory region. Where possible,
  1197. * resources are reused instead of deallocated and reallocated.
  1198. * @mr: The memory region to modify.
  1199. * @mr_rereg_mask: A bit-mask used to indicate which of the following
  1200. * properties of the memory region are being modified.
  1201. * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
  1202. * the new protection domain to associated with the memory region,
  1203. * otherwise, this parameter is ignored.
  1204. * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
  1205. * field specifies a list of physical buffers to use in the new
  1206. * translation, otherwise, this parameter is ignored.
  1207. * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
  1208. * field specifies the size of the phys_buf_array, otherwise, this
  1209. * parameter is ignored.
  1210. * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
  1211. * field specifies the new memory access rights, otherwise, this
  1212. * parameter is ignored.
  1213. * @iova_start: The offset of the region's starting I/O virtual address.
  1214. */
  1215. int ib_rereg_phys_mr(struct ib_mr *mr,
  1216. int mr_rereg_mask,
  1217. struct ib_pd *pd,
  1218. struct ib_phys_buf *phys_buf_array,
  1219. int num_phys_buf,
  1220. int mr_access_flags,
  1221. u64 *iova_start);
  1222. /**
  1223. * ib_query_mr - Retrieves information about a specific memory region.
  1224. * @mr: The memory region to retrieve information about.
  1225. * @mr_attr: The attributes of the specified memory region.
  1226. */
  1227. int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
  1228. /**
  1229. * ib_dereg_mr - Deregisters a memory region and removes it from the
  1230. * HCA translation table.
  1231. * @mr: The memory region to deregister.
  1232. */
  1233. int ib_dereg_mr(struct ib_mr *mr);
  1234. /**
  1235. * ib_alloc_mw - Allocates a memory window.
  1236. * @pd: The protection domain associated with the memory window.
  1237. */
  1238. struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
  1239. /**
  1240. * ib_bind_mw - Posts a work request to the send queue of the specified
  1241. * QP, which binds the memory window to the given address range and
  1242. * remote access attributes.
  1243. * @qp: QP to post the bind work request on.
  1244. * @mw: The memory window to bind.
  1245. * @mw_bind: Specifies information about the memory window, including
  1246. * its address range, remote access rights, and associated memory region.
  1247. */
  1248. static inline int ib_bind_mw(struct ib_qp *qp,
  1249. struct ib_mw *mw,
  1250. struct ib_mw_bind *mw_bind)
  1251. {
  1252. /* XXX reference counting in corresponding MR? */
  1253. return mw->device->bind_mw ?
  1254. mw->device->bind_mw(qp, mw, mw_bind) :
  1255. -ENOSYS;
  1256. }
  1257. /**
  1258. * ib_dealloc_mw - Deallocates a memory window.
  1259. * @mw: The memory window to deallocate.
  1260. */
  1261. int ib_dealloc_mw(struct ib_mw *mw);
  1262. /**
  1263. * ib_alloc_fmr - Allocates a unmapped fast memory region.
  1264. * @pd: The protection domain associated with the unmapped region.
  1265. * @mr_access_flags: Specifies the memory access rights.
  1266. * @fmr_attr: Attributes of the unmapped region.
  1267. *
  1268. * A fast memory region must be mapped before it can be used as part of
  1269. * a work request.
  1270. */
  1271. struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
  1272. int mr_access_flags,
  1273. struct ib_fmr_attr *fmr_attr);
  1274. /**
  1275. * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
  1276. * @fmr: The fast memory region to associate with the pages.
  1277. * @page_list: An array of physical pages to map to the fast memory region.
  1278. * @list_len: The number of pages in page_list.
  1279. * @iova: The I/O virtual address to use with the mapped region.
  1280. */
  1281. static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
  1282. u64 *page_list, int list_len,
  1283. u64 iova)
  1284. {
  1285. return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
  1286. }
  1287. /**
  1288. * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
  1289. * @fmr_list: A linked list of fast memory regions to unmap.
  1290. */
  1291. int ib_unmap_fmr(struct list_head *fmr_list);
  1292. /**
  1293. * ib_dealloc_fmr - Deallocates a fast memory region.
  1294. * @fmr: The fast memory region to deallocate.
  1295. */
  1296. int ib_dealloc_fmr(struct ib_fmr *fmr);
  1297. /**
  1298. * ib_attach_mcast - Attaches the specified QP to a multicast group.
  1299. * @qp: QP to attach to the multicast group. The QP must be type
  1300. * IB_QPT_UD.
  1301. * @gid: Multicast group GID.
  1302. * @lid: Multicast group LID in host byte order.
  1303. *
  1304. * In order to send and receive multicast packets, subnet
  1305. * administration must have created the multicast group and configured
  1306. * the fabric appropriately. The port associated with the specified
  1307. * QP must also be a member of the multicast group.
  1308. */
  1309. int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
  1310. /**
  1311. * ib_detach_mcast - Detaches the specified QP from a multicast group.
  1312. * @qp: QP to detach from the multicast group.
  1313. * @gid: Multicast group GID.
  1314. * @lid: Multicast group LID in host byte order.
  1315. */
  1316. int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
  1317. #endif /* IB_VERBS_H */